include/gmxcpp.h

   1
   2 /*
   3  *
   4  *                This source code is part of
   5  *
   6  *                 G   R   O   M   A   C   S
   7  *
   8  *          GROningen MAchine for Chemical Simulations
   9  *
  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-2008, The GROMACS development team,
  13  * check out http://www.gromacs.org for more information.
  14
  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.
  19  *
  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.
  26  *
  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.
  29  *
  30  * For more info, check our website at http://www.gromacs.org
  31  *
  32  * And Hey:
  33  * Gallium Rubidium Oxygen Manganese Argon Carbon Silicon
  34  */
  35
  36
  37 typedef struct gmx_cpp *gmx_cpp_t;
  38
  39         /* The possible return codes for these functions */
  40 enum { eCPP_OK, eCPP_FILE_NOT_FOUND, eCPP_EOF, eCPP_SYNTAX, eCPP_INTERRUPT,
  41        eCPP_INVALID_HANDLE,
  42        eCPP_FILE_NOT_OPEN, eCPP_UNKNOWN, eCPP_NR };
  43
  44 /* THESE FUNCTIONS ARE NOT THREAD SAFE!! */
  45
  46 /* Open the file to be processed. The handle variable holds internal
  47    info for the cpp emulator. The cppopt variable (null terminated)
  48    can hold cpp options like -IXXX and -DXXX. Return integer status.
  49
  50    NOT THREAD SAFE
  51    */
  52 int cpp_open_file(const char *filenm,gmx_cpp_t *handlep, char **cppopts);
  53
  54 /* Return one whole line from the file into buf which holds at most n
  55    characters, for subsequent processing. Returns integer status.
  56
  57    NOT THREAD SAFE
  58    */
  59 int cpp_read_line(gmx_cpp_t *handlep,int n,char buf[]);
  60
  61 /* Return the file currently being read.
  62
  63    NOT THREAD SAFE
  64    */
  65 char *cpp_cur_file(const gmx_cpp_t *handlep);
  66
  67 /* Return the current line number.
  68
  69    NOT THREAD SAFE
  70    */
  71 int cpp_cur_linenr(const gmx_cpp_t *handlep);
  72
  73 /* Close the file! Return integer status.
  74
  75    NOT THREAD SAFE
  76    */
  77 int cpp_close_file(gmx_cpp_t *handlep);
  78
  79 /* Return a string containing the error message coresponding to status
  80    variable.
  81
  82    NOT THREAD SAFE
  83    */
  84 char *cpp_error(gmx_cpp_t *handlep,int status);