Forbid pattern maching characters in refnames.
[git.git] / quote.h
1 #ifndef QUOTE_H
2 #define QUOTE_H
3
4 #include <stddef.h>
5 #include <stdio.h>
6
7 /* Help to copy the thing properly quoted for the shell safety.
8  * any single quote is replaced with '\'', any exclamation point
9  * is replaced with '\!', and the whole thing is enclosed in a
10  * single quote pair.
11  *
12  * For example, if you are passing the result to system() as an
13  * argument:
14  *
15  * sprintf(cmd, "foobar %s %s", sq_quote(arg0), sq_quote(arg1))
16  *
17  * would be appropriate.  If the system() is going to call ssh to
18  * run the command on the other side:
19  *
20  * sprintf(cmd, "git-diff-tree %s %s", sq_quote(arg0), sq_quote(arg1));
21  * sprintf(rcmd, "ssh %s %s", sq_quote(host), sq_quote(cmd));
22  *
23  * Note that the above examples leak memory!  Remember to free result from
24  * sq_quote() in a real application.
25  *
26  * sq_quote_buf() writes to an existing buffer of specified size; it
27  * will return the number of characters that would have been written
28  * excluding the final null regardless of the buffer size.
29  */
30
31 extern char *sq_quote(const char *src);
32 extern size_t sq_quote_buf(char *dst, size_t n, const char *src);
33
34 /* This unwraps what sq_quote() produces in place, but returns
35  * NULL if the input does not look like what sq_quote would have
36  * produced.
37  */
38 extern char *sq_dequote(char *);
39
40 extern int quote_c_style(const char *name, char *outbuf, FILE *outfp,
41                          int nodq);
42 extern char *unquote_c_style(const char *quoted, const char **endp);
43
44 extern void write_name_quoted(const char *prefix, int prefix_len,
45                               const char *name, int quote, FILE *out);
46
47 #endif