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

Diff Legend

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