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.154 by root, Sat Jun 2 06:43:02 2007 UTC vs.
Revision 1.272 by root, Thu Dec 29 01:10:08 2022 UTC

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

Diff Legend

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