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.142 by root, Thu Jul 6 18:56:10 2006 UTC vs.
Revision 1.261 by root, Fri Jun 18 12:35:38 2021 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	Or by adding them to the resource for extensions loaded by default:	44	Or by adding them to the resource for extensions loaded by default:
41		45
42	URxvt.perl-ext-common: default,automove-background,selection-autotransform	46	URxvt.perl-ext-common: default,selection-autotransform
43		47
44	=over 4	48	Extensions may add additional resources and C<actions>, i.e., methods
45		49	which can be bound to a key and invoked by the user. An extension can
46	=item selection (enabled by default)	50	define the resources it support using so called META comments,
47		51	described below. Similarly to builtin resources, extension resources
48	(More) intelligent selection. This extension tries to be more intelligent	52	can also be specified on the command line as long options (with C<.>
49	when the user extends selections (double-click and further clicks). Right	53	replaced by C<->), in which case the corresponding extension is loaded
50	now, it tries to select words, urls and complete shell-quoted	54	automatically. For this to work the extension B<must> define META
51	arguments, which is very convenient, too, if your F<ls> supports	55	comments for its resources.
52	C<--quoting-style=shell>.
53
54	A double-click usually selects the word under the cursor, further clicks
55	will enlarge the selection.
56
57	The selection works by trying to match a number of regexes and displaying
58	them in increasing order of length. You can add your own regexes by
59	specifying resources of the form:
60
61	URxvt.selection.pattern-0: perl-regex
62	URxvt.selection.pattern-1: perl-regex
63	...
64
65	The index number (0, 1...) must not have any holes, and each regex must
66	contain at least one pair of capturing parentheses, which will be used for
67	the match. For example, the followign adds a regex that matches everything
68	between two vertical bars:
69
70	URxvt.selection.pattern-0: \\|([^|]+)\\|
71
72	Another example: Programs I use often output "absolute path: " at the
73	beginning of a line when they process multiple files. The following
74	pattern matches the filename (note, there is a single space at the very
75	end):
76
77	URxvt.selection.pattern-0: ^(/[^:]+):\
78
79	You can look at the source of the selection extension to see more
80	interesting uses, such as parsing a line from beginning to end.
81
82	This extension also offers following bindable keyboard commands:
83
84	=over 4
85
86	=item rot13
87
88	Rot-13 the selection when activated. Used via keyboard trigger:
89
90	URxvt.keysym.C-M-r: perl:selection:rot13
91
92	=back
93
94	=item option-popup (enabled by default)
95
96	Binds a popup menu to Ctrl-Button2 that lets you toggle (some) options at
97	runtime.
98
99	Other extensions can extend this popup menu by pushing a code reference
100	onto C<@{ $term->{option_popup_hook} }>, which gets called whenever the
101	popup is being displayed.
102
103	It's sole argument is the popup menu, which can be modified. It should
104	either return nothing or a string, the initial boolean value and a code
105	reference. The string will be used as button text and the code reference
106	will be called when the toggle changes, with the new boolean value as
107	first argument.
108
109	The following will add an entry C<myoption> that changes
110	C<$self->{myoption}>:
111
112	push @{ $self->{term}{option_popup_hook} }, sub {
113	("my option" => $myoption, sub { $self->{myoption} = $_[0] })
114	};
115
116	=item selection-popup (enabled by default)
117
118	Binds a popup menu to Ctrl-Button3 that lets you convert the selection
119	text into various other formats/action (such as uri unescaping, perl
120	evaluation, web-browser starting etc.), depending on content.
121
122	Other extensions can extend this popup menu by pushing a code reference
123	onto C<@{ $term->{selection_popup_hook} }>, which gets called whenever the
124	popup is being displayed.
125
126	It's sole argument is the popup menu, which can be modified. The selection
127	is in C<$_>, which can be used to decide wether to add something or not.
128	It should either return nothing or a string and a code reference. The
129	string will be used as button text and the code reference will be called
130	when the button gets activated and should transform C<$_>.
131
132	The following will add an entry C<a to b> that transforms all C<a>s in
133	the selection to C<b>s, but only if the selection currently contains any
134	C<a>s:
135
136	push @{ $self->{term}{selection_popup_hook} }, sub {
137	/a/ ? ("a to be" => sub { s/a/b/g }
138	: ()
139	};
140
141	=item searchable-scrollback<hotkey> (enabled by default)
142
143	Adds regex search functionality to the scrollback buffer, triggered
144	by a hotkey (default: C<M-s>). While in search mode, normal terminal
145	input/output is suspended and a regex is displayed at the bottom of the
146	screen.
147
148	Inputting characters appends them to the regex and continues incremental
149	search. C<BackSpace> removes a character from the regex, C<Up> and C<Down>
150	search upwards/downwards in the scrollback buffer, C<End> jumps to the
151	bottom. C<Escape> leaves search mode and returns to the point where search
152	was started, while C<Enter> or C<Return> stay at the current position and
153	additionally stores the first match in the current line into the primary
154	selection.
155
156	The regex defaults to "(?i)", resulting in a case-insensitive search. To
157	get a case-sensitive search you can delete this prefix using C<BackSpace>
158	or simply use an uppercase character which removes the "(?i)" prefix.
159
160	See L<perlre> for more info about perl regular expression syntax.
161
162	=item readline (enabled by default)
163
164	A support package that tries to make editing with readline easier. At
165	the moment, it reacts to clicking shift-left mouse button by trying to
166	move the text cursor to this position. It does so by generating as many
167	cursor-left or cursor-right keypresses as required (the this only works
168	for programs that correctly support wide characters).
169
170	To avoid too many false positives, this is only done when:
171
172	=over 4
173
174	=item - the tty is in ICANON state.
175
176	=item - the text cursor is visible.
177
178	=item - the primary screen is currently being displayed.
179
180	=item - the mouse is on the same (multi-row-) line as the text cursor.
181
182	=back
183
184	The normal selection mechanism isn't disabled, so quick successive clicks
185	might interfere with selection creation in harmless ways.
186
187	=item selection-autotransform
188
189	This selection allows you to do automatic transforms on a selection
190	whenever a selection is made.
191
192	It works by specifying perl snippets (most useful is a single C<s///>
193	operator) that modify C<$_> as resources:
194
195	URxvt.selection-autotransform.0: transform
196	URxvt.selection-autotransform.1: transform
197	...
198
199	For example, the following will transform selections of the form
200	C<filename:number>, often seen in compiler messages, into C<vi +$filename
201	$word>:
202
203	URxvt.selection-autotransform.0: s/^([^:[:space:]]+):(\\d+):?$/vi +$2 \\Q$1\\E\\x0d/
204
205	And this example matches the same,but replaces it with vi-commands you can
206	paste directly into your (vi :) editor:
207
208	URxvt.selection-autotransform.0: s/^([^:[:space:]]+(\\d+):?$/:e \\Q$1\\E\\x0d:$2\\x0d/
209
210	Of course, this can be modified to suit your needs and your editor :)
211
212	To expand the example above to typical perl error messages ("XXX at
213	FILENAME line YYY."), you need a slightly more elaborate solution:
214
215	URxvt.selection.pattern-0: ( at .*? line \\d+[,.])
216	URxvt.selection-autotransform.0: s/^ at (.*?) line (\\d+)[,.]$/:e \\Q$1\E\\x0d:$2\\x0d/
217
218	The first line tells the selection code to treat the unchanging part of
219	every error message as a selection pattern, and the second line transforms
220	the message into vi commands to load the file.
221
222	=item tabbed
223
224	This transforms the terminal into a tabbar with additional terminals, that
225	is, it implements what is commonly refered to as "tabbed terminal". The topmost line
226	displays a "[NEW]" button, which, when clicked, will add a new tab, followed by one
227	button per tab.
228
229	Clicking a button will activate that tab. Pressing B<Shift-Left> and
230	B<Shift-Right> will switch to the tab left or right of the current one,
231	while B<Shift-Down> creates a new tab.
232
233	The tabbar itself can be configured similarly to a normal terminal, but
234	with a resource class of C<URxvt.tabbed>. In addition, it supports the
235	following four resources (shown with defaults):
236
237	URxvt.tabbed.tabbar-fg: <colour-index, default 3>
238	URxvt.tabbed.tabbar-bg: <colour-index, default 0>
239	URxvt.tabbed.tab-fg: <colour-index, default 0>
240	URxvt.tabbed.tab-bg: <colour-index, default 1>
241
242	See I<COLOR AND GRAPHICS> in the @@RXVT_NAME@@(1) manpage for valid
243	indices.
244
245	=item mark-urls
246
247	Uses per-line display filtering (C<on_line_update>) to underline urls and
248	make them clickable. When middle-clicked, the program specified in the
249	resource C<urlLauncher> (default C<x-www-browser>) will be started with
250	the URL as first argument.
251
252	=item xim-onthespot
253
254	This (experimental) perl extension implements OnTheSpot editing. It does
255	not work perfectly, and some input methods don't seem to work well with
256	OnTheSpot editing in general, but it seems to work at leats for SCIM and
257	kinput2.
258
259	You enable it by specifying this extension and a preedit style of
260	C<OnTheSpot>, i.e.:
261
262	@@RXVT_NAME@@ -pt OnTheSpot -pe xim-onthespot
263
264	=item automove-background
265
266	This is basically a very small extension that dynamically changes the
267	background pixmap offset to the window position, in effect creating the
268	same effect as pseudo transparency with a custom pixmap. No scaling is
269	supported in this mode. Exmaple:
270
271	@@RXVT_NAME@@ -pixmap background.xpm -pe automove-background
272
273	=item block-graphics-to-ascii
274
275	A not very useful example of filtering all text output to the terminal
276	by replacing all line-drawing characters (U+2500 .. U+259F) by a
277	similar-looking ascii character.
278
279	=item digital-clock
280
281	Displays a digital clock using the built-in overlay.
282
283	=item remote-clipboard
284
285	Somewhat of a misnomer, this extension adds two menu entries to the
286	selection popup that allows one ti run external commands to store the
287	selection somewhere and fetch it again.
288
289	We use it to implement a "distributed selection mechanism", which just
290	means that one command uploads the file to a remote server, and another
291	reads it.
292
293	The commands can be set using the C<URxvt.remote-selection.store> and
294	C<URxvt.remote-selection.fetch> resources. The first should read the
295	selection to store from STDIN (always in UTF-8), the second should provide
296	the selection data on STDOUT (also in UTF-8).
297
298	The defaults (which are likely useless to you) use rsh and cat:
299
300	URxvt.remote-selection.store: rsh ruth 'cat >/tmp/distributed-selection'
301	URxvt.remote-selection.fetch: rsh ruth 'cat /tmp/distributed-selection'
302
303	=item selection-pastebin
304
305	This is a little rarely useful extension that Uploads the selection as
306	textfile to a remote site (or does other things). (The implementation is
307	not currently secure for use in a multiuser environment as it writes to
308	F</tmp> directly.).
309
310	It listens to the C<selection-pastebin:remote-pastebin> keyboard command,
311	i.e.
312
313	URxvt.keysym.C-M-e: perl:selection-pastebin:remote-pastebin
314
315	Pressing this combination runs a command with C<%> replaced by the name of
316	the textfile. This command can be set via a resource:
317
318	URxvt.selection-pastebin.cmd: rsync -apP % ruth:/var/www/www.ta-sa.org/files/txt/.
319
320	And the default is likely not useful to anybody but the few people around
321	here :)
322
323	The name of the textfile is the hex encoded md5 sum of the selection, so
324	the same content should lead to the same filename.
325
326	After a successful upload the selection will be replaced by the text given
327	in the C<selection-pastebin-url> resource (again, the % is the placeholder
328	for the filename):
329
330	URxvt.selection-pastebin.url: http://www.ta-sa.org/files/txt/%
331
332	=item example-refresh-hooks
333
334	Displays a very simple digital clock in the upper right corner of the
335	window. Illustrates overwriting the refresh callbacks to create your own
336	overlays or changes.
337
338	=back
339		56
340	=head1 API DOCUMENTATION	57	=head1 API DOCUMENTATION
341		58
342	=head2 General API Considerations	59	=head2 General API Considerations
343		60
…		…
357		74
358	=over 4	75	=over 4
359		76
360	=item $text	77	=item $text
361		78
362	Rxvt-unicodes special way of encoding text, where one "unicode" character	79	Rxvt-unicode's special way of encoding text, where one "unicode" character
363	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.
364		81
365	=item $string	82	=item $string
366		83
367	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
…		…
371	=item $octets	88	=item $octets
372		89
373	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
374	locale-specific way.	91	locale-specific way.
375		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
376	=back	99	=back
377		100
378	=head2 Extension Objects	101	=head2 Extension Objects
379		102
380	Every 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
381	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,
382	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
383	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
384	begin with an underscore character C<_>: these are reserved for internal	108	that begin with an underscore character C<_>: these are reserved for
385	use.	109	internal use.
386		110
387	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
388	C<urxvt::term> class on this object.	112	C<urxvt::term> class on this object.
389		113
390	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. These comments are scanned whenever a
		121	terminal is created and are typically used to autoload extensions when
		122	their resources or command line parameters are used.
		123
		124	Currently, it recognises only one such comment:
391		125
392	=over 4	126	=over 4
393		127
394	=item $urxvt_term = $self->{term}	128	=item #:META:RESOURCE:name:type:desc
395		129
396	Returns the C<urxvt::term> object associated with this instance of the	130	The RESOURCE comment defines a resource used by the extension, where
397	extension. This member I<must not> be changed in any way.	131	C<name> is the resource name, C<type> is the resource type, C<boolean>
		132	or C<string>, and C<desc> is the resource description.
398		133
399	=item $self->enable ($hook_name => $cb, [$hook_name => $cb..])	134	The extension will be autoloaded when this resource is specified or used
400		135	as a command line parameter.
401	Dynamically enable the given hooks (named without the C<on_> prefix) for
402	this extension, replacing any previous hook. This is useful when you want
403	to overwrite time-critical hooks only temporarily.
404
405	=item $self->disable ($hook_name[, $hook_name..])
406
407	Dynamically disable the given hooks.
408		136
409	=back	137	=back
410		138
411	=head2 Hooks	139	=head2 Hooks
412		140
413	The following subroutines can be declared in extension files, and will be	141	The following subroutines can be declared in extension files, and will be
414	called whenever the relevant event happens.	142	called whenever the relevant event happens.
415		143
416	The first argument passed to them is an extension oject as described in	144	The first argument passed to them is an extension object as described in
417	the in the C<Extension Objects> section.	145	the in the C<Extension Objects> section.
418		146
419	B<All> of these hooks must return a boolean value. If any of the called	147	B<All> of these hooks must return a boolean value. If any of the called
420	hooks returns true, then the event counts as being I<consumed>, and the	148	hooks returns true, then the event counts as being I<consumed>, and the
421	relevant action might not be carried out by the C++ code.	149	relevant action might not be carried out by the C++ code.
…		…
434	place.	162	place.
435		163
436	=item on_start $term	164	=item on_start $term
437		165
438	Called at the very end of initialisation of a new terminal, just before	166	Called at the very end of initialisation of a new terminal, just before
439	trying to map (display) the toplevel and returning to the mainloop.	167	trying to map (display) the toplevel and returning to the main loop.
440		168
441	=item on_destroy $term	169	=item on_destroy $term
442		170
443	Called whenever something tries to destroy terminal, when the terminal is	171	Called whenever something tries to destroy terminal, when the terminal is
444	still fully functional (not for long, though).	172	still fully functional (not for long, though).
…		…
471		199
472	Called whenever a selection has been copied, but before the selection is	200	Called whenever a selection has been copied, but before the selection is
473	requested from the server. The selection text can be queried and changed	201	requested from the server. The selection text can be queried and changed
474	by calling C<< $term->selection >>.	202	by calling C<< $term->selection >>.
475		203
476	Returning a true value aborts selection grabbing. It will still be hilighted.	204	Returning a true value aborts selection grabbing. It will still be highlighted.
477		205
478	=item on_sel_extend $term	206	=item on_sel_extend $term
479		207
480	Called whenever the user tries to extend the selection (e.g. with a double	208	Called whenever the user tries to extend the selection (e.g. with a double
481	click) and is either supposed to return false (normal operation), or	209	click) and is either supposed to return false (normal operation), or
482	should extend the selection itelf and return true to suppress the built-in	210	should extend the selection itself and return true to suppress the built-in
483	processing. This can happen multiple times, as long as the callback	211	processing. This can happen multiple times, as long as the callback
484	returns true, it will be called on every further click by the user and is	212	returns true, it will be called on every further click by the user and is
485	supposed to enlarge the selection more and more, if possible.	213	supposed to enlarge the selection more and more, if possible.
486		214
487	See the F<selection> example extension.	215	See the F<selection> example extension.
488		216
489	=item on_view_change $term, $offset	217	=item on_view_change $term, $offset
490		218
491	Called whenever the view offset changes, i..e the user or program	219	Called whenever the view offset changes, i.e. the user or program
492	scrolls. Offset C<0> means display the normal terminal, positive values	220	scrolls. Offset C<0> means display the normal terminal, positive values
493	show this many lines of scrollback.	221	show this many lines of scrollback.
494		222
495	=item on_scroll_back $term, $lines, $saved	223	=item on_scroll_back $term, $lines, $saved
496		224
…		…
500		228
501	It is called before lines are scrolled out (so rows 0 .. min ($lines - 1,	229	It is called before lines are scrolled out (so rows 0 .. min ($lines - 1,
502	$nrow - 1) represent the lines to be scrolled out). C<$saved> is the total	230	$nrow - 1) represent the lines to be scrolled out). C<$saved> is the total
503	number of lines that will be in the scrollback buffer.	231	number of lines that will be in the scrollback buffer.
504		232
505	=item on_osc_seq $term, $op, $args	233	=item on_osc_seq $term, $op, $args, $resp
506		234
507	Called on every OSC sequence and can be used to suppress it or modify its	235	Called on every OSC sequence and can be used to suppress it or modify its
508	behaviour. The default should be to return an empty list. A true value	236	behaviour. The default should be to return an empty list. A true value
509	suppresses execution of the request completely. Make sure you don't get	237	suppresses execution of the request completely. Make sure you don't get
510	confused by recursive invocations when you output an osc sequence within	238	confused by recursive invocations when you output an OSC sequence within
511	this callback.	239	this callback.
512		240
513	C<on_osc_seq_perl> should be used for new behaviour.	241	C<on_osc_seq_perl> should be used for new behaviour.
514		242
515	=item on_osc_seq_perl $term, $string	243	=item on_osc_seq_perl $term, $args, $resp
516		244
517	Called whenever the B<ESC ] 777 ; string ST> command sequence (OSC =	245	Called whenever the B<ESC ] 777 ; string ST> command sequence (OSC =
518	operating system command) is processed. Cursor position and other state	246	operating system command) is processed. Cursor position and other state
519	information is up-to-date when this happens. For interoperability, the	247	information is up-to-date when this happens. For interoperability, the
520	string should start with the extension name and a colon, to distinguish	248	string should start with the extension name (sans -osc) and a semicolon,
521	it from commands for other extensions, and this might be enforced in the	249	to distinguish it from commands for other extensions, and this might be
522	future.	250	enforced in the future.
		251
		252	For example, C<overlay-osc> uses this:
		253
		254	sub on_osc_seq_perl {
		255	my ($self, $osc, $resp) = @_;
		256
		257	return unless $osc =~ s/^overlay;//;
		258
		259	... process remaining $osc string
		260	}
