mooncakes.io

marianoguerra/was/read does not have a README file

Span

using @marianoguerra/error-report { type Span }

A source span, as offsets into the file.

ReadError

source

pub(all) suberror ReadError {
  ReadError(@marianoguerra/error-report.Report
Report)
}

A was read error, carrying a ready-to-render report.

ReadError::report

source

fn ReadError::report(self : ReadError) -> @marianoguerra/error-report.Report
Report

The report inside a parse error.

Parts

source

pub(all) struct Parts {
  head : Array[@marianoguerra/shrubbery/ast.Node
Node]
  block : Array[@marianoguerra/shrubbery/ast.Node
Node]?
  alts : Array[Array[@marianoguerra/shrubbery/ast.Node
Node]]?
  span : @marianoguerra/error-report.Span
Span
}

A group split into the three parts shrubbery guarantees it can have: the terms, then at most one block, then at most one run of alternatives.

This shape is not a convention of wap's, it is the shrubbery grammar -- "a block list appears only at the end of a group list or just before an alts list that is at the end of the group list".

Read

source

pub struct Read {
  fields : Array[@marianoguerra/wax/basic.Annotated
Annotated[@marianoguerra/wax/ast.ModuleField
ModuleField[@marianoguerra/wax/basic.Location
Location], @marianoguerra/wax/basic.Location
Location]]
  sources : @marianoguerra/error-report.Sources
Sources
  source : @marianoguerra/error-report.SourceId
SourceId
  diagnostics : Array[@marianoguerra/error-report.Report
Report]
}

A module read from was source.

Read::diagnostics

source

fn Read::diagnostics(self : Read) -> Array[@marianoguerra/error-report.Report
Report]

Problems found while reading.

Read::fields

source

fn Read::fields(self : Read) -> Array[@marianoguerra/wax/basic.Annotated
Annotated[@marianoguerra/wax/ast.ModuleField
ModuleField[@marianoguerra/wax/basic.Location
Location], @marianoguerra/wax/basic.Location
Location]]

The Wax module fields.

Read::source

source

fn Read::source(self : Read) -> @marianoguerra/error-report.SourceId
SourceId

The id of the file that was read.

Read::sources

source

fn Read::sources(self : Read) -> @marianoguerra/error-report.Sources
Sources

The source registry the reports point into.

as_id

source

fn as_id(n : @marianoguerra/shrubbery/ast.Node
Node) -> String?

The identifier a term is, if it is one.

as_kw

source

fn as_kw(n : @marianoguerra/shrubbery/ast.Node
Node) -> String?

The keyword a term is, if it is one. Keywords are wap's labels: ~outer.

as_op

source

fn as_op(n : @marianoguerra/shrubbery/ast.Node
Node) -> String?

The operator a term is, if it is one.

as_str

source

fn as_str(n : @marianoguerra/shrubbery/ast.Node
Node) -> String?

The string a literal term is, if it is a string.

fail_at

source

fn[T] fail_at(msg : String, span : @marianoguerra/error-report.Span
Span, source~ : @marianoguerra/error-report.SourceId
SourceId, help? : String) -> T raise ReadError

Fail at a span, with a message.

has_source

source

fn has_source(s : @marianoguerra/error-report.Span
Span) -> Bool

True when a span points at real source text.

is_id

source

fn is_id(n : @marianoguerra/shrubbery/ast.Node
Node, name : String) -> Bool

True when the term is exactly this identifier.

is_op

source

fn is_op(n : @marianoguerra/shrubbery/ast.Node
Node, name : String) -> Bool

True when the term is exactly this operator.

node_span

source

fn node_span(n : @marianoguerra/shrubbery/ast.Node
Node) -> @marianoguerra/error-report.Span
Span

The span of a shrubbery node.

nowhere

source

let nowhere : @marianoguerra/error-report.Span
Span

The span of something that was never written down.

raw_text

source

fn raw_text(n : @marianoguerra/shrubbery/ast.Node
Node) -> String

The source text of a term, which is how numeric literals keep the spelling they were written with. Shrubbery parses 0xFF to 255; Wax needs the digits back, because the checker's flexible-literal typing and the printer both depend on them.

read_module

source

fn read_module(text : String, fname? : String) -> Read raise ReadError

Read was source into the Wax AST.

Grouping errors come from shrubbery and are re-raised unchanged: there is no value in was paraphrasing them, and a shrubbery diagnostic already renders through error-report.

split

source

fn split(n : @marianoguerra/shrubbery/ast.Node
Node) -> Parts

Split a group into head terms, block and alternatives.

terms_span

source

fn terms_span(ts : ArrayView[@marianoguerra/shrubbery/ast.Node
Node]) -> @marianoguerra/error-report.Span
Span

The span covering a run of terms, or nowhere if there are none.

to_span

source

fn to_span(s : @marianoguerra/shrubbery/basic.Span
Span) -> @marianoguerra/error-report.Span
Span

A shrubbery span as an error-report span.

idx is the UTF-16 index shrubbery keeps for exactly this purpose; line and pos are code-point positions for humans and are not used here.

Source Files

Site source Report issue Packages Build queue Skills Statistics

#Span

#ReadError

#ReadError::report

#Parts

#Read

#Read::diagnostics

#Read::fields

#Read::source

#Read::sources

#as_id

#as_kw

#as_op

#as_str

#fail_at

#has_source

#is_id

#is_op

#node_span

#nowhere

#raw_text

#read_module

#split

#terms_span

#to_span

Source Files

Span

ReadError

ReadError::report

Parts

Read

Read::diagnostics

Read::fields

Read::source

Read::sources

as_id

as_kw

as_op

as_str

fail_at

has_source

is_id

is_op

node_span

nowhere

raw_text

read_module

split

terms_span

to_span