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.196 by sf-exg, Wed Jun 29 22:46:48 2011 UTC vs.
Revision 1.270 by root, Fri Nov 26 18:49:47 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' 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 from the keyboard.
265	Simply bind a keysym to "perl:matcher" as seen in the example below.
266
267	Example configuration:
268
269	URxvt.perl-ext: default,matcher
270	URxvt.urlLauncher: sensible-browser
271	URxvt.keysym.C-Delete: perl:matcher
272	URxvt.matcher.button: 1
273	URxvt.matcher.pattern.1: \\bwww\\.[\\w-]+\\.[\\w./?&@#-]*[\\w/-]
274	URxvt.matcher.pattern.2: \\B(/\\S+?):(\\d+)(?=:|$)
275	URxvt.matcher.launcher.2: gvim +$2 $1
276
277	=item xim-onthespot
278
279	This (experimental) perl extension implements OnTheSpot editing. It does
280	not work perfectly, and some input methods don't seem to work well with
281	OnTheSpot editing in general, but it seems to work at least for SCIM and
282	kinput2.
283
284	You enable it by specifying this extension and a preedit style of
285	C<OnTheSpot>, i.e.:
286
287	@@RXVT_NAME@@ -pt OnTheSpot -pe xim-onthespot
288
289	=item kuake<hotkey>
290
291	A very primitive quake-console-like extension. It was inspired by a
292	description of how the programs C<kuake> and C<yakuake> work: Whenever the
293	user presses a global accelerator key (by default C<F10>), the terminal
294	will show or hide itself. Another press of the accelerator key will hide
295	or show it again.
296
297	Initially, the window will not be shown when using this extension.
298
299	This is useful if you need a single terminal that is not using any desktop
300	space most of the time but is quickly available at the press of a key.
301
302	The accelerator key is grabbed regardless of any modifiers, so this
303	extension will actually grab a physical key just for this function.
304
305	If you want a quake-like animation, tell your window manager to do so
306	(fvwm can do it).
307
308	=item overlay-osc
309
310	This extension implements some OSC commands to display timed popups on the
311	screen - useful for status displays from within scripts. You have to read
312	the sources for more info.
313
314	=item block-graphics-to-ascii
315
316	A not very useful example of filtering all text output to the terminal
317	by replacing all line-drawing characters (U+2500 .. U+259F) by a
318	similar-looking ascii character.
319
320	=item digital-clock
321
322	Displays a digital clock using the built-in overlay.
323
324	=item remote-clipboard
325
326	Somewhat of a misnomer, this extension adds two menu entries to the
327	selection popup that allows one to run external commands to store the
328	selection somewhere and fetch it again.
329
330	We use it to implement a "distributed selection mechanism", which just
331	means that one command uploads the file to a remote server, and another
332	reads it.
333
334	The commands can be set using the C<URxvt.remote-selection.store> and
335	C<URxvt.remote-selection.fetch> resources. The first should read the
336	selection to store from STDIN (always in UTF-8), the second should provide
337	the selection data on STDOUT (also in UTF-8).
338
339	The defaults (which are likely useless to you) use rsh and cat:
340
341	URxvt.remote-selection.store: rsh ruth 'cat >/tmp/distributed-selection'
342	URxvt.remote-selection.fetch: rsh ruth 'cat /tmp/distributed-selection'
343
344	=item selection-pastebin
345
346	This is a little rarely useful extension that uploads the selection as
347	textfile to a remote site (or does other things). (The implementation is
348	not currently secure for use in a multiuser environment as it writes to
349	F</tmp> directly.).
350
351	It listens to the C<selection-pastebin:remote-pastebin> keyboard command,
352	i.e.
353
354	URxvt.keysym.C-M-e: perl:selection-pastebin:remote-pastebin
355
356	Pressing this combination runs a command with C<%> replaced by the name of
357	the textfile. This command can be set via a resource:
358
359	URxvt.selection-pastebin.cmd: rsync -apP % ruth:/var/www/www.ta-sa.org/files/txt/.
360
361	And the default is likely not useful to anybody but the few people around
362	here :)
363
364	The name of the textfile is the hex encoded md5 sum of the selection, so
365	the same content should lead to the same filename.
366
367	After a successful upload the selection will be replaced by the text given
368	in the C<selection-pastebin-url> resource (again, the % is the placeholder
369	for the filename):
370
371	URxvt.selection-pastebin.url: http://www.ta-sa.org/files/txt/%
372
373	I<Note to xrdb users:> xrdb uses the C preprocessor, which might interpret
374	the double C</> characters as comment start. Use C<\057\057> instead,
375	which works regardless of whether xrdb is used to parse the resource file
376	or not.
377
378	=item macosx-clipboard and macosx-clipboard-native
379
380	These two modules implement an extended clipboard for Mac OS X. They are
381	used like this:
382
383	URxvt.perl-ext-common: default,macosx-clipboard
384	URxvt.keysym.M-c: perl:macosx-clipboard:copy
385	URxvt.keysym.M-v: perl:macosx-clipboard:paste
386
387	The difference between them is that the native variant requires a
388	perl from apple's devkit or so, and C<macosx-clipboard> requires the
389	C<Mac::Pasteboard> module, works with other perls, has fewer bugs, is
390	simpler etc. etc.
391
392	=item example-refresh-hooks
393
394	Displays a very simple digital clock in the upper right corner of the
395	window. Illustrates overwriting the refresh callbacks to create your own
396	overlays or changes.
397
398	=item confirm-paste
399
400	Displays a confirmation dialog when a paste containing at least a full
401	line is detected.
402
403	=back
404		56
405	=head1 API DOCUMENTATION	57	=head1 API DOCUMENTATION
406		58
407	=head2 General API Considerations	59	=head2 General API Considerations
408		60
…		…
418	terminal is destroyed.	70	terminal is destroyed.
419		71
420	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
421	hints on what they mean:	73	hints on what they mean:
422		74
423	=over 4	75	=over
424		76
425	=item $text	77	=item $text
426		78
427	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
428	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.
…		…
435		87
436	=item $octets	88	=item $octets
437		89
438	Either binary data or - more common - a text string encoded in a	90	Either binary data or - more common - a text string encoded in a
439	locale-specific way.	91	locale-specific way.
		92
		93	=item $keysym
		94
		95	an integer that is a valid X11 keysym code. You can convert a string
		96	into a keysym and viceversa by using C<XStringToKeysym> and
		97	C<XKeysymToString>.
