c_file_structure_validator.h

Go to the documentation of this file.

#ifndef _C_FILE_STRUCTURE_VALIDATOR_H
#define _C_FILE_STRUCTURE_VALIDATOR_H
 
#include "vanillapdf/c_export.h"
#include "vanillapdf/c_handles.h"
#include "vanillapdf/c_values.h"
 
#ifdef __cplusplus
extern "C"
{
#endif
 
    typedef enum {
        FileStructureIssueSeverity_Undefined = 0, 
        FileStructureIssueSeverity_Info,           
        FileStructureIssueSeverity_Warning,        
        FileStructureIssueSeverity_Error           
    } FileStructureIssueSeverityType;
 
    typedef enum {
        FileStructureIssueCode_Undefined = 0,                             
        /* Header checks (100s) */
        FileStructureIssueCode_HeaderMissing = 100,                       
        FileStructureIssueCode_HeaderVersionUndefined = 101,              
        /* Trailer checks (200s) */
        FileStructureIssueCode_TrailerMissingSize = 200,                  
        FileStructureIssueCode_TrailerMissingRoot = 201,                  
        FileStructureIssueCode_TrailerSizeMismatch = 202,                 
        FileStructureIssueCode_TrailerMissing = 203,                      
        /* Xref entry checks (300s) */
        FileStructureIssueCode_XrefUsedEntryBadOffset = 300,              
        FileStructureIssueCode_XrefUsedEntryOffsetExceedsFileSize = 301,  
        FileStructureIssueCode_XrefCompressedEntryMissingObjectStream = 302, 
        FileStructureIssueCode_XrefFreeEntryInvalidNextFree = 303,        
        /* Object reference checks (400s) */
        FileStructureIssueCode_TrailerRootReferenceNotInXref = 400,       
        FileStructureIssueCode_TrailerInfoReferenceNotInXref = 401,       
        /* Xref chain checks (500s) */
        FileStructureIssueCode_XrefChainEmpty = 500                       
    } FileStructureIssueCodeType;
 
    VANILLAPDF_API error_type CALLING_CONVENTION FileStructureValidator_Validate(
        FileHandle* handle,
        FileStructureValidationResultHandle** result
    );
 
    VANILLAPDF_API error_type CALLING_CONVENTION FileStructureValidationResult_GetIssueCount(
        FileStructureValidationResultHandle* handle,
        size_type* result
    );
 
    VANILLAPDF_API error_type CALLING_CONVENTION FileStructureValidationResult_GetIssueAt(
        FileStructureValidationResultHandle* handle,
        size_type index,
        FileStructureIssueHandle** result
    );
 
    VANILLAPDF_API error_type CALLING_CONVENTION FileStructureValidationResult_IsValid(
        FileStructureValidationResultHandle* handle,
        boolean_type* result
    );
 
    VANILLAPDF_API error_type CALLING_CONVENTION FileStructureValidationResult_GetErrorCount(
        FileStructureValidationResultHandle* handle,
        size_type* result
    );
 
    VANILLAPDF_API error_type CALLING_CONVENTION FileStructureValidationResult_GetWarningCount(
        FileStructureValidationResultHandle* handle,
        size_type* result
    );
 
    VANILLAPDF_API error_type CALLING_CONVENTION FileStructureValidationResult_ToUnknown(
        FileStructureValidationResultHandle* handle,
        IUnknownHandle** result
    );
 
    VANILLAPDF_API error_type CALLING_CONVENTION FileStructureValidationResult_FromUnknown(
        IUnknownHandle* handle,
        FileStructureValidationResultHandle** result
    );
 
    VANILLAPDF_API error_type CALLING_CONVENTION FileStructureValidationResult_Release(
        FileStructureValidationResultHandle* handle
    );
 
    VANILLAPDF_API error_type CALLING_CONVENTION FileStructureIssue_GetSeverity(
        FileStructureIssueHandle* handle,
        FileStructureIssueSeverityType* result
    );
 
    VANILLAPDF_API error_type CALLING_CONVENTION FileStructureIssue_GetCode(
        FileStructureIssueHandle* handle,
        FileStructureIssueCodeType* result
    );
 
    VANILLAPDF_API error_type CALLING_CONVENTION FileStructureIssue_GetMessage(
        FileStructureIssueHandle* handle,
        BufferHandle** result
    );
 
    VANILLAPDF_API error_type CALLING_CONVENTION FileStructureIssue_HasObjectContext(
        FileStructureIssueHandle* handle,
        boolean_type* result
    );
 
    VANILLAPDF_API error_type CALLING_CONVENTION FileStructureIssue_GetObjectNumber(
        FileStructureIssueHandle* handle,
        biguint_type* result
    );
 
    VANILLAPDF_API error_type CALLING_CONVENTION FileStructureIssue_GetGenerationNumber(
        FileStructureIssueHandle* handle,
        ushort_type* result
    );
 
    VANILLAPDF_API error_type CALLING_CONVENTION FileStructureIssue_ToUnknown(
        FileStructureIssueHandle* handle,
        IUnknownHandle** result
    );
 
    VANILLAPDF_API error_type CALLING_CONVENTION FileStructureIssue_FromUnknown(
        IUnknownHandle* handle,
        FileStructureIssueHandle** result
    );
 
    VANILLAPDF_API error_type CALLING_CONVENTION FileStructureIssue_Release(
        FileStructureIssueHandle* handle
    );
 
#ifdef __cplusplus
};
#endif
 
#endif /* _C_FILE_STRUCTURE_VALIDATOR_H */