[PATCH v17 06/14] ref-filter: implement an `align` atom

[Karthik Nayak]

Implement an `align` atom which left-, middle-, or right-aligns the
content between %(align:...) and %(end).

The "align:" is followed by `` and `` in any order
separated by a comma, where the `` is either left, right or
middle, default being left and `` is the total length of the
content with alignment. If the contents length is more than the width
then no alignment is performed.  e.g. to align a refname atom to the
middle with a total width of 40 we can do:
--format="%(align:middle,40)%(refname)%(end)".

We introduce an `at_end` function for each element of the stack which
is to be called when the `end` atom is encountered. Using this we
implement end_align_handler() for the `align` atom, this aligns the
final strbuf by calling `strbuf_utf8_align()` from utf8.c.

Ensure that quote formatting is performed on the whole of
%(align:...)...%(end) rather than individual atoms inside. We skip
quote formatting for individual atoms when the current stack element
is handling an %(align:...) atom and perform quote formatting at the
end when we encounter the %(end) atom of the second element of then
stack.

Add documentation and tests for the same.

Mentored-by: Christian Couder 
Mentored-by: Matthieu Moy 
Helped-by: Junio C Hamano 
Signed-off-by: Karthik Nayak 
---
 Documentation/git-for-each-ref.txt |  11 
 ref-filter.c   | 110 -
 t/t6302-for-each-ref-filter.sh |  82 +++
 3 files changed, 202 insertions(+), 1 deletion(-)

diff --git a/Documentation/git-for-each-ref.txt 
b/Documentation/git-for-each-ref.txt
index e49d578..3a271bf 100644
--- a/Documentation/git-for-each-ref.txt
+++ b/Documentation/git-for-each-ref.txt
@@ -127,6 +127,17 @@ color::
Change output color.  Followed by `:`, where names
are described in `color.branch.*`.
 
+align::
+   Left-, middle-, or right-align the content between
+   %(align:...) and %(end). The "align:" is followed by ``
+   and `` in any order separated by a comma, where the
+   `` is either left, right or middle, default being
+   left and `` is the total length of the content with
+   alignment. If the contents length is more than the width then
+   no alignment is performed. If used with '--quote' everything
+   in between %(align:...) and %(end) is quoted, but if nested
+   then only the topmost level performs quoting.
+
 In addition to the above, for commit and tag objects, the header
 field names (`tree`, `parent`, `object`, `type`, and `tag`) can
 be used to specify the value in the header field.
diff --git a/ref-filter.c b/ref-filter.c
index 514de34..c65cd60 100644
--- a/ref-filter.c
+++ b/ref-filter.c
@@ -10,6 +10,7 @@
 #include "quote.h"
 #include "ref-filter.h"
 #include "revision.h"
+#include "utf8.h"
 
 typedef enum { FIELD_STR, FIELD_ULONG, FIELD_TIME } cmp_type;
 
@@ -53,13 +54,22 @@ static struct {
{ "flag" },
{ "HEAD" },
{ "color" },
+   { "align" },
+   { "end" },
 };
 
 #define REF_FORMATTING_STATE_INIT  { 0, NULL }
 
