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

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