PageCollection.h

#pragma once
// Copyright (c) 2001-2024 Aspose Pty Ltd. All Rights Reserved.

#include <system/collections/ienumerator.h>
#include <system/collections/ienumerable.h>
#include <system/collections/icollection.h>
#include <system/array.h>
#include <cstdint>

#include "Aspose.PDF.Cpp/ISupportsMemoryCleanup.h"
#include "Aspose.PDF.Cpp/aspose_pdf_api_defs.h"

namespace Aspose
{
namespace Pdf
{
namespace Annotations
{
class AnnotationSelector;
} // namespace Annotations
class Copier;
class Document;
namespace Engine
{
namespace CommonData
{
class IPage;
class IPages;
class IPageTreeNode;
namespace Text
{
namespace Fonts
{
namespace Utilities
{
class DocumentCIDType2FontContentUpdater;
class DocumentFontsCollector;
class DocumentFontsSubsetter;
class DocumentFontsSubstitutor;
class DocumentFontsUnembedder;
template <typename> class FontsRemover;
} // namespace Utilities
} // namespace Fonts
} // namespace Text
} // namespace CommonData
namespace Data
{
class IPdfDictionary;
class IPdfObject;
} // namespace Data
namespace IO
{
namespace ConvertStrategies
{
namespace ConvertHelpers
{
class LowLevelFontSubstitutor;
} // namespace ConvertHelpers
class PdfAConvertStrategy;
class PdfConvertStrategy;
class PdfXConvertStrategy;
} // namespace ConvertStrategies
} // namespace IO
} // namespace Engine
namespace Facades
{
class PdfFileEditor;
class PdfFileStamp;
class Stamp;
} // namespace Facades
class ImagePlacementAbsorber;
namespace LogicalStructure
{
class MCRElement;
} // namespace LogicalStructure
class Page;
class PageCollection;
class PageInfo;
class PageTreeBalancer;
class Paragraphs;
namespace Tagged
{
class TaggedContent;
class TaggedContext;
} // namespace Tagged
namespace Tests
{
namespace Facades
{
class DocumentTest;
} // namespace Facades
class RegressionTests_v11_2;
class RegressionTests_v12_0;
class RegressionTests_v12_1;
class RegressionTests_v17_9;
class RegressionTests_v20_09;
class RegressionTests_v7_0;
class RegressionTests_v8_6;
class RegressionTests_v8_9;
class RegressionTests_v9_0;
class RegressionTests_v9_1;
class RegressionTests_v9_9;
} // namespace Tests
namespace Text
{
class TextAbsorber;
class TextFragmentAbsorber;
} // namespace Text
} // namespace Pdf
namespace Utils
{
class UnrestrictedPageTreeNodeEnumerator;
} // namespace Utils
} // namespace Aspose
namespace System
{
namespace Collections
{
namespace Generic
{
template <typename, typename> class Dictionary;
template <typename> class List;
} // namespace Generic
} // namespace Collections
} // namespace System

namespace Aspose {

namespace Pdf {

class ASPOSE_PDF_SHARED_CLASS PageCollection final : public System::Collections::Generic::ICollection<System::SharedPtr<Aspose::Pdf::Page>>, public Aspose::Pdf::ISupportsMemoryCleanup
{
    typedef PageCollection ThisType;
    typedef System::Collections::Generic::ICollection<System::SharedPtr<Aspose::Pdf::Page>> BaseType;
    typedef Aspose::Pdf::ISupportsMemoryCleanup BaseType1;
    
    typedef ::System::BaseTypesInfo<BaseType, BaseType1> ThisTypeBaseTypesInfo;
    ASPOSE_PDF_SHARED_RTTI_INFO_DECL();
    
