exceptions.h

Go to the documentation of this file.

/*
 * LibrePCB - Professional EDA for everyone!
 * Copyright (C) 2013 LibrePCB Developers, see AUTHORS.md for contributors.
 * https://librepcb.org/
 *
 * 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 3 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 <http://www.gnu.org/licenses/>.
 */

#ifndef LIBREPCB_CORE_EXCEPTIONS_H
#define LIBREPCB_CORE_EXCEPTIONS_H

/*******************************************************************************
 *  Includes
 ******************************************************************************/
#include <QtCore>

/*******************************************************************************
 *  Namespace / Forward Declarations
 ******************************************************************************/
namespace librepcb {

class FilePath;

/*******************************************************************************
 *  Class Exception
 ******************************************************************************/

class Exception : public QException {
public:
  // Constructors / Destructor

  Exception() = delete;

  Exception(const Exception& other) noexcept;

  Exception(const char* file, int line,
            const QString& msg = QString("Exception")) noexcept;

  virtual ~Exception() noexcept {}

  // Getters

  const QString& getMsg() const { return mMsg; }

  const QString& getFile() const { return mFile; }

  int getLine() const { return mLine; }

  const char* what() const noexcept override;

  // Inherited from QException (see QException documentation for more details)
  virtual void raise() const override { throw *this; }
  virtual Exception* clone() const override { return new Exception(*this); }

private:
  // Attributes
  QString mMsg;  
  QString mFile;  
  int mLine;  

  // Cached Attributes
  mutable QByteArray mMsgUtf8;  
};

/*******************************************************************************
 *  Class LogicError
 ******************************************************************************/

class LogicError final : public Exception {
public:
  LogicError() = delete;

  LogicError(const char* file, int line,
             const QString& msg = QString("Logic Error")) noexcept;

  LogicError(const LogicError& other) noexcept;

  // Inherited from Exception
  virtual void raise() const override { throw *this; }
  virtual LogicError* clone() const override { return new LogicError(*this); }
};

/*******************************************************************************
 *  Class RuntimeError
 ******************************************************************************/

class RuntimeError : public Exception {
public:
  RuntimeError() = delete;

  RuntimeError(const char* file, int line,
               const QString& msg = QString("Runtime Error")) noexcept;

  RuntimeError(const RuntimeError& other) noexcept;

  virtual ~RuntimeError() noexcept {}

  // Inherited from Exception
  virtual void raise() const override { throw *this; }
  virtual RuntimeError* clone() const override {
    return new RuntimeError(*this);
  }
};

/*******************************************************************************
 *  Class RangeError
 ******************************************************************************/

class RangeError final : public RuntimeError {
public:
  RangeError() = delete;

  RangeError(const char* file, int line,
             const QString& msg = QString("Range Error")) noexcept;

  template <typename Tval, typename Tmin, typename Tmax>
  RangeError(const char* file, int line, const Tval& value, const Tmin& min,
             const Tmax& max) noexcept
    : RangeError(file, line,
                 QString("Range error: %1 not in [%2..%3]")
                     .arg(value)
                     .arg(min)
                     .arg(max)) {}

  RangeError(const RangeError& other) noexcept;

  // Inherited from RuntimeError
  virtual void raise() const override { throw *this; }
  virtual RangeError* clone() const override { return new RangeError(*this); }
};

/*******************************************************************************
 *  Class FileParseError
 ******************************************************************************/

class FileParseError final : public RuntimeError {
public:
  FileParseError() = delete;

  FileParseError(const char* file, int line, const FilePath& filePath,
                 int fileLine = -1, int fileColumn = -1,
                 const QString& invalidFileContent = QString(),
                 const QString& msg = QString("File Parse Error")) noexcept;

  FileParseError(const FileParseError& other) noexcept;

  // Inherited from RuntimeError
  virtual void raise() const override { throw *this; }
  virtual FileParseError* clone() const override {
    return new FileParseError(*this);
  }
};

/*******************************************************************************
 *  Class UserCanceled
 ******************************************************************************/

class UserCanceled final : public Exception {
public:
  UserCanceled() = delete;

  UserCanceled(const char* file, int line,
               const QString& msg = QString("User Canceled")) noexcept;

  UserCanceled(const UserCanceled& other) noexcept;

  // Inherited from Exception
  virtual void raise() const override { throw *this; }
  virtual UserCanceled* clone() const override {
    return new UserCanceled(*this);
  }
};

/*******************************************************************************
 *  End of File
 ******************************************************************************/

}  // namespace librepcb

#endif