CbC/CbC_gcc: libiberty/functions.texi comparison

comparison libiberty/functions.texi @ 67:f6334be47118

update gcc from gcc-4.6-20100522 to gcc-4.6-20110318

author	nobuyasu <dimolto@cr.ie.u-ryukyu.ac.jp>
date	Tue, 22 Mar 2011 17:18:12 +0900
parents	77e2b8dfacca
children	04ced10e8804

comparison

equal deleted inserted replaced

-:65488c3d617d
+:f6334be47118
 @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 run 'make stamp-functions' and gather-docs will build a new copy.
-@c safe-ctype.c:25
-@defvr Extension HOST_CHARSET
-This macro indicates the basic character set and encoding used by the
-host: more precisely, the encoding used for character constants in
-preprocessor @samp{#if} statements (the C "execution character set").
-It is defined by @file{safe-ctype.h}, and will be an integer constant
-with one of the following values:
-@ftable @code
-@item HOST_CHARSET_UNKNOWN
-The host character set is unknown - that is, not one of the next two
-possibilities.
-@item HOST_CHARSET_ASCII
-The host character set is ASCII.
-@item HOST_CHARSET_EBCDIC
-The host character set is some variant of EBCDIC.  (Only one of the
-nineteen EBCDIC varying characters is tested; exercise caution.)
-@end ftable
-@end defvr
 @c alloca.c:26
 @deftypefn Replacement void* alloca (size_t @var{size})
 This function allocates memory which will be automatically reclaimed
 @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 *))
+@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}
 This function is provided for backwards compatibility only.  Its use is
 not recommended.
 @end deftypefn
-@c make-temp-file.c:95
+@c make-temp-file.c:96
 @deftypefn Replacement char* choose_tmpdir ()
 Returns a pointer to a directory path suitable for creating temporary
 files in.
 number of seconds used.
 @end deftypefn
 @c concat.c:24
-@deftypefn Extension char* concat (const char *@var{s1}, const char *@var{s2}, @dots{}, @code{NULL})
+@deftypefn Extension char* concat (const char *@var{s1}, const char *@var{s2}, @
+@dots{}, @code{NULL})
 Concatenate zero or more of strings and return the result in freshly
 @code{xmalloc}ed memory.  Returns @code{NULL} if insufficient memory is
 available.  The argument list is terminated by the first @code{NULL}
 pointer encountered.  Pointers to empty strings are ignored.
 @end deftypefn
 @c crc32.c:141
-@deftypefn Extension unsigned int crc32 (const unsigned char *@var{buf}, int @var{len}, unsigned int @var{init})
+@deftypefn Extension {unsigned int} crc32 (const unsigned char *@var{buf}, @
+int @var{len}, unsigned int @var{init})
 Compute the 32-bit CRC of @var{buf} which has length @var{len}.  The
 starting value is @var{init}; this may be used to compute the CRC of
 data split across multiple buffers by passing the return value of each
 call as the @var{init} parameter of the next.
 for a match, which is done by comparing major and minor device numbers
 and inode numbers.
 @end deftypefn
-@c fopen_unlocked.c:48
+@c fopen_unlocked.c:49
-@deftypefn Extension {FILE *} fdopen_unlocked (int @var{fildes}, const char * @var{mode})
+@deftypefn Extension {FILE *} fdopen_unlocked (int @var{fildes}, @
+const char * @var{mode})
 Opens and returns a @code{FILE} pointer via @code{fdopen}.  If the
 operating system supports it, ensure that the stream is setup to avoid
 any multi-threaded locking.  Otherwise return the @code{FILE} pointer
 unchanged.
 However, it does handle the fact that on DOS-like file systems, forward
 and backward slashes are equal.
 @end deftypefn
