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.170 by root, Tue Sep 23 07:03:13 2008 UTC vs.
Revision 1.260 by root, Mon May 24 20:21:51 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 $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,selection-autotransform	46	URxvt.perl-ext-common: default,selection-autotransform
46		47
47	=over 4	48	Extensions may add additional resources and C<actions>, i.e., methods
48		49	which can be bound to a key and invoked by the user. An extension can
49	=item selection (enabled by default)	50	define the resources it support using so called META comments,
50		51	described below. Similarly to builtin resources, extension resources
51	(More) intelligent selection. This extension tries to be more intelligent	52	can also be specified on the command line as long options (with C<.>
52	when the user extends selections (double-click and further clicks). Right	53	replaced by C<->), in which case the corresponding extension is loaded
53	now, it tries to select words, urls and complete shell-quoted	54	automatically. For this to work the extension B<must> define META
54	arguments, which is very convenient, too, if your F<ls> supports	55	comments for its resources.
55	C<--quoting-style=shell>.
56
57	A double-click usually selects the word under the cursor, further clicks
58	will enlarge the selection.
59
60	The selection works by trying to match a number of regexes and displaying
61	them in increasing order of length. You can add your own regexes by
62	specifying resources of the form:
63
64	URxvt.selection.pattern-0: perl-regex
65	URxvt.selection.pattern-1: perl-regex
66	...
67
68	The index number (0, 1...) must not have any holes, and each regex must
69	contain at least one pair of capturing parentheses, which will be used for
70	the match. For example, the following adds a regex that matches everything
71	between two vertical bars:
72
73	URxvt.selection.pattern-0: \\|([^|]+)\\|
74
75	Another example: Programs I use often output "absolute path: " at the
76	beginning of a line when they process multiple files. The following
77	pattern matches the filename (note, there is a single space at the very
78	end):
79
80	URxvt.selection.pattern-0: ^(/[^:]+):\
81
82	You can look at the source of the selection extension to see more
83	interesting uses, such as parsing a line from beginning to end.
84
85	This extension also offers following bindable keyboard commands:
86
87	=over 4
88
89	=item rot13
90
91	Rot-13 the selection when activated. Used via keyboard trigger:
92
93	URxvt.keysym.C-M-r: perl:selection:rot13
94
95	=back
96
97	=item option-popup (enabled by default)
98
99	Binds a popup menu to Ctrl-Button2 that lets you toggle (some) options at
100	runtime.
101
102	Other extensions can extend this popup menu by pushing a code reference
103	onto C<@{ $term->{option_popup_hook} }>, which gets called whenever the
104	popup is being displayed.
105
106	Its sole argument is the popup menu, which can be modified. It should
107	either return nothing or a string, the initial boolean value and a code
108	reference. The string will be used as button text and the code reference
109	will be called when the toggle changes, with the new boolean value as
110	first argument.
111
112	The following will add an entry C<myoption> that changes
113	C<< $self->{myoption} >>:
114
115	push @{ $self->{term}{option_popup_hook} }, sub {
116	("my option" => $myoption, sub { $self->{myoption} = $_[0] })
117	};
118
119	=item selection-popup (enabled by default)
120
121	Binds a popup menu to Ctrl-Button3 that lets you convert the selection
122	text into various other formats/action (such as uri unescaping, perl
123	evaluation, web-browser starting etc.), depending on content.
124
125	Other extensions can extend this popup menu by pushing a code reference
126	onto C<@{ $term->{selection_popup_hook} }>, which gets called whenever the
127	popup is being displayed.
128
129	Its sole argument is the popup menu, which can be modified. The selection
130	is in C<$_>, which can be used to decide whether to add something or not.
131	It should either return nothing or a string and a code reference. The
132	string will be used as button text and the code reference will be called
133	when the button gets activated and should transform C<$_>.
134
135	The following will add an entry C<a to b> that transforms all C<a>s in
136	the selection to C<b>s, but only if the selection currently contains any
137	C<a>s:
138
139	push @{ $self->{term}{selection_popup_hook} }, sub {
140	/a/ ? ("a to b" => sub { s/a/b/g }
141	: ()
142	};
143
144	=item searchable-scrollback<hotkey> (enabled by default)
145
146	Adds regex search functionality to the scrollback buffer, triggered
147	by a hotkey (default: C<M-s>). While in search mode, normal terminal
148	input/output is suspended and a regex is displayed at the bottom of the
149	screen.
150
151	Inputting characters appends them to the regex and continues incremental
152	search. C<BackSpace> removes a character from the regex, C<Up> and C<Down>
153	search upwards/downwards in the scrollback buffer, C<End> jumps to the
154	bottom. C<Escape> leaves search mode and returns to the point where search
155	was started, while C<Enter> or C<Return> stay at the current position and
156	additionally stores the first match in the current line into the primary
157	selection if the C<Shift> modifier is active.
158
159	The regex defaults to "(?i)", resulting in a case-insensitive search. To
160	get a case-sensitive search you can delete this prefix using C<BackSpace>
161	or simply use an uppercase character which removes the "(?i)" prefix.
162
163	See L<perlre> for more info about perl regular expression syntax.
164
165	=item readline (enabled by default)
166
167	A support package that tries to make editing with readline easier. At
168	the moment, it reacts to clicking shift-left mouse button by trying to
169	move the text cursor to this position. It does so by generating as many
170	cursor-left or cursor-right keypresses as required (this only works
171	for programs that correctly support wide characters).
172
173	To avoid too many false positives, this is only done when:
174
175	=over 4
176
177	=item - the tty is in ICANON state.
178
179	=item - the text cursor is visible.
180
181	=item - the primary screen is currently being displayed.
182
183	=item - the mouse is on the same (multi-row-) line as the text cursor.
184
185	=back
186
187	The normal selection mechanism isn't disabled, so quick successive clicks
188	might interfere with selection creation in harmless ways.
189
190	=item selection-autotransform
191
192	This selection allows you to do automatic transforms on a selection
193	whenever a selection is made.
194
195	It works by specifying perl snippets (most useful is a single C<s///>
196	operator) that modify C<$_> as resources:
197
198	URxvt.selection-autotransform.0: transform
199	URxvt.selection-autotransform.1: transform
200	...
201
202	For example, the following will transform selections of the form
203	C<filename:number>, often seen in compiler messages, into C<vi +$filename
204	$word>:
205
206	URxvt.selection-autotransform.0: s/^([^:[:space:]]+):(\\d+):?$/vi +$2 \\Q$1\\E\\x0d/
207
208	And this example matches the same,but replaces it with vi-commands you can
209	paste directly into your (vi :) editor:
210
211	URxvt.selection-autotransform.0: s/^([^:[:space:]]+(\\d+):?$/:e \\Q$1\\E\\x0d:$2\\x0d/
212
213	Of course, this can be modified to suit your needs and your editor :)
214
215	To expand the example above to typical perl error messages ("XXX at
216	FILENAME line YYY."), you need a slightly more elaborate solution:
217
218	URxvt.selection.pattern-0: ( at .*? line \\d+[,.])
219	URxvt.selection-autotransform.0: s/^ at (.*?) line (\\d+)[,.]$/:e \\Q$1\E\\x0d:$2\\x0d/
220
221	The first line tells the selection code to treat the unchanging part of
222	every error message as a selection pattern, and the second line transforms
223	the message into vi commands to load the file.
224
225	=item tabbed
226
227	This transforms the terminal into a tabbar with additional terminals, that
228	is, it implements what is commonly referred to as "tabbed terminal". The topmost line
229	displays a "[NEW]" button, which, when clicked, will add a new tab, followed by one
230	button per tab.
231
232	Clicking a button will activate that tab. Pressing B<Shift-Left> and
233	B<Shift-Right> will switch to the tab left or right of the current one,
234	while B<Shift-Down> creates a new tab.
235
236	The tabbar itself can be configured similarly to a normal terminal, but
237	with a resource class of C<URxvt.tabbed>. In addition, it supports the
238	following four resources (shown with defaults):
239
240	URxvt.tabbed.tabbar-fg: <colour-index, default 3>
241	URxvt.tabbed.tabbar-bg: <colour-index, default 0>
242	URxvt.tabbed.tab-fg: <colour-index, default 0>
243	URxvt.tabbed.tab-bg: <colour-index, default 1>
244
245	See I<COLOR AND GRAPHICS> in the @@RXVT_NAME@@(1) manpage for valid
246	indices.
247
248	=item matcher
249
250	Uses per-line display filtering (C<on_line_update>) to underline text
251	matching a certain pattern and make it clickable. When clicked with the
252	mouse button specified in the C<matcher.button> resource (default 2, or
253	middle), the program specified in the C<matcher.launcher> resource
254	(default, the C<urlLauncher> resource, C<sensible-browser>) will be started
255	with the matched text as first argument. The default configuration is
256	suitable for matching URLs and launching a web browser, like the
257	former "mark-urls" extension.
258
259	The default pattern to match URLs can be overridden with the
260	C<matcher.pattern.0> resource, and additional patterns can be specified
261	with numbered patterns, in a manner similar to the "selection" extension.
262	The launcher can also be overridden on a per-pattern basis.
263
264	It is possible to activate the most recently seen match from the keyboard.
265	Simply bind a keysym to "perl:matcher" as seen in the example below.
266
267	Example configuration:
268
269	URxvt.perl-ext: default,matcher
270	URxvt.urlLauncher: sensible-browser
271	URxvt.keysym.C-Delete: perl:matcher
272	URxvt.matcher.button: 1
273	URxvt.matcher.pattern.1: \\bwww\\.[\\w-]+\\.[\\w./?&@#-]*[\\w/-]
274	URxvt.matcher.pattern.2: \\B(/\\S+?):(\\d+)(?=:|$)
275	URxvt.matcher.launcher.2: gvim +$2 $1
276
277	=item xim-onthespot
278
279	This (experimental) perl extension implements OnTheSpot editing. It does
280	not work perfectly, and some input methods don't seem to work well with
281	OnTheSpot editing in general, but it seems to work at least for SCIM and
282	kinput2.
283
284	You enable it by specifying this extension and a preedit style of
285	C<OnTheSpot>, i.e.:
286
287	@@RXVT_NAME@@ -pt OnTheSpot -pe xim-onthespot
288
289	=item kuake<hotkey>
290
291	A very primitive quake-console-like extension. It was inspired by a
292	description of how the programs C<kuake> and C<yakuake> work: Whenever the
293	user presses a global accelerator key (by default C<F10>), the terminal
294	will show or hide itself. Another press of the accelerator key will hide
295	or show it again.
296
297	Initially, the window will not be shown when using this extension.
298
299	This is useful if you need a single terminal that is not using any desktop
300	space most of the time but is quickly available at the press of a key.
301
302	The accelerator key is grabbed regardless of any modifiers, so this
303	extension will actually grab a physical key just for this function.
304
305	If you want a quake-like animation, tell your window manager to do so
306	(fvwm can do it).
307
308	=item block-graphics-to-ascii
309
310	A not very useful example of filtering all text output to the terminal
311	by replacing all line-drawing characters (U+2500 .. U+259F) by a
312	similar-looking ascii character.
313
314	=item digital-clock
315
316	Displays a digital clock using the built-in overlay.
317
318	=item remote-clipboard
319
320	Somewhat of a misnomer, this extension adds two menu entries to the
321	selection popup that allows one to run external commands to store the
322	selection somewhere and fetch it again.
323
324	We use it to implement a "distributed selection mechanism", which just
325	means that one command uploads the file to a remote server, and another
326	reads it.
327
328	The commands can be set using the C<URxvt.remote-selection.store> and
329	C<URxvt.remote-selection.fetch> resources. The first should read the
330	selection to store from STDIN (always in UTF-8), the second should provide
331	the selection data on STDOUT (also in UTF-8).
332
333	The defaults (which are likely useless to you) use rsh and cat:
334
335	URxvt.remote-selection.store: rsh ruth 'cat >/tmp/distributed-selection'
336	URxvt.remote-selection.fetch: rsh ruth 'cat /tmp/distributed-selection'
337
338	=item selection-pastebin
339
340	This is a little rarely useful extension that Uploads the selection as
341	textfile to a remote site (or does other things). (The implementation is
342	not currently secure for use in a multiuser environment as it writes to
343	F</tmp> directly.).
344
345	It listens to the C<selection-pastebin:remote-pastebin> keyboard command,
346	i.e.
347
348	URxvt.keysym.C-M-e: perl:selection-pastebin:remote-pastebin
349
350	Pressing this combination runs a command with C<%> replaced by the name of
351	the textfile. This command can be set via a resource:
352
353	URxvt.selection-pastebin.cmd: rsync -apP % ruth:/var/www/www.ta-sa.org/files/txt/.
354
355	And the default is likely not useful to anybody but the few people around
356	here :)
357
358	The name of the textfile is the hex encoded md5 sum of the selection, so
359	the same content should lead to the same filename.
360
361	After a successful upload the selection will be replaced by the text given
362	in the C<selection-pastebin-url> resource (again, the % is the placeholder
363	for the filename):
364
365	URxvt.selection-pastebin.url: http://www.ta-sa.org/files/txt/%
366
367	I<Note to xrdb users:> xrdb uses the C preprocessor, which might interpret
368	the double C</> characters as comment start. Use C<\057\057> instead,
369	which works regardless of wether xrdb is used to parse the resource file
370	or not.
371
372	=item example-refresh-hooks
373
374	Displays a very simple digital clock in the upper right corner of the
375	window. Illustrates overwriting the refresh callbacks to create your own
376	overlays or changes.
377
378	=back
379		56
380	=head1 API DOCUMENTATION	57	=head1 API DOCUMENTATION
381		58
382	=head2 General API Considerations	59	=head2 General API Considerations
383		60
…		…
397		74
398	=over 4	75	=over 4
399		76
400	=item $text	77	=item $text
401		78
402	Rxvt-unicodes special way of encoding text, where one "unicode" character	79	Rxvt-unicode's special way of encoding text, where one "unicode" character
403	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.
404		81
405	=item $string	82	=item $string
406		83
407	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
…		…
411	=item $octets	88	=item $octets
412		89
413	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
414	locale-specific way.	91	locale-specific way.
415		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
416	=back	99	=back
417		100
418	=head2 Extension Objects	101	=head2 Extension Objects
419		102
420	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
421	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,
422	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
423	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
424	extensions or other terminals, with the exception of methods and members	107	extensions or other terminals, with the exception of methods and members
425	that begin with an underscore character C<_>: these are reserved for	108	that begin with an underscore character C<_>: these are reserved for
426	internal use.	109	internal use.
427		110
428	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
429	C<urxvt::term> class on this object.	112	C<urxvt::term> class on this object.
430		113
431	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:
432		125
433	=over 4	126	=over 4
434		127
435	=item $urxvt_term = $self->{term}	128	=item #:META:RESOURCE:name:type:desc
436		129
437	Returns the C<urxvt::term> object associated with this instance of the	130	The RESOURCE comment defines a resource used by the extension, where
438	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.
439		133
440	=item $self->enable ($hook_name => $cb, [$hook_name => $cb..])	134	The extension will be autoloaded when this resource is specified or used
441		135	as a command line parameter.
442	Dynamically enable the given hooks (named without the C<on_> prefix) for
443	this extension, replacing any previous hook. This is useful when you want
444	to overwrite time-critical hooks only temporarily.
445
446	=item $self->disable ($hook_name[, $hook_name..])
447
448	Dynamically disable the given hooks.
449		136
450	=back	137	=back
451		138
452	=head2 Hooks	139	=head2 Hooks
453		140
…		…
541		228
542	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,
543	$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
544	number of lines that will be in the scrollback buffer.	231	number of lines that will be in the scrollback buffer.
545		232
546	=item on_osc_seq $term, $op, $args	233	=item on_osc_seq $term, $op, $args, $resp
547		234
548	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
549	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
550	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
551	confused by recursive invocations when you output an osc sequence within	238	confused by recursive invocations when you output an OSC sequence within
552	this callback.	239	this callback.
553		240
554	C<on_osc_seq_perl> should be used for new behaviour.	241	C<on_osc_seq_perl> should be used for new behaviour.
555		242
556	=item on_osc_seq_perl $term, $string	243	=item on_osc_seq_perl $term, $args, $resp
557		244
558	Called whenever the B<ESC ] 777 ; string ST> command sequence (OSC =	245	Called whenever the B<ESC ] 777 ; string ST> command sequence (OSC =
559	operating system command) is processed. Cursor position and other state	246	operating system command) is processed. Cursor position and other state
560	information is up-to-date when this happens. For interoperability, the	247	information is up-to-date when this happens. For interoperability, the
561	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,
562	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
563	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	}
564		261
565	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,
566	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
567	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.
568		268
569	=item on_add_lines $term, $string	269	=item on_add_lines $term, $string
570		270
571	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
572	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
…		…
577	=item on_tt_write $term, $octets	277	=item on_tt_write $term, $octets
578		278
579	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
580	suppress or filter tty input.	280	suppress or filter tty input.
581		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
582	=item on_line_update $term, $row	289	=item on_line_update $term, $row
583		290
584	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
585	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
586	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,
…		…
593	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
594	you cannot just toggle rendition bits, but only set them.	301	you cannot just toggle rendition bits, but only set them.
595		302
596	=item on_refresh_begin $term	303	=item on_refresh_begin $term
597		304
598	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
599	or similar effects by modify terminal contents in refresh_begin, and	306	similar effects by modifying the terminal contents in refresh_begin, and
600	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
601	code is run after this hook, and takes precedence.	308	code is run after this hook, and takes precedence.
602		309
603	=item on_refresh_end $term	310	=item on_refresh_end $term
604		311
605	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>.
606		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
607	=item on_user_command $term, $string	322	=item on_user_command $term, $string *DEPRECATED*
608		323
609	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
610	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>
611	resource in the @@RXVT_NAME@@(1) manpage).	326	resource in the urxvt(1) manpage).
612		327
613	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
614	slightly in the future.	329	preference to the C<on_action> hook.
615		330
616	=item on_resize_all_windows $tern, $new_width, $new_height	331	=item on_resize_all_windows $term, $new_width, $new_height
617		332
618	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
619	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
620	returns TRUE, setting of the window hints is being skipped.	335	returns a true value, setting of the window hints is being skipped.
621		336
622	=item on_x_event $term, $event	337	=item on_x_event $term, $event
623		338
624	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
625	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
…		…
655		370
656	=item on_map_notify $term, $event	371	=item on_map_notify $term, $event
657		372
658	=item on_unmap_notify $term, $event	373	=item on_unmap_notify $term, $event
659		374
660	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
661	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.
662		377
663	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
664	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
665	(real, not screen-based) row and column under the mouse cursor.	380	(real, not screen-based) row and column under the mouse cursor.
666		381
667	C<on_key_press> additionally receives the string rxvt-unicode would	382	C<on_key_press> additionally receives the string rxvt-unicode would
668	output, if any, in locale-specific encoding.	383	output, if any, in locale-specific encoding.
669		384
670	subwindow.
671
672	=item on_client_message $term, $event	385	=item on_client_message $term, $event
673		386
674	=item on_wm_protocols $term, $event	387	=item on_wm_protocols $term, $event
675		388
676	=item on_wm_delete_window $term, $event	389	=item on_wm_delete_window $term, $event
677		390
678	Called when various types of ClientMessage events are received (all with	391	Called when various types of ClientMessage events are received (all with
679	format=32, WM_PROTOCOLS or WM_PROTOCOLS:WM_DELETE_WINDOW).	392	format=32, WM_PROTOCOLS or WM_PROTOCOLS:WM_DELETE_WINDOW).
680		393
		394	=item on_bell $term
		395
		396	Called on receipt of a bell character.
		397
