]>
Commit | Line | Data |
---|---|---|
392d7920 | 1 | /* Routines for dealing with '\0' separated arg vectors. |
29659dd2 RM |
2 | Copyright (C) 1995, 96, 97, 98 Free Software Foundation, Inc. |
3 | Written by Miles Bader <miles@gnu.org> | |
392d7920 | 4 | |
54d79e99 UD |
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. | |
392d7920 | 9 | |
54d79e99 UD |
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 | |
392d7920 | 12 | MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU |
54d79e99 | 13 | Library General Public License for more details. |
392d7920 | 14 | |
54d79e99 UD |
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. */ | |
392d7920 | 19 | |
5107cf1d UD |
20 | #ifndef _ARGZ_H |
21 | #define _ARGZ_H 1 | |
7a12c6bb RM |
22 | |
23 | #include <features.h> | |
24 | ||
d1a2b102 MB |
25 | #define __need_error_t |
26 | #include <errno.h> | |
392d7920 RM |
27 | #include <string.h> /* Need size_t, and strchr is called below. */ |
28 | ||
d1a2b102 | 29 | #ifndef __const |
2604afb1 | 30 | # define __const const |
d1a2b102 MB |
31 | #endif |
32 | ||
33 | #ifndef __error_t_defined | |
34 | typedef int error_t; | |
35 | #endif | |
36 | ||
7a12c6bb RM |
37 | |
38 | __BEGIN_DECLS | |
39 | ||
392d7920 RM |
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. */ | |
a6ff34d7 UD |
43 | extern error_t __argz_create __P ((char *__const __argv[], |
44 | char **__restrict __argz, | |
45 | size_t *__restrict __len)); | |
46 | extern error_t argz_create __P ((char *__const __argv[], | |
47 | char **__restrict __argz, | |
48 | size_t *__restrict __len)); | |
7a12c6bb RM |
49 | |
50 | /* Make a '\0' separated arg vector from a SEP separated list in | |
51 | STRING, returning it in ARGZ, and the total length in LEN. If a | |
52 | memory allocation error occurs, ENOMEM is returned, otherwise 0. | |
53 | The result can be destroyed using free. */ | |
a6ff34d7 UD |
54 | extern error_t __argz_create_sep __P ((__const char *__restrict __string, |
55 | int __sep, char **__restrict __argz, | |
56 | size_t *__restrict __len)); | |
57 | extern error_t argz_create_sep __P ((__const char *__restrict __string, | |
58 | int __sep, char **__restrict __argz, | |
59 | size_t *__restrict __len)); | |
392d7920 RM |
60 | |
61 | /* Returns the number of strings in ARGZ. */ | |
23396375 UD |
62 | extern size_t __argz_count __P ((__const char *__argz, size_t __len)); |
63 | extern size_t argz_count __P ((__const char *__argz, size_t __len)); | |
392d7920 RM |
64 | |
65 | /* Puts pointers to each string in ARGZ into ARGV, which must be large enough | |
66 | to hold them all. */ | |
a6ff34d7 UD |
67 | extern void __argz_extract __P ((__const char *__restrict __argz, size_t __len, |
68 | char **__restrict __argv)); | |
69 | extern void argz_extract __P ((__const char *__restrict __argz, size_t __len, | |
70 | char **__restrict __argv)); | |
392d7920 RM |
71 | |
72 | /* Make '\0' separated arg vector ARGZ printable by converting all the '\0's | |
73 | except the last into the character SEP. */ | |
23396375 UD |
74 | extern void __argz_stringify __P ((char *__argz, size_t __len, int __sep)); |
75 | extern void argz_stringify __P ((char *__argz, size_t __len, int __sep)); | |
392d7920 RM |
76 | |
77 | /* Append BUF, of length BUF_LEN to the argz vector in ARGZ & ARGZ_LEN. */ | |
a6ff34d7 UD |
78 | extern error_t __argz_append __P ((char **__restrict __argz, |
79 | size_t *__restrict __argz_len, | |
80 | __const char *__restrict __buf, | |
81 | size_t _buf_len)); | |
82 | extern error_t argz_append __P ((char **__restrict __argz, | |
83 | size_t *__restrict __argz_len, | |
84 | __const char *__restrict __buf, | |
85 | size_t __buf_len)); | |
392d7920 RM |
86 | |
87 | /* Append STR to the argz vector in ARGZ & ARGZ_LEN. */ | |
a6ff34d7 UD |
88 | extern error_t __argz_add __P ((char **__restrict __argz, |
89 | size_t *__restrict __argz_len, | |
90 | __const char *__restrict __str)); | |
91 | extern error_t argz_add __P ((char **__restrict __argz, | |
92 | size_t *__restrict __argz_len, | |
93 | __const char *__restrict __str)); | |
392d7920 | 94 | |
e4cf5070 UD |
95 | /* Append SEP separated list in STRING to the argz vector in ARGZ & |
96 | ARGZ_LEN. */ | |
a6ff34d7 UD |
97 | extern error_t __argz_add_sep __P ((char **__restrict __argz, |
98 | size_t *__restrict __argz_len, | |
99 | __const char *__restrict __string, | |
100 | int __delim)); | |
101 | extern error_t argz_add_sep __P ((char **__restrict __argz, | |
102 | size_t *__restrict __argz_len, | |
103 | __const char *__restrict __string, | |
104 | int __delim)); | |
e4cf5070 | 105 | |
392d7920 | 106 | /* Delete ENTRY from ARGZ & ARGZ_LEN, if it appears there. */ |
a6ff34d7 UD |
107 | extern void __argz_delete __P ((char **__restrict __argz, |
108 | size_t *__restrict __argz_len, | |
109 | char *__restrict __entry)); | |
110 | extern void argz_delete __P ((char **__restrict __argz, | |
111 | size_t *__restrict __argz_len, | |
112 | char *__restrict __entry)); | |
392d7920 RM |
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. */ | |
a6ff34d7 UD |
120 | extern error_t __argz_insert __P ((char **__restrict __argz, |
121 | size_t *__restrict __argz_len, | |
122 | char *__restrict __before, | |
123 | __const char *__restrict __entry)); | |
124 | extern error_t argz_insert __P ((char **__restrict __argz, | |
125 | size_t *__restrict __argz_len, | |
126 | char *__restrict __before, | |
127 | __const char *__restrict __entry)); | |
d705269e UD |
128 | |
129 | /* Replace any occurances 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. */ | |
a6ff34d7 UD |
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); | |
392d7920 RM |
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; | |
7a12c6bb | 148 | while ((entry = argz_next (argz, argz_len, entry))) |
392d7920 RM |
149 | ...; |
150 | ||
151 | or | |
152 | ||
153 | char *entry; | |
154 | for (entry = argz; entry; entry = argz_next (argz, argz_len, entry)) | |
155 | ...; | |
156 | */ | |
a6ff34d7 UD |
157 | extern char *__argz_next __P ((__const char *__restrict __argz, |
158 | size_t __argz_len, | |
159 | __const char *__restrict __entry)); | |
160 | extern char *argz_next __P ((__const char *__restrict __argz, | |
161 | size_t __argz_len, | |
162 | __const char *__restrict __entry)); | |
7a12c6bb | 163 | |
0c6cee5d | 164 | #ifdef __USE_EXTERN_INLINES |
392d7920 | 165 | extern inline char * |
99e46354 UD |
166 | __argz_next (__const char *__argz, size_t __argz_len, |
167 | __const char *__entry) __THROW | |
392d7920 | 168 | { |
23396375 | 169 | if (__entry) |
7a12c6bb | 170 | { |
23396375 UD |
171 | if (__entry < __argz + __argz_len) |
172 | __entry = strchr (__entry, '\0') + 1; | |
7a12c6bb | 173 | |
2604afb1 | 174 | return __entry >= __argz + __argz_len ? (char *) NULL : (char *) __entry; |
7a12c6bb | 175 | } |
392d7920 | 176 | else |
62ee0979 | 177 | return __argz_len > 0 ? (char *) __argz : 0; |
392d7920 | 178 | } |
7a12c6bb | 179 | extern inline char * |
99e46354 UD |
180 | argz_next (__const char *__argz, size_t __argz_len, |
181 | __const char *__entry) __THROW | |
7a12c6bb | 182 | { |
23396375 | 183 | return __argz_next (__argz, __argz_len, __entry); |
7a12c6bb | 184 | } |
0c6cee5d | 185 | #endif /* Use extern inlines. */ |
392d7920 | 186 | |
92f1da4d UD |
187 | __END_DECLS |
188 | ||
2c6fe0bd | 189 | #endif /* argz.h */ |