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.264 by root, Sat Jul 24 09:42:15 2021 UTC

1	=encoding utf8	1	=encoding utf8
2		2
3	=head1 NAME	3	=head1 NAME
4		4
5	@@RXVT_NAME@@perl - rxvt-unicode's embedded perl interpreter	5	urxvtperl - rxvt-unicode's embedded perl interpreter
6		6
7	=head1 SYNOPSIS	7	=head1 SYNOPSIS
8		8
9	# create a file grab_test in $HOME:	9	# create a file grab_test in some directory:
10		10
11	sub on_sel_grab {	11	sub on_sel_grab {
12	warn "you selected ", $_[0]->selection;	12	warn "you selected ", $_[0]->selection;
13	()	13	()
14	}	14	}
15		15
16	# start a @@RXVT_NAME@@ using it:	16	# start a urxvt instance using it:
17		17
18	@@RXVT_NAME@@ --perl-lib $HOME -pe grab_test	18	urxvt --perl-lib path/to/somedirectory -pe grab_test
19		19
20	=head1 DESCRIPTION	20	=head1 DESCRIPTION
21		21
22	Every time a terminal object gets created, extension scripts specified via	22	Every time a terminal object gets created, extension scripts specified via
23	the C<perl> resource are loaded and associated with it.	23	the C<perl> resource are loaded and associated with it.
24		24
25	Scripts are compiled in a 'use strict' and 'use utf8' environment, and	25	Scripts are compiled in a 'use strict "vars"' and 'use utf8' environment, and
26	thus must be encoded as UTF-8.	26	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
…		…
407		74
408	=over 4	75	=over 4
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.
		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 only one such comment:
442		125
443	=over 4	126	=over 4
444		127
445	=item $urxvt_term = $self->{term}	128	=item #:META:RESOURCE:name:type:desc
446		129
447	Returns the C<urxvt::term> object associated with this instance of the	130	The RESOURCE comment defines a resource used by the extension, where
448	extension. This member I<must not> be changed in any way.	131	C<name> is the resource name, C<type> is the resource type, C<boolean>
		132	or C<string>, and C<desc> is the resource description.
449		133
450	=item $self->enable ($hook_name => $cb, [$hook_name => $cb..])	134	The extension will be autoloaded when this resource is specified or used
451		135	as a command line parameter.
452	Dynamically enable the given hooks (named without the C<on_> prefix) for
453	this extension, replacing any previous hook. This is useful when you want
454	to overwrite time-critical hooks only temporarily.
455
456	=item $self->disable ($hook_name[, $hook_name..])
457
458	Dynamically disable the given hooks.
459		136
460	=back	137	=back
461		138
462	=head2 Hooks	139	=head2 Hooks
463		140
…		…
551		228
552	It is called before lines are scrolled out (so rows 0 .. min ($lines - 1,	229	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	230	$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.	231	number of lines that will be in the scrollback buffer.
555		232
556	=item on_osc_seq $term, $op, $args	233	=item on_osc_seq $term, $op, $args, $resp
557		234
558	Called on every OSC sequence and can be used to suppress it or modify its	235	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	236	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	237	suppresses execution of the request completely. Make sure you don't get
561	confused by recursive invocations when you output an osc sequence within	238	confused by recursive invocations when you output an OSC sequence within
562	this callback.	239	this callback.
563		240
564	C<on_osc_seq_perl> should be used for new behaviour.	241	C<on_osc_seq_perl> should be used for new behaviour.
565		242
566	=item on_osc_seq_perl $term, $string	243	=item on_osc_seq_perl $term, $args, $resp
567		244
568	Called whenever the B<ESC ] 777 ; string ST> command sequence (OSC =	245	Called whenever the B<ESC ] 777 ; string ST> command sequence (OSC =
569	operating system command) is processed. Cursor position and other state	246	operating system command) is processed. Cursor position and other state
570	information is up-to-date when this happens. For interoperability, the	247	information is up-to-date when this happens. For interoperability, the
571	string should start with the extension name and a colon, to distinguish	248	string should start with the extension name (sans -osc) and a semicolon,
572	it from commands for other extensions, and this might be enforced in the	249	to distinguish it from commands for other extensions, and this might be
573	future.	250	enforced in the future.
		251
		252	For example, C<overlay-osc> uses this:
		253
		254	sub on_osc_seq_perl {
		255	my ($self, $osc, $resp) = @_;
		256
		257	return unless $osc =~ s/^overlay;//;
		258
		259	... process remaining $osc string
		260	}
574		261
575	Be careful not ever to trust (in a security sense) the data you receive,	262	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	263	as its source can not easily be controlled (e-mail content, messages from
577	other users on the same system etc.).	264	other users on the same system etc.).
		265
		266	For responses, C<$resp> contains the end-of-args separator used by the
		267	sender.
578		268
579	=item on_add_lines $term, $string	269	=item on_add_lines $term, $string
580		270
581	Called whenever text is about to be output, with the text as argument. You	271	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	272	can filter/change and output the text yourself by returning a true value
…		…
587	=item on_tt_write $term, $octets	277	=item on_tt_write $term, $octets
588		278
589	Called whenever some data is written to the tty/pty and can be used to	279	Called whenever some data is written to the tty/pty and can be used to
590	suppress or filter tty input.	280	suppress or filter tty input.
591		281
		282	=item on_tt_paste $term, $octets
		283
		284	Called whenever text is about to be pasted, with the text as argument. You
		285	can filter/change and paste the text yourself by returning a true value
		286	and calling C<< $term->tt_paste >> yourself. C<$octets> is
		287	locale-encoded.
		288
592	=item on_line_update $term, $row	289	=item on_line_update $term, $row
593		290
594	Called whenever a line was updated or changed. Can be used to filter	291	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	292	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,	293	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	300	later with the already-modified line (e.g. if unrelated parts change), so
604	you cannot just toggle rendition bits, but only set them.	301	you cannot just toggle rendition bits, but only set them.
605		302
606	=item on_refresh_begin $term	303	=item on_refresh_begin $term
607		304
608	Called just before the screen gets redrawn. Can be used for overlay	305	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	306	similar effects by modifying the terminal contents in refresh_begin, and
610	restoring them in refresh_end. The built-in overlay and selection display	307	restoring them in refresh_end. The built-in overlay and selection display
611	code is run after this hook, and takes precedence.	308	code is run after this hook, and takes precedence.
612		309
613	=item on_refresh_end $term	310	=item on_refresh_end $term
614		311
615	Called just after the screen gets redrawn. See C<on_refresh_begin>.	312	Called just after the screen gets redrawn. See C<on_refresh_begin>.
616		313
		314	=item on_action $term, $string
		315
		316	Called whenever an action is invoked for the corresponding extension
		317	(e.g. via a C<extension:string> builtin action bound to a key, see
		318	description of the B<keysym> resource in the urxvt(1) manpage). The
		319	event is simply the action string. Note that an action event is always
		320	associated to a single extension.
		321
