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.157 by ayin, Wed Oct 31 09:55:24 2007 UTC vs.
Revision 1.257 by root, Thu Jul 13 10:31:27 2017 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 $HOME:
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 using it:
17		17
18	@@RXVT_NAME@@ --perl-lib $HOME -pe grab_test	18	urxvt --perl-lib $HOME -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 if the C<Shift> modifier is active.
158
159	The regex defaults to "(?i)", resulting in a case-insensitive search. To
160	get a case-sensitive search you can delete this prefix using C<BackSpace>
161	or simply use an uppercase character which removes the "(?i)" prefix.
162
163	See L<perlre> for more info about perl regular expression syntax.
164
165	=item readline (enabled by default)
166
167	A support package that tries to make editing with readline easier. At
168	the moment, it reacts to clicking shift-left mouse button by trying to
169	move the text cursor to this position. It does so by generating as many
170	cursor-left or cursor-right keypresses as required (the this only works
171	for programs that correctly support wide characters).
172
173	To avoid too many false positives, this is only done when:
174
175	=over 4
176
177	=item - the tty is in ICANON state.
178
179	=item - the text cursor is visible.
180
181	=item - the primary screen is currently being displayed.
182
183	=item - the mouse is on the same (multi-row-) line as the text cursor.
184
185	=back
186
187	The normal selection mechanism isn't disabled, so quick successive clicks
188	might interfere with selection creation in harmless ways.
189
190	=item selection-autotransform
191
192	This selection allows you to do automatic transforms on a selection
193	whenever a selection is made.
194
195	It works by specifying perl snippets (most useful is a single C<s///>
196	operator) that modify C<$_> as resources:
197
198	URxvt.selection-autotransform.0: transform
199	URxvt.selection-autotransform.1: transform
200	...
201
202	For example, the following will transform selections of the form
203	C<filename:number>, often seen in compiler messages, into C<vi +$filename
204	$word>:
205
206	URxvt.selection-autotransform.0: s/^([^:[:space:]]+):(\\d+):?$/vi +$2 \\Q$1\\E\\x0d/
207
208	And this example matches the same,but replaces it with vi-commands you can
209	paste directly into your (vi :) editor:
210
211	URxvt.selection-autotransform.0: s/^([^:[:space:]]+(\\d+):?$/:e \\Q$1\\E\\x0d:$2\\x0d/
212
213	Of course, this can be modified to suit your needs and your editor :)
214
215	To expand the example above to typical perl error messages ("XXX at
216	FILENAME line YYY."), you need a slightly more elaborate solution:
217
218	URxvt.selection.pattern-0: ( at .*? line \\d+[,.])
219	URxvt.selection-autotransform.0: s/^ at (.*?) line (\\d+)[,.]$/:e \\Q$1\E\\x0d:$2\\x0d/
220
221	The first line tells the selection code to treat the unchanging part of
222	every error message as a selection pattern, and the second line transforms
223	the message into vi commands to load the file.
224
225	=item tabbed
226
227	This transforms the terminal into a tabbar with additional terminals, that
228	is, it implements what is commonly referred to as "tabbed terminal". The topmost line
229	displays a "[NEW]" button, which, when clicked, will add a new tab, followed by one
230	button per tab.
231
232	Clicking a button will activate that tab. Pressing B<Shift-Left> and
233	B<Shift-Right> will switch to the tab left or right of the current one,
234	while B<Shift-Down> creates a new tab.
235
236	The tabbar itself can be configured similarly to a normal terminal, but
237	with a resource class of C<URxvt.tabbed>. In addition, it supports the
238	following four resources (shown with defaults):
239
240	URxvt.tabbed.tabbar-fg: <colour-index, default 3>
241	URxvt.tabbed.tabbar-bg: <colour-index, default 0>
242	URxvt.tabbed.tab-fg: <colour-index, default 0>
243	URxvt.tabbed.tab-bg: <colour-index, default 1>
244
245	See I<COLOR AND GRAPHICS> in the @@RXVT_NAME@@(1) manpage for valid
246	indices.
247
248	=item matcher
249
250	Uses per-line display filtering (C<on_line_update>) to underline text
251	matching a certain pattern and make it clickable. When clicked with the
252	mouse button specified in the C<matcher.button> resource (default 2, or
253	middle), the program specified in the C<matcher.launcher> resource
254	(default, the C<urlLauncher> resource, C<sensible-browser>) will be started
255	with the matched text as first argument. The default configuration is
256	suitable for matching URLs and launching a web browser, like the
257	former "mark-urls" extension.
258
259	The default pattern to match URLs can be overridden with the
260	C<matcher.pattern.0> resource, and additional patterns can be specified
261	with numbered patterns, in a manner similar to the "selection" extension.
262	The launcher can also be overridden on a per-pattern basis.
263
264	It is possible to activate the most recently seen match from the keyboard.
265	Simply bind a keysym to "perl:matcher" as seen in the example below.
266
267	Example configuration:
268
269	URxvt.perl-ext: default,matcher
270	URxvt.urlLauncher: sensible-browser
271	URxvt.keysym.C-Delete: perl:matcher
272	URxvt.matcher.button: 1
273	URxvt.matcher.pattern.1: \\bwww\\.[\\w-]+\\.[\\w./?&@#-]*[\\w/-]
274	URxvt.matcher.pattern.2: \\B(/\\S+?):(\\d+)(?=:|$)
275	URxvt.matcher.launcher.2: gvim +$2 $1
276
277	=item xim-onthespot
278
279	This (experimental) perl extension implements OnTheSpot editing. It does
280	not work perfectly, and some input methods don't seem to work well with
281	OnTheSpot editing in general, but it seems to work at leats for SCIM and
282	kinput2.
283
284	You enable it by specifying this extension and a preedit style of
285	C<OnTheSpot>, i.e.:
286
287	@@RXVT_NAME@@ -pt OnTheSpot -pe xim-onthespot
288
289	=item kuake<hotkey>
290
291	A very primitive quake-console-like extension. It was inspired by a
292	description of how the programs C<kuake> and C<yakuake> work: Whenever the
293	user presses a global accelerator key (by default C<F10>), the terminal
294	will show or hide itself. Another press of the accelerator key will hide
295	or show it again.
296
297	Initially, the window will not be shown when using this extension.
298
299	This is useful if you need a single terminal thats not using any desktop
300	space most of the time but is quickly available at the press of a key.
301
302	The accelerator key is grabbed regardless of any modifiers, so this
303	extension will actually grab a physical key just for this function.
304
305	If you want a quake-like animation, tell your window manager to do so
306	(fvwm can do it).
307
308	=item automove-background
309
310	This is basically a very small extension that dynamically changes the
311	background pixmap offset to the window position, in effect creating the
312	same effect as pseudo transparency with a custom pixmap. No scaling is
313	supported in this mode. Example:
314
315	@@RXVT_NAME@@ -pixmap background.xpm -pe automove-background
316
317	L<http://wiki.archlinux.org/index.php/Perl_Background_Rotation/Extensions>
318	shows how this extension can be used to implement an automatically blurred
319	transparent background.
320
321	=item block-graphics-to-ascii
322
323	A not very useful example of filtering all text output to the terminal
324	by replacing all line-drawing characters (U+2500 .. U+259F) by a
325	similar-looking ascii character.
326
327	=item digital-clock
328
329	Displays a digital clock using the built-in overlay.
330
331	=item remote-clipboard
332
333	Somewhat of a misnomer, this extension adds two menu entries to the
334	selection popup that allows one ti run external commands to store the
335	selection somewhere and fetch it again.
336
337	We use it to implement a "distributed selection mechanism", which just
338	means that one command uploads the file to a remote server, and another
339	reads it.
340
341	The commands can be set using the C<URxvt.remote-selection.store> and
342	C<URxvt.remote-selection.fetch> resources. The first should read the
343	selection to store from STDIN (always in UTF-8), the second should provide
344	the selection data on STDOUT (also in UTF-8).
345
346	The defaults (which are likely useless to you) use rsh and cat:
347
348	URxvt.remote-selection.store: rsh ruth 'cat >/tmp/distributed-selection'
349	URxvt.remote-selection.fetch: rsh ruth 'cat /tmp/distributed-selection'
350
351	=item selection-pastebin
352
353	This is a little rarely useful extension that Uploads the selection as
354	textfile to a remote site (or does other things). (The implementation is
355	not currently secure for use in a multiuser environment as it writes to
356	F</tmp> directly.).
357
358	It listens to the C<selection-pastebin:remote-pastebin> keyboard command,
359	i.e.
360
361	URxvt.keysym.C-M-e: perl:selection-pastebin:remote-pastebin
362
363	Pressing this combination runs a command with C<%> replaced by the name of
364	the textfile. This command can be set via a resource:
365
366	URxvt.selection-pastebin.cmd: rsync -apP % ruth:/var/www/www.ta-sa.org/files/txt/.
367
368	And the default is likely not useful to anybody but the few people around
369	here :)
370
371	The name of the textfile is the hex encoded md5 sum of the selection, so
372	the same content should lead to the same filename.
373
374	After a successful upload the selection will be replaced by the text given
375	in the C<selection-pastebin-url> resource (again, the % is the placeholder
376	for the filename):
377
378	URxvt.selection-pastebin.url: http://www.ta-sa.org/files/txt/%
379
380	I<Note to xrdb users:> xrdb uses the C preprocessor, which might interpret
381	the double C</> characters as comment start. Use C<\057\057> instead,
382	which works regardless of wether xrdb is used to parse the resource file
383	or not.
384
385	=item example-refresh-hooks
386
387	Displays a very simple digital clock in the upper right corner of the
388	window. Illustrates overwriting the refresh callbacks to create your own
389	overlays or changes.
390
391	=back
392		56
393	=head1 API DOCUMENTATION	57	=head1 API DOCUMENTATION
394		58
395	=head2 General API Considerations	59	=head2 General API Considerations
396		60
…		…
410		74
411	=over 4	75	=over 4
412		76
413	=item $text	77	=item $text
414		78
415	Rxvt-unicodes special way of encoding text, where one "unicode" character	79	Rxvt-unicode's special way of encoding text, where one "unicode" character
416	always represents one screen cell. See L<ROW_t> for a discussion of this format.	80	always represents one screen cell. See L<ROW_t> for a discussion of this format.
417		81
418	=item $string	82	=item $string
419		83
420	A perl text string, with an emphasis on I<text>. It can store all unicode	84	A perl text string, with an emphasis on I<text>. It can store all unicode
…		…
424	=item $octets	88	=item $octets
425		89
426	Either binary data or - more common - a text string encoded in a	90	Either binary data or - more common - a text string encoded in a
427	locale-specific way.	91	locale-specific way.
428		92
		93	=item $keysym
		94
		95	an integer that is a valid X11 keysym code. You can convert a string
		96	into a keysym and viceversa by using C<XStringToKeysym> and
		97	C<XKeysymToString>.
		98
429	=back	99	=back
430		100
431	=head2 Extension Objects	101	=head2 Extension Objects
432		102
433	Every perl extension is a perl class. A separate perl object is created	103	Every perl extension is a perl class. A separate perl object is created
434	for each terminal, and each terminal has its own set of extenion objects,	104	for each terminal, and each terminal has its own set of extension objects,
435	which are passed as the first parameter to hooks. So extensions can use	105	which are passed as the first parameter to hooks. So extensions can use
436	their C<$self> object without having to think about clashes with other	106	their C<$self> object without having to think about clashes with other
437	extensions or other terminals, with the exception of methods and members	107	extensions or other terminals, with the exception of methods and members
438	that begin with an underscore character C<_>: these are reserved for	108	that begin with an underscore character C<_>: these are reserved for
439	internal use.	109	internal use.
440		110
441	Although it isn't a C<urxvt::term> object, you can call all methods of the	111	Although it isn't a C<urxvt::term> object, you can call all methods of the
442	C<urxvt::term> class on this object.	112	C<urxvt::term> class on this object.
443		113
444	It has the following methods and data members:	114	Additional methods only supported for extension objects are described in
		115	the C<urxvt::extension> section below.
		116
		117	=head2 META comments
		118
		119	Rxvt-unicode recognizes special meta comments in extensions that define
		120	different types of metadata.
		121
		122	Currently, it recognises only one such comment:
445		123
446	=over 4	124	=over 4
447		125
448	=item $urxvt_term = $self->{term}	126	=item #:META:RESOURCE:name:type:desc
449		127
450	Returns the C<urxvt::term> object associated with this instance of the	128	The RESOURCE comment defines a resource used by the extension, where
451	extension. This member I<must not> be changed in any way.	129	C<name> is the resource name, C<type> is the resource type, C<boolean>
452		130	or C<string>, and C<desc> is the resource description.
453	=item $self->enable ($hook_name => $cb, [$hook_name => $cb..])
454
455	Dynamically enable the given hooks (named without the C<on_> prefix) for
456	this extension, replacing any previous hook. This is useful when you want
457	to overwrite time-critical hooks only temporarily.
458
459	=item $self->disable ($hook_name[, $hook_name..])
460
461	Dynamically disable the given hooks.
462		131
463	=back	132	=back
464		133
465	=head2 Hooks	134	=head2 Hooks
466		135
…		…
554		223
555	It is called before lines are scrolled out (so rows 0 .. min ($lines - 1,	224	It is called before lines are scrolled out (so rows 0 .. min ($lines - 1,
556	$nrow - 1) represent the lines to be scrolled out). C<$saved> is the total	225	$nrow - 1) represent the lines to be scrolled out). C<$saved> is the total
557	number of lines that will be in the scrollback buffer.	226	number of lines that will be in the scrollback buffer.
558		227
559	=item on_osc_seq $term, $op, $args	228	=item on_osc_seq $term, $op, $args, $resp
560		229
561	Called on every OSC sequence and can be used to suppress it or modify its	230	Called on every OSC sequence and can be used to suppress it or modify its
562	behaviour. The default should be to return an empty list. A true value	231	behaviour. The default should be to return an empty list. A true value
563	suppresses execution of the request completely. Make sure you don't get	232	suppresses execution of the request completely. Make sure you don't get
564	confused by recursive invocations when you output an osc sequence within	233	confused by recursive invocations when you output an OSC sequence within
565	this callback.	234	this callback.
566		235
567	C<on_osc_seq_perl> should be used for new behaviour.	236	C<on_osc_seq_perl> should be used for new behaviour.
568		237
569	=item on_osc_seq_perl $term, $string	238	=item on_osc_seq_perl $term, $args, $resp
570		239
571	Called whenever the B<ESC ] 777 ; string ST> command sequence (OSC =	240	Called whenever the B<ESC ] 777 ; string ST> command sequence (OSC =
572	operating system command) is processed. Cursor position and other state	241	operating system command) is processed. Cursor position and other state
573	information is up-to-date when this happens. For interoperability, the	242	information is up-to-date when this happens. For interoperability, the
574	string should start with the extension name and a colon, to distinguish	243	string should start with the extension name (sans -osc) and a semicolon,
575	it from commands for other extensions, and this might be enforced in the	244	to distinguish it from commands for other extensions, and this might be
576	future.	245	enforced in the future.
		246
		247	For example, C<overlay-osc> uses this:
		248
		249	sub on_osc_seq_perl {
		250	my ($self, $osc, $resp) = @_;
		251
		252	return unless $osc =~ s/^overlay;//;
		253
		254	... process remaining $osc string
		255	}
