[deliverable/binutils-gdb.git] / include / libiberty.h

/* Function declarations for libiberty.

   Copyright 2001 Free Software Foundation, Inc.
   
   Note - certain prototypes declared in this header file are for
   functions whoes implementation copyright does not belong to the
   FSF.  Those prototypes are present in this file for reference
   purposes only and their presence in this file should not construed
   as an indication of ownership by the FSF of the implementation of
   those functions in any way or form whatsoever.

   This program is free software; you can redistribute it and/or modify
   it under the terms of the GNU General Public License as published by
   the Free Software Foundation; either version 2, or (at your option)
   any later version.

   This program is distributed in the hope that it will be useful,
   but WITHOUT ANY WARRANTY; without even the implied warranty of
   MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
   GNU General Public License for more details.

   You should have received a copy of the GNU General Public License
   along with this program; if not, write to the Free Software
   Foundation, Inc., 59 Temple Place - Suite 330,
   Boston, MA 02111-1307, USA.
   
   Written by Cygnus Support, 1994.

   The libiberty library provides a number of functions which are
   missing on some operating systems.  We do not declare those here,
   to avoid conflicts with the system header files on operating
   systems that do support those functions.  In this file we only
   declare those functions which are specific to libiberty.  */

#ifndef LIBIBERTY_H
#define LIBIBERTY_H

