2002-08-26 Roland McGrath <roland@redhat.com>
[kopensolaris-gnu/glibc.git] / locale / localeinfo.h
index eed6d93..44a10e1 100644 (file)
-/* Copyright (C) 1991 Free Software Foundation, Inc.
-This file is part of the GNU C Library.
+/* Declarations for internal libc locale interfaces
+   Copyright (C) 1995-2001, 2002 Free Software Foundation, Inc.
+   This file is part of the GNU C Library.
 
-The GNU C Library is free software; you can redistribute it and/or
-modify it under the terms of the GNU Library General Public License as
-published by the Free Software Foundation; either version 2 of the
-License, or (at your option) any later version.
+   The GNU C 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.1 of the License, or (at your option) any later version.
 
-The GNU C 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
-Library General Public License for more details.
+   The GNU C 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 Library General Public
-License along with the GNU C Library; see the file COPYING.LIB.  If
-not, write to the Free Software Foundation, Inc., 675 Mass Ave,
-Cambridge, MA 02139, USA.  */
+   You should have received a copy of the GNU Lesser General Public
+   License along with the GNU C Library; if not, write to the Free
+   Software Foundation, Inc., 59 Temple Place, Suite 330, Boston, MA
+   02111-1307 USA.  */
 
-/* Locale-specific information.  */
+#ifndef _LOCALEINFO_H
+#define _LOCALEINFO_H 1
 
-#ifndef        _LOCALEINFO_H
-
-#define        _LOCALEINFO_H   1
-
-#define        __need_size_t
-#define        __need_wchar_t
 #include <stddef.h>
+#include <langinfo.h>
 #include <limits.h>
-
-
-/* Change these if the `wchar_t' type is changed.  */
-#define        WCHAR_MAX       ((wchar_t) UCHAR_MAX)
-
-
-/* Used by multibyte char functions.  */
-typedef struct
-  {
-    char *string;      /* Bytes.  */
-    size_t len;                /* # of bytes.  */
-    long int shift;    /* # of mb_char's to shift.  */
-  } mb_char;
-
-struct ctype_mbchar_info
-  {
-    size_t mb_max;             /* Max MB char length.  */
-    mb_char *mb_chars;         /* MB chars.  */
-  };
-
-struct ctype_ctype_info
-  {
-    unsigned char *ctype_b;            /* Characteristics.  */
-    unsigned char *ctype_tolower;      /* Case mappings.  */
-    unsigned char *ctype_toupper;      /* Case mappings.  */
-  };
-
-struct ctype_info
+#include <locale.h>
+#include <time.h>
+#include <stdint.h>
+#include <sys/types.h>
+
+#include <intl/loadinfo.h>     /* For loaded_l10nfile definition.  */
+
+/* Magic number at the beginning of a locale data file for CATEGORY.  */
+#define        LIMAGIC(category)       ((unsigned int) (0x20000828 ^ (category)))
+
+/* Two special weight constants for the collation data.  */
+#define IGNORE_CHAR    2
+
+/* We use a special value for the usage counter in `locale_data' to
+   signal that this data must never be removed anymore.  */
+#define MAX_USAGE_COUNT (UINT_MAX - 1)
+#define UNDELETABLE    UINT_MAX
+
+/* Structure describing locale data in core for a category.  */
+struct locale_data
+{
+  const char *name;
+  const char *filedata;                /* Region mapping the file data.  */
+  off_t filesize;              /* Size of the file (and the region).  */
+  enum                         /* Flavor of storage used for those.  */
   {
-    struct ctype_ctype_info *ctype;
-    struct ctype_mbchar_info *mbchar;
-  };
-
-extern CONST struct ctype_info *_ctype_info;
+    ld_malloced,               /* Both are malloc'd.  */
+    ld_mapped,                 /* name is malloc'd, filedata mmap'd */
+    ld_archive                 /* Both point into mmap'd archive regions.  */
+  } alloc;
 
-/* These are necessary because they are used in a header file.  */
-extern CONST unsigned char *__ctype_b;
-extern CONST unsigned char *__ctype_tolower;
-extern CONST unsigned char *__ctype_toupper;
+  unsigned int usage_count;    /* Counter for users.  */
 
+  int use_translit;            /* Nonzero if the mb*towv*() and wc*tomb()
+                                  functions should use transliteration.  */
 
