locale/localeinfo.h

   1 /* localeinfo.h -- declarations for internal libc locale interfaces
   2    Copyright (C) 1995, 1996, 1997 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 not,
  17    write to the Free Software Foundation, Inc., 59 Temple Place - Suite 330,
  18    Boston, MA 02111-1307, USA.  */
  19
  20 #ifndef _LOCALEINFO_H
  21 #define _LOCALEINFO_H 1
  22
  23 #include <stddef.h>
  24 #include <langinfo.h>
  25 #include <limits.h>
  26 #include <time.h>
  27 #include <sys/types.h>
  28
  29 #include "../intl/loadinfo.h"   /* For loaded_l10nfile definition.  */
  30
  31 /* Magic number at the beginning of a locale data file for CATEGORY.  */
  32 #define LIMAGIC(category)       (0x960617de ^ (category))
  33
  34 /* Two special weight constants for the collation data.  */
  35 #define FORWARD_CHAR ((wchar_t) 0xfffffffd)
  36 #define ELLIPSIS_CHAR ((wchar_t) 0xfffffffe)
  37 #define IGNORE_CHAR ((wchar_t) 0xffffffff)
  38
  39 /* We use a special value for the usage counter in `locale_data' to
  40    signal that this data must never be removed anymore.  */
  41 #define MAX_USAGE_COUNT UINT_MAX
  42
  43 /* Structure describing locale data in core for a category.  */
  44 struct locale_data
  45 {
  46   const char *name;
  47   const char *filedata;         /* Region mapping the file data.  */
  48   off_t filesize;               /* Size of the file (and the region).  */
  49   int mmaped;                   /* If nonzero the data is mmaped.  */
  50
  51   unsigned int usage_count;     /* Counter for users.  */
  52
  53   unsigned int nstrings;        /* Number of strings below.  */
  54   union locale_data_value
  55   {
  56     const wchar_t *wstr;
  57     const char *string;
  58     unsigned int word;
  59   }
  60   values[0];    /* Items, usually pointers into `filedata'.  */
  61 };
  62
  63 /* We know three kinds of collation sorting rules.  */
  64 enum coll_sort_rule
  65 {
  66   illegal_0__,
  67   sort_forward,
  68   sort_backward,
  69   illegal_3__,
  70   sort_position,
  71   sort_forward_position,
  72   sort_backward_position,
  73   sort_mask
  74 };
  75
  76 /* We can map the types of the entries into a few categories.  */
  77 enum value_type
  78 {
  79   none,
  80   string,
  81   stringarray,
  82   byte,
  83   bytearray,
  84   word
  85 };
  86
  87
  88 /* Structure to access `era' information from LC_TIME.  */
  89 struct era_entry
  90 {
  91   u_int32_t direction;          /* Contains '+' or '-'.  */
  92   int32_t offset;
  93   int32_t start_date[3];
  94   int32_t stop_date[3];
  95   const char name_fmt[0];
  96 };
  97
  98
  99 /* For each category declare the variable for the current locale data.  */
 100 #define DEFINE_CATEGORY(category, category_name, items, a, b, c, d) \
 101 extern struct locale_data *_nl_current_##category;
 102 #include "categories.def"
 103 #undef  DEFINE_CATEGORY
 104
 105 extern const char *const _nl_category_names[LC_ALL + 1];
 106 extern const size_t _nl_category_name_sizes[LC_ALL + 1];
 107 extern struct locale_data * *const _nl_current[LC_ALL + 1];
 108
 109 /* Name of the standard locale.  */
 110 extern const char _nl_C_name[];
 111
 112 /* Extract the current CATEGORY locale's string for ITEM.  */
 113 #define _NL_CURRENT(category, item) \
 114   (_nl_current_##category->values[_NL_ITEM_INDEX (item)].string)
 115
 116 /* Extract the current CATEGORY locale's word for ITEM.  */
 117 #define _NL_CURRENT_WORD(category, item) \
 118   (_nl_current_##category->values[_NL_ITEM_INDEX (item)].word)
 119
 120 /* This is used in lc-CATEGORY.c to define _nl_current_CATEGORY.  */
 121 #define _NL_CURRENT_DEFINE(category) \
 122   extern struct locale_data _nl_C_##category; \
 123   struct locale_data *_nl_current_##category = &_nl_C_##category
 124
 125 /* Load the locale data for CATEGORY from the file specified by *NAME.
 126    If *NAME is "", use environment variables as specified by POSIX,
 127    and fill in *NAME with the actual name used.  The directories
 128    listed in LOCALE_PATH are searched for the locale files.  */
 129 extern struct locale_data *_nl_find_locale (const char *locale_path,
 130                                             size_t locale_path_len,
 131                                             int category, const char **name);
 132
 133 /* Try to load the file described by FILE.  */
 134 extern void _nl_load_locale (struct loaded_l10nfile *file, int category);
 135
 136 /* Free the locale and give back all memory if the usage count is one.  */
 137 extern void _nl_remove_locale (int locale, struct locale_data *data);
 138
 139
 140 /* Return `era' entry which corresponds to TP.  Used in strftime.  */
 141 extern struct era_entry *_nl_get_era_entry (const struct tm *tp);
 142
 143 /* Return `alt_digit' which corresponds to NUMBER.  Used in strftime.  */
 144 extern const char *_nl_get_alt_digit (unsigned int number);
 145
 146
 147 /* Global variables for LC_COLLATE category data.  */
 148 extern const u_int32_t *__collate_table;
 149 extern const u_int32_t *__collate_extra;
 150 extern const u_int32_t *__collate_element_hash;
 151 extern const char *__collate_element_strings;
 152 extern const wchar_t *__collate_element_values;
 153 extern const u_int32_t *__collate_symbol_hash;
 154 extern const char *__collate_symbol_strings;
 155 extern const u_int32_t *__collate_symbol_classes;
 156
 157 #endif  /* localeinfo.h */