hdl_registers.generator.html package

Submodules

hdl_registers.generator.html.constant_table module

class hdl_registers.generator.html.constant_table.HtmlConstantTableGenerator(register_list: RegisterList, output_folder: Path)

Bases: HtmlGeneratorCommon

Generate HTML code with register constant information in a table.

SHORT_DESCRIPTION = 'HTML constant table'

__init__(register_list: RegisterList, output_folder: Path)

Parameters:

register_list – Registers and constants from this register list will be included in the generated artifacts.
output_folder – Result file will be placed in this folder.

get_code(**kwargs: Any) → str

Get the generated code as a string.

Overload in a subclass where the code generation is implemented.

Parameters:: kwargs – Further optional parameters that can be used. Can send any number of named arguments, per the requirements of get_code() of any custom generators that inherit this class.

property output_file: Path: Result will be placed in this file.

hdl_registers.generator.html.html_generator_common module

class hdl_registers.generator.html.html_generator_common.HtmlGeneratorCommon(register_list: RegisterList, output_folder: Path)

Bases: RegisterCodeGenerator, RegisterCodeGeneratorHelpers

Common for HTML code generators.

COMMENT_END: str = ' -->'

COMMENT_START: str = '<!--'

hdl_registers.generator.html.html_translator module

class hdl_registers.generator.html.html_translator.HtmlTranslator

Bases: object

Translate a raw text with markdown/rst annotations into HTML code.

Supports:

Strong: double asterisks
Emphasis: single asterisks

Literal asterisks should be escaped: *

translate(text: str) → str: Translate the text to have HTML tags where appropriate.

hdl_registers.generator.html.page module

class hdl_registers.generator.html.page.HtmlPageGenerator(register_list: RegisterList, output_folder: Path)

Bases: HtmlGeneratorCommon

Generate a HTML page with register and constant information.

SHORT_DESCRIPTION = 'HTML page'

get_code(**kwargs: Any) → str

Get a complete HTML page with register and constant information.

Parameters:

register_objects – Registers and register arrays to be included.
constants – Constants to be included.

Returns:

HTML code.

Return type:

str

static get_page_style(table_style: str | None = None, font_style: str | None = None, extra_style: str = '') → str

Get a CSS style for the register pages. Shall be saved to a file called regs_style.css.

Returns:: CSS code.
Return type:: str

property output_file: Path: Result will be placed in this file.

hdl_registers.generator.html.register_table module

class hdl_registers.generator.html.register_table.HtmlRegisterTableGenerator(register_list: RegisterList, output_folder: Path)

Bases: HtmlGeneratorCommon

Generate HTML code with register information in a table.

SHORT_DESCRIPTION = 'HTML register table'

__init__(register_list: RegisterList, output_folder: Path)

Parameters:

register_list – Registers and constants from this register list will be included in the generated artifacts.
output_folder – Result file will be placed in this folder.

get_code(**kwargs: Any) → str

Get the generated code as a string.

Overload in a subclass where the code generation is implemented.

Parameters:: kwargs – Further optional parameters that can be used. Can send any number of named arguments, per the requirements of get_code() of any custom generators that inherit this class.

property output_file: Path: Result will be placed in this file.