Gitiles
Code Review Sign In
review.blissroms.org / platform_external_bash / refs/heads/n2 / . / builtins / common.h
blob: a1298cb9c84abdf770ca76f169f514ba95bf7c78 [file] [log] [blame]
Jari Aalto726f6381996-08-26 18:22:31 +0000[diff] [blame]1/* common.h -- extern declarations for functions defined in common.c. */
2
Chet Ramey495aee42011-11-22 19:11:26 -0500[diff] [blame]3/* Copyright (C) 1993-2010 Free Software Foundation, Inc.
Jari Aalto726f6381996-08-26 18:22:31 +0000[diff] [blame]4
5 This file is part of GNU Bash, the Bourne Again SHell.
6
Jari Aalto31859422009-01-12 13:36:28 +0000[diff] [blame]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.
Jari Aalto726f6381996-08-26 18:22:31 +0000[diff] [blame]11
Jari Aalto31859422009-01-12 13:36:28 +0000[diff] [blame]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.
Jari Aalto726f6381996-08-26 18:22:31 +0000[diff] [blame]16
Jari Aalto31859422009-01-12 13:36:28 +0000[diff] [blame]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*/
Jari Aalto726f6381996-08-26 18:22:31 +0000[diff] [blame]20
21#if !defined (__COMMON_H)
22# define __COMMON_H
23
Jari Aaltobb706242000-03-17 21:46:59 +0000[diff] [blame]24#include "stdc.h"
Jari Aaltoccc6cda1996-12-23 17:02:34 +0000[diff] [blame]25
Jari Aalto726f6381996-08-26 18:22:31 +0000[diff] [blame]26#define ISOPTION(s, c) (s[0] == '-' && !s[2] && s[1] == c)
27
Jari Aaltod166f041997-06-05 14:59:13 +0000[diff] [blame]28/* Flag values for parse_and_execute () */
Jari Aalto7117c2d2002-07-17 14:10:11 +0000[diff] [blame]29#define SEVAL_NONINT 0x001
30#define SEVAL_INTERACT 0x002
31#define SEVAL_NOHIST 0x004
32#define SEVAL_NOFREE 0x008
Jari Aaltob80f6442004-07-27 13:29:18 +0000[diff] [blame]33#define SEVAL_RESETLINE 0x010
Jari Aalto31859422009-01-12 13:36:28 +0000[diff] [blame]34#define SEVAL_PARSEONLY 0x020
35#define SEVAL_NOLONGJMP 0x040
Chet Rameyb64a0e12014-09-25 08:45:07 -0400[diff] [blame]36#define SEVAL_FUNCDEF 0x080 /* only allow function definitions */
37#define SEVAL_ONECMD 0x100 /* only allow a single command */
Jari Aalto7117c2d2002-07-17 14:10:11 +0000[diff] [blame]38
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 */
Jari Aalto95732b42005-12-07 14:08:12 +0000[diff] [blame]47#define CDESC_ABSPATH 0x080 /* convert to absolute path, no ./ */
Jari Aalto7117c2d2002-07-17 14:10:11 +0000[diff] [blame]48
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 */
55
56/* Flags for remember_args and value of changed_dollar_vars */
57#define ARGS_NONE 0x0
58#define ARGS_INVOC 0x01
59#define ARGS_FUNC 0x02
60#define ARGS_SETBLTIN 0x04
Jari Aaltod166f041997-06-05 14:59:13 +0000[diff] [blame]61
Jari Aaltocce855b1998-04-17 19:52:44 +0000[diff] [blame]62/* Functions from common.c */
Jari Aaltof73dda02001-11-13 17:56:06 +0000[diff] [blame]63extern void builtin_error __P((const char *, ...)) __attribute__((__format__ (printf, 1, 2)));
Jari Aalto31859422009-01-12 13:36:28 +0000[diff] [blame]64extern void builtin_warning __P((const char *, ...)) __attribute__((__format__ (printf, 1, 2)));
Jari Aaltocce855b1998-04-17 19:52:44 +0000[diff] [blame]65extern void builtin_usage __P((void));
66extern void no_args __P((WORD_LIST *));
Jari Aaltocce855b1998-04-17 19:52:44 +0000[diff] [blame]67extern int no_options __P((WORD_LIST *));
Jari Aalto726f6381996-08-26 18:22:31 +0000[diff] [blame]68
Jari Aalto7117c2d2002-07-17 14:10:11 +0000[diff] [blame]69/* common error message functions */
70extern void sh_needarg __P((char *));
71extern void sh_neednumarg __P((char *));
72extern void sh_notfound __P((char *));
73extern void sh_invalidopt __P((char *));
74extern void sh_invalidoptname __P((char *));
75extern void sh_invalidid __P((char *));
76extern void sh_invalidnum __P((char *));
77extern void sh_invalidsig __P((char *));
78extern void sh_erange __P((char *, char *));
79extern void sh_badpid __P((char *));
80extern void sh_badjob __P((char *));
81extern void sh_readonly __P((const char *));
82extern void sh_nojobs __P((char *));
83extern void sh_restricted __P((char *));
Jari Aaltob80f6442004-07-27 13:29:18 +0000[diff] [blame]84extern void sh_notbuiltin __P((char *));
Jari Aalto95732b42005-12-07 14:08:12 +0000[diff] [blame]85extern void sh_wrerror __P((void));
Jari Aalto17345e52009-02-19 22:21:29 +0000[diff] [blame]86extern void sh_ttyerror __P((int));
Jari Aalto31859422009-01-12 13:36:28 +0000[diff] [blame]87extern int sh_chkwrite __P((int));
Jari Aalto7117c2d2002-07-17 14:10:11 +0000[diff] [blame]88
Jari Aaltocce855b1998-04-17 19:52:44 +0000[diff] [blame]89extern char **make_builtin_argv __P((WORD_LIST *, int *));
90extern void remember_args __P((WORD_LIST *, int));
Jari Aaltoccc6cda1996-12-23 17:02:34 +0000[diff] [blame]91
Jari Aaltocce855b1998-04-17 19:52:44 +0000[diff] [blame]92extern int dollar_vars_changed __P((void));
93extern void set_dollar_vars_unchanged __P((void));
94extern void set_dollar_vars_changed __P((void));
Jari Aalto726f6381996-08-26 18:22:31 +0000[diff] [blame]95
Jari Aalto31859422009-01-12 13:36:28 +0000[diff] [blame]96extern int get_numeric_arg __P((WORD_LIST *, int, intmax_t *));
Jari Aaltof73dda02001-11-13 17:56:06 +0000[diff] [blame]97extern int get_exitstat __P((WORD_LIST *));
Jari Aaltocce855b1998-04-17 19:52:44 +0000[diff] [blame]98extern int read_octal __P((char *));
Jari Aalto726f6381996-08-26 18:22:31 +0000[diff] [blame]99
100/* Keeps track of the current working directory. */
101extern char *the_current_working_directory;
Jari Aaltocce855b1998-04-17 19:52:44 +0000[diff] [blame]102extern char *get_working_directory __P((char *));
103extern void set_working_directory __P((char *));
Jari Aalto726f6381996-08-26 18:22:31 +0000[diff] [blame]104
105#if defined (JOB_CONTROL)
Jari Aalto7117c2d2002-07-17 14:10:11 +0000[diff] [blame]106extern int get_job_by_name __P((const char *, int));
Jari Aaltocce855b1998-04-17 19:52:44 +0000[diff] [blame]107extern int get_job_spec __P((WORD_LIST *));
Jari Aalto726f6381996-08-26 18:22:31 +0000[diff] [blame]108#endif
Jari Aaltocce855b1998-04-17 19:52:44 +0000[diff] [blame]109extern int display_signal_list __P((WORD_LIST *, int));
Jari Aalto726f6381996-08-26 18:22:31 +0000[diff] [blame]110
111/* It's OK to declare a function as returning a Function * without
112 providing a definition of what a `Function' is. */
Jari Aaltocce855b1998-04-17 19:52:44 +0000[diff] [blame]113extern struct builtin *builtin_address_internal __P((char *, int));
Jari Aaltof73dda02001-11-13 17:56:06 +0000[diff] [blame]114extern sh_builtin_func_t *find_shell_builtin __P((char *));
115extern sh_builtin_func_t *builtin_address __P((char *));
116extern sh_builtin_func_t *find_special_builtin __P((char *));
Jari Aaltocce855b1998-04-17 19:52:44 +0000[diff] [blame]117extern void initialize_shell_builtins __P((void));
Jari Aaltoccc6cda1996-12-23 17:02:34 +0000[diff] [blame]118
Jari Aaltob80f6442004-07-27 13:29:18 +0000[diff] [blame]119/* Functions from exit.def */
120extern void bash_logout __P((void));
121
Jari Aaltof73dda02001-11-13 17:56:06 +0000[diff] [blame]122/* Functions from getopts.def */
123extern void getopts_reset __P((int));
124
Chet Rameybbc8b482015-01-15 10:21:08 -0500[diff] [blame]125/* Functions from read.def */
126extern void read_tty_cleanup __P((void));
127extern int read_tty_modified __P((void));
128
Jari Aaltoccc6cda1996-12-23 17:02:34 +0000[diff] [blame]129/* Functions from set.def */
Jari Aaltocce855b1998-04-17 19:52:44 +0000[diff] [blame]130extern int minus_o_option_value __P((char *));
Jari Aaltof73dda02001-11-13 17:56:06 +0000[diff] [blame]131extern void list_minus_o_opts __P((int, int));
Jari Aaltobb706242000-03-17 21:46:59 +0000[diff] [blame]132extern char **get_minus_o_opts __P((void));
Jari Aaltof73dda02001-11-13 17:56:06 +0000[diff] [blame]133extern int set_minus_o_option __P((int, char *));
134
135extern void set_shellopts __P((void));
136extern void parse_shellopts __P((char *));
137extern void initialize_shell_options __P((int));
138
139extern void reset_shell_options __P((void));
Jari Aaltod166f041997-06-05 14:59:13 +0000[diff] [blame]140
141/* Functions from shopt.def */
Jari Aaltocce855b1998-04-17 19:52:44 +0000[diff] [blame]142extern void reset_shopt_options __P((void));
Jari Aaltobb706242000-03-17 21:46:59 +0000[diff] [blame]143extern char **get_shopt_options __P((void));
Jari Aaltoccc6cda1996-12-23 17:02:34 +0000[diff] [blame]144
Jari Aaltof73dda02001-11-13 17:56:06 +0000[diff] [blame]145extern int shopt_setopt __P((char *, int));
146extern int shopt_listopt __P((char *, int));
147
Chet Ramey00018032011-11-21 20:51:19 -0500[diff] [blame]148extern int set_login_shell __P((char *, int));
149
150extern void set_bashopts __P((void));
151extern void parse_bashopts __P((char *));
152extern void initialize_bashopts __P((int));
Jari Aaltof73dda02001-11-13 17:56:06 +0000[diff] [blame]153
Chet Rameyac50fba2014-02-26 09:36:43 -0500[diff] [blame]154extern void set_compatibility_opts __P((void));
155
Jari Aaltoccc6cda1996-12-23 17:02:34 +0000[diff] [blame]156/* Functions from type.def */
Jari Aalto7117c2d2002-07-17 14:10:11 +0000[diff] [blame]157extern int describe_command __P((char *, int));
Jari Aaltoccc6cda1996-12-23 17:02:34 +0000[diff] [blame]158
159/* Functions from setattr.def */
Jari Aaltocce855b1998-04-17 19:52:44 +0000[diff] [blame]160extern int set_or_show_attributes __P((WORD_LIST *, int, int));
Jari Aalto31859422009-01-12 13:36:28 +0000[diff] [blame]161extern int show_all_var_attributes __P((int, int));
Jari Aaltocce855b1998-04-17 19:52:44 +0000[diff] [blame]162extern int show_var_attributes __P((SHELL_VAR *, int, int));
163extern int show_name_attributes __P((char *, int));
Chet Rameyac50fba2014-02-26 09:36:43 -0500[diff] [blame]164extern int show_func_attributes __P((char *, int));
Jari Aaltocce855b1998-04-17 19:52:44 +0000[diff] [blame]165extern void set_var_attribute __P((char *, int, int));
Jari Aaltoccc6cda1996-12-23 17:02:34 +0000[diff] [blame]166
167/* Functions from pushd.def */
Jari Aaltocce855b1998-04-17 19:52:44 +0000[diff] [blame]168extern char *get_dirstack_from_string __P((char *));
Jari Aalto7117c2d2002-07-17 14:10:11 +0000[diff] [blame]169extern char *get_dirstack_element __P((intmax_t, int));
170extern void set_dirstack_element __P((intmax_t, int, char *));
Jari Aalto06285672006-10-10 14:15:34 +0000[diff] [blame]171extern WORD_LIST *get_directory_stack __P((int));
Jari Aaltoccc6cda1996-12-23 17:02:34 +0000[diff] [blame]172
173/* Functions from evalstring.c */
Jari Aaltof73dda02001-11-13 17:56:06 +0000[diff] [blame]174extern int parse_and_execute __P((char *, const char *, int));
Chet Rameyac50fba2014-02-26 09:36:43 -0500[diff] [blame]175extern int evalstring __P((char *, const char *, int));
Jari Aaltocce855b1998-04-17 19:52:44 +0000[diff] [blame]176extern void parse_and_execute_cleanup __P((void));
Jari Aalto31859422009-01-12 13:36:28 +0000[diff] [blame]177extern int parse_string __P((char *, const char *, int, char **));
Jari Aaltoccc6cda1996-12-23 17:02:34 +0000[diff] [blame]178
179/* Functions from evalfile.c */
Jari Aaltof73dda02001-11-13 17:56:06 +0000[diff] [blame]180extern int maybe_execute_file __P((const char *, int));
Jari Aaltob80f6442004-07-27 13:29:18 +0000[diff] [blame]181extern int source_file __P((const char *, int));
Jari Aaltof73dda02001-11-13 17:56:06 +0000[diff] [blame]182extern int fc_execute_file __P((const char *));
Jari Aalto726f6381996-08-26 18:22:31 +0000[diff] [blame]183
184#endif /* !__COMMON_H */