d1dafc11d287beb3c77944415497d6cb406d2dc2
[profile/ivi/qtxmlpatterns.git] / src / xmlpatterns / expr / qdocumentconstructor_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_DocumentConstructor_H
53 #define Patternist_DocumentConstructor_H
54
55 #include <QUrl>
56
57 #include <private/qsinglecontainer_p.h>
58
59 QT_BEGIN_HEADER
60
61 QT_BEGIN_NAMESPACE
62
63 namespace QPatternist
64 {
65     /**
66      * @short Constructs a text node. This covers both computed and directly constructed
67      * text nodes.
68      *
69      * @see <a href="http://www.w3.org/TR/xquery/#id-constructors">XQuery
70      * 1.0: An XML Query Language, 3.7 Constructors</a>
71      * @author Frans Englich <frans.englich@nokia.com>
72      * @ingroup Patternist_expressions
73      */
74     class DocumentConstructor : public SingleContainer
75     {
76     public:
77         DocumentConstructor(const Expression::Ptr &operand);
78
79         virtual Item evaluateSingleton(const DynamicContext::Ptr &context) const;
80         virtual void evaluateToSequenceReceiver(const DynamicContext::Ptr &context) const;
81
82         /**
83          * The first operand must be exactly one @c xs:string.
84          */
85         virtual SequenceType::List expectedOperandTypes() const;
86
87         virtual ExpressionVisitorResult::Ptr accept(const ExpressionVisitor::Ptr &visitor) const;
88         virtual Expression::Ptr typeCheck(const StaticContext::Ptr &context,
89                                           const SequenceType::Ptr &reqType);
90
91         virtual Properties properties() const;
92         virtual SequenceType::Ptr staticType() const;
93
94     private:
95         QUrl m_staticBaseURI;
96     };
97 }
98
99 QT_END_NAMESPACE
100
101 QT_END_HEADER
102
103 #endif