From: Jeff King <peff@peff.net>
To: git@vger.kernel.org
Subject: [PATCH 3/8] trailer: add interface for iterating over commit trailers
Date: Fri, 25 Sep 2020 03:02:49 -0400 [thread overview]
Message-ID: <20200925070249.GC62741@coredump.intra.peff.net> (raw)
In-Reply-To: <20200925070120.GA3669667@coredump.intra.peff.net>
The trailer code knows how to parse out the trailers and re-format them,
but there's no easy way to iterate over the trailers (you can use
trailer_info, but you have to then do a bunch of extra parsing).
Let's add an iteration interface that makes this easy to do.
Signed-off-by: Jeff King <peff@peff.net>
---
trailer.c | 36 ++++++++++++++++++++++++++++++++++++
trailer.h | 44 ++++++++++++++++++++++++++++++++++++++++++--
2 files changed, 78 insertions(+), 2 deletions(-)
diff --git a/trailer.c b/trailer.c
index 68dabc2556..3f7391d793 100644
--- a/trailer.c
+++ b/trailer.c
@@ -1183,3 +1183,39 @@ void format_trailers_from_commit(struct strbuf *out, const char *msg,
format_trailer_info(out, &info, opts);
trailer_info_release(&info);
}
+
+void trailer_iterator_init(struct trailer_iterator *iter, const char *msg)
+{
+ struct process_trailer_options opts = PROCESS_TRAILER_OPTIONS_INIT;
+ strbuf_init(&iter->key, 0);
+ strbuf_init(&iter->val, 0);
+ opts.no_divider = 1;
+ trailer_info_get(&iter->info, msg, &opts);
+ iter->cur = 0;
+}
+
+int trailer_iterator_advance(struct trailer_iterator *iter)
+{
+ while (iter->cur < iter->info.trailer_nr) {
+ char *trailer = iter->info.trailers[iter->cur++];
+ int separator_pos = find_separator(trailer, separators);
+
+ if (separator_pos < 1)
+ continue; /* not a real trailer */
+
+ strbuf_reset(&iter->key);
+ strbuf_reset(&iter->val);
+ parse_trailer(&iter->key, &iter->val, NULL,
+ trailer, separator_pos);
+ unfold_value(&iter->val);
+ return 1;
+ }
+ return 0;
+}
+
+void trailer_iterator_release(struct trailer_iterator *iter)
+{
+ trailer_info_release(&iter->info);
+ strbuf_release(&iter->val);
+ strbuf_release(&iter->key);
+}
diff --git a/trailer.h b/trailer.h
index 203acf4ee1..af9949363a 100644
--- a/trailer.h
+++ b/trailer.h
@@ -2,8 +2,7 @@
#define TRAILER_H
#include "list.h"
-
-struct strbuf;
+#include "strbuf.h"
enum trailer_where {
WHERE_DEFAULT,
@@ -103,4 +102,45 @@ void trailer_info_release(struct trailer_info *info);
void format_trailers_from_commit(struct strbuf *out, const char *msg,
const struct process_trailer_options *opts);
+/*
+ * An interface for iterating over the trailers found in a particular commit
+ * message. Use like:
+ *
+ * struct trailer_iterator iter;
+ * trailer_iterator_init(&iter, msg);
+ * while (trailer_iterator_advance(&iter))
+ * ... do something with iter.key and iter.val ...
+ * trailer_iterator_release(&iter);
+ */
+struct trailer_iterator {
+ struct strbuf key;
+ struct strbuf val;
+
+ /* private */
+ struct trailer_info info;
+ size_t cur;
+};
+
+/*
+ * Initialize "iter" in preparation for walking over the trailers in the commit
+ * message "msg". The "msg" pointer must remain valid until the iterator is
+ * released.
+ *
+ * After initializing, we are not yet pointing
+ */
+void trailer_iterator_init(struct trailer_iterator *iter, const char *msg);
+
+/*
+ * Advance to the next trailer of the iterator. Returns 0 if there is no such
+ * trailer, and 1 otherwise. The key and value of the trailer can be
+ * fetched from the iter->key and iter->value fields (which are valid
+ * only until the next advance).
+ */
+int trailer_iterator_advance(struct trailer_iterator *iter);
+
+/*
+ * Release all resources associated with the trailer iteration.
+ */
+void trailer_iterator_release(struct trailer_iterator *iter);
+
#endif /* TRAILER_H */
--
2.28.0.1085.g44a0350633
next prev parent reply other threads:[~2020-09-25 7:02 UTC|newest]
Thread overview: 44+ messages / expand[flat|nested] mbox.gz Atom feed top
2020-09-25 7:01 [PATCH 0/8] parsing trailers with shortlog Jeff King
2020-09-25 7:01 ` [PATCH 1/8] shortlog: change "author" variables to "ident" Jeff King
2020-09-25 7:02 ` [PATCH 2/8] shortlog: refactor committer/author grouping Jeff King
2020-09-25 20:05 ` Eric Sunshine
2020-09-27 8:03 ` Jeff King
2020-09-27 8:08 ` Jeff King
2020-09-27 8:23 ` Eric Sunshine
2020-09-26 12:31 ` Martin Ågren
2020-09-27 7:59 ` Jeff King
2020-09-25 7:02 ` Jeff King [this message]
2020-09-26 12:39 ` [PATCH 3/8] trailer: add interface for iterating over commit trailers Martin Ågren
2020-09-27 8:20 ` Jeff King
2020-09-25 7:03 ` [PATCH 4/8] shortlog: match commit trailers with --group Jeff King
2020-09-25 7:05 ` [PATCH 5/8] shortlog: de-duplicate trailer values Jeff King
2020-09-25 7:05 ` [PATCH 6/8] shortlog: rename parse_stdin_ident() Jeff King
2020-09-25 7:05 ` [PATCH 7/8] shortlog: parse trailer idents Jeff King
2020-09-25 7:05 ` [PATCH 8/8] shortlog: allow multiple groups to be specified Jeff King
2020-09-25 20:23 ` Eric Sunshine
2020-09-27 8:06 ` Jeff King
2020-09-26 12:48 ` Martin Ågren
2020-09-27 8:25 ` Jeff King
2020-09-25 14:27 ` [PATCH 0/8] parsing trailers with shortlog Derrick Stolee
2020-09-25 16:57 ` Junio C Hamano
2020-09-27 8:39 ` [PATCH v2 " Jeff King
2020-09-27 8:39 ` [PATCH v2 1/8] shortlog: change "author" variables to "ident" Jeff King
2020-09-27 19:18 ` Junio C Hamano
2020-09-27 8:39 ` [PATCH v2 2/8] shortlog: add grouping option Jeff King
2020-09-27 8:40 ` [PATCH v2 3/8] trailer: add interface for iterating over commit trailers Jeff King
2020-09-27 8:40 ` [PATCH v2 4/8] shortlog: match commit trailers with --group Jeff King
2020-09-27 19:51 ` Junio C Hamano
2020-09-28 3:17 ` Jeff King
2020-09-28 17:01 ` Junio C Hamano
2020-09-27 8:40 ` [PATCH v2 5/8] shortlog: de-duplicate trailer values Jeff King
2020-09-27 20:23 ` Junio C Hamano
2020-09-28 3:19 ` Jeff King
2020-09-27 8:40 ` [PATCH v2 6/8] shortlog: rename parse_stdin_ident() Jeff King
2020-09-27 8:40 ` [PATCH v2 7/8] shortlog: parse trailer idents Jeff King
2020-09-27 20:49 ` Junio C Hamano
2020-09-27 8:40 ` [PATCH v2 8/8] shortlog: allow multiple groups to be specified Jeff King
2020-09-27 21:18 ` Junio C Hamano
2020-09-28 3:25 ` Jeff King
2020-12-28 11:29 ` Junio C Hamano
2021-02-04 6:44 ` Junio C Hamano
2020-09-27 14:38 ` [PATCH v2 0/8] parsing trailers with shortlog Martin Ågren
Reply instructions:
You may reply publicly to this message via plain-text email
using any one of the following methods:
* Save the following mbox file, import it into your mail client,
and reply-to-all from there: mbox
Avoid top-posting and favor interleaved quoting:
https://en.wikipedia.org/wiki/Posting_style#Interleaved_style
List information: http://vger.kernel.org/majordomo-info.html
* Reply using the --to, --cc, and --in-reply-to
switches of git-send-email(1):
git send-email \
--in-reply-to=20200925070249.GC62741@coredump.intra.peff.net \
--to=peff@peff.net \
--cc=git@vger.kernel.org \
/path/to/YOUR_REPLY
https://kernel.org/pub/software/scm/git/docs/git-send-email.html
* If your mail client supports setting the In-Reply-To header
via mailto: links, try the mailto: link
Be sure your reply has a Subject: header at the top and a blank line
before the message body.
Code repositories for project(s) associated with this public inbox
https://80x24.org/mirrors/git.git
This is a public inbox, see mirroring instructions
for how to clone and mirror all data and code used for this inbox;
as well as URLs for read-only IMAP folder(s) and NNTP newsgroup(s).