4 * This source code is part of
8 * GROningen MAchine for Chemical Simulations
12 * Copyright (c) 1991-1999
13 * BIOSON Research Institute, Dept. of Biophysical Chemistry
14 * University of Groningen, The Netherlands
17 * GROMACS: A message-passing parallel molecular dynamics implementation
18 * H.J.C. Berendsen, D. van der Spoel and R. van Drunen
19 * Comp. Phys. Comm. 91, 43-56 (1995)
21 * Also check out our WWW page:
22 * http://md.chem.rug.nl/~gmx
27 * Green Red Orange Magenta Azure Cyan Skyblue
33 static char *SRCID_symtab_h = "$Id$";
40 #ident "@(#) symtab.h 1.6 12/16/92"
41 #endif /* HAVE_IDENT */
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 extern void open_symtab(t_symtab *symtab);
58 /* Initialises the symbol table symtab.
61 extern 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 extern void free_symtab(t_symtab *symtab);
68 /* Frees the space allocated by the symbol table itself */
70 extern void done_symtab(t_symtab *symtab);
71 /* Frees the space allocated by the symbol table, including all
74 extern char **put_symtab(t_symtab *symtab,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
81 extern 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 extern 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 extern 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 extern 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 extern void pr_symtab(FILE *fp,int indent,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 #endif /* _symtab_h */