+@c filename_cmp.c:81
+@deftypefn Extension int filename_ncmp (const char *@var{s1}, const char *@var{s2}, size_t @var{n})
+Return zero if the two file names @var{s1} and @var{s2} are equivalent
+in range @var{n}.
+If not equivalent, the returned value is similar to what @code{strncmp}
+would return.  In other words, it returns a negative value if @var{s1}
+is less than @var{s2}, or a positive value if @var{s2} is greater than
+@var{s2}.
+This function does not normalize file names.  As a result, this function
+will treat filenames that are spelled differently as different even in
+the case when the two filenames point to the same underlying file.
+However, it does handle the fact that on DOS-like file systems, forward
+and backward slashes are equal.
+@end deftypefn
 @c fnmatch.txh:1
-@deftypefn Replacement int fnmatch (const char *@var{pattern}, const char *@var{string}, int @var{flags})
+@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
 @end table
 @end deftypefn
 @c fopen_unlocked.c:39
-@deftypefn Extension {FILE *} fopen_unlocked (const char *@var{path}, const char * @var{mode})
+@deftypefn Extension {FILE *} fopen_unlocked (const char *@var{path}, @
+const char * @var{mode})
 Opens and returns a @code{FILE} pointer via @code{fopen}.  If the
 operating system supports it, ensure that the stream is setup to avoid
 any multi-threaded locking.  Otherwise return the @code{FILE} pointer
 unchanged.
 the terminating @code{NULL} is found, and then frees @var{vector}
 itself.
 @end deftypefn
-@c fopen_unlocked.c:57
+@c fopen_unlocked.c:59
-@deftypefn Extension {FILE *} freopen_unlocked (const char * @var{path}, const char * @var{mode}, FILE * @var{stream})
+@deftypefn Extension {FILE *} freopen_unlocked (const char * @var{path}, @
+const char * @var{mode}, FILE * @var{stream})
 Opens and returns a @code{FILE} pointer via @code{freopen}.  If the
 operating system supports it, ensure that the stream is setup to avoid
 any multi-threaded locking.  Otherwise return the @code{FILE} pointer
 unchanged.
 converted to a wider unsigned type --- like @code{bfd_vma}, on some
 systems.
 @end deftypefn