577		256
578	Be careful not ever to trust (in a security sense) the data you receive,	257	Be careful not ever to trust (in a security sense) the data you receive,
579	as its source can not easily be controlled (e-mail content, messages from	258	as its source can not easily be controlled (e-mail content, messages from
580	other users on the same system etc.).	259	other users on the same system etc.).
		260
		261	For responses, C<$resp> contains the end-of-args separator used by the
		262	sender.
581		263
582	=item on_add_lines $term, $string	264	=item on_add_lines $term, $string
583		265
584	Called whenever text is about to be output, with the text as argument. You	266	Called whenever text is about to be output, with the text as argument. You
585	can filter/change and output the text yourself by returning a true value	267	can filter/change and output the text yourself by returning a true value
…		…
590	=item on_tt_write $term, $octets	272	=item on_tt_write $term, $octets
591		273
592	Called whenever some data is written to the tty/pty and can be used to	274	Called whenever some data is written to the tty/pty and can be used to
593	suppress or filter tty input.	275	suppress or filter tty input.
594		276
		277	=item on_tt_paste $term, $octets
		278
		279	Called whenever text is about to be pasted, with the text as argument. You
		280	can filter/change and paste the text yourself by returning a true value
		281	and calling C<< $term->tt_paste >> yourself. C<$octets> is
		282	locale-encoded.
		283
595	=item on_line_update $term, $row	284	=item on_line_update $term, $row
596		285
597	Called whenever a line was updated or changed. Can be used to filter	286	Called whenever a line was updated or changed. Can be used to filter
598	screen output (e.g. underline urls or other useless stuff). Only lines	287	screen output (e.g. underline urls or other useless stuff). Only lines
599	that are being shown will be filtered, and, due to performance reasons,	288	that are being shown will be filtered, and, due to performance reasons,
…		…
606	later with the already-modified line (e.g. if unrelated parts change), so	295	later with the already-modified line (e.g. if unrelated parts change), so
607	you cannot just toggle rendition bits, but only set them.	296	you cannot just toggle rendition bits, but only set them.
608		297
609	=item on_refresh_begin $term	298	=item on_refresh_begin $term
610		299
611	Called just before the screen gets redrawn. Can be used for overlay	300	Called just before the screen gets redrawn. Can be used for overlay or
612	or similar effects by modify terminal contents in refresh_begin, and	301	similar effects by modifying the terminal contents in refresh_begin, and
613	restoring them in refresh_end. The built-in overlay and selection display	302	restoring them in refresh_end. The built-in overlay and selection display
614	code is run after this hook, and takes precedence.	303	code is run after this hook, and takes precedence.
615		304
616	=item on_refresh_end $term	305	=item on_refresh_end $term
617		306
618	Called just after the screen gets redrawn. See C<on_refresh_begin>.	307	Called just after the screen gets redrawn. See C<on_refresh_begin>.
619		308
		309	=item on_action $term, $string
		310
		311	Called whenever an action is invoked for the corresponding extension
		312	(e.g. via a C<extension:string> builtin action bound to a key, see
		313	description of the B<keysym> resource in the urxvt(1) manpage). The
		314	event is simply the action string. Note that an action event is always
		315	associated to a single extension.
		316
620	=item on_user_command $term, $string	317	=item on_user_command $term, $string *DEPRECATED*
621		318
622	Called whenever a user-configured event is being activated (e.g. via	319	Called whenever a user-configured event is being activated (e.g. via
623	a C<perl:string> action bound to a key, see description of the B<keysym>	320	a C<perl:string> action bound to a key, see description of the B<keysym>
624	resource in the @@RXVT_NAME@@(1) manpage).	321	resource in the urxvt(1) manpage).
625		322
626	The event is simply the action string. This interface is assumed to change	323	The event is simply the action string. This interface is going away in
627	slightly in the future.	324	preference to the C<on_action> hook.
628		325
629	=item on_resize_all_windows $tern, $new_width, $new_height	326	=item on_resize_all_windows $term, $new_width, $new_height
630		327
631	Called just after the new window size has been calculated, but before	328	Called just after the new window size has been calculated, but before
632	windows are actually being resized or hints are being set. If this hook	329	windows are actually being resized or hints are being set. If this hook
633	returns TRUE, setting of the window hints is being skipped.	330	returns a true value, setting of the window hints is being skipped.
634		331
635	=item on_x_event $term, $event	332	=item on_x_event $term, $event
636		333
637	Called on every X event received on the vt window (and possibly other	334	Called on every X event received on the vt window (and possibly other
638	windows). Should only be used as a last resort. Most event structure	335	windows). Should only be used as a last resort. Most event structure
…		…
668		365
669	=item on_map_notify $term, $event	366	=item on_map_notify $term, $event
670		367
671	=item on_unmap_notify $term, $event	368	=item on_unmap_notify $term, $event
672		369
673	Called whenever the corresponding X event is received for the terminal If	370	Called whenever the corresponding X event is received for the terminal. If
674	the hook returns true, then the even will be ignored by rxvt-unicode.	371	the hook returns true, then the event will be ignored by rxvt-unicode.
675		372
676	The event is a hash with most values as named by Xlib (see the XEvent	373	The event is a hash with most values as named by Xlib (see the XEvent
677	manpage), with the additional members C<row> and C<col>, which are the	374	manpage), with the additional members C<row> and C<col>, which are the
678	(real, not screen-based) row and column under the mouse cursor.	375	(real, not screen-based) row and column under the mouse cursor.
679		376
680	C<on_key_press> additionally receives the string rxvt-unicode would	377	C<on_key_press> additionally receives the string rxvt-unicode would
681	output, if any, in locale-specific encoding.	378	output, if any, in locale-specific encoding.
682		379
683	subwindow.
684
685	=item on_client_message $term, $event	380	=item on_client_message $term, $event
686		381
687	=item on_wm_protocols $term, $event	382	=item on_wm_protocols $term, $event
688		383
689	=item on_wm_delete_window $term, $event	384	=item on_wm_delete_window $term, $event
690		385
691	Called when various types of ClientMessage events are received (all with	386	Called when various types of ClientMessage events are received (all with
692	format=32, WM_PROTOCOLS or WM_PROTOCOLS:WM_DELETE_WINDOW).	387	format=32, WM_PROTOCOLS or WM_PROTOCOLS:WM_DELETE_WINDOW).
693		388
		389	=item on_bell $term
		390
		391	Called on receipt of a bell character.
		392
