mirror of
https://sourceware.org/git/glibc.git
synced 2024-11-27 15:30:07 +00:00
e656498ea9
2000-05-17 Andreas Jaeger <aj@suse.de> * string/envz.h: Add pure attributes if possible. * string/argz.h: argz_count is a pure function. * string/strings.h: Add pure and const attributes if possible.
187 lines
7.1 KiB
C
187 lines
7.1 KiB
C
/* Routines for dealing with '\0' separated arg vectors.
|
||
Copyright (C) 1995, 96, 97, 98, 99, 2000 Free Software Foundation, Inc.
|
||
|
||
The GNU C Library is free software; you can redistribute it and/or
|
||
modify it under the terms of the GNU Library General Public License as
|
||
published by the Free Software Foundation; either version 2 of the
|
||
License, or (at your option) any later version.
|
||
|
||
The GNU C Library is distributed in the hope that it will be useful,
|
||
but WITHOUT ANY WARRANTY; without even the implied warranty of
|
||
MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU
|
||
Library General Public License for more details.
|
||
|
||
You should have received a copy of the GNU Library General Public
|
||
License along with the GNU C Library; see the file COPYING.LIB. If not,
|
||
write to the Free Software Foundation, Inc., 59 Temple Place - Suite 330,
|
||
Boston, MA 02111-1307, USA. */
|
||
|
||
#ifndef _ARGZ_H
|
||
#define _ARGZ_H 1
|
||
|
||
#include <features.h>
|
||
|
||
#define __need_error_t
|
||
#include <errno.h>
|
||
#include <string.h> /* Need size_t, and strchr is called below. */
|
||
|
||
#ifndef __const
|
||
# define __const const
|
||
#endif
|
||
|
||
#ifndef __error_t_defined
|
||
typedef int error_t;
|
||
#endif
|
||
|
||
|
||
__BEGIN_DECLS
|
||
|
||
/* Make a '\0' separated arg vector from a unix argv vector, returning it in
|
||
ARGZ, and the total length in LEN. If a memory allocation error occurs,
|
||
ENOMEM is returned, otherwise 0. The result can be destroyed using free. */
|
||
extern error_t __argz_create (char *__const __argv[], char **__restrict __argz,
|
||
size_t *__restrict __len) __THROW;
|
||
extern error_t argz_create (char *__const __argv[], char **__restrict __argz,
|
||
size_t *__restrict __len) __THROW;
|
||
|
||
/* Make a '\0' separated arg vector from a SEP separated list in
|
||
STRING, returning it in ARGZ, and the total length in LEN. If a
|
||
memory allocation error occurs, ENOMEM is returned, otherwise 0.
|
||
The result can be destroyed using free. */
|
||
extern error_t __argz_create_sep (__const char *__restrict __string,
|
||
int __sep, char **__restrict __argz,
|
||
size_t *__restrict __len) __THROW;
|
||
extern error_t argz_create_sep (__const char *__restrict __string,
|
||
int __sep, char **__restrict __argz,
|
||
size_t *__restrict __len) __THROW;
|
||
|
||
/* Returns the number of strings in ARGZ. */
|
||
extern size_t __argz_count (__const char *__argz, size_t __len)
|
||
__THROW __attribute_pure__;
|
||
extern size_t argz_count (__const char *__argz, size_t __len)
|
||
__THROW __attribute_pure__;
|
||
|
||
/* Puts pointers to each string in ARGZ into ARGV, which must be large enough
|
||
to hold them all. */
|
||
extern void __argz_extract (__const char *__restrict __argz, size_t __len,
|
||
char **__restrict __argv) __THROW;
|
||
extern void argz_extract (__const char *__restrict __argz, size_t __len,
|
||
char **__restrict __argv) __THROW;
|
||
|
||
/* Make '\0' separated arg vector ARGZ printable by converting all the '\0's
|
||
except the last into the character SEP. */
|
||
extern void __argz_stringify (char *__argz, size_t __len, int __sep) __THROW;
|
||
extern void argz_stringify (char *__argz, size_t __len, int __sep) __THROW;
|
||
|
||
/* Append BUF, of length BUF_LEN to the argz vector in ARGZ & ARGZ_LEN. */
|
||
extern error_t __argz_append (char **__restrict __argz,
|
||
size_t *__restrict __argz_len,
|
||
__const char *__restrict __buf, size_t _buf_len)
|
||
__THROW;
|
||
extern error_t argz_append (char **__restrict __argz,
|
||
size_t *__restrict __argz_len,
|
||
__const char *__restrict __buf, size_t __buf_len)
|
||
__THROW;
|
||
|
||
/* Append STR to the argz vector in ARGZ & ARGZ_LEN. */
|
||
extern error_t __argz_add (char **__restrict __argz,
|
||
size_t *__restrict __argz_len,
|
||
__const char *__restrict __str) __THROW;
|
||
extern error_t argz_add (char **__restrict __argz,
|
||
size_t *__restrict __argz_len,
|
||
__const char *__restrict __str) __THROW;
|
||
|
||
/* Append SEP separated list in STRING to the argz vector in ARGZ &
|
||
ARGZ_LEN. */
|
||
extern error_t __argz_add_sep (char **__restrict __argz,
|
||
size_t *__restrict __argz_len,
|
||
__const char *__restrict __string, int __delim)
|
||
__THROW;
|
||
extern error_t argz_add_sep (char **__restrict __argz,
|
||
size_t *__restrict __argz_len,
|
||
__const char *__restrict __string, int __delim)
|
||
__THROW;
|
||
|
||
/* Delete ENTRY from ARGZ & ARGZ_LEN, if it appears there. */
|
||
extern void __argz_delete (char **__restrict __argz,
|
||
size_t *__restrict __argz_len,
|
||
char *__restrict __entry) __THROW;
|
||
extern void argz_delete (char **__restrict __argz,
|
||
size_t *__restrict __argz_len,
|
||
char *__restrict __entry) __THROW;
|
||
|
||
/* Insert ENTRY into ARGZ & ARGZ_LEN before BEFORE, which should be an
|
||
existing entry in ARGZ; if BEFORE is NULL, ENTRY is appended to the end.
|
||
Since ARGZ's first entry is the same as ARGZ, argz_insert (ARGZ, ARGZ_LEN,
|
||
ARGZ, ENTRY) will insert ENTRY at the beginning of ARGZ. If BEFORE is not
|
||
in ARGZ, EINVAL is returned, else if memory can't be allocated for the new
|
||
ARGZ, ENOMEM is returned, else 0. */
|
||
extern error_t __argz_insert (char **__restrict __argz,
|
||
size_t *__restrict __argz_len,
|
||
char *__restrict __before,
|
||
__const char *__restrict __entry) __THROW;
|
||
extern error_t argz_insert (char **__restrict __argz,
|
||
size_t *__restrict __argz_len,
|
||
char *__restrict __before,
|
||
__const char *__restrict __entry) __THROW;
|
||
|
||
/* Replace any occurrences of the string STR in ARGZ with WITH, reallocating
|
||
ARGZ as necessary. If REPLACE_COUNT is non-zero, *REPLACE_COUNT will be
|
||
incremented by number of replacements performed. */
|
||
extern error_t __argz_replace (char **__restrict __argz,
|
||
size_t *__restrict __argz_len,
|
||
__const char *__restrict __str,
|
||
__const char *__restrict __with,
|
||
unsigned int *__restrict __replace_count);
|
||
extern error_t argz_replace (char **__restrict __argz,
|
||
size_t *__restrict __argz_len,
|
||
__const char *__restrict __str,
|
||
__const char *__restrict __with,
|
||
unsigned int *__restrict __replace_count);
|
||
|
||
/* Returns the next entry in ARGZ & ARGZ_LEN after ENTRY, or NULL if there
|
||
are no more. If entry is NULL, then the first entry is returned. This
|
||
behavior allows two convenient iteration styles:
|
||
|
||
char *entry = 0;
|
||
while ((entry = argz_next (argz, argz_len, entry)))
|
||
...;
|
||
|
||
or
|
||
|
||
char *entry;
|
||
for (entry = argz; entry; entry = argz_next (argz, argz_len, entry))
|
||
...;
|
||
*/
|
||
extern char *__argz_next (__const char *__restrict __argz, size_t __argz_len,
|
||
__const char *__restrict __entry) __THROW;
|
||
extern char *argz_next (__const char *__restrict __argz, size_t __argz_len,
|
||
__const char *__restrict __entry) __THROW;
|
||
|
||
#ifdef __USE_EXTERN_INLINES
|
||
extern inline char *
|
||
__argz_next (__const char *__argz, size_t __argz_len,
|
||
__const char *__entry) __THROW
|
||
{
|
||
if (__entry)
|
||
{
|
||
if (__entry < __argz + __argz_len)
|
||
__entry = strchr (__entry, '\0') + 1;
|
||
|
||
return __entry >= __argz + __argz_len ? (char *) NULL : (char *) __entry;
|
||
}
|
||
else
|
||
return __argz_len > 0 ? (char *) __argz : 0;
|
||
}
|
||
extern inline char *
|
||
argz_next (__const char *__argz, size_t __argz_len,
|
||
__const char *__entry) __THROW
|
||
{
|
||
return __argz_next (__argz, __argz_len, __entry);
|
||
}
|
||
#endif /* Use extern inlines. */
|
||
|
||
__END_DECLS
|
||
|
||
#endif /* argz.h */
|