src/gromacs/fileio/gmxfio_xdr.h

   1 /*
   2  * This file is part of the GROMACS molecular simulation package.
   3  *
   4  * Copyright (c) 1991-2000, University of Groningen, The Netherlands.
   5  * Copyright (c) 2001-2004, The GROMACS development team.
   6  * Copyright (c) 2013,2014,2015,2016,2017,2018,2019, by the GROMACS development team, led by
   7  * Mark Abraham, David van der Spoel, Berk Hess, and Erik Lindahl,
   8  * and including many others, as listed in the AUTHORS file in the
   9  * top-level source directory and at http://www.gromacs.org.
  10  *
  11  * GROMACS is free software; you can redistribute it and/or
  12  * modify it under the terms of the GNU Lesser General Public License
  13  * as published by the Free Software Foundation; either version 2.1
  14  * of the License, or (at your option) any later version.
  15  *
  16  * GROMACS is distributed in the hope that it will be useful,
  17  * but WITHOUT ANY WARRANTY; without even the implied warranty of
  18  * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the GNU
  19  * Lesser General Public License for more details.
  20  *
  21  * You should have received a copy of the GNU Lesser General Public
  22  * License along with GROMACS; if not, see
  23  * http://www.gnu.org/licenses, or write to the Free Software Foundation,
  24  * Inc., 51 Franklin Street, Fifth Floor, Boston, MA  02110-1301  USA.
  25  *
  26  * If you want to redistribute modifications to GROMACS, please
  27  * consider that scientific software is very special. Version
  28  * control is crucial - bugs must be traceable. We will be happy to
  29  * consider code for inclusion in the official distribution, but
  30  * derived work must not be called official GROMACS. Details are found
  31  * in the README & COPYING files - if they are missing, get the
  32  * official version at http://www.gromacs.org.
  33  *
  34  * To help us fund GROMACS development, we humbly ask that you cite
  35  * the research papers on the package. Check out http://www.gromacs.org.
  36  */
  37 #ifndef GMX_FILEIO_GMXFIO_XDR_H
  38 #define GMX_FILEIO_GMXFIO_XDR_H
  39
  40 #include <string>
  41
  42 #include "gromacs/fileio/xdrf.h"
  43 #include "gromacs/math/vectypes.h"
  44 #include "gromacs/utility/basedefinitions.h"
  45 #include "gromacs/utility/iserializer.h"
  46 #include "gromacs/utility/real.h"
  47
  48 struct t_fileio;
  49
  50 void gmx_fio_setprecision(struct t_fileio *fio, gmx_bool bDouble);
  51 /* Select the floating point precision for reading and writing files */
  52
  53 bool gmx_fio_is_double(struct t_fileio *fio);
  54
  55 XDR *gmx_fio_getxdr(struct t_fileio *fio);
  56 /* Return the file pointer itself */
  57
  58 gmx_bool gmx_fio_writee_string(struct t_fileio *fio, const char *item,
  59                                const char *desc, const char *srcfile, int line);
  60
  61 /* reading or writing, depending on the file's opening mode string */
  62 gmx_bool gmx_fio_doe_real(struct t_fileio *fio, real *item,
  63                           const char *desc, const char *srcfile, int line);
  64 gmx_bool gmx_fio_doe_float(struct t_fileio *fio, float *item,
  65                            const char *desc, const char *srcfile, int line);
  66 gmx_bool gmx_fio_doe_double(struct t_fileio *fio, double *item,
  67                             const char *desc, const char *srcfile, int line);
  68 gmx_bool gmx_fio_doe_gmx_bool(struct t_fileio *fio, gmx_bool *item,
  69                               const char *desc, const char *srcfile, int line);
  70 gmx_bool gmx_fio_doe_int(struct t_fileio *fio, int *item,
  71                          const char *desc, const char *srcfile, int line);
  72 gmx_bool gmx_fio_doe_int32(struct t_fileio *fio, int32_t *item,
  73                            const char *desc, const char *srcfile, int line);
  74 gmx_bool gmx_fio_doe_int64(struct t_fileio *fio, int64_t *item,
  75                            const char *desc, const char *srcfile, int line);
  76 gmx_bool gmx_fio_doe_uchar(struct t_fileio *fio, unsigned char *item,
  77                            const char *desc, const char *srcfile, int line);
  78 gmx_bool gmx_fio_doe_char(struct t_fileio *fio, char *item,
  79                           const char *desc, const char *srcfile, int line);
  80 gmx_bool gmx_fio_doe_ushort(struct t_fileio *fio, unsigned short *item,
  81                             const char *desc, const char *srcfile, int line);
  82 gmx_bool gmx_fio_doe_rvec(struct t_fileio *fio, rvec *item,
  83                           const char *desc, const char *srcfile, int line);
  84 gmx_bool gmx_fio_doe_ivec(struct t_fileio *fio, ivec *item,
  85                           const char *desc, const char *srcfile, int line);
  86 gmx_bool gmx_fio_doe_string(struct t_fileio *fio, char *item,
  87                             const char *desc, const char *srcfile, int line);
  88
  89 /* array reading & writing */
  90 gmx_bool gmx_fio_ndoe_real(struct t_fileio *fio, real *item, int n,
  91                            const char *desc, const char *srcfile, int line);
  92 gmx_bool gmx_fio_ndoe_float(struct t_fileio *fio, float *item, int n,
  93                             const char *desc, const char *srcfile, int line);
  94 gmx_bool gmx_fio_ndoe_double(struct t_fileio *fio, double *item, int n,
  95                              const char *desc, const char *srcfile, int line);
  96 gmx_bool gmx_fio_ndoe_gmx_bool(struct t_fileio *fio, gmx_bool *item, int n,
  97                                const char *desc, const char *srcfile, int line);
  98 gmx_bool gmx_fio_ndoe_int(struct t_fileio *fio, int *item, int n,
  99                           const char *desc, const char *srcfile, int line);
 100 gmx_bool gmx_fio_ndoe_int32(struct t_fileio *fio, int32_t *item, int n,
 101                             const char *desc, const char *srcfile,
 102                             int line);
 103 gmx_bool gmx_fio_ndoe_int64(struct t_fileio *fio, int64_t *item, int n,
 104                             const char *desc, const char *srcfile,
 105                             int line);
 106 gmx_bool gmx_fio_ndoe_uchar(struct t_fileio *fio, unsigned char *item, int n,
 107                             const char *desc, const char *srcfile, int line);
 108 gmx_bool gmx_fio_ndoe_ushort(struct t_fileio *fio, unsigned short *item, int n,
 109                              const char *desc, const char *srcfile, int line);
 110 gmx_bool gmx_fio_ndoe_rvec(struct t_fileio *fio, rvec *item, int n,
 111                            const char *desc, const char *srcfile, int line);
 112 gmx_bool gmx_fio_ndoe_ivec(struct t_fileio *fio, ivec *item, int n,
 113                            const char *desc, const char *srcfile, int line);
 114 gmx_bool gmx_fio_ndoe_string(struct t_fileio *fio, char *item[], int n,
 115                              const char *desc, const char *srcfile, int line);
 116
 117
 118
 119 /* convenience macros */
 120 #define gmx_fio_write_string(fio, item)         gmx_fio_writee_string(fio, item, (#item), __FILE__, __LINE__)
 121
 122 #define gmx_fio_do_real(fio, item)              gmx_fio_doe_real(fio, &(item), (#item), __FILE__, __LINE__)
 123 #define gmx_fio_do_float(fio, item)             gmx_fio_doe_float(fio, &(item), (#item), __FILE__, __LINE__)
 124 #define gmx_fio_do_double(fio, item)            gmx_fio_doe_double(fio, &(item), (#item), __FILE__, __LINE__)
 125 #define gmx_fio_do_gmx_bool(fio, item)          gmx_fio_doe_gmx_bool(fio, &(item), (#item), __FILE__, __LINE__)
 126 #define gmx_fio_do_int(fio, item)               gmx_fio_doe_int(fio, &(item), (#item), __FILE__, __LINE__)
 127 #define gmx_fio_do_int32(fio, item)             gmx_fio_doe_int32(fio, &(item), (#item), __FILE__, __LINE__)
 128 #define gmx_fio_do_int64(fio, item)             gmx_fio_doe_int64(fio, &(item), (#item), __FILE__, __LINE__)
 129 #define gmx_fio_do_uchar(fio, item)             gmx_fio_doe_uchar(fio, &(item), (#item), __FILE__, __LINE__)
 130 #define gmx_fio_do_char(fio, item)              gmx_fio_doe_char(fio, &(item), (#item), __FILE__, __LINE__)
 131 #define gmx_fio_do_ushort(fio, item)            gmx_fio_doe_ushort(fio, &(item), (#item), __FILE__, __LINE__)
 132 #define gmx_fio_do_rvec(fio, item)              gmx_fio_doe_rvec(fio, &(item), (#item), __FILE__, __LINE__)
 133 #define gmx_fio_do_ivec(fio, item)              gmx_fio_doe_ivec(fio, &(item), (#item), __FILE__, __LINE__)
 134 #define gmx_fio_do_string(fio, item)            gmx_fio_doe_string(fio, item, (#item), __FILE__, __LINE__)
 135
 136
 137 #define gmx_fio_ndo_real(fio, item, n)              gmx_fio_ndoe_real(fio, item, n, (#item), __FILE__, __LINE__)
 138 #define gmx_fio_ndo_float(fio, item, n)             gmx_fio_ndoe_float(fio, item, n, (#item), __FILE__, __LINE__)
 139 #define gmx_fio_ndo_double(fio, item, n)            gmx_fio_ndoe_double(fio, item, n, (#item), __FILE__, __LINE__)
 140 #define gmx_fio_ndo_gmx_bool(fio, item, n)          gmx_fio_ndoe_gmx_bool(fio, item, n, (#item), __FILE__, __LINE__)
 141 #define gmx_fio_ndo_int(fio, item, n)               gmx_fio_ndoe_int(fio, item, n, (#item), __FILE__, __LINE__)
 142 #define gmx_fio_ndo_int32(fio, item, n)             gmx_fio_ndoe_int32(fio, item, n, (#item), __FILE__, __LINE__)
 143 #define gmx_fio_ndo_int64(fio, item, n)             gmx_fio_ndoe_int64(fio, item, n, (#item), __FILE__, __LINE__)
 144 #define gmx_fio_ndo_uchar(fio, item, n)             gmx_fio_ndoe_uchar(fio, item, n, (#item), __FILE__, __LINE__)
 145 #define gmx_fio_ndo_ushort(fio, item, n)            gmx_fio_ndoe_ushort(fio, item, n, (#item), __FILE__, __LINE__)
 146 #define gmx_fio_ndo_rvec(fio, item, n)              gmx_fio_ndoe_rvec(fio, item, n, (#item), __FILE__, __LINE__)
 147 #define gmx_fio_ndo_ivec(fio, item, n)              gmx_fio_ndoe_ivec(fio, item, n, (#item), __FILE__, __LINE__)
 148 #define gmx_fio_ndo_string(fio, item, n)            gmx_fio_ndoe_string(fio, item, n, (#item), __FILE__, __LINE__)
 149
 150 namespace gmx
 151 {
 152 /*!\internal \brief
 153  * Serializer to read/write XDR data.
 154  */
 155 class FileIOXdrSerializer : public ISerializer
 156 {
 157     public:
 158         //! Only create with valid file I/O handle.
 159         explicit FileIOXdrSerializer(t_fileio *fio);
 160
 161         //! If file is open in reading mode.
 162         bool reading() const override;
 163         //! Handle bool I/O.
 164         void doBool(bool *value) override;
 165         //! Handle unsigned char I/O.
 166         void doUChar(unsigned char *value) override;
 167         //! Handle char I/O.
 168         void doChar(char *value) override;
 169         //! Handle unsigned short I/O.
 170         void doUShort(unsigned short *value) override;
 171         //! Handle default integer I/O.
 172         void doInt(int *value) override;
 173         //! Handle int32 I/O.
 174         void doInt32(int32_t *value) override;
 175         //! Handle int64 I/O.
 176         void doInt64(int64_t *value) override;
 177         //! Handle single precision float I/O.
 178         void doFloat(float *value) override;
 179         //! Handle double precision float I/O.
 180         void doDouble(double *value) override;
 181         //! Handle GROMACS floating point number I/O.
 182         void doReal(real *value) override;
 183         //! Handle I/O of integer vector of size DIM.
 184         void doIvec(ivec *value) override;
 185         //! Handle I/O of GROMACS real vector of size DIM.
 186         void doRvec(rvec *value) override;
 187         //! Handle I/O if string.
 188         void doString(std::string *value) override;
 189
 190     private:
 191         //! File I/O handle.
 192         t_fileio *fio_;
 193 };
 194
 195 } // namespace gmx
 196
 197 #endif