694	=back	393	=back
695		394
696	=cut	395	=cut
697		396
698	package urxvt;	397	package urxvt;
699		398
700	use utf8;	399	use utf8;
701	use strict;	400	use strict 'vars';
702	use Carp ();	401	use Carp ();
703	use Scalar::Util ();	402	use Scalar::Util ();
704	use List::Util ();	403	use List::Util ();
705		404
706	our $VERSION = 1;	405	our $VERSION = 1;
707	our $TERM;	406	our $TERM;
708	our @TERM_INIT;	407	our @TERM_INIT; # should go, prevents async I/O etc.
709	our @TERM_EXT;	408	our @TERM_EXT; # should go, prevents async I/O etc.
710	our @HOOKNAME;	409	our @HOOKNAME;
711	our %HOOKTYPE = map +($HOOKNAME[$_] => $_), 0..$#HOOKNAME;	410	our %HOOKTYPE = map +($HOOKNAME[$_] => $_), 0..$#HOOKNAME;
712	our %OPTION;	411	our %OPTION;
713		412
714	our $LIBDIR;	413	our $LIBDIR;
…		…
762		461
763	=over 4	462	=over 4
764		463
765	=item urxvt::fatal $errormessage	464	=item urxvt::fatal $errormessage
766		465
767	Fatally aborts execution with the given error message. Avoid at all	466	Fatally aborts execution with the given error message (which should
768	costs! The only time this is acceptable is when the terminal process	467	include a trailing newline). Avoid at all costs! The only time this
769	starts up.	468	is acceptable (and useful) is in the init hook, where it prevents the
		469	terminal from starting up.
770		470
771	=item urxvt::warn $string	471	=item urxvt::warn $string
772		472
773	Calls C<rxvt_warn> with the given string which should not include a	473	Calls C<rxvt_warn> with the given string which should include a trailing
774	newline. The module also overwrites the C<warn> builtin with a function	474	newline. The module also overwrites the C<warn> builtin with a function
775	that calls this function.	475	that calls this function.
776		476
777	Using this function has the advantage that its output ends up in the	477	Using this function has the advantage that its output ends up in the
778	correct place, e.g. on stderr of the connecting urxvtc client.	478	correct place, e.g. on stderr of the connecting urxvtc client.
…		…
782	=item @terms = urxvt::termlist	482	=item @terms = urxvt::termlist
783		483
784	Returns all urxvt::term objects that exist in this process, regardless of	484	Returns all urxvt::term objects that exist in this process, regardless of
785	whether they are started, being destroyed etc., so be careful. Only term	485	whether they are started, being destroyed etc., so be careful. Only term
786	objects that have perl extensions attached will be returned (because there	486	objects that have perl extensions attached will be returned (because there
787	is no urxvt::term objet associated with others).	487	is no urxvt::term object associated with others).
788		488
789	=item $time = urxvt::NOW	489	=item $time = urxvt::NOW
790		490
791	Returns the "current time" (as per the event loop).	491	Returns the "current time" (as per the event loop).
792		492
…		…
812	CirculateRequest, PropertyNotify, SelectionClear, SelectionRequest,	512	CirculateRequest, PropertyNotify, SelectionClear, SelectionRequest,
813	SelectionNotify, ColormapNotify, ClientMessage, MappingNotify	513	SelectionNotify, ColormapNotify, ClientMessage, MappingNotify
814		514
815	Various constants for use in X calls and event processing.	515	Various constants for use in X calls and event processing.
816		516
		517	=item urxvt::PrivMode_132, PrivMode_132OK, PrivMode_rVideo, PrivMode_relOrigin,
		518	PrivMode_Screen, PrivMode_Autowrap, PrivMode_aplCUR, PrivMode_aplKP,
		519	PrivMode_HaveBackSpace, PrivMode_BackSpace, PrivMode_ShiftKeys,
		520	PrivMode_VisibleCursor, PrivMode_MouseX10, PrivMode_MouseX11,
		521	PrivMode_scrollBar, PrivMode_TtyOutputInh, PrivMode_Keypress,
		522	PrivMode_smoothScroll, PrivMode_vt52, PrivMode_LFNL, PrivMode_MouseBtnEvent,
		523	PrivMode_MouseAnyEvent, PrivMode_BracketPaste, PrivMode_ExtModeMouse,
		524	PrivMode_ExtMouseRight, PrivMode_BlinkingCursor, PrivMode_mouse_report,
		525	PrivMode_Default
		526
		527	Constants for checking DEC private modes.
		528
817	=back	529	=back
818		530
819	=head2 RENDITION	531	=head2 RENDITION
820		532
821	Rendition bitsets contain information about colour, font, font styles and	533	Rendition bitsets contain information about colour, font, font styles and
…		…
835		547
836	=item $rend = urxvt::OVERLAY_RSTYLE	548	=item $rend = urxvt::OVERLAY_RSTYLE
837		549
838	Return the rendition mask used for overlays by default.	550	Return the rendition mask used for overlays by default.
839		551
840	=item $rendbit = urxvt::RS_Bold, RS_Italic, RS_Blink, RS_RVid, RS_Uline	552	=item $rendbit = urxvt::RS_Bold, urxvt::RS_Italic, urxvt::RS_Blink,
		553	urxvt::RS_RVid, urxvt::RS_Uline
841		554
842	Return the bit that enabled bold, italic, blink, reverse-video and	555	Return the bit that enabled bold, italic, blink, reverse-video and
843	underline, respectively. To enable such a style, just logically OR it into	556	underline, respectively. To enable such a style, just logically OR it into
844	the bitset.	557	the bitset.
845		558
…		…
882	};	595	};
883	}	596	}
884		597
885	no warnings 'utf8';	598	no warnings 'utf8';
886		599
		600	sub parse_resource {
		601	my ($term, $name, $isarg, $longopt, $flag, $value) = @_;
		602
		603	$term->scan_extensions;
		604
		605	my $r = $term->{meta}{resource};
		606	keys %$r; # reset iterator
		607	while (my ($k, $v) = each %$r) {
		608	my $pattern = $k;
		609	$pattern =~ y/./-/ if $isarg;
		610	my $prefix = $name;
		611	my $suffix;
		612	if ($pattern =~ /\-$/) {
		613	$prefix = substr $name, 0, length $pattern;
		614	$suffix = substr $name, length $pattern;
		615	}
		616	if ($pattern eq $prefix) {
		617	$name = "$urxvt::RESCLASS.$k$suffix";
		618
		619	push @{ $term->{perl_ext_3} }, $v->[0];
		620
		621	return 1 unless $isarg;
		622
		623	if ($v->[1] eq "boolean") {
		624	$term->put_option_db ($name, $flag ? "true" : "false");
		625	return 1;
		626	} else {
		627	$term->put_option_db ($name, $value);
		628	return 1 + 2;
		629	}
		630	}
		631	}
		632
		633	0
		634	}
		635
		636	sub usage {
		637	my ($term, $usage_type) = @_;
		638
		639	$term->scan_extensions;
		640
		641	my $r = $term->{meta}{resource};
		642
		643	for my $pattern (sort keys %$r) {
		644	my ($ext, $type, $desc) = @{ $r->{$pattern} };
		645
		646	$desc .= " (-pe $ext)";
		647
		648	if ($usage_type == 1) {
		649	$pattern =~ y/./-/;
		650	$pattern =~ s/-$/-.../g;
		651
		652	if ($type eq "boolean") {
		653	urxvt::log sprintf " -%-30s %s\n", "/+$pattern", $desc;
		654	} else {
		655	urxvt::log sprintf " -%-30s %s\n", "$pattern $type", $desc;
		656	}
		657	} else {
		658	$pattern =~ s/\.$/.*/g;
		659	urxvt::log sprintf " %-31s %s\n", "$pattern:", $type;
		660	}
		661	}
		662	}
		663
