quote.h

   1 #ifndef QUOTE_H
   2 #define QUOTE_H
   3
   4 struct 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  * sq_quotef() quotes the entire formatted string as a single result.
  30  */
  31
  32 void sq_quote_buf(struct strbuf *, const char *src);
  33 void sq_quote_argv(struct strbuf *, const char **argv);
  34 void sq_quotef(struct strbuf *, const char *fmt, ...);
  35
  36 /*
  37  * These match their non-pretty variants, except that they avoid
  38  * quoting when there are no exotic characters. These should only be used for
  39  * human-readable output, as sq_dequote() is not smart enough to dequote it.
  40  */
  41 void sq_quote_buf_pretty(struct strbuf *, const char *src);
  42 void sq_quote_argv_pretty(struct strbuf *, const char **argv);
  43 void sq_append_quote_argv_pretty(struct strbuf *dst, const char **argv);
  44
  45 /*
  46  * This unwraps what sq_quote() produces in place, but returns
  47  * NULL if the input does not look like what sq_quote would have
  48  * produced (the full string must be a single quoted item).
  49  */
  50 char *sq_dequote(char *);
  51
  52 /*
  53  * Like sq_dequote(), but dequote a single item, and leave "next" pointing to
  54  * the next character. E.g., in the string:
  55  *
  56  *   'one' 'two' 'three'
  57  *
  58  * after the first call, the return value would be the unquoted string "one",
  59  * with "next" pointing to the space between "one" and "two"). The caller is
  60  * responsible for advancing the pointer to the start of the next item before
  61  * calling sq_dequote_step() again.
  62  */
  63 char *sq_dequote_step(char *src, char **next);
  64
  65 /*
  66  * Same as the above, but can be used to unwrap many arguments in the
  67  * same string separated by space. Like sq_quote, it works in place,
  68  * modifying arg and appending pointers into it to argv.
  69  */
  70 int sq_dequote_to_argv(char *arg, const char ***argv, int *nr, int *alloc);
  71
  72 /*
  73  * Same as above, but store the unquoted strings in a strvec. We will
  74  * still modify arg in place, but unlike sq_dequote_to_argv, the strvec
  75  * will duplicate and take ownership of the strings.
  76  */
  77 struct strvec;
  78 int sq_dequote_to_strvec(char *arg, struct strvec *);
  79
  80 int unquote_c_style(struct strbuf *, const char *quoted, const char **endp);
  81
  82 /* Bits in the flags parameter to quote_c_style() */
  83 #define CQUOTE_NODQ 01
  84 size_t quote_c_style(const char *name, struct strbuf *, FILE *, unsigned);
  85 void quote_two_c_style(struct strbuf *, const char *, const char *, unsigned);
  86
  87 void write_name_quoted(const char *name, FILE *, int terminator);
  88 void write_name_quoted_relative(const char *name, const char *prefix,
  89                                 FILE *fp, int terminator);
  90
  91 /* quote path as relative to the given prefix */
  92 char *quote_path(const char *in, const char *prefix, struct strbuf *out, unsigned flags);
  93 #define QUOTE_PATH_QUOTE_SP 01
  94
  95 /* quoting as a string literal for other languages */
  96 void perl_quote_buf(struct strbuf *sb, const char *src);
  97 void python_quote_buf(struct strbuf *sb, const char *src);
  98 void tcl_quote_buf(struct strbuf *sb, const char *src);
  99 void basic_regex_quote_buf(struct strbuf *sb, const char *src);
 100
 101 #endif