rxvt-unicode/src/iom.h

/*
    iom.h -- generic I/O multiplexer
    Copyright (C) 2003, 2004 Marc Lehmann <pcg@goof.com>
 
    This program 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 this program; if not, write to the Free Software
    Foundation, Inc. 59 Temple Place, Suite 330, Boston, MA  02111-1307  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;

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:
  // 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.20
Committed:	Fri Nov 12 12:43:27 2004 UTC (19 years, 6 months ago) by root
Content type:	text/plain
Branch:	MAIN
CVS Tags:	rel-4_2, rel-4_3, rel-4_1
Changes since 1.15:	+3 -7 lines
Log Message:	* empty log message *
#	User	Rev	Content
1	pcg	1.1	/*
2	root	1.20	iom.h -- generic I/O multiplexer
3	pcg	1.7	Copyright (C) 2003, 2004 Marc Lehmann <pcg@goof.com>
4	pcg	1.1
5			This program is free software; you can redistribute it and/or modify
6			it under the terms of the GNU General Public License as published by
7			the Free Software Foundation; either version 2 of the License, or
8			(at your option) any later version.
9
10			This program is distributed in the hope that it will be useful,
11			but WITHOUT ANY WARRANTY; without even the implied warranty of
12			MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
13			GNU General Public License for more details.
14
15			You should have received a copy of the GNU General Public License
16			along with this program; if not, write to the Free Software
17			Foundation, Inc. 59 Temple Place, Suite 330, Boston, MA 02111-1307 USA
18			*/
19
20	pcg	1.7	#ifndef IOM_H__
21			#define IOM_H__
22	pcg	1.1
23	pcg	1.7	// required:
24			// - a vector template like simplevec or stl's vector
25			// - defines for all watcher types required in your app
26			// edit iom_conf.h as appropriate.
27			#include "iom_conf.h"
28	pcg	1.1
29	pcg	1.6	#include "callback.h"
30	pcg	1.1
31	pcg	1.6	#ifndef IOM_IO
32	pcg	1.7	# define IOM_IO 0
33	pcg	1.6	#endif
34			#ifndef IOM_TIME
35	pcg	1.7	# define IOM_TIME 0
36	pcg	1.6	#endif
37			#ifndef IOM_CHECK
38	pcg	1.7	# define IOM_CHECK 0
39	pcg	1.6	#endif
40			#ifndef IOM_IDLE
41			# define IOM_IDLE 0
42			#endif
43	pcg	1.12	#ifndef IOM_SIG
44			# define IOM_SIG 0
45			#endif
46	pcg	1.6
47			typedef double tstamp;
48			extern tstamp NOW;
49	pcg	1.2
50	pcg	1.7	struct watcher;
51	pcg	1.2	#if IOM_IO
52	pcg	1.7	struct io_watcher;
53	pcg	1.2	#endif
54			#if IOM_TIME
55	pcg	1.7	struct time_watcher;
56	pcg	1.2	#endif
57			#if IOM_CHECK
58	pcg	1.7	struct check_watcher;
59	pcg	1.2	#endif
60	pcg	1.5	#if IOM_IDLE
61	pcg	1.7	struct idle_watcher;
62	pcg	1.5	#endif
63	pcg	1.12	#if IOM_SIG
64			struct sig_watcher;
65			#endif
66	pcg	1.1
67	pcg	1.6	template<class watcher>
68	pcg	1.10	struct io_manager_vec : vector<watcher *> {
69	pcg	1.6	void erase_unordered (unsigned int pos)
70			{
71	root	1.13	watcher w = (this)[this->size () - 1];
72			this->pop_back ();
73	pcg	1.6
74	root	1.20	if (!this->empty ())
75			if (((*this)[pos] = w)) // '=' is correct!
76	pcg	1.6	w->active = pos + 1;
77			}
78			};
79
80	root	1.15	// only used as a namespace, and for initialisation purposes
81	pcg	1.2	class io_manager {
82			template<class watcher>
83	root	1.15	static void reg (watcher &w, io_manager_vec<watcher> &queue);
84	pcg	1.1
85	pcg	1.2	template<class watcher>
86	root	1.15	static void unreg (watcher &w, io_manager_vec<watcher> &queue);
87	pcg	1.1
88			public:
89			// register a watcher
90	pcg	1.2	#if IOM_IO
91	root	1.15	static void reg (io_watcher &w); static void unreg (io_watcher &w);
92	pcg	1.2	#endif
93			#if IOM_TIME
94	root	1.15	static void reg (time_watcher &w); static void unreg (time_watcher &w);
95	pcg	1.2	#endif
96			#if IOM_CHECK
97	root	1.15	static void reg (check_watcher &w); static void unreg (check_watcher &w);
98	pcg	1.2	#endif
99	pcg	1.5	#if IOM_IDLE
100	root	1.15	static void reg (idle_watcher &w); static void unreg (idle_watcher &w);
101	pcg	1.5	#endif
102	pcg	1.12	#if IOM_SIG
103	root	1.15	static void reg (sig_watcher &w); static void unreg (sig_watcher &w);
104	pcg	1.12	#endif
105	pcg	1.1
106	root	1.15	static void loop ();
107	pcg	1.1	};
108
109	pcg	1.6	struct watcher {
110			int active; /* 0 == inactive, else index into respective vector */
111
112	pcg	1.11	watcher () : active (0) { }
113	pcg	1.6	};
114
115	pcg	1.2	#if IOM_IO
116	pcg	1.1	enum { EVENT_READ = 1, EVENT_WRITE = 2 };
117
118	pcg	1.6	struct io_watcher : watcher, callback2<void, io_watcher &, short> {
119	pcg	1.1	int fd;
120			short events;
121
122	pcg	1.5	void set (int fd_, short events_) { fd = fd_; events = events_; }
123	pcg	1.1
124	pcg	1.5	void set (short events_) { set (fd, events_); }
125	root	1.15	void start () { io_manager::reg (*this); }
126			void start (int fd_, short events_) { set (fd_, events_); io_manager::reg (*this); }
127			void stop () { io_manager::unreg (*this); }
128	pcg	1.6
129			template<class O1, class O2>
130	pcg	1.11	io_watcher (O1 object, void (O2::method) (io_watcher &, short))
131			: callback2<void, io_watcher &, short> (object,method)
132	pcg	1.6	{ }
133			~io_watcher () { stop (); }
134	pcg	1.1	};
135	pcg	1.2	#endif
136	pcg	1.1
137	pcg	1.2	#if IOM_TIME
138	pcg	1.6	struct time_watcher : watcher, callback1<void, time_watcher &> {
139	pcg	1.1	tstamp at;
140
141			void trigger ();
142
143			void set (tstamp when) { at = when; }
144	pcg	1.11	void operator () () { trigger (); }
145	root	1.15	void start () { io_manager::reg (*this); }
146			void start (tstamp when) { set (when); io_manager::reg (*this); }
147			void stop () { io_manager::unreg (*this); }
148	pcg	1.1
149	pcg	1.6	template<class O1, class O2>
150	pcg	1.11	time_watcher (O1 object, void (O2::method) (time_watcher &))
151			: callback1<void, time_watcher &> (object,method), at (0)
152	pcg	1.6	{ }
153			~time_watcher () { stop (); }
154	pcg	1.1	};
155	pcg	1.2	#endif
156
157			#if IOM_CHECK
158			// run before checking for new events
159	pcg	1.6	struct check_watcher : watcher, callback1<void, check_watcher &> {
160	root	1.15	void start () { io_manager::reg (*this); }
161			void stop () { io_manager::unreg (*this); }
162	pcg	1.6
163	pcg	1.2	template<class O1, class O2>
164	pcg	1.11	check_watcher (O1 object, void (O2::method) (check_watcher &))
165			: callback1<void, check_watcher &> (object,method)
166	pcg	1.6	{ }
167			~check_watcher () { stop (); }
168	pcg	1.5	};
169			#endif
170
171			#if IOM_IDLE
172			// run after checking for any i/o, but before waiting
173	pcg	1.6	struct idle_watcher : watcher, callback1<void, idle_watcher &> {
174	root	1.15	void start () { io_manager::reg (*this); }
175			void stop () { io_manager::unreg (*this); }
176	pcg	1.6
177	pcg	1.5	template<class O1, class O2>
178	pcg	1.11	idle_watcher (O1 object, void (O2::method) (idle_watcher &))
179			: callback1<void, idle_watcher &> (object,method)
180	pcg	1.5	{ }
181	pcg	1.6	~idle_watcher () { stop (); }
182	pcg	1.2	};
183			#endif
184	pcg	1.1
185	pcg	1.12	#if IOM_SIG
186			struct sig_watcher : watcher, callback1<void, sig_watcher &> {
187			int signum;
188
189			void start (int signum);
190	root	1.15	void stop () { io_manager::unreg (*this); }
191	pcg	1.12
192			template<class O1, class O2>
193			sig_watcher (O1 object, void (O2::method) (sig_watcher &))
194			: callback1<void, sig_watcher &> (object,method), signum (-1)
195			{ }
196			~sig_watcher () { stop (); }
197			};
198			#endif
199
200	pcg	1.1	#endif
201