[ViewVC] Diff of: cvs/rxvt-unicode/src/urxvt.pm

Comparing rxvt-unicode/src/urxvt.pm (file contents):
Revision 1.217 by root, Sun Jun 10 13:58:05 2012 UTC vs.
Revision 1.238 by root, Sun May 18 18:15:04 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 "vars"' and 'use utf8' environment, and	25	Scripts are compiled in a 'use strict "vars"' and 'use utf8' environment, and
26	thus must be encoded as UTF-8.	26	thus must be encoded as UTF-8.
27		27
28	Each script will only ever be loaded once, even in @@RXVT_NAME@@d, where	28	Each script will only ever be loaded once, even in urxvtd, where
29	scripts will be shared (but not enabled) for all terminals.	29	scripts will be shared (but not enabled) for all terminals.
30		30
31	You can disable the embedded perl interpreter by setting both "perl-ext"	31	You can disable the embedded perl interpreter by setting both "perl-ext"
32	and "perl-ext-common" resources to the empty string.	32	and "perl-ext-common" resources to the empty string.
33		33
34	=head1 PREPACKAGED EXTENSIONS	34	=head1 PREPACKAGED EXTENSIONS
35		35
36	This section describes the extensions delivered with this release. You can	36	A number of extensions are delivered with this release. You can find them
37	find them in F<@@RXVT_LIBDIR@@/urxvt/perl/>.	37	in F<< <libdir>/urxvt/perl/ >>, and the documentation can be viewed using
		38	F<< man urxvt-<EXTENSIONNAME> >>.
