ViewVC Help

View File | Revision Log | Show Annotations | Download File

/cvs/rxvt-unicode/src/urxvt.pm

Comparing rxvt-unicode/src/urxvt.pm (file contents):
Revision 1.78 by root, Wed Jan 11 01:01:52 2006 UTC vs.
Revision 1.255 by root, Wed Jun 17 11:59:37 2015 UTC

1	=encoding utf8	1	=encoding utf8
2		2
3	=head1 NAME	3	=head1 NAME
4		4
5	@@RXVT_NAME@@perl - rxvt-unicode's embedded perl interpreter	5	urxvtperl - rxvt-unicode's embedded perl interpreter
6		6
7	=head1 SYNOPSIS	7	=head1 SYNOPSIS
8		8
9	# create a file grab_test in $HOME:	9	# create a file grab_test in $HOME:
10		10
11	sub on_sel_grab {	11	sub on_sel_grab {
12	warn "you selected ", $_[0]->selection;	12	warn "you selected ", $_[0]->selection;
13	()	13	()
14	}	14	}
15		15
16	# start a @@RXVT_NAME@@ using it:	16	# start a urxvt using it:
17		17
18	@@RXVT_NAME@@ --perl-lib $HOME -pe grab_test	18	urxvt --perl-lib $HOME -pe grab_test
19		19
20	=head1 DESCRIPTION	20	=head1 DESCRIPTION
21		21
22	Everytime a terminal object gets created, extension scripts specified via	22	Every time a terminal object gets created, extension scripts specified via
23	the C<perl> resource are loaded and associated with it.	23	the C<perl> resource are loaded and associated with it.
24		24
25	Scripts are compiled in a 'use strict' and 'use utf8' environment, and	25	Scripts are compiled in a 'use strict "vars"' and 'use utf8' environment, and
26	thus must be encoded as UTF-8.	26	thus must be encoded as UTF-8.
27		27
28	Each script will only ever be loaded once, even in @@RXVT_NAME@@d, where	28	Each script will only ever be loaded once, even in urxvtd, where
29	scripts will be shared (but not enabled) for all terminals.	29	scripts will be shared (but not enabled) for all terminals.
30		30
		31	You can disable the embedded perl interpreter by setting both "perl-ext"
		32	and "perl-ext-common" resources to the empty string.
		33
31	=head1 PREPACKAGED EXTENSIONS	34	=head1 PREPACKAGED EXTENSIONS
32		35
33	This section describes the extensions delivered with this release. You can	36	A number of extensions are delivered with this release. You can find them
34	find them in F<@@RXVT_LIBDIR@@/urxvt/perl/>.	37	in F<< <libdir>/urxvt/perl/ >>, and the documentation can be viewed using
		38	F<< man urxvt-<EXTENSIONNAME> >>.
35		39
36	You can activate them like this:	40	You can activate them like this:
37		41
38	@@RXVT_NAME@@ -pe <extensionname>	42	urxvt -pe <extensionname>
39		43
40	=over 4	44	Or by adding them to the resource for extensions loaded by default:
41		45
42	=item selection (enabled by default)	46	URxvt.perl-ext-common: default,selection-autotransform
43		47
44	(More) intelligent selection. This extension tries to be more intelligent	48	Extensions may add additional resources and C<actions>, i.e., methods
45	when the user extends selections (double-click). Right now, it tries to	49	which can be bound to a key and invoked by the user. An extension can
46	select urls and complete shell-quoted arguments, which is very convenient,	50	define the resources it support using so called META comments,
47	too, if your F<ls> supports C<--quoting-style=shell>.	51	described below. Similarly to builtin resources, extension resources
48		52	can also be specified on the command line as long options (with C<.>
49	It also offers the following bindable keyboard command:	53	replaced by C<->), in which case the corresponding extension is loaded
50		54	automatically. For this to work the extension B<must> define META
51	=over 4	55	comments for its resources.
52
53	=item rot13
54
55	Rot-13 the selection when activated. Used via keyboard trigger:
56
57	URxvt.keysym.C-M-r: perl:selection:rot13
58
59	=back
60
61	=item option-popup (enabled by default)
62
63	Binds a popup menu to Ctrl-Button2 that lets you toggle (some) options at
64	runtime.
65
66	=item selection-popup (enabled by default)
67
68	Binds a popup menu to Ctrl-Button3 that lets you convert the selection
69	text into various other formats/action (such as uri unescaping, perl
70	evalution, web-browser starting etc.), depending on content.
71
72	=item searchable-scrollback<hotkey> (enabled by default)
73
74	Adds regex search functionality to the scrollback buffer, triggered
75	by a hotkey (default: C<M-s>). When in search mode, normal terminal
76	input/output is suspended.
77
78	C</> starts an incremental regex search, C<n> searches further, C<p> or
79	C<N> jump to the previous match, C<G> jumps to the bottom and clears the
80	history, C<enter> leaves search mode at the current position and C<escape>
81	returns to the original position.
82
83	=item digital-clock
84
85	Displays a digital clock using the built-in overlay.
86
87	=item mark-urls
88
89	Uses per-line display filtering (C<on_line_update>) to underline urls.
90
91	=item block-graphics-to-ascii
92
93	A not very useful example of filtering all text output to the terminal,
94	by replacing all line-drawing characters (U+2500 .. U+259F) by a
95	similar-looking ascii character.
96
97	=item example-refresh-hooks
98
99	Displays a very simple digital clock in the upper right corner of the
100	window. Illustrates overwriting the refresh callbacks to create your own
101	overlays or changes.
102
103	=back
104		56
105	=head1 API DOCUMENTATION	57	=head1 API DOCUMENTATION
106		58
107	=head2 General API Considerations	59	=head2 General API Considerations
108		60
…		…
122		74
123	=over 4	75	=over 4
124		76
125	=item $text	77	=item $text
126		78
127	Rxvt-unicodes special way of encoding text, where one "unicode" character	79	Rxvt-unicode's special way of encoding text, where one "unicode" character
128	always represents one screen cell. See L<ROW_t> for a discussion of this format.	80	always represents one screen cell. See L<ROW_t> for a discussion of this format.
129		81
130	=item $string	82	=item $string
131		83
132	A perl text string, with an emphasis on I<text>. It can store all unicode	84	A perl text string, with an emphasis on I<text>. It can store all unicode
…		…
136	=item $octets	88	=item $octets
137		89
138	Either binary data or - more common - a text string encoded in a	90	Either binary data or - more common - a text string encoded in a
139	locale-specific way.	91	locale-specific way.
140		92
		93	=item $keysym
		94
		95	an integer that is a valid X11 keysym code. You can convert a string
		96	into a keysym and viceversa by using C<XStringToKeysym> and
		97	C<XKeysymToString>.
		98
141	=back	99	=back
142		100
143	=head2 Extension Objects	101	=head2 Extension Objects
144		102
145	Very perl extension is a perl class. A separate perl object is created	103	Every perl extension is a perl class. A separate perl object is created
146	for each terminal and each extension and passed as the first parameter to	104	for each terminal, and each terminal has its own set of extension objects,
147	hooks. So extensions can use their C<$self> object without having to think	105	which are passed as the first parameter to hooks. So extensions can use
148	about other extensions, with the exception of methods and members that	106	their C<$self> object without having to think about clashes with other
		107	extensions or other terminals, with the exception of methods and members
149	begin with an underscore character C<_>: these are reserved for internal	108	that begin with an underscore character C<_>: these are reserved for
150	use.	109	internal use.
151		110
152	Although it isn't a C<urxvt::term> object, you can call all methods of the	111	Although it isn't a C<urxvt::term> object, you can call all methods of the
153	C<urxvt::term> class on this object.	112	C<urxvt::term> class on this object.
154		113
155	It has the following methods and data members:	114	Additional methods only supported for extension objects are described in
		115	the C<urxvt::extension> section below.
		116
		117	=head2 META comments
		118
		119	Rxvt-unicode recognizes special meta comments in extensions that define
		120	different types of metadata.
		121
		122	Currently, it recognises only one such comment:
156		123
157	=over 4	124	=over 4
158		125
159	=item $urxvt_term = $self->{term}	126	=item #:META:RESOURCE:name:type:desc
160		127
161	Returns the C<urxvt::term> object associated with this instance of the	128	The RESOURCE comment defines a resource used by the extension, where
162	extension. This member I<must not> be changed in any way.	129	C<name> is the resource name, C<type> is the resource type, C<boolean>
163		130	or C<string>, and C<desc> is the resource description.
164	=item $self->enable ($hook_name => $cb, [$hook_name => $cb..])
165
166	Dynamically enable the given hooks (named without the C<on_> prefix) for
167	this extension, replacing any previous hook. This is useful when you want
168	to overwrite time-critical hooks only temporarily.
169
170	=item $self->disable ($hook_name[, $hook_name..])
171
172	Dynamically disable the given hooks.
173		131
174	=back	132	=back
175		133
176	=head2 Hooks	134	=head2 Hooks
177		135
178	The following subroutines can be declared in extension files, and will be	136	The following subroutines can be declared in extension files, and will be
179	called whenever the relevant event happens.	137	called whenever the relevant event happens.
180		138
181	The first argument passed to them is an extension oject as described in	139	The first argument passed to them is an extension object as described in
182	the in the C<Extension Objects> section.	140	the in the C<Extension Objects> section.
183		141
184	B<All> of these hooks must return a boolean value. If it is true, then the	142	B<All> of these hooks must return a boolean value. If any of the called
185	event counts as being I<consumed>, and the invocation of other hooks is	143	hooks returns true, then the event counts as being I<consumed>, and the
186	skipped, and the relevant action might not be carried out by the C++ code.	144	relevant action might not be carried out by the C++ code.
187		145
188	I<< When in doubt, return a false value (preferably C<()>). >>	146	I<< When in doubt, return a false value (preferably C<()>). >>
189		147
190	=over 4	148	=over 4
191		149
192	=item on_init $term	150	=item on_init $term
193		151
194	Called after a new terminal object has been initialized, but before	152	Called after a new terminal object has been initialized, but before
195	windows are created or the command gets run. Most methods are unsafe to	153	windows are created or the command gets run. Most methods are unsafe to
196	call or deliver senseless data, as terminal size and other characteristics	154	call or deliver senseless data, as terminal size and other characteristics
197	have not yet been determined. You can safely query and change resources,	155	have not yet been determined. You can safely query and change resources
198	though.	156	and options, though. For many purposes the C<on_start> hook is a better
		157	place.
		158
		159	=item on_start $term
		160
		161	Called at the very end of initialisation of a new terminal, just before
		162	trying to map (display) the toplevel and returning to the main loop.
		163
		164	=item on_destroy $term
		165
		166	Called whenever something tries to destroy terminal, when the terminal is
		167	still fully functional (not for long, though).
199		168
200	=item on_reset $term	169	=item on_reset $term
201		170
202	Called after the screen is "reset" for any reason, such as resizing or	171	Called after the screen is "reset" for any reason, such as resizing or
203	control sequences. Here is where you can react on changes to size-related	172	control sequences. Here is where you can react on changes to size-related
204	variables.	173	variables.
205		174
206	=item on_start $term	175	=item on_child_start $term, $pid
207		176
208	Called at the very end of initialisation of a new terminal, just before	177	Called just after the child process has been C<fork>ed.
209	returning to the mainloop.	178
		179	=item on_child_exit $term, $status
		180
		181	Called just after the child process has exited. C<$status> is the status
		182	from C<waitpid>.
210		183
211	=item on_sel_make $term, $eventtime	184	=item on_sel_make $term, $eventtime
212		185
213	Called whenever a selection has been made by the user, but before the	186	Called whenever a selection has been made by the user, but before the
214	selection text is copied, so changes to the beginning, end or type of the	187	selection text is copied, so changes to the beginning, end or type of the
…		…
221		194
222	Called whenever a selection has been copied, but before the selection is	195	Called whenever a selection has been copied, but before the selection is
223	requested from the server. The selection text can be queried and changed	196	requested from the server. The selection text can be queried and changed
224	by calling C<< $term->selection >>.	197	by calling C<< $term->selection >>.
225		198
226	Returning a true value aborts selection grabbing. It will still be hilighted.	199	Returning a true value aborts selection grabbing. It will still be highlighted.
227		200
228	=item on_sel_extend $term	201	=item on_sel_extend $term
229		202
230	Called whenever the user tries to extend the selection (e.g. with a double	203	Called whenever the user tries to extend the selection (e.g. with a double
231	click) and is either supposed to return false (normal operation), or	204	click) and is either supposed to return false (normal operation), or
232	should extend the selection itelf and return true to suppress the built-in	205	should extend the selection itself and return true to suppress the built-in
233	processing.	206	processing. This can happen multiple times, as long as the callback
		207	returns true, it will be called on every further click by the user and is
		208	supposed to enlarge the selection more and more, if possible.
