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>

#define PINYIN_MAX_LENGTH 9

#define ZHUYIN_MAX_LENGTH 13

typedef gunichar  ZhuYin_Symbol;

typedef char ZhuYin;

typedef char PinYin;



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,   
} ZhuYin_Symbol_Id;

#define ZHUYIN_SYMBOL_COUNT ZHUYIN_SYMBOL_NEUTRAL + 1 

extern const ZhuYin_Symbol ZHUYIN_SYMBOL_LIST[];

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


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


/*==========================================================
 * PinYin functions.
 */

PinYin *pinYin_new(const char *pinYin_str);


guint pinYin_get_tone(const PinYin* pinYin);

guint pinYin_strip_tone(PinYin* pinYin);

void pinYin_add_tone(PinYin* pinYin, guint tone, gboolean useTrailNumber);

PinYin *pinYin_convert_accent_format(const PinYin *pinYin, PinYin_Accent_Format toFormat, gboolean useTrailNumber);


ZhuYin *pinYin_to_zhuYin(const PinYin* pinYin, ZhuYin_ToneMark_Format toFormat);

/*==========================================================
 * 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, ZhuYin_ToneMark_Format toFormat);

ZhuYin *zhuYin_convert_toneMark_format(const ZhuYin* zhuYin, ZhuYin_ToneMark_Format toFormat);

PinYin *zhuYin_to_pinYin(const ZhuYin* zhuYin, PinYin_Accent_Format toFormat, gboolean useTrailNumber);


/*----------------------------------------------------------
 * ZhuYin symbol functions.
 */

ZhuYin_Symbol zhuYin_Symbol_from_id(ZhuYin_Symbol_Id id);


ZhuYin_Symbol_Id zhuYin_Symbol_get_id(ZhuYin_Symbol zSym);

gboolean zhuYin_Symbol_is_initial(ZhuYin_Symbol zSym);

gboolean zhuYin_Symbol_is_medial(ZhuYin_Symbol zSym);

gboolean zhuYin_Symbol_is_final(ZhuYin_Symbol zSym);

gboolean zhuYin_Symbol_is_tone(ZhuYin_Symbol zSym);

guint zhuYin_Symbol_to_toneMark_id(ZhuYin_Symbol zSym);

ZhuYin_Symbol zhuYin_Symbol_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_ */

---