mirror of
https://github.com/git/git.git
synced 2026-01-09 17:46:37 +00:00
663af3422a
* 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>
59 lines
2.1 KiB
C
59 lines
2.1 KiB
C
#ifndef QUOTE_H
|
|
#define QUOTE_H
|
|
|
|
#include <stddef.h>
|
|
#include <stdio.h>
|
|
|
|
/* Help to copy the thing properly quoted for the shell safety.
|
|
* any single quote is replaced with '\'', any exclamation point
|
|
* is replaced with '\!', and the whole thing is enclosed in a
|
|
* single quote pair.
|
|
*
|
|
* 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.
|
|
*
|
|
* 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.
|
|
*/
|
|
|
|
extern void sq_quote_print(FILE *stream, const char *src);
|
|
extern char *sq_quote_argv(const char** argv, int count);
|
|
|
|
/*
|
|
* Append a string to a string buffer, with or without shell quoting.
|
|
* Return true if the buffer overflowed.
|
|
*/
|
|
extern int add_to_string(char **ptrp, int *sizep, const char *str, int quote);
|
|
|
|
/* 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 *);
|
|
|
|
extern int unquote_c_style(struct strbuf *, const char *quoted, const char **endp);
|
|
extern size_t quote_c_style(const char *name, struct strbuf *, FILE *, int no_dq);
|
|
|
|
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);
|
|
|
|
/* 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);
|
|
extern void tcl_quote_print(FILE *stream, const char *src);
|
|
|
|
#endif
|