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_TokenSource_H
51#define Patternist_TokenSource_H
52
53#include <private/qfunctionargument_p.h>
54#include <private/qitem_p.h>
55#include <private/qitemtype_p.h>
56#include <private/qtokenvalue_p.h>
57#include <private/qparsercontext_p.h>
58#include <private/qquerytransformparser_p.h>
59
60QT_BEGIN_NAMESPACE
61
62template<typename T> class QQueue;
63
64namespace QPatternist
65{
66 /**
67 * @short Base class for components that needs to return tokens.
68 *
69 * TokenSource represents a stream of Token instances. The end
70 * is reached when readNext() returns a Token constructed with
71 * END_OF_FILE.
72 *
73 * @see <a href="http://www.w3.org/TR/xquery-xpath-parsing/">Building a
74 * Tokenizer for XPath or XQuery</a>
75 * @author Frans Englich <frans.englich@nokia.com>
76 */
77 class TokenSource : public QSharedData
78 {
79 public:
80 /**
81 * typedef for the enum Bison generates that contains
82 * the token symbols.
83 */
84 typedef XPathtokentype TokenType;
85
86 /**
87 * Represents a token by carrying its name and value.
88 */
89 class Token
90 {
91 public:
92 /**
93 * Constructs an invalid Token. This default constructor
94 * is need in Qt's container classes.
95 */
96 inline Token() {}
97 inline Token(const TokenType t) : type(t) {}
98 inline Token(const TokenType t, const QString &val) : type(t), value(val) {}
99
100 bool hasError() const
101 {
102 return type == T_ERROR;
103 }
104
105 TokenType type;
106 QString value;
107 };
108
109 typedef QExplicitlySharedDataPointer<TokenSource> Ptr;
110 typedef QQueue<Ptr> Queue;
111
112 /**
113 * The C++ compiler cannot synthesize it when we use the
114 * Q_DISABLE_COPY() macro.
115 */
116 inline TokenSource()
117 {
118 }
119
120 virtual ~TokenSource();
121
122 /**
123 * @returns the next token.
124 */
125 virtual Token nextToken(XPATHLTYPE *const sourceLocator) = 0;
126
127 private:
128 Q_DISABLE_COPY(TokenSource)
129 };
130}
131
132QT_END_NAMESPACE
133
134#endif
135

source code of qtxmlpatterns/src/xmlpatterns/parser/qtokensource_p.h