chiark / gitweb /
Use library annotations.
[mLib] / quis.h
CommitLineData
0875b58f 1/* -*-c-*-
2 *
4a74ab73 3 * $Id: quis.h,v 1.4 1999/10/04 21:43:29 mdw Exp $
0875b58f 4 *
5 * Setting the program name
6 *
7 * (c) 1998 Straylight/Edgeware
8 */
9
c846879c 10/*----- Licensing notice --------------------------------------------------*
0875b58f 11 *
12 * This file is part of the mLib utilities library.
13 *
14 * mLib is free software; you can redistribute it and/or modify
c846879c 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 *
0875b58f 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
c846879c 22 * GNU Library General Public License for more details.
23 *
24 * You should have received a copy of the GNU Library General Public
0bd98442 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.
0875b58f 28 */
29
30/*----- Revision history --------------------------------------------------*
31 *
32 * $Log: quis.h,v $
4a74ab73 33 * Revision 1.4 1999/10/04 21:43:29 mdw
34 * New function `pquis'.
35 *
0bd98442 36 * Revision 1.3 1999/05/06 19:51:35 mdw
37 * Reformatted the LGPL notice a little bit.
38 *
c846879c 39 * Revision 1.2 1999/05/05 18:50:31 mdw
40 * Change licensing conditions to LGPL.
41 *
42 * Revision 1.1.1.1 1998/06/17 23:44:42 mdw
43 * Initial version of mLib
0875b58f 44 *
45 */
46
47#ifndef PROGNAME_H
48#define PROGNAME_H
49
50#ifdef __cplusplus
51 extern "C" {
52#endif
53
4a74ab73 54/*----- Header files ------------------------------------------------------*/
55
56#include <stdio.h>
57
0875b58f 58/*----- Global variables --------------------------------------------------*/
59
60extern const char *pn__name;
61
62/*----- Functions provided ------------------------------------------------*/
63
64/* --- @quis@ --- *
65 *
66 * Arguments: ---
67 *
68 * Returns: Pointer to the program name.
69 *
70 * Use: Returns the program name.
71 */
72
73extern const char *quis(void);
74#define QUIS (pn__name)
75
76/* --- @ego@ --- *
77 *
78 * Arguments: @const char *p@ = pointer to program name
79 *
80 * Returns: ---
81 *
82 * Use: Tells mLib what the program's name is.
83 */
84
85extern void ego(const char */*p*/);
86
4a74ab73 87/* --- @pquis@ --- *
88 *
89 * Arguments: @FILE *fp@ = output stream to write on
90 * @const char *p@ = pointer to string to write
91 *
92 * Returns: Zero if everything worked, EOF if not.
93 *
94 * Use: Writes the string @p@ to the output stream @fp@. Occurrences
95 * of the character `$' in @p@ are replaced by the program name
96 * as reported by @quis@. A `$$' is replaced by a single `$'
97 * sign.
98 */
99
100extern int pquis(FILE */*fp*/, const char */*p*/);
101
0875b58f 102/*----- That's all, folks -------------------------------------------------*/
103
104#ifdef __cplusplus
105 }
106#endif
107
108#endif