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.125 by root, Sun Jan 22 20:39:47 2006 UTC vs.
Revision 1.259 by sf-exg, Sat May 8 06:16:21 2021 UTC

1	=encoding utf8	1	=encoding utf8
2		2
3	=head1 NAME	3	=head1 NAME
4		4
5	@@RXVT_NAME@@perl - rxvt-unicode's embedded perl interpreter	5	urxvtperl - rxvt-unicode's embedded perl interpreter
6		6
7	=head1 SYNOPSIS	7	=head1 SYNOPSIS
8		8
9	# create a file grab_test in $HOME:	9	# create a file grab_test in $HOME:
10		10
11	sub on_sel_grab {	11	sub on_sel_grab {
12	warn "you selected ", $_[0]->selection;	12	warn "you selected ", $_[0]->selection;
13	()	13	()
14	}	14	}
15		15
16	# start a @@RXVT_NAME@@ using it:	16	# start a urxvt using it:
17		17
18	@@RXVT_NAME@@ --perl-lib $HOME -pe grab_test	18	urxvt --perl-lib $HOME -pe grab_test
19		19
20	=head1 DESCRIPTION	20	=head1 DESCRIPTION
21		21
22	Everytime a terminal object gets created, extension scripts specified via	22	Every time a terminal object gets created, extension scripts specified via
23	the C<perl> resource are loaded and associated with it.	23	the C<perl> resource are loaded and associated with it.
24		24
25	Scripts are compiled in a 'use strict' and 'use utf8' environment, and	25	Scripts are compiled in a 'use strict "vars"' and 'use utf8' environment, and
26	thus must be encoded as UTF-8.	26	thus must be encoded as UTF-8.
27		27
28	Each script will only ever be loaded once, even in @@RXVT_NAME@@d, where	28	Each script will only ever be loaded once, even in urxvtd, where
29	scripts will be shared (but not enabled) for all terminals.	29	scripts will be shared (but not enabled) for all terminals.
30		30
		31	You can disable the embedded perl interpreter by setting both "perl-ext"
		32	and "perl-ext-common" resources to the empty string.
		33
31	=head1 PREPACKAGED EXTENSIONS	34	=head1 PREPACKAGED EXTENSIONS
32		35
33	This section describes the extensions delivered with this release. You can	36	A number of extensions are delivered with this release. You can find them
34	find them in F<@@RXVT_LIBDIR@@/urxvt/perl/>.	37	in F<< <libdir>/urxvt/perl/ >>, and the documentation can be viewed using
		38	F<< man urxvt-<EXTENSIONNAME> >>.
