Headers: Guard inclusion of mLib headers.
[mLib] / 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 /*----- Functions provided ------------------------------------------------*/
36
37 /* --- @moan@ --- *
38 *
39 * Arguments: @const char *f@ = a @printf@-style format string
40 * @...@ = other arguments
41 *
42 * Returns: ---
43 *
44 * Use: Reports an error.
45 */
46
47 extern void moan(const char *f, ...);
48
49 /* --- @die@ --- *
50 *
51 * Arguments: @int status@ = exit status to return
52 * @const char *f@ = a @printf@-style format string
53 * @...@ = other arguments
54 *
55 * Returns: Never.
56 *
57 * Use: Reports an error and exits. Like @moan@ above, only more
58 * permanent.
59 */
60
61 extern void die(int status, const char *f, ...);
62
63 /*----- That's all, folks -------------------------------------------------*/
64
65 #ifdef __cplusplus
66 }
67 #endif
68
69 #endif