]>
git.ipfire.org Git - thirdparty/git.git/blob - quote.h
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
11 * For example, if you are passing the result to system() as an
14 * sprintf(cmd, "foobar %s %s", sq_quote(arg0), sq_quote(arg1))
16 * would be appropriate. If the system() is going to call ssh to
17 * run the command on the other side:
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));
22 * Note that the above examples leak memory! Remember to free result from
23 * sq_quote() in a real application.
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.
30 extern void sq_quote_print(FILE *stream
, const char *src
);
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
);
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
39 extern char *sq_dequote(char *);
42 * Same as the above, but can be used to unwrap many arguments in the
43 * same string separated by space. "next" is changed to point to the
44 * next argument that should be passed as first parameter. When there
45 * is no more argument to be dequoted, "next" is updated to point to NULL.
47 extern int sq_dequote_to_argv(char *arg
, const char ***argv
, int *nr
, int *alloc
);
49 extern int unquote_c_style(struct strbuf
*, const char *quoted
, const char **endp
);
50 extern size_t quote_c_style(const char *name
, struct strbuf
*, FILE *, int no_dq
);
51 extern void quote_two_c_style(struct strbuf
*, const char *, const char *, int);
53 extern void write_name_quoted(const char *name
, FILE *, int terminator
);
54 extern void write_name_quotedpfx(const char *pfx
, size_t pfxlen
,
55 const char *name
, FILE *, int terminator
);
56 extern void write_name_quoted_relative(const char *name
, size_t len
,
57 const char *prefix
, size_t prefix_len
,
58 FILE *fp
, int terminator
);
60 /* quote path as relative to the given prefix */
61 extern char *quote_path_relative(const char *in
, int len
,
62 struct strbuf
*out
, const char *prefix
);
64 /* quoting as a string literal for other languages */
65 extern void perl_quote_print(FILE *stream
, const char *src
);
66 extern void python_quote_print(FILE *stream
, const char *src
);
67 extern void tcl_quote_print(FILE *stream
, const char *src
);