edlerrors.h

Go to the documentation of this file.

/*
 * Copyright (C) 2007-2025 Global Graphics Software Ltd. All rights reserved.
 */

 
#ifndef __EDLERRORS_H__
#define __EDLERRORS_H__
 
#include <typeinfo>
#include <edl/edltypes.h>
#include <edl/edlstring.h>
 
_BEGIN_EDL_NAMESPACE
 
typedef enum
{
    EDL_OK  = 0,
 
    // Commmon Errors 1..499
    EDL_ERR_PANIC = 1,                                          
    EDL_ERR_UNDEFINED = 2,                                      
    EDL_ERR_LICENSE = 3,                                        
    EDL_ERR_FILENOTFOUND = 4,                                   
    EDL_ERR_CORRUPT_PNG_IMAGE = 5,                              
    EDL_ERR_OUTOFMEMORY = 6,                                    
    EDL_ERR_READ = 7,                                           
    EDL_ERR_LARGE_FILE = 8,                                     
    EDL_ERR_OPENFORWRITE = 9,                                   
    EDL_ERR_WRITE = 10,                                         
    EDL_ERR_IOERROR = 11,                                       
    EDL_ERR_COMPRESS = 12,                                      
    EDL_ERR_CONFIG = 13,                                        
    EDL_ERR_RESTRICTED_FONT = 14,                               
    EDL_ERR_ABORTED = 15,                                       
    EDL_ERR_BAD_ARGUMENTS = 16,                                 
    EDL_ERR_VECTOR_ERROR = 17,                                  
    EDL_ERR_BAD_FONT_MAP = 18,                                  
    EDL_ERR_UNICODE = 19,                                       
    EDL_ERR_PAGE_TOO_LARGE = 20,                                
    EDL_ERR_OPENFORREAD = 21,                                   
 
    // JawsMako API-specific errors
    JM_ERR_GENERAL = 99,                                        
    JM_ERR_UNSUPPORTED = 100,                                   
    JM_ERR_REVERT_FAILED = 101,                                 
    JM_ERR_TARGET_NOT_FOUND = 102,                              
    JM_ERR_RANGE_ERROR = 103,                                   
    JM_ERR_PAGE_NOT_FOUND = 104,                                
    JM_ERR_DOCUMENT_NOT_FOUND = 105,                            
    JM_DUPLICATE_FIELD_PARTIAL_NAME = 106,                      
    JM_ERR_FORM_FIELD_NOT_FOUND = 107,                          
    JM_ERR_DUPLICATE_WIDGET = 108,                              
    JM_ERR_WIDGET_NOT_FOUND = 109,                              
    JM_ERR_BAD_CONFIGURATION = 110,                             
    JM_ERR_APPEARANCE_NOT_FOUND = 111,                          
    JM_ERR_ANNOTATION_NOT_FOUND = 112,                          
    JM_ERR_ANNOTATION_INVALID = 113,                            
    JM_ERR_ASSEMBLY_WRITE_FORBIDDEN = 114,                      
    JM_ERR_FONT_NOT_FOUND = 115,                                
    JM_ERR_TOO_MANY_PDFOUT_WRITERS = 116,                       
    JM_ERR_INFORMATION_NOT_AVAILABLE = 117,                     
    JM_ERR_DIRECTORY_DOESNT_EXIST = 118,                        
    JM_ERR_RESOURCE_NOT_FOUND = 119,                            
    JM_ERR_BAD_UNICODE_CMAP = 120,                              
    JM_ERR_OPTIONAL_CONTENT_GROUP_NOT_FOUND = 121,              
    JM_ERR_INVALID_OPTIONAL_CONTENT = 122,                      
    JM_ERR_PCLXL = 123,                                         
    JM_ERR_PCL = 124,                                           
    JM_ERR_PJL = 125,                                           
    JM_ERR_SYMBOLSET_NOT_FOUND = 126,                           
    JM_ERR_PDF_OBJECT_NOT_FOUND = 127,                          
    JM_ERR_INVALID_PDF_OBJECT = 128,                            
    JM_ERR_INCORRECT_PDF_OBJECT_TYPE = 129,                     
    JM_ERR_IJPDS = 130,                                         
    JM_ERR_ATTEMPTED_WRITE_ON_OPEN_INPUT = 131,                 
    JM_ERR_TTF_INSTRUCTIONS = 132,                              
    JM_ERR_APEX_VULKAN_LOADER_LIBRARY_FAILED = 133,             
    JM_ERR_APEX_NO_VULKAN_DEVICES = 134,                        
    JM_ERR_INVALID_RENDER_SPEC = 135,                           
 
    // DOM Errors 500..999
    EDL_ERR_BAD_DIMENSIONS = 501,                               
    EDL_ERR_NULL_NODE = 502,                                    
    EDL_ERR_BAD_BRUSH = 503,                                    
    EDL_ERR_DOM_CREATION_FAILED = 504,                          
    EDL_ERR_INVALID_DOM_ID = 505,                               
    EDL_ERR_INVALID_TYPE3_GLYPH = 506,                          
    EDL_ERR_TYPE3_GLYPH_NOT_FOUND = 507,                        
    EDL_ERR_INVALID_GLYPHS = 508,                               
    EDL_ERR_BOUNDS_CALCULATION_FAILED = 509,                    
    EDL_ERR_NODE_ERROR = 510,                                   
    EDL_ERR_BAD_FONT = 511,                                     
    EDL_ERR_BAD_GEOMETRY = 512,                                 
    EDL_ERR_IMMUTABLE_GEOMETRY = 513,                           
    EDL_ERR_NO_COLOR_NAME = 514,                                
 
    // XPS specific errors
    EDL_ERR_INVALID_ZIP = 1001,                                 
    EDL_ERR_NO_CONTENT_TYPE = 1002,                             
    EDL_ERR_PROCESS_PART = 1003,                                
    EDL_ERR_XPS_PROVIDER = 1004,                                
    EDL_ERR_MISSING_RESOURCE = 1005,                            
    EDL_ERR_DTD_CONTENT = 1006,                                 
    EDL_ERR_MISSING_REQ_ATTRIBUTE = 1007,                       
    EDL_ERR_INVALID_ATTRIBUTE = 1008,                           
    EDL_ERR_PROPERTY_ALREADY_SET = 1009,                        
    EDL_ERR_REMOTERESOURCE_REF = 1010,                          
    EDL_ERR_KEY_SET_NON_RESOURCE = 1011,                        
    EDL_ERR_UNSUPPORTED_GLYPHS = 1012,                          
    EDL_ERR_INVALID_URI = 1013,                                 
    EDL_ERR_DEFLATE = 1014,                                     
    EDL_ERR_NO_KEY_RESDICT_OBJECT = 1015,                       
    EDL_ERR_ADD_OBJECT_RESDICT = 1016,                          
    EDL_ERR_INVALID_ABBR_PATH = 1017,                           
    EDL_ERR_NAMESPACE_NOT_UNDERSTOOD = 1018,                    
    EDL_ERR_XML_PARSER = 1019,                                  
    EDL_ERR_NO_REQ_ELEMENT = 1020,                              
    EDL_ERR_MORE_THAN_ONE_ELEMENT = 1021,                       
    EDL_ERR_INVALID_ELEMENT = 1022,                             
    EDL_ERR_FALLBACK_BEFORE_CHOICE = 1023,                      
    EDL_ERR_PREFIX_NOT_DEFINED = 1024,                          
    EDL_ERR_UNPREFIXED_ATTRIBUTE = 1025,                        
    EDL_ERR_BROKEN_ELEMENT_SEQUENCE = 1026,                     
    EDL_ERR_PREFIXED_ATTRIBUTE = 1027,                          
    EDL_ERR_INVALID_IMAGE = 1028,                               
    EDL_ERR_NUMBER_REQ_ELEMENT = 1029,                          
    EDL_ERR_MISSING_XPS_PART = 1030,                            
    EDL_ERR_PRINTTICKET_EXISTS = 1031,                          
    EDL_ERR_MULTIPLE_STARTPARTS_RELS = 1032,                    
    EDL_ERR_DICT_ITEM_PRESENT = 1033,                           
    EDL_ERR_MULTIPLE_COREPROPERTIES_RELS = 1034,                
    EDL_ERR_MULTIPLE_DOCSTRUCTURE_RELS = 1035,                  
    EDL_ERR_MULTIPLE_THUMBNAIL_RELS = 1036,                     
    EDL_ERR_INVALID_THUMBNAIL_TYPE = 1037,                      
    EDL_ERR_PRESERVED_ITEMS_NOT_DECLARED_IGNORABLE = 1038,      
    EDL_ERR_MORE_THAN_ONE_GROUP_ELEMENT = 1039,                 
    EDL_ERR_NO_REQ_GROUP_ELEMENT = 1040,                        
    EDL_ERR_INVALID_COLOR_SPECIFICATION = 1041,                 
    EDL_ERR_PROCESS_CONTENT_NOT_DECLARED_IGNORABLE = 1042,      
    EDL_ERR_DUPLICATE_URI = 1043,                               
 
    // XPS out specific errors
    EDL_ERR_UNEXPECTED_RESOURCE = 1300,                         
    EDL_ERR_DEVICE_OUTOFMEMORY = 1301,                          
    EDL_ERR_XPS_FROM_ENCRYPTED_SOURCE = 1302,                   
 
    // Outline specific errors
    EDL_ERR_DELETE_OUTLINE_WITH_CLOSED_PARENT = 1600,           
    EDL_ERR_APPEND_OUTLINE_TO_CLOSED_NODE = 1601,               
    EDL_ERR_FAILS_TO_ADD_OUTLINE_TO_METADATA_STORAGE = 1602,    
 
    // Annotation specific errors
    EDL_ERR_APPEND_EMPTY_ANNOTATION = 1700,
    EDL_ERR_APPEND_ANNOTATION_WITHOUT_RECT = 1701,
 
    // internal RIP erors
    EDL_ERR_INTERNAL_RIP = 2000,                                
 
    // PDF in specific errors
    EDL_ERR_OPEN_PDF = 2300,                                    
    EDL_ERR_INVALID_PDF_PASSWORD = 2301,                        
 
    // PDF/PS-out specific errors
    EDL_ERR_PSOUT_GENERAL_FAILURE = 2400,                       
    EDL_ERR_PDFOUT_GENERAL_FAILURE = 2401,                      
    EDL_ERR_INVALID_FONT = 2402,                                
    EDL_ERR_INCOMPATIBLE_PDFA = 2403,                           
    EDL_ERR_INCOMPATIBLE_PDFX = 2404,                           
 
    // Color specific errors
    EDL_ERR_BAD_COLOR_SPACE              = 2500,                
    EDL_ERR_COLOR_CONVERSION_FAILURE     = 2501,                
 
    // Image specific errors
    EDL_ERR_INCOMPATIBLE_IMAGE_PARAMETER = 2600,                
    EDL_ERR_IMAGE_PARAMETER_OUT_OF_RANGE = 2601,                
    EDL_ERR_IMAGE_DECODE_FAILURE         = 2602,                
    EDL_ERR_IMAGE_ENCODE_FAILURE         = 2603,                
 
    // ZIP specific errors
    EDL_ERR_ZIP_WRITE_ONLY     = 2700,                          
    EDL_ERR_ZIP_PATH_NOT_FOUND = 2701,                          
 
 
    // License related errors
    EDL_ERR_LICENSE_MISSING             = 2800,                 
    EDL_ERR_LICENSE_BAD_CONFIG          = 2801,                 
    EDL_ERR_LICENSE_INVALID             = 2802,                 
    EDL_ERR_LICENSE_BAD_AUTHMETHOD      = 2803,
    EDL_ERR_LICENSE_LIMIT_REACHED       = 2804,
    EDL_ERR_LICENSE_EXPIRED             = 2805,
    EDL_ERR_LICENSE_DISABLED            = 2806,
    EDL_ERR_LICENSE_NO_REMAINING_ACTIVATIONS = 2807,
 
    // General internal erors
    EDL_ERR_INTERNAL                    = 3000,                 
 
} EDLErrorCode;

class EDL_API IEDLError : public std::exception
{
  public:
    virtual uint32 getErrorCode() const = 0;
    virtual EDLString getErrorDescription(const EDLString &formatErrorString) = 0;
};

EDL_API EDLString getEDLErrorString(uint32 errorCode);

EDL_API void throwEDLError(uint32 errorcode);

EDL_API void throwEDLError(uint32 errorcode, const EDLString &message);
 
_END_EDL_NAMESPACE
 
#endif // __EDLERRORS_H__