Struct GeneratorHtml 

pub struct GeneratorHtml {
    pub core: GeneratorCore,
    /* private fields */
}

Fields

core: GeneratorCore

Implementations

impl GeneratorHtml

pub fn new(setting: GeneratorBaseSetting, cfg: CfgHtml) -> Self

Trait Implementations

impl GeneratorBase for GeneratorHtml

const EXT: &'static str = "html"

File extension

fn core(&self) -> &GeneratorCore

Get reference to the core generator

fn core_mut(&mut self) -> &mut GeneratorCore

Get reference to the core generator

fn setting(&self) -> &GeneratorBaseSetting

Get reference to the core generator

fn is_public(&self) -> bool

True when privacy setting is set to Public

fn set_comp(&mut self, comp: CompInfo, top_is_rifmux: bool)

Get reference to the core generator

fn comp(&self) -> &CompInfo

Return access to component info

fn addr_width(&self) -> u8

Return address width of current compoment

fn set_addr_width(&mut self, width: u8)

Return address width of current compoment

fn data_width(&self) -> u8

Return data width of current compoment

fn comp_name(&self) -> &str

Return data width of current compoment

fn write(&mut self, txt: &str)

Write a string in main buffer

fn push_stash(&mut self, idx: usize, txt: &str)

Save a string in one of the two stash

fn pop_stash(&mut self, idx: usize)

Write a stash content into main buffer and clear the stash

fn pop_stash_to(&mut self, from: usize, to: usize)

Write a stash content into main buffer and clear the stash

fn stash_is_empty(&mut self, idx: usize) -> bool

Write a stash content into main buffer and clear the stash

fn save(&mut self, filename: &str, is_top: bool) -> Result<(), Box<dyn Error>>

Save the main buffer into a file and clear buffer and stash

fn casing(&mut self, txt: &str) -> String

Write a string in main buffer

fn filename_rif(&self, rif: &RifInst) -> String

fn filename_rifmux(&self, rifmux: &RifmuxInst) -> String

impl GeneratorDoc for GeneratorHtml

fn write_table_cell_top( &mut self, kind: (TableKind, CellKind), _span: usize, txt: &str, _id: &str, )

Write a table cell header

fn add_link(&mut self, kind: LinkKind, id: &str)

Add a link to an ID of the document

const HAS_LAYOUT: bool = true

Display register layout table

const SHOW_RESET: bool = true

Show register reset in top summary

const SHOW_TYPE: bool = false

Show type name summary tables (top/register)

const SHOW_SINGLE_REG: bool = true

Show register instance even when there is only one instance

fn set_rif_info(&mut self, rif: &RifInst)

Set the width of address/data for current RIF

fn write_header(&mut self, name: &str)

Write file header No header by default

fn write_rif_title(&mut self, idx_rif: (&str, usize), desc: &str)

Write component title

fn write_page_title( &mut self, idx_rif: (&str, usize), idx_page: (&str, usize), desc: (String, Option<String>), )

Write page title

fn write_reg_title( &mut self, idx_rif: (&str, usize), idx_page: (&str, usize), idx_reg: (&str, usize), desc: &str, _base_addr: Option<u64>, )

Write register title

fn write_table_title(&mut self, kind: TableKind, title: &str, id: &str)

Write a table header

fn write_table_footer(&mut self, _kind: TableKind)

Write a table header

fn write_table_row_header(&mut self, id: Option<&str>)

Write a table row header

fn write_table_row_footer(&mut self)

Write a table row footer

fn write_table_cell( &mut self, kind: (TableKind, CellKind), span: usize, txt: &str, id: &str, tip: Option<String>, )

Write a table column

fn enum_def_desc(&mut self, def: &EnumDef) -> String

Write description of an enum field

fn sanitize(&self, raw: &str) -> String

Sanitize a text from all special characters Default implementation provides a simple copy

fn write_info(&mut self, info: &str)

Write component/page information

const SHOW_UNUSED: bool = false

Show unused part of a register

fn gen_all(&mut self, obj: &Comp) -> Result<(), Box<dyn Error>>

Main generator function

fn add_rifmux_entry( &mut self, comp: &CompInst, w: usize, offset: u64, top_name: Option<&str>, groups: &[RifmuxGroupInst], )

Add rifmux row in a table composed of 4 column: Address, Type, Instance and short description

fn write_rifmux_entry( &mut self, inst_name: &str, type_name: &str, addr: (u64, usize), desc: &str, show_type: bool, )

fn add_rif( &mut self, rif: &RifInst, idx: usize, info: &[RifInstInfo], ) -> Result<(), String>

Add RIF description

fn add_reg_summary(&mut self, rif: &RifInst, info: &[RifInstInfo])

Add register summary

fn write_reg_summary_header(&mut self, rif: &RifInst)

fn add_rif_summary(&mut self, rif: &RifInst, infos: &[RifInstInfo])

Summary of RIF instances when there is more than one

fn add_reg_detail( &mut self, rif: &RifInst, idx_c: usize, base_addr: Option<u64>, ) -> Result<(), String>

Add register details: table with register instance followed by table with fields description

fn write_reg_detail_header(&mut self, rif: &RifInst)

Write header for the register detail tables

fn access_str(kind: &FieldSwKind) -> &str

Convert access to string

fn write_footer(&mut self, name: &str)

Write file footer (empty by default)

fn write_table_row_top_header(&mut self, kind: TableKind)

Write a table top row header

fn write_table_row_top_footer(&mut self)

Write a table top row footer