#ifdef __cplusplus
extern "C" {
#endif

#include "ansidecl.h"

#ifdef ANSI_PROTOTYPES
/* Get a definition for size_t.  */
#include <stddef.h>
/* Get a definition for va_list.  */
#include <stdarg.h>
#endif

/* Build an argument vector from a string.  Allocates memory using
   malloc.  Use freeargv to free the vector.  */

extern char **buildargv PARAMS ((char *)) ATTRIBUTE_MALLOC;

/* Free a vector returned by buildargv.  */

extern void freeargv PARAMS ((char **));

/* Duplicate an argument vector. Allocates memory using malloc.  Use
   freeargv to free the vector.  */

extern char **dupargv PARAMS ((char **)) ATTRIBUTE_MALLOC;


/* Return the last component of a path name.  Note that we can't use a
   prototype here because the parameter is declared inconsistently
   across different systems, sometimes as "char *" and sometimes as
   "const char *" */

/* HAVE_DECL_* is a three-state macro: undefined, 0 or 1.  If it is
   undefined, we haven't run the autoconf check so provide the
   declaration without arguments.  If it is 0, we checked and failed
   to find the declaration so provide a fully prototyped one.  If it
   is 1, we found it so don't provide any declaration at all.  */
#if defined (__GNU_LIBRARY__ ) || defined (__linux__) || defined (__FreeBSD__) || defined (__OpenBSD__) || defined (__CYGWIN__) || defined (__CYGWIN32__) || (defined (HAVE_DECL_BASENAME) && !HAVE_DECL_BASENAME)
extern char *basename PARAMS ((const char *));
#else
# if !defined (HAVE_DECL_BASENAME)
extern char *basename ();
# endif
#endif

/* A well-defined basename () that is always compiled in.  */

extern const char *lbasename PARAMS ((const char *));

/* Concatenate an arbitrary number of strings, up to (char *) NULL.
   Allocates memory using xmalloc.  */

extern char *concat PARAMS ((const char *, ...)) ATTRIBUTE_MALLOC;

/* Determine the length of concatenating an arbitrary number of
   strings, up to (char *) NULL.  */

extern unsigned long concat_length PARAMS ((const char *, ...));

/* Concatenate an arbitrary number of strings into a SUPPLIED area of
   memory, up to (char *) NULL.  The supplied memory is assumed to be
   large enough.  */

extern char *concat_copy PARAMS ((char *, const char *, ...));

/* Concatenate an arbitrary number of strings into a GLOBAL area of
   memory, up to (char *) NULL.  The supplied memory is assumed to be
   large enough.  */

extern char *concat_copy2 PARAMS ((const char *, ...));

/* This is the global area used by concat_copy2.  */

extern char *libiberty_concat_ptr;

/* Concatenate an arbitrary number of strings, up to (char *) NULL.
   Allocates memory using alloca.  Arguments are evaluated twice!.  */
#define ACONCAT(ACONCAT_PARAMS) \
  (libiberty_concat_ptr = alloca (concat_length ACONCAT_PARAMS + 1), \
   concat_copy2 ACONCAT_PARAMS)

/* Check whether two file descriptors refer to the same file.  */

extern int fdmatch PARAMS ((int fd1, int fd2));

/* Get the working directory.  The result is cached, so don't call
   chdir() between calls to getpwd().  */

extern char * getpwd PARAMS ((void));

/* Get the amount of time the process has run, in microseconds.  */

extern long get_run_time PARAMS ((void));

/* Choose a temporary directory to use for scratch files.  */

extern char *choose_temp_base PARAMS ((void)) ATTRIBUTE_MALLOC;

/* Return a temporary file name or NULL if unable to create one.  */

extern char *make_temp_file PARAMS ((const char *)) ATTRIBUTE_MALLOC;

/* Allocate memory filled with spaces.  Allocates using malloc.  */

extern const char *spaces PARAMS ((int count));

/* Return the maximum error number for which strerror will return a
   string.  */

extern int errno_max PARAMS ((void));

/* Return the name of an errno value (e.g., strerrno (EINVAL) returns
   "EINVAL").  */

extern const char *strerrno PARAMS ((int));

/* Given the name of an errno value, return the value.  */

extern int strtoerrno PARAMS ((const char *));

/* ANSI's strerror(), but more robust.  */

extern char *xstrerror PARAMS ((int));

/* Return the maximum signal number for which strsignal will return a
   string.  */

extern int signo_max PARAMS ((void));

/* Return a signal message string for a signal number
   (e.g., strsignal (SIGHUP) returns something like "Hangup").  */
/* This is commented out as it can conflict with one in system headers.
   We still document its existence though.  */

/*extern const char *strsignal PARAMS ((int));*/

/* Return the name of a signal number (e.g., strsigno (SIGHUP) returns
   "SIGHUP").  */

extern const char *strsigno PARAMS ((int));

/* Given the name of a signal, return its number.  */

extern int strtosigno PARAMS ((const char *));

/* Register a function to be run by xexit.  Returns 0 on success.  */

extern int xatexit PARAMS ((void (*fn) (void)));

/* Exit, calling all the functions registered with xatexit.  */

extern void xexit PARAMS ((int status)) ATTRIBUTE_NORETURN;

/* Set the program name used by xmalloc.  */

extern void xmalloc_set_program_name PARAMS ((const char *));

/* Report an allocation failure.  */
extern void xmalloc_failed PARAMS ((size_t)) ATTRIBUTE_NORETURN;

/* Allocate memory without fail.  If malloc fails, this will print a
   message to stderr (using the name set by xmalloc_set_program_name,
   if any) and then call xexit.  */

extern PTR xmalloc PARAMS ((size_t)) ATTRIBUTE_MALLOC;

/* Reallocate memory without fail.  This works like xmalloc.  Note,
   realloc type functions are not suitable for attribute malloc since
   they may return the same address across multiple calls. */

extern PTR xrealloc PARAMS ((PTR, size_t));

/* Allocate memory without fail and set it to zero.  This works like
   xmalloc.  */

extern PTR xcalloc PARAMS ((size_t, size_t)) ATTRIBUTE_MALLOC;

/* Copy a string into a memory buffer without fail.  */

extern char *xstrdup PARAMS ((const char *)) ATTRIBUTE_MALLOC;

/* Copy an existing memory buffer to a new memory buffer without fail.  */

extern PTR xmemdup PARAMS ((const PTR, size_t, size_t)) ATTRIBUTE_MALLOC;

/* hex character manipulation routines */

#define _hex_array_size 256
#define _hex_bad	99
extern char _hex_value[_hex_array_size];
extern void hex_init PARAMS ((void));
#define hex_p(c)	(hex_value (c) != _hex_bad)
/* If you change this, note well: Some code relies on side effects in
   the argument being performed exactly once.  */
#define hex_value(c)	(_hex_value[(unsigned char) (c)])

/* Definitions used by the pexecute routine.  */

#define PEXECUTE_FIRST   1
#define PEXECUTE_LAST    2
#define PEXECUTE_ONE     (PEXECUTE_FIRST + PEXECUTE_LAST)
#define PEXECUTE_SEARCH  4
#define PEXECUTE_VERBOSE 8

/* Execute a program.  */

extern int pexecute PARAMS ((const char *, char * const *, const char *,
			    const char *, char **, char **, int));

/* Wait for pexecute to finish.  */

extern int pwait PARAMS ((int, int *, int));

/* Like sprintf but provides a pointer to malloc'd storage, which must
   be freed by the caller.  */

extern int asprintf PARAMS ((char **, const char *, ...)) ATTRIBUTE_PRINTF_2;

/* Like vsprintf but provides a pointer to malloc'd storage, which
   must be freed by the caller.  */

extern int vasprintf PARAMS ((char **, const char *, va_list))
  ATTRIBUTE_PRINTF(2,0);

#define ARRAY_SIZE(a) (sizeof (a) / sizeof ((a)[0]))

/* Drastically simplified alloca configurator.  If we're using GCC,
   we use __builtin_alloca; otherwise we use the C alloca.  The C
   alloca is always available.  You can override GCC by defining
   USE_C_ALLOCA yourself.  The canonical autoconf macro C_ALLOCA is
   also set/unset as it is often used to indicate whether code needs
   to call alloca(0).  */
extern PTR C_alloca PARAMS((size_t));
#undef alloca
#if GCC_VERSION >= 2000 && !defined USE_C_ALLOCA
# define alloca(x) __builtin_alloca(x)
# undef C_ALLOCA
# define ASTRDUP(X) \
  (__extension__ ({ const char *const libiberty_optr = (X); \
   const unsigned long libiberty_len = strlen (libiberty_optr) + 1; \
   char *const libiberty_nptr = alloca (libiberty_len); \
   (char *) memcpy (libiberty_nptr, libiberty_optr, libiberty_len); }))
#else
# define alloca(x) C_alloca(x)
# undef USE_C_ALLOCA
# define USE_C_ALLOCA 1
# undef C_ALLOCA
# define C_ALLOCA 1
extern const char *libiberty_optr;
extern char *libiberty_nptr;
extern unsigned long libiberty_len;
# define ASTRDUP(X) \
  (libiberty_optr = (X), \
   libiberty_len = strlen (libiberty_optr) + 1, \
   libiberty_nptr = alloca (libiberty_len), \
   (char *) memcpy (libiberty_nptr, libiberty_optr, libiberty_len))
#endif

#ifdef __cplusplus
}
#endif


