Main Page | Compound List | File List | Compound Members | File Members

librcc.h File Reference

#include <stdlib.h>

Go to the source code of this file.

Compounds

struct  rcc_class_default_charset_t
struct  rcc_class_t
struct  rcc_compiled_configuration_t
struct  rcc_engine_t
struct  rcc_language_alias_t
struct  rcc_language_relation_t
struct  rcc_language_t
struct  rcc_option_range_t

Defines

#define RCC_MAX_CHARSETS   16
#define RCC_MAX_ENGINES   5
#define RCC_MAX_LANGUAGES   64
#define RCC_MAX_ALIASES   64
#define RCC_MAX_CLASSES   16
#define RCC_FLAG_NO_DEFAULT_CONFIGURATION   1
#define RCC_CLASS_FLAG_CONST   0x01
#define RCC_CLASS_FLAG_SKIP_SAVELOAD   0x02
#define RCC_OPTION_LEARNING_FLAG_USE   1
#define RCC_OPTION_LEARNING_FLAG_LEARN   2
#define rccFrom(ctx, class_id, buf)   rccSizedFrom(ctx, class_id, buf, 0)
#define rccTo(ctx, class_id, buf)   rccSizedTo(ctx, class_id, buf, NULL)
#define rccRecode(ctx, from, to, buf)   rccSizedRecode(ctx, from, to, buf, 0, NULL)
#define rccFromCharset(ctx, charset, buf)   rccSizedFromCharset(ctx, charset, buf, 0)
#define rccToCharset(ctx, charset, buf)   rccSizedToCharset(ctx, charset, buf, NULL)
#define rccRecodeToCharset(ctx, class_id, charset, buf)   rccSizedRecodeToCharset(ctx, class_id, charset, buf, 0, NULL)
#define rccRecodeFromCharset(ctx, class_id, charset, buf)   rccSizedRecodeFromCharset(ctx, class_id, charset, buf, 0, NULL)
#define rccRecodeCharsets(ctx, from, to, buf)   rccSizedRecodeCharsets(ctx, from, to, buf, 0, NULL)
#define rccConfigFrom(ctx, class_id, buf)   rccConfigSizedFrom(ctx, class_id, buf, 0)
#define rccConfigTo(ctx, class_id, buf)   rccConfigSizedTo(ctx, class_id, buf, NULL)
#define rccConfigRecode(ctx, from, to, buf)   rccConfigSizedRecode(ctx, from, to, buf, 0, NULL)
#define rccConfigRecodeToCharset(ctx, class_id, charset, buf)   rccConfigSizedRecodeToCharset(ctx, class_id, charset, buf, 0, NULL)
#define rccConfigRecodeFromCharset(ctx, class_id, charset, buf)   rccConfigSizedRecodeFromCharset(ctx, class_id, charset, buf, 0, NULL)
#define RCC_CC_FLAG_HAVE_BERKLEY_DB   0x01
#define RCC_CC_FLAG_HAVE_DYNAMIC_ENGINES   0x02
#define RCC_CC_FLAG_HAVE_ENCA   0x04
#define RCC_CC_FLAG_HAVE_RCD   0x08
#define RCC_CC_FLAG_HAVE_LIBTRANSLATE   0x10

Typedefs