-/* Used by strcoll and strxfrm.  */
-typedef struct
+  unsigned int nstrings;       /* Number of strings below.  */
+  union locale_data_value
   {
-    unsigned char *values;
-    size_t nvalues;
-  } literal_value;
+    const uint32_t *wstr;
+    const char *string;
+    unsigned int word;
+  }
+  values __flexarr;    /* Items, usually pointers into `filedata'.  */
+};
+
+/* We know three kinds of collation sorting rules.  */
+enum coll_sort_rule
+{
+  illegal_0__,
+  sort_forward,
+  sort_backward,
+  illegal_3__,
+  sort_position,
+  sort_forward_position,
+  sort_backward_position,
+  sort_mask
+};
+
+/* We can map the types of the entries into a few categories.  */
+enum value_type
+{
+  none,
+  string,
+  stringarray,
+  byte,
+  bytearray,
+  word,
+  stringlist,
+  wordarray,
+  wstring,
+  wstringarray,
+  wstringlist
+};
+
+
+/* Definitions for `era' information from LC_TIME.  */
+#define ERA_NAME_FORMAT_MEMBERS 4
+#define ERA_M_NAME   0
+#define ERA_M_FORMAT 1
+#define ERA_W_NAME   2
+#define ERA_W_FORMAT 3
+
+
+/* Structure to access `era' information from LC_TIME.  */
+struct era_entry
+{
+  uint32_t direction;          /* Contains '+' or '-'.  */
+  int32_t offset;
+  int32_t start_date[3];
+  int32_t stop_date[3];
+  const char *era_name;
+  const char *era_format;
+  const wchar_t *era_wname;
+  const wchar_t *era_wformat;
+  int absolute_direction;
+  /* absolute direction:
+     +1 indicates that year number is higher in the future. (like A.D.)
+     -1 indicates that year number is higher in the past. (like B.C.)  */
+};
+
+
+/* LC_CTYPE specific:
+   Hardwired indices for standard wide character translation mappings.  */
+enum
+{
+  __TOW_toupper = 0,
+  __TOW_tolower = 1
+};
+
+
+/* LC_CTYPE specific:
+   Access a wide character class with a single character index.
+   _ISCTYPE (c, desc) = iswctype (btowc (c), desc).
+   c must be an `unsigned char'.  desc must be a nonzero wctype_t.  */
+#define _ISCTYPE(c, desc) \
+  (((((const uint32_t *) (desc)) - 8)[(c) >> 5] >> ((c) & 0x1f)) & 1)
+
+extern const char *const _nl_category_names[__LC_LAST] attribute_hidden;
+extern const size_t _nl_category_name_sizes[__LC_LAST] attribute_hidden;
+
+/* Name of the standard locales.  */
+extern const char _nl_C_name[] attribute_hidden;
+extern const char _nl_POSIX_name[] attribute_hidden;
+
+/* The standard codeset.  */
+extern const char _nl_C_codeset[] attribute_hidden;
+
+/* Name of current locale for each individual category.
+   Each is malloc'd unless it is _nl_C_name.  */
+extern const char *_nl_current_names[] attribute_hidden;
+
+
+#ifndef SHARED
+
+/* For each category declare the variable for the current locale data.  */
+/* XXX _nl_current_LC_CTYPE and _nl_current_LC_COLLATE were exported
+   but where are they used?  */
+#define DEFINE_CATEGORY(category, category_name, items, a) \
+extern struct locale_data *_nl_current_##category attribute_hidden;
+#include "categories.def"
+#undef DEFINE_CATEGORY
+extern struct locale_data * *const _nl_current[__LC_LAST] attribute_hidden;
+
+/* Return a pointer to the current `struct locale_data' for CATEGORY.  */
+#define _NL_CURRENT_DATA(category)     _nl_current_##category
+/* Hackety hack, don't talk back.  */
+#define _nl_current_category           (*_nl_current[category])
+
+/* Extract the current CATEGORY locale's string for ITEM.  */
+#define _NL_CURRENT(category, item) \
+  (_nl_current_##category->values[_NL_ITEM_INDEX (item)].string)
+
+/* Extract the current CATEGORY locale's string for ITEM.  */
+#define _NL_CURRENT_WSTR(category, item) \
+  ((wchar_t *) _nl_current_##category->values[_NL_ITEM_INDEX (item)].wstr)
+
+/* Extract the current CATEGORY locale's word for ITEM.  */
+#define _NL_CURRENT_WORD(category, item) \
+  (_nl_current_##category->values[_NL_ITEM_INDEX (item)].word)
+
+/* This is used in lc-CATEGORY.c to define _nl_current_CATEGORY.  */
+#define _NL_CURRENT_DEFINE(category) \
+  extern struct locale_data _nl_C_##category attribute_hidden; \
+  struct locale_data *_nl_current_##category = &_nl_C_##category
+
+#else
+
+/* All categories are always loaded in the shared library, so there is no
+   point in having lots of separate symbols for linking.  */
+
+# include <bits/libc-tsd.h>
 
-typedef struct
-  {
-    union
-      {
-       literal_value literal;
-       /* %%% This may become a regex_t in the future.  */
-       char *regexp;
-      } replace, with;
-    unsigned int regexp:1;
-  } subst;
-
-struct collate_info
-  {
-    size_t nsubsts;
-    subst *substs;
+__libc_tsd_define (extern, LOCALE)
 
-    unsigned char *values;
-    unsigned char *offsets;
-  };
+extern struct __locale_struct _nl_global_locale attribute_hidden;
+
+# define _NL_CURRENT_LOCALE \
+  ((__locale_t) __libc_tsd_get (LOCALE))
 
-extern CONST struct collate_info *_collate_info;
+/* Return a pointer to the current `struct locale_data' for CATEGORY.  */
+# define _NL_CURRENT_DATA(category) \
+  (_NL_CURRENT_LOCALE->__locales[category])
 
+/* Extract the current CATEGORY locale's string for ITEM.  */
+# define _NL_CURRENT(category, item) \
+  (_NL_CURRENT_DATA (category)->values[_NL_ITEM_INDEX (item)].string)
 
-/* Used by strtod, atof.  */
-struct numeric_info
-  {
-    char *decimal_point;
-    char *thousands_sep;
-    char *grouping;
-  };
+/* Extract the current CATEGORY locale's string for ITEM.  */
+# define _NL_CURRENT_WSTR(category, item) \
+  ((wchar_t *) _NL_CURRENT_DATA (category)->values[_NL_ITEM_INDEX (item)].wstr)
 
-extern CONST struct numeric_info *_numeric_info;
+/* Extract the current CATEGORY locale's word for ITEM.  */
+# define _NL_CURRENT_WORD(category, item) \
+  (_NL_CURRENT_DATA (category)->values[_NL_ITEM_INDEX (item)].word)
 
+/* This is used in lc-CATEGORY.c to define _nl_current_CATEGORY.  */
+# define _NL_CURRENT_DEFINE(category) \
+  /* No per-category variable here. */
 
-/* Used in the return value of localeconv.  */
-struct monetary_info
-  {
-    char *int_curr_symbol;
-    char *currency_symbol;
-    char *mon_decimal_point;
-    char *mon_thousands_sep;
-    char *mon_grouping;
-    char *positive_sign;
-    char *negative_sign;
-    char int_frac_digits;
-    char frac_digits;
-    char p_cs_precedes;
-    char p_sep_by_space;
-    char n_cs_precedes;
-    char n_sep_by_space;
-    char p_sign_posn;
-    char n_sign_posn;
-  };
-
-extern CONST struct monetary_info *_monetary_info;
-
-
-/* Used by strftime, asctime.  */
-struct time_info
-  {
-    char *abbrev_wkday[7];     /* Short weekday names.  */
-    char *full_wkday[7];       /* Full weekday names.  */
-    char *abbrev_month[12];    /* Short month names.  */
-    char *full_month[12];      /* Full month names.  */
-    char *ampm[2];             /* "AM" and "PM" strings.  */
+#endif
 
-    char *date_time;           /* Appropriate date and time format.  */
-    char *date;                        /* Appropriate date format.  */
-    char *time;                        /* Appropriate time format.  */
 
-    char *ut0;                 /* Name for GMT.  */
-    char *tz;                  /* Default TZ value.  */
-  };
+/* Default search path if no LOCPATH environment variable.  */
+extern const char _nl_default_locale_path[] attribute_hidden;
 
-extern CONST struct time_info *_time_info;
+/* Load the locale data for CATEGORY from the file specified by *NAME.
+   If *NAME is "", use environment variables as specified by POSIX, and
+   fill in *NAME with the actual name used.  If LOCALE_PATH is not null,
+   those directories are searched for the locale files.  If it's null,
+   the locale archive is checked first and then _nl_default_locale_path
+   is searched for locale files.  */
+extern struct locale_data *_nl_find_locale (const char *locale_path,
+                                           size_t locale_path_len,
+                                           int category, const char **name)
+     internal_function attribute_hidden;
 
-struct response_info
-  {
-    /* Regexp for affirmative answers.  */
-    char *yesexpr;
+/* Try to load the file described by FILE.  */
+extern void _nl_load_locale (struct loaded_l10nfile *file, int category)
+     internal_function attribute_hidden;
 
-    /* Regexp for negative answers.  */
-    char *noexpr;
-  };
+/* Free all resource.  */
+extern void _nl_unload_locale (struct locale_data *locale)
+     internal_function attribute_hidden;
 
-extern CONST struct response_info *_response_info;
+/* Free the locale and give back all memory if the usage count is one.  */
+extern void _nl_remove_locale (int locale, struct locale_data *data)
+     internal_function attribute_hidden;
 
-/* Locale structure.  */
-typedef struct
-  {
-    char *name;
-    int categories;
+/* Find the locale *NAMEP in the locale archive, and return the
+   internalized data structure for its CATEGORY data.  If this locale has
+   already been loaded from the archive, just returns the existing data
+   structure.  If successful, sets *NAMEP to point directly into the mapped
+   archive string table; that way, the next call can short-circuit strcmp.  */
+extern struct locale_data *_nl_load_locale_from_archive (int category,
+                                                        const char **namep)
+     internal_function attribute_hidden;
 
-    unsigned int allocated:1;
+/* Subroutine of setlocale's __libc_subfreeres hook.  */
+extern void _nl_archive_subfreeres (void) attribute_hidden;
 
-    int subcategories;
-    size_t num_sublocales;
-    struct sub_locale *sublocales;
+/* Validate the contents of a locale file and set up the in-core
+   data structure to point into the data.  This leaves the `alloc'
+   and `name' fields uninitialized, for the caller to fill in.
+   If any bogons are detected in the data, this will refuse to
+   intern it, and return a null pointer instead.  */
+extern struct locale_data *_nl_intern_locale_data (int category,
+                                                  const void *data,
+                                                  size_t datasize)
+     internal_function attribute_hidden;
 
-    PTR *info;
-  } locale;
-
-typedef struct sub_locale
-  {
-    unsigned int pointer:1;
 
-    int categories;
-    char *name;
+/* Return `era' entry which corresponds to TP.  Used in strftime.  */
+extern struct era_entry *_nl_get_era_entry (const struct tm *tp);
 
-    locale *locale;
-  } sublocale;
+/* Return `era' cnt'th entry .  Used in strptime.  */
+extern struct era_entry *_nl_select_era_entry (int cnt);
 
+/* Return `alt_digit' which corresponds to NUMBER.  Used in strftime.  */
+extern const char *_nl_get_alt_digit (unsigned int number);
 
-/* This is the magic number that localeinfo object files begin with.
-   In case you're wondering why I chose the value 0x051472CA, it's
-   because I was born on 05-14-72 in Oakland, CA.  */
-#define        LIMAGIC         0x051472CA
-/* This is the magic number that precedes each category-specific section
-   of a localeinfo object file.  It's the arbitrary magic number above,
-   but modified by the category so that it's different from the per-file
-   magic number and unique for each category.  */
-#define        CATEGORY_MAGIC(x)       (LIMAGIC ^ (x))
+/* Similar, but now for wide characters.  */
+extern const wchar_t *_nl_get_walt_digit (unsigned int number);
 
-extern CONST char *__lidir, *__lidefault;
+/* Parse string as alternative digit and return numeric value.  */
+extern int _nl_parse_alt_digit (const char **strp);
 
-extern locale *EXFUN(__find_locale, (int categories, CONST char *name));
-extern locale *EXFUN(__new_locale, (locale *));
-extern locale *EXFUN(__localefile, (CONST char *file));
-extern void EXFUN(__free_locale, (locale *));
+/* Postload processing.  */
+extern void _nl_postload_ctype (void);
+extern void _nl_postload_time (void);
 
 
-#endif /* localeinfo.h  */
+#endif /* localeinfo.h */