synchtimer.h

/*
 *  synchtimer.h  -  timers which synchronise to time boundaries
 *  Program:  kalarm
 *  Copyright (C) 2004, 2005 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 SYNCHTIMER_H
#define SYNCHTIMER_H
 
/* @file synchtimer.h - timers which synchronise to time boundaries */
 
#include <tqobject.h>
#include <tqvaluelist.h>
#include <tqcstring.h>
#include <tqdatetime.h>
class TQTimer;
 
class SynchTimer : public TQObject
{
        TQ_OBJECT
  
    public:
        virtual ~SynchTimer();
 
        struct Connection
        {
            Connection() { }
            Connection(TQObject* r, const char* s) : receiver(r), slot(s) { }
            bool operator==(const Connection& c) const  { return receiver == c.receiver && slot == c.slot; }
            TQObject*       receiver;
            const TQCString slot;
        };
    protected:
        SynchTimer();
        virtual void        start() = 0;
        void                connecT(TQObject* receiver, const char* member);
        void                disconnecT(TQObject* receiver, const char* member = 0);
        bool                hasConnections() const   { return !mConnections.isEmpty(); }
 
        TQTimer*             mTimer;
 
    protected slots:
        virtual void        slotTimer() = 0;
 
    private slots:
        void                slotReceiverGone(TQObject* r)  { disconnecT(r); }
 
    private:
        SynchTimer(const SynchTimer&);   // prohibit copying
        TQValueList<Connection> mConnections;  // list of current clients
};
 
 
class MinuteTimer : public SynchTimer
{
        TQ_OBJECT
  
    public:
        virtual ~MinuteTimer()  { mInstance = 0; }
        static void connect(TQObject* receiver, const char* member)
                           { instance()->connecT(receiver, member); }
        static void disconnect(TQObject* receiver, const char* member = 0)
                           { if (mInstance) mInstance->disconnecT(receiver, member); }
 
    protected:
        MinuteTimer() : SynchTimer() { }
        static MinuteTimer* instance();
        virtual void        start()    { slotTimer(); }
 
    protected slots:
        virtual void slotTimer();
 
    private:
        static MinuteTimer* mInstance;     // the one and only instance
};
 
 
class DailyTimer : public SynchTimer
{
        TQ_OBJECT
  
    public:
        virtual ~DailyTimer();
        static void connect(const TQTime& timeOfDay, TQObject* receiver, const char* member)
                           { fixedInstance(timeOfDay)->connecT(receiver, member); }
        static void disconnect(const TQTime& timeOfDay, TQObject* receiver, const char* member = 0);
        void changeTime(const TQTime& newTimeOfDay, bool triggerMissed = true);
        TQTime timeOfDay() const  { return mTime; }
 
    protected:
        DailyTimer(const TQTime&, bool fixed);
        static DailyTimer* fixedInstance(const TQTime& timeOfDay, bool create = true);
        virtual void start();
 
    protected slots:
        virtual void slotTimer();
 
    private:
        static TQValueList<DailyTimer*>  mFixedTimers;   // list of timers whose trigger time is fixed
        TQTime  mTime;
        TQDate  mLastDate;  // the date on which the timer was last triggered
        bool   mFixed;     // the time at which the timer triggers cannot be changed
};
 
 
class MidnightTimer
{
    public:
        static void connect(TQObject* receiver, const char* member)
                           { DailyTimer::connect(TQTime(0,0), receiver, member); }
        static void disconnect(TQObject* receiver, const char* member = 0)
                           { DailyTimer::disconnect(TQTime(0,0), receiver, member); }
 
};
 
#endif // SYNCHTIMER_H