//
// 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_TEST_MODERN_TOC_PRINTER_HH
#define FRAMECPP_TEST_MODERN_TOC_PRINTER_HH

#include <iostream>
#include "framecpp/Universal/FrTOC.hh"
#include "LegacyTOCPrinter.hh"

namespace FrameCPP
{
    namespace Test
    {
        /// \brief Modern TOC printer for frame specification versions 8+
        ///
        /// This class prints FrTOC contents for frame specifications v8 and v9,
        /// which introduced self-describing structures. For consistency with
        /// legacy output, this maintains parallel array format but includes
        /// v8+ specific fields like nTotalEvent.
        ///
        /// Version 9 removed FrStatData, so that section is not printed for v9.
        class ModernTOCPrinter
        {
        public:
            /// \brief Constructor
            ///
            /// \param[in,out] os Output stream for TOC dump
            explicit ModernTOCPrinter( std::ostream& os );

            /// \brief Print complete TOC in version-specific format
            ///
            /// \param[in] toc Table of contents to print
            /// \param[in] version Frame specification version (8 or 9)
            void print( const Universal::FrTOC* toc, unsigned int version );

        private:
            //---------------------------------------------------------------
            // Component printers - override LegacyTOCPrinter for v8+
            // specific handling
            //---------------------------------------------------------------

            /// \brief Print FrTOCEvent section with v8+ nTotalEvent field
            void printFrTOCEvent( const Universal::FrTOC* toc,
                                  unsigned int             version );

            /// \brief Print FrTOCSimEvent section with v8+ nTotalSEvent field
            void printFrTOCSimEvent( const Universal::FrTOC* toc,
                                     unsigned int             version );

            //---------------------------------------------------------------
            // Helper methods
            //---------------------------------------------------------------

            /// \brief Print simple array on one line
            template < typename Container >
            void printArray( const char* label, const Container& container );

            std::ostream&       m_os;            ///< Output stream
            LegacyTOCPrinter m_legacy_printer; ///< Reuse legacy printer for
                                                ///< most sections
        };

    } // namespace Test
} // namespace FrameCPP

#endif /* FRAMECPP_TEST_MODERN_TOC_PRINTER_HH */
