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.107 by root, Wed Jan 18 21:30:50 2006 UTC vs.
Revision 1.248 by root, Fri Dec 26 21:01:46 2014 UTC

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

Diff Legend

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