aboutsummaryrefslogtreecommitdiff
path: root/quote.h
blob: c8cfb3a12482b0a2398d7d9e164c37e5473b44b8 (plain)
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
#ifndef QUOTE_H
#define QUOTE_H


/* Help to copy the thing properly quoted for the shell safety.
 * any single quote is replaced with '\'', and the whole thing
 * is enclosed in a single quote pair.
 *
 * For example, if you are passing the result to system() as an
 * argument:
 *
 * sprintf(cmd, "foobar %s %s", sq_quote(arg0), sq_quote(arg1))
 *
 * would be appropriate.  If the system() is going to call ssh to
 * run the command on the other side:
 *
 * sprintf(cmd, "git-diff-tree %s %s", sq_quote(arg0), sq_quote(arg1));
 * sprintf(rcmd, "ssh %s %s", sq_quote(host), sq_quote(cmd));
 *
 * Note that the above examples leak memory!  Remember to free result from
 * sq_quote() in a real application.
 */

char *sq_quote(const char *src);

#endif