qt/api/qscriptengine.h

   1 /*
   2     Copyright (C) 2009 Nokia Corporation and/or its subsidiary(-ies)
   3
   4     This library is free software; you can redistribute it and/or
   5     modify it under the terms of the GNU Library General Public
   6     License as published by the Free Software Foundation; either
   7     version 2 of the License, or (at your option) any later version.
   8
   9     This library is distributed in the hope that it will be useful,
  10     but WITHOUT ANY WARRANTY; without even the implied warranty of
  11     MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the GNU
  12     Library General Public License for more details.
  13
  14     You should have received a copy of the GNU Library General Public License
  15     along with this library; see the file COPYING.LIB.  If not, write to
  16     the Free Software Foundation, Inc., 51 Franklin Street, Fifth Floor,
  17     Boston, MA 02110-1301, USA.
  18 */
  19
  20 #ifndef qscriptengine_h
  21 #define qscriptengine_h
  22
  23 #include "qscriptprogram.h"
  24 #include "qscriptstring.h"
  25 #include "qscriptsyntaxcheckresult.h"
  26 #include <QtCore/qobject.h>
  27 #include <QtCore/qshareddata.h>
  28 #include <QtCore/qstring.h>
  29
  30 class QScriptValue;
  31 class QScriptEnginePrivate;
  32
  33 // Internal typedef
  34 typedef QExplicitlySharedDataPointer<QScriptEnginePrivate> QScriptEnginePtr;
  35
  36 class QScriptEngine : public QObject {
  37 public:
  38     QScriptEngine();
  39     ~QScriptEngine();
  40
  41     static QScriptSyntaxCheckResult checkSyntax(const QString& program);
  42     QScriptValue evaluate(const QString& program, const QString& fileName = QString(), int lineNumber = 1);
  43     QScriptValue evaluate(const QScriptProgram& program);
  44
  45     void collectGarbage();
  46     void reportAdditionalMemoryCost(int cost);
  47
  48     QScriptString toStringHandle(const QString& str);
  49
  50     QScriptValue nullValue();
  51     QScriptValue undefinedValue();
  52     QScriptValue globalObject() const;
  53 private:
  54     friend class QScriptEnginePrivate;
  55
  56     QScriptEnginePtr d_ptr;
  57 };
  58
  59 #endif