523		261
524	Be careful not ever to trust (in a security sense) the data you receive,	262	Be careful not ever to trust (in a security sense) the data you receive,
525	as its source can not easily be controleld (e-mail content, messages from	263	as its source can not easily be controlled (e-mail content, messages from
526	other users on the same system etc.).	264	other users on the same system etc.).
		265
		266	For responses, C<$resp> contains the end-of-args separator used by the
		267	sender.
527		268
528	=item on_add_lines $term, $string	269	=item on_add_lines $term, $string
529		270
530	Called whenever text is about to be output, with the text as argument. You	271	Called whenever text is about to be output, with the text as argument. You
531	can filter/change and output the text yourself by returning a true value	272	can filter/change and output the text yourself by returning a true value
…		…
536	=item on_tt_write $term, $octets	277	=item on_tt_write $term, $octets
537		278
538	Called whenever some data is written to the tty/pty and can be used to	279	Called whenever some data is written to the tty/pty and can be used to
539	suppress or filter tty input.	280	suppress or filter tty input.
540		281
		282	=item on_tt_paste $term, $octets
		283
		284	Called whenever text is about to be pasted, with the text as argument. You
		285	can filter/change and paste the text yourself by returning a true value
		286	and calling C<< $term->tt_paste >> yourself. C<$octets> is
		287	locale-encoded.
		288
541	=item on_line_update $term, $row	289	=item on_line_update $term, $row
542		290
543	Called whenever a line was updated or changed. Can be used to filter	291	Called whenever a line was updated or changed. Can be used to filter
544	screen output (e.g. underline urls or other useless stuff). Only lines	292	screen output (e.g. underline urls or other useless stuff). Only lines
545	that are being shown will be filtered, and, due to performance reasons,	293	that are being shown will be filtered, and, due to performance reasons,
…		…
552	later with the already-modified line (e.g. if unrelated parts change), so	300	later with the already-modified line (e.g. if unrelated parts change), so
553	you cannot just toggle rendition bits, but only set them.	301	you cannot just toggle rendition bits, but only set them.
554		302
555	=item on_refresh_begin $term	303	=item on_refresh_begin $term
556		304
557	Called just before the screen gets redrawn. Can be used for overlay	305	Called just before the screen gets redrawn. Can be used for overlay or
558	or similar effects by modify terminal contents in refresh_begin, and	306	similar effects by modifying the terminal contents in refresh_begin, and
559	restoring them in refresh_end. The built-in overlay and selection display	307	restoring them in refresh_end. The built-in overlay and selection display
560	code is run after this hook, and takes precedence.	308	code is run after this hook, and takes precedence.
561		309
562	=item on_refresh_end $term	310	=item on_refresh_end $term
563		311
564	Called just after the screen gets redrawn. See C<on_refresh_begin>.	312	Called just after the screen gets redrawn. See C<on_refresh_begin>.
565		313
		314	=item on_action $term, $string
		315
		316	Called whenever an action is invoked for the corresponding extension
		317	(e.g. via a C<extension:string> builtin action bound to a key, see
		318	description of the B<keysym> resource in the urxvt(1) manpage). The
		319	event is simply the action string. Note that an action event is always
		320	associated to a single extension.
		321
566	=item on_user_command $term, $string	322	=item on_user_command $term, $string *DEPRECATED*
567		323
568	Called whenever the a user-configured event is being activated (e.g. via	324	Called whenever a user-configured event is being activated (e.g. via
569	a C<perl:string> action bound to a key, see description of the B<keysym>	325	a C<perl:string> action bound to a key, see description of the B<keysym>
570	resource in the @@RXVT_NAME@@(1) manpage).	326	resource in the urxvt(1) manpage).
571		327
572	The event is simply the action string. This interface is assumed to change	328	The event is simply the action string. This interface is going away in
573	slightly in the future.	329	preference to the C<on_action> hook.
574		330
575	=item on_resize_all_windows $tern, $new_width, $new_height	331	=item on_resize_all_windows $term, $new_width, $new_height
576		332
577	Called just after the new window size has been calculcated, but before	333	Called just after the new window size has been calculated, but before
578	windows are actually being resized or hints are being set. If this hook	334	windows are actually being resized or hints are being set. If this hook
579	returns TRUE, setting of the window hints is being skipped.	335	returns a true value, setting of the window hints is being skipped.
580		336
581	=item on_x_event $term, $event	337	=item on_x_event $term, $event
582		338
583	Called on every X event received on the vt window (and possibly other	339	Called on every X event received on the vt window (and possibly other
584	windows). Should only be used as a last resort. Most event structure	340	windows). Should only be used as a last resort. Most event structure
585	members are not passed.	341	members are not passed.
586		342
		343	=item on_root_event $term, $event
		344
		345	Like C<on_x_event>, but is called for events on the root window.
		346
