root/ext/mbstring/libmbfl/mbfl/mbfilter.h

INCLUDED FROM

/* charset=UTF-8
 * vim: encoding=utf-8:
 * */

/*
 * "streamable kanji code filter and converter"
 *
 * Copyright (c) 1998,1999,2000,2001 HappySize, Inc. All rights reserved.
 *
 * This software is released under the GNU Lesser General Public License.
 * (Version 2.1, February 1999)
 * Please read the following detail of the licence (in japanese).
 *
 * 笳�ｽｿ逕ｨ險ｱ隲ｾ譚｡莉ｶ笳�
 *
 * 縺薙�繧ｽ繝輔ヨ繧ｦ繧ｧ繧｢縺ｯ譬ｪ蠑丈ｼ夂､ｾ繝上ャ繝斐�繧ｵ繧､繧ｺ縺ｫ繧医▲縺ｦ髢狗匱縺輔ｌ縺ｾ縺励◆縲よ�ｪ蠑丈ｼ夂､ｾ繝上ャ
 * 繝斐�繧ｵ繧､繧ｺ縺ｯ縲∬送菴懈ｨｩ豕輔♀繧医�荳�嵜闡嶺ｽ懈ｨｩ譚｡邏��螳壹ａ縺ｫ繧医ｊ縲√％縺ｮ繧ｽ繝輔ヨ繧ｦ繧ｧ繧｢縺ｫ髢｢
 * 縺吶ｋ縺吶∋縺ｦ縺ｮ讓ｩ蛻ｩ繧堤蕗菫昴☆繧区ｨｩ蛻ｩ繧呈戟縺｡縲√％縺薙↓陦御ｽｿ縺励∪縺吶€よ�ｪ蠑丈ｼ夂､ｾ繝上ャ繝斐�繧ｵ繧､
 * 繧ｺ縺ｯ莉･荳九↓譏手ｨ倥＠縺滓擅莉ｶ縺ｫ蠕薙▲縺ｦ縲√％縺ｮ繧ｽ繝輔ヨ繧ｦ繧ｧ繧｢繧剃ｽｿ逕ｨ縺吶ｋ謗剃ｻ也噪縺ｧ縺ｯ縺ｪ縺�ｨｩ蛻ｩ
 * 繧偵♀螳｢讒倥↓險ｱ隲ｾ縺励∪縺吶€ゆｽ穂ｺｺ縺溘ｊ縺ｨ繧ゅ€∽ｻ･荳九�譚｡莉ｶ縺ｫ蜿阪＠縺ｦ縺薙�繧ｽ繝輔ヨ繧ｦ繧ｧ繧｢繧剃ｽｿ逕ｨ
 * 縺吶ｋ縺薙→縺ｯ縺ｧ縺阪∪縺帙ｓ縲�
 *
 * 縺薙�繧ｽ繝輔ヨ繧ｦ繧ｧ繧｢繧偵€隈NU Lesser General Public License (Version 2.1, February
 * 1999)縲阪↓遉ｺ縺輔ｌ縺滓擅莉ｶ縺ｧ菴ｿ逕ｨ縺吶ｋ縺薙→繧偵€∝�縺ｦ縺ｮ譁ｹ縺ｫ險ｱ隲ｾ縺励∪縺吶€ゅ€隈NU Lesser
 * General Public License縲阪ｒ貅€縺溘＆縺ｪ縺�ｽｿ逕ｨ縺ｫ縺ｯ縲∵�ｪ蠑丈ｼ夂､ｾ繝上ャ繝斐�繧ｵ繧､繧ｺ縺九ｉ譖ｸ髱｢
 * 縺ｫ繧医ｋ險ｱ隲ｾ繧貞ｾ励ｋ蠢�ｦ√′縺ゅｊ縺ｾ縺吶€�
 *
 * 縲隈NU Lesser General Public License縲阪�蜈ｨ譁��莉･荳九�繧ｦ繧ｧ繝悶�繝ｼ繧ｸ縺九ｉ蜿門ｾ励〒縺�
 * 縺ｾ縺吶€ゅ€隈NU Lesser General Public License縲阪→縺ｯ縲√％繧後∪縺ｧLibrary General
 * Public License縺ｨ蜻ｼ縺ｰ繧後※縺�◆繧ゅ�縺ｧ縺吶€�
 *     http://www.gnu.org/ --- GNU繧ｦ繧ｧ繝悶し繧､繝�
 *     http://www.gnu.org/copyleft/lesser.html --- 繝ｩ繧､繧ｻ繝ｳ繧ｹ譁�擇
 * 縺薙�繝ｩ繧､繧ｻ繝ｳ繧ｹ縺ｮ蜀�ｮｹ縺後ｏ縺九ｉ縺ｪ縺�婿縲∝ｮ医ｌ縺ｪ縺�婿縺ｫ縺ｯ菴ｿ逕ｨ繧定ｨｱ隲ｾ縺励∪縺帙ｓ縲�
 *
 * 縺励°縺励↑縺後ｉ縲∝ｽ鍋､ｾ縺ｨGNU繝励Ο繧ｸ繧ｧ繧ｯ繝医→縺ｮ迚ｹ螳壹�髢｢菫ゅｒ遉ｺ蜚�∪縺溘�荳ｻ蠑ｵ縺吶ｋ繧ゅ�縺ｧ
 * 縺ｯ縺ゅｊ縺ｾ縺帙ｓ縲�
 *
 * 笳�ｿ晁ｨｼ蜀�ｮｹ笳�
 *
 * 縺薙�繧ｽ繝輔ヨ繧ｦ繧ｧ繧｢縺ｯ縲∵悄蠕�＆繧後◆蜍穂ｽ懊�讖溯�繝ｻ諤ｧ閭ｽ繧呈戟縺､縺薙→繧堤岼讓吶→縺励※險ｭ險医＆繧�
 * 髢狗匱縺輔ｌ縺ｦ縺�∪縺吶′縲√％繧後ｒ菫晁ｨｼ縺吶ｋ繧ゅ�縺ｧ縺ｯ縺ゅｊ縺ｾ縺帙ｓ縲ゅ％縺ｮ繧ｽ繝輔ヨ繧ｦ繧ｧ繧｢縺ｯ縲後％
 * 縺ｮ縺ｾ縺ｾ縲阪�迥ｶ諷九〒謠蝉ｾ帙＆繧後※縺翫ｊ縲√◆縺ｨ縺医�縺薙�繧ｽ繝輔ヨ繧ｦ繧ｧ繧｢縺ｮ譛臥畑諤ｧ縺ｪ縺�＠迚ｹ螳壹�
 * 逶ｮ逧�↓蜷郁�縺吶ｋ縺薙→縺ｨ縺�▲縺溘€∽ｽ輔ｉ縺九�菫晁ｨｼ蜀�ｮｹ縺後€∵�遉ｺ縺輔ｌ縺溘ｊ證鈴ｻ吶↓遉ｺ縺輔ｌ縺ｦ縺�
 * 繧句�ｴ蜷医〒縺ゅ▲縺ｦ繧ゅ€√◎縺ｮ菫晁ｨｼ縺ｯ辟｡蜉ｹ縺ｧ縺吶€ゅ％縺ｮ繧ｽ繝輔ヨ繧ｦ繧ｧ繧｢繧剃ｽｿ逕ｨ縺励◆邨先棡縺ｪ縺�＠菴ｿ
 * 逕ｨ縺励↑縺九▲縺溽ｵ先棡縺ｫ繧医▲縺ｦ縲∫峩謗･縺ゅｋ縺��髢捺磁縺ｫ蜿励￠縺溯ｺｫ菴鍋噪縺ｪ蛯ｷ螳ｳ縲∬ｲ｡逕｣荳翫�謳榊ｮｳ
 * 縲√ョ繝ｼ繧ｿ縺ｮ謳榊､ｱ縺ゅｋ縺��縺昴�莉悶�蜈ｨ縺ｦ縺ｮ謳榊ｮｳ縺ｫ縺､縺�※縺ｯ縲√◎縺ｮ謳榊ｮｳ縺ｮ蜿ｯ閭ｽ諤ｧ縺御ｽｿ逕ｨ閠�
 * 縲∝ｽ鍋､ｾ縺ゅｋ縺��隨ｬ荳芽€�↓繧医▲縺ｦ隴ｦ蜻翫＆繧後※縺�◆蝣ｴ蜷医〒縺ゅ▲縺ｦ繧ゅ€∝ｽ鍋､ｾ縺ｯ縺昴�謳榊ｮｳ縺ｮ雉�
 * 蜆溘♀繧医�陬懷｡ｫ繧定｡後＞縺ｾ縺帙ｓ縲ゅ％縺ｮ隕丞ｮ壹�莉悶�蜈ｨ縺ｦ縺ｮ縲∵嶌髱｢荳翫∪縺溘�譖ｸ髱｢縺ｫ辟｡縺�ｿ晁ｨｼ繝ｻ
 * 螂醍ｴ��隕丞ｮ壹↓蜆ｪ蜈医＠縺ｾ縺吶€�
 *
 * 笳�送菴懈ｨｩ閠��騾｣邨｡蜈医♀繧医�菴ｿ逕ｨ譚｡莉ｶ縺ｫ縺､縺�※縺ｮ蝠上＞蜷医ｏ縺帛�笳�
 *
 * 縲�102-0073
 * 譚ｱ莠ｬ驛ｽ蜊�ｻ｣逕ｰ蛹ｺ荵晄ｮｵ蛹�1-13-5譌･譛ｬ蝨ｰ謇€隨ｬ荳€繝薙Ν4F
 * 譬ｪ蠑丈ｼ夂､ｾ繝上ャ繝斐�繧ｵ繧､繧ｺ
 * Phone: 03-3512-3655, Fax: 03-3512-3656
 * Email: sales@happysize.co.jp
 * Web: http://happysize.com/
 *
 * 笳�送閠�螺
 *
 * 驥第悽縲€闌� <sgk@happysize.co.jp>
 *
 * 笳�ｱ･豁ｴ笳�
 *
 * 1998/11/10 sgk implementation in C++
 * 1999/4/25  sgk C縺ｧ譖ｸ縺阪↑縺翫＠縲�
 * 1999/4/26  sgk 蜈･蜉帙ヵ繧｣繝ｫ繧ｿ繧貞ｮ溯｣�€よｼ｢蟄励さ繝ｼ繝峨ｒ謗ｨ螳壹＠縺ｪ縺後ｉ繝輔ぅ繝ｫ繧ｿ繧定ｿｽ蜉�縲�
 * 1999/6/??      Unicode繧ｵ繝昴�繝医€�
 * 1999/6/22  sgk 繝ｩ繧､繧ｻ繝ｳ繧ｹ繧鱈GPL縺ｫ螟画峩縲�
 *
 */