    friend class Aspose::Pdf::Engine::CommonData::Text::Fonts::Utilities::DocumentFontsCollector;
    friend class Aspose::Pdf::Engine::CommonData::Text::Fonts::Utilities::DocumentFontsSubstitutor;
    friend class Aspose::Pdf::Engine::CommonData::Text::Fonts::Utilities::DocumentFontsSubsetter;
    friend class Aspose::Pdf::Engine::CommonData::Text::Fonts::Utilities::DocumentFontsUnembedder;
    template<typename FT0> friend class Aspose::Pdf::Engine::CommonData::Text::Fonts::Utilities::FontsRemover;
    friend class Aspose::Pdf::Engine::IO::ConvertStrategies::ConvertHelpers::LowLevelFontSubstitutor;
    friend class Aspose::Pdf::Engine::CommonData::Text::Fonts::Utilities::DocumentCIDType2FontContentUpdater;
    friend class Aspose::Pdf::Engine::IO::ConvertStrategies::PdfConvertStrategy;
    friend class Aspose::Pdf::Engine::IO::ConvertStrategies::PdfXConvertStrategy;
    friend class Aspose::Pdf::Engine::IO::ConvertStrategies::PdfAConvertStrategy;
    friend class Aspose::Pdf::LogicalStructure::MCRElement;
    friend class Aspose::Pdf::Tagged::TaggedContent;
    friend class Aspose::Pdf::Tagged::TaggedContext;
    friend class Aspose::Pdf::Document;
    friend class Aspose::Pdf::Facades::PdfFileStamp;
    friend class Aspose::Pdf::Facades::Stamp;
    friend class Aspose::Pdf::Page;
    friend class Aspose::Pdf::Text::TextFragmentAbsorber;
    friend class Aspose::Pdf::PageTreeBalancer;
    friend class Aspose::Pdf::Tests::Facades::DocumentTest;
    friend class Aspose::Pdf::Facades::PdfFileEditor;
    friend class Aspose::Pdf::Tests::RegressionTests_v7_0;
    friend class Aspose::Pdf::Tests::RegressionTests_v8_6;
    friend class Aspose::Pdf::Tests::RegressionTests_v8_9;
    friend class Aspose::Pdf::Tests::RegressionTests_v9_0;
    friend class Aspose::Pdf::Tests::RegressionTests_v9_1;
    friend class Aspose::Pdf::Tests::RegressionTests_v9_9;
    friend class Aspose::Pdf::Tests::RegressionTests_v11_2;
    friend class Aspose::Pdf::Tests::RegressionTests_v12_0;
    friend class Aspose::Pdf::Tests::RegressionTests_v12_1;
    friend class Aspose::Pdf::Tests::RegressionTests_v17_9;
    friend class Aspose::Pdf::Tests::RegressionTests_v20_09;
    
protected:

    class PagesEnumerableUnrestricted : public System::Collections::Generic::IEnumerable<System::SharedPtr<Aspose::Pdf::Page>>
    {
        typedef PagesEnumerableUnrestricted ThisType;
        typedef System::Collections::Generic::IEnumerable<System::SharedPtr<Aspose::Pdf::Page>> BaseType;
        
        typedef ::System::BaseTypesInfo<BaseType> ThisTypeBaseTypesInfo;
        RTTI_INFO_DECL();
        
    public:
    
        PagesEnumerableUnrestricted(System::SharedPtr<PageCollection> pageCollection);
        
        System::SharedPtr<System::Collections::Generic::IEnumerator<System::SharedPtr<Page>>> GetEnumerator() override;
        
    protected:
    
        virtual ~PagesEnumerableUnrestricted();
        
    private:
    
        System::WeakPtr<PageCollection> _pageCollection;
        
    };
    
    
private:

    class PagesEnumerator : public System::Collections::Generic::IEnumerator<System::SharedPtr<Aspose::Pdf::Page>>
    {
        typedef PagesEnumerator ThisType;
        typedef System::Collections::Generic::IEnumerator<System::SharedPtr<Aspose::Pdf::Page>> BaseType;
        
        typedef ::System::BaseTypesInfo<BaseType> ThisTypeBaseTypesInfo;
        RTTI_INFO_DECL();
        CODEPORTING_ENUMERATOR_ITERATOR_METHODS_DECLARATION(CODEPORTING_ARGS(System::SharedPtr<Page>), CODEPORTING_NO_API_KEYWORD);
        
    public:
    
        const System::SharedPtr<Page>& get_Current() const override;
        
        PagesEnumerator(System::SharedPtr<PageCollection> pageCollection);
        
        bool MoveNext() override;
        void Reset() override;
        void Dispose() override;
        
    private:
    
        System::SharedPtr<PageCollection> _pageCollection;
        int32_t cursor;
        System::SharedPtr<Aspose::Utils::UnrestrictedPageTreeNodeEnumerator> _nodeEnumerator;
        
        bool MoveNextImplementation();
        System::SharedPtr<Page>* GetCurrentElementPointer();
        
    };
    
