mooncakes.io

moonbit-community/html/src does not have a README file

Attribute

pub(all) struct Attribute {
  name : String
  value : String
} derive(Eq, @moonbitlang/core/debug.Debug
Debug)

Attribute in a start/end tag

impl Show for Attribute

Attribute::equal

source

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

Attribute::not_equal

source

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

Attribute::output

source

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

Attribute::to_repr

source

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

Attribute::to_string

source

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

Document

source

pub struct Document {
  nodes : Array[Node]
  parents : Array[Int]
  document_element : Int
  head_element : Int
  body_element : Int
  quirks_mode : QuirksMode
  scripting_enabled : Bool
} derive(Eq, @moonbitlang/core/debug.Debug
Debug)

The complete document owns all nodes in a flat array

impl Show for Document

Document::add_node

source

fn Document::add_node(self : Document, node : Node) -> Int

Add a new node and return its ID

Document::append_child

source

fn Document::append_child(self : Document, parent_id : Int, child_id : Int) -> Unit

Append a child node to a parent

Document::dump

source

fn Document::dump(self : Document) -> String

Dump document in html5lib-tests format for conformance testing

Document::equal

source

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

Document::get_attribute

source

fn Document::get_attribute(self : Document, id : Int, attr_name : String) -> String?

Get an attribute value from an element

Document::get_children

source

fn Document::get_children(self : Document, id : Int) -> Array[Int]

Get children of a node

Document::get_element

source

fn Document::get_element(self : Document, id : Int) -> Element?

Get an element by ID (returns None if not an element)

Document::get_node

source

fn Document::get_node(self : Document, id : Int) -> Node?

Get a node by ID

Document::get_ns

source

fn Document::get_ns(self : Document, id : Int) -> Namespace?

Get the namespace of an element node

Document::get_parent

source

fn Document::get_parent(self : Document, id : Int) -> Int

Get the parent of a node

Document::get_tag_name

source

fn Document::get_tag_name(self : Document, id : Int) -> String?

Get the tag name of an element node

Document::get_template_content

source

fn Document::get_template_content(self : Document, id : Int) -> Int

Get the template content of a template element

Document::get_text_content

source

fn Document::get_text_content(self : Document, id : Int) -> String

Get text content of a node (concatenation of all text descendants)

Document::has_attribute

source

fn Document::has_attribute(self : Document, id : Int, attr_name : String) -> Bool

Check if an element has a specific attribute

Document::insert_before

source

fn Document::insert_before(self : Document, parent_id : Int, child_id : Int, reference_id : Int) -> Unit

Insert a child node before another child

Document::is_element

source

fn Document::is_element(self : Document, id : Int, tag_name : String, ns : Namespace) -> Bool

Check if a node is an element with the given tag name and namespace

Document::is_html_element

source

fn Document::is_html_element(self : Document, id : Int, tag_name : String) -> Bool

Check if a node is an HTML element with the given tag name

Document::new

source

fn Document::new() -> Document

Create a new empty document

Document::not_equal

source

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

Document::output

source

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

Document::remove_child

source

fn Document::remove_child(self : Document, parent_id : Int, child_id : Int) -> Unit

Remove a child from its parent

Document::set_attribute

source

fn Document::set_attribute(self : Document, id : Int, attr_name : String, attr_value : String) -> Unit

Set an attribute on an element

Document::to_html

source

fn Document::to_html(self : Document) -> String

Serialize document to HTML string

Document::to_repr

source

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

Document::to_string

source

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

Element

source

pub struct Element {
  tag_name : String
  ns : Namespace
  attributes : Array[(String, String)]
  children : Array[Int]
  parent : Int
  is_html_integration_point : Bool
  is_mathml_text_integration_point : Bool
  template_content : Int
} derive(Eq, @moonbitlang/core/debug.Debug
Debug)

DOM Element node

impl Show for Element

Element::equal

source

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

Element::new

source

fn Element::new(tag_name : String, ns : Namespace, attributes : Array[(String, String)]) -> Element

Create a new Element

Element::not_equal

source

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

Element::output

source

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

Element::to_repr

source

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

Element::to_string

source

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

FormattingEntry

source

type FormattingEntry

Marker or Element entry in the active formatting elements list

InsertionMode

source

type InsertionMode

23 tree construction insertion modes (WHATWG 13.2.6)

Namespace

source

pub(all) enum Namespace {
  HTML
  SVG
  MathML
} derive(Eq, @moonbitlang/core/debug.Debug
Debug)

Namespace for HTML, SVG, MathML

impl Show for Namespace

