2005-07-08 08:58:32 +02:00
|
|
|
#ifndef QUOTE_H
|
|
|
|
|
#define QUOTE_H
|
|
|
|
|
|
2005-10-10 23:46:10 +02:00
|
|
|
#include <stddef.h>
|
2005-10-15 06:54:47 +02:00
|
|
|
#include <stdio.h>
|
2005-07-08 08:58:32 +02:00
|
|
|
|
|
|
|
|
/* Help to copy the thing properly quoted for the shell safety.
|
2005-10-10 23:46:10 +02:00
|
|
|
* any single quote is replaced with '\'', any exclamation point
|
|
|
|
|
* is replaced with '\!', and the whole thing is enclosed in a
|
|
|
|
|
* single quote pair.
|
2005-07-08 08:58:32 +02:00
|
|
|
*
|
|
|
|
|
* 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.
|
2005-10-10 23:46:10 +02:00
|
|
|
*
|
|
|
|
|
* sq_quote_buf() writes to an existing buffer of specified size; it
|
|
|
|
|
* will return the number of characters that would have been written
|
|
|
|
|
* excluding the final null regardless of the buffer size.
|
2005-07-08 08:58:32 +02:00
|
|
|
*/
|
|
|
|
|
|
2006-06-25 15:56:18 +02:00
|
|
|
extern void sq_quote_print(FILE *stream, const char *src);
|
2005-10-15 06:54:47 +02:00
|
|
|
|
2007-09-20 00:42:13 +02:00
|
|
|
extern void sq_quote_buf(struct strbuf *, const char *src);
|
2007-12-03 05:51:50 +01:00
|
|
|
extern void sq_quote_argv(struct strbuf *, const char **argv, size_t maxlen);
|
2006-09-11 06:59:22 +02:00
|
|
|
|
2005-10-23 23:30:45 +02:00
|
|
|
/* This unwraps what sq_quote() produces in place, but returns
|
|
|
|
|
* NULL if the input does not look like what sq_quote would have
|
|
|
|
|
* produced.
|
|
|
|
|
*/
|
|
|
|
|
extern char *sq_dequote(char *);
|
|
|
|
|
|
2007-09-20 00:42:14 +02:00
|
|
|
extern int unquote_c_style(struct strbuf *, const char *quoted, const char **endp);
|
Full rework of quote_c_style and write_name_quoted.
* quote_c_style works on a strbuf instead of a wild buffer.
* quote_c_style is now clever enough to not add double quotes if not needed.
* write_name_quoted inherits those advantages, but also take a different
set of arguments. Now instead of asking for quotes or not, you pass a
"terminator". If it's \0 then we assume you don't want to escape, else C
escaping is performed. In any case, the terminator is also appended to the
stream. It also no longer takes the prefix/prefix_len arguments, as it's
seldomly used, and makes some optimizations harder.
* write_name_quotedpfx is created to work like write_name_quoted and take
the prefix/prefix_len arguments.
Thanks to those API changes, diff.c has somehow lost weight, thanks to the
removal of functions that were wrappers around the old write_name_quoted
trying to give it a semantics like the new one, but performing a lot of
allocations for this goal. Now we always write directly to the stream, no
intermediate allocation is performed.
As a side effect of the refactor in builtin-apply.c, the length of the bar
graphs in diffstats are not affected anymore by the fact that the path was
clipped.
Signed-off-by: Pierre Habouzit <madcoder@debian.org>
2007-09-20 00:42:15 +02:00
|
|
|
extern size_t quote_c_style(const char *name, struct strbuf *, FILE *, int no_dq);
|
2007-12-27 02:13:36 +01:00
|
|
|
extern void quote_two_c_style(struct strbuf *, const char *, const char *, int);
|
2005-10-15 06:54:47 +02:00
|
|
|
|
Full rework of quote_c_style and write_name_quoted.
* quote_c_style works on a strbuf instead of a wild buffer.
* quote_c_style is now clever enough to not add double quotes if not needed.
* write_name_quoted inherits those advantages, but also take a different
set of arguments. Now instead of asking for quotes or not, you pass a
"terminator". If it's \0 then we assume you don't want to escape, else C
escaping is performed. In any case, the terminator is also appended to the
stream. It also no longer takes the prefix/prefix_len arguments, as it's
seldomly used, and makes some optimizations harder.
* write_name_quotedpfx is created to work like write_name_quoted and take
the prefix/prefix_len arguments.
Thanks to those API changes, diff.c has somehow lost weight, thanks to the
removal of functions that were wrappers around the old write_name_quoted
trying to give it a semantics like the new one, but performing a lot of
allocations for this goal. Now we always write directly to the stream, no
intermediate allocation is performed.
As a side effect of the refactor in builtin-apply.c, the length of the bar
graphs in diffstats are not affected anymore by the fact that the path was
clipped.
Signed-off-by: Pierre Habouzit <madcoder@debian.org>
2007-09-20 00:42:15 +02:00
|
|
|
extern void write_name_quoted(const char *name, FILE *, int terminator);
|
|
|
|
|
extern void write_name_quotedpfx(const char *pfx, size_t pfxlen,
|
|
|
|
|
const char *name, FILE *, int terminator);
|
2005-07-08 08:58:32 +02:00
|
|
|
|
2008-03-07 03:30:58 +01:00
|
|
|
/* quote path as relative to the given prefix */
|
|
|
|
|
char *quote_path_relative(const char *in, int len,
|
|
|
|
|
struct strbuf *out, const char *prefix);
|
|
|
|
|
|
2006-09-15 22:30:02 +02:00
|
|
|
/* quoting as a string literal for other languages */
|
|
|
|
|
extern void perl_quote_print(FILE *stream, const char *src);
|
|
|
|
|
extern void python_quote_print(FILE *stream, const char *src);
|
2007-01-28 08:39:13 +01:00
|
|
|
extern void tcl_quote_print(FILE *stream, const char *src);
|
2006-09-15 22:30:02 +02:00
|
|
|
|
2005-07-08 08:58:32 +02:00
|
|
|
#endif
|