Reduced usage of typdefs.h
[alexxy/gromacs.git] / src / gromacs / legacyheaders / 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, 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
38 #ifndef _symtab_h
39 #define _symtab_h
40
41 #include <stdio.h>
42 #include "types/symtab.h"
43
44 #ifdef __cplusplus
45 extern "C" {
46 #endif
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 void open_symtab(t_symtab *symtab);
60 /* Initialises the symbol table symtab.
61  */
62
63 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 void free_symtab(t_symtab *symtab);
70 /* Frees the space allocated by the symbol table itself */
71
72 void done_symtab(t_symtab *symtab);
73 /* Frees the space allocated by the symbol table, including all
74  * entries in it */
75
76 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 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 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 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 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 void pr_symtab(FILE *fp, int indent, const 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 #ifdef __cplusplus
115 }
116 #endif
117
118 #endif  /* _symtab_h */