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

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