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.158 by ayin, Wed Oct 31 15:17:51 2007 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,automove-background,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 (the 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 automove-background
309
310	This is basically a very small extension that dynamically changes the
311	background pixmap offset to the window position, in effect creating the
312	same effect as pseudo transparency with a custom pixmap. No scaling is
313	supported in this mode. Example:
314
315	@@RXVT_NAME@@ -pixmap background.xpm -pe automove-background
316
317	L<http://wiki.archlinux.org/index.php/Perl_Background_Rotation/Extensions>
318	shows how this extension can be used to implement an automatically blurred
319	transparent background.
320
321	=item block-graphics-to-ascii
322
323	A not very useful example of filtering all text output to the terminal
324	by replacing all line-drawing characters (U+2500 .. U+259F) by a
325	similar-looking ascii character.
326
327	=item digital-clock
328
329	Displays a digital clock using the built-in overlay.
330
331	=item remote-clipboard
332
333	Somewhat of a misnomer, this extension adds two menu entries to the
334	selection popup that allows one to run external commands to store the
335	selection somewhere and fetch it again.
336
337	We use it to implement a "distributed selection mechanism", which just
338	means that one command uploads the file to a remote server, and another
339	reads it.
340
341	The commands can be set using the C<URxvt.remote-selection.store> and
342	C<URxvt.remote-selection.fetch> resources. The first should read the
343	selection to store from STDIN (always in UTF-8), the second should provide
344	the selection data on STDOUT (also in UTF-8).
345
346	The defaults (which are likely useless to you) use rsh and cat:
347
348	URxvt.remote-selection.store: rsh ruth 'cat >/tmp/distributed-selection'
349	URxvt.remote-selection.fetch: rsh ruth 'cat /tmp/distributed-selection'
350
351	=item selection-pastebin
352
353	This is a little rarely useful extension that Uploads the selection as
354	textfile to a remote site (or does other things). (The implementation is
355	not currently secure for use in a multiuser environment as it writes to
356	F</tmp> directly.).
357
358	It listens to the C<selection-pastebin:remote-pastebin> keyboard command,
359	i.e.
360
361	URxvt.keysym.C-M-e: perl:selection-pastebin:remote-pastebin
362
363	Pressing this combination runs a command with C<%> replaced by the name of
364	the textfile. This command can be set via a resource:
365
366	URxvt.selection-pastebin.cmd: rsync -apP % ruth:/var/www/www.ta-sa.org/files/txt/.
367
368	And the default is likely not useful to anybody but the few people around
369	here :)
370
371	The name of the textfile is the hex encoded md5 sum of the selection, so
372	the same content should lead to the same filename.
373
374	After a successful upload the selection will be replaced by the text given
375	in the C<selection-pastebin-url> resource (again, the % is the placeholder
376	for the filename):
377
378	URxvt.selection-pastebin.url: http://www.ta-sa.org/files/txt/%
379
380	I<Note to xrdb users:> xrdb uses the C preprocessor, which might interpret
381	the double C</> characters as comment start. Use C<\057\057> instead,
382	which works regardless of wether xrdb is used to parse the resource file
383	or not.
384
385	=item example-refresh-hooks
386
387	Displays a very simple digital clock in the upper right corner of the
388	window. Illustrates overwriting the refresh callbacks to create your own
389	overlays or changes.
390
391	=back
392		56
393	=head1 API DOCUMENTATION	57	=head1 API DOCUMENTATION
394		58
395	=head2 General API Considerations	59	=head2 General API Considerations
396		60
…		…
406	terminal is destroyed.	70	terminal is destroyed.
407		71
408	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
409	hints on what they mean:	73	hints on what they mean:
410		74
411	=over 4	75	=over
412		76
413	=item $text	77	=item $text
414		78
415	Rxvt-unicodes special way of encoding text, where one "unicode" character	79	Rxvt-unicode's special way of encoding text, where one "unicode" character
416	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.
417		81
418	=item $string	82	=item $string
419		83
420	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
…		…
424	=item $octets	88	=item $octets
425		89
426	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
427	locale-specific way.	91	locale-specific way.
428		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
429	=back	99	=back
430		100
431	=head2 Extension Objects	101	=head2 Extension Objects
432		102
433	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
434	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,
435	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
436	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
437	extensions or other terminals, with the exception of methods and members	107	extensions or other terminals, with the exception of methods and members
438	that begin with an underscore character C<_>: these are reserved for	108	that begin with an underscore character C<_>: these are reserved for
439	internal use.	109	internal use.
440		110
441	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
442	C<urxvt::term> class on this object.	112	C<urxvt::term> class on this object.
443		113
444	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.
445		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
446	=over 4	128	=over
447		129
448	=item $urxvt_term = $self->{term}	130	=item #:META:RESOURCE:name:type:desc
449		131
450	Returns the C<urxvt::term> object associated with this instance of the	132	The RESOURCE comment defines a resource used by the extension, where
451	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.
452		135
453	=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.
454		138
455	Dynamically enable the given hooks (named without the C<on_> prefix) for	139	Example: matcher provides the C<matcher.launcher> resource by having this
456	this extension, replacing any previous hook. This is useful when you want	140	comment:
457	to overwrite time-critical hooks only temporarily.
458		141
459	=item $self->disable ($hook_name[, $hook_name..])	142	#:META:RESOURCE:%.launcher:string:default launcher command
460		143
461	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
462		183
463	=back	184	=back
464		185
465	=head2 Hooks	186	=head2 Hooks
466		187
…		…
474	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
475	relevant action might not be carried out by the C++ code.	196	relevant action might not be carried out by the C++ code.
476		197
477	I<< When in doubt, return a false value (preferably C<()>). >>	198	I<< When in doubt, return a false value (preferably C<()>). >>
478		199
479	=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.
480		213
481	=item on_init $term	214	=item on_init $term
482		215
483	Called after a new terminal object has been initialized, but before	216	Called after a new terminal object has been initialized, but before
484	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
…		…
554		287
555	It is called before lines are scrolled out (so rows 0 .. min ($lines - 1,	288	It is called before lines are scrolled out (so rows 0 .. min ($lines - 1,
556	$nrow - 1) represent the lines to be scrolled out). C<$saved> is the total	289	$nrow - 1) represent the lines to be scrolled out). C<$saved> is the total
557	number of lines that will be in the scrollback buffer.	290	number of lines that will be in the scrollback buffer.
558		291
559	=item on_osc_seq $term, $op, $args	292	=item on_osc_seq $term, $op, $args, $resp
560		293
561	Called on every OSC sequence and can be used to suppress it or modify its	294	Called on every OSC sequence and can be used to suppress it or modify its
562	behaviour. The default should be to return an empty list. A true value	295	behaviour. The default should be to return an empty list. A true value
563	suppresses execution of the request completely. Make sure you don't get	296	suppresses execution of the request completely. Make sure you don't get
564	confused by recursive invocations when you output an osc sequence within	297	confused by recursive invocations when you output an OSC sequence within
565	this callback.	298	this callback.
566		299
567	C<on_osc_seq_perl> should be used for new behaviour.	300	C<on_osc_seq_perl> should be used for new behaviour.
568		301
569	=item on_osc_seq_perl $term, $string	302	=item on_osc_seq_perl $term, $args, $resp
570		303
571	Called whenever the B<ESC ] 777 ; string ST> command sequence (OSC =	304	Called whenever the B<ESC ] 777 ; prefix ; string ST> command sequence
572	operating system command) is processed. Cursor position and other state	305	(OSC = operating system command) is processed. Cursor position and other
573	information is up-to-date when this happens. For interoperability, the	306	state information is up-to-date when this happens. For interoperability,
574	string should start with the extension name and a colon, to distinguish	307	the argument should start with the extension name (sans -osc) or some
575	it from commands for other extensions, and this might be enforced in the	308	other suitable prefix, and a semicolon, to distinguish it from commands
576	future.	309	for other extensions.
		310
		311	For example, C<overlay-osc> uses this:
		312
		313	sub on_osc_seq_perl {
		314	my ($self, $osc, $resp) = @_;
		315
		316	return unless $osc =~ s/^overlay;//;
		317
		318	... process remaining $osc string
		319	}
