Improve name: "count-one-bits" is better than "popcount".
[gnulib.git] / lib / sh-quote.h
1 /* Shell quoting.
2    Copyright (C) 2001-2002, 2004 Free Software Foundation, Inc.
3    Written by Bruno Haible <haible@clisp.cons.org>, 2001.
4
5    This program is free software; you can redistribute it and/or modify
6    it under the terms of the GNU General Public License as published by
7    the Free Software Foundation; either version 2, or (at your option)
8    any later version.
9
10    This program is distributed in the hope that it will be useful,
11    but WITHOUT ANY WARRANTY; without even the implied warranty of
12    MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
13    GNU General Public License for more details.
14
15    You should have received a copy of the GNU General Public License
16    along with this program; if not, write to the Free Software Foundation,
17    Inc., 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301, USA.  */
18
19 /* When passing a command to a shell, we must quote the program name and
20    arguments, since Unix shells interpret characters like " ", "'", "<", ">",
21    "$" etc. in a special way.  */
22
23 #include <stddef.h>
24
25 /* Returns the number of bytes needed for the quoted string.  */
26 extern size_t shell_quote_length (const char *string);
27
28 /* Copies the quoted string to p and returns the incremented p.
29    There must be room for shell_quote_length (string) + 1 bytes at p.  */
30 extern char * shell_quote_copy (char *p, const char *string);
31
32 /* Returns the freshly allocated quoted string.  */
33 extern char * shell_quote (const char *string);
34
35 /* Returns a freshly allocated string containing all argument strings, quoted,
36    separated through spaces.  */
37 extern char * shell_quote_argv (char **argv);