43f1b7d401e7fcb937ddbf6b2f22e809cf5b9679
1 /* Function declarations for libiberty.
3 Copyright 2001 Free Software Foundation, Inc.
5 Note - certain prototypes declared in this header file are for
6 functions whoes implementation copyright does not belong to the
7 FSF. Those prototypes are present in this file for reference
8 purposes only and their presence in this file should not construed
9 as an indication of ownership by the FSF of the implementation of
10 those functions in any way or form whatsoever.
12 This program is free software; you can redistribute it and/or modify
13 it under the terms of the GNU General Public License as published by
14 the Free Software Foundation; either version 2, or (at your option)
17 This program is distributed in the hope that it will be useful,
18 but WITHOUT ANY WARRANTY; without even the implied warranty of
19 MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
20 GNU General Public License for more details.
22 You should have received a copy of the GNU General Public License
23 along with this program; if not, write to the Free Software
24 Foundation, Inc., 59 Temple Place - Suite 330,
25 Boston, MA 02111-1307, USA.
27 Written by Cygnus Support, 1994.
29 The libiberty library provides a number of functions which are
30 missing on some operating systems. We do not declare those here,
31 to avoid conflicts with the system header files on operating
32 systems that do support those functions. In this file we only
33 declare those functions which are specific to libiberty. */
44 #ifdef ANSI_PROTOTYPES
45 /* Get a definition for size_t. */
47 /* Get a definition for va_list. */
51 /* Build an argument vector from a string. Allocates memory using
52 malloc. Use freeargv to free the vector. */
54 extern char **buildargv
PARAMS ((char *)) ATTRIBUTE_MALLOC
;
56 /* Free a vector returned by buildargv. */
58 extern void freeargv
PARAMS ((char **));
60 /* Duplicate an argument vector. Allocates memory using malloc. Use
61 freeargv to free the vector. */
63 extern char **dupargv
PARAMS ((char **)) ATTRIBUTE_MALLOC
;
66 /* Return the last component of a path name. Note that we can't use a
67 prototype here because the parameter is declared inconsistently
68 across different systems, sometimes as "char *" and sometimes as
71 /* HAVE_DECL_* is a three-state macro: undefined, 0 or 1. If it is
72 undefined, we haven't run the autoconf check so provide the
73 declaration without arguments. If it is 0, we checked and failed
74 to find the declaration so provide a fully prototyped one. If it
75 is 1, we found it so don't provide any declaration at all. */
76 #if defined (__GNU_LIBRARY__ ) || defined (__linux__) || defined (__FreeBSD__) || defined (__OpenBSD__) || defined (__CYGWIN__) || defined (__CYGWIN32__) || (defined (HAVE_DECL_BASENAME) && !HAVE_DECL_BASENAME)
77 extern char *basename
PARAMS ((const char *));
79 # if !defined (HAVE_DECL_BASENAME)
80 extern char *basename ();
84 /* A well-defined basename () that is always compiled in. */
86 extern const char *lbasename
PARAMS ((const char *));
88 /* Concatenate an arbitrary number of strings, up to (char *) NULL.
89 Allocates memory using xmalloc. */
91 extern char *concat
PARAMS ((const char *, ...)) ATTRIBUTE_MALLOC
;
93 /* Determine the length of concatenating an arbitrary number of
94 strings, up to (char *) NULL. */
96 extern unsigned long concat_length
PARAMS ((const char *, ...));
98 /* Concatenate an arbitrary number of strings into a SUPPLIED area of
99 memory, up to (char *) NULL. The supplied memory is assumed to be
102 extern char *concat_copy
PARAMS ((char *, const char *, ...));
104 /* Concatenate an arbitrary number of strings into a GLOBAL area of
105 memory, up to (char *) NULL. The supplied memory is assumed to be
108 extern char *concat_copy2
PARAMS ((const char *, ...));
110 /* This is the global area used by concat_copy2. */
112 extern char *libiberty_concat_ptr
;
114 /* Concatenate an arbitrary number of strings, up to (char *) NULL.
115 Allocates memory using alloca. Arguments are evaluated twice!. */
116 #define ACONCAT(ACONCAT_PARAMS) \
117 (libiberty_concat_ptr = alloca (concat_length ACONCAT_PARAMS + 1), \
118 concat_copy2 ACONCAT_PARAMS)
120 /* Check whether two file descriptors refer to the same file. */
122 extern int fdmatch
PARAMS ((int fd1
, int fd2
));
124 /* Get the working directory. The result is cached, so don't call
125 chdir() between calls to getpwd(). */
127 extern char * getpwd
PARAMS ((void));
129 /* Get the amount of time the process has run, in microseconds. */
131 extern long get_run_time
PARAMS ((void));
133 /* Choose a temporary directory to use for scratch files. */
135 extern char *choose_temp_base
PARAMS ((void)) ATTRIBUTE_MALLOC
;
137 /* Return a temporary file name or NULL if unable to create one. */
139 extern char *make_temp_file
PARAMS ((const char *)) ATTRIBUTE_MALLOC
;
141 /* Allocate memory filled with spaces. Allocates using malloc. */
143 extern const char *spaces
PARAMS ((int count
));
145 /* Return the maximum error number for which strerror will return a
148 extern int errno_max
PARAMS ((void));
150 /* Return the name of an errno value (e.g., strerrno (EINVAL) returns
153 extern const char *strerrno
PARAMS ((int));
155 /* Given the name of an errno value, return the value. */
157 extern int strtoerrno
PARAMS ((const char *));
159 /* ANSI's strerror(), but more robust. */
161 extern char *xstrerror
PARAMS ((int));
163 /* Return the maximum signal number for which strsignal will return a
166 extern int signo_max
PARAMS ((void));
168 /* Return a signal message string for a signal number
169 (e.g., strsignal (SIGHUP) returns something like "Hangup"). */
170 /* This is commented out as it can conflict with one in system headers.
171 We still document its existence though. */
173 /*extern const char *strsignal PARAMS ((int));*/
175 /* Return the name of a signal number (e.g., strsigno (SIGHUP) returns
178 extern const char *strsigno
PARAMS ((int));
180 /* Given the name of a signal, return its number. */
182 extern int strtosigno
PARAMS ((const char *));
184 /* Register a function to be run by xexit. Returns 0 on success. */
186 extern int xatexit
PARAMS ((void (*fn
) (void)));
188 /* Exit, calling all the functions registered with xatexit. */
190 extern void xexit
PARAMS ((int status
)) ATTRIBUTE_NORETURN
;
192 /* Set the program name used by xmalloc. */
194 extern void xmalloc_set_program_name
PARAMS ((const char *));
196 /* Report an allocation failure. */
197 extern void xmalloc_failed
PARAMS ((size_t)) ATTRIBUTE_NORETURN
;
199 /* Allocate memory without fail. If malloc fails, this will print a
200 message to stderr (using the name set by xmalloc_set_program_name,
201 if any) and then call xexit. */
203 extern PTR xmalloc
PARAMS ((size_t)) ATTRIBUTE_MALLOC
;
205 /* Reallocate memory without fail. This works like xmalloc. Note,
206 realloc type functions are not suitable for attribute malloc since
207 they may return the same address across multiple calls. */
209 extern PTR xrealloc
PARAMS ((PTR
, size_t));
211 /* Allocate memory without fail and set it to zero. This works like
214 extern PTR xcalloc
PARAMS ((size_t, size_t)) ATTRIBUTE_MALLOC
;
216 /* Copy a string into a memory buffer without fail. */
218 extern char *xstrdup
PARAMS ((const char *)) ATTRIBUTE_MALLOC
;
220 /* Copy an existing memory buffer to a new memory buffer without fail. */
222 extern PTR xmemdup
PARAMS ((const PTR
, size_t, size_t)) ATTRIBUTE_MALLOC
;
224 /* hex character manipulation routines */
226 #define _hex_array_size 256
228 extern char _hex_value
[_hex_array_size
];
229 extern void hex_init
PARAMS ((void));
230 #define hex_p(c) (hex_value (c) != _hex_bad)
231 /* If you change this, note well: Some code relies on side effects in
232 the argument being performed exactly once. */
233 #define hex_value(c) (_hex_value[(unsigned char) (c)])
235 /* Definitions used by the pexecute routine. */
237 #define PEXECUTE_FIRST 1
238 #define PEXECUTE_LAST 2
239 #define PEXECUTE_ONE (PEXECUTE_FIRST + PEXECUTE_LAST)
240 #define PEXECUTE_SEARCH 4
241 #define PEXECUTE_VERBOSE 8
243 /* Execute a program. */
245 extern int pexecute
PARAMS ((const char *, char * const *, const char *,
246 const char *, char **, char **, int));
248 /* Wait for pexecute to finish. */
250 extern int pwait
PARAMS ((int, int *, int));
252 /* Like sprintf but provides a pointer to malloc'd storage, which must
253 be freed by the caller. */
255 extern int asprintf
PARAMS ((char **, const char *, ...)) ATTRIBUTE_PRINTF_2
;
257 /* Like vsprintf but provides a pointer to malloc'd storage, which
258 must be freed by the caller. */
260 extern int vasprintf
PARAMS ((char **, const char *, va_list))
261 ATTRIBUTE_PRINTF(2,0);
263 #define ARRAY_SIZE(a) (sizeof (a) / sizeof ((a)[0]))
265 /* Drastically simplified alloca configurator. If we're using GCC,
266 we use __builtin_alloca; otherwise we use the C alloca. The C
267 alloca is always available. You can override GCC by defining
268 USE_C_ALLOCA yourself. The canonical autoconf macro C_ALLOCA is
269 also set/unset as it is often used to indicate whether code needs
270 to call alloca(0). */
271 extern PTR C_alloca
PARAMS((size_t));
273 #if GCC_VERSION >= 2000 && !defined USE_C_ALLOCA
274 # define alloca(x) __builtin_alloca(x)
276 # define ASTRDUP(X) \
277 (__extension__ ({ const char *const libiberty_optr = (X); \
278 const unsigned long libiberty_len = strlen (libiberty_optr) + 1; \
279 char *const libiberty_nptr = alloca (libiberty_len); \
280 (char *) memcpy (libiberty_nptr, libiberty_optr, libiberty_len); }))
282 # define alloca(x) C_alloca(x)
284 # define USE_C_ALLOCA 1
287 extern const char *libiberty_optr
;
288 extern char *libiberty_nptr
;
289 extern unsigned long libiberty_len
;
290 # define ASTRDUP(X) \
291 (libiberty_optr = (X), \
292 libiberty_len = strlen (libiberty_optr) + 1, \
293 libiberty_nptr = alloca (libiberty_len), \
294 (char *) memcpy (libiberty_nptr, libiberty_optr, libiberty_len))
302 #endif /* ! defined (LIBIBERTY_H) */