-
Notifications
You must be signed in to change notification settings - Fork 8
/
helper.py
executable file
·583 lines (459 loc) · 16.9 KB
/
helper.py
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
320
321
322
323
324
325
326
327
328
329
330
331
332
333
334
335
336
337
338
339
340
341
342
343
344
345
346
347
348
349
350
351
352
353
354
355
356
357
358
359
360
361
362
363
364
365
366
367
368
369
370
371
372
373
374
375
376
377
378
379
380
381
382
383
384
385
386
387
388
389
390
391
392
393
394
395
396
397
398
399
400
401
402
403
404
405
406
407
408
409
410
411
412
413
414
415
416
417
418
419
420
421
422
423
424
425
426
427
428
429
430
431
432
433
434
435
436
437
438
439
440
441
442
443
444
445
446
447
448
449
450
451
452
453
454
455
456
457
458
459
460
461
462
463
464
465
466
467
468
469
470
471
472
473
474
475
476
477
478
479
480
481
482
483
484
485
486
487
488
489
490
491
492
493
494
495
496
497
498
499
500
501
502
503
504
505
506
507
508
509
510
511
512
513
514
515
516
517
518
519
520
521
522
523
524
525
526
527
528
529
530
531
532
533
534
535
536
537
538
539
540
541
542
543
544
545
546
547
548
549
550
551
552
553
554
555
556
557
558
559
560
561
562
563
564
565
566
567
568
569
570
571
572
573
574
575
576
577
578
579
580
581
582
583
#!/usr/bin/env python3
import sys
import os
import re
import json
import xml.etree.ElementTree
import datetime
# Version check
f"Python 3.6+ is required"
class UserException(Exception):
pass
def eprint(*args, **kwargs):
print(*args, file=sys.stderr, **kwargs)
def find(f, array):
for a in array:
if f(a):
return f
def input_default(prompt, default=""):
str = input(f"{prompt} [{default}]: ")
if str == "":
return default
return str
def is_valid_slug(slug):
return re.match(r'^[a-zA-Z0-9_\-]+$', slug) != None
def str_to_identifier(s):
if not s:
return "_"
# Identifiers can't start with a number
if s[0].isdigit():
s = "_" + s
# Capitalize first letter
s = s[0].upper() + s[1:]
# Replace special characters with underscore
s = re.sub(r'\W', '_', s)
return s
def create_plugin(slug, plugin_dir=None):
pass
def create_manifest(slug, plugin_dir="."):
pass
# Default manifest
def create_module(slug, panel_filename=None, source_filename=None):
# Check slug
if not is_valid_slug(slug):
raise UserException("Slug must only contain ASCII letters, numbers, '-', and '_'.")
# Read manifest
manifest_filename = 'plugin.json'
with open(manifest_filename, "r") as f:
manifest = json.load(f)
# Check if module manifest exists
module_manifest = find(lambda m: m['slug'] == slug, manifest['modules'])
if module_manifest:
eprint(f"Module {slug} already exists in plugin.json. Edit this file to modify the module manifest.")
else:
# Add module to manifest
module_manifest = {}
module_manifest['slug'] = slug
module_manifest['name'] = input_default("Module name", slug)
module_manifest['description'] = input_default("One-line description (optional)")
tags = input_default(
"Tags (comma-separated, case-insensitive, see https://vcvrack.com/manual/Manifest#modules-tags for list)")
tags = tags.split(",")
tags = [tag.strip() for tag in tags]
if len(tags) == 1 and tags[0] == "":
tags = []
module_manifest['tags'] = tags
manifest['modules'].append(module_manifest)
# Write manifest
with open(manifest_filename, "w") as f:
json.dump(manifest, f, indent=" ")
eprint(f"Added {slug} to {manifest_filename}")
# Check filenames
if panel_filename:
if not os.path.exists(panel_filename):
raise UserException(f"Panel not found at {panel_filename}.")
if source_filename and os.path.exists(source_filename):
if input_default(f"{source_filename} already exists. Overwrite? (y/n)", "n").lower() != "y":
return
# Read SVG XML
tree = xml.etree.ElementTree.parse(panel_filename)
components = panel_to_components(tree)
# Tell user to add model to plugin.hpp and plugin.cpp
identifier = str_to_identifier(slug)
eprint(f"""
To enable the module, add
extern Model* model{identifier};
to plugin.hpp, and add
p->addModel(model{identifier});
to the init() function in plugin.cpp.""")
# Write source
# source = components_to_source(components, slug)
#
# if source_filename:
# with open(source_filename, "w") as f:
# f.write(source)
# eprint(f"Source file generated at {source_filename}")
# else:
# print(source)
components_to_sourcefiles(components, slug)
def panel_to_components(tree):
ns = {
"svg": "http://www.w3.org/2000/svg",
"inkscape": "http://www.inkscape.org/namespaces/inkscape",
}
root = tree.getroot()
# Get SVG scale relative to mm
root_height = root.get('height')
if root_height.endswith("mm"):
scale = 1
else:
svg_dpi = 75
mm_per_in = 25.4
scale = mm_per_in / svg_dpi
# Get components layer
group = root.find(".//svg:g[@inkscape:label='components']", ns)
# Illustrator uses `data-name` (in Unique object ID mode) or `id` (in Layer Names object ID mode) for the group name.
# Don't test with `not group` since Elements with no subelements are falsy.
if group is None:
group = root.find(".//svg:g[@data-name='components']", ns)
if group is None:
group = root.find(".//svg:g[@id='components']", ns)
if group is None:
raise UserException("Could not find \"components\" layer on panel")
components = {}
components['params'] = []
components['inputs'] = []
components['outputs'] = []
components['lights'] = []
components['widgets'] = []
for el in group:
c = {}
# Get name
name = el.get('{' + ns['inkscape'] + '}label')
# Illustrator names
if not name:
name = el.get('data-name')
if not name:
name = el.get('id')
if not name:
name = ""
# Split name and component class name
names = name.split('#', 1)
name = names[0]
if len(names) >= 2:
c['cls'] = names[1]
name = str_to_identifier(name).upper()
c['name'] = name
# Get position
if el.tag == '{' + ns['svg'] + '}rect':
x = float(el.get('x')) * scale
y = float(el.get('y')) * scale
width = float(el.get('width')) * scale
height = float(el.get('height')) * scale
c['x'] = round(x, 3)
c['y'] = round(y, 3)
c['width'] = round(width, 3)
c['height'] = round(height, 3)
c['cx'] = round(x + width / 2, 3)
c['cy'] = round(y + height / 2, 3)
elif el.tag == '{' + ns['svg'] + '}circle' or el.tag == '{' + ns['svg'] + '}ellipse':
cx = float(el.get('cx')) * scale
cy = float(el.get('cy')) * scale
c['cx'] = round(cx, 3)
c['cy'] = round(cy, 3)
else:
eprint(f"Element in components layer is not rect, circle, or ellipse: {el}")
continue
# Get color
color = None
# Get color from fill attribute
fill = el.get('fill')
if fill:
color = fill
# Get color from CSS fill style
if not color:
style = el.get('style')
if style:
color_match = re.search(r'fill:\S*(#[0-9a-fA-F]{6})', style)
color = color_match.group(1)
if not color:
eprint(f"Cannot get color of component: {el}")
continue
color = color.lower()
if color == '#ff0000' or color == '#f00' or color == 'red':
components['params'].append(c)
if color == '#00ff00' or color == '#0f0' or color == 'lime':
components['inputs'].append(c)
if color == '#0000ff' or color == '#00f' or color == 'blue':
components['outputs'].append(c)
if color == '#ff00ff' or color == '#f0f' or color == 'magenta':
components['lights'].append(c)
if color == '#ffff00' or color == '#ff0' or color == 'yellow':
components['widgets'].append(c)
# Sort components
top_left_sort = lambda w: w['cy'] + 0.01 * w['cx']
components['params'] = sorted(components['params'], key=top_left_sort)
components['inputs'] = sorted(components['inputs'], key=top_left_sort)
components['outputs'] = sorted(components['outputs'], key=top_left_sort)
components['lights'] = sorted(components['lights'], key=top_left_sort)
components['widgets'] = sorted(components['widgets'], key=top_left_sort)
eprint(
f"Found {len(components['params'])} params, {len(components['inputs'])} inputs, {len(components['outputs'])} outputs, {len(components['lights'])} lights, and {len(components['widgets'])} custom widgets in \"components\" layer.")
return components
def components_to_modulecpp(components, slug):
identifier = str_to_identifier(slug)
source = ""
# read templateModule.cpp
with open("src/templates/templateModule.cpp") as f:
source = f.read()
# replace date
year = str(datetime.datetime.now().year)
source = source.replace("YEAR", year)
# replace slug
source = source.replace("SLUG", identifier)
# replace ADDWIDGETS
source = source.replace("ADDWIDGETS", components_to_paramwidgets(components, identifier))
# replace CONFIGWIDGETNAME
source = source.replace("CONFIGWIDGETNAME", components_to_PortNaming(components))
return source
def components_to_PortNaming(components):
source = ""
for c in components['inputs']:
source += f"""module->configInput (Comp::{c['name']}_INPUT, "{c['name']}");
"""
for c in components['outputs']:
source += f"""module->configOutput (Comp::{c['name']}_OUTPUT, "{c['name']}");
"""
for c in components['lights']:
source += f"""module->configLight (Comp::{c['name']}_LIGHT, "{c['name']}");
"""
return source
def components_to_composite(components, slug):
identifier = str_to_identifier(slug)
source = ""
# read templateModule.cpp
with open("src/templates/templateComposite.h") as f:
source = f.read()
# replace date
year = str(datetime.datetime.now().year)
source = source.replace("YEAR", year)
# replace slug
source = source.replace("SLUG", identifier)
# replace PORTENUMS
source = source.replace("PORTENUMS", components_to_portenums(components, identifier))
# replace CASEPARAMDESCRIPTIONS
source = source.replace("CASEPARAMDESCRIPTIONS", components_to_paramdescriptions(components, identifier))
return source
def components_to_test(components, slug):
identifier = str_to_identifier(slug)
source = ""
# read templateModule.cpp
with open("src/templates/templateTest.cpp") as f:
source = f.read()
# replace date
year = str(datetime.datetime.now().year)
source = source.replace("YEAR", year)
# replace slug
source = source.replace("SLUG", identifier)
return source
def components_to_paramdescriptions(components, identifier):
source = ""
for c in components['params']:
source += f"""case {identifier}Comp<TBase>::{c['name']}_PARAM:
ret = {{0.0f, 1.0f, 0.5f, "{c['name']}", " ", 0.0f, 1.0f, 0.0f }};
break;
"""
return source
def components_to_portenums(components, identifier):
# Params
source = ""
source += """
enum ParamId {"""
for c in components['params']:
source += f"""
{c['name']}_PARAM,"""
source += """
NUM_PARAMS
};"""
# Inputs
source += """
enum InputId {"""
for c in components['inputs']:
source += f"""
{c['name']}_INPUT,"""
source += """
NUM_INPUTS
};"""
# Outputs
source += """
enum OutputId {"""
for c in components['outputs']:
source += f"""
{c['name']}_OUTPUT,"""
source += """
NUM_OUTPUTS
};"""
# Lights
source += """
enum LightId {"""
for c in components['lights']:
source += f"""
{c['name']}_LIGHT,"""
source += """
NUM_LIGHTS
};"""
return source
def components_to_paramwidgets(components, identifier):
# Params
source = ""
if len(components['params']) > 0:
source += "\n"
for c in components['params']:
if 'x' in c:
source += f"""
addParam(createParam<{c.get('cls', 'sspo::Knob')}>(mm2px(Vec({c['x']}, {c['y']})), module, Comp::{c['name']}_PARAM));"""
else:
source += f"""
addParam(createParamCentered<{c.get('cls', 'sspo::Knob')}>(mm2px(Vec({c['cx']}, {c['cy']})), module, Comp::{c['name']}_PARAM));"""
# Inputs
if len(components['inputs']) > 0:
source += "\n"
for c in components['inputs']:
if 'x' in c:
source += f"""
addInput(createInput<{c.get('cls', 'sspo::PJ301MPort')}>(mm2px(Vec({c['x']}, {c['y']})), module, Comp::{c['name']}_INPUT));"""
else:
source += f"""
addInput(createInputCentered<{c.get('cls', 'sspo::PJ301MPort')}>(mm2px(Vec({c['cx']}, {c['cy']})), module, Comp::{c['name']}_INPUT));"""
# Outputs
if len(components['outputs']) > 0:
source += "\n"
for c in components['outputs']:
if 'x' in c:
source += f"""
addOutput(createOutput<{c.get('cls', 'sspo::PJ301MPort')}>(mm2px(Vec({c['x']}, {c['y']})), module, Comp::{c['name']}_OUTPUT));"""
else:
source += f"""
addOutput(createOutputCentered<{c.get('cls', 'sspo::PJ301MPort')}>(mm2px(Vec({c['cx']}, {c['cy']})), module, Comp::{c['name']}_OUTPUT));"""
# Lights
if len(components['lights']) > 0:
source += "\n"
for c in components['lights']:
if 'x' in c:
source += f"""
addChild(createLight<{c.get('cls', 'SmallLight<GreenLight>')}>(mm2px(Vec({c['x']}, {c['y']})), module, Comp::{c['name']}_LIGHT));"""
else:
source += f"""
addChild(createLightCentered<{c.get('cls', 'SmallLight<GreenLight>')}>(mm2px(Vec({c['cx']}, {c['cy']})), module, Comp::{c['name']}_LIGHT));"""
# Widgets
if len(components['widgets']) > 0:
source += "\n"
for c in components['widgets']:
if 'x' in c:
source += f"""
// mm2px(Vec({c['width']}, {c['height']}))
addChild(createWidget<{c.get('cls', 'Widget')}>(mm2px(Vec({c['x']}, {c['y']}))));"""
else:
source += f"""
addChild(createWidgetCentered<{c.get('cls', 'Widget')}>(mm2px(Vec({c['cx']}, {c['cy']}))));"""
return source
def components_to_sourcefiles(components, slug):
identifier = str_to_identifier(slug)
with open(f"""src/modules/{identifier}.cpp""", "w") as f:
f.write(components_to_modulecpp(components, slug))
with open(f"""src/composites/{identifier}.h""", "w") as f:
f.write(components_to_composite(components, slug))
with open(f"""test/test{identifier}.cpp""", "w") as f:
f.write(components_to_test(components, slug))
edit_plugin_and_testmain_files(identifier)
edit_readme(identifier)
def edit_readme(identifier):
with open(f"""README.md""", "r") as f:
source = f.read()
source = source.replace("[Next](#next)", f"""[{identifier}](#{identifier})\n\n[Next](#next)""")
source = source.replace("### Next", f"""### {identifier}\n\n<img src="images/{identifier}.png">\n\n### Next""")
with open(f"""README.md""", "w") as f:
f.write(source)
def edit_plugin_and_testmain_files(identifier):
with open(f"""src/plugin.cpp""", "r") as f:
source = f.read()
source = source.replace("// ADD ADDMODEL", f"""
p->addModel(model{identifier});
// ADD ADDMODEL
""")
with open(f"""src/plugin.cpp""", "w") as f:
f.write(source)
with open(f"""src/plugin.hpp""", "r") as f:
source = f.read()
source = source.replace("//ADD EXTERNS", f"""
extern Model* model{identifier};
//ADD EXTERNS
""")
with open(f"""src/plugin.hpp""", "w") as f:
f.write(source)
with open(f"""test/main.cpp""", "r") as f:
source = f.read()
source = source.replace("// ADD EXTERN", f"""// ADD EXTERN
extern void test{identifier}();
""")
source = source.replace("// ADD NEWTEST", f""" // ADD NEWTEST
test{identifier}();
""")
with open(f"""test/main.cpp""", "w") as f:
f.write(source)
def usage(script):
text = f"""
VCV
Rack
Plugin
Development
Helper
Usage: {script} < command > ...
Commands:
createplugin < slug > [plugin dir]
A
directory
will
be
created and initialized
with a minimal plugin template.
If no plugin directory is given, the slug is used.
createmanifest < slug >[plugin dir]
Creates a `plugin.json` manifest file in an existing plugin directory.
If no plugin directory is given, the current directory is used.
createmodule < module slug >[panel file][source file]
Adds a new module to the plugin manifest in the current directory.
If a panel and source file are given, generates a template source file initialized with components from a panel file.
Example:
{script}
createmodule
MyModule
res / MyModule.svg
src / MyModule.cpp
See
https: // vcvrack.com / manual / PanelTutorial.html
for creating SVG panel files.
"""
eprint(text)
def parse_args(args):
script = args.pop(0)
if len(args) == 0:
usage(script)
return
cmd = args.pop(0)
if cmd == 'createplugin':
create_plugin(*args)
elif cmd == 'createmodule':
create_module(*args)
elif cmd == 'createmanifest':
create_manifest(*args)
else:
eprint(f"Command not found: {cmd}")
if __name__ == "__main__":
try:
parse_args(sys.argv)
except KeyboardInterrupt:
pass
except UserException as e:
eprint(e)
sys.exit(1)