typedef unsigned char rcc_language_id
typedef unsigned char rcc_alias_id
typedef unsigned char rcc_relation_id
typedef unsigned char rcc_charset_id
typedef unsigned char rcc_autocharset_id
typedef unsigned char rcc_engine_id
typedef int rcc_class_id
typedef rcc_context_t * rcc_context
typedef rcc_engine_context_t * rcc_engine_context
typedef rcc_language_config_t * rcc_language_config
typedef const struct rcc_class_t * rcc_class_ptr
typedef unsigned int rcc_init_flags
typedef unsigned int rcc_db4_flags
typedef const char * rcc_charset
typedef rcc_charset rcc_charset_list [RCC_MAX_CHARSETS+1]
typedef void * rcc_engine_internal
typedef rcc_engine_internal(* rcc_engine_init_function )(rcc_engine_context ctx)
typedef rcc_autocharset_id(* rcc_engine_function )(rcc_engine_context ctx, const char *buf, int len)
typedef void(* rcc_engine_free_function )(rcc_engine_context ctx)
typedef rcc_engine_t rcc_engine
typedef rcc_engine * rcc_engine_ptr
typedef rcc_engine_ptr rcc_engine_list [RCC_MAX_ENGINES+1]
typedef rcc_language_t rcc_language
typedef rcc_language * rcc_language_ptr
typedef rcc_language_ptr rcc_language_list [RCC_MAX_LANGUAGES+1]
typedef rcc_language_alias_t rcc_language_alias
typedef rcc_language_alias * rcc_language_alias_ptr
typedef rcc_language_alias_ptr rcc_language_alias_list [RCC_MAX_ALIASES+1]
typedef rcc_language_relation_t rcc_language_relation
typedef enum rcc_class_type_t rcc_class_type
typedef const struct rcc_class_default_charset_t rcc_class_default_charset
typedef const struct rcc_class_t rcc_class
typedef rcc_class_ptr rcc_class_list [RCC_MAX_CLASSES+1]
typedef int rcc_option_value
typedef enum rcc_option_translate_t rcc_option_translate
typedef enum rcc_option_t rcc_option
typedef enum rcc_option_type_t rcc_option_type
typedef enum rcc_option_range_type_t rcc_option_range_type
typedef rcc_option_range_t rcc_option_range
typedef char * rcc_string
typedef const char * rcc_const_string
typedef rcc_iconv_t * rcc_iconv
typedef rcc_translate_t * rcc_translate
typedef rcc_speller_t * rcc_speller
typedef enum rcc_speller_result_t rcc_speller_result
typedef void * rcc_config
typedef rcc_engine *(* rcc_plugin_engine_info_function )(const char *lang)
typedef rcc_compiled_configuration_t rcc_compiled_configuration_s
typedef const struct rcc_compiled_configuration_t * rcc_compiled_configuration

Enumerations

enum  rcc_class_type_t {
  RCC_CLASS_INVALID = 0, RCC_CLASS_STANDARD, RCC_CLASS_KNOWN, RCC_CLASS_FS,
  RCC_CLASS_TRANSLATE_LOCALE, RCC_CLASS_TRANSLATE_CURRENT, RCC_CLASS_TRANSLATE_FROM
}
enum  rcc_option_translate_t {
  RCC_OPTION_TRANSLATE_OFF = 0, RCC_OPTION_TRANSLATE_TRANSLITERATE, RCC_OPTION_TRANSLATE_TO_ENGLISH, RCC_OPTION_TRANSLATE_SKIP_RELATED,
  RCC_OPTION_TRANSLATE_SKIP_PARRENT, RCC_OPTION_TRANSLATE_FULL
}
enum  rcc_option_t {
  RCC_OPTION_LEARNING_MODE = 0, RCC_OPTION_AUTODETECT_FS_TITLES, RCC_OPTION_AUTODETECT_FS_NAMES, RCC_OPTION_CONFIGURED_LANGUAGES_ONLY,
  RCC_OPTION_AUTOENGINE_SET_CURRENT, RCC_OPTION_AUTODETECT_LANGUAGE, RCC_OPTION_TRANSLATE, RCC_OPTION_TIMEOUT,
  RCC_MAX_OPTIONS, RCC_OPTION_ALL
}
enum  rcc_option_type_t { RCC_OPTION_TYPE_INVISIBLE = 0, RCC_OPTION_TYPE_STANDARD, RCC_OPTION_TYPE_MAX }
enum  rcc_option_range_type_t {
  RCC_OPTION_RANGE_TYPE_BOOLEAN = 0, RCC_OPTION_RANGE_TYPE_RANGE, RCC_OPTION_RANGE_TYPE_FLAGS, RCC_OPTION_RANGE_TYPE_MENU,
  RCC_OPTION_RANGE_TYPE_MAX
}
enum  rcc_speller_result_t {
  RCC_SPELLER_INCORRECT = 0, RCC_SPELLER_ALMOST_PARRENT, RCC_SPELLER_ALMOST_CORRECT, RCC_SPELLER_PARRENT,
  RCC_SPELLER_CORRECT
}

