#ifndef SIMULATOR_EXCEPTION_H
#define SIMULATOR_EXCEPTION_H

#include <exception>
#include <qstring.h>

namespace machine {

// Base exception for all machine ones
class SimulatorException : public std::exception {
public:
    SimulatorException(QString reason, QString ext, QString file, int line);
    const char *what() const noexcept override;
    QString msg(bool pos) const;

protected:
    QString name, reason, ext, file;
    int line;
};

/* This is list of all QtMips specific exceptions
 *
 * Input:
 *  Exception durring input loading
 * Runtime:
 *  Exceptions caused by machine invalid input or unsupported action
 * UnsupportedInstruction:
 *  Decoded instruction is not supported.
 *  This can be cause by really using some unimplemented instruction or because
 * of problems in instruction decode. UnsupportedAluOperation: Decoded ALU
 * operation is not supported This is basically same exception as
 * SimulatorExceptionUnsupportedInstruction but it is emmited from ALU when
 * executed and not before that. Overflow: Integer operation resulted to
 * overflow (or underflow as we are working with unsigned values) This is for
 * sure caused by program it self. UnalignedJump: Instruction is jumping to
 * unaligned address (ADDR % 4 != 0) This can be caused by bug or by user
 * program as it can be jumping relative to register This shouldn't be happening
 * with non-register jumps as those should be verified by compiler
 * UnknownMemoryControl:
 *  Used unknown MemoryAccess control value (write_ctl or read_ctl)
 *  This can be raised by invalid instruction but in such case we shoul raise
 * UnknownInstruction instead So this should signal just some QtMips bug.
 * OutOfMemoryAccess:
 *  Trying to access address outside of the memory
 *  As we are simulating whole 32bit memory address space then this is most
 * probably QtMips bug if raised not program. Sanity: This is sanity check
 * exception
 */
#define SIMULATOR_EXCEPTIONS                                                                       \
    EXCEPTION(Input, )                                                                             \
    EXCEPTION(Runtime, )                                                                           \
    EXCEPTION(UnsupportedInstruction, Runtime)                                                     \
    EXCEPTION(UnsupportedAluOperation, Runtime)                                                    \
    EXCEPTION(Overflow, Runtime)                                                                   \
    EXCEPTION(UnalignedJump, Runtime)                                                              \
    EXCEPTION(UnknownMemoryControl, Runtime)                                                       \
    EXCEPTION(OutOfMemoryAccess, Runtime)                                                          \
    EXCEPTION(Sanity, )                                                                            \
    EXCEPTION(SyscallUnknown, Runtime)

#define EXCEPTION(NAME, PARENT)                                                                    \
    class SimulatorException##NAME : public SimulatorException##PARENT {                           \
    public:                                                                                        \
        SimulatorException##NAME(QString reason, QString ext, QString file, int line);             \
    };
SIMULATOR_EXCEPTIONS
#undef EXCEPTION

// This is helper macro for throwing QtMips exceptions
#define SIMULATOR_EXCEPTION(TYPE, REASON, EXT)                                                     \
    (machine::SimulatorException##TYPE(QString(REASON), QString(EXT), QString(__FILE__), __LINE__))

#define SANITY_EXCEPTION(MSG)                                                                      \
    SIMULATOR_EXCEPTION(                                                                           \
        Sanity, "Internal error",                                                                  \
        "An internal error occurred in the simulator. We are sorry for the inconvenience."         \
        "To help get the simulator fixed ASAP, please report this incident to your "               \
        "teacher and/or file an issue at\n\n"                                                      \
        "https://github.com/cvut/qtrvsim/issues.\n\n"                                              \
        "Please attach the program you were executing, used configuration of the "                 \
        "simulator, description of steps you have taken and a copy of the following "              \
        "message:\n\n" #MSG)

// Sanity comparison potentially throwing SimulatorExceptionSanity
#define SANITY_ASSERT(COND, MSG)                                                                   \
    do {                                                                                           \
        if (!(COND)) throw SANITY_EXCEPTION("Sanity check failed (" #COND "):" #MSG);              \
    } while (false)

} // namespace machine

#endif // SIMULATOR_EXCEPTION_H