+@c safe-ctype.c:25
+@defvr Extension HOST_CHARSET
+This macro indicates the basic character set and encoding used by the
+host: more precisely, the encoding used for character constants in
+preprocessor @samp{#if} statements (the C "execution character set").
+It is defined by @file{safe-ctype.h}, and will be an integer constant
+with one of the following values:
+@ftable @code
+@item HOST_CHARSET_UNKNOWN
+The host character set is unknown - that is, not one of the next two
+possibilities.
+@item HOST_CHARSET_ASCII
+The host character set is ASCII.
+@item HOST_CHARSET_EBCDIC
+The host character set is some variant of EBCDIC.  (Only one of the
+nineteen EBCDIC varying characters is tested; exercise caution.)
+@end ftable
+@end defvr
+@c hashtab.c:336
+@deftypefn Supplemental htab_t htab_create_typed_alloc (size_t @var{size}, @
+htab_hash @var{hash_f}, htab_eq @var{eq_f}, htab_del @var{del_f}, @
+htab_alloc @var{alloc_tab_f}, htab_alloc @var{alloc_f}, @
+htab_free @var{free_f})
+This function creates a hash table that uses two different allocators
+@var{alloc_tab_f} and @var{alloc_f} to use for allocating the table itself
+and its entries respectively.  This is useful when variables of different
+types need to be allocated with different allocators.
+The created hash table is slightly larger than @var{size} and it is
+initially empty (all the hash table entries are @code{HTAB_EMPTY_ENTRY}).
+The function returns the created hash table, or @code{NULL} if memory
+allocation fails.
+@end deftypefn
 @c index.c:5
 @deftypefn Supplemental char* index (char *@var{s}, int @var{c})
 Returns a pointer to the first occurrence of the character @var{c} in
 the string @var{s}, or @code{NULL} if not found.  The use of @code{index} is
 deprecated in new programs in favor of @code{strchr}.
 @end deftypefn
 @c insque.c:6
-@deftypefn Supplemental void insque (struct qelem *@var{elem}, struct qelem *@var{pred})
+@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
 @code{malloc}, or @code{NULL} will be returned on a memory allocation error.
 @end deftypefn
 @c make-relative-prefix.c:24
-@deftypefn Extension {const char*} make_relative_prefix (const char *@var{progname}, const char *@var{bin_prefix}, const char *@var{prefix})
+@deftypefn Extension {const char*} make_relative_prefix (const char *@var{progname}, @
+const char *@var{bin_prefix}, const char *@var{prefix})
 Given three paths @var{progname}, @var{bin_prefix}, @var{prefix},
 return the path that is in the same position relative to
 @var{progname}'s directory as @var{prefix} is relative to
 @var{bin_prefix}.  That is, a string starting with the directory
 The return value is normally allocated via @code{malloc}.  If no
 relative prefix can be found, return @code{NULL}.
 @end deftypefn
-@c make-temp-file.c:168
+@c make-temp-file.c:174
 @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
 string is @code{malloc}ed, and the temporary file has been created.
 @end deftypefn
 @c memchr.c:3
-@deftypefn Supplemental void* memchr (const void *@var{s}, int @var{c}, size_t @var{n})
+@deftypefn Supplemental void* memchr (const void *@var{s}, int @var{c}, @
+size_t @var{n})
 This function searches memory starting at @code{*@var{s}} for the
 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
 returned.
 @end deftypefn
 @c memcmp.c:6
-@deftypefn Supplemental int memcmp (const void *@var{x}, const void *@var{y}, size_t @var{count})
+@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})
+@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 memmem.c:20
-@deftypefn Supplemental void* memmem (const void *@var{haystack}, size_t @var{haystack_len} const void *@var{needle}, size_t @var{needle_len})
+@deftypefn Supplemental void* memmem (const void *@var{haystack}, @
+size_t @var{haystack_len} const void *@var{needle}, size_t @var{needle_len})
 Returns a pointer to the first occurrence of @var{needle} (length
 @var{needle_len}) in @var{haystack} (length @var{haystack_len}).
 Returns @code{NULL} if not found.
 @end deftypefn
 @c memmove.c:6
-@deftypefn Supplemental void* memmove (void *@var{from}, const void *@var{to}, size_t @var{count})
+@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 mempcpy.c:23
-@deftypefn Supplemental void* mempcpy (void *@var{out}, const void *@var{in}, size_t @var{length})
+@deftypefn Supplemental void* mempcpy (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} + @var{length}.
 @end deftypefn
 @c memset.c:6
-@deftypefn Supplemental void* memset (void *@var{s}, int @var{c}, size_t @var{count})
+@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
 filename unique.  Returns a file descriptor open on the file for
 reading and writing.
 @end deftypefn
-@c pexecute.txh:266
+@c pexecute.txh:278
 @deftypefn Extension void pex_free (struct pex_obj @var{obj})
 Clean up and free all data associated with @var{obj}.  If you have not
 yet called @code{pex_get_times} or @code{pex_get_status}, this will
 try to kill the subprocesses.
 @end deftypefn
-@c pexecute.txh:241
+@c pexecute.txh:251
-@deftypefn Extension int pex_get_status (struct pex_obj *@var{obj}, int @var{count}, int *@var{vector})
+@deftypefn Extension int pex_get_status (struct pex_obj *@var{obj}, @
+int @var{count}, int *@var{vector})
 Returns the exit status of all programs run using @var{obj}.
 @var{count} is the number of results expected.  The results will be
 placed into @var{vector}.  The results are in the order of the calls
 to @code{pex_run}.  Returns 0 on error, 1 on success.
 @end deftypefn
