ki_exception.h

Go to the documentation of this file.

/*
 * This program source code file is part of KiCad, a free EDA CAD application.
 *
 * Copyright (C) 2007-2016 SoftPLC Corporation, Dick Hollenbeck <[email protected]>
 * Copyright (C) 2016-2020 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>


#define THROW_IO_ERROR( msg ) throw IO_ERROR( msg, __FILE__, __FUNCTION__, __LINE__ )

class KI_PARAM_ERROR // similar to std::invalid_argument for instance
{
public:
 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;
};


class IO_ERROR // : std::exception
{
public:
 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; 
 virtual const wxString Where() const; 

 virtual const wxString What() const; 

 virtual ~IO_ERROR() throw () {}

protected:
 wxString problem;
 wxString where;
};


struct PARSE_ERROR : public IO_ERROR
{
 int lineNumber; 
 int byteIndex; 

 std::string inputLine;

 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 )


struct FUTURE_FORMAT_ERROR : public PARSE_ERROR
{
 wxString requiredVersion; 

 FUTURE_FORMAT_ERROR( const wxString& aRequiredVersion );
 FUTURE_FORMAT_ERROR( const PARSE_ERROR& aParseError, const wxString& aRequiredVersion );
 ~FUTURE_FORMAT_ERROR() throw () {}

 void init( const wxString& aRequiredVersion );
};

#endif // KI_EXCEPTION_H_