src/plugins/coreplugin/scriptmanager/scriptmanager.h

   1 /**************************************************************************
   2 **
   3 ** This file is part of Qt Creator
   4 **
   5 ** Copyright (c) 2011 Nokia Corporation and/or its subsidiary(-ies).
   6 **
   7 ** Contact: Nokia Corporation (info@qt.nokia.com)
   8 **
   9 **
  10 ** GNU Lesser General Public License Usage
  11 **
  12 ** This file may be used under the terms of the GNU Lesser General Public
  13 ** License version 2.1 as published by the Free Software Foundation and
  14 ** appearing in the file LICENSE.LGPL included in the packaging of this file.
  15 ** Please review the following information to ensure the GNU Lesser General
  16 ** Public License version 2.1 requirements will be met:
  17 ** http://www.gnu.org/licenses/old-licenses/lgpl-2.1.html.
  18 **
  19 ** In addition, as a special exception, Nokia gives you certain additional
  20 ** rights. These rights are described in the Nokia Qt LGPL Exception
  21 ** version 1.1, included in the file LGPL_EXCEPTION.txt in this package.
  22 **
  23 ** Other Usage
  24 **
  25 ** Alternatively, this file may be used in accordance with the terms and
  26 ** conditions contained in a signed written agreement between you and Nokia.
  27 **
  28 ** If you have questions regarding the use of this file, please contact
  29 ** Nokia at qt-info@nokia.com.
  30 **
  31 **************************************************************************/
  32
  33 #ifndef SCRIPTMANAGER_H
  34 #define SCRIPTMANAGER_H
  35
  36 #include <coreplugin/core_global.h>
  37
  38 #include <QtCore/QObject>
  39 #include <QtCore/QString>
  40 #include <QtCore/QSharedPointer>
  41
  42 QT_BEGIN_NAMESPACE
  43 class QScriptEngine;
  44 QT_END_NAMESPACE
  45
  46 namespace Core {
  47
  48 /* Script Manager.
  49  * Provides a script engine that is initialized with
  50  * Qt Creator's interfaces and allows for running scripts.
  51  * @{todo} Should it actually manage script files, too? */
  52
  53 class CORE_EXPORT ScriptManager : public QObject
  54 {
  55     Q_OBJECT
  56 public:
  57     typedef QSharedPointer<QScriptEngine> QScriptEnginePtr;
  58
  59     // A stack frame as returned by a failed invocation (exception)
  60     // fileName may be empty. lineNumber can be 0 for the top frame (goof-up?).
  61     struct StackFrame {
  62         QString function;
  63         QString fileName;
  64         int lineNumber;
  65     };
  66     typedef QList<StackFrame> Stack;
  67
  68     ScriptManager(QObject *parent = 0) : QObject(parent) {}
  69     virtual ~ScriptManager() { }
  70
  71     // Run a script
  72     virtual bool runScript(const QString &script, QString *errorMessage, Stack *errorStack) = 0;
  73     virtual bool runScript(const QString &script, QString *errorMessage) = 0;
  74
  75     virtual QScriptEnginePtr scriptEngine() = 0;
  76 };
  77
  78 } // namespace Core
  79
  80 #endif // SCRIPTMANAGER_H