/*
    Ousía
    Copyright (C) 2014, 2015  Benjamin Paaßen, Andreas Stöckel

    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/>.
*/

/**
 * @file Exceptions.hpp
 *
 * Describes basic exception classes which are used throughout Ousía.
 *
 * @author Andreas Stöckel (astoecke@techfak.uni-bielefeld.de)
 */

#ifndef _OUSIA_EXCEPTIONS_HPP_
#define _OUSIA_EXCEPTIONS_HPP_

#include "Location.hpp"

namespace ousia {

/**
 * Base exception class all other Ousía exceptions should derive from.
 */
class OusiaException : public std::exception {
private:
	/**
	 * Error message which will be printed by the runtime environment if the
	 * exception is not caught and handled in the code.
	 */
	const std::string formatedMessage;

public:
	/**
	 * Constructor of the OusiaException class.
	 *
	 * @param formatedMessage is a formated message that should be printed by
	 * the runtime environment if the exception is not caught.
	 */
	OusiaException(std::string formatedMessage)
	    : formatedMessage(std::move(formatedMessage))
	{
	}

	/**
	 * Virtual destructor.
	 */
	virtual ~OusiaException() {}

	/**
	 * Implementation of the std::exception what function and used to retrieve
	 * the error message that should be printed by the runtime environment.
	 *
	 * @return a reference to the formated message string given in the
	 * constructor.
	 */
	const char *what() const noexcept override
	{
		return formatedMessage.c_str();
	}
};

/**
 * Exception class which can be directly passed to a Logger instance and thus
 * makes it simple to handle non-recoverable errors in the code.
 */
class LoggableException : public OusiaException {
public:
	/**
	 * Reported error message.
	 */
	const std::string msg;

	/**
	 * Position in the document at which the exception occurred.
	 */
	const SourceLocation loc;

	/**
	 * Constructor of the LoggableException class.
	 *
	 * @param msg contains the error message.
	 * @param loc is the position at which the error occured.
	 */
	LoggableException(std::string msg,
	                  SourceLocation loc = SourceLocation{})
	    : OusiaException(msg),
	      msg(std::move(msg)),
	      loc(std::move(loc))
	{
	}

	/**
	 * Constructor of LoggableException for arbitrary position objects.
	 *
	 * @param msg is the actual log message.
	 * @param loc is a reference to a variable with location data.
	 */
	template <class LocationType>
	LoggableException(std::string msg, LocationType loc)
	    : LoggableException(std::move(msg), SourceLocation::location(loc))
	{
	}

	/**
	 * Returns the position at which the exception occured in the text.
	 *
	 * @return the position descriptor.
	 */
	const SourceLocation& getLocation() const { return loc; }
};

}

#endif /* _OUSIA_EXCEPTIONS_HPP_ */