-@c pexecute.txh:250
+@c pexecute.txh:261
-@deftypefn Extension int pex_get_times (struct pex_obj *@var{obj}, int @var{count}, struct pex_time *@var{vector})
+@deftypefn Extension int pex_get_times (struct pex_obj *@var{obj}, @
+int @var{count}, struct pex_time *@var{vector})
 Returns the process execution times of all programs run using
 @var{obj}.  @var{count} is the number of results expected.  The
 results will be placed into @var{vector}.  The results are in the
 order of the calls to @code{pex_run}.  Returns 0 on error, 1 on
 process times, all the fields will be set to @code{0}.
 @end deftypefn
 @c pexecute.txh:2
-@deftypefn Extension {struct pex_obj *} pex_init (int @var{flags}, const char *@var{pname}, const char *@var{tempbase})
+@deftypefn Extension {struct pex_obj *} pex_init (int @var{flags}, @
+const char *@var{pname}, const char *@var{tempbase})
 Prepare to execute one or more programs, with standard output of each
 program fed to standard input of the next.  This is a system
 independent interface to execute a pipeline.
 messages.  @var{tempbase} is a base name to use for any required
 temporary files; it may be @code{NULL} to use a randomly chosen name.
 @end deftypefn
-@c pexecute.txh:155
+@c pexecute.txh:161
-@deftypefn Extension {FILE *} pex_input_file (struct pex_obj *@var{obj}, int @var{flags}, const char *@var{in_name})
+@deftypefn Extension {FILE *} pex_input_file (struct pex_obj *@var{obj}, @
+int @var{flags}, const char *@var{in_name})
 Return a stream for a temporary file to pass to the first program in
 the pipeline as input.
 The name of the input file is chosen according to the same rules
 If @var{flags} includes @code{PEX_BINARY_OUTPUT}, open the stream in
 binary mode; otherwise, open it in the default mode.  Including
 @code{PEX_BINARY_OUTPUT} in @var{flags} has no effect on Unix.
 @end deftypefn
-@c pexecute.txh:172
+@c pexecute.txh:179
-@deftypefn Extension {FILE *} pex_input_pipe (struct pex_obj *@var{obj}, int @var{binary})
+@deftypefn Extension {FILE *} pex_input_pipe (struct pex_obj *@var{obj}, @
+int @var{binary})
 Return a stream @var{fp} for a pipe connected to the standard input of
 the first program in the pipeline; @var{fp} is opened for writing.
 You must have passed @code{PEX_USE_PIPES} to the @code{pex_init} call
 that returned @var{obj}.
 @end itemize
 @end deftypefn
-@c pexecute.txh:274
+@c pexecute.txh:286
-@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})
+@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})
 An interface to permit the easy execution of a
 single program.  The return value and most of the parameters are as
 for a call to @code{pex_run}.  @var{flags} is restricted to a
 combination of @code{PEX_SEARCH}, @code{PEX_STDERR_TO_STDOUT}, and
 @code{PEX_LAST} were set.  On a successful return, @code{*@var{status}} will
 be set to the exit status of the program.
 @end deftypefn
-@c pexecute.txh:228
+@c pexecute.txh:237
-@deftypefn Extension {FILE *} pex_read_err (struct pex_obj *@var{obj}, int @var{binary})
+@deftypefn Extension {FILE *} pex_read_err (struct pex_obj *@var{obj}, @
+int @var{binary})
 Returns a @code{FILE} pointer which may be used to read the standard
 error of the last program in the pipeline.  When this is used,
 @code{PEX_LAST} should not be used in a call to @code{pex_run}.  After
 this is called, @code{pex_run} may no longer be called with the same
 opened in binary mode.  Don't call @code{fclose} on the returned file;
 it will be closed by @code{pex_free}.
 @end deftypefn
-@c pexecute.txh:216
+@c pexecute.txh:224
-@deftypefn Extension {FILE *} pex_read_output (struct pex_obj *@var{obj}, int @var{binary})
+@deftypefn Extension {FILE *} pex_read_output (struct pex_obj *@var{obj}, @
+int @var{binary})
 Returns a @code{FILE} pointer which may be used to read the standard
 output of the last program in the pipeline.  When this is used,
 @code{PEX_LAST} should not be used in a call to @code{pex_run}.  After
 this is called, @code{pex_run} may no longer be called with the same
 opened in binary mode.  Don't call @code{fclose} on the returned file;
 it will be closed by @code{pex_free}.
 @end deftypefn
