ViewVC Help
View File | Revision Log | Show Annotations | Download File
/cvs/rxvt-unicode/src/urxvt.pm
(Generate patch)

Comparing rxvt-unicode/src/urxvt.pm (file contents):
Revision 1.214 by root, Wed Jun 6 15:26:32 2012 UTC vs.
Revision 1.235 by sf-exg, Sat May 17 15:33:24 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 5urxvtperl - 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
22Every time a terminal object gets created, extension scripts specified via 22Every time a terminal object gets created, extension scripts specified via
23the C<perl> resource are loaded and associated with it. 23the C<perl> resource are loaded and associated with it.
24 24
25Scripts are compiled in a 'use strict' and 'use utf8' environment, and 25Scripts are compiled in a 'use strict "vars"' and 'use utf8' environment, and
26thus must be encoded as UTF-8. 26thus must be encoded as UTF-8.
27 27
28Each script will only ever be loaded once, even in @@RXVT_NAME@@d, where 28Each script will only ever be loaded once, even in urxvtd, where
29scripts will be shared (but not enabled) for all terminals. 29scripts will be shared (but not enabled) for all terminals.
30 30
31You can disable the embedded perl interpreter by setting both "perl-ext" 31You can disable the embedded perl interpreter by setting both "perl-ext"
32and "perl-ext-common" resources to the empty string. 32and "perl-ext-common" resources to the empty string.
33 33
34=head1 PREPACKAGED EXTENSIONS 34=head1 PREPACKAGED EXTENSIONS
35 35
36This section describes the extensions delivered with this release. You can 36A number of extensions are delivered with this release. You can find them
37find them in F<@@RXVT_LIBDIR@@/urxvt/perl/>. 37in F<< <libdir>/urxvt/perl/ >>, and the documentation can be viewed using
38F<< man urxvt-<EXTENSIONNAME> >>.
38 39
39You can activate them like this: 40You can activate them like this:
40 41
41 @@RXVT_NAME@@ -pe <extensionname> 42 urxvt -pe <extensionname>
42 43
43Or by adding them to the resource for extensions loaded by default: 44Or 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 48Extensions that add command line parameters or resources on their own are
48 49loaded automatically when used.
49=item selection (enabled by default)
50
51(More) intelligent selection. This extension tries to be more intelligent
52when the user extends selections (double-click and further clicks). Right
53now, it tries to select words, urls and complete shell-quoted
54arguments, which is very convenient, too, if your F<ls> supports
55C<--quoting-style=shell>.
56
57A double-click usually selects the word under the cursor, further clicks
58will enlarge the selection.
59
60The selection works by trying to match a number of regexes and displaying
61them in increasing order of length. You can add your own regexes by
62specifying resources of the form:
63
64 URxvt.selection.pattern-0: perl-regex
65 URxvt.selection.pattern-1: perl-regex
66 ...
67
68The index number (0, 1...) must not have any holes, and each regex must
69contain at least one pair of capturing parentheses, which will be used for
70the match. For example, the following adds a regex that matches everything
71between two vertical bars:
72
73 URxvt.selection.pattern-0: \\|([^|]+)\\|
74
75Another example: Programs I use often output "absolute path: " at the
76beginning of a line when they process multiple files. The following
77pattern matches the filename (note, there is a single space at the very
78end):
79
80 URxvt.selection.pattern-0: ^(/[^:]+):\
81
82You can look at the source of the selection extension to see more
83interesting uses, such as parsing a line from beginning to end.
84
85This extension also offers following bindable keyboard commands:
86
87=over 4
88
89=item rot13
90
91Rot-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
99Binds a popup menu to Ctrl-Button2 that lets you toggle (some) options at
100runtime.
101
102Other extensions can extend this popup menu by pushing a code reference
103onto C<@{ $term->{option_popup_hook} }>, which gets called whenever the
104popup is being displayed.
105
106Its sole argument is the popup menu, which can be modified. It should
107either return nothing or a string, the initial boolean value and a code
108reference. The string will be used as button text and the code reference
109will be called when the toggle changes, with the new boolean value as
110first argument.
111
112The following will add an entry C<myoption> that changes
113C<< $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
121Binds a popup menu to Ctrl-Button3 that lets you convert the selection
122text into various other formats/action (such as uri unescaping, perl
123evaluation, web-browser starting etc.), depending on content.
124
125Other extensions can extend this popup menu by pushing a code reference
126onto C<@{ $term->{selection_popup_hook} }>, which gets called whenever the
127popup is being displayed.
128
129Its sole argument is the popup menu, which can be modified. The selection
130is in C<$_>, which can be used to decide whether to add something or not.
131It should either return nothing or a string and a code reference. The
132string will be used as button text and the code reference will be called
133when the button gets activated and should transform C<$_>.
134
135The following will add an entry C<a to b> that transforms all C<a>s in
136the selection to C<b>s, but only if the selection currently contains any
137C<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
146Adds regex search functionality to the scrollback buffer, triggered
147by a hotkey (default: C<M-s>). While in search mode, normal terminal
148input/output is suspended and a regex is displayed at the bottom of the
149screen.
150
151Inputting characters appends them to the regex and continues incremental
152search. C<BackSpace> removes a character from the regex, C<Up> and C<Down>
153search upwards/downwards in the scrollback buffer, C<End> jumps to the
154bottom. C<Escape> leaves search mode and returns to the point where search
155was started, while C<Enter> or C<Return> stay at the current position and
156additionally stores the first match in the current line into the primary
157selection if the C<Shift> modifier is active.
158
159The regex defaults to "(?i)", resulting in a case-insensitive search. To
160get a case-sensitive search you can delete this prefix using C<BackSpace>
161or simply use an uppercase character which removes the "(?i)" prefix.
162
163See L<perlre> for more info about perl regular expression syntax.
164
165=item readline (enabled by default)
166
167A support package that tries to make editing with readline easier. At
168the moment, it reacts to clicking shift-left mouse button by trying to
169move the text cursor to this position. It does so by generating as many
170cursor-left or cursor-right keypresses as required (this only works
171for programs that correctly support wide characters).
172
173To 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
187The normal selection mechanism isn't disabled, so quick successive clicks
188might interfere with selection creation in harmless ways.
189
190=item selection-autotransform
191
192This selection allows you to do automatic transforms on a selection
193whenever a selection is made.
194
195It works by specifying perl snippets (most useful is a single C<s///>
196operator) that modify C<$_> as resources:
197
198 URxvt.selection-autotransform.0: transform
199 URxvt.selection-autotransform.1: transform
200 ...
201
202For example, the following will transform selections of the form
203C<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
208And this example matches the same,but replaces it with vi-commands you can
209paste directly into your (vi :) editor:
210
211 URxvt.selection-autotransform.0: s/^([^:[:space:]]+(\\d+):?$/:e \\Q$1\\E\\x0d:$2\\x0d/
212
213Of course, this can be modified to suit your needs and your editor :)
214
215To expand the example above to typical perl error messages ("XXX at
216FILENAME 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
221The first line tells the selection code to treat the unchanging part of
222every error message as a selection pattern, and the second line transforms
223the message into vi commands to load the file.
224
225=item tabbed
226
227This transforms the terminal into a tabbar with additional terminals, that
228is, it implements what is commonly referred to as "tabbed terminal". The topmost line
229displays a "[NEW]" button, which, when clicked, will add a new tab, followed by one
230button per tab.
231
232Clicking a button will activate that tab. Pressing B<Shift-Left> and
233B<Shift-Right> will switch to the tab left or right of the current one,
234while B<Shift-Down> creates a new tab.
235
236The tabbar itself can be configured similarly to a normal terminal, but
237with a resource class of C<URxvt.tabbed>. In addition, it supports the
238following 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
245See I<COLOR AND GRAPHICS> in the @@RXVT_NAME@@(1) manpage for valid
246indices.
247
248=item matcher
249
250Uses per-line display filtering (C<on_line_update>) to underline text
251matching a certain pattern and make it clickable. When clicked with the
252mouse button specified in the C<matcher.button> resource (default 2, or
253middle), the program specified in the C<matcher.launcher> resource
254(default, the C<urlLauncher> resource, C<sensible-browser>) will be started
255with the matched text as first argument. The default configuration is
256suitable for matching URLs and launching a web browser, like the
257former "mark-urls" extension.
258
259The default pattern to match URLs can be overridden with the
260C<matcher.pattern.0> resource, and additional patterns can be specified
261with numbered patterns, in a manner similar to the "selection" extension.
262The launcher can also be overridden on a per-pattern basis.
263
264It is possible to activate the most recently seen match or a list of matches
265from the keyboard. Simply bind a keysym to "perl:matcher:last" or
266"perl:matcher:list" as seen in the example below.
267
268Example 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
281This (experimental) perl extension implements OnTheSpot editing. It does
282not work perfectly, and some input methods don't seem to work well with
283OnTheSpot editing in general, but it seems to work at least for SCIM and
284kinput2.
285
286You enable it by specifying this extension and a preedit style of
287C<OnTheSpot>, i.e.:
288
289 @@RXVT_NAME@@ -pt OnTheSpot -pe xim-onthespot
290
291=item kuake<hotkey>
292
293A very primitive quake-console-like extension. It was inspired by a
294description of how the programs C<kuake> and C<yakuake> work: Whenever the
295user presses a global accelerator key (by default C<F10>), the terminal
296will show or hide itself. Another press of the accelerator key will hide
297or show it again.
298
299Initially, the window will not be shown when using this extension.
300
301This is useful if you need a single terminal that is not using any desktop
302space most of the time but is quickly available at the press of a key.
303
304The accelerator key is grabbed regardless of any modifiers, so this
305extension will actually grab a physical key just for this function.
306
307If you want a quake-like animation, tell your window manager to do so
308(fvwm can do it).
309
310=item overlay-osc
311
312This extension implements some OSC commands to display timed popups on the
313screen - useful for status displays from within scripts. You have to read
314the sources for more info.
315
316=item block-graphics-to-ascii
317
318A not very useful example of filtering all text output to the terminal
319by replacing all line-drawing characters (U+2500 .. U+259F) by a
320similar-looking ascii character.
321
322=item digital-clock
323
324Displays a digital clock using the built-in overlay.
325
326=item remote-clipboard
327
328Somewhat of a misnomer, this extension adds two menu entries to the
329selection popup that allows one to run external commands to store the
330selection somewhere and fetch it again.
331
332We use it to implement a "distributed selection mechanism", which just
333means that one command uploads the file to a remote server, and another
334reads it.
335
336The commands can be set using the C<URxvt.remote-selection.store> and
337C<URxvt.remote-selection.fetch> resources. The first should read the
338selection to store from STDIN (always in UTF-8), the second should provide
339the selection data on STDOUT (also in UTF-8).
340
341The 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
348This is a little rarely useful extension that uploads the selection as
349textfile to a remote site (or does other things). (The implementation is
350not currently secure for use in a multiuser environment as it writes to
351F</tmp> directly.).
352
353It listens to the C<selection-pastebin:remote-pastebin> keyboard command,
354i.e.
355
356 URxvt.keysym.C-M-e: perl:selection-pastebin:remote-pastebin
357
358Pressing this combination runs a command with C<%> replaced by the name of
359the 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
363And the default is likely not useful to anybody but the few people around
364here :)
365
366The name of the textfile is the hex encoded md5 sum of the selection, so
367the same content should lead to the same filename.
368
369After a successful upload the selection will be replaced by the text given
370in the C<selection-pastebin-url> resource (again, the % is the placeholder
371for the filename):
372
373 URxvt.selection-pastebin.url: http://www.ta-sa.org/files/txt/%
374
375I<Note to xrdb users:> xrdb uses the C preprocessor, which might interpret
376the double C</> characters as comment start. Use C<\057\057> instead,
377which works regardless of whether xrdb is used to parse the resource file
378or not.
379
380=item macosx-clipboard and macosx-clipboard-native
381
382These two modules implement an extended clipboard for Mac OS X. They are
383used 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
389The difference between them is that the native variant requires a
390perl from apple's devkit or so, and C<macosx-clipboard> requires the
391C<Mac::Pasteboard> module, works with other perls, has fewer bugs, is
392simpler etc. etc.
393
394=item example-refresh-hooks
395
396Displays a very simple digital clock in the upper right corner of the
397window. Illustrates overwriting the refresh callbacks to create your own
398overlays or changes.
399
400=item confirm-paste
401
402Displays a confirmation dialog when a paste containing at least a full
403line is detected.
404
405=item bell-command
406
407Runs the command specified by the C<URxvt.bell-command> resource when
408a bell event occurs. For example, the following pops up a notification
409bubble 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
467internal use. 103internal use.
468 104
469Although it isn't a C<urxvt::term> object, you can call all methods of the 105Although it isn't a C<urxvt::term> object, you can call all methods of the
470C<urxvt::term> class on this object. 106C<urxvt::term> class on this object.
471 107
472It has the following methods and data members: 108Additional methods only supported for extension objects are described in
473 109the C<urxvt::extension> section below.
474=over 4
475
476=item $urxvt_term = $self->{term}
477
478Returns the C<urxvt::term> object associated with this instance of the
479extension. This member I<must not> be changed in any way.
480
481=item $self->enable ($hook_name => $cb, [$hook_name => $cb..])
482
483Dynamically enable the given hooks (named without the C<on_> prefix) for
484this extension, replacing any previous hook. This is useful when you want
485to overwrite time-critical hooks only temporarily.
486
487=item $self->disable ($hook_name[, $hook_name..])
488
489Dynamically disable the given hooks.
490
491=back
492 110
493=head2 Hooks 111=head2 Hooks
494 112
495The following subroutines can be declared in extension files, and will be 113The following subroutines can be declared in extension files, and will be
496called whenever the relevant event happens. 114called whenever the relevant event happens.
663 281
664=item on_refresh_end $term 282=item on_refresh_end $term
665 283
666Called just after the screen gets redrawn. See C<on_refresh_begin>. 284Called 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
670Called whenever a user-configured event is being activated (e.g. via 288Called whenever a user-configured event is being activated (e.g. via
671a C<perl:string> action bound to a key, see description of the B<keysym> 289a C<perl:string> action bound to a key, see description of the B<keysym>
672resource in the @@RXVT_NAME@@(1) manpage). 290resource in the urxvt(1) manpage).
673 291
674The event is simply the action string. This interface is assumed to change 292The event is simply the action string. This interface is going away in
675slightly in the future. 293preference to the C<on_action> hook.
676
677=item on_register_command $term, $keysym, $modifiermask, $string
678
679Called after parsing a keysym resource but before registering the
680associated binding. If this hook returns TRUE the binding is not
681registered. It can be used to modify a binding by calling
682C<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
686Called just after the new window size has been calculated, but before 297Called just after the new window size has been calculated, but before
687windows are actually being resized or hints are being set. If this hook 298windows are actually being resized or hints are being set. If this hook
688returns TRUE, setting of the window hints is being skipped. 299returns 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
692Called on every X event received on the vt window (and possibly other 303Called on every X event received on the vt window (and possibly other
693windows). Should only be used as a last resort. Most event structure 304windows). Should only be used as a last resort. Most event structure
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
735C<on_key_press> additionally receives the string rxvt-unicode would 346C<on_key_press> additionally receives the string rxvt-unicode would
736output, if any, in locale-specific encoding. 347output, if any, in locale-specific encoding.
737 348
738subwindow.
739
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
744=item on_wm_delete_window $term, $event 353=item on_wm_delete_window $term, $event
755=cut 364=cut
756 365
757package urxvt; 366package urxvt;
758 367
759use utf8; 368use utf8;
760use strict; 369use strict 'vars';
761use Carp (); 370use Carp ();
762use Scalar::Util (); 371use Scalar::Util ();
763use List::Util (); 372use List::Util ();
764 373
765our $VERSION = 1; 374our $VERSION = 1;
946no warnings 'utf8'; 555no warnings 'utf8';
947 556
948sub parse_resource { 557sub parse_resource {
949 my ($term, $name, $isarg, $longopt, $flag, $value) = @_; 558 my ($term, $name, $isarg, $longopt, $flag, $value) = @_;
950 559
560 $name =~ y/-/./ if $isarg;
561
951 $term->scan_meta; 562 $term->scan_extensions;
952 563
953 my $r = $term->{meta}{resource}; 564 my $r = $term->{meta}{resource};
565 keys %$r; # reset iterator
954 while (my ($pattern, $v) = each %$r) { 566 while (my ($pattern, $v) = each %$r) {
955 $name =~ y/-/./ if $isarg;
956
957 if ( 567 if (
958 $pattern =~ /\.$/ 568 $pattern =~ /\.$/
959 ? $pattern eq substr $name, 0, length $pattern 569 ? $pattern eq substr $name, 0, length $pattern
960 : $pattern eq $name 570 : $pattern eq $name
961 ) { 571 ) {
962 $name = "$urxvt::RESCLASS.$name"; 572 $name = "$urxvt::RESCLASS.$name";
963 573
964 push @TERM_EXT, $v->[0]; 574 push @{ $term->{perl_ext_3} }, $v->[0];
965 575
966 if ($v->[1] eq "boolean") { 576 if ($v->[1] eq "boolean") {
967 $term->put_option_db ($name, $flag ? "true" : "false"); 577 $term->put_option_db ($name, $flag ? "true" : "false");
968 return 1; 578 return 1;
969 } else { 579 } else {
977} 587}
978 588
979sub usage { 589sub usage {
980 my ($term, $usage_type) = @_; 590 my ($term, $usage_type) = @_;
981 591
982 $term->scan_meta; 592 $term->scan_extensions;
983 593
984 my $r = $term->{meta}{resource}; 594 my $r = $term->{meta}{resource};
985 595
986 for my $pattern (sort keys %$r) { 596 for my $pattern (sort keys %$r) {
987 my ($ext, $type, $desc) = @{ $r->{$pattern} }; 597 my ($ext, $type, $desc) = @{ $r->{$pattern} };
1023 $pkg =~ s/[^[:word:]]/_/g; 633 $pkg =~ s/[^[:word:]]/_/g;
1024 $pkg = "urxvt::ext::$pkg"; 634 $pkg = "urxvt::ext::$pkg";
1025 635
1026 verbose 3, "loading extension '$path' into package '$pkg'"; 636 verbose 3, "loading extension '$path' into package '$pkg'";
1027 637
638 (${"$pkg\::_NAME"} = $path) =~ s/^.*[\\\/]//; # hackish
639
1028 open my $fh, "<:raw", $path 640 open my $fh, "<:raw", $path
1029 or die "$path: $!"; 641 or die "$path: $!";
1030 642
1031 my $source = 643 my $source =
1032 "package $pkg; use strict; use utf8; no warnings 'utf8';\n" 644 "package $pkg; use strict 'vars'; use utf8; no warnings 'utf8';\n"
1033 . "#line 1 \"$path\"\n{\n" 645 . "#line 1 \"$path\"\n{\n"
1034 . (do { local $/; <$fh> }) 646 . (do { local $/; <$fh> })
1035 . "\n};\n1"; 647 . "\n};\n1";
1036 648
1037 eval $source 649 eval $source
1046# called by the rxvt core 658# called by the rxvt core
1047sub invoke { 659sub invoke {
1048 local $TERM = shift; 660 local $TERM = shift;
1049 my $htype = shift; 661 my $htype = shift;
1050 662
1051 if ($htype == 0) { # INIT 663 if ($htype == HOOK_INIT) {
1052 my @dirs = $TERM->perl_libdirs; 664 my @dirs = $TERM->perl_libdirs;
665
666 $TERM->scan_extensions;
1053 667
1054 my %ext_arg; 668 my %ext_arg;
1055 669
1056 { 670 {
1057 my @init = @TERM_INIT; 671 my @init = @TERM_INIT;
1060 my @pkg = @TERM_EXT; 674 my @pkg = @TERM_EXT;
1061 @TERM_EXT = (); 675 @TERM_EXT = ();
1062 $TERM->register_package ($_) for @pkg; 676 $TERM->register_package ($_) for @pkg;
1063 } 677 }
1064 678
679 for (
680 @{ delete $TERM->{perl_ext_3} },
1065 for (grep $_, map { split /,/, $TERM->resource ("perl_ext_$_") } 1, 2) { 681 grep $_, map { split /,/, $TERM->resource ("perl_ext_$_") } 1, 2
682 ) {
1066 if ($_ eq "default") { 683 if ($_ eq "default") {
1067 $ext_arg{$_} ||= [] for qw(selection option-popup selection-popup searchable-scrollback readline); 684 $ext_arg{$_} ||= [] for qw(selection option-popup selection-popup searchable-scrollback readline);
1068 } elsif (/^-(.*)$/) { 685 } elsif (/^-(.*)$/) {
1069 delete $ext_arg{$1}; 686 delete $ext_arg{$1};
1070 } elsif (/^([^<]+)<(.*)>$/) { 687 } elsif (/^([^<]+)<(.*)>$/) {
1092 709
1093 if (my $cb = $TERM->{_hook}[$htype]) { 710 if (my $cb = $TERM->{_hook}[$htype]) {
1094 verbose 10, "$HOOKNAME[$htype] (" . (join ", ", $TERM, @_) . ")" 711 verbose 10, "$HOOKNAME[$htype] (" . (join ", ", $TERM, @_) . ")"
1095 if $verbosity >= 10; 712 if $verbosity >= 10;
1096 713
714 if ($htype == HOOK_ACTION) {
715 # this hook is only sent to the extension with the name
716 # matching the first arg
717 my $pkg = shift;
718 $pkg =~ y/-/_/;
719 $pkg = "urxvt::ext::$pkg";
720
721 $cb = $cb->{$pkg}
722 or return undef; #TODO: maybe warn user?
723
724 $cb = { $pkg => $cb };
725 }
726
1097 for my $pkg (keys %$cb) { 727 for my $pkg (keys %$cb) {
1098 my $retval_ = eval { $cb->{$pkg}->($TERM->{_pkg}{$pkg}, @_) }; 728 my $retval_ = eval { $cb->{$pkg}->($TERM->{_pkg}{$pkg} || $TERM, @_) };
1099 $retval ||= $retval_; 729 $retval ||= $retval_;
1100 730
1101 if ($@) { 731 if ($@) {
1102 $TERM->ungrab; # better to lose the grab than the session 732 $TERM->ungrab; # better to lose the grab than the session
1103 warn $@; 733 warn $@;
1106 736
1107 verbose 11, "$HOOKNAME[$htype] returning <$retval>" 737 verbose 11, "$HOOKNAME[$htype] returning <$retval>"
1108 if $verbosity >= 11; 738 if $verbosity >= 11;
1109 } 739 }
1110 740
1111 if ($htype == 1) { # DESTROY 741 if ($htype == HOOK_DESTROY) {
1112 # clear package objects 742 # clear package objects
1113 %$_ = () for values %{ $TERM->{_pkg} }; 743 %$_ = () for values %{ $TERM->{_pkg} };
1114 744
1115 # clear package 745 # clear package
1116 %$TERM = (); 746 %$TERM = ();
1146 } 776 }
1147 } 777 }
1148 ($mask, @color{qw(fg bg)}, \@failed) 778 ($mask, @color{qw(fg bg)}, \@failed)
1149} 779}
1150 780
1151# urxvt::term::extension
1152
1153package urxvt::term::extension; 781package urxvt::term::extension;
1154 782
1155sub enable { 783=head2 The C<urxvt::term::extension> class
1156 my ($self, %hook) = @_;
1157 my $pkg = $self->{_pkg};
1158 784
1159 while (my ($name, $cb) = each %hook) { 785Each extension attached to a terminal object is represented by
1160 my $htype = $HOOKTYPE{uc $name}; 786a C<urxvt::term::extension> object.
1161 defined $htype
1162 or Carp::croak "unsupported hook type '$name'";
1163 787
1164 $self->set_should_invoke ($htype, +1) 788You can use these objects, which are passed to all callbacks to store any
1165 unless exists $self->{term}{_hook}[$htype]{$pkg}; 789state related to the terminal and extension instance.
1166 790
1167 $self->{term}{_hook}[$htype]{$pkg} = $cb; 791The methods (And data members) documented below can be called on extension
1168 } 792objects, in addition to call methods documented for the <urxvt::term>
1169} 793class.
1170 794
1171sub disable { 795=over 4
1172 my ($self, @hook) = @_;
1173 my $pkg = $self->{_pkg};
1174 796
1175 for my $name (@hook) { 797=item $urxvt_term = $self->{term}
1176 my $htype = $HOOKTYPE{uc $name};
1177 defined $htype
1178 or Carp::croak "unsupported hook type '$name'";
1179 798
1180 $self->set_should_invoke ($htype, -1) 799Returns the C<urxvt::term> object associated with this instance of the
1181 if delete $self->{term}{_hook}[$htype]{$pkg}; 800extension. This member I<must not> be changed in any way.
1182 } 801
1183} 802=cut
1184 803
1185our $AUTOLOAD; 804our $AUTOLOAD;
1186 805
1187sub AUTOLOAD { 806sub AUTOLOAD {
1188 $AUTOLOAD =~ /:([^:]+)$/ 807 $AUTOLOAD =~ /:([^:]+)$/
1201 820
1202sub DESTROY { 821sub DESTROY {
1203 # nop 822 # nop
1204} 823}
1205 824
1206# urxvt::destroy_hook 825# urxvt::destroy_hook (basically a cheap Guard:: implementation)
1207 826
1208sub urxvt::destroy_hook::DESTROY { 827sub urxvt::destroy_hook::DESTROY {
1209 ${$_[0]}->(); 828 ${$_[0]}->();
1210} 829}
1211 830
1212sub urxvt::destroy_hook(&) { 831sub urxvt::destroy_hook(&) {
1213 bless \shift, urxvt::destroy_hook:: 832 bless \shift, urxvt::destroy_hook::
1214} 833}
834
835=item $self->enable ($hook_name => $cb[, $hook_name => $cb..])
836
837Dynamically enable the given hooks (named without the C<on_> prefix) for
838this extension, replacing any hook previously installed via C<enable> in
839this extension.
840
841This is useful when you want to overwrite time-critical hooks only
842temporarily.
843
844To install additional callbacks for the same hook, you can use the C<on>
845method of the C<urxvt::term> class.
846
847=item $self->disable ($hook_name[, $hook_name..])
848
849Dynamically disable the given hooks.
850
851=cut
852
853sub enable {
854 my ($self, %hook) = @_;
855 my $pkg = $self->{_pkg};
856
857 while (my ($name, $cb) = each %hook) {
858 my $htype = $HOOKTYPE{uc $name};
859 defined $htype
860 or Carp::croak "unsupported hook type '$name'";
861
862 $self->set_should_invoke ($htype, +1)
863 unless exists $self->{term}{_hook}[$htype]{$pkg};
864
865 $self->{term}{_hook}[$htype]{$pkg} = $cb;
866 }
867}
868
869sub disable {
870 my ($self, @hook) = @_;
871 my $pkg = $self->{_pkg};
872
873 for my $name (@hook) {
874 my $htype = $HOOKTYPE{uc $name};
875 defined $htype
876 or Carp::croak "unsupported hook type '$name'";
877
878 $self->set_should_invoke ($htype, -1)
879 if delete $self->{term}{_hook}[$htype]{$pkg};
880 }
881}
882
883=item $guard = $self->on ($hook_name => $cb[, $hook_name => $cb..])
884
885Similar to the C<enable> enable, but installs additional callbacks for
886the given hook(s) (that is, it doesn't replace existing callbacks), and
887returns a guard object. When the guard object is destroyed the callbacks
888are disabled again.
889
890=cut
891
892sub urxvt::extension::on_disable::DESTROY {
893 my $disable = shift;
894
895 my $term = delete $disable->{""};
896
897 while (my ($htype, $id) = each %$disable) {
898 delete $term->{_hook}[$htype]{$id};
899 $term->set_should_invoke ($htype, -1);
900 }
901}
902
903sub on {
904 my ($self, %hook) = @_;
905
906 my $term = $self->{term};
907
908 my %disable = ( "" => $term );
909
910 while (my ($name, $cb) = each %hook) {
911 my $htype = $HOOKTYPE{uc $name};
912 defined $htype
913 or Carp::croak "unsupported hook type '$name'";
914
915 $term->set_should_invoke ($htype, +1);
916 $term->{_hook}[$htype]{ $disable{$htype} = $cb+0 }
917 = sub { shift; $cb->($self, @_) }; # very ugly indeed
918 }
919
920 bless \%disable, "urxvt::extension::on_disable"
921}
922
923=item $self->x_resource ($pattern)
924
925=item $self->x_resource_boolean ($pattern)
926
927These methods support an additional C<%> prefix when called on an
928extension object - see the description of these methods in the
929C<urxvt::term> class for details.
930
931=cut
932
933sub x_resource {
934 my ($self, $name) = @_;
935 $name =~ s/^%(\.|$)/$_[0]{_name}$1/;
936 $self->{term}->x_resource ($name)
937}
938
939sub x_resource_boolean {
940 my ($self, $name) = @_;
941 $name =~ s/^%(\.|$)/$_[0]{_name}$1/;
942 $self->{term}->x_resource_boolean ($name)
943}
944
945=back
946
947=cut
1215 948
1216package urxvt::anyevent; 949package urxvt::anyevent;
1217 950
1218=head2 The C<urxvt::anyevent> Class 951=head2 The C<urxvt::anyevent> Class
1219 952
1315 urxvt::verbose 6, "register package $pkg to $self"; 1048 urxvt::verbose 6, "register package $pkg to $self";
1316 1049
1317 @{"$pkg\::ISA"} = urxvt::term::extension::; 1050 @{"$pkg\::ISA"} = urxvt::term::extension::;
1318 1051
1319 my $proxy = bless { 1052 my $proxy = bless {
1320 _pkg => $pkg, 1053 _pkg => $pkg,
1054 _name => ${"$pkg\::_NAME"}, # hackish
1321 argv => $argv, 1055 argv => $argv,
1322 }, $pkg; 1056 }, $pkg;
1323 Scalar::Util::weaken ($proxy->{term} = $self); 1057 Scalar::Util::weaken ($proxy->{term} = $self);
1324 1058
1325 $self->{_pkg}{$pkg} = $proxy; 1059 $self->{_pkg}{$pkg} = $proxy;
1326 1060
1337 $ENV{URXVT_PERL_LIB}, 1071 $ENV{URXVT_PERL_LIB},
1338 "$ENV{HOME}/.urxvt/ext", 1072 "$ENV{HOME}/.urxvt/ext",
1339 "$LIBDIR/perl" 1073 "$LIBDIR/perl"
1340} 1074}
1341 1075
1342sub scan_meta { 1076# scan for available extensions and collect their metadata
1077sub scan_extensions {
1343 my ($self) = @_; 1078 my ($self) = @_;
1079
1080 return if exists $self->{meta};
1081
1344 my @libdirs = perl_libdirs $self; 1082 my @libdirs = perl_libdirs $self;
1345 1083
1346 return if $self->{meta_libdirs} eq join "\x00", @libdirs; 1084 return if $self->{meta_libdirs} eq join "\x00", @libdirs;
1347 1085
1348 my %meta; 1086 my %meta;
1349 1087
1350 $self->{meta_libdirs} = join "\x00", @libdirs; 1088 $self->{meta_libdirs} = join "\x00", @libdirs;
1351 $self->{meta} = \%meta; 1089 $self->{meta} = \%meta;
1352 1090
1091 my %ext;
1092
1093 # first gather extensions
1353 for my $dir (reverse @libdirs) { 1094 for my $dir (reverse @libdirs) {
1354 opendir my $fh, $dir 1095 opendir my $fh, $dir
1355 or next; 1096 or next;
1356 for my $ext (readdir $fh) { 1097 for my $ext (readdir $fh) {
1357 $ext ne "." 1098 $ext !~ /^\./
1358 and $ext ne ".."
1359 and open my $fh, "<", "$dir/$ext" 1099 and open my $fh, "<", "$dir/$ext"
1360 or next; 1100 or next;
1361 1101
1102 my %ext = (dir => $dir);
1103
1362 while (<$fh>) { 1104 while (<$fh>) {
1363 if (/^#:META:X_RESOURCE:(.*)/) { 1105 if (/^#:META:(?:X_)?RESOURCE:(.*)/) {
1364 my ($pattern, $type, $desc) = split /:/, $1; 1106 my ($pattern, $type, $desc) = split /:/, $1;
1365 $pattern =~ s/^%(\.|$)/$ext$1/g; # % in pattern == extension name 1107 $pattern =~ s/^%(\.|$)/$ext$1/g; # % in pattern == extension name
1366 if ($pattern =~ /[^a-zA-Z0-9\-\.]/) { 1108 if ($pattern =~ /[^a-zA-Z0-9\-\.]/) {
1367 warn "$dir/$ext: meta resource '$pattern' contains illegal characters (not alphanumeric nor . nor *)\n"; 1109 warn "$dir/$ext: meta resource '$pattern' contains illegal characters (not alphanumeric nor . nor *)\n";
1368 } else { 1110 } else {
1369 $meta{resource}{$pattern} = [$ext, $type, $desc]; 1111 $ext{resource}{$pattern} = [$ext, $type, $desc];
1370 } 1112 }
1113 } elsif (/^#:META:BINDING:(.*)/) {
1114 my ($keysym, $action) = split /:/, $1;
1115 $ext{binding}{$keysym} = $action;
1371 } elsif (/^\s*(?:#|$)/) { 1116 } elsif (/^\s*(?:#|$)/) {
1372 # skip other comments and empty lines 1117 # skip other comments and empty lines
1373 } else { 1118 } else {
1374 last; # stop parsing on first non-empty non-comment line 1119 last; # stop parsing on first non-empty non-comment line
1375 } 1120 }
1376 } 1121 }
1122
1123 $meta{$ext} = \%ext;
1377 } 1124 }
1125 }
1126
1127 # and now merge resources and bindings
1128 while (my ($k, $v) = each %ext) {
1129 #TODO: should check for extensions overriding each other
1130 %{ $meta{resource} } = (%{ $meta{resource} }, %{ $v->{resource} });
1131 %{ $meta{binding} } = (%{ $meta{binding} }, %{ $v->{binding} });
1378 } 1132 }
1379} 1133}
1380 1134
1381=item $term = new urxvt::term $envhashref, $rxvtname, [arg...] 1135=item $term = new urxvt::term $envhashref, $rxvtname, [arg...]
1382 1136
1402} 1156}
1403 1157
1404=item $term->destroy 1158=item $term->destroy
1405 1159
1406Destroy the terminal object (close the window, free resources 1160Destroy the terminal object (close the window, free resources
1407etc.). Please note that @@RXVT_NAME@@ will not exit as long as any event 1161etc.). Please note that urxvt will not exit as long as any event
1408watchers (timers, io watchers) are still active. 1162watchers (timers, io watchers) are still active.
1409 1163
1410=item $term->exec_async ($cmd[, @args]) 1164=item $term->exec_async ($cmd[, @args])
1411 1165
1412Works like the combination of the C<fork>/C<exec> builtins, which executes 1166Works like the combination of the C<fork>/C<exec> builtins, which executes
1468 1222
1469Here is a likely non-exhaustive list of resource names, not all of which 1223Here is a likely non-exhaustive list of resource names, not all of which
1470are supported in every build, please see the source file F</src/rsinc.h> 1224are supported in every build, please see the source file F</src/rsinc.h>
1471to see the actual list: 1225to see the actual list:
1472 1226
1473 answerbackstring backgroundPixmap backspace_key blendtype blurradius 1227 answerbackstring backgroundPixmap backspace_key blurradius
1474 boldFont boldItalicFont borderLess buffered chdir color cursorBlink 1228 boldFont boldItalicFont borderLess buffered chdir color cursorBlink
1475 cursorUnderline cutchars delete_key depth display_name embed ext_bwidth 1229 cursorUnderline cutchars delete_key depth display_name embed ext_bwidth
1476 fade font geometry hold iconName iconfile imFont imLocale inputMethod 1230 fade font geometry hold iconName iconfile imFont imLocale inputMethod
1477 insecure int_bwidth intensityStyles iso14755 iso14755_52 italicFont 1231 insecure int_bwidth intensityStyles iso14755 iso14755_52 italicFont
1478 jumpScroll letterSpace lineSpace loginShell mapAlert meta8 modifier 1232 jumpScroll letterSpace lineSpace loginShell mapAlert meta8 modifier
1498Returns the X-Resource for the given pattern, excluding the program or 1252Returns the X-Resource for the given pattern, excluding the program or
1499class name, i.e. C<< $term->x_resource ("boldFont") >> should return the 1253class name, i.e. C<< $term->x_resource ("boldFont") >> should return the
1500same value as used by this instance of rxvt-unicode. Returns C<undef> if no 1254same value as used by this instance of rxvt-unicode. Returns C<undef> if no
1501resource with that pattern exists. 1255resource with that pattern exists.
1502 1256
1257Extensions that define extra resource or command line arguments also need
1258to call this method to access their values.
1259
1260If the method is called on an extension object (basically, from an
1261extension), then the special prefix C<%.> will be replaced by the name of
1262the extension and a dot, and the lone string C<%> will be replaced by the
1263extension name itself. This makes it possible to code extensions so you
1264can rename them and get a new set of commandline switches and resources
1265without having to change the actual code.
1266
1503This method should only be called during the C<on_start> hook, as there is 1267This method should only be called during the C<on_start> hook, as there is
1504only one resource database per display, and later invocations might return 1268only one resource database per display, and later invocations might return
1505the wrong resources. 1269the wrong resources.
1506 1270
1507=item $value = $term->x_resource_boolean ($pattern) 1271=item $value = $term->x_resource_boolean ($pattern)
1518 my $res = &x_resource; 1282 my $res = &x_resource;
1519 1283
1520 $res =~ /^\s*(?:true|yes|on|1)\s*$/i ? 1 : defined $res && 0 1284 $res =~ /^\s*(?:true|yes|on|1)\s*$/i ? 1 : defined $res && 0
1521} 1285}
1522 1286
1523=item $success = $term->parse_keysym ($key, $octets) 1287=item $success = $term->bind_action ($key, $octets)
1524 1288
1525Adds a key binding exactly as specified via a resource. See the 1289Adds a key binding exactly as specified via a C<keysym> resource. See the
1526C<keysym> resource in the @@RXVT_NAME@@(1) manpage. 1290C<keysym> resource in the urxvt(1) manpage.
1527
1528=item $term->register_command ($keysym, $modifiermask, $string)
1529
1530Adds a key binding. This is a lower level api compared to
1531C<parse_keysym>, as it expects a parsed key description, and can be
1532used only inside either the C<on_init> hook, to add a binding, or the
1533C<on_register_command> hook, to modify a parsed binding.
1534 1291
1535=item $rend = $term->rstyle ([$new_rstyle]) 1292=item $rend = $term->rstyle ([$new_rstyle])
1536 1293
1537Return and optionally change the current rendition. Text that is output by 1294Return and optionally change the current rendition. Text that is output by
1538the terminal application will use this style. 1295the terminal application will use this style.
1718=item $term->tt_write ($octets) 1475=item $term->tt_write ($octets)
1719 1476
1720Write the octets given in C<$octets> to the tty (i.e. as program input). To 1477Write the octets given in C<$octets> to the tty (i.e. as program input). To
1721pass characters instead of octets, you should convert your strings first 1478pass characters instead of octets, you should convert your strings first
1722to the locale-specific encoding using C<< $term->locale_encode >>. 1479to the locale-specific encoding using C<< $term->locale_encode >>.
1480
1481=item $term->tt_write_user_input ($octets)
1482
1483Like C<tt_write>, but should be used when writing strings in response to
1484the user pressing a key, to invokes the additional actions requested by
1485the user for that case (C<tt_write> doesn't do that).
1486
1487The typical use case would be inside C<on_action> hooks.
1723 1488
1724=item $term->tt_paste ($octets) 1489=item $term->tt_paste ($octets)
1725 1490
1726Write the octets given in C<$octets> to the tty as a paste, converting NL to 1491Write the octets given in C<$octets> to the tty as a paste, converting NL to
1727CR and bracketing the data with control sequences if bracketed paste mode 1492CR and bracketing the data with control sequences if bracketed paste mode
1961} 1726}
1962 1727
1963sub urxvt::line::t { 1728sub urxvt::line::t {
1964 my ($self) = @_; 1729 my ($self) = @_;
1965 1730
1966 if (@_ > 1) 1731 if (@_ > 1) {
1967 {
1968 $self->{term}->ROW_t ($_, $_[1], 0, ($_ - $self->{beg}) * $self->{ncol}, $self->{ncol}) 1732 $self->{term}->ROW_t ($_, $_[1], 0, ($_ - $self->{beg}) * $self->{ncol}, $self->{ncol})
1969 for $self->{beg} .. $self->{end}; 1733 for $self->{beg} .. $self->{end};
1970 } 1734 }
1971 1735
1972 defined wantarray && 1736 defined wantarray &&
1973 substr +(join "", map $self->{term}->ROW_t ($_), $self->{beg} .. $self->{end}), 1737 substr +(join "", map $self->{term}->ROW_t ($_), $self->{beg} .. $self->{end}),
1974 0, $self->{len} 1738 0, $self->{len}
1975} 1739}
1976 1740
1977sub urxvt::line::r { 1741sub urxvt::line::r {
1978 my ($self) = @_; 1742 my ($self) = @_;
1979 1743
1980 if (@_ > 1) 1744 if (@_ > 1) {
1981 {
1982 $self->{term}->ROW_r ($_, $_[1], 0, ($_ - $self->{beg}) * $self->{ncol}, $self->{ncol}) 1745 $self->{term}->ROW_r ($_, $_[1], 0, ($_ - $self->{beg}) * $self->{ncol}, $self->{ncol})
1983 for $self->{beg} .. $self->{end}; 1746 for $self->{beg} .. $self->{end};
1984 } 1747 }
1985 1748
1986 if (defined wantarray) { 1749 if (defined wantarray) {
1987 my $rend = [ 1750 my $rend = [
1988 map @{ $self->{term}->ROW_r ($_) }, $self->{beg} .. $self->{end} 1751 map @{ $self->{term}->ROW_r ($_) }, $self->{beg} .. $self->{end}
1989 ]; 1752 ];

Diff Legend

Removed lines
+ Added lines
< Changed lines
> Changed lines