word diff: handle zero length matches
[git] / urlmatch.h
1 #ifndef URL_MATCH_H
2 #define URL_MATCH_H
3
4 #include "string-list.h"
5
6 struct url_info {
7         /* normalized url on success, must be freed, otherwise NULL */
8         char *url;
9         /* if !url, a brief reason for the failure, otherwise NULL */
10         const char *err;
11
12         /* the rest of the fields are only set if url != NULL */
13
14         size_t url_len;         /* total length of url (which is now normalized) */
15         size_t scheme_len;      /* length of scheme name (excluding final :) */
16         size_t user_off;        /* offset into url to start of user name (0 => none) */
17         size_t user_len;        /* length of user name; if user_off != 0 but
18                                    user_len == 0, an empty user name was given */
19         size_t passwd_off;      /* offset into url to start of passwd (0 => none) */
20         size_t passwd_len;      /* length of passwd; if passwd_off != 0 but
21                                    passwd_len == 0, an empty passwd was given */
22         size_t host_off;        /* offset into url to start of host name (0 => none) */
23         size_t host_len;        /* length of host name;
24                                  * file urls may have host_len == 0 */
25         size_t port_off;        /* offset into url to start of port number (0 => none) */
26         size_t port_len;        /* if a portnum is present (port_off != 0), it has
27                                  * this length (excluding the leading ':') starting
28                                  * from port_off (always 0 for file urls) */
29         size_t path_off;        /* offset into url to the start of the url path;
30                                  * this will always point to a '/' character
31                                  * after the url has been normalized */
32         size_t path_len;        /* length of path portion excluding any trailing
33                                  * '?...' and '#...' portion; will always be >= 1 */
34 };
35
36 char *url_normalize(const char *, struct url_info *);
37
38 struct urlmatch_item {
39         size_t hostmatch_len;
40         size_t pathmatch_len;
41         char user_matched;
42 };
43
44 struct urlmatch_config {
45         struct string_list vars;
46         struct url_info url;
47         const char *section;
48         const char *key;
49
50         void *cb;
51         int (*collect_fn)(const char *var, const char *value, void *cb);
52         int (*cascade_fn)(const char *var, const char *value, void *cb);
53         /*
54          * Compare the two matches, the one just discovered and the existing
55          * best match and return a negative value if the found item is to be
56          * rejected or a non-negative value if it is to be accepted.  If this
57          * field is set to NULL, use the default comparison technique, which
58          * checks to ses if found is better (according to the urlmatch
59          * specificity rules) than existing.
60          */
61         int (*select_fn)(const struct urlmatch_item *found, const struct urlmatch_item *existing);
62         /*
63          * An optional callback to allow e.g. for partial URLs; it shall
64          * return 1 or 0 depending whether `url` matches or not.
65          */
66         int (*fallback_match_fn)(const char *url, void *cb);
67 };
68
69 int urlmatch_config_entry(const char *var, const char *value, void *cb);
70
71 #endif /* URL_MATCH_H */