Functions

int rccInit ()
void rccFree ()
rcc_context rccCreateContext (const char *locale_variable, unsigned int max_languages, unsigned int max_classes, rcc_class_ptr defclasses, rcc_init_flags flags)
int rccInitDefaultContext (const char *locale_variable, unsigned int max_languages, unsigned int max_classes, rcc_class_ptr defclasses, rcc_init_flags flags)
void rccFreeContext (rcc_context ctx)
int rccInitDb4 (rcc_context ctx, const char *name, rcc_db4_flags flags)
int rccLockConfiguration (rcc_context ctx, unsigned int lock_code)
int rccUnlockConfiguration (rcc_context ctx, unsigned int lock_code)
rcc_language_id rccRegisterLanguage (rcc_context ctx, rcc_language *language)
rcc_charset_id rccLanguageRegisterCharset (rcc_language *language, rcc_charset charset)
rcc_engine_id rccLanguageRegisterEngine (rcc_language *language, rcc_engine *engine)
rcc_alias_id rccRegisterLanguageAlias (rcc_context ctx, rcc_language_alias *alias)
rcc_relation_id rccRegisterLanguageRelation (rcc_context ctx, rcc_language_relation *relation)
rcc_class_id rccRegisterClass (rcc_context ctx, rcc_class *cl)
int rccRegisterAdditionalCharsets (rcc_context ctx, rcc_class_id class_id, rcc_charset *charsets)
int rccRegisterDisabledCharsets (rcc_context ctx, rcc_class_id class_id, rcc_charset *charsets)
int rccIsDisabledCharsetName (rcc_context ctx, rcc_class_id class_id, const char *charset)
rcc_class_type rccGetClassType (rcc_context ctx, rcc_class_id class_id)
const char * rccGetClassName (rcc_context ctx, rcc_class_id class_id)
const char * rccGetClassFullName (rcc_context ctx, rcc_class_id class_id)
int rccGetLanguageNumber (rcc_context ctx)
int rccGetClassNumber (rcc_context ctx)
const char * rccGetLanguageName (rcc_context ctx, rcc_language_id language_id)
rcc_language_id rccGetLanguageByName (rcc_context ctx, const char *name)
rcc_language_id rccGetRealLanguage (rcc_context ctx, rcc_language_id language_id)
const char * rccGetRealLanguageName (rcc_context ctx, rcc_language_id language_id)
rcc_language_id rccGetSelectedLanguage (rcc_context ctx)
const char * rccGetSelectedLanguageName (rcc_context ctx)
rcc_language_id rccGetCurrentLanguage (rcc_context ctx)
const char * rccGetCurrentLanguageName (rcc_context ctx)
int rccSetLanguage (rcc_context ctx, rcc_language_id language_id)
int rccSetLanguageByName (rcc_context ctx, const char *name)
rcc_option_value rccGetOption (rcc_context ctx, rcc_option option)
int rccOptionIsDefault (rcc_context ctx, rcc_option option)
int rccOptionSetDefault (rcc_context ctx, rcc_option option)
int rccSetOption (rcc_context ctx, rcc_option option, rcc_option_value value)
rcc_option_type rccOptionGetType (rcc_context ctx, rcc_option option)
rcc_option_range * rccOptionGetRange (rcc_context ctx, rcc_option option)
const char * rccGetOptionName (rcc_option option)
const char * rccGetOptionValueName (rcc_option option, rcc_option_value value)
rcc_option rccGetOptionByName (const char *name)
rcc_option_value rccGetOptionValueByName (rcc_option option, const char *name)
rcc_language_config rccCheckConfig (rcc_context ctx, rcc_language_id language_id)
rcc_language_config rccGetConfig (rcc_context ctx, rcc_language_id language_id)
rcc_language_config rccGetUsableConfig (rcc_context ctx, rcc_language_id language_id)
rcc_language_config rccGetConfigByName (rcc_context ctx, const char *name)
rcc_language_config rccGetCurrentConfig (rcc_context ctx)
rcc_language_id rccConfigGetLanguage (rcc_language_config config)
const char * rccConfigGetLanguageName (rcc_language_config config)
int rccConfigGetCharsetNumber (rcc_language_config config)
int rccConfigGetClassCharsetNumber (rcc_language_config config, rcc_class_id class_id)
int rccConfigGetEngineNumber (rcc_language_config config)
const char * rccConfigGetEngineName (rcc_language_config config, rcc_engine_id engine_id)
const char * rccConfigGetCharsetName (rcc_language_config config, rcc_charset_id charset_id)
const char * rccConfigGetClassCharsetName (rcc_language_config config, rcc_class_id class_id, rcc_charset_id charset_id)
rcc_engine_id rccConfigGetEngineByName (rcc_language_config config, const char *name)
rcc_charset_id rccConfigGetCharsetByName (rcc_language_config config, const char *name)
rcc_charset_id rccConfigGetClassCharsetByName (rcc_language_config config, rcc_class_id class_id, const char *name)
int rccConfigIsDisabledCharset (rcc_language_config config, rcc_class_id class_id, rcc_charset_id charset_id)
rcc_engine_id rccConfigGetSelectedEngine (rcc_language_config config)
const char * rccConfigGetSelectedEngineName (rcc_language_config config)
rcc_engine_id rccConfigGetCurrentEngine (rcc_language_config config)
const char * rccConfigGetCurrentEngineName (rcc_language_config config)
rcc_charset_id rccConfigGetSelectedCharset (rcc_language_config config, rcc_class_id class_id)
const char * rccConfigGetSelectedCharsetName (rcc_language_config config, rcc_class_id class_id)
rcc_charset_id rccConfigGetCurrentCharset (rcc_language_config config, rcc_class_id class_id)
const char * rccConfigGetCurrentCharsetName (rcc_language_config config, rcc_class_id class_id)
int rccConfigSetEngine (rcc_language_config config, rcc_engine_id engine_id)
int rccConfigSetCharset (rcc_language_config config, rcc_class_id class_id, rcc_charset_id charset_id)
int rccConfigSetEngineByName (rcc_language_config config, const char *name)
int rccConfigSetCharsetByName (rcc_language_config config, rcc_class_id class_id, const char *name)
rcc_charset_id rccConfigGetLocaleCharset (rcc_language_config config, const char *locale_variable)
rcc_charset_id rccConfigGetLocaleClassCharset (rcc_language_config config, rcc_class_id class_id, const char *locale_variable)
int rccGetCharsetNumber (rcc_context ctx)
int rccGetClassCharsetNumber (rcc_context ctx, rcc_class_id class_id)
int rccGetEngineNumber (rcc_context ctx)
const char * rccGetEngineName (rcc_context ctx, rcc_engine_id engine_id)
const char * rccGetCharsetName (rcc_context ctx, rcc_charset_id charset_id)
const char * rccGetClassCharsetName (rcc_context ctx, rcc_class_id class_id, rcc_charset_id charset_id)
rcc_engine_id rccGetEngineByName (rcc_context ctx, const char *name)
rcc_charset_id rccGetCharsetByName (rcc_context ctx, const char *name)
rcc_charset_id rccGetClassCharsetByName (rcc_context ctx, rcc_class_id class_id, const char *name)
int rccIsDisabledCharset (rcc_context ctx, rcc_class_id class_id, rcc_charset_id charset_id)
rcc_engine_id rccGetSelectedEngine (rcc_context ctx)
const char * rccGetSelectedEngineName (rcc_context ctx)
rcc_engine_id rccGetCurrentEngine (rcc_context ctx)
const char * rccGetCurrentEngineName (rcc_context ctx)
rcc_charset_id rccGetSelectedCharset (rcc_context ctx, rcc_class_id class_id)
const char * rccGetSelectedCharsetName (rcc_context ctx, rcc_class_id class_id)
rcc_charset_id rccGetCurrentCharset (rcc_context ctx, rcc_class_id class_id)
const char * rccGetCurrentCharsetName (rcc_context ctx, rcc_class_id class_id)
int rccSetEngine (rcc_context ctx, rcc_engine_id engine_id)
int rccSetCharset (rcc_context ctx, rcc_class_id class_id, rcc_charset_id charset_id)
int rccSetEngineByName (rcc_context ctx, const char *name)
int rccSetCharsetByName (rcc_context ctx, rcc_class_id class_id, const char *name)
rcc_charset_id rccGetLocaleCharset (rcc_context ctx, const char *locale_variable)
rcc_charset_id rccGetLocaleClassCharset (rcc_context ctx, rcc_class_id class_id, const char *locale_variable)
rcc_autocharset_id rccDetectCharset (rcc_context ctx, rcc_class_id class_id, const char *buf, size_t len)
size_t rccStringCheck (const char *str)
size_t rccStringSizedCheck (const char *str, size_t len)
rcc_language_id rccStringGetLanguage (rcc_const_string str)
const char * rccStringGetString (rcc_const_string str)
char * rccStringExtractString (rcc_const_string str)
const char * rccGetString (const char *str)
const char * rccSizedGetString (const char *str, size_t len)
int rccStringCmp (const char *str1, const char *str2)
int rccStringNCmp (const char *str1, const char *str2, size_t n)
int rccStringCaseCmp (const char *str1, const char *str2)
int rccStringNCaseCmp (const char *str1, const char *str2, size_t n)
rcc_iconv rccIConvOpen (const char *from, const char *to)
void rccIConvClose (rcc_iconv icnv)
char * rccIConv (rcc_iconv icnv, const char *buf, size_t len, size_t *rlen)
rcc_translate rccTranslateOpen (const char *from, const char *to)
void rccTranslateClose (rcc_translate translate)
int rccTranslateSetTimeout (rcc_translate translate, unsigned long us)
char * rccTranslate (rcc_translate translate, const char *buf)
int rccSpellerResultIsOwn (rcc_speller_result res)
int rccSpellerResultIsPrecise (rcc_speller_result res)
int rccSpellerResultIsCorrect (rcc_speller_result res)
rcc_speller rccSpellerCreate (const char *lang)
void rccSpellerFree (rcc_speller speller)
int rccSpellerAddParrent (rcc_speller speller, rcc_speller parrent)
rcc_speller_result rccSpeller (rcc_speller speller, const char *word)
rcc_language_id rccDetectLanguage (rcc_context ctx, rcc_class_id class_id, const char *buf, size_t len)
rcc_autocharset_id rccConfigDetectCharset (rcc_language_config config, rcc_class_id class_id, const char *buf, size_t len)
rcc_string rccSizedFrom (rcc_context ctx, rcc_class_id class_id, const char *buf, size_t len)
char * rccSizedTo (rcc_context ctx, rcc_class_id class_id, rcc_const_string buf, size_t *rlen)
char * rccSizedRecode (rcc_context ctx, rcc_class_id from, rcc_class_id to, const char *buf, size_t len, size_t *rlen)
char * rccFS (rcc_context ctx, rcc_class_id from, rcc_class_id to, const char *fspath, const char *path, const char *filename)
rcc_string rccSizedFromCharset (rcc_context ctx, const char *charset, const char *buf, size_t len)
char * rccSizedToCharset (rcc_context ctx, const char *charset, rcc_const_string buf, size_t *rlen)
char * rccSizedRecodeToCharset (rcc_context ctx, rcc_class_id class_id, const char *charset, rcc_const_string buf, size_t len, size_t *rlen)
rcc_string rccSizedRecodeFromCharset (rcc_context ctx, rcc_class_id class_id, const char *charset, const char *buf, size_t len, size_t *rlen)
char * rccSizedRecodeCharsets (rcc_context ctx, const char *from, const char *to, const char *buf, size_t len, size_t *rlen)
rcc_string rccConfigSizedFrom (rcc_language_config config, rcc_class_id class_id, const char *buf, size_t len)
char * rccConfigSizedTo (rcc_language_config config, rcc_class_id class_id, rcc_const_string buf, size_t *rlen)
char * rccConfigSizedRecode (rcc_language_config config, rcc_class_id from, rcc_class_id to, const char *buf, size_t len, size_t *rlen)
rcc_string rccConfigSizedRecodeFromCharset (rcc_language_config config, rcc_class_id class_id, const char *charset, const char *buf, size_t len, size_t *rlen)
char * rccConfigSizedRecodeToCharset (rcc_language_config config, rcc_class_id class_id, const char *charset, rcc_const_string buf, size_t len, size_t *rlen)
rcc_config rccGetConfiguration ()
int rccSave (rcc_context ctx, const char *name)
int rccLoad (rcc_context ctx, const char *name)
rcc_engine_internal rccEngineGetInternal (rcc_engine_context ctx)
rcc_language * rccEngineGetLanguage (rcc_engine_context ctx)
rcc_context rccEngineGetRccContext (rcc_engine_context ctx)
rcc_compiled_configuration rccGetCompiledConfiguration ()
int rccLocaleGetClassByName (const char *locale)
int rccLocaleGetLanguage (char *result, const char *lv, unsigned int n)
int rccLocaleGetCharset (char *result, const char *lv, unsigned int n)