+struct align {
+   align_type position;
+   unsigned int width;
+};
+
 struct ref_formatting_stack {
struct ref_formatting_stack *prev;
struct strbuf output;
+   void (*at_end)(struct ref_formatting_stack *stack);
+   void *at_end_data;
 };
 
 struct ref_formatting_state {
@@ -69,6 +79,9 @@ struct ref_formatting_state {
 
 struct atom_value {
const char *s;
+   union {
+   struct align align;
+   } u;
void (*handler)(struct atom_value *atomv, struct ref_formatting_state 
*state);
unsigned long ul; /* used for sorting when not FIELD_STR */
 };
@@ -165,7 +178,16 @@ static void quote_formatting(struct strbuf *s, const char 
*str, int quote_style)
 
 static void append_atom(struct atom_value *v, struct ref_formatting_state 
*state)
 {
-   quote_formatting(>stack->output, v->s, state->quote_style);
+   /*
+* Quote formatting is only done when the stack has a single
+* element. Otherwise quote formatting is done on the
+* element's entire output strbuf when the %(end) atom is
+* encountered.
+*/
+   if (!state->stack->prev)
+   quote_formatting(>stack->output, v->s, 
state->quote_style);
+   else
+   strbuf_addstr(>stack->output, v->s);
 }
 
 static void push_stack_element(struct ref_formatting_stack **stack)
@@ -189,6 +211,48 @@ static void pop_stack_element(struct ref_formatting_stack 
**stack)
*stack = prev;
 }
 
+static void end_align_handler(struct ref_formatting_stack *stack)
+{
+   struct align *align = (struct align *)stack->at_end_data;
+   struct strbuf s = STRBUF_INIT;
+
+   strbuf_utf8_align(, align->position, align->width, stack->output.buf);
+   strbuf_swap(>output, );
+   strbuf_release();

[PATCH v17 06/14] ref-filter: implement an `align` atom

[Karthik Nayak]

Implement an `align` atom which left-, middle-, or right-aligns the
content between %(align:...) and %(end).

The "align:" is followed by `` and `` in any order
separated by a comma, where the `` is either left, right or
middle, default being left and `` is the total length of the
content with alignment. If the contents length is more than the width
then no alignment is performed.  e.g. to align a refname atom to the
middle with a total width of 40 we can do:
--format="%(align:middle,40)%(refname)%(end)".

We introduce an `at_end` function for each element of the stack which
is to be called when the `end` atom is encountered. Using this we
implement end_align_handler() for the `align` atom, this aligns the
final strbuf by calling `strbuf_utf8_align()` from utf8.c.

Ensure that quote formatting is performed on the whole of
%(align:...)...%(end) rather than individual atoms inside. We skip
quote formatting for individual atoms when the current stack element
is handling an %(align:...) atom and perform quote formatting at the
end when we encounter the %(end) atom of the second element of then
stack.

Add documentation and tests for the same.

Mentored-by: Christian Couder 
Mentored-by: Matthieu Moy 
Helped-by: Junio C Hamano 
Signed-off-by: Karthik Nayak 
---
 Documentation/git-for-each-ref.txt |  11 
 ref-filter.c   | 110 -
 t/t6302-for-each-ref-filter.sh |  82 +++
 3 files changed, 202 insertions(+), 1 deletion(-)

diff --git a/Documentation/git-for-each-ref.txt 
b/Documentation/git-for-each-ref.txt
index e49d578..3a271bf 100644
--- a/Documentation/git-for-each-ref.txt
+++ b/Documentation/git-for-each-ref.txt
@@ -127,6 +127,17 @@ color::
Change output color.  Followed by `:`, where names
are described in `color.branch.*`.
 
+align::
+   Left-, middle-, or right-align the content between
+   %(align:...) and %(end). The "align:" is followed by ``
+   and `` in any order separated by a comma, where the
+   `` is either left, right or middle, default being
+   left and `` is the total length of the content with
+   alignment. If the contents length is more than the width then
+   no alignment is performed. If used with '--quote' everything
+   in between %(align:...) and %(end) is quoted, but if nested
+   then only the topmost level performs quoting.
+
 In addition to the above, for commit and tag objects, the header
 field names (`tree`, `parent`, `object`, `type`, and `tag`) can
 be used to specify the value in the header field.
diff --git a/ref-filter.c b/ref-filter.c
index 514de34..c65cd60 100644
--- a/ref-filter.c
+++ b/ref-filter.c
@@ -10,6 +10,7 @@
 #include "quote.h"
 #include "ref-filter.h"
 #include "revision.h"
+#include "utf8.h"
 
 typedef enum { FIELD_STR, FIELD_ULONG, FIELD_TIME } cmp_type;
 
@@ -53,13 +54,22 @@ static struct {
{ "flag" },
{ "HEAD" },
{ "color" },
+   { "align" },
+   { "end" },
 };
 
 #define REF_FORMATTING_STATE_INIT  { 0, NULL }
 
+struct align {
+   align_type position;
+   unsigned int width;
+};
+
 struct ref_formatting_stack {
struct ref_formatting_stack *prev;
struct strbuf output;
+   void (*at_end)(struct ref_formatting_stack *stack);
+   void *at_end_data;
 };
 
 struct ref_formatting_state {
@@ -69,6 +79,9 @@ struct ref_formatting_state {
 
 struct atom_value {
const char *s;
+   union {
+   struct align align;
+   } u;
void (*handler)(struct atom_value *atomv, struct ref_formatting_state 
*state);
unsigned long ul; /* used for sorting when not FIELD_STR */
 };
@@ -165,7 +178,16 @@ static void quote_formatting(struct strbuf *s, const char 
*str, int quote_style)
 
 static void append_atom(struct atom_value *v, struct ref_formatting_state 
*state)
 {
-   quote_formatting(>stack->output, v->s, state->quote_style);
+   /*
+* Quote formatting is only done when the stack has a single
+* element. Otherwise quote formatting is done on the
+* element's entire output strbuf when the %(end) atom is
+* encountered.
+*/
+   if (!state->stack->prev)
+   quote_formatting(>stack->output, v->s, 
state->quote_style);
+   else
+   strbuf_addstr(>stack->output, v->s);
 }
 
 static void push_stack_element(struct ref_formatting_stack **stack)
@@ -189,6 +211,48 @@ static void pop_stack_element(struct ref_formatting_stack 
**stack)
*stack = prev;
 }
 
+static void end_align_handler(struct ref_formatting_stack *stack)
+{
+   struct align *align = (struct align *)stack->at_end_data;
+   struct strbuf s = STRBUF_INIT;
+
+   strbuf_utf8_align(, align->position, align->width, stack->output.buf);
+   strbuf_swap(>output, );
+   strbuf_release();

[PATCH v17 06/14] ref-filter: implement an `align` atom

[Karthik Nayak]

Implement an `align` atom which left-, middle-, or right-aligns the
content between %(align:...) and %(end).

The "align:" is followed by `` and `` in any order
separated by a comma, where the `` is either left, right or
middle, default being left and `` is the total length of the
content with alignment. If the contents length is more than the width
then no alignment is performed.  e.g. to align a refname atom to the
middle with a total width of 40 we can do:
--format="%(align:middle,40)%(refname)%(end)".

We introduce an `at_end` function for each element of the stack which
is to be called when the `end` atom is encountered. Using this we
implement end_align_handler() for the `align` atom, this aligns the
final strbuf by calling `strbuf_utf8_align()` from utf8.c.

Ensure that quote formatting is performed on the whole of
%(align:...)...%(end) rather than individual atoms inside. We skip
quote formatting for individual atoms when the current stack element
is handling an %(align:...) atom and perform quote formatting at the
end when we encounter the %(end) atom of the second element of then
stack.

Add documentation and tests for the same.

Mentored-by: Christian Couder 
Mentored-by: Matthieu Moy 
Helped-by: Junio C Hamano 
Signed-off-by: Karthik Nayak 
---
 Documentation/git-for-each-ref.txt |  11 
 ref-filter.c   | 109 -
 t/t6302-for-each-ref-filter.sh |  82 
 3 files changed, 201 insertions(+), 1 deletion(-)

diff --git a/Documentation/git-for-each-ref.txt 
b/Documentation/git-for-each-ref.txt
index e49d578..3a271bf 100644
--- a/Documentation/git-for-each-ref.txt
+++ b/Documentation/git-for-each-ref.txt
@@ -127,6 +127,17 @@ color::
Change output color.  Followed by `:`, where names
are described in `color.branch.*`.
 
+align::
+   Left-, middle-, or right-align the content between
+   %(align:...) and %(end). The "align:" is followed by ``
+   and `` in any order separated by a comma, where the
+   `` is either left, right or middle, default being
+   left and `` is the total length of the content with
+   alignment. If the contents length is more than the width then
+   no alignment is performed. If used with '--quote' everything
+   in between %(align:...) and %(end) is quoted, but if nested
+   then only the topmost level performs quoting.
+
 In addition to the above, for commit and tag objects, the header
 field names (`tree`, `parent`, `object`, `type`, and `tag`) can
 be used to specify the value in the header field.
diff --git a/ref-filter.c b/ref-filter.c
index 70d36fe..b8f719c 100644
--- a/ref-filter.c
+++ b/ref-filter.c
@@ -10,6 +10,7 @@
 #include "quote.h"
 #include "ref-filter.h"
 #include "revision.h"
+#include "utf8.h"
 
 typedef enum { FIELD_STR, FIELD_ULONG, FIELD_TIME } cmp_type;
 
@@ -53,13 +54,22 @@ static struct {
{ "flag" },
{ "HEAD" },
{ "color" },
+   { "align" },
+   { "end" },
 };
 
 #define REF_FORMATTING_STATE_INIT  { 0, NULL }
 
+struct align {
+   align_type position;
+   unsigned int width;
+};
+
 struct ref_formatting_stack {
struct ref_formatting_stack *prev;
struct strbuf output;
+   void (*at_end)(struct ref_formatting_stack *stack);
+   void *at_end_data;
 };
 
 struct ref_formatting_state {
@@ -69,6 +79,9 @@ struct ref_formatting_state {
 
 struct atom_value {
const char *s;
+   union {
+   struct align align;
+   } u;
void (*handler)(struct atom_value *atomv, struct ref_formatting_state 
*state);
unsigned long ul; /* used for sorting when not FIELD_STR */
 };
@@ -165,7 +178,16 @@ static void quote_formatting(struct strbuf *s, const char 
*str, int quote_style)
 
 static void append_atom(struct atom_value *v, struct ref_formatting_state 
*state)
 {
-   quote_formatting(>stack->output, v->s, state->quote_style);
+   /*
+* Quote formatting is only done when the stack has a single
+* element. Otherwise quote formatting is done on the
+* element's entire output strbuf when the %(end) atom is
+* encountered.
+*/
+   if (!state->stack->prev)
+   quote_formatting(>stack->output, v->s, 
state->quote_style);
+   else
+   strbuf_addstr(>stack->output, v->s);
 }
 
 static void push_stack_element(struct ref_formatting_stack **stack)
@@ -189,6 +211,48 @@ static void pop_stack_element(struct ref_formatting_stack 
**stack)
*stack = prev;
 }
 
+static void end_align_handler(struct ref_formatting_stack *stack)
+{
+   struct align *align = (struct align *)stack->at_end_data;
+   struct strbuf s = STRBUF_INIT;
+
+   strbuf_utf8_align(, align->position, align->width, stack->output.buf);
+   strbuf_swap(>output, );
+   strbuf_release();

Re: [PATCH v17 06/14] ref-filter: implement an `align` atom

[Matthieu Moy]

Karthik Nayak  writes:

> + /*
> +  * 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) {
> + if (s[1])

A comment like /* strip trailing ',' */ here would really help the
reader IMHO.

> + strbuf_setlen(s[0], s[0]->len - 1);

-- 
Matthieu Moy
http://www-verimag.imag.fr/~moy/
--
To unsubscribe from this list: send the line "unsubscribe git" in
the body of a message to majord...@vger.kernel.org
More majordomo info at  http://vger.kernel.org/majordomo-info.html

Re: [PATCH v17 06/14] ref-filter: implement an `align` atom

[Junio C Hamano]

Karthik Nayak  writes:

> Implement an `align` atom which left-, middle-, or right-aligns the
> content between %(align:...) and %(end).

Nicely done.
--
To unsubscribe from this list: send the line "unsubscribe git" in
the body of a message to majord...@vger.kernel.org
More majordomo info at  http://vger.kernel.org/majordomo-info.html