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_CollationChecker_H
51#define Patternist_CollationChecker_H
52
53#include <private/qsinglecontainer_p.h>
54
55QT_BEGIN_NAMESPACE
56
57namespace QPatternist
58{
59 /**
60 * @short Checks that its operand evaluates to a supported string collation.
61 *
62 * CollationChecker is inserted in the AST when an Expression has LastOperandIsCollation
63 * set. If the argument that CollationChecker is a string literal the CollationChecker
64 * will const-fold as usual, but otherwise will simply pipe through the value of its argument,
65 * if it's a supported collation. Otherwise it raise an error, with code ReportContext::FOCH0002.
66 *
67 * @author Frans Englich <frans.englich@nokia.com>
68 * @ingroup Patternist_expressions
69 */
70 class CollationChecker : public SingleContainer
71 {
72 public:
73 CollationChecker(const Expression::Ptr &source);
74
75 virtual Item evaluateSingleton(const DynamicContext::Ptr &) const;
76
77 /**
78 * Expects exactly one string.
79 */
80 virtual SequenceType::List expectedOperandTypes() const;
81
82 /**
83 * @returns its operand's static type.
84 */
85 virtual SequenceType::Ptr staticType() const;
86
87 virtual ExpressionVisitorResult::Ptr accept(const ExpressionVisitor::Ptr &visitor) const;
88 };
89}
90
91QT_END_NAMESPACE
92
93#endif
94

source code of qtxmlpatterns/src/xmlpatterns/expr/qcollationchecker_p.h