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.103 by root, Wed Jan 18 11:05:09 2006 UTC vs.
Revision 1.254 by sf-exg, Tue Mar 17 09:23:08 2015 UTC

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

Diff Legend

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