c4f2d992 |
1 | /* -*-c-*- |
2 | * |
3 | * $Id: name.h,v 1.1 1997/07/21 13:47:46 mdw Exp $ |
4 | * |
5 | * Looking up of names in symbol tables |
6 | * |
7 | * (c) 1997 EBI |
8 | */ |
9 | |
10 | /*----- Licencing notice --------------------------------------------------* |
11 | * |
12 | * This file is part of `become' |
13 | * |
14 | * `Become' is free software; you can redistribute it and/or modify |
15 | * it under the terms of the GNU General Public License as published by |
16 | * the Free Software Foundation; either version 2 of the License, or |
17 | * (at your option) any later version. |
18 | * |
19 | * `Become' 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 General Public License for more details. |
23 | * |
24 | * You should have received a copy of the GNU General Public License |
25 | * along with `become'; if not, write to the Free Software |
26 | * Foundation, Inc., 675 Mass Ave, Cambridge, MA 02139, USA. |
27 | */ |
28 | |
29 | /*----- Revision history --------------------------------------------------* |
30 | * |
31 | * $Log: name.h,v $ |
32 | * Revision 1.1 1997/07/21 13:47:46 mdw |
33 | * Initial revision |
34 | * |
35 | */ |
36 | |
37 | #ifndef NAMES_H |
38 | #define NAMES_H |
39 | |
40 | #ifdef __cplusplus |
41 | extern "C" { |
42 | #endif |
43 | |
44 | /*----- Required headers --------------------------------------------------*/ |
45 | |
46 | #ifndef CLASS_H |
47 | # include "class.h" |
48 | #endif |
49 | |
50 | #ifndef SYM_H |
51 | # include "sym.h" |
52 | #endif |
53 | |
54 | /*----- Data structures ---------------------------------------------------*/ |
55 | |
56 | typedef struct name { |
57 | sym_base base; /* Base block for symbol table */ |
58 | classdef *c; /* Base class pointer */ |
59 | } name; |
60 | |
61 | /*----- Functions provided ------------------------------------------------*/ |
62 | |
63 | /* --- @name_init@ --- * |
64 | * |
65 | * Arguments: --- |
66 | * |
67 | * Returns: --- |
68 | * |
69 | * Use: Initialises the name table. Requires the user database to |
70 | * be populated (see @userdb_local@ and @userdb_yp@). |
71 | */ |
72 | |
73 | extern void name_init(void); |
74 | |
75 | /* --- @name_reinit@ --- * |
76 | * |
77 | * Arguments: --- |
78 | * |
79 | * Returns: --- |
80 | * |
81 | * Use: Reinitialises the names table. It's cleared and then |
82 | * initialised with the current user and group ids as for |
83 | * @name_init@ above. |
84 | */ |
85 | |
86 | extern void name_reinit(void); |
87 | |
88 | /* --- @name_find@ --- * |
89 | * |
90 | * Arguments: @const char *p@ = pointer to name to look up |
91 | * @unsigned create@ = whether to create the item |
92 | * @unsigned *f@ = whether the item was created |
93 | * |
94 | * Returns: Pointer to a @name@ block containing the symbol, or |
95 | * zero if it wasn't found and we didn't want to create a |
96 | * new one. |
97 | * |
98 | * Use: Looks up a name in the symbol table and returns the |
99 | * item so located. |
100 | */ |
101 | |
102 | extern name *name_find(const char */*p*/, |
103 | unsigned /*create*/, |
104 | unsigned */*f*/); |
105 | |
106 | /* --- @name_dump@ --- * |
107 | * |
108 | * Arguments: @FILE *fp@ = stream to dump on |
109 | * |
110 | * Returns: --- |
111 | * |
112 | * Use: Dumps a complete listing of the symbol table. |
113 | */ |
114 | |
115 | extern void name_dump(FILE */*fp*/); |
116 | |
117 | /*----- That's all, folks -------------------------------------------------*/ |
118 | |
119 | #ifdef __cplusplus |
120 | } |
121 | #endif |
122 | |
123 | #endif |