karecurrence.h

/*
 *  karecurrence.h  -  recurrence with special yearly February 29th handling
 *  Program:  kalarm
 *  Copyright © 2005,2006 by David Jarvie <software@astrojar.org.uk>
 *
 *  This program is free software; you can redistribute it and/or modify
 *  it under the terms of the GNU General Public License as published by
 *  the Free Software Foundation; either version 2 of the License, or
 *  (at your option) any later version.
 *
 *  This program 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 General Public License for more details.
 *
 *  You should have received a copy of the GNU General Public License along
 *  with this program; if not, write to the Free Software Foundation, Inc.,
 *  51 Franklin Street, Fifth Floor, Boston, MA 02110-1301, USA.
 */
 
#ifndef KARECURRENCE_H
#define KARECURRENCE_H
 
#include <libkcal/recurrence.h>
class DateTime;
 
 
class KARecurrence : public KCal::Recurrence
{
    public:
        enum Type {
            NO_RECUR,      // does not recur
            MINUTELY,      // at an hours/minutes interval
            DAILY,         // daily
            WEEKLY,        // weekly, on specified weekdays
            MONTHLY_POS,   // monthly, on specified weekdays in a specified week of the month
            MONTHLY_DAY,   // monthly, on a specified day of the month
            ANNUAL_DATE,   // yearly, on a specified date in each of the specified months
            ANNUAL_POS     // yearly, on specified weekdays in the specified weeks of the specified months
        };
        enum Feb29Type {
            FEB29_FEB29,    // February 29th recurrences are omitted in non-leap years
            FEB29_MAR1,     // February 29th recurrences are on March 1st in non-leap years
            FEB29_FEB28     // February 29th recurrences are on February 28th in non-leap years
        };
 
        KARecurrence() : KCal::Recurrence(), mFeb29Type(FEB29_FEB29), mCachedType(-1) { }
        KARecurrence(const KCal::Recurrence& r) : KCal::Recurrence(r) { fix(); }
        KARecurrence(const KARecurrence& r) : KCal::Recurrence(r), mFeb29Type(r.mFeb29Type), mCachedType(r.mCachedType) { }
        bool        set(const TQString& icalRRULE);
        bool        set(Type t, int freq, int count, const DateTime& start, const TQDateTime& end)
                                { return set(t, freq, count, -1, start, end); }
        bool        set(Type t, int freq, int count, const DateTime& start, const TQDateTime& end, Feb29Type f29)
                                { return set(t, freq, count, f29, start, end); }
        bool        init(KCal::RecurrenceRule::PeriodType t, int freq, int count, const DateTime& start, const TQDateTime& end)
                                { return init(t, freq, count, -1, start, end); }
        bool        init(KCal::RecurrenceRule::PeriodType t, int freq, int count, const DateTime& start, const TQDateTime& end, Feb29Type f29)
                                { return init(t, freq, count, f29, start, end); }
        void        fix();
        void        writeRecurrence(KCal::Recurrence&) const;
        TQDateTime  endDateTime() const;
        TQDate      endDate() const;
        bool        recursOn(const TQDate&) const;
        TQDateTime  getNextDateTime(const TQDateTime& preDateTime) const;
        TQDateTime  getPreviousDateTime(const TQDateTime& afterDateTime) const;
        int         longestInterval() const;
        Type        type() const;
        static Type type(const KCal::RecurrenceRule*);
        static bool dailyType(const KCal::RecurrenceRule*);
        Feb29Type   feb29Type() const                 { return mFeb29Type; }
        static Feb29Type defaultFeb29Type()           { return mDefaultFeb29; }
        static void setDefaultFeb29Type(Feb29Type t)  { mDefaultFeb29 = t; }
 
    private:
        bool        set(Type, int freq, int count, int feb29Type, const DateTime& start, const TQDateTime& end);
        bool        init(KCal::RecurrenceRule::PeriodType, int freq, int count, int feb29Type, const DateTime& start, const TQDateTime& end);
        int         combineDurations(const KCal::RecurrenceRule*, const KCal::RecurrenceRule*, TQDate& end) const;
        int         longestWeeklyInterval(const TQBitArray& days, int frequency);
 
        static Feb29Type mDefaultFeb29;
        Feb29Type   mFeb29Type;       // yearly recurrence on Feb 29th (leap years) / Mar 1st (non-leap years)
        mutable int mCachedType;
};
 
#endif // KARECURRENCE_H