617	=item on_user_command $term, $string	322	=item on_user_command $term, $string *DEPRECATED*
618		323
619	Called whenever a user-configured event is being activated (e.g. via	324	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>	325	a C<perl:string> action bound to a key, see description of the B<keysym>
621	resource in the @@RXVT_NAME@@(1) manpage).	326	resource in the urxvt(1) manpage).
622		327
623	The event is simply the action string. This interface is assumed to change	328	The event is simply the action string. This interface is going away in
624	slightly in the future.	329	preference to the C<on_action> hook.
625		330
626	=item on_resize_all_windows $tern, $new_width, $new_height	331	=item on_resize_all_windows $term, $new_width, $new_height
627		332
628	Called just after the new window size has been calculated, but before	333	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	334	windows are actually being resized or hints are being set. If this hook
630	returns TRUE, setting of the window hints is being skipped.	335	returns a true value, setting of the window hints is being skipped.
631		336
632	=item on_x_event $term, $event	337	=item on_x_event $term, $event
633		338
634	Called on every X event received on the vt window (and possibly other	339	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	340	windows). Should only be used as a last resort. Most event structure
…		…
665		370
666	=item on_map_notify $term, $event	371	=item on_map_notify $term, $event
667		372
668	=item on_unmap_notify $term, $event	373	=item on_unmap_notify $term, $event
669		374
670	Called whenever the corresponding X event is received for the terminal If	375	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.	376	the hook returns true, then the event will be ignored by rxvt-unicode.
672		377
673	The event is a hash with most values as named by Xlib (see the XEvent	378	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	379	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.	380	(real, not screen-based) row and column under the mouse cursor.
676		381
677	C<on_key_press> additionally receives the string rxvt-unicode would	382	C<on_key_press> additionally receives the string rxvt-unicode would
678	output, if any, in locale-specific encoding.	383	output, if any, in locale-specific encoding.
679		384
680	subwindow.
681
682	=item on_client_message $term, $event	385	=item on_client_message $term, $event
683		386
684	=item on_wm_protocols $term, $event	387	=item on_wm_protocols $term, $event
685		388
686	=item on_wm_delete_window $term, $event	389	=item on_wm_delete_window $term, $event
687		390
688	Called when various types of ClientMessage events are received (all with	391	Called when various types of ClientMessage events are received (all with
689	format=32, WM_PROTOCOLS or WM_PROTOCOLS:WM_DELETE_WINDOW).	392	format=32, WM_PROTOCOLS or WM_PROTOCOLS:WM_DELETE_WINDOW).
690		393
		394	=item on_bell $term
		395
		396	Called on receipt of a bell character.
		397
691	=back	398	=back
692		399
693	=cut	400	=cut
694		401
695	package urxvt;	402	package urxvt;
696		403
697	use utf8;	404	use utf8;
698	use strict;	405	use strict 'vars';
699	use Carp ();	406	use Carp ();
700	use Scalar::Util ();	407	use Scalar::Util ();
701	use List::Util ();	408	use List::Util ();
702		409
703	our $VERSION = 1;	410	our $VERSION = 1;
704	our $TERM;	411	our $TERM;
705	our @TERM_INIT;	412	our @TERM_INIT; # should go, prevents async I/O etc.
706	our @TERM_EXT;	413	our @TERM_EXT; # should go, prevents async I/O etc.
707	our @HOOKNAME;	414	our @HOOKNAME;
708	our %HOOKTYPE = map +($HOOKNAME[$_] => $_), 0..$#HOOKNAME;	415	our %HOOKTYPE = map +($HOOKNAME[$_] => $_), 0..$#HOOKNAME;
709	our %OPTION;	416	our %OPTION;
710		417
711	our $LIBDIR;	418	our $LIBDIR;
…		…
759		466
760	=over 4	467	=over 4
761		468
762	=item urxvt::fatal $errormessage	469	=item urxvt::fatal $errormessage
763		470
764	Fatally aborts execution with the given error message. Avoid at all	471	Fatally aborts execution with the given error message (which should
765	costs! The only time this is acceptable is when the terminal process	472	include a trailing newline). Avoid at all costs! The only time this
766	starts up.	473	is acceptable (and useful) is in the init hook, where it prevents the
		474	terminal from starting up.
767		475
768	=item urxvt::warn $string	476	=item urxvt::warn $string
769		477
770	Calls C<rxvt_warn> with the given string which should not include a	478	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	479	newline. The module also overwrites the C<warn> builtin with a function
772	that calls this function.	480	that calls this function.
773		481
774	Using this function has the advantage that its output ends up in the	482	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.	483	correct place, e.g. on stderr of the connecting urxvtc client.
…		…
779	=item @terms = urxvt::termlist	487	=item @terms = urxvt::termlist
780		488
781	Returns all urxvt::term objects that exist in this process, regardless of	489	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	490	whether they are started, being destroyed etc., so be careful. Only term
783	objects that have perl extensions attached will be returned (because there	491	objects that have perl extensions attached will be returned (because there
784	is no urxvt::term objet associated with others).	492	is no urxvt::term object associated with others).
785		493
786	=item $time = urxvt::NOW	494	=item $time = urxvt::NOW
787		495
788	Returns the "current time" (as per the event loop).	496	Returns the "current time" (as per the event loop).
789		497
…		…
809	CirculateRequest, PropertyNotify, SelectionClear, SelectionRequest,	517	CirculateRequest, PropertyNotify, SelectionClear, SelectionRequest,
810	SelectionNotify, ColormapNotify, ClientMessage, MappingNotify	518	SelectionNotify, ColormapNotify, ClientMessage, MappingNotify
811		519
812	Various constants for use in X calls and event processing.	520	Various constants for use in X calls and event processing.
813		521
		522	=item urxvt::PrivMode_132, PrivMode_132OK, PrivMode_rVideo, PrivMode_relOrigin,
		523	PrivMode_Screen, PrivMode_Autowrap, PrivMode_aplCUR, PrivMode_aplKP,
		524	PrivMode_HaveBackSpace, PrivMode_BackSpace, PrivMode_ShiftKeys,
		525	PrivMode_VisibleCursor, PrivMode_MouseX10, PrivMode_MouseX11,
		526	PrivMode_scrollBar, PrivMode_TtyOutputInh, PrivMode_Keypress,
		527	PrivMode_smoothScroll, PrivMode_vt52, PrivMode_LFNL, PrivMode_MouseBtnEvent,
		528	PrivMode_MouseAnyEvent, PrivMode_BracketPaste, PrivMode_ExtMouseUTF8,
		529	PrivMode_ExtMouseUrxvt, PrivMode_BlinkingCursor, PrivMode_mouse_report,
		530	PrivMode_Default
		531
		532	Constants for checking DEC private modes.
		533
814	=back	534	=back
815		535
816	=head2 RENDITION	536	=head2 RENDITION
817		537
818	Rendition bitsets contain information about colour, font, font styles and	538	Rendition bitsets contain information about colour, font, font styles and
…		…
832		552
833	=item $rend = urxvt::OVERLAY_RSTYLE	553	=item $rend = urxvt::OVERLAY_RSTYLE
834		554
835	Return the rendition mask used for overlays by default.	555	Return the rendition mask used for overlays by default.
836		556
837	=item $rendbit = urxvt::RS_Bold, RS_Italic, RS_Blink, RS_RVid, RS_Uline	557	=item $rendbit = urxvt::RS_Bold, urxvt::RS_Italic, urxvt::RS_Blink,
		558	urxvt::RS_RVid, urxvt::RS_Uline
838		559
839	Return the bit that enabled bold, italic, blink, reverse-video and	560	Return the bit that enabled bold, italic, blink, reverse-video and
840	underline, respectively. To enable such a style, just logically OR it into	561	underline, respectively. To enable such a style, just logically OR it into
841	the bitset.	562	the bitset.
842		563
…		…
879	};	600	};
880	}	601	}
881		602
882	no warnings 'utf8';	603	no warnings 'utf8';
883		604
		605	sub parse_resource {
		606	my ($term, $name, $isarg, $longopt, $flag, $value) = @_;
		607
		608	$term->scan_extensions;
		609
		610	# iterating over all resources has quadratic time overhead
		611	# overall, maybe this could be optimised?
		612	my $r = $term->{meta}{resource};
		613	keys %$r; # reset iterator
		614	while (my ($k, $v) = each %$r) {
		615	my $pattern = $k;
		616	$pattern =~ y/./-/ if $isarg;
		617	my $prefix = $name;
		618	my $suffix;
		619	if ($pattern =~ /\-$/) {
		620	$prefix = substr $name, 0, length $pattern;
		621	$suffix = substr $name, length $pattern;
		622	}
		623	if ($pattern eq $prefix) {
		624	$name = "$urxvt::RESCLASS.$k$suffix";
		625
		626	push @{ $term->{perl_ext_3} }, $v->[0];
		627
		628	return 1 unless $isarg;
		629
		630	if ($v->[1] eq "boolean") {
		631	$term->put_option_db ($name, $flag ? "true" : "false");
		632	return 1;
		633	} else {
		634	$term->put_option_db ($name, $value);
		635	return 1 + 2;
		636	}
		637	}
		638	}
		639
		640	0
		641	}
		642
		643	sub usage {
		644	my ($term, $usage_type) = @_;
		645
		646	$term->scan_extensions;
		647
		648	my $r = $term->{meta}{resource};
		649
		650	for my $pattern (sort keys %$r) {
		651	my ($ext, $type, $desc) = @{ $r->{$pattern} };
		652
		653	$desc .= " (-pe $ext)";
		654
		655	if ($usage_type == 1) {
		656	$pattern =~ y/./-/;
		657	$pattern =~ s/-$/-.../g;
		658
		659	if ($type eq "boolean") {
		660	urxvt::log sprintf " -%-30s %s\n", "/+$pattern", $desc;
		661	} else {
		662	urxvt::log sprintf " -%-30s %s\n", "$pattern $type", $desc;
		663	}
		664	} else {
		665	$pattern =~ s/\.$/.*/g;
		666	urxvt::log sprintf " %-31s %s\n", "$pattern:", $type;
		667	}
		668	}
		669	}
		670
