/usr/include/podofo/base/PdfError.h is in libpodofo-dev 0.9.0-1.2+b2.
This file is owned by root:root, with mode 0o644.
The actual contents of the file can be viewed below.
1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 17 18 19 20 21 22 23 24 25 26 27 28 29 30 31 32 33 34 35 36 37 38 39 40 41 42 43 44 45 46 47 48 49 50 51 52 53 54 55 56 57 58 59 60 61 62 63 64 65 66 67 68 69 70 71 72 73 74 75 76 77 78 79 80 81 82 83 84 85 86 87 88 89 90 91 92 93 94 95 96 97 98 99 100 101 102 103 104 105 106 107 108 109 110 111 112 113 114 115 116 117 118 119 120 121 122 123 124 125 126 127 128 129 130 131 132 133 134 135 136 137 138 139 140 141 142 143 144 145 146 147 148 149 150 151 152 153 154 155 156 157 158 159 160 161 162 163 164 165 166 167 168 169 170 171 172 173 174 175 176 177 178 179 180 181 182 183 184 185 186 187 188 189 190 191 192 193 194 195 196 197 198 199 200 201 202 203 204 205 206 207 208 209 210 211 212 213 214 215 216 217 218 219 220 221 222 223 224 225 226 227 228 229 230 231 232 233 234 235 236 237 238 239 240 241 242 243 244 245 246 247 248 249 250 251 252 253 254 255 256 257 258 259 260 261 262 263 264 265 266 267 268 269 270 271 272 273 274 275 276 277 278 279 280 281 282 283 284 285 286 287 288 289 290 291 292 293 294 295 296 297 298 299 300 301 302 303 304 305 306 307 308 309 310 311 312 313 314 315 316 317 318 319 320 321 322 323 324 325 326 327 328 329 330 331 332 333 334 335 336 337 338 339 340 341 342 343 344 345 346 347 348 349 350 351 352 353 354 355 356 357 358 359 360 361 362 363 364 365 366 367 368 369 370 371 372 373 374 375 376 377 378 379 380 381 382 383 384 385 386 387 388 389 390 391 392 393 394 395 396 397 398 399 400 401 402 403 404 405 406 407 408 409 410 411 412 413 414 415 416 417 418 419 420 421 422 423 424 425 426 427 428 429 430 431 432 433 434 435 436 437 438 439 440 441 442 443 444 445 446 447 448 449 450 451 452 453 454 455 456 457 458 459 460 461 462 463 464 465 466 467 468 469 470 471 472 473 474 475 476 477 478 479 480 481 482 483 484 485 486 487 488 489 490 491 492 493 494 495 496 | /***************************************************************************
* Copyright (C) 2006 by Dominik Seichter *
* domseichter@web.de *
* *
* This program is free software; you can redistribute it and/or modify *
* it under the terms of the GNU Library General Public License as *
* published by the Free Software Foundation; either version 2 of the *
* License, or (at your option) any later version. *
* *
* This program is distributed in the hope that it will be useful, *
* but WITHOUT ANY WARRANTY; without even the implied warranty of *
* MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the *
* GNU General Public License for more details. *
* *
* You should have received a copy of the GNU Library General Public *
* License along with this program; if not, write to the *
* Free Software Foundation, Inc., *
* 59 Temple Place - Suite 330, Boston, MA 02111-1307, USA. *
***************************************************************************/
#ifndef _PDF_ERROR_H_
#define _PDF_ERROR_H_
// PdfError.h should not include PdfDefines.h, since it is included by it.
// It should avoid depending on anything defined in PdfDefines.h .
#include "podofoapi.h"
#include <string>
#include <queue>
#include <cstdarg>
#if defined(_MSC_VER) && _MSC_VER <= 1200 // same pragma as in PdfDefines.h which we cannot include here
#pragma warning(disable: 4251)
#endif
/** \file PdfError.h
* Error information and logging is implemented in this file.
*/
namespace PoDoFo {
/** Error Code defines which are used in PdfError to describe the error.
*
* If you add an error code to this enum, please also add it to PdfError::ErrorName
* and PdfError::ErrorMessage.
*
* \see PdfError
*/
enum EPdfError {
ePdfError_ErrOk = 0, /**< The default value indicating no error. */
ePdfError_TestFailed, /**< Used in PoDoFo tests, to indicate that a test failed for some reason. */
ePdfError_InvalidHandle, /**< Null pointer was passed, but null pointer is not allowed. */
ePdfError_FileNotFound, /**< A file was not found or cannot be opened. */
ePdfError_InvalidDeviceOperation, /**< Tried to do something unsupported to an I/O device like seek a non-seekable input device */
ePdfError_UnexpectedEOF, /**< End of file was reached but data was expected. */
ePdfError_OutOfMemory, /**< Not enough memory to complete an operation. */
ePdfError_ValueOutOfRange, /**< The specified memory is out of the allowed range. */
ePdfError_InternalLogic, /**< An internal sanity check or assertion failed. */
ePdfError_InvalidEnumValue, /**< An invalid enum value was specified. */
ePdfError_PageNotFound, /**< The requested page could not be found in the PDF. */
ePdfError_NoPdfFile, /**< The file is no PDF file. */
ePdfError_NoXRef, /**< The PDF file has no or an invalid XRef table. */
ePdfError_NoTrailer, /**< The PDF file has no or an invalid trailer. */
ePdfError_NoNumber, /**< A number was expected in the PDF file, but the read string is no number. */
ePdfError_NoObject, /**< A object was expected and non was found. */
ePdfError_NoEOFToken, /**< The PDF file has no or an invalid EOF marker. */
ePdfError_InvalidTrailerSize, /**< The trailer size is invalid. */
ePdfError_InvalidLinearization, /**< The linearization directory of a web-optimized PDF file is invalid. */
ePdfError_InvalidDataType, /**< The passed datatype is invalid or was not recognized */
ePdfError_InvalidXRef, /**< The XRef table is invalid */
ePdfError_InvalidXRefStream, /**< A XRef steam is invalid */
ePdfError_InvalidXRefType, /**< The XRef type is invalid or was not found */
ePdfError_InvalidPredictor, /**< Invalid or unimplemented predictor */
ePdfError_InvalidStrokeStyle, /**< Invalid stroke style during drawing */
ePdfError_InvalidHexString, /**< Invalid hex string */
ePdfError_InvalidStream, /**< The stream is invalid */
ePdfError_InvalidStreamLength, /**< The stream length is invlaid */
ePdfError_InvalidKey, /**< The specified key is invalid */
ePdfError_InvalidName, /**< The specified Name is not valid in this context */
ePdfError_InvalidEncryptionDict, /**< The encryption dictionary is invalid or misses a required key */
ePdfError_InvalidPassword, /**< The password used to open the PDF file was invalid */
ePdfError_InvalidFontFile, /**< The font file is invalid */
ePdfError_InvalidContentStream, /**< The content stream is invalid due to mismatched context pairing or other problems */
ePdfError_UnsupportedFilter, /**< The requested filter is not yet implemented. */
ePdfError_UnsupportedFontFormat, /**< This font format is not supported by PoDoFO. */
ePdfError_ActionAlreadyPresent, /**< An Action was already present when trying to add a Destination */
ePdfError_WrongDestinationType, /**< The requested field is not available for the given destination type */
ePdfError_MissingEndStream, /**< The required token endstream was not found. */
ePdfError_Date, /**< Date/time error */
ePdfError_Flate, /**< Error in zlib */
ePdfError_FreeType, /**< Error in FreeType */
ePdfError_SignatureError, /**< Error in signature */
ePdfError_MutexError, /**< Error during a mutex operation */
ePdfError_UnsupportedImageFormat, /**< This image format is not supported by PoDoFO. */
ePdfError_CannotConvertColor, /**< This color format cannot be converted. */
ePdfError_NotImplemented, /**< This feature is currently not implemented. */
ePdfError_DestinationAlreadyPresent,/**< An destination was already present when trying to add a Action */
ePdfError_ChangeOnImmutable, /**< Changing values on immutable objects is not allowed. */
ePdfError_Unknown = 0xffff /**< Unknown error */
};
/**
* Used in PdfError::LogMessage to specify the log level.
*
* \see PdfError::LogMessage
*/
enum ELogSeverity {
eLogSeverity_Critical, /**< Critical unexpected error */
eLogSeverity_Error, /**< Error */
eLogSeverity_Warning, /**< Warning */
eLogSeverity_Information, /**< Information message */
eLogSeverity_Debug, /**< Debug information */
eLogSeverity_None, /**< No specified level */
eLogSeverity_Unknown = 0xffff /**< Unknown log level */
};
/** \def PODOFO_RAISE_ERROR( x )
*
* Set the value of the variable eCode (which has to exist in the current function) to x
* and return the eCode.
*/
#define PODOFO_RAISE_ERROR( x ) throw ::PoDoFo::PdfError( x, __FILE__, __LINE__ );
/** \def PODOFO_RAISE_ERROR_INFO( x, y )
*
* Set the value of the variable eCode (which has to exist in the current function) to x
* and return the eCode. Additionally additional information on the error y is set. y has
* to be an c-string.
*/
#define PODOFO_RAISE_ERROR_INFO( x, y ) throw ::PoDoFo::PdfError( x, __FILE__, __LINE__, y );
/** \def PODOFO_RAISE_LOGIC_IF( x, y )
*
* Evaluate `x' as a binary predicate and if it is true, raise a logic error with the
* info string `y' .
*
* This macro will be undefined when NDEBUG is set, so it's compiled out for release
* builds. Use it for expensive or extremely frequent sanity checking.
*
* We define it then UNDEF it to help out doxygen.
*/
#ifndef NDEBUG
// Woo for double-negatives. We define PODOFO_RAISE_LOGIC_IF unless we've been told not to by NDEBUG.
#define PODOFO_RAISE_LOGIC_IF( x, y ) { if (x) throw ::PoDoFo::PdfError( ePdfError_InternalLogic, __FILE__, __LINE__, y ); };
#else
#define PODOFO_RAISE_LOGIC_IF( x, y ) {};
#endif
class PODOFO_API PdfErrorInfo {
public:
PdfErrorInfo();
PdfErrorInfo( int line, const char* pszFile, const char* pszInfo );
PdfErrorInfo( int line, const char* pszFile, const wchar_t* pszInfo );
PdfErrorInfo( const PdfErrorInfo & rhs );
const PdfErrorInfo & operator=( const PdfErrorInfo & rhs );
inline int GetLine() const { return m_nLine; }
inline const std::string & GetFilename() const { return m_sFile; }
inline const std::string & GetInformation() const { return m_sInfo; }
inline const std::wstring & GetInformationW() const { return m_swInfo; }
inline void SetInformation( const char* pszInfo ) { m_sInfo = pszInfo ? pszInfo : ""; }
inline void SetInformation( const wchar_t* pszInfo ) { m_swInfo = pszInfo ? pszInfo : L""; }
private:
int m_nLine;
std::string m_sFile;
std::string m_sInfo;
std::wstring m_swInfo;
};
typedef std::deque<PdfErrorInfo> TDequeErrorInfo;
typedef TDequeErrorInfo::iterator TIDequeErrorInfo;
typedef TDequeErrorInfo::const_iterator TCIDequeErrorInfo;
// 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)
/** The error handling class of PoDoFo lib.
* Whenever a function encounters an error
* a PdfError object is returned.
*
* A PdfError with Error() == ErrOk means
* successfull execution.
*
* This class provides also meaningfull
* error descriptions.
*/
class PODOFO_EXCEPTION_API_DOXYGEN PdfError : public std::exception {
public:
// OC 17.08.2010 New to optionally replace stderr output by a callback:
class LogMessageCallback
{
public:
virtual ~LogMessageCallback() {} // every class with virtual methods needs a virtual destructor
virtual void LogMessage( ELogSeverity eLogSeverity, const char* pszPrefix, const char* pszMsg, va_list & args ) = 0;
virtual void LogMessage( ELogSeverity eLogSeverity, const wchar_t* pszPrefix, const wchar_t* pszMsg, va_list & args ) = 0;
};
/** Set a global static LogMessageCallback functor to repleace stderr output in LogMessageInternal
* \param fLogMessageCallback the pointer to the new callback functor object
* \returns the pointer to the previous callback functor object
*/
static LogMessageCallback* SetLogMessageCallback(LogMessageCallback* fLogMessageCallback);
/** Create a PdfError object initialized to ErrOk
*/
PdfError();
/** Create a PdfError object with a given error code.
* \param eCode the error code of this object
* \param pszFile the file in which the error has occured.
* Use the compiler macro __FILE__ to initialize the field.
* \param line the line in which the error has occured.
* Use the compiler macro __LINE__ to initialize the field.
* \param pszInformation additional information on this error which mayy
* be formatted like printf
*/
PdfError( const EPdfError & eCode, const char* pszFile = NULL, int line = 0,
const char* pszInformation = NULL );
/** Copy constructor
* \param rhs copy the contents of rhs into this object
*/
PdfError( const PdfError & rhs );
virtual ~PdfError() throw();
/** Assignment operator
* \param rhs another PdfError object
* \returns this object
*/
const PdfError & operator=( const PdfError & rhs );
/** Overloaded assignment operator
* \param eCode a EPdfError code
* \returns this object
*/
const PdfError & operator=( const EPdfError & eCode );
/** Comparison operator compares 2 PdfError objects
* \param rhs another PdfError object
* \returns true if both objects have the same error code.
*/
bool operator==( const PdfError & rhs );
/** Overloaded comparison operator compares 2 PdfError objects
* \param eCode an erroce code
* \returns true if this object has the same error code.
*/
bool operator==( const EPdfError & eCode );
/** Comparison operator compares 2 PdfError objects
* \param rhs another PdfError object
* \returns true if both objects have the different error code.
*/
bool operator!=( const PdfError & rhs );
/** Overloaded comparison operator compares 2 PdfError objects
* \param eCode an erroce code
* \returns true if this object has different error code.
*/
bool operator!=( const EPdfError & eCode );
/** Return the error code of this object
* \returns the error code of this object
*/
inline EPdfError GetError() const;
/** Get access to the internal callstack of this error
* \return the callstack
*/
inline const TDequeErrorInfo & GetCallstack() const;
/** Set the error code of this object.
* \param eCode the error code of this object
* \param pszFile the filename of the source file causing
* the error or NULL. Typically you will use
* the gcc macro __FILE__ here.
* \param line the line of source causing the error
* or 0. Typically you will use the gcc
* macro __LINE__ here.
* \param pszInformation additional information on the error.
* e.g. how to fix the error. This string is intended to
* be shown to the user.
*/
inline void SetError( const EPdfError & eCode, const char* pszFile = NULL, int line = 0, const char* pszInformation = NULL );
/** Set additional error informatiom
* \param pszInformation additional information on the error.
* e.g. how to fix the error. This string is intended to
* be shown to the user.
*/
inline void SetErrorInformation( const char* pszInformation );
/** Set additional error informatiom
* \param pszInformation additional information on the error.
* e.g. how to fix the error. This string is intended to
* be shown to the user.
*/
inline void SetErrorInformation( const wchar_t* pszInformation );
/** Add callstack information to an error object. Always call this function
* if you get an error object but do not handle the error but throw it again.
*
* \param pszFile the filename of the source file causing
* the error or NULL. Typically you will use
* the gcc macro __FILE__ here.
* \param line the line of source causing the error
* or 0. Typically you will use the gcc
* macro __LINE__ here.
* \param pszInformation additional information on the error.
* e.g. how to fix the error. This string is intended to
* be shown to the user.
*/
inline void AddToCallstack( const char* pszFile = NULL, int line = 0, const char* pszInformation = NULL );
/** \returns true if an error code was set
* and false if the error code is ePdfError_ErrOk
*/
inline bool IsError() const;
/** Print an error message to stderr
*/
void PrintErrorMsg() const;
/** Reimplemented from std::exception.
* \returns a c string describing the error.
* Annotated throw() in defiance of CODINGSTYLE.txt because we can't discard qualifiers on override.
*/
virtual const char* what() const throw();
/** Get the name for a certain error code.
* \returns the name or NULL if no name for the specified
* error code is available.
*/
PODOFO_NOTHROW static const char* ErrorName( EPdfError eCode );
/** Get the error message for a certain error code.
* \returns the error message or NULL if no error
* message for the specified error code
* is available.
*/
static const char* ErrorMessage( EPdfError eCode );
/** Log a message to the logging system defined for PoDoFo.
* \param eLogSeverity the sevirity of the log message
* \param pszMsg the message to be logged
*/
static void LogMessage( ELogSeverity eLogSeverity, const char* pszMsg, ... );
/** Log a message to the logging system defined for PoDoFo.
* \param eLogSeverity the sevirity of the log message
* \param pszMsg the message to be logged
*/
static void LogMessage( ELogSeverity eLogSeverity, const wchar_t* pszMsg, ... );
/** Enable or disable Logging
* \param bEnable enable (true) or disable (false)
*/
static void EnableLogging( bool bEnable ) { PdfError::s_LogEnabled = bEnable; }
/** Is the display of debugging messages enabled or not?
*/
static bool LoggingEnabled() { return PdfError::s_LogEnabled; }
/** Log a message to the logging system defined for PoDoFo for debugging
* \param pszMsg the message to be logged
*/
static void DebugMessage( const char* pszMsg, ... );
/** Enable or disable the display of debugging messages
* \param bEnable enable (true) or disable (false)
*/
static void EnableDebug( bool bEnable ) { PdfError::s_DgbEnabled = bEnable; }
/** Is the display of debugging messages enabled or not?
*/
static bool DebugEnabled() { return PdfError::s_DgbEnabled; }
private:
/** Log a message to the logging system defined for PoDoFo.
*
* This call does not check if logging is enabled and always
* prints the error message
*
* \param eLogSeverity the sevirity of the log message
* \param pszMsg the message to be logged
*/
static void LogErrorMessage( ELogSeverity eLogSeverity, const char* pszMsg, ... );
/** Log a message to the logging system defined for PoDoFo.
*
* This call does not check if logging is enabled and always
* prints the error message
*
* \param eLogSeverity the sevirity of the log message
* \param pszMsg the message to be logged
*/
static void LogErrorMessage( ELogSeverity eLogSeverity, const wchar_t* pszMsg, ... );
static void LogMessageInternal( ELogSeverity eLogSeverity, const char* pszMsg, va_list & args );
static void LogMessageInternal( ELogSeverity eLogSeverity, const wchar_t* pszMsg, va_list & args );
private:
EPdfError m_error;
TDequeErrorInfo m_callStack;
static bool s_DgbEnabled;
static bool s_LogEnabled;
// OC 17.08.2010 New to optionally replace stderr output by a callback:
static LogMessageCallback* m_fLogMessageCallback;
};
// -----------------------------------------------------
//
// -----------------------------------------------------
EPdfError PdfError::GetError() const
{
return m_error;
}
// -----------------------------------------------------
//
// -----------------------------------------------------
const TDequeErrorInfo & PdfError::GetCallstack() const
{
return m_callStack;
}
// -----------------------------------------------------
//
// -----------------------------------------------------
void PdfError::SetError( const EPdfError & eCode, const char* pszFile, int line, const char* pszInformation )
{
m_error = eCode;
this->AddToCallstack( pszFile, line, pszInformation );
}
// -----------------------------------------------------
//
// -----------------------------------------------------
void PdfError::AddToCallstack( const char* pszFile, int line, const char* pszInformation )
{
m_callStack.push_front( PdfErrorInfo( line, pszFile, pszInformation ) );
}
// -----------------------------------------------------
//
// -----------------------------------------------------
void PdfError::SetErrorInformation( const char* pszInformation )
{
if( m_callStack.size() )
m_callStack.front().SetInformation( pszInformation ? pszInformation : "" );
}
// -----------------------------------------------------
//
// -----------------------------------------------------
void PdfError::SetErrorInformation( const wchar_t* pszInformation )
{
if( m_callStack.size() )
m_callStack.front().SetInformation( pszInformation ? pszInformation : L"" );
}
// -----------------------------------------------------
//
// -----------------------------------------------------
bool PdfError::IsError() const
{
return (m_error != ePdfError_ErrOk);
}
};
#endif /* _PDF_ERROR_H_ */
|