render.py 6.4 KB

123456789101112131415161718192021222324252627282930313233343536373839404142434445464748495051525354555657585960616263646566676869707172737475767778798081828384858687888990919293949596979899100101102103104105106107108109110111112113114115116117118119120121122123124125126127128129130131132133134135136137138139140141142143144145146147148149150151152153154155156157158159160161162163164165166
  1. import argparse
  2. import sys
  3. import subprocess
  4. import multiprocessing
  5. from lib.os_tools import *
  6. from sccd.util.indenting_writer import *
  7. from sccd.parser.statechart_parser import *
  8. import lxml.etree as ET
  9. if __name__ == '__main__':
  10. parser = argparse.ArgumentParser(
  11. description="Render statecharts as SVG images.")
  12. parser.add_argument('path', metavar='PATH', type=str, nargs='*', help="Models to render. Can be a XML file or a directory. If a directory, it will be recursively scanned for XML files.")
  13. parser.add_argument('--build-dir', metavar='DIR', type=str, default='build', help="As a first step, input XML files first must be compiled to python files. Directory to store these files. Defaults to 'build'")
  14. parser.add_argument('--output-dir', metavar='DIR', type=str, default='', help="Directory for SVG rendered output. Defaults to '.' (putting the SVG files with the XML source files)")
  15. parser.add_argument('--keep-smcat', action='store_true', help="Whether to NOT delete intermediary SMCAT files after producing SVG output. Default = off (delete files)")
  16. parser.add_argument('--no-svg', action='store_true', help="Don't produce SVG output. This option only makes sense in combination with the --keep-smcat option. Default = off")
  17. parser.add_argument('--pool-size', metavar='INT', type=int, default=multiprocessing.cpu_count()+1, help="Number of worker processes. Default = CPU count + 1.")
  18. args = parser.parse_args()
  19. srcs = get_files(args.path,
  20. filter=lambda file: (file.startswith("statechart_") or file.startswith("test_")) and file.endswith(".xml"))
  21. if len(srcs):
  22. if not args.no_svg:
  23. try:
  24. subprocess.run(["state-machine-cat", "-h"], capture_output=True)
  25. except:
  26. print("Failed to run 'state-machine-cat'. Make sure this application is installed on your system.")
  27. exit()
  28. else:
  29. print("No input files specified.")
  30. print()
  31. parser.print_usage()
  32. exit()
  33. def process(src):
  34. try:
  35. parser = StatechartParser(load_external = False)
  36. parser.globals.push(Globals(fixed_delta = None))
  37. parser.statecharts.push([])
  38. parser.parse(src)
  39. statecharts = parser.statecharts.pop()
  40. if len(statecharts) != 1:
  41. return # no statechart here :(
  42. statechart = statecharts[0]
  43. root = statechart.tree.root
  44. target_path = lambda ext: os.path.join(args.output_dir, dropext(src)+ext)
  45. smcat_target = target_path('.smcat')
  46. svg_target = target_path('.svg')
  47. make_dirs(smcat_target)
  48. f = open(smcat_target, 'w')
  49. w = IndentingWriter(f)
  50. def name_to_label(name):
  51. label = name.split('/')[-1]
  52. return label if len(label) else "root"
  53. def name_to_name(name):
  54. return name.replace('/','_')
  55. # Used for drawing initial state
  56. class PseudoState:
  57. @dataclass
  58. class Gen:
  59. full_name: str
  60. def __init__(self, name):
  61. self.gen = PseudoState.Gen(name)
  62. # Used for drawing initial state
  63. class PseudoTransition:
  64. def __init__(self, source, targets):
  65. self.source = source
  66. self.targets = targets
  67. self.guard = None
  68. self.trigger = None
  69. self.actions = []
  70. transitions = []
  71. def write_state(s, hide=False):
  72. if not hide:
  73. w.write(name_to_name(s.gen.full_name))
  74. w.extendWrite(' [label="')
  75. w.extendWrite(name_to_label(s.gen.full_name))
  76. w.extendWrite('"')
  77. if isinstance(s, ParallelState):
  78. w.extendWrite(' type=parallel')
  79. elif isinstance(s, ShallowHistoryState):
  80. w.extendWrite(' type=history')
  81. elif isinstance(s, DeepHistoryState):
  82. w.extendWrite(' type=deephistory')
  83. else:
  84. w.extendWrite(' type=regular')
  85. w.extendWrite(']')
  86. if s.enter or s.exit:
  87. w.extendWrite(' :')
  88. for a in s.enter:
  89. w.write("onentry/ "+a.render())
  90. for a in s.exit:
  91. w.write("onexit/ "+a.render())
  92. w.write()
  93. if s.children:
  94. if not hide:
  95. w.extendWrite(' {')
  96. w.indent()
  97. if s.default_state:
  98. w.write(name_to_name(s.gen.full_name)+'_initial [type=initial],')
  99. transitions.append(PseudoTransition(source=PseudoState(s.gen.full_name+'/initial'), targets=[s.default_state]))
  100. s.children.reverse() # this appears to put orthogonal components in the right order :)
  101. for i, c in enumerate(s.children):
  102. write_state(c)
  103. w.extendWrite(',' if i < len(s.children)-1 else ';')
  104. if not hide:
  105. w.dedent()
  106. w.write('}')
  107. transitions.extend(s.transitions)
  108. write_state(root, hide=True)
  109. ctr = 0
  110. for t in transitions:
  111. label = ""
  112. if t.trigger:
  113. label += t.trigger.render()
  114. if t.guard:
  115. label += ' ['+t.guard.render()+']'
  116. if t.actions:
  117. label += ' '.join(a.render() for a in t.actions)
  118. if len(t.targets) == 1:
  119. w.write(name_to_name(t.source.gen.full_name) + ' -> ' + name_to_name(t.targets[0].gen.full_name))
  120. if label:
  121. w.extendWrite(': '+label)
  122. w.extendWrite(';')
  123. else:
  124. w.write(name_to_name(t.source.gen.full_name) + ' -> ' + ']split'+str(ctr))
  125. if label:
  126. w.extendWrite(': '+label)
  127. w.extendWrite(';')
  128. for tt in t.targets:
  129. w.write(']split'+str(ctr) + ' -> ' + name_to_name(tt.gen.full_name))
  130. w.extendWrite(';')
  131. ctr += 1
  132. f.close()
  133. if args.keep_smcat:
  134. print("Wrote "+smcat_target)
  135. if not args.no_svg:
  136. subprocess.run(["state-machine-cat", smcat_target, "-o", svg_target])
  137. print("Wrote "+svg_target)
  138. if not args.keep_smcat:
  139. os.remove(smcat_target)
  140. except Exception as e:
  141. # import traceback
  142. # traceback.print_exception(type(e), e, None)
  143. print(e,'\n')
  144. pool_size = min(args.pool_size, len(srcs))
  145. with multiprocessing.Pool(processes=pool_size) as pool:
  146. print("Created a pool of %d processes."%pool_size)
  147. pool.map(process, srcs)