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.133 by root, Mon Feb 6 06:14:08 2006 UTC vs.
Revision 1.257 by root, Thu Jul 13 10:31:27 2017 UTC

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

Diff Legend

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