577		320
578	Be careful not ever to trust (in a security sense) the data you receive,	321	Be careful not ever to trust (in a security sense) the data you receive,
579	as its source can not easily be controlled (e-mail content, messages from	322	as its source can not easily be controlled (e-mail content, messages from
580	other users on the same system etc.).	323	other users on the same system etc.).
		324
		325	For responses, C<$resp> contains the end-of-args separator used by the
		326	sender.
581		327
582	=item on_add_lines $term, $string	328	=item on_add_lines $term, $string
583		329
584	Called whenever text is about to be output, with the text as argument. You	330	Called whenever text is about to be output, with the text as argument. You
585	can filter/change and output the text yourself by returning a true value	331	can filter/change and output the text yourself by returning a true value
…		…
590	=item on_tt_write $term, $octets	336	=item on_tt_write $term, $octets
591		337
592	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
593	suppress or filter tty input.	339	suppress or filter tty input.
594		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
595	=item on_line_update $term, $row	348	=item on_line_update $term, $row
596		349
597	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
598	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
599	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,
…		…
606	later with the already-modified line (e.g. if unrelated parts change), so	359	later with the already-modified line (e.g. if unrelated parts change), so
607	you cannot just toggle rendition bits, but only set them.	360	you cannot just toggle rendition bits, but only set them.
608		361
609	=item on_refresh_begin $term	362	=item on_refresh_begin $term
610		363
611	Called just before the screen gets redrawn. Can be used for overlay	364	Called just before the screen gets redrawn. Can be used for overlay or
612	or similar effects by modify terminal contents in refresh_begin, and	365	similar effects by modifying the terminal contents in refresh_begin, and
613	restoring them in refresh_end. The built-in overlay and selection display	366	restoring them in refresh_end. The built-in overlay and selection display
614	code is run after this hook, and takes precedence.	367	code is run after this hook, and takes precedence.
615		368
616	=item on_refresh_end $term	369	=item on_refresh_end $term
617		370
618	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>.
619		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
620	=item on_user_command $term, $string	381	=item on_user_command $term, $string *DEPRECATED*
621		382
622	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
623	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>
624	resource in the @@RXVT_NAME@@(1) manpage).	385	resource in the urxvt(1) manpage).
625		386
626	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
627	slightly in the future.	388	preference to the C<on_action> hook.
628		389
629	=item on_resize_all_windows $tern, $new_width, $new_height	390	=item on_resize_all_windows $term, $new_width, $new_height
630		391
631	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
632	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
633	returns TRUE, setting of the window hints is being skipped.	394	returns a true value, setting of the window hints is being skipped.
634		395
635	=item on_x_event $term, $event	396	=item on_x_event $term, $event
636		397
637	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
638	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
…		…
668		429
669	=item on_map_notify $term, $event	430	=item on_map_notify $term, $event
670		431
671	=item on_unmap_notify $term, $event	432	=item on_unmap_notify $term, $event
672		433
673	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
674	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.
675		436
676	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
677	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
678	(real, not screen-based) row and column under the mouse cursor.	439	(real, not screen-based) row and column under the mouse cursor.
679		440
680	C<on_key_press> additionally receives the string rxvt-unicode would	441	C<on_key_press> additionally receives the string rxvt-unicode would
681	output, if any, in locale-specific encoding.	442	output, if any, in locale-specific encoding.
682		443
683	subwindow.
684
685	=item on_client_message $term, $event	444	=item on_client_message $term, $event
686		445
687	=item on_wm_protocols $term, $event	446	=item on_wm_protocols $term, $event
688		447
689	=item on_wm_delete_window $term, $event	448	=item on_wm_delete_window $term, $event
690		449
691	Called when various types of ClientMessage events are received (all with	450	Called when various types of ClientMessage events are received (all with
692	format=32, WM_PROTOCOLS or WM_PROTOCOLS:WM_DELETE_WINDOW).	451	format=32, WM_PROTOCOLS or WM_PROTOCOLS:WM_DELETE_WINDOW).
693		452
		453	=item on_bell $term
		454
		455	Called on receipt of a bell character.
		456
694	=back	457	=back
695		458
696	=cut	459	=cut
697		460
698	package urxvt;	461	package urxvt;
699		462
700	use utf8;	463	use utf8;
701	use strict;	464	use strict qw(vars subs);
702	use Carp ();	465	use Carp ();
703	use Scalar::Util ();	466	use Scalar::Util ();
704	use List::Util ();	467	use List::Util ();
705		468
706	our $VERSION = 1;	469	our $VERSION = 1;
707	our $TERM;	470	our $TERM;
708	our @TERM_INIT;	471	our @TERM_INIT; # should go, prevents async I/O etc.
709	our @TERM_EXT;	472	our @TERM_EXT; # should go, prevents async I/O etc.
710	our @HOOKNAME;	473	our @HOOKNAME;
711	our %HOOKTYPE = map +($HOOKNAME[$_] => $_), 0..$#HOOKNAME;	474	our %HOOKTYPE = map +($HOOKNAME[$_] => $_), 0..$#HOOKNAME;
712	our %OPTION;	475	our %OPTION;
713		476
714	our $LIBDIR;	477	our $LIBDIR;
…		…
718		481
719	our $NOCHAR = chr 0xffff;	482	our $NOCHAR = chr 0xffff;
720		483
721	=head2 Variables in the C<urxvt> Package	484	=head2 Variables in the C<urxvt> Package
722		485
723	=over 4	486	=over
724		487
725	=item $urxvt::LIBDIR	488	=item $urxvt::LIBDIR
726		489
727	The rxvt-unicode library directory, where, among other things, the perl	490	The rxvt-unicode library directory, where, among other things, the perl
728	modules and scripts are stored.	491	modules and scripts are stored.
…		…
758		521
759	=back	522	=back
760		523
761	=head2 Functions in the C<urxvt> Package	524	=head2 Functions in the C<urxvt> Package
762		525
763	=over 4	526	=over
764		527
765	=item urxvt::fatal $errormessage	528	=item urxvt::fatal $errormessage
766		529
767	Fatally aborts execution with the given error message. Avoid at all	530	Fatally aborts execution with the given error message (which should
768	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
769	starts up.	532	is acceptable (and useful) is in the init hook, where it prevents the
		533	terminal from starting up.
770		534
771	=item urxvt::warn $string	535	=item urxvt::warn $string
772		536
773	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
774	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
775	that calls this function.	539	that calls this function.
776		540
777	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
778	correct place, e.g. on stderr of the connecting urxvtc client.	542	correct place, e.g. on stderr of the connecting urxvtc client.
…		…
782	=item @terms = urxvt::termlist	546	=item @terms = urxvt::termlist
783		547
784	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
785	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
786	objects that have perl extensions attached will be returned (because there	550	objects that have perl extensions attached will be returned (because there
787	is no urxvt::term objet associated with others).	551	is no urxvt::term object associated with others).
788		552
789	=item $time = urxvt::NOW	553	=item $time = urxvt::NOW
790		554
791	Returns the "current time" (as per the event loop).	555	Returns the "current time" (as per the event loop).
792		556
…		…
812	CirculateRequest, PropertyNotify, SelectionClear, SelectionRequest,	576	CirculateRequest, PropertyNotify, SelectionClear, SelectionRequest,
813	SelectionNotify, ColormapNotify, ClientMessage, MappingNotify	577	SelectionNotify, ColormapNotify, ClientMessage, MappingNotify
814		578
815	Various constants for use in X calls and event processing.	579	Various constants for use in X calls and event processing.
816		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
817	=back	593	=back
818		594
819	=head2 RENDITION	595	=head2 RENDITION
820		596
821	Rendition bitsets contain information about colour, font, font styles and	597	Rendition bitsets contain information about colour, font, font styles and
…		…
824	The following "macros" deal with changes in rendition sets. You should	600	The following "macros" deal with changes in rendition sets. You should
825	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,
826	as they contain important information required for correct operation of	602	as they contain important information required for correct operation of
827	rxvt-unicode.	603	rxvt-unicode.
828		604
829	=over 4	605	=over
830		606
831	=item $rend = urxvt::DEFAULT_RSTYLE	607	=item $rend = urxvt::DEFAULT_RSTYLE
832		608
833	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
834	being reset. Useful as a base to start when creating renditions.	610	being reset. Useful as a base to start when creating renditions.
835		611
836	=item $rend = urxvt::OVERLAY_RSTYLE	612	=item $rend = urxvt::OVERLAY_RSTYLE
837		613
838	Return the rendition mask used for overlays by default.	614	Return the rendition mask used for overlays by default.
839		615
840	=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
841		618
842	Return the bit that enabled bold, italic, blink, reverse-video and	619	Return the bit that enabled bold, italic, blink, reverse-video and
843	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
844	the bitset.	621	the bitset.
845		622
…		…
882	};	659	};
883	}	660	}
884		661
885	no warnings 'utf8';	662	no warnings 'utf8';
886		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
887	my $verbosity = $ENV{URXVT_PERL_VERBOSITY};	730	my $verbosity = $ENV{URXVT_PERL_VERBOSITY} // 2;
888		731
889	sub verbose {	732	sub verbose {
890	my ($level, $msg) = @_;	733	my ($level, $msg) = @_;
891	warn "$msg\n" if $level <= $verbosity;	734	warn "$msg\n" if $level <= $verbosity;
892	}	735	}
…		…
903	$pkg =~ s/[^[:word:]]/_/g;	746	$pkg =~ s/[^[:word:]]/_/g;
904	$pkg = "urxvt::ext::$pkg";	747	$pkg = "urxvt::ext::$pkg";
905		748
906	verbose 3, "loading extension '$path' into package '$pkg'";	749	verbose 3, "loading extension '$path' into package '$pkg'";
907		750
		751	(${"$pkg\::_NAME"} = $path) =~ s/^.*[\\\/]//; # hackish
		752
