hdl_registers.generator.cpp package

Submodules

class hdl_registers.generator.cpp.cpp_generator_common.CppGeneratorCommon(register_list: RegisterList, output_folder: Path)

Class with common methods for generating C++ code.

__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.

class hdl_registers.generator.cpp.header.CppHeaderGenerator(register_list: RegisterList, output_folder: Path)

Class to generate a C++ header.

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.

class hdl_registers.generator.cpp.implementation.CppImplementationGenerator(register_list: RegisterList, output_folder: Path)

Class to generate a C++ implementation.

get_code(**kwargs: Any) → str: Get a complete C++ class implementation with all methods.

class hdl_registers.generator.cpp.interface.CppInterfaceGenerator(register_list: RegisterList, output_folder: Path)

Class to generate a C++ interface header.

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.