    class PagesEnumeratorUnrestricted : public System::Collections::Generic::IEnumerator<System::SharedPtr<Aspose::Pdf::Page>>
    {
        typedef PagesEnumeratorUnrestricted ThisType;
        typedef System::Collections::Generic::IEnumerator<System::SharedPtr<Aspose::Pdf::Page>> BaseType;
        
        typedef ::System::BaseTypesInfo<BaseType> ThisTypeBaseTypesInfo;
        RTTI_INFO_DECL();
        CODEPORTING_ENUMERATOR_ITERATOR_METHODS_DECLARATION(CODEPORTING_ARGS(System::SharedPtr<Page>), CODEPORTING_NO_API_KEYWORD);
        
    public:
    
        const System::SharedPtr<Page>& get_Current() const override;
        
        PagesEnumeratorUnrestricted(System::SharedPtr<PageCollection> pageCollection);
        
        bool MoveNext() override;
        void Reset() override;
        void Dispose() override;
        
    private:
    
        System::SharedPtr<PageCollection> _pageCollection;
        int32_t cursor;
        System::SharedPtr<Aspose::Utils::UnrestrictedPageTreeNodeEnumerator> _nodeEnumerator;
        
        bool MoveNextImplementation();
        System::SharedPtr<Page>* GetCurrentElementPointer();
        
    };
    
    class GeneratorInformation : public System::Object
    {
        typedef GeneratorInformation ThisType;
        typedef System::Object BaseType;
        
        typedef ::System::BaseTypesInfo<BaseType> ThisTypeBaseTypesInfo;
        RTTI_INFO_DECL();
        
    public:
    
        GeneratorInformation(System::SharedPtr<Page> page);
        
        void Assign(System::SharedPtr<Page> page);
        
    private:
    
        System::SharedPtr<Paragraphs> _paragraphs;
        System::SharedPtr<PageInfo> _pageInfo;
        
    };
    
    
public:

    ASPOSE_PDF_SHARED_API int32_t get_Count() const override;
    ASPOSE_PDF_SHARED_API bool get_IsSynchronized();
    ASPOSE_PDF_SHARED_API System::SharedPtr<System::Object> get_SyncRoot() const;
    ASPOSE_PDF_SHARED_API bool get_IsReadOnly() const override;
    
    ASPOSE_PDF_SHARED_API System::SharedPtr<Page> CopyPage(System::SharedPtr<Page> entity);
    ASPOSE_PDF_SHARED_API void Clear() override;
    ASPOSE_PDF_SHARED_API void Delete(int32_t index);
    ASPOSE_PDF_SHARED_API void Delete();
    ASPOSE_PDF_SHARED_API int32_t IndexOf(System::SharedPtr<Page> entity) const;
    //[Obfuscation(Feature = "virtualization", Exclude = false)]
    ASPOSE_PDF_SHARED_API void CopyTo(System::ArrayPtr<System::SharedPtr<Page>> array, int32_t index) override;
    ASPOSE_PDF_SHARED_API System::SharedPtr<System::Collections::Generic::IEnumerator<System::SharedPtr<Page>>> GetEnumerator() override;
    ASPOSE_PDF_SHARED_API void Accept(System::SharedPtr<Annotations::AnnotationSelector> visitor);
    ASPOSE_PDF_SHARED_API void Delete(System::ArrayPtr<int32_t> pages);
    ASPOSE_PDF_SHARED_API System::SharedPtr<Page> Insert(int32_t pageNumber);
    ASPOSE_PDF_SHARED_API System::SharedPtr<Page> Add();
    ASPOSE_PDF_SHARED_API void Add(const System::SharedPtr<System::Collections::Generic::ICollection<System::SharedPtr<Page>>>& pages);
    ASPOSE_PDF_SHARED_API System::SharedPtr<Page> Insert(int32_t pageNumber, System::SharedPtr<Page> entity);
    
    ASPOSE_PDF_SHARED_API System::SharedPtr<Page> idx_get(int32_t index);
    
