types.h

Go to the documentation of this file.

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

 
#include <edl/edlfwd.h>
#include <edl/edlstring.h>
#include <edl/smartptr.h>
#include <edl/ircobject.h>
#include <edl/iedlfactory.h>
#include <edl/isession.h>
#include <edl/edlerrors.h>
#include <edl/edltypes.h>
#include <edl/edlvector.h>
#include <edl/idomid.h>
#include <edl/ifilespec.h>
#include <edl/edlgeom.h>
#include <edl/iabort.h>
 
#define JAWSMAKO_API EDL_API
 
namespace JawsMako
{
    using namespace EDL;
    
    // Forward declaration of common JawsMako classes
    class IJawsMako;
    DECL_SMART_PTR(IJawsMako);
    class IDocument;
    DECL_SMART_PTR(IDocument);
    class IInput;
    DECL_SMART_PTR(IInput);
    class IOutput;
    DECL_SMART_PTR(IOutput);
    class IOutputWriter;
    DECL_SMART_PTR(IOutputWriter);
    class IDocumentAssembly;
    DECL_SMART_PTR(IDocumentAssembly);
    class IPageRaster;
    DECL_SMART_PTR(IPageRaster);
    class IPage;
    DECL_SMART_PTR(IPage);
    class IJawsRenderer;
    DECL_SMART_PTR(IJawsRenderer);
    class ITextRun;
    DECL_SMART_PTR(ITextRun);
    class IOptionalContent;
    DECL_SMART_PTR(IOptionalContent);
    class IOptionalContentGroup;
    DECL_SMART_PTR(IOptionalContentGroup);
    class IOptionalContentGroupReference;
    DECL_SMART_PTR(IOptionalContentGroupReference);
    class IOptionalContentDetails;
    DECL_SMART_PTR(IOptionalContentDetails);
    class IOutputIntent;
    DECL_SMART_PTR(IOutputIntent);
    class IMarkedContentDetails;
    DECL_SMART_PTR(IMarkedContentDetails);
    class IMarkedContentStructureDetails;
    DECL_SMART_PTR(IMarkedContentStructureDetails);
    class IStructure;
    DECL_SMART_PTR(IStructure);
    class IStructureElement;
    DECL_SMART_PTR(IStructureElement);
    class IStructureElementReference;
    DECL_SMART_PTR(IStructureElementReference);
    class INamedDestination;
    DECL_SMART_PTR(INamedDestination);
    class IPJLParser;
    DECL_SMART_PTR(IPJLParser);
    using IProgressTick = EDL::IProgressTick;
    using IProgressTickPtr = EDL::IProgressTickPtr;
    using IProgressEventHandler = EDL::IProgressEventHandler;
    using IProgressEventHandlerPtr = EDL::IProgressEventHandlerPtr;
    using IProgressMonitor = EDL::IProgressMonitor;
    using IProgressMonitorPtr = EDL::IProgressMonitorPtr;
    class IPageLabel;
    DECL_SMART_PTR(IPageLabel);
    class IPDFValidator;
    DECL_SMART_PTR(IPDFValidator);
    class IScanOverprint;
    DECL_SMART_PTR(IScanOverprint);
   
    class IPDFObject;
    DECL_SMART_PTR(IPDFObject);
    typedef CEDLVector<IPDFObjectPtr> CPDFObjectVect;
    class IPDFInteger;
    DECL_SMART_PTR(IPDFInteger);
    class IPDFBoolean;
    DECL_SMART_PTR(IPDFBoolean);
    class IPDFReal;
    DECL_SMART_PTR(IPDFReal);
    class IPDFNull;
    DECL_SMART_PTR(IPDFNull);
    class IPDFString;
    DECL_SMART_PTR(IPDFString);
    class IPDFName;
    DECL_SMART_PTR(IPDFName);
    typedef CEDLVector<IPDFNamePtr> CPDFNameVect;
    class IPDFArray;
    DECL_SMART_PTR(IPDFArray);
    class IPDFDictionary;
    DECL_SMART_PTR(IPDFDictionary);
    class IPDFReference;
    DECL_SMART_PTR(IPDFReference);
    class IPDFFarReference;
    DECL_SMART_PTR(IPDFFarReference);
    class IPDFStream;
    DECL_SMART_PTR(IPDFStream);
    class IPDFOperator;
    DECL_SMART_PTR(IPDFOperator);
    class IPDFObjectStore;
    DECL_SMART_PTR(IPDFObjectStore);
 
    
    typedef IEDLError IError;
 

 
 