-@c pexecute.txh:33
+@c pexecute.txh:34
-@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})
+@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})
 Execute one program in a pipeline.  On success this returns
 @code{NULL}.  On failure it returns an error message, a statically
 allocated string.
 On an error return, the code sets @code{*@var{err}} to an @code{errno}
 value, or to 0 if there is no relevant @code{errno}.
 @end deftypefn
-@c pexecute.txh:142
+@c pexecute.txh:145
-@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})
+@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})
 Execute one program in a pipeline, permitting the environment for the
 program to be specified.  Behaviour and parameters not listed below are
 as for @code{pex_run}.
 form @code{VAR=VALUE}, with the exception of the last element that must be
 @code{NULL}.
 @end deftypefn
-@c pexecute.txh:286
+@c pexecute.txh:301
-@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 @var{flags})
+@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 @var{flags})
 This is the old interface to execute one or more programs.  It is
 still supported for compatibility purposes, but is no longer
 documented.
 @samp{name=value} the string is added; if no @samp{=} is present the
 name is unset/removed.
 @end deftypefn
-@c pexecute.txh:294
+@c pexecute.txh:312
 @deftypefn Extension int pwait (int @var{pid}, int *@var{status}, int @var{flags})
 Another part of the old execution interface.
 @end deftypefn
 @c random.c:39
 @deftypefn Supplement {long int} random (void)
 @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* 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
 range 0 to @code{LONG_MAX}.  @code{srandom} initializes the random
 number generator to some starting point determined by @var{seed}
 run of the program).  @code{initstate} and @code{setstate} allow fine-grained
 control over the state of the random number generator.
 @end deftypefn
-@c concat.c:173
+@c concat.c:174
-@deftypefn Extension char* reconcat (char *@var{optr}, const char *@var{s1}, @dots{}, @code{NULL})
+@deftypefn Extension char* reconcat (char *@var{optr}, const char *@var{s1}, @
+@dots{}, @code{NULL})
 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:
 the string @var{s}, or @code{NULL} if not found.  The use of @code{rindex} is
 deprecated in new programs in favor of @code{strrchr}.
 @end deftypefn
-@c setenv.c:22
+@c setenv.c:23
-@deftypefn Supplemental int setenv (const char *@var{name}, const char *@var{value}, int @var{overwrite})
+@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,
 the new value will be stored only if @var{overwrite} is nonzero.
 The companion @code{unsetenv} function removes @var{name} from the
 environment.  This implementation is not safe for multithreaded code.
+@end deftypefn
+@c setproctitle.c:31
+@deftypefn Supplemental void setproctitle (const char *@var{fmt}, ...)
+Set the title of a process to @var{fmt}. va args not supported for now,
+but defined for compatibility with BSD.
 @end deftypefn
 @c strsignal.c:348
 @deftypefn Extension int signo_max (void)
 the old mask (which, for libiberty's implementation, will always
 be the value @code{1}).
 @end deftypefn
