/* -*- Mode: C++; tab-width: 4; indent-tabs-mode: nil; c-basic-offset: 4 -*- */
/*
* This file is part of the LibreOffice project.
*
* This Source Code Form is subject to the terms of the Mozilla Public
* License, v. 2.0. If a copy of the MPL was not distributed with this
* file, You can obtain one at http://mozilla.org/MPL/2.0/.
*
* This file incorporates work covered by the following license notice:
*
* Licensed to the Apache Software Foundation (ASF) under one or more
* contributor license agreements. See the NOTICE file distributed
* with this work for additional information regarding copyright
* ownership. The ASF licenses this file to you under the Apache
* License, Version 2.0 (the "License"); you may not use this file
* except in compliance with the License. You may obtain a copy of
* the License at http://www.apache.org/licenses/LICENSE-2.0 .
*/
#ifndef INCLUDED_TOOLS_DATE_HXX
#define INCLUDED_TOOLS_DATE_HXX
#include <tools/toolsdllapi.h>
#include <com/sun/star/util/Date.hpp>
#include <com/sun/star/util/DateTime.hpp>
#include <sal/log.hxx>
enum DayOfWeek { MONDAY, TUESDAY, WEDNESDAY, THURSDAY, FRIDAY,
SATURDAY, SUNDAY };
// TODO FIXME: make it handle signed year?
class TOOLS_DLLPUBLIC SAL_WARN_UNUSED Date
{
private:
sal_uInt32 nDate;
void init( sal_uInt16 nDay, sal_uInt16 nMonth, sal_uInt16 nYear )
{ nDate = ( sal_uInt32( nDay % 100 ) ) +
( ( sal_uInt32( nMonth % 100 ) ) * 100 ) +
( ( sal_uInt32( nYear % 10000 ) ) * 10000); }
public:
enum DateInitSystem
{
SYSTEM
};
// TODO temporary until all uses are inspected and resolved
enum DateInitEmpty
{
EMPTY
};
Date( DateInitEmpty)
{ nDate = 0; }
Date( DateInitSystem );
Date( sal_uInt32 _nDate ) { Date::nDate = _nDate; }
Date( const Date& rDate )
{ nDate = rDate.nDate; }
Date( sal_uInt16 nDay, sal_uInt16 nMonth, sal_uInt16 nYear )
{ init(nDay, nMonth, nYear); }
Date( const ::com::sun::star::util::Date& _rDate )
{
SAL_WARN_IF(_rDate.Year < 0, "tools.datetime", "Negative year in css::util::Date to ::Date conversion");
init(_rDate.Day, _rDate.Month, _rDate.Year);
}
Date( const ::com::sun::star::util::DateTime& _rDateTime );
void SetDate( sal_uInt32 nNewDate ) { nDate = nNewDate; }
sal_uInt32 GetDate() const { return nDate; }
::com::sun::star::util::Date GetUNODate() const { return ::com::sun::star::util::Date(GetDay(), GetMonth(), GetYear()); }
void SetDay( sal_uInt16 nNewDay );
void SetMonth( sal_uInt16 nNewMonth );
void SetYear( sal_uInt16 nNewYear );
sal_uInt16 GetDay() const { return (sal_uInt16)(nDate % 100); }
sal_uInt16 GetMonth() const { return (sal_uInt16)((nDate / 100) % 100); }
sal_uInt16 GetYear() const { return (sal_uInt16)(nDate / 10000); }
/** Obtain the day of the week for the date.
Internally normalizes a copy of values.
The result may be unexpected for a non-normalized invalid date like
Date(31,11,2000) or a sequence of aDate.SetDay(31); aDate.SetMonth(11);
*/
DayOfWeek GetDayOfWeek() const;
/** Obtain the day of the year for the date.
Internally normalizes a copy of values.
The result may be unexpected for a non-normalized invalid date like
Date(31,11,2000) or a sequence of aDate.SetDay(31); aDate.SetMonth(11);
*/
sal_uInt16 GetDayOfYear() const;
/** Obtain the week of the year for a date.
@param nMinimumNumberOfDaysInWeek
How many days of a week must reside in the first week of a year.
Internally normalizes a copy of values.
The result may be unexpected for a non-normalized invalid date like
Date(31,11,2000) or a sequence of aDate.SetDay(31); aDate.SetMonth(11);
*/
sal_uInt16 GetWeekOfYear( DayOfWeek eStartDay = MONDAY,
sal_Int16 nMinimumNumberOfDaysInWeek = 4 ) const;
/** Obtain the number of days in the month of the year of the date.
Internally normalizes a copy of values.
The result may be unexpected for a non-normalized invalid date like
Date(31,11,2000) or a sequence of aDate.SetDay(31); aDate.SetMonth(11);
These would result in 31 as --11-31 rolls over to --12-01 and the
number of days in December is returned.
Instead, to obtain the value for the actual set use the static method
Date::GetDaysInMonth( aDate.GetMonth(), aDate.GetYear()) in such cases.
*/
sal_uInt16 GetDaysInMonth() const;
sal_uInt16 GetDaysInYear() const { return (IsLeapYear()) ? 366 : 365; }
bool IsLeapYear() const;
/** If the represented date is valid (1<=month<=12, 1<=day<=(28,29,30,31)
depending on month/year) AND is of the Gregorian calendar (1582-10-15
<= date) (AND implicitly date <= 9999-12-31 due to internal
representation) */
bool IsValidAndGregorian() const;
/** If the represented date is valid (1<=month<=12, 1<=day<=(28,29,30,31)
depending on month/year) */
bool IsValidDate() const;
/** Normalize date, invalid day or month values are adapted such that they
carry over to the next month or/and year, for example 1999-02-32
becomes 1999-03-04, 1999-13-01 becomes 2000-01-01, 1999-13-42 becomes
2000-02-11. Truncates at 9999-12-31, 0000-00-x will yield the
normalized value of 0000-01-max(1,(x-31))
This may be necessary after Date ctors or if the SetDate(), SetDay(),
SetMonth(), SetYear() methods set individual non-matching values.
Adding/subtracting to/from dates never produces invalid dates.
@returns TRUE if the date was normalized, i.e. not valid before.
*/
bool Normalize();
bool IsBetween( const Date& rFrom, const Date& rTo ) const
{ return ((nDate >= rFrom.nDate) &&
(nDate <= rTo.nDate)); }
bool operator ==( const Date& rDate ) const
{ return (nDate == rDate.nDate); }
bool operator !=( const Date& rDate ) const
{ return (nDate != rDate.nDate); }
bool operator >( const Date& rDate ) const
{ return (nDate > rDate.nDate); }
bool operator <( const Date& rDate ) const
{ return (nDate < rDate.nDate); }
bool operator >=( const Date& rDate ) const
{ return (nDate >= rDate.nDate); }
bool operator <=( const Date& rDate ) const
{ return (nDate <= rDate.nDate); }
Date& operator =( const Date& rDate )
{ nDate = rDate.nDate; return *this; }
Date& operator +=( long nDays );
Date& operator -=( long nDays );
Date& operator ++();
Date& operator --();
Date operator ++( int );
Date operator --( int );
TOOLS_DLLPUBLIC friend Date operator +( const Date& rDate, long nDays );
TOOLS_DLLPUBLIC friend Date operator -( const Date& rDate, long nDays );
TOOLS_DLLPUBLIC friend long operator -( const Date& rDate1, const Date& rDate2 );
/** Obtain number of days in a month of a year.
Internally sanitizes nMonth to values 1 <= nMonth <= 12, does not
normalize values.
*/
static sal_uInt16 GetDaysInMonth( sal_uInt16 nMonth, sal_uInt16 nYear );
/// Internally normalizes values.
static long DateToDays( sal_uInt16 nDay, sal_uInt16 nMonth, sal_uInt16 nYear );
/// Semantically identical to IsValidDate() member method.
static bool IsValidDate( sal_uInt16 nDay, sal_uInt16 nMonth, sal_uInt16 nYear );
/// Semantically identical to Normalize() member method.
static bool Normalize( sal_uInt16 & rDay, sal_uInt16 & rMonth, sal_uInt16 & rYear );
private:
/// An accelerated form of DateToDays on this date
long GetAsNormalizedDays() const;
};
#endif
/* vim:set shiftwidth=4 softtabstop=4 expandtab: */