include/gmxcpp.h

   1
   2 /*
   3  * This file is part of the GROMACS molecular simulation package.
   4  *
   5  * Copyright (c) 1991-2000, University of Groningen, The Netherlands.
   6  * Copyright (c) 2001-2008, The GROMACS development team,
   7  * check out http://www.gromacs.org for more information.
   8  * Copyright (c) 2012, by the GROMACS development team, led by
   9  * David van der Spoel, Berk Hess, Erik Lindahl, and including many
  10  * others, as listed in the AUTHORS file in the top-level source
  11  * directory and at http://www.gromacs.org.
  12  *
  13  * GROMACS is free software; you can redistribute it and/or
  14  * modify it under the terms of the GNU Lesser General Public License
  15  * as published by the Free Software Foundation; either version 2.1
  16  * of the License, or (at your option) any later version.
  17  *
  18  * GROMACS is distributed in the hope that it will be useful,
  19  * but WITHOUT ANY WARRANTY; without even the implied warranty of
  20  * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the GNU
  21  * Lesser General Public License for more details.
  22  *
  23  * You should have received a copy of the GNU Lesser General Public
  24  * License along with GROMACS; if not, see
  25  * http://www.gnu.org/licenses, or write to the Free Software Foundation,
  26  * Inc., 51 Franklin Street, Fifth Floor, Boston, MA  02110-1301  USA.
  27  *
  28  * If you want to redistribute modifications to GROMACS, please
  29  * consider that scientific software is very special. Version
  30  * control is crucial - bugs must be traceable. We will be happy to
  31  * consider code for inclusion in the official distribution, but
  32  * derived work must not be called official GROMACS. Details are found
  33  * in the README & COPYING files - if they are missing, get the
  34  * official version at http://www.gromacs.org.
  35  *
  36  * To help us fund GROMACS development, we humbly ask that you cite
  37  * the research papers on the package. Check out http://www.gromacs.org.
  38  */
  39
  40 #ifndef _gmxcpp_h
  41 #define _gmxcpp_h
  42 #include "visibility.h"
  43 typedef struct gmx_cpp *gmx_cpp_t;
  44
  45         /* The possible return codes for these functions */
  46 enum { eCPP_OK, eCPP_FILE_NOT_FOUND, eCPP_EOF, eCPP_SYNTAX, eCPP_INTERRUPT,
  47        eCPP_INVALID_HANDLE,
  48        eCPP_FILE_NOT_OPEN, eCPP_UNKNOWN, eCPP_NR };
  49
  50 /* THESE FUNCTIONS ARE NOT THREAD SAFE!! */
  51
  52 /* Open the file to be processed. The handle variable holds internal
  53    info for the cpp emulator. The cppopt variable (null terminated)
  54    can hold cpp options like -IXXX and -DXXX. Return integer status.
  55
  56    NOT THREAD SAFE
  57    */
  58 GMX_LIBGMX_EXPORT
  59 int cpp_open_file(const char *filenm,gmx_cpp_t *handlep, char **cppopts);
  60
  61 /* Return one whole line from the file into buf which holds at most n
  62    characters, for subsequent processing. Returns integer status.
  63
  64    NOT THREAD SAFE
  65    */
  66 GMX_LIBGMX_EXPORT
  67 int cpp_read_line(gmx_cpp_t *handlep,int n,char buf[]);
  68
  69 /* Return the file currently being read.
  70
  71    NOT THREAD SAFE
  72    */
  73 GMX_LIBGMX_EXPORT
  74 char *cpp_cur_file(const gmx_cpp_t *handlep);
  75
  76 /* Return the current line number.
  77
  78    NOT THREAD SAFE
  79    */
  80 GMX_LIBGMX_EXPORT
  81 int cpp_cur_linenr(const gmx_cpp_t *handlep);
  82
  83 /* Close the file! Return integer status.
  84
  85    NOT THREAD SAFE
  86    */
  87 GMX_LIBGMX_EXPORT
  88 int cpp_close_file(gmx_cpp_t *handlep);
  89
  90 /* Return a string containing the error message coresponding to status
  91    variable.
  92
  93    NOT THREAD SAFE
  94    */
  95 GMX_LIBGMX_EXPORT
  96 char *cpp_error(gmx_cpp_t *handlep,int status);
  97 #endif