PdfCharCodeMap.h

// SPDX-FileCopyrightText: 2022 Francesco Pretto <ceztko@gmail.com>
// SPDX-License-Identifier: LGPL-2.0-or-later OR MPL-2.0
 
#ifndef PDF_CHAR_CODE_MAP_H
#define PDF_CHAR_CODE_MAP_H
 
#include "PdfDeclarations.h"
#include "PdfEncodingCommon.h"
 
namespace PoDoFo
{
    struct CodePointMapNode;
 
    struct PODOFO_API CodeUnitRange final
    {
        PdfCharCode SrcCodeLo;
        unsigned Size = 0;
        CodePointSpan DstCodeLo;
 
        CodeUnitRange();
 
        CodeUnitRange(PdfCharCode srcCodeLo, unsigned size, CodePointSpan dstCodeLo);
 
        PdfCharCode GetSrcCodeHi() const;
    };
 
    struct PODOFO_API CodeUnitRangeInequality
    {
        using is_transparent = std::true_type;
 
        bool operator()(const CodeUnitRange& lhs, const PdfCharCode& rhs) const
        {
            return lhs.SrcCodeLo < rhs;
        }
        bool operator()(const PdfCharCode& lhs, const CodeUnitRange& rhs) const
        {
            return lhs < rhs.SrcCodeLo;
        }
        bool operator()(const CodeUnitRange& lhs, const CodeUnitRange& rhs) const
        {
            return lhs.SrcCodeLo < rhs.SrcCodeLo;
        }
    };
 
    using CodeUnitRanges = std::set<CodeUnitRange, CodeUnitRangeInequality>;
 
    struct PODOFO_API CodeSpaceRange final
    {
        CodeSpaceRange();
        CodeSpaceRange(unsigned codeLo, unsigned codeHi, unsigned char codeSpaceSize);
 
        unsigned CodeLo;
        unsigned CodeHi;
        unsigned char CodeSpaceSize;
 
        PdfCharCode GetSrcCodeLo() const;
        PdfCharCode GetSrcCodeHi() const;
    };
 
    class PODOFO_API PdfCharCodeMap final
    {
        PODOFO_PRIVATE_FRIEND(class PdfCMapEncodingFactory);
 
    public:
        PdfCharCodeMap();
 
        PdfCharCodeMap(PdfCharCodeMap&& map) noexcept;
 
        ~PdfCharCodeMap();
 
    private:
        PdfCharCodeMap(CodeUnitMap&& mapping, CodeUnitRanges&& ranges, const PdfEncodingLimits& limits);
 
    public:
        void PushMapping(const PdfCharCode& codeUnit, const codepointview& codePoints);
 
        void PushMapping(const PdfCharCode& codeUnit, codepoint codePoint);
 
        void PushRange(const PdfCharCode& srcCodeLo, unsigned size, codepoint dstCodeLo);
 
        void PushRange(const PdfCharCode& srcCodeLo, unsigned size, const codepointview& dstCodeLo);
 
        bool TryGetCodePoints(const PdfCharCode& codeUnit, CodePointSpan& codePoints) const;
 
        bool TryGetNextCharCode(std::string_view::iterator& it,
            const std::string_view::iterator& end, PdfCharCode& code) const;
 
        bool TryGetCharCode(const codepointview& codePoints, PdfCharCode& code) const;
 
        bool TryGetCharCode(codepoint codePoint, PdfCharCode& code) const;
 
        PdfCharCodeMap& operator=(PdfCharCodeMap&& map) noexcept;
 
        const PdfEncodingLimits& GetLimits() const { return m_Limits; }
 
        bool IsEmpty() const;
 
        bool IsTrivialIdentity() const;
 
        std::vector<CodeSpaceRange> GetCodeSpaceRanges() const;
 
    public:
        const CodeUnitMap& GetMappings() const { return m_Mappings; }
 
        const CodeUnitRanges& GetRanges() const { return m_Ranges; }
 
    private:
        void move(PdfCharCodeMap& map) noexcept;
        void pushMapping(const PdfCharCode& codeUnit, const codepointview& codePoints);
 
    private:
        PdfCharCodeMap(const PdfCharCodeMap&) = delete;
        PdfCharCodeMap& operator=(const PdfCharCodeMap&) = delete;
 
    private:
        void updateLimits(const PdfCharCode& codeUnit);
        void reviseCodePointMap();
        bool tryFixNextRanges(const CodeUnitRanges::iterator& it, unsigned prevRangeCodeUpper);
 
    private:
        PdfEncodingLimits m_Limits;
        CodeUnitMap m_Mappings;
        CodeUnitRanges m_Ranges;
        bool m_MapDirty;
        CodePointMapNode* m_codePointMapHead;           // Head of a BST to lookup code points
    };
}
 
#endif // PDF_CHAR_CODE_MAP_H