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, const char* desc, const char* srcfile, int line);
  59
  60 /* reading or writing, depending on the file's opening mode string */
  61 gmx_bool gmx_fio_doe_real(struct t_fileio* fio, real* item, const char* desc, const char* srcfile, int line);
  62 gmx_bool gmx_fio_doe_float(struct t_fileio* fio, float* item, const char* desc, const char* srcfile, int line);
  63 gmx_bool gmx_fio_doe_double(struct t_fileio* fio, double* item, const char* desc, const char* srcfile, int line);
  64 gmx_bool gmx_fio_doe_gmx_bool(struct t_fileio* fio, gmx_bool* item, const char* desc, const char* srcfile, int line);
  65 gmx_bool gmx_fio_doe_int(struct t_fileio* fio, int* item, const char* desc, const char* srcfile, int line);
  66 gmx_bool gmx_fio_doe_int32(struct t_fileio* fio, int32_t* item, const char* desc, const char* srcfile, int line);
  67 gmx_bool gmx_fio_doe_int64(struct t_fileio* fio, int64_t* item, const char* desc, const char* srcfile, int line);
  68 gmx_bool gmx_fio_doe_uchar(struct t_fileio* fio, unsigned char* item, const char* desc, const char* srcfile, int line);
  69 gmx_bool gmx_fio_doe_char(struct t_fileio* fio, char* item, const char* desc, const char* srcfile, int line);
  70 gmx_bool gmx_fio_doe_ushort(struct t_fileio* fio,
  71                             unsigned short*  item,
  72                             const char*      desc,
  73                             const char*      srcfile,
  74                             int              line);
  75 gmx_bool gmx_fio_doe_rvec(struct t_fileio* fio, rvec* item, const char* desc, const char* srcfile, int line);
  76 gmx_bool gmx_fio_doe_ivec(struct t_fileio* fio, ivec* item, const char* desc, const char* srcfile, int line);
  77 gmx_bool gmx_fio_doe_string(struct t_fileio* fio, char* item, const char* desc, const char* srcfile, int line);
  78
  79 /* array reading & writing */
  80 gmx_bool gmx_fio_ndoe_real(struct t_fileio* fio, real* item, int n, const char* desc, const char* srcfile, int line);
  81 gmx_bool gmx_fio_ndoe_float(struct t_fileio* fio, float* item, int n, const char* desc, const char* srcfile, int line);
  82 gmx_bool gmx_fio_ndoe_double(struct t_fileio* fio, double* item, int n, const char* desc, const char* srcfile, int line);
  83 gmx_bool gmx_fio_ndoe_gmx_bool(struct t_fileio* fio,
  84                                gmx_bool*        item,
  85                                int              n,
  86                                const char*      desc,
  87                                const char*      srcfile,
  88                                int              line);
  89 gmx_bool gmx_fio_ndoe_int(struct t_fileio* fio, int* item, int n, const char* desc, const char* srcfile, int line);
  90 gmx_bool gmx_fio_ndoe_int32(struct t_fileio* fio, int32_t* item, int n, const char* desc, const char* srcfile, int line);
  91 gmx_bool gmx_fio_ndoe_int64(struct t_fileio* fio, int64_t* item, int n, const char* desc, const char* srcfile, int line);
  92 gmx_bool gmx_fio_ndoe_uchar(struct t_fileio* fio,
  93                             unsigned char*   item,
  94                             int              n,
  95                             const char*      desc,
  96                             const char*      srcfile,
  97                             int              line);
  98 gmx_bool gmx_fio_ndoe_char(struct t_fileio* fio, char* item, int n, const char* desc, const char* srcfile, int line);
  99 gmx_bool gmx_fio_ndoe_ushort(struct t_fileio* fio,
 100                              unsigned short*  item,
 101                              int              n,
 102                              const char*      desc,
 103                              const char*      srcfile,
 104                              int              line);
 105 gmx_bool gmx_fio_ndoe_rvec(struct t_fileio* fio, rvec* item, int n, const char* desc, const char* srcfile, int line);
 106 gmx_bool gmx_fio_ndoe_ivec(struct t_fileio* fio, ivec* item, int n, const char* desc, const char* srcfile, int line);
 107 gmx_bool gmx_fio_ndoe_string(struct t_fileio* fio, char* item[], int n, const char* desc, const char* srcfile, int line);
 108
 109
 110 /* convenience macros */
 111 #define gmx_fio_write_string(fio, item) \
 112     gmx_fio_writee_string(fio, item, (#item), __FILE__, __LINE__)
 113
 114 #define gmx_fio_do_real(fio, item) gmx_fio_doe_real(fio, &(item), (#item), __FILE__, __LINE__)
 115 #define gmx_fio_do_float(fio, item) gmx_fio_doe_float(fio, &(item), (#item), __FILE__, __LINE__)
 116 #define gmx_fio_do_double(fio, item) gmx_fio_doe_double(fio, &(item), (#item), __FILE__, __LINE__)
 117 #define gmx_fio_do_gmx_bool(fio, item) \
 118     gmx_fio_doe_gmx_bool(fio, &(item), (#item), __FILE__, __LINE__)
 119 #define gmx_fio_do_int(fio, item) gmx_fio_doe_int(fio, &(item), (#item), __FILE__, __LINE__)
 120 #define gmx_fio_do_int32(fio, item) gmx_fio_doe_int32(fio, &(item), (#item), __FILE__, __LINE__)
 121 #define gmx_fio_do_int64(fio, item) gmx_fio_doe_int64(fio, &(item), (#item), __FILE__, __LINE__)
 122 #define gmx_fio_do_uchar(fio, item) gmx_fio_doe_uchar(fio, &(item), (#item), __FILE__, __LINE__)
 123 #define gmx_fio_do_char(fio, item) gmx_fio_doe_char(fio, &(item), (#item), __FILE__, __LINE__)
 124 #define gmx_fio_do_ushort(fio, item) gmx_fio_doe_ushort(fio, &(item), (#item), __FILE__, __LINE__)
 125 #define gmx_fio_do_rvec(fio, item) gmx_fio_doe_rvec(fio, &(item), (#item), __FILE__, __LINE__)
 126 #define gmx_fio_do_ivec(fio, item) gmx_fio_doe_ivec(fio, &(item), (#item), __FILE__, __LINE__)
 127 #define gmx_fio_do_string(fio, item) gmx_fio_doe_string(fio, item, (#item), __FILE__, __LINE__)
 128
 129
 130 #define gmx_fio_ndo_real(fio, item, n) gmx_fio_ndoe_real(fio, item, n, (#item), __FILE__, __LINE__)
 131 #define gmx_fio_ndo_float(fio, item, n) \
 132     gmx_fio_ndoe_float(fio, item, n, (#item), __FILE__, __LINE__)
 133 #define gmx_fio_ndo_double(fio, item, n) \
 134     gmx_fio_ndoe_double(fio, item, n, (#item), __FILE__, __LINE__)
 135 #define gmx_fio_ndo_gmx_bool(fio, item, n) \
 136     gmx_fio_ndoe_gmx_bool(fio, item, n, (#item), __FILE__, __LINE__)
 137 #define gmx_fio_ndo_int(fio, item, n) gmx_fio_ndoe_int(fio, item, n, (#item), __FILE__, __LINE__)
 138 #define gmx_fio_ndo_int32(fio, item, n) \
 139     gmx_fio_ndoe_int32(fio, item, n, (#item), __FILE__, __LINE__)
 140 #define gmx_fio_ndo_int64(fio, item, n) \
 141     gmx_fio_ndoe_int64(fio, item, n, (#item), __FILE__, __LINE__)
 142 #define gmx_fio_ndo_uchar(fio, item, n) \
 143     gmx_fio_ndoe_uchar(fio, item, n, (#item), __FILE__, __LINE__)
 144 #define gmx_fio_ndo_char(fio, item, n) gmx_fio_ndoe_char(fio, item, n, (#item), __FILE__, __LINE__)
 145 #define gmx_fio_ndo_ushort(fio, item, n) \
 146     gmx_fio_ndoe_ushort(fio, item, n, (#item), __FILE__, __LINE__)
 147 #define gmx_fio_ndo_rvec(fio, item, n) gmx_fio_ndoe_rvec(fio, item, n, (#item), __FILE__, __LINE__)
 148 #define gmx_fio_ndo_ivec(fio, item, n) gmx_fio_ndoe_ivec(fio, item, n, (#item), __FILE__, __LINE__)
 149 #define gmx_fio_ndo_string(fio, item, n) \
 150     gmx_fio_ndoe_string(fio, item, n, (#item), __FILE__, __LINE__)
 151
 152 namespace gmx
 153 {
 154 /*!\internal \brief
 155  * Serializer to read/write XDR data.
 156  */
 157 class FileIOXdrSerializer : public ISerializer
 158 {
 159 public:
 160     //! Only create with valid file I/O handle.
 161     explicit FileIOXdrSerializer(t_fileio* fio);
 162
 163     //! If file is open in reading mode.
 164     bool reading() const override;
 165     //! Handle bool I/O.
 166     void doBool(bool* value) override;
 167     //! Handle unsigned char I/O.
 168     void doUChar(unsigned char* value) override;
 169     //! Handle char I/O.
 170     void doChar(char* value) override;
 171     //! Handle unsigned short I/O.
 172     void doUShort(unsigned short* value) override;
 173     //! Handle default integer I/O.
 174     void doInt(int* value) override;
 175     //! Handle int32 I/O.
 176     void doInt32(int32_t* value) override;
 177     //! Handle int64 I/O.
 178     void doInt64(int64_t* value) override;
 179     //! Handle single precision float I/O.
 180     void doFloat(float* value) override;
 181     //! Handle double precision float I/O.
 182     void doDouble(double* value) override;
 183     //! Handle GROMACS floating point number I/O.
 184     void doReal(real* value) override;
 185     //! Handle I/O of integer vector of size DIM.
 186     void doIvec(ivec* value) override;
 187     //! Handle I/O of GROMACS real vector of size DIM.
 188     void doRvec(rvec* value) override;
 189     //! Handle I/O if string.
 190     void doString(std::string* value) override;
 191     //! Special case for handling I/O of a vector of characters.
 192     void doCharArray(char* values, int elements) override;
 193     //! Special case for handling I/O of a vector of unsigned characters.
 194     void doUCharArray(unsigned char* values, int elements) override;
 195     //! Special case for handling I/O of a vector of rvecs.
 196     void doRvecArray(rvec* values, int elements) override;
 197
 198 private:
 199     //! File I/O handle.
 200     t_fileio* fio_;
 201 };
 202
 203 } // namespace gmx
 204
 205 #endif