ScriptException.h

//
//  ScriptException.h
//  libraries/script-engine/src
//
//  Created by Dale Glass on 27/02/2023.
//  Copyright 2023 Overte e.V.
//
//  Distributed under the Apache License, Version 2.0.
//  See the accompanying file LICENSE or http://www.apache.org/licenses/LICENSE-2.0.html
 
#include <QObject>
#include <QString>
#include <QStringList>
 
#include "ScriptValue.h"
 
#pragma once
 
class ScriptException {
    public:
 
    ScriptException(QString message = "", QString info = "", int line = 0, int column = 0, QStringList backtraceList = QStringList()) :
        errorMessage(message), additionalInfo(info), errorLine(line), errorColumn(column), backtrace(backtraceList) {
 
    }
 
    QString errorMessage;
 
    QString additionalInfo;
 
 
    int errorLine;
 
    int errorColumn;
 
    QStringList backtrace;
 
    bool isEmpty() const { return errorMessage.isEmpty(); }
 
    virtual std::shared_ptr<ScriptException> clone() const {
        return std::make_shared<ScriptException>(*this);
    }
};
 
 
class ScriptEngineException : public ScriptException {
    public:
 
    ScriptEngineException(QString message = "", QString info = "", int line = 0, int column = 0, QStringList backtraceList = QStringList()) :
        ScriptException(message, info, line, column, backtraceList) {
 
    }
 
 
    virtual std::shared_ptr<ScriptException> clone() const override {
        return std::make_shared<ScriptEngineException>(*this);
    }
};
 
 
 
class ScriptRuntimeException : public ScriptException {
    public:
 
    ScriptRuntimeException(QString message = "", QString info = "", int line = 0, int column = 0, QStringList backtraceList = QStringList()) :
        ScriptException(message, info, line, column, backtraceList) {
 
    }
 
 
    ScriptValue thrownValue;
 
    virtual std::shared_ptr<ScriptException> clone() const override {
        return std::make_shared<ScriptRuntimeException>(*this);
    }
};
 
inline QDebug operator<<(QDebug debug, const ScriptException& e) {
    debug << "Exception:"
        << e.errorMessage
        << (e.additionalInfo.isEmpty() ? QString("") : "[" + e.additionalInfo + "]")
        << " at line " << e.errorLine << ", column " << e.errorColumn;
 
    if (e.backtrace.length()) {
        debug << "Backtrace:";
        debug << e.backtrace;
    }
 
    return debug;
}
 
// Is this a bad practice?
inline QDebug operator<<(QDebug debug, std::shared_ptr<ScriptException> e) {
    if (!e) {
        debug << "[Null ScriptException]";
        return debug;
    }
 
    debug << *e.get();
    return debug;
}
 
Q_DECLARE_METATYPE(ScriptException)
Q_DECLARE_METATYPE(ScriptEngineException)
Q_DECLARE_METATYPE(ScriptRuntimeException)
 
Q_DECLARE_METATYPE(std::shared_ptr<ScriptException>)
Q_DECLARE_METATYPE(std::shared_ptr<ScriptEngineException>)
Q_DECLARE_METATYPE(std::shared_ptr<ScriptRuntimeException>)