Class Parser

TabScript parser implementing recursive descent parsing.

All parse* methods follow a contract:

Return truthy on success, falsy on failure
On failure, leave the state unchanged

Plugins can modify parse* methods directly on the Parser instance.

Constructors

constructor

new Parser(options: Options): Parser
Parameters
- options: Options
Returns Parser
- Defined in src/parser.ts:62

Properties

options

options: Options

Methods

parseArrowFuncExprBody

parseArrowFuncExprBody(s: State): boolean
Parameters
- s: State
Returns boolean
- Defined in src/parser.ts:764

parseBacktickString

parseBacktickString(s: State): boolean
Parameters
- s: State
Returns boolean
- Defined in src/parser.ts:795

parseBlock

parseBlock(s: State): boolean
Parameters
- s: State
Returns boolean
- Defined in src/parser.ts:736

parseClass

parseClass(s: State): boolean
Parse a class or interface definition.
Parameters
- s: State
Returns boolean
Example
```
`class Foo extends Bar` or `interface IFoo` or `abstract class Base`
```
- Defined in src/parser.ts:391

parseClassicFuncExprBody

parseClassicFuncExprBody(s: State): boolean
Parameters
- s: State
Returns boolean
- Defined in src/parser.ts:753

parseDeclare

parseDeclare(s: State): boolean
Parameters
- s: State
Returns boolean
- Defined in src/parser.ts:725

parseDoWhile

parseDoWhile(s: State): boolean
Parameters
- s: State
Returns boolean
- Defined in src/parser.ts:564

parseEnum

parseEnum(s: State): boolean
Parameters
- s: State
Returns boolean
- Defined in src/parser.ts:515

parseExport

parseExport(s: State): boolean
Parameters
- s: State
Returns boolean
- Defined in src/parser.ts:484

parseExpression

parseExpression(s: State, withinTag?: boolean): boolean
Parse an expression.
Parameters
- s: State
- withinTag: boolean = false
Returns boolean
Example
```
`x + 1` or `foo(bar)` or `obj.method.. arg1 arg2`
```
- Defined in src/parser.ts:176

parseExpressionSeq

parseExpressionSeq(s: State): boolean
Parameters
- s: State
Returns boolean
- Defined in src/parser.ts:789

parseFor

parseFor(s: State): boolean
Parameters
- s: State
Returns boolean
- Defined in src/parser.ts:572

parseFuncParams

parseFuncParams(
    s: State,
    isConstructor?: boolean,
    parenthesis?: boolean,
): string | boolean
Parse function parameters.
Parameters
- s: State
- isConstructor: boolean = false
- parenthesis: boolean = false
Returns string | boolean
Example
```
`|a, b: number, c = 3|` or `(a, b: number, c = 3)`
```
- Defined in src/parser.ts:84

parseFunction

parseFunction(s: State, declaration?: boolean): boolean
Parse a function definition.
Parameters
- s: State
- declaration: boolean = false
Returns boolean
Example
```
`|x| x * 2` or `async |x| await fetch(x)` or `function foo|x| x * 2`
```
- Defined in src/parser.ts:113

parseFuncType

parseFuncType(s: State): boolean
Parameters
- s: State
Returns boolean
- Defined in src/parser.ts:775

parseHeader

parseHeader(s: State): boolean
Parse the TabScript header line. Header format: tabscript X.Y
Parameters
- s: State
Returns boolean
- Defined in src/parser.ts:442

parseIfWhile

parseIfWhile(s: State): boolean
Parameters
- s: State
Returns boolean
- Defined in src/parser.ts:547

parseImport

parseImport(s: State): boolean
Parameters
- s: State
Returns boolean
- Defined in src/parser.ts:623

parseIndex

parseIndex(s: State): boolean
Parameters
- s: State
Returns boolean
- Defined in src/parser.ts:847

parseLiteralArray

parseLiteralArray(s: State): boolean
Parameters
- s: State
Returns boolean
- Defined in src/parser.ts:806

parseLiteralObject

parseLiteralObject(s: State): boolean
Parameters
- s: State
Returns boolean
- Defined in src/parser.ts:813

parseMain

parseMain(s: State): boolean
Parse the main entry point - processes header and all statements.
Parameters
- s: State
Returns boolean
- Defined in src/parser.ts:424

parseMethod

parseMethod(s: State, typeOnly?: boolean, isDerived?: boolean): boolean
Parse a class method or property.
Parameters
- s: State
- typeOnly: boolean = false
- isDerived: boolean = false
Returns boolean
Example
```
`myMethod|x| x * 2` or `static count := 0` or `get name|| this._name`
```
- Defined in src/parser.ts:309

parseParenthesised

parseParenthesised(s: State): boolean
Parameters
- s: State
Returns boolean
- Defined in src/parser.ts:782

parseReturn

parseReturn(s: State): boolean
Parameters
- s: State
Returns boolean
- Defined in src/parser.ts:541

parseStatement

parseStatement(s: State): string | boolean
Parse a single statement.
Parameters
- s: State
Returns string | boolean
Example
```
`x := 5` or `if condition` or `for item: of items` or `return value`
```
- Defined in src/parser.ts:467

parseSwitch

parseSwitch(s: State): boolean
Parameters
- s: State
Returns boolean
- Defined in src/parser.ts:595

parseTemplateArg

parseTemplateArg(s: State): boolean
Parameters
- s: State
Returns boolean
- Defined in src/parser.ts:836

parseTemplateDef

parseTemplateDef(s: State): boolean
Parameters
- s: State
Returns boolean
- Defined in src/parser.ts:740

parseThrow

parseThrow(s: State): boolean
Parameters
- s: State
Returns boolean
- Defined in src/parser.ts:558

parseTry

parseTry(s: State): boolean
Parameters
- s: State
Returns boolean
- Defined in src/parser.ts:686

parseType

parseType(s: State, allowFunction?: boolean): boolean
Parse a type annotation.
Parameters
- s: State
- allowFunction: boolean = true
Returns boolean
Example
```
`number` or `string[]` or `{x: number, y: string}` or `Foo<Bar>`
```
- Defined in src/parser.ts:251

parseTypeDecl

parseTypeDecl(s: State): boolean
Parameters
- s: State
Returns boolean
- Defined in src/parser.ts:507

parseTypeObjectEntry

parseTypeObjectEntry(s: State): boolean
Parameters
- s: State
Returns boolean
- Defined in src/parser.ts:854

parseVarDecl

parseVarDecl(s: State, allowInit?: boolean): boolean
Parse a variable declaration.
Parameters
- s: State
- allowInit: boolean = true
Returns boolean
Example
```
`x := 5` (const) or `x ::= 5` (let) or `x: number := 5` (with type)
```
- Defined in src/parser.ts:157

pattern

pattern(regexp: RegExp, name: string): RegExp
Creates a token matcher regex with a descriptive name for error messages. Automatically adds the sticky (/y) flag if not present.

This is the recommended way to create regex patterns for use with s.read(), s.accept(), s.peek(), and related methods in plugins.
Parameters
- regexp: RegExp
  The regular expression pattern to match tokens
- name: string
  A descriptive name shown in error messages (e.g., "identifier", "number")
Returns RegExp
A new RegExp with the sticky flag and custom toString()
- Defined in src/parser.ts:76