]>
Commit | Line | Data |
---|---|---|
6fb737be JH |
1 | #ifndef QUOTE_H |
2 | #define QUOTE_H | |
3 | ||
cf548cac | 4 | struct 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 |
32 | void sq_quote_buf(struct strbuf *, const char *src); |
33 | void sq_quote_argv(struct strbuf *, const char **argv); | |
75d31cee | 34 | __attribute__((format (printf, 2, 3))) |
b199d714 | 35 | void sq_quotef(struct strbuf *, const char *fmt, ...); |
86257aa3 | 36 | |
1fbdab21 JK |
37 | /* |
38 | * These match their non-pretty variants, except that they avoid | |
39 | * quoting when there are no exotic characters. These should only be used for | |
40 | * human-readable output, as sq_dequote() is not smart enough to dequote it. | |
41 | */ | |
42 | void sq_quote_buf_pretty(struct strbuf *, const char *src); | |
43 | void sq_quote_argv_pretty(struct strbuf *, const char **argv); | |
c2b890ac | 44 | void sq_append_quote_argv_pretty(struct strbuf *dst, const char **argv); |
1fbdab21 | 45 | |
13c44953 JK |
46 | /* |
47 | * This unwraps what sq_quote() produces in place, but returns | |
35eb2d36 | 48 | * NULL if the input does not look like what sq_quote would have |
13c44953 | 49 | * produced (the full string must be a single quoted item). |
35eb2d36 | 50 | */ |
55454427 | 51 | char *sq_dequote(char *); |
35eb2d36 | 52 | |
13c44953 JK |
53 | /* |
54 | * Like sq_dequote(), but dequote a single item, and leave "next" pointing to | |
55 | * the next character. E.g., in the string: | |
56 | * | |
57 | * 'one' 'two' 'three' | |
58 | * | |
59 | * after the first call, the return value would be the unquoted string "one", | |
60 | * with "next" pointing to the space between "one" and "two"). The caller is | |
61 | * responsible for advancing the pointer to the start of the next item before | |
62 | * calling sq_dequote_step() again. | |
63 | */ | |
64 | char *sq_dequote_step(char *src, char **next); | |
65 | ||
ebbc088e CC |
66 | /* |
67 | * Same as the above, but can be used to unwrap many arguments in the | |
7878b07c JK |
68 | * same string separated by space. Like sq_quote, it works in place, |
69 | * modifying arg and appending pointers into it to argv. | |
ebbc088e | 70 | */ |
55454427 | 71 | int sq_dequote_to_argv(char *arg, const char ***argv, int *nr, int *alloc); |
ebbc088e | 72 | |
37e8161a | 73 | /* |
2745b6b4 JK |
74 | * Same as above, but store the unquoted strings in a strvec. We will |
75 | * still modify arg in place, but unlike sq_dequote_to_argv, the strvec | |
37e8161a JK |
76 | * will duplicate and take ownership of the strings. |
77 | */ | |
873cd28a | 78 | struct strvec; |
2745b6b4 | 79 | int sq_dequote_to_strvec(char *arg, struct strvec *); |
37e8161a | 80 | |
55454427 | 81 | int unquote_c_style(struct strbuf *, const char *quoted, const char **endp); |
7c37c975 JH |
82 | |
83 | /* Bits in the flags parameter to quote_c_style() */ | |
84 | #define CQUOTE_NODQ 01 | |
85 | size_t quote_c_style(const char *name, struct strbuf *, FILE *, unsigned); | |
86 | void quote_two_c_style(struct strbuf *, const char *, const char *, unsigned); | |
4f6fbcdc | 87 | |
55454427 DL |
88 | void write_name_quoted(const char *name, FILE *, int terminator); |
89 | void write_name_quoted_relative(const char *name, const char *prefix, | |
ad6dad09 | 90 | FILE *fp, int terminator); |
6fb737be | 91 | |
a734d0b1 | 92 | /* quote path as relative to the given prefix */ |
88910c99 | 93 | char *quote_path(const char *in, const char *prefix, struct strbuf *out, unsigned flags); |
f3fc4a1b | 94 | #define QUOTE_PATH_QUOTE_SP 01 |
a734d0b1 | 95 | |
9f613ddd | 96 | /* quoting as a string literal for other languages */ |
55454427 | 97 | void perl_quote_buf(struct strbuf *sb, const char *src); |
7121c4d4 | 98 | void perl_quote_buf_with_len(struct strbuf *sb, const char *src, size_t len); |
55454427 DL |
99 | void python_quote_buf(struct strbuf *sb, const char *src); |
100 | void tcl_quote_buf(struct strbuf *sb, const char *src); | |
101 | void basic_regex_quote_buf(struct strbuf *sb, const char *src); | |
9f613ddd | 102 | |
6fb737be | 103 | #endif |