Merge branch 'jk/fetch-prune-doc' into maint
[git/git.git] / quote.h
1 #ifndef QUOTE_H
2 #define QUOTE_H
3
4 struct strbuf;
5
6 /* Help to copy the thing properly quoted for the shell safety.
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.
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.
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.
28 *
29 * sq_quotef() quotes the entire formatted string as a single result.
30 */
31
32 extern void sq_quote_buf(struct strbuf *, const char *src);
33 extern void sq_quote_argv(struct strbuf *, const char **argv, size_t maxlen);
34 extern void sq_quotef(struct strbuf *, const char *fmt, ...);
35
36 /* This unwraps what sq_quote() produces in place, but returns
37 * NULL if the input does not look like what sq_quote would have
38 * produced.
39 */
40 extern char *sq_dequote(char *);
41
42 /*
43 * Same as the above, but can be used to unwrap many arguments in the
44 * same string separated by space. Like sq_quote, it works in place,
45 * modifying arg and appending pointers into it to argv.
46 */
47 extern int sq_dequote_to_argv(char *arg, const char ***argv, int *nr, int *alloc);
48
49 /*
50 * Same as above, but store the unquoted strings in an argv_array. We will
51 * still modify arg in place, but unlike sq_dequote_to_argv, the argv_array
52 * will duplicate and take ownership of the strings.
53 */
54 struct argv_array;
55 extern int sq_dequote_to_argv_array(char *arg, struct argv_array *);
56
57 extern int unquote_c_style(struct strbuf *, const char *quoted, const char **endp);
58 extern size_t quote_c_style(const char *name, struct strbuf *, FILE *, int no_dq);
59 extern void quote_two_c_style(struct strbuf *, const char *, const char *, int);
60
61 extern void write_name_quoted(const char *name, FILE *, int terminator);
62 extern void write_name_quoted_relative(const char *name, const char *prefix,
63 FILE *fp, int terminator);
64
65 /* quote path as relative to the given prefix */
66 extern char *quote_path_relative(const char *in, const char *prefix,
67 struct strbuf *out);
68
69 /* quoting as a string literal for other languages */
70 extern void perl_quote_buf(struct strbuf *sb, const char *src);
71 extern void python_quote_buf(struct strbuf *sb, const char *src);
72 extern void tcl_quote_buf(struct strbuf *sb, const char *src);
73
74 #endif