language_support.h

Go to the documentation of this file.

/*
 * Copyright 2008 Search Solution Corporation
 * Copyright 2016 CUBRID Corporation
 *
 *  Licensed under the Apache License, Version 2.0 (the "License");
 *  you may not use this file except in compliance with the License.
 *  You may obtain a copy of the License at
 *
 *      http://www.apache.org/licenses/LICENSE-2.0
 *
 *  Unless required by applicable law or agreed to in writing, software
 *  distributed under the License is distributed on an "AS IS" BASIS,
 *  WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
 *  See the License for the specific language governing permissions and
 *  limitations under the License.
 *
 */


/*
 * language_support.h : Multi-language and character set support
 *
 */

#ifndef _LANGUAGE_SUPPORT_H_
#define _LANGUAGE_SUPPORT_H_

#ident "$Id$"

#include <stddef.h>

#include "intl_support.h"
#include "locale_support.h"

/*
 * currently built-in language names.
 */
#define LANG_NAME_KOREAN    "ko_KR"
#define LANG_NAME_ENGLISH   "en_US"
#define LANG_NAME_TURKISH   "tr_TR"
#define LANG_CHARSET_UTF8       "utf8"
#define LANG_CHARSET_UTF8_ALIAS1  "utf-8"
#define LANG_CHARSET_EUCKR      "euckr"
#define LANG_CHARSET_EUCKR_ALIAS1 "euc-kr"
#define LANG_CHARSET_ISO88591   "iso88591"
#define LANG_CHARSET_ISO88591_ALIAS1   "iso-88591"
#define LANG_CHARSET_ISO88591_ALIAS2   "iso-8859-1"
#define LANG_NAME_DEFAULT   LANG_NAME_ENGLISH
#define LANG_CHARSET_DEFAULT    LANG_NAME_ENGLISH "." LANG_CHARSET_ISO88591

#define LANG_MAX_COLLATIONS  256
#define LANG_MAX_BUILTIN_COLLATIONS  32
#define LANG_MAX_LOADED_LOCALES  32

#define LANG_COERCIBLE_COLL LANG_SYS_COLLATION
#define LANG_COERCIBLE_CODESET LANG_SYS_CODESET

#define LANG_IS_COERCIBLE_COLL(c)       \
    ((c) == LANG_COLL_ISO_BINARY || (c) == LANG_COLL_UTF8_BINARY  \
     || (c) == LANG_COLL_EUCKR_BINARY)

/* common collation to be used at runtime */
#define LANG_RT_COMMON_COLL(c1, c2, coll)     \
  do {                                        \
    coll = -1;                                \
    if ((c1) == (c2))                 \
      {                                       \
        coll = (c1);                  \
      }                                       \
    else if (LANG_IS_COERCIBLE_COLL (c1))     \
      {                       \
    if (!LANG_IS_COERCIBLE_COLL (c2))     \
      {                   \
        coll = (c2);              \
      }                   \
    else                      \
      {                   \
        if ((c2) == LANG_COLL_ISO_BINARY) \
          {                   \
        coll = (c2);              \
          }                   \
      }                   \
      }                       \
    else if (LANG_IS_COERCIBLE_COLL (c2))     \
      {                       \
    coll = (c1);                  \
      }                       \
  } while (0)

/*
 * message for fundamental error that occur before any messages catalogs
 * can be accessed or opened.
 */
#define LANG_ERR_NO_CUBRID "The `%s' environment variable is not set.\n"

#define LANG_MAX_LANGNAME       256

#define LANG_VARIABLE_CHARSET(x) ((x) != INTL_CODESET_ASCII     && \
                  (x) != INTL_CODESET_RAW_BITS  && \
                  (x) != INTL_CODESET_RAW_BYTES && \
                  (x) != INTL_CODESET_ISO88591)

