rxvt-unicode/src/iom.h

/*
    iom.h -- generic I/O multiplexer
    Copyright (C) 2003-2006 Marc Lehmann <gvpe@schmorp.de>
 
    This file is part of GVPE.

    GVPE 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 gvpe; if not, write to the Free Software
    Foundation, Inc. 51 Franklin Street, Fifth Floor, Boston, MA  02110-1301  USA
*/

#ifndef IOM_H__
#define IOM_H__

// required:
// - a vector template like simplevec or stl's vector
// - defines for all watcher types required in your app
// edit iom_conf.h as appropriate.
#include "iom_conf.h"

#if IOM_CHILD
# undef IOM_SIG
# define IOM_SIG 1
#endif

#include "callback.h"

typedef double tstamp;
extern tstamp NOW;

// TSTAMP_MAX must still fit into a positive struct timeval
#define TSTAMP_MAX (double)(1UL<<31)

//#define IOM_LIBEVENT "event.h" *NOT* a supported feature
#ifdef IOM_LIBEVENT
# include <sys/time.h>
# include IOM_LIBEVENT
# undef IOM_IO
# define IOM_IO 1
#endif

struct watcher;
#if IOM_IO
struct io_watcher;
#endif
#if IOM_TIME
struct time_watcher;
#endif
#if IOM_CHECK
struct check_watcher;
#endif
#if IOM_IDLE
struct idle_watcher;
#endif
#if IOM_SIG
struct sig_watcher;
#endif
#if IOM_CHILD
struct child_watcher;
#endif

template<class watcher>
struct io_manager_vec : vector<watcher *> {
  void erase_unordered (unsigned int pos)
  {
    watcher *w = (*this)[this->size () - 1];
    this->pop_back ();

    if (!this->empty ())
      if (((*this)[pos] = w)) // '=' is correct!
        w->active = pos + 1;
  }
};

// only used as a namespace, and for initialisation purposes
class io_manager {
  template<class watcher>
  static void reg (watcher &w, io_manager_vec<watcher> &queue);

  template<class watcher>
  static void unreg (watcher &w, io_manager_vec<watcher> &queue);

public:
#if IOM_TIME
  // fetch time only
  static tstamp now ();

  // set NOW
  static void set_now ();
#endif

  // register a watcher
#ifndef IOM_LIBEVENT
#if IOM_IO
  static void reg (io_watcher    &w); static void unreg (io_watcher    &w);
#endif
#if IOM_TIME
  static void reg (time_watcher  &w); static void unreg (time_watcher  &w);
#endif
#if IOM_SIG
  static void reg (sig_watcher   &w); static void unreg (sig_watcher   &w);
#endif
#if IOM_CHECK
  static void reg (check_watcher &w); static void unreg (check_watcher &w);
#endif
#endif
#if IOM_IDLE
  static void reg (idle_watcher  &w); static void unreg (idle_watcher  &w);
#endif
#if IOM_CHILD
  static void reg (child_watcher &w); static void unreg (child_watcher &w);
#endif
  
  static void loop ();
};

struct watcher {
  int active; /* 0 == inactive, else index into respective vector */

  bool is_active () { return active; }

  watcher () : active (0) { }
};

#if IOM_IO
#ifdef IOM_LIBEVENT
enum { EVENT_UNDEF = -1, EVENT_NONE = 0, EVENT_READ = EV_READ, EVENT_WRITE = EV_WRITE };

void iom_io_c_callback (int fd, short events, void *data);

struct io_watcher : watcher, callback<void (io_watcher &, short)> {
  struct event ev;
  int fd;

  void set (int fd_, short events_) { fd = fd_; event_set (&ev, fd_, events_, iom_io_c_callback, (void *)this); }

  void set (short events_) { set (fd, events_); }
  void start () { event_add (&ev, 0); active = 1; }
  void start (int fd_, short events_) { set (fd_, events_); start (); }
  void stop () { if (active) event_del (&ev); active = 0; }