Define Documentation

#define RCC_CC_FLAG_HAVE_BERKLEY_DB   0x01
 

The Berkley DB support is compiled in

#define RCC_CC_FLAG_HAVE_DYNAMIC_ENGINES   0x02
 

The dynamic engine plugins support is compiled in

#define RCC_CC_FLAG_HAVE_ENCA   0x04
 

Enca engine is compiled in

#define RCC_CC_FLAG_HAVE_LIBTRANSLATE   0x10
 

Libtranslate translation engine compiled in

#define RCC_CC_FLAG_HAVE_RCD   0x08
 

LibRCD engine is compiled in

#define RCC_CLASS_FLAG_CONST   0x01
 

Forbid change class value using Library API

#define RCC_CLASS_FLAG_SKIP_SAVELOAD   0x02
 

Forbid saving and loading of class value

#define RCC_FLAG_NO_DEFAULT_CONFIGURATION   1
 

Do not load default language configuration

#define RCC_MAX_ALIASES   64
 

#define RCC_MAX_CHARSETS   16
 

#define RCC_MAX_CLASSES   16
 

#define RCC_MAX_ENGINES   5
 

#define RCC_MAX_LANGUAGES   64
 

#define RCC_OPTION_LEARNING_FLAG_LEARN   2
 

Cache recodings in BerkeleyDB recoding cache for future use

