source: trunk/pymigemo/README.ja @ 21

Revision 21, 4.9 KB checked in by atzm, 18 years ago (diff)
  • Add pymigemo
  • Property svn:keywords set to Id
Line 
1PyMigemo 0.1
2============
3Atzm WATANABE (10/12/'05)
4
5これは䜕
6----------
7C/Migemo を Python から䜿うためのラッパヌです
8
9必芁なもの
10----------
11C/Migemo ラむブラリがむンストヌルされおいるこずが
12前提ずなっおいたすラむブラリ怜玢パスに migemo.so
13がヘッダ怜玢パスに migemo.h が存圚するこずを確認
14しお䞋さい
15
16むンストヌル方法
17----------------
18同梱の setup.py を利甚しお䞋さい
19
20 $ ./setup.py build
21 # ./setup.py install
22
23ラむセンス
24----------
25FreeBSD スタむルラむセンスに準拠したす
26
27䜿い方
28------
29Python むンタプリタ䞊で migemo を import しお䞋さい
30
31リファレンス
32- - - - - - -
33モゞュヌルコンテンツ
34 * VERSION
35    ** MIGEMO_VERSION
36        C/Migemo のバヌゞョン
37
38    ** PYMIGEMO_VERSION
39        PyMigemo のバヌゞョン
40
41 * DICTID
42    埌述の load メ゜ッドで䜿う蟞曞 ID
43
44    ** DICTID_MIGEMO
45        migemo-dict 蟞曞
46
47    ** DICTID_ROMA2HIRA
48        ロヌマ字→平仮名倉換衚
49
50    ** DICTID_HIRA2KATA
51        平仮名→カタカナ倉換衚
52
53    ** DICTID_HAN2ZEN
54        半角→党角倉換衚
55
56    ** DICTID_ZEN2HAN
57        党角→半角倉換衚
58
59    ** DICTID_INVALID
60        load メ゜ッドで蟞曞の読み蟌みに倱敗した堎合に返る
61
62 * OPINDEX
63    埌述の Migemo.set_operatorMigemo.get_operator メ゜ッドで䜿う
64    むンデクス
65
66    ** OPINDEX_OR
67        論理和デフォルトは "|"
68
69    ** OPINDEX_NEST_IN
70        グルヌピング時の開き括匧
71        Migemo.get_operator() に枡した際のデフォルトは "("
72
73    ** OPINDEX_NEST_OUT
74        グルヌピング時の閉じ括匧
75        Migemo.get_operator() に枡した際のデフォルトは ")"
76
77    ** OPINDEX_SELECT_IN
78        遞択の開始を衚す開き鈎括匧
79        Migemo.get_operator() に枡した際のデフォルトは "["
80
81    ** OPINDEX_SELECT_OUT
82        遞択の終了を衚す閉じ鈎括匧
83        Migemo.get_operator() に枡した際のデフォルトは "]"
84
85    ** OPINDEX_NEWLINE
86        各文字の間に挿入される「0 個以䞊の空癜もしくは改行にマッチする」
87        パタヌン
88        Migemo.get_operator() に枡した際のデフォルトは "" (空文字列)
89
90 * Migemo クラス
91    ** __init__(dictionary)
92        Migemo クラスのコンストラクタ
93        *** 匕数
94             dictionary: migemo-dict 蟞曞ファむルのパス (str)
95
96    ** get_encoding()
97        migemo-dict 蟞曞の゚ンコヌディングを str で返す
98        䟋えば EUC-JP で曞かれた蟞曞であれば "euc_jp" が返る
99        cp932euc_jputf8 のいずれかを返すが蟞曞の゚ンコヌディングがこ
100        れらに該圓しなかった堎合はファむルシステムのデフォルト゚ンコヌディ
101        ングを返す
102        *** 匕数
103             ãªã—
104        *** 返り倀
105             ã‚šãƒ³ã‚³ãƒŒãƒ‡ã‚£ãƒ³ã‚°æ–‡å­—列 (str)
106
107    ** get_operator(index)
108        index で指定された正芏衚珟に䜿甚するメタ文字を返す (str)
109        *** 匕数
110             index: 前述の OPINDEX のいずれか
111        *** 返り倀
112             ãƒ¡ã‚¿æ–‡å­—列 (str)
113
114    ** is_enable()
115        Migemo 内郚に正垞に蟞曞が読み蟌めおいるかどうかをチェックする
116        *** 匕数
117             ãªã—
118        *** 返り倀
119             çœŸåœå€€ (int) : 正垞に読み蟌めおいる堎合に真
120
121    ** load(dict_id, dict_file)
122        Migemo オブゞェクトに蟞曞を远加で読み蟌む
123        *** 匕数
124             dict_id: 前述の DICTID のいずれか
125             dict_file: 蟞曞ファむルのパス
126        *** 返り倀
127             èª­ã¿èŸŒã‚“だ蟞曞の DICTID
128             èª­ã¿èŸŒã¿ã«å€±æ•—した堎合 DICTID_INVALID が返る
129
130    ** query(query)
131        query で䞎えられた文字列から日本語怜玢のための正芏衚珟を返す
132        *** 匕数
133             query: 問い合わせる文字列 (Unicode or str)
134                    str で ascii 以倖の文字列を枡す堎合蟞曞ず同じ゚ン
135                    コヌディングの文字列でないず゚ラヌになる可胜性がある
136        *** 返り倀
137             æ­£èŠè¡šçŸæ–‡å­—列 (Unicode)
138
139    ** set_operator(index, op)
140        index で指定された正芏衚珟に䜿甚するメタ文字を op に倉曎する
141        *** 匕数
142             index: 前述の OPINDEX のいずれか
143             op: メタ文字列 (str)
144        *** 返り倀
145             çœŸåœå€€ (int) : 成功時に真
146
147䜜者
148----
149Atzm WATANABE <sitosito@p.chan.ne.jp>
150
151本゜フトりェアに察するコメントバグ報告パッチなどは倧いに歓迎
152したす䞊蚘のメヌルアドレスたでお気軜にお寄せ䞋さい
153
154$Id$
Note: See TracBrowser for help on using the repository browser.