GC2Szkey.c

[Top] [Bottom]

初めに

　WZ のマクロでキーを受け付ける常駐型マクロを作る場合、
• フックを用いる
• getch() を用いる
のいずれかがあります。しかし、Nifty-serve VillageCenter Station(SVC)で見る限り、後者を手法を用いているのほとんど僕だけで(ゆえに僕は「唯一の getch() 使い」と自称している(^^;)、普通は前者の方法を用います。この理由はいろいろありますが、そのうちの一つとして「getch() の返り値はそのままでは使いにくい」というのが挙げられます。このマクロはそれを解決するのに用いられます。

---

[Top] [Bottom] [使用法] [リファレンス] [使用例]

機能

　GC2Szkey.c は以下の機能を持つ関数もつライブラリです。
• 「getch()」を補助する関数・マクロ(#define)
• 「getch()」を Wrap し、キー入力を解析してそのキーに割り当てられているコマンドなどの情報を構造体に格納する。

---

[機能]

使用法

WZ のマクロでキー入力を受け付け、それをキーをあらわす文字列などを含んだ構造体に　ソースごとインクルードするには

#include <GC2Szkey.c>

で、TLL をインクルードするには

#include <GC2Szkey.h>

で使用してください。


---

[機能]

リファレンス

関数
• GC2Szkey
• GetCMD
• KeyUpDown2NormalUpDown (ver1.00 で廃止)
• nrtkeyWriteChar (ver1.00 で追加)
構造体
• CMDstruct
• GetCMDOption
マクロ(#define)
• wzcmdFromSzkey
• DelayedGC_WITHSHIFT
• Is2strokeSzcmd
• GC_GETByte

---

[リファレンス]
BOOL GC2Szkey(TXCHAR chGC, mchar *szKey)
　getch() で受け取った文字を(VZ風の)キー定義文字列の形式にして、szKey に格納します。
引数
• TXCHAR chGC
  「getch()」の返り値を渡します。
• mchar *szKey
  キー定義文字列を受け取るバッファを渡します。
返り値
• BOOL
  コマンド定義可能なキー又は2ストロークキーなら TRUE さもなくば FALSE

---

[リファレンス]
BOOL GetCMD(CMDstruct *InputCMD,GetCMDOption *Option)
キー入力を受け付けそれを解析し、結果を InputCMD に格納します。
2ストロークキーが押された場合は自動的に次の入力も待ちます。 ただし、[ESC]キーは 2ストロークキーにしていてもオプションで単発で取得が可能です。
引数
• CMDstruct *InputCMD
  受け付けたキーの情報を格納します。格納される情報は以下のとおりです。
  • 入力したキーを表す文字列
  • 入力した文字のコード
  • 入力したキーにバインドされているコマンドId
  • 入力したキーにバインドされているコマンド名
  • 同時に SHIFT が押されていたか(絶対状態取得)
  • 同時に CTRL が押されていたか(絶対状態取得)
  • 同時に ALT が押されていたか(絶対状態取得)
  詳しくはCMDstructを参照してください。
• GetCMDOption *Option
  動作オプションを指定します。設定できる項目は以下のとおりです。
  • 入力待ち時に表示するメッセージ
  • [ESC]キーに2ストロークキーが割り当てられていても単発で取得するか
  • コマンドを割り当てられていないキーを取得するか
  詳しくはGetCMDOptionを参照してください。
返り値
• BOOL
  コマンド定義可能なキー又は2ストロークキーなら TRUE さもなくば FALSE

---

[リファレンス]
CMDstruct
GetCMDに用いられる「コマンド構造体」CMDstruct は次のようになっています。

typedef struct {
    mchar   szKey[20];  //入力したキーを表す文字列
    TXCHAR  chInput;    //入力した文字のコード
    WZCMD   cmd;        //入力したキーにバインドされているコマンドId
    mchar   szcmd[50];  //入力したキーにバインドされているコマンド名
    BOOL    fSHIFT;     //同時に SHIFT が押されていたか(絶対状態取得)
    BOOL    fCTRL;      //同時に CTRL  が押されていたか(絶対状態取得)
    BOOL    fALT;       //同時に ALT   が押されていたか(絶対状態取得)
} CMDstruct;

szKey	getch() で入力されたキーを受け取り、それを GC2Szkey に渡して得られる文字列を格納します。
chInput	文字を生成するキーではその文字の ASCII コード、文字を生成しないキーに対しては Windows の仮想キーコードが格納されます。
cmd	入力されたキーに割り当てられているコマンドの「コマンドId」を返します。コマンドを割り当てられないキーに対しては 0 を返します。
szcmd	入力されたキーに割り当てられているコマンドの「コマンド名」を返します。コマンドを割り当てられないキーに対しては "null"（という文字列)を返します。
fSHIFT	キーが入力されたときに同時に SHIFT が押されていたかを示します。SHIFTキーが押されていれば true,さもなくば false を返します。GC_WITHSHIFT と違い、絶対状態を取得するので、[SHIFT]+[英字] で文字を入力した場合にも true が返されます。
fCTRL	キーが入力されたときに同時に CTRL が押されていたかを示します。CTRLキーが押されていれば true,さもなくば false を返します。絶対状態を取得します。
fALT	キーが入力されたときに同時に ALT が押されていたかを示します。ALTキーが押されていれば true,さもなくば false を返します。絶対状態を取得します。

---

[リファレンス]
GetCMDOption
GetCMDに用いられる「動作オプション構造体」GetCMDOption は次のようになっています。

typedef struct {
    mchar   szWaitmessage[80];      //入力待ちメッセージ
    BBOOL   fESC;                   //ESC設定 (動作変更)
    BBOOL   fNormalizeKeyUpDown;    //(オプション廃止)常に RAWKeyUpDown を指定
    BBOOL   fGetNullCmd;            //null cmd の受け付け
} GetCMDOption;

szWaitmessage	キー入力待ちの時にステータスラインに表示するメッセージを入れます。NULL文字列を入れるとステータスラインを書き換えません。
fESC	[ESC] を 2ストロークキーとしている場合に 2ストロークキーとして扱うか[ESC]キーの入力として扱うかを指定します。[ESC]キーに2ストロークキーが割り当てられていないときは動作に違いはありません。 fESCの値は次のいずれかです。 ESCESC [ESC]キーを[ESC]キーとして取得 ESCDefault [ESC]キーが２ストロークキーならそのように扱う 　前は ESCESC を指定したときに [ESC]キーを押すと常に InputCMD->cmd に 0, InputCMD->szcmd には "NULL" が返されていましたが、ver1.00 から[ESC]キーに割り当てられているコマンドID とコマンド名を返すように変更しました。2ストロークキーのときにはコマンド名「２ストロークキー」が返されます。
fNormalizeKeyUpDown	常に RAWKeyUpDown を指定します。 　前は txkeyUp / txkeyDown を txUp / txDown に換える機能がありましたが、解析したコマンドを txCall に渡せば txkeyUp /txkeyDown でも実行してくれるので不要だということで ver1.00 から廃止しました。
fGetNullCmd	コマンドが割り当てられていないキーの入力があったとき、その入力を受け付けるか次の入力を待つかを指定します。 fGetNullCmdの値は次のいずれかです。 notRecieveNullCMD コマンドを割り当てられていないキーは無視して次の入力を待ちます。 RecieveNullCMD コマンドを割り当てられていないキーも取得します。

---

[リファレンス]
void KeyUpDown2NormalUpDown(mchar *szcmd)(ver1.00 で廃止)
　文字列szcmd が 「txkeyUp」 なら 「txUp」 に、「txkeyDown」 なら 「txDown」に換えます。(「txkeyUp」「txkeyDown」はマクロでは無効なため) その他の文字列はそのままです。
• 　という関数だったのですが、txCall に渡せば実行できるのと、WZ 3.0 では txkey系コマンドが SHIFT やオプションによってポリモルフィックに動作が変していて、それぞれの動作を追っかけて分岐するのが困難なため廃止しました。

---

[リファレンス]
int nrtkeyWriteChar(TX* text,TXCHAR ch)(ver1.00 で追加)
　txWriteChar に以下の動作を付加して動作します。
• マウスで範囲を指定しているときには範囲選択している部分を削除する。
• フリーカーソル時に改行よりカーソルが後ろにあるならカーソル位置まで空白を付加する。
txkeyOverWrite のソースを参考にして作った関数です。
引数
• TX *text
  編集対象の text を指定します。
• TXCHAR ch
  書き込む文字を指定します。
返り値
• int
  文字の書き込みが実行できたかを返します。

---

[リファレンス]
wzcmdFromSzkey
キー文字列からコマンド番号を返します。(#define文)

wzcmdFromSzkey(s)       (wzkeyGetWzcmd(wzkeyFromSzkey(s)))




---

[リファレンス]
Is2strokeSzcmd
文字列が「２ストロークキー」かを返します。(#define文)

Is2strokeSzcmd(s)       ((strcmp(s,"２ストロークキー") == 0))




---

[リファレンス]
DelayedGC_WITHSHIFT
　前の文字入力時にSHIFTキーが押されていたかを調べます。(#define文)

DelayedGC_WITHSHIFT     (GetKeyState(VK_SHIFT) &lt 0)




---

[リファレンス]
GC_GETByte
　getch() で入力された文字の下位8Byte を取得します。(#define文)

#define GC_GETByte(c)                   ((c) &amp  0xFF)

---


[機能]

GC2Szkey を使っている例

• TeXenv for WZ
• 「このキーなあに?」
• WATCHAR
• NaruTo のインクリメンタルサーチマクロ



---

[Top] [Bottom] [変更履歴] [著作権・配布条件等]

その他

---

[その他]

変更履歴

1997/10/19 ver1.00

• ファイル名を GC2Szkey.txc から GC2Szkey.c に変更
• KeyUpDown2NormalUpDown の廃止及びそれに伴う GetCMD に於ける Option->fNormalizeKeyUpDown オプションの廃止(常に RAWKeyUpDown を指定)。さらに GetCMD 内部で wndtxCall(text->hwndbase,szCmd) を使用していた部分を Call(szCmd) で処理するように変更
• GetCMD に於ける Option->fESC の、ESCESC 指定時の返り値の変更
• nrtkeyWriteChar の追加


　マクロの部品でこの関数の変更履歴がのこっていないので以下略歴。
(WHATCHAR の変更履歴が GC2Szkey の大体の履歴になっている)


1995/06/24 ver0.40

• GetCMD の追加

1995/06/04 ver0.01

• 初版作成

1995/05/18

• 原形マクロ「VK2Szkey」作成

---

[その他]

著作権・配布条件等

• 　このマクロの作者は NaruTo(成岡知彦)で、 著作権を保有しています。
• 　このマクロを使用したことにより発生した いかなる障害に対しても 作者は責任を取る義務を有しません。
• 　このマクロにバグがあっても作者は バグを取り除く義務を有しません。
• 　このマクロを改変したものを配布・転載するときは 必ず改変した人の氏名と改変した旨を明記すること。 その際、作者の名前を削除しないこと。

---

[Top] [Bottom]

終わりに・・・

　TeXenv for WZ は杉山卓士さん原作・成岡知彦改変の VZ Editorの用のマクロ TeXenv for VZ を移植したものです。TeXenv for VZ は常駐型のマクロでした。
　僕は WZ のマクロが初めてのWindows Programing でした。そのため、VZ でいうところの「&p」「&o」にあたる機能を必要としていましたが、TeXenv を初めて作った(WZ ver1.0 のβテストをしていた)ころは、僕はフックを使いこなすことはできませんでした。
　「&o」にあたる処理はwndtxCall (初めは wndtxMacroSend だった)を自分自身のウインドウに用いることを教えていただきました。そして、「&p」にあたる機能が「getch()」でしたが、取得した文字をキーをあらわす文字列に変換する必要がありました。それが「GC2Szkey」の意味です。そのキーをあらわす文字列を「wzcmdFromSzkey」を用いてさらに「wzcmdToSzcmd」を用いてそのキーに割り当てられているコマンドを知ることができ、それを wndtxCall で実行しました。(GC2Szkey ver1.00 からは txCall を用いることを想定するようになりました。)


　その後も僕は幾つか常駐型のマクロやキーを取得して解釈して動作するマクロを幾つか作りましたが、その過程で、「GC2Szkey.txc」を強化してこのモジュールにその関数を実行するとキーを受け付けてそのキーが押されたときのシフトキーの状態やコマンドなどの情報を含んだ構造体に値を格納する getch() の Wrapper関数「GetCMD」を作りました。
　TeXenv では使っていませんが、その他の「GC2Szkey.c」を使っている僕のマクロは「GetCMD」を用いています。

DOWNLOAD

getch() Support関数群及びWrapper 関数

GC2Szkey.c ver1.00

【対応バージョン】

WZ32 ver3.00B

• その他のバージョンでは不明

【アーカイブ内容】

マクロソース、ドキュメント(HTML)、サンプルマクロ「WHATCHAR」

• NaruTo の WZ 工房へ
• NaruTo の御家頁へ