//
// LDASTools frameCPP - A library implementing the LIGO/Virgo frame
// specification
//
// Copyright (C) 2019 California Institute of Technology
//
// LDASTools frameCPP is free software; you may redistribute it and/or modify
// it under the terms of the GNU General Public License as published by
// the Free Software Foundation; either version 2 (GPLv2) of the
// License or at your discretion, any later version.
//
// LDASTools frameCPP is distributed in the hope that it will be useful, but
// without any warranty or even the implied warranty of merchantability
// or fitness for a particular purpose. See the GNU General Public
// License (GPLv2) for more details.
//
// Neither the names of the California Institute of Technology (Caltech),
// The Massachusetts Institute of Technology (M.I.T), The Laser
// Interferometer Gravitational-Wave Observatory (LIGO), nor the names
// of its contributors may be used to endorse or promote products derived
// from this software without specific prior written permission.
//
// You should have received a copy of the licensing terms for this
// software included in the file LICENSE located in the top-level
// directory of this package. If you did not, you can view a copy at
// http://dcc.ligo.org/M1500244/LICENSE
//

#ifndef FrameCPP_UNIVERSAL__IMPL__FrHistorySerialIO_HH
#define FrameCPP_UNIVERSAL__IMPL__FrHistorySerialIO_HH

#include <boost/serialization/nvp.hpp>
#include <boost/serialization/string.hpp>
#include <boost/serialization/split_member.hpp>
#include <boost/serialization/version.hpp>

#include "framecpp/Common/FrameSpec.hh"
#include "framecpp/Universal/impl/HelperSerialIO.hh"
#include "framecpp/Universal/impl/FrHistoryData.hh"

namespace FrameCPP
{
    namespace Universal
    {
        class FrHistory;
        namespace FrHistoryImpl
        {
            /// \brief Serialization I/O implementation for FrHistory data
            /// structures
            ///
            /// This class provides versioned serialization support for FrHistory
            /// objects using Boost.Serialization. It handles the stable FrHistory
            /// data structure across different frame specification versions
            /// (v3 through v9).
            ///
            /// \tparam FR_HISTORY_T The FrHistory type being serialized (typically
            /// FrHistory)
            template < typename FR_HISTORY_T >
            class SerialIO : public virtual Data
            {
            public:
                /// \brief Default constructor
                ///
                /// Constructs an empty SerialIO object ready for serialization
                /// operations. The object inherits data members from the Data
                /// base class.
                SerialIO( )
                {
                }
                
                SerialIO( const SerialIO& ) = default;
                SerialIO( SerialIO&& ) = default;
                SerialIO& operator=( const SerialIO& ) = delete;
                SerialIO& operator=( SerialIO&& ) = delete;

            private:
                friend class boost::serialization::access;

                /// \brief Serialize FrHistory data to an archive
                ///
                /// This method saves the FrHistory data to a serialization archive.
                /// Since the FrHistory structure has been stable from v3 onwards,
                /// all fields are serialized consistently across supported versions.
                ///
                /// \tparam Archive The Boost.Serialization archive type
                ///
                /// \param[in,out] ar The archive to write data to
                /// \param[in] version The target serialization version (3-9)
                ///
                /// \throws boost::archive::archive_exception on serialization
                /// errors
                ///
                /// Version-specific handling:
                /// - v3+: All fields supported (name, time, comment)
                /// - Pre-v3: Not supported, FrHistory structure undefined
                ///
                /// \note All data types remain consistent across versions
                /// \note time field is stored as INT_4U (GPS seconds)
                template < class Archive >
                void
                save( Archive& ar, const unsigned int version ) const
                {
                    using boost::serialization::make_nvp;

                    if ( version >= 3 )
                    {
                        // History record name
                        ar& make_nvp( "name", name );

                        // GPS time (integer seconds)
                        ar& make_nvp( "time", time );

                        // Processing description and comments
                        ar& make_nvp( "comment", comment );
                    }
                    // Note: FrHistory structure was introduced in v3, so no
                    // handling for earlier versions
                }

                /// \brief Deserialize FrHistory data from an archive
                ///
                /// This method loads FrHistory data from a serialization archive.
                /// Since the FrHistory structure has been stable from v3 onwards,
                /// all fields are loaded consistently across supported versions.
                ///
                /// \tparam Archive The Boost.Serialization archive type
                ///
                /// \param[in,out] ar The archive to read data from
                /// \param[in] version The source serialization version (3-9)
                ///
                /// \throws boost::archive::archive_exception on deserialization
                /// errors
                ///
                /// Version-specific handling:
                /// - v3+: Loads all fields (name, time, comment)
                /// - Pre-v3: Initializes with default empty values
                ///
                /// \note Default values are provided for unsupported versions
                /// \note time field represents GPS seconds as INT_4U
                ///
                /// \warning The caller must ensure the archive contains valid
                /// FrHistory data
                template < class Archive >
                void
                load( Archive& ar, const unsigned int version )
                {
                    using boost::serialization::make_nvp;

                    if ( version >= 3 )
                    {
                        // History record name
                        ar& make_nvp( "name", name );

                        // GPS time (integer seconds)
                        ar& make_nvp( "time", time );

                        // Processing description and comments
                        ar& make_nvp( "comment", comment );
                    }
                    else
                    {
                        // Pre-v3: Initialize with default values
                        name.clear( );
                        time = 0;
                        comment.clear( );
                    }
                }

                /// \brief Boost.Serialization split member macro
                ///
                /// This macro splits the serialize() method into separate
                /// save() and load() methods, allowing for different logic
                /// during serialization and deserialization. This provides
                /// consistency with other SerialIO implementations.
                BOOST_SERIALIZATION_SPLIT_MEMBER( )
            };

        } // namespace FrHistoryImpl
    } // namespace Universal
} // namespace FrameCPP

/// \brief Specify the class version for Boost.Serialization
///
/// This macro tells Boost.Serialization that FrHistoryImpl::Data is at version 9,
/// which corresponds to the v9 frame specification. The serialization framework
/// uses this version number to determine how to serialize/deserialize the data.
///
/// \note This version number is passed to the save() and load() methods
BOOST_CLASS_VERSION( FrameCPP::Universal::FrHistoryImpl::Data, 9 )
BOOST_CLASS_VERSION( FrameCPP::Universal::FrHistory, 9 )

#endif /* FrameCPP_UNIVERSAL__IMPL__FrHistorySerialIO_HH */
