/*
- *
+ *
* This source code is part of
- *
+ *
* G R O M A C S
- *
+ *
* GROningen MAchine for Chemical Simulations
- *
+ *
* VERSION 3.2.0
* Written by David van der Spoel, Erik Lindahl, Berk Hess, and others.
* Copyright (c) 1991-2000, University of Groningen, The Netherlands.
* modify it under the terms of the GNU General Public License
* as published by the Free Software Foundation; either version 2
* of the License, or (at your option) any later version.
- *
+ *
* If you want to redistribute modifications, please consider that
* scientific software is very special. Version control is crucial -
* bugs must be traceable. We will be happy to consider code for
* inclusion in the official distribution, but derived work must not
* be called official GROMACS. Details are found in the README & COPYING
* files - if they are missing, get the official version at www.gromacs.org.
- *
+ *
* To help us fund GROMACS development, we humbly ask that you cite
* the papers on the package - you can find them in the top README file.
- *
+ *
* For more info, check our website at http://www.gromacs.org
- *
+ *
* And Hey:
* Gromacs Runs On Most of All Computer Systems
*/
#endif
/*
- * This module handles symbol table manipulation. All text strings
+ * This module handles symbol table manipulation. All text strings
* needed by an application are allocated only once. All references
* to these text strings use handles returned from the put_symtab()
* routine. These handles can easily be converted to address independent
*/
void open_symtab(t_symtab *symtab);
- /* Initialises the symbol table symtab.
- */
+/* Initialises the symbol table symtab.
+ */
void close_symtab(t_symtab *symtab);
- /* Undoes the effect of open_symtab(), after invoking this function,
- * no value can be added to the symbol table, only values can be
- * retrieved using get_symtab().
- */
+/* Undoes the effect of open_symtab(), after invoking this function,
+ * no value can be added to the symbol table, only values can be
+ * retrieved using get_symtab().
+ */
void free_symtab(t_symtab *symtab);
- /* Frees the space allocated by the symbol table itself */
+/* Frees the space allocated by the symbol table itself */
void done_symtab(t_symtab *symtab);
- /* Frees the space allocated by the symbol table, including all
- * entries in it */
-
-char **put_symtab(t_symtab *symtab,const char *name);
- /* Enters a string into the symbol table symtab, if it was not
- * available, a reference to a copy is returned else a reference
- * to the earlier entered value is returned. Strings are trimmed
- * of spaces.
- */
-
-int lookup_symtab(t_symtab *symtab,char **name);
- /* Returns a unique handle for **name, without a memory reference.
- * It is a failure when name cannot be found in the symbol table,
- * it should be entered before with put_symtab().
- */
-
-char **get_symtab_handle(t_symtab *symtab,int name);
- /* Returns a text string handle for name. Name should be a value
- * returned from lookup_symtab(). So get_symtab_handle() and
- * lookup_symtab() are inverse functions.
- */
-
-long wr_symtab(FILE *fp,t_symtab *symtab);
- /* Writes the symbol table symtab to the file, specified by fp.
- * The function returns the number of bytes written.
- */
-
-long rd_symtab(FILE *fp,t_symtab *symtab);
- /* Reads the symbol table symtab from the file, specified by fp.
- * This will include allocating the needed space. The function
- * returns the number of bytes read. The symtab is in the closed
- * state afterwards, so no strings can be added to it.
- */
-
-void pr_symtab(FILE *fp,int indent,const char *title,t_symtab *symtab);
- /* This routine prints out a (human) readable representation of
- * the symbol table symtab to the file fp. Ident specifies the
- * number of spaces the text should be indented. Title is used
- * to print a header text.
- */
+/* Frees the space allocated by the symbol table, including all
+ * entries in it */
+
+char **put_symtab(t_symtab *symtab, const char *name);
+/* Enters a string into the symbol table symtab, if it was not
+ * available, a reference to a copy is returned else a reference
+ * to the earlier entered value is returned. Strings are trimmed
+ * of spaces.
+ */
+
+int lookup_symtab(t_symtab *symtab, char **name);
+/* Returns a unique handle for **name, without a memory reference.
+ * It is a failure when name cannot be found in the symbol table,
+ * it should be entered before with put_symtab().
+ */
+
+char **get_symtab_handle(t_symtab *symtab, int name);
+/* Returns a text string handle for name. Name should be a value
+ * returned from lookup_symtab(). So get_symtab_handle() and
+ * lookup_symtab() are inverse functions.
+ */
+
+long wr_symtab(FILE *fp, t_symtab *symtab);
+/* Writes the symbol table symtab to the file, specified by fp.
+ * The function returns the number of bytes written.
+ */
+
+long rd_symtab(FILE *fp, t_symtab *symtab);
+/* Reads the symbol table symtab from the file, specified by fp.
+ * This will include allocating the needed space. The function
+ * returns the number of bytes read. The symtab is in the closed
+ * state afterwards, so no strings can be added to it.
+ */
+
+void pr_symtab(FILE *fp, int indent, const char *title, t_symtab *symtab);
+/* This routine prints out a (human) readable representation of
+ * the symbol table symtab to the file fp. Ident specifies the
+ * number of spaces the text should be indented. Title is used
+ * to print a header text.
+ */
#ifdef __cplusplus
}
#endif
-#endif /* _symtab_h */
+#endif /* _symtab_h */