KiCad PCB EDA Suite
Loading...
Searching...
No Matches
ki_exception.h
Go to the documentation of this file.
1/*
2 * This program source code file is part of KiCad, a free EDA CAD application.
3 *
4 * Copyright (C) 2007-2016 SoftPLC Corporation, Dick Hollenbeck <[email protected]>
5 * Copyright The KiCad Developers, see AUTHORS.txt for contributors.
6 *
7 * This program is free software; you can redistribute it and/or
8 * modify it under the terms of the GNU General Public License
9 * as published by the Free Software Foundation; either version 2
10 * of the License, or (at your option) any later version.
11 *
12 * This program is distributed in the hope that it will be useful,
13 * but WITHOUT ANY WARRANTY; without even the implied warranty of
14 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
15 * GNU General Public License for more details.
16 *
17 * You should have received a copy of the GNU General Public License
18 * along with this program. If not, see <https://www.gnu.org/licenses/>.
19 */
20
21#ifndef KI_EXCEPTION_H_
22#define KI_EXCEPTION_H_
23
24#include <kicommon.h>
25
26#include <string>
27
28#include <wx/string.h>
29
30
35
37#define THROW_IO_ERROR( msg ) throw IO_ERROR( msg, __FILE__, __FUNCTION__, __LINE__ )
38#define THROW_IO_ERRORF( msg, ... ) throw IO_ERROR( wxString::Format( msg, __VA_ARGS__ ), \
39 __FILE__, __FUNCTION__, __LINE__ )
40
45class KICOMMON_API KI_PARAM_ERROR // similar to std::invalid_argument for instance
46{
47public:
51 KI_PARAM_ERROR( const wxString& aMessage )
52 {
53 m_message = aMessage;
54 }
55
57
58 const wxString What() const
59 {
60 return m_message;
61 }
62
63 virtual ~KI_PARAM_ERROR() throw () {}
64
65private:
66 wxString m_message;
67};
68
69
76class KICOMMON_API IO_ERROR : public std::exception
77{
78public:
88 IO_ERROR( const wxString& aProblem, const char* aThrowersFile,
89 const char* aThrowersFunction, int aThrowersLineNumber )
90 {
91 init( aProblem, aThrowersFile, aThrowersFunction, aThrowersLineNumber );
92 }
93
94 IO_ERROR() = default;
95 ~IO_ERROR() throw() {}
96
97 void init( const wxString& aProblem, const char* aThrowersFile,
98 const char* aThrowersFunction, int aThrowersLineNumber );
99
100 virtual const wxString Problem() const;
101 virtual const wxString Where() const;
102
103 virtual const char* what() const throw() override;
104 virtual const wxString What() const;
105
106protected:
107 void updateWhat();
108
109 wxString problem;
110 wxString where;
112};
113
114
121{
122public:
128 IO_CANCELLED( const char* aThrowersFile, const char* aThrowersFunction, int aThrowersLineNumber,
129 const wxString& aProblem = wxEmptyString );
130};
131
132
133#define THROW_IO_CANCELLED() throw IO_CANCELLED( __FILE__, __FUNCTION__, __LINE__ )
134
135#define THROW_IO_CANCELLED_MSG( msg ) throw IO_CANCELLED( __FILE__, __FUNCTION__, __LINE__, msg )
136
137
146{
149
154 std::string inputLine;
155
160 PARSE_ERROR( const wxString& aProblem, const char* aThrowersFile,
161 const char* aThrowersFunction, int aThrowersLineNumber,
162 const wxString& aSource, const char* aInputLine,
163 int aLineNumber, int aByteIndex ) :
164 IO_ERROR()
165 {
166 init( aProblem, aThrowersFile, aThrowersFunction, aThrowersLineNumber,
167 aSource, aInputLine, aLineNumber, aByteIndex );
168 }
169
170 void init( const wxString& aProblem, const char* aThrowersFile,
171 const char* aThrowersFunction, int aThrowersLineNumber,
172 const wxString& aSource, const char* aInputLine,
173 int aLineNumber, int aByteIndex );
174
175 ~PARSE_ERROR() throw () {}
176
177 const wxString ParseProblem() { return parseProblem; }
178
179protected:
181 IO_ERROR(),
182 lineNumber( 0 ),
183 byteIndex( 0 )
184 {}
185
186protected:
187 wxString parseProblem;
188};
189
190
191#define THROW_PARSE_ERROR( aProblem, aSource, aInputLine, aLineNumber, aByteIndex ) \
192 throw PARSE_ERROR( aProblem, __FILE__, __FUNCTION__, __LINE__, aSource, aInputLine, \
193 aLineNumber, aByteIndex )
194
195
202{
205
206 FUTURE_FORMAT_ERROR( const wxString& aRequiredVersion,
207 const wxString& aRequiredGenerator = wxEmptyString );
208 FUTURE_FORMAT_ERROR( const PARSE_ERROR& aParseError, const wxString& aRequiredVersion,
209 const wxString& aRequiredGenerator = wxEmptyString );
211
212 void init( const wxString& aRequiredVersion,
213 const wxString& aRequiredGenerator = wxEmptyString );
214};
215
217
218#endif // KI_EXCEPTION_H_
IO_CANCELLED(const char *aThrowersFile, const char *aThrowersFunction, int aThrowersLineNumber, const wxString &aProblem=wxEmptyString)
Normally thrown via the macro THROW_IO_CANCELLED(), which supplies the call-site file,...
void init(const wxString &aProblem, const char *aThrowersFile, const char *aThrowersFunction, int aThrowersLineNumber)
IO_ERROR(const wxString &aProblem, const char *aThrowersFile, const char *aThrowersFunction, int aThrowersLineNumber)
Use macro THROW_IO_ERROR() to wrap a call to this constructor at the call site.
wxString problem
wxString where
IO_ERROR()=default
std::string whatMessage
KI_PARAM_ERROR(const wxString &aMessage)
Constructor.
const wxString What() const
virtual ~KI_PARAM_ERROR()
wxString m_message
#define KICOMMON_API
Definition kicommon.h:27
STL namespace.
wxString requiredGenerator
Version of KiCad required to open file.
FUTURE_FORMAT_ERROR(const wxString &aRequiredVersion, const wxString &aRequiredGenerator=wxEmptyString)
wxString requiredVersion
Date of KiCad file format required to open file.
int lineNumber
at which line number, 1 based index.
const wxString ParseProblem()
wxString parseProblem
std::string inputLine
problem line of input [say, from a LINE_READER].
PARSE_ERROR(const wxString &aProblem, const char *aThrowersFile, const char *aThrowersFunction, int aThrowersLineNumber, const wxString &aSource, const char *aInputLine, int aLineNumber, int aByteIndex)
Normally called via the macro THROW_PARSE_ERROR so that FILE, FUNCTION, and LINE can be captured from...
int byteIndex
at which byte offset within the line, 1 based index
void init(const wxString &aProblem, const char *aThrowersFile, const char *aThrowersFunction, int aThrowersLineNumber, const wxString &aSource, const char *aInputLine, int aLineNumber, int aByteIndex)