[thirdparty/bash.git] / shell.h

/* shell.h -- The data structures used by the shell */

/* Copyright (C) 1993-2024 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/>.
*/

#ifdef HAVE_CONFIG_H
#include "config.h"
#endif

#include "bashjmp.h"

#include "command.h"
#include "syntax.h"
#include "general.h"
#include "error.h"
#include "variables.h"
#include "quit.h"
#include "maxpath.h"
#include "unwind_prot.h"
#include "dispose_cmd.h"
#include "make_cmd.h"
#include "ocache.h"
#include "subst.h"
#include "arrayfunc.h"
#include "sig.h"
#include "pathnames.h"
#include "externs.h"

extern int EOF_Reached;

#define NO_PIPE -1
#define REDIRECT_BOTH -2

#define NO_VARIABLE -1

/* Values that can be returned by execute_command (). */
#define EXECUTION_FAILURE 1
#define EXECUTION_SUCCESS 0

/* Usage messages by builtins result in a return status of 2. */
#define EX_BADUSAGE	2

#define EX_MISCERROR	2

/* Special exit statuses used by the shell, internally and externally. */
#define EX_RETRYFAIL	124
#define EX_WEXPCOMSUB	125
#define EX_BINARY_FILE	126
#define EX_NOEXEC	126
#define EX_NOINPUT	126
#define EX_NOTFOUND	127

#define EX_SHERRBASE	256	/* all special error values are > this. */

#define EX_BADSYNTAX	257	/* shell syntax error */
#define EX_USAGE	258	/* syntax error in usage */
#define EX_REDIRFAIL	259	/* redirection failed */
#define EX_BADASSIGN	260	/* variable assignment error */
#define EX_EXPFAIL	261	/* word expansion failed */
#define EX_DISKFALLBACK	262	/* fall back to disk command from builtin */
#define EX_UTILERROR	263	/* Posix special builtin utility error */

/* Flag values that control parameter pattern substitution. */
#define MATCH_ANY	0x000
#define MATCH_BEG	0x001
#define MATCH_END	0x002

#define MATCH_TYPEMASK	0x003

#define MATCH_GLOBREP	0x010
#define MATCH_QUOTED	0x020
#define MATCH_ASSIGNRHS	0x040
#define MATCH_STARSUB	0x080
#define MATCH_EXPREP	0x100	/* for pattern substitution, expand replacement */

/* Some needed external declarations. */
extern char **shell_environment;
extern WORD_LIST *rest_of_args;

/* Generalized global variables. */
extern char *command_execution_string;

extern int debugging_mode;
extern int executing;
extern int login_shell;
extern int su_shell;
extern int parsing_command;
extern int interactive, interactive_shell;
extern int startup_state;
extern int reading_shell_script;
extern int ssh_reading_startup_files;
extern int shell_initialized;
extern int bash_argv_initialized;
extern int subshell_environment;
extern int current_command_number;
extern int indirection_level;
extern int shell_compatibility_level;
extern const int default_compatibility_level;
extern int running_under_emacs;

extern int pretty_print_mode;

extern int posixly_correct;
extern int no_line_editing;

extern char *shell_name;
extern char *current_host_name;

extern int subshell_argc;
extern char **subshell_argv;
extern char **subshell_envp;

/* variables managed using shopt */
extern int hup_on_exit;
extern int check_jobs_at_exit;
extern int autocd;
extern int check_window_size;

/* from version.c */
extern int build_version, patch_level;
extern char *dist_version, *release_status;

extern int locale_mb_cur_max;
extern int locale_utf8locale;

/* Structure to pass around that holds a bitmap of file descriptors
   to close, and the size of that structure.  Used in execute_cmd.c. */
struct fd_bitmap {
  int size;
  char *bitmap;
};

#define FD_BITMAP_SIZE 32

#define CTLESC '\001'
#define CTLNUL '\177'

/* Information about the current user. */
struct user_info {
  uid_t uid, euid, saveuid;
  gid_t gid, egid, savegid;
  char *user_name;
  char *shell;		/* shell from the password file */
  char *home_dir;
};

extern struct user_info current_user;

/* Force gcc to not clobber X on a longjmp().  Old versions of gcc mangle
   this badly. */
#if (__GNUC__ > 2) || (__GNUC__ == 2 && __GNUC_MINOR__ > 8)
#  define USE_VAR(x)	((void) &(x))
#else
#  define USE_VAR(x)
#endif

#define HEREDOC_MAX 16

/* Structure in which to save partial parsing state when doing things like
   PROMPT_COMMAND and bash_execute_unix_command execution. */

