| 1 | /* quotearg.h - quote arguments for output
|
|---|
| 2 | Copyright (C) 1998, 1999, 2000 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. */
|
|---|
| 21 | enum 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 | clocale_quoting_style /* --quoting-style=clocale */
|
|---|
| 30 | };
|
|---|
| 31 |
|
|---|
| 32 | /* For now, --quoting-style=literal is the default, but this may change. */
|
|---|
| 33 | #ifndef DEFAULT_QUOTING_STYLE
|
|---|
| 34 | # define DEFAULT_QUOTING_STYLE literal_quoting_style
|
|---|
| 35 | #endif
|
|---|
| 36 |
|
|---|
| 37 | /* Names of quoting styles and their corresponding values. */
|
|---|
| 38 | extern char const *const quoting_style_args[];
|
|---|
| 39 | extern enum quoting_style const quoting_style_vals[];
|
|---|
| 40 |
|
|---|
| 41 | struct quoting_options;
|
|---|
| 42 |
|
|---|
| 43 | #ifndef PARAMS
|
|---|
| 44 | # if defined PROTOTYPES || defined __STDC__
|
|---|
| 45 | # define PARAMS(Args) Args
|
|---|
| 46 | # else
|
|---|
| 47 | # define PARAMS(Args) ()
|
|---|
| 48 | # endif
|
|---|
| 49 | #endif
|
|---|
| 50 |
|
|---|
| 51 | /* The functions listed below set and use a hidden variable
|
|---|
| 52 | that contains the default quoting style options. */
|
|---|
| 53 |
|
|---|
| 54 | /* Allocate a new set of quoting options, with contents initially identical
|
|---|
| 55 | to O if O is not null, or to the default if O is null.
|
|---|
| 56 | It is the caller's responsibility to free the result. */
|
|---|
| 57 | struct quoting_options *clone_quoting_options
|
|---|
| 58 | PARAMS ((struct quoting_options *o));
|
|---|
| 59 |
|
|---|
| 60 | /* Get the value of O's quoting style. If O is null, use the default. */
|
|---|
| 61 | enum quoting_style get_quoting_style PARAMS ((struct quoting_options *o));
|
|---|
| 62 |
|
|---|
| 63 | /* In O (or in the default if O is null),
|
|---|
| 64 | set the value of the quoting style to S. */
|
|---|
| 65 | void set_quoting_style PARAMS ((struct quoting_options *o,
|
|---|
| 66 | enum quoting_style s));
|
|---|
| 67 |
|
|---|
| 68 | /* In O (or in the default if O is null),
|
|---|
| 69 | set the value of the quoting options for character C to I.
|
|---|
| 70 | Return the old value. Currently, the only values defined for I are
|
|---|
| 71 | 0 (the default) and 1 (which means to quote the character even if
|
|---|
| 72 | it would not otherwise be quoted). */
|
|---|
| 73 | int set_char_quoting PARAMS ((struct quoting_options *o, char c, int i));
|
|---|
| 74 |
|
|---|
| 75 | /* Place into buffer BUFFER (of size BUFFERSIZE) a quoted version of
|
|---|
| 76 | argument ARG (of size ARGSIZE), using O to control quoting.
|
|---|
| 77 | If O is null, use the default.
|
|---|
| 78 | Terminate the output with a null character, and return the written
|
|---|
| 79 | size of the output, not counting the terminating null.
|
|---|
| 80 | If BUFFERSIZE is too small to store the output string, return the
|
|---|
| 81 | value that would have been returned had BUFFERSIZE been large enough.
|
|---|
| 82 | If ARGSIZE is -1, use the string length of the argument for ARGSIZE. */
|
|---|
| 83 | size_t quotearg_buffer PARAMS ((char *buffer, size_t buffersize,
|
|---|
| 84 | char const *arg, size_t argsize,
|
|---|
| 85 | struct quoting_options const *o));
|
|---|
| 86 |
|
|---|
| 87 | /* Use storage slot N to return a quoted version of the string ARG.
|
|---|
| 88 | Use the default quoting options.
|
|---|
| 89 | The returned value points to static storage that can be
|
|---|
| 90 | reused by the next call to this function with the same value of N.
|
|---|
| 91 | N must be nonnegative. */
|
|---|
| 92 | char *quotearg_n PARAMS ((unsigned int n, char const *arg));
|
|---|
| 93 |
|
|---|
| 94 | /* Equivalent to quotearg_n (0, ARG). */
|
|---|
| 95 | char *quotearg PARAMS ((char const *arg));
|
|---|
| 96 |
|
|---|
| 97 | /* Use style S and storage slot N to return a quoted version of the string ARG.
|
|---|
| 98 | This is like quotearg_n (N, ARG), except that it uses S with no other
|
|---|
| 99 | options to specify the quoting method. */
|
|---|
| 100 | char *quotearg_n_style PARAMS ((unsigned int n, enum quoting_style s,
|
|---|
| 101 | char const *arg));
|
|---|
| 102 |
|
|---|
| 103 | /* Equivalent to quotearg_n_style (0, S, ARG). */
|
|---|
| 104 | char *quotearg_style PARAMS ((enum quoting_style s, char const *arg));
|
|---|
| 105 |
|
|---|
| 106 | /* Like quotearg (ARG), except also quote any instances of CH. */
|
|---|
| 107 | char *quotearg_char PARAMS ((char const *arg, char ch));
|
|---|
| 108 |
|
|---|
| 109 | /* Equivalent to quotearg_char (ARG, ':'). */
|
|---|
| 110 | char *quotearg_colon PARAMS ((char const *arg));
|
|---|
