string/argz.h

   1 /* Routines for dealing with '\0' separated arg vectors.
   2    Copyright (C) 1995,96,97,98,99,2000,2004,2007 Free Software Foundation, Inc.
   3    This file is part of the GNU C Library.
   4
   5    The GNU C Library is free software; you can redistribute it and/or
   6    modify it under the terms of the GNU Lesser General Public
   7    License as published by the Free Software Foundation; either
   8    version 2.1 of the License, or (at your option) any later version.
   9
  10    The GNU C Library is distributed in the hope that it will be useful,
  11    but WITHOUT ANY WARRANTY; without even the implied warranty of
  12    MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the GNU
  13    Lesser General Public License for more details.
  14
  15    You should have received a copy of the GNU Lesser General Public
  16    License along with the GNU C Library; if not, write to the Free
  17    Software Foundation, Inc., 59 Temple Place, Suite 330, Boston, MA
  18    02111-1307 USA.  */
  19
  20 #ifndef _ARGZ_H
  21 #define _ARGZ_H 1
  22
  23 #include <features.h>
  24
  25 #define __need_error_t
  26 #include <errno.h>
  27 #include <string.h>             /* Need size_t, and strchr is called below.  */
  28
  29 #ifndef __const
  30 # define __const const
  31 #endif
  32
  33 #ifndef __error_t_defined
  34 typedef int error_t;
  35 #endif
  36
  37
  38 __BEGIN_DECLS
  39
  40 /* Make a '\0' separated arg vector from a unix argv vector, returning it in
  41    ARGZ, and the total length in LEN.  If a memory allocation error occurs,
  42    ENOMEM is returned, otherwise 0.  The result can be destroyed using free. */
  43 extern error_t __argz_create (char *__const __argv[], char **__restrict __argz,
  44                               size_t *__restrict __len) __THROW;
  45 extern error_t argz_create (char *__const __argv[], char **__restrict __argz,
  46                             size_t *__restrict __len) __THROW;
  47
  48 /* Make a '\0' separated arg vector from a SEP separated list in
  49    STRING, returning it in ARGZ, and the total length in LEN.  If a
  50    memory allocation error occurs, ENOMEM is returned, otherwise 0.
  51    The result can be destroyed using free.  */
  52 extern error_t __argz_create_sep (__const char *__restrict __string,
  53                                   int __sep, char **__restrict __argz,
  54                                   size_t *__restrict __len) __THROW;
  55 extern error_t argz_create_sep (__const char *__restrict __string,
  56                                 int __sep, char **__restrict __argz,
  57                                 size_t *__restrict __len) __THROW;
  58
  59 /* Returns the number of strings in ARGZ.  */
  60 extern size_t __argz_count (__const char *__argz, size_t __len)
  61      __THROW __attribute_pure__;
  62 extern size_t argz_count (__const char *__argz, size_t __len)
  63      __THROW __attribute_pure__;
  64
  65 /* Puts pointers to each string in ARGZ into ARGV, which must be large enough
  66    to hold them all.  */
  67 extern void __argz_extract (__const char *__restrict __argz, size_t __len,
  68                             char **__restrict __argv) __THROW;
  69 extern void argz_extract (__const char *__restrict __argz, size_t __len,
  70                           char **__restrict __argv) __THROW;
  71
  72 /* Make '\0' separated arg vector ARGZ printable by converting all the '\0's
  73    except the last into the character SEP.  */
  74 extern void __argz_stringify (char *__argz, size_t __len, int __sep) __THROW;
  75 extern void argz_stringify (char *__argz, size_t __len, int __sep) __THROW;
  76
  77 /* Append BUF, of length BUF_LEN to the argz vector in ARGZ & ARGZ_LEN.  */
  78 extern error_t __argz_append (char **__restrict __argz,
  79                               size_t *__restrict __argz_len,
  80                               __const char *__restrict __buf, size_t _buf_len)
  81      __THROW;
  82 extern error_t argz_append (char **__restrict __argz,
  83                             size_t *__restrict __argz_len,
  84                             __const char *__restrict __buf, size_t __buf_len)
  85      __THROW;
  86
  87 /* Append STR to the argz vector in ARGZ & ARGZ_LEN.  */
  88 extern error_t __argz_add (char **__restrict __argz,
  89                            size_t *__restrict __argz_len,
  90                            __const char *__restrict __str) __THROW;
  91 extern error_t argz_add (char **__restrict __argz,
  92                          size_t *__restrict __argz_len,
  93                          __const char *__restrict __str) __THROW;
  94
  95 /* Append SEP separated list in STRING to the argz vector in ARGZ &
  96    ARGZ_LEN.  */
  97 extern error_t __argz_add_sep (char **__restrict __argz,
  98                                size_t *__restrict __argz_len,
  99                                __const char *__restrict __string, int __delim)
 100      __THROW;
 101 extern error_t argz_add_sep (char **__restrict __argz,
 102                              size_t *__restrict __argz_len,
 103                              __const char *__restrict __string, int __delim)
 104      __THROW;
 105
 106 /* Delete ENTRY from ARGZ & ARGZ_LEN, if it appears there.  */
 107 extern void __argz_delete (char **__restrict __argz,
 108                            size_t *__restrict __argz_len,
 109                            char *__restrict __entry) __THROW;
 110 extern void argz_delete (char **__restrict __argz,
 111                          size_t *__restrict __argz_len,
 112                          char *__restrict __entry) __THROW;
 113
 114 /* Insert ENTRY into ARGZ & ARGZ_LEN before BEFORE, which should be an
 115    existing entry in ARGZ; if BEFORE is NULL, ENTRY is appended to the end.
 116    Since ARGZ's first entry is the same as ARGZ, argz_insert (ARGZ, ARGZ_LEN,
 117    ARGZ, ENTRY) will insert ENTRY at the beginning of ARGZ.  If BEFORE is not
 118    in ARGZ, EINVAL is returned, else if memory can't be allocated for the new
 119    ARGZ, ENOMEM is returned, else 0.  */
 120 extern error_t __argz_insert (char **__restrict __argz,
 121                               size_t *__restrict __argz_len,
 122                               char *__restrict __before,
 123                               __const char *__restrict __entry) __THROW;
 124 extern error_t argz_insert (char **__restrict __argz,
 125                             size_t *__restrict __argz_len,
 126                             char *__restrict __before,
 127                             __const char *__restrict __entry) __THROW;
 128
 129 /* Replace any occurrences of the string STR in ARGZ with WITH, reallocating
 130    ARGZ as necessary.  If REPLACE_COUNT is non-zero, *REPLACE_COUNT will be
 131    incremented by number of replacements performed.  */
 132 extern error_t __argz_replace (char **__restrict __argz,
 133                                size_t *__restrict __argz_len,
 134                                __const char *__restrict __str,
 135                                __const char *__restrict __with,
 136                                unsigned int *__restrict __replace_count);
 137 extern error_t argz_replace (char **__restrict __argz,
 138                              size_t *__restrict __argz_len,
 139                              __const char *__restrict __str,
 140                              __const char *__restrict __with,
 141                              unsigned int *__restrict __replace_count);
 142 \f
 143 /* Returns the next entry in ARGZ & ARGZ_LEN after ENTRY, or NULL if there
 144    are no more.  If entry is NULL, then the first entry is returned.  This
 145    behavior allows two convenient iteration styles:
 146
 147     char *entry = 0;
 148     while ((entry = argz_next (argz, argz_len, entry)))
 149       ...;
 150
 151    or
 152
 153     char *entry;
 154     for (entry = argz; entry; entry = argz_next (argz, argz_len, entry))
 155       ...;
 156 */
 157 extern char *__argz_next (__const char *__restrict __argz, size_t __argz_len,
 158                           __const char *__restrict __entry) __THROW;
 159 extern char *argz_next (__const char *__restrict __argz, size_t __argz_len,
 160                         __const char *__restrict __entry) __THROW;
 161
 162 #ifdef __USE_EXTERN_INLINES
 163 __extern_inline char *
 164 __NTH (__argz_next (__const char *__argz, size_t __argz_len,
 165                     __const char *__entry))
 166 {
 167   if (__entry)
 168     {
 169       if (__entry < __argz + __argz_len)
 170         __entry = strchr (__entry, '\0') + 1;
 171
 172       return __entry >= __argz + __argz_len ? (char *) NULL : (char *) __entry;
 173     }
 174   else
 175     return __argz_len > 0 ? (char *) __argz : 0;
 176 }
 177 __extern_inline char *
 178 __NTH (argz_next (__const char *__argz, size_t __argz_len,
 179                   __const char *__entry))
 180 {
 181   return __argz_next (__argz, __argz_len, __entry);
 182 }
 183 #endif /* Use extern inlines.  */
 184
 185 __END_DECLS
 186
 187 #endif /* argz.h */