warehack.ing/WireViz
2
0
Fork 0
Code Issues Pull Requests Actions Packages Projects Releases Wiki Activity

WIP: add templates connector

Browse Source 
doesn't support all current features of the connectors.
We should at least support those before updating the template
This commit is contained in:
Laurier Loiselle 2023-04-11 16:32:41 -04:00
parent 3c9f32481f
commit b687a9f134
No known key found for this signature in database
GPG Key ID: 345920CC72089A3F
3 changed files with 143 additions and 26 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

26
src/wireviz/templates/connector.html generated Normal file
View File

@ -0,0 +1,26 @@
<!-- Connector definition Table !-->
<!-- Has 3 columns !-->
<table border="0" cellborder="1" cellspacing="0" cellpadding="3" bgcolor="#FFFFFF">
<!-- Header !-->
<tr>
<td colspan="{{ columns }}">
<b> {{ designator }} </b>
</td>
</tr>
<tr>
<td> {{ type }} </td>
<td> {{ subtype }} </td>
{% if show_pincount %} <td > {{ pincount }}-pin </td> {% endif %}
</tr>
<!-- Pins !-->
{% for pin in pins %}
<tr>
{% if use_left %} <td port="p{{ pin.index + 1 }}l"> {{ pin.id }} </td> {% endif %}
<td colspan="2"> {{ pin.label }} </td>
{% if use_right %} <td port="p{{ pin.index + 1 }}r"> {{ pin.id }} </td> {% endif %}
</tr>
{% endfor %}
<!-- Additional Components !-->
</table>

135
src/wireviz/wv_graphviz.py
View File

