src/script/bridge/qscriptdeclarativeclass_p.h

   1 /****************************************************************************
   2 **
   3 ** Copyright (C) 2009 Nokia Corporation and/or its subsidiary(-ies).
   4 ** All rights reserved.
   5 ** Contact: Nokia Corporation (qt-info@nokia.com)
   6 **
   7 ** This file is part of the QtDeclarative module of the Qt Toolkit.
   8 **
   9 ** $QT_BEGIN_LICENSE:LGPL-ONLY$
  10 ** No Commercial Usage
  11 ** This file contains pre-release code and may not be distributed.
  12 ** You may use this file in accordance with the terms and conditions
  13 ** contained in the Technology Preview License Agreement accompanying
  14 ** this package.
  15 **
  16 ** GNU Lesser General Public License Usage
  17 ** Alternatively, this file may be used under the terms of the GNU Lesser
  18 ** General Public License version 2.1 as published by the Free Software
  19 ** Foundation and appearing in the file LICENSE.LGPL included in the
  20 ** packaging of this file.  Please review the following information to
  21 ** ensure the GNU Lesser General Public License version 2.1 requirements
  22 ** will be met: http://www.gnu.org/licenses/old-licenses/lgpl-2.1.html.
  23 **
  24 ** In addition, as a special exception, Nokia gives you certain additional
  25 ** rights.  These rights are described in the Nokia Qt LGPL Exception
  26 ** version 1.1, included in the file LGPL_EXCEPTION.txt in this package.
  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 **
  34 **
  35 **
  36 **
  37 **
  38 ** $QT_END_LICENSE$
  39 **
  40 ****************************************************************************/
  41
  42 #ifndef QSCRIPTDECLARATIVECLASS_P_H
  43 #define QSCRIPTDECLARATIVECLASS_P_H
  44
  45 //
  46 //  W A R N I N G
  47 //  -------------
  48 //
  49 // This file is not part of the Qt API.  It exists purely as an
  50 // implementation detail.  This header file may change from version to
  51 // version without notice, or even be removed.
  52 //
  53 // We mean it.
  54 //
  55
  56 #include <QtCore/qobjectdefs.h>
  57 #include <QtScript/qscriptvalue.h>
  58 #include <QtScript/qscriptclass.h>
  59
  60 QT_BEGIN_NAMESPACE
  61
  62 class QScriptDeclarativeClassPrivate;
  63 class PersistentIdentifierPrivate;
  64 class QScriptContext;
  65 class Q_SCRIPT_EXPORT QScriptDeclarativeClass
  66 {
  67 public:
  68     typedef void* Identifier;
  69
  70     struct Object { virtual ~Object() {} };
  71
  72     static QScriptValue newObject(QScriptEngine *, QScriptDeclarativeClass *, Object *);
  73     static QScriptDeclarativeClass *scriptClass(const QScriptValue &);
  74     static Object *object(const QScriptValue &);
  75
  76     static QScriptValue function(const QScriptValue &, const Identifier &);
  77     static QScriptValue property(const QScriptValue &, const Identifier &);
  78
  79     static QScriptValue scopeChainValue(QScriptContext *, int index);
  80     static QScriptContext *pushCleanContext(QScriptEngine *);
  81
  82     class Q_SCRIPT_EXPORT PersistentIdentifier
  83     {
  84     public:
  85         Identifier identifier;
  86
  87         PersistentIdentifier();
  88         ~PersistentIdentifier();
  89         PersistentIdentifier(const PersistentIdentifier &other);
  90         PersistentIdentifier &operator=(const PersistentIdentifier &other);
  91
  92     private:
  93         friend class QScriptDeclarativeClass;
  94         PersistentIdentifier(bool) : identifier(0), d(0) {}
  95         void *d;
  96     };
  97
  98     QScriptDeclarativeClass(QScriptEngine *engine);
  99     virtual ~QScriptDeclarativeClass();
 100
 101     QScriptEngine *engine() const;
 102
 103     PersistentIdentifier createPersistentIdentifier(const QString &);
 104     PersistentIdentifier createPersistentIdentifier(const Identifier &);
 105
 106     QString toString(const Identifier &);
 107     quint32 toArrayIndex(const Identifier &, bool *ok);
 108
 109     virtual QScriptClass::QueryFlags queryProperty(Object *, const Identifier &,
 110                                                    QScriptClass::QueryFlags flags);
 111
 112     virtual QScriptValue property(Object *, const Identifier &);
 113     virtual void setProperty(Object *, const Identifier &name, const QScriptValue &);
 114     virtual QScriptValue::PropertyFlags propertyFlags(Object *, const Identifier &);
 115
 116     virtual QStringList propertyNames(Object *);
 117
 118     virtual QObject *toQObject(Object *, bool *ok = 0);
 119     virtual QVariant toVariant(Object *, bool *ok = 0);
 120
 121     QScriptContext *context() const;
 122 protected:
 123     friend class QScriptDeclarativeClassPrivate;
 124     QScopedPointer<QScriptDeclarativeClassPrivate> d_ptr;
 125 };
 126
 127 QT_END_NAMESPACE
 128
 129 #endif