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 <- FnCC? KEYWORD_fn IDENTIFIER? LPAREN ParamDeclList RPAREN ByteAlign? LinkSection? EXCLAMATIONMARK? (KEYWORD_var / TypeExpr)
  23. VarDecl <- (KEYWORD_const / KEYWORD_var) IDENTIFIER (COLON TypeExpr)? ByteAlign? LinkSection? (EQUAL Expr)? SEMICOLON
  25. ContainerField <- IDENTIFIER (COLON TypeExpr)? (EQUAL Expr)?
  27. # *** Block Level ***
  28. Statement
  29.     <- KEYWORD_comptime? VarDecl
  30.      / KEYWORD_comptime BlockExprStatement
  31.      / KEYWORD_suspend (SEMICOLON / BlockExprStatement)
  32.      / KEYWORD_defer BlockExprStatement
  33.      / KEYWORD_errdefer BlockExprStatement
  34.      / IfStatement
  35.      / LabeledStatement
  36.      / SwitchExpr
  37.      / AssignExpr SEMICOLON
  39. IfStatement
  40.     <- IfPrefix BlockExpr ( KEYWORD_else Payload? Statement )?
  41.      / IfPrefix AssignExpr ( SEMICOLON / KEYWORD_else Payload? Statement )
  43. LabeledStatement <- BlockLabel? (Block / LoopStatement)
  45. LoopStatement <- KEYWORD_inline? (ForStatement / WhileStatement)
  47. ForStatement
  48.     <- ForPrefix BlockExpr ( KEYWORD_else Statement )?
  49.      / ForPrefix AssignExpr ( SEMICOLON / KEYWORD_else Statement )
  51. WhileStatement
  52.     <- WhilePrefix BlockExpr ( KEYWORD_else Payload? Statement )?
  53.      / WhilePrefix AssignExpr ( SEMICOLON / KEYWORD_else Payload? Statement )
  55. BlockExprStatement
  56.     <- BlockExpr
  57.      / AssignExpr SEMICOLON
  59. BlockExpr <- BlockLabel? Block
  61. # *** Expression Level ***
  62. AssignExpr <- Expr (AssignOp Expr)?
  64. Expr <- KEYWORD_try* BoolOrExpr
  66. BoolOrExpr <- BoolAndExpr (KEYWORD_or BoolAndExpr)*
  68. BoolAndExpr <- CompareExpr (KEYWORD_and CompareExpr)*
  70. CompareExpr <- BitwiseExpr (CompareOp BitwiseExpr)?
  72. BitwiseExpr <- BitShiftExpr (BitwiseOp BitShiftExpr)*
  74. BitShiftExpr <- AdditionExpr (BitShiftOp AdditionExpr)*
  76. AdditionExpr <- MultiplyExpr (AdditionOp MultiplyExpr)*
  78. MultiplyExpr <- PrefixExpr (MultiplyOp PrefixExpr)*
  80. PrefixExpr <- PrefixOp* PrimaryExpr
  82. PrimaryExpr
  83.     <- AsmExpr
  84.      / IfExpr
  85.      / KEYWORD_break BreakLabel? Expr?
  86.      / KEYWORD_comptime Expr
  87.      / KEYWORD_continue BreakLabel?
  88.      / KEYWORD_resume Expr
  89.      / KEYWORD_return Expr?
  90.      / BlockLabel? LoopExpr
  91.      / Block
  92.      / CurlySuffixExpr
  94. IfExpr <- IfPrefix Expr (KEYWORD_else Payload? Expr)?
  96. Block <- LBRACE Statement* RBRACE
  98. LoopExpr <- KEYWORD_inline? (ForExpr / WhileExpr)
  100. ForExpr <- ForPrefix Expr (KEYWORD_else Expr)?
  102. WhileExpr <- WhilePrefix Expr (KEYWORD_else Payload? Expr)?
  104. CurlySuffixExpr <- TypeExpr InitList?
  106. InitList
  107.     <- LBRACE FieldInit (COMMA FieldInit)* COMMA? RBRACE
  108.      / LBRACE Expr (COMMA Expr)* COMMA? RBRACE
  109.      / LBRACE RBRACE
  111. TypeExpr <- PrefixTypeOp* ErrorUnionExpr
  113. ErrorUnionExpr <- SuffixExpr (EXCLAMATIONMARK TypeExpr)?
  115. SuffixExpr
  116.     <- KEYWORD_async PrimaryTypeExpr SuffixOp* FnCallArguments
  117.      / PrimaryTypeExpr (SuffixOp / FnCallArguments)*
  119. PrimaryTypeExpr
  120.     <- BUILTINIDENTIFIER FnCallArguments
  121.      / CHAR_LITERAL
  122.      / ContainerDecl
  123.      / DOT IDENTIFIER
  124.      / DOT InitList
  125.      / ErrorSetDecl
  126.      / FLOAT
  127.      / FnProto
  128.      / GroupedExpr
  129.      / LabeledTypeExpr
  130.      / IDENTIFIER
  131.      / IfTypeExpr
  132.      / INTEGER
  133.      / KEYWORD_comptime TypeExpr
  134.      / KEYWORD_error DOT IDENTIFIER
  135.      / KEYWORD_false
  136.      / KEYWORD_null
  137.      / KEYWORD_promise
  138.      / KEYWORD_true
  139.      / KEYWORD_undefined
  140.      / KEYWORD_unreachable
  141.      / STRINGLITERAL
  142.      / SwitchExpr
  144. ContainerDecl <- (KEYWORD_extern / KEYWORD_packed)? ContainerDeclAuto
  146. ErrorSetDecl <- KEYWORD_error LBRACE IdentifierList RBRACE
  148. GroupedExpr <- LPAREN Expr RPAREN
  150. IfTypeExpr <- IfPrefix TypeExpr (KEYWORD_else Payload? TypeExpr)?
  152. LabeledTypeExpr
  153.     <- BlockLabel Block
  154.      / BlockLabel? LoopTypeExpr
  156. LoopTypeExpr <- KEYWORD_inline? (ForTypeExpr / WhileTypeExpr)
  158. ForTypeExpr <- ForPrefix TypeExpr (KEYWORD_else TypeExpr)?
  160. WhileTypeExpr <- WhilePrefix TypeExpr (KEYWORD_else Payload? TypeExpr)?
  162. SwitchExpr <- KEYWORD_switch LPAREN Expr RPAREN LBRACE SwitchProngList RBRACE
  164. # *** Assembly ***
  165. AsmExpr <- KEYWORD_asm KEYWORD_volatile? LPAREN STRINGLITERAL AsmOutput? RPAREN
  167. AsmOutput <- COLON AsmOutputList AsmInput?
  169. AsmOutputItem <- LBRACKET IDENTIFIER RBRACKET STRINGLITERAL LPAREN (MINUSRARROW TypeExpr / IDENTIFIER) RPAREN
  171. AsmInput <- COLON AsmInputList AsmClobbers?
  173. AsmInputItem <- LBRACKET IDENTIFIER RBRACKET STRINGLITERAL LPAREN Expr RPAREN
  175. AsmClobbers <- COLON StringList
  177. # *** Helper grammar ***
  178. BreakLabel <- COLON IDENTIFIER
  180. BlockLabel <- IDENTIFIER COLON
  182. FieldInit <- DOT IDENTIFIER EQUAL Expr
  184. WhileContinueExpr <- COLON LPAREN AssignExpr RPAREN
  186. LinkSection <- KEYWORD_linksection LPAREN Expr RPAREN
  188. # Fn specific
  189. FnCC
  190.     <- KEYWORD_extern
  191.      / KEYWORD_async
  193. ParamDecl <- (KEYWORD_noalias / KEYWORD_comptime)? (IDENTIFIER COLON)? ParamType
  195. ParamType
  196.     <- KEYWORD_var
  197.      / DOT3
  198.      / TypeExpr
  200. # Control flow prefixes
  201. IfPrefix <- KEYWORD_if LPAREN Expr RPAREN PtrPayload?
  203. WhilePrefix <- KEYWORD_while LPAREN Expr RPAREN PtrPayload? WhileContinueExpr?
  205. ForPrefix <- KEYWORD_for LPAREN Expr RPAREN PtrIndexPayload
  207. # Payloads
  208. Payload <- PIPE IDENTIFIER PIPE
  210. PtrPayload <- PIPE ASTERISK? IDENTIFIER PIPE
  212. PtrIndexPayload <- PIPE ASTERISK? IDENTIFIER (COMMA IDENTIFIER)? PIPE
  215. # Switch specific
  216. SwitchProng <- SwitchCase EQUALRARROW PtrPayload? AssignExpr
  218. SwitchCase
  219.     <- SwitchItem (COMMA SwitchItem)* COMMA?
  220.      / KEYWORD_else
  222. SwitchItem <- Expr (DOT3 Expr)?
  224. # Operators
  225. AssignOp
  226.     <- ASTERISKEQUAL
  227.      / SLASHEQUAL
  228.      / PERCENTEQUAL
  229.      / PLUSEQUAL
  230.      / MINUSEQUAL
  231.      / LARROW2EQUAL
  232.      / RARROW2EQUAL
  233.      / AMPERSANDEQUAL
  234.      / CARETEQUAL
  235.      / PIPEEQUAL
  236.      / ASTERISKPERCENTEQUAL
  237.      / PLUSPERCENTEQUAL
  238.      / MINUSPERCENTEQUAL
  239.      / EQUAL
  241. CompareOp
  242.     <- EQUALEQUAL
  243.      / EXCLAMATIONMARKEQUAL
  244.      / LARROW
  245.      / RARROW
  246.      / LARROWEQUAL
  247.      / RARROWEQUAL
  249. BitwiseOp
  250.     <- AMPERSAND
  251.      / CARET
  252.      / PIPE
  253.      / KEYWORD_orelse
  254.      / KEYWORD_catch Payload?
  256. BitShiftOp
  257.     <- LARROW2
  258.      / RARROW2
  260. AdditionOp
  261.     <- PLUS
  262.      / MINUS
  263.      / PLUS2
  264.      / PLUSPERCENT
  265.      / MINUSPERCENT
  267. MultiplyOp
  268.     <- PIPE2
  269.      / ASTERISK
  270.      / SLASH
  271.      / PERCENT
  272.      / ASTERISK2
  273.      / ASTERISKPERCENT
  275. PrefixOp
  276.     <- EXCLAMATIONMARK
  277.      / MINUS
  278.      / TILDE
  279.      / MINUSPERCENT
  280.      / AMPERSAND
  281.      / KEYWORD_try
  282.      / KEYWORD_await
  284. PrefixTypeOp
  285.     <- QUESTIONMARK
  286.      / KEYWORD_promise MINUSRARROW
  287.      / ArrayTypeStart (ByteAlign / KEYWORD_const / KEYWORD_volatile / KEYWORD_allowzero)*
  288.      / PtrTypeStart (KEYWORD_align LPAREN Expr (COLON INTEGER COLON INTEGER)? RPAREN / KEYWORD_const / KEYWORD_volatile / KEYWORD_allowzero)*
  290. SuffixOp
  291.     <- LBRACKET Expr (DOT2 Expr?)? RBRACKET
  292.      / DOT IDENTIFIER
  293.      / DOTASTERISK
  294.      / DOTQUESTIONMARK
  296. FnCallArguments <- LPAREN ExprList RPAREN
  298. # Ptr specific
  299. ArrayTypeStart <- LBRACKET Expr? RBRACKET
  301. PtrTypeStart
  302.     <- ASTERISK
  303.      / ASTERISK2
  304.      / PTRUNKNOWN
  305.      / PTRC
  307. # ContainerDecl specific
  308. ContainerDeclAuto <- ContainerDeclType LBRACE ContainerMembers RBRACE
  310. ContainerDeclType
  311.     <- (KEYWORD_struct / KEYWORD_enum) (LPAREN Expr RPAREN)?
  312.      / KEYWORD_union (LPAREN (KEYWORD_enum (LPAREN Expr RPAREN)? / Expr) RPAREN)?
  314. # Alignment
  315. ByteAlign <- KEYWORD_align LPAREN Expr RPAREN
  317. # Lists
  318. IdentifierList <- (IDENTIFIER COMMA)* IDENTIFIER?
  320. SwitchProngList <- (SwitchProng COMMA)* SwitchProng?
  322. AsmOutputList <- (AsmOutputItem COMMA)* AsmOutputItem?
  324. AsmInputList <- (AsmInputItem COMMA)* AsmInputItem?
  326. StringList <- (STRINGLITERAL COMMA)* STRINGLITERAL?
  328. ParamDeclList <- (ParamDecl COMMA)* ParamDecl?
  330. ExprList <- (Expr COMMA)* Expr?
  332. # *** Tokens ***
  333. eof <- !.
  334. hex <- [0-9a-fA-F]
  335. char_escape
  336.     <- "\\x" hex hex
  337.      / "\\u{" hex+ "}"
  338.      / "\\" [nr\\t'"]
  339. char_char
  340.     <- char_escape
  341.      / [^\\'\n]
  342. string_char
  343.     <- char_escape
  344.      / [^\\"\n]
  346. line_comment <- '//'[^\n]*
  347. line_string <- ("\\\\" [^\n]* [ \n]*)+
  348. skip <- ([ \n] / line_comment)*
  350. CHAR_LITERAL <- "'" char_char "'" skip
  351. FLOAT
  352.     <- "0x" hex+   "." hex+   ([pP] [-+]? hex+)?   skip
  353.      /      [0-9]+ "." [0-9]+ ([eE] [-+]? [0-9]+)? skip
  354.      / "0x" hex+   "."? [pP] [-+]? hex+   skip
  355.      /      [0-9]+ "."? [eE] [-+]? [0-9]+ skip
  356. INTEGER
  357.     <- "0b" [01]+  skip
  358.      / "0o" [0-7]+ skip
  359.      / "0x" hex+   skip
  360.      /      [0-9]+ skip
  361. STRINGLITERALSINGLE <- "\"" string_char* "\"" skip
  362. STRINGLITERAL
  363.     <- STRINGLITERALSINGLE
  364.      / line_string                 skip
  365. IDENTIFIER
  366.     <- !keyword [A-Za-z_] [A-Za-z0-9_]* skip
  367.      / "@\"" string_char* "\""                            skip
  368. BUILTINIDENTIFIER <- "@"[A-Za-z_][A-Za-z0-9_]* skip
  371. AMPERSAND            <- '&'      ![=]      skip
  372. AMPERSANDEQUAL       <- '&='               skip
  373. ASTERISK             <- '*'      ![*%=]    skip
  374. ASTERISK2            <- '**'               skip
  375. ASTERISKEQUAL        <- '*='               skip
  376. ASTERISKPERCENT      <- '*%'     ![=]      skip
  377. ASTERISKPERCENTEQUAL <- '*%='              skip
  378. CARET                <- '^'      ![=]      skip
  379. CARETEQUAL           <- '^='               skip
  380. COLON                <- ':'                skip
  381. COMMA                <- ','                skip
  382. DOT                  <- '.'      ![*.?]    skip
  383. DOT2                 <- '..'     ![.]      skip
  384. DOT3                 <- '...'              skip
  385. DOTASTERISK          <- '.*'               skip
  386. DOTQUESTIONMARK      <- '.?'               skip
  387. EQUAL                <- '='      ![>=]     skip
  388. EQUALEQUAL           <- '=='               skip
  389. EQUALRARROW          <- '=>'               skip
  390. EXCLAMATIONMARK      <- '!'      ![=]      skip
  391. EXCLAMATIONMARKEQUAL <- '!='               skip
  392. LARROW               <- '<'      ![<=]     skip
  393. LARROW2              <- '<<'     ![=]      skip
  394. LARROW2EQUAL         <- '<<='              skip
  395. LARROWEQUAL          <- '<='               skip
  396. LBRACE               <- '{'                skip
  397. LBRACKET             <- '['      ![*]      skip
  398. LPAREN               <- '('                skip
  399. MINUS                <- '-'      ![%=>]    skip
  400. MINUSEQUAL           <- '-='               skip
  401. MINUSPERCENT         <- '-%'     ![=]      skip
  402. MINUSPERCENTEQUAL    <- '-%='              skip
  403. MINUSRARROW          <- '->'               skip
  404. PERCENT              <- '%'      ![=]      skip
  405. PERCENTEQUAL         <- '%='               skip
  406. PIPE                 <- '|'      ![|=]     skip
  407. PIPE2                <- '||'               skip
  408. PIPEEQUAL            <- '|='               skip
  409. PLUS                 <- '+'      ![%+=]    skip
  410. PLUS2                <- '++'               skip
  411. PLUSEQUAL            <- '+='               skip
  412. PLUSPERCENT          <- '+%'     ![=]      skip
  413. PLUSPERCENTEQUAL     <- '+%='              skip
  414. PTRC                 <- '[*c]'             skip
  415. PTRUNKNOWN           <- '[*]'              skip
  416. QUESTIONMARK         <- '?'                skip
  417. RARROW               <- '>'      ![>=]     skip
  418. RARROW2              <- '>>'     ![=]      skip
  419. RARROW2EQUAL         <- '>>='              skip
  420. RARROWEQUAL          <- '>='               skip
  421. RBRACE               <- '}'                skip
  422. RBRACKET             <- ']'                skip
  423. RPAREN               <- ')'                skip
  424. SEMICOLON            <- ';'                skip
  425. SLASH                <- '/'      ![=]      skip
  426. SLASHEQUAL           <- '/='               skip
  427. TILDE                <- '~'                skip
  429. end_of_word <- ![a-zA-Z0-9_] skip
  430. KEYWORD_align       <- 'align'       end_of_word
  431. KEYWORD_allowzero   <- 'allowzero'   end_of_word
  432. KEYWORD_and         <- 'and'         end_of_word
  433. KEYWORD_asm         <- 'asm'         end_of_word
  434. KEYWORD_async       <- 'async'       end_of_word
  435. KEYWORD_await       <- 'await'       end_of_word
  436. KEYWORD_break       <- 'break'       end_of_word
  437. KEYWORD_catch       <- 'catch'       end_of_word
  438. KEYWORD_comptime    <- 'comptime'    end_of_word
  439. KEYWORD_const       <- 'const'       end_of_word
  440. KEYWORD_continue    <- 'continue'    end_of_word
  441. KEYWORD_defer       <- 'defer'       end_of_word
  442. KEYWORD_else        <- 'else'        end_of_word
  443. KEYWORD_enum        <- 'enum'        end_of_word
  444. KEYWORD_errdefer    <- 'errdefer'    end_of_word
  445. KEYWORD_error       <- 'error'       end_of_word
  446. KEYWORD_export      <- 'export'      end_of_word
  447. KEYWORD_extern      <- 'extern'      end_of_word
  448. KEYWORD_false       <- 'false'       end_of_word
  449. KEYWORD_fn          <- 'fn'          end_of_word
  450. KEYWORD_for         <- 'for'         end_of_word
  451. KEYWORD_if          <- 'if'          end_of_word
  452. KEYWORD_inline      <- 'inline'      end_of_word
  453. KEYWORD_noalias     <- 'noalias'     end_of_word
  454. KEYWORD_null        <- 'null'        end_of_word
  455. KEYWORD_or          <- 'or'          end_of_word
  456. KEYWORD_orelse      <- 'orelse'      end_of_word
  457. KEYWORD_packed      <- 'packed'      end_of_word
  458. KEYWORD_promise     <- 'promise'     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_allowzero / KEYWORD_asm
  479.          / 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_or
  485.          / KEYWORD_orelse / KEYWORD_packed / KEYWORD_promise / 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