887	my $verbosity = $ENV{URXVT_PERL_VERBOSITY};	664	my $verbosity = $ENV{URXVT_PERL_VERBOSITY};
888		665
889	sub verbose {	666	sub verbose {
890	my ($level, $msg) = @_;	667	my ($level, $msg) = @_;
891	warn "$msg\n" if $level <= $verbosity;	668	warn "$msg\n" if $level <= $verbosity;
…		…
903	$pkg =~ s/[^[:word:]]/_/g;	680	$pkg =~ s/[^[:word:]]/_/g;
904	$pkg = "urxvt::ext::$pkg";	681	$pkg = "urxvt::ext::$pkg";
905		682
906	verbose 3, "loading extension '$path' into package '$pkg'";	683	verbose 3, "loading extension '$path' into package '$pkg'";
907		684
		685	(${"$pkg\::_NAME"} = $path) =~ s/^.*[\\\/]//; # hackish
		686
908	open my $fh, "<:raw", $path	687	open my $fh, "<:raw", $path
909	or die "$path: $!";	688	or die "$path: $!";
910		689
911	my $source =	690	my $source =
912	"package $pkg; use strict; use utf8; no warnings 'utf8';\n"	691	"package $pkg; use strict 'vars'; use utf8; no warnings 'utf8';\n"
913	. "#line 1 \"$path\"\n{\n"	692	. "#line 1 \"$path\"\n{\n"
914	. (do { local $/; <$fh> })	693	. (do { local $/; <$fh> })
915	. "\n};\n1";	694	. "\n};\n1";
916		695
917	eval $source	696	eval $source
…		…
926	# called by the rxvt core	705	# called by the rxvt core
927	sub invoke {	706	sub invoke {
928	local $TERM = shift;	707	local $TERM = shift;
929	my $htype = shift;	708	my $htype = shift;
930		709
931	if ($htype == 0) { # INIT	710	if ($htype == HOOK_INIT) {
932	my @dirs = ((split /:/, $TERM->resource ("perl_lib")), "$LIBDIR/perl");	711	my @dirs = $TERM->perl_libdirs;
		712
		713	$TERM->scan_extensions;
933		714
934	my %ext_arg;	715	my %ext_arg;
935		716
936	{	717	{
937	my @init = @TERM_INIT;	718	my @init = @TERM_INIT;
…		…
940	my @pkg = @TERM_EXT;	721	my @pkg = @TERM_EXT;
941	@TERM_EXT = ();	722	@TERM_EXT = ();
942	$TERM->register_package ($_) for @pkg;	723	$TERM->register_package ($_) for @pkg;
943	}	724	}
944		725
		726	for (
945	for (grep $_, map { split /,/, $TERM->resource ("perl_ext_$_") } 1, 2) {	727	(grep $_, map { split /,/, $TERM->resource ("perl_ext_$_") } 1, 2),
		728	@{ delete $TERM->{perl_ext_3} }
		729	) {
946	if ($_ eq "default") {	730	if ($_ eq "default") {
		731
		732	$ext_arg{$_} = []
947	$ext_arg{$_} ||= [] for qw(selection option-popup selection-popup searchable-scrollback readline);	733	for qw(selection option-popup selection-popup readline searchable-scrollback);
		734
		735	for ($TERM->_keysym_resources) {
		736	next if /^(?:string|command|builtin|builtin-string|perl)/;
		737	next unless /^([A-Za-z0-9_\-]+):/;
		738
		739	my $ext = $1;
		740
		741	$ext_arg{$ext} = [];
		742	}
		743
948	} elsif (/^-(.*)$/) {	744	} elsif (/^-(.*)$/) {
949	delete $ext_arg{$1};	745	delete $ext_arg{$1};
		746
950	} elsif (/^([^<]+)<(.*)>$/) {	747	} elsif (/^([^<]+)<(.*)>$/) {
951	push @{ $ext_arg{$1} }, $2;	748	push @{ $ext_arg{$1} }, $2;
		749
952	} else {	750	} else {
953	$ext_arg{$_} ||= [];	751	$ext_arg{$_} ||= [];
954	}	752	}
955	}	753	}
956		754
…		…
972		770
973	if (my $cb = $TERM->{_hook}[$htype]) {	771	if (my $cb = $TERM->{_hook}[$htype]) {
974	verbose 10, "$HOOKNAME[$htype] (" . (join ", ", $TERM, @_) . ")"	772	verbose 10, "$HOOKNAME[$htype] (" . (join ", ", $TERM, @_) . ")"
975	if $verbosity >= 10;	773	if $verbosity >= 10;
976		774
		775	if ($htype == HOOK_ACTION) {
		776	# this hook is only sent to the extension with the name
		777	# matching the first arg
		778	my $pkg = shift;
		779	$pkg =~ y/-/_/;
		780	$pkg = "urxvt::ext::$pkg";
		781
		782	$cb = $cb->{$pkg}
		783	or return undef; #TODO: maybe warn user?
		784
		785	$cb = { $pkg => $cb };
		786	}
		787
977	for my $pkg (keys %$cb) {	788	for my $pkg (keys %$cb) {
978	my $retval_ = eval { $cb->{$pkg}->($TERM->{_pkg}{$pkg}, @_) };	789	my $retval_ = eval { $cb->{$pkg}->($TERM->{_pkg}{$pkg} || $TERM, @_) };
979	$retval ||= $retval_;	790	$retval ||= $retval_;
980		791
981	if ($@) {	792	if ($@) {
982	$TERM->ungrab; # better to lose the grab than the session	793	$TERM->ungrab; # better to lose the grab than the session
983	warn $@;	794	warn $@;
…		…
986		797
987	verbose 11, "$HOOKNAME[$htype] returning <$retval>"	798	verbose 11, "$HOOKNAME[$htype] returning <$retval>"
988	if $verbosity >= 11;	799	if $verbosity >= 11;
989	}	800	}
990		801
991	if ($htype == 1) { # DESTROY	802	if ($htype == HOOK_DESTROY) {
992	# clear package objects	803	# clear package objects
993	%$_ = () for values %{ $TERM->{_pkg} };	804	%$_ = () for values %{ $TERM->{_pkg} };
994		805
995	# clear package	806	# clear package
996	%$TERM = ();	807	%$TERM = ();
…		…
1026	}	837	}
1027	}	838	}
1028	($mask, @color{qw(fg bg)}, \@failed)	839	($mask, @color{qw(fg bg)}, \@failed)
1029	}	840	}
1030		841
1031	# urxvt::term::extension
1032
1033	package urxvt::term::extension;	842	package urxvt::term::extension;
1034		843
1035	sub enable {	844	=head2 The C<urxvt::term::extension> class
1036	my ($self, %hook) = @_;
1037	my $pkg = $self->{_pkg};
1038		845
1039	while (my ($name, $cb) = each %hook) {	846	Each extension attached to a terminal object is represented by
1040	my $htype = $HOOKTYPE{uc $name};	847	a C<urxvt::term::extension> object.
1041	defined $htype
1042	or Carp::croak "unsupported hook type '$name'";
1043		848
1044	$self->set_should_invoke ($htype, +1)	849	You can use these objects, which are passed to all callbacks to store any
1045	unless exists $self->{term}{_hook}[$htype]{$pkg};	850	state related to the terminal and extension instance.
1046		851
1047	$self->{term}{_hook}[$htype]{$pkg} = $cb;	852	The methods (And data members) documented below can be called on extension
1048	}	853	objects, in addition to call methods documented for the <urxvt::term>
1049	}	854	class.
1050		855
1051	sub disable {	856	=over 4
1052	my ($self, @hook) = @_;
1053	my $pkg = $self->{_pkg};
1054		857
1055	for my $name (@hook) {	858	=item $urxvt_term = $self->{term}
1056	my $htype = $HOOKTYPE{uc $name};
1057	defined $htype
1058	or Carp::croak "unsupported hook type '$name'";
1059		859
1060	$self->set_should_invoke ($htype, -1)	860	Returns the C<urxvt::term> object associated with this instance of the
1061	if delete $self->{term}{_hook}[$htype]{$pkg};	861	extension. This member I<must not> be changed in any way.
1062	}	862
1063	}	863	=cut
1064		864
1065	our $AUTOLOAD;	865	our $AUTOLOAD;
1066		866
1067	sub AUTOLOAD {	867	sub AUTOLOAD {
1068	$AUTOLOAD =~ /:([^:]+)$/	868	$AUTOLOAD =~ /:([^:]+)$/
…		…
1081		881
1082	sub DESTROY {	882	sub DESTROY {
1083	# nop	883	# nop
1084	}	884	}
1085		885
1086	# urxvt::destroy_hook	886	# urxvt::destroy_hook (basically a cheap Guard:: implementation)
1087		887
1088	sub urxvt::destroy_hook::DESTROY {	888	sub urxvt::destroy_hook::DESTROY {
1089	${$_[0]}->();	889	${$_[0]}->();
1090	}	890	}
1091		891
1092	sub urxvt::destroy_hook(&) {	892	sub urxvt::destroy_hook(&) {
1093	bless \shift, urxvt::destroy_hook::	893	bless \shift, urxvt::destroy_hook::
1094	}	894	}
		895
		896	=item $self->enable ($hook_name => $cb[, $hook_name => $cb..])
		897
		898	Dynamically enable the given hooks (named without the C<on_> prefix) for
		899	this extension, replacing any hook previously installed via C<enable> in
		900	this extension.
		901
		902	This is useful when you want to overwrite time-critical hooks only
		903	temporarily.
		904
		905	To install additional callbacks for the same hook, you can use the C<on>
		906	method of the C<urxvt::term> class.
		907
		908	=item $self->disable ($hook_name[, $hook_name..])
		909
		910	Dynamically disable the given hooks.
		911
		912	=cut
		913
		914	sub enable {
		915	my ($self, %hook) = @_;
		916	my $pkg = $self->{_pkg};
		917
		918	while (my ($name, $cb) = each %hook) {
		919	my $htype = $HOOKTYPE{uc $name};
		920	defined $htype
		921	or Carp::croak "unsupported hook type '$name'";
		922
		923	$self->set_should_invoke ($htype, +1)
		924	unless exists $self->{term}{_hook}[$htype]{$pkg};
		925
		926	$self->{term}{_hook}[$htype]{$pkg} = $cb;
		927	}
		928	}
		929
		930	sub disable {
		931	my ($self, @hook) = @_;
		932	my $pkg = $self->{_pkg};
		933
		934	for my $name (@hook) {
		935	my $htype = $HOOKTYPE{uc $name};
		936	defined $htype
		937	or Carp::croak "unsupported hook type '$name'";
		938
		939	$self->set_should_invoke ($htype, -1)
		940	if delete $self->{term}{_hook}[$htype]{$pkg};
		941	}
		942	}
		943
		944	=item $guard = $self->on ($hook_name => $cb[, $hook_name => $cb..])
		945
		946	Similar to the C<enable> enable, but installs additional callbacks for
		947	the given hook(s) (that is, it doesn't replace existing callbacks), and
		948	returns a guard object. When the guard object is destroyed the callbacks
		949	are disabled again.
		950
		951	=cut
		952
		953	sub urxvt::extension::on_disable::DESTROY {
		954	my $disable = shift;
		955
		956	my $term = delete $disable->{""};
		957
		958	while (my ($htype, $id) = each %$disable) {
		959	delete $term->{_hook}[$htype]{$id};
		960	$term->set_should_invoke ($htype, -1);
		961	}
		962	}
		963
		964	sub on {
		965	my ($self, %hook) = @_;
		966
		967	my $term = $self->{term};
		968
		969	my %disable = ( "" => $term );
		970
		971	while (my ($name, $cb) = each %hook) {
		972	my $htype = $HOOKTYPE{uc $name};
		973	defined $htype
		974	or Carp::croak "unsupported hook type '$name'";
		975
		976	$term->set_should_invoke ($htype, +1);
		977	$term->{_hook}[$htype]{ $disable{$htype} = $cb+0 }
		978	= sub { shift; $cb->($self, @_) }; # very ugly indeed
		979	}
		980
		981	bless \%disable, "urxvt::extension::on_disable"
		982	}
		983
		984	=item $self->bind_action ($hotkey, $action)
		985
		986	=item $self->x_resource ($pattern)
		987
		988	=item $self->x_resource_boolean ($pattern)
		989
		990	These methods support an additional C<%> prefix for C<$action> or
		991	C<$pattern> when called on an extension object, compared to the
		992	C<urxvt::term> methods of the same name - see the description of these
		993	methods in the C<urxvt::term> class for details.
		994
		995	=cut
		996
		997	sub bind_action {
		998	my ($self, $hotkey, $action) = @_;
		999	$action =~ s/^%:/$_[0]{_name}:/;
		1000	$self->{term}->bind_action ($hotkey, $action)
		1001	}
		1002
		1003	sub x_resource {
		1004	my ($self, $name) = @_;
		1005	$name =~ s/^%(\.|$)/$_[0]{_name}$1/;
		1006	$self->{term}->x_resource ($name)
		1007	}
		1008
		1009	sub x_resource_boolean {
		1010	my ($self, $name) = @_;
		1011	$name =~ s/^%(\.|$)/$_[0]{_name}$1/;
		1012	$self->{term}->x_resource_boolean ($name)
		1013	}
		1014
		1015	=back
		1016
		1017	=cut
1095		1018
1096	package urxvt::anyevent;	1019	package urxvt::anyevent;
1097		1020
1098	=head2 The C<urxvt::anyevent> Class	1021	=head2 The C<urxvt::anyevent> Class
1099		1022
1100	The sole purpose of this class is to deliver an interface to the	1023	The sole purpose of this class is to deliver an interface to the
1101	C<AnyEvent> module - any module using it will work inside urxvt without	1024	C<AnyEvent> module - any module using it will work inside urxvt without
1102	further programming. The only exception is that you cannot wait on	1025	further programming. The only exception is that you cannot wait on
1103	condition variables, but non-blocking condvar use is ok. What this means	1026	condition variables, but non-blocking condvar use is ok.
1104	is that you cannot use blocking APIs, but the non-blocking variant should
1105	work.
1106		1027
1107	=cut	1028	In practical terms this means is that you cannot use blocking APIs, but
		1029	the non-blocking variant should work.
1108		1030
		1031	=cut
		1032
1109	our $VERSION = 1;	1033	our $VERSION = '5.23';
1110		1034
1111	$INC{"urxvt/anyevent.pm"} = 1; # mark us as there	1035	$INC{"urxvt/anyevent.pm"} = 1; # mark us as there
1112	push @AnyEvent::REGISTRY, [urxvt => urxvt::anyevent::];	1036	push @AnyEvent::REGISTRY, [urxvt => urxvt::anyevent::];
1113		1037
1114	sub timer {	1038	sub timer {
…		…
1116		1040
1117	my $cb = $arg{cb};	1041	my $cb = $arg{cb};
1118		1042
1119	urxvt::timer	1043	urxvt::timer
1120	->new	1044	->new
1121	->start (urxvt::NOW + $arg{after})	1045	->after ($arg{after}, $arg{interval})
1122	->cb (sub {	1046	->cb ($arg{interval} ? $cb : sub {
1123	$_[0]->stop; # need to cancel manually	1047	$_[0]->stop; # need to cancel manually
1124	$cb->();	1048	$cb->();
1125	})	1049	})
1126	}	1050	}
1127		1051
1128	sub io {	1052	sub io {
1129	my ($class, %arg) = @_;	1053	my ($class, %arg) = @_;
1130		1054
1131	my $cb = $arg{cb};	1055	my $cb = $arg{cb};
		1056	my $fd = fileno $arg{fh};
		1057	defined $fd or $fd = $arg{fh};
1132		1058
1133	bless [$arg{fh}, urxvt::iow	1059	bless [$arg{fh}, urxvt::iow
1134	->new	1060	->new
1135	->fd (fileno $arg{fh})	1061	->fd ($fd)
1136	->events (($arg{poll} =~ /r/ ? 1 : 0)	1062	->events (($arg{poll} =~ /r/ ? 1 : 0)
1137	| ($arg{poll} =~ /w/ ? 2 : 0))	1063	| ($arg{poll} =~ /w/ ? 2 : 0))
1138	->start	1064	->start
1139	->cb (sub {	1065	->cb ($cb)
1140	$cb->(($_[1] & 1 ? 'r' : '')
1141	. ($_[1] & 2 ? 'w' : ''));
1142	})],
1143	urxvt::anyevent::	1066	], urxvt::anyevent::
		1067	}
		1068
		1069	sub idle {
		1070	my ($class, %arg) = @_;
		1071
		1072	my $cb = $arg{cb};
		1073
		1074	urxvt::iw
		1075	->new
		1076	->start
		1077	->cb ($cb)
		1078	}
		1079
		1080	sub child {
		1081	my ($class, %arg) = @_;
		1082
		1083	my $cb = $arg{cb};
		1084
		1085	urxvt::pw
		1086	->new
		1087	->start ($arg{pid})
		1088	->cb (sub {
		1089	$_[0]->stop; # need to cancel manually
		1090	$cb->($_[0]->rpid, $_[0]->rstatus);
		1091	})
1144	}	1092	}
1145		1093
1146	sub DESTROY {	1094	sub DESTROY {
1147	$_[0][1]->stop;	1095	$_[0][1]->stop;
1148	}	1096	}
1149		1097
1150	sub condvar {	1098	# only needed for AnyEvent < 6 compatibility
1151	bless \my $flag, urxvt::anyevent::
1152	}
1153
1154	sub broadcast {
1155	${$_[0]}++;
1156	}
1157
1158	sub wait {
1159	unless (${$_[0]}) {
1160	Carp::croak "AnyEvent->condvar blocking wait unsupported in urxvt, use a non-blocking API";
1161	}
1162	}
1163
1164	sub one_event {	1099	sub one_event {
1165	Carp::croak "AnyEvent->one_event blocking wait unsupported in urxvt, use a non-blocking API";	1100	Carp::croak "AnyEvent->one_event blocking wait unsupported in urxvt, use a non-blocking API";
1166	}	1101	}
1167		1102
1168	package urxvt::term;	1103	package urxvt::term;
…		…
1183	urxvt::verbose 6, "register package $pkg to $self";	1118	urxvt::verbose 6, "register package $pkg to $self";
1184		1119
1185	@{"$pkg\::ISA"} = urxvt::term::extension::;	1120	@{"$pkg\::ISA"} = urxvt::term::extension::;
1186		1121
1187	my $proxy = bless {	1122	my $proxy = bless {
1188	_pkg => $pkg,	1123	_pkg => $pkg,
		1124	_name => ${"$pkg\::_NAME"}, # hackish
1189	argv => $argv,	1125	argv => $argv,
1190	}, $pkg;	1126	}, $pkg;
1191	Scalar::Util::weaken ($proxy->{term} = $self);	1127	Scalar::Util::weaken ($proxy->{term} = $self);
1192		1128
1193	$self->{_pkg}{$pkg} = $proxy;	1129	$self->{_pkg}{$pkg} = $proxy;
1194		1130
…		…
1197	$proxy->enable ($name => $ref);	1133	$proxy->enable ($name => $ref);
1198	}	1134	}
1199	}	1135	}
1200	}	1136	}
1201		1137
		1138	sub perl_libdirs {
		1139	map { split /:/ }
		1140	$_[0]->resource ("perl_lib"),
		1141	$ENV{URXVT_PERL_LIB},
		1142	"$ENV{HOME}/.urxvt/ext",
		1143	"$LIBDIR/perl"
		1144	}
		1145
		1146	# scan for available extensions and collect their metadata
		1147	sub scan_extensions {
		1148	my ($self) = @_;
		1149
		1150	return if exists $self->{meta};
		1151
		1152	my @urxvtdirs = perl_libdirs $self;
		1153	# my @cpandirs = grep -d, map "$_/URxvt/Ext", @INC;
		1154
		1155	$self->{meta} = \my %meta;
		1156
		1157	# first gather extensions
		1158
		1159	my $gather = sub {
		1160	my ($dir, $core) = @_;
		1161
		1162	opendir my $fh, $dir
		1163	or return;
		1164
		1165	for my $ext (readdir $fh) {
		1166	$ext !~ /^\./
		1167	or next;
		1168
		1169	open my $fh, "<", "$dir/$ext"
		1170	or next;
		1171
		1172	-f $fh
		1173	or next;
		1174
		1175	$ext =~ s/\.uext$// or $core
		1176	or next;
		1177
		1178	my %ext = (dir => $dir);
		1179
		1180	while (<$fh>) {
		1181	if (/^#:META:(?:X_)?RESOURCE:(.*)/) {
		1182	my ($pattern, $type, $desc) = split /:/, $1;
		1183	$pattern =~ s/^%(\.|$)/$ext$1/g; # % in pattern == extension name
		1184	if ($pattern =~ /[^a-zA-Z0-9\-\.]/) {
		1185	warn "$dir/$ext: meta resource '$pattern' contains illegal characters (not alphanumeric nor . nor *)\n";
		1186	} else {
		1187	$ext{resource}{$pattern} = [$ext, $type, $desc];
		1188	}
		1189	} elsif (/^\s*(?:#|$)/) {
		1190	# skip other comments and empty lines
		1191	} else {
		1192	last; # stop parsing on first non-empty non-comment line
		1193	}
		1194	}
		1195
		1196	$meta{ext}{$ext} = \%ext;
		1197	}
		1198	};
		1199
		1200	# $gather->($_, 0) for @cpandirs;
		1201	$gather->($_, 1) for @urxvtdirs;
		1202
		1203	# and now merge resources
		1204
		1205	$meta{resource} = \my %resource;
		1206
		1207	while (my ($k, $v) = each %{ $meta{ext} }) {
		1208	#TODO: should check for extensions overriding each other
		1209	%resource = (%resource, %{ $v->{resource} });
		1210	}
		1211	}
		1212
1202	=item $term = new urxvt::term $envhashref, $rxvtname, [arg...]	1213	=item $term = new urxvt::term $envhashref, $rxvtname, [arg...]
1203		1214
1204	Creates a new terminal, very similar as if you had started it with system	1215	Creates a new terminal, very similar as if you had started it with system
1205	C<$rxvtname, arg...>. C<$envhashref> must be a reference to a C<%ENV>-like	1216	C<$rxvtname, arg...>. C<$envhashref> must be a reference to a C<%ENV>-like
1206	hash which defines the environment of the new terminal.	1217	hash which defines the environment of the new terminal.
…		…
1223	}	1234	}
1224		1235
1225	=item $term->destroy	1236	=item $term->destroy
1226		1237
1227	Destroy the terminal object (close the window, free resources	1238	Destroy the terminal object (close the window, free resources
1228	etc.). Please note that @@RXVT_NAME@@ will not exit as long as any event	1239	etc.). Please note that urxvt will not exit as long as any event
1229	watchers (timers, io watchers) are still active.	1240	watchers (timers, io watchers) are still active.
1230		1241
1231	=item $term->exec_async ($cmd[, @args])	1242	=item $term->exec_async ($cmd[, @args])
1232		1243
1233	Works like the combination of the C<fork>/C<exec> builtins, which executes	1244	Works like the combination of the C<fork>/C<exec> builtins, which executes
…		…
1260	C<%urxvt::OPTION>. Options not enabled in this binary are not in the hash.	1271	C<%urxvt::OPTION>. Options not enabled in this binary are not in the hash.
1261		1272
1262	Here is a likely non-exhaustive list of option names, please see the	1273	Here is a likely non-exhaustive list of option names, please see the
1263	source file F</src/optinc.h> to see the actual list:	1274	source file F</src/optinc.h> to see the actual list:
1264		1275
1265	borderLess console cursorBlink cursorUnderline hold iconic insecure	1276	borderLess buffered console cursorBlink cursorUnderline hold iconic
1266	intensityStyles jumpScroll loginShell mapAlert meta8 mouseWheelScrollPage	1277	insecure intensityStyles iso14755 iso14755_52 jumpScroll loginShell
1267	override-redirect pastableTabs pointerBlank reverseVideo scrollBar	1278	mapAlert meta8 mouseWheelScrollPage override_redirect pastableTabs
1268	scrollBar_floating scrollBar_right scrollTtyKeypress scrollTtyOutput	1279	pointerBlank reverseVideo scrollBar scrollBar_floating scrollBar_right
1269	scrollWithBuffer secondaryScreen secondaryScroll skipBuiltinGlyphs	1280	scrollTtyKeypress scrollTtyOutput scrollWithBuffer secondaryScreen
1270	transparent tripleclickwords utmpInhibit visualBell	1281	secondaryScroll skipBuiltinGlyphs skipScroll transparent tripleclickwords
		1282	urgentOnBell utmpInhibit visualBell
