mirror of
https://github.com/git/git.git
synced 2024-10-06 18:01:26 +02:00
4f6fbcdcf9
Following the list discussion, define two functions, quote_c_style and
unquote_c_style, to help adopting the proposed way for quoting funny
pathname letters for GNU patch. The rule is described in:
http://marc.theaimsgroup.com/?l=git&m=112927316408690&w=2
Currently we do not support the leading '!', but we probably should
barf upon seeing it. Rule B4. is interpreted to require always 3
octal digits in \XYZ notation.
Signed-off-by: Junio C Hamano <junkio@cox.net>
42 lines
1.3 KiB
C
42 lines
1.3 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 char *sq_quote(const char *src);
|
|
extern size_t sq_quote_buf(char *dst, size_t n, const char *src);
|
|
|
|
extern int quote_c_style(const char *name, char *outbuf, FILE *outfp,
|
|
int nodq);
|
|
extern char *unquote_c_style(const char *quoted, const char **endp);
|
|
|
|
extern void write_name_quoted(const char *prefix, const char *name,
|
|
int quote, FILE *out);
|
|
|
|
#endif
|