1 /**************************************************************************** 2 ** 3 ** Copyright (C) 2015 The Qt Company Ltd. 4 ** Contact: http://www.qt.io/licensing/ 5 ** 6 ** This file is part of the QtXmlPatterns module of the Qt Toolkit. 7 ** 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 The Qt Company. For licensing terms 14 ** and conditions see http://www.qt.io/terms-conditions. For further 15 ** information use the contact form at http://www.qt.io/contact-us. 16 ** 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 or version 3 as published by the Free 20 ** Software Foundation and appearing in the file LICENSE.LGPLv21 and 21 ** LICENSE.LGPLv3 included in the packaging of this file. Please review the 22 ** following information to ensure the GNU Lesser General Public License 23 ** requirements will be met: https://www.gnu.org/licenses/lgpl.html and 24 ** http://www.gnu.org/licenses/old-licenses/lgpl-2.1.html. 25 ** 26 ** As a special exception, The Qt Company gives you certain additional 27 ** rights. These rights are described in The Qt Company LGPL Exception 28 ** version 1.1, included in the file LGPL_EXCEPTION.txt in this package. 29 ** 30 ** GNU General Public License Usage 31 ** Alternatively, this file may be used under the terms of the GNU 32 ** General Public License version 3.0 as published by the Free Software 33 ** Foundation and appearing in the file LICENSE.GPL included in the 34 ** packaging of this file. Please review the following information to 35 ** ensure the GNU General Public License version 3.0 requirements will be 36 ** met: http://www.gnu.org/copyleft/gpl.html. 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_AbstractDuration_H 53 #define Patternist_AbstractDuration_H 54 55 #include <QRegExp> 56 57 #include "qitem_p.h" 58 59 QT_BEGIN_HEADER 60 61 QT_BEGIN_NAMESPACE 62 63 namespace QPatternist 64 { 65 /** 66 * @short Base class for classes implementing durations. 67 * 68 * @see <a href="http://www.w3.org/TR/xmlschema-2/#duration">XML Schema Part 69 * 2: Datatypes Second Edition, 3.2.6 duration</a> 70 * @see <a href="http://www.w3.org/TR/xpath-datamodel/#dates-and-times">XQuery 71 * 1.0 and XPath 2.0 Data Model (XDM), 3.3.2 Dates and Times</a> 72 * @author Frans Englich <frans.englich@nokia.com> 73 * @ingroup Patternist_xdm 74 * @todo Documentation is missing/incomplete 75 */ 76 class AbstractDuration : public AtomicValue 77 { 78 public: 79 typedef QExplicitlySharedDataPointer<AbstractDuration> Ptr; 80 81 /** 82 * @short The amount in milli seconds. 83 */ 84 typedef qint64 Value; 85 86 /** 87 * @short Acts as a mapping table for AbstractDuration::create() 88 * and describes where certain fields in a QRegExp pattern can be found 89 * for a particular W3C XML Schema duration type. 90 * 91 * @author Frans Englich <frans.englich@nokia.com> 92 * @ingroup Patternist_xdm 93 */ 94 class CaptureTable 95 { 96 public: 97 CaptureTable(const QRegExp &exp, 98 const qint8 yearP, 99 const qint8 monthP, 100 const qint8 dayP = -1, 101 const qint8 tDelimiterP = -1, 102 const qint8 hourP = -1, 103 const qint8 minutesP = -1, 104 const qint8 secondsP = -1, regExp(exp)105 const qint8 msecondsP = -1) : regExp(exp), 106 year(yearP), 107 month(monthP), 108 day(dayP), 109 tDelimiter(tDelimiterP), 110 hour(hourP), 111 minutes(minutesP), 112 seconds(secondsP), 113 mseconds(msecondsP) 114 { 115 Q_ASSERT(exp.isValid()); 116 Q_ASSERT(yearP == -1 || yearP == 2); 117 } 118 119 const QRegExp regExp; 120 const qint8 year; 121 const qint8 month; 122 const qint8 day; 123 const qint8 tDelimiter; 124 const qint8 hour; 125 const qint8 minutes; 126 const qint8 seconds; 127 const qint8 mseconds; 128 }; 129 130 /** 131 * Determines whether this Duration is equal to @p other. 132 * 133 * @note Do not re-implement this function. It uses getters such as years() and 134 * mseconds() for determining its truth value. 135 */ 136 bool operator==(const AbstractDuration &other) const; 137 138 virtual YearProperty years() const = 0; 139 virtual MonthProperty months() const = 0; 140 virtual DayCountProperty days() const = 0; 141 virtual HourProperty hours() const = 0; 142 virtual MinuteProperty minutes() const = 0; 143 virtual SecondProperty seconds() const = 0; 144 virtual MSecondProperty mseconds() const = 0; 145 146 /** 147 * @returns the value of this AbstractDuration. For example, 148 * in the case of xs:yearMonthDuration, that is YearMonthDuration, 149 * years times twelve plus the months is returned. 150 */ 151 virtual Value value() const = 0; 152 153 /** 154 * A polymorphic factory function that returns instances of the 155 * sub-class with the value @p val. 156 */ 157 virtual Item fromValue(const Value val) const = 0; 158 159 /** 160 * Determines whether this AbstractDuration is positive. For example, 161 * "P10H" is positive, while "-P10H" is not. 162 * 163 * @note Do not re-implement this function. Use the constructor, AbstractDuration(), 164 * for changing the value. 165 * @returns @c true if this AbstractDuration is positive, otherwise @c false. 166 */ 167 bool isPositive() const; 168 169 protected: 170 171 AbstractDuration(const bool isPos); 172 173 static QString serializeMSeconds(const MSecondProperty mseconds); 174 static AtomicValue::Ptr create(const CaptureTable &captTable, 175 const QString &lexical, 176 bool *isPositive, 177 YearProperty *years, 178 MonthProperty *months, 179 DayCountProperty *days, 180 HourProperty *hours, 181 MinuteProperty *minutes, 182 SecondProperty *seconds, 183 MSecondProperty *mseconds); 184 const bool m_isPositive; 185 }; 186 } 187 188 QT_END_NAMESPACE 189 190 QT_END_HEADER 191 192 #endif 193