utimer.hpp

/************************************************************************
 *
 *  utimer.hpp
 *  Ubit GUI Toolkit - Version 6
 *  (C) 2009 | Eric Lecolinet | TELECOM ParisTech | http://www.enst.fr/~elc/ubit
 *
 * ***********************************************************************
 * COPYRIGHT NOTICE : 
 * THIS PROGRAM IS DISTRIBUTED WITHOUT ANY WARRANTY AND WITHOUT EVEN THE 
 * IMPLIED WARRANTY OF MERCHANTABILITY OR FITNESS FOR A PARTICULAR PURPOSE. 
 * 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.
 * SEE FILES 'COPYRIGHT' AND 'COPYING' FOR MORE DETAILS.
 * ***********************************************************************/

#ifndef _utimer_hpp_
#define _utimer_hpp_ 1

extern "C" {
  struct timeval;
}

#include <ubit/uobject.hpp>
namespace ubit {
  
  class UTimer : public UNode {
  public:
    UCLASS(UTimer)
    
    UTimer(bool auto_delete = true);
    UTimer(unsigned long delay, int ntimes, bool auto_delete = true);
    virtual ~UTimer();
    
    virtual void onAction(UCall& callback);
    virtual void onTimeout(UCall& callback) {onAction(callback);}
    
    virtual void start();
    virtual void start(unsigned long delay, int ntimes);
    virtual void stop();
    unsigned long getDelay() const {return delay;}
    
    void setDelay(unsigned long time);
    
    bool isRunning() const {return is_running;}
    
    // - impl - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
#ifndef NO_DOC
    
    int getTimerNo() const {return timer_no;}
    bool timerCB();
    
  private:
    friend class UAppli;
    friend class UAppliImpl;
    friend class UTimerImpl;
    bool auto_delete, is_running, is_looping;
    int  timer_no, ntimes; 
    unsigned long delay;
    
    void removeTimer();
    
#if UBIT_WITH_X11
    struct timeval& timeout;
#elif UBIT_WITH_GDK
    unsigned int gid;  // timer ID when GDK is used
#endif
#endif
  };
  
  // - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
  
  class UTimerImpl {
  public:
    static unsigned long getTime();
    static void getTime(timeval& time);
    static void minTime(struct timeval& mintime, struct timeval& time);
    static void addTime(struct timeval& time, unsigned long millisec_delay);
    static bool lessTime(struct timeval& time, struct timeval& t2);
    
    bool resetTimers(struct timeval& delay);
    void fireTimers();
    
    typedef std::vector<UTimer*> Timers;
    Timers timers;
  };
  
}
#endif