src/xmlpatterns/iterators/qcachingiterator.cpp

   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 QtXmlPatterns 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
  43
  44 #include "qcachingiterator_p.h"
  45
  46 QT_BEGIN_NAMESPACE
  47
  48 using namespace QPatternist;
  49
  50 CachingIterator::CachingIterator(ItemSequenceCacheCell::Vector &cacheCells,
  51                                  const VariableSlotID slot,
  52                                  const DynamicContext::Ptr &context) : m_position(0),
  53                                                                        m_varSlot(slot),
  54                                                                        m_context(context),
  55                                                                        m_cacheCells(cacheCells),
  56                                                                        m_usingCache(true)
  57 {
  58     Q_ASSERT(m_varSlot > -1);
  59     Q_ASSERT(m_context);
  60     Q_ASSERT(m_cacheCells.at(m_varSlot).sourceIterator);
  61     Q_ASSERT_X((m_cacheCells.at(m_varSlot).cachedItems.isEmpty() && m_cacheCells.at(m_varSlot).cacheState == ItemSequenceCacheCell::Empty) ||
  62                m_cacheCells.at(m_varSlot).cacheState == ItemSequenceCacheCell::PartiallyPopulated,
  63                Q_FUNC_INFO,
  64                "It makes no sense to construct a CachingIterator for a cache that is ItemSequenceCacheCell::Full.");
  65 }
  66
  67 Item CachingIterator::next()
  68 {
  69     ItemSequenceCacheCell &cell = m_cacheCells[m_varSlot];
  70     if(m_position == -1)
  71         return Item();
  72
  73     if(m_usingCache)
  74     {
  75         ++m_position;
  76
  77         /* QAbstractXmlForwardIterator::position() starts at 1, while Qt's container classes
  78          * starts at 0. */
  79         if(m_position - 1 < cell.cachedItems.count())
  80         {
  81             m_current = cell.cachedItems.at(m_position - 1);
  82             return m_current;
  83         }
  84         else
  85         {
  86             cell.cacheState = ItemSequenceCacheCell::PartiallyPopulated;
  87             m_usingCache = false;
  88             /* We decrement here so we don't have to add a branch for this
  89              * when using the source QAbstractXmlForwardIterator below. */
  90             --m_position;
  91         }
  92     }
  93
  94     m_current = cell.sourceIterator->next();
  95
  96     if(m_current)
  97     {
  98         cell.cachedItems.append(m_current);
  99         Q_ASSERT(cell.cacheState == ItemSequenceCacheCell::PartiallyPopulated);
 100         ++m_position;
 101         return m_current;
 102     }
 103     else
 104     {
 105         m_position = -1;
 106         cell.cacheState = ItemSequenceCacheCell::Full;
 107         return Item();
 108     }
 109 }
 110
 111 Item CachingIterator::current() const
 112 {
 113     return m_current;
 114 }
 115
 116 xsInteger CachingIterator::position() const
 117 {
 118     return m_position;
 119 }
 120
 121 Item::Iterator::Ptr CachingIterator::copy() const
 122 {
 123     const ItemSequenceCacheCell &cell = m_cacheCells.at(m_varSlot);
 124     if(cell.cacheState == ItemSequenceCacheCell::Full)
 125         return makeListIterator(cell.cachedItems);
 126     else
 127         return Item::Iterator::Ptr(new CachingIterator(m_cacheCells, m_varSlot, m_context));
 128 }
 129
 130 QT_END_NAMESPACE