1 /* variables.h -- data structures for shell variables. */
3 #if !defined (_VARIABLES_H_)
9 /* Shell variables and functions are stored in hash tables. */
12 /* What a shell variable looks like. */
14 typedef struct variable *DYNAMIC_FUNC ();
16 typedef struct variable {
17 char *name; /* Symbol that the user types. */
18 char *value; /* Value that is returned. */
19 DYNAMIC_FUNC *dynamic_value; /* Function called to return a `dynamic'
20 value for a variable, like $SECONDS
22 DYNAMIC_FUNC *assign_func; /* Function called when this `special
23 variable' is assigned a value in
25 int attributes; /* export, readonly, array, invisible... */
26 int context; /* Which context this variable belongs to. */
27 struct variable *prev_context; /* Value from previous context or NULL. */
30 /* The various attributes that a given variable can have.
31 We only reserve one byte of the INT. */
32 #define att_exported 0x01 /* export to environment */
33 #define att_readonly 0x02 /* cannot change */
34 #define att_invisible 0x04 /* cannot see */
35 #define att_array 0x08 /* value is an array */
36 #define att_nounset 0x10 /* cannot unset */
37 #define att_function 0x20 /* value is a function */
38 #define att_integer 0x40 /* internal representation is int */
39 #define att_imported 0x80 /* came from environment */
40 #define att_local 0x100 /* variable is local to a function */
42 #define exported_p(var) ((((var)->attributes) & (att_exported)))
43 #define readonly_p(var) ((((var)->attributes) & (att_readonly)))
44 #define invisible_p(var) ((((var)->attributes) & (att_invisible)))
45 #define array_p(var) ((((var)->attributes) & (att_array)))
46 #define non_unsettable_p(var) ((((var)->attributes) & (att_nounset)))
47 #define function_p(var) ((((var)->attributes) & (att_function)))
48 #define integer_p(var) ((((var)->attributes) & (att_integer)))
49 #define imported_p(var) ((((var)->attributes) & (att_imported)))
50 #define local_p(var) ((((var)->attributes) & (att_local)))
52 #define value_cell(var) ((var)->value)
53 #define function_cell(var) (COMMAND *)((var)->value)
54 #define array_cell(var) ((ARRAY *)(var)->value)
56 #define SETVARATTR(var, attr, undo) \
57 ((undo == 0) ? ((var)->attributes |= (attribute)) \
58 : ((var)->attributes &= ~(attribute)))
60 /* Stuff for hacking variables. */
61 extern int variable_context;
62 extern HASH_TABLE *shell_variables, *shell_functions;
63 extern char *dollar_vars[];
64 extern char **export_env;
65 extern char **non_unsettable_vars;
67 extern void initialize_shell_variables __P((char **, int));
68 extern SHELL_VAR *set_if_not __P((char *, char *));
69 extern void set_lines_and_columns __P((int, int));
71 extern SHELL_VAR *find_function __P((char *));
72 extern SHELL_VAR *find_variable __P((char *));
73 extern SHELL_VAR *find_variable_internal __P((char *, int));
74 extern SHELL_VAR *find_tempenv_variable __P((char *));
75 extern SHELL_VAR *copy_variable __P((SHELL_VAR *));
76 extern SHELL_VAR *make_local_variable __P((char *));
77 extern SHELL_VAR *bind_variable __P((char *, char *));
78 extern SHELL_VAR *bind_function __P((char *, COMMAND *));
79 extern SHELL_VAR **map_over __P((Function *, HASH_TABLE *));
80 extern SHELL_VAR **all_shell_variables __P((void));
81 extern SHELL_VAR **all_shell_functions __P((void));
82 extern SHELL_VAR **all_visible_variables __P((void));
83 extern SHELL_VAR **all_visible_functions __P((void));
85 extern char **make_var_array __P((HASH_TABLE *));
86 extern char **add_or_supercede __P((char *, char **));
88 extern char *get_string_value __P((char *));
89 extern char *make_variable_value __P((SHELL_VAR *, char *));
91 extern int assignment __P((char *));
92 extern int variable_in_context __P((SHELL_VAR *));
93 extern int assign_in_env __P((char *));
94 extern int unbind_variable __P((char *));
95 extern int makunbound __P((char *, HASH_TABLE *));
96 extern int kill_local_variable __P((char *));
97 extern void delete_all_variables __P((HASH_TABLE *));
99 extern void adjust_shell_level __P((int));
100 extern void non_unsettable __P((char *));
101 extern void dispose_variable __P((SHELL_VAR *));
102 extern void dispose_used_env_vars __P((void));
103 extern void dispose_function_env __P((void));
104 extern void dispose_builtin_env __P((void));
105 extern void merge_temporary_env __P((void));
106 extern void merge_builtin_env __P((void));
107 extern void kill_all_local_variables __P((void));
108 extern void set_var_read_only __P((char *));
109 extern void set_func_read_only __P((char *));
110 extern void set_var_auto_export __P((char *));
111 extern void set_func_auto_export __P((char *));
112 extern void sort_variables __P((SHELL_VAR **));
113 extern void maybe_make_export_env __P((void));
114 extern void put_command_name_into_env __P((char *));
115 extern void put_gnu_argv_flags_into_env __P((int, char *));
116 extern void print_var_list __P((SHELL_VAR **));
117 extern void print_assignment __P((SHELL_VAR *));
118 extern void print_var_value __P((SHELL_VAR *, int));
119 extern void print_var_function __P((SHELL_VAR *));
121 extern char *indirection_level_string __P((void));
123 #if defined (ARRAY_VARS)
124 extern SHELL_VAR *make_new_array_variable __P((char *));
125 extern SHELL_VAR *make_local_array_variable __P((char *));
126 extern SHELL_VAR *convert_var_to_array __P((SHELL_VAR *));
127 extern SHELL_VAR *bind_array_variable __P((char *, int, char *));
128 extern SHELL_VAR *assign_array_from_string __P((char *, char *));
129 extern SHELL_VAR *assign_array_var_from_word_list __P((SHELL_VAR *, WORD_LIST *));
130 extern SHELL_VAR *assign_array_var_from_string __P((SHELL_VAR *, char *));
131 extern int unbind_array_element __P((SHELL_VAR *, char *));
132 extern int skipsubscript __P((char *, int));
133 extern void print_array_assignment __P((SHELL_VAR *, int));
136 #endif /* !_VARIABLES_H_ */