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

Diff Legend

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