lib/base/ebase.h

   1 #ifndef __ebase_h
   2 #define __ebase_h
   3
   4 #ifndef SWIG
   5 #include <vector>
   6 #include <map>
   7 #include <sys/poll.h>
   8 #include <sys/time.h>
   9 #include <asm/types.h>
  10 #include <time.h>
  11
  12 #include <lib/base/eptrlist.h>
  13 #include <libsig_comp.h>
  14 #endif
  15
  16 #include <lib/python/connections.h>
  17
  18 class eApplication;
  19
  20 extern eApplication* eApp;
  21
  22 #ifndef SWIG
  23         /* TODO: remove these inlines. */
  24 static inline bool operator<( const timeval &t1, const timeval &t2 )
  25 {
  26         return t1.tv_sec < t2.tv_sec || (t1.tv_sec == t2.tv_sec && t1.tv_usec < t2.tv_usec);
  27 }
  28
  29 static inline bool operator<=( const timeval &t1, const timeval &t2 )
  30 {
  31         return t1.tv_sec < t2.tv_sec || (t1.tv_sec == t2.tv_sec && t1.tv_usec <= t2.tv_usec);
  32 }
  33
  34 static inline timeval &operator+=( timeval &t1, const timeval &t2 )
  35 {
  36         t1.tv_sec += t2.tv_sec;
  37         if ( (t1.tv_usec += t2.tv_usec) >= 1000000 )
  38         {
  39                 t1.tv_sec++;
  40                 t1.tv_usec -= 1000000;
  41         }
  42         return t1;
  43 }
  44
  45 static inline timeval operator+( const timeval &t1, const timeval &t2 )
  46 {
  47         timeval tmp;
  48         tmp.tv_sec = t1.tv_sec + t2.tv_sec;
  49         if ( (tmp.tv_usec = t1.tv_usec + t2.tv_usec) >= 1000000 )
  50         {
  51                 tmp.tv_sec++;
  52                 tmp.tv_usec -= 1000000;
  53         }
  54         return tmp;
  55 }
  56
  57 static inline timeval operator-( const timeval &t1, const timeval &t2 )
  58 {
  59         timeval tmp;
  60         tmp.tv_sec = t1.tv_sec - t2.tv_sec;
  61         if ( (tmp.tv_usec = t1.tv_usec - t2.tv_usec) < 0 )
  62         {
  63                 tmp.tv_sec--;
  64                 tmp.tv_usec += 1000000;
  65         }
  66         return tmp;
  67 }
  68
  69 static inline timeval operator-=( timeval &t1, const timeval &t2 )
  70 {
  71         t1.tv_sec -= t2.tv_sec;
  72         if ( (t1.tv_usec -= t2.tv_usec) < 0 )
  73         {
  74                 t1.tv_sec--;
  75                 t1.tv_usec += 1000000;
  76         }
  77         return t1;
  78 }
  79
  80 static inline timeval &operator+=( timeval &t1, const long msek )
  81 {
  82         t1.tv_sec += msek / 1000;
  83         if ( (t1.tv_usec += (msek % 1000) * 1000) >= 1000000 )
  84         {
  85                 t1.tv_sec++;
  86                 t1.tv_usec -= 1000000;
  87         }
  88         return t1;
  89 }
  90
  91 static inline timeval operator+( const timeval &t1, const long msek )
  92 {
  93         timeval tmp;
  94         tmp.tv_sec = t1.tv_sec + msek / 1000;
  95         if ( (tmp.tv_usec = t1.tv_usec + (msek % 1000) * 1000) >= 1000000 )
  96         {
  97                 tmp.tv_sec++;
  98                 tmp.tv_usec -= 1000000;
  99         }
 100         return tmp;
 101 }
 102
 103 static inline timeval operator-( const timeval &t1, const long msek )
 104 {
 105         timeval tmp;
 106         tmp.tv_sec = t1.tv_sec - msek / 1000;
 107         if ( (tmp.tv_usec = t1.tv_usec - (msek % 1000)*1000) < 0 )
 108         {
 109                 tmp.tv_sec--;
 110                 tmp.tv_usec += 1000000;
 111         }
 112         return tmp;
 113 }
 114
 115 static inline timeval operator-=( timeval &t1, const long msek )
 116 {
 117         t1.tv_sec -= msek / 1000;
 118         if ( (t1.tv_usec -= (msek % 1000) * 1000) < 0 )
 119         {
 120                 t1.tv_sec--;
 121                 t1.tv_usec += 1000000;
 122         }
 123         return t1;
 124 }
 125
 126 static inline int timeval_to_usec(const timeval &t1)
 127 {
 128         return t1.tv_sec*1000000 + t1.tv_usec;
 129 }
 130 #endif
 131
 132 class eMainloop;
 133
 134                                         // die beiden signalquellen: SocketNotifier...
 135
 136 /**
 137  * \brief Gives a callback when data on a file descriptor is ready.
 138  *
 139  * This class emits the signal \c eSocketNotifier::activate whenever the
 140  * event specified by \c req is available.
 141  */
 142 class eSocketNotifier
 143 {
 144         friend class eMainloop;
 145 public:
 146         enum { Read=POLLIN, Write=POLLOUT, Priority=POLLPRI, Error=POLLERR, Hungup=POLLHUP };
 147 private:
 148         eMainloop &context;
 149         int fd;
 150         int state;
 151         int requested;          // requested events (POLLIN, ...)
 152 public:
 153         /**
 154          * \brief Constructs a eSocketNotifier.
 155          * \param context The thread where to bind the socketnotifier to. The signal is emitted from that thread.
 156          * \param fd The filedescriptor to monitor. Can be a device or a socket.
 157          * \param req The events to watch to, normally either \c Read or \c Write. You can specify any events that \c poll supports.
 158          * \param startnow Specifies if the socketnotifier should start immediately.
 159          */
 160         eSocketNotifier(eMainloop *context, int fd, int req, bool startnow=true);
 161         ~eSocketNotifier();
 162
 163         PSignal1<void, int> activated;
 164         void activate(int what) { /*emit*/ activated(what); }
 165
 166         void start();
 167         void stop();
 168         bool isRunning() { return state; }
 169
 170         int getFD() { return fd; }
 171         int getRequested() { return requested; }
 172         void setRequested(int req) { requested=req; }
 173 };
 174
 175 class eTimer;
 176
 177                         // werden in einer mainloop verarbeitet
 178 class eMainloop
 179 {
 180         friend class eTimer;
 181         friend class eSocketNotifier;
 182         std::map<int, eSocketNotifier*> notifiers;
 183         ePtrList<eTimer> m_timer_list;
 184         bool app_quit_now;
 185         int loop_level;
 186         int processOneEvent(unsigned int user_timeout, PyObject **res=0, ePyObject additional=ePyObject());
 187         int retval;
 188         pthread_mutex_t recalcLock;
 189
 190         int m_now_is_invalid;
 191         int m_interrupt_requested;
 192         void addSocketNotifier(eSocketNotifier *sn);
 193         void removeSocketNotifier(eSocketNotifier *sn);
 194         void addTimer(eTimer* e);
 195         void removeTimer(eTimer* e);
 196 public:
 197         static void addTimeOffset(int offset);
 198
 199 #ifndef SWIG
 200         static ePtrList<eMainloop> existing_loops;
 201 #endif
 202
 203         eMainloop()
 204                 :app_quit_now(0),loop_level(0),retval(0), m_interrupt_requested(0)
 205         {
 206                 m_now_is_invalid = 0;
 207                 existing_loops.push_back(this);
 208                 pthread_mutex_init(&recalcLock, 0);
 209         }
 210         ~eMainloop()
 211         {
 212                 existing_loops.remove(this);
 213                 pthread_mutex_destroy(&recalcLock);
 214         }
 215         int looplevel() { return loop_level; }
 216
 217 #ifndef SWIG
 218         void quit(int ret=0); // leave all pending loops (recursive leave())
 219 #endif
 220
 221                 /* a user supplied timeout. enter_loop will return with:
 222                   0 - no timeout, no signal
 223                   1 - timeout
 224                   2 - signal
 225                 */
 226         int iterate(unsigned int timeout=0, PyObject **res=0, SWIG_PYOBJECT(ePyObject) additional=(PyObject*)0);
 227
 228                 /* run will iterate endlessly until the app is quit, and return
 229                    the exit code */
 230         int runLoop();
 231
 232                 /* our new shared polling interface. */
 233         PyObject *poll(SWIG_PYOBJECT(ePyObject) dict, SWIG_PYOBJECT(ePyObject) timeout);
 234         void interruptPoll();
 235         void reset();
 236 };
 237
 238 /**
 239  * \brief The application class.
 240  *
 241  * An application provides a mainloop, and runs in the primary thread.
 242  * You can have other threads, too, but this is the primary one.
 243  */
 244 class eApplication: public eMainloop
 245 {
 246 public:
 247         eApplication()
 248         {
 249                 if (!eApp)
 250                         eApp = this;
 251         }
 252         ~eApplication()
 253         {
 254                 eApp = 0;
 255         }
 256 };
 257
 258                                 // ... und Timer
 259 /**
 260  * \brief Gives a callback after a specified timeout.
 261  *
 262  * This class emits the signal \c eTimer::timeout after the specified timeout.
 263  */
 264 class eTimer
 265 {
 266         friend class eMainloop;
 267         eMainloop &context;
 268         timeval nextActivation;
 269         long interval;
 270         bool bSingleShot;
 271         bool bActive;
 272         void addTimeOffset(int);
 273 public:
 274         /**
 275          * \brief Constructs a timer.
 276          *
 277          * The timer is not yet active, it has to be started with \c start.
 278          * \param context The thread from which the signal should be emitted.
 279          */
 280         eTimer(eMainloop *context=eApp): context(*context), bActive(false) { }
 281         ~eTimer() { if (bActive) stop(); }
 282
 283         PSignal0<void> timeout;
 284         void activate();
 285
 286         bool isActive() { return bActive; }
 287         timeval &getNextActivation() { return nextActivation; }
 288
 289         void start(long msec, bool b=false);
 290         void stop();
 291         void changeInterval(long msek);
 292 #ifndef SWIG
 293         bool operator<(const eTimer& t) const { return nextActivation < t.nextActivation; }
 294 #endif
 295         void startLongTimer( int seconds );
 296 };
 297 #endif