mirror of
https://https.git.savannah.gnu.org/git/bash.git
synced 2026-06-21 12:57:58 +02:00
Chet Ramey
293 lines
9.6 KiB
C
293 lines
9.6 KiB
C
/* common.h -- extern declarations for functions defined in common.c. */
|
|
|
|
/* Copyright (C) 1993-2022 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 (__COMMON_H)
|
|
# define __COMMON_H
|
|
|
|
#include "stdc.h"
|
|
|
|
#define ISOPTION(s, c) (s[0] == '-' && s[1] == c && !s[2])
|
|
#define ISHELP(s) (STREQ ((s), "--help"))
|
|
|
|
#define CHECK_HELPOPT(l) \
|
|
do { \
|
|
if ((l) && (l)->word && ISHELP((l)->word->word)) \
|
|
{ \
|
|
builtin_help (); \
|
|
return (EX_USAGE); \
|
|
} \
|
|
} while (0)
|
|
|
|
#define CASE_HELPOPT \
|
|
case GETOPT_HELP: \
|
|
builtin_help (); \
|
|
return (EX_USAGE)
|
|
|
|
/* Flag values for parse_and_execute () and parse_string () */
|
|
#define SEVAL_NONINT 0x001
|
|
#define SEVAL_INTERACT 0x002
|
|
#define SEVAL_NOHIST 0x004
|
|
#define SEVAL_NOFREE 0x008
|
|
#define SEVAL_RESETLINE 0x010
|
|
#define SEVAL_PARSEONLY 0x020
|
|
#define SEVAL_NOLONGJMP 0x040
|
|
#define SEVAL_FUNCDEF 0x080 /* only allow function definitions */
|
|
#define SEVAL_ONECMD 0x100 /* only allow a single command */
|
|
#define SEVAL_NOHISTEXP 0x200 /* inhibit history expansion */
|
|
#define SEVAL_NOOPTIMIZE 0x400 /* don't try to set optimization flags */
|
|
#define SEVAL_NOTIFY 0x800 /* want job notifications */
|
|
|
|
/* Flags for describe_command, shared between type.def and command.def */
|
|
#define CDESC_ALL 0x001 /* type -a */
|
|
#define CDESC_SHORTDESC 0x002 /* command -V */
|
|
#define CDESC_REUSABLE 0x004 /* command -v */
|
|
#define CDESC_TYPE 0x008 /* type -t */
|
|
#define CDESC_PATH_ONLY 0x010 /* type -p */
|
|
#define CDESC_FORCE_PATH 0x020 /* type -ap or type -P */
|
|
#define CDESC_NOFUNCS 0x040 /* type -f */
|
|
#define CDESC_ABSPATH 0x080 /* convert to absolute path, no ./ */
|
|
#define CDESC_STDPATH 0x100 /* command -p */
|
|
|
|
/* Flags for get_job_by_name */
|
|
#define JM_PREFIX 0x01 /* prefix of job name */
|
|
#define JM_SUBSTRING 0x02 /* substring of job name */
|
|
#define JM_EXACT 0x04 /* match job name exactly */
|
|
#define JM_STOPPED 0x08 /* match stopped jobs only */
|
|
#define JM_FIRSTMATCH 0x10 /* return first matching job */
|
|
|
|
/* Flags for remember_args and value of changed_dollar_vars */
|
|
#define ARGS_NONE 0x0
|
|
#define ARGS_INVOC 0x01
|
|
#define ARGS_FUNC 0x02
|
|
#define ARGS_SETBLTIN 0x04
|
|
|
|
/* Maximum number of attribute letters */
|
|
#define MAX_ATTRIBUTES 16
|
|
|
|
/* Functions from common.c */
|
|
extern void builtin_error (const char *, ...) __attribute__((__format__ (printf, 1, 2)));
|
|
extern void builtin_warning (const char *, ...) __attribute__((__format__ (printf, 1, 2)));
|
|
extern void builtin_usage (void);
|
|
extern void no_args (WORD_LIST *, int);
|
|
extern int no_options (WORD_LIST *);
|
|
|
|
/* common error message functions */
|
|
extern void sh_needarg (const char *);
|
|
extern void sh_neednumarg (const char *);
|
|
extern void sh_notfound (const char *);
|
|
extern void sh_invalidopt (const char *);
|
|
extern void sh_invalidoptname (const char *);
|
|
extern void sh_invalidid (const char *);
|
|
extern void sh_invalidnum (const char *);
|
|
extern void sh_invalidsig (const char *);
|
|
extern void sh_readonly (const char *);
|
|
extern void sh_noassign (const char *);
|
|
extern void sh_erange (const char *, const char *);
|
|
extern void sh_badpid (const char *);
|
|
extern void sh_badjob (const char *);
|
|
extern void sh_nojobs (const char *);
|
|
extern void sh_invalidjob (const char *);
|
|
extern void sh_restricted (const char *);
|
|
extern void sh_notbuiltin (const char *);
|
|
extern void sh_wrerror (void);
|
|
extern void sh_ttyerror (int);
|
|
extern int sh_chkwrite (int);
|
|
|
|
extern char **make_builtin_argv (WORD_LIST *, int *);
|
|
extern void remember_args (WORD_LIST *, int);
|
|
extern void shift_args (int);
|
|
extern int number_of_args (void);
|
|
|
|
extern int dollar_vars_changed (void);
|
|
extern void set_dollar_vars_unchanged (void);
|
|
extern void set_dollar_vars_changed (void);
|
|
|
|
extern int get_numeric_arg (WORD_LIST *, int, intmax_t *);
|
|
extern int get_exitstat (WORD_LIST *);
|
|
extern int read_octal (char *);
|
|
|
|
/* Keeps track of the current working directory. */
|
|
extern char *the_current_working_directory;
|
|
extern char *get_working_directory (const char *);
|
|
extern void set_working_directory (const char *);
|
|
|
|
#if defined (JOB_CONTROL)
|
|
extern int get_job_by_name (const char *, int);
|
|
extern int get_job_spec (WORD_LIST *);
|
|
#endif
|
|
extern int display_signal_list (WORD_LIST *, int);
|
|
|
|
/* It's OK to declare a function as returning a Function * without
|
|
providing a definition of what a `Function' is. */
|
|
extern struct builtin *builtin_address_internal (const char *, int);
|
|
extern sh_builtin_func_t *find_shell_builtin (const char *);
|
|
extern sh_builtin_func_t *builtin_address (const char *);
|
|
extern sh_builtin_func_t *find_special_builtin (const char *);
|
|
extern void initialize_shell_builtins (void);
|
|
|
|
#if defined (ARRAY_VARS)
|
|
extern int set_expand_once (int, int);
|
|
#endif
|
|
|
|
/* Functions from exit.def */
|
|
extern void bash_logout (void);
|
|
|
|
/* Functions from getopts.def */
|
|
extern void getopts_reset (int);
|
|
|
|
/* Functions from help.def */
|
|
extern void builtin_help (void);
|
|
|
|
/* Functions from read.def */
|
|
extern void read_tty_cleanup (void);
|
|
extern int read_tty_modified (void);
|
|
|
|
extern int read_builtin_timeout (int);
|
|
extern void check_read_timeout (void);
|
|
|
|
/* Functions from set.def */
|
|
extern int minus_o_option_value (char *);
|
|
extern void list_minus_o_opts (int, int);
|
|
extern char **get_minus_o_opts (void);
|
|
extern int set_minus_o_option (int, char *);
|
|
|
|
extern void set_shellopts (void);
|
|
extern void parse_shellopts (char *);
|
|
extern void initialize_shell_options (int);
|
|
|
|
extern void reset_shell_options (void);
|
|
|
|
extern char *get_current_options (void);
|
|
extern void set_current_options (const char *);
|
|
|
|
/* Functions from shopt.def */
|
|
extern void reset_shopt_options (void);
|
|
extern char **get_shopt_options (void);
|
|
|
|
extern int shopt_setopt (char *, int);
|
|
extern int shopt_listopt (char *, int);
|
|
|
|
extern int set_login_shell (char *, int);
|
|
|
|
extern void set_bashopts (void);
|
|
extern void parse_bashopts (char *);
|
|
extern void initialize_bashopts (int);
|
|
|
|
extern void set_compatibility_opts (void);
|
|
|
|
/* Functions from type.def */
|
|
extern int describe_command (char *, int);
|
|
|
|
/* Functions from setattr.def */
|
|
extern int set_or_show_attributes (WORD_LIST *, int, int);
|
|
extern int show_all_var_attributes (int, int);
|
|
extern int show_local_var_attributes (int, int);
|
|
extern int show_var_attributes (SHELL_VAR *, int, int);
|
|
extern int show_name_attributes (char *, int);
|
|
extern int show_localname_attributes (char *, int);
|
|
extern int show_func_attributes (char *, int);
|
|
extern void set_var_attribute (char *, int, int);
|
|
extern int var_attribute_string (SHELL_VAR *, int, char *);
|
|
|
|
/* Functions from pushd.def */
|
|
extern char *get_dirstack_from_string (char *);
|
|
extern char *get_dirstack_element (intmax_t, int);
|
|
extern void set_dirstack_element (intmax_t, int, char *);
|
|
extern WORD_LIST *get_directory_stack (int);
|
|
|
|
/* Functions from evalstring.c */
|
|
extern int parse_and_execute (char *, const char *, int);
|
|
extern int evalstring (char *, const char *, int);
|
|
extern void parse_and_execute_cleanup (int);
|
|
extern int parse_string (char *, const char *, int, COMMAND **, char **);
|
|
extern int should_optimize_fork (COMMAND *, int);
|
|
extern int should_suppress_fork (COMMAND *);
|
|
extern int can_optimize_connection (COMMAND *);
|
|
extern int can_optimize_cat_file (COMMAND *);
|
|
extern void optimize_connection_fork (COMMAND *);
|
|
extern void optimize_subshell_command (COMMAND *);
|
|
extern void optimize_shell_function (COMMAND *);
|
|
|
|
/* Functions from evalfile.c */
|
|
extern int maybe_execute_file (const char *, int);
|
|
extern int force_execute_file (const char *, int);
|
|
extern int source_file (const char *, int);
|
|
extern int fc_execute_file (const char *);
|
|
|
|
/* variables from common.c */
|
|
extern sh_builtin_func_t *this_shell_builtin;
|
|
extern sh_builtin_func_t *last_shell_builtin;
|
|
|
|
extern SHELL_VAR *builtin_bind_variable (char *, char *, int);
|
|
extern SHELL_VAR *builtin_bind_var_to_int (char *, intmax_t, int);
|
|
extern int builtin_unbind_variable (const char *);
|
|
|
|
extern SHELL_VAR *builtin_find_indexed_array (char *, int);
|
|
extern int builtin_arrayref_flags (WORD_DESC *, int);
|
|
|
|
/* variables from evalfile.c */
|
|
extern int sourcelevel;
|
|
|
|
/* variables from evalstring.c */
|
|
extern int parse_and_execute_level;
|
|
|
|
/* variables from break.def/continue.def */
|
|
extern int breaking;
|
|
extern int continuing;
|
|
extern int loop_level;
|
|
|
|
/* variables from shift.def */
|
|
extern int print_shift_error;
|
|
|
|
/* variables from shopt.def */
|
|
#if defined (ARRAY_VARS)
|
|
extern int expand_once_flag;
|
|
#endif
|
|
|
|
#if defined (EXTENDED_GLOB)
|
|
extern int extglob_flag;
|
|
#endif
|
|
|
|
extern int expaliases_flag;
|
|
|
|
/* variables from source.def */
|
|
extern int source_searches_cwd;
|
|
extern int source_uses_path;
|
|
|
|
/* variables from wait.def */
|
|
extern int wait_intr_flag;
|
|
|
|
/* common code to set flags for valid_array_reference and builtin_bind_variable */
|
|
#if defined (ARRAY_VARS)
|
|
#define SET_VFLAGS(wordflags, vflags, bindflags) \
|
|
do { \
|
|
vflags = array_expand_once ? VA_NOEXPAND : 0; \
|
|
bindflags = array_expand_once ? ASS_NOEXPAND : 0; \
|
|
if (array_expand_once && (wordflags & W_ARRAYREF)) \
|
|
vflags |= VA_ONEWORD|VA_NOEXPAND; \
|
|
if (vflags & VA_NOEXPAND) \
|
|
bindflags |= ASS_NOEXPAND; \
|
|
if (vflags & VA_ONEWORD) \
|
|
bindflags |= ASS_ONEWORD; \
|
|
} while (0)
|
|
#endif
|
|
|
|
#endif /* !__COMMON_H */
|