summary refs log tree commit diff
path: root/quote.h
diff options
context:
space:
mode:
authorH. Peter Anvin <hpa@zytor.com>2005-10-10 14:46:10 -0700
committerJunio C Hamano <junkio@cox.net>2005-10-10 14:46:10 -0700
commit77d604c30974587a2e0d36d92c48cef87f6e8e4d (patch)
tree14968934196d8160d040ea73d9981da00c6adc54 /quote.h
parent4769948afe7c502d37746edc2ee2c084c9dcb325 (diff)
Enhanced sq_quote()
Create function to sq_quote into a buffer
Handle !'s for csh-based shells

Signed-off-by: H. Peter Anvin <hpa@zytor.com>
Signed-off-by: Junio C Hamano <junkio@cox.net>
Diffstat (limited to 'quote.h')
-rw-r--r--quote.h11
1 files changed, 9 insertions, 2 deletions
diff --git a/quote.h b/quote.h
index c8cfb3a124..50ce1df976 100644
--- a/quote.h
+++ b/quote.h
@@ -1,10 +1,12 @@
 #ifndef QUOTE_H
 #define QUOTE_H
 
+#include <stddef.h>
 
 /* Help to copy the thing properly quoted for the shell safety.
- * any single quote is replaced with '\'', and the whole thing
- * is enclosed in a single quote pair.
+ * 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:
@@ -19,8 +21,13 @@
  *
  * 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.
  */
 
 char *sq_quote(const char *src);
+size_t sq_quote_buf(char *dst, size_t n, const char *src);
 
 #endif