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.207 by root, Tue Jun 5 21:29:52 2012 UTC vs.
Revision 1.272 by root, Thu Dec 29 01:10:08 2022 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' 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
		201
		202	=item on_attach $term
		203
		204	Called when an extension package is attached to a running terminal
		205	instance. Must return true in all cases, and runs with the same
		206	limitations as C<on_init>.
		207
		208	Unlike C<on_init> or C<on_start>, this is called when the extension is
		209	attached to a terminal, regardless of whether the extension is loaded
		210	before or after the terminal is started. Extensions that need to do
		211	something before they work can do it in this callback, as opposed to e.g.
		212	C<on_init>, which might not be called.
508		213
509	=item on_init $term	214	=item on_init $term
510		215
511	Called after a new terminal object has been initialized, but before	216	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	217	windows are created or the command gets run. Most methods are unsafe to
…		…
594		299
595	C<on_osc_seq_perl> should be used for new behaviour.	300	C<on_osc_seq_perl> should be used for new behaviour.
596		301
597	=item on_osc_seq_perl $term, $args, $resp	302	=item on_osc_seq_perl $term, $args, $resp
598		303
599	Called whenever the B<ESC ] 777 ; string ST> command sequence (OSC =	304	Called whenever the B<ESC ] 777 ; prefix ; string ST> command sequence
600	operating system command) is processed. Cursor position and other state	305	(OSC = operating system command) is processed. Cursor position and other
601	information is up-to-date when this happens. For interoperability, the	306	state information is up-to-date when this happens. For interoperability,
602	string should start with the extension name (sans -osc) and a semicolon,	307	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	308	other suitable prefix, and a semicolon, to distinguish it from commands
604	enforced in the future.	309	for other extensions.
605		310
606	For example, C<overlay-osc> uses this:	311	For example, C<overlay-osc> uses this:
607		312
608	sub on_osc_seq_perl {	313	sub on_osc_seq_perl {
609	my ($self, $osc, $resp) = @_;	314	my ($self, $osc, $resp) = @_;
…		…
663		368
664	=item on_refresh_end $term	369	=item on_refresh_end $term
665		370
666	Called just after the screen gets redrawn. See C<on_refresh_begin>.	371	Called just after the screen gets redrawn. See C<on_refresh_begin>.
667		372
		373	=item on_action $term, $string
		374
		375	Called whenever an action is invoked for the corresponding extension
		376	(e.g. via a C<extension:string> builtin action bound to a key, see
		377	description of the B<keysym> resource in the urxvt(1) manpage). The
		378	event is simply the action string. Note that an action event is always
		379	associated to a single extension.
		380
668	=item on_user_command $term, $string	381	=item on_user_command $term, $string *DEPRECATED*
669		382
670	Called whenever a user-configured event is being activated (e.g. via	383	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>	384	a C<perl:string> action bound to a key, see description of the B<keysym>
672	resource in the @@RXVT_NAME@@(1) manpage).	385	resource in the urxvt(1) manpage).
673		386
674	The event is simply the action string. This interface is assumed to change	387	The event is simply the action string. This interface is going away in
675	slightly in the future.	388	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		389
684	=item on_resize_all_windows $term, $new_width, $new_height	390	=item on_resize_all_windows $term, $new_width, $new_height
685		391
686	Called just after the new window size has been calculated, but before	392	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	393	windows are actually being resized or hints are being set. If this hook
688	returns TRUE, setting of the window hints is being skipped.	394	returns a true value, setting of the window hints is being skipped.
689		395
690	=item on_x_event $term, $event	396	=item on_x_event $term, $event
691		397
692	Called on every X event received on the vt window (and possibly other	398	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	399	windows). Should only be used as a last resort. Most event structure
…		…
733	(real, not screen-based) row and column under the mouse cursor.	439	(real, not screen-based) row and column under the mouse cursor.
734		440
735	C<on_key_press> additionally receives the string rxvt-unicode would	441	C<on_key_press> additionally receives the string rxvt-unicode would
736	output, if any, in locale-specific encoding.	442	output, if any, in locale-specific encoding.
737		443
738	subwindow.
739
740	=item on_client_message $term, $event	444	=item on_client_message $term, $event
741		445
742	=item on_wm_protocols $term, $event	446	=item on_wm_protocols $term, $event
743		447
744	=item on_wm_delete_window $term, $event	448	=item on_wm_delete_window $term, $event
…		…
755	=cut	459	=cut
756		460
757	package urxvt;	461	package urxvt;
758		462
759	use utf8;	463	use utf8;
760	use strict;	464	use strict qw(vars subs);
761	use Carp ();	465	use Carp ();
762	use Scalar::Util ();	466	use Scalar::Util ();
763	use List::Util ();	467	use List::Util ();
764		468
765	our $VERSION = 1;	469	our $VERSION = 1;
766	our $TERM;	470	our $TERM;
767	our @TERM_INIT;	471	our @TERM_INIT; # should go, prevents async I/O etc.
768	our @TERM_EXT;	472	our @TERM_EXT; # should go, prevents async I/O etc.
769	our @HOOKNAME;	473	our @HOOKNAME;
770	our %HOOKTYPE = map +($HOOKNAME[$_] => $_), 0..$#HOOKNAME;	474	our %HOOKTYPE = map +($HOOKNAME[$_] => $_), 0..$#HOOKNAME;
771	our %OPTION;	475	our %OPTION;
772		476
773	our $LIBDIR;	477	our $LIBDIR;
…		…
777		481
778	our $NOCHAR = chr 0xffff;	482	our $NOCHAR = chr 0xffff;
779		483
780	=head2 Variables in the C<urxvt> Package	484	=head2 Variables in the C<urxvt> Package
781		485
782	=over 4	486	=over
783		487
784	=item $urxvt::LIBDIR	488	=item $urxvt::LIBDIR
785		489
786	The rxvt-unicode library directory, where, among other things, the perl	490	The rxvt-unicode library directory, where, among other things, the perl
787	modules and scripts are stored.	491	modules and scripts are stored.
…		…
817		521
818	=back	522	=back
819		523
820	=head2 Functions in the C<urxvt> Package	524	=head2 Functions in the C<urxvt> Package
821		525
822	=over 4	526	=over
823		527
824	=item urxvt::fatal $errormessage	528	=item urxvt::fatal $errormessage
825		529
826	Fatally aborts execution with the given error message (which should	530	Fatally aborts execution with the given error message (which should
827	include a trailing newline). Avoid at all costs! The only time this	531	include a trailing newline). Avoid at all costs! The only time this
…		…
872	CirculateRequest, PropertyNotify, SelectionClear, SelectionRequest,	576	CirculateRequest, PropertyNotify, SelectionClear, SelectionRequest,
873	SelectionNotify, ColormapNotify, ClientMessage, MappingNotify	577	SelectionNotify, ColormapNotify, ClientMessage, MappingNotify
874		578
875	Various constants for use in X calls and event processing.	579	Various constants for use in X calls and event processing.
876		580
		581	=item urxvt::PrivMode_132, PrivMode_132OK, PrivMode_rVideo, PrivMode_relOrigin,
		582	PrivMode_Screen, PrivMode_Autowrap, PrivMode_aplCUR, PrivMode_aplKP,
		583	PrivMode_HaveBackSpace, PrivMode_BackSpace, PrivMode_ShiftKeys,
		584	PrivMode_VisibleCursor, PrivMode_MouseX10, PrivMode_MouseX11,
		585	PrivMode_scrollBar, PrivMode_TtyOutputInh, PrivMode_Keypress,
		586	PrivMode_smoothScroll, PrivMode_vt52, PrivMode_LFNL, PrivMode_MouseBtnEvent,
		587	PrivMode_MouseAnyEvent, PrivMode_BracketPaste, PrivMode_ExtMouseUTF8,
		588	PrivMode_ExtMouseUrxvt, PrivMode_BlinkingCursor, PrivMode_mouse_report,
		589	PrivMode_Default
		590
		591	Constants for checking DEC private modes.
		592
877	=back	593	=back
878		594
879	=head2 RENDITION	595	=head2 RENDITION
880		596
881	Rendition bitsets contain information about colour, font, font styles and	597	Rendition bitsets contain information about colour, font, font styles and
…		…
884	The following "macros" deal with changes in rendition sets. You should	600	The following "macros" deal with changes in rendition sets. You should
885	never just create a bitset, you should always modify an existing one,	601	never just create a bitset, you should always modify an existing one,
886	as they contain important information required for correct operation of	602	as they contain important information required for correct operation of
887	rxvt-unicode.	603	rxvt-unicode.
888		604
889	=over 4	605	=over
890		606
891	=item $rend = urxvt::DEFAULT_RSTYLE	607	=item $rend = urxvt::DEFAULT_RSTYLE
892		608
893	Returns the default rendition, as used when the terminal is starting up or	609	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.	610	being reset. Useful as a base to start when creating renditions.
…		…
943	};	659	};
944	}	660	}
945		661
946	no warnings 'utf8';	662	no warnings 'utf8';
947		663
948	sub perl_libdirs {
949	map { split /:/ }
950	$_[0]->resource ("perl_lib"),
951	$ENV{URXVT_PERL_LIB},
952	"$ENV{HOME}/.urxvt/ext",
953	"$LIBDIR/perl"
954	}
955
956	our %META; # meta header information from scripts
957	our %SCAN; # which dirs already scanned
958
959	sub resource {	664	sub parse_resource {
960	my ($term, $name, $isarg, $flag, $value) = @_;	665	my ($term, $name, $isarg, $longopt, $flag, $value) = @_;
961		666
962	for my $dir (perl_libdirs $term) {	667	$term->scan_extensions;
		668
		669	# iterating over all resources has quadratic time overhead
		670	# overall, maybe this could be optimised?
		671	my $r = $term->{meta}{resource};
		672	keys %$r; # reset iterator
		673	while (my ($k, $v) = each %$r) {
		674	my $pattern = $k;
		675	$pattern =~ y/./-/ if $isarg;
		676	my $prefix = $name;
		677	my $suffix;
		678	if ($pattern =~ /\-$/) {
		679	$prefix = substr $name, 0, length $pattern;
		680	$suffix = substr $name, length $pattern;
		681	}
		682	if ($pattern eq $prefix) {
		683	$name = "$urxvt::RESCLASS.$k$suffix";
		684
		685	push @{ $term->{perl_ext_3} }, $v->[0];
		686
		687	return 1 unless $isarg;
		688
		689	if ($v->[1] eq "boolean") {
		690	$term->put_option_db ($name, $flag ? "true" : "false");
		691	return 1;
		692	} else {
		693	$term->put_option_db ($name, $value);
		694	return 1 + 2;
		695	}
		696	}
963	}	697	}
964		698
965	warn "resourece<@_>\n";#d#
966
967	0	699	0
968	}	700	}
969		701
		702	sub usage {
		703	my ($term, $usage_type) = @_;
		704
		705	$term->scan_extensions;
		706
		707	my $r = $term->{meta}{resource};
		708
		709	for my $pattern (sort keys %$r) {
		710	my ($ext, $type, $desc) = @{ $r->{$pattern} };
		711
		712	$desc .= " (-pe $ext)";
		713
		714	if ($usage_type == 1) {
		715	$pattern =~ y/./-/;
		716	$pattern =~ s/-$/-.../g;
		717
		718	if ($type eq "boolean") {
		719	urxvt::log sprintf " -%-30s %s\n", "/+$pattern", $desc;
		720	} else {
		721	urxvt::log sprintf " -%-30s %s\n", "$pattern $type", $desc;
		722	}
		723	} else {
		724	$pattern =~ s/\.$/.*/g;
		725	urxvt::log sprintf " %-31s %s\n", "$pattern:", $type;
		726	}
		727	}
		728	}
		729
