ViewVC Help
View File | Revision Log | Show Annotations | Download File
/cvs/cvsroot/rxvt-unicode/src/iom.h
(Generate patch)

Comparing cvsroot/rxvt-unicode/src/iom.h (file contents):
Revision 1.6 by pcg, Fri Jan 16 22:11:09 2004 UTC vs.
Revision 1.31 by root, Thu Oct 25 12:42:00 2007 UTC

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

Diff Legend

– Removed lines
+ Added lines
< Changed lines
> Changed lines