GDAL

cpl_error_internal.h
1/**********************************************************************
2 * $Id$
3 *
4 * Name: cpl_error_internal.h
5 * Project: CPL - Common Portability Library
6 * Purpose: CPL Error handling
7 * Author: Even Rouault, <even.rouault at spatialys.com>
8 *
9 **********************************************************************
10 * Copyright (c) 2019, Even Rouault, <even.rouault at spatialys.com>
11 *
12 * Permission is hereby granted, free of charge, to any person obtaining a
13 * copy of this software and associated documentation files (the "Software"),
14 * to deal in the Software without restriction, including without limitation
15 * the rights to use, copy, modify, merge, publish, distribute, sublicense,
16 * and/or sell copies of the Software, and to permit persons to whom the
17 * Software is furnished to do so, subject to the following conditions:
18 *
19 * The above copyright notice and this permission notice shall be included
20 * in all copies or substantial portions of the Software.
21 *
22 * THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
23 * IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
24 * FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL
25 * THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
26 * LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING
27 * FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER
28 * DEALINGS IN THE SOFTWARE.
29 ****************************************************************************/
30
31#ifndef CPL_ERROR_INTERNAL_H_INCLUDED
32#define CPL_ERROR_INTERNAL_H_INCLUDED
33
34#ifdef GDAL_COMPILATION
35// internal only
36
37#include "cpl_error.h"
38#include "cpl_string.h"
39#include <vector>
40
41/************************************************************************/
42/* ErrorHandlerAccumulator() */
43/************************************************************************/
44
45 class CPL_DLL CPLErrorHandlerAccumulatorStruct
46{
47 public:
48 CPLErr type;
49 CPLErrorNum no;
50 CPLString msg{};
51
52 CPLErrorHandlerAccumulatorStruct() : type(CE_None), no(CPLE_None)
53 {
54 }
55
56 CPLErrorHandlerAccumulatorStruct(CPLErr eErrIn, CPLErrorNum noIn,
57 const char *msgIn)
58 : type(eErrIn), no(noIn), msg(msgIn)
59 {
60 }
61};
62
63 void CPL_DLL CPLInstallErrorHandlerAccumulator(
64 std::vector<CPLErrorHandlerAccumulatorStruct> &aoErrors);
65 void CPL_DLL CPLUninstallErrorHandlerAccumulator();
66
67#endif
68
69#endif // CPL_ERROR_INTERNAL_H_INCLUDED
CPLString
Convenient string class based on std::string.
Definition cpl_string.h:320
cpl_error.h
CPL error handling services.
CPLE_None
#define CPLE_None
No error.
Definition cpl_error.h:98
CPLErr
CPLErr
Error category.
Definition cpl_error.h:53
CPLErrorNum
int CPLErrorNum
Error number.
Definition cpl_error.h:95
cpl_string.h
Various convenience functions for working with strings and string lists.