1998-09-04 Roland McGrath <roland@baalperazim.frob.com>
[kopensolaris-gnu/glibc.git] / string / argz.h
1 /* Routines for dealing with '\0' separated arg vectors.
2    Copyright (C) 1995, 96, 97, 98 Free Software Foundation, Inc.
3    Written by Miles Bader <miles@gnu.org>
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 ((__const char *__argz, size_t __len,
64                                  char **__argv));
65 extern void argz_extract __P ((__const char *__argz, size_t __len,
66                                char **__argv));
67
68 /* Make '\0' separated arg vector ARGZ printable by converting all the '\0's
69    except the last into the character SEP.  */
70 extern void __argz_stringify __P ((char *__argz, size_t __len, int __sep));
71 extern void argz_stringify __P ((char *__argz, size_t __len, int __sep));
72
73 /* Append BUF, of length BUF_LEN to the argz vector in ARGZ & ARGZ_LEN.  */
74 extern error_t __argz_append __P ((char **__argz, size_t *__argz_len,
75                                    __const char *__buf, size_t _buf_len));
76 extern error_t argz_append __P ((char **__argz, size_t *__argz_len,
77                                  __const char *__buf, size_t __buf_len));
78
79 /* Append STR to the argz vector in ARGZ & ARGZ_LEN.  */
80 extern error_t __argz_add __P ((char **__argz, size_t *__argz_len,
81                                 __const char *__str));
82 extern error_t argz_add __P ((char **__argz, size_t *__argz_len,
83                               __const char *__str));
84
85 /* Append SEP separated list in STRING to the argz vector in ARGZ &
86    ARGZ_LEN.  */
87 extern error_t __argz_add_sep __P ((char **__argz, size_t *__argz_len,
88                                     __const char *__string, int __delim));
89 extern error_t argz_add_sep __P ((char **__argz, size_t *__argz_len,
90                                   __const char *__string, int __delim));
91
92 /* Delete ENTRY from ARGZ & ARGZ_LEN, if it appears there.  */
93 extern void __argz_delete __P ((char **__argz, size_t *__argz_len,
94                                 char *__entry));
95 extern void argz_delete __P ((char **__argz, size_t *__argz_len,
96                               char *__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 extern error_t __argz_insert __P ((char **__argz, size_t *__argz_len,
105                                    char *__before, __const char *__entry));
106 extern error_t argz_insert __P ((char **__argz, size_t *__argz_len,
107                                  char *__before, __const char *__entry));
108
109 /* Replace any occurances 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 extern error_t __argz_replace (char **__argz, size_t *__argz_len,
113                                __const char *__str, __const char *__with,
114                                unsigned *__replace_count);
115 extern error_t argz_replace (char **__argz, size_t *__argz_len,
116                              __const char *__str, __const char *__with,
117                              unsigned *__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 extern char *__argz_next __P ((__const char *argz, size_t __argz_len,
134                                __const char *entry));
135 extern char *argz_next __P ((__const char *argz, size_t __argz_len,
136                              __const char *entry));
137
138 #ifdef __USE_EXTERN_INLINES
139 extern inline char *
140 __argz_next (__const char *__argz, size_t __argz_len, __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 ? __argz : 0;
151 }
152 extern inline char *
153 argz_next (__const char *__argz, size_t __argz_len, __const char *__entry)
154 {
155   return __argz_next (__argz, __argz_len, __entry);
156 }
157 #endif /* Use extern inlines.  */
158
159 __END_DECLS
160
161 #endif /* argz.h */