src/xmlpatterns/functions/qdatetimefns_p.h
changeset 0 1918ee327afb
child 4 3b1da2848fc7
--- /dev/null	Thu Jan 01 00:00:00 1970 +0000
+++ b/src/xmlpatterns/functions/qdatetimefns_p.h	Mon Jan 11 14:00:40 2010 +0000
@@ -0,0 +1,305 @@
+/****************************************************************************
+**
+** 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_DateTimeFNs_H
+#define Patternist_DateTimeFNs_H
+
+#include "qatomiccomparator_p.h"
+#include "qcommonvalues_p.h"
+#include "qschemadatetime_p.h"
+#include "qdaytimeduration_p.h"
+#include "qdecimal_p.h"
+#include "qinteger_p.h"
+#include "qfunctioncall_p.h"
+
+/**
+ * @file
+ * @short Contains classes implementing the functions found in
+ * <a href="http://www.w3.org/TR/xpath-functions/#component-exraction-functions">XQuery 1.0 and
+ * XPath 2.0 Functions and Operators, 10.5 Component Extraction Functions on Durations, Dates and Times</a>.
+ *
+ * @ingroup Patternist_functions
+ */
+
+QT_BEGIN_HEADER
+
+QT_BEGIN_NAMESPACE
+
+namespace QPatternist
+{
+    /**
+     * @short Helper class for implementing functions extracting components from durations.
+     *
+     * Each sub-class must implement this function:
+     *
+     * @code
+     * Item extract(const AbstractDuration *const duration) const;
+     * @endcode
+     *
+     * This function performs the actual component extraction from the argument, that
+     * is guaranteed to never be @c null.
+     *
+     * @ingroup Patternist_functions
+     * @author Frans Englich <frans.englich@nokia.com>
+     */
+    template<typename TSubClass>
+    class ExtractFromDurationFN : public FunctionCall
+    {
+    public:
+        /**
+         * Takes care of the argument handling, and, if applicable,
+         * calls extract() with the value of the operand.
+         */
+        virtual Item evaluateSingleton(const DynamicContext::Ptr &context) const;
+    };
+
+    /**
+     * @short Implements the function <tt>fn:years-from-duration()</tt>.
+     *
+     * @ingroup Patternist_functions
+     * @author Frans Englich <frans.englich@nokia.com>
+     */
+    class YearsFromDurationFN : public ExtractFromDurationFN<YearsFromDurationFN>
+    {
+    public:
+        inline Item extract(const AbstractDuration *const duration) const;
+    };
+
+    /**
+     * @short Implements the function <tt>fn:months-from-duration()</tt>.
+     *
+     * @ingroup Patternist_functions
+     * @author Frans Englich <frans.englich@nokia.com>
+     */
+    class MonthsFromDurationFN : public ExtractFromDurationFN<MonthsFromDurationFN>
+    {
+    public:
+        inline Item extract(const AbstractDuration *const duration) const;
+    };
+
+    /**
+     * @short Implements the function <tt>fn:days-from-duration()</tt>.
+     *
+     * @ingroup Patternist_functions
+     * @author Frans Englich <frans.englich@nokia.com>
+     */
+    class DaysFromDurationFN : public ExtractFromDurationFN<DaysFromDurationFN>
+    {
+    public:
+        inline Item extract(const AbstractDuration *const duration) const;
+    };
+
+    /**
+     * @short Implements the function <tt>fn:hours-from-duration()</tt>.
+     *
+     * @ingroup Patternist_functions
+     * @author Frans Englich <frans.englich@nokia.com>
+     */
+    class HoursFromDurationFN : public ExtractFromDurationFN<HoursFromDurationFN>
+    {
+    public:
+        inline Item extract(const AbstractDuration *const duration) const;
+    };
+
+    /**
+     * @short Implements the function <tt>fn:minutes-from-duration()</tt>.
+     *
+     * @ingroup Patternist_functions
+     * @author Frans Englich <frans.englich@nokia.com>
+     */
+    class MinutesFromDurationFN : public ExtractFromDurationFN<MinutesFromDurationFN>
+    {
+    public:
+        inline Item extract(const AbstractDuration *const duration) const;
+    };
+
+    /**
+     * @short Implements the function <tt>fn:seconds-from-duration()</tt>.
+     *
+     * @ingroup Patternist_functions
+     * @author Frans Englich <frans.englich@nokia.com>
+     */
+    class SecondsFromDurationFN : public ExtractFromDurationFN<SecondsFromDurationFN>
+    {
+    public:
+        inline Item extract(const AbstractDuration *const duration) const;
+    };
+
+    /**
+     * @short Helper class for implementing functions extracting components
+     * from date/time values.
+     *
+     * Each sub-class must implement this function:
+     *
+     * @code
+     * Item extract(const AbstractDuration *const duration) const;
+     * @endcode
+     *
+     * This function performs the actual component extraction from the argument, that
+     * is guaranteed to never be @c null.
+     *
+     * @ingroup Patternist_functions
+     * @author Frans Englich <frans.englich@nokia.com>
+     */
+    template<typename TSubClass>
+    class ExtractFromDateTimeFN : public FunctionCall
+    {
+    public:
+        /**
+         * Takes care of the argument handling, and, if applicable,
+         * calls extract() with the value of the operand.
+         */
+        virtual Item evaluateSingleton(const DynamicContext::Ptr &context) const;
+    };
+
+    /**
+     * @short Extracts the year property from a sub-class of AbstractDateTime such as DateTime or Date.
+     * This function implements <tt>fn:year-from-dateTime()</tt> and <tt>fn:year-from-date()</tt>.
+     *
+     * @ingroup Patternist_functions
+     * @author Frans Englich <frans.englich@nokia.com>
+     */
+    class YearFromAbstractDateTimeFN : public ExtractFromDateTimeFN<YearFromAbstractDateTimeFN>
+    {
+    public:
+        inline Item extract(const QDateTime &dt) const;
+    };
+
+    /**
+     * @short Extracts the day property from a sub-class of AbstractDateTime such as DateTime or Date.
+     * This function implements <tt>fn:day-from-dateTime()</tt> and <tt>fn:day-from-date()</tt>.
+     *
+     * @ingroup Patternist_functions
+     * @author Frans Englich <frans.englich@nokia.com>
+     */
+    class DayFromAbstractDateTimeFN : public ExtractFromDateTimeFN<DayFromAbstractDateTimeFN>
+    {
+    public:
+        inline Item extract(const QDateTime &dt) const;
+    };
+
+    /**
+     * @short Extracts the minute property from a sub-class of AbstractDateTime such as DateTime or SchemaTime.
+     * Implements the functions <tt>fn:hours-from-dateTime()</tt> and
+     * <tt>fn:hours-from-time()</tt>.
+     *
+     * @ingroup Patternist_functions
+     * @author Frans Englich <frans.englich@nokia.com>
+     */
+    class HoursFromAbstractDateTimeFN : public ExtractFromDateTimeFN<HoursFromAbstractDateTimeFN>
+    {
+    public:
+        inline Item extract(const QDateTime &dt) const;
+    };
+
+    /**
+     * @short Extracts the minutes property from a sub-class of AbstractDateTime such as DateTime or Date.
+     * Implements the functions <tt>fn:minutes-from-dateTime()</tt> and
+     * <tt>fn:minutes-from-time()</tt>.
+     *
+     * @ingroup Patternist_functions
+     * @author Frans Englich <frans.englich@nokia.com>
+     */
+    class MinutesFromAbstractDateTimeFN : public ExtractFromDateTimeFN<MinutesFromAbstractDateTimeFN>
+    {
+    public:
+        inline Item extract(const QDateTime &dt) const;
+    };
+
+    /**
+     * @short Extracts the seconds property from a sub-class of AbstractDateTime such as DateTime or Date.
+     * Implements the functions <tt>fn:seconds-from-dateTime()</tt> and
+     * <tt>fn:seconds-from-time()</tt>.
+     *
+     * @ingroup Patternist_functions
+     * @author Frans Englich <frans.englich@nokia.com>
+     */
+    class SecondsFromAbstractDateTimeFN : public ExtractFromDateTimeFN<SecondsFromAbstractDateTimeFN>
+    {
+    public:
+        inline Item extract(const QDateTime &dt) const;
+    };
+
+    /**
+     * @short Extracts the timezone property from a sub-class of AbstractDateTime such as DateTime or Date.
+     * Implements the functions <tt>fn:timezone-from-dateTime()</tt>,
+     * <tt>fn:timezone-from-time()</tt> and <tt>fn:timezone-from-date()</tt>.
+     *
+     * @ingroup Patternist_functions
+     * @author Frans Englich <frans.englich@nokia.com>
+     */
+    class TimezoneFromAbstractDateTimeFN : public ExtractFromDateTimeFN<TimezoneFromAbstractDateTimeFN>
+    {
+    public:
+        inline Item extract(const QDateTime &dt) const;
+    };
+
+    /**
+     * @short implements the functions <tt>fn:month-from-dateTime()</tt> and <tt>fn:month-from-date()</tt>.
+     *
+     * @ingroup Patternist_functions
+     * @author Frans Englich <frans.englich@nokia.com>
+     */
+    class MonthFromAbstractDateTimeFN : public ExtractFromDateTimeFN<MonthFromAbstractDateTimeFN>
+    {
+    public:
+        inline Item extract(const QDateTime &dt) const;
+    };
+
+#include "qdatetimefns.cpp"
+
+}
+
+QT_END_NAMESPACE
+
+QT_END_HEADER
+
+#endif