mirror of
https://github.com/YosysHQ/yosys
synced 2025-04-06 01:24:10 +00:00
04b0ae540d
Drop the default help message from rst while still displaying it on the command line. Fix command line formatting for older style help messages.
103 lines
2.9 KiB
Python
103 lines
2.9 KiB
Python
#!/usr/bin/env python3
|
|
|
|
from __future__ import annotations
|
|
import fileinput
|
|
import json
|
|
from pathlib import Path
|
|
|
|
class SimHelper:
|
|
name: str = ""
|
|
title: str = ""
|
|
ports: str = ""
|
|
source: str = ""
|
|
desc: list[str]
|
|
code: list[str]
|
|
group: str = ""
|
|
ver: str = "1"
|
|
|
|
def __init__(self) -> None:
|
|
self.desc = []
|
|
|
|
def __str__(self) -> str:
|
|
printed_fields = [
|
|
"name", "title", "ports", "source", "desc", "code", "group", "ver",
|
|
]
|
|
# generate C++ struct
|
|
val = f"cell_help[{json.dumps(self.name)}] = "
|
|
val += "{\n"
|
|
for field in printed_fields:
|
|
field_val = getattr(self, field)
|
|
if isinstance(field_val, list):
|
|
field_val = "\n".join(field_val)
|
|
field_val = field_val.strip()
|
|
val += f' {json.dumps(field_val)},\n'
|
|
val += "};\n"
|
|
return val
|
|
|
|
def simcells_reparse(cell: SimHelper):
|
|
# cut manual signature
|
|
cell.desc = cell.desc[3:]
|
|
|
|
# code-block truth table
|
|
new_desc = []
|
|
indent = ""
|
|
for line in cell.desc:
|
|
if line.startswith("Truth table:"):
|
|
indent = " "
|
|
new_desc.pop()
|
|
new_desc.extend(["::", ""])
|
|
new_desc.append(indent + line)
|
|
cell.desc = new_desc
|
|
|
|
# set version
|
|
cell.ver = "2a"
|
|
|
|
simHelper = SimHelper()
|
|
|
|
for line in fileinput.input():
|
|
line = line.rstrip()
|
|
# special comments
|
|
if line.startswith("//-"):
|
|
simHelper.desc.append(line[4:] if len(line) > 4 else "")
|
|
elif line.startswith("//* "):
|
|
_, key, val = line.split(maxsplit=2)
|
|
setattr(simHelper, key, val)
|
|
|
|
# code parsing
|
|
if line.startswith("module "):
|
|
clean_line = line[7:].replace("\\", "").replace(";", "")
|
|
simHelper.name, simHelper.ports = clean_line.split(maxsplit=1)
|
|
simHelper.code = []
|
|
short_filename = Path(fileinput.filename()).name
|
|
simHelper.source = f'{short_filename}:{fileinput.filelineno()}'
|
|
elif not line.startswith("endmodule"):
|
|
line = " " + line
|
|
try:
|
|
simHelper.code.append(line.replace("\t", " "))
|
|
except AttributeError:
|
|
# no module definition, ignore line
|
|
pass
|
|
if line.startswith("endmodule"):
|
|
short_filename = Path(fileinput.filename()).name
|
|
if simHelper.ver == "1" and short_filename == "simcells.v":
|
|
# default simcells parsing
|
|
simcells_reparse(simHelper)
|
|
|
|
# check help
|
|
if simHelper.desc and simHelper.ver == "1" and short_filename == "simlib.v" and simHelper.desc[1].startswith(' '):
|
|
simHelper.desc.pop(1)
|
|
|
|
# check group
|
|
if not simHelper.group:
|
|
if short_filename == 'simcells.v':
|
|
simHelper.group = "gate_"
|
|
elif short_filename == 'simlib.v':
|
|
simHelper.group = "word_"
|
|
simHelper.group += "other"
|
|
|
|
# dump
|
|
print(simHelper)
|
|
# new
|
|
simHelper = SimHelper()
|
|
|