src/qml/qml/qqmlcontextwrapper_p.h

   1 /****************************************************************************
   2 **
   3 ** Copyright (C) 2015 The Qt Company Ltd.
   4 ** Contact: http://www.qt.io/licensing/
   5 **
   6 ** This file is part of the QtQml module of the Qt Toolkit.
   7 **
   8 ** $QT_BEGIN_LICENSE:LGPL21$
   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 The Qt Company. For licensing terms
  14 ** and conditions see http://www.qt.io/terms-conditions. For further
  15 ** information use the contact form at http://www.qt.io/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 or version 3 as published by the Free
  20 ** Software Foundation and appearing in the file LICENSE.LGPLv21 and
  21 ** LICENSE.LGPLv3 included in the packaging of this file. Please review the
  22 ** following information to ensure the GNU Lesser General Public License
  23 ** requirements will be met: https://www.gnu.org/licenses/lgpl.html and
  24 ** http://www.gnu.org/licenses/old-licenses/lgpl-2.1.html.
  25 **
  26 ** As a special exception, The Qt Company gives you certain additional
  27 ** rights. These rights are described in The Qt Company LGPL Exception
  28 ** version 1.1, included in the file LGPL_EXCEPTION.txt in this package.
  29 **
  30 ** $QT_END_LICENSE$
  31 **
  32 ****************************************************************************/
  33
  34 #ifndef QQMLCONTEXTWRAPPER_P_H
  35 #define QQMLCONTEXTWRAPPER_P_H
  36
  37 //
  38 //  W A R N I N G
  39 //  -------------
  40 //
  41 // This file is not part of the Qt API.  It exists purely as an
  42 // implementation detail.  This header file may change from version to
  43 // version without notice, or even be removed.
  44 //
  45 // We mean it.
  46 //
  47
  48 #include <QtCore/qglobal.h>
  49 #include <private/qtqmlglobal_p.h>
  50
  51 #include <private/qv4value_p.h>
  52 #include <private/qv4object_p.h>
  53 #include <private/qqmlcontext_p.h>
  54 #include <private/qv4functionobject_p.h>
  55
  56 QT_BEGIN_NAMESPACE
  57
  58 namespace QV4 {
  59
  60 namespace CompiledData {
  61 struct Function;
  62 }
  63
  64 struct QmlContextWrapper;
  65
  66 namespace Heap {
  67
  68 struct QmlContextWrapper : Object {
  69     QmlContextWrapper(ExecutionEngine *engine, QQmlContextData *context, QObject *scopeObject, bool ownsContext = false);
  70     ~QmlContextWrapper();
  71     bool readOnly;
  72     bool ownsContext;
  73     bool isNullWrapper;
  74
  75     QQmlGuardedContextData context;
  76     QPointer<QObject> scopeObject;
  77 };
  78
  79 }
  80
  81 struct Q_QML_EXPORT QmlContextWrapper : Object
  82 {
  83     V4_OBJECT2(QmlContextWrapper, Object)
  84     V4_NEEDS_DESTROY
  85
  86     static ReturnedValue qmlScope(ExecutionEngine *e, QQmlContextData *ctxt, QObject *scope);
  87     static ReturnedValue urlScope(ExecutionEngine *v4, const QUrl &);
  88
  89     void takeContextOwnership() {
  90         d()->ownsContext = true;
  91     }
  92
  93     inline QObject *getScopeObject() const { return d()->scopeObject; }
  94     inline QQmlContextData *getContext() const { return d()->context; }
  95     static QQmlContextData *getContext(const Value &value);
  96
  97     void setReadOnly(bool b) { d()->readOnly = b; }
  98
  99     static ReturnedValue get(const Managed *m, String *name, bool *hasProperty);
 100     static void put(Managed *m, String *name, const Value &value);
 101
 102     ReturnedValue qmlSingletonWrapper(ExecutionEngine *e, String *name);
 103 };
 104
 105 }
 106
 107 QT_END_NAMESPACE
 108
 109 #endif // QV8CONTEXTWRAPPER_P_H
 110