1/* quote.h - prototypes for quote.c
2
3 Copyright (C) 1998-2001, 2003, 2009-2019 Free Software Foundation, Inc.
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 QUOTE_H_
19# define QUOTE_H_ 1
20
21# include <stddef.h>
22
23/* The quoting options used by quote_n and quote. Its type is incomplete,
24 so it's useful only in expressions like '&quote_quoting_options'. */
25extern struct quoting_options quote_quoting_options;
26
27/* Return an unambiguous printable representation of ARG (of size
28 ARGSIZE), allocated in slot N, suitable for diagnostics. If
29 ARGSIZE is SIZE_MAX, use the string length of the argument for
30 ARGSIZE. */
31char const *quote_n_mem (int n, char const *arg, size_t argsize);
32
33/* Return an unambiguous printable representation of ARG (of size
34 ARGSIZE), suitable for diagnostics. If ARGSIZE is SIZE_MAX, use
35 the string length of the argument for ARGSIZE. */
36char const *quote_mem (char const *arg, size_t argsize);
37
38/* Return an unambiguous printable representation of ARG, allocated in
39 slot N, suitable for diagnostics. */
40char const *quote_n (int n, char const *arg);
41
42/* Return an unambiguous printable representation of ARG, suitable for
43 diagnostics. */
44char const *quote (char const *arg);
45
46#endif /* !QUOTE_H_ */
47