binutils-gdb/libiberty/functions.texi

966 lines
34 KiB
Plaintext
Raw Normal View History

2001-09-27 02:45:50 +08:00
@c Automatically generated from *.c and others (the comments before
@c each entry tell you which file and where in that file). DO NOT EDIT!
@c Edit the *.c files, configure with --enable-maintainer-mode,
@c and let gather-docs build you a new copy.
@c alloca.c:26
2001-10-08 06:42:23 +08:00
@deftypefn Replacement void* alloca (size_t @var{size})
2001-09-27 02:45:50 +08:00
This function allocates memory which will be automatically reclaimed
after the procedure exits. The @libib{} implementation does not free
the memory immediately but will do so eventually during subsequent
calls to this function. Memory is allocated using @code{xmalloc} under
normal circumstances.
The header file @file{alloca-conf.h} can be used in conjunction with the
GNU Autoconf test @code{AC_FUNC_ALLOCA} to test for and properly make
available this function. The @code{AC_FUNC_ALLOCA} test requires that
client code use a block of preprocessor code to be safe (see the Autoconf
manual for more); this header incorporates that logic and more, including
2001-10-08 06:42:23 +08:00
the possibility of a GCC built-in function.
2001-09-27 02:45:50 +08:00
@end deftypefn
2001-10-16 10:55:31 +08:00
@c asprintf.c:33
2001-10-18 06:35:28 +08:00
@deftypefn Extension int asprintf (char **@var{resptr}, const char *@var{format}, ...)
2001-10-16 10:55:31 +08:00
Like @code{sprintf}, but instead of passing a pointer to a buffer, you
pass a pointer to a pointer. This function will compute the size of
the buffer needed, allocate memory with @code{malloc}, and store a
pointer to the allocated memory in @code{*@var{resptr}}. The value
returned is the same as @code{sprintf} would return. If memory could
not be allocated, zero is returned and @code{NULL} is stored in
@code{*@var{resptr}}.
@end deftypefn
2001-09-27 02:45:50 +08:00
@c atexit.c:6
@deftypefn Supplemental int atexit (void (*@var{f})())
Causes function @var{f} to be called at exit. Returns 0.
@end deftypefn
@c basename.c:6
@deftypefn Supplemental char* basename (const char *@var{name})
Returns a pointer to the last component of pathname @var{name}.
Behavior is undefined if the pathname ends in a directory separator.
@end deftypefn
@c bcmp.c:6
@deftypefn Supplemental int bcmp (char *@var{x}, char *@var{y}, int @var{count})
Compares the first @var{count} bytes of two areas of memory. Returns
2001-10-10 08:05:13 +08:00
zero if they are the same, nonzero otherwise. Returns zero if
@var{count} is zero. A nonzero result only indicates a difference,
2001-09-27 02:45:50 +08:00
it does not indicate any sorting order (say, by having a positive
result mean @var{x} sorts before @var{y}).
@end deftypefn
@c bcopy.c:3
@deftypefn Supplemental void bcopy (char *@var{in}, char *@var{out}, int @var{length})
Copies @var{length} bytes from memory region @var{in} to region
@var{out}. The use of @code{bcopy} is deprecated in new programs.
@end deftypefn
@c bsearch.c:33
@deftypefn Supplemental void* bsearch (const void *@var{key}, const void *@var{base}, size_t @var{nmemb}, size_t @var{size}, int (*@var{compar})(const void *, const void *))
Performs a search over an array of @var{nmemb} elements pointed to by
@var{base} for a member that matches the object pointed to by @var{key}.
The size of each member is specified by @var{size}. The array contents
should be sorted in ascending order according to the @var{compar}
comparison function. This routine should take two arguments pointing to
the @var{key} and to an array member, in that order, and should return an
integer less than, equal to, or greater than zero if the @var{key} object
2001-09-28 04:27:58 +08:00
is respectively less than, matching, or greater than the array member.
2001-09-27 02:45:50 +08:00
@end deftypefn
2001-10-16 10:55:31 +08:00
@c argv.c:139
@deftypefn Extension char** buildargv (char *@var{sp})
Given a pointer to a string, parse the string extracting fields
separated by whitespace and optionally enclosed within either single
or double quotes (which are stripped off), and build a vector of
pointers to copies of the string for each field. The input string
remains unchanged. The last element of the vector is followed by a
@code{NULL} element.
All of the memory for the pointer array and copies of the string
is obtained from @code{malloc}. All of the memory can be returned to the
system with the single function call @code{freeargv}, which takes the
returned result of @code{buildargv}, as it's argument.
2001-10-18 06:35:28 +08:00
Returns a pointer to the argument vector if successful. Returns
2001-10-16 10:55:31 +08:00
@code{NULL} if @var{sp} is @code{NULL} or if there is insufficient
memory to complete building the argument vector.
If the input is a null string (as opposed to a @code{NULL} pointer),
then buildarg returns an argument vector that has one arg, a null
string.
@end deftypefn
2001-09-27 02:45:50 +08:00
@c bzero.c:6
@deftypefn Supplemental void bzero (char *@var{mem}, int @var{count})
2001-09-28 04:27:58 +08:00
Zeros @var{count} bytes starting at @var{mem}. Use of this function
2001-09-27 02:45:50 +08:00
is deprecated in favor of @code{memset}.
@end deftypefn
@c calloc.c:6
@deftypefn Supplemental void* calloc (size_t @var{nelem}, size_t @var{elsize})
Uses @code{malloc} to allocate storage for @var{nelem} objects of
@var{elsize} bytes each, then zeros the memory.
@end deftypefn
2001-10-16 10:55:31 +08:00
@c choose-temp.c:42
2001-10-18 06:35:28 +08:00
@deftypefn Extension char* choose_temp_base (void)
2001-10-16 10:55:31 +08:00
Return a prefix for temporary file names or @code{NULL} if unable to
find one. The current directory is chosen if all else fails so the
program is exited if a temporary directory can't be found (@code{mktemp}
fails). The buffer for the result is obtained with @code{xmalloc}.
This function is provided for backwards compatability only. Its use is
not recommended.
@end deftypefn
@c make-temp-file.c:88
@deftypefn Replacement char* choose_tmpdir ()
Returns a pointer to a directory path suitable for creating temporary
files in.
@end deftypefn
2001-09-27 02:45:50 +08:00
@c clock.c:27
2001-10-08 06:42:23 +08:00
@deftypefn Supplemental long clock (void)
2001-09-27 02:45:50 +08:00
Returns an approximation of the CPU time used by the process as a
@code{clock_t}; divide this number by @samp{CLOCKS_PER_SEC} to get the
number of seconds used.
@end deftypefn
2001-10-16 10:55:31 +08:00
@c concat.c:24
2001-10-18 06:35:28 +08:00
@deftypefn Extension char* concat (const char *@var{s1}, const char *@var{s2}, @dots{}, @code{NULL})
2001-10-16 10:55:31 +08:00
Concatenate zero or more of strings and return the result in freshly
2001-10-18 06:35:28 +08:00
@code{xmalloc}ed memory. Returns @code{NULL} if insufficient memory is
2001-10-16 10:55:31 +08:00
available. The argument list is terminated by the first @code{NULL}
pointer encountered. Pointers to empty strings are ignored.
@end deftypefn
@c argv.c:65
@deftypefn Extension char** dupargv (char **@var{vector})
Duplicate an argument vector. Simply scans through @var{vector},
duplicating each argument until the terminating @code{NULL} is found.
2001-10-18 06:35:28 +08:00
Returns a pointer to the argument vector if successful. Returns
2001-10-16 10:55:31 +08:00
@code{NULL} if there is insufficient memory to complete building the
argument vector.
@end deftypefn
2001-09-27 02:45:50 +08:00
@c strerror.c:566
2001-10-16 10:55:31 +08:00
@deftypefn Extension int errno_max (void)
2001-09-27 02:45:50 +08:00
Returns the maximum @code{errno} value for which a corresponding
symbolic name or message is available. Note that in the case where we
use the @code{sys_errlist} supplied by the system, it is possible for
there to be more symbolic names than messages, or vice versa. In
fact, the manual page for @code{perror(3C)} explicitly warns that one
should check the size of the table (@code{sys_nerr}) before indexing
it, since new error codes may be added to the system before they are
added to the table. Thus @code{sys_nerr} might be smaller than value
2001-10-08 06:42:23 +08:00
implied by the largest @code{errno} value defined in @code{<errno.h>}.
2001-09-27 02:45:50 +08:00
We return the maximum value that can be used to obtain a meaningful
symbolic name or message.
@end deftypefn
2001-10-16 10:55:31 +08:00
@c fdmatch.c:23
@deftypefn Extension int fdmatch (int @var{fd1}, int @var{fd2})
Check to see if two open file descriptors refer to the same file.
This is useful, for example, when we have an open file descriptor for
an unnamed file, and the name of a file that we believe to correspond
to that fd. This can happen when we are exec'd with an already open
file (@code{stdout} for example) or from the SVR4 @file{/proc} calls
that return open file descriptors for mapped address spaces. All we
have to do is open the file by name and check the two file descriptors
for a match, which is done by comparing major and minor device numbers
and inode numbers.
@end deftypefn
@c ffs.c:3
@deftypefn Supplemental int ffs (int @var{valu})
2001-10-18 06:35:28 +08:00
Find the first (least significant) bit set in @var{valu}. Bits are
2001-10-16 10:55:31 +08:00
numbered from right to left, starting with bit 1 (corresponding to the
value 1). If @var{valu} is zero, zero is returned.
@end deftypefn
@c fnmatch.txh:1
@deftypefn Replacement int fnmatch (const char *@var{pattern}, const char *@var{string}, int @var{flags})
Matches @var{string} against @var{pattern}, returning zero if it
matches, @code{FNM_NOMATCH} if not. @var{pattern} may contain the
wildcards @code{?} to match any one character, @code{*} to match any
zero or more characters, or a set of alternate characters in square
brackets, like @samp{[a-gt8]}, which match one character (@code{a}
through @code{g}, or @code{t}, or @code{8}, in this example) if that one
2001-10-18 06:35:28 +08:00
character is in the set. A set may be inverted (i.e., match anything
2001-10-16 10:55:31 +08:00
except what's in the set) by giving @code{^} or @code{!} as the first
character in the set. To include those characters in the set, list them
as anything other than the first character of the set. To include a
dash in the set, list it last in the set. A backslash character makes
the following character not special, so for example you could match
against a literal asterisk with @samp{\*}. To match a literal
backslash, use @samp{\\}.
@code{flags} controls various aspects of the matching process, and is a
boolean OR of zero or more of the following values (defined in
2001-10-18 06:35:28 +08:00
@code{<fnmatch.h>}):
2001-10-16 10:55:31 +08:00
@table @code
@item FNM_PATHNAME
@itemx FNM_FILE_NAME
@var{string} is assumed to be a path name. No wildcard will ever match
@code{/}.
@item FNM_NOESCAPE
Do not interpret backslashes as quoting the following special character.
@item FNM_PERIOD
A leading period (at the beginning of @var{string}, or if
@code{FNM_PATHNAME} after a slash) is not matched by @code{*} or
@code{?} but must be matched explicitly.
@item FNM_LEADING_DIR
Means that @var{string} also matches @var{pattern} if some initial part
of @var{string} matches, and is followed by @code{/} and zero or more
characters. For example, @samp{foo*} would match either @samp{foobar}
or @samp{foobar/grill}.
@item FNM_CASEFOLD
Ignores case when performing the comparison.
@end table
@end deftypefn
@c argv.c:111
@deftypefn Extension void freeargv (char **@var{vector})
Free an argument vector that was built using @code{buildargv}. Simply
scans through @var{vector}, freeing the memory for each argument until
the terminating @code{NULL} is found, and then frees @var{vector}
itself.
@end deftypefn
@c getruntime.c:78
2001-10-18 06:35:28 +08:00
@deftypefn Replacement long get_run_time (void)
2001-10-16 10:55:31 +08:00
Returns the time used so far, in microseconds. If possible, this is
the time used by this process, else it is the elapsed time since the
process started.
@end deftypefn
2001-09-27 02:45:50 +08:00
@c getcwd.c:6
2001-10-08 06:42:23 +08:00
@deftypefn Supplemental char* getcwd (char *@var{pathname}, int @var{len})
2001-09-27 02:45:50 +08:00
Copy the absolute pathname for the current working directory into
@var{pathname}, which is assumed to point to a buffer of at least
@var{len} bytes, and return a pointer to the buffer. If the current
directory's path doesn't fit in @var{len} characters, the result is
2001-10-08 06:42:23 +08:00
@code{NULL} and @code{errno} is set. If @var{pathname} is a null pointer,
2001-09-27 02:45:50 +08:00
@code{getcwd} will obtain @var{len} bytes of space using
@code{malloc}.
@end deftypefn
@c getpagesize.c:5
2001-10-08 06:42:23 +08:00
@deftypefn Supplemental int getpagesize (void)
2001-09-27 02:45:50 +08:00
Returns the number of bytes in a page of memory. This is the
granularity of many of the system memory management routines. No
guarantee is made as to whether or not it is the same as the basic
memory management hardware page size.
@end deftypefn
@c getpwd.c:5
2001-10-08 06:42:23 +08:00
@deftypefn Supplemental char* getpwd (void)
2001-09-27 02:45:50 +08:00
Returns the current working directory. This implementation caches the
result on the assumption that the process will not call @code{chdir}
between calls to @code{getpwd}.
@end deftypefn
2002-03-28 12:06:38 +08:00
@c hex.c:25
@deftypefn Extension void hex_init (void)
Initializes the array mapping the current character set to
corresponding hex values. This function must be called before any
call to @code{hex_p} or @code{hex_value}.
@end deftypefn
@c hex.c:33
@deftypefn Extension int hex_p (int @var{c})
Evaluates to non-zero if the given character is a valid hex character,
or zero if it is not. Note that the value you pass will be cast to
@code{unsigned char} within the macro.
@end deftypefn
@c hex.c:41
@deftypefn Extension int hex_value (int @var{c})
Returns the numeric equivalent of the given character when interpreted
as a hexidecimal digit. The result is undefined if you pass an
invalid hex digit. Note that the value you pass will be cast to
@code{unsigned char} within the macro.
@end deftypefn
2001-09-27 02:45:50 +08:00
@c index.c:5
@deftypefn Supplemental char* index (char *@var{s}, int @var{c})
2001-09-28 04:27:58 +08:00
Returns a pointer to the first occurrence of the character @var{c} in
2001-10-08 06:42:23 +08:00
the string @var{s}, or @code{NULL} if not found. The use of @code{index} is
2001-09-27 02:45:50 +08:00
deprecated in new programs in favor of @code{strchr}.
@end deftypefn
2001-10-16 10:55:31 +08:00
@c insque.c:6
@deftypefn Supplemental void insque (struct qelem *@var{elem}, struct qelem *@var{pred})
@deftypefnx Supplemental void remque (struct qelem *@var{elem})
Routines to manipulate queues built from doubly linked lists. The
@code{insque} routine inserts @var{elem} in the queue immediately
after @var{pred}. The @code{remque} routine removes @var{elem} from
its containing queue. These routines expect to be passed pointers to
structures which have as their first members a forward pointer and a
back pointer, like this prototype (although no prototype is provided):
@example
struct qelem @{
struct qelem *q_forw;
struct qelem *q_back;
char q_data[];
@};
@end example
@end deftypefn
@c lbasename.c:23
@deftypefn Replacement {const char*} lbasename (const char *@var{name})
Given a pointer to a string containing a typical pathname
(@samp{/usr/src/cmd/ls/ls.c} for example), returns a pointer to the
last component of the pathname (@samp{ls.c} in this case). The
returned pointer is guaranteed to lie within the original
string. This latter fact is not true of many vendor C
libraries, which return special strings or modify the passed
strings for particular input.
In particular, the empty string returns the same empty string,
and a path ending in @code{/} returns the empty string after it.
@end deftypefn
@c make-temp-file.c:138
@deftypefn Replacement char* make_temp_file (const char *@var{suffix})
Return a temporary file name (as a string) or @code{NULL} if unable to
create one. @var{suffix} is a suffix to append to the file name. The
2001-10-18 06:35:28 +08:00
string is @code{malloc}ed, and the temporary file has been created.
2001-10-16 10:55:31 +08:00
@end deftypefn
2001-09-27 02:45:50 +08:00
@c memchr.c:3
@deftypefn Supplemental void* memchr (const void *@var{s}, int @var{c}, size_t @var{n})
2001-10-08 06:42:23 +08:00
This function searches memory starting at @code{*@var{s}} for the
2001-09-27 02:45:50 +08:00
character @var{c}. The search only ends with the first occurrence of
@var{c}, or after @var{length} characters; in particular, a null
character does not terminate the search. If the character @var{c} is
2001-10-08 06:42:23 +08:00
found within @var{length} characters of @code{*@var{s}}, a pointer
to the character is returned. If @var{c} is not found, then @code{NULL} is
2001-09-27 02:45:50 +08:00
returned.
@end deftypefn
@c memcmp.c:6
@deftypefn Supplemental int memcmp (const void *@var{x}, const void *@var{y}, size_t @var{count})
Compares the first @var{count} bytes of two areas of memory. Returns
zero if they are the same, a value less than zero if @var{x} is
lexically less than @var{y}, or a value greater than zero if @var{x}
is lexically greater than @var{y}. Note that lexical order is determined
as if comparing unsigned char arrays.
@end deftypefn
@c memcpy.c:6
@deftypefn Supplemental void* memcpy (void *@var{out}, const void *@var{in}, size_t @var{length})
Copies @var{length} bytes from memory region @var{in} to region
@var{out}. Returns a pointer to @var{out}.
@end deftypefn
@c memmove.c:6
@deftypefn Supplemental void* memmove (void *@var{from}, const void *@var{to}, size_t @var{count})
Copies @var{count} bytes from memory area @var{from} to memory area
@var{to}, returning a pointer to @var{to}.
@end deftypefn
@c memset.c:6
@deftypefn Supplemental void* memset (void *@var{s}, int @var{c}, size_t @var{count})
Sets the first @var{count} bytes of @var{s} to the constant byte
@var{c}, returning a pointer to @var{s}.
@end deftypefn
2001-10-16 10:55:31 +08:00
@c mkstemps.c:54
@deftypefn Replacement int mkstemps (char *@var{template}, int @var{suffix_len})
Generate a unique temporary file name from @var{template}.
@var{template} has the form:
@example
2001-10-18 06:35:28 +08:00
@var{path}/ccXXXXXX@var{suffix}
2001-10-16 10:55:31 +08:00
@end example
2001-10-18 06:35:28 +08:00
@var{suffix_len} tells us how long @var{suffix} is (it can be zero
length). The last six characters of @var{template} before @var{suffix}
must be @samp{XXXXXX}; they are replaced with a string that makes the
2001-10-16 10:55:31 +08:00
filename unique. Returns a file descriptor open on the file for
reading and writing.
@end deftypefn
@c pexecute.c:67
@deftypefn Extension int pexecute (const char *@var{program}, char * const *@var{argv}, const char *@var{this_pname}, const char *@var{temp_base}, char **@var{errmsg_fmt}, char **@var{errmsg_arg}, int flags)
Executes a program.
@var{program} and @var{argv} are the arguments to
@code{execv}/@code{execvp}.
2001-10-18 06:35:28 +08:00
@var{this_pname} is name of the calling program (i.e., @code{argv[0]}).
2001-10-16 10:55:31 +08:00
@var{temp_base} is the path name, sans suffix, of a temporary file to
use if needed. This is currently only needed for MS-DOS ports that
don't use @code{go32} (do any still exist?). Ports that don't need it
can pass @code{NULL}.
2001-10-18 06:35:28 +08:00
(@code{@var{flags} & PEXECUTE_SEARCH}) is non-zero if @env{PATH} should be searched
(??? It's not clear that GCC passes this flag correctly). (@code{@var{flags} &
PEXECUTE_FIRST}) is nonzero for the first process in chain.
(@code{@var{flags} & PEXECUTE_FIRST}) is nonzero for the last process
2001-10-16 10:55:31 +08:00
in chain. The first/last flags could be simplified to only mark the
last of a chain of processes but that requires the caller to always
mark the last one (and not give up early if some error occurs).
It's more robust to require the caller to mark both ends of the chain.
The result is the pid on systems like Unix where we
@code{fork}/@code{exec} and on systems like WIN32 and OS/2 where we
use @code{spawn}. It is up to the caller to wait for the child.
2001-10-18 06:35:28 +08:00
The result is the @code{WEXITSTATUS} on systems like MS-DOS where we
2001-10-16 10:55:31 +08:00
@code{spawn} and wait for the child here.
Upon failure, @var{errmsg_fmt} and @var{errmsg_arg} are set to the
text of the error message with an optional argument (if not needed,
2001-10-18 06:35:28 +08:00
@var{errmsg_arg} is set to @code{NULL}), and @minus{}1 is returned.
2001-10-16 10:55:31 +08:00
@code{errno} is available to the caller to use.
@end deftypefn
@c strsignal.c:547
@deftypefn Supplemental void psignal (unsigned @var{signo}, char *@var{message})
Print @var{message} to the standard error, followed by a colon,
followed by the description of the signal specified by @var{signo},
followed by a newline.
@end deftypefn
2001-09-27 02:45:50 +08:00
@c putenv.c:21
@deftypefn Supplemental int putenv (const char *@var{string})
Uses @code{setenv} or @code{unsetenv} to put @var{string} into
the environment or remove it. If @var{string} is of the form
2001-10-08 06:42:23 +08:00
@samp{name=value} the string is added; if no @samp{=} is present the
2001-09-27 02:45:50 +08:00
name is unset/removed.
@end deftypefn
2001-10-16 10:55:31 +08:00
@c pexecute.c:104
@deftypefn Extension int pwait (int @var{pid}, int *@var{status}, int @var{flags})
Waits for a program started by @code{pexecute} to finish.
@var{pid} is the process id of the task to wait for. @var{status} is
the `status' argument to wait. @var{flags} is currently unused (allows
future enhancement without breaking upward compatibility). Pass 0 for now.
The result is the pid of the child reaped, or -1 for failure
(@code{errno} says why).
On systems that don't support waiting for a particular child, @var{pid} is
ignored. On systems like MS-DOS that don't really multitask @code{pwait}
is just a mechanism to provide a consistent interface for the caller.
@end deftypefn
@c random.c:39
2001-10-18 06:35:28 +08:00
@deftypefn Supplement {long int} random (void)
2001-10-16 10:55:31 +08:00
@deftypefnx Supplement void srandom (unsigned int @var{seed})
@deftypefnx Supplement void* initstate (unsigned int @var{seed}, void *@var{arg_state}, unsigned long @var{n})
@deftypefnx Supplement void* setstate (void *@var{arg_state})
Random number functions. @code{random} returns a random number in the
2001-10-18 06:35:28 +08:00
range 0 to @code{LONG_MAX}. @code{srandom} initializes the random
2001-10-16 10:55:31 +08:00
number generator to some starting point determined by @var{seed}
(else, the values returned by @code{random} are always the same for each
2001-10-18 06:35:28 +08:00
run of the program). @code{initstate} and @code{setstate} allow fine-grained
2001-10-16 10:55:31 +08:00
control over the state of the random number generator.
@end deftypefn
@c concat.c:177
2001-10-18 06:35:28 +08:00
@deftypefn Extension char* reconcat (char *@var{optr}, const char *@var{s1}, @dots{}, @code{NULL})
2001-10-16 10:55:31 +08:00
Same as @code{concat}, except that if @var{optr} is not @code{NULL} it
is freed after the string is created. This is intended to be useful
when you're extending an existing string or building up a string in a
loop:
@example
str = reconcat (str, "pre-", str, NULL);
@end example
@end deftypefn
2001-09-27 02:45:50 +08:00
@c rename.c:6
@deftypefn Supplemental int rename (const char *@var{old}, const char *@var{new})
Renames a file from @var{old} to @var{new}. If @var{new} already
exists, it is removed.
@end deftypefn
@c rindex.c:5
@deftypefn Supplemental char* rindex (const char *@var{s}, int @var{c})
2001-09-28 04:27:58 +08:00
Returns a pointer to the last occurrence of the character @var{c} in
2001-10-08 06:42:23 +08:00
the string @var{s}, or @code{NULL} if not found. The use of @code{rindex} is
2001-09-27 02:45:50 +08:00
deprecated in new programs in favor of @code{strrchr}.
@end deftypefn
@c setenv.c:22
@deftypefn Supplemental int setenv (const char *@var{name}, const char *@var{value}, int @var{overwrite})
@deftypefnx Supplemental void unsetenv (const char *@var{name})
@code{setenv} adds @var{name} to the environment with value
@var{value}. If the name was already present in the environment,
2001-10-10 08:05:13 +08:00
the new value will be stored only if @var{overwrite} is nonzero.
2001-09-27 02:45:50 +08:00
The companion @code{unsetenv} function removes @var{name} from the
environment. This implementation is not safe for multithreaded code.
@end deftypefn
2001-10-16 10:55:31 +08:00
@c strsignal.c:353
2001-10-18 06:35:28 +08:00
@deftypefn Extension int signo_max (void)
2001-10-16 10:55:31 +08:00
Returns the maximum signal value for which a corresponding symbolic
name or message is available. Note that in the case where we use the
@code{sys_siglist} supplied by the system, it is possible for there to
be more symbolic names than messages, or vice versa. In fact, the
manual page for @code{psignal(3b)} explicitly warns that one should
check the size of the table (@code{NSIG}) before indexing it, since
new signal codes may be added to the system before they are added to
the table. Thus @code{NSIG} might be smaller than value implied by
the largest signo value defined in @code{<signal.h>}.
We return the maximum value that can be used to obtain a meaningful
symbolic name or message.
@end deftypefn
2001-09-27 02:45:50 +08:00
@c sigsetmask.c:8
@deftypefn Supplemental int sigsetmask (int @var{set})
Sets the signal mask to the one provided in @var{set} and returns
the old mask (which, for libiberty's implementation, will always
be the value @code{1}).
@end deftypefn
2001-10-16 10:55:31 +08:00
@c spaces.c:22
@deftypefn Extension char* spaces (int @var{count})
Returns a pointer to a memory region filled with the specified
number of spaces and null terminated. The returned pointer is
valid until at least the next call.
@end deftypefn
2001-09-27 02:45:50 +08:00
@c strcasecmp.c:15
@deftypefn Supplemental int strcasecmp (const char *@var{s1}, const char *@var{s2})
A case-insensitive @code{strcmp}.
@end deftypefn
@c strchr.c:6
@deftypefn Supplemental char* strchr (const char *@var{s}, int @var{c})
2001-09-28 04:27:58 +08:00
Returns a pointer to the first occurrence of the character @var{c} in
2001-10-08 06:42:23 +08:00
the string @var{s}, or @code{NULL} if not found. If @var{c} is itself the
2001-09-27 02:45:50 +08:00
null character, the results are undefined.
@end deftypefn
@c strdup.c:3
@deftypefn Supplemental char* strdup (const char *@var{s})
Returns a pointer to a copy of @var{s} in memory obtained from
2001-10-08 06:42:23 +08:00
@code{malloc}, or @code{NULL} if insufficient memory was available.
2001-09-27 02:45:50 +08:00
@end deftypefn
@c strerror.c:670
2001-10-16 10:55:31 +08:00
@deftypefn Replacement {const char*} strerrno (int @var{errnum})
2001-09-27 02:45:50 +08:00
Given an error number returned from a system call (typically returned
in @code{errno}), returns a pointer to a string containing the
2001-10-08 06:42:23 +08:00
symbolic name of that error number, as found in @code{<errno.h>}.
2001-09-27 02:45:50 +08:00
If the supplied error number is within the valid range of indices for
symbolic names, but no name is available for the particular error
2001-10-16 10:55:31 +08:00
number, then returns the string @samp{Error @var{num}}, where @var{num}
2001-09-28 04:27:58 +08:00
is the error number.
2001-09-27 02:45:50 +08:00
If the supplied error number is not within the range of valid
2001-10-08 06:42:23 +08:00
indices, then returns @code{NULL}.
2001-09-27 02:45:50 +08:00
The contents of the location pointed to are only guaranteed to be
2001-09-28 04:27:58 +08:00
valid until the next call to @code{strerrno}.
2001-09-27 02:45:50 +08:00
@end deftypefn
@c strerror.c:602
2001-10-16 10:55:31 +08:00
@deftypefn Supplemental char* strerror (int @var{errnoval})
2001-09-27 02:45:50 +08:00
Maps an @code{errno} number to an error message string, the contents
of which are implementation defined. On systems which have the
external variables @code{sys_nerr} and @code{sys_errlist}, these
strings will be the same as the ones used by @code{perror}.
If the supplied error number is within the valid range of indices for
the @code{sys_errlist}, but no message is available for the particular
2001-10-16 10:55:31 +08:00
error number, then returns the string @samp{Error @var{num}}, where
2001-09-28 04:27:58 +08:00
@var{num} is the error number.
2001-09-27 02:45:50 +08:00
If the supplied error number is not a valid index into
2001-10-08 06:42:23 +08:00
@code{sys_errlist}, returns @code{NULL}.
2001-09-27 02:45:50 +08:00
The returned string is only guaranteed to be valid only until the
next call to @code{strerror}.
@end deftypefn
@c strncasecmp.c:15
@deftypefn Supplemental int strncasecmp (const char *@var{s1}, const char *@var{s2})
A case-insensitive @code{strncmp}.
@end deftypefn
@c strncmp.c:6
@deftypefn Supplemental int strncmp (const char *@var{s1}, const char *@var{s2}, size_t @var{n})
Compares the first @var{n} bytes of two strings, returning a value as
@code{strcmp}.
@end deftypefn
@c strrchr.c:6
@deftypefn Supplemental char* strrchr (const char *@var{s}, int @var{c})
2001-09-28 04:27:58 +08:00
Returns a pointer to the last occurrence of the character @var{c} in
2001-10-08 06:42:23 +08:00
the string @var{s}, or @code{NULL} if not found. If @var{c} is itself the
2001-09-27 02:45:50 +08:00
null character, the results are undefined.
@end deftypefn
2001-10-16 10:55:31 +08:00
@c strsignal.c:388
@deftypefn Supplemental {const char *} strsignal (int @var{signo})
Maps an signal number to an signal message string, the contents of
which are implementation defined. On systems which have the external
variable @code{sys_siglist}, these strings will be the same as the
ones used by @code{psignal()}.
If the supplied signal number is within the valid range of indices for
the @code{sys_siglist}, but no message is available for the particular
signal number, then returns the string @samp{Signal @var{num}}, where
@var{num} is the signal number.
If the supplied signal number is not a valid index into
@code{sys_siglist}, returns @code{NULL}.
The returned string is only guaranteed to be valid only until the next
call to @code{strsignal}.
@end deftypefn
@c strsignal.c:452
@deftypefn Extension {const char*} strsigno (int @var{signo})
Given an signal number, returns a pointer to a string containing the
symbolic name of that signal number, as found in @code{<signal.h>}.
If the supplied signal number is within the valid range of indices for
symbolic names, but no name is available for the particular signal
number, then returns the string @samp{Signal @var{num}}, where
@var{num} is the signal number.
If the supplied signal number is not within the range of valid
indices, then returns @code{NULL}.
The contents of the location pointed to are only guaranteed to be
valid until the next call to @code{strsigno}.
@end deftypefn
2001-09-27 02:45:50 +08:00
@c strstr.c:6
@deftypefn Supplemental char* strstr (const char *@var{string}, const char *@var{sub})
This function searches for the substring @var{sub} in the string
2001-09-28 04:27:58 +08:00
@var{string}, not including the terminating null characters. A pointer
2001-10-08 06:42:23 +08:00
to the first occurrence of @var{sub} is returned, or @code{NULL} if the
2001-09-27 02:45:50 +08:00
substring is absent. If @var{sub} points to a string with zero
length, the function returns @var{string}.
@end deftypefn
@c strtod.c:27
@deftypefn Supplemental double strtod (const char *@var{string}, char **@var{endptr})
2001-10-10 08:05:13 +08:00
This ISO C function converts the initial portion of @var{string} to a
2001-10-08 06:42:23 +08:00
@code{double}. If @var{endptr} is not @code{NULL}, a pointer to the
2001-09-27 02:45:50 +08:00
character after the last character used in the conversion is stored in
the location referenced by @var{endptr}. If no conversion is
performed, zero is returned and the value of @var{string} is stored in
the location referenced by @var{endptr}.
@end deftypefn
@c strerror.c:730
2001-10-16 10:55:31 +08:00
@deftypefn Extension int strtoerrno (const char *@var{name})
2001-09-27 02:45:50 +08:00
2001-10-08 06:42:23 +08:00
Given the symbolic name of a error number (e.g., @code{EACCES}), map it
2001-09-27 02:45:50 +08:00
to an errno value. If no translation is found, returns 0.
@end deftypefn
@c strtol.c:33
@deftypefn Supplemental {long int} strtol (const char *@var{string}, char **@var{endptr}, int @var{base})
2001-10-16 10:55:31 +08:00
@deftypefnx Supplemental {unsigned long int} strtoul (const char *@var{string}, char **@var{endptr}, int @var{base})
2001-09-27 02:45:50 +08:00
The @code{strtol} function converts the string in @var{string} to a
long integer value according to the given @var{base}, which must be
between 2 and 36 inclusive, or be the special value 0. If @var{base}
is 0, @code{strtol} will look for the prefixes @code{0} and @code{0x}
to indicate bases 8 and 16, respectively, else default to base 10.
When the base is 16 (either explicitly or implicitly), a prefix of
2001-09-28 04:27:58 +08:00
@code{0x} is allowed. The handling of @var{endptr} is as that of
2001-10-16 10:55:31 +08:00
@code{strtod} above. The @code{strtoul} function is the same, except
that the converted value is unsigned.
@end deftypefn
@c strsignal.c:507
@deftypefn Extension int strtosigno (const char *@var{name})
Given the symbolic name of a signal, map it to a signal number. If no
translation is found, returns 0.
2001-09-27 02:45:50 +08:00
@end deftypefn
@c tmpnam.c:3
@deftypefn Supplemental char* tmpnam (char *@var{s})
This function attempts to create a name for a temporary file, which
will be a valid file name yet not exist when @code{tmpnam} checks for
it. @var{s} must point to a buffer of at least @code{L_tmpnam} bytes,
2001-10-08 06:42:23 +08:00
or be @code{NULL}. Use of this function creates a security risk, and it must
2001-09-27 02:45:50 +08:00
not be used in new projects. Use @code{mkstemp} instead.
@end deftypefn
2001-10-16 10:55:31 +08:00
@c vasprintf.c:48
2001-10-18 06:35:28 +08:00
@deftypefn Extension int vasprintf (char **@var{resptr}, const char *@var{format}, va_list @var{args})
2001-10-16 10:55:31 +08:00
Like @code{vsprintf}, but instead of passing a pointer to a buffer,
you pass a pointer to a pointer. This function will compute the size
of the buffer needed, allocate memory with @code{malloc}, and store a
pointer to the allocated memory in @code{*@var{resptr}}. The value
returned is the same as @code{vsprintf} would return. If memory could
not be allocated, zero is returned and @code{NULL} is stored in
@code{*@var{resptr}}.
@end deftypefn
2001-09-27 02:45:50 +08:00
@c vfork.c:6
2001-10-08 06:42:23 +08:00
@deftypefn Supplemental int vfork (void)
2001-09-27 02:45:50 +08:00
Emulates @code{vfork} by calling @code{fork} and returning its value.
@end deftypefn
@c vprintf.c:3
@deftypefn Supplemental int vprintf (const char *@var{format}, va_list @var{ap})
@deftypefnx Supplemental int vfprintf (FILE *@var{stream}, const char *@var{format}, va_list @var{ap})
@deftypefnx Supplemental int vsprintf (char *@var{str}, const char *@var{format}, va_list @var{ap})
These functions are the same as @code{printf}, @code{fprintf}, and
@code{sprintf}, respectively, except that they are called with a
@code{va_list} instead of a variable number of arguments. Note that
they do not call @code{va_end}; this is the application's
responsibility. In @libib{} they are implemented in terms of the
nonstandard but common function @code{_doprnt}.
@end deftypefn
@c waitpid.c:3
@deftypefn Supplemental int waitpid (int @var{pid}, int *@var{status}, int)
This is a wrapper around the @code{wait} function. Any ``special''
values of @var{pid} depend on your implementation of @code{wait}, as
does the return value. The third argument is unused in @libib{}.
@end deftypefn
@c xatexit.c:11
@deftypefun int xatexit (void (*@var{fn}) (void))
Behaves as the standard @code{atexit} function, but with no limit on
2001-10-08 06:42:23 +08:00
the number of registered functions. Returns 0 on success, or @minus{}1 on
2001-09-27 02:45:50 +08:00
failure. If you use @code{xatexit} to register functions, you must use
@code{xexit} to terminate your program.
@end deftypefun
2001-09-28 04:27:58 +08:00
@c xmalloc.c:38
2001-10-08 06:42:23 +08:00
@deftypefn Replacement void* xcalloc (size_t @var{nelem}, size_t @var{elsize})
2001-09-27 02:45:50 +08:00
Allocate memory without fail, and set it to zero. This routine functions
like @code{calloc}, but will behave the same as @code{xmalloc} if memory
cannot be found.
@end deftypefn
@c xexit.c:22
@deftypefn Replacement void xexit (int @var{code})
Terminates the program. If any functions have been registered with
2001-09-28 04:27:58 +08:00
the @code{xatexit} replacement function, they will be called first.
2001-09-27 02:45:50 +08:00
Termination is handled via the system's normal @code{exit} call.
@end deftypefn
@c xmalloc.c:22
@deftypefn Replacement void* xmalloc (size_t)
Allocate memory without fail. If @code{malloc} fails, this will print
2001-09-28 04:27:58 +08:00
a message to @code{stderr} (using the name set by
@code{xmalloc_set_program_name},
2001-09-27 02:45:50 +08:00
if any) and then call @code{xexit}. Note that it is therefore safe for
a program to contain @code{#define malloc xmalloc} in its source.
@end deftypefn
2001-09-28 04:27:58 +08:00
@c xmalloc.c:53
2001-09-27 02:45:50 +08:00
@deftypefn Replacement void xmalloc_failed (size_t)
This function is not meant to be called by client code, and is listed
here for completeness only. If any of the allocation routines fail, this
function will be called to print an error message and terminate execution.
@end deftypefn
2001-09-28 04:27:58 +08:00
@c xmalloc.c:46
2001-09-27 02:45:50 +08:00
@deftypefn Replacement void xmalloc_set_program_name (const char *@var{name})
You can use this to set the name of the program used by
@code{xmalloc_failed} when printing a failure message.
@end deftypefn
@c xmemdup.c:7
@deftypefn Replacement void* xmemdup (void *@var{input}, size_t @var{copy_size}, size_t @var{alloc_size})
Duplicates a region of memory without fail. First, @var{alloc_size} bytes
are allocated, then @var{copy_size} bytes from @var{input} are copied into
it, and the new memory is returned. If fewer bytes are copied than were
allocated, the remaining memory is zeroed.
@end deftypefn
2001-09-28 04:27:58 +08:00
@c xmalloc.c:32
2001-10-08 06:42:23 +08:00
@deftypefn Replacement void* xrealloc (void *@var{ptr}, size_t @var{size})
2001-09-27 02:45:50 +08:00
Reallocate memory without fail. This routine functions like @code{realloc},
but will behave the same as @code{xmalloc} if memory cannot be found.
@end deftypefn
@c xstrdup.c:7
@deftypefn Replacement char* xstrdup (const char *@var{s})
Duplicates a character string without fail, using @code{xmalloc} to
obtain memory.
@end deftypefn
@c xstrerror.c:7
@deftypefn Replacement char* xstrerror (int @var{errnum})
Behaves exactly like the standard @code{strerror} function, but
2001-10-08 06:42:23 +08:00
will never return a @code{NULL} pointer.
2001-09-27 02:45:50 +08:00
@end deftypefn