#define RCC_OPTION_LEARNING_FLAG_USE   1
 

Use BerkeleyDB recodings cache for encoding detection

#define rccConfigFrom (  ctx,
class_id,
buf   )     rccConfigSizedFrom(ctx, class_id, buf, 0)
 

#define rccConfigRecode (  ctx,
from,
to,
buf   )     rccConfigSizedRecode(ctx, from, to, buf, 0, NULL)
 

#define rccConfigRecodeFromCharset (  ctx,
class_id,
charset,
buf   )     rccConfigSizedRecodeFromCharset(ctx, class_id, charset, buf, 0, NULL)
 

#define rccConfigRecodeToCharset (  ctx,
class_id,
charset,
buf   )     rccConfigSizedRecodeToCharset(ctx, class_id, charset, buf, 0, NULL)
 

#define rccConfigTo (  ctx,
class_id,
buf   )     rccConfigSizedTo(ctx, class_id, buf, NULL)
 

#define rccFrom (  ctx,
class_id,
buf   )     rccSizedFrom(ctx, class_id, buf, 0)
 

#define rccFromCharset (  ctx,
charset,
buf   )     rccSizedFromCharset(ctx, charset, buf, 0)
 

#define rccRecode (  ctx,
from,
to,
buf   )     rccSizedRecode(ctx, from, to, buf, 0, NULL)
 