1271		1283
1272	=item $value = $term->resource ($name[, $newval])	1284	=item $value = $term->resource ($name[, $newval])
1273		1285
1274	Returns the current resource value associated with a given name and	1286	Returns the current resource value associated with a given name and
1275	optionally sets a new value. Setting values is most useful in the C<init>	1287	optionally sets a new value. Setting values is most useful in the C<init>
…		…
1288		1300
1289	Here is a likely non-exhaustive list of resource names, not all of which	1301	Here is a likely non-exhaustive list of resource names, not all of which
1290	are supported in every build, please see the source file F</src/rsinc.h>	1302	are supported in every build, please see the source file F</src/rsinc.h>
1291	to see the actual list:	1303	to see the actual list:
1292		1304
1293	answerbackstring backgroundPixmap backspace_key boldFont boldItalicFont	1305	answerbackstring backgroundPixmap backspace_key blurradius
1294	borderLess color cursorBlink cursorUnderline cutchars delete_key	1306	boldFont boldItalicFont borderLess buffered chdir color cursorBlink
1295	display_name embed ext_bwidth fade font geometry hold iconName	1307	cursorUnderline cutchars delete_key depth display_name embed ext_bwidth
1296	imFont imLocale inputMethod insecure int_bwidth intensityStyles	1308	fade font geometry hold iconName iconfile imFont imLocale inputMethod
		1309	insecure int_bwidth intensityStyles iso14755 iso14755_52 italicFont
