tests/auto/xmlpatternssdk/DebugExpressionFactory.h

   1 /****************************************************************************
   2 **
   3 ** Copyright (C) 2011 Nokia Corporation and/or its subsidiary(-ies).
   4 ** All rights reserved.
   5 ** Contact: Nokia Corporation (qt-info@nokia.com)
   6 **
   7 ** This file is part of the test suite of the Qt Toolkit.
   8 **
   9 ** $QT_BEGIN_LICENSE:LGPL$
  10 ** No Commercial Usage
  11 ** This file contains pre-release code and may not be distributed.
  12 ** You may use this file in accordance with the terms and conditions
  13 ** contained in the Technology Preview License Agreement accompanying
  14 ** this package.
  15 **
  16 ** GNU Lesser General Public License Usage
  17 ** Alternatively, this file may be used under the terms of the GNU Lesser
  18 ** General Public License version 2.1 as published by the Free Software
  19 ** Foundation and appearing in the file LICENSE.LGPL included in the
  20 ** packaging of this file.  Please review the following information to
  21 ** ensure the GNU Lesser General Public License version 2.1 requirements
  22 ** will be met: http://www.gnu.org/licenses/old-licenses/lgpl-2.1.html.
  23 **
  24 ** In addition, as a special exception, Nokia gives you certain additional
  25 ** rights.  These rights are described in the Nokia Qt LGPL Exception
  26 ** version 1.1, included in the file LGPL_EXCEPTION.txt in this package.
  27 **
  28 ** If you have questions regarding the use of this file, please contact
  29 ** Nokia at qt-info@nokia.com.
  30 **
  31 **
  32 **
  33 **
  34 **
  35 **
  36 **
  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:
  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