PdfError.h

Go to the documentation of this file.

 
#ifndef PDF_ERROR_H
#define PDF_ERROR_H
 
#include <podofo/main/PdfDeclarations.h>
 
namespace PoDoFo {
 
enum class PdfErrorCode
{
    Unknown = 0,              
    InvalidHandle,            
    FileNotFound,             
    IOError,                  
    UnexpectedEOF,            
    OutOfMemory,              
    ValueOutOfRange,          
    InternalLogic,            
    InvalidEnumValue,         
    MaxRecursionReached,      
    ObjectNotFound,           
    BrokenFile,               
 
    InvalidPDF,               
    InvalidTrailer,           
    InvalidNumber,            
    InvalidEncoding,          
    InvalidObject,            
    InvalidEOFToken,          
    InvalidDataType,          
    InvalidXRef,              
    InvalidXRefStream,        
    InvalidPredictor,         
    InvalidStrokeStyle,       
    InvalidStream,            
    InvalidKey,               
    InvalidName,              
    InvalidEncryptionDict,    
    InvalidPassword,          
    InvalidFontData,          
    InvalidContentStream,     
 
    UnsupportedFilter,        
    UnsupportedFontFormat,    
    WrongDestinationType,     
 
    FlateError,               
    FreeTypeError,            
 
    UnsupportedPixelFormat,   
    UnsupportedImageFormat,   
    CannotConvertColor,       
 
    NotImplemented,           
 
    ItemAlreadyPresent,       
    ChangeOnImmutable,        
 
    XmpMetadataError,         
    OpenSSLError,             
};
 
class PODOFO_API PdfErrorInfo final
{
public:
    PdfErrorInfo(std::string filepath, unsigned line, std::string info);
    PdfErrorInfo(const PdfErrorInfo& rhs) = default;
    PdfErrorInfo& operator=(const PdfErrorInfo& rhs) = default;
 
public:
    std::string_view GetFilePath() const;
    const std::string& GetFullFilePath() const { return m_FilePath; }
    inline unsigned GetLine() const { return m_Line; }
    inline const std::string& GetInformation() const { return m_Info; }
 
private:
    unsigned m_Line;
    std::string m_FilePath;
    std::string m_Info;
};
 
using PdErrorInfoStack = std::deque<PdfErrorInfo>;
 
// This is required to generate the documentation with Doxygen.
// Without this define doxygen thinks we have a class called PODOFO_EXCEPTION_API(PODOFO_API) ...
#define PODOFO_EXCEPTION_API_DOXYGEN PODOFO_EXCEPTION_API(PODOFO_API)
 
class PODOFO_EXCEPTION_API_DOXYGEN PdfError final : public std::exception
{
    PODOFO_PRIVATE_FRIEND(void AddToCallStack(PdfError& err, std::string filepath, unsigned line, std::string information));
 
public:
    PdfError(PdfErrorCode code, std::string filepath, unsigned line,
        std::string information = { });
 
    PdfError(const PdfError& rhs) = default;
 
    PdfError& operator=(const PdfError& rhs) = default;
 
    bool operator==(PdfErrorCode code);
 
    bool operator!=(PdfErrorCode code);
 
    std::string_view GetName() const;
 
    inline PdfErrorCode GetCode() const { return m_Code; }
 
    inline const PdErrorInfoStack& GetCallStack() const { return m_CallStack; }
 
    void PrintErrorMsg() const;
 
    const char* what() const noexcept override;
 
public:
    static std::string_view ErrorName(PdfErrorCode code);
 
    static std::string_view ErrorMessage(PdfErrorCode code);
 
private:
    void AddToCallStack(std::string&& filepath, unsigned line, std::string&& information);
 
    void initFullDescription();
 
private:
    PdfErrorCode m_Code;
    PdErrorInfoStack m_CallStack;
    std::string m_FullDescription;
};
 
};
 
#endif // PDF_ERROR_H