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.257 by root, Thu Jul 13 10:31:27 2017 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.
		121
		122	Currently, it recognises only one such comment:
391		123
392	=over 4	124	=over 4
393		125
394	=item $urxvt_term = $self->{term}	126	=item #:META:RESOURCE:name:type:desc
395		127
396	Returns the C<urxvt::term> object associated with this instance of the	128	The RESOURCE comment defines a resource used by the extension, where
397	extension. This member I<must not> be changed in any way.	129	C<name> is the resource name, C<type> is the resource type, C<boolean>
398		130	or C<string>, and C<desc> is the resource description.
399	=item $self->enable ($hook_name => $cb, [$hook_name => $cb..])
400
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		131
409	=back	132	=back
410		133
411	=head2 Hooks	134	=head2 Hooks
412		135
413	The following subroutines can be declared in extension files, and will be	136	The following subroutines can be declared in extension files, and will be
414	called whenever the relevant event happens.	137	called whenever the relevant event happens.
415		138
416	The first argument passed to them is an extension oject as described in	139	The first argument passed to them is an extension object as described in
417	the in the C<Extension Objects> section.	140	the in the C<Extension Objects> section.
418		141
419	B<All> of these hooks must return a boolean value. If any of the called	142	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	143	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.	144	relevant action might not be carried out by the C++ code.
…		…
434	place.	157	place.
435		158
436	=item on_start $term	159	=item on_start $term
437		160
438	Called at the very end of initialisation of a new terminal, just before	161	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.	162	trying to map (display) the toplevel and returning to the main loop.
440		163
441	=item on_destroy $term	164	=item on_destroy $term
442		165
443	Called whenever something tries to destroy terminal, when the terminal is	166	Called whenever something tries to destroy terminal, when the terminal is
444	still fully functional (not for long, though).	167	still fully functional (not for long, though).
…		…
471		194
472	Called whenever a selection has been copied, but before the selection is	195	Called whenever a selection has been copied, but before the selection is
473	requested from the server. The selection text can be queried and changed	196	requested from the server. The selection text can be queried and changed
474	by calling C<< $term->selection >>.	197	by calling C<< $term->selection >>.
475		198
476	Returning a true value aborts selection grabbing. It will still be hilighted.	199	Returning a true value aborts selection grabbing. It will still be highlighted.
477		200
478	=item on_sel_extend $term	201	=item on_sel_extend $term
479		202
480	Called whenever the user tries to extend the selection (e.g. with a double	203	Called whenever the user tries to extend the selection (e.g. with a double
481	click) and is either supposed to return false (normal operation), or	204	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	205	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	206	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	207	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.	208	supposed to enlarge the selection more and more, if possible.
486		209
487	See the F<selection> example extension.	210	See the F<selection> example extension.
488		211
489	=item on_view_change $term, $offset	212	=item on_view_change $term, $offset
490		213
491	Called whenever the view offset changes, i..e the user or program	214	Called whenever the view offset changes, i.e. the user or program
492	scrolls. Offset C<0> means display the normal terminal, positive values	215	scrolls. Offset C<0> means display the normal terminal, positive values
493	show this many lines of scrollback.	216	show this many lines of scrollback.
494		217
495	=item on_scroll_back $term, $lines, $saved	218	=item on_scroll_back $term, $lines, $saved
496		219
…		…
500		223
501	It is called before lines are scrolled out (so rows 0 .. min ($lines - 1,	224	It is called before lines are scrolled out (so rows 0 .. min ($lines - 1,
502	$nrow - 1) represent the lines to be scrolled out). C<$saved> is the total	225	$nrow - 1) represent the lines to be scrolled out). C<$saved> is the total
503	number of lines that will be in the scrollback buffer.	226	number of lines that will be in the scrollback buffer.
504		227
505	=item on_osc_seq $term, $op, $args	228	=item on_osc_seq $term, $op, $args, $resp
506		229
507	Called on every OSC sequence and can be used to suppress it or modify its	230	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	231	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	232	suppresses execution of the request completely. Make sure you don't get
510	confused by recursive invocations when you output an osc sequence within	233	confused by recursive invocations when you output an OSC sequence within
511	this callback.	234	this callback.
512		235
513	C<on_osc_seq_perl> should be used for new behaviour.	236	C<on_osc_seq_perl> should be used for new behaviour.
514		237
515	=item on_osc_seq_perl $term, $string	238	=item on_osc_seq_perl $term, $args, $resp
516		239
517	Called whenever the B<ESC ] 777 ; string ST> command sequence (OSC =	240	Called whenever the B<ESC ] 777 ; string ST> command sequence (OSC =
518	operating system command) is processed. Cursor position and other state	241	operating system command) is processed. Cursor position and other state
519	information is up-to-date when this happens. For interoperability, the	242	information is up-to-date when this happens. For interoperability, the
520	string should start with the extension name and a colon, to distinguish	243	string should start with the extension name (sans -osc) and a semicolon,
521	it from commands for other extensions, and this might be enforced in the	244	to distinguish it from commands for other extensions, and this might be
522	future.	245	enforced in the future.
		246
		247	For example, C<overlay-osc> uses this:
		248
		249	sub on_osc_seq_perl {
		250	my ($self, $osc, $resp) = @_;
		251
		252	return unless $osc =~ s/^overlay;//;
		253
		254	... process remaining $osc string
		255	}
523		256
524	Be careful not ever to trust (in a security sense) the data you receive,	257	Be careful not ever to trust (in a security sense) the data you receive,
525	as its source can not easily be controleld (e-mail content, messages from	258	as its source can not easily be controlled (e-mail content, messages from
526	other users on the same system etc.).	259	other users on the same system etc.).
		260
		261	For responses, C<$resp> contains the end-of-args separator used by the
		262	sender.
527		263
528	=item on_add_lines $term, $string	264	=item on_add_lines $term, $string
529		265
530	Called whenever text is about to be output, with the text as argument. You	266	Called whenever text is about to be output, with the text as argument. You
531	can filter/change and output the text yourself by returning a true value	267	can filter/change and output the text yourself by returning a true value
…		…
536	=item on_tt_write $term, $octets	272	=item on_tt_write $term, $octets
537		273
538	Called whenever some data is written to the tty/pty and can be used to	274	Called whenever some data is written to the tty/pty and can be used to
539	suppress or filter tty input.	275	suppress or filter tty input.
540		276
		277	=item on_tt_paste $term, $octets
		278
		279	Called whenever text is about to be pasted, with the text as argument. You
		280	can filter/change and paste the text yourself by returning a true value
		281	and calling C<< $term->tt_paste >> yourself. C<$octets> is
		282	locale-encoded.
		283
541	=item on_line_update $term, $row	284	=item on_line_update $term, $row
542		285
543	Called whenever a line was updated or changed. Can be used to filter	286	Called whenever a line was updated or changed. Can be used to filter
544	screen output (e.g. underline urls or other useless stuff). Only lines	287	screen output (e.g. underline urls or other useless stuff). Only lines
545	that are being shown will be filtered, and, due to performance reasons,	288	that are being shown will be filtered, and, due to performance reasons,
…		…
552	later with the already-modified line (e.g. if unrelated parts change), so	295	later with the already-modified line (e.g. if unrelated parts change), so
553	you cannot just toggle rendition bits, but only set them.	296	you cannot just toggle rendition bits, but only set them.
554		297
555	=item on_refresh_begin $term	298	=item on_refresh_begin $term
556		299
557	Called just before the screen gets redrawn. Can be used for overlay	300	Called just before the screen gets redrawn. Can be used for overlay or
558	or similar effects by modify terminal contents in refresh_begin, and	301	similar effects by modifying the terminal contents in refresh_begin, and
559	restoring them in refresh_end. The built-in overlay and selection display	302	restoring them in refresh_end. The built-in overlay and selection display
560	code is run after this hook, and takes precedence.	303	code is run after this hook, and takes precedence.
561		304
562	=item on_refresh_end $term	305	=item on_refresh_end $term
563		306
564	Called just after the screen gets redrawn. See C<on_refresh_begin>.	307	Called just after the screen gets redrawn. See C<on_refresh_begin>.
565		308
		309	=item on_action $term, $string
		310
		311	Called whenever an action is invoked for the corresponding extension
		312	(e.g. via a C<extension:string> builtin action bound to a key, see
		313	description of the B<keysym> resource in the urxvt(1) manpage). The
		314	event is simply the action string. Note that an action event is always
		315	associated to a single extension.
		316
566	=item on_user_command $term, $string	317	=item on_user_command $term, $string *DEPRECATED*
567		318
568	Called whenever the a user-configured event is being activated (e.g. via	319	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>	320	a C<perl:string> action bound to a key, see description of the B<keysym>
570	resource in the @@RXVT_NAME@@(1) manpage).	321	resource in the urxvt(1) manpage).
571		322
572	The event is simply the action string. This interface is assumed to change	323	The event is simply the action string. This interface is going away in
573	slightly in the future.	324	preference to the C<on_action> hook.
574		325
575	=item on_resize_all_windows $tern, $new_width, $new_height	326	=item on_resize_all_windows $term, $new_width, $new_height
576		327
577	Called just after the new window size has been calculcated, but before	328	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	329	windows are actually being resized or hints are being set. If this hook
579	returns TRUE, setting of the window hints is being skipped.	330	returns a true value, setting of the window hints is being skipped.
580		331
581	=item on_x_event $term, $event	332	=item on_x_event $term, $event
582		333
583	Called on every X event received on the vt window (and possibly other	334	Called on every X event received on the vt window (and possibly other
584	windows). Should only be used as a last resort. Most event structure	335	windows). Should only be used as a last resort. Most event structure
585	members are not passed.	336	members are not passed.
586		337
		338	=item on_root_event $term, $event
		339
		340	Like C<on_x_event>, but is called for events on the root window.
		341
