1#ifndef QUOTE_H 2#define QUOTE_H 3 4struct 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 30extern void sq_quote_print(FILE *stream, const char *src); 31 32extern void sq_quote_buf(struct strbuf *, const char *src); 33extern void sq_quote_argv(struct strbuf *, const char **argv, size_t maxlen); 34 35/* This unwraps what sq_quote() produces in place, but returns 36 * NULL if the input does not look like what sq_quote would have 37 * produced. 38 */ 39extern char *sq_dequote(char *); 40 41/* 42 * Same as the above, but can be used to unwrap many arguments in the 43 * same string separated by space. Like sq_quote, it works in place, 44 * modifying arg and appending pointers into it to argv. 45 */ 46extern int sq_dequote_to_argv(char *arg, const char ***argv, int *nr, int *alloc); 47 48/* 49 * Same as above, but store the unquoted strings in an argv_array. We will 50 * still modify arg in place, but unlike sq_dequote_to_argv, the argv_array 51 * will duplicate and take ownership of the strings. 52 */ 53struct argv_array; 54extern int sq_dequote_to_argv_array(char *arg, struct argv_array *); 55 56extern int unquote_c_style(struct strbuf *, const char *quoted, const char **endp); 57extern size_t quote_c_style(const char *name, struct strbuf *, FILE *, int no_dq); 58extern void quote_two_c_style(struct strbuf *, const char *, const char *, int); 59 60extern void write_name_quoted(const char *name, FILE *, int terminator); 61extern void write_name_quotedpfx(const char *pfx, size_t pfxlen, 62 const char *name, FILE *, int terminator); 63extern void write_name_quoted_relative(const char *name, size_t len, 64 const char *prefix, size_t prefix_len, 65 FILE *fp, int terminator); 66 67/* quote path as relative to the given prefix */ 68extern char *quote_path_relative(const char *in, int len, 69 struct strbuf *out, const char *prefix); 70 71/* quoting as a string literal for other languages */ 72extern void perl_quote_print(FILE *stream, const char *src); 73extern void python_quote_print(FILE *stream, const char *src); 74extern void tcl_quote_print(FILE *stream, const char *src); 75 76#endif