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

[PATCH/RFC 07/10] ref-filter: introduce align_atom_parser()

From
Karthik Nayak <karthik.188@gmail.com>
Date
Nov 11, 2015, 19:44 UTC
Message-ID
<1447271075-15364-8-git-send-email-Karthik.188@gmail.com>
In-Reply-To
<1447271075-15364-1-git-send-email-Karthik.188@gmail.com>

Introduce align_atom_parser() which will parse 'align' atoms and store the required width and position into the 'used_atom' structure. While we're here, add support for the usage of 'width=' and 'position=' when using the 'align' atom (e.g. %(align:position=middle,width=30)).

Add documentation and modify the existing tests in t6302 to reflect the same.

Signed-off-by: Karthik Nayak <Karthik.188@gmail.com>
---
 Documentation/git-for-each-ref.txt |  18 ++++---
 ref-filter.c                       | 102 +++++++++++++++++++++++--------------
 t/t6302-for-each-ref-filter.sh     |   4 +-
 3 files changed, 75 insertions(+), 49 deletions(-)
diff --git a/Documentation/git-for-each-ref.txt b/Documentation/git-for-each-ref.txt
index c6f073c..56ffdc1 100644
--- a/Documentation/git-for-each-ref.txt
+++ b/Documentation/git-for-each-ref.txt
@@ -129,14 +129,16 @@ color::
 
 align::
 	Left-, middle-, or right-align the content between
-	%(align:...) and %(end). The "align:" is followed by `<width>`
-	and `<position>` in any order separated by a comma, where the
-	`<position>` is either left, right or middle, default being
-	left and `<width>` 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.
+	%(align:...) and %(end). The "align:" is followed by
+	`width=<width>` and `position=<position>` in any order
+	separated by a comma, where the `<position>` is either left,
+	right or middle, default being left and `<width>` is the total
+	length of the content with alignment. The prefix for the
+	arguments is not mandatory. 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
diff --git a/ref-filter.c b/ref-filter.c
index 4e8b3c9..049e6b9 100644
--- a/ref-filter.c
+++ b/ref-filter.c
@@ -16,6 +16,11 @@
 
 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().
@@ -31,6 +36,7 @@ static struct used_atom {
 	cmp_type type;
 	union {
 		const char *color;
+		struct align align;
 	} u;
 } *used_atom;
 static int used_atom_cnt, need_tagged, need_symref;
@@ -63,6 +69,61 @@ void color_atom_parser(struct used_atom *atom)
 		die(_("expected format: %%(color:<color>)"));
 }
 
