From: Junio C Hamano <gitster@pobox.com>
To: git@vger.kernel.org
Cc: Johannes Schindelin <Johannes.Schindelin@gmx.de>,
Jeff King <peff@peff.net>
Subject: [PREVIEW v3 9/9] strbuf: give strbuf_getline() to the "most text friendly" variant
Date: Wed, 13 Jan 2016 19:03:09 -0800 [thread overview]
Message-ID: <1452740590-16827-10-git-send-email-gitster@pobox.com> (raw)
In-Reply-To: <1452740590-16827-1-git-send-email-gitster@pobox.com>
Now there is no direct caller to strbuf_getline(), we can demote it
to file-scope static private to strbuf.c implementation and rename
it to strbuf_getdelim(). Rename strbuf_getline_crlf(), which is
designed to be the most "text friendly" variant, and allow it to
take over this simplest name, strbuf_getline(), so we can add more
uses of it without having to type _crlf over and over again in the
coming steps.
Signed-off-by: Junio C Hamano <gitster@pobox.com>
---
builtin/am.c | 8 ++++----
strbuf.c | 8 ++++----
strbuf.h | 25 ++++++++++++++-----------
transport-helper.c | 3 ++-
4 files changed, 24 insertions(+), 20 deletions(-)
diff --git a/builtin/am.c b/builtin/am.c
index 885fa19..8e3a9f9 100644
--- a/builtin/am.c
+++ b/builtin/am.c
@@ -612,7 +612,7 @@ static int is_mail(FILE *fp)
if (regcomp(®ex, header_regex, REG_NOSUB | REG_EXTENDED))
die("invalid pattern: %s", header_regex);
- while (!strbuf_getline_crlf(&sb, fp)) {
+ while (!strbuf_getline(&sb, fp)) {
if (!sb.len)
break; /* End of header */
@@ -659,7 +659,7 @@ static int detect_patch_format(const char **paths)
fp = xfopen(*paths, "r");
- while (!strbuf_getline_crlf(&l1, fp)) {
+ while (!strbuf_getline(&l1, fp)) {
if (l1.len)
break;
}
@@ -680,9 +680,9 @@ static int detect_patch_format(const char **paths)
}
strbuf_reset(&l2);
- strbuf_getline_crlf(&l2, fp);
+ strbuf_getline(&l2, fp);
strbuf_reset(&l3);
- strbuf_getline_crlf(&l3, fp);
+ strbuf_getline(&l3, fp);
/*
* If the second line is empty and the third is a From, Author or Date
diff --git a/strbuf.c b/strbuf.c
index 2ff898c..47ac045 100644
--- a/strbuf.c
+++ b/strbuf.c
@@ -501,7 +501,7 @@ int strbuf_getwholeline(struct strbuf *sb, FILE *fp, int term)
}
#endif
-int strbuf_getline(struct strbuf *sb, FILE *fp, int term)
+static int strbuf_getdelim(struct strbuf *sb, FILE *fp, int term)
{
if (strbuf_getwholeline(sb, fp, term))
return EOF;
@@ -510,7 +510,7 @@ int strbuf_getline(struct strbuf *sb, FILE *fp, int term)
return 0;
}
-int strbuf_getline_crlf(struct strbuf *sb, FILE *fp)
+int strbuf_getline(struct strbuf *sb, FILE *fp)
{
if (strbuf_getwholeline(sb, fp, '\n'))
return EOF;
@@ -524,12 +524,12 @@ int strbuf_getline_crlf(struct strbuf *sb, FILE *fp)
int strbuf_getline_lf(struct strbuf *sb, FILE *fp)
{
- return strbuf_getline(sb, fp, '\n');
+ return strbuf_getdelim(sb, fp, '\n');
}
int strbuf_getline_nul(struct strbuf *sb, FILE *fp)
{
- return strbuf_getline(sb, fp, '\0');
+ return strbuf_getdelim(sb, fp, '\0');
}
int strbuf_getwholeline_fd(struct strbuf *sb, int fd, int term)
diff --git a/strbuf.h b/strbuf.h
index 5501743..220c541 100644
--- a/strbuf.h
+++ b/strbuf.h
@@ -354,8 +354,8 @@ extern void strbuf_addftime(struct strbuf *sb, const char *fmt, const struct tm
*
* NOTE: The buffer is rewound if the read fails. If -1 is returned,
* `errno` must be consulted, like you would do for `read(3)`.
- * `strbuf_read()`, `strbuf_read_file()` and `strbuf_getline()` has the
- * same behaviour as well.
+ * `strbuf_read()`, `strbuf_read_file()` and `strbuf_getline_*()`
+ * family of functions have the same behaviour as well.
*/
extern size_t strbuf_fread(struct strbuf *, size_t, FILE *);
@@ -380,26 +380,29 @@ extern int strbuf_readlink(struct strbuf *sb, const char *path, size_t hint);
/**
* Read a line from a FILE *, overwriting the existing contents
- * of the strbuf. The second argument specifies the line
- * terminator character, typically `'\n'`.
+ * of the strbuf. There are three public functions with this
+ * function signature, with different line termination convention.
* Reading stops after the terminator or at EOF. The terminator
* is removed from the buffer before returning. Returns 0 unless
* there was nothing left before EOF, in which case it returns `EOF`.
*/
-extern int strbuf_getline(struct strbuf *, FILE *, int);
-
typedef int (*strbuf_getline_fn)(struct strbuf *, FILE *);
+/* Uses LF as the line terminator */
extern int strbuf_getline_lf(struct strbuf *sb, FILE *fp);
+
+/* Uses NUL as the line terminator */
extern int strbuf_getline_nul(struct strbuf *sb, FILE *fp);
-/*
- * Similar to strbuf_getline(), but uses '\n' as the terminator,
- * and additionally treats a '\r' that comes immediately before '\n'
- * as part of the terminator.
+/**
+ * Similar to strbuf_getline_lf(), but additionally treats
+ * a '\r' that comes immediately before '\n' as part of the
+ * terminator. This is the most friendly version to be used
+ * to read "text" files that can come from platforms whose
+ * native text format is CRLF terminated.
*/
-extern int strbuf_getline_crlf(struct strbuf *, FILE *);
+extern int strbuf_getline(struct strbuf *, FILE *);
/**
diff --git a/transport-helper.c b/transport-helper.c
index 74eb217..d108336 100644
--- a/transport-helper.c
+++ b/transport-helper.c
@@ -137,7 +137,8 @@ static struct child_process *get_helper(struct transport *transport)
data->no_disconnect_req = 0;
/*
- * Open the output as FILE* so strbuf_getline() can be used.
+ * Open the output as FILE* so strbuf_getline_*() family of
+ * functions can be used.
* Do this with duped fd because fclose() will close the fd,
* and stuff like taking over will require the fd to remain.
*/
--
2.7.0-242-gdd583c7
next prev parent reply other threads:[~2016-01-14 3:03 UTC|newest]
Thread overview: 114+ messages / expand[flat|nested] mbox.gz Atom feed top
2015-08-11 20:21 [PATCH] revisions --stdin: accept CRLF line terminators Johannes Sixt
2015-08-11 21:35 ` Junio C Hamano
2015-08-11 22:14 ` Junio C Hamano
2015-08-12 18:24 ` Johannes Sixt
2015-10-28 22:25 ` [PATCH 00/17] Peace with CRLF Junio C Hamano
2015-10-28 22:25 ` [PATCH 01/17] strbuf: add strbuf_gets() Junio C Hamano
2015-10-28 22:25 ` [PATCH 02/17] check-attr, check-ignore, checkout-index: read paths with strbuf_gets() Junio C Hamano
2015-10-28 22:25 ` [PATCH 03/17] update-index: read --index-info " Junio C Hamano
2015-10-28 22:25 ` [PATCH 04/17] update-index: read list of paths with strbuf_gets() under --stdin Junio C Hamano
2015-10-28 22:25 ` [PATCH 05/17] mktree: read textual tree representation with strbuf_gets() Junio C Hamano
2015-10-28 22:25 ` [PATCH 06/17] hash-object: read --stdin-paths " Junio C Hamano
2015-10-28 22:25 ` [PATCH 07/17] revision: read --stdin " Junio C Hamano
2015-10-28 22:25 ` [PATCH 08/17] rev-parse: read parseopt spec " Junio C Hamano
2015-10-28 22:25 ` [PATCH 09/17] ident.c: read /etc/mailname " Junio C Hamano
2015-10-28 22:25 ` [PATCH 10/17] remote.c: read $GIT_DIR/remotes/* " Junio C Hamano
2015-10-28 22:25 ` [PATCH 11/17] clone/sha1_file: read info/alternates " Junio C Hamano
2015-10-28 22:25 ` [PATCH 12/17] transport-helper: read helper response " Junio C Hamano
2015-10-28 22:25 ` [PATCH 13/17] cat-file: read batch stream " Junio C Hamano
2015-10-28 22:25 ` [PATCH 14/17] column: read lines " Junio C Hamano
2015-10-28 22:25 ` [PATCH 15/17] send-pack: read list of refs " Junio C Hamano
2015-10-28 22:26 ` [PATCH 16/17] grep: read -f file " Junio C Hamano
2015-10-28 22:26 ` [PATCH 17/17] test-sha1-array: read command stream " Junio C Hamano
2015-12-16 22:03 ` [PATCH v2 00/17] Peace with CRLF Junio C Hamano
2015-12-16 22:03 ` [PATCH v2 01/17] strbuf: make strbuf_getline_crlf() global Junio C Hamano
2016-01-04 12:25 ` Johannes Schindelin
2016-01-04 19:17 ` Junio C Hamano
2015-12-16 22:03 ` [PATCH v2 02/17] check-attr, check-ignore, checkout-index: read paths with strbuf_getline_crlf() Junio C Hamano
2016-01-04 12:25 ` Johannes Schindelin
2016-01-04 12:27 ` Johannes Schindelin
2016-01-04 19:20 ` Junio C Hamano
2015-12-16 22:03 ` [PATCH v2 03/17] update-index: read --index-info " Junio C Hamano
2016-01-04 12:27 ` Johannes Schindelin
2016-01-04 19:50 ` Junio C Hamano
2015-12-16 22:03 ` [PATCH v2 04/17] update-index: read list of paths with strbuf_getline_crlf() under --stdin Junio C Hamano
2016-01-04 12:27 ` Johannes Schindelin
2015-12-16 22:03 ` [PATCH v2 05/17] mktree: read textual tree representation with strbuf_getline_crlf() Junio C Hamano
2016-01-04 12:27 ` Johannes Schindelin
2015-12-16 22:03 ` [PATCH v2 06/17] hash-object: read --stdin-paths " Junio C Hamano
2015-12-16 22:03 ` [PATCH v2 07/17] revision: read --stdin " Junio C Hamano
2015-12-16 22:03 ` [PATCH v2 08/17] rev-parse: read parseopt spec " Junio C Hamano
2015-12-16 22:03 ` [PATCH v2 09/17] ident.c: read /etc/mailname " Junio C Hamano
2015-12-16 22:03 ` [PATCH v2 10/17] remote.c: read $GIT_DIR/remotes/* " Junio C Hamano
2015-12-16 22:03 ` [PATCH v2 11/17] clone/sha1_file: read info/alternates " Junio C Hamano
2015-12-16 22:03 ` [PATCH v2 12/17] transport-helper: read helper response " Junio C Hamano
2015-12-16 22:03 ` [PATCH v2 13/17] cat-file: read batch stream " Junio C Hamano
2015-12-16 22:03 ` [PATCH v2 14/17] column: read lines " Junio C Hamano
2015-12-16 22:03 ` [PATCH v2 15/17] send-pack: read list of refs " Junio C Hamano
2015-12-16 22:03 ` [PATCH v2 16/17] grep: read -f file " Junio C Hamano
2016-01-04 12:27 ` Johannes Schindelin
2016-01-04 19:30 ` Junio C Hamano
2015-12-16 22:03 ` [PATCH v2 17/17] test-sha1-array: read command stream " Junio C Hamano
2016-01-04 12:27 ` Johannes Schindelin
2016-01-04 12:25 ` [PATCH v2 00/17] Peace with CRLF Johannes Schindelin
2016-01-14 3:03 ` [PREVIEW v3 0/9] Preview of "Peace with CRLF" rerolled Junio C Hamano
2016-01-14 3:03 ` [PREVIEW v3 1/9] strbuf: miniscule style fix Junio C Hamano
2016-01-14 3:03 ` [PREVIEW v3 2/9] strbuf: make strbuf_getline_crlf() global Junio C Hamano
2016-01-14 3:03 ` [PREVIEW v3 3/9] strbuf: introduce strbuf_getline_{lf,nul}() Junio C Hamano
2016-01-14 3:03 ` [PREVIEW v3 4/9] mktree: there are only two line terminators Junio C Hamano
2016-01-14 10:11 ` Jeff King
2016-01-14 3:03 ` [PREVIEW v3 5/9] check-attr: " Junio C Hamano
2016-01-14 3:03 ` [PREVIEW v3 6/9] check-ignore: " Junio C Hamano
2016-01-14 3:03 ` [PREVIEW v3 7/9] update-index: " Junio C Hamano
2016-01-14 10:09 ` Jeff King
2016-01-14 3:03 ` [PREVIEW v3 8/9] checkout-index: " Junio C Hamano
2016-01-14 10:18 ` Jeff King
2016-01-14 17:13 ` Junio C Hamano
2016-01-14 20:13 ` Jeff King
2016-01-14 3:03 ` Junio C Hamano [this message]
2016-01-14 3:03 ` [PREVIEW v3 9/9] strbuf: retire strbuf_getline() for now Junio C Hamano
2016-01-14 3:09 ` Junio C Hamano
2016-01-14 10:23 ` [PREVIEW v3 0/9] Preview of "Peace with CRLF" rerolled Jeff King
2016-01-14 23:58 ` [PATCH v4 00/21] Peace with CRLF Junio C Hamano
2016-01-14 23:58 ` [PATCH v4 01/21] strbuf: miniscule style fix Junio C Hamano
2016-01-14 23:58 ` [PATCH v4 02/21] strbuf: make strbuf_getline_crlf() global Junio C Hamano
2016-01-14 23:58 ` [PATCH v4 03/21] strbuf: introduce strbuf_getline_{lf,nul}() Junio C Hamano
2016-01-14 23:58 ` [PATCH v4 04/21] mktree: there are only two possible line terminations Junio C Hamano
2016-01-14 23:58 ` [PATCH v4 05/21] check-attr: " Junio C Hamano
2016-01-15 19:16 ` Jeff King
2016-01-15 19:36 ` Jeff King
2016-01-15 21:20 ` Junio C Hamano
2016-01-15 21:23 ` Jeff King
2016-01-15 21:29 ` Junio C Hamano
2016-01-14 23:58 ` [PATCH v4 06/21] check-ignore: " Junio C Hamano
2016-01-14 23:58 ` [PATCH v4 07/21] update-index: " Junio C Hamano
2016-01-14 23:58 ` [PATCH v4 08/21] checkout-index: " Junio C Hamano
2016-01-15 20:08 ` Jeff King
2016-01-15 20:20 ` Jeff King
2016-01-15 21:22 ` Junio C Hamano
2016-01-15 23:31 ` Junio C Hamano
2016-01-14 23:58 ` [PATCH v4 09/21] strbuf: give strbuf_getline() to the "most text friendly" variant Junio C Hamano
2016-01-15 1:46 ` Eric Sunshine
2016-01-15 18:02 ` Junio C Hamano
2016-01-14 23:58 ` [PATCH v4 10/21] hash-object: read --stdin-paths with strbuf_getline() Junio C Hamano
2016-01-15 20:23 ` Jeff King
2016-01-14 23:58 ` [PATCH v4 11/21] revision: read --stdin " Junio C Hamano
2016-01-15 1:50 ` Eric Sunshine
2016-01-15 18:38 ` Junio C Hamano
2016-01-15 20:27 ` Jeff King
2016-01-14 23:58 ` [PATCH v4 12/21] rev-parse: read parseopt spec " Junio C Hamano
2016-01-14 23:58 ` [PATCH v4 13/21] ident.c: read /etc/mailname " Junio C Hamano
2016-01-14 23:58 ` [PATCH v4 14/21] remote.c: read $GIT_DIR/remotes/* " Junio C Hamano
2016-01-14 23:58 ` [PATCH v4 15/21] clone/sha1_file: read info/alternates " Junio C Hamano
2016-01-15 1:52 ` Eric Sunshine
2016-01-14 23:58 ` [PATCH v4 16/21] transport-helper: read helper response " Junio C Hamano
2016-01-15 20:31 ` Jeff King
2016-01-14 23:58 ` [PATCH v4 17/21] cat-file: read batch stream " Junio C Hamano
2016-01-15 20:41 ` Jeff King
2016-01-14 23:58 ` [PATCH v4 18/21] column: read lines " Junio C Hamano
2016-01-15 20:43 ` Jeff King
2016-01-14 23:58 ` [PATCH v4 19/21] send-pack: read list of refs " Junio C Hamano
2016-01-14 23:58 ` [PATCH v4 20/21] grep: read -f file " Junio C Hamano
2016-01-14 23:58 ` [PATCH v4 21/21] test-sha1-array: read command stream " Junio C Hamano
2016-01-15 19:10 ` [PATCH v4 00/21] Peace with CRLF Jeff King
2016-01-15 20:49 ` Jeff King
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=1452740590-16827-10-git-send-email-gitster@pobox.com \
--to=gitster@pobox.com \
--cc=Johannes.Schindelin@gmx.de \
--cc=git@vger.kernel.org \
--cc=peff@peff.net \
/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).