Documentation: help: specify supported html browsers.
[git/dscho.git] / quote.h
blob4da110ec01331f346705199dde709436622967cb
1 #ifndef QUOTE_H
2 #define QUOTE_H
4 #include <stddef.h>
5 #include <stdio.h>
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  */
31 extern void sq_quote_print(FILE *stream, const char *src);
33 extern void sq_quote_buf(struct strbuf *, const char *src);
34 extern void sq_quote_argv(struct strbuf *, const char **argv, size_t maxlen);
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 *);
42 extern int unquote_c_style(struct strbuf *, const char *quoted, const char **endp);
43 extern size_t quote_c_style(const char *name, struct strbuf *, FILE *, int no_dq);
44 extern void quote_two_c_style(struct strbuf *, const char *, const char *, int);
46 extern void write_name_quoted(const char *name, FILE *, int terminator);
47 extern void write_name_quotedpfx(const char *pfx, size_t pfxlen,
48                                  const char *name, FILE *, int terminator);
50 /* quoting as a string literal for other languages */
51 extern void perl_quote_print(FILE *stream, const char *src);
52 extern void python_quote_print(FILE *stream, const char *src);
53 extern void tcl_quote_print(FILE *stream, const char *src);
55 #endif