gettext-tools/gnulib-lib/error-progname.h

   1 /* Use of program name in error-reporting functions.
   2    Copyright (C) 2001-2003, 2015 Free Software Foundation, Inc.
   3    Written by Bruno Haible <haible@clisp.cons.org>, 2001.
   4
   5    This program is free software: you can redistribute it and/or modify
   6    it under the terms of the GNU General Public License as published by
   7    the Free Software Foundation; either version 3 of the License, or
   8    (at your option) any later version.
   9
  10    This program 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
  13    GNU General Public License for more details.
  14
  15    You should have received a copy of the GNU General Public License
  16    along with this program.  If not, see <http://www.gnu.org/licenses/>.  */
  17
  18 #ifndef _ERROR_PROGNAME_H
  19 #define _ERROR_PROGNAME_H
  20
  21 #include <stdbool.h>
  22
  23 /* This file supports selectively prefixing or nor prefixing error messages
  24    with the program name.
  25
  26    Programs using this file should do the following in main():
  27      error_print_progname = maybe_print_progname;
  28  */
  29
  30
  31 #ifdef __cplusplus
  32 extern "C" {
  33 #endif
  34
  35
  36 /* Indicates whether errors and warnings get prefixed with program_name.
  37    Default is true.
  38    A reason to omit the prefix is for better interoperability with Emacs'
  39    compile.el.  */
  40 extern DLL_VARIABLE bool error_with_progname;
  41
  42 /* Print program_name prefix on stderr if and only if error_with_progname
  43    is true.  */
  44 extern void maybe_print_progname (void);
  45
  46
  47 #ifdef __cplusplus
  48 }
  49 #endif
  50
  51
  52 #endif /* _ERROR_PROGNAME_H */