StelScriptMgr.hpp

/*
 * Stellarium
 * Copyright (C) 2007 Fabien Chereau, 2009 Matthew Gates
 *
 * This program is free software; you can redistribute it and/or
 * modify it under the terms of the GNU General Public License
 * as published by the Free Software Foundation; either version 2
 * of the License, or (at your option) any later version.
 *
 * This program is distributed in the hope that it will be useful,
 * but WITHOUT ANY WARRANTY; without even the implied warranty of
 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
 * GNU General Public License for more details.
 *
 * You should have received a copy of the GNU General Public License
 * along with this program; if not, write to the Free Software
 * Foundation, Inc., 51 Franklin Street, Suite 500, Boston, MA  02110-1335, USA.
 */

#ifndef _STELSCRIPTMGR_HPP_
#define _STELSCRIPTMGR_HPP_

#include <QObject>
#include <QStringList>
#include <QFile>
#include <QTime>
#include <QTimer>

class StelMainScriptAPI;
class StelScriptEngineAgent;
class QScriptEngine;

#ifdef ENABLE_SCRIPT_CONSOLE
class ScriptConsole;
#endif

class StelScriptMgr : public QObject
{
    Q_OBJECT

    Q_PROPERTY(QString runningScriptId READ runningScriptId NOTIFY runningScriptIdChanged)
        
#ifdef ENABLE_SCRIPT_CONSOLE
friend class ScriptConsole;
#endif

public:
    StelScriptMgr(QObject *parent=Q_NULLPTR);
    ~StelScriptMgr();

    QStringList getScriptList();

    bool scriptIsRunning();
    QString runningScriptId();

    // Pre-processor functions
    bool preprocessScript(const QString& input, QString& output, const QString& scriptDir);
    bool preprocessScript(QFile &input, QString& output, const QString& scriptDir);
    
    void addModules();
public slots:
    QString getHtmlDescription(const QString& s, bool generateDocumentTags=true) const;

    QString getName(const QString& s) const;

    QString getAuthor(const QString& s) const;

    QString getLicense(const QString& s) const;

    QString getVersion(const QString& s) const;

    QString getDescription(const QString& s) const;

    QString getShortcut(const QString& s) const;

    bool runScript(const QString& fileName, const QString& includePath="");

    bool runScriptDirect(const QString& scriptCode, const QString &includePath = QString());

    bool runPreprocessedScript(const QString& preprocessedScript, const QString &scriptId);

    bool prepareScript(QString& script, const QString& fileName, const QString& includePath="");

    void stopScript();

    void setScriptRate(float r);
    
    double getScriptRate();

    void debug(const QString& msg);

    void output(const QString& msg);

    void resetOutput(void);

    void saveOutputAs(const QString &filename);

    void pauseScript();

    void resumeScript();

private slots:
    void scriptEnded();
signals:
    void runningScriptIdChanged(const QString& id);
    void scriptRunning();
    void scriptStopped();
    void scriptDebug(const QString&) const;
    void scriptOutput(const QString&) const;

private:
    // Utility functions for preprocessor
    QMap<QString, QString> mappify(const QStringList& args, bool lowerKey=false);
    bool strToBool(const QString& str);

    void initActions();

    QString getHeaderSingleLineCommentText(const QString& s, const QString& id, const QString& notFoundText="") const;
    QScriptEngine* engine;
    
    StelMainScriptAPI *mainAPI;

    QString scriptFileName;
    
    //Script engine agent
    StelScriptEngineAgent *agent;
};

#endif // _STELSCRIPTMGR_HPP_