Namespace::equal

source

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

Namespace::not_equal

source

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

Namespace::output

source

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

Namespace::to_repr

source

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

Namespace::to_string

source

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

Node

source

pub enum Node {
  ElementNode(Element)
  TextNode(String)
  CommentNode(String)
  ProcessingInstructionNode(target~ : String, data~ : String)
  DocumentTypeNode(name~ : String, public_id~ : String, system_id~ : String)
  DocumentNode(children~ : Array[Int])
  DocumentFragmentNode(children~ : Array[Int])
} derive(Eq, @moonbitlang/core/debug.Debug
Debug)

DOM Node - sum type for all node kinds

impl Show for Node

Node::equal

source

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

Node::not_equal

source

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

Node::output

source

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

Node::to_repr

source

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

Node::to_string

source

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

ParseError

source

pub struct ParseError {
  code : ParseErrorCode
  position : SourcePosition
} derive(Eq, @moonbitlang/core/debug.Debug
Debug)

A parse error with location

impl Show for ParseError

ParseError::equal

source

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

ParseError::not_equal

source

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

ParseError::output

source

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

ParseError::to_repr

source

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

ParseError::to_string

source

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

ParseErrorCode

source

pub(all) enum ParseErrorCode {
  AbruptClosingOfEmptyComment
  EofInComment
  IncorrectlyClosedComment
  IncorrectlyOpenedComment
  NestedComment
  AbruptDoctypePublicIdentifier
  AbruptDoctypeSystemIdentifier
  EofInDoctype
  InvalidCharacterSequenceAfterDoctypeName
  MissingDoctypeName
  MissingDoctypePublicIdentifier
  MissingDoctypeSystemIdentifier
  MissingQuoteBeforeDoctypePublicIdentifier
  MissingQuoteBeforeDoctypeSystemIdentifier
  MissingWhitespaceAfterDoctypePublicKeyword
  MissingWhitespaceAfterDoctypeSystemKeyword
  MissingWhitespaceBeforeDoctypeName
  MissingWhitespaceBetweenDoctypePublicAndSystemIdentifiers
  UnexpectedCharacterAfterDoctypeSystemIdentifier
  DuplicateAttribute
  EndTagWithAttributes
  EndTagWithTrailingSolidus
  EofBeforeTagName
  EofInTag
  InvalidFirstCharacterOfTagName
  MissingAttributeValue
  MissingEndTagName
  MissingWhitespaceBetweenAttributes
  NonVoidHtmlElementStartTagWithTrailingSolidus
  UnexpectedCharacterInAttributeName
  UnexpectedCharacterInUnquotedAttributeValue
  UnexpectedEqualsSignBeforeAttributeName
  UnexpectedNullCharacter
  UnexpectedQuestionMarkInsteadOfTagName
  UnexpectedSolidusInTag
  DisallowedProcessingInstructionTarget
  EofInProcessingInstruction
  InvalidFirstCharacterOfProcessingInstructionTarget
  InvalidProcessingInstructionTarget
  TreeConstruction
  AbsenceOfDigitsInNumericCharacterReference
  CharacterReferenceOutsideUnicodeRange
  ControlCharacterReference
  MissingSemicolonAfterCharacterReference
  NoncharacterCharacterReference
  NullCharacterReference
  SurrogateCharacterReference
  UnknownNamedCharacterReference
  CdataInHtmlContent
  ControlCharacterInInputStream
  EofInCdata
  EofInScriptHtmlCommentLikeText
  NoncharacterInInputStream
  SurrogateInInputStream
} derive(Eq, @moonbitlang/core/debug.Debug
Debug)

WHATWG HTML5 Parse Errors (49 types per specification)

impl Show for ParseErrorCode

ParseErrorCode::equal

source

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

ParseErrorCode::not_equal

source

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

ParseErrorCode::output

source

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

ParseErrorCode::to_repr

source

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

ParseErrorCode::to_string

source

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

QuirksMode

source

pub(all) enum QuirksMode {
  NoQuirks
  Quirks
  LimitedQuirks
} derive(Eq, @moonbitlang/core/debug.Debug
Debug)

Document quirks mode (WHATWG 3.1.4)

impl Show for QuirksMode

QuirksMode::equal

source

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

QuirksMode::not_equal

source

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

QuirksMode::output

source

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

QuirksMode::to_repr

source

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

QuirksMode::to_string

source

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

SourcePosition

source

pub struct SourcePosition {
  line : Int
  column : Int
  offset : Int
} derive(Eq, @moonbitlang/core/debug.Debug
Debug)

