Morsmall.ASTShell AST.
Names in Shell are just strings with a few additional conditions.
The type word is a description of words in Shell. See POSIX, 2 Shell & Utilities, 2.3 Token Recognition
and attribute = | NoAttribute| ParameterLength| UseDefaultValues of word * bool| AssignDefaultValues of word * bool| IndicateErrorifNullorUnset of word * bool| UseAlternativeValue of word * bool| RemoveSmallestSuffixPattern of word| RemoveLargestSuffixPattern of word| RemoveSmallestPrefixPattern of word| RemoveLargestPrefixPattern of wordand word = word_component listand word' = word Location.locatedFor now, a pattern is just a word.
and pattern = word listand pattern' = pattern Location.locatedAn assignment is just a pair of a name and a word.
and assignment' = assignment Location.locatedA file descriptor descr is an integer.
The following description does contain all the semantic subtleties of POSIX Shell. Such a description can be found in the document IEEE Std 1003.1™-2008, 2016 Edition. In the following, we will refer to it simple as POSIX.
The type command contains the definition of a Shell command in Morsmall. Compared to what can be found in the POSIX standard or in Morbig, this type is rather small. This is because a lot of syntactically distinct scripts that are semantically equivalent are identified in here. For instance, all the following scripts are equivalent and identified as such:
if t1; then c1; elif t2; then c2; fi
if { t1; }; then c1; elif { { t2; }; }; fi
if t1; then c1; else if t2; then c2; fi; fiSee POSIX, 2 Shell & Utilities, 2.9.1 Simple Command
See POSIX, 2 Shell & Utilities, 2.9.2 Pipelines and 2.9.3 Lists
Async c, the Shell shall execute c asynchronously in a subshell. This means that the shell shall not wait for the command to finish before executing the next command.c1 and c2 in Seq (c1, c2) shall be executed sequentially.And (c1, c2), c1 shall be executed first. If its exit status is zero, c2 shall be executed. The commands are expanded only if they are executed.Or (c1, c2), c1 shall be executed first. If its exit status is non-zero, c2 shall be executed.Pipe (c1, c2), the standard output of c1 shall be connected to the standard input of c2. The standard input, standard output, or both of a command shall be considered to be assigned by the pipeline before any redirection specified by redirection operators that are part of the command.Not c has the same behaviour as c, except for the exit status that shall be the logical NOT of the exit status of c.See POSIX, 2 Shell & Utilities, 2.9.4 Compound Commands
Subshell c shall execute c a subshell environment. Variable assignments and built-in commands that affect the environment shall not remain in effect after the list finishes.For (x, l, c) shall execute a sequence of commands c for each member in a list of items. It is to be noted that l is non-mandatory and is thus an option. Besides, there is an important semantic difference between None and Some []. The former appears in a for loop where the list of words appear but is empty. In that case, the for loops through the empty list. The latter appears in a for loop where the list of words has been omitted. In that case, the for loops through the positional parameters.Case (w, [([p11;...],c1); ...]) shall execute the compound-list corresponding to the first one of several patterns that is matched by the string resulting from the expansion of the given word w. In order from the beginning to the end of the case statement, each pattern p* shall be subjected to expansion, and the result of these expansions shall be compared against the expansion of w. After the first match, no more patterns shall be expanded, and the corresponding c* shall be executed. The order of expansion and comparison of multiple patterns that label the same statement is unspecified.If (c1, c2, c3) shall execute c1 and use its exit status to determine whether to execute c2 or c3. In fact, c3 is not mandatory and is thus an option.While (c1, c2) shall continuously execute c2 as long as c1 has a zero exit status.Until (c1, c2) shall continuously execute c2 as long as c1 has a non-zero exit status.See POSIX, 2 Shell & Utilities, 2.9.5 Function Definition Command
A function is a user-defined name that is used as a simple command to call a compound command with new positional parameters. A function is defined with a function definition command, Function (name, body).
This function definition command defines a function named name: string and with body body: command. The body shall be executed whenever name is specified as the name of a simple command.
See POSIX, 2 Shell & Utilities, 2.7 Redirections
The type command describes a command in the AST. All the command semantics are described at the top of this document.
and program = command' listand command = | Simple of assignment' list * word' list| Async of command'| Seq of command' * command'| And of command' * command'| Or of command' * command'| Not of command'| Pipe of command' * command'| Subshell of command'| For of name * word' list option * command'| Case of word' * case_item' list| If of command' * command' * command' option| While of command' * command'| Until of command' * command'| Function of name * command'| Redirection of command' * descr * kind * word'| HereDocument of command' * descr * word'and command' = command Location.locatedand case_item' = case_item Location.locatedinclude sig ... endclass virtual +'a iter : object ... endinclude sig ... endclass virtual +'a map : object ... endinclude sig ... endclass virtual +'a reduce : object ... endinclude sig ... endclass virtual +'a mapreduce : object ... endinclude sig ... endclass virtual +'a iter2 : object ... endinclude sig ... endclass virtual +'a map2 : object ... endinclude sig ... endclass virtual +'a reduce2 : object ... endval equal_character_range :
character_range ->
character_range ->
Ppx_deriving_runtime.boolval equal_word_component :
word_component ->
word_component ->
Ppx_deriving_runtime.boolval equal_assignment : assignment -> assignment -> Ppx_deriving_runtime.boolval equal_assignment' : assignment' -> assignment' -> Ppx_deriving_runtime.boolval equal_case_item' : case_item' -> case_item' -> Ppx_deriving_runtime.boolval pp_name :
Ppx_deriving_runtime.Format.formatter ->
name ->
Ppx_deriving_runtime.unitval show_name : name -> Ppx_deriving_runtime.stringval pp_character_range :
Ppx_deriving_runtime.Format.formatter ->
character_range ->
Ppx_deriving_runtime.unitval show_character_range : character_range -> Ppx_deriving_runtime.stringval pp_attribute :
Ppx_deriving_runtime.Format.formatter ->
attribute ->
Ppx_deriving_runtime.unitval show_attribute : attribute -> Ppx_deriving_runtime.stringval pp_word_component :
Ppx_deriving_runtime.Format.formatter ->
word_component ->
Ppx_deriving_runtime.unitval show_word_component : word_component -> Ppx_deriving_runtime.stringval pp_word :
Ppx_deriving_runtime.Format.formatter ->
word ->
Ppx_deriving_runtime.unitval show_word : word -> Ppx_deriving_runtime.stringval pp_word' :
Ppx_deriving_runtime.Format.formatter ->
word' ->
Ppx_deriving_runtime.unitval show_word' : word' -> Ppx_deriving_runtime.stringval pp_pattern :
Ppx_deriving_runtime.Format.formatter ->
pattern ->
Ppx_deriving_runtime.unitval show_pattern : pattern -> Ppx_deriving_runtime.stringval pp_pattern' :
Ppx_deriving_runtime.Format.formatter ->
pattern' ->
Ppx_deriving_runtime.unitval show_pattern' : pattern' -> Ppx_deriving_runtime.stringval pp_assignment :
Ppx_deriving_runtime.Format.formatter ->
assignment ->
Ppx_deriving_runtime.unitval show_assignment : assignment -> Ppx_deriving_runtime.stringval pp_assignment' :
Ppx_deriving_runtime.Format.formatter ->
assignment' ->
Ppx_deriving_runtime.unitval show_assignment' : assignment' -> Ppx_deriving_runtime.stringval pp_descr :
Ppx_deriving_runtime.Format.formatter ->
descr ->
Ppx_deriving_runtime.unitval show_descr : descr -> Ppx_deriving_runtime.stringval pp_program :
Ppx_deriving_runtime.Format.formatter ->
program ->
Ppx_deriving_runtime.unitval show_program : program -> Ppx_deriving_runtime.stringval pp_command :
Ppx_deriving_runtime.Format.formatter ->
command ->
Ppx_deriving_runtime.unitval show_command : command -> Ppx_deriving_runtime.stringval pp_command' :
Ppx_deriving_runtime.Format.formatter ->
command' ->
Ppx_deriving_runtime.unitval show_command' : command' -> Ppx_deriving_runtime.stringval pp_case_item :
Ppx_deriving_runtime.Format.formatter ->
case_item ->
Ppx_deriving_runtime.unitval show_case_item : case_item -> Ppx_deriving_runtime.stringval pp_case_item' :
Ppx_deriving_runtime.Format.formatter ->
case_item' ->
Ppx_deriving_runtime.unitval show_case_item' : case_item' -> Ppx_deriving_runtime.stringval pp_kind :
Ppx_deriving_runtime.Format.formatter ->
kind ->
Ppx_deriving_runtime.unitval show_kind : kind -> Ppx_deriving_runtime.stringval name_to_yojson : name -> Yojson.Safe.tval name_of_yojson : Yojson.Safe.t -> name Ppx_deriving_yojson_runtime.error_orval character_range_to_yojson : character_range -> Yojson.Safe.tval character_range_of_yojson :
Yojson.Safe.t ->
character_range Ppx_deriving_yojson_runtime.error_orval attribute_to_yojson : attribute -> Yojson.Safe.tval attribute_of_yojson :
Yojson.Safe.t ->
attribute Ppx_deriving_yojson_runtime.error_orval word_component_to_yojson : word_component -> Yojson.Safe.tval word_component_of_yojson :
Yojson.Safe.t ->
word_component Ppx_deriving_yojson_runtime.error_orval word_to_yojson : word -> Yojson.Safe.tval word_of_yojson : Yojson.Safe.t -> word Ppx_deriving_yojson_runtime.error_orval word'_to_yojson : word' -> Yojson.Safe.tval word'_of_yojson :
Yojson.Safe.t ->
word' Ppx_deriving_yojson_runtime.error_orval pattern_to_yojson : pattern -> Yojson.Safe.tval pattern_of_yojson :
Yojson.Safe.t ->
pattern Ppx_deriving_yojson_runtime.error_orval pattern'_to_yojson : pattern' -> Yojson.Safe.tval pattern'_of_yojson :
Yojson.Safe.t ->
pattern' Ppx_deriving_yojson_runtime.error_orval assignment_to_yojson : assignment -> Yojson.Safe.tval assignment_of_yojson :
Yojson.Safe.t ->
assignment Ppx_deriving_yojson_runtime.error_orval assignment'_to_yojson : assignment' -> Yojson.Safe.tval assignment'_of_yojson :
Yojson.Safe.t ->
assignment' Ppx_deriving_yojson_runtime.error_orval descr_to_yojson : descr -> Yojson.Safe.tval descr_of_yojson :
Yojson.Safe.t ->
descr Ppx_deriving_yojson_runtime.error_orval program_to_yojson : program -> Yojson.Safe.tval program_of_yojson :
Yojson.Safe.t ->
program Ppx_deriving_yojson_runtime.error_orval command_to_yojson : command -> Yojson.Safe.tval command_of_yojson :
Yojson.Safe.t ->
command Ppx_deriving_yojson_runtime.error_orval command'_to_yojson : command' -> Yojson.Safe.tval command'_of_yojson :
Yojson.Safe.t ->
command' Ppx_deriving_yojson_runtime.error_orval case_item_to_yojson : case_item -> Yojson.Safe.tval case_item_of_yojson :
Yojson.Safe.t ->
case_item Ppx_deriving_yojson_runtime.error_orval case_item'_to_yojson : case_item' -> Yojson.Safe.tval case_item'_of_yojson :
Yojson.Safe.t ->
case_item' Ppx_deriving_yojson_runtime.error_orval kind_to_yojson : kind -> Yojson.Safe.tval kind_of_yojson : Yojson.Safe.t -> kind Ppx_deriving_yojson_runtime.error_orval name_of_yojson_exn : Yojson.Safe.t -> nameval character_range_of_yojson_exn : Yojson.Safe.t -> character_rangeval attribute_of_yojson_exn : Yojson.Safe.t -> attributeval word_component_of_yojson_exn : Yojson.Safe.t -> word_componentval word_of_yojson_exn : Yojson.Safe.t -> wordval word'_of_yojson_exn : Yojson.Safe.t -> word'val pattern_of_yojson_exn : Yojson.Safe.t -> patternval pattern'_of_yojson_exn : Yojson.Safe.t -> pattern'val assignment_of_yojson_exn : Yojson.Safe.t -> assignmentval assignment'_of_yojson_exn : Yojson.Safe.t -> assignment'val descr_of_yojson_exn : Yojson.Safe.t -> descrval program_of_yojson_exn : Yojson.Safe.t -> programval command_of_yojson_exn : Yojson.Safe.t -> commandval command'_of_yojson_exn : Yojson.Safe.t -> command'val case_item_of_yojson_exn : Yojson.Safe.t -> case_itemval case_item'_of_yojson_exn : Yojson.Safe.t -> case_item'val kind_of_yojson_exn : Yojson.Safe.t -> kindval _ : Yojson.Safe.t -> kindval default_redirection_descriptor : kind -> int