440		98
441	=back	99	=back
442		100
443	=head2 Extension Objects	101	=head2 Extension Objects
444		102
…		…
451	internal use.	109	internal use.
452		110
453	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
454	C<urxvt::term> class on this object.	112	C<urxvt::term> class on this object.
455		113
456	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.
457		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
458	=over 4	128	=over
459		129
460	=item $urxvt_term = $self->{term}	130	=item #:META:RESOURCE:name:type:desc
461		131
462	Returns the C<urxvt::term> object associated with this instance of the	132	The RESOURCE comment defines a resource used by the extension, where
463	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.
464		135
465	=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.
466		138
467	Dynamically enable the given hooks (named without the C<on_> prefix) for	139	Example: matcher provides the C<matcher.launcher> resource by having this
468	this extension, replacing any previous hook. This is useful when you want	140	comment:
469	to overwrite time-critical hooks only temporarily.
470		141
471	=item $self->disable ($hook_name[, $hook_name..])	142	#:META:RESOURCE:%.launcher:string:default launcher command
472		143
473	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
474		183
475	=back	184	=back
476		185
477	=head2 Hooks	186	=head2 Hooks
478		187
…		…
486	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
487	relevant action might not be carried out by the C++ code.	196	relevant action might not be carried out by the C++ code.
488		197
489	I<< When in doubt, return a false value (preferably C<()>). >>	198	I<< When in doubt, return a false value (preferably C<()>). >>
490		199
491	=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.
492		213
493	=item on_init $term	214	=item on_init $term
494		215
495	Called after a new terminal object has been initialized, but before	216	Called after a new terminal object has been initialized, but before
496	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
…		…
578		299
579	C<on_osc_seq_perl> should be used for new behaviour.	300	C<on_osc_seq_perl> should be used for new behaviour.
580		301
581	=item on_osc_seq_perl $term, $args, $resp	302	=item on_osc_seq_perl $term, $args, $resp
582		303
583	Called whenever the B<ESC ] 777 ; string ST> command sequence (OSC =	304	Called whenever the B<ESC ] 777 ; prefix ; string ST> command sequence
584	operating system command) is processed. Cursor position and other state	305	(OSC = operating system command) is processed. Cursor position and other
585	information is up-to-date when this happens. For interoperability, the	306	state information is up-to-date when this happens. For interoperability,
586	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
587	to distinguish it from commands for other extensions, and this might be	308	other suitable prefix, and a semicolon, to distinguish it from commands
588	enforced in the future.	309	for other extensions.
589		310
590	For example, C<overlay-osc> uses this:	311	For example, C<overlay-osc> uses this:
591		312
592	sub on_osc_seq_perl {	313	sub on_osc_seq_perl {
593	my ($self, $osc, $resp) = @_;	314	my ($self, $osc, $resp) = @_;
…		…
647		368
648	=item on_refresh_end $term	369	=item on_refresh_end $term
649		370
650	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>.
651		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
652	=item on_user_command $term, $string	381	=item on_user_command $term, $string *DEPRECATED*
653		382
654	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
655	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>
656	resource in the @@RXVT_NAME@@(1) manpage).	385	resource in the urxvt(1) manpage).
657		386
658	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
659	slightly in the future.	388	preference to the C<on_action> hook.
660		389
661	=item on_resize_all_windows $term, $new_width, $new_height	390	=item on_resize_all_windows $term, $new_width, $new_height
662		391
663	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
664	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
665	returns TRUE, setting of the window hints is being skipped.	394	returns a true value, setting of the window hints is being skipped.
666		395
667	=item on_x_event $term, $event	396	=item on_x_event $term, $event
668		397
669	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
670	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
…		…
710	(real, not screen-based) row and column under the mouse cursor.	439	(real, not screen-based) row and column under the mouse cursor.
711		440
712	C<on_key_press> additionally receives the string rxvt-unicode would	441	C<on_key_press> additionally receives the string rxvt-unicode would
713	output, if any, in locale-specific encoding.	442	output, if any, in locale-specific encoding.
714		443
715	subwindow.
716
717	=item on_client_message $term, $event	444	=item on_client_message $term, $event
718		445
719	=item on_wm_protocols $term, $event	446	=item on_wm_protocols $term, $event
720		447
721	=item on_wm_delete_window $term, $event	448	=item on_wm_delete_window $term, $event
…		…
732	=cut	459	=cut
733		460
734	package urxvt;	461	package urxvt;
735		462
736	use utf8;	463	use utf8;
737	use strict;	464	use strict qw(vars subs);
738	use Carp ();	465	use Carp ();
739	use Scalar::Util ();	466	use Scalar::Util ();
740	use List::Util ();	467	use List::Util ();
741		468
742	our $VERSION = 1;	469	our $VERSION = 1;
743	our $TERM;	470	our $TERM;
744	our @TERM_INIT;	471	our @TERM_INIT; # should go, prevents async I/O etc.
745	our @TERM_EXT;	472	our @TERM_EXT; # should go, prevents async I/O etc.
746	our @HOOKNAME;	473	our @HOOKNAME;
747	our %HOOKTYPE = map +($HOOKNAME[$_] => $_), 0..$#HOOKNAME;	474	our %HOOKTYPE = map +($HOOKNAME[$_] => $_), 0..$#HOOKNAME;
748	our %OPTION;	475	our %OPTION;
749		476
750	our $LIBDIR;	477	our $LIBDIR;
…		…
754		481
755	our $NOCHAR = chr 0xffff;	482	our $NOCHAR = chr 0xffff;
756		483
757	=head2 Variables in the C<urxvt> Package	484	=head2 Variables in the C<urxvt> Package
758		485
759	=over 4	486	=over
760		487
761	=item $urxvt::LIBDIR	488	=item $urxvt::LIBDIR
762		489
763	The rxvt-unicode library directory, where, among other things, the perl	490	The rxvt-unicode library directory, where, among other things, the perl
764	modules and scripts are stored.	491	modules and scripts are stored.
…		…
794		521
795	=back	522	=back
796		523
797	=head2 Functions in the C<urxvt> Package	524	=head2 Functions in the C<urxvt> Package
798		525
799	=over 4	526	=over
800		527
801	=item urxvt::fatal $errormessage	528	=item urxvt::fatal $errormessage
802		529
803	Fatally aborts execution with the given error message (which should	530	Fatally aborts execution with the given error message (which should
804	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
…		…
849	CirculateRequest, PropertyNotify, SelectionClear, SelectionRequest,	576	CirculateRequest, PropertyNotify, SelectionClear, SelectionRequest,
850	SelectionNotify, ColormapNotify, ClientMessage, MappingNotify	577	SelectionNotify, ColormapNotify, ClientMessage, MappingNotify
851		578
852	Various constants for use in X calls and event processing.	579	Various constants for use in X calls and event processing.
853		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
854	=back	593	=back
855		594
856	=head2 RENDITION	595	=head2 RENDITION
857		596
858	Rendition bitsets contain information about colour, font, font styles and	597	Rendition bitsets contain information about colour, font, font styles and
…		…
861	The following "macros" deal with changes in rendition sets. You should	600	The following "macros" deal with changes in rendition sets. You should
862	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,
863	as they contain important information required for correct operation of	602	as they contain important information required for correct operation of
864	rxvt-unicode.	603	rxvt-unicode.
865		604
866	=over 4	605	=over
867		606
868	=item $rend = urxvt::DEFAULT_RSTYLE	607	=item $rend = urxvt::DEFAULT_RSTYLE
869		608
870	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
871	being reset. Useful as a base to start when creating renditions.	610	being reset. Useful as a base to start when creating renditions.
…		…
920	};	659	};
921	}	660	}
922		661
923	no warnings 'utf8';	662	no warnings 'utf8';
924		663
		664	sub parse_resource {
		665	my ($term, $name, $isarg, $longopt, $flag, $value) = @_;
		666
		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	}
		697	}
		698
		699	0
		700	}
		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
