Unihan_phonetic.h

Go to the documentation of this file.

/*
 * Copyright © 2008  Red Hat, Inc. All rights reserved.
 * Copyright © 2008  Ding-Yi Chen <dchen at redhat dot com>
 *
 * This file is part of the libUnihan Project.
 *
 * This library is free software; you can redistribute it and/or
 * modify it under the terms of the GNU Lesser General Public
 * License as published by the Free Software Foundation; either
 * version 2 of the License, or (at your option) any later version.
 *
 * This library is distributed in the hope that it will be useful,
 * but WITHOUT ANY WARRANTY; without even the implied warranty of
 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
 * GNU Lesser General Public License for more details.
 *
 * You should have received a copy of the GNU Lesser General Public
 * License along with this program; if not, write to the
 * Free Software Foundation, Inc., 59 Temple Place, Suite 330,
 * Boston, MA  02111-1307  USA
 */ 

#ifndef UNIHAN_PHONETIC_H_
#define UNIHAN_PHONETIC_H_

#include <sqlite3.h>
#include "Unihan_phonetic-private.h"

#define PINYIN_MAX_LENGTH 13

#define ZHUYIN_MAX_LENGTH 13

#define TRANSCRIPTION_MAX_LENGTH 13

typedef gunichar  ZhuyinSymbol;

typedef char Zhuyin;

typedef char Pinyin;

typedef struct{
    char transcription[TRANSCRIPTION_MAX_LENGTH];  
    guint tone;           
} Syllable;

#define PINYIN_REGEX_IMPORT PINYIN_REGEX_IMPORT_PRIVATE

#define PINYIN_IMPORT_SUBSTITUTE PINYIN_IMPORT_SUBSTITUTE_PRIVATE

#define PINYIN_IMPORT_SUBSTITUTE_TONE_ACCENT PINYIN_IMPORT_SUBSTITUTE_TONE_ACCENT_PRIVATE

#define PINYIN_IMPORT_SUBSTITUTE_TONE PINYIN_IMPORT_SUBSTITUTE_TONE_ACCENT "$20"


#define PINYIN_IMPORT_SUBSTITUTE_XHC PINYIN_IMPORT_SUBSTITUTE_XHC_PRIVATE

#define PINYIN_IMPORT_SUBSTITUTE_TONE_ACCENT_XHC PINYIN_IMPORT_SUBSTITUTE_TONE_ACCENT_XHC_PRIVATE 

#define PINYIN_IMPORT_SUBSTITUTE_TONE_XHC PINYIN_IMPORT_SUBSTITUTE_TONE_ACCENT_XHC "$24"


typedef enum {
    ZHUYIN_INVALID_SYMBOL= -1, 
    ZHUYIN_SYMBOL_B,         
    ZHUYIN_SYMBOL_P,         
    ZHUYIN_SYMBOL_M,         
    ZHUYIN_SYMBOL_F,         
    ZHUYIN_SYMBOL_D,         
    ZHUYIN_SYMBOL_T,         
    ZHUYIN_SYMBOL_N,         
    ZHUYIN_SYMBOL_L,         
    ZHUYIN_SYMBOL_G,         
    ZHUYIN_SYMBOL_K,         
    ZHUYIN_SYMBOL_H,         
    ZHUYIN_SYMBOL_J,         
    ZHUYIN_SYMBOL_Q,         
    ZHUYIN_SYMBOL_X,         
    ZHUYIN_SYMBOL_ZH,        
    ZHUYIN_SYMBOL_CH,        
    ZHUYIN_SYMBOL_SH,        
    ZHUYIN_SYMBOL_R,         
    ZHUYIN_SYMBOL_Z,         
    ZHUYIN_SYMBOL_C,         
    ZHUYIN_SYMBOL_S,         
    ZHUYIN_SYMBOL_I,        
    ZHUYIN_SYMBOL_U,        
    ZHUYIN_SYMBOL_U_DIAERESIS,       
    ZHUYIN_SYMBOL_A,         
    ZHUYIN_SYMBOL_O,         
    ZHUYIN_SYMBOL_E,         
    ZHUYIN_SYMBOL_E_CIRCUMFLEX,     
    ZHUYIN_SYMBOL_AI,        
    ZHUYIN_SYMBOL_EI,        
    ZHUYIN_SYMBOL_AO,        
    ZHUYIN_SYMBOL_OU,        
    ZHUYIN_SYMBOL_AN,        
    ZHUYIN_SYMBOL_EN,        
    ZHUYIN_SYMBOL_ANG,       
    ZHUYIN_SYMBOL_ENG,       
    ZHUYIN_SYMBOL_ER,        
    ZHUYIN_SYMBOL_1,         
    ZHUYIN_SYMBOL_2,         
    ZHUYIN_SYMBOL_3,         
    ZHUYIN_SYMBOL_4,         
    ZHUYIN_SYMBOL_NEUTRAL,   
} ZhuyinSymbolId;

#define ZHUYIN_SYMBOL_COUNT ZHUYIN_SYMBOL_NEUTRAL + 1 

extern const ZhuyinSymbol ZHUYIN_SYMBOL_LIST[];


typedef guint PinyinFormatFlags;

#define PINYIN_FORMAT_FLAG_STRIP_TRIVIAL_ACCENT 0x1 
#define PINYIN_FORMAT_FLAG_STRIP_CIRCUMFLEX     0x2  
#define PINYIN_FORMAT_FLAG_STRIP_DIAERESIS      0x4  
#define PINYIN_FORMAT_FLAG_NFD                  0x8  

#define PINYIN_FORMAT_FLAG_ASCII_ONLY           0x10  
                                         

#define PINYIN_FORMAT_FLAG_TONE_AS_ACCENT               0x20

