HCP Viewer(Ver 1.2.0) User s Manual 杉 浦 学 gackt@crew.sfc.keio.ac.jp 慶 應 義 塾 大 学 大 岩 研 究 室 (CreW Project) 2004.04.14 目 次 1 準 備 編 2 1.1 実 行 環 境......................................... 2 1.1.1 ハードウェアと OS の 要 件........................... 2 1.1.2 JDK の 準 備................................... 2 1.2 HCP Viewer のインストール.............................. 3 1.2.1 Windows の 場 合................................ 3 1.2.2 その 他 の OS の 場 合............................... 4 2 実 践 編 5 2.1 ソースの 作 成...................................... 5 2.1.1 インデント................................... 5 2.1.2 コメント..................................... 6 2.1.3 コマンド..................................... 7 2.2 アプリケーションの 概 観 と 機 能 の 概 要......................... 14 2.3 チャートの 閲 覧..................................... 15 2.3.1 ソースの 読 み 込 み................................ 15 2.3.2 再 読 み 込 み................................... 15 2.3.3 表 示 するモジュールの 切 り 替 え........................ 15 2.3.4 デバッグコンソールの 利 用........................... 15 2.4 チャートの 印 刷..................................... 16 2.5 清 書 したチャートの 保 存................................ 16 3 応 用 編 17 3.1 コマンドラインツール................................. 17 3.1.1 パスの 設 定................................... 17 3.1.2 ツールの 解 説.................................. 17 3.2 コマンドのカスタマイズ................................ 21 A コマンド 速 見 表 22 1
Over View この 文 書 は HCP Viewer(Ver 1.2.0) の 使 用 説 明 書 です. アプリケーションの 概 要 HCP Viewer は,インデントしたテキストをコンパイルし,HCP チャートとして 清 書 した 結 果 を 閲 覧 するためのアプリケーションです. 清 書 したチャートは,SVG,PNG,EPS 等 のイメージ ファイルとして 保 存 することができます( 図 1). 図 1: HCP Viewer を 利 用 した HCP チャートの 作 成 インデントしたテキストをコンパイルするという 方 式 を 採 用 することで,GUI によるペイント ソフトでありがちなマウスによる 編 集 の 手 間 を 省 き,スピーディーに HCP チャートを 作 成 できる のが,HCP Viewer の 最 大 の 特 徴 です. また,ソースに で 始 まるコマンドを 記 述 するだけで 振 り 分 け 処 理 や 繰 り 返 し 処 理 等 の 記 号 の 描 画 を 行 うことができます.モジュール 分 割 をしたチャートの 作 成 にも 対 応 しており, 1 つのソースに 複 数 のモジュールを 記 述 することができます. 現 行 の Ver1.2.0 ではデータの 記 述 はサポートしていませんが, 将 来 的 にはデータの 記 述 もサポー トする 予 定 です. マニュアルの 構 成 このマニュアルは 3 章 で 構 成 されていて, 各 章 の 内 容 は 以 下 のようになっています. 一 般 的 な 使 用 方 法 を 想 定 していれば,2 章 までの 内 容 を 読 めば 十 分 です. 3 章 は HCP Viewer を 使 用 して,( 教 材 等 の) 本 格 的 なドキュメント 作 成 を 行 う 場 合 に 有 益 な 情 報 を 掲 載 しました. 付 録 にはコマンドの 一 覧 表 をまとめたものを 掲 載 しました. 第 1 章 準 備 編 HCP Viewer を 使 用 するために 必 要 な 環 境 について 第 2 章 実 践 編 HCP Viewer を 使 用 したチャート 作 成 の 基 本 について 第 3 章 応 用 編 HCP Viewer の 発 展 的 な 機 能 とカスタマイズについて 付 録 A コマンドの 速 見 表 1
1 準 備 編 1.1 実 行 環 境 1.1.1 ハードウェアと OS の 要 件 HCP Viewer は, 以 下 の 要 件 を 満 たすハードウェアで 実 行 することを 推 奨 します. CPU 1GHz 以 上 を 推 奨 メモリ 256MB 以 上 を 推 奨 HD 8MB 以 上 の 空 き 容 量 がインストール 時 に 必 要 OS は 以 下 に 示 す,JDK 1.4 以 上 が 導 入 可 能 なものが 必 要 です. OS JDK 1.4 以 上 が 動 作 する OS Solaris (SPARC and x86) Sun Java Desktop System Windows 2000 Windows XP Windows Server Red Hat Enterprise Linux Mac OS 1.1.2 JDK の 準 備 HCP Viewer を 実 行 するためには,JDK 1.4 以 上 がインストールされていることが 必 要 です. JDK のインストールが 済 んでいない 場 合 は,ダウンロードとインストールを 済 ませておいてくだ さい. ダウンロード http://java.sun.com/j2ee/1.4/download.html(sun Microsystems) インストール 方 法 http://nautilus.crew.sfc.keio.ac.jp/lecture/2004objprog/jdk install.html 2
1.2 HCP Viewer のインストール 1.1 節 の 環 境 が 整 ったら, http://www.crew.sfc.keio.ac.jp/projects/hcpviewer/から, 各 自 の OS に 適 合 した Installer をダウンロードし,インストールを 行 ってください. 1.2.1 節 にて,Windows ユーザを 対 象 に,インストール 手 順 の 詳 細 を 解 説 します. 1.2.1 Windows の 場 合 (1) Installer のダウンロード http://www.crew.sfc.keio.ac.jp/projects/hcpviewer/install.htm から Windows 用 の Installer を ダウンロードします. 上 記 のページにある, Start Installer for Windows... のボタンをクリックするか,ページ 中 央 にある,Available Installers から,Windows 用 の Installer をダウンロードして 任 意 の 場 所 に 保 存 してください. 図 2: HCP Viewer の Web ページ (2) インストール ダウンロードした HCP Viewer 1.2.0.exe をダブルクリックして Installer を 起 動 します. Start Installer for Windows... のボタンをクリックした 場 合 は, 自 動 的 に Installer が 起 動 します. 画 面 に 表 示 されるウィザードに 従 って,インストールを 行 ってください. 通 常 はデフォルトの 設 定 を 使 用 してください.その 場 合, 全 てのウィザードで NEXT ボタンをクリックするだけで インストールが 完 了 します. アンインストールは, スタート コントロールパネル プログラムの 追 加 と 削 除 から 行 ってください.アンインストールウィザードにより,アンインストールを 行 うことができます. 3
(3) パスの 設 定 第 3 章 応 用 編 に 書 かれているコマンドを 実 行 するためには,パスの 設 定 が 必 要 になります. コマンドラインからのツール 実 行 を 行 わない 場 合,この 設 定 は 必 要 ありません. スタート コントロールパネル システム( 詳 細 設 定 タブをクリック) 環 境 変 数 ボタンをクリックして,パスの 設 定 を 行 ってください. 必 要 な 設 定 は 以 下 の 2 項 目 です. 1. HCP VIEWER HOME を 新 規 作 成 する (a) 変 数 名 :HCP VIEWER HOME (b) 変 数 値 :HCP Viewer をインストールしたディレクトリのパス(デフォルトは, C: Program Files HCP Viewer 1.2.0 ) 2. PATH に%HCP VIEWER HOME% bin を 追 加 する 設 定 が 終 了 したら,コマンドプロンプトを 起 動 し,hcp というコマンドを 入 力 します.HCP Viewer が 起 動 すれば, 設 定 が 正 常 に 終 了 したことになります. (4) インストールの 確 認 とアプリケーションの 起 動 インストールが 終 了 すると,スタートメニューに HCP Viewer の 起 動 アイコンが 追 加 されます ( スタート すべてのプログラム HCP Viewer 1.2.0 HCP Viewer 1.2.0 ). アイコンと 共 に 表 示 されている, HCP Viewer 1.2.0 をクリックすると,アプリケーションが 起 動 します. このマニュアルへのリンクも マニュアル として 作 成 されていることを 確 認 してください. 1.2.2 その 他 の OS の 場 合 お 使 いの OS に 適 合 した Installer をダウンロードし, 適 宜 インストールを 行 ってください. 説 明 は 割 愛 します. 4
2 実 践 編 2.1 ソースの 作 成 チャートのソースは, 普 段 使 い 慣 れているテキストエディタを 使 用 するなどして 作 成 してくだ さい. 保 存 するソースファイルの 拡 張 子 に 制 限 はありませんが,.hcp などの 分 かりやすい 名 前 にして 保 存 1 することをお 勧 めします. 2.1.1 インデント 項 目 の 前 にタブやスペースを 挿 入 してソースをインデントすることで,チャートの 階 層 構 造 を 表 現 することができます.インデントしたソース(リスト 1)と,その 表 示 結 果 ( 図 3)を 示 します. リスト 1: 段 下 げを 行 ったソース 処 理 前 処 理 本 処 理 後 処 理 図 3: 段 下 げを 行 ったソースの 表 示 結 果 1 これは, 第 3 章 で 紹 介 する, 一 括 変 換 コマンドを 利 用 する 際 に 必 要 になる 事 柄 です 5
2.1.2 コメント コメントアウトしたいソースの 一 行 目 に # を 挿 入 すると,その 行 全 体 がコメントとして 扱 わ れます. リスト 2: コメントアウトを 行 ったソース 処 理 前 処 理 本 処 理 # 後 処 理 図 4: コメントアウトを 行 ったソースの 表 示 結 果 6
2.1.3 コマンド で 表 現 される 項 目 以 外 を 表 現 したり,モジュール 分 割 を 行 う 場 合 はソースにコマンドを 記 述 します. コマンドは 半 角 の の 後 にコマンド 名 を 記 述 し, 半 角 のスペースを 空 けて, 内 容 を 記 述 する という 書 式 (リスト 3 ) です. ただし, 内 容 の 記 述 が 不 要 なコマンドも 存 在 します. リスト 3: コマンドの 書 式 コマンド 名 内 容 コマンドは 以 下 の 3 種 類 に 大 別 することができます. 次 からそれぞれのコマンドの 詳 細 を 解 説 し ます. ヘッダーコマンド チャートのヘッダーを 記 述 するためのコマンド モジュールコマンド チャートをモジュール 分 割 するためのコマンド 通 常 コマンド チャート 中 の 記 号 を 表 現 するためのコマンド 7
(1) ヘッダーコマンド ソースにチャートのタイトル, 作 成 した 人 などのヘッダー 情 報 を 付 けることができます. チャートのソース 本 体 の 前 に, 表 1に 示 すヘッダーコマンドを 記 述 してください. 記 述 する 順 番 は 問 いません.コマンドを 記 述 しない 場 合, 内 容 が 空 のヘッダーが 付 与 されます. 表 1: ヘッダーコマンド 一 覧 コマンド 内 容 title タイトル author 作 成 者 date 作 成 日 version バージョン 情 報 リスト 4: ヘッダーコマンドを 記 述 したソース title はじめての HCP チャート author 杉 浦 学 date 2004.04.12 version 1.0 処 理 前 処 理 本 処 理 後 処 理 図 5: ヘッダーコマンドを 記 述 したソースの 表 示 結 果 8
(2) モジュールコマンド モジュールの 開 始 位 置 に module モジュール 名 というコマンドを 書 くことで,1 つのファ イルで 複 数 のモジュールを 表 現 し, 各 モジュールをタブで 分 割 して 閲 覧 することができます. このモジュール 名 は 自 動 的 にヘッダーにも 記 述 されます. なお, 他 のモジュールを 呼 び 出 す 二 重 丸 の 項 目 を 記 述 する 場 合, mod 呼 び 出 しモジュール 名 で 記 述 します. 表 2: モジュールコマンド 一 覧 コマンド 内 容 module モジュール 分 割 位 置 の 指 定 mod モジュール 呼 び 出 し 項 目 モジュールコマンドを 使 用 したソースをリスト 5に,その 表 示 結 果 を 図 6と 図 7に 示 します. 9
リスト 5: モジュールコマンドを 記 述 したソース title 自 動 販 売 機 アプリケーション author 杉 浦 学 date 2004.04.12 version 1.0 module main 商 品 ( 缶 ジュース)の 販 売 と 管 理 を 行 う 自 動 販 売 機 アプリケーションの 開 始 を 知 らせる mod 商 品 を 販 売 する 自 動 販 売 機 アプリケーションの 終 了 を 知 らせる module sell 商 品 を 販 売 する 購 入 したい 商 品 の 入 力 を 受 け 取 る 選 択 された 商 品 を 排 出 する 図 6: モジュールコマンドを 記 述 したソースを 表 示 結 果 (main モジュール) 図 7: モジュールコマンドを 記 述 したソースを 表 示 結 果 (sell モジュール) 10
(3) 通 常 コマンド チャート 中 の 記 号 を 表 現 するためのコマンドの 一 覧 と, 良 く 使 用 される 組 み 合 わせ 例 を 示 します. 表 3: 通 常 コマンド 一 覧 コマンド 内 容 表 示 形 態 repeat 繰 り 返 し 処 理 fork branch return 振 り 分 け 処 理 分 岐 条 件 脱 出 ec エラーチェック 処 理 ex エラー 出 口 return 数 字 で 脱 出 する 階 層 数 を 指 定 することもできます. 11
(i) 振 り 分 け 処 理 と 条 件 の 記 述 例 振 り 分 け 処 理 と 条 件 を 記 述 したソース 例 とその 表 示 結 果 を 示 します. リスト 6: 振 り 分 け 処 理 と 条 件 を 記 述 したソース title 振 り 分 け 処 理 の 記 述 例 author 杉 浦 学 date 2004.04.12 version 1.0 module main 処 理 fork 振 り 分 け 処 理 branch 条 件 その 1 条 件 その 1 が 真 だったときの 処 理 branch 条 件 その 2 条 件 その 3 が 真 だったときの 処 理 branch 条 件 その 3 条 件 その 2 が 真 だったときの 処 理 図 8: 振 り 分 け 処 理 と 条 件 を 記 述 したソースの 表 示 結 果 12
(ii) 繰 り 返 し 処 理 と 脱 出 の 記 述 例 繰 り 返 し 処 理 と 脱 出 を 記 述 したソース 例 とその 表 示 結 果 を 示 します. リスト 7: 繰 り 返 し 処 理 と 脱 出 を 記 述 したソース title 繰 り 返 し 処 理 と 脱 出 author 杉 浦 学 date 2004.04.12 version 1.0 module main 処 理 repeat 繰 り 返 し 処 理 fork 終 了 条 件 の 確 認 branch 終 了 条 件 return 処 理 図 9: 繰 り 返 し 処 理 と 脱 出 を 記 述 したソースの 表 示 結 果 13
2.2 アプリケーションの 概 観 と 機 能 の 概 要 図 10にアプリケーションの 概 観 と,それぞれがどのような 機 能 を 果 たすかを 示 します. 図 10: アプリケーションの 概 観 メニュー File ソースファイルの( 再 ) 読 み 込 みと 保 存, 印 刷,アプリケーションの 終 了 を 行 います Option デバックコンソールの 表 示 非 表 示 を 切 り 替 えます Help HCP Viewer のクレジットを 表 示 します 表 示 モジュール 切 り 替 えタブ クリックすると, 表 示 するモジュールを 切 り 替 えることが できます チャート 表 示 部 分 清 書 されたチャートが 表 示 される 部 分 です デバックコンソール ソースファイルのコンパイルエラーを 表 示 します 14
2.3 チャートの 閲 覧 作 成 したチャートのソースを 清 書 した 結 果 を 閲 覧 するための 方 法 を 解 説 します. 2.3.1 ソースの 読 み 込 み 作 成 したチャートのソースを 読 み 込 むには, File Open から 表 示 したいソースファイルを 選 択 するか, 起 動 しているアプリケーションにソースファイルをドラッグアンドドロップします. 2.3.2 再 読 み 込 み チャートのソースを 編 集 した 場 合,ソースファイルの 再 読 み 込 みを 行 うことができます. File Reload を 選 択 するか,ショートカットキーである F5 をタイプしてください. 2.3.3 表 示 するモジュールの 切 り 替 え 複 数 のモジュールからなるソースを 読 み 込 んだ 場 合,メニューバーの 下 方 のタブをクリックする ことで 表 示 するモジュールを 切 り 替 えることができます. 2.3.4 デバッグコンソールの 利 用 表 示 するソースを 読 み 込 んだ 際 のコンパイルエラーを 表 示 することができます. Option Debug Console にチェックを 入 れると,アプリケーションのウィンドウの 下 方 に Debug Console を 表 示 (デフォルトは OFF)することができます.チェックをはずすと 非 表 示 になります. コンソールに 表 示 されている 内 容 をクリアーしたい 場 合 は, 右 にある 消 しゴムのボタンを 押 して ください. 図 11: デバッグコンソール 15
2.4 チャートの 印 刷 清 書 されたチャートの 表 示 結 果 を 印 刷 したい 場 合 は, File Print を 選 択 してください. 印 刷 用 のプリンタを 選 択 するウィンドウが 表 示 されます. なお, 印 刷 されるチャートは,タブで 選 択 されて 表 示 されているモジュールのみになります. 2.5 清 書 したチャートの 保 存 チャートの 表 示 結 果 を SVG 形 式 のイメージとして 保 存 することができます. File Print Export SVG を 選 択 すると, 保 存 するファイル 名 を 入 力 するた めのウィンドウが 表 示 されます(デフォルトは ファイル 名 モジュール 名.svg になります). なお, 保 存 されるチャートは,タブで 選 択 されて 表 示 されているモジュールのみになります. 16
3 応 用 編 3.1 コマンドラインツール 3.1.1 パスの 設 定 コマンドラインから 各 種 のコマンドを 実 行 するためには,パスの 設 定 が 必 要 になります.1.2.1 節 (3) を 参 照 し,パスの 設 定 を 行 ってください. 3.1.2 ツールの 解 説 (1) ファイル 形 式 の 変 換 (i) SVG への 変 換 HCP チャートのソースを SVG 形 式 のイメージファイルに 変 換 することができます. tosvg [ 変 換 したい hcp チャートのソースファイル 名 ] 図 12: SVG への 変 換 大 量 かつ 複 数 のファイルを 一 括 で 変 換 したい 場 合 は 以 下 のコマンドを 利 用 してください. tosvgall [ 変 更 履 歴 ログを 取 る 場 合 は clog] 図 13: SVG への 一 括 変 換 tosvgall は, 実 行 されたディレクトリ 以 下 の 全 ての.hcp という 拡 張 子 のファイルに 対 して tosvg を 実 行 します. clog という 引 数 を 付 けて 実 行 すると, 実 行 ディレクトリに 変 換 履 歴 のログを 作 成 し, 変 換 時 に チェックを 行 います. 同 じディレクトリから clog を 引 数 として 与 えて 実 行 した 場 合,ソースファイ ルの 変 更 があった 場 合 のみに 変 換 を 行 うことができます. 17
(ii) PNG への 変 換 SVG 形 式 に 変 換 した HCP チャートを PNG 形 式 のイメージファイルに 変 換 することができます. topng [ 変 換 したい svg のソースファイル 名 ] 図 14: PNG への 変 換 コマンド 大 量 かつ 複 数 のファイルを 一 括 で 変 換 したい 場 合 は 以 下 のコマンドを 利 用 してください. topngall [ 変 更 履 歴 ログを 取 る 場 合 は clog] 図 15: PNG への 一 括 変 換 コマンド topngall は, 実 行 されたディレクトリ 以 下 の 全 ての.svg という 拡 張 子 のファイルに 対 して topng を 実 行 します. clog という 引 数 を 付 けて 実 行 すると, 実 行 ディレクトリに 変 換 履 歴 のログを 作 成 し, 変 換 時 に チェックを 行 います. 同 じディレクトリから clog を 引 数 として 与 えて 実 行 した 場 合 は,SVG の 変 更 があった 場 合 のみに 変 換 を 行 うことができます. 18
(iii) EPS への 変 換 SVG 形 式 に 変 換 した HCP チャートを EPS 形 式 のイメージファイルに 変 換 することができます. toeps [ 変 換 したい svg のソースファイル 名 ] 図 16: EPS への 変 換 コマンド 大 量 かつ 複 数 のファイルを 一 括 で 変 換 したい 場 合 は 以 下 のコマンドを 利 用 してください. toepsall [ 変 更 履 歴 ログを 取 る 場 合 は clog] 図 17: EPS への 一 括 変 換 コマンド このコマンドは, 実 行 されたディレクトリ 以 下 の 全 ての.svg という 拡 張 子 のファイルに 対 して toeps を 実 行 します. clog という 引 数 を 付 けて 実 行 すると, 実 行 ディレクトリに 変 換 履 歴 のログを 作 成 し, 変 換 時 に チェックを 行 います. 同 じディレクトリから clog を 引 数 として 与 えて 実 行 した 場 合 は,SVG の 変 更 があった 場 合 のみに 変 換 を 行 うことができます. 19
(2) アプリケーションの 起 動 hcp [ 表 示 する HCP チャートのソースファイル 名 ] 図 18: アプリケーションの 起 動 コマンド アプリケーションの 起 動 を,コマンドラインから 行 うことが 可 能 です.デバッグコンソールに 表 示 される 内 容 と 同 一 のコンパイルエラーを, 起 動 したコンソールに 表 示 することができます. (3) チャートの 印 刷 hprint [ 印 刷 する HCP チャートのソースファイル 名 ] [プリンターの 登 録 名 ] 図 19: チャートの 印 刷 コマンド HCP チャートの 印 刷 を,コマンドラインから 行 うことが 可 能 です. 20
3.2 コマンドのカスタマイズ 定 義 されているコマンドのリテラルを, 自 分 の 好 みに 変 更 することができます. HCP Viewer がインストールされているディレクトリにある command.properties を 編 集 し てください. リスト 8: コマンドの 定 義 ファイル(command.properties) ### HCPViewer コマンド 定 義 ファイル ### modulecommandname=module defaultcommandname=node module=hcpviewer.compiler.analyzer.modulelineanalyzer title=hcpviewer.compiler.analyzer.titlelineanalyzer author=hcpviewer.compiler.analyzer.authorlineanalyzer date=hcpviewer.compiler.analyzer.datelineanalyzer version=hcpviewer.compiler.analyzer.versionlineanalyzer node=hcpviewer.compiler.analyzer.nodelineanalyzer repeat=hcpviewer.compiler.analyzer.repeatlineanalyzer fork=hcpviewer.compiler.analyzer.forklineanalyzer branch=hcpviewer.compiler.analyzer.branchlineanalyzer ec=hcpviewer.compiler.analyzer.errorchecklineanalyzer mod=hcpviewer.compiler.analyzer.callmodulelineanalyzer ex=hcpviewer.compiler.analyzer.exceptionalexitlineanalyzer return=hcpviewer.compiler.analyzer.returnlineanalyzer 例 えば, repeat を r と 書 いてもコンパイルできるようにするには, r=hcpviewer.compiler.analyzer.repeatlineanalyzer という 行 を 追 加 で 記 述 し,アプリケーションを 再 起 動 してください. 21
A コマンド 速 見 表 表 4: ヘッダーコマンド 一 覧 コマンド 内 容 title タイトル author 作 成 者 date 作 成 日 version バージョン 情 報 表 5: モジュールコマンド 一 覧 コマンド 内 容 module モジュール 分 割 位 置 の 指 定 mod モジュール 呼 び 出 し 項 目 表 6: 通 常 コマンド 一 覧 コマンド 内 容 表 示 形 態 repeat 繰 り 返 し 処 理 fork branch return 振 り 分 け 処 理 分 岐 条 件 脱 出 ec エラーチェック 処 理 ex エラー 出 口 22