summaryrefslogtreecommitdiff
path: root/src/xmlpatterns/environment/qgenericstaticcontext_p.h
blob: cc219e386c6804595e01346123c9fc68acb3e909 (plain)
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
/****************************************************************************
**
** Copyright (C) 2016 The Qt Company Ltd.
** Contact: https://www.qt.io/licensing/
**
** This file is part of the QtXmlPatterns module of the Qt Toolkit.
**
** $QT_BEGIN_LICENSE:LGPL$
** Commercial License Usage
** Licensees holding valid commercial Qt licenses may use this file in
** accordance with the commercial license agreement provided with the
** Software or, alternatively, in accordance with the terms contained in
** a written agreement between you and The Qt Company. For licensing terms
** and conditions see https://www.qt.io/terms-conditions. For further
** information use the contact form at https://www.qt.io/contact-us.
**
** GNU Lesser General Public License Usage
** Alternatively, this file may be used under the terms of the GNU Lesser
** General Public License version 3 as published by the Free Software
** Foundation and appearing in the file LICENSE.LGPL3 included in the
** packaging of this file. Please review the following information to
** ensure the GNU Lesser General Public License version 3 requirements
** will be met: https://www.gnu.org/licenses/lgpl-3.0.html.
**
** GNU General Public License Usage
** Alternatively, this file may be used under the terms of the GNU
** General Public License version 2.0 or (at your option) the GNU General
** Public license version 3 or any later version approved by the KDE Free
** Qt Foundation. The licenses are as published by the Free Software
** Foundation and appearing in the file LICENSE.GPL2 and LICENSE.GPL3
** included in the packaging of this file. Please review the following
** information to ensure the GNU General Public License requirements will
** be met: https://www.gnu.org/licenses/gpl-2.0.html and
** https://www.gnu.org/licenses/gpl-3.0.html.
**
** $QT_END_LICENSE$
**
****************************************************************************/

//
//  W A R N I N G
//  -------------
//
// This file is not part of the Qt API.  It exists purely as an
// implementation detail.  This header file may change from version to
// version without notice, or even be removed.
//
// We mean it.

#ifndef Patternist_GenericStaticContext_H
#define Patternist_GenericStaticContext_H

#include <QUrl>
#include <QXmlQuery>

#include <private/qstaticcontext_p.h>
#include <private/qfunctionfactory_p.h>
#include <private/qschematypefactory_p.h>

QT_BEGIN_NAMESPACE

namespace QPatternist
{
    /**
     * @short Provides setters and getters for the properties defined in StaticContext.
     *
     * @author Frans Englich <frans.englich@nokia.com>
     */
    class GenericStaticContext : public StaticContext
    {
    public:
        typedef QExplicitlySharedDataPointer<GenericStaticContext> Ptr;
        /**
         * Constructs a GenericStaticContext. The components are initialized as per
         * the recommended default values in XQuery 1.0. <tt>Default order for empty sequences</tt>,
         * orderingEmptySequence(), is initialized to Greatest.
         *
         * @see <a href="http://www.w3.org/TR/xquery/#id-xq-static-context-components">XQuery
         * 1.0: An XML Query Language, C.1 Static Context Components</a>
         * @param errorHandler the error handler. May be null.
         * @param np the NamePool. May not be null.
         * @param aBaseURI the base URI in the static context. Must be absolute
         * and valid.
         */
        GenericStaticContext(const NamePool::Ptr &np,
                             QAbstractMessageHandler *const errorHandler,
                             const QUrl &aBaseURI,
                             const FunctionFactory::Ptr &factory,
                             const QXmlQuery::QueryLanguage lang);

        NamespaceResolver::Ptr namespaceBindings() const override;
        void setNamespaceBindings(const NamespaceResolver::Ptr &) override;

        FunctionFactory::Ptr functionSignatures() const override;
        SchemaTypeFactory::Ptr schemaDefinitions() const override;

        /**
         * Returns a DynamicContext used for evaluation at compile time.
         *
         * @bug The DynamicContext isn't stable. It should be cached privately.
         */
        DynamicContext::Ptr dynamicContext() const override;

        QUrl baseURI() const override;
        void setBaseURI(const QUrl &uri) override;

        bool compatModeEnabled() const override;
        void setCompatModeEnabled(const bool newVal) override;

        /**
         * @returns always the Unicode codepoint collation URI
         */
        QUrl defaultCollation() const override;

        QAbstractMessageHandler * messageHandler() const override;

        void setDefaultCollation(const QUrl &uri) override;

        BoundarySpacePolicy boundarySpacePolicy() const override;
        void setBoundarySpacePolicy(const BoundarySpacePolicy policy) override;

        ConstructionMode constructionMode() const override;
        void setConstructionMode(const ConstructionMode mode) override;

        OrderingMode orderingMode() const override;
        void setOrderingMode(const OrderingMode mode) override;
        OrderingEmptySequence orderingEmptySequence() const override;
        void setOrderingEmptySequence(const OrderingEmptySequence ordering) override;

        QString defaultFunctionNamespace() const override;
        void setDefaultFunctionNamespace(const QString &ns) override;

        QString defaultElementNamespace() const override;
        void setDefaultElementNamespace(const QString &ns) override;

        InheritMode inheritMode() const override;
        void setInheritMode(const InheritMode mode) override;

        PreserveMode preserveMode() const override;
        void setPreserveMode(const PreserveMode mode) override;

        ItemType::Ptr contextItemType() const override;
        void setContextItemType(const ItemType::Ptr &type);
        ItemType::Ptr currentItemType() const override;

        StaticContext::Ptr copy() const override;

        ResourceLoader::Ptr resourceLoader() const override;
        void setResourceLoader(const ResourceLoader::Ptr &loader);

        ExternalVariableLoader::Ptr externalVariableLoader() const override;
        void setExternalVariableLoader(const ExternalVariableLoader::Ptr &loader);
        NamePool::Ptr namePool() const override;

        void addLocation(const SourceLocationReflection *const reflection,
                         const QSourceLocation &location) override;
        QSourceLocation locationFor(const SourceLocationReflection *const reflection) const override;

        LocationHash sourceLocations() const override;
        QAbstractUriResolver *uriResolver() const override;

        VariableSlotID currentRangeSlot() const override;
        VariableSlotID allocateRangeSlot() override;

    private:
        BoundarySpacePolicy         m_boundarySpacePolicy;
        ConstructionMode            m_constructionMode;
        FunctionFactory::Ptr        m_functionFactory;
        QString                     m_defaultElementNamespace;
        QString                     m_defaultFunctionNamespace;
        OrderingEmptySequence       m_orderingEmptySequence;
        OrderingMode                m_orderingMode;
        QUrl                        m_defaultCollation;
        QUrl                        m_baseURI;
        QAbstractMessageHandler *   m_messageHandler;
        PreserveMode                m_preserveMode;
        InheritMode                 m_inheritMode;
        NamespaceResolver::Ptr      m_namespaceResolver;
        ExternalVariableLoader::Ptr m_externalVariableLoader;
        ResourceLoader::Ptr         m_resourceLoader;
        const NamePool::Ptr         m_namePool;
        ItemType::Ptr               m_contextItemType;
        LocationHash                m_locations;
        QAbstractUriResolver *      m_uriResolver;
        QXmlQuery::QueryLanguage    m_queryLanguage;
        VariableSlotID              m_rangeSlot;
        bool                        m_compatModeEnabled;
    };
}

QT_END_NAMESPACE

#endif