1297	italicFont jumpScroll lineSpace loginShell mapAlert meta8 modifier	1310	jumpScroll letterSpace lineSpace loginShell mapAlert meta8 modifier
1298	mouseWheelScrollPage name override_redirect pastableTabs path perl_eval	1311	mouseWheelScrollPage name override_redirect pastableTabs path perl_eval
1299	perl_ext_1 perl_ext_2 perl_lib pointerBlank pointerBlankDelay	1312	perl_ext_1 perl_ext_2 perl_lib pointerBlank pointerBlankDelay
1300	preeditType print_pipe pty_fd reverseVideo saveLines scrollBar	1313	preeditType print_pipe pty_fd reverseVideo saveLines scrollBar
1301	scrollBar_align scrollBar_floating scrollBar_right scrollBar_thickness	1314	scrollBar_align scrollBar_floating scrollBar_right scrollBar_thickness
1302	scrollTtyKeypress scrollTtyOutput scrollWithBuffer scrollstyle	1315	scrollTtyKeypress scrollTtyOutput scrollWithBuffer scrollstyle
1303	secondaryScreen secondaryScroll selectstyle shade term_name title	1316	secondaryScreen secondaryScroll shade skipBuiltinGlyphs skipScroll
1304	transient_for transparent transparent_all tripleclickwords utmpInhibit	1317	term_name title transient_for transparent tripleclickwords urgentOnBell
1305	visualBell	1318	utmpInhibit visualBell
1306		1319
1307	=cut	1320	=cut
1308		1321
1309	sub resource($$;$) {	1322	sub resource($$;$) {
1310	my ($self, $name) = (shift, shift);	1323	my ($self, $name) = (shift, shift);
1311	unshift @_, $self, $name, ($name =~ s/\s*\+\s*(\d+)$// ? $1 : 0);	1324	unshift @_, $self, $name, ($name =~ s/\s*\+\s*(\d+)$// ? $1 : 0);
1312	&urxvt::term::_resource	1325	goto &urxvt::term::_resource
1313	}	1326	}
1314		1327
1315	=item $value = $term->x_resource ($pattern)	1328	=item $value = $term->x_resource ($pattern)
1316		1329
1317	Returns the X-Resource for the given pattern, excluding the program or	1330	Returns the X-Resource for the given pattern, excluding the program or
1318	class name, i.e. C<< $term->x_resource ("boldFont") >> should return the	1331	class name, i.e. C<< $term->x_resource ("boldFont") >> should return the
1319	same value as used by this instance of rxvt-unicode. Returns C<undef> if no	1332	same value as used by this instance of rxvt-unicode. Returns C<undef> if no
1320	resource with that pattern exists.	1333	resource with that pattern exists.
1321		1334
		1335	Extensions that define extra resources also need to call this method
		1336	to access their values.
		1337
		1338	If the method is called on an extension object (basically, from an
		1339	extension), then the special prefix C<%.> will be replaced by the name of
		1340	the extension and a dot, and the lone string C<%> will be replaced by the
		1341	extension name itself. This makes it possible to code extensions so you
		1342	can rename them and get a new set of resources without having to change
		1343	the actual code.
		1344
1322	This method should only be called during the C<on_start> hook, as there is	1345	This method should only be called during the C<on_start> hook, as there is
1323	only one resource database per display, and later invocations might return	1346	only one resource database per display, and later invocations might return
1324	the wrong resources.	1347	the wrong resources.
1325		1348
1326	=item $success = $term->parse_keysym ($keysym_spec, $command_string)	1349	=item $value = $term->x_resource_boolean ($pattern)
1327		1350
		1351	Like C<x_resource>, above, but interprets the string value as a boolean
		1352	and returns C<1> for true values, C<0> for false values and C<undef> if
		1353	the resource or option isn't specified.
		1354
		1355	You should always use this method to parse boolean resources.
		1356
		1357	=cut
		1358
		1359	sub x_resource_boolean {
		1360	my $res = &x_resource;
		1361
		1362	$res =~ /^\s*(?:true|yes|on|1)\s*$/i ? 1 : defined $res && 0
		1363	}
		1364
		1365	=item $action = $term->lookup_keysym ($keysym, $state)
		1366
		1367	Returns the action bound to key combination C<($keysym, $state)>,
		1368	if a binding for it exists, and C<undef> otherwise.
		1369
		1370	=item $success = $term->bind_action ($key, $action)
		1371
1328	Adds a keymap translation exactly as specified via a resource. See the	1372	Adds a key binding exactly as specified via a C<keysym> resource. See the
1329	C<keysym> resource in the @@RXVT_NAME@@(1) manpage.	1373	C<keysym> resource in the urxvt(1) manpage.
		1374
		1375	To add default bindings for actions, an extension should call C<<
		1376	->bind_action >> in its C<init> hook for every such binding. Doing it
		1377	in the C<init> hook allows users to override or remove the binding
		1378	again.
		1379
		1380	Example: the C<searchable-scrollback> by default binds itself
		1381	on C<Meta-s>, using C<< $self->bind_action >>, which calls C<<
		1382	$term->bind_action >>.
		1383
		1384	sub init {
		1385	my ($self) = @_;
		1386
		1387	$self->bind_action ("M-s" => "%:start");
		1388	}
1330		1389
1331	=item $rend = $term->rstyle ([$new_rstyle])	1390	=item $rend = $term->rstyle ([$new_rstyle])
1332		1391
1333	Return and optionally change the current rendition. Text that is output by	1392	Return and optionally change the current rendition. Text that is output by
1334	the terminal application will use this style.	1393	the terminal application will use this style.
…		…
1342		1401
1343	=item ($row, $col) = $term->selection_beg ([$row, $col])	1402	=item ($row, $col) = $term->selection_beg ([$row, $col])
1344		1403
1345	=item ($row, $col) = $term->selection_end ([$row, $col])	1404	=item ($row, $col) = $term->selection_end ([$row, $col])
1346		1405
1347	Return the current values of the selection mark, begin or end positions,	1406	Return the current values of the selection mark, begin or end positions.
1348	and optionally set them to new values.	1407
		1408	When arguments are given, then the selection coordinates are set to
		1409	C<$row> and C<$col>, and the selection screen is set to the current
		1410	screen.
		1411
		1412	=item $screen = $term->selection_screen ([$screen])
		1413
		1414	Returns the current selection screen, and then optionally sets it.
1349		1415
1350	=item $term->selection_make ($eventtime[, $rectangular])	1416	=item $term->selection_make ($eventtime[, $rectangular])
1351		1417
1352	Tries to make a selection as set by C<selection_beg> and	1418	Tries to make a selection as set by C<selection_beg> and
1353	C<selection_end>. If C<$rectangular> is true (default: false), a	1419	C<selection_end>. If C<$rectangular> is true (default: false), a
1354	rectangular selection will be made. This is the prefered function to make	1420	rectangular selection will be made. This is the preferred function to make
1355	a selection.	1421	a selection.
1356		1422
1357	=item $success = $term->selection_grab ($eventtime)	1423	=item $success = $term->selection_grab ($eventtime[, $clipboard])
1358		1424
1359	Try to request the primary selection text from the server (for example, as	1425	Try to acquire ownership of the primary (clipboard if C<$clipboard> is
		1426	true) selection from the server. The corresponding text can be set
1360	set by the next method). No visual feedback will be given. This function	1427	with the next method. No visual feedback will be given. This function
1361	is mostly useful from within C<on_sel_grab> hooks.	1428	is mostly useful from within C<on_sel_grab> hooks.
1362		1429
1363	=item $oldtext = $term->selection ([$newtext])	1430	=item $oldtext = $term->selection ([$newtext, $clipboard])
1364		1431
1365	Return the current selection text and optionally replace it by C<$newtext>.	1432	Return the current selection (clipboard if C<$clipboard> is true) text
		1433	and optionally replace it by C<$newtext>.
		1434
		1435	=item $term->selection_clear ([$clipboard])
		1436
		1437	Revoke ownership of the primary (clipboard if C<$clipboard> is true) selection.
1366		1438
1367	=item $term->overlay_simple ($x, $y, $text)	1439	=item $term->overlay_simple ($x, $y, $text)
1368		1440
1369	Create a simple multi-line overlay box. See the next method for details.	1441	Create a simple multi-line overlay box. See the next method for details.
1370		1442
…		…
1400		1472
1401	The methods currently supported on C<urxvt::overlay> objects are:	1473	The methods currently supported on C<urxvt::overlay> objects are:
1402		1474
1403	=over 4	1475	=over 4
1404		1476
1405	=item $overlay->set ($x, $y, $text, $rend)	1477	=item $overlay->set ($x, $y, $text[, $rend])
1406		1478
1407	Similar to C<< $term->ROW_t >> and C<< $term->ROW_r >> in that it puts	1479	Similar to C<< $term->ROW_t >> and C<< $term->ROW_r >> in that it puts
1408	text in rxvt-unicode's special encoding and an array of rendition values	1480	text in rxvt-unicode's special encoding and an array of rendition values
1409	at a specific position inside the overlay.	1481	at a specific position inside the overlay.
		1482
		1483	If C<$rend> is missing, then the rendition will not be changed.
1410		1484
1411	=item $overlay->hide	1485	=item $overlay->hide
1412		1486
1413	If visible, hide the overlay, but do not destroy it.	1487	If visible, hide the overlay, but do not destroy it.
1414		1488
…		…
1477		1551
1478	=item $term->scr_add_lines ($string)	1552	=item $term->scr_add_lines ($string)
1479		1553
1480	Write the given text string to the screen, as if output by the application	1554	Write the given text string to the screen, as if output by the application
1481	running inside the terminal. It may not contain command sequences (escape	1555	running inside the terminal. It may not contain command sequences (escape
1482	codes), but is free to use line feeds, carriage returns and tabs. The	1556	codes - see C<cmd_parse> for that), but is free to use line feeds,
1483	string is a normal text string, not in locale-dependent encoding.	1557	carriage returns and tabs. The string is a normal text string, not in
		1558	locale-dependent encoding.
1484		1559
1485	Normally its not a good idea to use this function, as programs might be	1560	Normally its not a good idea to use this function, as programs might be
1486	confused by changes in cursor position or scrolling. Its useful inside a	1561	confused by changes in cursor position or scrolling. Its useful inside a
1487	C<on_add_lines> hook, though.	1562	C<on_add_lines> hook, though.
1488		1563
…		…
1496	locale-specific encoding of the terminal and can contain command sequences	1571	locale-specific encoding of the terminal and can contain command sequences
1497	(escape codes) that will be interpreted.	1572	(escape codes) that will be interpreted.
1498		1573
1499	=item $term->tt_write ($octets)	1574	=item $term->tt_write ($octets)
1500		1575
1501	Write the octets given in C<$data> to the tty (i.e. as program input). To	1576	Write the octets given in C<$octets> to the tty (i.e. as user input
		1577	to the program, see C<cmd_parse> for the opposite direction). To pass
1502	pass characters instead of octets, you should convert your strings first	1578	characters instead of octets, you should convert your strings first to the
1503	to the locale-specific encoding using C<< $term->locale_encode >>.	1579	locale-specific encoding using C<< $term->locale_encode >>.
		1580
		1581	=item $term->tt_write_user_input ($octets)
		1582
		1583	Like C<tt_write>, but should be used when writing strings in response to
		1584	the user pressing a key, to invoke the additional actions requested by
		1585	the user for that case (C<tt_write> doesn't do that).
		1586
		1587	The typical use case would be inside C<on_action> hooks.
		1588
		1589	=item $term->tt_paste ($octets)
		1590
		1591	Write the octets given in C<$octets> to the tty as a paste, converting NL to
		1592	CR and bracketing the data with control sequences if bracketed paste mode
		1593	is set.
1504		1594
1505	=item $old_events = $term->pty_ev_events ([$new_events])	1595	=item $old_events = $term->pty_ev_events ([$new_events])
1506		1596
1507	Replaces the event mask of the pty watcher by the given event mask. Can	1597	Replaces the event mask of the pty watcher by the given event mask. Can
1508	be used to suppress input and output handling to the pty/tty. See the	1598	be used to suppress input and output handling to the pty/tty. See the
…		…
1527	Adds the specified events to the vt event mask. Useful e.g. when you want	1617	Adds the specified events to the vt event mask. Useful e.g. when you want
1528	to receive pointer events all the times:	1618	to receive pointer events all the times:
1529		1619
1530	$term->vt_emask_add (urxvt::PointerMotionMask);	1620	$term->vt_emask_add (urxvt::PointerMotionMask);
1531		1621
		1622	=item $term->set_urgency ($set)
		1623
		1624	Enable/disable the urgency hint on the toplevel window.
		1625
1532	=item $term->focus_in	1626	=item $term->focus_in
1533		1627
1534	=item $term->focus_out	1628	=item $term->focus_out
1535		1629
1536	=item $term->key_press ($state, $keycode[, $time])	1630	=item $term->key_press ($state, $keycode[, $time])
1537		1631
1538	=item $term->key_release ($state, $keycode[, $time])	1632	=item $term->key_release ($state, $keycode[, $time])
1539		1633
1540	Deliver various fake events to to terminal.	1634	Deliver various fake events to to terminal.
1541		1635
1542	=item $window_width = $term->width	1636	=item $window_width = $term->width ([$new_value])
1543		1637
1544	=item $window_height = $term->height	1638	=item $window_height = $term->height ([$new_value])
1545		1639
1546	=item $font_width = $term->fwidth	1640	=item $font_width = $term->fwidth ([$new_value])
1547		1641
1548	=item $font_height = $term->fheight	1642	=item $font_height = $term->fheight ([$new_value])
1549		1643
1550	=item $font_ascent = $term->fbase	1644	=item $font_ascent = $term->fbase ([$new_value])
1551		1645
1552	=item $terminal_rows = $term->nrow	1646	=item $terminal_rows = $term->nrow ([$new_value])
1553		1647
1554	=item $terminal_columns = $term->ncol	1648	=item $terminal_columns = $term->ncol ([$new_value])
1555		1649
1556	=item $has_focus = $term->focus	1650	=item $has_focus = $term->focus ([$new_value])
1557		1651
1558	=item $is_mapped = $term->mapped	1652	=item $is_mapped = $term->mapped ([$new_value])
1559		1653
1560	=item $max_scrollback = $term->saveLines	1654	=item $max_scrollback = $term->saveLines ([$new_value])
1561		1655
1562	=item $nrow_plus_saveLines = $term->total_rows	1656	=item $nrow_plus_saveLines = $term->total_rows ([$new_value])
1563		1657
1564	=item $topmost_scrollback_row = $term->top_row	1658	=item $topmost_scrollback_row = $term->top_row ([$new_value])
1565		1659
1566	Return various integers describing terminal characteristics.	1660	Return various integers describing terminal characteristics. If an
		1661	argument is given, changes the value and returns the previous one.
1567		1662
1568	=item $x_display = $term->display_id	1663	=item $x_display = $term->display_id
1569		1664
1570	Return the DISPLAY used by rxvt-unicode.	1665	Return the DISPLAY used by rxvt-unicode.
1571		1666
…		…
1607	Returns the currently displayed screen (0 primary, 1 secondary).	1702	Returns the currently displayed screen (0 primary, 1 secondary).
1608		1703
1609	=item $cursor_is_hidden = $term->hidden_cursor	1704	=item $cursor_is_hidden = $term->hidden_cursor
1610		1705
1611	Returns whether the cursor is currently hidden or not.	1706	Returns whether the cursor is currently hidden or not.
		1707
		1708	=item $priv_modes = $term->priv_modes
		1709
		1710	Returns a bitset with the state of DEC private modes.
		1711
		1712	Example:
		1713
		1714	if ($term->priv_modes & urxvt::PrivMode_mouse_report) {
		1715	# mouse reporting is turned on
		1716	}
1612		1717
1613	=item $view_start = $term->view_start ([$newvalue])	1718	=item $view_start = $term->view_start ([$newvalue])
1614		1719
1615	Returns the row number of the topmost displayed line. Maximum value is	1720	Returns the row number of the topmost displayed line. Maximum value is
1616	C<0>, which displays the normal terminal contents. Lower values scroll	1721	C<0>, which displays the normal terminal contents. Lower values scroll
…		…
1622	compare the on-screen display with its stored representation. If they	1727	compare the on-screen display with its stored representation. If they
1623	differ, it redraws the differences.	1728	differ, it redraws the differences.
1624		1729
1625	Used after changing terminal contents to display them.	1730	Used after changing terminal contents to display them.
1626		1731
		1732	=item $term->refresh_check
		1733
		1734	Checks if a refresh has been requested and, if so, schedules one.
		1735
1627	=item $text = $term->ROW_t ($row_number[, $new_text[, $start_col]])	1736	=item $text = $term->ROW_t ($row_number[, $new_text[, $start_col]])
1628		1737
1629	Returns the text of the entire row with number C<$row_number>. Row C<0>	1738	Returns the text of the entire row with number C<$row_number>. Row C<< $term->top_row >>
1630	is the topmost terminal line, row C<< $term->$ncol-1 >> is the bottommost	1739	is the topmost terminal line, row C<< $term->nrow-1 >> is the bottommost
1631	terminal line. The scrollback buffer starts at line C<-1> and extends to
1632	line C<< -$term->nsaved >>. Nothing will be returned if a nonexistent line	1740	terminal line. Nothing will be returned if a nonexistent line
1633	is requested.	1741	is requested.
1634		1742
1635	If C<$new_text> is specified, it will replace characters in the current	1743	If C<$new_text> is specified, it will replace characters in the current
1636	line, starting at column C<$start_col> (default C<0>), which is useful	1744	line, starting at column C<$start_col> (default C<0>), which is useful
1637	to replace only parts of a line. The font index in the rendition will	1745	to replace only parts of a line. The font index in the rendition will
1638	automatically be updated.	1746	automatically be updated.
1639		1747
1640	C<$text> is in a special encoding: tabs and wide characters that use more	1748	C<$text> is in a special encoding: tabs and wide characters that use more
1641	than one cell when displayed are padded with C<$urxvt::NOCHAR> (chr 65535)	1749	than one cell when displayed are padded with C<$urxvt::NOCHAR> (chr 65535)
1642	characters. Characters with combining characters and other characters that	1750	characters. Characters with combining characters and other characters that
1643	do not fit into the normal tetx encoding will be replaced with characters	1751	do not fit into the normal text encoding will be replaced with characters
1644	in the private use area.	1752	in the private use area.
1645		1753
1646	You have to obey this encoding when changing text. The advantage is	1754	You have to obey this encoding when changing text. The advantage is
1647	that C<substr> and similar functions work on screen cells and not on	1755	that C<substr> and similar functions work on screen cells and not on
1648	characters.	1756	characters.
…		…
1733	}	1841	}
1734		1842
1735	sub urxvt::line::t {	1843	sub urxvt::line::t {
1736	my ($self) = @_;	1844	my ($self) = @_;
1737		1845
1738	if (@_ > 1)	1846	if (@_ > 1) {
1739	{
1740	$self->{term}->ROW_t ($_, $_[1], 0, ($_ - $self->{beg}) * $self->{ncol}, $self->{ncol})	1847	$self->{term}->ROW_t ($_, $_[1], 0, ($_ - $self->{beg}) * $self->{ncol}, $self->{ncol})
1741	for $self->{beg} .. $self->{end};	1848	for $self->{beg} .. $self->{end};
1742	}	1849	}
1743		1850
1744	defined wantarray &&	1851	defined wantarray &&
1745	substr +(join "", map $self->{term}->ROW_t ($_), $self->{beg} .. $self->{end}),	1852	substr +(join "", map $self->{term}->ROW_t ($_), $self->{beg} .. $self->{end}),
1746	0, $self->{len}	1853	0, $self->{len}
1747	}	1854	}
1748		1855
1749	sub urxvt::line::r {	1856	sub urxvt::line::r {
1750	my ($self) = @_;	1857	my ($self) = @_;
1751		1858
1752	if (@_ > 1)	1859	if (@_ > 1) {
1753	{
1754	$self->{term}->ROW_r ($_, $_[1], 0, ($_ - $self->{beg}) * $self->{ncol}, $self->{ncol})	1860	$self->{term}->ROW_r ($_, $_[1], 0, ($_ - $self->{beg}) * $self->{ncol}, $self->{ncol})
1755	for $self->{beg} .. $self->{end};	1861	for $self->{beg} .. $self->{end};
1756	}	1862	}
1757		1863
1758	if (defined wantarray) {	1864	if (defined wantarray) {
1759	my $rend = [	1865	my $rend = [
1760	map @{ $self->{term}->ROW_r ($_) }, $self->{beg} .. $self->{end}	1866	map @{ $self->{term}->ROW_r ($_) }, $self->{beg} .. $self->{end}
1761	];	1867	];
…		…
1823	Calls XAllowEvents with both ReplayPointer and ReplayKeyboard for the most	1929	Calls XAllowEvents with both ReplayPointer and ReplayKeyboard for the most
1824	recent grab.	1930	recent grab.
1825		1931
1826	=item $term->ungrab	1932	=item $term->ungrab
1827		1933
1828	Calls XUngrab for the most recent grab. Is called automatically on	1934	Calls XUngrabPointer and XUngrabKeyboard for the most recent grab. Is called automatically on
1829	evaluation errors, as it is better to lose the grab in the error case as	1935	evaluation errors, as it is better to lose the grab in the error case as
1830	the session.	1936	the session.
1831		1937
1832	=item $atom = $term->XInternAtom ($atom_name[, $only_if_exists])	1938	=item $atom = $term->XInternAtom ($atom_name[, $only_if_exists])
1833		1939
…		…
1835		1941
1836	=item @atoms = $term->XListProperties ($window)	1942	=item @atoms = $term->XListProperties ($window)
1837		1943
1838	=item ($type,$format,$octets) = $term->XGetWindowProperty ($window, $property)	1944	=item ($type,$format,$octets) = $term->XGetWindowProperty ($window, $property)
1839		1945
1840	=item $term->XChangeWindowProperty ($window, $property, $type, $format, $octets)	1946	=item $term->XChangeProperty ($window, $property, $type, $format, $octets)
1841		1947
1842	=item $term->XDeleteProperty ($window, $property)	1948	=item $term->XDeleteProperty ($window, $property)
1843		1949
1844	=item $window = $term->DefaultRootWindow	1950	=item $window = $term->DefaultRootWindow
1845		1951
…		…
1852	=item $term->XMoveResizeWindow ($window, $x, $y, $width, $height)	1958	=item $term->XMoveResizeWindow ($window, $x, $y, $width, $height)
1853		1959
1854	=item ($x, $y, $child_window) = $term->XTranslateCoordinates ($src, $dst, $x, $y)	1960	=item ($x, $y, $child_window) = $term->XTranslateCoordinates ($src, $dst, $x, $y)
1855		1961
1856	=item $term->XChangeInput ($window, $add_events[, $del_events])	1962	=item $term->XChangeInput ($window, $add_events[, $del_events])
		1963
		1964	=item $keysym = $term->XStringToKeysym ($string)
		1965
		1966	=item $string = $term->XKeysymToString ($keysym)
1857		1967
1858	Various X or X-related functions. The C<$term> object only serves as	1968	Various X or X-related functions. The C<$term> object only serves as
1859	the source of the display, otherwise those functions map more-or-less	1969	the source of the display, otherwise those functions map more-or-less
1860	directory onto the X functions of the same name.	1970	directly onto the X functions of the same name.
1861		1971
1862	=back	1972	=back
1863		1973
1864	=cut	1974	=cut
1865		1975
…		…
1967	my $env = $self->{term}->env;	2077	my $env = $self->{term}->env;
1968	# we can't hope to reproduce the locale algorithm, so nuke LC_ALL and set LC_CTYPE.	2078	# we can't hope to reproduce the locale algorithm, so nuke LC_ALL and set LC_CTYPE.
1969	delete $env->{LC_ALL};	2079	delete $env->{LC_ALL};
1970	$env->{LC_CTYPE} = $self->{term}->locale;	2080	$env->{LC_CTYPE} = $self->{term}->locale;
1971		2081
1972	urxvt::term->new ($env, "popup",	2082	my $term = urxvt::term->new (
		2083	$env, "popup",
1973	"--perl-lib" => "", "--perl-ext-common" => "",	2084	"--perl-lib" => "", "--perl-ext-common" => "",
1974	"-pty-fd" => -1, "-sl" => 0,	2085	"-pty-fd" => -1, "-sl" => 0,
1975	"-b" => 1, "-bd" => "grey80", "-bl", "-override-redirect",	2086	"-b" => 1, "-bd" => "grey80", "-bl", "-override-redirect",
1976	"--transient-for" => $self->{term}->parent,	2087	"--transient-for" => $self->{term}->parent,
1977	"-display" => $self->{term}->display_id,	2088	"-display" => $self->{term}->display_id,
1978	"-pe" => "urxvt-popup")	2089	"-pe" => "urxvt-popup",
1979	or die "unable to create popup window\n";	2090	) or die "unable to create popup window\n";
		2091
		2092	unless (delete $term->{urxvt_popup_init_done}) {
		2093	$term->ungrab;
		2094	$term->destroy;
		2095	die "unable to initialise popup window\n";
		2096	}
1980	}	2097	}
1981		2098
1982	sub DESTROY {	2099	sub DESTROY {
1983	my ($self) = @_;	2100	my ($self) = @_;
1984		2101
…		…
2015		2132
2016	=item $timer = $timer->cb (sub { my ($timer) = @_; ... })	2133	=item $timer = $timer->cb (sub { my ($timer) = @_; ... })
2017		2134
2018	Set the callback to be called when the timer triggers.	2135	Set the callback to be called when the timer triggers.
2019		2136
2020	=item $tstamp = $timer->at
2021
2022	Return the time this watcher will fire next.
2023
2024	=item $timer = $timer->set ($tstamp)	2137	=item $timer = $timer->set ($tstamp[, $interval])
2025		2138
2026	Set the time the event is generated to $tstamp.	2139	Set the time the event is generated to $tstamp (and optionally specifies a
		2140	new $interval).
2027		2141
2028	=item $timer = $timer->interval ($interval)	2142	=item $timer = $timer->interval ($interval)
2029		2143
2030	Normally (and when C<$interval> is C<0>), the timer will automatically	2144	By default (and when C<$interval> is C<0>), the timer will automatically
2031	stop after it has fired once. If C<$interval> is non-zero, then the timer	2145	stop after it has fired once. If C<$interval> is non-zero, then the timer
2032	is automatically rescheduled at the given intervals.	2146	is automatically rescheduled at the given intervals.
2033		2147
2034	=item $timer = $timer->start	2148	=item $timer = $timer->start
2035		2149
2036	Start the timer.	2150	Start the timer.
2037		2151
2038	=item $timer = $timer->start ($tstamp)	2152	=item $timer = $timer->start ($tstamp[, $interval])
2039		2153
2040	Set the event trigger time to C<$tstamp> and start the timer.	2154	Set the event trigger time to C<$tstamp> and start the timer. Optionally
		2155	also replaces the interval.
2041		2156
2042	=item $timer = $timer->after ($delay)	2157	=item $timer = $timer->after ($delay[, $interval])
2043		2158
2044	Like C<start>, but sets the expiry timer to c<urxvt::NOW + $delay>.	2159	Like C<start>, but sets the expiry timer to c<urxvt::NOW + $delay>.
2045		2160
2046	=item $timer = $timer->stop	2161	=item $timer = $timer->stop
2047		2162
…		…
2055		2170
2056	$term->{socket} = ...	2171	$term->{socket} = ...
2057	$term->{iow} = urxvt::iow	2172	$term->{iow} = urxvt::iow
2058	->new	2173	->new
2059	->fd (fileno $term->{socket})	2174	->fd (fileno $term->{socket})
2060	->events (urxvt::EVENT_READ)	2175	->events (urxvt::EV_READ)
2061	->start	2176	->start
2062	->cb (sub {	2177	->cb (sub {
2063	my ($iow, $revents) = @_;	2178	my ($iow, $revents) = @_;
2064	# $revents must be 1 here, no need to check	2179	# $revents must be 1 here, no need to check
2065	sysread $term->{socket}, my $buf, 8192	2180	sysread $term->{socket}, my $buf, 8192
…		…
2083	Set the file descriptor (not handle) to watch.	2198	Set the file descriptor (not handle) to watch.
2084		2199
2085	=item $iow = $iow->events ($eventmask)	2200	=item $iow = $iow->events ($eventmask)
2086		2201
2087	Set the event mask to watch. The only allowed values are	2202	Set the event mask to watch. The only allowed values are
2088	C<urxvt::EVENT_READ> and C<urxvt::EVENT_WRITE>, which might be ORed	2203	C<urxvt::EV_READ> and C<urxvt::EV_WRITE>, which might be ORed
2089	together, or C<urxvt::EVENT_NONE>.	2204	together, or C<urxvt::EV_NONE>.
2090		2205
2091	=item $iow = $iow->start	2206	=item $iow = $iow->start
2092		2207
2093	Start watching for requested events on the given handle.	2208	Start watching for requested events on the given handle.
2094		2209
…		…
2178		2293
2179	=back	2294	=back
2180		2295
2181	=head1 AUTHOR	2296	=head1 AUTHOR
2182		2297
2183	Marc Lehmann <pcg@goof.com>	2298	Marc Lehmann <schmorp@schmorp.de>
2184	http://software.schmorp.de/pkg/rxvt-unicode	2299	http://software.schmorp.de/pkg/rxvt-unicode
2185		2300
2186	=cut	2301	=cut
2187		2302
2188	1	2303	1

Diff Legend

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