#endif /* ! defined (LIBIBERTY_H) */
Commit	Line	Data
252b5132	1	/* Function declarations for libiberty.
4f1d9bd8 NC	2
	3	Copyright 2001 Free Software Foundation, Inc.
	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
cc89ffe6	54	extern char *buildargv PARAMS ((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 ));
252b5132 RH	78	#else
79c6de76	79	# if !defined (HAVE_DECL_BASENAME)
252b5132	80	extern char *basename ();
79c6de76	81	# endif
252b5132 RH	82	#endif
252b5132 RH	83
8aa30e60 DD	84	/* A well-defined basename () that is always compiled in. */
8aa30e60 DD	85
3ea71002	86	extern const char lbasename PARAMS ((const char ));
8aa30e60	87
252b5132 RH	88	/* Concatenate an arbitrary number of strings, up to (char *) NULL.
	89	Allocates memory using xmalloc. */
	90
cc89ffe6	91	extern char concat PARAMS ((const char , ...)) ATTRIBUTE_MALLOC;
252b5132	92
54c20242 DD	93	/* Determine the length of concatenating an arbitrary number of
	94	strings, up to (char ) NULL. /
	95
	96	extern unsigned long concat_length PARAMS ((const char *, ...));
	97
	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
	100	large enough. */
	101
	102	extern char concat_copy PARAMS ((char , const char *, ...));
	103
	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
	106	large enough. */
	107
	108	extern char concat_copy2 PARAMS ((const char , ...));
	109
	110	/* This is the global area used by concat_copy2. */
	111
	112	extern char *libiberty_concat_ptr;
	113
	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)
	119
252b5132 RH	120	/* Check whether two file descriptors refer to the same file. */
	121
	122	extern int fdmatch PARAMS ((int fd1, int fd2));
	123
cc89ffe6 ILT	124	/* Get the working directory. The result is cached, so don't call
	125	chdir() between calls to getpwd(). */
	126
	127	extern char * getpwd PARAMS ((void));
	128
252b5132 RH	129	/* Get the amount of time the process has run, in microseconds. */
	130
	131	extern long get_run_time PARAMS ((void));
	132
	133	/* Choose a temporary directory to use for scratch files. */
	134
cc89ffe6 ILT	135	extern char *choose_temp_base PARAMS ((void)) ATTRIBUTE_MALLOC;
	136
	137	/* Return a temporary file name or NULL if unable to create one. */
	138
	139	extern char make_temp_file PARAMS ((const char )) ATTRIBUTE_MALLOC;
