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.178 by root, Sat Dec 26 09:02:42 2009 UTC vs.
Revision 1.271 by root, Fri Dec 9 05:06:46 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 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 wether xrdb is used to parse the resource file
376	or not.
377
378	=item macosx-pastebin and macosx-pastebin-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<maxosx-pastebin> 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	=back
399		56
400	=head1 API DOCUMENTATION	57	=head1 API DOCUMENTATION
401		58
402	=head2 General API Considerations	59	=head2 General API Considerations
403		60
…		…
413	terminal is destroyed.	70	terminal is destroyed.
414		71
415	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
416	hints on what they mean:	73	hints on what they mean:
417		74
418	=over 4	75	=over
419		76
420	=item $text	77	=item $text
421		78
422	Rxvt-unicodes special way of encoding text, where one "unicode" character	79	Rxvt-unicode's special way of encoding text, where one "unicode" character
423	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.
424		81
425	=item $string	82	=item $string
426		83
427	A perl text string, with an emphasis on I<text>. It can store all unicode	84	A perl text string, with an emphasis on I<text>. It can store all unicode
…		…
431	=item $octets	88	=item $octets
432		89
433	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
434	locale-specific way.	91	locale-specific way.
435		92
		93	=item $keysym
		94
		95	an integer that is a valid X11 keysym code. You can convert a string
		96	into a keysym and viceversa by using C<XStringToKeysym> and
		97	C<XKeysymToString>.
		98
436	=back	99	=back
437		100
438	=head2 Extension Objects	101	=head2 Extension Objects
439		102
440	Every perl extension is a perl class. A separate perl object is created	103	Every perl extension is a perl class. A separate perl object is created
441	for each terminal, and each terminal has its own set of extenion objects,	104	for each terminal, and each terminal has its own set of extension objects,
442	which are passed as the first parameter to hooks. So extensions can use	105	which are passed as the first parameter to hooks. So extensions can use
443	their C<$self> object without having to think about clashes with other	106	their C<$self> object without having to think about clashes with other
444	extensions or other terminals, with the exception of methods and members	107	extensions or other terminals, with the exception of methods and members
445	that begin with an underscore character C<_>: these are reserved for	108	that begin with an underscore character C<_>: these are reserved for
446	internal use.	109	internal use.
447		110
448	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
449	C<urxvt::term> class on this object.	112	C<urxvt::term> class on this object.
450		113
451	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.
452		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
453	=over 4	128	=over
454		129
455	=item $urxvt_term = $self->{term}	130	=item #:META:RESOURCE:name:type:desc
456		131
457	Returns the C<urxvt::term> object associated with this instance of the	132	The RESOURCE comment defines a resource used by the extension, where
458	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.
459		135
460	=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.
461		138
462	Dynamically enable the given hooks (named without the C<on_> prefix) for	139	Example: matcher provides the C<matcher.launcher> resource by having this
463	this extension, replacing any previous hook. This is useful when you want	140	comment:
464	to overwrite time-critical hooks only temporarily.
465		141
466	=item $self->disable ($hook_name[, $hook_name..])	142	#:META:RESOURCE:%.launcher:string:default launcher command
467		143
468	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
469		183
470	=back	184	=back
471		185
472	=head2 Hooks	186	=head2 Hooks
473		187
…		…
481	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
482	relevant action might not be carried out by the C++ code.	196	relevant action might not be carried out by the C++ code.
483		197
484	I<< When in doubt, return a false value (preferably C<()>). >>	198	I<< When in doubt, return a false value (preferably C<()>). >>
485		199
486	=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.
487		213
488	=item on_init $term	214	=item on_init $term
489		215
490	Called after a new terminal object has been initialized, but before	216	Called after a new terminal object has been initialized, but before
491	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
…		…
573		299
574	C<on_osc_seq_perl> should be used for new behaviour.	300	C<on_osc_seq_perl> should be used for new behaviour.
575		301
576	=item on_osc_seq_perl $term, $args, $resp	302	=item on_osc_seq_perl $term, $args, $resp
577		303
578	Called whenever the B<ESC ] 777 ; string ST> command sequence (OSC =	304	Called whenever the B<ESC ] 777 ; prefix ; string ST> command sequence
579	operating system command) is processed. Cursor position and other state	305	(OSC = operating system command) is processed. Cursor position and other
580	information is up-to-date when this happens. For interoperability, the	306	state information is up-to-date when this happens. For interoperability,
581	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
582	to distinguish it from commands for other extensions, and this might be	308	other suitable prefix, and a semicolon, to distinguish it from commands
583	enforced in the future.	309	for other extensions.
584		310
585	For example, C<overlay-osc> uses this:	311	For example, C<overlay-osc> uses this:
586		312
587	sub on_osc_seq_perl {	313	sub on_osc_seq_perl {
588	my ($self, $osc, $resp) = @_;	314	my ($self, $osc, $resp) = @_;
…		…
610	=item on_tt_write $term, $octets	336	=item on_tt_write $term, $octets
611		337
612	Called whenever some data is written to the tty/pty and can be used to	338	Called whenever some data is written to the tty/pty and can be used to
613	suppress or filter tty input.	339	suppress or filter tty input.
614		340
		341	=item on_tt_paste $term, $octets
		342
		343	Called whenever text is about to be pasted, with the text as argument. You
		344	can filter/change and paste the text yourself by returning a true value
		345	and calling C<< $term->tt_paste >> yourself. C<$octets> is
		346	locale-encoded.
		347
615	=item on_line_update $term, $row	348	=item on_line_update $term, $row
616		349
617	Called whenever a line was updated or changed. Can be used to filter	350	Called whenever a line was updated or changed. Can be used to filter
618	screen output (e.g. underline urls or other useless stuff). Only lines	351	screen output (e.g. underline urls or other useless stuff). Only lines
619	that are being shown will be filtered, and, due to performance reasons,	352	that are being shown will be filtered, and, due to performance reasons,
…		…
635		368
636	=item on_refresh_end $term	369	=item on_refresh_end $term
637		370
638	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>.
639		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
640	=item on_user_command $term, $string	381	=item on_user_command $term, $string *DEPRECATED*
641		382
642	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
643	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>
644	resource in the @@RXVT_NAME@@(1) manpage).	385	resource in the urxvt(1) manpage).
645		386
646	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
647	slightly in the future.	388	preference to the C<on_action> hook.
648		389
649	=item on_resize_all_windows $tern, $new_width, $new_height	390	=item on_resize_all_windows $term, $new_width, $new_height
650		391
651	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
652	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
653	returns TRUE, setting of the window hints is being skipped.	394	returns a true value, setting of the window hints is being skipped.
654		395
655	=item on_x_event $term, $event	396	=item on_x_event $term, $event
656		397
657	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
658	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
…		…
688		429
689	=item on_map_notify $term, $event	430	=item on_map_notify $term, $event
690		431
691	=item on_unmap_notify $term, $event	432	=item on_unmap_notify $term, $event
692		433
693	Called whenever the corresponding X event is received for the terminal If	434	Called whenever the corresponding X event is received for the terminal. If
694	the hook returns true, then the even will be ignored by rxvt-unicode.	435	the hook returns true, then the event will be ignored by rxvt-unicode.
695		436
696	The event is a hash with most values as named by Xlib (see the XEvent	437	The event is a hash with most values as named by Xlib (see the XEvent
697	manpage), with the additional members C<row> and C<col>, which are the	438	manpage), with the additional members C<row> and C<col>, which are the
698	(real, not screen-based) row and column under the mouse cursor.	439	(real, not screen-based) row and column under the mouse cursor.
699		440
700	C<on_key_press> additionally receives the string rxvt-unicode would	441	C<on_key_press> additionally receives the string rxvt-unicode would
701	output, if any, in locale-specific encoding.	442	output, if any, in locale-specific encoding.
702		443
703	subwindow.
704
705	=item on_client_message $term, $event	444	=item on_client_message $term, $event
706		445
707	=item on_wm_protocols $term, $event	446	=item on_wm_protocols $term, $event
708		447
709	=item on_wm_delete_window $term, $event	448	=item on_wm_delete_window $term, $event
710		449
711	Called when various types of ClientMessage events are received (all with	450	Called when various types of ClientMessage events are received (all with
712	format=32, WM_PROTOCOLS or WM_PROTOCOLS:WM_DELETE_WINDOW).	451	format=32, WM_PROTOCOLS or WM_PROTOCOLS:WM_DELETE_WINDOW).
713		452
		453	=item on_bell $term
		454
		455	Called on receipt of a bell character.
		456
