Mirrors/miller
1
0
Fork 0
mirror of https://github.com/johnkerl/miller.git synced 2026-01-23 02:14:13 +00:00
Code Issues Projects Releases Wiki Activity
miller/internal/pkg/parsing/mlr.bnf

2419 lines
65 KiB
BNF
Raw Permalink Blame History

// ================================================================
// If you edit this file, please run tools/build-dsl to autogenerate
// Go code from it, using the GOCC tool.
// ================================================================
// ================================================================
// GRAMMAR FOR THE MILLER DOMAIN-SPECIFIC LANGUAGE
//
// This is the Miller DSL's BNF grammar, using the awesome GOCC tool framework
// from https://github.com/goccmack/gocc.
//
// The first section is lexical elements and the second section is syntactical
// elements. These are the analogs of lex and yacc, respectively, using a
// classical C/lex/yacc framework -- although for lex/yacc one would have
// separate .l and .y files, whereas here there is a single .bnf file.
//
// Notes:
//
// * This grammar is used to auto-generate Go code, using bin/gocc.
//
// * Lexical items are either literals inlined within the syntactical section,
// such as "/", or snake-cased named tokens within the lexical section, such
// as field_name.
//
// * Syntactical items are all camel-cased, such as MapLiteral.
//
// * Everything is delivered to the rest of Miller in the form of an abstract
// syntax tree (AST), via <<...>>> code segments within this file's
// syntactical section, to be processed by hand-written Go code. That code,
// in turn, turns the AST into a CST (concrete syntax tree) which is what the
// DSL runtime executes.
//
// * The <<...>> code called by the gocc framework must accept interface{} at
// all parameters, to be generic, but in practice all arguments end up being
// either token.Token (regcognizable here via string-literals or snake-cased
// namees) or *dsl.AstNode (recognizable here via camel-cased names).
//
// * Another pattern worth pointing out is that in the gocc framework,
// return-types from AST methods must be a pair of (interface{}, error),
// whereas arguments going into those same methods are interface{} only.
// Hence a few methods in the Miller AST API which don't return a pair of
// interface{}/error since they are meant for nesting as arguments here
// within this file.
//
// * Please see internal/pkg/dsl/ast*.go for more about what the <<...>>
// code here is calling.
// ================================================================
// ================================================================
// LEXICAL ELEMENTS
// ================================================================
// ----------------------------------------------------------------
// CHARACTER CLASSES
// ----------------------------------------------------------------
_letter : 'a'-'z' | 'A'-'Z' | '\u00a0'-'\u00ff' | '\u0100'-'\U0010ffff';
_decdig : '0'-'9' ;
_hexdig : '0'-'9' | 'a'-'f' | 'A'-'F';
_octdig : '0'-'7' ;
_bindig : '0'-'1' ;
_leading_idchar : _letter | '_' ;
_idchar : _letter | _decdig | '_' ;
!whitespace : ' ' | '\t' | '\n' | '\r' ;
!comment : '#' {.} '\n' ;
// ----------------------------------------------------------------
// STRING/INT/FLOAT/BOOLEAN LITERALS
// ----------------------------------------------------------------
// Notes on string literals:
// * " isn't included here -- need \" handling to put that inside strings
// * GOCC seems to lack a '[^"] notation ...
// * \[ \] \n etc special cases are a bit tedious to keystroke out ...
// these are most important for put/filter print/emit/tee/etc with "|"
// to arbitrary shell commands. E.g. in
//
// mlr put 'print | "tr \[a-z\] \[A-Z\]", $something'
//
// the shell command is the 'tr ...' string and we need to spell out the
// escape sequence used by tr.
// * See https://github.com/google/re2/wiki/Syntax
_string_literal_element
: 'A'-'Z' | 'a'-'z' | '0'-'9'
| '\n'
| ' ' | '!' | '#' | '$' | '%' | '&' | '\'' | '\\'
| '(' | ')' | '*' | '+' | ',' | '-' | '.' | '/'
| ':' | ';' | '<' | '=' | '>' | '?' | '@' | '['
| ']' | '^' | '_' | '`' | '{' | '|' | '}' | '~'
| ( '\\' '\\' ) | ( '\\' '"' ) | ( '\\' '[' ) | ( '\\' ']' )
| ( '\\' '.' ) | ( '\\' '*' ) | ( '\\' '%' )
| ( '\\' 'A') | ( '\\' 'B') | ( '\\' 'C') | ( '\\' 'D') | ( '\\' 'G') | ( '\\' 'H')
| ( '\\' 'K') | ( '\\' 'L') | ( '\\' 'N') | ( '\\' 'P') | ( '\\' 'R') | ( '\\' 'S')
| ( '\\' 'U') | ( '\\' 'V') | ( '\\' 'W') | ( '\\' 'X') | ( '\\' 'Z')
| ( '\\' 'a') | ( '\\' 'b') | ( '\\' 'c') | ( '\\' 'd') | ( '\\' 'f') | ( '\\' 'g')
| ( '\\' 'h') | ( '\\' 'k') | ( '\\' 'l') | ( '\\' 'n') | ( '\\' 'p') | ( '\\' 'r')
| ( '\\' 's') | ( '\\' 't') | ( '\\' 'u') | ( '\\' 'v') | ( '\\' 'w') | ( '\\' 'x')
| ( '\\' 'z')
| ( '\\' '0' ) | ( '\\' '1' ) | ( '\\' '2' ) | ( '\\' '3' ) | ( '\\' '4' )
| ( '\\' '5' ) | ( '\\' '6' ) | ( '\\' '7' ) | ( '\\' '8' ) | ( '\\' '9' )
| '\u00a0'-'\u00ff'
| '\u0100'-'\U0010ffff'
;
string_literal : '"' {_string_literal_element} '"' ;
// Miller regexes are of the form "a.*b" for case-sensitive, or "a.*b"i for case-insensitive.
regex_case_insensitive : '"' {_string_literal_element} '"' 'i';
// Notes on int literals:
// * Leading minus sign is handled via the unary-minus operator, not here.
int_literal
: _decdig { _decdig }
| '0' 'x' _hexdig { _hexdig }
| '0' 'o' _octdig { _octdig }
| '0' 'b' _bindig { _bindig }
;
// Notes on float literals:
// * Leading minus sign is handled via the unary-minus operator, not here.
// * The various shapes are for scientific notation. Examples:
// 123
// 123.
// 123.4
// .234
// 1e2
// 1e-2
// 1.2e3 1.e3
// 1.2e-3 1.e-3
// .2e3
// .2e-3 1.e-3
_scinotE : 'e' | 'E' ;
float_literal
: { _decdig} '.' { _decdig }
| _decdig { _decdig} '.' { _decdig }
| _decdig { _decdig} _scinotE _decdig { _decdig}
| _decdig { _decdig} _scinotE '-' _decdig { _decdig}
| _decdig { _decdig} _scinotE '+' _decdig { _decdig}
| _decdig { _decdig} '.' { _decdig} _scinotE _decdig { _decdig}
| _decdig { _decdig} '.' { _decdig} _scinotE '-' _decdig { _decdig}
| _decdig { _decdig} '.' { _decdig} _scinotE '+' _decdig { _decdig}
| { _decdig} '.' _decdig { _decdig} _scinotE _decdig { _decdig}
| { _decdig} '.' _decdig { _decdig} _scinotE '-' _decdig { _decdig}
| { _decdig} '.' _decdig { _decdig} _scinotE '+' _decdig { _decdig}
;
const_M_PI : 'M' '_' 'P' 'I' ;
const_M_E : 'M' '_' 'E' ;
// Notes on boolean literals:
// * true and false should be defined here rather than as "true" / "false"
// within the grammar below -- this forces them to be keywords, not legal as
// variable names. We want them as keywords -- we don't want to allow things
// like 'true = 3'.
_literal_true : 't' 'r' 'u' 'e' ;
_literal_false : 'f' 'a' 'l' 's' 'e';
boolean_literal : ( _literal_true | _literal_false );
null_literal : 'n' 'u' 'l' 'l';
inf_literal : 'I' 'n' 'f';
nan_literal : 'N' 'a' 'N';
// ----------------------------------------------------------------
// MILLER CONTEXT VARIABLES
// ----------------------------------------------------------------
// I want to call these simply "IPS" et al. but GOCC is has leading-case (and
// leading-underscore) semantics for token names.
ctx_IPS : 'I' 'P' 'S' ;
ctx_IFS : 'I' 'F' 'S' ;
ctx_IRS : 'I' 'R' 'S' ;
ctx_OPS : 'O' 'P' 'S' ;
ctx_OFS : 'O' 'F' 'S' ;
ctx_ORS : 'O' 'R' 'S' ;
ctx_FLATSEP : 'F' 'L' 'A' 'T' 'S' 'E' 'P';
ctx_NF : 'N' 'F' ;
ctx_NR : 'N' 'R' ;
ctx_FNR : 'F' 'N' 'R' ;
ctx_FILENAME : 'F' 'I' 'L' 'E' 'N' 'A' 'M' 'E' ;
ctx_FILENUM : 'F' 'I' 'L' 'E' 'N' 'U' 'M' ;
env : 'E' 'N' 'V' ;
// ----------------------------------------------------------------
// MILLER KEYWORDS
// ----------------------------------------------------------------
// Notes on keywords:
// * Any new keywords defined here should also be documented
// in dsl/mlr_dsl_cst.c's mlr_dsl_keyword_usage() et al.
// * true and false (boolean literals) are also keywords, defined above.
begin : 'b' 'e' 'g' 'i' 'n' ;
do : 'd' 'o' ;
elif : 'e' 'l' 'i' 'f' ;
else : 'e' 'l' 's' 'e' ;
end : 'e' 'n' 'd' ;
filter : 'f' 'i' 'l' 't' 'e' 'r' ;
for : 'f' 'o' 'r' ;
if : 'i' 'f' ;
in : 'i' 'n' ;
while : 'w' 'h' 'i' 'l' 'e' ;
break : 'b' 'r' 'e' 'a' 'k' ;
continue : 'c' 'o' 'n' 't' 'i' 'n' 'u' 'e' ;
return : 'r' 'e' 't' 'u' 'r' 'n' ;
func : 'f' 'u' 'n' 'c' ;
subr : 's' 'u' 'b' 'r' ;
call : 'c' 'a' 'l' 'l' ;
arr : 'a' 'r' 'r' ;
bool : 'b' 'o' 'o' 'l' ;
float : 'f' 'l' 'o' 'a' 't' ;
int : 'i' 'n' 't' ;
map : 'm' 'a' 'p' ;
num : 'n' 'u' 'm' ;
str : 's' 't' 'r' ;
var : 'v' 'a' 'r' ;
funct : 'f' 'u' 'n' 'c' 't';
unset : 'u' 'n' 's' 'e' 't' ;
dump : 'd' 'u' 'm' 'p' ;
edump : 'e' 'd' 'u' 'm' 'p' ;
emit1 : 'e' 'm' 'i' 't' '1' ;
emit : 'e' 'm' 'i' 't' ;
emitp : 'e' 'm' 'i' 't' 'p' ;
emitf : 'e' 'm' 'i' 't' 'f' ;
eprint : 'e' 'p' 'r' 'i' 'n' 't' ;
eprintn : 'e' 'p' 'r' 'i' 'n' 't' 'n' ;
print : 'p' 'r' 'i' 'n' 't' ;
printn : 'p' 'r' 'i' 'n' 't' 'n' ;
tee : 't' 'e' 'e' ;
stdout : 's' 't' 'd' 'o' 'u' 't' ;
stderr : 's' 't' 'd' 'e' 'r' 'r' ;
// ----------------------------------------------------------------
// FIELD NAMES, OUT-OF-STREAM VARIABLES, LOCAL VARIABLES
// ----------------------------------------------------------------
// Note: the parser depends on the dollar sign being here. If this is changed,
// that needs to be changed as well.
//
// Also note: if we omit the '$' here and include it in the parser section
// below as "$", then we get an LR-1 conflict. So this must be dealt with at
// the AST level.
//
// Also note $1 is a valid field name but @1 is not a valid oosvar name; hence
// _leading_idchar vs _idchar.
field_name : '$' _idchar { _idchar } ;
// This is for literal strings but where the field name might have spaces in it
// or somesuch.
_braced_char
: 'A'-'Z' | 'a'-'z' | '0'-'9'
| ' ' | '!' | '#' | '$' | '%' | '&' | '\'' | '\\'
| '(' | ')' | '*' | '+' | ',' | '-' | '.' | '/'
| ':' | ';' | '<' | '=' | '>' | '?' | '@' | '['
| ']' | '^' | '_' | '`' | '|' | '~'
| ( '\\' '{' ) | ( '\\' '}' )
| '\u0100'-'\U0010FFFF'
;
braced_field_name: '$' '{' _braced_char { _braced_char } '}' ;
full_srec : '$' '*' ;
oosvar_name : '@' _leading_idchar { _idchar } ;
// This is for literal strings but where the oosvar name might have spaces in it
// or somesuch.
braced_oosvar_name: '@' '{' _braced_char { _braced_char } '}' ;
full_oosvar : '@' '*' ;
all : 'a' 'l' 'l' ;
// ----------------------------------------------------------------
// FUNCTIONS AND LOCAL VARIABLES
non_sigil_name : _leading_idchar { _idchar } ;
// ----------------------------------------------------------------
// PANIC TOKEN
// ----------------------------------------------------------------
// This is for testing short-circuiting of "&&", "||", etc in the CST. The
// sole job of the CST evaluator for this token is to panic the process -- so
// we'll know if we're evaluating something we should not.
panic : '%' '%' '%' 'p' 'a' 'n' 'i' 'c' '%' '%' '%' ;
// ================================================================
// SYNTAX ELEMENTS
// ================================================================
// ================================================================
// Parsing goes through three formats:
//
// (1) Source code which is a string of characters.
//
// (2) Abstract syntax tree (AST):
//
// * Parentheses, commas, semicolons, line endings, whitespace are all stripped away
// * Variable names and literal values remain as leaf nodes of the AST
// * = + - * / ** {function names} remain as non-leaf nodes of the AST
//
// (3) Concrete syntax tree (CST): a reshaping of the AST with pre-processed
// setup of function pointers to handle each type of statement on a
// per-record basis. The if/else and/or switch statements to decide what to
// do with each AST node are done at CST-build time, so they don't need to
// be re-done when the syntax tree is executed once on every data record.
//
// The job of this parser is to turn (1) into (2).
//
// Note: This parser accepts many things that are invalid, e.g.
// * begin{end{}} -- begin/end not at top level
// * begin{$x=1} -- references to stream records at begin/end (there is no $x when
// there is no input record yet)
// * break/continue outside of for/while/do-while
// * return outside of a function definition
// * $x=x -- boundvars outside of for-loop variable bindings
//
// All of the above are enforced by the CST builder's semantic-analysis logic,
// which takes this parser's output AST as input. This is done (a) to keep
// this grammar from being overly complex, and (b) so we can get more
// informative error messages.
//
// For clearer visuals on what the ASTs look like, you can do
//
// mlr -n put -v 'your expression goes here'
//
// Also see reg_test/run's filter -v and put -v outputs, e.g. in
// reg_test/expected/out.
// ================================================================
// Import the AST/ASTNode types and functions
<< import "github.com/johnkerl/miller/internal/pkg/dsl" >>
// ================================================================
// TOP-LEVEL PRODUCTION RULE FOR THE MILLER DSL
// ----------------------------------------------------------------
Root
: StatementBlock
<< dsl.NewAST($0) >>
;
// ----------------------------------------------------------------
// A StatementBlock is a sequence of statements: either the stuff in between
// (but not including) the curly braces in things like 'if (NR > 2) { $x = 1;
// $y = 2 }', or, top-level Miller DSL statements like '$x = 1; $y = 2'.
StatementBlock
// Empty statement. This allows for 'mlr put ""', as well as repeated semicolons.
: empty
<< dsl.NewASTNodeZary(nil, dsl.NodeTypeStatementBlock) >>
| NonEmptyStatementBlock
<< dsl.Wrap($0) >>
;
// ----------------------------------------------------------------
// NonEmptyStatementBlock is split out from StatementBlock to avoid LR-1
// conflicts in parsing things like 'begin {...} x=1; y=2; end{...}' wherein we
// want to avoid forcing people to type a semicolon after the first closing
// brace.
NonEmptyStatementBlock
// ---------------------- Terminal rules
// Things not ending in a curly brace, like assignments -- and also do-while.
: BracelessStatement
<< dsl.NewASTNodeUnary(nil, $0, dsl.NodeTypeStatementBlock) >>
// Things ending in a curly brace, like for/do/while, begin/end, and pattern-acction blocks
| BracefulStatement
<< dsl.NewASTNodeUnary(nil, $0, dsl.NodeTypeStatementBlock) >>
// ---------------------- Recursive rules
// So statements can start with a semicolon
| ";" StatementBlock
<< dsl.Wrap($1) >>
// Normal case for sequential statements like '$x=1; $y=2'
| BracelessStatement ";" StatementBlock
<<dsl.PrependChild($2, $0) >>
// For 'begin {...} ; $x=1'
| BracefulStatement ";" StatementBlock
<<dsl.PrependChild($2, $0) >>
// These are for things like 'begin {...} begin {...} ...' -- where people
// shouldn't have to put semicolons after the closing curly braces.
//
// We get LR-1 conflicts with the following, so we need a pair of more
// explicit lookahead-by-more production rules instead. (By using two
// Statement rules and a (recursive) StatementBlock rule, with
// PrependTwoChildren, we are effectively getting lookahead-by-two.)
//
// | BracefulStatement StatementBlock
// <<dsl.PrependChild($1, $0) >>
// E.g. 'begin {...} begin {...} $x=1'
| BracefulStatement BracefulStatement StatementBlock
<<dsl.PrependTwoChildren($2, $0, $1) >>
// E.g. 'begin {...} $x=1'
| BracefulStatement BracelessStatement
<< dsl.NewASTNodeBinary(nil, $0, $1, dsl.NodeTypeStatementBlock) >>
// E.g. 'begin {...} $x=1 ;'
| BracefulStatement BracelessStatement ";"
<< dsl.NewASTNodeBinary(nil, $0, $1, dsl.NodeTypeStatementBlock) >>
| BracefulStatement BracelessStatement ";" NonEmptyStatementBlock
<<dsl.PrependTwoChildren($3, $0, $1) >>
;
// ----------------------------------------------------------------
// Simply a keystroke-saver for all the various if/for/do/while/begin/end/etc
// which use curly-braced bodies.
StatementBlockInBraces
: "{" StatementBlock "}"
<< dsl.Wrap($1) >>
;
// ================================================================
// ASSIGNMENT STATEMENTS
BracelessStatement
: Assignment
| Unset
| BareBoolean
| FilterStatement
| PrintStatement
| PrintnStatement
| EprintStatement
| EprintnStatement
| DumpStatement
| EdumpStatement
| TeeStatement
| Emit1Statement
| EmitStatement
| EmitPStatement
| EmitFStatement
// Has braces but does not *end* in braces -- so it requires semicolon after.
| DoWhileLoop
| BreakStatement
| ContinueStatement
| ReturnStatement
| SubroutineCallsite
;
Assignment
: Lvalue "=" Rvalue
<< dsl.NewASTNodeBinary($1, $0, $2, dsl.NodeTypeAssignment) >>
;
Unset
: unset FcnArgs
<<
dsl.AdoptChildren(
dsl.NewASTNodeNestable(
$0,
dsl.NodeTypeUnset,
),
$1,
)
>>
;
// Semantically there are far fewer things which are valid lvalues than valid
// rvalues. For example, in '1+2=3+4', the right-hand side is fine while the
// left-hand side is not.
//
// We can limit the things expressible on the left-hand side here in the AST,
// via Lvalue production rules much narrower than Rvalue production rules.
// However, this results in LR-1 conflicts for bare-boolean and pattern-action
// blocks which start with something of rvalue form -- the parser needs more
// than one lookahead symbol to realize what's going on.
//
// Instead, we use the same production rule for lvalues and rvalues here in the
// grammar, deferring lvalue restrictions to the CST builder where we have more
// flexibility. As an added bonuys, we get more expressive ability in our error
// messages.
Lvalue
: Rvalue
| Typedecl LocalVariable
<< dsl.AppendChild($1, $0) >>
;
BareBoolean
: Rvalue
<< dsl.NewASTNodeUnary(nil, $0, dsl.NodeTypeBareBoolean) >>
;
FilterStatement
: filter Rvalue
<< dsl.NewASTNodeUnary($0, $1, dsl.NodeTypeFilterStatement) >>
;
// ----------------------------------------------------------------
// For dump, emit, tee, print
Redirector
: ">" RedirectTarget
<< dsl.NewASTNodeUnary($0, $1, dsl.NodeTypeRedirectWrite) >>
| ">>" RedirectTarget
<< dsl.NewASTNodeUnary($0, $1, dsl.NodeTypeRedirectAppend) >>
| "|" RedirectTarget
<< dsl.NewASTNodeUnary($0, $1, dsl.NodeTypeRedirectPipe) >>
;
RedirectTarget
: stdout
<< dsl.NewASTNodeZary($0, dsl.NodeTypeRedirectTargetStdout) >>
| stderr
<< dsl.NewASTNodeZary($0, dsl.NodeTypeRedirectTargetStderr) >>
| Rvalue
;
// ----------------------------------------------------------------
PrintStatement
: print
<<
dsl.NewASTNodeBinary(
$0, // print
dsl.NewASTNodeNestable(nil, dsl.NodeTypeNoOp), // no printable
dsl.NewASTNodeNestable(nil, dsl.NodeTypeNoOp), // no redirect
dsl.NodeTypePrintStatement,
)
>>
| print Redirector
<<
dsl.NewASTNodeBinary(
$0, // print
dsl.NewASTNodeNestable(nil, dsl.NodeTypeNoOp), // no printable
$1, // redirect
dsl.NodeTypePrintStatement,
)
>>
| print FcnArgs
<<
dsl.NewASTNodeBinary(
$0, // print
$1, // printables
dsl.NewASTNodeNestable(nil, dsl.NodeTypeNoOp), // no redirect
dsl.NodeTypePrintStatement,
)
>>
| print Redirector "," FcnArgs
<<
dsl.NewASTNodeBinary(
$0, // print
$3, // printables
$1, // redirect
dsl.NodeTypePrintStatement,
)
>>
;
// ----------------------------------------------------------------
PrintnStatement
: printn
<<
dsl.NewASTNodeBinary(
$0, // printn
dsl.NewASTNodeNestable(nil, dsl.NodeTypeNoOp), // no printable
dsl.NewASTNodeNestable(nil, dsl.NodeTypeNoOp), // no redirect
dsl.NodeTypePrintnStatement,
)
>>
| printn Redirector
<<
dsl.NewASTNodeBinary(
$0, // printn
dsl.NewASTNodeNestable(nil, dsl.NodeTypeNoOp), // no printable
$1, // redirect
dsl.NodeTypePrintnStatement,
)
>>
| printn FcnArgs
<<
dsl.NewASTNodeBinary(
$0, // printn
$1, // printables
dsl.NewASTNodeNestable(nil, dsl.NodeTypeNoOp), // no redirect
dsl.NodeTypePrintnStatement,
)
>>
| printn Redirector "," FcnArgs
<<
dsl.NewASTNodeBinary(
$0, // printn
$3, // printables
$1, // redirect
dsl.NodeTypePrintnStatement,
)
>>
;
// ----------------------------------------------------------------
EprintStatement
: eprint
<<
dsl.NewASTNodeBinary(
$0, // eprint
dsl.NewASTNodeNestable(nil, dsl.NodeTypeNoOp), // no printables
dsl.NewASTNodeNestable(nil, dsl.NodeTypeNoOp), // no redirect
dsl.NodeTypeEprintStatement,
)
>>
| eprint FcnArgs
<<
dsl.NewASTNodeBinary(
$0, // eprint
$1, // printables
dsl.NewASTNodeNestable(nil, dsl.NodeTypeNoOp), // no redirect
dsl.NodeTypeEprintStatement,
)
>>
;
// ----------------------------------------------------------------
EprintnStatement
: eprintn
<<
dsl.NewASTNodeBinary(
$0, // eprint
dsl.NewASTNodeNestable(nil, dsl.NodeTypeNoOp), // no printables
dsl.NewASTNodeNestable(nil, dsl.NodeTypeNoOp), // no redirect
dsl.NodeTypeEprintnStatement,
)
>>
| eprintn FcnArgs
<<
dsl.NewASTNodeBinary(
$0, // eprintn
$1, // printables
dsl.NewASTNodeNestable(nil, dsl.NodeTypeNoOp), // no redirect
dsl.NodeTypeEprintnStatement,
)
>>
;
// ----------------------------------------------------------------
DumpStatement
: dump
<<
dsl.NewASTNodeBinary(
$0, // dump
dsl.NewASTNodeNestable(nil, dsl.NodeTypeNoOp), // no dumpable
dsl.NewASTNodeNestable(nil, dsl.NodeTypeNoOp), // no redirect
dsl.NodeTypeDumpStatement,
)
>>
| dump Redirector
<<
dsl.NewASTNodeBinary(
$0, // dump
dsl.NewASTNodeNestable(nil, dsl.NodeTypeNoOp), // no dumpable
$1, // redirect
dsl.NodeTypeDumpStatement,
)
>>
| dump FcnArgs
<<
dsl.NewASTNodeBinary(
$0, // dump
$1, // printables
dsl.NewASTNodeNestable(nil, dsl.NodeTypeNoOp), // no redirect
dsl.NodeTypeDumpStatement,
)
>>
| dump Redirector "," FcnArgs
<<
dsl.NewASTNodeBinary(
$0, // dump
$3, // printables
$1, // redirect
dsl.NodeTypeDumpStatement,
)
>>
;
// ----------------------------------------------------------------
EdumpStatement
: edump
<<
dsl.NewASTNodeBinary(
$0, // edump
dsl.NewASTNodeNestable(nil, dsl.NodeTypeNoOp), // no dumpable
dsl.NewASTNodeNestable(nil, dsl.NodeTypeNoOp), // no redirect
dsl.NodeTypeEdumpStatement,
)
>>
| edump FcnArgs
<<
dsl.NewASTNodeBinary(
$0, // edump
$1, // printables
dsl.NewASTNodeNestable(nil, dsl.NodeTypeNoOp), // no redirect
dsl.NodeTypeEdumpStatement,
)
>>
;
// ----------------------------------------------------------------
TeeStatement
: tee Redirector "," FullSrec
<< dsl.NewASTNodeBinary($0, $3, $1, dsl.NodeTypeTeeStatement) >>
;
// ----------------------------------------------------------------
// Examples:
// emitf @a
// emitf @a, b, $c
// Each argument must be a non-indexed oosvar/localvar/fieldname, so we can use
// their names as keys in the emitted record.
EmitFStatement
: emitf EmittableList
<<
dsl.NewASTNodeBinary(
$0, // emitf
$1, // emittables
dsl.NewASTNodeNestable(nil, dsl.NodeTypeNoOp), // no redirect
dsl.NodeTypeEmitFStatement,
)
>>
| emitf Redirector "," EmittableList
<<
dsl.NewASTNodeBinary(
$0, // emitf
$3, // emittables
$1, // redirect
dsl.NodeTypeEmitFStatement,
)
>>
;
// ----------------------------------------------------------------
// The other emit variants need to take only oosvars, etc. -- not arbitrary
// expressions which *evaluate* to map. Emit1, by contrast, takes any
// expression which evaluates to a map. So you can do 'emit1 mapsum({"id":
// $id}, $some_map_valued_field})'.
//
// The reason for this is LR1 shift-reduce conflicts. When I originally
// implemented emit/emitp, I permitted a lot of options for lashing together
// multiple oosvars, indexing, redirection, etc. When we try to let emit (not
// emit1) take arbitrary Rvalue as argument, we get LR1 conflicts since the
// parse can't disambiguate between all the possibilities for commas and
// parentheses for emit-lashing and emit-indexing, and all the possibilities
// for commas and parentheses for the Rvalue expression itself.
//
// So, we have emit/emitp which permit grammatical complexity in the
// lashing/indexing, and emit1 which permits grammatical complexity in the
// emittable.
Emit1Statement
: emit1 Rvalue
<<
dsl.NewASTNodeUnary(
$0, // emit
$1, // Emittable
dsl.NodeTypeEmit1Statement,
)
>>
;
// ----------------------------------------------------------------
// Examples for emit:
// emit @a
// emit (@a, @b)
// emit @a, "x", "y"
// emit (@a, @b), "x", "y"
//
// Examples for emitp: syntactically identical to emit.
//
// First argument (single or in parentheses) must be non-indexed
// oosvar/localvar/fieldname, so we can use their names as keys in the emitted
// record.
//
// We use the Emittable production rule to limit the things being emitted. It
// might be fine to use more generally Rvalue -- anything *evaluating* to a
// map, including function calls -- except that the legacy punctuation design
// of 'emit (#, #), #, #' means that allowing parenthesized expressions within
// the '(...)' results in shift-reduce conflicts at parser-gen time.
//
// One backward-compatible solution (used here) is to limit the types of
// expression within the parentheses. Another (backward-incompatible) solution
// would be to modify the punctuation, e.g. 'emit [#, #], # #' or
// 'emit ([#, #], # #)' perhaps.
//
// However: we shouldn't bother. The reason is that emittables need names which
// are known.
// * emit @a -- the name is "a"
// * emit (@a, @b) -- the names are ["a", "b"]
// * emit @* -- the names are the map keys
// * emit $* -- the names are the map keys
// * emit {...} -- the names are the map keys
// If we allow emit of arbitrary expressions, we open ourselves up to things
// which are unnameable such as the return value from map-valued functions such
// as mapdiff, etc. etc.
EmitStatement
: emit EmittableAsList
<<
dsl.NewASTNodeTernary(
$0, // emit
$1, // Emittable
dsl.NewASTNodeNestable(nil, dsl.NodeTypeNoOp), // no keys
dsl.NewASTNodeNestable(nil, dsl.NodeTypeNoOp), // no redirect
dsl.NodeTypeEmitStatement,
)
>>
| emit Redirector "," EmittableAsList
<<
dsl.NewASTNodeTernary(
$0, // emit
$3, // Emittable
dsl.NewASTNodeNestable(nil, dsl.NodeTypeNoOp), // no keys
$1, // redirect
dsl.NodeTypeEmitStatement,
)
>>
| emit "(" EmittableList ")"
<<
dsl.NewASTNodeTernary(
$0, // emit
$2, // emittables
dsl.NewASTNodeNestable(nil, dsl.NodeTypeNoOp), // no keys
dsl.NewASTNodeNestable(nil, dsl.NodeTypeNoOp), // no redirect
dsl.NodeTypeEmitStatement,
)
>>
| emit Redirector "," "(" EmittableList ")"
<<
dsl.NewASTNodeTernary(
$0, // emit
$4, // emittables
dsl.NewASTNodeNestable(nil, dsl.NodeTypeNoOp), // no keys
$1, // redirect
dsl.NodeTypeEmitStatement,
)
>>
| emit EmittableAsList "," EmitKeys
<<
dsl.NewASTNodeTernary(
$0, // emit
$1, // emittable
$3, // keys
dsl.NewASTNodeNestable(nil, dsl.NodeTypeNoOp), // no redirect
dsl.NodeTypeEmitStatement,
)
>>
| emit Redirector "," EmittableAsList "," EmitKeys
<<
dsl.NewASTNodeTernary(
$0, // emit
$3, // emittable
$5, // keys
$1, // redirect
dsl.NodeTypeEmitStatement,
)
>>
| emit "(" EmittableList ")" "," EmitKeys
<<
dsl.NewASTNodeTernary(
$0, // emit
$2, // emittable
$5, // keys
dsl.NewASTNodeNestable(nil, dsl.NodeTypeNoOp), // no redirect
dsl.NodeTypeEmitStatement,
)
>>
| emit Redirector "," "(" EmittableList ")" "," EmitKeys
<<
dsl.NewASTNodeTernary(
$0, // emit
$4, // emittables
$7, // keys
$1, // redirect
dsl.NodeTypeEmitStatement,
)
>>
;
// ----------------------------------------------------------------
EmitPStatement
: emitp EmittableAsList
<<
dsl.NewASTNodeTernary(
$0, // emitp
$1, // emittable
dsl.NewASTNodeNestable(nil, dsl.NodeTypeNoOp), // no keys
dsl.NewASTNodeNestable(nil, dsl.NodeTypeNoOp), // no redirect
dsl.NodeTypeEmitPStatement,
)
>>
| emitp Redirector "," EmittableAsList
<<
dsl.NewASTNodeTernary(
$0, // emitp
$3, // emittable
dsl.NewASTNodeNestable(nil, dsl.NodeTypeNoOp), // no keys
$1, // redirect
dsl.NodeTypeEmitPStatement,
)
>>
| emitp "(" EmittableList ")"
<<
dsl.NewASTNodeTernary(
$0, // emitp
$2, // emittables
dsl.NewASTNodeNestable(nil, dsl.NodeTypeNoOp), // no keys
dsl.NewASTNodeNestable(nil, dsl.NodeTypeNoOp), // no redirect
dsl.NodeTypeEmitPStatement,
)
>>
| emitp Redirector "," "(" EmittableList ")"
<<
dsl.NewASTNodeTernary(
$0, // emitp
$4, // emittables
dsl.NewASTNodeNestable(nil, dsl.NodeTypeNoOp), // no keys
$1, // redirect
dsl.NodeTypeEmitPStatement,
)
>>
| emitp EmittableAsList "," EmitKeys
<<
dsl.NewASTNodeTernary(
$0, // emitp
$1, // emittable
$3, // keys
dsl.NewASTNodeNestable(nil, dsl.NodeTypeNoOp), // no redirect
dsl.NodeTypeEmitPStatement,
)
>>
| emitp Redirector "," EmittableAsList "," EmitKeys
<<
dsl.NewASTNodeTernary(
$0, // emitp
$3, // emittable
$5, // keys
$1, // redirect
dsl.NodeTypeEmitPStatement,
)
>>
| emitp "(" EmittableList ")" "," EmitKeys
<<
dsl.NewASTNodeTernary(
$0, // emitp
$2, // emittable
$5, // keys
dsl.NewASTNodeNestable(nil, dsl.NodeTypeNoOp), // no redirect
dsl.NodeTypeEmitPStatement,
)
>>
| emitp Redirector "," "(" EmittableList ")" "," EmitKeys
<<
dsl.NewASTNodeTernary(
$0, // emitp
$4, // emittable
$7, // keys
$1, // redirect
dsl.NodeTypeEmitPStatement,
)
>>
;
// ----------------------------------------------------------------
EmittableList
: Emittable
<<
dsl.NewASTNodeUnary(
nil,
$0,
dsl.NodeTypeEmittableList,
)
>>
// Allow trailing final comma, especially for multiline statements
| Emittable "," EmittableList
<< dsl.PrependChild(
$2,
$0,
) >>
;
// Wraps a single emittable in a list-of-one node.
EmittableAsList
: Emittable
<< dsl.NewASTNodeUnary(
nil,
$0,
dsl.NodeTypeEmittableList,
) >>
;
Emittable
: LocalVariable
| DirectOosvarValue
| BracedOosvarValue
| IndirectOosvarValue
| DirectFieldValue
| BracedFieldValue
| IndirectFieldValue
| FullSrec
| FullOosvar
| MapLiteral
;
// ----------------------------------------------------------------
EmitKeys
: Rvalue
<< dsl.NewASTNodeUnary(
nil,
$0,
dsl.NodeTypeEmitKeys,
) >>
| Rvalue "," EmitKeys
<< dsl.PrependChild(
$2,
$0,
) >>
;
// ----------------------------------------------------------------
FieldValue
: DirectFieldValue
| IndirectFieldValue
| BracedFieldValue
| PositionalFieldName
| PositionalFieldValue
;
// Note: the field name is "$name" not "name" since field_name
// includes the '$'. If we omit the '$' there and include it in the parser
// section here as "$", then we get an LR-1 conflict. So this must be dealt
// with at the AST level. Hence the NewASTNodeStripDollarOrAtSign.
DirectFieldValue
: field_name
<< dsl.NewASTNodeStripDollarOrAtSign($0, dsl.NodeTypeDirectFieldValue) >>
;
IndirectFieldValue
: "$[" Rvalue "]"
<< dsl.NewASTNodeUnary(dsl.NewASTToken("$[]", $0), $1, dsl.NodeTypeIndirectFieldValue) >>
;
// * Direct is '$name'
// * Indirect is '$["name"]'
// * Braced is '${name}' -- note no double-quotes. This is for when the field
// name has spaces or somesuch in it.
BracedFieldValue
: braced_field_name
<< dsl.NewASTNodeStripDollarOrAtSignAndCurlyBraces($0, dsl.NodeTypeDirectFieldValue) >>
;
PositionalFieldName
: "$[[" Rvalue "]" "]" // Not "]]" since that would define a token, making '$foo[bar[1]]' a syntax error
<< dsl.NewASTNodeUnary(dsl.NewASTToken("$[]", $0), $1, dsl.NodeTypePositionalFieldName) >>
;
PositionalFieldValue
: "$[[[" Rvalue "]" "]" "]" // Not "]]]" since that would define a token, making '$foo[bar[baz[1]]]' a syntax error
<< dsl.NewASTNodeUnary(dsl.NewASTToken("$[]", $0), $1, dsl.NodeTypePositionalFieldValue) >>
;
FullSrec
: full_srec
<< dsl.NewASTNode($0, dsl.NodeTypeFullSrec) >>
;
// ----------------------------------------------------------------
OosvarValue
: DirectOosvarValue
| IndirectOosvarValue
| BracedOosvarValue
;
// Note: the oosvar name is "@name" not "name" since oosvar_name
// includes the '@'. If we omit the '@' there and include it in the parser
// section here as "$", then we get an LR-1 conflict. So this must be dealt
// with at the AST level. Hence the NewASTNodeStripDollarOrAtSign.
DirectOosvarValue
: oosvar_name
<< dsl.NewASTNodeStripDollarOrAtSign($0, dsl.NodeTypeDirectOosvarValue) >>
;
IndirectOosvarValue
: "@[" Rvalue "]"
<< dsl.NewASTNodeUnary(dsl.NewASTToken("@[]", $0), $1, dsl.NodeTypeIndirectOosvarValue) >>
;
// * Direct is '@name'
// * Indirect is '@["name"]'
// * Braced is '@{name}' -- note no double-quotes. This is for when the oosvar
// name has spaces or somesuch in it.
BracedOosvarValue
: braced_oosvar_name
<< dsl.NewASTNodeStripDollarOrAtSignAndCurlyBraces($0, dsl.NodeTypeDirectOosvarValue) >>
;
FullOosvar
: full_oosvar
<< dsl.NewASTNode($0, dsl.NodeTypeFullOosvar) >>
| all
<< dsl.NewASTNode($0, dsl.NodeTypeFullOosvar) >>
;
// ----------------------------------------------------------------
LocalVariable
: non_sigil_name
<< dsl.NewASTNode($0, dsl.NodeTypeLocalVariable) >>
;
Typedecl
: arr
<< dsl.NewASTNode($0, dsl.NodeTypeTypedecl) >>
| bool
<< dsl.NewASTNode($0, dsl.NodeTypeTypedecl) >>
| float
<< dsl.NewASTNode($0, dsl.NodeTypeTypedecl) >>
| int
<< dsl.NewASTNode($0, dsl.NodeTypeTypedecl) >>
| map
<< dsl.NewASTNode($0, dsl.NodeTypeTypedecl) >>
| num
<< dsl.NewASTNode($0, dsl.NodeTypeTypedecl) >>
| str
<< dsl.NewASTNode($0, dsl.NodeTypeTypedecl) >>
| var
<< dsl.NewASTNode($0, dsl.NodeTypeTypedecl) >>
| funct
<< dsl.NewASTNode($0, dsl.NodeTypeTypedecl) >>
;
// ----------------------------------------------------------------
// REWRITE COMPOUND ASSIGNMENT OPERATORS
//
// Transform '$x += 1' which would have AST
//
// +=
// $x
// 1
//
// into '$x = $x + 1' with AST
//
// =
// $x
// +
// $x
// 1
//
// right here in the parser.
//
// Use the NewASTToken to clone the "||=" into "||" and so on.
Assignment
: Lvalue "||=" Rvalue
<< dsl.NewASTNodeBinary(
dsl.NewASTToken("=", $1),
$0,
dsl.NewASTNodeBinaryNestable(dsl.NewASTToken("||", $1), $0, $2, dsl.NodeTypeOperator),
dsl.NodeTypeAssignment,
) >>
| Lvalue "^^=" Rvalue
<< dsl.NewASTNodeBinary(
dsl.NewASTToken("=", $1),
$0,
dsl.NewASTNodeBinaryNestable(dsl.NewASTToken("^^", $1), $0, $2, dsl.NodeTypeOperator),
dsl.NodeTypeAssignment,
) >>
| Lvalue "&&=" Rvalue
<< dsl.NewASTNodeBinary(
dsl.NewASTToken("=", $1),
$0,
dsl.NewASTNodeBinaryNestable(dsl.NewASTToken("&&", $1), $0, $2, dsl.NodeTypeOperator),
dsl.NodeTypeAssignment,
) >>
| Lvalue "??=" Rvalue
<< dsl.NewASTNodeBinary(
dsl.NewASTToken("=", $1),
$0,
dsl.NewASTNodeBinaryNestable(dsl.NewASTToken("??", $1), $0, $2, dsl.NodeTypeOperator),
dsl.NodeTypeAssignment,
) >>
| Lvalue "???=" Rvalue
<< dsl.NewASTNodeBinary(
dsl.NewASTToken("=", $1),
$0,
dsl.NewASTNodeBinaryNestable(dsl.NewASTToken("???", $1), $0, $2, dsl.NodeTypeOperator),
dsl.NodeTypeAssignment,
) >>
| Lvalue "|=" Rvalue
<< dsl.NewASTNodeBinary(
dsl.NewASTToken("=", $1),
$0,
dsl.NewASTNodeBinaryNestable(dsl.NewASTToken("|", $1), $0, $2, dsl.NodeTypeOperator),
dsl.NodeTypeAssignment,
) >>
| Lvalue "&=" Rvalue
<< dsl.NewASTNodeBinary(
dsl.NewASTToken("=", $1),
$0,
dsl.NewASTNodeBinaryNestable(dsl.NewASTToken("^", $1), $0, $2, dsl.NodeTypeOperator),
dsl.NodeTypeAssignment,
) >>
| Lvalue "^=" Rvalue
<< dsl.NewASTNodeBinary(
dsl.NewASTToken("=", $1),
$0,
dsl.NewASTNodeBinaryNestable(dsl.NewASTToken("^", $1), $0, $2, dsl.NodeTypeOperator),
dsl.NodeTypeAssignment,
) >>
| Lvalue "<<=" Rvalue
<< dsl.NewASTNodeBinary(
dsl.NewASTToken("=", $1),
$0,
dsl.NewASTNodeBinaryNestable(dsl.NewASTToken("<<", $1), $0, $2, dsl.NodeTypeOperator),
dsl.NodeTypeAssignment,
) >>
| Lvalue ">>=" Rvalue
<< dsl.NewASTNodeBinary(
dsl.NewASTToken("=", $1),
$0,
dsl.NewASTNodeBinaryNestable(dsl.NewASTToken(">"+">", $1), $0, $2, dsl.NodeTypeOperator),
dsl.NodeTypeAssignment,
) >>
| Lvalue ">>>=" Rvalue
<< dsl.NewASTNodeBinary(
dsl.NewASTToken("=", $1),
$0,
dsl.NewASTNodeBinaryNestable(dsl.NewASTToken(">"+">"+">", $1), $0, $2, dsl.NodeTypeOperator),
dsl.NodeTypeAssignment,
) >>
| Lvalue "+=" Rvalue
<< dsl.NewASTNodeBinary(
dsl.NewASTToken("=", $1),
$0,
dsl.NewASTNodeBinaryNestable(dsl.NewASTToken("+", $1), $0, $2, dsl.NodeTypeOperator),
dsl.NodeTypeAssignment,
) >>
| Lvalue ".=" Rvalue
<< dsl.NewASTNodeBinary(
dsl.NewASTToken("=", $1),
$0,
dsl.NewASTNodeBinaryNestable(dsl.NewASTToken(".", $1), $0, $2, dsl.NodeTypeDotOperator),
dsl.NodeTypeAssignment,
) >>
| Lvalue "-=" Rvalue
<< dsl.NewASTNodeBinary(
dsl.NewASTToken("=", $1),
$0,
dsl.NewASTNodeBinaryNestable(dsl.NewASTToken("-", $1), $0, $2, dsl.NodeTypeOperator),
dsl.NodeTypeAssignment,
) >>
| Lvalue "*=" Rvalue
<< dsl.NewASTNodeBinary(
dsl.NewASTToken("=", $1),
$0,
dsl.NewASTNodeBinaryNestable(dsl.NewASTToken("*", $1), $0, $2, dsl.NodeTypeOperator),
dsl.NodeTypeAssignment,
) >>
| Lvalue "/=" Rvalue
<< dsl.NewASTNodeBinary(
dsl.NewASTToken("=", $1),
$0,
dsl.NewASTNodeBinaryNestable(dsl.NewASTToken("/", $1), $0, $2, dsl.NodeTypeOperator),
dsl.NodeTypeAssignment,
) >>
| Lvalue "//=" Rvalue
<< dsl.NewASTNodeBinary(
dsl.NewASTToken("=", $1),
$0,
dsl.NewASTNodeBinaryNestable(dsl.NewASTToken("//", $1), $0, $2, dsl.NodeTypeOperator),
dsl.NodeTypeAssignment,
) >>
| Lvalue "%=" Rvalue
<< dsl.NewASTNodeBinary(
dsl.NewASTToken("=", $1),
$0,
dsl.NewASTNodeBinaryNestable(dsl.NewASTToken("%", $1), $0, $2, dsl.NodeTypeOperator),
dsl.NodeTypeAssignment,
) >>
| Lvalue "**=" Rvalue
<< dsl.NewASTNodeBinary(
dsl.NewASTToken("=", $1),
$0,
dsl.NewASTNodeBinaryNestable(dsl.NewASTToken("**", $1), $0, $2, dsl.NodeTypeOperator),
dsl.NodeTypeAssignment,
) >>
;
// ================================================================
// BEGIN RVALUE OPERATOR-PRECEDENCE CHAIN
// ================================================================
Rvalue : PrecedenceChainStart ;
PrecedenceChainStart : TernaryTerm ;
TernaryTerm
: LogicalOrTerm "?" TernaryTerm ":" TernaryTerm
<< dsl.NewASTNodeTernary(dsl.NewASTToken("?:", $1), $0, $2, $4, dsl.NodeTypeOperator) >>
| LogicalOrTerm
;
LogicalOrTerm
: LogicalOrTerm "||" LogicalXORTerm
<< dsl.NewASTNodeBinary($1, $0, $2, dsl.NodeTypeOperator) >>
| LogicalXORTerm
;
LogicalXORTerm
: LogicalXORTerm "^^" LogicalAndTerm
<< dsl.NewASTNodeBinary($1, $0, $2, dsl.NodeTypeOperator) >>
| LogicalAndTerm
;
LogicalAndTerm
: LogicalAndTerm "&&" AbsentCoalesceTerm
<< dsl.NewASTNodeBinary($1, $0, $2, dsl.NodeTypeOperator) >>
| AbsentCoalesceTerm
;
AbsentCoalesceTerm
: AbsentCoalesceTerm "??" EmptyCoalesceTerm
<< dsl.NewASTNodeBinary($1, $0, $2, dsl.NodeTypeOperator) >>
| EmptyCoalesceTerm
;
EmptyCoalesceTerm
: EmptyCoalesceTerm "???" EqneTerm
<< dsl.NewASTNodeBinary($1, $0, $2, dsl.NodeTypeOperator) >>
| EqneTerm
;
EqneTerm
: EqneTerm "=~" CmpTerm << dsl.NewASTNodeBinary($1, $0, $2, dsl.NodeTypeOperator) >>
| EqneTerm "!=~" CmpTerm << dsl.NewASTNodeBinary($1, $0, $2, dsl.NodeTypeOperator) >>
| EqneTerm "==" CmpTerm << dsl.NewASTNodeBinary($1, $0, $2, dsl.NodeTypeOperator) >>
| EqneTerm "!=" CmpTerm << dsl.NewASTNodeBinary($1, $0, $2, dsl.NodeTypeOperator) >>
| EqneTerm "<=>" CmpTerm << dsl.NewASTNodeBinary($1, $0, $2, dsl.NodeTypeOperator) >>
| CmpTerm
;
CmpTerm
: CmpTerm ">" BitwiseORTerm << dsl.NewASTNodeBinary($1, $0, $2, dsl.NodeTypeOperator) >>
| CmpTerm ">=" BitwiseORTerm << dsl.NewASTNodeBinary($1, $0, $2, dsl.NodeTypeOperator) >>
| CmpTerm "<" BitwiseORTerm << dsl.NewASTNodeBinary($1, $0, $2, dsl.NodeTypeOperator) >>
| CmpTerm "<=" BitwiseORTerm << dsl.NewASTNodeBinary($1, $0, $2, dsl.NodeTypeOperator) >>
| BitwiseORTerm
;
BitwiseORTerm
: BitwiseORTerm "|" BitwiseXORTerm << dsl.NewASTNodeBinary($1, $0, $2, dsl.NodeTypeOperator) >>
| BitwiseXORTerm
;
BitwiseXORTerm
: BitwiseXORTerm "^" BitwiseANDTerm << dsl.NewASTNodeBinary($1, $0, $2, dsl.NodeTypeOperator) >>
| BitwiseANDTerm
;
BitwiseANDTerm
: BitwiseANDTerm "&" BitwiseShiftTerm << dsl.NewASTNodeBinary($1, $0, $2, dsl.NodeTypeOperator) >>
| BitwiseShiftTerm
;
BitwiseShiftTerm
: BitwiseShiftTerm "<<" AddsubdotTerm << dsl.NewASTNodeBinary($1, $0, $2, dsl.NodeTypeOperator) >>
| BitwiseShiftTerm ">>" AddsubdotTerm << dsl.NewASTNodeBinary($1, $0, $2, dsl.NodeTypeOperator) >>
| BitwiseShiftTerm ">>>" AddsubdotTerm << dsl.NewASTNodeBinary($1, $0, $2, dsl.NodeTypeOperator) >>
| AddsubdotTerm
;
AddsubdotTerm
: AddsubdotTerm "+" MuldivTerm << dsl.NewASTNodeBinary($1, $0, $2, dsl.NodeTypeOperator) >>
| AddsubdotTerm "-" MuldivTerm << dsl.NewASTNodeBinary($1, $0, $2, dsl.NodeTypeOperator) >>
| AddsubdotTerm ".+" MuldivTerm << dsl.NewASTNodeBinary($1, $0, $2, dsl.NodeTypeOperator) >>
| AddsubdotTerm ".-" MuldivTerm << dsl.NewASTNodeBinary($1, $0, $2, dsl.NodeTypeOperator) >>
| MuldivTerm
;
MuldivTerm
: MuldivTerm "*" DotTerm << dsl.NewASTNodeBinary($1, $0, $2, dsl.NodeTypeOperator) >>
| MuldivTerm "/" DotTerm << dsl.NewASTNodeBinary($1, $0, $2, dsl.NodeTypeOperator) >>
| MuldivTerm "//" DotTerm << dsl.NewASTNodeBinary($1, $0, $2, dsl.NodeTypeOperator) >>
| MuldivTerm "%" DotTerm << dsl.NewASTNodeBinary($1, $0, $2, dsl.NodeTypeOperator) >>
| MuldivTerm ".*" DotTerm << dsl.NewASTNodeBinary($1, $0, $2, dsl.NodeTypeOperator) >>
| MuldivTerm "./" DotTerm << dsl.NewASTNodeBinary($1, $0, $2, dsl.NodeTypeOperator) >>
| MuldivTerm ".//" DotTerm << dsl.NewASTNodeBinary($1, $0, $2, dsl.NodeTypeOperator) >>
| DotTerm
;
DotTerm
: DotTerm "." UnaryOpTerm << dsl.NewASTNodeBinary($1, $0, $2, dsl.NodeTypeDotOperator) >>
| UnaryOpTerm
;
UnaryOpTerm
: "+" UnaryOpTerm << dsl.NewASTNodeUnary($0, $1, dsl.NodeTypeOperator) >>
| "-" UnaryOpTerm << dsl.NewASTNodeUnary($0, $1, dsl.NodeTypeOperator) >>
| ".+" UnaryOpTerm << dsl.NewASTNodeUnary($0, $1, dsl.NodeTypeOperator) >>
| ".-" UnaryOpTerm << dsl.NewASTNodeUnary($0, $1, dsl.NodeTypeOperator) >>
| "!" UnaryOpTerm << dsl.NewASTNodeUnary($0, $1, dsl.NodeTypeOperator) >>
| "~" UnaryOpTerm << dsl.NewASTNodeUnary($0, $1, dsl.NodeTypeOperator) >>
| PowTerm
;
PowTerm
: PrecedenceChainEnd "**" PowTerm
<< dsl.NewASTNodeBinary($1, $0, $2, dsl.NodeTypeOperator) >>
// In the Miller-DSL grammar, the leading -/+ isn't part of the int/float token -- it's treated as
// a unary operator. (Making it part of the token leads to LR1 conflicts, and is also inelegant.)
// However, this means things like '2 ** -3' result in mashup of two operators next to one
// another. For '2 + -3' and '2 * -3', this happens fine down the precedence chain since
// AddsubdotTerm and MuldivTerm are above UnaryOpTerm. Since PowTerm is below UnaryOpTerm, though,
// we need to be explicit about '2 ** -3' in a way that we do not need to for '2 * -3'. Also, we
// can't use 'PrecedenceChainEnd "**" UnaryOpTerm', as this also results in LR1 conflicts.
| PrecedenceChainEnd "**" "-" PowTerm << dsl.NewASTNodeBinary( $1, $0,
dsl.NewASTNodeUnaryNestable( $2, $3, dsl.NodeTypeOperator,), dsl.NodeTypeOperator,)
>>
| PrecedenceChainEnd "**" "+" PowTerm
<<
dsl.NewASTNodeBinary(
$1,
$0,
dsl.NewASTNodeUnaryNestable(
$2,
$3,
dsl.NodeTypeOperator,
),
dsl.NodeTypeOperator,
)
>>
| PrecedenceChainEnd
;
// Please Excuse My Dear Aunt Sally! :) We've gotten to the 'P' so we're done
// with the operator-precedence chain. :)
PrecedenceChainEnd
: "(" Rvalue ")"
<< dsl.Nestable($1) >>
;
PrecedenceChainEnd : MlrvalOrFunction ;
// ================================================================
// END RVALUE OPERATOR-PRECEDENCE CHAIN
// ================================================================
// ================================================================
// Leaf-ish nodes, i.e. expressions without operators ... in things like '$y =
// 3 * $x + 4', the Rvalue operator-parse separates out the '3', the '$x', and
// the '4' ... but they could have as well been '$y = 3 * $x[7] + f($a,$b,$c)'.
//
// Grammar rules here have to do with nodes like '3', or '$x[7]', or
// 'f($a,$b,$c)'.
//
// At the moment I call these MlrvalOrFunction.
// ----------------------------------------------------------------
MlrvalOrFunction
: FieldValue
| FullSrec
| OosvarValue
| FullOosvar
| LocalVariable
| UnnamedFunctionDefinition
;
// ----------------------------------------------------------------
// STRING/INT/FLOAT/BOOL LITERALS
// As with '$' on field_name, so too for string_literal we
// get LR-1 conflicts if we attempt to put the double quotes here. Hence the
// quote-stripper AST method. Also, since string literals can have
// backslash-escaped double-quotes like "...\"...\"...", we also unbackslash
// in the same method.
// For Miller-style case-insensitive regexes -- of the form "a.*b"i with the
// trailing 'i' -- we don't strip the initial '"' or the final '"i'.
MlrvalOrFunction
: string_literal
<< dsl.NewASTNodeStripDoubleQuotePair($0, dsl.NodeTypeStringLiteral) >>
| regex_case_insensitive
<< dsl.NewASTNode($0, dsl.NodeTypeRegexCaseInsensitive) >>
| int_literal
<< dsl.NewASTNode($0, dsl.NodeTypeIntLiteral) >>
| float_literal
<< dsl.NewASTNode($0, dsl.NodeTypeFloatLiteral) >>
| boolean_literal
<< dsl.NewASTNode($0, dsl.NodeTypeBoolLiteral) >>
| null_literal
<< dsl.NewASTNode($0, dsl.NodeTypeNullLiteral) >>
| inf_literal
<< dsl.NewASTNode($0, dsl.NodeTypeFloatLiteral) >>
| nan_literal
<< dsl.NewASTNode($0, dsl.NodeTypeFloatLiteral) >>
| const_M_PI
<< dsl.NewASTNode(
$0,
dsl.NodeTypeConstant,
) >>
| const_M_E
<< dsl.NewASTNode(
$0,
dsl.NodeTypeConstant,
) >>
| panic
<< dsl.NewASTNode($0, dsl.NodeTypePanic) >>
;
// ================================================================
// Array literals in Miller are JSON-ish.
MlrvalOrFunction : ArrayLiteral ;
// ----------------------------------------------------------------
ArrayLiteral
: "[" "]"
<< dsl.NewASTNodeZary(
dsl.NewASTToken("[]", $0),
dsl.NodeTypeArrayLiteral,
) >>
| "[" ArrayLiteralElements "]"
// As parsed there's an intermediate node between ArrayLiteral
// and the children. Now we can remove it.
//
// Before:
// * ArrayLiteral "[]"
// * ArrayLiteral
// * StringLiteral "a"
// * StringLiteral "b"
//
// After:
// * ArrayLiteral "[]"
// * StringLiteral "a"
// * StringLiteral "b"
<<
dsl.AdoptChildren(
dsl.NewASTNodeNestable(
dsl.NewASTToken("[]", $0),
dsl.NodeTypeArrayLiteral,
),
$1,
)
>>
;
// ----------------------------------------------------------------
ArrayLiteralElements
: Rvalue
<< dsl.NewASTNodeUnary(
nil,
$0,
dsl.NodeTypeArrayLiteral,
) >>
// Allow trailing final comma, especially for multiline statements
| Rvalue ","
<< dsl.NewASTNodeUnary(
nil,
$0,
dsl.NodeTypeArrayLiteral,
) >>
// Allow trailing final comma, especially for multiline statements
| Rvalue "," ArrayLiteralElements
<< dsl.PrependChild(
$2,
$0,
) >>
;
// ================================================================
// Map literals in Miller are JSON-ish.
MlrvalOrFunction : MapLiteral ;
// ----------------------------------------------------------------
MapLiteral
: "{" "}"
<< dsl.NewASTNodeZary(
dsl.NewASTToken("{}", $0),
dsl.NodeTypeMapLiteral,
) >>
| "{" MapLiteralKeyValuePairs "}"
// As parsed there's an intermediate node between MapLiteral
// and the children. Now we can remove it.
//
// Before:
// * MapLiteral "{}"
// * MapLiteral
// * MapLiteralKeyValuePair ":"
// * StringLiteral "a"
// * StringLiteral "1"
// * MapLiteralKeyValuePair ":"
// * StringLiteral "b"
// * IntLiteral "2"
//
// After:
// * MapLiteral "{}"
// * MapLiteralKeyValuePair ":"
// * StringLiteral "a"
// * StringLiteral "1"
// * MapLiteralKeyValuePair ":"
// * StringLiteral "b"
// * IntLiteral "2"
<<
dsl.AdoptChildren(
dsl.NewASTNodeNestable(
dsl.NewASTToken("{}", $0),
dsl.NodeTypeMapLiteral,
),
$1,
)
>>
;
// ----------------------------------------------------------------
MapLiteralKeyValuePairs
: MapLiteralKeyValuePair
<< dsl.NewASTNodeUnary(
nil,
$0,
dsl.NodeTypeMapLiteral,
) >>
// Allow trailing final comma, especially for multiline statements
| MapLiteralKeyValuePair ","
<< dsl.NewASTNodeUnary(
nil,
$0,
dsl.NodeTypeMapLiteral,
) >>
// Allow trailing final comma, especially for multiline statements
| MapLiteralKeyValuePair "," MapLiteralKeyValuePairs
<< dsl.PrependChild(
$2,
$0,
) >>
;
// ----------------------------------------------------------------
MapLiteralKeyValuePair
: Rvalue ":" Rvalue
<< dsl.NewASTNodeBinary(
$1,
$0,
$2,
dsl.NodeTypeMapLiteralKeyValuePair,
) >>
;
// ================================================================
MlrvalOrFunction : ContextVariable ;
ContextVariable
: ctx_IPS << dsl.NewASTNode($0, dsl.NodeTypeContextVariable) >>
| ctx_IFS << dsl.NewASTNode($0, dsl.NodeTypeContextVariable) >>
| ctx_IRS << dsl.NewASTNode($0, dsl.NodeTypeContextVariable) >>
| ctx_OPS << dsl.NewASTNode($0, dsl.NodeTypeContextVariable) >>
| ctx_OFS << dsl.NewASTNode($0, dsl.NodeTypeContextVariable) >>
| ctx_ORS << dsl.NewASTNode($0, dsl.NodeTypeContextVariable) >>
| ctx_FLATSEP << dsl.NewASTNode($0, dsl.NodeTypeContextVariable) >>
| ctx_NF << dsl.NewASTNode($0, dsl.NodeTypeContextVariable) >>
| ctx_NR << dsl.NewASTNode($0, dsl.NodeTypeContextVariable) >>
| ctx_FNR << dsl.NewASTNode($0, dsl.NodeTypeContextVariable) >>
| ctx_FILENAME << dsl.NewASTNode($0, dsl.NodeTypeContextVariable) >>
| ctx_FILENUM << dsl.NewASTNode($0, dsl.NodeTypeContextVariable) >>
;
// ----------------------------------------------------------------
MlrvalOrFunction : ENV ;
// Only ENV["FOO"]; not arbitrarily indexable like maps are.
// Alternate syntax: ENV.FOO.
ENV
: env "[" Rvalue "]"
<< dsl.NewASTNodeUnary(
$0,
$2,
dsl.NodeTypeEnvironmentVariable,
) >>
| env "." non_sigil_name
<< dsl.NewASTNodeUnary(
$0,
dsl.NewASTNodeNestable($2, dsl.NodeTypeStringLiteral),
dsl.NodeTypeEnvironmentVariable,
) >>
;
// ================================================================
// INDEXED ACCESS
//
// For Array or Map -- which one, to be determined at runtime.
// ----------------------------------------------------------------
MlrvalOrFunction
: ArrayOrMapIndexAccess
| ArrayOrMapPositionalNameAccess
| ArrayOrMapPositionalValueAccess
| ArraySliceAccess ;
ArrayOrMapIndexAccess
: MlrvalOrFunction "[" Rvalue "]"
<< dsl.NewASTNodeBinary(
dsl.NewASTToken("[]", $1),
$0,
$2,
dsl.NodeTypeArrayOrMapIndexAccess,
)>>
;
ArrayOrMapPositionalNameAccess
: MlrvalOrFunction "[[" Rvalue "]" "]" // Not "]]" since that would define a token, making '$foo[bar[1]]' a syntax error
<< dsl.NewASTNodeBinary(
dsl.NewASTToken("[]", $1),
$0,
$2,
dsl.NodeTypeArrayOrMapPositionalNameAccess,
)>>
;
ArrayOrMapPositionalValueAccess
: MlrvalOrFunction "[[[" Rvalue "]" "]" "]" // Not "]]]" since that would define a token, making '$foo[bar[baz[1]]]' a syntax error
<< dsl.NewASTNodeBinary(
dsl.NewASTToken("[]", $1),
$0,
$2,
dsl.NodeTypeArrayOrMapPositionalValueAccess,
)>>
;
ArraySliceAccess
: MlrvalOrFunction "[" Rvalue ":" Rvalue "]"
<< dsl.NewASTNodeTernary(
dsl.NewASTToken("[]", $1),
$0,
$2,
$4,
dsl.NodeTypeArraySliceAccess,
)>>
| MlrvalOrFunction "[" ":" Rvalue "]"
<< dsl.NewASTNodeTernary(
dsl.NewASTToken("[]", $1),
$0,
dsl.NewASTNodeNestable(
$2,
dsl.NodeTypeArraySliceEmptyLowerIndex,
),
$3,
dsl.NodeTypeArraySliceAccess,
)>>
| MlrvalOrFunction "[" Rvalue ":" "]"
<< dsl.NewASTNodeTernary(
dsl.NewASTToken("[]", $1),
$0,
$2,
dsl.NewASTNodeNestable(
$3,
dsl.NodeTypeArraySliceEmptyUpperIndex,
),
dsl.NodeTypeArraySliceAccess,
)>>
| MlrvalOrFunction "[" ":" "]"
<< dsl.NewASTNodeTernary(
dsl.NewASTToken("[]", $1),
$0,
dsl.NewASTNodeNestable(
$2,
dsl.NodeTypeArraySliceEmptyLowerIndex,
),
dsl.NewASTNodeNestable(
$2,
dsl.NodeTypeArraySliceEmptyUpperIndex,
),
dsl.NodeTypeArraySliceAccess,
)>>
;
// ================================================================
// FUNCTION/SUBROUTINE CALLS
MlrvalOrFunction
: FunctionCallsite
;
FunctionCallsite
: FunctionName "(" ")"
<< dsl.NewASTNodeZary(
$0,
dsl.NodeTypeFunctionCallsite,
) >>
| FunctionName "(" FcnArgs ")"
// As parsed there's an intermediate node between FunctionCallsite
// and the children. Now we can remove it.
//
// Before:
// * FunctionCallsite "[]"
// * FunctionCallsite
// * StringLiteral "a"
// * StringLiteral "b"
//
// After:
// * FunctionCallsite "[]"
// * StringLiteral "a"
// * StringLiteral "b"
<<
dsl.AdoptChildren(
dsl.NewASTNodeNestable(
$0,
dsl.NodeTypeFunctionCallsite,
),
$2,
)
>>
;
// For most functions it suffices to use the non_sigil_name pattern.
// But int and float are keywords in the lexer so we need to spell those out
// explicitly. (They're type-decl keywords but they're also the names of
// type-conversion functions.)
FunctionName
: non_sigil_name
| int
| float
;
// ----------------------------------------------------------------
FcnArgs
: Rvalue
<< dsl.NewASTNodeUnary(
nil,
$0,
dsl.NodeTypeFunctionCallsite,
) >>
// Allow trailing final comma, especially for multiline statements
| Rvalue ","
<< dsl.NewASTNodeUnary(
nil,
$0,
dsl.NodeTypeFunctionCallsite,
) >>
// Allow trailing final comma, especially for multiline statements
| Rvalue "," FcnArgs
<< dsl.PrependChild(
$2,
$0,
) >>
;
// ----------------------------------------------------------------
// Subroutine callsite
SubroutineCallsite
: call SubroutineName "(" ")"
<< dsl.NewASTNodeZary(
$1,
dsl.NodeTypeSubroutineCallsite,
) >>
| call SubroutineName "(" FcnArgs ")"
// As parsed there's an intermediate node between SubroutineCallsite
// and the children. Now we can remove it.
//
// Before:
// * SubroutineCallsite "[]"
// * SubroutineCallsite
// * StringLiteral "a"
// * StringLiteral "b"
//
// After:
// * SubroutineCallsite "[]"
// * StringLiteral "a"
// * StringLiteral "b"
<<
dsl.AdoptChildren(
dsl.NewASTNodeNestable(
$1,
dsl.NodeTypeSubroutineCallsite,
),
$3,
)
>>
;
SubroutineName : non_sigil_name;
// ================================================================
// BEGIN/END BLOCKS
BracefulStatement
: BeginBlock
| EndBlock
| CondBlock
| IfChain
| WhileLoop
| ForLoop
| NamedFunctionDefinition
| SubroutineDefinition
;
BeginBlock
: begin StatementBlockInBraces
<< dsl.NewASTNodeUnary(nil, $1, dsl.NodeTypeBeginBlock) >>
;
EndBlock
: end StatementBlockInBraces
<< dsl.NewASTNodeUnary(nil, $1, dsl.NodeTypeEndBlock) >>
;
// ================================================================
// PATTERN-ACTION BLOCKS (AWKISH)
// E.g. mlr put 'NR > 10 { ... }'.
// Just shorthand for mlr put 'if (NR > 10) { ... }' without any elif/else.
CondBlock
:= Rvalue StatementBlockInBraces
<< dsl.NewASTNodeBinary(nil, $0, $1, dsl.NodeTypeCondBlock) >>
;
// ================================================================
// IF-STATEMENTS
// Cases:
// if elif*
// if elif* else
IfChain
: IfElifStar
| IfElifStar ElseBlock
<< dsl.AppendChild($0, $1) >>
;
IfElifStar
: IfBlock
<< dsl.NewASTNodeUnary(nil, $0, dsl.NodeTypeIfChain) >>
| IfElifStar ElifBlock
<< dsl.AppendChild($0, $1) >>
;
IfBlock
: if "(" Rvalue ")" StatementBlockInBraces
<< dsl.NewASTNodeBinary($0, $2, $4, dsl.NodeTypeIfItem) >>
;
ElifBlock
: elif "(" Rvalue ")" StatementBlockInBraces
<< dsl.NewASTNodeBinary($0, $2, $4, dsl.NodeTypeIfItem) >>
;
ElseBlock
: else StatementBlockInBraces
<< dsl.NewASTNodeUnary($0, $1, dsl.NodeTypeIfItem) >>
;
// ================================================================
// WHILE AND DO-WHILE -LOOPS
WhileLoop
: while "(" Rvalue ")" StatementBlockInBraces
<< dsl.NewASTNodeBinary($0, $2, $4, dsl.NodeTypeWhileLoop) >>
;
DoWhileLoop
: do StatementBlockInBraces while "(" Rvalue ")"
<< dsl.NewASTNodeBinary($0, $1, $4, dsl.NodeTypeDoWhileLoop) >>
;
// ================================================================
// FOR-LOOPS
// ----------------------------------------------------------------
ForLoop
: ForLoopOneVariable
| ForLoopTwoVariable
| ForLoopMultivariable
| TripleForLoop
;
// ----------------------------------------------------------------
// for(k in $*) { ... }
ForLoopOneVariable
: for
"("
LocalVariable
in
Rvalue
")"
StatementBlockInBraces
<<
dsl.NewASTNodeTernary(
$0, // "for"
$2, // k, etc.
$4, // $*, etc.
$6, // { ... }
dsl.NodeTypeForLoopOneVariable,
);
>>
;
// ----------------------------------------------------------------
// for(k, v in $*) { ... }
ForLoopTwoVariable
: for
"("
LocalVariable
","
LocalVariable
in
Rvalue
")"
StatementBlockInBraces
<<
dsl.NewASTNodeQuaternary(
$0, // "for"
$2, // k, etc.
$4, // v, etc.
$6, // $*, etc.
$8, // { ... }
dsl.NodeTypeForLoopTwoVariable,
);
>>
;
// ----------------------------------------------------------------
// for((k1, k2), v in $*) { ... }
ForLoopMultivariable
:
for
"("
"("
MultiIndex
")"
","
LocalVariable
in
Rvalue
")"
StatementBlockInBraces
<<
dsl.NewASTNodeQuaternary(
$0, // "for"
$3, // (k1, k2), etc.
$6, // v, etc.
$8, // $*, etc.
$10, // { ... }
dsl.NodeTypeForLoopMultivariable,
);
>>
;
MultiIndex
: LocalVariable "," LocalVariable
<< dsl.NewASTNodeBinary(
nil,
$0,
$2,
dsl.NodeTypeParameterList,
) >>
| MultiIndex "," LocalVariable
<< dsl.AppendChild(
$0,
$2,
) >>
;
// ----------------------------------------------------------------
TripleForLoop
:
for
"("
TripleForStart
";"
TripleForContinuation
";"
TripleForUpdate
")"
StatementBlockInBraces
<<
dsl.NewASTNodeQuaternary(
$0, // for
$2, // start
$4, // continuation
$6, // update
$8, // body
dsl.NodeTypeTripleForLoop,
);
>>
;
TripleForStart
: empty
<< dsl.NewASTNodeZary(nil, dsl.NodeTypeStatementBlock) >>
| Assignment
<< dsl.NewASTNodeUnary(nil, $0, dsl.NodeTypeStatementBlock) >>
| TripleForStart "," Assignment
<<dsl.AppendChild($0, $2) >>
;
// Enforced in the CST, not here: the last must be a bare boolean; the ones
// before must be assignments.
TripleForContinuation
: empty
<< dsl.NewASTNodeZary(nil, dsl.NodeTypeStatementBlock) >>
| TripleForContinuationItem
<< dsl.NewASTNodeUnary(nil, $0, dsl.NodeTypeStatementBlock) >>
| TripleForContinuation "," TripleForContinuationItem
<<dsl.AppendChild($0, $2) >>
;
TripleForContinuationItem
: Assignment
| BareBoolean
;
TripleForUpdate
: empty
<< dsl.NewASTNodeZary(nil, dsl.NodeTypeStatementBlock) >>
| Assignment
<< dsl.NewASTNodeUnary(nil, $0, dsl.NodeTypeStatementBlock) >>
| TripleForUpdate "," Assignment
<<dsl.AppendChild($0, $2) >>
;
// ----------------------------------------------------------------
BreakStatement
: break
<< dsl.NewASTNodeZary($0, dsl.NodeTypeBreak) >>
;
ContinueStatement
: continue
<< dsl.NewASTNodeZary($0, dsl.NodeTypeContinue) >>
;
// ================================================================
// FUNCTION AND SUBROUTINE DEFINITIONS
// Example: 'func f(a, b) { return b - a }'
NamedFunctionDefinition
// Without return-type annotation
: func
non_sigil_name
"("
FuncOrSubrParameterList
")"
StatementBlockInBraces
<<
dsl.NewASTNodeBinary(
$1,
$3, // parameter list
$5, // { ... }
dsl.NodeTypeNamedFunctionDefinition,
);
>>
// With return-type annotation
| func
non_sigil_name
"("
FuncOrSubrParameterList
")"
":"
Typedecl
StatementBlockInBraces
<<
dsl.NewASTNodeTernary(
$1,
$3, // parameter list
$7, // {...}
$6, // return type
dsl.NodeTypeNamedFunctionDefinition,
);
>>
;
// Example: RHS of 'f = func (a, b) { return b - a }'
UnnamedFunctionDefinition
// Without return-type annotation
: func
"("
FuncOrSubrParameterList
")"
StatementBlockInBraces
<<
dsl.NewASTNodeBinary(
$0,
$2, // parameter list
$4, // { ... }
dsl.NodeTypeUnnamedFunctionDefinition,
);
>>
// With return-type annotation
| func
"("
FuncOrSubrParameterList
")"
":"
Typedecl
StatementBlockInBraces
<<
dsl.NewASTNodeTernary(
$0,
$2, // parameter list
$6, // {...}
$5, // return type
dsl.NodeTypeUnnamedFunctionDefinition,
);
>>
;
SubroutineDefinition
: subr
non_sigil_name
"("
FuncOrSubrParameterList
")"
StatementBlockInBraces
<<
dsl.NewASTNodeBinary(
$1,
$3, // parameter list
$5, // { ... }
dsl.NodeTypeSubroutineDefinition,
);
>>
;
// ----------------------------------------------------------------
FuncOrSubrParameterList
: empty
<< dsl.NewASTNodeZary(nil, dsl.NodeTypeParameterList) >>
| FuncOrSubrNonEmptyParameterList
<< dsl.Wrap($0) >>
;
FuncOrSubrNonEmptyParameterList
: FuncOrSubrParameter
<< dsl.NewASTNodeUnary(nil, $0, dsl.NodeTypeParameterList) >>
| FuncOrSubrParameter ","
<< dsl.NewASTNodeUnary(nil, $0, dsl.NodeTypeParameterList) >>
| FuncOrSubrParameter "," FuncOrSubrNonEmptyParameterList
<< dsl.PrependChild($2, $0) >>
;
FuncOrSubrParameter
// Untyped parameter, e.g. "x". Produce this AST:
// Parameter
// -> ParameterName "x"
: UntypedFuncOrSubrParameterName
<< dsl.NewASTNodeUnary(
nil,
$0,
dsl.NodeTypeParameter,
) >>
// Typed parameter, e.g. "num x". Produce this AST:
// Parameter
// -> ParameterName "x"
// -> Typedecl "num"
| TypedFuncOrSubrParameterName
<< dsl.NewASTNodeUnary(
nil,
$0,
dsl.NodeTypeParameter,
) >>
;
UntypedFuncOrSubrParameterName
: non_sigil_name
<< dsl.NewASTNode($0, dsl.NodeTypeParameterName) >>
;
TypedFuncOrSubrParameterName
: Typedecl UntypedFuncOrSubrParameterName
<< dsl.AppendChild($1, $0) >>
;
// ----------------------------------------------------------------
// Return statements for user-defined functions and subroutines
ReturnStatement
// For user-defined functions: return a value
: return Rvalue
<< dsl.NewASTNodeUnary($0, $1, dsl.NodeTypeReturn) >>
// For user-defined subroutines
| return
<< dsl.NewASTNodeZary($0, dsl.NodeTypeReturn) >>
;
Reference in a new issue View git blame Copy permalink