m17n データベースにとそれに関する API. [詳解]

型定義
typedef struct MDatabase	MDatabase
	データベースの型宣言.

関数
MDatabase *	mdatabase_find (MSymbol tag0, MSymbol tag1, MSymbol tag2, MSymbol tag3)
	データベース中のデータを探す.

MPlist *	mdatabase_list (MSymbol tag0, MSymbol tag1, MSymbol tag2, MSymbol tag3)
	m17n データベースのデータリストを返す.

MDatabase *	mdatabase_define (MSymbol tag0, MSymbol tag1, MSymbol tag2, MSymbol tag3, void (loader)(MSymbol , void ), void *extra_info)
	m17n データベースのデータを定義する.

void *	mdatabase_load (MDatabase *mdb)
	データベースからデータをロードする.

MSymbol *	mdatabase_tag (MDatabase *mdb)
	データのタグを得る.

変数
char *	mdatabase_dir

詳解

m17n データベースにとそれに関する API.

アプリケーション固有のデータ用ディレクトリ.

m17n ライブラリは必要に応じて動的に m17n データベース から情報を取得する。またアプリケーションプログラムも、独自のデータを m17n データベースに追加し、それを動的に取得することができる。アプリケーションプログラムが独自のデータを追加・取得するには、変数 mdatabase_dir にそのアプリケーション固有のディレクトリをセットし、その中にデータを格納する。ユーザがそのデータをオーバーライトしたいときは、環境変数 "M17NDIR" で指定されるディレクトリ（指定されていないときは "~/.m17n.d" というディレクトリ）に別のデータを置く。

m17n データベースには複数の多様なデータが含まれており、各データは TAG0, TAG1, TAG2, TAG3（すべてシンボル）の４つのタグによって識別される。

TAG0 によって、データベース内のデータのタイプは次のように指定される。

TAG0 が Mchar_table であるデータは chartableタイプ と呼ばれ、各文字に関する情報を提供する。この場合 TAG1 は情報の種類を指定するシンボルであり、::Msymbol, Minteger, Mstring, Mtext, Mplist のいずれかである。TAG2 と TAG3 は任意のシンボルでよい。

TAG0 が Mcharset であるデータは charsetタイプ と呼ばれ、文字セット用のデコード／エンコードマップを提供する。この場合 TAG1 は文字セットのシンボルでなければならない。TAG2 と TAG3 は任意のシンボルでよい。

TAG0 が Mchar_table でも Mcharset でもない場合、そのデータは plistタイプ である。詳細に関しては関数 mdatabase_load() の説明を参照のこと。この場合 TAG1、TAG2、TAG3 は任意のシンボルでよい。

特定のタグを持つデータベースを <TAG0, TAG1, TAG2, TAG3> という形式で表す。

アプリケーションプログラムは、まず関数 mdatabase_find() を使ってデータベースに関する情報を保持するオブジェクト（::MDatabase 型）へのポインタを得る。それに成功したら、 mdatabase_load() によって実際にデータベースをロードする。構造体 MDatabase 自身がどう実装されているかは、アプリケーションプログラムからは見えない。

アプリケーションプログラムが、そのプログラム固有のデータや m17n データベースを上書きするデータを提供する場合には、マクロ M17N_INIT() を呼ぶ前にこの変数をデータファイルを含むディレクトリ名にセットしなくてはならない。ディレクトリには "mdb.dir" ファイルをおくことができる。その"mdb.dir"ファイルには、 mdbDir(5) で説明されているフォーマットでデータ定義のリストを記述する。

デフォルトの値は NULL である。

型定義詳解

◆ MDatabase

typedef struct MDatabase MDatabase

データベースの型宣言.

MDatabase 型はデータベースオブジェクト用の構造体である。内部構造はアプリケーションプログラムからは見えない。

関数詳解

◆ mdatabase_find()

MDatabase * mdatabase_find	(	MSymbol	tag0,
		MSymbol	tag1,
		MSymbol	tag2,
		MSymbol	tag3
	)

データベース中のデータを探す.

関数 mdatabase_find() は、 m17n 言語情報ベース中で tag0 から tag3 までのタグを持つデータを探し、それへのポインタを返す。そのようなデータがなければ NULL を返す。

◆ mdatabase_list()

MPlist * mdatabase_list	(	MSymbol	tag0,
		MSymbol	tag1,
		MSymbol	tag2,
		MSymbol	tag3
	)

m17n データベースのデータリストを返す.

関数 mdatabase_list() は m17n データベース中から tag0 からtag3 までのタグを持つデータを探し、そのリストをplist として返す。 tagn が Mnil であった場合には、任意のタグにマッチするワイルドカードとして取り扱われる。返される plist の各要素はキーとして Mt を、値として MDatabase 型へのポインタを持つ。

◆ mdatabase_define()

MDatabase * mdatabase_define	(	MSymbol	tag0,
		MSymbol	tag1,
		MSymbol	tag2,
		MSymbol	tag3,
		void ()(MSymbol , void )	loader,
		void *	extra_info
	)

m17n データベースのデータを定義する.

関数 mdatabase_define() は tag0 から tag3 までのタグおよび付加情報 extra_info を持つデータを定義する。

loader はそのデータのロードに用いられる関数へのポインタである。この関数は mdatabase_load() から tags と extra_info という二つの引数付きで呼び出される。ここで tags は tag0 から tag3 までの配列である。

もし loader が NULL なら、m17n ライブラリ標準のローダが使われる。この場合には extra_info はデータを含むファイル名でなくてはならない。