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

[PATCH 17/28] attr: expose validity check for attribute names

From
Stefan Beller <sbeller@google.com>
Date
Oct 11, 2016, 00:21 UTC
Message-ID
<20161011002115.23312-18-sbeller@google.com>
In-Reply-To
<20161011002115.23312-1-sbeller@google.com>
From: Junio C Hamano <gitster@pobox.com>

Export attr_name_valid() function, and a helper function that returns the message to be given when a given <name, len> pair is not a good name for an attribute.

We could later update the message to exactly spell out what the rules for a good attribute name are, etc.

Signed-off-by: Junio C Hamano <gitster@pobox.com>
Signed-off-by: Stefan Beller <sbeller@google.com>
---
 attr.c | 39 +++++++++++++++++++++++++--------------
 attr.h |  3 +++
 2 files changed, 28 insertions(+), 14 deletions(-)
diff --git a/attr.c b/attr.c
index 90dbacd..6e3bd25 100644
--- a/attr.c
+++ b/attr.c
@@ -59,23 +59,38 @@ static unsigned hash_name(const char *name, int namelen)
 	return val;
 }
 
-static int invalid_attr_name(const char *name, int namelen)
+int attr_name_valid(const char *name, size_t namelen)
 {
 	/*
 	 * Attribute name cannot begin with '-' and must consist of
 	 * characters from [-A-Za-z0-9_.].
 	 */
 	if (namelen <= 0 || *name == '-')
-		return -1;
+		return 0;
 	while (namelen--) {
 		char ch = *name++;
 		if (! (ch == '-' || ch == '.' || ch == '_' ||
 		       ('0' <= ch && ch <= '9') ||
 		       ('a' <= ch && ch <= 'z') ||
 		       ('A' <= ch && ch <= 'Z')) )
-			return -1;
+			return 0;
 	}
-	return 0;
+	return -1;
+}
+
+void invalid_attr_name_message(struct strbuf *err, const char *name, int len)
+{
+	strbuf_addf(err, _("%.*s is not a valid attribute name"),
+		    len, name);
+}
+
+static void report_invalid_attr(const char *name, size_t len,
+				const char *src, int lineno)
+{
+	struct strbuf err = STRBUF_INIT;
+	invalid_attr_name_message(&err, name, len);
+	fprintf(stderr, "%s: %s:%d\n", err.buf, src, lineno);
+	strbuf_release(&err);
 }
 
 struct git_attr *git_attr_counted(const char *name, size_t len)
@@ -90,7 +105,7 @@ struct git_attr *git_attr_counted(const char *name, size_t len)
 			return a;
 	}
 
-	if (invalid_attr_name(name, len))
+	if (!attr_name_valid(name, len))
 		return NULL;
 
 	FLEX_ALLOC_MEM(a, name, name, len);
@@ -176,17 +191,15 @@ static const char *parse_attr(const char *src, int lineno, const char *cp,
 			cp++;
 			len--;
 		}
