[binutils.git] / include / libiberty.h

/* Function declarations for libiberty.
   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"

/* 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

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

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

/* 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 *));

/* 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.  */

#ifdef ANSI_PROTOTYPES
/* Get a definition for size_t.  */
#include <stddef.h>
/* Get a definition for va_list.  */
#include <stdarg.h>
#endif
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);

#ifdef __cplusplus
}
#endif


#endif /* ! defined (LIBIBERTY_H) */
Commit	Line	Data
252b5132 RH	1	/* Function declarations for libiberty.
	2	Written by Cygnus Support, 1994.
	3
	4	The libiberty library provides a number of functions which are
	5	missing on some operating systems. We do not declare those here,
	6	to avoid conflicts with the system header files on operating
	7	systems that do support those functions. In this file we only
	8	declare those functions which are specific to libiberty. */
	9
	10	#ifndef LIBIBERTY_H
	11	#define LIBIBERTY_H
	12
	13	#ifdef __cplusplus
	14	extern "C" {
	15	#endif
	16
	17	#include "ansidecl.h"
	18
	19	/* Build an argument vector from a string. Allocates memory using
	20	malloc. Use freeargv to free the vector. */
	21
cc89ffe6	22	extern char *buildargv PARAMS ((char )) ATTRIBUTE_MALLOC;
252b5132 RH	23
	24	/* Free a vector returned by buildargv. */
	25
	26	extern void freeargv PARAMS ((char **));
	27
	28	/* Duplicate an argument vector. Allocates memory using malloc. Use
	29	freeargv to free the vector. */
	30
cc89ffe6	31	extern char dupargv PARAMS ((char )) ATTRIBUTE_MALLOC;
252b5132 RH	32
	33
	34	/* Return the last component of a path name. Note that we can't use a
	35	prototype here because the parameter is declared inconsistently
	36	across different systems, sometimes as "char *" and sometimes as
	37	"const char " /
	38
79c6de76 L	39	/* HAVE_DECL_* is a three-state macro: undefined, 0 or 1. If it is
	40	undefined, we haven't run the autoconf check so provide the
	41	declaration without arguments. If it is 0, we checked and failed
	42	to find the declaration so provide a fully prototyped one. If it
	43	is 1, we found it so don't provide any declaration at all. */
	44	#if defined (__GNU_LIBRARY__ ) \|\| defined (__linux__) \|\| defined (__FreeBSD__) \|\| defined (__OpenBSD__) \|\| defined (__CYGWIN__) \|\| defined (__CYGWIN32__) \|\| (defined (HAVE_DECL_BASENAME) && !HAVE_DECL_BASENAME)
252b5132 RH	45	extern char basename PARAMS ((const char ));
252b5132 RH	46	#else
79c6de76	47	# if !defined (HAVE_DECL_BASENAME)
252b5132	48	extern char *basename ();
79c6de76	49	# endif
252b5132 RH	50	#endif
	51
	52	/* Concatenate an arbitrary number of strings, up to (char *) NULL.
	53	Allocates memory using xmalloc. */
	54
cc89ffe6	55	extern char concat PARAMS ((const char , ...)) ATTRIBUTE_MALLOC;
252b5132 RH	56
	57	/* Check whether two file descriptors refer to the same file. */
	58
	59	extern int fdmatch PARAMS ((int fd1, int fd2));
	60
cc89ffe6 ILT	61	/* Get the working directory. The result is cached, so don't call
	62	chdir() between calls to getpwd(). */
	63
	64	extern char * getpwd PARAMS ((void));
	65
252b5132 RH	66	/* Get the amount of time the process has run, in microseconds. */
	67
	68	extern long get_run_time PARAMS ((void));
	69
	70	/* Choose a temporary directory to use for scratch files. */
	71
cc89ffe6 ILT	72	extern char *choose_temp_base PARAMS ((void)) ATTRIBUTE_MALLOC;
	73
	74	/* Return a temporary file name or NULL if unable to create one. */
	75
	76	extern char make_temp_file PARAMS ((const char )) ATTRIBUTE_MALLOC;
252b5132 RH	77
	78	/* Allocate memory filled with spaces. Allocates using malloc. */
	79
	80	extern const char *spaces PARAMS ((int count));
	81
	82	/* Return the maximum error number for which strerror will return a
	83	string. */
	84
	85	extern int errno_max PARAMS ((void));
	86
	87	/* Return the name of an errno value (e.g., strerrno (EINVAL) returns
	88	"EINVAL"). */
	89
	90	extern const char *strerrno PARAMS ((int));
	91
	92	/* Given the name of an errno value, return the value. */
	93
	94	extern int strtoerrno PARAMS ((const char *));
	95
	96	/* ANSI's strerror(), but more robust. */
	97
	98	extern char *xstrerror PARAMS ((int));
	99
	100	/* Return the maximum signal number for which strsignal will return a
	101	string. */
	102
	103	extern int signo_max PARAMS ((void));
	104
	105	/* Return a signal message string for a signal number
	106	(e.g., strsignal (SIGHUP) returns something like "Hangup"). */
	107	/* This is commented out as it can conflict with one in system headers.
	108	We still document its existence though. */
	109
	110	/extern const char strsignal PARAMS ((int));*/
	111
	112	/* Return the name of a signal number (e.g., strsigno (SIGHUP) returns
	113	"SIGHUP"). */
	114
	115	extern const char *strsigno PARAMS ((int));
	116
	117	/* Given the name of a signal, return its number. */
	118
	119	extern int strtosigno PARAMS ((const char *));
	120
	121	/* Register a function to be run by xexit. Returns 0 on success. */
	122
	123	extern int xatexit PARAMS ((void (*fn) (void)));
	124
	125	/* Exit, calling all the functions registered with xatexit. */
	126
cc89ffe6	127	extern void xexit PARAMS ((int status)) ATTRIBUTE_NORETURN;
252b5132 RH	128
	129	/* Set the program name used by xmalloc. */
	130
	131	extern void xmalloc_set_program_name PARAMS ((const char *));
	132
	133	/* Allocate memory without fail. If malloc fails, this will print a
	134	message to stderr (using the name set by xmalloc_set_program_name,
	135	if any) and then call xexit. */
	136
	137	#ifdef ANSI_PROTOTYPES
	138	/* Get a definition for size_t. */
	139	#include <stddef.h>
cc89ffe6 ILT	140	/* Get a definition for va_list. */
cc89ffe6 ILT	141	#include <stdarg.h>
252b5132	142	#endif
cc89ffe6	143	extern PTR xmalloc PARAMS ((size_t)) ATTRIBUTE_MALLOC;
252b5132	144
cc89ffe6 ILT	145	/* Reallocate memory without fail. This works like xmalloc. Note,
	146	realloc type functions are not suitable for attribute malloc since
	147	they may return the same address across multiple calls. */
252b5132 RH	148
	149	extern PTR xrealloc PARAMS ((PTR, size_t));
	150
	151	/* Allocate memory without fail and set it to zero. This works like
	152	xmalloc. */
	153
cc89ffe6	154	extern PTR xcalloc PARAMS ((size_t, size_t)) ATTRIBUTE_MALLOC;
252b5132 RH	155
	156	/* Copy a string into a memory buffer without fail. */
	157
cc89ffe6 ILT	158	extern char xstrdup PARAMS ((const char )) ATTRIBUTE_MALLOC;
	159
	160	/* Copy an existing memory buffer to a new memory buffer without fail. */
	161
	162	extern PTR xmemdup PARAMS ((const PTR, size_t, size_t)) ATTRIBUTE_MALLOC;
252b5132 RH	163
	164	/* hex character manipulation routines */
	165
	166	#define _hex_array_size 256
	167	#define _hex_bad 99
	168	extern char _hex_value[_hex_array_size];
	169	extern void hex_init PARAMS ((void));
	170	#define hex_p(c) (hex_value (c) != _hex_bad)
	171	/* If you change this, note well: Some code relies on side effects in
	172	the argument being performed exactly once. */
	173	#define hex_value(c) (_hex_value[(unsigned char) (c)])
	174
	175	/* Definitions used by the pexecute routine. */
	176
	177	#define PEXECUTE_FIRST 1
	178	#define PEXECUTE_LAST 2
	179	#define PEXECUTE_ONE (PEXECUTE_FIRST + PEXECUTE_LAST)
	180	#define PEXECUTE_SEARCH 4
	181	#define PEXECUTE_VERBOSE 8
	182
	183	/* Execute a program. */
	184
	185	extern int pexecute PARAMS ((const char , char const , const char ,
	186	const char , char , char *, int));
	187
	188	/* Wait for pexecute to finish. */
	189
	190	extern int pwait PARAMS ((int, int *, int));
	191
cc89ffe6 ILT	192	/* Like sprintf but provides a pointer to malloc'd storage, which must
	193	be freed by the caller. */
	194
	195	extern int asprintf PARAMS ((char *, const char , ...)) ATTRIBUTE_PRINTF_2;
	196
	197	/* Like vsprintf but provides a pointer to malloc'd storage, which
	198	must be freed by the caller. */
	199
	200	extern int vasprintf PARAMS ((char *, const char , va_list))
	201	ATTRIBUTE_PRINTF(2,0);
	202
252b5132 RH	203	#ifdef __cplusplus
	204	}
	205	#endif
	206
	207
	208	#endif /* ! defined (LIBIBERTY_H) */