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.90 by root, Thu Jan 12 12:15:10 2006 UTC vs.
Revision 1.248 by root, Fri Dec 26 21:01:46 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 and further clicks). Right	49	which can be bound to a key and invoked by the user. An extension can
46	now, it tries to select words, urls and complete shell-quoted	50	define the resources it support and also default bindings for one or
47	arguments, which is very convenient, too, if your F<ls> supports	51	more actions it provides using so called META comments, described
48	C<--quoting-style=shell>.	52	below. Similarly to builtin resources, extension resources can also be
49		53	specified on the command line as long options (with C<.> replaced by
50	A double-click usually selects the word under the cursor, further clicks	54	C<->), in which case the corresponding extension is loaded
51	will enlarge the selection.	55	automatically. For this to work the extension B<must> define META
52		56	comments for its resources.
53	The selection works by trying to match a number of regexes and displaying
54	them in increasing order of length. You can add your own regexes by
55	specifying resources of the form:
56
57	URxvt.selection.pattern-0: perl-regex
58	URxvt.selection.pattern-1: perl-regex
59	...
60
61	The index number (0, 1...) must not have any holes, and each regex must
62	contain at least one pair of capturing parentheses, which will be used for
63	the match. For example, the followign adds a regex that matches everything
64	between two vertical bars:
65
66	URxvt.selection.pattern-0: \\|([^|]+)\\|
67
68	You can look at the source of the selection extension to see more
69	interesting uses, such as parsing a line from beginning to end.
70
71	This extension also offers the following bindable keyboard command:
72
73	=over 4
74
75	=item rot13
76
77	Rot-13 the selection when activated. Used via keyboard trigger:
78
79	URxvt.keysym.C-M-r: perl:selection:rot13
80
81	=back
82
83	=item option-popup (enabled by default)
84
85	Binds a popup menu to Ctrl-Button2 that lets you toggle (some) options at
86	runtime.
87
88	=item selection-popup (enabled by default)
89
90	Binds a popup menu to Ctrl-Button3 that lets you convert the selection
91	text into various other formats/action (such as uri unescaping, perl
92	evalution, web-browser starting etc.), depending on content.
93
94	=item searchable-scrollback<hotkey> (enabled by default)
95
96	Adds regex search functionality to the scrollback buffer, triggered
97	by a hotkey (default: C<M-s>). While in search mode, normal terminal
98	input/output is suspended and a regex is displayed at the bottom of the
99	screen.
100
101	Inputting characters appends them to the regex and continues incremental
102	search. C<BackSpace> removes a character from the regex, C<Up> and C<Down>
103	search upwards/downwards in the scrollback buffer, C<End> jumps to the
104	bottom. C<Escape> leaves search mode and returns to the point where search
105	was started, while C<Enter> or C<Return> stay at the current position and
106	additionally stores the first match in the current line into the primary
107	selection.
108
109	=item selection-autotransform
110
111	This selection allows you to do automatic transforms on a selection
112	whenever a selection is made.
113
114	It works by specifying perl snippets (most useful is a single C<s///>
115	operator) that modify C<$_> as resources:
116
117	URxvt.selection-autotransform.0: transform
118	URxvt.selection-autotransform.1: transform
119	...
120
121	For example, the following will transform selections of the form
122	C<filename:number>, often seen in compiler messages, into C<vi +$filename
123	$word>:
124
125	URxvt.selection-autotransform.0: s/^(\\S+):(\\d+):?$/vi +$2 \\Q$1\\E\\x0d/
126
127	And this example matches the same,but replaces it with vi-commands you can
128	paste directly into your (vi :) editor:
129
130	URxvt.selection-autotransform.0: s/^(S+):(d+):?$/\\x1b:e \\Q$1\\E\\x0d:$2\\x0d/
131
132	Of course, this can be modified to suit your needs and your editor :)
133
134	=item mark-urls
135
136	Uses per-line display filtering (C<on_line_update>) to underline urls and
137	make them clickable. When middle-clicked, the program specified in the
138	resource C<urlLauncher> (default C<x-www-browser>) will be started with
139	the URL as first argument.
140
141	=item block-graphics-to-ascii
142
143	A not very useful example of filtering all text output to the terminal,
144	by replacing all line-drawing characters (U+2500 .. U+259F) by a
145	similar-looking ascii character.
146
147	=item digital-clock
148
149	Displays a digital clock using the built-in overlay.
150
151	=item example-refresh-hooks
152
153	Displays a very simple digital clock in the upper right corner of the
154	window. Illustrates overwriting the refresh callbacks to create your own
155	overlays or changes.
156
157	=back
158		57
159	=head1 API DOCUMENTATION	58	=head1 API DOCUMENTATION
160		59
161	=head2 General API Considerations	60	=head2 General API Considerations
162		61
…		…
176		75
177	=over 4	76	=over 4
178		77
179	=item $text	78	=item $text
180		79
181	Rxvt-unicodes special way of encoding text, where one "unicode" character	80	Rxvt-unicode's special way of encoding text, where one "unicode" character
182	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.
183		82
184	=item $string	83	=item $string
185		84
186	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
…		…
190	=item $octets	89	=item $octets
191		90
192	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
193	locale-specific way.	92	locale-specific way.
194		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
195	=back	100	=back
196		101
197	=head2 Extension Objects	102	=head2 Extension Objects
198		103
199	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
200	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,
201	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
202	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
203	begin with an underscore character C<_>: these are reserved for internal	109	that begin with an underscore character C<_>: these are reserved for
204	use.	110	internal use.
205		111
206	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
207	C<urxvt::term> class on this object.	113	C<urxvt::term> class on this object.
208		114
209	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:
210		124
211	=over 4	125	=over 4
212		126
213	=item $urxvt_term = $self->{term}	127	=item #:META:RESOURCE:name:type:desc
214		128
215	Returns the C<urxvt::term> object associated with this instance of the	129	The RESOURCE comment defines a resource used by the extension, where
216	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>
217		131	or C<string>, and C<desc> is the resource description.
218	=item $self->enable ($hook_name => $cb, [$hook_name => $cb..])
219
220	Dynamically enable the given hooks (named without the C<on_> prefix) for
221	this extension, replacing any previous hook. This is useful when you want
222	to overwrite time-critical hooks only temporarily.
223
224	=item $self->disable ($hook_name[, $hook_name..])
225
226	Dynamically disable the given hooks.
227		132
228	=back	133	=back
229		134
230	=head2 Hooks	135	=head2 Hooks
231		136
232	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
233	called whenever the relevant event happens.	138	called whenever the relevant event happens.
234		139
235	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
236	the in the C<Extension Objects> section.	141	the in the C<Extension Objects> section.
237		142
238	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
239	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
240	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.
241		146
242	I<< When in doubt, return a false value (preferably C<()>). >>	147	I<< When in doubt, return a false value (preferably C<()>). >>
243		148
244	=over 4	149	=over 4
245		150
246	=item on_init $term	151	=item on_init $term
247		152
248	Called after a new terminal object has been initialized, but before	153	Called after a new terminal object has been initialized, but before
249	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
250	call or deliver senseless data, as terminal size and other characteristics	155	call or deliver senseless data, as terminal size and other characteristics
251	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
252	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).
253		169
254	=item on_reset $term	170	=item on_reset $term
255		171
256	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
257	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
258	variables.	174	variables.
259		175
260	=item on_start $term	176	=item on_child_start $term, $pid
261		177
262	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.
263	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>.
264		184
265	=item on_sel_make $term, $eventtime	185	=item on_sel_make $term, $eventtime
266		186
267	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
268	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
…		…
275		195
276	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
277	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
278	by calling C<< $term->selection >>.	198	by calling C<< $term->selection >>.
279		199
280	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.
281		201
282	=item on_sel_extend $term	202	=item on_sel_extend $term
283		203
284	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
285	click) and is either supposed to return false (normal operation), or	205	click) and is either supposed to return false (normal operation), or
286	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
287	processing. This can happen multiple times, as long as the callback	207	processing. This can happen multiple times, as long as the callback
288	returns true, it will be called on every further click by the user and is	208	returns true, it will be called on every further click by the user and is
289	supposed to enlarge the selection more and more, if possible.	209	supposed to enlarge the selection more and more, if possible.
290		210
291	See the F<selection> example extension.	211	See the F<selection> example extension.
292		212
293	=item on_view_change $term, $offset	213	=item on_view_change $term, $offset
294		214
295	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
296	scrolls. Offset C<0> means display the normal terminal, positive values	216	scrolls. Offset C<0> means display the normal terminal, positive values
297	show this many lines of scrollback.	217	show this many lines of scrollback.
298		218
299	=item on_scroll_back $term, $lines, $saved	219	=item on_scroll_back $term, $lines, $saved
300		220
…		…
304		224
305	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,
306	$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
307	number of lines that will be in the scrollback buffer.	227	number of lines that will be in the scrollback buffer.
308		228
309	=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
310		240
311	Called whenever the B<ESC ] 777 ; string ST> command sequence (OSC =	241	Called whenever the B<ESC ] 777 ; string ST> command sequence (OSC =
312	operating system command) is processed. Cursor position and other state	242	operating system command) is processed. Cursor position and other state
313	information is up-to-date when this happens. For interoperability, the	243	information is up-to-date when this happens. For interoperability, the
314	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,
315	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
316	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	}
317		257
318	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,
319	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
320	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.
321		264
322	=item on_add_lines $term, $string	265	=item on_add_lines $term, $string
323		266
324	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
325	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
…		…
330	=item on_tt_write $term, $octets	273	=item on_tt_write $term, $octets
331		274
332	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
333	suppress or filter tty input.	276	suppress or filter tty input.
334		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
335	=item on_line_update $term, $row	285	=item on_line_update $term, $row
336		286
337	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
338	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
339	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,
…		…
346	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
347	you cannot just toggle rendition bits, but only set them.	297	you cannot just toggle rendition bits, but only set them.
348		298
349	=item on_refresh_begin $term	299	=item on_refresh_begin $term
350		300
351	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
352	or similar effects by modify terminal contents in refresh_begin, and	302	similar effects by modifying the terminal contents in refresh_begin, and
353	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
354	code is run after this hook, and takes precedence.	304	code is run after this hook, and takes precedence.
355		305
356	=item on_refresh_end $term	306	=item on_refresh_end $term
357		307
358	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>.
359		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
360	=item on_keyboard_command $term, $string	318	=item on_user_command $term, $string *DEPRECATED*
361		319
362	Called whenever the user presses a key combination that has a	320	Called whenever a user-configured event is being activated (e.g. via
363	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>
364	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.
365		342
366	=item on_focus_in $term	343	=item on_focus_in $term
367		344
368	Called whenever the window gets the keyboard focus, before rxvt-unicode	345	Called whenever the window gets the keyboard focus, before rxvt-unicode
369	does focus in processing.	346	does focus in processing.
370		347
371	=item on_focus_out $term	348	=item on_focus_out $term
372		349
373	Called wheneever the window loses keyboard focus, before rxvt-unicode does	350	Called whenever the window loses keyboard focus, before rxvt-unicode does
374	focus out processing.	351	focus out processing.
375		352
		353	=item on_configure_notify $term, $event
		354
		355	=item on_property_notify $term, $event
		356
376	=item on_key_press $term, $event, $keysym, $octets	357	=item on_key_press $term, $event, $keysym, $octets
377		358
378	=item on_key_release $term, $event, $keysym	359	=item on_key_release $term, $event, $keysym
379		360
380	=item on_button_press $term, $event	361	=item on_button_press $term, $event
…		…
385		366
386	=item on_map_notify $term, $event	367	=item on_map_notify $term, $event
387		368
388	=item on_unmap_notify $term, $event	369	=item on_unmap_notify $term, $event
389		370
390	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
391	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.
392		373
393	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
394	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
395	and column under the mouse cursor.	376	(real, not screen-based) row and column under the mouse cursor.
396		377
397	C<on_key_press> additionally receives the string rxvt-unicode would	378	C<on_key_press> additionally receives the string rxvt-unicode would
398	output, if any, in locale-specific encoding.	379	output, if any, in locale-specific encoding.
399		380
400	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.
401		393
402	=back	394	=back
403		395
404	=cut	396	=cut
405		397
406	package urxvt;	398	package urxvt;
407		399
408	use utf8;	400	use utf8;
409	use strict;	401	use strict 'vars';
410	use Carp ();	402	use Carp ();
411	use Scalar::Util ();	403	use Scalar::Util ();
412	use List::Util ();	404	use List::Util ();
413		405
414	our $VERSION = 1;	406	our $VERSION = 1;
415	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.
416	our @HOOKNAME;	410	our @HOOKNAME;
417	our %HOOKTYPE = map +($HOOKNAME[$_] => $_), 0..$#HOOKNAME;	411	our %HOOKTYPE = map +($HOOKNAME[$_] => $_), 0..$#HOOKNAME;
418	our %OPTION;	412	our %OPTION;
419		413
420	our $LIBDIR;	414	our $LIBDIR;
421	our $RESNAME;	415	our $RESNAME;
422	our $RESCLASS;	416	our $RESCLASS;
423	our $RXVTNAME;	417	our $RXVTNAME;
424		418
		419	our $NOCHAR = chr 0xffff;
		420
425	=head2 Variables in the C<urxvt> Package	421	=head2 Variables in the C<urxvt> Package
426		422
427	=over 4	423	=over 4
428		424
429	=item $urxvt::LIBDIR	425	=item $urxvt::LIBDIR
…		…
442	=item $urxvt::TERM	438	=item $urxvt::TERM
443		439
444	The current terminal. This variable stores the current C<urxvt::term>	440	The current terminal. This variable stores the current C<urxvt::term>
445	object, whenever a callback/hook is executing.	441	object, whenever a callback/hook is executing.
446		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
447	=back	459	=back
448		460
449	=head2 Functions in the C<urxvt> Package	461	=head2 Functions in the C<urxvt> Package
450		462
451	=over 4	463	=over 4
452		464
453	=item urxvt::fatal $errormessage	465	=item urxvt::fatal $errormessage
454		466
455	Fatally aborts execution with the given error message. Avoid at all	467	Fatally aborts execution with the given error message (which should
456	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
457	starts up.	469	is acceptable (and useful) is in the init hook, where it prevents the
		470	terminal from starting up.
458		471
459	=item urxvt::warn $string	472	=item urxvt::warn $string
460		473
461	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
462	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
463	that calls this function.	476	that calls this function.
464		477
465	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
466	correct place, e.g. on stderr of the connecting urxvtc client.	479	correct place, e.g. on stderr of the connecting urxvtc client.
467		480
468	Messages have a size limit of 1023 bytes currently.	481	Messages have a size limit of 1023 bytes currently.
469		482
470	=item $is_safe = urxvt::safe	483	=item @terms = urxvt::termlist
471		484
472	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
473	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
474	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).
475		489
476	=item $time = urxvt::NOW	490	=item $time = urxvt::NOW
477		491
478	Returns the "current time" (as per the event loop).	492	Returns the "current time" (as per the event loop).
479		493
480	=item urxvt::CurrentTime	494	=item urxvt::CurrentTime
481		495
482	=item urxvt::ShiftMask, LockMask, ControlMask, Mod1Mask, Mod2Mask,	496	=item urxvt::ShiftMask, LockMask, ControlMask, Mod1Mask, Mod2Mask,
483	Mod3Mask, Mod4Mask, Mod5Mask, Button1Mask, Button2Mask, Button3Mask,	497	Mod3Mask, Mod4Mask, Mod5Mask, Button1Mask, Button2Mask, Button3Mask,
484	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
485		515
486	Various constants for use in X calls and event processing.	516	Various constants for use in X calls and event processing.
487		517
488	=back	518	=back
489		519
…		…
506		536
507	=item $rend = urxvt::OVERLAY_RSTYLE	537	=item $rend = urxvt::OVERLAY_RSTYLE
508		538
509	Return the rendition mask used for overlays by default.	539	Return the rendition mask used for overlays by default.
510		540
511	=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
512		543
513	Return the bit that enabled bold, italic, blink, reverse-video and	544	Return the bit that enabled bold, italic, blink, reverse-video and
514	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
515	the bitset.	546	the bitset.
516		547
…		…
522		553
523	=item $rend = urxvt::SET_FGCOLOR $rend, $new_colour	554	=item $rend = urxvt::SET_FGCOLOR $rend, $new_colour
524		555
525	=item $rend = urxvt::SET_BGCOLOR $rend, $new_colour	556	=item $rend = urxvt::SET_BGCOLOR $rend, $new_colour
526		557
		558	=item $rend = urxvt::SET_COLOR $rend, $new_fg, $new_bg
		559
527	Replace the foreground/background colour in the rendition mask with the	560	Replace the foreground/background colour in the rendition mask with the
528	specified one.	561	specified one.
529		562
530	=item $value = urxvt::GET_CUSTOM $rend	563	=item $value = urxvt::GET_CUSTOM $rend
531		564
…		…
540	=back	573	=back
541		574
542	=cut	575	=cut
543		576
544	BEGIN {	577	BEGIN {
545	urxvt->bootstrap;
546
547	# overwrite perl's warn	578	# overwrite perl's warn
548	*CORE::GLOBAL::warn = sub {	579	*CORE::GLOBAL::warn = sub {
549	my $msg = join "", @_;	580	my $msg = join "", @_;
550	$msg .= "\n"	581	$msg .= "\n"
551	unless $msg =~ /\n$/;	582	unless $msg =~ /\n$/;
552	urxvt::warn ($msg);	583	urxvt::warn ($msg);
553	};	584	};
554
555	# %ENV is the original startup environment
556	delete $ENV{IFS};
557	delete $ENV{CDPATH};
558	delete $ENV{BASH_ENV};
559	$ENV{PATH} = "/bin:/sbin:/usr/bin:/usr/sbin:/usr/local/bin:/usr/local/sbin:/opt/bin:/opt/sbin";
560	}	585	}
561		586
562	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
563	my $verbosity = $ENV{URXVT_PERL_VERBOSITY};	651	my $verbosity = $ENV{URXVT_PERL_VERBOSITY};
564		652
565	sub verbose {	653	sub verbose {
566	my ($level, $msg) = @_;	654	my ($level, $msg) = @_;
567	warn "$msg\n" if $level <= $verbosity;	655	warn "$msg\n" if $level <= $verbosity;
568	}	656	}
569		657
570	my $extension_pkg = "extension0000";
571	my %extension_pkg;	658	my %extension_pkg;
572		659
573	# load a single script into its own package, once only	660	# load a single script into its own package, once only
574	sub extension_package($) {	661	sub extension_package($) {
575	my ($path) = @_;	662	my ($path) = @_;
576		663
577	$extension_pkg{$path} ||= do {	664	$extension_pkg{$path} ||= do {
578	my $pkg = "urxvt::" . ($extension_pkg++);	665	$path =~ /([^\/\\]+)$/;
		666	my $pkg = $1;
		667	$pkg =~ s/[^[:word:]]/_/g;
		668	$pkg = "urxvt::ext::$pkg";
579		669
580	verbose 3, "loading extension '$path' into package '$pkg'";	670	verbose 3, "loading extension '$path' into package '$pkg'";
		671
		672	(${"$pkg\::_NAME"} = $path) =~ s/^.*[\\\/]//; # hackish
581		673
582	open my $fh, "<:raw", $path	674	open my $fh, "<:raw", $path
583	or die "$path: $!";	675	or die "$path: $!";
584		676
585	my $source = untaint	677	my $source =
586	"package $pkg; use strict; use utf8;\n"	678	"package $pkg; use strict 'vars'; use utf8; no warnings 'utf8';\n"
587	. "use base urxvt::term::extension::;\n"
588	. "#line 1 \"$path\"\n{\n"	679	. "#line 1 \"$path\"\n{\n"
589	. (do { local $/; <$fh> })	680	. (do { local $/; <$fh> })
590	. "\n};\n1";	681	. "\n};\n1";
591		682
592	eval $source	683	eval $source
…		…
601	# called by the rxvt core	692	# called by the rxvt core
602	sub invoke {	693	sub invoke {
603	local $TERM = shift;	694	local $TERM = shift;
604	my $htype = shift;	695	my $htype = shift;
605		696
606	if ($htype == 0) { # INIT	697	if ($htype == HOOK_INIT) {
607	my @dirs = ((split /:/, $TERM->resource ("perl_lib")), "$LIBDIR/perl");	698	my @dirs = $TERM->perl_libdirs;
608		699
		700	$TERM->scan_extensions;
		701
609	my %ext_arg;	702	my %ext_arg;
610		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 (
611	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	) {
612	if ($_ eq "default") {	717	if ($_ eq "default") {
		718
		719	$ext_arg{$_} = []
613	$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
614	} elsif (/^-(.*)$/) {	731	} elsif (/^-(.*)$/) {
615	delete $ext_arg{$1};	732	delete $ext_arg{$1};
		733
616	} elsif (/^([^<]+)<(.*)>$/) {	734	} elsif (/^([^<]+)<(.*)>$/) {
617	push @{ $ext_arg{$1} }, $2;	735	push @{ $ext_arg{$1} }, $2;
		736
618	} else {	737	} else {
619	$ext_arg{$_} ||= [];	738	$ext_arg{$_} ||= [];
620	}	739	}
621	}	740	}
622		741
623	while (my ($ext, $argv) = each %ext_arg) {	742	for my $ext (sort keys %ext_arg) {
624	my @files = grep -f $_, map "$_/$ext", @dirs;	743	my @files = grep -f $_, map "$_/$ext", @dirs;
625		744
626	if (@files) {	745	if (@files) {
627	$TERM->register_package (extension_package $files[0], $argv);	746	$TERM->register_package (extension_package $files[0], $ext_arg{$ext});
628	} else {	747	} else {
629	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";
630	}	749	}
631	}	750	}
632		751
…		…
638		757
639	if (my $cb = $TERM->{_hook}[$htype]) {	758	if (my $cb = $TERM->{_hook}[$htype]) {
640	verbose 10, "$HOOKNAME[$htype] (" . (join ", ", $TERM, @_) . ")"	759	verbose 10, "$HOOKNAME[$htype] (" . (join ", ", $TERM, @_) . ")"
641	if $verbosity >= 10;	760	if $verbosity >= 10;
642		761
643	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";
644		768
645	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) {
646	$retval = eval { $cb->($TERM->{_pkg}{$pkg}, @_) }	776	my $retval_ = eval { $cb->{$pkg}->($TERM->{_pkg}{$pkg} || $TERM, @_) };
647	and last;	777	$retval ||= $retval_;
648		778
649	if ($@) {	779	if ($@) {
650	$TERM->ungrab; # better to lose the grab than the session	780	$TERM->ungrab; # better to lose the grab than the session
651	warn $@;	781	warn $@;
652	}	782	}
…		…
654		784
655	verbose 11, "$HOOKNAME[$htype] returning <$retval>"	785	verbose 11, "$HOOKNAME[$htype] returning <$retval>"
656	if $verbosity >= 11;	786	if $verbosity >= 11;
657	}	787	}
658		788
659	if ($htype == 1) { # DESTROY	789	if ($htype == HOOK_DESTROY) {
660	if (my $hook = delete $TERM->{_hook}) {
661	for my $htype (0..$#$hook) {
662	$hook_count[$htype] -= scalar keys %{ $hook->[$htype] || {} }
663	or set_should_invoke $htype, 0;
664	}
665	}
666
667	# clear package objects	790	# clear package objects
668	%$_ = () for values %{ $TERM->{_pkg} };	791	%$_ = () for values %{ $TERM->{_pkg} };
669		792
670	# clear package	793	# clear package
671	%$TERM = ();	794	%$TERM = ();
672	}	795	}
673		796
674	$retval	797	$retval
675	}	798	}
676		799
677	sub exec_async(@) {	800	sub SET_COLOR($$$) {
678	my $pid = fork;	801	SET_BGCOLOR (SET_FGCOLOR ($_[0], $_[1]), $_[2])
679
680	return
681	if !defined $pid or $pid;
682
683	%ENV = %{ $TERM->env };
684
685	exec @_;
686	_exit 255;
687	}	802	}
688		803
689	# urxvt::term::extension	804	sub rend2mask {
690		805	no strict 'refs';
691	package urxvt::term::extension;	806	my ($str, $mask) = (@_, 0);
692		807	my %color = ( fg => undef, bg => undef );
693	sub enable {	808	my @failed;
694	my ($self, %hook) = @_;	809	for my $spec ( split /\s+/, $str ) {
695	my $pkg = $self->{_pkg};	810	if ( $spec =~ /^([fb]g)[_:-]?(\d+)/i ) {
696		811	$color{lc($1)} = $2;
697	while (my ($name, $cb) = each %hook) {	812	} else {
698	my $htype = $HOOKTYPE{uc $name};	813	my $neg = $spec =~ s/^[-^]//;
699	defined $htype	814	unless ( exists &{"RS_$spec"} ) {
700	or Carp::croak "unsupported hook type '$name'";	815	push @failed, $spec;
701		816	next;
702	unless (exists $self->{term}{_hook}[$htype]{$pkg}) {
703	$hook_count[$htype]++
704	or urxvt::set_should_invoke $htype, 1;
705	}	817	}
706		818	my $cur = &{"RS_$spec"};
707	$self->{term}{_hook}[$htype]{$pkg} = $cb;	819	if ( $neg ) {
708	}	820	$mask &= ~$cur;
709	}	821	} else {
710		822	$mask |= $cur;
711	sub disable {	823	}
712	my ($self, @hook) = @_;
713	my $pkg = $self->{_pkg};
714
715	for my $name (@hook) {
716	my $htype = $HOOKTYPE{uc $name};
717	defined $htype
718	or Carp::croak "unsupported hook type '$name'";
719
720	if (delete $self->{term}{_hook}[$htype]{$pkg}) {
721	--$hook_count[$htype]
722	or urxvt::set_should_invoke $htype, 0;
723	}	824	}
724	}	825	}
		826	($mask, @color{qw(fg bg)}, \@failed)
725	}	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
726		851
727	our $AUTOLOAD;	852	our $AUTOLOAD;
728		853
729	sub AUTOLOAD {	854	sub AUTOLOAD {
730	$AUTOLOAD =~ /:([^:]+)$/	855	$AUTOLOAD =~ /:([^:]+)$/
…		…
743		868
744	sub DESTROY {	869	sub DESTROY {
745	# nop	870	# nop
746	}	871	}
747		872
748	# urxvt::destroy_hook	873	# urxvt::destroy_hook (basically a cheap Guard:: implementation)
749		874
750	sub urxvt::destroy_hook::DESTROY {	875	sub urxvt::destroy_hook::DESTROY {
751	${$_[0]}->();	876	${$_[0]}->();
752	}	877	}
753		878
754	sub urxvt::destroy_hook(&) {	879	sub urxvt::destroy_hook(&) {
755	bless \shift, urxvt::destroy_hook::	880	bless \shift, urxvt::destroy_hook::
756	}	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
757		1005
758	package urxvt::anyevent;	1006	package urxvt::anyevent;
759		1007
760	=head2 The C<urxvt::anyevent> Class	1008	=head2 The C<urxvt::anyevent> Class
761		1009
762	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
763	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
764	further programming. The only exception is that you cannot wait on	1012	further programming. The only exception is that you cannot wait on
765	condition variables, but non-blocking condvar use is ok. What this means	1013	condition variables, but non-blocking condvar use is ok.
766	is that you cannot use blocking APIs, but the non-blocking variant should
767	work.
768		1014
769	=cut	1015	In practical terms this means is that you cannot use blocking APIs, but
		1016	the non-blocking variant should work.
770		1017
		1018	=cut
		1019
771	our $VERSION = 1;	1020	our $VERSION = '5.23';
772		1021
773	$INC{"urxvt/anyevent.pm"} = 1; # mark us as there	1022	$INC{"urxvt/anyevent.pm"} = 1; # mark us as there
774	push @AnyEvent::REGISTRY, [urxvt => urxvt::anyevent::];	1023	push @AnyEvent::REGISTRY, [urxvt => urxvt::anyevent::];
775		1024
776	sub timer {	1025	sub timer {
…		…
778		1027
779	my $cb = $arg{cb};	1028	my $cb = $arg{cb};
780		1029
781	urxvt::timer	1030	urxvt::timer
782	->new	1031	->new
783	->start (urxvt::NOW + $arg{after})	1032	->after ($arg{after}, $arg{interval})
784	->cb (sub {	1033	->cb ($arg{interval} ? $cb : sub {
785	$_[0]->stop; # need to cancel manually	1034	$_[0]->stop; # need to cancel manually
786	$cb->();	1035	$cb->();
787	})	1036	})
788	}	1037	}
789		1038
790	sub io {	1039	sub io {
791	my ($class, %arg) = @_;	1040	my ($class, %arg) = @_;
792		1041
793	my $cb = $arg{cb};	1042	my $cb = $arg{cb};
		1043	my $fd = fileno $arg{fh};
		1044	defined $fd or $fd = $arg{fh};
794		1045
795	bless [$arg{fh}, urxvt::iow	1046	bless [$arg{fh}, urxvt::iow
796	->new	1047	->new
797	->fd (fileno $arg{fh})	1048	->fd ($fd)
798	->events (($arg{poll} =~ /r/ ? 1 : 0)	1049	->events (($arg{poll} =~ /r/ ? 1 : 0)
799	| ($arg{poll} =~ /w/ ? 2 : 0))	1050	| ($arg{poll} =~ /w/ ? 2 : 0))
800	->start	1051	->start
801	->cb (sub {	1052	->cb ($cb)
802	$cb->(($_[1] & 1 ? 'r' : '')
803	. ($_[1] & 2 ? 'w' : ''));
804	})],
805	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	})
806	}	1079	}
807		1080
808	sub DESTROY {	1081	sub DESTROY {
809	$_[0][1]->stop;	1082	$_[0][1]->stop;
810	}	1083	}
811		1084
812	sub condvar {	1085	# only needed for AnyEvent < 6 compatibility
813	bless \my $flag, urxvt::anyevent::condvar::	1086	sub one_event {
814	}
815
816	sub urxvt::anyevent::condvar::broadcast {
817	${$_[0]}++;
818	}
819
820	sub urxvt::anyevent::condvar::wait {
821	unless (${$_[0]}) {
822	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";
823	}
824	}	1088	}
825		1089
826	package urxvt::term;	1090	package urxvt::term;
827		1091
828	=head2 The C<urxvt::term> Class	1092	=head2 The C<urxvt::term> Class
…		…
834	# find on_xxx subs in the package and register them	1098	# find on_xxx subs in the package and register them
835	# as hooks	1099	# as hooks
836	sub register_package {	1100	sub register_package {
837	my ($self, $pkg, $argv) = @_;	1101	my ($self, $pkg, $argv) = @_;
838		1102
		1103	no strict 'refs';
		1104
		1105	urxvt::verbose 6, "register package $pkg to $self";
		1106
		1107	@{"$pkg\::ISA"} = urxvt::term::extension::;
		1108
839	my $proxy = bless {	1109	my $proxy = bless {
840	_pkg => $pkg,	1110	_pkg => $pkg,
		1111	_name => ${"$pkg\::_NAME"}, # hackish
841	argv => $argv,	1112	argv => $argv,
842	}, $pkg;	1113	}, $pkg;
843	Scalar::Util::weaken ($proxy->{term} = $self);	1114	Scalar::Util::weaken ($proxy->{term} = $self);
844		1115
845	$self->{_pkg}{$pkg} = $proxy;	1116	$self->{_pkg}{$pkg} = $proxy;
846		1117
…		…
849	$proxy->enable ($name => $ref);	1120	$proxy->enable ($name => $ref);
850	}	1121	}
851	}	1122	}
852	}	1123	}
853		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 @libdirs = perl_libdirs $self;
		1140
		1141	# return if $self->{meta_libdirs} eq join "\x00", @libdirs;#d#
		1142
		1143	# $self->{meta_libdirs} = join "\x00", @libdirs;#d#
		1144	$self->{meta} = \my %meta;
		1145
		1146	# first gather extensions
		1147	for my $dir (reverse @libdirs) {
		1148	opendir my $fh, $dir
		1149	or next;
		1150	for my $ext (readdir $fh) {
		1151	$ext !~ /^\./
		1152	and open my $fh, "<", "$dir/$ext"
		1153	or next;
		1154
		1155	my %ext = (dir => $dir);
		1156
		1157	while (<$fh>) {
		1158	if (/^#:META:(?:X_)?RESOURCE:(.*)/) {
		1159	my ($pattern, $type, $desc) = split /:/, $1;
		1160	$pattern =~ s/^%(\.|$)/$ext$1/g; # % in pattern == extension name
		1161	if ($pattern =~ /[^a-zA-Z0-9\-\.]/) {
		1162	warn "$dir/$ext: meta resource '$pattern' contains illegal characters (not alphanumeric nor . nor *)\n";
		1163	} else {
		1164	$ext{resource}{$pattern} = [$ext, $type, $desc];
		1165	}
		1166	} elsif (/^\s*(?:#|$)/) {
		1167	# skip other comments and empty lines
		1168	} else {
		1169	last; # stop parsing on first non-empty non-comment line
		1170	}
		1171	}
		1172
		1173	$meta{ext}{$ext} = \%ext;
		1174	}
		1175	}
		1176
		1177	# and now merge resources
		1178	while (my ($k, $v) = each %{ $meta{ext} }) {
		1179	#TODO: should check for extensions overriding each other
		1180	%{ $meta{resource} } = (%{ $meta{resource} }, %{ $v->{resource} });
		1181	}
		1182	}
		1183
854	=item $term = new urxvt::term $envhashref, $rxvtname, [arg...]	1184	=item $term = new urxvt::term $envhashref, $rxvtname, [arg...]
855		1185
856	Creates a new terminal, very similar as if you had started it with system	1186	Creates a new terminal, very similar as if you had started it with system
857	C<$rxvtname, arg...>. C<$envhashref> must be a reference to a C<%ENV>-like	1187	C<$rxvtname, arg...>. C<$envhashref> must be a reference to a C<%ENV>-like
858	hash which defines the environment of the new terminal.	1188	hash which defines the environment of the new terminal.
859		1189
860	Croaks (and probably outputs an error message) if the new instance	1190	Croaks (and probably outputs an error message) if the new instance
861	couldn't be created. Returns C<undef> if the new instance didn't	1191	couldn't be created. Returns C<undef> if the new instance didn't
862	initialise perl, and the terminal object otherwise. The C<init> and	1192	initialise perl, and the terminal object otherwise. The C<init> and
863	C<start> hooks will be called during this call.	1193	C<start> hooks will be called before this call returns, and are free to
		1194	refer to global data (which is race free).
864		1195
865	=cut	1196	=cut
866		1197
867	sub new {	1198	sub new {
868	my ($class, $env, @args) = @_;	1199	my ($class, $env, @args) = @_;
869		1200
		1201	$env or Carp::croak "environment hash missing in call to urxvt::term->new";
		1202	@args or Carp::croak "name argument missing in call to urxvt::term->new";
		1203
870	_new ([ map "$_=$env->{$_}", keys %$env ], @args);	1204	_new ([ map "$_=$env->{$_}", keys %$env ], \@args);
871	}	1205	}
872		1206
873	=item $term->destroy	1207	=item $term->destroy
874		1208
875	Destroy the terminal object (close the window, free resources	1209	Destroy the terminal object (close the window, free resources
876	etc.). Please note that @@RXVT_NAME@@ will not exit as long as any event	1210	etc.). Please note that urxvt will not exit as long as any event
877	watchers (timers, io watchers) are still active.	1211	watchers (timers, io watchers) are still active.
		1212
		1213	=item $term->exec_async ($cmd[, @args])
		1214
		1215	Works like the combination of the C<fork>/C<exec> builtins, which executes
		1216	("starts") programs in the background. This function takes care of setting
		1217	the user environment before exec'ing the command (e.g. C<PATH>) and should
		1218	be preferred over explicit calls to C<exec> or C<system>.
		1219
		1220	Returns the pid of the subprocess or C<undef> on error.
		1221
		1222	=cut
		1223
		1224	sub exec_async {
		1225	my $self = shift;
		1226
		1227	my $pid = fork;
		1228
		1229	return $pid
		1230	if !defined $pid or $pid;
		1231
		1232	%ENV = %{ $self->env };
		1233
		1234	exec @_;
		1235	urxvt::_exit 255;
		1236	}
878		1237
879	=item $isset = $term->option ($optval[, $set])	1238	=item $isset = $term->option ($optval[, $set])
880		1239
881	Returns true if the option specified by C<$optval> is enabled, and	1240	Returns true if the option specified by C<$optval> is enabled, and
882	optionally change it. All option values are stored by name in the hash	1241	optionally change it. All option values are stored by name in the hash
883	C<%urxvt::OPTION>. Options not enabled in this binary are not in the hash.	1242	C<%urxvt::OPTION>. Options not enabled in this binary are not in the hash.
884		1243
885	Here is a a likely non-exhaustive list of option names, please see the	1244	Here is a likely non-exhaustive list of option names, please see the
886	source file F</src/optinc.h> to see the actual list:	1245	source file F</src/optinc.h> to see the actual list:
887		1246
888	borderLess console cursorBlink cursorUnderline hold iconic insecure	1247	borderLess buffered console cursorBlink cursorUnderline hold iconic
889	intensityStyles jumpScroll loginShell mapAlert meta8 mouseWheelScrollPage	1248	insecure intensityStyles iso14755 iso14755_52 jumpScroll loginShell
		1249	mapAlert meta8 mouseWheelScrollPage override_redirect pastableTabs
890	pastableTabs pointerBlank reverseVideo scrollBar scrollBar_floating	1250	pointerBlank reverseVideo scrollBar scrollBar_floating scrollBar_right
891	scrollBar_right scrollTtyKeypress scrollTtyOutput scrollWithBuffer	1251	scrollTtyKeypress scrollTtyOutput scrollWithBuffer secondaryScreen
892	secondaryScreen secondaryScroll skipBuiltinGlyphs transparent	1252	secondaryScroll skipBuiltinGlyphs skipScroll transparent tripleclickwords
893	tripleclickwords utmpInhibit visualBell	1253	urgentOnBell utmpInhibit visualBell
894		1254
895	=item $value = $term->resource ($name[, $newval])	1255	=item $value = $term->resource ($name[, $newval])
896		1256
897	Returns the current resource value associated with a given name and	1257	Returns the current resource value associated with a given name and
898	optionally sets a new value. Setting values is most useful in the C<init>	1258	optionally sets a new value. Setting values is most useful in the C<init>
…		…
907	likely change).	1267	likely change).
908		1268
909	Please note that resource strings will currently only be freed when the	1269	Please note that resource strings will currently only be freed when the
910	terminal is destroyed, so changing options frequently will eat memory.	1270	terminal is destroyed, so changing options frequently will eat memory.
911		1271
912	Here is a a likely non-exhaustive list of resource names, not all of which	1272	Here is a likely non-exhaustive list of resource names, not all of which
913	are supported in every build, please see the source file F</src/rsinc.h>	1273	are supported in every build, please see the source file F</src/rsinc.h>
914	to see the actual list:	1274	to see the actual list:
915		1275
916	answerbackstring backgroundPixmap backspace_key boldFont boldItalicFont	1276	answerbackstring backgroundPixmap backspace_key blurradius
917	borderLess color cursorBlink cursorUnderline cutchars delete_key	1277	boldFont boldItalicFont borderLess buffered chdir color cursorBlink
918	display_name embed ext_bwidth fade font geometry hold iconName	1278	cursorUnderline cutchars delete_key depth display_name embed ext_bwidth
919	imFont imLocale inputMethod insecure int_bwidth intensityStyles	1279	fade font geometry hold iconName iconfile imFont imLocale inputMethod
		1280	insecure int_bwidth intensityStyles iso14755 iso14755_52 italicFont