Source position for error reporting

impl Show for SourcePosition

SourcePosition::equal

source

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

SourcePosition::not_equal

source

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

SourcePosition::output

source

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

SourcePosition::to_repr

source

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

SourcePosition::to_string

source

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

StackEntry

source

type StackEntry

Entry in the stack of open elements

State

source

type State derive(Eq, @moonbitlang/core/debug.Debug
Debug)

WHATWG tokenizer states

impl Show for State

State::equal

source

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

State::not_equal

source

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

State::output

source

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

State::to_repr

source

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

State::to_string

source

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

Token

source

pub(all) enum Token {
  DOCTYPE(name~ : String?, public_id~ : String?, system_id~ : String?, force_quirks~ : Bool)
  StartTag(name~ : String, attrs~ : Array[Attribute], self_closing~ : Bool)
  EndTag(name~ : String)
  Character(Char)
  Comment(String)
  ProcessingInstruction(target~ : String, data~ : String)
  EOF
} derive(Eq, @moonbitlang/core/debug.Debug
Debug)

HTML5 Token types per WHATWG spec

impl Show for Token

Token::equal

source

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

Token::not_equal

source

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

Token::output

source

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

Token::to_repr

source

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

Token::to_string

source

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

Tokenizer

source

pub struct Tokenizer {
  input : Array[Char]
  pos : Int
  line : Int
  column : Int
  last_pos : Int
  last_line : Int
  last_column : Int
  saw_eof : Bool
  input_error_reported : Array[Bool]
  state : State
  return_state : State
  errors : Array[ParseError]
  current_tag_name : StringBuilder
  current_tag_is_end : Bool
  current_tag_self_closing : Bool
  current_attrs : Array[Attribute]
  current_attr_name : StringBuilder
  current_attr_value : StringBuilder
  current_attr_duplicate : Bool
  current_comment : StringBuilder
  current_pi_target : StringBuilder
  current_pi_data : StringBuilder
  current_doctype_name : StringBuilder
  current_doctype_public_id : StringBuilder
  current_doctype_system_id : StringBuilder
  current_doctype_force_quirks : Bool
  current_doctype_public_id_set : Bool
  current_doctype_system_id_set : Bool
  char_ref_code : Int
  temp_buffer : StringBuilder
  last_start_tag_name : String
  pending_tokens : Array[Token]
  in_foreign_content : Bool
}

HTML5 Tokenizer per WHATWG Living Standard

Tokenizer::get_errors

source

fn Tokenizer::get_errors(self : Tokenizer) -> Array[ParseError]

Get all parse errors

Tokenizer::get_position

source

fn Tokenizer::get_position(self : Tokenizer) -> SourcePosition

Get current source position

Tokenizer::new

source

fn Tokenizer::new(input : String) -> Tokenizer

Create a tokenizer from a string

Tokenizer::next_token

source

fn Tokenizer::next_token(self : Tokenizer) -> Token

Read the next token

Tokenizer::switch_to_plaintext

source

fn Tokenizer::switch_to_plaintext(self : Tokenizer) -> Unit

Switch tokenizer to PLAINTEXT mode (for )

Tokenizer::switch_to_rawtext

source

fn Tokenizer::switch_to_rawtext(self : Tokenizer) -> Unit

Switch tokenizer to RAWTEXT mode (for , , etc.)

Tokenizer::switch_to_rcdata

source

fn Tokenizer::switch_to_rcdata(self : Tokenizer) -> Unit

Switch tokenizer to RCDATA mode (for , )

Tokenizer::switch_to_script_data

source

fn Tokenizer::switch_to_script_data(self : Tokenizer) -> Unit

Switch tokenizer to Script Data mode (for )

TreeBuilder

source

pub struct TreeBuilder {
  tokenizer : Tokenizer
  document : Document
  open_elements : Array[StackEntry]
  active_formatting : Array[FormattingEntry]
  mode : InsertionMode
  original_mode : InsertionMode
  template_modes : Array[InsertionMode]
  head_element : Int
  form_element : Int
  scripting : Bool
  frameset_ok : Bool
  foster_parenting : Bool
  pending_table_chars : Array[Char]
  skip_next_newline : Bool
  errors : Array[ParseError]
}

The HTML tree builder (WHATWG 13.2.6)

TreeBuilder::new

source

fn TreeBuilder::new(html : String) -> TreeBuilder

Create a new tree builder for parsing HTML

TreeBuilder::new_with_options

source

fn TreeBuilder::new_with_options(html : String, scripting~ : Bool) -> TreeBuilder

