src/xmlpatterns/iterators/qcachingiterator_p.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 QtXmlPatterns 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 //
  43 //  W A R N I N G
  44 //  -------------
  45 //
  46 // This file is not part of the Qt API.  It exists purely as an
  47 // implementation detail.  This header file may change from version to
  48 // version without notice, or even be removed.
  49 //
  50 // We mean it.
  51
  52 #ifndef Patternist_CachingIterator_H
  53 #define Patternist_CachingIterator_H
  54
  55 #include <QList>
  56 #include <QVector>
  57
  58 #include <private/qdynamiccontext_p.h>
  59 #include <private/qitem_p.h>
  60
  61 QT_BEGIN_HEADER
  62
  63 QT_BEGIN_NAMESPACE
  64
  65 namespace QPatternist
  66 {
  67     /**
  68      * @short An QAbstractXmlForwardIterator that gets its item from a cache unless its empty, in
  69      * which case it continues to populate the cache as well as deliver on its
  70      * own from a source QAbstractXmlForwardIterator.
  71      *
  72      * @author Frans Englich <frans.frans.englich@nokia.com>
  73      * @ingroup Patternist_iterators
  74      */
  75     class CachingIterator : public Item::Iterator
  76     {
  77     public:
  78         /**
  79          * We always use the same cache cell so why don't we use it directly,
  80          * instead of passing the slot and ItemSequenceCacheCell::Vector to
  81          * this class? Because the GenericDynamicContext might decide to resize
  82          * the vector and that would invalidate the reference.
  83          *
  84          * We intentionally pass in a non-const reference here.
  85          */
  86         CachingIterator(ItemSequenceCacheCell::Vector &cacheCells,
  87                         const VariableSlotID slot,
  88                         const DynamicContext::Ptr &context);
  89
  90         virtual Item next();
  91         virtual Item current() const;
  92         virtual xsInteger position() const;
  93         virtual Item::Iterator::Ptr copy() const;
  94
  95     private:
  96         Item                        m_current;
  97         xsInteger                   m_position;
  98
  99         /**
 100          * This variable cannot be called m_slot, because
 101          * /usr/include/sys/sysmacros.h on hpuxi-acc defines it.
 102          */
 103         const VariableSlotID        m_varSlot;
 104
 105         /**
 106          * We don't use the context. We only keep a reference such that it
 107          * doesn't get deleted, and m_cacheCells starts to dangle.
 108          */
 109         const DynamicContext::Ptr   m_context;
 110
 111         /**
 112          * We intentionally store a reference here such that we are able to
 113          * modify the item.
 114          */
 115         ItemSequenceCacheCell::Vector &m_cacheCells;
 116
 117         /**
 118          * Whether this CachingIterator is delivering items from
 119          * m_cacheCell.cacheItems or from m_cacheCell.sourceIterator.
 120          */
 121         bool m_usingCache;
 122     };
 123 }
 124
 125 QT_END_NAMESPACE
 126
 127 QT_END_HEADER
 128
 129 #endif