234		209
235	See the F<selection> example extension.	210	See the F<selection> example extension.
236		211
237	=item on_view_change $term, $offset	212	=item on_view_change $term, $offset
238		213
239	Called whenever the view offset changes, i..e the user or program	214	Called whenever the view offset changes, i.e. the user or program
240	scrolls. Offset C<0> means display the normal terminal, positive values	215	scrolls. Offset C<0> means display the normal terminal, positive values
241	show this many lines of scrollback.	216	show this many lines of scrollback.
242		217
243	=item on_scroll_back $term, $lines, $saved	218	=item on_scroll_back $term, $lines, $saved
244		219
…		…
248		223
249	It is called before lines are scrolled out (so rows 0 .. min ($lines - 1,	224	It is called before lines are scrolled out (so rows 0 .. min ($lines - 1,
250	$nrow - 1) represent the lines to be scrolled out). C<$saved> is the total	225	$nrow - 1) represent the lines to be scrolled out). C<$saved> is the total
251	number of lines that will be in the scrollback buffer.	226	number of lines that will be in the scrollback buffer.
252		227
253	=item on_osc_seq $term, $string	228	=item on_osc_seq $term, $op, $args, $resp
		229
		230	Called on every OSC sequence and can be used to suppress it or modify its
		231	behaviour. The default should be to return an empty list. A true value
		232	suppresses execution of the request completely. Make sure you don't get
		233	confused by recursive invocations when you output an OSC sequence within
		234	this callback.
		235
		236	C<on_osc_seq_perl> should be used for new behaviour.
		237
		238	=item on_osc_seq_perl $term, $args, $resp
254		239
255	Called whenever the B<ESC ] 777 ; string ST> command sequence (OSC =	240	Called whenever the B<ESC ] 777 ; string ST> command sequence (OSC =
256	operating system command) is processed. Cursor position and other state	241	operating system command) is processed. Cursor position and other state
257	information is up-to-date when this happens. For interoperability, the	242	information is up-to-date when this happens. For interoperability, the
258	string should start with the extension name and a colon, to distinguish	243	string should start with the extension name (sans -osc) and a semicolon,
259	it from commands for other extensions, and this might be enforced in the	244	to distinguish it from commands for other extensions, and this might be
260	future.	245	enforced in the future.
		246
		247	For example, C<overlay-osc> uses this:
		248
		249	sub on_osc_seq_perl {
		250	my ($self, $osc, $resp) = @_;
		251
		252	return unless $osc =~ s/^overlay;//;
		253
		254	... process remaining $osc string
		255	}
261		256
262	Be careful not ever to trust (in a security sense) the data you receive,	257	Be careful not ever to trust (in a security sense) the data you receive,
263	as its source can not easily be controleld (e-mail content, messages from	258	as its source can not easily be controlled (e-mail content, messages from
264	other users on the same system etc.).	259	other users on the same system etc.).
		260
		261	For responses, C<$resp> contains the end-of-args separator used by the
		262	sender.
265		263
266	=item on_add_lines $term, $string	264	=item on_add_lines $term, $string
267		265
268	Called whenever text is about to be output, with the text as argument. You	266	Called whenever text is about to be output, with the text as argument. You
269	can filter/change and output the text yourself by returning a true value	267	can filter/change and output the text yourself by returning a true value
…		…
274	=item on_tt_write $term, $octets	272	=item on_tt_write $term, $octets
275		273
276	Called whenever some data is written to the tty/pty and can be used to	274	Called whenever some data is written to the tty/pty and can be used to
277	suppress or filter tty input.	275	suppress or filter tty input.
278		276
		277	=item on_tt_paste $term, $octets
		278
		279	Called whenever text is about to be pasted, with the text as argument. You
		280	can filter/change and paste the text yourself by returning a true value
		281	and calling C<< $term->tt_paste >> yourself. C<$octets> is
		282	locale-encoded.
		283
279	=item on_line_update $term, $row	284	=item on_line_update $term, $row
280		285
281	Called whenever a line was updated or changed. Can be used to filter	286	Called whenever a line was updated or changed. Can be used to filter
282	screen output (e.g. underline urls or other useless stuff). Only lines	287	screen output (e.g. underline urls or other useless stuff). Only lines
283	that are being shown will be filtered, and, due to performance reasons,	288	that are being shown will be filtered, and, due to performance reasons,
…		…
290	later with the already-modified line (e.g. if unrelated parts change), so	295	later with the already-modified line (e.g. if unrelated parts change), so
291	you cannot just toggle rendition bits, but only set them.	296	you cannot just toggle rendition bits, but only set them.
292		297
293	=item on_refresh_begin $term	298	=item on_refresh_begin $term
294		299
295	Called just before the screen gets redrawn. Can be used for overlay	300	Called just before the screen gets redrawn. Can be used for overlay or
296	or similar effects by modify terminal contents in refresh_begin, and	301	similar effects by modifying the terminal contents in refresh_begin, and
297	restoring them in refresh_end. The built-in overlay and selection display	302	restoring them in refresh_end. The built-in overlay and selection display
298	code is run after this hook, and takes precedence.	303	code is run after this hook, and takes precedence.
299		304
300	=item on_refresh_end $term	305	=item on_refresh_end $term
301		306
302	Called just after the screen gets redrawn. See C<on_refresh_begin>.	307	Called just after the screen gets redrawn. See C<on_refresh_begin>.
303		308
		309	=item on_action $term, $string
		310
		311	Called whenever an action is invoked for the corresponding extension
		312	(e.g. via a C<extension:string> builtin action bound to a key, see
		313	description of the B<keysym> resource in the urxvt(1) manpage). The
		314	event is simply the action string. Note that an action event is always
		315	associated to a single extension.
		316
304	=item on_keyboard_command $term, $string	317	=item on_user_command $term, $string *DEPRECATED*
305		318
306	Called whenever the user presses a key combination that has a	319	Called whenever a user-configured event is being activated (e.g. via
307	C<perl:string> action bound to it (see description of the B<keysym>	320	a C<perl:string> action bound to a key, see description of the B<keysym>
308	resource in the @@RXVT_NAME@@(1) manpage).	321	resource in the urxvt(1) manpage).
		322
		323	The event is simply the action string. This interface is going away in
		324	preference to the C<on_action> hook.
		325
		326	=item on_resize_all_windows $term, $new_width, $new_height
		327
		328	Called just after the new window size has been calculated, but before
		329	windows are actually being resized or hints are being set. If this hook
		330	returns a true value, setting of the window hints is being skipped.
		331
		332	=item on_x_event $term, $event
		333
		334	Called on every X event received on the vt window (and possibly other
		335	windows). Should only be used as a last resort. Most event structure
		336	members are not passed.
		337
		338	=item on_root_event $term, $event
		339
		340	Like C<on_x_event>, but is called for events on the root window.
309		341
310	=item on_focus_in $term	342	=item on_focus_in $term
311		343
312	Called whenever the window gets the keyboard focus, before rxvt-unicode	344	Called whenever the window gets the keyboard focus, before rxvt-unicode
313	does focus in processing.	345	does focus in processing.
314		346
315	=item on_focus_out $term	347	=item on_focus_out $term
316		348
317	Called wheneever the window loses keyboard focus, before rxvt-unicode does	349	Called whenever the window loses keyboard focus, before rxvt-unicode does
318	focus out processing.	350	focus out processing.
319		351
		352	=item on_configure_notify $term, $event
		353
		354	=item on_property_notify $term, $event
		355
320	=item on_key_press $term, $event, $keysym, $octets	356	=item on_key_press $term, $event, $keysym, $octets
321		357
322	=item on_key_release $term, $event, $keysym	358	=item on_key_release $term, $event, $keysym
323		359
324	=item on_button_press $term, $event	360	=item on_button_press $term, $event
…		…
329		365
330	=item on_map_notify $term, $event	366	=item on_map_notify $term, $event
331		367
332	=item on_unmap_notify $term, $event	368	=item on_unmap_notify $term, $event
333		369
334	Called whenever the corresponding X event is received for the terminal If	370	Called whenever the corresponding X event is received for the terminal. If
335	the hook returns true, then the even will be ignored by rxvt-unicode.	371	the hook returns true, then the event will be ignored by rxvt-unicode.
336		372
337	The event is a hash with most values as named by Xlib (see the XEvent	373	The event is a hash with most values as named by Xlib (see the XEvent
338	manpage), with the additional members C<row> and C<col>, which are the row	374	manpage), with the additional members C<row> and C<col>, which are the
339	and column under the mouse cursor.	375	(real, not screen-based) row and column under the mouse cursor.
340		376
341	C<on_key_press> additionally receives the string rxvt-unicode would	377	C<on_key_press> additionally receives the string rxvt-unicode would
342	output, if any, in locale-specific encoding.	378	output, if any, in locale-specific encoding.
343		379
344	subwindow.	380	=item on_client_message $term, $event
		381
		382	=item on_wm_protocols $term, $event
		383
		384	=item on_wm_delete_window $term, $event
		385
		386	Called when various types of ClientMessage events are received (all with
		387	format=32, WM_PROTOCOLS or WM_PROTOCOLS:WM_DELETE_WINDOW).
		388
		389	=item on_bell $term
		390
		391	Called on receipt of a bell character.
345		392
346	=back	393	=back
347		394
348	=cut	395	=cut
349		396
350	package urxvt;	397	package urxvt;
351		398
352	use utf8;	399	use utf8;
353	use strict;	400	use strict 'vars';
354	use Carp ();	401	use Carp ();
355	use Scalar::Util ();	402	use Scalar::Util ();
356	use List::Util ();	403	use List::Util ();
357		404
358	our $VERSION = 1;	405	our $VERSION = 1;
359	our $TERM;	406	our $TERM;
		407	our @TERM_INIT; # should go, prevents async I/O etc.
		408	our @TERM_EXT; # should go, prevents async I/O etc.
360	our @HOOKNAME;	409	our @HOOKNAME;
361	our %HOOKTYPE = map +($HOOKNAME[$_] => $_), 0..$#HOOKNAME;	410	our %HOOKTYPE = map +($HOOKNAME[$_] => $_), 0..$#HOOKNAME;
362	our %OPTION;	411	our %OPTION;
363		412
364	our $LIBDIR;	413	our $LIBDIR;
365	our $RESNAME;	414	our $RESNAME;
366	our $RESCLASS;	415	our $RESCLASS;
367	our $RXVTNAME;	416	our $RXVTNAME;
368		417
		418	our $NOCHAR = chr 0xffff;
		419
369	=head2 Variables in the C<urxvt> Package	420	=head2 Variables in the C<urxvt> Package
370		421
371	=over 4	422	=over 4
372		423
373	=item $urxvt::LIBDIR	424	=item $urxvt::LIBDIR
…		…
386	=item $urxvt::TERM	437	=item $urxvt::TERM
387		438
388	The current terminal. This variable stores the current C<urxvt::term>	439	The current terminal. This variable stores the current C<urxvt::term>
389	object, whenever a callback/hook is executing.	440	object, whenever a callback/hook is executing.
390		441
		442	=item @urxvt::TERM_INIT
		443
		444	All code references in this array will be called as methods of the next newly
		445	created C<urxvt::term> object (during the C<on_init> phase). The array
		446	gets cleared before the code references that were in it are being executed,
		447	so references can push themselves onto it again if they so desire.
		448
		449	This complements to the perl-eval command line option, but gets executed
		450	first.
		451
		452	=item @urxvt::TERM_EXT
		453
		454	Works similar to C<@TERM_INIT>, but contains perl package/class names, which
		455	get registered as normal extensions after calling the hooks in C<@TERM_INIT>
		456	but before other extensions. Gets cleared just like C<@TERM_INIT>.
		457
391	=back	458	=back
392		459
393	=head2 Functions in the C<urxvt> Package	460	=head2 Functions in the C<urxvt> Package
394		461
395	=over 4	462	=over 4
396		463
397	=item urxvt::fatal $errormessage	464	=item urxvt::fatal $errormessage
398		465
399	Fatally aborts execution with the given error message. Avoid at all	466	Fatally aborts execution with the given error message (which should
400	costs! The only time this is acceptable is when the terminal process	467	include a trailing newline). Avoid at all costs! The only time this
401	starts up.	468	is acceptable (and useful) is in the init hook, where it prevents the
		469	terminal from starting up.
402		470
403	=item urxvt::warn $string	471	=item urxvt::warn $string
404		472
405	Calls C<rxvt_warn> with the given string which should not include a	473	Calls C<rxvt_warn> with the given string which should include a trailing
406	newline. The module also overwrites the C<warn> builtin with a function	474	newline. The module also overwrites the C<warn> builtin with a function
407	that calls this function.	475	that calls this function.
408		476
409	Using this function has the advantage that its output ends up in the	477	Using this function has the advantage that its output ends up in the
410	correct place, e.g. on stderr of the connecting urxvtc client.	478	correct place, e.g. on stderr of the connecting urxvtc client.
411		479
412	Messages have a size limit of 1023 bytes currently.	480	Messages have a size limit of 1023 bytes currently.
413		481
414	=item $is_safe = urxvt::safe	482	=item @terms = urxvt::termlist
415		483
416	Returns true when it is safe to do potentially unsafe things, such as	484	Returns all urxvt::term objects that exist in this process, regardless of
417	evaluating perl code specified by the user. This is true when urxvt was	485	whether they are started, being destroyed etc., so be careful. Only term
418	started setuid or setgid.	486	objects that have perl extensions attached will be returned (because there
		487	is no urxvt::term object associated with others).
