pdfinput.h

Go to the documentation of this file.

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

 
#include <jawsmako/jawsmako.h>
#include <edl/idomfont.h>
#include <edl/edlrenderingintent.h>
 
namespace JawsMako
{
    using namespace EDL;
 
    class IPDFInput;
    DECL_SMART_PTR(IPDFInput);

    class IPDFInput : public IInput
    {
      public:
        virtual ~IPDFInput() = default;

        static JAWSMAKO_API IPDFInputPtr create(const IJawsMakoPtr &jawsMako, const IProgressMonitorPtr &progressMonitor = IProgressMonitorPtr ());

        virtual void setPassword(const U8String &password) = 0;

        virtual void setPkcs12(const IRAInputStreamPtr &pkcs12) = 0;

        virtual void setFailOnFontFallback(bool failOnFontFallback) = 0;

        virtual void setImproveGlyphSelectionForUnembeddedIdentityFonts(bool improve) = 0;

        virtual void setDefaultRenderingIntent(eRenderingIntent intent) = 0;

        virtual void setIgnoreNonGraphicalObjects(bool ignoreNonGraphical) = 0;

        class CPdfFontInfo
        {
          public:
            CPdfFontInfo()
            {
                embedded = false;
                subset = false;
                objectNumber = -1;
                generation = -1;
                subFontObjectNumber = -1;
                subFontGeneration = -1;
            }
 
            bool        embedded;            
            bool        subset;              
            RawString   fontType;            
            RawString   fontName;            
            RawString   baseFontName;        
 
            int32       objectNumber;        
            int32       generation;          
 
            int32       subFontObjectNumber; 
            int32       subFontGeneration;   
 
            CUInt32Vect referencedPages;     
 
            IDOMFontPtr font;                
 
            RawString   encoding;            
                                             //
                                             //   Simple fonts:
                                             //   - The Encoding name for fonts that define an encoding with no Differences,
                                             //     which may be "MacRomanEncoding", "MacExpertEncoding", or "WinAnsiEncoding".
                                             //   - "Custom" for fonts that define an Encoding dictionary with Differences.
                                             //   - "StandardEncoding" for non-symbolic fonts that do not define an Encoding.
                                             //   - "Built-in" for symbolic fonts that do not define an Encoding.
                                             //   Composite fonts:
                                             //   - The name of the CMap from the Type 0 font dictionary Encoding for fonts
                                             //     that define a predefined CMap.
                                             //   - "Custom" for fonts that define a CMap stream as the Type 0 font dictionary
                                             //     Encoding.
 
            bool operator== (const CPdfFontInfo &other) const
            {
                return     (other.embedded            == embedded)
                        && (other.subset              == subset)
                        && (other.fontType            == fontType)
                        && (other.fontName            == fontName)
                        && (other.baseFontName        == baseFontName)
                        && (other.encoding            == encoding)
                        && (other.objectNumber        == objectNumber)
                        && (other.generation          == generation)
                        && (other.subFontObjectNumber == subFontObjectNumber)
                        && (other.subFontGeneration   == subFontGeneration)
                        && (other.font                == font);
            }
 
            bool operator!= (const CPdfFontInfo &other) const
            {
                return ! (*this == other);
            }
        };
 
        typedef CEDLVector<CPdfFontInfo> CPdfFontInfoVect;

        virtual CPdfFontInfoVect scanPdfForFonts(const U8String &pathToFile, const IProgressMonitorPtr &progressMonitor, bool domFont = false) = 0;

        virtual CPdfFontInfoVect scanPdfForFonts(const String &pathToFile, const IProgressMonitorPtr &progressMonitor, bool domFont = false) = 0;

        virtual CPdfFontInfoVect scanPdfForFonts(const IInputStreamPtr &pdfStream, const IProgressMonitorPtr &progressMonitor, bool domFont = false) = 0;
 

        class CPdfScannedInk
        {
          public:
            RawString   inkName;  
            CUInt32Vect pageNums; 
 
            bool operator== (const CPdfScannedInk &other) const
            {
                return      (other.inkName  == inkName)
                        &&  (other.pageNums == pageNums);
            }
 
            bool operator!= (const CPdfScannedInk &other) const
            {
                return ! (*this == other);
            }
 
            String getInkName() const
            {
                return inkNameToString(inkName);
            }
 
            String getInkName(eInkFallbackEncoding fallbackEncoding) const
            {
                return inkNameToString(inkName, fallbackEncoding);
            }
        };
 
        typedef CEDLVector<CPdfScannedInk> CPdfScannedInkVect;

        virtual CPdfScannedInkVect scanPdfForInks(const U8String &pathToFile,
                                                  const IProgressMonitorPtr &progressMonitor,
                                                  uint32 startPageIndex = 0,
                                                  uint32 endPageIndex = 0,
                                                  bool includeAll = false) = 0;

        virtual CPdfScannedInkVect scanPdfForInks(const String &pathToFile,
                                                  const IProgressMonitorPtr &progressMonitor,
                                                  uint32 startPageIndex = 0,
                                                  uint32 endPageIndex = 0,
                                                  bool includeAll = false) = 0;

        virtual CPdfScannedInkVect scanPdfForInks(const IInputStreamPtr &pdfStream,
                                                  const IProgressMonitorPtr &progressMonitor,
                                                  uint32 startPageIndex = 0,
                                                  uint32 endPageIndex = 0,
                                                  bool includeAll = false) = 0;

        virtual uint32 getNumIncrementalSaves(const U8String &pathToFile) = 0;

        virtual uint32 getNumIncrementalSaves(const String &pathToFile) = 0;

        virtual uint32 getNumIncrementalSaves(const IInputStreamPtr &pdfStream) = 0;

        virtual IDocumentAssemblyPtr openIncremental(const U8String &pathToFile, uint32 incrementalIndex) = 0;

        virtual IDocumentAssemblyPtr openIncremental(const String &pathToFile, uint32 incrementalIndex) = 0;

        virtual IDocumentAssemblyPtr openIncremental(const IInputStreamPtr &pdfStream, uint32 incrementalIndex) = 0;

        virtual CIRAInputStreamVect getIncrementalSaves(const U8String &pathToFile) = 0;

        virtual CIRAInputStreamVect getIncrementalSaves(const String &pathToFile) = 0;

        virtual CIRAInputStreamVect getIncrementalSaves(const IInputStreamPtr &pdfStream) = 0;

        virtual void setAlternateBaseFont(const U8String &baseFontName, const U8String &alternateFontName) = 0;
    };
    #define obj2IPDFInput(obj) IPDFInputPtr(dynamic_cast<IPDFInput *>((IRCObject *) (obj)), true)
}
 
#endif