builtins/common.h

   1 /* common.h -- extern declarations for functions defined in common.c. */
   2
   3 /* Copyright (C) 1993-2004 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 it under
   8    the terms of the GNU General Public License as published by the Free
   9    Software Foundation; either version 2, or (at your option) any later
  10    version.
  11
  12    Bash is distributed in the hope that it will be useful, but WITHOUT ANY
  13    WARRANTY; without even the implied warranty of MERCHANTABILITY or
  14    FITNESS FOR A PARTICULAR PURPOSE.  See the GNU General Public License
  15    for more details.
  16
  17    You should have received a copy of the GNU General Public License along
  18    with Bash; see the file COPYING.  If not, write to the Free Software
  19    Foundation, 59 Temple Place, Suite 330, Boston, MA 02111 USA. */
  20
  21 #if  !defined (__COMMON_H)
  22 #  define __COMMON_H
  23
  24 #include "stdc.h"
  25
  26 #define ISOPTION(s, c)  (s[0] == '-' && !s[2] && s[1] == c)
  27
  28 /* Flag values for parse_and_execute () */
  29 #define SEVAL_NONINT    0x001
  30 #define SEVAL_INTERACT  0x002
  31 #define SEVAL_NOHIST    0x004
  32 #define SEVAL_NOFREE    0x008
  33 #define SEVAL_RESETLINE 0x010
  34
  35 /* Flags for describe_command, shared between type.def and command.def */
  36 #define CDESC_ALL               0x001   /* type -a */
  37 #define CDESC_SHORTDESC         0x002   /* command -V */
  38 #define CDESC_REUSABLE          0x004   /* command -v */
  39 #define CDESC_TYPE              0x008   /* type -t */
  40 #define CDESC_PATH_ONLY         0x010   /* type -p */
  41 #define CDESC_FORCE_PATH        0x020   /* type -ap or type -P */
  42 #define CDESC_NOFUNCS           0x040   /* type -f */
  43 #define CDESC_ABSPATH           0x080   /* convert to absolute path, no ./ */
  44
  45 /* Flags for get_job_by_name */
  46 #define JM_PREFIX               0x01    /* prefix of job name */
  47 #define JM_SUBSTRING            0x02    /* substring of job name */
  48 #define JM_EXACT                0x04    /* match job name exactly */
  49 #define JM_STOPPED              0x08    /* match stopped jobs only */
  50 #define JM_FIRSTMATCH           0x10    /* return first matching job */
  51
  52 /* Flags for remember_args and value of changed_dollar_vars */
  53 #define ARGS_NONE               0x0
  54 #define ARGS_INVOC              0x01
  55 #define ARGS_FUNC               0x02
  56 #define ARGS_SETBLTIN           0x04
  57
  58 /* Functions from common.c */
  59 extern void builtin_error __P((const char *, ...))  __attribute__((__format__ (printf, 1, 2)));
  60 extern void builtin_usage __P((void));
  61 extern void no_args __P((WORD_LIST *));
  62 extern int no_options __P((WORD_LIST *));
  63
  64 /* common error message functions */
  65 extern void sh_needarg __P((char *));
  66 extern void sh_neednumarg __P((char *));
  67 extern void sh_notfound __P((char *));
  68 extern void sh_invalidopt __P((char *));
  69 extern void sh_invalidoptname __P((char *));
  70 extern void sh_invalidid __P((char *));
  71 extern void sh_invalidnum __P((char *));
  72 extern void sh_invalidsig __P((char *));
  73 extern void sh_erange __P((char *, char *));
  74 extern void sh_badpid __P((char *));
  75 extern void sh_badjob __P((char *));
  76 extern void sh_readonly __P((const char *));
  77 extern void sh_nojobs __P((char *));
  78 extern void sh_restricted __P((char *));
  79 extern void sh_notbuiltin __P((char *));
  80 extern void sh_wrerror __P((void));
  81
  82 extern char **make_builtin_argv __P((WORD_LIST *, int *));
  83 extern void remember_args __P((WORD_LIST *, int));
  84
  85 extern int dollar_vars_changed __P((void));
  86 extern void set_dollar_vars_unchanged __P((void));
  87 extern void set_dollar_vars_changed __P((void));
  88
  89 extern intmax_t get_numeric_arg __P((WORD_LIST *, int));
  90 extern int get_exitstat __P((WORD_LIST *));
  91 extern int read_octal __P((char *));
  92
  93 /* Keeps track of the current working directory. */
  94 extern char *the_current_working_directory;
  95 extern char *get_working_directory __P((char *));
  96 extern void set_working_directory __P((char *));
  97
  98 #if defined (JOB_CONTROL)
  99 extern int get_job_by_name __P((const char *, int));
 100 extern int get_job_spec __P((WORD_LIST *));
 101 #endif
 102 extern int display_signal_list __P((WORD_LIST *, int));
 103
 104 /* It's OK to declare a function as returning a Function * without
 105    providing a definition of what a `Function' is. */
 106 extern struct builtin *builtin_address_internal __P((char *, int));
 107 extern sh_builtin_func_t *find_shell_builtin __P((char *));
 108 extern sh_builtin_func_t *builtin_address __P((char *));
 109 extern sh_builtin_func_t *find_special_builtin __P((char *));
 110 extern void initialize_shell_builtins __P((void));
 111
 112 /* Functions from exit.def */
 113 extern void bash_logout __P((void));
 114
 115 /* Functions from getopts.def */
 116 extern void getopts_reset __P((int));
 117
 118 /* Functions from set.def */
 119 extern int minus_o_option_value __P((char *));
 120 extern void list_minus_o_opts __P((int, int));
 121 extern char **get_minus_o_opts __P((void));
 122 extern int set_minus_o_option __P((int, char *));
 123
 124 extern void set_shellopts __P((void));
 125 extern void parse_shellopts __P((char *));
 126 extern void initialize_shell_options __P((int));
 127
 128 extern void reset_shell_options __P((void));
 129
 130 /* Functions from shopt.def */
 131 extern void reset_shopt_options __P((void));
 132 extern char **get_shopt_options __P((void));
 133
 134 extern int shopt_setopt __P((char *, int));
 135 extern int shopt_listopt __P((char *, int));
 136
 137 extern int set_login_shell __P((int));
 138
 139 /* Functions from type.def */
 140 extern int describe_command __P((char *, int));
 141
 142 /* Functions from setattr.def */
 143 extern int set_or_show_attributes __P((WORD_LIST *, int, int));
 144 extern int show_var_attributes __P((SHELL_VAR *, int, int));
 145 extern int show_name_attributes __P((char *, int));
 146 extern void set_var_attribute __P((char *, int, int));
 147
 148 /* Functions from pushd.def */
 149 extern char *get_dirstack_from_string __P((char *));
 150 extern char *get_dirstack_element __P((intmax_t, int));
 151 extern void set_dirstack_element __P((intmax_t, int, char *));
 152 extern WORD_LIST *get_directory_stack __P((int));
 153
 154 /* Functions from evalstring.c */
 155 extern int parse_and_execute __P((char *, const char *, int));
 156 extern void parse_and_execute_cleanup __P((void));
 157
 158 /* Functions from evalfile.c */
 159 extern int maybe_execute_file __P((const char *, int));
 160 extern int source_file __P((const char *, int));
 161 extern int fc_execute_file __P((const char *));
 162
 163 #endif /* !__COMMON_H */