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

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

template<class watcher>
struct io_manager_vec : vector<watcher *> {
#if IOM_CHECK
  bool activity;
#endif

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

    if (size ())
      if ((*this)[pos] = w)
        w->active = pos + 1;
  }
};

class io_manager {
#if IOM_IO
  io_manager_vec<io_watcher>    iow;
#endif
#if IOM_CHECK
  io_manager_vec<check_watcher> cw;
#endif
#if IOM_TIME
  io_manager_vec<time_watcher>  tw;
#endif
#if IOM_IDLE
  io_manager_vec<idle_watcher>  iw;
#endif

  template<class watcher>
  void reg (watcher *w, io_manager_vec<watcher> &queue);

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

public:
  // register a watcher
#if IOM_IO
  void reg (io_watcher    *w); void unreg (io_watcher    *w);
#endif
#if IOM_TIME
  void reg (time_watcher  *w); void unreg (time_watcher  *w);
#endif
#if IOM_CHECK
  void reg (check_watcher *w); void unreg (check_watcher *w);
#endif
#if IOM_IDLE
  void reg (idle_watcher  *w); void unreg (idle_watcher  *w);
#endif
  
  void loop ();

  io_manager ();
  ~io_manager ();
};

extern io_manager iom; // a singleton, together with it's construction/destruction problems.

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 () { iom.reg (this); }
  void start (int fd_, short events_) { set (fd_, events_); iom.reg (this); }
  void stop () { iom.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 () { iom.reg (this); }
  void start (tstamp when) { set (when); iom.reg (this); }
  void stop () { iom.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 () { iom.reg (this); }
  void stop () { iom.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 () { iom.reg (this); }
  void stop () { iom.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

#endif

Revision:	1.11
Committed:	Fri Feb 13 12:16:21 2004 UTC (20 years, 3 months ago) by pcg
Content type:	text/plain
Branch:	MAIN
CVS Tags:	rel-2_1_0, rel-2_4, rel-2_5, rel-2_2, rel-2_3, rel-2_0, rel-1_9
Changes since 1.10:	+10 -10 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
44			typedef double tstamp;
45			extern tstamp NOW;
46	pcg	1.2
47	pcg	1.7	struct watcher;
48	pcg	1.2	#if IOM_IO
49	pcg	1.7	struct io_watcher;
50	pcg	1.2	#endif
51			#if IOM_TIME
52	pcg	1.7	struct time_watcher;
53	pcg	1.2	#endif
54			#if IOM_CHECK
55	pcg	1.7	struct check_watcher;
56	pcg	1.2	#endif
57	pcg	1.5	#if IOM_IDLE
58	pcg	1.7	struct idle_watcher;
59	pcg	1.5	#endif
60	pcg	1.1
61	pcg	1.6	template<class watcher>
62	pcg	1.10	struct io_manager_vec : vector<watcher *> {
63	pcg	1.9	#if IOM_CHECK
64			bool activity;
65			#endif
66
67	pcg	1.6	void erase_unordered (unsigned int pos)
68			{
69			watcher w = (this)[size () - 1];
70			pop_back ();
71
72			if (size ())
73			if ((*this)[pos] = w)
74			w->active = pos + 1;
75			}
76			};
77
78	pcg	1.2	class io_manager {
79			#if IOM_IO
80	pcg	1.6	io_manager_vec<io_watcher> iow;
81	pcg	1.2	#endif
82			#if IOM_CHECK
83	pcg	1.6	io_manager_vec<check_watcher> cw;
84	pcg	1.2	#endif
85			#if IOM_TIME
86	pcg	1.6	io_manager_vec<time_watcher> tw;
87	pcg	1.2	#endif
88	pcg	1.5	#if IOM_IDLE
89	pcg	1.6	io_manager_vec<idle_watcher> iw;
90	pcg	1.5	#endif
91	pcg	1.1
92	pcg	1.2	template<class watcher>
93	pcg	1.7	void reg (watcher *w, io_manager_vec<watcher> &queue);
94	pcg	1.1
95	pcg	1.2	template<class watcher>
96	pcg	1.7	void unreg (watcher *w, io_manager_vec<watcher> &queue);
97	pcg	1.1
98			public:
99			// register a watcher
100	pcg	1.2	#if IOM_IO
101	pcg	1.5	void reg (io_watcher w); void unreg (io_watcher w);
102	pcg	1.2	#endif
103			#if IOM_TIME
104	pcg	1.5	void reg (time_watcher w); void unreg (time_watcher w);
105	pcg	1.2	#endif
106			#if IOM_CHECK
107			void reg (check_watcher w); void unreg (check_watcher w);
108			#endif
109	pcg	1.5	#if IOM_IDLE
110			void reg (idle_watcher w); void unreg (idle_watcher w);
111			#endif
112	pcg	1.1
113			void loop ();
114
115			io_manager ();
116			~io_manager ();
117			};
118
119			extern io_manager iom; // a singleton, together with it's construction/destruction problems.
120
121	pcg	1.6	struct watcher {
122			int active; /* 0 == inactive, else index into respective vector */
123
124	pcg	1.11	watcher () : active (0) { }
125	pcg	1.6	};
126
127	pcg	1.2	#if IOM_IO
128	pcg	1.1	enum { EVENT_READ = 1, EVENT_WRITE = 2 };
129
130	pcg	1.6	struct io_watcher : watcher, callback2<void, io_watcher &, short> {
131	pcg	1.1	int fd;
132			short events;
133
134	pcg	1.5	void set (int fd_, short events_) { fd = fd_; events = events_; }
135	pcg	1.1
136	pcg	1.5	void set (short events_) { set (fd, events_); }
137			void start () { iom.reg (this); }
138	pcg	1.1	void start (int fd_, short events_) { set (fd_, events_); iom.reg (this); }
139			void stop () { iom.unreg (this); }
140	pcg	1.6
141			template<class O1, class O2>
142	pcg	1.11	io_watcher (O1 object, void (O2::method) (io_watcher &, short))
143			: callback2<void, io_watcher &, short> (object,method)
144	pcg	1.6	{ }
145			~io_watcher () { stop (); }
146	pcg	1.1	};
147	pcg	1.2	#endif
148	pcg	1.1
149	pcg	1.2	#if IOM_TIME
150	pcg	1.6	struct time_watcher : watcher, callback1<void, time_watcher &> {
151	pcg	1.1	tstamp at;
152
153			void trigger ();
154
155			void set (tstamp when) { at = when; }
156	pcg	1.11	void operator () () { trigger (); }
157	pcg	1.1	void start () { iom.reg (this); }
158			void start (tstamp when) { set (when); iom.reg (this); }
159			void stop () { iom.unreg (this); }
160
161	pcg	1.6	template<class O1, class O2>
162	pcg	1.11	time_watcher (O1 object, void (O2::method) (time_watcher &))
163			: callback1<void, time_watcher &> (object,method), at (0)
164	pcg	1.6	{ }
165			~time_watcher () { stop (); }
166	pcg	1.1	};
167	pcg	1.2	#endif
168
169			#if IOM_CHECK
170			// run before checking for new events
171	pcg	1.6	struct check_watcher : watcher, callback1<void, check_watcher &> {
172			void start () { iom.reg (this); }
173			void stop () { iom.unreg (this); }
174
175	pcg	1.2	template<class O1, class O2>
176	pcg	1.11	check_watcher (O1 object, void (O2::method) (check_watcher &))
177			: callback1<void, check_watcher &> (object,method)
178	pcg	1.6	{ }
179			~check_watcher () { stop (); }
180	pcg	1.5	};
181			#endif
182
183			#if IOM_IDLE
184			// run after checking for any i/o, but before waiting
185	pcg	1.6	struct idle_watcher : watcher, callback1<void, idle_watcher &> {
186			void start () { iom.reg (this); }
187			void stop () { iom.unreg (this); }
188
189	pcg	1.5	template<class O1, class O2>
190	pcg	1.11	idle_watcher (O1 object, void (O2::method) (idle_watcher &))
191			: callback1<void, idle_watcher &> (object,method)
192	pcg	1.5	{ }
193	pcg	1.6	~idle_watcher () { stop (); }
194	pcg	1.2	};
195			#endif
196	pcg	1.1
197			#endif
198