src/xmlpatterns/expr/qcachecells_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 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 //  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_CacheCells_H
  53 #define Patternist_CacheCells_H
  54
  55 #include <QList>
  56 #include <QVector>
  57
  58 #include <private/qitem_p.h>
  59
  60 QT_BEGIN_HEADER
  61
  62 QT_BEGIN_NAMESPACE
  63
  64 namespace QPatternist
  65 {
  66
  67     /**
  68      * @short Represents a cache entry for a single Item,
  69      * as opposed to for a sequence of items.
  70      *
  71      * A characteristic of the ItemCacheCell is that it has two states:
  72      * either its full or it's not, since it only deals with a single
  73      * item.
  74      *
  75      * Remember that cachedItem doesn't tell the state of the ItemCacheCell.
  76      * For instance, it can have a null pointer, the empty sequence, and that
  77      * can be the value of its cache.
  78      *
  79      * @author Frans Englich <frans.englich@nokia.com>
  80      */
  81     class ItemCacheCell
  82     {
  83     public:
  84         typedef QList<ItemCacheCell> List;
  85         typedef QVector<ItemCacheCell> Vector;
  86         enum CacheState
  87         {
  88             Full,
  89             Empty
  90         };
  91
  92         inline ItemCacheCell() : cacheState(Empty)
  93         {
  94         }
  95
  96         Item        cachedItem;
  97         CacheState  cacheState;
  98     };
  99
 100     /**
 101      * @short Represents a cache entry for a sequence of items.
 102      *
 103      * As opposed to ItemCacheCell, ItemSequenceCacheCell can be partially
 104      * populated: e.g, four items is in the cache while three remains in the
 105      * source. For that reason ItemSequenceCacheCell in addition to the source
 106      * also carried an QAbstractXmlForwardIterator which is the source, such
 107      * that it can continue to populate the cache when it runs out.
 108      *
 109      * @author Frans Englich <frans.englich@nokia.com>
 110      */
 111     class ItemSequenceCacheCell
 112     {
 113     public:
 114         typedef QList<ItemSequenceCacheCell> List;
 115         typedef QVector<ItemSequenceCacheCell> Vector;
 116
 117         enum CacheState
 118         {
 119             Full,
 120             Empty,
 121             PartiallyPopulated
 122         };
 123
 124         inline ItemSequenceCacheCell() : cacheState(Empty)
 125                                        , inUse(false)
 126         {
 127         }
 128
 129         Item::List          cachedItems;
 130         Item::Iterator::Ptr sourceIterator;
 131         CacheState          cacheState;
 132         /**
 133          * In XSL-T, we can have circularity which we cannot detect statically.
 134          * For instance, a global variable invokes a template, and the template
 135          * uses the variable. We can't detect that, because we can't figure out
 136          * what template will be invoked.
 137          *
 138          * For solution we have this toggle, which is set temporarily on the
 139          * cell such that EvaluationCache can detect whether it's trashing
 140          * itself.
 141          *
 142          * One might think that it would be sufficient to flag usage of the
 143          * variable in an arbitrary template, but that would also flag valid
 144          * cases.
 145          */
 146         bool                inUse;
 147     };
 148 }
 149
 150 Q_DECLARE_TYPEINFO(QPatternist::ItemCacheCell, Q_MOVABLE_TYPE);
 151 Q_DECLARE_TYPEINFO(QPatternist::ItemSequenceCacheCell, Q_MOVABLE_TYPE);
 152
 153 QT_END_NAMESPACE
 154
 155 QT_END_HEADER
 156
 157 #endif