1 /* Shell quoting. 2 Copyright (C) 2001-2002, 2004, 2009-2021 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 3 of the License, or 8 (at your option) 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, see <https://www.gnu.org/licenses/>. */ 17 18 #ifndef _SH_QUOTE_H 19 #define _SH_QUOTE_H 20 21 /* When passing a command to a shell, we must quote the program name and 22 arguments, since Unix shells interpret characters like " ", "'", "<", ">", 23 "$", '*', '?' etc. in a special way. */ 24 25 #include <stdlib.h> 26 27 #ifdef __cplusplus 28 extern "C" { 29 #endif 30 31 /* Returns the number of bytes needed for the quoted string. */ 32 extern size_t shell_quote_length (const char *string); 33 34 /* Copies the quoted string to p and returns the incremented p. 35 There must be room for shell_quote_length (string) + 1 bytes at p. */ 36 extern char * shell_quote_copy (char *restrict p, const char *string); 37 38 /* Returns the freshly allocated quoted string. */ 39 extern char * shell_quote (const char *string) 40 _GL_ATTRIBUTE_MALLOC _GL_ATTRIBUTE_DEALLOC_FREE 41 _GL_ATTRIBUTE_RETURNS_NONNULL; 42 43 /* Returns a freshly allocated string containing all argument strings, quoted, 44 separated through spaces. */ 45 extern char * shell_quote_argv (const char * const *argv) 46 _GL_ATTRIBUTE_MALLOC _GL_ATTRIBUTE_DEALLOC_FREE 47 _GL_ATTRIBUTE_RETURNS_NONNULL; 48 49 #ifdef __cplusplus 50 } 51 #endif 52 53 #endif /* _SH_QUOTE_H */