//
// LDASTools frameCPP - A library implementing the LIGO/Virgo frame
// specification
//
// Copyright (C) 2025 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__FrTOCSerialIO_HH
#define FrameCPP_UNIVERSAL__IMPL__FrTOCSerialIO_HH

#if !defined( SWIGIMPORTED )
#include <boost/serialization/nvp.hpp>
#include <boost/serialization/split_member.hpp>
#include <boost/serialization/version.hpp>

#include "framecpp/Common/FrameSpec.hh"
#include "framecpp/Universal/impl/HelperSerialIO.hh"
#endif /* !defined( SWIGIMPORTED ) */

#include "framecpp/Universal/impl/FrTOCData.hh"

#if !defined( SWIGIMPORTED )
namespace FrameCPP
{
    namespace Universal
    {
        class FrTOC;
        namespace FrTOCImpl
        {
            /// \brief Serialization I/O implementation for FrTOC data structures
            ///
            /// This class provides versioned serialization support for FrTOC
            /// objects using Boost.Serialization. The FrTOC (Table of Contents)
            /// structure is primarily a metadata container that aggregates
            /// information about other frame objects.
            ///
            /// \tparam FR_TOC_T The FrTOC type being serialized (typically FrTOC)
            template < typename FR_TOC_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 FrTOC data to an archive
                ///
                /// This method saves the FrTOC data to a serialization archive.
                /// Since FrTOC is primarily a metadata container, it has minimal
                /// direct data to serialize.
                ///
                /// \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 versions supported (stable structure)
                /// - Pre-v3: Not supported
                ///
                /// \note FrTOC structure is stable across all frame versions
                /// \note Primary data is in the constituent TOC objects
                template < class Archive >
                void
                save( Archive& ar, const unsigned int version ) const
                {
                    using boost::serialization::make_nvp;

                    if ( version >= 3 )
                    {
                        // FrTOC structure is essentially empty at the top level
                        // The actual TOC data is handled by the specialized
                        // FrTOC*SerialIO classes for each data type
                        
                        // Placeholder for any future FrTOC-specific fields
                        // Currently, FrTOC only provides metadata functionality
                    }
                }

                /// \brief Deserialize FrTOC data from an archive
                ///
                /// This method loads FrTOC data from a serialization archive.
                /// Since FrTOC is primarily a metadata container, it has minimal
                /// direct data to deserialize.
                ///
                /// \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+: All versions supported (stable structure)
                /// - Pre-v3: Initialize with default values
                ///
                /// \note FrTOC structure is stable across all frame versions
                /// \note Primary data is in the constituent TOC objects
                ///
                /// \warning The caller must ensure the archive contains valid
                /// FrTOC data
                template < class Archive >
                void
                load( Archive& ar, const unsigned int version )
                {
                    using boost::serialization::make_nvp;

                    if ( version >= 3 )
                    {
                        // FrTOC structure is essentially empty at the top level
                        // The actual TOC data is handled by the specialized
                        // FrTOC*SerialIO classes for each data type
                        
                        // Placeholder for any future FrTOC-specific fields
                        // Currently, FrTOC only provides metadata functionality
                    }
                    else
                    {
                        // Pre-v3: Initialize with default values
                        // No specific data to initialize for FrTOC base class
                    }
                }

                /// \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 maintains
                /// consistency with other SerialIO implementations.
                BOOST_SERIALIZATION_SPLIT_MEMBER( )
            };

        } // namespace FrTOCImpl
    } // namespace Universal
} // namespace FrameCPP

/// \brief Specify the class version for Boost.Serialization
///
/// This macro tells Boost.Serialization that FrTOCImpl::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::FrTOCImpl::Data, 9 )

#endif /* !defined( SWIGIMPORTED ) */

#endif /* FrameCPP_UNIVERSAL__IMPL__FrTOCSerialIO_HH */