general.h

   1 /* general.h -- defines that everybody likes to use. */
   2
   3 /* Copyright (C) 1993-2021 Free Software Foundation, Inc.
   4
   5    This file is part of GNU Bash, the Bourne Again SHell.
   6
   7    Bash is free software: you can redistribute it and/or modify
   8    it under the terms of the GNU General Public License as published by
   9    the Free Software Foundation, either version 3 of the License, or
  10    (at your option) any later version.
  11
  12    Bash is distributed in the hope that it will be useful,
  13    but WITHOUT ANY WARRANTY; without even the implied warranty of
  14    MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
  15    GNU General Public License for more details.
  16
  17    You should have received a copy of the GNU General Public License
  18    along with Bash.  If not, see <http://www.gnu.org/licenses/>.
  19 */
  20
  21 #if !defined (_GENERAL_H_)
  22 #define _GENERAL_H_
  23
  24 #include "stdc.h"
  25
  26 #include "bashtypes.h"
  27 #include "chartypes.h"
  28
  29 #if defined (HAVE_SYS_RESOURCE_H) && defined (RLIMTYPE)
  30 #  if defined (HAVE_SYS_TIME_H)
  31 #    include <sys/time.h>
  32 #  endif
  33 #  include <sys/resource.h>
  34 #endif
  35
  36 #if defined (HAVE_STRING_H)
  37 #  include <string.h>
  38 #else
  39 #  include <strings.h>
  40 #endif /* !HAVE_STRING_H */
  41
  42 #if defined (HAVE_LIMITS_H)
  43 #  include <limits.h>
  44 #endif
  45
  46 #include "xmalloc.h"
  47
  48 /* NULL pointer type. */
  49 #if !defined (NULL)
  50 #  if defined (__STDC__)
  51 #    define NULL ((void *) 0)
  52 #  else
  53 #    define NULL 0x0
  54 #  endif /* !__STDC__ */
  55 #endif /* !NULL */
  56
  57 /* Hardly used anymore */
  58 #define pointer_to_int(x)       (int)((char *)x - (char *)0)
  59
  60 #if defined (alpha) && defined (__GNUC__) && !defined (strchr) && !defined (__STDC__)
  61 extern char *strchr (), *strrchr ();
  62 #endif
  63
  64 #if !defined (strcpy) && (defined (HAVE_DECL_STRCPY) && !HAVE_DECL_STRCPY)
  65 extern char *strcpy PARAMS((char *, const char *));
  66 #endif
  67
  68 #if !defined (savestring)
  69 #  define savestring(x) (char *)strcpy (xmalloc (1 + strlen (x)), (x))
  70 #endif
  71
  72 #ifndef member
  73 #  define member(c, s) ((c) ? ((char *)mbschr ((s), (c)) != (char *)NULL) : 0)
  74 #endif
  75
  76 #ifndef whitespace
  77 #define whitespace(c) (((c) == ' ') || ((c) == '\t'))
  78 #endif
  79
  80 #ifndef CHAR_MAX
  81 #  ifdef __CHAR_UNSIGNED__
  82 #    define CHAR_MAX    0xff
  83 #  else
  84 #    define CHAR_MAX    0x7f
  85 #  endif
  86 #endif
  87
  88 #ifndef CHAR_BIT
  89 #  define CHAR_BIT 8
  90 #endif
  91
  92 /* Nonzero if the integer type T is signed.  */
  93 #define TYPE_SIGNED(t) (! ((t) 0 < (t) -1))
  94
  95 /* The width in bits of the integer type or expression T.
  96    Padding bits are not supported; this is checked at compile-time below.  */
  97 #define TYPE_WIDTH(t) (sizeof (t) * CHAR_BIT)
  98
  99 /* Bound on length of the string representing an unsigned integer
 100    value representable in B bits.  log10 (2.0) < 146/485.  The
 101       smallest value of B where this bound is not tight is 2621.  */
 102 #define INT_BITS_STRLEN_BOUND(b) (((b) * 146 + 484) / 485)
 103
 104 /* Bound on length of the string representing an integer value of type T.
 105    Subtract one for the sign bit if T is signed;
 106    302 / 1000 is log10 (2) rounded up;
 107    add one for integer division truncation;
 108    add one more for a minus sign if t is signed.  */
 109 #define INT_STRLEN_BOUND(t) \
 110   ((TYPE_WIDTH (t) - TYPE_SIGNED (t)) * 302 / 1000 \
 111    + 1 + TYPE_SIGNED (t))
 112
 113 /* Updated version adapted from gnulib/intprops.h, not used right now.
 114    Changes the approximation of log10(2) from 302/1000 to 146/485. */
 115 #if 0
 116 #define INT_STRLEN_BOUND(t) \
 117   (INT_BITS_STRLEN_BOUND (TYPE_WIDTH (t) - TYPE_SIGNED (t)) + TYPE_SIGNED(t))
 118 #endif
 119
 120 /* Bound on buffer size needed to represent an integer type or expression T,
 121    including the terminating null.  */
 122 #define INT_BUFSIZE_BOUND(t) (INT_STRLEN_BOUND (t) + 1)
 123
 124 /* Define exactly what a legal shell identifier consists of. */
 125 #define legal_variable_starter(c) (ISALPHA(c) || (c == '_'))
 126 #define legal_variable_char(c)  (ISALNUM(c) || c == '_')
 127
 128 /* Definitions used in subst.c and by the `read' builtin for field
 129    splitting. */
 130 #define spctabnl(c)     ((c) == ' ' || (c) == '\t' || (c) == '\n')
 131
 132 /* All structs which contain a `next' field should have that field
 133    as the first field in the struct.  This means that functions
 134    can be written to handle the general case for linked lists. */
 135 typedef struct g_list {
 136   struct g_list *next;
 137 } GENERIC_LIST;
 138
 139 /* Here is a generic structure for associating character strings
 140    with integers.  It is used in the parser for shell tokenization. */
 141 typedef struct {
 142   char *word;
 143   int token;
 144 } STRING_INT_ALIST;
 145
 146 /* A macro to avoid making an unnecessary function call. */
 147 #define REVERSE_LIST(list, type) \
 148   ((list && list->next) ? (type)list_reverse ((GENERIC_LIST *)list) \
 149                         : (type)(list))
 150
 151 #if __GNUC__ > 1
 152 #  define FASTCOPY(s, d, n)  __builtin_memcpy ((d), (s), (n))
 153 #else /* !__GNUC__ */
 154 #  if !defined (HAVE_BCOPY)
 155 #    if !defined (HAVE_MEMMOVE)
 156 #      define FASTCOPY(s, d, n)  memcpy ((d), (s), (n))
 157 #    else
 158 #      define FASTCOPY(s, d, n)  memmove ((d), (s), (n))
 159 #    endif /* !HAVE_MEMMOVE */
 160 #  else /* HAVE_BCOPY */
 161 #    define FASTCOPY(s, d, n)  bcopy ((s), (d), (n))
 162 #  endif /* HAVE_BCOPY */
 163 #endif /* !__GNUC__ */
 164
 165 /* String comparisons that possibly save a function call each. */
 166 #define STREQ(a, b) ((a)[0] == (b)[0] && strcmp(a, b) == 0)
 167 #define STREQN(a, b, n) ((n == 0) ? (1) \
 168                                   : ((a)[0] == (b)[0] && strncmp(a, b, n) == 0))
 169
 170 /* More convenience definitions that possibly save system or libc calls. */
 171 #define STRLEN(s) (((s) && (s)[0]) ? ((s)[1] ? ((s)[2] ? strlen(s) : 2) : 1) : 0)
 172 #define FREE(s)  do { if (s) free (s); } while (0)
 173 #define MEMBER(c, s) (((c) && c == (s)[0] && !(s)[1]) || (member(c, s)))
 174
 175 /* A fairly hairy macro to check whether an allocated string has more room,
 176    and to resize it using xrealloc if it does not.
 177    STR is the string (char *)
 178    CIND is the current index into the string (int)
 179    ROOM is the amount of additional room we need in the string (int)
 180    CSIZE is the currently-allocated size of STR (int)
 181    SINCR is how much to increment CSIZE before calling xrealloc (int) */
 182
 183 #define RESIZE_MALLOCED_BUFFER(str, cind, room, csize, sincr) \
 184   do { \
 185     if ((cind) + (room) >= csize) \
 186       { \
 187         while ((cind) + (room) >= csize) \
 188           csize += (sincr); \
 189         str = xrealloc (str, csize); \
 190       } \
 191   } while (0)
 192
 193 /* Function pointers can be declared as (Function *)foo. */
 194 #if !defined (_FUNCTION_DEF)
 195 #  define _FUNCTION_DEF
 196 typedef int Function ();
 197 typedef void VFunction ();
 198 typedef char *CPFunction ();            /* no longer used */
 199 typedef char **CPPFunction ();          /* no longer used */
 200 #endif /* _FUNCTION_DEF */
 201
 202 #ifndef SH_FUNCTION_TYPEDEF
 203 #  define SH_FUNCTION_TYPEDEF
 204
 205 /* Shell function typedefs with prototypes */
 206 /* `Generic' function pointer typedefs */
 207
 208 typedef int sh_intfunc_t PARAMS((int));
 209 typedef int sh_ivoidfunc_t PARAMS((void));
 210 typedef int sh_icpfunc_t PARAMS((char *));
 211 typedef int sh_icppfunc_t PARAMS((char **));
 212 typedef int sh_iptrfunc_t PARAMS((PTR_T));
 213
 214 typedef void sh_voidfunc_t PARAMS((void));
 215 typedef void sh_vintfunc_t PARAMS((int));
 216 typedef void sh_vcpfunc_t PARAMS((char *));
 217 typedef void sh_vcppfunc_t PARAMS((char **));
 218 typedef void sh_vptrfunc_t PARAMS((PTR_T));
 219
 220 typedef int sh_wdesc_func_t PARAMS((WORD_DESC *));
 221 typedef int sh_wlist_func_t PARAMS((WORD_LIST *));
 222
 223 typedef int sh_glist_func_t PARAMS((GENERIC_LIST *));
 224
 225 typedef char *sh_string_func_t PARAMS((char *));        /* like savestring, et al. */
 226
 227 typedef int sh_msg_func_t PARAMS((const char *, ...));  /* printf(3)-like */
 228 typedef void sh_vmsg_func_t PARAMS((const char *, ...));        /* printf(3)-like */
 229
 230 /* Specific function pointer typedefs.  Most of these could be done
 231    with #defines. */
 232 typedef void sh_sv_func_t PARAMS((char *));     /* sh_vcpfunc_t */
 233 typedef void sh_free_func_t PARAMS((PTR_T));    /* sh_vptrfunc_t */
 234 typedef void sh_resetsig_func_t PARAMS((int));  /* sh_vintfunc_t */
 235
 236 typedef int sh_ignore_func_t PARAMS((const char *));    /* sh_icpfunc_t */
 237
 238 typedef int sh_assign_func_t PARAMS((const char *));
 239 typedef int sh_wassign_func_t PARAMS((WORD_DESC *, int));
 240
 241 typedef int sh_load_func_t PARAMS((char *));
 242 typedef void sh_unload_func_t PARAMS((char *));
 243
 244 typedef int sh_builtin_func_t PARAMS((WORD_LIST *)); /* sh_wlist_func_t */
 245
 246 #endif /* SH_FUNCTION_TYPEDEF */
 247
 248 #define NOW     ((time_t) time ((time_t *) 0))
 249 #define GETTIME(tv)     gettimeofday(&(tv), NULL)
 250
 251 /* Some defines for calling file status functions. */
 252 #define FS_EXISTS         0x1
 253 #define FS_EXECABLE       0x2
 254 #define FS_EXEC_PREFERRED 0x4
 255 #define FS_EXEC_ONLY      0x8
 256 #define FS_DIRECTORY      0x10
 257 #define FS_NODIRS         0x20
 258 #define FS_READABLE       0x40
 259
 260 /* Default maximum for move_to_high_fd */
 261 #define HIGH_FD_MAX     256
 262
 263 /* The type of function passed as the fourth argument to qsort(3). */
 264 #ifdef __STDC__
 265 typedef int QSFUNC (const void *, const void *);
 266 #else
 267 typedef int QSFUNC ();
 268 #endif
 269
 270 /* Some useful definitions for Unix pathnames.  Argument convention:
 271    x == string, c == character */
 272
 273 #if !defined (__CYGWIN__)
 274 #  define ABSPATH(x)    ((x)[0] == '/')
 275 #  define RELPATH(x)    ((x)[0] != '/')
 276 #else /* __CYGWIN__ */
 277 #  define ABSPATH(x)    (((x)[0] && ISALPHA((unsigned char)(x)[0]) && (x)[1] == ':') || ISDIRSEP((x)[0]))
 278 #  define RELPATH(x)    (ABSPATH(x) == 0)
 279 #endif /* __CYGWIN__ */
 280
 281 #define ROOTEDPATH(x)   (ABSPATH(x))
 282
 283 #define DIRSEP  '/'
 284 #if !defined (__CYGWIN__)
 285 #  define ISDIRSEP(c)   ((c) == '/')
 286 #else
 287 #  define ISDIRSEP(c)   ((c) == '/' || (c) == '\\')
 288 #endif /* __CYGWIN__ */
 289 #define PATHSEP(c)      (ISDIRSEP(c) || (c) == 0)
 290
 291 #define DOT_OR_DOTDOT(s)        (s[0] == '.' && (s[1] == 0 || (s[1] == '.' && s[2] == 0)))
 292
 293 #if defined (HANDLE_MULTIBYTE)
 294 #define WDOT_OR_DOTDOT(w)       (w[0] == L'.' && (w[1] == L'\0' || (w[1] == L'.' && w[2] == L'\0')))
 295 #endif
 296
 297 #if 0
 298 /* Declarations for functions defined in xmalloc.c */
 299 extern PTR_T xmalloc PARAMS((size_t));
 300 extern PTR_T xrealloc PARAMS((void *, size_t));
 301 extern void xfree PARAMS((void *));
 302 #endif
 303
 304 /* Declarations for functions defined in general.c */
 305 extern void posix_initialize PARAMS((int));
 306
 307 extern int num_posix_options PARAMS((void));
 308 extern char *get_posix_options PARAMS((char *));
 309 extern void set_posix_options PARAMS((const char *));
 310
 311 extern void save_posix_options PARAMS((void));
 312
 313 #if defined (RLIMTYPE)
 314 extern RLIMTYPE string_to_rlimtype PARAMS((char *));
 315 extern void print_rlimtype PARAMS((RLIMTYPE, int));
 316 #endif
 317
 318 extern int all_digits PARAMS((const char *));
 319 extern int legal_number PARAMS((const char *, intmax_t *));
 320 extern int legal_identifier PARAMS((const char *));
 321 extern int importable_function_name PARAMS((const char *, size_t));
 322 extern int exportable_function_name PARAMS((const char *));
 323 extern int check_identifier PARAMS((WORD_DESC *, int));
 324 extern int valid_nameref_value PARAMS((const char *, int));
 325 extern int check_selfref PARAMS((const char *, char *, int));
 326 extern int legal_alias_name PARAMS((const char *, int));
 327 extern int line_isblank PARAMS((const char *));
 328 extern int assignment PARAMS((const char *, int));
 329
 330 extern int sh_unset_nodelay_mode PARAMS((int));
 331 extern int sh_setclexec PARAMS((int));
 332 extern int sh_validfd PARAMS((int));
 333 extern int fd_ispipe PARAMS((int));
 334 extern void check_dev_tty PARAMS((void));
 335 extern int move_to_high_fd PARAMS((int, int, int));
 336 extern int check_binary_file PARAMS((const char *, int));
 337
 338 #ifdef _POSIXSTAT_H_
 339 extern int same_file PARAMS((const char *, const char *, struct stat *, struct stat *));
 340 #endif
 341
 342 extern int sh_openpipe PARAMS((int *));
 343 extern int sh_closepipe PARAMS((int *));
 344
 345 extern int file_exists PARAMS((const char *));
 346 extern int file_isdir PARAMS((const char  *));
 347 extern int file_iswdir PARAMS((const char  *));
 348 extern int path_dot_or_dotdot PARAMS((const char *));
 349 extern int absolute_pathname PARAMS((const char *));
 350 extern int absolute_program PARAMS((const char *));
 351
 352 extern char *make_absolute PARAMS((const char *, const char *));
 353 extern char *base_pathname PARAMS((char *));
 354 extern char *full_pathname PARAMS((char *));
 355 extern char *polite_directory_format PARAMS((char *));
 356 extern char *trim_pathname PARAMS((char *, int));
 357 extern char *printable_filename PARAMS((char *, int));
 358
 359 extern char *extract_colon_unit PARAMS((char *, int *));
 360
 361 extern void tilde_initialize PARAMS((void));
 362 extern char *bash_tilde_find_word PARAMS((const char *, int, int *));
 363 extern char *bash_tilde_expand PARAMS((const char *, int));
 364
 365 extern int group_member PARAMS((gid_t));
 366 extern char **get_group_list PARAMS((int *));
 367 extern int *get_group_array PARAMS((int *));
 368
 369 extern char *conf_standard_path PARAMS((void));
 370 extern int default_columns PARAMS((void));
 371
 372 #endif  /* _GENERAL_H_ */