src/xmlpatterns/environment/qfocus_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_Focus_H
  53 #define Patternist_Focus_H
  54
  55 #include <private/qdelegatingdynamiccontext_p.h>
  56
  57 QT_BEGIN_HEADER
  58
  59 QT_BEGIN_NAMESPACE
  60
  61 namespace QPatternist
  62 {
  63     /**
  64      * @short A DynamicContext that maintains the focus, a sequence
  65      * of items.
  66      *
  67      * Focus implements both the outer and inner focus. The focus is one of
  68      * the things that characterizes the XPath language. The focus is what's
  69      * iterated over in a predicate, whose current item can be received
  70      * via the context item expression, <tt>.</tt>(the dot),
  71      * and whose size is retrievable via the function <tt>fn:last()</tt>.
  72      *
  73      * @author Frans Englich <frans.englich@nokia.com>
  74      */
  75     class Focus : public DelegatingDynamicContext
  76     {
  77     public:
  78         Focus(const DynamicContext::Ptr &prevContext);
  79
  80         virtual xsInteger contextPosition() const;
  81         virtual Item contextItem() const;
  82         virtual xsInteger contextSize();
  83
  84         virtual void setFocusIterator(const Item::Iterator::Ptr &it);
  85         virtual Item::Iterator::Ptr focusIterator() const;
  86
  87         /**
  88          * If there is no top level expression that sets the current item,
  89          * the focus should be used. This implementation ensures that.
  90          */
  91         virtual Item currentItem() const;
  92
  93     private:
  94         Item::Iterator::Ptr m_focusIterator;
  95         xsInteger           m_contextSizeCached;
  96     };
  97 }
  98
  99 QT_END_NAMESPACE
 100
 101 QT_END_HEADER
 102
 103 #endif