enum
{
  LANG_COLL_ISO_BINARY = 0,
  LANG_COLL_UTF8_BINARY = 1,
  LANG_COLL_ISO_EN_CS = 2,
  LANG_COLL_ISO_EN_CI = 3,
  LANG_COLL_UTF8_EN_CS = 4,
  LANG_COLL_UTF8_EN_CI = 5,
  LANG_COLL_UTF8_TR_CS = 6,
  LANG_COLL_UTF8_KO_CS = 7,
  LANG_COLL_EUCKR_BINARY = 8,
  LANG_COLL_BINARY = 9,
  LANG_COLL_DEFAULT = LANG_COLL_ISO_BINARY,
  LANG_COLL_BUILTIN_MAX = LANG_COLL_BINARY
};

#define LANG_GET_BINARY_COLLATION(c) (((c) == INTL_CODESET_UTF8) \
  ? LANG_COLL_UTF8_BINARY :                  \
  (((c) == INTL_CODESET_KSC5601_EUC) ? LANG_COLL_EUCKR_BINARY :  \
  (((c) == INTL_CODESET_ISO88591) ? LANG_COLL_ISO_BINARY :   \
    LANG_COLL_BINARY)))

typedef struct db_charset DB_CHARSET;
struct db_charset
{
  const char *charset_name;
  const char *charset_desc;
  const char *space_char;
  const char *introducer;
  const char *charset_cubrid_name;
  INTL_CODESET charset_id;
  int space_size;
};

/* collation optimizations */
typedef struct coll_opt COLL_OPT;
struct coll_opt
{
  /* enabled by default; disabled for case insensitive collations and collations with expansions */
  bool allow_like_rewrite;

  /* enabled by default; disabled for collations having identical sort key for different strings (case insensitive
   * collations). In order to produce specific sort keys, an UCA collation should be configured with maximum sorting
   * level. But, even in this case there are some acceptatable codepoints which have the same weight. These codepoints
   * ussually represent the same graphic symbol. */
  bool allow_index_opt;

  /* enabled by default; disabled for collations with expansions */
  bool allow_prefix_index;
};

typedef struct lang_locale_data LANG_LOCALE_DATA;

typedef struct lang_collation LANG_COLLATION;
struct lang_collation
{
  INTL_CODESET codeset;
  int built_in;
  bool need_init;
  COLL_OPT options;     /* collation options */

  /* default language to use for this collation (for casing functions) */
  LANG_LOCALE_DATA *default_lang;

  COLL_DATA coll;       /* collation data */
  /* string compare */
  int (*fastcmp) (const LANG_COLLATION * lang_coll, const unsigned char *string1, const int size1,
          const unsigned char *string2, const int size2, bool ignore_trailing_space);
  int (*strmatch) (const LANG_COLLATION * lang_coll, bool is_match, const unsigned char *string1, int size1,
           const unsigned char *string2, int size2, const unsigned char *escape, const bool has_last_escape,
           int *str1_match_size, bool ignore_trailing_space);
  /* function to get collatable character sequence (in sort order) */
  int (*next_coll_seq) (const LANG_COLLATION * lang_coll, const unsigned char *seq, const int size,
            unsigned char *next_seq, int *len_next, bool ignore_trailing_space);
  /* find common key where str1 <= key < str2 (BTREE string prefix) */
  int (*split_key) (const LANG_COLLATION * lang_coll, const bool is_desc, const unsigned char *str1, const int size1,
            const unsigned char *str2, const int size2, const unsigned char **key, int *byte_size,
            bool ignore_trailing_space);
  /* compute hash value pseudokey (mht_2str_pseudo_key) */
  unsigned int (*mht2str) (const LANG_COLLATION * lang_coll, const unsigned char *str, const int size);
  /* collation data init function */
  void (*init_coll) (LANG_COLLATION * lang_coll);
};

/* Language locale data */
struct lang_locale_data
{
  /* next locale with same lang id, but different codeset */
  LANG_LOCALE_DATA *next_lld;

  const char *lang_name;
  INTL_LANG lang_id;
  INTL_CODESET codeset;

  ALPHABET_DATA alphabet;   /* data for lower / upper */
  ALPHABET_DATA ident_alphabet; /* data for lower / upper for identifiers */

  LANG_COLLATION *default_lang_coll;    /* default collation for this locale */

