Merge branch 'nd/apply-doc' into maint
[git] / urlmatch.h
1 #ifndef URL_MATCH_H
2 #include "string-list.h"
3
4 struct url_info {
5         /* normalized url on success, must be freed, otherwise NULL */
6         char *url;
7         /* if !url, a brief reason for the failure, otherwise NULL */
8         const char *err;
9
10         /* the rest of the fields are only set if url != NULL */
11
12         size_t url_len;         /* total length of url (which is now normalized) */
13         size_t scheme_len;      /* length of scheme name (excluding final :) */
14         size_t user_off;        /* offset into url to start of user name (0 => none) */
15         size_t user_len;        /* length of user name; if user_off != 0 but
16                                    user_len == 0, an empty user name was given */
17         size_t passwd_off;      /* offset into url to start of passwd (0 => none) */
18         size_t passwd_len;      /* length of passwd; if passwd_off != 0 but
19                                    passwd_len == 0, an empty passwd was given */
20         size_t host_off;        /* offset into url to start of host name (0 => none) */
21         size_t host_len;        /* length of host name; this INCLUDES any ':portnum';
22                                  * file urls may have host_len == 0 */
23         size_t port_len;        /* if a portnum is present (port_len != 0), it has
24                                  * this length (excluding the leading ':') at the
25                                  * end of the host name (always 0 for file urls) */
26         size_t path_off;        /* offset into url to the start of the url path;
27                                  * this will always point to a '/' character
28                                  * after the url has been normalized */
29         size_t path_len;        /* length of path portion excluding any trailing
30                                  * '?...' and '#...' portion; will always be >= 1 */
31 };
32
33 extern char *url_normalize(const char *, struct url_info *);
34
35 struct urlmatch_item {
36         size_t matched_len;
37         char user_matched;
38 };
39
40 struct urlmatch_config {
41         struct string_list vars;
42         struct url_info url;
43         const char *section;
44         const char *key;
45
46         void *cb;
47         int (*collect_fn)(const char *var, const char *value, void *cb);
48         int (*cascade_fn)(const char *var, const char *value, void *cb);
49 };
50
51 extern int urlmatch_config_entry(const char *var, const char *value, void *cb);
52
53 #endif /* URL_MATCH_H */