714	=back	457	=back
715		458
716	=cut	459	=cut
717		460
718	package urxvt;	461	package urxvt;
719		462
720	use utf8;	463	use utf8;
721	use strict;	464	use strict qw(vars subs);
722	use Carp ();	465	use Carp ();
723	use Scalar::Util ();	466	use Scalar::Util ();
724	use List::Util ();	467	use List::Util ();
725		468
726	our $VERSION = 1;	469	our $VERSION = 1;
727	our $TERM;	470	our $TERM;
728	our @TERM_INIT;	471	our @TERM_INIT; # should go, prevents async I/O etc.
729	our @TERM_EXT;	472	our @TERM_EXT; # should go, prevents async I/O etc.
730	our @HOOKNAME;	473	our @HOOKNAME;
731	our %HOOKTYPE = map +($HOOKNAME[$_] => $_), 0..$#HOOKNAME;	474	our %HOOKTYPE = map +($HOOKNAME[$_] => $_), 0..$#HOOKNAME;
732	our %OPTION;	475	our %OPTION;
733		476
734	our $LIBDIR;	477	our $LIBDIR;
…		…
738		481
739	our $NOCHAR = chr 0xffff;	482	our $NOCHAR = chr 0xffff;
740		483
741	=head2 Variables in the C<urxvt> Package	484	=head2 Variables in the C<urxvt> Package
742		485
743	=over 4	486	=over
744		487
745	=item $urxvt::LIBDIR	488	=item $urxvt::LIBDIR
746		489
747	The rxvt-unicode library directory, where, among other things, the perl	490	The rxvt-unicode library directory, where, among other things, the perl
748	modules and scripts are stored.	491	modules and scripts are stored.
…		…
778		521
779	=back	522	=back
780		523
781	=head2 Functions in the C<urxvt> Package	524	=head2 Functions in the C<urxvt> Package
782		525
783	=over 4	526	=over
784		527
785	=item urxvt::fatal $errormessage	528	=item urxvt::fatal $errormessage
786		529
787	Fatally aborts execution with the given error message. Avoid at all	530	Fatally aborts execution with the given error message (which should
788	costs! The only time this is acceptable is when the terminal process	531	include a trailing newline). Avoid at all costs! The only time this
789	starts up.	532	is acceptable (and useful) is in the init hook, where it prevents the
		533	terminal from starting up.
790		534
791	=item urxvt::warn $string	535	=item urxvt::warn $string
792		536
793	Calls C<rxvt_warn> with the given string which should not include a	537	Calls C<rxvt_warn> with the given string which should include a trailing
794	newline. The module also overwrites the C<warn> builtin with a function	538	newline. The module also overwrites the C<warn> builtin with a function
795	that calls this function.	539	that calls this function.
796		540
797	Using this function has the advantage that its output ends up in the	541	Using this function has the advantage that its output ends up in the
798	correct place, e.g. on stderr of the connecting urxvtc client.	542	correct place, e.g. on stderr of the connecting urxvtc client.
…		…
802	=item @terms = urxvt::termlist	546	=item @terms = urxvt::termlist
803		547
804	Returns all urxvt::term objects that exist in this process, regardless of	548	Returns all urxvt::term objects that exist in this process, regardless of
805	whether they are started, being destroyed etc., so be careful. Only term	549	whether they are started, being destroyed etc., so be careful. Only term
806	objects that have perl extensions attached will be returned (because there	550	objects that have perl extensions attached will be returned (because there
807	is no urxvt::term objet associated with others).	551	is no urxvt::term object associated with others).
808		552
809	=item $time = urxvt::NOW	553	=item $time = urxvt::NOW
810		554
811	Returns the "current time" (as per the event loop).	555	Returns the "current time" (as per the event loop).
812		556
…		…
832	CirculateRequest, PropertyNotify, SelectionClear, SelectionRequest,	576	CirculateRequest, PropertyNotify, SelectionClear, SelectionRequest,
833	SelectionNotify, ColormapNotify, ClientMessage, MappingNotify	577	SelectionNotify, ColormapNotify, ClientMessage, MappingNotify
834		578
835	Various constants for use in X calls and event processing.	579	Various constants for use in X calls and event processing.
836		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
837	=back	593	=back
838		594
839	=head2 RENDITION	595	=head2 RENDITION
840		596
841	Rendition bitsets contain information about colour, font, font styles and	597	Rendition bitsets contain information about colour, font, font styles and
…		…
844	The following "macros" deal with changes in rendition sets. You should	600	The following "macros" deal with changes in rendition sets. You should
845	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,
846	as they contain important information required for correct operation of	602	as they contain important information required for correct operation of
847	rxvt-unicode.	603	rxvt-unicode.
848		604
849	=over 4	605	=over
850		606
851	=item $rend = urxvt::DEFAULT_RSTYLE	607	=item $rend = urxvt::DEFAULT_RSTYLE
852		608
853	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
854	being reset. Useful as a base to start when creating renditions.	610	being reset. Useful as a base to start when creating renditions.
855		611
856	=item $rend = urxvt::OVERLAY_RSTYLE	612	=item $rend = urxvt::OVERLAY_RSTYLE
857		613
858	Return the rendition mask used for overlays by default.	614	Return the rendition mask used for overlays by default.
859		615
860	=item $rendbit = urxvt::RS_Bold, RS_Italic, RS_Blink, RS_RVid, RS_Uline	616	=item $rendbit = urxvt::RS_Bold, urxvt::RS_Italic, urxvt::RS_Blink,
		617	urxvt::RS_RVid, urxvt::RS_Uline
