rxvt-unicode/src/iom.h

/*
    iom.h -- generic I/O multiplexor
    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 *> {
#if IOM_CHECK
  bool activity;
#endif

  void erase_unordered (unsigned int pos)
  {
    watcher *w = (*this)[this->size () - 1];
    this->pop_back ();

    if (this->size ())
      if ((*this)[pos] = w)
        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.15
Committed:	Thu Sep 2 07:44:40 2004 UTC (19 years, 8 months ago) by root
Content type:	text/plain
Branch:	MAIN
CVS Tags:	rel-4_0
Changes since 1.13:	+20 -42 lines
Log Message:	* empty log message *
#	User	Rev	Content
1	pcg	1.1	/*
2			iom.h -- generic I/O multiplexor
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.9	#if IOM_CHECK
70			bool activity;
71			#endif
72
73	pcg	1.6	void erase_unordered (unsigned int pos)
74			{
75	root	1.13	watcher w = (this)[this->size () - 1];
76			this->pop_back ();
77	pcg	1.6
78	root	1.13	if (this->size ())
79	pcg	1.6	if ((*this)[pos] = w)
80			w->active = pos + 1;
81			}
82			};
83
84	root	1.15	// only used as a namespace, and for initialisation purposes
85	pcg	1.2	class io_manager {
86			template<class watcher>
87	root	1.15	static void reg (watcher &w, io_manager_vec<watcher> &queue);
88	pcg	1.1
89	pcg	1.2	template<class watcher>
90	root	1.15	static void unreg (watcher &w, io_manager_vec<watcher> &queue);
91	pcg	1.1
92			public:
93			// register a watcher
94	pcg	1.2	#if IOM_IO
95	root	1.15	static void reg (io_watcher &w); static void unreg (io_watcher &w);
96	pcg	1.2	#endif
97			#if IOM_TIME
98	root	1.15	static void reg (time_watcher &w); static void unreg (time_watcher &w);
99	pcg	1.2	#endif
100			#if IOM_CHECK
101	root	1.15	static void reg (check_watcher &w); static void unreg (check_watcher &w);
102	pcg	1.2	#endif
103	pcg	1.5	#if IOM_IDLE
104	root	1.15	static void reg (idle_watcher &w); static void unreg (idle_watcher &w);
105	pcg	1.5	#endif
106	pcg	1.12	#if IOM_SIG
107	root	1.15	static void reg (sig_watcher &w); static void unreg (sig_watcher &w);
108	pcg	1.12	#endif
109	pcg	1.1
110	root	1.15	static void loop ();
111	pcg	1.1	};
112
113	pcg	1.6	struct watcher {
114			int active; /* 0 == inactive, else index into respective vector */
115
116	pcg	1.11	watcher () : active (0) { }
117	pcg	1.6	};
118
119	pcg	1.2	#if IOM_IO
120	pcg	1.1	enum { EVENT_READ = 1, EVENT_WRITE = 2 };
121
122	pcg	1.6	struct io_watcher : watcher, callback2<void, io_watcher &, short> {
123	pcg	1.1	int fd;
124			short events;
125
126	pcg	1.5	void set (int fd_, short events_) { fd = fd_; events = events_; }
127	pcg	1.1
128	pcg	1.5	void set (short events_) { set (fd, events_); }
129	root	1.15	void start () { io_manager::reg (*this); }
130			void start (int fd_, short events_) { set (fd_, events_); io_manager::reg (*this); }
131			void stop () { io_manager::unreg (*this); }
132	pcg	1.6
133			template<class O1, class O2>
134	pcg	1.11	io_watcher (O1 object, void (O2::method) (io_watcher &, short))
135			: callback2<void, io_watcher &, short> (object,method)
136	pcg	1.6	{ }
137			~io_watcher () { stop (); }
138	pcg	1.1	};
139	pcg	1.2	#endif
140	pcg	1.1
141	pcg	1.2	#if IOM_TIME
142	pcg	1.6	struct time_watcher : watcher, callback1<void, time_watcher &> {
143	pcg	1.1	tstamp at;
144
145			void trigger ();
146
147			void set (tstamp when) { at = when; }
148	pcg	1.11	void operator () () { trigger (); }
149	root	1.15	void start () { io_manager::reg (*this); }
150			void start (tstamp when) { set (when); io_manager::reg (*this); }
151			void stop () { io_manager::unreg (*this); }
152	pcg	1.1
153	pcg	1.6	template<class O1, class O2>
154	pcg	1.11	time_watcher (O1 object, void (O2::method) (time_watcher &))
155			: callback1<void, time_watcher &> (object,method), at (0)
156	pcg	1.6	{ }
157			~time_watcher () { stop (); }
158	pcg	1.1	};
159	pcg	1.2	#endif
160
161			#if IOM_CHECK
162			// run before checking for new events
163	pcg	1.6	struct check_watcher : watcher, callback1<void, check_watcher &> {
164	root	1.15	void start () { io_manager::reg (*this); }
165			void stop () { io_manager::unreg (*this); }
166	pcg	1.6
167	pcg	1.2	template<class O1, class O2>
168	pcg	1.11	check_watcher (O1 object, void (O2::method) (check_watcher &))
169			: callback1<void, check_watcher &> (object,method)
170	pcg	1.6	{ }
171			~check_watcher () { stop (); }
172	pcg	1.5	};
173			#endif
174
175			#if IOM_IDLE
176			// run after checking for any i/o, but before waiting
177	pcg	1.6	struct idle_watcher : watcher, callback1<void, idle_watcher &> {
178	root	1.15	void start () { io_manager::reg (*this); }
179			void stop () { io_manager::unreg (*this); }
180	pcg	1.6
181	pcg	1.5	template<class O1, class O2>
182	pcg	1.11	idle_watcher (O1 object, void (O2::method) (idle_watcher &))
183			: callback1<void, idle_watcher &> (object,method)
184	pcg	1.5	{ }
185	pcg	1.6	~idle_watcher () { stop (); }
186	pcg	1.2	};
187			#endif
188	pcg	1.1
189	pcg	1.12	#if IOM_SIG
190			struct sig_watcher : watcher, callback1<void, sig_watcher &> {
191			int signum;
192
193			void start (int signum);
194	root	1.15	void stop () { io_manager::unreg (*this); }
195	pcg	1.12
196			template<class O1, class O2>
197			sig_watcher (O1 object, void (O2::method) (sig_watcher &))
198			: callback1<void, sig_watcher &> (object,method), signum (-1)
199			{ }
200			~sig_watcher () { stop (); }
201			};
202			#endif
203
204	pcg	1.1	#endif
205