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

Comparing rxvt-unicode/src/urxvt.pm (file contents):
Revision 1.203 by sf-exg, Fri Dec 2 09:03:43 2011 UTC vs.
Revision 1.220 by root, Tue Jun 19 18:17:56 2012 UTC

…		…
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 @@RXVT_NAME@@d, 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<@@RXVT_LIBDIR@@/urxvt/perl/>, and the documentation can be viewed
		38	using 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	@@RXVT_NAME@@ -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
…		…
476	=item $urxvt_term = $self->{term}	112	=item $urxvt_term = $self->{term}
477		113
478	Returns the C<urxvt::term> object associated with this instance of the	114	Returns the C<urxvt::term> object associated with this instance of the
479	extension. This member I<must not> be changed in any way.	115	extension. This member I<must not> be changed in any way.
480		116
481	=item $self->enable ($hook_name => $cb, [$hook_name => $cb..])	117	=item $self->enable ($hook_name => $cb[, $hook_name => $cb..])
482		118
483	Dynamically enable the given hooks (named without the C<on_> prefix) for	119	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	120	this extension, replacing any previous hook. This is useful when you want
485	to overwrite time-critical hooks only temporarily.	121	to overwrite time-critical hooks only temporarily.
486		122
		123	To install additional callbacks for the same hook, you cna use the C<on>
		124	method of the C<urxvt::term> class.
		125
487	=item $self->disable ($hook_name[, $hook_name..])	126	=item $self->disable ($hook_name[, $hook_name..])
488		127
489	Dynamically disable the given hooks.	128	Dynamically disable the given hooks.
		129
		130	=item $self->x_resource ($pattern)
		131
		132	=item $self->x_resource_boolean ($pattern)
		133
		134	These methods support an additional C<%> prefix when called on an
		135	extension object - see the description of these methods in the
		136	C<urxvt::term> class for details.
490		137
491	=back	138	=back
492		139
493	=head2 Hooks	140	=head2 Hooks
494		141
…		…
755	=cut	402	=cut
756		403
757	package urxvt;	404	package urxvt;
758		405
759	use utf8;	406	use utf8;
760	use strict;	407	use strict 'vars';
761	use Carp ();	408	use Carp ();
762	use Scalar::Util ();	409	use Scalar::Util ();
763	use List::Util ();	410	use List::Util ();
764		411
765	our $VERSION = 1;	412	our $VERSION = 1;
766	our $TERM;	413	our $TERM;
767	our @TERM_INIT;	414	our @TERM_INIT; # should go, prevents async I/O etc.
768	our @TERM_EXT;	415	our @TERM_EXT; # should go, prevents async I/O etc.
769	our @HOOKNAME;	416	our @HOOKNAME;
770	our %HOOKTYPE = map +($HOOKNAME[$_] => $_), 0..$#HOOKNAME;	417	our %HOOKTYPE = map +($HOOKNAME[$_] => $_), 0..$#HOOKNAME;
771	our %OPTION;	418	our %OPTION;
772		419
773	our $LIBDIR;	420	our $LIBDIR;
…		…
943	};	590	};
944	}	591	}
945		592
946	no warnings 'utf8';	593	no warnings 'utf8';
947		594
		595	sub parse_resource {
		596	my ($term, $name, $isarg, $longopt, $flag, $value) = @_;
		597
		598	$name =~ y/-/./ if $isarg;
		599
		600	$term->scan_meta;
		601
		602	my $r = $term->{meta}{resource};
		603	keys %$r; # reste iterator
		604	while (my ($pattern, $v) = each %$r) {
		605	if (
		606	$pattern =~ /\.$/
		607	? $pattern eq substr $name, 0, length $pattern
		608	: $pattern eq $name
		609	) {
		610	$name = "$urxvt::RESCLASS.$name";
		611
		612	push @{ $term->{perl_ext_3} }, $v->[0];
		613
		614	if ($v->[1] eq "boolean") {
		615	$term->put_option_db ($name, $flag ? "true" : "false");
		616	return 1;
		617	} else {
		618	$term->put_option_db ($name, $value);
		619	return 1 + 2;
		620	}
		621	}
		622	}
		623
		624	0
		625	}
		626
		627	sub usage {
		628	my ($term, $usage_type) = @_;
		629
		630	$term->scan_meta;
		631
		632	my $r = $term->{meta}{resource};
		633
		634	for my $pattern (sort keys %$r) {
		635	my ($ext, $type, $desc) = @{ $r->{$pattern} };
		636
		637	$desc .= " (-pe $ext)";
		638
		639	if ($usage_type == 1) {
		640	$pattern =~ y/./-/;
		641	$pattern =~ s/-$/-.../g;
		642
		643	if ($type eq "boolean") {
		644	urxvt::log sprintf " -%-30s %s\n", "/+$pattern", $desc;
		645	} else {
		646	urxvt::log sprintf " -%-30s %s\n", "$pattern $type", $desc;
		647	}
		648	} else {
		649	$pattern =~ s/\.$/.*/g;
		650	urxvt::log sprintf " %-31s %s\n", "$pattern:", $type;
		651	}
		652	}
		653	}
		654