+@c simple-object.txh:96
+@deftypefn Extension {const char *} simple_object_attributes_compare @
+(simple_object_attributes *@var{attrs1}, simple_object_attributes *@var{attrs2}, @
+int *@var{err})
+Compare @var{attrs1} and @var{attrs2}.  If they could be linked
+together without error, return @code{NULL}.  Otherwise, return an
+error message and set @code{*@var{err}} to an errno value or @code{0}
+if there is no relevant errno.
+@end deftypefn
+@c simple-object.txh:81
+@deftypefn Extension {simple_object_attributes *} simple_object_fetch_attributes @
+(simple_object_read *@var{simple_object}, const char **@var{errmsg}, int *@var{err})
+Fetch the attributes of @var{simple_object}.  The attributes are
+internal information such as the format of the object file, or the
+architecture it was compiled for.  This information will persist until
+@code{simple_object_attributes_release} is called, even if
+@var{simple_object} itself is released.
+On error this returns @code{NULL}, sets @code{*@var{errmsg}} to an
+error message, and sets @code{*@var{err}} to an errno value or
+@code{0} if there is no relevant errno.
+@end deftypefn
+@c simple-object.txh:49
+@deftypefn Extension {int} simple_object_find_section @
+(simple_object_read *@var{simple_object} off_t *@var{offset}, @
+off_t *@var{length}, const char **@var{errmsg}, int *@var{err})
+Look for the section @var{name} in @var{simple_object}.  This returns
+information for the first section with that name.
+If found, return 1 and set @code{*@var{offset}} to the offset in the
+file of the section contents and set @code{*@var{length}} to the
+length of the section contents.  The value in @code{*@var{offset}}
+will be relative to the offset passed to
+@code{simple_object_open_read}.
+If the section is not found, and no error occurs,
+@code{simple_object_find_section} returns @code{0} and set
+@code{*@var{errmsg}} to @code{NULL}.
+If an error occurs, @code{simple_object_find_section} returns
+@code{0}, sets @code{*@var{errmsg}} to an error message, and sets
+@code{*@var{err}} to an errno value or @code{0} if there is no
+relevant errno.
+@end deftypefn
+@c simple-object.txh:27
+@deftypefn Extension {const char *} simple_object_find_sections @
+(simple_object_read *@var{simple_object}, int (*@var{pfn}) (void *@var{data}, @
+const char *@var{name}, off_t @var{offset}, off_t @var{length}), @
+void *@var{data}, int *@var{err})
+This function calls @var{pfn} for each section in @var{simple_object}.
+It calls @var{pfn} with the section name, the offset within the file
+of the section contents, and the length of the section contents.  The
+offset within the file is relative to the offset passed to
+@code{simple_object_open_read}.  The @var{data} argument to this
+function is passed along to @var{pfn}.
+If @var{pfn} returns @code{0}, the loop over the sections stops and
+@code{simple_object_find_sections} returns.  If @var{pfn} returns some
+other value, the loop continues.
+On success @code{simple_object_find_sections} returns.  On error it
+returns an error string, and sets @code{*@var{err}} to an errno value
+or @code{0} if there is no relevant errno.
+@end deftypefn
+@c simple-object.txh:2
+@deftypefn Extension {simple_object_read *} simple_object_open_read @
+(int @var{descriptor}, off_t @var{offset}, const char *{segment_name}, @
+const char **@var{errmsg}, int *@var{err})
+Opens an object file for reading.  Creates and returns an
+@code{simple_object_read} pointer which may be passed to other
+functions to extract data from the object file.
+@var{descriptor} holds a file descriptor which permits reading.
+@var{offset} is the offset into the file; this will be @code{0} in the
+normal case, but may be a different value when reading an object file
+in an archive file.
+@var{segment_name} is only used with the Mach-O file format used on
+Darwin aka Mac OS X.  It is required on that platform, and means to
+only look at sections within the segment with that name.  The
+parameter is ignored on other systems.
+If an error occurs, this functions returns @code{NULL} and sets
+@code{*@var{errmsg}} to an error string and sets @code{*@var{err}} to
+an errno value or @code{0} if there is no relevant errno.
+@end deftypefn
+@c simple-object.txh:107
+@deftypefn Extension {void} simple_object_release_attributes @
+(simple_object_attributes *@var{attrs})
+Release all resources associated with @var{attrs}.
+@end deftypefn
+@c simple-object.txh:73
+@deftypefn Extension {void} simple_object_release_read @
+(simple_object_read *@var{simple_object})
+Release all resources associated with @var{simple_object}.  This does
+not close the file descriptor.
+@end deftypefn
+@c simple-object.txh:184
+@deftypefn Extension {void} simple_object_release_write @
+(simple_object_write *@var{simple_object})
+Release all resources associated with @var{simple_object}.
+@end deftypefn
+@c simple-object.txh:114
+@deftypefn Extension {simple_object_write *} simple_object_start_write @
+(simple_object_attributes @var{attrs}, const char *@var{segment_name}, @
+const char **@var{errmsg}, int *@var{err})
+Start creating a new object file using the object file format
+described in @var{attrs}.  You must fetch attribute information from
+an existing object file before you can create a new one.  There is
+currently no support for creating an object file de novo.
+@var{segment_name} is only used with Mach-O as found on Darwin aka Mac
+OS X.  The parameter is required on that target.  It means that all
+sections are created within the named segment.  It is ignored for
+other object file formats.
+On error @code{simple_object_start_write} returns @code{NULL}, sets
+@code{*@var{ERRMSG}} to an error message, and sets @code{*@var{err}}
+to an errno value or @code{0} if there is no relevant errno.
+@end deftypefn
+@c simple-object.txh:153
+@deftypefn Extension {const char *} simple_object_write_add_data @
+(simple_object_write *@var{simple_object}, @
+simple_object_write_section *@var{section}, const void *@var{buffer}, @
+size_t @var{size}, int @var{copy}, int *@var{err})
+Add data @var{buffer}/@var{size} to @var{section} in
+@var{simple_object}.  If @var{copy} is non-zero, the data will be
+copied into memory if necessary.  If @var{copy} is zero, @var{buffer}
+must persist until @code{simple_object_write_to_file} is called.  is
+released.
+On success this returns @code{NULL}.  On error this returns an error
+message, and sets @code{*@var{err}} to an errno value or 0 if there is
+no relevant erro.
+@end deftypefn
+@c simple-object.txh:134
+@deftypefn Extension {simple_object_write_section *} simple_object_write_create_section @
+(simple_object_write *@var{simple_object}, const char *@var{name}, @
+unsigned int @var{align}, const char **@var{errmsg}, int *@var{err})
+Add a section to @var{simple_object}.  @var{name} is the name of the
+new section.  @var{align} is the required alignment expressed as the
+number of required low-order 0 bits (e.g., 2 for alignment to a 32-bit
+boundary).
+The section is created as containing data, readable, not writable, not
+executable, not loaded at runtime.  The section is not written to the
+file until @code{simple_object_write_to_file} is called.
+On error this returns @code{NULL}, sets @code{*@var{errmsg}} to an
+error message, and sets @code{*@var{err}} to an errno value or
+@code{0} if there is no relevant errno.
+@end deftypefn
+@c simple-object.txh:170
+@deftypefn Extension {const char *} simple_object_write_to_file @
+(simple_object_write *@var{simple_object}, int @var{descriptor}, int *@var{err})
+Write the complete object file to @var{descriptor}, an open file
+descriptor.  This writes out all the data accumulated by calls to
+@code{simple_object_write_create_section} and
+@var{simple_object_write_add_data}.
+This returns @code{NULL} on success.  On error this returns an error
+message and sets @code{*@var{err}} to an errno value or @code{0} if
+there is no relevant errno.
+@end deftypefn
 @c snprintf.c:28
