dom/core

ParseErrorKind -- the shared Syntax node.

(ParseError (syntax-kind) (from-cstr "mismatched tag") 3 7)

SourcePos -- 1-based line and byte column; (SourcePos 0 0) when the error has no position (an Io error).

(.line (parse-error-pos e))   ; => 3

cstr -- valid until `parse-error-release`.

(println (parse-error-message e))   ; e.g. "mismatched tag"

(parse-error-release e)

(Option Node) -- none only for a document with no element at all (an empty HTML fragment, say).

(match (dom-root d)
    (Some r) (node-name r)   ; => (Some "feed")
    (None)   (None))

Node -- the invisible root.

(node-children (dom-node d))   ; => doctype, comments, root element

(dom-free d)

int -- elements, text, comments, CDATA, PIs and doctypes together.

(dom-node-count d)   ; => 3 for <a>x<b/></a>

int -- bytes, including each arena chunk's header.

(let [before (dom-live-bytes)]
    (dom-free (ok-val (dom-parse-string "<a/>")))
    (= before (dom-live-bytes)))   ; => true

NodeKind

(match (node-kind n) (ElementNode) "element" (TextNode) "text" ...)

bool

(node-element? (dom-node d))   ; => false (the document node)

(Option cstr) -- borrowed from the document; none for text, comment, CDATA and document nodes.

(node-name root)   ; => (Some "rss")

(Option cstr) -- `link` for `<atom:link>`; none for non-elements.

(node-local-name n)   ; => (Some "link")

(Option cstr) -- none for an element in no namespace, and for non-elements.

(node-ns-uri feed)   ; => (Some "http://www.w3.org/2005/Atom")

(Option cstr) -- borrowed from the document; none for elements, the doctype and the document node.

(match (node-first-child p)          ; <p>hello</p>
    (Some t) (node-value t)            ; => (Some "hello")
    (None)   (None))

String -- owned; release it when done.

(node-text p)   ; => "abc" for <p>a<b>b</b>c</p>

(Option cstr) -- borrowed from the document; none when absent or when `n` is not an element.

(node-attr link "href")   ; => (Some "https://example.com/")

int -- 0 for non-elements.

(node-attr-count (dom-root d))   ; => 2 for <a x="1" y="2"/>

(Option cstr) -- borrowed; none when out of range.

(node-attr-name-at el 0)   ; => (Some "x")

(Option cstr) -- borrowed; none when out of range.

(node-attr-value-at el 0)   ; => (Some "1")

(Option Node) -- the root element's parent is the document node; the document node has none.

(node-parent title)   ; => (Some head)

(Option Node) -- none for a leaf.

(node-first-child (dom-node d))

(Option Node) -- none for a leaf.

(node-last-child body)

(Option Node) -- none for the last child.

(node-next-sibling item)

(Option Node) -- none for the first child.

(node-prev-sibling item)

int

(node-child-count (dom-node d))

(Cons Node) -- `(tnil)` for a leaf.

(tlength (node-children root))   ; => 3

Document -- the same handle `dom-free` takes.

(dom-free (node-document root))

(Option SourcePos) -- XML nodes carry their start position; HTML nodes and the document node do not (lexbor's tree does not record them).

(node-pos item)   ; => (Some (SourcePos 4 3))

int -- 0 for the document node, 1 for the root element.

(node-depth (dom-node d))   ; => 0

bool -- false for every non-element.

(node-matches? n "{http://www.w3.org/2005/Atom}entry")

(Cons Node) -- `(tnil)` when nothing matches.

(tlength (find-all (dom-node d) "item"))   ; => number of <item>s

(Option Node) -- none when nothing matches.

(find-first (dom-node d) "title")

String -- owned; release it when done.

(to-cstr (dom-serialize root))   ; => "<a x=\"1\"><b/></a>"

bool

(dom-equal? (dom-node d1) (dom-node d2))