mdl_state_t Struct Reference

One series' complete persistent state (declare at file scope). More...

#include <mdl_state.h>

Collaboration diagram for mdl_state_t:

Data Fields
uint16_t	version
	Schema version.
char	series_url [k_mdl_url_max]
	Series page URL.
char	series_title [k_mdl_title_max]
	Series title.
char	site_name [k_mdl_name_max]
	Descriptor name.
char	site_host [k_mdl_host_max]
	Site host.
char	config_path [k_mdl_cfgpath_max]
	Descriptor used.
char	summary [k_mdl_summary_max]
	Series synopsis.
char	writer [k_mdl_person_max]
	Writer/author.
char	artist [k_mdl_person_max]
	Artist/illustrator.
char	cover_url [k_mdl_url_max]
	Remote cover URL.
char	cover_path [k_mdl_relpath_max]
	Local cover path.
char	language [k_mdl_language_max]
	BCP-47 language tag.
mdl_state_reading_direction_t	reading_direction
	Page progression.
uint16_t	chapter_count
	Chapters recorded.
uint32_t	page_rec_count
	Page records recorded.
mdl_chapter_rec_t	chapters [k_mdl_max_chapters]
	Per-chapter coverage.
mdl_page_rec_t	pages [k_mdl_max_page_recs]
	Per-page identities.

Detailed Description

One series' complete persistent state (declare at file scope).

About 2 MiB (it embeds the chapter table and page pool), so it lives in .bss, not on the stack, exactly like the session and page buffers. One instance serves one series at a time; library-wide commands reuse it series by series.

Invariant

chapter_count <= k_mdl_max_chapters.

page_rec_count <= k_mdl_max_page_recs.

See also

mdl_state_load

mdl_state_save

Since

0.1.0

Definition at line 175 of file mdl_state.h.

Field Documentation

artist

char mdl_state_t::artist[k_mdl_person_max]

Artist/illustrator.

Definition at line 184 of file mdl_state.h.

Referenced by internal_mdl_state_apply_metadata(), internal_mdl_state_emit_metadata(), internal_snapshot_prior_metadata(), mdl_state_set_series_metadata(), and priv_mdl_state_valid().

chapter_count

uint16_t mdl_state_t::chapter_count

Chapters recorded.

Definition at line 191 of file mdl_state.h.

Referenced by internal_mdl_state_complete_span(), internal_mdl_state_emit_chapters(), internal_mdl_state_has_complete_number(), mdl_state_add_chapter_numbered(), mdl_state_chapter_complete(), mdl_state_chapter_pages(), mdl_state_coverage(), mdl_state_find_chapter(), and priv_mdl_state_valid().

chapters

mdl_chapter_rec_t mdl_state_t::chapters[k_mdl_max_chapters]

Per-chapter coverage.

Definition at line 195 of file mdl_state.h.

Referenced by internal_mdl_state_complete_span(), internal_mdl_state_emit_chapters(), internal_mdl_state_has_complete_number(), mdl_state_add_chapter_numbered(), mdl_state_chapter_complete(), mdl_state_chapter_pages(), mdl_state_coverage(), mdl_state_find_chapter(), and priv_mdl_state_valid().

config_path

char mdl_state_t::config_path[k_mdl_cfgpath_max]

Descriptor used.

Definition at line 181 of file mdl_state.h.

Referenced by internal_mdl_state_apply_line(), internal_mdl_state_emit_metadata(), internal_update_all_cb(), mdl_state_set_series(), and priv_mdl_state_valid().

cover_path

char mdl_state_t::cover_path[k_mdl_relpath_max]

Local cover path.

Definition at line 186 of file mdl_state.h.

Referenced by internal_cover_current(), internal_cover_finish(), internal_mdl_state_apply_metadata(), internal_mdl_state_emit_metadata(), internal_snapshot_prior_metadata(), mdl_state_set_series_metadata(), and priv_mdl_state_valid().

cover_url

char mdl_state_t::cover_url[k_mdl_url_max]