587	=item on_focus_in $term	342	=item on_focus_in $term
588		343
589	Called whenever the window gets the keyboard focus, before rxvt-unicode	344	Called whenever the window gets the keyboard focus, before rxvt-unicode
590	does focus in processing.	345	does focus in processing.
591		346
592	=item on_focus_out $term	347	=item on_focus_out $term
593		348
594	Called wheneever the window loses keyboard focus, before rxvt-unicode does	349	Called whenever the window loses keyboard focus, before rxvt-unicode does
595	focus out processing.	350	focus out processing.
596		351
597	=item on_configure_notify $term, $event	352	=item on_configure_notify $term, $event
598		353
599	=item on_property_notify $term, $event	354	=item on_property_notify $term, $event
…		…
610		365
611	=item on_map_notify $term, $event	366	=item on_map_notify $term, $event
612		367
613	=item on_unmap_notify $term, $event	368	=item on_unmap_notify $term, $event
614		369
615	Called whenever the corresponding X event is received for the terminal If	370	Called whenever the corresponding X event is received for the terminal. If
616	the hook returns true, then the even will be ignored by rxvt-unicode.	371	the hook returns true, then the event will be ignored by rxvt-unicode.
617		372
618	The event is a hash with most values as named by Xlib (see the XEvent	373	The event is a hash with most values as named by Xlib (see the XEvent
619	manpage), with the additional members C<row> and C<col>, which are the	374	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.	375	(real, not screen-based) row and column under the mouse cursor.
621		376
622	C<on_key_press> additionally receives the string rxvt-unicode would	377	C<on_key_press> additionally receives the string rxvt-unicode would
623	output, if any, in locale-specific encoding.	378	output, if any, in locale-specific encoding.
624		379
625	subwindow.
626
627	=item on_client_message $term, $event	380	=item on_client_message $term, $event
628		381
629	=item on_wm_protocols $term, $event	382	=item on_wm_protocols $term, $event
630		383
631	=item on_wm_delete_window $term, $event	384	=item on_wm_delete_window $term, $event
632		385
633	Called when various types of ClientMessage events are received (all with	386	Called when various types of ClientMessage events are received (all with
634	format=32, WM_PROTOCOLS or WM_PROTOCOLS:WM_DELETE_WINDOW).	387	format=32, WM_PROTOCOLS or WM_PROTOCOLS:WM_DELETE_WINDOW).
635		388
		389	=item on_bell $term
		390
		391	Called on receipt of a bell character.
		392
636	=back	393	=back
637		394
638	=cut	395	=cut
639		396
640	package urxvt;	397	package urxvt;
641		398
642	use utf8;	399	use utf8;
643	use strict;	400	use strict 'vars';
644	use Carp ();	401	use Carp ();
645	use Scalar::Util ();	402	use Scalar::Util ();
646	use List::Util ();	403	use List::Util ();
647		404
648	our $VERSION = 1;	405	our $VERSION = 1;
649	our $TERM;	406	our $TERM;
650	our @TERM_INIT;	407	our @TERM_INIT; # should go, prevents async I/O etc.
651	our @TERM_EXT;	408	our @TERM_EXT; # should go, prevents async I/O etc.
652	our @HOOKNAME;	409	our @HOOKNAME;
653	our %HOOKTYPE = map +($HOOKNAME[$_] => $_), 0..$#HOOKNAME;	410	our %HOOKTYPE = map +($HOOKNAME[$_] => $_), 0..$#HOOKNAME;
654	our %OPTION;	411	our %OPTION;
655		412
656	our $LIBDIR;	413	our $LIBDIR;
…		…
682	The current terminal. This variable stores the current C<urxvt::term>	439	The current terminal. This variable stores the current C<urxvt::term>
683	object, whenever a callback/hook is executing.	440	object, whenever a callback/hook is executing.
684		441
685	=item @urxvt::TERM_INIT	442	=item @urxvt::TERM_INIT
686		443
687	All coderefs in this array will be called as methods of the next newly	444	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	445	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,	446	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.	447	so references can push themselves onto it again if they so desire.
691		448
692	This complements to the perl-eval commandline option, but gets executed	449	This complements to the perl-eval command line option, but gets executed
693	first.	450	first.
694		451
695	=item @urxvt::TERM_EXT	452	=item @urxvt::TERM_EXT
696		453
697	Works similar to C<@TERM_INIT>, but contains perl package/class names, which	454	Works similar to C<@TERM_INIT>, but contains perl package/class names, which
…		…
704		461
705	=over 4	462	=over 4
706		463
707	=item urxvt::fatal $errormessage	464	=item urxvt::fatal $errormessage
708		465
709	Fatally aborts execution with the given error message. Avoid at all	466	Fatally aborts execution with the given error message (which should
710	costs! The only time this is acceptable is when the terminal process	467	include a trailing newline). Avoid at all costs! The only time this
711	starts up.	468	is acceptable (and useful) is in the init hook, where it prevents the
		469	terminal from starting up.
712		470
713	=item urxvt::warn $string	471	=item urxvt::warn $string
714		472
715	Calls C<rxvt_warn> with the given string which should not include a	473	Calls C<rxvt_warn> with the given string which should include a trailing
716	newline. The module also overwrites the C<warn> builtin with a function	474	newline. The module also overwrites the C<warn> builtin with a function
717	that calls this function.	475	that calls this function.
718		476
719	Using this function has the advantage that its output ends up in the	477	Using this function has the advantage that its output ends up in the
720	correct place, e.g. on stderr of the connecting urxvtc client.	478	correct place, e.g. on stderr of the connecting urxvtc client.
…		…
722	Messages have a size limit of 1023 bytes currently.	480	Messages have a size limit of 1023 bytes currently.
723		481
724	=item @terms = urxvt::termlist	482	=item @terms = urxvt::termlist
725		483
726	Returns all urxvt::term objects that exist in this process, regardless of	484	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	485	whether they are started, being destroyed etc., so be careful. Only term
728	objects that have perl extensions attached will be returned (because there	486	objects that have perl extensions attached will be returned (because there
729	is no urxvt::term objet associated with others).	487	is no urxvt::term object associated with others).
730		488
731	=item $time = urxvt::NOW	489	=item $time = urxvt::NOW
732		490
733	Returns the "current time" (as per the event loop).	491	Returns the "current time" (as per the event loop).
734		492
…		…
754	CirculateRequest, PropertyNotify, SelectionClear, SelectionRequest,	512	CirculateRequest, PropertyNotify, SelectionClear, SelectionRequest,
755	SelectionNotify, ColormapNotify, ClientMessage, MappingNotify	513	SelectionNotify, ColormapNotify, ClientMessage, MappingNotify
756		514
757	Various constants for use in X calls and event processing.	515	Various constants for use in X calls and event processing.
758		516
		517	=item urxvt::PrivMode_132, PrivMode_132OK, PrivMode_rVideo, PrivMode_relOrigin,
		518	PrivMode_Screen, PrivMode_Autowrap, PrivMode_aplCUR, PrivMode_aplKP,
		519	PrivMode_HaveBackSpace, PrivMode_BackSpace, PrivMode_ShiftKeys,
		520	PrivMode_VisibleCursor, PrivMode_MouseX10, PrivMode_MouseX11,
		521	PrivMode_scrollBar, PrivMode_TtyOutputInh, PrivMode_Keypress,
		522	PrivMode_smoothScroll, PrivMode_vt52, PrivMode_LFNL, PrivMode_MouseBtnEvent,
		523	PrivMode_MouseAnyEvent, PrivMode_BracketPaste, PrivMode_ExtModeMouse,
		524	PrivMode_ExtMouseRight, PrivMode_BlinkingCursor, PrivMode_mouse_report,
		525	PrivMode_Default
		526
		527	Constants for checking DEC private modes.
		528
759	=back	529	=back
760		530
761	=head2 RENDITION	531	=head2 RENDITION
762		532
763	Rendition bitsets contain information about colour, font, font styles and	533	Rendition bitsets contain information about colour, font, font styles and
…		…
777		547
778	=item $rend = urxvt::OVERLAY_RSTYLE	548	=item $rend = urxvt::OVERLAY_RSTYLE
779		549
780	Return the rendition mask used for overlays by default.	550	Return the rendition mask used for overlays by default.
781		551
782	=item $rendbit = urxvt::RS_Bold, RS_Italic, RS_Blink, RS_RVid, RS_Uline	552	=item $rendbit = urxvt::RS_Bold, urxvt::RS_Italic, urxvt::RS_Blink,
		553	urxvt::RS_RVid, urxvt::RS_Uline
783		554
784	Return the bit that enabled bold, italic, blink, reverse-video and	555	Return the bit that enabled bold, italic, blink, reverse-video and
785	underline, respectively. To enable such a style, just logically OR it into	556	underline, respectively. To enable such a style, just logically OR it into
786	the bitset.	557	the bitset.
787		558
…		…
824	};	595	};
825	}	596	}
826		597
827	no warnings 'utf8';	598	no warnings 'utf8';
828		599
		600	sub parse_resource {
		601	my ($term, $name, $isarg, $longopt, $flag, $value) = @_;
		602
		603	$term->scan_extensions;
		604
		605	my $r = $term->{meta}{resource};
		606	keys %$r; # reset iterator
		607	while (my ($k, $v) = each %$r) {
		608	my $pattern = $k;
		609	$pattern =~ y/./-/ if $isarg;
		610	my $prefix = $name;
		611	my $suffix;
		612	if ($pattern =~ /\-$/) {
		613	$prefix = substr $name, 0, length $pattern;
		614	$suffix = substr $name, length $pattern;
		615	}
		616	if ($pattern eq $prefix) {
		617	$name = "$urxvt::RESCLASS.$k$suffix";
		618
		619	push @{ $term->{perl_ext_3} }, $v->[0];
		620
		621	return 1 unless $isarg;
		622
		623	if ($v->[1] eq "boolean") {
		624	$term->put_option_db ($name, $flag ? "true" : "false");
		625	return 1;
		626	} else {
		627	$term->put_option_db ($name, $value);
		628	return 1 + 2;
		629	}
		630	}
		631	}
		632
		633	0
		634	}
		635
		636	sub usage {
		637	my ($term, $usage_type) = @_;
		638
		639	$term->scan_extensions;
		640
		641	my $r = $term->{meta}{resource};
		642
		643	for my $pattern (sort keys %$r) {
		644	my ($ext, $type, $desc) = @{ $r->{$pattern} };
		645
		646	$desc .= " (-pe $ext)";
		647
		648	if ($usage_type == 1) {
		649	$pattern =~ y/./-/;
		650	$pattern =~ s/-$/-.../g;
		651
		652	if ($type eq "boolean") {
		653	urxvt::log sprintf " -%-30s %s\n", "/+$pattern", $desc;
		654	} else {
		655	urxvt::log sprintf " -%-30s %s\n", "$pattern $type", $desc;
		656	}
		657	} else {
		658	$pattern =~ s/\.$/.*/g;
		659	urxvt::log sprintf " %-31s %s\n", "$pattern:", $type;
		660	}
		661	}
		662	}
		663
