🌐 AI搜索 & 代理 主页
Google Git
Sign in
chromium / external / github.com / git / git / refs/tags/v2.14.0-rc0 / . / quote.h
blob: 66f5644aa29d0da4f95e693429ad6f8c0eb8cf09 [file] [log] [blame]
Junio C Hamano6fb737b2005-07-08 06:58:32[diff] [blame]1#ifndef QUOTE_H
2#define QUOTE_H
3
Jonathan Niedercf548ca2011-01-05 00:36:34[diff] [blame]4struct strbuf;
Junio C Hamano6fb737b2005-07-08 06:58:32[diff] [blame]5
6/* Help to copy the thing properly quoted for the shell safety.
H. Peter Anvin77d604c2005-10-10 21:46:10[diff] [blame]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.
Junio C Hamano6fb737b2005-07-08 06:58:32[diff] [blame]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.
H. Peter Anvin77d604c2005-10-10 21:46:10[diff] [blame]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.
Jacob Kellere70986d2016-02-29 22:58:34[diff] [blame]28 *
29 * sq_quotef() quotes the entire formatted string as a single result.
Junio C Hamano6fb737b2005-07-08 06:58:32[diff] [blame]30 */
31
Pierre Habouzit7a33bcb2007-09-19 22:42:13[diff] [blame]32extern void sq_quote_buf(struct strbuf *, const char *src);
Christian Couderb319ce42007-12-03 04:51:50[diff] [blame]33extern void sq_quote_argv(struct strbuf *, const char **argv, size_t maxlen);
Jacob Kellere70986d2016-02-29 22:58:34[diff] [blame]34extern void sq_quotef(struct strbuf *, const char *fmt, ...);
Christian Couder86257aa2006-09-11 04:59:22[diff] [blame]35
Linus Torvalds35eb2d32005-10-23 21:30:45[diff] [blame]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 */
40extern char *sq_dequote(char *);
41
Christian Couderebbc0882009-03-29 09:44:44[diff] [blame]42/*
43 * Same as the above, but can be used to unwrap many arguments in the
Jeff King7878b072011-09-13 21:57:47[diff] [blame]44 * same string separated by space. Like sq_quote, it works in place,
45 * modifying arg and appending pointers into it to argv.
Christian Couderebbc0882009-03-29 09:44:44[diff] [blame]46 */
Christian Coudereaa759b2009-03-29 09:44:52[diff] [blame]47extern int sq_dequote_to_argv(char *arg, const char ***argv, int *nr, int *alloc);
Christian Couderebbc0882009-03-29 09:44:44[diff] [blame]48
Jeff King37e81612011-09-13 21:58:08[diff] [blame]49/*
50 * Same as above, but store the unquoted strings in an argv_array. We will
51 * still modify arg in place, but unlike sq_dequote_to_argv, the argv_array
52 * will duplicate and take ownership of the strings.
53 */
54struct argv_array;
55extern int sq_dequote_to_argv_array(char *arg, struct argv_array *);
56
Pierre Habouzit7fb10112007-09-19 22:42:14[diff] [blame]57extern int unquote_c_style(struct strbuf *, const char *quoted, const char **endp);
Pierre Habouzit663af342007-09-19 22:42:15[diff] [blame]58extern size_t quote_c_style(const char *name, struct strbuf *, FILE *, int no_dq);
Junio C Hamanod5625092007-12-27 01:13:36[diff] [blame]59extern void quote_two_c_style(struct strbuf *, const char *, const char *, int);
Junio C Hamano4f6fbcd2005-10-15 04:54:47[diff] [blame]60
Pierre Habouzit663af342007-09-19 22:42:15[diff] [blame]61extern void write_name_quoted(const char *name, FILE *, int terminator);
Jiang Xine9a820c2013-06-25 15:53:46[diff] [blame]62extern void write_name_quoted_relative(const char *name, const char *prefix,
Clemens Buchacherb167cff2010-06-03 13:36:31[diff] [blame]63 FILE *fp, int terminator);
Junio C Hamano6fb737b2005-07-08 06:58:32[diff] [blame]64
Dmitry Potapova734d0b2008-03-07 02:30:58[diff] [blame]65/* quote path as relative to the given prefix */
Jiang Xin39598f92013-06-25 15:53:45[diff] [blame]66extern char *quote_path_relative(const char *in, const char *prefix,
67 struct strbuf *out);
Dmitry Potapova734d0b2008-03-07 02:30:58[diff] [blame]68
Junio C Hamano9f613dd2006-09-15 20:30:02[diff] [blame]69/* quoting as a string literal for other languages */
Nguyễn Thái Ngọc Duy10d01672013-07-30 08:31:25[diff] [blame]70extern void perl_quote_buf(struct strbuf *sb, const char *src);
71extern void python_quote_buf(struct strbuf *sb, const char *src);
72extern void tcl_quote_buf(struct strbuf *sb, const char *src);
Nguyễn Thái Ngọc Duy793dc672016-06-25 05:22:31[diff] [blame]73extern void basic_regex_quote_buf(struct strbuf *sb, const char *src);
Junio C Hamano9f613dd2006-09-15 20:30:02[diff] [blame]74
Junio C Hamano6fb737b2005-07-08 06:58:32[diff] [blame]75#endif