Class Parser

Constructors

constructor

new Parser(code, tokens, errorCollector): Parser
Parameters
- code: CodeFile
- tokens: Token[]
- errorCollector: ErrorCollector
Returns Parser
- Defined in src/Parser.ts:106

Properties

code

The code file being parsed.

`Protected`currentToken

currentToken: number = 0

errorCollector

errorCollector: ErrorCollector

The ErrorCollector for this parser. All the errors encountered by the parser will be put there, since it does not throw on non-fatal errors.

tokens

tokens: Token[]

The tokens being parsed. They have to be provided from the lexer

See

[[Lexer.scan]]

Methods

`Protected`addition

addition(): Expression
Returns Expression
- Defined in src/Parser.ts:738

`Protected`advance

advance(): Token
Returns Token
- Defined in src/Parser.ts:1193

`Protected`anonymousFunction

anonymousFunction(): AnonymousFunctionExpr
Returns AnonymousFunctionExpr
- Defined in src/Parser.ts:1033

`Protected`args

args(allowPositional?, forceType?): AssignmentNode[]
Parses an argument list including the finishing paren. Can handle trailing and extra commas as well as an empty arguments list. The initial paren must be consumed.
Parameters
- allowPositional: boolean = false
  Set to true when in call mode, positional arguments will be allowed.
- forceType: null | AssignmentNodeRole = null
Returns AssignmentNode[]
- Defined in src/Parser.ts:465

`Protected`assignmentStatement

assignmentStatement(): AssignmentNode
Returns AssignmentNode
- Defined in src/Parser.ts:340

`Protected`blockStatement

blockStatement(): BlockStmt
Returns BlockStmt
- Defined in src/Parser.ts:260

`Protected`bracketInsides

bracketInsides(): Expression
Handles the parsing of vector literals and range literals.

Returns Expression
- Defined in src/Parser.ts:924

`Protected`checkToken

checkToken(tt): boolean
Parameters
- tt: TokenType
Returns boolean
- Defined in src/Parser.ts:1187

`Protected`comparsion

comparsion(): Expression
Returns Expression
- Defined in src/Parser.ts:720

`Protected`consume

consume(tt, where): Token
Parameters
- tt: TokenType
- where: string
Returns Token
- Defined in src/Parser.ts:1165

`Protected`consumeUselessCommas

consumeUselessCommas(trailingArr?): boolean
Consumes redundant commas and returns true if it consumed any.

You can also pass an array of tokens to which all the comma tokens will be pushed.
Parameters
- OptionaltrailingArr: Token[]
Returns boolean
- Defined in src/Parser.ts:647

`Protected`equality

equality(): Expression
Parses the '==' and '!=' operators.

Returns Expression
- Defined in src/Parser.ts:709

`Protected`exponentiation

exponentiation(): Expression
Parses b ^ e.

Returns Expression
- Defined in src/Parser.ts:766

`Protected`expression

expression(): Expression
Returns Expression
- Defined in src/Parser.ts:657

`Protected`finishCall

finishCall(callee): Expression
Parameters
- callee: Expression
Returns Expression
- Defined in src/Parser.ts:821

`Protected`forComprehensionArgs

forComprehensionArgs(): AssignmentNode[]
Parses arguments from the 'for' loop comprehension. The initial paren must be consumed. Stops on semicolon or right paren, but does not consume them.

Returns AssignmentNode[]
- Defined in src/Parser.ts:548

`Protected`functionDeclarationStatement

functionDeclarationStatement(): FunctionDeclarationStmt
Returns FunctionDeclarationStmt
- Defined in src/Parser.ts:309

`Protected`getLocation

getLocation(): CodeLocation
Returns CodeLocation
- Defined in src/Parser.ts:1211

`Protected`ifElseStatement

ifElseStatement(): IfElseStatement
Returns IfElseStatement
- Defined in src/Parser.ts:410

`Protected`isAtEnd

isAtEnd(): boolean
Returns boolean
- Defined in src/Parser.ts:1199

