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

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