Commit | Line | Data |
---|---|---|
252b5132 | 1 | /* Function declarations for libiberty. |
4f1d9bd8 | 2 | |
1d619e59 | 3 | Copyright 2001, 2002 Free Software Foundation, Inc. |
4f1d9bd8 | 4 | |
526c3e12 NC |
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. | |
11 | ||
4f1d9bd8 NC |
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) | |
15 | any later version. | |
16 | ||
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. | |
21 | ||
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. | |
26 | ||
252b5132 RH |
27 | Written by Cygnus Support, 1994. |
28 | ||
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. */ | |
34 | ||
35 | #ifndef LIBIBERTY_H | |
36 | #define LIBIBERTY_H | |
37 | ||
38 | #ifdef __cplusplus | |
39 | extern "C" { | |
40 | #endif | |
41 | ||
42 | #include "ansidecl.h" | |
43 | ||
b13291a9 DD |
44 | #ifdef ANSI_PROTOTYPES |
45 | /* Get a definition for size_t. */ | |
46 | #include <stddef.h> | |
47 | /* Get a definition for va_list. */ | |
48 | #include <stdarg.h> | |
49 | #endif | |
50 | ||
252b5132 RH |
51 | /* Build an argument vector from a string. Allocates memory using |
52 | malloc. Use freeargv to free the vector. */ | |
53 | ||
e6450fe5 | 54 | extern char **buildargv PARAMS ((const char *)) ATTRIBUTE_MALLOC; |
252b5132 RH |
55 | |
56 | /* Free a vector returned by buildargv. */ | |
57 | ||
58 | extern void freeargv PARAMS ((char **)); | |
59 | ||
60 | /* Duplicate an argument vector. Allocates memory using malloc. Use | |
61 | freeargv to free the vector. */ | |
62 | ||
cc89ffe6 | 63 | extern char **dupargv PARAMS ((char **)) ATTRIBUTE_MALLOC; |
252b5132 RH |
64 | |
65 | ||
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 | |
69 | "const char *" */ | |
70 | ||
79c6de76 L |
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) | |
252b5132 RH |
77 | extern char *basename PARAMS ((const char *)); |
78 | #else | |
79c6de76 | 79 | # if !defined (HAVE_DECL_BASENAME) |
252b5132 | 80 | extern char *basename (); |
79c6de76 | 81 | # endif |
252b5132 RH |
82 | #endif |
83 | ||
8aa30e60 DD |
84 | /* A well-defined basename () that is always compiled in. */ |
85 | ||
3ea71002 | 86 | extern const char *lbasename PARAMS ((const char *)); |
8aa30e60 | 87 | |
38bfaea8 DD |
88 | /* Concatenate an arbitrary number of strings. You must pass NULL as |
89 | the last argument of this function, to terminate the list of | |
90 | strings. Allocates memory using xmalloc. */ | |
252b5132 | 91 | |
cc89ffe6 | 92 | extern char *concat PARAMS ((const char *, ...)) ATTRIBUTE_MALLOC; |
252b5132 | 93 | |
99ee3a8f DD |
94 | /* Concatenate an arbitrary number of strings. You must pass NULL as |
95 | the last argument of this function, to terminate the list of | |
96 | strings. Allocates memory using xmalloc. The first argument is | |
97 | not one of the strings to be concatenated, but if not NULL is a | |
98 | pointer to be freed after the new string is created, similar to the | |
99 | way xrealloc works. */ | |
100 | ||
101 | extern char *reconcat PARAMS ((char *, const char *, ...)) ATTRIBUTE_MALLOC; | |
102 | ||
54c20242 | 103 | /* Determine the length of concatenating an arbitrary number of |
38bfaea8 DD |
104 | strings. You must pass NULL as the last argument of this function, |
105 | to terminate the list of strings. */ | |
54c20242 DD |
106 | |
107 | extern unsigned long concat_length PARAMS ((const char *, ...)); | |
108 | ||
109 | /* Concatenate an arbitrary number of strings into a SUPPLIED area of | |
38bfaea8 DD |
110 | memory. You must pass NULL as the last argument of this function, |
111 | to terminate the list of strings. The supplied memory is assumed | |
112 | to be large enough. */ | |
54c20242 DD |
113 | |
114 | extern char *concat_copy PARAMS ((char *, const char *, ...)); | |
115 | ||
116 | /* Concatenate an arbitrary number of strings into a GLOBAL area of | |
38bfaea8 DD |
117 | memory. You must pass NULL as the last argument of this function, |
118 | to terminate the list of strings. The supplied memory is assumed | |
119 | to be large enough. */ | |
54c20242 DD |
120 | |
121 | extern char *concat_copy2 PARAMS ((const char *, ...)); | |
122 | ||
123 | /* This is the global area used by concat_copy2. */ | |
124 | ||
125 | extern char *libiberty_concat_ptr; | |
126 | ||
38bfaea8 DD |
127 | /* Concatenate an arbitrary number of strings. You must pass NULL as |
128 | the last argument of this function, to terminate the list of | |
129 | strings. Allocates memory using alloca. The arguments are | |
130 | evaluated twice! */ | |
54c20242 DD |
131 | #define ACONCAT(ACONCAT_PARAMS) \ |
132 | (libiberty_concat_ptr = alloca (concat_length ACONCAT_PARAMS + 1), \ | |
133 | concat_copy2 ACONCAT_PARAMS) | |
134 | ||
252b5132 RH |
135 | /* Check whether two file descriptors refer to the same file. */ |
136 | ||
137 | extern int fdmatch PARAMS ((int fd1, int fd2)); | |
138 | ||
cc89ffe6 ILT |
139 | /* Get the working directory. The result is cached, so don't call |
140 | chdir() between calls to getpwd(). */ | |
141 | ||
142 | extern char * getpwd PARAMS ((void)); | |
143 | ||
252b5132 RH |
144 | /* Get the amount of time the process has run, in microseconds. */ |
145 | ||
146 | extern long get_run_time PARAMS ((void)); | |
147 | ||
148 | /* Choose a temporary directory to use for scratch files. */ | |
149 | ||
cc89ffe6 ILT |
150 | extern char *choose_temp_base PARAMS ((void)) ATTRIBUTE_MALLOC; |
151 | ||
152 | /* Return a temporary file name or NULL if unable to create one. */ | |
153 | ||
154 | extern char *make_temp_file PARAMS ((const char *)) ATTRIBUTE_MALLOC; | |
252b5132 RH |
155 | |
156 | /* Allocate memory filled with spaces. Allocates using malloc. */ | |
157 | ||
158 | extern const char *spaces PARAMS ((int count)); | |
159 | ||
160 | /* Return the maximum error number for which strerror will return a | |
161 | string. */ | |
162 | ||
163 | extern int errno_max PARAMS ((void)); | |
164 | ||
165 | /* Return the name of an errno value (e.g., strerrno (EINVAL) returns | |
166 | "EINVAL"). */ | |
167 | ||
168 | extern const char *strerrno PARAMS ((int)); | |
169 | ||
170 | /* Given the name of an errno value, return the value. */ | |
171 | ||
172 | extern int strtoerrno PARAMS ((const char *)); | |
173 | ||
174 | /* ANSI's strerror(), but more robust. */ | |
175 | ||
176 | extern char *xstrerror PARAMS ((int)); | |
177 | ||
178 | /* Return the maximum signal number for which strsignal will return a | |
179 | string. */ | |
180 | ||
181 | extern int signo_max PARAMS ((void)); | |
182 | ||
183 | /* Return a signal message string for a signal number | |
184 | (e.g., strsignal (SIGHUP) returns something like "Hangup"). */ | |
185 | /* This is commented out as it can conflict with one in system headers. | |
186 | We still document its existence though. */ | |
187 | ||
188 | /*extern const char *strsignal PARAMS ((int));*/ | |
189 | ||
190 | /* Return the name of a signal number (e.g., strsigno (SIGHUP) returns | |
191 | "SIGHUP"). */ | |
192 | ||
193 | extern const char *strsigno PARAMS ((int)); | |
194 | ||
195 | /* Given the name of a signal, return its number. */ | |
196 | ||
197 | extern int strtosigno PARAMS ((const char *)); | |
198 | ||
199 | /* Register a function to be run by xexit. Returns 0 on success. */ | |
200 | ||
201 | extern int xatexit PARAMS ((void (*fn) (void))); | |
202 | ||
203 | /* Exit, calling all the functions registered with xatexit. */ | |
204 | ||
cc89ffe6 | 205 | extern void xexit PARAMS ((int status)) ATTRIBUTE_NORETURN; |
252b5132 RH |
206 | |
207 | /* Set the program name used by xmalloc. */ | |
208 | ||
209 | extern void xmalloc_set_program_name PARAMS ((const char *)); | |
210 | ||
b13291a9 DD |
211 | /* Report an allocation failure. */ |
212 | extern void xmalloc_failed PARAMS ((size_t)) ATTRIBUTE_NORETURN; | |
213 | ||
252b5132 RH |
214 | /* Allocate memory without fail. If malloc fails, this will print a |
215 | message to stderr (using the name set by xmalloc_set_program_name, | |
216 | if any) and then call xexit. */ | |
217 | ||
cc89ffe6 | 218 | extern PTR xmalloc PARAMS ((size_t)) ATTRIBUTE_MALLOC; |
252b5132 | 219 | |
cc89ffe6 ILT |
220 | /* Reallocate memory without fail. This works like xmalloc. Note, |
221 | realloc type functions are not suitable for attribute malloc since | |
222 | they may return the same address across multiple calls. */ | |
252b5132 RH |
223 | |
224 | extern PTR xrealloc PARAMS ((PTR, size_t)); | |
225 | ||
226 | /* Allocate memory without fail and set it to zero. This works like | |
227 | xmalloc. */ | |
228 | ||
cc89ffe6 | 229 | extern PTR xcalloc PARAMS ((size_t, size_t)) ATTRIBUTE_MALLOC; |
252b5132 RH |
230 | |
231 | /* Copy a string into a memory buffer without fail. */ | |
232 | ||
cc89ffe6 ILT |
233 | extern char *xstrdup PARAMS ((const char *)) ATTRIBUTE_MALLOC; |
234 | ||
235 | /* Copy an existing memory buffer to a new memory buffer without fail. */ | |
236 | ||
237 | extern PTR xmemdup PARAMS ((const PTR, size_t, size_t)) ATTRIBUTE_MALLOC; | |
252b5132 RH |
238 | |
239 | /* hex character manipulation routines */ | |
240 | ||
241 | #define _hex_array_size 256 | |
242 | #define _hex_bad 99 | |
d311a83a | 243 | extern const char _hex_value[_hex_array_size]; |
252b5132 RH |
244 | extern void hex_init PARAMS ((void)); |
245 | #define hex_p(c) (hex_value (c) != _hex_bad) | |
246 | /* If you change this, note well: Some code relies on side effects in | |
247 | the argument being performed exactly once. */ | |
248 | #define hex_value(c) (_hex_value[(unsigned char) (c)]) | |
249 | ||
250 | /* Definitions used by the pexecute routine. */ | |
251 | ||
252 | #define PEXECUTE_FIRST 1 | |
253 | #define PEXECUTE_LAST 2 | |
254 | #define PEXECUTE_ONE (PEXECUTE_FIRST + PEXECUTE_LAST) | |
255 | #define PEXECUTE_SEARCH 4 | |
256 | #define PEXECUTE_VERBOSE 8 | |
257 | ||
258 | /* Execute a program. */ | |
259 | ||
260 | extern int pexecute PARAMS ((const char *, char * const *, const char *, | |
261 | const char *, char **, char **, int)); | |
262 | ||
263 | /* Wait for pexecute to finish. */ | |
264 | ||
265 | extern int pwait PARAMS ((int, int *, int)); | |
266 | ||
cc89ffe6 ILT |
267 | /* Like sprintf but provides a pointer to malloc'd storage, which must |
268 | be freed by the caller. */ | |
269 | ||
270 | extern int asprintf PARAMS ((char **, const char *, ...)) ATTRIBUTE_PRINTF_2; | |
271 | ||
272 | /* Like vsprintf but provides a pointer to malloc'd storage, which | |
273 | must be freed by the caller. */ | |
274 | ||
275 | extern int vasprintf PARAMS ((char **, const char *, va_list)) | |
276 | ATTRIBUTE_PRINTF(2,0); | |
277 | ||
b18903cb NC |
278 | #define ARRAY_SIZE(a) (sizeof (a) / sizeof ((a)[0])) |
279 | ||
30673bf5 DD |
280 | /* Drastically simplified alloca configurator. If we're using GCC, |
281 | we use __builtin_alloca; otherwise we use the C alloca. The C | |
282 | alloca is always available. You can override GCC by defining | |
129e8d96 DD |
283 | USE_C_ALLOCA yourself. The canonical autoconf macro C_ALLOCA is |
284 | also set/unset as it is often used to indicate whether code needs | |
285 | to call alloca(0). */ | |
1d619e59 | 286 | extern PTR C_alloca PARAMS ((size_t)) ATTRIBUTE_MALLOC; |
30673bf5 DD |
287 | #undef alloca |
288 | #if GCC_VERSION >= 2000 && !defined USE_C_ALLOCA | |
289 | # define alloca(x) __builtin_alloca(x) | |
129e8d96 | 290 | # undef C_ALLOCA |
54c20242 DD |
291 | # define ASTRDUP(X) \ |
292 | (__extension__ ({ const char *const libiberty_optr = (X); \ | |
293 | const unsigned long libiberty_len = strlen (libiberty_optr) + 1; \ | |
294 | char *const libiberty_nptr = alloca (libiberty_len); \ | |
295 | (char *) memcpy (libiberty_nptr, libiberty_optr, libiberty_len); })) | |
30673bf5 DD |
296 | #else |
297 | # define alloca(x) C_alloca(x) | |
298 | # undef USE_C_ALLOCA | |
299 | # define USE_C_ALLOCA 1 | |
129e8d96 DD |
300 | # undef C_ALLOCA |
301 | # define C_ALLOCA 1 | |
54c20242 DD |
302 | extern const char *libiberty_optr; |
303 | extern char *libiberty_nptr; | |
304 | extern unsigned long libiberty_len; | |
305 | # define ASTRDUP(X) \ | |
306 | (libiberty_optr = (X), \ | |
307 | libiberty_len = strlen (libiberty_optr) + 1, \ | |
308 | libiberty_nptr = alloca (libiberty_len), \ | |
309 | (char *) memcpy (libiberty_nptr, libiberty_optr, libiberty_len)) | |
30673bf5 DD |
310 | #endif |
311 | ||
252b5132 RH |
312 | #ifdef __cplusplus |
313 | } | |
314 | #endif | |
315 | ||
316 | ||
317 | #endif /* ! defined (LIBIBERTY_H) */ |