+static align_type get_align_position(const char *type)
+{
+	if (!strcmp(type, "right"))
+		return ALIGN_RIGHT;
+	else if (!strcmp(type, "middle"))
+		return ALIGN_MIDDLE;
+	else if (!strcmp(type, "left"))
+		return ALIGN_LEFT;
+	return -1;
+}
+
+void align_atom_parser(struct used_atom *atom)
+{
+	struct align *align = &atom->u.align;
+	const char *buf = NULL;
+	struct strbuf **s, **to_free;
+	int width = -1;
+
+	match_atom_name(atom->str, "align", &buf);
+	if (!buf)
+		die(_("expected format: %%(align:<width>,<position>)"));
+	s = to_free = strbuf_split_str_without_term(buf, ',', 0);
+
+	/*  By default align to ALGIN_LEFT */
+	align->position = ALIGN_LEFT;
+
+	while (*s) {
+		int position;
+		buf = s[0]->buf;
+
+		position = get_align_position(buf);
+
+		if (skip_prefix(buf, "position=", &buf)) {
+			position = get_align_position(buf);
+			if (position == -1)
+				die(_("improper format entered align:%s"), s[0]->buf);
+			align->position = position;
+		} else if (skip_prefix(buf, "width=", &buf)) {
+			if (strtoul_ui(buf, 10, (unsigned int *)&width))
+				die(_("improper format entered align:%s"), s[0]->buf);
+		} else if (!strtoul_ui(buf, 10, (unsigned int *)&width))
+				;
+		else if (position != -1)
+			align->position = position;
+		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);
+}
+
 static struct {
 	const char *name;
 	cmp_type cmp_type;
@@ -101,17 +162,12 @@ static struct {
 	{ "flag", FIELD_STR },
 	{ "HEAD", FIELD_STR },
 	{ "color", FIELD_STR, color_atom_parser },
-	{ "align", FIELD_STR },
+	{ "align", FIELD_STR, align_atom_parser },
 	{ "end", FIELD_STR },
 };
 
 #define REF_FORMATTING_STATE_INIT  { 0, NULL }
 
-struct align {
-	align_type position;
-	unsigned int width;
-};
-
 struct contents {
 	unsigned int lines;
 	struct object_id oid;
@@ -881,39 +937,7 @@ static void populate_value(struct ref_array_item *ref)
 				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_without_term(valp, ',', 0);
-
-			align->position = ALIGN_LEFT;
-
-			while (*s) {
-				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);
+			v->u.align = atom->u.align;
 			v->handler = align_atom_handler;
 			continue;
 		} else if (!strcmp(name, "end")) {
diff --git a/t/t6302-for-each-ref-filter.sh b/t/t6302-for-each-ref-filter.sh
index fe4796c..688751e 100755
--- a/t/t6302-for-each-ref-filter.sh
+++ b/t/t6302-for-each-ref-filter.sh
@@ -97,7 +97,7 @@ test_expect_success 'left alignment is default' '
 	refname is refs/tags/three    |refs/tags/three
 	refname is refs/tags/two      |refs/tags/two
 	EOF
-	git for-each-ref --format="%(align:30)refname is %(refname)%(end)|%(refname)" >actual &&
+	git for-each-ref --format="%(align:width=30)refname is %(refname)%(end)|%(refname)" >actual &&
 	test_cmp expect actual
 '
 
@@ -113,7 +113,7 @@ test_expect_success 'middle alignment' '
 	|  refname is refs/tags/three  |refs/tags/three
 	|   refname is refs/tags/two   |refs/tags/two
 	EOF
-	git for-each-ref --format="|%(align:middle,30)refname is %(refname)%(end)|%(refname)" >actual &&
+	git for-each-ref --format="|%(align:position=middle,30)refname is %(refname)%(end)|%(refname)" >actual &&
 	test_cmp expect actual
 '
 

-- 
2.6.2
Previous: Karthik NayakNext: Eric Sunshine
Message 25 of 50 in “ref-filter: use parsing functions”
  1. 00/10 ref-filter: use parsing functionsKarthik Nayak, Nov 11, 2015
  2. 01/10 ref-filter: introduce a parsing function for each atom in valid_atomKarthik Nayak, Nov 11, 2015
  3. Eric SunshineNov 23, 2015
  4. Karthik NayakNov 25, 2015
  5. Eric SunshineNov 25, 2015
  6. Karthik NayakNov 26, 2015
  7. Junio C HamanoDec 11, 2015
  8. Karthik NayakDec 12, 2015
  9. 02/10 ref-filter: introduce struct used_atomKarthik Nayak, Nov 11, 2015
  10. Eric SunshineDec 1, 2015
  11. 03/10 ref-fitler: bump match_atom() name to the topKarthik Nayak, Nov 11, 2015
  12. 04/10 ref-filter: skip deref specifier in match_atom_name()Karthik Nayak, Nov 11, 2015
  13. Eric SunshineDec 1, 2015
  14. Karthik NayakDec 3, 2015
  15. 05/10 ref-filter: introduce color_atom_parser()Karthik Nayak, Nov 11, 2015
  16. Eric SunshineDec 1, 2015
  17. Karthik NayakDec 3, 2015
  18. Eric SunshineDec 13, 2015
  19. Karthik NayakDec 13, 2015
  20. 06/10 strbuf: introduce strbuf_split_str_without_term()Karthik Nayak, Nov 11, 2015
  21. Eric SunshineDec 2, 2015
  22. Karthik NayakDec 3, 2015
  23. Junio C HamanoDec 11, 2015
  24. Karthik NayakDec 12, 2015
  25. 07/10 ref-filter: introduce align_atom_parser()Karthik Nayak, Nov 11, 2015
  26. Eric SunshineDec 2, 2015
  27. Karthik NayakDec 7, 2015
  28. 08/10 ref-filter: introduce remote_ref_atom_parser()Karthik Nayak, Nov 11, 2015
  29. Eric SunshineDec 13, 2015
  30. Karthik NayakDec 13, 2015
  31. Eric SunshineDec 13, 2015
  32. Karthik NayakDec 13, 2015
  33. Eric SunshineDec 13, 2015
  34. Karthik NayakDec 13, 2015
  35. 09/10 ref-filter: introduce contents_atom_parser()Karthik Nayak, Nov 11, 2015
  36. Eric SunshineDec 13, 2015
  37. Eric SunshineDec 13, 2015
  38. Karthik NayakDec 13, 2015
  39. Karthik NayakDec 13, 2015
  40. Jeff KingNov 24, 2015
  41. Karthik NayakNov 25, 2015
  42. 10/10 ref-filter: introduce objectname_atom_parser()Karthik Nayak, Nov 25, 2015
  43. Eric SunshineDec 13, 2015
  44. Karthik NayakDec 13, 2015
  45. Junio C HamanoDec 11, 2015
  46. Eric SunshineDec 13, 2015
  47. Karthik NayakDec 13, 2015
  48. Eric SunshineDec 13, 2015
  49. Karthik NayakDec 16, 2015
  50. Junio C HamanoDec 14, 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.