annotate lib/sh-quote.h @ 10531:e83a90adf243

Override fopen more carefully.
author Bruno Haible <bruno@clisp.org>
date Sun, 28 Sep 2008 16:12:20 +0200
parents bbbbbf4cd1c5
children b5e42ef33b49
Ignore whitespace changes - Everywhere: Within whitespace: At end of lines:
rev   line source
5598
09d49a2e321b New module 'sh-quote'.
Bruno Haible <bruno@clisp.org>
parents:
diff changeset
1 /* Shell quoting.
09d49a2e321b New module 'sh-quote'.
Bruno Haible <bruno@clisp.org>
parents:
diff changeset
2 Copyright (C) 2001-2002, 2004 Free Software Foundation, Inc.
09d49a2e321b New module 'sh-quote'.
Bruno Haible <bruno@clisp.org>
parents:
diff changeset
3 Written by Bruno Haible <haible@clisp.cons.org>, 2001.
09d49a2e321b New module 'sh-quote'.
Bruno Haible <bruno@clisp.org>
parents:
diff changeset
4
9309
bbbbbf4cd1c5 Change copyright notice from GPLv2+ to GPLv3+.
Bruno Haible <bruno@clisp.org>
parents: 5848
diff changeset
5 This program is free software: you can redistribute it and/or modify
5598
09d49a2e321b New module 'sh-quote'.
Bruno Haible <bruno@clisp.org>
parents:
diff changeset
6 it under the terms of the GNU General Public License as published by
9309
bbbbbf4cd1c5 Change copyright notice from GPLv2+ to GPLv3+.
Bruno Haible <bruno@clisp.org>
parents: 5848
diff changeset
7 the Free Software Foundation; either version 3 of the License, or
bbbbbf4cd1c5 Change copyright notice from GPLv2+ to GPLv3+.
Bruno Haible <bruno@clisp.org>
parents: 5848
diff changeset
8 (at your option) any later version.
5598
09d49a2e321b New module 'sh-quote'.
Bruno Haible <bruno@clisp.org>
parents:
diff changeset
9
09d49a2e321b New module 'sh-quote'.
Bruno Haible <bruno@clisp.org>
parents:
diff changeset
10 This program is distributed in the hope that it will be useful,
09d49a2e321b New module 'sh-quote'.
Bruno Haible <bruno@clisp.org>
parents:
diff changeset
11 but WITHOUT ANY WARRANTY; without even the implied warranty of
09d49a2e321b New module 'sh-quote'.
Bruno Haible <bruno@clisp.org>
parents:
diff changeset
12 MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
09d49a2e321b New module 'sh-quote'.
Bruno Haible <bruno@clisp.org>
parents:
diff changeset
13 GNU General Public License for more details.
09d49a2e321b New module 'sh-quote'.
Bruno Haible <bruno@clisp.org>
parents:
diff changeset
14
09d49a2e321b New module 'sh-quote'.
Bruno Haible <bruno@clisp.org>
parents:
diff changeset
15 You should have received a copy of the GNU General Public License
9309
bbbbbf4cd1c5 Change copyright notice from GPLv2+ to GPLv3+.
Bruno Haible <bruno@clisp.org>
parents: 5848
diff changeset
16 along with this program. If not, see <http://www.gnu.org/licenses/>. */
5598
09d49a2e321b New module 'sh-quote'.
Bruno Haible <bruno@clisp.org>
parents:
diff changeset
17
09d49a2e321b New module 'sh-quote'.
Bruno Haible <bruno@clisp.org>
parents:
diff changeset
18 /* When passing a command to a shell, we must quote the program name and
09d49a2e321b New module 'sh-quote'.
Bruno Haible <bruno@clisp.org>
parents:
diff changeset
19 arguments, since Unix shells interpret characters like " ", "'", "<", ">",
09d49a2e321b New module 'sh-quote'.
Bruno Haible <bruno@clisp.org>
parents:
diff changeset
20 "$" etc. in a special way. */
09d49a2e321b New module 'sh-quote'.
Bruno Haible <bruno@clisp.org>
parents:
diff changeset
21
09d49a2e321b New module 'sh-quote'.
Bruno Haible <bruno@clisp.org>
parents:
diff changeset
22 #include <stddef.h>
09d49a2e321b New module 'sh-quote'.
Bruno Haible <bruno@clisp.org>
parents:
diff changeset
23
09d49a2e321b New module 'sh-quote'.
Bruno Haible <bruno@clisp.org>
parents:
diff changeset
24 /* Returns the number of bytes needed for the quoted string. */
09d49a2e321b New module 'sh-quote'.
Bruno Haible <bruno@clisp.org>
parents:
diff changeset
25 extern size_t shell_quote_length (const char *string);
09d49a2e321b New module 'sh-quote'.
Bruno Haible <bruno@clisp.org>
parents:
diff changeset
26
09d49a2e321b New module 'sh-quote'.
Bruno Haible <bruno@clisp.org>
parents:
diff changeset
27 /* Copies the quoted string to p and returns the incremented p.
09d49a2e321b New module 'sh-quote'.
Bruno Haible <bruno@clisp.org>
parents:
diff changeset
28 There must be room for shell_quote_length (string) + 1 bytes at p. */
09d49a2e321b New module 'sh-quote'.
Bruno Haible <bruno@clisp.org>
parents:
diff changeset
29 extern char * shell_quote_copy (char *p, const char *string);
09d49a2e321b New module 'sh-quote'.
Bruno Haible <bruno@clisp.org>
parents:
diff changeset
30
09d49a2e321b New module 'sh-quote'.
Bruno Haible <bruno@clisp.org>
parents:
diff changeset
31 /* Returns the freshly allocated quoted string. */
09d49a2e321b New module 'sh-quote'.
Bruno Haible <bruno@clisp.org>
parents:
diff changeset
32 extern char * shell_quote (const char *string);
09d49a2e321b New module 'sh-quote'.
Bruno Haible <bruno@clisp.org>
parents:
diff changeset
33
09d49a2e321b New module 'sh-quote'.
Bruno Haible <bruno@clisp.org>
parents:
diff changeset
34 /* Returns a freshly allocated string containing all argument strings, quoted,
09d49a2e321b New module 'sh-quote'.
Bruno Haible <bruno@clisp.org>
parents:
diff changeset
35 separated through spaces. */
09d49a2e321b New module 'sh-quote'.
Bruno Haible <bruno@clisp.org>
parents:
diff changeset
36 extern char * shell_quote_argv (char **argv);