#define rccRecodeCharsets (  ctx,
from,
to,
buf   )     rccSizedRecodeCharsets(ctx, from, to, buf, 0, NULL)
 

#define rccRecodeFromCharset (  ctx,
class_id,
charset,
buf   )     rccSizedRecodeFromCharset(ctx, class_id, charset, buf, 0, NULL)
 

#define rccRecodeToCharset (  ctx,
class_id,
charset,
buf   )     rccSizedRecodeToCharset(ctx, class_id, charset, buf, 0, NULL)
 

#define rccTo (  ctx,
class_id,
buf   )     rccSizedTo(ctx, class_id, buf, NULL)
 

#define rccToCharset (  ctx,
charset,
buf   )     rccSizedToCharset(ctx, charset, buf, NULL)
 

Typedef Documentation

typedef unsigned char rcc_alias_id
 

Alias ID

typedef unsigned char rcc_autocharset_id
 

Autocharset ID.

  • -1 is error
  • >0 is some encoding

typedef const char* rcc_charset
 

Encoding name.

typedef unsigned char rcc_charset_id
 

Charset ID.

  • 0 is default charset
  • -1 is error
  • >0 is some charset

typedef rcc_charset rcc_charset_list[RCC_MAX_CHARSETS+1]
 

List of Encoding names

