include/poppler/Error.h

0001 //========================================================================
0002 //
0003 // Error.h
0004 //
0005 // Copyright 1996-2003 Glyph & Cog, LLC
0006 //
0007 //========================================================================
0008
0009 //========================================================================
0010 //
0011 // Modified under the Poppler project - http://poppler.freedesktop.org
0012 //
0013 // All changes made under the Poppler project to this file are licensed
0014 // under GPL version 2 or later
0015 //
0016 // Copyright (C) 2005, 2007 Jeff Muizelaar <jeff@infidigm.net>
0017 // Copyright (C) 2005, 2018 Albert Astals Cid <aacid@kde.org>
0018 // Copyright (C) 2005 Kristian Høgsberg <krh@redhat.com>
0019 // Copyright (C) 2013 Adrian Johnson <ajohnson@redneon.com>
0020 // Copyright (C) 2014 Fabio D'Urso <fabiodurso@hotmail.it>
0021 // Copyright (C) 2020 Adam Reichold <adam.reichold@t-online.de>
0022 //
0023 // To see a description of the changes please see the Changelog file that
0024 // came with your tarball or type make ChangeLog if you are building from git
0025 //
0026 //========================================================================
0027
0028 #ifndef ERROR_H
0029 #define ERROR_H
0030
0031 #include <cstdarg>
0032 #include "poppler-config.h"
0033 #include "poppler_private_export.h"
0034 #include "goo/gfile.h"
0035 #include "goo/GooString.h"
0036
0037 enum ErrorCategory
0038 {
0039     errSyntaxWarning, // PDF syntax error which can be worked around;
0040                       //   output will probably be correct
0041     errSyntaxError, // PDF syntax error which can be worked around;
0042                     //   output will probably be incorrect
0043     errConfig, // error in Xpdf config info (xpdfrc file, etc.)
0044     errCommandLine, // error in user-supplied parameters, action not
0045                     //   allowed, etc. (only used by command-line tools)
0046     errIO, // error in file I/O
0047     errNotAllowed, // action not allowed by PDF permission bits
0048     errUnimplemented, // unimplemented PDF feature - display will be
0049                       //   incorrect
0050     errInternal // internal error - malfunction within the Xpdf code
0051 };
0052
0053 using ErrorCallback = void (*)(ErrorCategory category, Goffset pos, const char *msg);
0054
0055 extern void POPPLER_PRIVATE_EXPORT setErrorCallback(ErrorCallback cbk);
0056
0057 extern void CDECL POPPLER_PRIVATE_EXPORT error(ErrorCategory category, Goffset pos, const char *msg, ...) GOOSTRING_FORMAT;
0058
0059 #endif