python_context.h

Go to the documentation of this file.

// MIT License
// 
// Copyright (c) 2019 Ruhr University Bochum, Chair for Embedded Security. All Rights reserved.
// Copyright (c) 2019 Marc Fyrbiak, Sebastian Wallat, Max Hoffmann ("ORIGINAL AUTHORS"). All rights reserved.
// Copyright (c) 2021 Max Planck Institute for Security and Privacy. All Rights reserved.
// Copyright (c) 2021 Jörn Langheinrich, Julian Speith, Nils Albartus, René Walendy, Simon Klix ("ORIGINAL AUTHORS"). All Rights reserved.
// 
// Permission is hereby granted, free of charge, to any person obtaining a copy
// of this software and associated documentation files (the "Software"), to deal
// in the Software without restriction, including without limitation the rights
// to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
// copies of the Software, and to permit persons to whom the Software is
// furnished to do so, subject to the following conditions:
// 
// The above copyright notice and this permission notice shall be included in all
// copies or substantial portions of the Software.
// 
// THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
// IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
// FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
// AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
// LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
// OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
// SOFTWARE.
 
#pragma once
 
#include "gui/python/python_console.h"
#include "gui/python/python_thread.h"
#include "gui/module_dialog/gate_select_model.h"
#include "gui/module_dialog/module_select_model.h"
 
#include <QString>
#include <QObject>
 
#pragma GCC diagnostic push
#pragma GCC diagnostic ignored "-Wshadow"
#include "pybind11/embed.h"
#include "pybind11/eval.h"
#include "pybind11/functional.h"
#include "pybind11/operators.h"
#include "pybind11/stl.h"
#include "pybind11/stl_bind.h"
#pragma GCC diagnostic pop
 
namespace hal
{
    class PythonContextSubscriber;
    class PythonEditor;
    class PythonThread;
    class LayoutLocker;
 
    class PythonGateSelectionReceiver : public GateSelectReceiver
    {
        Q_OBJECT
        PythonThread* mThread;
    public Q_SLOTS:
        void handleGatesPicked(const QSet<u32>& gats) override;
    public:
        PythonGateSelectionReceiver(PythonThread* thread, QObject* parent = nullptr)
            : GateSelectReceiver(parent), mThread(thread) {;}
    };
 
    class PythonModuleSelectionReceiver : public ModuleSelectReceiver
    {
        Q_OBJECT
        PythonThread* mThread;
    public Q_SLOTS:
        void handleModulesPicked(const QSet<u32>& gats) override;
    public:
        PythonModuleSelectionReceiver(PythonThread* thread, QObject* parent = nullptr)
            : ModuleSelectReceiver(parent), mThread(thread) {;}
    };
 
    namespace py = pybind11;
    class __attribute__((visibility("default"))) PythonContext : public QObject
    {
        Q_OBJECT
    public:
        PythonContext(QObject* parent=nullptr);
 
        ~PythonContext();
 
        void interpretForeground(const QString& input);
 
        void interpretBackground(QObject* caller, const QString& input, bool multiple_expressions = false);
 
        void interpretScript(QObject* caller, const QString& input);
 
        void forwardStdout(const QString& output);
 
        void forwardError(const QString& output);
 
        void scheduleClear();
 
        void scheduleReset();
 
        void setConsole(PythonConsole* console);
 
        std::vector<std::tuple<std::string, std::string>> complete(const QString& text, bool use_console_context);
 
        int checkCompleteStatement(const QString& text);
 
        //    void set_history_length();
 
        //    void read_history_file(const QString& file);
        //    void write_history_file(const QString& file);
        void initPython();
 
        void closePython();
 
        void updateNetlist();
 
        PythonThread* pythonThread() const;
 
        static void initializeContext(py::dict* context);
        static void initializeScript(py::dict* context);
 
        void abortThread();
        void abortThreadAndWait();
        bool isThreadRunning() const { return mThread != nullptr; }
 
    private Q_SLOTS:
        void handleThreadFinished();
        void handleScriptOutput(const QString& txt);
        void handleScriptError(const QString& txt);
        void handleInputRequired(int type, const QString& prompt, const QVariant& defaultValue);
        void handleConsoleInputReceived(const QString& input);
 
    private:
 
        void handleReset();
        void handleClear();
 
        // these have to be pointers, otherwise they are destructed after py::finalize_interpreter and segfault
        // only one object for global and local is needed, as for the console we run it always in global scope wher globals() == locals()
        py::dict* mContext;
 
        PythonContextSubscriber* mSender;
 
        std::string mHistoryFile;
 
        PythonConsole* mConsole;
        bool mTriggerReset;
        bool mTriggerClear;
        LayoutLocker* mLayoutLocker;
        PythonThread* mThread;
        bool mThreadAborted;
        PyThreadState* mMainThreadState;
        QObject* mInterpreterCaller;
 
        void startThread(const QString& input, bool singleStatement);
    };
}    // namespace hal