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 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, see <https://www.gnu.org/licenses/>.
 */
 
#ifndef KI_EXCEPTION_H_
#define KI_EXCEPTION_H_
 
#include <kicommon.h>
 
#include <wx/string.h>
 


#define THROW_IO_ERROR( msg )   throw IO_ERROR( msg, __FILE__, __FUNCTION__, __LINE__ )
#define THROW_IO_ERRORF( msg, ... )   throw IO_ERROR( wxString::Format( msg, __VA_ARGS__ ), \
                                                      __FILE__, __FUNCTION__, __LINE__ )

class KICOMMON_API 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 KICOMMON_API IO_ERROR : public std::exception
{
public:
    IO_ERROR( const wxString& aProblem, const char* aThrowersFile,
              const char* aThrowersFunction, int aThrowersLineNumber )
    {
        init( aProblem, aThrowersFile, aThrowersFunction, aThrowersLineNumber );
    }
 
    IO_ERROR() = default;
    ~IO_ERROR() throw() {}
 
    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 char*    what() const throw() override; 
    virtual const wxString What() const;            
 
protected:
    wxString    problem;
    wxString    where;
};
 

class KICOMMON_API IO_CANCELLED : public IO_ERROR
{
public:
    IO_CANCELLED( const char* aThrowersFile, const char* aThrowersFunction, int aThrowersLineNumber,
                  const wxString& aProblem = wxEmptyString );
};
 
 
#define THROW_IO_CANCELLED() throw IO_CANCELLED( __FILE__, __FUNCTION__, __LINE__ )
 
#define THROW_IO_CANCELLED_MSG( msg ) throw IO_CANCELLED( __FILE__, __FUNCTION__, __LINE__, msg )
 

struct KICOMMON_API 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 KICOMMON_API FUTURE_FORMAT_ERROR : public PARSE_ERROR
{
    wxString requiredVersion;   
    wxString requiredGenerator; 
 
    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 );
};

 
#endif // KI_EXCEPTION_H_