681	=back	398	=back
682		399
683	=cut	400	=cut
684		401
685	package urxvt;	402	package urxvt;
686		403
687	use utf8;	404	use utf8;
688	use strict;	405	use strict 'vars';
689	use Carp ();	406	use Carp ();
690	use Scalar::Util ();	407	use Scalar::Util ();
691	use List::Util ();	408	use List::Util ();
692		409
693	our $VERSION = 1;	410	our $VERSION = 1;
694	our $TERM;	411	our $TERM;
695	our @TERM_INIT;	412	our @TERM_INIT; # should go, prevents async I/O etc.
696	our @TERM_EXT;	413	our @TERM_EXT; # should go, prevents async I/O etc.
697	our @HOOKNAME;	414	our @HOOKNAME;
698	our %HOOKTYPE = map +($HOOKNAME[$_] => $_), 0..$#HOOKNAME;	415	our %HOOKTYPE = map +($HOOKNAME[$_] => $_), 0..$#HOOKNAME;
699	our %OPTION;	416	our %OPTION;
700		417
701	our $LIBDIR;	418	our $LIBDIR;
…		…
749		466
750	=over 4	467	=over 4
751		468
752	=item urxvt::fatal $errormessage	469	=item urxvt::fatal $errormessage
753		470
754	Fatally aborts execution with the given error message. Avoid at all	471	Fatally aborts execution with the given error message (which should
755	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
756	starts up.	473	is acceptable (and useful) is in the init hook, where it prevents the
		474	terminal from starting up.
757		475
758	=item urxvt::warn $string	476	=item urxvt::warn $string
759		477
760	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
761	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
762	that calls this function.	480	that calls this function.
763		481
764	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
765	correct place, e.g. on stderr of the connecting urxvtc client.	483	correct place, e.g. on stderr of the connecting urxvtc client.
…		…
769	=item @terms = urxvt::termlist	487	=item @terms = urxvt::termlist
770		488
771	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
772	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
773	objects that have perl extensions attached will be returned (because there	491	objects that have perl extensions attached will be returned (because there
774	is no urxvt::term objet associated with others).	492	is no urxvt::term object associated with others).
775		493
776	=item $time = urxvt::NOW	494	=item $time = urxvt::NOW
777		495
778	Returns the "current time" (as per the event loop).	496	Returns the "current time" (as per the event loop).
779		497
…		…
799	CirculateRequest, PropertyNotify, SelectionClear, SelectionRequest,	517	CirculateRequest, PropertyNotify, SelectionClear, SelectionRequest,
800	SelectionNotify, ColormapNotify, ClientMessage, MappingNotify	518	SelectionNotify, ColormapNotify, ClientMessage, MappingNotify
801		519
802	Various constants for use in X calls and event processing.	520	Various constants for use in X calls and event processing.
803		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
804	=back	534	=back
805		535
806	=head2 RENDITION	536	=head2 RENDITION
807		537
808	Rendition bitsets contain information about colour, font, font styles and	538	Rendition bitsets contain information about colour, font, font styles and
…		…
822		552
823	=item $rend = urxvt::OVERLAY_RSTYLE	553	=item $rend = urxvt::OVERLAY_RSTYLE
824		554
825	Return the rendition mask used for overlays by default.	555	Return the rendition mask used for overlays by default.
826		556
827	=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
828		559
829	Return the bit that enabled bold, italic, blink, reverse-video and	560	Return the bit that enabled bold, italic, blink, reverse-video and
830	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
831	the bitset.	562	the bitset.
832		563
…		…
869	};	600	};
870	}	601	}
871		602
872	no warnings 'utf8';	603	no warnings 'utf8';
873		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
874	my $verbosity = $ENV{URXVT_PERL_VERBOSITY};	671	my $verbosity = $ENV{URXVT_PERL_VERBOSITY};
875		672
876	sub verbose {	673	sub verbose {
877	my ($level, $msg) = @_;	674	my ($level, $msg) = @_;
878	warn "$msg\n" if $level <= $verbosity;	675	warn "$msg\n" if $level <= $verbosity;
…		…
890	$pkg =~ s/[^[:word:]]/_/g;	687	$pkg =~ s/[^[:word:]]/_/g;
891	$pkg = "urxvt::ext::$pkg";	688	$pkg = "urxvt::ext::$pkg";
892		689
893	verbose 3, "loading extension '$path' into package '$pkg'";	690	verbose 3, "loading extension '$path' into package '$pkg'";
894		691
		692	(${"$pkg\::_NAME"} = $path) =~ s/^.*[\\\/]//; # hackish
		693
895	open my $fh, "<:raw", $path	694	open my $fh, "<:raw", $path
896	or die "$path: $!";	695	or die "$path: $!";
897		696
898	my $source =	697	my $source =
899	"package $pkg; use strict; use utf8; no warnings 'utf8';\n"	698	"package $pkg; use strict 'vars'; use utf8; no warnings 'utf8';\n"
900	. "#line 1 \"$path\"\n{\n"	699	. "#line 1 \"$path\"\n{\n"
901	. (do { local $/; <$fh> })	700	. (do { local $/; <$fh> })
902	. "\n};\n1";	701	. "\n};\n1";
903		702
904	eval $source	703	eval $source
…		…
913	# called by the rxvt core	712	# called by the rxvt core
914	sub invoke {	713	sub invoke {
915	local $TERM = shift;	714	local $TERM = shift;
916	my $htype = shift;	715	my $htype = shift;
917		716
918	if ($htype == 0) { # INIT	717	if ($htype == HOOK_INIT) {
919	my @dirs = ((split /:/, $TERM->resource ("perl_lib")), "$LIBDIR/perl");	718	my @dirs = $TERM->perl_libdirs;
		719
		720	$TERM->scan_extensions;
920		721
921	my %ext_arg;	722	my %ext_arg;
922		723
923	{	724	{
924	my @init = @TERM_INIT;	725	my @init = @TERM_INIT;
…		…
927	my @pkg = @TERM_EXT;	728	my @pkg = @TERM_EXT;
928	@TERM_EXT = ();	729	@TERM_EXT = ();
929	$TERM->register_package ($_) for @pkg;	730	$TERM->register_package ($_) for @pkg;
930	}	731	}
931		732
		733	for (
		734	@{ delete $TERM->{perl_ext_3} },
932	for (grep $_, map { split /,/, $TERM->resource ("perl_ext_$_") } 1, 2) {	735	(grep $_, map { split /,/, $TERM->resource ("perl_ext_$_") } 1, 2),
		736	) {
933	if ($_ eq "default") {	737	if ($_ eq "default") {
		738
		739	$ext_arg{$_} = []
934	$ext_arg{$_} ||= [] for qw(selection option-popup selection-popup searchable-scrollback readline);	740	for qw(selection option-popup selection-popup readline searchable-scrollback);
		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
935	} elsif (/^-(.*)$/) {	751	} elsif (/^-(.*)$/) {
936	delete $ext_arg{$1};	752	delete $ext_arg{$1};
		753
937	} elsif (/^([^<]+)<(.*)>$/) {	754	} elsif (/^([^<]+)<(.*)>$/) {
938	push @{ $ext_arg{$1} }, $2;	755	push @{ $ext_arg{$1} }, $2;
		756
939	} else {	757	} else {
940	$ext_arg{$_} ||= [];	758	$ext_arg{$_} ||= [];
941	}	759	}
942	}	760	}
943		761
…		…
959		777
960	if (my $cb = $TERM->{_hook}[$htype]) {	778	if (my $cb = $TERM->{_hook}[$htype]) {
961	verbose 10, "$HOOKNAME[$htype] (" . (join ", ", $TERM, @_) . ")"	779	verbose 10, "$HOOKNAME[$htype] (" . (join ", ", $TERM, @_) . ")"
962	if $verbosity >= 10;	780	if $verbosity >= 10;
963		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
964	for my $pkg (keys %$cb) {	795	for my $pkg (keys %$cb) {
965	my $retval_ = eval { $cb->{$pkg}->($TERM->{_pkg}{$pkg}, @_) };	796	my $retval_ = eval { $cb->{$pkg}->($TERM->{_pkg}{$pkg} || $TERM, @_) };
966	$retval ||= $retval_;	797	$retval ||= $retval_;
967		798
968	if ($@) {	799	if ($@) {
969	$TERM->ungrab; # better to lose the grab than the session	800	$TERM->ungrab; # better to lose the grab than the session
970	warn $@;	801	warn $@;
…		…
973		804
974	verbose 11, "$HOOKNAME[$htype] returning <$retval>"	805	verbose 11, "$HOOKNAME[$htype] returning <$retval>"
975	if $verbosity >= 11;	806	if $verbosity >= 11;
976	}	807	}
977		808
978	if ($htype == 1) { # DESTROY	809	if ($htype == HOOK_DESTROY) {
979	# clear package objects	810	# clear package objects
980	%$_ = () for values %{ $TERM->{_pkg} };	811	%$_ = () for values %{ $TERM->{_pkg} };
981		812
982	# clear package	813	# clear package
983	%$TERM = ();	814	%$TERM = ();
…		…
1013	}	844	}
1014	}	845	}
1015	($mask, @color{qw(fg bg)}, \@failed)	846	($mask, @color{qw(fg bg)}, \@failed)
1016	}	847	}
1017		848
1018	# urxvt::term::extension
1019
1020	package urxvt::term::extension;	849	package urxvt::term::extension;
1021		850
1022	sub enable {	851	=head2 The C<urxvt::term::extension> class
1023	my ($self, %hook) = @_;
1024	my $pkg = $self->{_pkg};
1025		852
1026	while (my ($name, $cb) = each %hook) {	853	Each extension attached to a terminal object is represented by
1027	my $htype = $HOOKTYPE{uc $name};	854	a C<urxvt::term::extension> object.
1028	defined $htype
1029	or Carp::croak "unsupported hook type '$name'";
1030		855
1031	$self->set_should_invoke ($htype, +1)	856	You can use these objects, which are passed to all callbacks to store any
1032	unless exists $self->{term}{_hook}[$htype]{$pkg};	857	state related to the terminal and extension instance.
1033		858
1034	$self->{term}{_hook}[$htype]{$pkg} = $cb;	859	The methods (And data members) documented below can be called on extension
1035	}	860	objects, in addition to call methods documented for the <urxvt::term>
1036	}	861	class.
1037		862
1038	sub disable {	863	=over 4
1039	my ($self, @hook) = @_;
1040	my $pkg = $self->{_pkg};
1041		864
1042	for my $name (@hook) {	865	=item $urxvt_term = $self->{term}
1043	my $htype = $HOOKTYPE{uc $name};
1044	defined $htype
1045	or Carp::croak "unsupported hook type '$name'";
1046		866
1047	$self->set_should_invoke ($htype, -1)	867	Returns the C<urxvt::term> object associated with this instance of the
1048	if delete $self->{term}{_hook}[$htype]{$pkg};	868	extension. This member I<must not> be changed in any way.
1049	}	869
1050	}	870	=cut
1051		871
1052	our $AUTOLOAD;	872	our $AUTOLOAD;
1053		873
1054	sub AUTOLOAD {	874	sub AUTOLOAD {
1055	$AUTOLOAD =~ /:([^:]+)$/	875	$AUTOLOAD =~ /:([^:]+)$/
…		…
1068		888
1069	sub DESTROY {	889	sub DESTROY {
1070	# nop	890	# nop
1071	}	891	}
1072		892
1073	# urxvt::destroy_hook	893	# urxvt::destroy_hook (basically a cheap Guard:: implementation)
1074		894
1075	sub urxvt::destroy_hook::DESTROY {	895	sub urxvt::destroy_hook::DESTROY {
1076	${$_[0]}->();	896	${$_[0]}->();
1077	}	897	}
1078		898
1079	sub urxvt::destroy_hook(&) {	899	sub urxvt::destroy_hook(&) {
1080	bless \shift, urxvt::destroy_hook::	900	bless \shift, urxvt::destroy_hook::
1081	}	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
1082		1025
1083	package urxvt::anyevent;	1026	package urxvt::anyevent;
1084		1027
1085	=head2 The C<urxvt::anyevent> Class	1028	=head2 The C<urxvt::anyevent> Class
1086		1029
1087	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
1088	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
1089	further programming. The only exception is that you cannot wait on	1032	further programming. The only exception is that you cannot wait on
1090	condition variables, but non-blocking condvar use is ok. What this means	1033	condition variables, but non-blocking condvar use is ok.
1091	is that you cannot use blocking APIs, but the non-blocking variant should
1092	work.
1093		1034
1094	=cut	1035	In practical terms this means is that you cannot use blocking APIs, but
		1036	the non-blocking variant should work.
1095		1037
		1038	=cut
		1039
1096	our $VERSION = '3.4';	1040	our $VERSION = '5.23';
1097		1041
1098	$INC{"urxvt/anyevent.pm"} = 1; # mark us as there	1042	$INC{"urxvt/anyevent.pm"} = 1; # mark us as there
1099	push @AnyEvent::REGISTRY, [urxvt => urxvt::anyevent::];	1043	push @AnyEvent::REGISTRY, [urxvt => urxvt::anyevent::];
1100		1044
1101	sub timer {	1045	sub timer {
…		…
1103		1047
1104	my $cb = $arg{cb};	1048	my $cb = $arg{cb};
1105		1049
1106	urxvt::timer	1050	urxvt::timer
1107	->new	1051	->new
1108	->start (urxvt::NOW + $arg{after})	1052	->after ($arg{after}, $arg{interval})
1109	->cb (sub {	1053	->cb ($arg{interval} ? $cb : sub {
1110	$_[0]->stop; # need to cancel manually	1054	$_[0]->stop; # need to cancel manually
1111	$cb->();	1055	$cb->();
1112	})	1056	})
1113	}	1057	}
1114		1058
1115	sub io {	1059	sub io {
1116	my ($class, %arg) = @_;	1060	my ($class, %arg) = @_;
1117		1061
1118	my $cb = $arg{cb};	1062	my $cb = $arg{cb};
		1063	my $fd = fileno $arg{fh};
		1064	defined $fd or $fd = $arg{fh};
1119		1065
1120	bless [$arg{fh}, urxvt::iow	1066	bless [$arg{fh}, urxvt::iow
1121	->new	1067	->new
1122	->fd (fileno $arg{fh})	1068	->fd ($fd)
1123	->events (($arg{poll} =~ /r/ ? 1 : 0)	1069	->events (($arg{poll} =~ /r/ ? 1 : 0)
1124	| ($arg{poll} =~ /w/ ? 2 : 0))	1070	| ($arg{poll} =~ /w/ ? 2 : 0))
1125	->start	1071	->start
1126	->cb (sub {	1072	->cb ($cb)
1127	$cb->(($_[1] & 1 ? 'r' : '')
1128	. ($_[1] & 2 ? 'w' : ''));
1129	})],
1130	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	})
1131	}	1099	}
1132		1100
1133	sub DESTROY {	1101	sub DESTROY {
1134	$_[0][1]->stop;	1102	$_[0][1]->stop;
1135	}	1103	}
1136		1104
		1105	# only needed for AnyEvent < 6 compatibility
1137	sub one_event {	1106	sub one_event {
1138	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";
1139	}	1108	}
1140		1109
1141	package urxvt::term;	1110	package urxvt::term;
…		…
1156	urxvt::verbose 6, "register package $pkg to $self";	1125	urxvt::verbose 6, "register package $pkg to $self";
1157		1126
1158	@{"$pkg\::ISA"} = urxvt::term::extension::;	1127	@{"$pkg\::ISA"} = urxvt::term::extension::;
1159		1128
1160	my $proxy = bless {	1129	my $proxy = bless {
1161	_pkg => $pkg,	1130	_pkg => $pkg,
		1131	_name => ${"$pkg\::_NAME"}, # hackish
1162	argv => $argv,	1132	argv => $argv,
1163	}, $pkg;	1133	}, $pkg;
1164	Scalar::Util::weaken ($proxy->{term} = $self);	1134	Scalar::Util::weaken ($proxy->{term} = $self);
1165		1135
1166	$self->{_pkg}{$pkg} = $proxy;	1136	$self->{_pkg}{$pkg} = $proxy;
1167		1137
…		…
1170	$proxy->enable ($name => $ref);	1140	$proxy->enable ($name => $ref);
1171	}	1141	}
1172	}	1142	}
1173	}	1143	}
1174		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
1175	=item $term = new urxvt::term $envhashref, $rxvtname, [arg...]	1220	=item $term = new urxvt::term $envhashref, $rxvtname, [arg...]
1176		1221
1177	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
1178	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
1179	hash which defines the environment of the new terminal.	1224	hash which defines the environment of the new terminal.
…		…
1196	}	1241	}
1197		1242
1198	=item $term->destroy	1243	=item $term->destroy
1199		1244
1200	Destroy the terminal object (close the window, free resources	1245	Destroy the terminal object (close the window, free resources
1201	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
1202	watchers (timers, io watchers) are still active.	1247	watchers (timers, io watchers) are still active.
1203		1248
1204	=item $term->exec_async ($cmd[, @args])	1249	=item $term->exec_async ($cmd[, @args])
1205		1250
1206	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
…		…
1233	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.
1234		1279
1235	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
1236	source file F</src/optinc.h> to see the actual list:	1281	source file F</src/optinc.h> to see the actual list:
1237		1282
1238	borderLess console cursorBlink cursorUnderline hold iconic insecure	1283	borderLess buffered console cursorBlink cursorUnderline hold iconic
1239	intensityStyles jumpScroll loginShell mapAlert meta8 mouseWheelScrollPage	1284	insecure intensityStyles iso14755 iso14755_52 jumpScroll loginShell
1240	override-redirect pastableTabs pointerBlank reverseVideo scrollBar	1285	mapAlert meta8 mouseWheelScrollPage override_redirect pastableTabs
1241	scrollBar_floating scrollBar_right scrollTtyKeypress scrollTtyOutput	1286	pointerBlank reverseVideo scrollBar scrollBar_floating scrollBar_right
1242	scrollWithBuffer secondaryScreen secondaryScroll skipBuiltinGlyphs	1287	scrollTtyKeypress scrollTtyOutput scrollWithBuffer secondaryScreen
1243	transparent tripleclickwords utmpInhibit visualBell	1288	secondaryScroll skipBuiltinGlyphs skipScroll transparent tripleclickwords
		1289	urgentOnBell utmpInhibit visualBell
1244		1290
1245	=item $value = $term->resource ($name[, $newval])	1291	=item $value = $term->resource ($name[, $newval])
1246		1292
1247	Returns the current resource value associated with a given name and	1293	Returns the current resource value associated with a given name and
1248	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>
…		…
1261		1307
1262	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
1263	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>
1264	to see the actual list:	1310	to see the actual list:
1265		1311
1266	answerbackstring backgroundPixmap backspace_key boldFont boldItalicFont	1312	answerbackstring backgroundPixmap backspace_key blurradius
1267	borderLess chdir color cursorBlink cursorUnderline cutchars delete_key	1313	boldFont boldItalicFont borderLess buffered chdir color cursorBlink
1268	display_name embed ext_bwidth fade font geometry hold iconName	1314	cursorUnderline cutchars delete_key depth display_name embed ext_bwidth
1269	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
1270	italicFont jumpScroll lineSpace loginShell mapAlert meta8 modifier	1317	jumpScroll letterSpace lineSpace loginShell mapAlert meta8 modifier
1271	mouseWheelScrollPage name override_redirect pastableTabs path perl_eval	1318	mouseWheelScrollPage name override_redirect pastableTabs path perl_eval
1272	perl_ext_1 perl_ext_2 perl_lib pointerBlank pointerBlankDelay	1319	perl_ext_1 perl_ext_2 perl_lib pointerBlank pointerBlankDelay
1273	preeditType print_pipe pty_fd reverseVideo saveLines scrollBar	1320	preeditType print_pipe pty_fd reverseVideo saveLines scrollBar
1274	scrollBar_align scrollBar_floating scrollBar_right scrollBar_thickness	1321	scrollBar_align scrollBar_floating scrollBar_right scrollBar_thickness
1275	scrollTtyKeypress scrollTtyOutput scrollWithBuffer scrollstyle	1322	scrollTtyKeypress scrollTtyOutput scrollWithBuffer scrollstyle
1276	secondaryScreen secondaryScroll shade term_name title	1323	secondaryScreen secondaryScroll shade skipBuiltinGlyphs skipScroll
1277	transient_for transparent transparent_all tripleclickwords utmpInhibit	1324	term_name title transient_for transparent tripleclickwords urgentOnBell
1278	visualBell	1325	utmpInhibit visualBell
1279		1326
1280	=cut	1327	=cut
1281		1328
1282	sub resource($$;$) {	1329	sub resource($$;$) {
1283	my ($self, $name) = (shift, shift);	1330	my ($self, $name) = (shift, shift);
…		…
1290	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
1291	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
1292	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
1293	resource with that pattern exists.	1340	resource with that pattern exists.
1294		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
1295	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
1296	only one resource database per display, and later invocations might return	1353	only one resource database per display, and later invocations might return
1297	the wrong resources.	1354	the wrong resources.
1298		1355
1299	=item $success = $term->parse_keysym ($keysym_spec, $command_string)	1356	=item $value = $term->x_resource_boolean ($pattern)
1300		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
1301	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
1302	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	}
1303		1396
1304	=item $rend = $term->rstyle ([$new_rstyle])	1397	=item $rend = $term->rstyle ([$new_rstyle])
1305		1398
1306	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
1307	the terminal application will use this style.	1400	the terminal application will use this style.
…		…
1315		1408
1316	=item ($row, $col) = $term->selection_beg ([$row, $col])	1409	=item ($row, $col) = $term->selection_beg ([$row, $col])
1317		1410
1318	=item ($row, $col) = $term->selection_end ([$row, $col])	1411	=item ($row, $col) = $term->selection_end ([$row, $col])
1319		1412
1320	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.
1321	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.
1322		1422
1323	=item $term->selection_make ($eventtime[, $rectangular])	1423	=item $term->selection_make ($eventtime[, $rectangular])
1324		1424
1325	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
1326	C<selection_end>. If C<$rectangular> is true (default: false), a	1426	C<selection_end>. If C<$rectangular> is true (default: false), a
1327	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
1328	a selection.	1428	a selection.
1329		1429
1330	=item $success = $term->selection_grab ($eventtime)	1430	=item $success = $term->selection_grab ($eventtime[, $clipboard])
1331		1431
1332	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
1333	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
1334	is mostly useful from within C<on_sel_grab> hooks.	1435	is mostly useful from within C<on_sel_grab> hooks.
1335		1436
1336	=item $oldtext = $term->selection ([$newtext])	1437	=item $oldtext = $term->selection ([$newtext, $clipboard])
1337		1438
1338	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.
1339		1445
1340	=item $term->overlay_simple ($x, $y, $text)	1446	=item $term->overlay_simple ($x, $y, $text)
1341		1447
1342	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.
1343		1449
…		…
1373		1479
1374	The methods currently supported on C<urxvt::overlay> objects are:	1480	The methods currently supported on C<urxvt::overlay> objects are:
1375		1481
1376	=over 4	1482	=over 4
1377		1483
1378	=item $overlay->set ($x, $y, $text, $rend)	1484	=item $overlay->set ($x, $y, $text[, $rend])
1379		1485
1380	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
1381	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
1382	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.
1383		1491
1384	=item $overlay->hide	1492	=item $overlay->hide
1385		1493
1386	If visible, hide the overlay, but do not destroy it.	1494	If visible, hide the overlay, but do not destroy it.
1387		1495
…		…
1450		1558
1451	=item $term->scr_add_lines ($string)	1559	=item $term->scr_add_lines ($string)
1452		1560
1453	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
1454	running inside the terminal. It may not contain command sequences (escape	1562	running inside the terminal. It may not contain command sequences (escape
1455	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,
1456	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.
1457		1566
1458	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
1459	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
1460	C<on_add_lines> hook, though.	1569	C<on_add_lines> hook, though.
1461		1570
…		…
1469	locale-specific encoding of the terminal and can contain command sequences	1578	locale-specific encoding of the terminal and can contain command sequences
1470	(escape codes) that will be interpreted.	1579	(escape codes) that will be interpreted.
1471		1580
1472	=item $term->tt_write ($octets)	1581	=item $term->tt_write ($octets)
1473		1582
1474	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
1475	pass characters instead of octets, you should convert your strings first	1585	characters instead of octets, you should convert your strings first to the
1476	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.
1477		1601
1478	=item $old_events = $term->pty_ev_events ([$new_events])	1602	=item $old_events = $term->pty_ev_events ([$new_events])
1479		1603
1480	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
1481	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
…		…
1500	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
1501	to receive pointer events all the times:	1625	to receive pointer events all the times:
1502		1626
1503	$term->vt_emask_add (urxvt::PointerMotionMask);	1627	$term->vt_emask_add (urxvt::PointerMotionMask);
1504		1628
		1629	=item $term->set_urgency ($set)
		1630
		1631	Enable/disable the urgency hint on the toplevel window.
		1632
1505	=item $term->focus_in	1633	=item $term->focus_in
1506		1634
1507	=item $term->focus_out	1635	=item $term->focus_out
1508		1636
1509	=item $term->key_press ($state, $keycode[, $time])	1637	=item $term->key_press ($state, $keycode[, $time])
1510		1638
1511	=item $term->key_release ($state, $keycode[, $time])	1639	=item $term->key_release ($state, $keycode[, $time])
1512		1640
1513	Deliver various fake events to to terminal.	1641	Deliver various fake events to to terminal.
1514		1642
1515	=item $window_width = $term->width	1643	=item $window_width = $term->width ([$new_value])
1516		1644
1517	=item $window_height = $term->height	1645	=item $window_height = $term->height ([$new_value])
1518		1646
1519	=item $font_width = $term->fwidth	1647	=item $font_width = $term->fwidth ([$new_value])
1520		1648
1521	=item $font_height = $term->fheight	1649	=item $font_height = $term->fheight ([$new_value])
1522		1650
1523	=item $font_ascent = $term->fbase	1651	=item $font_ascent = $term->fbase ([$new_value])
1524		1652
1525	=item $terminal_rows = $term->nrow	1653	=item $terminal_rows = $term->nrow ([$new_value])
1526		1654
1527	=item $terminal_columns = $term->ncol	1655	=item $terminal_columns = $term->ncol ([$new_value])
1528		1656
1529	=item $has_focus = $term->focus	1657	=item $has_focus = $term->focus ([$new_value])
1530		1658
1531	=item $is_mapped = $term->mapped	1659	=item $is_mapped = $term->mapped ([$new_value])
1532		1660
1533	=item $max_scrollback = $term->saveLines	1661	=item $max_scrollback = $term->saveLines ([$new_value])
1534		1662
1535	=item $nrow_plus_saveLines = $term->total_rows	1663	=item $nrow_plus_saveLines = $term->total_rows ([$new_value])
1536		1664
1537	=item $topmost_scrollback_row = $term->top_row	1665	=item $topmost_scrollback_row = $term->top_row ([$new_value])
1538		1666
1539	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.
1540		1669
1541	=item $x_display = $term->display_id	1670	=item $x_display = $term->display_id
1542		1671
1543	Return the DISPLAY used by rxvt-unicode.	1672	Return the DISPLAY used by rxvt-unicode.
1544		1673
…		…
1580	Returns the currently displayed screen (0 primary, 1 secondary).	1709	Returns the currently displayed screen (0 primary, 1 secondary).
1581		1710
1582	=item $cursor_is_hidden = $term->hidden_cursor	1711	=item $cursor_is_hidden = $term->hidden_cursor
1583		1712
1584	Returns whether the cursor is currently hidden or not.	1713	Returns whether the cursor is currently hidden or not.
		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	}
1585		1724
1586	=item $view_start = $term->view_start ([$newvalue])	1725	=item $view_start = $term->view_start ([$newvalue])
1587		1726
1588	Returns the row number of the topmost displayed line. Maximum value is	1727	Returns the row number of the topmost displayed line. Maximum value is
1589	C<0>, which displays the normal terminal contents. Lower values scroll	1728	C<0>, which displays the normal terminal contents. Lower values scroll
…		…
1594	Requests a screen refresh. At the next opportunity, rxvt-unicode will	1733	Requests a screen refresh. At the next opportunity, rxvt-unicode will
1595	compare the on-screen display with its stored representation. If they	1734	compare the on-screen display with its stored representation. If they
1596	differ, it redraws the differences.	1735	differ, it redraws the differences.
1597		1736
1598	Used after changing terminal contents to display them.	1737	Used after changing terminal contents to display them.
		1738
		1739	=item $term->refresh_check
		1740
		1741	Checks if a refresh has been requested and, if so, schedules one.
1599		1742
1600	=item $text = $term->ROW_t ($row_number[, $new_text[, $start_col]])	1743	=item $text = $term->ROW_t ($row_number[, $new_text[, $start_col]])
1601		1744
1602	Returns the text of the entire row with number C<$row_number>. Row C<< $term->top_row >>	1745	Returns the text of the entire row with number C<$row_number>. Row C<< $term->top_row >>
1603	is the topmost terminal line, row C<< $term->nrow-1 >> is the bottommost	1746	is the topmost terminal line, row C<< $term->nrow-1 >> is the bottommost
…		…
1705	}	1848	}
1706		1849
1707	sub urxvt::line::t {	1850	sub urxvt::line::t {
1708	my ($self) = @_;	1851	my ($self) = @_;
1709		1852
1710	if (@_ > 1)	1853	if (@_ > 1) {
1711	{
1712	$self->{term}->ROW_t ($_, $_[1], 0, ($_ - $self->{beg}) * $self->{ncol}, $self->{ncol})	1854	$self->{term}->ROW_t ($_, $_[1], 0, ($_ - $self->{beg}) * $self->{ncol}, $self->{ncol})
1713	for $self->{beg} .. $self->{end};	1855	for $self->{beg} .. $self->{end};
1714	}	1856	}
1715		1857
1716	defined wantarray &&	1858	defined wantarray &&
1717	substr +(join "", map $self->{term}->ROW_t ($_), $self->{beg} .. $self->{end}),	1859	substr +(join "", map $self->{term}->ROW_t ($_), $self->{beg} .. $self->{end}),
1718	0, $self->{len}	1860	0, $self->{len}
1719	}	1861	}
1720		1862
1721	sub urxvt::line::r {	1863	sub urxvt::line::r {
1722	my ($self) = @_;	1864	my ($self) = @_;
1723		1865
1724	if (@_ > 1)	1866	if (@_ > 1) {
1725	{
1726	$self->{term}->ROW_r ($_, $_[1], 0, ($_ - $self->{beg}) * $self->{ncol}, $self->{ncol})	1867	$self->{term}->ROW_r ($_, $_[1], 0, ($_ - $self->{beg}) * $self->{ncol}, $self->{ncol})
1727	for $self->{beg} .. $self->{end};	1868	for $self->{beg} .. $self->{end};
1728	}	1869	}
1729		1870
1730	if (defined wantarray) {	1871	if (defined wantarray) {
1731	my $rend = [	1872	my $rend = [
1732	map @{ $self->{term}->ROW_r ($_) }, $self->{beg} .. $self->{end}	1873	map @{ $self->{term}->ROW_r ($_) }, $self->{beg} .. $self->{end}
1733	];	1874	];
…		…
1795	Calls XAllowEvents with both ReplayPointer and ReplayKeyboard for the most	1936	Calls XAllowEvents with both ReplayPointer and ReplayKeyboard for the most
1796	recent grab.	1937	recent grab.
1797		1938
1798	=item $term->ungrab	1939	=item $term->ungrab
1799		1940
1800	Calls XUngrab for the most recent grab. Is called automatically on	1941	Calls XUngrabPointer and XUngrabKeyboard for the most recent grab. Is called automatically on
1801	evaluation errors, as it is better to lose the grab in the error case as	1942	evaluation errors, as it is better to lose the grab in the error case as
1802	the session.	1943	the session.
1803		1944
1804	=item $atom = $term->XInternAtom ($atom_name[, $only_if_exists])	1945	=item $atom = $term->XInternAtom ($atom_name[, $only_if_exists])
1805		1946
…		…
1825		1966
1826	=item ($x, $y, $child_window) = $term->XTranslateCoordinates ($src, $dst, $x, $y)	1967	=item ($x, $y, $child_window) = $term->XTranslateCoordinates ($src, $dst, $x, $y)
1827		1968
1828	=item $term->XChangeInput ($window, $add_events[, $del_events])	1969	=item $term->XChangeInput ($window, $add_events[, $del_events])
1829		1970
		1971	=item $keysym = $term->XStringToKeysym ($string)
		1972
		1973	=item $string = $term->XKeysymToString ($keysym)
		1974
1830	Various X or X-related functions. The C<$term> object only serves as	1975	Various X or X-related functions. The C<$term> object only serves as
1831	the source of the display, otherwise those functions map more-or-less	1976	the source of the display, otherwise those functions map more-or-less
1832	directory onto the X functions of the same name.	1977	directly onto the X functions of the same name.
1833		1978
1834	=back	1979	=back
1835		1980
1836	=cut	1981	=cut
1837		1982
…		…
1994		2139
1995	=item $timer = $timer->cb (sub { my ($timer) = @_; ... })	2140	=item $timer = $timer->cb (sub { my ($timer) = @_; ... })
1996		2141
1997	Set the callback to be called when the timer triggers.	2142	Set the callback to be called when the timer triggers.
1998		2143
1999	=item $tstamp = $timer->at
2000
2001	Return the time this watcher will fire next.
2002
2003	=item $timer = $timer->set ($tstamp)	2144	=item $timer = $timer->set ($tstamp[, $interval])
2004		2145
2005	Set the time the event is generated to $tstamp.	2146	Set the time the event is generated to $tstamp (and optionally specifies a
		2147	new $interval).
2006		2148
2007	=item $timer = $timer->interval ($interval)	2149	=item $timer = $timer->interval ($interval)
2008		2150
2009	Normally (and when C<$interval> is C<0>), the timer will automatically	2151	By default (and when C<$interval> is C<0>), the timer will automatically
2010	stop after it has fired once. If C<$interval> is non-zero, then the timer	2152	stop after it has fired once. If C<$interval> is non-zero, then the timer
2011	is automatically rescheduled at the given intervals.	2153	is automatically rescheduled at the given intervals.
2012		2154
2013	=item $timer = $timer->start	2155	=item $timer = $timer->start
2014		2156
2015	Start the timer.	2157	Start the timer.
2016		2158
2017	=item $timer = $timer->start ($tstamp)	2159	=item $timer = $timer->start ($tstamp[, $interval])
2018		2160
2019	Set the event trigger time to C<$tstamp> and start the timer.	2161	Set the event trigger time to C<$tstamp> and start the timer. Optionally
		2162	also replaces the interval.
2020		2163
2021	=item $timer = $timer->after ($delay)	2164	=item $timer = $timer->after ($delay[, $interval])
2022		2165
2023	Like C<start>, but sets the expiry timer to c<urxvt::NOW + $delay>.	2166	Like C<start>, but sets the expiry timer to c<urxvt::NOW + $delay>.
2024		2167
2025	=item $timer = $timer->stop	2168	=item $timer = $timer->stop
2026		2169
…		…
2157		2300
2158	=back	2301	=back
2159		2302
2160	=head1 AUTHOR	2303	=head1 AUTHOR
2161		2304
2162	Marc Lehmann <pcg@goof.com>	2305	Marc Lehmann <schmorp@schmorp.de>
2163	http://software.schmorp.de/pkg/rxvt-unicode	2306	http://software.schmorp.de/pkg/rxvt-unicode
2164		2307
2165	=cut	2308	=cut
2166		2309
2167	1	2310	1

Diff Legend

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