exception.hpp

//
// libsemigroups - C++ library for semigroups and monoids
// Copyright (C) 2019-2025 James D. Mitchell
//
// 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 LIBSEMIGROUPS_EXCEPTION_HPP_
#define LIBSEMIGROUPS_EXCEPTION_HPP_
 
#include <exception>
#include <stdexcept>  // for std::runtime_error
#include <string>     // for std::string
 
#include "detail/fmt.hpp"
#include "detail/formatters.hpp"
 
namespace libsemigroups {

  struct LibsemigroupsException : public std::runtime_error {
    LibsemigroupsException(std::string const& fname,
                           int                linenum,
                           std::string const& funcname,
                           std::string const& msg);

    LibsemigroupsException(LibsemigroupsException const&) = default;

    LibsemigroupsException(LibsemigroupsException&&) = default;

    LibsemigroupsException& operator=(LibsemigroupsException const&) = default;

    LibsemigroupsException& operator=(LibsemigroupsException&&) = default;
 
    ~LibsemigroupsException() = default;
  };
}  // namespace libsemigroups

#define LIBSEMIGROUPS_EXCEPTION(...)                             \
  {                                                              \
    throw LibsemigroupsException(                                \
        __FILE__, __LINE__, __func__, fmt::format(__VA_ARGS__)); \
  }
 
#endif  // LIBSEMIGROUPS_EXCEPTION_HPP_