glibc/locale/programs/localedef.h
Carlos O'Donell f16491eb8e locale: Fix localedef exit code (Bug 22292)
The error and warning handling in localedef, locale, and iconv
is a bit of a mess.

We use ugly constructs like this:
      WITH_CUR_LOCALE (error (1, errno, gettext ("\
cannot read character map directory `%s'"), directory));

to issue errors, and read error_message_count directly from the
error API to detect errors. The problem with that is that the
code also uses error to print warnings, and informative messages.
All of this leads to problems where just having warnings will
produce an exit status as-if errors had been seen.

To fix this situation I have adopted the following high-level
changes:
* All errors are counted distinctly.
* All warnings are counted distinctly.
* All informative messages are not counted.
* Increasing verbosity cannot generate *more* errors, and
  it previously did for errors conditional on verbose,
  this is now fixed.
* Increasing verbosity *can* generate *more* warnings.
* Making the output quiet cannot generate *fewer* errors,
  and it previously did for errors conditional on be_quiet,
  this is now fixed.
* Each of error, warning, and informative message has it's
  own function to call defined in record-status.h, and they
  are: record_error, record_warning, and record_verbose.
* The record_error function always records an error, but
  conditional on be_quiet may not print it.
* The record_warning function always records a warning,
  but conditional on be_quiet may not print it.
* The record_verbose function only prints the verbose
  message if verbose is true and be_quiet is false.

This has allowed the following fix:
* Previously any warnings were being treated as errors
  because they incremented error_message_count, but now
  we properly return an exit status of 1 if there are
  warnings but output was generated.

All of this allows localedef to correctly decide if errors,
or warnings were present, and produce the correct exit code.

The locale and iconv programs now also use record-status.h
and we have removed the WITH_CUR_LOCALE hack, and instead
have internal push_locale/pop_locale functions centralized
in the record routines.

Signed-off-by: Carlos O'Donell <carlos@redhat.com>
2017-10-13 22:30:18 -07:00

168 lines
4.7 KiB
C

/* General definitions for localedef(1).
Copyright (C) 1998-2017 Free Software Foundation, Inc.
This file is part of the GNU C Library.
Contributed by Ulrich Drepper <drepper@cygnus.com>, 1998.
This program is free software; you can redistribute it and/or modify
it under the terms of the GNU General Public License as published
by the Free Software Foundation; version 2 of the License, or
(at your option) any later version.
This program 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 General Public License for more details.
You should have received a copy of the GNU General Public License
along with this program; if not, see <http://www.gnu.org/licenses/>. */
#ifndef _LOCALEDEF_H
#define _LOCALEDEF_H 1
/* Get the basic locale definitions. */
#include <errno.h>
#include <locale.h>
#include <stdbool.h>
#include <stddef.h>
#include <stdarg.h>
#include <stdio.h>
#include <stdlib.h>
#include "record-status.h"
#include "repertoire.h"
#include "../locarchive.h"
/* We need a bitmask for the locales. */
enum
{
CTYPE_LOCALE = 1 << LC_CTYPE,
NUMERIC_LOCALE = 1 << LC_NUMERIC,
TIME_LOCALE = 1 << LC_TIME,
COLLATE_LOCALE = 1 << LC_COLLATE,
MONETARY_LOCALE = 1 << LC_MONETARY,
MESSAGES_LOCALE = 1 << LC_MESSAGES,
PAPER_LOCALE = 1 << LC_PAPER,
NAME_LOCALE = 1 << LC_NAME,
ADDRESS_LOCALE = 1 << LC_ADDRESS,
TELEPHONE_LOCALE = 1 << LC_TELEPHONE,
MEASUREMENT_LOCALE = 1 << LC_MEASUREMENT,
IDENTIFICATION_LOCALE = 1 << LC_IDENTIFICATION,
ALL_LOCALES = (1 << LC_CTYPE
| 1 << LC_NUMERIC
| 1 << LC_TIME
| 1 << LC_COLLATE
| 1 << LC_MONETARY
| 1 << LC_MESSAGES
| 1 << LC_PAPER
| 1 << LC_NAME
| 1 << LC_ADDRESS
| 1 << LC_TELEPHONE
| 1 << LC_MEASUREMENT
| 1 << LC_IDENTIFICATION)
};
/* Opaque types for the different locales. */
struct locale_ctype_t;
struct locale_collate_t;
struct locale_monetary_t;
struct locale_numeric_t;
struct locale_time_t;
struct locale_messages_t;
struct locale_paper_t;
struct locale_name_t;
struct locale_address_t;
struct locale_telephone_t;
struct locale_measurement_t;
struct locale_identification_t;
/* Definitions for the locale. */
struct localedef_t
{
struct localedef_t *next;
const char *name;
int needed;
int avail;
union
{
void *generic;
struct locale_ctype_t *ctype;
struct locale_collate_t *collate;
struct locale_monetary_t *monetary;
struct locale_numeric_t *numeric;
struct locale_time_t *time;
struct locale_messages_t *messages;
struct locale_paper_t *paper;
struct locale_name_t *name;
struct locale_address_t *address;
struct locale_telephone_t *telephone;
struct locale_measurement_t *measurement;
struct locale_identification_t *identification;
} categories[__LC_LAST];
size_t len[__LC_LAST];
const char *copy_name[__LC_LAST];
const char *repertoire_name;
};
/* Global variables of the localedef program. */
extern int verbose;
extern const char *repertoire_global;
extern int max_locarchive_open_retry;
extern bool no_archive;
extern const char *alias_file;
/* Prototypes for a few program-wide used functions. */
#include <programs/xmalloc.h>
/* Mark given locale as to be read. */
extern struct localedef_t *add_to_readlist (int locale, const char *name,
const char *repertoire_name,
int generate,
struct localedef_t *copy_locale);
/* Find the information for the locale NAME. */
extern struct localedef_t *find_locale (int locale, const char *name,
const char *repertoire_name,
const struct charmap_t *charmap);
/* Load (if necessary) the information for the locale NAME. */
extern struct localedef_t *load_locale (int locale, const char *name,
const char *repertoire_name,
const struct charmap_t *charmap,
struct localedef_t *copy_locale);
/* Open the locale archive. */
extern void open_archive (struct locarhandle *ah, bool readonly);
/* Close the locale archive. */
extern void close_archive (struct locarhandle *ah);
/* Add given locale data to the archive. */
extern int add_locale_to_archive (struct locarhandle *ah, const char *name,
locale_data_t data, bool replace);
/* Add content of named directories to locale archive. */
extern int add_locales_to_archive (size_t nlist, char *list[], bool replace);
/* Removed named locales from archive. */
extern int delete_locales_from_archive (size_t nlist, char *list[]);
/* List content of locale archive. If FNAME is non-null use that as
the locale archive to list, otherwise the default. */
extern void show_archive_content (const char *fname,
int verbose) __attribute__ ((noreturn));
#endif /* localedef.h */