tzdata.h

Go to the documentation of this file.

//
// C++ Interface: TZ Data
//
// Description: Time Zone Calculator
//
//
// Author: Konrad Rosenbaum <konrad@silmor.de>, (C) 2010
//
// Copyright: See README/COPYING files that come with this distribution
//
//

#ifndef TIME_ZONE_DATA_H
#define TIME_ZONE_DATA_H

#include <QDate>
#include <QDateTime>
#include <QString>
#include <QTime>


#if defined(TZ_LIBRARY_BUILD)
#  define TZLIB_EXPORT Q_DECL_EXPORT
#else
#  define TZLIB_EXPORT Q_DECL_IMPORT
#endif


namespace TimeZoneLib {class TZFile;}

class TZLIB_EXPORT TimeStamp
{
        public:
                enum WeekDay{
                        Sunday=0,
                        Monday=1,
                        Tuesday=2,
                        Wednesday=3,
                        Thursday=4,
                        Friday=5,
                        Saturday=6
                };

                TimeStamp();
                
                TimeStamp(qint64 ts,bool isLocal=true);
                TimeStamp(qint64 ts,QString zone);
                TimeStamp(qint64 ts,quint16 msec,bool isLocal=true);
                TimeStamp(qint64 ts,quint16 msec,QString zone);
                
                TimeStamp(const QDate&,bool isLocal=true);
                TimeStamp(const QDate&,QString);
                
                TimeStamp(const QTime&,bool isLocal=true);
                TimeStamp(const QTime&,QString);
                
                TimeStamp(const QDateTime&ts);
                TimeStamp(const QDateTime&ts,bool isLocal);
                TimeStamp(const QDateTime&ts,QString zone);
                
                TimeStamp(const TimeStamp&);
                TimeStamp& operator=(const TimeStamp&);
                
                bool setZone(QString);
                
                void setLocal(){setZone(defaultZone());}
                
                void setUTC(){setZone("UTC");}
                
                bool moveToZone(QString);
                
                void moveToUTC(){moveToZone("UTC");}
                
                void moveToLocal(){moveToZone(defaultZone());}
                
                QString zone()const{return m_zone;}
                
                TimeStamp toUTC()const{return TimeStamp(m_unix,m_msec,false);}
                
                TimeStamp toLocal()const{return TimeStamp(m_unix,m_msec,true);}
                
                TimeStamp toZone(QString zone)const{return TimeStamp(m_unix,m_msec,zone);}
                
                QDate toDate()const{return QDate(m_year,m_month,m_day);}
                operator QDate()const{return QDate(m_year,m_month,m_day);}
                
                QTime toTime()const{return QTime(m_hour,m_min,m_sec,m_msec);}
                operator QTime()const{return QTime(m_hour,m_min,m_sec,m_msec);}
                
                QDateTime toDateTime()const;
                operator QDateTime()const{return toDateTime();}
                
                QDateTime toSystemDateTimeUTC()const{return toUTC().toDateTime();}
                QDateTime toSystemDateTime()const{return toSystemDateTimeUTC().toLocalTime();}
                
                void addMSecs(int msec);
                
                void addSecs(int sec);
                
                void addDays(int d);
                
                qint64 toUnix()const{return m_unix;}
                
                qint16 year()const{return m_year;}
                quint8 month()const{return m_month;}
                quint8 day()const{return m_day;}
                quint8 hour()const{return m_hour;}
                quint8 minute()const{return m_min;}
                quint8 second()const{return m_sec;}
                quint16 msecs()const{return m_msec;}
                
                WeekDay weekDay()const;
                
                QString zoneAbbreviation()const;
                
                QString toISO()const;
                
                
                qint32 offsetFromUTC()const{return m_off;}
                
                bool operator==(const TimeStamp&ts)const
                 {return m_unix==ts.m_unix && m_msec==ts.m_msec;}
                bool operator!=(const TimeStamp&ts)const
                 {return m_unix!=ts.m_unix || m_msec!=ts.m_msec;}
                
                bool operator<(const TimeStamp&ts)const
                 {return m_unix<ts.m_unix || (m_unix==ts.m_unix && m_msec<ts.m_msec);}
                bool operator<=(const TimeStamp&ts)const
                 {return m_unix<ts.m_unix || (m_unix==ts.m_unix && m_msec<=ts.m_msec);}

