関数

jrKanjiString, jrKanjiControl

ヘッダファイル

canna/jrkanji.h

ライブラリ

libcanna.a, libcanna.so

関数

XLookupKanjiString, XKanjiControl

ヘッダファイル

canna/kanji.h

ライブラリ

libXn.a, libXn.so, libcanna.a, libcanna.so

typedef struct {


  int      val;          /* バッファに格納された文字列の長さが返る */


  unsigned char *buffer; /* 確定文字列を格納するためのバッファを与える */


  int      bytes_buffer; /* 上記のバッファの大きさを与える */


  jrKanjiStatus *ks;     /* 未確定文字列の情報を格納する構造体へのポインタ */
} jrKanjiStatusWithValue;

KC_INITIALIZEをrequest部で指定することにより，かな漢字変換の初期 化を行います．argにはwarningメッセージを 格納するための(char **)型の変数へのポインタまたはNULLを指定します．初 期化の処理は基本的にはjrKanjiString(3)が最初に呼ばれた時に自動的に行わ れますが，jrKanjiControlを用いて初期化する ことにより，jrKanjiString(3)での初期化処理は行われなくなります．

jrKanjiString(3)の使用に先立ってjrKanjiControlを用いてかな漢字変換に関 する制御を行う時などは，漢字変換の初期化を行う必要があります．

正常終了時にはjrKanjiControlの戻り値として0が返り，異常終了時には-1が 返ります．

KC_INITIALIZEを行った場合，エラーとまではいかなくとも何らかのwarningが 発生することがあります．warningが発生した場合はargにて与えられた 変数に対してwarning文字列の配列へのポインタが格納され 返されます．warningがないときはNULLが格納され返されます．

