src/qml/qml/qqmlaccessors_p.h

   1 /****************************************************************************
   2 **
   3 ** Copyright (C) 2012 Nokia Corporation and/or its subsidiary(-ies).
   4 ** Contact: http://www.qt-project.org/
   5 **
   6 ** This file is part of the QtQml module of the Qt Toolkit.
   7 **
   8 ** $QT_BEGIN_LICENSE:LGPL$
   9 ** GNU Lesser General Public License Usage
  10 ** This file may be used under the terms of the GNU Lesser General Public
  11 ** License version 2.1 as published by the Free Software Foundation and
  12 ** appearing in the file LICENSE.LGPL included in the packaging of this
  13 ** file. Please review the following information to ensure the GNU Lesser
  14 ** General Public License version 2.1 requirements will be met:
  15 ** http://www.gnu.org/licenses/old-licenses/lgpl-2.1.html.
  16 **
  17 ** In addition, as a special exception, Nokia gives you certain additional
  18 ** rights. These rights are described in the Nokia Qt LGPL Exception
  19 ** version 1.1, included in the file LGPL_EXCEPTION.txt in this package.
  20 **
  21 ** GNU General Public License Usage
  22 ** Alternatively, this file may be used under the terms of the GNU General
  23 ** Public License version 3.0 as published by the Free Software Foundation
  24 ** and appearing in the file LICENSE.GPL included in the packaging of this
  25 ** file. Please review the following information to ensure the GNU General
  26 ** Public License version 3.0 requirements will be met:
  27 ** http://www.gnu.org/copyleft/gpl.html.
  28 **
  29 ** Other Usage
  30 ** Alternatively, this file may be used in accordance with the terms and
  31 ** conditions contained in a signed written agreement between you and Nokia.
  32 **
  33 **
  34 **
  35 **
  36 **
  37 **
  38 ** $QT_END_LICENSE$
  39 **
  40 ****************************************************************************/
  41
  42 #ifndef QQMLACCESSORS_P_H
  43 #define QQMLACCESSORS_P_H
  44
  45 #include <QtQml/qtqmlglobal.h>
  46 #include <QtCore/qvector.h>
  47 #include <QtCore/qhash.h>
  48 #include <QtCore/QReadWriteLock>
  49
  50 QT_BEGIN_HEADER
  51
  52 QT_BEGIN_NAMESPACE
  53
  54 class QObject;
  55 class QQmlNotifier;
  56
  57 // QML "accessor properties" allow V4 and V8 to bypass Qt's meta system to read and, more
  58 // importantly, subscribe to properties directly.  Any property that is primarily read
  59 // from bindings is a candidate for inclusion as an accessor property.
  60 //
  61 // To define accessor properties, use the QML_DECLARE_PROPERTIES() and QML_DEFINE_PROPERTIES()
  62 // macros.  The QML_DECLARE_PROPERTIES() macro is used to specify the properties, and the
  63 // QML_DEFINE_PROPERTIES() macro to register the properties with the
  64 // QQmlAccessorProperties singleton.
  65 //
  66 // A class with accessor properties must also add the Q_CLASSINFO("qt_HasQmlAccessors", "true")
  67 // tag to its declaration.  This is essential for QML to maintain internal consistency,
  68 // and forgetting to do so will probably cause your application to qFatal() with a
  69 // helpful reminder of this requirement.
  70 //
  71 // It is important that QML_DEFINE_PROPERTIES() has been called before QML ever sees
  72 // the type with the accessor properties.  As QML_DEFINE_PROPERTIES() is idempotent, it is
  73 // recommended to call it in the type's constructor as well as when the type is registered
  74 // as a QML element (if it ever is).  QML_DEFINE_PROPERTIES() is a very cheap operation
  75 // if registration has already occurred.
  76
  77 #define QML_DECLARE_PROPERTIES(type) \
  78     static volatile bool qqml_accessor_properties_isregistered_ ## type = false; \
  79     static QQmlAccessorProperties::Property qqml_accessor_properties_ ## type[] =
  80
  81 #define QML_DEFINE_PROPERTIES(type) \
  82     do { \
  83         if (!qqml_accessor_properties_isregistered_ ## type) { \
  84             int count = sizeof(qqml_accessor_properties_ ## type) / \
  85                         sizeof(QQmlAccessorProperties::Property); \
  86             QQmlAccessorProperties::registerProperties(&type::staticMetaObject, count, \
  87                     qqml_accessor_properties_ ## type);\
  88             qqml_accessor_properties_isregistered_ ## type = true; \
  89         } \
  90     } while (false);
  91
  92 #define QML_PRIVATE_ACCESSOR(clazz, cpptype, name, variable) \
  93     static void clazz ## _ ## name ## Read(QObject *o, intptr_t, void *rv) \
  94     { \
  95         clazz ## Private *d = clazz ## Private::get(static_cast<clazz *>(o)); \
  96         *static_cast<cpptype *>(rv) = d->variable; \
  97     }
  98
  99 #define QML_PROPERTY_NAME(name) #name, sizeof #name - 1
 100
 101 class QQmlAccessors
 102 {
 103 public:
 104     void (*read)(QObject *object, intptr_t property, void *output);
 105     void (*notifier)(QObject *object, intptr_t property, QQmlNotifier **notifier);
 106 };
 107
 108 namespace QQmlAccessorProperties {
 109     struct Property {
 110         const char *name;
 111         unsigned int nameLength;
 112         intptr_t data;
 113         QQmlAccessors *accessors;
 114     };
 115
 116     struct Properties {
 117         inline Properties();
 118         Properties(Property *, int);
 119
 120         bool operator==(const Properties &o) const {
 121             return count == o.count && properties == o.properties;
 122         }
 123
 124         inline Property *property(const char *name);
 125
 126         int count;
 127         Property *properties;
 128         quint32 nameMask;
 129     };
 130
 131     Properties properties(const QMetaObject *);
 132     void Q_QML_EXPORT registerProperties(const QMetaObject *, int, Property *);
 133 };
 134
 135 QQmlAccessorProperties::Property *
 136 QQmlAccessorProperties::Properties::property(const char *name)
 137 {
 138     if (count == 0)
 139         return 0;
 140
 141     unsigned int length = strlen(name);
 142
 143     Q_ASSERT(length);
 144
 145     if (nameMask & (1 << qMin(31U, length - 1))) {
 146
 147         for (int ii = 0; ii < count; ++ii) {
 148             if (properties[ii].nameLength == length && 0 == qstrcmp(name, properties[ii].name))
 149                 return &properties[ii];
 150         }
 151
 152     }
 153
 154     return 0;
 155 }
 156
 157 QQmlAccessorProperties::Properties::Properties()
 158 : count(0), properties(0), nameMask(0)
 159 {
 160 }
 161
 162 QT_END_NAMESPACE
 163
 164 QT_END_HEADER
 165
 166 #endif // QQMLACCESSORS_P_H