1 /****************************************************************************
3 ** Copyright (C) 2012 Digia Plc and/or its subsidiary(-ies).
4 ** Contact: http://www.qt-project.org/legal
6 ** This file is part of the QtXmlPatterns module of the Qt Toolkit.
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 Digia. For licensing terms and
14 ** conditions see http://qt.digia.com/licensing. For further information
15 ** use the contact form at http://qt.digia.com/contact-us.
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 2.1 as published by the Free Software
20 ** Foundation and appearing in the file LICENSE.LGPL included in the
21 ** packaging of this file. Please review the following information to
22 ** ensure the GNU Lesser General Public License version 2.1 requirements
23 ** will be met: http://www.gnu.org/licenses/old-licenses/lgpl-2.1.html.
25 ** In addition, as a special exception, Digia gives you certain additional
26 ** rights. These rights are described in the Digia Qt LGPL Exception
27 ** version 1.1, included in the file LGPL_EXCEPTION.txt in this package.
29 ** GNU General Public License Usage
30 ** Alternatively, this file may be used under the terms of the GNU
31 ** General Public License version 3.0 as published by the Free Software
32 ** Foundation and appearing in the file LICENSE.GPL included in the
33 ** packaging of this file. Please review the following information to
34 ** ensure the GNU General Public License version 3.0 requirements will be
35 ** met: http://www.gnu.org/copyleft/gpl.html.
40 ****************************************************************************/
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.
52 #ifndef Patternist_TokenSource_H
53 #define Patternist_TokenSource_H
55 #include <private/qatomiccomparator_p.h>
56 #include <private/qatomicmathematician_p.h>
57 #include <private/qcombinenodes_p.h>
58 #include <private/qfunctionargument_p.h>
59 #include <private/qitem_p.h>
60 #include <private/qitemtype_p.h>
61 #include <private/qorderby_p.h>
62 #include <private/qpath_p.h>
63 #include <private/qquerytransformparser_p.h>
64 #include <private/qvalidate_p.h>
70 template<typename T> class QQueue;
75 * @short A union of all the enums the parser uses.
79 AtomicComparator::Operator valueOperator;
80 AtomicMathematician::Operator mathOperator;
81 CombineNodes::Operator combinedNodeOp;
82 QXmlNodeModelIndex::Axis axis;
83 QXmlNodeModelIndex::DocumentOrder nodeOperator;
84 StaticContext::BoundarySpacePolicy boundarySpacePolicy;
85 StaticContext::ConstructionMode constructionMode;
86 StaticContext::OrderingEmptySequence orderingEmptySequence;
87 StaticContext::OrderingMode orderingMode;
88 OrderBy::OrderSpec::Direction sortDirection;
89 Validate::Mode validationMode;
91 int tokenizerPosition;
99 * @short Base class for components that needs to return tokens.
101 * TokenSource represents a stream of Token instances. The end
102 * is reached when readNext() returns a Token constructed with
105 * @see <a href="http://www.w3.org/TR/xquery-xpath-parsing/">Building a
106 * Tokenizer for XPath or XQuery</a>
107 * @author Frans Englich <frans.englich@nokia.com>
109 class TokenSource : public QSharedData
113 * typedef for the enum Bison generates that contains
116 typedef yytokentype TokenType;
119 * Represents a token by carrying its name and value.
125 * Constructs an invalid Token. This default constructor
126 * is need in Qt's container classes.
129 inline Token(const TokenType t) : type(t) {}
130 inline Token(const TokenType t, const QString &val) : type(t), value(val) {}
132 bool hasError() const
134 return type == ERROR;
141 typedef QExplicitlySharedDataPointer<TokenSource> Ptr;
142 typedef QQueue<Ptr> Queue;
145 * The C++ compiler cannot synthesize it when we use the
146 * Q_DISABLE_COPY() macro.
152 virtual ~TokenSource();
155 * @returns the next token.
158 virtual Token nextToken(YYLTYPE *const sourceLocator) = 0;
161 Q_DISABLE_COPY(TokenSource)