lib/quotearg.h

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