38		39
39	You can activate them like this:	40	You can activate them like this:
40		41
41	@@RXVT_NAME@@ -pe <extensionname>	42	urxvt -pe <extensionname>
42		43
43	Or by adding them to the resource for extensions loaded by default:	44	Or by adding them to the resource for extensions loaded by default:
44		45
45	URxvt.perl-ext-common: default,selection-autotransform	46	URxvt.perl-ext-common: default,selection-autotransform
46		47
47	=over 4	48	Extensions that add command line parameters or resources on their own are
48		49	loaded automatically when used.
49	=item selection (enabled by default)
50
51	(More) intelligent selection. This extension tries to be more intelligent
52	when the user extends selections (double-click and further clicks). Right
53	now, it tries to select words, urls and complete shell-quoted
54	arguments, which is very convenient, too, if your F<ls> supports
55	C<--quoting-style=shell>.
56
57	A double-click usually selects the word under the cursor, further clicks
58	will enlarge the selection.
59
60	The selection works by trying to match a number of regexes and displaying
61	them in increasing order of length. You can add your own regexes by
62	specifying resources of the form:
63
64	URxvt.selection.pattern-0: perl-regex
65	URxvt.selection.pattern-1: perl-regex
66	...
67
68	The index number (0, 1...) must not have any holes, and each regex must
69	contain at least one pair of capturing parentheses, which will be used for
70	the match. For example, the following adds a regex that matches everything
71	between two vertical bars:
72
73	URxvt.selection.pattern-0: \\\|([^\|]+)\\\|
74
75	Another example: Programs I use often output "absolute path: " at the
76	beginning of a line when they process multiple files. The following
77	pattern matches the filename (note, there is a single space at the very
78	end):
79
80	URxvt.selection.pattern-0: ^(/[^:]+):\
81
82	You can look at the source of the selection extension to see more
83	interesting uses, such as parsing a line from beginning to end.
84
85	This extension also offers following bindable keyboard commands:
86
87	=over 4
88
89	=item rot13
90
91	Rot-13 the selection when activated. Used via keyboard trigger:
92
93	URxvt.keysym.C-M-r: perl:selection:rot13
94
95	=back
96
97	=item option-popup (enabled by default)
98
99	Binds a popup menu to Ctrl-Button2 that lets you toggle (some) options at
100	runtime.
101
102	Other extensions can extend this popup menu by pushing a code reference
103	onto C<@{ $term->{option_popup_hook} }>, which gets called whenever the
104	popup is being displayed.
105
106	Its sole argument is the popup menu, which can be modified. It should
107	either return nothing or a string, the initial boolean value and a code
108	reference. The string will be used as button text and the code reference
109	will be called when the toggle changes, with the new boolean value as
110	first argument.
111
112	The following will add an entry C<myoption> that changes
113	C<< $self->{myoption} >>:
114
115	push @{ $self->{term}{option_popup_hook} }, sub {
116	("my option" => $myoption, sub { $self->{myoption} = $_[0] })
117	};
118
119	=item selection-popup (enabled by default)
120
121	Binds a popup menu to Ctrl-Button3 that lets you convert the selection
122	text into various other formats/action (such as uri unescaping, perl
123	evaluation, web-browser starting etc.), depending on content.
124
125	Other extensions can extend this popup menu by pushing a code reference
126	onto C<@{ $term->{selection_popup_hook} }>, which gets called whenever the
127	popup is being displayed.
128
129	Its sole argument is the popup menu, which can be modified. The selection
130	is in C<$_>, which can be used to decide whether to add something or not.
131	It should either return nothing or a string and a code reference. The
132	string will be used as button text and the code reference will be called
133	when the button gets activated and should transform C<$_>.
134
135	The following will add an entry C<a to b> that transforms all C<a>s in
136	the selection to C<b>s, but only if the selection currently contains any
137	C<a>s:
138
139	push @{ $self->{term}{selection_popup_hook} }, sub {
140	/a/ ? ("a to b" => sub { s/a/b/g }
141	: ()
142	};
143
144	=item searchable-scrollback<hotkey> (enabled by default)
145
146	Adds regex search functionality to the scrollback buffer, triggered
147	by a hotkey (default: C<M-s>). While in search mode, normal terminal
148	input/output is suspended and a regex is displayed at the bottom of the
149	screen.
150
151	Inputting characters appends them to the regex and continues incremental
152	search. C<BackSpace> removes a character from the regex, C<Up> and C<Down>
153	search upwards/downwards in the scrollback buffer, C<End> jumps to the
154	bottom. C<Escape> leaves search mode and returns to the point where search
155	was started, while C<Enter> or C<Return> stay at the current position and
156	additionally stores the first match in the current line into the primary
157	selection if the C<Shift> modifier is active.
158
159	The regex defaults to "(?i)", resulting in a case-insensitive search. To
160	get a case-sensitive search you can delete this prefix using C<BackSpace>
161	or simply use an uppercase character which removes the "(?i)" prefix.
162
163	See L<perlre> for more info about perl regular expression syntax.
164
165	=item readline (enabled by default)
166
167	A support package that tries to make editing with readline easier. At
168	the moment, it reacts to clicking shift-left mouse button by trying to
169	move the text cursor to this position. It does so by generating as many
170	cursor-left or cursor-right keypresses as required (this only works
171	for programs that correctly support wide characters).
172
173	To avoid too many false positives, this is only done when:
174
175	=over 4
176
177	=item - the tty is in ICANON state.
178
179	=item - the text cursor is visible.
180
181	=item - the primary screen is currently being displayed.
182
183	=item - the mouse is on the same (multi-row-) line as the text cursor.
184
185	=back
186
187	The normal selection mechanism isn't disabled, so quick successive clicks
188	might interfere with selection creation in harmless ways.
189
190	=item selection-autotransform
191
192	This selection allows you to do automatic transforms on a selection
193	whenever a selection is made.
194
195	It works by specifying perl snippets (most useful is a single C<s///>
196	operator) that modify C<$_> as resources:
197
198	URxvt.selection-autotransform.0: transform
199	URxvt.selection-autotransform.1: transform
200	...
201
202	For example, the following will transform selections of the form
203	C<filename:number>, often seen in compiler messages, into C<vi +$filename
204	$word>:
205
206	URxvt.selection-autotransform.0: s/^([^:[:space:]]+):(\\d+):?$/vi +$2 \\Q$1\\E\\x0d/
207
208	And this example matches the same,but replaces it with vi-commands you can
209	paste directly into your (vi :) editor:
210
211	URxvt.selection-autotransform.0: s/^([^:[:space:]]+(\\d+):?$/:e \\Q$1\\E\\x0d:$2\\x0d/
212
213	Of course, this can be modified to suit your needs and your editor :)
214
215	To expand the example above to typical perl error messages ("XXX at
216	FILENAME line YYY."), you need a slightly more elaborate solution:
217
218	URxvt.selection.pattern-0: ( at .*? line \\d+[,.])
219	URxvt.selection-autotransform.0: s/^ at (.*?) line (\\d+)[,.]$/:e \\Q$1\E\\x0d:$2\\x0d/
220
221	The first line tells the selection code to treat the unchanging part of
222	every error message as a selection pattern, and the second line transforms
223	the message into vi commands to load the file.
224
225	=item tabbed
226
227	This transforms the terminal into a tabbar with additional terminals, that
228	is, it implements what is commonly referred to as "tabbed terminal". The topmost line
229	displays a "[NEW]" button, which, when clicked, will add a new tab, followed by one
230	button per tab.
231
232	Clicking a button will activate that tab. Pressing B<Shift-Left> and
233	B<Shift-Right> will switch to the tab left or right of the current one,
234	while B<Shift-Down> creates a new tab.
235
236	The tabbar itself can be configured similarly to a normal terminal, but
237	with a resource class of C<URxvt.tabbed>. In addition, it supports the
238	following four resources (shown with defaults):
239
240	URxvt.tabbed.tabbar-fg: <colour-index, default 3>
241	URxvt.tabbed.tabbar-bg: <colour-index, default 0>
242	URxvt.tabbed.tab-fg: <colour-index, default 0>
243	URxvt.tabbed.tab-bg: <colour-index, default 1>
244
245	See I<COLOR AND GRAPHICS> in the @@RXVT_NAME@@(1) manpage for valid
246	indices.
247
248	=item matcher
249
250	Uses per-line display filtering (C<on_line_update>) to underline text
251	matching a certain pattern and make it clickable. When clicked with the
252	mouse button specified in the C<matcher.button> resource (default 2, or
253	middle), the program specified in the C<matcher.launcher> resource
254	(default, the C<urlLauncher> resource, C<sensible-browser>) will be started
255	with the matched text as first argument. The default configuration is
256	suitable for matching URLs and launching a web browser, like the
257	former "mark-urls" extension.
258
259	The default pattern to match URLs can be overridden with the
260	C<matcher.pattern.0> resource, and additional patterns can be specified
261	with numbered patterns, in a manner similar to the "selection" extension.
262	The launcher can also be overridden on a per-pattern basis.
263
264	It is possible to activate the most recently seen match or a list of matches
265	from the keyboard. Simply bind a keysym to "perl:matcher:last" or
266	"perl:matcher:list" as seen in the example below.
267
268	Example configuration:
269
270	URxvt.perl-ext: default,matcher
271	URxvt.urlLauncher: sensible-browser
272	URxvt.keysym.C-Delete: perl:matcher:last
273	URxvt.keysym.M-Delete: perl:matcher:list
274	URxvt.matcher.button: 1
275	URxvt.matcher.pattern.1: \\bwww\\.[\\w-]+\\.[\\w./?&@#-]*[\\w/-]
276	URxvt.matcher.pattern.2: \\B(/\\S+?):(\\d+)(?=:\|$)
277	URxvt.matcher.launcher.2: gvim +$2 $1
278
279	=item xim-onthespot
280
281	This (experimental) perl extension implements OnTheSpot editing. It does
282	not work perfectly, and some input methods don't seem to work well with
283	OnTheSpot editing in general, but it seems to work at least for SCIM and
284	kinput2.
285
286	You enable it by specifying this extension and a preedit style of
287	C<OnTheSpot>, i.e.:
288
289	@@RXVT_NAME@@ -pt OnTheSpot -pe xim-onthespot
290
291	=item kuake<hotkey>
292
293	A very primitive quake-console-like extension. It was inspired by a
294	description of how the programs C<kuake> and C<yakuake> work: Whenever the
295	user presses a global accelerator key (by default C<F10>), the terminal
296	will show or hide itself. Another press of the accelerator key will hide
297	or show it again.
298
299	Initially, the window will not be shown when using this extension.
300
301	This is useful if you need a single terminal that is not using any desktop
302	space most of the time but is quickly available at the press of a key.
303
304	The accelerator key is grabbed regardless of any modifiers, so this
305	extension will actually grab a physical key just for this function.
306
307	If you want a quake-like animation, tell your window manager to do so
308	(fvwm can do it).
309
310	=item overlay-osc
311
312	This extension implements some OSC commands to display timed popups on the
313	screen - useful for status displays from within scripts. You have to read
314	the sources for more info.
315
316	=item block-graphics-to-ascii
317
318	A not very useful example of filtering all text output to the terminal
319	by replacing all line-drawing characters (U+2500 .. U+259F) by a
320	similar-looking ascii character.
321
322	=item digital-clock
323
324	Displays a digital clock using the built-in overlay.
325
326	=item remote-clipboard
327
328	Somewhat of a misnomer, this extension adds two menu entries to the
329	selection popup that allows one to run external commands to store the
330	selection somewhere and fetch it again.
331
332	We use it to implement a "distributed selection mechanism", which just
333	means that one command uploads the file to a remote server, and another
334	reads it.
335
336	The commands can be set using the C<URxvt.remote-selection.store> and
337	C<URxvt.remote-selection.fetch> resources. The first should read the
338	selection to store from STDIN (always in UTF-8), the second should provide
339	the selection data on STDOUT (also in UTF-8).
340
341	The defaults (which are likely useless to you) use rsh and cat:
342
343	URxvt.remote-selection.store: rsh ruth 'cat >/tmp/distributed-selection'
344	URxvt.remote-selection.fetch: rsh ruth 'cat /tmp/distributed-selection'
345
346	=item selection-pastebin
347
348	This is a little rarely useful extension that uploads the selection as
349	textfile to a remote site (or does other things). (The implementation is
350	not currently secure for use in a multiuser environment as it writes to
351	F</tmp> directly.).
352
353	It listens to the C<selection-pastebin:remote-pastebin> keyboard command,
354	i.e.
355
356	URxvt.keysym.C-M-e: perl:selection-pastebin:remote-pastebin
357
358	Pressing this combination runs a command with C<%> replaced by the name of
359	the textfile. This command can be set via a resource:
360
361	URxvt.selection-pastebin.cmd: rsync -apP % ruth:/var/www/www.ta-sa.org/files/txt/.
362
363	And the default is likely not useful to anybody but the few people around
364	here :)
365
366	The name of the textfile is the hex encoded md5 sum of the selection, so
367	the same content should lead to the same filename.
368
369	After a successful upload the selection will be replaced by the text given
370	in the C<selection-pastebin-url> resource (again, the % is the placeholder
371	for the filename):
372
373	URxvt.selection-pastebin.url: http://www.ta-sa.org/files/txt/%
374
375	I<Note to xrdb users:> xrdb uses the C preprocessor, which might interpret
376	the double C</> characters as comment start. Use C<\057\057> instead,
377	which works regardless of whether xrdb is used to parse the resource file
378	or not.
379
380	=item macosx-clipboard and macosx-clipboard-native
381
382	These two modules implement an extended clipboard for Mac OS X. They are
383	used like this:
384
385	URxvt.perl-ext-common: default,macosx-clipboard
386	URxvt.keysym.M-c: perl:macosx-clipboard:copy
387	URxvt.keysym.M-v: perl:macosx-clipboard:paste
388
389	The difference between them is that the native variant requires a
390	perl from apple's devkit or so, and C<macosx-clipboard> requires the
391	C<Mac::Pasteboard> module, works with other perls, has fewer bugs, is
392	simpler etc. etc.
393
394	=item example-refresh-hooks
395
396	Displays a very simple digital clock in the upper right corner of the
397	window. Illustrates overwriting the refresh callbacks to create your own
398	overlays or changes.
399
400	=item confirm-paste
401
402	Displays a confirmation dialog when a paste containing at least a full
403	line is detected.
404
405	=item bell-command
406
407	Runs the command specified by the C<URxvt.bell-command> resource when
408	a bell event occurs. For example, the following pops up a notification
409	bubble with the text "Beep, Beep" using notify-send:
410
411	URxvt.bell-command: notify-send "Beep, Beep"
412
413	=back
414		50
415	=head1 API DOCUMENTATION	51	=head1 API DOCUMENTATION
416		52
417	=head2 General API Considerations	53	=head2 General API Considerations
418		54
467	internal use.	103	internal use.
468		104
469	Although it isn't a C<urxvt::term> object, you can call all methods of the	105	Although it isn't a C<urxvt::term> object, you can call all methods of the
470	C<urxvt::term> class on this object.	106	C<urxvt::term> class on this object.
471		107
472	It has the following methods and data members:	108	Additional methods only supported for extension objects are described in
473		109	the C<urxvt::extension> section below.
474	=over 4
475
476	=item $urxvt_term = $self->{term}
477
478	Returns the C<urxvt::term> object associated with this instance of the
479	extension. This member I<must not> be changed in any way.
480
481	=item $self->enable ($hook_name => $cb, [$hook_name => $cb..])
482
483	Dynamically enable the given hooks (named without the C<on_> prefix) for
484	this extension, replacing any previous hook. This is useful when you want
485	to overwrite time-critical hooks only temporarily.
486
487	=item $self->disable ($hook_name[, $hook_name..])
488
489	Dynamically disable the given hooks.
490
491	=back
492		110
493	=head2 Hooks	111	=head2 Hooks
494		112
495	The following subroutines can be declared in extension files, and will be	113	The following subroutines can be declared in extension files, and will be
496	called whenever the relevant event happens.	114	called whenever the relevant event happens.
…		…
663		281
664	=item on_refresh_end $term	282	=item on_refresh_end $term
665		283
666	Called just after the screen gets redrawn. See C<on_refresh_begin>.	284	Called just after the screen gets redrawn. See C<on_refresh_begin>.
667		285
668	=item on_user_command $term, $string	286	=item on_user_command $term, $string DEPRECATED
669		287
670	Called whenever a user-configured event is being activated (e.g. via	288	Called whenever a user-configured event is being activated (e.g. via
671	a C<perl:string> action bound to a key, see description of the B<keysym>	289	a C<perl:string> action bound to a key, see description of the B<keysym>
672	resource in the @@RXVT_NAME@@(1) manpage).	290	resource in the urxvt(1) manpage).
673		291
674	The event is simply the action string. This interface is assumed to change	292	The event is simply the action string. This interface is going away in
675	slightly in the future.	293	preference to the C<on_action> hook.
676
677	=item on_register_command $term, $keysym, $modifiermask, $string
678
679	Called after parsing a keysym resource but before registering the
680	associated binding. If this hook returns TRUE the binding is not
681	registered. It can be used to modify a binding by calling
682	C<register_command>.
683		294
684	=item on_resize_all_windows $term, $new_width, $new_height	295	=item on_resize_all_windows $term, $new_width, $new_height
685		296
686	Called just after the new window size has been calculated, but before	297	Called just after the new window size has been calculated, but before
687	windows are actually being resized or hints are being set. If this hook	298	windows are actually being resized or hints are being set. If this hook
688	returns TRUE, setting of the window hints is being skipped.	299	returns a true value, setting of the window hints is being skipped.
689		300
690	=item on_x_event $term, $event	301	=item on_x_event $term, $event
691		302
692	Called on every X event received on the vt window (and possibly other	303	Called on every X event received on the vt window (and possibly other
693	windows). Should only be used as a last resort. Most event structure	304	windows). Should only be used as a last resort. Most event structure
…		…
732	manpage), with the additional members C<row> and C<col>, which are the	343	manpage), with the additional members C<row> and C<col>, which are the
733	(real, not screen-based) row and column under the mouse cursor.	344	(real, not screen-based) row and column under the mouse cursor.
734		345
735	C<on_key_press> additionally receives the string rxvt-unicode would	346	C<on_key_press> additionally receives the string rxvt-unicode would
736	output, if any, in locale-specific encoding.	347	output, if any, in locale-specific encoding.
737
738	subwindow.
739		348
740	=item on_client_message $term, $event	349	=item on_client_message $term, $event
741		350
742	=item on_wm_protocols $term, $event	351	=item on_wm_protocols $term, $event
743		352
…		…
948	sub parse_resource {	557	sub parse_resource {
949	my ($term, $name, $isarg, $longopt, $flag, $value) = @_;	558	my ($term, $name, $isarg, $longopt, $flag, $value) = @_;
950		559
951	$name =~ y/-/./ if $isarg;	560	$name =~ y/-/./ if $isarg;
952		561
953	$term->scan_meta;	562	$term->scan_extensions;
954		563
955	my $r = $term->{meta}{resource};	564	my $r = $term->{meta}{resource};
956	keys %$r; # reste iterator	565	keys %$r; # reset iterator
957	while (my ($pattern, $v) = each %$r) {	566	while (my ($pattern, $v) = each %$r) {
958	if (	567	if (
959	$pattern =~ /\.$/	568	$pattern =~ /\.$/
960	? $pattern eq substr $name, 0, length $pattern	569	? $pattern eq substr $name, 0, length $pattern
961	: $pattern eq $name	570	: $pattern eq $name
…		…
978	}	587	}
979		588
980	sub usage {	589	sub usage {
981	my ($term, $usage_type) = @_;	590	my ($term, $usage_type) = @_;
982		591
983	$term->scan_meta;	592	$term->scan_extensions;
984		593
985	my $r = $term->{meta}{resource};	594	my $r = $term->{meta}{resource};
986		595
987	for my $pattern (sort keys %$r) {	596	for my $pattern (sort keys %$r) {
988	my ($ext, $type, $desc) = @{ $r->{$pattern} };	597	my ($ext, $type, $desc) = @{ $r->{$pattern} };
…		…
1049	# called by the rxvt core	658	# called by the rxvt core
1050	sub invoke {	659	sub invoke {
1051	local $TERM = shift;	660	local $TERM = shift;
1052	my $htype = shift;	661	my $htype = shift;
1053		662
1054	if ($htype == 0) { # INIT	663	if ($htype == HOOK_INIT) {
1055	my @dirs = $TERM->perl_libdirs;	664	my @dirs = $TERM->perl_libdirs;
		665
		666	$TERM->scan_extensions;
1056		667
1057	my %ext_arg;	668	my %ext_arg;
1058		669
1059	{	670	{
1060	my @init = @TERM_INIT;	671	my @init = @TERM_INIT;
…		…
1064	@TERM_EXT = ();	675	@TERM_EXT = ();
1065	$TERM->register_package ($_) for @pkg;	676	$TERM->register_package ($_) for @pkg;
1066	}	677	}
1067		678
1068	for (	679	for (
1069	@{ delete $TERM->{perl_ext_3} },
1070	grep $_, map { split /,/, $TERM->resource ("perl_ext_$_") } 1, 2	680	grep $_, map { split /,/, $TERM->resource ("perl_ext_$_") } 1, 2
1071	) {	681	) {
1072	if ($_ eq "default") {	682	if ($_ eq "default") {
1073	$ext_arg{$_} \|\|= [] for qw(selection option-popup selection-popup searchable-scrollback readline);	683
		684	$ext_arg{$_} = []
		685	for
		686	qw(selection option-popup selection-popup readline),
		687	map $_->[0], values %{ $TERM->{meta}{binding} },
		688	@{ delete $TERM->{perl_ext_3} };
		689
		690	for ($TERM->_keysym_resources) {
		691	next if /^(?:string\|command\|builtin\|builtin-string\|perl)/;
		692	next unless /^([A-Za-z0-9_\-]+):/;
		693
		694	my $ext = $1;
		695	$ext =~ y/-/_/;
		696
		697	$ext_arg{$ext} = [];
		698	}
		699
1074	} elsif (/^-(.*)$/) {	700	} elsif (/^-(.*)$/) {
1075	delete $ext_arg{$1};	701	delete $ext_arg{$1};
		702
1076	} elsif (/^([^<]+)<(.*)>$/) {	703	} elsif (/^([^<]+)<(.*)>$/) {
1077	push @{ $ext_arg{$1} }, $2;	704	push @{ $ext_arg{$1} }, $2;
		705
1078	} else {	706	} else {
1079	$ext_arg{$_} \|\|= [];	707	$ext_arg{$_} \|\|= [];
		708	}
		709	}
		710
		711	# now register default key bindings
		712	for my $ext (sort keys %ext_arg) {
		713	while (my ($k, $v) = each %{ $TERM->{meta}{ext}{$ext}{binding} }) {
		714	$TERM->bind_action ($k, "$v->[0]:$v->[1]");
1080	}	715	}
1081	}	716	}
1082		717
1083	for my $ext (sort keys %ext_arg) {	718	for my $ext (sort keys %ext_arg) {
1084	my @files = grep -f $_, map "$_/$ext", @dirs;	719	my @files = grep -f $_, map "$_/$ext", @dirs;
…		…
1098		733
1099	if (my $cb = $TERM->{_hook}[$htype]) {	734	if (my $cb = $TERM->{_hook}[$htype]) {
1100	verbose 10, "$HOOKNAME[$htype] (" . (join ", ", $TERM, @_) . ")"	735	verbose 10, "$HOOKNAME[$htype] (" . (join ", ", $TERM, @_) . ")"
1101	if $verbosity >= 10;	736	if $verbosity >= 10;
1102		737
		738	if ($htype == HOOK_ACTION) {
		739	# this hook is only sent to the extension with the name
		740	# matching the first arg
		741	my $pkg = shift;
		742	$pkg =~ y/-/_/;
		743	$pkg = "urxvt::ext::$pkg";
		744
		745	$cb = $cb->{$pkg}
		746	or return undef; #TODO: maybe warn user?
		747
		748	$cb = { $pkg => $cb };
		749	}
		750
1103	for my $pkg (keys %$cb) {	751	for my $pkg (keys %$cb) {
1104	my $retval_ = eval { $cb->{$pkg}->($TERM->{_pkg}{$pkg}, @_) };	752	my $retval_ = eval { $cb->{$pkg}->($TERM->{_pkg}{$pkg} \|\| $TERM, @_) };
1105	$retval \|\|= $retval_;	753	$retval \|\|= $retval_;
1106		754
1107	if ($@) {	755	if ($@) {
1108	$TERM->ungrab; # better to lose the grab than the session	756	$TERM->ungrab; # better to lose the grab than the session
1109	warn $@;	757	warn $@;
…		…
1112		760
1113	verbose 11, "$HOOKNAME[$htype] returning <$retval>"	761	verbose 11, "$HOOKNAME[$htype] returning <$retval>"
1114	if $verbosity >= 11;	762	if $verbosity >= 11;
1115	}	763	}
1116		764
1117	if ($htype == 1) { # DESTROY	765	if ($htype == HOOK_DESTROY) {
1118	# clear package objects	766	# clear package objects
1119	%$_ = () for values %{ $TERM->{_pkg} };	767	%$_ = () for values %{ $TERM->{_pkg} };
1120		768
1121	# clear package	769	# clear package
1122	%$TERM = ();	770	%$TERM = ();
…		…
1154	($mask, @color{qw(fg bg)}, \@failed)	802	($mask, @color{qw(fg bg)}, \@failed)
1155	}	803	}
1156		804
1157	package urxvt::term::extension;	805	package urxvt::term::extension;
1158		806
1159	sub enable {	807	=head2 The C<urxvt::term::extension> class
1160	my ($self, %hook) = @_;
1161	my $pkg = $self->{_pkg};
1162		808
1163	while (my ($name, $cb) = each %hook) {	809	Each extension attached to a terminal object is represented by
1164	my $htype = $HOOKTYPE{uc $name};	810	a C<urxvt::term::extension> object.
1165	defined $htype
1166	or Carp::croak "unsupported hook type '$name'";
1167		811
1168	$self->set_should_invoke ($htype, +1)	812	You can use these objects, which are passed to all callbacks to store any
1169	unless exists $self->{term}{_hook}[$htype]{$pkg};	813	state related to the terminal and extension instance.
1170		814
1171	$self->{term}{_hook}[$htype]{$pkg} = $cb;	815	The methods (And data members) documented below can be called on extension
1172	}	816	objects, in addition to call methods documented for the <urxvt::term>
1173	}	817	class.
1174		818
1175	sub disable {	819	=over 4
1176	my ($self, @hook) = @_;
1177	my $pkg = $self->{_pkg};
1178		820
1179	for my $name (@hook) {	821	=item $urxvt_term = $self->{term}
1180	my $htype = $HOOKTYPE{uc $name};
1181	defined $htype
1182	or Carp::croak "unsupported hook type '$name'";
1183		822
1184	$self->set_should_invoke ($htype, -1)	823	Returns the C<urxvt::term> object associated with this instance of the
1185	if delete $self->{term}{_hook}[$htype]{$pkg};	824	extension. This member I<must not> be changed in any way.
1186	}	825
1187	}	826	=cut
1188		827
1189	our $AUTOLOAD;	828	our $AUTOLOAD;
1190		829
1191	sub AUTOLOAD {	830	sub AUTOLOAD {
1192	$AUTOLOAD =~ /:([^:]+)$/	831	$AUTOLOAD =~ /:([^:]+)$/
…		…
1205		844
1206	sub DESTROY {	845	sub DESTROY {
1207	# nop	846	# nop
1208	}	847	}
1209		848
1210	# urxvt::destroy_hook	849	# urxvt::destroy_hook (basically a cheap Guard:: implementation)
1211		850
1212	sub urxvt::destroy_hook::DESTROY {	851	sub urxvt::destroy_hook::DESTROY {
1213	${$_[0]}->();	852	${$_[0]}->();
1214	}	853	}
1215		854
1216	sub urxvt::destroy_hook(&) {	855	sub urxvt::destroy_hook(&) {
1217	bless \shift, urxvt::destroy_hook::	856	bless \shift, urxvt::destroy_hook::
1218	}	857	}
		858
		859	=item $self->enable ($hook_name => $cb[, $hook_name => $cb..])
		860
		861	Dynamically enable the given hooks (named without the C<on_> prefix) for
		862	this extension, replacing any hook previously installed via C<enable> in
		863	this extension.
		864
		865	This is useful when you want to overwrite time-critical hooks only
		866	temporarily.
		867
		868	To install additional callbacks for the same hook, you can use the C<on>
		869	method of the C<urxvt::term> class.
		870
		871	=item $self->disable ($hook_name[, $hook_name..])
		872
		873	Dynamically disable the given hooks.
		874
		875	=cut
		876
		877	sub enable {
		878	my ($self, %hook) = @_;
		879	my $pkg = $self->{_pkg};
		880
		881	while (my ($name, $cb) = each %hook) {
		882	my $htype = $HOOKTYPE{uc $name};
		883	defined $htype
		884	or Carp::croak "unsupported hook type '$name'";
		885
		886	$self->set_should_invoke ($htype, +1)
		887	unless exists $self->{term}{_hook}[$htype]{$pkg};
		888
		889	$self->{term}{_hook}[$htype]{$pkg} = $cb;
		890	}
		891	}
		892
		893	sub disable {
		894	my ($self, @hook) = @_;
		895	my $pkg = $self->{_pkg};
		896
		897	for my $name (@hook) {
		898	my $htype = $HOOKTYPE{uc $name};
		899	defined $htype
		900	or Carp::croak "unsupported hook type '$name'";
		901
		902	$self->set_should_invoke ($htype, -1)
		903	if delete $self->{term}{_hook}[$htype]{$pkg};
		904	}
		905	}
		906
		907	=item $guard = $self->on ($hook_name => $cb[, $hook_name => $cb..])
		908
		909	Similar to the C<enable> enable, but installs additional callbacks for
		910	the given hook(s) (that is, it doesn't replace existing callbacks), and
		911	returns a guard object. When the guard object is destroyed the callbacks
		912	are disabled again.
		913
		914	=cut
		915
		916	sub urxvt::extension::on_disable::DESTROY {
		917	my $disable = shift;
		918
		919	my $term = delete $disable->{""};
		920
		921	while (my ($htype, $id) = each %$disable) {
		922	delete $term->{_hook}[$htype]{$id};
		923	$term->set_should_invoke ($htype, -1);
		924	}
		925	}
		926
		927	sub on {
		928	my ($self, %hook) = @_;
		929
		930	my $term = $self->{term};
		931
		932	my %disable = ( "" => $term );
		933
		934	while (my ($name, $cb) = each %hook) {
		935	my $htype = $HOOKTYPE{uc $name};
		936	defined $htype
		937	or Carp::croak "unsupported hook type '$name'";
		938
		939	$term->set_should_invoke ($htype, +1);
		940	$term->{_hook}[$htype]{ $disable{$htype} = $cb+0 }
		941	= sub { shift; $cb->($self, @_) }; # very ugly indeed
		942	}
		943
		944	bless \%disable, "urxvt::extension::on_disable"
		945	}
		946
		947	=item $self->x_resource ($pattern)
		948
		949	=item $self->x_resource_boolean ($pattern)
		950
		951	These methods support an additional C<%> prefix when called on an
		952	extension object - see the description of these methods in the
		953	C<urxvt::term> class for details.
		954
		955	=cut
1219		956
1220	sub x_resource {	957	sub x_resource {
1221	my ($self, $name) = @_;	958	my ($self, $name) = @_;
1222	$name =~ s/^%(\.\|$)/$_[0]{_name}$1/;	959	$name =~ s/^%(\.\|$)/$_[0]{_name}$1/;
1223	$self->{term}->x_resource ($name)	960	$self->{term}->x_resource ($name)
…		…
1226	sub x_resource_boolean {	963	sub x_resource_boolean {
1227	my ($self, $name) = @_;	964	my ($self, $name) = @_;
1228	$name =~ s/^%(\.\|$)/$_[0]{_name}$1/;	965	$name =~ s/^%(\.\|$)/$_[0]{_name}$1/;
1229	$self->{term}->x_resource_boolean ($name)	966	$self->{term}->x_resource_boolean ($name)
1230	}	967	}
		968
		969	=back
		970
		971	=cut
1231		972
1232	package urxvt::anyevent;	973	package urxvt::anyevent;
1233		974
1234	=head2 The C<urxvt::anyevent> Class	975	=head2 The C<urxvt::anyevent> Class
1235		976
…		…
1354	$ENV{URXVT_PERL_LIB},	1095	$ENV{URXVT_PERL_LIB},
1355	"$ENV{HOME}/.urxvt/ext",	1096	"$ENV{HOME}/.urxvt/ext",
1356	"$LIBDIR/perl"	1097	"$LIBDIR/perl"
1357	}	1098	}
1358		1099
1359	sub scan_meta {	1100	# scan for available extensions and collect their metadata
		1101	sub scan_extensions {
1360	my ($self) = @_;	1102	my ($self) = @_;
		1103
		1104	return if exists $self->{meta};
		1105
1361	my @libdirs = perl_libdirs $self;	1106	my @libdirs = perl_libdirs $self;
1362		1107
1363	return if $self->{meta_libdirs} eq join "\x00", @libdirs;	1108	# return if $self->{meta_libdirs} eq join "\x00", @libdirs;#d#
1364		1109
1365	my %meta;
1366
1367	$self->{meta_libdirs} = join "\x00", @libdirs;	1110	# $self->{meta_libdirs} = join "\x00", @libdirs;#d#
1368	$self->{meta} = \%meta;	1111	$self->{meta} = \my %meta;
1369		1112
		1113	# first gather extensions
1370	for my $dir (reverse @libdirs) {	1114	for my $dir (reverse @libdirs) {
1371	opendir my $fh, $dir	1115	opendir my $fh, $dir
1372	or next;	1116	or next;
1373	for my $ext (readdir $fh) {	1117	for my $ext (readdir $fh) {
1374	$ext ne "."	1118	$ext !~ /^\./
1375	and $ext ne ".."
1376	and open my $fh, "<", "$dir/$ext"	1119	and open my $fh, "<", "$dir/$ext"
1377	or next;	1120	or next;
1378		1121
		1122	my %ext = (dir => $dir);
		1123
1379	while (<$fh>) {	1124	while (<$fh>) {
1380	if (/^#:META:X_RESOURCE:(.*)/) {	1125	if (/^#:META:(?:X_)?RESOURCE:(.*)/) {
1381	my ($pattern, $type, $desc) = split /:/, $1;	1126	my ($pattern, $type, $desc) = split /:/, $1;
1382	$pattern =~ s/^%(\.\|$)/$ext$1/g; # % in pattern == extension name	1127	$pattern =~ s/^%(\.\|$)/$ext$1/g; # % in pattern == extension name
1383	if ($pattern =~ /[^a-zA-Z0-9\-\.]/) {	1128	if ($pattern =~ /[^a-zA-Z0-9\-\.]/) {
1384	warn "$dir/$ext: meta resource '$pattern' contains illegal characters (not alphanumeric nor . nor *)\n";	1129	warn "$dir/$ext: meta resource '$pattern' contains illegal characters (not alphanumeric nor . nor *)\n";
1385	} else {	1130	} else {
1386	$meta{resource}{$pattern} = [$ext, $type, $desc];	1131	$ext{resource}{$pattern} = [$ext, $type, $desc];
1387	}	1132	}
		1133	} elsif (/^#:META:BINDING:(.*)/) {
		1134	my ($keysym, $action) = split /:/, $1;
		1135	$ext{binding}{$keysym} = [$ext, $action];
1388	} elsif (/^\s*(?:#\|$)/) {	1136	} elsif (/^\s*(?:#\|$)/) {
1389	# skip other comments and empty lines	1137	# skip other comments and empty lines
1390	} else {	1138	} else {
1391	last; # stop parsing on first non-empty non-comment line	1139	last; # stop parsing on first non-empty non-comment line
1392	}	1140	}
1393	}	1141	}
		1142
		1143	$meta{ext}{$ext} = \%ext;
1394	}	1144	}
		1145	}
		1146
		1147	# and now merge resources and bindings
		1148	while (my ($k, $v) = each %{ $meta{ext} }) {
		1149	#TODO: should check for extensions overriding each other
		1150	%{ $meta{resource} } = (%{ $meta{resource} }, %{ $v->{resource} });
		1151	%{ $meta{binding} } = (%{ $meta{binding} }, %{ $v->{binding} });
1395	}	1152	}
1396	}	1153	}
1397		1154
1398	=item $term = new urxvt::term $envhashref, $rxvtname, [arg...]	1155	=item $term = new urxvt::term $envhashref, $rxvtname, [arg...]
1399		1156
…		…
1419	}	1176	}
1420		1177
1421	=item $term->destroy	1178	=item $term->destroy
1422		1179
1423	Destroy the terminal object (close the window, free resources	1180	Destroy the terminal object (close the window, free resources
1424	etc.). Please note that @@RXVT_NAME@@ will not exit as long as any event	1181	etc.). Please note that urxvt will not exit as long as any event
1425	watchers (timers, io watchers) are still active.	1182	watchers (timers, io watchers) are still active.
1426		1183
1427	=item $term->exec_async ($cmd[, @args])	1184	=item $term->exec_async ($cmd[, @args])
1428		1185
1429	Works like the combination of the C<fork>/C<exec> builtins, which executes	1186	Works like the combination of the C<fork>/C<exec> builtins, which executes
…		…
1485		1242
1486	Here is a likely non-exhaustive list of resource names, not all of which	1243	Here is a likely non-exhaustive list of resource names, not all of which
1487	are supported in every build, please see the source file F</src/rsinc.h>	1244	are supported in every build, please see the source file F</src/rsinc.h>
1488	to see the actual list:	1245	to see the actual list:
1489		1246
1490	answerbackstring backgroundPixmap backspace_key blendtype blurradius	1247	answerbackstring backgroundPixmap backspace_key blurradius
1491	boldFont boldItalicFont borderLess buffered chdir color cursorBlink	1248	boldFont boldItalicFont borderLess buffered chdir color cursorBlink
1492	cursorUnderline cutchars delete_key depth display_name embed ext_bwidth	1249	cursorUnderline cutchars delete_key depth display_name embed ext_bwidth
1493	fade font geometry hold iconName iconfile imFont imLocale inputMethod	1250	fade font geometry hold iconName iconfile imFont imLocale inputMethod
1494	insecure int_bwidth intensityStyles iso14755 iso14755_52 italicFont	1251	insecure int_bwidth intensityStyles iso14755 iso14755_52 italicFont
1495	jumpScroll letterSpace lineSpace loginShell mapAlert meta8 modifier	1252	jumpScroll letterSpace lineSpace loginShell mapAlert meta8 modifier
…		…
1520	Extensions that define extra resource or command line arguments also need	1277	Extensions that define extra resource or command line arguments also need
1521	to call this method to access their values.	1278	to call this method to access their values.
1522		1279
1523	If the method is called on an extension object (basically, from an	1280	If the method is called on an extension object (basically, from an
1524	extension), then the special prefix C<%.> will be replaced by the name of	1281	extension), then the special prefix C<%.> will be replaced by the name of
1525	the extension and a dot, and the lone string C<%> will be replcaed by the	1282	the extension and a dot, and the lone string C<%> will be replaced by the
1526	extension name itself. This makes it possible to code extensions so you	1283	extension name itself. This makes it possible to code extensions so you
1527	can rename them and get a new set of commandline switches and resources	1284	can rename them and get a new set of commandline switches and resources
1528	without having to change the actual code.	1285	without having to change the actual code.
1529		1286
1530	This method should only be called during the C<on_start> hook, as there is	1287	This method should only be called during the C<on_start> hook, as there is
…		…
1545	my $res = &x_resource;	1302	my $res = &x_resource;
1546		1303
1547	$res =~ /^\s(?:true\|yes\|on\|1)\s$/i ? 1 : defined $res && 0	1304	$res =~ /^\s(?:true\|yes\|on\|1)\s$/i ? 1 : defined $res && 0
1548	}	1305	}
1549		1306
1550	=item $success = $term->parse_keysym ($key, $octets)	1307	=item $success = $term->bind_action ($key, $octets)
1551		1308
1552	Adds a key binding exactly as specified via a resource. See the	1309	Adds a key binding exactly as specified via a C<keysym> resource. See the
1553	C<keysym> resource in the @@RXVT_NAME@@(1) manpage.	1310	C<keysym> resource in the urxvt(1) manpage.
1554
1555	=item $term->register_command ($keysym, $modifiermask, $string)
1556
1557	Adds a key binding. This is a lower level api compared to
1558	C<parse_keysym>, as it expects a parsed key description, and can be
1559	used only inside either the C<on_init> hook, to add a binding, or the
1560	C<on_register_command> hook, to modify a parsed binding.
1561		1311
1562	=item $rend = $term->rstyle ([$new_rstyle])	1312	=item $rend = $term->rstyle ([$new_rstyle])
1563		1313
1564	Return and optionally change the current rendition. Text that is output by	1314	Return and optionally change the current rendition. Text that is output by
1565	the terminal application will use this style.	1315	the terminal application will use this style.
…		…
1745	=item $term->tt_write ($octets)	1495	=item $term->tt_write ($octets)
1746		1496
1747	Write the octets given in C<$octets> to the tty (i.e. as program input). To	1497	Write the octets given in C<$octets> to the tty (i.e. as program input). To
1748	pass characters instead of octets, you should convert your strings first	1498	pass characters instead of octets, you should convert your strings first
1749	to the locale-specific encoding using C<< $term->locale_encode >>.	1499	to the locale-specific encoding using C<< $term->locale_encode >>.
		1500
		1501	=item $term->tt_write_user_input ($octets)
		1502
		1503	Like C<tt_write>, but should be used when writing strings in response to
		1504	the user pressing a key, to invokes the additional actions requested by
		1505	the user for that case (C<tt_write> doesn't do that).
		1506
		1507	The typical use case would be inside C<on_action> hooks.
1750		1508
1751	=item $term->tt_paste ($octets)	1509	=item $term->tt_paste ($octets)
1752		1510
1753	Write the octets given in C<$octets> to the tty as a paste, converting NL to	1511	Write the octets given in C<$octets> to the tty as a paste, converting NL to
1754	CR and bracketing the data with control sequences if bracketed paste mode	1512	CR and bracketing the data with control sequences if bracketed paste mode
…		…
1988	}	1746	}
1989		1747
1990	sub urxvt::line::t {	1748	sub urxvt::line::t {
1991	my ($self) = @_;	1749	my ($self) = @_;
1992		1750
1993	if (@_ > 1)	1751	if (@_ > 1) {
1994	{
1995	$self->{term}->ROW_t ($_, $_[1], 0, ($_ - $self->{beg}) * $self->{ncol}, $self->{ncol})	1752	$self->{term}->ROW_t ($_, $_[1], 0, ($_ - $self->{beg}) * $self->{ncol}, $self->{ncol})
1996	for $self->{beg} .. $self->{end};	1753	for $self->{beg} .. $self->{end};
1997	}	1754	}
1998		1755
1999	defined wantarray &&	1756	defined wantarray &&
2000	substr +(join "", map $self->{term}->ROW_t ($_), $self->{beg} .. $self->{end}),	1757	substr +(join "", map $self->{term}->ROW_t ($_), $self->{beg} .. $self->{end}),
2001	0, $self->{len}	1758	0, $self->{len}
2002	}	1759	}
2003		1760
2004	sub urxvt::line::r {	1761	sub urxvt::line::r {
2005	my ($self) = @_;	1762	my ($self) = @_;
2006		1763
2007	if (@_ > 1)	1764	if (@_ > 1) {
2008	{
2009	$self->{term}->ROW_r ($_, $_[1], 0, ($_ - $self->{beg}) * $self->{ncol}, $self->{ncol})	1765	$self->{term}->ROW_r ($_, $_[1], 0, ($_ - $self->{beg}) * $self->{ncol}, $self->{ncol})
2010	for $self->{beg} .. $self->{end};	1766	for $self->{beg} .. $self->{end};
2011	}	1767	}
2012		1768
2013	if (defined wantarray) {	1769	if (defined wantarray) {
2014	my $rend = [	1770	my $rend = [
2015	map @{ $self->{term}->ROW_r ($_) }, $self->{beg} .. $self->{end}	1771	map @{ $self->{term}->ROW_r ($_) }, $self->{beg} .. $self->{end}
2016	];	1772	];

Diff Legend

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

Comparing rxvt-unicode/src/urxvt.pm (file contents): Revision 1.217 by root, Sun Jun 10 13:58:05 2012 UTC vs. Revision 1.238 by root, Sun May 18 18:15:04 2014 UTC

Diff Legend

Comparing rxvt-unicode/src/urxvt.pm (file contents):
Revision 1.217 by root, Sun Jun 10 13:58:05 2012 UTC vs.
Revision 1.238 by root, Sun May 18 18:15:04 2014 UTC