src/Timer.h

   1 // Timer.h for Openbox
   2 // Copyright (c) 2001 Sean 'Shaleh' Perry <shaleh@debian.org>
   3 // Copyright (c) 1997 - 2000 Brad Hughes (bhughes@tcac.net)
   4 //
   5 // Permission is hereby granted, free of charge, to any person obtaining a
   6 // copy of this software and associated documentation files (the "Software"),
   7 // to deal in the Software without restriction, including without limitation
   8 // the rights to use, copy, modify, merge, publish, distribute, sublicense,
   9 // and/or sell copies of the Software, and to permit persons to whom the
  10 // Software is furnished to do so, subject to the following conditions:
  11 //
  12 // The above copyright notice and this permission notice shall be included in
  13 // all copies or substantial portions of the Software.
  14 //
  15 // THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
  16 // IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
  17 // FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT.  IN NO EVENT SHALL
  18 // THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
  19 // LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING
  20 // FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER
  21 // DEALINGS IN THE SOFTWARE.
  22
  23 #ifndef   __Timer_hh
  24 #define   __Timer_hh
  25
  26 #ifdef    TIME_WITH_SYS_TIME
  27 #  include <sys/time.h>
  28 #  include <time.h>
  29 #else // !TIME_WITH_SYS_TIME
  30 #  ifdef    HAVE_SYS_TIME_H
  31 #    include <sys/time.h>
  32 #  else // !HAVE_SYS_TIME_H
  33 #    include <time.h>
  34 #  endif // HAVE_SYS_TIME_H
  35 #endif // TIME_WITH_SYS_TIME
  36
  37 // forward declaration
  38 class BTimer;
  39 class TimeoutHandler;
  40 class BaseDisplay;
  41
  42 class TimeoutHandler {
  43 public:
  44   virtual void timeout(void) = 0;
  45 };
  46
  47 class BTimer {
  48   friend class BaseDisplay;
  49 private:
  50   BaseDisplay &display;
  51   TimeoutHandler &handler;
  52   int timing, once;
  53
  54   timeval _start, _timeout;
  55
  56 protected:
  57   void fireTimeout(void);
  58
  59 public:
  60   BTimer(BaseDisplay &, TimeoutHandler &);
  61   virtual ~BTimer(void);
  62
  63   inline const int &isTiming(void) const { return timing; }
  64   inline const int &doOnce(void) const { return once; }
  65
  66   inline const timeval &getTimeout(void) const { return _timeout; }
  67   inline const timeval &getStartTime(void) const { return _start; }
  68
  69   inline void fireOnce(int o) { once = o; }
  70
  71   void setTimeout(long);
  72   void setTimeout(timeval);
  73   void start(void);
  74   void stop(void);
  75 };
  76
  77 #endif // __Timer_hh
  78