Skip to content

feat: add enum to docnode #8

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Open
sjalloq wants to merge 1 commit into
base: main
Choose a base branch
from
Open

feat: add enum to docnode #8

Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
40 changes: 35 additions & 5 deletions src/sphinx_peakrdl/directives/docnode.py
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -9,6 +9,7 @@
from docutils.parsers.rst import directives

from systemrdl.node import Node, RegNode, AddressableNode, SignalNode, RootNode
from systemrdl.rdltypes import UserEnum
from systemrdl.rdltypes.references import PropertyReference
from systemrdl.source_ref import FileSourceRef, DetailedFileSourceRef

Expand Down Expand Up @@ -209,15 +210,34 @@ def make_rdl_node_doc(self, rdl_node: Node) -> Sequence[nodes.Element]:
return doc_nodes


def _build_enum_table(self, enum_cls: type) -> nodes.table:
"""Build a table of enum members showing value, name, and description."""
table = Table(["Value", "Name", "Description"])
for member in enum_cls:
table.add_row([
f"{member.value:#x}",
member.name,
member.rdl_desc or "-",
])
return table.as_node()

def make_rdl_reg_doc(self, rdl_node: RegNode) -> Sequence[nodes.Element]:
# Info Field List Header
fl = self.get_info_header(rdl_node)

# Description
desc_paragraph = self.get_rdl_desc(rdl_node)

# Check if any field uses an enum encoding
has_enums = any(
field.get_property("encode") for field in rdl_node.fields()
)

# Field Table
table = Table(["Bits", "Identifier", "Access", "Reset", "Name"])
headings = ["Bits", "Identifier", "Access", "Reset", "Name"]
if has_enums:
headings.append("Encode")
table = Table(headings)
for field in reversed(rdl_node.fields()):
# Is actual field
if field.width == 1:
Expand Down Expand Up @@ -245,28 +265,38 @@ def make_rdl_reg_doc(self, rdl_node: RegNode) -> Sequence[nodes.Element]:
else:
reset = self.get_rdl_xref(reset_value)

table.add_row([
row = [
bitrange,
field.inst_name,
access,
reset,
field.get_property("name", default="-"),
])
]
if has_enums:
encode = field.get_property("encode")
encode_name = encode.type_name if encode and issubclass(encode, UserEnum) else "-"
row.append(encode_name)

table.add_row(row)

# Field descriptions
def_list = nodes.definition_list()
for field in reversed(rdl_node.fields()):
desc = field.get_property("desc")
if not desc:
continue
encode = field.get_property("encode")

dli = nodes.definition_list_item()
def_list.append(dli)

dl_term = nodes.term(text = field.inst_name)
dl_def = nodes.definition()
dl_def_p = self.get_rdl_desc(field)
dl_def.append(dl_def_p)
if desc:
dl_def_p = self.get_rdl_desc(field)
dl_def.append(dl_def_p)
if encode and issubclass(encode, UserEnum):
dl_def.append(self._build_enum_table(encode))

dli.append(dl_term)
dli.append(dl_def)
Expand Down