970	my $verbosity = $ENV{URXVT_PERL_VERBOSITY};	730	my $verbosity = $ENV{URXVT_PERL_VERBOSITY} // 2;
971		731
972	sub verbose {	732	sub verbose {
973	my ($level, $msg) = @_;	733	my ($level, $msg) = @_;
974	warn "$msg\n" if $level <= $verbosity;	734	warn "$msg\n" if $level <= $verbosity;
975	}	735	}
…		…
986	$pkg =~ s/[^[:word:]]/_/g;	746	$pkg =~ s/[^[:word:]]/_/g;
987	$pkg = "urxvt::ext::$pkg";	747	$pkg = "urxvt::ext::$pkg";
988		748
989	verbose 3, "loading extension '$path' into package '$pkg'";	749	verbose 3, "loading extension '$path' into package '$pkg'";
990		750
		751	(${"$pkg\::_NAME"} = $path) =~ s/^.*[\\\/]//; # hackish
		752
991	open my $fh, "<:raw", $path	753	open my $fh, "<:raw", $path
992	or die "$path: $!";	754	or die "$path: $!";
993		755
994	my $source =	756	my $source =
995	"package $pkg; use strict; use utf8; no warnings 'utf8';\n"	757	"package $pkg; use strict qw(vars subs); use utf8; no warnings 'utf8';\n"
996	. "#line 1 \"$path\"\n{\n"	758	. "#line 1 \"$path\"\n{\n"
997	. (do { local $/; <$fh> })	759	. (do { local $/; <$fh> })
998	. "\n};\n1";	760	. "\n};\n1";
999		761
1000	eval $source	762	eval $source
…		…
1009	# called by the rxvt core	771	# called by the rxvt core
1010	sub invoke {	772	sub invoke {
1011	local $TERM = shift;	773	local $TERM = shift;
1012	my $htype = shift;	774	my $htype = shift;
1013		775
1014	if ($htype == 0) { # INIT	776	if ($htype == HOOK_INIT) {
1015	my @dirs = perl_libdirs $TERM;	777	$TERM->scan_extensions;
1016		778
1017	my %ext_arg;	779	my %ext_arg;
1018		780
1019	{	781	{
1020	my @init = @TERM_INIT;	782	my @init = @TERM_INIT;
…		…
1023	my @pkg = @TERM_EXT;	785	my @pkg = @TERM_EXT;
1024	@TERM_EXT = ();	786	@TERM_EXT = ();
1025	$TERM->register_package ($_) for @pkg;	787	$TERM->register_package ($_) for @pkg;
1026	}	788	}
1027		789
		790	for (
		791	@{ delete $TERM->{perl_ext_3} },
1028	for (grep $_, map { split /,/, $TERM->resource ("perl_ext_$_") } 1, 2) {	792	(grep $_, map { split /,/, $TERM->resource ("perl_ext_$_") } 1, 2),
		793	) {
1029	if ($_ eq "default") {	794	if ($_ eq "default") {
		795
		796	$ext_arg{$_} = []
1030	$ext_arg{$_} ||= [] for qw(selection option-popup selection-popup searchable-scrollback readline);	797	for qw(selection option-popup selection-popup readline searchable-scrollback confirm-paste);
		798
		799	for ($TERM->_keysym_resources) {
		800	next if /^(?:string|command|builtin|builtin-string|perl)/;
		801	next unless /^([A-Za-z0-9_\-]+):/;
		802
		803	my $ext = $1;
		804
		805	$ext_arg{$ext} = [];
		806	}
		807
1031	} elsif (/^-(.*)$/) {	808	} elsif (/^-(.*)$/) { # remove from set
1032	delete $ext_arg{$1};	809	delete $ext_arg{$1};
1033	} elsif (/^([^<]+)<(.*)>$/) {	810
		811	} elsif (/^\/(.*)$/) { # prohibit loading
		812	undef $TERM->{ext_prohibit}{$1};
		813
		814	} elsif (/^([^<]+)(?:<(.*)>)?$/) { # add to set, clear prohibit status
		815	delete $TERM->{ext_prohibit}{$1};
1034	push @{ $ext_arg{$1} }, $2;	816	push @{ $ext_arg{$1} }, defined $2 ? $2 : ();
		817
1035	} else {	818	} else {
1036	$ext_arg{$_} ||= [];	819	verbose 2, "cannot parse extension specification '$_', ignoring.";
1037	}	820	}
1038	}	821	}
1039		822
		823	$TERM->set_should_invoke (HOOK_OSC_SEQ , +1) if $TERM->{meta}{autoload_osc};
		824	$TERM->set_should_invoke (HOOK_OSC_SEQ_PERL, +1) if $TERM->{meta}{autoload_osc_perl};
		825
1040	for my $ext (sort keys %ext_arg) {	826	for my $ext (sort keys %ext_arg) {
1041	my @files = grep -f $_, map "$_/$ext", @dirs;	827	my $path = $TERM->extension_path ($ext);
1042		828
1043	if (@files) {	829	if (defined $path) {
1044	$TERM->register_package (extension_package $files[0], $ext_arg{$ext});	830	$TERM->autoload_extension ($ext, $ext_arg{$ext});
1045	} else {	831	} else {
1046	warn "perl extension '$ext' not found in perl library search path\n";	832	verbose 2, "perl extension '$ext' not found in perl library search path";
1047	}	833	}
1048	}	834	}
1049		835
1050	eval "#line 1 \"--perl-eval resource/argument\"\n" . $TERM->resource ("perl_eval");	836	eval "#line 1 \"--perl-eval resource/argument\"\n" . $TERM->resource ("perl_eval");
1051	warn $@ if $@;	837	warn $@ if $@;
1052	}	838	}
1053		839
		840	if ($htype == HOOK_OSC_SEQ) {
		841	if (my $exts = delete $TERM->{meta}{autoload_osc}{$_[0]}) {
		842	$TERM->autoload_extension ($_->[0]) for @$exts;
		843	}
		844	} elsif ($htype == HOOK_OSC_SEQ_PERL) {
		845	if ($_[0] =~ /^([^;]+)/ and (my $exts = delete $TERM->{meta}{autoload_osc_perl}{$1})) {
		846	$TERM->autoload_extension ($_->[0]) for @$exts;
		847	}
		848	}
		849
1054	$retval = undef;	850	$retval = undef;
1055		851
1056	if (my $cb = $TERM->{_hook}[$htype]) {	852	if (my $cb = $TERM->{_hook}[$htype]) {
1057	verbose 10, "$HOOKNAME[$htype] (" . (join ", ", $TERM, @_) . ")"	853	verbose 10, "$HOOKNAME[$htype] (" . (join ", ", $TERM, @_) . ")"
1058	if $verbosity >= 10;	854	if $verbosity >= 10;
1059		855
		856	if ($htype == HOOK_ACTION) {
		857	# this hook is only sent to the extension with the name
		858	# matching the first arg
		859	my $pkg = shift;
		860	$pkg =~ y/-/_/;
		861	$pkg = "urxvt::ext::$pkg";
		862
		863	$cb = $cb->{$pkg}
		864	or return undef; #TODO: maybe warn user?
		865
		866	$cb = { $pkg => $cb };
		867	}
		868
1060	for my $pkg (keys %$cb) {	869	for my $pkg (keys %$cb) {
1061	my $retval_ = eval { $cb->{$pkg}->($TERM->{_pkg}{$pkg}, @_) };	870	my $retval_ = eval { $cb->{$pkg}->($TERM->{_pkg}{$pkg} || $TERM, @_) };
1062	$retval ||= $retval_;	871	$retval ||= $retval_;
1063		872
1064	if ($@) {	873	if ($@) {
1065	$TERM->ungrab; # better to lose the grab than the session	874	$TERM->ungrab; # better to lose the grab than the session
1066	warn $@;	875	warn $@;
…		…
1069		878
1070	verbose 11, "$HOOKNAME[$htype] returning <$retval>"	879	verbose 11, "$HOOKNAME[$htype] returning <$retval>"
1071	if $verbosity >= 11;	880	if $verbosity >= 11;
1072	}	881	}
1073		882
1074	if ($htype == 1) { # DESTROY	883	if ($htype == HOOK_DESTROY) {
1075	# clear package objects	884	# clear package objects
1076	%$_ = () for values %{ $TERM->{_pkg} };	885	%$_ = () for values %{ $TERM->{_pkg} };
1077		886
1078	# clear package	887	# clear package
1079	%$TERM = ();	888	%$TERM = ();
…		…
1109	}	918	}
1110	}	919	}
1111	($mask, @color{qw(fg bg)}, \@failed)	920	($mask, @color{qw(fg bg)}, \@failed)
1112	}	921	}
1113		922
1114	# urxvt::term::extension
1115
1116	package urxvt::term::extension;	923	package urxvt::term::extension;
1117		924
1118	sub enable {	925	=head2 The C<urxvt::term::extension> class
1119	my ($self, %hook) = @_;
1120	my $pkg = $self->{_pkg};
1121		926
1122	while (my ($name, $cb) = each %hook) {	927	Each extension attached to a terminal object is represented by
1123	my $htype = $HOOKTYPE{uc $name};	928	a C<urxvt::term::extension> object.
1124	defined $htype
1125	or Carp::croak "unsupported hook type '$name'";
1126		929
1127	$self->set_should_invoke ($htype, +1)	930	You can use these objects, which are passed to all callbacks to store any
1128	unless exists $self->{term}{_hook}[$htype]{$pkg};	931	state related to the terminal and extension instance.
1129		932
1130	$self->{term}{_hook}[$htype]{$pkg} = $cb;	933	The methods (And data members) documented below can be called on extension
1131	}	934	objects, in addition to call methods documented for the <urxvt::term>
1132	}	935	class.
1133		936
1134	sub disable {	937	=over
1135	my ($self, @hook) = @_;
1136	my $pkg = $self->{_pkg};
1137		938
1138	for my $name (@hook) {	939	=item $urxvt_term = $self->{term}
1139	my $htype = $HOOKTYPE{uc $name};
1140	defined $htype
1141	or Carp::croak "unsupported hook type '$name'";
1142		940
1143	$self->set_should_invoke ($htype, -1)	941	Returns the C<urxvt::term> object associated with this instance of the
1144	if delete $self->{term}{_hook}[$htype]{$pkg};	942	extension. This member I<must not> be changed in any way.
1145	}	943
1146	}	944	=cut
1147		945
1148	our $AUTOLOAD;	946	our $AUTOLOAD;
1149		947
1150	sub AUTOLOAD {	948	sub AUTOLOAD {
1151	$AUTOLOAD =~ /:([^:]+)$/	949	$AUTOLOAD =~ /:([^:]+)$/
…		…
1164		962
1165	sub DESTROY {	963	sub DESTROY {
1166	# nop	964	# nop
1167	}	965	}
1168		966
1169	# urxvt::destroy_hook	967	# urxvt::destroy_hook (basically a cheap Guard:: implementation)
1170		968
1171	sub urxvt::destroy_hook::DESTROY {	969	sub urxvt::destroy_hook::DESTROY {
1172	${$_[0]}->();	970	${$_[0]}->();
1173	}	971	}
1174		972
1175	sub urxvt::destroy_hook(&) {	973	sub urxvt::destroy_hook(&) {
1176	bless \shift, urxvt::destroy_hook::	974	bless \shift, urxvt::destroy_hook::
1177	}	975	}
		976
		977	=item $self->enable ($hook_name => $cb[, $hook_name => $cb..])
		978
		979	Dynamically enable the given hooks (named without the C<on_> prefix) for
		980	this extension, replacing any hook previously installed via C<enable> in
		981	this extension.
		982
		983	This is useful when you want to overwrite time-critical hooks only
		984	temporarily.
		985
		986	To install additional callbacks for the same hook, you can use the C<on>
		987	method of the C<urxvt::term> class.
		988
		989	=item $self->disable ($hook_name[, $hook_name..])
		990
		991	Dynamically disable the given hooks.
		992
		993	=cut
		994
		995	sub enable {
		996	my ($self, %hook) = @_;
		997	my $pkg = $self->{_pkg};
		998
		999	while (my ($name, $cb) = each %hook) {
		1000	my $htype = $HOOKTYPE{uc $name};
		1001	defined $htype
		1002	or Carp::croak "unsupported hook type '$name'";
		1003
		1004	$self->set_should_invoke ($htype, +1)
		1005	unless exists $self->{term}{_hook}[$htype]{$pkg};
		1006
		1007	$self->{term}{_hook}[$htype]{$pkg} = $cb;
		1008	}
		1009	}
		1010
		1011	sub disable {
		1012	my ($self, @hook) = @_;
		1013	my $pkg = $self->{_pkg};
		1014
		1015	for my $name (@hook) {
		1016	my $htype = $HOOKTYPE{uc $name};
		1017	defined $htype
		1018	or Carp::croak "unsupported hook type '$name'";
		1019
		1020	$self->set_should_invoke ($htype, -1)
		1021	if delete $self->{term}{_hook}[$htype]{$pkg};
		1022	}
		1023	}
		1024
		1025	=item $guard = $self->on ($hook_name => $cb[, $hook_name => $cb..])
		1026
		1027	Similar to the C<enable> enable, but installs additional callbacks for
		1028	the given hook(s) (that is, it doesn't replace existing callbacks), and
		1029	returns a guard object. When the guard object is destroyed the callbacks
		1030	are disabled again.
		1031
		1032	=cut
		1033
		1034	sub urxvt::extension::on_disable::DESTROY {
		1035	my $disable = shift;
		1036
		1037	my $term = delete $disable->{""};
		1038
		1039	while (my ($htype, $id) = each %$disable) {
		1040	delete $term->{_hook}[$htype]{$id};
		1041	$term->set_should_invoke ($htype, -1);
		1042	}
		1043	}
		1044
		1045	sub on {
		1046	my ($self, %hook) = @_;
		1047
		1048	my $term = $self->{term};
		1049
		1050	my %disable = ( "" => $term );
		1051
		1052	while (my ($name, $cb) = each %hook) {
		1053	my $htype = $HOOKTYPE{uc $name};
		1054	defined $htype
		1055	or Carp::croak "unsupported hook type '$name'";
		1056
		1057	$term->set_should_invoke ($htype, +1);
		1058	$term->{_hook}[$htype]{ $disable{$htype} = $cb+0 }
		1059	= sub { shift; $cb->($self, @_) }; # very ugly indeed
		1060	}
		1061
		1062	bless \%disable, "urxvt::extension::on_disable"
		1063	}
		1064
		1065	=item $self->bind_action ($hotkey, $action)
		1066
		1067	=item $self->x_resource ($pattern)
		1068
		1069	=item $self->x_resource_boolean ($pattern)
		1070
		1071	These methods support an additional C<%> prefix for C<$action> or
		1072	C<$pattern> when called on an extension object, compared to the
		1073	C<urxvt::term> methods of the same name - see the description of these
		1074	methods in the C<urxvt::term> class for details.
		1075
		1076	=cut
		1077
		1078	sub bind_action {
		1079	my ($self, $hotkey, $action) = @_;
		1080	$action =~ s/^%:/$_[0]{_name}:/;
		1081	$self->{term}->bind_action ($hotkey, $action)
		1082	}
		1083
		1084	sub x_resource {
		1085	my ($self, $name) = @_;
		1086	$name =~ s/^%(\.|$)/$_[0]{_name}$1/;
		1087	$self->{term}->x_resource ($name)
		1088	}
		1089
		1090	sub x_resource_boolean {
		1091	my ($self, $name) = @_;
		1092	$name =~ s/^%(\.|$)/$_[0]{_name}$1/;
		1093	$self->{term}->x_resource_boolean ($name)
		1094	}
		1095
		1096	=back
		1097
		1098	=cut
1178		1099
1179	package urxvt::anyevent;	1100	package urxvt::anyevent;
1180		1101
1181	=head2 The C<urxvt::anyevent> Class	1102	=head2 The C<urxvt::anyevent> Class
1182		1103
1183	The sole purpose of this class is to deliver an interface to the	1104	The sole purpose of this class is to deliver an interface to the
1184	C<AnyEvent> module - any module using it will work inside urxvt without	1105	C<AnyEvent> module - any module using it will work inside urxvt without
1185	further programming. The only exception is that you cannot wait on	1106	further programming. The only exception is that you cannot wait on
1186	condition variables, but non-blocking condvar use is ok. What this means	1107	condition variables, but non-blocking condvar use is ok.
1187	is that you cannot use blocking APIs, but the non-blocking variant should	1108
1188	work.	1109	In practical terms this means is that you cannot use blocking APIs, but
		1110	the non-blocking variant should work.
1189		1111
1190	=cut	1112	=cut
1191		1113
1192	our $VERSION = '5.23';	1114	our $VERSION = '5.23';
1193		1115
…		…
1261		1183
1262	package urxvt::term;	1184	package urxvt::term;
1263		1185
1264	=head2 The C<urxvt::term> Class	1186	=head2 The C<urxvt::term> Class
1265		1187
1266	=over 4	1188	=over
1267		1189
1268	=cut	1190	=cut
1269		1191
1270	# find on_xxx subs in the package and register them	1192	# find on_xxx subs in the package and register them
1271	# as hooks	1193	# as hooks
1272	sub register_package {	1194	sub register_package {
1273	my ($self, $pkg, $argv) = @_;	1195	my ($self, $pkg, $argv) = @_;
1274		1196
		1197	return if $self->{_pkg}{$pkg};
		1198
1275	no strict 'refs';	1199	no strict 'refs';
1276		1200
1277	urxvt::verbose 6, "register package $pkg to $self";	1201	urxvt::verbose 6, "register package $pkg to $self";
1278		1202
1279	@{"$pkg\::ISA"} = urxvt::term::extension::;	1203	@{"$pkg\::ISA"} = urxvt::term::extension::;
1280		1204
1281	my $proxy = bless {	1205	my $proxy = bless {
1282	_pkg => $pkg,	1206	_pkg => $pkg,
		1207	_name => ${"$pkg\::_NAME"}, # hackish
1283	argv => $argv,	1208	argv => $argv,
1284	}, $pkg;	1209	}, $pkg;
1285	Scalar::Util::weaken ($proxy->{term} = $self);	1210	Scalar::Util::weaken ($proxy->{term} = $self);
1286		1211
1287	$self->{_pkg}{$pkg} = $proxy;	1212	$self->{_pkg}{$pkg} = $proxy;
1288		1213
1289	for my $name (@HOOKNAME) {	1214	for my $name (@HOOKNAME) {
1290	if (my $ref = $pkg->can ("on_" . lc $name)) {	1215	if (my $ref = $pkg->can ("on_" . lc $name)) {
1291	$proxy->enable ($name => $ref);	1216	$proxy->enable ($name => $ref);
1292	}	1217	}
1293	}	1218	}
		1219
		1220	if (my $attach_hook = $pkg->can ("on_attach")) {
		1221	$attach_hook->($proxy)
		1222	or urxvt::verbose 1, "$pkg->on_attach returned false, extension failed to attach";
		1223	}
		1224	}
		1225
		1226	# map extension name to filesystem path
		1227	sub extension_path {
		1228	(grep -f $_, map "$_/$_[1]", $_[0]->perl_libdirs)[0]
		1229	}
		1230
		1231	# load an extension by name
		1232	sub load_extension_file {
		1233	my ($self, $path, $argv) = @_;
		1234
		1235	$self->register_package (urxvt::extension_package $path, $argv);
		1236	}
		1237
		1238	# autoload an extension unless loading it is prohibited
		1239	sub autoload_extension {
		1240	my ($self, $name, $argv) = @_;
		1241
		1242	return if exists $self->{ext_prohibit}{$name};
		1243
		1244	my $path = $self->extension_path ($name)
		1245	// return urxvt::verbose 2, "perl extension '$name' not found in perl library search path (during autoload)";
		1246
		1247	$self->load_extension_file ($path, $argv);
		1248	}
		1249
		1250	sub perl_libdirs {
		1251	map { split /:/ }
		1252	$_[0]->resource ("perl_lib"),
		1253	$ENV{URXVT_PERL_LIB},
		1254	"$ENV{HOME}/.urxvt/ext",
		1255	"$LIBDIR/perl"
		1256	}
		1257
		1258	# scan for available extensions and collect their metadata
		1259	sub scan_extensions {
		1260	my ($self) = @_;
		1261
		1262	return if exists $self->{meta};
		1263
		1264	my @urxvtdirs = perl_libdirs $self;
		1265	# my @cpandirs = grep -d, map "$_/URxvt/Ext", @INC;
		1266
		1267	$self->{meta} = \my %allmeta;
		1268
		1269	# first gather extensions
		1270
		1271	my $gather = sub {
		1272	my ($dir, $core) = @_;
		1273
		1274	opendir my $fh, $dir
		1275	or return;
		1276
		1277	for my $ext (readdir $fh) {
		1278	$ext !~ /^\./
		1279	or next;
		1280
		1281	open my $fh, "<", "$dir/$ext"
		1282	or next;
		1283
		1284	-f $fh
		1285	or next;
		1286
		1287	$ext =~ s/\.uext$// or $core
		1288	or next;
		1289
		1290	my %meta = (dir => $dir);
		1291
		1292	while (<$fh>) {
		1293	if (/^#:META:(?:X_)?RESOURCE:(.*)/) {
		1294	my ($pattern, $type, $desc) = split /:/, $1;
		1295	$pattern =~ s/^%(\.|$)/$ext$1/g; # % in pattern == extension name
		1296	if ($pattern =~ /[^a-zA-Z0-9\-\.]/) {
		1297	warn "$dir/$ext: meta resource '$pattern' contains illegal characters (not alphanumeric nor . nor *)\n";
		1298	} else {
		1299	$meta{resource}{$pattern} = [$ext, $type, $desc];
		1300	}
		1301
		1302	} elsif (/^#:META:OSC:([0-9]+):(.*)/) {
		1303	push @{$allmeta{autoload_osc}{$1}}, [$ext, $2];
		1304
		1305	} elsif (/^#:META:OSC_PERL:([^:]+):(.*)/) {
		1306	push @{$allmeta{autoload_osc_perl}{$1}}, [$ext, $2];
		1307
		1308	} elsif (/^\s*(?:#|$)/) {
		1309	# skip other comments and empty lines
		1310
		1311	} else {
		1312	last; # stop parsing on first non-empty non-comment line
		1313	}
		1314	}
		1315
		1316	$allmeta{ext}{$ext} = \%meta;
		1317	}
		1318	};
		1319
		1320	# $gather->($_, 0) for @cpandirs;
		1321	$gather->($_, 1) for @urxvtdirs;
		1322
		1323	# and now merge resources
		1324
		1325	$allmeta{resource} = \my %resource;
		1326
		1327	while (my ($k, $v) = each %{ $allmeta{ext} }) {
		1328	#TODO: should check for extensions overriding each other
		1329	%resource = (%resource, %{ $v->{resource} });
		1330	}
1294	}	1331	}
1295		1332
1296	=item $term = new urxvt::term $envhashref, $rxvtname, [arg...]	1333	=item $term = new urxvt::term $envhashref, $rxvtname, [arg...]
1297		1334
1298	Creates a new terminal, very similar as if you had started it with system	1335	Creates a new terminal, very similar as if you had started it with system
…		…
1317	}	1354	}
1318		1355
1319	=item $term->destroy	1356	=item $term->destroy
1320		1357
1321	Destroy the terminal object (close the window, free resources	1358	Destroy the terminal object (close the window, free resources
1322	etc.). Please note that @@RXVT_NAME@@ will not exit as long as any event	1359	etc.). Please note that urxvt will not exit as long as any event
1323	watchers (timers, io watchers) are still active.	1360	watchers (timers, io watchers) are still active.
1324		1361
1325	=item $term->exec_async ($cmd[, @args])	1362	=item $term->exec_async ($cmd[, @args])
1326		1363
1327	Works like the combination of the C<fork>/C<exec> builtins, which executes	1364	Works like the combination of the C<fork>/C<exec> builtins, which executes
1328	("starts") programs in the background. This function takes care of setting	1365	("starts") programs in the background. This function takes care of setting
1329	the user environment before exec'ing the command (e.g. C<PATH>) and should	1366	the user environment before exec'ing the command (e.g. C<PATH>) and should
1330	be preferred over explicit calls to C<exec> or C<system>.	1367	be preferred over explicit calls to C<exec> or C<system>.
1331		1368
		1369	It also sets the C<URXVT_EXT_WINDOWID> environment variable to the window
		1370	ID of the terminal (C<< $self->parent >>), similar to the C<WINDOWID>
		1371	variable set for the process spawned inside the terminal.
		1372
1332	Returns the pid of the subprocess or C<undef> on error.	1373	Returns the pid of the subprocess or C<undef> on error.
1333		1374
1334	=cut	1375	=cut
1335		1376
1336	sub exec_async {	1377	sub exec_async {
…		…
1339	my $pid = fork;	1380	my $pid = fork;
1340		1381
1341	return $pid	1382	return $pid
1342	if !defined $pid or $pid;	1383	if !defined $pid or $pid;
1343		1384
		1385	%ENV = (
1344	%ENV = %{ $self->env };	1386	%{ $self->env },
		1387	URXVT_EXT_WINDOWID => $self->parent,
		1388	);
1345		1389
1346	exec @_;	1390	exec @_;
1347	urxvt::_exit 255;	1391	urxvt::_exit 255;
1348	}	1392	}
1349		1393
…		…
1360	insecure intensityStyles iso14755 iso14755_52 jumpScroll loginShell	1404	insecure intensityStyles iso14755 iso14755_52 jumpScroll loginShell
1361	mapAlert meta8 mouseWheelScrollPage override_redirect pastableTabs	1405	mapAlert meta8 mouseWheelScrollPage override_redirect pastableTabs
1362	pointerBlank reverseVideo scrollBar scrollBar_floating scrollBar_right	1406	pointerBlank reverseVideo scrollBar scrollBar_floating scrollBar_right
1363	scrollTtyKeypress scrollTtyOutput scrollWithBuffer secondaryScreen	1407	scrollTtyKeypress scrollTtyOutput scrollWithBuffer secondaryScreen
1364	secondaryScroll skipBuiltinGlyphs skipScroll transparent tripleclickwords	1408	secondaryScroll skipBuiltinGlyphs skipScroll transparent tripleclickwords
1365	urgentOnBell utmpInhibit visualBell	1409	urgentOnBell utmpInhibit visualBell disablePasteBrackets
1366		1410
1367	=item $value = $term->resource ($name[, $newval])	1411	=item $value = $term->resource ($name[, $newval])
1368		1412
1369	Returns the current resource value associated with a given name and	1413	Returns the current resource value associated with a given name and
1370	optionally sets a new value. Setting values is most useful in the C<init>	1414	optionally sets a new value. Setting values is most useful in the C<init>
…		…
1383		1427
1384	Here is a likely non-exhaustive list of resource names, not all of which	1428	Here is a likely non-exhaustive list of resource names, not all of which
1385	are supported in every build, please see the source file F</src/rsinc.h>	1429	are supported in every build, please see the source file F</src/rsinc.h>
1386	to see the actual list:	1430	to see the actual list:
1387		1431
1388	answerbackstring backgroundPixmap backspace_key blendtype blurradius	1432	answerbackstring backgroundPixmap backspace_key blurradius
1389	boldFont boldItalicFont borderLess buffered chdir color cursorBlink	1433	boldFont boldItalicFont borderLess buffered chdir color cursorBlink
1390	cursorUnderline cutchars delete_key depth display_name embed ext_bwidth	1434	cursorUnderline cutchars delete_key depth display_name embed ext_bwidth
1391	fade font geometry hold iconName iconfile imFont imLocale inputMethod	1435	fade font geometry hold iconName iconfile imFont imLocale inputMethod
1392	insecure int_bwidth intensityStyles iso14755 iso14755_52 italicFont	1436	insecure int_bwidth intensityStyles iso14755 iso14755_52 italicFont
1393	jumpScroll letterSpace lineSpace loginShell mapAlert meta8 modifier	1437	jumpScroll letterSpace lineSpace loginShell mapAlert meta8 modifier
…		…
1396	preeditType print_pipe pty_fd reverseVideo saveLines scrollBar	1440	preeditType print_pipe pty_fd reverseVideo saveLines scrollBar
1397	scrollBar_align scrollBar_floating scrollBar_right scrollBar_thickness	1441	scrollBar_align scrollBar_floating scrollBar_right scrollBar_thickness
1398	scrollTtyKeypress scrollTtyOutput scrollWithBuffer scrollstyle	1442	scrollTtyKeypress scrollTtyOutput scrollWithBuffer scrollstyle
1399	secondaryScreen secondaryScroll shade skipBuiltinGlyphs skipScroll	1443	secondaryScreen secondaryScroll shade skipBuiltinGlyphs skipScroll
1400	term_name title transient_for transparent tripleclickwords urgentOnBell	1444	term_name title transient_for transparent tripleclickwords urgentOnBell
1401	utmpInhibit visualBell	1445	utmpInhibit visualBell rewrapMode disablePasteBrackets
1402		1446
1403	=cut	1447	=cut
1404		1448
1405	sub resource($$;$) {	1449	sub resource($$;$) {
1406	my ($self, $name) = (shift, shift);	1450	my ($self, $name) = (shift, shift);
…		…
1413	Returns the X-Resource for the given pattern, excluding the program or	1457	Returns the X-Resource for the given pattern, excluding the program or
1414	class name, i.e. C<< $term->x_resource ("boldFont") >> should return the	1458	class name, i.e. C<< $term->x_resource ("boldFont") >> should return the
1415	same value as used by this instance of rxvt-unicode. Returns C<undef> if no	1459	same value as used by this instance of rxvt-unicode. Returns C<undef> if no
1416	resource with that pattern exists.	1460	resource with that pattern exists.
1417		1461
		1462	Extensions that define extra resources also need to call this method
		1463	to access their values.
		1464
		1465	If the method is called on an extension object (basically, from an
		1466	extension), then the special prefix C<%.> will be replaced by the name of
		1467	the extension and a dot, and the lone string C<%> will be replaced by the
		1468	extension name itself. This makes it possible to code extensions so you
		1469	can rename them and get a new set of resources without having to change
		1470	the actual code.
		1471
1418	This method should only be called during the C<on_start> hook, as there is	1472	This method should only be called during the C<on_start> hook, as there is
1419	only one resource database per display, and later invocations might return	1473	only one resource database per display, and later invocations might return
1420	the wrong resources.	1474	the wrong resources.
1421		1475
1422	=item $success = $term->parse_keysym ($key, $octets)	1476	=item $value = $term->x_resource_boolean ($pattern)
1423		1477
		1478	Like C<x_resource>, above, but interprets the string value as a boolean
		1479	and returns C<1> for true values, C<0> for false values and C<undef> if
		1480	the resource or option isn't specified.
		1481
		1482	You should always use this method to parse boolean resources.
		1483
		1484	=cut
		1485
		1486	sub x_resource_boolean {
		1487	my $res = &x_resource;
		1488
		1489	$res =~ /^\s*(?:true|yes|on|1)\s*$/i ? 1 : defined $res && 0
		1490	}
		1491
		1492	=item $action = $term->lookup_keysym ($keysym, $state)
		1493
		1494	Returns the action bound to key combination C<($keysym, $state)>,
		1495	if a binding for it exists, and C<undef> otherwise.
		1496
		1497	=item $success = $term->bind_action ($key, $action)
		1498
1424	Adds a key binding exactly as specified via a resource. See the	1499	Adds a key binding exactly as specified via a C<keysym> resource. See the
1425	C<keysym> resource in the @@RXVT_NAME@@(1) manpage.	1500	C<keysym> resource in the urxvt(1) manpage.
1426		1501
1427	=item $term->register_command ($keysym, $modifiermask, $string)	1502	To add default bindings for actions, an extension should call C<<
		1503	->bind_action >> in its C<init> hook for every such binding. Doing it
		1504	in the C<init> hook allows users to override or remove the binding
		1505	again.
1428		1506
1429	Adds a key binding. This is a lower level api compared to	1507	Example: the C<searchable-scrollback> by default binds itself
1430	C<parse_keysym>, as it expects a parsed key description, and can be	1508	on C<Meta-s>, using C<< $self->bind_action >>, which calls C<<
1431	used only inside either the C<on_init> hook, to add a binding, or the	1509	$term->bind_action >>.
1432	C<on_register_command> hook, to modify a parsed binding.	1510
		1511	sub init {
		1512	my ($self) = @_;
		1513
		1514	$self->bind_action ("M-s" => "%:start");
		1515	}
1433		1516
1434	=item $rend = $term->rstyle ([$new_rstyle])	1517	=item $rend = $term->rstyle ([$new_rstyle])
1435		1518
1436	Return and optionally change the current rendition. Text that is output by	1519	Return and optionally change the current rendition. Text that is output by
1437	the terminal application will use this style.	1520	the terminal application will use this style.
…		…
1514	This method returns an urxvt::overlay object. The overlay will be visible	1597	This method returns an urxvt::overlay object. The overlay will be visible
1515	as long as the perl object is referenced.	1598	as long as the perl object is referenced.
1516		1599
1517	The methods currently supported on C<urxvt::overlay> objects are:	1600	The methods currently supported on C<urxvt::overlay> objects are:
1518		1601
1519	=over 4	1602	=over
1520		1603
1521	=item $overlay->set ($x, $y, $text[, $rend])	1604	=item $overlay->set ($x, $y, $text[, $rend])
1522		1605
1523	Similar to C<< $term->ROW_t >> and C<< $term->ROW_r >> in that it puts	1606	Similar to C<< $term->ROW_t >> and C<< $term->ROW_r >> in that it puts
1524	text in rxvt-unicode's special encoding and an array of rendition values	1607	text in rxvt-unicode's special encoding and an array of rendition values
…		…
1568	Returns the number of screen-cells this string would need. Correctly	1651	Returns the number of screen-cells this string would need. Correctly
1569	accounts for wide and combining characters.	1652	accounts for wide and combining characters.
1570		1653
1571	=item $octets = $term->locale_encode ($string)	1654	=item $octets = $term->locale_encode ($string)
1572		1655
1573	Convert the given text string into the corresponding locale encoding.	1656	Convert the given text string into the corresponding locale
		1657	encoding. Returns C<undef> if C<$string> is C<undef>.
1574		1658
1575	=item $string = $term->locale_decode ($octets)	1659	=item $string = $term->locale_decode ($octets)
1576		1660
1577	Convert the given locale-encoded octets into a perl string.	1661	Convert the given locale-encoded octets into a perl string. Returns
		1662	C<undef> if C<$octets> is C<undef>.
1578		1663
1579	=item $term->scr_xor_span ($beg_row, $beg_col, $end_row, $end_col[, $rstyle])	1664	=item $term->scr_xor_span ($beg_row, $beg_col, $end_row, $end_col[, $rstyle])
1580		1665
1581	XORs the rendition values in the given span with the provided value	1666	XORs the rendition values in the given span with the provided value
1582	(default: C<RS_RVid>), which I<MUST NOT> contain font styles. Useful in	1667	(default: C<RS_RVid>), which I<MUST NOT> contain font styles. Useful in
…		…
1595		1680
1596	=item $term->scr_add_lines ($string)	1681	=item $term->scr_add_lines ($string)
1597		1682
1598	Write the given text string to the screen, as if output by the application	1683	Write the given text string to the screen, as if output by the application
1599	running inside the terminal. It may not contain command sequences (escape	1684	running inside the terminal. It may not contain command sequences (escape
1600	codes), but is free to use line feeds, carriage returns and tabs. The	1685	codes - see C<cmd_parse> for that), but is free to use line feeds,
1601	string is a normal text string, not in locale-dependent encoding.	1686	carriage returns and tabs. The string is a normal text string, not in
		1687	locale-dependent encoding.
1602		1688
1603	Normally its not a good idea to use this function, as programs might be	1689	Normally its not a good idea to use this function, as programs might be
1604	confused by changes in cursor position or scrolling. Its useful inside a	1690	confused by changes in cursor position or scrolling. Its useful inside a
1605	C<on_add_lines> hook, though.	1691	C<on_add_lines> hook, though.
1606		1692
…		…
1614	locale-specific encoding of the terminal and can contain command sequences	1700	locale-specific encoding of the terminal and can contain command sequences
1615	(escape codes) that will be interpreted.	1701	(escape codes) that will be interpreted.
1616		1702
1617	=item $term->tt_write ($octets)	1703	=item $term->tt_write ($octets)
1618		1704
1619	Write the octets given in C<$octets> to the tty (i.e. as program input). To	1705	Write the octets given in C<$octets> to the tty (i.e. as user input
		1706	to the program, see C<cmd_parse> for the opposite direction). To pass
1620	pass characters instead of octets, you should convert your strings first	1707	characters instead of octets, you should convert your strings first to the
1621	to the locale-specific encoding using C<< $term->locale_encode >>.	1708	locale-specific encoding using C<< $term->locale_encode >>.
		1709
		1710	=item $term->tt_write_user_input ($octets)
		1711
		1712	Like C<tt_write>, but should be used when writing strings in response to
		1713	the user pressing a key, to invoke the additional actions requested by
		1714	the user for that case (C<tt_write> doesn't do that).
		1715
		1716	The typical use case would be inside C<on_action> hooks.
1622		1717
1623	=item $term->tt_paste ($octets)	1718	=item $term->tt_paste ($octets)
1624		1719
1625	Write the octets given in C<$octets> to the tty as a paste, converting NL to	1720	Write the octets given in C<$octets> to the tty as a paste, converting NL to
1626	CR and bracketing the data with control sequences if bracketed paste mode	1721	CR and bracketing the data with control sequences if bracketed paste mode
…		…
1665		1760
1666	=item $term->key_release ($state, $keycode[, $time])	1761	=item $term->key_release ($state, $keycode[, $time])
1667		1762
1668	Deliver various fake events to to terminal.	1763	Deliver various fake events to to terminal.
1669		1764
1670	=item $window_width = $term->width	1765	=item $window_width = $term->width ([$new_value])
1671		1766
1672	=item $window_height = $term->height	1767	=item $window_height = $term->height ([$new_value])
1673		1768
1674	=item $font_width = $term->fwidth	1769	=item $font_width = $term->fwidth ([$new_value])
1675		1770
1676	=item $font_height = $term->fheight	1771	=item $font_height = $term->fheight ([$new_value])
1677		1772
1678	=item $font_ascent = $term->fbase	1773	=item $font_ascent = $term->fbase ([$new_value])
1679		1774
1680	=item $terminal_rows = $term->nrow	1775	=item $terminal_rows = $term->nrow ([$new_value])
1681		1776
1682	=item $terminal_columns = $term->ncol	1777	=item $terminal_columns = $term->ncol ([$new_value])
1683		1778
1684	=item $has_focus = $term->focus	1779	=item $has_focus = $term->focus ([$new_value])
1685		1780
1686	=item $is_mapped = $term->mapped	1781	=item $is_mapped = $term->mapped ([$new_value])
1687		1782
1688	=item $max_scrollback = $term->saveLines	1783	=item $max_scrollback = $term->saveLines ([$new_value])
1689		1784
1690	=item $nrow_plus_saveLines = $term->total_rows	1785	=item $nrow_plus_saveLines = $term->total_rows ([$new_value])
1691		1786
1692	=item $topmost_scrollback_row = $term->top_row	1787	=item $topmost_scrollback_row = $term->top_row ([$new_value])
1693		1788
1694	Return various integers describing terminal characteristics.	1789	Return various integers describing terminal characteristics. If an
		1790	argument is given, changes the value and returns the previous one.
1695		1791
1696	=item $x_display = $term->display_id	1792	=item $x_display = $term->display_id
1697		1793
1698	Return the DISPLAY used by rxvt-unicode.	1794	Return the DISPLAY used by rxvt-unicode.
1699		1795
…		…
1736		1832
1737	=item $cursor_is_hidden = $term->hidden_cursor	1833	=item $cursor_is_hidden = $term->hidden_cursor
1738		1834
1739	Returns whether the cursor is currently hidden or not.	1835	Returns whether the cursor is currently hidden or not.
1740		1836
		1837	=item $priv_modes = $term->priv_modes
		1838
		1839	Returns a bitset with the state of DEC private modes.
		1840
		1841	Example:
		1842
		1843	if ($term->priv_modes & urxvt::PrivMode_mouse_report) {
		1844	# mouse reporting is turned on
		1845	}
		1846
1741	=item $view_start = $term->view_start ([$newvalue])	1847	=item $view_start = $term->view_start ([$newvalue])
1742		1848
1743	Returns the row number of the topmost displayed line. Maximum value is	1849	Returns the row number of the topmost displayed line and changes it,
1744	C<0>, which displays the normal terminal contents. Lower values scroll	1850	if an argument is given. Values greater than or equal to C<0> display
1745	this many lines into the scrollback buffer.	1851	the terminal contents. Lower values scroll this many lines into the
		1852	scrollback buffer.
1746		1853
1747	=item $term->want_refresh	1854	=item $term->want_refresh
1748		1855
1749	Requests a screen refresh. At the next opportunity, rxvt-unicode will	1856	Requests a screen refresh. At the next opportunity, rxvt-unicode will
1750	compare the on-screen display with its stored representation. If they	1857	compare the on-screen display with its stored representation. If they
1751	differ, it redraws the differences.	1858	differ, it redraws the differences.
1752		1859
1753	Used after changing terminal contents to display them.	1860	Used after changing terminal contents to display them.
		1861
		1862	=item $term->refresh_check
		1863
		1864	Checks if a refresh has been requested and, if so, schedules one.
1754		1865
1755	=item $text = $term->ROW_t ($row_number[, $new_text[, $start_col]])	1866	=item $text = $term->ROW_t ($row_number[, $new_text[, $start_col]])
1756		1867
1757	Returns the text of the entire row with number C<$row_number>. Row C<< $term->top_row >>	1868	Returns the text of the entire row with number C<$row_number>. Row C<< $term->top_row >>
1758	is the topmost terminal line, row C<< $term->nrow-1 >> is the bottommost	1869	is the topmost terminal line, row C<< $term->nrow-1 >> is the bottommost
…		…
1804		1915
1805	Create and return a new C<urxvt::line> object that stores information	1916	Create and return a new C<urxvt::line> object that stores information
1806	about the logical line that row C<$row_number> is part of. It supports the	1917	about the logical line that row C<$row_number> is part of. It supports the
1807	following methods:	1918	following methods:
1808		1919
1809	=over 4	1920	=over
1810		1921
1811	=item $text = $line->t ([$new_text])	1922	=item $text = $line->t ([$new_text])
1812		1923
1813	Returns or replaces the full text of the line, similar to C<ROW_t>	1924	Returns or replaces the full text of the line, similar to C<ROW_t>
1814		1925
…		…
1860	}	1971	}
1861		1972
1862	sub urxvt::line::t {	1973	sub urxvt::line::t {
1863	my ($self) = @_;	1974	my ($self) = @_;
1864		1975
1865	if (@_ > 1)	1976	if (@_ > 1) {
1866	{
1867	$self->{term}->ROW_t ($_, $_[1], 0, ($_ - $self->{beg}) * $self->{ncol}, $self->{ncol})	1977	$self->{term}->ROW_t ($_, $_[1], 0, ($_ - $self->{beg}) * $self->{ncol}, $self->{ncol})
1868	for $self->{beg} .. $self->{end};	1978	for $self->{beg} .. $self->{end};
1869	}	1979	}
1870		1980
1871	defined wantarray &&	1981	defined wantarray &&
1872	substr +(join "", map $self->{term}->ROW_t ($_), $self->{beg} .. $self->{end}),	1982	substr +(join "", map $self->{term}->ROW_t ($_), $self->{beg} .. $self->{end}),
1873	0, $self->{len}	1983	0, $self->{len}
1874	}	1984	}
1875		1985
1876	sub urxvt::line::r {	1986	sub urxvt::line::r {
1877	my ($self) = @_;	1987	my ($self) = @_;
1878		1988
1879	if (@_ > 1)	1989	if (@_ > 1) {
1880	{
1881	$self->{term}->ROW_r ($_, $_[1], 0, ($_ - $self->{beg}) * $self->{ncol}, $self->{ncol})	1990	$self->{term}->ROW_r ($_, $_[1], 0, ($_ - $self->{beg}) * $self->{ncol}, $self->{ncol})
1882	for $self->{beg} .. $self->{end};	1991	for $self->{beg} .. $self->{end};
1883	}	1992	}
1884		1993
1885	if (defined wantarray) {	1994	if (defined wantarray) {
1886	my $rend = [	1995	my $rend = [
1887	map @{ $self->{term}->ROW_r ($_) }, $self->{beg} .. $self->{end}	1996	map @{ $self->{term}->ROW_r ($_) }, $self->{beg} .. $self->{end}
1888	];	1997	];
…		…
1912	$offset / $self->{ncol} + $self->{beg},	2021	$offset / $self->{ncol} + $self->{beg},
1913	$offset % $self->{ncol}	2022	$offset % $self->{ncol}
1914	)	2023	)
1915	}	2024	}
1916		2025
1917	=item $text = $term->special_encode $string	2026	=item $text = $term->special_encode ($string)
1918		2027
1919	Converts a perl string into the special encoding used by rxvt-unicode,	2028	Converts a perl string into the special encoding used by rxvt-unicode,
1920	where one character corresponds to one screen cell. See	2029	where one character corresponds to one screen cell. See
1921	C<< $term->ROW_t >> for details.	2030	C<< $term->ROW_t >> for details.
1922		2031
1923	=item $string = $term->special_decode $text	2032	=item $string = $term->special_decode ($text)
1924		2033
1925	Converts rxvt-unicodes text representation into a perl string. See	2034	Converts rxvt-unicode's text representation into a perl string. See
1926	C<< $term->ROW_t >> for details.	2035	C<< $term->ROW_t >> for details.
1927		2036
1928	=item $success = $term->grab_button ($button, $modifiermask[, $window = $term->vt])	2037	=item $success = $term->grab_button ($button, $modifiermask[, $window = $term->vt])
1929		2038
1930	=item $term->ungrab_button ($button, $modifiermask[, $window = $term->vt])	2039	=item $term->ungrab_button ($button, $modifiermask[, $window = $term->vt])
…		…
1996		2105
1997	package urxvt::popup;	2106	package urxvt::popup;
1998		2107
1999	=head2 The C<urxvt::popup> Class	2108	=head2 The C<urxvt::popup> Class
2000		2109
2001	=over 4	2110	=over
2002		2111
2003	=cut	2112	=cut
2004		2113
2005	sub add_item {	2114	sub add_item {
2006	my ($self, $item) = @_;	2115	my ($self, $item) = @_;
…		…
2142	->cb (sub {	2251	->cb (sub {
2143	$term->{overlay}->set (0, 0,	2252	$term->{overlay}->set (0, 0,
2144	sprintf "%2d:%02d:%02d", (localtime urxvt::NOW)[2,1,0]);	2253	sprintf "%2d:%02d:%02d", (localtime urxvt::NOW)[2,1,0]);
2145	});	2254	});
2146		2255
2147	=over 4	2256	=over
2148		2257
2149	=item $timer = new urxvt::timer	2258	=item $timer = new urxvt::timer
2150		2259
2151	Create a new timer object in started state. It is scheduled to fire	2260	Create a new timer object in started state. It is scheduled to fire
2152	immediately.	2261	immediately.
…		…
2201	sysread $term->{socket}, my $buf, 8192	2310	sysread $term->{socket}, my $buf, 8192
2202	or end-of-file;	2311	or end-of-file;
2203	});	2312	});
2204		2313
2205		2314
2206	=over 4	2315	=over
2207		2316
2208	=item $iow = new urxvt::iow	2317	=item $iow = new urxvt::iow
2209		2318
2210	Create a new io watcher object in stopped state.	2319	Create a new io watcher object in stopped state.
2211		2320
…		…
2238		2347
2239	This class implements idle watchers, that get called automatically when	2348	This class implements idle watchers, that get called automatically when
2240	the process is idle. They should return as fast as possible, after doing	2349	the process is idle. They should return as fast as possible, after doing
2241	some useful work.	2350	some useful work.
2242		2351
2243	=over 4	2352	=over
2244		2353
2245	=item $iw = new urxvt::iw	2354	=item $iw = new urxvt::iw
2246		2355
2247	Create a new idle watcher object in stopped state.	2356	Create a new idle watcher object in stopped state.
2248		2357
…		…
2273	->cb (sub {	2382	->cb (sub {
2274	my ($pw, $exit_status) = @_;	2383	my ($pw, $exit_status) = @_;
2275	...	2384	...
2276	});	2385	});
2277		2386
2278	=over 4	2387	=over
2279		2388
2280	=item $pw = new urxvt::pw	2389	=item $pw = new urxvt::pw
2281		2390
2282	Create a new process watcher in stopped state.	2391	Create a new process watcher in stopped state.
2283		2392
…		…
2300	=head2 URXVT_PERL_VERBOSITY	2409	=head2 URXVT_PERL_VERBOSITY
2301		2410
2302	This variable controls the verbosity level of the perl extension. Higher	2411	This variable controls the verbosity level of the perl extension. Higher
2303	numbers indicate more verbose output.	2412	numbers indicate more verbose output.
2304		2413
2305	=over 4	2414	=over
2306		2415
2307	=item == 0 - fatal messages	2416	=item == 0 - fatal messages only
		2417
		2418	=item >= 2 - general warnings (default level)
2308		2419
2309	=item >= 3 - script loading and management	2420	=item >= 3 - script loading and management
2310		2421
2311	=item >=10 - all called hooks	2422	=item >=10 - all called hooks
2312		2423

Diff Legend

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