msc-generatorでシーケンス図を作成する

複数機器間の通信の手順を可視化したり、仕様として規定する際、「シーケンス図」というものを作成することがあります。

英語では、Message Sequence Chartというそうで、graphvizのようにテキストファイルを入力として、きれいな図を生成してくれるソフトが何種類かあるようです。

今回、SpaceWire関連の仕様書を記述するタスクのために、MSC-Generatorというソフトを利用しました。ドキュメントもしっかり用意されていたり、日本語も扱えたりしてひじょうに心強いです。

Macでの使用に当たってはソースコードからビルドする必要があり、手順が少し難しいところがあったのでまとめておきます。

[tmkm-amazon]9784774143958[/tmkm-amazon]

サンプル

たとえば以下のようなコードからは次のような図が生成されます。

hscale=auto, numbering=yes;
numbering.format = "roman";
a->b: Lowercase roman;
numbering.format = "ABC)";
a->b: Uppercase letters;
numbering.format = "123";
a->b: Arabic numbers;
{
  numbering.append = ".123";
 a->b: Two-level numbers;
   a->b: Set last number [number=5];
};
a->b: Back to one level;
a--b: Alternative #1 {
      numbering.append = "abc";
  a->b: Step N;
     b->a: Step N;
}
a..b: Alternative #2 {
 numbering.append = "abc";
  a->b: Step N;
     b->a: Step N [number=c];
  numbering.format = "roman-roman";
  a->b: Exotic format;
       numbering.format = "roman";
        a->b: Only the last number;
        numbering.format = "123abc";
       a->b: Back to normal;
};a->b: Back to one level;

インストール手順

SorceForgeのサイトからソースコードをダウンロードして展開。msc-generator/というフォルダが生成される。
今回は3.5.18というバージョンを利用しました。
Homebrewで最新のbisonとflexをインストール。
インストール後、
brew link bison --force
としてバージョン2.7のbisonを/usr/local/binにリンクする。
which bison
として、/usr/local/bin/bisonが見えている事を確認。
(システムのデフォルトである/usr/bin/bisonが見えてしまっている場合、.zshrc等にexport PATH=/usr/local/bin:$PATHを追加して、/usr/binよりも先に/usr/local/binが見えるようにする)
Homebrewでgcc4.7をインストール。30分くらいかかるので、コーヒーブレイク。
cd msc-generator
以下を実行して、ylwrapというラッパースクリプトをmsc-generator/直下にコピー(src/内ではないので注意)。
cp /usr/local/share/automake-1.13/ylwrap .
以下の一連のコマンドでconfigureスクリプトを生成する。
aclocal
automake --add-missing
autoconf
./configure CXX=g++-4.7 CC=gcc-4.7 CXXFLAGS=-I/usr/local/include/cairo
として、gccのバージョンを指定しつつMakefileを生成。
(ユーザのローカルな場所にインストールしたい場合は--prefix=$HOME/work/install等を添加)
nano Makefile としてテキストエディタで開き、SUBDIRの行でdocを削除(ドキュメントのコンパイルはしない)。
make -j8
途中、src/commandline.cppの591行目でstd::max()の引数がおかしいというエラーが出るので、
std::vector scale(std::max((unsigned int)1, (unsigned int)oScale.size()), XY(1., 1.));
のようにキャストを追加して修正する。</li>
再度make
今度はsrc/language.hの229行目で、yyparseの重複定義というエラーが出るので、第一引数の方をMscに変更して、
int yyparse (Msc &RESULT, void *yyscanner);
として保存。
再度makeすると通るはず。
make install
インストールディレクトリ($HOME/work/install/bin等)にパスを通せば使えるようになる。
msc-gen (ソースファイル名)
とすると実行され、Successと表示されるとpngが生成されます。

現実的なサンプル

30 Aug 2013

#Uncategorized

« Chandra/HETGの位相分割スペクトル抽出の解析ログ NuSTARのデータ公開 »