From 072958d1a3238b2b544efa707e198f58f909556e Mon Sep 17 00:00:00 2001 From: Daniel Rojas Date: Fri, 22 May 2020 09:33:10 +0200 Subject: [PATCH 01/14] Create first draft of wireviz Python module --- .gitignore | 1 + src/.gitignore | 1 + src/test.py | 20 ++++++++++++++++++ src/wireviz.py | 56 ++++++++++++++++++++++++++++++++++++++++++++++++++ 4 files changed, 78 insertions(+) create mode 100644 src/.gitignore create mode 100644 src/test.py create mode 100644 src/wireviz.py diff --git a/.gitignore b/.gitignore index e43b0f9..79b2f55 100644 --- a/.gitignore +++ b/.gitignore @@ -1 +1,2 @@ .DS_Store +temp/ diff --git a/src/.gitignore b/src/.gitignore new file mode 100644 index 0000000..c18dd8d --- /dev/null +++ b/src/.gitignore @@ -0,0 +1 @@ +__pycache__/ diff --git a/src/test.py b/src/test.py new file mode 100644 index 0000000..358be4c --- /dev/null +++ b/src/test.py @@ -0,0 +1,20 @@ +import wireviz + +PINOUT_I2C = ("GND","VCC","SCL","SDA") +COLORS_WEIRD = ("infrared","ultraviolet","transparent","invisible") + +X1 = wireviz.Node("X1", num_pins=4) +X2 = wireviz.Node("X2", pinout=PINOUT_I2C) +X3 = wireviz.Node("X3", pinout=PINOUT_I2C) + +W1 = wireviz.Cable("W1", num_wires=4) +W2 = wireviz.Cable("W2", num_wires=4, color_code="DIN") +W3 = wireviz.Cable("W3", num_wires=3, colors=COLORS_WEIRD) + +print(X1) +print(X2) +print(X3) + +print(W1) +print(W2) +print(W3) diff --git a/src/wireviz.py b/src/wireviz.py new file mode 100644 index 0000000..9bae181 --- /dev/null +++ b/src/wireviz.py @@ -0,0 +1,56 @@ + +COLOR_CODE_DIN = ['WH','BN','GN','YE','GY','PK','BU','RD','BK','VT'] +COLOR_CODE_IEC = ['BN','RD','OG','YE','GN','BU','VT','GY','WH','BK'] + +class Node: + + def __init__(self, name, num_pins=None, pinout=None): + self.name = name + + if pinout is None: + self.pinout = ("",) * num_pins + else: + if num_pins is None: + if pinout is None: + raise Exception("Must provide num_pins or pinout") + else: + self.pinout = pinout + + def __repr__(self): + return "{} = {} {}".format(self.name, len(self.pinout), self.pinout) + +class Cable: + + def __init__(self, name, num_wires=None, colors=None, color_code=None): + self.name = name + if color_code is None and colors is None: + self.colors = ("",) * num_wires + else: + if colors is None: + if num_wires is None: + raise Exception("Unknown number of wires") + else: + # TODO: Loop through colors if num_wires > len(COLOR_CODE_XXX) + if color_code == "DIN": + self.colors = tuple(COLOR_CODE_DIN[:num_wires]) + elif color_code == "IEC": + self.colors = tuple(COLOR_CODE_IEC[:num_wires]) + else: + raise Exception("Unknown color code") + else: + if num_wires is None: + self.colors = colors + else: + self.colors = colors[:num_wires] + + def __repr__(self): + return "{} = {} {}".format(self.name, len(self.colors), self.colors) + + + +# class ClassName(object): +# """docstring for .""" +# +# def __init__(self, arg): +# super(, self).__init__() +# self.arg = arg From 48e744a0cee6c2ee5d587c65531f462d39eb2f42 Mon Sep 17 00:00:00 2001 From: Daniel Rojas Date: Fri, 22 May 2020 12:21:09 +0200 Subject: [PATCH 02/14] Add GraphViz output functionality --- src/input/footer.dot | 1 + src/input/header.dot | 4 ++ src/output/output.dot | 17 ++++++++ src/test.py | 38 +++++++++++------ src/wireviz.py | 99 +++++++++++++++++++++++++++++++++++++++---- 5 files changed, 137 insertions(+), 22 deletions(-) create mode 100644 src/input/footer.dot create mode 100644 src/input/header.dot create mode 100644 src/output/output.dot diff --git a/src/input/footer.dot b/src/input/footer.dot new file mode 100644 index 0000000..5c34318 --- /dev/null +++ b/src/input/footer.dot @@ -0,0 +1 @@ +} diff --git a/src/input/header.dot b/src/input/header.dot new file mode 100644 index 0000000..e3f1a79 --- /dev/null +++ b/src/input/header.dot @@ -0,0 +1,4 @@ +digraph G { + graph [rankdir = LR, ranksep=2, fontname = "arial"]; + edge [arrowhead=none, fontname = "arial"]; + node [shape=record, style=rounded, fontname = "arial"]; diff --git a/src/output/output.dot b/src/output/output.dot new file mode 100644 index 0000000..0014b97 --- /dev/null +++ b/src/output/output.dot @@ -0,0 +1,17 @@ +digraph G { + graph [rankdir = LR, ranksep=2, fontname = "arial"]; + edge [arrowhead=none, fontname = "arial"]; + node [shape=record, style=rounded, fontname = "arial"]; + + +X1[label="X1 | {{DCD|RX|TX|DTR|GND|DSR|RTS|CTS|RI} | {1|2|3|4|5|6|7|8|9}}}"] +X2[label="X2 | {{1|2|3|4|5|6} | {|||||}}}"] +W1[label="W1 | {{1|2|3|4} | {WH|BN|GN|Shield} | {1|2|3|4}}}"] + +{edge[style=bold]{X1:p2 -> W1:w1i; W1:w1o -> X2:p1} +{X1:p3 -> W1:w2i; W1:w2o -> X2:p3} +{X1:p5 -> W1:w3i; W1:w3o -> X2:p2} +} + + +} diff --git a/src/test.py b/src/test.py index 358be4c..26e3d4a 100644 --- a/src/test.py +++ b/src/test.py @@ -1,20 +1,32 @@ import wireviz -PINOUT_I2C = ("GND","VCC","SCL","SDA") +PINOUT_SERIAL = ('DCD','RX','TX','DTR','GND','DSR','RTS','CTS','RI') COLORS_WEIRD = ("infrared","ultraviolet","transparent","invisible") -X1 = wireviz.Node("X1", num_pins=4) -X2 = wireviz.Node("X2", pinout=PINOUT_I2C) -X3 = wireviz.Node("X3", pinout=PINOUT_I2C) +X1 = wireviz.Node("X1", pinout=PINOUT_SERIAL, ports_right=True) +X2 = wireviz.Node("X2", num_pins=6, ports_left=True) -W1 = wireviz.Cable("W1", num_wires=4) -W2 = wireviz.Cable("W2", num_wires=4, color_code="DIN") -W3 = wireviz.Cable("W3", num_wires=3, colors=COLORS_WEIRD) +W1 = wireviz.Cable("W1", num_wires=3, color_code="DIN", shield=True) -print(X1) -print(X2) -print(X3) +W1.connect(X1,(2,3,5),(1,2,3),X2,(1,3,2)) -print(W1) -print(W2) -print(W3) +with open('output/output.dot','w') as f: + with open('input/header.dot','r') as infile: + for line in infile: + f.write(line) + f.write('\n\n') + + f.write(X1.graphviz() + '\n') + f.write(X2.graphviz() + '\n') + f.write(W1.graphviz() + '\n') + + + f.write('\n\n') + with open('input/footer.dot','r') as infile: + for line in infile: + f.write(line) + +# print output file +# with open('output/output.dot','r') as f: +# for line in f: +# print(line) diff --git a/src/wireviz.py b/src/wireviz.py index 9bae181..b5d213f 100644 --- a/src/wireviz.py +++ b/src/wireviz.py @@ -4,8 +4,10 @@ COLOR_CODE_IEC = ['BN','RD','OG','YE','GN','BU','VT','GY','WH','BK'] class Node: - def __init__(self, name, num_pins=None, pinout=None): + def __init__(self, name, num_pins=None, pinout=None, ports_left=False, ports_right=False): self.name = name + self.ports_left = ports_left + self.ports_right = ports_right if pinout is None: self.pinout = ("",) * num_pins @@ -19,10 +21,43 @@ class Node: def __repr__(self): return "{} = {} {}".format(self.name, len(self.pinout), self.pinout) + def __str__(self): + return "{}".format(self.name) + + def graphviz(self): + s = '' + # print header + s = s + '{name}[label="{name} | {{'.format(name=self.name) + # print pinout + if self.ports_left == True: + s = s + '{' + l = [] + for i,x in enumerate(self.pinout,1): + l.append('{portno}'.format(portno=i)) + s = s + '|'.join(l) + s = s + '} | ' + + s = s + '{' + s = s + '|'.join(self.pinout) + s = s + '}' + + if self.ports_right == True: + s = s + ' | {' + l = [] + for i,x in enumerate(self.pinout,1): + l.append('{portno}'.format(portno=i)) + s = s + '|'.join(l) + s = s + '}' + + s = s + '}}"]' + + return s + class Cable: - def __init__(self, name, num_wires=None, colors=None, color_code=None): + def __init__(self, name, num_wires=None, colors=None, color_code=None, shield=False): self.name = name + self.connections = [] if color_code is None and colors is None: self.colors = ("",) * num_wires else: @@ -42,15 +77,61 @@ class Cable: self.colors = colors else: self.colors = colors[:num_wires] + if shield == True: + self.colors = self.colors + ('Shield',) + + def connect(self, from_name, from_pin, via, to_name, to_pin): + if len(from_pin) != len(to_pin): + raise Exception("from_pin must have the same number of elements as to_pin") + for i, x in enumerate(from_pin): + self.connections.append((from_name, from_pin[i], via[i], to_name, to_pin[i])) def __repr__(self): - return "{} = {} {}".format(self.name, len(self.colors), self.colors) + return "{} = {} {}\n {}".format(self.name, len(self.colors), self.colors, self.connections) + def debug(self): + print(self.name) + print(self.colors) + if len(self.connections) > 0: + for i, x in enumerate(self.connections): + if i < len(self.colors): + s = self.colors[int(x[2]-1)] + else: + s = '--' + # print(self.colors(x[2]) if i < len(self.colors) else '-') + print("{}:{} -- {}({}) -> {}:{}".format(x[0],x[1],x[2],s,x[3],x[4])) + def graphviz(self): + s = '' + # print header + s = s + '{name}[label="{name} | {{'.format(name=self.name) + # print pinout + s = s + '{' + l = [] + for i,x in enumerate(self.colors,1): + l.append('{wireno}'.format(wireno=i)) + s = s + '|'.join(l) + s = s + '} | ' -# class ClassName(object): -# """docstring for .""" -# -# def __init__(self, arg): -# super(, self).__init__() -# self.arg = arg + s = s + '{' + s = s + '|'.join(self.colors) + s = s + '}' + + s = s + ' | {' + l = [] + for i,x in enumerate(self.colors,1): + l.append('{wireno}'.format(wireno=i)) + s = s + '|'.join(l) + s = s + '}' + + s = s + '}}"]' + + s = s + '\n\n{edge[style=bold]' + for x in self.connections: + s = s + '{' + t = '{from_name}:p{from_port} -> {via_name}:w{via_wire}i; {via_name}:w{via_wire}o -> {to_name}:p{to_port}'.format(from_name=x[0],from_port=x[1],via_name=self.name, via_wire=x[2],to_name=x[3],to_port=x[4]) + s = s + t + s = s + '}\n' + s = s + '}' + + return s From e084da0d4a73583491008a1a5ba85189c34ff677 Mon Sep 17 00:00:00 2001 From: Daniel Rojas Date: Fri, 22 May 2020 12:43:18 +0200 Subject: [PATCH 03/14] Add wire colors --- src/output/output.dot | 7 ++++--- src/wireviz.py | 19 ++++++++++++++++++- 2 files changed, 22 insertions(+), 4 deletions(-) diff --git a/src/output/output.dot b/src/output/output.dot index 0014b97..06a9729 100644 --- a/src/output/output.dot +++ b/src/output/output.dot @@ -8,9 +8,10 @@ X1[label="X1 | {{DCD|RX|TX|DTR|GND|DSR|RTS|CTS|RI} | {1|2|3|4|

