1 /**************************************************************************** 2 ** 3 ** Copyright (C) 2016 The Qt Company Ltd. 4 ** Contact: https://www.qt.io/licensing/ 5 ** 6 ** This file is part of the QtXmlPatterns module 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 https://www.qt.io/terms-conditions. For further 15 ** information use the contact form at https://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 3 as published by the Free Software 20 ** Foundation and appearing in the file LICENSE.LGPL3 included in the 21 ** packaging of this file. Please review the following information to 22 ** ensure the GNU Lesser General Public License version 3 requirements 23 ** will be met: https://www.gnu.org/licenses/lgpl-3.0.html. 24 ** 25 ** GNU General Public License Usage 26 ** Alternatively, this file may be used under the terms of the GNU 27 ** General Public License version 2.0 or (at your option) the GNU General 28 ** Public license version 3 or any later version approved by the KDE Free 29 ** Qt Foundation. The licenses are as published by the Free Software 30 ** Foundation and appearing in the file LICENSE.GPL2 and LICENSE.GPL3 31 ** included in the packaging of this file. Please review the following 32 ** information to ensure the GNU General Public License requirements will 33 ** be met: https://www.gnu.org/licenses/gpl-2.0.html and 34 ** https://www.gnu.org/licenses/gpl-3.0.html. 35 ** 36 ** $QT_END_LICENSE$ 37 ** 38 ****************************************************************************/ 39 40 // 41 // W A R N I N G 42 // ------------- 43 // 44 // This file is not part of the Qt API. It exists purely as an 45 // implementation detail. This header file may change from version to 46 // version without notice, or even be removed. 47 // 48 // We mean it. 49 50 #ifndef Patternist_OptimizationBlocks_H 51 #define Patternist_OptimizationBlocks_H 52 53 #include <private/qatomiccomparator_p.h> 54 #include <private/qexpression_p.h> 55 #include <private/qoptimizerframework_p.h> 56 57 QT_BEGIN_NAMESPACE 58 59 namespace QPatternist 60 { 61 /** 62 * @short Contains a set of common OptimizerPass instances. 63 * 64 * @author Frans englich <frans.englich@nokia.com> 65 * @ingroup Patternist_expressions 66 */ 67 namespace OptimizationPasses 68 { 69 /** 70 * A list of OptimizerPass instances that performs the 71 * following rewrites: 72 * 73 * - <tt>count([expr]) ne 0</tt> into <tt>exists([expr])</tt> 74 * - <tt>count([expr]) != 0</tt> into <tt>exists([expr])</tt> 75 * - <tt>0 ne count([expr])</tt> into <tt>exists([expr])</tt> 76 * - <tt>0 != count([expr])</tt> into <tt>exists([expr])</tt> 77 * - <tt>count([expr]) eq 0</tt> into <tt>empty([expr])</tt> 78 * - <tt>count([expr]) = 0</tt> into <tt>empty([expr])</tt> 79 * - <tt>0 eq count([expr])</tt> into <tt>empty([expr])</tt> 80 * - <tt>0 = count([expr])</tt> into <tt>empty([expr])</tt> 81 * - <tt>count([expr]) ge 1</tt> into <tt>exists([expr])</tt> 82 * - <tt>count([expr]) >= 1</tt> into <tt>exists([expr])</tt> 83 */ 84 extern OptimizationPass::List comparisonPasses; 85 86 /** 87 * A list of OptimizerPass instances that performs the 88 * following rewrites: 89 * 90 * - <tt>for $var in [expr] return $var</tt> into <tt>[expr]</tt> 91 */ 92 extern OptimizationPass::List forPasses; 93 94 /** 95 * A list of OptimizerPass instances that performs the 96 * following rewrites: 97 * 98 * - <tt>if([expr of type xs:boolean]) then true() else false()</tt> 99 * into <tt>[expr of type xs:boolean]</tt> 100 */ 101 extern OptimizationPass::List ifThenPasses; 102 103 /** 104 * A list of OptimizerPass instances that performs the 105 * following rewrites: 106 * 107 * - <tt>fn:not(fn:exists([expr]))</tt> into <tt>fn:empty([expr])</tt> 108 * - <tt>fn:not(fn:empty([expr]))</tt> into <tt>fn:exists([expr])</tt> 109 */ 110 extern OptimizationPass::List notFN; 111 112 /** 113 * Initializes the data members in the OptimizationPasses namespace. 114 * 115 * This class is not supposed to be instantiated, but to be used via its init() 116 * function. In fact, this class cannot be instantiated. 117 * 118 * @author Frans englich <frans.englich@nokia.com> 119 */ 120 class Coordinator 121 { 122 public: 123 /** 124 * Initializes the members in the OptimizationPasses namespace. 125 */ 126 static void init(); 127 128 private: 129 Q_DISABLE_COPY(Coordinator) 130 inline Coordinator(); 131 }; 132 } 133 } 134 135 QT_END_NAMESPACE 136 137 #endif 138