Create a new tree builder with options

TreeBuilder::parse

source

fn TreeBuilder::parse(self : TreeBuilder) -> Document

Parse the document and return it

NO_NODE

source

let NO_NODE : Int

Node index for O(1) parent/sibling access (using Int directly) Sentinel value NO_NODE = -1 indicates "no node"

is_formatting_element

source

fn is_formatting_element(name : String) -> Bool

Check if a tag name is a formatting element (adoption agency applies)

lookup_entity

source

fn lookup_entity(name : String) -> Array[Int]?

Lookup a named character reference (without the leading &) Returns array of codepoints if found

parse

source

fn parse(html : String) -> Document

Parse an HTML string and return the document

parse_with_errors

source

fn parse_with_errors(html : String) -> (Document, Array[ParseError])

Parse an HTML string and return the document with errors

parse_with_scripting

source

fn parse_with_scripting(html : String) -> Document

Parse an HTML string with scripting enabled

tokenize

source

fn tokenize(input : String) -> (Array[Token], Array[ParseError])

Tokenize entire input and return all tokens

Source Files

Site source Report issue Packages Build queue Skills Statistics

#Attribute

#Attribute::equal

#Attribute::not_equal

#Attribute::output

#Attribute::to_repr

#Attribute::to_string

#Document

#Document::add_node

#Document::append_child

#Document::dump

#Document::equal

#Document::get_attribute

#Document::get_children

#Document::get_element

#Document::get_node

#Document::get_ns

#Document::get_parent

#Document::get_tag_name

#Document::get_template_content

#Document::get_text_content

#Document::has_attribute

#Document::insert_before

#Document::is_element

#Document::is_html_element

#Document::new

#Document::not_equal

#Document::output

#Document::remove_child

#Document::set_attribute

#Document::to_html

#Document::to_repr

#Document::to_string

#Element

#Element::equal

#Element::new

#Element::not_equal

#Element::output

#Element::to_repr

#Element::to_string

#FormattingEntry

#InsertionMode

#Namespace

#Namespace::equal

#Namespace::not_equal

#Namespace::output

#Namespace::to_repr

#Namespace::to_string

#Node

#Node::equal

#Node::not_equal

#Node::output

#Node::to_repr

#Node::to_string

#ParseError

#ParseError::equal

#ParseError::not_equal

#ParseError::output

#ParseError::to_repr

#ParseError::to_string

#ParseErrorCode

#ParseErrorCode::equal

#ParseErrorCode::not_equal

#ParseErrorCode::output

#ParseErrorCode::to_repr

#ParseErrorCode::to_string

#QuirksMode

#QuirksMode::equal

#QuirksMode::not_equal

#QuirksMode::output

#QuirksMode::to_repr

#QuirksMode::to_string

#SourcePosition

#SourcePosition::equal

#SourcePosition::not_equal

#SourcePosition::output

#SourcePosition::to_repr

#SourcePosition::to_string

#StackEntry

#State

#State::equal

Attribute

Attribute::equal

Attribute::not_equal

Attribute::output

Attribute::to_repr

Attribute::to_string

Document

Document::add_node

Document::append_child

Document::dump

Document::equal

Document::get_attribute

Document::get_children

Document::get_element

Document::get_node

Document::get_ns

Document::get_parent

Document::get_tag_name

Document::get_template_content

Document::get_text_content

Document::has_attribute

Document::insert_before

Document::is_element

Document::is_html_element

Document::new

Document::not_equal

Document::output

Document::remove_child

Document::set_attribute

Document::to_html

Document::to_repr

Document::to_string

Element

Element::equal

Element::new

Element::not_equal

Element::output

Element::to_repr

Element::to_string

FormattingEntry

InsertionMode

Namespace

Namespace::equal

Namespace::not_equal

Namespace::output

Namespace::to_repr

Namespace::to_string

Node

Node::equal

Node::not_equal

Node::output

Node::to_repr

Node::to_string

ParseError

ParseError::equal

ParseError::not_equal

ParseError::output

ParseError::to_repr

ParseError::to_string

ParseErrorCode

ParseErrorCode::equal

ParseErrorCode::not_equal

ParseErrorCode::output

ParseErrorCode::to_repr

ParseErrorCode::to_string

QuirksMode

QuirksMode::equal

QuirksMode::not_equal

QuirksMode::output

QuirksMode::to_repr

QuirksMode::to_string

SourcePosition

SourcePosition::equal

SourcePosition::not_equal

SourcePosition::output

SourcePosition::to_repr

SourcePosition::to_string

StackEntry

State

State::equal