chiark - git - mdw - mLib/blob - ui/report.h

   1 /* -*-c-*-
   2  *
   3  * Reporting errors and things
   4  *
   5  * (c) 1998 Straylight/Edgeware
   6  */
   7
   8 /*----- Licensing notice --------------------------------------------------*
   9  *
  10  * This file is part of the mLib utilities library.
  11  *
  12  * mLib is free software; you can redistribute it and/or modify
  13  * it under the terms of the GNU Library General Public License as
  14  * published by the Free Software Foundation; either version 2 of the
  15  * License, or (at your option) any later version.
  16  *
  17  * mLib is distributed in the hope that it will be useful,
  18  * but WITHOUT ANY WARRANTY; without even the implied warranty of
  19  * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
  20  * GNU Library General Public License for more details.
  21  *
  22  * You should have received a copy of the GNU Library General Public
  23  * License along with mLib; if not, write to the Free
  24  * Software Foundation, Inc., 59 Temple Place - Suite 330, Boston,
  25  * MA 02111-1307, USA.
  26  */
  27
  28 #ifndef MLIB_REPORT_H
  29 #define MLIB_REPORT_H
  30
  31 #ifdef __cplusplus
  32   extern "C" {
  33 #endif
  34
  35 /*----- Header files ------------------------------------------------------*/
  36
  37 #ifndef MLIB_MACROS_H
  38 #  include "macros.h"
  39 #endif
  40
  41 /*----- Functions provided ------------------------------------------------*/
  42
  43 /* --- @moan@ --- *
  44  *
  45  * Arguments:   @const char *f@ = a @printf@-style format string
  46  *              @...@ = other arguments
  47  *
  48  * Returns:     ---
  49  *
  50  * Use:         Reports an error.
  51  */
  52
  53 extern PRINTF_LIKE(1, 2) void moan(const char *f, ...);
  54
  55 /* --- @die@ --- *
  56  *
  57  * Arguments:   @int status@ = exit status to return
  58  *              @const char *f@ = a @printf@-style format string
  59  *              @...@ = other arguments
  60  *
  61  * Returns:     Never.
  62  *
  63  * Use:         Reports an error and exits.  Like @moan@ above, only more
  64  *              permanent.
  65  */
  66
  67 extern PRINTF_LIKE(2, 3) NORETURN void die(int status, const char *f, ...);
  68
  69 /*----- That's all, folks -------------------------------------------------*/
  70
  71 #ifdef __cplusplus
  72   }
  73 #endif
  74
  75 #endif