BaseHandler.h

Go to the documentation of this file.

// Copyright 2015 - 2026, GIBIS-UNIFESP and the wiRedPanda contributors
// SPDX-License-Identifier: GPL-3.0-or-later
 
#pragma once
 
#include <QJsonObject>
#include <QString>
 
#include "MCP/Server/Core/JsonRpcError.h"
 
class MainWindow;
class MCPValidator;
class Scene;
class GraphicElement;

class BaseHandler
{
public:
    explicit BaseHandler(MainWindow *mainWindow, const MCPValidator *validator);
    virtual ~BaseHandler() = default;
 
    // Pure virtual method for handling commands - each handler implements this
    virtual QJsonObject handleCommand(const QString &command, const QJsonObject &params, const QJsonValue &requestId) = 0;
 
    // Public utility methods available to all classes
    QJsonObject createErrorResponse(const QString &error,
                                    const QJsonValue &requestId = QJsonValue(),
                                    int code = JsonRpcError::InternalError) const;
    QJsonObject createSuccessResponse(const QJsonObject &result = {}, const QJsonValue &requestId = QJsonValue()) const;
    Scene *currentScene();
    const Scene *currentScene() const;
    bool validateElementId(int elementId, const QString &paramName, QString &errorMsg) const;
    bool validateNonEmptyString(const QJsonValue &value, const QString &paramName, QString &errorMsg) const;
    bool validateNonNegativeInteger(const QJsonValue &value, const QString &paramName, QString &errorMsg) const;
    bool validateNumeric(const QJsonValue &value, const QString &paramName, QString &errorMsg) const;
    bool validateParameters(const QJsonObject &params, const QStringList &required) const;
    bool validatePortRange(GraphicElement *element, int portIndex, bool isOutput, const QString &paramName, QString &errorMsg) const;
    bool validatePositiveInteger(const QJsonValue &value, const QString &paramName, QString &errorMsg) const;

    template<typename Fn>
    QJsonObject tryCommand(Fn &&fn, const QString &action, const QJsonValue &requestId = QJsonValue())
    {
        try {
            return std::forward<Fn>(fn)();
        } catch (const std::exception &e) {
            return createErrorResponse(QString("Failed to %1: %2").arg(action, e.what()),
                                       requestId, JsonRpcError::OperationFailed);
        } catch (...) {
            return createErrorResponse(QString("Failed to %1: Unknown exception").arg(action),
                                       requestId, JsonRpcError::OperationFailed);
        }
    }

    GraphicElement *validatedElement(const QJsonObject &params, const QString &paramName, QString &errorMsg);
 
    // Port lookup by label (similar to CircuitBuilder in testutils.cpp)
    bool inputPortByLabel(GraphicElement *element, const QString &label, int &portIndex, QString &errorMsg) const;
    bool outputPortByLabel(GraphicElement *element, const QString &label, int &portIndex, QString &errorMsg) const;
    QString availableInputPorts(GraphicElement *element) const;
    QString availableOutputPorts(GraphicElement *element) const;
 
protected:
    QString availablePorts(GraphicElement *element, bool isOutput) const;
    // Shared resources
    MainWindow *m_mainWindow;
    const MCPValidator *m_validator;
};