gnu/usr.bin/texinfo/libgnu/argz.h

   1 /* DO NOT EDIT! GENERATED AUTOMATICALLY! */
   2 /* Routines for dealing with '\0' separated arg vectors.
   3    Copyright (C) 1995,96,97,98,99,2000,2004,2007 Free Software Foundation, Inc.
   4    This file is part of the GNU C Library.
   5
   6    The GNU C Library is free software; you can redistribute it and/or
   7    modify it under the terms of the GNU General Public
   8    License as published by the Free Software Foundation; either
   9    version 3 of the License, or (at your option) any later version.
  10
  11    The GNU C Library 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 GNU
  14    Lesser General Public License for more details.
  15
  16    You should have received a copy of the GNU General Public
  17    License along with the GNU C Library; if not, write to the Free
  18    Software Foundation, Inc., 59 Temple Place, Suite 330, Boston, MA
  19    02111-1307 USA.  */
  20
  21 #ifndef _ARGZ_H
  22 #define _ARGZ_H 1
  23
  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
  39 /* Make a '\0' separated arg vector from a unix argv vector, returning it in
  40    ARGZ, and the total length in LEN.  If a memory allocation error occurs,
  41    ENOMEM is returned, otherwise 0.  The result can be destroyed using free. */
  42
  43 extern error_t argz_create (char *const __argv[], char **restrict __argz,
  44                             size_t *restrict __len);
  45
  46 /* Make a '\0' separated arg vector from a SEP separated list in
  47    STRING, returning it in ARGZ, and the total length in LEN.  If a
  48    memory allocation error occurs, ENOMEM is returned, otherwise 0.
  49    The result can be destroyed using free.  */
  50
  51 extern error_t argz_create_sep (const char *restrict string,
  52                                 int __sep, char **restrict __argz,
  53                                 size_t *restrict __len);
  54
  55 /* Returns the number of strings in ARGZ.  */
  56
  57 extern size_t argz_count (const char *__argz, size_t __len)
  58 ;
  59
  60 /* Puts pointers to each string in ARGZ into ARGV, which must be large enough
  61    to hold them all.  */
  62
  63 extern void argz_extract (const char *restrict __argz, size_t __len,
  64                           char **restrict __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
  69 extern void argz_stringify (char *__argz, size_t __len, int __sep);
  70
  71 /* Append BUF, of length BUF_LEN to the argz vector in ARGZ & ARGZ_LEN.  */
  72
  73 extern error_t argz_append (char **restrict __argz,
  74                             size_t *restrict __argz_len,
  75                             const char *restrict __buf, size_t __buf_len)
  76 ;
  77
  78 /* Append STR to the argz vector in ARGZ & ARGZ_LEN.  */
  79
  80 extern error_t argz_add (char **restrict __argz,
  81                          size_t *restrict __argz_len,
  82                          const char *restrict str);
  83
  84 /* Append SEP separated list in STRING to the argz vector in ARGZ &
  85    ARGZ_LEN.  */
  86
  87 extern error_t argz_add_sep (char **restrict __argz,
  88                              size_t *restrict __argz_len,
  89                              const char *restrict string, int __delim)
  90 ;
  91
  92 /* Delete ENTRY from ARGZ & ARGZ_LEN, if it appears there.  */
  93
  94 extern void argz_delete (char **restrict __argz,
  95                          size_t *restrict __argz_len,
  96                          char *restrict __entry);
  97
  98 /* Insert ENTRY into ARGZ & ARGZ_LEN before BEFORE, which should be an
  99    existing entry in ARGZ; if BEFORE is NULL, ENTRY is appended to the end.
 100    Since ARGZ's first entry is the same as ARGZ, argz_insert (ARGZ, ARGZ_LEN,
 101    ARGZ, ENTRY) will insert ENTRY at the beginning of ARGZ.  If BEFORE is not
 102    in ARGZ, EINVAL is returned, else if memory can't be allocated for the new
 103    ARGZ, ENOMEM is returned, else 0.  */
 104
 105 extern error_t argz_insert (char **restrict __argz,
 106                             size_t *restrict __argz_len,
 107                             char *restrict __before,
 108                             const char *restrict __entry);
 109
 110 /* Replace any occurrences of the string STR in ARGZ with WITH, reallocating
 111    ARGZ as necessary.  If REPLACE_COUNT is non-zero, *REPLACE_COUNT will be
 112    incremented by number of replacements performed.  */
 113
 114 extern error_t argz_replace (char **restrict __argz,
 115                              size_t *restrict __argz_len,
 116                              const char *restrict str,
 117                              const char *restrict __with,
 118                              unsigned int *restrict __replace_count);
 119 \f
 120 /* Returns the next entry in ARGZ & ARGZ_LEN after ENTRY, or NULL if there
 121    are no more.  If entry is NULL, then the first entry is returned.  This
 122    behavior allows two convenient iteration styles:
 123
 124     char *entry = 0;
 125     while ((entry = argz_next (argz, argz_len, entry)))
 126       ...;
 127
 128    or
 129
 130     char *entry;
 131     for (entry = argz; entry; entry = argz_next (argz, argz_len, entry))
 132       ...;
 133 */
 134
 135 extern char *argz_next (const char *restrict __argz, size_t __argz_len,
 136                         const char *restrict __entry);
 137
 138 #ifdef __USE_EXTERN_INLINES
 139 __extern_inline char *
 140 __NTH (argz_next (const char *__argz, size_t __argz_len,
 141                     const char *__entry))
 142 {
 143   if (__entry)
 144     {
 145       if (__entry < __argz + __argz_len)
 146         __entry = strchr (__entry, '\0') + 1;
 147
 148       return __entry >= __argz + __argz_len ? (char *) NULL : (char *) __entry;
 149     }
 150   else
 151     return __argz_len > 0 ? (char *) __argz : 0;
 152 }
 153 __extern_inline char *
 154 __NTH (argz_next (const char *__argz, size_t __argz_len,
 155                   const char *__entry))
 156 {
 157   return argz_next (__argz, __argz_len, __entry);
 158 }
 159 #endif /* Use extern inlines.  */
 160
 161
 162 #endif /* argz.h */