src/xmlpatterns/functions/qtimezonefns_p.h

   1 /****************************************************************************
   2 **
   3 ** Copyright (C) 2011 Nokia Corporation and/or its subsidiary(-ies).
   4 ** All rights reserved.
   5 ** Contact: Nokia Corporation (qt-info@nokia.com)
   6 **
   7 ** This file is part of the QtXmlPatterns module of the Qt Toolkit.
   8 **
   9 ** $QT_BEGIN_LICENSE:LGPL$
  10 ** GNU Lesser General Public License Usage
  11 ** This file may be used under the terms of the GNU Lesser General Public
  12 ** License version 2.1 as published by the Free Software Foundation and
  13 ** appearing in the file LICENSE.LGPL included in the packaging of this
  14 ** file. Please review the following information to ensure the GNU Lesser
  15 ** General Public License version 2.1 requirements will be met:
  16 ** http://www.gnu.org/licenses/old-licenses/lgpl-2.1.html.
  17 **
  18 ** In addition, as a special exception, Nokia gives you certain additional
  19 ** rights. These rights are described in the Nokia Qt LGPL Exception
  20 ** version 1.1, included in the file LGPL_EXCEPTION.txt in this package.
  21 **
  22 ** GNU General Public License Usage
  23 ** Alternatively, this file may be used under the terms of the GNU General
  24 ** Public License version 3.0 as published by the Free Software Foundation
  25 ** and appearing in the file LICENSE.GPL included in the packaging of this
  26 ** file. Please review the following information to ensure the GNU General
  27 ** Public License version 3.0 requirements will be met:
  28 ** http://www.gnu.org/copyleft/gpl.html.
  29 **
  30 ** Other Usage
  31 ** Alternatively, this file may be used in accordance with the terms and
  32 ** conditions contained in a signed written agreement between you and Nokia.
  33 **
  34 **
  35 **
  36 **
  37 **
  38 ** $QT_END_LICENSE$
  39 **
  40 ****************************************************************************/
  41
  42 //
  43 //  W A R N I N G
  44 //  -------------
  45 //
  46 // This file is not part of the Qt API.  It exists purely as an
  47 // implementation detail.  This header file may change from version to
  48 // version without notice, or even be removed.
  49 //
  50 // We mean it.
  51
  52 #ifndef Patternist_TimezoneFNs_H
  53 #define Patternist_TimezoneFNs_H
  54
  55 #include <private/qatomiccomparator_p.h>
  56 #include <private/qfunctioncall_p.h>
  57
  58 /**
  59  * @file
  60  * @short Contains classes implementing the functions found in
  61  * <a href="http://www.w3.org/TR/xpath-functions/#timezone.functions">XQuery 1.0 and
  62  * XPath 2.0 Functions and Operators, 10.7 Timezone Adjustment on Dates and SchemaTime Values</a>.
  63  * @ingroup Patternist_functions
  64  */
  65
  66 QT_BEGIN_HEADER
  67
  68 QT_BEGIN_NAMESPACE
  69
  70 namespace QPatternist
  71 {
  72     /**
  73      * @short Base class for classes implementing functions changing the timezone
  74      * on values.
  75      *
  76      * It would be possible to implement this with the Curiously Recurring Template Pattern, in order
  77      * to avoid the virtual call dispatching that is done via createValue(). However, these are not
  78      * very hot code paths and evaluateSingleton() is quite large, which would lead to heavy code
  79      * expansion.
  80      *
  81      * @see <a href="http://en.wikipedia.org/wiki/Curiously_recurring_template_pattern">Curiously
  82      * Recurring Template Pattern, Wikipedia, the free encyclopedia</a>
  83      * @ingroup Patternist_functions
  84      * @author Frans Englich <frans.englich@nokia.com>
  85      */
  86     class AdjustTimezone : public FunctionCall
  87     {
  88     public:
  89         virtual Item evaluateSingleton(const DynamicContext::Ptr &context) const;
  90
  91     protected:
  92         virtual Item createValue(const QDateTime &dt) const = 0;
  93     };
  94
  95     /**
  96      * @short Implements the function <tt>fn:adjust-dateTime-to-timezone()</tt>.
  97      *
  98      * @ingroup Patternist_functions
  99      * @author Frans Englich <frans.englich@nokia.com>
 100      */
 101     class AdjustDateTimeToTimezoneFN : public AdjustTimezone
 102     {
 103     protected:
 104         virtual Item createValue(const QDateTime &dt) const;
 105     };
 106
 107     /**
 108      * @short Implements the function <tt>fn:adjust-dateTime-to-timezone()</tt>.
 109      *
 110      * @ingroup Patternist_functions
 111      * @author Frans Englich <frans.englich@nokia.com>
 112      */
 113     class AdjustDateToTimezoneFN : public AdjustTimezone
 114     {
 115     protected:
 116         virtual Item createValue(const QDateTime &dt) const;
 117     };
 118
 119     /**
 120      * @short Implements the function <tt>fn:adjust-time-to-timezone()</tt>.
 121      *
 122      * @ingroup Patternist_functions
 123      * @author Frans Englich <frans.englich@nokia.com>
 124      */
 125     class AdjustTimeToTimezoneFN : public AdjustTimezone
 126     {
 127     protected:
 128         virtual Item createValue(const QDateTime &dt) const;
 129     };
 130 }
 131
 132 QT_END_NAMESPACE
 133
 134 QT_END_HEADER
 135
 136 #endif