  TEXT_CONVERSION *txt_conv;    /* console text conversion */

  bool is_initialized;      /* init status */

  const char *time_format;  /* default time format */
  const char *date_format;  /* default date format */
  const char *datetime_format;  /* default datetime format */
  const char *timestamp_format; /* default timestamp format */
  const char *datetimetz_format;    /* default datetime_tz format */
  const char *timestamptz_format;   /* default timestamp_tz format */

  const char *day_short_name[CAL_DAY_COUNT];
  const char *day_name[CAL_DAY_COUNT];
  const char *month_short_name[CAL_MONTH_COUNT];
  const char *month_name[CAL_MONTH_COUNT];
  const char *am_pm[CAL_AM_PM_COUNT];

  const char *day_short_parse_order;
  const char *day_parse_order;
  const char *month_short_parse_order;
  const char *month_parse_order;
  const char *am_pm_parse_order;

  char number_decimal_sym;
  char number_group_sym;
  DB_CURRENCY default_currency_code;

  UNICODE_NORMALIZATION unicode_norm;

  char *checksum;

  void (*initloc) (LANG_LOCALE_DATA * ld);  /* locale data init function */
  bool is_user_data;        /* TRUE if lang data is loaded from DLL/so FALSE if built-in */
};

typedef struct lang_coll_compat LANG_COLL_COMPAT;
struct lang_coll_compat
{
  int coll_id;
  char coll_name[COLL_NAME_SIZE];
  INTL_CODESET codeset;
  char checksum[32 + 1];
};

typedef struct lang_locale_compat LANG_LOCALE_COMPAT;
struct lang_locale_compat
{
  char lang_name[LANG_MAX_LANGNAME];
  INTL_CODESET codeset;
  char checksum[32 + 1];
};

/* collation and charset do be used by system : */
#if defined(NDEBUG)
#define LANG_GET_COLLATION(i)  lang_Collations[i]
#else /* DEBUG */
#define LANG_GET_COLLATION(i)  lang_get_collation(i)
#endif /* NDEBUG */

#if defined(NDEBUG)
#define LANG_SYS_COLLATION  (LANG_GET_BINARY_COLLATION(lang_Loc_charset))
#define LANG_SYS_CODESET  lang_Loc_charset
#else /* DEBUG */
#define LANG_SYS_COLLATION  (LANG_GET_BINARY_COLLATION(lang_charset()))
#define LANG_SYS_CODESET  lang_charset()
#endif /* NDEBUG */

