PDFACompliance.h

Go to the documentation of this file.

//---------------------------------------------------------------------------------------
// Copyright (c) 2001-2025 by Apryse Software Inc. All Rights Reserved.
// Consult legal.txt regarding legal and license information.
//---------------------------------------------------------------------------------------
#ifndef PDFTRON_H_CPPPDFPDFAPDFACompliance
#define PDFTRON_H_CPPPDFPDFAPDFACompliance

#include <vector>
#include <PDF/PDFDoc.h>
#include <C/PDF/PDFA/TRN_PDFACompliance.h>
#include <Common/UString.h>


namespace pdftron { 
    namespace PDF { 
        namespace PDFA {
            class PDFAOptions;

class PDFACompliance
{
public:

    enum Conformance 
    {
        e_NoConformance     = 0,
        e_Level1A,
        e_Level1B,
        e_Level2A,
        e_Level2B,
        e_Level2U,
        e_Level3A,
        e_Level3B,
        e_Level3U,
        e_Level4,
        e_Level4E,
        e_Level4F
    };

    enum ErrorCode
    {
        // PDF/A-1 Level B Validation Errors --------------------------------
        e_PDFA0_1_0  =10,   
        e_PDFA0_1_1  =11,   
        e_PDFA0_1_2  =12,   
        e_PDFA0_1_3  =13,   
        e_PDFA0_1_4  =14,   
        e_PDFA0_1_5  =15,   
        e_PDFA1_2_1  =121,  
        e_PDFA1_2_2  =122,  
        e_PDFA1_3_1  =131,  
        e_PDFA1_3_2  =132,  
        e_PDFA1_3_3  =133,  
        e_PDFA1_3_4  =134,  
        e_PDFA1_4_1  =141,  
        e_PDFA1_4_2  =142,  
        e_PDFA1_6_1  =161,  
        e_PDFA1_7_1  =171,  
        e_PDFA1_7_2  =172,  
        e_PDFA1_7_3  =173,  
        e_PDFA1_7_4  =174,  
        e_PDFA1_8_1  =181,  
        e_PDFA1_8_2  =182,  
        e_PDFA1_8_3  =183,  
        e_PDFA1_8_4  =184,  
        e_PDFA1_8_5  =185,  
        e_PDFA1_8_6  =186,  
        e_PDFA1_8_7  =187,  
        e_PDFA1_10_1 =1101, 
        e_PDFA1_11_1 =1111, 
        e_PDFA1_11_2 =1112, 
        e_PDFA1_12_1 =1121, 
        e_PDFA1_12_2 =1122, 
        e_PDFA1_12_3 =1123, 
        e_PDFA1_12_4 =1124, 
        e_PDFA1_12_5 =1125, 
        e_PDFA1_12_6 =1126, 
        e_PDFA1_12_7 =1127, 
        e_PDFA1_12_11 =11211, 
        e_PDFA1_12_13 =11213, 
        e_PDFA1_12_15 =11215, 
        e_PDFA1_13_1 =1131, 
        e_PDFA2_2_1  =221,  
        e_PDFA2_3_2  =232,  
        e_PDFA2_3_3  =233,  
        e_PDFA2_3_3_1=2331, 
        e_PDFA2_3_3_2=2332, 
        e_PDFA2_3_4_1=2341, 
        e_PDFA2_4_1  =241,  
        e_PDFA2_4_2  =242,  
        e_PDFA2_4_3  =243,  
        e_PDFA2_4_4  =244,  
        e_PDFA2_5_1  =251,  
        e_PDFA2_5_2  =252,  
        e_PDFA2_6_1  =261,  
        e_PDFA2_7_1  =271,  
        e_PDFA2_8_1  =281,  
        e_PDFA2_9_1  =291,  
        e_PDFA2_10_1 =2101, 
        e_PDFA3_2_1  =321,  
        e_PDFA3_2_2  =322,  
        e_PDFA3_2_3  =323,  
        e_PDFA3_2_4  =324,  
        e_PDFA3_2_5  =325,  
        e_PDFA3_2_6  =326,  
        e_PDFA3_2_7  =327,  
        e_PDFA3_3_1  =331,  
        e_PDFA3_3_2  =332,  
        e_PDFA3_3_3_1=3331, 
        e_PDFA3_3_3_2=3332, 
        e_PDFA3_4_1  =341,  
        e_PDFA3_5_1  =351,  
        e_PDFA3_5_2  =352,  
        e_PDFA3_5_3  =353,  
        e_PDFA3_5_4  =354,  
        e_PDFA3_5_5  =355,  
        e_PDFA3_5_6  =356,  
        e_PDFA3_5_7  =357,  
        e_PDFA3_6_1  =361,  
        e_PDFA3_7_1  =371,  
        e_PDFA3_7_2  =372,  
        e_PDFA3_7_3  =373,  
        e_PDFA4_1    =41,   
        e_PDFA4_2    =42,   
        e_PDFA4_3    =43,   
        e_PDFA4_4    =44,   
        e_PDFA4_5    =45,   
        e_PDFA4_6    =46,   
        e_PDFA5_2_1  =521,  
        e_PDFA5_2_2  =522,  
        e_PDFA5_2_3  =523,  
        e_PDFA5_2_4  =524,  
        e_PDFA5_2_5  =525,  
        e_PDFA5_2_6  =526,  
        e_PDFA5_2_7  =527,  
        e_PDFA5_2_8  =528,  
        e_PDFA5_2_9  =529,  
        e_PDFA5_2_10 =5210, 
        e_PDFA5_2_11 =5211, 
        e_PDFA5_3_1  =531,  
        e_PDFA5_3_2_1=5321, 
        e_PDFA5_3_2_2=5322, 
        e_PDFA5_3_2_3=5323, 
        e_PDFA5_3_2_4=5324, 
        e_PDFA5_3_2_5=5325, 
        e_PDFA5_3_3_1=5331, 
        e_PDFA5_3_3_2=5332, 
        e_PDFA5_3_3_3=5333, 
        e_PDFA5_3_3_4=5334, 
        e_PDFA5_3_4_1=5341, 
        e_PDFA5_3_4_2=5342, 
        e_PDFA5_3_4_3=5343, 
        e_PDFA6_1_1  =611,  
        e_PDFA6_1_2  =612,  
        e_PDFA6_2_1  =621,  
        e_PDFA6_2_2  =622,  
        e_PDFA6_2_3  =623,  
        e_PDFA7_2_1  =721,  
        e_PDFA7_2_2  =722,  
        e_PDFA7_2_3  =723,  
        e_PDFA7_2_4  =724,  
        e_PDFA7_2_5  =725,  
        e_PDFA7_3_1  =731,  
        e_PDFA7_3_2  =732,  
        e_PDFA7_3_3  =733,  
        e_PDFA7_3_4  =734,  
        e_PDFA7_3_5  =735,  
        e_PDFA7_3_6  =736,  
        e_PDFA7_3_7  =737,  
        e_PDFA7_3_8  =738,  
        e_PDFA7_3_9  =739,  
        e_PDFA7_5_1  =751,  
        e_PDFA7_8_1  =781,  
        e_PDFA7_8_2  =782,  
        e_PDFA7_8_3  =783,  
        e_PDFA7_8_4  =784,  
        e_PDFA7_8_5  =785,  
        e_PDFA7_8_6  =786,  
        e_PDFA7_8_7  =787,  
        e_PDFA7_8_8  =788,  
        e_PDFA7_8_9  =789,  
        e_PDFA7_8_10 =7810, 
        e_PDFA7_8_11 =7811, 
        e_PDFA7_8_12 =7812, 
        e_PDFA7_8_13 =7813, 
        e_PDFA7_8_14 =7814, 
        e_PDFA7_8_15 =7815, 
        e_PDFA7_8_16 =7816, 
        e_PDFA7_8_17 =7817, 
        e_PDFA7_8_18= 7818, 
        e_PDFA7_8_19= 7819, 
        e_PDFA7_8_20 =7820, 
        e_PDFA7_8_21 =7821, 
        e_PDFA7_8_22 =7822, 
        e_PDFA7_8_23 =7823, 
        e_PDFA7_8_24 =7824, 
        e_PDFA7_8_25 =7825, 
        e_PDFA7_8_26 =7826, 
        e_PDFA7_8_27 =7827, 
        e_PDFA7_8_28 =7828, 
        e_PDFA7_8_29 =7829, 
        e_PDFA7_8_30 =7830, 
        e_PDFA7_8_31 =7831, 
        e_PDFA7_11_1 =7111, 
        e_PDFA7_11_2 =7112, 
        e_PDFA7_11_3 =7113, 
        e_PDFA7_11_4 =7114, 
        e_PDFA7_11_5 =7115, 
        e_PDFA9_1    =91,   
        e_PDFA9_2    =92,   
        e_PDFA9_3    =93,   
        e_PDFA9_4    =94,   
        e_PDFA9_5    =95,   

