| 1 | /* -*-c-*- |
| 2 | * |
| 3 | * $Id: name.h,v 1.8 2004/04/08 01:36:20 mdw Exp $ |
| 4 | * |
| 5 | * Looking up of names in symbol tables |
| 6 | * |
| 7 | * (c) 1998 EBI |
| 8 | */ |
| 9 | |
| 10 | /*----- Licensing 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 Foundation, |
| 26 | * Inc., 59 Temple Place - Suite 330, Boston, MA 02111-1307, USA. |
| 27 | */ |
| 28 | |
| 29 | #ifndef NAME_H |
| 30 | #define NAME_H |
| 31 | |
| 32 | #ifdef __cplusplus |
| 33 | extern "C" { |
| 34 | #endif |
| 35 | |
| 36 | /*----- Required headers --------------------------------------------------*/ |
| 37 | |
| 38 | #include <mLib/sym.h> |
| 39 | |
| 40 | #ifndef CLASS_H |
| 41 | # include "class.h" |
| 42 | #endif |
| 43 | |
| 44 | /*----- Data structures ---------------------------------------------------*/ |
| 45 | |
| 46 | typedef struct name { |
| 47 | sym_base base; /* Base block for symbol table */ |
| 48 | class_node *c; /* Base class pointer */ |
| 49 | } name; |
| 50 | |
| 51 | /*----- Functions provided ------------------------------------------------*/ |
| 52 | |
| 53 | /* --- @name_init@ --- * |
| 54 | * |
| 55 | * Arguments: --- |
| 56 | * |
| 57 | * Returns: --- |
| 58 | * |
| 59 | * Use: Initialises the name table. Requires the user database to |
| 60 | * be populated (see @userdb_local@ and @userdb_yp@). |
| 61 | */ |
| 62 | |
| 63 | extern void name_init(void); |
| 64 | |
| 65 | /* --- @name_end@ --- * |
| 66 | * |
| 67 | * Arguments: --- |
| 68 | * |
| 69 | * Returns: --- |
| 70 | * |
| 71 | * Use: Closes down the name database, so that it can be |
| 72 | * reinitialised. |
| 73 | */ |
| 74 | |
| 75 | extern void name_end(void); |
| 76 | |
| 77 | /* --- @name_find@ --- * |
| 78 | * |
| 79 | * Arguments: @const char *p@ = pointer to name to look up |
| 80 | * @unsigned create@ = whether to create the item |
| 81 | * @unsigned *f@ = whether the item was created |
| 82 | * |
| 83 | * Returns: Pointer to a @name@ block containing the symbol, or |
| 84 | * zero if it wasn't found and we didn't want to create a |
| 85 | * new one. |
| 86 | * |
| 87 | * Use: Looks up a name in the symbol table and returns the |
| 88 | * item so located. |
| 89 | */ |
| 90 | |
| 91 | extern name *name_find(const char */*p*/, |
| 92 | unsigned /*create*/, |
| 93 | unsigned */*f*/); |
| 94 | |
| 95 | /* --- @name_dump@ --- * |
| 96 | * |
| 97 | * Arguments: --- |
| 98 | * |
| 99 | * Returns: --- |
| 100 | * |
| 101 | * Use: Dumps a complete listing of the symbol table. |
| 102 | */ |
| 103 | |
| 104 | extern void name_dump(void); |
| 105 | |
| 106 | /*----- That's all, folks -------------------------------------------------*/ |
| 107 | |
| 108 | #ifdef __cplusplus |
| 109 | } |
| 110 | #endif |
| 111 | |
| 112 | #endif |