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.216 by root, Sun Jun 10 13:32:55 2012 UTC vs.
Revision 1.267 by sf-exg, Sat Jul 24 12:17:08 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	Every time 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 "vars"' and 'use utf8' environment, and	25	Scripts are compiled in a 'use strict qw(vars subs)' and 'use utf8'
26	thus must be encoded as UTF-8.	26	environment, and 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"	31	You can disable the embedded perl interpreter by setting both "perl-ext"
32	and "perl-ext-common" resources to the empty string.	32	and "perl-ext-common" resources to the empty string.
33		33
34	=head1 PREPACKAGED EXTENSIONS	34	=head1 PREPACKAGED EXTENSIONS
35		35
36	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
37	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> >>.
38		39
39	You can activate them like this:	40	You can activate them like this:
40		41
41	@@RXVT_NAME@@ -pe <extensionname>	42	urxvt -pe <extensionname>
42		43
43	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:
44		45
45	URxvt.perl-ext-common: default,selection-autotransform	46	URxvt.perl-ext-common: default,selection-autotransform
46		47
47	=over 4	48	Extensions may add additional resources and C<actions>, i.e., methods
48		49	which can be bound to a key and invoked by the user. An extension can
49	=item selection (enabled by default)	50	define the resources it support using so called META comments,
50		51	described below. Similarly to builtin resources, extension resources
51	(More) intelligent selection. This extension tries to be more intelligent	52	can also be specified on the command line as long options (with C<.>
52	when the user extends selections (double-click and further clicks). Right	53	replaced by C<->), in which case the corresponding extension is loaded
53	now, it tries to select words, urls and complete shell-quoted	54	automatically. For this to work the extension B<must> define META
54	arguments, which is very convenient, too, if your F<ls> supports	55	comments for its resources.
55	C<--quoting-style=shell>.
56
57	A double-click usually selects the word under the cursor, further clicks
58	will enlarge the selection.
59
60	The selection works by trying to match a number of regexes and displaying
61	them in increasing order of length. You can add your own regexes by
62	specifying resources of the form:
63
64	URxvt.selection.pattern-0: perl-regex
65	URxvt.selection.pattern-1: perl-regex
66	...
67
68	The index number (0, 1...) must not have any holes, and each regex must
69	contain at least one pair of capturing parentheses, which will be used for
70	the match. For example, the following adds a regex that matches everything
71	between two vertical bars:
72
73	URxvt.selection.pattern-0: \\|([^|]+)\\|
74
75	Another example: Programs I use often output "absolute path: " at the
76	beginning of a line when they process multiple files. The following
77	pattern matches the filename (note, there is a single space at the very
78	end):
79
80	URxvt.selection.pattern-0: ^(/[^:]+):\
81
82	You can look at the source of the selection extension to see more
83	interesting uses, such as parsing a line from beginning to end.
84
85	This extension also offers following bindable keyboard commands:
86
87	=over 4
88
89	=item rot13
90
91	Rot-13 the selection when activated. Used via keyboard trigger:
92
93	URxvt.keysym.C-M-r: perl:selection:rot13
94
95	=back
96
97	=item option-popup (enabled by default)
98
99	Binds a popup menu to Ctrl-Button2 that lets you toggle (some) options at
100	runtime.
101
102	Other extensions can extend this popup menu by pushing a code reference
103	onto C<@{ $term->{option_popup_hook} }>, which gets called whenever the
104	popup is being displayed.
105
106	Its sole argument is the popup menu, which can be modified. It should
107	either return nothing or a string, the initial boolean value and a code
108	reference. The string will be used as button text and the code reference
109	will be called when the toggle changes, with the new boolean value as
110	first argument.
111
112	The following will add an entry C<myoption> that changes
113	C<< $self->{myoption} >>:
114
115	push @{ $self->{term}{option_popup_hook} }, sub {
116	("my option" => $myoption, sub { $self->{myoption} = $_[0] })
117	};
118
119	=item selection-popup (enabled by default)
120
121	Binds a popup menu to Ctrl-Button3 that lets you convert the selection
122	text into various other formats/action (such as uri unescaping, perl
123	evaluation, web-browser starting etc.), depending on content.
124
125	Other extensions can extend this popup menu by pushing a code reference
126	onto C<@{ $term->{selection_popup_hook} }>, which gets called whenever the
127	popup is being displayed.
128
129	Its sole argument is the popup menu, which can be modified. The selection
130	is in C<$_>, which can be used to decide whether to add something or not.
131	It should either return nothing or a string and a code reference. The
132	string will be used as button text and the code reference will be called
133	when the button gets activated and should transform C<$_>.
134
135	The following will add an entry C<a to b> that transforms all C<a>s in
136	the selection to C<b>s, but only if the selection currently contains any
137	C<a>s:
138
139	push @{ $self->{term}{selection_popup_hook} }, sub {
140	/a/ ? ("a to b" => sub { s/a/b/g }
141	: ()
142	};
143
144	=item searchable-scrollback<hotkey> (enabled by default)
145
146	Adds regex search functionality to the scrollback buffer, triggered
147	by a hotkey (default: C<M-s>). While in search mode, normal terminal
148	input/output is suspended and a regex is displayed at the bottom of the
149	screen.
150
151	Inputting characters appends them to the regex and continues incremental
152	search. C<BackSpace> removes a character from the regex, C<Up> and C<Down>
153	search upwards/downwards in the scrollback buffer, C<End> jumps to the
154	bottom. C<Escape> leaves search mode and returns to the point where search
155	was started, while C<Enter> or C<Return> stay at the current position and
156	additionally stores the first match in the current line into the primary
157	selection if the C<Shift> modifier is active.
158
159	The regex defaults to "(?i)", resulting in a case-insensitive search. To
160	get a case-sensitive search you can delete this prefix using C<BackSpace>
161	or simply use an uppercase character which removes the "(?i)" prefix.
162
163	See L<perlre> for more info about perl regular expression syntax.
164
165	=item readline (enabled by default)
166
167	A support package that tries to make editing with readline easier. At
168	the moment, it reacts to clicking shift-left mouse button by trying to
169	move the text cursor to this position. It does so by generating as many
170	cursor-left or cursor-right keypresses as required (this only works
171	for programs that correctly support wide characters).
172
173	To avoid too many false positives, this is only done when:
174
175	=over 4
176
177	=item - the tty is in ICANON state.
178
179	=item - the text cursor is visible.
180
181	=item - the primary screen is currently being displayed.
182
183	=item - the mouse is on the same (multi-row-) line as the text cursor.
184
185	=back
186
187	The normal selection mechanism isn't disabled, so quick successive clicks
188	might interfere with selection creation in harmless ways.
189
190	=item selection-autotransform
191
192	This selection allows you to do automatic transforms on a selection
193	whenever a selection is made.
194
195	It works by specifying perl snippets (most useful is a single C<s///>
196	operator) that modify C<$_> as resources:
197
198	URxvt.selection-autotransform.0: transform
199	URxvt.selection-autotransform.1: transform
200	...
201
202	For example, the following will transform selections of the form
203	C<filename:number>, often seen in compiler messages, into C<vi +$filename
204	$word>:
205
206	URxvt.selection-autotransform.0: s/^([^:[:space:]]+):(\\d+):?$/vi +$2 \\Q$1\\E\\x0d/
207
208	And this example matches the same,but replaces it with vi-commands you can
209	paste directly into your (vi :) editor:
210
211	URxvt.selection-autotransform.0: s/^([^:[:space:]]+(\\d+):?$/:e \\Q$1\\E\\x0d:$2\\x0d/
212
213	Of course, this can be modified to suit your needs and your editor :)
214
215	To expand the example above to typical perl error messages ("XXX at
216	FILENAME line YYY."), you need a slightly more elaborate solution:
217
218	URxvt.selection.pattern-0: ( at .*? line \\d+[,.])
219	URxvt.selection-autotransform.0: s/^ at (.*?) line (\\d+)[,.]$/:e \\Q$1\E\\x0d:$2\\x0d/
220
221	The first line tells the selection code to treat the unchanging part of
222	every error message as a selection pattern, and the second line transforms
223	the message into vi commands to load the file.
224
225	=item tabbed
226
227	This transforms the terminal into a tabbar with additional terminals, that
228	is, it implements what is commonly referred to as "tabbed terminal". The topmost line
229	displays a "[NEW]" button, which, when clicked, will add a new tab, followed by one
230	button per tab.
231
232	Clicking a button will activate that tab. Pressing B<Shift-Left> and
233	B<Shift-Right> will switch to the tab left or right of the current one,
234	while B<Shift-Down> creates a new tab.
235
236	The tabbar itself can be configured similarly to a normal terminal, but
237	with a resource class of C<URxvt.tabbed>. In addition, it supports the
238	following four resources (shown with defaults):
239
240	URxvt.tabbed.tabbar-fg: <colour-index, default 3>
241	URxvt.tabbed.tabbar-bg: <colour-index, default 0>
242	URxvt.tabbed.tab-fg: <colour-index, default 0>
243	URxvt.tabbed.tab-bg: <colour-index, default 1>
244
245	See I<COLOR AND GRAPHICS> in the @@RXVT_NAME@@(1) manpage for valid
246	indices.
247
248	=item matcher
249
250	Uses per-line display filtering (C<on_line_update>) to underline text
251	matching a certain pattern and make it clickable. When clicked with the
252	mouse button specified in the C<matcher.button> resource (default 2, or
253	middle), the program specified in the C<matcher.launcher> resource
254	(default, the C<urlLauncher> resource, C<sensible-browser>) will be started
255	with the matched text as first argument. The default configuration is
256	suitable for matching URLs and launching a web browser, like the
257	former "mark-urls" extension.
258
259	The default pattern to match URLs can be overridden with the
260	C<matcher.pattern.0> resource, and additional patterns can be specified
261	with numbered patterns, in a manner similar to the "selection" extension.
262	The launcher can also be overridden on a per-pattern basis.
263
264	It is possible to activate the most recently seen match or a list of matches
265	from the keyboard. Simply bind a keysym to "perl:matcher:last" or
266	"perl:matcher:list" as seen in the example below.
267
268	Example configuration:
269
270	URxvt.perl-ext: default,matcher
271	URxvt.urlLauncher: sensible-browser
272	URxvt.keysym.C-Delete: perl:matcher:last
273	URxvt.keysym.M-Delete: perl:matcher:list
274	URxvt.matcher.button: 1
275	URxvt.matcher.pattern.1: \\bwww\\.[\\w-]+\\.[\\w./?&@#-]*[\\w/-]
276	URxvt.matcher.pattern.2: \\B(/\\S+?):(\\d+)(?=:|$)
277	URxvt.matcher.launcher.2: gvim +$2 $1
278
279	=item xim-onthespot
280
281	This (experimental) perl extension implements OnTheSpot editing. It does
282	not work perfectly, and some input methods don't seem to work well with
283	OnTheSpot editing in general, but it seems to work at least for SCIM and
284	kinput2.
285
286	You enable it by specifying this extension and a preedit style of
287	C<OnTheSpot>, i.e.:
288
289	@@RXVT_NAME@@ -pt OnTheSpot -pe xim-onthespot
290
291	=item kuake<hotkey>
292
293	A very primitive quake-console-like extension. It was inspired by a
294	description of how the programs C<kuake> and C<yakuake> work: Whenever the
295	user presses a global accelerator key (by default C<F10>), the terminal
296	will show or hide itself. Another press of the accelerator key will hide
297	or show it again.
298
299	Initially, the window will not be shown when using this extension.
300
301	This is useful if you need a single terminal that is not using any desktop
302	space most of the time but is quickly available at the press of a key.
303
304	The accelerator key is grabbed regardless of any modifiers, so this
305	extension will actually grab a physical key just for this function.
306
307	If you want a quake-like animation, tell your window manager to do so
308	(fvwm can do it).
309
310	=item overlay-osc
311
312	This extension implements some OSC commands to display timed popups on the
313	screen - useful for status displays from within scripts. You have to read
314	the sources for more info.
315
316	=item block-graphics-to-ascii
317
318	A not very useful example of filtering all text output to the terminal
319	by replacing all line-drawing characters (U+2500 .. U+259F) by a
320	similar-looking ascii character.
321
322	=item digital-clock
323
324	Displays a digital clock using the built-in overlay.
325
326	=item remote-clipboard
327
328	Somewhat of a misnomer, this extension adds two menu entries to the
329	selection popup that allows one to run external commands to store the
330	selection somewhere and fetch it again.
331
332	We use it to implement a "distributed selection mechanism", which just
333	means that one command uploads the file to a remote server, and another
334	reads it.
335
336	The commands can be set using the C<URxvt.remote-selection.store> and
337	C<URxvt.remote-selection.fetch> resources. The first should read the
338	selection to store from STDIN (always in UTF-8), the second should provide
339	the selection data on STDOUT (also in UTF-8).
340
341	The defaults (which are likely useless to you) use rsh and cat:
342
343	URxvt.remote-selection.store: rsh ruth 'cat >/tmp/distributed-selection'
344	URxvt.remote-selection.fetch: rsh ruth 'cat /tmp/distributed-selection'
345
346	=item selection-pastebin
347
348	This is a little rarely useful extension that uploads the selection as
349	textfile to a remote site (or does other things). (The implementation is
350	not currently secure for use in a multiuser environment as it writes to
351	F</tmp> directly.).
352
353	It listens to the C<selection-pastebin:remote-pastebin> keyboard command,
354	i.e.
355
356	URxvt.keysym.C-M-e: perl:selection-pastebin:remote-pastebin
357
358	Pressing this combination runs a command with C<%> replaced by the name of
359	the textfile. This command can be set via a resource:
360
361	URxvt.selection-pastebin.cmd: rsync -apP % ruth:/var/www/www.ta-sa.org/files/txt/.
362
363	And the default is likely not useful to anybody but the few people around
364	here :)
365
366	The name of the textfile is the hex encoded md5 sum of the selection, so
367	the same content should lead to the same filename.
368
369	After a successful upload the selection will be replaced by the text given
370	in the C<selection-pastebin-url> resource (again, the % is the placeholder
371	for the filename):
372
373	URxvt.selection-pastebin.url: http://www.ta-sa.org/files/txt/%
374
375	I<Note to xrdb users:> xrdb uses the C preprocessor, which might interpret
376	the double C</> characters as comment start. Use C<\057\057> instead,
377	which works regardless of whether xrdb is used to parse the resource file
378	or not.
379
380	=item macosx-clipboard and macosx-clipboard-native
381
382	These two modules implement an extended clipboard for Mac OS X. They are
383	used like this:
384
385	URxvt.perl-ext-common: default,macosx-clipboard
386	URxvt.keysym.M-c: perl:macosx-clipboard:copy
387	URxvt.keysym.M-v: perl:macosx-clipboard:paste
388
389	The difference between them is that the native variant requires a
390	perl from apple's devkit or so, and C<macosx-clipboard> requires the
391	C<Mac::Pasteboard> module, works with other perls, has fewer bugs, is
392	simpler etc. etc.
393
394	=item example-refresh-hooks
395
396	Displays a very simple digital clock in the upper right corner of the
397	window. Illustrates overwriting the refresh callbacks to create your own
398	overlays or changes.
399
400	=item confirm-paste
401
402	Displays a confirmation dialog when a paste containing at least a full
403	line is detected.
404
405	=item bell-command
406
407	Runs the command specified by the C<URxvt.bell-command> resource when
408	a bell event occurs. For example, the following pops up a notification
409	bubble with the text "Beep, Beep" using notify-send:
410
411	URxvt.bell-command: notify-send "Beep, Beep"
412
413	=back
414		56
415	=head1 API DOCUMENTATION	57	=head1 API DOCUMENTATION
416		58
417	=head2 General API Considerations	59	=head2 General API Considerations
418		60
…		…
428	terminal is destroyed.	70	terminal is destroyed.
429		71
430	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
431	hints on what they mean:	73	hints on what they mean:
432		74
433	=over 4	75	=over
434		76
435	=item $text	77	=item $text
436		78
437	Rxvt-unicode's special way of encoding text, where one "unicode" character	79	Rxvt-unicode's special way of encoding text, where one "unicode" character
438	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.
…		…
467	internal use.	109	internal use.
468		110
469	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
470	C<urxvt::term> class on this object.	112	C<urxvt::term> class on this object.
471		113
472	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.
473		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 these comments below. Individual components are
		125	separated by colons (C<:>), and should not contain colons themselves -
		126	there is also currently no escaping mechanism provided for this.
		127
474	=over 4	128	=over
475		129
476	=item $urxvt_term = $self->{term}	130	=item #:META:RESOURCE:name:type:desc
477		131
478	Returns the C<urxvt::term> object associated with this instance of the	132	The RESOURCE comment defines a resource used by the extension, where
479	extension. This member I<must not> be changed in any way.	133	C<name> is the resource name, C<type> is the resource type, C<boolean>
		134	or C<string>, and C<desc> is the resource description.
480		135
481	=item $self->enable ($hook_name => $cb, [$hook_name => $cb..])	136	The extension will be autoloaded when this resource is specified or used
		137	as a command line parameter.
482		138
483	Dynamically enable the given hooks (named without the C<on_> prefix) for	139	Example: matcher provides the C<matcher.launcher> resource by having this
484	this extension, replacing any previous hook. This is useful when you want	140	comment:
485	to overwrite time-critical hooks only temporarily.
486		141
487	=item $self->disable ($hook_name[, $hook_name..])	142	#:META:RESOURCE:%.launcher:string:default launcher command
488		143
489	Dynamically disable the given hooks.	144	Example: load this extension when the C<-tr> command line option or
		145	resource name is used.
		146
		147	#:META:RESOURCE:tr:boolean:set root pixmap as background
		148
		149	=item #:META:OSC:number:desc
		150
		151	The OSC comment specifies an OSC sequence, where C<number> is the
		152	numerical OSC code and C<desc> is a short description that is currently
		153	unused.
		154
		155	This will cause the extension to be autoloaded when the OSC sequence is
		156	used for the first time.
		157
		158	Note that autoloading carries some extra responsibilities with it:
		159	although the terminal cannot really protect itself against malicious
		160	sources of command sequences, therefore relying on the programs running
		161	I<inside> to sanitize data that they output, it is very common for
		162	programs to emit command sequences from untrusted sources.
		163
		164	While this means that extensions should, as a defense-in-depth mechanism,
		165	always consider whether OSC sequences are safe, autoloading automatically
		166	exposes any autoloaded extension in all terminal windows, so extra care
		167	should be taken.
		168
		169	Example: the background extension registers OSC C<20> like this:
		170
		171	#:META:OSC:20:change/query background image
		172
		173	=item #:META:OSC_PERL:prefix:desc
		174
		175	The same as the OSC comment, but for the Perl OSC sequence (C<777>). The
		176	C<prefix> should be unique among extensions, of course, which is most
		177	easily arranged by using the extension name, although this is not
		178	required.
		179
		180	Example: the overlay-osc extension registers its Perl OSC like this:
		181
		182	#:META:OSC_PERL:overlay:man overlay-osc
490		183
491	=back	184	=back
492		185
493	=head2 Hooks	186	=head2 Hooks
494		187
…		…
502	hooks returns true, then the event counts as being I<consumed>, and the	195	hooks returns true, then the event counts as being I<consumed>, and the
503	relevant action might not be carried out by the C++ code.	196	relevant action might not be carried out by the C++ code.
504		197
505	I<< When in doubt, return a false value (preferably C<()>). >>	198	I<< When in doubt, return a false value (preferably C<()>). >>
506		199
507	=over 4	200	=over
508		201
509	=item on_init $term	202	=item on_init $term
510		203
511	Called after a new terminal object has been initialized, but before	204	Called after a new terminal object has been initialized, but before
512	windows are created or the command gets run. Most methods are unsafe to	205	windows are created or the command gets run. Most methods are unsafe to
…		…
594		287
595	C<on_osc_seq_perl> should be used for new behaviour.	288	C<on_osc_seq_perl> should be used for new behaviour.
596		289
597	=item on_osc_seq_perl $term, $args, $resp	290	=item on_osc_seq_perl $term, $args, $resp
598		291
599	Called whenever the B<ESC ] 777 ; string ST> command sequence (OSC =	292	Called whenever the B<ESC ] 777 ; prefix ; string ST> command sequence
600	operating system command) is processed. Cursor position and other state	293	(OSC = operating system command) is processed. Cursor position and other
601	information is up-to-date when this happens. For interoperability, the	294	state information is up-to-date when this happens. For interoperability,
602	string should start with the extension name (sans -osc) and a semicolon,	295	the argument should start with the extension name (sans -osc) or some
603	to distinguish it from commands for other extensions, and this might be	296	other suitable prefix, and a semicolon, to distinguish it from commands
604	enforced in the future.	297	for other extensions.
605		298
606	For example, C<overlay-osc> uses this:	299	For example, C<overlay-osc> uses this:
607		300
608	sub on_osc_seq_perl {	301	sub on_osc_seq_perl {
609	my ($self, $osc, $resp) = @_;	302	my ($self, $osc, $resp) = @_;
…		…
663		356
664	=item on_refresh_end $term	357	=item on_refresh_end $term
665		358
666	Called just after the screen gets redrawn. See C<on_refresh_begin>.	359	Called just after the screen gets redrawn. See C<on_refresh_begin>.
667		360
		361	=item on_action $term, $string
		362
		363	Called whenever an action is invoked for the corresponding extension
		364	(e.g. via a C<extension:string> builtin action bound to a key, see
		365	description of the B<keysym> resource in the urxvt(1) manpage). The
		366	event is simply the action string. Note that an action event is always
		367	associated to a single extension.
		368
668	=item on_user_command $term, $string	369	=item on_user_command $term, $string *DEPRECATED*
669		370
670	Called whenever a user-configured event is being activated (e.g. via	371	Called whenever a user-configured event is being activated (e.g. via
671	a C<perl:string> action bound to a key, see description of the B<keysym>	372	a C<perl:string> action bound to a key, see description of the B<keysym>
672	resource in the @@RXVT_NAME@@(1) manpage).	373	resource in the urxvt(1) manpage).
673		374
674	The event is simply the action string. This interface is assumed to change	375	The event is simply the action string. This interface is going away in
675	slightly in the future.	376	preference to the C<on_action> hook.
676
677	=item on_register_command $term, $keysym, $modifiermask, $string
678
679	Called after parsing a keysym resource but before registering the
680	associated binding. If this hook returns TRUE the binding is not
681	registered. It can be used to modify a binding by calling
682	C<register_command>.
683		377
684	=item on_resize_all_windows $term, $new_width, $new_height	378	=item on_resize_all_windows $term, $new_width, $new_height
685		379
686	Called just after the new window size has been calculated, but before	380	Called just after the new window size has been calculated, but before
687	windows are actually being resized or hints are being set. If this hook	381	windows are actually being resized or hints are being set. If this hook
688	returns TRUE, setting of the window hints is being skipped.	382	returns a true value, setting of the window hints is being skipped.
689		383
690	=item on_x_event $term, $event	384	=item on_x_event $term, $event
691		385
692	Called on every X event received on the vt window (and possibly other	386	Called on every X event received on the vt window (and possibly other
693	windows). Should only be used as a last resort. Most event structure	387	windows). Should only be used as a last resort. Most event structure
…		…
733	(real, not screen-based) row and column under the mouse cursor.	427	(real, not screen-based) row and column under the mouse cursor.
734		428
735	C<on_key_press> additionally receives the string rxvt-unicode would	429	C<on_key_press> additionally receives the string rxvt-unicode would
736	output, if any, in locale-specific encoding.	430	output, if any, in locale-specific encoding.
737		431
738	subwindow.
739
740	=item on_client_message $term, $event	432	=item on_client_message $term, $event
741		433
742	=item on_wm_protocols $term, $event	434	=item on_wm_protocols $term, $event
743		435
744	=item on_wm_delete_window $term, $event	436	=item on_wm_delete_window $term, $event
…		…
755	=cut	447	=cut
756		448
757	package urxvt;	449	package urxvt;
758		450
759	use utf8;	451	use utf8;
760	use strict 'vars';	452	use strict qw(vars subs);
761	use Carp ();	453	use Carp ();
762	use Scalar::Util ();	454	use Scalar::Util ();
763	use List::Util ();	455	use List::Util ();
764		456
765	our $VERSION = 1;	457	our $VERSION = 1;
…		…
777		469
778	our $NOCHAR = chr 0xffff;	470	our $NOCHAR = chr 0xffff;
779		471
780	=head2 Variables in the C<urxvt> Package	472	=head2 Variables in the C<urxvt> Package
781		473
782	=over 4	474	=over
783		475
784	=item $urxvt::LIBDIR	476	=item $urxvt::LIBDIR
785		477
786	The rxvt-unicode library directory, where, among other things, the perl	478	The rxvt-unicode library directory, where, among other things, the perl
787	modules and scripts are stored.	479	modules and scripts are stored.
…		…
817		509
818	=back	510	=back
819		511
820	=head2 Functions in the C<urxvt> Package	512	=head2 Functions in the C<urxvt> Package
821		513
822	=over 4	514	=over
823		515
824	=item urxvt::fatal $errormessage	516	=item urxvt::fatal $errormessage
825		517
826	Fatally aborts execution with the given error message (which should	518	Fatally aborts execution with the given error message (which should
827	include a trailing newline). Avoid at all costs! The only time this	519	include a trailing newline). Avoid at all costs! The only time this
…		…
872	CirculateRequest, PropertyNotify, SelectionClear, SelectionRequest,	564	CirculateRequest, PropertyNotify, SelectionClear, SelectionRequest,
873	SelectionNotify, ColormapNotify, ClientMessage, MappingNotify	565	SelectionNotify, ColormapNotify, ClientMessage, MappingNotify
874		566
875	Various constants for use in X calls and event processing.	567	Various constants for use in X calls and event processing.
876		568
		569	=item urxvt::PrivMode_132, PrivMode_132OK, PrivMode_rVideo, PrivMode_relOrigin,
		570	PrivMode_Screen, PrivMode_Autowrap, PrivMode_aplCUR, PrivMode_aplKP,
		571	PrivMode_HaveBackSpace, PrivMode_BackSpace, PrivMode_ShiftKeys,
		572	PrivMode_VisibleCursor, PrivMode_MouseX10, PrivMode_MouseX11,
		573	PrivMode_scrollBar, PrivMode_TtyOutputInh, PrivMode_Keypress,
		574	PrivMode_smoothScroll, PrivMode_vt52, PrivMode_LFNL, PrivMode_MouseBtnEvent,
		575	PrivMode_MouseAnyEvent, PrivMode_BracketPaste, PrivMode_ExtMouseUTF8,
		576	PrivMode_ExtMouseUrxvt, PrivMode_BlinkingCursor, PrivMode_mouse_report,
		577	PrivMode_Default
		578
		579	Constants for checking DEC private modes.
		580
877	=back	581	=back
878		582
879	=head2 RENDITION	583	=head2 RENDITION
880		584
881	Rendition bitsets contain information about colour, font, font styles and	585	Rendition bitsets contain information about colour, font, font styles and
…		…
884	The following "macros" deal with changes in rendition sets. You should	588	The following "macros" deal with changes in rendition sets. You should
885	never just create a bitset, you should always modify an existing one,	589	never just create a bitset, you should always modify an existing one,
886	as they contain important information required for correct operation of	590	as they contain important information required for correct operation of
887	rxvt-unicode.	591	rxvt-unicode.
888		592
889	=over 4	593	=over
890		594
891	=item $rend = urxvt::DEFAULT_RSTYLE	595	=item $rend = urxvt::DEFAULT_RSTYLE
892		596
893	Returns the default rendition, as used when the terminal is starting up or	597	Returns the default rendition, as used when the terminal is starting up or
894	being reset. Useful as a base to start when creating renditions.	598	being reset. Useful as a base to start when creating renditions.
…		…
946	no warnings 'utf8';	650	no warnings 'utf8';
947		651
948	sub parse_resource {	652	sub parse_resource {
949	my ($term, $name, $isarg, $longopt, $flag, $value) = @_;	653	my ($term, $name, $isarg, $longopt, $flag, $value) = @_;
950		654
951	$name =~ y/-/./ if $isarg;
952
953	$term->scan_meta;	655	$term->scan_extensions;
954		656
		657	# iterating over all resources has quadratic time overhead
		658	# overall, maybe this could be optimised?
955	my $r = $term->{meta}{resource};	659	my $r = $term->{meta}{resource};
956	keys %$r; # reste iterator	660	keys %$r; # reset iterator
957	while (my ($pattern, $v) = each %$r) {	661	while (my ($k, $v) = each %$r) {
958	if (	662	my $pattern = $k;
		663	$pattern =~ y/./-/ if $isarg;
		664	my $prefix = $name;
		665	my $suffix;
959	$pattern =~ /\.$/	666	if ($pattern =~ /\-$/) {
960	? $pattern eq substr $name, 0, length $pattern	667	$prefix = substr $name, 0, length $pattern;
961	: $pattern eq $name	668	$suffix = substr $name, length $pattern;
962	) {	669	}
		670	if ($pattern eq $prefix) {
963	$name = "$urxvt::RESCLASS.$name";	671	$name = "$urxvt::RESCLASS.$k$suffix";
964		672
965	push @{ $term->{perl_ext_3} }, $v->[0];	673	push @{ $term->{perl_ext_3} }, $v->[0];
		674
		675	return 1 unless $isarg;
966		676
967	if ($v->[1] eq "boolean") {	677	if ($v->[1] eq "boolean") {
968	$term->put_option_db ($name, $flag ? "true" : "false");	678	$term->put_option_db ($name, $flag ? "true" : "false");
969	return 1;	679	return 1;
970	} else {	680	} else {
…		…
978	}	688	}
979		689
980	sub usage {	690	sub usage {
981	my ($term, $usage_type) = @_;	691	my ($term, $usage_type) = @_;
982		692
983	$term->scan_meta;	693	$term->scan_extensions;
984		694
985	my $r = $term->{meta}{resource};	695	my $r = $term->{meta}{resource};
986		696
987	for my $pattern (sort keys %$r) {	697	for my $pattern (sort keys %$r) {
988	my ($ext, $type, $desc) = @{ $r->{$pattern} };	698	my ($ext, $type, $desc) = @{ $r->{$pattern} };
…		…
1003	urxvt::log sprintf " %-31s %s\n", "$pattern:", $type;	713	urxvt::log sprintf " %-31s %s\n", "$pattern:", $type;
1004	}	714	}
1005	}	715	}
1006	}	716	}
1007		717
1008	my $verbosity = $ENV{URXVT_PERL_VERBOSITY};	718	my $verbosity = $ENV{URXVT_PERL_VERBOSITY} // 2;
1009		719
1010	sub verbose {	720	sub verbose {
1011	my ($level, $msg) = @_;	721	my ($level, $msg) = @_;
1012	warn "$msg\n" if $level <= $verbosity;	722	warn "$msg\n" if $level <= $verbosity;
1013	}	723	}
…		…
1024	$pkg =~ s/[^[:word:]]/_/g;	734	$pkg =~ s/[^[:word:]]/_/g;
1025	$pkg = "urxvt::ext::$pkg";	735	$pkg = "urxvt::ext::$pkg";
1026		736
1027	verbose 3, "loading extension '$path' into package '$pkg'";	737	verbose 3, "loading extension '$path' into package '$pkg'";
1028		738
		739	(${"$pkg\::_NAME"} = $path) =~ s/^.*[\\\/]//; # hackish
		740
1029	open my $fh, "<:raw", $path	741	open my $fh, "<:raw", $path
1030	or die "$path: $!";	742	or die "$path: $!";
1031		743
1032	my $source =	744	my $source =
1033	"package $pkg; use strict 'vars'; use utf8; no warnings 'utf8';\n"	745	"package $pkg; use strict qw(vars subs); use utf8; no warnings 'utf8';\n"
1034	. "#line 1 \"$path\"\n{\n"	746	. "#line 1 \"$path\"\n{\n"
1035	. (do { local $/; <$fh> })	747	. (do { local $/; <$fh> })
1036	. "\n};\n1";	748	. "\n};\n1";
1037		749
1038	eval $source	750	eval $source
…		…
1047	# called by the rxvt core	759	# called by the rxvt core
1048	sub invoke {	760	sub invoke {
1049	local $TERM = shift;	761	local $TERM = shift;
1050	my $htype = shift;	762	my $htype = shift;
1051		763
1052	if ($htype == 0) { # INIT	764	if ($htype == HOOK_INIT) {
1053	my @dirs = $TERM->perl_libdirs;	765	$TERM->scan_extensions;
1054		766
1055	my %ext_arg;	767	my %ext_arg;
1056		768
1057	{	769	{
1058	my @init = @TERM_INIT;	770	my @init = @TERM_INIT;
…		…
1063	$TERM->register_package ($_) for @pkg;	775	$TERM->register_package ($_) for @pkg;
1064	}	776	}
1065		777
1066	for (	778	for (
1067	@{ delete $TERM->{perl_ext_3} },	779	@{ delete $TERM->{perl_ext_3} },
1068	grep $_, map { split /,/, $TERM->resource ("perl_ext_$_") } 1, 2	780	(grep $_, map { split /,/, $TERM->resource ("perl_ext_$_") } 1, 2),
1069	) {	781	) {
1070	if ($_ eq "default") {	782	if ($_ eq "default") {
		783
		784	$ext_arg{$_} = []
1071	$ext_arg{$_} ||= [] for qw(selection option-popup selection-popup searchable-scrollback readline);	785	for qw(selection option-popup selection-popup readline searchable-scrollback confirm-paste);
		786
		787	for ($TERM->_keysym_resources) {
		788	next if /^(?:string|command|builtin|builtin-string|perl)/;
		789	next unless /^([A-Za-z0-9_\-]+):/;
		790
		791	my $ext = $1;
		792
		793	$ext_arg{$ext} = [];
		794	}
		795
1072	} elsif (/^-(.*)$/) {	796	} elsif (/^-(.*)$/) { # remove from set
1073	delete $ext_arg{$1};	797	delete $ext_arg{$1};
1074	} elsif (/^([^<]+)<(.*)>$/) {	798
		799	} elsif (/^\/(.*)$/) { # prohibit loading
		800	undef $TERM->{ext_prohibit}{$1};
		801
		802	} elsif (/^([^<]+)(?:<(.*)>)?$/) { # add to set, clear prohibit status
		803	delete $TERM->{ext_prohibit}{$1};
1075	push @{ $ext_arg{$1} }, $2;	804	push @{ $ext_arg{$1} }, defined $2 ? $2 : ();
		805
1076	} else {	806	} else {
1077	$ext_arg{$_} ||= [];	807	verbose 2, "cannot parse extension specification '$_', ignoring.";
1078	}	808	}
1079	}	809	}
1080		810
		811	$TERM->set_should_invoke (HOOK_OSC_SEQ , +1) if $TERM->{meta}{autoload_osc};
		812	$TERM->set_should_invoke (HOOK_OSC_SEQ_PERL, +1) if $TERM->{meta}{autoload_osc_perl};
		813
1081	for my $ext (sort keys %ext_arg) {	814	for my $ext (sort keys %ext_arg) {
1082	my @files = grep -f $_, map "$_/$ext", @dirs;	815	my $path = $TERM->extension_path ($ext);
1083		816
1084	if (@files) {	817	if (defined $path) {
1085	$TERM->register_package (extension_package $files[0], $ext_arg{$ext});	818	$TERM->autoload_extension ($ext, $ext_arg{$ext});
1086	} else {	819	} else {
1087	warn "perl extension '$ext' not found in perl library search path\n";	820	verbose 2, "perl extension '$ext' not found in perl library search path";
1088	}	821	}
1089	}	822	}
1090		823
1091	eval "#line 1 \"--perl-eval resource/argument\"\n" . $TERM->resource ("perl_eval");	824	eval "#line 1 \"--perl-eval resource/argument\"\n" . $TERM->resource ("perl_eval");
1092	warn $@ if $@;	825	warn $@ if $@;
1093	}	826	}
1094		827
1095	$retval = undef;	828	$retval = undef;
1096		829
		830	if ($htype == HOOK_OSC_SEQ) {
		831	if (my $exts = delete $TERM->{meta}{autoload_osc}{$_[0]}) {
		832	$TERM->autoload_extension ($_->[0]) for @$exts;
		833	}
		834	} elsif ($htype == HOOK_OSC_SEQ_PERL) {
		835	if ($_[0] =~ /^([^;]+)/ and (my $exts = delete $TERM->{meta}{autoload_osc_perl}{$1})) {
		836	$TERM->autoload_extension ($_->[0]) for @$exts;
		837	}
		838	}
		839
1097	if (my $cb = $TERM->{_hook}[$htype]) {	840	if (my $cb = $TERM->{_hook}[$htype]) {
1098	verbose 10, "$HOOKNAME[$htype] (" . (join ", ", $TERM, @_) . ")"	841	verbose 10, "$HOOKNAME[$htype] (" . (join ", ", $TERM, @_) . ")"
1099	if $verbosity >= 10;	842	if $verbosity >= 10;
1100		843
		844	if ($htype == HOOK_ACTION) {
		845	# this hook is only sent to the extension with the name
		846	# matching the first arg
		847	my $pkg = shift;
		848	$pkg =~ y/-/_/;
		849	$pkg = "urxvt::ext::$pkg";
		850
		851	$cb = $cb->{$pkg}
		852	or return undef; #TODO: maybe warn user?
		853
		854	$cb = { $pkg => $cb };
		855	}
		856
1101	for my $pkg (keys %$cb) {	857	for my $pkg (keys %$cb) {
1102	my $retval_ = eval { $cb->{$pkg}->($TERM->{_pkg}{$pkg}, @_) };	858	my $retval_ = eval { $cb->{$pkg}->($TERM->{_pkg}{$pkg} || $TERM, @_) };
1103	$retval ||= $retval_;	859	$retval ||= $retval_;
1104		860
1105	if ($@) {	861	if ($@) {
1106	$TERM->ungrab; # better to lose the grab than the session	862	$TERM->ungrab; # better to lose the grab than the session
1107	warn $@;	863	warn $@;
…		…
1110		866
1111	verbose 11, "$HOOKNAME[$htype] returning <$retval>"	867	verbose 11, "$HOOKNAME[$htype] returning <$retval>"
1112	if $verbosity >= 11;	868	if $verbosity >= 11;
1113	}	869	}
1114		870
1115	if ($htype == 1) { # DESTROY	871	if ($htype == HOOK_DESTROY) {
1116	# clear package objects	872	# clear package objects
1117	%$_ = () for values %{ $TERM->{_pkg} };	873	%$_ = () for values %{ $TERM->{_pkg} };
1118		874
1119	# clear package	875	# clear package
1120	%$TERM = ();	876	%$TERM = ();
…		…
1150	}	906	}
1151	}	907	}
1152	($mask, @color{qw(fg bg)}, \@failed)	908	($mask, @color{qw(fg bg)}, \@failed)
1153	}	909	}
1154		910
1155	# urxvt::term::extension
1156
1157	package urxvt::term::extension;	911	package urxvt::term::extension;
1158		912
1159	sub enable {	913	=head2 The C<urxvt::term::extension> class
1160	my ($self, %hook) = @_;
1161	my $pkg = $self->{_pkg};
1162		914
1163	while (my ($name, $cb) = each %hook) {	915	Each extension attached to a terminal object is represented by
1164	my $htype = $HOOKTYPE{uc $name};	916	a C<urxvt::term::extension> object.
1165	defined $htype
1166	or Carp::croak "unsupported hook type '$name'";
1167		917
1168	$self->set_should_invoke ($htype, +1)	918	You can use these objects, which are passed to all callbacks to store any
1169	unless exists $self->{term}{_hook}[$htype]{$pkg};	919	state related to the terminal and extension instance.
1170		920
1171	$self->{term}{_hook}[$htype]{$pkg} = $cb;	921	The methods (And data members) documented below can be called on extension
1172	}	922	objects, in addition to call methods documented for the <urxvt::term>
1173	}	923	class.
1174		924
1175	sub disable {	925	=over
1176	my ($self, @hook) = @_;
1177	my $pkg = $self->{_pkg};
1178		926
1179	for my $name (@hook) {	927	=item $urxvt_term = $self->{term}
1180	my $htype = $HOOKTYPE{uc $name};
1181	defined $htype
1182	or Carp::croak "unsupported hook type '$name'";
1183		928
1184	$self->set_should_invoke ($htype, -1)	929	Returns the C<urxvt::term> object associated with this instance of the
1185	if delete $self->{term}{_hook}[$htype]{$pkg};	930	extension. This member I<must not> be changed in any way.
1186	}	931
1187	}	932	=cut
1188		933
1189	our $AUTOLOAD;	934	our $AUTOLOAD;
1190		935
1191	sub AUTOLOAD {	936	sub AUTOLOAD {
1192	$AUTOLOAD =~ /:([^:]+)$/	937	$AUTOLOAD =~ /:([^:]+)$/
…		…
1205		950
1206	sub DESTROY {	951	sub DESTROY {
1207	# nop	952	# nop
1208	}	953	}
1209		954
1210	# urxvt::destroy_hook	955	# urxvt::destroy_hook (basically a cheap Guard:: implementation)
1211		956
1212	sub urxvt::destroy_hook::DESTROY {	957	sub urxvt::destroy_hook::DESTROY {
1213	${$_[0]}->();	958	${$_[0]}->();
1214	}	959	}
1215		960
1216	sub urxvt::destroy_hook(&) {	961	sub urxvt::destroy_hook(&) {
1217	bless \shift, urxvt::destroy_hook::	962	bless \shift, urxvt::destroy_hook::
1218	}	963	}
		964
		965	=item $self->enable ($hook_name => $cb[, $hook_name => $cb..])
		966
		967	Dynamically enable the given hooks (named without the C<on_> prefix) for
		968	this extension, replacing any hook previously installed via C<enable> in
		969	this extension.
		970
		971	This is useful when you want to overwrite time-critical hooks only
		972	temporarily.
		973
		974	To install additional callbacks for the same hook, you can use the C<on>
		975	method of the C<urxvt::term> class.
		976
		977	=item $self->disable ($hook_name[, $hook_name..])
		978
		979	Dynamically disable the given hooks.
		980
		981	=cut
		982
		983	sub enable {
		984	my ($self, %hook) = @_;
		985	my $pkg = $self->{_pkg};
		986
		987	while (my ($name, $cb) = each %hook) {
		988	my $htype = $HOOKTYPE{uc $name};
		989	defined $htype
		990	or Carp::croak "unsupported hook type '$name'";
		991
		992	$self->set_should_invoke ($htype, +1)
		993	unless exists $self->{term}{_hook}[$htype]{$pkg};
		994
		995	$self->{term}{_hook}[$htype]{$pkg} = $cb;
		996	}
		997	}
		998
		999	sub disable {
		1000	my ($self, @hook) = @_;
		1001	my $pkg = $self->{_pkg};
		1002
		1003	for my $name (@hook) {
		1004	my $htype = $HOOKTYPE{uc $name};
		1005	defined $htype
		1006	or Carp::croak "unsupported hook type '$name'";
		1007
		1008	$self->set_should_invoke ($htype, -1)
		1009	if delete $self->{term}{_hook}[$htype]{$pkg};
		1010	}
		1011	}
		1012
		1013	=item $guard = $self->on ($hook_name => $cb[, $hook_name => $cb..])
		1014
		1015	Similar to the C<enable> enable, but installs additional callbacks for
		1016	the given hook(s) (that is, it doesn't replace existing callbacks), and
		1017	returns a guard object. When the guard object is destroyed the callbacks
		1018	are disabled again.
		1019
		1020	=cut
		1021
		1022	sub urxvt::extension::on_disable::DESTROY {
		1023	my $disable = shift;
		1024
		1025	my $term = delete $disable->{""};
		1026
		1027	while (my ($htype, $id) = each %$disable) {
		1028	delete $term->{_hook}[$htype]{$id};
		1029	$term->set_should_invoke ($htype, -1);
		1030	}
		1031	}
		1032
		1033	sub on {
		1034	my ($self, %hook) = @_;
		1035
		1036	my $term = $self->{term};
		1037
		1038	my %disable = ( "" => $term );
		1039
		1040	while (my ($name, $cb) = each %hook) {
		1041	my $htype = $HOOKTYPE{uc $name};
		1042	defined $htype
		1043	or Carp::croak "unsupported hook type '$name'";
		1044
		1045	$term->set_should_invoke ($htype, +1);
		1046	$term->{_hook}[$htype]{ $disable{$htype} = $cb+0 }
		1047	= sub { shift; $cb->($self, @_) }; # very ugly indeed
		1048	}
		1049
		1050	bless \%disable, "urxvt::extension::on_disable"
		1051	}
		1052
		1053	=item $self->bind_action ($hotkey, $action)
		1054
		1055	=item $self->x_resource ($pattern)
		1056
		1057	=item $self->x_resource_boolean ($pattern)
		1058
		1059	These methods support an additional C<%> prefix for C<$action> or
		1060	C<$pattern> when called on an extension object, compared to the
		1061	C<urxvt::term> methods of the same name - see the description of these
		1062	methods in the C<urxvt::term> class for details.
		1063
		1064	=cut
		1065
		1066	sub bind_action {
		1067	my ($self, $hotkey, $action) = @_;
		1068	$action =~ s/^%:/$_[0]{_name}:/;
		1069	$self->{term}->bind_action ($hotkey, $action)
		1070	}
		1071
		1072	sub x_resource {
		1073	my ($self, $name) = @_;
		1074	$name =~ s/^%(\.|$)/$_[0]{_name}$1/;
		1075	$self->{term}->x_resource ($name)
		1076	}
		1077
		1078	sub x_resource_boolean {
		1079	my ($self, $name) = @_;
		1080	$name =~ s/^%(\.|$)/$_[0]{_name}$1/;
		1081	$self->{term}->x_resource_boolean ($name)
		1082	}
		1083
		1084	=back
		1085
		1086	=cut
1219		1087
1220	package urxvt::anyevent;	1088	package urxvt::anyevent;
1221		1089
1222	=head2 The C<urxvt::anyevent> Class	1090	=head2 The C<urxvt::anyevent> Class
1223		1091
…		…
1303		1171
1304	package urxvt::term;	1172	package urxvt::term;
1305		1173
1306	=head2 The C<urxvt::term> Class	1174	=head2 The C<urxvt::term> Class
1307		1175
1308	=over 4	1176	=over
1309		1177
1310	=cut	1178	=cut
1311		1179
1312	# find on_xxx subs in the package and register them	1180	# find on_xxx subs in the package and register them
1313	# as hooks	1181	# as hooks
…		…
1319	urxvt::verbose 6, "register package $pkg to $self";	1187	urxvt::verbose 6, "register package $pkg to $self";
1320		1188
1321	@{"$pkg\::ISA"} = urxvt::term::extension::;	1189	@{"$pkg\::ISA"} = urxvt::term::extension::;
1322		1190
1323	my $proxy = bless {	1191	my $proxy = bless {
1324	_pkg => $pkg,	1192	_pkg => $pkg,
		1193	_name => ${"$pkg\::_NAME"}, # hackish
1325	argv => $argv,	1194	argv => $argv,
1326	}, $pkg;	1195	}, $pkg;
1327	Scalar::Util::weaken ($proxy->{term} = $self);	1196	Scalar::Util::weaken ($proxy->{term} = $self);
1328		1197
1329	$self->{_pkg}{$pkg} = $proxy;	1198	$self->{_pkg}{$pkg} = $proxy;
1330		1199
1331	for my $name (@HOOKNAME) {	1200	for my $name (@HOOKNAME) {
1332	if (my $ref = $pkg->can ("on_" . lc $name)) {	1201	if (my $ref = $pkg->can ("on_" . lc $name)) {
1333	$proxy->enable ($name => $ref);	1202	$proxy->enable ($name => $ref);
1334	}	1203	}
1335	}	1204	}
		1205	}
		1206
		1207	# map extension name to filesystem path
		1208	sub extension_path {
		1209	(grep -f $_, map "$_/$_[1]", $_[0]->perl_libdirs)[0]
		1210	}
		1211
		1212	# load an extension by name
		1213	sub load_extension_file {
		1214	my ($self, $path, $argv) = @_;
		1215
		1216	$self->register_package (urxvt::extension_package $path, $argv);
		1217	}
		1218
		1219	# autoload an extension unless loading it is prohibited
		1220	sub autoload_extension {
		1221	my ($self, $name, $argv) = @_;
		1222
		1223	return if exists $self->{ext_prohibit}{$name};
		1224
		1225	my $path = $self->extension_path ($name)
		1226	// return urxvt::verbose 2, "perl extension '$name' not found in perl library search path (during autoload)";
		1227
		1228	$self->load_extension_file ($path, $argv);
1336	}	1229	}
1337		1230
1338	sub perl_libdirs {	1231	sub perl_libdirs {
1339	map { split /:/ }	1232	map { split /:/ }
1340	$_[0]->resource ("perl_lib"),	1233	$_[0]->resource ("perl_lib"),
1341	$ENV{URXVT_PERL_LIB},	1234	$ENV{URXVT_PERL_LIB},
1342	"$ENV{HOME}/.urxvt/ext",	1235	"$ENV{HOME}/.urxvt/ext",
1343	"$LIBDIR/perl"	1236	"$LIBDIR/perl"
1344	}	1237	}
1345		1238
1346	sub scan_meta {	1239	# scan for available extensions and collect their metadata
		1240	sub scan_extensions {
1347	my ($self) = @_;	1241	my ($self) = @_;
		1242
		1243	return if exists $self->{meta};
		1244
1348	my @libdirs = perl_libdirs $self;	1245	my @urxvtdirs = perl_libdirs $self;
		1246	# my @cpandirs = grep -d, map "$_/URxvt/Ext", @INC;
1349		1247
1350	return if $self->{meta_libdirs} eq join "\x00", @libdirs;
1351
1352	my %meta;
1353
1354	$self->{meta_libdirs} = join "\x00", @libdirs;
1355	$self->{meta} = \%meta;	1248	$self->{meta} = \my %allmeta;
1356		1249
1357	for my $dir (reverse @libdirs) {	1250	# first gather extensions
		1251
		1252	my $gather = sub {
		1253	my ($dir, $core) = @_;
		1254
1358	opendir my $fh, $dir	1255	opendir my $fh, $dir
1359	or next;	1256	or return;
		1257
1360	for my $ext (readdir $fh) {	1258	for my $ext (readdir $fh) {
1361	$ext ne "."	1259	$ext !~ /^\./
1362	and $ext ne ".."
1363	and open my $fh, "<", "$dir/$ext"
1364	or next;	1260	or next;
1365		1261
		1262	open my $fh, "<", "$dir/$ext"
		1263	or next;
		1264
		1265	-f $fh
		1266	or next;
		1267
		1268	$ext =~ s/\.uext$// or $core
		1269	or next;
		1270
		1271	my %meta = (dir => $dir);
		1272
1366	while (<$fh>) {	1273	while (<$fh>) {
1367	if (/^#:META:X_RESOURCE:(.*)/) {	1274	if (/^#:META:(?:X_)?RESOURCE:(.*)/) {
1368	my ($pattern, $type, $desc) = split /:/, $1;	1275	my ($pattern, $type, $desc) = split /:/, $1;
1369	$pattern =~ s/^%(\.|$)/$ext$1/g; # % in pattern == extension name	1276	$pattern =~ s/^%(\.|$)/$ext$1/g; # % in pattern == extension name
1370	if ($pattern =~ /[^a-zA-Z0-9\-\.]/) {	1277	if ($pattern =~ /[^a-zA-Z0-9\-\.]/) {
1371	warn "$dir/$ext: meta resource '$pattern' contains illegal characters (not alphanumeric nor . nor *)\n";	1278	warn "$dir/$ext: meta resource '$pattern' contains illegal characters (not alphanumeric nor . nor *)\n";
1372	} else {	1279	} else {
1373	$meta{resource}{$pattern} = [$ext, $type, $desc];	1280	$meta{resource}{$pattern} = [$ext, $type, $desc];
1374	}	1281	}
		1282
		1283	} elsif (/^#:META:OSC:([0-9]+):(.*)/) {
		1284	push @{$allmeta{autoload_osc}{$1}}, [$ext, $2];
		1285
		1286	} elsif (/^#:META:OSC_PERL:([^:]+):(.*)/) {
		1287	push @{$allmeta{autoload_osc_perl}{$1}}, [$ext, $2];
		1288
1375	} elsif (/^\s*(?:#|$)/) {	1289	} elsif (/^\s*(?:#|$)/) {
1376	# skip other comments and empty lines	1290	# skip other comments and empty lines
		1291
1377	} else {	1292	} else {
1378	last; # stop parsing on first non-empty non-comment line	1293	last; # stop parsing on first non-empty non-comment line
1379	}	1294	}
1380	}	1295	}
		1296
		1297	$allmeta{ext}{$ext} = \%meta;
1381	}	1298	}
		1299	};
		1300
		1301	# $gather->($_, 0) for @cpandirs;
		1302	$gather->($_, 1) for @urxvtdirs;
		1303
		1304	# and now merge resources
		1305
		1306	$allmeta{resource} = \my %resource;
		1307
		1308	while (my ($k, $v) = each %{ $allmeta{ext} }) {
		1309	#TODO: should check for extensions overriding each other
		1310	%resource = (%resource, %{ $v->{resource} });
1382	}	1311	}
1383	}	1312	}
1384		1313
1385	=item $term = new urxvt::term $envhashref, $rxvtname, [arg...]	1314	=item $term = new urxvt::term $envhashref, $rxvtname, [arg...]
1386		1315
…		…
1406	}	1335	}
1407		1336
1408	=item $term->destroy	1337	=item $term->destroy
1409		1338
1410	Destroy the terminal object (close the window, free resources	1339	Destroy the terminal object (close the window, free resources
1411	etc.). Please note that @@RXVT_NAME@@ will not exit as long as any event	1340	etc.). Please note that urxvt will not exit as long as any event
1412	watchers (timers, io watchers) are still active.	1341	watchers (timers, io watchers) are still active.
1413		1342
1414	=item $term->exec_async ($cmd[, @args])	1343	=item $term->exec_async ($cmd[, @args])
1415		1344
1416	Works like the combination of the C<fork>/C<exec> builtins, which executes	1345	Works like the combination of the C<fork>/C<exec> builtins, which executes
…		…
1449	insecure intensityStyles iso14755 iso14755_52 jumpScroll loginShell	1378	insecure intensityStyles iso14755 iso14755_52 jumpScroll loginShell
1450	mapAlert meta8 mouseWheelScrollPage override_redirect pastableTabs	1379	mapAlert meta8 mouseWheelScrollPage override_redirect pastableTabs
1451	pointerBlank reverseVideo scrollBar scrollBar_floating scrollBar_right	1380	pointerBlank reverseVideo scrollBar scrollBar_floating scrollBar_right
1452	scrollTtyKeypress scrollTtyOutput scrollWithBuffer secondaryScreen	1381	scrollTtyKeypress scrollTtyOutput scrollWithBuffer secondaryScreen
1453	secondaryScroll skipBuiltinGlyphs skipScroll transparent tripleclickwords	1382	secondaryScroll skipBuiltinGlyphs skipScroll transparent tripleclickwords
1454	urgentOnBell utmpInhibit visualBell	1383	urgentOnBell utmpInhibit visualBell disablePasteBrackets
1455		1384
1456	=item $value = $term->resource ($name[, $newval])	1385	=item $value = $term->resource ($name[, $newval])
1457		1386
1458	Returns the current resource value associated with a given name and	1387	Returns the current resource value associated with a given name and
1459	optionally sets a new value. Setting values is most useful in the C<init>	1388	optionally sets a new value. Setting values is most useful in the C<init>
…		…
1472		1401
1473	Here is a likely non-exhaustive list of resource names, not all of which	1402	Here is a likely non-exhaustive list of resource names, not all of which
1474	are supported in every build, please see the source file F</src/rsinc.h>	1403	are supported in every build, please see the source file F</src/rsinc.h>
1475	to see the actual list:	1404	to see the actual list:
1476		1405
1477	answerbackstring backgroundPixmap backspace_key blendtype blurradius	1406	answerbackstring backgroundPixmap backspace_key blurradius
1478	boldFont boldItalicFont borderLess buffered chdir color cursorBlink	1407	boldFont boldItalicFont borderLess buffered chdir color cursorBlink
1479	cursorUnderline cutchars delete_key depth display_name embed ext_bwidth	1408	cursorUnderline cutchars delete_key depth display_name embed ext_bwidth
1480	fade font geometry hold iconName iconfile imFont imLocale inputMethod	1409	fade font geometry hold iconName iconfile imFont imLocale inputMethod
1481	insecure int_bwidth intensityStyles iso14755 iso14755_52 italicFont	1410	insecure int_bwidth intensityStyles iso14755 iso14755_52 italicFont
1482	jumpScroll letterSpace lineSpace loginShell mapAlert meta8 modifier	1411	jumpScroll letterSpace lineSpace loginShell mapAlert meta8 modifier
…		…
1485	preeditType print_pipe pty_fd reverseVideo saveLines scrollBar	1414	preeditType print_pipe pty_fd reverseVideo saveLines scrollBar
1486	scrollBar_align scrollBar_floating scrollBar_right scrollBar_thickness	1415	scrollBar_align scrollBar_floating scrollBar_right scrollBar_thickness
1487	scrollTtyKeypress scrollTtyOutput scrollWithBuffer scrollstyle	1416	scrollTtyKeypress scrollTtyOutput scrollWithBuffer scrollstyle
1488	secondaryScreen secondaryScroll shade skipBuiltinGlyphs skipScroll	1417	secondaryScreen secondaryScroll shade skipBuiltinGlyphs skipScroll
1489	term_name title transient_for transparent tripleclickwords urgentOnBell	1418	term_name title transient_for transparent tripleclickwords urgentOnBell
1490	utmpInhibit visualBell	1419	utmpInhibit visualBell rewrapMode disablePasteBrackets
1491		1420
1492	=cut	1421	=cut
1493		1422
1494	sub resource($$;$) {	1423	sub resource($$;$) {
1495	my ($self, $name) = (shift, shift);	1424	my ($self, $name) = (shift, shift);
…		…
1502	Returns the X-Resource for the given pattern, excluding the program or	1431	Returns the X-Resource for the given pattern, excluding the program or
1503	class name, i.e. C<< $term->x_resource ("boldFont") >> should return the	1432	class name, i.e. C<< $term->x_resource ("boldFont") >> should return the
1504	same value as used by this instance of rxvt-unicode. Returns C<undef> if no	1433	same value as used by this instance of rxvt-unicode. Returns C<undef> if no
1505	resource with that pattern exists.	1434	resource with that pattern exists.
1506		1435
		1436	Extensions that define extra resources also need to call this method
		1437	to access their values.
		1438
		1439	If the method is called on an extension object (basically, from an
		1440	extension), then the special prefix C<%.> will be replaced by the name of
		1441	the extension and a dot, and the lone string C<%> will be replaced by the
		1442	extension name itself. This makes it possible to code extensions so you
		1443	can rename them and get a new set of resources without having to change
		1444	the actual code.
		1445
1507	This method should only be called during the C<on_start> hook, as there is	1446	This method should only be called during the C<on_start> hook, as there is
1508	only one resource database per display, and later invocations might return	1447	only one resource database per display, and later invocations might return
1509	the wrong resources.	1448	the wrong resources.
1510		1449
1511	=item $value = $term->x_resource_boolean ($pattern)	1450	=item $value = $term->x_resource_boolean ($pattern)
…		…
1522	my $res = &x_resource;	1461	my $res = &x_resource;
1523		1462
1524	$res =~ /^\s*(?:true|yes|on|1)\s*$/i ? 1 : defined $res && 0	1463	$res =~ /^\s*(?:true|yes|on|1)\s*$/i ? 1 : defined $res && 0
1525	}	1464	}
1526		1465
1527	=item $success = $term->parse_keysym ($key, $octets)	1466	=item $action = $term->lookup_keysym ($keysym, $state)
1528		1467
		1468	Returns the action bound to key combination C<($keysym, $state)>,
		1469	if a binding for it exists, and C<undef> otherwise.
		1470
		1471	=item $success = $term->bind_action ($key, $action)
		1472
1529	Adds a key binding exactly as specified via a resource. See the	1473	Adds a key binding exactly as specified via a C<keysym> resource. See the
1530	C<keysym> resource in the @@RXVT_NAME@@(1) manpage.	1474	C<keysym> resource in the urxvt(1) manpage.
1531		1475
1532	=item $term->register_command ($keysym, $modifiermask, $string)	1476	To add default bindings for actions, an extension should call C<<
		1477	->bind_action >> in its C<init> hook for every such binding. Doing it
		1478	in the C<init> hook allows users to override or remove the binding
		1479	again.
1533		1480
1534	Adds a key binding. This is a lower level api compared to	1481	Example: the C<searchable-scrollback> by default binds itself
1535	C<parse_keysym>, as it expects a parsed key description, and can be	1482	on C<Meta-s>, using C<< $self->bind_action >>, which calls C<<
1536	used only inside either the C<on_init> hook, to add a binding, or the	1483	$term->bind_action >>.
1537	C<on_register_command> hook, to modify a parsed binding.	1484
		1485	sub init {
		1486	my ($self) = @_;
		1487
		1488	$self->bind_action ("M-s" => "%:start");
		1489	}
1538		1490
1539	=item $rend = $term->rstyle ([$new_rstyle])	1491	=item $rend = $term->rstyle ([$new_rstyle])
1540		1492
1541	Return and optionally change the current rendition. Text that is output by	1493	Return and optionally change the current rendition. Text that is output by
1542	the terminal application will use this style.	1494	the terminal application will use this style.
…		…
1619	This method returns an urxvt::overlay object. The overlay will be visible	1571	This method returns an urxvt::overlay object. The overlay will be visible
1620	as long as the perl object is referenced.	1572	as long as the perl object is referenced.
1621		1573
1622	The methods currently supported on C<urxvt::overlay> objects are:	1574	The methods currently supported on C<urxvt::overlay> objects are:
1623		1575
1624	=over 4	1576	=over
1625		1577
1626	=item $overlay->set ($x, $y, $text[, $rend])	1578	=item $overlay->set ($x, $y, $text[, $rend])
1627		1579
1628	Similar to C<< $term->ROW_t >> and C<< $term->ROW_r >> in that it puts	1580	Similar to C<< $term->ROW_t >> and C<< $term->ROW_r >> in that it puts
1629	text in rxvt-unicode's special encoding and an array of rendition values	1581	text in rxvt-unicode's special encoding and an array of rendition values
…		…
1700		1652
1701	=item $term->scr_add_lines ($string)	1653	=item $term->scr_add_lines ($string)
1702		1654
1703	Write the given text string to the screen, as if output by the application	1655	Write the given text string to the screen, as if output by the application
1704	running inside the terminal. It may not contain command sequences (escape	1656	running inside the terminal. It may not contain command sequences (escape
1705	codes), but is free to use line feeds, carriage returns and tabs. The	1657	codes - see C<cmd_parse> for that), but is free to use line feeds,
1706	string is a normal text string, not in locale-dependent encoding.	1658	carriage returns and tabs. The string is a normal text string, not in
		1659	locale-dependent encoding.
1707		1660
1708	Normally its not a good idea to use this function, as programs might be	1661	Normally its not a good idea to use this function, as programs might be
1709	confused by changes in cursor position or scrolling. Its useful inside a	1662	confused by changes in cursor position or scrolling. Its useful inside a
1710	C<on_add_lines> hook, though.	1663	C<on_add_lines> hook, though.
1711		1664
…		…
1719	locale-specific encoding of the terminal and can contain command sequences	1672	locale-specific encoding of the terminal and can contain command sequences
1720	(escape codes) that will be interpreted.	1673	(escape codes) that will be interpreted.
1721		1674
1722	=item $term->tt_write ($octets)	1675	=item $term->tt_write ($octets)
1723		1676
1724	Write the octets given in C<$octets> to the tty (i.e. as program input). To	1677	Write the octets given in C<$octets> to the tty (i.e. as user input
		1678	to the program, see C<cmd_parse> for the opposite direction). To pass
1725	pass characters instead of octets, you should convert your strings first	1679	characters instead of octets, you should convert your strings first to the
1726	to the locale-specific encoding using C<< $term->locale_encode >>.	1680	locale-specific encoding using C<< $term->locale_encode >>.
		1681
		1682	=item $term->tt_write_user_input ($octets)
		1683
		1684	Like C<tt_write>, but should be used when writing strings in response to
		1685	the user pressing a key, to invoke the additional actions requested by
		1686	the user for that case (C<tt_write> doesn't do that).
		1687
		1688	The typical use case would be inside C<on_action> hooks.
1727		1689
1728	=item $term->tt_paste ($octets)	1690	=item $term->tt_paste ($octets)
1729		1691
1730	Write the octets given in C<$octets> to the tty as a paste, converting NL to	1692	Write the octets given in C<$octets> to the tty as a paste, converting NL to
1731	CR and bracketing the data with control sequences if bracketed paste mode	1693	CR and bracketing the data with control sequences if bracketed paste mode
…		…
1770		1732
1771	=item $term->key_release ($state, $keycode[, $time])	1733	=item $term->key_release ($state, $keycode[, $time])
1772		1734
1773	Deliver various fake events to to terminal.	1735	Deliver various fake events to to terminal.
1774		1736
1775	=item $window_width = $term->width	1737	=item $window_width = $term->width ([$new_value])
1776		1738
1777	=item $window_height = $term->height	1739	=item $window_height = $term->height ([$new_value])
1778		1740
1779	=item $font_width = $term->fwidth	1741	=item $font_width = $term->fwidth ([$new_value])
1780		1742
1781	=item $font_height = $term->fheight	1743	=item $font_height = $term->fheight ([$new_value])
1782		1744
1783	=item $font_ascent = $term->fbase	1745	=item $font_ascent = $term->fbase ([$new_value])
1784		1746
1785	=item $terminal_rows = $term->nrow	1747	=item $terminal_rows = $term->nrow ([$new_value])
1786		1748
1787	=item $terminal_columns = $term->ncol	1749	=item $terminal_columns = $term->ncol ([$new_value])
1788		1750
1789	=item $has_focus = $term->focus	1751	=item $has_focus = $term->focus ([$new_value])
1790		1752
1791	=item $is_mapped = $term->mapped	1753	=item $is_mapped = $term->mapped ([$new_value])
1792		1754
1793	=item $max_scrollback = $term->saveLines	1755	=item $max_scrollback = $term->saveLines ([$new_value])
1794		1756
1795	=item $nrow_plus_saveLines = $term->total_rows	1757	=item $nrow_plus_saveLines = $term->total_rows ([$new_value])
1796		1758
1797	=item $topmost_scrollback_row = $term->top_row	1759	=item $topmost_scrollback_row = $term->top_row ([$new_value])
1798		1760
1799	Return various integers describing terminal characteristics.	1761	Return various integers describing terminal characteristics. If an
		1762	argument is given, changes the value and returns the previous one.
1800		1763
1801	=item $x_display = $term->display_id	1764	=item $x_display = $term->display_id
1802		1765
1803	Return the DISPLAY used by rxvt-unicode.	1766	Return the DISPLAY used by rxvt-unicode.
1804		1767
…		…
1841		1804
1842	=item $cursor_is_hidden = $term->hidden_cursor	1805	=item $cursor_is_hidden = $term->hidden_cursor
1843		1806
1844	Returns whether the cursor is currently hidden or not.	1807	Returns whether the cursor is currently hidden or not.
1845		1808
		1809	=item $priv_modes = $term->priv_modes
		1810
		1811	Returns a bitset with the state of DEC private modes.
		1812
		1813	Example:
		1814
		1815	if ($term->priv_modes & urxvt::PrivMode_mouse_report) {
		1816	# mouse reporting is turned on
		1817	}
		1818
1846	=item $view_start = $term->view_start ([$newvalue])	1819	=item $view_start = $term->view_start ([$newvalue])
1847		1820
1848	Returns the row number of the topmost displayed line. Maximum value is	1821	Returns the row number of the topmost displayed line and changes it,
1849	C<0>, which displays the normal terminal contents. Lower values scroll	1822	if an argument is given. Values greater than or equal to C<0> display
1850	this many lines into the scrollback buffer.	1823	the terminal contents. Lower values scroll this many lines into the
		1824	scrollback buffer.
1851		1825
1852	=item $term->want_refresh	1826	=item $term->want_refresh
1853		1827
1854	Requests a screen refresh. At the next opportunity, rxvt-unicode will	1828	Requests a screen refresh. At the next opportunity, rxvt-unicode will
1855	compare the on-screen display with its stored representation. If they	1829	compare the on-screen display with its stored representation. If they
1856	differ, it redraws the differences.	1830	differ, it redraws the differences.
1857		1831
1858	Used after changing terminal contents to display them.	1832	Used after changing terminal contents to display them.
		1833
		1834	=item $term->refresh_check
		1835
		1836	Checks if a refresh has been requested and, if so, schedules one.
1859		1837
1860	=item $text = $term->ROW_t ($row_number[, $new_text[, $start_col]])	1838	=item $text = $term->ROW_t ($row_number[, $new_text[, $start_col]])
1861		1839
1862	Returns the text of the entire row with number C<$row_number>. Row C<< $term->top_row >>	1840	Returns the text of the entire row with number C<$row_number>. Row C<< $term->top_row >>
1863	is the topmost terminal line, row C<< $term->nrow-1 >> is the bottommost	1841	is the topmost terminal line, row C<< $term->nrow-1 >> is the bottommost
…		…
1909		1887
1910	Create and return a new C<urxvt::line> object that stores information	1888	Create and return a new C<urxvt::line> object that stores information
1911	about the logical line that row C<$row_number> is part of. It supports the	1889	about the logical line that row C<$row_number> is part of. It supports the
1912	following methods:	1890	following methods:
1913		1891
1914	=over 4	1892	=over
1915		1893
1916	=item $text = $line->t ([$new_text])	1894	=item $text = $line->t ([$new_text])
1917		1895
1918	Returns or replaces the full text of the line, similar to C<ROW_t>	1896	Returns or replaces the full text of the line, similar to C<ROW_t>
1919		1897
…		…
1965	}	1943	}
1966		1944
1967	sub urxvt::line::t {	1945	sub urxvt::line::t {
1968	my ($self) = @_;	1946	my ($self) = @_;
1969		1947
1970	if (@_ > 1)	1948	if (@_ > 1) {
1971	{
1972	$self->{term}->ROW_t ($_, $_[1], 0, ($_ - $self->{beg}) * $self->{ncol}, $self->{ncol})	1949	$self->{term}->ROW_t ($_, $_[1], 0, ($_ - $self->{beg}) * $self->{ncol}, $self->{ncol})
1973	for $self->{beg} .. $self->{end};	1950	for $self->{beg} .. $self->{end};
1974	}	1951	}
1975		1952
1976	defined wantarray &&	1953	defined wantarray &&
1977	substr +(join "", map $self->{term}->ROW_t ($_), $self->{beg} .. $self->{end}),	1954	substr +(join "", map $self->{term}->ROW_t ($_), $self->{beg} .. $self->{end}),
1978	0, $self->{len}	1955	0, $self->{len}
1979	}	1956	}
1980		1957
1981	sub urxvt::line::r {	1958	sub urxvt::line::r {
1982	my ($self) = @_;	1959	my ($self) = @_;
1983		1960
1984	if (@_ > 1)	1961	if (@_ > 1) {
1985	{
1986	$self->{term}->ROW_r ($_, $_[1], 0, ($_ - $self->{beg}) * $self->{ncol}, $self->{ncol})	1962	$self->{term}->ROW_r ($_, $_[1], 0, ($_ - $self->{beg}) * $self->{ncol}, $self->{ncol})
1987	for $self->{beg} .. $self->{end};	1963	for $self->{beg} .. $self->{end};
1988	}	1964	}
1989		1965
1990	if (defined wantarray) {	1966	if (defined wantarray) {
1991	my $rend = [	1967	my $rend = [
1992	map @{ $self->{term}->ROW_r ($_) }, $self->{beg} .. $self->{end}	1968	map @{ $self->{term}->ROW_r ($_) }, $self->{beg} .. $self->{end}
1993	];	1969	];
…		…
2025	where one character corresponds to one screen cell. See	2001	where one character corresponds to one screen cell. See
2026	C<< $term->ROW_t >> for details.	2002	C<< $term->ROW_t >> for details.
2027		2003
2028	=item $string = $term->special_decode $text	2004	=item $string = $term->special_decode $text
2029		2005
2030	Converts rxvt-unicodes text representation into a perl string. See	2006	Converts rxvt-unicode's text representation into a perl string. See
2031	C<< $term->ROW_t >> for details.	2007	C<< $term->ROW_t >> for details.
2032		2008
2033	=item $success = $term->grab_button ($button, $modifiermask[, $window = $term->vt])	2009	=item $success = $term->grab_button ($button, $modifiermask[, $window = $term->vt])
2034		2010
2035	=item $term->ungrab_button ($button, $modifiermask[, $window = $term->vt])	2011	=item $term->ungrab_button ($button, $modifiermask[, $window = $term->vt])
…		…
2101		2077
2102	package urxvt::popup;	2078	package urxvt::popup;
2103		2079
2104	=head2 The C<urxvt::popup> Class	2080	=head2 The C<urxvt::popup> Class
2105		2081
2106	=over 4	2082	=over
2107		2083
2108	=cut	2084	=cut
2109		2085
2110	sub add_item {	2086	sub add_item {
2111	my ($self, $item) = @_;	2087	my ($self, $item) = @_;
…		…
2247	->cb (sub {	2223	->cb (sub {
2248	$term->{overlay}->set (0, 0,	2224	$term->{overlay}->set (0, 0,
2249	sprintf "%2d:%02d:%02d", (localtime urxvt::NOW)[2,1,0]);	2225	sprintf "%2d:%02d:%02d", (localtime urxvt::NOW)[2,1,0]);
2250	});	2226	});
2251		2227
2252	=over 4	2228	=over
2253		2229
2254	=item $timer = new urxvt::timer	2230	=item $timer = new urxvt::timer
2255		2231
2256	Create a new timer object in started state. It is scheduled to fire	2232	Create a new timer object in started state. It is scheduled to fire
2257	immediately.	2233	immediately.
…		…
2306	sysread $term->{socket}, my $buf, 8192	2282	sysread $term->{socket}, my $buf, 8192
2307	or end-of-file;	2283	or end-of-file;
2308	});	2284	});
2309		2285
2310		2286
2311	=over 4	2287	=over
2312		2288
2313	=item $iow = new urxvt::iow	2289	=item $iow = new urxvt::iow
2314		2290
2315	Create a new io watcher object in stopped state.	2291	Create a new io watcher object in stopped state.
2316		2292
…		…
2343		2319
2344	This class implements idle watchers, that get called automatically when	2320	This class implements idle watchers, that get called automatically when
2345	the process is idle. They should return as fast as possible, after doing	2321	the process is idle. They should return as fast as possible, after doing
2346	some useful work.	2322	some useful work.
2347		2323
2348	=over 4	2324	=over
2349		2325
2350	=item $iw = new urxvt::iw	2326	=item $iw = new urxvt::iw
2351		2327
2352	Create a new idle watcher object in stopped state.	2328	Create a new idle watcher object in stopped state.
2353		2329
…		…
2378	->cb (sub {	2354	->cb (sub {
2379	my ($pw, $exit_status) = @_;	2355	my ($pw, $exit_status) = @_;
2380	...	2356	...
2381	});	2357	});
2382		2358
2383	=over 4	2359	=over
2384		2360
2385	=item $pw = new urxvt::pw	2361	=item $pw = new urxvt::pw
2386		2362
2387	Create a new process watcher in stopped state.	2363	Create a new process watcher in stopped state.
2388		2364
…		…
2405	=head2 URXVT_PERL_VERBOSITY	2381	=head2 URXVT_PERL_VERBOSITY
2406		2382
2407	This variable controls the verbosity level of the perl extension. Higher	2383	This variable controls the verbosity level of the perl extension. Higher
2408	numbers indicate more verbose output.	2384	numbers indicate more verbose output.
2409		2385
2410	=over 4	2386	=over
2411		2387
2412	=item == 0 - fatal messages	2388	=item == 0 - fatal messages only
		2389
		2390	=item >= 2 - general warnings (default level)
2413		2391
2414	=item >= 3 - script loading and management	2392	=item >= 3 - script loading and management
2415		2393
2416	=item >=10 - all called hooks	2394	=item >=10 - all called hooks
2417		2395

Diff Legend

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