/* general.h -- defines that everybody likes to use. *//* Copyright (C) 1993-2009 Free Software Foundation, Inc.   This file is part of GNU Bash, the Bourne Again SHell.   Bash 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 3 of the License, or   (at your option) any later version.   Bash 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 Bash.  If not, see <http://www.gnu.org/licenses/>.*/#if !defined (_GENERAL_H_)#define _GENERAL_H_#include "stdc.h"#include "bashtypes.h"#include "chartypes.h"#if defined (HAVE_SYS_RESOURCE_H) && defined (RLIMTYPE)#  if defined (HAVE_SYS_TIME_H)#    include <sys/time.h>#  endif#  include <sys/resource.h>#endif#if defined (HAVE_STRING_H)#  include <string.h>#else#  include <strings.h>#endif /* !HAVE_STRING_H */#if defined (HAVE_LIMITS_H)#  include <limits.h>#endif#include "xmalloc.h"/* NULL pointer type. */#if !defined (NULL)#  if defined (__STDC__)#    define NULL ((void *) 0)#  else#    define NULL 0x0#  endif /* !__STDC__ */#endif /* !NULL *//* Hardly used anymore */#define pointer_to_int(x)	(int)((char *)x - (char *)0)#if defined (alpha) && defined (__GNUC__) && !defined (strchr) && !defined (__STDC__)extern char *strchr (), *strrchr ();#endif#if !defined (strcpy) && (defined (HAVE_DECL_STRCPY) && !HAVE_DECL_STRCPY)extern char *strcpy __P((char *, const char *));#endif#if !defined (savestring)#  define savestring(x) (char *)strcpy (xmalloc (1 + strlen (x)), (x))#endif#ifndef member#  define member(c, s) ((c) ? ((char *)mbschr ((s), (c)) != (char *)NULL) : 0)#endif#ifndef whitespace#define whitespace(c) (((c) == ' ') || ((c) == '\t'))#endif#ifndef CHAR_MAX#  ifdef __CHAR_UNSIGNED__#    define CHAR_MAX	0xff#  else#    define CHAR_MAX	0x7f#  endif#endif#ifndef CHAR_BIT#  define CHAR_BIT 8#endif/* Nonzero if the integer type T is signed.  */#define TYPE_SIGNED(t) (! ((t) 0 < (t) -1))/* Bound on length of the string representing an integer value of type T.   Subtract one for the sign bit if T is signed;   302 / 1000 is log10 (2) rounded up;   add one for integer division truncation;   add one more for a minus sign if t is signed.  */#define INT_STRLEN_BOUND(t) \  ((sizeof (t) * CHAR_BIT - TYPE_SIGNED (t)) * 302 / 1000 \   + 1 + TYPE_SIGNED (t))/* Define exactly what a legal shell identifier consists of. */#define legal_variable_starter(c) (ISALPHA(c) || (c == '_'))#define legal_variable_char(c)	(ISALNUM(c) || c == '_')/* Definitions used in subst.c and by the `read' builtin for field   splitting. */#define spctabnl(c)	((c) == ' ' || (c) == '\t' || (c) == '\n')/* All structs which contain a `next' field should have that field   as the first field in the struct.  This means that functions   can be written to handle the general case for linked lists. */typedef struct g_list {  struct g_list *next;} GENERIC_LIST;/* Here is a generic structure for associating character strings   with integers.  It is used in the parser for shell tokenization. */typedef struct {  char *word;  int token;} STRING_INT_ALIST;/* A macro to avoid making an uneccessary function call. */#define REVERSE_LIST(list, type) \  ((list && list->next) ? (type)list_reverse ((GENERIC_LIST *)list) \			: (type)(list))#if __GNUC__ > 1#  define FASTCOPY(s, d, n)  __builtin_memcpy ((d), (s), (n))#else /* !__GNUC__ */#  if !defined (HAVE_BCOPY)#    if !defined (HAVE_MEMMOVE)#      define FASTCOPY(s, d, n)  memcpy ((d), (s), (n))#    else#      define FASTCOPY(s, d, n)  memmove ((d), (s), (n))#    endif /* !HAVE_MEMMOVE */#  else /* HAVE_BCOPY */#    define FASTCOPY(s, d, n)  bcopy ((s), (d), (n))#  endif /* HAVE_BCOPY */#endif /* !__GNUC__ *//* String comparisons that possibly save a function call each. */#define STREQ(a, b) ((a)[0] == (b)[0] && strcmp(a, b) == 0)#define STREQN(a, b, n) ((n == 0) ? (1) \				  : ((a)[0] == (b)[0] && strncmp(a, b, n) == 0))/* More convenience definitions that possibly save system or libc calls. */#define STRLEN(s) (((s) && (s)[0]) ? ((s)[1] ? ((s)[2] ? strlen(s) : 2) : 1) : 0)#define FREE(s)  do { if (s) free (s); } while (0)#define MEMBER(c, s) (((c) && c == (s)[0] && !(s)[1]) || (member(c, s)))/* A fairly hairy macro to check whether an allocated string has more room,   and to resize it using xrealloc if it does not.   STR is the string (char *)   CIND is the current index into the string (int)   ROOM is the amount of additional room we need in the string (int)   CSIZE is the currently-allocated size of STR (int)   SINCR is how much to increment CSIZE before calling xrealloc (int) */#define RESIZE_MALLOCED_BUFFER(str, cind, room, csize, sincr) \  do { \    if ((cind) + (room) >= csize) \      { \	while ((cind) + (room) >= csize) \	  csize += (sincr); \	str = xrealloc (str, csize); \      } \  } while (0)/* Function pointers can be declared as (Function *)foo. */#if !defined (_FUNCTION_DEF)#  define _FUNCTION_DEFtypedef int Function ();typedef void VFunction ();typedef char *CPFunction ();		/* no longer used */typedef char **CPPFunction ();		/* no longer used */#endif /* _FUNCTION_DEF */#ifndef SH_FUNCTION_TYPEDEF#  define SH_FUNCTION_TYPEDEF/* Shell function typedefs with prototypes *//* `Generic' function pointer typedefs */typedef int sh_intfunc_t __P((int));typedef int sh_ivoidfunc_t __P((void));typedef int sh_icpfunc_t __P((char *));typedef int sh_icppfunc_t __P((char **));typedef int sh_iptrfunc_t __P((PTR_T));typedef void sh_voidfunc_t __P((void));typedef void sh_vintfunc_t __P((int));typedef void sh_vcpfunc_t __P((char *));typedef void sh_vcppfunc_t __P((char **));typedef void sh_vptrfunc_t __P((PTR_T));typedef int sh_wdesc_func_t __P((WORD_DESC *));typedef int sh_wlist_func_t __P((WORD_LIST *));typedef int sh_glist_func_t __P((GENERIC_LIST *));typedef char *sh_string_func_t __P((char *));	/* like savestring, et al. */typedef int sh_msg_func_t __P((const char *, ...));	/* printf(3)-like */typedef void sh_vmsg_func_t __P((const char *, ...));	/* printf(3)-like *//* Specific function pointer typedefs.  Most of these could be done   with #defines. */typedef void sh_sv_func_t __P((char *));	/* sh_vcpfunc_t */typedef void sh_free_func_t __P((PTR_T));	/* sh_vptrfunc_t */typedef void sh_resetsig_func_t __P((int));	/* sh_vintfunc_t */typedef int sh_ignore_func_t __P((const char *));	/* sh_icpfunc_t */typedef int sh_assign_func_t __P((const char *));typedef int sh_wassign_func_t __P((WORD_DESC *, int));typedef int sh_builtin_func_t __P((WORD_LIST *)); /* sh_wlist_func_t */#endif /* SH_FUNCTION_TYPEDEF */#define NOW	((time_t) time ((time_t *) 0))/* Some defines for calling file status functions. */#define FS_EXISTS	  0x1#define FS_EXECABLE	  0x2#define FS_EXEC_PREFERRED 0x4#define FS_EXEC_ONLY	  0x8#define FS_DIRECTORY	  0x10#define FS_NODIRS	  0x20#define FS_READABLE	  0x40/* Default maximum for move_to_high_fd */#define HIGH_FD_MAX	256/* The type of function passed as the fourth argument to qsort(3). */#ifdef __STDC__typedef int QSFUNC (const void *, const void *);#elsetypedef int QSFUNC ();#endif /* Some useful definitions for Unix pathnames.  Argument convention:   x == string, c == character */#if !defined (__CYGWIN__)#  define ABSPATH(x)	((x)[0] == '/')#  define RELPATH(x)	((x)[0] != '/')#else /* __CYGWIN__ */#  define ABSPATH(x)	(((x)[0] && ISALPHA((unsigned char)(x)[0]) && (x)[1] == ':') || ISDIRSEP((x)[0]))#  define RELPATH(x)	(ABSPATH(x) == 0)#endif /* __CYGWIN__ */#define ROOTEDPATH(x)	(ABSPATH(x))#define DIRSEP	'/'#if !defined (__CYGWIN__)#  define ISDIRSEP(c)	((c) == '/')#else#  define ISDIRSEP(c)	((c) == '/' || (c) == '\\')#endif /* __CYGWIN__ */#define PATHSEP(c)	(ISDIRSEP(c) || (c) == 0)#if 0/* Declarations for functions defined in xmalloc.c */extern PTR_T xmalloc __P((size_t));extern PTR_T xrealloc __P((void *, size_t));extern void xfree __P((void *));#endif/* Declarations for functions defined in general.c */extern void posix_initialize __P((int));#if defined (RLIMTYPE)extern RLIMTYPE string_to_rlimtype __P((char *));extern void print_rlimtype __P((RLIMTYPE, int));#endifextern int all_digits __P((char *));extern int legal_number __P((const char *, intmax_t *));extern int legal_identifier __P((char *));extern int check_identifier __P((WORD_DESC *, int));extern int legal_alias_name __P((char *, int));extern int assignment __P((const char *, int));extern int sh_unset_nodelay_mode __P((int));extern int sh_validfd __P((int));extern int fd_ispipe __P((int));extern void check_dev_tty __P((void));extern int move_to_high_fd __P((int, int, int));extern int check_binary_file __P((char *, int));#ifdef _POSIXSTAT_H_extern int same_file __P((char *, char *, struct stat *, struct stat *));#endifextern int sh_openpipe __P((int *));extern int sh_closepipe __P((int *));extern int file_exists __P((char *));extern int file_isdir __P((char  *));extern int file_iswdir __P((char  *));extern int dot_or_dotdot __P((const char *));extern int absolute_pathname __P((const char *));extern int absolute_program __P((const char *));extern char *make_absolute __P((char *, char *));extern char *base_pathname __P((char *));extern char *full_pathname __P((char *));extern char *polite_directory_format __P((char *));extern char *trim_pathname __P((char *, int));extern char *extract_colon_unit __P((char *, int *));extern void tilde_initialize __P((void));extern char *bash_tilde_find_word __P((const char *, int, int *));extern char *bash_tilde_expand __P((const char *, int));extern int group_member __P((gid_t));extern char **get_group_list __P((int *));extern int *get_group_array __P((int *));#endif	/* _GENERAL_H_ */