text.h

Go to the documentation of this file.

/*
 * Copyright (C) 2018-2025 Global Graphics Software Ltd. All rights reserved.
 */
 
#ifndef JAWSMAKO_TEXT_H
#define JAWSMAKO_TEXT_H

 
#include <jawsmako/types.h>
#include <jawsmako/interactive.h>
#include <edl/idomglyphs.h>
 
namespace JawsMako
{
    using namespace EDL;
 
    class IUnicodeHelper;
    DECL_SMART_PTR(IUnicodeHelper);

    enum eLanguageType
 
    {
        eLTArabic     
    };

    class IUnicodeHelper : public IRCObject
    {
      private:
        static int compare(const void *a, const void *b);
 
      public:
        virtual ~IUnicodeHelper() {}

        static JAWSMAKO_API IUnicodeHelperPtr create(eLanguageType language);

        static JAWSMAKO_API bool isSpaceCharacter(wchar_t ch);

        virtual bool isCombiningCharacter(const wchar_t wchar) const = 0;

        virtual wchar_t getNonContextualCharacter(const wchar_t ch) const = 0;

        virtual bool hasContextualForms() const = 0;

        virtual String constructStringFromRuns(CTextRunVect &runs) const = 0;

        virtual void applyDiacriticFixes(CTextRunVect &runs) const = 0;

        virtual void applyContextualSubstitution(String &input) const = 0;
    };

    class ITextRun : public IRCObject
    {
      public:
        virtual ~ITextRun() {}

        virtual const String &getUnicode() const = 0;

        virtual U8String getUTF8() const = 0;

        virtual FMatrix getTransform() const = 0;

        virtual FPoint getLocalOrigin() const = 0;

        FPoint getOriginOnPage() const
        {
            FPoint origin = getLocalOrigin();
            getTransform().transform(origin, origin);
            return origin;
        }

        virtual FRect getLocalBounds(bool tight = true) const = 0;

        virtual FRect getBoundsOnPage(bool tight = true) const
        {
            FRect bounds = getLocalBounds(tight);
            getTransform().transformRect(bounds);
            return bounds;
        }

        virtual void getCornersOnPage(FPoint &p1, FPoint &p2, FPoint &p3, FPoint &p4, bool tight) const = 0;

        virtual CTextRunVect split() = 0;

        virtual double getSpaceWidth() const = 0;

        virtual double getSpaceWidthOnPage() const = 0;

        virtual double getFontHeightOnPage() const = 0;

        virtual IDOMGlyphsPtr getGlyphs() const = 0;
    };
 
    class IPageLayout;
    DECL_SMART_PTR(IPageLayout);

    typedef enum
    {
        ePAAll = -1,            
        ePABuildPage,           
        ePAJoinHRuns,           
        ePAJoinVRuns,           
        ePADefineReadingOrder   
    } ePageAnalysis;

    typedef enum
    {
        ePLTRoot,             
        ePLTColumn,           
        ePLTTextRun           
    } ePageLayoutType;
 
    class IPageLayoutData;
    DECL_SMART_PTR(IPageLayoutData);
 
    class IPageLayoutNode;
    DECL_SMART_PTR(IPageLayoutNode);

    typedef CEDLVector<IPageLayoutNodePtr> IPageLayoutNodeCollection;

    class IPageLayoutData : public IRCObject
    {
      public:
        virtual ~IPageLayoutData() {}

        static JAWSMAKO_API IPageLayoutDataPtr create(IPageLayoutNodeCollection data);

        virtual IPageLayoutNodeCollection getColumn(uint32 columnNumber) = 0;

        virtual uint32 getNumberOfColumns() const = 0;
    };

    class IPageLayoutNode : public IRCObject
    {
      public:
        virtual ~IPageLayoutNode() {}

        static JAWSMAKO_API IPageLayoutNodePtr create(FRect rect, ePageLayoutType type, String content, const IDOMGlyphsPtr &contentGlyphs, uint32 columnNumber);

        virtual String getContent() const = 0;

        virtual IDOMGlyphsPtr getContentGlyphs() const = 0;

        virtual FRect getPageBounds() const = 0;

        virtual ePageLayoutType getType() const = 0;

        virtual uint32 getColumnNumber() const = 0;
    };

    class IPageLayout : public IRCObject
    {
      public:
        virtual ~IPageLayout() {}

        static JAWSMAKO_API IPageLayoutPtr create(IEDLClassFactory *factory, const IDOMFixedPagePtr &page);

        static JAWSMAKO_API IPageLayoutPtr create(IEDLClassFactory *factory, const CTextRunVect &runs);

        virtual IDOMFixedPagePtr getFixedPage() const = 0;

        virtual void analyze(ePageAnalysis analysisToPerform = ePAAll) = 0;

        virtual String getLayoutInfo() const = 0;

        virtual IPageLayoutDataPtr getLayoutData() const = 0;

        virtual IPageLayoutNodeCollection getLayoutNodeCollection() const = 0;

        virtual String getPageText() const = 0;

        virtual void setVirtualSpaceThreshold(double virtualSpaceThreshold) = 0;

        virtual void setMultipleSpaceMode(bool multipleSpaces) = 0;

        virtual void setLineSpacingThreshold(double threshold) = 0;
    };
 
    class ITextSearch;
    DECL_SMART_PTR(ITextSearch);

    class ITextSearch : public IRCObject
    {
      public:
        virtual ~ITextSearch() {}

        static JAWSMAKO_API ITextSearchPtr create(IEDLClassFactory *factory, const IPageLayoutPtr &pageLayout);

        virtual CFPointVectVect search(const String &targetText, CEDLStringVect &found, bool caseSensitive, bool ignoreSpaces) const = 0;

        virtual CFPointVectVect search(const String &targetText, CEDLSysStringVect &found, bool caseSensitive, bool ignoreSpaces) const = 0;
    };
 
    class ITextSelect;
    DECL_SMART_PTR(ITextSelect);

    class ITextSelect : public IRCObject
    {
      public:
        virtual ~ITextSelect() {}

        static JAWSMAKO_API ITextSelectPtr create(IEDLClassFactory *factory, const IPageLayoutPtr &pageLayout);

        virtual String getTextAtRect(const FRect &pageArea, eLanguageType language = eLTArabic) const = 0;

        virtual CFPointVect selectArea(const FRect &pageArea, String *selectedText) const = 0;

        virtual CFPointVect selectLines(const FPoint &startPoint, const FPoint &endPoint, String *selectedText) const = 0;
    };
}
 
#endif