src/qml/qml/v8/qjsengine.h

   1 /****************************************************************************
   2 **
   3 ** Copyright (C) 2012 Digia Plc and/or its subsidiary(-ies).
   4 ** Contact: http://www.qt-project.org/legal
   5 **
   6 ** This file is part of the QtQml module of the Qt Toolkit.
   7 **
   8 ** $QT_BEGIN_LICENSE:LGPL$
   9 ** Commercial License Usage
  10 ** Licensees holding valid commercial Qt licenses may use this file in
  11 ** accordance with the commercial license agreement provided with the
  12 ** Software or, alternatively, in accordance with the terms contained in
  13 ** a written agreement between you and Digia.  For licensing terms and
  14 ** conditions see http://qt.digia.com/licensing.  For further information
  15 ** use the contact form at http://qt.digia.com/contact-us.
  16 **
  17 ** GNU Lesser General Public License Usage
  18 ** Alternatively, this file may be used under the terms of the GNU Lesser
  19 ** General Public License version 2.1 as published by the Free Software
  20 ** Foundation and appearing in the file LICENSE.LGPL included in the
  21 ** packaging of this file.  Please review the following information to
  22 ** ensure the GNU Lesser General Public License version 2.1 requirements
  23 ** will be met: http://www.gnu.org/licenses/old-licenses/lgpl-2.1.html.
  24 **
  25 ** In addition, as a special exception, Digia gives you certain additional
  26 ** rights.  These rights are described in the Digia Qt LGPL Exception
  27 ** version 1.1, included in the file LGPL_EXCEPTION.txt in this package.
  28 **
  29 ** GNU General Public License Usage
  30 ** Alternatively, this file may be used under the terms of the GNU
  31 ** General Public License version 3.0 as published by the Free Software
  32 ** Foundation and appearing in the file LICENSE.GPL included in the
  33 ** packaging of this file.  Please review the following information to
  34 ** ensure the GNU General Public License version 3.0 requirements will be
  35 ** met: http://www.gnu.org/copyleft/gpl.html.
  36 **
  37 **
  38 ** $QT_END_LICENSE$
  39 **
  40 ****************************************************************************/
  41
  42 #ifndef QJSENGINE_H
  43 #define QJSENGINE_H
  44
  45 #include <QtCore/qmetatype.h>
  46
  47 #include <QtCore/qvariant.h>
  48 #include <QtCore/qsharedpointer.h>
  49 #include <QtCore/qobject.h>
  50 #include <QtQml/qjsvalue.h>
  51
  52 QT_BEGIN_HEADER
  53
  54 QT_BEGIN_NAMESPACE
  55
  56
  57 class QV8Engine;
  58
  59 template <typename T>
  60 inline T qjsvalue_cast(const QJSValue &);
  61
  62 class QJSEnginePrivate;
  63 class Q_QML_EXPORT QJSEngine
  64     : public QObject
  65 {
  66     Q_OBJECT
  67 public:
  68     QJSEngine();
  69     explicit QJSEngine(QObject *parent);
  70     virtual ~QJSEngine();
  71
  72     QJSValue globalObject() const;
  73
  74     QJSValue evaluate(const QString &program, const QString &fileName = QString(), int lineNumber = 1);
  75
  76     QJSValue newObject();
  77     QJSValue newArray(uint length = 0);
  78
  79     QJSValue newQObject(QObject *object);
  80
  81     template <typename T>
  82     inline QJSValue toScriptValue(const T &value)
  83     {
  84         return create(qMetaTypeId<T>(), &value);
  85     }
  86     template <typename T>
  87     inline T fromScriptValue(const QJSValue &value)
  88     {
  89         return qjsvalue_cast<T>(value);
  90     }
  91
  92     void collectGarbage();
  93
  94     QV8Engine *handle() const { return d; }
  95
  96 private:
  97     QJSValue create(int type, const void *ptr);
  98
  99     static bool convertV2(const QJSValue &value, int type, void *ptr);
 100
 101     friend inline bool qjsvalue_cast_helper(const QJSValue &, int, void *);
 102
 103 protected:
 104     QJSEngine(QJSEnginePrivate &dd, QObject *parent = 0);
 105
 106 private:
 107     QV8Engine *d;
 108     Q_DISABLE_COPY(QJSEngine)
 109     Q_DECLARE_PRIVATE(QJSEngine)
 110     friend class QV8Engine;
 111 };
 112
 113 inline bool qjsvalue_cast_helper(const QJSValue &value, int type, void *ptr)
 114 {
 115     return QJSEngine::convertV2(value, type, ptr);
 116 }
 117
 118 template<typename T>
 119 T qjsvalue_cast(const QJSValue &value)
 120 {
 121     T t;
 122     const int id = qMetaTypeId<T>();
 123
 124     if (qjsvalue_cast_helper(value, id, &t))
 125         return t;
 126     else if (value.isVariant())
 127         return qvariant_cast<T>(value.toVariant());
 128
 129     return T();
 130 }
 131
 132 template <>
 133 inline QVariant qjsvalue_cast<QVariant>(const QJSValue &value)
 134 {
 135     return value.toVariant();
 136 }
 137
 138 QT_END_NAMESPACE
 139
 140 QT_END_HEADER
 141
 142 #endif // QJSENGINE_H