Andrew's git - gitweb.git/blob

   1#ifndef QUOTE_H
   2#define QUOTE_H
   3
   4#include <stddef.h>
   5#include <stdio.h>
   6
   7/* Help to copy the thing properly quoted for the shell safety.
   8 * any single quote is replaced with '\'', any exclamation point
   9 * is replaced with '\!', and the whole thing is enclosed in a
  10 * single quote pair.
  11 *
  12 * For example, if you are passing the result to system() as an
  13 * argument:
  14 *
  15 * sprintf(cmd, "foobar %s %s", sq_quote(arg0), sq_quote(arg1))
  16 *
  17 * would be appropriate.  If the system() is going to call ssh to
  18 * run the command on the other side:
  19 *
  20 * sprintf(cmd, "git-diff-tree %s %s", sq_quote(arg0), sq_quote(arg1));
  21 * sprintf(rcmd, "ssh %s %s", sq_quote(host), sq_quote(cmd));
  22 *
  23 * Note that the above examples leak memory!  Remember to free result from
  24 * sq_quote() in a real application.
  25 *
  26 * sq_quote_buf() writes to an existing buffer of specified size; it
  27 * will return the number of characters that would have been written
  28 * excluding the final null regardless of the buffer size.
  29 */
  30
  31extern void sq_quote_print(FILE *stream, const char *src);
  32
  33extern void sq_quote_buf(struct strbuf *, const char *src);
  34extern void sq_quote_argv(struct strbuf *, const char **argv, size_t maxlen);
  35
  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
  42/*
  43 * Same as the above, but can be used to unwrap many arguments in the
  44 * same string separated by space. "next" is changed to point to the
  45 * next argument that should be passed as first parameter. When there
  46 * is no more argument to be dequoted, "next" is updated to point to NULL.
  47 */
  48extern int sq_dequote_to_argv(char *arg, const char ***argv, int *nr, int *alloc);
  49
  50extern int unquote_c_style(struct strbuf *, const char *quoted, const char **endp);
  51extern size_t quote_c_style(const char *name, struct strbuf *, FILE *, int no_dq);
  52extern void quote_two_c_style(struct strbuf *, const char *, const char *, int);
  53
  54extern void write_name_quoted(const char *name, FILE *, int terminator);
  55extern void write_name_quotedpfx(const char *pfx, size_t pfxlen,
  56                                 const char *name, FILE *, int terminator);
  57extern void write_name_quoted_relative(const char *name, size_t len,
  58                const char *prefix, size_t prefix_len,
  59                FILE *fp, int terminator);
  60
  61/* quote path as relative to the given prefix */
  62extern char *quote_path_relative(const char *in, int len,
  63                          struct strbuf *out, const char *prefix);
  64
  65/* quoting as a string literal for other languages */
  66extern void perl_quote_print(FILE *stream, const char *src);
  67extern void python_quote_print(FILE *stream, const char *src);
  68extern void tcl_quote_print(FILE *stream, const char *src);
  69
  70#endif