        // PDF/A-1 Level A Validation Errors --------------------------------
        e_PDFA3_8_1  =381,  
        e_PDFA8_2_2  =822,  
        e_PDFA8_3_3_1=8331, 
        e_PDFA8_3_3_2=8332, 
        e_PDFA8_3_4_1=8341, 
        e_PDFA8_4_1  =841,  


        // PDF/A-2 Level B Validation Errors --------------------------------
        e_PDFA1_2_3   =123,     
        e_PDFA1_3_5   =135,     
        e_PDFA1_10_2  =1102,    
        e_PDFA1_10_3  =1103,    
        e_PDFA1_12_8  =1128,    
        e_PDFA1_12_9  =1129,    
        e_PDFA1_12_10 =11210,   
        e_PDFA1_12_12 =11212,   
        e_PDFA1_12_14 =11214,   
        e_PDFA1_13_5  =1135,    
        e_PDFA2_3_10  =2310,    
        e_PDFA2_4_2_10 =24210,  
        e_PDFA2_4_2_11 =24211,  
        e_PDFA2_4_2_12 =24212,  
        e_PDFA2_4_2_13 =24213,  
        e_PDFA2_5_10   =2510,   
        e_PDFA2_5_11   =2511,   
        e_PDFA2_5_12   =2512,   
        e_PDFA2_8_3_1  =2831,   
        e_PDFA2_8_3_2  =2832,   
        e_PDFA2_8_3_3  =2833,   
        e_PDFA2_8_3_4  =2834,   
        e_PDFA2_8_3_5  =2835,   
        e_PDFA2_10_20  =21020,  
        e_PDFA2_10_21  =21021,  
        e_PDFA3_3_4    =334,    
        e_PDFA5_2_12   =5212,   
        e_PDFA8_1      =81,     
        e_PDFA11_0_0   =11000,  
        e_PDFA6_10_0   =6100,   
        e_PDFA6_10_1   =6101,   
        e_PDFA6_2_11_5 =62115,  
        e_PDFA6_2_11_6 =62116,  
        e_PDFA6_2_11_7 =62117,  
        e_PDFA6_2_11_8 =62118,  
        e_PDFA6_2_11_3_3 =621133, 
        e_PDFA6_9_1    =69001,  
        e_PDFA6_9_3    =69003,  