884	my $verbosity = $ENV{URXVT_PERL_VERBOSITY};	671	my $verbosity = $ENV{URXVT_PERL_VERBOSITY};
885		672
886	sub verbose {	673	sub verbose {
887	my ($level, $msg) = @_;	674	my ($level, $msg) = @_;
888	warn "$msg\n" if $level <= $verbosity;	675	warn "$msg\n" if $level <= $verbosity;
…		…
900	$pkg =~ s/[^[:word:]]/_/g;	687	$pkg =~ s/[^[:word:]]/_/g;
901	$pkg = "urxvt::ext::$pkg";	688	$pkg = "urxvt::ext::$pkg";
902		689
903	verbose 3, "loading extension '$path' into package '$pkg'";	690	verbose 3, "loading extension '$path' into package '$pkg'";
904		691
		692	(${"$pkg\::_NAME"} = $path) =~ s/^.*[\\\/]//; # hackish
		693
905	open my $fh, "<:raw", $path	694	open my $fh, "<:raw", $path
906	or die "$path: $!";	695	or die "$path: $!";
907		696
908	my $source =	697	my $source =
909	"package $pkg; use strict; use utf8; no warnings 'utf8';\n"	698	"package $pkg; use strict 'vars'; use utf8; no warnings 'utf8';\n"
910	. "#line 1 \"$path\"\n{\n"	699	. "#line 1 \"$path\"\n{\n"
911	. (do { local $/; <$fh> })	700	. (do { local $/; <$fh> })
912	. "\n};\n1";	701	. "\n};\n1";
913		702
914	eval $source	703	eval $source
…		…
923	# called by the rxvt core	712	# called by the rxvt core
924	sub invoke {	713	sub invoke {
925	local $TERM = shift;	714	local $TERM = shift;
926	my $htype = shift;	715	my $htype = shift;
927		716
928	if ($htype == 0) { # INIT	717	if ($htype == HOOK_INIT) {
929	my @dirs = ((split /:/, $TERM->resource ("perl_lib")), "$LIBDIR/perl");	718	my @dirs = $TERM->perl_libdirs;
930		719
		720	$TERM->scan_extensions;
		721
931	my %ext_arg;	722	my %ext_arg;
932		723
933	{	724	{
934	my @init = @TERM_INIT;	725	my @init = @TERM_INIT;
935	@TERM_INIT = ();	726	@TERM_INIT = ();
…		…
937	my @pkg = @TERM_EXT;	728	my @pkg = @TERM_EXT;
938	@TERM_EXT = ();	729	@TERM_EXT = ();
939	$TERM->register_package ($_) for @pkg;	730	$TERM->register_package ($_) for @pkg;
940	}	731	}
941		732
		733	for (
		734	@{ delete $TERM->{perl_ext_3} },
942	for (grep $_, map { split /,/, $TERM->resource ("perl_ext_$_") } 1, 2) {	735	(grep $_, map { split /,/, $TERM->resource ("perl_ext_$_") } 1, 2),
		736	) {
943	if ($_ eq "default") {	737	if ($_ eq "default") {
		738
		739	$ext_arg{$_} = []
944	$ext_arg{$_} ||= [] for qw(selection option-popup selection-popup searchable-scrollback readline);	740	for qw(selection option-popup selection-popup readline searchable-scrollback confirm-paste);
		741
		742	for ($TERM->_keysym_resources) {
		743	next if /^(?:string|command|builtin|builtin-string|perl)/;
		744	next unless /^([A-Za-z0-9_\-]+):/;
		745
		746	my $ext = $1;
		747
		748	$ext_arg{$ext} = [];
		749	}
		750
945	} elsif (/^-(.*)$/) {	751	} elsif (/^-(.*)$/) {
946	delete $ext_arg{$1};	752	delete $ext_arg{$1};
		753
947	} elsif (/^([^<]+)<(.*)>$/) {	754	} elsif (/^([^<]+)<(.*)>$/) {
948	push @{ $ext_arg{$1} }, $2;	755	push @{ $ext_arg{$1} }, $2;
		756
949	} else {	757	} else {
950	$ext_arg{$_} ||= [];	758	$ext_arg{$_} ||= [];
951	}	759	}
952	}	760	}
953		761
…		…
969		777
970	if (my $cb = $TERM->{_hook}[$htype]) {	778	if (my $cb = $TERM->{_hook}[$htype]) {
971	verbose 10, "$HOOKNAME[$htype] (" . (join ", ", $TERM, @_) . ")"	779	verbose 10, "$HOOKNAME[$htype] (" . (join ", ", $TERM, @_) . ")"
972	if $verbosity >= 10;	780	if $verbosity >= 10;
973		781
		782	if ($htype == HOOK_ACTION) {
		783	# this hook is only sent to the extension with the name
		784	# matching the first arg
		785	my $pkg = shift;
		786	$pkg =~ y/-/_/;
		787	$pkg = "urxvt::ext::$pkg";
		788
		789	$cb = $cb->{$pkg}
		790	or return undef; #TODO: maybe warn user?
		791
		792	$cb = { $pkg => $cb };
		793	}
		794
974	for my $pkg (keys %$cb) {	795	for my $pkg (keys %$cb) {
975	my $retval_ = eval { $cb->{$pkg}->($TERM->{_pkg}{$pkg}, @_) };	796	my $retval_ = eval { $cb->{$pkg}->($TERM->{_pkg}{$pkg} || $TERM, @_) };
976	$retval ||= $retval_;	797	$retval ||= $retval_;
977		798
978	if ($@) {	799	if ($@) {
979	$TERM->ungrab; # better to lose the grab than the session	800	$TERM->ungrab; # better to lose the grab than the session
980	warn $@;	801	warn $@;
…		…
983		804
984	verbose 11, "$HOOKNAME[$htype] returning <$retval>"	805	verbose 11, "$HOOKNAME[$htype] returning <$retval>"
985	if $verbosity >= 11;	806	if $verbosity >= 11;
986	}	807	}
987		808
988	if ($htype == 1) { # DESTROY	809	if ($htype == HOOK_DESTROY) {
989	# clear package objects	810	# clear package objects
990	%$_ = () for values %{ $TERM->{_pkg} };	811	%$_ = () for values %{ $TERM->{_pkg} };
991		812
992	# clear package	813	# clear package
993	%$TERM = ();	814	%$TERM = ();
…		…
1023	}	844	}
1024	}	845	}
1025	($mask, @color{qw(fg bg)}, \@failed)	846	($mask, @color{qw(fg bg)}, \@failed)
1026	}	847	}
1027		848
1028	# urxvt::term::extension
1029
1030	package urxvt::term::extension;	849	package urxvt::term::extension;
1031		850
1032	sub enable {	851	=head2 The C<urxvt::term::extension> class
1033	my ($self, %hook) = @_;
1034	my $pkg = $self->{_pkg};
1035		852
1036	while (my ($name, $cb) = each %hook) {	853	Each extension attached to a terminal object is represented by
1037	my $htype = $HOOKTYPE{uc $name};	854	a C<urxvt::term::extension> object.
1038	defined $htype
1039	or Carp::croak "unsupported hook type '$name'";
1040		855
1041	$self->set_should_invoke ($htype, +1)	856	You can use these objects, which are passed to all callbacks to store any
1042	unless exists $self->{term}{_hook}[$htype]{$pkg};	857	state related to the terminal and extension instance.
1043		858
1044	$self->{term}{_hook}[$htype]{$pkg} = $cb;	859	The methods (And data members) documented below can be called on extension
1045	}	860	objects, in addition to call methods documented for the <urxvt::term>
1046	}	861	class.
1047		862
1048	sub disable {	863	=over 4
1049	my ($self, @hook) = @_;
1050	my $pkg = $self->{_pkg};
1051		864
1052	for my $name (@hook) {	865	=item $urxvt_term = $self->{term}
1053	my $htype = $HOOKTYPE{uc $name};
1054	defined $htype
1055	or Carp::croak "unsupported hook type '$name'";
1056		866
1057	$self->set_should_invoke ($htype, -1)	867	Returns the C<urxvt::term> object associated with this instance of the
1058	if delete $self->{term}{_hook}[$htype]{$pkg};	868	extension. This member I<must not> be changed in any way.
1059	}	869
1060	}	870	=cut
1061		871
1062	our $AUTOLOAD;	872	our $AUTOLOAD;
1063		873
1064	sub AUTOLOAD {	874	sub AUTOLOAD {
1065	$AUTOLOAD =~ /:([^:]+)$/	875	$AUTOLOAD =~ /:([^:]+)$/
…		…
1078		888
1079	sub DESTROY {	889	sub DESTROY {
1080	# nop	890	# nop
1081	}	891	}
1082		892
1083	# urxvt::destroy_hook	893	# urxvt::destroy_hook (basically a cheap Guard:: implementation)
1084		894
1085	sub urxvt::destroy_hook::DESTROY {	895	sub urxvt::destroy_hook::DESTROY {
1086	${$_[0]}->();	896	${$_[0]}->();
1087	}	897	}
1088		898
1089	sub urxvt::destroy_hook(&) {	899	sub urxvt::destroy_hook(&) {
1090	bless \shift, urxvt::destroy_hook::	900	bless \shift, urxvt::destroy_hook::
1091	}	901	}
		902
		903	=item $self->enable ($hook_name => $cb[, $hook_name => $cb..])
		904
		905	Dynamically enable the given hooks (named without the C<on_> prefix) for
		906	this extension, replacing any hook previously installed via C<enable> in
		907	this extension.
		908
		909	This is useful when you want to overwrite time-critical hooks only
		910	temporarily.
		911
		912	To install additional callbacks for the same hook, you can use the C<on>
		913	method of the C<urxvt::term> class.
		914
		915	=item $self->disable ($hook_name[, $hook_name..])
		916
		917	Dynamically disable the given hooks.
		918
		919	=cut
		920
		921	sub enable {
		922	my ($self, %hook) = @_;
		923	my $pkg = $self->{_pkg};
		924
		925	while (my ($name, $cb) = each %hook) {
		926	my $htype = $HOOKTYPE{uc $name};
		927	defined $htype
		928	or Carp::croak "unsupported hook type '$name'";
		929
		930	$self->set_should_invoke ($htype, +1)
		931	unless exists $self->{term}{_hook}[$htype]{$pkg};
		932
		933	$self->{term}{_hook}[$htype]{$pkg} = $cb;
		934	}
		935	}
		936
		937	sub disable {
		938	my ($self, @hook) = @_;
		939	my $pkg = $self->{_pkg};
		940
		941	for my $name (@hook) {
		942	my $htype = $HOOKTYPE{uc $name};
		943	defined $htype
		944	or Carp::croak "unsupported hook type '$name'";
		945
		946	$self->set_should_invoke ($htype, -1)
		947	if delete $self->{term}{_hook}[$htype]{$pkg};
		948	}
		949	}
		950
		951	=item $guard = $self->on ($hook_name => $cb[, $hook_name => $cb..])
		952
		953	Similar to the C<enable> enable, but installs additional callbacks for
		954	the given hook(s) (that is, it doesn't replace existing callbacks), and
		955	returns a guard object. When the guard object is destroyed the callbacks
		956	are disabled again.
		957
		958	=cut
		959
		960	sub urxvt::extension::on_disable::DESTROY {
		961	my $disable = shift;
		962
		963	my $term = delete $disable->{""};
		964
		965	while (my ($htype, $id) = each %$disable) {
		966	delete $term->{_hook}[$htype]{$id};
		967	$term->set_should_invoke ($htype, -1);
		968	}
		969	}
		970
		971	sub on {
		972	my ($self, %hook) = @_;
		973
		974	my $term = $self->{term};
		975
		976	my %disable = ( "" => $term );
		977
		978	while (my ($name, $cb) = each %hook) {
		979	my $htype = $HOOKTYPE{uc $name};
		980	defined $htype
		981	or Carp::croak "unsupported hook type '$name'";
		982
		983	$term->set_should_invoke ($htype, +1);
		984	$term->{_hook}[$htype]{ $disable{$htype} = $cb+0 }
		985	= sub { shift; $cb->($self, @_) }; # very ugly indeed
		986	}
		987
		988	bless \%disable, "urxvt::extension::on_disable"
		989	}
		990
		991	=item $self->bind_action ($hotkey, $action)
		992
		993	=item $self->x_resource ($pattern)
		994
		995	=item $self->x_resource_boolean ($pattern)
		996
		997	These methods support an additional C<%> prefix for C<$action> or
		998	C<$pattern> when called on an extension object, compared to the
		999	C<urxvt::term> methods of the same name - see the description of these
		1000	methods in the C<urxvt::term> class for details.
		1001
		1002	=cut
		1003
		1004	sub bind_action {
		1005	my ($self, $hotkey, $action) = @_;
		1006	$action =~ s/^%:/$_[0]{_name}:/;
		1007	$self->{term}->bind_action ($hotkey, $action)
		1008	}
		1009
		1010	sub x_resource {
		1011	my ($self, $name) = @_;
		1012	$name =~ s/^%(\.|$)/$_[0]{_name}$1/;
		1013	$self->{term}->x_resource ($name)
		1014	}
		1015
		1016	sub x_resource_boolean {
		1017	my ($self, $name) = @_;
		1018	$name =~ s/^%(\.|$)/$_[0]{_name}$1/;
		1019	$self->{term}->x_resource_boolean ($name)
		1020	}
		1021
		1022	=back
		1023
		1024	=cut
1092		1025
1093	package urxvt::anyevent;	1026	package urxvt::anyevent;
1094		1027
1095	=head2 The C<urxvt::anyevent> Class	1028	=head2 The C<urxvt::anyevent> Class
1096		1029
1097	The sole purpose of this class is to deliver an interface to the	1030	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	1031	C<AnyEvent> module - any module using it will work inside urxvt without
1099	further programming. The only exception is that you cannot wait on	1032	further programming. The only exception is that you cannot wait on
1100	condition variables, but non-blocking condvar use is ok. What this means	1033	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		1034
1104	=cut	1035	In practical terms this means is that you cannot use blocking APIs, but
		1036	the non-blocking variant should work.
1105		1037
		1038	=cut
		1039
1106	our $VERSION = 1;	1040	our $VERSION = '5.23';
1107		1041
1108	$INC{"urxvt/anyevent.pm"} = 1; # mark us as there	1042	$INC{"urxvt/anyevent.pm"} = 1; # mark us as there
1109	push @AnyEvent::REGISTRY, [urxvt => urxvt::anyevent::];	1043	push @AnyEvent::REGISTRY, [urxvt => urxvt::anyevent::];
1110		1044
1111	sub timer {	1045	sub timer {
…		…
1113		1047
1114	my $cb = $arg{cb};	1048	my $cb = $arg{cb};
1115		1049
1116	urxvt::timer	1050	urxvt::timer
1117	->new	1051	->new
1118	->start (urxvt::NOW + $arg{after})	1052	->after ($arg{after}, $arg{interval})
1119	->cb (sub {	1053	->cb ($arg{interval} ? $cb : sub {
1120	$_[0]->stop; # need to cancel manually	1054	$_[0]->stop; # need to cancel manually
1121	$cb->();	1055	$cb->();
1122	})	1056	})
1123	}	1057	}
1124		1058
1125	sub io {	1059	sub io {
1126	my ($class, %arg) = @_;	1060	my ($class, %arg) = @_;
1127		1061
1128	my $cb = $arg{cb};	1062	my $cb = $arg{cb};
		1063	my $fd = fileno $arg{fh};
		1064	defined $fd or $fd = $arg{fh};
1129		1065
1130	bless [$arg{fh}, urxvt::iow	1066	bless [$arg{fh}, urxvt::iow
1131	->new	1067	->new
1132	->fd (fileno $arg{fh})	1068	->fd ($fd)
1133	->events (($arg{poll} =~ /r/ ? 1 : 0)	1069	->events (($arg{poll} =~ /r/ ? 1 : 0)
1134	| ($arg{poll} =~ /w/ ? 2 : 0))	1070	| ($arg{poll} =~ /w/ ? 2 : 0))
1135	->start	1071	->start
1136	->cb (sub {	1072	->cb ($cb)
1137	$cb->(($_[1] & 1 ? 'r' : '')
1138	. ($_[1] & 2 ? 'w' : ''));
1139	})],
1140	urxvt::anyevent::	1073	], urxvt::anyevent::
		1074	}
		1075
		1076	sub idle {
		1077	my ($class, %arg) = @_;
		1078
		1079	my $cb = $arg{cb};
		1080
		1081	urxvt::iw
		1082	->new
		1083	->start
		1084	->cb ($cb)
		1085	}
		1086
		1087	sub child {
		1088	my ($class, %arg) = @_;
		1089
		1090	my $cb = $arg{cb};
		1091
		1092	urxvt::pw
		1093	->new
		1094	->start ($arg{pid})
		1095	->cb (sub {
		1096	$_[0]->stop; # need to cancel manually
		1097	$cb->($_[0]->rpid, $_[0]->rstatus);
		1098	})
1141	}	1099	}
1142		1100
1143	sub DESTROY {	1101	sub DESTROY {
1144	$_[0][1]->stop;	1102	$_[0][1]->stop;
1145	}	1103	}
1146		1104
1147	sub condvar {	1105	# 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 {	1106	sub one_event {
1162	Carp::croak "AnyEvent->one_event blocking wait unsupported in urxvt, use a non-blocking API";	1107	Carp::croak "AnyEvent->one_event blocking wait unsupported in urxvt, use a non-blocking API";
1163	}	1108	}
1164		1109
1165	package urxvt::term;	1110	package urxvt::term;
…		…
1180	urxvt::verbose 6, "register package $pkg to $self";	1125	urxvt::verbose 6, "register package $pkg to $self";
1181		1126
1182	@{"$pkg\::ISA"} = urxvt::term::extension::;	1127	@{"$pkg\::ISA"} = urxvt::term::extension::;
1183		1128
1184	my $proxy = bless {	1129	my $proxy = bless {
1185	_pkg => $pkg,	1130	_pkg => $pkg,
		1131	_name => ${"$pkg\::_NAME"}, # hackish
1186	argv => $argv,	1132	argv => $argv,
1187	}, $pkg;	1133	}, $pkg;
1188	Scalar::Util::weaken ($proxy->{term} = $self);	1134	Scalar::Util::weaken ($proxy->{term} = $self);
1189		1135
1190	$self->{_pkg}{$pkg} = $proxy;	1136	$self->{_pkg}{$pkg} = $proxy;
1191		1137
…		…
1194	$proxy->enable ($name => $ref);	1140	$proxy->enable ($name => $ref);
1195	}	1141	}
1196	}	1142	}
1197	}	1143	}
1198		1144
		1145	sub perl_libdirs {
		1146	map { split /:/ }
		1147	$_[0]->resource ("perl_lib"),
		1148	$ENV{URXVT_PERL_LIB},
		1149	"$ENV{HOME}/.urxvt/ext",
		1150	"$LIBDIR/perl"
		1151	}
		1152
		1153	# scan for available extensions and collect their metadata
		1154	sub scan_extensions {
		1155	my ($self) = @_;
		1156
		1157	return if exists $self->{meta};
		1158
		1159	my @urxvtdirs = perl_libdirs $self;
		1160	# my @cpandirs = grep -d, map "$_/URxvt/Ext", @INC;
		1161
		1162	$self->{meta} = \my %meta;
		1163
		1164	# first gather extensions
		1165
		1166	my $gather = sub {
		1167	my ($dir, $core) = @_;
		1168
		1169	opendir my $fh, $dir
		1170	or return;
		1171
		1172	for my $ext (readdir $fh) {
		1173	$ext !~ /^\./
		1174	or next;
		1175
		1176	open my $fh, "<", "$dir/$ext"
		1177	or next;
		1178
		1179	-f $fh
		1180	or next;
		1181
		1182	$ext =~ s/\.uext$// or $core
		1183	or next;
		1184
		1185	my %ext = (dir => $dir);
		1186
		1187	while (<$fh>) {
		1188	if (/^#:META:(?:X_)?RESOURCE:(.*)/) {
		1189	my ($pattern, $type, $desc) = split /:/, $1;
		1190	$pattern =~ s/^%(\.|$)/$ext$1/g; # % in pattern == extension name
		1191	if ($pattern =~ /[^a-zA-Z0-9\-\.]/) {
		1192	warn "$dir/$ext: meta resource '$pattern' contains illegal characters (not alphanumeric nor . nor *)\n";
		1193	} else {
		1194	$ext{resource}{$pattern} = [$ext, $type, $desc];
		1195	}
		1196	} elsif (/^\s*(?:#|$)/) {
		1197	# skip other comments and empty lines
		1198	} else {
		1199	last; # stop parsing on first non-empty non-comment line
		1200	}
		1201	}
		1202
		1203	$meta{ext}{$ext} = \%ext;
		1204	}
		1205	};
		1206
		1207	# $gather->($_, 0) for @cpandirs;
		1208	$gather->($_, 1) for @urxvtdirs;
		1209
		1210	# and now merge resources
		1211
		1212	$meta{resource} = \my %resource;
		1213
		1214	while (my ($k, $v) = each %{ $meta{ext} }) {
		1215	#TODO: should check for extensions overriding each other
		1216	%resource = (%resource, %{ $v->{resource} });
		1217	}
		1218	}
		1219
1199	=item $term = new urxvt::term $envhashref, $rxvtname, [arg...]	1220	=item $term = new urxvt::term $envhashref, $rxvtname, [arg...]
1200		1221
1201	Creates a new terminal, very similar as if you had started it with system	1222	Creates a new terminal, very similar as if you had started it with system
1202	C<$rxvtname, arg...>. C<$envhashref> must be a reference to a C<%ENV>-like	1223	C<$rxvtname, arg...>. C<$envhashref> must be a reference to a C<%ENV>-like
1203	hash which defines the environment of the new terminal.	1224	hash which defines the environment of the new terminal.
…		…
1220	}	1241	}
1221		1242
1222	=item $term->destroy	1243	=item $term->destroy
1223		1244
1224	Destroy the terminal object (close the window, free resources	1245	Destroy the terminal object (close the window, free resources
1225	etc.). Please note that @@RXVT_NAME@@ will not exit as long as any event	1246	etc.). Please note that urxvt will not exit as long as any event
1226	watchers (timers, io watchers) are still active.	1247	watchers (timers, io watchers) are still active.
1227		1248
1228	=item $term->exec_async ($cmd[, @args])	1249	=item $term->exec_async ($cmd[, @args])
1229		1250
1230	Works like the combination of the C<fork>/C<exec> builtins, which executes	1251	Works like the combination of the C<fork>/C<exec> builtins, which executes
…		…
1257	C<%urxvt::OPTION>. Options not enabled in this binary are not in the hash.	1278	C<%urxvt::OPTION>. Options not enabled in this binary are not in the hash.
1258		1279
1259	Here is a likely non-exhaustive list of option names, please see the	1280	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:	1281	source file F</src/optinc.h> to see the actual list:
1261		1282
1262	borderLess console cursorBlink cursorUnderline hold iconic insecure	1283	borderLess buffered console cursorBlink cursorUnderline hold iconic
1263	intensityStyles jumpScroll loginShell mapAlert meta8 mouseWheelScrollPage	1284	insecure intensityStyles iso14755 iso14755_52 jumpScroll loginShell
1264	override-redirect pastableTabs pointerBlank reverseVideo scrollBar	1285	mapAlert meta8 mouseWheelScrollPage override_redirect pastableTabs
1265	scrollBar_floating scrollBar_right scrollTtyKeypress scrollTtyOutput	1286	pointerBlank reverseVideo scrollBar scrollBar_floating scrollBar_right
1266	scrollWithBuffer secondaryScreen secondaryScroll skipBuiltinGlyphs	1287	scrollTtyKeypress scrollTtyOutput scrollWithBuffer secondaryScreen
1267	transparent tripleclickwords utmpInhibit visualBell	1288	secondaryScroll skipBuiltinGlyphs skipScroll transparent tripleclickwords
		1289	urgentOnBell utmpInhibit visualBell disablePasteBrackets