-		if (invalid_attr_name(cp, len)) {
-			fprintf(stderr,
-				"%.*s is not a valid attribute name: %s:%d\n",
-				len, cp, src, lineno);
+		if (!attr_name_valid(cp, len)) {
+			report_invalid_attr(cp, len, src, lineno);
 			return NULL;
 		}
 	} else {
 		/*
 		 * As this function is always called twice, once with
 		 * e == NULL in the first pass and then e != NULL in
-		 * the second pass, no need for invalid_attr_name()
+		 * the second pass, no need for attr_name_valid()
 		 * check here.
 		 */
 		if (*cp == '-' || *cp == '!') {
@@ -229,10 +242,8 @@ static struct match_attr *parse_attr_line(const char *line, const char *src,
 		name += strlen(ATTRIBUTE_MACRO_PREFIX);
 		name += strspn(name, blank);
 		namelen = strcspn(name, blank);
-		if (invalid_attr_name(name, namelen)) {
-			fprintf(stderr,
-				"%.*s is not a valid attribute name: %s:%d\n",
-				namelen, name, src, lineno);
+		if (!attr_name_valid(name, namelen)) {
+			report_invalid_attr(name, namelen, src, lineno);
 			goto fail_return;
 		}
 	}
diff --git a/attr.h b/attr.h
index bcedf92..40abc16 100644
--- a/attr.h
+++ b/attr.h
@@ -13,6 +13,9 @@ extern struct git_attr *git_attr(const char *);
 /* The same, but with counted string */
 extern struct git_attr *git_attr_counted(const char *, size_t);
 
+extern int attr_name_valid(const char *name, size_t namelen);
+extern void invalid_attr_name_message(struct strbuf *, const char *, int);
+
 /* Internal use */
 extern const char git_attr__true[];
 extern const char git_attr__false[];
-- 
2.10.1.382.ga23ca1b.dirty
Previous: Stefan BellerNext: Brandon Williams
Message 15 of 44 in “Revamping the attr subsystem!”
  1. 00/28 Revamping the attr subsystem!Stefan Beller, Oct 11, 2016
  2. 01/28 commit.c: use strchrnul() to scan for one lineStefan Beller, Oct 11, 2016
  3. 02/28 attr.c: use strchrnul() to scan for one lineStefan Beller, Oct 11, 2016
  4. 03/28 attr.c: update a stale comment on "struct match_attr"Stefan Beller, Oct 11, 2016
  5. 07/28 attr.c: simplify macroexpand_one()Stefan Beller, Oct 11, 2016
  6. 05/28 attr.c: complete a sentence in a commentStefan Beller, Oct 11, 2016
  7. 04/28 attr.c: explain the lack of attr-name syntax check in parse_attr()Stefan Beller, Oct 11, 2016
  8. 06/28 attr.c: mark where #if DEBUG ends more clearlyStefan Beller, Oct 11, 2016
  9. 09/28 attr.c: plug small leak in parse_attr_line()Stefan Beller, Oct 11, 2016
  10. 08/28 attr.c: tighten constness around "git_attr" structureStefan Beller, Oct 11, 2016
  11. 10/28 attr: rename function and struct related to checking attributesStefan Beller, Oct 11, 2016
  12. 14/28 attr: retire git_check_attrs() APIStefan Beller, Oct 11, 2016
  13. 13/28 attr: convert git_check_attrs() callers to use the new APIStefan Beller, Oct 11, 2016
  14. 16/28 attr: add counted string version of git_attr()Stefan Beller, Oct 11, 2016
  15. 17/28 attr: expose validity check for attribute namesStefan Beller, Oct 11, 2016
  16. Brandon WilliamsOct 11, 2016
  17. Stefan BellerOct 11, 2016
  18. Brandon WilliamsOct 11, 2016
  19. Stefan BellerOct 11, 2016
  20. Brandon WilliamsOct 11, 2016
  21. 15/28 attr: add counted string version of git_check_attr()Stefan Beller, Oct 11, 2016
  22. 19/28 attr.c: add push_stack() helperStefan Beller, Oct 11, 2016
  23. 18/28 attr: support quoting pathname patterns in C styleStefan Beller, Oct 11, 2016
  24. 21/28 attr.c: rename a local variable checkStefan Beller, Oct 11, 2016
  25. 25/28 attr.c: outline the future plans by heavily commentingStefan Beller, Oct 11, 2016
  26. 20/28 attr.c: pass struct git_attr_check down the callchainStefan Beller, Oct 11, 2016
  27. 26/28 attr: make git_attr_counted staticStefan Beller, Oct 11, 2016
  28. Brandon WilliamsOct 11, 2016
  29. Stefan BellerOct 11, 2016
  30. 27/28 attr: make git_check_attr_counted staticStefan Beller, Oct 11, 2016
  31. 23/28 attr.c: introduce empty_attr_check_elems()Stefan Beller, Oct 11, 2016
  32. 28/28 attr: convert to new threadsafe APIStefan Beller, Oct 11, 2016
  33. Brandon WilliamsOct 11, 2016
  34. Junio C HamanoOct 11, 2016
  35. Stefan BellerOct 11, 2016
  36. Junio C HamanoOct 11, 2016
  37. Stefan BellerOct 11, 2016
  38. Junio C HamanoOct 11, 2016
  39. 24/28 attr.c: always pass check[] to collect_some_attrs()Stefan Beller, Oct 11, 2016
  40. 22/28 attr.c: correct ugly hack for git_all_attrs()Stefan Beller, Oct 11, 2016
  41. 11/28 attr: (re)introduce git_check_attr() and struct git_attr_checkStefan Beller, Oct 11, 2016
  42. Brandon WilliamsOct 11, 2016
  43. Junio C HamanoOct 11, 2016
  44. 12/28 attr: convert git_all_attrs() to use "struct git_attr_check"Stefan Beller, Oct 11, 2016

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.