  template<class O, class M>
  io_watcher (O object, M method)
  : callback<void (io_watcher &, short)> (object, method)
  { }
  ~io_watcher () { stop (); }
};
#else
enum { EVENT_UNDEF = -1, EVENT_NONE = 0, EVENT_READ = 1, EVENT_WRITE = 2 };

struct io_watcher : watcher, callback<void (io_watcher &, short)> {
  int fd;
  short events;

  void set (int fd_, short events_) { fd = fd_; events = events_; }

  void set (short events_) { set (fd, events_); }
  void start () { io_manager::reg (*this); }
  void start (int fd_, short events_) { set (fd_, events_); start (); }
  void stop () { io_manager::unreg (*this); }

  template<class O, class M>
  io_watcher (O object, M method)
  : callback<void (io_watcher &, short)> (object, method)
  { }
  ~io_watcher () { stop (); }
};
#endif
#endif

#if IOM_TIME
#ifdef IOM_LIBEVENT
void iom_time_c_callback (int fd, short events, void *data);

struct time_watcher : watcher, callback<void (time_watcher &)> {
  struct event ev;
  tstamp at;

  void trigger ();

  void set (tstamp when) { at = when; }
  void operator () () { trigger (); }
  void start ()
  {
    struct timeval tv;
    tv.tv_sec  = (long)at;
    tv.tv_usec = (long)((at - (tstamp)tv.tv_sec) * 1000000.);
    evtimer_add (&ev, &tv);
    active = 1;
  }
  void start (tstamp when) { set (when); start (); }
  void stop () { if (active) evtimer_del (&ev); active = 0; }

  template<class O, class M>
  time_watcher (O object, M method)
  : callback<void (time_watcher &)> (object, method), at (0)
  {
    evtimer_set (&ev, iom_time_c_callback, (void *)this);
  }
  ~time_watcher () { stop (); }
};
#else
struct time_watcher : watcher, callback<void (time_watcher &)> {
  tstamp at;

  void trigger ();

  void set (tstamp when) { at = when; }
  void operator () () { trigger (); }
  void start () { io_manager::reg (*this); }
  void start (tstamp when) { set (when); start (); }
  void stop () { io_manager::unreg (*this); }

  template<class O, class M>
  time_watcher (O object, M method)
  : callback<void (time_watcher &)> (object, method), at (0)
  { }
  ~time_watcher () { stop (); }
};
#endif
#endif

#if IOM_CHECK
// run before checking for new events
struct check_watcher : watcher, callback<void (check_watcher &)> {
  void start () { io_manager::reg (*this); }
  void stop () { io_manager::unreg (*this); }

  template<class O, class M>
  check_watcher (O object, M method)
  : callback<void (check_watcher &)> (object, method)
  { }
  ~check_watcher () { stop (); }
};
#endif

#if IOM_IDLE
// run after checking for any i/o, but before waiting
struct idle_watcher : watcher, callback<void (idle_watcher &)> {
  void start () { io_manager::reg (*this); }
  void stop () { io_manager::unreg (*this); }

  template<class O, class M>
  idle_watcher (O object, M method)
    : callback<void (idle_watcher &)> (object, method)
    { }
  ~idle_watcher () { stop (); }
};
#endif

#if IOM_SIG
struct sig_watcher : watcher, callback<void (sig_watcher &)> {
  int signum;

  void start (int signum);
  void stop () { io_manager::unreg (*this); }

  template<class O, class M>
  sig_watcher (O object, M method)
  : callback<void(sig_watcher &)> (object, method), signum (0)
  { }
  ~sig_watcher () { stop (); }
};
#endif

#if IOM_CHILD
struct child_watcher : watcher, callback<void (child_watcher &, int)> {
  int /*pid_t*/ pid;

  void start (int pid) { this->pid = pid; io_manager::reg (*this); }
  void stop () { io_manager::unreg (*this); }

  template<class O, class M>
  child_watcher (O object, M method)
  : callback<void (child_watcher &, int)> (object, method), pid (0)
  { }
  ~child_watcher () { stop (); }
};
#endif

#endif