252b5132 RH	140
	141	/* Allocate memory filled with spaces. Allocates using malloc. */
	142
	143	extern const char *spaces PARAMS ((int count));
	144
	145	/* Return the maximum error number for which strerror will return a
	146	string. */
	147
	148	extern int errno_max PARAMS ((void));
	149
	150	/* Return the name of an errno value (e.g., strerrno (EINVAL) returns
	151	"EINVAL"). */
	152
	153	extern const char *strerrno PARAMS ((int));
	154
	155	/* Given the name of an errno value, return the value. */
	156
	157	extern int strtoerrno PARAMS ((const char *));
	158
	159	/* ANSI's strerror(), but more robust. */
	160
	161	extern char *xstrerror PARAMS ((int));
	162
	163	/* Return the maximum signal number for which strsignal will return a
	164	string. */
	165
	166	extern int signo_max PARAMS ((void));
	167
	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. */
	172
	173	/extern const char strsignal PARAMS ((int));*/
	174
	175	/* Return the name of a signal number (e.g., strsigno (SIGHUP) returns
	176	"SIGHUP"). */
	177
	178	extern const char *strsigno PARAMS ((int));
	179
	180	/* Given the name of a signal, return its number. */
	181
	182	extern int strtosigno PARAMS ((const char *));
	183
	184	/* Register a function to be run by xexit. Returns 0 on success. */
	185
	186	extern int xatexit PARAMS ((void (*fn) (void)));
	187
	188	/* Exit, calling all the functions registered with xatexit. */
	189
cc89ffe6	190	extern void xexit PARAMS ((int status)) ATTRIBUTE_NORETURN;
252b5132 RH	191
	192	/* Set the program name used by xmalloc. */
	193
	194	extern void xmalloc_set_program_name PARAMS ((const char *));
	195
b13291a9 DD	196	/* Report an allocation failure. */
	197	extern void xmalloc_failed PARAMS ((size_t)) ATTRIBUTE_NORETURN;
	198
252b5132 RH	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. */
	202
cc89ffe6	203	extern PTR xmalloc PARAMS ((size_t)) ATTRIBUTE_MALLOC;
252b5132	204
cc89ffe6 ILT	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. */
252b5132 RH	208
	209	extern PTR xrealloc PARAMS ((PTR, size_t));
	210
	211	/* Allocate memory without fail and set it to zero. This works like
	212	xmalloc. */
	213
cc89ffe6	214	extern PTR xcalloc PARAMS ((size_t, size_t)) ATTRIBUTE_MALLOC;
252b5132 RH	215
	216	/* Copy a string into a memory buffer without fail. */
	217
cc89ffe6 ILT	218	extern char xstrdup PARAMS ((const char )) ATTRIBUTE_MALLOC;
	219
	220	/* Copy an existing memory buffer to a new memory buffer without fail. */
	221
	222	extern PTR xmemdup PARAMS ((const PTR, size_t, size_t)) ATTRIBUTE_MALLOC;
252b5132 RH	223
	224	/* hex character manipulation routines */
	225
	226	#define _hex_array_size 256
	227	#define _hex_bad 99
	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)])
	234
	235	/* Definitions used by the pexecute routine. */
	236
	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
	242
	243	/* Execute a program. */
	244
	245	extern int pexecute PARAMS ((const char , char const , const char ,
	246	const char , char , char *, int));
	247
	248	/* Wait for pexecute to finish. */
	249
	250	extern int pwait PARAMS ((int, int *, int));
	251
cc89ffe6 ILT	252	/* Like sprintf but provides a pointer to malloc'd storage, which must
	253	be freed by the caller. */
	254
	255	extern int asprintf PARAMS ((char *, const char , ...)) ATTRIBUTE_PRINTF_2;
	256
	257	/* Like vsprintf but provides a pointer to malloc'd storage, which
	258	must be freed by the caller. */
	259
	260	extern int vasprintf PARAMS ((char *, const char , va_list))
	261	ATTRIBUTE_PRINTF(2,0);
	262
b18903cb NC	263	#define ARRAY_SIZE(a) (sizeof (a) / sizeof ((a)[0]))
b18903cb NC	264
30673bf5 DD	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
129e8d96 DD	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). */
30673bf5 DD	271	extern PTR C_alloca PARAMS((size_t));
	272	#undef alloca
	273	#if GCC_VERSION >= 2000 && !defined USE_C_ALLOCA
	274	# define alloca(x) __builtin_alloca(x)
129e8d96	275	# undef C_ALLOCA
54c20242 DD	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); }))
30673bf5 DD	281	#else
	282	# define alloca(x) C_alloca(x)
	283	# undef USE_C_ALLOCA
	284	# define USE_C_ALLOCA 1
129e8d96 DD	285	# undef C_ALLOCA
129e8d96 DD	286	# define C_ALLOCA 1
54c20242 DD	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))
30673bf5 DD	295	#endif
30673bf5 DD	296
252b5132 RH	297	#ifdef __cplusplus
	298	}
	299	#endif
	300
	301
	302	#endif /* ! defined (LIBIBERTY_H) */