1/****************************************************************************
2**
3** Copyright (C) 2016 The Qt Company Ltd.
4** Contact: https://www.qt.io/licensing/
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 The Qt Company. For licensing terms
14** and conditions see https://www.qt.io/terms-conditions. For further
15** information use the contact form at https://www.qt.io/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 3 as published by the Free Software
20** Foundation and appearing in the file LICENSE.LGPL3 included in the
21** packaging of this file. Please review the following information to
22** ensure the GNU Lesser General Public License version 3 requirements
23** will be met: https://www.gnu.org/licenses/lgpl-3.0.html.
24**
25** GNU General Public License Usage
26** Alternatively, this file may be used under the terms of the GNU
27** General Public License version 2.0 or (at your option) the GNU General
28** Public license version 3 or any later version approved by the KDE Free
29** Qt Foundation. The licenses are as published by the Free Software
30** Foundation and appearing in the file LICENSE.GPL2 and LICENSE.GPL3
31** included in the packaging of this file. Please review the following
32** information to ensure the GNU General Public License requirements will
33** be met: https://www.gnu.org/licenses/gpl-2.0.html and
34** https://www.gnu.org/licenses/gpl-3.0.html.
35**
36** $QT_END_LICENSE$
37**
38****************************************************************************/
39
40//
41// W A R N I N G
42// -------------
43//
44// This file is not part of the Qt API. It exists purely as an
45// implementation detail. This header file may change from version to
46// version without notice, or even be removed.
47//
48// We mean it.
49
50#ifndef Patternist_Focus_H
51#define Patternist_Focus_H
52
53#include <private/qdelegatingdynamiccontext_p.h>
54
55QT_BEGIN_NAMESPACE
56
57namespace QPatternist
58{
59 /**
60 * @short A DynamicContext that maintains the focus, a sequence
61 * of items.
62 *
63 * Focus implements both the outer and inner focus. The focus is one of
64 * the things that characterizes the XPath language. The focus is what's
65 * iterated over in a predicate, whose current item can be received
66 * via the context item expression, <tt>.</tt>(the dot),
67 * and whose size is retrievable via the function <tt>fn:last()</tt>.
68 *
69 * @author Frans Englich <frans.englich@nokia.com>
70 */
71 class Focus : public DelegatingDynamicContext
72 {
73 public:
74 Focus(const DynamicContext::Ptr &prevContext);
75
76 virtual xsInteger contextPosition() const;
77 virtual Item contextItem() const;
78 virtual xsInteger contextSize();
79
80 virtual void setFocusIterator(const Item::Iterator::Ptr &it);
81 virtual Item::Iterator::Ptr focusIterator() const;
82
83 /**
84 * If there is no top level expression that sets the current item,
85 * the focus should be used. This implementation ensures that.
86 */
87 virtual Item currentItem() const;
88
89 private:
90 Item::Iterator::Ptr m_focusIterator;
91 xsInteger m_contextSizeCached;
92 };
93}
94
95QT_END_NAMESPACE
96
97#endif
98

source code of qtxmlpatterns/src/xmlpatterns/environment/qfocus_p.h