Revision:	1.30
Committed:	Thu Oct 25 10:44:14 2007 UTC (16 years, 7 months ago) by root
Content type:	text/plain
Branch:	MAIN
Changes since 1.29:	+71 -5 lines
Log Message:	* empty log message *
#	User	Rev	Content
1	pcg	1.1	/*
2	root	1.20	iom.h -- generic I/O multiplexer
3	root	1.26	Copyright (C) 2003-2006 Marc Lehmann <gvpe@schmorp.de>
4	pcg	1.1
5	root	1.23	This file is part of GVPE.
6
7			GVPE is free software; you can redistribute it and/or modify
8	pcg	1.1	it under the terms of the GNU General Public License as published by
9			the Free Software Foundation; either version 2 of the License, or
10			(at your option) any later version.
11
12			This program is distributed in the hope that it will be useful,
13			but WITHOUT ANY WARRANTY; without even the implied warranty of
14			MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
15			GNU General Public License for more details.
16
17			You should have received a copy of the GNU General Public License
18	root	1.23	along with gvpe; if not, write to the Free Software
19	root	1.22	Foundation, Inc. 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301 USA
20	pcg	1.1	*/
21
22	pcg	1.7	#ifndef IOM_H__
23			#define IOM_H__
24	pcg	1.1
25	pcg	1.7	// required:
26			// - a vector template like simplevec or stl's vector
27			// - defines for all watcher types required in your app
28			// edit iom_conf.h as appropriate.
29			#include "iom_conf.h"
30	pcg	1.1
31	root	1.25	#if IOM_CHILD
32			# undef IOM_SIG
33			# define IOM_SIG 1
34			#endif
35
36	pcg	1.6	#include "callback.h"
37	pcg	1.1
38	pcg	1.6	typedef double tstamp;
39			extern tstamp NOW;
40	pcg	1.2
41	root	1.23	// TSTAMP_MAX must still fit into a positive struct timeval
42			#define TSTAMP_MAX (double)(1UL<<31)
43
44	root	1.30	//#define IOM_LIBEVENT "event.h" NOT a supported feature
45			#ifdef IOM_LIBEVENT
46			# include <sys/time.h>
47			# include IOM_LIBEVENT
48			# undef IOM_IO
49			# define IOM_IO 1
50			#endif
51
52	pcg	1.7	struct watcher;
53	pcg	1.2	#if IOM_IO
54	pcg	1.7	struct io_watcher;
55	pcg	1.2	#endif
56			#if IOM_TIME
57	pcg	1.7	struct time_watcher;
58	pcg	1.2	#endif
59			#if IOM_CHECK
60	pcg	1.7	struct check_watcher;
61	pcg	1.2	#endif
62	pcg	1.5	#if IOM_IDLE
63	pcg	1.7	struct idle_watcher;
64	pcg	1.5	#endif
65	pcg	1.12	#if IOM_SIG
66			struct sig_watcher;
67			#endif
68	root	1.25	#if IOM_CHILD
69			struct child_watcher;
70			#endif
71	pcg	1.1
72	pcg	1.6	template<class watcher>
73	pcg	1.10	struct io_manager_vec : vector<watcher *> {
74	pcg	1.6	void erase_unordered (unsigned int pos)
75			{
76	root	1.13	watcher w = (this)[this->size () - 1];
77			this->pop_back ();
78	pcg	1.6
79	root	1.20	if (!this->empty ())
80			if (((*this)[pos] = w)) // '=' is correct!
81	pcg	1.6	w->active = pos + 1;
82			}
83			};
84
85	root	1.15	// only used as a namespace, and for initialisation purposes
86	pcg	1.2	class io_manager {
87			template<class watcher>
88	root	1.15	static void reg (watcher &w, io_manager_vec<watcher> &queue);
89	pcg	1.1
90	pcg	1.2	template<class watcher>
91	root	1.15	static void unreg (watcher &w, io_manager_vec<watcher> &queue);
92	pcg	1.1
93			public:
94	root	1.21	#if IOM_TIME
95			// fetch time only
96			static tstamp now ();
97
98			// set NOW
99			static void set_now ();
100			#endif
101
102	pcg	1.1	// register a watcher
103	root	1.30	#ifndef IOM_LIBEVENT
104	pcg	1.2	#if IOM_IO
105	root	1.15	static void reg (io_watcher &w); static void unreg (io_watcher &w);
106	pcg	1.2	#endif
107			#if IOM_TIME
108	root	1.15	static void reg (time_watcher &w); static void unreg (time_watcher &w);
109	pcg	1.2	#endif
110	root	1.30	#if IOM_SIG
111			static void reg (sig_watcher &w); static void unreg (sig_watcher &w);
112			#endif
113	pcg	1.2	#if IOM_CHECK
114	root	1.15	static void reg (check_watcher &w); static void unreg (check_watcher &w);
115	pcg	1.2	#endif
116	root	1.30	#endif
117	pcg	1.5	#if IOM_IDLE
118	root	1.15	static void reg (idle_watcher &w); static void unreg (idle_watcher &w);
119	pcg	1.5	#endif
120	root	1.25	#if IOM_CHILD
121			static void reg (child_watcher &w); static void unreg (child_watcher &w);
122			#endif
123	pcg	1.1
124	root	1.15	static void loop ();
125	pcg	1.1	};
126
127	pcg	1.6	struct watcher {
128			int active; /* 0 == inactive, else index into respective vector */
129
130	root	1.27	bool is_active () { return active; }
131
132	pcg	1.11	watcher () : active (0) { }
133	pcg	1.6	};
134
135	pcg	1.2	#if IOM_IO
136	root	1.30	#ifdef IOM_LIBEVENT
137			enum { EVENT_UNDEF = -1, EVENT_NONE = 0, EVENT_READ = EV_READ, EVENT_WRITE = EV_WRITE };
138
139			void iom_io_c_callback (int fd, short events, void *data);
140
141			struct io_watcher : watcher, callback<void (io_watcher &, short)> {
142			struct event ev;
143			int fd;
144
145			void set (int fd_, short events_) { fd = fd_; event_set (&ev, fd_, events_, iom_io_c_callback, (void *)this); }
146
147			void set (short events_) { set (fd, events_); }
148			void start () { event_add (&ev, 0); active = 1; }
149			void start (int fd_, short events_) { set (fd_, events_); start (); }
150			void stop () { if (active) event_del (&ev); active = 0; }
151
152			template<class O, class M>
153			io_watcher (O object, M method)
154			: callback<void (io_watcher &, short)> (object, method)
155			{ }
156			~io_watcher () { stop (); }
157			};
158			#else
159	root	1.24	enum { EVENT_UNDEF = -1, EVENT_NONE = 0, EVENT_READ = 1, EVENT_WRITE = 2 };
160	pcg	1.1
161	root	1.28	struct io_watcher : watcher, callback<void (io_watcher &, short)> {
162	pcg	1.1	int fd;
163			short events;
164
165	pcg	1.5	void set (int fd_, short events_) { fd = fd_; events = events_; }
166	pcg	1.1
167	pcg	1.5	void set (short events_) { set (fd, events_); }
168	root	1.15	void start () { io_manager::reg (*this); }
169	root	1.30	void start (int fd_, short events_) { set (fd_, events_); start (); }
170	root	1.15	void stop () { io_manager::unreg (*this); }
171	pcg	1.6
172	root	1.29	template<class O, class M>
173			io_watcher (O object, M method)
174	root	1.28	: callback<void (io_watcher &, short)> (object, method)
175	pcg	1.6	{ }
176			~io_watcher () { stop (); }
177	pcg	1.1	};
178	pcg	1.2	#endif
179	root	1.30	#endif
180	pcg	1.1
181	pcg	1.2	#if IOM_TIME
182	root	1.30	#ifdef IOM_LIBEVENT
183			void iom_time_c_callback (int fd, short events, void *data);
184
185			struct time_watcher : watcher, callback<void (time_watcher &)> {
186			struct event ev;
187			tstamp at;
188
189			void trigger ();
190
191			void set (tstamp when) { at = when; }
192			void operator () () { trigger (); }
193			void start ()
194			{
195			struct timeval tv;
196			tv.tv_sec = (long)at;
197			tv.tv_usec = (long)((at - (tstamp)tv.tv_sec) * 1000000.);
198			evtimer_add (&ev, &tv);
199			active = 1;
200			}
201			void start (tstamp when) { set (when); start (); }
202			void stop () { if (active) evtimer_del (&ev); active = 0; }
203
204			template<class O, class M>
205			time_watcher (O object, M method)
206			: callback<void (time_watcher &)> (object, method), at (0)
207			{
208			evtimer_set (&ev, iom_time_c_callback, (void *)this);
209			}
210			~time_watcher () { stop (); }
211			};
212			#else
213	root	1.28	struct time_watcher : watcher, callback<void (time_watcher &)> {
214	pcg	1.1	tstamp at;
215
216			void trigger ();
217
218			void set (tstamp when) { at = when; }
219	pcg	1.11	void operator () () { trigger (); }
220	root	1.15	void start () { io_manager::reg (*this); }
221	root	1.30	void start (tstamp when) { set (when); start (); }
222	root	1.15	void stop () { io_manager::unreg (*this); }
223	pcg	1.1
224	root	1.29	template<class O, class M>
225			time_watcher (O object, M method)
226	root	1.28	: callback<void (time_watcher &)> (object, method), at (0)
227	pcg	1.6	{ }
228			~time_watcher () { stop (); }
229	pcg	1.1	};
230	pcg	1.2	#endif
231	root	1.30	#endif
232	pcg	1.2
233			#if IOM_CHECK
234			// run before checking for new events
235	root	1.28	struct check_watcher : watcher, callback<void (check_watcher &)> {
236	root	1.15	void start () { io_manager::reg (*this); }
237			void stop () { io_manager::unreg (*this); }
238	pcg	1.6
239	root	1.29	template<class O, class M>
240			check_watcher (O object, M method)
241	root	1.28	: callback<void (check_watcher &)> (object, method)
242	pcg	1.6	{ }
243			~check_watcher () { stop (); }
244	pcg	1.5	};
245			#endif
246
247			#if IOM_IDLE
248			// run after checking for any i/o, but before waiting
249	root	1.28	struct idle_watcher : watcher, callback<void (idle_watcher &)> {
250	root	1.15	void start () { io_manager::reg (*this); }
251			void stop () { io_manager::unreg (*this); }
252	pcg	1.6
253	root	1.29	template<class O, class M>
254			idle_watcher (O object, M method)
255	root	1.28	: callback<void (idle_watcher &)> (object, method)
256	pcg	1.5	{ }
257	pcg	1.6	~idle_watcher () { stop (); }
258	pcg	1.2	};
259			#endif
260	pcg	1.1
261	pcg	1.12	#if IOM_SIG
262	root	1.28	struct sig_watcher : watcher, callback<void (sig_watcher &)> {
263	pcg	1.12	int signum;
264
265			void start (int signum);
266	root	1.15	void stop () { io_manager::unreg (*this); }
267	pcg	1.12
268	root	1.29	template<class O, class M>
269			sig_watcher (O object, M method)
270	root	1.28	: callback<void(sig_watcher &)> (object, method), signum (0)
271	pcg	1.12	{ }
272			~sig_watcher () { stop (); }
273			};
274			#endif
275
276	root	1.25	#if IOM_CHILD
277	root	1.28	struct child_watcher : watcher, callback<void (child_watcher &, int)> {
278	root	1.25	int /pid_t/ pid;
279
280			void start (int pid) { this->pid = pid; io_manager::reg (*this); }
281			void stop () { io_manager::unreg (*this); }
282
283	root	1.29	template<class O, class M>
284			child_watcher (O object, M method)
285	root	1.28	: callback<void (child_watcher &, int)> (object, method), pid (0)
286	root	1.25	{ }
287			~child_watcher () { stop (); }
288			};
289			#endif
290
291	pcg	1.1	#endif
292