        // PDF/A-3 Validation Errors --------------------------------------
        e_PDFA_3E1     =1,      
        e_PDFA_3E1_1   =101,    
        e_PDFA_3E2     =2,      
        e_PDFA_3E3     =3,      

        // PDF/A-4 Validation Errors --------------------------------------
        e_PDFA_4_6_1_3_4   = 46134,      
        e_PDFA_4_6_1_3_5   = 46135,      
        e_PDFA_4_6_1_6_1_3 = 461613,     
        e_PDFA_4_6_7_3_5   = 46735,      
        e_PDFA_4_6_2_5_3   = 46253,      
        e_PDFA_4_6_6_3_1   = 46631,      
        e_PDFA_4_6_1_12_1  = 461121,     
        e_PDFA_4_6_2_4_2_3 = 462423,     
        e_PDFA_4_6_2_2_3   = 46223,      
        e_PDFA_4_6_3_1_6   = 46316,      
        e_PDFA_4_6_9_5     = 4695,       
        e_PDFA_4_6_2_10_6_1  = 4621061,  
        e_PDFA_4_6_2_10_6_4  = 4621064,  
        e_PDFA_4_6_2_10_8_1  = 4621081,  

        e_PDFA_LAST
    };


    PDFACompliance(bool convert, const UString& file_path, const char* password = 0, Conformance conf = e_Level1B, ErrorCode* exceptions = 0, int num_exceptions = 0, int max_ref_objs = 10, bool first_stop = false);

    PDFACompliance(bool convert, const char* buf, size_t buf_size, const char* password = 0, Conformance conf = e_Level1B, ErrorCode* exceptions = 0, int num_exceptions = 0, int max_ref_objs = 10, bool first_stop = false);
    PDFACompliance(bool convert, const unsigned char* buf, size_t buf_size, const char* password = 0, Conformance conf = e_Level1B, ErrorCode* exceptions = 0, int num_exceptions = 0, int max_ref_objs = 10, bool first_stop = false);

    PDFACompliance(bool convert, const UString& file_path, const PDFA::PDFAOptions& in_options);

    PDFACompliance(bool convert, const char* buf, size_t buf_size, const PDFA::PDFAOptions& in_options);
    PDFACompliance(bool convert, const unsigned char* buf, size_t buf_size, const PDFA::PDFAOptions& in_options);

    void SaveAs(const UString& file_path, bool linearized = false);

    std::vector<unsigned char> SaveAs(bool linearized = false);

#ifndef SWIG

    void SaveAs(const char* &out_buf, size_t& out_buf_size, bool linearized = false);
#endif

    size_t GetErrorCount();

    PDFACompliance::ErrorCode GetError(size_t idx);

    size_t GetRefObjCount(ErrorCode id);

    size_t GetRefObj(ErrorCode id, size_t err_idx);

    static const char* GetPDFAErrorMessage(ErrorCode id);

    static PDFACompliance::Conformance GetDeclaredConformance(const PDF::PDFDoc& in_doc);

     ~PDFACompliance();

     void Destroy();

#ifndef SWIGHIDDEN
     PDFACompliance(TRN_PDFACompliance impl) : mp_pdfac(impl) {}
     TRN_PDFACompliance mp_pdfac;
#endif
private:
    PDFACompliance(const PDFACompliance&);
    PDFACompliance& operator= (const PDFACompliance&);
};


        };  // namespace PDFA
    };  // namespace PDF
};  // namespace pdftron

#include <Impl/PDFACompliance.inl>

#endif // PDFTRON_H_CPPPDFPDFAPDFACompliance