1268		1290
1269	=item $value = $term->resource ($name[, $newval])	1291	=item $value = $term->resource ($name[, $newval])
1270		1292
1271	Returns the current resource value associated with a given name and	1293	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>	1294	optionally sets a new value. Setting values is most useful in the C<init>
…		…
1285		1307
1286	Here is a likely non-exhaustive list of resource names, not all of which	1308	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>	1309	are supported in every build, please see the source file F</src/rsinc.h>
1288	to see the actual list:	1310	to see the actual list:
1289		1311
1290	answerbackstring backgroundPixmap backspace_key boldFont boldItalicFont	1312	answerbackstring backgroundPixmap backspace_key blurradius
1291	borderLess color cursorBlink cursorUnderline cutchars delete_key	1313	boldFont boldItalicFont borderLess buffered chdir color cursorBlink
1292	display_name embed ext_bwidth fade font geometry hold iconName	1314	cursorUnderline cutchars delete_key depth display_name embed ext_bwidth
1293	imFont imLocale inputMethod insecure int_bwidth intensityStyles	1315	fade font geometry hold iconName iconfile imFont imLocale inputMethod
		1316	insecure int_bwidth intensityStyles iso14755 iso14755_52 italicFont
1294	italicFont jumpScroll lineSpace loginShell mapAlert meta8 modifier	1317	jumpScroll letterSpace lineSpace loginShell mapAlert meta8 modifier
1295	mouseWheelScrollPage name override_redirect pastableTabs path perl_eval	1318	mouseWheelScrollPage name override_redirect pastableTabs path perl_eval
1296	perl_ext_1 perl_ext_2 perl_lib pointerBlank pointerBlankDelay	1319	perl_ext_1 perl_ext_2 perl_lib pointerBlank pointerBlankDelay
1297	preeditType print_pipe pty_fd reverseVideo saveLines scrollBar	1320	preeditType print_pipe pty_fd reverseVideo saveLines scrollBar
1298	scrollBar_align scrollBar_floating scrollBar_right scrollBar_thickness	1321	scrollBar_align scrollBar_floating scrollBar_right scrollBar_thickness
1299	scrollTtyKeypress scrollTtyOutput scrollWithBuffer scrollstyle	1322	scrollTtyKeypress scrollTtyOutput scrollWithBuffer scrollstyle
1300	secondaryScreen secondaryScroll selectstyle shade term_name title	1323	secondaryScreen secondaryScroll shade skipBuiltinGlyphs skipScroll
1301	transient_for transparent transparent_all tripleclickwords utmpInhibit	1324	term_name title transient_for transparent tripleclickwords urgentOnBell
1302	visualBell	1325	utmpInhibit visualBell rewrapMode disablePasteBrackets
1303		1326
1304	=cut	1327	=cut
1305		1328
1306	sub resource($$;$) {	1329	sub resource($$;$) {
1307	my ($self, $name) = (shift, shift);	1330	my ($self, $name) = (shift, shift);
1308	unshift @_, $self, $name, ($name =~ s/\s*\+\s*(\d+)$// ? $1 : 0);	1331	unshift @_, $self, $name, ($name =~ s/\s*\+\s*(\d+)$// ? $1 : 0);
1309	&urxvt::term::_resource	1332	goto &urxvt::term::_resource
1310	}	1333	}
1311		1334
1312	=item $value = $term->x_resource ($pattern)	1335	=item $value = $term->x_resource ($pattern)
1313		1336
1314	Returns the X-Resource for the given pattern, excluding the program or	1337	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	1338	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	1339	same value as used by this instance of rxvt-unicode. Returns C<undef> if no
1317	resource with that pattern exists.	1340	resource with that pattern exists.
1318		1341
		1342	Extensions that define extra resources also need to call this method
		1343	to access their values.
		1344
		1345	If the method is called on an extension object (basically, from an
		1346	extension), then the special prefix C<%.> will be replaced by the name of
		1347	the extension and a dot, and the lone string C<%> will be replaced by the
		1348	extension name itself. This makes it possible to code extensions so you
		1349	can rename them and get a new set of resources without having to change
		1350	the actual code.
		1351
1319	This method should only be called during the C<on_start> hook, as there is	1352	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	1353	only one resource database per display, and later invocations might return
1321	the wrong resources.	1354	the wrong resources.
1322		1355
1323	=item $success = $term->parse_keysym ($keysym_spec, $command_string)	1356	=item $value = $term->x_resource_boolean ($pattern)
1324		1357
		1358	Like C<x_resource>, above, but interprets the string value as a boolean
		1359	and returns C<1> for true values, C<0> for false values and C<undef> if
		1360	the resource or option isn't specified.
		1361
		1362	You should always use this method to parse boolean resources.
		1363
		1364	=cut
		1365
		1366	sub x_resource_boolean {
		1367	my $res = &x_resource;
		1368
		1369	$res =~ /^\s*(?:true|yes|on|1)\s*$/i ? 1 : defined $res && 0
		1370	}
		1371
		1372	=item $action = $term->lookup_keysym ($keysym, $state)
		1373
		1374	Returns the action bound to key combination C<($keysym, $state)>,
		1375	if a binding for it exists, and C<undef> otherwise.
		1376
		1377	=item $success = $term->bind_action ($key, $action)
		1378
1325	Adds a keymap translation exactly as specified via a resource. See the	1379	Adds a key binding exactly as specified via a C<keysym> resource. See the
1326	C<keysym> resource in the @@RXVT_NAME@@(1) manpage.	1380	C<keysym> resource in the urxvt(1) manpage.
		1381
		1382	To add default bindings for actions, an extension should call C<<
		1383	->bind_action >> in its C<init> hook for every such binding. Doing it
		1384	in the C<init> hook allows users to override or remove the binding
		1385	again.
		1386
		1387	Example: the C<searchable-scrollback> by default binds itself
		1388	on C<Meta-s>, using C<< $self->bind_action >>, which calls C<<
		1389	$term->bind_action >>.
		1390
		1391	sub init {
		1392	my ($self) = @_;
		1393
		1394	$self->bind_action ("M-s" => "%:start");
		1395	}
1327		1396
1328	=item $rend = $term->rstyle ([$new_rstyle])	1397	=item $rend = $term->rstyle ([$new_rstyle])
1329		1398
1330	Return and optionally change the current rendition. Text that is output by	1399	Return and optionally change the current rendition. Text that is output by
1331	the terminal application will use this style.	1400	the terminal application will use this style.
…		…
1339		1408
1340	=item ($row, $col) = $term->selection_beg ([$row, $col])	1409	=item ($row, $col) = $term->selection_beg ([$row, $col])
1341		1410
1342	=item ($row, $col) = $term->selection_end ([$row, $col])	1411	=item ($row, $col) = $term->selection_end ([$row, $col])
1343		1412
1344	Return the current values of the selection mark, begin or end positions,	1413	Return the current values of the selection mark, begin or end positions.
1345	and optionally set them to new values.	1414
		1415	When arguments are given, then the selection coordinates are set to
		1416	C<$row> and C<$col>, and the selection screen is set to the current
		1417	screen.
		1418
		1419	=item $screen = $term->selection_screen ([$screen])
		1420
		1421	Returns the current selection screen, and then optionally sets it.
1346		1422
1347	=item $term->selection_make ($eventtime[, $rectangular])	1423	=item $term->selection_make ($eventtime[, $rectangular])
1348		1424
1349	Tries to make a selection as set by C<selection_beg> and	1425	Tries to make a selection as set by C<selection_beg> and
1350	C<selection_end>. If C<$rectangular> is true (default: false), a	1426	C<selection_end>. If C<$rectangular> is true (default: false), a
1351	rectangular selection will be made. This is the prefered function to make	1427	rectangular selection will be made. This is the preferred function to make
1352	a selection.	1428	a selection.
1353		1429
1354	=item $success = $term->selection_grab ($eventtime)	1430	=item $success = $term->selection_grab ($eventtime[, $clipboard])
1355		1431
1356	Try to request the primary selection text from the server (for example, as	1432	Try to acquire ownership of the primary (clipboard if C<$clipboard> is
		1433	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	1434	with the next method. No visual feedback will be given. This function
1358	is mostly useful from within C<on_sel_grab> hooks.	1435	is mostly useful from within C<on_sel_grab> hooks.
1359		1436
1360	=item $oldtext = $term->selection ([$newtext])	1437	=item $oldtext = $term->selection ([$newtext, $clipboard])
1361		1438
1362	Return the current selection text and optionally replace it by C<$newtext>.	1439	Return the current selection (clipboard if C<$clipboard> is true) text
		1440	and optionally replace it by C<$newtext>.
		1441
		1442	=item $term->selection_clear ([$clipboard])
		1443
		1444	Revoke ownership of the primary (clipboard if C<$clipboard> is true) selection.
1363		1445
1364	=item $term->overlay_simple ($x, $y, $text)	1446	=item $term->overlay_simple ($x, $y, $text)
1365		1447
1366	Create a simple multi-line overlay box. See the next method for details.	1448	Create a simple multi-line overlay box. See the next method for details.
1367		1449
…		…
1397		1479
1398	The methods currently supported on C<urxvt::overlay> objects are:	1480	The methods currently supported on C<urxvt::overlay> objects are:
1399		1481
1400	=over 4	1482	=over 4
1401		1483
1402	=item $overlay->set ($x, $y, $text, $rend)	1484	=item $overlay->set ($x, $y, $text[, $rend])
1403		1485
1404	Similar to C<< $term->ROW_t >> and C<< $term->ROW_r >> in that it puts	1486	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	1487	text in rxvt-unicode's special encoding and an array of rendition values
1406	at a specific position inside the overlay.	1488	at a specific position inside the overlay.
		1489
		1490	If C<$rend> is missing, then the rendition will not be changed.
1407		1491
1408	=item $overlay->hide	1492	=item $overlay->hide
1409		1493
1410	If visible, hide the overlay, but do not destroy it.	1494	If visible, hide the overlay, but do not destroy it.
1411		1495
…		…
1474		1558
1475	=item $term->scr_add_lines ($string)	1559	=item $term->scr_add_lines ($string)
1476		1560
1477	Write the given text string to the screen, as if output by the application	1561	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	1562	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	1563	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.	1564	carriage returns and tabs. The string is a normal text string, not in
		1565	locale-dependent encoding.
1481		1566
1482	Normally its not a good idea to use this function, as programs might be	1567	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	1568	confused by changes in cursor position or scrolling. Its useful inside a
1484	C<on_add_lines> hook, though.	1569	C<on_add_lines> hook, though.
1485		1570
…		…
1493	locale-specific encoding of the terminal and can contain command sequences	1578	locale-specific encoding of the terminal and can contain command sequences
1494	(escape codes) that will be interpreted.	1579	(escape codes) that will be interpreted.
1495		1580
1496	=item $term->tt_write ($octets)	1581	=item $term->tt_write ($octets)
1497		1582
1498	Write the octets given in C<$data> to the tty (i.e. as program input). To	1583	Write the octets given in C<$octets> to the tty (i.e. as user input
		1584	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	1585	characters instead of octets, you should convert your strings first to the
1500	to the locale-specific encoding using C<< $term->locale_encode >>.	1586	locale-specific encoding using C<< $term->locale_encode >>.
		1587
		1588	=item $term->tt_write_user_input ($octets)
		1589
		1590	Like C<tt_write>, but should be used when writing strings in response to
		1591	the user pressing a key, to invoke the additional actions requested by
		1592	the user for that case (C<tt_write> doesn't do that).
		1593
		1594	The typical use case would be inside C<on_action> hooks.
		1595
		1596	=item $term->tt_paste ($octets)
		1597
		1598	Write the octets given in C<$octets> to the tty as a paste, converting NL to
		1599	CR and bracketing the data with control sequences if bracketed paste mode
		1600	is set.
1501		1601
1502	=item $old_events = $term->pty_ev_events ([$new_events])	1602	=item $old_events = $term->pty_ev_events ([$new_events])
1503		1603
1504	Replaces the event mask of the pty watcher by the given event mask. Can	1604	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	1605	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	1624	Adds the specified events to the vt event mask. Useful e.g. when you want
1525	to receive pointer events all the times:	1625	to receive pointer events all the times:
1526		1626
1527	$term->vt_emask_add (urxvt::PointerMotionMask);	1627	$term->vt_emask_add (urxvt::PointerMotionMask);
1528		1628
		1629	=item $term->set_urgency ($set)
		1630
		1631	Enable/disable the urgency hint on the toplevel window.
		1632
1529	=item $term->focus_in	1633	=item $term->focus_in
1530		1634
1531	=item $term->focus_out	1635	=item $term->focus_out
1532		1636
1533	=item $term->key_press ($state, $keycode[, $time])	1637	=item $term->key_press ($state, $keycode[, $time])
1534		1638
1535	=item $term->key_release ($state, $keycode[, $time])	1639	=item $term->key_release ($state, $keycode[, $time])
1536		1640
1537	Deliver various fake events to to terminal.	1641	Deliver various fake events to to terminal.
1538		1642
1539	=item $window_width = $term->width	1643	=item $window_width = $term->width ([$new_value])
1540		1644
1541	=item $window_height = $term->height	1645	=item $window_height = $term->height ([$new_value])
1542		1646
1543	=item $font_width = $term->fwidth	1647	=item $font_width = $term->fwidth ([$new_value])
1544		1648
1545	=item $font_height = $term->fheight	1649	=item $font_height = $term->fheight ([$new_value])
1546		1650
1547	=item $font_ascent = $term->fbase	1651	=item $font_ascent = $term->fbase ([$new_value])
1548		1652
1549	=item $terminal_rows = $term->nrow	1653	=item $terminal_rows = $term->nrow ([$new_value])
1550		1654
1551	=item $terminal_columns = $term->ncol	1655	=item $terminal_columns = $term->ncol ([$new_value])
1552		1656
1553	=item $has_focus = $term->focus	1657	=item $has_focus = $term->focus ([$new_value])
1554		1658
1555	=item $is_mapped = $term->mapped	1659	=item $is_mapped = $term->mapped ([$new_value])
1556		1660
1557	=item $max_scrollback = $term->saveLines	1661	=item $max_scrollback = $term->saveLines ([$new_value])
1558		1662
1559	=item $nrow_plus_saveLines = $term->total_rows	1663	=item $nrow_plus_saveLines = $term->total_rows ([$new_value])
1560		1664
1561	=item $topmost_scrollback_row = $term->top_row	1665	=item $topmost_scrollback_row = $term->top_row ([$new_value])
1562		1666
1563	Return various integers describing terminal characteristics.	1667	Return various integers describing terminal characteristics. If an
		1668	argument is given, changes the value and returns the previous one.
1564		1669
1565	=item $x_display = $term->display_id	1670	=item $x_display = $term->display_id
1566		1671
1567	Return the DISPLAY used by rxvt-unicode.	1672	Return the DISPLAY used by rxvt-unicode.
1568		1673
…		…
1605		1710
1606	=item $cursor_is_hidden = $term->hidden_cursor	1711	=item $cursor_is_hidden = $term->hidden_cursor
1607		1712
1608	Returns whether the cursor is currently hidden or not.	1713	Returns whether the cursor is currently hidden or not.
1609		1714
		1715	=item $priv_modes = $term->priv_modes
		1716
		1717	Returns a bitset with the state of DEC private modes.
		1718
		1719	Example:
		1720
		1721	if ($term->priv_modes & urxvt::PrivMode_mouse_report) {
		1722	# mouse reporting is turned on
		1723	}
		1724
1610	=item $view_start = $term->view_start ([$newvalue])	1725	=item $view_start = $term->view_start ([$newvalue])
1611		1726
1612	Returns the row number of the topmost displayed line. Maximum value is	1727	Returns the row number of the topmost displayed line and changes it,
1613	C<0>, which displays the normal terminal contents. Lower values scroll	1728	if an argument is given. Values greater than or equal to C<0> display
1614	this many lines into the scrollback buffer.	1729	the terminal contents. Lower values scroll this many lines into the
		1730	scrollback buffer.
1615		1731
1616	=item $term->want_refresh	1732	=item $term->want_refresh
1617		1733
1618	Requests a screen refresh. At the next opportunity, rxvt-unicode will	1734	Requests a screen refresh. At the next opportunity, rxvt-unicode will
1619	compare the on-screen display with its stored representation. If they	1735	compare the on-screen display with its stored representation. If they
1620	differ, it redraws the differences.	1736	differ, it redraws the differences.
1621		1737
1622	Used after changing terminal contents to display them.	1738	Used after changing terminal contents to display them.
1623		1739
		1740	=item $term->refresh_check
		1741
		1742	Checks if a refresh has been requested and, if so, schedules one.
		1743
1624	=item $text = $term->ROW_t ($row_number[, $new_text[, $start_col]])	1744	=item $text = $term->ROW_t ($row_number[, $new_text[, $start_col]])
1625		1745
1626	Returns the text of the entire row with number C<$row_number>. Row C<0>	1746	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	1747	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	1748	terminal line. Nothing will be returned if a nonexistent line
1630	is requested.	1749	is requested.
1631		1750
1632	If C<$new_text> is specified, it will replace characters in the current	1751	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	1752	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	1753	to replace only parts of a line. The font index in the rendition will
1635	automatically be updated.	1754	automatically be updated.
1636		1755
1637	C<$text> is in a special encoding: tabs and wide characters that use more	1756	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)	1757	than one cell when displayed are padded with C<$urxvt::NOCHAR> (chr 65535)
1639	characters. Characters with combining characters and other characters that	1758	characters. Characters with combining characters and other characters that
1640	do not fit into the normal tetx encoding will be replaced with characters	1759	do not fit into the normal text encoding will be replaced with characters
1641	in the private use area.	1760	in the private use area.
1642		1761
1643	You have to obey this encoding when changing text. The advantage is	1762	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	1763	that C<substr> and similar functions work on screen cells and not on
1645	characters.	1764	characters.
…		…
1730	}	1849	}
1731		1850
1732	sub urxvt::line::t {	1851	sub urxvt::line::t {
1733	my ($self) = @_;	1852	my ($self) = @_;
1734		1853
1735	if (@_ > 1)	1854	if (@_ > 1) {
1736	{
1737	$self->{term}->ROW_t ($_, $_[1], 0, ($_ - $self->{beg}) * $self->{ncol}, $self->{ncol})	1855	$self->{term}->ROW_t ($_, $_[1], 0, ($_ - $self->{beg}) * $self->{ncol}, $self->{ncol})
1738	for $self->{beg} .. $self->{end};	1856	for $self->{beg} .. $self->{end};
1739	}	1857	}
1740		1858
1741	defined wantarray &&	1859	defined wantarray &&
1742	substr +(join "", map $self->{term}->ROW_t ($_), $self->{beg} .. $self->{end}),	1860	substr +(join "", map $self->{term}->ROW_t ($_), $self->{beg} .. $self->{end}),
1743	0, $self->{len}	1861	0, $self->{len}
1744	}	1862	}
1745		1863
1746	sub urxvt::line::r {	1864	sub urxvt::line::r {
1747	my ($self) = @_;	1865	my ($self) = @_;
1748		1866
1749	if (@_ > 1)	1867	if (@_ > 1) {
1750	{
1751	$self->{term}->ROW_r ($_, $_[1], 0, ($_ - $self->{beg}) * $self->{ncol}, $self->{ncol})	1868	$self->{term}->ROW_r ($_, $_[1], 0, ($_ - $self->{beg}) * $self->{ncol}, $self->{ncol})
1752	for $self->{beg} .. $self->{end};	1869	for $self->{beg} .. $self->{end};
1753	}	1870	}
1754		1871
1755	if (defined wantarray) {	1872	if (defined wantarray) {
1756	my $rend = [	1873	my $rend = [
1757	map @{ $self->{term}->ROW_r ($_) }, $self->{beg} .. $self->{end}	1874	map @{ $self->{term}->ROW_r ($_) }, $self->{beg} .. $self->{end}
1758	];	1875	];
…		…
1820	Calls XAllowEvents with both ReplayPointer and ReplayKeyboard for the most	1937	Calls XAllowEvents with both ReplayPointer and ReplayKeyboard for the most
1821	recent grab.	1938	recent grab.
1822		1939
1823	=item $term->ungrab	1940	=item $term->ungrab
1824		1941
1825	Calls XUngrab for the most recent grab. Is called automatically on	1942	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	1943	evaluation errors, as it is better to lose the grab in the error case as
1827	the session.	1944	the session.
1828		1945
1829	=item $atom = $term->XInternAtom ($atom_name[, $only_if_exists])	1946	=item $atom = $term->XInternAtom ($atom_name[, $only_if_exists])
1830		1947
…		…
1832		1949
1833	=item @atoms = $term->XListProperties ($window)	1950	=item @atoms = $term->XListProperties ($window)
1834		1951
1835	=item ($type,$format,$octets) = $term->XGetWindowProperty ($window, $property)	1952	=item ($type,$format,$octets) = $term->XGetWindowProperty ($window, $property)
1836		1953
1837	=item $term->XChangeWindowProperty ($window, $property, $type, $format, $octets)	1954	=item $term->XChangeProperty ($window, $property, $type, $format, $octets)
1838		1955
1839	=item $term->XDeleteProperty ($window, $property)	1956	=item $term->XDeleteProperty ($window, $property)
1840		1957
1841	=item $window = $term->DefaultRootWindow	1958	=item $window = $term->DefaultRootWindow
1842		1959
…		…
1849	=item $term->XMoveResizeWindow ($window, $x, $y, $width, $height)	1966	=item $term->XMoveResizeWindow ($window, $x, $y, $width, $height)
1850		1967
1851	=item ($x, $y, $child_window) = $term->XTranslateCoordinates ($src, $dst, $x, $y)	1968	=item ($x, $y, $child_window) = $term->XTranslateCoordinates ($src, $dst, $x, $y)
1852		1969
1853	=item $term->XChangeInput ($window, $add_events[, $del_events])	1970	=item $term->XChangeInput ($window, $add_events[, $del_events])
		1971
		1972	=item $keysym = $term->XStringToKeysym ($string)
		1973
		1974	=item $string = $term->XKeysymToString ($keysym)
1854		1975
1855	Various X or X-related functions. The C<$term> object only serves as	1976	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	1977	the source of the display, otherwise those functions map more-or-less
1857	directory onto the X functions of the same name.	1978	directly onto the X functions of the same name.
1858		1979
1859	=back	1980	=back
1860		1981
1861	=cut	1982	=cut
1862		1983
…		…
1964	my $env = $self->{term}->env;	2085	my $env = $self->{term}->env;
1965	# we can't hope to reproduce the locale algorithm, so nuke LC_ALL and set LC_CTYPE.	2086	# we can't hope to reproduce the locale algorithm, so nuke LC_ALL and set LC_CTYPE.
1966	delete $env->{LC_ALL};	2087	delete $env->{LC_ALL};
1967	$env->{LC_CTYPE} = $self->{term}->locale;	2088	$env->{LC_CTYPE} = $self->{term}->locale;
1968		2089
1969	urxvt::term->new ($env, "popup",	2090	my $term = urxvt::term->new (
		2091	$env, "popup",
1970	"--perl-lib" => "", "--perl-ext-common" => "",	2092	"--perl-lib" => "", "--perl-ext-common" => "",
1971	"-pty-fd" => -1, "-sl" => 0,	2093	"-pty-fd" => -1, "-sl" => 0,
1972	"-b" => 1, "-bd" => "grey80", "-bl", "-override-redirect",	2094	"-b" => 1, "-bd" => "grey80", "-bl", "-override-redirect",
1973	"--transient-for" => $self->{term}->parent,	2095	"--transient-for" => $self->{term}->parent,
1974	"-display" => $self->{term}->display_id,	2096	"-display" => $self->{term}->display_id,
1975	"-pe" => "urxvt-popup")	2097	"-pe" => "urxvt-popup",
1976	or die "unable to create popup window\n";	2098	) or die "unable to create popup window\n";
		2099
		2100	unless (delete $term->{urxvt_popup_init_done}) {
		2101	$term->ungrab;
		2102	$term->destroy;
		2103	die "unable to initialise popup window\n";
		2104	}
1977	}	2105	}
1978		2106
1979	sub DESTROY {	2107	sub DESTROY {
1980	my ($self) = @_;	2108	my ($self) = @_;
1981		2109
…		…
1999	->new	2127	->new
2000	->interval (1)	2128	->interval (1)
2001	->cb (sub {	2129	->cb (sub {
2002	$term->{overlay}->set (0, 0,	2130	$term->{overlay}->set (0, 0,
2003	sprintf "%2d:%02d:%02d", (localtime urxvt::NOW)[2,1,0]);	2131	sprintf "%2d:%02d:%02d", (localtime urxvt::NOW)[2,1,0]);
2004	});	2132	});
2005		2133
2006	=over 4	2134	=over 4
2007		2135
2008	=item $timer = new urxvt::timer	2136	=item $timer = new urxvt::timer
2009		2137
…		…
2012		2140
2013	=item $timer = $timer->cb (sub { my ($timer) = @_; ... })	2141	=item $timer = $timer->cb (sub { my ($timer) = @_; ... })
2014		2142
2015	Set the callback to be called when the timer triggers.	2143	Set the callback to be called when the timer triggers.
2016		2144
2017	=item $tstamp = $timer->at
2018
2019	Return the time this watcher will fire next.
2020
2021	=item $timer = $timer->set ($tstamp)	2145	=item $timer = $timer->set ($tstamp[, $interval])
2022		2146
2023	Set the time the event is generated to $tstamp.	2147	Set the time the event is generated to $tstamp (and optionally specifies a
		2148	new $interval).
2024		2149
2025	=item $timer = $timer->interval ($interval)	2150	=item $timer = $timer->interval ($interval)
2026		2151
2027	Normally (and when C<$interval> is C<0>), the timer will automatically	2152	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	2153	stop after it has fired once. If C<$interval> is non-zero, then the timer
2029	is automatically rescheduled at the given intervals.	2154	is automatically rescheduled at the given intervals.
2030		2155
2031	=item $timer = $timer->start	2156	=item $timer = $timer->start
2032		2157
2033	Start the timer.	2158	Start the timer.
2034		2159
2035	=item $timer = $timer->start ($tstamp)	2160	=item $timer = $timer->start ($tstamp[, $interval])
2036		2161
2037	Set the event trigger time to C<$tstamp> and start the timer.	2162	Set the event trigger time to C<$tstamp> and start the timer. Optionally
		2163	also replaces the interval.
2038		2164
2039	=item $timer = $timer->after ($delay)	2165	=item $timer = $timer->after ($delay[, $interval])
2040		2166
2041	Like C<start>, but sets the expiry timer to c<urxvt::NOW + $delay>.	2167	Like C<start>, but sets the expiry timer to c<urxvt::NOW + $delay>.
2042		2168
2043	=item $timer = $timer->stop	2169	=item $timer = $timer->stop
2044		2170
…		…
2052		2178
2053	$term->{socket} = ...	2179	$term->{socket} = ...
2054	$term->{iow} = urxvt::iow	2180	$term->{iow} = urxvt::iow
2055	->new	2181	->new
2056	->fd (fileno $term->{socket})	2182	->fd (fileno $term->{socket})
2057	->events (urxvt::EVENT_READ)	2183	->events (urxvt::EV_READ)
2058	->start	2184	->start
2059	->cb (sub {	2185	->cb (sub {
2060	my ($iow, $revents) = @_;	2186	my ($iow, $revents) = @_;
2061	# $revents must be 1 here, no need to check	2187	# $revents must be 1 here, no need to check
2062	sysread $term->{socket}, my $buf, 8192	2188	sysread $term->{socket}, my $buf, 8192
…		…
2080	Set the file descriptor (not handle) to watch.	2206	Set the file descriptor (not handle) to watch.
2081		2207
2082	=item $iow = $iow->events ($eventmask)	2208	=item $iow = $iow->events ($eventmask)
2083		2209
2084	Set the event mask to watch. The only allowed values are	2210	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	2211	C<urxvt::EV_READ> and C<urxvt::EV_WRITE>, which might be ORed
2086	together, or C<urxvt::EVENT_NONE>.	2212	together, or C<urxvt::EV_NONE>.
2087		2213
2088	=item $iow = $iow->start	2214	=item $iow = $iow->start
2089		2215
2090	Start watching for requested events on the given handle.	2216	Start watching for requested events on the given handle.
2091		2217
…		…
2132	->new	2258	->new
2133	->start ($pid)	2259	->start ($pid)
2134	->cb (sub {	2260	->cb (sub {
2135	my ($pw, $exit_status) = @_;	2261	my ($pw, $exit_status) = @_;
2136	...	2262	...
2137	});	2263	});
2138		2264
2139	=over 4	2265	=over 4
2140		2266
2141	=item $pw = new urxvt::pw	2267	=item $pw = new urxvt::pw
2142		2268
…		…
2175		2301
2176	=back	2302	=back
2177		2303
2178	=head1 AUTHOR	2304	=head1 AUTHOR
2179		2305
2180	Marc Lehmann <pcg@goof.com>	2306	Marc Lehmann <schmorp@schmorp.de>
2181	http://software.schmorp.de/pkg/rxvt-unicode	2307	http://software.schmorp.de/pkg/rxvt-unicode
2182		2308
2183	=cut	2309	=cut
2184		2310
2185	1	2311	1

Diff Legend

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