git/list[1] front-page[2] threads[3] people[4] search[5] about
 

[PATCH v7 0/11] port tag.c to use ref-filter APIs

From
Karthik Nayak <karthik.188@gmail.com>
Date
Jul 30, 2015, 15:34 UTC
Message-ID
<CAOLa=ZQG4Oz4aSGLNQxcRB4vNo3DQn_V96H-aCD=krSSoA9JGQ@mail.gmail.com>

This is part of my GSoC project to unify git tag -l, git branch -l, git for-each-ref. This patch series is continued from: Git (next) https://github.com/git/git/commit/bf5418f49ff0cebc6e5ce04ad1417e1a47c81b61

Version 6 can be found here: http://article.gmane.org/gmane.comp.version-control.git/274726

Changes in this version:
* ref_formatting_state now works on emit() also, hence succeeding
strings and atoms are affected.
* Make color a modifier_atom like in v5.
* Add test for "padright" when its value is lesser than the value of the atom.
* Other small changes.
Interdiff:
diff --git a/Documentation/git-for-each-ref.txt
b/Documentation/git-for-each-ref.txt
index 2b60aee..bcf319a 100644
--- a/Documentation/git-for-each-ref.txt
+++ b/Documentation/git-for-each-ref.txt
@@ -128,10 +128,10 @@ color::
     are described in `color.branch.*`.

 padright::
-    Pad succeeding atom to the right. Followed by `:<value>`,
-    where `value` states the total length of atom including the
-    padding. If the `value` is greater than the atom length, then
-    no padding is performed.
+    Pad succeeding atom or string to the right. Followed by
+    `:<value>`, where `value` states the total length of atom or
+    string including the padding. If the `value` is lesser than
+    the atom or string length, then no padding is performed.

 In addition to the above, for commit and tag objects, the header
 field names (`tree`, `parent`, `object`, `type`, and `tag`) can
@@ -152,7 +152,7 @@ order (`objectsize`, `authordate`,
`committerdate`, `taggerdate`).
 All other fields are used to sort in their byte-value order.

 There is also an option to sort by versions, this can be done by using
-the fieldname `version:refname` or in short `v:refname`.
+the fieldname `version:refname` or its alias `v:refname`.

 In any case, a field name that refers to a field inapplicable to
 the object referred by the ref does not cause an error.  It
diff --git a/ref-filter.c b/ref-filter.c
index 0a34924..65d168e 100644
--- a/ref-filter.c
+++ b/ref-filter.c
@@ -624,7 +624,7 @@ static void populate_value(struct ref_array_item *ref)
         const char *name = used_atom[i];
         struct atom_value *v = &ref->value[i];
         int deref = 0;
-        const char *refname = NULL;
+        const char *refname;
         const char *formatp;
         struct branch *branch = NULL;

@@ -664,6 +664,8 @@ static void populate_value(struct ref_array_item *ref)
             if (color_parse(name + 6, color) < 0)
                 die(_("unable to parse format"));
             v->s = xstrdup(color);
