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 QtXmlPatterns module 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 #include "qcommonsequencetypes_p.h"
43 #include "qoptimizerblocks_p.h"
45 #include "qoptimizationpasses_p.h"
49 using namespace QPatternist;
51 OptimizationPass::List OptimizationPasses::comparisonPasses;
52 OptimizationPass::List OptimizationPasses::forPasses;
53 OptimizationPass::List OptimizationPasses::ifThenPasses;
54 OptimizationPass::List OptimizationPasses::notFN;
56 void OptimizationPasses::Coordinator::init()
58 static bool isInitialized = false; // STATIC DATA
65 /* Note, below is many of the building blocks re-used in several passes
66 * in order to reduce memory use. Thus, when changing one building block
67 * it potentially affects many passes. */
69 /* ****************************************************** */
70 /* Rewrite "count(<expr>) ge 1" into "exists(<expr>)" */
71 OptimizationPass::ExpressionMarker firstFirstChild;
72 firstFirstChild.append(0);
73 firstFirstChild.append(0);
75 ExpressionIdentifier::List geOpIDs;
76 const ExpressionIdentifier::Ptr countFN(new ByIDIdentifier(Expression::IDCountFN));
77 geOpIDs.append(countFN);
78 geOpIDs.append(ExpressionIdentifier::Ptr(new IntegerIdentifier(1)));
80 QVector<Expression::ID> geMatcher;
81 geMatcher.append(Expression::IDValueComparison);
82 geMatcher.append(Expression::IDGeneralComparison);
84 const ExpressionIdentifier::Ptr ge(new ComparisonIdentifier(geMatcher,
85 AtomicComparator::OperatorGreaterOrEqual));
87 const ExpressionCreator::Ptr existsFN(new ByIDCreator(Expression::IDExistsFN));
88 const OptimizationPass::Ptr geToExists(new OptimizationPass(ge, geOpIDs, firstFirstChild, existsFN));
89 comparisonPasses.append(geToExists);
90 /* ****************************************************** */
92 /* ****************************************************** */
93 /* Rewrite "count(<expr>) gt 0" into "exists(<expr>)" */
94 ExpressionIdentifier::List countAndIntZero;
95 countAndIntZero.append(countFN);
96 const ExpressionIdentifier::Ptr zeroInteger(new IntegerIdentifier(0));
97 countAndIntZero.append(zeroInteger);
99 const ExpressionIdentifier::Ptr gt(new ComparisonIdentifier(geMatcher,
100 AtomicComparator::OperatorGreaterThan));
102 const OptimizationPass::Ptr gtToExists(new OptimizationPass(gt, countAndIntZero,
103 firstFirstChild, existsFN));
104 comparisonPasses.append(gtToExists);
105 /* ****************************************************** */
107 /* ****************************************************** */
108 /* Rewrite "count(<expr>) ne 0" into "exists(<expr>)" */
110 const ExpressionIdentifier::Ptr ne(new ComparisonIdentifier(geMatcher,
111 AtomicComparator::OperatorNotEqual));
112 const OptimizationPass::Ptr neToExists(new OptimizationPass(ne, countAndIntZero, firstFirstChild,
114 OptimizationPass::AnyOrder));
115 comparisonPasses.append(neToExists);
116 /* ****************************************************** */
118 /* ****************************************************** */
119 /* Rewrite "count(<expr>) eq 0" into "empty(<expr>)" */
120 ExpressionIdentifier::List eqOpIDs;
121 eqOpIDs.append(countFN);
122 eqOpIDs.append(zeroInteger);
123 const ExpressionCreator::Ptr emptyFN(new ByIDCreator(Expression::IDEmptyFN));
124 const ExpressionIdentifier::Ptr eq(new ComparisonIdentifier(geMatcher,
125 AtomicComparator::OperatorEqual));
126 const OptimizationPass::Ptr eqToEmpty(new OptimizationPass(eq, eqOpIDs, firstFirstChild,
128 OptimizationPass::AnyOrder));
129 comparisonPasses.append(eqToEmpty);
131 /* ****************************************************** */
133 /* ****************************************************** */
134 /* Rewrite "for $var in <expr> return $var" into "<expr>" */
135 ExpressionIdentifier::List forOps;
136 OptimizationPass::ExpressionMarker firstChild;
137 firstChild.append(0);
139 forOps.append(ExpressionIdentifier::Ptr());
140 forOps.append(ExpressionIdentifier::Ptr(new ByIDIdentifier(Expression::IDRangeVariableReference)));
141 const OptimizationPass::Ptr simplifyFor(new OptimizationPass(ExpressionIdentifier::Ptr(), forOps,
142 firstChild, ExpressionCreator::Ptr()));
143 forPasses.append(simplifyFor);
144 /* ****************************************************** */
146 /* ****************************************************** */
147 /* Rewrite "if(<expr>) then true() else false()" to "<expr>" */
148 OptimizationPass::ExpressionMarker marker;
151 ExpressionIdentifier::List opIDs;
152 opIDs.append(ExpressionIdentifier::Ptr(new BySequenceTypeIdentifier(
153 CommonSequenceTypes::ExactlyOneBoolean)));
154 opIDs.append(ExpressionIdentifier::Ptr(new BooleanIdentifier(true)));
155 opIDs.append(ExpressionIdentifier::Ptr(new BooleanIdentifier(false)));
157 const OptimizationPass::Ptr pass(new OptimizationPass(ExpressionIdentifier::Ptr(), opIDs, marker));
158 ifThenPasses.append(pass);
159 /* ****************************************************** */
161 /* ****************************************************** */
162 /* Rewrite "not(exists(X))" into "empty(X)" */
163 ExpressionIdentifier::List idExistsFN;
164 idExistsFN.append(ExpressionIdentifier::Ptr(new ByIDIdentifier(Expression::IDExistsFN)));
166 notFN.append(OptimizationPass::Ptr(new OptimizationPass(ExpressionIdentifier::Ptr(),
171 /* Rewrite "not(empty(X))" into "exists(X)" */
172 ExpressionIdentifier::List idEmptyFN;
173 idEmptyFN.append(ExpressionIdentifier::Ptr(new ByIDIdentifier(Expression::IDEmptyFN)));
175 notFN.append(OptimizationPass::Ptr(new OptimizationPass(ExpressionIdentifier::Ptr(),
179 /* ****************************************************** */