1 /****************************************************************************
3 ** Copyright (C) 2011 Nokia Corporation and/or its subsidiary(-ies).
4 ** All rights reserved.
5 ** Contact: Nokia Corporation (qt-info@nokia.com)
7 ** This file is part of the QtXmlPatterns module of the Qt Toolkit.
9 ** $QT_BEGIN_LICENSE:LGPL$
10 ** GNU Lesser General Public License Usage
11 ** This file may be used under the terms of the GNU Lesser General Public
12 ** License version 2.1 as published by the Free Software Foundation and
13 ** appearing in the file LICENSE.LGPL included in the packaging of this
14 ** file. Please review the following information to ensure the GNU Lesser
15 ** General Public License version 2.1 requirements will be met:
16 ** http://www.gnu.org/licenses/old-licenses/lgpl-2.1.html.
18 ** In addition, as a special exception, Nokia gives you certain additional
19 ** rights. These rights are described in the Nokia Qt LGPL Exception
20 ** version 1.1, included in the file LGPL_EXCEPTION.txt in this package.
22 ** GNU General Public License Usage
23 ** Alternatively, this file may be used under the terms of the GNU General
24 ** Public License version 3.0 as published by the Free Software Foundation
25 ** and appearing in the file LICENSE.GPL included in the packaging of this
26 ** file. Please review the following information to ensure the GNU General
27 ** Public License version 3.0 requirements will be met:
28 ** http://www.gnu.org/copyleft/gpl.html.
31 ** Alternatively, this file may be used in accordance with the terms and
32 ** conditions contained in a signed written agreement between you and Nokia.
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_Tokenizer_H
53 #define Patternist_Tokenizer_H
56 #include <QSharedData>
60 #include "qparsercontext_p.h"
61 #include "qtokensource_p.h"
65 * @short Contains functions and classes used by the parser and tokenizer.
74 typedef QPair<QString, Expression::Ptr> AttributeHolder;
75 typedef QVector<AttributeHolder> AttributeHolderVector;
77 class OrderSpecTransfer
80 typedef QList<OrderSpecTransfer> List;
81 inline OrderSpecTransfer()
85 inline OrderSpecTransfer(const Expression::Ptr &aExpr,
86 const OrderBy::OrderSpec aOrderSpec) : expression(aExpr),
92 Expression::Ptr expression;
93 OrderBy::OrderSpec orderSpec;
97 * @short The value the parser, but not the tokenizers, uses for tokens and
100 * It is inefficient but ensures nothing leaks, by invoking C++
101 * destructors even in the cases the code throws exceptions. This might be
102 * able to be done in a more efficient way -- suggestions are welcome.
109 Expression::Ptr expr;
110 Expression::List expressionList;
112 Cardinality cardinality;
113 ItemType::Ptr itemType;
114 SequenceType::Ptr sequenceType;
115 FunctionArgument::List functionArguments;
116 FunctionArgument::Ptr functionArgument;
117 QVector<QXmlName> qNameVector;
124 AttributeHolder attributeHolder;
125 AttributeHolderVector attributeHolders;
126 OrderSpecTransfer::List orderSpecs;
127 OrderSpecTransfer orderSpec;
134 * Macro for the data type of semantic values; int by default.
135 * See section Data Types of Semantic Values.
137 #define YYSTYPE QPatternist::TokenValue
139 #include "qquerytransformparser_p.h" /* This inclusion must be after TokenValue. */
143 namespace QPatternist
146 * @short Base class for all tokenizers.
148 * The main entry point is nextToken(), which ones calls to retrieve the stream
149 * of tokens this Tokenizer delivers.
151 * @see <a href="http://www.w3.org/TR/xquery-xpath-parsing/">Building a
152 * Tokenizer for XPath or XQuery</a>
153 * @author Frans Englich <frans.englich@nokia.com>
155 class Tokenizer : public TokenSource
158 inline Tokenizer(const QUrl &queryU) : m_queryURI(queryU)
160 Q_ASSERT(queryU.isValid());
163 typedef QExplicitlySharedDataPointer<Tokenizer> Ptr;
166 * Switches the Tokenizer to only do scanning, and returns complete
167 * strings for attribute value templates as opposed to the tokens for
168 * the contained expressions.
170 * The current position in the stream is returned. It can be used to
171 * later resume regular tokenization.
173 virtual int commenceScanOnly() = 0;
176 * Resumes regular parsing from @p position. The tokenizer must be in
177 * the scan-only state, which the commenceScanOnly() call transists to.
179 * The tokenizer will return the token POSITION_SET once after this
180 * function has been called.
182 virtual void resumeTokenizationFrom(const int position) = 0;
185 * @returns the URI of the resource being tokenized.
187 inline const QUrl &queryURI() const
192 virtual void setParserContext(const ParserContext::Ptr &parseInfo) = 0;
196 * Returns a string representation of @p token.
198 * This function is used for debugging purposes. The implementation of
199 * this function is in querytransformparser.ypp.
201 static QString tokenToString(const Token &token);
204 Q_DISABLE_COPY(Tokenizer)
205 const QUrl m_queryURI;
210 #undef Patternist_DEBUG_PARSER // disable it for now