+            v->color = 1;
+            v->modifier_atom = 1;
             continue;
         } else if (!strcmp(name, "flag")) {
             char buf[256], *cp = buf;
@@ -954,12 +956,9 @@ static int match_pattern(const char **patterns,
const char *refname)
      * When no '--format' option is given we need to skip the prefix
      * for matching refs of tags and branches.
      */
-    if (skip_prefix(refname, "refs/tags/", &refname))
-        ;
-    else if (skip_prefix(refname, "refs/heads/", &refname))
-        ;
-    else if (skip_prefix(refname, "refs/remotes/", &refname))
-        ;
+    (void)(skip_prefix(refname, "refs/tags/", &refname) ||
+           skip_prefix(refname, "refs/heads/", &refname) ||
+           skip_prefix(refname, "refs/remotes/", &refname));

     for (; *patterns; patterns++) {
         if (!wildmatch(*patterns, refname, 0, NULL))
@@ -1245,19 +1244,24 @@ void ref_array_sort(struct ref_sorting
*sorting, struct ref_array *array)
 }

 static void apply_formatting_state(struct ref_formatting_state *state,
-                   struct atom_value *v, struct strbuf *value)
+                   const char *buf, struct strbuf *value)
 {
+    if (state->color) {
+        strbuf_addstr(value, state->color);
+        state->color = NULL;
+    }
     if (state->pad_to_right) {
-        if (!is_utf8(v->s))
-            strbuf_addf(value, "%-*s", state->pad_to_right, v->s);
+        if (!is_utf8(buf))
+            strbuf_addf(value, "%-*s", state->pad_to_right, buf);
         else {
-            int utf8_compensation = strlen(v->s) - utf8_strwidth(v->s);
-            strbuf_addf(value, "%-*s", state->pad_to_right +
utf8_compensation, v->s);
+            int utf8_compensation = strlen(buf) - utf8_strwidth(buf);
+            strbuf_addf(value, "%-*s", state->pad_to_right +
utf8_compensation, buf);
         }
+        state->pad_to_right = 0;
         return;
     }

-    strbuf_addstr(value, v->s);
+    strbuf_addstr(value, buf);
 }

 static void print_value(struct atom_value *v, struct
ref_formatting_state *state)
@@ -1265,13 +1269,7 @@ static void print_value(struct atom_value *v,
struct ref_formatting_state *state
     struct strbuf value = STRBUF_INIT;
     struct strbuf formatted = STRBUF_INIT;

-    /*
-     * Some (pesudo) atoms have no immediate side effect, but only
-     * affect the next atom. Store the relevant information from
-     * these atoms in the 'state' variable for use when displaying
-     * the next atom.
-     */
-    apply_formatting_state(state, v, &value);
+    apply_formatting_state(state, v->s, &value);

     switch (state->quote_style) {
     case QUOTE_NONE:
@@ -1314,8 +1312,12 @@ static int hex2(const char *cp)
         return -1;
 }

-static void emit(const char *cp, const char *ep)
+static void emit(const char *cp, const char *ep,
+         struct ref_formatting_state *state)
 {
+    struct strbuf value = STRBUF_INIT;
+    struct strbuf format = STRBUF_INIT;
+
     while (*cp && (!ep || cp < ep)) {
         if (*cp == '%') {
             if (cp[1] == '%')
@@ -1329,25 +1331,24 @@ static void emit(const char *cp, const char *ep)
                 }
             }
         }
-        putchar(*cp);
+        strbuf_addch(&value, *cp);
         cp++;
     }
+    apply_formatting_state(state, value.buf, &format);
+    fputs(format.buf, stdout);
+    strbuf_release(&format);
+    strbuf_release(&value);
 }

 static void store_formatting_state(struct ref_formatting_state *state,
                    struct atom_value *atomv)
 {
+    if (atomv->color)
+        state->color = atomv->s;
     if (atomv->pad_to_right)
         state->pad_to_right = atomv->ul;
 }