#ifdef __cplusplus
extern "C"
{
#endif
  extern LANG_COLLATION *lang_Collations[LANG_MAX_COLLATIONS];
  extern INTL_CODESET lang_Loc_charset;
  extern INTL_CODESET lang_charset (void);
  extern void lang_init_builtin (void);
  extern int lang_init (void);
  extern void lang_init_console_txt_conv (void);
  extern int lang_set_charset_lang (const char *lang_charset);
  extern int lang_set_charset (const INTL_CODESET codeset);
  extern int lang_set_language (const char *lang_str);
  extern void lang_final (void);
  extern int lang_locales_count (bool check_codeset);
  extern const char *lang_get_msg_Loc_name (void);
  extern const char *lang_get_Lang_name (void);
  extern INTL_LANG lang_id (void);
  extern DB_CURRENCY lang_currency (void);
  extern DB_CURRENCY lang_locale_currency (const char *locale_str);
  extern const char *lang_currency_symbol (DB_CURRENCY curr);
#if defined(ENABLE_UNUSED_FUNCTION)
  extern int lang_char_mem_size (const char *p);
  extern int lang_char_screen_size (const char *p);
  extern int lang_wchar_mem_size (const wchar_t * p);
  extern int lang_wchar_screen_size (const wchar_t * p);
#endif
  extern bool lang_check_identifier (const char *name, int length);
  extern const LANG_LOCALE_DATA *lang_locale (void);
  extern const LANG_LOCALE_DATA *lang_get_specific_locale (const INTL_LANG lang, const INTL_CODESET codeset);
  extern const LANG_LOCALE_DATA *lang_get_first_locale_for_lang (const INTL_LANG lang);
  extern int lang_get_lang_id_from_name (const char *lang_name, INTL_LANG * lang_id);
  extern const char *lang_get_lang_name_from_id (const INTL_LANG lang_id);
  extern int lang_set_flag_from_lang (const char *lang_str, bool has_user_format, bool has_user_lang, int *flag);
  extern int lang_set_flag_from_lang_id (const INTL_LANG lang, bool has_user_format, bool has_user_lang, int *flag);
  extern INTL_LANG lang_get_lang_id_from_flag (const int flag, bool * has_user_format, bool * has_user_lang);
  extern const char *lang_date_format_parse (const INTL_LANG lang_id, const INTL_CODESET codeset, const DB_TYPE type,
                         INTL_CODESET * format_codeset);
  extern char lang_digit_grouping_symbol (const INTL_LANG lang_id);
  extern char lang_digit_fractional_symbol (const INTL_LANG lang_id);
  extern bool lang_is_coll_name_allowed (const char *name);
  extern LANG_COLLATION *lang_get_collation (const int coll_id);
  extern const char *lang_get_collation_name (const int coll_id);
  extern LANG_COLLATION *lang_get_collation_by_name (const char *coll_name);
  extern int lang_collation_count (void);
  extern const char *lang_get_codeset_name (int codeset_id);
  extern const ALPHABET_DATA *lang_user_alphabet_w_coll (const int collation_id);
  extern TEXT_CONVERSION *lang_get_txt_conv (void);
  extern const char *lang_charset_name (const INTL_CODESET codeset);
  extern const char *lang_charset_cubrid_name (const INTL_CODESET codeset);

  extern int lang_strmatch_utf8_uca_w_coll_data (const COLL_DATA * coll_data, bool is_match, const unsigned char *str1,
                         const int size1, const unsigned char *str2, const int size2,
                         const unsigned char *escape, const bool has_last_escape,
                         int *str1_match_size, bool ignore_trailing_space);
  extern int lang_get_charset_env_string (char *buf, int buf_size, const char *lang_name, const INTL_CODESET charset);
#if !defined (SERVER_MODE)
  extern int lang_charset_name_to_id (const char *name, INTL_CODESET * codeset);
  extern int lang_db_put_charset (void);
  extern INTL_CODESET lang_get_client_charset (void);
  extern int lang_get_client_collation (void);
  extern void lang_set_parser_use_client_charset (bool use);
  extern bool lang_get_parser_use_client_charset (void);
#endif              /* !SERVER_MODE */

  extern INTL_CODESET lang_charset_cubrid_name_to_id (const char *name);
  extern const char *lang_charset_introducer (const INTL_CODESET codeset);
  extern int lang_load_library (const char *lib_file, void **handle);
  extern int lang_locale_data_load_from_lib (LANG_LOCALE_DATA * lld, void *lib_handle, const LOCALE_FILE * lf,
                         bool is_load_for_dump);
  extern int lang_load_count_coll_from_lib (int *count_coll, void *lib_handle, const LOCALE_FILE * lf);
  extern int lang_load_get_coll_name_from_lib (const int coll_pos, char **coll_name, void *lib_handle,
                           const LOCALE_FILE * lf);
  extern int lang_load_coll_from_lib (COLL_DATA * cd, void *lib_handle, const LOCALE_FILE * lf);

  extern UNICODE_NORMALIZATION *lang_get_generic_unicode_norm (void);
  extern void lang_set_generic_unicode_norm (UNICODE_NORMALIZATION * norm);
  extern int lang_check_coll_compat (const LANG_COLL_COMPAT * coll_array, const int coll_cnt, const char *client_text,
                     const char *server_text);
  extern int lang_check_locale_compat (const LANG_LOCALE_COMPAT * loc_array, const int loc_cnt, const char *client_text,
                       const char *server_text);
#ifdef __cplusplus
}
#endif

#endif              /* _LANGUAGE_SUPPORT_H_ */