typedef struct _sh_parser_state_t
{
  /* parsing state */
  int parser_state;
  int *token_state;
  int parsing_command;

  char *token;
  size_t token_buffer_size;
  int eof_token;

  /* input line state -- line number saved elsewhere */
  int input_line_terminator;
  int eof_encountered;
  int eol_lookahead;

#if defined (HANDLE_MULTIBYTE)
  /* Nothing right now for multibyte state, but might want something later. */
#endif

  char **prompt_string_pointer;

  /* history state affecting or modified by the parser */
  int current_command_line_count;
#if defined (HISTORY)
  int remember_on_history;
  int history_expansion_inhibited;
#endif

  /* execution state possibly modified by the parser */
  int last_command_exit_value;
#if defined (ARRAY_VARS)
  ARRAY *pipestatus;
#endif
  sh_builtin_func_t *last_shell_builtin, *this_shell_builtin;

  /* flags state affecting the parser */
  int expand_aliases;
  int echo_input_at_read;
  int need_here_doc;
  int here_doc_first_line;

  int esacs_needed;
  int expecting_in;
  int incmd;

  /* structures affecting the parser */
  void *pushed_strings;
  REDIRECT *redir_stack[HEREDOC_MAX];
} sh_parser_state_t;

typedef struct _sh_input_line_state_t
{
  char *input_line;
  size_t input_line_index;
  size_t input_line_size;
  size_t input_line_len;
#if defined (HANDLE_MULTIBYTE)
  char *input_property;
  size_t input_propsize;
#endif
} sh_input_line_state_t;

/* Let's try declaring these here. */
extern void shell_ungets (char *);
extern void rewind_input_string (void);

extern char *parser_remaining_input (void);

extern sh_parser_state_t *save_parser_state (sh_parser_state_t *);
extern void restore_parser_state (sh_parser_state_t *);
extern void flush_parser_state (sh_parser_state_t *);
extern void uw_restore_parser_state (void *);

