recurrencerule.h

/*
  This file is part of the kcalcore library.

  Copyright (c) 1998 Preston Brown <[email protected]>
  Copyright (c) 2001,2003 Cornelius Schumacher <[email protected]>
  Copyright (c) 2002,2006,2007 David Jarvie <[email protected]>
  Copyright (c) 2005, Reinhold Kainhofer <[email protected]>

  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_RECURRENCERULE_H
#define KCALCORE_RECURRENCERULE_H

#include "kcalendarcore_export.h"

#include <QDateTime>
#include <QTimeZone>

class QTimeZone;

namespace KCalendarCore {
// These two are duplicates wrt. incidencebase.h
typedef QList<QDate> DateList;
/* List of times */
typedef QList<QTime> TimeList;

class KCALENDARCORE_EXPORT RecurrenceRule
{
public:
    class RuleObserver
    {
    public:
        virtual ~RuleObserver();
        virtual void recurrenceChanged(RecurrenceRule *) = 0;
    };
    typedef QList<RecurrenceRule *> List;

    enum PeriodType {
        rNone = 0,
        rSecondly,
        rMinutely,
        rHourly,
        rDaily,
        rWeekly,
        rMonthly,
        rYearly
    };

    class KCALENDARCORE_EXPORT WDayPos //krazy:exclude=dpointer
    {
    public:
        explicit WDayPos(int ps = 0, short dy = 0);
        void setDay(short dy);
        short day() const;
        void setPos(int ps);
        int pos() const;

        bool operator==(const RecurrenceRule::WDayPos &pos2) const;
        bool operator!=(const RecurrenceRule::WDayPos &pos2) const;

    protected:
        short mDay; // Weekday, 1=monday, 7=sunday
        int mPos;   // week of the day (-1 for last, 1 for first, 0 for all weeks)
        // Bounded by -366 and +366, 0 means all weeks in that period

        friend KCALENDARCORE_EXPORT QDataStream &operator<<(QDataStream &out, const KCalendarCore::RecurrenceRule::WDayPos &);
        friend KCALENDARCORE_EXPORT QDataStream &operator>>(QDataStream &in, KCalendarCore::RecurrenceRule::WDayPos &);
    };

    RecurrenceRule();
    RecurrenceRule(const RecurrenceRule &r);
    ~RecurrenceRule();

    bool operator==(const RecurrenceRule &r) const;
    bool operator!=(const RecurrenceRule &r) const
    {
        return !operator==(r);
    }

    RecurrenceRule &operator=(const RecurrenceRule &r);

    void setReadOnly(bool readOnly);

    Q_REQUIRED_RESULT bool isReadOnly() const;

    Q_REQUIRED_RESULT bool recurs() const;
    void setRecurrenceType(PeriodType period);
    Q_REQUIRED_RESULT PeriodType recurrenceType() const;

    void clear();

    Q_REQUIRED_RESULT uint frequency() const;

    void setFrequency(int freq);

    Q_REQUIRED_RESULT QDateTime startDt() const;

    void setStartDt(const QDateTime &start);

    Q_REQUIRED_RESULT bool allDay() const;

    void setAllDay(bool allDay);

    Q_REQUIRED_RESULT QDateTime endDt(bool *result = nullptr) const;

    void setEndDt(const QDateTime &endDateTime);

    Q_REQUIRED_RESULT int duration() const;

    void setDuration(int duration);

    Q_REQUIRED_RESULT int durationTo(const QDateTime &dt) const;

    Q_REQUIRED_RESULT int durationTo(const QDate &date) const;

    void shiftTimes(const QTimeZone &oldTz, const QTimeZone &newTz);

    Q_REQUIRED_RESULT bool recursOn(const QDate &date, const QTimeZone &timeZone) const;

    Q_REQUIRED_RESULT bool recursAt(const QDateTime &dt) const;

    Q_REQUIRED_RESULT bool dateMatchesRules(const QDateTime &dt) const;

    Q_REQUIRED_RESULT TimeList recurTimesOn(const QDate &date, const QTimeZone &timeZone) const;

    Q_REQUIRED_RESULT QList<QDateTime> timesInInterval(const QDateTime &start, const QDateTime &end) const;

    Q_REQUIRED_RESULT QDateTime getNextDate(const QDateTime &preDateTime) const;

    Q_REQUIRED_RESULT QDateTime getPreviousDate(const QDateTime &afterDateTime) const;

    void setBySeconds(const QList<int> &bySeconds);
    void setByMinutes(const QList<int> &byMinutes);
    void setByHours(const QList<int> &byHours);

    void setByDays(const QList<WDayPos> &byDays);
    void setByMonthDays(const QList<int> &byMonthDays);
    void setByYearDays(const QList<int> &byYearDays);
    void setByWeekNumbers(const QList<int> &byWeekNumbers);
    void setByMonths(const QList<int> &byMonths);
    void setBySetPos(const QList<int> &bySetPos);
    void setWeekStart(short weekStart);

    const QList<int> &bySeconds() const;
    const QList<int> &byMinutes() const;
    const QList<int> &byHours() const;

    const QList<WDayPos> &byDays() const;
    const QList<int> &byMonthDays() const;
    const QList<int> &byYearDays() const;
    const QList<int> &byWeekNumbers() const;
    const QList<int> &byMonths() const;
    const QList<int> &bySetPos() const;
    short weekStart() const;

    void setRRule(const QString &rrule);
    Q_REQUIRED_RESULT QString rrule() const;

    void setDirty();
    void addObserver(RuleObserver *observer);

    void removeObserver(RuleObserver *observer);

    void dump() const;

private:
    //@cond PRIVATE
    class Private;
    Private *const d;
    //@endcond

    friend KCALENDARCORE_EXPORT QDataStream &operator<<(QDataStream &out, const KCalendarCore::RecurrenceRule *);
    friend KCALENDARCORE_EXPORT QDataStream &operator>>(QDataStream &in, const KCalendarCore::RecurrenceRule *);
};

KCALENDARCORE_EXPORT QDataStream &operator<<(QDataStream &out, const KCalendarCore::RecurrenceRule *);
KCALENDARCORE_EXPORT QDataStream &operator>>(QDataStream &in, const KCalendarCore::RecurrenceRule *);

KCALENDARCORE_EXPORT QDataStream &operator<<(QDataStream &out, const KCalendarCore::RecurrenceRule::WDayPos &);
KCALENDARCORE_EXPORT QDataStream &operator>>(QDataStream &in, KCalendarCore::RecurrenceRule::WDayPos &);
}

Q_DECLARE_TYPEINFO(KCalendarCore::RecurrenceRule::WDayPos, Q_MOVABLE_TYPE);

#endif