925	my $verbosity = $ENV{URXVT_PERL_VERBOSITY};	730	my $verbosity = $ENV{URXVT_PERL_VERBOSITY} // 2;
926		731
927	sub verbose {	732	sub verbose {
928	my ($level, $msg) = @_;	733	my ($level, $msg) = @_;
929	warn "$msg\n" if $level <= $verbosity;	734	warn "$msg\n" if $level <= $verbosity;
930	}	735	}
…		…
941	$pkg =~ s/[^[:word:]]/_/g;	746	$pkg =~ s/[^[:word:]]/_/g;
942	$pkg = "urxvt::ext::$pkg";	747	$pkg = "urxvt::ext::$pkg";
943		748
944	verbose 3, "loading extension '$path' into package '$pkg'";	749	verbose 3, "loading extension '$path' into package '$pkg'";
945		750
		751	(${"$pkg\::_NAME"} = $path) =~ s/^.*[\\\/]//; # hackish
		752
946	open my $fh, "<:raw", $path	753	open my $fh, "<:raw", $path
947	or die "$path: $!";	754	or die "$path: $!";
948		755
949	my $source =	756	my $source =
950	"package $pkg; use strict; use utf8; no warnings 'utf8';\n"	757	"package $pkg; use strict qw(vars subs); use utf8; no warnings 'utf8';\n"
951	. "#line 1 \"$path\"\n{\n"	758	. "#line 1 \"$path\"\n{\n"
952	. (do { local $/; <$fh> })	759	. (do { local $/; <$fh> })
953	. "\n};\n1";	760	. "\n};\n1";
954		761
955	eval $source	762	eval $source
…		…
964	# called by the rxvt core	771	# called by the rxvt core
965	sub invoke {	772	sub invoke {
966	local $TERM = shift;	773	local $TERM = shift;
967	my $htype = shift;	774	my $htype = shift;
968		775
969	if ($htype == 0) { # INIT	776	if ($htype == HOOK_INIT) {
970	my @dirs = ((split /:/, $TERM->resource ("perl_lib")), "$LIBDIR/perl");	777	$TERM->scan_extensions;
971		778
972	my %ext_arg;	779	my %ext_arg;
973		780
974	{	781	{
975	my @init = @TERM_INIT;	782	my @init = @TERM_INIT;
…		…
978	my @pkg = @TERM_EXT;	785	my @pkg = @TERM_EXT;
979	@TERM_EXT = ();	786	@TERM_EXT = ();
980	$TERM->register_package ($_) for @pkg;	787	$TERM->register_package ($_) for @pkg;
981	}	788	}
982		789
		790	for (
		791	@{ delete $TERM->{perl_ext_3} },
983	for (grep $_, map { split /,/, $TERM->resource ("perl_ext_$_") } 1, 2) {	792	(grep $_, map { split /,/, $TERM->resource ("perl_ext_$_") } 1, 2),
		793	) {
984	if ($_ eq "default") {	794	if ($_ eq "default") {
		795
		796	$ext_arg{$_} = []
985	$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
986	} elsif (/^-(.*)$/) {	808	} elsif (/^-(.*)$/) { # remove from set
987	delete $ext_arg{$1};	809	delete $ext_arg{$1};
988	} 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};
989	push @{ $ext_arg{$1} }, $2;	816	push @{ $ext_arg{$1} }, defined $2 ? $2 : ();
		817
990	} else {	818	} else {
991	$ext_arg{$_} ||= [];	819	verbose 2, "cannot parse extension specification '$_', ignoring.";
992	}	820	}
993	}	821	}
994		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
995	for my $ext (sort keys %ext_arg) {	826	for my $ext (sort keys %ext_arg) {
996	my @files = grep -f $_, map "$_/$ext", @dirs;	827	my $path = $TERM->extension_path ($ext);
997		828
998	if (@files) {	829	if (defined $path) {
999	$TERM->register_package (extension_package $files[0], $ext_arg{$ext});	830	$TERM->autoload_extension ($ext, $ext_arg{$ext});
1000	} else {	831	} else {
1001	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";
1002	}	833	}
1003	}	834	}
1004		835
1005	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");
1006	warn $@ if $@;	837	warn $@ if $@;
1007	}	838	}
1008		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
1009	$retval = undef;	850	$retval = undef;
1010		851
1011	if (my $cb = $TERM->{_hook}[$htype]) {	852	if (my $cb = $TERM->{_hook}[$htype]) {
1012	verbose 10, "$HOOKNAME[$htype] (" . (join ", ", $TERM, @_) . ")"	853	verbose 10, "$HOOKNAME[$htype] (" . (join ", ", $TERM, @_) . ")"
1013	if $verbosity >= 10;	854	if $verbosity >= 10;
1014		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
1015	for my $pkg (keys %$cb) {	869	for my $pkg (keys %$cb) {
1016	my $retval_ = eval { $cb->{$pkg}->($TERM->{_pkg}{$pkg}, @_) };	870	my $retval_ = eval { $cb->{$pkg}->($TERM->{_pkg}{$pkg} || $TERM, @_) };
1017	$retval ||= $retval_;	871	$retval ||= $retval_;
1018		872
1019	if ($@) {	873	if ($@) {
1020	$TERM->ungrab; # better to lose the grab than the session	874	$TERM->ungrab; # better to lose the grab than the session
1021	warn $@;	875	warn $@;
…		…
1024		878
1025	verbose 11, "$HOOKNAME[$htype] returning <$retval>"	879	verbose 11, "$HOOKNAME[$htype] returning <$retval>"
1026	if $verbosity >= 11;	880	if $verbosity >= 11;
1027	}	881	}
1028		882
1029	if ($htype == 1) { # DESTROY	883	if ($htype == HOOK_DESTROY) {
1030	# clear package objects	884	# clear package objects
1031	%$_ = () for values %{ $TERM->{_pkg} };	885	%$_ = () for values %{ $TERM->{_pkg} };
1032		886
1033	# clear package	887	# clear package
1034	%$TERM = ();	888	%$TERM = ();
…		…
1064	}	918	}
1065	}	919	}
1066	($mask, @color{qw(fg bg)}, \@failed)	920	($mask, @color{qw(fg bg)}, \@failed)
1067	}	921	}
1068		922
1069	# urxvt::term::extension
1070
1071	package urxvt::term::extension;	923	package urxvt::term::extension;
1072		924
1073	sub enable {	925	=head2 The C<urxvt::term::extension> class
1074	my ($self, %hook) = @_;
1075	my $pkg = $self->{_pkg};
1076		926
1077	while (my ($name, $cb) = each %hook) {	927	Each extension attached to a terminal object is represented by
1078	my $htype = $HOOKTYPE{uc $name};	928	a C<urxvt::term::extension> object.
1079	defined $htype
1080	or Carp::croak "unsupported hook type '$name'";
1081		929
1082	$self->set_should_invoke ($htype, +1)	930	You can use these objects, which are passed to all callbacks to store any
1083	unless exists $self->{term}{_hook}[$htype]{$pkg};	931	state related to the terminal and extension instance.
1084		932
1085	$self->{term}{_hook}[$htype]{$pkg} = $cb;	933	The methods (And data members) documented below can be called on extension
1086	}	934	objects, in addition to call methods documented for the <urxvt::term>
1087	}	935	class.
1088		936
1089	sub disable {	937	=over
1090	my ($self, @hook) = @_;
1091	my $pkg = $self->{_pkg};
1092		938
1093	for my $name (@hook) {	939	=item $urxvt_term = $self->{term}
1094	my $htype = $HOOKTYPE{uc $name};
1095	defined $htype
1096	or Carp::croak "unsupported hook type '$name'";
1097		940
1098	$self->set_should_invoke ($htype, -1)	941	Returns the C<urxvt::term> object associated with this instance of the
1099	if delete $self->{term}{_hook}[$htype]{$pkg};	942	extension. This member I<must not> be changed in any way.
1100	}	943
1101	}	944	=cut
1102		945
1103	our $AUTOLOAD;	946	our $AUTOLOAD;
1104		947
1105	sub AUTOLOAD {	948	sub AUTOLOAD {
1106	$AUTOLOAD =~ /:([^:]+)$/	949	$AUTOLOAD =~ /:([^:]+)$/
…		…
1119		962
1120	sub DESTROY {	963	sub DESTROY {
1121	# nop	964	# nop
1122	}	965	}
1123		966
1124	# urxvt::destroy_hook	967	# urxvt::destroy_hook (basically a cheap Guard:: implementation)
1125		968
1126	sub urxvt::destroy_hook::DESTROY {	969	sub urxvt::destroy_hook::DESTROY {
1127	${$_[0]}->();	970	${$_[0]}->();
1128	}	971	}
1129		972
1130	sub urxvt::destroy_hook(&) {	973	sub urxvt::destroy_hook(&) {
1131	bless \shift, urxvt::destroy_hook::	974	bless \shift, urxvt::destroy_hook::
1132	}	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
1133		1099
1134	package urxvt::anyevent;	1100	package urxvt::anyevent;
1135		1101
1136	=head2 The C<urxvt::anyevent> Class	1102	=head2 The C<urxvt::anyevent> Class
1137		1103
1138	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
1139	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
1140	further programming. The only exception is that you cannot wait on	1106	further programming. The only exception is that you cannot wait on
1141	condition variables, but non-blocking condvar use is ok. What this means	1107	condition variables, but non-blocking condvar use is ok.
1142	is that you cannot use blocking APIs, but the non-blocking variant should	1108
1143	work.	1109	In practical terms this means is that you cannot use blocking APIs, but
		1110	the non-blocking variant should work.
1144		1111
1145	=cut	1112	=cut
1146		1113
1147	our $VERSION = '5.23';	1114	our $VERSION = '5.23';
1148		1115
…		…
1207		1174
1208	sub DESTROY {	1175	sub DESTROY {
1209	$_[0][1]->stop;	1176	$_[0][1]->stop;
1210	}	1177	}
1211		1178
		1179	# only needed for AnyEvent < 6 compatibility
1212	sub one_event {	1180	sub one_event {
1213	Carp::croak "AnyEvent->one_event blocking wait unsupported in urxvt, use a non-blocking API";	1181	Carp::croak "AnyEvent->one_event blocking wait unsupported in urxvt, use a non-blocking API";
1214	}	1182	}
1215		1183
1216	package urxvt::term;	1184	package urxvt::term;
1217		1185
1218	=head2 The C<urxvt::term> Class	1186	=head2 The C<urxvt::term> Class
1219		1187
1220	=over 4	1188	=over
1221		1189
1222	=cut	1190	=cut
1223		1191
1224	# find on_xxx subs in the package and register them	1192	# find on_xxx subs in the package and register them
1225	# as hooks	1193	# as hooks
1226	sub register_package {	1194	sub register_package {
1227	my ($self, $pkg, $argv) = @_;	1195	my ($self, $pkg, $argv) = @_;
1228		1196
		1197	return if $self->{_pkg}{$pkg};
		1198
1229	no strict 'refs';	1199	no strict 'refs';
1230		1200
1231	urxvt::verbose 6, "register package $pkg to $self";	1201	urxvt::verbose 6, "register package $pkg to $self";
1232		1202
1233	@{"$pkg\::ISA"} = urxvt::term::extension::;	1203	@{"$pkg\::ISA"} = urxvt::term::extension::;
1234		1204
1235	my $proxy = bless {	1205	my $proxy = bless {
1236	_pkg => $pkg,	1206	_pkg => $pkg,
		1207	_name => ${"$pkg\::_NAME"}, # hackish
1237	argv => $argv,	1208	argv => $argv,
1238	}, $pkg;	1209	}, $pkg;
1239	Scalar::Util::weaken ($proxy->{term} = $self);	1210	Scalar::Util::weaken ($proxy->{term} = $self);
1240		1211
1241	$self->{_pkg}{$pkg} = $proxy;	1212	$self->{_pkg}{$pkg} = $proxy;
1242		1213
1243	for my $name (@HOOKNAME) {	1214	for my $name (@HOOKNAME) {
1244	if (my $ref = $pkg->can ("on_" . lc $name)) {	1215	if (my $ref = $pkg->can ("on_" . lc $name)) {
1245	$proxy->enable ($name => $ref);	1216	$proxy->enable ($name => $ref);
1246	}	1217	}
1247	}	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	}
1248	}	1331	}
1249		1332
1250	=item $term = new urxvt::term $envhashref, $rxvtname, [arg...]	1333	=item $term = new urxvt::term $envhashref, $rxvtname, [arg...]
1251		1334
1252	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
…		…
1271	}	1354	}
1272		1355
1273	=item $term->destroy	1356	=item $term->destroy
1274		1357
1275	Destroy the terminal object (close the window, free resources	1358	Destroy the terminal object (close the window, free resources
1276	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
1277	watchers (timers, io watchers) are still active.	1360	watchers (timers, io watchers) are still active.
1278		1361
1279	=item $term->exec_async ($cmd[, @args])	1362	=item $term->exec_async ($cmd[, @args])
1280		1363
1281	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
…		…
1314	insecure intensityStyles iso14755 iso14755_52 jumpScroll loginShell	1397	insecure intensityStyles iso14755 iso14755_52 jumpScroll loginShell
1315	mapAlert meta8 mouseWheelScrollPage override_redirect pastableTabs	1398	mapAlert meta8 mouseWheelScrollPage override_redirect pastableTabs
1316	pointerBlank reverseVideo scrollBar scrollBar_floating scrollBar_right	1399	pointerBlank reverseVideo scrollBar scrollBar_floating scrollBar_right
1317	scrollTtyKeypress scrollTtyOutput scrollWithBuffer secondaryScreen	1400	scrollTtyKeypress scrollTtyOutput scrollWithBuffer secondaryScreen
1318	secondaryScroll skipBuiltinGlyphs skipScroll transparent tripleclickwords	1401	secondaryScroll skipBuiltinGlyphs skipScroll transparent tripleclickwords
1319	urgentOnBell utmpInhibit visualBell	1402	urgentOnBell utmpInhibit visualBell disablePasteBrackets
1320		1403
1321	=item $value = $term->resource ($name[, $newval])	1404	=item $value = $term->resource ($name[, $newval])
1322		1405
1323	Returns the current resource value associated with a given name and	1406	Returns the current resource value associated with a given name and
1324	optionally sets a new value. Setting values is most useful in the C<init>	1407	optionally sets a new value. Setting values is most useful in the C<init>
…		…
1337		1420
1338	Here is a likely non-exhaustive list of resource names, not all of which	1421	Here is a likely non-exhaustive list of resource names, not all of which
1339	are supported in every build, please see the source file F</src/rsinc.h>	1422	are supported in every build, please see the source file F</src/rsinc.h>
1340	to see the actual list:	1423	to see the actual list:
1341		1424
1342	answerbackstring backgroundPixmap backspace_key blendtype blurradius	1425	answerbackstring backgroundPixmap backspace_key blurradius
1343	boldFont boldItalicFont borderLess buffered chdir color cursorBlink	1426	boldFont boldItalicFont borderLess buffered chdir color cursorBlink
1344	cursorUnderline cutchars delete_key depth display_name embed ext_bwidth	1427	cursorUnderline cutchars delete_key depth display_name embed ext_bwidth
1345	fade font geometry hold iconName iconfile imFont imLocale inputMethod	1428	fade font geometry hold iconName iconfile imFont imLocale inputMethod
1346	insecure int_bwidth intensityStyles iso14755 iso14755_52 italicFont	1429	insecure int_bwidth intensityStyles iso14755 iso14755_52 italicFont
1347	jumpScroll letterSpace lineSpace loginShell mapAlert meta8 modifier	1430	jumpScroll letterSpace lineSpace loginShell mapAlert meta8 modifier
…		…
1350	preeditType print_pipe pty_fd reverseVideo saveLines scrollBar	1433	preeditType print_pipe pty_fd reverseVideo saveLines scrollBar
1351	scrollBar_align scrollBar_floating scrollBar_right scrollBar_thickness	1434	scrollBar_align scrollBar_floating scrollBar_right scrollBar_thickness
1352	scrollTtyKeypress scrollTtyOutput scrollWithBuffer scrollstyle	1435	scrollTtyKeypress scrollTtyOutput scrollWithBuffer scrollstyle
1353	secondaryScreen secondaryScroll shade skipBuiltinGlyphs skipScroll	1436	secondaryScreen secondaryScroll shade skipBuiltinGlyphs skipScroll
1354	term_name title transient_for transparent tripleclickwords urgentOnBell	1437	term_name title transient_for transparent tripleclickwords urgentOnBell
1355	utmpInhibit visualBell	1438	utmpInhibit visualBell rewrapMode disablePasteBrackets
1356		1439
1357	=cut	1440	=cut
1358		1441
1359	sub resource($$;$) {	1442	sub resource($$;$) {
1360	my ($self, $name) = (shift, shift);	1443	my ($self, $name) = (shift, shift);
…		…
1367	Returns the X-Resource for the given pattern, excluding the program or	1450	Returns the X-Resource for the given pattern, excluding the program or
1368	class name, i.e. C<< $term->x_resource ("boldFont") >> should return the	1451	class name, i.e. C<< $term->x_resource ("boldFont") >> should return the
1369	same value as used by this instance of rxvt-unicode. Returns C<undef> if no	1452	same value as used by this instance of rxvt-unicode. Returns C<undef> if no
1370	resource with that pattern exists.	1453	resource with that pattern exists.
1371		1454
		1455	Extensions that define extra resources also need to call this method
		1456	to access their values.
		1457
		1458	If the method is called on an extension object (basically, from an
		1459	extension), then the special prefix C<%.> will be replaced by the name of
		1460	the extension and a dot, and the lone string C<%> will be replaced by the
		1461	extension name itself. This makes it possible to code extensions so you
		1462	can rename them and get a new set of resources without having to change
		1463	the actual code.
		1464
1372	This method should only be called during the C<on_start> hook, as there is	1465	This method should only be called during the C<on_start> hook, as there is
1373	only one resource database per display, and later invocations might return	1466	only one resource database per display, and later invocations might return
1374	the wrong resources.	1467	the wrong resources.
1375		1468
1376	=item $success = $term->parse_keysym ($keysym_spec, $command_string)	1469	=item $value = $term->x_resource_boolean ($pattern)
1377		1470
		1471	Like C<x_resource>, above, but interprets the string value as a boolean
		1472	and returns C<1> for true values, C<0> for false values and C<undef> if
		1473	the resource or option isn't specified.
		1474
		1475	You should always use this method to parse boolean resources.
		1476
		1477	=cut
		1478
		1479	sub x_resource_boolean {
		1480	my $res = &x_resource;
		1481
		1482	$res =~ /^\s*(?:true|yes|on|1)\s*$/i ? 1 : defined $res && 0
		1483	}
		1484
		1485	=item $action = $term->lookup_keysym ($keysym, $state)
		1486
		1487	Returns the action bound to key combination C<($keysym, $state)>,
		1488	if a binding for it exists, and C<undef> otherwise.
		1489
		1490	=item $success = $term->bind_action ($key, $action)
		1491
1378	Adds a keymap translation exactly as specified via a resource. See the	1492	Adds a key binding exactly as specified via a C<keysym> resource. See the
1379	C<keysym> resource in the @@RXVT_NAME@@(1) manpage.	1493	C<keysym> resource in the urxvt(1) manpage.
		1494
		1495	To add default bindings for actions, an extension should call C<<
		1496	->bind_action >> in its C<init> hook for every such binding. Doing it
		1497	in the C<init> hook allows users to override or remove the binding
		1498	again.
		1499
		1500	Example: the C<searchable-scrollback> by default binds itself
		1501	on C<Meta-s>, using C<< $self->bind_action >>, which calls C<<
		1502	$term->bind_action >>.
		1503
		1504	sub init {
		1505	my ($self) = @_;
		1506
		1507	$self->bind_action ("M-s" => "%:start");
		1508	}
1380		1509
1381	=item $rend = $term->rstyle ([$new_rstyle])	1510	=item $rend = $term->rstyle ([$new_rstyle])
1382		1511
1383	Return and optionally change the current rendition. Text that is output by	1512	Return and optionally change the current rendition. Text that is output by
1384	the terminal application will use this style.	1513	the terminal application will use this style.
…		…
1461	This method returns an urxvt::overlay object. The overlay will be visible	1590	This method returns an urxvt::overlay object. The overlay will be visible
1462	as long as the perl object is referenced.	1591	as long as the perl object is referenced.
1463		1592
1464	The methods currently supported on C<urxvt::overlay> objects are:	1593	The methods currently supported on C<urxvt::overlay> objects are:
1465		1594
1466	=over 4	1595	=over
1467		1596
1468	=item $overlay->set ($x, $y, $text[, $rend])	1597	=item $overlay->set ($x, $y, $text[, $rend])
1469		1598
1470	Similar to C<< $term->ROW_t >> and C<< $term->ROW_r >> in that it puts	1599	Similar to C<< $term->ROW_t >> and C<< $term->ROW_r >> in that it puts
1471	text in rxvt-unicode's special encoding and an array of rendition values	1600	text in rxvt-unicode's special encoding and an array of rendition values
…		…
1515	Returns the number of screen-cells this string would need. Correctly	1644	Returns the number of screen-cells this string would need. Correctly
1516	accounts for wide and combining characters.	1645	accounts for wide and combining characters.
1517		1646
1518	=item $octets = $term->locale_encode ($string)	1647	=item $octets = $term->locale_encode ($string)
1519		1648
1520	Convert the given text string into the corresponding locale encoding.	1649	Convert the given text string into the corresponding locale
		1650	encoding. Returns C<undef> if C<$string> is C<undef>.
1521		1651
1522	=item $string = $term->locale_decode ($octets)	1652	=item $string = $term->locale_decode ($octets)
1523		1653
1524	Convert the given locale-encoded octets into a perl string.	1654	Convert the given locale-encoded octets into a perl string. Returns
		1655	C<undef> if C<$octets> is C<undef>.
1525		1656
1526	=item $term->scr_xor_span ($beg_row, $beg_col, $end_row, $end_col[, $rstyle])	1657	=item $term->scr_xor_span ($beg_row, $beg_col, $end_row, $end_col[, $rstyle])
1527		1658
1528	XORs the rendition values in the given span with the provided value	1659	XORs the rendition values in the given span with the provided value
1529	(default: C<RS_RVid>), which I<MUST NOT> contain font styles. Useful in	1660	(default: C<RS_RVid>), which I<MUST NOT> contain font styles. Useful in
…		…
1542		1673
1543	=item $term->scr_add_lines ($string)	1674	=item $term->scr_add_lines ($string)
1544		1675
1545	Write the given text string to the screen, as if output by the application	1676	Write the given text string to the screen, as if output by the application
1546	running inside the terminal. It may not contain command sequences (escape	1677	running inside the terminal. It may not contain command sequences (escape
1547	codes), but is free to use line feeds, carriage returns and tabs. The	1678	codes - see C<cmd_parse> for that), but is free to use line feeds,
1548	string is a normal text string, not in locale-dependent encoding.	1679	carriage returns and tabs. The string is a normal text string, not in
		1680	locale-dependent encoding.
1549		1681
1550	Normally its not a good idea to use this function, as programs might be	1682	Normally its not a good idea to use this function, as programs might be
1551	confused by changes in cursor position or scrolling. Its useful inside a	1683	confused by changes in cursor position or scrolling. Its useful inside a
1552	C<on_add_lines> hook, though.	1684	C<on_add_lines> hook, though.
1553		1685
…		…
1561	locale-specific encoding of the terminal and can contain command sequences	1693	locale-specific encoding of the terminal and can contain command sequences
1562	(escape codes) that will be interpreted.	1694	(escape codes) that will be interpreted.
1563		1695
1564	=item $term->tt_write ($octets)	1696	=item $term->tt_write ($octets)
1565		1697
1566	Write the octets given in C<$octets> to the tty (i.e. as program input). To	1698	Write the octets given in C<$octets> to the tty (i.e. as user input
		1699	to the program, see C<cmd_parse> for the opposite direction). To pass
1567	pass characters instead of octets, you should convert your strings first	1700	characters instead of octets, you should convert your strings first to the
1568	to the locale-specific encoding using C<< $term->locale_encode >>.	1701	locale-specific encoding using C<< $term->locale_encode >>.
		1702
		1703	=item $term->tt_write_user_input ($octets)
		1704
		1705	Like C<tt_write>, but should be used when writing strings in response to
		1706	the user pressing a key, to invoke the additional actions requested by
		1707	the user for that case (C<tt_write> doesn't do that).
		1708
		1709	The typical use case would be inside C<on_action> hooks.
1569		1710
1570	=item $term->tt_paste ($octets)	1711	=item $term->tt_paste ($octets)
1571		1712
1572	Write the octets given in C<$octets> to the tty as a paste, converting NL to	1713	Write the octets given in C<$octets> to the tty as a paste, converting NL to
1573	CR and bracketing the data with control sequences if bracketed paste mode	1714	CR and bracketing the data with control sequences if bracketed paste mode
…		…
1598	Adds the specified events to the vt event mask. Useful e.g. when you want	1739	Adds the specified events to the vt event mask. Useful e.g. when you want
1599	to receive pointer events all the times:	1740	to receive pointer events all the times:
1600		1741
1601	$term->vt_emask_add (urxvt::PointerMotionMask);	1742	$term->vt_emask_add (urxvt::PointerMotionMask);
1602		1743
		1744	=item $term->set_urgency ($set)
		1745
		1746	Enable/disable the urgency hint on the toplevel window.
		1747
1603	=item $term->focus_in	1748	=item $term->focus_in
1604		1749
1605	=item $term->focus_out	1750	=item $term->focus_out
1606		1751
1607	=item $term->key_press ($state, $keycode[, $time])	1752	=item $term->key_press ($state, $keycode[, $time])
1608		1753
1609	=item $term->key_release ($state, $keycode[, $time])	1754	=item $term->key_release ($state, $keycode[, $time])
1610		1755
1611	Deliver various fake events to to terminal.	1756	Deliver various fake events to to terminal.
1612		1757
1613	=item $window_width = $term->width	1758	=item $window_width = $term->width ([$new_value])
1614		1759
1615	=item $window_height = $term->height	1760	=item $window_height = $term->height ([$new_value])
1616		1761
1617	=item $font_width = $term->fwidth	1762	=item $font_width = $term->fwidth ([$new_value])
1618		1763
1619	=item $font_height = $term->fheight	1764	=item $font_height = $term->fheight ([$new_value])
1620		1765
1621	=item $font_ascent = $term->fbase	1766	=item $font_ascent = $term->fbase ([$new_value])
1622		1767
1623	=item $terminal_rows = $term->nrow	1768	=item $terminal_rows = $term->nrow ([$new_value])
1624		1769
1625	=item $terminal_columns = $term->ncol	1770	=item $terminal_columns = $term->ncol ([$new_value])
1626		1771
1627	=item $has_focus = $term->focus	1772	=item $has_focus = $term->focus ([$new_value])
1628		1773
1629	=item $is_mapped = $term->mapped	1774	=item $is_mapped = $term->mapped ([$new_value])
1630		1775
1631	=item $max_scrollback = $term->saveLines	1776	=item $max_scrollback = $term->saveLines ([$new_value])
1632		1777
1633	=item $nrow_plus_saveLines = $term->total_rows	1778	=item $nrow_plus_saveLines = $term->total_rows ([$new_value])
1634		1779
1635	=item $topmost_scrollback_row = $term->top_row	1780	=item $topmost_scrollback_row = $term->top_row ([$new_value])
1636		1781
1637	Return various integers describing terminal characteristics.	1782	Return various integers describing terminal characteristics. If an
		1783	argument is given, changes the value and returns the previous one.
1638		1784
1639	=item $x_display = $term->display_id	1785	=item $x_display = $term->display_id
1640		1786
1641	Return the DISPLAY used by rxvt-unicode.	1787	Return the DISPLAY used by rxvt-unicode.
1642		1788
…		…
1679		1825
1680	=item $cursor_is_hidden = $term->hidden_cursor	1826	=item $cursor_is_hidden = $term->hidden_cursor
1681		1827
1682	Returns whether the cursor is currently hidden or not.	1828	Returns whether the cursor is currently hidden or not.
1683		1829
		1830	=item $priv_modes = $term->priv_modes
		1831
		1832	Returns a bitset with the state of DEC private modes.
		1833
		1834	Example:
		1835
		1836	if ($term->priv_modes & urxvt::PrivMode_mouse_report) {
		1837	# mouse reporting is turned on
		1838	}
		1839
1684	=item $view_start = $term->view_start ([$newvalue])	1840	=item $view_start = $term->view_start ([$newvalue])
1685		1841
1686	Returns the row number of the topmost displayed line. Maximum value is	1842	Returns the row number of the topmost displayed line and changes it,
1687	C<0>, which displays the normal terminal contents. Lower values scroll	1843	if an argument is given. Values greater than or equal to C<0> display
1688	this many lines into the scrollback buffer.	1844	the terminal contents. Lower values scroll this many lines into the
		1845	scrollback buffer.
1689		1846
1690	=item $term->want_refresh	1847	=item $term->want_refresh
1691		1848
1692	Requests a screen refresh. At the next opportunity, rxvt-unicode will	1849	Requests a screen refresh. At the next opportunity, rxvt-unicode will
1693	compare the on-screen display with its stored representation. If they	1850	compare the on-screen display with its stored representation. If they
1694	differ, it redraws the differences.	1851	differ, it redraws the differences.
1695		1852
1696	Used after changing terminal contents to display them.	1853	Used after changing terminal contents to display them.
		1854
		1855	=item $term->refresh_check
		1856
		1857	Checks if a refresh has been requested and, if so, schedules one.
1697		1858
1698	=item $text = $term->ROW_t ($row_number[, $new_text[, $start_col]])	1859	=item $text = $term->ROW_t ($row_number[, $new_text[, $start_col]])
1699		1860
1700	Returns the text of the entire row with number C<$row_number>. Row C<< $term->top_row >>	1861	Returns the text of the entire row with number C<$row_number>. Row C<< $term->top_row >>
1701	is the topmost terminal line, row C<< $term->nrow-1 >> is the bottommost	1862	is the topmost terminal line, row C<< $term->nrow-1 >> is the bottommost
…		…
1747		1908
1748	Create and return a new C<urxvt::line> object that stores information	1909	Create and return a new C<urxvt::line> object that stores information
1749	about the logical line that row C<$row_number> is part of. It supports the	1910	about the logical line that row C<$row_number> is part of. It supports the
1750	following methods:	1911	following methods:
1751		1912
1752	=over 4	1913	=over
1753		1914
1754	=item $text = $line->t ([$new_text])	1915	=item $text = $line->t ([$new_text])
1755		1916
1756	Returns or replaces the full text of the line, similar to C<ROW_t>	1917	Returns or replaces the full text of the line, similar to C<ROW_t>
1757		1918
…		…
1803	}	1964	}
1804		1965
1805	sub urxvt::line::t {	1966	sub urxvt::line::t {
1806	my ($self) = @_;	1967	my ($self) = @_;
1807		1968
1808	if (@_ > 1)	1969	if (@_ > 1) {
1809	{
1810	$self->{term}->ROW_t ($_, $_[1], 0, ($_ - $self->{beg}) * $self->{ncol}, $self->{ncol})	1970	$self->{term}->ROW_t ($_, $_[1], 0, ($_ - $self->{beg}) * $self->{ncol}, $self->{ncol})
1811	for $self->{beg} .. $self->{end};	1971	for $self->{beg} .. $self->{end};
1812	}	1972	}
1813		1973
1814	defined wantarray &&	1974	defined wantarray &&
1815	substr +(join "", map $self->{term}->ROW_t ($_), $self->{beg} .. $self->{end}),	1975	substr +(join "", map $self->{term}->ROW_t ($_), $self->{beg} .. $self->{end}),
1816	0, $self->{len}	1976	0, $self->{len}
1817	}	1977	}
1818		1978
1819	sub urxvt::line::r {	1979	sub urxvt::line::r {
1820	my ($self) = @_;	1980	my ($self) = @_;
1821		1981
1822	if (@_ > 1)	1982	if (@_ > 1) {
1823	{
1824	$self->{term}->ROW_r ($_, $_[1], 0, ($_ - $self->{beg}) * $self->{ncol}, $self->{ncol})	1983	$self->{term}->ROW_r ($_, $_[1], 0, ($_ - $self->{beg}) * $self->{ncol}, $self->{ncol})
1825	for $self->{beg} .. $self->{end};	1984	for $self->{beg} .. $self->{end};
1826	}	1985	}
1827		1986
1828	if (defined wantarray) {	1987	if (defined wantarray) {
1829	my $rend = [	1988	my $rend = [
1830	map @{ $self->{term}->ROW_r ($_) }, $self->{beg} .. $self->{end}	1989	map @{ $self->{term}->ROW_r ($_) }, $self->{beg} .. $self->{end}
1831	];	1990	];
…		…
1863	where one character corresponds to one screen cell. See	2022	where one character corresponds to one screen cell. See
1864	C<< $term->ROW_t >> for details.	2023	C<< $term->ROW_t >> for details.
1865		2024
1866	=item $string = $term->special_decode $text	2025	=item $string = $term->special_decode $text
1867		2026
1868	Converts rxvt-unicodes text representation into a perl string. See	2027	Converts rxvt-unicode's text representation into a perl string. See
1869	C<< $term->ROW_t >> for details.	2028	C<< $term->ROW_t >> for details.
1870		2029
1871	=item $success = $term->grab_button ($button, $modifiermask[, $window = $term->vt])	2030	=item $success = $term->grab_button ($button, $modifiermask[, $window = $term->vt])
1872		2031
1873	=item $term->ungrab_button ($button, $modifiermask[, $window = $term->vt])	2032	=item $term->ungrab_button ($button, $modifiermask[, $window = $term->vt])
…		…
1923		2082
1924	=item ($x, $y, $child_window) = $term->XTranslateCoordinates ($src, $dst, $x, $y)	2083	=item ($x, $y, $child_window) = $term->XTranslateCoordinates ($src, $dst, $x, $y)
1925		2084
1926	=item $term->XChangeInput ($window, $add_events[, $del_events])	2085	=item $term->XChangeInput ($window, $add_events[, $del_events])
1927		2086
		2087	=item $keysym = $term->XStringToKeysym ($string)
		2088
		2089	=item $string = $term->XKeysymToString ($keysym)
		2090
1928	Various X or X-related functions. The C<$term> object only serves as	2091	Various X or X-related functions. The C<$term> object only serves as
1929	the source of the display, otherwise those functions map more-or-less	2092	the source of the display, otherwise those functions map more-or-less
1930	directly onto the X functions of the same name.	2093	directly onto the X functions of the same name.
1931		2094
1932	=back	2095	=back
…		…
1935		2098
1936	package urxvt::popup;	2099	package urxvt::popup;
1937		2100
1938	=head2 The C<urxvt::popup> Class	2101	=head2 The C<urxvt::popup> Class
1939		2102
1940	=over 4	2103	=over
1941		2104
1942	=cut	2105	=cut
1943		2106
1944	sub add_item {	2107	sub add_item {
1945	my ($self, $item) = @_;	2108	my ($self, $item) = @_;
…		…
2081	->cb (sub {	2244	->cb (sub {
2082	$term->{overlay}->set (0, 0,	2245	$term->{overlay}->set (0, 0,
2083	sprintf "%2d:%02d:%02d", (localtime urxvt::NOW)[2,1,0]);	2246	sprintf "%2d:%02d:%02d", (localtime urxvt::NOW)[2,1,0]);
2084	});	2247	});
2085		2248
2086	=over 4	2249	=over
2087		2250
2088	=item $timer = new urxvt::timer	2251	=item $timer = new urxvt::timer
2089		2252
2090	Create a new timer object in started state. It is scheduled to fire	2253	Create a new timer object in started state. It is scheduled to fire
2091	immediately.	2254	immediately.
…		…
2140	sysread $term->{socket}, my $buf, 8192	2303	sysread $term->{socket}, my $buf, 8192
2141	or end-of-file;	2304	or end-of-file;
2142	});	2305	});
2143		2306
2144		2307
2145	=over 4	2308	=over
2146		2309
2147	=item $iow = new urxvt::iow	2310	=item $iow = new urxvt::iow
2148		2311
2149	Create a new io watcher object in stopped state.	2312	Create a new io watcher object in stopped state.
2150		2313
…		…
2177		2340
2178	This class implements idle watchers, that get called automatically when	2341	This class implements idle watchers, that get called automatically when
2179	the process is idle. They should return as fast as possible, after doing	2342	the process is idle. They should return as fast as possible, after doing
2180	some useful work.	2343	some useful work.
2181		2344
2182	=over 4	2345	=over
2183		2346
2184	=item $iw = new urxvt::iw	2347	=item $iw = new urxvt::iw
2185		2348
2186	Create a new idle watcher object in stopped state.	2349	Create a new idle watcher object in stopped state.
2187		2350
…		…
2212	->cb (sub {	2375	->cb (sub {
2213	my ($pw, $exit_status) = @_;	2376	my ($pw, $exit_status) = @_;
2214	...	2377	...
2215	});	2378	});
2216		2379
2217	=over 4	2380	=over
2218		2381
2219	=item $pw = new urxvt::pw	2382	=item $pw = new urxvt::pw
2220		2383
2221	Create a new process watcher in stopped state.	2384	Create a new process watcher in stopped state.
2222		2385
…		…
2239	=head2 URXVT_PERL_VERBOSITY	2402	=head2 URXVT_PERL_VERBOSITY
2240		2403
2241	This variable controls the verbosity level of the perl extension. Higher	2404	This variable controls the verbosity level of the perl extension. Higher
2242	numbers indicate more verbose output.	2405	numbers indicate more verbose output.
2243		2406
2244	=over 4	2407	=over
2245		2408
2246	=item == 0 - fatal messages	2409	=item == 0 - fatal messages only
		2410
		2411	=item >= 2 - general warnings (default level)
2247		2412
2248	=item >= 3 - script loading and management	2413	=item >= 3 - script loading and management
2249		2414
2250	=item >=10 - all called hooks	2415	=item >=10 - all called hooks
2251		2416

Diff Legend

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