1 /**************************************************************************** 2 ** 3 ** Copyright (C) 2015 The Qt Company Ltd. 4 ** Contact: http://www.qt.io/licensing/ 5 ** 6 ** This file is part of the test suite 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 http://www.qt.io/terms-conditions. For further 15 ** information use the contact form at http://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 2.1 or version 3 as published by the Free 20 ** Software Foundation and appearing in the file LICENSE.LGPLv21 and 21 ** LICENSE.LGPLv3 included in the packaging of this file. Please review the 22 ** following information to ensure the GNU Lesser General Public License 23 ** requirements will be met: https://www.gnu.org/licenses/lgpl.html and 24 ** http://www.gnu.org/licenses/old-licenses/lgpl-2.1.html. 25 ** 26 ** As a special exception, The Qt Company gives you certain additional 27 ** rights. These rights are described in The Qt Company LGPL Exception 28 ** version 1.1, included in the file LGPL_EXCEPTION.txt in this package. 29 ** 30 ** GNU General Public License Usage 31 ** Alternatively, this file may be used under the terms of the GNU 32 ** General Public License version 3.0 as published by the Free Software 33 ** Foundation and appearing in the file LICENSE.GPL included in the 34 ** packaging of this file. Please review the following information to 35 ** ensure the GNU General Public License version 3.0 requirements will be 36 ** met: http://www.gnu.org/copyleft/gpl.html. 37 ** 38 ** $QT_END_LICENSE$ 39 ** 40 ****************************************************************************/ 41 42 #ifndef PatternistSDK_DebugExpressionFactory_H 43 #define PatternistSDK_DebugExpressionFactory_H 44 45 #include "Global.h" 46 #include "qexpressionfactory_p.h" 47 #include "qfunctionfactory_p.h" 48 49 QT_BEGIN_HEADER 50 51 QT_BEGIN_NAMESPACE 52 53 namespace QPatternistSDK 54 { 55 class ASTItem; 56 57 /** 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. 61 * 62 * This tree can be retrieved via astTree(). The astTree() function 63 * returns the AST built the last time createExpression() was called. 64 * 65 * @ingroup PatternistSDK 66 * @author Frans Englich <frans.englich@nokia.com> 67 */ 68 class Q_PATTERNISTSDK_EXPORT DebugExpressionFactory : public QPatternist::ExpressionFactory 69 { 70 public: DebugExpressionFactory()71 DebugExpressionFactory() : m_ast(0) 72 { 73 } 74 75 typedef QExplicitlySharedDataPointer<DebugExpressionFactory> Ptr; 76 /** 77 * Identical to ExpressionFactory::createExpression() with the difference 78 * that it builds an ASTItem tree which can be accessed via astTree(). 79 */ 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, 84 const QUrl &queryURI, 85 const QXmlName &initialTemplateName); 86 87 /** 88 * @returns an ASTItem tree built for the last created expression, 89 * via createExpression(). 90 */ 91 virtual ASTItem *astTree() const; 92 93 /** 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. 97 */ 98 static QStringList availableFunctionSignatures(); 99 100 protected: 101 /** 102 * Performs the ASTItem tree building. 103 */ 104 virtual void processTreePass(const QPatternist::Expression::Ptr &tree, 105 const CompilationStage stage); 106 107 void processTemplateRule(const QPatternist::Expression::Ptr &body, 108 const QPatternist::TemplatePattern::Ptr &pattern, 109 const QXmlName &mode, 110 const TemplateCompilationStage stage); 111 112 void processNamedTemplate(const QXmlName &name, 113 const QPatternist::Expression::Ptr &body, 114 const TemplateCompilationStage stage); 115 private: 116 static ASTItem *buildASTTree(const QPatternist::Expression::Ptr &expr, 117 ASTItem *const parent, 118 const QPatternist::SequenceType::Ptr &reqType); 119 ASTItem *m_ast; 120 }; 121 } 122 123 QT_END_NAMESPACE 124 125 QT_END_HEADER 126 127 #endif 128 // vim: et:ts=4:sw=4:sts=4 129