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

[PATCH v3 05/10] interpret-trailers: access trailer_info with new helpers

From
LGLinus Arver via GitGitGadget <gitgitgadget@gmail.com>
Date
Apr 26, 2024, 00:26 UTC
Message-ID
<460979ba9643c5b7eb0fb93a51ba4817396bcbf7.1714091170.git.gitgitgadget@gmail.com>
In-Reply-To
<pull.1696.v3.git.1714091170.gitgitgadget@gmail.com>
From: Linus Arver <linusa@google.com>

Instead of directly accessing trailer_info members, access them indirectly through new helper functions exposed by the trailer API.

This is the first of two preparatory commits which will allow us to use the so-called "pimpl" (pointer to implementation) idiom for the trailer API, by making the trailer_info struct private to the trailer implementation (and thus hidden from the API).

Helped-by: Christian Couder <chriscool@tuxfamily.org>
Signed-off-by: Linus Arver <linusa@google.com>
---
 builtin/interpret-trailers.c | 12 ++++++------
 trailer.c                    | 21 +++++++++++++++++++++
 trailer.h                    |  4 ++++
 3 files changed, 31 insertions(+), 6 deletions(-)
diff --git a/builtin/interpret-trailers.c b/builtin/interpret-trailers.c
index 11f4ce9e4a2..f3240682e35 100644
--- a/builtin/interpret-trailers.c
+++ b/builtin/interpret-trailers.c
@@ -141,7 +141,7 @@ static void interpret_trailers(const struct process_trailer_options *opts,
 	LIST_HEAD(head);
 	struct strbuf sb = STRBUF_INIT;
 	struct strbuf trailer_block = STRBUF_INIT;
-	struct trailer_info info;
+	struct trailer_info *info = trailer_info_new();
 	FILE *outfile = stdout;
 
 	trailer_config_init();
@@ -151,13 +151,13 @@ static void interpret_trailers(const struct process_trailer_options *opts,
 	if (opts->in_place)
 		outfile = create_in_place_tempfile(file);
 
-	parse_trailers(opts, &info, sb.buf, &head);
+	parse_trailers(opts, info, sb.buf, &head);
 
 	/* Print the lines before the trailers */
 	if (!opts->only_trailers)
-		fwrite(sb.buf, 1, info.trailer_block_start, outfile);
+		fwrite(sb.buf, 1, trailer_block_start(info), outfile);
 
-	if (!opts->only_trailers && !info.blank_line_before_trailer)
+	if (!opts->only_trailers && !blank_line_before_trailer_block(info))
 		fprintf(outfile, "\n");
 
 
@@ -178,8 +178,8 @@ static void interpret_trailers(const struct process_trailer_options *opts,
 
 	/* Print the lines after the trailers as is */
 	if (!opts->only_trailers)
-		fwrite(sb.buf + info.trailer_block_end, 1, sb.len - info.trailer_block_end, outfile);
-	trailer_info_release(&info);
+		fwrite(sb.buf + trailer_block_end(info), 1, sb.len - trailer_block_end(info), outfile);
+	trailer_info_release(info);
 
 	if (opts->in_place)
 		if (rename_tempfile(&trailers_tempfile, file))
diff --git a/trailer.c b/trailer.c
index 4700c441442..95b4c9b8f19 100644
--- a/trailer.c
+++ b/trailer.c
@@ -952,6 +952,12 @@ static void unfold_value(struct strbuf *val)
 	strbuf_release(&out);
 }
 
+struct trailer_info *trailer_info_new(void)
+{
+	struct trailer_info *info = xcalloc(1, sizeof(*info));
+	return info;
+}
+
 /*
  * Parse trailers in "str", populating the trailer info and "head"
  * linked list structure.
@@ -1000,6 +1006,21 @@ void free_trailers(struct list_head *trailers)
 	}
 }
 
+size_t trailer_block_start(struct trailer_info *info)
+{
+	return info->trailer_block_start;
+}
+
+size_t trailer_block_end(struct trailer_info *info)
+{
+	return info->trailer_block_end;
+}
+
+int blank_line_before_trailer_block(struct trailer_info *info)
+{
+	return info->blank_line_before_trailer;
+}
+
 void trailer_info_get(const struct process_trailer_options *opts,
 		      const char *str,
 		      struct trailer_info *info)
diff --git a/trailer.h b/trailer.h
index ebafa3657e4..9ac4be853c5 100644
--- a/trailer.h
+++ b/trailer.h
@@ -97,6 +97,10 @@ void parse_trailers(const struct process_trailer_options *,
 void trailer_info_get(const struct process_trailer_options *,
 		      const char *str,
 		      struct trailer_info *);
+size_t trailer_block_start(struct trailer_info *);
+size_t trailer_block_end(struct trailer_info *);
+int blank_line_before_trailer_block(struct trailer_info *);
+struct trailer_info *trailer_info_new(void);
 
 void trailer_info_release(struct trailer_info *info);
 
-- 
gitgitgadget
Previous: Linus Arver via GitGitGadgetNext: Linus Arver via GitGitGadget
Message 41 of 66 in “Make trailer_info struct private (plus sequencer cleanup)”
  1. 0/6 Make trailer_info struct private (plus sequencer cleanup)Linus Arver via GitGitGadget, Mar 16, 2024
  2. 1/6 trailer: teach iterator about non-trailer linesLinus Arver via GitGitGadget, Mar 16, 2024
  3. 2/6 sequencer: use the trailer iteratorLinus Arver via GitGitGadget, Mar 16, 2024
  4. 3/6 interpret-trailers: access trailer_info with new helpersLinus Arver via GitGitGadget, Mar 16, 2024
  5. 4/6 trailer: make parse_trailers() return trailer_info pointerLinus Arver via GitGitGadget, Mar 16, 2024
  6. 5/6 trailer: make trailer_info struct privateLinus Arver via GitGitGadget, Mar 16, 2024
  7. 6/6 trailer: retire trailer_info_get() from APILinus Arver via GitGitGadget, Mar 16, 2024
  8. Junio C HamanoMar 16, 2024
  9. Junio C HamanoMar 26, 2024
  10. Linus ArverApr 19, 2024
  11. 0/8 Make trailer_info struct private (plus sequencer cleanup)Linus Arver via GitGitGadget, Apr 19, 2024
  12. 1/8 Makefile: sort UNIT_TEST_PROGRAMSLinus Arver via GitGitGadget, Apr 19, 2024
  13. 2/8 trailer: add unit tests for trailer iteratorLinus Arver via GitGitGadget, Apr 19, 2024
  14. Linus ArverApr 19, 2024
  15. Linus ArverApr 19, 2024
  16. Junio C HamanoApr 19, 2024
  17. Linus ArverApr 20, 2024
  18. 3/8 trailer: teach iterator about non-trailer linesLinus Arver via GitGitGadget, Apr 19, 2024
  19. 4/8 sequencer: use the trailer iteratorLinus Arver via GitGitGadget, Apr 19, 2024
  20. Junio C HamanoApr 23, 2024
  21. 5/8 interpret-trailers: access trailer_info with new helpersLinus Arver via GitGitGadget, Apr 19, 2024
  22. 7/8 trailer: make trailer_info struct privateLinus Arver via GitGitGadget, Apr 19, 2024
  23. Junio C HamanoApr 23, 2024
  24. Linus ArverApr 25, 2024
  25. 6/8 trailer: make parse_trailers() return trailer_info pointerLinus Arver via GitGitGadget, Apr 19, 2024
  26. Junio C HamanoApr 23, 2024
  27. 8/8 trailer: retire trailer_info_get() from APILinus Arver via GitGitGadget, Apr 19, 2024
  28. Junio C HamanoApr 23, 2024
  29. Junio C HamanoApr 24, 2024
  30. 00/10 Make trailer_info struct private (plus sequencer cleanup)Linus Arver via GitGitGadget, Apr 26, 2024
  31. 01/10 Makefile: sort UNIT_TEST_PROGRAMSLinus Arver via GitGitGadget, Apr 26, 2024
  32. 02/10 trailer: add unit tests for trailer iteratorLinus Arver via GitGitGadget, Apr 26, 2024
  33. Christian CouderApr 26, 2024
  34. Junio C HamanoApr 26, 2024
  35. Linus ArverApr 26, 2024
  36. 03/10 trailer: teach iterator about non-trailer linesLinus Arver via GitGitGadget, Apr 26, 2024
  37. Christian CouderApr 27, 2024
  38. Linus ArverApr 30, 2024
  39. Linus ArverApr 30, 2024
  40. 04/10 sequencer: use the trailer iteratorLinus Arver via GitGitGadget, Apr 26, 2024
  41. 05/10 interpret-trailers: access trailer_info with new helpersLinus Arver via GitGitGadget, Apr 26, 2024
  42. 06/10 trailer: make parse_trailers() return trailer_info pointerLinus Arver via GitGitGadget, Apr 26, 2024
  43. 07/10 trailer: make trailer_info struct privateLinus Arver via GitGitGadget, Apr 26, 2024
  44. 08/10 trailer: retire trailer_info_get() from APILinus Arver via GitGitGadget, Apr 26, 2024
  45. 10/10 trailer unit tests: inspect iterator contentsLinus Arver via GitGitGadget, Apr 26, 2024
  46. 09/10 trailer: document parse_trailers() usageLinus Arver via GitGitGadget, Apr 26, 2024
  47. Christian CouderApr 27, 2024
  48. 00/10 Make trailer_info struct private (plus sequencer cleanup)Linus Arver via GitGitGadget, May 2, 2024
  49. 01/10 Makefile: sort UNIT_TEST_PROGRAMSLinus Arver via GitGitGadget, May 2, 2024
  50. 02/10 trailer: add unit tests for trailer iteratorLinus Arver via GitGitGadget, May 2, 2024
  51. Junio C HamanoMay 2, 2024
  52. 03/10 trailer: teach iterator about non-trailer linesLinus Arver via GitGitGadget, May 2, 2024
  53. Phillip WoodMay 4, 2024
  54. Linus ArverMay 5, 2024
  55. Phillip WoodMay 5, 2024
  56. Linus ArverMay 9, 2024
  57. Phillip WoodMay 13, 2024
  58. Phillip WoodMay 13, 2024
  59. 04/10 sequencer: use the trailer iteratorLinus Arver via GitGitGadget, May 2, 2024
  60. 05/10 interpret-trailers: access trailer_info with new helpersLinus Arver via GitGitGadget, May 2, 2024
  61. 06/10 trailer: make parse_trailers() return trailer_info pointerLinus Arver via GitGitGadget, May 2, 2024
  62. 07/10 trailer: make trailer_info struct privateLinus Arver via GitGitGadget, May 2, 2024
  63. 08/10 trailer: retire trailer_info_get() from APILinus Arver via GitGitGadget, May 2, 2024
  64. 09/10 trailer: document parse_trailers() usageLinus Arver via GitGitGadget, May 2, 2024
  65. 10/10 trailer unit tests: inspect iterator contentsLinus Arver via GitGitGadget, May 2, 2024
  66. Junio C HamanoMay 2, 2024

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.