ScriptManager.h

Go to the documentation of this file.

#pragma once
 
#include <QSettings>
#include <QTimer>
#include <QWidget>
#include <gsc/GlobalShortcut.h>
#include <misc/gen/ScriptInterpreter.h>
 
namespace sf
{
 
class ScriptManagerListModel;
 
class ScriptEntry;
 
class ScriptManager : public QObject
{
    Q_OBJECT
 
  public:
    explicit ScriptManager(QSettings* settings, QObject* parent);
 
    ~ScriptManager() override;
 
    [[nodiscard]] QString getScriptFilePath(const QString& base_name = QString()) const;
 
    static QString getFileSuffix();
 
    void shortcutActivated(ScriptEntry* entry);
 
    void storeSettings(bool save);
 
    [[nodiscard]] bool isModified() const;
 
    void addAt(qsizetype index = -1);
 
    void remove(qsizetype index);
 
    void start(qsizetype index = -1);
 
    void stop(qsizetype index = -1);
 
    ScriptEntry* getEntry(qsizetype index);
 
    void setModified(QObject* caller);
 
    const ScriptEntry* getEntryByFilepath(const QString& filepath);
 
  private:
    void backgroundRun();
 
    [[nodiscard]] QStringList getFilenames() const;
 
    QSettings* _settings;
    QList<ScriptEntry*> _list;
    bool _modified{false};
    QString _subDirectory;
    QTimer* _timer{nullptr};
 
    friend ScriptManagerListModel;
    friend ScriptEntry;
};
 
class ScriptEntry : public QObject
{
    Q_OBJECT
 
  public:
    enum EBackgroundMode
    {
      bmNo = 0,
      bmOnce,
      bmContinuous
    };
 
    Q_ENUM(EBackgroundMode)
 
    
    explicit ScriptEntry(ScriptManager* parent)
      : QObject(parent)
      , _manager(parent)
    {}
 
    bool start();
 
    void stop();
 
    [[nodiscard]] const QKeySequence& getKeySequence() const;
 
    void setKeySequence(const QKeySequence& ks);
 
    [[nodiscard]] QString getDisplayName() const;
 
    void setDisplayName(const QString& name);
 
    [[nodiscard]] QString getScriptName() const;
 
    void setScriptName(const QString& name);
 
    [[nodiscard]] const QString& getFilename() const
    {
      return _filename;
    }
 
    void setFilename(const QString& name);
 
    [[nodiscard]] EBackgroundMode getBackgroundMode() const
    {
      return _background;
    }
 
    void setBackgroundMode(EBackgroundMode bm);
 
    void setInterpreter(const QSharedPointer<ScriptInterpreter>& interpreter)
    {
      _interpreter = interpreter;
    }
 
    [[nodiscard]] const QSharedPointer<ScriptInterpreter>& getInterpreter() const
    {
      return _interpreter;
    }
 
    [[nodiscard]] QString getStateName() const;
 
    [[nodiscard]] bool isGlobal() const;
 
    void setGlobal(bool);
 
  private:
    QString _filename{};
    EBackgroundMode _background{bmNo};
    QSharedPointer<ScriptInterpreter> _interpreter;
    ScriptManager* _manager{nullptr};
    QKeySequence _keySequence{};
    GlobalShortcut* _globalShortcut{nullptr};
    bool _global{false};
};
 
}// namespace sf