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