    typedef EDLString String;
    
    typedef EDLSysString U8String;

    typedef EDLSysString RawString;

    typedef EDLU16String U16String;
     
    typedef EDLU32String U32String;
    
    // Vector types
    
    typedef CEDLStringVect CStringVect;
    typedef CEDLSysStringVect CU8StringVect;
    typedef CEDLSysStringVect CRawStringVect;
    typedef CEDLVector<U8String> CSpotColorNames;
    typedef CEDLVector<EDL::DOMid> CDOMidVector;
    typedef CEDLVector<ITextRunPtr> CTextRunVect;
    typedef CEDLVector<IOptionalContentGroupReferencePtr> COptionalContentGroupReferenceVect;
    typedef CEDLVector<IOutputIntentPtr> COutputIntentVect;
    typedef CEDLVector<IStructureElementPtr> CStructureElementVect;
    typedef CEDLVector<IStructureElementReferencePtr> CStructureElementReferenceVect;
    typedef CEDLVector<INamedDestinationPtr> CNamedDestinationVect;
    typedef CEDLVector<uint64> CUInt64Vect;
    typedef CEDLVector<uint32> CUInt32Vect;
    typedef CEDLVector<uint16> CUInt16Vect;
    typedef CEDLVector<uint8> CUInt8Vect;
    typedef CEDLVector<int64> CInt64Vect;
    typedef CEDLVector<int32> CInt32Vect;
    typedef CEDLVector<int16> CInt16Vect;
    typedef CEDLVector<int8> CInt8Vect;
    typedef CEDLVector<float> CFloatVect;
    typedef CEDLVector<double> CDoubleVect;
    
          
    typedef enum
    {
        eOCEUnknown, 
        eOCEView,    
        eOCEPrint,  
        eOCEExport     
    } eOptionalContentEvent;
     
    JAWSMAKO_API String    U8StringToString(const U8String &string);
    
    JAWSMAKO_API U16String U8StringToU16String(const U8String &string);
    
    JAWSMAKO_API U32String U8StringToU32String(const U8String &string);
    
    JAWSMAKO_API U8String  StringToU8String(const String &string);
    
    JAWSMAKO_API U16String StringToU16String(const String &string);
    
    JAWSMAKO_API U32String StringToU32String(const String &string);

    JAWSMAKO_API String U16StringToString(const U16String &string);

    JAWSMAKO_API U8String  U16StringToU8String(const U16String &string);
    
    JAWSMAKO_API U32String U16StringToU32String(const U16String &string);
    
    JAWSMAKO_API String    U32StringToString(const U32String &string);

    JAWSMAKO_API U8String  U32StringToU8String(const U32String &string);

    JAWSMAKO_API U16String U32StringToU16String(const U32String &string);

    JAWSMAKO_API U8String  ShiftJISStringToU8String(const RawString &string);
 

    JAWSMAKO_API String inkNameToString(const RawString& string);

    typedef enum
    {
        eIFEAuto,        
        eIFEMacRoman,    
        eIFEWindows1252, 
        eIFEPDFText,     
        eIFEShiftJIS     
    } eInkFallbackEncoding;
    
    JAWSMAKO_API String inkNameToString(const RawString &string, eInkFallbackEncoding fallbackEncoding);

    JAWSMAKO_API String NormalizeStringForCompare(const String &string);
  
    enum eNormalizationForm
    {
        eNFNFKD, 
        eNFNFKC, 
        eNFNFD,  
        eNFNFC   
    };

    JAWSMAKO_API String NormalizeString(const String &string, eNormalizationForm normalizationForm);

    JAWSMAKO_API String ReplaceNonListedLigatures(String string);
    
    JAWSMAKO_API void RemoveCombinationCharacters(String &string);

    JAWSMAKO_API bool IsCombinationChar(wchar_t c);
    
    class CTemporaryStoreParameters
    {
      public:
        CTemporaryStoreParameters(uint64 memoryLimit = 0,
                                  uint64 diskLimit = 0,
                                  uint32 blockSize = 0)
        {
            m_memoryLimit = memoryLimit;
            m_diskLimit = diskLimit;
            m_blockSize = blockSize;
        }
        
      public:
        uint64 m_memoryLimit;
        uint64 m_diskLimit;
        uint32 m_blockSize;
    };
 
}
 
#endif