-@deftypefn Supplemental int snprintf (char *@var{buf}, size_t @var{n}, const char *@var{format}, ...)
+@deftypefn Supplemental int snprintf (char *@var{buf}, size_t @var{n}, @
+const char *@var{format}, ...)
 This function is similar to @code{sprintf}, but it will write to
 @var{buf} at most @code{@var{n}-1} bytes of text, followed by a
 terminating null byte, for a total of @var{n} bytes.
 On error the return value is -1, otherwise it returns the number of
 number of spaces and null terminated.  The returned pointer is
 valid until at least the next call.
 @end deftypefn
+@c splay-tree.c:303
+@deftypefn Supplemental splay_tree splay_tree_new_with_typed_alloc @
+(splay_tree_compare_fn @var{compare_fn}, @
+splay_tree_delete_key_fn @var{delete_key_fn}, @
+splay_tree_delete_value_fn @var{delete_value_fn}, @
+splay_tree_allocate_fn @var{tree_allocate_fn}, @
+splay_tree_allocate_fn @var{node_allocate_fn}, @
+splay_tree_deallocate_fn @var{deallocate_fn}, @
+void * @var{allocate_data})
+This function creates a splay tree that uses two different allocators
+@var{tree_allocate_fn} and @var{node_allocate_fn} to use for allocating the
+tree itself and its nodes respectively.  This is useful when variables of
+different types need to be allocated with different allocators.
+The splay tree will use @var{compare_fn} to compare nodes,
+@var{delete_key_fn} to deallocate keys, and @var{delete_value_fn} to
+deallocate values.
+@end deftypefn
 @c stpcpy.c:23
 @deftypefn Supplemental char* stpcpy (char *@var{dst}, const char *@var{src})
 Copies the string @var{src} into @var{dst}.  Returns a pointer to
 @var{dst} + strlen(@var{src}).
 @end deftypefn
 @c stpncpy.c:23
