1 /****************************************************************************
3 ** Copyright (C) 2012 Digia Plc and/or its subsidiary(-ies).
4 ** Contact: http://www.qt-project.org/legal
6 ** This file is part of the QtXmlPatterns module of the Qt Toolkit.
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 Digia. For licensing terms and
14 ** conditions see http://qt.digia.com/licensing. For further information
15 ** use the contact form at http://qt.digia.com/contact-us.
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 as published by the Free Software
20 ** Foundation and appearing in the file LICENSE.LGPL included in the
21 ** packaging of this file. Please review the following information to
22 ** ensure the GNU Lesser General Public License version 2.1 requirements
23 ** will be met: http://www.gnu.org/licenses/old-licenses/lgpl-2.1.html.
25 ** In addition, as a special exception, Digia gives you certain additional
26 ** rights. These rights are described in the Digia Qt LGPL Exception
27 ** version 1.1, included in the file LGPL_EXCEPTION.txt in this package.
29 ** GNU General Public License Usage
30 ** Alternatively, this file may be used under the terms of the GNU
31 ** General Public License version 3.0 as published by the Free Software
32 ** Foundation and appearing in the file LICENSE.GPL included in the
33 ** packaging of this file. Please review the following information to
34 ** ensure the GNU General Public License version 3.0 requirements will be
35 ** met: http://www.gnu.org/copyleft/gpl.html.
40 ****************************************************************************/
42 #include "qargumentconverter_p.h"
43 #include "qatomictype_p.h"
44 #include "qatomizer_p.h"
45 #include "qbuiltintypes_p.h"
46 #include "qcardinalityverifier_p.h"
47 #include "qcommonsequencetypes_p.h"
48 #include "qfunctionfactory_p.h"
49 #include "qitemverifier_p.h"
50 #include "qpatternistlocale_p.h"
51 #include "quntypedatomicconverter_p.h"
53 #include "qtypechecker_p.h"
57 using namespace QPatternist;
59 QString TypeChecker::wrongType(const NamePool::Ptr &np,
60 const ItemType::Ptr &reqType,
61 const ItemType::Ptr &opType)
63 return QtXmlPatterns::tr("Required type is %1, but %2 was found.")
64 .arg(formatType(np, reqType), formatType(np, opType));
67 Expression::Ptr TypeChecker::applyFunctionConversion(const Expression::Ptr &operand,
68 const SequenceType::Ptr &reqType,
69 const StaticContext::Ptr &context,
70 const ReportContext::ErrorCode code,
71 const Options options)
73 Q_ASSERT_X(!ReportContext::codeToString(code).isEmpty(), Q_FUNC_INFO,
74 "This test ensures 'code' exists, otherwise codeToString() would assert.");
79 /* Do it in two steps: verify type, and then cardinality. */
80 const Expression::Ptr cardVerified(CardinalityVerifier::verifyCardinality(operand, reqType->cardinality(), context, code));
81 return verifyType(cardVerified, reqType, context, code, options);
84 bool TypeChecker::promotionPossible(const ItemType::Ptr &fromType,
85 const ItemType::Ptr &toType,
86 const StaticContext::Ptr &context)
88 /* These types can be promoted to xs:string. xs:untypedAtomic should be
89 * cast when interpreting it formally, but implementing it as a promotion
90 * gives the same result(and is faster). */
91 if(*toType == *BuiltinTypes::xsString &&
92 (BuiltinTypes::xsUntypedAtomic->xdtTypeMatches(fromType) ||
93 BuiltinTypes::xsAnyURI->xdtTypeMatches(fromType)))
96 if(*toType == *BuiltinTypes::xsDouble &&
97 BuiltinTypes::numeric->xdtTypeMatches(fromType))
99 /* Any numeric can be promoted to xs:double. */
103 /* xs:decimal/xs:integer can be promoted to xs:float. */
104 if(*toType == *BuiltinTypes::xsFloat && BuiltinTypes::xsDecimal->xdtTypeMatches(fromType))
107 context->warning(QtXmlPatterns::tr("Promoting %1 to %2 may cause loss of precision.")
108 .arg(formatType(context->namePool(), fromType))
109 .arg(formatType(context->namePool(), BuiltinTypes::xsFloat)));
116 Expression::Ptr TypeChecker::typeCheck(Expression *const op,
117 const StaticContext::Ptr &context,
118 const SequenceType::Ptr &reqType)
120 return Expression::Ptr(op->typeCheck(context, reqType));
123 Expression::Ptr TypeChecker::verifyType(const Expression::Ptr &operand,
124 const SequenceType::Ptr &reqSeqType,
125 const StaticContext::Ptr &context,
126 const ReportContext::ErrorCode code,
127 const Options options)
129 const ItemType::Ptr reqType(reqSeqType->itemType());
130 const Expression::Properties props(operand->properties());
132 /* If operand requires a focus, do the necessary type checking for that. */
133 if(props.testFlag(Expression::RequiresFocus) && options.testFlag(CheckFocus))
135 const ItemType::Ptr contextType(context->contextItemType());
138 if(props.testFlag(Expression::RequiresContextItem))
140 Q_ASSERT_X(operand->expectedContextItemType(), Q_FUNC_INFO,
141 "When the Expression sets the RequiresContextItem property, it must "
142 "return a type in expectedContextItemType()");
143 const ItemType::Ptr expectedContextType(operand->expectedContextItemType());
145 /* Allow the empty sequence. We don't want to trigger XPTY0020 on ()/... . */
146 if(!expectedContextType->xdtTypeMatches(contextType) && contextType != CommonSequenceTypes::Empty)
148 context->error(wrongType(context->namePool(), operand->expectedContextItemType(), contextType),
149 ReportContext::XPTY0020, operand.data());
156 context->error(QtXmlPatterns::tr("The focus is undefined."), ReportContext::XPDY0002, operand.data());
161 SequenceType::Ptr operandSeqType(operand->staticType());
162 ItemType::Ptr operandType(operandSeqType->itemType());
164 /* This returns the operand if the types are identical or if operandType
165 * is a subtype of reqType. */
166 if(reqType->xdtTypeMatches(operandType) || *operandType == *CommonSequenceTypes::Empty)
169 /* Since we haven't exited yet, it means that the operandType is a super type
170 * of reqType, and that there hence is a path down to it through the
171 * type hierachy -- but that doesn't necessarily mean that a up-cast(down the
172 * hierarchy) would succeed. */
174 Expression::Ptr result(operand);
176 if(reqType->isAtomicType())
178 const Expression::ID opID = operand->id();
179 if((opID == Expression::IDArgumentReference ||
180 (opID == Expression::IDCardinalityVerifier && operand->operands().first()->is(Expression::IDArgumentReference)))
181 && *BuiltinTypes::item == *operandType)
182 return Expression::Ptr(new ArgumentConverter(result, reqType));
184 if(!operandType->isAtomicType())
186 result = Expression::Ptr(new Atomizer(result));
187 /* The atomizer might know more about the type. */
188 operandType = result->staticType()->itemType();
191 if(reqType->xdtTypeMatches(operandType))
193 /* Atomization was sufficient. Either the expected type is xs:anyAtomicType
194 * or the type the Atomizer knows it returns, matches the required type. */
198 const bool compatModeEnabled = context->compatModeEnabled();
200 if((options.testFlag(AutomaticallyConvert) && BuiltinTypes::xsUntypedAtomic->xdtTypeMatches(operandType)) ||
201 (compatModeEnabled && BuiltinTypes::xsString->xdtTypeMatches(reqType)))
203 if(*reqType == *BuiltinTypes::numeric)
205 result = typeCheck(new UntypedAtomicConverter(result, BuiltinTypes::xsDouble, code),
206 context, reqSeqType);
209 result = typeCheck(new UntypedAtomicConverter(result, reqType, code), context, reqSeqType);
211 /* The UntypedAtomicConverter might know more about the type, so reload. */
212 operandType = result->staticType()->itemType();
214 else if(compatModeEnabled && *reqType == *BuiltinTypes::xsDouble)
216 const FunctionFactory::Ptr functions(context->functionSignatures());
217 Expression::List numberArgs;
218 numberArgs.append(operand);
220 result = functions->createFunctionCall(QXmlName(StandardNamespaces::fn, StandardLocalNames::number),
223 operand.data())->typeCheck(context, reqSeqType);
224 operandType = result->staticType()->itemType();
225 context->wrapExpressionWith(operand.data(), result);
228 if(reqType->xdtTypeMatches(operandType))
231 /* Test if promotion will solve it; the xdtTypeMatches didn't
233 if(options.testFlag(AutomaticallyConvert) && promotionPossible(operandType, reqType, context))
235 if(options.testFlag(GeneratePromotion))
236 return Expression::Ptr(new UntypedAtomicConverter(result, reqType));
241 if(operandType->xdtTypeMatches(reqType))
243 /* For example, operandType is numeric, and reqType is xs:integer. */
244 return Expression::Ptr(new ItemVerifier(result, reqType, code));
248 context->error(wrongType(context->namePool(), reqType, operandType), code, operand.data());
252 else if(reqType->isNodeType())
255 ReportContext::ErrorCode myCode;
257 if(*reqType == *CommonSequenceTypes::EBV->itemType())
258 myCode = ReportContext::FORG0006;
262 /* empty-sequence() is considered valid because it's ok to do
263 * for example nilled( () ). That is, to pass an empty sequence to a
264 * function requiring for example node()?. */
265 if(*operandType == *CommonSequenceTypes::Empty)
267 else if(!operandType->xdtTypeMatches(reqType))
269 context->error(wrongType(context->namePool(), reqType, operandType), myCode, operand.data());
273 /* Operand must be an item. Thus, the sequence can contain both
274 * nodes and atomic values: we have to verify. */
275 return Expression::Ptr(new ItemVerifier(result, reqType, myCode));
279 Q_ASSERT(*reqType == *CommonSequenceTypes::Empty);
281 /* element() doesn't match empty-sequence(), but element()* does. */
282 if(!reqType->xdtTypeMatches(operandType) &&
283 !operandSeqType->cardinality().allowsEmpty())
285 context->error(wrongType(context->namePool(), reqType, operandType),
286 code, operand.data());
291 /* This line should be reached if required type is
292 * EBVType, and the operand is compatible. */