mirror of
https://github.com/git/git
synced 2024-11-05 18:59:29 +00:00
13c44953fb
We provide a function for dequoting an entire string, as well as one for handling a space-separated list of quoted strings. But there's no way for a caller to parse a string like 'foo'='bar', even though it is easy to generate one using sq_quote_buf() or similar. Let's make the single-step function available to callers outside of quote.c. Note that we do need to adjust its implementation slightly: it insists on seeing whitespace between items, and we'd like to be more flexible than that. Since it only has a single caller, we can move that check (and slurping up any extra whitespace) into that caller. Signed-off-by: Jeff King <peff@peff.net> Signed-off-by: Junio C Hamano <gitster@pobox.com>
101 lines
3.7 KiB
C
101 lines
3.7 KiB
C
#ifndef QUOTE_H
|
|
#define QUOTE_H
|
|
|
|
struct strbuf;
|
|
|
|
/* Help to copy the thing properly quoted for the shell safety.
|
|
* any single quote is replaced with '\'', any exclamation point
|
|
* is replaced with '\!', and the whole thing is enclosed in a
|
|
* single quote pair.
|
|
*
|
|
* For example, if you are passing the result to system() as an
|
|
* argument:
|
|
*
|
|
* sprintf(cmd, "foobar %s %s", sq_quote(arg0), sq_quote(arg1))
|
|
*
|
|
* would be appropriate. If the system() is going to call ssh to
|
|
* run the command on the other side:
|
|
*
|
|
* sprintf(cmd, "git-diff-tree %s %s", sq_quote(arg0), sq_quote(arg1));
|
|
* sprintf(rcmd, "ssh %s %s", sq_quote(host), sq_quote(cmd));
|
|
*
|
|
* Note that the above examples leak memory! Remember to free result from
|
|
* sq_quote() in a real application.
|
|
*
|
|
* sq_quote_buf() writes to an existing buffer of specified size; it
|
|
* will return the number of characters that would have been written
|
|
* excluding the final null regardless of the buffer size.
|
|
*
|
|
* sq_quotef() quotes the entire formatted string as a single result.
|
|
*/
|
|
|
|
void sq_quote_buf(struct strbuf *, const char *src);
|
|
void sq_quote_argv(struct strbuf *, const char **argv);
|
|
void sq_quotef(struct strbuf *, const char *fmt, ...);
|
|
|
|
/*
|
|
* These match their non-pretty variants, except that they avoid
|
|
* quoting when there are no exotic characters. These should only be used for
|
|
* human-readable output, as sq_dequote() is not smart enough to dequote it.
|
|
*/
|
|
void sq_quote_buf_pretty(struct strbuf *, const char *src);
|
|
void sq_quote_argv_pretty(struct strbuf *, const char **argv);
|
|
void sq_append_quote_argv_pretty(struct strbuf *dst, const char **argv);
|
|
|
|
/*
|
|
* This unwraps what sq_quote() produces in place, but returns
|
|
* NULL if the input does not look like what sq_quote would have
|
|
* produced (the full string must be a single quoted item).
|
|
*/
|
|
char *sq_dequote(char *);
|
|
|
|
/*
|
|
* Like sq_dequote(), but dequote a single item, and leave "next" pointing to
|
|
* the next character. E.g., in the string:
|
|
*
|
|
* 'one' 'two' 'three'
|
|
*
|
|
* after the first call, the return value would be the unquoted string "one",
|
|
* with "next" pointing to the space between "one" and "two"). The caller is
|
|
* responsible for advancing the pointer to the start of the next item before
|
|
* calling sq_dequote_step() again.
|
|
*/
|
|
char *sq_dequote_step(char *src, char **next);
|
|
|
|
/*
|
|
* Same as the above, but can be used to unwrap many arguments in the
|
|
* same string separated by space. Like sq_quote, it works in place,
|
|
* modifying arg and appending pointers into it to argv.
|
|
*/
|
|
int sq_dequote_to_argv(char *arg, const char ***argv, int *nr, int *alloc);
|
|
|
|
/*
|
|
* Same as above, but store the unquoted strings in a strvec. We will
|
|
* still modify arg in place, but unlike sq_dequote_to_argv, the strvec
|
|
* will duplicate and take ownership of the strings.
|
|
*/
|
|
struct strvec;
|
|
int sq_dequote_to_strvec(char *arg, struct strvec *);
|
|
|
|
int unquote_c_style(struct strbuf *, const char *quoted, const char **endp);
|
|
|
|
/* Bits in the flags parameter to quote_c_style() */
|
|
#define CQUOTE_NODQ 01
|
|
size_t quote_c_style(const char *name, struct strbuf *, FILE *, unsigned);
|
|
void quote_two_c_style(struct strbuf *, const char *, const char *, unsigned);
|
|
|
|
void write_name_quoted(const char *name, FILE *, int terminator);
|
|
void write_name_quoted_relative(const char *name, const char *prefix,
|
|
FILE *fp, int terminator);
|
|
|
|
/* quote path as relative to the given prefix */
|
|
char *quote_path(const char *in, const char *prefix, struct strbuf *out, unsigned flags);
|
|
#define QUOTE_PATH_QUOTE_SP 01
|
|
|
|
/* quoting as a string literal for other languages */
|
|
void perl_quote_buf(struct strbuf *sb, const char *src);
|
|
void python_quote_buf(struct strbuf *sb, const char *src);
|
|
void tcl_quote_buf(struct strbuf *sb, const char *src);
|
|
void basic_regex_quote_buf(struct strbuf *sb, const char *src);
|
|
|
|
#endif
|