From: Ramkumar Ramachandra <artagnon@gmail.com>
To: Git List <git@vger.kernel.org>
Cc: "Nguyễn Thái Ngọc Duy" <pclouds@gmail.com>,
"Junio C Hamano" <gitster@pobox.com>
Subject: [PATCH v2 05/15] pretty: extend pretty_print_context with callback
Date: Sun, 9 Jun 2013 23:24:24 +0530 [thread overview]
Message-ID: <1370800474-8940-6-git-send-email-artagnon@gmail.com> (raw)
In-Reply-To: <1370800474-8940-1-git-send-email-artagnon@gmail.com>
From: Nguyễn Thái Ngọc Duy <pclouds@gmail.com>
The struct pretty_print_context contains the context in which the
placeholders in format_commit_one() should be parsed. Although
format_commit_one() primarily acts as a parser, there is no way for a
caller to plug in custom callbacks. Now, callers can:
1. Parse a custom placeholder that is not supported by
format_commit_one(), and act on it independently of the pretty
machinery.
2. Parse a custom placeholder to substitute the custom placeholder with
a placeholder that format_commit_one() understands. This is
especially useful for supporting %>(*), where * is substituted with a
length computed by the caller.
To support these two usecases, the interface for the function looks
like:
typedef size_t (*format_message_fn)(struct strbuf *sb,
const char *placeholder,
void *format_context,
void *user_data,
struct strbuf *placeholder_subst)
It is exactly like format_commit_one(), except that there are two
additional fields: user_data (to pass custom data to the callback), and
placeholder_subst (to set the substitution). The callback should return
the length of the original string parsed, and optionally set
placeholder_subst.
[rr: commit message, minor modifications]
Signed-off-by: Nguyễn Thái Ngọc Duy <pclouds@gmail.com>
Signed-off-by: Ramkumar Ramachandra <artagnon@gmail.com>
---
commit.h | 8 ++++++++
pretty.c | 25 +++++++++++++++++++++++++
2 files changed, 33 insertions(+)
diff --git a/commit.h b/commit.h
index 6e9c7cd..38dc0c0 100644
--- a/commit.h
+++ b/commit.h
@@ -78,6 +78,12 @@ enum cmit_fmt {
CMIT_FMT_UNSPECIFIED
};
+typedef size_t (*format_message_fn)(struct strbuf *sb,
+ const char *placeholder,
+ void *format_context,
+ void *user_data,
+ struct strbuf *placeholder_subst);
+
struct pretty_print_context {
enum cmit_fmt fmt;
int abbrev;
@@ -92,6 +98,8 @@ struct pretty_print_context {
const char *output_encoding;
struct string_list *mailmap;
int color;
+ format_message_fn format;
+ void *user_data;
};
struct userformat_want {
diff --git a/pretty.c b/pretty.c
index 9e43154..095e5ba 100644
--- a/pretty.c
+++ b/pretty.c
@@ -1069,6 +1069,31 @@ static size_t format_commit_one(struct strbuf *sb, /* in UTF-8 */
struct commit_list *p;
int h1, h2;
+ if (c->pretty_ctx->format) {
+ struct strbuf subst = STRBUF_INIT;
+ int ret = c->pretty_ctx->format(sb, placeholder, context,
+ c->pretty_ctx->user_data,
+ &subst);
+ if (ret && subst.len) {
+ /*
+ * Something was parsed by format(), and a
+ * placeholder-substitution was set.
+ * Recursion is required to override the
+ * return value of format_commit_one() with
+ * ret: the length of the original string
+ * before substitution.
+ */
+ ret = format_commit_one(sb, subst.buf, context) ? ret : 0;
+ strbuf_release(&subst);
+ return ret;
+ } else if (ret)
+ /*
+ * Something was parsed by format(), but
+ * no placeholder-substitution was set.
+ */
+ return ret;
+ }
+
/* these are independent of the commit */
switch (placeholder[0]) {
case 'C':
--
1.8.3.247.g485169c
next prev parent reply other threads:[~2013-06-09 17:56 UTC|newest]
Thread overview: 19+ messages / expand[flat|nested] mbox.gz Atom feed top
2013-06-09 17:54 [PATCH v2 00/15] Towards a more awesome git branch Ramkumar Ramachandra
2013-06-09 17:54 ` [PATCH v2 01/15] for-each-ref, quote: convert *_quote_print -> *_quote_buf Ramkumar Ramachandra
2013-06-09 17:54 ` [PATCH v2 02/15] for-each-ref: don't print out elements directly Ramkumar Ramachandra
2013-06-09 17:54 ` [PATCH v2 03/15] tar-tree: remove dependency on sq_quote_print() Ramkumar Ramachandra
2013-06-09 17:54 ` [PATCH v2 04/15] quote: remove sq_quote_print() Ramkumar Ramachandra
2013-06-09 17:54 ` Ramkumar Ramachandra [this message]
2013-06-09 17:54 ` [PATCH v2 06/15] pretty: limit recursion in format_commit_one() Ramkumar Ramachandra
2013-06-09 17:54 ` [PATCH v2 07/15] pretty: allow passing NULL commit to format_commit_message() Ramkumar Ramachandra
2013-06-09 17:54 ` [PATCH v2 08/15] for-each-ref: get --pretty using format_commit_message() Ramkumar Ramachandra
2013-06-09 17:54 ` [PATCH v2 09/15] for-each-ref: teach verify_format() about pretty's syntax Ramkumar Ramachandra
2013-06-09 17:54 ` [PATCH v2 10/15] for-each-ref: introduce format specifier %>(*) and %<(*) Ramkumar Ramachandra
2013-06-09 17:54 ` [PATCH v2 11/15] for-each-ref: introduce %(HEAD) marker Ramkumar Ramachandra
2013-06-09 17:54 ` [PATCH v2 12/15] for-each-ref: introduce %(upstream:track[short]) Ramkumar Ramachandra
2013-06-09 17:54 ` [PATCH v2 13/15] for-each-ref: improve responsiveness of %(upstream:track) Ramkumar Ramachandra
2013-06-09 17:54 ` [PATCH v2 14/15] pretty: introduce get_pretty_userformat Ramkumar Ramachandra
2013-06-09 17:54 ` [PATCH v2 15/15] for-each-ref: use get_pretty_userformat in --pretty Ramkumar Ramachandra
2013-06-10 1:25 ` [PATCH v2 00/15] Towards a more awesome git branch Duy Nguyen
2013-06-10 12:08 ` Ramkumar Ramachandra
2013-06-10 16:02 ` Junio C Hamano
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=1370800474-8940-6-git-send-email-artagnon@gmail.com \
--to=artagnon@gmail.com \
--cc=git@vger.kernel.org \
--cc=gitster@pobox.com \
--cc=pclouds@gmail.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.
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).