include/symtab.h

   1 /*
   2  * $Id$
   3  *
   4  *                This source code is part of
   5  *
   6  *                 G   R   O   M   A   C   S
   7  *
   8  *          GROningen MAchine for Chemical Simulations
   9  *
  10  *                        VERSION 3.2.0
  11  * Written by David van der Spoel, Erik Lindahl, Berk Hess, and others.
  12  * Copyright (c) 1991-2000, University of Groningen, The Netherlands.
  13  * Copyright (c) 2001-2004, The GROMACS development team,
  14  * check out http://www.gromacs.org for more information.
  15
  16  * This program is free software; you can redistribute it and/or
  17  * modify it under the terms of the GNU General Public License
  18  * as published by the Free Software Foundation; either version 2
  19  * of the License, or (at your option) any later version.
  20  *
  21  * If you want to redistribute modifications, please consider that
  22  * scientific software is very special. Version control is crucial -
  23  * bugs must be traceable. We will be happy to consider code for
  24  * inclusion in the official distribution, but derived work must not
  25  * be called official GROMACS. Details are found in the README & COPYING
  26  * files - if they are missing, get the official version at www.gromacs.org.
  27  *
  28  * To help us fund GROMACS development, we humbly ask that you cite
  29  * the papers on the package - you can find them in the top README file.
  30  *
  31  * For more info, check our website at http://www.gromacs.org
  32  *
  33  * And Hey:
  34  * Gromacs Runs On Most of All Computer Systems
  35  */
  36
  37 #ifndef _symtab_h
  38 #define _symtab_h
  39
  40 #ifdef HAVE_CONFIG_H
  41 #include <config.h>
  42 #endif
  43
  44
  45 #include <stdio.h>
  46 #include "typedefs.h"
  47
  48 /*
  49  * This module handles symbol table manipulation. All text strings
  50  * needed by an application are allocated only once. All references
  51  * to these text strings use handles returned from the put_symtab()
  52  * routine. These handles can easily be converted to address independent
  53  * values by invoking lookup_symtab(). So when writing structures to
  54  * a file which contains text strings, this value can be written in stead
  55  * of the text string or its address. This value can easily be converted
  56  * back to a text string handle by get_symtab_handle().
  57  */
  58
  59 extern void open_symtab(t_symtab *symtab);
  60      /* Initialises the symbol table symtab.
  61       */
  62
  63 extern void close_symtab(t_symtab *symtab);
  64      /* Undoes the effect of open_symtab(), after invoking this function,
  65       * no value can be added to the symbol table, only values can be
  66       * retrieved using get_symtab().
  67       */
  68
  69 extern void free_symtab(t_symtab *symtab);
  70      /* Frees the space allocated by the symbol table itself */
  71
  72 extern void done_symtab(t_symtab *symtab);
  73      /* Frees the space allocated by the symbol table, including all
  74       * entries in it */
  75
  76 extern char **put_symtab(t_symtab *symtab,const char *name);
  77      /* Enters a string into the symbol table symtab, if it was not
  78       * available, a reference to a copy is returned else a reference
  79       * to the earlier entered value is returned. Strings are trimmed
  80       * of spaces.
  81       */
  82
  83 extern int lookup_symtab(t_symtab *symtab,char **name);
  84      /* Returns a unique handle for **name, without a memory reference.
  85       * It is a failure when name cannot be found in the symbol table,
  86       * it should be entered before with put_symtab().
  87       */
  88
  89 extern char **get_symtab_handle(t_symtab *symtab,int name);
  90      /* Returns a text string handle for name. Name should be a value
  91       * returned from lookup_symtab(). So get_symtab_handle() and
  92       * lookup_symtab() are inverse functions.
  93       */
  94
  95 extern long wr_symtab(FILE *fp,t_symtab *symtab);
  96      /* Writes the symbol table symtab to the file, specified by fp.
  97       * The function returns the number of bytes written.
  98       */
  99
 100 extern long rd_symtab(FILE *fp,t_symtab *symtab);
 101      /* Reads the symbol table symtab from the file, specified by fp.
 102       * This will include allocating the needed space. The function
 103       * returns the number of bytes read. The symtab is in the closed
 104       * state afterwards, so no strings can be added to it.
 105       */
 106
 107 extern void pr_symtab(FILE *fp,int indent,char *title,t_symtab *symtab);
 108      /* This routine prints out a (human) readable representation of
 109       * the symbol table symtab to the file fp. Ident specifies the
 110       * number of spaces the text should be indented. Title is used
 111       * to print a header text.
 112       */
 113
 114 #endif  /* _symtab_h */