string/argz.h

   1 /* Routines for dealing with '\0' separated arg vectors.
   2    Copyright (C) 1995, 1996, 1997 Free Software Foundation, Inc.
   3    Written by Miles Bader <miles@gnu.ai.mit.edu>
   4
   5    The GNU C Library is free software; you can redistribute it and/or
   6    modify it under the terms of the GNU Library General Public License as
   7    published by the Free Software Foundation; either version 2 of the
   8    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    Library General Public License for more details.
  14
  15    You should have received a copy of the GNU Library General Public
  16    License along with the GNU C Library; see the file COPYING.LIB.  If not,
  17    write to the Free Software Foundation, Inc., 59 Temple Place - Suite 330,
  18    Boston, MA 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 __P ((char *__const __argv[], char **__argz,
  44                                    size_t *__len));
  45 extern error_t argz_create __P ((char *__const __argv[], char **__argz,
  46                                  size_t *__len));
  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 __P ((__const char *__string, int __sep,
  53                                        char **__argz, size_t *__len));
  54 extern error_t argz_create_sep __P ((__const char *__string, int __sep,
  55                                      char **__argz, size_t *__len));
  56
  57 /* Returns the number of strings in ARGZ.  */
  58 extern size_t __argz_count __P ((__const char *__argz, size_t __len));
  59 extern size_t argz_count __P ((__const char *__argz, size_t __len));
  60
  61 /* Puts pointers to each string in ARGZ into ARGV, which must be large enough
  62    to hold them all.  */
  63 extern void __argz_extract __P ((char *__argz, size_t __len, char **__argv));
  64 extern void argz_extract __P ((char *__argz, size_t __len, char **__argv));
  65
  66 /* Make '\0' separated arg vector ARGZ printable by converting all the '\0's
  67    except the last into the character SEP.  */
  68 extern void __argz_stringify __P ((char *__argz, size_t __len, int __sep));
  69 extern void argz_stringify __P ((char *__argz, size_t __len, int __sep));
  70
  71 /* Append BUF, of length BUF_LEN to the argz vector in ARGZ & ARGZ_LEN.  */
  72 extern error_t __argz_append __P ((char **__argz, size_t *__argz_len,
  73                                    __const char *__buf, size_t _buf_len));
  74 extern error_t argz_append __P ((char **__argz, size_t *__argz_len,
  75                                  __const char *__buf, size_t __buf_len));
  76
  77 /* Append STR to the argz vector in ARGZ & ARGZ_LEN.  */
  78 extern error_t __argz_add __P ((char **__argz, size_t *__argz_len,
  79                                 __const char *__str));
  80 extern error_t argz_add __P ((char **__argz, size_t *__argz_len,
  81                               __const char *__str));
  82
  83 /* Append SEP separated list in STRING to the argz vector in ARGZ &
  84    ARGZ_LEN.  */
  85 extern error_t __argz_add_sep __P ((char **__argz, size_t *__argz_len,
  86                                     __const char *__string, int __delim));
  87 extern error_t argz_add_sep __P ((char **__argz, size_t *__argz_len,
  88                                   __const char *__string, int __delim));
  89
  90 /* Delete ENTRY from ARGZ & ARGZ_LEN, if it appears there.  */
  91 extern void __argz_delete __P ((char **__argz, size_t *__argz_len,
  92                                 char *__entry));
  93 extern void argz_delete __P ((char **__argz, size_t *__argz_len,
  94                               char *__entry));
  95
  96 /* Insert ENTRY into ARGZ & ARGZ_LEN before BEFORE, which should be an
  97    existing entry in ARGZ; if BEFORE is NULL, ENTRY is appended to the end.
  98    Since ARGZ's first entry is the same as ARGZ, argz_insert (ARGZ, ARGZ_LEN,
  99    ARGZ, ENTRY) will insert ENTRY at the beginning of ARGZ.  If BEFORE is not
 100    in ARGZ, EINVAL is returned, else if memory can't be allocated for the new
 101    ARGZ, ENOMEM is returned, else 0.  */
 102 extern error_t __argz_insert __P ((char **__argz, size_t *__argz_len,
 103                                    char *__before, __const char *__entry));
 104 extern error_t argz_insert __P ((char **__argz, size_t *__argz_len,
 105                                  char *__before, __const char *__entry));
 106
 107 /* Replace any occurances of the string STR in ARGZ with WITH, reallocating
 108    ARGZ as necessary.  If REPLACE_COUNT is non-zero, *REPLACE_COUNT will be
 109    incremented by number of replacements performed.  */
 110 extern error_t __argz_replace (char **__argz, size_t *__argz_len,
 111                                __const char *__str, __const char *__with,
 112                                unsigned *__replace_count);
 113 extern error_t argz_replace (char **__argz, size_t *__argz_len,
 114                              __const char *__str, __const char *__with,
 115                              unsigned *__replace_count);
 116 \f
 117 /* Returns the next entry in ARGZ & ARGZ_LEN after ENTRY, or NULL if there
 118    are no more.  If entry is NULL, then the first entry is returned.  This
 119    behavior allows two convenient iteration styles:
 120
 121     char *entry = 0;
 122     while ((entry = argz_next (argz, argz_len, entry)))
 123       ...;
 124
 125    or
 126
 127     char *entry;
 128     for (entry = argz; entry; entry = argz_next (argz, argz_len, entry))
 129       ...;
 130 */
 131 extern char *__argz_next __P ((char *argz, size_t __argz_len,
 132                                __const char *entry));
 133 extern char *argz_next __P ((char *argz, size_t __argz_len,
 134                              __const char *entry));
 135
 136 #ifdef __USE_EXTERN_INLINES
 137 extern inline char *
 138 __argz_next (char *__argz, size_t __argz_len, __const char *__entry)
 139 {
 140   if (__entry)
 141     {
 142       if (__entry < __argz + __argz_len)
 143         __entry = strchr (__entry, '\0') + 1;
 144
 145       return __entry >= __argz + __argz_len ? (char *) NULL : (char *) __entry;
 146     }
 147   else
 148     return __argz_len > 0 ? __argz : 0;
 149 }
 150 extern inline char *
 151 argz_next (char *__argz, size_t __argz_len, __const char *__entry)
 152 {
 153   return __argz_next (__argz, __argz_len, __entry);
 154 }
 155 #endif /* Use extern inlines.  */
 156
 157 __END_DECLS
 158
 159 #endif /* argz.h */