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.155 by tpope, Sun Jun 10 23:42:36 2007 UTC vs.
Revision 1.249 by root, Fri Dec 26 21:26:37 2014 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 and also default bindings for one or
50		51	more actions it provides using so called META comments, described
51	(More) intelligent selection. This extension tries to be more intelligent	52	below. Similarly to builtin resources, extension resources can also be
52	when the user extends selections (double-click and further clicks). Right	53	specified on the command line as long options (with C<.> replaced by
53	now, it tries to select words, urls and complete shell-quoted	54	C<->), in which case the corresponding extension is loaded
54	arguments, which is very convenient, too, if your F<ls> supports	55	automatically. For this to work the extension B<must> define META
55	C<--quoting-style=shell>.	56	comments for its resources.
56
57	A double-click usually selects the word under the cursor, further clicks
58	will enlarge the selection.
59
60	The selection works by trying to match a number of regexes and displaying
61	them in increasing order of length. You can add your own regexes by
62	specifying resources of the form:
63
64	URxvt.selection.pattern-0: perl-regex
65	URxvt.selection.pattern-1: perl-regex
66	...
67
68	The index number (0, 1...) must not have any holes, and each regex must
69	contain at least one pair of capturing parentheses, which will be used for
70	the match. For example, the following adds a regex that matches everything
71	between two vertical bars:
72
73	URxvt.selection.pattern-0: \\|([^|]+)\\|
74
75	Another example: Programs I use often output "absolute path: " at the
76	beginning of a line when they process multiple files. The following
77	pattern matches the filename (note, there is a single space at the very
78	end):
79
80	URxvt.selection.pattern-0: ^(/[^:]+):\
81
82	You can look at the source of the selection extension to see more
83	interesting uses, such as parsing a line from beginning to end.
84
85	This extension also offers following bindable keyboard commands:
86
87	=over 4
88
89	=item rot13
90
91	Rot-13 the selection when activated. Used via keyboard trigger:
92
93	URxvt.keysym.C-M-r: perl:selection:rot13
94
95	=back
96
97	=item option-popup (enabled by default)
98
99	Binds a popup menu to Ctrl-Button2 that lets you toggle (some) options at
100	runtime.
101
102	Other extensions can extend this popup menu by pushing a code reference
103	onto C<@{ $term->{option_popup_hook} }>, which gets called whenever the
104	popup is being displayed.
105
106	It's sole argument is the popup menu, which can be modified. It should
107	either return nothing or a string, the initial boolean value and a code
108	reference. The string will be used as button text and the code reference
109	will be called when the toggle changes, with the new boolean value as
110	first argument.
111
112	The following will add an entry C<myoption> that changes
113	C<$self->{myoption}>:
114
115	push @{ $self->{term}{option_popup_hook} }, sub {
116	("my option" => $myoption, sub { $self->{myoption} = $_[0] })
117	};
118
119	=item selection-popup (enabled by default)
120
121	Binds a popup menu to Ctrl-Button3 that lets you convert the selection
122	text into various other formats/action (such as uri unescaping, perl
123	evaluation, web-browser starting etc.), depending on content.
124
125	Other extensions can extend this popup menu by pushing a code reference
126	onto C<@{ $term->{selection_popup_hook} }>, which gets called whenever the
127	popup is being displayed.
128
129	It's sole argument is the popup menu, which can be modified. The selection
130	is in C<$_>, which can be used to decide whether to add something or not.
131	It should either return nothing or a string and a code reference. The
132	string will be used as button text and the code reference will be called
133	when the button gets activated and should transform C<$_>.
134
135	The following will add an entry C<a to b> that transforms all C<a>s in
136	the selection to C<b>s, but only if the selection currently contains any
137	C<a>s:
138
139	push @{ $self->{term}{selection_popup_hook} }, sub {
140	/a/ ? ("a to be" => sub { s/a/b/g }
141	: ()
142	};
143
144	=item searchable-scrollback<hotkey> (enabled by default)
145
146	Adds regex search functionality to the scrollback buffer, triggered
147	by a hotkey (default: C<M-s>). While in search mode, normal terminal
148	input/output is suspended and a regex is displayed at the bottom of the
149	screen.
150
151	Inputting characters appends them to the regex and continues incremental
152	search. C<BackSpace> removes a character from the regex, C<Up> and C<Down>
153	search upwards/downwards in the scrollback buffer, C<End> jumps to the
154	bottom. C<Escape> leaves search mode and returns to the point where search
155	was started, while C<Enter> or C<Return> stay at the current position and
156	additionally stores the first match in the current line into the primary
157	selection.
158
159	The regex defaults to "(?i)", resulting in a case-insensitive search. To
160	get a case-sensitive search you can delete this prefix using C<BackSpace>
161	or simply use an uppercase character which removes the "(?i)" prefix.
162
163	See L<perlre> for more info about perl regular expression syntax.
164
165	=item readline (enabled by default)
166
167	A support package that tries to make editing with readline easier. At
168	the moment, it reacts to clicking shift-left mouse button by trying to
169	move the text cursor to this position. It does so by generating as many
170	cursor-left or cursor-right keypresses as required (the this only works
171	for programs that correctly support wide characters).
172
173	To avoid too many false positives, this is only done when:
174
175	=over 4
176
177	=item - the tty is in ICANON state.
178
179	=item - the text cursor is visible.
180
181	=item - the primary screen is currently being displayed.
182
183	=item - the mouse is on the same (multi-row-) line as the text cursor.
184
185	=back
186
187	The normal selection mechanism isn't disabled, so quick successive clicks
188	might interfere with selection creation in harmless ways.
189
190	=item selection-autotransform
191
192	This selection allows you to do automatic transforms on a selection
193	whenever a selection is made.
194
195	It works by specifying perl snippets (most useful is a single C<s///>
196	operator) that modify C<$_> as resources:
197
198	URxvt.selection-autotransform.0: transform
199	URxvt.selection-autotransform.1: transform
200	...
201
202	For example, the following will transform selections of the form
203	C<filename:number>, often seen in compiler messages, into C<vi +$filename
204	$word>:
205
206	URxvt.selection-autotransform.0: s/^([^:[:space:]]+):(\\d+):?$/vi +$2 \\Q$1\\E\\x0d/
207
208	And this example matches the same,but replaces it with vi-commands you can
209	paste directly into your (vi :) editor:
210
211	URxvt.selection-autotransform.0: s/^([^:[:space:]]+(\\d+):?$/:e \\Q$1\\E\\x0d:$2\\x0d/
212
213	Of course, this can be modified to suit your needs and your editor :)
214
215	To expand the example above to typical perl error messages ("XXX at
216	FILENAME line YYY."), you need a slightly more elaborate solution:
217
218	URxvt.selection.pattern-0: ( at .*? line \\d+[,.])
219	URxvt.selection-autotransform.0: s/^ at (.*?) line (\\d+)[,.]$/:e \\Q$1\E\\x0d:$2\\x0d/
220
221	The first line tells the selection code to treat the unchanging part of
222	every error message as a selection pattern, and the second line transforms
223	the message into vi commands to load the file.
224
225	=item tabbed
226
227	This transforms the terminal into a tabbar with additional terminals, that
228	is, it implements what is commonly referred to as "tabbed terminal". The topmost line
229	displays a "[NEW]" button, which, when clicked, will add a new tab, followed by one
230	button per tab.
231
232	Clicking a button will activate that tab. Pressing B<Shift-Left> and
233	B<Shift-Right> will switch to the tab left or right of the current one,
234	while B<Shift-Down> creates a new tab.
235
236	The tabbar itself can be configured similarly to a normal terminal, but
237	with a resource class of C<URxvt.tabbed>. In addition, it supports the
238	following four resources (shown with defaults):
239
240	URxvt.tabbed.tabbar-fg: <colour-index, default 3>
241	URxvt.tabbed.tabbar-bg: <colour-index, default 0>
242	URxvt.tabbed.tab-fg: <colour-index, default 0>
243	URxvt.tabbed.tab-bg: <colour-index, default 1>
244
245	See I<COLOR AND GRAPHICS> in the @@RXVT_NAME@@(1) manpage for valid
246	indices.
247
248	=item matcher
249
250	Uses per-line display filtering (C<on_line_update>) to underline text
251	matching a certain pattern and make it clickable. When clicked with the
252	mouse button specified in the C<matcher.button> resource (default 2, or
253	middle), the program specified in the C<matcher.launcher> resource
254	(default, the C<urlLauncher> resource, C<sensible-browser>) will be started
255	with the matched text as first argument. The default configuration is
256	suitable for matching URLs and launching a web browser, like the
257	former "mark-urls" extension.
258
259	The default pattern to match URLs can be overridden with the
260	C<matcher.pattern.0> resource, and additional patterns can be specified
261	with numbered patterns, in a manner similar to the "selection" extension.
262	The launcher can also be overridden on a per-pattern basis.
263
264	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		57
393	=head1 API DOCUMENTATION	58	=head1 API DOCUMENTATION
394		59
395	=head2 General API Considerations	60	=head2 General API Considerations
396		61
…		…
410		75
411	=over 4	76	=over 4
412		77
413	=item $text	78	=item $text
414		79
415	Rxvt-unicodes special way of encoding text, where one "unicode" character	80	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.	81	always represents one screen cell. See L<ROW_t> for a discussion of this format.
417		82
418	=item $string	83	=item $string
419		84
420	A perl text string, with an emphasis on I<text>. It can store all unicode	85	A perl text string, with an emphasis on I<text>. It can store all unicode
…		…
424	=item $octets	89	=item $octets
425		90
426	Either binary data or - more common - a text string encoded in a	91	Either binary data or - more common - a text string encoded in a
427	locale-specific way.	92	locale-specific way.
428		93
		94	=item $keysym
		95
		96	an integer that is a valid X11 keysym code. You can convert a string
		97	into a keysym and viceversa by using C<XStringToKeysym> and
		98	C<XKeysymToString>.
		99
429	=back	100	=back
430		101
431	=head2 Extension Objects	102	=head2 Extension Objects
432		103
433	Every perl extension is a perl class. A separate perl object is created	104	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,	105	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	106	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	107	their C<$self> object without having to think about clashes with other
437	extensions or other terminals, with the exception of methods and members	108	extensions or other terminals, with the exception of methods and members
438	that begin with an underscore character C<_>: these are reserved for	109	that begin with an underscore character C<_>: these are reserved for
439	internal use.	110	internal use.
440		111
441	Although it isn't a C<urxvt::term> object, you can call all methods of the	112	Although it isn't a C<urxvt::term> object, you can call all methods of the
442	C<urxvt::term> class on this object.	113	C<urxvt::term> class on this object.
443		114
444	It has the following methods and data members:	115	Additional methods only supported for extension objects are described in
		116	the C<urxvt::extension> section below.
		117
		118	=head2 META comments
		119
		120	Rxvt-unicode recognizes special meta comments in extensions that define
		121	different types of metadata.
		122
		123	Currently, it recxognises only one such comment:
445		124
446	=over 4	125	=over 4
447		126
448	=item $urxvt_term = $self->{term}	127	=item #:META:RESOURCE:name:type:desc
449		128
450	Returns the C<urxvt::term> object associated with this instance of the	129	The RESOURCE comment defines a resource used by the extension, where
451	extension. This member I<must not> be changed in any way.	130	C<name> is the resource name, C<type> is the resource type, C<boolean>
452		131	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		132
463	=back	133	=back
464		134
465	=head2 Hooks	135	=head2 Hooks
466		136
…		…
554		224
555	It is called before lines are scrolled out (so rows 0 .. min ($lines - 1,	225	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	226	$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.	227	number of lines that will be in the scrollback buffer.
558		228
559	=item on_osc_seq $term, $op, $args	229	=item on_osc_seq $term, $op, $args, $resp
560		230
561	Called on every OSC sequence and can be used to suppress it or modify its	231	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	232	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	233	suppresses execution of the request completely. Make sure you don't get
564	confused by recursive invocations when you output an osc sequence within	234	confused by recursive invocations when you output an OSC sequence within
565	this callback.	235	this callback.
566		236
567	C<on_osc_seq_perl> should be used for new behaviour.	237	C<on_osc_seq_perl> should be used for new behaviour.
568		238
569	=item on_osc_seq_perl $term, $string	239	=item on_osc_seq_perl $term, $args, $resp
570		240
571	Called whenever the B<ESC ] 777 ; string ST> command sequence (OSC =	241	Called whenever the B<ESC ] 777 ; string ST> command sequence (OSC =
572	operating system command) is processed. Cursor position and other state	242	operating system command) is processed. Cursor position and other state
573	information is up-to-date when this happens. For interoperability, the	243	information is up-to-date when this happens. For interoperability, the
574	string should start with the extension name and a colon, to distinguish	244	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	245	to distinguish it from commands for other extensions, and this might be
576	future.	246	enforced in the future.
		247
		248	For example, C<overlay-osc> uses this:
		249
		250	sub on_osc_seq_perl {
		251	my ($self, $osc, $resp) = @_;
		252
		253	return unless $osc =~ s/^overlay;//;
		254
		255	... process remaining $osc string
		256	}
577		257
578	Be careful not ever to trust (in a security sense) the data you receive,	258	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	259	as its source can not easily be controlled (e-mail content, messages from
580	other users on the same system etc.).	260	other users on the same system etc.).
		261
		262	For responses, C<$resp> contains the end-of-args separator used by the
		263	sender.
581		264
582	=item on_add_lines $term, $string	265	=item on_add_lines $term, $string
583		266
584	Called whenever text is about to be output, with the text as argument. You	267	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	268	can filter/change and output the text yourself by returning a true value
…		…
590	=item on_tt_write $term, $octets	273	=item on_tt_write $term, $octets
591		274
592	Called whenever some data is written to the tty/pty and can be used to	275	Called whenever some data is written to the tty/pty and can be used to
593	suppress or filter tty input.	276	suppress or filter tty input.
594		277
		278	=item on_tt_paste $term, $octets
		279
		280	Called whenever text is about to be pasted, with the text as argument. You
		281	can filter/change and paste the text yourself by returning a true value
		282	and calling C<< $term->tt_paste >> yourself. C<$octets> is
		283	locale-encoded.
		284
595	=item on_line_update $term, $row	285	=item on_line_update $term, $row
596		286
597	Called whenever a line was updated or changed. Can be used to filter	287	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	288	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,	289	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	296	later with the already-modified line (e.g. if unrelated parts change), so
607	you cannot just toggle rendition bits, but only set them.	297	you cannot just toggle rendition bits, but only set them.
608		298
609	=item on_refresh_begin $term	299	=item on_refresh_begin $term
610		300
611	Called just before the screen gets redrawn. Can be used for overlay	301	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	302	similar effects by modifying the terminal contents in refresh_begin, and
613	restoring them in refresh_end. The built-in overlay and selection display	303	restoring them in refresh_end. The built-in overlay and selection display
614	code is run after this hook, and takes precedence.	304	code is run after this hook, and takes precedence.
615		305
616	=item on_refresh_end $term	306	=item on_refresh_end $term
617		307
618	Called just after the screen gets redrawn. See C<on_refresh_begin>.	308	Called just after the screen gets redrawn. See C<on_refresh_begin>.
619		309
		310	=item on_action $term, $string
		311
		312	Called whenever an action is invoked for the corresponding extension
		313	(e.g. via a C<extension:string> builtin action bound to a key, see
		314	description of the B<keysym> resource in the urxvt(1) manpage). The
		315	event is simply the action string. Note that an action event is always
		316	associated to a single extension.
		317
620	=item on_user_command $term, $string	318	=item on_user_command $term, $string *DEPRECATED*
621		319
622	Called whenever a user-configured event is being activated (e.g. via	320	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>	321	a C<perl:string> action bound to a key, see description of the B<keysym>
624	resource in the @@RXVT_NAME@@(1) manpage).	322	resource in the urxvt(1) manpage).
625		323
626	The event is simply the action string. This interface is assumed to change	324	The event is simply the action string. This interface is going away in
627	slightly in the future.	325	preference to the C<on_action> hook.
628		326
629	=item on_resize_all_windows $tern, $new_width, $new_height	327	=item on_resize_all_windows $term, $new_width, $new_height
630		328
631	Called just after the new window size has been calculated, but before	329	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	330	windows are actually being resized or hints are being set. If this hook
633	returns TRUE, setting of the window hints is being skipped.	331	returns a true value, setting of the window hints is being skipped.
634		332
635	=item on_x_event $term, $event	333	=item on_x_event $term, $event
636		334
637	Called on every X event received on the vt window (and possibly other	335	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	336	windows). Should only be used as a last resort. Most event structure
…		…
668		366
669	=item on_map_notify $term, $event	367	=item on_map_notify $term, $event
670		368
671	=item on_unmap_notify $term, $event	369	=item on_unmap_notify $term, $event
672		370
673	Called whenever the corresponding X event is received for the terminal If	371	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.	372	the hook returns true, then the event will be ignored by rxvt-unicode.
675		373
676	The event is a hash with most values as named by Xlib (see the XEvent	374	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	375	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.	376	(real, not screen-based) row and column under the mouse cursor.
679		377
680	C<on_key_press> additionally receives the string rxvt-unicode would	378	C<on_key_press> additionally receives the string rxvt-unicode would
681	output, if any, in locale-specific encoding.	379	output, if any, in locale-specific encoding.
682		380
683	subwindow.
684
685	=item on_client_message $term, $event	381	=item on_client_message $term, $event
686		382
687	=item on_wm_protocols $term, $event	383	=item on_wm_protocols $term, $event
688		384
689	=item on_wm_delete_window $term, $event	385	=item on_wm_delete_window $term, $event
690		386
691	Called when various types of ClientMessage events are received (all with	387	Called when various types of ClientMessage events are received (all with
692	format=32, WM_PROTOCOLS or WM_PROTOCOLS:WM_DELETE_WINDOW).	388	format=32, WM_PROTOCOLS or WM_PROTOCOLS:WM_DELETE_WINDOW).
693		389
		390	=item on_bell $term
		391
		392	Called on receipt of a bell character.
		393
694	=back	394	=back
695		395
696	=cut	396	=cut
697		397
698	package urxvt;	398	package urxvt;
699		399
700	use utf8;	400	use utf8;
701	use strict;	401	use strict 'vars';
702	use Carp ();	402	use Carp ();
703	use Scalar::Util ();	403	use Scalar::Util ();
704	use List::Util ();	404	use List::Util ();
705		405
706	our $VERSION = 1;	406	our $VERSION = 1;
707	our $TERM;	407	our $TERM;
708	our @TERM_INIT;	408	our @TERM_INIT; # should go, prevents async I/O etc.
709	our @TERM_EXT;	409	our @TERM_EXT; # should go, prevents async I/O etc.
710	our @HOOKNAME;	410	our @HOOKNAME;
711	our %HOOKTYPE = map +($HOOKNAME[$_] => $_), 0..$#HOOKNAME;	411	our %HOOKTYPE = map +($HOOKNAME[$_] => $_), 0..$#HOOKNAME;
712	our %OPTION;	412	our %OPTION;
713		413
714	our $LIBDIR;	414	our $LIBDIR;
…		…
762		462
763	=over 4	463	=over 4
764		464
765	=item urxvt::fatal $errormessage	465	=item urxvt::fatal $errormessage
766		466
767	Fatally aborts execution with the given error message. Avoid at all	467	Fatally aborts execution with the given error message (which should
768	costs! The only time this is acceptable is when the terminal process	468	include a trailing newline). Avoid at all costs! The only time this
769	starts up.	469	is acceptable (and useful) is in the init hook, where it prevents the
		470	terminal from starting up.
770		471
771	=item urxvt::warn $string	472	=item urxvt::warn $string
772		473
773	Calls C<rxvt_warn> with the given string which should not include a	474	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	475	newline. The module also overwrites the C<warn> builtin with a function
775	that calls this function.	476	that calls this function.
776		477
777	Using this function has the advantage that its output ends up in the	478	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.	479	correct place, e.g. on stderr of the connecting urxvtc client.
…		…
782	=item @terms = urxvt::termlist	483	=item @terms = urxvt::termlist
783		484
784	Returns all urxvt::term objects that exist in this process, regardless of	485	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	486	whether they are started, being destroyed etc., so be careful. Only term
786	objects that have perl extensions attached will be returned (because there	487	objects that have perl extensions attached will be returned (because there
787	is no urxvt::term objet associated with others).	488	is no urxvt::term object associated with others).
788		489
789	=item $time = urxvt::NOW	490	=item $time = urxvt::NOW
790		491
791	Returns the "current time" (as per the event loop).	492	Returns the "current time" (as per the event loop).
792		493
…		…
835		536
836	=item $rend = urxvt::OVERLAY_RSTYLE	537	=item $rend = urxvt::OVERLAY_RSTYLE
837		538
838	Return the rendition mask used for overlays by default.	539	Return the rendition mask used for overlays by default.
839		540
840	=item $rendbit = urxvt::RS_Bold, RS_Italic, RS_Blink, RS_RVid, RS_Uline	541	=item $rendbit = urxvt::RS_Bold, urxvt::RS_Italic, urxvt::RS_Blink,
		542	urxvt::RS_RVid, urxvt::RS_Uline
841		543
842	Return the bit that enabled bold, italic, blink, reverse-video and	544	Return the bit that enabled bold, italic, blink, reverse-video and
843	underline, respectively. To enable such a style, just logically OR it into	545	underline, respectively. To enable such a style, just logically OR it into
844	the bitset.	546	the bitset.
845		547
…		…
882	};	584	};
883	}	585	}
884		586
885	no warnings 'utf8';	587	no warnings 'utf8';
886		588
		589	sub parse_resource {
		590	my ($term, $name, $isarg, $longopt, $flag, $value) = @_;
		591
		592	$term->scan_extensions;
		593
		594	my $r = $term->{meta}{resource};
		595	keys %$r; # reset iterator
		596	while (my ($k, $v) = each %$r) {
		597	my $pattern = $k;
		598	$pattern =~ y/./-/ if $isarg;
		599	my $prefix = $name;
		600	my $suffix;
		601	if ($pattern =~ /\-$/) {
		602	$prefix = substr $name, 0, length $pattern;
		603	$suffix = substr $name, length $pattern;
		604	}
		605	if ($pattern eq $prefix) {
		606	$name = "$urxvt::RESCLASS.$k$suffix";
		607
		608	push @{ $term->{perl_ext_3} }, $v->[0];
		609
		610	if ($v->[1] eq "boolean") {
		611	$term->put_option_db ($name, $flag ? "true" : "false");
		612	return 1;
		613	} else {
		614	$term->put_option_db ($name, $value);
		615	return 1 + 2;
		616	}
		617	}
		618	}
		619
		620	0
		621	}
		622
		623	sub usage {
		624	my ($term, $usage_type) = @_;
		625
		626	$term->scan_extensions;
		627
		628	my $r = $term->{meta}{resource};
		629
		630	for my $pattern (sort keys %$r) {
		631	my ($ext, $type, $desc) = @{ $r->{$pattern} };
		632
		633	$desc .= " (-pe $ext)";
		634
		635	if ($usage_type == 1) {
		636	$pattern =~ y/./-/;
		637	$pattern =~ s/-$/-.../g;
		638
		639	if ($type eq "boolean") {
		640	urxvt::log sprintf " -%-30s %s\n", "/+$pattern", $desc;
		641	} else {
		642	urxvt::log sprintf " -%-30s %s\n", "$pattern $type", $desc;
		643	}
		644	} else {
		645	$pattern =~ s/\.$/.*/g;
		646	urxvt::log sprintf " %-31s %s\n", "$pattern:", $type;
		647	}
		648	}
		649	}
		650
