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,2020,2021, 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 <cstddef>
  47
  48 #include <memory>
  49 #include <vector>
  50
  51 #include "gromacs/utility/arrayref.h"
  52 #include "gromacs/utility/iserializer.h"
  53
  54 namespace gmx
  55 {
  56
  57 //! Specify endian swapping behavoir.
  58 //
  59 // The host-dependent choices avoid the calling file having to
  60 // depend on config.h.
  61 //
  62 enum class EndianSwapBehavior : int
  63 {
  64     DoNotSwap,                //!< Don't touch anything
  65     Swap,                     //!< User-enforced swapping
  66     SwapIfHostIsBigEndian,    //!< Only swap if machine we execute on is big-endian
  67     SwapIfHostIsLittleEndian, //!< Only swap if machine we execute on is little-endian
  68     Count                     //!< Number of possible behaviors
  69 };
  70
  71 class InMemorySerializer : public ISerializer
  72 {
  73 public:
  74     explicit InMemorySerializer(EndianSwapBehavior endianSwapBehavior = EndianSwapBehavior::DoNotSwap);
  75     ~InMemorySerializer() override;
  76
  77     std::vector<char> finishAndGetBuffer();
  78
  79     // From ISerializer
  80     bool reading() const override { return false; }
  81     void doBool(bool* value) override;
  82     void doUChar(unsigned char* value) override;
  83     void doChar(char* value) override;
  84     void doUShort(unsigned short* value) override;
  85     void doInt(int* value) override;
  86     void doInt32(int32_t* value) override;
  87     void doInt64(int64_t* value) override;
  88     void doFloat(float* value) override;
  89     void doDouble(double* value) override;
  90     void doReal(real* value) override;
  91     void doIvec(ivec* value) override;
  92     void doRvec(rvec* value) override;
  93     void doString(std::string* value) override;
  94     void doOpaque(char* data, std::size_t size) override;
  95
  96 private:
  97     class Impl;
  98
  99     std::unique_ptr<Impl> impl_;
 100 };
 101
 102 class InMemoryDeserializer : public ISerializer
 103 {
 104 public:
 105     InMemoryDeserializer(ArrayRef<const char> buffer,
 106                          bool                 sourceIsDouble,
 107                          EndianSwapBehavior   endianSwapBehavior = EndianSwapBehavior::DoNotSwap);
 108     ~InMemoryDeserializer() override;
 109
 110     //! Get if the source data was written in double precsion
 111     bool sourceIsDouble() const;
 112
 113     // From ISerializer
 114     bool reading() const override { return true; }
 115     void doBool(bool* value) override;
 116     void doUChar(unsigned char* value) override;
 117     void doChar(char* value) override;
 118     void doUShort(unsigned short* value) override;
 119     void doInt(int* value) override;
 120     void doInt32(int32_t* value) override;
 121     void doInt64(int64_t* value) override;
 122     void doFloat(float* value) override;
 123     void doDouble(double* value) override;
 124     void doReal(real* value) override;
 125     void doIvec(ivec* value) override;
 126     void doRvec(rvec* value) override;
 127     void doString(std::string* value) override;
 128     void doOpaque(char* data, std::size_t size) override;
 129
 130 private:
 131     class Impl;
 132
 133     std::unique_ptr<Impl> impl_;
 134 };
 135
 136 } // namespace gmx
 137
 138 #endif