861		618
862	Return the bit that enabled bold, italic, blink, reverse-video and	619	Return the bit that enabled bold, italic, blink, reverse-video and
863	underline, respectively. To enable such a style, just logically OR it into	620	underline, respectively. To enable such a style, just logically OR it into
864	the bitset.	621	the bitset.
865		622
…		…
902	};	659	};
903	}	660	}
904		661
905	no warnings 'utf8';	662	no warnings 'utf8';
906		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
907	my $verbosity = $ENV{URXVT_PERL_VERBOSITY};	730	my $verbosity = $ENV{URXVT_PERL_VERBOSITY} // 2;
908		731
909	sub verbose {	732	sub verbose {
910	my ($level, $msg) = @_;	733	my ($level, $msg) = @_;
911	warn "$msg\n" if $level <= $verbosity;	734	warn "$msg\n" if $level <= $verbosity;
912	}	735	}
…		…
923	$pkg =~ s/[^[:word:]]/_/g;	746	$pkg =~ s/[^[:word:]]/_/g;
924	$pkg = "urxvt::ext::$pkg";	747	$pkg = "urxvt::ext::$pkg";
925		748
926	verbose 3, "loading extension '$path' into package '$pkg'";	749	verbose 3, "loading extension '$path' into package '$pkg'";
927		750
		751	(${"$pkg\::_NAME"} = $path) =~ s/^.*[\\\/]//; # hackish
		752
