src/xmlpatterns/expr/qliteral_p.h
changeset 0 1918ee327afb
child 4 3b1da2848fc7
--- /dev/null	Thu Jan 01 00:00:00 1970 +0000
+++ b/src/xmlpatterns/expr/qliteral_p.h	Mon Jan 11 14:00:40 2010 +0000
@@ -0,0 +1,148 @@
+/****************************************************************************
+**
+** Copyright (C) 2009 Nokia Corporation and/or its subsidiary(-ies).
+** All rights reserved.
+** Contact: Nokia Corporation (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 Technology Preview License Agreement accompanying
+** this package.
+**
+** 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.1, included in the file LGPL_EXCEPTION.txt in this package.
+**
+** If you have questions regarding the use of this file, please contact
+** Nokia at qt-info@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_Literal_H
+#define Patternist_Literal_H
+
+#include "qemptycontainer_p.h"
+
+QT_BEGIN_HEADER
+
+QT_BEGIN_NAMESPACE
+
+namespace QPatternist
+{
+    /**
+     * @short Houses an AtomicValue, making it available as an Expression.
+     *
+     * This is not only literals that can be created via the XQuery syntax(strings and numbers), but
+     * all other atomic values, such as <tt>xs:date</tt> or <tt>xs:time</tt>.
+     *
+     * @see <a href="http://www.w3.org/TR/xquery/#id-literals">XQuery 1.0: An XML Query Language,
+     * 3.1.1 Literals</a>
+     * @author Frans Englich <frans.englich@nokia.com>
+     * @ingroup Patternist_expressions
+     */
+    class Literal : public EmptyContainer
+    {
+    public:
+        /**
+         * Creates a Literal that represents @p item.
+         *
+         * @param item must be non-null and cannot be a QXmlNodeModelIndex.
+         */
+        Literal(const Item &item);
+
+        virtual Item evaluateSingleton(const DynamicContext::Ptr &context) const;
+        virtual bool evaluateEBV(const DynamicContext::Ptr &context) const;
+        void evaluateToSequenceReceiver(const DynamicContext::Ptr &context) const;
+
+        virtual SequenceType::Ptr staticType() const;
+        virtual ExpressionVisitorResult::Ptr accept(const ExpressionVisitor::Ptr &visitor) const;
+        virtual ID id() const;
+        virtual QString description() const;
+
+        /**
+         * @returns Expression::DisableElimination and Expression::IsEvaluated
+         */
+        virtual Properties properties() const;
+
+        /**
+         * Declaring the return value of this function a const reference, leads
+         * to crashes in patternistview, for a to me unknown reason.
+         */
+        inline Item item() const
+        {
+            return m_item;
+        }
+
+    private:
+        const Item m_item;
+    };
+
+    /**
+     * @short Creates a Literal that wraps @p item, and returns it.
+     *
+     * This simplifies code. Instead of writing:
+     *
+     * @code
+     * Expression::Ptr(new Literal(item));
+     * @endcode
+     *
+     * One can write:
+     *
+     * @code
+     * wrapLiteral(item);
+     * @endcode
+     *
+     * This function is not declared static, because it breaks the build on
+     * at least aix-xlc-64.
+     *
+     * @relates Literal
+     */
+    inline Expression::Ptr wrapLiteral(const Item &item,
+                                       const StaticContext::Ptr &context,
+                                       const SourceLocationReflection *const r)
+    {
+        Q_ASSERT(item);
+
+        const Expression::Ptr retval(new Literal(item));
+        context->addLocation(retval.data(), context->locationFor(r));
+
+        return retval;
+    }
+}
+
+QT_END_NAMESPACE
+
+QT_END_HEADER
+
+#endif