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
|
/*
* This program source code file is part of KiCad, a free EDA CAD application.
*
* Copyright (C) 2007-2016 SoftPLC Corporation, Dick Hollenbeck <dick@softplc.com>
* Copyright The KiCad Developers, see AUTHORS.txt for contributors.
*
* This program is free software; you can redistribute it and/or
* modify it under the terms of the GNU 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 General Public License
* along with this program; if not, you may find one here:
* http://www.gnu.org/licenses/old-licenses/gpl-2.0.html
* or you may search the http://www.gnu.org website for the version 2 license,
* or you may write to the Free Software Foundation, Inc.,
* 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301, USA
*/
#ifndef KI_EXCEPTION_H_
#define KI_EXCEPTION_H_
#include <kicommon.h>
#include <wx/string.h>
/**
* @ingroup exception_types
* @{
*/
/// macro which captures the "call site" values of __FILE_, __FUNCTION__ & __LINE__
#define THROW_IO_ERROR( msg ) throw IO_ERROR( msg, __FILE__, __FUNCTION__, __LINE__ )
/**
* Hold a translatable error message and may be used when throwing exceptions containing a
* translated error message.
*/
class KICOMMON_API KI_PARAM_ERROR // similar to std::invalid_argument for instance
{
public:
/**
* Constructor
*/
KI_PARAM_ERROR( const wxString& aMessage )
{
m_message = aMessage;
}
KI_PARAM_ERROR() {}
const wxString What() const
{
return m_message;
}
virtual ~KI_PARAM_ERROR() throw () {}
private:
wxString m_message;
};
/**
* Hold an error message and may be used when throwing exceptions containing meaningful
* error messages.
*
* @author Dick Hollenbeck
*/
class KICOMMON_API IO_ERROR // : std::exception
{
public:
/**
* Use macro #THROW_IO_ERROR() to wrap a call to this constructor at the call site.
*
* @param aProblem is Problem() text.
* @param aThrowersFile is the __FILE__ preprocessor macro but generated at the source
* file of thrower.
* @param aThrowersFunction is the function name at the throw site.
* @param aThrowersLineNumber is the source code line number of the throw.
*/
IO_ERROR( const wxString& aProblem, const char* aThrowersFile,
const char* aThrowersFunction, int aThrowersLineNumber )
{
init( aProblem, aThrowersFile, aThrowersFunction, aThrowersLineNumber );
}
IO_ERROR() {}
void init( const wxString& aProblem, const char* aThrowersFile,
const char* aThrowersFunction, int aThrowersLineNumber );
virtual const wxString Problem() const; ///< what was the problem?
virtual const wxString Where() const; ///< where did the Problem() occur?
virtual const wxString What() const; ///< A composite of Problem() and Where()
virtual ~IO_ERROR() throw () {}
protected:
wxString problem;
wxString where;
};
/**
* A filename or source description, a problem input line, a line number, a byte
* offset, and an error message which contains the caller's report and his call
* site information: CPP source file, function, and line number.
*
* @author Dick Hollenbeck
*/
struct KICOMMON_API PARSE_ERROR : public IO_ERROR
{
int lineNumber; ///< at which line number, 1 based index.
int byteIndex; ///< at which byte offset within the line, 1 based index
/// problem line of input [say, from a LINE_READER].
/// this is brought up in original byte format rather than wxString form, in case
/// there was a problem with the encoding, in which case converting to wxString is
/// not reliable in this context.
std::string inputLine;
/**
* Normally called via the macro #THROW_PARSE_ERROR so that __FILE__, __FUNCTION__,
* and __LINE__ can be captured from the call site.
*/
PARSE_ERROR( const wxString& aProblem, const char* aThrowersFile,
const char* aThrowersFunction, int aThrowersLineNumber,
const wxString& aSource, const char* aInputLine,
int aLineNumber, int aByteIndex ) :
IO_ERROR()
{
init( aProblem, aThrowersFile, aThrowersFunction, aThrowersLineNumber,
aSource, aInputLine, aLineNumber, aByteIndex );
}
void init( const wxString& aProblem, const char* aThrowersFile,
const char* aThrowersFunction, int aThrowersLineNumber,
const wxString& aSource, const char* aInputLine,
int aLineNumber, int aByteIndex );
~PARSE_ERROR() throw () {}
const wxString ParseProblem() { return parseProblem; }
protected:
PARSE_ERROR() :
IO_ERROR(),
lineNumber( 0 ),
byteIndex( 0 )
{}
protected:
wxString parseProblem;
};
#define THROW_PARSE_ERROR( aProblem, aSource, aInputLine, aLineNumber, aByteIndex ) \
throw PARSE_ERROR( aProblem, __FILE__, __FUNCTION__, __LINE__, aSource, aInputLine, \
aLineNumber, aByteIndex )
/**
* Variant of #PARSE_ERROR indicating that a syntax or related error was likely caused
* by a file generated by a newer version of KiCad than this. This can be used to generate
* more informative error messages.
*/
struct KICOMMON_API FUTURE_FORMAT_ERROR : public PARSE_ERROR
{
wxString requiredVersion; ///< Date of KiCad file format required to open file
wxString requiredGenerator; ///< Version of KiCad required to open file
FUTURE_FORMAT_ERROR( const wxString& aRequiredVersion,
const wxString& aRequiredGenerator = wxEmptyString );
FUTURE_FORMAT_ERROR( const PARSE_ERROR& aParseError, const wxString& aRequiredVersion,
const wxString& aRequiredGenerator = wxEmptyString );
~FUTURE_FORMAT_ERROR() throw () {}
void init( const wxString& aRequiredVersion,
const wxString& aRequiredGenerator = wxEmptyString );
};
/** @} exception_types */
#endif // KI_EXCEPTION_H_
|
