Class default

OpenQASM 2.0 Parser

A straightforward recursive descent parser for OpenQASM 2.0 that produces a simplified AST structure appropriate for the more limited feature set of the 2.0 language specification.

Example: Basic parsing workflow

const parser = new Parser(tokens);
const ast = parser.parse();

// Process the resulting AST nodes
ast.forEach(node => {
  if (node instanceof QReg) {
    console.log(`Quantum register: ${node.id}[${node.size}]`);
  }
});

Index

Constructors

constructor

new default(tokens: [Token, (string | number)?][]): default
Creates a parser.
Parameters
- tokens: [Token, (string | number)?][]
  Tokens to parse.
Returns default
- Defined in src/qasm2/parser.ts:107

Methods

application

application(tokens: [Token, (string | number)?][], op: string): AstNode[]
Parses an application of one of the allowed gates.
Parameters
- tokens: [Token, (string | number)?][]
  Remaining tokens to parse.
- op: string
Returns AstNode[]
An AST node representing the gate application.
- Defined in src/qasm2/parser.ts:421

barrier

barrier(tokens: [Token, (string | number)?][]): AstNode
Parses a barrier.
Parameters
- tokens: [Token, (string | number)?][]
  Remaining tokens to parse.
Returns AstNode
An AST node representing the barrier.
- Defined in src/qasm2/parser.ts:339

conditional

conditional(tokens: [Token, (string | number)?][]): AstNode
Parses a conditional.
Parameters
- tokens: [Token, (string | number)?][]
  Remaining tokens to parse.
Returns AstNode
An AST node representing the conditional.
- Defined in src/qasm2/parser.ts:315

creg

creg(tokens: [Token, (string | number)?][]): AstNode
Parses a classical register.
Parameters
- tokens: [Token, (string | number)?][]
  Remaining tokens to parse.
Returns AstNode
An AST node representing the classical register.
- Defined in src/qasm2/parser.ts:289

gate

gate(tokens: [Token, (string | number)?][]): AstNode
Parses a gate.
Parameters
- tokens: [Token, (string | number)?][]
  Remaining tokens to parse.
Returns AstNode
An AST node representing the gate.
- Defined in src/qasm2/parser.ts:660

include

include(tokens: [Token, (string | number)?][]): Include
Parses an include statement.
Parameters
- tokens: [Token, (string | number)?][]
  Tokens to parse.
Returns Include
An Include node representing the include statement.
- Defined in src/qasm2/parser.ts:598

matchArg

matchArg(tokens: [Token, (string | number)?][]): number
Parses an argument value.
Parameters
- tokens: [Token, (string | number)?][]
  Tokens to parse.
Returns number
An AST node representing the argument value.
- Defined in src/qasm2/parser.ts:539

matchArgList

matchArgList(tokens: [Token, (string | number)?][]): [string, number?][]
Parses a list of argument values.
Parameters
- tokens: [Token, (string | number)?][]
  Tokens to parse.
Returns [string, number?][]
An array of AST nodes representing the argument values.
- Defined in src/qasm2/parser.ts:562

matchIdList

matchIdList(tokens: [Token, (string | number)?][]): string[]
Parses a list of identifiers.
Parameters
- tokens: [Token, (string | number)?][]
  Tokens to parse.
Returns string[]
An array of AST nodes representing the identifiers.
- Defined in src/qasm2/parser.ts:639

matchNext

matchNext(
tokens: [Token, (string | number)?][],
expectedTokens: Token[],
): boolean
Checks if the next tokens match those expected.
Parameters
- tokens: [Token, (string | number)?][]
  Remaining tokens to parse.
- expectedTokens: Token[]
  Expected tokens.
Returns boolean
Whether these is a match.
- Defined in src/qasm2/parser.ts:239

matchParam

matchParam(tokens: [Token, (string | number)?][]): AstNode
Parses a parameter value.
Parameters
- tokens: [Token, (string | number)?][]
  Tokens to parse.
Returns AstNode
An AST node representing the parameter value.
- Defined in src/qasm2/parser.ts:490

matchParamList

matchParamList(tokens: [Token, (string | number)?][]): AstNode[][]
Parses a list of parameter values.
Parameters
- tokens: [Token, (string | number)?][]
  Tokens to parse.
Returns AstNode[][]
An array of AST nodes representing the parameter values.
- Defined in src/qasm2/parser.ts:505

measure

measure(tokens: [Token, (string | number)?][]): AstNode
Parses a measurement.
Parameters
- tokens: [Token, (string | number)?][]
  Remaining tokens to parse.
Returns AstNode
An AST node representing the measurement.
- Defined in src/qasm2/parser.ts:365

opaque

opaque(tokens: [Token, (string | number)?][]): AstNode
Parses an opaque declaration if using OpenQASM 2. If using OpenQASM 3 it skips the line.
Parameters
- tokens: [Token, (string | number)?][]
  Remaining tokens to parse.
Returns AstNode
An AST node representing the opaque declaration.
- Defined in src/qasm2/parser.ts:696

parse

parse(): AstNode[]
Calling this method parses the code represented by the provided tokens.

Returns AstNode[]
The abstract syntax tree.
- Defined in src/qasm2/parser.ts:136

parseNode

parseNode(
tokens: [Token, (string | number)?][],
allowVariables?: boolean,
): AstNode[]
Delegates the parsing of the next set of tokens to the appropriate method.
Parameters
- tokens: [Token, (string | number)?][]
  Remaining tokens to parse.
- allowVariables: boolean = false
  Whether encountered identifiers should be consider variable initializations or references.
Returns AstNode[]
A set of AST nodes.
- Defined in src/qasm2/parser.ts:163

qreg

qreg(tokens: [Token, (string | number)?][]): AstNode
Parses a quantum register.
Parameters
- tokens: [Token, (string | number)?][]
  Remaining tokens to parse.
Returns AstNode
An AST node representing the quantum register.
- Defined in src/qasm2/parser.ts:263

sub

sub(tokens: [Token, (string | number)?][]): AstNode[]
Parses a subroutine used in a custom gate definition.
Parameters
- tokens: [Token, (string | number)?][]
  Expression tokens to parse.
Returns AstNode[]
A parsed subroutine.
- Defined in src/qasm2/parser.ts:462

versionHeader

versionHeader(tokens: [Token, (string | number)?][]): Version
Parses the version header and sets the parser version.
Parameters
- tokens: [Token, (string | number)?][]
  Tokens to parse.
Returns Version
A Version node representing the version statement.
- Defined in src/qasm2/parser.ts:612

Properties

gates

gates: string[]

The allowed gates.

tokens

tokens: [Token, (string | number)?][]

The tokens to parse.

Class default

Example: Basic parsing workflow

Index

Constructors

Methods

Properties

Constructors

constructor

Parameters

Returns default

Methods

application

Parameters

Returns AstNode[]

barrier

Parameters

Returns AstNode

conditional

Parameters

Returns AstNode

creg

Parameters

Returns AstNode

gate

Parameters

Returns AstNode

include

Parameters

Returns Include

matchArg

Parameters

Returns number

matchArgList

Parameters

Returns [string, number?][]

matchIdList

Parameters

Returns string[]

matchNext

Parameters

Returns boolean

matchParam

Parameters

Returns AstNode

matchParamList

Parameters

Returns AstNode[][]

measure

Parameters

Returns AstNode

opaque

Parameters

Returns AstNode

parse

Returns AstNode[]

parseNode

Parameters

Returns AstNode[]

qreg

Parameters

Returns AstNode

sub

Parameters

Returns AstNode[]

versionHeader

Parameters

Returns Version

Properties

gates

tokens

Settings

On This Page