extern sh_input_line_state_t *save_input_line_state (sh_input_line_state_t *);
extern void restore_input_line_state (sh_input_line_state_t *);
Commit	Line	Data
	1	/* shell.h -- The data structures used by the shell */
	2
	3	/* Copyright (C) 1993-2024 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	#ifdef HAVE_CONFIG_H
	22	#include "config.h"
	23	#endif
	24
	25	#include "bashjmp.h"
	26
	27	#include "command.h"
	28	#include "syntax.h"
	29	#include "general.h"
	30	#include "error.h"
	31	#include "variables.h"
	32	#include "quit.h"
	33	#include "maxpath.h"
	34	#include "unwind_prot.h"
	35	#include "dispose_cmd.h"
	36	#include "make_cmd.h"
	37	#include "ocache.h"
	38	#include "subst.h"
	39	#include "arrayfunc.h"
	40	#include "sig.h"
	41	#include "pathnames.h"
	42	#include "externs.h"
	43
	44	extern int EOF_Reached;
	45
	46	#define NO_PIPE -1
	47	#define REDIRECT_BOTH -2
	48
	49	#define NO_VARIABLE -1
	50
	51	/* Values that can be returned by execute_command (). */
	52	#define EXECUTION_FAILURE 1
	53	#define EXECUTION_SUCCESS 0
	54
	55	/* Usage messages by builtins result in a return status of 2. */
	56	#define EX_BADUSAGE 2
	57
	58	#define EX_MISCERROR 2
	59
	60	/* Special exit statuses used by the shell, internally and externally. */
	61	#define EX_RETRYFAIL 124
	62	#define EX_WEXPCOMSUB 125
	63	#define EX_BINARY_FILE 126
	64	#define EX_NOEXEC 126
	65	#define EX_NOINPUT 126
	66	#define EX_NOTFOUND 127
	67
	68	#define EX_SHERRBASE 256 /* all special error values are > this. */
	69
	70	#define EX_BADSYNTAX 257 /* shell syntax error */
	71	#define EX_USAGE 258 /* syntax error in usage */
	72	#define EX_REDIRFAIL 259 /* redirection failed */
	73	#define EX_BADASSIGN 260 /* variable assignment error */
	74	#define EX_EXPFAIL 261 /* word expansion failed */
	75	#define EX_DISKFALLBACK 262 /* fall back to disk command from builtin */
	76	#define EX_UTILERROR 263 /* Posix special builtin utility error */
	77
	78	/* Flag values that control parameter pattern substitution. */
	79	#define MATCH_ANY 0x000
	80	#define MATCH_BEG 0x001
	81	#define MATCH_END 0x002
	82
	83	#define MATCH_TYPEMASK 0x003
	84
	85	#define MATCH_GLOBREP 0x010
	86	#define MATCH_QUOTED 0x020
	87	#define MATCH_ASSIGNRHS 0x040
	88	#define MATCH_STARSUB 0x080
	89	#define MATCH_EXPREP 0x100 /* for pattern substitution, expand replacement */
	90
	91	/* Some needed external declarations. */
	92	extern char **shell_environment;
	93	extern WORD_LIST *rest_of_args;
	94
	95	/* Generalized global variables. */
	96	extern char *command_execution_string;
	97
	98	extern int debugging_mode;
	99	extern int executing;
	100	extern int login_shell;
	101	extern int su_shell;
	102	extern int parsing_command;
	103	extern int interactive, interactive_shell;
	104	extern int startup_state;
	105	extern int reading_shell_script;
	106	extern int ssh_reading_startup_files;
	107	extern int shell_initialized;
	108	extern int bash_argv_initialized;
	109	extern int subshell_environment;
	110	extern int current_command_number;
	111	extern int indirection_level;
	112	extern int shell_compatibility_level;
	113	extern const int default_compatibility_level;
	114	extern int running_under_emacs;
	115
	116	extern int pretty_print_mode;
	117
	118	extern int posixly_correct;
	119	extern int no_line_editing;
	120
	121	extern char *shell_name;
	122	extern char *current_host_name;
	123
	124	extern int subshell_argc;
	125	extern char **subshell_argv;
	126	extern char **subshell_envp;
	127
	128	/* variables managed using shopt */
	129	extern int hup_on_exit;
	130	extern int check_jobs_at_exit;
	131	extern int autocd;
	132	extern int check_window_size;
	133
	134	/* from version.c */
	135	extern int build_version, patch_level;
	136	extern char dist_version, release_status;
	137
	138	extern int locale_mb_cur_max;
	139	extern int locale_utf8locale;
	140
	141	/* Structure to pass around that holds a bitmap of file descriptors
	142	to close, and the size of that structure. Used in execute_cmd.c. */
	143	struct fd_bitmap {
	144	int size;
	145	char *bitmap;
	146	};
	147
	148	#define FD_BITMAP_SIZE 32
	149
	150	#define CTLESC '\001'
	151	#define CTLNUL '\177'
	152
	153	/* Information about the current user. */
	154	struct user_info {
	155	uid_t uid, euid, saveuid;
	156	gid_t gid, egid, savegid;
	157	char *user_name;
	158	char shell; / shell from the password file */
	159	char *home_dir;
	160	};
	161
	162	extern struct user_info current_user;
	163
	164	/* Force gcc to not clobber X on a longjmp(). Old versions of gcc mangle
	165	this badly. */
	166	#if (__GNUC__ > 2) \|\| (__GNUC__ == 2 && __GNUC_MINOR__ > 8)
	167	# define USE_VAR(x) ((void) &(x))
	168	#else
	169	# define USE_VAR(x)
	170	#endif
	171
	172	#define HEREDOC_MAX 16
	173
	174	/* Structure in which to save partial parsing state when doing things like
	175	PROMPT_COMMAND and bash_execute_unix_command execution. */
	176
	177	typedef struct _sh_parser_state_t
	178	{
	179	/* parsing state */
	180	int parser_state;
	181	int *token_state;
	182	int parsing_command;
	183
	184	char *token;
	185	size_t token_buffer_size;
	186	int eof_token;
	187
	188	/* input line state -- line number saved elsewhere */
	189	int input_line_terminator;
	190	int eof_encountered;
	191	int eol_lookahead;
	192
	193	#if defined (HANDLE_MULTIBYTE)
	194	/* Nothing right now for multibyte state, but might want something later. */
	195	#endif
	196
	197	char **prompt_string_pointer;
	198
	199	/* history state affecting or modified by the parser */
	200	int current_command_line_count;
	201	#if defined (HISTORY)
	202	int remember_on_history;
	203	int history_expansion_inhibited;
	204	#endif
	205
	206	/* execution state possibly modified by the parser */
	207	int last_command_exit_value;
	208	#if defined (ARRAY_VARS)
	209	ARRAY *pipestatus;
	210	#endif
	211	sh_builtin_func_t last_shell_builtin, this_shell_builtin;
	212
	213	/* flags state affecting the parser */
	214	int expand_aliases;
	215	int echo_input_at_read;
	216	int need_here_doc;
	217	int here_doc_first_line;
	218
	219	int esacs_needed;
	220	int expecting_in;
	221	int incmd;
	222
	223	/* structures affecting the parser */
	224	void *pushed_strings;
	225	REDIRECT *redir_stack[HEREDOC_MAX];
	226	} sh_parser_state_t;
	227
	228	typedef struct _sh_input_line_state_t
	229	{
	230	char *input_line;
	231	size_t input_line_index;
	232	size_t input_line_size;
	233	size_t input_line_len;
	234	#if defined (HANDLE_MULTIBYTE)
	235	char *input_property;
	236	size_t input_propsize;
	237	#endif
	238	} sh_input_line_state_t;
	239
	240	/* Let's try declaring these here. */
	241	extern void shell_ungets (char *);
	242	extern void rewind_input_string (void);
	243
	244	extern char *parser_remaining_input (void);
	245
	246	extern sh_parser_state_t save_parser_state (sh_parser_state_t );
	247	extern void restore_parser_state (sh_parser_state_t *);
	248	extern void flush_parser_state (sh_parser_state_t *);
	249	extern void uw_restore_parser_state (void *);
	250
	251	extern sh_input_line_state_t save_input_line_state (sh_input_line_state_t );
	252	extern void restore_input_line_state (sh_input_line_state_t *);