description

   1 Boost Statechart Viewer\r
   2 =======================\r
   3 \r
   4 This clang plugin can visualize simple state machines implemented with\r
   5 Boost Statechart library. It is able to visualize states (except for\r
   6 orthogonal states) and transitions. The examples folder contains some\r
   7 source code of state machines that can be visualized using this tool.\r
   8 \r
   9 The input file for the tool is the source code of the state machine.\r
  10 On the command line you need to specify all source locations for\r
  11 finding header files in the same way as you do for normal compilation\r
  12 (e.g. -I options for include files). As this is plugin for compiler\r
  13 the program line works the same as normal compiler. The output format\r
  14 is dot (part of Graphvis project) and the output file can be\r
  15 transformed into the picture using classic dot commands.\r
  16 \r
  17 Example of command line invocation:\r
  18 \r
  19     clang++ -Xclang -load -Xclang visualizer.so -Xclang -plugin -Xclang visualize-statechart -c file.cpp\r
  20 \r
  21 For compiling and running the plugin you need to have LLVM and clang\r
  22 installed. The program should work with packages distributed with\r
  23 common Linux distributions or you can download LLVM and clang from\r
  24 repositories and compile it.\r