glibc/locale/programs/linereader.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

167 lines
3.5 KiB
C

/* Copyright (C) 1996-2017 Free Software Foundation, Inc.
This file is part of the GNU C Library.
Contributed by Ulrich Drepper, <drepper@gnu.org>.
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 _LINEREADER_H
#define _LINEREADER_H 1
#include <ctype.h>
#include <libintl.h>
#include <stdint.h>
#include <stdio.h>
#include "charmap.h"
#include "error.h"
#include "locfile-token.h"
#include "repertoire.h"
#include "record-status.h"
typedef const struct keyword_t *(*kw_hash_fct_t) (const char *, unsigned int);
struct charset_t;
struct localedef_t;
struct token
{
enum token_t tok;
union
{
struct
{
char *startmb;
size_t lenmb;
uint32_t *startwc;
size_t lenwc;
} str;
unsigned long int num;
struct
{
/* This element is sized on the safe expectation that no single
character in any character set uses more than 16 bytes. */
unsigned char bytes[16];
int nbytes;
} charcode;
uint32_t ucs4;
} val;
};
struct linereader
{
FILE *fp;
const char *fname;
char *buf;
size_t bufsize;
size_t bufact;
size_t lineno;
size_t idx;
char comment_char;
char escape_char;
struct token token;
int translate_strings;
int return_widestr;
kw_hash_fct_t hash_fct;
};
/* Functions defined in linereader.c. */
extern struct linereader *lr_open (const char *fname, kw_hash_fct_t hf);
extern struct linereader *lr_create (FILE *fp, const char *fname,
kw_hash_fct_t hf);
extern int lr_eof (struct linereader *lr);
extern void lr_close (struct linereader *lr);
extern int lr_next (struct linereader *lr);
extern struct token *lr_token (struct linereader *lr,
const struct charmap_t *charmap,
struct localedef_t *locale,
const struct repertoire_t *repertoire,
int verbose);
extern void lr_ignore_rest (struct linereader *lr, int verbose);
static inline void
__attribute__ ((__format__ (__printf__, 2, 3), nonnull (1, 2)))
lr_error (struct linereader *lr, const char *fmt, ...)
{
char *str;
va_list arg;
struct locale_state ls;
int ret;
va_start (arg, fmt);
ls = push_locale ();
ret = vasprintf (&str, fmt, arg);
if (ret == -1)
abort ();
pop_locale (ls);
va_end (arg);
error_at_line (0, 0, lr->fname, lr->lineno, "%s", str);
free (str);
}
static inline int
__attribute ((always_inline))
lr_getc (struct linereader *lr)
{
if (lr->idx == lr->bufact)
{
if (lr->bufact != 0)
if (lr_next (lr) < 0)
return EOF;
if (lr->bufact == 0)
return EOF;
}
return lr->buf[lr->idx] == '\32' ? EOF : lr->buf[lr->idx++];
}
static inline int
__attribute ((always_inline))
lr_ungetc (struct linereader *lr, int ch)
{
if (lr->idx == 0)
return -1;
if (ch != EOF)
lr->buf[--lr->idx] = ch;
return 0;
}
static inline int
lr_ungetn (struct linereader *lr, size_t n)
{
if (lr->idx < n)
return -1;
lr->idx -= n;
return 0;
}
#endif /* linereader.h */