/usr/include/gromacs/topology/symtab.h is in libgromacs-dev 5.1.2-1ubuntu1.
This file is owned by root:root, with mode 0o644.
The actual contents of the file can be viewed below.
1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 17 18 19 20 21 22 23 24 25 26 27 28 29 30 31 32 33 34 35 36 37 38 39 40 41 42 43 44 45 46 47 48 49 50 51 52 53 54 55 56 57 58 59 60 61 62 63 64 65 66 67 68 69 70 71 72 73 74 75 76 77 78 79 80 81 82 83 84 85 86 87 88 89 90 91 92 93 94 95 96 97 98 99 100 101 102 103 104 105 106 107 108 109 110 111 112 113 114 115 116 117 118 119 120 121 122 123 124 125 126 127 128 129 | /*
* This file is part of the GROMACS molecular simulation package.
*
* Copyright (c) 1991-2000, University of Groningen, The Netherlands.
* Copyright (c) 2001-2004, The GROMACS development team.
* Copyright (c) 2010,2014, by the GROMACS development team, led by
* Mark Abraham, David van der Spoel, Berk Hess, and Erik Lindahl,
* and including many others, as listed in the AUTHORS file in the
* top-level source directory and at http://www.gromacs.org.
*
* GROMACS is free software; you can redistribute it and/or
* modify it under the terms of the GNU Lesser General Public License
* as published by the Free Software Foundation; either version 2.1
* of the License, or (at your option) any later version.
*
* GROMACS is distributed in the hope that it will be useful,
* but WITHOUT ANY WARRANTY; without even the implied warranty of
* MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU
* Lesser General Public License for more details.
*
* You should have received a copy of the GNU Lesser General Public
* License along with GROMACS; if not, see
* http://www.gnu.org/licenses, or write to the Free Software Foundation,
* Inc., 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301 USA.
*
* If you want to redistribute modifications to GROMACS, 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 http://www.gromacs.org.
*
* To help us fund GROMACS development, we humbly ask that you cite
* the research papers on the package. Check out http://www.gromacs.org.
*/
#ifndef GMX_TOPOLOGY_SYMTAB_H
#define GMX_TOPOLOGY_SYMTAB_H
#include <stdio.h>
#ifdef __cplusplus
extern "C" {
#endif
typedef struct t_symbuf
{
int bufsize;
char **buf;
struct t_symbuf *next;
} t_symbuf;
typedef struct t_symtab
{
int nr;
t_symbuf *symbuf;
} t_symtab;
/*
* 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
* values by invoking lookup_symtab(). So when writing structures to
* a file which contains text strings, this value can be written in stead
* of the text string or its address. This value can easily be converted
* back to a text string handle by get_symtab_handle().
*/
void open_symtab(t_symtab *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().
*/
void free_symtab(t_symtab *symtab);
/* 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.
*/
#ifdef __cplusplus
}
#endif
#endif
|