1 /* Function declarations for libiberty.
3 Copyright 2001, 2002 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 ((const 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 !HAVE_DECL_BASENAME
77 #if defined (__GNU_LIBRARY__ ) || defined (__linux__) || defined (__FreeBSD__) || defined (__OpenBSD__) || defined(__NetBSD__) || defined (__CYGWIN__) || defined (__CYGWIN32__) || defined (HAVE_DECL_BASENAME)
78 extern char *basename
PARAMS ((const char *));
80 extern char *basename ();
84 /* A well-defined basename () that is always compiled in. */
86 extern const char *lbasename
PARAMS ((const char *));
88 /* A well-defined realpath () that is always compiled in. */
90 extern char *lrealpath
PARAMS ((const char *));
92 /* Concatenate an arbitrary number of strings. You must pass NULL as
93 the last argument of this function, to terminate the list of
94 strings. Allocates memory using xmalloc. */
96 extern char *concat
PARAMS ((const char *, ...)) ATTRIBUTE_MALLOC
;
98 /* Concatenate an arbitrary number of strings. You must pass NULL as
99 the last argument of this function, to terminate the list of
100 strings. Allocates memory using xmalloc. The first argument is
101 not one of the strings to be concatenated, but if not NULL is a
102 pointer to be freed after the new string is created, similar to the
103 way xrealloc works. */
105 extern char *reconcat
PARAMS ((char *, const char *, ...)) ATTRIBUTE_MALLOC
;
107 /* Determine the length of concatenating an arbitrary number of
108 strings. You must pass NULL as the last argument of this function,
109 to terminate the list of strings. */
111 extern unsigned long concat_length
PARAMS ((const char *, ...));
113 /* Concatenate an arbitrary number of strings into a SUPPLIED area of
114 memory. You must pass NULL as the last argument of this function,
115 to terminate the list of strings. The supplied memory is assumed
116 to be large enough. */
118 extern char *concat_copy
PARAMS ((char *, const char *, ...));
120 /* Concatenate an arbitrary number of strings into a GLOBAL area of
121 memory. You must pass NULL as the last argument of this function,
122 to terminate the list of strings. The supplied memory is assumed
123 to be large enough. */
125 extern char *concat_copy2
PARAMS ((const char *, ...));
127 /* This is the global area used by concat_copy2. */
129 extern char *libiberty_concat_ptr
;
131 /* Concatenate an arbitrary number of strings. You must pass NULL as
132 the last argument of this function, to terminate the list of
133 strings. Allocates memory using alloca. The arguments are
135 #define ACONCAT(ACONCAT_PARAMS) \
136 (libiberty_concat_ptr = alloca (concat_length ACONCAT_PARAMS + 1), \
137 concat_copy2 ACONCAT_PARAMS)
139 /* Check whether two file descriptors refer to the same file. */
141 extern int fdmatch
PARAMS ((int fd1
, int fd2
));
143 /* Get the working directory. The result is cached, so don't call
144 chdir() between calls to getpwd(). */
146 extern char * getpwd
PARAMS ((void));
148 /* Get the amount of time the process has run, in microseconds. */
150 extern long get_run_time
PARAMS ((void));
152 /* Generate a relocated path to some installation directory. Allocates
153 return value using malloc. */
155 extern char *make_relative_prefix
PARAMS ((const char *, const char *,
158 /* Choose a temporary directory to use for scratch files. */
160 extern char *choose_temp_base
PARAMS ((void)) ATTRIBUTE_MALLOC
;
162 /* Return a temporary file name or NULL if unable to create one. */
164 extern char *make_temp_file
PARAMS ((const char *)) ATTRIBUTE_MALLOC
;
166 /* Allocate memory filled with spaces. Allocates using malloc. */
168 extern const char *spaces
PARAMS ((int count
));
170 /* Return the maximum error number for which strerror will return a
173 extern int errno_max
PARAMS ((void));
175 /* Return the name of an errno value (e.g., strerrno (EINVAL) returns
178 extern const char *strerrno
PARAMS ((int));
180 /* Given the name of an errno value, return the value. */
182 extern int strtoerrno
PARAMS ((const char *));
184 /* ANSI's strerror(), but more robust. */
186 extern char *xstrerror
PARAMS ((int));
188 /* Return the maximum signal number for which strsignal will return a
191 extern int signo_max
PARAMS ((void));
193 /* Return a signal message string for a signal number
194 (e.g., strsignal (SIGHUP) returns something like "Hangup"). */
195 /* This is commented out as it can conflict with one in system headers.
196 We still document its existence though. */
198 /*extern const char *strsignal PARAMS ((int));*/
200 /* Return the name of a signal number (e.g., strsigno (SIGHUP) returns
203 extern const char *strsigno
PARAMS ((int));
205 /* Given the name of a signal, return its number. */
207 extern int strtosigno
PARAMS ((const char *));
209 /* Register a function to be run by xexit. Returns 0 on success. */
211 extern int xatexit
PARAMS ((void (*fn
) (void)));
213 /* Exit, calling all the functions registered with xatexit. */
215 extern void xexit
PARAMS ((int status
)) ATTRIBUTE_NORETURN
;
217 /* Set the program name used by xmalloc. */
219 extern void xmalloc_set_program_name
PARAMS ((const char *));
221 /* Report an allocation failure. */
222 extern void xmalloc_failed
PARAMS ((size_t)) ATTRIBUTE_NORETURN
;
224 /* Allocate memory without fail. If malloc fails, this will print a
225 message to stderr (using the name set by xmalloc_set_program_name,
226 if any) and then call xexit. */
228 extern PTR xmalloc
PARAMS ((size_t)) ATTRIBUTE_MALLOC
;
230 /* Reallocate memory without fail. This works like xmalloc. Note,
231 realloc type functions are not suitable for attribute malloc since
232 they may return the same address across multiple calls. */
234 extern PTR xrealloc
PARAMS ((PTR
, size_t));
236 /* Allocate memory without fail and set it to zero. This works like
239 extern PTR xcalloc
PARAMS ((size_t, size_t)) ATTRIBUTE_MALLOC
;
241 /* Copy a string into a memory buffer without fail. */
243 extern char *xstrdup
PARAMS ((const char *)) ATTRIBUTE_MALLOC
;
245 /* Copy an existing memory buffer to a new memory buffer without fail. */
247 extern PTR xmemdup
PARAMS ((const PTR
, size_t, size_t)) ATTRIBUTE_MALLOC
;
249 /* Physical memory routines. Return values are in BYTES. */
250 extern double physmem_total
PARAMS ((void));
251 extern double physmem_available
PARAMS ((void));
253 /* hex character manipulation routines */
255 #define _hex_array_size 256
257 extern const unsigned char _hex_value
[_hex_array_size
];
258 extern void hex_init
PARAMS ((void));
259 #define hex_p(c) (hex_value (c) != _hex_bad)
260 /* If you change this, note well: Some code relies on side effects in
261 the argument being performed exactly once. */
262 #define hex_value(c) ((unsigned int) _hex_value[(unsigned char) (c)])
264 /* Definitions used by the pexecute routine. */
266 #define PEXECUTE_FIRST 1
267 #define PEXECUTE_LAST 2
268 #define PEXECUTE_ONE (PEXECUTE_FIRST + PEXECUTE_LAST)
269 #define PEXECUTE_SEARCH 4
270 #define PEXECUTE_VERBOSE 8
272 /* Execute a program. */
274 extern int pexecute
PARAMS ((const char *, char * const *, const char *,
275 const char *, char **, char **, int));
277 /* Wait for pexecute to finish. */
279 extern int pwait
PARAMS ((int, int *, int));
281 #if !HAVE_DECL_ASPRINTF
282 /* Like sprintf but provides a pointer to malloc'd storage, which must
283 be freed by the caller. */
285 extern int asprintf
PARAMS ((char **, const char *, ...)) ATTRIBUTE_PRINTF_2
;
288 #if !HAVE_DECL_VASPRINTF
289 /* Like vsprintf but provides a pointer to malloc'd storage, which
290 must be freed by the caller. */
292 extern int vasprintf
PARAMS ((char **, const char *, va_list))
293 ATTRIBUTE_PRINTF(2,0);
296 #define ARRAY_SIZE(a) (sizeof (a) / sizeof ((a)[0]))
298 /* Drastically simplified alloca configurator. If we're using GCC,
299 we use __builtin_alloca; otherwise we use the C alloca. The C
300 alloca is always available. You can override GCC by defining
301 USE_C_ALLOCA yourself. The canonical autoconf macro C_ALLOCA is
302 also set/unset as it is often used to indicate whether code needs
303 to call alloca(0). */
304 extern PTR C_alloca
PARAMS ((size_t)) ATTRIBUTE_MALLOC
;
306 #if GCC_VERSION >= 2000 && !defined USE_C_ALLOCA
307 # define alloca(x) __builtin_alloca(x)
309 # define ASTRDUP(X) \
310 (__extension__ ({ const char *const libiberty_optr = (X); \
311 const unsigned long libiberty_len = strlen (libiberty_optr) + 1; \
312 char *const libiberty_nptr = alloca (libiberty_len); \
313 (char *) memcpy (libiberty_nptr, libiberty_optr, libiberty_len); }))
315 # define alloca(x) C_alloca(x)
317 # define USE_C_ALLOCA 1
320 extern const char *libiberty_optr
;
321 extern char *libiberty_nptr
;
322 extern unsigned long libiberty_len
;
323 # define ASTRDUP(X) \
324 (libiberty_optr = (X), \
325 libiberty_len = strlen (libiberty_optr) + 1, \
326 libiberty_nptr = alloca (libiberty_len), \
327 (char *) memcpy (libiberty_nptr, libiberty_optr, libiberty_len))
335 #endif /* ! defined (LIBIBERTY_H) */
This page took 0.036152 seconds and 4 git commands to generate.