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