W1:w1i; W1:w1o -> X2:p1} -{X1:p3 -> W1:w2i; W1:w2o -> X2:p3} -{X1:p5 -> W1:w3i; W1:w3o -> X2:p2} +{edge[style=bold] +{edge[color="#000000:#ffffff:#000000"] X1:p2 -> W1:w1i; W1:w1o -> X2:p1} +{edge[color="#000000:#808000:#000000"] X1:p3 -> W1:w2i; W1:w2o -> X2:p3} +{edge[color="#000000:#00ff00:#000000"] X1:p5 -> W1:w3i; W1:w3o -> X2:p2} } diff --git a/src/wireviz.py b/src/wireviz.py index b5d213f..4a64e4a 100644 --- a/src/wireviz.py +++ b/src/wireviz.py @@ -2,6 +2,20 @@ COLOR_CODE_DIN = ['WH','BN','GN','YE','GY','PK','BU','RD','BK','VT'] COLOR_CODE_IEC = ['BN','RD','OG','YE','GN','BU','VT','GY','WH','BK'] +color_dict = {'BK': '#000000', + 'WH': '#ffffff', + 'GY': '#808080', + 'PK': '#ff80c0', + 'RD': '#ff0000', + 'OG': '#ff8000', + 'YE': '#ffff00', + 'GN': '#00ff00', + 'TQ': '#00ffff', + 'BU': '#0000ff', + 'VT': '#8000ff', + 'BN': '#808000', + } + class Node: def __init__(self, name, num_pins=None, pinout=None, ports_left=False, ports_right=False): @@ -126,9 +140,12 @@ class Cable: s = s + '}}"]' - s = s + '\n\n{edge[style=bold]' + s = s + '\n\n{edge[style=bold]\n' for x in self.connections: s = s + '{' + search_color = self.colors[x[2]-1] + if search_color in color_dict: + s = s + 'edge[color="#000000:{wire_color}:#000000"] '.format(wire_color=color_dict[search_color]) t = '{from_name}:p{from_port} -> {via_name}:w{via_wire}i; {via_name}:w{via_wire}o -> {to_name}:p{to_port}'.format(from_name=x[0],from_port=x[1],via_name=self.name, via_wire=x[2],to_name=x[3],to_port=x[4]) s = s + t s = s + '}\n' From 59816cfb6df0eee5f82742dd7ba1a3d9687f4fa2 Mon Sep 17 00:00:00 2001 From: Daniel Rojas Date: Fri, 22 May 2020 12:45:11 +0200 Subject: [PATCH 04/14] Optimize file output --- src/test.py | 8 ++++---- 1 file changed, 4 insertions(+), 4 deletions(-) diff --git a/src/test.py b/src/test.py index 26e3d4a..3427366 100644 --- a/src/test.py +++ b/src/test.py @@ -10,16 +10,16 @@ W1 = wireviz.Cable("W1", num_wires=3, color_code="DIN", shield=True) W1.connect(X1,(2,3,5),(1,2,3),X2,(1,3,2)) +objects = [X1, X2, W1] + with open('output/output.dot','w') as f: with open('input/header.dot','r') as infile: for line in infile: f.write(line) f.write('\n\n') - f.write(X1.graphviz() + '\n') - f.write(X2.graphviz() + '\n') - f.write(W1.graphviz() + '\n') - + for o in objects: + f.write(o.graphviz() + '\n') f.write('\n\n') with open('input/footer.dot','r') as infile: From 075d9ed9db3d0b57ea31847b514565eda6ed0e83 Mon Sep 17 00:00:00 2001 From: Daniel Rojas Date: Fri, 22 May 2020 12:58:09 +0200 Subject: [PATCH 05/14] Add ability to define loops on connectors --- src/output/output.dot | 6 ++++++ src/test.py | 5 ++--- src/wireviz.py | 21 +++++++++++++++++++++ 3 files changed, 29 insertions(+), 3 deletions(-) diff --git a/src/output/output.dot b/src/output/output.dot index 06a9729..65d4d93 100644 --- a/src/output/output.dot +++ b/src/output/output.dot @@ -5,7 +5,13 @@ digraph G { X1[label="X1 | {{DCD|RX|TX|DTR|GND|DSR|RTS|CTS|RI} | {1|2|3|4|5|6|7|8|9}}}"] + X2[label="X2 | {{1|2|3|4|5|6} | {|||||}}}"] + +{edge[style=bold] +X2:p5:w -> X2:p6:w +} + W1[label="W1 | {{1|2|3|4} | {WH|BN|GN|Shield} | {1|2|3|4}}}"] {edge[style=bold] diff --git a/src/test.py b/src/test.py index 3427366..d4af6a6 100644 --- a/src/test.py +++ b/src/test.py @@ -3,13 +3,12 @@ import wireviz PINOUT_SERIAL = ('DCD','RX','TX','DTR','GND','DSR','RTS','CTS','RI') COLORS_WEIRD = ("infrared","ultraviolet","transparent","invisible") +# example 1 X1 = wireviz.Node("X1", pinout=PINOUT_SERIAL, ports_right=True) X2 = wireviz.Node("X2", num_pins=6, ports_left=True) - W1 = wireviz.Cable("W1", num_wires=3, color_code="DIN", shield=True) - W1.connect(X1,(2,3,5),(1,2,3),X2,(1,3,2)) - +X2.loop(5,6) objects = [X1, X2, W1] with open('output/output.dot','w') as f: diff --git a/src/wireviz.py b/src/wireviz.py index 4a64e4a..852e611 100644 --- a/src/wireviz.py +++ b/src/wireviz.py @@ -22,6 +22,7 @@ class Node: self.name = name self.ports_left = ports_left self.ports_right = ports_right + self.loops = [] if pinout is None: self.pinout = ("",) * num_pins @@ -32,6 +33,18 @@ class Node: else: self.pinout = pinout + def loop(self, from_pin, to_pin, side=None): + if self.ports_left == True and self.ports_right == False: + loop_side = 'w' # west = left + elif self.ports_left == False and self.ports_right == True: + loop_side = 'e' # east = right + elif self.ports_left == True and self.ports_right == True: + if side == None: + raise Exception("Must specify side of loop") + else: + loop_side = side + self.loops.append((from_pin, to_pin, loop_side)) + def __repr__(self): return "{} = {} {}".format(self.name, len(self.pinout), self.pinout) @@ -65,6 +78,14 @@ class Node: s = s + '}}"]' + # print loops + if len(self.loops) > 0: + s = s + '\n\n{edge[style=bold]\n' + for x in self.loops: + s = s + '{name}:p{port_from}:{loop_side} -> {name}:p{port_to}:{loop_side}\n'.format(name=self.name, port_from=x[0], port_to=x[1], loop_side=x[2]) + s = s + '}' + + s = s + '\n' return s class Cable: From 006fdba67748ae8dd792fa29b08ec0c9c4db27b4 Mon Sep 17 00:00:00 2001 From: Daniel Rojas Date: Fri, 22 May 2020 13:08:54 +0200 Subject: [PATCH 06/14] Make cable name hidden by default --- src/test.py | 2 +- src/wireviz.py | 10 ++++++++-- 2 files changed, 9 insertions(+), 3 deletions(-) diff --git a/src/test.py b/src/test.py index d4af6a6..c44965e 100644 --- a/src/test.py +++ b/src/test.py @@ -6,7 +6,7 @@ COLORS_WEIRD = ("infrared","ultraviolet","transparent","invisible") # example 1 X1 = wireviz.Node("X1", pinout=PINOUT_SERIAL, ports_right=True) X2 = wireviz.Node("X2", num_pins=6, ports_left=True) -W1 = wireviz.Cable("W1", num_wires=3, color_code="DIN", shield=True) +W1 = wireviz.Cable("W1", show_name=True, num_wires=3, color_code="DIN", shield=True) W1.connect(X1,(2,3,5),(1,2,3),X2,(1,3,2)) X2.loop(5,6) objects = [X1, X2, W1] diff --git a/src/wireviz.py b/src/wireviz.py index 852e611..a93252f 100644 --- a/src/wireviz.py +++ b/src/wireviz.py @@ -90,8 +90,9 @@ class Node: class Cable: - def __init__(self, name, num_wires=None, colors=None, color_code=None, shield=False): + def __init__(self, name, show_name=False, num_wires=None, colors=None, color_code=None, shield=False): self.name = name + self.show_name = show_name self.connections = [] if color_code is None and colors is None: self.colors = ("",) * num_wires @@ -139,7 +140,12 @@ class Cable: def graphviz(self): s = '' # print header - s = s + '{name}[label="{name} | {{'.format(name=self.name) + s = s + '{name}[label="'.format(name=self.name) + + if self.show_name == True: + s = s + '{name} | '.format(name=self.name) + + s = s + '{' # print pinout s = s + '{' l = [] From 429d958e6d33c7b10d6eec650697bf6beea23f3a Mon Sep 17 00:00:00 2001 From: Daniel Rojas Date: Fri, 22 May 2020 13:21:26 +0200 Subject: [PATCH 07/14] Add example output --- src/output/{output.dot => output_ex1.dot} | 0 1 file changed, 0 insertions(+), 0 deletions(-) rename src/output/{output.dot => output_ex1.dot} (100%) diff --git a/src/output/output.dot b/src/output/output_ex1.dot similarity index 100% rename from src/output/output.dot rename to src/output/output_ex1.dot From 0ae58148e0e46e6ea2775aac4b3fd208bbd3104b Mon Sep 17 00:00:00 2001 From: Daniel Rojas Date: Fri, 22 May 2020 13:22:31 +0200 Subject: [PATCH 08/14] Add example 2 --- src/output/output_ex2.dot | 49 +++++++++++++++++++++++++++++++++++++++ src/test.py | 43 ++++++++++++++++++++++++++++------ 2 files changed, 85 insertions(+), 7 deletions(-) create mode 100644 src/output/output_ex2.dot diff --git a/src/output/output_ex2.dot b/src/output/output_ex2.dot new file mode 100644 index 0000000..0c25722 --- /dev/null +++ b/src/output/output_ex2.dot @@ -0,0 +1,49 @@ +digraph G { + graph [rankdir = LR, ranksep=2, fontname = "arial"]; + edge [arrowhead=none, fontname = "arial"]; + node [shape=record, style=rounded, fontname = "arial"]; + + +X1[label="X1 | {{GND|+5V|SCL|SDA|MISO|MOSI|SCK|N/C} | {1|2|3|4|5|6|7|8}}}"] + +X2[label="X2 | {{1|2|3|4} | {GND|+5V|SCL|SDA}}}"] + +X3[label="X3 | {{1|2|3|4} | {GND|+5V|SCL|SDA}}}"] + +X4[label="X4 | {{1|2|3|4|5} | {GND|+12V|MISO|MOSI|SCK}}}"] + +X5[label="X5 | {{GND|+12V} | {1|2}}}"] + +W1[label="{{1|2|3|4} | {BK|RD|YE|GN} | {1|2|3|4}}}"] + +{edge[style=bold] +{edge[color="#000000:#000000:#000000"] X1:p1 -> W1:w1i; W1:w1o -> X2:p1} +{edge[color="#000000:#ff0000:#000000"] X1:p2 -> W1:w2i; W1:w2o -> X2:p2} +{edge[color="#000000:#ffff00:#000000"] X1:p3 -> W1:w3i; W1:w3o -> X2:p3} +{edge[color="#000000:#00ff00:#000000"] X1:p4 -> W1:w4i; W1:w4o -> X2:p4} +} +W2[label="{{1|2|3|4} | {BK|RD|YE|GN} | {1|2|3|4}}}"] + +{edge[style=bold] +{edge[color="#000000:#000000:#000000"] X1:p1 -> W2:w1i; W2:w1o -> X3:p1} +{edge[color="#000000:#ff0000:#000000"] X1:p2 -> W2:w2i; W2:w2o -> X3:p2} +{edge[color="#000000:#ffff00:#000000"] X1:p3 -> W2:w3i; W2:w3o -> X3:p3} +{edge[color="#000000:#00ff00:#000000"] X1:p4 -> W2:w4i; W2:w4o -> X3:p4} +} +W3[label="{{1|2|3|4} | {BK|BU|OG|VT} | {1|2|3|4}}}"] + +{edge[style=bold] +{edge[color="#000000:#000000:#000000"] X1:p1 -> W3:w1i; W3:w1o -> X4:p1} +{edge[color="#000000:#0000ff:#000000"] X1:p5 -> W3:w2i; W3:w2o -> X4:p3} +{edge[color="#000000:#ff8000:#000000"] X1:p6 -> W3:w3i; W3:w3o -> X4:p4} +{edge[color="#000000:#8000ff:#000000"] X1:p7 -> W3:w4i; W3:w4o -> X4:p5} +} +W4[label="{{1|2} | {BK|RD} | {1|2}}}"] + +{edge[style=bold] +{edge[color="#000000:#000000:#000000"] X5:p1 -> W4:w1i; W4:w1o -> X4:p1} +{edge[color="#000000:#ff0000:#000000"] X5:p2 -> W4:w2i; W4:w2o -> X4:p2} +} + + +} diff --git a/src/test.py b/src/test.py index c44965e..81bb2ef 100644 --- a/src/test.py +++ b/src/test.py @@ -1,15 +1,44 @@ import wireviz PINOUT_SERIAL = ('DCD','RX','TX','DTR','GND','DSR','RTS','CTS','RI') -COLORS_WEIRD = ("infrared","ultraviolet","transparent","invisible") + +PINOUT_I2C = ('GND','+5V','SCL','SDA') +COLORS_I2C = ('BK', 'RD', 'YE', 'GN') + +PINOUT_SPI_DATAONLY = ('MISO','MOSI','SCK') # example 1 -X1 = wireviz.Node("X1", pinout=PINOUT_SERIAL, ports_right=True) -X2 = wireviz.Node("X2", num_pins=6, ports_left=True) -W1 = wireviz.Cable("W1", show_name=True, num_wires=3, color_code="DIN", shield=True) -W1.connect(X1,(2,3,5),(1,2,3),X2,(1,3,2)) -X2.loop(5,6) -objects = [X1, X2, W1] +# X1 = wireviz.Node("X1", pinout=PINOUT_SERIAL, ports_right=True) +# X2 = wireviz.Node("X2", num_pins=6, ports_left=True) +# W1 = wireviz.Cable("W1", show_name=True, num_wires=3, color_code="DIN", shield=True) +# W1.connect(X1,(2,3,5),(1,2,3),X2,(1,3,2)) +# X2.loop(5,6) +# objects = [X1, X2, W1] + +# example 2 +X1 = wireviz.Node("X1", pinout=( +'GND', +'+5V', +'SCL', +'SDA', +'MISO', +'MOSI', +'SCK', +'N/C' +), ports_right=True) +X2 = wireviz.Node("X2", pinout=PINOUT_I2C, ports_left=True) +X3 = wireviz.Node("X3", pinout=PINOUT_I2C, ports_left=True) +X4 = wireviz.Node("X4", pinout=('GND','+12V')+PINOUT_SPI_DATAONLY, ports_left=True) +X5 = wireviz.Node("X5", pinout=('GND','+12V'), ports_right=True) +W1 = wireviz.Cable("W1", colors=COLORS_I2C) +W2 = wireviz.Cable("W2", colors=COLORS_I2C) +W3 = wireviz.Cable("W3", colors=('BK','BU','OG','VT')) +W4 = wireviz.Cable("W4", colors=('BK','RD')) +W1.connect(X1,(1,2,3,4),(1,2,3,4),X2,(1,2,3,4)) +W2.connect(X1,(1,2,3,4),(1,2,3,4),X3,(1,2,3,4)) +W3.connect(X1,(1,5,6,7),(1,2,3,4),X4,(1,3,4,5)) +W4.connect(X5,(1,2),(1,2),X4,(1,2)) +objects = [X1, X2, X3, X4, X5, W1, W2, W3, W4] with open('output/output.dot','w') as f: with open('input/header.dot','r') as infile: From c63da45d8ffcd87682eca08e30802f4090c62528 Mon Sep 17 00:00:00 2001 From: Daniel Rojas Date: Fri, 22 May 2020 13:23:18 +0200 Subject: [PATCH 09/14] Update gitignore --- src/output/.gitignore | 1 + 1 file changed, 1 insertion(+) create mode 100644 src/output/.gitignore diff --git a/src/output/.gitignore b/src/output/.gitignore new file mode 100644 index 0000000..95d5a41 --- /dev/null +++ b/src/output/.gitignore @@ -0,0 +1 @@ +output.dot From da258ceaa85389a027ccabb062c2e109bb564f79 Mon Sep 17 00:00:00 2001 From: Daniel Rojas Date: Fri, 22 May 2020 14:05:36 +0200 Subject: [PATCH 10/14] Add simple auto-wiring --- src/test.py | 8 ++++---- src/wireviz.py | 9 +++++++++ 2 files changed, 13 insertions(+), 4 deletions(-) diff --git a/src/test.py b/src/test.py index 81bb2ef..aa26b83 100644 --- a/src/test.py +++ b/src/test.py @@ -34,10 +34,10 @@ W1 = wireviz.Cable("W1", colors=COLORS_I2C) W2 = wireviz.Cable("W2", colors=COLORS_I2C) W3 = wireviz.Cable("W3", colors=('BK','BU','OG','VT')) W4 = wireviz.Cable("W4", colors=('BK','RD')) -W1.connect(X1,(1,2,3,4),(1,2,3,4),X2,(1,2,3,4)) -W2.connect(X1,(1,2,3,4),(1,2,3,4),X3,(1,2,3,4)) -W3.connect(X1,(1,5,6,7),(1,2,3,4),X4,(1,3,4,5)) -W4.connect(X5,(1,2),(1,2),X4,(1,2)) +W1.connect(X1,(1,2,3,4),'auto',X2,'auto') +W2.connect(X1,(1,2,3,4),'auto',X3,'auto') +W3.connect(X1,(1,5,6,7),'auto',X4,(1,3,4,5)) +W4.connect(X5,'auto','auto',X4,'auto') objects = [X1, X2, X3, X4, X5, W1, W2, W3, W4] with open('output/output.dot','w') as f: diff --git a/src/wireviz.py b/src/wireviz.py index a93252f..ae395b5 100644 --- a/src/wireviz.py +++ b/src/wireviz.py @@ -117,11 +117,20 @@ class Cable: self.colors = self.colors + ('Shield',) def connect(self, from_name, from_pin, via, to_name, to_pin): + if from_pin == 'auto': + from_pin = tuple(x+1 for x in range(len(self.colors))) + if via == 'auto': + via = tuple(x+1 for x in range(len(self.colors))) + if to_pin == 'auto': + to_pin = tuple(x+1 for x in range(len(self.colors))) if len(from_pin) != len(to_pin): raise Exception("from_pin must have the same number of elements as to_pin") for i, x in enumerate(from_pin): self.connections.append((from_name, from_pin[i], via[i], to_name, to_pin[i])) + def connect_all_straight(self, from_name, to_name): + self.connect(from_name, 'auto', 'auto', to_name, 'auto') + def __repr__(self): return "{} = {} {}\n {}".format(self.name, len(self.colors), self.colors, self.connections) From 5097f54d9268df37b8e72154a239f73e6a26f3df Mon Sep 17 00:00:00 2001 From: Daniel Rojas Date: Fri, 22 May 2020 14:06:13 +0200 Subject: [PATCH 11/14] Add example 3 --- src/output/output_ex3.dot | 45 +++++++++++++++++++++++++++++++ src/test.py | 57 +++++++++++++++++++++++---------------- 2 files changed, 79 insertions(+), 23 deletions(-) create mode 100644 src/output/output_ex3.dot diff --git a/src/output/output_ex3.dot b/src/output/output_ex3.dot new file mode 100644 index 0000000..2c5ec43 --- /dev/null +++ b/src/output/output_ex3.dot @@ -0,0 +1,45 @@ +digraph G { + graph [rankdir = LR, ranksep=2, fontname = "arial"]; + edge [arrowhead=none, fontname = "arial"]; + node [shape=record, style=rounded, fontname = "arial"]; + + +X1[label="X1 | {{|||||||||} | {1|2|3|4|5|6|7|8|9|10}}}"] + +X2[label="X2 | {{1|2|3|4|5|6|7|8|9|10} | {|||||||||}}}"] + +W1[label="{{1|2|3|4|5|6|7|8|9|10} | {BN|RD|OG|YE|GN|BU|VT|GY|WH|BK} | {1|2|3|4|5|6|7|8|9|10}}}"] + +{edge[style=bold] +{edge[color="#000000:#808000:#000000"] X1:p1 -> W1:w1i; W1:w1o -> X2:p1} +{edge[color="#000000:#ff0000:#000000"] X1:p2 -> W1:w2i; W1:w2o -> X2:p2} +{edge[color="#000000:#ff8000:#000000"] X1:p3 -> W1:w3i; W1:w3o -> X2:p3} +{edge[color="#000000:#ffff00:#000000"] X1:p4 -> W1:w4i; W1:w4o -> X2:p4} +{edge[color="#000000:#00ff00:#000000"] X1:p5 -> W1:w5i; W1:w5o -> X2:p5} +{edge[color="#000000:#0000ff:#000000"] X1:p6 -> W1:w6i; W1:w6o -> X2:p6} +{edge[color="#000000:#8000ff:#000000"] X1:p7 -> W1:w7i; W1:w7o -> X2:p7} +{edge[color="#000000:#808080:#000000"] X1:p8 -> W1:w8i; W1:w8o -> X2:p8} +{edge[color="#000000:#ffffff:#000000"] X1:p9 -> W1:w9i; W1:w9o -> X2:p9} +{edge[color="#000000:#000000:#000000"] X1:p10 -> W1:w10i; W1:w10o -> X2:p10} +} +X3[label="X3 | {{|||||||||} | {1|2|3|4|5|6|7|8|9|10}}}"] + +X4[label="X4 | {{1|2|3|4|5|6|7|8|9|10} | {|||||||||}}}"] + +W2[label="{{1|2|3|4|5|6|7|8|9|10} | {WH|BN|GN|YE|GY|PK|BU|RD|BK|VT} | {1|2|3|4|5|6|7|8|9|10}}}"] + +{edge[style=bold] +{edge[color="#000000:#ffffff:#000000"] X3:p1 -> W2:w1i; W2:w1o -> X4:p1} +{edge[color="#000000:#808000:#000000"] X3:p2 -> W2:w2i; W2:w2o -> X4:p2} +{edge[color="#000000:#00ff00:#000000"] X3:p3 -> W2:w3i; W2:w3o -> X4:p3} +{edge[color="#000000:#ffff00:#000000"] X3:p4 -> W2:w4i; W2:w4o -> X4:p4} +{edge[color="#000000:#808080:#000000"] X3:p5 -> W2:w5i; W2:w5o -> X4:p5} +{edge[color="#000000:#ff80c0:#000000"] X3:p6 -> W2:w6i; W2:w6o -> X4:p6} +{edge[color="#000000:#0000ff:#000000"] X3:p7 -> W2:w7i; W2:w7o -> X4:p7} +{edge[color="#000000:#ff0000:#000000"] X3:p8 -> W2:w8i; W2:w8o -> X4:p8} +{edge[color="#000000:#000000:#000000"] X3:p9 -> W2:w9i; W2:w9o -> X4:p9} +{edge[color="#000000:#8000ff:#000000"] X3:p10 -> W2:w10i; W2:w10o -> X4:p10} +} + + +} diff --git a/src/test.py b/src/test.py index aa26b83..551b7c8 100644 --- a/src/test.py +++ b/src/test.py @@ -16,29 +16,40 @@ PINOUT_SPI_DATAONLY = ('MISO','MOSI','SCK') # objects = [X1, X2, W1] # example 2 -X1 = wireviz.Node("X1", pinout=( -'GND', -'+5V', -'SCL', -'SDA', -'MISO', -'MOSI', -'SCK', -'N/C' -), ports_right=True) -X2 = wireviz.Node("X2", pinout=PINOUT_I2C, ports_left=True) -X3 = wireviz.Node("X3", pinout=PINOUT_I2C, ports_left=True) -X4 = wireviz.Node("X4", pinout=('GND','+12V')+PINOUT_SPI_DATAONLY, ports_left=True) -X5 = wireviz.Node("X5", pinout=('GND','+12V'), ports_right=True) -W1 = wireviz.Cable("W1", colors=COLORS_I2C) -W2 = wireviz.Cable("W2", colors=COLORS_I2C) -W3 = wireviz.Cable("W3", colors=('BK','BU','OG','VT')) -W4 = wireviz.Cable("W4", colors=('BK','RD')) -W1.connect(X1,(1,2,3,4),'auto',X2,'auto') -W2.connect(X1,(1,2,3,4),'auto',X3,'auto') -W3.connect(X1,(1,5,6,7),'auto',X4,(1,3,4,5)) -W4.connect(X5,'auto','auto',X4,'auto') -objects = [X1, X2, X3, X4, X5, W1, W2, W3, W4] +# X1 = wireviz.Node("X1", pinout=( +# 'GND', +# '+5V', +# 'SCL', +# 'SDA', +# 'MISO', +# 'MOSI', +# 'SCK', +# 'N/C' +# ), ports_right=True) +# X2 = wireviz.Node("X2", pinout=PINOUT_I2C, ports_left=True) +# X3 = wireviz.Node("X3", pinout=PINOUT_I2C, ports_left=True) +# X4 = wireviz.Node("X4", pinout=('GND','+12V')+PINOUT_SPI_DATAONLY, ports_left=True) +# X5 = wireviz.Node("X5", pinout=('GND','+12V'), ports_right=True) +# W1 = wireviz.Cable("W1", colors=COLORS_I2C) +# W2 = wireviz.Cable("W2", colors=COLORS_I2C) +# W3 = wireviz.Cable("W3", colors=('BK','BU','OG','VT')) +# W4 = wireviz.Cable("W4", colors=('BK','RD')) +# W1.connect(X1,(1,2,3,4),'auto',X2,'auto') +# W2.connect(X1,(1,2,3,4),'auto',X3,'auto') +# W3.connect(X1,(1,5,6,7),'auto',X4,(1,3,4,5)) +# W4.connect(X5,'auto','auto',X4,'auto') +# objects = [X1, X2, X3, X4, X5, W1, W2, W3, W4] + +# example 3 +X1 = wireviz.Node("X1", num_pins=10, ports_right=True) +X2 = wireviz.Node("X2", num_pins=10, ports_left=True) +W1 = wireviz.Cable("W1", num_wires=10, color_code="IEC") +W1.connect_all_straight(X1,X2) +X3 = wireviz.Node("X3", num_pins=10, ports_right=True) +X4 = wireviz.Node("X4", num_pins=10, ports_left=True) +W2 = wireviz.Cable("W2", num_wires=10, color_code="DIN") +W2.connect_all_straight(X3,X4) +objects = [X1, X2, W1, X3, X4, W2] with open('output/output.dot','w') as f: with open('input/header.dot','r') as infile: From a198d27a26a5fe4b1b4e77bfa2b03b8cae96cf88 Mon Sep 17 00:00:00 2001 From: Daniel Rojas Date: Fri, 22 May 2020 14:28:29 +0200 Subject: [PATCH 12/14] Tweak brown color --- src/wireviz.py | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/src/wireviz.py b/src/wireviz.py index ae395b5..ccb8aba 100644 --- a/src/wireviz.py +++ b/src/wireviz.py @@ -13,7 +13,7 @@ color_dict = {'BK': '#000000', 'TQ': '#00ffff', 'BU': '#0000ff', 'VT': '#8000ff', - 'BN': '#808000', + 'BN': '#666600', } class Node: From d42b12fd0fdfee35f0a7d09ae41a44f1079953b6 Mon Sep 17 00:00:00 2001 From: Daniel Rojas Date: Fri, 22 May 2020 14:28:54 +0200 Subject: [PATCH 13/14] Improve shield wiring, fix and expand example 1 --- src/test.py | 34 +++++++++++++++++++--------------- src/wireviz.py | 26 +++++++++++++++++++------- 2 files changed, 38 insertions(+), 22 deletions(-) diff --git a/src/test.py b/src/test.py index 551b7c8..ee2b8da 100644 --- a/src/test.py +++ b/src/test.py @@ -8,12 +8,16 @@ COLORS_I2C = ('BK', 'RD', 'YE', 'GN') PINOUT_SPI_DATAONLY = ('MISO','MOSI','SCK') # example 1 -# X1 = wireviz.Node("X1", pinout=PINOUT_SERIAL, ports_right=True) -# X2 = wireviz.Node("X2", num_pins=6, ports_left=True) -# W1 = wireviz.Cable("W1", show_name=True, num_wires=3, color_code="DIN", shield=True) -# W1.connect(X1,(2,3,5),(1,2,3),X2,(1,3,2)) -# X2.loop(5,6) -# objects = [X1, X2, W1] +X1 = wireviz.Node("X1", pinout=PINOUT_SERIAL, ports_right=True) +X2 = wireviz.Node("X2", num_pins=6, ports_left=True) +W1 = wireviz.Cable("W1", show_name=True, num_wires=3, color_code="DIN", shield=True) +# Option 1: define wires and shield in one line +# W1.connect(X1,(5,2,3,5),(1,2,3,'s'),X2,(1,3,2,None)) +# Option 2: define wires and shield separately +W1.connect(X1,(5,2,3),'auto',X2,(1,3,2)) # wires +W1.connect(X1,(5,),('s',),X2,(None,)) # shield +X2.loop(5,6) +objects = [X1, X2, W1] # example 2 # X1 = wireviz.Node("X1", pinout=( @@ -41,15 +45,15 @@ PINOUT_SPI_DATAONLY = ('MISO','MOSI','SCK') # objects = [X1, X2, X3, X4, X5, W1, W2, W3, W4] # example 3 -X1 = wireviz.Node("X1", num_pins=10, ports_right=True) -X2 = wireviz.Node("X2", num_pins=10, ports_left=True) -W1 = wireviz.Cable("W1", num_wires=10, color_code="IEC") -W1.connect_all_straight(X1,X2) -X3 = wireviz.Node("X3", num_pins=10, ports_right=True) -X4 = wireviz.Node("X4", num_pins=10, ports_left=True) -W2 = wireviz.Cable("W2", num_wires=10, color_code="DIN") -W2.connect_all_straight(X3,X4) -objects = [X1, X2, W1, X3, X4, W2] +# X1 = wireviz.Node("X1", num_pins=10, ports_right=True) +# X2 = wireviz.Node("X2", num_pins=10, ports_left=True) +# W1 = wireviz.Cable("W1", num_wires=10, color_code="IEC") +# W1.connect_all_straight(X1,X2) +# X3 = wireviz.Node("X3", num_pins=10, ports_right=True) +# X4 = wireviz.Node("X4", num_pins=10, ports_left=True) +# W2 = wireviz.Cable("W2", num_wires=10, color_code="DIN") +# W2.connect_all_straight(X3,X4) +# objects = [X1, X2, W1, X3, X4, W2] with open('output/output.dot','w') as f: with open('input/header.dot','r') as infile: diff --git a/src/wireviz.py b/src/wireviz.py index ccb8aba..1780e96 100644 --- a/src/wireviz.py +++ b/src/wireviz.py @@ -93,6 +93,7 @@ class Cable: def __init__(self, name, show_name=False, num_wires=None, colors=None, color_code=None, shield=False): self.name = name self.show_name = show_name + self.shield = shield self.connections = [] if color_code is None and colors is None: self.colors = ("",) * num_wires @@ -113,8 +114,8 @@ class Cable: self.colors = colors else: self.colors = colors[:num_wires] - if shield == True: - self.colors = self.colors + ('Shield',) + # if shield == True: + # self.colors = self.colors + ('Shield',) def connect(self, from_name, from_pin, via, to_name, to_pin): if from_pin == 'auto': @@ -161,10 +162,14 @@ class Cable: for i,x in enumerate(self.colors,1): l.append('{wireno}'.format(wireno=i)) s = s + '|'.join(l) + if self.shield == True: + s = s + '|' s = s + '} | ' s = s + '{' s = s + '|'.join(self.colors) + if self.shield == True: + s = s + '|Shield' s = s + '}' s = s + ' | {' @@ -172,6 +177,8 @@ class Cable: for i,x in enumerate(self.colors,1): l.append('{wireno}'.format(wireno=i)) s = s + '|'.join(l) + if self.shield == True: + s = s + '|' s = s + '}' s = s + '}}"]' @@ -179,11 +186,16 @@ class Cable: s = s + '\n\n{edge[style=bold]\n' for x in self.connections: s = s + '{' - search_color = self.colors[x[2]-1] - if search_color in color_dict: - s = s + 'edge[color="#000000:{wire_color}:#000000"] '.format(wire_color=color_dict[search_color]) - t = '{from_name}:p{from_port} -> {via_name}:w{via_wire}i; {via_name}:w{via_wire}o -> {to_name}:p{to_port}'.format(from_name=x[0],from_port=x[1],via_name=self.name, via_wire=x[2],to_name=x[3],to_port=x[4]) - s = s + t + if isinstance(x[2], int): + search_color = self.colors[x[2]-1] + if search_color in color_dict: + s = s + 'edge[color="#000000:{wire_color}:#000000"] '.format(wire_color=color_dict[search_color]) + if x[1] is not None: + t = '{from_name}:p{from_port} -> {via_name}:w{via_wire}i; '.format(from_name=x[0],from_port=x[1],via_name=self.name, via_wire=x[2]) + s = s + t + if x[4] is not None: + t = '{via_name}:w{via_wire}o -> {to_name}:p{to_port}'.format(via_name=self.name, via_wire=x[2],to_name=x[3],to_port=x[4]) + s = s + t s = s + '}\n' s = s + '}' From d7a6deb578adfa24f4e09b39878270f91a65360d Mon Sep 17 00:00:00 2001 From: Daniel Rojas Date: Fri, 22 May 2020 14:37:08 +0200 Subject: [PATCH 14/14] Update readme, add GNU GPL v3 license --- LICENSE | 674 ++++++++++++++++++++++++++++++++++++++++++++++++++++++ readme.md | 6 + 2 files changed, 680 insertions(+) create mode 100644 LICENSE diff --git a/LICENSE b/LICENSE new file mode 100644 index 0000000..f288702 --- /dev/null +++ b/LICENSE @@ -0,0 +1,674 @@ + GNU GENERAL PUBLIC LICENSE + Version 3, 29 June 2007 + + Copyright (C) 2007 Free Software Foundation, Inc. + Everyone is permitted to copy and distribute verbatim copies + of this license document, but changing it is not allowed. + + Preamble + + The GNU General Public License is a free, copyleft license for +software and other kinds of works. + + The licenses for most software and other practical works are designed +to take away your freedom to share and change the works. By contrast, +the GNU General Public License is intended to guarantee your freedom to +share and change all versions of a program--to make sure it remains free +software for all its users. We, the Free Software Foundation, use the +GNU General Public License for most of our software; it applies also to +any other work released this way by its authors. You can apply it to +your programs, too. + + When we speak of free software, we are referring to freedom, not +price. Our General Public Licenses are designed to make sure that you +have the freedom to distribute copies of free software (and charge for +them if you wish), that you receive source code or can get it if you +want it, that you can change the software or use pieces of it in new +free programs, and that you know you can do these things. + + To protect your rights, we need to prevent others from denying you +these rights or asking you to surrender the rights. Therefore, you have +certain responsibilities if you distribute copies of the software, or if +you modify it: responsibilities to respect the freedom of others. + + For example, if you distribute copies of such a program, whether +gratis or for a fee, you must pass on to the recipients the same +freedoms that you received. You must make sure that they, too, receive +or can get the source code. And you must show them these terms so they +know their rights. + + Developers that use the GNU GPL protect your rights with two steps: +(1) assert copyright on the software, and (2) offer you this License +giving you legal permission to copy, distribute and/or modify it. + + For the developers' and authors' protection, the GPL clearly explains +that there is no warranty for this free software. For both users' and +authors' sake, the GPL requires that modified versions be marked as +changed, so that their problems will not be attributed erroneously to +authors of previous versions. + + Some devices are designed to deny users access to install or run +modified versions of the software inside them, although the manufacturer +can do so. This is fundamentally incompatible with the aim of +protecting users' freedom to change the software. The systematic +pattern of such abuse occurs in the area of products for individuals to +use, which is precisely where it is most unacceptable. Therefore, we +have designed this version of the GPL to prohibit the practice for those +products. If such problems arise substantially in other domains, we +stand ready to extend this provision to those domains in future versions +of the GPL, as needed to protect the freedom of users. + + Finally, every program is threatened constantly by software patents. +States should not allow patents to restrict development and use of +software on general-purpose computers, but in those that do, we wish to +avoid the special danger that patents applied to a free program could +make it effectively proprietary. To prevent this, the GPL assures that +patents cannot be used to render the program non-free. + + The precise terms and conditions for copying, distribution and +modification follow. + + TERMS AND CONDITIONS + + 0. Definitions. + + "This License" refers to version 3 of the GNU General Public License. + + "Copyright" also means copyright-like laws that apply to other kinds of +works, such as semiconductor masks. + + "The Program" refers to any copyrightable work licensed under this +License. Each licensee is addressed as "you". "Licensees" and +"recipients" may be individuals or organizations. + + To "modify" a work means to copy from or adapt all or part of the work +in a fashion requiring copyright permission, other than the making of an +exact copy. The resulting work is called a "modified version" of the +earlier work or a work "based on" the earlier work. + + A "covered work" means either the unmodified Program or a work based +on the Program. + + To "propagate" a work means to do anything with it that, without +permission, would make you directly or secondarily liable for +infringement under applicable copyright law, except executing it on a +computer or modifying a private copy. Propagation includes copying, +distribution (with or without modification), making available to the +public, and in some countries other activities as well. + + To "convey" a work means any kind of propagation that enables other +parties to make or receive copies. Mere interaction with a user through +a computer network, with no transfer of a copy, is not conveying. + + An interactive user interface displays "Appropriate Legal Notices" +to the extent that it includes a convenient and prominently visible +feature that (1) displays an appropriate copyright notice, and (2) +tells the user that there is no warranty for the work (except to the +extent that warranties are provided), that licensees may convey the +work under this License, and how to view a copy of this License. If +the interface presents a list of user commands or options, such as a +menu, a prominent item in the list meets this criterion. + + 1. Source Code. + + The "source code" for a work means the preferred form of the work +for making modifications to it. "Object code" means any non-source +form of a work. + + A "Standard Interface" means an interface that either is an official +standard defined by a recognized standards body, or, in the case of +interfaces specified for a particular programming language, one that +is widely used among developers working in that language. + + The "System Libraries" of an executable work include anything, other +than the work as a whole, that (a) is included in the normal form of +packaging a Major Component, but which is not part of that Major +Component, and (b) serves only to enable use of the work with that +Major Component, or to implement a Standard Interface for which an +implementation is available to the public in source code form. A +"Major Component", in this context, means a major essential component +(kernel, window system, and so on) of the specific operating system +(if any) on which the executable work runs, or a compiler used to +produce the work, or an object code interpreter used to run it. + + The "Corresponding Source" for a work in object code form means all +the source code needed to generate, install, and (for an executable +work) run the object code and to modify the work, including scripts to +control those activities. However, it does not include the work's +System Libraries, or general-purpose tools or generally available free +programs which are used unmodified in performing those activities but +which are not part of the work. For example, Corresponding Source +includes interface definition files associated with source files for +the work, and the source code for shared libraries and dynamically +linked subprograms that the work is specifically designed to require, +such as by intimate data communication or control flow between those +subprograms and other parts of the work. + + The Corresponding Source need not include anything that users +can regenerate automatically from other parts of the Corresponding +Source. + + The Corresponding Source for a work in source code form is that +same work. + + 2. Basic Permissions. + + All rights granted under this License are granted for the term of +copyright on the Program, and are irrevocable provided the stated +conditions are met. This License explicitly affirms your unlimited +permission to run the unmodified Program. The output from running a +covered work is covered by this License only if the output, given its +content, constitutes a covered work. This License acknowledges your +rights of fair use or other equivalent, as provided by copyright law. + + You may make, run and propagate covered works that you do not +convey, without conditions so long as your license otherwise remains +in force. You may convey covered works to others for the sole purpose +of having them make modifications exclusively for you, or provide you +with facilities for running those works, provided that you comply with +the terms of this License in conveying all material for which you do +not control copyright. Those thus making or running the covered works +for you must do so exclusively on your behalf, under your direction +and control, on terms that prohibit them from making any copies of +your copyrighted material outside their relationship with you. + + Conveying under any other circumstances is permitted solely under +the conditions stated below. Sublicensing is not allowed; section 10 +makes it unnecessary. + + 3. Protecting Users' Legal Rights From Anti-Circumvention Law. + + No covered work shall be deemed part of an effective technological +measure under any applicable law fulfilling obligations under article +11 of the WIPO copyright treaty adopted on 20 December 1996, or +similar laws prohibiting or restricting circumvention of such +measures. + + When you convey a covered work, you waive any legal power to forbid +circumvention of technological measures to the extent such circumvention +is effected by exercising rights under this License with respect to +the covered work, and you disclaim any intention to limit operation or +modification of the work as a means of enforcing, against the work's +users, your or third parties' legal rights to forbid circumvention of +technological measures. + + 4. Conveying Verbatim Copies. + + You may convey verbatim copies of the Program's source code as you +receive it, in any medium, provided that you conspicuously and +appropriately publish on each copy an appropriate copyright notice; +keep intact all notices stating that this License and any +non-permissive terms added in accord with section 7 apply to the code; +keep intact all notices of the absence of any warranty; and give all +recipients a copy of this License along with the Program. + + You may charge any price or no price for each copy that you convey, +and you may offer support or warranty protection for a fee. + + 5. Conveying Modified Source Versions. + + You may convey a work based on the Program, or the modifications to +produce it from the Program, in the form of source code under the +terms of section 4, provided that you also meet all of these conditions: + + a) The work must carry prominent notices stating that you modified + it, and giving a relevant date. + + b) The work must carry prominent notices stating that it is + released under this License and any conditions added under section + 7. This requirement modifies the requirement in section 4 to + "keep intact all notices". + + c) You must license the entire work, as a whole, under this + License to anyone who comes into possession of a copy. This + License will therefore apply, along with any applicable section 7 + additional terms, to the whole of the work, and all its parts, + regardless of how they are packaged. This License gives no + permission to license the work in any other way, but it does not + invalidate such permission if you have separately received it. + + d) If the work has interactive user interfaces, each must display + Appropriate Legal Notices; however, if the Program has interactive + interfaces that do not display Appropriate Legal Notices, your + work need not make them do so. + + A compilation of a covered work with other separate and independent +works, which are not by their nature extensions of the covered work, +and which are not combined with it such as to form a larger program, +in or on a volume of a storage or distribution medium, is called an +"aggregate" if the compilation and its resulting copyright are not +used to limit the access or legal rights of the compilation's users +beyond what the individual works permit. Inclusion of a covered work +in an aggregate does not cause this License to apply to the other +parts of the aggregate. + + 6. Conveying Non-Source Forms. + + You may convey a covered work in object code form under the terms +of sections 4 and 5, provided that you also convey the +machine-readable Corresponding Source under the terms of this License, +in one of these ways: + + a) Convey the object code in, or embodied in, a physical product + (including a physical distribution medium), accompanied by the + Corresponding Source fixed on a durable physical medium + customarily used for software interchange. + + b) Convey the object code in, or embodied in, a physical product + (including a physical distribution medium), accompanied by a + written offer, valid for at least three years and valid for as + long as you offer spare parts or customer support for that product + model, to give anyone who possesses the object code either (1) a + copy of the Corresponding Source for all the software in the + product that is covered by this License, on a durable physical + medium customarily used for software interchange, for a price no + more than your reasonable cost of physically performing this + conveying of source, or (2) access to copy the + Corresponding Source from a network server at no charge. + + c) Convey individual copies of the object code with a copy of the + written offer to provide the Corresponding Source. This + alternative is allowed only occasionally and noncommercially, and + only if you received the object code with such an offer, in accord + with subsection 6b. + + d) Convey the object code by offering access from a designated + place (gratis or for a charge), and offer equivalent access to the + Corresponding Source in the same way through the same place at no + further charge. You need not require recipients to copy the + Corresponding Source along with the object code. If the place to + copy the object code is a network server, the Corresponding Source + may be on a different server (operated by you or a third party) + that supports equivalent copying facilities, provided you maintain + clear directions next to the object code saying where to find the + Corresponding Source. Regardless of what server hosts the + Corresponding Source, you remain obligated to ensure that it is + available for as long as needed to satisfy these requirements. + + e) Convey the object code using peer-to-peer transmission, provided + you inform other peers where the object code and Corresponding + Source of the work are being offered to the general public at no + charge under subsection 6d. + + A separable portion of the object code, whose source code is excluded +from the Corresponding Source as a System Library, need not be +included in conveying the object code work. + + A "User Product" is either (1) a "consumer product", which means any +tangible personal property which is normally used for personal, family, +or household purposes, or (2) anything designed or sold for incorporation +into a dwelling. In determining whether a product is a consumer product, +doubtful cases shall be resolved in favor of coverage. For a particular +product received by a particular user, "normally used" refers to a +typical or common use of that class of product, regardless of the status +of the particular user or of the way in which the particular user +actually uses, or expects or is expected to use, the product. A product +is a consumer product regardless of whether the product has substantial +commercial, industrial or non-consumer uses, unless such uses represent +the only significant mode of use of the product. + + "Installation Information" for a User Product means any methods, +procedures, authorization keys, or other information required to install +and execute modified versions of a covered work in that User Product from +a modified version of its Corresponding Source. The information must +suffice to ensure that the continued functioning of the modified object +code is in no case prevented or interfered with solely because +modification has been made. + + If you convey an object code work under this section in, or with, or +specifically for use in, a User Product, and the conveying occurs as +part of a transaction in which the right of possession and use of the +User Product is transferred to the recipient in perpetuity or for a +fixed term (regardless of how the transaction is characterized), the +Corresponding Source conveyed under this section must be accompanied +by the Installation Information. But this requirement does not apply +if neither you nor any third party retains the ability to install +modified object code on the User Product (for example, the work has +been installed in ROM). + + The requirement to provide Installation Information does not include a +requirement to continue to provide support service, warranty, or updates +for a work that has been modified or installed by the recipient, or for +the User Product in which it has been modified or installed. Access to a +network may be denied when the modification itself materially and +adversely affects the operation of the network or violates the rules and +protocols for communication across the network. + + Corresponding Source conveyed, and Installation Information provided, +in accord with this section must be in a format that is publicly +documented (and with an implementation available to the public in +source code form), and must require no special password or key for +unpacking, reading or copying. + + 7. Additional Terms. + + "Additional permissions" are terms that supplement the terms of this +License by making exceptions from one or more of its conditions. +Additional permissions that are applicable to the entire Program shall +be treated as though they were included in this License, to the extent +that they are valid under applicable law. If additional permissions +apply only to part of the Program, that part may be used separately +under those permissions, but the entire Program remains governed by +this License without regard to the additional permissions. + + When you convey a copy of a covered work, you may at your option +remove any additional permissions from that copy, or from any part of +it. (Additional permissions may be written to require their own +removal in certain cases when you modify the work.) You may place +additional permissions on material, added by you to a covered work, +for which you have or can give appropriate copyright permission. + + Notwithstanding any other provision of this License, for material you +add to a covered work, you may (if authorized by the copyright holders of +that material) supplement the terms of this License with terms: + + a) Disclaiming warranty or limiting liability differently from the + terms of sections 15 and 16 of this License; or + + b) Requiring preservation of specified reasonable legal notices or + author attributions in that material or in the Appropriate Legal + Notices displayed by works containing it; or + + c) Prohibiting misrepresentation of the origin of that material, or + requiring that modified versions of such material be marked in + reasonable ways as different from the original version; or + + d) Limiting the use for publicity purposes of names of licensors or + authors of the material; or + + e) Declining to grant rights under trademark law for use of some + trade names, trademarks, or service marks; or + + f) Requiring indemnification of licensors and authors of that + material by anyone who conveys the material (or modified versions of + it) with contractual assumptions of liability to the recipient, for + any liability that these contractual assumptions directly impose on + those licensors and authors. + + All other non-permissive additional terms are considered "further +restrictions" within the meaning of section 10. If the Program as you +received it, or any part of it, contains a notice stating that it is +governed by this License along with a term that is a further +restriction, you may remove that term. If a license document contains +a further restriction but permits relicensing or conveying under this +License, you may add to a covered work material governed by the terms +of that license document, provided that the further restriction does +not survive such relicensing or conveying. + + If you add terms to a covered work in accord with this section, you +must place, in the relevant source files, a statement of the +additional terms that apply to those files, or a notice indicating +where to find the applicable terms. + + Additional terms, permissive or non-permissive, may be stated in the +form of a separately written license, or stated as exceptions; +the above requirements apply either way. + + 8. Termination. + + You may not propagate or modify a covered work except as expressly +provided under this License. Any attempt otherwise to propagate or +modify it is void, and will automatically terminate your rights under +this License (including any patent licenses granted under the third +paragraph of section 11). + + However, if you cease all violation of this License, then your +license from a particular copyright holder is reinstated (a) +provisionally, unless and until the copyright holder explicitly and +finally terminates your license, and (b) permanently, if the copyright +holder fails to notify you of the violation by some reasonable means +prior to 60 days after the cessation. + + Moreover, your license from a particular copyright holder is +reinstated permanently if the copyright holder notifies you of the +violation by some reasonable means, this is the first time you have +received notice of violation of this License (for any work) from that +copyright holder, and you cure the violation prior to 30 days after +your receipt of the notice. + + Termination of your rights under this section does not terminate the +licenses of parties who have received copies or rights from you under +this License. If your rights have been terminated and not permanently +reinstated, you do not qualify to receive new licenses for the same +material under section 10. + + 9. Acceptance Not Required for Having Copies. + + You are not required to accept this License in order to receive or +run a copy of the Program. Ancillary propagation of a covered work +occurring solely as a consequence of using peer-to-peer transmission +to receive a copy likewise does not require acceptance. However, +nothing other than this License grants you permission to propagate or +modify any covered work. These actions infringe copyright if you do +not accept this License. Therefore, by modifying or propagating a +covered work, you indicate your acceptance of this License to do so. + + 10. Automatic Licensing of Downstream Recipients. + + Each time you convey a covered work, the recipient automatically +receives a license from the original licensors, to run, modify and +propagate that work, subject to this License. You are not responsible +for enforcing compliance by third parties with this License. + + An "entity transaction" is a transaction transferring control of an +organization, or substantially all assets of one, or subdividing an +organization, or merging organizations. If propagation of a covered +work results from an entity transaction, each party to that +transaction who receives a copy of the work also receives whatever +licenses to the work the party's predecessor in interest had or could +give under the previous paragraph, plus a right to possession of the +Corresponding Source of the work from the predecessor in interest, if +the predecessor has it or can get it with reasonable efforts. + + You may not impose any further restrictions on the exercise of the +rights granted or affirmed under this License. For example, you may +not impose a license fee, royalty, or other charge for exercise of +rights granted under this License, and you may not initiate litigation +(including a cross-claim or counterclaim in a lawsuit) alleging that +any patent claim is infringed by making, using, selling, offering for +sale, or importing the Program or any portion of it. + + 11. Patents. + + A "contributor" is a copyright holder who authorizes use under this +License of the Program or a work on which the Program is based. The +work thus licensed is called the contributor's "contributor version". + + A contributor's "essential patent claims" are all patent claims +owned or controlled by the contributor, whether already acquired or +hereafter acquired, that would be infringed by some manner, permitted +by this License, of making, using, or selling its contributor version, +but do not include claims that would be infringed only as a +consequence of further modification of the contributor version. For +purposes of this definition, "control" includes the right to grant +patent sublicenses in a manner consistent with the requirements of +this License. + + Each contributor grants you a non-exclusive, worldwide, royalty-free +patent license under the contributor's essential patent claims, to +make, use, sell, offer for sale, import and otherwise run, modify and +propagate the contents of its contributor version. + + In the following three paragraphs, a "patent license" is any express +agreement or commitment, however denominated, not to enforce a patent +(such as an express permission to practice a patent or covenant not to +sue for patent infringement). To "grant" such a patent license to a +party means to make such an agreement or commitment not to enforce a +patent against the party. + + If you convey a covered work, knowingly relying on a patent license, +and the Corresponding Source of the work is not available for anyone +to copy, free of charge and under the terms of this License, through a +publicly available network server or other readily accessible means, +then you must either (1) cause the Corresponding Source to be so +available, or (2) arrange to deprive yourself of the benefit of the +patent license for this particular work, or (3) arrange, in a manner +consistent with the requirements of this License, to extend the patent +license to downstream recipients. "Knowingly relying" means you have +actual knowledge that, but for the patent license, your conveying the +covered work in a country, or your recipient's use of the covered work +in a country, would infringe one or more identifiable patents in that +country that you have reason to believe are valid. + + If, pursuant to or in connection with a single transaction or +arrangement, you convey, or propagate by procuring conveyance of, a +covered work, and grant a patent license to some of the parties +receiving the covered work authorizing them to use, propagate, modify +or convey a specific copy of the covered work, then the patent license +you grant is automatically extended to all recipients of the covered +work and works based on it. + + A patent license is "discriminatory" if it does not include within +the scope of its coverage, prohibits the exercise of, or is +conditioned on the non-exercise of one or more of the rights that are +specifically granted under this License. You may not convey a covered +work if you are a party to an arrangement with a third party that is +in the business of distributing software, under which you make payment +to the third party based on the extent of your activity of conveying +the work, and under which the third party grants, to any of the +parties who would receive the covered work from you, a discriminatory +patent license (a) in connection with copies of the covered work +conveyed by you (or copies made from those copies), or (b) primarily +for and in connection with specific products or compilations that +contain the covered work, unless you entered into that arrangement, +or that patent license was granted, prior to 28 March 2007. + + Nothing in this License shall be construed as excluding or limiting +any implied license or other defenses to infringement that may +otherwise be available to you under applicable patent law. + + 12. No Surrender of Others' Freedom. + + If conditions are imposed on you (whether by court order, agreement or +otherwise) that contradict the conditions of this License, they do not +excuse you from the conditions of this License. If you cannot convey a +covered work so as to satisfy simultaneously your obligations under this +License and any other pertinent obligations, then as a consequence you may +not convey it at all. For example, if you agree to terms that obligate you +to collect a royalty for further conveying from those to whom you convey +the Program, the only way you could satisfy both those terms and this +License would be to refrain entirely from conveying the Program. + + 13. Use with the GNU Affero General Public License. + + Notwithstanding any other provision of this License, you have +permission to link or combine any covered work with a work licensed +under version 3 of the GNU Affero General Public License into a single +combined work, and to convey the resulting work. The terms of this +License will continue to apply to the part which is the covered work, +but the special requirements of the GNU Affero General Public License, +section 13, concerning interaction through a network will apply to the +combination as such. + + 14. Revised Versions of this License. + + The Free Software Foundation may publish revised and/or new versions of +the GNU General Public License from time to time. Such new versions will +be similar in spirit to the present version, but may differ in detail to +address new problems or concerns. + + Each version is given a distinguishing version number. If the +Program specifies that a certain numbered version of the GNU General +Public License "or any later version" applies to it, you have the +option of following the terms and conditions either of that numbered +version or of any later version published by the Free Software +Foundation. If the Program does not specify a version number of the +GNU General Public License, you may choose any version ever published +by the Free Software Foundation. + + If the Program specifies that a proxy can decide which future +versions of the GNU General Public License can be used, that proxy's +public statement of acceptance of a version permanently authorizes you +to choose that version for the Program. + + Later license versions may give you additional or different +permissions. However, no additional obligations are imposed on any +author or copyright holder as a result of your choosing to follow a +later version. + + 15. Disclaimer of Warranty. + + THERE IS NO WARRANTY FOR THE PROGRAM, TO THE EXTENT PERMITTED BY +APPLICABLE LAW. EXCEPT WHEN OTHERWISE STATED IN WRITING THE COPYRIGHT +HOLDERS AND/OR OTHER PARTIES PROVIDE THE PROGRAM "AS IS" WITHOUT WARRANTY +OF ANY KIND, EITHER EXPRESSED OR IMPLIED, INCLUDING, BUT NOT LIMITED TO, +THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR +PURPOSE. THE ENTIRE RISK AS TO THE QUALITY AND PERFORMANCE OF THE PROGRAM +IS WITH YOU. SHOULD THE PROGRAM PROVE DEFECTIVE, YOU ASSUME THE COST OF +ALL NECESSARY SERVICING, REPAIR OR CORRECTION. + + 16. Limitation of Liability. + + IN NO EVENT UNLESS REQUIRED BY APPLICABLE LAW OR AGREED TO IN WRITING +WILL ANY COPYRIGHT HOLDER, OR ANY OTHER PARTY WHO MODIFIES AND/OR CONVEYS +THE PROGRAM AS PERMITTED ABOVE, BE LIABLE TO YOU FOR DAMAGES, INCLUDING ANY +GENERAL, SPECIAL, INCIDENTAL OR CONSEQUENTIAL DAMAGES ARISING OUT OF THE +USE OR INABILITY TO USE THE PROGRAM (INCLUDING BUT NOT LIMITED TO LOSS OF +DATA OR DATA BEING RENDERED INACCURATE OR LOSSES SUSTAINED BY YOU OR THIRD +PARTIES OR A FAILURE OF THE PROGRAM TO OPERATE WITH ANY OTHER PROGRAMS), +EVEN IF SUCH HOLDER OR OTHER PARTY HAS BEEN ADVISED OF THE POSSIBILITY OF +SUCH DAMAGES. + + 17. Interpretation of Sections 15 and 16. + + If the disclaimer of warranty and limitation of liability provided +above cannot be given local legal effect according to their terms, +reviewing courts shall apply local law that most closely approximates +an absolute waiver of all civil liability in connection with the +Program, unless a warranty or assumption of liability accompanies a +copy of the Program in return for a fee. + + END OF TERMS AND CONDITIONS + + How to Apply These Terms to Your New Programs + + If you develop a new program, and you want it to be of the greatest +possible use to the public, the best way to achieve this is to make it +free software which everyone can redistribute and change under these terms. + + To do so, attach the following notices to the program. It is safest +to attach them to the start of each source file to most effectively +state the exclusion of warranty; and each file should have at least +the "copyright" line and a pointer to where the full notice is found. + + + Copyright (C) + + This program is free software: you can redistribute it and/or modify + it under the terms of the GNU General Public License as published by + the Free Software Foundation, either version 3 of the License, or + (at your option) any later version. + + This program is distributed in the hope that it will be useful, + but WITHOUT ANY WARRANTY; without even the implied warranty of + MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the + GNU General Public License for more details. + + You should have received a copy of the GNU General Public License + along with this program. If not, see . + +Also add information on how to contact you by electronic and paper mail. + + If the program does terminal interaction, make it output a short +notice like this when it starts in an interactive mode: + + Copyright (C) + This program comes with ABSOLUTELY NO WARRANTY; for details type `show w'. + This is free software, and you are welcome to redistribute it + under certain conditions; type `show c' for details. + +The hypothetical commands `show w' and `show c' should show the appropriate +parts of the General Public License. Of course, your program's commands +might be different; for a GUI interface, you would use an "about box". + + You should also get your employer (if you work as a programmer) or school, +if any, to sign a "copyright disclaimer" for the program, if necessary. +For more information on this, and how to apply and follow the GNU GPL, see +. + + The GNU General Public License does not permit incorporating your program +into proprietary programs. If your program is a subroutine library, you +may consider it more useful to permit linking proprietary applications with +the library. If this is what you want to do, use the GNU Lesser General +Public License instead of this License. But first, please read +. diff --git a/readme.md b/readme.md index 44d0693..6cb0dfa 100644 --- a/readme.md +++ b/readme.md @@ -89,3 +89,9 @@ GraphViz code generated by parser: ## Status This is very much a work in progress, and mainly an idea in my head. +A Python module and test scripts is available. Running the test script will generate GraphViz output. +The parser will follow later; contributions are welcome! + +## License + +GNU GPLv3