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

Comparing rxvt-unicode/src/urxvt.pm (file contents):
Revision 1.216 by root, Sun Jun 10 13:32:55 2012 UTC vs.
Revision 1.231 by root, Sun Apr 27 20:26:28 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<< ->register_keysym_action >> method.
676		294
677	=item on_register_command $term, $keysym, $modifiermask, $string	295	=item on_register_command $term, $keysym, $modifiermask, $string
678		296
679	Called after parsing a keysym resource but before registering the	297	Called after parsing a keysym resource but before registering the
680	associated binding. If this hook returns TRUE the binding is not	298	associated binding. If this hook returns a true value the binding
681	registered. It can be used to modify a binding by calling	299	is not registered. It can be used to modify a binding by calling
682	C<register_command>.	300	C<register_command>.
683		301
684	=item on_resize_all_windows $term, $new_width, $new_height	302	=item on_resize_all_windows $term, $new_width, $new_height
685		303
686	Called just after the new window size has been calculated, but before	304	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	305	windows are actually being resized or hints are being set. If this hook
688	returns TRUE, setting of the window hints is being skipped.	306	returns a true value, setting of the window hints is being skipped.
689		307
690	=item on_x_event $term, $event	308	=item on_x_event $term, $event
691		309
692	Called on every X event received on the vt window (and possibly other	310	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	311	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	350	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.	351	(real, not screen-based) row and column under the mouse cursor.
734		352
735	C<on_key_press> additionally receives the string rxvt-unicode would	353	C<on_key_press> additionally receives the string rxvt-unicode would
736	output, if any, in locale-specific encoding.	354	output, if any, in locale-specific encoding.
737
738	subwindow.
739		355
740	=item on_client_message $term, $event	356	=item on_client_message $term, $event
741		357
742	=item on_wm_protocols $term, $event	358	=item on_wm_protocols $term, $event
743		359
…		…
951	$name =~ y/-/./ if $isarg;	567	$name =~ y/-/./ if $isarg;
952		568
953	$term->scan_meta;	569	$term->scan_meta;
954		570
955	my $r = $term->{meta}{resource};	571	my $r = $term->{meta}{resource};
956	keys %$r; # reste iterator	572	keys %$r; # reset iterator
957	while (my ($pattern, $v) = each %$r) {	573	while (my ($pattern, $v) = each %$r) {
958	if (	574	if (
959	$pattern =~ /\.$/	575	$pattern =~ /\.$/
960	? $pattern eq substr $name, 0, length $pattern	576	? $pattern eq substr $name, 0, length $pattern
961	: $pattern eq $name	577	: $pattern eq $name
…		…
1024	$pkg =~ s/[^[:word:]]/_/g;	640	$pkg =~ s/[^[:word:]]/_/g;
1025	$pkg = "urxvt::ext::$pkg";	641	$pkg = "urxvt::ext::$pkg";
1026		642
1027	verbose 3, "loading extension '$path' into package '$pkg'";	643	verbose 3, "loading extension '$path' into package '$pkg'";
1028		644
		645	(${"$pkg\::_NAME"} = $path) =~ s/^.*[\\\/]//; # hackish
		646
1029	open my $fh, "<:raw", $path	647	open my $fh, "<:raw", $path
1030	or die "$path: $!";	648	or die "$path: $!";
1031		649
1032	my $source =	650	my $source =
1033	"package $pkg; use strict 'vars'; use utf8; no warnings 'utf8';\n"	651	"package $pkg; use strict 'vars'; use utf8; no warnings 'utf8';\n"
…		…
1047	# called by the rxvt core	665	# called by the rxvt core
1048	sub invoke {	666	sub invoke {
1049	local $TERM = shift;	667	local $TERM = shift;
1050	my $htype = shift;	668	my $htype = shift;
1051		669
1052	if ($htype == 0) { # INIT	670	if ($htype == HOOK_INIT) {
1053	my @dirs = $TERM->perl_libdirs;	671	my @dirs = $TERM->perl_libdirs;
1054		672
1055	my %ext_arg;	673	my %ext_arg;
1056		674
1057	{	675	{
…		…
1096		714
1097	if (my $cb = $TERM->{_hook}[$htype]) {	715	if (my $cb = $TERM->{_hook}[$htype]) {
1098	verbose 10, "$HOOKNAME[$htype] (" . (join ", ", $TERM, @_) . ")"	716	verbose 10, "$HOOKNAME[$htype] (" . (join ", ", $TERM, @_) . ")"
1099	if $verbosity >= 10;	717	if $verbosity >= 10;
1100		718
1101	for my $pkg (keys %$cb) {	719	for my $pkg (
		720	# this hook is only sent to the extension with the name
		721	# matching the first arg
		722	$htype == HOOK_KEYBOARD_DISPATCH
		723	? exists $cb->{"urxvt::ext::$_[0]"} ? "urxvt::ext::" . shift : return undef
		724	: keys %$cb
		725	) {
1102	my $retval_ = eval { $cb->{$pkg}->($TERM->{_pkg}{$pkg}, @_) };	726	my $retval_ = eval { $cb->{$pkg}->($TERM->{_pkg}{$pkg} \|\| $TERM, @_) };
1103	$retval \|\|= $retval_;	727	$retval \|\|= $retval_;
1104		728
1105	if ($@) {	729	if ($@) {
1106	$TERM->ungrab; # better to lose the grab than the session	730	$TERM->ungrab; # better to lose the grab than the session
1107	warn $@;	731	warn $@;
…		…
1110		734
1111	verbose 11, "$HOOKNAME[$htype] returning <$retval>"	735	verbose 11, "$HOOKNAME[$htype] returning <$retval>"
1112	if $verbosity >= 11;	736	if $verbosity >= 11;
1113	}	737	}
1114		738
1115	if ($htype == 1) { # DESTROY	739	if ($htype == HOOK_DESTROY) {
1116	# clear package objects	740	# clear package objects
1117	%$_ = () for values %{ $TERM->{_pkg} };	741	%$_ = () for values %{ $TERM->{_pkg} };
1118		742
1119	# clear package	743	# clear package
1120	%$TERM = ();	744	%$TERM = ();
…		…
1150	}	774	}
1151	}	775	}
1152	($mask, @color{qw(fg bg)}, \@failed)	776	($mask, @color{qw(fg bg)}, \@failed)
1153	}	777	}
1154		778
1155	# urxvt::term::extension
1156
1157	package urxvt::term::extension;	779	package urxvt::term::extension;
1158		780
1159	sub enable {	781	=head2 The C<urxvt::term::extension> class
1160	my ($self, %hook) = @_;
1161	my $pkg = $self->{_pkg};
1162		782
1163	while (my ($name, $cb) = each %hook) {	783	Each extension attached to a terminal object is represented by
1164	my $htype = $HOOKTYPE{uc $name};	784	a C<urxvt::term::extension> object.
1165	defined $htype
1166	or Carp::croak "unsupported hook type '$name'";
1167		785
1168	$self->set_should_invoke ($htype, +1)	786	You can use these objects, which are passed to all callbacks to store any
1169	unless exists $self->{term}{_hook}[$htype]{$pkg};	787	state related to the terminal and extension instance.
1170		788
1171	$self->{term}{_hook}[$htype]{$pkg} = $cb;	789	The methods (And data members) documented below can be called on extension
1172	}	790	objects, in addition to call methods documented for the <urxvt::term>
1173	}	791	class.
1174		792
1175	sub disable {	793	=over 4
1176	my ($self, @hook) = @_;
1177	my $pkg = $self->{_pkg};
1178		794
1179	for my $name (@hook) {	795	=item $urxvt_term = $self->{term}
1180	my $htype = $HOOKTYPE{uc $name};
1181	defined $htype
1182	or Carp::croak "unsupported hook type '$name'";
1183		796
1184	$self->set_should_invoke ($htype, -1)	797	Returns the C<urxvt::term> object associated with this instance of the
1185	if delete $self->{term}{_hook}[$htype]{$pkg};	798	extension. This member I<must not> be changed in any way.
1186	}	799
1187	}	800	=cut
1188		801
1189	our $AUTOLOAD;	802	our $AUTOLOAD;
1190		803
1191	sub AUTOLOAD {	804	sub AUTOLOAD {
1192	$AUTOLOAD =~ /:([^:]+)$/	805	$AUTOLOAD =~ /:([^:]+)$/
…		…
1205		818
1206	sub DESTROY {	819	sub DESTROY {
1207	# nop	820	# nop
1208	}	821	}
1209		822
1210	# urxvt::destroy_hook	823	# urxvt::destroy_hook (basically a cheap Guard:: implementation)
1211		824
1212	sub urxvt::destroy_hook::DESTROY {	825	sub urxvt::destroy_hook::DESTROY {
1213	${$_[0]}->();	826	${$_[0]}->();
1214	}	827	}
1215		828
1216	sub urxvt::destroy_hook(&) {	829	sub urxvt::destroy_hook(&) {
1217	bless \shift, urxvt::destroy_hook::	830	bless \shift, urxvt::destroy_hook::
1218	}	831	}
		832
		833	=item $self->enable ($hook_name => $cb[, $hook_name => $cb..])
		834
		835	Dynamically enable the given hooks (named without the C<on_> prefix) for
		836	this extension, replacing any hook previously installed via C<enable> in
		837	this extension.
		838
		839	This is useful when you want to overwrite time-critical hooks only
		840	temporarily.
		841
		842	To install additional callbacks for the same hook, you can use the C<on>
		843	method of the C<urxvt::term> class.
		844
		845	=item $self->disable ($hook_name[, $hook_name..])
		846
		847	Dynamically disable the given hooks.
		848
		849	=cut
		850
		851	sub enable {
		852	my ($self, %hook) = @_;
		853	my $pkg = $self->{_pkg};
		854
		855	while (my ($name, $cb) = each %hook) {
		856	my $htype = $HOOKTYPE{uc $name};
		857	defined $htype
		858	or Carp::croak "unsupported hook type '$name'";
		859
		860	$self->set_should_invoke ($htype, +1)
		861	unless exists $self->{term}{_hook}[$htype]{$pkg};
		862
		863	$self->{term}{_hook}[$htype]{$pkg} = $cb;
		864	}
		865	}
		866
		867	sub disable {
		868	my ($self, @hook) = @_;
		869	my $pkg = $self->{_pkg};
		870
		871	for my $name (@hook) {
		872	my $htype = $HOOKTYPE{uc $name};
		873	defined $htype
		874	or Carp::croak "unsupported hook type '$name'";
		875
		876	$self->set_should_invoke ($htype, -1)
		877	if delete $self->{term}{_hook}[$htype]{$pkg};
		878	}
		879	}
		880
		881	=item $guard = $self->on ($hook_name => $cb[, $hook_name => $cb..])
		882
		883	Similar to the C<enable> enable, but installs additional callbacks for
		884	the given hook(s) (that is, it doesn't replace existing callbacks), and
		885	returns a guard object. When the guard object is destroyed the callbacks
		886	are disabled again.
		887
		888	=cut
		889
		890	sub urxvt::extension::on_disable::DESTROY {
		891	my $disable = shift;
		892
		893	my $term = delete $disable->{""};
		894
		895	while (my ($htype, $id) = each %$disable) {
		896	delete $term->{_hook}[$htype]{$id};
		897	$term->set_should_invoke ($htype, -1);
		898	}
		899	}
		900
		901	sub on {
		902	my ($self, %hook) = @_;
		903
		904	my $term = $self->{term};
		905
		906	my %disable = ( "" => $term );
		907
		908	while (my ($name, $cb) = each %hook) {
		909	my $htype = $HOOKTYPE{uc $name};
		910	defined $htype
		911	or Carp::croak "unsupported hook type '$name'";
		912
		913	$term->set_should_invoke ($htype, +1);
		914	$term->{_hook}[$htype]{ $disable{$htype} = $cb+0 }
		915	= sub { shift; $cb->($self, @_) }; # very ugly indeed
		916	}
		917
		918	bless \%disable, "urxvt::extension::on_disable"
		919	}
		920
		921	=item $self->x_resource ($pattern)
		922
		923	=item $self->x_resource_boolean ($pattern)
		924
		925	These methods support an additional C<%> prefix when called on an
		926	extension object - see the description of these methods in the
		927	C<urxvt::term> class for details.
		928
		929	=cut
		930
		931	sub x_resource {
		932	my ($self, $name) = @_;
		933	$name =~ s/^%(\.\|$)/$_[0]{_name}$1/;
		934	$self->{term}->x_resource ($name)
		935	}
		936
		937	sub x_resource_boolean {
		938	my ($self, $name) = @_;
		939	$name =~ s/^%(\.\|$)/$_[0]{_name}$1/;
		940	$self->{term}->x_resource_boolean ($name)
		941	}
		942
		943	=back
		944
		945	=cut
1219		946
1220	package urxvt::anyevent;	947	package urxvt::anyevent;
1221		948
1222	=head2 The C<urxvt::anyevent> Class	949	=head2 The C<urxvt::anyevent> Class
1223		950
…		…
1319	urxvt::verbose 6, "register package $pkg to $self";	1046	urxvt::verbose 6, "register package $pkg to $self";
1320		1047
1321	@{"$pkg\::ISA"} = urxvt::term::extension::;	1048	@{"$pkg\::ISA"} = urxvt::term::extension::;
1322		1049
1323	my $proxy = bless {	1050	my $proxy = bless {
1324	_pkg => $pkg,	1051	_pkg => $pkg,
		1052	_name => ${"$pkg\::_NAME"}, # hackish
1325	argv => $argv,	1053	argv => $argv,
1326	}, $pkg;	1054	}, $pkg;
1327	Scalar::Util::weaken ($proxy->{term} = $self);	1055	Scalar::Util::weaken ($proxy->{term} = $self);
1328		1056
1329	$self->{_pkg}{$pkg} = $proxy;	1057	$self->{_pkg}{$pkg} = $proxy;
1330		1058
…		…
1356		1084
1357	for my $dir (reverse @libdirs) {	1085	for my $dir (reverse @libdirs) {
1358	opendir my $fh, $dir	1086	opendir my $fh, $dir
1359	or next;	1087	or next;
1360	for my $ext (readdir $fh) {	1088	for my $ext (readdir $fh) {
1361	$ext ne "."	1089	$ext !~ /^\./
1362	and $ext ne ".."
1363	and open my $fh, "<", "$dir/$ext"	1090	and open my $fh, "<", "$dir/$ext"
1364	or next;	1091	or next;
1365		1092
1366	while (<$fh>) {	1093	while (<$fh>) {
1367	if (/^#:META:X_RESOURCE:(.*)/) {	1094	if (/^#:META:X_RESOURCE:(.*)/) {
…		…
1406	}	1133	}
1407		1134
1408	=item $term->destroy	1135	=item $term->destroy
1409		1136
1410	Destroy the terminal object (close the window, free resources	1137	Destroy the terminal object (close the window, free resources
1411	etc.). Please note that @@RXVT_NAME@@ will not exit as long as any event	1138	etc.). Please note that urxvt will not exit as long as any event
1412	watchers (timers, io watchers) are still active.	1139	watchers (timers, io watchers) are still active.
1413		1140
1414	=item $term->exec_async ($cmd[, @args])	1141	=item $term->exec_async ($cmd[, @args])
1415		1142
1416	Works like the combination of the C<fork>/C<exec> builtins, which executes	1143	Works like the combination of the C<fork>/C<exec> builtins, which executes
…		…
1472		1199
1473	Here is a likely non-exhaustive list of resource names, not all of which	1200	Here is a likely non-exhaustive list of resource names, not all of which
1474	are supported in every build, please see the source file F</src/rsinc.h>	1201	are supported in every build, please see the source file F</src/rsinc.h>
1475	to see the actual list:	1202	to see the actual list:
1476		1203
1477	answerbackstring backgroundPixmap backspace_key blendtype blurradius	1204	answerbackstring backgroundPixmap backspace_key blurradius
1478	boldFont boldItalicFont borderLess buffered chdir color cursorBlink	1205	boldFont boldItalicFont borderLess buffered chdir color cursorBlink
1479	cursorUnderline cutchars delete_key depth display_name embed ext_bwidth	1206	cursorUnderline cutchars delete_key depth display_name embed ext_bwidth
1480	fade font geometry hold iconName iconfile imFont imLocale inputMethod	1207	fade font geometry hold iconName iconfile imFont imLocale inputMethod
1481	insecure int_bwidth intensityStyles iso14755 iso14755_52 italicFont	1208	insecure int_bwidth intensityStyles iso14755 iso14755_52 italicFont
1482	jumpScroll letterSpace lineSpace loginShell mapAlert meta8 modifier	1209	jumpScroll letterSpace lineSpace loginShell mapAlert meta8 modifier
…		…
1502	Returns the X-Resource for the given pattern, excluding the program or	1229	Returns the X-Resource for the given pattern, excluding the program or
1503	class name, i.e. C<< $term->x_resource ("boldFont") >> should return the	1230	class name, i.e. C<< $term->x_resource ("boldFont") >> should return the
1504	same value as used by this instance of rxvt-unicode. Returns C<undef> if no	1231	same value as used by this instance of rxvt-unicode. Returns C<undef> if no
1505	resource with that pattern exists.	1232	resource with that pattern exists.
1506		1233
		1234	Extensions that define extra resource or command line arguments also need
		1235	to call this method to access their values.
		1236
		1237	If the method is called on an extension object (basically, from an
		1238	extension), then the special prefix C<%.> will be replaced by the name of
		1239	the extension and a dot, and the lone string C<%> will be replaced by the
		1240	extension name itself. This makes it possible to code extensions so you
		1241	can rename them and get a new set of commandline switches and resources
		1242	without having to change the actual code.
		1243
1507	This method should only be called during the C<on_start> hook, as there is	1244	This method should only be called during the C<on_start> hook, as there is
1508	only one resource database per display, and later invocations might return	1245	only one resource database per display, and later invocations might return
1509	the wrong resources.	1246	the wrong resources.
1510		1247
1511	=item $value = $term->x_resource_boolean ($pattern)	1248	=item $value = $term->x_resource_boolean ($pattern)
…		…
1525	}	1262	}
1526		1263
1527	=item $success = $term->parse_keysym ($key, $octets)	1264	=item $success = $term->parse_keysym ($key, $octets)
1528		1265
1529	Adds a key binding exactly as specified via a resource. See the	1266	Adds a key binding exactly as specified via a resource. See the
1530	C<keysym> resource in the @@RXVT_NAME@@(1) manpage.	1267	C<keysym> resource in the urxvt(1) manpage.
1531		1268
1532	=item $term->register_command ($keysym, $modifiermask, $string)	1269	=item $term->register_command ($keysym, $modifiermask, $string)
1533		1270
1534	Adds a key binding. This is a lower level api compared to	1271	Adds a key binding. This is a lower level api compared to
1535	C<parse_keysym>, as it expects a parsed key description, and can be	1272	C<parse_keysym>, as it expects a parsed key description, and can be
…		…
1965	}	1702	}
1966		1703
1967	sub urxvt::line::t {	1704	sub urxvt::line::t {
1968	my ($self) = @_;	1705	my ($self) = @_;
1969		1706
1970	if (@_ > 1)	1707	if (@_ > 1) {
1971	{
1972	$self->{term}->ROW_t ($_, $_[1], 0, ($_ - $self->{beg}) * $self->{ncol}, $self->{ncol})	1708	$self->{term}->ROW_t ($_, $_[1], 0, ($_ - $self->{beg}) * $self->{ncol}, $self->{ncol})
1973	for $self->{beg} .. $self->{end};	1709	for $self->{beg} .. $self->{end};
1974	}	1710	}
1975		1711
1976	defined wantarray &&	1712	defined wantarray &&
1977	substr +(join "", map $self->{term}->ROW_t ($_), $self->{beg} .. $self->{end}),	1713	substr +(join "", map $self->{term}->ROW_t ($_), $self->{beg} .. $self->{end}),
1978	0, $self->{len}	1714	0, $self->{len}
1979	}	1715	}
1980		1716
1981	sub urxvt::line::r {	1717	sub urxvt::line::r {
1982	my ($self) = @_;	1718	my ($self) = @_;
1983		1719
1984	if (@_ > 1)	1720	if (@_ > 1) {
1985	{
1986	$self->{term}->ROW_r ($_, $_[1], 0, ($_ - $self->{beg}) * $self->{ncol}, $self->{ncol})	1721	$self->{term}->ROW_r ($_, $_[1], 0, ($_ - $self->{beg}) * $self->{ncol}, $self->{ncol})
1987	for $self->{beg} .. $self->{end};	1722	for $self->{beg} .. $self->{end};
1988	}	1723	}
1989		1724
1990	if (defined wantarray) {	1725	if (defined wantarray) {
1991	my $rend = [	1726	my $rend = [
1992	map @{ $self->{term}->ROW_r ($_) }, $self->{beg} .. $self->{end}	1727	map @{ $self->{term}->ROW_r ($_) }, $self->{beg} .. $self->{end}
1993	];	1728	];

Diff Legend

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

Comparing rxvt-unicode/src/urxvt.pm (file contents): Revision 1.216 by root, Sun Jun 10 13:32:55 2012 UTC vs. Revision 1.231 by root, Sun Apr 27 20:26:28 2014 UTC

Diff Legend

Comparing rxvt-unicode/src/urxvt.pm (file contents):
Revision 1.216 by root, Sun Jun 10 13:32:55 2012 UTC vs.
Revision 1.231 by root, Sun Apr 27 20:26:28 2014 UTC