diff options
Diffstat (limited to 'src/xmlpatterns/functions/qdocumentfn_p.h')
-rw-r--r-- | src/xmlpatterns/functions/qdocumentfn_p.h | 124 |
1 files changed, 124 insertions, 0 deletions
diff --git a/src/xmlpatterns/functions/qdocumentfn_p.h b/src/xmlpatterns/functions/qdocumentfn_p.h new file mode 100644 index 0000000..74dcd31 --- /dev/null +++ b/src/xmlpatterns/functions/qdocumentfn_p.h @@ -0,0 +1,124 @@ +/**************************************************************************** +** +** Copyright (C) 2009 Nokia Corporation and/or its subsidiary(-ies). +** Contact: Qt Software Information (qt-info@nokia.com) +** +** This file is part of the QtXmlPatterns module of the Qt Toolkit. +** +** $QT_BEGIN_LICENSE:LGPL$ +** No Commercial Usage +** This file contains pre-release code and may not be distributed. +** You may use this file in accordance with the terms and conditions +** contained in the either Technology Preview License Agreement or the +** Beta Release License Agreement. +** +** GNU Lesser General Public License Usage +** Alternatively, this file may be used under the terms of the GNU Lesser +** General Public License version 2.1 as published by the Free Software +** Foundation and appearing in the file LICENSE.LGPL included in the +** packaging of this file. Please review the following information to +** ensure the GNU Lesser General Public License version 2.1 requirements +** will be met: http://www.gnu.org/licenses/old-licenses/lgpl-2.1.html. +** +** In addition, as a special exception, Nokia gives you certain +** additional rights. These rights are described in the Nokia Qt LGPL +** Exception version 1.0, included in the file LGPL_EXCEPTION.txt in this +** package. +** +** GNU General Public License Usage +** Alternatively, this file may be used under the terms of the GNU +** General Public License version 3.0 as published by the Free Software +** Foundation and appearing in the file LICENSE.GPL included in the +** packaging of this file. Please review the following information to +** ensure the GNU General Public License version 3.0 requirements will be +** met: http://www.gnu.org/copyleft/gpl.html. +** +** If you are unsure which license is appropriate for your use, please +** contact the sales department at qt-sales@nokia.com. +** $QT_END_LICENSE$ +** +****************************************************************************/ + +// +// W A R N I N G +// ------------- +// +// This file is not part of the Qt API. It exists purely as an +// implementation detail. This header file may change from version to +// version without notice, or even be removed. +// +// We mean it. + +#ifndef Patternist_DocumentFN_H +#define Patternist_DocumentFN_H + +#include "qfunctioncall_p.h" + +QT_BEGIN_HEADER + +QT_BEGIN_NAMESPACE + +namespace QPatternist +{ + + /** + * @short Implements XSL-T's function <tt>fn:document()</tt>. + * + * @c fn:document() has no evaluation functions, because it rewrites + * itself to a set of expressions that is the implementation. + * + * The two-argument version: + * + * <tt>document($uris as item()*, $baseURINode as node()) as node()*</tt> + * + * is rewritten into: + * + * <tt>for $uri in distinct-values($uris) + * return doc(resolve-uri($uri, base-uri($baseURINode)))</tt> + * + * and the single version argument: + * + * <tt>document($uris as item()*) as node()*</tt> + * + * is rewritten into: + * + * <tt>for $uri in distinct-values($uris) + * return doc($uri)</tt> + * + * The distinct-values() call ensures the node deduplication and sorting, + * although it fails in the case that URIs resolve/directs in some way to + * the same document. Some of those cases can be solved by wrapping the + * whole expression with a node deduplication(conceptually the-for-loop/.). + * One advantage with distinct-values() over generating traditional node + * sorting/deduplication code is that the latter contains node sorting + * which is uecessary and can be hard to analyze away. distinct-values() + * doesn't have this problem due to its narrower task.. + * + * This works without problems, assuming XTRE1160 is not raised and that + * the recover action instead is ignore. In the case XTRE1160 is raised, + * one must cater for this. + * + * In addition to this, both signatures has its first argument changed to + * type <tt>xs:string*</tt>, in order to generate atomization code. + * + * One notable thing is that the expression for $baseURINode, is moved + * inside a loop, and will be evaluated repeatedly, unless moved out as + * part of optimization. + * + * @ingroup Patternist_functions + * @author Frans Englich <fenglich@trolltech.com> + * @since 4.5 + */ + class DocumentFN : public FunctionCall + { + public: + virtual Expression::Ptr typeCheck(const StaticContext::Ptr &context, + const SequenceType::Ptr &reqType); + }; +} + +QT_END_NAMESPACE + +QT_END_HEADER + +#endif |