Browse Source
Split IO_ERROR out of richio.* and store Problem() and Where() separately
pull/3/merge
Split IO_ERROR out of richio.* and store Problem() and Where() separately
pull/3/merge
Dick Hollenbeck
9 years ago
committed by
Wayne Stambaugh
Wayne Stambaugh
47 changed files with 394 additions and 362 deletions
-
100common/exceptions.cpp
-
6common/page_layout/page_layout_reader.cpp
-
33common/richio.cpp
-
93common/single_top.cpp
-
2cvpcb/class_DisplayFootprintsFrame.cpp
-
2cvpcb/cvpcb.cpp
-
6cvpcb/cvpcb_mainframe.cpp
-
2cvpcb/readwrite_dlgs.cpp
-
4eeschema/class_library.cpp
-
2eeschema/cross-probing.cpp
-
6eeschema/eeschema_config.cpp
-
4eeschema/files-io.cpp
-
2eeschema/netlist_exporters/netlist_exporter_kicad.cpp
-
2eeschema/plot_schematic_DXF.cpp
-
2eeschema/plot_schematic_HPGL.cpp
-
2eeschema/plot_schematic_PDF.cpp
-
2eeschema/plot_schematic_PS.cpp
-
2eeschema/plot_schematic_SVG.cpp
-
4eeschema/schframe.cpp
-
2eeschema/symbedit.cpp
-
156include/ki_exception.h
-
170include/richio.h
-
62kicad/kicad.cpp
-
8kicad/mainframe.cpp
-
4pagelayout_editor/page_layout_writer.cpp
-
2pcb_calculator/datafile_read_write.cpp
-
2pcbnew/append_board_to_current.cpp
-
2pcbnew/basepcbframe.cpp
-
2pcbnew/dialogs/dialog_fp_lib_table.cpp
-
2pcbnew/dialogs/dialog_netlist.cpp
-
2pcbnew/dialogs/dialog_update_pcb.cpp
-
2pcbnew/dialogs/wizard_add_fplib.cpp
-
2pcbnew/exporters/export_idf.cpp
-
6pcbnew/files.cpp
-
2pcbnew/github/github_getliblist.cpp
-
4pcbnew/github/github_plugin.cpp
-
18pcbnew/librairi.cpp
-
8pcbnew/loadcmp.cpp
-
4pcbnew/moduleframe.cpp
-
2pcbnew/modview_frame.cpp
-
2pcbnew/netlist.cpp
-
2pcbnew/pcbnew.cpp
-
4pcbnew/pcbnew_config.cpp
-
4pcbnew/specctra_export.cpp
-
2pcbnew/specctra_import.cpp
-
2pcbnew/specctra_test.cpp
-
2pcbnew/tools/pcbnew_control.cpp
@ -0,0 +1,100 @@ |
|||
/*
|
|||
* 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 (C) 2016 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 |
|||
*/ |
|||
|
|||
#include <wx/wx.h>
|
|||
#include <ki_exception.h>
|
|||
|
|||
|
|||
#define THROWERS_WHERE _( "from %s : %s() line:%d" )
|
|||
#define PARSE_PROBLEM _( "%s in input/source\n'%s'\nline %d" )
|
|||
|
|||
|
|||
const wxString IO_ERROR::What() const |
|||
{ |
|||
return wxString( "IO_ERROR: " ) + Problem() + "\n\t" + Where(); |
|||
} |
|||
|
|||
|
|||
const wxString IO_ERROR::Where() const |
|||
{ |
|||
return where; |
|||
} |
|||
|
|||
|
|||
const wxString IO_ERROR::Problem() const |
|||
{ |
|||
return problem; |
|||
} |
|||
|
|||
|
|||
|
|||
void IO_ERROR::init( const wxString& aProblem, const char* aThrowersFile, const char* aThrowersFunction, int aThrowersLineNumber ) |
|||
{ |
|||
problem = aProblem; |
|||
|
|||
// The throwers filename is a full filename, depending on Kicad source location.
|
|||
// a short filename will be printed (it is better for user, the full filename has no meaning).
|
|||
wxString srcname = aThrowersFile; |
|||
|
|||
where.Printf( THROWERS_WHERE, srcname.AfterLast( '/' ).GetData(), |
|||
wxString( aThrowersFunction ).GetData(), aThrowersLineNumber ); |
|||
} |
|||
|
|||
|
|||
void PARSE_ERROR::init( const wxString& aProblem, const char* aThrowersFile, |
|||
const char* aThrowersFunction, int aThrowersLineNumber, |
|||
const wxString& aSource, |
|||
const char* aInputLine, |
|||
int aLineNumber, int aByteIndex ) |
|||
{ |
|||
problem.Printf( PARSE_PROBLEM, aProblem.GetData(), aSource.GetData(), aLineNumber, aByteIndex ); |
|||
|
|||
inputLine = aInputLine; |
|||
lineNumber = aLineNumber; |
|||
byteIndex = aByteIndex; |
|||
|
|||
// The throwers filename is a full filename, depending on Kicad source location.
|
|||
// a short filename will be printed (it is better for user, the full filename has no meaning).
|
|||
wxString srcname = aThrowersFile; |
|||
|
|||
where.Printf( THROWERS_WHERE, srcname.AfterLast( '/' ).GetData(), |
|||
wxString( aThrowersFunction ).GetData(), aThrowersLineNumber ); |
|||
} |
|||
|
|||
|
|||
FUTURE_FORMAT_ERROR::FUTURE_FORMAT_ERROR( const PARSE_ERROR& aParseError, const wxString& aRequiredVersion ) : |
|||
PARSE_ERROR(), requiredVersion( aRequiredVersion ) |
|||
{ |
|||
problem.Printf( _( |
|||
"KiCad was unable to open this file, as it was created with a more " |
|||
"recent version than the one you are running. To open it, you'll need " |
|||
"to upgrade KiCad to a more recent version.\n\n" |
|||
"Date of KiCad version required (or newer): %s\n\n" |
|||
"Full error text:\n%s" ), |
|||
requiredVersion, aParseError.Problem() ); |
|||
|
|||
lineNumber = aParseError.lineNumber; |
|||
byteIndex = aParseError.byteIndex; |
|||
inputLine = aParseError.inputLine; |
|||
} |
|||
@ -0,0 +1,156 @@ |
|||
/* |
|||
* 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 (C) 2016 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 <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__ ) |
|||
|
|||
|
|||
/** |
|||
* Struct IO_ERROR |
|||
* is a class used to hold an error message and may be used when throwing exceptions |
|||
* containing meaningful error messages. |
|||
* @author Dick Hollenbeck |
|||
*/ |
|||
class IO_ERROR // : std::exception |
|||
{ |
|||
public: |
|||
/** |
|||
* Constructor |
|||
* |
|||
* @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. |
|||
* |
|||
* Use macro THROW_IO_ERROR() to wrap a call to this constructor at the call site. |
|||
*/ |
|||
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; |
|||
}; |
|||
|
|||
|
|||
#ifndef SWIG |
|||
/** |
|||
* Struct PARSE_ERROR |
|||
* contains a filename or source description, a problem input line, a line number, |
|||
* a byte offset, and an error message which contains the the caller's report and his |
|||
* call site information: CPP source file, function, and line number. |
|||
* @author Dick Hollenbeck |
|||
*/ |
|||
struct 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, incase |
|||
/// there was a problem with the encoding, in which case converting to wxString is |
|||
/// not reliable in this context. |
|||
std::string inputLine; |
|||
|
|||
/** |
|||
* Constructor |
|||
* which is normally called via the macro THROW_PARSE_ERROR so that |
|||
* __FILE__ and __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 () {} |
|||
|
|||
protected: |
|||
PARSE_ERROR(): IO_ERROR(), lineNumber( 0 ), byteIndex( 0 ) {} |
|||
}; |
|||
|
|||
|
|||
#define THROW_PARSE_ERROR( aProblem, aSource, aInputLine, aLineNumber, aByteIndex ) \ |
|||
throw PARSE_ERROR( aProblem, __FILE__, __FUNCTION__, __LINE__, aSource, aInputLine, aLineNumber, aByteIndex ) |
|||
|
|||
|
|||
/** |
|||
* Struct FUTURE_FORMAT_ERROR |
|||
* 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. Can be used to generate |
|||
* more informative error messages. |
|||
*/ |
|||
struct FUTURE_FORMAT_ERROR : public PARSE_ERROR |
|||
{ |
|||
wxString requiredVersion; ///< version or date of KiCad required to open file |
|||
|
|||
FUTURE_FORMAT_ERROR( const PARSE_ERROR& aParseError, const wxString& aRequiredVersion ); |
|||
~FUTURE_FORMAT_ERROR() throw () {} |
|||
}; |
|||
|
|||
#endif // SWIG |
|||
|
|||
/** @} exception_types */ |
|||
|
|||
#endif // KI_EXCEPTION_H_ |
|||
Write
Preview
Loading…
Cancel
Save
Reference in new issue