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