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

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