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.203 by sf-exg, Fri Dec 2 09:03:43 2011 UTC vs.
Revision 1.232 by sf-exg, Fri May 2 20:33:56 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<< ->register_keysym_action >> method.
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;
766our $TERM; 375our $TERM;
767our @TERM_INIT; 376our @TERM_INIT; # should go, prevents async I/O etc.
768our @TERM_EXT; 377our @TERM_EXT; # should go, prevents async I/O etc.
769our @HOOKNAME; 378our @HOOKNAME;
770our %HOOKTYPE = map +($HOOKNAME[$_] => $_), 0..$#HOOKNAME; 379our %HOOKTYPE = map +($HOOKNAME[$_] => $_), 0..$#HOOKNAME;
771our %OPTION; 380our %OPTION;
772 381
773our $LIBDIR; 382our $LIBDIR;
943 }; 552 };
944} 553}
945 554
946no warnings 'utf8'; 555no warnings 'utf8';
947 556
557sub parse_resource {
558 my ($term, $name, $isarg, $longopt, $flag, $value) = @_;
559
560 $name =~ y/-/./ if $isarg;
561
562 $term->scan_meta;
563
564 my $r = $term->{meta}{resource};
565 keys %$r; # reset iterator
566 while (my ($pattern, $v) = each %$r) {
567 if (
568 $pattern =~ /\.$/
569 ? $pattern eq substr $name, 0, length $pattern
570 : $pattern eq $name
571 ) {
572 $name = "$urxvt::RESCLASS.$name";
573
574 push @{ $term->{perl_ext_3} }, $v->[0];
575
576 if ($v->[1] eq "boolean") {
577 $term->put_option_db ($name, $flag ? "true" : "false");
578 return 1;
579 } else {
580 $term->put_option_db ($name, $value);
581 return 1 + 2;
582 }
583 }
584 }
585
586 0
587}
588
589sub usage {
590 my ($term, $usage_type) = @_;
591
592 $term->scan_meta;
593
594 my $r = $term->{meta}{resource};
595
596 for my $pattern (sort keys %$r) {
597 my ($ext, $type, $desc) = @{ $r->{$pattern} };
598
599 $desc .= " (-pe $ext)";
600
601 if ($usage_type == 1) {
602 $pattern =~ y/./-/;
603 $pattern =~ s/-$/-.../g;
604
605 if ($type eq "boolean") {
606 urxvt::log sprintf " -%-30s %s\n", "/+$pattern", $desc;
607 } else {
608 urxvt::log sprintf " -%-30s %s\n", "$pattern $type", $desc;
609 }
610 } else {
611 $pattern =~ s/\.$/.*/g;
612 urxvt::log sprintf " %-31s %s\n", "$pattern:", $type;
613 }
614 }
615}
616
948my $verbosity = $ENV{URXVT_PERL_VERBOSITY}; 617my $verbosity = $ENV{URXVT_PERL_VERBOSITY};
949 618
950sub verbose { 619sub verbose {
951 my ($level, $msg) = @_; 620 my ($level, $msg) = @_;
952 warn "$msg\n" if $level <= $verbosity; 621 warn "$msg\n" if $level <= $verbosity;
964 $pkg =~ s/[^[:word:]]/_/g; 633 $pkg =~ s/[^[:word:]]/_/g;
965 $pkg = "urxvt::ext::$pkg"; 634 $pkg = "urxvt::ext::$pkg";
966 635
967 verbose 3, "loading extension '$path' into package '$pkg'"; 636 verbose 3, "loading extension '$path' into package '$pkg'";
968 637
638 (${"$pkg\::_NAME"} = $path) =~ s/^.*[\\\/]//; # hackish
639
969 open my $fh, "<:raw", $path 640 open my $fh, "<:raw", $path
970 or die "$path: $!"; 641 or die "$path: $!";
971 642
972 my $source = 643 my $source =
973 "package $pkg; use strict; use utf8; no warnings 'utf8';\n" 644 "package $pkg; use strict 'vars'; use utf8; no warnings 'utf8';\n"
974 . "#line 1 \"$path\"\n{\n" 645 . "#line 1 \"$path\"\n{\n"
975 . (do { local $/; <$fh> }) 646 . (do { local $/; <$fh> })
976 . "\n};\n1"; 647 . "\n};\n1";
977 648
978 eval $source 649 eval $source
987# called by the rxvt core 658# called by the rxvt core
988sub invoke { 659sub invoke {
989 local $TERM = shift; 660 local $TERM = shift;
990 my $htype = shift; 661 my $htype = shift;
991 662
992 if ($htype == 0) { # INIT 663 if ($htype == HOOK_INIT) {
993 my @dirs = ((split /:/, $TERM->resource ("perl_lib")), "$ENV{HOME}/.urxvt/ext", "$LIBDIR/perl"); 664 my @dirs = $TERM->perl_libdirs;
994 665
995 my %ext_arg; 666 my %ext_arg;
996 667
997 { 668 {
998 my @init = @TERM_INIT; 669 my @init = @TERM_INIT;
1001 my @pkg = @TERM_EXT; 672 my @pkg = @TERM_EXT;
1002 @TERM_EXT = (); 673 @TERM_EXT = ();
1003 $TERM->register_package ($_) for @pkg; 674 $TERM->register_package ($_) for @pkg;
1004 } 675 }
1005 676
677 for (
678 @{ delete $TERM->{perl_ext_3} },
1006 for (grep $_, map { split /,/, $TERM->resource ("perl_ext_$_") } 1, 2) { 679 grep $_, map { split /,/, $TERM->resource ("perl_ext_$_") } 1, 2
680 ) {
1007 if ($_ eq "default") { 681 if ($_ eq "default") {
1008 $ext_arg{$_} ||= [] for qw(selection option-popup selection-popup searchable-scrollback readline); 682 $ext_arg{$_} ||= [] for qw(selection option-popup selection-popup searchable-scrollback readline);
1009 } elsif (/^-(.*)$/) { 683 } elsif (/^-(.*)$/) {
1010 delete $ext_arg{$1}; 684 delete $ext_arg{$1};
1011 } elsif (/^([^<]+)<(.*)>$/) { 685 } elsif (/^([^<]+)<(.*)>$/) {
1033 707
1034 if (my $cb = $TERM->{_hook}[$htype]) { 708 if (my $cb = $TERM->{_hook}[$htype]) {
1035 verbose 10, "$HOOKNAME[$htype] (" . (join ", ", $TERM, @_) . ")" 709 verbose 10, "$HOOKNAME[$htype] (" . (join ", ", $TERM, @_) . ")"
1036 if $verbosity >= 10; 710 if $verbosity >= 10;
1037 711
1038 for my $pkg (keys %$cb) { 712 for my $pkg (
713 # this hook is only sent to the extension with the name
714 # matching the first arg
715 $htype == HOOK_KEYBOARD_DISPATCH
716 ? exists $cb->{"urxvt::ext::$_[0]"} ? "urxvt::ext::" . shift : return undef
717 : keys %$cb
718 ) {
1039 my $retval_ = eval { $cb->{$pkg}->($TERM->{_pkg}{$pkg}, @_) }; 719 my $retval_ = eval { $cb->{$pkg}->($TERM->{_pkg}{$pkg} || $TERM, @_) };
1040 $retval ||= $retval_; 720 $retval ||= $retval_;
1041 721
1042 if ($@) { 722 if ($@) {
1043 $TERM->ungrab; # better to lose the grab than the session 723 $TERM->ungrab; # better to lose the grab than the session
1044 warn $@; 724 warn $@;
1047 727
1048 verbose 11, "$HOOKNAME[$htype] returning <$retval>" 728 verbose 11, "$HOOKNAME[$htype] returning <$retval>"
1049 if $verbosity >= 11; 729 if $verbosity >= 11;
1050 } 730 }
1051 731
1052 if ($htype == 1) { # DESTROY 732 if ($htype == HOOK_DESTROY) {
1053 # clear package objects 733 # clear package objects
1054 %$_ = () for values %{ $TERM->{_pkg} }; 734 %$_ = () for values %{ $TERM->{_pkg} };
1055 735
1056 # clear package 736 # clear package
1057 %$TERM = (); 737 %$TERM = ();
1087 } 767 }
1088 } 768 }
1089 ($mask, @color{qw(fg bg)}, \@failed) 769 ($mask, @color{qw(fg bg)}, \@failed)
1090} 770}
1091 771
1092# urxvt::term::extension
1093
1094package urxvt::term::extension; 772package urxvt::term::extension;
1095 773
1096sub enable { 774=head2 The C<urxvt::term::extension> class
1097 my ($self, %hook) = @_;
1098 my $pkg = $self->{_pkg};
1099 775
1100 while (my ($name, $cb) = each %hook) { 776Each extension attached to a terminal object is represented by
1101 my $htype = $HOOKTYPE{uc $name}; 777a C<urxvt::term::extension> object.
1102 defined $htype
1103 or Carp::croak "unsupported hook type '$name'";
1104 778
1105 $self->set_should_invoke ($htype, +1) 779You can use these objects, which are passed to all callbacks to store any
1106 unless exists $self->{term}{_hook}[$htype]{$pkg}; 780state related to the terminal and extension instance.
1107 781
1108 $self->{term}{_hook}[$htype]{$pkg} = $cb; 782The methods (And data members) documented below can be called on extension
1109 } 783objects, in addition to call methods documented for the <urxvt::term>
1110} 784class.
1111 785
1112sub disable { 786=over 4
1113 my ($self, @hook) = @_;
1114 my $pkg = $self->{_pkg};
1115 787
1116 for my $name (@hook) { 788=item $urxvt_term = $self->{term}
1117 my $htype = $HOOKTYPE{uc $name};
1118 defined $htype
1119 or Carp::croak "unsupported hook type '$name'";
1120 789
1121 $self->set_should_invoke ($htype, -1) 790Returns the C<urxvt::term> object associated with this instance of the
1122 if delete $self->{term}{_hook}[$htype]{$pkg}; 791extension. This member I<must not> be changed in any way.
1123 } 792
1124} 793=cut
1125 794
1126our $AUTOLOAD; 795our $AUTOLOAD;
1127 796
1128sub AUTOLOAD { 797sub AUTOLOAD {
1129 $AUTOLOAD =~ /:([^:]+)$/ 798 $AUTOLOAD =~ /:([^:]+)$/
1142 811
1143sub DESTROY { 812sub DESTROY {
1144 # nop 813 # nop
1145} 814}
1146 815
1147# urxvt::destroy_hook 816# urxvt::destroy_hook (basically a cheap Guard:: implementation)
1148 817
1149sub urxvt::destroy_hook::DESTROY { 818sub urxvt::destroy_hook::DESTROY {
1150 ${$_[0]}->(); 819 ${$_[0]}->();
1151} 820}
1152 821
1153sub urxvt::destroy_hook(&) { 822sub urxvt::destroy_hook(&) {
1154 bless \shift, urxvt::destroy_hook:: 823 bless \shift, urxvt::destroy_hook::
1155} 824}
825
826=item $self->enable ($hook_name => $cb[, $hook_name => $cb..])
827
828Dynamically enable the given hooks (named without the C<on_> prefix) for
829this extension, replacing any hook previously installed via C<enable> in
830this extension.
831
832This is useful when you want to overwrite time-critical hooks only
833temporarily.
834
835To install additional callbacks for the same hook, you can use the C<on>
836method of the C<urxvt::term> class.
837
838=item $self->disable ($hook_name[, $hook_name..])
839
840Dynamically disable the given hooks.
841
842=cut
843
844sub enable {
845 my ($self, %hook) = @_;
846 my $pkg = $self->{_pkg};
847
848 while (my ($name, $cb) = each %hook) {
849 my $htype = $HOOKTYPE{uc $name};
850 defined $htype
851 or Carp::croak "unsupported hook type '$name'";
852
853 $self->set_should_invoke ($htype, +1)
854 unless exists $self->{term}{_hook}[$htype]{$pkg};
855
856 $self->{term}{_hook}[$htype]{$pkg} = $cb;
857 }
858}
859
860sub disable {
861 my ($self, @hook) = @_;
862 my $pkg = $self->{_pkg};
863
864 for my $name (@hook) {
865 my $htype = $HOOKTYPE{uc $name};
866 defined $htype
867 or Carp::croak "unsupported hook type '$name'";
868
869 $self->set_should_invoke ($htype, -1)
870 if delete $self->{term}{_hook}[$htype]{$pkg};
871 }
872}
873
874=item $guard = $self->on ($hook_name => $cb[, $hook_name => $cb..])
875
876Similar to the C<enable> enable, but installs additional callbacks for
877the given hook(s) (that is, it doesn't replace existing callbacks), and
878returns a guard object. When the guard object is destroyed the callbacks
879are disabled again.
880
881=cut
882
883sub urxvt::extension::on_disable::DESTROY {
884 my $disable = shift;
885
886 my $term = delete $disable->{""};
887
888 while (my ($htype, $id) = each %$disable) {
889 delete $term->{_hook}[$htype]{$id};
890 $term->set_should_invoke ($htype, -1);
891 }
892}
893
894sub on {
895 my ($self, %hook) = @_;
896
897 my $term = $self->{term};
898
899 my %disable = ( "" => $term );
900
901 while (my ($name, $cb) = each %hook) {
902 my $htype = $HOOKTYPE{uc $name};
903 defined $htype
904 or Carp::croak "unsupported hook type '$name'";
905
906 $term->set_should_invoke ($htype, +1);
907 $term->{_hook}[$htype]{ $disable{$htype} = $cb+0 }
908 = sub { shift; $cb->($self, @_) }; # very ugly indeed
909 }
910
911 bless \%disable, "urxvt::extension::on_disable"
912}
913
914=item $self->x_resource ($pattern)
915
916=item $self->x_resource_boolean ($pattern)
917
918These methods support an additional C<%> prefix when called on an
919extension object - see the description of these methods in the
920C<urxvt::term> class for details.
921
922=cut
923
924sub x_resource {
925 my ($self, $name) = @_;
926 $name =~ s/^%(\.|$)/$_[0]{_name}$1/;
927 $self->{term}->x_resource ($name)
928}
929
930sub x_resource_boolean {
931 my ($self, $name) = @_;
932 $name =~ s/^%(\.|$)/$_[0]{_name}$1/;
933 $self->{term}->x_resource_boolean ($name)
934}
935
936=back
937
938=cut
1156 939
1157package urxvt::anyevent; 940package urxvt::anyevent;
1158 941
1159=head2 The C<urxvt::anyevent> Class 942=head2 The C<urxvt::anyevent> Class
1160 943
1161The sole purpose of this class is to deliver an interface to the 944The sole purpose of this class is to deliver an interface to the
1162C<AnyEvent> module - any module using it will work inside urxvt without 945C<AnyEvent> module - any module using it will work inside urxvt without
1163further programming. The only exception is that you cannot wait on 946further programming. The only exception is that you cannot wait on
1164condition variables, but non-blocking condvar use is ok. What this means 947condition variables, but non-blocking condvar use is ok.
1165is that you cannot use blocking APIs, but the non-blocking variant should 948
1166work. 949In practical terms this means is that you cannot use blocking APIs, but
950the non-blocking variant should work.
1167 951
1168=cut 952=cut
1169 953
1170our $VERSION = '5.23'; 954our $VERSION = '5.23';
1171 955
1255 urxvt::verbose 6, "register package $pkg to $self"; 1039 urxvt::verbose 6, "register package $pkg to $self";
1256 1040
1257 @{"$pkg\::ISA"} = urxvt::term::extension::; 1041 @{"$pkg\::ISA"} = urxvt::term::extension::;
1258 1042
1259 my $proxy = bless { 1043 my $proxy = bless {
1260 _pkg => $pkg, 1044 _pkg => $pkg,
1045 _name => ${"$pkg\::_NAME"}, # hackish
1261 argv => $argv, 1046 argv => $argv,
1262 }, $pkg; 1047 }, $pkg;
1263 Scalar::Util::weaken ($proxy->{term} = $self); 1048 Scalar::Util::weaken ($proxy->{term} = $self);
1264 1049
1265 $self->{_pkg}{$pkg} = $proxy; 1050 $self->{_pkg}{$pkg} = $proxy;
1266 1051
1269 $proxy->enable ($name => $ref); 1054 $proxy->enable ($name => $ref);
1270 } 1055 }
1271 } 1056 }
1272} 1057}
1273 1058
1059sub perl_libdirs {
1060 map { split /:/ }
1061 $_[0]->resource ("perl_lib"),
1062 $ENV{URXVT_PERL_LIB},
1063 "$ENV{HOME}/.urxvt/ext",
1064 "$LIBDIR/perl"
1065}
1066
1067sub scan_meta {
1068 my ($self) = @_;
1069 my @libdirs = perl_libdirs $self;
1070
1071 return if $self->{meta_libdirs} eq join "\x00", @libdirs;
1072
1073 my %meta;
1074
1075 $self->{meta_libdirs} = join "\x00", @libdirs;
1076 $self->{meta} = \%meta;
1077
1078 for my $dir (reverse @libdirs) {
1079 opendir my $fh, $dir
1080 or next;
1081 for my $ext (readdir $fh) {
1082 $ext !~ /^\./
1083 and open my $fh, "<", "$dir/$ext"
1084 or next;
1085
1086 while (<$fh>) {
1087 if (/^#:META:X_RESOURCE:(.*)/) {
1088 my ($pattern, $type, $desc) = split /:/, $1;
1089 $pattern =~ s/^%(\.|$)/$ext$1/g; # % in pattern == extension name
1090 if ($pattern =~ /[^a-zA-Z0-9\-\.]/) {
1091 warn "$dir/$ext: meta resource '$pattern' contains illegal characters (not alphanumeric nor . nor *)\n";
1092 } else {
1093 $meta{resource}{$pattern} = [$ext, $type, $desc];
1094 }
1095 } elsif (/^\s*(?:#|$)/) {
1096 # skip other comments and empty lines
1097 } else {
1098 last; # stop parsing on first non-empty non-comment line
1099 }
1100 }
1101 }
1102 }
1103}
1104
1274=item $term = new urxvt::term $envhashref, $rxvtname, [arg...] 1105=item $term = new urxvt::term $envhashref, $rxvtname, [arg...]
1275 1106
1276Creates a new terminal, very similar as if you had started it with system 1107Creates a new terminal, very similar as if you had started it with system
1277C<$rxvtname, arg...>. C<$envhashref> must be a reference to a C<%ENV>-like 1108C<$rxvtname, arg...>. C<$envhashref> must be a reference to a C<%ENV>-like
1278hash which defines the environment of the new terminal. 1109hash which defines the environment of the new terminal.
1295} 1126}
1296 1127
1297=item $term->destroy 1128=item $term->destroy
1298 1129
1299Destroy the terminal object (close the window, free resources 1130Destroy the terminal object (close the window, free resources
1300etc.). Please note that @@RXVT_NAME@@ will not exit as long as any event 1131etc.). Please note that urxvt will not exit as long as any event
1301watchers (timers, io watchers) are still active. 1132watchers (timers, io watchers) are still active.
1302 1133
1303=item $term->exec_async ($cmd[, @args]) 1134=item $term->exec_async ($cmd[, @args])
1304 1135
1305Works like the combination of the C<fork>/C<exec> builtins, which executes 1136Works like the combination of the C<fork>/C<exec> builtins, which executes
1361 1192
1362Here is a likely non-exhaustive list of resource names, not all of which 1193Here is a likely non-exhaustive list of resource names, not all of which
1363are supported in every build, please see the source file F</src/rsinc.h> 1194are supported in every build, please see the source file F</src/rsinc.h>
1364to see the actual list: 1195to see the actual list:
1365 1196
1366 answerbackstring backgroundPixmap backspace_key blendtype blurradius 1197 answerbackstring backgroundPixmap backspace_key blurradius
1367 boldFont boldItalicFont borderLess buffered chdir color cursorBlink 1198 boldFont boldItalicFont borderLess buffered chdir color cursorBlink
1368 cursorUnderline cutchars delete_key depth display_name embed ext_bwidth 1199 cursorUnderline cutchars delete_key depth display_name embed ext_bwidth
1369 fade font geometry hold iconName iconfile imFont imLocale inputMethod 1200 fade font geometry hold iconName iconfile imFont imLocale inputMethod
1370 insecure int_bwidth intensityStyles iso14755 iso14755_52 italicFont 1201 insecure int_bwidth intensityStyles iso14755 iso14755_52 italicFont
1371 jumpScroll letterSpace lineSpace loginShell mapAlert meta8 modifier 1202 jumpScroll letterSpace lineSpace loginShell mapAlert meta8 modifier
1391Returns the X-Resource for the given pattern, excluding the program or 1222Returns the X-Resource for the given pattern, excluding the program or
1392class name, i.e. C<< $term->x_resource ("boldFont") >> should return the 1223class name, i.e. C<< $term->x_resource ("boldFont") >> should return the
1393same value as used by this instance of rxvt-unicode. Returns C<undef> if no 1224same value as used by this instance of rxvt-unicode. Returns C<undef> if no
1394resource with that pattern exists. 1225resource with that pattern exists.
1395 1226
1227Extensions that define extra resource or command line arguments also need
1228to call this method to access their values.
1229
1230If the method is called on an extension object (basically, from an
1231extension), then the special prefix C<%.> will be replaced by the name of
1232the extension and a dot, and the lone string C<%> will be replaced by the
1233extension name itself. This makes it possible to code extensions so you
1234can rename them and get a new set of commandline switches and resources
1235without having to change the actual code.
1236
1396This method should only be called during the C<on_start> hook, as there is 1237This method should only be called during the C<on_start> hook, as there is
1397only one resource database per display, and later invocations might return 1238only one resource database per display, and later invocations might return
1398the wrong resources. 1239the wrong resources.
1399 1240
1241=item $value = $term->x_resource_boolean ($pattern)
1242
1243Like C<x_resource>, above, but interprets the string value as a boolean
1244and returns C<1> for true values, C<0> for false values and C<undef> if
1245the resource or option isn't specified.
1246
1247You should always use this method to parse boolean resources.
1248
1249=cut
1250
1251sub x_resource_boolean {
1252 my $res = &x_resource;
1253
1254 $res =~ /^\s*(?:true|yes|on|1)\s*$/i ? 1 : defined $res && 0
1255}
1256
1400=item $success = $term->parse_keysym ($key, $octets) 1257=item $success = $term->parse_keysym ($key, $octets)
1401 1258
1402Adds a key binding exactly as specified via a resource. See the 1259Adds a key binding exactly as specified via a resource. See the
1403C<keysym> resource in the @@RXVT_NAME@@(1) manpage. 1260C<keysym> resource in the urxvt(1) manpage.
1404
1405=item $term->register_command ($keysym, $modifiermask, $string)
1406
1407Adds a key binding. This is a lower level api compared to
1408C<parse_keysym>, as it expects a parsed key description, and can be
1409used only inside either the C<on_init> hook, to add a binding, or the
1410C<on_register_command> hook, to modify a parsed binding.
1411 1261
1412=item $rend = $term->rstyle ([$new_rstyle]) 1262=item $rend = $term->rstyle ([$new_rstyle])
1413 1263
1414Return and optionally change the current rendition. Text that is output by 1264Return and optionally change the current rendition. Text that is output by
1415the terminal application will use this style. 1265the terminal application will use this style.
1628 1478
1629Adds the specified events to the vt event mask. Useful e.g. when you want 1479Adds the specified events to the vt event mask. Useful e.g. when you want
1630to receive pointer events all the times: 1480to receive pointer events all the times:
1631 1481
1632 $term->vt_emask_add (urxvt::PointerMotionMask); 1482 $term->vt_emask_add (urxvt::PointerMotionMask);
1483
1484=item $term->set_urgency ($set)
1485
1486Enable/disable the urgency hint on the toplevel window.
1633 1487
1634=item $term->focus_in 1488=item $term->focus_in
1635 1489
1636=item $term->focus_out 1490=item $term->focus_out
1637 1491
1834} 1688}
1835 1689
1836sub urxvt::line::t { 1690sub urxvt::line::t {
1837 my ($self) = @_; 1691 my ($self) = @_;
1838 1692
1839 if (@_ > 1) 1693 if (@_ > 1) {
1840 {
1841 $self->{term}->ROW_t ($_, $_[1], 0, ($_ - $self->{beg}) * $self->{ncol}, $self->{ncol}) 1694 $self->{term}->ROW_t ($_, $_[1], 0, ($_ - $self->{beg}) * $self->{ncol}, $self->{ncol})
1842 for $self->{beg} .. $self->{end}; 1695 for $self->{beg} .. $self->{end};
1843 } 1696 }
1844 1697
1845 defined wantarray && 1698 defined wantarray &&
1846 substr +(join "", map $self->{term}->ROW_t ($_), $self->{beg} .. $self->{end}), 1699 substr +(join "", map $self->{term}->ROW_t ($_), $self->{beg} .. $self->{end}),
1847 0, $self->{len} 1700 0, $self->{len}
1848} 1701}
1849 1702
1850sub urxvt::line::r { 1703sub urxvt::line::r {
1851 my ($self) = @_; 1704 my ($self) = @_;
1852 1705
1853 if (@_ > 1) 1706 if (@_ > 1) {
1854 {
1855 $self->{term}->ROW_r ($_, $_[1], 0, ($_ - $self->{beg}) * $self->{ncol}, $self->{ncol}) 1707 $self->{term}->ROW_r ($_, $_[1], 0, ($_ - $self->{beg}) * $self->{ncol}, $self->{ncol})
1856 for $self->{beg} .. $self->{end}; 1708 for $self->{beg} .. $self->{end};
1857 } 1709 }
1858 1710
1859 if (defined wantarray) { 1711 if (defined wantarray) {
1860 my $rend = [ 1712 my $rend = [
1861 map @{ $self->{term}->ROW_r ($_) }, $self->{beg} .. $self->{end} 1713 map @{ $self->{term}->ROW_r ($_) }, $self->{beg} .. $self->{end}
1862 ]; 1714 ];

Diff Legend

Removed lines
+ Added lines
< Changed lines
> Changed lines