タイミングチャート清書サービス のバックアップの現在との差分(No.2)

更新


  • 追加された行はこの色です。
  • 削除された行はこの色です。
[[公開メモ]]
* 設置アドレス [#s578cb5d]

SIZE(20){https://rawgit.com/osamutake/tchart-coffee/master/bin/editor-offline.html}

*** スクリーンイメージ [#vb49705b]
&ref(screenshot.png,nolink,border,66%);

* 概要 [#td75a95f]

[[こちらで紹介したタイミングチャート清書スクリプト>ソフトウェア/tchart.rb]]をオンラインで使えるようにしました。
このようなテキストを入力すると、
 aclk    ~_~_~_~_~_~_~_~_~_~_
 awaddr  ==?X=A1==X=A2X=A3==X==?=X=A4X=?
 awvalid __~~~~~~~~~~____~~__
 awready ____[~~~~]__[~~]____[~~]__
 wdata   ====?X=D1X=D2X=?X=D3X=?X=D4==X=?
 wvalid  ____~~~~__~~__~~~~__
 wready  ____~~~~__~~____~~__
 bresp   ====00================
 bvalid  ____~~~~__~~____~~__
 bready  ~~~~~~~~~~~~~~~~~~1~~

- コードを書けばほぼリアルタイムで清書結果を確認できます
- 清書したタイミングチャートは SVG または PNG 形式でダウンロードできます
こんなタイミングチャートを生成できるサービスです。

>  &ref(screen-capture1.png,,66%);
&tchart(
aclk    ~_~_~_~_~_~_~_~_~_~_
awaddr  ==?X=A1==X=A2X=A3==X==?=X=A4X=?
awvalid __~~~~~~~~~~____~~__
awready ____[~~~~]__[~~]____[~~]__
wdata   ====?X=D1X=D2X=?X=D3X=?X=D4==X=?
wvalid  ____~~~~__~~__~~~~__
wready  ____~~~~__~~____~~__
bresp   ====00================
bvalid  ____~~~~__~~____~~__
bready  ~~~~~~~~~~~~~~~~~~1~~
);

* 設置アドレス [#s578cb5d]
ソースコード編集中に、ほぼリアルタイムで清書結果を確認できるので、試行錯誤しているうちに正しく書けると思います。

こちらです:~
http://dora.bk.tsukuba.ac.jp/~takeuchi/tchart.php
清書したタイミングチャートは SVG または PNG 形式で保存できます。

* ソースコード [#sabe6496]
入力内容がサーバーに送られることはなく、完全にブラウザ上だけで画像を生成していますので、守秘義務の問題も発生しません。心配であればリンク先の html を PC に保存して、そこから立ち上げれば、完全にオフラインの状態でも動作します。

 LANG:php(linenumber)
 <?php 
 
   function generate_svg($source)
   {
     $descriptorspec = array(
        0 => array("pipe", "r"),             // stdin
        1 => array("pipe", "w"),             // stdout
        2 => array("file", "/dev/null", "a") // stderr
     );
     $process = proc_open('/usr/local/bin/tchart.rb', $descriptorspec, $pipes);
 
     if (is_resource($process)) {
       fwrite($pipes[0], $source);
       fclose($pipes[0]);
 
       return stream_get_contents($pipes[1]);
       fclose($pipes[1]);
 
       $return_value = proc_close($process);
     }
     return "";
設置アドレスはこちらです:~
  SIZE(20){https://rawgit.com/osamutake/tchart-coffee/master/bin/editor-offline.html}
~
~
[[>>>> 記述文法についてはこちらをご覧下さい。>https://rawgit.com/osamutake/tchart-coffee/master/doc/syntax.html]]

コメントや質問などがあれば [[GitHub で Issue を上げる>https://github.com/osamutake/tchart-coffee/issues]]、[[このページの一番下の投稿フォームをご利用下さい>#m9652e62]]。

このサービスで使っている javascript コードを既存システムに組み込むことで、
各種 Wiki や Markdown にタイミングチャート記述機能を追加できると思います。
下記 [[組み込み処理系>#e2debc9b]] を参照して下さい。

** WaveDrom : 似たようなコンセプトで、より凝ったチャートを書けるツールもあるようです [#s714eccc]

http://wavedrom.com/

&ref(wavedrom1.png,,50%);

チュートリアルはこちら:~
http://wavedrom.com/tutorial.html

** IE での不具合 [#a0ceca1d]

下記リンク先で議論されている問題のため、[Save as PNG] および [Generate Images for Copy] 
のボタンが IE では正常に働きません。~
https://connect.microsoft.com/IE/feedback/details/809823/draw-svg-image-on-canvas-context

代わりに、SVG 画像上で右クリックから [名前を付けて画像を保存] で形式を PNG にすれば保存できます。

同様に右クリックから [コピー] で画像をクリップボードへ入れられるので、
Word などへ貼り付ける用途ではむしろ IE の方が便利かもしれません。

** IE 以外でクリップボードへのコピーの仕方 [#m4d46332]

セキュリティ上の制限のため、javascript からクリップボードへ
自動的にコピーすることはできないようになっています。
そこで、手動で対応していただく必要があります。

[Generate Images for Copy] ボタンを押すと SVG ソースと PNG 画像が生成されます
- SVG ソースをご入り用であれば、SVG ソースにフォーカスが当たっている状況でそのまま Ctrl+C すればコピー可能です
- PNG 画像がご入り用であれば、PNG 画像上で右クリックから [画像をコピー] します
-- なぜか空の HTML も一緒にコピーされてしまうようで、なおかつこの空の HTML 
が優先的に貼り付けられるようなので、Word などへ貼り付ける際には 
[形式を選択して貼り付け]-[ビットマップ(DIB)] などとして下さい(Office でのショートカットは Alt+E,S です)
-- 上記の制限のため IE では [Generate Images for Copy] で PNG 画像が生成されません
-- 代わりに SVG 画像上の右クリックから [コピー] でコピーできますので、そちらをご利用下さい

* 謝辞 [#j084c7a9]

熊谷正朗さんの "Timing chart formatter by kumagai" ~
http://www.mech.tohoku-gakuin.ac.jp/rde/contents/library/tchart/indexframe.html

を大いに参考にさせていただきました。

記述文法はほぼ熊谷さんの tchart を踏襲しています。

大変有用なツールをご提供くださったことに感謝いたします。

* 記述文法 [#g7420e8f]

[[こちらをご覧下さい。>https://rawgit.com/osamutake/tchart-coffee/master/doc/syntax.html]]

* ソースコード [#sc7a574d]

GitHub に上がっています:https://github.com/osamutake/tchart-coffee

npm でも利用可能です:https://www.npmjs.com/package/tchart-coffee

* 組み込み処理系 [#e2debc9b]

このサービスで作成した svg を手で切り貼りして html に埋め込む代わりに、
html 中に以下のように直接タイミング図定義を書いておいて、
javascript で svg に変換して表示した方が、
あとから修正することなどを考えると便利です。

チャートを表示したい部分に次のように記述しておいて、

 LANG:html
 <script type="text/tchart">
 aclk    ~_~_~_~_~_~_~_~_~_~_
 awaddr  ==?X=A1==X=A2X=A3==X==?=X=A4X=?
 awvalid __~~~~~~~~~~____~~__
 awready ____[~~~~]__[~~]____[~~]__
 wdata   ====?X=D1X=D2X=?X=D3X=?X=D4==X=?
 wvalid  ____~~~~__~~__~~~~__
 wready  ____~~~~__~~____~~__
 bresp   ====00================
 bvalid  ____~~~~__~~____~~__
 bready  ~~~~~~~~~~~~~~~~~~1~~
 </script>

~</body> の直後に次のコードを置きます。

 LANG:html
 <script src='https://cdn.rawgit.com/osamutake/tchart-coffee/v1.1.1/lib/tchart.min.js'></script>
 <script>
 (function(){
   var codes = document.getElementsByTagName('script');
   for (var i = codes.length-1; i >= 0; i--){
     var code = codes[i];
     if(code.getAttribute('type')!=='text/tchart')
       continue;
     var svg = TimingChart.format(code.textContent);
     var div = document.createElement('div');
     div.className = 'tchart';
     div.innerHTML = svg;
     code.parentNode.replaceChild(div, code);
   }
 
   function bad_referer()
   {
     $referer = $_SERVER["HTTP_REFERER"];
     $url = parse_url($referer);
     return $url['host'] != $_SERVER["SERVER_NAME"];
   }
 
   if(@$_POST['source'] && @$_POST['format']=='svg'){
     if(bad_referer()) exit;
 
 #    header('Content-type: image/svg+xml');
     header('Content-Type: application/force-download');
     header('Content-Disposition: attachment; filename="tchart.svg"');
     echo generate_svg($_POST['source']);
     exit;
   }
 
   if(@$_POST['source'] && @$_POST['format']=='png'){
     if(bad_referer()) exit;
 
     $svg = generate_svg($_POST['source']);
 
     $tempname = tempnam('/tmp', 'tchart');
     $svgname = $tempname . '.svg';
     $pngname = $tempname . '.png';
 
     $svgfile = fopen($svgname, 'w');
     fwrite($svgfile, $svg);
     fclose($svgfile);
     system("/usr/bin/convert ${svgname} ${pngname}");
     unlink($svgname);
 
 #    header("Content-Type: image/png");
     header('Content-Type: application/force-download');
     header('Content-Disposition: attachment; filename="tchart.png"');
     readfile($pngname);
     unlink($pngname);
     exit;
 
 #    下記はなぜかうまく動かない
 #    $im = new Imagick();
 #    $im->readImageBlob($svg, 'tchart.svg');
 #    $im->setImageFormat("png24");
 #    header("Content-Type: image/png");
 #    header('Content-Disposition: attachment; filename="tchart.png"');
 #    echo $im;
 #    exit;
   }
 ?>
 
 <!DOCTYPE html>
 <html>
   <head>
     <meta http-equiv="X-UA-Compatible" content="IE=edge">
     <title>Timing chart formatter</title>
     <meta charset="utf-8">
     <meta name="description" content="Timing chart formatter">
     <meta name="author" content="Osamu Takeuchi &lt;osamu@big.jp&gt;">
     <meta name="viewport" content="width=device-width, initial-scale=1">
     <!-- link rel="stylesheet" href="" -->
     <!--&#91;if lt IE 9&#93;>
     <script src="//cdn.jsdelivr.net/html5shiv/3.7.2/html5shiv.min.js"></script>
     <script src="//cdnjs.cloudflare.com/ajax/libs/respond.js/1.4.2/respond.min.js"></script>
     <!&#91;endif&#93;-->
     <!-- link rel="shortcut icon" href="" -->
   </head>
   <body>
     <script src="//ajax.googleapis.com/ajax/libs/jquery/1.11.1/jquery.min.js"></script>
 
     <h1>Timing chart formatter</h1>
 
     <h2>Source Code</h2>
 
     <a href="http://dora.bk.tsukuba.ac.jp/~takeuchi/?%E3%82%BD%E3%83%95%E3%83%88%E3%82%A6%E3%82%A7%E3%82%A2%2Ftchart.rb">View sytax of the source text.</a><br>
     <br>
 
     <form name="form" method="post" target="_blank">
     <input type="hidden" name="format" id="format" value="svg" />
     <textarea id="source" name="source" cols="120" rows="20"># comment
 clock	_~_~_~_~_~_~_~_~_~_~_
 data	=?====X=DATA========X=?====
 valid	_____~~~~~~~~~~______
 ready	_____________[~~]______
 </textarea>
     </form>
     <input type="button" id="reload" value="Reload">
     <span id="indicator"></span><br />
 
     <h2>Result</h2>
     <input type="button" id="as_svg" value="Download as svg" />
     <input type="button" id="as_png" value="Download as png" /><br />
     <div id="result"></div>
   </body>
 
 })();
 </script>

似たような方法を使えば、Wiki や Blog をカスタマイズして、
タイミング図の表示機能を付けるようなことも簡単にできると思います。
Markdown なら[[こうでしょうか>#y9c3ed0a]]。

ちなみにこのサイト自身、[[タイミングチャートを処理するプラグイン>ソフトウェア/pukiwiki/tchart.inc.php]] を導入した pukiwiki で書いているため、
記事の中で自然にタイミング図を記述できています。

** 実行例 [#e2ad9fe5]

実行例はこちらをご覧下さい:~
http://jsbin.com/naxidurome/edit?html,output
** Markdown に組み込む [#y9c3ed0a]

Markdown に組み込む場合、

 ```tchart2svg
 clock  _~_~_~_~_~
 signal ___~~~~___
 ```

と書いた物が

 LANG:html
 <pre><code class="lang-tchart2svg">
 clock  _~_~_~_~_~
 signal ___~~~~___
 </code></pre>

と変換される処理系であれば、

 LANG:html
 <script src='https://cdn.rawgit.com/osamutake/tchart-coffee/v1.1.1/lib/tchart.min.js'></script>
 <script>
 
 $(function(){
 
   var reload = function(source) {
     if (source != "") {
       $("#indicator").html("*");
       $.post("tchart.php", {
           "source": source,
           "format": "svg"
         }, 
         function(data, status) {
           if (status=="success") {
             $("#result").html(data);
           } else {
             $("#result").html(status);
           }
           $("#indicator").html("");
         },
         "text"
       );
     }
 (function(){
   var codes = document.getElementsByClassName('lang-tchart2svg');
   for (var i = codes.length-1; i >= 0; i--){
     var code = codes[i];
     var svg = TimingChart.format(code.textContent);
     var div = document.createElement('div');
     div.className = 'tchart';
     div.innerHTML = svg;
     var pre = code.parentNode
     pre.parentNode.replaceChild(div, pre);
   }
 
   $('#reload').on('click', function(e){
     source = $("#source").val();
     reload(source);
   });
 
   var lastSource = '';
   setInterval(function(){
     source = $("#source").val();
     if (source!=lastSource)
       reload(source);
     lastSource = source;
   },1000);
 
   $('#as_svg').on('click', function(e){
     $('#format').val('svg');
     document.form.submit();
   });
 
   $('#as_png').on('click', function(e){
     $('#format').val('png');
     document.form.submit();
   });
 
 });
 
 })();
 </script>
 
 </html>

をレイアウトファイルの </body> の直後に組み込めば、自然な文法でタイミングチャートを記述できるようになります。

実行例:~
http://jsbin.com/wicuvabalu/edit?html,output

** 注意点 [#u566db26]

tchart.min.js を取り込む際、

https://cdn.rawgit.com/osamutake/tchart-coffee/v1.1.1/lib/tchart.min.js

ではなく

https://cdn.rawgit.com/osamutake/tchart-coffee/master/lib/tchart.min.js

としておけば常に最新版を使えて便利!

と思いそうになるのですが、cdn.rawgit.com のサービスは github.com 
の内容をキャッシュするもので、URL と内容とが一対一に対応するため、
/master/ で読まれる内容はキャッシュがタイムアウトしない限り
新しいコミットがあっても更新されることはありません。

https://rawgit.com/ にも書かれているとおり、

>Use a specific tag or commit hash in the URL (not a branch). Files are cached permanently based on the URL.

cdn.rawgit.com からの読み込みは必ず tag 名あるいはコミット ID で行うようにして下さい。

* コメント・質問 [#m9652e62]

バグ報告や改善要望などは、可能であれば [[GitHub で Issue を上げていただけると>https://github.com/osamutake/tchart-coffee/issues]]捗ります。よく分からなければ下記へご記入いただいて構いません。

#article_kcaptcha
**矢印付きの立ち上がりエッジ、立ち下がりエッジ [#k629795c]
>[[かとう]] (&timetag(2019-08-06T15:04:30+09:00, 2019-08-07 (水) 00:04:30);)~
~
もう一つ、お願いがあります。~
立ち上がりエッジ、立ち下がりエッジの時に、矢印を追加するオプションを追加できないでしょうか?~
こんな感じの矢印です。~
https://synapse.kyoto/glossary/dff/png/fig004_mag.png~
https://synapse.kyoto/glossary/dff/png/fig006_mag.png~
https://image.itmedia.co.jp/mn/articles/0805/22/ay_drill2_18_fig02.gif~
https://image.itmedia.co.jp/mn/articles/0805/22/ay_dr2_18_mon01.gif~
~
指定の方法は~
_^~ で矢印付きの立ち上がりエッジ~
~v_ で矢印付きの立ち下がりエッジ~
という方法はどうでしょうか?~

//
- ああ、URLが画像展開されてしまうんですね。すみません。目障りでしたらURLを削ってください。それと「矢印付きの立ち下がりエッジ」は「~v_」です。なぜか先頭の ~ が消えてしまいました。 -- [[かとう]] &new{2019-08-07 (水) 00:08:28};

#comment_kcaptcha

**png 保存できません [#s69a6f10]
>[[かとう]] (&timetag(2019-08-06T06:48:14+09:00, 2019-08-06 (火) 15:48:14);)~
~
たびたびすみません。~
~
仕様なのかもしれませんが、信号名や文字列に日本語(非ASCII文字)が一文字でもあると、svg 保存はできますが、png 保存や Generate Images for Copy が効かない様です。~
ASCII のみなら、問題なく png 保存できます。~
小生の使用環境は Windows7 home SP1, Google Chrome v.76.0.3809.87 です。~
~
※"enable"だとはみ出すので"有効"に変更したら、とたんにpng保存できなくなってしまい、ちょっと悩んでしまいました。~

//
- ご指摘ありがとうございます。http://js.studio-kingdom.com/javascript/window/btoa#unicode_strings こちらで解説されているようにUnicode文字列のwindow.btoa()の呼び出しで、 文字範囲外(Character Out Of Range)の例外が発生してしまっていることを確認しました。リンク先で解決策も提示されていますので、後ほど修正いたします。 -- [[武内(管理人)]] &new{2019-08-06 (火) 17:03:38};
- すみません、追加です。信号中に埋め込む文字列の方のみ "~" で括った時に空白文字(0x20)があると、png 保存できないようです(svg 保存はできます)。信号名の方は空白文字があっても問題ありません。 -- [[かとう]] &new{2019-08-06 (火) 21:08:55};
- 何となくわかりました。多分ですが、信号中に埋め込む文字列の方のみ、空白文字(0x20)が NBSP(0xA0)に変換されるので非ASCII文字になってしまい、日本語の時と同様に「文字範囲外エラー」になっているのだと思われます。 -- [[かとう]] &new{2019-08-06 (火) 21:53:24};

#comment_kcaptcha

**信号名や文字列に上線(upper bar)をつけたい [#u810ea60]
>[[かとう]] (&timetag(2019-08-04T15:22:48+09:00, 2019-08-05 (月) 00:22:48);)~
~
負論理の時の信号名や文字列に上線をつけたいのですが~
どの様にすればよろしいのでしょうか?~

//
- すみません、表示上だけ何とかしたければ、text-decoration="overline" を使って~
@caption_font text-decoration="overline"~
clock  _~_~_~_~_~_~_~_~_~_~_ ~
@caption_font text-decoration=""~
などとする手はありますが、現状では信号名に上線を付ける標準的な機能はありません。もし対応するとしたらどういう文法にするのが自然でしょうね・・・-- [[武内(管理人)]] &new{2019-08-05 (月) 08:01:31};
- ご返答ありがとうございます。 @caption_font, @signal_font で上線が付けられました。 ただ、毎回毎回、この方法だと記述が大変かな、という気もしました。 小生が使用している回路図エディタ BSch3V では、\R\E\S と書くと RES に上線が付いて表示されます。 同様な考えで !R!E!S で一文字一文字に上線が付くようにする、という方法はどうでしょうか? これなら上線を付けたい文字の直前だけに ! を追加するだけで済むので @caption_font, @signal_font よりは記述が楽かな、と思います。 あるいは ! が現れるたびに text-decoration="overline" と text-decoration="" をトグルする、という方法でも良いかもしれません。 -- [[かとう]] &new{2019-08-06 (火) 14:39:17};
- その文字を文字通りの記号として使うことがあり得ない、と確信できる記法にしたいですね。! は使う可能性があるようにも思うので、採用するなら \R\E\S の方でしょうか。WaveDrom だと <o>RES</o> のようですが、これはちょっと違いそう。ちょっと考えさせて下さい。 -- [[武内(管理人)]] &new{2019-08-06 (火) 15:03:13};
- \ ですと不定値部分の指定に使っている様ですので、(信号名の方は大丈夫だと思うのですが)信号中に埋め込む文字列の方で使えないのでは?と考えて、! にしました。! がまずければ、全角文字の ̄や¬(否定)などは、どうでしょうか? -- [[かとう]] &new{2019-08-06 (火) 15:59:17};
- すみません、¬記号はダメですね。Unix系や外国の Windows ですと U+00AC の方が入力されるのでしょうが、日本語Windows の IME ですと U+FFE2 の方が入力されてしまい、混乱してしまいますね… -- [[かとう]] &new{2019-08-06 (火) 16:13:03};
- 確かに信号中に埋め込む文字列ではそのままの \ は使えませんね。その場合には " " か ' ' で囲んでもらうということではどうでしょう?全角の ̄よりは良いような??? -- [[武内(管理人)]] &new{2019-08-06 (火) 17:07:57};

#comment_kcaptcha

**信号名の文字数について [#d2ba024e]
>[[そうたろう]] (&timetag(2019-04-11T01:56:08+09:00, 2019-04-11 (木) 10:56:08);)~
~
はじめまして。~
タイミングチャート清書サービスのご提供ありがとうございます。~
使い始めたばかりなのですがすごい便利でこれから使っていこうと思っています。~
~
本題の信号名の文字数についてですが、~
信号名の文字数が長いと、出力されるタイミングチャートに信号名が入りきらないのですが、修正をしていただけますでしょうか。~
~
動作環境は下記になります。~
  OS      :windows10
  ブラウザ:Google Chrome(73.0.3683.86)
~
よろしくお願いいたします。~

//
- 信号名の幅を見て自動的に幅を調整する機能はないのですが、[[w_caption>https://rawgit.com/osamutake/tchart-coffee/master/doc/syntax.html#1-3-3]] を指定することで信号名称部分の幅を広げることは可能ですので、手動で調整していただけますでしょうか。そのような意味で合っているでしょうか? -- [[武内(管理人)]] &new{2019-04-11 (木) 11:03:09};
- 早急なご回答ありがとうございます。ご回答いただいたことがまさにやりたかったことです!文法説明をちゃんと読んでおらず、お手数おかけしてすみませんでした。これから末永く利用させていただきたいと思います。 -- [[そうたろう]] &new{2019-04-11 (木) 15:48:56};

#comment_kcaptcha

**仕様かもしれませんが [#jd99ae7a]
>[[通りすがりで大丈夫ですか?]] (&timetag(2019-02-21T07:37:50+09:00, 2019-02-21 (木) 16:37:50);)~
~
こんにちは~
タイミングチャート清書サービスを便利に利用させてもらっています。~
その中で気になった点をお知らせいたします。~
タイミング定義中に記述できる文字列に半角スペースがあると~
エディター上は問題ないように見えますが、~
SVGで保存した後、正しく表示できません。~
半角スペースのエスケープに問題があるようです。~

//
- コメントありがとうございます。全角スペースではなく半角スペースですよね・・・すみません、私が何か見落としているようでうまく再現できませんでした。お手数ですが、簡単な例を教えていただけませんでしょうか?試しに https://rawgit.com/osamutake/tchart-coffee/master/bin/editor-offline.html で表示される初期データの "DATA" を "D A T A" としてみましたが、問題ないように見えました。 -- [[武内(管理人)]] &new{2019-02-21 (木) 17:05:11};

#comment_kcaptcha


Counter: 45822 (from 2010/06/03), today: 6, yesterday: 21