42b01c936897f05ca504d946c2bddac5ac772b5f
1 /* Function declarations for libiberty.
3 Copyright 2001 Free Software Foundation, Inc.
5 This program is free software; you can redistribute it and/or modify
6 it under the terms of the GNU General Public License as published by
7 the Free Software Foundation; either version 2, or (at your option)
10 This program is distributed in the hope that it will be useful,
11 but WITHOUT ANY WARRANTY; without even the implied warranty of
12 MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
13 GNU General Public License for more details.
15 You should have received a copy of the GNU General Public License
16 along with this program; if not, write to the Free Software
17 Foundation, Inc., 59 Temple Place - Suite 330,
18 Boston, MA 02111-1307, USA.
20 Written by Cygnus Support, 1994.
22 The libiberty library provides a number of functions which are
23 missing on some operating systems. We do not declare those here,
24 to avoid conflicts with the system header files on operating
25 systems that do support those functions. In this file we only
26 declare those functions which are specific to libiberty. */
37 #ifdef ANSI_PROTOTYPES
38 /* Get a definition for size_t. */
40 /* Get a definition for va_list. */
44 /* Build an argument vector from a string. Allocates memory using
45 malloc. Use freeargv to free the vector. */
47 extern char **buildargv
PARAMS ((char *)) ATTRIBUTE_MALLOC
;
49 /* Free a vector returned by buildargv. */
51 extern void freeargv
PARAMS ((char **));
53 /* Duplicate an argument vector. Allocates memory using malloc. Use
54 freeargv to free the vector. */
56 extern char **dupargv
PARAMS ((char **)) ATTRIBUTE_MALLOC
;
59 /* Return the last component of a path name. Note that we can't use a
60 prototype here because the parameter is declared inconsistently
61 across different systems, sometimes as "char *" and sometimes as
64 /* HAVE_DECL_* is a three-state macro: undefined, 0 or 1. If it is
65 undefined, we haven't run the autoconf check so provide the
66 declaration without arguments. If it is 0, we checked and failed
67 to find the declaration so provide a fully prototyped one. If it
68 is 1, we found it so don't provide any declaration at all. */
69 #if defined (__GNU_LIBRARY__ ) || defined (__linux__) || defined (__FreeBSD__) || defined (__OpenBSD__) || defined (__CYGWIN__) || defined (__CYGWIN32__) || (defined (HAVE_DECL_BASENAME) && !HAVE_DECL_BASENAME)
70 extern char *basename
PARAMS ((const char *));
72 # if !defined (HAVE_DECL_BASENAME)
73 extern char *basename ();
77 /* A well-defined basename () that is always compiled in. */
79 extern char *lbasename
PARAMS ((const char *));
81 /* Concatenate an arbitrary number of strings, up to (char *) NULL.
82 Allocates memory using xmalloc. */
84 extern char *concat
PARAMS ((const char *, ...)) ATTRIBUTE_MALLOC
;
86 /* Check whether two file descriptors refer to the same file. */
88 extern int fdmatch
PARAMS ((int fd1
, int fd2
));
90 /* Get the working directory. The result is cached, so don't call
91 chdir() between calls to getpwd(). */
93 extern char * getpwd
PARAMS ((void));
95 /* Get the amount of time the process has run, in microseconds. */
97 extern long get_run_time
PARAMS ((void));
99 /* Choose a temporary directory to use for scratch files. */
101 extern char *choose_temp_base
PARAMS ((void)) ATTRIBUTE_MALLOC
;
103 /* Return a temporary file name or NULL if unable to create one. */
105 extern char *make_temp_file
PARAMS ((const char *)) ATTRIBUTE_MALLOC
;
107 /* Allocate memory filled with spaces. Allocates using malloc. */
109 extern const char *spaces
PARAMS ((int count
));
111 /* Return the maximum error number for which strerror will return a
114 extern int errno_max
PARAMS ((void));
116 /* Return the name of an errno value (e.g., strerrno (EINVAL) returns
119 extern const char *strerrno
PARAMS ((int));
121 /* Given the name of an errno value, return the value. */
123 extern int strtoerrno
PARAMS ((const char *));
125 /* ANSI's strerror(), but more robust. */
127 extern char *xstrerror
PARAMS ((int));
129 /* Return the maximum signal number for which strsignal will return a
132 extern int signo_max
PARAMS ((void));
134 /* Return a signal message string for a signal number
135 (e.g., strsignal (SIGHUP) returns something like "Hangup"). */
136 /* This is commented out as it can conflict with one in system headers.
137 We still document its existence though. */
139 /*extern const char *strsignal PARAMS ((int));*/
141 /* Return the name of a signal number (e.g., strsigno (SIGHUP) returns
144 extern const char *strsigno
PARAMS ((int));
146 /* Given the name of a signal, return its number. */
148 extern int strtosigno
PARAMS ((const char *));
150 /* Register a function to be run by xexit. Returns 0 on success. */
152 extern int xatexit
PARAMS ((void (*fn
) (void)));
154 /* Exit, calling all the functions registered with xatexit. */
156 extern void xexit
PARAMS ((int status
)) ATTRIBUTE_NORETURN
;
158 /* Set the program name used by xmalloc. */
160 extern void xmalloc_set_program_name
PARAMS ((const char *));
162 /* Report an allocation failure. */
163 extern void xmalloc_failed
PARAMS ((size_t)) ATTRIBUTE_NORETURN
;
165 /* Allocate memory without fail. If malloc fails, this will print a
166 message to stderr (using the name set by xmalloc_set_program_name,
167 if any) and then call xexit. */
169 extern PTR xmalloc
PARAMS ((size_t)) ATTRIBUTE_MALLOC
;
171 /* Reallocate memory without fail. This works like xmalloc. Note,
172 realloc type functions are not suitable for attribute malloc since
173 they may return the same address across multiple calls. */
175 extern PTR xrealloc
PARAMS ((PTR
, size_t));
177 /* Allocate memory without fail and set it to zero. This works like
180 extern PTR xcalloc
PARAMS ((size_t, size_t)) ATTRIBUTE_MALLOC
;
182 /* Copy a string into a memory buffer without fail. */
184 extern char *xstrdup
PARAMS ((const char *)) ATTRIBUTE_MALLOC
;
186 /* Copy an existing memory buffer to a new memory buffer without fail. */
188 extern PTR xmemdup
PARAMS ((const PTR
, size_t, size_t)) ATTRIBUTE_MALLOC
;
190 /* hex character manipulation routines */
192 #define _hex_array_size 256
194 extern char _hex_value
[_hex_array_size
];
195 extern void hex_init
PARAMS ((void));
196 #define hex_p(c) (hex_value (c) != _hex_bad)
197 /* If you change this, note well: Some code relies on side effects in
198 the argument being performed exactly once. */
199 #define hex_value(c) (_hex_value[(unsigned char) (c)])
201 /* Definitions used by the pexecute routine. */
203 #define PEXECUTE_FIRST 1
204 #define PEXECUTE_LAST 2
205 #define PEXECUTE_ONE (PEXECUTE_FIRST + PEXECUTE_LAST)
206 #define PEXECUTE_SEARCH 4
207 #define PEXECUTE_VERBOSE 8
209 /* Execute a program. */
211 extern int pexecute
PARAMS ((const char *, char * const *, const char *,
212 const char *, char **, char **, int));
214 /* Wait for pexecute to finish. */
216 extern int pwait
PARAMS ((int, int *, int));
218 /* Like sprintf but provides a pointer to malloc'd storage, which must
219 be freed by the caller. */
221 extern int asprintf
PARAMS ((char **, const char *, ...)) ATTRIBUTE_PRINTF_2
;
223 /* Like vsprintf but provides a pointer to malloc'd storage, which
224 must be freed by the caller. */
226 extern int vasprintf
PARAMS ((char **, const char *, va_list))
227 ATTRIBUTE_PRINTF(2,0);
229 #define ARRAY_SIZE(a) (sizeof (a) / sizeof ((a)[0]))
231 /* Drastically simplified alloca configurator. If we're using GCC,
232 we use __builtin_alloca; otherwise we use the C alloca. The C
233 alloca is always available. You can override GCC by defining
234 USE_C_ALLOCA yourself. */
235 extern PTR C_alloca
PARAMS((size_t));
237 #if GCC_VERSION >= 2000 && !defined USE_C_ALLOCA
238 # define alloca(x) __builtin_alloca(x)
240 # define alloca(x) C_alloca(x)
242 # define USE_C_ALLOCA 1
250 #endif /* ! defined (LIBIBERTY_H) */