src/declarative/qml/ftw/qhashfield_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 QtDeclarative 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 QHASHFIELD_P_H
  43 #define QHASHFIELD_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
  57 #include <QtCore/qglobal.h>
  58
  59 QT_BEGIN_NAMESPACE
  60
  61 // QHashField can be used for doing coarse grained set testing, in
  62 // cases where you do not expect the set to contain the item.  For
  63 // example where you would write:
  64 //     QSet<QString> strings;
  65 //     for (int ii = 0; ii < mystrings.count(); ++ii) {
  66 //         if (strings.contains(mystrings.at(ii)))
  67 //             qFatal("Duplication!");
  68 //         strings.insert(mystrings);
  69 //     }
  70 // You may write:
  71 //     QHashField strings;
  72 //     for (int ii = 0; ii < mystrings.count(); ++ii) {
  73 //         if (strings.testAndSet(qHash(mystrings.at(ii)))) {
  74 //             // The string *might* be duplicated
  75 //             for (int jj = 0; jj < ii; ++jj) {
  76 //                 if (mystrings.at(ii) == mystrings.at(jj))
  77 //                     qFatal("Duplication!");
  78 //             }
  79 //          }
  80 //     }
  81 // For small lists of things, where the hash is cheap to calculate
  82 // and you don't expect duplication this will be much faster.
  83 class QHashField {
  84 public:
  85     inline QHashField();
  86
  87     inline void clear();
  88
  89     inline bool test(quint32 hash);
  90     inline bool testAndSet(quint32 hash);
  91 private:
  92     quint32 m_field;
  93 };
  94
  95 QHashField::QHashField()
  96 : m_field(0)
  97 {
  98 }
  99
 100 void QHashField::clear()
 101 {
 102     m_field = 0;
 103 }
 104
 105 bool QHashField::test(quint32 hash)
 106 {
 107     return m_field & (1 << (hash % 31));
 108 }
 109
 110 bool QHashField::testAndSet(quint32 hash)
 111 {
 112     quint32 mask = 1 << (hash % 31);
 113     bool rv = m_field & mask;
 114     m_field |= mask;
 115     return rv;
 116 }
 117
 118 QT_END_NAMESPACE
 119
 120 #endif // QHASHFIELD_P_H