419		488
420	=item $time = urxvt::NOW	489	=item $time = urxvt::NOW
421		490
422	Returns the "current time" (as per the event loop).	491	Returns the "current time" (as per the event loop).
423		492
424	=item urxvt::CurrentTime	493	=item urxvt::CurrentTime
425		494
426	=item urxvt::ShiftMask, LockMask, ControlMask, Mod1Mask, Mod2Mask,	495	=item urxvt::ShiftMask, LockMask, ControlMask, Mod1Mask, Mod2Mask,
427	Mod3Mask, Mod4Mask, Mod5Mask, Button1Mask, Button2Mask, Button3Mask,	496	Mod3Mask, Mod4Mask, Mod5Mask, Button1Mask, Button2Mask, Button3Mask,
428	Button4Mask, Button5Mask, AnyModifier	497	Button4Mask, Button5Mask, AnyModifier
		498
		499	=item urxvt::NoEventMask, KeyPressMask, KeyReleaseMask,
		500	ButtonPressMask, ButtonReleaseMask, EnterWindowMask, LeaveWindowMask,
		501	PointerMotionMask, PointerMotionHintMask, Button1MotionMask, Button2MotionMask,
		502	Button3MotionMask, Button4MotionMask, Button5MotionMask, ButtonMotionMask,
		503	KeymapStateMask, ExposureMask, VisibilityChangeMask, StructureNotifyMask,
		504	ResizeRedirectMask, SubstructureNotifyMask, SubstructureRedirectMask,
		505	FocusChangeMask, PropertyChangeMask, ColormapChangeMask, OwnerGrabButtonMask
		506
		507	=item urxvt::KeyPress, KeyRelease, ButtonPress, ButtonRelease, MotionNotify,
		508	EnterNotify, LeaveNotify, FocusIn, FocusOut, KeymapNotify, Expose,
		509	GraphicsExpose, NoExpose, VisibilityNotify, CreateNotify, DestroyNotify,
		510	UnmapNotify, MapNotify, MapRequest, ReparentNotify, ConfigureNotify,
		511	ConfigureRequest, GravityNotify, ResizeRequest, CirculateNotify,
		512	CirculateRequest, PropertyNotify, SelectionClear, SelectionRequest,
		513	SelectionNotify, ColormapNotify, ClientMessage, MappingNotify
429		514
430	Various constants for use in X calls and event processing.	515	Various constants for use in X calls and event processing.
431		516
432	=back	517	=back
433		518
…		…
450		535
451	=item $rend = urxvt::OVERLAY_RSTYLE	536	=item $rend = urxvt::OVERLAY_RSTYLE
452		537
453	Return the rendition mask used for overlays by default.	538	Return the rendition mask used for overlays by default.
454		539
455	=item $rendbit = urxvt::RS_Bold, RS_Italic, RS_Blink, RS_RVid, RS_Uline	540	=item $rendbit = urxvt::RS_Bold, urxvt::RS_Italic, urxvt::RS_Blink,
		541	urxvt::RS_RVid, urxvt::RS_Uline
456		542
457	Return the bit that enabled bold, italic, blink, reverse-video and	543	Return the bit that enabled bold, italic, blink, reverse-video and
458	underline, respectively. To enable such a style, just logically OR it into	544	underline, respectively. To enable such a style, just logically OR it into
459	the bitset.	545	the bitset.
460		546
…		…
466		552
467	=item $rend = urxvt::SET_FGCOLOR $rend, $new_colour	553	=item $rend = urxvt::SET_FGCOLOR $rend, $new_colour
468		554
469	=item $rend = urxvt::SET_BGCOLOR $rend, $new_colour	555	=item $rend = urxvt::SET_BGCOLOR $rend, $new_colour
470		556
		557	=item $rend = urxvt::SET_COLOR $rend, $new_fg, $new_bg
		558
471	Replace the foreground/background colour in the rendition mask with the	559	Replace the foreground/background colour in the rendition mask with the
472	specified one.	560	specified one.
473		561
474	=item $value = urxvt::GET_CUSTOM $rend	562	=item $value = urxvt::GET_CUSTOM $rend
475		563
…		…
484	=back	572	=back
485		573
486	=cut	574	=cut
487		575
488	BEGIN {	576	BEGIN {
489	urxvt->bootstrap;
490
491	# overwrite perl's warn	577	# overwrite perl's warn
492	*CORE::GLOBAL::warn = sub {	578	*CORE::GLOBAL::warn = sub {
493	my $msg = join "", @_;	579	my $msg = join "", @_;
494	$msg .= "\n"	580	$msg .= "\n"
495	unless $msg =~ /\n$/;	581	unless $msg =~ /\n$/;
496	urxvt::warn ($msg);	582	urxvt::warn ($msg);
497	};	583	};
498
499	delete $ENV{IFS};
500	delete $ENV{CDPATH};
501	delete $ENV{BASH_ENV};
502	$ENV{PATH} = "/bin:/sbin:/usr/bin:/usr/sbin:/usr/local/bin:/usr/local/sbin:/opt/bin:/opt/sbin";
503	}	584	}
504		585
505	my @hook_count;	586	no warnings 'utf8';
		587
		588	sub parse_resource {
		589	my ($term, $name, $isarg, $longopt, $flag, $value) = @_;
		590
		591	$term->scan_extensions;
		592
		593	my $r = $term->{meta}{resource};
		594	keys %$r; # reset iterator
		595	while (my ($k, $v) = each %$r) {
		596	my $pattern = $k;
		597	$pattern =~ y/./-/ if $isarg;
		598	my $prefix = $name;
		599	my $suffix;
		600	if ($pattern =~ /\-$/) {
		601	$prefix = substr $name, 0, length $pattern;
		602	$suffix = substr $name, length $pattern;
		603	}
		604	if ($pattern eq $prefix) {
		605	$name = "$urxvt::RESCLASS.$k$suffix";
		606
		607	push @{ $term->{perl_ext_3} }, $v->[0];
		608
		609	if ($v->[1] eq "boolean") {
		610	$term->put_option_db ($name, $flag ? "true" : "false");
		611	return 1;
		612	} else {
		613	$term->put_option_db ($name, $value);
		614	return 1 + 2;
		615	}
		616	}
		617	}
		618
		619	0
		620	}
		621
		622	sub usage {
		623	my ($term, $usage_type) = @_;
		624
		625	$term->scan_extensions;
		626
		627	my $r = $term->{meta}{resource};
		628
		629	for my $pattern (sort keys %$r) {
		630	my ($ext, $type, $desc) = @{ $r->{$pattern} };
		631
		632	$desc .= " (-pe $ext)";
		633
		634	if ($usage_type == 1) {
		635	$pattern =~ y/./-/;
		636	$pattern =~ s/-$/-.../g;
		637
		638	if ($type eq "boolean") {
		639	urxvt::log sprintf " -%-30s %s\n", "/+$pattern", $desc;
		640	} else {
		641	urxvt::log sprintf " -%-30s %s\n", "$pattern $type", $desc;
		642	}
		643	} else {
		644	$pattern =~ s/\.$/.*/g;
		645	urxvt::log sprintf " %-31s %s\n", "$pattern:", $type;
		646	}
		647	}
		648	}
		649
