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 <QtScript>
#include <QStringList>
#include <QFile>
#include <QTime>
#include <QTimer>
#include <QScriptEngineAgent>

class StelMainScriptAPI;
class StelScriptEngineAgent;

#ifdef ENABLE_SCRIPT_CONSOLE
class ScriptConsole;
#endif

class StelScriptMgr : public QObject
{
    Q_OBJECT
        
#ifdef ENABLE_SCRIPT_CONSOLE
friend class ScriptConsole;
#endif

public:
    StelScriptMgr(QObject *parent=0);
    ~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:
    const QString getName(const QString& s);

    const QString getAuthor(const QString& s);

    const QString getLicense(const QString& s);

    const QString getDescription(const QString& s);

    bool runPreprocessedScript(const QString& preprocessedScript);

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

    void stopScript();

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

    void debug(const QString& msg);

    void pauseScript();

    void resumeScript();

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

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

#ifdef ENABLE_STRATOSCRIPT_COMPAT
    bool preprocessStratoScript(QFile& input, QString& output, const QString& scriptDir);
#endif

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

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

class StelScriptEngineAgent : public QScriptEngineAgent
{
public:
    explicit StelScriptEngineAgent(QScriptEngine *engine);
    virtual ~StelScriptEngineAgent() {}

    void setPauseScript(bool pause) { isPaused=pause; }
    bool getPauseScript() { return isPaused; }

    void positionChange(qint64 scriptId, int lineNumber, int columnNumber);
    
private:
    bool isPaused;

};

#endif // _STELSCRIPTMGR_HPP_