`Protected`listComprehensionElements

listComprehensionElements(): Expression
Returns Expression
- Defined in src/Parser.ts:1049

`Protected`listComprehensionElementsOrExpr

listComprehensionElementsOrExpr(): Expression
Returns Expression
- Defined in src/Parser.ts:1141

`Protected`listComprehensionFor

listComprehensionFor(): Expression
Returns Expression
- Defined in src/Parser.ts:1102

`Protected`logicalAnd

logicalAnd(): Expression
Parses the '&&' operators

Returns Expression
- Defined in src/Parser.ts:695

`Protected`logicalOr

logicalOr(): Expression
Parses the '||' operators

Returns Expression
- Defined in src/Parser.ts:681

`Protected`matchAssignmentOrModuleInstantation

matchAssignmentOrModuleInstantation():
    | null
    | AssignmentNode
    | ModuleInstantiationStmt
    | IfElseStatement
Returns
    | null
    | AssignmentNode
    | ModuleInstantiationStmt
    | IfElseStatement
- Defined in src/Parser.ts:237

`Protected`matchToken

matchToken(...toMatch): boolean
Parameters
- Rest...toMatch: TokenType[]
Returns boolean
- Defined in src/Parser.ts:1178

`Protected`memberLookupOrArrayLookup

memberLookupOrArrayLookup(): Expression
Returns Expression
- Defined in src/Parser.ts:791

`Protected`moduleDeclarationStatement

moduleDeclarationStatement(): ModuleDeclarationStmt
Returns ModuleDeclarationStmt
- Defined in src/Parser.ts:274

`Protected`moduleInstantiationStatement

moduleInstantiationStatement(): ModuleInstantiationStmt | IfElseStatement
Returns ModuleInstantiationStmt | IfElseStatement
- Defined in src/Parser.ts:362

`Protected`multiplication

multiplication(): Expression
Returns Expression
- Defined in src/Parser.ts:749

parse

parse(): ScadFile
Attempts to parse a file and return the AST with the ScadFile as a root node.

Returns ScadFile
Throws
ParsingError
- Defined in src/Parser.ts:116

`Protected`peek

peek(): Token
Returns Token
- Defined in src/Parser.ts:1202

`Protected`peekNext

peekNext(): Token
Returns Token
- Defined in src/Parser.ts:1205

`Protected`previous

previous(): Token
Returns Token
- Defined in src/Parser.ts:1214

`Protected`primary

primary(): Expression
Returns Expression
- Defined in src/Parser.ts:830

`Protected`singleModuleInstantiation

singleModuleInstantiation(): ModuleInstantiationStmt | IfElseStatement
Returns ModuleInstantiationStmt | IfElseStatement
- Defined in src/Parser.ts:432

`Protected`statement

statement(isAtRoot?):
    | ErrorNode
    | AssignmentNode
    | UseStmt
    | IncludeStmt
    | ModuleInstantiationStmt
    | ModuleDeclarationStmt
    | FunctionDeclarationStmt
    | BlockStmt
    | NoopStmt
    | IfElseStatement
Parses a statement, including use and include when isAtRoot is set to true.
Parameters
- isAtRoot: boolean = false
  whther we are parsing a statement in the root of the file, set to false inside blocks or modules.
Returns
    | ErrorNode
    | AssignmentNode
    | UseStmt
    | IncludeStmt
    | ModuleInstantiationStmt
    | ModuleDeclarationStmt
    | FunctionDeclarationStmt
    | BlockStmt
    | NoopStmt
    | IfElseStatement
- Defined in src/Parser.ts:165

`Protected`synchronize

synchronize(e): void
Parameters
- e: ParsingError
Returns void
- Defined in src/Parser.ts:125

`Protected`ternary

ternary(): Expression
Parses the ternary '? :' expression

Returns Expression
- Defined in src/Parser.ts:663

`Protected`unary

unary(): Expression
Parses +expr, -expr and !expr.

Returns Expression
- Defined in src/Parser.ts:781