From c8bae7493d2f2910b57f13ded012e86bdcfb0532 Mon Sep 17 00:00:00 2001 From: Daniel Baumann Date: Sun, 7 Apr 2024 16:47:53 +0200 Subject: Adding upstream version 1:2.39.2. Signed-off-by: Daniel Baumann --- quote.h | 103 ++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++ 1 file changed, 103 insertions(+) create mode 100644 quote.h (limited to 'quote.h') diff --git a/quote.h b/quote.h new file mode 100644 index 0000000..87ff458 --- /dev/null +++ b/quote.h @@ -0,0 +1,103 @@ +#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); +__attribute__((format (printf, 2, 3))) +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 perl_quote_buf_with_len(struct strbuf *sb, const char *src, size_t len); +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 -- cgit v1.2.3