PoDoFo 1.1.0
Loading...
Searching...
No Matches
PdfError.h
Go to the documentation of this file.
1
7#ifndef PDF_ERROR_H
8#define PDF_ERROR_H
9
11
16namespace PoDoFo {
17
80
81class PODOFO_API PdfErrorInfo final
82{
83public:
84 PdfErrorInfo(std::string filepath, unsigned line, std::string info);
85 PdfErrorInfo(const PdfErrorInfo& rhs) = default;
86 PdfErrorInfo& operator=(const PdfErrorInfo& rhs) = default;
87
88public:
92 std::string_view GetFilePath() const;
93 const std::string& GetFullFilePath() const { return m_FilePath; }
94 inline unsigned GetLine() const { return m_Line; }
95 inline const std::string& GetInformation() const { return m_Info; }
96
97private:
98 unsigned m_Line;
99 std::string m_FilePath;
100 std::string m_Info;
101};
102
103using PdErrorInfoStack = std::deque<PdfErrorInfo>;
104
115class PODOFO_API PdfError final : public std::exception
116{
117 PODOFO_PRIVATE_FRIEND(void AddToCallStack(PdfError& err, std::string filepath, unsigned line, std::string information));
118
119public:
128 PdfError(PdfErrorCode code, std::string filepath, unsigned line,
129 std::string information = { });
130
134 PdfError(const PdfError& rhs) = default;
135
140 PdfError& operator=(const PdfError& rhs) = default;
141
147 bool operator==(PdfErrorCode code);
148
154 bool operator!=(PdfErrorCode code);
155
156 std::string_view GetName() const;
157
161 inline PdfErrorCode GetCode() const { return m_Code; }
162
166 inline const PdErrorInfoStack& GetCallStack() const { return m_CallStack; }
167
171 void PrintErrorMsg() const;
172
176 const char* what() const noexcept override;
177
178public:
183 static std::string_view ErrorName(PdfErrorCode code);
184
190 static std::string_view ErrorMessage(PdfErrorCode code);
191
192private:
206 void AddToCallStack(std::string&& filepath, unsigned line, std::string&& information);
207
208 void initFullDescription();
209
210private:
211 PdfErrorCode m_Code;
212 PdErrorInfoStack m_CallStack;
213 std::string m_FullDescription;
214};
215
216};
217
218#endif // PDF_ERROR_H
SPDX-FileCopyrightText: (C) 2005 Dominik Seichter domseichter@web.de SPDX-FileCopyrightText: (C) 2020...
The error handling class of the PoDoFo library.
Definition PdfError.h:116
const PdErrorInfoStack & GetCallStack() const
Get access to the internal callstack of this error.
Definition PdfError.h:166
PdfErrorCode GetCode() const
Return the error code of this object.
Definition PdfError.h:161
PdfError & operator=(const PdfError &rhs)=default
Assignment operator.
PdfError(const PdfError &rhs)=default
Copy constructor.
Convenient type for char array storage and/or buffer with std::string compatibility.
Definition basetypes.h:38
SPDX-FileCopyrightText: (C) 2022 Francesco Pretto ceztko@gmail.com SPDX-License-Identifier: LGPL-2....
Definition basetypes.h:16
PdfErrorCode
Error Code enum values which are used in PdfError to describe the error.
Definition PdfError.h:26
@ InvalidKey
The specified key is invalid.
@ InvalidXRef
The XRef table is invalid.
@ BrokenFile
The file content is broken.
@ InvalidXRefStream
A XRef stream is invalid.
@ InvalidEnumValue
An invalid enum value was specified.
@ ChangeOnImmutable
Changing values on immutable objects is not allowed.
@ XmpMetadataError
Error while creating or reading XMP metadata.
@ MaxRecursionReached
Reached maximum recursion depth.
@ FileNotFound
A file was not found or cannot be opened.
@ InvalidHandle
Unexpected null pointer or invalid state.
@ InvalidDataType
The passed datatype is invalid or was not recognized.
@ InvalidContentStream
The content stream is invalid due to mismatched context pairing or other problems.
@ IOError
Tried to do something unsupported to an I/O device like seek a non-seekable input device.
@ InvalidStrokeStyle
Invalid stroke style during drawing.
@ FlateError
Error in zlib.
@ UnsupportedFontFormat
This font format is not supported by PoDoFo.
@ InvalidTrailer
The PDF file has no or an invalid trailer.
@ InvalidObject
Invalid object or none none was found.
@ UnsupportedFilter
The requested filter is not yet implemented.
@ UnsupportedImageFormat
This image format is not supported by PoDoFo.
@ FreeTypeError
Error in FreeType.
@ InternalLogic
An internal sanity check or assertion failed.
@ ItemAlreadyPresent
An item to be inserted is already in this container.
@ InvalidNumber
A number was expected in the PDF file, but the read string is no number.
@ InvalidPassword
The password used to open the PDF file was invalid.
@ InvalidPredictor
Invalid or unimplemented predictor.
@ NotImplemented
This feature is currently not implemented.
@ OpenSSLError
OpenSSL error.
@ UnsupportedPixelFormat
This pixel format is not supported by PoDoFo.
@ InvalidName
The specified Name is not valid in this context.
@ InvalidFontData
The font file is invalid.
@ OutOfMemory
Not enough memory to complete an operation.
@ ObjectNotFound
An object was requested but was not found.
@ WrongDestinationType
The requested field is not available for the given destination type.
@ InvalidEncoding
Invalid encoding information.
@ InvalidPDF
The file is no PDF file.
@ InvalidStream
The stream is invalid.
@ InvalidInput
Invalid input.
@ CannotConvertColor
This color format cannot be converted.
@ InvalidEncryptionDict
The encryption dictionary is invalid or misses a required key.
@ InvalidEOFToken
The PDF file has no or an invalid EOF marker.
@ ValueOutOfRange
The specified memory is out of the allowed range.
@ UnsupportedOperation
Unsupported operation.
@ UnexpectedEOF
End of file was reached but data was expected.