lib/quotearg.h

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