Update licenseheader text in source files for qtxmlpatterns Qt module
[profile/ivi/qtxmlpatterns.git] / src / xmlpatterns / janitors / qatomizer_p.h
1 /****************************************************************************
2 **
3 ** Copyright (C) 2011 Nokia Corporation and/or its subsidiary(-ies).
4 ** All rights reserved.
5 ** Contact: Nokia Corporation (qt-info@nokia.com)
6 **
7 ** This file is part of the QtXmlPatterns module of the Qt Toolkit.
8 **
9 ** $QT_BEGIN_LICENSE:LGPL$
10 ** GNU Lesser General Public License Usage
11 ** This file may be used under the terms of the GNU Lesser General Public
12 ** License version 2.1 as published by the Free Software Foundation and
13 ** appearing in the file LICENSE.LGPL included in the packaging of this
14 ** file. Please review the following information to ensure the GNU Lesser
15 ** General Public License version 2.1 requirements will be met:
16 ** http://www.gnu.org/licenses/old-licenses/lgpl-2.1.html.
17 **
18 ** In addition, as a special exception, Nokia gives you certain additional
19 ** rights. These rights are described in the Nokia Qt LGPL Exception
20 ** version 1.1, included in the file LGPL_EXCEPTION.txt in this package.
21 **
22 ** GNU General Public License Usage
23 ** Alternatively, this file may be used under the terms of the GNU General
24 ** Public License version 3.0 as published by the Free Software Foundation
25 ** and appearing in the file LICENSE.GPL included in the packaging of this
26 ** file. Please review the following information to ensure the GNU General
27 ** Public License version 3.0 requirements will be met:
28 ** http://www.gnu.org/copyleft/gpl.html.
29 **
30 ** Other Usage
31 ** Alternatively, this file may be used in accordance with the terms and
32 ** conditions contained in a signed written agreement between you and Nokia.
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_Atomizer_H
53 #define Patternist_Atomizer_H
54
55 #include "qitem_p.h"
56 #include "qsinglecontainer_p.h"
57
58 QT_BEGIN_HEADER
59
60 QT_BEGIN_NAMESPACE
61
62 namespace QPatternist
63 {
64
65     /**
66      * @short Performs atomization. Effectively, it is an implementation
67      * of the <tt>fn:data()</tt> function.
68      *
69      * @see <a href="http://www.w3.org/TR/xpath-functions/#func-data">XQuery 1.0 and XPath
70      * 2.0 Functions and Operators, 2.4 fn:data</a>
71      * @see <a href="http://www.w3.org/TR/xpath20/#id-atomization">XML
72      * Path Language (XPath) 2.0, 2.4.2 Atomization</a>
73      * @author Frans Englich <frans.englich@nokia.com>
74      * @ingroup Patternist_expressions
75      */
76     class Atomizer : public SingleContainer
77     {
78     public:
79         Atomizer(const Expression::Ptr &operand);
80
81         virtual Item evaluateSingleton(const DynamicContext::Ptr &) const;
82         virtual Item::Iterator::Ptr evaluateSequence(const DynamicContext::Ptr &) const;
83
84         virtual SequenceType::Ptr staticType() const;
85
86         virtual SequenceType::List expectedOperandTypes() const;
87         virtual const SourceLocationReflection *actualReflection() const;
88
89         /**
90          * Makes an early compression, by returning the result of
91          * the type checked operand, if the operand has the static type
92          * xs:anyAtomicType(no atomization needed).
93          */
94         virtual Expression::Ptr typeCheck(const StaticContext::Ptr &context,
95                                           const SequenceType::Ptr &reqType);
96
97         inline Item::Iterator::Ptr mapToSequence(const Item &item,
98                                                  const DynamicContext::Ptr &context) const;
99         virtual ExpressionVisitorResult::Ptr accept(const ExpressionVisitor::Ptr &visitor) const;
100
101     private:
102         typedef QExplicitlySharedDataPointer<const Atomizer> ConstPtr;
103     };
104 }
105
106 QT_END_NAMESPACE
107
108 QT_END_HEADER
109
110 #endif