Moved to bits/in.h.
[kopensolaris-gnu/glibc.git] / locale / localeinfo.h
index eed6d93..79db06d 100644 (file)
-/* Copyright (C) 1991 Free Software Foundation, Inc.
-This file is part of the GNU C Library.
+/* localeinfo.h -- declarations for internal libc locale interfaces
+   Copyright (C) 1995, 1996, 1997 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 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 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
+   Library 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 Library General Public
+   License along with the GNU C Library; see the file COPYING.LIB.  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>
+#include <time.h>
+#include <sys/types.h>
 
+#include "../intl/loadinfo.h"  /* For loaded_l10nfile definition.  */
 
-/* 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
-  {
-    struct ctype_ctype_info *ctype;
-    struct ctype_mbchar_info *mbchar;
-  };
+/* Magic number at the beginning of a locale data file for CATEGORY.  */
+#define        LIMAGIC(category)       (0x960617de ^ (category))
 
-extern CONST struct ctype_info *_ctype_info;
+/* Two special weight constants for the collation data.  */
+#define FORWARD_CHAR ((wchar_t) 0xfffffffd)
+#define ELLIPSIS_CHAR ((wchar_t) 0xfffffffe)
+#define IGNORE_CHAR ((wchar_t) 0xffffffff)
 
-/* 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;
+/* 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
 
+/* 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).  */
+  int mmaped;                  /* If nonzero the data is mmaped.  */
 
-/* Used by strcoll and strxfrm.  */
-typedef struct
-  {
-    unsigned char *values;
-    size_t nvalues;
-  } literal_value;
+  unsigned int usage_count;    /* Counter for users.  */
 
-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;
-
-    unsigned char *values;
-    unsigned char *offsets;
-  };
-
-extern CONST struct collate_info *_collate_info;
-
-
-/* Used by strtod, atof.  */
-struct numeric_info
-  {
-    char *decimal_point;
-    char *thousands_sep;
-    char *grouping;
-  };
-
-extern CONST struct numeric_info *_numeric_info;
-
-
-/* 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
+  unsigned int nstrings;       /* Number of strings below.  */
+  union locale_data_value
   {
-    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.  */
-
-    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.  */
-  };
-
-extern CONST struct time_info *_time_info;
-
-struct response_info
-  {
-    /* Regexp for affirmative answers.  */
-    char *yesexpr;
-
-    /* Regexp for negative answers.  */
-    char *noexpr;
-  };
-
-extern CONST struct response_info *_response_info;
-
-/* Locale structure.  */
-typedef struct
-  {
-    char *name;
-    int categories;
-
-    unsigned int allocated:1;
-
-    int subcategories;
-    size_t num_sublocales;
-    struct sub_locale *sublocales;
-
-    PTR *info;
-  } locale;
-
-typedef struct sub_locale
-  {
-    unsigned int pointer:1;
-
-    int categories;
-    char *name;
-
-    locale *locale;
-  } sublocale;
-
-
-/* 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))
-
-extern CONST char *__lidir, *__lidefault;
-
-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 *));
-
-
-#endif /* localeinfo.h  */
+    const wchar_t *wstr;
+    const char *string;
+    unsigned int word;
+  }
+  values[0];   /* 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
+};
+
+
+/* Structure to access `era' information from LC_TIME.  */
+struct era_entry
+{
+  u_int32_t direction;         /* Contains '+' or '-'.  */
+  int32_t offset;
+  int32_t start_date[3];
+  int32_t stop_date[3];
+  const char name_fmt[0];
+};
+
+
+/* For each category declare the variable for the current locale data.  */
+#define DEFINE_CATEGORY(category, category_name, items, a, b, c, d) \
+extern struct locale_data *_nl_current_##category;
+#include "categories.def"
+#undef DEFINE_CATEGORY
+
+extern const char *const _nl_category_names[LC_ALL + 1];
+extern const size_t _nl_category_name_sizes[LC_ALL + 1];
+extern struct locale_data * *const _nl_current[LC_ALL + 1];
+
+/* Name of the standard locale.  */
+extern const char _nl_C_name[];
+
+/* 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 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; \
+  struct locale_data *_nl_current_##category = &_nl_C_##category
+
+/* 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.  The directories
+   listed in LOCALE_PATH are searched for the locale files.  */
+extern struct locale_data *_nl_find_locale (const char *locale_path,
+                                           size_t locale_path_len,
+                                           int category, const char **name);
+
+/* Try to load the file described by FILE.  */
+extern void _nl_load_locale (struct loaded_l10nfile *file, int category);
+
+/* 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);
+
+
+/* Return `era' entry which corresponds to TP.  Used in strftime.  */
+extern struct era_entry *_nl_get_era_entry (const struct tm *tp);
+
+/* Return `alt_digit' which corresponds to NUMBER.  Used in strftime.  */
+extern const char *_nl_get_alt_digit (unsigned int number);
+
+
+/* Global variables for LC_COLLATE category data.  */
+extern const u_int32_t *__collate_table;
+extern const u_int32_t *__collate_extra;
+extern const u_int32_t *__collate_element_hash;
+extern const char *__collate_element_strings;
+extern const wchar_t *__collate_element_values;
+extern const u_int32_t *__collate_symbol_hash;
+extern const char *__collate_symbol_strings;
+extern const u_int32_t *__collate_symbol_classes;
+
+#endif /* localeinfo.h */