From: "Martin Ågren" <martin.agren@gmail.com>
To: git@vger.kernel.org
Cc: Junio C Hamano <gitster@pobox.com>
Subject: [PATCH 7/8] pretty: refactor parsing of magic
Date: Wed, 19 Mar 2025 08:23:40 +0100 [thread overview]
Message-ID: <7c96899bb520ab945a650205982f54d65461d5bd.1742367347.git.martin.agren@gmail.com> (raw)
In-Reply-To: <cover.1742367347.git.martin.agren@gmail.com>
Similar to the previous commit, pull out our parsing of initial
placeholder magic into a separate function. This helps make it a bit
easier to get an overview of `format_commit_item()`. It also represents
another small step towards separating the parsing of placeholders from
subsequent usage of the parsed information.
This diff might be a bit easier to read with `-w`.
Signed-off-by: Martin Ågren <martin.agren@gmail.com>
---
pretty.c | 69 ++++++++++++++++++++++++++++++++++----------------------
1 file changed, 42 insertions(+), 27 deletions(-)
diff --git a/pretty.c b/pretty.c
index c44ff87481..ddc7fd6aab 100644
--- a/pretty.c
+++ b/pretty.c
@@ -1929,17 +1929,17 @@ static size_t format_and_pad_commit(struct strbuf *sb, /* in UTF-8 */
return total_consumed;
}
-static size_t format_commit_item(struct strbuf *sb, /* in UTF-8 */
- const char *placeholder,
- struct format_commit_context *context)
+enum magic {
+ NO_MAGIC,
+ ADD_LF_BEFORE_NON_EMPTY,
+ DEL_LF_BEFORE_EMPTY,
+ ADD_SP_BEFORE_NON_EMPTY
+};
+
+/* 2 for 'bad magic', otherwise whether we consumed 0 or 1 chars. */
+static size_t parse_magic(const char *placeholder, enum magic *ret)
{
- size_t consumed, orig_len;
- enum {
- NO_MAGIC,
- ADD_LF_BEFORE_NON_EMPTY,
- DEL_LF_BEFORE_EMPTY,
- ADD_SP_BEFORE_NON_EMPTY
- } magic = NO_MAGIC;
+ enum magic magic;
switch (placeholder[0]) {
case '-':
@@ -1952,28 +1952,43 @@ static size_t format_commit_item(struct strbuf *sb, /* in UTF-8 */
magic = ADD_SP_BEFORE_NON_EMPTY;
break;
default:
- break;
+ *ret = NO_MAGIC;
+ return 0;
}
- if (magic != NO_MAGIC) {
- placeholder++;
- switch (placeholder[0]) {
- case 'w':
- /*
- * `%+w()` cannot ever expand to a non-empty string,
- * and it potentially changes the layout of preceding
- * contents. We're thus not able to handle the magic in
- * this combination and refuse the pattern.
- */
- return 0;
- };
- }
+ switch (placeholder[1]) {
+ case 'w':
+ /*
+ * `%+w()` cannot ever expand to a non-empty string,
+ * and it potentially changes the layout of preceding
+ * contents. We're thus not able to handle the magic in
+ * this combination and refuse the pattern.
+ */
+ *ret = NO_MAGIC;
+ return 2;
+ };
+
+ *ret = magic;
+ return 1;
+}
+
+static size_t format_commit_item(struct strbuf *sb, /* in UTF-8 */
+ const char *placeholder,
+ struct format_commit_context *context)
+{
+ size_t consumed, orig_len;
+ enum magic magic;
+
+ consumed = parse_magic(placeholder, &magic);
+ if (consumed > 1)
+ return 0;
+ placeholder += consumed;
orig_len = sb->len;
if (context->pad.flush_type == no_flush)
- consumed = format_commit_one(sb, placeholder, context);
+ consumed += format_commit_one(sb, placeholder, context);
else
- consumed = format_and_pad_commit(sb, placeholder, context);
+ consumed += format_and_pad_commit(sb, placeholder, context);
if (magic == NO_MAGIC)
return consumed;
@@ -1986,7 +2001,7 @@ static size_t format_commit_item(struct strbuf *sb, /* in UTF-8 */
else if (magic == ADD_SP_BEFORE_NON_EMPTY)
strbuf_insertstr(sb, orig_len, " ");
}
- return consumed + 1;
+ return consumed;
}
void userformat_find_requirements(const char *fmt, struct userformat_want *w)
--
2.49.0.472.ge94155a9ec
next prev parent reply other threads:[~2025-03-19 7:25 UTC|newest]
Thread overview: 22+ messages / expand[flat|nested] mbox.gz Atom feed top
2025-03-19 7:23 [PATCH 0/8] pretty: minor bugfixing, some refactorings Martin Ågren
2025-03-19 7:23 ` [PATCH 1/8] pretty: tighten function signature to not take `void *` Martin Ågren
2025-03-20 9:18 ` Patrick Steinhardt
2025-03-19 7:23 ` [PATCH 2/8] pretty: simplify if-else to reduce code duplication Martin Ågren
2025-03-20 9:17 ` Patrick Steinhardt
2025-03-20 16:10 ` Martin Ågren
2025-03-24 3:50 ` Jeff King
2025-03-19 7:23 ` [PATCH 3/8] pretty: collect padding-related fields in separate struct Martin Ågren
2025-03-19 7:23 ` [PATCH 4/8] pretty: fix parsing of half-valid "%<" and "%>" placeholders Martin Ågren
2025-03-20 9:18 ` Patrick Steinhardt
2025-03-20 16:11 ` Martin Ågren
2025-03-24 10:10 ` Patrick Steinhardt
2025-03-19 7:23 ` [PATCH 5/8] pretty: after padding, reset padding info Martin Ågren
2025-03-20 9:18 ` Patrick Steinhardt
2025-03-20 16:11 ` Martin Ågren
2025-03-19 7:23 ` [PATCH 6/8] pretty: refactor parsing of line-wrapping "%w" placeholder Martin Ågren
2025-03-20 9:18 ` Patrick Steinhardt
2025-03-20 16:11 ` Martin Ågren
2025-03-19 7:23 ` Martin Ågren [this message]
2025-03-20 9:18 ` [PATCH 7/8] pretty: refactor parsing of magic Patrick Steinhardt
2025-03-20 16:12 ` Martin Ågren
2025-03-19 7:23 ` [PATCH 8/8] pretty: refactor parsing of decoration options 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
* Reply using the --to, --cc, and --in-reply-to
switches of git-send-email(1):
git send-email \
--in-reply-to=7c96899bb520ab945a650205982f54d65461d5bd.1742367347.git.martin.agren@gmail.com \
--to=martin.agren@gmail.com \
--cc=git@vger.kernel.org \
--cc=gitster@pobox.com \
/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.
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 NNTP newsgroup(s).