Qx.Export.OpenQASM.Parser (Qx - Quantum Computing Simulator v0.6.0)

View Source

nimble_parsec grammar for the OpenQASM 3.0 subset Qx supports.

See Qx.Export.OpenQASM.AST for the shape of the produced AST nodes.

Whitespace and comments (// line and /* … */ block, including nested blocks) are skipped between every grammar production via the optional_ws combinator — nimble_parsec has no built-in whitespace handling.

Summary

Functions

expression(binary, opts \\ [])

Parses the given binary as expression.

parse(source)

Parses an OpenQASM 3.0 source string into a {:program, [statement]} AST.

program(binary, opts \\ [])

Parses the given binary as program.

Functions

expression(binary, opts \\ [])

@spec expression(binary(), keyword()) ::
  {:ok, [term()], rest, context, line, byte_offset}
  | {:error, reason, rest, context, line, byte_offset}
when line: {pos_integer(), byte_offset},
     byte_offset: non_neg_integer(),
     rest: binary(),
     reason: String.t(),
     context: map()

Parses the given binary as expression.

Returns {:ok, [token], rest, context, position, byte_offset} or {:error, reason, rest, context, line, byte_offset} where position describes the location of the expression (start position) as {line, offset_to_start_of_line}.

To column where the error occurred can be inferred from byte_offset - offset_to_start_of_line.

Options

  • :byte_offset - the byte offset for the whole binary, defaults to 0
  • :line - the line and the byte offset into that line, defaults to {1, byte_offset}
  • :context - the initial context value. It will be converted to a map

parse(source)

@spec parse(String.t()) :: {:ok, tuple()} | {:error, Exception.t()}

Parses an OpenQASM 3.0 source string into a {:program, [statement]} AST.

Returns {:ok, ast} on success or {:error, %Qx.QasmParseError{}} on failure.

program(binary, opts \\ [])

@spec program(binary(), keyword()) ::
  {:ok, [term()], rest, context, line, byte_offset}
  | {:error, reason, rest, context, line, byte_offset}
when line: {pos_integer(), byte_offset},
     byte_offset: non_neg_integer(),
     rest: binary(),
     reason: String.t(),
     context: map()

Parses the given binary as program.

Returns {:ok, [token], rest, context, position, byte_offset} or {:error, reason, rest, context, line, byte_offset} where position describes the location of the program (start position) as {line, offset_to_start_of_line}.

To column where the error occurred can be inferred from byte_offset - offset_to_start_of_line.

Options

  • :byte_offset - the byte offset for the whole binary, defaults to 0
  • :line - the line and the byte offset into that line, defaults to {1, byte_offset}
  • :context - the initial context value. It will be converted to a map