@ -19,8 +19,118 @@ from wireviz.wv_dataclasses import (
)
from wireviz.wv_html import Img, Table, Td, Tr
from wireviz.wv_utils import html_line_breaks, remove_links
from wireviz.wv_templates import get_template
def gv_pin_table(component) -> Table:
pin_rows = []
for pin in component.pin_objects.values():
if component.should_show_pin(pin.id):
pin_rows.append(gv_pin_row(pin, component))
if len(pin_rows) == 0:
# TODO: write test for empty pin tables, and for unconnected connectors that hide disconnected pins
pass
tbl = Table(pin_rows, border=0, cellborder=1, cellpadding=3, cellspacing=0)
return tbl
def gv_pin_row(pin, connector) -> Tr:
# ports in GraphViz are 1-indexed for more natural maping to pin/wire numbers
has_pincolors = any([_pin.color for _pin in connector.pin_objects.values()])
cells = [
Td(pin.id, port=f"p{pin.index+1}l") if connector.ports_left else None,
Td(pin.label, delete_if_empty=True),
Td(str(pin.color) if pin.color else "", sides="TBL") if has_pincolors else None,
Td(color_minitable(pin.color), sides="TBR") if has_pincolors else None,
Td(pin.id, port=f"p{pin.index+1}r") if connector.ports_right else None,
]
return Tr(cells)
def gv_node_connector(connector: Connector) -> Table:
pins = []
use_left = bool(connector.ports_left)
use_right = bool(connector.ports_right)
for pin in connector.pin_objects.values():
if not connector.should_show_pin(pin.id):
continue
pins.append({
'id': pin.id,
'index': pin.index,
'label': pin.label,
#'color': pin.color,
#TODO: support color minitable?
})
columns = 2 + (1 if use_left else 0) + (1 if use_right else 0)
params = {
'designator': f"{remove_links(connector.designator)}",
'use_left': use_left,
'use_right': use_right,
'pins': pins,
'columns': columns,
# TODO: support asdict(connector)
'type': html_line_breaks(connector.type),
'subtype': html_line_breaks(connector.subtype),
'pincount': connector.pincount,
'show_pincount': connector.show_pincount
}
return get_template("connector.html").render(params)
## If no wires connected (except maybe loop wires)?
#if isinstance(connector, Connector):
# if not (connector.ports_left or connector.ports_right):
# connector.ports_left = True # Use left side pins by default
## generate all rows to be shown in the node
#if connector.show_name:
# str_name = f"{remove_links(connector.designator)}"
# line_name = Td(str_name, bgcolor=connector.bgcolor_title.html)
#else:
# line_name = None
#line_pn = partnumbers2list(connector.partnumbers)
#is_simple_connector = connector.style == 'simple'
#line_info = [
# html_line_breaks(connector.type),
# html_line_breaks(connector.subtype),
# f"{connector.pincount}-pin" if connector.show_pincount else None,
# str(connector.color) if connector.color else None,
#]
#if connector.color:
# line_info.extend(colorbar_cells(connector.color))
#line_image, line_image_caption = image_and_caption_cells(connector)
##line_additional_connector_table = gv_additional_component_table(connector)
#line_notes = [html_line_breaks(connector.notes)]
#if connector.style != "simple":
# line_ports = gv_pin_table(connector)
#else:
# line_ports = None
#lines = [
# line_name,
# line_pn,
# line_info,
# line_ports,
# line_image,
# line_image_caption,
# line_additional_connector_table,
# line_notes,
#]
#tbl = nested_table(lines)
#if is_simple_connector:
# # Simple connectors have no pin table, and therefore, no ports to attach wires to.
# # Manually assign left and right ports here if required.
# # Use table itself for right port, and the first cell for left port.
# # Even if the table only has one cell, two separate ports can still be assigned.
# tbl.update_attribs(port="p1r")
# first_cell_in_tbl = tbl.contents[0].contents
# first_cell_in_tbl.update_attribs(port="p1l")
return tbl
def gv_node_component(component: Component) -> Table:
# If no wires connected (except maybe loop wires)?
if isinstance(component, Connector):
@ -184,31 +294,6 @@ def nested_table(lines: List[Td]) -> Table:
return tbl
def gv_pin_table(component) -> Table:
pin_rows = []
for pin in component.pin_objects.values():
if component.should_show_pin(pin.id):
pin_rows.append(gv_pin_row(pin, component))
if len(pin_rows) == 0:
# TODO: write test for empty pin tables, and for unconnected connectors that hide disconnected pins
pass
tbl = Table(pin_rows, border=0, cellborder=1, cellpadding=3, cellspacing=0)
return tbl
def gv_pin_row(pin, connector) -> Tr:
# ports in GraphViz are 1-indexed for more natural maping to pin/wire numbers
has_pincolors = any([_pin.color for _pin in connector.pin_objects.values()])
cells = [
Td(pin.id, port=f"p{pin.index+1}l") if connector.ports_left else None,
Td(pin.label, delete_if_empty=True),
Td(str(pin.color) if pin.color else "", sides="TBL") if has_pincolors else None,
Td(color_minitable(pin.color), sides="TBR") if has_pincolors else None,
Td(pin.id, port=f"p{pin.index+1}r") if connector.ports_right else None,
]
return Tr(cells)
def gv_connector_loops(connector: Connector) -> List:
loop_edges = []
if connector.ports_left:

8
src/wireviz/wv_harness.py
View File

@ -6,6 +6,7 @@ from typing import Dict, List
from graphviz import Graph
from wireviz import APP_NAME, APP_URL, __version__
import wireviz.wv_colors
from wireviz.wv_bom import bom_list
from wireviz.wv_dataclasses import (
@ -26,6 +27,7 @@ from wireviz.wv_graphviz import (
gv_connector_loops,
gv_edge_mate,
gv_edge_wire,
gv_node_connector,
gv_node_component,
parse_arrow_str,
set_dot_basics,
@ -36,6 +38,7 @@ from wireviz.wv_output import (
generate_pdf_output,
)
from wireviz.wv_utils import bom2tsv
from wireviz.wv_templates import get_template
@dataclass
@ -278,9 +281,12 @@ class Harness:
gv_html.update_attribs(
bgcolor=calculate_node_bgcolor(connector, self.options)
)
template_html = gv_node_connector(connector)
#print(gv_html)
#import pdb; pdb.set_trace()
dot.node(
connector.designator,
label=f"<\n{gv_html}\n>",
label=f"<\n{template_html}\n>",
shape="box",
style="filled",
)