/* 
 * Unicode support
 *
 * Portions copyright (c) 1999,2000,2001 by the PHP3 internationalization team.
 * All rights reserved.
 *
 */

/*
 *
 * streamable kanji code filter and converter
 *    mbfl : Multi Byte FiLter Liblary
 *
 */

#ifndef MBFL_MBFILTER_H
#define MBFL_MBFILTER_H

#include "mbfl_defs.h"
#include "mbfl_consts.h"
#include "mbfl_allocators.h"
#include "mbfl_encoding.h"
#include "mbfl_language.h"
#include "mbfl_string.h"
#include "mbfl_convert.h"
#include "mbfl_ident.h"

/*
 * version information
 */
#define MBFL_VERSION_MAJOR 1
#define MBFL_VERSION_MINOR 3
#define MBFL_VERSION_TEENY 2

/*
 * convert filter
 */
#define MBFL_OUTPUTFILTER_ILLEGAL_MODE_NONE 0
#define MBFL_OUTPUTFILTER_ILLEGAL_MODE_CHAR 1
#define MBFL_OUTPUTFILTER_ILLEGAL_MODE_LONG 2
#define MBFL_OUTPUTFILTER_ILLEGAL_MODE_ENTITY 3

/*
 * buffering converter
 */
typedef struct _mbfl_buffer_converter mbfl_buffer_converter;

