Back to index

php5  5.3.10
mbfilter.h
Go to the documentation of this file.
00001 /* charset=UTF-8
00002  * vim: encoding=utf-8:
00003  * */
00004 
00005 /*
00006  * "streamable kanji code filter and converter"
00007  *
00008  * Copyright (c) 1998,1999,2000,2001 HappySize, Inc. All rights reserved.
00009  *
00010  * This software is released under the GNU Lesser General Public License.
00011  * (Version 2.1, February 1999)
00012  * Please read the following detail of the licence (in japanese).
00013  *
00014  * ◆使用許諾条件◆
00015  *
00016  * このソフトウェアは株式会社ハッピーサイズによって開発されました。株式会社ハッ
00017  * ピーサイズは、著作権法および万国著作権条約の定めにより、このソフトウェアに関
00018  * するすべての権利を留保する権利を持ち、ここに行使します。株式会社ハッピーサイ
00019  * ズは以下に明記した条件に従って、このソフトウェアを使用する排他的ではない権利
00020  * をお客様に許諾します。何人たりとも、以下の条件に反してこのソフトウェアを使用
00021  * することはできません。
00022  *
00023  * このソフトウェアを「GNU Lesser General Public License (Version 2.1, February
00024  * 1999)」に示された条件で使用することを、全ての方に許諾します。「GNU Lesser
00025  * General Public License」を満たさない使用には、株式会社ハッピーサイズから書面
00026  * による許諾を得る必要があります。
00027  *
00028  * 「GNU Lesser General Public License」の全文は以下のウェブページから取得でき
00029  * ます。「GNU Lesser General Public License」とは、これまでLibrary General
00030  * Public Licenseと呼ばれていたものです。
00031  *     http://www.gnu.org/ --- GNUウェブサイト
00032  *     http://www.gnu.org/copyleft/lesser.html --- ライセンス文面
00033  * このライセンスの内容がわからない方、守れない方には使用を許諾しません。
00034  *
00035  * しかしながら、当社とGNUプロジェクトとの特定の関係を示唆または主張するもので
00036  * はありません。
00037  *
00038  * ◆保証内容◆
00039  *
00040  * このソフトウェアは、期待された動作・機能・性能を持つことを目標として設計され
00041  * 開発されていますが、これを保証するものではありません。このソフトウェアは「こ
00042  * のまま」の状態で提供されており、たとえばこのソフトウェアの有用性ないし特定の
00043  * 目的に合致することといった、何らかの保証内容が、明示されたり暗黙に示されてい
00044  * る場合であっても、その保証は無効です。このソフトウェアを使用した結果ないし使
00045  * 用しなかった結果によって、直接あるいは間接に受けた身体的な傷害、財産上の損害
00046  * 、データの損失あるいはその他の全ての損害については、その損害の可能性が使用者
00047  * 、当社あるいは第三者によって警告されていた場合であっても、当社はその損害の賠
00048  * 償および補填を行いません。この規定は他の全ての、書面上または書面に無い保証・
00049  * 契約・規定に優先します。
00050  *
00051  * ◆著作権者の連絡先および使用条件についての問い合わせ先◆
00052  *
00053  * 〒102-0073
00054  * 東京都千代田区九段北1-13-5日本地所第一ビル4F
00055  * 株式会社ハッピーサイズ
00056  * Phone: 03-3512-3655, Fax: 03-3512-3656
00057  * Email: sales@happysize.co.jp
00058  * Web: http://happysize.com/
00059  *
00060  * ◆著者◆
00061  *
00062  * 金本 茂 <sgk@happysize.co.jp>
00063  *
00064  * ◆履歴◆
00065  *
00066  * 1998/11/10 sgk implementation in C++
00067  * 1999/4/25  sgk Cで書きなおし。
00068  * 1999/4/26  sgk 入力フィルタを実装。漢字コードを推定しながらフィルタを追加。
00069  * 1999/6/??      Unicodeサポート。
00070  * 1999/6/22  sgk ライセンスをLGPLに変更。
00071  *
00072  */
00073 
00074 /* 
00075  * Unicode support
00076  *
00077  * Portions copyright (c) 1999,2000,2001 by the PHP3 internationalization team.
00078  * All rights reserved.
00079  *
00080  */
00081 
00082 /*
00083  *
00084  * streamable kanji code filter and converter
00085  *    mbfl : Multi Byte FiLter Liblary
00086  *
00087  */
00088 
00089 #ifndef MBFL_MBFILTER_H
00090 #define MBFL_MBFILTER_H
00091 
00092 #include "mbfl_defs.h"
00093 #include "mbfl_consts.h"
00094 #include "mbfl_allocators.h"
00095 #include "mbfl_encoding.h"
00096 #include "mbfl_language.h"
00097 #include "mbfl_string.h"
00098 #include "mbfl_convert.h"
00099 #include "mbfl_ident.h"
00100 
00101 /*
00102  * version information
00103  */
00104 #define MBFL_VERSION_MAJOR 1
00105 #define MBFL_VERSION_MINOR 1
00106 #define MBFL_VERSION_TEENY 0
00107 
00108 /*
00109  * convert filter
00110  */
00111 #define MBFL_OUTPUTFILTER_ILLEGAL_MODE_NONE 0
00112 #define MBFL_OUTPUTFILTER_ILLEGAL_MODE_CHAR 1
00113 #define MBFL_OUTPUTFILTER_ILLEGAL_MODE_LONG 2
00114 #define MBFL_OUTPUTFILTER_ILLEGAL_MODE_ENTITY 3
00115 
00116 /*
00117  * buffering converter
00118  */
00119 typedef struct _mbfl_buffer_converter mbfl_buffer_converter;
00120 
00121 struct _mbfl_buffer_converter {
00122        mbfl_convert_filter *filter1;
00123        mbfl_convert_filter *filter2;
00124        mbfl_memory_device device;
00125        const mbfl_encoding *from;
00126        const mbfl_encoding *to;
00127 };
00128 
00129 MBFLAPI extern mbfl_buffer_converter * mbfl_buffer_converter_new(enum mbfl_no_encoding from, enum mbfl_no_encoding to, int buf_initsz);
00130 MBFLAPI extern void mbfl_buffer_converter_delete(mbfl_buffer_converter *convd);
00131 MBFLAPI extern void mbfl_buffer_converter_reset(mbfl_buffer_converter *convd);
00132 MBFLAPI extern int mbfl_buffer_converter_illegal_mode(mbfl_buffer_converter *convd, int mode);
00133 MBFLAPI extern int mbfl_buffer_converter_illegal_substchar(mbfl_buffer_converter *convd, int substchar);
00134 MBFLAPI extern int mbfl_buffer_converter_strncat(mbfl_buffer_converter *convd, const unsigned char *p, int n);
00135 MBFLAPI extern int mbfl_buffer_converter_feed(mbfl_buffer_converter *convd, mbfl_string *string);
00136 MBFLAPI extern int mbfl_buffer_converter_flush(mbfl_buffer_converter *convd);
00137 MBFLAPI extern mbfl_string * mbfl_buffer_converter_getbuffer(mbfl_buffer_converter *convd, mbfl_string *result);
00138 MBFLAPI extern mbfl_string * mbfl_buffer_converter_result(mbfl_buffer_converter *convd, mbfl_string *result);
00139 MBFLAPI extern mbfl_string * mbfl_buffer_converter_feed_result(mbfl_buffer_converter *convd, mbfl_string *string, mbfl_string *result);
00140 MBFLAPI extern int mbfl_buffer_illegalchars(mbfl_buffer_converter *convd);
00141 
00142 /*
00143  * encoding detector
00144  */
00145 typedef struct _mbfl_encoding_detector mbfl_encoding_detector;
00146 
00147 struct _mbfl_encoding_detector {
00148        mbfl_identify_filter **filter_list;
00149        int filter_list_size;
00150        int strict;
00151 };
00152 
00153 MBFLAPI extern mbfl_encoding_detector * mbfl_encoding_detector_new(enum mbfl_no_encoding *elist, int elistsz, int strict);
00154 MBFLAPI extern void mbfl_encoding_detector_delete(mbfl_encoding_detector *identd);
00155 MBFLAPI extern int mbfl_encoding_detector_feed(mbfl_encoding_detector *identd, mbfl_string *string);
00156 MBFLAPI extern enum mbfl_no_encoding mbfl_encoding_detector_judge(mbfl_encoding_detector *identd);
00157 
00158 
00159 /*
00160  * encoding converter
00161  */
00162 MBFLAPI extern mbfl_string *
00163 mbfl_convert_encoding(mbfl_string *string, mbfl_string *result, enum mbfl_no_encoding toenc);
00164 
00165 
00166 /*
00167  * identify encoding
00168  */
00169 MBFLAPI extern const mbfl_encoding *
00170 mbfl_identify_encoding(mbfl_string *string, enum mbfl_no_encoding *elist, int elistsz, int strict);
00171 
00172 MBFLAPI extern const char *
00173 mbfl_identify_encoding_name(mbfl_string *string, enum mbfl_no_encoding *elist, int elistsz, int strict);
00174 
00175 MBFLAPI extern enum mbfl_no_encoding
00176 mbfl_identify_encoding_no(mbfl_string *string, enum mbfl_no_encoding *elist, int elistsz, int strict);
00177 
00178 /*
00179  * strlen
00180  */
00181 MBFLAPI extern int
00182 mbfl_strlen(mbfl_string *string);
00183 
00184 /*
00185  * oddlen
00186  */
00187 MBFLAPI extern int
00188 mbfl_oddlen(mbfl_string *string);
00189 
00190 /*
00191  * strpos
00192  */
00193 MBFLAPI extern int
00194 mbfl_strpos(mbfl_string *haystack, mbfl_string *needle, int offset, int reverse);
00195 
00196 
00197 /*
00198  * substr_count
00199  */
00200 MBFLAPI extern int
00201 mbfl_substr_count(mbfl_string *haystack, mbfl_string *needle);
00202 
00203 /*
00204  * substr
00205  */
00206 MBFLAPI extern mbfl_string *
00207 mbfl_substr(mbfl_string *string, mbfl_string *result, int from, int length);
00208 
00209 /*
00210  * strcut
00211  */
00212 MBFLAPI extern mbfl_string *
00213 mbfl_strcut(mbfl_string *string, mbfl_string *result, int from, int length);
00214 
00215 /*
00216  *  strwidth
00217  */
00218 MBFLAPI extern int
00219 mbfl_strwidth(mbfl_string *string);
00220 
00221 /*
00222  *  strimwidth
00223  */
00224 MBFLAPI extern mbfl_string *
00225 mbfl_strimwidth(mbfl_string *string, mbfl_string *marker, mbfl_string *result, int from, int width);
00226 
00227 /*
00228  * MIME header encode
00229  */
00230 struct mime_header_encoder_data;   /* forward declaration */
00231 
00232 MBFLAPI extern struct mime_header_encoder_data *
00233 mime_header_encoder_new(
00234     enum mbfl_no_encoding incode,
00235     enum mbfl_no_encoding outcode,
00236     enum mbfl_no_encoding encoding);
00237 
00238 MBFLAPI extern void
00239 mime_header_encoder_delete(struct mime_header_encoder_data *pe);
00240 
00241 MBFLAPI extern int
00242 mime_header_encoder_feed(int c, struct mime_header_encoder_data *pe);
00243 
00244 MBFLAPI extern mbfl_string *
00245 mime_header_encoder_result(struct mime_header_encoder_data *pe, mbfl_string *result);
00246 
00247 MBFLAPI extern mbfl_string *
00248 mbfl_mime_header_encode(
00249     mbfl_string *string, mbfl_string *result,
00250     enum mbfl_no_encoding outcode,
00251     enum mbfl_no_encoding encoding,
00252     const char *linefeed,
00253     int indent);
00254 
00255 /*
00256  * MIME header decode
00257  */
00258 struct mime_header_decoder_data;   /* forward declaration */
00259 
00260 MBFLAPI extern struct mime_header_decoder_data *
00261 mime_header_decoder_new(enum mbfl_no_encoding outcode);
00262 
00263 MBFLAPI extern void
00264 mime_header_decoder_delete(struct mime_header_decoder_data *pd);
00265 
00266 MBFLAPI extern int
00267 mime_header_decoder_feed(int c, struct mime_header_decoder_data *pd);
00268 
00269 MBFLAPI extern mbfl_string *
00270 mime_header_decoder_result(struct mime_header_decoder_data *pd, mbfl_string *result);
00271 
00272 MBFLAPI extern mbfl_string *
00273 mbfl_mime_header_decode(
00274     mbfl_string *string,
00275     mbfl_string *result,
00276     enum mbfl_no_encoding outcode);
00277 
00278 /*
00279  * convert HTML numeric entity
00280  */
00281 MBFLAPI extern mbfl_string *
00282 mbfl_html_numeric_entity(mbfl_string *string, mbfl_string *result, int *convmap, int mapsize, int type);
00283 
00284 /*
00285  * convert of harfwidth and fullwidth for japanese
00286  */
00287 MBFLAPI extern mbfl_string *
00288 mbfl_ja_jp_hantozen(mbfl_string *string, mbfl_string *result, int mode);
00289 
00290 #endif /* MBFL_MBFILTER_H */