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