587	=item on_focus_in $term	347	=item on_focus_in $term
588		348
589	Called whenever the window gets the keyboard focus, before rxvt-unicode	349	Called whenever the window gets the keyboard focus, before rxvt-unicode
590	does focus in processing.	350	does focus in processing.
591		351
592	=item on_focus_out $term	352	=item on_focus_out $term
593		353
594	Called wheneever the window loses keyboard focus, before rxvt-unicode does	354	Called whenever the window loses keyboard focus, before rxvt-unicode does
595	focus out processing.	355	focus out processing.
596		356
597	=item on_configure_notify $term, $event	357	=item on_configure_notify $term, $event
598		358
599	=item on_property_notify $term, $event	359	=item on_property_notify $term, $event
…		…
610		370
611	=item on_map_notify $term, $event	371	=item on_map_notify $term, $event
612		372
613	=item on_unmap_notify $term, $event	373	=item on_unmap_notify $term, $event
614		374
615	Called whenever the corresponding X event is received for the terminal If	375	Called whenever the corresponding X event is received for the terminal. If
616	the hook returns true, then the even will be ignored by rxvt-unicode.	376	the hook returns true, then the event will be ignored by rxvt-unicode.
617		377
618	The event is a hash with most values as named by Xlib (see the XEvent	378	The event is a hash with most values as named by Xlib (see the XEvent
619	manpage), with the additional members C<row> and C<col>, which are the	379	manpage), with the additional members C<row> and C<col>, which are the
620	(real, not screen-based) row and column under the mouse cursor.	380	(real, not screen-based) row and column under the mouse cursor.
621		381
622	C<on_key_press> additionally receives the string rxvt-unicode would	382	C<on_key_press> additionally receives the string rxvt-unicode would
623	output, if any, in locale-specific encoding.	383	output, if any, in locale-specific encoding.
624		384
625	subwindow.
626
627	=item on_client_message $term, $event	385	=item on_client_message $term, $event
628		386
629	=item on_wm_protocols $term, $event	387	=item on_wm_protocols $term, $event
630		388
631	=item on_wm_delete_window $term, $event	389	=item on_wm_delete_window $term, $event
632		390
633	Called when various types of ClientMessage events are received (all with	391	Called when various types of ClientMessage events are received (all with
634	format=32, WM_PROTOCOLS or WM_PROTOCOLS:WM_DELETE_WINDOW).	392	format=32, WM_PROTOCOLS or WM_PROTOCOLS:WM_DELETE_WINDOW).
635		393
		394	=item on_bell $term
		395
		396	Called on receipt of a bell character.
		397
636	=back	398	=back
637		399
638	=cut	400	=cut
639		401
640	package urxvt;	402	package urxvt;
641		403
642	use utf8;	404	use utf8;
643	use strict;	405	use strict 'vars';
644	use Carp ();	406	use Carp ();
645	use Scalar::Util ();	407	use Scalar::Util ();
646	use List::Util ();	408	use List::Util ();
647		409
648	our $VERSION = 1;	410	our $VERSION = 1;
649	our $TERM;	411	our $TERM;
650	our @TERM_INIT;	412	our @TERM_INIT; # should go, prevents async I/O etc.
651	our @TERM_EXT;	413	our @TERM_EXT; # should go, prevents async I/O etc.
652	our @HOOKNAME;	414	our @HOOKNAME;
653	our %HOOKTYPE = map +($HOOKNAME[$_] => $_), 0..$#HOOKNAME;	415	our %HOOKTYPE = map +($HOOKNAME[$_] => $_), 0..$#HOOKNAME;
654	our %OPTION;	416	our %OPTION;
655		417
656	our $LIBDIR;	418	our $LIBDIR;
…		…
682	The current terminal. This variable stores the current C<urxvt::term>	444	The current terminal. This variable stores the current C<urxvt::term>
683	object, whenever a callback/hook is executing.	445	object, whenever a callback/hook is executing.
684		446
685	=item @urxvt::TERM_INIT	447	=item @urxvt::TERM_INIT
686		448
687	All coderefs in this array will be called as methods of the next newly	449	All code references in this array will be called as methods of the next newly
688	created C<urxvt::term> object (during the C<on_init> phase). The array	450	created C<urxvt::term> object (during the C<on_init> phase). The array
689	gets cleared before the codereferences that were in it are being executed,	451	gets cleared before the code references that were in it are being executed,
690	so coderefs can push themselves onto it again if they so desire.	452	so references can push themselves onto it again if they so desire.
691		453
692	This complements to the perl-eval commandline option, but gets executed	454	This complements to the perl-eval command line option, but gets executed
693	first.	455	first.
694		456
695	=item @urxvt::TERM_EXT	457	=item @urxvt::TERM_EXT
696		458
697	Works similar to C<@TERM_INIT>, but contains perl package/class names, which	459	Works similar to C<@TERM_INIT>, but contains perl package/class names, which
…		…
704		466
705	=over 4	467	=over 4
706		468
707	=item urxvt::fatal $errormessage	469	=item urxvt::fatal $errormessage
708		470
709	Fatally aborts execution with the given error message. Avoid at all	471	Fatally aborts execution with the given error message (which should
710	costs! The only time this is acceptable is when the terminal process	472	include a trailing newline). Avoid at all costs! The only time this
711	starts up.	473	is acceptable (and useful) is in the init hook, where it prevents the
		474	terminal from starting up.
712		475
713	=item urxvt::warn $string	476	=item urxvt::warn $string
714		477
715	Calls C<rxvt_warn> with the given string which should not include a	478	Calls C<rxvt_warn> with the given string which should include a trailing
716	newline. The module also overwrites the C<warn> builtin with a function	479	newline. The module also overwrites the C<warn> builtin with a function
717	that calls this function.	480	that calls this function.
718		481
719	Using this function has the advantage that its output ends up in the	482	Using this function has the advantage that its output ends up in the
720	correct place, e.g. on stderr of the connecting urxvtc client.	483	correct place, e.g. on stderr of the connecting urxvtc client.
…		…
722	Messages have a size limit of 1023 bytes currently.	485	Messages have a size limit of 1023 bytes currently.
723		486
724	=item @terms = urxvt::termlist	487	=item @terms = urxvt::termlist
725		488
726	Returns all urxvt::term objects that exist in this process, regardless of	489	Returns all urxvt::term objects that exist in this process, regardless of
727	wether they are started, being destroyed etc., so be careful. Only term	490	whether they are started, being destroyed etc., so be careful. Only term
728	objects that have perl extensions attached will be returned (because there	491	objects that have perl extensions attached will be returned (because there
729	is no urxvt::term objet associated with others).	492	is no urxvt::term object associated with others).
730		493
731	=item $time = urxvt::NOW	494	=item $time = urxvt::NOW
732		495
733	Returns the "current time" (as per the event loop).	496	Returns the "current time" (as per the event loop).
734		497
…		…
754	CirculateRequest, PropertyNotify, SelectionClear, SelectionRequest,	517	CirculateRequest, PropertyNotify, SelectionClear, SelectionRequest,
755	SelectionNotify, ColormapNotify, ClientMessage, MappingNotify	518	SelectionNotify, ColormapNotify, ClientMessage, MappingNotify
756		519
757	Various constants for use in X calls and event processing.	520	Various constants for use in X calls and event processing.
758		521
		522	=item urxvt::PrivMode_132, PrivMode_132OK, PrivMode_rVideo, PrivMode_relOrigin,
		523	PrivMode_Screen, PrivMode_Autowrap, PrivMode_aplCUR, PrivMode_aplKP,
		524	PrivMode_HaveBackSpace, PrivMode_BackSpace, PrivMode_ShiftKeys,
		525	PrivMode_VisibleCursor, PrivMode_MouseX10, PrivMode_MouseX11,
		526	PrivMode_scrollBar, PrivMode_TtyOutputInh, PrivMode_Keypress,
		527	PrivMode_smoothScroll, PrivMode_vt52, PrivMode_LFNL, PrivMode_MouseBtnEvent,
		528	PrivMode_MouseAnyEvent, PrivMode_BracketPaste, PrivMode_ExtMouseUTF8,
		529	PrivMode_ExtMouseUrxvt, PrivMode_BlinkingCursor, PrivMode_mouse_report,
		530	PrivMode_Default
		531
		532	Constants for checking DEC private modes.
		533
759	=back	534	=back
760		535
761	=head2 RENDITION	536	=head2 RENDITION
762		537
763	Rendition bitsets contain information about colour, font, font styles and	538	Rendition bitsets contain information about colour, font, font styles and
…		…
777		552
778	=item $rend = urxvt::OVERLAY_RSTYLE	553	=item $rend = urxvt::OVERLAY_RSTYLE
779		554
780	Return the rendition mask used for overlays by default.	555	Return the rendition mask used for overlays by default.
781		556
782	=item $rendbit = urxvt::RS_Bold, RS_Italic, RS_Blink, RS_RVid, RS_Uline	557	=item $rendbit = urxvt::RS_Bold, urxvt::RS_Italic, urxvt::RS_Blink,
		558	urxvt::RS_RVid, urxvt::RS_Uline
783		559
784	Return the bit that enabled bold, italic, blink, reverse-video and	560	Return the bit that enabled bold, italic, blink, reverse-video and
785	underline, respectively. To enable such a style, just logically OR it into	561	underline, respectively. To enable such a style, just logically OR it into
786	the bitset.	562	the bitset.
787		563
…		…
824	};	600	};
825	}	601	}
826		602
827	no warnings 'utf8';	603	no warnings 'utf8';
828		604
		605	sub parse_resource {
		606	my ($term, $name, $isarg, $longopt, $flag, $value) = @_;
		607
		608	$term->scan_extensions;
		609
		610	# iterating over all resources has quadratic time overhead
		611	# overall, maybe this could be optimised?
		612	my $r = $term->{meta}{resource};
		613	keys %$r; # reset iterator
		614	while (my ($k, $v) = each %$r) {
		615	my $pattern = $k;
		616	$pattern =~ y/./-/ if $isarg;
		617	my $prefix = $name;
		618	my $suffix;
		619	if ($pattern =~ /\-$/) {
		620	$prefix = substr $name, 0, length $pattern;
		621	$suffix = substr $name, length $pattern;
		622	}
		623	if ($pattern eq $prefix) {
		624	$name = "$urxvt::RESCLASS.$k$suffix";
		625
		626	push @{ $term->{perl_ext_3} }, $v->[0];
		627
		628	return 1 unless $isarg;
		629
		630	if ($v->[1] eq "boolean") {
		631	$term->put_option_db ($name, $flag ? "true" : "false");
		632	return 1;
		633	} else {
		634	$term->put_option_db ($name, $value);
		635	return 1 + 2;
		636	}
		637	}
		638	}
		639
		640	0
		641	}
		642
		643	sub usage {
		644	my ($term, $usage_type) = @_;
		645
		646	$term->scan_extensions;
		647
		648	my $r = $term->{meta}{resource};
		649
		650	for my $pattern (sort keys %$r) {
		651	my ($ext, $type, $desc) = @{ $r->{$pattern} };
		652
		653	$desc .= " (-pe $ext)";
		654
		655	if ($usage_type == 1) {
		656	$pattern =~ y/./-/;
		657	$pattern =~ s/-$/-.../g;
		658
		659	if ($type eq "boolean") {
		660	urxvt::log sprintf " -%-30s %s\n", "/+$pattern", $desc;
		661	} else {
		662	urxvt::log sprintf " -%-30s %s\n", "$pattern $type", $desc;
		663	}
		664	} else {
		665	$pattern =~ s/\.$/.*/g;
		666	urxvt::log sprintf " %-31s %s\n", "$pattern:", $type;
		667	}
		668	}
		669	}
		670