typedef const struct rcc_class_t rcc_class
 

typedef const struct rcc_class_default_charset_t rcc_class_default_charset
 

typedef int rcc_class_id
 

Class ID.

typedef rcc_class_ptr rcc_class_list[RCC_MAX_CLASSES+1]
 

typedef const struct rcc_class_t* rcc_class_ptr
 

typedef enum rcc_class_type_t rcc_class_type
 

Enumeration represents type of class.

typedef const struct rcc_compiled_configuration_t* rcc_compiled_configuration
 

typedef struct rcc_compiled_configuration_t rcc_compiled_configuration_s
 

typedef void* rcc_config
 

typedef const char* rcc_const_string
 

Intermediate string format. RCC_string can be manipulated as standard NULL terminated string. However it contains small header with information about string language. All strings are encoded using UTF-8 encoding.

typedef struct rcc_context_t* rcc_context
 

Current Working Context

typedef unsigned int rcc_db4_flags
 

Berkeley DB initialization flags

typedef struct rcc_engine_t rcc_engine
 

typedef struct rcc_engine_context_t* rcc_engine_context
 

Encoding Detection Engine Context. Containes considered information about engine, which can be extracted using API functions.

See also:
rccEngineGetInternal

rccEngineGetLanguage

rccEngineGetRccContext

typedef void(* rcc_engine_free_function)(rcc_engine_context ctx)
 

Engine destructor function

typedef rcc_autocharset_id(* rcc_engine_function)(rcc_engine_context ctx, const char *buf, int len)
 

Engine encoding detection function.

Parameters:
ctx is engine context
buf is string encoded in unknow encoding
len is exact size of string or 0 (size will be detected with strlen)
Returns:
the rcc_autocharset_id of the detected encoding or -1 in case of error

typedef unsigned char rcc_engine_id
 

Engine ID.

  • -1 is non configured (first available will be used if any)
  • 0 autodetection is switched off
  • >0 is some auto-engine

typedef rcc_engine_internal(* rcc_engine_init_function)(rcc_engine_context ctx)
 

Engine constructor function

Parameters:
ctx is engine context
See also:
rccEngineGetInternal

rccEngineGetLanguage

rccEngineGetRccContext

Returns:
pointer on desired internal data to be stored in engine_context.

typedef void* rcc_engine_internal
 

Engine internal data

typedef rcc_engine_ptr rcc_engine_list[RCC_MAX_ENGINES+1]
 

