rxvt-unicode/src/iom.h

/*
    iom.h -- generic I/O multiplexer
    Copyright (C) 2003, 2004 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"

#include "callback.h"

#ifndef IOM_IO
# define IOM_IO 0
#endif
#ifndef IOM_TIME
# define IOM_TIME 0
#endif
#ifndef IOM_CHECK
# define IOM_CHECK 0
#endif
#ifndef IOM_IDLE
# define IOM_IDLE 0
#endif
#ifndef IOM_SIG
# define IOM_SIG 0
#endif

typedef double tstamp;
extern tstamp NOW;

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

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

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
#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_CHECK
  static void reg (check_watcher &w); static void unreg (check_watcher &w);
#endif
#if IOM_IDLE
  static void reg (idle_watcher  &w); static void unreg (idle_watcher  &w);
#endif
#if IOM_SIG
  static void reg (sig_watcher   &w); static void unreg (sig_watcher   &w);
#endif
  
  static void loop ();
};

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

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

#if IOM_IO
enum { EVENT_READ = 1, EVENT_WRITE = 2 };

struct io_watcher : watcher, callback2<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_); io_manager::reg (*this); }
  void stop () { io_manager::unreg (*this); }

  template<class O1, class O2>
  io_watcher (O1 *object, void (O2::*method) (io_watcher &, short))
  : callback2<void, io_watcher &, short> (object,method)
  { }
  ~io_watcher () { stop (); }
};
#endif

#if IOM_TIME
struct time_watcher : watcher, callback1<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); io_manager::reg (*this); }
  void stop () { io_manager::unreg (*this); }

  template<class O1, class O2>
  time_watcher (O1 *object, void (O2::*method) (time_watcher &))
  : callback1<void, time_watcher &> (object,method), at (0)
  { }
  ~time_watcher () { stop (); }
};
#endif

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

  template<class O1, class O2>
  check_watcher (O1 *object, void (O2::*method) (check_watcher &))
  : callback1<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, callback1<void, idle_watcher &> {
  void start () { io_manager::reg (*this); }
  void stop () { io_manager::unreg (*this); }

  template<class O1, class O2>
  idle_watcher (O1 *object, void (O2::*method) (idle_watcher &))
    : callback1<void, idle_watcher &> (object,method)
    { }
  ~idle_watcher () { stop (); }
};
#endif

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

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

  template<class O1, class O2>
  sig_watcher (O1 *object, void (O2::*method) (sig_watcher &))
  : callback1<void, sig_watcher &> (object,method), signum (-1)
  { }
  ~sig_watcher () { stop (); }
};
#endif

#endif

Revision:	1.23
Committed:	Tue Nov 29 19:22:48 2005 UTC (18 years, 6 months ago) by root
Content type:	text/plain
Branch:	MAIN
CVS Tags:	rel-6_2, rel-6_3, rel-6_0, rel-5_9, rel-6_1
Changes since 1.22:	+8 -3 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.23	Copyright (C) 2003, 2004 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	pcg	1.6	#include "callback.h"
32	pcg	1.1
33	pcg	1.6	#ifndef IOM_IO
34	pcg	1.7	# define IOM_IO 0
35	pcg	1.6	#endif
36			#ifndef IOM_TIME
37	pcg	1.7	# define IOM_TIME 0
38	pcg	1.6	#endif
39			#ifndef IOM_CHECK
40	pcg	1.7	# define IOM_CHECK 0
41	pcg	1.6	#endif
42			#ifndef IOM_IDLE
43			# define IOM_IDLE 0
44			#endif
45	pcg	1.12	#ifndef IOM_SIG
46			# define IOM_SIG 0
47			#endif
48	pcg	1.6
49			typedef double tstamp;
50			extern tstamp NOW;
51	pcg	1.2
52	root	1.23	// TSTAMP_MAX must still fit into a positive struct timeval
53			#define TSTAMP_MAX (double)(1UL<<31)
54
55	pcg	1.7	struct watcher;
56	pcg	1.2	#if IOM_IO
57	pcg	1.7	struct io_watcher;
58	pcg	1.2	#endif
59			#if IOM_TIME
60	pcg	1.7	struct time_watcher;
61	pcg	1.2	#endif
62			#if IOM_CHECK
63	pcg	1.7	struct check_watcher;
64	pcg	1.2	#endif
65	pcg	1.5	#if IOM_IDLE
66	pcg	1.7	struct idle_watcher;
67	pcg	1.5	#endif
68	pcg	1.12	#if IOM_SIG
69			struct sig_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	pcg	1.2	#if IOM_IO
104	root	1.15	static void reg (io_watcher &w); static void unreg (io_watcher &w);
105	pcg	1.2	#endif
106			#if IOM_TIME
107	root	1.15	static void reg (time_watcher &w); static void unreg (time_watcher &w);
108	pcg	1.2	#endif
109			#if IOM_CHECK
110	root	1.15	static void reg (check_watcher &w); static void unreg (check_watcher &w);
111	pcg	1.2	#endif
112	pcg	1.5	#if IOM_IDLE
113	root	1.15	static void reg (idle_watcher &w); static void unreg (idle_watcher &w);
114	pcg	1.5	#endif
115	pcg	1.12	#if IOM_SIG
116	root	1.15	static void reg (sig_watcher &w); static void unreg (sig_watcher &w);
117	pcg	1.12	#endif
118	pcg	1.1
119	root	1.15	static void loop ();
120	pcg	1.1	};
121
122	pcg	1.6	struct watcher {
123			int active; /* 0 == inactive, else index into respective vector */
124
125	pcg	1.11	watcher () : active (0) { }
126	pcg	1.6	};
127
128	pcg	1.2	#if IOM_IO
129	pcg	1.1	enum { EVENT_READ = 1, EVENT_WRITE = 2 };
130
131	pcg	1.6	struct io_watcher : watcher, callback2<void, io_watcher &, short> {
132	pcg	1.1	int fd;
133			short events;
134
135	pcg	1.5	void set (int fd_, short events_) { fd = fd_; events = events_; }
136	pcg	1.1
137	pcg	1.5	void set (short events_) { set (fd, events_); }
138	root	1.15	void start () { io_manager::reg (*this); }
139			void start (int fd_, short events_) { set (fd_, events_); io_manager::reg (*this); }
140			void stop () { io_manager::unreg (*this); }
141	pcg	1.6
142			template<class O1, class O2>
143	pcg	1.11	io_watcher (O1 object, void (O2::method) (io_watcher &, short))
144			: callback2<void, io_watcher &, short> (object,method)
145	pcg	1.6	{ }
146			~io_watcher () { stop (); }
147	pcg	1.1	};
148	pcg	1.2	#endif
149	pcg	1.1
150	pcg	1.2	#if IOM_TIME
151	pcg	1.6	struct time_watcher : watcher, callback1<void, time_watcher &> {
152	pcg	1.1	tstamp at;
153
154			void trigger ();
155
156			void set (tstamp when) { at = when; }
157	pcg	1.11	void operator () () { trigger (); }
158	root	1.15	void start () { io_manager::reg (*this); }
159			void start (tstamp when) { set (when); io_manager::reg (*this); }
160			void stop () { io_manager::unreg (*this); }
161	pcg	1.1
162	pcg	1.6	template<class O1, class O2>
163	pcg	1.11	time_watcher (O1 object, void (O2::method) (time_watcher &))
164			: callback1<void, time_watcher &> (object,method), at (0)
165	pcg	1.6	{ }
166			~time_watcher () { stop (); }
167	pcg	1.1	};
168	pcg	1.2	#endif
169
170			#if IOM_CHECK
171			// run before checking for new events
172	pcg	1.6	struct check_watcher : watcher, callback1<void, check_watcher &> {
173	root	1.15	void start () { io_manager::reg (*this); }
174			void stop () { io_manager::unreg (*this); }
175	pcg	1.6
176	pcg	1.2	template<class O1, class O2>
177	pcg	1.11	check_watcher (O1 object, void (O2::method) (check_watcher &))
178			: callback1<void, check_watcher &> (object,method)
179	pcg	1.6	{ }
180			~check_watcher () { stop (); }
181	pcg	1.5	};
182			#endif
183
184			#if IOM_IDLE
185			// run after checking for any i/o, but before waiting
186	pcg	1.6	struct idle_watcher : watcher, callback1<void, idle_watcher &> {
187	root	1.15	void start () { io_manager::reg (*this); }
188			void stop () { io_manager::unreg (*this); }
189	pcg	1.6
190	pcg	1.5	template<class O1, class O2>
191	pcg	1.11	idle_watcher (O1 object, void (O2::method) (idle_watcher &))
192			: callback1<void, idle_watcher &> (object,method)
193	pcg	1.5	{ }
194	pcg	1.6	~idle_watcher () { stop (); }
195	pcg	1.2	};
196			#endif
197	pcg	1.1
198	pcg	1.12	#if IOM_SIG
199			struct sig_watcher : watcher, callback1<void, sig_watcher &> {
200			int signum;
201
202			void start (int signum);
203	root	1.15	void stop () { io_manager::unreg (*this); }
204	pcg	1.12
205			template<class O1, class O2>
206			sig_watcher (O1 object, void (O2::method) (sig_watcher &))
207			: callback1<void, sig_watcher &> (object,method), signum (-1)
208			{ }
209			~sig_watcher () { stop (); }
210			};
211			#endif
212
213	pcg	1.1	#endif
214