                bool operator>(const TimeStamp&ts)const
                 {return m_unix>ts.m_unix || (m_unix==ts.m_unix && m_msec>ts.m_msec);}
                bool operator>=(const TimeStamp&ts)const
                 {return m_unix>ts.m_unix || (m_unix==ts.m_unix && m_msec>=ts.m_msec);}
                
                // /////////////////////////////////////////////////////////////
                // statics
                static TimeStamp fromDate(int year,quint8 month,quint8 day,bool isLocal=true)
                 {return TimeStamp(QDate(year,month,day),isLocal);}
                static TimeStamp fromDate(QDate dt,bool isLocal=true)
                 {return TimeStamp(dt,isLocal);}
                static TimeStamp fromDate(int year,quint8 month,quint8 day,QString zone)
                 {return TimeStamp(QDate(year,month,day),zone);}
                static TimeStamp fromDate(QDate dt,QString zone)
                 {return TimeStamp(dt,zone);}
                
                static TimeStamp fromTime(quint8 hour,quint8 minute,bool isLocal=true)
                 {return TimeStamp(QTime(hour,minute),isLocal);}
                static TimeStamp fromTime(quint8 hour,quint8 minute,quint8 second,bool isLocal=true)
                 {return TimeStamp(QTime(hour,minute,second),isLocal);}
                static TimeStamp fromTime(quint8 hour,quint8 minute,QString zone)
                 {return TimeStamp(QTime(hour,minute),zone);}
                static TimeStamp fromTime(quint8 hour,quint8 minute,quint8 second,QString zone)
                 {return TimeStamp(QTime(hour,minute,second),zone);}
                static TimeStamp fromTime(QTime tm,bool isLocal=true)
                 {return TimeStamp(tm,isLocal);}
                static TimeStamp fromTime(QTime tm,QString zone)
                 {return TimeStamp(tm,zone);}

                static TimeStamp fromDateTime(QDateTime dt)
                 {return TimeStamp(dt);}
                static TimeStamp fromDateTime(QDateTime dt,bool isLocal)
                 {return TimeStamp(dt,isLocal);}
                static TimeStamp fromDateTime(QDateTime dt,QString zone)
                 {return TimeStamp(dt,zone);}

                static TimeStamp fromDateTime(QDate dt,QTime tm)
                 {return TimeStamp(QDateTime(dt,tm));}
                static TimeStamp fromDateTime(QDate dt,QTime tm,bool isLocal)
                 {return TimeStamp(QDateTime(dt,tm),isLocal);}
                static TimeStamp fromDateTime(QDate dt,QTime tm,QString zone)
                 {return TimeStamp(QDateTime(dt,tm),zone);}

                static TimeStamp fromDateTime(int year,quint8 month,quint8 day,quint8 hour,quint8 minute,bool isLocal=true)
                 {return fromDateTime(QDate(year,month,day),QTime(hour,minute),isLocal);}
                static TimeStamp fromDateTime(int year,quint8 month,quint8 day,quint8 hour,quint8 minute,quint8 second,bool isLocal=true)
                 {return fromDateTime(QDate(year,month,day),QTime(hour,minute,second),isLocal);}

                static TimeStamp now(QString zone){return TimeStamp(QDateTime::currentDateTime().toTime_t(),zone);}
                static TimeStamp now(bool isLocal=true){return TimeStamp(QDateTime::currentDateTime().toTime_t(),isLocal);}
                
                static void setSearchPath(const QStringList&);
                
                static void resetRepository();
                
                static bool setDefaultZone(QString zone);
                
                static QString defaultZone();
                
                static void storeDefaultZone();
                
                static void forgetDefaultZone();
                
                static bool loadZone(QString zone);
                
                static QString systemLocalZone();
                
                TimeZoneLib::TZFile zoneFile()const;
                
                static TimeZoneLib::TZFile defaultZoneFile();
                
                static TimeZoneLib::TZFile systemLocalZoneFile();
                
        private:
                //the main measure of time: the unix timestamp
                qint64 m_unix;
                //milliseconds beyond that time
                quint16 m_msec;
                //the time zone
                QString m_zone;
                //cache values to make calculations easier
                qint16 m_year;
                qint32 m_off;
                quint8 m_month,m_day,m_hour,m_min,m_sec;
                
                void recalcToCached();
                
                void recalcToUnix();
};



#endif