chiark - git - mdw - become/blob - src/name.h

   1 /* -*-c-*-
   2  *
   3  * $Id: name.h,v 1.7 2003/10/12 00:14:55 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 /*----- Revision history --------------------------------------------------*
  30  *
  31  * $Log: name.h,v $
  32  * Revision 1.7  2003/10/12 00:14:55  mdw
  33  * Major overhaul.  Now uses DSA signatures rather than the bogus symmetric
  34  * encrypt-and-hope thing.  Integrated with mLib and Catacomb.
  35  *
  36  * Revision 1.6  1998/04/23 13:24:21  mdw
  37  * Fix multiple inclusion guard macro name.
  38  *
  39  * Revision 1.5  1998/01/12 16:46:15  mdw
  40  * Fix copyright date.
  41  *
  42  * Revision 1.4  1997/09/17  10:26:11  mdw
  43  * Use rewritten class handler.  Support `none' class.
  44  *
  45  * Revision 1.3  1997/08/20  16:18:05  mdw
  46  * Replace `name_reinit' by `name_end' for more sensible restart.
  47  *
  48  * Revision 1.2  1997/08/04 10:24:24  mdw
  49  * Sources placed under CVS control.
  50  *
  51  * Revision 1.1  1997/07/21  13:47:46  mdw
  52  * Initial revision
  53  *
  54  */
  55
  56 #ifndef NAME_H
  57 #define NAME_H
  58
  59 #ifdef __cplusplus
  60   extern "C" {
  61 #endif
  62
  63 /*----- Required headers --------------------------------------------------*/
  64
  65 #include <mLib/sym.h>
  66
  67 #ifndef CLASS_H
  68 #  include "class.h"
  69 #endif
  70
  71 /*----- Data structures ---------------------------------------------------*/
  72
  73 typedef struct name {
  74   sym_base base;                        /* Base block for symbol table */
  75   class_node *c;                                /* Base class pointer */
  76 } name;
  77
  78 /*----- Functions provided ------------------------------------------------*/
  79
  80 /* --- @name_init@ --- *
  81  *
  82  * Arguments:   ---
  83  *
  84  * Returns:     ---
  85  *
  86  * Use:         Initialises the name table.  Requires the user database to
  87  *              be populated (see @userdb_local@ and @userdb_yp@).
  88  */
  89
  90 extern void name_init(void);
  91
  92 /* --- @name_end@ --- *
  93  *
  94  * Arguments:   ---
  95  *
  96  * Returns:     ---
  97  *
  98  * Use:         Closes down the name database, so that it can be
  99  *              reinitialised.
 100  */
 101
 102 extern void name_end(void);
 103
 104 /* --- @name_find@ --- *
 105  *
 106  * Arguments:   @const char *p@ = pointer to name to look up
 107  *              @unsigned create@ = whether to create the item
 108  *              @unsigned *f@ = whether the item was created
 109  *
 110  * Returns:     Pointer to a @name@ block containing the symbol, or
 111  *              zero if it wasn't found and we didn't want to create a
 112  *              new one.
 113  *
 114  * Use:         Looks up a name in the symbol table and returns the
 115  *              item so located.
 116  */
 117
 118 extern name *name_find(const char */*p*/,
 119                        unsigned /*create*/,
 120                        unsigned */*f*/);
 121
 122 /* --- @name_dump@ --- *
 123  *
 124  * Arguments:   ---
 125  *
 126  * Returns:     ---
 127  *
 128  * Use:         Dumps a complete listing of the symbol table.
 129  */
 130
 131 extern void name_dump(void);
 132
 133 /*----- That's all, folks -------------------------------------------------*/
 134
 135 #ifdef __cplusplus
 136   }
 137 #endif
 138
 139 #endif