| 1 | #!/usr/bin/env python2
|
| 2 | from __future__ import print_function
|
| 3 |
|
| 4 | from typing import List, Dict, Optional, Tuple, Any
|
| 5 |
|
| 6 |
|
| 7 | class Option(object):
|
| 8 |
|
| 9 | def __init__(self,
|
| 10 | index,
|
| 11 | name,
|
| 12 | short_flag=None,
|
| 13 | builtin='shopt',
|
| 14 | default=False,
|
| 15 | implemented=True,
|
| 16 | groups=None):
|
| 17 | # type: (int, str, str, Optional[str], bool, bool, List[str]) -> None
|
| 18 | self.index = index
|
| 19 | self.name = name # e.g. 'errexit'
|
| 20 | self.short_flag = short_flag # 'e' for -e
|
| 21 |
|
| 22 | if short_flag:
|
| 23 | self.builtin = 'set'
|
| 24 | else:
|
| 25 | # The 'interactive' option is the only one where builtin is None. It has
|
| 26 | # a cell but you can't change it. Only the shell can.
|
| 27 | self.builtin = builtin
|
| 28 |
|
| 29 | self.default = default # default value is True in some cases
|
| 30 | self.implemented = implemented
|
| 31 | self.groups = groups or [] # list of groups
|
| 32 |
|
| 33 | # for optview
|
| 34 | self.is_parse = (name.startswith('parse_') or
|
| 35 | name.startswith('no_parse_') or
|
| 36 | name.startswith('strict_parse_') or
|
| 37 | name == 'expand_aliases')
|
| 38 | # interactive() is an accessor
|
| 39 | self.is_exec = implemented and not self.is_parse
|
| 40 |
|
| 41 |
|
| 42 | class _OptionDef(object):
|
| 43 | """Description of all shell options.
|
| 44 |
|
| 45 | Similar to id_kind_def.IdSpec
|
| 46 | """
|
| 47 |
|
| 48 | def __init__(self):
|
| 49 | # type: () -> None
|
| 50 | self.opts = [] # type: List[Option]
|
| 51 | self.index = 1 # start with 1
|
| 52 | self.array_size = -1
|
| 53 |
|
| 54 | def Add(self, *args, **kwargs):
|
| 55 | # type: (Any, Any) -> None
|
| 56 | self.opts.append(Option(self.index, *args, **kwargs))
|
| 57 | self.index += 1
|
| 58 |
|
| 59 | def DoneWithImplementedOptions(self):
|
| 60 | # type: () -> None
|
| 61 | self.array_size = self.index
|
| 62 |
|
| 63 |
|
| 64 | # Used by builtin
|
| 65 | _OTHER_SET_OPTIONS = [
|
| 66 | # NOTE: set -i and +i is explicitly disallowed. Only osh -i or +i is valid
|
| 67 | # https://unix.stackexchange.com/questions/339506/can-an-interactive-shell-become-non-interactive-or-vice-versa
|
| 68 | ('a', 'allexport'),
|
| 69 | ('n', 'noexec'),
|
| 70 | ('x', 'xtrace'),
|
| 71 | ('v', 'verbose'), # like xtrace, but prints unevaluated commands
|
| 72 | ('f', 'noglob'),
|
| 73 | ('C', 'noclobber'),
|
| 74 | ('E', 'errtrace'),
|
| 75 | (None, 'posix'), # controls special builtins
|
| 76 | (None, 'vi'),
|
| 77 | (None, 'emacs'),
|
| 78 | ]
|
| 79 |
|
| 80 | _STRICT_OPTS = [
|
| 81 | # disallow '=x' in first word, to avoid confusion with '= x'
|
| 82 | 'strict_parse_equals',
|
| 83 | # $a{[@]::} is not allowed, you need ${a[@]::0} or ${a[@]::n}
|
| 84 | 'strict_parse_slice',
|
| 85 |
|
| 86 | # These are RUNTIME strict options.
|
| 87 | 'strict_argv', # empty argv not allowed
|
| 88 | 'strict_arith', # string to integer conversions, e.g. x=foo; echo $(( x ))
|
| 89 | 'strict_arg_parse', # disallow additional arguments, e.g. cd / /
|
| 90 |
|
| 91 | # No implicit conversions between string and array.
|
| 92 | # - foo="$@" not allowed because it decays. Should be foo=( "$@" ).
|
| 93 | # - ${a} not ${a[0]} (not implemented)
|
| 94 | # sane-array? compare arrays like [[ "$@" == "${a[@]}" ]], which is
|
| 95 | # incompatible because bash coerces
|
| 96 | # default: do not allow
|
| 97 | 'strict_array',
|
| 98 | 'strict_control_flow', # break/continue at top level is fatal
|
| 99 | 'strict_env_binding', # FOO=bar cmd is always an env binding
|
| 100 | # 'return $empty' and return "" are NOT accepted
|
| 101 | 'strict_errexit', # errexit can't be disabled in compound commands
|
| 102 | 'strict_nameref', # trap invalid variable names
|
| 103 | 'strict_word_eval', # negative slices, unicode
|
| 104 | 'strict_tilde', # ~nonexistent is an error (like zsh)
|
| 105 |
|
| 106 | # Not implemented
|
| 107 | 'strict_glob', # glob_.py GlobParser has warnings
|
| 108 | ]
|
| 109 |
|
| 110 | # These will break some programs, but the fix should be simple.
|
| 111 |
|
| 112 | # command_sub_errexit makes 'local foo=$(false)' and echo $(false) fail.
|
| 113 | # By default, we have mimic bash's undesirable behavior of ignoring
|
| 114 | # these failures, since ash copied it, and Alpine's abuild relies on it.
|
| 115 | #
|
| 116 | # Note that inherit_errexit is a strict option.
|
| 117 |
|
| 118 | _UPGRADE_RUNTIME_OPTS = [
|
| 119 | ('simple_word_eval', False), # No splitting; arity isn't data-dependent
|
| 120 | # Don't reparse program data as globs
|
| 121 | ('no_dash_glob', False), # do globs return files starting with - ?
|
| 122 |
|
| 123 | # TODO: Should these be in strict mode?
|
| 124 | # The logic was that strict_errexit improves your bash programs, but these
|
| 125 | # would lead you to remove error handling. But the same could be said for
|
| 126 | # strict_array?
|
| 127 | ('command_sub_errexit', False), # check after command sub
|
| 128 | ('process_sub_fail', False), # like pipefail, but for <(sort foo.txt)
|
| 129 | ('xtrace_rich', False), # Hierarchical trace with PIDs
|
| 130 | ('no_xtrace_osh', False), # Legacy set -x stuff
|
| 131 |
|
| 132 | # Whether status 141 in pipelines is turned into 0
|
| 133 | ('sigpipe_status_ok', False),
|
| 134 |
|
| 135 | # create ENV at startup; read from it when starting processes
|
| 136 | ('env_obj', False),
|
| 137 | ('init_ysh_globals', False), # initialize ARGV
|
| 138 |
|
| 139 | # Can create closures from loop variables, like JS / C# / Go
|
| 140 | ('for_loop_frames', False),
|
| 141 | ]
|
| 142 |
|
| 143 | _YSH_RUNTIME_OPTS = [
|
| 144 | ('no_exported', False), # don't initialize or use exported variables
|
| 145 | ('no_init_globals', False), # don't initialize PWD, COMP_WORDBREAKS, etc.
|
| 146 | ('no_osh_builtins', False), # disable 'set' builtin, etc.
|
| 147 | ('simple_echo', False), # echo takes 0 or 1 arguments
|
| 148 | ('simple_eval_builtin', False), # eval takes exactly 1 argument
|
| 149 | # test only does file ops (no strings ops), remove [, status 2
|
| 150 | ('simple_test_builtin', False),
|
| 151 | ('simple_trap_builtin', False), # trap doesn't take code strings, etc.
|
| 152 |
|
| 153 | # TODO: simple_trap
|
| 154 |
|
| 155 | # Turn aliases off so we can statically parse. bash has it off
|
| 156 | # non-interactively, so this shouldn't break much.
|
| 157 | ('expand_aliases', True),
|
| 158 | ]
|
| 159 |
|
| 160 | # Stuff that doesn't break too many programs.
|
| 161 | _UPGRADE_PARSE_OPTS = [
|
| 162 | 'parse_at', # @array, @[expr]
|
| 163 | 'parse_proc', # proc p { ... }
|
| 164 | 'parse_func', # func f(x) { ... }
|
| 165 | 'parse_brace', # cd /bin { ... }
|
| 166 | 'parse_bracket', # assert [42 === x]
|
| 167 |
|
| 168 | # bare assignment 'x = 42' is allowed in Hay { } blocks, but disallowed
|
| 169 | # everywhere else. It's not a command 'x' with arg '='.
|
| 170 | 'parse_equals',
|
| 171 | 'parse_paren', # if (x > 0) ...
|
| 172 | 'parse_ysh_string', # r'' u'' b'' and multi-line versions
|
| 173 | 'parse_triple_quote', # for ''' and """
|
| 174 | ]
|
| 175 |
|
| 176 | # Extra stuff that breaks programs.
|
| 177 | _YSH_PARSE_OPTS = [
|
| 178 | ('parse_at_all', False), # @ is always an operator, e.g. @[] @{} @@ @_ @-
|
| 179 |
|
| 180 | # Legacy syntax that is removed. These options are distinct from strict_*
|
| 181 | # because they don't help you avoid bugs in bash programs. They just makes
|
| 182 | # the language more consistent.
|
| 183 | ('no_parse_backslash', False),
|
| 184 | ('no_parse_backticks', False),
|
| 185 | ('no_parse_bare_word', False), # disallow 'case bare' and 'for x in bare'
|
| 186 | ('no_parse_dbracket', False), # disallow bash's [[
|
| 187 | ('no_parse_dollar', False),
|
| 188 | ('no_parse_dparen', False), # disallow bash's ((
|
| 189 | ('no_parse_ignored', False),
|
| 190 | ('no_parse_osh', False), # disallow $'', etc.
|
| 191 | ('no_parse_sh_arith', False), # disallow all shell arithmetic, $(( )) etc.
|
| 192 | ('no_parse_word_join', False), # disallow --flag=r'value' pitfall
|
| 193 | ]
|
| 194 |
|
| 195 | _BASH_STUBS = [
|
| 196 | # It's OK to stub progcomp - similar to shopt -s lastpipe, it's on by default in OSH
|
| 197 | 'progcomp',
|
| 198 |
|
| 199 | # Complete host names with '@'.
|
| 200 | # Not implemented, but stubbed out for bash-completion.
|
| 201 | 'hostcomplete',
|
| 202 | ]
|
| 203 |
|
| 204 | # No-ops for bash compatibility
|
| 205 | _BASH_UNIMPLEMENTED = [
|
| 206 | # Handled one by one
|
| 207 | 'histappend', # stubbed out for issue #218
|
| 208 | 'cmdhist', # multi-line commands in history
|
| 209 |
|
| 210 | # Copied from https://www.gnu.org/software/bash/manual/bash.txt
|
| 211 | # except 'compat*' because they were deemed too ugly
|
| 212 | 'assoc_expand_once',
|
| 213 | 'autocd',
|
| 214 | 'cdable_vars',
|
| 215 | 'cdspell',
|
| 216 | 'checkhash',
|
| 217 | 'checkjobs',
|
| 218 | 'checkwinsize',
|
| 219 | 'complete_fullquote', # Set by default
|
| 220 | # If set, Bash quotes all shell metacharacters in filenames and
|
| 221 | # directory names when performing completion. If not set, Bash
|
| 222 | # removes metacharacters such as the dollar sign from the set of
|
| 223 | # characters that will be quoted in completed filenames when
|
| 224 | # these metacharacters appear in shell variable references in
|
| 225 | # words to be completed. This means that dollar signs in
|
| 226 | # variable names that expand to directories will not be quoted;
|
| 227 | # however, any dollar signs appearing in filenames will not be
|
| 228 | # quoted, either. This is active only when bash is using
|
| 229 | # backslashes to quote completed filenames. This variable is
|
| 230 | # set by default, which is the default Bash behavior in versions
|
| 231 | # through 4.2.
|
| 232 | 'direxpand',
|
| 233 | 'dirspell',
|
| 234 | 'execfail',
|
| 235 | 'extquote',
|
| 236 | 'force_fignore',
|
| 237 | 'globasciiranges',
|
| 238 | 'globstar', # TODO: implement **
|
| 239 | 'gnu_errfmt',
|
| 240 | 'histreedit',
|
| 241 | 'histverify',
|
| 242 | 'huponexit',
|
| 243 | 'interactive_comments',
|
| 244 | 'lithist',
|
| 245 | 'localvar_inherit',
|
| 246 | 'localvar_unset',
|
| 247 | 'login_shell',
|
| 248 | 'mailwarn',
|
| 249 | 'no_empty_cmd_completion',
|
| 250 | 'nocaseglob',
|
| 251 | 'progcomp_alias',
|
| 252 | 'promptvars',
|
| 253 | 'restricted_shell',
|
| 254 | 'shift_verbose',
|
| 255 | 'sourcepath',
|
| 256 | 'xpg_echo',
|
| 257 | ]
|
| 258 |
|
| 259 |
|
| 260 | def _Init(opt_def):
|
| 261 | # type: (_OptionDef) -> None
|
| 262 |
|
| 263 | opt_def.Add('errexit',
|
| 264 | short_flag='e',
|
| 265 | builtin='set',
|
| 266 | groups=['ysh:upgrade', 'ysh:all'])
|
| 267 | opt_def.Add('nounset',
|
| 268 | short_flag='u',
|
| 269 | builtin='set',
|
| 270 | groups=['ysh:upgrade', 'ysh:all'])
|
| 271 | opt_def.Add('pipefail', builtin='set', groups=['ysh:upgrade', 'ysh:all'])
|
| 272 |
|
| 273 | opt_def.Add('inherit_errexit', groups=['ysh:upgrade', 'ysh:all'])
|
| 274 | # Hm is this subsumed by simple_word_eval?
|
| 275 | opt_def.Add('nullglob', groups=['ysh:upgrade', 'ysh:all'])
|
| 276 | opt_def.Add('verbose_errexit', groups=['ysh:upgrade', 'ysh:all'])
|
| 277 | opt_def.Add('verbose_warn', groups=['ysh:upgrade', 'ysh:all'])
|
| 278 |
|
| 279 | # set -o noclobber, etc.
|
| 280 | for short_flag, name in _OTHER_SET_OPTIONS:
|
| 281 | opt_def.Add(name, short_flag=short_flag, builtin='set')
|
| 282 |
|
| 283 | # The only one where builtin=None. Only the shell can change it.
|
| 284 | opt_def.Add('interactive', builtin=None)
|
| 285 |
|
| 286 | # bash --norc -c 'set -o' shows this is on by default
|
| 287 | opt_def.Add('hashall', short_flag='h', builtin='set', default=True)
|
| 288 |
|
| 289 | # This option is always on
|
| 290 | opt_def.Add('lastpipe', default=True)
|
| 291 |
|
| 292 | #
|
| 293 | # shopt
|
| 294 | # (bash uses $BASHOPTS rather than $SHELLOPTS)
|
| 295 | #
|
| 296 |
|
| 297 | # shopt options that aren't in any groups.
|
| 298 | opt_def.Add('failglob')
|
| 299 | opt_def.Add('extglob')
|
| 300 | opt_def.Add('nocasematch')
|
| 301 | opt_def.Add('dotglob')
|
| 302 |
|
| 303 | opt_def.Add('extdebug') # for task files
|
| 304 |
|
| 305 | # recursive parsing and evaluation - for compatibility, ble.sh, etc.
|
| 306 | opt_def.Add('eval_unsafe_arith')
|
| 307 |
|
| 308 | opt_def.Add('ignore_flags_not_impl')
|
| 309 | opt_def.Add('ignore_shopt_not_impl')
|
| 310 |
|
| 311 | # Optimizations
|
| 312 | opt_def.Add('rewrite_extern', default=True)
|
| 313 |
|
| 314 | # For implementing strict_errexit
|
| 315 | # TODO: could be _no_command_sub / _no_process_sub, if we had to discourage
|
| 316 | # "default True" options
|
| 317 | opt_def.Add('_allow_command_sub', default=True)
|
| 318 | opt_def.Add('_allow_process_sub', default=True)
|
| 319 |
|
| 320 | # For implementing 'proc'
|
| 321 | # TODO: _dynamic_scope
|
| 322 | opt_def.Add('dynamic_scope', default=True)
|
| 323 |
|
| 324 | # On in interactive shell
|
| 325 | opt_def.Add('redefine_const', default=False)
|
| 326 | opt_def.Add('redefine_source', default=False)
|
| 327 |
|
| 328 | # For disabling strict_errexit while running traps. Because we run in the
|
| 329 | # main loop, the value can be "off". Prefix with _ because it's undocumented
|
| 330 | # and users shouldn't fiddle with it. We need a stack so this is a
|
| 331 | # convenient place.
|
| 332 | opt_def.Add('_running_trap')
|
| 333 | opt_def.Add('_running_hay')
|
| 334 |
|
| 335 | # For fixing lastpipe / job control / DEBUG trap interaction
|
| 336 | opt_def.Add('_no_debug_trap')
|
| 337 | # To implement ERR trap semantics - it's only run for the WHOLE pipeline,
|
| 338 | # not each part (even the last part)
|
| 339 | opt_def.Add('_no_err_trap')
|
| 340 |
|
| 341 | # shopt -s strict_arith, etc.
|
| 342 | for name in _STRICT_OPTS:
|
| 343 | opt_def.Add(name, groups=['strict:all', 'ysh:all'])
|
| 344 |
|
| 345 | #
|
| 346 | # Options that enable YSH features
|
| 347 | #
|
| 348 |
|
| 349 | #opt_def.Add('no_exported') # TODO: move this
|
| 350 | for name in _UPGRADE_PARSE_OPTS:
|
| 351 | opt_def.Add(name, groups=['ysh:upgrade', 'ysh:all'])
|
| 352 | # shopt -s simple_word_eval, etc.
|
| 353 | for name, default in _UPGRADE_RUNTIME_OPTS:
|
| 354 | opt_def.Add(name, default=default, groups=['ysh:upgrade', 'ysh:all'])
|
| 355 |
|
| 356 | for name, default in _YSH_PARSE_OPTS:
|
| 357 | opt_def.Add(name, default=default, groups=['ysh:all'])
|
| 358 | for name, default in _YSH_RUNTIME_OPTS:
|
| 359 | opt_def.Add(name, default=default, groups=['ysh:all'])
|
| 360 |
|
| 361 | for name in _BASH_STUBS:
|
| 362 | opt_def.Add(name)
|
| 363 |
|
| 364 | opt_def.DoneWithImplementedOptions()
|
| 365 |
|
| 366 | # Stubs for shopt -s xpg_echo, etc.
|
| 367 | for name in _BASH_UNIMPLEMENTED:
|
| 368 | opt_def.Add(name, implemented=False)
|
| 369 |
|
| 370 |
|
| 371 | def All():
|
| 372 | # type: () -> List[Option]
|
| 373 | """Return a list of options with metadata.
|
| 374 |
|
| 375 | - Used by osh/builtin_pure.py to construct the arg spec.
|
| 376 | - Used by frontend/lexer_gen.py to construct the lexer/matcher
|
| 377 | """
|
| 378 | return _OPTION_DEF.opts
|
| 379 |
|
| 380 |
|
| 381 | def ArraySize():
|
| 382 | # type: () -> int
|
| 383 | """Unused now, since we use opt_num::ARRAY_SIZE.
|
| 384 |
|
| 385 | We could get rid of unimplemented options and shrink the array.
|
| 386 | """
|
| 387 | return _OPTION_DEF.array_size
|
| 388 |
|
| 389 |
|
| 390 | def OptionDict():
|
| 391 | # type: () -> Dict[str, Tuple[int, bool]]
|
| 392 | """Implemented options.
|
| 393 |
|
| 394 | For the slow path in frontend/consts.py
|
| 395 | """
|
| 396 | d = {}
|
| 397 | for opt in _OPTION_DEF.opts:
|
| 398 | d[opt.name] = (opt.index, opt.implemented)
|
| 399 | return d
|
| 400 |
|
| 401 |
|
| 402 | def ParseOptNames():
|
| 403 | # type: () -> List[str]
|
| 404 | """Used by core/optview*.py."""
|
| 405 | return [opt.name for opt in _OPTION_DEF.opts if opt.is_parse]
|
| 406 |
|
| 407 |
|
| 408 | def ExecOptNames():
|
| 409 | # type: () -> List[str]
|
| 410 | """Used by core/optview*.py."""
|
| 411 | return [opt.name for opt in _OPTION_DEF.opts if opt.is_exec]
|
| 412 |
|
| 413 |
|
| 414 | _OPTION_DEF = _OptionDef()
|
| 415 |
|
| 416 | _Init(_OPTION_DEF)
|
| 417 |
|
| 418 | # Sort by name because we print options.
|
| 419 | # TODO: for MEMBERSHIP queries, we could sort by the most common? errexit
|
| 420 | # first?
|
| 421 | _SORTED = sorted(_OPTION_DEF.opts, key=lambda opt: opt.name)
|
| 422 |
|
| 423 | PARSE_OPTION_NUMS = [opt.index for opt in _SORTED if opt.is_parse]
|
| 424 |
|
| 425 | # Sorted because 'shopt -o -p' should be sorted, etc.
|
| 426 | VISIBLE_SHOPT_NUMS = [
|
| 427 | opt.index for opt in _SORTED if opt.builtin == 'shopt' and opt.implemented
|
| 428 | ]
|
| 429 |
|
| 430 | YSH_UPGRADE = [opt.index for opt in _SORTED if 'ysh:upgrade' in opt.groups]
|
| 431 | YSH_ALL = [opt.index for opt in _SORTED if 'ysh:all' in opt.groups]
|
| 432 | STRICT_ALL = [opt.index for opt in _SORTED if 'strict:all' in opt.groups]
|
| 433 | DEFAULT_TRUE = [opt.index for opt in _SORTED if opt.default]
|
| 434 | #print([opt.name for opt in _SORTED if opt.default])
|
| 435 |
|
| 436 | META_OPTIONS = ['strict:all', 'ysh:upgrade',
|
| 437 | 'ysh:all'] # Passed to flag parser
|
| 438 |
|
| 439 | # For printing option names to stdout. Wrapped by frontend/consts.
|
| 440 | OPTION_NAMES = dict((opt.index, opt.name) for opt in _SORTED)
|