/******************************************************************************

 *

 * Purpose:  Declaration of the CPCIDSKSegment class.

 *

 ******************************************************************************

 * Copyright (c) 2009

 * PCI Geomatics, 90 Allstate Parkway, Markham, Ontario, Canada.

 *

 * SPDX-License-Identifier: MIT

 ****************************************************************************/

#ifndef INCLUDE_SEGMENT_PCIDSKSEGMENT_H

#define INCLUDE_SEGMENT_PCIDSKSEGMENT_H

#include "pcidsk_config.h"

#include "pcidsk_types.h"

#include "pcidsk_buffer.h"

#include "pcidsk_segment.h"

#include <string>

#include <vector>

namespace PCIDSK

{

    class PCIDSKFile;

    class MetadataSet;

/************************************************************************/

/*                            CPCIDSKSegment                            */

/*                                                                      */

/*      Base class for accessing all segments.  Provides core           */

/*      PCIDSKObject implementation for segments with raw segment io    */

/*      options.                                                        */

/************************************************************************/

    class CPCIDSKSegment : virtual public PCIDSKSegment

    {

    public:

        CPCIDSKSegment( PCIDSKFile *file, int segment,

            const char *segment_pointer );

        virtual ~CPCIDSKSegment();

        void        LoadSegmentPointer( const char *segment_pointer ) override final;

        void        LoadSegmentHeader();

        PCIDSKBuffer &GetHeader() { return header; }

        void        FlushHeader();

        void      WriteToFile( const void *buffer, uint64 offset, uint64 size ) override;

        void      ReadFromFile( void *buffer, uint64 offset, uint64 size ) override;

        eSegType    GetSegmentType() override { return segment_type; }

        std::string GetName() override { return segment_name; }

        std::string GetDescription() override;

        int         GetSegmentNumber() override { return segment; }

        bool        IsContentSizeValid() const override { return data_size >= 1024; }

        uint64      GetContentSize() override { return data_size - 1024; }

        uint64      GetContentOffset() override { return data_offset; }

        bool        IsAtEOF() override;

        bool        CanExtend(uint64 size) const override;

        void        SetDescription( const std::string &description) override;

        std::string GetMetadataValue( const std::string &key ) const override;

        void        SetMetadataValue( const std::string &key, const std::string &value ) override;

        std::vector<std::string> GetMetadataKeys() const override;

        virtual void Synchronize() override {}

        std::vector<std::string> GetHistoryEntries() const override;

        void SetHistoryEntries( const std::vector<std::string> &entries ) override;

        void PushHistory(const std::string &app,

                         const std::string &message) override;

        virtual std::string ConsistencyCheck() override { return ""; }

    protected:

        PCIDSKFile *file;

        int         segment;

        eSegType    segment_type;

        char        segment_flag;

        std::string segment_name;

        uint64      data_offset;     // includes 1024 byte segment header.

        uint64      data_size;

        uint64      data_size_limit;

        PCIDSKBuffer header;

        mutable MetadataSet  *metadata;

        std::vector<std::string> history_;

        void        MoveData( uint64 src_offset, uint64 dst_offset,

                              uint64 size_in_bytes );

    };

} // end namespace PCIDSK

#endif // INCLUDE_SEGMENT_PCIDSKSEGMENT_H