    ASPOSE_PDF_SHARED_API void Accept(System::SharedPtr<ImagePlacementAbsorber> visitor);
    ASPOSE_PDF_SHARED_API void Accept(System::SharedPtr<Text::TextFragmentAbsorber> visitor);
    ASPOSE_PDF_SHARED_API void Accept(System::SharedPtr<Text::TextAbsorber> visitor);
    ASPOSE_PDF_SHARED_API void Add(const System::ArrayPtr<System::SharedPtr<Page>>& pages);
    ASPOSE_PDF_SHARED_API void Insert(int32_t pageNumber, System::SharedPtr<System::Collections::Generic::ICollection<System::SharedPtr<Page>>> pages);
    ASPOSE_PDF_SHARED_API void Insert(int32_t pageNumber, System::ArrayPtr<System::SharedPtr<Page>> pages);
    ASPOSE_PDF_SHARED_API void Flatten();
    ASPOSE_PDF_SHARED_API void FreeMemory() override;
    ASPOSE_PDF_SHARED_API bool Contains(const System::SharedPtr<Page>& item) const override;
    ASPOSE_PDF_SHARED_API bool Remove(const System::SharedPtr<Page>& item) override;
    
protected:

    System::SharedPtr<PageCollection::PagesEnumerableUnrestricted> get_Unrestricted();
    
    System::WeakPtr<Document> _document;
    System::SharedPtr<Engine::CommonData::IPages> pages;
    
    bool get_AnnotationsAdded() const;
    
    bool FreezeNumbersCache;
    
    PageCollection(System::SharedPtr<Document> document);
    
    MEMBER_FUNCTION_MAKE_OBJECT_DECLARATION(PageCollection, CODEPORTING_ARGS(System::SharedPtr<Document> document));
    System::SharedPtr<Page> GetUnrestricted(System::SharedPtr<Engine::CommonData::IPageTreeNode> pageNode, int32_t index);
    System::SharedPtr<Page> GetUnrestricted(int32_t index);
    System::SharedPtr<Page> Insert(int32_t pageNumber, System::SharedPtr<Page> entity, System::SharedPtr<Copier> copier);
    System::SharedPtr<Page> Add(System::SharedPtr<Page> entity, System::SharedPtr<Copier> copier);
    void Add(System::SharedPtr<System::Collections::Generic::ICollection<System::SharedPtr<Page>>> srcPages, System::SharedPtr<Copier> copier);
    void Dispose();
    System::SharedPtr<Page> FindByObjectId(int32_t objectID);
    System::SharedPtr<Page> FindByPdfObject(System::SharedPtr<Engine::Data::IPdfObject> pdfObject);
    
    virtual ASPOSE_PDF_SHARED_API ~PageCollection();
    
private:

    static const int32_t DefaultIndex;
    System::SharedPtr<PageCollection::PagesEnumerableUnrestricted> _pagesEnumerableUnrestricted;
    System::SharedPtr<System::Object> syncRoot;
    System::SharedPtr<System::Collections::Generic::Dictionary<int32_t, System::SharedPtr<PageCollection::GeneratorInformation>>> _storedGeneratorInformation;
    bool _isDisposed;
    System::SharedPtr<System::Collections::Generic::List<System::SharedPtr<Page>>> cache;
    bool _annotationsAdded;
    
    void InitCache();
    System::SharedPtr<Page> Get(int32_t index);
    System::SharedPtr<Page> Get(System::SharedPtr<Engine::CommonData::IPageTreeNode> pageNode, int32_t index);
    void Invalidate(int32_t number);
    void DuplicatePage(System::SharedPtr<Page> srcPage, System::SharedPtr<Engine::Data::IPdfObject> dest, System::SharedPtr<Copier> copier);
    void bindFields(System::SharedPtr<Page> page);
    System::SharedPtr<Page> CreateNewPage(System::SharedPtr<Engine::CommonData::IPage> newPage, int32_t index, System::SharedPtr<Page> templatePage);
    void MergeAcroForm(System::SharedPtr<Engine::Data::IPdfDictionary> source, System::SharedPtr<Engine::Data::IPdfDictionary> dest, System::SharedPtr<Copier> copier);
    System::SharedPtr<Engine::CommonData::IPageTreeNode> CopyCollectionPagesToPageTree(System::SharedPtr<System::Collections::Generic::ICollection<System::SharedPtr<Page>>> srcPages, System::SharedPtr<Copier> copier);
    System::SharedPtr<Engine::CommonData::IPageTreeNode> CopyPagesTree(System::SharedPtr<PageCollection> srcPages, System::SharedPtr<Copier> copier);
    bool MergeAcroForm(System::SharedPtr<Document> srcDocument, System::SharedPtr<Copier> copier);
    void assertObject() const;
    void Add(const System::SharedPtr<Page>& entity) override;
    
};

} // namespace Pdf
} // namespace Aspose