920	italicFont jumpScroll lineSpace loginShell mapAlert menu meta8 modifier	1281	jumpScroll letterSpace lineSpace loginShell mapAlert meta8 modifier
921	mouseWheelScrollPage name pastableTabs path perl_eval perl_ext_1 perl_ext_2	1282	mouseWheelScrollPage name override_redirect pastableTabs path perl_eval
922	perl_lib pointerBlank pointerBlankDelay preeditType print_pipe pty_fd	1283	perl_ext_1 perl_ext_2 perl_lib pointerBlank pointerBlankDelay
923	reverseVideo saveLines scrollBar scrollBar_align scrollBar_floating	1284	preeditType print_pipe pty_fd reverseVideo saveLines scrollBar
924	scrollBar_right scrollBar_thickness scrollTtyKeypress scrollTtyOutput	1285	scrollBar_align scrollBar_floating scrollBar_right scrollBar_thickness
925	scrollWithBuffer scrollstyle secondaryScreen secondaryScroll selectstyle	1286	scrollTtyKeypress scrollTtyOutput scrollWithBuffer scrollstyle
926	shade term_name title transparent transparent_all tripleclickwords	1287	secondaryScreen secondaryScroll shade skipBuiltinGlyphs skipScroll
		1288	term_name title transient_for transparent tripleclickwords urgentOnBell
