ViewVC Help

View File | Revision Log | Show Annotations | Download File

/cvs/rxvt-unicode/src/urxvt.pm

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

Diff Legend

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