trikScriptRunnerInterface.h

Go to the documentation of this file.

/* Copyright 2014 CyberTech Labs Ltd.
 *
 * Licensed under the Apache License, Version 2.0 (the "License");
 * you may not use this file except in compliance with the License.
 * You may obtain a copy of the License at
 *
 *     http://www.apache.org/licenses/LICENSE-2.0
 *
 * Unless required by applicable law or agreed to in writing, software
 * distributed under the License is distributed on an "AS IS" BASIS,
 * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
 * See the License for the specific language governing permissions and
 * limitations under the License. */

#pragma once

#include <functional>
#include <type_traits>
#include <QtCore/QObject>
#include <QtCore/QScopedPointer>
#include <QtCore/QThread>
#include <QtScript/QScriptEngine>

#ifndef TRIKSCRIPTRUNNER_EXPORT
#  if defined(TRIKSCRIPTRUNNER_LIBRARY)
#    define TRIKSCRIPTRUNNER_EXPORT Q_DECL_EXPORT
#  else
#    define TRIKSCRIPTRUNNER_EXPORT Q_DECL_IMPORT
#  endif
#endif

#include <trikControl/batteryInterface.h>
#include <trikControl/colorSensorInterface.h>
#include <trikControl/displayInterface.h>
#include <trikControl/encoderInterface.h>
#include <trikControl/eventCodeInterface.h>
#include <trikControl/eventDeviceInterface.h>
#include <trikControl/eventInterface.h>
#include <trikControl/gamepadInterface.h>
#include <trikControl/gyroSensorInterface.h>
#include <trikControl/i2cDeviceInterface.h>
#include <trikControl/lineSensorInterface.h>
#include <trikControl/motorInterface.h>
#include <trikControl/objectSensorInterface.h>
#include <trikControl/soundSensorInterface.h>
#include <trikControl/sensorInterface.h>
#include <trikControl/vectorSensorInterface.h>
#include <trikControl/fifoInterface.h>
#include <trikControl/keysInterface.h>
#include <trikControl/ledInterface.h>
#include <trikControl/markerInterface.h>
#include <trikNetwork/mailboxInterface.h>

#define REGISTER_METATYPE(TYPE) \
    qRegisterMetaType<TYPE*>(TYPE::staticMetaObject.className());

#define REGISTER_DEVICES_WITH_TEMPLATE(TEMPLATE) \
    TEMPLATE(trikControl::BatteryInterface) \
    TEMPLATE(trikControl::ColorSensorInterface) \
    TEMPLATE(trikControl::FifoInterface) \
    TEMPLATE(trikControl::DisplayInterface) \
    TEMPLATE(trikControl::EncoderInterface) \
    TEMPLATE(trikControl::EventCodeInterface) \
    TEMPLATE(trikControl::EventDeviceInterface) \
    TEMPLATE(trikControl::EventInterface) \
    TEMPLATE(trikControl::GamepadInterface) \
    TEMPLATE(trikControl::GyroSensorInterface) \
    TEMPLATE(trikControl::I2cDeviceInterface) \
    TEMPLATE(trikControl::KeysInterface) \
    TEMPLATE(trikControl::LedInterface) \
    TEMPLATE(trikControl::LineSensorInterface) \
    TEMPLATE(trikControl::MarkerInterface) \
    TEMPLATE(trikControl::MotorInterface) \
    TEMPLATE(trikControl::ObjectSensorInterface) \
    TEMPLATE(trikControl::SoundSensorInterface) \
    TEMPLATE(trikControl::SensorInterface) \
    TEMPLATE(trikControl::VectorSensorInterface) \
    TEMPLATE(trikNetwork::MailboxInterface) \

namespace trikScriptRunner {

enum class ScriptType { // must be 0, 1, ..
    UNINITIALIZED = -1,
    JAVASCRIPT,
    PYTHON,
    Size // should always be the last
};

static constexpr typename std::underlying_type<ScriptType>::type to_underlying(ScriptType t) noexcept
{
    return static_cast<std::underlying_type<ScriptType>::type>(t);
}

class TRIKSCRIPTRUNNER_EXPORT TrikScriptRunnerInterface : public QObject
{
    Q_OBJECT

public:
    virtual void registerUserFunction(const QString &name, QScriptEngine::FunctionSignature function) = 0;

    virtual void addCustomEngineInitStep(const std::function<void (QScriptEngine *)> &step) = 0;

    virtual QStringList knownMethodNames() const = 0;

    struct Helper
    {
        static void collectMethodNames(QSet<QString> &result, const QMetaObject *obj);
    };


    virtual bool wasError() = 0;

public slots:
    virtual void run(const QString &script, const QString &fileName = "") = 0;


    virtual void runDirectCommand(const QString &command) = 0;

    virtual void abort() = 0;

    virtual void brickBeep() = 0;

signals:
    void completed(const QString &error, int scriptId);

    void startedScript(const QString &fileName, int scriptId);

    void startedDirectScript(int scriptId);

    void sendMessage(const QString &text);
};

}