src/gromacs/utility/inmemoryserializer.h

   1 /*
   2  * This file is part of the GROMACS molecular simulation package.
   3  *
   4  * Copyright (c) 2016,2017,2018,2019, by the GROMACS development team, led by
   5  * Mark Abraham, David van der Spoel, Berk Hess, and Erik Lindahl,
   6  * and including many others, as listed in the AUTHORS file in the
   7  * top-level source directory and at http://www.gromacs.org.
   8  *
   9  * GROMACS is free software; you can redistribute it and/or
  10  * modify it under the terms of the GNU Lesser General Public License
  11  * as published by the Free Software Foundation; either version 2.1
  12  * of the License, or (at your option) any later version.
  13  *
  14  * GROMACS is distributed in the hope that it will be useful,
  15  * but WITHOUT ANY WARRANTY; without even the implied warranty of
  16  * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the GNU
  17  * Lesser General Public License for more details.
  18  *
  19  * You should have received a copy of the GNU Lesser General Public
  20  * License along with GROMACS; if not, see
  21  * http://www.gnu.org/licenses, or write to the Free Software Foundation,
  22  * Inc., 51 Franklin Street, Fifth Floor, Boston, MA  02110-1301  USA.
  23  *
  24  * If you want to redistribute modifications to GROMACS, please
  25  * consider that scientific software is very special. Version
  26  * control is crucial - bugs must be traceable. We will be happy to
  27  * consider code for inclusion in the official distribution, but
  28  * derived work must not be called official GROMACS. Details are found
  29  * in the README & COPYING files - if they are missing, get the
  30  * official version at http://www.gromacs.org.
  31  *
  32  * To help us fund GROMACS development, we humbly ask that you cite
  33  * the research papers on the package. Check out http://www.gromacs.org.
  34  */
  35 /*! \libinternal \file
  36  * \brief
  37  * Declares gmx::ISerializer implementation for in-memory serialization.
  38  *
  39  * \author Teemu Murtola <teemu.murtola@gmail.com>
  40  * \inlibraryapi
  41  * \ingroup module_utility
  42  */
  43 #ifndef GMX_UTILITY_INMEMORYSERIALIZER_H
  44 #define GMX_UTILITY_INMEMORYSERIALIZER_H
  45
  46 #include <vector>
  47
  48 #include "gromacs/utility/arrayref.h"
  49 #include "gromacs/utility/classhelpers.h"
  50 #include "gromacs/utility/iserializer.h"
  51
  52 namespace gmx
  53 {
  54
  55 class InMemorySerializer : public ISerializer
  56 {
  57     public:
  58         InMemorySerializer();
  59         ~InMemorySerializer() override;
  60
  61         std::vector<char> finishAndGetBuffer();
  62
  63         // From ISerializer
  64         bool reading() const override { return false; }
  65         void doBool(bool *value) override;
  66         void doUChar(unsigned char *value) override;
  67         void doChar(char *value) override;
  68         void doUShort(unsigned short *value) override;
  69         void doInt(int *value) override;
  70         void doInt32(int32_t *value) override;
  71         void doInt64(int64_t *value) override;
  72         void doFloat(float *value) override;
  73         void doDouble(double *value) override;
  74         void doReal(real *value) override;
  75         void doIvec(ivec *value) override;
  76         void doRvec(rvec *value) override;
  77         void doString(std::string *value) override;
  78
  79     private:
  80         class Impl;
  81
  82         PrivateImplPointer<Impl> impl_;
  83 };
  84
  85 class InMemoryDeserializer : public ISerializer
  86 {
  87     public:
  88         explicit InMemoryDeserializer(ArrayRef<const char> buffer, bool sourceIsDouble);
  89         ~InMemoryDeserializer() override;
  90
  91         //! Get if the source data was written in double precsion
  92         bool sourceIsDouble() const;
  93
  94         // From ISerializer
  95         bool reading() const override { return true; }
  96         void doBool(bool *value) override;
  97         void doUChar(unsigned char *value) override;
  98         void doChar(char *value) override;
  99         void doUShort(unsigned short *value) override;
 100         void doInt(int *value) override;
 101         void doInt32(int32_t *value) override;
 102         void doInt64(int64_t *value) override;
 103         void doFloat(float *value) override;
 104         void doDouble(double *value) override;
 105         void doReal(real *value) override;
 106         void doIvec(ivec *value) override;
 107         void doRvec(rvec *value) override;
 108         void doString(std::string *value) override;
 109
 110     private:
 111         class Impl;
 112
 113         PrivateImplPointer<Impl> impl_;
 114 };
 115
 116 } // namespace gmx
 117
 118 #endif