1/* quotearg.h - quote arguments for output
2   Copyright (C) 1998, 1999 Free Software Foundation, Inc.
3
4   This program is free software; you can redistribute it and/or modify
5   it under the terms of the GNU General Public License as published by
6   the Free Software Foundation; either version 2, or (at your option)
7   any later version.
8
9   This program is distributed in the hope that it will be useful,
10   but WITHOUT ANY WARRANTY; without even the implied warranty of
11   MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
12   GNU General Public License for more details.
13
14   You should have received a copy of the GNU General Public License
15   along with this program; if not, write to the Free Software Foundation,
16   Inc., 59 Temple Place - Suite 330, Boston, MA 02111-1307, USA.  */
17
18/* Written by Paul Eggert <eggert@twinsun.com> */
19
20/* Basic quoting styles.  */
21enum quoting_style
22  {
23    literal_quoting_style,	/* --quoting-style=literal */
24    shell_quoting_style,	/* --quoting-style=shell */
25    shell_always_quoting_style,	/* --quoting-style=shell-always */
26    c_quoting_style,		/* --quoting-style=c */
27    escape_quoting_style,	/* --quoting-style=escape */
28    locale_quoting_style	/* --quoting-style=locale */
29  };
30
31/* For now, --quoting-style=literal is the default, but this may change.  */
32#ifndef DEFAULT_QUOTING_STYLE
33# define DEFAULT_QUOTING_STYLE literal_quoting_style
34#endif
35
36/* Names of quoting styles and their corresponding values.  */
37extern char const *const quoting_style_args[];
38extern enum quoting_style const quoting_style_vals[];
39
40struct quoting_options;
41
42#ifndef PARAMS
43# if defined PROTOTYPES || defined __STDC__
44#  define PARAMS(Args) Args
45# else
46#  define PARAMS(Args) ()
47# endif
48#endif
49
50/* The functions listed below set and use a hidden variable
51   that contains the default quoting style options.  */
52
53/* Allocate a new set of quoting options, with contents initially identical
54   to O if O is not null, or to the default if O is null.
55   It is the caller's responsibility to free the result.  */
56struct quoting_options *clone_quoting_options
57   PARAMS ((struct quoting_options *o));
58
59/* Get the value of O's quoting style.  If O is null, use the default.  */
60enum quoting_style get_quoting_style PARAMS ((struct quoting_options *o));
61
62/* In O (or in the default if O is null),
63   set the value of the quoting style to S.  */
64void set_quoting_style PARAMS ((struct quoting_options *o,
65				enum quoting_style s));
66
67/* In O (or in the default if O is null),
68   set the value of the quoting options for character C to I.
69   Return the old value.  Currently, the only values defined for I are
70   0 (the default) and 1 (which means to quote the character even if
71   it would not otherwise be quoted).  */
72int set_char_quoting PARAMS ((struct quoting_options *o, char c, int i));
73
74/* Place into buffer BUFFER (of size BUFFERSIZE) a quoted version of
75   argument ARG (of size ARGSIZE), using O to control quoting.
76   If O is null, use the default.
77   Terminate the output with a null character, and return the written
78   size of the output, not counting the terminating null.
79   If BUFFERSIZE is too small to store the output string, return the
80   value that would have been returned had BUFFERSIZE been large enough.
81   If ARGSIZE is -1, use the string length of the argument for ARGSIZE.  */
82size_t quotearg_buffer PARAMS ((char *buffer, size_t buffersize,
83				char const *arg, size_t argsize,
84				struct quoting_options const *o));
85
86/* Use storage slot N to return a quoted version of the string ARG.
87   Use the default quoting options.
88   The returned value points to static storage that can be
89   reused by the next call to this function with the same value of N.
90   N must be nonnegative.  */
91char *quotearg_n PARAMS ((unsigned int n, char const *arg));
92
93/* Equivalent to quotearg_n (0, ARG).  */
94char *quotearg PARAMS ((char const *arg));
95
96/* Use style S and storage slot N to return a quoted version of the string ARG.
97   This is like quotearg_n (N, ARG), except that it uses S with no other
98   options to specify the quoting method.  */
99char *quotearg_n_style PARAMS ((unsigned int n, enum quoting_style s,
100				char const *arg));
101
102/* Equivalent to quotearg_n_style (0, S, ARG).  */
103char *quotearg_style PARAMS ((enum quoting_style s, char const *arg));
104
105/* Like quotearg (ARG), except also quote any instances of CH.  */
106char *quotearg_char PARAMS ((char const *arg, char ch));
107
108/* Equivalent to quotearg_char (ARG, ':').  */
109char *quotearg_colon PARAMS ((char const *arg));
110