-static void reset_formatting_state(struct ref_formatting_state *state)
-{
-    int quote_style = state->quote_style;
-    memset(state, 0, sizeof(*state));
-    state->quote_style = quote_style;
-}
-
 /*
  * If 'lines' is greater than 0, print that many lines from the given
  * object_id 'oid'.
@@ -1405,18 +1406,16 @@ void show_ref_array_item(struct ref_array_item
*info, const char *format,

         ep = strchr(sp, ')');
         if (cp < sp)
-            emit(cp, sp);
+            emit(cp, sp, &state);
         get_ref_atom_value(info, parse_ref_filter_atom(sp + 2, ep), &atomv);
         if (atomv->modifier_atom)
             store_formatting_state(&state, atomv);
-        else {
+        else
             print_value(atomv, &state);
-            reset_formatting_state(&state);
-        }
     }
     if (*cp) {
         sp = cp + strlen(cp);
-        emit(cp, sp);
+        emit(cp, sp, &state);
     }
     if (need_color_reset_at_eol) {
         struct atom_value resetv;
diff --git a/ref-filter.h b/ref-filter.h
index fcf469e..b50a036 100644
--- a/ref-filter.h
+++ b/ref-filter.h
@@ -21,12 +21,14 @@ struct atom_value {
     const char *s;
     unsigned long ul; /* used for sorting when not FIELD_STR */
     unsigned int modifier_atom : 1, /*  atoms which act as modifiers
for the next atom */
+        color : 1,
         pad_to_right : 1;
 };

 struct ref_formatting_state {
     int quote_style;
     unsigned int pad_to_right;
+    const char *color;
 };

 struct ref_sorting {
diff --git a/t/t6302-for-each-ref-filter.sh b/t/t6302-for-each-ref-filter.sh
index 68688a9..b9ebb3d 100755
--- a/t/t6302-for-each-ref-filter.sh
+++ b/t/t6302-for-each-ref-filter.sh
@@ -83,17 +83,33 @@ test_expect_success 'filtering with --contains' '

 test_expect_success 'padding to the right using `padright`' '
     cat >expect <<-\EOF &&
-    refs/heads/master|refs/heads/master        |refs/heads/master|
-    refs/heads/side|refs/heads/side          |refs/heads/side|
-    refs/odd/spot|refs/odd/spot            |refs/odd/spot|
-    refs/tags/double-tag|refs/tags/double-tag     |refs/tags/double-tag|
-    refs/tags/four|refs/tags/four           |refs/tags/four|
-    refs/tags/one|refs/tags/one            |refs/tags/one|
-    refs/tags/signed-tag|refs/tags/signed-tag     |refs/tags/signed-tag|
-    refs/tags/three|refs/tags/three          |refs/tags/three|
-    refs/tags/two|refs/tags/two            |refs/tags/two|
+    master|    master    |
+    side|    side      |
+    odd/spot|    odd/spot  |
+    double-tag|    double-tag|
+    four|    four      |
+    one|    one       |
+    signed-tag|    signed-tag|
+    three|    three     |
+    two|    two       |
     EOF
-    git for-each-ref
--format="%(refname)%(padright:25)|%(refname)|%(refname)|" >actual &&
+    git for-each-ref
--format="%(refname:short)%(padright:5)|%(padright:10)%(refname:short)|"
>actual &&
+    test_cmp expect actual
+'
+
+test_expect_success 'no padding when `padright` length is smaller
than atom length' '
+    cat >expect <<-\EOF &&
+    refs/heads/master|
+    refs/heads/side|
+    refs/odd/spot|
+    refs/tags/double-tag|
+    refs/tags/four|
+    refs/tags/one|
+    refs/tags/signed-tag|
+    refs/tags/three|
+    refs/tags/two|
+    EOF
+    git for-each-ref --format="%(padright:5)%(refname)|" >actual &&
     test_cmp expect actual
 '

Thanks to Everyone for suggestions and tips :)

-- 
Regards,
Karthik Nayak
Next: Karthik Nayak
Message 1 of 17 in “port tag.c to use ref-filter APIs”
  1. 0/11 port tag.c to use ref-filter APIsKarthik Nayak, Jul 30, 2015
  2. 01/11 ref-filter: introduce 'ref_formatting_state'Karthik Nayak, Jul 30, 2015
  3. 02/11 ref-filter: make `color` use `ref_formatting_state`Karthik Nayak, Jul 30, 2015
  4. 03/11 ref-filter: add option to pad atoms to the rightKarthik Nayak, Jul 30, 2015
  5. Eric SunshineJul 30, 2015
  6. Karthik NayakAug 1, 2015
  7. 04/11 ref-filter: add option to filter only tagsKarthik Nayak, Jul 30, 2015
  8. 05/11 ref-filter: support printing N lines from tag annotationKarthik Nayak, Jul 30, 2015
  9. 06/11 ref-filter: add support to sort by versionKarthik Nayak, Jul 30, 2015
  10. 07/11 ref-filter: add option to match literal patternKarthik Nayak, Jul 30, 2015
  11. 08/11 tag.c: use 'ref-filter' data structuresKarthik Nayak, Jul 30, 2015
  12. 09/11 tag.c: use 'ref-filter' APIsKarthik Nayak, Jul 30, 2015
  13. 10/11 tag.c: implement '--format' optionKarthik Nayak, Jul 30, 2015
  14. 11/11 tag.c: implement '--merged' and '--no-merged' optionsKarthik Nayak, Jul 30, 2015
  15. Karthik NayakJul 30, 2015
  16. Matthieu MoyAug 2, 2015
  17. Karthik NayakAug 3, 2015

Read the whole thread, see it on lore, or plain text.

$ cat FOOTERMessages come from the public archive at lore.kernel.org/git, fetched every hour. The front page is chosen and written each morning by an AI editor and can be wrong; the threads themselves are the record. About and API. For agents: an MCP server at https://gitlist.dev/mcp, and any thread, story or person page as Markdown by adding .md to its URL (or sending Accept: text/markdown). Details in /llms.txt.