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

Diff Legend

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