lib/argz.in.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
  24 #define __need_error_t
  25 #include <errno.h>
  26 #include <string.h>             /* Need size_t, and strchr is called below.  */
  27
  28 #ifndef const
  29 # define const const
  30 #endif
  31
  32 #ifndef __error_t_defined
  33 typedef int error_t;
  34 #endif
  35
  36
  37
  38 /* Make a '\0' separated arg vector from a unix argv vector, returning it in
  39    ARGZ, and the total length in LEN.  If a memory allocation error occurs,
  40    ENOMEM is returned, otherwise 0.  The result can be destroyed using free. */
  41
  42 extern error_t argz_create (char *const __argv[], char **restrict __argz,
  43                             size_t *restrict __len);
  44
  45 /* Make a '\0' separated arg vector from a SEP separated list in
  46    STRING, returning it in ARGZ, and the total length in LEN.  If a
  47    memory allocation error occurs, ENOMEM is returned, otherwise 0.
  48    The result can be destroyed using free.  */
  49
  50 extern error_t argz_create_sep (const char *restrict string,
  51                                 int __sep, char **restrict __argz,
  52                                 size_t *restrict __len);
  53
  54 /* Returns the number of strings in ARGZ.  */
  55
  56 extern size_t argz_count (const char *__argz, size_t __len)
  57 ;
  58
  59 /* Puts pointers to each string in ARGZ into ARGV, which must be large enough
  60    to hold them all.  */
  61
  62 extern void argz_extract (const char *restrict __argz, size_t __len,
  63                           char **restrict __argv);
  64
  65 /* Make '\0' separated arg vector ARGZ printable by converting all the '\0's
  66    except the last into the character SEP.  */
  67
  68 extern void argz_stringify (char *__argz, size_t __len, int __sep);
  69
  70 /* Append BUF, of length BUF_LEN to the argz vector in ARGZ & ARGZ_LEN.  */
  71
  72 extern error_t argz_append (char **restrict __argz,
  73                             size_t *restrict __argz_len,
  74                             const char *restrict __buf, size_t __buf_len)
  75 ;
  76
  77 /* Append STR to the argz vector in ARGZ & ARGZ_LEN.  */
  78
  79 extern error_t argz_add (char **restrict __argz,
  80                          size_t *restrict __argz_len,
  81                          const char *restrict str);
  82
  83 /* Append SEP separated list in STRING to the argz vector in ARGZ &
  84    ARGZ_LEN.  */
  85
  86 extern error_t argz_add_sep (char **restrict __argz,
  87                              size_t *restrict __argz_len,
  88                              const char *restrict string, int __delim)
  89 ;
  90
  91 /* Delete ENTRY from ARGZ & ARGZ_LEN, if it appears there.  */
  92
  93 extern void argz_delete (char **restrict __argz,
  94                          size_t *restrict __argz_len,
  95                          char *restrict __entry);
  96
  97 /* Insert ENTRY into ARGZ & ARGZ_LEN before BEFORE, which should be an
  98    existing entry in ARGZ; if BEFORE is NULL, ENTRY is appended to the end.
  99    Since ARGZ's first entry is the same as ARGZ, argz_insert (ARGZ, ARGZ_LEN,
 100    ARGZ, ENTRY) will insert ENTRY at the beginning of ARGZ.  If BEFORE is not
 101    in ARGZ, EINVAL is returned, else if memory can't be allocated for the new
 102    ARGZ, ENOMEM is returned, else 0.  */
 103
 104 extern error_t argz_insert (char **restrict __argz,
 105                             size_t *restrict __argz_len,
 106                             char *restrict __before,
 107                             const char *restrict __entry);
 108
 109 /* Replace any occurrences of the string STR in ARGZ with WITH, reallocating
 110    ARGZ as necessary.  If REPLACE_COUNT is non-zero, *REPLACE_COUNT will be
 111    incremented by number of replacements performed.  */
 112
 113 extern error_t argz_replace (char **restrict __argz,
 114                              size_t *restrict __argz_len,
 115                              const char *restrict str,
 116                              const char *restrict __with,
 117                              unsigned int *restrict __replace_count);
 118 \f
 119 /* Returns the next entry in ARGZ & ARGZ_LEN after ENTRY, or NULL if there
 120    are no more.  If entry is NULL, then the first entry is returned.  This
 121    behavior allows two convenient iteration styles:
 122
 123     char *entry = 0;
 124     while ((entry = argz_next (argz, argz_len, entry)))
 125       ...;
 126
 127    or
 128
 129     char *entry;
 130     for (entry = argz; entry; entry = argz_next (argz, argz_len, entry))
 131       ...;
 132 */
 133
 134 extern char *argz_next (const char *restrict __argz, size_t __argz_len,
 135                         const char *restrict __entry);
 136
 137 #ifdef __USE_EXTERN_INLINES
 138 __extern_inline char *
 139 __NTH (argz_next (const char *__argz, size_t __argz_len,
 140                     const char *__entry))
 141 {
 142   if (__entry)
 143     {
 144       if (__entry < __argz + __argz_len)
 145         __entry = strchr (__entry, '\0') + 1;
 146
 147       return __entry >= __argz + __argz_len ? (char *) NULL : (char *) __entry;
 148     }
 149   else
 150     return __argz_len > 0 ? (char *) __argz : 0;
 151 }
 152 __extern_inline char *
 153 __NTH (argz_next (const char *__argz, size_t __argz_len,
 154                   const char *__entry))
 155 {
 156   return argz_next (__argz, __argz_len, __entry);
 157 }
 158 #endif /* Use extern inlines.  */
 159
 160
 161 #endif /* argz.h */