chiark / gitweb /
Minor change in argument naming.
[mLib] / report.h
1 /* -*-c-*-
2  *
3  * $Id: report.h,v 1.3 1999/05/06 19:51:35 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
26  * Software Foundation, Inc., 59 Temple Place - Suite 330, Boston,
27  * MA 02111-1307, USA.
28  */
29
30 /*----- Revision history --------------------------------------------------*
31  *
32  * $Log: report.h,v $
33  * Revision 1.3  1999/05/06 19:51:35  mdw
34  * Reformatted the LGPL notice a little bit.
35  *
36  * Revision 1.2  1999/05/05 18:50:31  mdw
37  * Change licensing conditions to LGPL.
38  *
39  * Revision 1.1.1.1  1998/06/17 23:44:42  mdw
40  * Initial version of mLib
41  *
42  */
43
44 #ifndef REPORT_H
45 #define REPORT_H
46
47 #ifdef __cplusplus
48   extern "C" {
49 #endif
50
51 /*----- Functions provided ------------------------------------------------*/
52
53 /* --- @moan@ --- *
54  *
55  * Arguments:   @const char *f@ = a @printf@-style format string
56  *              @...@ = other arguments
57  *
58  * Returns:     ---
59  *
60  * Use:         Reports an error.
61  */
62
63 extern void moan(const char *f, ...);
64
65 /* --- @die@ --- *
66  *
67  * Arguments:   @int status@ = exit status to return
68  *              @const char *f@ = a @printf@-style format string
69  *              @...@ = other arguments
70  *
71  * Returns:     Never.
72  *
73  * Use:         Reports an error and exits.  Like @moan@ above, only more
74  *              permanent.
75  */
76
77 extern void die(int status, const char *f, ...);
78
79 /*----- That's all, folks -------------------------------------------------*/
80
81 #ifdef __cplusplus
82   }
83 #endif
84
85 #endif