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

Diff Legend

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