Update for locale rewrite.
[kopensolaris-gnu/glibc.git] / locale / programs / localedef.c
1 /* Copyright (C) 1995, 1996, 1997, 1998, 1999 Free Software Foundation, Inc.
2    This file is part of the GNU C Library.
3    Contributed by Ulrich Drepper <drepper@cygnus.com>, 1995.
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 #ifdef HAVE_CONFIG_H
21 # include <config.h>
22 #endif
23
24 #include <argp.h>
25 #include <errno.h>
26 #include <fcntl.h>
27 #include <libintl.h>
28 #include <locale.h>
29 #include <stdio.h>
30 #include <stdlib.h>
31 #include <string.h>
32 #include <unistd.h>
33 #include <sys/mman.h>
34 #include <sys/stat.h>
35
36 #include "error.h"
37 #include "charmap.h"
38 #include "locfile.h"
39
40 /* Undefine the following line in the production version.  */
41 /* #define NDEBUG 1 */
42 #include <assert.h>
43
44
45 /* List of copied locales.  */
46 struct copy_def_list_t *copy_list;
47
48 /* If this is defined be POSIX conform.  */
49 int posix_conformance;
50
51 /* If not zero give a lot more messages.  */
52 int verbose;
53
54 /* If not zero suppress warnings and information messages.  */
55 int be_quiet;
56
57 /* If not zero force output even if warning were issued.  */
58 static int force_output;
59
60 /* Name of the character map file.  */
61 static const char *charmap_file;
62
63 /* Name of the locale definition file.  */
64 static const char *input_file;
65
66 /* Name of the repertoire map file.  */
67 const char *repertoire_global;
68
69 /* List of all locales.  */
70 static struct localedef_t *locales;
71
72
73 /* Name and version of program.  */
74 static void print_version (FILE *stream, struct argp_state *state);
75 void (*argp_program_version_hook) (FILE *, struct argp_state *) = print_version;
76
77 #define OPT_POSIX 1
78 #define OPT_QUIET 2
79
80 /* Definitions of arguments for argp functions.  */
81 static const struct argp_option options[] =
82 {
83   { NULL, 0, NULL, 0, N_("Input Files:") },
84   { "charmap", 'f', "FILE", 0,
85     N_("Symbolic character names defined in FILE") },
86   { "inputfile", 'i', "FILE", 0, N_("Source definitions are found in FILE") },
87   { "repertoire-map", 'u', "FILE", 0,
88     N_("FILE contains mapping from symbolic names to UCS4 values") },
89
90   { NULL, 0, NULL, 0, N_("Output control:") },
91   { "force", 'c', NULL, 0,
92     N_("Create output even if warning messages were issued") },
93   { "posix", OPT_POSIX, NULL, 0, N_("Be strictly POSIX conform") },
94   { "quiet", OPT_QUIET, NULL, 0,
95     N_("Suppress warnings and information messages") },
96   { "verbose", 'v', NULL, 0, N_("Print more messages") },
97   { NULL, 0, NULL, 0, NULL }
98 };
99
100 /* Short description of program.  */
101 static const char doc[] = N_("Compile locale specification");
102
103 /* Strings for arguments in help texts.  */
104 static const char args_doc[] = N_("NAME");
105
106 /* Prototype for option handler.  */
107 static error_t parse_opt (int key, char *arg, struct argp_state *state);
108
109 /* Function to print some extra text in the help message.  */
110 static char *more_help (int key, const char *text, void *input);
111
112 /* Data structure to communicate with argp functions.  */
113 static struct argp argp =
114 {
115   options, parse_opt, args_doc, doc, NULL, more_help
116 };
117
118
119 /* Prototypes for global functions.  */
120 extern void *xmalloc (size_t __n);
121
122 /* Prototypes for local functions.  */
123 static void error_print (void);
124 static const char *construct_output_path (char *path);
125 static const char *normalize_codeset (const char *codeset, size_t name_len);
126
127
128 int
129 main (int argc, char *argv[])
130 {
131   const char *output_path;
132   int cannot_write_why;
133   struct charmap_t *charmap;
134   struct localedef_t global;
135   int remaining;
136
137   /* Set initial values for global variables.  */
138   copy_list = NULL;
139   posix_conformance = getenv ("POSIXLY_CORRECT") != NULL;
140   error_print_progname = error_print;
141
142   /* Set locale.  Do not set LC_ALL because the other categories must
143      not be affected (according to POSIX.2).  */
144   setlocale (LC_MESSAGES, "");
145   setlocale (LC_CTYPE, "");
146
147   /* Initialize the message catalog.  */
148   textdomain (_libc_intl_domainname);
149
150   /* Parse and process arguments.  */
151   argp_err_exit_status = 4;
152   argp_parse (&argp, argc, argv, 0, &remaining, NULL);
153
154   /* POSIX.2 requires to be verbose about missing characters in the
155      character map.  */
156   verbose |= posix_conformance;
157
158   if (argc - remaining != 1)
159     {
160       /* We need exactly one non-option parameter.  */
161       argp_help (&argp, stdout, ARGP_HELP_SEE | ARGP_HELP_EXIT_ERR,
162                  program_invocation_short_name);
163       exit (4);
164     }
165
166   /* The parameter describes the output path of the constructed files.
167      If the described files cannot be written return a NULL pointer.  */
168   output_path  = construct_output_path (argv[remaining]);
169   cannot_write_why = errno;
170
171   /* Now that the parameters are processed we have to reset the local
172      ctype locale.  (P1003.2 4.35.5.2)  */
173   setlocale (LC_CTYPE, "POSIX");
174
175   /* Look whether the system really allows locale definitions.  POSIX
176      defines error code 3 for this situation so I think it must be
177      a fatal error (see P1003.2 4.35.8).  */
178   if (sysconf (_SC_2_LOCALEDEF) < 0)
179     error (3, 0, _("FATAL: system does not define `_POSIX2_LOCALEDEF'"));
180
181   /* Process charmap file.  */
182   charmap = charmap_read (charmap_file);
183
184   /* Add the first entry in the locale list.  */
185   memset (&global, '\0', sizeof (struct localedef_t));
186   global.name = input_file;
187   global.needed = ALL_LOCALES;
188   locales = &global;
189
190   /* Now read the locale file.  */
191   if (locfile_read (&global, charmap) != 0)
192     error (4, errno, _("cannot open locale definition file `%s'"), input_file);
193
194   /* Perhaps we saw some `copy' instructions.  */
195   while (1)
196     {
197       struct localedef_t *runp = locales;
198
199       while (runp != NULL && runp->needed == runp->avail)
200         runp = runp->next;
201
202       if (runp == NULL)
203         /* Everything read.  */
204         break;
205
206       if (locfile_read (runp, charmap) != 0)
207         error (4, errno, _("cannot open locale definition file `%s'"),
208                runp->name);
209     }
210
211   /* Check the categories we processed in source form.  */
212   check_all_categories (locales, charmap);
213
214   /* We are now able to write the data files.  If warning were given we
215      do it only if it is explicitly requested (--force).  */
216   if (error_message_count == 0 || force_output != 0)
217     {
218       if (cannot_write_why != 0)
219         error (4, cannot_write_why, _("cannot write output files to `%s'"),
220                output_path);
221       else
222         write_all_categories (locales, charmap, output_path);
223     }
224   else
225     error (4, 0, _("no output file produced because warning were issued"));
226
227   /* This exit status is prescribed by POSIX.2 4.35.7.  */
228   exit (error_message_count != 0);
229 }
230
231
232 /* Handle program arguments.  */
233 static error_t
234 parse_opt (int key, char *arg, struct argp_state *state)
235 {
236   switch (key)
237     {
238     case OPT_QUIET:
239       be_quiet = 1;
240       break;
241     case OPT_POSIX:
242       posix_conformance = 1;
243       break;
244     case 'c':
245       force_output = 1;
246       break;
247     case 'f':
248       charmap_file = arg;
249       break;
250     case 'i':
251       input_file = arg;
252       break;
253     case 'u':
254       repertoire_global = arg;
255       break;
256     case 'v':
257       verbose = 1;
258       break;
259     default:
260       return ARGP_ERR_UNKNOWN;
261     }
262   return 0;
263 }
264
265
266 static char *
267 more_help (int key, const char *text, void *input)
268 {
269   char *cp;
270
271   switch (key)
272     {
273     case ARGP_KEY_HELP_EXTRA:
274       /* We print some extra information.  */
275       asprintf (&cp, gettext ("\
276 System's directory for character maps : %s\n\
277                        repertoire maps: %s\n\
278                        locale path    : %s\n\
279 %s"),
280                 CHARMAP_PATH, REPERTOIREMAP_PATH, LOCALE_PATH, gettext ("\
281 Report bugs using the `glibcbug' script to <bugs@gnu.org>.\n"));
282       return cp;
283     default:
284       break;
285     }
286   return (char *) text;
287 }
288
289 /* Print the version information.  */
290 static void
291 print_version (FILE *stream, struct argp_state *state)
292 {
293   fprintf (stream, "localedef (GNU %s) %s\n", PACKAGE, VERSION);
294   fprintf (stream, gettext ("\
295 Copyright (C) %s Free Software Foundation, Inc.\n\
296 This is free software; see the source for copying conditions.  There is NO\n\
297 warranty; not even for MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.\n\
298 "), "1999");
299   fprintf (stream, gettext ("Written by %s.\n"), "Ulrich Drepper");
300 }
301
302
303 /* The address of this function will be assigned to the hook in the error
304    functions.  */
305 static void
306 error_print (void)
307 {
308 }
309
310
311 /* The parameter to localedef describes the output path.  If it does
312    contain a '/' character it is a relative path.  Otherwise it names the
313    locale this definition is for.  */
314 static const char *
315 construct_output_path (char *path)
316 {
317   const char *normal = NULL;
318   char *result;
319   char *endp;
320
321   if (strchr (path, '/') == NULL)
322     {
323       /* This is a system path.  First examine whether the locale name
324          contains a reference to the codeset.  This should be
325          normalized.  */
326       char *startp;
327       size_t n;
328
329       startp = path;
330       /* We must be prepared for finding a CEN name or a location of
331          the introducing `.' where it is not possible anymore.  */
332       while (*startp != '\0' && *startp != '@' && *startp != '.'
333              && *startp != '+' && *startp != ',')
334         ++startp;
335       if (*startp == '.')
336         {
337           /* We found a codeset specification.  Now find the end.  */
338           endp = ++startp;
339           while (*endp != '\0' && *endp != '@')
340             ++endp;
341
342           if (endp > startp)
343             normal = normalize_codeset (startp, endp - startp);
344         }
345       else
346         /* This is to keep gcc quiet.  */
347         endp = NULL;
348
349       /* We put an additional '\0' at the end of the string because at
350          the end of the function we need another byte for the trailing
351          '/'.  */
352       if (normal == NULL)
353         n = asprintf (&result, "%s/%s%c", LOCALEDIR, path, '\0');
354       else
355         n = asprintf (&result, "%s/%.*s%s%s%c", LOCALEDIR, startp - path, path,
356                       normal, endp, '\0');
357
358       endp = result + n;
359     }
360   else
361     {
362       /* This is a user path.  Please note the additional byte in the
363          memory allocation.  */
364       size_t len = strlen (path) + 1;
365       result = xmalloc (len + 1);
366       endp = mempcpy (result, path, len);
367     }
368
369   errno = 0;
370
371   if (euidaccess (result, W_OK) == -1)
372     /* Perhaps the directory does not exist now.  Try to create it.  */
373     if (errno == ENOENT)
374       {
375         errno = 0;
376         mkdir (result, 0777);
377       }
378
379   *endp++ = '/';
380   *endp = '\0';
381
382   return result;
383 }
384
385
386 /* Normalize codeset name.  There is no standard for the codeset
387    names.  Normalization allows the user to use any of the common
388    names.  */
389 static const char *
390 normalize_codeset (codeset, name_len)
391      const char *codeset;
392      size_t name_len;
393 {
394   int len = 0;
395   int only_digit = 1;
396   char *retval;
397   char *wp;
398   size_t cnt;
399
400   for (cnt = 0; cnt < name_len; ++cnt)
401     if (isalnum (codeset[cnt]))
402       {
403         ++len;
404
405         if (isalpha (codeset[cnt]))
406           only_digit = 0;
407       }
408
409   retval = (char *) malloc ((only_digit ? 3 : 0) + len + 1);
410
411   if (retval != NULL)
412     {
413       if (only_digit)
414         wp = stpcpy (retval, "iso");
415       else
416         wp = retval;
417
418       for (cnt = 0; cnt < name_len; ++cnt)
419         if (isalpha (codeset[cnt]))
420           *wp++ = tolower (codeset[cnt]);
421         else if (isdigit (codeset[cnt]))
422           *wp++ = codeset[cnt];
423
424       *wp = '\0';
425     }
426
427   return (const char *) retval;
428 }
429
430
431 struct localedef_t *
432 add_to_readlist (int locale, const char *name, const char *repertoire_name)
433 {
434   struct localedef_t *runp = locales;
435
436   while (runp != NULL && strcmp (name, runp->name) != 0)
437     runp = runp->next;
438
439   if (runp == NULL)
440     {
441       /* Add a new entry at the end.  */
442       struct localedef_t *newp = xcalloc (1, sizeof (struct localedef_t));
443       newp->name = name;
444       newp->repertoire_name = repertoire_name;
445
446       if (locales == NULL)
447         runp = locales = newp;
448       else
449         {
450           runp = locales;
451           while (runp->next != NULL)
452             runp = runp->next;
453           runp = runp->next = newp;
454         }
455     }
456
457   if ((runp->needed & (1 << locale)) != 0)
458     error (5, 0, _("circular dependencies between locale definitions"));
459
460   runp->needed |= 1 << locale;
461
462   return runp;
463 }
464
465
466 struct localedef_t *
467 find_locale (int locale, const char *name, const char *repertoire_name,
468              struct charmap_t *charmap)
469 {
470   struct localedef_t *result = add_to_readlist (locale, name, repertoire_name);
471
472   if (locfile_read (result, charmap) != 0)
473     error (4, errno, _("cannot open locale definition file `%s'"),
474            result->name);
475
476   return result;
477 }