locale/localeinfo.h

   1 /* localeinfo.h -- declarations for internal libc locale interfaces
   2 Copyright (C) 1995, 1996 Free Software Foundation, Inc.
   3 This file is part of the GNU C Library.
   4
   5 The GNU C Library is free software; you can redistribute it and/or
   6 modify it under the terms of the GNU Library General Public License as
   7 published by the Free Software Foundation; either version 2 of the
   8 License, or (at your option) any later version.
   9
  10 The GNU C Library is distributed in the hope that it will be useful,
  11 but WITHOUT ANY WARRANTY; without even the implied warranty of
  12 MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the GNU
  13 Library General Public License for more details.
  14
  15 You should have received a copy of the GNU Library General Public
  16 License along with the GNU C Library; see the file COPYING.LIB.  If
  17 not, write to the Free Software Foundation, Inc., 675 Mass Ave,
  18 Cambridge, MA 02139, USA.  */
  19
  20 #ifndef _LOCALEINFO_H
  21 #define _LOCALEINFO_H 1
  22
  23 #include <stddef.h>
  24 #include <langinfo.h>
  25 #include <time.h>
  26 #include <sys/types.h>
  27
  28 #include "../intl/loadinfo.h"   /* For loaded_l10nfile definition.  */
  29
  30 /* Magic number at the beginning of a locale data file for CATEGORY.  */
  31 #define LIMAGIC(category)       (0x960617de ^ (category))
  32
  33 /* Two special weight constants for the collation data.  */
  34 #define FORWARD_CHAR ((wchar_t) 0xfffffffd)
  35 #define ELLIPSIS_CHAR ((wchar_t) 0xfffffffe)
  36 #define IGNORE_CHAR ((wchar_t) 0xffffffff)
  37
  38 /* Structure describing locale data in core for a category.  */
  39 struct locale_data
  40 {
  41   const char *name;
  42   const char *filedata;         /* Region mapping the file data.  */
  43   off_t filesize;               /* Size of the file (and the region).  */
  44
  45   unsigned int nstrings;        /* Number of strings below.  */
  46   union locale_data_value
  47   {
  48     const wchar_t *wstr;
  49     const char *string;
  50     unsigned int word;
  51   }
  52   values[0];    /* Items, usually pointers into `filedata'.  */
  53 };
  54
  55 /* We know three kinds of collation sorting rules.  */
  56 enum coll_sort_rule
  57 {
  58   illegal_0__,
  59   sort_forward,
  60   sort_backward,
  61   illegal_3__,
  62   sort_position,
  63   sort_forward_position,
  64   sort_backward_position,
  65   sort_mask
  66 };
  67
  68 /* We can map the types of the entries into a few categories.  */
  69 enum value_type
  70 {
  71   none,
  72   string,
  73   stringarray,
  74   byte,
  75   bytearray,
  76   word
  77 };
  78
  79
  80 /* Structure to access `era' information from LC_TIME.  */
  81 struct era_entry
  82 {
  83   u_int32_t direction;          /* Contains '+' or '-'.  */
  84   int32_t offset;
  85   int32_t start_date[3];
  86   int32_t stop_date[3];
  87   const char name_fmt[0];
  88 };
  89
  90
  91 /* For each category declare the variable for the current locale data.  */
  92 #define DEFINE_CATEGORY(category, category_name, items, a, b, c, d) \
  93 extern const struct locale_data *_nl_current_##category;
  94 #include "categories.def"
  95 #undef  DEFINE_CATEGORY
  96
  97 extern const char *const _nl_category_names[LC_ALL + 1];
  98 extern const size_t _nl_category_name_sizes[LC_ALL + 1];
  99 extern const struct locale_data * *const _nl_current[LC_ALL];
 100
 101 /* Name of the standard locale.  */
 102 extern const char _nl_C_name[];
 103
 104 /* Extract the current CATEGORY locale's string for ITEM.  */
 105 #define _NL_CURRENT(category, item) \
 106   (_nl_current_##category->values[_NL_ITEM_INDEX (item)].string)
 107
 108 /* Extract the current CATEGORY locale's word for ITEM.  */
 109 #define _NL_CURRENT_WORD(category, item) \
 110   (_nl_current_##category->values[_NL_ITEM_INDEX (item)].word)
 111
 112 /* This is used in lc-CATEGORY.c to define _nl_current_CATEGORY.  */
 113 #define _NL_CURRENT_DEFINE(category) \
 114   extern const struct locale_data _nl_C_##category; \
 115   const struct locale_data *_nl_current_##category = &_nl_C_##category
 116
 117 /* Load the locale data for CATEGORY from the file specified by *NAME.
 118    If *NAME is "", use environment variables as specified by POSIX,
 119    and fill in *NAME with the actual name used.  The directories
 120    listed in LOCALE_PATH are searched for the locale files.  */
 121 extern const struct locale_data *_nl_find_locale (const char *locale_path,
 122                                                   size_t locale_path_len,
 123                                                   int category, char **name);
 124
 125 /* Try to load the file described by FILE.  */
 126 extern void _nl_load_locale (struct loaded_l10nfile *file, int category);
 127
 128
 129 /* Return `era' entry which corresponds to TP.  Used in strftime.  */
 130 struct era_entry *_nl_get_era_entry (const struct tm *tp);
 131
 132 /* Return `alt_digit' which corresponds to NUMBER.  Used in strftime.  */
 133 const char *_nl_get_alt_digit (unsigned int number);
 134
 135
 136 /* Global variables for LC_COLLATE category data.  */
 137 extern const u_int32_t *__collate_table;
 138 extern const u_int32_t *__collate_extra;
 139 extern const u_int32_t *__collate_element_hash;
 140 extern const char *__collate_element_strings;
 141 extern const wchar_t *__collate_element_values;
 142 extern const u_int32_t *__collate_symbol_hash;
 143 extern const char *__collate_symbol_strings;
 144 extern const u_int32_t *__collate_symbol_classes;
 145
 146 #endif  /* localeinfo.h */