1 /* common.h -- extern declarations for functions defined in common.c. */
3 /* Copyright (C) 1993-2010 Free Software Foundation, Inc.
5 This file is part of GNU Bash, the Bourne Again SHell.
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.
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.
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/>.
21 #if !defined (__COMMON_H)
26 #define ISOPTION(s, c) (s[0] == '-' && !s[2] && s[1] == c)
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 #define SEVAL_PARSEONLY 0x020
35 #define SEVAL_NOLONGJMP 0x040
36 #define SEVAL_FUNCDEF 0x080 /* only allow function definitions */
37 #define SEVAL_ONECMD 0x100 /* only allow a single command */
39 /* Flags for describe_command, shared between type.def and command.def */
40 #define CDESC_ALL 0x001 /* type -a */
41 #define CDESC_SHORTDESC 0x002 /* command -V */
42 #define CDESC_REUSABLE 0x004 /* command -v */
43 #define CDESC_TYPE 0x008 /* type -t */
44 #define CDESC_PATH_ONLY 0x010 /* type -p */
45 #define CDESC_FORCE_PATH 0x020 /* type -ap or type -P */
46 #define CDESC_NOFUNCS 0x040 /* type -f */
47 #define CDESC_ABSPATH 0x080 /* convert to absolute path, no ./ */
49 /* Flags for get_job_by_name */
50 #define JM_PREFIX 0x01 /* prefix of job name */
51 #define JM_SUBSTRING 0x02 /* substring of job name */
52 #define JM_EXACT 0x04 /* match job name exactly */
53 #define JM_STOPPED 0x08 /* match stopped jobs only */
54 #define JM_FIRSTMATCH 0x10 /* return first matching job */
56 /* Flags for remember_args and value of changed_dollar_vars */
58 #define ARGS_INVOC 0x01
59 #define ARGS_FUNC 0x02
60 #define ARGS_SETBLTIN 0x04
62 /* Functions from common.c */
63 extern void builtin_error __P((const char *, ...)) __attribute__((__format__ (printf, 1, 2)));
64 extern void builtin_warning __P((const char *, ...)) __attribute__((__format__ (printf, 1, 2)));
65 extern void builtin_usage __P((void));
66 extern void no_args __P((WORD_LIST *));
67 extern int no_options __P((WORD_LIST *));
69 /* common error message functions */
70 extern void sh_needarg __P((char *));
71 extern void sh_neednumarg __P((char *));
72 extern void sh_notfound __P((char *));
73 extern void sh_invalidopt __P((char *));
74 extern void sh_invalidoptname __P((char *));
75 extern void sh_invalidid __P((char *));
76 extern void sh_invalidnum __P((char *));
77 extern void sh_invalidsig __P((char *));
78 extern void sh_erange __P((char *, char *));
79 extern void sh_badpid __P((char *));
80 extern void sh_badjob __P((char *));
81 extern void sh_readonly __P((const char *));
82 extern void sh_nojobs __P((char *));
83 extern void sh_restricted __P((char *));
84 extern void sh_notbuiltin __P((char *));
85 extern void sh_wrerror __P((void));
86 extern void sh_ttyerror __P((int));
87 extern int sh_chkwrite __P((int));
89 extern char **make_builtin_argv __P((WORD_LIST *, int *));
90 extern void remember_args __P((WORD_LIST *, int));
92 extern int dollar_vars_changed __P((void));
93 extern void set_dollar_vars_unchanged __P((void));
94 extern void set_dollar_vars_changed __P((void));
96 extern int get_numeric_arg __P((WORD_LIST *, int, intmax_t *));
97 extern int get_exitstat __P((WORD_LIST *));
98 extern int read_octal __P((char *));
100 /* Keeps track of the current working directory. */
101 extern char *the_current_working_directory;
102 extern char *get_working_directory __P((char *));
103 extern void set_working_directory __P((char *));
105 #if defined (JOB_CONTROL)
106 extern int get_job_by_name __P((const char *, int));
107 extern int get_job_spec __P((WORD_LIST *));
109 extern int display_signal_list __P((WORD_LIST *, int));
111 /* It's OK to declare a function as returning a Function * without
112 providing a definition of what a `Function' is. */
113 extern struct builtin *builtin_address_internal __P((char *, int));
114 extern sh_builtin_func_t *find_shell_builtin __P((char *));
115 extern sh_builtin_func_t *builtin_address __P((char *));
116 extern sh_builtin_func_t *find_special_builtin __P((char *));
117 extern void initialize_shell_builtins __P((void));
119 /* Functions from exit.def */
120 extern void bash_logout __P((void));
122 /* Functions from getopts.def */
123 extern void getopts_reset __P((int));
125 /* Functions from set.def */
126 extern int minus_o_option_value __P((char *));
127 extern void list_minus_o_opts __P((int, int));
128 extern char **get_minus_o_opts __P((void));
129 extern int set_minus_o_option __P((int, char *));
131 extern void set_shellopts __P((void));
132 extern void parse_shellopts __P((char *));
133 extern void initialize_shell_options __P((int));
135 extern void reset_shell_options __P((void));
137 /* Functions from shopt.def */
138 extern void reset_shopt_options __P((void));
139 extern char **get_shopt_options __P((void));
141 extern int shopt_setopt __P((char *, int));
142 extern int shopt_listopt __P((char *, int));
144 extern int set_login_shell __P((char *, int));
146 extern void set_bashopts __P((void));
147 extern void parse_bashopts __P((char *));
148 extern void initialize_bashopts __P((int));
150 extern void set_compatibility_opts __P((void));
152 /* Functions from type.def */
153 extern int describe_command __P((char *, int));
155 /* Functions from setattr.def */
156 extern int set_or_show_attributes __P((WORD_LIST *, int, int));
157 extern int show_all_var_attributes __P((int, int));
158 extern int show_var_attributes __P((SHELL_VAR *, int, int));
159 extern int show_name_attributes __P((char *, int));
160 extern int show_func_attributes __P((char *, int));
161 extern void set_var_attribute __P((char *, int, int));
163 /* Functions from pushd.def */
164 extern char *get_dirstack_from_string __P((char *));
165 extern char *get_dirstack_element __P((intmax_t, int));
166 extern void set_dirstack_element __P((intmax_t, int, char *));
167 extern WORD_LIST *get_directory_stack __P((int));
169 /* Functions from evalstring.c */
170 extern int parse_and_execute __P((char *, const char *, int));
171 extern int evalstring __P((char *, const char *, int));
172 extern void parse_and_execute_cleanup __P((void));
173 extern int parse_string __P((char *, const char *, int, char **));
175 /* Functions from evalfile.c */
176 extern int maybe_execute_file __P((const char *, int));
177 extern int source_file __P((const char *, int));
178 extern int fc_execute_file __P((const char *));
180 #endif /* !__COMMON_H */