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.140 by root, Mon Jul 3 19:10:09 2006 UTC vs.
Revision 1.263 by sf-exg, Wed Jul 14 12:39:57 2021 UTC

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

Diff Legend

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