927	utmpInhibit visualBell	1289	utmpInhibit visualBell
928		1290
929	=cut	1291	=cut
930		1292
931	sub resource($$;$) {	1293	sub resource($$;$) {
932	my ($self, $name) = (shift, shift);	1294	my ($self, $name) = (shift, shift);
933	unshift @_, $self, $name, ($name =~ s/\s*\+\s*(\d+)$// ? $1 : 0);	1295	unshift @_, $self, $name, ($name =~ s/\s*\+\s*(\d+)$// ? $1 : 0);
934	&urxvt::term::_resource	1296	goto &urxvt::term::_resource
935	}	1297	}
936		1298
937	=item $value = $term->x_resource ($pattern)	1299	=item $value = $term->x_resource ($pattern)
938		1300
939	Returns the X-Resource for the given pattern, excluding the program or	1301	Returns the X-Resource for the given pattern, excluding the program or
940	class name, i.e. C<< $term->x_resource ("boldFont") >> should return the	1302	class name, i.e. C<< $term->x_resource ("boldFont") >> should return the
941	same value as used by this instance of rxvt-unicode. Returns C<undef> if no	1303	same value as used by this instance of rxvt-unicode. Returns C<undef> if no
942	resource with that pattern exists.	1304	resource with that pattern exists.
943		1305
		1306	Extensions that define extra resources also need to call this method
		1307	to access their values.
		1308
		1309	If the method is called on an extension object (basically, from an
		1310	extension), then the special prefix C<%.> will be replaced by the name of
		1311	the extension and a dot, and the lone string C<%> will be replaced by the
		1312	extension name itself. This makes it possible to code extensions so you
		1313	can rename them and get a new set of resources without having to change
		1314	the actual code.
		1315
944	This method should only be called during the C<on_start> hook, as there is	1316	This method should only be called during the C<on_start> hook, as there is
945	only one resource database per display, and later invocations might return	1317	only one resource database per display, and later invocations might return
946	the wrong resources.	1318	the wrong resources.
947		1319
948	=item $success = $term->parse_keysym ($keysym_spec, $command_string)	1320	=item $value = $term->x_resource_boolean ($pattern)
949		1321
		1322	Like C<x_resource>, above, but interprets the string value as a boolean
		1323	and returns C<1> for true values, C<0> for false values and C<undef> if
		1324	the resource or option isn't specified.
		1325
		1326	You should always use this method to parse boolean resources.
		1327
		1328	=cut
		1329
		1330	sub x_resource_boolean {
		1331	my $res = &x_resource;
		1332
		1333	$res =~ /^\s*(?:true|yes|on|1)\s*$/i ? 1 : defined $res && 0
		1334	}
		1335
		1336	=item $success = $term->bind_action ($key, $action)
		1337
950	Adds a keymap translation exactly as specified via a resource. See the	1338	Adds a key binding exactly as specified via a C<keysym> resource. See the
951	C<keysym> resource in the @@RXVT_NAME@@(1) manpage.	1339	C<keysym> resource in the urxvt(1) manpage.
		1340
		1341	To add default bindings for an extension, the extension should call C<<
		1342	->bind_action >> on it's C<init> hook for every such binding. Doing it
		1343	in the C<init> hook allows users the override or remove the the binding
		1344	again.
		1345
		1346	Example: the C<searchable-scrollback> by default binds itself
		1347	on C<Meta-s>, using C<< $self->bind_action >>, which calls C<<
		1348	$term->bind_action >>.
		1349
		1350	sub init {
		1351	my ($self) = @_;
		1352
		1353	$self->bind_action ("M-s" => "%:start");
		1354	}
952		1355
953	=item $rend = $term->rstyle ([$new_rstyle])	1356	=item $rend = $term->rstyle ([$new_rstyle])
954		1357
955	Return and optionally change the current rendition. Text that is output by	1358	Return and optionally change the current rendition. Text that is output by
956	the terminal application will use this style.	1359	the terminal application will use this style.
…		…
964		1367
965	=item ($row, $col) = $term->selection_beg ([$row, $col])	1368	=item ($row, $col) = $term->selection_beg ([$row, $col])
966		1369
967	=item ($row, $col) = $term->selection_end ([$row, $col])	1370	=item ($row, $col) = $term->selection_end ([$row, $col])
968		1371
969	Return the current values of the selection mark, begin or end positions,	1372	Return the current values of the selection mark, begin or end positions.
970	and optionally set them to new values.	1373
		1374	When arguments are given, then the selection coordinates are set to
		1375	C<$row> and C<$col>, and the selection screen is set to the current
		1376	screen.
		1377
		1378	=item $screen = $term->selection_screen ([$screen])
		1379
		1380	Returns the current selection screen, and then optionally sets it.
971		1381
972	=item $term->selection_make ($eventtime[, $rectangular])	1382	=item $term->selection_make ($eventtime[, $rectangular])
973		1383
974	Tries to make a selection as set by C<selection_beg> and	1384	Tries to make a selection as set by C<selection_beg> and
975	C<selection_end>. If C<$rectangular> is true (default: false), a	1385	C<selection_end>. If C<$rectangular> is true (default: false), a
976	rectangular selection will be made. This is the prefered function to make	1386	rectangular selection will be made. This is the preferred function to make
977	a selection.	1387	a selection.
978		1388
979	=item $success = $term->selection_grab ($eventtime)	1389	=item $success = $term->selection_grab ($eventtime[, $clipboard])
980		1390
981	Try to request the primary selection text from the server (for example, as	1391	Try to acquire ownership of the primary (clipboard if C<$clipboard> is
		1392	true) selection from the server. The corresponding text can be set
982	set by the next method). No visual feedback will be given. This function	1393	with the next method. No visual feedback will be given. This function
983	is mostly useful from within C<on_sel_grab> hooks.	1394	is mostly useful from within C<on_sel_grab> hooks.
984		1395
985	=item $oldtext = $term->selection ([$newtext])	1396	=item $oldtext = $term->selection ([$newtext, $clipboard])
986		1397
987	Return the current selection text and optionally replace it by C<$newtext>.	1398	Return the current selection (clipboard if C<$clipboard> is true) text
		1399	and optionally replace it by C<$newtext>.
		1400
		1401	=item $term->selection_clear ([$clipboard])
		1402
		1403	Revoke ownership of the primary (clipboard if C<$clipboard> is true) selection.
988		1404
989	=item $term->overlay_simple ($x, $y, $text)	1405	=item $term->overlay_simple ($x, $y, $text)
990		1406
991	Create a simple multi-line overlay box. See the next method for details.	1407	Create a simple multi-line overlay box. See the next method for details.
992		1408
…		…
1022		1438
1023	The methods currently supported on C<urxvt::overlay> objects are:	1439	The methods currently supported on C<urxvt::overlay> objects are:
1024		1440
1025	=over 4	1441	=over 4
1026		1442
1027	=item $overlay->set ($x, $y, $text, $rend)	1443	=item $overlay->set ($x, $y, $text[, $rend])
1028		1444
1029	Similar to C<< $term->ROW_t >> and C<< $term->ROW_r >> in that it puts	1445	Similar to C<< $term->ROW_t >> and C<< $term->ROW_r >> in that it puts
1030	text in rxvt-unicode's special encoding and an array of rendition values	1446	text in rxvt-unicode's special encoding and an array of rendition values
1031	at a specific position inside the overlay.	1447	at a specific position inside the overlay.
		1448
		1449	If C<$rend> is missing, then the rendition will not be changed.
1032		1450
1033	=item $overlay->hide	1451	=item $overlay->hide
1034		1452
1035	If visible, hide the overlay, but do not destroy it.	1453	If visible, hide the overlay, but do not destroy it.
1036		1454
…		…
1099		1517
1100	=item $term->scr_add_lines ($string)	1518	=item $term->scr_add_lines ($string)
1101		1519
1102	Write the given text string to the screen, as if output by the application	1520	Write the given text string to the screen, as if output by the application
1103	running inside the terminal. It may not contain command sequences (escape	1521	running inside the terminal. It may not contain command sequences (escape
1104	codes), but is free to use line feeds, carriage returns and tabs. The	1522	codes - see C<cmd_parse> for that), but is free to use line feeds,
1105	string is a normal text string, not in locale-dependent encoding.	1523	carriage returns and tabs. The string is a normal text string, not in
		1524	locale-dependent encoding.
1106		1525
1107	Normally its not a good idea to use this function, as programs might be	1526	Normally its not a good idea to use this function, as programs might be
1108	confused by changes in cursor position or scrolling. Its useful inside a	1527	confused by changes in cursor position or scrolling. Its useful inside a
1109	C<on_add_lines> hook, though.	1528	C<on_add_lines> hook, though.
1110		1529
		1530	=item $term->scr_change_screen ($screen)
		1531
		1532	Switch to given screen - 0 primary, 1 secondary.
		1533
1111	=item $term->cmd_parse ($octets)	1534	=item $term->cmd_parse ($octets)
1112		1535
1113	Similar to C<scr_add_lines>, but the argument must be in the	1536	Similar to C<scr_add_lines>, but the argument must be in the
1114	locale-specific encoding of the terminal and can contain command sequences	1537	locale-specific encoding of the terminal and can contain command sequences
1115	(escape codes) that will be interpreted.	1538	(escape codes) that will be interpreted.
1116		1539
1117	=item $term->tt_write ($octets)	1540	=item $term->tt_write ($octets)
1118		1541
1119	Write the octets given in C<$data> to the tty (i.e. as program input). To	1542	Write the octets given in C<$octets> to the tty (i.e. as user input
		1543	to the program, see C<cmd_parse> for the opposite direction). To pass
1120	pass characters instead of octets, you should convert your strings first	1544	characters instead of octets, you should convert your strings first to the
1121	to the locale-specific encoding using C<< $term->locale_encode >>.	1545	locale-specific encoding using C<< $term->locale_encode >>.
		1546
		1547	=item $term->tt_write_user_input ($octets)
		1548
		1549	Like C<tt_write>, but should be used when writing strings in response to
		1550	the user pressing a key, to invoke the additional actions requested by
		1551	the user for that case (C<tt_write> doesn't do that).
		1552
		1553	The typical use case would be inside C<on_action> hooks.
		1554
		1555	=item $term->tt_paste ($octets)
		1556
		1557	Write the octets given in C<$octets> to the tty as a paste, converting NL to
		1558	CR and bracketing the data with control sequences if bracketed paste mode
		1559	is set.
1122		1560
1123	=item $old_events = $term->pty_ev_events ([$new_events])	1561	=item $old_events = $term->pty_ev_events ([$new_events])
1124		1562
1125	Replaces the event mask of the pty watcher by the given event mask. Can	1563	Replaces the event mask of the pty watcher by the given event mask. Can
1126	be used to suppress input and output handling to the pty/tty. See the	1564	be used to suppress input and output handling to the pty/tty. See the
1127	description of C<< urxvt::timer->events >>. Make sure to always restore	1565	description of C<< urxvt::timer->events >>. Make sure to always restore
1128	the previous value.	1566	the previous value.
1129		1567
		1568	=item $fd = $term->pty_fd
		1569
		1570	Returns the master file descriptor for the pty in use, or C<-1> if no pty
		1571	is used.
		1572
1130	=item $windowid = $term->parent	1573	=item $windowid = $term->parent
1131		1574
1132	Return the window id of the toplevel window.	1575	Return the window id of the toplevel window.
1133		1576
1134	=item $windowid = $term->vt	1577	=item $windowid = $term->vt
1135		1578
1136	Return the window id of the terminal window.	1579	Return the window id of the terminal window.
1137		1580
		1581	=item $term->vt_emask_add ($x_event_mask)
		1582
		1583	Adds the specified events to the vt event mask. Useful e.g. when you want
		1584	to receive pointer events all the times:
		1585
		1586	$term->vt_emask_add (urxvt::PointerMotionMask);
		1587
		1588	=item $term->set_urgency ($set)
		1589
		1590	Enable/disable the urgency hint on the toplevel window.
		1591
		1592	=item $term->focus_in
		1593
		1594	=item $term->focus_out
		1595
		1596	=item $term->key_press ($state, $keycode[, $time])
		1597
		1598	=item $term->key_release ($state, $keycode[, $time])
		1599
		1600	Deliver various fake events to to terminal.
		1601
1138	=item $window_width = $term->width	1602	=item $window_width = $term->width
1139		1603
1140	=item $window_height = $term->height	1604	=item $window_height = $term->height
1141		1605
1142	=item $font_width = $term->fwidth	1606	=item $font_width = $term->fwidth
…		…
1155		1619
1156	=item $max_scrollback = $term->saveLines	1620	=item $max_scrollback = $term->saveLines
1157		1621
1158	=item $nrow_plus_saveLines = $term->total_rows	1622	=item $nrow_plus_saveLines = $term->total_rows
1159		1623
1160	=item $lines_in_scrollback = $term->nsaved	1624	=item $topmost_scrollback_row = $term->top_row
1161		1625
1162	Return various integers describing terminal characteristics.	1626	Return various integers describing terminal characteristics.
1163		1627
1164	=item $x_display = $term->display_id	1628	=item $x_display = $term->display_id
1165		1629
…		…
1172	=item $env = $term->env	1636	=item $env = $term->env
1173		1637
1174	Returns a copy of the environment in effect for the terminal as a hashref	1638	Returns a copy of the environment in effect for the terminal as a hashref
1175	similar to C<\%ENV>.	1639	similar to C<\%ENV>.
1176		1640
		1641	=item @envv = $term->envv
		1642
		1643	Returns the environment as array of strings of the form C<VAR=VALUE>.
		1644
		1645	=item @argv = $term->argv
		1646
		1647	Return the argument vector as this terminal, similar to @ARGV, but
		1648	includes the program name as first element.
		1649
1177	=cut	1650	=cut
1178		1651
1179	sub env {	1652	sub env {
1180	if (my $env = $_[0]->_env) {
1181	+{ map /^([^=]+)(?:=(.*))?$/s && ($1 => $2), @$env }	1653	+{ map /^([^=]+)(?:=(.*))?$/s && ($1 => $2), $_[0]->envv }
1182	} else {
1183	+{ %ENV }
1184	}
1185	}	1654	}
1186		1655
1187	=item $modifiermask = $term->ModLevel3Mask	1656	=item $modifiermask = $term->ModLevel3Mask
1188		1657
1189	=item $modifiermask = $term->ModMetaMask	1658	=item $modifiermask = $term->ModMetaMask
…		…
1191	=item $modifiermask = $term->ModNumLockMask	1660	=item $modifiermask = $term->ModNumLockMask
1192		1661
1193	Return the modifier masks corresponding to the "ISO Level 3 Shift" (often	1662	Return the modifier masks corresponding to the "ISO Level 3 Shift" (often
1194	AltGr), the meta key (often Alt) and the num lock key, if applicable.	1663	AltGr), the meta key (often Alt) and the num lock key, if applicable.
1195		1664
		1665	=item $screen = $term->current_screen
		1666
		1667	Returns the currently displayed screen (0 primary, 1 secondary).
		1668
		1669	=item $cursor_is_hidden = $term->hidden_cursor
		1670
		1671	Returns whether the cursor is currently hidden or not.
		1672
1196	=item $view_start = $term->view_start ([$newvalue])	1673	=item $view_start = $term->view_start ([$newvalue])
1197		1674
1198	Returns the negative row number of the topmost line. Minimum value is	1675	Returns the row number of the topmost displayed line. Maximum value is
1199	C<0>, which displays the normal terminal contents. Larger values scroll	1676	C<0>, which displays the normal terminal contents. Lower values scroll
1200	this many lines into the scrollback buffer.	1677	this many lines into the scrollback buffer.
1201		1678
1202	=item $term->want_refresh	1679	=item $term->want_refresh
1203		1680
1204	Requests a screen refresh. At the next opportunity, rxvt-unicode will	1681	Requests a screen refresh. At the next opportunity, rxvt-unicode will
…		…
1207		1684
1208	Used after changing terminal contents to display them.	1685	Used after changing terminal contents to display them.
1209		1686
1210	=item $text = $term->ROW_t ($row_number[, $new_text[, $start_col]])	1687	=item $text = $term->ROW_t ($row_number[, $new_text[, $start_col]])
1211		1688
1212	Returns the text of the entire row with number C<$row_number>. Row C<0>	1689	Returns the text of the entire row with number C<$row_number>. Row C<< $term->top_row >>
1213	is the topmost terminal line, row C<< $term->$ncol-1 >> is the bottommost	1690	is the topmost terminal line, row C<< $term->nrow-1 >> is the bottommost
1214	terminal line. The scrollback buffer starts at line C<-1> and extends to
1215	line C<< -$term->nsaved >>. Nothing will be returned if a nonexistent line	1691	terminal line. Nothing will be returned if a nonexistent line
1216	is requested.	1692	is requested.
1217		1693
1218	If C<$new_text> is specified, it will replace characters in the current	1694	If C<$new_text> is specified, it will replace characters in the current
1219	line, starting at column C<$start_col> (default C<0>), which is useful	1695	line, starting at column C<$start_col> (default C<0>), which is useful
1220	to replace only parts of a line. The font index in the rendition will	1696	to replace only parts of a line. The font index in the rendition will
1221	automatically be updated.	1697	automatically be updated.
1222		1698
1223	C<$text> is in a special encoding: tabs and wide characters that use more	1699	C<$text> is in a special encoding: tabs and wide characters that use more
1224	than one cell when displayed are padded with urxvt::NOCHAR characters	1700	than one cell when displayed are padded with C<$urxvt::NOCHAR> (chr 65535)
1225	(C<chr 65535>). Characters with combining characters and other characters	1701	characters. Characters with combining characters and other characters that
1226	that do not fit into the normal tetx encoding will be replaced with	1702	do not fit into the normal text encoding will be replaced with characters
1227	characters in the private use area.	1703	in the private use area.
1228		1704
1229	You have to obey this encoding when changing text. The advantage is	1705	You have to obey this encoding when changing text. The advantage is
1230	that C<substr> and similar functions work on screen cells and not on	1706	that C<substr> and similar functions work on screen cells and not on
1231	characters.	1707	characters.
1232		1708
…		…
1316	}	1792	}
1317		1793
1318	sub urxvt::line::t {	1794	sub urxvt::line::t {
1319	my ($self) = @_;	1795	my ($self) = @_;
1320		1796
1321	if (@_ > 1)	1797	if (@_ > 1) {
1322	{
1323	$self->{term}->ROW_t ($_, $_[1], 0, ($_ - $self->{beg}) * $self->{ncol}, $self->{ncol})	1798	$self->{term}->ROW_t ($_, $_[1], 0, ($_ - $self->{beg}) * $self->{ncol}, $self->{ncol})
1324	for $self->{beg} .. $self->{end};	1799	for $self->{beg} .. $self->{end};
1325	}	1800	}
1326		1801
1327	defined wantarray &&	1802	defined wantarray &&
1328	substr +(join "", map $self->{term}->ROW_t ($_), $self->{beg} .. $self->{end}),	1803	substr +(join "", map $self->{term}->ROW_t ($_), $self->{beg} .. $self->{end}),
1329	0, $self->{len}	1804	0, $self->{len}
1330	}	1805	}
1331		1806
1332	sub urxvt::line::r {	1807	sub urxvt::line::r {
1333	my ($self) = @_;	1808	my ($self) = @_;
1334		1809
1335	if (@_ > 1)	1810	if (@_ > 1) {
1336	{
1337	$self->{term}->ROW_r ($_, $_[1], 0, ($_ - $self->{beg}) * $self->{ncol}, $self->{ncol})	1811	$self->{term}->ROW_r ($_, $_[1], 0, ($_ - $self->{beg}) * $self->{ncol}, $self->{ncol})
1338	for $self->{beg} .. $self->{end};	1812	for $self->{beg} .. $self->{end};
1339	}	1813	}
1340		1814
1341	if (defined wantarray) {	1815	if (defined wantarray) {
1342	my $rend = [	1816	my $rend = [
1343	map @{ $self->{term}->ROW_r ($_) }, $self->{beg} .. $self->{end}	1817	map @{ $self->{term}->ROW_r ($_) }, $self->{beg} .. $self->{end}
1344	];	1818	];
…		…
1376	where one character corresponds to one screen cell. See	1850	where one character corresponds to one screen cell. See
1377	C<< $term->ROW_t >> for details.	1851	C<< $term->ROW_t >> for details.
1378		1852
1379	=item $string = $term->special_decode $text	1853	=item $string = $term->special_decode $text
1380		1854
1381	Converts rxvt-unicodes text reprsentation into a perl string. See	1855	Converts rxvt-unicodes text representation into a perl string. See
1382	C<< $term->ROW_t >> for details.	1856	C<< $term->ROW_t >> for details.
1383		1857
1384	=item $success = $term->grab_button ($button, $modifiermask)	1858	=item $success = $term->grab_button ($button, $modifiermask[, $window = $term->vt])
1385		1859
		1860	=item $term->ungrab_button ($button, $modifiermask[, $window = $term->vt])
		1861
1386	Registers a synchronous button grab. See the XGrabButton manpage.	1862	Register/unregister a synchronous button grab. See the XGrabButton
		1863	manpage.
1387		1864
1388	=item $success = $term->grab ($eventtime[, $sync])	1865	=item $success = $term->grab ($eventtime[, $sync])
1389		1866
1390	Calls XGrabPointer and XGrabKeyboard in asynchronous (default) or	1867	Calls XGrabPointer and XGrabKeyboard in asynchronous (default) or
1391	synchronous (C<$sync> is true). Also remembers the grab timestampe.	1868	synchronous (C<$sync> is true). Also remembers the grab timestamp.
1392		1869
1393	=item $term->allow_events_async	1870	=item $term->allow_events_async
1394		1871
1395	Calls XAllowEvents with AsyncBoth for the most recent grab.	1872	Calls XAllowEvents with AsyncBoth for the most recent grab.
1396		1873
…		…
1403	Calls XAllowEvents with both ReplayPointer and ReplayKeyboard for the most	1880	Calls XAllowEvents with both ReplayPointer and ReplayKeyboard for the most
1404	recent grab.	1881	recent grab.
1405		1882
1406	=item $term->ungrab	1883	=item $term->ungrab
1407		1884
1408	Calls XUngrab for the most recent grab. Is called automatically on	1885	Calls XUngrabPointer and XUngrabKeyboard for the most recent grab. Is called automatically on
1409	evaluation errors, as it is better to lose the grab in the error case as	1886	evaluation errors, as it is better to lose the grab in the error case as
1410	the session.	1887	the session.
		1888
		1889	=item $atom = $term->XInternAtom ($atom_name[, $only_if_exists])
		1890
		1891	=item $atom_name = $term->XGetAtomName ($atom)
		1892
		1893	=item @atoms = $term->XListProperties ($window)
		1894
		1895	=item ($type,$format,$octets) = $term->XGetWindowProperty ($window, $property)
		1896
		1897	=item $term->XChangeProperty ($window, $property, $type, $format, $octets)
		1898
		1899	=item $term->XDeleteProperty ($window, $property)
		1900
		1901	=item $window = $term->DefaultRootWindow
		1902
		1903	=item $term->XReparentWindow ($window, $parent, [$x, $y])
		1904
		1905	=item $term->XMapWindow ($window)
		1906
		1907	=item $term->XUnmapWindow ($window)
		1908
		1909	=item $term->XMoveResizeWindow ($window, $x, $y, $width, $height)
		1910
		1911	=item ($x, $y, $child_window) = $term->XTranslateCoordinates ($src, $dst, $x, $y)
		1912
		1913	=item $term->XChangeInput ($window, $add_events[, $del_events])
		1914
		1915	=item $keysym = $term->XStringToKeysym ($string)
		1916
		1917	=item $string = $term->XKeysymToString ($keysym)
		1918
		1919	Various X or X-related functions. The C<$term> object only serves as
		1920	the source of the display, otherwise those functions map more-or-less
		1921	directly onto the X functions of the same name.
1411		1922
1412	=back	1923	=back
1413		1924
1414	=cut	1925	=cut
1415		1926
…		…
1479	my ($self, $text, $cb) = @_;	1990	my ($self, $text, $cb) = @_;
1480		1991
1481	$self->add_item ({ type => "button", text => $text, activate => $cb});	1992	$self->add_item ({ type => "button", text => $text, activate => $cb});
1482	}	1993	}
1483		1994
1484	=item $popup->add_toggle ($text, $cb, $initial_value)	1995	=item $popup->add_toggle ($text, $initial_value, $cb)
1485		1996
1486	Adds a toggle/checkbox item to the popup. Teh callback gets called	1997	Adds a toggle/checkbox item to the popup. The callback gets called
1487	whenever it gets toggled, with a boolean indicating its value as its first	1998	whenever it gets toggled, with a boolean indicating its new value as its
1488	argument.	1999	first argument.
1489		2000
1490	=cut	2001	=cut
1491		2002
1492	sub add_toggle {	2003	sub add_toggle {
1493	my ($self, $text, $cb, $value) = @_;	2004	my ($self, $text, $value, $cb) = @_;
1494		2005
1495	my $item; $item = {	2006	my $item; $item = {
1496	type => "button",	2007	type => "button",
1497	text => " $text",	2008	text => " $text",
1498	value => $value,	2009	value => $value,
…		…
1517	my $env = $self->{term}->env;	2028	my $env = $self->{term}->env;
1518	# we can't hope to reproduce the locale algorithm, so nuke LC_ALL and set LC_CTYPE.	2029	# we can't hope to reproduce the locale algorithm, so nuke LC_ALL and set LC_CTYPE.
1519	delete $env->{LC_ALL};	2030	delete $env->{LC_ALL};
1520	$env->{LC_CTYPE} = $self->{term}->locale;	2031	$env->{LC_CTYPE} = $self->{term}->locale;
1521		2032
1522	urxvt::term->new ($env, $self->{term}->resource ("name"),	2033	my $term = urxvt::term->new (
1523	"--perl-lib" => "", "--perl-ext-common" => "", "-pty-fd" => -1, "-sl" => 0, "-b" => 0,	2034	$env, "popup",
		2035	"--perl-lib" => "", "--perl-ext-common" => "",
		2036	"-pty-fd" => -1, "-sl" => 0,
		2037	"-b" => 1, "-bd" => "grey80", "-bl", "-override-redirect",
1524	"--transient-for" => $self->{term}->parent,	2038	"--transient-for" => $self->{term}->parent,
1525	"-display" => $self->{term}->display_id,	2039	"-display" => $self->{term}->display_id,
1526	"-pe" => "urxvt-popup")	2040	"-pe" => "urxvt-popup",
1527	or die "unable to create popup window\n";	2041	) or die "unable to create popup window\n";
		2042
		2043	unless (delete $term->{urxvt_popup_init_done}) {
		2044	$term->ungrab;
		2045	$term->destroy;
		2046	die "unable to initialise popup window\n";
		2047	}
1528	}	2048	}
1529		2049
1530	sub DESTROY {	2050	sub DESTROY {
1531	my ($self) = @_;	2051	my ($self) = @_;
1532		2052
1533	delete $self->{term}{_destroy}{$self};	2053	delete $self->{term}{_destroy}{$self};
1534	$self->{term}->ungrab;	2054	$self->{term}->ungrab;
1535	}	2055	}
1536		2056
1537	=back	2057	=back
		2058
		2059	=cut
		2060
		2061	package urxvt::watcher;
1538		2062
1539	=head2 The C<urxvt::timer> Class	2063	=head2 The C<urxvt::timer> Class
1540		2064
1541	This class implements timer watchers/events. Time is represented as a	2065	This class implements timer watchers/events. Time is represented as a
1542	fractional number of seconds since the epoch. Example:	2066	fractional number of seconds since the epoch. Example:
…		…
1546	->new	2070	->new
1547	->interval (1)	2071	->interval (1)
1548	->cb (sub {	2072	->cb (sub {
1549	$term->{overlay}->set (0, 0,	2073	$term->{overlay}->set (0, 0,
1550	sprintf "%2d:%02d:%02d", (localtime urxvt::NOW)[2,1,0]);	2074	sprintf "%2d:%02d:%02d", (localtime urxvt::NOW)[2,1,0]);
1551	});	2075	});
1552		2076
1553	=over 4	2077	=over 4
1554		2078
1555	=item $timer = new urxvt::timer	2079	=item $timer = new urxvt::timer
1556		2080
…		…
1559		2083
1560	=item $timer = $timer->cb (sub { my ($timer) = @_; ... })	2084	=item $timer = $timer->cb (sub { my ($timer) = @_; ... })
1561		2085
1562	Set the callback to be called when the timer triggers.	2086	Set the callback to be called when the timer triggers.
1563		2087
1564	=item $tstamp = $timer->at
1565
1566	Return the time this watcher will fire next.
1567
1568	=item $timer = $timer->set ($tstamp)	2088	=item $timer = $timer->set ($tstamp[, $interval])
1569		2089
1570	Set the time the event is generated to $tstamp.	2090	Set the time the event is generated to $tstamp (and optionally specifies a
		2091	new $interval).
1571		2092
1572	=item $timer = $timer->interval ($interval)	2093	=item $timer = $timer->interval ($interval)
1573		2094
1574	Normally (and when C<$interval> is C<0>), the timer will automatically	2095	By default (and when C<$interval> is C<0>), the timer will automatically
1575	stop after it has fired once. If C<$interval> is non-zero, then the timer	2096	stop after it has fired once. If C<$interval> is non-zero, then the timer
1576	is automatically rescheduled at the given intervals.	2097	is automatically rescheduled at the given intervals.
1577		2098
1578	=item $timer = $timer->start	2099	=item $timer = $timer->start
1579		2100
1580	Start the timer.	2101	Start the timer.
1581		2102
1582	=item $timer = $timer->start ($tstamp)	2103	=item $timer = $timer->start ($tstamp[, $interval])
1583		2104
1584	Set the event trigger time to C<$tstamp> and start the timer.	2105	Set the event trigger time to C<$tstamp> and start the timer. Optionally
		2106	also replaces the interval.
		2107
		2108	=item $timer = $timer->after ($delay[, $interval])
		2109
		2110	Like C<start>, but sets the expiry timer to c<urxvt::NOW + $delay>.
1585		2111
1586	=item $timer = $timer->stop	2112	=item $timer = $timer->stop
1587		2113
1588	Stop the timer.	2114	Stop the timer.
1589		2115
…		…
1595		2121
1596	$term->{socket} = ...	2122	$term->{socket} = ...
1597	$term->{iow} = urxvt::iow	2123	$term->{iow} = urxvt::iow
1598	->new	2124	->new
1599	->fd (fileno $term->{socket})	2125	->fd (fileno $term->{socket})
1600	->events (urxvt::EVENT_READ)	2126	->events (urxvt::EV_READ)
1601	->start	2127	->start
1602	->cb (sub {	2128	->cb (sub {
1603	my ($iow, $revents) = @_;	2129	my ($iow, $revents) = @_;
1604	# $revents must be 1 here, no need to check	2130	# $revents must be 1 here, no need to check
1605	sysread $term->{socket}, my $buf, 8192	2131	sysread $term->{socket}, my $buf, 8192
…		…
1618	Set the callback to be called when io events are triggered. C<$reventmask>	2144	Set the callback to be called when io events are triggered. C<$reventmask>
1619	is a bitset as described in the C<events> method.	2145	is a bitset as described in the C<events> method.
1620		2146
1621	=item $iow = $iow->fd ($fd)	2147	=item $iow = $iow->fd ($fd)
1622		2148
1623	Set the filedescriptor (not handle) to watch.	2149	Set the file descriptor (not handle) to watch.
1624		2150
1625	=item $iow = $iow->events ($eventmask)	2151	=item $iow = $iow->events ($eventmask)
1626		2152
1627	Set the event mask to watch. The only allowed values are	2153	Set the event mask to watch. The only allowed values are
1628	C<urxvt::EVENT_READ> and C<urxvt::EVENT_WRITE>, which might be ORed	2154	C<urxvt::EV_READ> and C<urxvt::EV_WRITE>, which might be ORed
1629	together, or C<urxvt::EVENT_NONE>.	2155	together, or C<urxvt::EV_NONE>.
1630		2156
1631	=item $iow = $iow->start	2157	=item $iow = $iow->start
1632		2158
1633	Start watching for requested events on the given handle.	2159	Start watching for requested events on the given handle.
1634		2160
1635	=item $iow = $iow->stop	2161	=item $iow = $iow->stop
1636		2162
1637	Stop watching for events on the given filehandle.	2163	Stop watching for events on the given file handle.
		2164
		2165	=back
		2166
		2167	=head2 The C<urxvt::iw> Class
		2168
		2169	This class implements idle watchers, that get called automatically when
		2170	the process is idle. They should return as fast as possible, after doing
		2171	some useful work.
		2172
		2173	=over 4
		2174
		2175	=item $iw = new urxvt::iw
		2176
		2177	Create a new idle watcher object in stopped state.
		2178
		2179	=item $iw = $iw->cb (sub { my ($iw) = @_; ... })
		2180
		2181	Set the callback to be called when the watcher triggers.
		2182
		2183	=item $timer = $timer->start
		2184
		2185	Start the watcher.
		2186
		2187	=item $timer = $timer->stop
		2188
		2189	Stop the watcher.
		2190
		2191	=back
		2192
		2193	=head2 The C<urxvt::pw> Class
		2194
		2195	This class implements process watchers. They create an event whenever a
		2196	process exits, after which they stop automatically.
		2197
		2198	my $pid = fork;
		2199	...
		2200	$term->{pw} = urxvt::pw
		2201	->new
		2202	->start ($pid)
		2203	->cb (sub {
		2204	my ($pw, $exit_status) = @_;
		2205	...
		2206	});
		2207
		2208	=over 4
		2209
		2210	=item $pw = new urxvt::pw
		2211
		2212	Create a new process watcher in stopped state.
		2213
		2214	=item $pw = $pw->cb (sub { my ($pw, $exit_status) = @_; ... })
		2215
		2216	Set the callback to be called when the timer triggers.
		2217
		2218	=item $pw = $timer->start ($pid)
		2219
		2220	Tells the watcher to start watching for process C<$pid>.
		2221
		2222	=item $pw = $pw->stop
		2223
		2224	Stop the watcher.
1638		2225
1639	=back	2226	=back
1640		2227
1641	=head1 ENVIRONMENT	2228	=head1 ENVIRONMENT
1642		2229
…		…
1651		2238
1652	=item >= 3 - script loading and management	2239	=item >= 3 - script loading and management
1653		2240
1654	=item >=10 - all called hooks	2241	=item >=10 - all called hooks
1655		2242
1656	=item >=11 - hook reutrn values	2243	=item >=11 - hook return values
1657		2244
1658	=back	2245	=back
1659		2246
1660	=head1 AUTHOR	2247	=head1 AUTHOR
1661		2248
1662	Marc Lehmann <pcg@goof.com>	2249	Marc Lehmann <schmorp@schmorp.de>
1663	http://software.schmorp.de/pkg/rxvt-unicode	2250	http://software.schmorp.de/pkg/rxvt-unicode
1664		2251
1665	=cut	2252	=cut
1666		2253
1667	1	2254	1
		2255
		2256	# vim: sw=3:

Diff Legend

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