katescript.h

Go to the documentation of this file.

// This file is part of the KDE libraries
// Copyright (C) 2008 Paul Giannaros <paul@giannaros.org>
// Copyright (C) 2009 Dominik Haumann <dhaumann kde org>
// Copyright (C) 2010 Joseph Wenninger <jowenn@kde.org>
//
// This library is free software; you can redistribute it and/or
// modify it under the terms of the GNU Library General Public
// License as published by the Free Software Foundation; either
// version 2 of the License, or (at your option) version 3.
//
// This library 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
// Library General Public License for more details.
//
// You should have received a copy of the GNU Library General Public License
// along with this library; see the file COPYING.LIB.  If not, write to
// the Free Software Foundation, Inc., 51 Franklin Street, Fifth Floor,
// Boston, MA 02110-1301, USA.

#ifndef KATE_SCRIPT_H
#define KATE_SCRIPT_H

#include <QtCore/QObject>
#include <QtCore/QHash>
#include <QtCore/QStringList>

#include <QtScript/QScriptValue>
#include <QtScript/QScriptable>

class QScriptEngine;
class QScriptContext;

class KateDocument;
class KateView;

class KateScriptDocument;
class KateScriptView;

namespace Kate {
  enum ScriptType {
    IndentationScript,
    CommandLineScript,
    UnknownScript
  };
}

//BEGIN KateScriptHeader

class KateScriptHeader
{
  public:
    KateScriptHeader() : m_revision(0), m_scriptType(Kate::UnknownScript)
    {}
    virtual ~KateScriptHeader()
    {}

    inline void setLicense(const QString& license)
    { m_license = license; }
    inline const QString& license() const
    { return m_license; }

    inline void setAuthor(const QString& author)
    { m_author = author; }
    inline const QString& author() const
    { return m_author; }

    inline void setRevision(int revision)
    { m_revision = revision; }
    inline int revision() const
    { return m_revision; }

    inline void setKateVersion(const QString& kateVersion)
    { m_kateVersion = kateVersion; }
    inline const QString& kateVersion() const
    { return m_kateVersion; }

    inline void setCatalog(const QString& catalog)
    { m_i18nCatalog = catalog; }
    inline const QString& catalog() const
    { return m_i18nCatalog; }

    inline void setScriptType(Kate::ScriptType scriptType)
    { m_scriptType = scriptType; }
    inline Kate::ScriptType scriptType() const
    { return m_scriptType; }

  private:
    QString m_license;        
    QString m_author;         
    int m_revision;           
    QString m_kateVersion;    
    QString m_i18nCatalog;        
    Kate::ScriptType m_scriptType;  
};
//END

//BEGIN KateScript

class KateScript {
  public:

    enum InputType {
      InputURL,
      InputSCRIPT
    };

    KateScript(const QString &urlOrScript, enum InputType inputType = InputURL);
    virtual ~KateScript();

    const QString &url() { return m_url; }

    bool load();

    bool setView (KateView *view);

    QScriptValue global(const QString &name);

    QScriptValue function(const QString &name);

    const QString &errorMessage() { return m_errorMessage; }

    QString backtrace(const QScriptValue &error, const QString &header = QString());

    void displayBacktrace(const QScriptValue &error, const QString &header = QString());

    void clearExceptions();

    void setGeneralHeader(const KateScriptHeader& generalHeader);
    KateScriptHeader& generalHeader();

  protected:
    bool hasException(const QScriptValue& object, const QString& file);

    static bool readFile(const QString& sourceUrl, QString& sourceCode);

  private:
    bool initApi ();

    void initEngine();

    bool m_loaded;
    bool m_loadSuccessful;
    QString m_url;
    QString m_errorMessage;

  protected:
    QScriptEngine *m_engine;

  private:
    KateScriptHeader m_generalHeader;

    KateScriptDocument *m_document;
    KateScriptView *m_view;

  public:
    static void reloadScriptingApi();

  private:
    static bool s_scriptingApiLoaded;

    enum InputType m_inputType;
    QString m_script;
};

//END

#endif

// kate: space-indent on; indent-width 2; replace-tabs on;