include/libiberty.h

   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
  22 extern char **buildargv PARAMS ((char *));
  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
  31 extern char **dupargv PARAMS ((char **));
  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
  39 #if defined (__GNU_LIBRARY__ ) || defined (__linux__) || defined (__FreeBSD__) || defined (__CYGWIN__) || defined (__CYGWIN32__)
  40 extern char *basename PARAMS ((const char *));
  41 #else
  42 extern char *basename ();
  43 #endif
  44
  45 /* Concatenate an arbitrary number of strings, up to (char *) NULL.
  46    Allocates memory using xmalloc.  */
  47
  48 extern char *concat PARAMS ((const char *, ...));
  49
  50 /* Check whether two file descriptors refer to the same file.  */
  51
  52 extern int fdmatch PARAMS ((int fd1, int fd2));
  53
  54 /* Get the working directory.  The result is cached, so don't call
  55    chdir() between calls to getpwd().  */
  56
  57 extern char * getpwd PARAMS ((void));
  58
  59 /* Get the amount of time the process has run, in microseconds.  */
  60
  61 extern long get_run_time PARAMS ((void));
  62
  63 /* Choose a temporary directory to use for scratch files.  */
  64
  65 extern char *choose_temp_base PARAMS ((void));
  66
  67 /* Allocate memory filled with spaces.  Allocates using malloc.  */
  68
  69 extern const char *spaces PARAMS ((int count));
  70
  71 /* Return the maximum error number for which strerror will return a
  72    string.  */
  73
  74 extern int errno_max PARAMS ((void));
  75
  76 /* Return the name of an errno value (e.g., strerrno (EINVAL) returns
  77    "EINVAL").  */
  78
  79 extern const char *strerrno PARAMS ((int));
  80
  81 /* Given the name of an errno value, return the value.  */
  82
  83 extern int strtoerrno PARAMS ((const char *));
  84
  85 /* ANSI's strerror(), but more robust.  */
  86
  87 extern char *xstrerror PARAMS ((int));
  88
  89 /* Return the maximum signal number for which strsignal will return a
  90    string.  */
  91
  92 extern int signo_max PARAMS ((void));
  93
  94 /* Return a signal message string for a signal number
  95    (e.g., strsignal (SIGHUP) returns something like "Hangup").  */
  96 /* This is commented out as it can conflict with one in system headers.
  97    We still document its existence though.  */
  98
  99 /*extern const char *strsignal PARAMS ((int));*/
 100
 101 /* Return the name of a signal number (e.g., strsigno (SIGHUP) returns
 102    "SIGHUP").  */
 103
 104 extern const char *strsigno PARAMS ((int));
 105
 106 /* Given the name of a signal, return its number.  */
 107
 108 extern int strtosigno PARAMS ((const char *));
 109
 110 /* Register a function to be run by xexit.  Returns 0 on success.  */
 111
 112 extern int xatexit PARAMS ((void (*fn) (void)));
 113
 114 /* Exit, calling all the functions registered with xatexit.  */
 115
 116 #ifndef __GNUC__
 117 extern void xexit PARAMS ((int status));
 118 #else
 119 void xexit PARAMS ((int status)) __attribute__ ((noreturn));
 120 #endif
 121
 122 /* Set the program name used by xmalloc.  */
 123
 124 extern void xmalloc_set_program_name PARAMS ((const char *));
 125
 126 /* Allocate memory without fail.  If malloc fails, this will print a
 127    message to stderr (using the name set by xmalloc_set_program_name,
 128    if any) and then call xexit.  */
 129
 130 #ifdef ANSI_PROTOTYPES
 131 /* Get a definition for size_t.  */
 132 #include <stddef.h>
 133 #endif
 134 extern PTR xmalloc PARAMS ((size_t));
 135
 136 /* Reallocate memory without fail.  This works like xmalloc.
 137
 138    FIXME: We do not declare the parameter types for the same reason as
 139    xmalloc.  */
 140
 141 extern PTR xrealloc PARAMS ((PTR, size_t));
 142
 143 /* Allocate memory without fail and set it to zero.  This works like
 144    xmalloc.  */
 145
 146 extern PTR xcalloc PARAMS ((size_t, size_t));
 147
 148 /* Copy a string into a memory buffer without fail.  */
 149
 150 extern char *xstrdup PARAMS ((const char *));
 151
 152 /* hex character manipulation routines */
 153
 154 #define _hex_array_size 256
 155 #define _hex_bad        99
 156 extern char _hex_value[_hex_array_size];
 157 extern void hex_init PARAMS ((void));
 158 #define hex_p(c)        (hex_value (c) != _hex_bad)
 159 /* If you change this, note well: Some code relies on side effects in
 160    the argument being performed exactly once.  */
 161 #define hex_value(c)    (_hex_value[(unsigned char) (c)])
 162
 163 /* Definitions used by the pexecute routine.  */
 164
 165 #define PEXECUTE_FIRST   1
 166 #define PEXECUTE_LAST    2
 167 #define PEXECUTE_ONE     (PEXECUTE_FIRST + PEXECUTE_LAST)
 168 #define PEXECUTE_SEARCH  4
 169 #define PEXECUTE_VERBOSE 8
 170
 171 /* Execute a program.  */
 172
 173 extern int pexecute PARAMS ((const char *, char * const *, const char *,
 174                             const char *, char **, char **, int));
 175
 176 /* Wait for pexecute to finish.  */
 177
 178 extern int pwait PARAMS ((int, int *, int));
 179
 180 #ifdef __cplusplus
 181 }
 182 #endif
 183
 184
 185 #endif /* ! defined (LIBIBERTY_H) */