Merge branch 'cs/pretty-formats-doc-typofix'
[git/git.git] / quote.h
CommitLineData
6fb737be
JH
1#ifndef QUOTE_H
2#define QUOTE_H
3
cf548cac 4struct strbuf;
6fb737be
JH
5
6/* Help to copy the thing properly quoted for the shell safety.
77d604c3
PA
7 * any single quote is replaced with '\'', any exclamation point
8 * is replaced with '\!', and the whole thing is enclosed in a
9 * single quote pair.
6fb737be
JH
10 *
11 * For example, if you are passing the result to system() as an
12 * argument:
13 *
14 * sprintf(cmd, "foobar %s %s", sq_quote(arg0), sq_quote(arg1))
15 *
16 * would be appropriate. If the system() is going to call ssh to
17 * run the command on the other side:
18 *
19 * sprintf(cmd, "git-diff-tree %s %s", sq_quote(arg0), sq_quote(arg1));
20 * sprintf(rcmd, "ssh %s %s", sq_quote(host), sq_quote(cmd));
21 *
22 * Note that the above examples leak memory! Remember to free result from
23 * sq_quote() in a real application.
77d604c3
PA
24 *
25 * sq_quote_buf() writes to an existing buffer of specified size; it
26 * will return the number of characters that would have been written
27 * excluding the final null regardless of the buffer size.
e70986d7
JK
28 *
29 * sq_quotef() quotes the entire formatted string as a single result.
6fb737be
JH
30 */
31
55454427
DL
32void sq_quote_buf(struct strbuf *, const char *src);
33void sq_quote_argv(struct strbuf *, const char **argv);
b199d714 34void sq_quotef(struct strbuf *, const char *fmt, ...);
86257aa3 35
1fbdab21
JK
36/*
37 * These match their non-pretty variants, except that they avoid
38 * quoting when there are no exotic characters. These should only be used for
39 * human-readable output, as sq_dequote() is not smart enough to dequote it.
40 */
41void sq_quote_buf_pretty(struct strbuf *, const char *src);
42void sq_quote_argv_pretty(struct strbuf *, const char **argv);
c2b890ac 43void sq_append_quote_argv_pretty(struct strbuf *dst, const char **argv);
1fbdab21 44
35eb2d36
LT
45/* This unwraps what sq_quote() produces in place, but returns
46 * NULL if the input does not look like what sq_quote would have
47 * produced.
48 */
55454427 49char *sq_dequote(char *);
35eb2d36 50
ebbc088e
CC
51/*
52 * Same as the above, but can be used to unwrap many arguments in the
7878b07c
JK
53 * same string separated by space. Like sq_quote, it works in place,
54 * modifying arg and appending pointers into it to argv.
ebbc088e 55 */
55454427 56int sq_dequote_to_argv(char *arg, const char ***argv, int *nr, int *alloc);
ebbc088e 57
37e8161a
JK
58/*
59 * Same as above, but store the unquoted strings in an argv_array. We will
60 * still modify arg in place, but unlike sq_dequote_to_argv, the argv_array
61 * will duplicate and take ownership of the strings.
62 */
63struct argv_array;
55454427 64int sq_dequote_to_argv_array(char *arg, struct argv_array *);
37e8161a 65
55454427
DL
66int unquote_c_style(struct strbuf *, const char *quoted, const char **endp);
67size_t quote_c_style(const char *name, struct strbuf *, FILE *, int no_dq);
68void quote_two_c_style(struct strbuf *, const char *, const char *, int);
4f6fbcdc 69
55454427
DL
70void write_name_quoted(const char *name, FILE *, int terminator);
71void write_name_quoted_relative(const char *name, const char *prefix,
ad6dad09 72 FILE *fp, int terminator);
6fb737be 73
a734d0b1 74/* quote path as relative to the given prefix */
55454427 75char *quote_path_relative(const char *in, const char *prefix,
39598f99 76 struct strbuf *out);
a734d0b1 77
9f613ddd 78/* quoting as a string literal for other languages */
55454427
DL
79void perl_quote_buf(struct strbuf *sb, const char *src);
80void python_quote_buf(struct strbuf *sb, const char *src);
81void tcl_quote_buf(struct strbuf *sb, const char *src);
82void basic_regex_quote_buf(struct strbuf *sb, const char *src);
9f613ddd 83
6fb737be 84#endif