newlib-cygwin/newlib/libc/string/strtok.c

102 lines
3.0 KiB
C
Raw Normal View History

2000-02-18 03:39:52 +08:00
/*
FUNCTION
<<strtok>>,<<strtok_r>>,<<strsep>>---get next token from a string
2000-02-18 03:39:52 +08:00
INDEX
strtok
INDEX
strtok_r
INDEX
strsep
2000-02-18 03:39:52 +08:00
ANSI_SYNOPSIS
#include <string.h>
char *strtok(char *<[source]>, const char *<[delimiters]>)
char *strtok_r(char *<[source]>, const char *<[delimiters]>,
char **<[lasts]>)
char *strsep(char **<[source_ptr]>, const char *<[delimiters]>)
2000-02-18 03:39:52 +08:00
TRAD_SYNOPSIS
#include <string.h>
char *strtok(<[source]>, <[delimiters]>)
char *<[source]>;
char *<[delimiters]>;
char *strtok_r(<[source]>, <[delimiters]>, <[lasts]>)
char *<[source]>;
char *<[delimiters]>;
char **<[lasts]>;
char *strsep(<[source_ptr]>, <[delimiters]>)
char **<[source_ptr]>;
char *<[delimiters]>;
2000-02-18 03:39:52 +08:00
DESCRIPTION
The <<strtok>> function is used to isolate sequential tokens in a
null-terminated string, <<*<[source]>>>. These tokens are delimited
in the string by at least one of the characters in <<*<[delimiters]>>>.
The first time that <<strtok>> is called, <<*<[source]>>> should be
specified; subsequent calls, wishing to obtain further tokens from
the same string, should pass a null pointer instead. The separator
string, <<*<[delimiters]>>>, must be supplied each time, and may
change between calls.
The <<strtok>> function returns a pointer to the beginning of each
subsequent token in the string, after replacing the separator
character itself with a NUL character. When no more tokens remain,
a null pointer is returned.
The <<strtok_r>> function has the same behavior as <<strtok>>, except
a pointer to placeholder <<*[lasts]>> must be supplied by the caller.
The <<strsep>> function is similar in behavior to <<strtok>>, except
a pointer to the string pointer must be supplied <<[source_ptr]>> and
the function does not skip leading delimeters. When the string starts
with a delimeter, the delimeter is changed to the NUL character and
the empty string is returned. Like <<strtok_r>> and <<strtok>>, the
<<*[source_ptr]>> is updated to the next character following the
last delimeter found or NULL if the end of string is reached with
no more delimeters.
2000-02-18 03:39:52 +08:00
RETURNS
<<strtok>>, <<strtok_r>>, and <<strsep>> all return a pointer to the
next token, or <<NULL>> if no more tokens can be found. For
<<strsep>>, a token may be the empty string.
2000-02-18 03:39:52 +08:00
NOTES
<<strtok>> is unsafe for multi-thread applications. <<strtok_r>>
and <<strsep>> are MT-Safe and should be used instead.
2000-02-18 03:39:52 +08:00
PORTABILITY
<<strtok>> is ANSI C.
<<strtok_r>> is POSIX.
<<strsep>> is a BSD-extension.
2000-02-18 03:39:52 +08:00
<<strtok>>, <<strtok_r>>, and <<strsep>> require no supporting OS subroutines.
2000-02-18 03:39:52 +08:00
QUICKREF
strtok ansi impure
*/
/* undef STRICT_ANSI so that strtok_r prototype will be defined */
#undef __STRICT_ANSI__
2000-02-18 03:39:52 +08:00
#include <string.h>
#include <_ansi.h>
#include <reent.h>
#ifndef _REENT_ONLY
extern char *__strtok_r (char *, const char *, char **, int);
2000-02-18 03:39:52 +08:00
char *
_DEFUN (strtok, (s, delim),
register char *s _AND
register const char *delim)
{
_REENT_CHECK_MISC(_REENT);
return __strtok_r (s, delim, &(_REENT_STRTOK_LAST(_REENT)), 1);
2000-02-18 03:39:52 +08:00
}
#endif