struct _mbfl_buffer_converter {
        mbfl_convert_filter *filter1;
        mbfl_convert_filter *filter2;
        mbfl_memory_device device;
        const mbfl_encoding *from;
        const mbfl_encoding *to;
};

MBFLAPI extern mbfl_buffer_converter * mbfl_buffer_converter_new(enum mbfl_no_encoding from, enum mbfl_no_encoding to, int buf_initsz);
MBFLAPI extern mbfl_buffer_converter * mbfl_buffer_converter_new2(const mbfl_encoding *from, const mbfl_encoding *to, int buf_initsz);
MBFLAPI extern void mbfl_buffer_converter_delete(mbfl_buffer_converter *convd);
MBFLAPI extern void mbfl_buffer_converter_reset(mbfl_buffer_converter *convd);
MBFLAPI extern int mbfl_buffer_converter_illegal_mode(mbfl_buffer_converter *convd, int mode);
MBFLAPI extern int mbfl_buffer_converter_illegal_substchar(mbfl_buffer_converter *convd, int substchar);
MBFLAPI extern int mbfl_buffer_converter_strncat(mbfl_buffer_converter *convd, const unsigned char *p, int n);
MBFLAPI extern int mbfl_buffer_converter_feed(mbfl_buffer_converter *convd, mbfl_string *string);
MBFLAPI extern int mbfl_buffer_converter_feed2(mbfl_buffer_converter *convd, mbfl_string *string, int *loc);
MBFLAPI extern int mbfl_buffer_converter_flush(mbfl_buffer_converter *convd);
MBFLAPI extern mbfl_string * mbfl_buffer_converter_getbuffer(mbfl_buffer_converter *convd, mbfl_string *result);
MBFLAPI extern mbfl_string * mbfl_buffer_converter_result(mbfl_buffer_converter *convd, mbfl_string *result);
MBFLAPI extern mbfl_string * mbfl_buffer_converter_feed_result(mbfl_buffer_converter *convd, mbfl_string *string, mbfl_string *result);
MBFLAPI extern int mbfl_buffer_illegalchars(mbfl_buffer_converter *convd);

/*
 * encoding detector
 */