829	my $verbosity = $ENV{URXVT_PERL_VERBOSITY};	664	my $verbosity = $ENV{URXVT_PERL_VERBOSITY};
830		665
831	sub verbose {	666	sub verbose {
832	my ($level, $msg) = @_;	667	my ($level, $msg) = @_;
833	warn "$msg\n" if $level <= $verbosity;	668	warn "$msg\n" if $level <= $verbosity;
…		…
845	$pkg =~ s/[^[:word:]]/_/g;	680	$pkg =~ s/[^[:word:]]/_/g;
846	$pkg = "urxvt::ext::$pkg";	681	$pkg = "urxvt::ext::$pkg";
847		682
848	verbose 3, "loading extension '$path' into package '$pkg'";	683	verbose 3, "loading extension '$path' into package '$pkg'";
849		684
		685	(${"$pkg\::_NAME"} = $path) =~ s/^.*[\\\/]//; # hackish
		686
850	open my $fh, "<:raw", $path	687	open my $fh, "<:raw", $path
851	or die "$path: $!";	688	or die "$path: $!";
852		689
853	my $source =	690	my $source =
854	"package $pkg; use strict; use utf8; no warnings 'utf8';\n"	691	"package $pkg; use strict 'vars'; use utf8; no warnings 'utf8';\n"
855	. "#line 1 \"$path\"\n{\n"	692	. "#line 1 \"$path\"\n{\n"
856	. (do { local $/; <$fh> })	693	. (do { local $/; <$fh> })
857	. "\n};\n1";	694	. "\n};\n1";
858		695
859	eval $source	696	eval $source
…		…
868	# called by the rxvt core	705	# called by the rxvt core
869	sub invoke {	706	sub invoke {
870	local $TERM = shift;	707	local $TERM = shift;
871	my $htype = shift;	708	my $htype = shift;
872		709
873	if ($htype == 0) { # INIT	710	if ($htype == HOOK_INIT) {
874	my @dirs = ((split /:/, $TERM->resource ("perl_lib")), "$LIBDIR/perl");	711	my @dirs = $TERM->perl_libdirs;
875		712
		713	$TERM->scan_extensions;
		714
876	my %ext_arg;	715	my %ext_arg;
877		716
878	{	717	{
879	my @init = @TERM_INIT;	718	my @init = @TERM_INIT;
880	@TERM_INIT = ();	719	@TERM_INIT = ();
…		…
882	my @pkg = @TERM_EXT;	721	my @pkg = @TERM_EXT;
883	@TERM_EXT = ();	722	@TERM_EXT = ();
884	$TERM->register_package ($_) for @pkg;	723	$TERM->register_package ($_) for @pkg;
885	}	724	}
886		725
		726	for (
887	for (grep $_, map { split /,/, $TERM->resource ("perl_ext_$_") } 1, 2) {	727	(grep $_, map { split /,/, $TERM->resource ("perl_ext_$_") } 1, 2),
		728	@{ delete $TERM->{perl_ext_3} }
		729	) {
888	if ($_ eq "default") {	730	if ($_ eq "default") {
		731
		732	$ext_arg{$_} = []
889	$ext_arg{$_} ||= [] for qw(selection option-popup selection-popup searchable-scrollback readline);	733	for qw(selection option-popup selection-popup readline searchable-scrollback);
		734
		735	for ($TERM->_keysym_resources) {
		736	next if /^(?:string|command|builtin|builtin-string|perl)/;
		737	next unless /^([A-Za-z0-9_\-]+):/;
		738
		739	my $ext = $1;
		740
		741	$ext_arg{$ext} = [];
		742	}
		743
890	} elsif (/^-(.*)$/) {	744	} elsif (/^-(.*)$/) {
891	delete $ext_arg{$1};	745	delete $ext_arg{$1};
		746
892	} elsif (/^([^<]+)<(.*)>$/) {	747	} elsif (/^([^<]+)<(.*)>$/) {
893	push @{ $ext_arg{$1} }, $2;	748	push @{ $ext_arg{$1} }, $2;
		749
894	} else {	750	} else {
895	$ext_arg{$_} ||= [];	751	$ext_arg{$_} ||= [];
896	}	752	}
897	}	753	}
898		754
…		…
914		770
915	if (my $cb = $TERM->{_hook}[$htype]) {	771	if (my $cb = $TERM->{_hook}[$htype]) {
916	verbose 10, "$HOOKNAME[$htype] (" . (join ", ", $TERM, @_) . ")"	772	verbose 10, "$HOOKNAME[$htype] (" . (join ", ", $TERM, @_) . ")"
917	if $verbosity >= 10;	773	if $verbosity >= 10;
918		774
		775	if ($htype == HOOK_ACTION) {
		776	# this hook is only sent to the extension with the name
		777	# matching the first arg
		778	my $pkg = shift;
		779	$pkg =~ y/-/_/;
		780	$pkg = "urxvt::ext::$pkg";
		781
		782	$cb = $cb->{$pkg}
		783	or return undef; #TODO: maybe warn user?
		784
		785	$cb = { $pkg => $cb };
		786	}
		787
919	for my $pkg (keys %$cb) {	788	for my $pkg (keys %$cb) {
920	my $retval_ = eval { $cb->{$pkg}->($TERM->{_pkg}{$pkg}, @_) };	789	my $retval_ = eval { $cb->{$pkg}->($TERM->{_pkg}{$pkg} || $TERM, @_) };
921	$retval ||= $retval_;	790	$retval ||= $retval_;
922		791
923	if ($@) {	792	if ($@) {
924	$TERM->ungrab; # better to lose the grab than the session	793	$TERM->ungrab; # better to lose the grab than the session
925	warn $@;	794	warn $@;
…		…
928		797
929	verbose 11, "$HOOKNAME[$htype] returning <$retval>"	798	verbose 11, "$HOOKNAME[$htype] returning <$retval>"
930	if $verbosity >= 11;	799	if $verbosity >= 11;
931	}	800	}
932		801
933	if ($htype == 1) { # DESTROY	802	if ($htype == HOOK_DESTROY) {
934	# clear package objects	803	# clear package objects
935	%$_ = () for values %{ $TERM->{_pkg} };	804	%$_ = () for values %{ $TERM->{_pkg} };
936		805
937	# clear package	806	# clear package
938	%$TERM = ();	807	%$TERM = ();
…		…
943		812
944	sub SET_COLOR($$$) {	813	sub SET_COLOR($$$) {
945	SET_BGCOLOR (SET_FGCOLOR ($_[0], $_[1]), $_[2])	814	SET_BGCOLOR (SET_FGCOLOR ($_[0], $_[1]), $_[2])
946	}	815	}
947		816
948	# urxvt::term::extension	817	sub rend2mask {
		818	no strict 'refs';
		819	my ($str, $mask) = (@_, 0);
		820	my %color = ( fg => undef, bg => undef );
		821	my @failed;
		822	for my $spec ( split /\s+/, $str ) {
		823	if ( $spec =~ /^([fb]g)[_:-]?(\d+)/i ) {
		824	$color{lc($1)} = $2;
		825	} else {
		826	my $neg = $spec =~ s/^[-^]//;
		827	unless ( exists &{"RS_$spec"} ) {
		828	push @failed, $spec;
		829	next;
		830	}
		831	my $cur = &{"RS_$spec"};
		832	if ( $neg ) {
		833	$mask &= ~$cur;
		834	} else {
		835	$mask |= $cur;
		836	}
		837	}
		838	}
		839	($mask, @color{qw(fg bg)}, \@failed)
		840	}
949		841
950	package urxvt::term::extension;	842	package urxvt::term::extension;
951		843
952	sub enable {	844	=head2 The C<urxvt::term::extension> class
953	my ($self, %hook) = @_;
954	my $pkg = $self->{_pkg};
955		845
956	while (my ($name, $cb) = each %hook) {	846	Each extension attached to a terminal object is represented by
957	my $htype = $HOOKTYPE{uc $name};	847	a C<urxvt::term::extension> object.
958	defined $htype
959	or Carp::croak "unsupported hook type '$name'";
960		848
961	$self->set_should_invoke ($htype, +1)	849	You can use these objects, which are passed to all callbacks to store any
962	unless exists $self->{term}{_hook}[$htype]{$pkg};	850	state related to the terminal and extension instance.
963		851
964	$self->{term}{_hook}[$htype]{$pkg} = $cb;	852	The methods (And data members) documented below can be called on extension
965	}	853	objects, in addition to call methods documented for the <urxvt::term>
966	}	854	class.
967		855
968	sub disable {	856	=over 4
969	my ($self, @hook) = @_;
970	my $pkg = $self->{_pkg};
971		857
972	for my $name (@hook) {	858	=item $urxvt_term = $self->{term}
973	my $htype = $HOOKTYPE{uc $name};
974	defined $htype
975	or Carp::croak "unsupported hook type '$name'";
976		859
977	$self->set_should_invoke ($htype, -1)	860	Returns the C<urxvt::term> object associated with this instance of the
978	if delete $self->{term}{_hook}[$htype]{$pkg};	861	extension. This member I<must not> be changed in any way.
979	}	862
980	}	863	=cut
981		864
982	our $AUTOLOAD;	865	our $AUTOLOAD;
983		866
984	sub AUTOLOAD {	867	sub AUTOLOAD {
985	$AUTOLOAD =~ /:([^:]+)$/	868	$AUTOLOAD =~ /:([^:]+)$/
…		…
998		881
999	sub DESTROY {	882	sub DESTROY {
1000	# nop	883	# nop
1001	}	884	}
1002		885
1003	# urxvt::destroy_hook	886	# urxvt::destroy_hook (basically a cheap Guard:: implementation)
1004		887
1005	sub urxvt::destroy_hook::DESTROY {	888	sub urxvt::destroy_hook::DESTROY {
1006	${$_[0]}->();	889	${$_[0]}->();
1007	}	890	}
1008		891
1009	sub urxvt::destroy_hook(&) {	892	sub urxvt::destroy_hook(&) {
1010	bless \shift, urxvt::destroy_hook::	893	bless \shift, urxvt::destroy_hook::
1011	}	894	}
		895
		896	=item $self->enable ($hook_name => $cb[, $hook_name => $cb..])
		897
		898	Dynamically enable the given hooks (named without the C<on_> prefix) for
		899	this extension, replacing any hook previously installed via C<enable> in
		900	this extension.
		901
		902	This is useful when you want to overwrite time-critical hooks only
		903	temporarily.
		904
		905	To install additional callbacks for the same hook, you can use the C<on>
		906	method of the C<urxvt::term> class.
		907
		908	=item $self->disable ($hook_name[, $hook_name..])
		909
		910	Dynamically disable the given hooks.
		911
		912	=cut
		913
		914	sub enable {
		915	my ($self, %hook) = @_;
		916	my $pkg = $self->{_pkg};
		917
		918	while (my ($name, $cb) = each %hook) {
		919	my $htype = $HOOKTYPE{uc $name};
		920	defined $htype
		921	or Carp::croak "unsupported hook type '$name'";
		922
		923	$self->set_should_invoke ($htype, +1)
		924	unless exists $self->{term}{_hook}[$htype]{$pkg};
		925
		926	$self->{term}{_hook}[$htype]{$pkg} = $cb;
		927	}
		928	}
		929
		930	sub disable {
		931	my ($self, @hook) = @_;
		932	my $pkg = $self->{_pkg};
		933
		934	for my $name (@hook) {
		935	my $htype = $HOOKTYPE{uc $name};
		936	defined $htype
		937	or Carp::croak "unsupported hook type '$name'";
		938
		939	$self->set_should_invoke ($htype, -1)
		940	if delete $self->{term}{_hook}[$htype]{$pkg};
		941	}
		942	}
		943
		944	=item $guard = $self->on ($hook_name => $cb[, $hook_name => $cb..])
		945
		946	Similar to the C<enable> enable, but installs additional callbacks for
		947	the given hook(s) (that is, it doesn't replace existing callbacks), and
		948	returns a guard object. When the guard object is destroyed the callbacks
		949	are disabled again.
		950
		951	=cut
		952
		953	sub urxvt::extension::on_disable::DESTROY {
		954	my $disable = shift;
		955
		956	my $term = delete $disable->{""};
		957
		958	while (my ($htype, $id) = each %$disable) {
		959	delete $term->{_hook}[$htype]{$id};
		960	$term->set_should_invoke ($htype, -1);
		961	}
		962	}
		963
		964	sub on {
		965	my ($self, %hook) = @_;
		966
		967	my $term = $self->{term};
		968
		969	my %disable = ( "" => $term );
		970
		971	while (my ($name, $cb) = each %hook) {
		972	my $htype = $HOOKTYPE{uc $name};
		973	defined $htype
		974	or Carp::croak "unsupported hook type '$name'";
		975
		976	$term->set_should_invoke ($htype, +1);
		977	$term->{_hook}[$htype]{ $disable{$htype} = $cb+0 }
		978	= sub { shift; $cb->($self, @_) }; # very ugly indeed
		979	}
		980
		981	bless \%disable, "urxvt::extension::on_disable"
		982	}
		983
		984	=item $self->bind_action ($hotkey, $action)
		985
		986	=item $self->x_resource ($pattern)
		987
		988	=item $self->x_resource_boolean ($pattern)
		989
		990	These methods support an additional C<%> prefix for C<$action> or
		991	C<$pattern> when called on an extension object, compared to the
		992	C<urxvt::term> methods of the same name - see the description of these
		993	methods in the C<urxvt::term> class for details.
		994
		995	=cut
		996
		997	sub bind_action {
		998	my ($self, $hotkey, $action) = @_;
		999	$action =~ s/^%:/$_[0]{_name}:/;
		1000	$self->{term}->bind_action ($hotkey, $action)
		1001	}
		1002
		1003	sub x_resource {
		1004	my ($self, $name) = @_;
		1005	$name =~ s/^%(\.|$)/$_[0]{_name}$1/;
		1006	$self->{term}->x_resource ($name)
		1007	}
		1008
		1009	sub x_resource_boolean {
		1010	my ($self, $name) = @_;
		1011	$name =~ s/^%(\.|$)/$_[0]{_name}$1/;
		1012	$self->{term}->x_resource_boolean ($name)
		1013	}
		1014
		1015	=back
		1016
		1017	=cut
1012		1018
1013	package urxvt::anyevent;	1019	package urxvt::anyevent;
1014		1020
1015	=head2 The C<urxvt::anyevent> Class	1021	=head2 The C<urxvt::anyevent> Class
1016		1022
1017	The sole purpose of this class is to deliver an interface to the	1023	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	1024	C<AnyEvent> module - any module using it will work inside urxvt without
1019	further programming. The only exception is that you cannot wait on	1025	further programming. The only exception is that you cannot wait on
1020	condition variables, but non-blocking condvar use is ok. What this means	1026	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		1027
1024	=cut	1028	In practical terms this means is that you cannot use blocking APIs, but
		1029	the non-blocking variant should work.
1025		1030
		1031	=cut
		1032
1026	our $VERSION = 1;	1033	our $VERSION = '5.23';
1027		1034
1028	$INC{"urxvt/anyevent.pm"} = 1; # mark us as there	1035	$INC{"urxvt/anyevent.pm"} = 1; # mark us as there
1029	push @AnyEvent::REGISTRY, [urxvt => urxvt::anyevent::];	1036	push @AnyEvent::REGISTRY, [urxvt => urxvt::anyevent::];
1030		1037
1031	sub timer {	1038	sub timer {
…		…
1033		1040
1034	my $cb = $arg{cb};	1041	my $cb = $arg{cb};
1035		1042
1036	urxvt::timer	1043	urxvt::timer
1037	->new	1044	->new
1038	->start (urxvt::NOW + $arg{after})	1045	->after ($arg{after}, $arg{interval})
1039	->cb (sub {	1046	->cb ($arg{interval} ? $cb : sub {
1040	$_[0]->stop; # need to cancel manually	1047	$_[0]->stop; # need to cancel manually
1041	$cb->();	1048	$cb->();
1042	})	1049	})
1043	}	1050	}
1044		1051
1045	sub io {	1052	sub io {
1046	my ($class, %arg) = @_;	1053	my ($class, %arg) = @_;
1047		1054
1048	my $cb = $arg{cb};	1055	my $cb = $arg{cb};
		1056	my $fd = fileno $arg{fh};
		1057	defined $fd or $fd = $arg{fh};
1049		1058
1050	bless [$arg{fh}, urxvt::iow	1059	bless [$arg{fh}, urxvt::iow
1051	->new	1060	->new
1052	->fd (fileno $arg{fh})	1061	->fd ($fd)
1053	->events (($arg{poll} =~ /r/ ? 1 : 0)	1062	->events (($arg{poll} =~ /r/ ? 1 : 0)
1054	| ($arg{poll} =~ /w/ ? 2 : 0))	1063	| ($arg{poll} =~ /w/ ? 2 : 0))
1055	->start	1064	->start
1056	->cb (sub {	1065	->cb ($cb)
1057	$cb->(($_[1] & 1 ? 'r' : '')
1058	. ($_[1] & 2 ? 'w' : ''));
1059	})],
1060	urxvt::anyevent::	1066	], urxvt::anyevent::
		1067	}
		1068
		1069	sub idle {
		1070	my ($class, %arg) = @_;
		1071
		1072	my $cb = $arg{cb};
		1073
		1074	urxvt::iw
		1075	->new
		1076	->start
		1077	->cb ($cb)
		1078	}
		1079
		1080	sub child {
		1081	my ($class, %arg) = @_;
		1082
		1083	my $cb = $arg{cb};
		1084
		1085	urxvt::pw
		1086	->new
		1087	->start ($arg{pid})
		1088	->cb (sub {
		1089	$_[0]->stop; # need to cancel manually
		1090	$cb->($_[0]->rpid, $_[0]->rstatus);
		1091	})
1061	}	1092	}
1062		1093
1063	sub DESTROY {	1094	sub DESTROY {
1064	$_[0][1]->stop;	1095	$_[0][1]->stop;
1065	}	1096	}
1066		1097
1067	sub condvar {	1098	# only needed for AnyEvent < 6 compatibility
1068	bless \my $flag, urxvt::anyevent::condvar::	1099	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";	1100	Carp::croak "AnyEvent->one_event blocking wait unsupported in urxvt, use a non-blocking API";
1078	}
1079	}	1101	}
1080		1102
1081	package urxvt::term;	1103	package urxvt::term;
1082		1104
1083	=head2 The C<urxvt::term> Class	1105	=head2 The C<urxvt::term> Class
…		…
1096	urxvt::verbose 6, "register package $pkg to $self";	1118	urxvt::verbose 6, "register package $pkg to $self";
1097		1119
1098	@{"$pkg\::ISA"} = urxvt::term::extension::;	1120	@{"$pkg\::ISA"} = urxvt::term::extension::;
1099		1121
1100	my $proxy = bless {	1122	my $proxy = bless {
1101	_pkg => $pkg,	1123	_pkg => $pkg,
		1124	_name => ${"$pkg\::_NAME"}, # hackish
1102	argv => $argv,	1125	argv => $argv,
1103	}, $pkg;	1126	}, $pkg;
1104	Scalar::Util::weaken ($proxy->{term} = $self);	1127	Scalar::Util::weaken ($proxy->{term} = $self);
1105		1128
1106	$self->{_pkg}{$pkg} = $proxy;	1129	$self->{_pkg}{$pkg} = $proxy;
1107		1130
…		…
1110	$proxy->enable ($name => $ref);	1133	$proxy->enable ($name => $ref);
1111	}	1134	}
1112	}	1135	}
1113	}	1136	}
1114		1137
		1138	sub perl_libdirs {
		1139	map { split /:/ }
		1140	$_[0]->resource ("perl_lib"),
		1141	$ENV{URXVT_PERL_LIB},
		1142	"$ENV{HOME}/.urxvt/ext",
		1143	"$LIBDIR/perl"
		1144	}
		1145
		1146	# scan for available extensions and collect their metadata
		1147	sub scan_extensions {
		1148	my ($self) = @_;
		1149
		1150	return if exists $self->{meta};
		1151
		1152	my @urxvtdirs = perl_libdirs $self;
		1153	# my @cpandirs = grep -d, map "$_/URxvt/Ext", @INC;
		1154
		1155	$self->{meta} = \my %meta;
		1156
		1157	# first gather extensions
		1158
		1159	my $gather = sub {
		1160	my ($dir, $core) = @_;
		1161
		1162	opendir my $fh, $dir
		1163	or return;
		1164
		1165	for my $ext (readdir $fh) {
		1166	$ext !~ /^\./
		1167	or next;
		1168
		1169	open my $fh, "<", "$dir/$ext"
		1170	or next;
		1171
		1172	-f $fh
		1173	or next;
		1174
		1175	$ext =~ s/\.uext$// or $core
		1176	or next;
		1177
		1178	my %ext = (dir => $dir);
		1179
		1180	while (<$fh>) {
		1181	if (/^#:META:(?:X_)?RESOURCE:(.*)/) {
		1182	my ($pattern, $type, $desc) = split /:/, $1;
		1183	$pattern =~ s/^%(\.|$)/$ext$1/g; # % in pattern == extension name
		1184	if ($pattern =~ /[^a-zA-Z0-9\-\.]/) {
		1185	warn "$dir/$ext: meta resource '$pattern' contains illegal characters (not alphanumeric nor . nor *)\n";
		1186	} else {
		1187	$ext{resource}{$pattern} = [$ext, $type, $desc];
		1188	}
		1189	} elsif (/^\s*(?:#|$)/) {
		1190	# skip other comments and empty lines
		1191	} else {
		1192	last; # stop parsing on first non-empty non-comment line
		1193	}
		1194	}
		1195
		1196	$meta{ext}{$ext} = \%ext;
		1197	}
		1198	};
		1199
		1200	# $gather->($_, 0) for @cpandirs;
		1201	$gather->($_, 1) for @urxvtdirs;
		1202
		1203	# and now merge resources
		1204
		1205	$meta{resource} = \my %resource;
		1206
		1207	while (my ($k, $v) = each %{ $meta{ext} }) {
		1208	#TODO: should check for extensions overriding each other
		1209	%resource = (%resource, %{ $v->{resource} });
		1210	}
		1211	}
		1212
1115	=item $term = new urxvt::term $envhashref, $rxvtname, [arg...]	1213	=item $term = new urxvt::term $envhashref, $rxvtname, [arg...]
1116		1214
1117	Creates a new terminal, very similar as if you had started it with system	1215	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	1216	C<$rxvtname, arg...>. C<$envhashref> must be a reference to a C<%ENV>-like
1119	hash which defines the environment of the new terminal.	1217	hash which defines the environment of the new terminal.
…		…
1136	}	1234	}
1137		1235
1138	=item $term->destroy	1236	=item $term->destroy
1139		1237
1140	Destroy the terminal object (close the window, free resources	1238	Destroy the terminal object (close the window, free resources
1141	etc.). Please note that @@RXVT_NAME@@ will not exit as long as any event	1239	etc.). Please note that urxvt will not exit as long as any event
1142	watchers (timers, io watchers) are still active.	1240	watchers (timers, io watchers) are still active.
1143		1241
1144	=item $term->exec_async ($cmd[, @args])	1242	=item $term->exec_async ($cmd[, @args])
1145		1243
1146	Works like the combination of the C<fork>/C<exec> builtins, which executes	1244	Works like the combination of the C<fork>/C<exec> builtins, which executes
…		…
1170		1268
1171	Returns true if the option specified by C<$optval> is enabled, and	1269	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	1270	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.	1271	C<%urxvt::OPTION>. Options not enabled in this binary are not in the hash.
1174		1272
1175	Here is a a likely non-exhaustive list of option names, please see the	1273	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:	1274	source file F</src/optinc.h> to see the actual list:
1177		1275
1178	borderLess console cursorBlink cursorUnderline hold iconic insecure	1276	borderLess buffered console cursorBlink cursorUnderline hold iconic
1179	intensityStyles jumpScroll loginShell mapAlert meta8 mouseWheelScrollPage	1277	insecure intensityStyles iso14755 iso14755_52 jumpScroll loginShell
1180	override-redirect pastableTabs pointerBlank reverseVideo scrollBar	1278	mapAlert meta8 mouseWheelScrollPage override_redirect pastableTabs
1181	scrollBar_floating scrollBar_right scrollTtyKeypress scrollTtyOutput	1279	pointerBlank reverseVideo scrollBar scrollBar_floating scrollBar_right
1182	scrollWithBuffer secondaryScreen secondaryScroll skipBuiltinGlyphs	1280	scrollTtyKeypress scrollTtyOutput scrollWithBuffer secondaryScreen
1183	transparent tripleclickwords utmpInhibit visualBell	1281	secondaryScroll skipBuiltinGlyphs skipScroll transparent tripleclickwords
		1282	urgentOnBell utmpInhibit visualBell
1184		1283
1185	=item $value = $term->resource ($name[, $newval])	1284	=item $value = $term->resource ($name[, $newval])
1186		1285
1187	Returns the current resource value associated with a given name and	1286	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>	1287	optionally sets a new value. Setting values is most useful in the C<init>
…		…
1197	likely change).	1296	likely change).
1198		1297
1199	Please note that resource strings will currently only be freed when the	1298	Please note that resource strings will currently only be freed when the
1200	terminal is destroyed, so changing options frequently will eat memory.	1299	terminal is destroyed, so changing options frequently will eat memory.
1201		1300
1202	Here is a a likely non-exhaustive list of resource names, not all of which	1301	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>	1302	are supported in every build, please see the source file F</src/rsinc.h>
1204	to see the actual list:	1303	to see the actual list:
1205		1304
1206	answerbackstring backgroundPixmap backspace_key boldFont boldItalicFont	1305	answerbackstring backgroundPixmap backspace_key blurradius
1207	borderLess color cursorBlink cursorUnderline cutchars delete_key	1306	boldFont boldItalicFont borderLess buffered chdir color cursorBlink
1208	display_name embed ext_bwidth fade font geometry hold iconName	1307	cursorUnderline cutchars delete_key depth display_name embed ext_bwidth
1209	imFont imLocale inputMethod insecure int_bwidth intensityStyles	1308	fade font geometry hold iconName iconfile imFont imLocale inputMethod
		1309	insecure int_bwidth intensityStyles iso14755 iso14755_52 italicFont
1210	italicFont jumpScroll lineSpace loginShell mapAlert meta8 modifier	1310	jumpScroll letterSpace lineSpace loginShell mapAlert meta8 modifier
1211	mouseWheelScrollPage name override_redirect pastableTabs path perl_eval	1311	mouseWheelScrollPage name override_redirect pastableTabs path perl_eval
1212	perl_ext_1 perl_ext_2 perl_lib pointerBlank pointerBlankDelay	1312	perl_ext_1 perl_ext_2 perl_lib pointerBlank pointerBlankDelay
1213	preeditType print_pipe pty_fd reverseVideo saveLines scrollBar	1313	preeditType print_pipe pty_fd reverseVideo saveLines scrollBar
1214	scrollBar_align scrollBar_floating scrollBar_right scrollBar_thickness	1314	scrollBar_align scrollBar_floating scrollBar_right scrollBar_thickness
1215	scrollTtyKeypress scrollTtyOutput scrollWithBuffer scrollstyle	1315	scrollTtyKeypress scrollTtyOutput scrollWithBuffer scrollstyle
1216	secondaryScreen secondaryScroll selectstyle shade term_name title	1316	secondaryScreen secondaryScroll shade skipBuiltinGlyphs skipScroll
1217	transient_for transparent transparent_all tripleclickwords utmpInhibit	1317	term_name title transient_for transparent tripleclickwords urgentOnBell
1218	visualBell	1318	utmpInhibit visualBell
1219		1319
1220	=cut	1320	=cut
1221		1321
1222	sub resource($$;$) {	1322	sub resource($$;$) {
1223	my ($self, $name) = (shift, shift);	1323	my ($self, $name) = (shift, shift);
1224	unshift @_, $self, $name, ($name =~ s/\s*\+\s*(\d+)$// ? $1 : 0);	1324	unshift @_, $self, $name, ($name =~ s/\s*\+\s*(\d+)$// ? $1 : 0);
1225	&urxvt::term::_resource	1325	goto &urxvt::term::_resource
1226	}	1326	}
1227		1327
1228	=item $value = $term->x_resource ($pattern)	1328	=item $value = $term->x_resource ($pattern)
1229		1329
1230	Returns the X-Resource for the given pattern, excluding the program or	1330	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	1331	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	1332	same value as used by this instance of rxvt-unicode. Returns C<undef> if no
1233	resource with that pattern exists.	1333	resource with that pattern exists.
1234		1334
		1335	Extensions that define extra resources also need to call this method
		1336	to access their values.
		1337
		1338	If the method is called on an extension object (basically, from an
		1339	extension), then the special prefix C<%.> will be replaced by the name of
		1340	the extension and a dot, and the lone string C<%> will be replaced by the
		1341	extension name itself. This makes it possible to code extensions so you
		1342	can rename them and get a new set of resources without having to change
		1343	the actual code.
		1344
1235	This method should only be called during the C<on_start> hook, as there is	1345	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	1346	only one resource database per display, and later invocations might return
1237	the wrong resources.	1347	the wrong resources.
1238		1348
1239	=item $success = $term->parse_keysym ($keysym_spec, $command_string)	1349	=item $value = $term->x_resource_boolean ($pattern)
1240		1350
		1351	Like C<x_resource>, above, but interprets the string value as a boolean
		1352	and returns C<1> for true values, C<0> for false values and C<undef> if
		1353	the resource or option isn't specified.
		1354
		1355	You should always use this method to parse boolean resources.
		1356
		1357	=cut
		1358
		1359	sub x_resource_boolean {
		1360	my $res = &x_resource;
		1361
		1362	$res =~ /^\s*(?:true|yes|on|1)\s*$/i ? 1 : defined $res && 0
		1363	}
		1364
		1365	=item $action = $term->lookup_keysym ($keysym, $state)
		1366
		1367	Returns the action bound to key combination C<($keysym, $state)>,
		1368	if a binding for it exists, and C<undef> otherwise.
		1369
		1370	=item $success = $term->bind_action ($key, $action)
		1371
1241	Adds a keymap translation exactly as specified via a resource. See the	1372	Adds a key binding exactly as specified via a C<keysym> resource. See the
1242	C<keysym> resource in the @@RXVT_NAME@@(1) manpage.	1373	C<keysym> resource in the urxvt(1) manpage.
		1374
		1375	To add default bindings for actions, an extension should call C<<
		1376	->bind_action >> in its C<init> hook for every such binding. Doing it
		1377	in the C<init> hook allows users to override or remove the binding
		1378	again.
		1379
		1380	Example: the C<searchable-scrollback> by default binds itself
		1381	on C<Meta-s>, using C<< $self->bind_action >>, which calls C<<
		1382	$term->bind_action >>.
		1383
		1384	sub init {
		1385	my ($self) = @_;
		1386
		1387	$self->bind_action ("M-s" => "%:start");
		1388	}
1243		1389
1244	=item $rend = $term->rstyle ([$new_rstyle])	1390	=item $rend = $term->rstyle ([$new_rstyle])
1245		1391
1246	Return and optionally change the current rendition. Text that is output by	1392	Return and optionally change the current rendition. Text that is output by
1247	the terminal application will use this style.	1393	the terminal application will use this style.
…		…
1255		1401
1256	=item ($row, $col) = $term->selection_beg ([$row, $col])	1402	=item ($row, $col) = $term->selection_beg ([$row, $col])
1257		1403
1258	=item ($row, $col) = $term->selection_end ([$row, $col])	1404	=item ($row, $col) = $term->selection_end ([$row, $col])
1259		1405
1260	Return the current values of the selection mark, begin or end positions,	1406	Return the current values of the selection mark, begin or end positions.
1261	and optionally set them to new values.	1407
		1408	When arguments are given, then the selection coordinates are set to
		1409	C<$row> and C<$col>, and the selection screen is set to the current
		1410	screen.
		1411
		1412	=item $screen = $term->selection_screen ([$screen])
		1413
		1414	Returns the current selection screen, and then optionally sets it.
1262		1415
1263	=item $term->selection_make ($eventtime[, $rectangular])	1416	=item $term->selection_make ($eventtime[, $rectangular])
1264		1417
1265	Tries to make a selection as set by C<selection_beg> and	1418	Tries to make a selection as set by C<selection_beg> and
1266	C<selection_end>. If C<$rectangular> is true (default: false), a	1419	C<selection_end>. If C<$rectangular> is true (default: false), a
1267	rectangular selection will be made. This is the prefered function to make	1420	rectangular selection will be made. This is the preferred function to make
1268	a selection.	1421	a selection.
1269		1422
1270	=item $success = $term->selection_grab ($eventtime)	1423	=item $success = $term->selection_grab ($eventtime[, $clipboard])
1271		1424
1272	Try to request the primary selection text from the server (for example, as	1425	Try to acquire ownership of the primary (clipboard if C<$clipboard> is
		1426	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	1427	with the next method. No visual feedback will be given. This function
1274	is mostly useful from within C<on_sel_grab> hooks.	1428	is mostly useful from within C<on_sel_grab> hooks.
1275		1429
1276	=item $oldtext = $term->selection ([$newtext])	1430	=item $oldtext = $term->selection ([$newtext, $clipboard])
1277		1431
1278	Return the current selection text and optionally replace it by C<$newtext>.	1432	Return the current selection (clipboard if C<$clipboard> is true) text
		1433	and optionally replace it by C<$newtext>.
		1434
		1435	=item $term->selection_clear ([$clipboard])
		1436
		1437	Revoke ownership of the primary (clipboard if C<$clipboard> is true) selection.
1279		1438
1280	=item $term->overlay_simple ($x, $y, $text)	1439	=item $term->overlay_simple ($x, $y, $text)
1281		1440
1282	Create a simple multi-line overlay box. See the next method for details.	1441	Create a simple multi-line overlay box. See the next method for details.
1283		1442
…		…
1313		1472
1314	The methods currently supported on C<urxvt::overlay> objects are:	1473	The methods currently supported on C<urxvt::overlay> objects are:
1315		1474
1316	=over 4	1475	=over 4
1317		1476
1318	=item $overlay->set ($x, $y, $text, $rend)	1477	=item $overlay->set ($x, $y, $text[, $rend])
1319		1478
1320	Similar to C<< $term->ROW_t >> and C<< $term->ROW_r >> in that it puts	1479	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	1480	text in rxvt-unicode's special encoding and an array of rendition values
1322	at a specific position inside the overlay.	1481	at a specific position inside the overlay.
		1482
		1483	If C<$rend> is missing, then the rendition will not be changed.
1323		1484
1324	=item $overlay->hide	1485	=item $overlay->hide
1325		1486
1326	If visible, hide the overlay, but do not destroy it.	1487	If visible, hide the overlay, but do not destroy it.
1327		1488
…		…
1390		1551
1391	=item $term->scr_add_lines ($string)	1552	=item $term->scr_add_lines ($string)
1392		1553
1393	Write the given text string to the screen, as if output by the application	1554	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	1555	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	1556	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.	1557	carriage returns and tabs. The string is a normal text string, not in
		1558	locale-dependent encoding.
1397		1559
1398	Normally its not a good idea to use this function, as programs might be	1560	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	1561	confused by changes in cursor position or scrolling. Its useful inside a
1400	C<on_add_lines> hook, though.	1562	C<on_add_lines> hook, though.
1401		1563
…		…
1409	locale-specific encoding of the terminal and can contain command sequences	1571	locale-specific encoding of the terminal and can contain command sequences
1410	(escape codes) that will be interpreted.	1572	(escape codes) that will be interpreted.
1411		1573
1412	=item $term->tt_write ($octets)	1574	=item $term->tt_write ($octets)
1413		1575
1414	Write the octets given in C<$data> to the tty (i.e. as program input). To	1576	Write the octets given in C<$octets> to the tty (i.e. as user input
		1577	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	1578	characters instead of octets, you should convert your strings first to the
1416	to the locale-specific encoding using C<< $term->locale_encode >>.	1579	locale-specific encoding using C<< $term->locale_encode >>.
		1580
		1581	=item $term->tt_write_user_input ($octets)
		1582
		1583	Like C<tt_write>, but should be used when writing strings in response to
		1584	the user pressing a key, to invoke the additional actions requested by
		1585	the user for that case (C<tt_write> doesn't do that).
		1586
		1587	The typical use case would be inside C<on_action> hooks.
		1588
		1589	=item $term->tt_paste ($octets)
		1590
		1591	Write the octets given in C<$octets> to the tty as a paste, converting NL to
		1592	CR and bracketing the data with control sequences if bracketed paste mode
		1593	is set.
1417		1594
1418	=item $old_events = $term->pty_ev_events ([$new_events])	1595	=item $old_events = $term->pty_ev_events ([$new_events])
1419		1596
1420	Replaces the event mask of the pty watcher by the given event mask. Can	1597	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	1598	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	1617	Adds the specified events to the vt event mask. Useful e.g. when you want
1441	to receive pointer events all the times:	1618	to receive pointer events all the times:
1442		1619
1443	$term->vt_emask_add (urxvt::PointerMotionMask);	1620	$term->vt_emask_add (urxvt::PointerMotionMask);
1444		1621
		1622	=item $term->set_urgency ($set)
		1623
		1624	Enable/disable the urgency hint on the toplevel window.
		1625
1445	=item $term->focus_in	1626	=item $term->focus_in
1446		1627
1447	=item $term->focus_out	1628	=item $term->focus_out
1448		1629
1449	=item $term->key_press ($state, $keycode[, $time])	1630	=item $term->key_press ($state, $keycode[, $time])
1450		1631
1451	=item $term->key_release ($state, $keycode[, $time])	1632	=item $term->key_release ($state, $keycode[, $time])
1452		1633
1453	Deliver various fake events to to terminal.	1634	Deliver various fake events to to terminal.
1454		1635
1455	=item $window_width = $term->width	1636	=item $window_width = $term->width ([$new_value])
1456		1637
1457	=item $window_height = $term->height	1638	=item $window_height = $term->height ([$new_value])
1458		1639
1459	=item $font_width = $term->fwidth	1640	=item $font_width = $term->fwidth ([$new_value])
1460		1641
1461	=item $font_height = $term->fheight	1642	=item $font_height = $term->fheight ([$new_value])
1462		1643
1463	=item $font_ascent = $term->fbase	1644	=item $font_ascent = $term->fbase ([$new_value])
1464		1645
1465	=item $terminal_rows = $term->nrow	1646	=item $terminal_rows = $term->nrow ([$new_value])
1466		1647
1467	=item $terminal_columns = $term->ncol	1648	=item $terminal_columns = $term->ncol ([$new_value])
1468		1649
1469	=item $has_focus = $term->focus	1650	=item $has_focus = $term->focus ([$new_value])
1470		1651
1471	=item $is_mapped = $term->mapped	1652	=item $is_mapped = $term->mapped ([$new_value])
1472		1653
1473	=item $max_scrollback = $term->saveLines	1654	=item $max_scrollback = $term->saveLines ([$new_value])
1474		1655
1475	=item $nrow_plus_saveLines = $term->total_rows	1656	=item $nrow_plus_saveLines = $term->total_rows ([$new_value])
1476		1657
1477	=item $topmost_scrollback_row = $term->top_row	1658	=item $topmost_scrollback_row = $term->top_row ([$new_value])
1478		1659
1479	Return various integers describing terminal characteristics.	1660	Return various integers describing terminal characteristics. If an
		1661	argument is given, changes the value and returns the previous one.
1480		1662
1481	=item $x_display = $term->display_id	1663	=item $x_display = $term->display_id
1482		1664
1483	Return the DISPLAY used by rxvt-unicode.	1665	Return the DISPLAY used by rxvt-unicode.
1484		1666
…		…
1519		1701
1520	Returns the currently displayed screen (0 primary, 1 secondary).	1702	Returns the currently displayed screen (0 primary, 1 secondary).
1521		1703
1522	=item $cursor_is_hidden = $term->hidden_cursor	1704	=item $cursor_is_hidden = $term->hidden_cursor
1523		1705
1524	Returns wether the cursor is currently hidden or not.	1706	Returns whether the cursor is currently hidden or not.
		1707
		1708	=item $priv_modes = $term->priv_modes
		1709
		1710	Returns a bitset with the state of DEC private modes.
		1711
		1712	Example:
		1713
		1714	if ($term->priv_modes & urxvt::PrivMode_mouse_report) {
		1715	# mouse reporting is turned on
		1716	}
1525		1717
1526	=item $view_start = $term->view_start ([$newvalue])	1718	=item $view_start = $term->view_start ([$newvalue])
1527		1719
1528	Returns the row number of the topmost displayed line. Maximum value is	1720	Returns the row number of the topmost displayed line. Maximum value is
1529	C<0>, which displays the normal terminal contents. Lower values scroll	1721	C<0>, which displays the normal terminal contents. Lower values scroll
…		…
1535	compare the on-screen display with its stored representation. If they	1727	compare the on-screen display with its stored representation. If they
1536	differ, it redraws the differences.	1728	differ, it redraws the differences.
1537		1729
1538	Used after changing terminal contents to display them.	1730	Used after changing terminal contents to display them.
1539		1731
		1732	=item $term->refresh_check
		1733
		1734	Checks if a refresh has been requested and, if so, schedules one.
		1735
1540	=item $text = $term->ROW_t ($row_number[, $new_text[, $start_col]])	1736	=item $text = $term->ROW_t ($row_number[, $new_text[, $start_col]])
1541		1737
1542	Returns the text of the entire row with number C<$row_number>. Row C<0>	1738	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	1739	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	1740	terminal line. Nothing will be returned if a nonexistent line
1546	is requested.	1741	is requested.
1547		1742
1548	If C<$new_text> is specified, it will replace characters in the current	1743	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	1744	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	1745	to replace only parts of a line. The font index in the rendition will
1551	automatically be updated.	1746	automatically be updated.
1552		1747
1553	C<$text> is in a special encoding: tabs and wide characters that use more	1748	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)	1749	than one cell when displayed are padded with C<$urxvt::NOCHAR> (chr 65535)
1555	characters. Characters with combining characters and other characters that	1750	characters. Characters with combining characters and other characters that
1556	do not fit into the normal tetx encoding will be replaced with characters	1751	do not fit into the normal text encoding will be replaced with characters
1557	in the private use area.	1752	in the private use area.
1558		1753
1559	You have to obey this encoding when changing text. The advantage is	1754	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	1755	that C<substr> and similar functions work on screen cells and not on
1561	characters.	1756	characters.
…		…
1646	}	1841	}
1647		1842
1648	sub urxvt::line::t {	1843	sub urxvt::line::t {
1649	my ($self) = @_;	1844	my ($self) = @_;
1650		1845
1651	if (@_ > 1)	1846	if (@_ > 1) {
1652	{
1653	$self->{term}->ROW_t ($_, $_[1], 0, ($_ - $self->{beg}) * $self->{ncol}, $self->{ncol})	1847	$self->{term}->ROW_t ($_, $_[1], 0, ($_ - $self->{beg}) * $self->{ncol}, $self->{ncol})
1654	for $self->{beg} .. $self->{end};	1848	for $self->{beg} .. $self->{end};
1655	}	1849	}
1656		1850
1657	defined wantarray &&	1851	defined wantarray &&
1658	substr +(join "", map $self->{term}->ROW_t ($_), $self->{beg} .. $self->{end}),	1852	substr +(join "", map $self->{term}->ROW_t ($_), $self->{beg} .. $self->{end}),
1659	0, $self->{len}	1853	0, $self->{len}
1660	}	1854	}
1661		1855
1662	sub urxvt::line::r {	1856	sub urxvt::line::r {
1663	my ($self) = @_;	1857	my ($self) = @_;
1664		1858
1665	if (@_ > 1)	1859	if (@_ > 1) {
1666	{
1667	$self->{term}->ROW_r ($_, $_[1], 0, ($_ - $self->{beg}) * $self->{ncol}, $self->{ncol})	1860	$self->{term}->ROW_r ($_, $_[1], 0, ($_ - $self->{beg}) * $self->{ncol}, $self->{ncol})
1668	for $self->{beg} .. $self->{end};	1861	for $self->{beg} .. $self->{end};
1669	}	1862	}
1670		1863
1671	if (defined wantarray) {	1864	if (defined wantarray) {
1672	my $rend = [	1865	my $rend = [
1673	map @{ $self->{term}->ROW_r ($_) }, $self->{beg} .. $self->{end}	1866	map @{ $self->{term}->ROW_r ($_) }, $self->{beg} .. $self->{end}
1674	];	1867	];
…		…
1706	where one character corresponds to one screen cell. See	1899	where one character corresponds to one screen cell. See
1707	C<< $term->ROW_t >> for details.	1900	C<< $term->ROW_t >> for details.
1708		1901
1709	=item $string = $term->special_decode $text	1902	=item $string = $term->special_decode $text
1710		1903
1711	Converts rxvt-unicodes text reprsentation into a perl string. See	1904	Converts rxvt-unicodes text representation into a perl string. See
1712	C<< $term->ROW_t >> for details.	1905	C<< $term->ROW_t >> for details.
1713		1906
1714	=item $success = $term->grab_button ($button, $modifiermask[, $window = $term->vt])	1907	=item $success = $term->grab_button ($button, $modifiermask[, $window = $term->vt])
1715		1908
1716	=item $term->ungrab_button ($button, $modifiermask[, $window = $term->vt])	1909	=item $term->ungrab_button ($button, $modifiermask[, $window = $term->vt])
…		…
1719	manpage.	1912	manpage.
1720		1913
1721	=item $success = $term->grab ($eventtime[, $sync])	1914	=item $success = $term->grab ($eventtime[, $sync])
1722		1915
1723	Calls XGrabPointer and XGrabKeyboard in asynchronous (default) or	1916	Calls XGrabPointer and XGrabKeyboard in asynchronous (default) or
1724	synchronous (C<$sync> is true). Also remembers the grab timestampe.	1917	synchronous (C<$sync> is true). Also remembers the grab timestamp.
1725		1918
1726	=item $term->allow_events_async	1919	=item $term->allow_events_async
1727		1920
1728	Calls XAllowEvents with AsyncBoth for the most recent grab.	1921	Calls XAllowEvents with AsyncBoth for the most recent grab.
1729		1922
…		…
1736	Calls XAllowEvents with both ReplayPointer and ReplayKeyboard for the most	1929	Calls XAllowEvents with both ReplayPointer and ReplayKeyboard for the most
1737	recent grab.	1930	recent grab.
1738		1931
1739	=item $term->ungrab	1932	=item $term->ungrab
1740		1933
1741	Calls XUngrab for the most recent grab. Is called automatically on	1934	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	1935	evaluation errors, as it is better to lose the grab in the error case as
1743	the session.	1936	the session.
1744		1937
1745	=item $atom = $term->XInternAtom ($atom_name[, $only_if_exists])	1938	=item $atom = $term->XInternAtom ($atom_name[, $only_if_exists])
1746		1939
…		…
1748		1941
1749	=item @atoms = $term->XListProperties ($window)	1942	=item @atoms = $term->XListProperties ($window)
1750		1943
1751	=item ($type,$format,$octets) = $term->XGetWindowProperty ($window, $property)	1944	=item ($type,$format,$octets) = $term->XGetWindowProperty ($window, $property)
1752		1945
1753	=item $term->XChangeWindowProperty ($window, $property, $type, $format, $octets)	1946	=item $term->XChangeProperty ($window, $property, $type, $format, $octets)
1754		1947
1755	=item $term->XDeleteProperty ($window, $property)	1948	=item $term->XDeleteProperty ($window, $property)
1756		1949
1757	=item $window = $term->DefaultRootWindow	1950	=item $window = $term->DefaultRootWindow
1758		1951
…		…
1765	=item $term->XMoveResizeWindow ($window, $x, $y, $width, $height)	1958	=item $term->XMoveResizeWindow ($window, $x, $y, $width, $height)
1766		1959
1767	=item ($x, $y, $child_window) = $term->XTranslateCoordinates ($src, $dst, $x, $y)	1960	=item ($x, $y, $child_window) = $term->XTranslateCoordinates ($src, $dst, $x, $y)
1768		1961
1769	=item $term->XChangeInput ($window, $add_events[, $del_events])	1962	=item $term->XChangeInput ($window, $add_events[, $del_events])
		1963
		1964	=item $keysym = $term->XStringToKeysym ($string)
		1965
		1966	=item $string = $term->XKeysymToString ($keysym)
1770		1967
1771	Various X or X-related functions. The C<$term> object only serves as	1968	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	1969	the source of the display, otherwise those functions map more-or-less
1773	directory onto the X functions of the same name.	1970	directly onto the X functions of the same name.
1774		1971
1775	=back	1972	=back
1776		1973
1777	=cut	1974	=cut
1778		1975
…		…
1880	my $env = $self->{term}->env;	2077	my $env = $self->{term}->env;
1881	# we can't hope to reproduce the locale algorithm, so nuke LC_ALL and set LC_CTYPE.	2078	# we can't hope to reproduce the locale algorithm, so nuke LC_ALL and set LC_CTYPE.
1882	delete $env->{LC_ALL};	2079	delete $env->{LC_ALL};
1883	$env->{LC_CTYPE} = $self->{term}->locale;	2080	$env->{LC_CTYPE} = $self->{term}->locale;
1884		2081
1885	urxvt::term->new ($env, "popup",	2082	my $term = urxvt::term->new (
		2083	$env, "popup",
1886	"--perl-lib" => "", "--perl-ext-common" => "",	2084	"--perl-lib" => "", "--perl-ext-common" => "",
1887	"-pty-fd" => -1, "-sl" => 0,	2085	"-pty-fd" => -1, "-sl" => 0,
1888	"-b" => 1, "-bd" => "grey80", "-bl", "-override-redirect",	2086	"-b" => 1, "-bd" => "grey80", "-bl", "-override-redirect",
1889	"--transient-for" => $self->{term}->parent,	2087	"--transient-for" => $self->{term}->parent,
1890	"-display" => $self->{term}->display_id,	2088	"-display" => $self->{term}->display_id,
1891	"-pe" => "urxvt-popup")	2089	"-pe" => "urxvt-popup",
1892	or die "unable to create popup window\n";	2090	) or die "unable to create popup window\n";
		2091
		2092	unless (delete $term->{urxvt_popup_init_done}) {
		2093	$term->ungrab;
		2094	$term->destroy;
		2095	die "unable to initialise popup window\n";
		2096	}
1893	}	2097	}
1894		2098
1895	sub DESTROY {	2099	sub DESTROY {
1896	my ($self) = @_;	2100	my ($self) = @_;
1897		2101
…		…
1902	=back	2106	=back
1903		2107
1904	=cut	2108	=cut
1905		2109
1906	package urxvt::watcher;	2110	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		2111
1913	=head2 The C<urxvt::timer> Class	2112	=head2 The C<urxvt::timer> Class
1914		2113
1915	This class implements timer watchers/events. Time is represented as a	2114	This class implements timer watchers/events. Time is represented as a
1916	fractional number of seconds since the epoch. Example:	2115	fractional number of seconds since the epoch. Example:
…		…
1920	->new	2119	->new
1921	->interval (1)	2120	->interval (1)
1922	->cb (sub {	2121	->cb (sub {
1923	$term->{overlay}->set (0, 0,	2122	$term->{overlay}->set (0, 0,
1924	sprintf "%2d:%02d:%02d", (localtime urxvt::NOW)[2,1,0]);	2123	sprintf "%2d:%02d:%02d", (localtime urxvt::NOW)[2,1,0]);
1925	});	2124	});
1926		2125
1927	=over 4	2126	=over 4
1928		2127
1929	=item $timer = new urxvt::timer	2128	=item $timer = new urxvt::timer
1930		2129
…		…
1933		2132
1934	=item $timer = $timer->cb (sub { my ($timer) = @_; ... })	2133	=item $timer = $timer->cb (sub { my ($timer) = @_; ... })
1935		2134
1936	Set the callback to be called when the timer triggers.	2135	Set the callback to be called when the timer triggers.
1937		2136
1938	=item $tstamp = $timer->at
1939
1940	Return the time this watcher will fire next.
1941
1942	=item $timer = $timer->set ($tstamp)	2137	=item $timer = $timer->set ($tstamp[, $interval])
1943		2138
1944	Set the time the event is generated to $tstamp.	2139	Set the time the event is generated to $tstamp (and optionally specifies a
		2140	new $interval).
1945		2141
1946	=item $timer = $timer->interval ($interval)	2142	=item $timer = $timer->interval ($interval)
1947		2143
1948	Normally (and when C<$interval> is C<0>), the timer will automatically	2144	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	2145	stop after it has fired once. If C<$interval> is non-zero, then the timer
1950	is automatically rescheduled at the given intervals.	2146	is automatically rescheduled at the given intervals.
1951		2147
1952	=item $timer = $timer->start	2148	=item $timer = $timer->start
1953		2149
1954	Start the timer.	2150	Start the timer.
1955		2151
1956	=item $timer = $timer->start ($tstamp)	2152	=item $timer = $timer->start ($tstamp[, $interval])
1957		2153
1958	Set the event trigger time to C<$tstamp> and start the timer.	2154	Set the event trigger time to C<$tstamp> and start the timer. Optionally
		2155	also replaces the interval.
1959		2156
1960	=item $timer = $timer->after ($delay)	2157	=item $timer = $timer->after ($delay[, $interval])
1961		2158
1962	Like C<start>, but sets the expiry timer to c<urxvt::NOW + $delay>.	2159	Like C<start>, but sets the expiry timer to c<urxvt::NOW + $delay>.
1963		2160
1964	=item $timer = $timer->stop	2161	=item $timer = $timer->stop
1965		2162
…		…
1973		2170
1974	$term->{socket} = ...	2171	$term->{socket} = ...
1975	$term->{iow} = urxvt::iow	2172	$term->{iow} = urxvt::iow
1976	->new	2173	->new
1977	->fd (fileno $term->{socket})	2174	->fd (fileno $term->{socket})
1978	->events (urxvt::EVENT_READ)	2175	->events (urxvt::EV_READ)
1979	->start	2176	->start
1980	->cb (sub {	2177	->cb (sub {
1981	my ($iow, $revents) = @_;	2178	my ($iow, $revents) = @_;
1982	# $revents must be 1 here, no need to check	2179	# $revents must be 1 here, no need to check
1983	sysread $term->{socket}, my $buf, 8192	2180	sysread $term->{socket}, my $buf, 8192
…		…
1996	Set the callback to be called when io events are triggered. C<$reventmask>	2193	Set the callback to be called when io events are triggered. C<$reventmask>
1997	is a bitset as described in the C<events> method.	2194	is a bitset as described in the C<events> method.
1998		2195
1999	=item $iow = $iow->fd ($fd)	2196	=item $iow = $iow->fd ($fd)
2000		2197
2001	Set the filedescriptor (not handle) to watch.	2198	Set the file descriptor (not handle) to watch.
2002		2199
2003	=item $iow = $iow->events ($eventmask)	2200	=item $iow = $iow->events ($eventmask)
2004		2201
2005	Set the event mask to watch. The only allowed values are	2202	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	2203	C<urxvt::EV_READ> and C<urxvt::EV_WRITE>, which might be ORed
2007	together, or C<urxvt::EVENT_NONE>.	2204	together, or C<urxvt::EV_NONE>.
2008		2205
2009	=item $iow = $iow->start	2206	=item $iow = $iow->start
2010		2207
2011	Start watching for requested events on the given handle.	2208	Start watching for requested events on the given handle.
2012		2209
2013	=item $iow = $iow->stop	2210	=item $iow = $iow->stop
2014		2211
2015	Stop watching for events on the given filehandle.	2212	Stop watching for events on the given file handle.
2016		2213
2017	=back	2214	=back
2018		2215
2019	=head2 The C<urxvt::iw> Class	2216	=head2 The C<urxvt::iw> Class
2020		2217
…		…
2053	->new	2250	->new
2054	->start ($pid)	2251	->start ($pid)
2055	->cb (sub {	2252	->cb (sub {
2056	my ($pw, $exit_status) = @_;	2253	my ($pw, $exit_status) = @_;
2057	...	2254	...
2058	});	2255	});
2059		2256
2060	=over 4	2257	=over 4
2061		2258
2062	=item $pw = new urxvt::pw	2259	=item $pw = new urxvt::pw
2063		2260
…		…
2067		2264
2068	Set the callback to be called when the timer triggers.	2265	Set the callback to be called when the timer triggers.
2069		2266
2070	=item $pw = $timer->start ($pid)	2267	=item $pw = $timer->start ($pid)
2071		2268
2072	Tells the wqtcher to start watching for process C<$pid>.	2269	Tells the watcher to start watching for process C<$pid>.
2073		2270
2074	=item $pw = $pw->stop	2271	=item $pw = $pw->stop
2075		2272
2076	Stop the watcher.	2273	Stop the watcher.
2077		2274
…		…
2090		2287
2091	=item >= 3 - script loading and management	2288	=item >= 3 - script loading and management
2092		2289
2093	=item >=10 - all called hooks	2290	=item >=10 - all called hooks
2094		2291
2095	=item >=11 - hook reutrn values	2292	=item >=11 - hook return values
2096		2293
2097	=back	2294	=back
2098		2295
2099	=head1 AUTHOR	2296	=head1 AUTHOR
2100		2297
2101	Marc Lehmann <pcg@goof.com>	2298	Marc Lehmann <schmorp@schmorp.de>
2102	http://software.schmorp.de/pkg/rxvt-unicode	2299	http://software.schmorp.de/pkg/rxvt-unicode
2103		2300
2104	=cut	2301	=cut
2105		2302
2106	1	2303	1
		2304
		2305	# vim: sw=3:

Diff Legend

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