typedef rcc_engine* rcc_engine_ptr
 

typedef struct rcc_iconv_t* rcc_iconv
 

recoding context

typedef unsigned int rcc_init_flags
 

RCC context initialization flags

typedef struct rcc_language_t rcc_language
 

typedef struct rcc_language_alias_t rcc_language_alias
 

typedef rcc_language_alias_ptr rcc_language_alias_list[RCC_MAX_ALIASES+1]
 

typedef rcc_language_alias* rcc_language_alias_ptr
 

typedef struct rcc_language_config_t* rcc_language_config
 

Current Language Configuration: Information about current 'class encodings', and selected 'Encoding Detection Engine'

typedef unsigned char rcc_language_id
 

Language ID.

  • 0 is default language
  • -1 is error
  • 1 usually represents "LibRCC off" language
  • >1 is some language

typedef rcc_language_ptr rcc_language_list[RCC_MAX_LANGUAGES+1]
 

typedef rcc_language* rcc_language_ptr
 

typedef struct rcc_language_relation_t rcc_language_relation
 

typedef enum rcc_option_t rcc_option
 

List of options available

typedef struct rcc_option_range_t rcc_option_range
 

Descriptionm of value range

typedef enum rcc_option_range_type_t rcc_option_range_type
 

Description of option values range type

typedef enum rcc_option_translate_t rcc_option_translate
 

typedef enum rcc_option_type_t rcc_option_type
 

List of option types

typedef int rcc_option_value
 

typedef rcc_engine*(* rcc_plugin_engine_info_function)(const char *lang)
 

typedef unsigned char rcc_relation_id
 

Relation ID

typedef struct rcc_speller_t* rcc_speller
 

spelling context

typedef enum rcc_speller_result_t rcc_speller_result
 

result of spelling

typedef char* rcc_string
 

Intermediate string format. RCC_string can be manipulated as standard NULL terminated string. However it contains small header with information about string language. All strings are encoded using UTF-8 encoding.

typedef struct rcc_translate_t* rcc_translate
 

translating context

Enumeration Type Documentation

enum rcc_class_type_t
 

Enumeration represents type of class.

Enumeration values:
RCC_CLASS_INVALID  Invalid value
RCC_CLASS_STANDARD  Standard class
RCC_CLASS_KNOWN  Class encoding is known and no autodetection should be performed
RCC_CLASS_FS  Class strings are representing file names
RCC_CLASS_TRANSLATE_LOCALE  It is permited to translate class strings to current Locale Language in rccTo
RCC_CLASS_TRANSLATE_CURRENT  It is permited to translate class strings to Current Language in rccTo
RCC_CLASS_TRANSLATE_FROM  It is permited to translate class strings to Current Language in rccFrom 

00293                               {
00294     RCC_CLASS_INVALID = 0,      
00295     RCC_CLASS_STANDARD,         
00296     RCC_CLASS_KNOWN,            
00297     RCC_CLASS_FS,               
00298     RCC_CLASS_TRANSLATE_LOCALE, 
00299     RCC_CLASS_TRANSLATE_CURRENT,
00300     RCC_CLASS_TRANSLATE_FROM,   
00301 } rcc_class_type;

enum rcc_option_range_type_t
 

Description of option values range type

Enumeration values:
RCC_OPTION_RANGE_TYPE_BOOLEAN  Boolean option
RCC_OPTION_RANGE_TYPE_RANGE  Range of integer values
RCC_OPTION_RANGE_TYPE_FLAGS  Set of boolean flags
RCC_OPTION_RANGE_TYPE_MENU  Enumeration
RCC_OPTION_RANGE_TYPE_MAX  

00465                                      {
00466     RCC_OPTION_RANGE_TYPE_BOOLEAN = 0,  
00467     RCC_OPTION_RANGE_TYPE_RANGE,        
00468     RCC_OPTION_RANGE_TYPE_FLAGS,        
00469     RCC_OPTION_RANGE_TYPE_MENU,         
00470     RCC_OPTION_RANGE_TYPE_MAX</