functions.texi revision 259705
1@c Automatically generated from *.c and others (the comments before 2@c each entry tell you which file and where in that file). DO NOT EDIT! 3@c Edit the *.c files, configure with --enable-maintainer-mode, 4@c and let gather-docs build you a new copy. 5 6@c safe-ctype.c:25 7@defvr Extension HOST_CHARSET 8This macro indicates the basic character set and encoding used by the 9host: more precisely, the encoding used for character constants in 10preprocessor @samp{#if} statements (the C "execution character set"). 11It is defined by @file{safe-ctype.h}, and will be an integer constant 12with one of the following values: 13 14@ftable @code 15@item HOST_CHARSET_UNKNOWN 16The host character set is unknown - that is, not one of the next two 17possibilities. 18 19@item HOST_CHARSET_ASCII 20The host character set is ASCII. 21 22@item HOST_CHARSET_EBCDIC 23The host character set is some variant of EBCDIC. (Only one of the 24nineteen EBCDIC varying characters is tested; exercise caution.) 25@end ftable 26@end defvr 27 28@c alloca.c:26 29@deftypefn Replacement void* alloca (size_t @var{size}) 30 31This function allocates memory which will be automatically reclaimed 32after the procedure exits. The @libib{} implementation does not free 33the memory immediately but will do so eventually during subsequent 34calls to this function. Memory is allocated using @code{xmalloc} under 35normal circumstances. 36 37The header file @file{alloca-conf.h} can be used in conjunction with the 38GNU Autoconf test @code{AC_FUNC_ALLOCA} to test for and properly make 39available this function. The @code{AC_FUNC_ALLOCA} test requires that 40client code use a block of preprocessor code to be safe (see the Autoconf 41manual for more); this header incorporates that logic and more, including 42the possibility of a GCC built-in function. 43 44@end deftypefn 45 46@c asprintf.c:32 47@deftypefn Extension int asprintf (char **@var{resptr}, const char *@var{format}, ...) 48 49Like @code{sprintf}, but instead of passing a pointer to a buffer, you 50pass a pointer to a pointer. This function will compute the size of 51the buffer needed, allocate memory with @code{malloc}, and store a 52pointer to the allocated memory in @code{*@var{resptr}}. The value 53returned is the same as @code{sprintf} would return. If memory could 54not be allocated, minus one is returned and @code{NULL} is stored in 55@code{*@var{resptr}}. 56 57@end deftypefn 58 59@c atexit.c:6 60@deftypefn Supplemental int atexit (void (*@var{f})()) 61 62Causes function @var{f} to be called at exit. Returns 0. 63 64@end deftypefn 65 66@c basename.c:6 67@deftypefn Supplemental char* basename (const char *@var{name}) 68 69Returns a pointer to the last component of pathname @var{name}. 70Behavior is undefined if the pathname ends in a directory separator. 71 72@end deftypefn 73 74@c bcmp.c:6 75@deftypefn Supplemental int bcmp (char *@var{x}, char *@var{y}, int @var{count}) 76 77Compares the first @var{count} bytes of two areas of memory. Returns 78zero if they are the same, nonzero otherwise. Returns zero if 79@var{count} is zero. A nonzero result only indicates a difference, 80it does not indicate any sorting order (say, by having a positive 81result mean @var{x} sorts before @var{y}). 82 83@end deftypefn 84 85@c bcopy.c:3 86@deftypefn Supplemental void bcopy (char *@var{in}, char *@var{out}, int @var{length}) 87 88Copies @var{length} bytes from memory region @var{in} to region 89@var{out}. The use of @code{bcopy} is deprecated in new programs. 90 91@end deftypefn 92 93@c bsearch.c:33 94@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 *)) 95 96Performs a search over an array of @var{nmemb} elements pointed to by 97@var{base} for a member that matches the object pointed to by @var{key}. 98The size of each member is specified by @var{size}. The array contents 99should be sorted in ascending order according to the @var{compar} 100comparison function. This routine should take two arguments pointing to 101the @var{key} and to an array member, in that order, and should return an 102integer less than, equal to, or greater than zero if the @var{key} object 103is respectively less than, matching, or greater than the array member. 104 105@end deftypefn 106 107@c argv.c:124 108@deftypefn Extension char** buildargv (char *@var{sp}) 109 110Given a pointer to a string, parse the string extracting fields 111separated by whitespace and optionally enclosed within either single 112or double quotes (which are stripped off), and build a vector of 113pointers to copies of the string for each field. The input string 114remains unchanged. The last element of the vector is followed by a 115@code{NULL} element. 116 117All of the memory for the pointer array and copies of the string 118is obtained from @code{malloc}. All of the memory can be returned to the 119system with the single function call @code{freeargv}, which takes the 120returned result of @code{buildargv}, as it's argument. 121 122Returns a pointer to the argument vector if successful. Returns 123@code{NULL} if @var{sp} is @code{NULL} or if there is insufficient 124memory to complete building the argument vector. 125 126If the input is a null string (as opposed to a @code{NULL} pointer), 127then buildarg returns an argument vector that has one arg, a null 128string. 129 130@end deftypefn 131 132@c bzero.c:6 133@deftypefn Supplemental void bzero (char *@var{mem}, int @var{count}) 134 135Zeros @var{count} bytes starting at @var{mem}. Use of this function 136is deprecated in favor of @code{memset}. 137 138@end deftypefn 139 140@c calloc.c:6 141@deftypefn Supplemental void* calloc (size_t @var{nelem}, size_t @var{elsize}) 142 143Uses @code{malloc} to allocate storage for @var{nelem} objects of 144@var{elsize} bytes each, then zeros the memory. 145 146@end deftypefn 147 148@c choose-temp.c:42 149@deftypefn Extension char* choose_temp_base (void) 150 151Return a prefix for temporary file names or @code{NULL} if unable to 152find one. The current directory is chosen if all else fails so the 153program is exited if a temporary directory can't be found (@code{mktemp} 154fails). The buffer for the result is obtained with @code{xmalloc}. 155 156This function is provided for backwards compatability only. Its use is 157not recommended. 158 159@end deftypefn 160 161@c make-temp-file.c:87 162@deftypefn Replacement char* choose_tmpdir () 163 164Returns a pointer to a directory path suitable for creating temporary 165files in. 166 167@end deftypefn 168 169@c clock.c:27 170@deftypefn Supplemental long clock (void) 171 172Returns an approximation of the CPU time used by the process as a 173@code{clock_t}; divide this number by @samp{CLOCKS_PER_SEC} to get the 174number of seconds used. 175 176@end deftypefn 177 178@c concat.c:24 179@deftypefn Extension char* concat (const char *@var{s1}, const char *@var{s2}, @dots{}, @code{NULL}) 180 181Concatenate zero or more of strings and return the result in freshly 182@code{xmalloc}ed memory. Returns @code{NULL} if insufficient memory is 183available. The argument list is terminated by the first @code{NULL} 184pointer encountered. Pointers to empty strings are ignored. 185 186@end deftypefn 187 188@c argv.c:52 189@deftypefn Extension char** dupargv (char **@var{vector}) 190 191Duplicate an argument vector. Simply scans through @var{vector}, 192duplicating each argument until the terminating @code{NULL} is found. 193Returns a pointer to the argument vector if successful. Returns 194@code{NULL} if there is insufficient memory to complete building the 195argument vector. 196 197@end deftypefn 198 199@c strerror.c:567 200@deftypefn Extension int errno_max (void) 201 202Returns the maximum @code{errno} value for which a corresponding 203symbolic name or message is available. Note that in the case where we 204use the @code{sys_errlist} supplied by the system, it is possible for 205there to be more symbolic names than messages, or vice versa. In 206fact, the manual page for @code{perror(3C)} explicitly warns that one 207should check the size of the table (@code{sys_nerr}) before indexing 208it, since new error codes may be added to the system before they are 209added to the table. Thus @code{sys_nerr} might be smaller than value 210implied by the largest @code{errno} value defined in @code{<errno.h>}. 211 212We return the maximum value that can be used to obtain a meaningful 213symbolic name or message. 214 215@end deftypefn 216 217@c argv.c:293 218@deftypefn Extension void expandargv (int *@var{argcp}, char ***@var{argvp}) 219 220The @var{argcp} and @code{argvp} arguments are pointers to the usual 221@code{argc} and @code{argv} arguments to @code{main}. This function 222looks for arguments that begin with the character @samp{@@}. Any such 223arguments are interpreted as ``response files''. The contents of the 224response file are interpreted as additional command line options. In 225particular, the file is separated into whitespace-separated strings; 226each such string is taken as a command-line option. The new options 227are inserted in place of the option naming the response file, and 228@code{*argcp} and @code{*argvp} will be updated. If the value of 229@code{*argvp} is modified by this function, then the new value has 230been dynamically allocated and can be deallocated by the caller with 231@code{freeargv}. However, most callers will simply call 232@code{expandargv} near the beginning of @code{main} and allow the 233operating system to free the memory when the program exits. 234 235@end deftypefn 236 237@c fdmatch.c:23 238@deftypefn Extension int fdmatch (int @var{fd1}, int @var{fd2}) 239 240Check to see if two open file descriptors refer to the same file. 241This is useful, for example, when we have an open file descriptor for 242an unnamed file, and the name of a file that we believe to correspond 243to that fd. This can happen when we are exec'd with an already open 244file (@code{stdout} for example) or from the SVR4 @file{/proc} calls 245that return open file descriptors for mapped address spaces. All we 246have to do is open the file by name and check the two file descriptors 247for a match, which is done by comparing major and minor device numbers 248and inode numbers. 249 250@end deftypefn 251 252@c fopen_unlocked.c:48 253@deftypefn Extension {FILE *} fdopen_unlocked (int @var{fildes}, const char * @var{mode}) 254 255Opens and returns a @code{FILE} pointer via @code{fdopen}. If the 256operating system supports it, ensure that the stream is setup to avoid 257any multi-threaded locking. Otherwise return the @code{FILE} pointer 258unchanged. 259 260@end deftypefn 261 262@c ffs.c:3 263@deftypefn Supplemental int ffs (int @var{valu}) 264 265Find the first (least significant) bit set in @var{valu}. Bits are 266numbered from right to left, starting with bit 1 (corresponding to the 267value 1). If @var{valu} is zero, zero is returned. 268 269@end deftypefn 270 271@c fnmatch.txh:1 272@deftypefn Replacement int fnmatch (const char *@var{pattern}, const char *@var{string}, int @var{flags}) 273 274Matches @var{string} against @var{pattern}, returning zero if it 275matches, @code{FNM_NOMATCH} if not. @var{pattern} may contain the 276wildcards @code{?} to match any one character, @code{*} to match any 277zero or more characters, or a set of alternate characters in square 278brackets, like @samp{[a-gt8]}, which match one character (@code{a} 279through @code{g}, or @code{t}, or @code{8}, in this example) if that one 280character is in the set. A set may be inverted (i.e., match anything 281except what's in the set) by giving @code{^} or @code{!} as the first 282character in the set. To include those characters in the set, list them 283as anything other than the first character of the set. To include a 284dash in the set, list it last in the set. A backslash character makes 285the following character not special, so for example you could match 286against a literal asterisk with @samp{\*}. To match a literal 287backslash, use @samp{\\}. 288 289@code{flags} controls various aspects of the matching process, and is a 290boolean OR of zero or more of the following values (defined in 291@code{<fnmatch.h>}): 292 293@table @code 294 295@item FNM_PATHNAME 296@itemx FNM_FILE_NAME 297@var{string} is assumed to be a path name. No wildcard will ever match 298@code{/}. 299 300@item FNM_NOESCAPE 301Do not interpret backslashes as quoting the following special character. 302 303@item FNM_PERIOD 304A leading period (at the beginning of @var{string}, or if 305@code{FNM_PATHNAME} after a slash) is not matched by @code{*} or 306@code{?} but must be matched explicitly. 307 308@item FNM_LEADING_DIR 309Means that @var{string} also matches @var{pattern} if some initial part 310of @var{string} matches, and is followed by @code{/} and zero or more 311characters. For example, @samp{foo*} would match either @samp{foobar} 312or @samp{foobar/grill}. 313 314@item FNM_CASEFOLD 315Ignores case when performing the comparison. 316 317@end table 318 319@end deftypefn 320 321@c fopen_unlocked.c:39 322@deftypefn Extension {FILE *} fopen_unlocked (const char *@var{path}, const char * @var{mode}) 323 324Opens and returns a @code{FILE} pointer via @code{fopen}. If the 325operating system supports it, ensure that the stream is setup to avoid 326any multi-threaded locking. Otherwise return the @code{FILE} pointer 327unchanged. 328 329@end deftypefn 330 331@c argv.c:97 332@deftypefn Extension void freeargv (char **@var{vector}) 333 334Free an argument vector that was built using @code{buildargv}. Simply 335scans through @var{vector}, freeing the memory for each argument until 336the terminating @code{NULL} is found, and then frees @var{vector} 337itself. 338 339@end deftypefn 340 341@c fopen_unlocked.c:57 342@deftypefn Extension {FILE *} freopen_unlocked (const char * @var{path}, const char * @var{mode}, FILE * @var{stream}) 343 344Opens and returns a @code{FILE} pointer via @code{freopen}. If the 345operating system supports it, ensure that the stream is setup to avoid 346any multi-threaded locking. Otherwise return the @code{FILE} pointer 347unchanged. 348 349@end deftypefn 350 351@c getruntime.c:82 352@deftypefn Replacement long get_run_time (void) 353 354Returns the time used so far, in microseconds. If possible, this is 355the time used by this process, else it is the elapsed time since the 356process started. 357 358@end deftypefn 359 360@c getcwd.c:6 361@deftypefn Supplemental char* getcwd (char *@var{pathname}, int @var{len}) 362 363Copy the absolute pathname for the current working directory into 364@var{pathname}, which is assumed to point to a buffer of at least 365@var{len} bytes, and return a pointer to the buffer. If the current 366directory's path doesn't fit in @var{len} characters, the result is 367@code{NULL} and @code{errno} is set. If @var{pathname} is a null pointer, 368@code{getcwd} will obtain @var{len} bytes of space using 369@code{malloc}. 370 371@end deftypefn 372 373@c getpagesize.c:5 374@deftypefn Supplemental int getpagesize (void) 375 376Returns the number of bytes in a page of memory. This is the 377granularity of many of the system memory management routines. No 378guarantee is made as to whether or not it is the same as the basic 379memory management hardware page size. 380 381@end deftypefn 382 383@c getpwd.c:5 384@deftypefn Supplemental char* getpwd (void) 385 386Returns the current working directory. This implementation caches the 387result on the assumption that the process will not call @code{chdir} 388between calls to @code{getpwd}. 389 390@end deftypefn 391 392@c gettimeofday.c:12 393@deftypefn Supplemental int gettimeofday (struct timeval *@var{tp}, void *@var{tz}) 394 395Writes the current time to @var{tp}. This implementation requires 396that @var{tz} be NULL. Returns 0 on success, -1 on failure. 397 398@end deftypefn 399 400@c hex.c:33 401@deftypefn Extension void hex_init (void) 402 403Initializes the array mapping the current character set to 404corresponding hex values. This function must be called before any 405call to @code{hex_p} or @code{hex_value}. If you fail to call it, a 406default ASCII-based table will normally be used on ASCII systems. 407 408@end deftypefn 409 410@c hex.c:42 411@deftypefn Extension int hex_p (int @var{c}) 412 413Evaluates to non-zero if the given character is a valid hex character, 414or zero if it is not. Note that the value you pass will be cast to 415@code{unsigned char} within the macro. 416 417@end deftypefn 418 419@c hex.c:50 420@deftypefn Extension {unsigned int} hex_value (int @var{c}) 421 422Returns the numeric equivalent of the given character when interpreted 423as a hexidecimal digit. The result is undefined if you pass an 424invalid hex digit. Note that the value you pass will be cast to 425@code{unsigned char} within the macro. 426 427The @code{hex_value} macro returns @code{unsigned int}, rather than 428signed @code{int}, to make it easier to use in parsing addresses from 429hex dump files: a signed @code{int} would be sign-extended when 430converted to a wider unsigned type --- like @code{bfd_vma}, on some 431systems. 432 433@end deftypefn 434 435@c index.c:5 436@deftypefn Supplemental char* index (char *@var{s}, int @var{c}) 437 438Returns a pointer to the first occurrence of the character @var{c} in 439the string @var{s}, or @code{NULL} if not found. The use of @code{index} is 440deprecated in new programs in favor of @code{strchr}. 441 442@end deftypefn 443 444@c insque.c:6 445@deftypefn Supplemental void insque (struct qelem *@var{elem}, struct qelem *@var{pred}) 446@deftypefnx Supplemental void remque (struct qelem *@var{elem}) 447 448Routines to manipulate queues built from doubly linked lists. The 449@code{insque} routine inserts @var{elem} in the queue immediately 450after @var{pred}. The @code{remque} routine removes @var{elem} from 451its containing queue. These routines expect to be passed pointers to 452structures which have as their first members a forward pointer and a 453back pointer, like this prototype (although no prototype is provided): 454 455@example 456struct qelem @{ 457 struct qelem *q_forw; 458 struct qelem *q_back; 459 char q_data[]; 460@}; 461@end example 462 463@end deftypefn 464 465@c safe-ctype.c:46 466@deffn Extension ISALPHA (@var{c}) 467@deffnx Extension ISALNUM (@var{c}) 468@deffnx Extension ISBLANK (@var{c}) 469@deffnx Extension ISCNTRL (@var{c}) 470@deffnx Extension ISDIGIT (@var{c}) 471@deffnx Extension ISGRAPH (@var{c}) 472@deffnx Extension ISLOWER (@var{c}) 473@deffnx Extension ISPRINT (@var{c}) 474@deffnx Extension ISPUNCT (@var{c}) 475@deffnx Extension ISSPACE (@var{c}) 476@deffnx Extension ISUPPER (@var{c}) 477@deffnx Extension ISXDIGIT (@var{c}) 478 479These twelve macros are defined by @file{safe-ctype.h}. Each has the 480same meaning as the corresponding macro (with name in lowercase) 481defined by the standard header @file{ctype.h}. For example, 482@code{ISALPHA} returns true for alphabetic characters and false for 483others. However, there are two differences between these macros and 484those provided by @file{ctype.h}: 485 486@itemize @bullet 487@item These macros are guaranteed to have well-defined behavior for all 488values representable by @code{signed char} and @code{unsigned char}, and 489for @code{EOF}. 490 491@item These macros ignore the current locale; they are true for these 492fixed sets of characters: 493@multitable {@code{XDIGIT}} {yada yada yada yada yada yada yada yada} 494@item @code{ALPHA} @tab @kbd{A-Za-z} 495@item @code{ALNUM} @tab @kbd{A-Za-z0-9} 496@item @code{BLANK} @tab @kbd{space tab} 497@item @code{CNTRL} @tab @code{!PRINT} 498@item @code{DIGIT} @tab @kbd{0-9} 499@item @code{GRAPH} @tab @code{ALNUM || PUNCT} 500@item @code{LOWER} @tab @kbd{a-z} 501@item @code{PRINT} @tab @code{GRAPH ||} @kbd{space} 502@item @code{PUNCT} @tab @kbd{`~!@@#$%^&*()_-=+[@{]@}\|;:'",<.>/?} 503@item @code{SPACE} @tab @kbd{space tab \n \r \f \v} 504@item @code{UPPER} @tab @kbd{A-Z} 505@item @code{XDIGIT} @tab @kbd{0-9A-Fa-f} 506@end multitable 507 508Note that, if the host character set is ASCII or a superset thereof, 509all these macros will return false for all values of @code{char} outside 510the range of 7-bit ASCII. In particular, both ISPRINT and ISCNTRL return 511false for characters with numeric values from 128 to 255. 512@end itemize 513@end deffn 514 515@c safe-ctype.c:95 516@deffn Extension ISIDNUM (@var{c}) 517@deffnx Extension ISIDST (@var{c}) 518@deffnx Extension IS_VSPACE (@var{c}) 519@deffnx Extension IS_NVSPACE (@var{c}) 520@deffnx Extension IS_SPACE_OR_NUL (@var{c}) 521@deffnx Extension IS_ISOBASIC (@var{c}) 522These six macros are defined by @file{safe-ctype.h} and provide 523additional character classes which are useful when doing lexical 524analysis of C or similar languages. They are true for the following 525sets of characters: 526 527@multitable {@code{SPACE_OR_NUL}} {yada yada yada yada yada yada yada yada} 528@item @code{IDNUM} @tab @kbd{A-Za-z0-9_} 529@item @code{IDST} @tab @kbd{A-Za-z_} 530@item @code{VSPACE} @tab @kbd{\r \n} 531@item @code{NVSPACE} @tab @kbd{space tab \f \v \0} 532@item @code{SPACE_OR_NUL} @tab @code{VSPACE || NVSPACE} 533@item @code{ISOBASIC} @tab @code{VSPACE || NVSPACE || PRINT} 534@end multitable 535@end deffn 536 537@c lbasename.c:23 538@deftypefn Replacement {const char*} lbasename (const char *@var{name}) 539 540Given a pointer to a string containing a typical pathname 541(@samp{/usr/src/cmd/ls/ls.c} for example), returns a pointer to the 542last component of the pathname (@samp{ls.c} in this case). The 543returned pointer is guaranteed to lie within the original 544string. This latter fact is not true of many vendor C 545libraries, which return special strings or modify the passed 546strings for particular input. 547 548In particular, the empty string returns the same empty string, 549and a path ending in @code{/} returns the empty string after it. 550 551@end deftypefn 552 553@c lrealpath.c:25 554@deftypefn Replacement {const char*} lrealpath (const char *@var{name}) 555 556Given a pointer to a string containing a pathname, returns a canonical 557version of the filename. Symlinks will be resolved, and ``.'' and ``..'' 558components will be simplified. The returned value will be allocated using 559@code{malloc}, or @code{NULL} will be returned on a memory allocation error. 560 561@end deftypefn 562 563@c make-relative-prefix.c:24 564@deftypefn Extension {const char*} make_relative_prefix (const char *@var{progname}, const char *@var{bin_prefix}, const char *@var{prefix}) 565 566Given three paths @var{progname}, @var{bin_prefix}, @var{prefix}, 567return the path that is in the same position relative to 568@var{progname}'s directory as @var{prefix} is relative to 569@var{bin_prefix}. That is, a string starting with the directory 570portion of @var{progname}, followed by a relative pathname of the 571difference between @var{bin_prefix} and @var{prefix}. 572 573If @var{progname} does not contain any directory separators, 574@code{make_relative_prefix} will search @env{PATH} to find a program 575named @var{progname}. Also, if @var{progname} is a symbolic link, 576the symbolic link will be resolved. 577 578For example, if @var{bin_prefix} is @code{/alpha/beta/gamma/gcc/delta}, 579@var{prefix} is @code{/alpha/beta/gamma/omega/}, and @var{progname} is 580@code{/red/green/blue/gcc}, then this function will return 581@code{/red/green/blue/../../omega/}. 582 583The return value is normally allocated via @code{malloc}. If no 584relative prefix can be found, return @code{NULL}. 585 586@end deftypefn 587 588@c make-temp-file.c:137 589@deftypefn Replacement char* make_temp_file (const char *@var{suffix}) 590 591Return a temporary file name (as a string) or @code{NULL} if unable to 592create one. @var{suffix} is a suffix to append to the file name. The 593string is @code{malloc}ed, and the temporary file has been created. 594 595@end deftypefn 596 597@c memchr.c:3 598@deftypefn Supplemental void* memchr (const void *@var{s}, int @var{c}, size_t @var{n}) 599 600This function searches memory starting at @code{*@var{s}} for the 601character @var{c}. The search only ends with the first occurrence of 602@var{c}, or after @var{length} characters; in particular, a null 603character does not terminate the search. If the character @var{c} is 604found within @var{length} characters of @code{*@var{s}}, a pointer 605to the character is returned. If @var{c} is not found, then @code{NULL} is 606returned. 607 608@end deftypefn 609 610@c memcmp.c:6 611@deftypefn Supplemental int memcmp (const void *@var{x}, const void *@var{y}, size_t @var{count}) 612 613Compares the first @var{count} bytes of two areas of memory. Returns 614zero if they are the same, a value less than zero if @var{x} is 615lexically less than @var{y}, or a value greater than zero if @var{x} 616is lexically greater than @var{y}. Note that lexical order is determined 617as if comparing unsigned char arrays. 618 619@end deftypefn 620 621@c memcpy.c:6 622@deftypefn Supplemental void* memcpy (void *@var{out}, const void *@var{in}, size_t @var{length}) 623 624Copies @var{length} bytes from memory region @var{in} to region 625@var{out}. Returns a pointer to @var{out}. 626 627@end deftypefn 628 629@c memmove.c:6 630@deftypefn Supplemental void* memmove (void *@var{from}, const void *@var{to}, size_t @var{count}) 631 632Copies @var{count} bytes from memory area @var{from} to memory area 633@var{to}, returning a pointer to @var{to}. 634 635@end deftypefn 636 637@c mempcpy.c:23 638@deftypefn Supplemental void* mempcpy (void *@var{out}, const void *@var{in}, size_t @var{length}) 639 640Copies @var{length} bytes from memory region @var{in} to region 641@var{out}. Returns a pointer to @var{out} + @var{length}. 642 643@end deftypefn 644 645@c memset.c:6 646@deftypefn Supplemental void* memset (void *@var{s}, int @var{c}, size_t @var{count}) 647 648Sets the first @var{count} bytes of @var{s} to the constant byte 649@var{c}, returning a pointer to @var{s}. 650 651@end deftypefn 652 653@c mkstemps.c:54 654@deftypefn Replacement int mkstemps (char *@var{pattern}, int @var{suffix_len}) 655 656Generate a unique temporary file name from @var{pattern}. 657@var{pattern} has the form: 658 659@example 660 @var{path}/ccXXXXXX@var{suffix} 661@end example 662 663@var{suffix_len} tells us how long @var{suffix} is (it can be zero 664length). The last six characters of @var{pattern} before @var{suffix} 665must be @samp{XXXXXX}; they are replaced with a string that makes the 666filename unique. Returns a file descriptor open on the file for 667reading and writing. 668 669@end deftypefn 670 671@c pexecute.txh:244 672@deftypefn Extension void pex_free (struct pex_obj @var{obj}) 673 674Clean up and free all data associated with @var{obj}. 675 676@end deftypefn 677 678@c pexecute.txh:219 679@deftypefn Extension int pex_get_status (struct pex_obj *@var{obj}, int @var{count}, int *@var{vector}) 680 681Returns the exit status of all programs run using @var{obj}. 682@var{count} is the number of results expected. The results will be 683placed into @var{vector}. The results are in the order of the calls 684to @code{pex_run}. Returns 0 on error, 1 on success. 685 686@end deftypefn 687 688@c pexecute.txh:228 689@deftypefn Extension int pex_get_times (struct pex_obj *@var{obj}, int @var{count}, struct pex_time *@var{vector}) 690 691Returns the process execution times of all programs run using 692@var{obj}. @var{count} is the number of results expected. The 693results will be placed into @var{vector}. The results are in the 694order of the calls to @code{pex_run}. Returns 0 on error, 1 on 695success. 696 697@code{struct pex_time} has the following fields of the type 698@code{unsigned long}: @code{user_seconds}, 699@code{user_microseconds}, @code{system_seconds}, 700@code{system_microseconds}. On systems which do not support reporting 701process times, all the fields will be set to @code{0}. 702 703@end deftypefn 704 705@c pexecute.txh:2 706@deftypefn Extension {struct pex_obj *} pex_init (int @var{flags}, const char *@var{pname}, const char *@var{tempbase}) 707 708Prepare to execute one or more programs, with standard output of each 709program fed to standard input of the next. This is a system 710independent interface to execute a pipeline. 711 712@var{flags} is a bitwise combination of the following: 713 714@table @code 715 716@vindex PEX_RECORD_TIMES 717@item PEX_RECORD_TIMES 718Record subprocess times if possible. 719 720@vindex PEX_USE_PIPES 721@item PEX_USE_PIPES 722Use pipes for communication between processes, if possible. 723 724@vindex PEX_SAVE_TEMPS 725@item PEX_SAVE_TEMPS 726Don't delete temporary files used for communication between 727processes. 728 729@end table 730 731@var{pname} is the name of program to be executed, used in error 732messages. @var{tempbase} is a base name to use for any required 733temporary files; it may be @code{NULL} to use a randomly chosen name. 734 735@end deftypefn 736 737@c pexecute.txh:146 738@deftypefn Extension {FILE *} pex_input_file (struct pex_obj *@var{obj}, int @var{flags}, const char *@var{in_name}) 739 740Return a stream for a temporary file to pass to the first program in 741the pipeline as input. 742 743The name of the input file is chosen according to the same rules 744@code{pex_run} uses to choose output file names, based on 745@var{in_name}, @var{obj} and the @code{PEX_SUFFIX} bit in @var{flags}. 746 747Don't call @code{fclose} on the returned stream; the first call to 748@code{pex_run} closes it automatically. 749 750If @var{flags} includes @code{PEX_BINARY_OUTPUT}, open the stream in 751binary mode; otherwise, open it in the default mode. Including 752@code{PEX_BINARY_OUTPUT} in @var{flags} has no effect on Unix. 753@end deftypefn 754 755@c pexecute.txh:163 756@deftypefn Extension {FILE *} pex_input_pipe (struct pex_obj *@var{obj}, int @var{binary}) 757 758Return a stream @var{fp} for a pipe connected to the standard input of 759the first program in the pipeline; @var{fp} is opened for writing. 760You must have passed @code{PEX_USE_PIPES} to the @code{pex_init} call 761that returned @var{obj}. 762 763You must close @var{fp} using @code{fclose} yourself when you have 764finished writing data to the pipeline. 765 766The file descriptor underlying @var{fp} is marked not to be inherited 767by child processes. 768 769On systems that do not support pipes, this function returns 770@code{NULL}, and sets @code{errno} to @code{EINVAL}. If you would 771like to write code that is portable to all systems the @code{pex} 772functions support, consider using @code{pex_input_file} instead. 773 774There are two opportunities for deadlock using 775@code{pex_input_pipe}: 776 777@itemize @bullet 778@item 779Most systems' pipes can buffer only a fixed amount of data; a process 780that writes to a full pipe blocks. Thus, if you write to @file{fp} 781before starting the first process, you run the risk of blocking when 782there is no child process yet to read the data and allow you to 783continue. @code{pex_input_pipe} makes no promises about the 784size of the pipe's buffer, so if you need to write any data at all 785before starting the first process in the pipeline, consider using 786@code{pex_input_file} instead. 787 788@item 789Using @code{pex_input_pipe} and @code{pex_read_output} together 790may also cause deadlock. If the output pipe fills up, so that each 791program in the pipeline is waiting for the next to read more data, and 792you fill the input pipe by writing more data to @var{fp}, then there 793is no way to make progress: the only process that could read data from 794the output pipe is you, but you are blocked on the input pipe. 795 796@end itemize 797 798@end deftypefn 799 800@c pexecute.txh:250 801@deftypefn Extension {const char *} pex_one (int @var{flags}, const char *@var{executable}, char * const *@var{argv}, const char *@var{pname}, const char *@var{outname}, const char *@var{errname}, int *@var{status}, int *@var{err}) 802 803An interface to permit the easy execution of a 804single program. The return value and most of the parameters are as 805for a call to @code{pex_run}. @var{flags} is restricted to a 806combination of @code{PEX_SEARCH}, @code{PEX_STDERR_TO_STDOUT}, and 807@code{PEX_BINARY_OUTPUT}. @var{outname} is interpreted as if 808@code{PEX_LAST} were set. On a successful return, @code{*@var{status}} will 809be set to the exit status of the program. 810 811@end deftypefn 812 813@c pexecute.txh:207 814@deftypefn Extension {FILE *} pex_read_output (struct pex_obj *@var{obj}, int @var{binary}) 815 816Returns a @code{FILE} pointer which may be used to read the standard 817output of the last program in the pipeline. When this is used, 818@code{PEX_LAST} should not be used in a call to @code{pex_run}. After 819this is called, @code{pex_run} may no longer be called with the same 820@var{obj}. @var{binary} should be non-zero if the file should be 821opened in binary mode. Don't call @code{fclose} on the returned file; 822it will be closed by @code{pex_free}. 823 824@end deftypefn 825 826@c pexecute.txh:33 827@deftypefn Extension {const char *} pex_run (struct pex_obj *@var{obj}, int @var{flags}, const char *@var{executable}, char * const *@var{argv}, const char *@var{outname}, const char *@var{errname}, int *@var{err}) 828 829Execute one program in a pipeline. On success this returns 830@code{NULL}. On failure it returns an error message, a statically 831allocated string. 832 833@var{obj} is returned by a previous call to @code{pex_init}. 834 835@var{flags} is a bitwise combination of the following: 836 837@table @code 838 839@vindex PEX_LAST 840@item PEX_LAST 841This must be set on the last program in the pipeline. In particular, 842it should be set when executing a single program. The standard output 843of the program will be sent to @var{outname}, or, if @var{outname} is 844@code{NULL}, to the standard output of the calling program. Do @emph{not} 845set this bit if you want to call @code{pex_read_output} 846(described below). After a call to @code{pex_run} with this bit set, 847@var{pex_run} may no longer be called with the same @var{obj}. 848 849@vindex PEX_SEARCH 850@item PEX_SEARCH 851Search for the program using the user's executable search path. 852 853@vindex PEX_SUFFIX 854@item PEX_SUFFIX 855@var{outname} is a suffix. See the description of @var{outname}, 856below. 857 858@vindex PEX_STDERR_TO_STDOUT 859@item PEX_STDERR_TO_STDOUT 860Send the program's standard error to standard output, if possible. 861 862@vindex PEX_BINARY_INPUT 863@vindex PEX_BINARY_OUTPUT 864@item PEX_BINARY_INPUT 865@itemx PEX_BINARY_OUTPUT 866The standard input (output) of the program should be read (written) in 867binary mode rather than text mode. These flags are ignored on systems 868which do not distinguish binary mode and text mode, such as Unix. For 869proper behavior these flags should match appropriately---a call to 870@code{pex_run} using @code{PEX_BINARY_OUTPUT} should be followed by a 871call using @code{PEX_BINARY_INPUT}. 872@end table 873 874@var{executable} is the program to execute. @var{argv} is the set of 875arguments to pass to the program; normally @code{@var{argv}[0]} will 876be a copy of @var{executable}. 877 878@var{outname} is used to set the name of the file to use for standard 879output. There are two cases in which no output file will be used: 880 881@enumerate 882@item 883if @code{PEX_LAST} is not set in @var{flags}, and @code{PEX_USE_PIPES} 884was set in the call to @code{pex_init}, and the system supports pipes 885 886@item 887if @code{PEX_LAST} is set in @var{flags}, and @var{outname} is 888@code{NULL} 889@end enumerate 890 891@noindent 892Otherwise the code will use a file to hold standard 893output. If @code{PEX_LAST} is not set, this file is considered to be 894a temporary file, and it will be removed when no longer needed, unless 895@code{PEX_SAVE_TEMPS} was set in the call to @code{pex_init}. 896 897There are two cases to consider when setting the name of the file to 898hold standard output. 899 900@enumerate 901@item 902@code{PEX_SUFFIX} is set in @var{flags}. In this case 903@var{outname} may not be @code{NULL}. If the @var{tempbase} parameter 904to @code{pex_init} was not @code{NULL}, then the output file name is 905the concatenation of @var{tempbase} and @var{outname}. If 906@var{tempbase} was @code{NULL}, then the output file name is a random 907file name ending in @var{outname}. 908 909@item 910@code{PEX_SUFFIX} was not set in @var{flags}. In this 911case, if @var{outname} is not @code{NULL}, it is used as the output 912file name. If @var{outname} is @code{NULL}, and @var{tempbase} was 913not NULL, the output file name is randomly chosen using 914@var{tempbase}. Otherwise the output file name is chosen completely 915at random. 916@end enumerate 917 918@var{errname} is the file name to use for standard error output. If 919it is @code{NULL}, standard error is the same as the caller's. 920Otherwise, standard error is written to the named file. 921 922On an error return, the code sets @code{*@var{err}} to an @code{errno} 923value, or to 0 if there is no relevant @code{errno}. 924 925@end deftypefn 926 927@c pexecute.txh:133 928@deftypefn Extension {const char *} pex_run_in_environment (struct pex_obj *@var{obj}, int @var{flags}, const char *@var{executable}, char * const *@var{argv}, char * const *@var{env}, int @var{env_size}, const char *@var{outname}, const char *@var{errname}, int *@var{err}) 929 930Execute one program in a pipeline, permitting the environment for the 931program to be specified. Behaviour and parameters not listed below are 932as for @code{pex_run}. 933 934@var{env} is the environment for the child process, specified as an array of 935character pointers. Each element of the array should point to a string of the 936form @code{VAR=VALUE}, with the exception of the last element that must be 937@code{NULL}. 938 939@end deftypefn 940 941@c pexecute.txh:262 942@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) 943 944This is the old interface to execute one or more programs. It is 945still supported for compatibility purposes, but is no longer 946documented. 947 948@end deftypefn 949 950@c strsignal.c:539 951@deftypefn Supplemental void psignal (int @var{signo}, char *@var{message}) 952 953Print @var{message} to the standard error, followed by a colon, 954followed by the description of the signal specified by @var{signo}, 955followed by a newline. 956 957@end deftypefn 958 959@c putenv.c:21 960@deftypefn Supplemental int putenv (const char *@var{string}) 961 962Uses @code{setenv} or @code{unsetenv} to put @var{string} into 963the environment or remove it. If @var{string} is of the form 964@samp{name=value} the string is added; if no @samp{=} is present the 965name is unset/removed. 966 967@end deftypefn 968 969@c pexecute.txh:270 970@deftypefn Extension int pwait (int @var{pid}, int *@var{status}, int @var{flags}) 971 972Another part of the old execution interface. 973 974@end deftypefn 975 976@c random.c:39 977@deftypefn Supplement {long int} random (void) 978@deftypefnx Supplement void srandom (unsigned int @var{seed}) 979@deftypefnx Supplement void* initstate (unsigned int @var{seed}, void *@var{arg_state}, unsigned long @var{n}) 980@deftypefnx Supplement void* setstate (void *@var{arg_state}) 981 982Random number functions. @code{random} returns a random number in the 983range 0 to @code{LONG_MAX}. @code{srandom} initializes the random 984number generator to some starting point determined by @var{seed} 985(else, the values returned by @code{random} are always the same for each 986run of the program). @code{initstate} and @code{setstate} allow fine-grained 987control over the state of the random number generator. 988 989@end deftypefn 990 991@c concat.c:173 992@deftypefn Extension char* reconcat (char *@var{optr}, const char *@var{s1}, @dots{}, @code{NULL}) 993 994Same as @code{concat}, except that if @var{optr} is not @code{NULL} it 995is freed after the string is created. This is intended to be useful 996when you're extending an existing string or building up a string in a 997loop: 998 999@example 1000 str = reconcat (str, "pre-", str, NULL); 1001@end example 1002 1003@end deftypefn 1004 1005@c rename.c:6 1006@deftypefn Supplemental int rename (const char *@var{old}, const char *@var{new}) 1007 1008Renames a file from @var{old} to @var{new}. If @var{new} already 1009exists, it is removed. 1010 1011@end deftypefn 1012 1013@c rindex.c:5 1014@deftypefn Supplemental char* rindex (const char *@var{s}, int @var{c}) 1015 1016Returns a pointer to the last occurrence of the character @var{c} in 1017the string @var{s}, or @code{NULL} if not found. The use of @code{rindex} is 1018deprecated in new programs in favor of @code{strrchr}. 1019 1020@end deftypefn 1021 1022@c setenv.c:22 1023@deftypefn Supplemental int setenv (const char *@var{name}, const char *@var{value}, int @var{overwrite}) 1024@deftypefnx Supplemental void unsetenv (const char *@var{name}) 1025 1026@code{setenv} adds @var{name} to the environment with value 1027@var{value}. If the name was already present in the environment, 1028the new value will be stored only if @var{overwrite} is nonzero. 1029The companion @code{unsetenv} function removes @var{name} from the 1030environment. This implementation is not safe for multithreaded code. 1031 1032@end deftypefn 1033 1034@c strsignal.c:348 1035@deftypefn Extension int signo_max (void) 1036 1037Returns the maximum signal value for which a corresponding symbolic 1038name or message is available. Note that in the case where we use the 1039@code{sys_siglist} supplied by the system, it is possible for there to 1040be more symbolic names than messages, or vice versa. In fact, the 1041manual page for @code{psignal(3b)} explicitly warns that one should 1042check the size of the table (@code{NSIG}) before indexing it, since 1043new signal codes may be added to the system before they are added to 1044the table. Thus @code{NSIG} might be smaller than value implied by 1045the largest signo value defined in @code{<signal.h>}. 1046 1047We return the maximum value that can be used to obtain a meaningful 1048symbolic name or message. 1049 1050@end deftypefn 1051 1052@c sigsetmask.c:8 1053@deftypefn Supplemental int sigsetmask (int @var{set}) 1054 1055Sets the signal mask to the one provided in @var{set} and returns 1056the old mask (which, for libiberty's implementation, will always 1057be the value @code{1}). 1058 1059@end deftypefn 1060 1061@c snprintf.c:28 1062@deftypefn Supplemental int snprintf (char *@var{buf}, size_t @var{n}, const char *@var{format}, ...) 1063 1064This function is similar to sprintf, but it will print at most @var{n} 1065characters. On error the return value is -1, otherwise it returns the 1066number of characters that would have been printed had @var{n} been 1067sufficiently large, regardless of the actual value of @var{n}. Note 1068some pre-C99 system libraries do not implement this correctly so users 1069cannot generally rely on the return value if the system version of 1070this function is used. 1071 1072@end deftypefn 1073 1074@c spaces.c:22 1075@deftypefn Extension char* spaces (int @var{count}) 1076 1077Returns a pointer to a memory region filled with the specified 1078number of spaces and null terminated. The returned pointer is 1079valid until at least the next call. 1080 1081@end deftypefn 1082 1083@c stpcpy.c:23 1084@deftypefn Supplemental char* stpcpy (char *@var{dst}, const char *@var{src}) 1085 1086Copies the string @var{src} into @var{dst}. Returns a pointer to 1087@var{dst} + strlen(@var{src}). 1088 1089@end deftypefn 1090 1091@c stpncpy.c:23 1092@deftypefn Supplemental char* stpncpy (char *@var{dst}, const char *@var{src}, size_t @var{len}) 1093 1094Copies the string @var{src} into @var{dst}, copying exactly @var{len} 1095and padding with zeros if necessary. If @var{len} < strlen(@var{src}) 1096then return @var{dst} + @var{len}, otherwise returns @var{dst} + 1097strlen(@var{src}). 1098 1099@end deftypefn 1100 1101@c strcasecmp.c:15 1102@deftypefn Supplemental int strcasecmp (const char *@var{s1}, const char *@var{s2}) 1103 1104A case-insensitive @code{strcmp}. 1105 1106@end deftypefn 1107 1108@c strchr.c:6 1109@deftypefn Supplemental char* strchr (const char *@var{s}, int @var{c}) 1110 1111Returns a pointer to the first occurrence of the character @var{c} in 1112the string @var{s}, or @code{NULL} if not found. If @var{c} is itself the 1113null character, the results are undefined. 1114 1115@end deftypefn 1116 1117@c strdup.c:3 1118@deftypefn Supplemental char* strdup (const char *@var{s}) 1119 1120Returns a pointer to a copy of @var{s} in memory obtained from 1121@code{malloc}, or @code{NULL} if insufficient memory was available. 1122 1123@end deftypefn 1124 1125@c strerror.c:670 1126@deftypefn Replacement {const char*} strerrno (int @var{errnum}) 1127 1128Given an error number returned from a system call (typically returned 1129in @code{errno}), returns a pointer to a string containing the 1130symbolic name of that error number, as found in @code{<errno.h>}. 1131 1132If the supplied error number is within the valid range of indices for 1133symbolic names, but no name is available for the particular error 1134number, then returns the string @samp{Error @var{num}}, where @var{num} 1135is the error number. 1136 1137If the supplied error number is not within the range of valid 1138indices, then returns @code{NULL}. 1139 1140The contents of the location pointed to are only guaranteed to be 1141valid until the next call to @code{strerrno}. 1142 1143@end deftypefn 1144 1145@c strerror.c:603 1146@deftypefn Supplemental char* strerror (int @var{errnoval}) 1147 1148Maps an @code{errno} number to an error message string, the contents 1149of which are implementation defined. On systems which have the 1150external variables @code{sys_nerr} and @code{sys_errlist}, these 1151strings will be the same as the ones used by @code{perror}. 1152 1153If the supplied error number is within the valid range of indices for 1154the @code{sys_errlist}, but no message is available for the particular 1155error number, then returns the string @samp{Error @var{num}}, where 1156@var{num} is the error number. 1157 1158If the supplied error number is not a valid index into 1159@code{sys_errlist}, returns @code{NULL}. 1160 1161The returned string is only guaranteed to be valid only until the 1162next call to @code{strerror}. 1163 1164@end deftypefn 1165 1166@c strncasecmp.c:15 1167@deftypefn Supplemental int strncasecmp (const char *@var{s1}, const char *@var{s2}) 1168 1169A case-insensitive @code{strncmp}. 1170 1171@end deftypefn 1172 1173@c strncmp.c:6 1174@deftypefn Supplemental int strncmp (const char *@var{s1}, const char *@var{s2}, size_t @var{n}) 1175 1176Compares the first @var{n} bytes of two strings, returning a value as 1177@code{strcmp}. 1178 1179@end deftypefn 1180 1181@c strndup.c:23 1182@deftypefn Extension char* strndup (const char *@var{s}, size_t @var{n}) 1183 1184Returns a pointer to a copy of @var{s} with at most @var{n} characters 1185in memory obtained from @code{malloc}, or @code{NULL} if insufficient 1186memory was available. The result is always NUL terminated. 1187 1188@end deftypefn 1189 1190@c strrchr.c:6 1191@deftypefn Supplemental char* strrchr (const char *@var{s}, int @var{c}) 1192 1193Returns a pointer to the last occurrence of the character @var{c} in 1194the string @var{s}, or @code{NULL} if not found. If @var{c} is itself the 1195null character, the results are undefined. 1196 1197@end deftypefn 1198 1199@c strsignal.c:383 1200@deftypefn Supplemental {const char *} strsignal (int @var{signo}) 1201 1202Maps an signal number to an signal message string, the contents of 1203which are implementation defined. On systems which have the external 1204variable @code{sys_siglist}, these strings will be the same as the 1205ones used by @code{psignal()}. 1206 1207If the supplied signal number is within the valid range of indices for 1208the @code{sys_siglist}, but no message is available for the particular 1209signal number, then returns the string @samp{Signal @var{num}}, where 1210@var{num} is the signal number. 1211 1212If the supplied signal number is not a valid index into 1213@code{sys_siglist}, returns @code{NULL}. 1214 1215The returned string is only guaranteed to be valid only until the next 1216call to @code{strsignal}. 1217 1218@end deftypefn 1219 1220@c strsignal.c:446 1221@deftypefn Extension {const char*} strsigno (int @var{signo}) 1222 1223Given an signal number, returns a pointer to a string containing the 1224symbolic name of that signal number, as found in @code{<signal.h>}. 1225 1226If the supplied signal number is within the valid range of indices for 1227symbolic names, but no name is available for the particular signal 1228number, then returns the string @samp{Signal @var{num}}, where 1229@var{num} is the signal number. 1230 1231If the supplied signal number is not within the range of valid 1232indices, then returns @code{NULL}. 1233 1234The contents of the location pointed to are only guaranteed to be 1235valid until the next call to @code{strsigno}. 1236 1237@end deftypefn 1238 1239@c strstr.c:6 1240@deftypefn Supplemental char* strstr (const char *@var{string}, const char *@var{sub}) 1241 1242This function searches for the substring @var{sub} in the string 1243@var{string}, not including the terminating null characters. A pointer 1244to the first occurrence of @var{sub} is returned, or @code{NULL} if the 1245substring is absent. If @var{sub} points to a string with zero 1246length, the function returns @var{string}. 1247 1248@end deftypefn 1249 1250@c strtod.c:27 1251@deftypefn Supplemental double strtod (const char *@var{string}, char **@var{endptr}) 1252 1253This ISO C function converts the initial portion of @var{string} to a 1254@code{double}. If @var{endptr} is not @code{NULL}, a pointer to the 1255character after the last character used in the conversion is stored in 1256the location referenced by @var{endptr}. If no conversion is 1257performed, zero is returned and the value of @var{string} is stored in 1258the location referenced by @var{endptr}. 1259 1260@end deftypefn 1261 1262@c strerror.c:729 1263@deftypefn Extension int strtoerrno (const char *@var{name}) 1264 1265Given the symbolic name of a error number (e.g., @code{EACCES}), map it 1266to an errno value. If no translation is found, returns 0. 1267 1268@end deftypefn 1269 1270@c strtol.c:33 1271@deftypefn Supplemental {long int} strtol (const char *@var{string}, char **@var{endptr}, int @var{base}) 1272@deftypefnx Supplemental {unsigned long int} strtoul (const char *@var{string}, char **@var{endptr}, int @var{base}) 1273 1274The @code{strtol} function converts the string in @var{string} to a 1275long integer value according to the given @var{base}, which must be 1276between 2 and 36 inclusive, or be the special value 0. If @var{base} 1277is 0, @code{strtol} will look for the prefixes @code{0} and @code{0x} 1278to indicate bases 8 and 16, respectively, else default to base 10. 1279When the base is 16 (either explicitly or implicitly), a prefix of 1280@code{0x} is allowed. The handling of @var{endptr} is as that of 1281@code{strtod} above. The @code{strtoul} function is the same, except 1282that the converted value is unsigned. 1283 1284@end deftypefn 1285 1286@c strsignal.c:500 1287@deftypefn Extension int strtosigno (const char *@var{name}) 1288 1289Given the symbolic name of a signal, map it to a signal number. If no 1290translation is found, returns 0. 1291 1292@end deftypefn 1293 1294@c strverscmp.c:25 1295@deftypefun int strverscmp (const char *@var{s1}, const char *@var{s2}) 1296The @code{strverscmp} function compares the string @var{s1} against 1297@var{s2}, considering them as holding indices/version numbers. Return 1298value follows the same conventions as found in the @code{strverscmp} 1299function. In fact, if @var{s1} and @var{s2} contain no digits, 1300@code{strverscmp} behaves like @code{strcmp}. 1301 1302Basically, we compare strings normally (character by character), until 1303we find a digit in each string - then we enter a special comparison 1304mode, where each sequence of digits is taken as a whole. If we reach the 1305end of these two parts without noticing a difference, we return to the 1306standard comparison mode. There are two types of numeric parts: 1307"integral" and "fractional" (those begin with a '0'). The types 1308of the numeric parts affect the way we sort them: 1309 1310@itemize @bullet 1311@item 1312integral/integral: we compare values as you would expect. 1313 1314@item 1315fractional/integral: the fractional part is less than the integral one. 1316Again, no surprise. 1317 1318@item 1319fractional/fractional: the things become a bit more complex. 1320If the common prefix contains only leading zeroes, the longest part is less 1321than the other one; else the comparison behaves normally. 1322@end itemize 1323 1324@smallexample 1325strverscmp ("no digit", "no digit") 1326 @result{} 0 // @r{same behavior as strcmp.} 1327strverscmp ("item#99", "item#100") 1328 @result{} <0 // @r{same prefix, but 99 < 100.} 1329strverscmp ("alpha1", "alpha001") 1330 @result{} >0 // @r{fractional part inferior to integral one.} 1331strverscmp ("part1_f012", "part1_f01") 1332 @result{} >0 // @r{two fractional parts.} 1333strverscmp ("foo.009", "foo.0") 1334 @result{} <0 // @r{idem, but with leading zeroes only.} 1335@end smallexample 1336 1337This function is especially useful when dealing with filename sorting, 1338because filenames frequently hold indices/version numbers. 1339@end deftypefun 1340 1341@c tmpnam.c:3 1342@deftypefn Supplemental char* tmpnam (char *@var{s}) 1343 1344This function attempts to create a name for a temporary file, which 1345will be a valid file name yet not exist when @code{tmpnam} checks for 1346it. @var{s} must point to a buffer of at least @code{L_tmpnam} bytes, 1347or be @code{NULL}. Use of this function creates a security risk, and it must 1348not be used in new projects. Use @code{mkstemp} instead. 1349 1350@end deftypefn 1351 1352@c unlink-if-ordinary.c:27 1353@deftypefn Supplemental int unlink_if_ordinary (const char*) 1354 1355Unlinks the named file, unless it is special (e.g. a device file). 1356Returns 0 when the file was unlinked, a negative value (and errno set) when 1357there was an error deleting the file, and a positive value if no attempt 1358was made to unlink the file because it is special. 1359 1360@end deftypefn 1361 1362@c fopen_unlocked.c:31 1363@deftypefn Extension void unlock_std_streams (void) 1364 1365If the OS supports it, ensure that the standard I/O streams, 1366@code{stdin}, @code{stdout} and @code{stderr} are setup to avoid any 1367multi-threaded locking. Otherwise do nothing. 1368 1369@end deftypefn 1370 1371@c fopen_unlocked.c:23 1372@deftypefn Extension void unlock_stream (FILE * @var{stream}) 1373 1374If the OS supports it, ensure that the supplied stream is setup to 1375avoid any multi-threaded locking. Otherwise leave the @code{FILE} 1376pointer unchanged. If the @var{stream} is @code{NULL} do nothing. 1377 1378@end deftypefn 1379 1380@c vasprintf.c:47 1381@deftypefn Extension int vasprintf (char **@var{resptr}, const char *@var{format}, va_list @var{args}) 1382 1383Like @code{vsprintf}, but instead of passing a pointer to a buffer, 1384you pass a pointer to a pointer. This function will compute the size 1385of the buffer needed, allocate memory with @code{malloc}, and store a 1386pointer to the allocated memory in @code{*@var{resptr}}. The value 1387returned is the same as @code{vsprintf} would return. If memory could 1388not be allocated, minus one is returned and @code{NULL} is stored in 1389@code{*@var{resptr}}. 1390 1391@end deftypefn 1392 1393@c vfork.c:6 1394@deftypefn Supplemental int vfork (void) 1395 1396Emulates @code{vfork} by calling @code{fork} and returning its value. 1397 1398@end deftypefn 1399 1400@c vprintf.c:3 1401@deftypefn Supplemental int vprintf (const char *@var{format}, va_list @var{ap}) 1402@deftypefnx Supplemental int vfprintf (FILE *@var{stream}, const char *@var{format}, va_list @var{ap}) 1403@deftypefnx Supplemental int vsprintf (char *@var{str}, const char *@var{format}, va_list @var{ap}) 1404 1405These functions are the same as @code{printf}, @code{fprintf}, and 1406@code{sprintf}, respectively, except that they are called with a 1407@code{va_list} instead of a variable number of arguments. Note that 1408they do not call @code{va_end}; this is the application's 1409responsibility. In @libib{} they are implemented in terms of the 1410nonstandard but common function @code{_doprnt}. 1411 1412@end deftypefn 1413 1414@c vsnprintf.c:28 1415@deftypefn Supplemental int vsnprintf (char *@var{buf}, size_t @var{n}, const char *@var{format}, va_list @var{ap}) 1416 1417This function is similar to vsprintf, but it will print at most 1418@var{n} characters. On error the return value is -1, otherwise it 1419returns the number of characters that would have been printed had 1420@var{n} been sufficiently large, regardless of the actual value of 1421@var{n}. Note some pre-C99 system libraries do not implement this 1422correctly so users cannot generally rely on the return value if the 1423system version of this function is used. 1424 1425@end deftypefn 1426 1427@c waitpid.c:3 1428@deftypefn Supplemental int waitpid (int @var{pid}, int *@var{status}, int) 1429 1430This is a wrapper around the @code{wait} function. Any ``special'' 1431values of @var{pid} depend on your implementation of @code{wait}, as 1432does the return value. The third argument is unused in @libib{}. 1433 1434@end deftypefn 1435 1436@c xatexit.c:11 1437@deftypefun int xatexit (void (*@var{fn}) (void)) 1438 1439Behaves as the standard @code{atexit} function, but with no limit on 1440the number of registered functions. Returns 0 on success, or @minus{}1 on 1441failure. If you use @code{xatexit} to register functions, you must use 1442@code{xexit} to terminate your program. 1443 1444@end deftypefun 1445 1446@c xmalloc.c:38 1447@deftypefn Replacement void* xcalloc (size_t @var{nelem}, size_t @var{elsize}) 1448 1449Allocate memory without fail, and set it to zero. This routine functions 1450like @code{calloc}, but will behave the same as @code{xmalloc} if memory 1451cannot be found. 1452 1453@end deftypefn 1454 1455@c xexit.c:22 1456@deftypefn Replacement void xexit (int @var{code}) 1457 1458Terminates the program. If any functions have been registered with 1459the @code{xatexit} replacement function, they will be called first. 1460Termination is handled via the system's normal @code{exit} call. 1461 1462@end deftypefn 1463 1464@c xmalloc.c:22 1465@deftypefn Replacement void* xmalloc (size_t) 1466 1467Allocate memory without fail. If @code{malloc} fails, this will print 1468a message to @code{stderr} (using the name set by 1469@code{xmalloc_set_program_name}, 1470if any) and then call @code{xexit}. Note that it is therefore safe for 1471a program to contain @code{#define malloc xmalloc} in its source. 1472 1473@end deftypefn 1474 1475@c xmalloc.c:53 1476@deftypefn Replacement void xmalloc_failed (size_t) 1477 1478This function is not meant to be called by client code, and is listed 1479here for completeness only. If any of the allocation routines fail, this 1480function will be called to print an error message and terminate execution. 1481 1482@end deftypefn 1483 1484@c xmalloc.c:46 1485@deftypefn Replacement void xmalloc_set_program_name (const char *@var{name}) 1486 1487You can use this to set the name of the program used by 1488@code{xmalloc_failed} when printing a failure message. 1489 1490@end deftypefn 1491 1492@c xmemdup.c:7 1493@deftypefn Replacement void* xmemdup (void *@var{input}, size_t @var{copy_size}, size_t @var{alloc_size}) 1494 1495Duplicates a region of memory without fail. First, @var{alloc_size} bytes 1496are allocated, then @var{copy_size} bytes from @var{input} are copied into 1497it, and the new memory is returned. If fewer bytes are copied than were 1498allocated, the remaining memory is zeroed. 1499 1500@end deftypefn 1501 1502@c xmalloc.c:32 1503@deftypefn Replacement void* xrealloc (void *@var{ptr}, size_t @var{size}) 1504Reallocate memory without fail. This routine functions like @code{realloc}, 1505but will behave the same as @code{xmalloc} if memory cannot be found. 1506 1507@end deftypefn 1508 1509@c xstrdup.c:7 1510@deftypefn Replacement char* xstrdup (const char *@var{s}) 1511 1512Duplicates a character string without fail, using @code{xmalloc} to 1513obtain memory. 1514 1515@end deftypefn 1516 1517@c xstrerror.c:7 1518@deftypefn Replacement char* xstrerror (int @var{errnum}) 1519 1520Behaves exactly like the standard @code{strerror} function, but 1521will never return a @code{NULL} pointer. 1522 1523@end deftypefn 1524 1525@c xstrndup.c:23 1526@deftypefn Replacement char* xstrndup (const char *@var{s}, size_t @var{n}) 1527 1528Returns a pointer to a copy of @var{s} with at most @var{n} characters 1529without fail, using @code{xmalloc} to obtain memory. The result is 1530always NUL terminated. 1531 1532@end deftypefn 1533 1534 1535