Unihan.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_H_
#define UNIHAN_H_
#include "Unihan_enum.h"
#include "Unihan_phonetic.h"
#include "sqlite_functions.h"
#include "str_functions.h"

#define FIELD_CACHE_DB "field.cache"

typedef struct {
    const char *name; 
    const char *description; 
} UnihanIRG_SourceData;

typedef struct {
    UnihanField field; 
    UnihanTable table; 
} UnihanFieldTablePair;

typedef struct {
    UnihanIRG_SourceId sourceId; 
    const char *sourceMapping;   
} UnihanIRG_SourceRec;


typedef struct {
    const char* funcName;                
    int argc;                            
    void (*func)(sqlite3_context *context, int argc, sqlite3_value **argv); 
    void (*stepFunc)(sqlite3_context *context, int argc, sqlite3_value **argv);  
    void (*finalizeFunc)(sqlite3_context *context); 
} DatabaseFuncStru;

extern const DatabaseFuncStru DATABASE_FUNCS[];

typedef guint UnihanQueryOption;

#define UNIHAN_QUERY_OPTION_LIKE                1       
#define UNIHAN_QUERY_OPTION_SCALAR_STRING       1 << 1  
#define UNIHAN_QUERY_OPTION_SHOW_GIVEN_FIELD    1 << 2  
#define UNIHAN_QUERY_OPTION_PINYIN_TONE_ACCENT  1 << 3  
#define UNIHAN_QUERY_OPTION_PINYIN_FORMAT_MASK  7 << 4  
#define UNIHAN_QUERY_OPTION_ZHUYIN_FORCE_DISPLAY  1 << 7  
#define UNIHAN_QUERY_OPTION_ZHUYIN_FORMAT_MASK  7 << 8  

#define UNIHAN_QUERY_OPTION_DEFAULT             (PINYIN_ACCENT_UNIHAN << 4) | (ZHUYIN_TONEMARK_ORIGINAL << 8)   


#define UNIHAN_QUERY_OPTION_GET_PINYIN_FORMAT(options) (options & UNIHAN_QUERY_OPTION_PINYIN_FORMAT_MASK) >> 4

#define UNIHAN_QUERY_OPTION_SET_PINYIN_FORMAT(options,format) options |= format << 4

#define UNIHAN_QUERY_OPTION_GET_ZHUYIN_FORMAT(options) (options & UNIHAN_QUERY_OPTION_ZHUYIN_FORMAT_MASK) >> 8

#define UNIHAN_QUERY_OPTION_SET_ZHUYIN_FORMAT(options,format) options |= format << 8

SQL_Result *unihan_find_all_matched(UnihanField givenField, const char *givenValue, 
        UnihanField queryField, UnihanQueryOption qOption);

char* unihan_find_first_matched(UnihanField givenField, const char* givenValue, 
        UnihanField queryField, UnihanQueryOption qOption );

int unihan_count_matched_record(UnihanTable table,StringList *valueList);

int unihan_insert(UnihanTable table,StringList *valueList);

int unihan_insert_no_duplicate(UnihanTable table,StringList *valueList);

int unihan_insert_value(gunichar code, UnihanField field, const char *value);

gboolean unihanChar_has_field(gunichar code, UnihanField field);

gboolean unihanChar_is_in_source(gunichar code, UnihanIRG_SourceId source);

UnihanIRG_SourceId unihanChar_is_in_sources(gunichar code, UnihanIRG_SourceId source, ...);

gboolean unihanChar_is_common_in_locale(gunichar code, UnihanLocale locale);

UnihanRange unihanChar_in_range(gunichar code);

gunichar unihanChar_parse(const char *str);

char *unihanChar_to_scalar_string(gunichar code);


sqlite3 *unihanDb_get();


UnihanTable *unihanDb_get_all_tables();

SQL_Result *unihanDb_get_all_tableNames();


int unihanDb_open(const char *filename, int flags);

int unihanDb_open_default();

int unihanDb_close();

int unihanField_array_index(UnihanField field,  const UnihanField* fieldArray);

UnihanIRG_Source unihanField_get_IRG_source(UnihanField field);

UnihanTable unihanField_get_table(UnihanField field);

UnihanTable *unihanField_get_all_tables(UnihanField field);

UnihanTable unihanField_get_extra_table(UnihanField field);

UnihanTable *unihanField_get_required_tables(UnihanField field);

gboolean unihanField_is_IRG_Source(UnihanField field);


gboolean unihanField_is_indexed(UnihanField field);

gboolean unihanField_is_integer(UnihanField field);


gboolean unihanField_is_uppercase(UnihanField field);

gboolean unihanField_is_lowercase(UnihanField field);

gboolean unihanField_is_mandarin(UnihanField field);

gboolean unihanField_is_pseudo(UnihanField field);

gboolean unihanField_is_ucs4(UnihanField field);

gboolean unihanField_is_singleton(UnihanField field);

UnihanField unihanField_parse(const char *str);

const char* unihanField_to_string(UnihanField field);

gboolean unihanIRG_Source_has_no_mapping(UnihanIRG_SourceId sourceId);

const UnihanIRG_SourceData *unihanIRG_SourceData_get(UnihanIRG_SourceId sourceId);

UnihanIRG_SourceId unihanIRG_SourceId_parse(const char *sourceShortName);

UnihanIRG_SourceRec* unihanIRG_SourceRec_parse(UnihanField field,const char *value);

void unihanIRG_SourceRec_free(UnihanIRG_SourceRec *rec);

int unihanSql_count_matches(const char * sqlClause, char **errMsg_ptr);

int unihanSql_exec(char *sqlClause, sqlite_exec_callback callback, 
 void *callbackOption,  char **errMsg_ptr);

SQL_Result *unihanSql_get_sql_result(const char *sqlClause);


UnihanLocale unihanLocale_parse(char *str);

const char *unihanLocale_to_string(UnihanLocale locale);

const char *unihanRange_to_string(UnihanRange uRange);

UnihanTable unihanTable_parse(const char * tableName);

const char *unihanTable_to_string(UnihanTable table);


UnihanField* unihanTable_get_db_fields(UnihanTable table);

UnihanField* unihanTable_get_fields(UnihanTable table);

UnihanField* unihanTable_get_primary_key_fields(UnihanTable table);
#endif /* UNIHAN_H */

---