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