book_node_t Struct Reference

One DOM node. More...

#include <book.h>

Data Fields
uint8_t	kind
	book_node_kind_t.
uint8_t	reserved
	Padding; 0.
uint16_t	attr_count
	Element: number of attributes (text: 0).
uint32_t	name_off
	Element: string-pool offset of tag name (text: 0).
uint32_t	text_off
	Text: string-pool offset of the run (element: 0).
uint32_t	first_attr
	Index of first attribute, or nil.
uint32_t	first_child
	Index of first child node, or nil.
uint32_t	next_sibling
	Index of next sibling node, or nil.

Detailed Description

One DOM node.

Children form a singly-linked sibling chain.

Walk an element's children by reading first_child then following each node's next_sibling until k_book_nil. Element nodes set name_off (tag name) and may have attributes; text nodes set text_off and have neither attributes nor children.

Invariant

kind == k_book_node_text implies attr_count == 0, first_attr == nil and first_child == nil.

Since

Version 0.1.0

Definition at line 299 of file book.h.

Field Documentation

attr_count

uint16_t book_node_t::attr_count

Element: number of attributes (text: 0).

Definition at line 302 of file book.h.

Referenced by internal_emit_attrs(), ra8_rabook_add_element(), and ra8_rabook_add_text().

first_attr

uint32_t book_node_t::first_attr

Index of first attribute, or nil.

Definition at line 305 of file book.h.

Referenced by internal_emit_attrs(), ra8_rabook_add_element(), and ra8_rabook_add_text().

first_child

uint32_t book_node_t::first_child

Index of first child node, or nil.

Definition at line 306 of file book.h.

Referenced by collect_chapter_text(), internal_open_element(), internal_paged_visit_node(), internal_walk_text(), ra8_rabook_add_element(), ra8_rabook_add_text(), and ra8_rabook_link_child().

kind

uint8_t book_node_t::kind

book_node_kind_t.

Definition at line 300 of file book.h.

Referenced by collect_chapter_text(), internal_paged_visit_node(), internal_walk_text(), internal_walk_to_xhtml(), ra8_rabook_add_element(), and ra8_rabook_add_text().

name_off

uint32_t book_node_t::name_off

Element: string-pool offset of tag name (text: 0).

Definition at line 303 of file book.h.

Referenced by book_node_name(), internal_open_element(), internal_paged_visit_node(), internal_walk_text(), ra8_rabook_add_element(), and ra8_rabook_add_text().

next_sibling

uint32_t book_node_t::next_sibling

Index of next sibling node, or nil.

Definition at line 307 of file book.h.

Referenced by collect_chapter_text(), internal_paged_visit_node(), internal_walk_text(), internal_walk_to_xhtml(), ra8_rabook_add_element(), ra8_rabook_add_text(), and ra8_rabook_link_sibling().

reserved

uint8_t book_node_t::reserved

Padding; 0.

Definition at line 301 of file book.h.

text_off

uint32_t book_node_t::text_off

Text: string-pool offset of the run (element: 0).

Definition at line 304 of file book.h.

Referenced by book_node_text(), internal_paged_visit_node(), internal_walk_text(), internal_walk_to_xhtml(), ra8_rabook_add_element(), and ra8_rabook_add_text().

---

The documentation for this struct was generated from the following file:

• apps/shared_libs/book/inc/book.h