OILS / core / shell.py View on Github | oilshell.org

1183 lines, 746 significant
1"""
2core/shell.py -- Entry point for the shell interpreter.
3"""
4from __future__ import print_function
5
6from errno import ENOENT
7import time as time_
8
9from _devbuild.gen import arg_types
10from _devbuild.gen.option_asdl import option_i, builtin_i
11from _devbuild.gen.runtime_asdl import scope_e
12from _devbuild.gen.syntax_asdl import (loc, source, source_t, IntParamBox,
13 debug_frame, debug_frame_t)
14from _devbuild.gen.value_asdl import (value, value_e, value_t, Obj)
15from core import alloc
16from core import comp_ui
17from core import dev
18from core import error
19from core import executor
20from core import completion
21from core import main_loop
22from core import optview
23from core import pyos
24from core import process
25from core import pyutil
26from core import state
27from display import ui
28from core import util
29from core import vm
30
31from frontend import args
32from frontend import flag_def # side effect: flags are defined!
33
34unused1 = flag_def
35from frontend import flag_util
36from frontend import location
37from frontend import reader
38from frontend import parse_lib
39
40from builtin import assign_osh
41from builtin import bracket_osh
42from builtin import completion_osh
43from builtin import completion_ysh
44from builtin import dirs_osh
45from builtin import error_ysh
46from builtin import hay_ysh
47from builtin import io_osh
48from builtin import io_ysh
49from builtin import json_ysh
50from builtin import meta_osh
51from builtin import misc_osh
52from builtin import module_ysh
53from builtin import printf_osh
54from builtin import process_osh
55from builtin import pure_osh
56from builtin import pure_ysh
57from builtin import readline_osh
58from builtin import read_osh
59from builtin import trap_osh
60
61from builtin import func_eggex
62from builtin import func_hay
63from builtin import func_misc
64
65from builtin import method_dict
66from builtin import method_io
67from builtin import method_list
68from builtin import method_other
69from builtin import method_str
70
71from osh import cmd_eval
72from osh import glob_
73from osh import history
74from osh import prompt
75from osh import sh_expr_eval
76from osh import split
77from osh import word_eval
78
79from mycpp import mops
80from mycpp import mylib
81from mycpp.mylib import print_stderr, log
82from pylib import os_path
83from tools import deps
84from tools import fmt
85from tools import ysh_ify
86from ysh import expr_eval
87
88unused2 = log
89
90import libc
91import posix_ as posix
92
93from typing import List, Dict, Optional, TYPE_CHECKING, cast
94if TYPE_CHECKING:
95 from frontend.py_readline import Readline
96
97if mylib.PYTHON:
98 try:
99 from _devbuild.gen import help_meta # type: ignore
100 except ImportError:
101 help_meta = None
102
103
104def _InitDefaultCompletions(cmd_ev, complete_builtin, comp_lookup):
105 # type: (cmd_eval.CommandEvaluator, completion_osh.Complete, completion.Lookup) -> None
106
107 # register builtins and words
108 complete_builtin.Run(cmd_eval.MakeBuiltinArgv(['-E', '-A', 'command']))
109 # register path completion
110 # Add -o filenames? Or should that be automatic?
111 complete_builtin.Run(cmd_eval.MakeBuiltinArgv(['-D', '-A', 'file']))
112
113
114def _CompletionDemo(comp_lookup):
115 # type: (completion.Lookup) -> None
116
117 # Something for fun, to show off. Also: test that you don't repeatedly hit
118 # the file system / network / coprocess.
119 A1 = completion.TestAction(['foo.py', 'foo', 'bar.py'], 0.0)
120 l = [] # type: List[str]
121 for i in xrange(0, 5):
122 l.append('m%d' % i)
123
124 A2 = completion.TestAction(l, 0.1)
125 C1 = completion.UserSpec([A1, A2], [], [], completion.DefaultPredicate(),
126 '', '')
127 comp_lookup.RegisterName('slowc', {}, C1)
128
129
130def SourceStartupFile(
131 fd_state, # type: process.FdState
132 rc_path, # type: str
133 lang, # type: str
134 parse_ctx, # type: parse_lib.ParseContext
135 cmd_ev, # type: cmd_eval.CommandEvaluator
136 errfmt, # type: ui.ErrorFormatter
137):
138 # type: (...) -> None
139
140 # Right now this is called when the shell is interactive. (Maybe it should
141 # be called on login_shel too.)
142 #
143 # Terms:
144 # - interactive shell: Roughly speaking, no args or -c, and isatty() is true
145 # for stdin and stdout.
146 # - login shell: Started from the top level, e.g. from init or ssh.
147 #
148 # We're not going to copy everything bash does because it's too complex, but
149 # for reference:
150 # https://www.gnu.org/software/bash/manual/bash.html#Bash-Startup-Files
151 # Bash also has --login.
152
153 try:
154 f = fd_state.Open(rc_path)
155 except (IOError, OSError) as e:
156 # TODO: Could warn about nonexistent explicit --rcfile?
157 if e.errno != ENOENT:
158 raise # Goes to top level. Handle this better?
159 return
160
161 arena = parse_ctx.arena
162 rc_line_reader = reader.FileLineReader(f, arena)
163 rc_c_parser = parse_ctx.MakeOshParser(rc_line_reader)
164
165 with alloc.ctx_SourceCode(arena, source.SourcedFile(rc_path, loc.Missing)):
166 # TODO: handle status, e.g. 2 for ParseError
167 unused = main_loop.Batch(cmd_ev, rc_c_parser, errfmt)
168
169 f.close()
170
171
172class ShellOptHook(state.OptHook):
173
174 def __init__(self, readline):
175 # type: (Optional[Readline]) -> None
176 self.readline = readline
177
178 def OnChange(self, opt0_array, opt_name, b):
179 # type: (List[bool], str, bool) -> bool
180 """This method is called whenever an option is changed.
181
182 Returns success or failure.
183 """
184 if opt_name == 'vi' or opt_name == 'emacs':
185 # TODO: Replace with a hook? Just like setting LANG= can have a hook.
186 if self.readline:
187 self.readline.parse_and_bind("set editing-mode " + opt_name)
188 else:
189 print_stderr(
190 "Warning: Can't set option %r because shell wasn't compiled with GNU readline"
191 % opt_name)
192 return False
193
194 # Invert: they are mutually exclusive!
195 if opt_name == 'vi':
196 opt0_array[option_i.emacs] = not b
197 elif opt_name == 'emacs':
198 opt0_array[option_i.vi] = not b
199
200 return True
201
202
203def _SetGlobalFunc(mem, name, func):
204 # type: (state.Mem, str, vm._Callable) -> None
205 assert isinstance(func, vm._Callable), func
206
207 # Note: no location info for builtin functions?
208 mem.SetNamed(location.LName(name), value.BuiltinFunc(func),
209 scope_e.GlobalOnly)
210
211
212def InitAssignmentBuiltins(
213 mem, # type: state.Mem
214 procs, # type: state.Procs
215 exec_opts, # type: optview.Exec
216 errfmt, # type: ui.ErrorFormatter
217):
218 # type: (...) -> Dict[int, vm._AssignBuiltin]
219
220 assign_b = {} # type: Dict[int, vm._AssignBuiltin]
221
222 new_var = assign_osh.NewVar(mem, procs, exec_opts, errfmt)
223 assign_b[builtin_i.declare] = new_var
224 assign_b[builtin_i.typeset] = new_var
225 assign_b[builtin_i.local] = new_var
226
227 assign_b[builtin_i.export_] = assign_osh.Export(mem, errfmt)
228 assign_b[builtin_i.readonly] = assign_osh.Readonly(mem, errfmt)
229
230 return assign_b
231
232
233class ShellFiles(object):
234
235 def __init__(self, lang, home_dir, mem, flag):
236 # type: (str, str, state.Mem, arg_types.main) -> None
237 assert lang in ('osh', 'ysh'), lang
238 self.lang = lang
239 self.home_dir = home_dir
240 self.mem = mem
241 self.flag = flag
242
243 def _HistVar(self):
244 # type: () -> str
245 return 'HISTFILE' if self.lang == 'osh' else 'YSH_HISTFILE'
246
247 def _DefaultHistoryFile(self):
248 # type: () -> str
249 return os_path.join(self.home_dir,
250 '.local/share/oils/%s_history' % self.lang)
251
252 def InitAfterLoadingEnv(self):
253 # type: () -> None
254
255 hist_var = self._HistVar()
256 if self.mem.GetValue(hist_var).tag() == value_e.Undef:
257 # Note: if the directory doesn't exist, GNU readline ignores
258 state.SetGlobalString(self.mem, hist_var,
259 self._DefaultHistoryFile())
260
261 def HistoryFile(self):
262 # type: () -> Optional[str]
263 # TODO: In non-strict mode we should try to cast the HISTFILE value to a
264 # string following bash's rules
265
266 UP_val = self.mem.GetValue(self._HistVar())
267 if UP_val.tag() == value_e.Str:
268 val = cast(value.Str, UP_val)
269 return val.s
270 else:
271 # Note: if HISTFILE is an array, bash will return ${HISTFILE[0]}
272 return None
273 #return self._DefaultHistoryFile()
274
275 # TODO: can we recover line information here?
276 # might be useful to show where HISTFILE was set
277 #raise error.Strict("$HISTFILE should only ever be a string", loc.Missing)
278
279
280def Main(
281 lang, # type: str
282 arg_r, # type: args.Reader
283 environ, # type: Dict[str, str]
284 login_shell, # type: bool
285 loader, # type: pyutil._ResourceLoader
286 readline, # type: Optional[Readline]
287):
288 # type: (...) -> int
289 """The full shell lifecycle. Used by bin/osh and bin/ysh.
290
291 Args:
292 lang: 'osh' or 'ysh'
293 login_shell: Was - on argv[0]?
294 loader: to get help, version, grammar, etc.
295 readline: optional GNU readline
296 """
297 # Differences between osh and ysh:
298 # - oshrc vs yshrc
299 # - shopt -s ysh:all
300 # - Prompt
301 # - --help
302
303 argv0 = arg_r.Peek()
304 assert argv0 is not None
305 arg_r.Next()
306
307 assert lang in ('osh', 'ysh'), lang
308
309 try:
310 attrs = flag_util.ParseMore('main', arg_r)
311 except error.Usage as e:
312 print_stderr('%s usage error: %s' % (lang, e.msg))
313 return 2
314 flag = arg_types.main(attrs.attrs)
315
316 arena = alloc.Arena()
317 errfmt = ui.ErrorFormatter()
318
319 if flag.help:
320 util.HelpFlag(loader, '%s-usage' % lang, mylib.Stdout())
321 return 0
322 if flag.version:
323 util.VersionFlag(loader, mylib.Stdout())
324 return 0
325
326 if flag.tool == 'cat-em':
327 paths = arg_r.Rest()
328
329 status = 0
330 for p in paths:
331 try:
332 contents = loader.Get(p)
333 print(contents)
334 except (OSError, IOError):
335 print_stderr("cat-em: %r not found" % p)
336 status = 1
337 return status
338
339 debug_stack = [] # type: List[debug_frame_t]
340 if arg_r.AtEnd():
341 dollar0 = argv0
342 else:
343 dollar0 = arg_r.Peek() # the script name, or the arg after -c
344
345 frame0 = debug_frame.Main(dollar0)
346 debug_stack.append(frame0)
347
348 script_name = arg_r.Peek() # type: Optional[str]
349 arg_r.Next()
350 mem = state.Mem(dollar0, arg_r.Rest(), arena, debug_stack)
351
352 opt_hook = ShellOptHook(readline)
353 # Note: only MutableOpts needs mem, so it's not a true circular dep.
354 parse_opts, exec_opts, mutable_opts = state.MakeOpts(mem, opt_hook)
355 mem.exec_opts = exec_opts # circular dep
356 mutable_opts.Init()
357
358 # Set these BEFORE processing flags, so they can be overridden.
359 if lang == 'ysh':
360 mutable_opts.SetAnyOption('ysh:all', True)
361
362 pure_osh.SetOptionsFromFlags(mutable_opts, attrs.opt_changes,
363 attrs.shopt_changes)
364
365 version_str = pyutil.GetVersion(loader)
366 state.InitMem(mem, environ, version_str)
367
368 # TODO: consider turning on no_copy_env in YSH
369 if exec_opts.no_copy_env():
370 # Don't consult the environment
371 mem.SetPwd(state.GetWorkingDir())
372 else:
373 state.InitVarsFromEnv(mem, environ)
374
375 # MUTABLE GLOBAL that's SEPARATE from $PWD. Used by the 'pwd' builtin, but
376 # it can't be modified by users.
377 val = mem.GetValue('PWD')
378 # should be true since it's exported
379 assert val.tag() == value_e.Str, val
380 pwd = cast(value.Str, val).s
381 mem.SetPwd(pwd)
382
383 if attrs.show_options: # special case: sh -o
384 mutable_opts.ShowOptions([])
385 return 0
386
387 # feedback between runtime and parser
388 aliases = {} # type: Dict[str, str]
389
390 ysh_grammar = pyutil.LoadYshGrammar(loader)
391
392 if flag.do_lossless and not exec_opts.noexec():
393 raise error.Usage('--one-pass-parse requires noexec (-n)', loc.Missing)
394
395 # Tools always use one pass parse
396 # Note: osh --tool syntax-tree is like osh -n --one-pass-parse
397 do_lossless = True if len(flag.tool) else flag.do_lossless
398
399 parse_ctx = parse_lib.ParseContext(arena,
400 parse_opts,
401 aliases,
402 ysh_grammar,
403 do_lossless=do_lossless)
404
405 # Three ParseContext instances SHARE aliases.
406 comp_arena = alloc.Arena()
407 comp_arena.PushSource(source.Unused('completion'))
408 trail1 = parse_lib.Trail()
409 # do_lossless needs to be turned on to complete inside backticks. TODO:
410 # fix the issue where ` gets erased because it's not part of
411 # set_completer_delims().
412 comp_ctx = parse_lib.ParseContext(comp_arena,
413 parse_opts,
414 aliases,
415 ysh_grammar,
416 do_lossless=True)
417 comp_ctx.Init_Trail(trail1)
418
419 hist_arena = alloc.Arena()
420 hist_arena.PushSource(source.Unused('history'))
421 trail2 = parse_lib.Trail()
422 hist_ctx = parse_lib.ParseContext(hist_arena, parse_opts, aliases,
423 ysh_grammar)
424 hist_ctx.Init_Trail(trail2)
425
426 # Deps helps manages dependencies. These dependencies are circular:
427 # - cmd_ev and word_ev, arith_ev -- for command sub, arith sub
428 # - arith_ev and word_ev -- for $(( ${a} )) and $x$(( 1 ))
429 # - cmd_ev and builtins (which execute code, like eval)
430 # - prompt_ev needs word_ev for $PS1, which needs prompt_ev for @P
431 cmd_deps = cmd_eval.Deps()
432 cmd_deps.mutable_opts = mutable_opts
433
434 job_control = process.JobControl()
435 job_list = process.JobList()
436 fd_state = process.FdState(errfmt, job_control, job_list, mem, None, None,
437 exec_opts)
438
439 my_pid = posix.getpid()
440
441 debug_path = ''
442 debug_dir = environ.get('OILS_DEBUG_DIR')
443 if flag.debug_file is not None:
444 # --debug-file takes precedence over OSH_DEBUG_DIR
445 debug_path = flag.debug_file
446 elif debug_dir is not None:
447 debug_path = os_path.join(debug_dir, '%d-osh.log' % my_pid)
448
449 if len(debug_path):
450 # This will be created as an empty file if it doesn't exist, or it could be
451 # a pipe.
452 try:
453 debug_f = util.DebugFile(
454 fd_state.OpenForWrite(debug_path)) # type: util._DebugFile
455 except (IOError, OSError) as e:
456 print_stderr("%s: Couldn't open %r: %s" %
457 (lang, debug_path, posix.strerror(e.errno)))
458 return 2
459 else:
460 debug_f = util.NullDebugFile()
461
462 if flag.xtrace_to_debug_file:
463 trace_f = debug_f
464 else:
465 trace_f = util.DebugFile(mylib.Stderr())
466
467 trace_dir = environ.get('OILS_TRACE_DIR', '')
468 dumps = environ.get('OILS_TRACE_DUMPS', '')
469 streams = environ.get('OILS_TRACE_STREAMS', '')
470 multi_trace = dev.MultiTracer(my_pid, trace_dir, dumps, streams, fd_state)
471
472 tracer = dev.Tracer(parse_ctx, exec_opts, mutable_opts, mem, trace_f,
473 multi_trace)
474 fd_state.tracer = tracer # circular dep
475
476 # RegisterSignalInterest should return old sigint handler
477 # then InteractiveLineReader can use it
478 # InteractiveLineReader
479 signal_safe = pyos.InitSignalSafe()
480 trap_state = trap_osh.TrapState(signal_safe)
481
482 waiter = process.Waiter(job_list, exec_opts, signal_safe, tracer)
483 fd_state.waiter = waiter
484
485 cmd_deps.debug_f = debug_f
486
487 now = time_.time()
488 iso_stamp = time_.strftime("%Y-%m-%d %H:%M:%S", time_.localtime(now))
489
490 argv_buf = mylib.BufWriter()
491 dev.PrintShellArgv(arg_r.argv, argv_buf)
492
493 debug_f.writeln('%s [%d] Oils started with argv %s' %
494 (iso_stamp, my_pid, argv_buf.getvalue()))
495 if len(debug_path):
496 debug_f.writeln('Writing logs to %r' % debug_path)
497
498 interp = environ.get('OILS_HIJACK_SHEBANG', '')
499 search_path = state.SearchPath(mem)
500 ext_prog = process.ExternalProgram(interp, fd_state, errfmt, debug_f)
501
502 splitter = split.SplitContext(mem)
503 # TODO: This is instantiation is duplicated in osh/word_eval.py
504 globber = glob_.Globber(exec_opts)
505
506 # This could just be OILS_TRACE_DUMPS='crash:argv0'
507 crash_dump_dir = environ.get('OILS_CRASH_DUMP_DIR', '')
508 cmd_deps.dumper = dev.CrashDumper(crash_dump_dir, fd_state)
509
510 comp_lookup = completion.Lookup()
511
512 # Various Global State objects to work around readline interfaces
513 compopt_state = completion.OptionState()
514
515 comp_ui_state = comp_ui.State()
516 prompt_state = comp_ui.PromptState()
517
518 # The login program is supposed to set $HOME
519 # https://superuser.com/questions/271925/where-is-the-home-environment-variable-set
520 # state.InitMem(mem) must happen first
521 tilde_ev = word_eval.TildeEvaluator(mem, exec_opts)
522 home_dir = tilde_ev.GetMyHomeDir()
523 if home_dir is None:
524 # TODO: print errno from getpwuid()
525 print_stderr("%s: Failed to get home dir from $HOME or getpwuid()" %
526 lang)
527 return 1
528
529 sh_files = ShellFiles(lang, home_dir, mem, flag)
530 sh_files.InitAfterLoadingEnv()
531
532 #
533 # Executor and Evaluators (are circularly dependent)
534 #
535
536 # Global proc namespace. Funcs are defined in the common variable
537 # namespace.
538 procs = state.Procs(mem) # type: state.Procs
539
540 builtins = {} # type: Dict[int, vm._Builtin]
541
542 # e.g. s->startswith()
543 methods = {} # type: Dict[int, Dict[str, vm._Callable]]
544
545 hay_state = hay_ysh.HayState()
546
547 shell_ex = executor.ShellExecutor(mem, exec_opts, mutable_opts, procs,
548 hay_state, builtins, search_path,
549 ext_prog, waiter, tracer, job_control,
550 job_list, fd_state, trap_state, errfmt)
551
552 arith_ev = sh_expr_eval.ArithEvaluator(mem, exec_opts, mutable_opts,
553 parse_ctx, errfmt)
554 bool_ev = sh_expr_eval.BoolEvaluator(mem, exec_opts, mutable_opts,
555 parse_ctx, errfmt)
556 expr_ev = expr_eval.ExprEvaluator(mem, mutable_opts, methods, splitter,
557 errfmt)
558 word_ev = word_eval.NormalWordEvaluator(mem, exec_opts, mutable_opts,
559 tilde_ev, splitter, errfmt)
560
561 assign_b = InitAssignmentBuiltins(mem, procs, exec_opts, errfmt)
562 cmd_ev = cmd_eval.CommandEvaluator(mem, exec_opts, errfmt, procs, assign_b,
563 arena, cmd_deps, trap_state,
564 signal_safe)
565
566 # PromptEvaluator rendering is needed in non-interactive shells for @P.
567 prompt_ev = prompt.Evaluator(lang, version_str, parse_ctx, mem)
568
569 io_methods = {
570 'promptVal': value.BuiltinFunc(method_io.PromptVal(prompt_ev)),
571
572 # The M/ prefix means it's io->eval()
573 'M/eval': value.BuiltinFunc(method_io.Eval(cmd_ev)),
574
575 # Identical to command sub
576 'captureStdout': value.BuiltinFunc(method_io.CaptureStdout(shell_ex)),
577
578 # TODO:
579 'time': value.BuiltinFunc(method_io.Time()),
580 'strftime': value.BuiltinFunc(method_io.Strftime()),
581 'glob': None,
582 } # type: Dict[str, value_t]
583 io_props = {'stdin': value.Stdin} # type: Dict[str, value_t]
584 io_obj = Obj(Obj(None, io_methods), io_props)
585
586 # Wire up circular dependencies.
587 vm.InitCircularDeps(arith_ev, bool_ev, expr_ev, word_ev, cmd_ev, shell_ex,
588 prompt_ev, io_obj, tracer)
589
590 unsafe_arith = sh_expr_eval.UnsafeArith(mem, exec_opts, mutable_opts,
591 parse_ctx, arith_ev, errfmt)
592 vm.InitUnsafeArith(mem, word_ev, unsafe_arith)
593
594 #
595 # Initialize Built-in Procs
596 #
597
598 b = builtins # short alias for initialization
599
600 if mylib.PYTHON:
601 if help_meta:
602 help_data = help_meta.TopicMetadata()
603 else:
604 help_data = {} # minimal build
605 else:
606 help_data = help_meta.TopicMetadata()
607 b[builtin_i.help] = misc_osh.Help(lang, loader, help_data, errfmt)
608
609 # Interpreter state
610 b[builtin_i.set] = pure_osh.Set(mutable_opts, mem)
611 b[builtin_i.shopt] = pure_osh.Shopt(mutable_opts, cmd_ev)
612
613 b[builtin_i.hash] = pure_osh.Hash(search_path) # not really pure
614 b[builtin_i.trap] = trap_osh.Trap(trap_state, parse_ctx, tracer, errfmt)
615
616 b[builtin_i.shvar] = pure_ysh.Shvar(mem, search_path, cmd_ev)
617 b[builtin_i.ctx] = pure_ysh.Ctx(mem, cmd_ev)
618 b[builtin_i.push_registers] = pure_ysh.PushRegisters(mem, cmd_ev)
619
620 # Hay
621 b[builtin_i.hay] = hay_ysh.Hay(hay_state, mutable_opts, mem, cmd_ev)
622 b[builtin_i.haynode] = hay_ysh.HayNode_(hay_state, mem, cmd_ev)
623
624 # Interpreter introspection
625 b[builtin_i.type] = meta_osh.Type(procs, aliases, search_path, errfmt)
626 b[builtin_i.builtin] = meta_osh.Builtin(shell_ex, errfmt)
627 b[builtin_i.command] = meta_osh.Command(shell_ex, procs, aliases,
628 search_path)
629 # Part of YSH, but similar to builtin/command
630 b[builtin_i.runproc] = meta_osh.RunProc(shell_ex, procs, errfmt)
631
632 # Meta builtins
633 source_builtin = meta_osh.Source(parse_ctx, search_path, cmd_ev, fd_state,
634 tracer, errfmt, loader)
635 b[builtin_i.source] = source_builtin
636 b[builtin_i.dot] = source_builtin
637 b[builtin_i.eval] = meta_osh.Eval(parse_ctx, exec_opts, cmd_ev, tracer,
638 errfmt, mem)
639
640 # Module builtins
641 guards = {} # type: Dict[str, bool]
642 b[builtin_i.source_guard] = module_ysh.SourceGuard(guards, exec_opts,
643 errfmt)
644 b[builtin_i.is_main] = module_ysh.IsMain(mem)
645 b[builtin_i.use] = module_ysh.Use(mem, errfmt)
646
647 # Errors
648 b[builtin_i.error] = error_ysh.Error()
649 b[builtin_i.failed] = error_ysh.Failed(mem)
650 b[builtin_i.boolstatus] = error_ysh.BoolStatus(shell_ex, errfmt)
651 b[builtin_i.try_] = error_ysh.Try(mutable_opts, mem, cmd_ev, shell_ex,
652 errfmt)
653 b[builtin_i.assert_] = error_ysh.Assert(expr_ev, errfmt)
654
655 # Pure builtins
656 true_ = pure_osh.Boolean(0)
657 b[builtin_i.colon] = true_ # a "special" builtin
658 b[builtin_i.true_] = true_
659 b[builtin_i.false_] = pure_osh.Boolean(1)
660
661 b[builtin_i.alias] = pure_osh.Alias(aliases, errfmt)
662 b[builtin_i.unalias] = pure_osh.UnAlias(aliases, errfmt)
663
664 b[builtin_i.getopts] = pure_osh.GetOpts(mem, errfmt)
665
666 b[builtin_i.shift] = assign_osh.Shift(mem)
667 b[builtin_i.unset] = assign_osh.Unset(mem, procs, unsafe_arith, errfmt)
668
669 b[builtin_i.append] = pure_ysh.Append(mem, errfmt)
670
671 # test / [ differ by need_right_bracket
672 b[builtin_i.test] = bracket_osh.Test(False, exec_opts, mem, errfmt)
673 b[builtin_i.bracket] = bracket_osh.Test(True, exec_opts, mem, errfmt)
674
675 # Output
676 b[builtin_i.echo] = io_osh.Echo(exec_opts)
677 b[builtin_i.printf] = printf_osh.Printf(mem, parse_ctx, unsafe_arith,
678 errfmt)
679 b[builtin_i.write] = io_ysh.Write(mem, errfmt)
680 b[builtin_i.fopen] = io_ysh.Fopen(mem, cmd_ev)
681
682 # (pp output format isn't stable)
683 b[builtin_i.pp] = io_ysh.Pp(expr_ev, mem, errfmt, procs, arena)
684
685 # Input
686 b[builtin_i.cat] = io_osh.Cat() # for $(<file)
687 b[builtin_i.read] = read_osh.Read(splitter, mem, parse_ctx, cmd_ev, errfmt)
688
689 mapfile = io_osh.MapFile(mem, errfmt, cmd_ev)
690 b[builtin_i.mapfile] = mapfile
691 b[builtin_i.readarray] = mapfile
692
693 # Dirs
694 dir_stack = dirs_osh.DirStack()
695 b[builtin_i.cd] = dirs_osh.Cd(mem, dir_stack, cmd_ev, errfmt)
696 b[builtin_i.pushd] = dirs_osh.Pushd(mem, dir_stack, errfmt)
697 b[builtin_i.popd] = dirs_osh.Popd(mem, dir_stack, errfmt)
698 b[builtin_i.dirs] = dirs_osh.Dirs(mem, dir_stack, errfmt)
699 b[builtin_i.pwd] = dirs_osh.Pwd(mem, errfmt)
700
701 b[builtin_i.times] = misc_osh.Times()
702
703 b[builtin_i.json] = json_ysh.Json(mem, errfmt, False)
704 b[builtin_i.json8] = json_ysh.Json(mem, errfmt, True)
705
706 ### Process builtins
707 b[builtin_i.exec_] = process_osh.Exec(mem, ext_prog, fd_state, search_path,
708 errfmt)
709 b[builtin_i.umask] = process_osh.Umask()
710 b[builtin_i.ulimit] = process_osh.Ulimit()
711 b[builtin_i.wait] = process_osh.Wait(waiter, job_list, mem, tracer, errfmt)
712
713 b[builtin_i.jobs] = process_osh.Jobs(job_list)
714 b[builtin_i.fg] = process_osh.Fg(job_control, job_list, waiter)
715 b[builtin_i.bg] = process_osh.Bg(job_list)
716
717 # Could be in process_ysh
718 b[builtin_i.fork] = process_osh.Fork(shell_ex)
719 b[builtin_i.forkwait] = process_osh.ForkWait(shell_ex)
720
721 # Interactive builtins depend on readline
722 b[builtin_i.bind] = readline_osh.Bind(readline, errfmt)
723 b[builtin_i.history] = readline_osh.History(readline, sh_files, errfmt,
724 mylib.Stdout())
725
726 # Completion
727 spec_builder = completion_osh.SpecBuilder(cmd_ev, parse_ctx, word_ev,
728 splitter, comp_lookup, help_data,
729 errfmt)
730 complete_builtin = completion_osh.Complete(spec_builder, comp_lookup)
731 b[builtin_i.complete] = complete_builtin
732 b[builtin_i.compgen] = completion_osh.CompGen(spec_builder)
733 b[builtin_i.compopt] = completion_osh.CompOpt(compopt_state, errfmt)
734 b[builtin_i.compadjust] = completion_osh.CompAdjust(mem)
735
736 comp_ev = word_eval.CompletionWordEvaluator(mem, exec_opts, mutable_opts,
737 tilde_ev, splitter, errfmt)
738
739 comp_ev.arith_ev = arith_ev
740 comp_ev.expr_ev = expr_ev
741 comp_ev.prompt_ev = prompt_ev
742 comp_ev.CheckCircularDeps()
743
744 root_comp = completion.RootCompleter(comp_ev, mem, comp_lookup,
745 compopt_state, comp_ui_state,
746 comp_ctx, debug_f)
747 b[builtin_i.compexport] = completion_ysh.CompExport(root_comp)
748
749 #
750 # Initialize Builtin-in Methods
751 #
752
753 methods[value_e.Str] = {
754 'startsWith': method_str.HasAffix(method_str.START),
755 'endsWith': method_str.HasAffix(method_str.END),
756 'trim': method_str.Trim(method_str.START | method_str.END),
757 'trimStart': method_str.Trim(method_str.START),
758 'trimEnd': method_str.Trim(method_str.END),
759 'upper': method_str.Upper(),
760 'lower': method_str.Lower(),
761 'split': method_str.Split(),
762
763 # finds a substring, optional position to start at
764 'find': None,
765
766 # replace substring, OR an eggex
767 # takes count=3, the max number of replacements to do.
768 'replace': method_str.Replace(mem, expr_ev),
769
770 # Like Python's re.search, except we put it on the string object
771 # It's more consistent with Str->find(substring, pos=0)
772 # It returns value.Match() rather than an integer
773 'search': method_str.SearchMatch(method_str.SEARCH),
774
775 # like Python's re.match()
776 'leftMatch': method_str.SearchMatch(method_str.LEFT_MATCH),
777
778 # like Python's re.fullmatch(), not sure if we really need it
779 'fullMatch': None,
780 }
781 methods[value_e.Dict] = {
782 'M/erase': method_dict.Erase(),
783
784 # Dict.get()
785 # Dict.keys()
786 # Dict.values()
787 'get': method_dict.Get(),
788 'keys': method_dict.Keys(),
789 'values': method_dict.Values(),
790
791 # I think items() isn't as necessary because dicts are ordered?
792 # YSH code shouldn't use the List of Lists representation.
793
794 # could be d->tally() or d->increment(), but inc() is short
795 #
796 # call d->inc('mycounter')
797 # call d->inc('mycounter', 3)
798 'M/inc': None,
799
800 # call d->accum('mygroup', 'value')
801 'M/accum': None,
802 }
803 methods[value_e.List] = {
804 # TODO: __mut_{reverse,append,extend,pop,insert,remove}
805 'M/reverse': method_list.Reverse(),
806 'M/append': method_list.Append(),
807 'M/extend': method_list.Extend(),
808 'M/pop': method_list.Pop(),
809 'M/insert': None, # insert object before index
810 'M/remove': None, # insert object before index
811 'indexOf': method_list.IndexOf(), # return first index of value, or -1
812 # Python list() has index(), which raises ValueError
813 # But this is consistent with Str->find(), and doesn't
814 # use exceptions
815 'join': func_misc.Join(), # both a method and a func
816 }
817
818 methods[value_e.Match] = {
819 'group': func_eggex.MatchMethod(func_eggex.G, expr_ev),
820 'start': func_eggex.MatchMethod(func_eggex.S, None),
821 'end': func_eggex.MatchMethod(func_eggex.E, None),
822 }
823
824 methods[value_e.Place] = {
825 # __mut_setValue()
826
827 # instead of setplace keyword
828 'M/setValue': method_other.SetValue(mem),
829 }
830
831 methods[value_e.Command] = {
832 # var x = ^(echo hi)
833 # Export source code and line number
834 # Useful for test frameworks and so forth
835 'export': None,
836 }
837
838 #
839 # Initialize Built-in Funcs
840 #
841
842 parse_hay = func_hay.ParseHay(fd_state, parse_ctx, errfmt)
843 eval_hay = func_hay.EvalHay(hay_state, mutable_opts, mem, cmd_ev)
844 hay_func = func_hay.HayFunc(hay_state)
845
846 _SetGlobalFunc(mem, 'parseHay', parse_hay)
847 _SetGlobalFunc(mem, 'evalHay', eval_hay)
848 _SetGlobalFunc(mem, '_hay', hay_func)
849
850 _SetGlobalFunc(mem, 'len', func_misc.Len())
851 _SetGlobalFunc(mem, 'type', func_misc.Type())
852
853 g = func_eggex.MatchFunc(func_eggex.G, expr_ev, mem)
854 _SetGlobalFunc(mem, '_group', g)
855 _SetGlobalFunc(mem, '_match', g) # TODO: remove this backward compat alias
856 _SetGlobalFunc(mem, '_start', func_eggex.MatchFunc(func_eggex.S, None,
857 mem))
858 _SetGlobalFunc(mem, '_end', func_eggex.MatchFunc(func_eggex.E, None, mem))
859
860 _SetGlobalFunc(mem, 'evalExpr', func_misc.EvalExpr(expr_ev))
861
862 _SetGlobalFunc(mem, 'Object', func_misc.Object())
863 _SetGlobalFunc(mem, 'prototype', func_misc.Prototype())
864 _SetGlobalFunc(mem, 'propView', func_misc.PropView())
865
866 # type conversions
867 _SetGlobalFunc(mem, 'bool', func_misc.Bool())
868 _SetGlobalFunc(mem, 'int', func_misc.Int())
869 _SetGlobalFunc(mem, 'float', func_misc.Float())
870 _SetGlobalFunc(mem, 'str', func_misc.Str_())
871 _SetGlobalFunc(mem, 'list', func_misc.List_())
872 _SetGlobalFunc(mem, 'dict', func_misc.DictFunc())
873
874 _SetGlobalFunc(mem, 'runes', func_misc.Runes())
875 _SetGlobalFunc(mem, 'encodeRunes', func_misc.EncodeRunes())
876 _SetGlobalFunc(mem, 'bytes', func_misc.Bytes())
877 _SetGlobalFunc(mem, 'encodeBytes', func_misc.EncodeBytes())
878
879 # Str
880 #_SetGlobalFunc(mem, 'strcmp', None)
881 # TODO: This should be Python style splitting
882 _SetGlobalFunc(mem, 'split', func_misc.Split(splitter))
883 _SetGlobalFunc(mem, 'shSplit', func_misc.Split(splitter))
884
885 # Float
886 _SetGlobalFunc(mem, 'floatsEqual', func_misc.FloatsEqual())
887
888 # List
889 _SetGlobalFunc(mem, 'join', func_misc.Join())
890 _SetGlobalFunc(mem, 'maybe', func_misc.Maybe())
891 _SetGlobalFunc(mem, 'glob', func_misc.Glob(globber))
892
893 _SetGlobalFunc(mem, 'shvarGet', func_misc.Shvar_get(mem))
894 _SetGlobalFunc(mem, 'getVar', func_misc.GetVar(mem))
895
896 # Serialize
897 _SetGlobalFunc(mem, 'toJson8', func_misc.ToJson8(True))
898 _SetGlobalFunc(mem, 'toJson', func_misc.ToJson8(False))
899
900 _SetGlobalFunc(mem, 'fromJson8', func_misc.FromJson8(True))
901 _SetGlobalFunc(mem, 'fromJson', func_misc.FromJson8(False))
902
903 # Demos
904 _SetGlobalFunc(mem, '_a2sp', func_misc.BashArrayToSparse())
905 _SetGlobalFunc(mem, '_opsp', func_misc.SparseOp())
906
907 # TODO: 'io' can be in the builtin module, and then hidden in functions
908 mem.SetNamed(location.LName('io'), io_obj, scope_e.GlobalOnly)
909
910 #mem.SetNamed(location.LName('stdin'), value.Stdin, scope_e.GlobalOnly)
911
912 #
913 # Is the shell interactive?
914 #
915
916 # History evaluation is a no-op if readline is None.
917 hist_ev = history.Evaluator(readline, hist_ctx, debug_f)
918
919 if flag.c is not None:
920 src = source.CFlag # type: source_t
921 line_reader = reader.StringLineReader(flag.c,
922 arena) # type: reader._Reader
923 if flag.i: # -c and -i can be combined
924 mutable_opts.set_interactive()
925
926 elif flag.i: # force interactive
927 src = source.Stdin(' -i')
928 line_reader = reader.InteractiveLineReader(arena, prompt_ev, hist_ev,
929 readline, prompt_state)
930 mutable_opts.set_interactive()
931
932 else:
933 if script_name is None:
934 if flag.headless:
935 src = source.Headless
936 line_reader = None # unused!
937 # Not setting '-i' flag for now. Some people's bashrc may want it?
938 else:
939 stdin_ = mylib.Stdin()
940 # --tool never starts a prompt
941 if len(flag.tool) == 0 and stdin_.isatty():
942 src = source.Interactive
943 line_reader = reader.InteractiveLineReader(
944 arena, prompt_ev, hist_ev, readline, prompt_state)
945 mutable_opts.set_interactive()
946 else:
947 src = source.Stdin('')
948 line_reader = reader.FileLineReader(stdin_, arena)
949 else:
950 src = source.MainFile(script_name)
951 try:
952 f = fd_state.Open(script_name)
953 except (IOError, OSError) as e:
954 print_stderr("%s: Couldn't open %r: %s" %
955 (lang, script_name, posix.strerror(e.errno)))
956 return 1
957 line_reader = reader.FileLineReader(f, arena)
958
959 # Pretend it came from somewhere else
960 if flag.location_str is not None:
961 src = source.Synthetic(flag.location_str)
962 assert line_reader is not None
963 location_start_line = mops.BigTruncate(flag.location_start_line)
964 if location_start_line != -1:
965 line_reader.SetLineOffset(location_start_line)
966
967 arena.PushSource(src)
968
969 # Calculate ~/.config/oils/oshrc or yshrc. Used for both -i and --headless
970 # We avoid cluttering the user's home directory. Some users may want to ln
971 # -s ~/.config/oils/oshrc ~/oshrc or ~/.oshrc.
972
973 # https://unix.stackexchange.com/questions/24347/why-do-some-applications-use-config-appname-for-their-config-data-while-other
974
975 config_dir = '.config/oils'
976 rc_paths = [] # type: List[str]
977 if not flag.norc and (flag.headless or exec_opts.interactive()):
978 # User's rcfile comes FIRST. Later we can add an 'after-rcdir' hook
979 rc_path = flag.rcfile
980 if rc_path is None:
981 rc_paths.append(
982 os_path.join(home_dir, '%s/%src' % (config_dir, lang)))
983 else:
984 rc_paths.append(rc_path)
985
986 # Load all files in ~/.config/oil/oshrc.d or oilrc.d
987 # This way "installers" can avoid mutating oshrc directly
988
989 rc_dir = flag.rcdir
990 if rc_dir is None:
991 rc_dir = os_path.join(home_dir, '%s/%src.d' % (config_dir, lang))
992
993 rc_paths.extend(libc.glob(os_path.join(rc_dir, '*')))
994 else:
995 if flag.rcfile is not None: # bash doesn't have this warning, but it's useful
996 print_stderr('%s warning: --rcfile ignored with --norc' % lang)
997 if flag.rcdir is not None:
998 print_stderr('%s warning: --rcdir ignored with --norc' % lang)
999
1000 # Initialize even in non-interactive shell, for 'compexport'
1001 _InitDefaultCompletions(cmd_ev, complete_builtin, comp_lookup)
1002
1003 if flag.headless:
1004 state.InitInteractive(mem)
1005 mutable_opts.set_redefine_proc_func()
1006 mutable_opts.set_redefine_module()
1007
1008 # NOTE: rc files loaded AFTER _InitDefaultCompletions.
1009 for rc_path in rc_paths:
1010 with state.ctx_ThisDir(mem, rc_path):
1011 try:
1012 SourceStartupFile(fd_state, rc_path, lang, parse_ctx,
1013 cmd_ev, errfmt)
1014 except util.UserExit as e:
1015 return e.status
1016
1017 loop = main_loop.Headless(cmd_ev, parse_ctx, errfmt)
1018 try:
1019 # TODO: What other exceptions happen here?
1020 status = loop.Loop()
1021 except util.UserExit as e:
1022 status = e.status
1023
1024 # Same logic as interactive shell
1025 mut_status = IntParamBox(status)
1026 cmd_ev.RunTrapsOnExit(mut_status)
1027 status = mut_status.i
1028
1029 return status
1030
1031 # Note: headless mode above doesn't use c_parser
1032 assert line_reader is not None
1033 c_parser = parse_ctx.MakeOshParser(line_reader)
1034
1035 if exec_opts.interactive():
1036 state.InitInteractive(mem)
1037 # bash: 'set -o emacs' is the default only in the interactive shell
1038 mutable_opts.set_emacs()
1039 mutable_opts.set_redefine_proc_func()
1040 mutable_opts.set_redefine_module()
1041
1042 if readline:
1043 term_width = 0
1044 if flag.completion_display == 'nice':
1045 try:
1046 term_width = libc.get_terminal_width()
1047 except (IOError, OSError): # stdin not a terminal
1048 pass
1049
1050 if term_width != 0:
1051 display = comp_ui.NiceDisplay(
1052 term_width, comp_ui_state, prompt_state, debug_f, readline,
1053 signal_safe) # type: comp_ui._IDisplay
1054 else:
1055 display = comp_ui.MinimalDisplay(comp_ui_state, prompt_state,
1056 debug_f)
1057
1058 comp_ui.InitReadline(readline, sh_files.HistoryFile(), root_comp,
1059 display, debug_f)
1060
1061 _InitDefaultCompletions(cmd_ev, complete_builtin, comp_lookup)
1062 if flag.completion_demo:
1063 _CompletionDemo(comp_lookup)
1064
1065 else: # Without readline module
1066 display = comp_ui.MinimalDisplay(comp_ui_state, prompt_state,
1067 debug_f)
1068
1069 process.InitInteractiveShell(signal_safe) # Set signal handlers
1070
1071 # The interactive shell leads a process group which controls the terminal.
1072 # It MUST give up the terminal afterward, otherwise we get SIGTTIN /
1073 # SIGTTOU bugs.
1074 with process.ctx_TerminalControl(job_control, errfmt):
1075
1076 # NOTE: rc files loaded AFTER _InitDefaultCompletions.
1077 for rc_path in rc_paths:
1078 with state.ctx_ThisDir(mem, rc_path):
1079 try:
1080 SourceStartupFile(fd_state, rc_path, lang, parse_ctx,
1081 cmd_ev, errfmt)
1082 except util.UserExit as e:
1083 return e.status
1084
1085 assert line_reader is not None
1086 line_reader.Reset() # After sourcing startup file, render $PS1
1087
1088 prompt_plugin = prompt.UserPlugin(mem, parse_ctx, cmd_ev, errfmt)
1089 try:
1090 status = main_loop.Interactive(flag, cmd_ev, c_parser, display,
1091 prompt_plugin, waiter, errfmt)
1092 except util.UserExit as e:
1093 status = e.status
1094
1095 mut_status = IntParamBox(status)
1096 cmd_ev.RunTrapsOnExit(mut_status)
1097 status = mut_status.i
1098
1099 if readline:
1100 hist_file = sh_files.HistoryFile()
1101 if hist_file is not None:
1102 try:
1103 readline.write_history_file(hist_file)
1104 except (IOError, OSError):
1105 pass
1106
1107 return status
1108
1109 if flag.rcfile is not None: # bash doesn't have this warning, but it's useful
1110 print_stderr('%s warning: --rcfile ignored in non-interactive shell' %
1111 lang)
1112 if flag.rcdir is not None:
1113 print_stderr('%s warning: --rcdir ignored in non-interactive shell' %
1114 lang)
1115
1116 #
1117 # Tools that use the OSH/YSH parsing mode, etc.
1118 #
1119
1120 # flag.tool is '' if nothing is passed
1121 # osh --tool syntax-tree is equivalent to osh -n --one-pass-parse
1122 tool_name = 'syntax-tree' if exec_opts.noexec() else flag.tool
1123
1124 if len(tool_name):
1125 # Don't save tokens becaues it's slow
1126 if tool_name != 'syntax-tree':
1127 arena.SaveTokens()
1128
1129 try:
1130 node = main_loop.ParseWholeFile(c_parser)
1131 except error.Parse as e:
1132 errfmt.PrettyPrintError(e)
1133 return 2
1134
1135 if tool_name == 'syntax-tree':
1136 ui.PrintAst(node, flag)
1137
1138 elif tool_name == 'tokens':
1139 ysh_ify.PrintTokens(arena)
1140
1141 elif tool_name == 'lossless-cat': # for test/lossless.sh
1142 ysh_ify.LosslessCat(arena)
1143
1144 elif tool_name == 'fmt':
1145 fmt.Format(arena, node)
1146
1147 elif tool_name == 'test':
1148 raise AssertionError('TODO')
1149
1150 elif tool_name == 'ysh-ify':
1151 ysh_ify.Ysh_ify(arena, node)
1152
1153 elif tool_name == 'deps':
1154 if mylib.PYTHON:
1155 deps.Deps(node)
1156
1157 else:
1158 raise AssertionError(tool_name) # flag parser validated it
1159
1160 return 0
1161
1162 #
1163 # Run a shell script
1164 #
1165
1166 with state.ctx_ThisDir(mem, script_name):
1167 try:
1168 status = main_loop.Batch(cmd_ev,
1169 c_parser,
1170 errfmt,
1171 cmd_flags=cmd_eval.IsMainProgram)
1172 except util.UserExit as e:
1173 status = e.status
1174 except KeyboardInterrupt:
1175 # The interactive shell handles this in main_loop.Interactive
1176 status = 130 # 128 + 2
1177 mut_status = IntParamBox(status)
1178 cmd_ev.RunTrapsOnExit(mut_status)
1179
1180 multi_trace.WriteDumps()
1181
1182 # NOTE: We haven't closed the file opened with fd_state.Open
1183 return mut_status.i