ref-filter: introduce align_atom_parser()
[gitweb.git] / ref-filter.c
index 7bef7f8dac644b49a2cb13d8d5154fd563d6e8a0..797f9fe2d883d9568259507e394cfe290fc4adde 100644 (file)
 
 typedef enum { FIELD_STR, FIELD_ULONG, FIELD_TIME } cmp_type;
 
+struct align {
+       align_type position;
+       unsigned int width;
+};
+
+/*
+ * An atom is a valid field atom listed below, possibly prefixed with
+ * a "*" to denote deref_tag().
+ *
+ * We parse given format string and sort specifiers, and make a list
+ * of properties that we need to extract out of objects.  ref_array_item
+ * structure will hold an array of values extracted that can be
+ * indexed with the "atom number", which is an index into this
+ * array.
+ */
+static struct used_atom {
+       const char *name;
+       cmp_type type;
+       union {
+               char color[COLOR_MAXLEN];
+               struct align align;
+       } u;
+} *used_atom;
+static int used_atom_cnt, need_tagged, need_symref;
+static int need_color_reset_at_eol;
+
+static void color_atom_parser(struct used_atom *atom, const char *color_value)
+{
+       if (!color_value)
+               die(_("expected format: %%(color:<color>)"));
+       if (color_parse(color_value, atom->u.color) < 0)
+               die(_("unrecognized color: %%(color:%s)"), color_value);
+}
+
+static align_type parse_align_position(const char *s)
+{
+       if (!strcmp(s, "right"))
+               return ALIGN_RIGHT;
+       else if (!strcmp(s, "middle"))
+               return ALIGN_MIDDLE;
+       else if (!strcmp(s, "left"))
+               return ALIGN_LEFT;
+       return -1;
+}
+
+static void align_atom_parser(struct used_atom *atom, const char *arg)
+{
+       struct align *align = &atom->u.align;
+       struct string_list params = STRING_LIST_INIT_DUP;
+       int i;
+       unsigned int width = ~0U;
+
+       if (!arg)
+               die(_("expected format: %%(align:<width>,<position>)"));
+
+       align->position = ALIGN_LEFT;
+
+       string_list_split(&params, arg, ',', -1);
+       for (i = 0; i < params.nr; i++) {
+               const char *s = params.items[i].string;
+               int position;
+
+               if (!strtoul_ui(s, 10, &width))
+                       ;
+               else if ((position = parse_align_position(s)) >= 0)
+                       align->position = position;
+               else
+                       die(_("unrecognized %%(align) argument: %s"), s);
+       }
+
+       if (width == ~0U)
+               die(_("positive width expected with the %%(align) atom"));
+       align->width = width;
+       string_list_clear(&params, 0);
+}
+
 static struct {
        const char *name;
        cmp_type cmp_type;
+       void (*parser)(struct used_atom *atom, const char *arg);
 } valid_atom[] = {
        { "refname" },
        { "objecttype" },
@@ -52,18 +129,13 @@ static struct {
        { "symref" },
        { "flag" },
        { "HEAD" },
-       { "color" },
-       { "align" },
+       { "color", FIELD_STR, color_atom_parser },
+       { "align", FIELD_STR, align_atom_parser },
        { "end" },
 };
 
 #define REF_FORMATTING_STATE_INIT  { 0, NULL }
 
-struct align {
-       align_type position;
-       unsigned int width;
-};
-
 struct contents {
        unsigned int lines;
        struct object_id oid;
@@ -91,27 +163,13 @@ struct atom_value {
        unsigned long ul; /* used for sorting when not FIELD_STR */
 };
 
-/*
- * An atom is a valid field atom listed above, possibly prefixed with
- * a "*" to denote deref_tag().
- *
- * We parse given format string and sort specifiers, and make a list
- * of properties that we need to extract out of objects.  ref_array_item
- * structure will hold an array of values extracted that can be
- * indexed with the "atom number", which is an index into this
- * array.
- */
-static const char **used_atom;
-static cmp_type *used_atom_type;
-static int used_atom_cnt, need_tagged, need_symref;
-static int need_color_reset_at_eol;
-
 /*
  * Used to parse format string and sort specifiers
  */
 int parse_ref_filter_atom(const char *atom, const char *ep)
 {
        const char *sp;
+       const char *arg;
        int i, at;
 
        sp = atom;
@@ -122,24 +180,24 @@ int parse_ref_filter_atom(const char *atom, const char *ep)
 
        /* Do we have the atom already used elsewhere? */
        for (i = 0; i < used_atom_cnt; i++) {
-               int len = strlen(used_atom[i]);
-               if (len == ep - atom && !memcmp(used_atom[i], atom, len))
+               int len = strlen(used_atom[i].name);
+               if (len == ep - atom && !memcmp(used_atom[i].name, atom, len))
                        return i;
        }
 
        /* Is the atom a valid one? */
        for (i = 0; i < ARRAY_SIZE(valid_atom); i++) {
                int len = strlen(valid_atom[i].name);
+
                /*
                 * If the atom name has a colon, strip it and everything after
                 * it off - it specifies the format for this entry, and
                 * shouldn't be used for checking against the valid_atom
                 * table.
                 */
-               const char *formatp = strchr(sp, ':');
-               if (!formatp || ep < formatp)
-                       formatp = ep;
-               if (len == formatp - sp && !memcmp(valid_atom[i].name, sp, len))
+               arg = memchr(sp, ':', ep - sp);
+               if (len == (arg ? arg : ep) - sp &&
+                   !memcmp(valid_atom[i].name, sp, len))
                        break;
        }
 
@@ -150,12 +208,16 @@ int parse_ref_filter_atom(const char *atom, const char *ep)
        at = used_atom_cnt;
        used_atom_cnt++;
        REALLOC_ARRAY(used_atom, used_atom_cnt);
-       REALLOC_ARRAY(used_atom_type, used_atom_cnt);
-       used_atom[at] = xmemdupz(atom, ep - atom);
-       used_atom_type[at] = valid_atom[i].cmp_type;
+       used_atom[at].name = xmemdupz(atom, ep - atom);
+       used_atom[at].type = valid_atom[i].cmp_type;
+       if (arg)
+               arg = used_atom[at].name + (arg - atom) + 1;
+       memset(&used_atom[at].u, 0, sizeof(used_atom[at].u));
+       if (valid_atom[i].parser)
+               valid_atom[i].parser(&used_atom[at], arg);
        if (*atom == '*')
                need_tagged = 1;
-       if (!strcmp(used_atom[at], "symref"))
+       if (!strcmp(used_atom[at].name, "symref"))
                need_symref = 1;
        return at;
 }
@@ -258,22 +320,6 @@ static void end_atom_handler(struct atom_value *atomv, struct ref_formatting_sta
        pop_stack_element(&state->stack);
 }
 
-static int match_atom_name(const char *name, const char *atom_name, const char **val)
-{
-       const char *body;
-
-       if (!skip_prefix(name, atom_name, &body))
-               return 0; /* doesn't even begin with "atom_name" */
-       if (!body[0]) {
-               *val = NULL; /* %(atom_name) and no customization */
-               return 1;
-       }
-       if (body[0] != ':')
-               return 0; /* "atom_namefoo" is not "atom_name" or "atom_name:..." */
-       *val = body + 1; /* "atom_name:val" */
-       return 1;
-}
-
 /*
  * In a format string, find the next occurrence of %(atom).
  */
@@ -315,7 +361,7 @@ int verify_ref_format(const char *format)
                at = parse_ref_filter_atom(sp + 2, ep);
                cp = ep + 1;
 
-               if (skip_prefix(used_atom[at], "color:", &color))
+               if (skip_prefix(used_atom[at].name, "color:", &color))
                        need_color_reset_at_eol = !!strcmp(color, "reset");
        }
        return 0;
@@ -359,7 +405,7 @@ static void grab_common_values(struct atom_value *val, int deref, struct object
        int i;
 
        for (i = 0; i < used_atom_cnt; i++) {
-               const char *name = used_atom[i];
+               const char *name = used_atom[i].name;
                struct atom_value *v = &val[i];
                if (!!deref != (*name == '*'))
                        continue;
@@ -383,7 +429,7 @@ static void grab_tag_values(struct atom_value *val, int deref, struct object *ob
        struct tag *tag = (struct tag *) obj;
 
        for (i = 0; i < used_atom_cnt; i++) {
-               const char *name = used_atom[i];
+               const char *name = used_atom[i].name;
                struct atom_value *v = &val[i];
                if (!!deref != (*name == '*'))
                        continue;
@@ -405,7 +451,7 @@ static void grab_commit_values(struct atom_value *val, int deref, struct object
        struct commit *commit = (struct commit *) obj;
 
        for (i = 0; i < used_atom_cnt; i++) {
-               const char *name = used_atom[i];
+               const char *name = used_atom[i].name;
                struct atom_value *v = &val[i];
                if (!!deref != (*name == '*'))
                        continue;
@@ -535,7 +581,7 @@ static void grab_person(const char *who, struct atom_value *val, int deref, stru
        const char *wholine = NULL;
 
        for (i = 0; i < used_atom_cnt; i++) {
-               const char *name = used_atom[i];
+               const char *name = used_atom[i].name;
                struct atom_value *v = &val[i];
                if (!!deref != (*name == '*'))
                        continue;
@@ -573,7 +619,7 @@ static void grab_person(const char *who, struct atom_value *val, int deref, stru
        if (!wholine)
                return;
        for (i = 0; i < used_atom_cnt; i++) {
-               const char *name = used_atom[i];
+               const char *name = used_atom[i].name;
                struct atom_value *v = &val[i];
                if (!!deref != (*name == '*'))
                        continue;
@@ -663,7 +709,7 @@ static void grab_sub_body_contents(struct atom_value *val, int deref, struct obj
        unsigned long sublen = 0, bodylen = 0, nonsiglen = 0, siglen = 0;
 
        for (i = 0; i < used_atom_cnt; i++) {
-               const char *name = used_atom[i];
+               const char *name = used_atom[i].name;
                struct atom_value *v = &val[i];
                const char *valp = NULL;
                if (!!deref != (*name == '*'))
@@ -763,6 +809,29 @@ static inline char *copy_advance(char *dst, const char *src)
        return dst;
 }
 
+static const char *strip_ref_components(const char *refname, const char *nr_arg)
+{
+       char *end;
+       long nr = strtol(nr_arg, &end, 10);
+       long remaining = nr;
+       const char *start = refname;
+
+       if (nr < 1 || *end != '\0')
+               die(":strip= requires a positive integer argument");
+
+       while (remaining) {
+               switch (*start++) {
+               case '\0':
+                       die("ref '%s' does not have %ld components to :strip",
+                           refname, nr);
+               case '/':
+                       remaining--;
+                       break;
+               }
+       }
+       return start;
+}
+
 /*
  * Parse the object referred by ref, and grab needed value.
  */
@@ -786,12 +855,12 @@ static void populate_value(struct ref_array_item *ref)
 
        /* Fill in specials first */
        for (i = 0; i < used_atom_cnt; i++) {
-               const char *name = used_atom[i];
+               struct used_atom *atom = &used_atom[i];
+               const char *name = used_atom[i].name;
                struct atom_value *v = &ref->value[i];
                int deref = 0;
                const char *refname;
                const char *formatp;
-               const char *valp;
                struct branch *branch = NULL;
 
                v->handler = append_atom;
@@ -826,14 +895,8 @@ static void populate_value(struct ref_array_item *ref)
                        refname = branch_get_push(branch, NULL);
                        if (!refname)
                                continue;
-               } else if (match_atom_name(name, "color", &valp)) {
-                       char color[COLOR_MAXLEN] = "";
-
-                       if (!valp)
-                               die(_("expected format: %%(color:<color>)"));
-                       if (color_parse(valp, color) < 0)
-                               die(_("unable to parse format"));
-                       v->s = xstrdup(color);
+               } else if (starts_with(name, "color:")) {
+                       v->s = atom->u.color;
                        continue;
                } else if (!strcmp(name, "flag")) {
                        char buf[256], *cp = buf;
@@ -861,43 +924,8 @@ static void populate_value(struct ref_array_item *ref)
                        else
                                v->s = " ";
                        continue;
-               } else if (match_atom_name(name, "align", &valp)) {
-                       struct align *align = &v->u.align;
-                       struct strbuf **s, **to_free;
-                       int width = -1;
-
-                       if (!valp)
-                               die(_("expected format: %%(align:<width>,<position>)"));
-
-                       /*
-                        * TODO: Implement a function similar to strbuf_split_str()
-                        * which would omit the separator from the end of each value.
-                        */
-                       s = to_free = strbuf_split_str(valp, ',', 0);
-
-                       align->position = ALIGN_LEFT;
-
-                       while (*s) {
-                               /*  Strip trailing comma */
-                               if (s[1])
-                                       strbuf_setlen(s[0], s[0]->len - 1);
-                               if (!strtoul_ui(s[0]->buf, 10, (unsigned int *)&width))
-                                       ;
-                               else if (!strcmp(s[0]->buf, "left"))
-                                       align->position = ALIGN_LEFT;
-                               else if (!strcmp(s[0]->buf, "right"))
-                                       align->position = ALIGN_RIGHT;
-                               else if (!strcmp(s[0]->buf, "middle"))
-                                       align->position = ALIGN_MIDDLE;
-                               else
-                                       die(_("improper format entered align:%s"), s[0]->buf);
-                               s++;
-                       }
-
-                       if (width < 0)
-                               die(_("positive width expected with the %%(align) atom"));
-                       align->width = width;
-                       strbuf_list_free(to_free);
+               } else if (starts_with(name, "align")) {
+                       v->u.align = atom->u.align;
                        v->handler = align_atom_handler;
                        continue;
                } else if (!strcmp(name, "end")) {
@@ -909,11 +937,14 @@ static void populate_value(struct ref_array_item *ref)
                formatp = strchr(name, ':');
                if (formatp) {
                        int num_ours, num_theirs;
+                       const char *arg;
 
                        formatp++;
                        if (!strcmp(formatp, "short"))
                                refname = shorten_unambiguous_ref(refname,
                                                      warn_ambiguous_refs);
+                       else if (skip_prefix(formatp, "strip=", &arg))
+                               refname = strip_ref_components(refname, arg);
                        else if (!strcmp(formatp, "track") &&
                                 (starts_with(name, "upstream") ||
                                  starts_with(name, "push"))) {
@@ -1445,7 +1476,7 @@ static int cmp_ref_sorting(struct ref_sorting *s, struct ref_array_item *a, stru
 {
        struct atom_value *va, *vb;
        int cmp;
-       cmp_type cmp_type = used_atom_type[s->atom];
+       cmp_type cmp_type = used_atom[s->atom].type;
 
        get_ref_atom_value(a, s->atom, &va);
        get_ref_atom_value(b, s->atom, &vb);