kokic/notiz/parsing - mooncakes.io

kokic/notiz/parsing does not have a README file

BlockParser

type BlockParser = @kokic/talcparsec.Parser
Parser[@kokic/talcparsec.Input
Input, Block]

InlineParser

source

type InlineParser = @kokic/talcparsec.Parser
Parser[@kokic/talcparsec.Input
Input, Inline]

SyntaxError

source

pub(all) suberror SyntaxError {
  Mismatch(@kokic/talcparsec.Position
Position, Array[Expected])
  Unexpected(@kokic/talcparsec.Position
Position, String)
} derive(Eq, @moonbitlang/core/debug.Debug
Debug)

A syntax error raised while parsing notiz markdown.

Carries the failure position and a structured description of what went wrong, instead of an opaque message string.

impl Show for SyntaxError

fn output(self : SyntaxError, logger : &Logger) -> Unit

source

One-line summary, e.g. parse error at 1:2: expected a space.

The full report with the source snippet, caret, and found token is [format_parse_error], which needs the source text.

SyntaxError::equal

source

fn SyntaxError::equal(SyntaxError, SyntaxError) -> Bool

SyntaxError::not_equal

source

fn SyntaxError::not_equal(x : SyntaxError, y : SyntaxError) -> Bool

SyntaxError::of_parse_error

source

fn SyntaxError::of_parse_error(err : @kokic/talcparsec.ParseError
ParseError) -> SyntaxError

Converts a @talc.ParseError into the typed [SyntaxError].

This is the single place that interprets the parser engine's string labels; every label below this point is structured.

SyntaxError::output

source

fn SyntaxError::output(self : SyntaxError, logger : &Logger) -> Unit

SyntaxError::position

source

fn SyntaxError::position(self : SyntaxError) -> @kokic/talcparsec.Position
Position

The source position where the parse failed.

SyntaxError::to_repr

source

fn SyntaxError::to_repr(SyntaxError) -> @moonbitlang/core/debug.Repr
Repr

SyntaxError::to_string

source

fn SyntaxError::to_string(self : SyntaxError) -> String

Block

source

pub(all) enum Block {
  Heading(Int, Array[Inline])
  Paragraph(Array[Inline])
  Blockquote(Array[Block])
  UnorderedList(Array[MdListItem])
  OrderedList(Array[MdListItem])
  FencedCode(String?, String)
  DisplayMath(String)
  ThematicBreak
  Table(TableRow, Array[TableRow])
  FootnoteDef(String, Array[Block])
} derive(Eq, @moonbitlang/core/debug.Debug
Debug)

Block::equal

source

fn Block::equal(Block, Block) -> Bool

Block::not_equal

source

fn Block::not_equal(x : Block, y : Block) -> Bool

Block::to_repr

source

fn Block::to_repr(Block) -> @moonbitlang/core/debug.Repr
Repr

Expected

source

pub(all) enum Expected {
  Char(Char)
  Str(String)
  OneOf(String)
  EndOfInput
  TableDelimiterRow
  Other(String)
} derive(Eq, @moonbitlang/core/debug.Debug
Debug)

What the parser expected to find at a failure position.

Expected::equal

source

fn Expected::equal(Expected, Expected) -> Bool

Expected::not_equal

source

fn Expected::not_equal(x : Expected, y : Expected) -> Bool

Expected::to_repr

source

fn Expected::to_repr(Expected) -> @moonbitlang/core/debug.Repr
Repr

Inline

source

pub(all) enum Inline {
  Plain(String)
  Strong(Array[Inline])
  Emph(Array[Inline])
  Code(String)
  Image(String, String)
  SoftBreak
  HardBreak
  InlineMath(String)
  FootnoteRef(String)
} derive(Eq, @moonbitlang/core/debug.Debug
Debug)

AST types

Inline::equal

source

fn Inline::equal(Inline, Inline) -> Bool

Inline::not_equal

source

fn Inline::not_equal(x : Inline, y : Inline) -> Bool

Inline::to_repr

source

fn Inline::to_repr(Inline) -> @moonbitlang/core/debug.Repr
Repr

MdListItem

source

pub(all) struct MdListItem {
  checked : Bool?
  content : Array[Inline]
  children : Array[Block]
} derive(Eq, @moonbitlang/core/debug.Debug
Debug)

MdListItem::equal

source

fn MdListItem::equal(MdListItem, MdListItem) -> Bool

MdListItem::not_equal

source

fn MdListItem::not_equal(x : MdListItem, y : MdListItem) -> Bool

MdListItem::to_repr

source

fn MdListItem::to_repr(MdListItem) -> @moonbitlang/core/debug.Repr
Repr

TableRow

source

pub(all) struct TableRow {
  cells : Array[Array[Inline]]
} derive(Eq, @moonbitlang/core/debug.Debug
Debug)

TableRow::equal

source

fn TableRow::equal(TableRow, TableRow) -> Bool

TableRow::not_equal

source

fn TableRow::not_equal(x : TableRow, y : TableRow) -> Bool

TableRow::to_repr

source

fn TableRow::to_repr(TableRow) -> @moonbitlang/core/debug.Repr
Repr

delim

source

fn delim(c : Char) -> @kokic/talcparsec.Parser
Parser[@kokic/talcparsec.Input
Input, Unit]

document

source

let document : @kokic/talcparsec.Parser
Parser[@kokic/talcparsec.Input
Input, Array[Block]]

format_parse_error

source

fn format_parse_error(err : SyntaxError, source : String) -> String

Formats a syntax error with a source snippet and caret marker.

Returns a multi-line message like:

parse error at 1:2: expected a space, found 'a'

 1 |   hello world
   |   ^

parse_inlines

source

fn parse_inlines(text : String) -> Result[Array[Inline], @kokic/talcparsec.ParseError
ParseError]

special_chars

source

let special_chars : String

Inline parsers

table

source

fn table() -> @kokic/talcparsec.Parser
Parser[@kokic/talcparsec.Input
Input, Block]

Source Files

Site source Report issue Packages Build queue Skills Statistics

#BlockParser

#InlineParser

#SyntaxError

#SyntaxError::equal

#SyntaxError::not_equal

#SyntaxError::of_parse_error

#SyntaxError::output

#SyntaxError::position

#SyntaxError::to_repr

#SyntaxError::to_string

#Block

#Block::equal

#Block::not_equal

#Block::to_repr

#Expected

#Expected::equal

#Expected::not_equal

#Expected::to_repr

#Inline

#Inline::equal

#Inline::not_equal

#Inline::to_repr

#MdListItem

#MdListItem::equal

#MdListItem::not_equal

#MdListItem::to_repr

#TableRow

#TableRow::equal

#TableRow::not_equal

#TableRow::to_repr

#delim

#document

#format_parse_error

#parse_inlines

#special_chars

#table

Source Files

BlockParser

InlineParser

SyntaxError

SyntaxError::equal

SyntaxError::not_equal

SyntaxError::of_parse_error

SyntaxError::output

SyntaxError::position

SyntaxError::to_repr

SyntaxError::to_string

Block

Block::equal

Block::not_equal

Block::to_repr

Expected

Expected::equal

Expected::not_equal

Expected::to_repr

Inline

Inline::equal

Inline::not_equal

Inline::to_repr

MdListItem

MdListItem::equal

MdListItem::not_equal

MdListItem::to_repr

TableRow

TableRow::equal

TableRow::not_equal

TableRow::to_repr

delim

document

format_parse_error

parse_inlines

special_chars

table