908	open my $fh, "<:raw", $path	753	open my $fh, "<:raw", $path
909	or die "$path: $!";	754	or die "$path: $!";
910		755
911	my $source =	756	my $source =
912	"package $pkg; use strict; use utf8; no warnings 'utf8';\n"	757	"package $pkg; use strict qw(vars subs); use utf8; no warnings 'utf8';\n"
913	. "#line 1 \"$path\"\n{\n"	758	. "#line 1 \"$path\"\n{\n"
914	. (do { local $/; <$fh> })	759	. (do { local $/; <$fh> })
915	. "\n};\n1";	760	. "\n};\n1";
916		761
917	eval $source	762	eval $source
…		…
926	# called by the rxvt core	771	# called by the rxvt core
927	sub invoke {	772	sub invoke {
928	local $TERM = shift;	773	local $TERM = shift;
929	my $htype = shift;	774	my $htype = shift;
930		775
931	if ($htype == 0) { # INIT	776	if ($htype == HOOK_INIT) {
932	my @dirs = ((split /:/, $TERM->resource ("perl_lib")), "$LIBDIR/perl");	777	$TERM->scan_extensions;
933		778
934	my %ext_arg;	779	my %ext_arg;
935		780
936	{	781	{
937	my @init = @TERM_INIT;	782	my @init = @TERM_INIT;
…		…
940	my @pkg = @TERM_EXT;	785	my @pkg = @TERM_EXT;
941	@TERM_EXT = ();	786	@TERM_EXT = ();
942	$TERM->register_package ($_) for @pkg;	787	$TERM->register_package ($_) for @pkg;
943	}	788	}
944		789
		790	for (
		791	@{ delete $TERM->{perl_ext_3} },
945	for (grep $_, map { split /,/, $TERM->resource ("perl_ext_$_") } 1, 2) {	792	(grep $_, map { split /,/, $TERM->resource ("perl_ext_$_") } 1, 2),
		793	) {
946	if ($_ eq "default") {	794	if ($_ eq "default") {
		795
		796	$ext_arg{$_} = []
947	$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
948	} elsif (/^-(.*)$/) {	808	} elsif (/^-(.*)$/) { # remove from set
949	delete $ext_arg{$1};	809	delete $ext_arg{$1};
950	} 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};
951	push @{ $ext_arg{$1} }, $2;	816	push @{ $ext_arg{$1} }, defined $2 ? $2 : ();
		817
952	} else {	818	} else {
953	$ext_arg{$_} ||= [];	819	verbose 2, "cannot parse extension specification '$_', ignoring.";
954	}	820	}
955	}	821	}
956		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
957	for my $ext (sort keys %ext_arg) {	826	for my $ext (sort keys %ext_arg) {
958	my @files = grep -f $_, map "$_/$ext", @dirs;	827	my $path = $TERM->extension_path ($ext);
959		828
960	if (@files) {	829	if (defined $path) {
961	$TERM->register_package (extension_package $files[0], $ext_arg{$ext});	830	$TERM->autoload_extension ($ext, $ext_arg{$ext});
962	} else {	831	} else {
963	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";
964	}	833	}
965	}	834	}
966		835
967	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");
968	warn $@ if $@;	837	warn $@ if $@;
969	}	838	}
970		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
971	$retval = undef;	850	$retval = undef;
972		851
973	if (my $cb = $TERM->{_hook}[$htype]) {	852	if (my $cb = $TERM->{_hook}[$htype]) {
974	verbose 10, "$HOOKNAME[$htype] (" . (join ", ", $TERM, @_) . ")"	853	verbose 10, "$HOOKNAME[$htype] (" . (join ", ", $TERM, @_) . ")"
975	if $verbosity >= 10;	854	if $verbosity >= 10;
976		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
977	for my $pkg (keys %$cb) {	869	for my $pkg (keys %$cb) {
978	my $retval_ = eval { $cb->{$pkg}->($TERM->{_pkg}{$pkg}, @_) };	870	my $retval_ = eval { $cb->{$pkg}->($TERM->{_pkg}{$pkg} || $TERM, @_) };
979	$retval ||= $retval_;	871	$retval ||= $retval_;
980		872
981	if ($@) {	873	if ($@) {
982	$TERM->ungrab; # better to lose the grab than the session	874	$TERM->ungrab; # better to lose the grab than the session
983	warn $@;	875	warn $@;
…		…
986		878
987	verbose 11, "$HOOKNAME[$htype] returning <$retval>"	879	verbose 11, "$HOOKNAME[$htype] returning <$retval>"
988	if $verbosity >= 11;	880	if $verbosity >= 11;
989	}	881	}
990		882
991	if ($htype == 1) { # DESTROY	883	if ($htype == HOOK_DESTROY) {
992	# clear package objects	884	# clear package objects
993	%$_ = () for values %{ $TERM->{_pkg} };	885	%$_ = () for values %{ $TERM->{_pkg} };
994		886
995	# clear package	887	# clear package
996	%$TERM = ();	888	%$TERM = ();
…		…
1026	}	918	}
1027	}	919	}
1028	($mask, @color{qw(fg bg)}, \@failed)	920	($mask, @color{qw(fg bg)}, \@failed)
1029	}	921	}
1030		922
1031	# urxvt::term::extension
1032
1033	package urxvt::term::extension;	923	package urxvt::term::extension;
1034		924
1035	sub enable {	925	=head2 The C<urxvt::term::extension> class
1036	my ($self, %hook) = @_;
1037	my $pkg = $self->{_pkg};
1038		926
1039	while (my ($name, $cb) = each %hook) {	927	Each extension attached to a terminal object is represented by
1040	my $htype = $HOOKTYPE{uc $name};	928	a C<urxvt::term::extension> object.
1041	defined $htype
1042	or Carp::croak "unsupported hook type '$name'";
1043		929
1044	$self->set_should_invoke ($htype, +1)	930	You can use these objects, which are passed to all callbacks to store any
1045	unless exists $self->{term}{_hook}[$htype]{$pkg};	931	state related to the terminal and extension instance.
1046		932
1047	$self->{term}{_hook}[$htype]{$pkg} = $cb;	933	The methods (And data members) documented below can be called on extension
1048	}	934	objects, in addition to call methods documented for the <urxvt::term>
1049	}	935	class.
1050		936
1051	sub disable {	937	=over
1052	my ($self, @hook) = @_;
1053	my $pkg = $self->{_pkg};
1054		938
1055	for my $name (@hook) {	939	=item $urxvt_term = $self->{term}
1056	my $htype = $HOOKTYPE{uc $name};
1057	defined $htype
1058	or Carp::croak "unsupported hook type '$name'";
1059		940
1060	$self->set_should_invoke ($htype, -1)	941	Returns the C<urxvt::term> object associated with this instance of the
1061	if delete $self->{term}{_hook}[$htype]{$pkg};	942	extension. This member I<must not> be changed in any way.
1062	}	943
1063	}	944	=cut
1064		945
1065	our $AUTOLOAD;	946	our $AUTOLOAD;
1066		947
1067	sub AUTOLOAD {	948	sub AUTOLOAD {
1068	$AUTOLOAD =~ /:([^:]+)$/	949	$AUTOLOAD =~ /:([^:]+)$/
…		…
1081		962
1082	sub DESTROY {	963	sub DESTROY {
1083	# nop	964	# nop
1084	}	965	}
1085		966
1086	# urxvt::destroy_hook	967	# urxvt::destroy_hook (basically a cheap Guard:: implementation)
1087		968
1088	sub urxvt::destroy_hook::DESTROY {	969	sub urxvt::destroy_hook::DESTROY {
1089	${$_[0]}->();	970	${$_[0]}->();
1090	}	971	}
1091		972
1092	sub urxvt::destroy_hook(&) {	973	sub urxvt::destroy_hook(&) {
1093	bless \shift, urxvt::destroy_hook::	974	bless \shift, urxvt::destroy_hook::
1094	}	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
1095		1099
1096	package urxvt::anyevent;	1100	package urxvt::anyevent;
1097		1101
1098	=head2 The C<urxvt::anyevent> Class	1102	=head2 The C<urxvt::anyevent> Class
1099		1103
1100	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
1101	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
1102	further programming. The only exception is that you cannot wait on	1106	further programming. The only exception is that you cannot wait on
1103	condition variables, but non-blocking condvar use is ok. What this means	1107	condition variables, but non-blocking condvar use is ok.
1104	is that you cannot use blocking APIs, but the non-blocking variant should
1105	work.
1106		1108
1107	=cut	1109	In practical terms this means is that you cannot use blocking APIs, but
		1110	the non-blocking variant should work.
1108		1111
		1112	=cut
		1113
1109	our $VERSION = 1;	1114	our $VERSION = '5.23';
1110		1115
1111	$INC{"urxvt/anyevent.pm"} = 1; # mark us as there	1116	$INC{"urxvt/anyevent.pm"} = 1; # mark us as there
1112	push @AnyEvent::REGISTRY, [urxvt => urxvt::anyevent::];	1117	push @AnyEvent::REGISTRY, [urxvt => urxvt::anyevent::];
1113		1118
1114	sub timer {	1119	sub timer {
…		…
1116		1121
1117	my $cb = $arg{cb};	1122	my $cb = $arg{cb};
1118		1123
1119	urxvt::timer	1124	urxvt::timer
1120	->new	1125	->new
1121	->start (urxvt::NOW + $arg{after})	1126	->after ($arg{after}, $arg{interval})
1122	->cb (sub {	1127	->cb ($arg{interval} ? $cb : sub {
1123	$_[0]->stop; # need to cancel manually	1128	$_[0]->stop; # need to cancel manually
1124	$cb->();	1129	$cb->();
1125	})	1130	})
1126	}	1131	}
1127		1132
1128	sub io {	1133	sub io {
1129	my ($class, %arg) = @_;	1134	my ($class, %arg) = @_;
1130		1135
1131	my $cb = $arg{cb};	1136	my $cb = $arg{cb};
		1137	my $fd = fileno $arg{fh};
		1138	defined $fd or $fd = $arg{fh};
1132		1139
1133	bless [$arg{fh}, urxvt::iow	1140	bless [$arg{fh}, urxvt::iow
1134	->new	1141	->new
1135	->fd (fileno $arg{fh})	1142	->fd ($fd)
1136	->events (($arg{poll} =~ /r/ ? 1 : 0)	1143	->events (($arg{poll} =~ /r/ ? 1 : 0)
1137	| ($arg{poll} =~ /w/ ? 2 : 0))	1144	| ($arg{poll} =~ /w/ ? 2 : 0))
1138	->start	1145	->start
1139	->cb (sub {	1146	->cb ($cb)
1140	$cb->(($_[1] & 1 ? 'r' : '')
1141	. ($_[1] & 2 ? 'w' : ''));
1142	})],
1143	urxvt::anyevent::	1147	], urxvt::anyevent::
		1148	}
		1149
		1150	sub idle {
		1151	my ($class, %arg) = @_;
		1152
		1153	my $cb = $arg{cb};
		1154
		1155	urxvt::iw
		1156	->new
		1157	->start
		1158	->cb ($cb)
		1159	}
		1160
		1161	sub child {
		1162	my ($class, %arg) = @_;
		1163
		1164	my $cb = $arg{cb};
		1165
		1166	urxvt::pw
		1167	->new
		1168	->start ($arg{pid})
		1169	->cb (sub {
		1170	$_[0]->stop; # need to cancel manually
		1171	$cb->($_[0]->rpid, $_[0]->rstatus);
		1172	})
1144	}	1173	}
1145		1174
1146	sub DESTROY {	1175	sub DESTROY {
1147	$_[0][1]->stop;	1176	$_[0][1]->stop;
1148	}	1177	}
1149		1178
1150	sub condvar {	1179	# only needed for AnyEvent < 6 compatibility
1151	bless \my $flag, urxvt::anyevent::
1152	}
1153
1154	sub broadcast {
1155	${$_[0]}++;
1156	}
1157
1158	sub wait {
1159	unless (${$_[0]}) {
1160	Carp::croak "AnyEvent->condvar blocking wait unsupported in urxvt, use a non-blocking API";
1161	}
1162	}
1163
1164	sub one_event {	1180	sub one_event {
1165	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";
1166	}	1182	}
1167		1183
1168	package urxvt::term;	1184	package urxvt::term;
1169		1185
1170	=head2 The C<urxvt::term> Class	1186	=head2 The C<urxvt::term> Class
1171		1187
1172	=over 4	1188	=over
1173		1189
1174	=cut	1190	=cut
1175		1191
1176	# find on_xxx subs in the package and register them	1192	# find on_xxx subs in the package and register them
1177	# as hooks	1193	# as hooks
1178	sub register_package {	1194	sub register_package {
1179	my ($self, $pkg, $argv) = @_;	1195	my ($self, $pkg, $argv) = @_;
1180		1196
		1197	return if $self->{_pkg}{$pkg};
		1198
1181	no strict 'refs';	1199	no strict 'refs';
1182		1200
1183	urxvt::verbose 6, "register package $pkg to $self";	1201	urxvt::verbose 6, "register package $pkg to $self";
1184		1202
1185	@{"$pkg\::ISA"} = urxvt::term::extension::;	1203	@{"$pkg\::ISA"} = urxvt::term::extension::;
1186		1204
1187	my $proxy = bless {	1205	my $proxy = bless {
1188	_pkg => $pkg,	1206	_pkg => $pkg,
		1207	_name => ${"$pkg\::_NAME"}, # hackish
1189	argv => $argv,	1208	argv => $argv,
1190	}, $pkg;	1209	}, $pkg;
1191	Scalar::Util::weaken ($proxy->{term} = $self);	1210	Scalar::Util::weaken ($proxy->{term} = $self);
1192		1211
1193	$self->{_pkg}{$pkg} = $proxy;	1212	$self->{_pkg}{$pkg} = $proxy;
1194		1213
1195	for my $name (@HOOKNAME) {	1214	for my $name (@HOOKNAME) {
1196	if (my $ref = $pkg->can ("on_" . lc $name)) {	1215	if (my $ref = $pkg->can ("on_" . lc $name)) {
1197	$proxy->enable ($name => $ref);	1216	$proxy->enable ($name => $ref);
1198	}	1217	}
1199	}	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	}
1200	}	1331	}
1201		1332
1202	=item $term = new urxvt::term $envhashref, $rxvtname, [arg...]	1333	=item $term = new urxvt::term $envhashref, $rxvtname, [arg...]
1203		1334
1204	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
…		…
1223	}	1354	}
1224		1355
1225	=item $term->destroy	1356	=item $term->destroy
1226		1357
1227	Destroy the terminal object (close the window, free resources	1358	Destroy the terminal object (close the window, free resources
1228	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
1229	watchers (timers, io watchers) are still active.	1360	watchers (timers, io watchers) are still active.
1230		1361
1231	=item $term->exec_async ($cmd[, @args])	1362	=item $term->exec_async ($cmd[, @args])
1232		1363
1233	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
1234	("starts") programs in the background. This function takes care of setting	1365	("starts") programs in the background. This function takes care of setting
1235	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
1236	be preferred over explicit calls to C<exec> or C<system>.	1367	be preferred over explicit calls to C<exec> or C<system>.
1237		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
1238	Returns the pid of the subprocess or C<undef> on error.	1373	Returns the pid of the subprocess or C<undef> on error.
1239		1374
1240	=cut	1375	=cut
1241		1376
1242	sub exec_async {	1377	sub exec_async {
…		…
1245	my $pid = fork;	1380	my $pid = fork;
1246		1381
1247	return $pid	1382	return $pid
1248	if !defined $pid or $pid;	1383	if !defined $pid or $pid;
1249		1384
		1385	%ENV = (
1250	%ENV = %{ $self->env };	1386	%{ $self->env },
		1387	URXVT_EXT_WINDOWID => $self->parent,
		1388	);
1251		1389
1252	exec @_;	1390	exec @_;
1253	urxvt::_exit 255;	1391	urxvt::_exit 255;
1254	}	1392	}
1255		1393
…		…
1260	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.
1261		1399
1262	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
1263	source file F</src/optinc.h> to see the actual list:	1401	source file F</src/optinc.h> to see the actual list:
1264		1402
1265	borderLess console cursorBlink cursorUnderline hold iconic insecure	1403	borderLess buffered console cursorBlink cursorUnderline hold iconic
1266	intensityStyles jumpScroll loginShell mapAlert meta8 mouseWheelScrollPage	1404	insecure intensityStyles iso14755 iso14755_52 jumpScroll loginShell
1267	override-redirect pastableTabs pointerBlank reverseVideo scrollBar	1405	mapAlert meta8 mouseWheelScrollPage override_redirect pastableTabs
1268	scrollBar_floating scrollBar_right scrollTtyKeypress scrollTtyOutput	1406	pointerBlank reverseVideo scrollBar scrollBar_floating scrollBar_right
1269	scrollWithBuffer secondaryScreen secondaryScroll skipBuiltinGlyphs	1407	scrollTtyKeypress scrollTtyOutput scrollWithBuffer secondaryScreen
1270	transparent tripleclickwords utmpInhibit visualBell	1408	secondaryScroll skipBuiltinGlyphs skipScroll transparent tripleclickwords
		1409	urgentOnBell utmpInhibit visualBell disablePasteBrackets
1271		1410
1272	=item $value = $term->resource ($name[, $newval])	1411	=item $value = $term->resource ($name[, $newval])
1273		1412
1274	Returns the current resource value associated with a given name and	1413	Returns the current resource value associated with a given name and
1275	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>
…		…
1288		1427
1289	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
1290	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>
1291	to see the actual list:	1430	to see the actual list:
1292		1431
1293	answerbackstring backgroundPixmap backspace_key boldFont boldItalicFont	1432	answerbackstring backgroundPixmap backspace_key blurradius
1294	borderLess color cursorBlink cursorUnderline cutchars delete_key	1433	boldFont boldItalicFont borderLess buffered chdir color cursorBlink
1295	display_name embed ext_bwidth fade font geometry hold iconName	1434	cursorUnderline cutchars delete_key depth display_name embed ext_bwidth
1296	imFont imLocale inputMethod insecure int_bwidth intensityStyles	1435	fade font geometry hold iconName iconfile imFont imLocale inputMethod
		1436	insecure int_bwidth intensityStyles iso14755 iso14755_52 italicFont
1297	italicFont jumpScroll lineSpace loginShell mapAlert meta8 modifier	1437	jumpScroll letterSpace lineSpace loginShell mapAlert meta8 modifier
1298	mouseWheelScrollPage name override_redirect pastableTabs path perl_eval	1438	mouseWheelScrollPage name override_redirect pastableTabs path perl_eval
1299	perl_ext_1 perl_ext_2 perl_lib pointerBlank pointerBlankDelay	1439	perl_ext_1 perl_ext_2 perl_lib pointerBlank pointerBlankDelay
1300	preeditType print_pipe pty_fd reverseVideo saveLines scrollBar	1440	preeditType print_pipe pty_fd reverseVideo saveLines scrollBar
1301	scrollBar_align scrollBar_floating scrollBar_right scrollBar_thickness	1441	scrollBar_align scrollBar_floating scrollBar_right scrollBar_thickness
1302	scrollTtyKeypress scrollTtyOutput scrollWithBuffer scrollstyle	1442	scrollTtyKeypress scrollTtyOutput scrollWithBuffer scrollstyle
1303	secondaryScreen secondaryScroll selectstyle shade term_name title	1443	secondaryScreen secondaryScroll shade skipBuiltinGlyphs skipScroll
1304	transient_for transparent transparent_all tripleclickwords utmpInhibit	1444	term_name title transient_for transparent tripleclickwords urgentOnBell
1305	visualBell	1445	utmpInhibit visualBell rewrapMode disablePasteBrackets
1306		1446
1307	=cut	1447	=cut
1308		1448
1309	sub resource($$;$) {	1449	sub resource($$;$) {
1310	my ($self, $name) = (shift, shift);	1450	my ($self, $name) = (shift, shift);
1311	unshift @_, $self, $name, ($name =~ s/\s*\+\s*(\d+)$// ? $1 : 0);	1451	unshift @_, $self, $name, ($name =~ s/\s*\+\s*(\d+)$// ? $1 : 0);
1312	&urxvt::term::_resource	1452	goto &urxvt::term::_resource
1313	}	1453	}
1314		1454
1315	=item $value = $term->x_resource ($pattern)	1455	=item $value = $term->x_resource ($pattern)
1316		1456
1317	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
1318	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
1319	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
1320	resource with that pattern exists.	1460	resource with that pattern exists.
1321		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
1322	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
1323	only one resource database per display, and later invocations might return	1473	only one resource database per display, and later invocations might return
1324	the wrong resources.	1474	the wrong resources.
1325		1475
1326	=item $success = $term->parse_keysym ($keysym_spec, $command_string)	1476	=item $value = $term->x_resource_boolean ($pattern)
1327		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
1328	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
1329	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	}
1330		1516
1331	=item $rend = $term->rstyle ([$new_rstyle])	1517	=item $rend = $term->rstyle ([$new_rstyle])
1332		1518
1333	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
1334	the terminal application will use this style.	1520	the terminal application will use this style.
…		…
1342		1528
1343	=item ($row, $col) = $term->selection_beg ([$row, $col])	1529	=item ($row, $col) = $term->selection_beg ([$row, $col])
1344		1530
1345	=item ($row, $col) = $term->selection_end ([$row, $col])	1531	=item ($row, $col) = $term->selection_end ([$row, $col])
1346		1532
1347	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.
1348	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.
1349		1542
1350	=item $term->selection_make ($eventtime[, $rectangular])	1543	=item $term->selection_make ($eventtime[, $rectangular])
1351		1544
1352	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
1353	C<selection_end>. If C<$rectangular> is true (default: false), a	1546	C<selection_end>. If C<$rectangular> is true (default: false), a
1354	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
1355	a selection.	1548	a selection.
1356		1549
1357	=item $success = $term->selection_grab ($eventtime)	1550	=item $success = $term->selection_grab ($eventtime[, $clipboard])
1358		1551
1359	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
1360	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
1361	is mostly useful from within C<on_sel_grab> hooks.	1555	is mostly useful from within C<on_sel_grab> hooks.
1362		1556
1363	=item $oldtext = $term->selection ([$newtext])	1557	=item $oldtext = $term->selection ([$newtext, $clipboard])
1364		1558
1365	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.
1366		1565
1367	=item $term->overlay_simple ($x, $y, $text)	1566	=item $term->overlay_simple ($x, $y, $text)
1368		1567
1369	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.
1370		1569
…		…
1398	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
1399	as long as the perl object is referenced.	1598	as long as the perl object is referenced.
1400		1599
1401	The methods currently supported on C<urxvt::overlay> objects are:	1600	The methods currently supported on C<urxvt::overlay> objects are:
1402		1601
1403	=over 4	1602	=over
1404		1603
1405	=item $overlay->set ($x, $y, $text, $rend)	1604	=item $overlay->set ($x, $y, $text[, $rend])
1406		1605
1407	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
1408	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
1409	at a specific position inside the overlay.	1608	at a specific position inside the overlay.
		1609
		1610	If C<$rend> is missing, then the rendition will not be changed.
1410		1611
1411	=item $overlay->hide	1612	=item $overlay->hide
1412		1613
1413	If visible, hide the overlay, but do not destroy it.	1614	If visible, hide the overlay, but do not destroy it.
1414		1615
…		…
1450	Returns the number of screen-cells this string would need. Correctly	1651	Returns the number of screen-cells this string would need. Correctly
1451	accounts for wide and combining characters.	1652	accounts for wide and combining characters.
1452		1653
1453	=item $octets = $term->locale_encode ($string)	1654	=item $octets = $term->locale_encode ($string)
1454		1655
1455	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>.
1456		1658
1457	=item $string = $term->locale_decode ($octets)	1659	=item $string = $term->locale_decode ($octets)
1458		1660
1459	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>.
1460		1663
1461	=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])
1462		1665
1463	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
1464	(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
…		…
1477		1680
1478	=item $term->scr_add_lines ($string)	1681	=item $term->scr_add_lines ($string)
1479		1682
1480	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
1481	running inside the terminal. It may not contain command sequences (escape	1684	running inside the terminal. It may not contain command sequences (escape
1482	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,
1483	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.
1484		1688
1485	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
1486	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
1487	C<on_add_lines> hook, though.	1691	C<on_add_lines> hook, though.
1488		1692
…		…
1496	locale-specific encoding of the terminal and can contain command sequences	1700	locale-specific encoding of the terminal and can contain command sequences
1497	(escape codes) that will be interpreted.	1701	(escape codes) that will be interpreted.
1498		1702
1499	=item $term->tt_write ($octets)	1703	=item $term->tt_write ($octets)
1500		1704
1501	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
1502	pass characters instead of octets, you should convert your strings first	1707	characters instead of octets, you should convert your strings first to the
1503	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.
1504		1723
1505	=item $old_events = $term->pty_ev_events ([$new_events])	1724	=item $old_events = $term->pty_ev_events ([$new_events])
1506		1725
1507	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
1508	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
…		…
1527	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
1528	to receive pointer events all the times:	1747	to receive pointer events all the times:
1529		1748
1530	$term->vt_emask_add (urxvt::PointerMotionMask);	1749	$term->vt_emask_add (urxvt::PointerMotionMask);
1531		1750
		1751	=item $term->set_urgency ($set)
		1752
		1753	Enable/disable the urgency hint on the toplevel window.
		1754
1532	=item $term->focus_in	1755	=item $term->focus_in
1533		1756
1534	=item $term->focus_out	1757	=item $term->focus_out
1535		1758
1536	=item $term->key_press ($state, $keycode[, $time])	1759	=item $term->key_press ($state, $keycode[, $time])
1537		1760
1538	=item $term->key_release ($state, $keycode[, $time])	1761	=item $term->key_release ($state, $keycode[, $time])
1539		1762
1540	Deliver various fake events to to terminal.	1763	Deliver various fake events to to terminal.
1541		1764
1542	=item $window_width = $term->width	1765	=item $window_width = $term->width ([$new_value])
1543		1766
1544	=item $window_height = $term->height	1767	=item $window_height = $term->height ([$new_value])
1545		1768
1546	=item $font_width = $term->fwidth	1769	=item $font_width = $term->fwidth ([$new_value])
1547		1770
1548	=item $font_height = $term->fheight	1771	=item $font_height = $term->fheight ([$new_value])
1549		1772
1550	=item $font_ascent = $term->fbase	1773	=item $font_ascent = $term->fbase ([$new_value])
1551		1774
1552	=item $terminal_rows = $term->nrow	1775	=item $terminal_rows = $term->nrow ([$new_value])
1553		1776
1554	=item $terminal_columns = $term->ncol	1777	=item $terminal_columns = $term->ncol ([$new_value])
1555		1778
1556	=item $has_focus = $term->focus	1779	=item $has_focus = $term->focus ([$new_value])
1557		1780
1558	=item $is_mapped = $term->mapped	1781	=item $is_mapped = $term->mapped ([$new_value])
1559		1782
1560	=item $max_scrollback = $term->saveLines	1783	=item $max_scrollback = $term->saveLines ([$new_value])
1561		1784
1562	=item $nrow_plus_saveLines = $term->total_rows	1785	=item $nrow_plus_saveLines = $term->total_rows ([$new_value])
1563		1786
1564	=item $topmost_scrollback_row = $term->top_row	1787	=item $topmost_scrollback_row = $term->top_row ([$new_value])
1565		1788
1566	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.
1567		1791
1568	=item $x_display = $term->display_id	1792	=item $x_display = $term->display_id
1569		1793
1570	Return the DISPLAY used by rxvt-unicode.	1794	Return the DISPLAY used by rxvt-unicode.
1571		1795
…		…
1608		1832
1609	=item $cursor_is_hidden = $term->hidden_cursor	1833	=item $cursor_is_hidden = $term->hidden_cursor
1610		1834
1611	Returns whether the cursor is currently hidden or not.	1835	Returns whether the cursor is currently hidden or not.
1612		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
1613	=item $view_start = $term->view_start ([$newvalue])	1847	=item $view_start = $term->view_start ([$newvalue])
1614		1848
1615	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,
1616	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
1617	this many lines into the scrollback buffer.	1851	the terminal contents. Lower values scroll this many lines into the
		1852	scrollback buffer.
1618		1853
1619	=item $term->want_refresh	1854	=item $term->want_refresh
1620		1855
1621	Requests a screen refresh. At the next opportunity, rxvt-unicode will	1856	Requests a screen refresh. At the next opportunity, rxvt-unicode will
1622	compare the on-screen display with its stored representation. If they	1857	compare the on-screen display with its stored representation. If they
1623	differ, it redraws the differences.	1858	differ, it redraws the differences.
1624		1859
1625	Used after changing terminal contents to display them.	1860	Used after changing terminal contents to display them.
1626		1861
		1862	=item $term->refresh_check
		1863
		1864	Checks if a refresh has been requested and, if so, schedules one.
		1865
1627	=item $text = $term->ROW_t ($row_number[, $new_text[, $start_col]])	1866	=item $text = $term->ROW_t ($row_number[, $new_text[, $start_col]])
1628		1867
1629	Returns the text of the entire row with number C<$row_number>. Row C<0>	1868	Returns the text of the entire row with number C<$row_number>. Row C<< $term->top_row >>
1630	is the topmost terminal line, row C<< $term->$ncol-1 >> is the bottommost	1869	is the topmost terminal line, row C<< $term->nrow-1 >> is the bottommost
1631	terminal line. The scrollback buffer starts at line C<-1> and extends to
1632	line C<< -$term->nsaved >>. Nothing will be returned if a nonexistent line	1870	terminal line. Nothing will be returned if a nonexistent line
1633	is requested.	1871	is requested.
1634		1872
1635	If C<$new_text> is specified, it will replace characters in the current	1873	If C<$new_text> is specified, it will replace characters in the current
1636	line, starting at column C<$start_col> (default C<0>), which is useful	1874	line, starting at column C<$start_col> (default C<0>), which is useful
1637	to replace only parts of a line. The font index in the rendition will	1875	to replace only parts of a line. The font index in the rendition will
1638	automatically be updated.	1876	automatically be updated.
1639		1877
1640	C<$text> is in a special encoding: tabs and wide characters that use more	1878	C<$text> is in a special encoding: tabs and wide characters that use more
1641	than one cell when displayed are padded with C<$urxvt::NOCHAR> (chr 65535)	1879	than one cell when displayed are padded with C<$urxvt::NOCHAR> (chr 65535)
1642	characters. Characters with combining characters and other characters that	1880	characters. Characters with combining characters and other characters that
1643	do not fit into the normal tetx encoding will be replaced with characters	1881	do not fit into the normal text encoding will be replaced with characters
1644	in the private use area.	1882	in the private use area.
1645		1883
1646	You have to obey this encoding when changing text. The advantage is	1884	You have to obey this encoding when changing text. The advantage is
1647	that C<substr> and similar functions work on screen cells and not on	1885	that C<substr> and similar functions work on screen cells and not on
1648	characters.	1886	characters.
…		…
1677		1915
1678	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
1679	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
1680	following methods:	1918	following methods:
1681		1919
1682	=over 4	1920	=over
1683		1921
1684	=item $text = $line->t ([$new_text])	1922	=item $text = $line->t ([$new_text])
1685		1923
1686	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>
1687		1925
…		…
1733	}	1971	}
1734		1972
1735	sub urxvt::line::t {	1973	sub urxvt::line::t {
1736	my ($self) = @_;	1974	my ($self) = @_;
1737		1975
1738	if (@_ > 1)	1976	if (@_ > 1) {
1739	{
1740	$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})
1741	for $self->{beg} .. $self->{end};	1978	for $self->{beg} .. $self->{end};
1742	}	1979	}
1743		1980
1744	defined wantarray &&	1981	defined wantarray &&
1745	substr +(join "", map $self->{term}->ROW_t ($_), $self->{beg} .. $self->{end}),	1982	substr +(join "", map $self->{term}->ROW_t ($_), $self->{beg} .. $self->{end}),
1746	0, $self->{len}	1983	0, $self->{len}
1747	}	1984	}
1748		1985
1749	sub urxvt::line::r {	1986	sub urxvt::line::r {
1750	my ($self) = @_;	1987	my ($self) = @_;
1751		1988
1752	if (@_ > 1)	1989	if (@_ > 1) {
1753	{
1754	$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})
1755	for $self->{beg} .. $self->{end};	1991	for $self->{beg} .. $self->{end};
1756	}	1992	}
1757		1993
1758	if (defined wantarray) {	1994	if (defined wantarray) {
1759	my $rend = [	1995	my $rend = [
1760	map @{ $self->{term}->ROW_r ($_) }, $self->{beg} .. $self->{end}	1996	map @{ $self->{term}->ROW_r ($_) }, $self->{beg} .. $self->{end}
1761	];	1997	];
…		…
1793	where one character corresponds to one screen cell. See	2029	where one character corresponds to one screen cell. See
1794	C<< $term->ROW_t >> for details.	2030	C<< $term->ROW_t >> for details.
1795		2031
1796	=item $string = $term->special_decode $text	2032	=item $string = $term->special_decode $text
1797		2033
1798	Converts rxvt-unicodes text representation into a perl string. See	2034	Converts rxvt-unicode's text representation into a perl string. See
1799	C<< $term->ROW_t >> for details.	2035	C<< $term->ROW_t >> for details.
1800		2036
1801	=item $success = $term->grab_button ($button, $modifiermask[, $window = $term->vt])	2037	=item $success = $term->grab_button ($button, $modifiermask[, $window = $term->vt])
1802		2038
1803	=item $term->ungrab_button ($button, $modifiermask[, $window = $term->vt])	2039	=item $term->ungrab_button ($button, $modifiermask[, $window = $term->vt])
…		…
1823	Calls XAllowEvents with both ReplayPointer and ReplayKeyboard for the most	2059	Calls XAllowEvents with both ReplayPointer and ReplayKeyboard for the most
1824	recent grab.	2060	recent grab.
1825		2061
1826	=item $term->ungrab	2062	=item $term->ungrab
1827		2063
1828	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
1829	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
1830	the session.	2066	the session.
1831		2067
1832	=item $atom = $term->XInternAtom ($atom_name[, $only_if_exists])	2068	=item $atom = $term->XInternAtom ($atom_name[, $only_if_exists])
1833		2069
…		…
1835		2071
1836	=item @atoms = $term->XListProperties ($window)	2072	=item @atoms = $term->XListProperties ($window)
1837		2073
1838	=item ($type,$format,$octets) = $term->XGetWindowProperty ($window, $property)	2074	=item ($type,$format,$octets) = $term->XGetWindowProperty ($window, $property)
1839		2075
1840	=item $term->XChangeWindowProperty ($window, $property, $type, $format, $octets)	2076	=item $term->XChangeProperty ($window, $property, $type, $format, $octets)
1841		2077
1842	=item $term->XDeleteProperty ($window, $property)	2078	=item $term->XDeleteProperty ($window, $property)
1843		2079
1844	=item $window = $term->DefaultRootWindow	2080	=item $window = $term->DefaultRootWindow
1845		2081
…		…
1852	=item $term->XMoveResizeWindow ($window, $x, $y, $width, $height)	2088	=item $term->XMoveResizeWindow ($window, $x, $y, $width, $height)
1853		2089
1854	=item ($x, $y, $child_window) = $term->XTranslateCoordinates ($src, $dst, $x, $y)	2090	=item ($x, $y, $child_window) = $term->XTranslateCoordinates ($src, $dst, $x, $y)
1855		2091
1856	=item $term->XChangeInput ($window, $add_events[, $del_events])	2092	=item $term->XChangeInput ($window, $add_events[, $del_events])
		2093
		2094	=item $keysym = $term->XStringToKeysym ($string)
		2095
		2096	=item $string = $term->XKeysymToString ($keysym)
1857		2097
1858	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
1859	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
1860	directory onto the X functions of the same name.	2100	directly onto the X functions of the same name.
1861		2101
1862	=back	2102	=back
1863		2103
1864	=cut	2104	=cut
1865		2105
1866	package urxvt::popup;	2106	package urxvt::popup;
1867		2107
1868	=head2 The C<urxvt::popup> Class	2108	=head2 The C<urxvt::popup> Class
1869		2109
1870	=over 4	2110	=over
1871		2111
1872	=cut	2112	=cut
1873		2113
1874	sub add_item {	2114	sub add_item {
1875	my ($self, $item) = @_;	2115	my ($self, $item) = @_;
…		…
1967	my $env = $self->{term}->env;	2207	my $env = $self->{term}->env;
1968	# we can't hope to reproduce the locale algorithm, so nuke LC_ALL and set LC_CTYPE.	2208	# we can't hope to reproduce the locale algorithm, so nuke LC_ALL and set LC_CTYPE.
1969	delete $env->{LC_ALL};	2209	delete $env->{LC_ALL};
1970	$env->{LC_CTYPE} = $self->{term}->locale;	2210	$env->{LC_CTYPE} = $self->{term}->locale;
1971		2211
1972	urxvt::term->new ($env, "popup",	2212	my $term = urxvt::term->new (
		2213	$env, "popup",
1973	"--perl-lib" => "", "--perl-ext-common" => "",	2214	"--perl-lib" => "", "--perl-ext-common" => "",
1974	"-pty-fd" => -1, "-sl" => 0,	2215	"-pty-fd" => -1, "-sl" => 0,
1975	"-b" => 1, "-bd" => "grey80", "-bl", "-override-redirect",	2216	"-b" => 1, "-bd" => "grey80", "-bl", "-override-redirect",
1976	"--transient-for" => $self->{term}->parent,	2217	"--transient-for" => $self->{term}->parent,
1977	"-display" => $self->{term}->display_id,	2218	"-display" => $self->{term}->display_id,
1978	"-pe" => "urxvt-popup")	2219	"-pe" => "urxvt-popup",
1979	or die "unable to create popup window\n";	2220	) or die "unable to create popup window\n";
		2221
		2222	unless (delete $term->{urxvt_popup_init_done}) {
		2223	$term->ungrab;
		2224	$term->destroy;
		2225	die "unable to initialise popup window\n";
		2226	}
1980	}	2227	}
1981		2228
1982	sub DESTROY {	2229	sub DESTROY {
1983	my ($self) = @_;	2230	my ($self) = @_;
1984		2231
…		…
2004	->cb (sub {	2251	->cb (sub {
2005	$term->{overlay}->set (0, 0,	2252	$term->{overlay}->set (0, 0,
2006	sprintf "%2d:%02d:%02d", (localtime urxvt::NOW)[2,1,0]);	2253	sprintf "%2d:%02d:%02d", (localtime urxvt::NOW)[2,1,0]);
2007	});	2254	});
2008		2255
2009	=over 4	2256	=over
2010		2257
2011	=item $timer = new urxvt::timer	2258	=item $timer = new urxvt::timer
2012		2259
2013	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
2014	immediately.	2261	immediately.
2015		2262
2016	=item $timer = $timer->cb (sub { my ($timer) = @_; ... })	2263	=item $timer = $timer->cb (sub { my ($timer) = @_; ... })
2017		2264
2018	Set the callback to be called when the timer triggers.	2265	Set the callback to be called when the timer triggers.
2019		2266
2020	=item $tstamp = $timer->at
2021
2022	Return the time this watcher will fire next.
2023
2024	=item $timer = $timer->set ($tstamp)	2267	=item $timer = $timer->set ($tstamp[, $interval])
2025		2268
2026	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).
2027		2271
2028	=item $timer = $timer->interval ($interval)	2272	=item $timer = $timer->interval ($interval)
2029		2273
2030	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
2031	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
2032	is automatically rescheduled at the given intervals.	2276	is automatically rescheduled at the given intervals.
2033		2277
2034	=item $timer = $timer->start	2278	=item $timer = $timer->start
2035		2279
2036	Start the timer.	2280	Start the timer.
2037		2281
2038	=item $timer = $timer->start ($tstamp)	2282	=item $timer = $timer->start ($tstamp[, $interval])
2039		2283
2040	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.
2041		2286
2042	=item $timer = $timer->after ($delay)	2287	=item $timer = $timer->after ($delay[, $interval])
2043		2288
2044	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>.
2045		2290
2046	=item $timer = $timer->stop	2291	=item $timer = $timer->stop
2047		2292
…		…
2055		2300
2056	$term->{socket} = ...	2301	$term->{socket} = ...
2057	$term->{iow} = urxvt::iow	2302	$term->{iow} = urxvt::iow
2058	->new	2303	->new
2059	->fd (fileno $term->{socket})	2304	->fd (fileno $term->{socket})
2060	->events (urxvt::EVENT_READ)	2305	->events (urxvt::EV_READ)
2061	->start	2306	->start
2062	->cb (sub {	2307	->cb (sub {
2063	my ($iow, $revents) = @_;	2308	my ($iow, $revents) = @_;
2064	# $revents must be 1 here, no need to check	2309	# $revents must be 1 here, no need to check
2065	sysread $term->{socket}, my $buf, 8192	2310	sysread $term->{socket}, my $buf, 8192
2066	or end-of-file;	2311	or end-of-file;
2067	});	2312	});
2068		2313
2069		2314
2070	=over 4	2315	=over
2071		2316
2072	=item $iow = new urxvt::iow	2317	=item $iow = new urxvt::iow
2073		2318
2074	Create a new io watcher object in stopped state.	2319	Create a new io watcher object in stopped state.
2075		2320
…		…
2083	Set the file descriptor (not handle) to watch.	2328	Set the file descriptor (not handle) to watch.
2084		2329
2085	=item $iow = $iow->events ($eventmask)	2330	=item $iow = $iow->events ($eventmask)
2086		2331
2087	Set the event mask to watch. The only allowed values are	2332	Set the event mask to watch. The only allowed values are
2088	C<urxvt::EVENT_READ> and C<urxvt::EVENT_WRITE>, which might be ORed	2333	C<urxvt::EV_READ> and C<urxvt::EV_WRITE>, which might be ORed
2089	together, or C<urxvt::EVENT_NONE>.	2334	together, or C<urxvt::EV_NONE>.
2090		2335
2091	=item $iow = $iow->start	2336	=item $iow = $iow->start
2092		2337
2093	Start watching for requested events on the given handle.	2338	Start watching for requested events on the given handle.
2094		2339
…		…
2102		2347
2103	This class implements idle watchers, that get called automatically when	2348	This class implements idle watchers, that get called automatically when
2104	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
2105	some useful work.	2350	some useful work.
2106		2351
2107	=over 4	2352	=over
2108		2353
2109	=item $iw = new urxvt::iw	2354	=item $iw = new urxvt::iw
2110		2355
2111	Create a new idle watcher object in stopped state.	2356	Create a new idle watcher object in stopped state.
2112		2357
…		…
2137	->cb (sub {	2382	->cb (sub {
2138	my ($pw, $exit_status) = @_;	2383	my ($pw, $exit_status) = @_;
2139	...	2384	...
2140	});	2385	});
2141		2386
2142	=over 4	2387	=over
2143		2388
2144	=item $pw = new urxvt::pw	2389	=item $pw = new urxvt::pw
2145		2390
2146	Create a new process watcher in stopped state.	2391	Create a new process watcher in stopped state.
2147		2392
…		…
2164	=head2 URXVT_PERL_VERBOSITY	2409	=head2 URXVT_PERL_VERBOSITY
2165		2410
2166	This variable controls the verbosity level of the perl extension. Higher	2411	This variable controls the verbosity level of the perl extension. Higher
2167	numbers indicate more verbose output.	2412	numbers indicate more verbose output.
2168		2413
2169	=over 4	2414	=over
2170		2415
2171	=item == 0 - fatal messages	2416	=item == 0 - fatal messages only
		2417
		2418	=item >= 2 - general warnings (default level)
2172		2419
2173	=item >= 3 - script loading and management	2420	=item >= 3 - script loading and management
2174		2421
2175	=item >=10 - all called hooks	2422	=item >=10 - all called hooks
2176		2423
…		…
2178		2425
2179	=back	2426	=back
2180		2427
2181	=head1 AUTHOR	2428	=head1 AUTHOR
2182		2429
2183	Marc Lehmann <pcg@goof.com>	2430	Marc Lehmann <schmorp@schmorp.de>
2184	http://software.schmorp.de/pkg/rxvt-unicode	2431	http://software.schmorp.de/pkg/rxvt-unicode
2185		2432
2186	=cut	2433	=cut
2187		2434
2188	1	2435	1

Diff Legend

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