icaltimezones.h

/*
  This file is part of the kcalcore library.

  Copyright (c) 2005-2007 David Jarvie <djarvie@kde.org>

  This library is free software; you can redistribute it and/or
  modify it under the terms of the GNU Library General Public
  License as published by the Free Software Foundation; either
  version 2 of the License, or (at your option) any later version.

  This library is distributed in the hope that it will be useful,
  but WITHOUT ANY WARRANTY; without even the implied warranty of
  MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the GNU
  Library General Public License for more details.

  You should have received a copy of the GNU Library General Public License
  along with this library; see the file COPYING.LIB.  If not, write to
  the Free Software Foundation, Inc., 51 Franklin Street, Fifth Floor,
  Boston, MA 02110-1301, USA.
*/
#ifndef KCALCORE_ICALTIMEZONES_H
#define KCALCORE_ICALTIMEZONES_H

#include "kcalcore_export.h"

#include <KDE/KTimeZone>

#include <QtCore/QMap>

#ifndef ICALCOMPONENT_H
typedef struct icalcomponent_impl icalcomponent;
#endif
#ifndef ICALTIMEZONE_DEFINED
#define ICALTIMEZONE_DEFINED
typedef struct _icaltimezone  icaltimezone;
#endif

namespace KCalCore {

class ICalTimeZone;
class ICalTimeZoneSource;
class ICalTimeZoneData;
class ICalTimeZonesPrivate;
class ICalTimeZonePrivate;
class ICalTimeZoneSourcePrivate;
class ICalTimeZoneDataPrivate;

class KCALCORE_EXPORT ICalTimeZones
{
public:
    ICalTimeZones();

    ICalTimeZones(const ICalTimeZones &rhs);

    ICalTimeZones &operator=(const ICalTimeZones &rhs);

    ~ICalTimeZones();

    ICalTimeZone zone(const QString &name) const;

    ICalTimeZone zone(const ICalTimeZone &zone) const;

    typedef QMap<QString, ICalTimeZone> ZoneMap;

    const ZoneMap zones() const;

    bool add(const ICalTimeZone &zone);

    ICalTimeZone remove(const ICalTimeZone &zone);

    ICalTimeZone remove(const QString &name);

    void clear();

    int count();

private:
    //@cond PRIVATE
    ICalTimeZonesPrivate *const d;
    //@endcond
};

class KCALCORE_EXPORT ICalTimeZone : public KTimeZone //krazy:exclude=dpointer
    //(no d-pointer for KTimeZone derived classes)
{
public:
    ICalTimeZone();

    ICalTimeZone(ICalTimeZoneSource *source, const QString &name, ICalTimeZoneData *data);

    explicit ICalTimeZone(const KTimeZone &tz, const QDate &earliest = QDate());

    virtual ~ICalTimeZone();

    QString city() const;

    QByteArray url() const;

    QDateTime lastModified() const;

    QByteArray vtimezone() const;

    icaltimezone *icalTimezone() const;

    bool update(const ICalTimeZone &other);

    static ICalTimeZone utc();

protected:
    virtual void virtual_hook(int id, void *data);

private:
    // d-pointer is in ICalTimeZoneBackend.
    // This is a requirement for classes inherited from KTimeZone.
};

class KCALCORE_EXPORT ICalTimeZoneBackend : public KTimeZoneBackend
{
public:
    ICalTimeZoneBackend();
    ICalTimeZoneBackend(ICalTimeZoneSource *source, const QString &name,
                        const QString &countryCode = QString(),
                        float latitude = KTimeZone::UNKNOWN,
                        float longitude = KTimeZone::UNKNOWN,
                        const QString &comment = QString());

    ICalTimeZoneBackend(const KTimeZone &tz, const QDate &earliest);

    virtual ~ICalTimeZoneBackend();

    virtual KTimeZoneBackend *clone() const;

    virtual QByteArray type() const;

    virtual bool hasTransitions(const KTimeZone *caller) const;

protected:
    virtual void virtual_hook(int id, void *data);

private:
    //@cond PRIVATE
    ICalTimeZonePrivate *d; //krazy:exclude=dpointer
    //(non-const d-pointer for KTimeZoneBackend-derived classes)
    //@endcond
};

typedef struct _MSSystemTime {
    qint16 wYear;
    qint16 wMonth;
    qint16 wDayOfWeek;
    qint16 wDay;
    qint16 wHour;
    qint16 wMinute;
    qint16 wSecond;
    qint16 wMilliseconds;
} MSSystemTime;

typedef struct _MSTimeZone {
    long         Bias;
    QString      StandardName;
    MSSystemTime StandardDate;
    long         StandardBias;
    QString      DaylightName;
    MSSystemTime DaylightDate;
    long         DaylightBias;
} MSTimeZone;

class KCALCORE_EXPORT ICalTimeZoneSource : public KTimeZoneSource
{
public:
    ICalTimeZoneSource();

    virtual ~ICalTimeZoneSource();

    ICalTimeZone parse(icalcomponent *vtimezone);

    bool parse(icalcomponent *calendar, ICalTimeZones &zones);

    ICalTimeZone parse(MSTimeZone *tz);

    ICalTimeZone parse(MSTimeZone *tz, ICalTimeZones &zones);

    ICalTimeZone parse(const QString &name, const QStringList &tzList, ICalTimeZones &zones);

    ICalTimeZone parse(const QString &name, const QStringList &tzList);

    bool parse(const QString &fileName, ICalTimeZones &zones);

    ICalTimeZone parse(icaltimezone *tz);

    ICalTimeZone standardZone(const QString &zone, bool icalBuiltIn = false);

    static QByteArray icalTzidPrefix();

    using KTimeZoneSource::parse; // prevent warning about hidden virtual method

protected:
    virtual void virtual_hook(int id, void *data);

private:
    //@cond PRIVATE
    ICalTimeZoneSourcePrivate *const d;
    //@endcond
};

class KCALCORE_EXPORT ICalTimeZoneData : public KTimeZoneData
{
    friend class ICalTimeZoneSource;

public:
    ICalTimeZoneData();

    ICalTimeZoneData(const ICalTimeZoneData &rhs);

    ICalTimeZoneData(const KTimeZoneData &rhs, const KTimeZone &tz, const QDate &earliest);

    virtual ~ICalTimeZoneData();

    ICalTimeZoneData &operator=(const ICalTimeZoneData &rhs);

    virtual KTimeZoneData *clone() const;

    QString city() const;

    QByteArray url() const;

    QDateTime lastModified() const;

    QByteArray vtimezone() const;

    icaltimezone *icalTimezone() const;

    virtual bool hasTransitions() const;

protected:
    virtual void virtual_hook(int id, void *data);

private:
    //@cond PRIVATE
    ICalTimeZoneDataPrivate *const d;
    //@endcond
};

}

#endif