887	my $verbosity = $ENV{URXVT_PERL_VERBOSITY};	651	my $verbosity = $ENV{URXVT_PERL_VERBOSITY};
888		652
889	sub verbose {	653	sub verbose {
890	my ($level, $msg) = @_;	654	my ($level, $msg) = @_;
891	warn "$msg\n" if $level <= $verbosity;	655	warn "$msg\n" if $level <= $verbosity;
…		…
903	$pkg =~ s/[^[:word:]]/_/g;	667	$pkg =~ s/[^[:word:]]/_/g;
904	$pkg = "urxvt::ext::$pkg";	668	$pkg = "urxvt::ext::$pkg";
905		669
906	verbose 3, "loading extension '$path' into package '$pkg'";	670	verbose 3, "loading extension '$path' into package '$pkg'";
907		671
		672	(${"$pkg\::_NAME"} = $path) =~ s/^.*[\\\/]//; # hackish
		673
908	open my $fh, "<:raw", $path	674	open my $fh, "<:raw", $path
909	or die "$path: $!";	675	or die "$path: $!";
910		676
911	my $source =	677	my $source =
912	"package $pkg; use strict; use utf8; no warnings 'utf8';\n"	678	"package $pkg; use strict 'vars'; use utf8; no warnings 'utf8';\n"
913	. "#line 1 \"$path\"\n{\n"	679	. "#line 1 \"$path\"\n{\n"
914	. (do { local $/; <$fh> })	680	. (do { local $/; <$fh> })
915	. "\n};\n1";	681	. "\n};\n1";
916		682
917	eval $source	683	eval $source
…		…
926	# called by the rxvt core	692	# called by the rxvt core
927	sub invoke {	693	sub invoke {
928	local $TERM = shift;	694	local $TERM = shift;
929	my $htype = shift;	695	my $htype = shift;
930		696
931	if ($htype == 0) { # INIT	697	if ($htype == HOOK_INIT) {
932	my @dirs = ((split /:/, $TERM->resource ("perl_lib")), "$LIBDIR/perl");	698	my @dirs = $TERM->perl_libdirs;
933		699
		700	$TERM->scan_extensions;
		701
934	my %ext_arg;	702	my %ext_arg;
935		703
936	{	704	{
937	my @init = @TERM_INIT;	705	my @init = @TERM_INIT;
938	@TERM_INIT = ();	706	@TERM_INIT = ();
…		…
940	my @pkg = @TERM_EXT;	708	my @pkg = @TERM_EXT;
941	@TERM_EXT = ();	709	@TERM_EXT = ();
942	$TERM->register_package ($_) for @pkg;	710	$TERM->register_package ($_) for @pkg;
943	}	711	}
944		712
		713	for (
945	for (grep $_, map { split /,/, $TERM->resource ("perl_ext_$_") } 1, 2) {	714	(grep $_, map { split /,/, $TERM->resource ("perl_ext_$_") } 1, 2),
		715	@{ delete $TERM->{perl_ext_3} }
		716	) {
946	if ($_ eq "default") {	717	if ($_ eq "default") {
		718
		719	$ext_arg{$_} = []
947	$ext_arg{$_} ||= [] for qw(selection option-popup selection-popup searchable-scrollback readline);	720	for qw(selection option-popup selection-popup readline searchable-scrollback);
		721
		722	for ($TERM->_keysym_resources) {
		723	next if /^(?:string|command|builtin|builtin-string|perl)/;
		724	next unless /^([A-Za-z0-9_\-]+):/;
		725
		726	my $ext = $1;
		727
		728	$ext_arg{$ext} = [];
		729	}
		730
948	} elsif (/^-(.*)$/) {	731	} elsif (/^-(.*)$/) {
949	delete $ext_arg{$1};	732	delete $ext_arg{$1};
		733
950	} elsif (/^([^<]+)<(.*)>$/) {	734	} elsif (/^([^<]+)<(.*)>$/) {
951	push @{ $ext_arg{$1} }, $2;	735	push @{ $ext_arg{$1} }, $2;
		736
952	} else {	737	} else {
953	$ext_arg{$_} ||= [];	738	$ext_arg{$_} ||= [];
954	}	739	}
955	}	740	}
956		741
…		…
972		757
973	if (my $cb = $TERM->{_hook}[$htype]) {	758	if (my $cb = $TERM->{_hook}[$htype]) {
974	verbose 10, "$HOOKNAME[$htype] (" . (join ", ", $TERM, @_) . ")"	759	verbose 10, "$HOOKNAME[$htype] (" . (join ", ", $TERM, @_) . ")"
975	if $verbosity >= 10;	760	if $verbosity >= 10;
976		761
		762	if ($htype == HOOK_ACTION) {
		763	# this hook is only sent to the extension with the name
		764	# matching the first arg
		765	my $pkg = shift;
		766	$pkg =~ y/-/_/;
		767	$pkg = "urxvt::ext::$pkg";
		768
		769	$cb = $cb->{$pkg}
		770	or return undef; #TODO: maybe warn user?
		771
		772	$cb = { $pkg => $cb };
		773	}
		774
977	for my $pkg (keys %$cb) {	775	for my $pkg (keys %$cb) {
978	my $retval_ = eval { $cb->{$pkg}->($TERM->{_pkg}{$pkg}, @_) };	776	my $retval_ = eval { $cb->{$pkg}->($TERM->{_pkg}{$pkg} || $TERM, @_) };
979	$retval ||= $retval_;	777	$retval ||= $retval_;
980		778
981	if ($@) {	779	if ($@) {
982	$TERM->ungrab; # better to lose the grab than the session	780	$TERM->ungrab; # better to lose the grab than the session
983	warn $@;	781	warn $@;
…		…
986		784
987	verbose 11, "$HOOKNAME[$htype] returning <$retval>"	785	verbose 11, "$HOOKNAME[$htype] returning <$retval>"
988	if $verbosity >= 11;	786	if $verbosity >= 11;
989	}	787	}
990		788
991	if ($htype == 1) { # DESTROY	789	if ($htype == HOOK_DESTROY) {
992	# clear package objects	790	# clear package objects
993	%$_ = () for values %{ $TERM->{_pkg} };	791	%$_ = () for values %{ $TERM->{_pkg} };
994		792
995	# clear package	793	# clear package
996	%$TERM = ();	794	%$TERM = ();
…		…
1026	}	824	}
1027	}	825	}
1028	($mask, @color{qw(fg bg)}, \@failed)	826	($mask, @color{qw(fg bg)}, \@failed)
1029	}	827	}
1030		828
1031	# urxvt::term::extension
1032
1033	package urxvt::term::extension;	829	package urxvt::term::extension;
1034		830
1035	sub enable {	831	=head2 The C<urxvt::term::extension> class
1036	my ($self, %hook) = @_;
1037	my $pkg = $self->{_pkg};
1038		832
1039	while (my ($name, $cb) = each %hook) {	833	Each extension attached to a terminal object is represented by
1040	my $htype = $HOOKTYPE{uc $name};	834	a C<urxvt::term::extension> object.
1041	defined $htype
1042	or Carp::croak "unsupported hook type '$name'";
1043		835
1044	$self->set_should_invoke ($htype, +1)	836	You can use these objects, which are passed to all callbacks to store any
1045	unless exists $self->{term}{_hook}[$htype]{$pkg};	837	state related to the terminal and extension instance.
1046		838
1047	$self->{term}{_hook}[$htype]{$pkg} = $cb;	839	The methods (And data members) documented below can be called on extension
1048	}	840	objects, in addition to call methods documented for the <urxvt::term>
1049	}	841	class.
1050		842
1051	sub disable {	843	=over 4
1052	my ($self, @hook) = @_;
1053	my $pkg = $self->{_pkg};
1054		844
1055	for my $name (@hook) {	845	=item $urxvt_term = $self->{term}
1056	my $htype = $HOOKTYPE{uc $name};
1057	defined $htype
1058	or Carp::croak "unsupported hook type '$name'";
1059		846
1060	$self->set_should_invoke ($htype, -1)	847	Returns the C<urxvt::term> object associated with this instance of the
1061	if delete $self->{term}{_hook}[$htype]{$pkg};	848	extension. This member I<must not> be changed in any way.
1062	}	849
1063	}	850	=cut
1064		851
1065	our $AUTOLOAD;	852	our $AUTOLOAD;
1066		853
1067	sub AUTOLOAD {	854	sub AUTOLOAD {
1068	$AUTOLOAD =~ /:([^:]+)$/	855	$AUTOLOAD =~ /:([^:]+)$/
…		…
1081		868
1082	sub DESTROY {	869	sub DESTROY {
1083	# nop	870	# nop
1084	}	871	}
1085		872
1086	# urxvt::destroy_hook	873	# urxvt::destroy_hook (basically a cheap Guard:: implementation)
1087		874
1088	sub urxvt::destroy_hook::DESTROY {	875	sub urxvt::destroy_hook::DESTROY {
1089	${$_[0]}->();	876	${$_[0]}->();
1090	}	877	}
1091		878
1092	sub urxvt::destroy_hook(&) {	879	sub urxvt::destroy_hook(&) {
1093	bless \shift, urxvt::destroy_hook::	880	bless \shift, urxvt::destroy_hook::
1094	}	881	}
		882
		883	=item $self->enable ($hook_name => $cb[, $hook_name => $cb..])
		884
		885	Dynamically enable the given hooks (named without the C<on_> prefix) for
		886	this extension, replacing any hook previously installed via C<enable> in
		887	this extension.
		888
		889	This is useful when you want to overwrite time-critical hooks only
		890	temporarily.
		891
		892	To install additional callbacks for the same hook, you can use the C<on>
		893	method of the C<urxvt::term> class.
		894
		895	=item $self->disable ($hook_name[, $hook_name..])
		896
		897	Dynamically disable the given hooks.
		898
		899	=cut
		900
		901	sub enable {
		902	my ($self, %hook) = @_;
		903	my $pkg = $self->{_pkg};
		904
		905	while (my ($name, $cb) = each %hook) {
		906	my $htype = $HOOKTYPE{uc $name};
		907	defined $htype
		908	or Carp::croak "unsupported hook type '$name'";
		909
		910	$self->set_should_invoke ($htype, +1)
		911	unless exists $self->{term}{_hook}[$htype]{$pkg};
		912
		913	$self->{term}{_hook}[$htype]{$pkg} = $cb;
		914	}
		915	}
		916
		917	sub disable {
		918	my ($self, @hook) = @_;
		919	my $pkg = $self->{_pkg};
		920
		921	for my $name (@hook) {
		922	my $htype = $HOOKTYPE{uc $name};
		923	defined $htype
		924	or Carp::croak "unsupported hook type '$name'";
		925
		926	$self->set_should_invoke ($htype, -1)
		927	if delete $self->{term}{_hook}[$htype]{$pkg};
		928	}
		929	}
		930
		931	=item $guard = $self->on ($hook_name => $cb[, $hook_name => $cb..])
		932
		933	Similar to the C<enable> enable, but installs additional callbacks for
		934	the given hook(s) (that is, it doesn't replace existing callbacks), and
		935	returns a guard object. When the guard object is destroyed the callbacks
		936	are disabled again.
		937
		938	=cut
		939
		940	sub urxvt::extension::on_disable::DESTROY {
		941	my $disable = shift;
		942
		943	my $term = delete $disable->{""};
		944
		945	while (my ($htype, $id) = each %$disable) {
		946	delete $term->{_hook}[$htype]{$id};
		947	$term->set_should_invoke ($htype, -1);
		948	}
		949	}
		950
		951	sub on {
		952	my ($self, %hook) = @_;
		953
		954	my $term = $self->{term};
		955
		956	my %disable = ( "" => $term );
		957
		958	while (my ($name, $cb) = each %hook) {
		959	my $htype = $HOOKTYPE{uc $name};
		960	defined $htype
		961	or Carp::croak "unsupported hook type '$name'";
		962
		963	$term->set_should_invoke ($htype, +1);
		964	$term->{_hook}[$htype]{ $disable{$htype} = $cb+0 }
		965	= sub { shift; $cb->($self, @_) }; # very ugly indeed
		966	}
		967
		968	bless \%disable, "urxvt::extension::on_disable"
		969	}
		970
		971	=item $self->bind_action ($hotkey, $action)
		972
		973	=item $self->x_resource ($pattern)
		974
		975	=item $self->x_resource_boolean ($pattern)
		976
		977	These methods support an additional C<%> prefix for C<$action> or
		978	C<$pattern> when called on an extension object, compared to the
		979	C<urxvt::term> methods of the same name - see the description of these
		980	methods in the C<urxvt::term> class for details.
		981
		982	=cut
		983
		984	sub bind_action {
		985	my ($self, $hotkey, $action) = @_;
		986	$action =~ s/^%:/$_[0]{_name}:/;
		987	$self->{term}->bind_action ($hotkey, $action)
		988	}
		989
		990	sub x_resource {
		991	my ($self, $name) = @_;
		992	$name =~ s/^%(\.|$)/$_[0]{_name}$1/;
		993	$self->{term}->x_resource ($name)
		994	}
		995
		996	sub x_resource_boolean {
		997	my ($self, $name) = @_;
		998	$name =~ s/^%(\.|$)/$_[0]{_name}$1/;
		999	$self->{term}->x_resource_boolean ($name)
		1000	}
		1001
		1002	=back
		1003
		1004	=cut
1095		1005
1096	package urxvt::anyevent;	1006	package urxvt::anyevent;
1097		1007
1098	=head2 The C<urxvt::anyevent> Class	1008	=head2 The C<urxvt::anyevent> Class
1099		1009
1100	The sole purpose of this class is to deliver an interface to the	1010	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	1011	C<AnyEvent> module - any module using it will work inside urxvt without
1102	further programming. The only exception is that you cannot wait on	1012	further programming. The only exception is that you cannot wait on
1103	condition variables, but non-blocking condvar use is ok. What this means	1013	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		1014
1107	=cut	1015	In practical terms this means is that you cannot use blocking APIs, but
		1016	the non-blocking variant should work.
1108		1017
		1018	=cut
		1019
1109	our $VERSION = 1;	1020	our $VERSION = '5.23';
1110		1021
1111	$INC{"urxvt/anyevent.pm"} = 1; # mark us as there	1022	$INC{"urxvt/anyevent.pm"} = 1; # mark us as there
1112	push @AnyEvent::REGISTRY, [urxvt => urxvt::anyevent::];	1023	push @AnyEvent::REGISTRY, [urxvt => urxvt::anyevent::];
1113		1024
1114	sub timer {	1025	sub timer {
…		…
1116		1027
1117	my $cb = $arg{cb};	1028	my $cb = $arg{cb};
1118		1029
1119	urxvt::timer	1030	urxvt::timer
1120	->new	1031	->new
1121	->start (urxvt::NOW + $arg{after})	1032	->after ($arg{after}, $arg{interval})
1122	->cb (sub {	1033	->cb ($arg{interval} ? $cb : sub {
1123	$_[0]->stop; # need to cancel manually	1034	$_[0]->stop; # need to cancel manually
1124	$cb->();	1035	$cb->();
1125	})	1036	})
1126	}	1037	}
1127		1038
1128	sub io {	1039	sub io {
1129	my ($class, %arg) = @_;	1040	my ($class, %arg) = @_;
1130		1041
1131	my $cb = $arg{cb};	1042	my $cb = $arg{cb};
		1043	my $fd = fileno $arg{fh};
		1044	defined $fd or $fd = $arg{fh};
1132		1045
1133	bless [$arg{fh}, urxvt::iow	1046	bless [$arg{fh}, urxvt::iow
1134	->new	1047	->new
1135	->fd (fileno $arg{fh})	1048	->fd ($fd)
1136	->events (($arg{poll} =~ /r/ ? 1 : 0)	1049	->events (($arg{poll} =~ /r/ ? 1 : 0)
1137	| ($arg{poll} =~ /w/ ? 2 : 0))	1050	| ($arg{poll} =~ /w/ ? 2 : 0))
1138	->start	1051	->start
1139	->cb (sub {	1052	->cb ($cb)
1140	$cb->(($_[1] & 1 ? 'r' : '')
1141	. ($_[1] & 2 ? 'w' : ''));
1142	})],
1143	urxvt::anyevent::	1053	], urxvt::anyevent::
		1054	}
		1055
		1056	sub idle {
		1057	my ($class, %arg) = @_;
		1058
		1059	my $cb = $arg{cb};
		1060
		1061	urxvt::iw
		1062	->new
		1063	->start
		1064	->cb ($cb)
		1065	}
		1066
		1067	sub child {
		1068	my ($class, %arg) = @_;
		1069
		1070	my $cb = $arg{cb};
		1071
		1072	urxvt::pw
		1073	->new
		1074	->start ($arg{pid})
		1075	->cb (sub {
		1076	$_[0]->stop; # need to cancel manually
		1077	$cb->($_[0]->rpid, $_[0]->rstatus);
		1078	})
1144	}	1079	}
1145		1080
1146	sub DESTROY {	1081	sub DESTROY {
1147	$_[0][1]->stop;	1082	$_[0][1]->stop;
1148	}	1083	}
1149		1084
1150	sub condvar {	1085	# 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 {	1086	sub one_event {
1165	Carp::croak "AnyEvent->one_event blocking wait unsupported in urxvt, use a non-blocking API";	1087	Carp::croak "AnyEvent->one_event blocking wait unsupported in urxvt, use a non-blocking API";
1166	}	1088	}
1167		1089
1168	package urxvt::term;	1090	package urxvt::term;
…		…
1183	urxvt::verbose 6, "register package $pkg to $self";	1105	urxvt::verbose 6, "register package $pkg to $self";
1184		1106
1185	@{"$pkg\::ISA"} = urxvt::term::extension::;	1107	@{"$pkg\::ISA"} = urxvt::term::extension::;
1186		1108
1187	my $proxy = bless {	1109	my $proxy = bless {
1188	_pkg => $pkg,	1110	_pkg => $pkg,
		1111	_name => ${"$pkg\::_NAME"}, # hackish
1189	argv => $argv,	1112	argv => $argv,
1190	}, $pkg;	1113	}, $pkg;
1191	Scalar::Util::weaken ($proxy->{term} = $self);	1114	Scalar::Util::weaken ($proxy->{term} = $self);
1192		1115
1193	$self->{_pkg}{$pkg} = $proxy;	1116	$self->{_pkg}{$pkg} = $proxy;
1194		1117
…		…
1197	$proxy->enable ($name => $ref);	1120	$proxy->enable ($name => $ref);
1198	}	1121	}
1199	}	1122	}
1200	}	1123	}
1201		1124
		1125	sub perl_libdirs {
		1126	map { split /:/ }
		1127	$_[0]->resource ("perl_lib"),
		1128	$ENV{URXVT_PERL_LIB},
		1129	"$ENV{HOME}/.urxvt/ext",
		1130	"$LIBDIR/perl"
		1131	}
		1132
		1133	# scan for available extensions and collect their metadata
		1134	sub scan_extensions {
		1135	my ($self) = @_;
		1136
		1137	return if exists $self->{meta};
		1138
		1139	my @urxvtdirs = perl_libdirs $self;
		1140	my @cpandirs = grep -d, map "$_/URxvt/Ext", @INC;
		1141
		1142	$self->{meta} = \my %meta;
		1143
		1144	# first gather extensions
		1145
		1146	my $gather = sub {
		1147	my ($dir, $core) = @_;
		1148
		1149	opendir my $fh, $dir
		1150	or return;
		1151
		1152	for my $ext (readdir $fh) {
		1153	$ext !~ /^\./
		1154	or next;
		1155
		1156	open my $fh, "<", "$dir/$ext"
		1157	or next;
		1158
		1159	-f $fh
		1160	or next;
		1161
		1162	$ext =~ s/\.uext$// or $core
		1163	or next;
		1164
		1165	my %ext = (dir => $dir);
		1166
		1167	while (<$fh>) {
		1168	if (/^#:META:(?:X_)?RESOURCE:(.*)/) {
		1169	my ($pattern, $type, $desc) = split /:/, $1;
		1170	$pattern =~ s/^%(\.|$)/$ext$1/g; # % in pattern == extension name
		1171	if ($pattern =~ /[^a-zA-Z0-9\-\.]/) {
		1172	warn "$dir/$ext: meta resource '$pattern' contains illegal characters (not alphanumeric nor . nor *)\n";
		1173	} else {
		1174	$ext{resource}{$pattern} = [$ext, $type, $desc];
		1175	}
		1176	} elsif (/^\s*(?:#|$)/) {
		1177	# skip other comments and empty lines
		1178	} else {
		1179	last; # stop parsing on first non-empty non-comment line
		1180	}
		1181	}
		1182
		1183	$meta{ext}{$ext} = \%ext;
		1184	}
		1185	};
		1186
		1187	$gather->($_, 0) for @cpandirs;
		1188	$gather->($_, 1) for @urxvtdirs;
		1189
		1190	# and now merge resources
		1191	while (my ($k, $v) = each %{ $meta{ext} }) {
		1192	#TODO: should check for extensions overriding each other
		1193	%{ $meta{resource} } = (%{ $meta{resource} }, %{ $v->{resource} });
		1194	}
		1195	}
		1196
1202	=item $term = new urxvt::term $envhashref, $rxvtname, [arg...]	1197	=item $term = new urxvt::term $envhashref, $rxvtname, [arg...]
1203		1198
1204	Creates a new terminal, very similar as if you had started it with system	1199	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	1200	C<$rxvtname, arg...>. C<$envhashref> must be a reference to a C<%ENV>-like
1206	hash which defines the environment of the new terminal.	1201	hash which defines the environment of the new terminal.
…		…
1223	}	1218	}
1224		1219
1225	=item $term->destroy	1220	=item $term->destroy
1226		1221
1227	Destroy the terminal object (close the window, free resources	1222	Destroy the terminal object (close the window, free resources
1228	etc.). Please note that @@RXVT_NAME@@ will not exit as long as any event	1223	etc.). Please note that urxvt will not exit as long as any event
1229	watchers (timers, io watchers) are still active.	1224	watchers (timers, io watchers) are still active.
1230		1225
1231	=item $term->exec_async ($cmd[, @args])	1226	=item $term->exec_async ($cmd[, @args])
1232		1227
1233	Works like the combination of the C<fork>/C<exec> builtins, which executes	1228	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.	1255	C<%urxvt::OPTION>. Options not enabled in this binary are not in the hash.
1261		1256
1262	Here is a likely non-exhaustive list of option names, please see the	1257	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:	1258	source file F</src/optinc.h> to see the actual list:
1264		1259
1265	borderLess console cursorBlink cursorUnderline hold iconic insecure	1260	borderLess buffered console cursorBlink cursorUnderline hold iconic
1266	intensityStyles jumpScroll loginShell mapAlert meta8 mouseWheelScrollPage	1261	insecure intensityStyles iso14755 iso14755_52 jumpScroll loginShell
1267	override-redirect pastableTabs pointerBlank reverseVideo scrollBar	1262	mapAlert meta8 mouseWheelScrollPage override_redirect pastableTabs
1268	scrollBar_floating scrollBar_right scrollTtyKeypress scrollTtyOutput	1263	pointerBlank reverseVideo scrollBar scrollBar_floating scrollBar_right
1269	scrollWithBuffer secondaryScreen secondaryScroll skipBuiltinGlyphs	1264	scrollTtyKeypress scrollTtyOutput scrollWithBuffer secondaryScreen
1270	transparent tripleclickwords utmpInhibit visualBell	1265	secondaryScroll skipBuiltinGlyphs skipScroll transparent tripleclickwords
		1266	urgentOnBell utmpInhibit visualBell
