chiark / gitweb /
Qualify name given to @bres_byname@.
[mLib] / quis.h
1 /* -*-c-*-
2  *
3  * $Id: quis.h,v 1.5 1999/12/10 23:42:04 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 /*----- Revision history --------------------------------------------------*
31  *
32  * $Log: quis.h,v $
33  * Revision 1.5  1999/12/10 23:42:04  mdw
34  * Change header file guard names.
35  *
36  * Revision 1.4  1999/10/04 21:43:29  mdw
37  * New function `pquis'.
38  *
39  * Revision 1.3  1999/05/06 19:51:35  mdw
40  * Reformatted the LGPL notice a little bit.
41  *
42  * Revision 1.2  1999/05/05 18:50:31  mdw
43  * Change licensing conditions to LGPL.
44  *
45  * Revision 1.1.1.1  1998/06/17 23:44:42  mdw
46  * Initial version of mLib
47  *
48  */
49
50 #ifndef MLIB_PROGNAME_H
51 #define MLIB_PROGNAME_H
52
53 #ifdef __cplusplus
54   extern "C" {
55 #endif
56
57 /*----- Header files ------------------------------------------------------*/
58
59 #include <stdio.h>
60
61 /*----- Global variables --------------------------------------------------*/
62
63 extern const char *pn__name;
64
65 /*----- Functions provided ------------------------------------------------*/
66
67 /* --- @quis@ --- *
68  *
69  * Arguments:   ---
70  *
71  * Returns:     Pointer to the program name.
72  *
73  * Use:         Returns the program name.
74  */
75
76 extern const char *quis(void);
77 #define QUIS (pn__name)
78
79 /* --- @ego@ --- *
80  *
81  * Arguments:   @const char *p@ = pointer to program name
82  *
83  * Returns:     ---
84  *
85  * Use:         Tells mLib what the program's name is.
86  */
87
88 extern void ego(const char */*p*/);
89
90 /* --- @pquis@ --- *
91  *
92  * Arguments:   @FILE *fp@ = output stream to write on
93  *              @const char *p@ = pointer to string to write
94  *
95  * Returns:     Zero if everything worked, EOF if not.
96  *
97  * Use:         Writes the string @p@ to the output stream @fp@.  Occurrences
98  *              of the character `$' in @p@ are replaced by the program name
99  *              as reported by @quis@.  A `$$' is replaced by a single `$'
100  *              sign.
101  */
102
103 extern int pquis(FILE */*fp*/, const char */*p*/);
104
105 /*----- That's all, folks -------------------------------------------------*/
106
107 #ifdef __cplusplus
108   }
109 #endif
110
111 #endif