Serializer.h

Go to the documentation of this file.

// (c) IMT - Information Management Technology AG, CH-9470 Buchs, www.imt.ch.
//
// ActiveParts (AP) and the corresponding Data Flow Framework (DFF) is invented and designed by Jakob Daescher.
// ANY USE OF THIS CODE CONSTITUTES ACCEPTANCE OF THE TERMS OF THE COPYRIGHT NOTICE.
// ===================================================================================================
// COPYRIGHT NOTICE
// ===================================================================================================
// Copyright (C) 2005-2075, IMT Information Management Technology AG, 9470 Buchs, Switzerland
// All rights reserved.
// This code is proprietary software of IMT Information Management Technology AG (hereinafter: "IMT").
// Proprietary software is computer software licensed under exclusive legal right of IMT.
//
// The licensee is given the irrevocable, perpetual, worldwide, non-exclusive right and license to use,
// execute and reproduce the software in binary form within the licensed products.
//
// Redistribution and use in source forms, without modification, are permitted provided that the following conditions are met:
// (1) Copying of source code must retain the above copyright notice, this list of conditions and the following disclaimer.
// (2) Copying of source code is only allowed for regulatory documentation and archiving purposes
// (3) Redistributions in binary form must reproduce the above copyright notice,
//     this list of conditions and the following disclaimer in the documentation and/or other materials provided with the distribution.
//
// IMT provide no reassurances that the source code provided does not infringe
// any patent, copyright, or any other intellectual property rights of third parties.
// IMT disclaim any liability to any recipient for claims brought against
// recipient by any third party for infringement of that parties intellectual property rights.
//
// THIS SOFTWARE IS PROVIDED BY IMT AND CONTRIBUTORS "AS IS" AND ANY EXPRESS OR IMPLIED WARRANTIES,
// INCLUDING, BUT NOT LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE DISCLAIMED.
// IN NO EVENT SHALL IMT OR CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY,
// OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCURE-MENT OF SUBSTITUTE GOODS OR SERVICES;
// LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY,
// WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING
// IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
// ===================================================================================================
 
#ifndef IMT_BASE_CORE_SERIALIZATION_SERIALIZER_H
#define IMT_BASE_CORE_SERIALIZATION_SERIALIZER_H
 
#include <Imt.Base.Core.Platform/Nonmovable.h>
#include <Imt.Base.Core.Platform/Platform.h>
#include <Imt.Base.Core.Serialization/SerializableIfc.h>
 
#ifdef USE_STL
#include <functional>
#include <string>
#endif //USE_STL
 
namespace imt {
namespace base {
namespace core {
namespace serialization {
 
class Serializer final : private ::imt::base::core::platform::Nonmovable {
 
public:
 
    Serializer() = delete;
 
    // AXIVION Next Codeline AutosarC++19_03-A18.1.1: use C-style array for compatibility
    Serializer(uint8_t buffer[], uint32_t const bufferSize) noexcept;
 
    uint32_t getBufferPos() const;
 
    void setBufferPos(uint32_t const newPos);
 
    uint32_t getBufferSize() const;
 
    uint8_t const* getBuffer() const;
 
    uint32_t getUnusedBufferSize() const;
 
    bool isReset() const;
 
    uint8_t const& getBufferByte(uint32_t const indexOfByte) const;
 
    void reset();
 
    bool hasOverflow() const;
 
    Serializer& operator<<(bool const data);
 
    Serializer& operator<<(uint8_t const data);
 
    Serializer& operator<<(char_t const data);
 
    [[deprecated]] // uses unsafe strlen()
    Serializer& operator<<(char_t const* pData);
 
    Serializer& operator<<(int8_t const data);
 
    Serializer& operator<<(uint16_t const data);
 
    Serializer& operator<<(int16_t const data);
 
    Serializer& operator<<(uint32_t const data);
 
    Serializer& operator<<(int32_t const data);
 
    Serializer& operator<<(uint64_t const data);
 
    Serializer& operator<<(int64_t const data);
 
    Serializer& operator<<(float32_t const data);
 
    Serializer& operator<<(float64_t const data);
 
    Serializer& pushData(void const* const pDataSrc, uint32_t const bytes);
 
    Serializer& operator<<(SerializableIfc const& data);
 
#ifdef USE_STL
    Serializer& operator<<(std::string const& string);
 
    Serializer& pushString(std::string const& string);
#endif //USE_STL
 
#ifdef USE_STL
    using AssertDebugFunctionPtr = std::function<void(bool const condition, char_t const* const pMessage)>;
#else
    using AssertDebugFunctionPtr = void (*)(bool const condition, char_t const* const pMessage);
#endif
 
    static void setAssertDebugFunction(AssertDebugFunctionPtr const funcPtr);
 
private:
 
    bool checkCapacity(uint32_t bytesToWrite);
 
#if !defined(USE_STL)
    // AXIVION Next Codeline CodingStyle-Naming.StaticFieldPointer: type is not always a pointer
#endif
    static AssertDebugFunctionPtr s_assertDebugFunc;
 
    // AXIVION Next Codeline AutosarC++19_03-A12.1.3: All data members initialized in custom constructor
    uint32_t m_bufferPos;
    uint8_t* const m_pBuffer;
    uint32_t const m_bufferSize;
    // AXIVION Next Codeline AutosarC++19_03-A12.1.3: All data members initialized in custom constructor
    bool m_overflow;
};
 
} // namespace serialization
} // namespace core
} // namespace base
} // namespace imt
 
#endif // IMT_BASE_CORE_SERIALIZATION_SERIALIZER_H