Remote cover URL.

Definition at line 185 of file mdl_state.h.

Referenced by internal_mdl_state_apply_metadata(), internal_mdl_state_emit_metadata(), internal_snapshot_prior_metadata(), mdl_state_set_series_metadata(), and priv_mdl_state_valid().

language

char mdl_state_t::language[k_mdl_language_max]

BCP-47 language tag.

Definition at line 187 of file mdl_state.h.

Referenced by internal_mdl_state_apply_metadata(), internal_mdl_state_emit_metadata(), mdl_state_set_series_metadata(), and priv_mdl_state_valid().

page_rec_count

uint32_t mdl_state_t::page_rec_count

Page records recorded.

Definition at line 193 of file mdl_state.h.

Referenced by internal_mdl_fetch_publish_page(), internal_mdl_state_emit_pages(), internal_verify_series_dir(), mdl_state_add_page(), mdl_state_find_page(), mdl_state_note_page_response(), and priv_mdl_state_valid().

pages

mdl_page_rec_t mdl_state_t::pages[k_mdl_max_page_recs]

Per-page identities.

Definition at line 197 of file mdl_state.h.

Referenced by internal_mdl_state_emit_pages(), internal_verify_series_dir(), mdl_state_add_page(), mdl_state_find_page(), mdl_state_note_page_response(), and priv_mdl_state_valid().

reading_direction

mdl_state_reading_direction_t mdl_state_t::reading_direction

Page progression.

Definition at line 189 of file mdl_state.h.

Referenced by internal_build_export_metadata(), internal_mdl_state_apply_line(), internal_mdl_state_emit_metadata(), mdl_state_set_series_metadata(), and priv_mdl_state_valid().

series_title

char mdl_state_t::series_title[k_mdl_title_max]

Series title.

Definition at line 178 of file mdl_state.h.

Referenced by internal_mdl_state_apply_line(), internal_mdl_state_emit_metadata(), internal_snapshot_prior_metadata(), mdl_state_set_series(), and priv_mdl_state_valid().

series_url

char mdl_state_t::series_url[k_mdl_url_max]

Series page URL.

Definition at line 177 of file mdl_state.h.

Referenced by internal_cover_cached(), internal_cover_stream(), internal_list_cb(), internal_mdl_state_apply_line(), internal_mdl_state_emit_metadata(), internal_update_all_cb(), mdl_state_set_series(), and priv_mdl_state_valid().

site_host

char mdl_state_t::site_host[k_mdl_host_max]

Site host.

Definition at line 180 of file mdl_state.h.

Referenced by internal_mdl_state_apply_line(), internal_mdl_state_emit_metadata(), mdl_state_set_series(), and priv_mdl_state_valid().

site_name

char mdl_state_t::site_name[k_mdl_name_max]

Descriptor name.

Definition at line 179 of file mdl_state.h.

Referenced by internal_mdl_state_apply_line(), internal_mdl_state_emit_metadata(), mdl_state_set_series(), and priv_mdl_state_valid().

summary

char mdl_state_t::summary[k_mdl_summary_max]

Series synopsis.

Definition at line 182 of file mdl_state.h.

Referenced by internal_mdl_state_apply_metadata(), internal_mdl_state_emit_metadata(), internal_snapshot_prior_metadata(), mdl_state_set_series_metadata(), and priv_mdl_state_valid().

version

uint16_t mdl_state_t::version

Schema version.

Definition at line 176 of file mdl_state.h.

Referenced by mdl_state_init(), and priv_mdl_state_valid().

writer

char mdl_state_t::writer[k_mdl_person_max]

Writer/author.

Definition at line 183 of file mdl_state.h.

Referenced by internal_mdl_state_apply_metadata(), internal_mdl_state_emit_metadata(), internal_snapshot_prior_metadata(), mdl_state_set_series_metadata(), and priv_mdl_state_valid().

---

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

• apps/shared_libs/mdl/inc/mdl_state.h