829	my $verbosity = $ENV{URXVT_PERL_VERBOSITY};	671	my $verbosity = $ENV{URXVT_PERL_VERBOSITY};
830		672
831	sub verbose {	673	sub verbose {
832	my ($level, $msg) = @_;	674	my ($level, $msg) = @_;
833	warn "$msg\n" if $level <= $verbosity;	675	warn "$msg\n" if $level <= $verbosity;
…		…
845	$pkg =~ s/[^[:word:]]/_/g;	687	$pkg =~ s/[^[:word:]]/_/g;
846	$pkg = "urxvt::ext::$pkg";	688	$pkg = "urxvt::ext::$pkg";
847		689
848	verbose 3, "loading extension '$path' into package '$pkg'";	690	verbose 3, "loading extension '$path' into package '$pkg'";
849		691
		692	(${"$pkg\::_NAME"} = $path) =~ s/^.*[\\\/]//; # hackish
		693
850	open my $fh, "<:raw", $path	694	open my $fh, "<:raw", $path
851	or die "$path: $!";	695	or die "$path: $!";
852		696
853	my $source =	697	my $source =
854	"package $pkg; use strict; use utf8; no warnings 'utf8';\n"	698	"package $pkg; use strict 'vars'; use utf8; no warnings 'utf8';\n"
855	. "#line 1 \"$path\"\n{\n"	699	. "#line 1 \"$path\"\n{\n"
856	. (do { local $/; <$fh> })	700	. (do { local $/; <$fh> })
857	. "\n};\n1";	701	. "\n};\n1";
858		702
859	eval $source	703	eval $source
…		…
868	# called by the rxvt core	712	# called by the rxvt core
869	sub invoke {	713	sub invoke {
870	local $TERM = shift;	714	local $TERM = shift;
871	my $htype = shift;	715	my $htype = shift;
872		716
873	if ($htype == 0) { # INIT	717	if ($htype == HOOK_INIT) {
874	my @dirs = ((split /:/, $TERM->resource ("perl_lib")), "$LIBDIR/perl");	718	my @dirs = $TERM->perl_libdirs;
875		719
		720	$TERM->scan_extensions;
		721
876	my %ext_arg;	722	my %ext_arg;
877		723
878	{	724	{
879	my @init = @TERM_INIT;	725	my @init = @TERM_INIT;
880	@TERM_INIT = ();	726	@TERM_INIT = ();
…		…
882	my @pkg = @TERM_EXT;	728	my @pkg = @TERM_EXT;
883	@TERM_EXT = ();	729	@TERM_EXT = ();
884	$TERM->register_package ($_) for @pkg;	730	$TERM->register_package ($_) for @pkg;
885	}	731	}
886		732
		733	for (
		734	@{ delete $TERM->{perl_ext_3} },
887	for (grep $_, map { split /,/, $TERM->resource ("perl_ext_$_") } 1, 2) {	735	(grep $_, map { split /,/, $TERM->resource ("perl_ext_$_") } 1, 2),
		736	) {
888	if ($_ eq "default") {	737	if ($_ eq "default") {
		738
		739	$ext_arg{$_} = []
889	$ext_arg{$_} ||= [] for qw(selection option-popup selection-popup searchable-scrollback readline);	740	for qw(selection option-popup selection-popup readline searchable-scrollback confirm-paste);
		741
		742	for ($TERM->_keysym_resources) {
		743	next if /^(?:string|command|builtin|builtin-string|perl)/;
		744	next unless /^([A-Za-z0-9_\-]+):/;
		745
		746	my $ext = $1;
		747
		748	$ext_arg{$ext} = [];
		749	}
		750
890	} elsif (/^-(.*)$/) {	751	} elsif (/^-(.*)$/) {
891	delete $ext_arg{$1};	752	delete $ext_arg{$1};
		753
892	} elsif (/^([^<]+)<(.*)>$/) {	754	} elsif (/^([^<]+)<(.*)>$/) {
893	push @{ $ext_arg{$1} }, $2;	755	push @{ $ext_arg{$1} }, $2;
		756
894	} else {	757	} else {
895	$ext_arg{$_} ||= [];	758	$ext_arg{$_} ||= [];
896	}	759	}
897	}	760	}
898		761
…		…
914		777
915	if (my $cb = $TERM->{_hook}[$htype]) {	778	if (my $cb = $TERM->{_hook}[$htype]) {
916	verbose 10, "$HOOKNAME[$htype] (" . (join ", ", $TERM, @_) . ")"	779	verbose 10, "$HOOKNAME[$htype] (" . (join ", ", $TERM, @_) . ")"
917	if $verbosity >= 10;	780	if $verbosity >= 10;
918		781
		782	if ($htype == HOOK_ACTION) {
		783	# this hook is only sent to the extension with the name
		784	# matching the first arg
		785	my $pkg = shift;
		786	$pkg =~ y/-/_/;
		787	$pkg = "urxvt::ext::$pkg";
		788
		789	$cb = $cb->{$pkg}
		790	or return undef; #TODO: maybe warn user?
		791
		792	$cb = { $pkg => $cb };
		793	}
		794
919	for my $pkg (keys %$cb) {	795	for my $pkg (keys %$cb) {
920	my $retval_ = eval { $cb->{$pkg}->($TERM->{_pkg}{$pkg}, @_) };	796	my $retval_ = eval { $cb->{$pkg}->($TERM->{_pkg}{$pkg} || $TERM, @_) };
921	$retval ||= $retval_;	797	$retval ||= $retval_;
922		798
923	if ($@) {	799	if ($@) {
924	$TERM->ungrab; # better to lose the grab than the session	800	$TERM->ungrab; # better to lose the grab than the session
925	warn $@;	801	warn $@;
…		…
928		804
929	verbose 11, "$HOOKNAME[$htype] returning <$retval>"	805	verbose 11, "$HOOKNAME[$htype] returning <$retval>"
930	if $verbosity >= 11;	806	if $verbosity >= 11;
931	}	807	}
932		808
933	if ($htype == 1) { # DESTROY	809	if ($htype == HOOK_DESTROY) {
934	# clear package objects	810	# clear package objects
935	%$_ = () for values %{ $TERM->{_pkg} };	811	%$_ = () for values %{ $TERM->{_pkg} };
936		812
937	# clear package	813	# clear package
938	%$TERM = ();	814	%$TERM = ();
…		…
943		819
944	sub SET_COLOR($$$) {	820	sub SET_COLOR($$$) {
945	SET_BGCOLOR (SET_FGCOLOR ($_[0], $_[1]), $_[2])	821	SET_BGCOLOR (SET_FGCOLOR ($_[0], $_[1]), $_[2])
946	}	822	}
947		823
948	# urxvt::term::extension	824	sub rend2mask {
		825	no strict 'refs';
		826	my ($str, $mask) = (@_, 0);
		827	my %color = ( fg => undef, bg => undef );
		828	my @failed;
		829	for my $spec ( split /\s+/, $str ) {
		830	if ( $spec =~ /^([fb]g)[_:-]?(\d+)/i ) {
		831	$color{lc($1)} = $2;
		832	} else {
		833	my $neg = $spec =~ s/^[-^]//;
		834	unless ( exists &{"RS_$spec"} ) {
		835	push @failed, $spec;
		836	next;
		837	}
		838	my $cur = &{"RS_$spec"};
		839	if ( $neg ) {
		840	$mask &= ~$cur;
		841	} else {
		842	$mask |= $cur;
		843	}
		844	}
		845	}
		846	($mask, @color{qw(fg bg)}, \@failed)
		847	}
949		848
950	package urxvt::term::extension;	849	package urxvt::term::extension;
951		850
952	sub enable {	851	=head2 The C<urxvt::term::extension> class
953	my ($self, %hook) = @_;
954	my $pkg = $self->{_pkg};
955		852
956	while (my ($name, $cb) = each %hook) {	853	Each extension attached to a terminal object is represented by
957	my $htype = $HOOKTYPE{uc $name};	854	a C<urxvt::term::extension> object.
958	defined $htype
959	or Carp::croak "unsupported hook type '$name'";
960		855
961	$self->set_should_invoke ($htype, +1)	856	You can use these objects, which are passed to all callbacks to store any
962	unless exists $self->{term}{_hook}[$htype]{$pkg};	857	state related to the terminal and extension instance.
963		858
964	$self->{term}{_hook}[$htype]{$pkg} = $cb;	859	The methods (And data members) documented below can be called on extension
965	}	860	objects, in addition to call methods documented for the <urxvt::term>
966	}	861	class.
967		862
968	sub disable {	863	=over 4
969	my ($self, @hook) = @_;
970	my $pkg = $self->{_pkg};
971		864
972	for my $name (@hook) {	865	=item $urxvt_term = $self->{term}
973	my $htype = $HOOKTYPE{uc $name};
974	defined $htype
975	or Carp::croak "unsupported hook type '$name'";
976		866
977	$self->set_should_invoke ($htype, -1)	867	Returns the C<urxvt::term> object associated with this instance of the
978	if delete $self->{term}{_hook}[$htype]{$pkg};	868	extension. This member I<must not> be changed in any way.
979	}	869
980	}	870	=cut
981		871
982	our $AUTOLOAD;	872	our $AUTOLOAD;
983		873
984	sub AUTOLOAD {	874	sub AUTOLOAD {
985	$AUTOLOAD =~ /:([^:]+)$/	875	$AUTOLOAD =~ /:([^:]+)$/
…		…
998		888
999	sub DESTROY {	889	sub DESTROY {
1000	# nop	890	# nop
1001	}	891	}
1002		892
1003	# urxvt::destroy_hook	893	# urxvt::destroy_hook (basically a cheap Guard:: implementation)
1004		894
1005	sub urxvt::destroy_hook::DESTROY {	895	sub urxvt::destroy_hook::DESTROY {
1006	${$_[0]}->();	896	${$_[0]}->();
1007	}	897	}
1008		898
1009	sub urxvt::destroy_hook(&) {	899	sub urxvt::destroy_hook(&) {
1010	bless \shift, urxvt::destroy_hook::	900	bless \shift, urxvt::destroy_hook::
1011	}	901	}
		902
		903	=item $self->enable ($hook_name => $cb[, $hook_name => $cb..])
		904
		905	Dynamically enable the given hooks (named without the C<on_> prefix) for
		906	this extension, replacing any hook previously installed via C<enable> in
		907	this extension.
		908
		909	This is useful when you want to overwrite time-critical hooks only
		910	temporarily.
		911
		912	To install additional callbacks for the same hook, you can use the C<on>
		913	method of the C<urxvt::term> class.
		914
		915	=item $self->disable ($hook_name[, $hook_name..])
		916
		917	Dynamically disable the given hooks.
		918
		919	=cut
		920
		921	sub enable {
		922	my ($self, %hook) = @_;
		923	my $pkg = $self->{_pkg};
		924
		925	while (my ($name, $cb) = each %hook) {
		926	my $htype = $HOOKTYPE{uc $name};
		927	defined $htype
		928	or Carp::croak "unsupported hook type '$name'";
		929
		930	$self->set_should_invoke ($htype, +1)
		931	unless exists $self->{term}{_hook}[$htype]{$pkg};
		932
		933	$self->{term}{_hook}[$htype]{$pkg} = $cb;
		934	}
		935	}
		936
		937	sub disable {
		938	my ($self, @hook) = @_;
		939	my $pkg = $self->{_pkg};
		940
		941	for my $name (@hook) {
		942	my $htype = $HOOKTYPE{uc $name};
		943	defined $htype
		944	or Carp::croak "unsupported hook type '$name'";
		945
		946	$self->set_should_invoke ($htype, -1)
		947	if delete $self->{term}{_hook}[$htype]{$pkg};
		948	}
		949	}
		950
		951	=item $guard = $self->on ($hook_name => $cb[, $hook_name => $cb..])
		952
		953	Similar to the C<enable> enable, but installs additional callbacks for
		954	the given hook(s) (that is, it doesn't replace existing callbacks), and
		955	returns a guard object. When the guard object is destroyed the callbacks
		956	are disabled again.
		957
		958	=cut
		959
		960	sub urxvt::extension::on_disable::DESTROY {
		961	my $disable = shift;
		962
		963	my $term = delete $disable->{""};
		964
		965	while (my ($htype, $id) = each %$disable) {
		966	delete $term->{_hook}[$htype]{$id};
		967	$term->set_should_invoke ($htype, -1);
		968	}
		969	}
		970
		971	sub on {
		972	my ($self, %hook) = @_;
		973
		974	my $term = $self->{term};
		975
		976	my %disable = ( "" => $term );
		977
		978	while (my ($name, $cb) = each %hook) {
		979	my $htype = $HOOKTYPE{uc $name};
		980	defined $htype
		981	or Carp::croak "unsupported hook type '$name'";
		982
		983	$term->set_should_invoke ($htype, +1);
		984	$term->{_hook}[$htype]{ $disable{$htype} = $cb+0 }
		985	= sub { shift; $cb->($self, @_) }; # very ugly indeed
		986	}
		987
		988	bless \%disable, "urxvt::extension::on_disable"
		989	}
		990
		991	=item $self->bind_action ($hotkey, $action)
		992
		993	=item $self->x_resource ($pattern)
		994
		995	=item $self->x_resource_boolean ($pattern)
		996
		997	These methods support an additional C<%> prefix for C<$action> or
		998	C<$pattern> when called on an extension object, compared to the
		999	C<urxvt::term> methods of the same name - see the description of these
		1000	methods in the C<urxvt::term> class for details.
		1001
		1002	=cut
		1003
		1004	sub bind_action {
		1005	my ($self, $hotkey, $action) = @_;
		1006	$action =~ s/^%:/$_[0]{_name}:/;
		1007	$self->{term}->bind_action ($hotkey, $action)
		1008	}
		1009
		1010	sub x_resource {
		1011	my ($self, $name) = @_;
		1012	$name =~ s/^%(\.|$)/$_[0]{_name}$1/;
		1013	$self->{term}->x_resource ($name)
		1014	}
		1015
		1016	sub x_resource_boolean {
		1017	my ($self, $name) = @_;
		1018	$name =~ s/^%(\.|$)/$_[0]{_name}$1/;
		1019	$self->{term}->x_resource_boolean ($name)
		1020	}
		1021
		1022	=back
		1023
		1024	=cut
1012		1025
1013	package urxvt::anyevent;	1026	package urxvt::anyevent;
1014		1027
1015	=head2 The C<urxvt::anyevent> Class	1028	=head2 The C<urxvt::anyevent> Class
1016		1029
1017	The sole purpose of this class is to deliver an interface to the	1030	The sole purpose of this class is to deliver an interface to the
1018	C<AnyEvent> module - any module using it will work inside urxvt without	1031	C<AnyEvent> module - any module using it will work inside urxvt without
1019	further programming. The only exception is that you cannot wait on	1032	further programming. The only exception is that you cannot wait on
1020	condition variables, but non-blocking condvar use is ok. What this means	1033	condition variables, but non-blocking condvar use is ok.
1021	is that you cannot use blocking APIs, but the non-blocking variant should
1022	work.
1023		1034
1024	=cut	1035	In practical terms this means is that you cannot use blocking APIs, but
		1036	the non-blocking variant should work.
1025		1037
		1038	=cut
		1039
1026	our $VERSION = 1;	1040	our $VERSION = '5.23';
1027		1041
1028	$INC{"urxvt/anyevent.pm"} = 1; # mark us as there	1042	$INC{"urxvt/anyevent.pm"} = 1; # mark us as there
1029	push @AnyEvent::REGISTRY, [urxvt => urxvt::anyevent::];	1043	push @AnyEvent::REGISTRY, [urxvt => urxvt::anyevent::];
1030		1044
1031	sub timer {	1045	sub timer {
…		…
1033		1047
1034	my $cb = $arg{cb};	1048	my $cb = $arg{cb};
1035		1049
1036	urxvt::timer	1050	urxvt::timer
1037	->new	1051	->new
1038	->start (urxvt::NOW + $arg{after})	1052	->after ($arg{after}, $arg{interval})
1039	->cb (sub {	1053	->cb ($arg{interval} ? $cb : sub {
1040	$_[0]->stop; # need to cancel manually	1054	$_[0]->stop; # need to cancel manually
1041	$cb->();	1055	$cb->();
1042	})	1056	})
1043	}	1057	}
1044		1058
1045	sub io {	1059	sub io {
1046	my ($class, %arg) = @_;	1060	my ($class, %arg) = @_;
1047		1061
1048	my $cb = $arg{cb};	1062	my $cb = $arg{cb};
		1063	my $fd = fileno $arg{fh};
		1064	defined $fd or $fd = $arg{fh};
1049		1065
1050	bless [$arg{fh}, urxvt::iow	1066	bless [$arg{fh}, urxvt::iow
1051	->new	1067	->new
1052	->fd (fileno $arg{fh})	1068	->fd ($fd)
1053	->events (($arg{poll} =~ /r/ ? 1 : 0)	1069	->events (($arg{poll} =~ /r/ ? 1 : 0)
1054	| ($arg{poll} =~ /w/ ? 2 : 0))	1070	| ($arg{poll} =~ /w/ ? 2 : 0))
1055	->start	1071	->start
1056	->cb (sub {	1072	->cb ($cb)
1057	$cb->(($_[1] & 1 ? 'r' : '')
1058	. ($_[1] & 2 ? 'w' : ''));
1059	})],
1060	urxvt::anyevent::	1073	], urxvt::anyevent::
		1074	}
		1075
		1076	sub idle {
		1077	my ($class, %arg) = @_;
		1078
		1079	my $cb = $arg{cb};
		1080
		1081	urxvt::iw
		1082	->new
		1083	->start
		1084	->cb ($cb)
		1085	}
		1086
		1087	sub child {
		1088	my ($class, %arg) = @_;
		1089
		1090	my $cb = $arg{cb};
		1091
		1092	urxvt::pw
		1093	->new
		1094	->start ($arg{pid})
		1095	->cb (sub {
		1096	$_[0]->stop; # need to cancel manually
		1097	$cb->($_[0]->rpid, $_[0]->rstatus);
		1098	})
1061	}	1099	}
1062		1100
1063	sub DESTROY {	1101	sub DESTROY {
1064	$_[0][1]->stop;	1102	$_[0][1]->stop;
1065	}	1103	}
1066		1104
1067	sub condvar {	1105	# only needed for AnyEvent < 6 compatibility
1068	bless \my $flag, urxvt::anyevent::condvar::	1106	sub one_event {
1069	}
1070
1071	sub urxvt::anyevent::condvar::broadcast {
1072	${$_[0]}++;
1073	}
1074
1075	sub urxvt::anyevent::condvar::wait {
1076	unless (${$_[0]}) {
1077	Carp::croak "AnyEvent->condvar blocking wait unsupported in urxvt, use a non-blocking API";	1107	Carp::croak "AnyEvent->one_event blocking wait unsupported in urxvt, use a non-blocking API";
1078	}
1079	}	1108	}
1080		1109
1081	package urxvt::term;	1110	package urxvt::term;
1082		1111
1083	=head2 The C<urxvt::term> Class	1112	=head2 The C<urxvt::term> Class
…		…
1096	urxvt::verbose 6, "register package $pkg to $self";	1125	urxvt::verbose 6, "register package $pkg to $self";
1097		1126
1098	@{"$pkg\::ISA"} = urxvt::term::extension::;	1127	@{"$pkg\::ISA"} = urxvt::term::extension::;
1099		1128
1100	my $proxy = bless {	1129	my $proxy = bless {
1101	_pkg => $pkg,	1130	_pkg => $pkg,
		1131	_name => ${"$pkg\::_NAME"}, # hackish
1102	argv => $argv,	1132	argv => $argv,
1103	}, $pkg;	1133	}, $pkg;
1104	Scalar::Util::weaken ($proxy->{term} = $self);	1134	Scalar::Util::weaken ($proxy->{term} = $self);
1105		1135
1106	$self->{_pkg}{$pkg} = $proxy;	1136	$self->{_pkg}{$pkg} = $proxy;
1107		1137
…		…
1110	$proxy->enable ($name => $ref);	1140	$proxy->enable ($name => $ref);
1111	}	1141	}
1112	}	1142	}
1113	}	1143	}
1114		1144
		1145	sub perl_libdirs {
		1146	map { split /:/ }
		1147	$_[0]->resource ("perl_lib"),
		1148	$ENV{URXVT_PERL_LIB},
		1149	"$ENV{HOME}/.urxvt/ext",
		1150	"$LIBDIR/perl"
		1151	}
		1152
		1153	# scan for available extensions and collect their metadata
		1154	sub scan_extensions {
		1155	my ($self) = @_;
		1156
		1157	return if exists $self->{meta};
		1158
		1159	my @urxvtdirs = perl_libdirs $self;
		1160	# my @cpandirs = grep -d, map "$_/URxvt/Ext", @INC;
		1161
		1162	$self->{meta} = \my %meta;
		1163
		1164	# first gather extensions
		1165
		1166	my $gather = sub {
		1167	my ($dir, $core) = @_;
		1168
		1169	opendir my $fh, $dir
		1170	or return;
		1171
		1172	for my $ext (readdir $fh) {
		1173	$ext !~ /^\./
		1174	or next;
		1175
		1176	open my $fh, "<", "$dir/$ext"
		1177	or next;
		1178
		1179	-f $fh
		1180	or next;
		1181
		1182	$ext =~ s/\.uext$// or $core
		1183	or next;
		1184
		1185	my %ext = (dir => $dir);
		1186
		1187	while (<$fh>) {
		1188	if (/^#:META:(?:X_)?RESOURCE:(.*)/) {
		1189	my ($pattern, $type, $desc) = split /:/, $1;
		1190	$pattern =~ s/^%(\.|$)/$ext$1/g; # % in pattern == extension name
		1191	if ($pattern =~ /[^a-zA-Z0-9\-\.]/) {
		1192	warn "$dir/$ext: meta resource '$pattern' contains illegal characters (not alphanumeric nor . nor *)\n";
		1193	} else {
		1194	$ext{resource}{$pattern} = [$ext, $type, $desc];
		1195	}
		1196	} elsif (/^\s*(?:#|$)/) {
		1197	# skip other comments and empty lines
		1198	} else {
		1199	last; # stop parsing on first non-empty non-comment line
		1200	}
		1201	}
		1202
		1203	$meta{ext}{$ext} = \%ext;
		1204	}
		1205	};
		1206
		1207	# $gather->($_, 0) for @cpandirs;
		1208	$gather->($_, 1) for @urxvtdirs;
		1209
		1210	# and now merge resources
		1211
		1212	$meta{resource} = \my %resource;
		1213
		1214	while (my ($k, $v) = each %{ $meta{ext} }) {
		1215	#TODO: should check for extensions overriding each other
		1216	%resource = (%resource, %{ $v->{resource} });
		1217	}
		1218	}
		1219
1115	=item $term = new urxvt::term $envhashref, $rxvtname, [arg...]	1220	=item $term = new urxvt::term $envhashref, $rxvtname, [arg...]
1116		1221
1117	Creates a new terminal, very similar as if you had started it with system	1222	Creates a new terminal, very similar as if you had started it with system
1118	C<$rxvtname, arg...>. C<$envhashref> must be a reference to a C<%ENV>-like	1223	C<$rxvtname, arg...>. C<$envhashref> must be a reference to a C<%ENV>-like
1119	hash which defines the environment of the new terminal.	1224	hash which defines the environment of the new terminal.
…		…
1136	}	1241	}
1137		1242
1138	=item $term->destroy	1243	=item $term->destroy
1139		1244
1140	Destroy the terminal object (close the window, free resources	1245	Destroy the terminal object (close the window, free resources
1141	etc.). Please note that @@RXVT_NAME@@ will not exit as long as any event	1246	etc.). Please note that urxvt will not exit as long as any event
1142	watchers (timers, io watchers) are still active.	1247	watchers (timers, io watchers) are still active.
1143		1248
1144	=item $term->exec_async ($cmd[, @args])	1249	=item $term->exec_async ($cmd[, @args])
1145		1250
1146	Works like the combination of the C<fork>/C<exec> builtins, which executes	1251	Works like the combination of the C<fork>/C<exec> builtins, which executes
…		…
1170		1275
1171	Returns true if the option specified by C<$optval> is enabled, and	1276	Returns true if the option specified by C<$optval> is enabled, and
1172	optionally change it. All option values are stored by name in the hash	1277	optionally change it. All option values are stored by name in the hash
1173	C<%urxvt::OPTION>. Options not enabled in this binary are not in the hash.	1278	C<%urxvt::OPTION>. Options not enabled in this binary are not in the hash.
1174		1279
1175	Here is a a likely non-exhaustive list of option names, please see the	1280	Here is a likely non-exhaustive list of option names, please see the
1176	source file F</src/optinc.h> to see the actual list:	1281	source file F</src/optinc.h> to see the actual list:
1177		1282
1178	borderLess console cursorBlink cursorUnderline hold iconic insecure	1283	borderLess buffered console cursorBlink cursorUnderline hold iconic
1179	intensityStyles jumpScroll loginShell mapAlert meta8 mouseWheelScrollPage	1284	insecure intensityStyles iso14755 iso14755_52 jumpScroll loginShell
1180	override-redirect pastableTabs pointerBlank reverseVideo scrollBar	1285	mapAlert meta8 mouseWheelScrollPage override_redirect pastableTabs
1181	scrollBar_floating scrollBar_right scrollTtyKeypress scrollTtyOutput	1286	pointerBlank reverseVideo scrollBar scrollBar_floating scrollBar_right
1182	scrollWithBuffer secondaryScreen secondaryScroll skipBuiltinGlyphs	1287	scrollTtyKeypress scrollTtyOutput scrollWithBuffer secondaryScreen
1183	transparent tripleclickwords utmpInhibit visualBell	1288	secondaryScroll skipBuiltinGlyphs skipScroll transparent tripleclickwords
		1289	urgentOnBell utmpInhibit visualBell
1184		1290
1185	=item $value = $term->resource ($name[, $newval])	1291	=item $value = $term->resource ($name[, $newval])
1186		1292
1187	Returns the current resource value associated with a given name and	1293	Returns the current resource value associated with a given name and
1188	optionally sets a new value. Setting values is most useful in the C<init>	1294	optionally sets a new value. Setting values is most useful in the C<init>
…		…
1197	likely change).	1303	likely change).
1198		1304
1199	Please note that resource strings will currently only be freed when the	1305	Please note that resource strings will currently only be freed when the
1200	terminal is destroyed, so changing options frequently will eat memory.	1306	terminal is destroyed, so changing options frequently will eat memory.
1201		1307
1202	Here is a a likely non-exhaustive list of resource names, not all of which	1308	Here is a likely non-exhaustive list of resource names, not all of which
1203	are supported in every build, please see the source file F</src/rsinc.h>	1309	are supported in every build, please see the source file F</src/rsinc.h>
1204	to see the actual list:	1310	to see the actual list:
1205		1311
1206	answerbackstring backgroundPixmap backspace_key boldFont boldItalicFont	1312	answerbackstring backgroundPixmap backspace_key blurradius
1207	borderLess color cursorBlink cursorUnderline cutchars delete_key	1313	boldFont boldItalicFont borderLess buffered chdir color cursorBlink
1208	display_name embed ext_bwidth fade font geometry hold iconName	1314	cursorUnderline cutchars delete_key depth display_name embed ext_bwidth
1209	imFont imLocale inputMethod insecure int_bwidth intensityStyles	1315	fade font geometry hold iconName iconfile imFont imLocale inputMethod
		1316	insecure int_bwidth intensityStyles iso14755 iso14755_52 italicFont
1210	italicFont jumpScroll lineSpace loginShell mapAlert meta8 modifier	1317	jumpScroll letterSpace lineSpace loginShell mapAlert meta8 modifier
1211	mouseWheelScrollPage name override_redirect pastableTabs path perl_eval	1318	mouseWheelScrollPage name override_redirect pastableTabs path perl_eval
1212	perl_ext_1 perl_ext_2 perl_lib pointerBlank pointerBlankDelay	1319	perl_ext_1 perl_ext_2 perl_lib pointerBlank pointerBlankDelay
1213	preeditType print_pipe pty_fd reverseVideo saveLines scrollBar	1320	preeditType print_pipe pty_fd reverseVideo saveLines scrollBar
1214	scrollBar_align scrollBar_floating scrollBar_right scrollBar_thickness	1321	scrollBar_align scrollBar_floating scrollBar_right scrollBar_thickness
1215	scrollTtyKeypress scrollTtyOutput scrollWithBuffer scrollstyle	1322	scrollTtyKeypress scrollTtyOutput scrollWithBuffer scrollstyle
1216	secondaryScreen secondaryScroll selectstyle shade term_name title	1323	secondaryScreen secondaryScroll shade skipBuiltinGlyphs skipScroll
1217	transient_for transparent transparent_all tripleclickwords utmpInhibit	1324	term_name title transient_for transparent tripleclickwords urgentOnBell
1218	visualBell	1325	utmpInhibit visualBell
1219		1326
1220	=cut	1327	=cut
1221		1328
1222	sub resource($$;$) {	1329	sub resource($$;$) {
1223	my ($self, $name) = (shift, shift);	1330	my ($self, $name) = (shift, shift);
1224	unshift @_, $self, $name, ($name =~ s/\s*\+\s*(\d+)$// ? $1 : 0);	1331	unshift @_, $self, $name, ($name =~ s/\s*\+\s*(\d+)$// ? $1 : 0);
1225	&urxvt::term::_resource	1332	goto &urxvt::term::_resource
1226	}	1333	}
1227		1334
1228	=item $value = $term->x_resource ($pattern)	1335	=item $value = $term->x_resource ($pattern)
1229		1336
1230	Returns the X-Resource for the given pattern, excluding the program or	1337	Returns the X-Resource for the given pattern, excluding the program or
1231	class name, i.e. C<< $term->x_resource ("boldFont") >> should return the	1338	class name, i.e. C<< $term->x_resource ("boldFont") >> should return the
1232	same value as used by this instance of rxvt-unicode. Returns C<undef> if no	1339	same value as used by this instance of rxvt-unicode. Returns C<undef> if no
1233	resource with that pattern exists.	1340	resource with that pattern exists.
1234		1341
		1342	Extensions that define extra resources also need to call this method
		1343	to access their values.
		1344
		1345	If the method is called on an extension object (basically, from an
		1346	extension), then the special prefix C<%.> will be replaced by the name of
		1347	the extension and a dot, and the lone string C<%> will be replaced by the
		1348	extension name itself. This makes it possible to code extensions so you
		1349	can rename them and get a new set of resources without having to change
		1350	the actual code.
		1351
1235	This method should only be called during the C<on_start> hook, as there is	1352	This method should only be called during the C<on_start> hook, as there is
1236	only one resource database per display, and later invocations might return	1353	only one resource database per display, and later invocations might return
1237	the wrong resources.	1354	the wrong resources.
1238		1355
1239	=item $success = $term->parse_keysym ($keysym_spec, $command_string)	1356	=item $value = $term->x_resource_boolean ($pattern)
1240		1357
		1358	Like C<x_resource>, above, but interprets the string value as a boolean
		1359	and returns C<1> for true values, C<0> for false values and C<undef> if
		1360	the resource or option isn't specified.
		1361
		1362	You should always use this method to parse boolean resources.
		1363
		1364	=cut
		1365
		1366	sub x_resource_boolean {
		1367	my $res = &x_resource;
		1368
		1369	$res =~ /^\s*(?:true|yes|on|1)\s*$/i ? 1 : defined $res && 0
		1370	}
		1371
		1372	=item $action = $term->lookup_keysym ($keysym, $state)
		1373
		1374	Returns the action bound to key combination C<($keysym, $state)>,
		1375	if a binding for it exists, and C<undef> otherwise.
		1376
		1377	=item $success = $term->bind_action ($key, $action)
		1378
1241	Adds a keymap translation exactly as specified via a resource. See the	1379	Adds a key binding exactly as specified via a C<keysym> resource. See the
1242	C<keysym> resource in the @@RXVT_NAME@@(1) manpage.	1380	C<keysym> resource in the urxvt(1) manpage.
		1381
		1382	To add default bindings for actions, an extension should call C<<
		1383	->bind_action >> in its C<init> hook for every such binding. Doing it
		1384	in the C<init> hook allows users to override or remove the binding
		1385	again.
		1386
		1387	Example: the C<searchable-scrollback> by default binds itself
		1388	on C<Meta-s>, using C<< $self->bind_action >>, which calls C<<
		1389	$term->bind_action >>.
		1390
		1391	sub init {
		1392	my ($self) = @_;
		1393
		1394	$self->bind_action ("M-s" => "%:start");
		1395	}
1243		1396
1244	=item $rend = $term->rstyle ([$new_rstyle])	1397	=item $rend = $term->rstyle ([$new_rstyle])
1245		1398
1246	Return and optionally change the current rendition. Text that is output by	1399	Return and optionally change the current rendition. Text that is output by
1247	the terminal application will use this style.	1400	the terminal application will use this style.
…		…
1255		1408
1256	=item ($row, $col) = $term->selection_beg ([$row, $col])	1409	=item ($row, $col) = $term->selection_beg ([$row, $col])
1257		1410
1258	=item ($row, $col) = $term->selection_end ([$row, $col])	1411	=item ($row, $col) = $term->selection_end ([$row, $col])
1259		1412
1260	Return the current values of the selection mark, begin or end positions,	1413	Return the current values of the selection mark, begin or end positions.
1261	and optionally set them to new values.	1414
		1415	When arguments are given, then the selection coordinates are set to
		1416	C<$row> and C<$col>, and the selection screen is set to the current
		1417	screen.
		1418
		1419	=item $screen = $term->selection_screen ([$screen])
		1420
		1421	Returns the current selection screen, and then optionally sets it.
1262		1422
1263	=item $term->selection_make ($eventtime[, $rectangular])	1423	=item $term->selection_make ($eventtime[, $rectangular])
1264		1424
1265	Tries to make a selection as set by C<selection_beg> and	1425	Tries to make a selection as set by C<selection_beg> and
1266	C<selection_end>. If C<$rectangular> is true (default: false), a	1426	C<selection_end>. If C<$rectangular> is true (default: false), a
1267	rectangular selection will be made. This is the prefered function to make	1427	rectangular selection will be made. This is the preferred function to make
1268	a selection.	1428	a selection.
1269		1429
1270	=item $success = $term->selection_grab ($eventtime)	1430	=item $success = $term->selection_grab ($eventtime[, $clipboard])
1271		1431
1272	Try to request the primary selection text from the server (for example, as	1432	Try to acquire ownership of the primary (clipboard if C<$clipboard> is
		1433	true) selection from the server. The corresponding text can be set
1273	set by the next method). No visual feedback will be given. This function	1434	with the next method. No visual feedback will be given. This function
1274	is mostly useful from within C<on_sel_grab> hooks.	1435	is mostly useful from within C<on_sel_grab> hooks.
1275		1436
1276	=item $oldtext = $term->selection ([$newtext])	1437	=item $oldtext = $term->selection ([$newtext, $clipboard])
1277		1438
1278	Return the current selection text and optionally replace it by C<$newtext>.	1439	Return the current selection (clipboard if C<$clipboard> is true) text
		1440	and optionally replace it by C<$newtext>.
		1441
		1442	=item $term->selection_clear ([$clipboard])
		1443
		1444	Revoke ownership of the primary (clipboard if C<$clipboard> is true) selection.
1279		1445
1280	=item $term->overlay_simple ($x, $y, $text)	1446	=item $term->overlay_simple ($x, $y, $text)
1281		1447
1282	Create a simple multi-line overlay box. See the next method for details.	1448	Create a simple multi-line overlay box. See the next method for details.
1283		1449
…		…
1313		1479
1314	The methods currently supported on C<urxvt::overlay> objects are:	1480	The methods currently supported on C<urxvt::overlay> objects are:
1315		1481
1316	=over 4	1482	=over 4
1317		1483
1318	=item $overlay->set ($x, $y, $text, $rend)	1484	=item $overlay->set ($x, $y, $text[, $rend])
1319		1485
1320	Similar to C<< $term->ROW_t >> and C<< $term->ROW_r >> in that it puts	1486	Similar to C<< $term->ROW_t >> and C<< $term->ROW_r >> in that it puts
1321	text in rxvt-unicode's special encoding and an array of rendition values	1487	text in rxvt-unicode's special encoding and an array of rendition values
1322	at a specific position inside the overlay.	1488	at a specific position inside the overlay.
		1489
		1490	If C<$rend> is missing, then the rendition will not be changed.
1323		1491
1324	=item $overlay->hide	1492	=item $overlay->hide
1325		1493
1326	If visible, hide the overlay, but do not destroy it.	1494	If visible, hide the overlay, but do not destroy it.
1327		1495
…		…
1390		1558
1391	=item $term->scr_add_lines ($string)	1559	=item $term->scr_add_lines ($string)
1392		1560
1393	Write the given text string to the screen, as if output by the application	1561	Write the given text string to the screen, as if output by the application
1394	running inside the terminal. It may not contain command sequences (escape	1562	running inside the terminal. It may not contain command sequences (escape
1395	codes), but is free to use line feeds, carriage returns and tabs. The	1563	codes - see C<cmd_parse> for that), but is free to use line feeds,
1396	string is a normal text string, not in locale-dependent encoding.	1564	carriage returns and tabs. The string is a normal text string, not in
		1565	locale-dependent encoding.
1397		1566
1398	Normally its not a good idea to use this function, as programs might be	1567	Normally its not a good idea to use this function, as programs might be
1399	confused by changes in cursor position or scrolling. Its useful inside a	1568	confused by changes in cursor position or scrolling. Its useful inside a
1400	C<on_add_lines> hook, though.	1569	C<on_add_lines> hook, though.
1401		1570
…		…
1409	locale-specific encoding of the terminal and can contain command sequences	1578	locale-specific encoding of the terminal and can contain command sequences
1410	(escape codes) that will be interpreted.	1579	(escape codes) that will be interpreted.
1411		1580
1412	=item $term->tt_write ($octets)	1581	=item $term->tt_write ($octets)
1413		1582
1414	Write the octets given in C<$data> to the tty (i.e. as program input). To	1583	Write the octets given in C<$octets> to the tty (i.e. as user input
		1584	to the program, see C<cmd_parse> for the opposite direction). To pass
1415	pass characters instead of octets, you should convert your strings first	1585	characters instead of octets, you should convert your strings first to the
1416	to the locale-specific encoding using C<< $term->locale_encode >>.	1586	locale-specific encoding using C<< $term->locale_encode >>.
		1587
		1588	=item $term->tt_write_user_input ($octets)
		1589
		1590	Like C<tt_write>, but should be used when writing strings in response to
		1591	the user pressing a key, to invoke the additional actions requested by
		1592	the user for that case (C<tt_write> doesn't do that).
		1593
		1594	The typical use case would be inside C<on_action> hooks.
		1595
		1596	=item $term->tt_paste ($octets)
		1597
		1598	Write the octets given in C<$octets> to the tty as a paste, converting NL to
		1599	CR and bracketing the data with control sequences if bracketed paste mode
		1600	is set.
1417		1601
1418	=item $old_events = $term->pty_ev_events ([$new_events])	1602	=item $old_events = $term->pty_ev_events ([$new_events])
1419		1603
1420	Replaces the event mask of the pty watcher by the given event mask. Can	1604	Replaces the event mask of the pty watcher by the given event mask. Can
1421	be used to suppress input and output handling to the pty/tty. See the	1605	be used to suppress input and output handling to the pty/tty. See the
…		…
1440	Adds the specified events to the vt event mask. Useful e.g. when you want	1624	Adds the specified events to the vt event mask. Useful e.g. when you want
1441	to receive pointer events all the times:	1625	to receive pointer events all the times:
1442		1626
1443	$term->vt_emask_add (urxvt::PointerMotionMask);	1627	$term->vt_emask_add (urxvt::PointerMotionMask);
1444		1628
		1629	=item $term->set_urgency ($set)
		1630
		1631	Enable/disable the urgency hint on the toplevel window.
		1632
1445	=item $term->focus_in	1633	=item $term->focus_in
1446		1634
1447	=item $term->focus_out	1635	=item $term->focus_out
1448		1636
1449	=item $term->key_press ($state, $keycode[, $time])	1637	=item $term->key_press ($state, $keycode[, $time])
1450		1638
1451	=item $term->key_release ($state, $keycode[, $time])	1639	=item $term->key_release ($state, $keycode[, $time])
1452		1640
1453	Deliver various fake events to to terminal.	1641	Deliver various fake events to to terminal.
1454		1642
1455	=item $window_width = $term->width	1643	=item $window_width = $term->width ([$new_value])
1456		1644
1457	=item $window_height = $term->height	1645	=item $window_height = $term->height ([$new_value])
1458		1646
1459	=item $font_width = $term->fwidth	1647	=item $font_width = $term->fwidth ([$new_value])
1460		1648
1461	=item $font_height = $term->fheight	1649	=item $font_height = $term->fheight ([$new_value])
1462		1650
1463	=item $font_ascent = $term->fbase	1651	=item $font_ascent = $term->fbase ([$new_value])
1464		1652
1465	=item $terminal_rows = $term->nrow	1653	=item $terminal_rows = $term->nrow ([$new_value])
1466		1654
1467	=item $terminal_columns = $term->ncol	1655	=item $terminal_columns = $term->ncol ([$new_value])
1468		1656
1469	=item $has_focus = $term->focus	1657	=item $has_focus = $term->focus ([$new_value])
1470		1658
1471	=item $is_mapped = $term->mapped	1659	=item $is_mapped = $term->mapped ([$new_value])
1472		1660
1473	=item $max_scrollback = $term->saveLines	1661	=item $max_scrollback = $term->saveLines ([$new_value])
1474		1662
1475	=item $nrow_plus_saveLines = $term->total_rows	1663	=item $nrow_plus_saveLines = $term->total_rows ([$new_value])
1476		1664
1477	=item $topmost_scrollback_row = $term->top_row	1665	=item $topmost_scrollback_row = $term->top_row ([$new_value])
1478		1666
1479	Return various integers describing terminal characteristics.	1667	Return various integers describing terminal characteristics. If an
		1668	argument is given, changes the value and returns the previous one.
1480		1669
1481	=item $x_display = $term->display_id	1670	=item $x_display = $term->display_id
1482		1671
1483	Return the DISPLAY used by rxvt-unicode.	1672	Return the DISPLAY used by rxvt-unicode.
1484		1673
…		…
1519		1708
1520	Returns the currently displayed screen (0 primary, 1 secondary).	1709	Returns the currently displayed screen (0 primary, 1 secondary).
1521		1710
1522	=item $cursor_is_hidden = $term->hidden_cursor	1711	=item $cursor_is_hidden = $term->hidden_cursor
1523		1712
1524	Returns wether the cursor is currently hidden or not.	1713	Returns whether the cursor is currently hidden or not.
		1714
		1715	=item $priv_modes = $term->priv_modes
		1716
		1717	Returns a bitset with the state of DEC private modes.
		1718
		1719	Example:
		1720
		1721	if ($term->priv_modes & urxvt::PrivMode_mouse_report) {
		1722	# mouse reporting is turned on
		1723	}
1525		1724
1526	=item $view_start = $term->view_start ([$newvalue])	1725	=item $view_start = $term->view_start ([$newvalue])
1527		1726
1528	Returns the row number of the topmost displayed line. Maximum value is	1727	Returns the row number of the topmost displayed line. Maximum value is
1529	C<0>, which displays the normal terminal contents. Lower values scroll	1728	C<0>, which displays the normal terminal contents. Lower values scroll
…		…
1535	compare the on-screen display with its stored representation. If they	1734	compare the on-screen display with its stored representation. If they
1536	differ, it redraws the differences.	1735	differ, it redraws the differences.
1537		1736
1538	Used after changing terminal contents to display them.	1737	Used after changing terminal contents to display them.
1539		1738
		1739	=item $term->refresh_check
		1740
		1741	Checks if a refresh has been requested and, if so, schedules one.
		1742
1540	=item $text = $term->ROW_t ($row_number[, $new_text[, $start_col]])	1743	=item $text = $term->ROW_t ($row_number[, $new_text[, $start_col]])
1541		1744
1542	Returns the text of the entire row with number C<$row_number>. Row C<0>	1745	Returns the text of the entire row with number C<$row_number>. Row C<< $term->top_row >>
1543	is the topmost terminal line, row C<< $term->$ncol-1 >> is the bottommost	1746	is the topmost terminal line, row C<< $term->nrow-1 >> is the bottommost
1544	terminal line. The scrollback buffer starts at line C<-1> and extends to
1545	line C<< -$term->nsaved >>. Nothing will be returned if a nonexistent line	1747	terminal line. Nothing will be returned if a nonexistent line
1546	is requested.	1748	is requested.
1547		1749
1548	If C<$new_text> is specified, it will replace characters in the current	1750	If C<$new_text> is specified, it will replace characters in the current
1549	line, starting at column C<$start_col> (default C<0>), which is useful	1751	line, starting at column C<$start_col> (default C<0>), which is useful
1550	to replace only parts of a line. The font index in the rendition will	1752	to replace only parts of a line. The font index in the rendition will
1551	automatically be updated.	1753	automatically be updated.
1552		1754
1553	C<$text> is in a special encoding: tabs and wide characters that use more	1755	C<$text> is in a special encoding: tabs and wide characters that use more
1554	than one cell when displayed are padded with C<$urxvt::NOCHAR> (chr 65535)	1756	than one cell when displayed are padded with C<$urxvt::NOCHAR> (chr 65535)
1555	characters. Characters with combining characters and other characters that	1757	characters. Characters with combining characters and other characters that
1556	do not fit into the normal tetx encoding will be replaced with characters	1758	do not fit into the normal text encoding will be replaced with characters
1557	in the private use area.	1759	in the private use area.
1558		1760
1559	You have to obey this encoding when changing text. The advantage is	1761	You have to obey this encoding when changing text. The advantage is
1560	that C<substr> and similar functions work on screen cells and not on	1762	that C<substr> and similar functions work on screen cells and not on
1561	characters.	1763	characters.
…		…
1646	}	1848	}
1647		1849
1648	sub urxvt::line::t {	1850	sub urxvt::line::t {
1649	my ($self) = @_;	1851	my ($self) = @_;
1650		1852
1651	if (@_ > 1)	1853	if (@_ > 1) {
1652	{
1653	$self->{term}->ROW_t ($_, $_[1], 0, ($_ - $self->{beg}) * $self->{ncol}, $self->{ncol})	1854	$self->{term}->ROW_t ($_, $_[1], 0, ($_ - $self->{beg}) * $self->{ncol}, $self->{ncol})
1654	for $self->{beg} .. $self->{end};	1855	for $self->{beg} .. $self->{end};
1655	}	1856	}
1656		1857
1657	defined wantarray &&	1858	defined wantarray &&
1658	substr +(join "", map $self->{term}->ROW_t ($_), $self->{beg} .. $self->{end}),	1859	substr +(join "", map $self->{term}->ROW_t ($_), $self->{beg} .. $self->{end}),
1659	0, $self->{len}	1860	0, $self->{len}
1660	}	1861	}
1661		1862
1662	sub urxvt::line::r {	1863	sub urxvt::line::r {
1663	my ($self) = @_;	1864	my ($self) = @_;
1664		1865
1665	if (@_ > 1)	1866	if (@_ > 1) {
1666	{
1667	$self->{term}->ROW_r ($_, $_[1], 0, ($_ - $self->{beg}) * $self->{ncol}, $self->{ncol})	1867	$self->{term}->ROW_r ($_, $_[1], 0, ($_ - $self->{beg}) * $self->{ncol}, $self->{ncol})
1668	for $self->{beg} .. $self->{end};	1868	for $self->{beg} .. $self->{end};
1669	}	1869	}
1670		1870
1671	if (defined wantarray) {	1871	if (defined wantarray) {
1672	my $rend = [	1872	my $rend = [
1673	map @{ $self->{term}->ROW_r ($_) }, $self->{beg} .. $self->{end}	1873	map @{ $self->{term}->ROW_r ($_) }, $self->{beg} .. $self->{end}
1674	];	1874	];
…		…
1706	where one character corresponds to one screen cell. See	1906	where one character corresponds to one screen cell. See
1707	C<< $term->ROW_t >> for details.	1907	C<< $term->ROW_t >> for details.
1708		1908
1709	=item $string = $term->special_decode $text	1909	=item $string = $term->special_decode $text
1710		1910
1711	Converts rxvt-unicodes text reprsentation into a perl string. See	1911	Converts rxvt-unicodes text representation into a perl string. See
1712	C<< $term->ROW_t >> for details.	1912	C<< $term->ROW_t >> for details.
1713		1913
1714	=item $success = $term->grab_button ($button, $modifiermask[, $window = $term->vt])	1914	=item $success = $term->grab_button ($button, $modifiermask[, $window = $term->vt])
1715		1915
1716	=item $term->ungrab_button ($button, $modifiermask[, $window = $term->vt])	1916	=item $term->ungrab_button ($button, $modifiermask[, $window = $term->vt])
…		…
1719	manpage.	1919	manpage.
1720		1920
1721	=item $success = $term->grab ($eventtime[, $sync])	1921	=item $success = $term->grab ($eventtime[, $sync])
1722		1922
1723	Calls XGrabPointer and XGrabKeyboard in asynchronous (default) or	1923	Calls XGrabPointer and XGrabKeyboard in asynchronous (default) or
1724	synchronous (C<$sync> is true). Also remembers the grab timestampe.	1924	synchronous (C<$sync> is true). Also remembers the grab timestamp.
1725		1925
1726	=item $term->allow_events_async	1926	=item $term->allow_events_async
1727		1927
1728	Calls XAllowEvents with AsyncBoth for the most recent grab.	1928	Calls XAllowEvents with AsyncBoth for the most recent grab.
1729		1929
…		…
1736	Calls XAllowEvents with both ReplayPointer and ReplayKeyboard for the most	1936	Calls XAllowEvents with both ReplayPointer and ReplayKeyboard for the most
1737	recent grab.	1937	recent grab.
1738		1938
1739	=item $term->ungrab	1939	=item $term->ungrab
1740		1940
1741	Calls XUngrab for the most recent grab. Is called automatically on	1941	Calls XUngrabPointer and XUngrabKeyboard for the most recent grab. Is called automatically on
1742	evaluation errors, as it is better to lose the grab in the error case as	1942	evaluation errors, as it is better to lose the grab in the error case as
1743	the session.	1943	the session.
1744		1944
1745	=item $atom = $term->XInternAtom ($atom_name[, $only_if_exists])	1945	=item $atom = $term->XInternAtom ($atom_name[, $only_if_exists])
1746		1946
…		…
1748		1948
1749	=item @atoms = $term->XListProperties ($window)	1949	=item @atoms = $term->XListProperties ($window)
1750		1950
1751	=item ($type,$format,$octets) = $term->XGetWindowProperty ($window, $property)	1951	=item ($type,$format,$octets) = $term->XGetWindowProperty ($window, $property)
1752		1952
1753	=item $term->XChangeWindowProperty ($window, $property, $type, $format, $octets)	1953	=item $term->XChangeProperty ($window, $property, $type, $format, $octets)
1754		1954
1755	=item $term->XDeleteProperty ($window, $property)	1955	=item $term->XDeleteProperty ($window, $property)
1756		1956
1757	=item $window = $term->DefaultRootWindow	1957	=item $window = $term->DefaultRootWindow
1758		1958
…		…
1765	=item $term->XMoveResizeWindow ($window, $x, $y, $width, $height)	1965	=item $term->XMoveResizeWindow ($window, $x, $y, $width, $height)
1766		1966
1767	=item ($x, $y, $child_window) = $term->XTranslateCoordinates ($src, $dst, $x, $y)	1967	=item ($x, $y, $child_window) = $term->XTranslateCoordinates ($src, $dst, $x, $y)
1768		1968
1769	=item $term->XChangeInput ($window, $add_events[, $del_events])	1969	=item $term->XChangeInput ($window, $add_events[, $del_events])
		1970
		1971	=item $keysym = $term->XStringToKeysym ($string)
		1972
		1973	=item $string = $term->XKeysymToString ($keysym)
1770		1974
1771	Various X or X-related functions. The C<$term> object only serves as	1975	Various X or X-related functions. The C<$term> object only serves as
1772	the source of the display, otherwise those functions map more-or-less	1976	the source of the display, otherwise those functions map more-or-less
1773	directory onto the X functions of the same name.	1977	directly onto the X functions of the same name.
1774		1978
1775	=back	1979	=back
1776		1980
1777	=cut	1981	=cut
1778		1982
…		…
1880	my $env = $self->{term}->env;	2084	my $env = $self->{term}->env;
1881	# we can't hope to reproduce the locale algorithm, so nuke LC_ALL and set LC_CTYPE.	2085	# we can't hope to reproduce the locale algorithm, so nuke LC_ALL and set LC_CTYPE.
1882	delete $env->{LC_ALL};	2086	delete $env->{LC_ALL};
1883	$env->{LC_CTYPE} = $self->{term}->locale;	2087	$env->{LC_CTYPE} = $self->{term}->locale;
1884		2088
1885	urxvt::term->new ($env, "popup",	2089	my $term = urxvt::term->new (
		2090	$env, "popup",
1886	"--perl-lib" => "", "--perl-ext-common" => "",	2091	"--perl-lib" => "", "--perl-ext-common" => "",
1887	"-pty-fd" => -1, "-sl" => 0,	2092	"-pty-fd" => -1, "-sl" => 0,
1888	"-b" => 1, "-bd" => "grey80", "-bl", "-override-redirect",	2093	"-b" => 1, "-bd" => "grey80", "-bl", "-override-redirect",
1889	"--transient-for" => $self->{term}->parent,	2094	"--transient-for" => $self->{term}->parent,
1890	"-display" => $self->{term}->display_id,	2095	"-display" => $self->{term}->display_id,
1891	"-pe" => "urxvt-popup")	2096	"-pe" => "urxvt-popup",
1892	or die "unable to create popup window\n";	2097	) or die "unable to create popup window\n";
		2098
		2099	unless (delete $term->{urxvt_popup_init_done}) {
		2100	$term->ungrab;
		2101	$term->destroy;
		2102	die "unable to initialise popup window\n";
		2103	}
1893	}	2104	}
1894		2105
1895	sub DESTROY {	2106	sub DESTROY {
1896	my ($self) = @_;	2107	my ($self) = @_;
1897		2108
…		…
1902	=back	2113	=back
1903		2114
1904	=cut	2115	=cut
1905		2116
1906	package urxvt::watcher;	2117	package urxvt::watcher;
1907
1908	@urxvt::timer::ISA = __PACKAGE__;
1909	@urxvt::iow::ISA = __PACKAGE__;
1910	@urxvt::pw::ISA = __PACKAGE__;
1911	@urxvt::iw::ISA = __PACKAGE__;
1912		2118
1913	=head2 The C<urxvt::timer> Class	2119	=head2 The C<urxvt::timer> Class
1914		2120
1915	This class implements timer watchers/events. Time is represented as a	2121	This class implements timer watchers/events. Time is represented as a
1916	fractional number of seconds since the epoch. Example:	2122	fractional number of seconds since the epoch. Example:
…		…
1920	->new	2126	->new
1921	->interval (1)	2127	->interval (1)
1922	->cb (sub {	2128	->cb (sub {
1923	$term->{overlay}->set (0, 0,	2129	$term->{overlay}->set (0, 0,
1924	sprintf "%2d:%02d:%02d", (localtime urxvt::NOW)[2,1,0]);	2130	sprintf "%2d:%02d:%02d", (localtime urxvt::NOW)[2,1,0]);
1925	});	2131	});
1926		2132
1927	=over 4	2133	=over 4
1928		2134
1929	=item $timer = new urxvt::timer	2135	=item $timer = new urxvt::timer
1930		2136
…		…
1933		2139
1934	=item $timer = $timer->cb (sub { my ($timer) = @_; ... })	2140	=item $timer = $timer->cb (sub { my ($timer) = @_; ... })
1935		2141
1936	Set the callback to be called when the timer triggers.	2142	Set the callback to be called when the timer triggers.
1937		2143
1938	=item $tstamp = $timer->at
1939
1940	Return the time this watcher will fire next.
1941
1942	=item $timer = $timer->set ($tstamp)	2144	=item $timer = $timer->set ($tstamp[, $interval])
1943		2145
1944	Set the time the event is generated to $tstamp.	2146	Set the time the event is generated to $tstamp (and optionally specifies a
		2147	new $interval).
1945		2148
1946	=item $timer = $timer->interval ($interval)	2149	=item $timer = $timer->interval ($interval)
1947		2150
1948	Normally (and when C<$interval> is C<0>), the timer will automatically	2151	By default (and when C<$interval> is C<0>), the timer will automatically
1949	stop after it has fired once. If C<$interval> is non-zero, then the timer	2152	stop after it has fired once. If C<$interval> is non-zero, then the timer
1950	is automatically rescheduled at the given intervals.	2153	is automatically rescheduled at the given intervals.
1951		2154
1952	=item $timer = $timer->start	2155	=item $timer = $timer->start
1953		2156
1954	Start the timer.	2157	Start the timer.
1955		2158
1956	=item $timer = $timer->start ($tstamp)	2159	=item $timer = $timer->start ($tstamp[, $interval])
1957		2160
1958	Set the event trigger time to C<$tstamp> and start the timer.	2161	Set the event trigger time to C<$tstamp> and start the timer. Optionally
		2162	also replaces the interval.
1959		2163
1960	=item $timer = $timer->after ($delay)	2164	=item $timer = $timer->after ($delay[, $interval])
1961		2165
1962	Like C<start>, but sets the expiry timer to c<urxvt::NOW + $delay>.	2166	Like C<start>, but sets the expiry timer to c<urxvt::NOW + $delay>.
1963		2167
1964	=item $timer = $timer->stop	2168	=item $timer = $timer->stop
1965		2169
…		…
1973		2177
1974	$term->{socket} = ...	2178	$term->{socket} = ...
1975	$term->{iow} = urxvt::iow	2179	$term->{iow} = urxvt::iow
1976	->new	2180	->new
1977	->fd (fileno $term->{socket})	2181	->fd (fileno $term->{socket})
1978	->events (urxvt::EVENT_READ)	2182	->events (urxvt::EV_READ)
1979	->start	2183	->start
1980	->cb (sub {	2184	->cb (sub {
1981	my ($iow, $revents) = @_;	2185	my ($iow, $revents) = @_;
1982	# $revents must be 1 here, no need to check	2186	# $revents must be 1 here, no need to check
1983	sysread $term->{socket}, my $buf, 8192	2187	sysread $term->{socket}, my $buf, 8192
…		…
1996	Set the callback to be called when io events are triggered. C<$reventmask>	2200	Set the callback to be called when io events are triggered. C<$reventmask>
1997	is a bitset as described in the C<events> method.	2201	is a bitset as described in the C<events> method.
1998		2202
1999	=item $iow = $iow->fd ($fd)	2203	=item $iow = $iow->fd ($fd)
2000		2204
2001	Set the filedescriptor (not handle) to watch.	2205	Set the file descriptor (not handle) to watch.
2002		2206
2003	=item $iow = $iow->events ($eventmask)	2207	=item $iow = $iow->events ($eventmask)
2004		2208
2005	Set the event mask to watch. The only allowed values are	2209	Set the event mask to watch. The only allowed values are
2006	C<urxvt::EVENT_READ> and C<urxvt::EVENT_WRITE>, which might be ORed	2210	C<urxvt::EV_READ> and C<urxvt::EV_WRITE>, which might be ORed
2007	together, or C<urxvt::EVENT_NONE>.	2211	together, or C<urxvt::EV_NONE>.
2008		2212
2009	=item $iow = $iow->start	2213	=item $iow = $iow->start
2010		2214
2011	Start watching for requested events on the given handle.	2215	Start watching for requested events on the given handle.
2012		2216
2013	=item $iow = $iow->stop	2217	=item $iow = $iow->stop
2014		2218
2015	Stop watching for events on the given filehandle.	2219	Stop watching for events on the given file handle.
2016		2220
2017	=back	2221	=back
2018		2222
2019	=head2 The C<urxvt::iw> Class	2223	=head2 The C<urxvt::iw> Class
2020		2224
…		…
2053	->new	2257	->new
2054	->start ($pid)	2258	->start ($pid)
2055	->cb (sub {	2259	->cb (sub {
2056	my ($pw, $exit_status) = @_;	2260	my ($pw, $exit_status) = @_;
2057	...	2261	...
2058	});	2262	});
2059		2263
2060	=over 4	2264	=over 4
2061		2265
2062	=item $pw = new urxvt::pw	2266	=item $pw = new urxvt::pw
2063		2267
…		…
2067		2271
2068	Set the callback to be called when the timer triggers.	2272	Set the callback to be called when the timer triggers.
2069		2273
2070	=item $pw = $timer->start ($pid)	2274	=item $pw = $timer->start ($pid)
2071		2275
2072	Tells the wqtcher to start watching for process C<$pid>.	2276	Tells the watcher to start watching for process C<$pid>.
2073		2277
2074	=item $pw = $pw->stop	2278	=item $pw = $pw->stop
2075		2279
2076	Stop the watcher.	2280	Stop the watcher.
2077		2281
…		…
2090		2294
2091	=item >= 3 - script loading and management	2295	=item >= 3 - script loading and management
2092		2296
2093	=item >=10 - all called hooks	2297	=item >=10 - all called hooks
2094		2298
2095	=item >=11 - hook reutrn values	2299	=item >=11 - hook return values
2096		2300
2097	=back	2301	=back
2098		2302
2099	=head1 AUTHOR	2303	=head1 AUTHOR
2100		2304
2101	Marc Lehmann <pcg@goof.com>	2305	Marc Lehmann <schmorp@schmorp.de>
2102	http://software.schmorp.de/pkg/rxvt-unicode	2306	http://software.schmorp.de/pkg/rxvt-unicode
2103		2307
2104	=cut	2308	=cut
2105		2309
2106	1	2310	1
		2311
		2312	# vim: sw=3:

Diff Legend

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