src/gromacs/topology/symtab.h

   1 /*
   2  * This file is part of the GROMACS molecular simulation package.
   3  *
   4  * Copyright (c) 1991-2000, University of Groningen, The Netherlands.
   5  * Copyright (c) 2001-2004, The GROMACS development team.
   6  * Copyright (c) 2010,2014,2017,2018,2019, by the GROMACS development team, led by
   7  * Mark Abraham, David van der Spoel, Berk Hess, and Erik Lindahl,
   8  * and including many others, as listed in the AUTHORS file in the
   9  * top-level source directory and at http://www.gromacs.org.
  10  *
  11  * GROMACS is free software; you can redistribute it and/or
  12  * modify it under the terms of the GNU Lesser General Public License
  13  * as published by the Free Software Foundation; either version 2.1
  14  * of the License, or (at your option) any later version.
  15  *
  16  * GROMACS is distributed in the hope that it will be useful,
  17  * but WITHOUT ANY WARRANTY; without even the implied warranty of
  18  * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the GNU
  19  * Lesser General Public License for more details.
  20  *
  21  * You should have received a copy of the GNU Lesser General Public
  22  * License along with GROMACS; if not, see
  23  * http://www.gnu.org/licenses, or write to the Free Software Foundation,
  24  * Inc., 51 Franklin Street, Fifth Floor, Boston, MA  02110-1301  USA.
  25  *
  26  * If you want to redistribute modifications to GROMACS, please
  27  * consider that scientific software is very special. Version
  28  * control is crucial - bugs must be traceable. We will be happy to
  29  * consider code for inclusion in the official distribution, but
  30  * derived work must not be called official GROMACS. Details are found
  31  * in the README & COPYING files - if they are missing, get the
  32  * official version at http://www.gromacs.org.
  33  *
  34  * To help us fund GROMACS development, we humbly ask that you cite
  35  * the research papers on the package. Check out http://www.gromacs.org.
  36  */
  37 #ifndef GMX_TOPOLOGY_SYMTAB_H
  38 #define GMX_TOPOLOGY_SYMTAB_H
  39
  40 #include <stdio.h>
  41
  42 typedef struct t_symbuf
  43 {
  44     int              bufsize;
  45     char**           buf;
  46     struct t_symbuf* next;
  47 } t_symbuf;
  48
  49 typedef struct t_symtab
  50 {
  51     int       nr;
  52     t_symbuf* symbuf;
  53 } t_symtab;
  54
  55 /*
  56  * This module handles symbol table manipulation. All text strings
  57  * needed by an application are allocated only once. All references
  58  * to these text strings use handles returned from the put_symtab()
  59  * routine. These handles can easily be converted to address independent
  60  * values by invoking lookup_symtab(). So when writing structures to
  61  * a file which contains text strings, this value can be written in stead
  62  * of the text string or its address. This value can easily be converted
  63  * back to a text string handle by get_symtab_handle().
  64  */
  65
  66 void open_symtab(t_symtab* symtab);
  67 /* Initialises the symbol table symtab.
  68  */
  69
  70 void close_symtab(t_symtab* symtab);
  71 /* Undoes the effect of open_symtab(), after invoking this function,
  72  * no value can be added to the symbol table, only values can be
  73  * retrieved using get_symtab().
  74  *
  75  * Note that this does no work.
  76  */
  77
  78 /*! \brief Returns a deep copy of \c symtab. */
  79 t_symtab* duplicateSymtab(const t_symtab* symtab);
  80
  81 void free_symtab(t_symtab* symtab);
  82 /* Frees the space allocated by the symbol table itself */
  83
  84 void done_symtab(t_symtab* symtab);
  85 /* Frees the space allocated by the symbol table, including all
  86  * entries in it */
  87
  88 char** put_symtab(t_symtab* symtab, const char* name);
  89 /* Enters a string into the symbol table symtab, if it was not
  90  * available, a reference to a copy is returned else a reference
  91  * to the earlier entered value is returned. Strings are trimmed
  92  * of spaces.
  93  */
  94
  95 int lookup_symtab(t_symtab* symtab, char** name);
  96 /* Returns a unique handle for **name, without a memory reference.
  97  * It is a failure when name cannot be found in the symbol table,
  98  * it should be entered before with put_symtab().
  99  */
 100
 101 char** get_symtab_handle(t_symtab* symtab, int name);
 102 /* Returns a text string handle for name. Name should be a value
 103  * returned from lookup_symtab(). So get_symtab_handle() and
 104  * lookup_symtab() are inverse functions.
 105  */
 106
 107 long wr_symtab(FILE* fp, t_symtab* symtab);
 108 /* Writes the symbol table symtab to the file, specified by fp.
 109  * The function returns the number of bytes written.
 110  */
 111
 112 long rd_symtab(FILE* fp, t_symtab* symtab);
 113 /* Reads the symbol table symtab from the file, specified by fp.
 114  * This will include allocating the needed space. The function
 115  * returns the number of bytes read. The symtab is in the closed
 116  * state afterwards, so no strings can be added to it.
 117  */
 118
 119 void pr_symtab(FILE* fp, int indent, const char* title, t_symtab* symtab);
 120 /* This routine prints out a (human) readable representation of
 121  * the symbol table symtab to the file fp. Ident specifies the
 122  * number of spaces the text should be indented. Title is used
 123  * to print a header text.
 124  */
 125
 126 #endif