Grammar

  1. Root <- skip ContainerMembers eof
  3. # *** Top level ***
  4. ContainerMembers
  5.     <- TestDecl ContainerMembers
  6.      / TopLevelComptime ContainerMembers
  7.      / KEYWORD_pub? TopLevelDecl ContainerMembers
  8.      / ContainerField COMMA ContainerMembers
  9.      / ContainerField
  10.      /
  12. TestDecl <- KEYWORD_test STRINGLITERALSINGLE Block
  14. TopLevelComptime <- KEYWORD_comptime BlockExpr
  16. TopLevelDecl
  17.     <- (KEYWORD_export / KEYWORD_extern STRINGLITERALSINGLE? / KEYWORD_inline)? FnProto (SEMICOLON / Block)
  18.      / (KEYWORD_export / KEYWORD_extern STRINGLITERALSINGLE?)? KEYWORD_threadlocal? VarDecl
  19.      / KEYWORD_usingnamespace Expr SEMICOLON
  21. FnProto <- KEYWORD_fn IDENTIFIER? LPAREN ParamDeclList RPAREN ByteAlign? LinkSection? EXCLAMATIONMARK? (KEYWORD_anytype / TypeExpr)
  23. VarDecl <- (KEYWORD_const / KEYWORD_var) IDENTIFIER (COLON TypeExpr)? ByteAlign? LinkSection? (EQUAL Expr)? SEMICOLON
  25. ContainerField <- KEYWORD_comptime? IDENTIFIER (COLON TypeExpr)? (EQUAL Expr)?
  27. # *** Block Level ***
  28. Statement
  29.     <- KEYWORD_comptime? VarDecl
  30.      / KEYWORD_comptime BlockExprStatement
  31.      / KEYWORD_nosuspend BlockExprStatement
  32.      / KEYWORD_suspend (SEMICOLON / BlockExprStatement)
  33.      / KEYWORD_defer BlockExprStatement
  34.      / KEYWORD_errdefer BlockExprStatement
  35.      / IfStatement
  36.      / LabeledStatement
  37.      / SwitchExpr
  38.      / AssignExpr SEMICOLON
  40. IfStatement
  41.     <- IfPrefix BlockExpr ( KEYWORD_else Payload? Statement )?
  42.      / IfPrefix AssignExpr ( SEMICOLON / KEYWORD_else Payload? Statement )
  44. LabeledStatement <- BlockLabel? (Block / LoopStatement)
  46. LoopStatement <- KEYWORD_inline? (ForStatement / WhileStatement)
  48. ForStatement
  49.     <- ForPrefix BlockExpr ( KEYWORD_else Statement )?
  50.      / ForPrefix AssignExpr ( SEMICOLON / KEYWORD_else Statement )
  52. WhileStatement
  53.     <- WhilePrefix BlockExpr ( KEYWORD_else Payload? Statement )?
  54.      / WhilePrefix AssignExpr ( SEMICOLON / KEYWORD_else Payload? Statement )
  56. BlockExprStatement
  57.     <- BlockExpr
  58.      / AssignExpr SEMICOLON
  60. BlockExpr <- BlockLabel? Block
  62. # *** Expression Level ***
  63. AssignExpr <- Expr (AssignOp Expr)?
  65. Expr <- KEYWORD_try* BoolOrExpr
  67. BoolOrExpr <- BoolAndExpr (KEYWORD_or BoolAndExpr)*
  69. BoolAndExpr <- CompareExpr (KEYWORD_and CompareExpr)*
  71. CompareExpr <- BitwiseExpr (CompareOp BitwiseExpr)?
  73. BitwiseExpr <- BitShiftExpr (BitwiseOp BitShiftExpr)*
  75. BitShiftExpr <- AdditionExpr (BitShiftOp AdditionExpr)*
  77. AdditionExpr <- MultiplyExpr (AdditionOp MultiplyExpr)*
  79. MultiplyExpr <- PrefixExpr (MultiplyOp PrefixExpr)*
  81. PrefixExpr <- PrefixOp* PrimaryExpr
  83. PrimaryExpr
  84.     <- AsmExpr
  85.      / IfExpr
  86.      / KEYWORD_break BreakLabel? Expr?
  87.      / KEYWORD_comptime Expr
  88.      / KEYWORD_nosuspend Expr
  89.      / KEYWORD_continue BreakLabel?
  90.      / KEYWORD_resume Expr
  91.      / KEYWORD_return Expr?
  92.      / BlockLabel? LoopExpr
  93.      / Block
  94.      / CurlySuffixExpr
  96. IfExpr <- IfPrefix Expr (KEYWORD_else Payload? Expr)?
  98. Block <- LBRACE Statement* RBRACE
  100. LoopExpr <- KEYWORD_inline? (ForExpr / WhileExpr)
  102. ForExpr <- ForPrefix Expr (KEYWORD_else Expr)?
  104. WhileExpr <- WhilePrefix Expr (KEYWORD_else Payload? Expr)?
  106. CurlySuffixExpr <- TypeExpr InitList?
  108. InitList
  109.     <- LBRACE FieldInit (COMMA FieldInit)* COMMA? RBRACE
  110.      / LBRACE Expr (COMMA Expr)* COMMA? RBRACE
  111.      / LBRACE RBRACE
  113. TypeExpr <- PrefixTypeOp* ErrorUnionExpr
  115. ErrorUnionExpr <- SuffixExpr (EXCLAMATIONMARK TypeExpr)?
  117. SuffixExpr
  118.     <- KEYWORD_async PrimaryTypeExpr SuffixOp* FnCallArguments
  119.      / PrimaryTypeExpr (SuffixOp / FnCallArguments)*
  121. PrimaryTypeExpr
  122.     <- BUILTINIDENTIFIER FnCallArguments
  123.      / CHAR_LITERAL
  124.      / ContainerDecl
  125.      / DOT IDENTIFIER
  126.      / DOT InitList
  127.      / ErrorSetDecl
  128.      / FLOAT
  129.      / FnProto
  130.      / GroupedExpr
  131.      / LabeledTypeExpr
  132.      / IDENTIFIER
  133.      / IfTypeExpr
  134.      / INTEGER
  135.      / KEYWORD_comptime TypeExpr
  136.      / KEYWORD_error DOT IDENTIFIER
  137.      / KEYWORD_false
  138.      / KEYWORD_null
  139.      / KEYWORD_anyframe
  140.      / KEYWORD_true
  141.      / KEYWORD_undefined
  142.      / KEYWORD_unreachable
  143.      / STRINGLITERAL
  144.      / SwitchExpr
  146. ContainerDecl <- (KEYWORD_extern / KEYWORD_packed)? ContainerDeclAuto
  148. ErrorSetDecl <- KEYWORD_error LBRACE IdentifierList RBRACE
  150. GroupedExpr <- LPAREN Expr RPAREN
  152. IfTypeExpr <- IfPrefix TypeExpr (KEYWORD_else Payload? TypeExpr)?
  154. LabeledTypeExpr
  155.     <- BlockLabel Block
  156.      / BlockLabel? LoopTypeExpr
  158. LoopTypeExpr <- KEYWORD_inline? (ForTypeExpr / WhileTypeExpr)
  160. ForTypeExpr <- ForPrefix TypeExpr (KEYWORD_else TypeExpr)?
  162. WhileTypeExpr <- WhilePrefix TypeExpr (KEYWORD_else Payload? TypeExpr)?
  164. SwitchExpr <- KEYWORD_switch LPAREN Expr RPAREN LBRACE SwitchProngList RBRACE
  166. # *** Assembly ***
  167. AsmExpr <- KEYWORD_asm KEYWORD_volatile? LPAREN STRINGLITERAL AsmOutput? RPAREN
  169. AsmOutput <- COLON AsmOutputList AsmInput?
  171. AsmOutputItem <- LBRACKET IDENTIFIER RBRACKET STRINGLITERAL LPAREN (MINUSRARROW TypeExpr / IDENTIFIER) RPAREN
  173. AsmInput <- COLON AsmInputList AsmClobbers?
  175. AsmInputItem <- LBRACKET IDENTIFIER RBRACKET STRINGLITERAL LPAREN Expr RPAREN
  177. AsmClobbers <- COLON StringList
  179. # *** Helper grammar ***
  180. BreakLabel <- COLON IDENTIFIER
  182. BlockLabel <- IDENTIFIER COLON
  184. FieldInit <- DOT IDENTIFIER EQUAL Expr
  186. WhileContinueExpr <- COLON LPAREN AssignExpr RPAREN
  188. LinkSection <- KEYWORD_linksection LPAREN Expr RPAREN
  190. ParamDecl <- (KEYWORD_noalias / KEYWORD_comptime)? (IDENTIFIER COLON)? ParamType
  192. ParamType
  193.     <- KEYWORD_anytype
  194.      / DOT3
  195.      / TypeExpr
  197. # Control flow prefixes
  198. IfPrefix <- KEYWORD_if LPAREN Expr RPAREN PtrPayload?
  200. WhilePrefix <- KEYWORD_while LPAREN Expr RPAREN PtrPayload? WhileContinueExpr?
  202. ForPrefix <- KEYWORD_for LPAREN Expr RPAREN PtrIndexPayload
  204. # Payloads
  205. Payload <- PIPE IDENTIFIER PIPE
  207. PtrPayload <- PIPE ASTERISK? IDENTIFIER PIPE
  209. PtrIndexPayload <- PIPE ASTERISK? IDENTIFIER (COMMA IDENTIFIER)? PIPE
  212. # Switch specific
  213. SwitchProng <- SwitchCase EQUALRARROW PtrPayload? AssignExpr
  215. SwitchCase
  216.     <- SwitchItem (COMMA SwitchItem)* COMMA?
  217.      / KEYWORD_else
  219. SwitchItem <- Expr (DOT3 Expr)?
  221. # Operators
  222. AssignOp
  223.     <- ASTERISKEQUAL
  224.      / SLASHEQUAL
  225.      / PERCENTEQUAL
  226.      / PLUSEQUAL
  227.      / MINUSEQUAL
  228.      / LARROW2EQUAL
  229.      / RARROW2EQUAL
  230.      / AMPERSANDEQUAL
  231.      / CARETEQUAL
  232.      / PIPEEQUAL
  233.      / ASTERISKPERCENTEQUAL
  234.      / PLUSPERCENTEQUAL
  235.      / MINUSPERCENTEQUAL
  236.      / EQUAL
  238. CompareOp
  239.     <- EQUALEQUAL
  240.      / EXCLAMATIONMARKEQUAL
  241.      / LARROW
  242.      / RARROW
  243.      / LARROWEQUAL
  244.      / RARROWEQUAL
  246. BitwiseOp
  247.     <- AMPERSAND
  248.      / CARET
  249.      / PIPE
  250.      / KEYWORD_orelse
  251.      / KEYWORD_catch Payload?
  253. BitShiftOp
  254.     <- LARROW2
  255.      / RARROW2
  257. AdditionOp
  258.     <- PLUS
  259.      / MINUS
  260.      / PLUS2
  261.      / PLUSPERCENT
  262.      / MINUSPERCENT
  264. MultiplyOp
  265.     <- PIPE2
  266.      / ASTERISK
  267.      / SLASH
  268.      / PERCENT
  269.      / ASTERISK2
  270.      / ASTERISKPERCENT
  272. PrefixOp
  273.     <- EXCLAMATIONMARK
  274.      / MINUS
  275.      / TILDE
  276.      / MINUSPERCENT
  277.      / AMPERSAND
  278.      / KEYWORD_try
  279.      / KEYWORD_await
  281. PrefixTypeOp
  282.     <- QUESTIONMARK
  283.      / KEYWORD_anyframe MINUSRARROW
  284.      / ArrayTypeStart (ByteAlign / KEYWORD_const / KEYWORD_volatile / KEYWORD_allowzero)*
  285.      / PtrTypeStart (KEYWORD_align LPAREN Expr (COLON INTEGER COLON INTEGER)? RPAREN / KEYWORD_const / KEYWORD_volatile / KEYWORD_allowzero)*
  287. SuffixOp
  288.     <- LBRACKET Expr (DOT2 Expr?)? RBRACKET
  289.      / DOT IDENTIFIER
  290.      / DOTASTERISK
  291.      / DOTQUESTIONMARK
  293. FnCallArguments <- LPAREN ExprList RPAREN
  295. # Ptr specific
  296. ArrayTypeStart <- LBRACKET Expr? RBRACKET
  298. PtrTypeStart
  299.     <- ASTERISK
  300.      / ASTERISK2
  301.      / PTRUNKNOWN
  302.      / PTRC
  304. # ContainerDecl specific
  305. ContainerDeclAuto <- ContainerDeclType LBRACE ContainerMembers RBRACE
  307. ContainerDeclType
  308.     <- (KEYWORD_struct / KEYWORD_enum / KEYWORD_opaque) (LPAREN Expr RPAREN)?
  309.      / KEYWORD_union (LPAREN (KEYWORD_enum (LPAREN Expr RPAREN)? / Expr) RPAREN)?
  311. # Alignment
  312. ByteAlign <- KEYWORD_align LPAREN Expr RPAREN
  314. # Lists
  315. IdentifierList <- (IDENTIFIER COMMA)* IDENTIFIER?
  317. SwitchProngList <- (SwitchProng COMMA)* SwitchProng?
  319. AsmOutputList <- (AsmOutputItem COMMA)* AsmOutputItem?
  321. AsmInputList <- (AsmInputItem COMMA)* AsmInputItem?
  323. StringList <- (STRINGLITERAL COMMA)* STRINGLITERAL?
  325. ParamDeclList <- (ParamDecl COMMA)* ParamDecl?
  327. ExprList <- (Expr COMMA)* Expr?
  329. # *** Tokens ***
  330. eof <- !.
  331. hex <- [0-9a-fA-F]
  332. char_escape
  333.     <- "\\x" hex hex
  334.      / "\\u{" hex+ "}"
  335.      / "\\" [nr\\t'"]
  336. char_char
  337.     <- char_escape
  338.      / [^\\'\n]
  339. string_char
  340.     <- char_escape
  341.      / [^\\"\n]
  343. line_comment <- '//'[^\n]*
  344. line_string <- ("\\\\" [^\n]* [ \n]*)+
  345. skip <- ([ \n] / line_comment)*
  347. CHAR_LITERAL <- "'" char_char "'" skip
  348. FLOAT
  349.     <- "0x" hex+   "." hex+   ([pP] [-+]? hex+)?   skip
  350.      /      [0-9]+ "." [0-9]+ ([eE] [-+]? [0-9]+)? skip
  351.      / "0x" hex+   "."? [pP] [-+]? hex+   skip
  352.      /      [0-9]+ "."? [eE] [-+]? [0-9]+ skip
  353. INTEGER
  354.     <- "0b" [01]+  skip
  355.      / "0o" [0-7]+ skip
  356.      / "0x" hex+   skip
  357.      /      [0-9]+ skip
  358. STRINGLITERALSINGLE <- "\"" string_char* "\"" skip
  359. STRINGLITERAL
  360.     <- STRINGLITERALSINGLE
  361.      / line_string                 skip
  362. IDENTIFIER
  363.     <- !keyword [A-Za-z_] [A-Za-z0-9_]* skip
  364.      / "@\"" string_char* "\""                            skip
  365. BUILTINIDENTIFIER <- "@"[A-Za-z_][A-Za-z0-9_]* skip
  368. AMPERSAND            <- '&'      ![=]      skip
  369. AMPERSANDEQUAL       <- '&='               skip
  370. ASTERISK             <- '*'      ![*%=]    skip
  371. ASTERISK2            <- '**'               skip
  372. ASTERISKEQUAL        <- '*='               skip
  373. ASTERISKPERCENT      <- '*%'     ![=]      skip
  374. ASTERISKPERCENTEQUAL <- '*%='              skip
  375. CARET                <- '^'      ![=]      skip
  376. CARETEQUAL           <- '^='               skip
  377. COLON                <- ':'                skip
  378. COMMA                <- ','                skip
  379. DOT                  <- '.'      ![*.?]    skip
  380. DOT2                 <- '..'     ![.]      skip
  381. DOT3                 <- '...'              skip
  382. DOTASTERISK          <- '.*'               skip
  383. DOTQUESTIONMARK      <- '.?'               skip
  384. EQUAL                <- '='      ![>=]     skip
  385. EQUALEQUAL           <- '=='               skip
  386. EQUALRARROW          <- '=>'               skip
  387. EXCLAMATIONMARK      <- '!'      ![=]      skip
  388. EXCLAMATIONMARKEQUAL <- '!='               skip
  389. LARROW               <- '<'      ![<=]     skip
  390. LARROW2              <- '<<'     ![=]      skip
  391. LARROW2EQUAL         <- '<<='              skip
  392. LARROWEQUAL          <- '<='               skip
  393. LBRACE               <- '{'                skip
  394. LBRACKET             <- '['      ![*]      skip
  395. LPAREN               <- '('                skip
  396. MINUS                <- '-'      ![%=>]    skip
  397. MINUSEQUAL           <- '-='               skip
  398. MINUSPERCENT         <- '-%'     ![=]      skip
  399. MINUSPERCENTEQUAL    <- '-%='              skip
  400. MINUSRARROW          <- '->'               skip
  401. PERCENT              <- '%'      ![=]      skip
  402. PERCENTEQUAL         <- '%='               skip
  403. PIPE                 <- '|'      ![|=]     skip
  404. PIPE2                <- '||'               skip
  405. PIPEEQUAL            <- '|='               skip
  406. PLUS                 <- '+'      ![%+=]    skip
  407. PLUS2                <- '++'               skip
  408. PLUSEQUAL            <- '+='               skip
  409. PLUSPERCENT          <- '+%'     ![=]      skip
  410. PLUSPERCENTEQUAL     <- '+%='              skip
  411. PTRC                 <- '[*c]'             skip
  412. PTRUNKNOWN           <- '[*]'              skip
  413. QUESTIONMARK         <- '?'                skip
  414. RARROW               <- '>'      ![>=]     skip
  415. RARROW2              <- '>>'     ![=]      skip
  416. RARROW2EQUAL         <- '>>='              skip
  417. RARROWEQUAL          <- '>='               skip
  418. RBRACE               <- '}'                skip
  419. RBRACKET             <- ']'                skip
  420. RPAREN               <- ')'                skip
  421. SEMICOLON            <- ';'                skip
  422. SLASH                <- '/'      ![=]      skip
  423. SLASHEQUAL           <- '/='               skip
  424. TILDE                <- '~'                skip
  426. end_of_word <- ![a-zA-Z0-9_] skip
  427. KEYWORD_align       <- 'align'       end_of_word
  428. KEYWORD_allowzero   <- 'allowzero'   end_of_word
  429. KEYWORD_and         <- 'and'         end_of_word
  430. KEYWORD_anyframe    <- 'anyframe'    end_of_word
  431. KEYWORD_anytype     <- 'anytype'     end_of_word
  432. KEYWORD_asm         <- 'asm'         end_of_word
  433. KEYWORD_async       <- 'async'       end_of_word
  434. KEYWORD_await       <- 'await'       end_of_word
  435. KEYWORD_break       <- 'break'       end_of_word
  436. KEYWORD_catch       <- 'catch'       end_of_word
  437. KEYWORD_comptime    <- 'comptime'    end_of_word
  438. KEYWORD_const       <- 'const'       end_of_word
  439. KEYWORD_continue    <- 'continue'    end_of_word
  440. KEYWORD_defer       <- 'defer'       end_of_word
  441. KEYWORD_else        <- 'else'        end_of_word
  442. KEYWORD_enum        <- 'enum'        end_of_word
  443. KEYWORD_errdefer    <- 'errdefer'    end_of_word
  444. KEYWORD_error       <- 'error'       end_of_word
  445. KEYWORD_export      <- 'export'      end_of_word
  446. KEYWORD_extern      <- 'extern'      end_of_word
  447. KEYWORD_false       <- 'false'       end_of_word
  448. KEYWORD_fn          <- 'fn'          end_of_word
  449. KEYWORD_for         <- 'for'         end_of_word
  450. KEYWORD_if          <- 'if'          end_of_word
  451. KEYWORD_inline      <- 'inline'      end_of_word
  452. KEYWORD_noalias     <- 'noalias'     end_of_word
  453. KEYWORD_nosuspend   <- 'nosuspend'   end_of_word
  454. KEYWORD_null        <- 'null'        end_of_word
  455. KEYWORD_opaque      <- 'opaque'      end_of_word
  456. KEYWORD_or          <- 'or'          end_of_word
  457. KEYWORD_orelse      <- 'orelse'      end_of_word
  458. KEYWORD_packed      <- 'packed'      end_of_word
  459. KEYWORD_pub         <- 'pub'         end_of_word
  460. KEYWORD_resume      <- 'resume'      end_of_word
  461. KEYWORD_return      <- 'return'      end_of_word
  462. KEYWORD_linksection <- 'linksection' end_of_word
  463. KEYWORD_struct      <- 'struct'      end_of_word
  464. KEYWORD_suspend     <- 'suspend'     end_of_word
  465. KEYWORD_switch      <- 'switch'      end_of_word
  466. KEYWORD_test        <- 'test'        end_of_word
  467. KEYWORD_threadlocal <- 'threadlocal' end_of_word
  468. KEYWORD_true        <- 'true'        end_of_word
  469. KEYWORD_try         <- 'try'         end_of_word
  470. KEYWORD_undefined   <- 'undefined'   end_of_word
  471. KEYWORD_union       <- 'union'       end_of_word
  472. KEYWORD_unreachable <- 'unreachable' end_of_word
  473. KEYWORD_usingnamespace <- 'usingnamespace' end_of_word
  474. KEYWORD_var         <- 'var'         end_of_word
  475. KEYWORD_volatile    <- 'volatile'    end_of_word
  476. KEYWORD_while       <- 'while'       end_of_word
  478. keyword <- KEYWORD_align / KEYWORD_and / KEYWORD_anyframe / KEYWORD_anytype
  479.          / KEYWORD_allowzero / KEYWORD_asm / KEYWORD_async / KEYWORD_await / KEYWORD_break
  480.          / KEYWORD_catch / KEYWORD_comptime / KEYWORD_const / KEYWORD_continue
  481.          / KEYWORD_defer / KEYWORD_else / KEYWORD_enum / KEYWORD_errdefer
  482.          / KEYWORD_error / KEYWORD_export / KEYWORD_extern / KEYWORD_false
  483.          / KEYWORD_fn / KEYWORD_for / KEYWORD_if / KEYWORD_inline
  484.          / KEYWORD_noalias / KEYWORD_null / KEYWORD_opaque / KEYWORD_or
  485.          / KEYWORD_orelse / KEYWORD_packed / KEYWORD_pub
  486.          / KEYWORD_resume / KEYWORD_return / KEYWORD_linksection
  487.          / KEYWORD_struct / KEYWORD_suspend
  488.          / KEYWORD_switch / KEYWORD_test / KEYWORD_threadlocal / KEYWORD_true / KEYWORD_try
  489.          / KEYWORD_undefined / KEYWORD_union / KEYWORD_unreachable
  490.          / KEYWORD_usingnamespace / KEYWORD_var / KEYWORD_volatile / KEYWORD_while