typedef struct _mbfl_encoding_detector mbfl_encoding_detector;

struct _mbfl_encoding_detector {
        mbfl_identify_filter **filter_list;
        int filter_list_size;
        int strict;
};

MBFLAPI extern mbfl_encoding_detector * mbfl_encoding_detector_new(enum mbfl_no_encoding *elist, int elistsz, int strict);
MBFLAPI extern mbfl_encoding_detector * mbfl_encoding_detector_new2(const mbfl_encoding **elist, int elistsz, int strict);
MBFLAPI extern void mbfl_encoding_detector_delete(mbfl_encoding_detector *identd);
MBFLAPI extern int mbfl_encoding_detector_feed(mbfl_encoding_detector *identd, mbfl_string *string);
MBFLAPI extern enum mbfl_no_encoding mbfl_encoding_detector_judge(mbfl_encoding_detector *identd);
MBFLAPI extern const mbfl_encoding *mbfl_encoding_detector_judge2(mbfl_encoding_detector *identd);


/*
 * encoding converter
 */
MBFLAPI extern mbfl_string *
mbfl_convert_encoding(mbfl_string *string, mbfl_string *result, enum mbfl_no_encoding toenc);


/*
 * identify encoding
 */
MBFLAPI extern const mbfl_encoding *
mbfl_identify_encoding(mbfl_string *string, enum mbfl_no_encoding *elist, int elistsz, int strict);

MBFLAPI extern const mbfl_encoding *
mbfl_identify_encoding2(mbfl_string *string, const mbfl_encoding **elist, int elistsz, int strict);
/*
 * strlen
 */
MBFLAPI extern int
mbfl_strlen(mbfl_string *string);

/*
 * oddlen
 */
MBFLAPI extern int
mbfl_oddlen(mbfl_string *string);

/*
 * strpos
 */
MBFLAPI extern int
mbfl_strpos(mbfl_string *haystack, mbfl_string *needle, int offset, int reverse);


/*
 * substr_count
 */
MBFLAPI extern int
mbfl_substr_count(mbfl_string *haystack, mbfl_string *needle);

/*
 * substr
 */
MBFLAPI extern mbfl_string *
mbfl_substr(mbfl_string *string, mbfl_string *result, int from, int length);

/*
 * strcut
 */
MBFLAPI extern mbfl_string *
mbfl_strcut(mbfl_string *string, mbfl_string *result, int from, int length);

/*
 *  strwidth
 */
MBFLAPI extern int
mbfl_strwidth(mbfl_string *string);

/*
 *  strimwidth
 */
MBFLAPI extern mbfl_string *
mbfl_strimwidth(mbfl_string *string, mbfl_string *marker, mbfl_string *result, int from, int width);

/*
 * MIME header encode
 */
struct mime_header_encoder_data;        /* forward declaration */

MBFLAPI extern struct mime_header_encoder_data *
mime_header_encoder_new(
    enum mbfl_no_encoding incode,
    enum mbfl_no_encoding outcode,
    enum mbfl_no_encoding encoding);

MBFLAPI extern void
mime_header_encoder_delete(struct mime_header_encoder_data *pe);

MBFLAPI extern int
mime_header_encoder_feed(int c, struct mime_header_encoder_data *pe);

MBFLAPI extern mbfl_string *
mime_header_encoder_result(struct mime_header_encoder_data *pe, mbfl_string *result);

MBFLAPI extern mbfl_string *
mbfl_mime_header_encode(
    mbfl_string *string, mbfl_string *result,
    enum mbfl_no_encoding outcode,
    enum mbfl_no_encoding encoding,
    const char *linefeed,
    int indent);

/*
 * MIME header decode
 */
struct mime_header_decoder_data;        /* forward declaration */

MBFLAPI extern struct mime_header_decoder_data *
mime_header_decoder_new(enum mbfl_no_encoding outcode);

MBFLAPI extern void
mime_header_decoder_delete(struct mime_header_decoder_data *pd);

MBFLAPI extern int
mime_header_decoder_feed(int c, struct mime_header_decoder_data *pd);

MBFLAPI extern mbfl_string *
mime_header_decoder_result(struct mime_header_decoder_data *pd, mbfl_string *result);

MBFLAPI extern mbfl_string *
mbfl_mime_header_decode(
    mbfl_string *string,
    mbfl_string *result,
    enum mbfl_no_encoding outcode);

/*
 * convert HTML numeric entity
 */
MBFLAPI extern mbfl_string *
mbfl_html_numeric_entity(mbfl_string *string, mbfl_string *result, int *convmap, int mapsize, int type);

/*
 * convert of harfwidth and fullwidth for japanese
 */
MBFLAPI extern mbfl_string *
mbfl_ja_jp_hantozen(mbfl_string *string, mbfl_string *result, int mode);

#endif  /* MBFL_MBFILTER_H */