chiark / gitweb /
cleanup: All the whitespace fixes, all at once.
[mLib] / quis.h
1 /* -*-c-*-
2  *
3  * $Id: quis.h,v 1.6 2004/04/08 01:36:13 mdw Exp $
4  *
5  * Setting the program name
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 #ifndef MLIB_PROGNAME_H
31 #define MLIB_PROGNAME_H
32
33 #ifdef __cplusplus
34   extern "C" {
35 #endif
36
37 /*----- Header files ------------------------------------------------------*/
38
39 #include <stdio.h>
40
41 /*----- Global variables --------------------------------------------------*/
42
43 extern const char *pn__name;
44
45 /*----- Functions provided ------------------------------------------------*/
46
47 /* --- @quis@ --- *
48  *
49  * Arguments:   ---
50  *
51  * Returns:     Pointer to the program name.
52  *
53  * Use:         Returns the program name.
54  */
55
56 extern const char *quis(void);
57 #define QUIS (pn__name)
58
59 /* --- @ego@ --- *
60  *
61  * Arguments:   @const char *p@ = pointer to program name
62  *
63  * Returns:     ---
64  *
65  * Use:         Tells mLib what the program's name is.
66  */
67
68 extern void ego(const char */*p*/);
69
70 /* --- @pquis@ --- *
71  *
72  * Arguments:   @FILE *fp@ = output stream to write on
73  *              @const char *p@ = pointer to string to write
74  *
75  * Returns:     Zero if everything worked, EOF if not.
76  *
77  * Use:         Writes the string @p@ to the output stream @fp@.  Occurrences
78  *              of the character `$' in @p@ are replaced by the program name
79  *              as reported by @quis@.  A `$$' is replaced by a single `$'
80  *              sign.
81  */
82
83 extern int pquis(FILE */*fp*/, const char */*p*/);
84
85 /*----- That's all, folks -------------------------------------------------*/
86
87 #ifdef __cplusplus
88   }
89 #endif
90
91 #endif