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