スタックダイアグラム (OpenBoot 3.x コマンド・リファレンスマニュアル)

OpenBoot 3.x コマンド・リファレンスマニュアル

スタックダイアグラム

規則に従うコーディング形式では、わかりやすいように Forth ワードの定義ごとに、それぞれの最初の定義行に ( -- ) の形式の「スタックダイアグラム 」を表記する必要があります。スタックダイアグラムは、ワードを実行するとスタックがどうなるかを指定するものです。

-- の左側におかれる項目は、ワードがスタックが取り出し、その操作で使用するスタック項目を表します。これらの項目の最も右側のものがスタックの一番上にあり、それより前の項目は順次にその下にあります。つまり、引数は左から右の順にスタックにプッシュされ、最も新しい項 (ダイアグラムの最も右の項目) がスタックの一番上に残ることになります。

-- の右側におかれる項目は、ワードが実行を終了した後にスタックに残されるスタック項目を表します。この場合もやはり、最も右側の項目がスタックの一番上に置かれ、それより前の項目はその下に入ります。

たとえば、ワード + のスタックダイアグラムは

( nu1 nu2 -- sum )

です。この場合、+ は 2 つの数値 (nu1 と nu2) をスタックから削除し、それらの和 (sum) をスタックに残します。もう 1 つの例として、ワード . のスタックダイアグラム

( nu -- )

があります。この場合、ワード . はスタックの一番上の数値 (nu) を削除し、それを表示します。

スタックの内容に影響しないワード (showstack や decimal など) のスタックダイアグラムは ( -- ) になります。

場合によっては、コマンド行のワードのすぐ後に別のワード、または他のテキストが必要なことがあります。たとえば、ワード see は

see thisword

という形式で使用されます。

スタック項目は、正しい使い方がわかりやすいように、一般的に (意味を表すような) 説明的名前を使用して書きます。本書で使用するスタック項目の省略表記については、表 4-2 を参照してください。

表 4-2 スタック項目の表記法


表記	説明
\|	前後に空白文字を入れて表示される代替スタック結果。たとえば、( `input -- addr len false` \| `result true` )。
`???`	未知のスタック項目 (1 つまたは複数)。
...	未知のスタック項目 (1 つまたは複数)。スタックコメントの両側に使用した場合は、両側に同じスタック項目があることを意味します。
`< > <space>`	空白区切り文字。先行空白文字は無視されます。
`a-addr`	可変境界アドレス。
`addr`	メモリーアドレス (一般的に仮想アドレス)。
`addr len`	メモリー領域のアドレスと長さ。
`byte b`xxx	8 ビット値 (1 セル中の下位バイト)。
`char`	7 ビット値 (1 セル中の下位バイト)。最上位ビットは不定
`cnt`	カウント値。
`len`	長さ。
`size`	カウント値または長さ。
`d`xxx	倍 (拡張) 精度数。2 セルで、スタックの上部には、最上位のセルが置かれる。quadlet (32 ビット)。
`<eol>`	行末区切り文字。
`false`	0 (false フラグ)。
`n n1 n2 n3`	通常の符号付き 1 セルの値。
`nu nu1`	符号付きまたは符号なしの 1 セルの値。
`<nothing>`	ゼロスタック項目。
`o o1 o2 oct1 oct2`	Octlet (符号付き 64 ビット値)。
`oaddr`	Octlet (64 ビット) 境界のアドレス。
`octlet`	8 バイト数値。
`phys`	物理アドレス (実際のハードウェアアドレス)。
`phys.lo` `phys.hi`	物理アドレスの下位/上位セル。
`pstr`	パックされた文字列。
`quad q`xxx	Quadlet (32 ビット値、1 セル中の下位 4 バイト)
`qaddr`	Quadlet (32 ビット値) 境界のアドレス。
`true`	-1 (true フラグ)。(真)
`uxxx`	1 セル、符号なし 32 ビット値、正の値 (32 ビット)。
`virt`	仮想アドレス (ソフトウェアが使用するアドレス)。
`waddr`	Doublet (16 ビット) 境界のアドレス。
`word w`xxx	Doublet (16 ビット値、1 セル中の下位 2 バイト)。
`x x1`	任意の 1 セルのスタック項目。
`x.lo x.hi`	データ項目の下位／上位ビット
`xt`	実行トークン。
`xxx?`	フラグ。名前は用途を示します (たとえば、`done?` `ok?` `error?`)。
`xyz-str xyz-len`	パックされない文字列のアドレスと長さ。
`xyz-sys`	制御フロー用スタック項目。実装に依存します。
`( C: -- )`	コンパイルスタックダイアグラム。
`( -- )( E: -- )`	実行スタックダイアグラム。
`( R: -- )`	復帰スタックダイアグラム。