locale/programs/localedef.h

   1 /* General definitions for localedef(1).
   2    Copyright (C) 1998-2017 Free Software Foundation, Inc.
   3    This file is part of the GNU C Library.
   4    Contributed by Ulrich Drepper <drepper@cygnus.com>, 1998.
   5
   6    This program is free software; you can redistribute it and/or modify
   7    it under the terms of the GNU General Public License as published
   8    by the Free Software Foundation; version 2 of the License, or
   9    (at your option) any later version.
  10
  11    This program is distributed in the hope that it will be useful,
  12    but WITHOUT ANY WARRANTY; without even the implied warranty of
  13    MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
  14    GNU General Public License for more details.
  15
  16    You should have received a copy of the GNU General Public License
  17    along with this program; if not, see <http://www.gnu.org/licenses/>.  */
  18
  19 #ifndef _LOCALEDEF_H
  20 #define _LOCALEDEF_H    1
  21
  22 /* Get the basic locale definitions.  */
  23 #include <errno.h>
  24 #include <locale.h>
  25 #include <stdbool.h>
  26 #include <stddef.h>
  27
  28 #include "repertoire.h"
  29 #include "../locarchive.h"
  30
  31
  32 /* We need a bitmask for the locales.  */
  33 enum
  34 {
  35   CTYPE_LOCALE = 1 << LC_CTYPE,
  36   NUMERIC_LOCALE = 1 << LC_NUMERIC,
  37   TIME_LOCALE = 1 << LC_TIME,
  38   COLLATE_LOCALE = 1 << LC_COLLATE,
  39   MONETARY_LOCALE = 1 << LC_MONETARY,
  40   MESSAGES_LOCALE = 1 << LC_MESSAGES,
  41   PAPER_LOCALE = 1 << LC_PAPER,
  42   NAME_LOCALE = 1 << LC_NAME,
  43   ADDRESS_LOCALE = 1 << LC_ADDRESS,
  44   TELEPHONE_LOCALE = 1 << LC_TELEPHONE,
  45   MEASUREMENT_LOCALE = 1 << LC_MEASUREMENT,
  46   IDENTIFICATION_LOCALE = 1 << LC_IDENTIFICATION,
  47   ALL_LOCALES = (1 << LC_CTYPE
  48                  | 1 << LC_NUMERIC
  49                  | 1 << LC_TIME
  50                  | 1 << LC_COLLATE
  51                  | 1 << LC_MONETARY
  52                  | 1 << LC_MESSAGES
  53                  | 1 << LC_PAPER
  54                  | 1 << LC_NAME
  55                  | 1 << LC_ADDRESS
  56                  | 1 << LC_TELEPHONE
  57                  | 1 << LC_MEASUREMENT
  58                  | 1 << LC_IDENTIFICATION)
  59 };
  60
  61
  62 /* Opaque types for the different locales.  */
  63 struct locale_ctype_t;
  64 struct locale_collate_t;
  65 struct locale_monetary_t;
  66 struct locale_numeric_t;
  67 struct locale_time_t;
  68 struct locale_messages_t;
  69 struct locale_paper_t;
  70 struct locale_name_t;
  71 struct locale_address_t;
  72 struct locale_telephone_t;
  73 struct locale_measurement_t;
  74 struct locale_identification_t;
  75
  76
  77 /* Definitions for the locale.  */
  78 struct localedef_t
  79 {
  80   struct localedef_t *next;
  81
  82   const char *name;
  83
  84   int needed;
  85   int avail;
  86
  87   union
  88   {
  89     void *generic;
  90     struct locale_ctype_t *ctype;
  91     struct locale_collate_t *collate;
  92     struct locale_monetary_t *monetary;
  93     struct locale_numeric_t *numeric;
  94     struct locale_time_t *time;
  95     struct locale_messages_t *messages;
  96     struct locale_paper_t *paper;
  97     struct locale_name_t *name;
  98     struct locale_address_t *address;
  99     struct locale_telephone_t *telephone;
 100     struct locale_measurement_t *measurement;
 101     struct locale_identification_t *identification;
 102   } categories[__LC_LAST];
 103
 104   size_t len[__LC_LAST];
 105
 106   const char *copy_name[__LC_LAST];
 107
 108   const char *repertoire_name;
 109 };
 110
 111
 112 /* Global variables of the localedef program.  */
 113 extern int verbose;
 114 extern int be_quiet;
 115 extern const char *repertoire_global;
 116 extern int max_locarchive_open_retry;
 117 extern bool no_archive;
 118 extern const char *alias_file;
 119
 120
 121 /* Prototypes for a few program-wide used functions.  */
 122 #include <programs/xmalloc.h>
 123
 124
 125 /* Wrapper to switch LC_CTYPE back to the locale specified in the
 126    environment for output.  */
 127 #define WITH_CUR_LOCALE(stmt)                                   \
 128   do {                                                          \
 129       int saved_errno = errno;                                  \
 130       const char *cur_locale_ = setlocale (LC_CTYPE, NULL);     \
 131       setlocale (LC_CTYPE, "");                                 \
 132       errno = saved_errno;                                      \
 133       stmt;                                                     \
 134       setlocale (LC_CTYPE, cur_locale_);                        \
 135   } while (0)
 136
 137
 138 /* Mark given locale as to be read.  */
 139 extern struct localedef_t *add_to_readlist (int locale, const char *name,
 140                                             const char *repertoire_name,
 141                                             int generate,
 142                                             struct localedef_t *copy_locale);
 143
 144 /* Find the information for the locale NAME.  */
 145 extern struct localedef_t *find_locale (int locale, const char *name,
 146                                         const char *repertoire_name,
 147                                         const struct charmap_t *charmap);
 148
 149 /* Load (if necessary) the information for the locale NAME.  */
 150 extern struct localedef_t *load_locale (int locale, const char *name,
 151                                         const char *repertoire_name,
 152                                         const struct charmap_t *charmap,
 153                                         struct localedef_t *copy_locale);
 154
 155
 156 /* Open the locale archive.  */
 157 extern void open_archive (struct locarhandle *ah, bool readonly);
 158
 159 /* Close the locale archive.  */
 160 extern void close_archive (struct locarhandle *ah);
 161
 162 /* Add given locale data to the archive.  */
 163 extern int add_locale_to_archive (struct locarhandle *ah, const char *name,
 164                                   locale_data_t data, bool replace);
 165
 166 /* Add content of named directories to locale archive.  */
 167 extern int add_locales_to_archive (size_t nlist, char *list[], bool replace);
 168
 169 /* Removed named locales from archive.  */
 170 extern int delete_locales_from_archive (size_t nlist, char *list[]);
 171
 172 /* List content of locale archive. If FNAME is non-null use that as
 173    the locale archive to list, otherwise the default.  */
 174 extern void show_archive_content (const char *fname,
 175                                   int verbose) __attribute__ ((noreturn));
 176
 177 #endif /* localedef.h */