1271		1267
1272	=item $value = $term->resource ($name[, $newval])	1268	=item $value = $term->resource ($name[, $newval])
1273		1269
1274	Returns the current resource value associated with a given name and	1270	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>	1271	optionally sets a new value. Setting values is most useful in the C<init>
…		…
1288		1284
1289	Here is a likely non-exhaustive list of resource names, not all of which	1285	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>	1286	are supported in every build, please see the source file F</src/rsinc.h>
1291	to see the actual list:	1287	to see the actual list:
1292		1288
1293	answerbackstring backgroundPixmap backspace_key boldFont boldItalicFont	1289	answerbackstring backgroundPixmap backspace_key blurradius
1294	borderLess color cursorBlink cursorUnderline cutchars delete_key	1290	boldFont boldItalicFont borderLess buffered chdir color cursorBlink
1295	display_name embed ext_bwidth fade font geometry hold iconName	1291	cursorUnderline cutchars delete_key depth display_name embed ext_bwidth
1296	imFont imLocale inputMethod insecure int_bwidth intensityStyles	1292	fade font geometry hold iconName iconfile imFont imLocale inputMethod
		1293	insecure int_bwidth intensityStyles iso14755 iso14755_52 italicFont
1297	italicFont jumpScroll lineSpace loginShell mapAlert meta8 modifier	1294	jumpScroll letterSpace lineSpace loginShell mapAlert meta8 modifier
1298	mouseWheelScrollPage name override_redirect pastableTabs path perl_eval	1295	mouseWheelScrollPage name override_redirect pastableTabs path perl_eval
1299	perl_ext_1 perl_ext_2 perl_lib pointerBlank pointerBlankDelay	1296	perl_ext_1 perl_ext_2 perl_lib pointerBlank pointerBlankDelay
1300	preeditType print_pipe pty_fd reverseVideo saveLines scrollBar	1297	preeditType print_pipe pty_fd reverseVideo saveLines scrollBar
1301	scrollBar_align scrollBar_floating scrollBar_right scrollBar_thickness	1298	scrollBar_align scrollBar_floating scrollBar_right scrollBar_thickness
1302	scrollTtyKeypress scrollTtyOutput scrollWithBuffer scrollstyle	1299	scrollTtyKeypress scrollTtyOutput scrollWithBuffer scrollstyle
1303	secondaryScreen secondaryScroll selectstyle shade term_name title	1300	secondaryScreen secondaryScroll shade skipBuiltinGlyphs skipScroll
1304	transient_for transparent transparent_all tripleclickwords utmpInhibit	1301	term_name title transient_for transparent tripleclickwords urgentOnBell
1305	visualBell	1302	utmpInhibit visualBell
1306		1303
1307	=cut	1304	=cut
1308		1305
1309	sub resource($$;$) {	1306	sub resource($$;$) {
1310	my ($self, $name) = (shift, shift);	1307	my ($self, $name) = (shift, shift);
1311	unshift @_, $self, $name, ($name =~ s/\s*\+\s*(\d+)$// ? $1 : 0);	1308	unshift @_, $self, $name, ($name =~ s/\s*\+\s*(\d+)$// ? $1 : 0);
1312	&urxvt::term::_resource	1309	goto &urxvt::term::_resource
1313	}	1310	}
1314		1311
1315	=item $value = $term->x_resource ($pattern)	1312	=item $value = $term->x_resource ($pattern)
1316		1313
1317	Returns the X-Resource for the given pattern, excluding the program or	1314	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	1315	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	1316	same value as used by this instance of rxvt-unicode. Returns C<undef> if no
1320	resource with that pattern exists.	1317	resource with that pattern exists.
1321		1318
		1319	Extensions that define extra resources also need to call this method
		1320	to access their values.
		1321
		1322	If the method is called on an extension object (basically, from an
		1323	extension), then the special prefix C<%.> will be replaced by the name of
		1324	the extension and a dot, and the lone string C<%> will be replaced by the
		1325	extension name itself. This makes it possible to code extensions so you
		1326	can rename them and get a new set of resources without having to change
		1327	the actual code.
		1328
1322	This method should only be called during the C<on_start> hook, as there is	1329	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	1330	only one resource database per display, and later invocations might return
1324	the wrong resources.	1331	the wrong resources.
1325		1332
1326	=item $success = $term->parse_keysym ($keysym_spec, $command_string)	1333	=item $value = $term->x_resource_boolean ($pattern)
1327		1334
		1335	Like C<x_resource>, above, but interprets the string value as a boolean
		1336	and returns C<1> for true values, C<0> for false values and C<undef> if
		1337	the resource or option isn't specified.
		1338
		1339	You should always use this method to parse boolean resources.
		1340
		1341	=cut
		1342
		1343	sub x_resource_boolean {
		1344	my $res = &x_resource;
		1345
		1346	$res =~ /^\s*(?:true|yes|on|1)\s*$/i ? 1 : defined $res && 0
		1347	}
		1348
		1349	=item $success = $term->bind_action ($key, $action)
		1350
1328	Adds a keymap translation exactly as specified via a resource. See the	1351	Adds a key binding exactly as specified via a C<keysym> resource. See the
1329	C<keysym> resource in the @@RXVT_NAME@@(1) manpage.	1352	C<keysym> resource in the urxvt(1) manpage.
		1353
		1354	To add default bindings for an extension, the extension should call C<<
		1355	->bind_action >> on it's C<init> hook for every such binding. Doing it
		1356	in the C<init> hook allows users the override or remove the the binding
		1357	again.
		1358
		1359	Example: the C<searchable-scrollback> by default binds itself
		1360	on C<Meta-s>, using C<< $self->bind_action >>, which calls C<<
		1361	$term->bind_action >>.
		1362
		1363	sub init {
		1364	my ($self) = @_;
		1365
		1366	$self->bind_action ("M-s" => "%:start");
		1367	}
1330		1368
1331	=item $rend = $term->rstyle ([$new_rstyle])	1369	=item $rend = $term->rstyle ([$new_rstyle])
1332		1370
1333	Return and optionally change the current rendition. Text that is output by	1371	Return and optionally change the current rendition. Text that is output by
1334	the terminal application will use this style.	1372	the terminal application will use this style.
…		…
1342		1380
1343	=item ($row, $col) = $term->selection_beg ([$row, $col])	1381	=item ($row, $col) = $term->selection_beg ([$row, $col])
1344		1382
1345	=item ($row, $col) = $term->selection_end ([$row, $col])	1383	=item ($row, $col) = $term->selection_end ([$row, $col])
1346		1384
1347	Return the current values of the selection mark, begin or end positions,	1385	Return the current values of the selection mark, begin or end positions.
1348	and optionally set them to new values.	1386
		1387	When arguments are given, then the selection coordinates are set to
		1388	C<$row> and C<$col>, and the selection screen is set to the current
		1389	screen.
		1390
		1391	=item $screen = $term->selection_screen ([$screen])
		1392
		1393	Returns the current selection screen, and then optionally sets it.
1349		1394
1350	=item $term->selection_make ($eventtime[, $rectangular])	1395	=item $term->selection_make ($eventtime[, $rectangular])
1351		1396
1352	Tries to make a selection as set by C<selection_beg> and	1397	Tries to make a selection as set by C<selection_beg> and
1353	C<selection_end>. If C<$rectangular> is true (default: false), a	1398	C<selection_end>. If C<$rectangular> is true (default: false), a
1354	rectangular selection will be made. This is the prefered function to make	1399	rectangular selection will be made. This is the preferred function to make
1355	a selection.	1400	a selection.
1356		1401
1357	=item $success = $term->selection_grab ($eventtime)	1402	=item $success = $term->selection_grab ($eventtime[, $clipboard])
1358		1403
1359	Try to request the primary selection text from the server (for example, as	1404	Try to acquire ownership of the primary (clipboard if C<$clipboard> is
		1405	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	1406	with the next method. No visual feedback will be given. This function
1361	is mostly useful from within C<on_sel_grab> hooks.	1407	is mostly useful from within C<on_sel_grab> hooks.
1362		1408
1363	=item $oldtext = $term->selection ([$newtext])	1409	=item $oldtext = $term->selection ([$newtext, $clipboard])
1364		1410
1365	Return the current selection text and optionally replace it by C<$newtext>.	1411	Return the current selection (clipboard if C<$clipboard> is true) text
		1412	and optionally replace it by C<$newtext>.
		1413
		1414	=item $term->selection_clear ([$clipboard])
		1415
		1416	Revoke ownership of the primary (clipboard if C<$clipboard> is true) selection.
1366		1417
1367	=item $term->overlay_simple ($x, $y, $text)	1418	=item $term->overlay_simple ($x, $y, $text)
1368		1419
1369	Create a simple multi-line overlay box. See the next method for details.	1420	Create a simple multi-line overlay box. See the next method for details.
1370		1421
…		…
1400		1451
1401	The methods currently supported on C<urxvt::overlay> objects are:	1452	The methods currently supported on C<urxvt::overlay> objects are:
1402		1453
1403	=over 4	1454	=over 4
1404		1455
1405	=item $overlay->set ($x, $y, $text, $rend)	1456	=item $overlay->set ($x, $y, $text[, $rend])
1406		1457
1407	Similar to C<< $term->ROW_t >> and C<< $term->ROW_r >> in that it puts	1458	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	1459	text in rxvt-unicode's special encoding and an array of rendition values
1409	at a specific position inside the overlay.	1460	at a specific position inside the overlay.
		1461
		1462	If C<$rend> is missing, then the rendition will not be changed.
1410		1463
1411	=item $overlay->hide	1464	=item $overlay->hide
1412		1465
1413	If visible, hide the overlay, but do not destroy it.	1466	If visible, hide the overlay, but do not destroy it.
1414		1467
…		…
1477		1530
1478	=item $term->scr_add_lines ($string)	1531	=item $term->scr_add_lines ($string)
1479		1532
1480	Write the given text string to the screen, as if output by the application	1533	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	1534	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	1535	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.	1536	carriage returns and tabs. The string is a normal text string, not in
		1537	locale-dependent encoding.
1484		1538
1485	Normally its not a good idea to use this function, as programs might be	1539	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	1540	confused by changes in cursor position or scrolling. Its useful inside a
1487	C<on_add_lines> hook, though.	1541	C<on_add_lines> hook, though.
1488		1542
…		…
1496	locale-specific encoding of the terminal and can contain command sequences	1550	locale-specific encoding of the terminal and can contain command sequences
1497	(escape codes) that will be interpreted.	1551	(escape codes) that will be interpreted.
1498		1552
1499	=item $term->tt_write ($octets)	1553	=item $term->tt_write ($octets)
1500		1554
1501	Write the octets given in C<$data> to the tty (i.e. as program input). To	1555	Write the octets given in C<$octets> to the tty (i.e. as user input
		1556	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	1557	characters instead of octets, you should convert your strings first to the
1503	to the locale-specific encoding using C<< $term->locale_encode >>.	1558	locale-specific encoding using C<< $term->locale_encode >>.
		1559
		1560	=item $term->tt_write_user_input ($octets)
		1561
		1562	Like C<tt_write>, but should be used when writing strings in response to
		1563	the user pressing a key, to invoke the additional actions requested by
		1564	the user for that case (C<tt_write> doesn't do that).
		1565
		1566	The typical use case would be inside C<on_action> hooks.
		1567
		1568	=item $term->tt_paste ($octets)
		1569
		1570	Write the octets given in C<$octets> to the tty as a paste, converting NL to
		1571	CR and bracketing the data with control sequences if bracketed paste mode
		1572	is set.
1504		1573
1505	=item $old_events = $term->pty_ev_events ([$new_events])	1574	=item $old_events = $term->pty_ev_events ([$new_events])
1506		1575
1507	Replaces the event mask of the pty watcher by the given event mask. Can	1576	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	1577	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	1596	Adds the specified events to the vt event mask. Useful e.g. when you want
1528	to receive pointer events all the times:	1597	to receive pointer events all the times:
1529		1598
1530	$term->vt_emask_add (urxvt::PointerMotionMask);	1599	$term->vt_emask_add (urxvt::PointerMotionMask);
1531		1600
		1601	=item $term->set_urgency ($set)
		1602
		1603	Enable/disable the urgency hint on the toplevel window.
		1604
1532	=item $term->focus_in	1605	=item $term->focus_in
1533		1606
1534	=item $term->focus_out	1607	=item $term->focus_out
1535		1608
1536	=item $term->key_press ($state, $keycode[, $time])	1609	=item $term->key_press ($state, $keycode[, $time])
…		…
1624		1697
1625	Used after changing terminal contents to display them.	1698	Used after changing terminal contents to display them.
1626		1699
1627	=item $text = $term->ROW_t ($row_number[, $new_text[, $start_col]])	1700	=item $text = $term->ROW_t ($row_number[, $new_text[, $start_col]])
1628		1701
1629	Returns the text of the entire row with number C<$row_number>. Row C<0>	1702	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	1703	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	1704	terminal line. Nothing will be returned if a nonexistent line
1633	is requested.	1705	is requested.
1634		1706
1635	If C<$new_text> is specified, it will replace characters in the current	1707	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	1708	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	1709	to replace only parts of a line. The font index in the rendition will
1638	automatically be updated.	1710	automatically be updated.
1639		1711
1640	C<$text> is in a special encoding: tabs and wide characters that use more	1712	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)	1713	than one cell when displayed are padded with C<$urxvt::NOCHAR> (chr 65535)
1642	characters. Characters with combining characters and other characters that	1714	characters. Characters with combining characters and other characters that
1643	do not fit into the normal tetx encoding will be replaced with characters	1715	do not fit into the normal text encoding will be replaced with characters
1644	in the private use area.	1716	in the private use area.
1645		1717
1646	You have to obey this encoding when changing text. The advantage is	1718	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	1719	that C<substr> and similar functions work on screen cells and not on
1648	characters.	1720	characters.
…		…
1733	}	1805	}
1734		1806
1735	sub urxvt::line::t {	1807	sub urxvt::line::t {
1736	my ($self) = @_;	1808	my ($self) = @_;
1737		1809
1738	if (@_ > 1)	1810	if (@_ > 1) {
1739	{
1740	$self->{term}->ROW_t ($_, $_[1], 0, ($_ - $self->{beg}) * $self->{ncol}, $self->{ncol})	1811	$self->{term}->ROW_t ($_, $_[1], 0, ($_ - $self->{beg}) * $self->{ncol}, $self->{ncol})
1741	for $self->{beg} .. $self->{end};	1812	for $self->{beg} .. $self->{end};
1742	}	1813	}
1743		1814
1744	defined wantarray &&	1815	defined wantarray &&
1745	substr +(join "", map $self->{term}->ROW_t ($_), $self->{beg} .. $self->{end}),	1816	substr +(join "", map $self->{term}->ROW_t ($_), $self->{beg} .. $self->{end}),
1746	0, $self->{len}	1817	0, $self->{len}
1747	}	1818	}
1748		1819
1749	sub urxvt::line::r {	1820	sub urxvt::line::r {
1750	my ($self) = @_;	1821	my ($self) = @_;
1751		1822
1752	if (@_ > 1)	1823	if (@_ > 1) {
1753	{
1754	$self->{term}->ROW_r ($_, $_[1], 0, ($_ - $self->{beg}) * $self->{ncol}, $self->{ncol})	1824	$self->{term}->ROW_r ($_, $_[1], 0, ($_ - $self->{beg}) * $self->{ncol}, $self->{ncol})
1755	for $self->{beg} .. $self->{end};	1825	for $self->{beg} .. $self->{end};
1756	}	1826	}
1757		1827
1758	if (defined wantarray) {	1828	if (defined wantarray) {
1759	my $rend = [	1829	my $rend = [
1760	map @{ $self->{term}->ROW_r ($_) }, $self->{beg} .. $self->{end}	1830	map @{ $self->{term}->ROW_r ($_) }, $self->{beg} .. $self->{end}
1761	];	1831	];
…		…
1823	Calls XAllowEvents with both ReplayPointer and ReplayKeyboard for the most	1893	Calls XAllowEvents with both ReplayPointer and ReplayKeyboard for the most
1824	recent grab.	1894	recent grab.
1825		1895
1826	=item $term->ungrab	1896	=item $term->ungrab
1827		1897
1828	Calls XUngrab for the most recent grab. Is called automatically on	1898	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	1899	evaluation errors, as it is better to lose the grab in the error case as
1830	the session.	1900	the session.
1831		1901
1832	=item $atom = $term->XInternAtom ($atom_name[, $only_if_exists])	1902	=item $atom = $term->XInternAtom ($atom_name[, $only_if_exists])
1833		1903
…		…
1835		1905
1836	=item @atoms = $term->XListProperties ($window)	1906	=item @atoms = $term->XListProperties ($window)
1837		1907
1838	=item ($type,$format,$octets) = $term->XGetWindowProperty ($window, $property)	1908	=item ($type,$format,$octets) = $term->XGetWindowProperty ($window, $property)
1839		1909
1840	=item $term->XChangeWindowProperty ($window, $property, $type, $format, $octets)	1910	=item $term->XChangeProperty ($window, $property, $type, $format, $octets)
1841		1911
1842	=item $term->XDeleteProperty ($window, $property)	1912	=item $term->XDeleteProperty ($window, $property)
1843		1913
1844	=item $window = $term->DefaultRootWindow	1914	=item $window = $term->DefaultRootWindow
1845		1915
…		…
1852	=item $term->XMoveResizeWindow ($window, $x, $y, $width, $height)	1922	=item $term->XMoveResizeWindow ($window, $x, $y, $width, $height)
1853		1923
1854	=item ($x, $y, $child_window) = $term->XTranslateCoordinates ($src, $dst, $x, $y)	1924	=item ($x, $y, $child_window) = $term->XTranslateCoordinates ($src, $dst, $x, $y)
1855		1925
1856	=item $term->XChangeInput ($window, $add_events[, $del_events])	1926	=item $term->XChangeInput ($window, $add_events[, $del_events])
		1927
		1928	=item $keysym = $term->XStringToKeysym ($string)
		1929
		1930	=item $string = $term->XKeysymToString ($keysym)
1857		1931
1858	Various X or X-related functions. The C<$term> object only serves as	1932	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	1933	the source of the display, otherwise those functions map more-or-less
1860	directory onto the X functions of the same name.	1934	directly onto the X functions of the same name.
1861		1935
1862	=back	1936	=back
1863		1937
1864	=cut	1938	=cut
1865		1939
…		…
1967	my $env = $self->{term}->env;	2041	my $env = $self->{term}->env;
1968	# we can't hope to reproduce the locale algorithm, so nuke LC_ALL and set LC_CTYPE.	2042	# we can't hope to reproduce the locale algorithm, so nuke LC_ALL and set LC_CTYPE.
1969	delete $env->{LC_ALL};	2043	delete $env->{LC_ALL};
1970	$env->{LC_CTYPE} = $self->{term}->locale;	2044	$env->{LC_CTYPE} = $self->{term}->locale;
1971		2045
1972	urxvt::term->new ($env, "popup",	2046	my $term = urxvt::term->new (
		2047	$env, "popup",
1973	"--perl-lib" => "", "--perl-ext-common" => "",	2048	"--perl-lib" => "", "--perl-ext-common" => "",
1974	"-pty-fd" => -1, "-sl" => 0,	2049	"-pty-fd" => -1, "-sl" => 0,
1975	"-b" => 1, "-bd" => "grey80", "-bl", "-override-redirect",	2050	"-b" => 1, "-bd" => "grey80", "-bl", "-override-redirect",
1976	"--transient-for" => $self->{term}->parent,	2051	"--transient-for" => $self->{term}->parent,
1977	"-display" => $self->{term}->display_id,	2052	"-display" => $self->{term}->display_id,
1978	"-pe" => "urxvt-popup")	2053	"-pe" => "urxvt-popup",
1979	or die "unable to create popup window\n";	2054	) or die "unable to create popup window\n";
		2055
		2056	unless (delete $term->{urxvt_popup_init_done}) {
		2057	$term->ungrab;
		2058	$term->destroy;
		2059	die "unable to initialise popup window\n";
		2060	}
1980	}	2061	}
1981		2062
1982	sub DESTROY {	2063	sub DESTROY {
1983	my ($self) = @_;	2064	my ($self) = @_;
1984		2065
…		…
2002	->new	2083	->new
2003	->interval (1)	2084	->interval (1)
2004	->cb (sub {	2085	->cb (sub {
2005	$term->{overlay}->set (0, 0,	2086	$term->{overlay}->set (0, 0,
2006	sprintf "%2d:%02d:%02d", (localtime urxvt::NOW)[2,1,0]);	2087	sprintf "%2d:%02d:%02d", (localtime urxvt::NOW)[2,1,0]);
2007	});	2088	});
2008		2089
2009	=over 4	2090	=over 4
2010		2091
2011	=item $timer = new urxvt::timer	2092	=item $timer = new urxvt::timer
2012		2093
…		…
2015		2096
2016	=item $timer = $timer->cb (sub { my ($timer) = @_; ... })	2097	=item $timer = $timer->cb (sub { my ($timer) = @_; ... })
2017		2098
2018	Set the callback to be called when the timer triggers.	2099	Set the callback to be called when the timer triggers.
2019		2100
2020	=item $tstamp = $timer->at
2021
2022	Return the time this watcher will fire next.
2023
2024	=item $timer = $timer->set ($tstamp)	2101	=item $timer = $timer->set ($tstamp[, $interval])
2025		2102
2026	Set the time the event is generated to $tstamp.	2103	Set the time the event is generated to $tstamp (and optionally specifies a
		2104	new $interval).
2027		2105
2028	=item $timer = $timer->interval ($interval)	2106	=item $timer = $timer->interval ($interval)
2029		2107
2030	Normally (and when C<$interval> is C<0>), the timer will automatically	2108	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	2109	stop after it has fired once. If C<$interval> is non-zero, then the timer
2032	is automatically rescheduled at the given intervals.	2110	is automatically rescheduled at the given intervals.
2033		2111
2034	=item $timer = $timer->start	2112	=item $timer = $timer->start
2035		2113
2036	Start the timer.	2114	Start the timer.
2037		2115
2038	=item $timer = $timer->start ($tstamp)	2116	=item $timer = $timer->start ($tstamp[, $interval])
2039		2117
2040	Set the event trigger time to C<$tstamp> and start the timer.	2118	Set the event trigger time to C<$tstamp> and start the timer. Optionally
		2119	also replaces the interval.
2041		2120
2042	=item $timer = $timer->after ($delay)	2121	=item $timer = $timer->after ($delay[, $interval])
2043		2122
2044	Like C<start>, but sets the expiry timer to c<urxvt::NOW + $delay>.	2123	Like C<start>, but sets the expiry timer to c<urxvt::NOW + $delay>.
2045		2124
2046	=item $timer = $timer->stop	2125	=item $timer = $timer->stop
2047		2126
…		…
2055		2134
2056	$term->{socket} = ...	2135	$term->{socket} = ...
2057	$term->{iow} = urxvt::iow	2136	$term->{iow} = urxvt::iow
2058	->new	2137	->new
2059	->fd (fileno $term->{socket})	2138	->fd (fileno $term->{socket})
2060	->events (urxvt::EVENT_READ)	2139	->events (urxvt::EV_READ)
2061	->start	2140	->start
2062	->cb (sub {	2141	->cb (sub {
2063	my ($iow, $revents) = @_;	2142	my ($iow, $revents) = @_;
2064	# $revents must be 1 here, no need to check	2143	# $revents must be 1 here, no need to check
2065	sysread $term->{socket}, my $buf, 8192	2144	sysread $term->{socket}, my $buf, 8192
…		…
2083	Set the file descriptor (not handle) to watch.	2162	Set the file descriptor (not handle) to watch.
2084		2163
2085	=item $iow = $iow->events ($eventmask)	2164	=item $iow = $iow->events ($eventmask)
2086		2165
2087	Set the event mask to watch. The only allowed values are	2166	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	2167	C<urxvt::EV_READ> and C<urxvt::EV_WRITE>, which might be ORed
2089	together, or C<urxvt::EVENT_NONE>.	2168	together, or C<urxvt::EV_NONE>.
2090		2169
2091	=item $iow = $iow->start	2170	=item $iow = $iow->start
2092		2171
2093	Start watching for requested events on the given handle.	2172	Start watching for requested events on the given handle.
2094		2173
…		…
2135	->new	2214	->new
2136	->start ($pid)	2215	->start ($pid)
2137	->cb (sub {	2216	->cb (sub {
2138	my ($pw, $exit_status) = @_;	2217	my ($pw, $exit_status) = @_;
2139	...	2218	...
2140	});	2219	});
2141		2220
2142	=over 4	2221	=over 4
2143		2222
2144	=item $pw = new urxvt::pw	2223	=item $pw = new urxvt::pw
2145		2224
…		…
2178		2257
2179	=back	2258	=back
2180		2259
2181	=head1 AUTHOR	2260	=head1 AUTHOR
2182		2261
2183	Marc Lehmann <pcg@goof.com>	2262	Marc Lehmann <schmorp@schmorp.de>
2184	http://software.schmorp.de/pkg/rxvt-unicode	2263	http://software.schmorp.de/pkg/rxvt-unicode
2185		2264
2186	=cut	2265	=cut
2187		2266
2188	1	2267	1

Diff Legend

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