(例)

  int res; /* エラーが返ってくる場合に備える */


  char **warning;


  .....


  res = jrKanjiControl(0, KC_INITIALIZE, &warning);


  if (warning) {


    char **p;


    for (p = warning ; *p ; p++) {


      fprintf(stderr, "%s0, *p);


    }


  }

第３引数に返されるwarningメッセージはライブラリの内部でmallocされます． これは，次にKC_INITIALIZEやKC_FINALIZEが行われた時に開放されます．アプ リケーションプログラマが勝手にfreeしてはいけません．warningは今のとこ ろ最大64メッセージに限定されます．それ以上のメッセージは切捨てられます．

メッセージに含まれる可能性のあるwarningには以下のものがあります．

・

カスタマイズファイルがシステムのものも含めてすべて利用できない．

・

カスタマイズファイルにシンタックスエラーがある．

・

ローマ字かな変換辞書が利用できない．

・

かな漢字変換辞書が利用できない．

・

かな漢字変換サーバに接続できない．

第３引数としてNULLを指定した場合warningメッセージは捨てられます．

入力モードをアプリケーションから変更します．requestの 部分にはKC_CHANGEMODEを指定し，argにjrKanjiStatusWithValue構造体 を指定して下さい．jrKanjiStatusWithValue構造体のvalメンバにてモー ド番号を指定することにより日本語モードが切り替わります．モード番号は以 下のマクロで示されます．

マクロ番号

モード

CANNA_MODE_AlphaMode

アルファベットモード

CANNA_MODE_HenkanMode

変換入力モード

CANNA_MODE_KigoMode

記号入力モード

CANNA_MODE_ZenHiraKakuteiMode

全角ひらがな確定入力モード

CANNA_MODE_ZenKataKakuteiMode

全角カタカナ確定入力モード

CANNA_MODE_HanKataKakuteiMode

半角カタカナ確定入力モード

CANNA_MODE_ZenAlphaKakuteiMode

全角アルファベット確定入力モード

CANNA_MODE_HanAlphaKakuteiMode

半角アルファベット確定入力モード

CANNA_MODE_HexMode

16進コード入力モード

CANNA_MODE_BushuMode

部首入力モード

CANNA_MODE_TorokuMode

単語登録モード

この機能によりモードを変更するとモード名を始めとして多くの表示が変化を 受けます．表示の変更はargとして指定したjrKanjiStatusWithValue構造体に て返されます．

(例)

  jrKanjiStatus ks;


  jrKanjiStatusWithValue ksv;


  unsigned char buf[SOMESIZE];


  .....


  ksv.ks = &ks;


  ksv.buffer = buf;


  ksv.bytes_buffer = SOMESIZE;


  ksv.val = CANNA_MODE_HexMode;


  jrKanjiControl(context, KC_CHANGEMODE, &ksv);


  len = ksv.val;


  .....


  /* 未確定文字列や確定文字列の情報がksvにより返されます． */

候補一覧のために用いられる領域のコラム数を指定します．１コラムの幅はア ルファベット文字あるいは半角カタカナ１文字の文字幅であり，全角漢字は２ コラム占めることになります．候補一覧表示のための幅を 指定するためにrequest部分に指定する値はKC_SETWIDTHで， このときargにコラム数を指定します．

(例)

  jrKanjiControl(0, KC_SETWIDTH, (char *)60);

プログラムを終了するなどの局面でかな漢字変換も終了することを指定します． かな漢字変換処理を終了させる時は必ずこの処理を行って下さい．終わるにあ たって今まで学習した内容がファイルに登録されます．request部分に はKC_FINALIZEを指定します．

正常終了時に0，異常終了時に-1が戻り値として返ります．

KC_FINALIZEを行った場合，エラーとまでいかなくとも何らかのwarningが発生 することがあります．warningが発生した場合はargにて与えられた 変数にwarning文字列の配列へのポインタが格納され返されます．warningがな い場合にはNULLポインタが格納され返されます．

(例)

int res; /* エラーが返る場合に備える */
char **warning;
.....
res = jrKanjiControl(0, KC_FINALIZE, &warning);
if (warning) {
char **p;

for (p = warning ; *p ; p++) {
fprintf(stderr, "%s0, *p);
}
}

第３引数に返されるwarningメッセージは，ライブラリの内部でmallocされま す．これは，次にKC_INITIALIZEやKC_FINALIZEが行われた時に開放されます． アプリケーションプログラマが勝手にfreeしてはいけません．

warningは今のところ最大64メッセージに限定されます．それ以上のメッセー ジは切捨てられます．

メッセージに含まれる可能性のあるwarningには次のものがあります．

・

辞書がアンマウントできない．

第３引数としてNULLを指定した場合，warningメッセージは捨てられます．

読みを入力している状態でC-tを打ったときのように未定義キーを入力した時 に取られる処理を指定します．未定義キーに対応して行われる処理としては以 下の処理があります．

マクロ名

処理

kc_normal

ビープ

kc_through

アプリケーションプログラムに渡す

kc_kakutei

確定しアプリケーションプログラムに渡す

kc_kill

消去しアプリケーションプログラムに渡す

kc_normalを指定した場合，外部変数jrBeepFuncに設定された関数が未定義キー 入力時にライブラリによって自動的に呼び出されます．jrBeepFuncに値を設定 しない場合には(jrBeepFunc == NULLの場合には)何も起こりません．

(例)

  extern (*jrBeepFunc)(), beep();


  jrBeepFunc = beep;


  jrKanjiControl(0, KC_SETUNDEFKEYFUNCTION, kc_normal);

モード情報を文字列ではなくビットマップなどのデータで表示したい場合があ ります．そのような場合にはモード情報として数値データが返ってくると処理 がしやすくなります．jrKanjiControlでKC_SETMODEINFOSTYLEを 指定し，argに１を渡すことによってそれ以後はjrKanjiStatus構造体 のmodeメンバにはモードを表す数値に'@'(0x40)を加えた１文字が返さ れるようになります．モードを表す数値に変換する場合には返ってきた文字列 から'@'(0x40)を引きます．モードを表す数値については入力モードの 変更((2)KC_CHANGEMODE)のこうを参照して下さい．

入力中の文字列を何らかの都合で放棄したい場合があります．放棄する場合に 入力中の文字列を確定文字列として取り込んでから放棄したい場合と全く捨て てしまってから放棄したい場合があります．確定する 場合にはjrKanjiControlにてKC_KAKUTEIを指定し，放棄する 場合にはKC_KILLを指定します．

この処理は表示に影響を与えるので第３引数にはjrKanjiStatusWithValue構造 体を指定しなければなりません．

(例)

  jrKanjiStatusWithValue ksv;


  jrKanjiStatus ks;


  unsigned char buf[SOMESIZE];


  .....


  ksv.ks = &ks;


  ksv.buffer = buf;


  ksv.bytes_buffer = SOMESIZE;


  jrKanjiControl(context, KC_KAKUTEI, &ksv);


  len = ksv.val;


  .....

現在のモードを問い合わせるにはjrKanjiControlでKC_QUERYMODEを指定します．

第３引数にはモード文字列を格納するための文字配列のポインタを指定します． モード文字列はヌル文字で終わる文字列です．ここに数値が返るようにするに はjrKanjiControlでKC_SETMODEINFOSTYLEを指定してモード文字列のスタイル を変更しておきます．

(例)

  char currentMode[MAXMODELEN];


  .....


  jrKanjiControl(0, KC_QUERYMODE, currentMode);


  .....

かな漢字変換サーバとしてどのサーバを使うかをアプリケーションプログラム を終了することなしに切替えることが可能です．かな漢字変換サーバとして接 続するべきサーバを指定するにはjrKanjiControlでKC_SETSERVERNAMEを指定し ます．第３引数には接続したいサーバ名を指定します．

カスタマイズファイルをアプリケーションプログラム側から変更することがで きます．カスタマイズファイルの変更はjrKanjiControlの 第２引数にKC_SETINITFILENAMEを指定し，第３引数にファイル名文字列を指定 することにより行います．この処理を行う場合はKC_INITIALIZEに先立って実 行しておかなければなりません．

(例)

  char *inifile = "app-own.canna"


  .....


  jrKanjiControl(0, KC_SETINITFILENAME, initfile);


  .....

変換コンテクストを表すコンテクストIDは任意の整数を割り当てることができ ます．今まで使われていない コンテクストIDをjrKanjiStringあるいはjrKanjiControlに与えることが可能 であり，その場合，そのコンテクスト用のイニシャライズが行われ必要なメ モリが確保されます．

それまで使用していた入力ポートが使われなくなった場合に，そのポートに割 り当てて使っていたコンテクストID用に確保されたメモリを 開放するにはjrKanjiControlを第２引数にKC_CLOSEUICONTEXTを指定して呼び 出します．

この処理は表示の変化をともなうので第３引数にはjrKanjiStatusWithValue構 造体を与えます．

(例)

  jrKanjiStatusWithValue ksv;


  jrKanjiStatus ks;


  unsigned char buf[SOMESIZE];


  .....


  ksv.ks = &ks;


  ksv.buffer = buf;


  ksv.bytes_buffer = SOMESIZE;


  jrKanjiControl(0, KC_CLOSEUICONTEXT, &ksv);


  .....

初期化ファイルにてモード表示文字列がカスタマイズできますが，カスタマイ ズされた結果モード表示文字列にどれだけの表示領域を確保するかを調べる必 要がある場合があります．jrKanjiControlを第２引数にKC_QUERYMAXMODESTRを 指定して呼び出すことにより，モード表示文字列として何コラム必要かが返り 値として返されます．ここで言うコラムとは半角英数文字の文字幅を１とした ときの値を示します．

第３引数は用いられないのでダミー値として0を与えます．

(例)

  int max_mode_columns;


  .....


  max_mode_columns = jrKanjiControl(0, KC_QUERYMAXMODESTR, 0);


  .....

event_struct

キーイベントを指定します。

buffer_return

変換した漢字文字列が返されます。

bytes_buffer

バッファの長さを指定します。

keysym_return

キーシンボルを返します。NULLを指定することもできます。

status_return

XCompose構造体へのポインタを指定します。

kanji_status_return

かな漢字変換の様子が返されます。

typedef struct {


  int      val;          /* バッファに格納された文字列の長さが返る */


  unsigned char *buffer; /* 確定文字列を格納するためのバッファを与える */


  int      bytes_buffer; /* 上記のバッファの大きさを与える */


  XKanjiStatus *ks;     /* 未確定文字列の情報を格納する構造体へのポインタ */
} XKanjiStatusWithValue;

KC_INITIALIZEをrequest部で指定することにより，かな漢字変換の初期 化を行います．argにはwarningメッセージを 格納するための(char **)型の変数へのポインタまたはNULLを指定します．初 期化の処理は基本的にはXKanjiString(3)が最初に呼ばれた時に自動的に行わ れますが，XKanjiControlを用いて初期化する ことにより，XKanjiString(3)での初期化処理は行われなくなります．

XKanjiString(3)の使用に先立ってXKanjiControlを用いてかな漢字変換に関 する制御を行う時などは，漢字変換の初期化を行う必要があります．

正常終了時にはXKanjiControlの戻り値として0が返り，異常終了時には-1が 返ります．

KC_INITIALIZEを行った場合，エラーとまではいかなくとも何らかのwarningが 発生することがあります．warningが発生した場合はargにて与えられた 変数に対してwarning文字列の配列へのポインタが格納され 返されます．warningがないときはNULLが格納され返されます．

(例)

  int res; /* エラーが返ってくる場合に備える */


  char **warning;


  .....


  res = XKanjiControl(dpy, win, KC_INITIALIZE, &warning);


  if (warning) {


    char **p;


    for (p = warning ; *p ; p++) {


      fprintf(stderr, "%s0, *p);


    }


  }

第4引数に返されるwarningメッセージはライブラリの内部でmallocされます． これは，次にKC_INITIALIZEやKC_FINALIZEが行われた時に開放されます．アプ リケーションプログラマが勝手にfreeしてはいけません．warningは今のとこ ろ最大64メッセージに限定されます．それ以上のメッセージは切捨てられます．

メッセージに含まれる可能性のあるwarningには以下のものがあります．

・

カスタマイズファイルがシステムのものも含めてすべて利用できない．

・

カスタマイズファイルにシンタックスエラーがある．

・

ローマ字かな変換辞書が利用できない．

・

かな漢字変換辞書が利用できない．

・

かな漢字変換サーバに接続できない．

第4引数としてNULLを指定した場合warningメッセージは捨てられます．

入力モードをアプリケーションから変更します．requestの 部分にはKC_CHANGEMODEを指定し，argにXKanjiStatusWithValue構造体 を指定して下さい．XKanjiStatusWithValue構造体のvalメンバにてモー ド番号を指定することにより日本語モードが切り替わります．モード番号は以 下のマクロで示されます．

マクロ番号

モード

CANNA_MODE_AlphaMode

アルファベットモード

CANNA_MODE_HenkanMode

変換入力モード

CANNA_MODE_KigoMode

記号入力モード

CANNA_MODE_ZenHiraKakuteiMode

全角ひらがな確定入力モード

CANNA_MODE_ZenKataKakuteiMode

全角カタカナ確定入力モード

CANNA_MODE_HanKataKakuteiMode

半角カタカナ確定入力モード

CANNA_MODE_ZenAlphaKakuteiMode

全角アルファベット確定入力モード

CANNA_MODE_HanAlphaKakuteiMode

半角アルファベット確定入力モード

CANNA_MODE_HexMode

16進コード入力モード

CANNA_MODE_BushuMode

部首入力モード

CANNA_MODE_TorokuMode

単語登録モード

この機能によりモードを変更するとモード名を始めとして多くの表示が変化を 受けます．表示の変更はargとして指定したXKanjiStatusWithValue構造体に て返されます．

(例)

  XKanjiStatus ks;


  XKanjiStatusWithValue ksv;


  unsigned char buf[SOMESIZE];


  .....


  ksv.ks = &ks;


  ksv.buffer = buf;


  ksv.bytes_buffer = SOMESIZE;


  ksv.val = CANNA_MODE_HexMode;


  XKanjiControl(dpy, win, KC_CHANGEMODE, &ksv);


  len = ksv.val;


  .....


  /* 未確定文字列や確定文字列の情報がksvにより返されます． */

候補一覧のために用いられる領域のコラム数を指定します．１コラムの幅はア ルファベット文字あるいは半角カタカナ１文字の文字幅であり，全角漢字は２ コラム占めることになります．候補一覧表示のための幅を 指定するためにrequest部分に指定する値はKC_SETWIDTHで， このときargにコラム数を指定します．

(例)

  XKanjiControl(dpy, win, KC_SETWIDTH, (char *)60);

プログラムを終了するなどの局面でかな漢字変換も終了することを指定します． かな漢字変換処理を終了させる時は必ずこの処理を行って下さい．終わるにあ たって今まで学習した内容がファイルに登録されます．request部分に はKC_FINALIZEを指定します．

正常終了時に0，異常終了時に-1が戻り値として返ります．

KC_FINALIZEを行った場合，エラーとまでいかなくとも何らかのwarningが発生 することがあります．warningが発生した場合はargにて与えられた 変数にwarning文字列の配列へのポインタが格納され返されます．warningがな い場合にはNULLポインタが格納され返されます．

(例)

int res; /* エラーが返る場合に備える */
char **warning;
.....
res = XKanjiControl(dpy, win, KC_FINALIZE, &warning);
if (warning) {
char **p;

for (p = warning ; *p ; p++) {
fprintf(stderr, "%s0, *p);
}
}

第4引数に返されるwarningメッセージは，ライブラリの内部でmallocされま す．これは，次にKC_INITIALIZEやKC_FINALIZEが行われた時に開放されます． アプリケーションプログラマが勝手にfreeしてはいけません．

warningは今のところ最大64メッセージに限定されます．それ以上のメッセー ジは切捨てられます．

メッセージに含まれる可能性のあるwarningには次のものがあります．

・

辞書がアンマウントできない．

第4引数としてNULLを指定した場合，warningメッセージは捨てられます．

読みを入力している状態でC-tを打ったときのように未定義キーを入力した時 に取られる処理を指定します．未定義キーに対応して行われる処理としては以 下の処理があります．

マクロ名

処理

kc_normal

ビープ

kc_through

アプリケーションプログラムに渡す

kc_kakutei

確定しアプリケーションプログラムに渡す

kc_kill

消去しアプリケーションプログラムに渡す

kc_normalを指定した場合，外部変数jrBeepFuncに設定された関数が未定義キー 入力時にライブラリによって自動的に呼び出されます．jrBeepFuncに値を設定 しない場合には(jrBeepFunc == NULLの場合には)何も起こりません．

(例)

  extern (*jrBeepFunc)(), beep();


  jrBeepFunc = beep;


  XKanjiControl(dpy, win, KC_SETUNDEFKEYFUNCTION, kc_normal);

モード情報を文字列ではなくビットマップなどのデータで表示したい場合があ ります．そのような場合にはモード情報として数値データが返ってくると処理 がしやすくなります．XKanjiControlでKC_SETMODEINFOSTYLEを 指定し，argに１を渡すことによってそれ以後はXKanjiStatus構造体 のmodeメンバにはモードを表す数値に'@'(0x40)を加えた１文字が返さ れるようになります．モードを表す数値に変換する場合には返ってきた文字列 から'@'(0x40)を引きます．モードを表す数値については入力モードの 変更((2)KC_CHANGEMODE)のこうを参照して下さい．

入力中の文字列を何らかの都合で放棄したい場合があります．放棄する場合に 入力中の文字列を確定文字列として取り込んでから放棄したい場合と全く捨て てしまってから放棄したい場合があります．確定する 場合にはXKanjiControlにてKC_KAKUTEIを指定し，放棄する 場合にはKC_KILLを指定します．

この処理は表示に影響を与えるので第4引数にはXKanjiStatusWithValue構造 体を指定しなければなりません．

  XKanjiStatusWithValue ksv;


  XKanjiStatus ks;


  unsigned char buf[SOMESIZE];


  .....


  ksv.ks = &ks;


  ksv.buffer = buf;


  ksv.bytes_buffer = SOMESIZE;


  XKanjiControl(dpy, win, KC_KAKUTEI, &ksv);


  len = ksv.val;


  .....

現在のモードを問い合わせるにはXKanjiControlでKC_QUERYMODEを指定します．

第4引数にはモード文字列を格納するための文字配列のポインタを指定します． モード文字列はヌル文字で終わる文字列です．ここに数値が返るようにするに はXKanjiControlでKC_SETMODEINFOSTYLEを指定してモード文字列のスタイル を変更しておきます．

(例)

  char currentMode[MAXMODELEN];


  .....


  XKanjiControl(dpy, win, KC_QUERYMODE, currentMode);


  .....

かな漢字変換サーバとしてどのサーバを使うかをアプリケーションプログラム を終了することなしに切替えることが可能です．かな漢字変換サーバとして接 続するべきサーバを指定するにはXKanjiControlでKC_SETSERVERNAMEを指定し ます．第4引数には接続したいサーバ名を指定します．

カスタマイズファイルをアプリケーションプログラム側から変更することがで きます．カスタマイズファイルの変更はXKanjiControlの 第3引数にKC_SETINITFILENAMEを指定し，第4引数にファイル名文字列を指定 することにより行います．この処理を行う場合はKC_INITIALIZEに先立って実 行しておかなければなりません．

(例)

  char *inifile = "app-own.canna"


  .....


  XKanjiControl(dpy, win, KC_SETINITFILENAME, initfile);


  .....

XKanjiControlやXKanjiStringを呼び出すと，dpy, winの組み合わせに 対してひとつの変換コンテクストを割り当てます． 今まで使われていないdpy, winの 組み合わせをXKanjiStringあるいはXKanjiControlに与えることが可能 であり，その場合，そのウィンドウ用に新たにコンテクストが作成され必要なメ モリが確保されます．

それまで使用していたウィンドウが使われなくなった場合に，そのウィンドウに割 り当てて使っていたコンテクスト用に確保されたメモリを 開放するにはXKanjiControlを第3引数にKC_CLOSEUICONTEXTを指定して呼び 出します．

この処理は表示の変化をともなうので第4引数にはXKanjiStatusWithValue構 造体を与えます．

(例)

  XKanjiStatusWithValue ksv;


  XKanjiStatus ks;


  unsigned char buf[SOMESIZE];


  .....


  ksv.ks = &ks;


  ksv.buffer = buf;


  ksv.bytes_buffer = SOMESIZE;


  XKanjiControl(dpy, win, KC_CLOSEUICONTEXT, &ksv);


  .....

初期化ファイルにてモード表示文字列がカスタマイズできますが，カスタマイ ズされた結果モード表示文字列にどれだけの表示領域を確保するかを調べる必 要がある場合があります．XKanjiControlを第3引数にKC_QUERYMAXMODESTRを 指定して呼び出すことにより，モード表示文字列として何コラム必要かが返り 値として返されます．ここで言うコラムとは半角英数文字の文字幅を１とした ときの値を示します．

第4引数は用いられないのでダミー値として0を与えます．

(例)

  int max_mode_columns;


  .....


  max_mode_columns = XKanjiControl(dpy, win, KC_QUERYMAXMODESTR, 0);


  .....