506	my $verbosity = $ENV{URXVT_PERL_VERBOSITY};	650	my $verbosity = $ENV{URXVT_PERL_VERBOSITY};
507		651
508	sub verbose {	652	sub verbose {
509	my ($level, $msg) = @_;	653	my ($level, $msg) = @_;
510	warn "$msg\n" if $level <= $verbosity;	654	warn "$msg\n" if $level <= $verbosity;
511	}	655	}
512		656
513	my $extension_pkg = "extension0000";
514	my %extension_pkg;	657	my %extension_pkg;
515		658
516	# load a single script into its own package, once only	659	# load a single script into its own package, once only
517	sub extension_package($) {	660	sub extension_package($) {
518	my ($path) = @_;	661	my ($path) = @_;
519		662
520	$extension_pkg{$path} ||= do {	663	$extension_pkg{$path} ||= do {
521	my $pkg = "urxvt::" . ($extension_pkg++);	664	$path =~ /([^\/\\]+)$/;
		665	my $pkg = $1;
		666	$pkg =~ s/[^[:word:]]/_/g;
		667	$pkg = "urxvt::ext::$pkg";
522		668
523	verbose 3, "loading extension '$path' into package '$pkg'";	669	verbose 3, "loading extension '$path' into package '$pkg'";
		670
		671	(${"$pkg\::_NAME"} = $path) =~ s/^.*[\\\/]//; # hackish
524		672
525	open my $fh, "<:raw", $path	673	open my $fh, "<:raw", $path
526	or die "$path: $!";	674	or die "$path: $!";
527		675
528	my $source = untaint	676	my $source =
529	"package $pkg; use strict; use utf8;\n"	677	"package $pkg; use strict 'vars'; use utf8; no warnings 'utf8';\n"
530	. "use base urxvt::term::extension::;\n"
531	. "#line 1 \"$path\"\n{\n"	678	. "#line 1 \"$path\"\n{\n"
532	. (do { local $/; <$fh> })	679	. (do { local $/; <$fh> })
533	. "\n};\n1";	680	. "\n};\n1";
534		681
535	eval $source	682	eval $source
…		…
544	# called by the rxvt core	691	# called by the rxvt core
545	sub invoke {	692	sub invoke {
546	local $TERM = shift;	693	local $TERM = shift;
547	my $htype = shift;	694	my $htype = shift;
548		695
549	if ($htype == 0) { # INIT	696	if ($htype == HOOK_INIT) {
550	my @dirs = ((split /:/, $TERM->resource ("perl_lib")), "$LIBDIR/perl");	697	my @dirs = $TERM->perl_libdirs;
551		698
		699	$TERM->scan_extensions;
		700
552	my %ext_arg;	701	my %ext_arg;
553		702
		703	{
		704	my @init = @TERM_INIT;
		705	@TERM_INIT = ();
		706	$_->($TERM) for @init;
		707	my @pkg = @TERM_EXT;
		708	@TERM_EXT = ();
		709	$TERM->register_package ($_) for @pkg;
		710	}
		711
		712	for (
554	for (map { split /,/, $TERM->resource ("perl_ext_$_") } 1, 2) {	713	(grep $_, map { split /,/, $TERM->resource ("perl_ext_$_") } 1, 2),
		714	@{ delete $TERM->{perl_ext_3} }
		715	) {
555	if ($_ eq "default") {	716	if ($_ eq "default") {
		717
		718	$ext_arg{$_} = []
556	$ext_arg{$_} ||= [] for qw(selection option-popup selection-popup searchable-scrollback);	719	for qw(selection option-popup selection-popup readline searchable-scrollback);
		720
		721	for ($TERM->_keysym_resources) {
		722	next if /^(?:string|command|builtin|builtin-string|perl)/;
		723	next unless /^([A-Za-z0-9_\-]+):/;
		724
		725	my $ext = $1;
		726
		727	$ext_arg{$ext} = [];
		728	}
		729
557	} elsif (/^-(.*)$/) {	730	} elsif (/^-(.*)$/) {
558	delete $ext_arg{$1};	731	delete $ext_arg{$1};
		732
559	} elsif (/^([^<]+)<(.*)>$/) {	733	} elsif (/^([^<]+)<(.*)>$/) {
560	push @{ $ext_arg{$1} }, $2;	734	push @{ $ext_arg{$1} }, $2;
		735
561	} else {	736	} else {
562	$ext_arg{$_} ||= [];	737	$ext_arg{$_} ||= [];
563	}	738	}
564	}	739	}
565		740
566	while (my ($ext, $argv) = each %ext_arg) {	741	for my $ext (sort keys %ext_arg) {
567	my @files = grep -f $_, map "$_/$ext", @dirs;	742	my @files = grep -f $_, map "$_/$ext", @dirs;
568		743
569	if (@files) {	744	if (@files) {
570	$TERM->register_package (extension_package $files[0], $argv);	745	$TERM->register_package (extension_package $files[0], $ext_arg{$ext});
571	} else {	746	} else {
572	warn "perl extension '$ext' not found in perl library search path\n";	747	warn "perl extension '$ext' not found in perl library search path\n";
573	}	748	}
574	}	749	}
575		750
…		…
581		756
582	if (my $cb = $TERM->{_hook}[$htype]) {	757	if (my $cb = $TERM->{_hook}[$htype]) {
583	verbose 10, "$HOOKNAME[$htype] (" . (join ", ", $TERM, @_) . ")"	758	verbose 10, "$HOOKNAME[$htype] (" . (join ", ", $TERM, @_) . ")"
584	if $verbosity >= 10;	759	if $verbosity >= 10;
585		760
586	keys %$cb;	761	if ($htype == HOOK_ACTION) {
		762	# this hook is only sent to the extension with the name
		763	# matching the first arg
		764	my $pkg = shift;
		765	$pkg =~ y/-/_/;
		766	$pkg = "urxvt::ext::$pkg";
587		767
588	while (my ($pkg, $cb) = each %$cb) {	768	$cb = $cb->{$pkg}
		769	or return undef; #TODO: maybe warn user?
		770
		771	$cb = { $pkg => $cb };
		772	}
		773
		774	for my $pkg (keys %$cb) {
589	$retval = eval { $cb->($TERM->{_pkg}{$pkg}, @_) }	775	my $retval_ = eval { $cb->{$pkg}->($TERM->{_pkg}{$pkg} || $TERM, @_) };
590	and last;	776	$retval ||= $retval_;
591		777
592	if ($@) {	778	if ($@) {
593	$TERM->ungrab; # better to lose the grab than the session	779	$TERM->ungrab; # better to lose the grab than the session
594	warn $@;	780	warn $@;
595	}	781	}
596	}	782	}
		783
		784	verbose 11, "$HOOKNAME[$htype] returning <$retval>"
		785	if $verbosity >= 11;
597	}	786	}
598		787
599	if ($htype == 1) { # DESTROY	788	if ($htype == HOOK_DESTROY) {
600	if (my $hook = delete $TERM->{_hook}) {
601	for my $htype (0..$#$hook) {
602	$hook_count[$htype] -= scalar keys %{ $hook->[$htype] || {} }
603	or set_should_invoke $htype, 0;
604	}
605	}
606
607	# clear package objects	789	# clear package objects
608	%$_ = () for values %{ $TERM->{_pkg} };	790	%$_ = () for values %{ $TERM->{_pkg} };
609		791
610	# clear package	792	# clear package
611	%$TERM = ();	793	%$TERM = ();
612	}	794	}
613		795
614	$retval	796	$retval
615	}	797	}
616		798
617	# urxvt::term::extension	799	sub SET_COLOR($$$) {
		800	SET_BGCOLOR (SET_FGCOLOR ($_[0], $_[1]), $_[2])
		801	}
618		802
619	package urxvt::term::extension;	803	sub rend2mask {
620		804	no strict 'refs';
621	sub enable {	805	my ($str, $mask) = (@_, 0);
622	my ($self, %hook) = @_;	806	my %color = ( fg => undef, bg => undef );
623	my $pkg = $self->{_pkg};	807	my @failed;
624		808	for my $spec ( split /\s+/, $str ) {
625	while (my ($name, $cb) = each %hook) {	809	if ( $spec =~ /^([fb]g)[_:-]?(\d+)/i ) {
626	my $htype = $HOOKTYPE{uc $name};	810	$color{lc($1)} = $2;
627	defined $htype	811	} else {
628	or Carp::croak "unsupported hook type '$name'";	812	my $neg = $spec =~ s/^[-^]//;
629		813	unless ( exists &{"RS_$spec"} ) {
630	unless (exists $self->{term}{_hook}[$htype]{$pkg}) {	814	push @failed, $spec;
631	$hook_count[$htype]++	815	next;
632	or urxvt::set_should_invoke $htype, 1;
633	}	816	}
634		817	my $cur = &{"RS_$spec"};
635	$self->{term}{_hook}[$htype]{$pkg} = $cb;	818	if ( $neg ) {
636	}	819	$mask &= ~$cur;
637	}	820	} else {
638		821	$mask |= $cur;
639	sub disable {	822	}
640	my ($self, @hook) = @_;
641	my $pkg = $self->{_pkg};
642
643	for my $name (@hook) {
644	my $htype = $HOOKTYPE{uc $name};
645	defined $htype
646	or Carp::croak "unsupported hook type '$name'";
647
648	if (delete $self->{term}{_hook}[$htype]{$pkg}) {
649	--$hook_count[$htype]
650	or urxvt::set_should_invoke $htype, 0;
651	}	823	}
652	}	824	}
		825	($mask, @color{qw(fg bg)}, \@failed)
653	}	826	}
		827
		828	package urxvt::term::extension;
		829
		830	=head2 The C<urxvt::term::extension> class
		831
		832	Each extension attached to a terminal object is represented by
		833	a C<urxvt::term::extension> object.
		834
		835	You can use these objects, which are passed to all callbacks to store any
		836	state related to the terminal and extension instance.
		837
		838	The methods (And data members) documented below can be called on extension
		839	objects, in addition to call methods documented for the <urxvt::term>
		840	class.
		841
		842	=over 4
		843
		844	=item $urxvt_term = $self->{term}
		845
		846	Returns the C<urxvt::term> object associated with this instance of the
		847	extension. This member I<must not> be changed in any way.
		848
		849	=cut
654		850
655	our $AUTOLOAD;	851	our $AUTOLOAD;
656		852
657	sub AUTOLOAD {	853	sub AUTOLOAD {
658	$AUTOLOAD =~ /:([^:]+)$/	854	$AUTOLOAD =~ /:([^:]+)$/
…		…
671		867
672	sub DESTROY {	868	sub DESTROY {
673	# nop	869	# nop
674	}	870	}
675		871
676	# urxvt::destroy_hook	872	# urxvt::destroy_hook (basically a cheap Guard:: implementation)
677		873
678	sub urxvt::destroy_hook::DESTROY {	874	sub urxvt::destroy_hook::DESTROY {
679	${$_[0]}->();	875	${$_[0]}->();
680	}	876	}
681		877
682	sub urxvt::destroy_hook(&) {	878	sub urxvt::destroy_hook(&) {
683	bless \shift, urxvt::destroy_hook::	879	bless \shift, urxvt::destroy_hook::
684	}	880	}
		881
		882	=item $self->enable ($hook_name => $cb[, $hook_name => $cb..])
		883
		884	Dynamically enable the given hooks (named without the C<on_> prefix) for
		885	this extension, replacing any hook previously installed via C<enable> in
		886	this extension.
		887
		888	This is useful when you want to overwrite time-critical hooks only
		889	temporarily.
		890
		891	To install additional callbacks for the same hook, you can use the C<on>
		892	method of the C<urxvt::term> class.
		893
		894	=item $self->disable ($hook_name[, $hook_name..])
		895
		896	Dynamically disable the given hooks.
		897
		898	=cut
		899
		900	sub enable {
		901	my ($self, %hook) = @_;
		902	my $pkg = $self->{_pkg};
		903
		904	while (my ($name, $cb) = each %hook) {
		905	my $htype = $HOOKTYPE{uc $name};
		906	defined $htype
		907	or Carp::croak "unsupported hook type '$name'";
		908
		909	$self->set_should_invoke ($htype, +1)
		910	unless exists $self->{term}{_hook}[$htype]{$pkg};
		911
		912	$self->{term}{_hook}[$htype]{$pkg} = $cb;
		913	}
		914	}
		915
		916	sub disable {
		917	my ($self, @hook) = @_;
		918	my $pkg = $self->{_pkg};
		919
		920	for my $name (@hook) {
		921	my $htype = $HOOKTYPE{uc $name};
		922	defined $htype
		923	or Carp::croak "unsupported hook type '$name'";
		924
		925	$self->set_should_invoke ($htype, -1)
		926	if delete $self->{term}{_hook}[$htype]{$pkg};
		927	}
		928	}
		929
		930	=item $guard = $self->on ($hook_name => $cb[, $hook_name => $cb..])
		931
		932	Similar to the C<enable> enable, but installs additional callbacks for
		933	the given hook(s) (that is, it doesn't replace existing callbacks), and
		934	returns a guard object. When the guard object is destroyed the callbacks
		935	are disabled again.
		936
		937	=cut
		938
		939	sub urxvt::extension::on_disable::DESTROY {
		940	my $disable = shift;
		941
		942	my $term = delete $disable->{""};
		943
		944	while (my ($htype, $id) = each %$disable) {
		945	delete $term->{_hook}[$htype]{$id};
		946	$term->set_should_invoke ($htype, -1);
		947	}
		948	}
		949
		950	sub on {
		951	my ($self, %hook) = @_;
		952
		953	my $term = $self->{term};
		954
		955	my %disable = ( "" => $term );
		956
		957	while (my ($name, $cb) = each %hook) {
		958	my $htype = $HOOKTYPE{uc $name};
		959	defined $htype
		960	or Carp::croak "unsupported hook type '$name'";
		961
		962	$term->set_should_invoke ($htype, +1);
		963	$term->{_hook}[$htype]{ $disable{$htype} = $cb+0 }
		964	= sub { shift; $cb->($self, @_) }; # very ugly indeed
		965	}
		966
		967	bless \%disable, "urxvt::extension::on_disable"
		968	}
		969
		970	=item $self->bind_action ($hotkey, $action)
		971
		972	=item $self->x_resource ($pattern)
		973
		974	=item $self->x_resource_boolean ($pattern)
		975
		976	These methods support an additional C<%> prefix for C<$action> or
		977	C<$pattern> when called on an extension object, compared to the
		978	C<urxvt::term> methods of the same name - see the description of these
		979	methods in the C<urxvt::term> class for details.
		980
		981	=cut
		982
		983	sub bind_action {
		984	my ($self, $hotkey, $action) = @_;
		985	$action =~ s/^%:/$_[0]{_name}:/;
		986	$self->{term}->bind_action ($hotkey, $action)
		987	}
		988
		989	sub x_resource {
		990	my ($self, $name) = @_;
		991	$name =~ s/^%(\.|$)/$_[0]{_name}$1/;
		992	$self->{term}->x_resource ($name)
		993	}
		994
		995	sub x_resource_boolean {
		996	my ($self, $name) = @_;
		997	$name =~ s/^%(\.|$)/$_[0]{_name}$1/;
		998	$self->{term}->x_resource_boolean ($name)
		999	}
		1000
		1001	=back
		1002
		1003	=cut
685		1004
686	package urxvt::anyevent;	1005	package urxvt::anyevent;
687		1006
688	=head2 The C<urxvt::anyevent> Class	1007	=head2 The C<urxvt::anyevent> Class
689		1008
690	The sole purpose of this class is to deliver an interface to the	1009	The sole purpose of this class is to deliver an interface to the
691	C<AnyEvent> module - any module using it will work inside urxvt without	1010	C<AnyEvent> module - any module using it will work inside urxvt without
692	further programming. The only exception is that you cannot wait on	1011	further programming. The only exception is that you cannot wait on
693	condition variables, but non-blocking condvar use is ok. What this means	1012	condition variables, but non-blocking condvar use is ok.
694	is that you cannot use blocking APIs, but the non-blocking variant should
695	work.
696		1013
697	=cut	1014	In practical terms this means is that you cannot use blocking APIs, but
		1015	the non-blocking variant should work.
698		1016
		1017	=cut
		1018
699	our $VERSION = 1;	1019	our $VERSION = '5.23';
700		1020
701	$INC{"urxvt/anyevent.pm"} = 1; # mark us as there	1021	$INC{"urxvt/anyevent.pm"} = 1; # mark us as there
702	push @AnyEvent::REGISTRY, [urxvt => urxvt::anyevent::];	1022	push @AnyEvent::REGISTRY, [urxvt => urxvt::anyevent::];
703		1023
704	sub timer {	1024	sub timer {
…		…
706		1026
707	my $cb = $arg{cb};	1027	my $cb = $arg{cb};
708		1028
709	urxvt::timer	1029	urxvt::timer
710	->new	1030	->new
711	->start (urxvt::NOW + $arg{after})	1031	->after ($arg{after}, $arg{interval})
712	->cb (sub {	1032	->cb ($arg{interval} ? $cb : sub {
713	$_[0]->stop; # need to cancel manually	1033	$_[0]->stop; # need to cancel manually
714	$cb->();	1034	$cb->();
715	})	1035	})
716	}	1036	}
717		1037
718	sub io {	1038	sub io {
719	my ($class, %arg) = @_;	1039	my ($class, %arg) = @_;
720		1040
721	my $cb = $arg{cb};	1041	my $cb = $arg{cb};
		1042	my $fd = fileno $arg{fh};
		1043	defined $fd or $fd = $arg{fh};
722		1044
723	bless [$arg{fh}, urxvt::iow	1045	bless [$arg{fh}, urxvt::iow
724	->new	1046	->new
725	->fd (fileno $arg{fh})	1047	->fd ($fd)
726	->events (($arg{poll} =~ /r/ ? 1 : 0)	1048	->events (($arg{poll} =~ /r/ ? 1 : 0)
727	| ($arg{poll} =~ /w/ ? 2 : 0))	1049	| ($arg{poll} =~ /w/ ? 2 : 0))
728	->start	1050	->start
729	->cb (sub {	1051	->cb ($cb)
730	$cb->(($_[1] & 1 ? 'r' : '')
731	. ($_[1] & 2 ? 'w' : ''));
732	})],
733	urxvt::anyevent::	1052	], urxvt::anyevent::
		1053	}
		1054
		1055	sub idle {
		1056	my ($class, %arg) = @_;
		1057
		1058	my $cb = $arg{cb};
		1059
		1060	urxvt::iw
		1061	->new
		1062	->start
		1063	->cb ($cb)
		1064	}
		1065
		1066	sub child {
		1067	my ($class, %arg) = @_;
		1068
		1069	my $cb = $arg{cb};
		1070
		1071	urxvt::pw
		1072	->new
		1073	->start ($arg{pid})
		1074	->cb (sub {
		1075	$_[0]->stop; # need to cancel manually
		1076	$cb->($_[0]->rpid, $_[0]->rstatus);
		1077	})
734	}	1078	}
735		1079
736	sub DESTROY {	1080	sub DESTROY {
737	$_[0][1]->stop;	1081	$_[0][1]->stop;
738	}	1082	}
739		1083
740	sub condvar {	1084	# only needed for AnyEvent < 6 compatibility
741	bless \my $flag, urxvt::anyevent::condvar::	1085	sub one_event {
742	}
743
744	sub urxvt::anyevent::condvar::broadcast {
745	${$_[0]}++;
746	}
747
748	sub urxvt::anyevent::condvar::wait {
749	unless (${$_[0]}) {
750	Carp::croak "AnyEvent->condvar blocking wait unsupported in urxvt, use a non-blocking API";	1086	Carp::croak "AnyEvent->one_event blocking wait unsupported in urxvt, use a non-blocking API";
751	}
752	}	1087	}
753		1088
754	package urxvt::term;	1089	package urxvt::term;
755		1090
756	=head2 The C<urxvt::term> Class	1091	=head2 The C<urxvt::term> Class
…		…
762	# find on_xxx subs in the package and register them	1097	# find on_xxx subs in the package and register them
763	# as hooks	1098	# as hooks
764	sub register_package {	1099	sub register_package {
765	my ($self, $pkg, $argv) = @_;	1100	my ($self, $pkg, $argv) = @_;
766		1101
		1102	no strict 'refs';
		1103
		1104	urxvt::verbose 6, "register package $pkg to $self";
		1105
		1106	@{"$pkg\::ISA"} = urxvt::term::extension::;
		1107
767	my $proxy = bless {	1108	my $proxy = bless {
768	_pkg => $pkg,	1109	_pkg => $pkg,
		1110	_name => ${"$pkg\::_NAME"}, # hackish
769	argv => $argv,	1111	argv => $argv,
770	}, $pkg;	1112	}, $pkg;
771	Scalar::Util::weaken ($proxy->{term} = $self);	1113	Scalar::Util::weaken ($proxy->{term} = $self);
772		1114
773	$self->{_pkg}{$pkg} = $proxy;	1115	$self->{_pkg}{$pkg} = $proxy;
774		1116
…		…
777	$proxy->enable ($name => $ref);	1119	$proxy->enable ($name => $ref);
778	}	1120	}
779	}	1121	}
780	}	1122	}
781		1123
		1124	sub perl_libdirs {
		1125	map { split /:/ }
		1126	$_[0]->resource ("perl_lib"),
		1127	$ENV{URXVT_PERL_LIB},
		1128	"$ENV{HOME}/.urxvt/ext",
		1129	"$LIBDIR/perl"
		1130	}
		1131
		1132	# scan for available extensions and collect their metadata
		1133	sub scan_extensions {
		1134	my ($self) = @_;
		1135
		1136	return if exists $self->{meta};
		1137
		1138	my @urxvtdirs = perl_libdirs $self;
		1139	# my @cpandirs = grep -d, map "$_/URxvt/Ext", @INC;
		1140
		1141	$self->{meta} = \my %meta;
		1142
		1143	# first gather extensions
		1144
		1145	my $gather = sub {
		1146	my ($dir, $core) = @_;
		1147
		1148	opendir my $fh, $dir
		1149	or return;
		1150
		1151	for my $ext (readdir $fh) {
		1152	$ext !~ /^\./
		1153	or next;
		1154
		1155	open my $fh, "<", "$dir/$ext"
		1156	or next;
		1157
		1158	-f $fh
		1159	or next;
		1160
		1161	$ext =~ s/\.uext$// or $core
		1162	or next;
		1163
		1164	my %ext = (dir => $dir);
		1165
		1166	while (<$fh>) {
		1167	if (/^#:META:(?:X_)?RESOURCE:(.*)/) {
		1168	my ($pattern, $type, $desc) = split /:/, $1;
		1169	$pattern =~ s/^%(\.|$)/$ext$1/g; # % in pattern == extension name
		1170	if ($pattern =~ /[^a-zA-Z0-9\-\.]/) {
		1171	warn "$dir/$ext: meta resource '$pattern' contains illegal characters (not alphanumeric nor . nor *)\n";
		1172	} else {
		1173	$ext{resource}{$pattern} = [$ext, $type, $desc];
		1174	}
		1175	} elsif (/^\s*(?:#|$)/) {
		1176	# skip other comments and empty lines
		1177	} else {
		1178	last; # stop parsing on first non-empty non-comment line
		1179	}
		1180	}
		1181
		1182	$meta{ext}{$ext} = \%ext;
		1183	}
		1184	};
		1185
		1186	# $gather->($_, 0) for @cpandirs;
		1187	$gather->($_, 1) for @urxvtdirs;
		1188
		1189	# and now merge resources
		1190
		1191	$meta{resource} = \my %resource;
		1192
		1193	while (my ($k, $v) = each %{ $meta{ext} }) {
		1194	#TODO: should check for extensions overriding each other
		1195	%resource = (%resource, %{ $v->{resource} });
		1196	}
		1197	}
		1198
782	=item $term = new urxvt::term $envhashref, $rxvtname, [arg...]	1199	=item $term = new urxvt::term $envhashref, $rxvtname, [arg...]
783		1200
784	Creates a new terminal, very similar as if you had started it with system	1201	Creates a new terminal, very similar as if you had started it with system
785	C<$rxvtname, arg...>. C<$envhashref> must be a reference to a C<%ENV>-like	1202	C<$rxvtname, arg...>. C<$envhashref> must be a reference to a C<%ENV>-like
786	hash which defines the environment of the new terminal.	1203	hash which defines the environment of the new terminal.
787		1204
788	Croaks (and probably outputs an error message) if the new instance	1205	Croaks (and probably outputs an error message) if the new instance
789	couldn't be created. Returns C<undef> if the new instance didn't	1206	couldn't be created. Returns C<undef> if the new instance didn't
790	initialise perl, and the terminal object otherwise. The C<init> and	1207	initialise perl, and the terminal object otherwise. The C<init> and
791	C<start> hooks will be called during this call.	1208	C<start> hooks will be called before this call returns, and are free to
		1209	refer to global data (which is race free).
792		1210
793	=cut	1211	=cut
794		1212
795	sub new {	1213	sub new {
796	my ($class, $env, @args) = @_;	1214	my ($class, $env, @args) = @_;
797		1215
		1216	$env or Carp::croak "environment hash missing in call to urxvt::term->new";
		1217	@args or Carp::croak "name argument missing in call to urxvt::term->new";
		1218
798	_new ([ map "$_=$env->{$_}", keys %$env ], @args);	1219	_new ([ map "$_=$env->{$_}", keys %$env ], \@args);
799	}	1220	}
800		1221
801	=item $term->destroy	1222	=item $term->destroy
802		1223
803	Destroy the terminal object (close the window, free resources	1224	Destroy the terminal object (close the window, free resources
804	etc.). Please note that @@RXVT_NAME@@ will not exit as long as any event	1225	etc.). Please note that urxvt will not exit as long as any event
805	watchers (timers, io watchers) are still active.	1226	watchers (timers, io watchers) are still active.
		1227
		1228	=item $term->exec_async ($cmd[, @args])
		1229
		1230	Works like the combination of the C<fork>/C<exec> builtins, which executes
		1231	("starts") programs in the background. This function takes care of setting
		1232	the user environment before exec'ing the command (e.g. C<PATH>) and should
		1233	be preferred over explicit calls to C<exec> or C<system>.
		1234
		1235	Returns the pid of the subprocess or C<undef> on error.
		1236
		1237	=cut
		1238
		1239	sub exec_async {
		1240	my $self = shift;
		1241
		1242	my $pid = fork;
		1243
		1244	return $pid
		1245	if !defined $pid or $pid;
		1246
		1247	%ENV = %{ $self->env };
		1248
		1249	exec @_;
		1250	urxvt::_exit 255;
		1251	}
806		1252
807	=item $isset = $term->option ($optval[, $set])	1253	=item $isset = $term->option ($optval[, $set])
808		1254
809	Returns true if the option specified by C<$optval> is enabled, and	1255	Returns true if the option specified by C<$optval> is enabled, and
810	optionally change it. All option values are stored by name in the hash	1256	optionally change it. All option values are stored by name in the hash
811	C<%urxvt::OPTION>. Options not enabled in this binary are not in the hash.	1257	C<%urxvt::OPTION>. Options not enabled in this binary are not in the hash.
812		1258
813	Here is a a likely non-exhaustive list of option names, please see the	1259	Here is a likely non-exhaustive list of option names, please see the
814	source file F</src/optinc.h> to see the actual list:	1260	source file F</src/optinc.h> to see the actual list:
815		1261
816	borderLess console cursorBlink cursorUnderline hold iconic insecure	1262	borderLess buffered console cursorBlink cursorUnderline hold iconic
817	intensityStyles jumpScroll loginShell mapAlert meta8 mouseWheelScrollPage	1263	insecure intensityStyles iso14755 iso14755_52 jumpScroll loginShell
		1264	mapAlert meta8 mouseWheelScrollPage override_redirect pastableTabs
818	pastableTabs pointerBlank reverseVideo scrollBar scrollBar_floating	1265	pointerBlank reverseVideo scrollBar scrollBar_floating scrollBar_right
819	scrollBar_right scrollTtyKeypress scrollTtyOutput scrollWithBuffer	1266	scrollTtyKeypress scrollTtyOutput scrollWithBuffer secondaryScreen
820	secondaryScreen secondaryScroll skipBuiltinGlyphs transparent	1267	secondaryScroll skipBuiltinGlyphs skipScroll transparent tripleclickwords
821	tripleclickwords utmpInhibit visualBell	1268	urgentOnBell utmpInhibit visualBell
822		1269
823	=item $value = $term->resource ($name[, $newval])	1270	=item $value = $term->resource ($name[, $newval])
824		1271
825	Returns the current resource value associated with a given name and	1272	Returns the current resource value associated with a given name and
826	optionally sets a new value. Setting values is most useful in the C<init>	1273	optionally sets a new value. Setting values is most useful in the C<init>
…		…
835	likely change).	1282	likely change).
836		1283
837	Please note that resource strings will currently only be freed when the	1284	Please note that resource strings will currently only be freed when the
838	terminal is destroyed, so changing options frequently will eat memory.	1285	terminal is destroyed, so changing options frequently will eat memory.
839		1286
840	Here is a a likely non-exhaustive list of resource names, not all of which	1287	Here is a likely non-exhaustive list of resource names, not all of which
841	are supported in every build, please see the source file F</src/rsinc.h>	1288	are supported in every build, please see the source file F</src/rsinc.h>
842	to see the actual list:	1289	to see the actual list:
843		1290
844	answerbackstring backgroundPixmap backspace_key boldFont boldItalicFont	1291	answerbackstring backgroundPixmap backspace_key blurradius
845	borderLess color cursorBlink cursorUnderline cutchars delete_key	1292	boldFont boldItalicFont borderLess buffered chdir color cursorBlink
846	display_name embed ext_bwidth fade font geometry hold iconName	1293	cursorUnderline cutchars delete_key depth display_name embed ext_bwidth
847	imFont imLocale inputMethod insecure int_bwidth intensityStyles	1294	fade font geometry hold iconName iconfile imFont imLocale inputMethod
		1295	insecure int_bwidth intensityStyles iso14755 iso14755_52 italicFont
848	italicFont jumpScroll lineSpace loginShell mapAlert menu meta8 modifier	1296	jumpScroll letterSpace lineSpace loginShell mapAlert meta8 modifier
849	mouseWheelScrollPage name pastableTabs path perl_eval perl_ext_1 perl_ext_2	1297	mouseWheelScrollPage name override_redirect pastableTabs path perl_eval
850	perl_lib pointerBlank pointerBlankDelay preeditType print_pipe pty_fd	1298	perl_ext_1 perl_ext_2 perl_lib pointerBlank pointerBlankDelay
851	reverseVideo saveLines scrollBar scrollBar_align scrollBar_floating	1299	preeditType print_pipe pty_fd reverseVideo saveLines scrollBar
852	scrollBar_right scrollBar_thickness scrollTtyKeypress scrollTtyOutput	1300	scrollBar_align scrollBar_floating scrollBar_right scrollBar_thickness
853	scrollWithBuffer scrollstyle secondaryScreen secondaryScroll selectstyle	1301	scrollTtyKeypress scrollTtyOutput scrollWithBuffer scrollstyle
854	shade term_name title transparent transparent_all tripleclickwords	1302	secondaryScreen secondaryScroll shade skipBuiltinGlyphs skipScroll
		1303	term_name title transient_for transparent tripleclickwords urgentOnBell
855	utmpInhibit visualBell	1304	utmpInhibit visualBell
856		1305
857	=cut	1306	=cut
858		1307
859	sub resource($$;$) {	1308	sub resource($$;$) {
860	my ($self, $name) = (shift, shift);	1309	my ($self, $name) = (shift, shift);
861	unshift @_, $self, $name, ($name =~ s/\s*\+\s*(\d+)$// ? $1 : 0);	1310	unshift @_, $self, $name, ($name =~ s/\s*\+\s*(\d+)$// ? $1 : 0);
862	&urxvt::term::_resource	1311	goto &urxvt::term::_resource
863	}	1312	}
864		1313
865	=item $success = $term->parse_keysym ($keysym_spec, $command_string)	1314	=item $value = $term->x_resource ($pattern)
866		1315
		1316	Returns the X-Resource for the given pattern, excluding the program or
		1317	class name, i.e. C<< $term->x_resource ("boldFont") >> should return the
		1318	same value as used by this instance of rxvt-unicode. Returns C<undef> if no
		1319	resource with that pattern exists.
		1320
		1321	Extensions that define extra resources also need to call this method
		1322	to access their values.
		1323
		1324	If the method is called on an extension object (basically, from an
		1325	extension), then the special prefix C<%.> will be replaced by the name of
		1326	the extension and a dot, and the lone string C<%> will be replaced by the
		1327	extension name itself. This makes it possible to code extensions so you
		1328	can rename them and get a new set of resources without having to change
		1329	the actual code.
		1330
		1331	This method should only be called during the C<on_start> hook, as there is
		1332	only one resource database per display, and later invocations might return
		1333	the wrong resources.
		1334
		1335	=item $value = $term->x_resource_boolean ($pattern)
		1336
		1337	Like C<x_resource>, above, but interprets the string value as a boolean
		1338	and returns C<1> for true values, C<0> for false values and C<undef> if
		1339	the resource or option isn't specified.
		1340
		1341	You should always use this method to parse boolean resources.
		1342
		1343	=cut
		1344
		1345	sub x_resource_boolean {
		1346	my $res = &x_resource;
		1347
		1348	$res =~ /^\s*(?:true|yes|on|1)\s*$/i ? 1 : defined $res && 0
		1349	}
		1350
		1351	=item $action = $term->lookup_keysym ($keysym, $state)
		1352
		1353	Returns the action bound to key combination C<($keysym, $state)>,
		1354	if a binding for it exists, and C<undef> otherwise.
		1355
		1356	=item $success = $term->bind_action ($key, $action)
		1357
867	Adds a keymap translation exactly as specified via a resource. See the	1358	Adds a key binding exactly as specified via a C<keysym> resource. See the
868	C<keysym> resource in the @@RXVT_NAME@@(1) manpage.	1359	C<keysym> resource in the urxvt(1) manpage.
		1360
		1361	To add default bindings for actions, an extension should call C<<
		1362	->bind_action >> in its C<init> hook for every such binding. Doing it
		1363	in the C<init> hook allows users to override or remove the binding
		1364	again.
		1365
		1366	Example: the C<searchable-scrollback> by default binds itself
		1367	on C<Meta-s>, using C<< $self->bind_action >>, which calls C<<
		1368	$term->bind_action >>.
		1369
		1370	sub init {
		1371	my ($self) = @_;
		1372
		1373	$self->bind_action ("M-s" => "%:start");
		1374	}
869		1375
870	=item $rend = $term->rstyle ([$new_rstyle])	1376	=item $rend = $term->rstyle ([$new_rstyle])
871		1377
872	Return and optionally change the current rendition. Text that is output by	1378	Return and optionally change the current rendition. Text that is output by
873	the terminal application will use this style.	1379	the terminal application will use this style.
…		…
881		1387
882	=item ($row, $col) = $term->selection_beg ([$row, $col])	1388	=item ($row, $col) = $term->selection_beg ([$row, $col])
883		1389
884	=item ($row, $col) = $term->selection_end ([$row, $col])	1390	=item ($row, $col) = $term->selection_end ([$row, $col])
885		1391
886	Return the current values of the selection mark, begin or end positions,	1392	Return the current values of the selection mark, begin or end positions.
887	and optionally set them to new values.
888		1393
		1394	When arguments are given, then the selection coordinates are set to
		1395	C<$row> and C<$col>, and the selection screen is set to the current
		1396	screen.
		1397
		1398	=item $screen = $term->selection_screen ([$screen])
		1399
		1400	Returns the current selection screen, and then optionally sets it.
		1401
		1402	=item $term->selection_make ($eventtime[, $rectangular])
		1403
		1404	Tries to make a selection as set by C<selection_beg> and
		1405	C<selection_end>. If C<$rectangular> is true (default: false), a
		1406	rectangular selection will be made. This is the preferred function to make
		1407	a selection.
		1408
889	=item $success = $term->selection_grab ($eventtime)	1409	=item $success = $term->selection_grab ($eventtime[, $clipboard])
890		1410
891	Try to request the primary selection from the server (for example, as set	1411	Try to acquire ownership of the primary (clipboard if C<$clipboard> is
892	by the next method).	1412	true) selection from the server. The corresponding text can be set
		1413	with the next method. No visual feedback will be given. This function
		1414	is mostly useful from within C<on_sel_grab> hooks.
893		1415
894	=item $oldtext = $term->selection ([$newtext])	1416	=item $oldtext = $term->selection ([$newtext, $clipboard])
895		1417
896	Return the current selection text and optionally replace it by C<$newtext>.	1418	Return the current selection (clipboard if C<$clipboard> is true) text
		1419	and optionally replace it by C<$newtext>.
		1420
		1421	=item $term->selection_clear ([$clipboard])
		1422
		1423	Revoke ownership of the primary (clipboard if C<$clipboard> is true) selection.
897		1424
898	=item $term->overlay_simple ($x, $y, $text)	1425	=item $term->overlay_simple ($x, $y, $text)
899		1426
900	Create a simple multi-line overlay box. See the next method for details.	1427	Create a simple multi-line overlay box. See the next method for details.
901		1428
…		…
931		1458
932	The methods currently supported on C<urxvt::overlay> objects are:	1459	The methods currently supported on C<urxvt::overlay> objects are:
933		1460
934	=over 4	1461	=over 4
935		1462
936	=item $overlay->set ($x, $y, $text, $rend)	1463	=item $overlay->set ($x, $y, $text[, $rend])
937		1464
938	Similar to C<< $term->ROW_t >> and C<< $term->ROW_r >> in that it puts	1465	Similar to C<< $term->ROW_t >> and C<< $term->ROW_r >> in that it puts
939	text in rxvt-unicode's special encoding and an array of rendition values	1466	text in rxvt-unicode's special encoding and an array of rendition values
940	at a specific position inside the overlay.	1467	at a specific position inside the overlay.
		1468
		1469	If C<$rend> is missing, then the rendition will not be changed.
941		1470
942	=item $overlay->hide	1471	=item $overlay->hide
943		1472
944	If visible, hide the overlay, but do not destroy it.	1473	If visible, hide the overlay, but do not destroy it.
945		1474
…		…
990	Convert the given locale-encoded octets into a perl string.	1519	Convert the given locale-encoded octets into a perl string.
991		1520
992	=item $term->scr_xor_span ($beg_row, $beg_col, $end_row, $end_col[, $rstyle])	1521	=item $term->scr_xor_span ($beg_row, $beg_col, $end_row, $end_col[, $rstyle])
993		1522
994	XORs the rendition values in the given span with the provided value	1523	XORs the rendition values in the given span with the provided value
995	(default: C<RS_RVid>). Useful in refresh hooks to provide effects similar	1524	(default: C<RS_RVid>), which I<MUST NOT> contain font styles. Useful in
996	to the selection.	1525	refresh hooks to provide effects similar to the selection.
997		1526
998	=item $term->scr_xor_rect ($beg_row, $beg_col, $end_row, $end_col[, $rstyle1[, $rstyle2]])	1527	=item $term->scr_xor_rect ($beg_row, $beg_col, $end_row, $end_col[, $rstyle1[, $rstyle2]])
999		1528
1000	Similar to C<scr_xor_span>, but xors a rectangle instead. Trailing	1529	Similar to C<scr_xor_span>, but xors a rectangle instead. Trailing
1001	whitespace will additionally be xored with the C<$rstyle2>, which defaults	1530	whitespace will additionally be xored with the C<$rstyle2>, which defaults
1002	to C<RS_RVid | RS_Uline>, which removes reverse video again and underlines	1531	to C<RS_RVid | RS_Uline>, which removes reverse video again and underlines
1003	it instead.	1532	it instead. Both styles I<MUST NOT> contain font styles.
1004		1533
1005	=item $term->scr_bell	1534	=item $term->scr_bell
1006		1535
1007	Ring the bell!	1536	Ring the bell!
1008		1537
1009	=item $term->scr_add_lines ($string)	1538	=item $term->scr_add_lines ($string)
1010		1539
1011	Write the given text string to the screen, as if output by the application	1540	Write the given text string to the screen, as if output by the application
1012	running inside the terminal. It may not contain command sequences (escape	1541	running inside the terminal. It may not contain command sequences (escape
1013	codes), but is free to use line feeds, carriage returns and tabs. The	1542	codes - see C<cmd_parse> for that), but is free to use line feeds,
1014	string is a normal text string, not in locale-dependent encoding.	1543	carriage returns and tabs. The string is a normal text string, not in
		1544	locale-dependent encoding.
1015		1545
1016	Normally its not a good idea to use this function, as programs might be	1546	Normally its not a good idea to use this function, as programs might be
1017	confused by changes in cursor position or scrolling. Its useful inside a	1547	confused by changes in cursor position or scrolling. Its useful inside a
1018	C<on_add_lines> hook, though.	1548	C<on_add_lines> hook, though.
1019		1549
		1550	=item $term->scr_change_screen ($screen)
		1551
		1552	Switch to given screen - 0 primary, 1 secondary.
		1553
1020	=item $term->cmd_parse ($octets)	1554	=item $term->cmd_parse ($octets)
1021		1555
1022	Similar to C<scr_add_lines>, but the argument must be in the	1556	Similar to C<scr_add_lines>, but the argument must be in the
1023	locale-specific encoding of the terminal and can contain command sequences	1557	locale-specific encoding of the terminal and can contain command sequences
1024	(escape codes) that will be interpreted.	1558	(escape codes) that will be interpreted.
1025		1559
1026	=item $term->tt_write ($octets)	1560	=item $term->tt_write ($octets)
1027		1561
1028	Write the octets given in C<$data> to the tty (i.e. as program input). To	1562	Write the octets given in C<$octets> to the tty (i.e. as user input
		1563	to the program, see C<cmd_parse> for the opposite direction). To pass
1029	pass characters instead of octets, you should convert your strings first	1564	characters instead of octets, you should convert your strings first to the
1030	to the locale-specific encoding using C<< $term->locale_encode >>.	1565	locale-specific encoding using C<< $term->locale_encode >>.
		1566
		1567	=item $term->tt_write_user_input ($octets)
		1568
		1569	Like C<tt_write>, but should be used when writing strings in response to
		1570	the user pressing a key, to invoke the additional actions requested by
		1571	the user for that case (C<tt_write> doesn't do that).
		1572
		1573	The typical use case would be inside C<on_action> hooks.
		1574
		1575	=item $term->tt_paste ($octets)
		1576
		1577	Write the octets given in C<$octets> to the tty as a paste, converting NL to
		1578	CR and bracketing the data with control sequences if bracketed paste mode
		1579	is set.
1031		1580
1032	=item $old_events = $term->pty_ev_events ([$new_events])	1581	=item $old_events = $term->pty_ev_events ([$new_events])
1033		1582
1034	Replaces the event mask of the pty watcher by the given event mask. Can	1583	Replaces the event mask of the pty watcher by the given event mask. Can
1035	be used to suppress input and output handling to the pty/tty. See the	1584	be used to suppress input and output handling to the pty/tty. See the
1036	description of C<< urxvt::timer->events >>. Make sure to always restore	1585	description of C<< urxvt::timer->events >>. Make sure to always restore
1037	the previous value.	1586	the previous value.
1038		1587
		1588	=item $fd = $term->pty_fd
		1589
		1590	Returns the master file descriptor for the pty in use, or C<-1> if no pty
		1591	is used.
		1592
1039	=item $windowid = $term->parent	1593	=item $windowid = $term->parent
1040		1594
1041	Return the window id of the toplevel window.	1595	Return the window id of the toplevel window.
1042		1596
1043	=item $windowid = $term->vt	1597	=item $windowid = $term->vt
1044		1598
1045	Return the window id of the terminal window.	1599	Return the window id of the terminal window.
1046		1600
		1601	=item $term->vt_emask_add ($x_event_mask)
		1602
		1603	Adds the specified events to the vt event mask. Useful e.g. when you want
		1604	to receive pointer events all the times:
		1605
		1606	$term->vt_emask_add (urxvt::PointerMotionMask);
		1607
		1608	=item $term->set_urgency ($set)
		1609
		1610	Enable/disable the urgency hint on the toplevel window.
		1611
		1612	=item $term->focus_in
		1613
		1614	=item $term->focus_out
		1615
		1616	=item $term->key_press ($state, $keycode[, $time])
		1617
		1618	=item $term->key_release ($state, $keycode[, $time])
		1619
		1620	Deliver various fake events to to terminal.
		1621
1047	=item $window_width = $term->width	1622	=item $window_width = $term->width ([$new_value])
1048		1623
1049	=item $window_height = $term->height	1624	=item $window_height = $term->height ([$new_value])
1050		1625
1051	=item $font_width = $term->fwidth	1626	=item $font_width = $term->fwidth ([$new_value])
1052		1627
1053	=item $font_height = $term->fheight	1628	=item $font_height = $term->fheight ([$new_value])
1054		1629
1055	=item $font_ascent = $term->fbase	1630	=item $font_ascent = $term->fbase ([$new_value])
1056		1631
1057	=item $terminal_rows = $term->nrow	1632	=item $terminal_rows = $term->nrow ([$new_value])
1058		1633
1059	=item $terminal_columns = $term->ncol	1634	=item $terminal_columns = $term->ncol ([$new_value])
1060		1635
1061	=item $has_focus = $term->focus	1636	=item $has_focus = $term->focus ([$new_value])
1062		1637
1063	=item $is_mapped = $term->mapped	1638	=item $is_mapped = $term->mapped ([$new_value])
1064		1639
1065	=item $max_scrollback = $term->saveLines	1640	=item $max_scrollback = $term->saveLines ([$new_value])
1066		1641
1067	=item $nrow_plus_saveLines = $term->total_rows	1642	=item $nrow_plus_saveLines = $term->total_rows ([$new_value])
1068		1643
1069	=item $lines_in_scrollback = $term->nsaved	1644	=item $topmost_scrollback_row = $term->top_row ([$new_value])
1070		1645
1071	Return various integers describing terminal characteristics.	1646	Return various integers describing terminal characteristics. If an
		1647	argument is given, changes the value and returns the previous one.
1072		1648
1073	=item $x_display = $term->display_id	1649	=item $x_display = $term->display_id
1074		1650
1075	Return the DISPLAY used by rxvt-unicode.	1651	Return the DISPLAY used by rxvt-unicode.
1076		1652
…		…
1081	=item $env = $term->env	1657	=item $env = $term->env
1082		1658
1083	Returns a copy of the environment in effect for the terminal as a hashref	1659	Returns a copy of the environment in effect for the terminal as a hashref
1084	similar to C<\%ENV>.	1660	similar to C<\%ENV>.
1085		1661
		1662	=item @envv = $term->envv
		1663
		1664	Returns the environment as array of strings of the form C<VAR=VALUE>.
		1665
		1666	=item @argv = $term->argv
		1667
		1668	Return the argument vector as this terminal, similar to @ARGV, but
		1669	includes the program name as first element.
		1670
1086	=cut	1671	=cut
1087		1672
1088	sub env {	1673	sub env {
1089	if (my $env = $_[0]->_env) {
1090	+{ map /^([^=]+)(?:=(.*))?$/s && ($1 => $2), @$env }	1674	+{ map /^([^=]+)(?:=(.*))?$/s && ($1 => $2), $_[0]->envv }
1091	} else {
1092	+{ %ENV }
1093	}
1094	}	1675	}
1095		1676
1096	=item $modifiermask = $term->ModLevel3Mask	1677	=item $modifiermask = $term->ModLevel3Mask
1097		1678
1098	=item $modifiermask = $term->ModMetaMask	1679	=item $modifiermask = $term->ModMetaMask
…		…
1100	=item $modifiermask = $term->ModNumLockMask	1681	=item $modifiermask = $term->ModNumLockMask
1101		1682
1102	Return the modifier masks corresponding to the "ISO Level 3 Shift" (often	1683	Return the modifier masks corresponding to the "ISO Level 3 Shift" (often
1103	AltGr), the meta key (often Alt) and the num lock key, if applicable.	1684	AltGr), the meta key (often Alt) and the num lock key, if applicable.
1104		1685
		1686	=item $screen = $term->current_screen
		1687
		1688	Returns the currently displayed screen (0 primary, 1 secondary).
		1689
		1690	=item $cursor_is_hidden = $term->hidden_cursor
		1691
		1692	Returns whether the cursor is currently hidden or not.
		1693
1105	=item $view_start = $term->view_start ([$newvalue])	1694	=item $view_start = $term->view_start ([$newvalue])
1106		1695
1107	Returns the negative row number of the topmost line. Minimum value is	1696	Returns the row number of the topmost displayed line. Maximum value is
1108	C<0>, which displays the normal terminal contents. Larger values scroll	1697	C<0>, which displays the normal terminal contents. Lower values scroll
1109	this many lines into the scrollback buffer.	1698	this many lines into the scrollback buffer.
1110		1699
1111	=item $term->want_refresh	1700	=item $term->want_refresh
1112		1701
1113	Requests a screen refresh. At the next opportunity, rxvt-unicode will	1702	Requests a screen refresh. At the next opportunity, rxvt-unicode will
1114	compare the on-screen display with its stored representation. If they	1703	compare the on-screen display with its stored representation. If they
1115	differ, it redraws the differences.	1704	differ, it redraws the differences.
1116		1705
1117	Used after changing terminal contents to display them.	1706	Used after changing terminal contents to display them.
1118		1707
		1708	=item $term->refresh_check
		1709
		1710	Checks if a refresh has been requested and, if so, schedules one.
		1711
1119	=item $text = $term->ROW_t ($row_number[, $new_text[, $start_col]])	1712	=item $text = $term->ROW_t ($row_number[, $new_text[, $start_col]])
1120		1713
1121	Returns the text of the entire row with number C<$row_number>. Row C<0>	1714	Returns the text of the entire row with number C<$row_number>. Row C<< $term->top_row >>
1122	is the topmost terminal line, row C<< $term->$ncol-1 >> is the bottommost	1715	is the topmost terminal line, row C<< $term->nrow-1 >> is the bottommost
1123	terminal line. The scrollback buffer starts at line C<-1> and extends to
1124	line C<< -$term->nsaved >>. Nothing will be returned if a nonexistent line	1716	terminal line. Nothing will be returned if a nonexistent line
1125	is requested.	1717	is requested.
1126		1718
1127	If C<$new_text> is specified, it will replace characters in the current	1719	If C<$new_text> is specified, it will replace characters in the current
1128	line, starting at column C<$start_col> (default C<0>), which is useful	1720	line, starting at column C<$start_col> (default C<0>), which is useful
1129	to replace only parts of a line. The font index in the rendition will	1721	to replace only parts of a line. The font index in the rendition will
1130	automatically be updated.	1722	automatically be updated.
1131		1723
1132	C<$text> is in a special encoding: tabs and wide characters that use more	1724	C<$text> is in a special encoding: tabs and wide characters that use more
1133	than one cell when displayed are padded with urxvt::NOCHAR characters	1725	than one cell when displayed are padded with C<$urxvt::NOCHAR> (chr 65535)
1134	(C<chr 65535>). Characters with combining characters and other characters	1726	characters. Characters with combining characters and other characters that
1135	that do not fit into the normal tetx encoding will be replaced with	1727	do not fit into the normal text encoding will be replaced with characters
1136	characters in the private use area.	1728	in the private use area.
1137		1729
1138	You have to obey this encoding when changing text. The advantage is	1730	You have to obey this encoding when changing text. The advantage is
1139	that C<substr> and similar functions work on screen cells and not on	1731	that C<substr> and similar functions work on screen cells and not on
1140	characters.	1732	characters.
1141		1733
…		…
1192	Return the row number of the first/last row of the line, respectively.	1784	Return the row number of the first/last row of the line, respectively.
1193		1785
1194	=item $offset = $line->offset_of ($row, $col)	1786	=item $offset = $line->offset_of ($row, $col)
1195		1787
1196	Returns the character offset of the given row|col pair within the logical	1788	Returns the character offset of the given row|col pair within the logical
1197	line.	1789	line. Works for rows outside the line, too, and returns corresponding
		1790	offsets outside the string.
1198		1791
1199	=item ($row, $col) = $line->coord_of ($offset)	1792	=item ($row, $col) = $line->coord_of ($offset)
1200		1793
1201	Translates a string offset into terminal coordinates again.	1794	Translates a string offset into terminal coordinates again.
1202		1795
…		…
1224	}	1817	}
1225		1818
1226	sub urxvt::line::t {	1819	sub urxvt::line::t {
1227	my ($self) = @_;	1820	my ($self) = @_;
1228		1821
1229	if (@_ > 1)	1822	if (@_ > 1) {
1230	{
1231	$self->{term}->ROW_t ($_, $_[1], 0, ($_ - $self->{beg}) * $self->{ncol}, $self->{ncol})	1823	$self->{term}->ROW_t ($_, $_[1], 0, ($_ - $self->{beg}) * $self->{ncol}, $self->{ncol})
1232	for $self->{beg} .. $self->{end};	1824	for $self->{beg} .. $self->{end};
1233	}	1825	}
1234		1826
1235	defined wantarray &&	1827	defined wantarray &&
1236	substr +(join "", map $self->{term}->ROW_t ($_), $self->{beg} .. $self->{end}),	1828	substr +(join "", map $self->{term}->ROW_t ($_), $self->{beg} .. $self->{end}),
1237	0, $self->{len}	1829	0, $self->{len}
1238	}	1830	}
1239		1831
1240	sub urxvt::line::r {	1832	sub urxvt::line::r {
1241	my ($self) = @_;	1833	my ($self) = @_;
1242		1834
1243	if (@_ > 1)	1835	if (@_ > 1) {
1244	{
1245	$self->{term}->ROW_r ($_, $_[1], 0, ($_ - $self->{beg}) * $self->{ncol}, $self->{ncol})	1836	$self->{term}->ROW_r ($_, $_[1], 0, ($_ - $self->{beg}) * $self->{ncol}, $self->{ncol})
1246	for $self->{beg} .. $self->{end};	1837	for $self->{beg} .. $self->{end};
1247	}	1838	}
1248		1839
1249	if (defined wantarray) {	1840	if (defined wantarray) {
1250	my $rend = [	1841	my $rend = [
1251	map @{ $self->{term}->ROW_r ($_) }, $self->{beg} .. $self->{end}	1842	map @{ $self->{term}->ROW_r ($_) }, $self->{beg} .. $self->{end}
1252	];	1843	];
…		…
1284	where one character corresponds to one screen cell. See	1875	where one character corresponds to one screen cell. See
1285	C<< $term->ROW_t >> for details.	1876	C<< $term->ROW_t >> for details.
1286		1877
1287	=item $string = $term->special_decode $text	1878	=item $string = $term->special_decode $text
1288		1879
1289	Converts rxvt-unicodes text reprsentation into a perl string. See	1880	Converts rxvt-unicodes text representation into a perl string. See
1290	C<< $term->ROW_t >> for details.	1881	C<< $term->ROW_t >> for details.
1291		1882
1292	=item $success = $term->grab_button ($button, $modifiermask)	1883	=item $success = $term->grab_button ($button, $modifiermask[, $window = $term->vt])
1293		1884
		1885	=item $term->ungrab_button ($button, $modifiermask[, $window = $term->vt])
		1886
1294	Registers a synchronous button grab. See the XGrabButton manpage.	1887	Register/unregister a synchronous button grab. See the XGrabButton
		1888	manpage.
1295		1889
1296	=item $success = $term->grab ($eventtime[, $sync])	1890	=item $success = $term->grab ($eventtime[, $sync])
1297		1891
1298	Calls XGrabPointer and XGrabKeyboard in asynchronous (default) or	1892	Calls XGrabPointer and XGrabKeyboard in asynchronous (default) or
1299	synchronous (C<$sync> is true). Also remembers the grab timestampe.	1893	synchronous (C<$sync> is true). Also remembers the grab timestamp.
1300		1894
1301	=item $term->allow_events_async	1895	=item $term->allow_events_async
1302		1896
1303	Calls XAllowEvents with AsyncBoth for the most recent grab.	1897	Calls XAllowEvents with AsyncBoth for the most recent grab.
1304		1898
…		…
1311	Calls XAllowEvents with both ReplayPointer and ReplayKeyboard for the most	1905	Calls XAllowEvents with both ReplayPointer and ReplayKeyboard for the most
1312	recent grab.	1906	recent grab.
1313		1907
1314	=item $term->ungrab	1908	=item $term->ungrab
1315		1909
1316	Calls XUngrab for the most recent grab. Is called automatically on	1910	Calls XUngrabPointer and XUngrabKeyboard for the most recent grab. Is called automatically on
1317	evaluation errors, as it is better to lose the grab in the error case as	1911	evaluation errors, as it is better to lose the grab in the error case as
1318	the session.	1912	the session.
		1913
		1914	=item $atom = $term->XInternAtom ($atom_name[, $only_if_exists])
		1915
		1916	=item $atom_name = $term->XGetAtomName ($atom)
		1917
		1918	=item @atoms = $term->XListProperties ($window)
		1919
		1920	=item ($type,$format,$octets) = $term->XGetWindowProperty ($window, $property)
		1921
		1922	=item $term->XChangeProperty ($window, $property, $type, $format, $octets)
		1923
		1924	=item $term->XDeleteProperty ($window, $property)
		1925
		1926	=item $window = $term->DefaultRootWindow
		1927
		1928	=item $term->XReparentWindow ($window, $parent, [$x, $y])
		1929
		1930	=item $term->XMapWindow ($window)
		1931
		1932	=item $term->XUnmapWindow ($window)
		1933
		1934	=item $term->XMoveResizeWindow ($window, $x, $y, $width, $height)
		1935
		1936	=item ($x, $y, $child_window) = $term->XTranslateCoordinates ($src, $dst, $x, $y)
		1937
		1938	=item $term->XChangeInput ($window, $add_events[, $del_events])
		1939
		1940	=item $keysym = $term->XStringToKeysym ($string)
		1941
		1942	=item $string = $term->XKeysymToString ($keysym)
		1943
		1944	Various X or X-related functions. The C<$term> object only serves as
		1945	the source of the display, otherwise those functions map more-or-less
		1946	directly onto the X functions of the same name.
1319		1947
1320	=back	1948	=back
1321		1949
1322	=cut	1950	=cut
1323		1951
…		…
1387	my ($self, $text, $cb) = @_;	2015	my ($self, $text, $cb) = @_;
1388		2016
1389	$self->add_item ({ type => "button", text => $text, activate => $cb});	2017	$self->add_item ({ type => "button", text => $text, activate => $cb});
1390	}	2018	}
1391		2019
1392	=item $popup->add_toggle ($text, $cb, $initial_value)	2020	=item $popup->add_toggle ($text, $initial_value, $cb)
1393		2021
1394	Adds a toggle/checkbox item to the popup. Teh callback gets called	2022	Adds a toggle/checkbox item to the popup. The callback gets called
1395	whenever it gets toggled, with a boolean indicating its value as its first	2023	whenever it gets toggled, with a boolean indicating its new value as its
1396	argument.	2024	first argument.
1397		2025
1398	=cut	2026	=cut
1399		2027
1400	sub add_toggle {	2028	sub add_toggle {
1401	my ($self, $text, $cb, $value) = @_;	2029	my ($self, $text, $value, $cb) = @_;
1402		2030
1403	my $item; $item = {	2031	my $item; $item = {
1404	type => "button",	2032	type => "button",
1405	text => " $text",	2033	text => " $text",
1406	value => $value,	2034	value => $value,
…		…
1425	my $env = $self->{term}->env;	2053	my $env = $self->{term}->env;
1426	# we can't hope to reproduce the locale algorithm, so nuke LC_ALL and set LC_CTYPE.	2054	# we can't hope to reproduce the locale algorithm, so nuke LC_ALL and set LC_CTYPE.
1427	delete $env->{LC_ALL};	2055	delete $env->{LC_ALL};
1428	$env->{LC_CTYPE} = $self->{term}->locale;	2056	$env->{LC_CTYPE} = $self->{term}->locale;
1429		2057
1430	urxvt::term->new ($env, $self->{term}->resource ("name"),	2058	my $term = urxvt::term->new (
1431	"--perl-lib" => "", "--perl-ext-common" => "", "-pty-fd" => -1, "-sl" => 0, "-b" => 0,	2059	$env, "popup",
		2060	"--perl-lib" => "", "--perl-ext-common" => "",
		2061	"-pty-fd" => -1, "-sl" => 0,
		2062	"-b" => 1, "-bd" => "grey80", "-bl", "-override-redirect",
1432	"--transient-for" => $self->{term}->parent,	2063	"--transient-for" => $self->{term}->parent,
1433	"-display" => $self->{term}->display_id,	2064	"-display" => $self->{term}->display_id,
1434	"-pe" => "urxvt-popup")	2065	"-pe" => "urxvt-popup",
1435	or die "unable to create popup window\n";	2066	) or die "unable to create popup window\n";
		2067
		2068	unless (delete $term->{urxvt_popup_init_done}) {
		2069	$term->ungrab;
		2070	$term->destroy;
		2071	die "unable to initialise popup window\n";
		2072	}
1436	}	2073	}
1437		2074
1438	sub DESTROY {	2075	sub DESTROY {
1439	my ($self) = @_;	2076	my ($self) = @_;
1440		2077
1441	delete $self->{term}{_destroy}{$self};	2078	delete $self->{term}{_destroy}{$self};
1442	$self->{term}->ungrab;	2079	$self->{term}->ungrab;
1443	}	2080	}
1444		2081
1445	=back	2082	=back
		2083
		2084	=cut
		2085
		2086	package urxvt::watcher;
1446		2087
1447	=head2 The C<urxvt::timer> Class	2088	=head2 The C<urxvt::timer> Class
1448		2089
1449	This class implements timer watchers/events. Time is represented as a	2090	This class implements timer watchers/events. Time is represented as a
1450	fractional number of seconds since the epoch. Example:	2091	fractional number of seconds since the epoch. Example:
…		…
1454	->new	2095	->new
1455	->interval (1)	2096	->interval (1)
1456	->cb (sub {	2097	->cb (sub {
1457	$term->{overlay}->set (0, 0,	2098	$term->{overlay}->set (0, 0,
1458	sprintf "%2d:%02d:%02d", (localtime urxvt::NOW)[2,1,0]);	2099	sprintf "%2d:%02d:%02d", (localtime urxvt::NOW)[2,1,0]);
1459	});	2100	});
1460		2101
1461	=over 4	2102	=over 4
1462		2103
1463	=item $timer = new urxvt::timer	2104	=item $timer = new urxvt::timer
1464		2105
…		…
1467		2108
1468	=item $timer = $timer->cb (sub { my ($timer) = @_; ... })	2109	=item $timer = $timer->cb (sub { my ($timer) = @_; ... })
1469		2110
1470	Set the callback to be called when the timer triggers.	2111	Set the callback to be called when the timer triggers.
1471		2112
1472	=item $tstamp = $timer->at
1473
1474	Return the time this watcher will fire next.
1475
1476	=item $timer = $timer->set ($tstamp)	2113	=item $timer = $timer->set ($tstamp[, $interval])
1477		2114
1478	Set the time the event is generated to $tstamp.	2115	Set the time the event is generated to $tstamp (and optionally specifies a
		2116	new $interval).
1479		2117
1480	=item $timer = $timer->interval ($interval)	2118	=item $timer = $timer->interval ($interval)
1481		2119
1482	Normally (and when C<$interval> is C<0>), the timer will automatically	2120	By default (and when C<$interval> is C<0>), the timer will automatically
1483	stop after it has fired once. If C<$interval> is non-zero, then the timer	2121	stop after it has fired once. If C<$interval> is non-zero, then the timer
1484	is automatically rescheduled at the given intervals.	2122	is automatically rescheduled at the given intervals.
1485		2123
1486	=item $timer = $timer->start	2124	=item $timer = $timer->start
1487		2125
1488	Start the timer.	2126	Start the timer.
1489		2127
1490	=item $timer = $timer->start ($tstamp)	2128	=item $timer = $timer->start ($tstamp[, $interval])
1491		2129
1492	Set the event trigger time to C<$tstamp> and start the timer.	2130	Set the event trigger time to C<$tstamp> and start the timer. Optionally
		2131	also replaces the interval.
		2132
		2133	=item $timer = $timer->after ($delay[, $interval])
		2134
		2135	Like C<start>, but sets the expiry timer to c<urxvt::NOW + $delay>.
1493		2136
1494	=item $timer = $timer->stop	2137	=item $timer = $timer->stop
1495		2138
1496	Stop the timer.	2139	Stop the timer.
1497		2140
…		…
1503		2146
1504	$term->{socket} = ...	2147	$term->{socket} = ...
1505	$term->{iow} = urxvt::iow	2148	$term->{iow} = urxvt::iow
1506	->new	2149	->new
1507	->fd (fileno $term->{socket})	2150	->fd (fileno $term->{socket})
1508	->events (urxvt::EVENT_READ)	2151	->events (urxvt::EV_READ)
1509	->start	2152	->start
1510	->cb (sub {	2153	->cb (sub {
1511	my ($iow, $revents) = @_;	2154	my ($iow, $revents) = @_;
1512	# $revents must be 1 here, no need to check	2155	# $revents must be 1 here, no need to check
1513	sysread $term->{socket}, my $buf, 8192	2156	sysread $term->{socket}, my $buf, 8192
…		…
1526	Set the callback to be called when io events are triggered. C<$reventmask>	2169	Set the callback to be called when io events are triggered. C<$reventmask>
1527	is a bitset as described in the C<events> method.	2170	is a bitset as described in the C<events> method.
1528		2171
1529	=item $iow = $iow->fd ($fd)	2172	=item $iow = $iow->fd ($fd)
1530		2173
1531	Set the filedescriptor (not handle) to watch.	2174	Set the file descriptor (not handle) to watch.
1532		2175
1533	=item $iow = $iow->events ($eventmask)	2176	=item $iow = $iow->events ($eventmask)
1534		2177
1535	Set the event mask to watch. The only allowed values are	2178	Set the event mask to watch. The only allowed values are
1536	C<urxvt::EVENT_READ> and C<urxvt::EVENT_WRITE>, which might be ORed	2179	C<urxvt::EV_READ> and C<urxvt::EV_WRITE>, which might be ORed
1537	together, or C<urxvt::EVENT_NONE>.	2180	together, or C<urxvt::EV_NONE>.
1538		2181
1539	=item $iow = $iow->start	2182	=item $iow = $iow->start
1540		2183
1541	Start watching for requested events on the given handle.	2184	Start watching for requested events on the given handle.
1542		2185
1543	=item $iow = $iow->stop	2186	=item $iow = $iow->stop
1544		2187
1545	Stop watching for events on the given filehandle.	2188	Stop watching for events on the given file handle.
		2189
		2190	=back
		2191
		2192	=head2 The C<urxvt::iw> Class
		2193
		2194	This class implements idle watchers, that get called automatically when
		2195	the process is idle. They should return as fast as possible, after doing
		2196	some useful work.
		2197
		2198	=over 4
		2199
		2200	=item $iw = new urxvt::iw
		2201
		2202	Create a new idle watcher object in stopped state.
		2203
		2204	=item $iw = $iw->cb (sub { my ($iw) = @_; ... })
		2205
		2206	Set the callback to be called when the watcher triggers.
		2207
		2208	=item $timer = $timer->start
		2209
		2210	Start the watcher.
		2211
		2212	=item $timer = $timer->stop
		2213
		2214	Stop the watcher.
		2215
		2216	=back
		2217
		2218	=head2 The C<urxvt::pw> Class
		2219
		2220	This class implements process watchers. They create an event whenever a
		2221	process exits, after which they stop automatically.
		2222
		2223	my $pid = fork;
		2224	...
		2225	$term->{pw} = urxvt::pw
		2226	->new
		2227	->start ($pid)
		2228	->cb (sub {
		2229	my ($pw, $exit_status) = @_;
		2230	...
		2231	});
		2232
		2233	=over 4
		2234
		2235	=item $pw = new urxvt::pw
		2236
		2237	Create a new process watcher in stopped state.
		2238
		2239	=item $pw = $pw->cb (sub { my ($pw, $exit_status) = @_; ... })
		2240
		2241	Set the callback to be called when the timer triggers.
		2242
		2243	=item $pw = $timer->start ($pid)
		2244
		2245	Tells the watcher to start watching for process C<$pid>.
		2246
		2247	=item $pw = $pw->stop
		2248
		2249	Stop the watcher.
1546		2250
1547	=back	2251	=back
1548		2252
1549	=head1 ENVIRONMENT	2253	=head1 ENVIRONMENT
1550		2254
…		…
1557		2261
1558	=item == 0 - fatal messages	2262	=item == 0 - fatal messages
1559		2263
1560	=item >= 3 - script loading and management	2264	=item >= 3 - script loading and management
1561		2265
1562	=item >=10 - all events received	2266	=item >=10 - all called hooks
		2267
		2268	=item >=11 - hook return values
1563		2269
1564	=back	2270	=back
1565		2271
1566	=head1 AUTHOR	2272	=head1 AUTHOR
1567		2273
1568	Marc Lehmann <pcg@goof.com>	2274	Marc Lehmann <schmorp@schmorp.de>
1569	http://software.schmorp.de/pkg/rxvt-unicode	2275	http://software.schmorp.de/pkg/rxvt-unicode
1570		2276
1571	=cut	2277	=cut
1572		2278
1573	1	2279	1
		2280
		2281	# vim: sw=3:

Diff Legend

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