ra8_rabook_buffers_t Struct Reference

Caller-owned, fixed-capacity arenas the builder appends into (no heap). More...

#include <rabook_compile.h>

Collaboration diagram for ra8_rabook_buffers_t:

Data Fields
book_chapter_t *	chapters
	Chapter-table arena.
book_node_t *	nodes
	Node-table arena.
book_attr_t *	attrs
	Attribute-table arena.
book_stylesheet_t *	stylesheets
	Stylesheet-table arena.
book_image_t *	images
	Image-table arena.
char *	string_pool
	String-pool byte arena.
uint8_t *	image_pool
	Image-pool byte arena.
uint8_t *	out
	Final-blob output buffer.
uint32_t	chapter_cap
	Max chapters.
uint32_t	node_cap
	Max DOM nodes.
uint32_t	attr_cap
	Max attribute records.
uint32_t	stylesheet_cap
	Max stylesheets.
uint32_t	image_cap
	Max image descriptors.
uint32_t	string_cap
	String-pool capacity in bytes.
uint32_t	image_pool_cap
	Image-pool capacity in bytes.
uint32_t	out_cap
	Output capacity in bytes.

Detailed Description

Caller-owned, fixed-capacity arenas the builder appends into (no heap).

The caller sizes each arena for its worst-case book. The builder never allocates; it only fills these. *_cap are element counts for the typed tables and byte capacities for the pools and the output.

Invariant

Every pointer is non-NULL and each arena holds at least its _cap.

Since

Version 0.1.0

Definition at line 66 of file rabook_compile.h.

Field Documentation

attr_cap

uint32_t ra8_rabook_buffers_t::attr_cap

Max attribute records.

Definition at line 79 of file rabook_compile.h.

Referenced by internal_allocate_builder(), and ra8_rabook_add_element().

attrs

book_attr_t* ra8_rabook_buffers_t::attrs

Attribute-table arena.

Definition at line 71 of file rabook_compile.h.

Referenced by internal_allocate_builder(), internal_append_attrs(), internal_check_buffer_members(), and internal_segments().

chapter_cap

uint32_t ra8_rabook_buffers_t::chapter_cap

Max chapters.

Definition at line 77 of file rabook_compile.h.

Referenced by internal_allocate_builder(), and ra8_rabook_add_chapter().

chapters

book_chapter_t* ra8_rabook_buffers_t::chapters

Chapter-table arena.

Definition at line 69 of file rabook_compile.h.

Referenced by internal_allocate_builder(), internal_check_buffer_members(), internal_segments(), and ra8_rabook_add_chapter().

image_cap

uint32_t ra8_rabook_buffers_t::image_cap

Max image descriptors.

Definition at line 81 of file rabook_compile.h.

Referenced by internal_allocate_builder(), ra8_rabook_add_image(), and ra8_rabook_add_image_external().

image_pool

uint8_t* ra8_rabook_buffers_t::image_pool

Image-pool byte arena.

Definition at line 75 of file rabook_compile.h.

Referenced by internal_allocate_builder(), internal_check_buffer_members(), internal_crc_image_pool(), internal_write_image_pool(), and ra8_rabook_add_image().

image_pool_cap

uint32_t ra8_rabook_buffers_t::image_pool_cap

Image-pool capacity in bytes.

Definition at line 83 of file rabook_compile.h.

Referenced by internal_allocate_builder(), and ra8_rabook_add_image().

images

book_image_t* ra8_rabook_buffers_t::images

Image-table arena.

Definition at line 73 of file rabook_compile.h.

Referenced by internal_allocate_builder(), internal_append_image_descriptor(), internal_check_buffer_members(), and internal_segments().

node_cap

uint32_t ra8_rabook_buffers_t::node_cap

Max DOM nodes.

Definition at line 78 of file rabook_compile.h.

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

nodes

book_node_t* ra8_rabook_buffers_t::nodes

Node-table arena.

Definition at line 70 of file rabook_compile.h.

Referenced by internal_allocate_builder(), internal_check_buffer_members(), internal_segments(), ra8_rabook_add_element(), ra8_rabook_add_text(), ra8_rabook_link_child(), and ra8_rabook_link_sibling().

out

uint8_t* ra8_rabook_buffers_t::out

Final-blob output buffer.

Definition at line 76 of file rabook_compile.h.

Referenced by internal_allocate_builder(), internal_check_buffer_members(), and ra8_rabook_finalize().

out_cap

uint32_t ra8_rabook_buffers_t::out_cap

Output capacity in bytes.

Definition at line 84 of file rabook_compile.h.

Referenced by internal_allocate_builder(), internal_validate_memory_finalize(), and ra8_rabook_finalize().

string_cap

uint32_t ra8_rabook_buffers_t::string_cap

String-pool capacity in bytes.

Definition at line 82 of file rabook_compile.h.

Referenced by internal_allocate_builder(), internal_intern_span(), and ra8_rabook_intern().

string_pool

char* ra8_rabook_buffers_t::string_pool

String-pool byte arena.

Definition at line 74 of file rabook_compile.h.

Referenced by internal_allocate_builder(), internal_check_buffer_members(), internal_intern_span(), internal_segments(), and ra8_rabook_intern().

stylesheet_cap

uint32_t ra8_rabook_buffers_t::stylesheet_cap

Max stylesheets.

Definition at line 80 of file rabook_compile.h.

Referenced by internal_allocate_builder(), and ra8_rabook_add_stylesheet().

stylesheets

book_stylesheet_t* ra8_rabook_buffers_t::stylesheets

Stylesheet-table arena.

Definition at line 72 of file rabook_compile.h.

Referenced by internal_allocate_builder(), internal_check_buffer_members(), internal_segments(), and ra8_rabook_add_stylesheet().

---

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

• apps/shared_libs/rabook_compile/inc/rabook_compile.h