1 /****************************************************************************
3 ** Copyright (C) 2012 Nokia Corporation and/or its subsidiary(-ies).
4 ** Contact: http://www.qt-project.org/
6 ** This file is part of the test suite of the Qt Toolkit.
8 ** $QT_BEGIN_LICENSE:LGPL$
9 ** GNU Lesser General Public License Usage
10 ** This file may be used under the terms of the GNU Lesser General Public
11 ** License version 2.1 as published by the Free Software Foundation and
12 ** appearing in the file LICENSE.LGPL included in the packaging of this
13 ** file. Please review the following information to ensure the GNU Lesser
14 ** General Public License version 2.1 requirements will be met:
15 ** http://www.gnu.org/licenses/old-licenses/lgpl-2.1.html.
17 ** In addition, as a special exception, Nokia gives you certain additional
18 ** rights. These rights are described in the Nokia Qt LGPL Exception
19 ** version 1.1, included in the file LGPL_EXCEPTION.txt in this package.
21 ** GNU General Public License Usage
22 ** Alternatively, this file may be used under the terms of the GNU General
23 ** Public License version 3.0 as published by the Free Software Foundation
24 ** and appearing in the file LICENSE.GPL included in the packaging of this
25 ** file. Please review the following information to ensure the GNU General
26 ** Public License version 3.0 requirements will be met:
27 ** http://www.gnu.org/copyleft/gpl.html.
30 ** Alternatively, this file may be used in accordance with the terms and
31 ** conditions contained in a signed written agreement between you and Nokia.
40 ****************************************************************************/
42 #ifndef PatternistSDK_DebugExpressionFactory_H
43 #define PatternistSDK_DebugExpressionFactory_H
46 #include <private/qexpressionfactory_p.h>
47 #include <private/qfunctionfactory_p.h>
53 namespace QPatternistSDK
58 * @short Is a QPatternist::ExpressionFactory, with the
59 * difference that it provides the hooks for building from a tree of
60 * debug data from the compiled expression.
62 * This tree can be retrieved via astTree(). The astTree() function
63 * returns the AST built the last time createExpression() was called.
65 * @ingroup PatternistSDK
66 * @author Frans Englich <frans.englich@nokia.com>
68 class Q_PATTERNISTSDK_EXPORT DebugExpressionFactory : public QPatternist::ExpressionFactory
71 DebugExpressionFactory() : m_ast(0)
75 typedef QExplicitlySharedDataPointer<DebugExpressionFactory> Ptr;
77 * Identical to ExpressionFactory::createExpression() with the difference
78 * that it builds an ASTItem tree which can be accessed via astTree().
80 virtual QPatternist::Expression::Ptr createExpression(QIODevice *const expr,
81 const QPatternist::StaticContext::Ptr &context,
82 const QXmlQuery::QueryLanguage lang,
83 const QPatternist::SequenceType::Ptr &requiredType,
85 const QXmlName &initialTemplateName);
88 * @returns an ASTItem tree built for the last created expression,
89 * via createExpression().
91 virtual ASTItem *astTree() const;
94 * @returns a list containing string representations of all available
95 * functions in Patternist. Each QString in the returned QStringList
96 * is a function synopsis for human consumption.
98 static QStringList availableFunctionSignatures();
102 * Performs the ASTItem tree building.
104 virtual void processTreePass(const QPatternist::Expression::Ptr &tree,
105 const CompilationStage stage);
107 void processTemplateRule(const QPatternist::Expression::Ptr &body,
108 const QPatternist::TemplatePattern::Ptr &pattern,
109 const QXmlName &mode,
110 const TemplateCompilationStage stage);
112 void processNamedTemplate(const QXmlName &name,
113 const QPatternist::Expression::Ptr &body,
114 const TemplateCompilationStage stage);
116 static ASTItem *buildASTTree(const QPatternist::Expression::Ptr &expr,
117 ASTItem *const parent,
118 const QPatternist::SequenceType::Ptr &reqType);
128 // vim: et:ts=4:sw=4:sts=4