928	open my $fh, "<:raw", $path	753	open my $fh, "<:raw", $path
929	or die "$path: $!";	754	or die "$path: $!";
930		755
931	my $source =	756	my $source =
932	"package $pkg; use strict; use utf8; no warnings 'utf8';\n"	757	"package $pkg; use strict qw(vars subs); use utf8; no warnings 'utf8';\n"
933	. "#line 1 \"$path\"\n{\n"	758	. "#line 1 \"$path\"\n{\n"
934	. (do { local $/; <$fh> })	759	. (do { local $/; <$fh> })
935	. "\n};\n1";	760	. "\n};\n1";
936		761
937	eval $source	762	eval $source
…		…
946	# called by the rxvt core	771	# called by the rxvt core
947	sub invoke {	772	sub invoke {
948	local $TERM = shift;	773	local $TERM = shift;
949	my $htype = shift;	774	my $htype = shift;
950		775
951	if ($htype == 0) { # INIT	776	if ($htype == HOOK_INIT) {
952	my @dirs = ((split /:/, $TERM->resource ("perl_lib")), "$LIBDIR/perl");	777	$TERM->scan_extensions;
953		778
954	my %ext_arg;	779	my %ext_arg;
955		780
956	{	781	{
957	my @init = @TERM_INIT;	782	my @init = @TERM_INIT;
…		…
960	my @pkg = @TERM_EXT;	785	my @pkg = @TERM_EXT;
961	@TERM_EXT = ();	786	@TERM_EXT = ();
962	$TERM->register_package ($_) for @pkg;	787	$TERM->register_package ($_) for @pkg;
963	}	788	}
964		789
		790	for (
		791	@{ delete $TERM->{perl_ext_3} },
965	for (grep $_, map { split /,/, $TERM->resource ("perl_ext_$_") } 1, 2) {	792	(grep $_, map { split /,/, $TERM->resource ("perl_ext_$_") } 1, 2),
		793	) {
966	if ($_ eq "default") {	794	if ($_ eq "default") {
		795
		796	$ext_arg{$_} = []
967	$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
968	} elsif (/^-(.*)$/) {	808	} elsif (/^-(.*)$/) { # remove from set
969	delete $ext_arg{$1};	809	delete $ext_arg{$1};
970	} 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};
971	push @{ $ext_arg{$1} }, $2;	816	push @{ $ext_arg{$1} }, defined $2 ? $2 : ();
		817
972	} else {	818	} else {
973	$ext_arg{$_} ||= [];	819	verbose 2, "cannot parse extension specification '$_', ignoring.";
974	}	820	}
975	}	821	}
976		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
977	for my $ext (sort keys %ext_arg) {	826	for my $ext (sort keys %ext_arg) {
978	my @files = grep -f $_, map "$_/$ext", @dirs;	827	my $path = $TERM->extension_path ($ext);
979		828
980	if (@files) {	829	if (defined $path) {
981	$TERM->register_package (extension_package $files[0], $ext_arg{$ext});	830	$TERM->autoload_extension ($ext, $ext_arg{$ext});
982	} else {	831	} else {
983	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";
984	}	833	}
985	}	834	}
986		835
987	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");
988	warn $@ if $@;	837	warn $@ if $@;
989	}	838	}
990		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
991	$retval = undef;	850	$retval = undef;
992		851
993	if (my $cb = $TERM->{_hook}[$htype]) {	852	if (my $cb = $TERM->{_hook}[$htype]) {
994	verbose 10, "$HOOKNAME[$htype] (" . (join ", ", $TERM, @_) . ")"	853	verbose 10, "$HOOKNAME[$htype] (" . (join ", ", $TERM, @_) . ")"
995	if $verbosity >= 10;	854	if $verbosity >= 10;
996		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
997	for my $pkg (keys %$cb) {	869	for my $pkg (keys %$cb) {
998	my $retval_ = eval { $cb->{$pkg}->($TERM->{_pkg}{$pkg}, @_) };	870	my $retval_ = eval { $cb->{$pkg}->($TERM->{_pkg}{$pkg} || $TERM, @_) };
999	$retval ||= $retval_;	871	$retval ||= $retval_;
1000		872
1001	if ($@) {	873	if ($@) {
1002	$TERM->ungrab; # better to lose the grab than the session	874	$TERM->ungrab; # better to lose the grab than the session
1003	warn $@;	875	warn $@;
…		…
1006		878
1007	verbose 11, "$HOOKNAME[$htype] returning <$retval>"	879	verbose 11, "$HOOKNAME[$htype] returning <$retval>"
1008	if $verbosity >= 11;	880	if $verbosity >= 11;
1009	}	881	}
1010		882
1011	if ($htype == 1) { # DESTROY	883	if ($htype == HOOK_DESTROY) {
1012	# clear package objects	884	# clear package objects
1013	%$_ = () for values %{ $TERM->{_pkg} };	885	%$_ = () for values %{ $TERM->{_pkg} };
1014		886
1015	# clear package	887	# clear package
1016	%$TERM = ();	888	%$TERM = ();
…		…
1046	}	918	}
1047	}	919	}
1048	($mask, @color{qw(fg bg)}, \@failed)	920	($mask, @color{qw(fg bg)}, \@failed)
1049	}	921	}
1050		922
1051	# urxvt::term::extension
1052
1053	package urxvt::term::extension;	923	package urxvt::term::extension;
1054		924
1055	sub enable {	925	=head2 The C<urxvt::term::extension> class
1056	my ($self, %hook) = @_;
1057	my $pkg = $self->{_pkg};
1058		926
1059	while (my ($name, $cb) = each %hook) {	927	Each extension attached to a terminal object is represented by
1060	my $htype = $HOOKTYPE{uc $name};	928	a C<urxvt::term::extension> object.
1061	defined $htype
1062	or Carp::croak "unsupported hook type '$name'";
1063		929
1064	$self->set_should_invoke ($htype, +1)	930	You can use these objects, which are passed to all callbacks to store any
1065	unless exists $self->{term}{_hook}[$htype]{$pkg};	931	state related to the terminal and extension instance.
1066		932
1067	$self->{term}{_hook}[$htype]{$pkg} = $cb;	933	The methods (And data members) documented below can be called on extension
1068	}	934	objects, in addition to call methods documented for the <urxvt::term>
1069	}	935	class.
1070		936
1071	sub disable {	937	=over
1072	my ($self, @hook) = @_;
1073	my $pkg = $self->{_pkg};
1074		938
1075	for my $name (@hook) {	939	=item $urxvt_term = $self->{term}
1076	my $htype = $HOOKTYPE{uc $name};
1077	defined $htype
1078	or Carp::croak "unsupported hook type '$name'";
1079		940
1080	$self->set_should_invoke ($htype, -1)	941	Returns the C<urxvt::term> object associated with this instance of the
1081	if delete $self->{term}{_hook}[$htype]{$pkg};	942	extension. This member I<must not> be changed in any way.
1082	}	943
1083	}	944	=cut
1084		945
1085	our $AUTOLOAD;	946	our $AUTOLOAD;
1086		947
1087	sub AUTOLOAD {	948	sub AUTOLOAD {
1088	$AUTOLOAD =~ /:([^:]+)$/	949	$AUTOLOAD =~ /:([^:]+)$/
…		…
1101		962
1102	sub DESTROY {	963	sub DESTROY {
1103	# nop	964	# nop
1104	}	965	}
1105		966
1106	# urxvt::destroy_hook	967	# urxvt::destroy_hook (basically a cheap Guard:: implementation)
1107		968
1108	sub urxvt::destroy_hook::DESTROY {	969	sub urxvt::destroy_hook::DESTROY {
1109	${$_[0]}->();	970	${$_[0]}->();
1110	}	971	}
1111		972
1112	sub urxvt::destroy_hook(&) {	973	sub urxvt::destroy_hook(&) {
1113	bless \shift, urxvt::destroy_hook::	974	bless \shift, urxvt::destroy_hook::
1114	}	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
1115		1099
1116	package urxvt::anyevent;	1100	package urxvt::anyevent;
1117		1101
1118	=head2 The C<urxvt::anyevent> Class	1102	=head2 The C<urxvt::anyevent> Class
1119		1103
1120	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
1121	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
1122	further programming. The only exception is that you cannot wait on	1106	further programming. The only exception is that you cannot wait on
1123	condition variables, but non-blocking condvar use is ok. What this means	1107	condition variables, but non-blocking condvar use is ok.
1124	is that you cannot use blocking APIs, but the non-blocking variant should	1108
1125	work.	1109	In practical terms this means is that you cannot use blocking APIs, but
		1110	the non-blocking variant should work.
1126		1111
1127	=cut	1112	=cut
1128		1113
1129	our $VERSION = '5.23';	1114	our $VERSION = '5.23';
1130		1115
…		…
1136		1121
1137	my $cb = $arg{cb};	1122	my $cb = $arg{cb};
1138		1123
1139	urxvt::timer	1124	urxvt::timer
1140	->new	1125	->new
1141	->after ($arg{after})	1126	->after ($arg{after}, $arg{interval})
1142	->interval ($arg{interval})
1143	->start
1144	->cb ($argv{interval} ? $cb : sub {	1127	->cb ($arg{interval} ? $cb : sub {
1145	$_[0]->stop; # need to cancel manually	1128	$_[0]->stop; # need to cancel manually
1146	$cb->();	1129	$cb->();
1147	})	1130	})
1148	}	1131	}
1149		1132
…		…
1191		1174
1192	sub DESTROY {	1175	sub DESTROY {
1193	$_[0][1]->stop;	1176	$_[0][1]->stop;
1194	}	1177	}
1195		1178
		1179	# only needed for AnyEvent < 6 compatibility
1196	sub one_event {	1180	sub one_event {
1197	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";
1198	}	1182	}
1199		1183
1200	package urxvt::term;	1184	package urxvt::term;
1201		1185
1202	=head2 The C<urxvt::term> Class	1186	=head2 The C<urxvt::term> Class
1203		1187
1204	=over 4	1188	=over
1205		1189
1206	=cut	1190	=cut
1207		1191
1208	# find on_xxx subs in the package and register them	1192	# find on_xxx subs in the package and register them
1209	# as hooks	1193	# as hooks
1210	sub register_package {	1194	sub register_package {
1211	my ($self, $pkg, $argv) = @_;	1195	my ($self, $pkg, $argv) = @_;
1212		1196
		1197	return if $self->{_pkg}{$pkg};
		1198
1213	no strict 'refs';	1199	no strict 'refs';
1214		1200
1215	urxvt::verbose 6, "register package $pkg to $self";	1201	urxvt::verbose 6, "register package $pkg to $self";
1216		1202
1217	@{"$pkg\::ISA"} = urxvt::term::extension::;	1203	@{"$pkg\::ISA"} = urxvt::term::extension::;
1218		1204
1219	my $proxy = bless {	1205	my $proxy = bless {
1220	_pkg => $pkg,	1206	_pkg => $pkg,
		1207	_name => ${"$pkg\::_NAME"}, # hackish
1221	argv => $argv,	1208	argv => $argv,
1222	}, $pkg;	1209	}, $pkg;
1223	Scalar::Util::weaken ($proxy->{term} = $self);	1210	Scalar::Util::weaken ($proxy->{term} = $self);
1224		1211
1225	$self->{_pkg}{$pkg} = $proxy;	1212	$self->{_pkg}{$pkg} = $proxy;
1226		1213
1227	for my $name (@HOOKNAME) {	1214	for my $name (@HOOKNAME) {
1228	if (my $ref = $pkg->can ("on_" . lc $name)) {	1215	if (my $ref = $pkg->can ("on_" . lc $name)) {
1229	$proxy->enable ($name => $ref);	1216	$proxy->enable ($name => $ref);
1230	}	1217	}
1231	}	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	}
1232	}	1331	}
1233		1332
1234	=item $term = new urxvt::term $envhashref, $rxvtname, [arg...]	1333	=item $term = new urxvt::term $envhashref, $rxvtname, [arg...]
1235		1334
1236	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
…		…
1255	}	1354	}
1256		1355
1257	=item $term->destroy	1356	=item $term->destroy
1258		1357
1259	Destroy the terminal object (close the window, free resources	1358	Destroy the terminal object (close the window, free resources
1260	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
1261	watchers (timers, io watchers) are still active.	1360	watchers (timers, io watchers) are still active.
1262		1361
1263	=item $term->exec_async ($cmd[, @args])	1362	=item $term->exec_async ($cmd[, @args])
1264		1363
1265	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
1266	("starts") programs in the background. This function takes care of setting	1365	("starts") programs in the background. This function takes care of setting
1267	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
1268	be preferred over explicit calls to C<exec> or C<system>.	1367	be preferred over explicit calls to C<exec> or C<system>.
1269		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
1270	Returns the pid of the subprocess or C<undef> on error.	1373	Returns the pid of the subprocess or C<undef> on error.
1271		1374
1272	=cut	1375	=cut
1273		1376
1274	sub exec_async {	1377	sub exec_async {
…		…
1277	my $pid = fork;	1380	my $pid = fork;
1278		1381
1279	return $pid	1382	return $pid
1280	if !defined $pid or $pid;	1383	if !defined $pid or $pid;
1281		1384
		1385	%ENV = (
1282	%ENV = %{ $self->env };	1386	%{ $self->env },
		1387	URXVT_EXT_WINDOWID => $self->parent,
		1388	);
1283		1389
1284	exec @_;	1390	exec @_;
1285	urxvt::_exit 255;	1391	urxvt::_exit 255;
1286	}	1392	}
1287		1393
…		…
1292	C<%urxvt::OPTION>. Options not enabled in this binary are not in the hash.	1398	C<%urxvt::OPTION>. Options not enabled in this binary are not in the hash.
1293		1399
1294	Here is a likely non-exhaustive list of option names, please see the	1400	Here is a likely non-exhaustive list of option names, please see the
1295	source file F</src/optinc.h> to see the actual list:	1401	source file F</src/optinc.h> to see the actual list:
1296		1402
1297	borderLess console cursorBlink cursorUnderline hold iconic insecure	1403	borderLess buffered console cursorBlink cursorUnderline hold iconic
1298	intensityStyles jumpScroll loginShell mapAlert meta8 mouseWheelScrollPage	1404	insecure intensityStyles iso14755 iso14755_52 jumpScroll loginShell
1299	override-redirect pastableTabs pointerBlank reverseVideo scrollBar	1405	mapAlert meta8 mouseWheelScrollPage override_redirect pastableTabs
1300	scrollBar_floating scrollBar_right scrollTtyKeypress scrollTtyOutput	1406	pointerBlank reverseVideo scrollBar scrollBar_floating scrollBar_right
1301	scrollWithBuffer secondaryScreen secondaryScroll skipBuiltinGlyphs	1407	scrollTtyKeypress scrollTtyOutput scrollWithBuffer secondaryScreen
1302	transparent tripleclickwords utmpInhibit visualBell	1408	secondaryScroll skipBuiltinGlyphs skipScroll transparent tripleclickwords
		1409	urgentOnBell utmpInhibit visualBell disablePasteBrackets
1303		1410
1304	=item $value = $term->resource ($name[, $newval])	1411	=item $value = $term->resource ($name[, $newval])
1305		1412
1306	Returns the current resource value associated with a given name and	1413	Returns the current resource value associated with a given name and
1307	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>
…		…
1320		1427
1321	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
1322	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>
1323	to see the actual list:	1430	to see the actual list:
1324		1431
1325	answerbackstring backgroundPixmap backspace_key boldFont boldItalicFont	1432	answerbackstring backgroundPixmap backspace_key blurradius
1326	borderLess chdir color cursorBlink cursorUnderline cutchars delete_key	1433	boldFont boldItalicFont borderLess buffered chdir color cursorBlink
1327	display_name embed ext_bwidth fade font geometry hold iconName	1434	cursorUnderline cutchars delete_key depth display_name embed ext_bwidth
1328	imFont imLocale inputMethod insecure int_bwidth intensityStyles	1435	fade font geometry hold iconName iconfile imFont imLocale inputMethod
1329	italicFont jumpScroll lineSpace letterSpace loginShell mapAlert meta8	1436	insecure int_bwidth intensityStyles iso14755 iso14755_52 italicFont
		1437	jumpScroll letterSpace lineSpace loginShell mapAlert meta8 modifier
1330	modifier mouseWheelScrollPage name override_redirect pastableTabs path	1438	mouseWheelScrollPage name override_redirect pastableTabs path perl_eval
1331	perl_eval perl_ext_1 perl_ext_2 perl_lib pointerBlank pointerBlankDelay	1439	perl_ext_1 perl_ext_2 perl_lib pointerBlank pointerBlankDelay
1332	preeditType print_pipe pty_fd reverseVideo saveLines scrollBar	1440	preeditType print_pipe pty_fd reverseVideo saveLines scrollBar
1333	scrollBar_align scrollBar_floating scrollBar_right scrollBar_thickness	1441	scrollBar_align scrollBar_floating scrollBar_right scrollBar_thickness
1334	scrollTtyKeypress scrollTtyOutput scrollWithBuffer scrollstyle	1442	scrollTtyKeypress scrollTtyOutput scrollWithBuffer scrollstyle
1335	secondaryScreen secondaryScroll shade term_name title	1443	secondaryScreen secondaryScroll shade skipBuiltinGlyphs skipScroll
1336	transient_for transparent transparent_all tripleclickwords utmpInhibit	1444	term_name title transient_for transparent tripleclickwords urgentOnBell
1337	visualBell	1445	utmpInhibit visualBell rewrapMode disablePasteBrackets
1338		1446
1339	=cut	1447	=cut
1340		1448
1341	sub resource($$;$) {	1449	sub resource($$;$) {
1342	my ($self, $name) = (shift, shift);	1450	my ($self, $name) = (shift, shift);
…		…
1349	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
1350	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
1351	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
1352	resource with that pattern exists.	1460	resource with that pattern exists.
1353		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
1354	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
1355	only one resource database per display, and later invocations might return	1473	only one resource database per display, and later invocations might return
1356	the wrong resources.	1474	the wrong resources.
1357		1475
1358	=item $success = $term->parse_keysym ($keysym_spec, $command_string)	1476	=item $value = $term->x_resource_boolean ($pattern)
1359		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
1360	Adds a keymap translation exactly as specified via a resource. See the	1499	Adds a key binding exactly as specified via a C<keysym> resource. See the
1361	C<keysym> resource in the @@RXVT_NAME@@(1) manpage.	1500	C<keysym> resource in the urxvt(1) manpage.
		1501
		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.
		1506
		1507	Example: the C<searchable-scrollback> by default binds itself
		1508	on C<Meta-s>, using C<< $self->bind_action >>, which calls C<<
		1509	$term->bind_action >>.
		1510
		1511	sub init {
		1512	my ($self) = @_;
		1513
		1514	$self->bind_action ("M-s" => "%:start");
		1515	}
1362		1516
1363	=item $rend = $term->rstyle ([$new_rstyle])	1517	=item $rend = $term->rstyle ([$new_rstyle])
1364		1518
1365	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
1366	the terminal application will use this style.	1520	the terminal application will use this style.
…		…
1374		1528
1375	=item ($row, $col) = $term->selection_beg ([$row, $col])	1529	=item ($row, $col) = $term->selection_beg ([$row, $col])
1376		1530
1377	=item ($row, $col) = $term->selection_end ([$row, $col])	1531	=item ($row, $col) = $term->selection_end ([$row, $col])
1378		1532
1379	Return the current values of the selection mark, begin or end positions,	1533	Return the current values of the selection mark, begin or end positions.
1380	and optionally set them to new values.	1534
		1535	When arguments are given, then the selection coordinates are set to
		1536	C<$row> and C<$col>, and the selection screen is set to the current
		1537	screen.
		1538
		1539	=item $screen = $term->selection_screen ([$screen])
		1540
		1541	Returns the current selection screen, and then optionally sets it.
1381		1542
1382	=item $term->selection_make ($eventtime[, $rectangular])	1543	=item $term->selection_make ($eventtime[, $rectangular])
1383		1544
1384	Tries to make a selection as set by C<selection_beg> and	1545	Tries to make a selection as set by C<selection_beg> and
1385	C<selection_end>. If C<$rectangular> is true (default: false), a	1546	C<selection_end>. If C<$rectangular> is true (default: false), a
1386	rectangular selection will be made. This is the prefered function to make	1547	rectangular selection will be made. This is the preferred function to make
1387	a selection.	1548	a selection.
1388		1549
1389	=item $success = $term->selection_grab ($eventtime)	1550	=item $success = $term->selection_grab ($eventtime[, $clipboard])
1390		1551
1391	Try to request the primary selection text from the server (for example, as	1552	Try to acquire ownership of the primary (clipboard if C<$clipboard> is
		1553	true) selection from the server. The corresponding text can be set
1392	set by the next method). No visual feedback will be given. This function	1554	with the next method. No visual feedback will be given. This function
1393	is mostly useful from within C<on_sel_grab> hooks.	1555	is mostly useful from within C<on_sel_grab> hooks.
1394		1556
1395	=item $oldtext = $term->selection ([$newtext])	1557	=item $oldtext = $term->selection ([$newtext, $clipboard])
1396		1558
1397	Return the current selection text and optionally replace it by C<$newtext>.	1559	Return the current selection (clipboard if C<$clipboard> is true) text
		1560	and optionally replace it by C<$newtext>.
		1561
		1562	=item $term->selection_clear ([$clipboard])
		1563
		1564	Revoke ownership of the primary (clipboard if C<$clipboard> is true) selection.
1398		1565
1399	=item $term->overlay_simple ($x, $y, $text)	1566	=item $term->overlay_simple ($x, $y, $text)
1400		1567
1401	Create a simple multi-line overlay box. See the next method for details.	1568	Create a simple multi-line overlay box. See the next method for details.
1402		1569
…		…
1430	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
1431	as long as the perl object is referenced.	1598	as long as the perl object is referenced.
1432		1599
1433	The methods currently supported on C<urxvt::overlay> objects are:	1600	The methods currently supported on C<urxvt::overlay> objects are:
1434		1601
1435	=over 4	1602	=over
1436		1603
1437	=item $overlay->set ($x, $y, $text[, $rend])	1604	=item $overlay->set ($x, $y, $text[, $rend])
1438		1605
1439	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
1440	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
…		…
1484	Returns the number of screen-cells this string would need. Correctly	1651	Returns the number of screen-cells this string would need. Correctly
1485	accounts for wide and combining characters.	1652	accounts for wide and combining characters.
1486		1653
1487	=item $octets = $term->locale_encode ($string)	1654	=item $octets = $term->locale_encode ($string)
1488		1655
1489	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>.
1490		1658
1491	=item $string = $term->locale_decode ($octets)	1659	=item $string = $term->locale_decode ($octets)
1492		1660
1493	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>.
1494		1663
1495	=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])
1496		1665
1497	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
1498	(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
…		…
1511		1680
1512	=item $term->scr_add_lines ($string)	1681	=item $term->scr_add_lines ($string)
1513		1682
1514	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
1515	running inside the terminal. It may not contain command sequences (escape	1684	running inside the terminal. It may not contain command sequences (escape
1516	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,
1517	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.
1518		1688
1519	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
1520	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
1521	C<on_add_lines> hook, though.	1691	C<on_add_lines> hook, though.
1522		1692
…		…
1530	locale-specific encoding of the terminal and can contain command sequences	1700	locale-specific encoding of the terminal and can contain command sequences
1531	(escape codes) that will be interpreted.	1701	(escape codes) that will be interpreted.
1532		1702
1533	=item $term->tt_write ($octets)	1703	=item $term->tt_write ($octets)
1534		1704
1535	Write the octets given in C<$data> 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
1536	pass characters instead of octets, you should convert your strings first	1707	characters instead of octets, you should convert your strings first to the
1537	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.
		1717
		1718	=item $term->tt_paste ($octets)
		1719
		1720	Write the octets given in C<$octets> to the tty as a paste, converting NL to
		1721	CR and bracketing the data with control sequences if bracketed paste mode
		1722	is set.
1538		1723
1539	=item $old_events = $term->pty_ev_events ([$new_events])	1724	=item $old_events = $term->pty_ev_events ([$new_events])
1540		1725
1541	Replaces the event mask of the pty watcher by the given event mask. Can	1726	Replaces the event mask of the pty watcher by the given event mask. Can
1542	be used to suppress input and output handling to the pty/tty. See the	1727	be used to suppress input and output handling to the pty/tty. See the
…		…
1561	Adds the specified events to the vt event mask. Useful e.g. when you want	1746	Adds the specified events to the vt event mask. Useful e.g. when you want
1562	to receive pointer events all the times:	1747	to receive pointer events all the times:
1563		1748
1564	$term->vt_emask_add (urxvt::PointerMotionMask);	1749	$term->vt_emask_add (urxvt::PointerMotionMask);
1565		1750
		1751	=item $term->set_urgency ($set)
		1752
		1753	Enable/disable the urgency hint on the toplevel window.
		1754
1566	=item $term->focus_in	1755	=item $term->focus_in
1567		1756
1568	=item $term->focus_out	1757	=item $term->focus_out
1569		1758
1570	=item $term->key_press ($state, $keycode[, $time])	1759	=item $term->key_press ($state, $keycode[, $time])
1571		1760
1572	=item $term->key_release ($state, $keycode[, $time])	1761	=item $term->key_release ($state, $keycode[, $time])
1573		1762
1574	Deliver various fake events to to terminal.	1763	Deliver various fake events to to terminal.
1575		1764
1576	=item $window_width = $term->width	1765	=item $window_width = $term->width ([$new_value])
1577		1766
1578	=item $window_height = $term->height	1767	=item $window_height = $term->height ([$new_value])
1579		1768
1580	=item $font_width = $term->fwidth	1769	=item $font_width = $term->fwidth ([$new_value])
1581		1770
1582	=item $font_height = $term->fheight	1771	=item $font_height = $term->fheight ([$new_value])
1583		1772
1584	=item $font_ascent = $term->fbase	1773	=item $font_ascent = $term->fbase ([$new_value])
1585		1774
1586	=item $terminal_rows = $term->nrow	1775	=item $terminal_rows = $term->nrow ([$new_value])
1587		1776
1588	=item $terminal_columns = $term->ncol	1777	=item $terminal_columns = $term->ncol ([$new_value])
1589		1778
1590	=item $has_focus = $term->focus	1779	=item $has_focus = $term->focus ([$new_value])
1591		1780
1592	=item $is_mapped = $term->mapped	1781	=item $is_mapped = $term->mapped ([$new_value])
1593		1782
1594	=item $max_scrollback = $term->saveLines	1783	=item $max_scrollback = $term->saveLines ([$new_value])
1595		1784
1596	=item $nrow_plus_saveLines = $term->total_rows	1785	=item $nrow_plus_saveLines = $term->total_rows ([$new_value])
1597		1786
1598	=item $topmost_scrollback_row = $term->top_row	1787	=item $topmost_scrollback_row = $term->top_row ([$new_value])
1599		1788
1600	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.
1601		1791
1602	=item $x_display = $term->display_id	1792	=item $x_display = $term->display_id
1603		1793
1604	Return the DISPLAY used by rxvt-unicode.	1794	Return the DISPLAY used by rxvt-unicode.
1605		1795
…		…
1642		1832
1643	=item $cursor_is_hidden = $term->hidden_cursor	1833	=item $cursor_is_hidden = $term->hidden_cursor
1644		1834
1645	Returns whether the cursor is currently hidden or not.	1835	Returns whether the cursor is currently hidden or not.
1646		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
1647	=item $view_start = $term->view_start ([$newvalue])	1847	=item $view_start = $term->view_start ([$newvalue])
1648		1848
1649	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,
1650	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
1651	this many lines into the scrollback buffer.	1851	the terminal contents. Lower values scroll this many lines into the
		1852	scrollback buffer.
1652		1853
1653	=item $term->want_refresh	1854	=item $term->want_refresh
1654		1855
1655	Requests a screen refresh. At the next opportunity, rxvt-unicode will	1856	Requests a screen refresh. At the next opportunity, rxvt-unicode will
1656	compare the on-screen display with its stored representation. If they	1857	compare the on-screen display with its stored representation. If they
1657	differ, it redraws the differences.	1858	differ, it redraws the differences.
1658		1859
1659	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.
1660		1865
1661	=item $text = $term->ROW_t ($row_number[, $new_text[, $start_col]])	1866	=item $text = $term->ROW_t ($row_number[, $new_text[, $start_col]])
1662		1867
1663	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 >>
1664	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
…		…
1710		1915
1711	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
1712	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
1713	following methods:	1918	following methods:
1714		1919
1715	=over 4	1920	=over
1716		1921
1717	=item $text = $line->t ([$new_text])	1922	=item $text = $line->t ([$new_text])
1718		1923
1719	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>
1720		1925
…		…
1766	}	1971	}
1767		1972
1768	sub urxvt::line::t {	1973	sub urxvt::line::t {
1769	my ($self) = @_;	1974	my ($self) = @_;
1770		1975
1771	if (@_ > 1)	1976	if (@_ > 1) {
1772	{
1773	$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})
1774	for $self->{beg} .. $self->{end};	1978	for $self->{beg} .. $self->{end};
1775	}	1979	}
1776		1980
1777	defined wantarray &&	1981	defined wantarray &&
1778	substr +(join "", map $self->{term}->ROW_t ($_), $self->{beg} .. $self->{end}),	1982	substr +(join "", map $self->{term}->ROW_t ($_), $self->{beg} .. $self->{end}),
1779	0, $self->{len}	1983	0, $self->{len}
1780	}	1984	}
1781		1985
1782	sub urxvt::line::r {	1986	sub urxvt::line::r {
1783	my ($self) = @_;	1987	my ($self) = @_;
1784		1988
1785	if (@_ > 1)	1989	if (@_ > 1) {
1786	{
1787	$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})
1788	for $self->{beg} .. $self->{end};	1991	for $self->{beg} .. $self->{end};
1789	}	1992	}
1790		1993
1791	if (defined wantarray) {	1994	if (defined wantarray) {
1792	my $rend = [	1995	my $rend = [
1793	map @{ $self->{term}->ROW_r ($_) }, $self->{beg} .. $self->{end}	1996	map @{ $self->{term}->ROW_r ($_) }, $self->{beg} .. $self->{end}
1794	];	1997	];
…		…
1826	where one character corresponds to one screen cell. See	2029	where one character corresponds to one screen cell. See
1827	C<< $term->ROW_t >> for details.	2030	C<< $term->ROW_t >> for details.
1828		2031
1829	=item $string = $term->special_decode $text	2032	=item $string = $term->special_decode $text
1830		2033
1831	Converts rxvt-unicodes text representation into a perl string. See	2034	Converts rxvt-unicode's text representation into a perl string. See
1832	C<< $term->ROW_t >> for details.	2035	C<< $term->ROW_t >> for details.
1833		2036
1834	=item $success = $term->grab_button ($button, $modifiermask[, $window = $term->vt])	2037	=item $success = $term->grab_button ($button, $modifiermask[, $window = $term->vt])
1835		2038
1836	=item $term->ungrab_button ($button, $modifiermask[, $window = $term->vt])	2039	=item $term->ungrab_button ($button, $modifiermask[, $window = $term->vt])
…		…
1856	Calls XAllowEvents with both ReplayPointer and ReplayKeyboard for the most	2059	Calls XAllowEvents with both ReplayPointer and ReplayKeyboard for the most
1857	recent grab.	2060	recent grab.
1858		2061
1859	=item $term->ungrab	2062	=item $term->ungrab
1860		2063
1861	Calls XUngrab for the most recent grab. Is called automatically on	2064	Calls XUngrabPointer and XUngrabKeyboard for the most recent grab. Is called automatically on
1862	evaluation errors, as it is better to lose the grab in the error case as	2065	evaluation errors, as it is better to lose the grab in the error case as
1863	the session.	2066	the session.
1864		2067
1865	=item $atom = $term->XInternAtom ($atom_name[, $only_if_exists])	2068	=item $atom = $term->XInternAtom ($atom_name[, $only_if_exists])
1866		2069
…		…
1886		2089
1887	=item ($x, $y, $child_window) = $term->XTranslateCoordinates ($src, $dst, $x, $y)	2090	=item ($x, $y, $child_window) = $term->XTranslateCoordinates ($src, $dst, $x, $y)
1888		2091
1889	=item $term->XChangeInput ($window, $add_events[, $del_events])	2092	=item $term->XChangeInput ($window, $add_events[, $del_events])
1890		2093
		2094	=item $keysym = $term->XStringToKeysym ($string)
		2095
		2096	=item $string = $term->XKeysymToString ($keysym)
		2097
1891	Various X or X-related functions. The C<$term> object only serves as	2098	Various X or X-related functions. The C<$term> object only serves as
1892	the source of the display, otherwise those functions map more-or-less	2099	the source of the display, otherwise those functions map more-or-less
1893	directory onto the X functions of the same name.	2100	directly onto the X functions of the same name.
1894		2101
1895	=back	2102	=back
1896		2103
1897	=cut	2104	=cut
1898		2105
1899	package urxvt::popup;	2106	package urxvt::popup;
1900		2107
1901	=head2 The C<urxvt::popup> Class	2108	=head2 The C<urxvt::popup> Class
1902		2109
1903	=over 4	2110	=over
1904		2111
1905	=cut	2112	=cut
1906		2113
1907	sub add_item {	2114	sub add_item {
1908	my ($self, $item) = @_;	2115	my ($self, $item) = @_;
…		…
2044	->cb (sub {	2251	->cb (sub {
2045	$term->{overlay}->set (0, 0,	2252	$term->{overlay}->set (0, 0,
2046	sprintf "%2d:%02d:%02d", (localtime urxvt::NOW)[2,1,0]);	2253	sprintf "%2d:%02d:%02d", (localtime urxvt::NOW)[2,1,0]);
2047	});	2254	});
2048		2255
2049	=over 4	2256	=over
2050		2257
2051	=item $timer = new urxvt::timer	2258	=item $timer = new urxvt::timer
2052		2259
2053	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
2054	immediately.	2261	immediately.
2055		2262
2056	=item $timer = $timer->cb (sub { my ($timer) = @_; ... })	2263	=item $timer = $timer->cb (sub { my ($timer) = @_; ... })
2057		2264
2058	Set the callback to be called when the timer triggers.	2265	Set the callback to be called when the timer triggers.
2059		2266
2060	=item $tstamp = $timer->at
2061
2062	Return the time this watcher will fire next.
2063
2064	=item $timer = $timer->set ($tstamp)	2267	=item $timer = $timer->set ($tstamp[, $interval])
2065		2268
2066	Set the time the event is generated to $tstamp.	2269	Set the time the event is generated to $tstamp (and optionally specifies a
		2270	new $interval).
2067		2271
2068	=item $timer = $timer->interval ($interval)	2272	=item $timer = $timer->interval ($interval)
2069		2273
2070	Normally (and when C<$interval> is C<0>), the timer will automatically	2274	By default (and when C<$interval> is C<0>), the timer will automatically
2071	stop after it has fired once. If C<$interval> is non-zero, then the timer	2275	stop after it has fired once. If C<$interval> is non-zero, then the timer
2072	is automatically rescheduled at the given intervals.	2276	is automatically rescheduled at the given intervals.
2073		2277
2074	=item $timer = $timer->start	2278	=item $timer = $timer->start
2075		2279
2076	Start the timer.	2280	Start the timer.
2077		2281
2078	=item $timer = $timer->start ($tstamp)	2282	=item $timer = $timer->start ($tstamp[, $interval])
2079		2283
2080	Set the event trigger time to C<$tstamp> and start the timer.	2284	Set the event trigger time to C<$tstamp> and start the timer. Optionally
		2285	also replaces the interval.
2081		2286
2082	=item $timer = $timer->after ($delay)	2287	=item $timer = $timer->after ($delay[, $interval])
2083		2288
2084	Like C<start>, but sets the expiry timer to c<urxvt::NOW + $delay>.	2289	Like C<start>, but sets the expiry timer to c<urxvt::NOW + $delay>.
2085		2290
2086	=item $timer = $timer->stop	2291	=item $timer = $timer->stop
2087		2292
…		…
2105	sysread $term->{socket}, my $buf, 8192	2310	sysread $term->{socket}, my $buf, 8192
2106	or end-of-file;	2311	or end-of-file;
2107	});	2312	});
2108		2313
2109		2314
2110	=over 4	2315	=over
2111		2316
2112	=item $iow = new urxvt::iow	2317	=item $iow = new urxvt::iow
2113		2318
2114	Create a new io watcher object in stopped state.	2319	Create a new io watcher object in stopped state.
2115		2320
…		…
2142		2347
2143	This class implements idle watchers, that get called automatically when	2348	This class implements idle watchers, that get called automatically when
2144	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
2145	some useful work.	2350	some useful work.
2146		2351
2147	=over 4	2352	=over
2148		2353
2149	=item $iw = new urxvt::iw	2354	=item $iw = new urxvt::iw
2150		2355
2151	Create a new idle watcher object in stopped state.	2356	Create a new idle watcher object in stopped state.
2152		2357
…		…
2177	->cb (sub {	2382	->cb (sub {
2178	my ($pw, $exit_status) = @_;	2383	my ($pw, $exit_status) = @_;
2179	...	2384	...
2180	});	2385	});
2181		2386
2182	=over 4	2387	=over
2183		2388
2184	=item $pw = new urxvt::pw	2389	=item $pw = new urxvt::pw
2185		2390
2186	Create a new process watcher in stopped state.	2391	Create a new process watcher in stopped state.
2187		2392
…		…
2204	=head2 URXVT_PERL_VERBOSITY	2409	=head2 URXVT_PERL_VERBOSITY
2205		2410
2206	This variable controls the verbosity level of the perl extension. Higher	2411	This variable controls the verbosity level of the perl extension. Higher
2207	numbers indicate more verbose output.	2412	numbers indicate more verbose output.
2208		2413
2209	=over 4	2414	=over
2210		2415
2211	=item == 0 - fatal messages	2416	=item == 0 - fatal messages only
		2417
		2418	=item >= 2 - general warnings (default level)
2212		2419
2213	=item >= 3 - script loading and management	2420	=item >= 3 - script loading and management
2214		2421
2215	=item >=10 - all called hooks	2422	=item >=10 - all called hooks
2216		2423
…		…
2218		2425
2219	=back	2426	=back
2220		2427
2221	=head1 AUTHOR	2428	=head1 AUTHOR
2222		2429
2223	Marc Lehmann <pcg@goof.com>	2430	Marc Lehmann <schmorp@schmorp.de>
2224	http://software.schmorp.de/pkg/rxvt-unicode	2431	http://software.schmorp.de/pkg/rxvt-unicode
2225		2432
2226	=cut	2433	=cut
2227		2434
2228	1	2435	1

Diff Legend

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