Debian Codegraph @

doc/html/ja/addin.html

raw
1 <!DOCTYPE html>
2 <html lang="ja">
3 <head>
4 <meta charset="UTF-8">
5 <link rel="stylesheet" href="../ngraph.css" media="screen" type="text/css"/>
6 <link rel="icon" href="../ngraph.svg" />
7 <title>Add-in</title>
8 </head>
9 <body>
10 <div class="toc">
11 <a name="TOP">&nbsp;</a>
12 <h1><a href="./ngraph.html">アドイン</a></h1>
13 <ul>
14 <li><a href="#ADDIN">概要</a>
15 <li><a href="#LEGEND_NSC">legend.nscの動作</a>
16 <li><a href="#STRUCTURE">アドインスクリプトの形式</a>
17 <li><a href="#DATA">データを扱うアドインスクリプト</a>
18 </ul>
19 </div>
20
21 <div class="chapter">
22 <h2><a name="ADDIN">概要</a></h2>
23
24 <p>
25 Ngraph の[アドイン]メニューで登録されているアドインを選ぶと Ngraph はそれ
26 を「Ngraphマクロスクリプト」として実行します。アドインプログラムの追加は
27 [Preference]-[Addin script]で行います。以下のアドインプログラムは配布パッ
28 ケージに含まれており、簡単に追加できるようになっています。
29 </p>
30
31 <dl>
32 <dt> legend.nsc
33 <dd> <p>凡例を自動生成する為のアドイン。「Mix:」をチェックするとファイル
34 名、Xカラム、Yカラムが同じデータをまとめて一つの凡例として扱うよう
35 になります。リストボックスからデータファイル名を選び、「Caption:」
36 に凡例テキストを入力してください。デフォルトではデータファイル名が
37 使われます。</p>
38 <dt> fitrslt.nsc
39 <dd> <p>フィッティングの結果の凡例を作成する為のアドイン。「Expand」を
40 チェックした場合、現在のフィット結果の数値をLegend-Text として生成
41 しますので、フィット結果が変わっても Legend-Textは変更されません。
42 非チェックの場合にはLegend-Textのオブジェクト置換機能を使いますので、
43 フィット結果が変われば、Legend-Textの内容も自動的に変化します。</p>
44 <dt> append.nsc
45 <dd> <p>すでに読み込んであるグラフをクリアせずにNGPファイルを読み込む為
46 のアドインスクリプト。</p>
47 <dt> math.nsc
48 <dd> <p>一行電卓の為のアドイン。数式を入力すると答えを表示します。
49 Ngraphの数式変換機能の関数が使えます。</p>
50 <dt> text-in.nsc
51 <dd> <p>データファイルの指定したカラムを legend-text としてプロットデー
52 タ点の隣に挿入するアドインスクリプト。データを扱うスクリプトの例に
53 もなっています。</p>
54 <dt> cal.nsc
55 <dd> <p>インフォメーションウィンドウにカレンダーを表示するアドインです。
56 /usr/bin/cal を利用しています。</p>
57 <dt> ps2gra.nsc
58 <dd> <p>PostScript を GRA に変換してインポートするマクロです。ビットマッ
59 プを使用したものなど、正常に変換できない場合もあります。文字は直線、
60 曲線に展開され文字としての情報は失われています。実行には ruby 及び
61 pstoedit が必要です。</p>
62 <dt> tex_equation.nsc
63 <dd> <p>LaTeX の数式を GRA ファイルとしてインポートするアドインです。レ
64 ジェンドテキストに LaTeX の数式を入力して、そのテキストを選択状態に
65 してから実行すると GRA ファイルが生成され、マージファイルとして登録
66 されます。数式は直線、曲線で構成され文字の情報は失われています。実
67 行には ruby, pdflatex 及び pstoedit が必要です。</p>
68 <dt> load_prm.nsc
69 <dd> <p>DOS版Ngraphのグラフ (PRM ファイル) を読み込むアドインです。</p>
70 <dt> spellchecker.rb
71 <dd> <p>レジェンドテキストのスペルチェックを行うためのマクロです。
72 raspell ライブラリを使用できる Ruby が必要です。</p>
73 </dl>
74
75 <p>
76 アドインプログラムはユーザが作成する事もできます。マクロスクリプトには
77 Ngraph 内部の設定パラメター全てを参照、変更する機能がありますので、アドイ
78 ンプログラムは Ngraph の状態変数にアクセスして,現在の Ngraph の状態を取
79 得したり,変更したりすることができます。マクロスクリプトだけでもかなりの
80 事ができるのですが、ユーザインターフェースなどの点から、独立した個々のプ
81 ログラムを起動した方が効率が良い場合があります。マクロスクリプトには外部
82 プログラムを起動する機能がありますので、これも可能ですが、その場合には
83 <ul>
84 <li>どうのように外部プログラムに Ngraph の状態を知らせるか?
85 <li>外部プログラムから、どの様に Ngraph の状態を変更させるか?
86 </ul>
87 が問題となります。その簡単な一つの方法の例として legend.nsc を取り上げ、
88 以下で説明します。
89 </p>
90
91
92
93
94 <h2><a name="LEGEND_NSC">legend.nsc の動作</a></h2>
95 <p>
96 legend.nsc が起動する外部プログラムは legend です。
97 まず legend が必要とする現在の Ngraph の状態を記述した中間ファイルを
98 作成します。
99 </p>
100
101 <pre>
102 DATALIST=${system:0:temp_file}
103 object data -instance > "$DATALIST"
104 get data:0-! -id -field file x y type >> "$DATALIST"
105 </pre>
106
107 <p>
108 ここでは、system:0:temp_file でテンポラリファイル名を取得し、objectコマンド
109 で data (データファイル)のインスタンスの数を、get コマンドで各種設定パラメ
110 ターを取得し、テンポラリファイルに書き込んでいます。この中間ファイルのフォ
111 ーマットは起動する外部プログラム(今の場合には legend)固有のフォーマッ
112 トになります。このファイルの中身は現在の Ngraph のデータファイルの設定状況
113 をリストした
114 </p>
115
116 <pre>
117 1
118 demo1.dat
119 1
120 2
121 mark
122 </pre>
123
124 <p>
125 の様なものになります。次に
126 </p>
127 <pre>
128 SCRIPT=${system:0:temp_file}
129 </pre>
130
131 <p>
132 で legend の出力用に別のテンポラリファイル名を取得し、変数SCRIPT
133 に格納しています。後にこのファイルが Ngraph マクロスクリプトとして実行
134 されます。従って、このファイルの中身はマクロスクリプトの文法に則ってい
135 なければなりません。
136 </p>
137 <pre>
138 legend "$DATALIST" "$SCRIPT"
139 </pre>
140
141 <p>
142 ここで外部プログラム legend を起動しています。legend は コマン
143 ドラインの1番目に指定されたファイルから Ngraph の状態を取得し、2番目
144 に指定されたファイルに変更すべき状態をマクロスクリプトとして出力する
145 ように設計されています。例えば "STRING" と言う legend-text を(0,0)に生
146 成するには、$SCRIPT のファイルの内容は
147 </p>
148 <pre>
149 new text
150 text::x=0
151 text::y=0
152 text::text="STRING"
153 </pre>
154
155 <p>
156 となります。またグラフに変更を加えたときは、"menu::modified=TRUE" を実行
157 して、グラフを閉じるときに保存の確認が行われるようにしておきます。このス
158 クリプトを実行するのは
159 </p>
160 <pre>
161 if [ -f "$SCRIPT" ];
162 then
163 new shell
164 shell::shell "$SCRIPT"
165 del shell
166 fi
167 </pre>
168
169 <p>
170 です。ここで、変数 SCRIPT に格納したファイルが存在しいている場合(if文)
171 に、shell オプジェクトのインスタンスを生成(new)し、そのインスタンスに
172 そのファイルを解釈実行(shell)させ、最後に不要になったインスタンスを削
173 除(del)しています。
174 </p>
175 <pre>
176 system:0:unlink_temp_file "$DATALIST"
177 system:0:unlink_temp_file "$SCRIPT"
178 </pre>
179
180 <p>
181 最後に不必要になった中間ファイル($DATALIST)とスクリプトファイル($SCRIPT)
182 を削除します。
183 </p>
184
185
186
187
188
189 <h2><a name="STRUCTURE">アドインスクリプトの形式</a></h2>
190 <p>
191 外部プログラムを起動するアドインスクリプトは、
192 </p>
193 <pre>
194 … 外部プログラムに必要な中間ファイルを生成する …
195 SCRIPT=${system:0:temp_file}
196 外部プログラム名 中間ファイル名 "$SCRIPT"
197 if [ -f "$SCRIPT" ];
198 then
199 new shell
200 shell::shell "$SCRIPT"
201 del shell
202 fi
203 system:0:unlink_temp_file "$SCRIPT"
204 </pre>
205
206 <p>
207 となります。
208 </p>
209 <p>
210 もちろん、Ngraphの現在の状態を取得する必要がなければ、
211 </p>
212 <pre>
213 SCRIPT=${system:0:temp_file}
214 外部プログラム名 "$SCRIPT"
215 if [ -f "$SCRIPT" ];
216 then
217 new shell
218 shell::shell "$SCRIPT"
219 del shell
220 fi
221 system:0:unlink_temp_file "$SCRIPT"
222 </pre>
223
224 <p>だけで十分です。</p>
225
226
227
228
229
230 <h2><a name="DATA">データを扱うアドインスクリプト</a></h2>
231 <p>
232
233 アドインスクリプトの中からデータを直接扱う事もできます。その例として
234 text-in.nsc を説明します。次のようなデータファイルが有るとします。
235 </p>
236 <pre>
237 =====test.dat=========
238 0 0 sampleA
239 1 1 sampleB
240 2 2 sampleC
241 ======================
242 </pre>
243
244 <p>
245 第一カラムをx座標に、第二カラムをy座標にしたグラフを作成したとします。
246 Ngraphにはすでにtest.datが開いてあり、プロットタイプ "mark" でプロット
247 されているとします。ここで text-in.nsc を実行し、
248 "Input legend-text column" に 3 を入力すると、データ点の隣に第三カラム
249 のテキストをlegend-textとして挿入することができます。
250 </p>
251 <p>
252 このスクリプトでは、まず dialog オブジェクトを使って、legend-text のカラ
253 ム数を入力させ、変数(COLUMN)に代入します。
254 </p>
255 <pre>
256 new dialog
257 COLUMN=${dialog::input:'Input legend-text column'}
258 del dialog
259 </pre>
260
261 <p>
262 次に data オブジェクトの data::opendatac を使ってデータファイルを開き、
263 data::getdata でデータが無くなるまでデータを取得し、最後に
264 data::closedata でデータを閉じます。
265 </p>
266 <pre>
267 data:0:opendatac
268 while data:0:getdata
269 do
270 … テキストの設定 …
271 done
272 data:0:closedata
273 </pre>
274
275 <p>
276 while ループの中では、まず text オブジェクトを生成します。
277 </p>
278 <pre>
279 new text
280 </pre>
281
282 <p>
283 また data::getdata を実行した時、データの数値は data::data_x, data::data_y
284 に入り、0.01mm単位での用紙上での位置は data::coord_x, data::coord_y に入
285 り、行番号は data::line に入ります。これらを用いて生成したtextの座標値を設
286 定しています。
287 </p>
288 <pre>
289 text::x=${data:0:coord_x}
290 text::y=${data:0:coord_y}
291 </pre>
292
293 <p>
294 また data::column を用いてカラムのトークンを取り出しています。data::column
295 の第一引数はファイルの行数で、data::line を使い、第二引数は取り出すカラム数
296 で変数 COLUMN の値を用いています。取り出したトークンを text::text に設定し
297 ます。
298 </p>
299 <pre>
300 text::text=`get data:0 -field column:"${data:0:line} ${COLUMN}"`
301 </pre>
302
303 <p>
304 ただし、data::column は呼び出される毎にファイルの先頭から走査して目的の文字
305 列を取得しますので、データファイルが大きい場合には動作が遅いです。
306 </p>
307 <p>
308 一般的にデータを扱うアドインスクリプトは、
309 </p>
310
311 <pre>
312 data::opendatac
313 while data::getdata
314 do
315 … 目的の操作
316 data::data_x data::data_y data::coord_x data::coord_y data::line が使える
317 done
318 data::closedata
319 </pre>
320
321 <p>
322 となります。data::opendatac の代わりに data::opendata を用いた場合、
323 data::coord_x, data::coord_y の値は不定となりますが、その代わり軸の設定がなさ
324 れていなくてもエラーにはなりません。</p>
325
326
327 </div>
328 </body>
329 </html>