948	my $verbosity = $ENV{URXVT_PERL_VERBOSITY};	655	my $verbosity = $ENV{URXVT_PERL_VERBOSITY};
949		656
950	sub verbose {	657	sub verbose {
951	my ($level, $msg) = @_;	658	my ($level, $msg) = @_;
952	warn "$msg\n" if $level <= $verbosity;	659	warn "$msg\n" if $level <= $verbosity;
…		…
964	$pkg =~ s/[^[:word:]]/_/g;	671	$pkg =~ s/[^[:word:]]/_/g;
965	$pkg = "urxvt::ext::$pkg";	672	$pkg = "urxvt::ext::$pkg";
966		673
967	verbose 3, "loading extension '$path' into package '$pkg'";	674	verbose 3, "loading extension '$path' into package '$pkg'";
968		675
		676	(${"$pkg\::_NAME"} = $path) =~ s/^.*[\\\/]//; # hackish
		677
969	open my $fh, "<:raw", $path	678	open my $fh, "<:raw", $path
970	or die "$path: $!";	679	or die "$path: $!";
971		680
972	my $source =	681	my $source =
973	"package $pkg; use strict; use utf8; no warnings 'utf8';\n"	682	"package $pkg; use strict 'vars'; use utf8; no warnings 'utf8';\n"
974	. "#line 1 \"$path\"\n{\n"	683	. "#line 1 \"$path\"\n{\n"
975	. (do { local $/; <$fh> })	684	. (do { local $/; <$fh> })
976	. "\n};\n1";	685	. "\n};\n1";
977		686
978	eval $source	687	eval $source
…		…
988	sub invoke {	697	sub invoke {
989	local $TERM = shift;	698	local $TERM = shift;
990	my $htype = shift;	699	my $htype = shift;
991		700
992	if ($htype == 0) { # INIT	701	if ($htype == 0) { # INIT
993	my @dirs = ((split /:/, $TERM->resource ("perl_lib")), "$ENV{HOME}/.urxvt/ext", "$LIBDIR/perl");	702	my @dirs = $TERM->perl_libdirs;
994		703
995	my %ext_arg;	704	my %ext_arg;
996		705
997	{	706	{
998	my @init = @TERM_INIT;	707	my @init = @TERM_INIT;
…		…
1001	my @pkg = @TERM_EXT;	710	my @pkg = @TERM_EXT;
1002	@TERM_EXT = ();	711	@TERM_EXT = ();
1003	$TERM->register_package ($_) for @pkg;	712	$TERM->register_package ($_) for @pkg;
1004	}	713	}
1005		714
		715	for (
		716	@{ delete $TERM->{perl_ext_3} },
1006	for (grep $_, map { split /,/, $TERM->resource ("perl_ext_$_") } 1, 2) {	717	grep $_, map { split /,/, $TERM->resource ("perl_ext_$_") } 1, 2
		718	) {
1007	if ($_ eq "default") {	719	if ($_ eq "default") {
1008	$ext_arg{$_} \|\|= [] for qw(selection option-popup selection-popup searchable-scrollback readline);	720	$ext_arg{$_} \|\|= [] for qw(selection option-popup selection-popup searchable-scrollback readline);
1009	} elsif (/^-(.*)$/) {	721	} elsif (/^-(.*)$/) {
1010	delete $ext_arg{$1};	722	delete $ext_arg{$1};
1011	} elsif (/^([^<]+)<(.*)>$/) {	723	} elsif (/^([^<]+)<(.*)>$/) {
…		…
1034	if (my $cb = $TERM->{_hook}[$htype]) {	746	if (my $cb = $TERM->{_hook}[$htype]) {
1035	verbose 10, "$HOOKNAME[$htype] (" . (join ", ", $TERM, @_) . ")"	747	verbose 10, "$HOOKNAME[$htype] (" . (join ", ", $TERM, @_) . ")"
1036	if $verbosity >= 10;	748	if $verbosity >= 10;
1037		749
1038	for my $pkg (keys %$cb) {	750	for my $pkg (keys %$cb) {
1039	my $retval_ = eval { $cb->{$pkg}->($TERM->{_pkg}{$pkg}, @_) };	751	my $retval_ = eval { $cb->{$pkg}->($TERM->{_pkg}{$pkg} \|\| $TERM, @_) };
1040	$retval \|\|= $retval_;	752	$retval \|\|= $retval_;
1041		753
1042	if ($@) {	754	if ($@) {
1043	$TERM->ungrab; # better to lose the grab than the session	755	$TERM->ungrab; # better to lose the grab than the session
1044	warn $@;	756	warn $@;
…		…
1087	}	799	}
1088	}	800	}
1089	($mask, @color{qw(fg bg)}, \@failed)	801	($mask, @color{qw(fg bg)}, \@failed)
1090	}	802	}
1091		803
1092	# urxvt::term::extension
1093
1094	package urxvt::term::extension;	804	package urxvt::term::extension;
1095		805
1096	sub enable {	806	sub enable {
1097	my ($self, %hook) = @_;	807	my ($self, %hook) = @_;
1098	my $pkg = $self->{_pkg};	808	my $pkg = $self->{_pkg};
…		…
1152		862
1153	sub urxvt::destroy_hook(&) {	863	sub urxvt::destroy_hook(&) {
1154	bless \shift, urxvt::destroy_hook::	864	bless \shift, urxvt::destroy_hook::
1155	}	865	}
1156		866
		867	sub x_resource {
		868	my ($self, $name) = @_;
		869	$name =~ s/^%(\.\|$)/$_[0]{_name}$1/;
		870	$self->{term}->x_resource ($name)
		871	}
		872
		873	sub x_resource_boolean {
		874	my ($self, $name) = @_;
		875	$name =~ s/^%(\.\|$)/$_[0]{_name}$1/;
		876	$self->{term}->x_resource_boolean ($name)
		877	}
		878
1157	package urxvt::anyevent;	879	package urxvt::anyevent;
1158		880
1159	=head2 The C<urxvt::anyevent> Class	881	=head2 The C<urxvt::anyevent> Class
1160		882
1161	The sole purpose of this class is to deliver an interface to the	883	The sole purpose of this class is to deliver an interface to the
1162	C<AnyEvent> module - any module using it will work inside urxvt without	884	C<AnyEvent> module - any module using it will work inside urxvt without
1163	further programming. The only exception is that you cannot wait on	885	further programming. The only exception is that you cannot wait on
1164	condition variables, but non-blocking condvar use is ok. What this means	886	condition variables, but non-blocking condvar use is ok.
1165	is that you cannot use blocking APIs, but the non-blocking variant should	887
1166	work.	888	In practical terms this means is that you cannot use blocking APIs, but
		889	the non-blocking variant should work.
1167		890
1168	=cut	891	=cut
1169		892
1170	our $VERSION = '5.23';	893	our $VERSION = '5.23';
1171		894
…		…
1255	urxvt::verbose 6, "register package $pkg to $self";	978	urxvt::verbose 6, "register package $pkg to $self";
1256		979
1257	@{"$pkg\::ISA"} = urxvt::term::extension::;	980	@{"$pkg\::ISA"} = urxvt::term::extension::;
1258		981
1259	my $proxy = bless {	982	my $proxy = bless {
1260	_pkg => $pkg,	983	_pkg => $pkg,
		984	_name => ${"$pkg\::_NAME"}, # hackish
1261	argv => $argv,	985	argv => $argv,
1262	}, $pkg;	986	}, $pkg;
1263	Scalar::Util::weaken ($proxy->{term} = $self);	987	Scalar::Util::weaken ($proxy->{term} = $self);
1264		988
1265	$self->{_pkg}{$pkg} = $proxy;	989	$self->{_pkg}{$pkg} = $proxy;
1266		990
…		…
1269	$proxy->enable ($name => $ref);	993	$proxy->enable ($name => $ref);
1270	}	994	}
1271	}	995	}
1272	}	996	}
1273		997
		998	sub perl_libdirs {
		999	map { split /:/ }
		1000	$_[0]->resource ("perl_lib"),
		1001	$ENV{URXVT_PERL_LIB},
		1002	"$ENV{HOME}/.urxvt/ext",
		1003	"$LIBDIR/perl"
		1004	}
		1005
		1006	sub scan_meta {
		1007	my ($self) = @_;
		1008	my @libdirs = perl_libdirs $self;
		1009
		1010	return if $self->{meta_libdirs} eq join "\x00", @libdirs;
		1011
		1012	my %meta;
		1013
		1014	$self->{meta_libdirs} = join "\x00", @libdirs;
		1015	$self->{meta} = \%meta;
		1016
		1017	for my $dir (reverse @libdirs) {
		1018	opendir my $fh, $dir
		1019	or next;
		1020	for my $ext (readdir $fh) {
		1021	$ext ne "."
		1022	and $ext ne ".."
		1023	and open my $fh, "<", "$dir/$ext"
		1024	or next;
		1025
		1026	while (<$fh>) {
		1027	if (/^#:META:X_RESOURCE:(.*)/) {
		1028	my ($pattern, $type, $desc) = split /:/, $1;
		1029	$pattern =~ s/^%(\.\|$)/$ext$1/g; # % in pattern == extension name
		1030	if ($pattern =~ /[^a-zA-Z0-9\-\.]/) {
		1031	warn "$dir/$ext: meta resource '$pattern' contains illegal characters (not alphanumeric nor . nor *)\n";
		1032	} else {
		1033	$meta{resource}{$pattern} = [$ext, $type, $desc];
		1034	}
		1035	} elsif (/^\s*(?:#\|$)/) {
		1036	# skip other comments and empty lines
		1037	} else {
		1038	last; # stop parsing on first non-empty non-comment line
		1039	}
		1040	}
		1041	}
		1042	}
		1043	}
		1044
1274	=item $term = new urxvt::term $envhashref, $rxvtname, [arg...]	1045	=item $term = new urxvt::term $envhashref, $rxvtname, [arg...]
1275		1046
1276	Creates a new terminal, very similar as if you had started it with system	1047	Creates a new terminal, very similar as if you had started it with system
1277	C<$rxvtname, arg...>. C<$envhashref> must be a reference to a C<%ENV>-like	1048	C<$rxvtname, arg...>. C<$envhashref> must be a reference to a C<%ENV>-like
1278	hash which defines the environment of the new terminal.	1049	hash which defines the environment of the new terminal.
…		…
1297	=item $term->destroy	1068	=item $term->destroy
1298		1069
1299	Destroy the terminal object (close the window, free resources	1070	Destroy the terminal object (close the window, free resources
1300	etc.). Please note that @@RXVT_NAME@@ will not exit as long as any event	1071	etc.). Please note that @@RXVT_NAME@@ will not exit as long as any event
1301	watchers (timers, io watchers) are still active.	1072	watchers (timers, io watchers) are still active.
		1073
		1074	=item $guard = $self->on ($hook_name => $cb[, $hook_name => $cb..])
		1075
		1076	Similar to the extension method C<enable>, but installs additional
		1077	callbacks for the givne hook(s) (existing ones are not replaced), and
		1078	returns a guard object. When the guard object is destroyed the callbacks
		1079	are disabled again.
		1080
		1081	Note that these callbacks receive the normal paramaters, but the first
		1082	argument (normally the extension) is currently undefined.
		1083
		1084	=cut
		1085
		1086	sub urxvt::term::on_disable::DESTROY {
		1087	my $disable = shift;
		1088
		1089	my $self = delete $disable->{""};
		1090
		1091	while (my ($htype, $id) = each %$disable) {
		1092	delete $self->{_hook}[$htype]{$id};
		1093	$self->set_should_invoke ($htype, -1);
		1094	}
		1095	}
		1096
		1097	sub on {
		1098	my ($self, %hook) = @_;
		1099
		1100	my %disable = ( "" => $self );
		1101
		1102	while (my ($name, $cb) = each %hook) {
		1103	my $htype = $HOOKTYPE{uc $name};
		1104	defined $htype
		1105	or Carp::croak "unsupported hook type '$name'";
		1106
		1107	my $id = $cb+0;
		1108
		1109	$self->set_should_invoke ($htype, +1);
		1110	$disable{$htype} = $id;
		1111	$self->{_hook}[$htype]{$id} = $cb;
		1112	}
		1113
		1114	bless \%disable, "urxvt::term::on_disable"
		1115	}
1302		1116
1303	=item $term->exec_async ($cmd[, @args])	1117	=item $term->exec_async ($cmd[, @args])
1304		1118
1305	Works like the combination of the C<fork>/C<exec> builtins, which executes	1119	Works like the combination of the C<fork>/C<exec> builtins, which executes
1306	("starts") programs in the background. This function takes care of setting	1120	("starts") programs in the background. This function takes care of setting
…		…
1361		1175
1362	Here is a likely non-exhaustive list of resource names, not all of which	1176	Here is a likely non-exhaustive list of resource names, not all of which
1363	are supported in every build, please see the source file F</src/rsinc.h>	1177	are supported in every build, please see the source file F</src/rsinc.h>
1364	to see the actual list:	1178	to see the actual list:
1365		1179
1366	answerbackstring backgroundPixmap backspace_key blendtype blurradius	1180	answerbackstring backgroundPixmap backspace_key blurradius
1367	boldFont boldItalicFont borderLess buffered chdir color cursorBlink	1181	boldFont boldItalicFont borderLess buffered chdir color cursorBlink
1368	cursorUnderline cutchars delete_key depth display_name embed ext_bwidth	1182	cursorUnderline cutchars delete_key depth display_name embed ext_bwidth
1369	fade font geometry hold iconName iconfile imFont imLocale inputMethod	1183	fade font geometry hold iconName iconfile imFont imLocale inputMethod
1370	insecure int_bwidth intensityStyles iso14755 iso14755_52 italicFont	1184	insecure int_bwidth intensityStyles iso14755 iso14755_52 italicFont
1371	jumpScroll letterSpace lineSpace loginShell mapAlert meta8 modifier	1185	jumpScroll letterSpace lineSpace loginShell mapAlert meta8 modifier
…		…
1391	Returns the X-Resource for the given pattern, excluding the program or	1205	Returns the X-Resource for the given pattern, excluding the program or
1392	class name, i.e. C<< $term->x_resource ("boldFont") >> should return the	1206	class name, i.e. C<< $term->x_resource ("boldFont") >> should return the
1393	same value as used by this instance of rxvt-unicode. Returns C<undef> if no	1207	same value as used by this instance of rxvt-unicode. Returns C<undef> if no
1394	resource with that pattern exists.	1208	resource with that pattern exists.
1395		1209
		1210	Extensions that define extra resource or command line arguments also need
		1211	to call this method to access their values.
		1212
		1213	If the method is called on an extension object (basically, from an
		1214	extension), then the special prefix C<%.> will be replaced by the name of
		1215	the extension and a dot, and the lone string C<%> will be replaced by the
		1216	extension name itself. This makes it possible to code extensions so you
		1217	can rename them and get a new set of commandline switches and resources
		1218	without having to change the actual code.
		1219
1396	This method should only be called during the C<on_start> hook, as there is	1220	This method should only be called during the C<on_start> hook, as there is
1397	only one resource database per display, and later invocations might return	1221	only one resource database per display, and later invocations might return
1398	the wrong resources.	1222	the wrong resources.
		1223
		1224	=item $value = $term->x_resource_boolean ($pattern)
		1225
		1226	Like C<x_resource>, above, but interprets the string value as a boolean
		1227	and returns C<1> for true values, C<0> for false values and C<undef> if
		1228	the resource or option isn't specified.
		1229
		1230	You should always use this method to parse boolean resources.
		1231
		1232	=cut
		1233
		1234	sub x_resource_boolean {
		1235	my $res = &x_resource;
		1236
		1237	$res =~ /^\s(?:true\|yes\|on\|1)\s$/i ? 1 : defined $res && 0
		1238	}
1399		1239
1400	=item $success = $term->parse_keysym ($key, $octets)	1240	=item $success = $term->parse_keysym ($key, $octets)
1401		1241
1402	Adds a key binding exactly as specified via a resource. See the	1242	Adds a key binding exactly as specified via a resource. See the
1403	C<keysym> resource in the @@RXVT_NAME@@(1) manpage.	1243	C<keysym> resource in the @@RXVT_NAME@@(1) manpage.
…		…
1628		1468
1629	Adds the specified events to the vt event mask. Useful e.g. when you want	1469	Adds the specified events to the vt event mask. Useful e.g. when you want
1630	to receive pointer events all the times:	1470	to receive pointer events all the times:
1631		1471
1632	$term->vt_emask_add (urxvt::PointerMotionMask);	1472	$term->vt_emask_add (urxvt::PointerMotionMask);
		1473
		1474	=item $term->set_urgency ($set)
		1475
		1476	Enable/disable the urgency hint on the toplevel window.
1633		1477
1634	=item $term->focus_in	1478	=item $term->focus_in
1635		1479
1636	=item $term->focus_out	1480	=item $term->focus_out
1637		1481

Diff Legend

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

Comparing rxvt-unicode/src/urxvt.pm (file contents): Revision 1.203 by sf-exg, Fri Dec 2 09:03:43 2011 UTC vs. Revision 1.220 by root, Tue Jun 19 18:17:56 2012 UTC

Diff Legend

Comparing rxvt-unicode/src/urxvt.pm (file contents):
Revision 1.203 by sf-exg, Fri Dec 2 09:03:43 2011 UTC vs.
Revision 1.220 by root, Tue Jun 19 18:17:56 2012 UTC