35		39
36	You can activate them like this:	40	You can activate them like this:
37		41
38	@@RXVT_NAME@@ -pe <extensionname>	42	urxvt -pe <extensionname>
39		43
40	Or by adding them to the resource for extensions loaded by default:	44	Or by adding them to the resource for extensions loaded by default:
41		45
42	URxvt.perl-ext-common: default,automove-background,selection-autotransform	46	URxvt.perl-ext-common: default,selection-autotransform
43		47
44	=over 4	48	Extensions may add additional resources and C<actions>, i.e., methods
45		49	which can be bound to a key and invoked by the user. An extension can
46	=item selection (enabled by default)	50	define the resources it support using so called META comments,
47		51	described below. Similarly to builtin resources, extension resources
48	(More) intelligent selection. This extension tries to be more intelligent	52	can also be specified on the command line as long options (with C<.>
49	when the user extends selections (double-click and further clicks). Right	53	replaced by C<->), in which case the corresponding extension is loaded
50	now, it tries to select words, urls and complete shell-quoted	54	automatically. For this to work the extension B<must> define META
51	arguments, which is very convenient, too, if your F<ls> supports	55	comments for its resources.
52	C<--quoting-style=shell>.
53
54	A double-click usually selects the word under the cursor, further clicks
55	will enlarge the selection.
56
57	The selection works by trying to match a number of regexes and displaying
58	them in increasing order of length. You can add your own regexes by
59	specifying resources of the form:
60
61	URxvt.selection.pattern-0: perl-regex
62	URxvt.selection.pattern-1: perl-regex
63	...
64
65	The index number (0, 1...) must not have any holes, and each regex must
66	contain at least one pair of capturing parentheses, which will be used for
67	the match. For example, the followign adds a regex that matches everything
68	between two vertical bars:
69
70	URxvt.selection.pattern-0: \\|([^|]+)\\|
71
72	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 readline (enabled by default)
133
134	A support package that tries to make editing with readline easier. At the
135	moment, it reacts to clicking with the left mouse button by trying to
136	move the text cursor to this position. It does so by generating as many
137	cursor-left or cursor-right keypresses as required (the this only works
138	for programs that correctly support wide characters).
139
140	To avoid too many false positives, this is only done when:
141
142	=over 4
143
144	=item - the tty is in ICANON state.
145
146	=item - the text cursor is visible.
147
148	=item - the primary screen is currently being displayed.
149
150	=item - the mouse is on the same (multi-row-) line as the text cursor.
151
152	=back
153
154	The normal selection mechanism isn't disabled, so quick successive clicks
155	might interfere with selection creation in harmless ways.
156
157	=item selection-autotransform
158
159	This selection allows you to do automatic transforms on a selection
160	whenever a selection is made.
161
162	It works by specifying perl snippets (most useful is a single C<s///>
163	operator) that modify C<$_> as resources:
164
165	URxvt.selection-autotransform.0: transform
166	URxvt.selection-autotransform.1: transform
167	...
168
169	For example, the following will transform selections of the form
170	C<filename:number>, often seen in compiler messages, into C<vi +$filename
171	$word>:
172
173	URxvt.selection-autotransform.0: s/^([^:[:space:]]+):(\\d+):?$/vi +$2 \\Q$1\\E\\x0d/
174
175	And this example matches the same,but replaces it with vi-commands you can
176	paste directly into your (vi :) editor:
177
178	URxvt.selection-autotransform.0: s/^([^:[:space:]]+(\\d+):?$/:e \\Q$1\\E\\x0d:$2\\x0d/
179
180	Of course, this can be modified to suit your needs and your editor :)
181
182	To expand the example above to typical perl error messages ("XXX at
183	FILENAME line YYY."), you need a slightly more elaborate solution:
184
185	URxvt.selection.pattern-0: ( at .*? line \\d+[,.])
186	URxvt.selection-autotransform.0: s/^ at (.*?) line (\\d+)[,.]$/:e \\Q$1\E\\x0d:$2\\x0d/
187
188	The first line tells the selection code to treat the unchanging part of
189	every error message as a selection pattern, and the second line transforms
190	the message into vi commands to load the file.
191
192	=item tabbed
193
194	This transforms the terminal into a tabbar with additional terminals, that
195	is, it implements what is commonly refered to as "tabbed terminal". The topmost line
196	displays a "[NEW]" button, which, when clicked, will add a new tab, followed by one
197	button per tab.
198
199	Clicking a button will activate that tab. Pressing B<Shift-Left> and
200	B<Shift-Right> will switch to the tab left or right of the current one,
201	while B<Shift-Down> creates a new tab.
202
203	=item mark-urls
204
205	Uses per-line display filtering (C<on_line_update>) to underline urls and
206	make them clickable. When middle-clicked, the program specified in the
207	resource C<urlLauncher> (default C<x-www-browser>) will be started with
208	the URL as first argument.
209
210	=item automove-background
211
212	This is basically a one-line extension that dynamically changes the background pixmap offset
213	to the window position, in effect creating the same effect as pseudo transparency with
214	a custom pixmap. No scaling is supported in this mode. Exmaple:
215
216	@@RXVT_NAME@@ -pixmap background.xpm -pe automove-background
217
218	=item block-graphics-to-ascii
219
220	A not very useful example of filtering all text output to the terminal,
221	by replacing all line-drawing characters (U+2500 .. U+259F) by a
222	similar-looking ascii character.
223
224	=item digital-clock
225
226	Displays a digital clock using the built-in overlay.
227
228	=item example-refresh-hooks
229
230	Displays a very simple digital clock in the upper right corner of the
231	window. Illustrates overwriting the refresh callbacks to create your own
232	overlays or changes.
233
234	=item selection-pastebin
235
236	This is a little rarely useful extension that Uploads the selection as
237	textfile to a remote site (or does other things). (The implementation is
238	not currently secure for use in a multiuser environment as it writes to
239	F</tmp> directly.).
240
241	It listens to the C<selection-pastebin:remote-pastebin> keyboard command,
242	i.e.
243
244	URxvt.keysym.C-M-e: perl:selection-pastebin:remote-pastebin
245
246	Pressing this combination runs a command with C<%> replaced by the name of
247	the textfile. This command can be set via a resource:
248
249	URxvt.selection-pastebin.cmd: rsync -apP % ruth:/var/www/www.ta-sa.org/files/txt/.
250
251	And the default is likely not useful to anybody but the few people around
252	here :)
253
254	The name of the textfile is the hex encoded md5 sum of the selection, so
255	the same content should lead to the same filename.
256
257	After a successful upload the selection will be replaced by the text given
258	in the C<selection-pastebin-url> resource (again, the % is the placeholder
259	for the filename):
260
261	URxvt.selection-pastebin.url: http://www.ta-sa.org/files/txt/%
262
263	=back
264		56
265	=head1 API DOCUMENTATION	57	=head1 API DOCUMENTATION
266		58
267	=head2 General API Considerations	59	=head2 General API Considerations
268		60
…		…
282		74
283	=over 4	75	=over 4
284		76
285	=item $text	77	=item $text
286		78
287	Rxvt-unicodes special way of encoding text, where one "unicode" character	79	Rxvt-unicode's special way of encoding text, where one "unicode" character
288	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.
289		81
290	=item $string	82	=item $string
291		83
292	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
…		…
296	=item $octets	88	=item $octets
297		89
298	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
299	locale-specific way.	91	locale-specific way.
300		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
301	=back	99	=back
302		100
303	=head2 Extension Objects	101	=head2 Extension Objects
304		102
305	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
306	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,
307	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
308	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
309	begin with an underscore character C<_>: these are reserved for internal	108	that begin with an underscore character C<_>: these are reserved for
310	use.	109	internal use.
311		110
312	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
313	C<urxvt::term> class on this object.	112	C<urxvt::term> class on this object.
314		113
315	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:
316		125
317	=over 4	126	=over 4
318		127
319	=item $urxvt_term = $self->{term}	128	=item #:META:RESOURCE:name:type:desc
320		129
321	Returns the C<urxvt::term> object associated with this instance of the	130	The RESOURCE comment defines a resource used by the extension, where
322	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.
323		133
324	=item $self->enable ($hook_name => $cb, [$hook_name => $cb..])	134	The extension will be autoloaded when this resource is specified or used
325		135	as a command line parameter.
326	Dynamically enable the given hooks (named without the C<on_> prefix) for
327	this extension, replacing any previous hook. This is useful when you want
328	to overwrite time-critical hooks only temporarily.
329
330	=item $self->disable ($hook_name[, $hook_name..])
331
332	Dynamically disable the given hooks.
333		136
334	=back	137	=back
335		138
336	=head2 Hooks	139	=head2 Hooks
337		140
338	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
339	called whenever the relevant event happens.	142	called whenever the relevant event happens.
340		143
341	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
342	the in the C<Extension Objects> section.	145	the in the C<Extension Objects> section.
343		146
344	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
345	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
346	relevant action might not be carried out by the C++ code.	149	relevant action might not be carried out by the C++ code.
…		…
359	place.	162	place.
360		163
361	=item on_start $term	164	=item on_start $term
362		165
363	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
364	trying to map (display) the toplevel and returning to the mainloop.	167	trying to map (display) the toplevel and returning to the main loop.
365		168
366	=item on_destroy $term	169	=item on_destroy $term
367		170
368	Called whenever something tries to destroy terminal, before doing anything	171	Called whenever something tries to destroy terminal, when the terminal is
369	yet. If this hook returns true, then destruction is skipped, but this is	172	still fully functional (not for long, though).
370	rarely a good idea.
371		173
372	=item on_reset $term	174	=item on_reset $term
373		175
374	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
375	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
…		…
397		199
398	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
399	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
400	by calling C<< $term->selection >>.	202	by calling C<< $term->selection >>.
401		203
402	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.
403		205
404	=item on_sel_extend $term	206	=item on_sel_extend $term
405		207
406	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
407	click) and is either supposed to return false (normal operation), or	209	click) and is either supposed to return false (normal operation), or
408	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
409	processing. This can happen multiple times, as long as the callback	211	processing. This can happen multiple times, as long as the callback
410	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
411	supposed to enlarge the selection more and more, if possible.	213	supposed to enlarge the selection more and more, if possible.
412		214
413	See the F<selection> example extension.	215	See the F<selection> example extension.
414		216
415	=item on_view_change $term, $offset	217	=item on_view_change $term, $offset
416		218
417	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
418	scrolls. Offset C<0> means display the normal terminal, positive values	220	scrolls. Offset C<0> means display the normal terminal, positive values
419	show this many lines of scrollback.	221	show this many lines of scrollback.
420		222
421	=item on_scroll_back $term, $lines, $saved	223	=item on_scroll_back $term, $lines, $saved
422		224
…		…
426		228
427	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,
428	$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
429	number of lines that will be in the scrollback buffer.	231	number of lines that will be in the scrollback buffer.
430		232
431	=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
432		244
433	Called whenever the B<ESC ] 777 ; string ST> command sequence (OSC =	245	Called whenever the B<ESC ] 777 ; string ST> command sequence (OSC =
434	operating system command) is processed. Cursor position and other state	246	operating system command) is processed. Cursor position and other state
435	information is up-to-date when this happens. For interoperability, the	247	information is up-to-date when this happens. For interoperability, the
436	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,
437	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
438	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	}
439		261
440	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,
441	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
442	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.
443		268
444	=item on_add_lines $term, $string	269	=item on_add_lines $term, $string
445		270
446	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
447	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
…		…
452	=item on_tt_write $term, $octets	277	=item on_tt_write $term, $octets
453		278
454	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
455	suppress or filter tty input.	280	suppress or filter tty input.
456		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
457	=item on_line_update $term, $row	289	=item on_line_update $term, $row
458		290
459	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
460	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
461	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,
…		…
468	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
469	you cannot just toggle rendition bits, but only set them.	301	you cannot just toggle rendition bits, but only set them.
470		302
471	=item on_refresh_begin $term	303	=item on_refresh_begin $term
472		304
473	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
474	or similar effects by modify terminal contents in refresh_begin, and	306	similar effects by modifying the terminal contents in refresh_begin, and
475	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
476	code is run after this hook, and takes precedence.	308	code is run after this hook, and takes precedence.
477		309
478	=item on_refresh_end $term	310	=item on_refresh_end $term
479		311
480	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>.
481		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
482	=item on_keyboard_command $term, $string	322	=item on_user_command $term, $string *DEPRECATED*
483		323
484	Called whenever the user presses a key combination that has a	324	Called whenever a user-configured event is being activated (e.g. via
485	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>
486	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.
487		336
488	=item on_x_event $term, $event	337	=item on_x_event $term, $event
489		338
490	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
491	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
492	members are not passed.	341	members are not passed.
493		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
494	=item on_focus_in $term	347	=item on_focus_in $term
495		348
496	Called whenever the window gets the keyboard focus, before rxvt-unicode	349	Called whenever the window gets the keyboard focus, before rxvt-unicode
497	does focus in processing.	350	does focus in processing.
498		351
499	=item on_focus_out $term	352	=item on_focus_out $term
500		353
501	Called wheneever the window loses keyboard focus, before rxvt-unicode does	354	Called whenever the window loses keyboard focus, before rxvt-unicode does
502	focus out processing.	355	focus out processing.
503		356
504	=item on_configure_notify $term, $event	357	=item on_configure_notify $term, $event
505		358
506	=item on_property_notify $term, $event	359	=item on_property_notify $term, $event
…		…
517		370
518	=item on_map_notify $term, $event	371	=item on_map_notify $term, $event
519		372
520	=item on_unmap_notify $term, $event	373	=item on_unmap_notify $term, $event
521		374
522	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
523	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.
524		377
525	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
526	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
527	(real, not screen-based) row and column under the mouse cursor.	380	(real, not screen-based) row and column under the mouse cursor.
528		381
529	C<on_key_press> additionally receives the string rxvt-unicode would	382	C<on_key_press> additionally receives the string rxvt-unicode would
530	output, if any, in locale-specific encoding.	383	output, if any, in locale-specific encoding.
531		384
532	subwindow.
533
534	=item on_client_message $term, $event	385	=item on_client_message $term, $event
535		386
536	=item on_wm_protocols $term, $event	387	=item on_wm_protocols $term, $event
537		388
538	=item on_wm_delete_window $term, $event	389	=item on_wm_delete_window $term, $event
539		390
540	Called when various types of ClientMessage events are received (all with	391	Called when various types of ClientMessage events are received (all with
541	format=32, WM_PROTOCOLS or WM_PROTOCOLS:WM_DELETE_WINDOW).	392	format=32, WM_PROTOCOLS or WM_PROTOCOLS:WM_DELETE_WINDOW).
542		393
		394	=item on_bell $term
		395
		396	Called on receipt of a bell character.
		397
543	=back	398	=back
544		399
545	=cut	400	=cut
546		401
547	package urxvt;	402	package urxvt;
548		403
549	use utf8;	404	use utf8;
550	use strict;	405	use strict 'vars';
551	use Carp ();	406	use Carp ();
552	use Scalar::Util ();	407	use Scalar::Util ();
553	use List::Util ();	408	use List::Util ();
554		409
555	our $VERSION = 1;	410	our $VERSION = 1;
556	our $TERM;	411	our $TERM;
557	our @TERM_INIT;	412	our @TERM_INIT; # should go, prevents async I/O etc.
558	our @TERM_EXT;	413	our @TERM_EXT; # should go, prevents async I/O etc.
559	our @HOOKNAME;	414	our @HOOKNAME;
560	our %HOOKTYPE = map +($HOOKNAME[$_] => $_), 0..$#HOOKNAME;	415	our %HOOKTYPE = map +($HOOKNAME[$_] => $_), 0..$#HOOKNAME;
561	our %OPTION;	416	our %OPTION;
562		417
563	our $LIBDIR;	418	our $LIBDIR;
…		…
589	The current terminal. This variable stores the current C<urxvt::term>	444	The current terminal. This variable stores the current C<urxvt::term>
590	object, whenever a callback/hook is executing.	445	object, whenever a callback/hook is executing.
591		446
592	=item @urxvt::TERM_INIT	447	=item @urxvt::TERM_INIT
593		448
594	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
595	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
596	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,
597	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.
598		453
599	This complements to the perl-eval commandline option, but gets executed	454	This complements to the perl-eval command line option, but gets executed
600	first.	455	first.
601		456
602	=item @urxvt::TERM_EXT	457	=item @urxvt::TERM_EXT
603		458
604	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
…		…
611		466
612	=over 4	467	=over 4
613		468
614	=item urxvt::fatal $errormessage	469	=item urxvt::fatal $errormessage
615		470
616	Fatally aborts execution with the given error message. Avoid at all	471	Fatally aborts execution with the given error message (which should
617	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
618	starts up.	473	is acceptable (and useful) is in the init hook, where it prevents the
		474	terminal from starting up.
619		475
620	=item urxvt::warn $string	476	=item urxvt::warn $string
621		477
622	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
623	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
624	that calls this function.	480	that calls this function.
625		481
626	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
627	correct place, e.g. on stderr of the connecting urxvtc client.	483	correct place, e.g. on stderr of the connecting urxvtc client.
628		484
629	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).
630		493
631	=item $time = urxvt::NOW	494	=item $time = urxvt::NOW
632		495
633	Returns the "current time" (as per the event loop).	496	Returns the "current time" (as per the event loop).
634		497
…		…
654	CirculateRequest, PropertyNotify, SelectionClear, SelectionRequest,	517	CirculateRequest, PropertyNotify, SelectionClear, SelectionRequest,
655	SelectionNotify, ColormapNotify, ClientMessage, MappingNotify	518	SelectionNotify, ColormapNotify, ClientMessage, MappingNotify
656		519
657	Various constants for use in X calls and event processing.	520	Various constants for use in X calls and event processing.
658		521
		522	=item urxvt::PrivMode_132, PrivMode_132OK, PrivMode_rVideo, PrivMode_relOrigin,
		523	PrivMode_Screen, PrivMode_Autowrap, PrivMode_aplCUR, PrivMode_aplKP,
		524	PrivMode_HaveBackSpace, PrivMode_BackSpace, PrivMode_ShiftKeys,
		525	PrivMode_VisibleCursor, PrivMode_MouseX10, PrivMode_MouseX11,
		526	PrivMode_scrollBar, PrivMode_TtyOutputInh, PrivMode_Keypress,
		527	PrivMode_smoothScroll, PrivMode_vt52, PrivMode_LFNL, PrivMode_MouseBtnEvent,
		528	PrivMode_MouseAnyEvent, PrivMode_BracketPaste, PrivMode_ExtMouseUTF8,
		529	PrivMode_ExtMouseUrxvt, PrivMode_BlinkingCursor, PrivMode_mouse_report,
		530	PrivMode_Default
		531
		532	Constants for checking DEC private modes.
		533
659	=back	534	=back
660		535
661	=head2 RENDITION	536	=head2 RENDITION
662		537
663	Rendition bitsets contain information about colour, font, font styles and	538	Rendition bitsets contain information about colour, font, font styles and
…		…
677		552
678	=item $rend = urxvt::OVERLAY_RSTYLE	553	=item $rend = urxvt::OVERLAY_RSTYLE
679		554
680	Return the rendition mask used for overlays by default.	555	Return the rendition mask used for overlays by default.
681		556
682	=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
683		559
684	Return the bit that enabled bold, italic, blink, reverse-video and	560	Return the bit that enabled bold, italic, blink, reverse-video and
685	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
686	the bitset.	562	the bitset.
687		563
…		…
692	Return the foreground/background colour index, respectively.	568	Return the foreground/background colour index, respectively.
693		569
694	=item $rend = urxvt::SET_FGCOLOR $rend, $new_colour	570	=item $rend = urxvt::SET_FGCOLOR $rend, $new_colour
695		571
696	=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
697		575
698	Replace the foreground/background colour in the rendition mask with the	576	Replace the foreground/background colour in the rendition mask with the
699	specified one.	577	specified one.
700		578
701	=item $value = urxvt::GET_CUSTOM $rend	579	=item $value = urxvt::GET_CUSTOM $rend
…		…
722	};	600	};
723	}	601	}
724		602
725	no warnings 'utf8';	603	no warnings 'utf8';
726		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
727	my $verbosity = $ENV{URXVT_PERL_VERBOSITY};	671	my $verbosity = $ENV{URXVT_PERL_VERBOSITY};
728		672
729	sub verbose {	673	sub verbose {
730	my ($level, $msg) = @_;	674	my ($level, $msg) = @_;
731	warn "$msg\n" if $level <= $verbosity;	675	warn "$msg\n" if $level <= $verbosity;
…		…
743	$pkg =~ s/[^[:word:]]/_/g;	687	$pkg =~ s/[^[:word:]]/_/g;
744	$pkg = "urxvt::ext::$pkg";	688	$pkg = "urxvt::ext::$pkg";
745		689
746	verbose 3, "loading extension '$path' into package '$pkg'";	690	verbose 3, "loading extension '$path' into package '$pkg'";
747		691
		692	(${"$pkg\::_NAME"} = $path) =~ s/^.*[\\\/]//; # hackish
		693
748	open my $fh, "<:raw", $path	694	open my $fh, "<:raw", $path
749	or die "$path: $!";	695	or die "$path: $!";
750		696
751	my $source =	697	my $source =
752	"package $pkg; use strict; use utf8; no warnings 'utf8';\n"	698	"package $pkg; use strict 'vars'; use utf8; no warnings 'utf8';\n"
753	. "#line 1 \"$path\"\n{\n"	699	. "#line 1 \"$path\"\n{\n"
754	. (do { local $/; <$fh> })	700	. (do { local $/; <$fh> })
755	. "\n};\n1";	701	. "\n};\n1";
756		702
757	eval $source	703	eval $source
…		…
766	# called by the rxvt core	712	# called by the rxvt core
767	sub invoke {	713	sub invoke {
768	local $TERM = shift;	714	local $TERM = shift;
769	my $htype = shift;	715	my $htype = shift;
770		716
771	if ($htype == 0) { # INIT	717	if ($htype == HOOK_INIT) {
772	my @dirs = ((split /:/, $TERM->resource ("perl_lib")), "$LIBDIR/perl");	718	my @dirs = $TERM->perl_libdirs;
773		719
		720	$TERM->scan_extensions;
		721
774	my %ext_arg;	722	my %ext_arg;
775		723
776	{	724	{
777	my @init = @TERM_INIT;	725	my @init = @TERM_INIT;
778	@TERM_INIT = ();	726	@TERM_INIT = ();
…		…
780	my @pkg = @TERM_EXT;	728	my @pkg = @TERM_EXT;
781	@TERM_EXT = ();	729	@TERM_EXT = ();
782	$TERM->register_package ($_) for @pkg;	730	$TERM->register_package ($_) for @pkg;
783	}	731	}
784		732
		733	for (
785	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	) {
786	if ($_ eq "default") {	737	if ($_ eq "default") {
		738
		739	$ext_arg{$_} = []
787	$ext_arg{$_} ||= [] for qw(selection option-popup selection-popup searchable-scrollback readline);	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
788	} elsif (/^-(.*)$/) {	751	} elsif (/^-(.*)$/) {
789	delete $ext_arg{$1};	752	delete $ext_arg{$1};
		753
790	} elsif (/^([^<]+)<(.*)>$/) {	754	} elsif (/^([^<]+)<(.*)>$/) {
791	push @{ $ext_arg{$1} }, $2;	755	push @{ $ext_arg{$1} }, $2;
		756
792	} else {	757	} else {
793	$ext_arg{$_} ||= [];	758	$ext_arg{$_} ||= [];
794	}	759	}
795	}	760	}
796		761
797	while (my ($ext, $argv) = each %ext_arg) {	762	for my $ext (sort keys %ext_arg) {
798	my @files = grep -f $_, map "$_/$ext", @dirs;	763	my @files = grep -f $_, map "$_/$ext", @dirs;
799		764
800	if (@files) {	765	if (@files) {
801	$TERM->register_package (extension_package $files[0], $argv);	766	$TERM->register_package (extension_package $files[0], $ext_arg{$ext});
802	} else {	767	} else {
803	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";
804	}	769	}
805	}	770	}
806		771
…		…
812		777
813	if (my $cb = $TERM->{_hook}[$htype]) {	778	if (my $cb = $TERM->{_hook}[$htype]) {
814	verbose 10, "$HOOKNAME[$htype] (" . (join ", ", $TERM, @_) . ")"	779	verbose 10, "$HOOKNAME[$htype] (" . (join ", ", $TERM, @_) . ")"
815	if $verbosity >= 10;	780	if $verbosity >= 10;
816		781
817	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";
818		788
819	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) {
820	my $retval_ = eval { $cb->($TERM->{_pkg}{$pkg}, @_) };	796	my $retval_ = eval { $cb->{$pkg}->($TERM->{_pkg}{$pkg} || $TERM, @_) };
821	$retval ||= $retval_;	797	$retval ||= $retval_;
822		798
823	if ($@) {	799	if ($@) {
824	$TERM->ungrab; # better to lose the grab than the session	800	$TERM->ungrab; # better to lose the grab than the session
825	warn $@;	801	warn $@;
…		…
828		804
829	verbose 11, "$HOOKNAME[$htype] returning <$retval>"	805	verbose 11, "$HOOKNAME[$htype] returning <$retval>"
830	if $verbosity >= 11;	806	if $verbosity >= 11;
831	}	807	}
832		808
833	if ($htype == 1) { # DESTROY	809	if ($htype == HOOK_DESTROY) {
834	# clear package objects	810	# clear package objects
835	%$_ = () for values %{ $TERM->{_pkg} };	811	%$_ = () for values %{ $TERM->{_pkg} };
836		812
837	# clear package	813	# clear package
838	%$TERM = ();	814	%$TERM = ();
839	}	815	}
840		816
841	$retval	817	$retval
842	}	818	}
843		819
844	# 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	}
845		848
846	package urxvt::term::extension;	849	package urxvt::term::extension;
847		850
848	sub enable {	851	=head2 The C<urxvt::term::extension> class
849	my ($self, %hook) = @_;
850	my $pkg = $self->{_pkg};
851		852
852	while (my ($name, $cb) = each %hook) {	853	Each extension attached to a terminal object is represented by
853	my $htype = $HOOKTYPE{uc $name};	854	a C<urxvt::term::extension> object.
854	defined $htype
855	or Carp::croak "unsupported hook type '$name'";
856		855
857	$self->set_should_invoke ($htype, +1)	856	You can use these objects, which are passed to all callbacks to store any
858	unless exists $self->{term}{_hook}[$htype]{$pkg};	857	state related to the terminal and extension instance.
859		858
860	$self->{term}{_hook}[$htype]{$pkg} = $cb;	859	The methods (And data members) documented below can be called on extension
861	}	860	objects, in addition to call methods documented for the <urxvt::term>
862	}	861	class.
863		862
864	sub disable {	863	=over 4
865	my ($self, @hook) = @_;
866	my $pkg = $self->{_pkg};
867		864
868	for my $name (@hook) {	865	=item $urxvt_term = $self->{term}
869	my $htype = $HOOKTYPE{uc $name};
870	defined $htype
871	or Carp::croak "unsupported hook type '$name'";
872		866
873	$self->set_should_invoke ($htype, -1)	867	Returns the C<urxvt::term> object associated with this instance of the
874	if delete $self->{term}{_hook}[$htype]{$pkg};	868	extension. This member I<must not> be changed in any way.
875	}	869
876	}	870	=cut
877		871
878	our $AUTOLOAD;	872	our $AUTOLOAD;
879		873
880	sub AUTOLOAD {	874	sub AUTOLOAD {
881	$AUTOLOAD =~ /:([^:]+)$/	875	$AUTOLOAD =~ /:([^:]+)$/
…		…
894		888
895	sub DESTROY {	889	sub DESTROY {
896	# nop	890	# nop
897	}	891	}
898		892
899	# urxvt::destroy_hook	893	# urxvt::destroy_hook (basically a cheap Guard:: implementation)
900		894
901	sub urxvt::destroy_hook::DESTROY {	895	sub urxvt::destroy_hook::DESTROY {
902	${$_[0]}->();	896	${$_[0]}->();
903	}	897	}
904		898
905	sub urxvt::destroy_hook(&) {	899	sub urxvt::destroy_hook(&) {
906	bless \shift, urxvt::destroy_hook::	900	bless \shift, urxvt::destroy_hook::
907	}	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
908		1025
909	package urxvt::anyevent;	1026	package urxvt::anyevent;
910		1027
911	=head2 The C<urxvt::anyevent> Class	1028	=head2 The C<urxvt::anyevent> Class
912		1029
913	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
914	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
915	further programming. The only exception is that you cannot wait on	1032	further programming. The only exception is that you cannot wait on
916	condition variables, but non-blocking condvar use is ok. What this means	1033	condition variables, but non-blocking condvar use is ok.
917	is that you cannot use blocking APIs, but the non-blocking variant should
918	work.
919		1034
920	=cut	1035	In practical terms this means is that you cannot use blocking APIs, but
		1036	the non-blocking variant should work.
921		1037
		1038	=cut
		1039
922	our $VERSION = 1;	1040	our $VERSION = '5.23';
923		1041
924	$INC{"urxvt/anyevent.pm"} = 1; # mark us as there	1042	$INC{"urxvt/anyevent.pm"} = 1; # mark us as there
925	push @AnyEvent::REGISTRY, [urxvt => urxvt::anyevent::];	1043	push @AnyEvent::REGISTRY, [urxvt => urxvt::anyevent::];
926		1044
927	sub timer {	1045	sub timer {
…		…
929		1047
930	my $cb = $arg{cb};	1048	my $cb = $arg{cb};
931		1049
932	urxvt::timer	1050	urxvt::timer
933	->new	1051	->new
934	->start (urxvt::NOW + $arg{after})	1052	->after ($arg{after}, $arg{interval})
935	->cb (sub {	1053	->cb ($arg{interval} ? $cb : sub {
936	$_[0]->stop; # need to cancel manually	1054	$_[0]->stop; # need to cancel manually
937	$cb->();	1055	$cb->();
938	})	1056	})
939	}	1057	}
940		1058
941	sub io {	1059	sub io {
942	my ($class, %arg) = @_;	1060	my ($class, %arg) = @_;
943		1061
944	my $cb = $arg{cb};	1062	my $cb = $arg{cb};
		1063	my $fd = fileno $arg{fh};
		1064	defined $fd or $fd = $arg{fh};
945		1065
946	bless [$arg{fh}, urxvt::iow	1066	bless [$arg{fh}, urxvt::iow
947	->new	1067	->new
948	->fd (fileno $arg{fh})	1068	->fd ($fd)
949	->events (($arg{poll} =~ /r/ ? 1 : 0)	1069	->events (($arg{poll} =~ /r/ ? 1 : 0)
950	| ($arg{poll} =~ /w/ ? 2 : 0))	1070	| ($arg{poll} =~ /w/ ? 2 : 0))
951	->start	1071	->start
952	->cb (sub {	1072	->cb ($cb)
953	$cb->(($_[1] & 1 ? 'r' : '')
954	. ($_[1] & 2 ? 'w' : ''));
955	})],
956	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	})
957	}	1099	}
958		1100
959	sub DESTROY {	1101	sub DESTROY {
960	$_[0][1]->stop;	1102	$_[0][1]->stop;
961	}	1103	}
962		1104
963	sub condvar {	1105	# only needed for AnyEvent < 6 compatibility
964	bless \my $flag, urxvt::anyevent::condvar::	1106	sub one_event {
965	}
966
967	sub urxvt::anyevent::condvar::broadcast {
968	${$_[0]}++;
969	}
970
971	sub urxvt::anyevent::condvar::wait {
972	unless (${$_[0]}) {
973	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";
974	}
975	}	1108	}
976		1109
977	package urxvt::term;	1110	package urxvt::term;
978		1111
979	=head2 The C<urxvt::term> Class	1112	=head2 The C<urxvt::term> Class
…		…
992	urxvt::verbose 6, "register package $pkg to $self";	1125	urxvt::verbose 6, "register package $pkg to $self";
993		1126
994	@{"$pkg\::ISA"} = urxvt::term::extension::;	1127	@{"$pkg\::ISA"} = urxvt::term::extension::;
995		1128
996	my $proxy = bless {	1129	my $proxy = bless {
997	_pkg => $pkg,	1130	_pkg => $pkg,
		1131	_name => ${"$pkg\::_NAME"}, # hackish
998	argv => $argv,	1132	argv => $argv,
999	}, $pkg;	1133	}, $pkg;
1000	Scalar::Util::weaken ($proxy->{term} = $self);	1134	Scalar::Util::weaken ($proxy->{term} = $self);
1001		1135
1002	$self->{_pkg}{$pkg} = $proxy;	1136	$self->{_pkg}{$pkg} = $proxy;
1003		1137
…		…
1006	$proxy->enable ($name => $ref);	1140	$proxy->enable ($name => $ref);
1007	}	1141	}
1008	}	1142	}
1009	}	1143	}
1010		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
1011	=item $term = new urxvt::term $envhashref, $rxvtname, [arg...]	1220	=item $term = new urxvt::term $envhashref, $rxvtname, [arg...]
1012		1221
1013	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
1014	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
1015	hash which defines the environment of the new terminal.	1224	hash which defines the environment of the new terminal.
1016		1225
1017	Croaks (and probably outputs an error message) if the new instance	1226	Croaks (and probably outputs an error message) if the new instance
1018	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
1019	initialise perl, and the terminal object otherwise. The C<init> and	1228	initialise perl, and the terminal object otherwise. The C<init> and
1020	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).
1021		1231
1022	=cut	1232	=cut
1023		1233
1024	sub new {	1234	sub new {
1025	my ($class, $env, @args) = @_;	1235	my ($class, $env, @args) = @_;
1026		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
1027	_new ([ map "$_=$env->{$_}", keys %$env ], @args);	1240	_new ([ map "$_=$env->{$_}", keys %$env ], \@args);
1028	}	1241	}
1029		1242
1030	=item $term->destroy	1243	=item $term->destroy
1031		1244
1032	Destroy the terminal object (close the window, free resources	1245	Destroy the terminal object (close the window, free resources
1033	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
1034	watchers (timers, io watchers) are still active.	1247	watchers (timers, io watchers) are still active.
1035		1248
1036	=item $term->exec_async ($cmd[, @args])	1249	=item $term->exec_async ($cmd[, @args])
1037		1250
1038	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
…		…
1062		1275
1063	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
1064	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
1065	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.
1066		1279
1067	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
1068	source file F</src/optinc.h> to see the actual list:	1281	source file F</src/optinc.h> to see the actual list:
1069		1282
1070	borderLess console cursorBlink cursorUnderline hold iconic insecure	1283	borderLess buffered console cursorBlink cursorUnderline hold iconic
1071	intensityStyles jumpScroll loginShell mapAlert meta8 mouseWheelScrollPage	1284	insecure intensityStyles iso14755 iso14755_52 jumpScroll loginShell
1072	override-redirect pastableTabs pointerBlank reverseVideo scrollBar	1285	mapAlert meta8 mouseWheelScrollPage override_redirect pastableTabs
1073	scrollBar_floating scrollBar_right scrollTtyKeypress scrollTtyOutput	1286	pointerBlank reverseVideo scrollBar scrollBar_floating scrollBar_right
1074	scrollWithBuffer secondaryScreen secondaryScroll skipBuiltinGlyphs	1287	scrollTtyKeypress scrollTtyOutput scrollWithBuffer secondaryScreen
1075	transparent tripleclickwords utmpInhibit visualBell	1288	secondaryScroll skipBuiltinGlyphs skipScroll transparent tripleclickwords
		1289	urgentOnBell utmpInhibit visualBell
1076		1290
1077	=item $value = $term->resource ($name[, $newval])	1291	=item $value = $term->resource ($name[, $newval])
1078		1292
1079	Returns the current resource value associated with a given name and	1293	Returns the current resource value associated with a given name and
1080	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>
…		…
1089	likely change).	1303	likely change).
1090		1304
1091	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
1092	terminal is destroyed, so changing options frequently will eat memory.	1306	terminal is destroyed, so changing options frequently will eat memory.
1093		1307
1094	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
1095	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>
1096	to see the actual list:	1310	to see the actual list:
1097		1311
1098	answerbackstring backgroundPixmap backspace_key boldFont boldItalicFont	1312	answerbackstring backgroundPixmap backspace_key blurradius
1099	borderLess color cursorBlink cursorUnderline cutchars delete_key	1313	boldFont boldItalicFont borderLess buffered chdir color cursorBlink
1100	display_name embed ext_bwidth fade font geometry hold iconName	1314	cursorUnderline cutchars delete_key depth display_name embed ext_bwidth
1101	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
1102	italicFont jumpScroll lineSpace loginShell mapAlert meta8 modifier	1317	jumpScroll letterSpace lineSpace loginShell mapAlert meta8 modifier
1103	mouseWheelScrollPage name override_redirect pastableTabs path perl_eval	1318	mouseWheelScrollPage name override_redirect pastableTabs path perl_eval
1104	perl_ext_1 perl_ext_2 perl_lib pointerBlank pointerBlankDelay	1319	perl_ext_1 perl_ext_2 perl_lib pointerBlank pointerBlankDelay
1105	preeditType print_pipe pty_fd reverseVideo saveLines scrollBar	1320	preeditType print_pipe pty_fd reverseVideo saveLines scrollBar
1106	scrollBar_align scrollBar_floating scrollBar_right scrollBar_thickness	1321	scrollBar_align scrollBar_floating scrollBar_right scrollBar_thickness
1107	scrollTtyKeypress scrollTtyOutput scrollWithBuffer scrollstyle	1322	scrollTtyKeypress scrollTtyOutput scrollWithBuffer scrollstyle
1108	secondaryScreen secondaryScroll selectstyle shade term_name title	1323	secondaryScreen secondaryScroll shade skipBuiltinGlyphs skipScroll
1109	transient_for transparent transparent_all tripleclickwords utmpInhibit	1324	term_name title transient_for transparent tripleclickwords urgentOnBell
1110	visualBell	1325	utmpInhibit visualBell
1111		1326
1112	=cut	1327	=cut
1113		1328
1114	sub resource($$;$) {	1329	sub resource($$;$) {
1115	my ($self, $name) = (shift, shift);	1330	my ($self, $name) = (shift, shift);
1116	unshift @_, $self, $name, ($name =~ s/\s*\+\s*(\d+)$// ? $1 : 0);	1331	unshift @_, $self, $name, ($name =~ s/\s*\+\s*(\d+)$// ? $1 : 0);
1117	&urxvt::term::_resource	1332	goto &urxvt::term::_resource
1118	}	1333	}
1119		1334
1120	=item $value = $term->x_resource ($pattern)	1335	=item $value = $term->x_resource ($pattern)
1121		1336
1122	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
1123	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
1124	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
1125	resource with that pattern exists.	1340	resource with that pattern exists.
1126		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
1127	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
1128	only one resource database per display, and later invocations might return	1353	only one resource database per display, and later invocations might return
1129	the wrong resources.	1354	the wrong resources.
1130		1355
1131	=item $success = $term->parse_keysym ($keysym_spec, $command_string)	1356	=item $value = $term->x_resource_boolean ($pattern)
1132		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
1133	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
1134	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	}
1135		1396
1136	=item $rend = $term->rstyle ([$new_rstyle])	1397	=item $rend = $term->rstyle ([$new_rstyle])
1137		1398
1138	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
1139	the terminal application will use this style.	1400	the terminal application will use this style.
…		…
1147		1408
1148	=item ($row, $col) = $term->selection_beg ([$row, $col])	1409	=item ($row, $col) = $term->selection_beg ([$row, $col])
1149		1410
1150	=item ($row, $col) = $term->selection_end ([$row, $col])	1411	=item ($row, $col) = $term->selection_end ([$row, $col])
1151		1412
1152	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.
1153	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.
1154		1422
1155	=item $term->selection_make ($eventtime[, $rectangular])	1423	=item $term->selection_make ($eventtime[, $rectangular])
1156		1424
1157	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
1158	C<selection_end>. If C<$rectangular> is true (default: false), a	1426	C<selection_end>. If C<$rectangular> is true (default: false), a
1159	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
1160	a selection.	1428	a selection.
1161		1429
1162	=item $success = $term->selection_grab ($eventtime)	1430	=item $success = $term->selection_grab ($eventtime[, $clipboard])
1163		1431
1164	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
1165	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
1166	is mostly useful from within C<on_sel_grab> hooks.	1435	is mostly useful from within C<on_sel_grab> hooks.
1167		1436
1168	=item $oldtext = $term->selection ([$newtext])	1437	=item $oldtext = $term->selection ([$newtext, $clipboard])
1169		1438
1170	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.
1171		1445
1172	=item $term->overlay_simple ($x, $y, $text)	1446	=item $term->overlay_simple ($x, $y, $text)
1173		1447
1174	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.
1175		1449
…		…
1205		1479
1206	The methods currently supported on C<urxvt::overlay> objects are:	1480	The methods currently supported on C<urxvt::overlay> objects are:
1207		1481
1208	=over 4	1482	=over 4
1209		1483
1210	=item $overlay->set ($x, $y, $text, $rend)	1484	=item $overlay->set ($x, $y, $text[, $rend])
1211		1485
1212	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
1213	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
1214	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.
1215		1491
1216	=item $overlay->hide	1492	=item $overlay->hide
1217		1493
1218	If visible, hide the overlay, but do not destroy it.	1494	If visible, hide the overlay, but do not destroy it.
1219		1495
…		…
1282		1558
1283	=item $term->scr_add_lines ($string)	1559	=item $term->scr_add_lines ($string)
1284		1560
1285	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
1286	running inside the terminal. It may not contain command sequences (escape	1562	running inside the terminal. It may not contain command sequences (escape
1287	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,
1288	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.
1289		1566
1290	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
1291	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
1292	C<on_add_lines> hook, though.	1569	C<on_add_lines> hook, though.
1293		1570
…		…
1301	locale-specific encoding of the terminal and can contain command sequences	1578	locale-specific encoding of the terminal and can contain command sequences
1302	(escape codes) that will be interpreted.	1579	(escape codes) that will be interpreted.
1303		1580
1304	=item $term->tt_write ($octets)	1581	=item $term->tt_write ($octets)
1305		1582
1306	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
1307	pass characters instead of octets, you should convert your strings first	1585	characters instead of octets, you should convert your strings first to the
1308	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.
1309		1601
1310	=item $old_events = $term->pty_ev_events ([$new_events])	1602	=item $old_events = $term->pty_ev_events ([$new_events])
1311		1603
1312	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
1313	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
…		…
1332	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
1333	to receive pointer events all the times:	1625	to receive pointer events all the times:
1334		1626
1335	$term->vt_emask_add (urxvt::PointerMotionMask);	1627	$term->vt_emask_add (urxvt::PointerMotionMask);
1336		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
1337	=item $window_width = $term->width	1643	=item $window_width = $term->width ([$new_value])
1338		1644
1339	=item $window_height = $term->height	1645	=item $window_height = $term->height ([$new_value])
1340		1646
1341	=item $font_width = $term->fwidth	1647	=item $font_width = $term->fwidth ([$new_value])
1342		1648
1343	=item $font_height = $term->fheight	1649	=item $font_height = $term->fheight ([$new_value])
1344		1650
1345	=item $font_ascent = $term->fbase	1651	=item $font_ascent = $term->fbase ([$new_value])
1346		1652
1347	=item $terminal_rows = $term->nrow	1653	=item $terminal_rows = $term->nrow ([$new_value])
1348		1654
1349	=item $terminal_columns = $term->ncol	1655	=item $terminal_columns = $term->ncol ([$new_value])
1350		1656
1351	=item $has_focus = $term->focus	1657	=item $has_focus = $term->focus ([$new_value])
1352		1658
1353	=item $is_mapped = $term->mapped	1659	=item $is_mapped = $term->mapped ([$new_value])
1354		1660
1355	=item $max_scrollback = $term->saveLines	1661	=item $max_scrollback = $term->saveLines ([$new_value])
1356		1662
1357	=item $nrow_plus_saveLines = $term->total_rows	1663	=item $nrow_plus_saveLines = $term->total_rows ([$new_value])
1358		1664
1359	=item $topmost_scrollback_row = $term->top_row	1665	=item $topmost_scrollback_row = $term->top_row ([$new_value])
1360		1666
1361	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.
1362		1669
1363	=item $x_display = $term->display_id	1670	=item $x_display = $term->display_id
1364		1671
1365	Return the DISPLAY used by rxvt-unicode.	1672	Return the DISPLAY used by rxvt-unicode.
1366		1673
…		…
1371	=item $env = $term->env	1678	=item $env = $term->env
1372		1679
1373	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
1374	similar to C<\%ENV>.	1681	similar to C<\%ENV>.
1375		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
1376	=cut	1692	=cut
1377		1693
1378	sub env {	1694	sub env {
1379	if (my $env = $_[0]->_env) {
1380	+{ map /^([^=]+)(?:=(.*))?$/s && ($1 => $2), @$env }	1695	+{ map /^([^=]+)(?:=(.*))?$/s && ($1 => $2), $_[0]->envv }
1381	} else {
1382	+{ %ENV }
1383	}
1384	}	1696	}
1385		1697
1386	=item $modifiermask = $term->ModLevel3Mask	1698	=item $modifiermask = $term->ModLevel3Mask
1387		1699
1388	=item $modifiermask = $term->ModMetaMask	1700	=item $modifiermask = $term->ModMetaMask
…		…
1396		1708
1397	Returns the currently displayed screen (0 primary, 1 secondary).	1709	Returns the currently displayed screen (0 primary, 1 secondary).
1398		1710
1399	=item $cursor_is_hidden = $term->hidden_cursor	1711	=item $cursor_is_hidden = $term->hidden_cursor
1400		1712
1401	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	}
1402		1724
1403	=item $view_start = $term->view_start ([$newvalue])	1725	=item $view_start = $term->view_start ([$newvalue])
1404		1726
1405	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
1406	C<0>, which displays the normal terminal contents. Lower values scroll	1728	C<0>, which displays the normal terminal contents. Lower values scroll
…		…
1412	compare the on-screen display with its stored representation. If they	1734	compare the on-screen display with its stored representation. If they
1413	differ, it redraws the differences.	1735	differ, it redraws the differences.
1414		1736
1415	Used after changing terminal contents to display them.	1737	Used after changing terminal contents to display them.
1416		1738
		1739	=item $term->refresh_check
		1740
		1741	Checks if a refresh has been requested and, if so, schedules one.
		1742
1417	=item $text = $term->ROW_t ($row_number[, $new_text[, $start_col]])	1743	=item $text = $term->ROW_t ($row_number[, $new_text[, $start_col]])
1418		1744
1419	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 >>
1420	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
1421	terminal line. The scrollback buffer starts at line C<-1> and extends to
1422	line C<< -$term->nsaved >>. Nothing will be returned if a nonexistent line	1747	terminal line. Nothing will be returned if a nonexistent line
1423	is requested.	1748	is requested.
1424		1749
1425	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
1426	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
1427	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
1428	automatically be updated.	1753	automatically be updated.
1429		1754
1430	C<$text> is in a special encoding: tabs and wide characters that use more	1755	C<$text> is in a special encoding: tabs and wide characters that use more
1431	than one cell when displayed are padded with C<$urxvt::NOCHAR> (chr 65535)	1756	than one cell when displayed are padded with C<$urxvt::NOCHAR> (chr 65535)
1432	characters. Characters with combining characters and other characters that	1757	characters. Characters with combining characters and other characters that
1433	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
1434	in the private use area.	1759	in the private use area.
1435		1760
1436	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
1437	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
1438	characters.	1763	characters.
…		…
1523	}	1848	}
1524		1849
1525	sub urxvt::line::t {	1850	sub urxvt::line::t {
1526	my ($self) = @_;	1851	my ($self) = @_;
1527		1852
1528	if (@_ > 1)	1853	if (@_ > 1) {
1529	{
1530	$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})
1531	for $self->{beg} .. $self->{end};	1855	for $self->{beg} .. $self->{end};
1532	}	1856	}
1533		1857
1534	defined wantarray &&	1858	defined wantarray &&
1535	substr +(join "", map $self->{term}->ROW_t ($_), $self->{beg} .. $self->{end}),	1859	substr +(join "", map $self->{term}->ROW_t ($_), $self->{beg} .. $self->{end}),
1536	0, $self->{len}	1860	0, $self->{len}
1537	}	1861	}
1538		1862
1539	sub urxvt::line::r {	1863	sub urxvt::line::r {
1540	my ($self) = @_;	1864	my ($self) = @_;
1541		1865
1542	if (@_ > 1)	1866	if (@_ > 1) {
1543	{
1544	$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})
1545	for $self->{beg} .. $self->{end};	1868	for $self->{beg} .. $self->{end};
1546	}	1869	}
1547		1870
1548	if (defined wantarray) {	1871	if (defined wantarray) {
1549	my $rend = [	1872	my $rend = [
1550	map @{ $self->{term}->ROW_r ($_) }, $self->{beg} .. $self->{end}	1873	map @{ $self->{term}->ROW_r ($_) }, $self->{beg} .. $self->{end}
1551	];	1874	];
…		…
1583	where one character corresponds to one screen cell. See	1906	where one character corresponds to one screen cell. See
1584	C<< $term->ROW_t >> for details.	1907	C<< $term->ROW_t >> for details.
1585		1908
1586	=item $string = $term->special_decode $text	1909	=item $string = $term->special_decode $text
1587		1910
1588	Converts rxvt-unicodes text reprsentation into a perl string. See	1911	Converts rxvt-unicodes text representation into a perl string. See
1589	C<< $term->ROW_t >> for details.	1912	C<< $term->ROW_t >> for details.
1590		1913
1591	=item $success = $term->grab_button ($button, $modifiermask)	1914	=item $success = $term->grab_button ($button, $modifiermask[, $window = $term->vt])
1592		1915
		1916	=item $term->ungrab_button ($button, $modifiermask[, $window = $term->vt])
		1917
1593	Registers a synchronous button grab. See the XGrabButton manpage.	1918	Register/unregister a synchronous button grab. See the XGrabButton
		1919	manpage.
1594		1920
1595	=item $success = $term->grab ($eventtime[, $sync])	1921	=item $success = $term->grab ($eventtime[, $sync])
1596		1922
1597	Calls XGrabPointer and XGrabKeyboard in asynchronous (default) or	1923	Calls XGrabPointer and XGrabKeyboard in asynchronous (default) or
1598	synchronous (C<$sync> is true). Also remembers the grab timestampe.	1924	synchronous (C<$sync> is true). Also remembers the grab timestamp.
1599		1925
1600	=item $term->allow_events_async	1926	=item $term->allow_events_async
1601		1927
1602	Calls XAllowEvents with AsyncBoth for the most recent grab.	1928	Calls XAllowEvents with AsyncBoth for the most recent grab.
1603		1929
…		…
1610	Calls XAllowEvents with both ReplayPointer and ReplayKeyboard for the most	1936	Calls XAllowEvents with both ReplayPointer and ReplayKeyboard for the most
1611	recent grab.	1937	recent grab.
1612		1938
1613	=item $term->ungrab	1939	=item $term->ungrab
1614		1940
1615	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
1616	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
1617	the session.	1943	the session.
1618		1944
1619	=item $atom = $term->XInternAtom ($atom_name[, $only_if_exists])	1945	=item $atom = $term->XInternAtom ($atom_name[, $only_if_exists])
1620		1946
…		…
1622		1948
1623	=item @atoms = $term->XListProperties ($window)	1949	=item @atoms = $term->XListProperties ($window)
1624		1950
1625	=item ($type,$format,$octets) = $term->XGetWindowProperty ($window, $property)	1951	=item ($type,$format,$octets) = $term->XGetWindowProperty ($window, $property)
1626		1952
1627	=item $term->XChangeWindowProperty ($window, $property, $type, $format, $octets)	1953	=item $term->XChangeProperty ($window, $property, $type, $format, $octets)
1628		1954
1629	=item $term->XDeleteProperty ($window, $property)	1955	=item $term->XDeleteProperty ($window, $property)
1630		1956
1631	=item $window = $term->DefaultRootWindow	1957	=item $window = $term->DefaultRootWindow
1632		1958
…		…
1639	=item $term->XMoveResizeWindow ($window, $x, $y, $width, $height)	1965	=item $term->XMoveResizeWindow ($window, $x, $y, $width, $height)
1640		1966
1641	=item ($x, $y, $child_window) = $term->XTranslateCoordinates ($src, $dst, $x, $y)	1967	=item ($x, $y, $child_window) = $term->XTranslateCoordinates ($src, $dst, $x, $y)
1642		1968
1643	=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)
1644		1974
1645	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
1646	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
1647	directory onto the X functions of the same name.	1977	directly onto the X functions of the same name.
1648		1978
1649	=back	1979	=back
1650		1980
1651	=cut	1981	=cut
1652		1982
…		…
1716	my ($self, $text, $cb) = @_;	2046	my ($self, $text, $cb) = @_;
1717		2047
1718	$self->add_item ({ type => "button", text => $text, activate => $cb});	2048	$self->add_item ({ type => "button", text => $text, activate => $cb});
1719	}	2049	}
1720		2050
1721	=item $popup->add_toggle ($text, $cb, $initial_value)	2051	=item $popup->add_toggle ($text, $initial_value, $cb)
1722		2052
1723	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
1724	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
1725	argument.	2055	first argument.
1726		2056
1727	=cut	2057	=cut
1728		2058
1729	sub add_toggle {	2059	sub add_toggle {
1730	my ($self, $text, $cb, $value) = @_;	2060	my ($self, $text, $value, $cb) = @_;
1731		2061
1732	my $item; $item = {	2062	my $item; $item = {
1733	type => "button",	2063	type => "button",
1734	text => " $text",	2064	text => " $text",
1735	value => $value,	2065	value => $value,
…		…
1754	my $env = $self->{term}->env;	2084	my $env = $self->{term}->env;
1755	# 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.
1756	delete $env->{LC_ALL};	2086	delete $env->{LC_ALL};
1757	$env->{LC_CTYPE} = $self->{term}->locale;	2087	$env->{LC_CTYPE} = $self->{term}->locale;
1758		2088
1759	urxvt::term->new ($env, "popup",	2089	my $term = urxvt::term->new (
		2090	$env, "popup",
1760	"--perl-lib" => "", "--perl-ext-common" => "",	2091	"--perl-lib" => "", "--perl-ext-common" => "",
1761	"-pty-fd" => -1, "-sl" => 0,	2092	"-pty-fd" => -1, "-sl" => 0,
1762	"-b" => 1, "-bd" => "grey80", "-bl", "-override-redirect",	2093	"-b" => 1, "-bd" => "grey80", "-bl", "-override-redirect",
1763	"--transient-for" => $self->{term}->parent,	2094	"--transient-for" => $self->{term}->parent,
1764	"-display" => $self->{term}->display_id,	2095	"-display" => $self->{term}->display_id,
1765	"-pe" => "urxvt-popup")	2096	"-pe" => "urxvt-popup",
1766	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	}
1767	}	2104	}
1768		2105
1769	sub DESTROY {	2106	sub DESTROY {
1770	my ($self) = @_;	2107	my ($self) = @_;
1771		2108
…		…
1776	=back	2113	=back
1777		2114
1778	=cut	2115	=cut
1779		2116
1780	package urxvt::watcher;	2117	package urxvt::watcher;
1781
1782	@urxvt::timer::ISA = __PACKAGE__;
1783	@urxvt::iow::ISA = __PACKAGE__;
1784	@urxvt::pw::ISA = __PACKAGE__;
1785	@urxvt::iw::ISA = __PACKAGE__;
1786		2118
1787	=head2 The C<urxvt::timer> Class	2119	=head2 The C<urxvt::timer> Class
1788		2120
1789	This class implements timer watchers/events. Time is represented as a	2121	This class implements timer watchers/events. Time is represented as a
1790	fractional number of seconds since the epoch. Example:	2122	fractional number of seconds since the epoch. Example:
…		…
1794	->new	2126	->new
1795	->interval (1)	2127	->interval (1)
1796	->cb (sub {	2128	->cb (sub {
1797	$term->{overlay}->set (0, 0,	2129	$term->{overlay}->set (0, 0,
1798	sprintf "%2d:%02d:%02d", (localtime urxvt::NOW)[2,1,0]);	2130	sprintf "%2d:%02d:%02d", (localtime urxvt::NOW)[2,1,0]);
1799	});	2131	});
1800		2132
1801	=over 4	2133	=over 4
1802		2134
1803	=item $timer = new urxvt::timer	2135	=item $timer = new urxvt::timer
1804		2136
…		…
1807		2139
1808	=item $timer = $timer->cb (sub { my ($timer) = @_; ... })	2140	=item $timer = $timer->cb (sub { my ($timer) = @_; ... })
1809		2141
1810	Set the callback to be called when the timer triggers.	2142	Set the callback to be called when the timer triggers.
1811		2143
1812	=item $tstamp = $timer->at
1813
1814	Return the time this watcher will fire next.
1815
1816	=item $timer = $timer->set ($tstamp)	2144	=item $timer = $timer->set ($tstamp[, $interval])
1817		2145
1818	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).
1819		2148
1820	=item $timer = $timer->interval ($interval)	2149	=item $timer = $timer->interval ($interval)
1821		2150
1822	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
1823	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
1824	is automatically rescheduled at the given intervals.	2153	is automatically rescheduled at the given intervals.
1825		2154
1826	=item $timer = $timer->start	2155	=item $timer = $timer->start
1827		2156
1828	Start the timer.	2157	Start the timer.
1829		2158
1830	=item $timer = $timer->start ($tstamp)	2159	=item $timer = $timer->start ($tstamp[, $interval])
1831		2160
1832	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.
1833		2163
1834	=item $timer = $timer->after ($delay)	2164	=item $timer = $timer->after ($delay[, $interval])
1835		2165
1836	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>.
1837		2167
1838	=item $timer = $timer->stop	2168	=item $timer = $timer->stop
1839		2169
…		…
1847		2177
1848	$term->{socket} = ...	2178	$term->{socket} = ...
1849	$term->{iow} = urxvt::iow	2179	$term->{iow} = urxvt::iow
1850	->new	2180	->new
1851	->fd (fileno $term->{socket})	2181	->fd (fileno $term->{socket})
1852	->events (urxvt::EVENT_READ)	2182	->events (urxvt::EV_READ)
1853	->start	2183	->start
1854	->cb (sub {	2184	->cb (sub {
1855	my ($iow, $revents) = @_;	2185	my ($iow, $revents) = @_;
1856	# $revents must be 1 here, no need to check	2186	# $revents must be 1 here, no need to check
1857	sysread $term->{socket}, my $buf, 8192	2187	sysread $term->{socket}, my $buf, 8192
…		…
1870	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>
1871	is a bitset as described in the C<events> method.	2201	is a bitset as described in the C<events> method.
1872		2202
1873	=item $iow = $iow->fd ($fd)	2203	=item $iow = $iow->fd ($fd)
1874		2204
1875	Set the filedescriptor (not handle) to watch.	2205	Set the file descriptor (not handle) to watch.
1876		2206
1877	=item $iow = $iow->events ($eventmask)	2207	=item $iow = $iow->events ($eventmask)
1878		2208
1879	Set the event mask to watch. The only allowed values are	2209	Set the event mask to watch. The only allowed values are
1880	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
1881	together, or C<urxvt::EVENT_NONE>.	2211	together, or C<urxvt::EV_NONE>.
1882		2212
1883	=item $iow = $iow->start	2213	=item $iow = $iow->start
1884		2214
1885	Start watching for requested events on the given handle.	2215	Start watching for requested events on the given handle.
1886		2216
1887	=item $iow = $iow->stop	2217	=item $iow = $iow->stop
1888		2218
1889	Stop watching for events on the given filehandle.	2219	Stop watching for events on the given file handle.
1890		2220
1891	=back	2221	=back
1892		2222
1893	=head2 The C<urxvt::iw> Class	2223	=head2 The C<urxvt::iw> Class
1894		2224
…		…
1927	->new	2257	->new
1928	->start ($pid)	2258	->start ($pid)
1929	->cb (sub {	2259	->cb (sub {
1930	my ($pw, $exit_status) = @_;	2260	my ($pw, $exit_status) = @_;
1931	...	2261	...
1932	});	2262	});
1933		2263
1934	=over 4	2264	=over 4
1935		2265
1936	=item $pw = new urxvt::pw	2266	=item $pw = new urxvt::pw
1937		2267
…		…
1941		2271
1942	Set the callback to be called when the timer triggers.	2272	Set the callback to be called when the timer triggers.
1943		2273
1944	=item $pw = $timer->start ($pid)	2274	=item $pw = $timer->start ($pid)
1945		2275
1946	Tells the wqtcher to start watching for process C<$pid>.	2276	Tells the watcher to start watching for process C<$pid>.
1947		2277
1948	=item $pw = $pw->stop	2278	=item $pw = $pw->stop
1949		2279
1950	Stop the watcher.	2280	Stop the watcher.
1951		2281
…		…
1964		2294
1965	=item >= 3 - script loading and management	2295	=item >= 3 - script loading and management
1966		2296
1967	=item >=10 - all called hooks	2297	=item >=10 - all called hooks
1968		2298
1969	=item >=11 - hook reutrn values	2299	=item >=11 - hook return values
1970		2300
1971	=back	2301	=back
1972		2302
1973	=head1 AUTHOR	2303	=head1 AUTHOR
1974		2304
1975	Marc Lehmann <pcg@goof.com>	2305	Marc Lehmann <schmorp@schmorp.de>
1976	http://software.schmorp.de/pkg/rxvt-unicode	2306	http://software.schmorp.de/pkg/rxvt-unicode
1977		2307
1978	=cut	2308	=cut
1979		2309
1980	1	2310	1
		2311
		2312	# vim: sw=3:

Diff Legend

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