-@deftypefn Supplemental char* stpncpy (char *@var{dst}, const char *@var{src}, size_t @var{len})
+@deftypefn Supplemental char* stpncpy (char *@var{dst}, const char *@var{src}, @
+size_t @var{len})
 Copies the string @var{src} into @var{dst}, copying exactly @var{len}
 and padding with zeros if necessary.  If @var{len} < strlen(@var{src})
 then return @var{dst} + @var{len}, otherwise returns @var{dst} +
 strlen(@var{src}).
 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})
+@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
 length, the function returns @var{string}.
 @end deftypefn
 @c strtod.c:27
-@deftypefn Supplemental double strtod (const char *@var{string}, char **@var{endptr})
+@deftypefn Supplemental double strtod (const char *@var{string}, @
+char **@var{endptr})
 This ISO C function converts the initial portion of @var{string} to a
 @code{double}.  If @var{endptr} is not @code{NULL}, a pointer to the
 character after the last character used in the conversion is stored in
 the location referenced by @var{endptr}.  If no conversion is
 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})
+@deftypefn Supplemental {long int} strtol (const char *@var{string}, @
-@deftypefnx Supplemental {unsigned long int} strtoul (const char *@var{string}, char **@var{endptr}, int @var{base})
+char **@var{endptr}, int @var{base})
+@deftypefnx Supplemental {unsigned long int} strtoul (const char *@var{string}, @
+char **@var{endptr}, int @var{base})
 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}
 pointer unchanged.  If the @var{stream} is @code{NULL} do nothing.
 @end deftypefn
 @c vasprintf.c:47
-@deftypefn Extension int vasprintf (char **@var{resptr}, const char *@var{format}, va_list @var{args})
+@deftypefn Extension int vasprintf (char **@var{resptr}, @
+const char *@var{format}, va_list @var{args})
 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
 @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 vfprintf (FILE *@var{stream}, @
-@deftypefnx Supplemental int vsprintf (char *@var{str}, const char *@var{format}, va_list @var{ap})
+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
 nonstandard but common function @code{_doprnt}.
 @end deftypefn
 @c vsnprintf.c:28
-@deftypefn Supplemental int vsnprintf (char *@var{buf}, size_t @var{n}, const char *@var{format}, va_list @var{ap})
+@deftypefn Supplemental int vsnprintf (char *@var{buf}, size_t @var{n}, @
+const char *@var{format}, va_list @var{ap})
 This function is similar to @code{vsprintf}, but it will write to
 @var{buf} at most @code{@var{n}-1} bytes of text, followed by a
 terminating null byte, for a total of @var{n} bytes.  On error the
 return value is -1, otherwise it returns the number of characters that
 @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})
+@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.

Mercurial > hg > CbC > CbC_gcc

comparison libiberty/functions.texi @ 67:f6334be47118