#define PINYIN_FORMAT_FLAG_STRIP_TRIVIAL_TONE           0x40

typedef enum{
    PINYIN_ACCENT_ALWAYS,   
    PINYIN_ACCENT_ORIGINAL, 
    PINYIN_ACCENT_UNIHAN,   
    PINYIN_ACCENT_TRAILING, 
    PINYIN_ACCENT_INPUT_METHOD,  
    PINYIN_ACCENT_NONE,      
    PINYIN_ACCENT_INTERNAL  
} PinyinAccentFormat;

PinyinFormatFlags pinyinAccentFormat_to_pinyinFormatFlags(
        PinyinAccentFormat toFormat, gboolean useTrailNumber);
typedef guint ZhuyinFormatFlags;

#define ZHUYIN_FORMAT_FLAG_STRIP_1ST_TONE       0x1

#define ZHUYIN_FORMAT_FLAG_FRONT_5TH_TONE       0x2

#define ZHUYIN_FORMAT_FLAG_NUMERICAL_TONE       0x4

typedef enum{
    ZHUYIN_TONEMARK_ALWAYS,   
    ZHUYIN_TONEMARK_ORIGINAL,   
    ZHUYIN_TONEMARK_INPUT_METHOD,  
    ZHUYIN_TONEMARK_NUMERICAL,  
} ZhuyinToneMarkFormat;

ZhuyinFormatFlags zhuyinToneMarkFormat_to_zhuyinFormatFlags(
        ZhuyinToneMarkFormat toFormat);
/*==========================================================
 * Syllable functions.
 */

Syllable *syllable_new();

Syllable *syllable_new_pinyin(const Pinyin *pinyin_str);

Syllable *syllable_new_zhuyin(const Zhuyin *zhuyin_str);


Syllable *syllable_clone(Syllable *syl);

Pinyin *syllable_to_pinyin(Syllable *syl,PinyinFormatFlags formatFlags);

Zhuyin *syllable_to_zhuyin(Syllable *syl,ZhuyinFormatFlags formatFlags);

gboolean syllable_is_zhuyin(Syllable *syl);

gboolean syllable_is_zhuyin_fast(Syllable *syl);

void syllable_free(Syllable *syl);

int syllabel_regex_t_init();


/*==========================================================
 * Pinyin functions.
 */

Pinyin *pinyin_new(const char *pinyin_str);


guint pinyin_get_tone(const Pinyin* pinyin);

guint pinyin_strip_tone(Pinyin* pinyin);

guint pinyin_strip_tone_normalized(Pinyin* pinyin);

void pinyin_add_tone(Pinyin* pinyin, guint tone, gboolean useTrailNumber);

void pinyin_add_tone_formatFlags(Pinyin* pinyin, guint tone, PinyinFormatFlags formatFlags);


Pinyin *pinyin_convert_formatFlags(const Pinyin *pinyin, PinyinFormatFlags formatFlags);


Pinyin *pinyin_convert_accent_format(const Pinyin *pinyin, PinyinAccentFormat toFormat, gboolean useTrailNumber);



Zhuyin *pinyin_to_zhuyin(const Pinyin* pinyin, ZhuyinToneMarkFormat toFormat);

Zhuyin *pinyin_to_zhuyin_formatFlags(const Pinyin* pinyin, ZhuyinFormatFlags formatFlags);

/*==========================================================
 * Zhuyin functions.
 */

Zhuyin *zhuyin_new(const char *zhuyin_str);


guint zhuyin_get_tone(const Zhuyin* zhuyin);


guint zhuyin_strip_tone(Zhuyin* zhuyin);

void zhuyin_add_tone(Zhuyin* zhuyin, guint tone, ZhuyinToneMarkFormat toFormat);

void zhuyin_add_tone_formatFlags(Zhuyin* zhuyin, guint tone, ZhuyinFormatFlags formatFlags);

Zhuyin *zhuyin_convert_toneMark_format(const Zhuyin* zhuyin, ZhuyinToneMarkFormat toFormat);

Zhuyin *zhuyin_convert_formatFlags(const Zhuyin *zhuyin, ZhuyinFormatFlags formatFlags);

Pinyin *zhuyin_to_pinyin(const Zhuyin* zhuyin, PinyinAccentFormat toFormat, gboolean useTrailNumber);

Pinyin *zhuyin_to_pinyin_formatFlags(const Zhuyin* zhuyin, PinyinFormatFlags formatFlags);

/*----------------------------------------------------------
 * Zhuyin symbol functions.
 */

ZhuyinSymbol zhuyinSymbol_from_id(ZhuyinSymbolId id);


ZhuyinSymbolId zhuyinSymbol_get_id(ZhuyinSymbol zSym);

gboolean zhuyinSymbol_is_initial(ZhuyinSymbol zSym);

gboolean zhuyinSymbol_is_medial(ZhuyinSymbol zSym);

gboolean zhuyinSymbol_is_final(ZhuyinSymbol zSym);

gboolean zhuyinSymbol_is_tone(ZhuyinSymbol zSym);

guint zhuyinSymbol_to_toneMark_id(ZhuyinSymbol zSym);

ZhuyinSymbol zhuyinSymbol_from_toneMark_id(guint toneMark_id);

void pinyin_convert_accent_format_scalar_func(sqlite3_context *context, int argc, sqlite3_value **argv);

void pinyin_to_zhuyin_scalar_func(sqlite3_context *context, int argc, sqlite3_value **argv);

void zhuyin_convert_toneMark_format_scalar_func(sqlite3_context *context, int argc, sqlite3_value **argv);


void zhuyin_to_pinyin_scalar_func(sqlite3_context *context, int argc, sqlite3_value **argv);

#endif /* UNIHAN_PHONETIC_H_ */

---