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.197 by sf-tpope, Fri Aug 19 23:08:35 2011 UTC vs.
Revision 1.230 by root, Sat Apr 26 20:51:12 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=back
406 50
407=head1 API DOCUMENTATION 51=head1 API DOCUMENTATION
408 52
409=head2 General API Considerations 53=head2 General API Considerations
410 54
437 81
438=item $octets 82=item $octets
439 83
440Either binary data or - more common - a text string encoded in a 84Either binary data or - more common - a text string encoded in a
441locale-specific way. 85locale-specific way.
86
87=item $keysym
88
89an integer that is a valid X11 keysym code. You can convert a string
90into a keysym and viceversa by using C<XStringToKeysym> and
91C<XKeysymToString>.
442 92
443=back 93=back
444 94
445=head2 Extension Objects 95=head2 Extension Objects
446 96
453internal use. 103internal use.
454 104
455Although 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
456C<urxvt::term> class on this object. 106C<urxvt::term> class on this object.
457 107
458It has the following methods and data members: 108Additional methods only supported for extension objects are described in
459 109the C<urxvt::extension> section below.
460=over 4
461
462=item $urxvt_term = $self->{term}
463
464Returns the C<urxvt::term> object associated with this instance of the
465extension. This member I<must not> be changed in any way.
466
467=item $self->enable ($hook_name => $cb, [$hook_name => $cb..])
468
469Dynamically enable the given hooks (named without the C<on_> prefix) for
470this extension, replacing any previous hook. This is useful when you want
471to overwrite time-critical hooks only temporarily.
472
473=item $self->disable ($hook_name[, $hook_name..])
474
475Dynamically disable the given hooks.
476
477=back
478 110
479=head2 Hooks 111=head2 Hooks
480 112
481The following subroutines can be declared in extension files, and will be 113The following subroutines can be declared in extension files, and will be
482called whenever the relevant event happens. 114called whenever the relevant event happens.
649 281
650=item on_refresh_end $term 282=item on_refresh_end $term
651 283
652Called just after the screen gets redrawn. See C<on_refresh_begin>. 284Called just after the screen gets redrawn. See C<on_refresh_begin>.
653 285
654=item on_user_command $term, $string 286=item on_user_command $term, $string *DEPRECATED*
655 287
656Called whenever a user-configured event is being activated (e.g. via 288Called whenever a user-configured event is being activated (e.g. via
657a 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>
658resource in the @@RXVT_NAME@@(1) manpage). 290resource in the urxvt(1) manpage).
659 291
660The 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
661slightly in the future. 293preference to the C<< ->register_keysym_action >> method.
294
295=item on_register_command $term, $keysym, $modifiermask, $string
296
297Called after parsing a keysym resource but before registering the
298associated binding. If this hook returns a true value the binding
299is not registered. It can be used to modify a binding by calling
300C<register_command>.
662 301
663=item on_resize_all_windows $term, $new_width, $new_height 302=item on_resize_all_windows $term, $new_width, $new_height
664 303
665Called just after the new window size has been calculated, but before 304Called just after the new window size has been calculated, but before
666windows are actually being resized or hints are being set. If this hook 305windows are actually being resized or hints are being set. If this hook
667returns TRUE, setting of the window hints is being skipped. 306returns a true value, setting of the window hints is being skipped.
668 307
669=item on_x_event $term, $event 308=item on_x_event $term, $event
670 309
671Called on every X event received on the vt window (and possibly other 310Called on every X event received on the vt window (and possibly other
672windows). Should only be used as a last resort. Most event structure 311windows). Should only be used as a last resort. Most event structure
734=cut 373=cut
735 374
736package urxvt; 375package urxvt;
737 376
738use utf8; 377use utf8;
739use strict; 378use strict 'vars';
740use Carp (); 379use Carp ();
741use Scalar::Util (); 380use Scalar::Util ();
742use List::Util (); 381use List::Util ();
743 382
744our $VERSION = 1; 383our $VERSION = 1;
745our $TERM; 384our $TERM;
746our @TERM_INIT; 385our @TERM_INIT; # should go, prevents async I/O etc.
747our @TERM_EXT; 386our @TERM_EXT; # should go, prevents async I/O etc.
748our @HOOKNAME; 387our @HOOKNAME;
749our %HOOKTYPE = map +($HOOKNAME[$_] => $_), 0..$#HOOKNAME; 388our %HOOKTYPE = map +($HOOKNAME[$_] => $_), 0..$#HOOKNAME;
750our %OPTION; 389our %OPTION;
751 390
752our $LIBDIR; 391our $LIBDIR;
922 }; 561 };
923} 562}
924 563
925no warnings 'utf8'; 564no warnings 'utf8';
926 565
566sub parse_resource {
567 my ($term, $name, $isarg, $longopt, $flag, $value) = @_;
568
569 $name =~ y/-/./ if $isarg;
570
571 $term->scan_meta;
572
573 my $r = $term->{meta}{resource};
574 keys %$r; # reset iterator
575 while (my ($pattern, $v) = each %$r) {
576 if (
577 $pattern =~ /\.$/
578 ? $pattern eq substr $name, 0, length $pattern
579 : $pattern eq $name
580 ) {
581 $name = "$urxvt::RESCLASS.$name";
582
583 push @{ $term->{perl_ext_3} }, $v->[0];
584
585 if ($v->[1] eq "boolean") {
586 $term->put_option_db ($name, $flag ? "true" : "false");
587 return 1;
588 } else {
589 $term->put_option_db ($name, $value);
590 return 1 + 2;
591 }
592 }
593 }
594
595 0
596}
597
598sub usage {
599 my ($term, $usage_type) = @_;
600
601 $term->scan_meta;
602
603 my $r = $term->{meta}{resource};
604
605 for my $pattern (sort keys %$r) {
606 my ($ext, $type, $desc) = @{ $r->{$pattern} };
607
608 $desc .= " (-pe $ext)";
609
610 if ($usage_type == 1) {
611 $pattern =~ y/./-/;
612 $pattern =~ s/-$/-.../g;
613
614 if ($type eq "boolean") {
615 urxvt::log sprintf " -%-30s %s\n", "/+$pattern", $desc;
616 } else {
617 urxvt::log sprintf " -%-30s %s\n", "$pattern $type", $desc;
618 }
619 } else {
620 $pattern =~ s/\.$/.*/g;
621 urxvt::log sprintf " %-31s %s\n", "$pattern:", $type;
622 }
623 }
624}
625
927my $verbosity = $ENV{URXVT_PERL_VERBOSITY}; 626my $verbosity = $ENV{URXVT_PERL_VERBOSITY};
928 627
929sub verbose { 628sub verbose {
930 my ($level, $msg) = @_; 629 my ($level, $msg) = @_;
931 warn "$msg\n" if $level <= $verbosity; 630 warn "$msg\n" if $level <= $verbosity;
943 $pkg =~ s/[^[:word:]]/_/g; 642 $pkg =~ s/[^[:word:]]/_/g;
944 $pkg = "urxvt::ext::$pkg"; 643 $pkg = "urxvt::ext::$pkg";
945 644
946 verbose 3, "loading extension '$path' into package '$pkg'"; 645 verbose 3, "loading extension '$path' into package '$pkg'";
947 646
647 (${"$pkg\::_NAME"} = $path) =~ s/^.*[\\\/]//; # hackish
648
948 open my $fh, "<:raw", $path 649 open my $fh, "<:raw", $path
949 or die "$path: $!"; 650 or die "$path: $!";
950 651
951 my $source = 652 my $source =
952 "package $pkg; use strict; use utf8; no warnings 'utf8';\n" 653 "package $pkg; use strict 'vars'; use utf8; no warnings 'utf8';\n"
953 . "#line 1 \"$path\"\n{\n" 654 . "#line 1 \"$path\"\n{\n"
954 . (do { local $/; <$fh> }) 655 . (do { local $/; <$fh> })
955 . "\n};\n1"; 656 . "\n};\n1";
956 657
957 eval $source 658 eval $source
966# called by the rxvt core 667# called by the rxvt core
967sub invoke { 668sub invoke {
968 local $TERM = shift; 669 local $TERM = shift;
969 my $htype = shift; 670 my $htype = shift;
970 671
971 if ($htype == 0) { # INIT 672 if ($htype == HOOK_INIT) {
972 my @dirs = ((split /:/, $TERM->resource ("perl_lib")), "$LIBDIR/perl"); 673 my @dirs = $TERM->perl_libdirs;
973 674
974 my %ext_arg; 675 my %ext_arg;
975 676
976 { 677 {
977 my @init = @TERM_INIT; 678 my @init = @TERM_INIT;
980 my @pkg = @TERM_EXT; 681 my @pkg = @TERM_EXT;
981 @TERM_EXT = (); 682 @TERM_EXT = ();
982 $TERM->register_package ($_) for @pkg; 683 $TERM->register_package ($_) for @pkg;
983 } 684 }
984 685
686 for (
687 @{ delete $TERM->{perl_ext_3} },
985 for (grep $_, map { split /,/, $TERM->resource ("perl_ext_$_") } 1, 2) { 688 grep $_, map { split /,/, $TERM->resource ("perl_ext_$_") } 1, 2
689 ) {
986 if ($_ eq "default") { 690 if ($_ eq "default") {
987 $ext_arg{$_} ||= [] for qw(selection option-popup selection-popup searchable-scrollback readline); 691 $ext_arg{$_} ||= [] for qw(selection option-popup selection-popup searchable-scrollback readline);
988 } elsif (/^-(.*)$/) { 692 } elsif (/^-(.*)$/) {
989 delete $ext_arg{$1}; 693 delete $ext_arg{$1};
990 } elsif (/^([^<]+)<(.*)>$/) { 694 } elsif (/^([^<]+)<(.*)>$/) {
1012 716
1013 if (my $cb = $TERM->{_hook}[$htype]) { 717 if (my $cb = $TERM->{_hook}[$htype]) {
1014 verbose 10, "$HOOKNAME[$htype] (" . (join ", ", $TERM, @_) . ")" 718 verbose 10, "$HOOKNAME[$htype] (" . (join ", ", $TERM, @_) . ")"
1015 if $verbosity >= 10; 719 if $verbosity >= 10;
1016 720
1017 for my $pkg (keys %$cb) { 721 for my $pkg (
722 # this hook is only sent to the extension with the name
723 # matching the first arg
724 $htype == HOOK_KEYBOARD_DISPATCH
725 ? exists $cb->{"urxvt::ext::$_[0]"} ? "urxvt::ext::" . shift : return undef
726 : keys %$cb
727 ) {
1018 my $retval_ = eval { $cb->{$pkg}->($TERM->{_pkg}{$pkg}, @_) }; 728 my $retval_ = eval { $cb->{$pkg}->($TERM->{_pkg}{$pkg} || $TERM, @_) };
1019 $retval ||= $retval_; 729 $retval ||= $retval_;
1020 730
1021 if ($@) { 731 if ($@) {
1022 $TERM->ungrab; # better to lose the grab than the session 732 $TERM->ungrab; # better to lose the grab than the session
1023 warn $@; 733 warn $@;
1026 736
1027 verbose 11, "$HOOKNAME[$htype] returning <$retval>" 737 verbose 11, "$HOOKNAME[$htype] returning <$retval>"
1028 if $verbosity >= 11; 738 if $verbosity >= 11;
1029 } 739 }
1030 740
1031 if ($htype == 1) { # DESTROY 741 if ($htype == HOOK_DESTROY) {
1032 # clear package objects 742 # clear package objects
1033 %$_ = () for values %{ $TERM->{_pkg} }; 743 %$_ = () for values %{ $TERM->{_pkg} };
1034 744
1035 # clear package 745 # clear package
1036 %$TERM = (); 746 %$TERM = ();
1066 } 776 }
1067 } 777 }
1068 ($mask, @color{qw(fg bg)}, \@failed) 778 ($mask, @color{qw(fg bg)}, \@failed)
1069} 779}
1070 780
1071# urxvt::term::extension
1072
1073package urxvt::term::extension; 781package urxvt::term::extension;
1074 782
1075sub enable { 783=head2 The C<urxvt::term::extension> class
1076 my ($self, %hook) = @_;
1077 my $pkg = $self->{_pkg};
1078 784
1079 while (my ($name, $cb) = each %hook) { 785Each extension attached to a terminal object is represented by
1080 my $htype = $HOOKTYPE{uc $name}; 786a C<urxvt::term::extension> object.
1081 defined $htype
1082 or Carp::croak "unsupported hook type '$name'";
1083 787
1084 $self->set_should_invoke ($htype, +1) 788You can use these objects, which are passed to all callbacks to store any
1085 unless exists $self->{term}{_hook}[$htype]{$pkg}; 789state related to the terminal and extension instance.
1086 790
1087 $self->{term}{_hook}[$htype]{$pkg} = $cb; 791The methods (And data members) documented below can be called on extension
1088 } 792objects, in addition to call methods documented for the <urxvt::term>
1089} 793class.
1090 794
1091sub disable { 795=over 4
1092 my ($self, @hook) = @_;
1093 my $pkg = $self->{_pkg};
1094 796
1095 for my $name (@hook) { 797=item $urxvt_term = $self->{term}
1096 my $htype = $HOOKTYPE{uc $name};
1097 defined $htype
1098 or Carp::croak "unsupported hook type '$name'";
1099 798
1100 $self->set_should_invoke ($htype, -1) 799Returns the C<urxvt::term> object associated with this instance of the
1101 if delete $self->{term}{_hook}[$htype]{$pkg}; 800extension. This member I<must not> be changed in any way.
1102 } 801
1103} 802=cut
1104 803
1105our $AUTOLOAD; 804our $AUTOLOAD;
1106 805
1107sub AUTOLOAD { 806sub AUTOLOAD {
1108 $AUTOLOAD =~ /:([^:]+)$/ 807 $AUTOLOAD =~ /:([^:]+)$/
1121 820
1122sub DESTROY { 821sub DESTROY {
1123 # nop 822 # nop
1124} 823}
1125 824
1126# urxvt::destroy_hook 825# urxvt::destroy_hook (basically a cheap Guard:: implementation)
1127 826
1128sub urxvt::destroy_hook::DESTROY { 827sub urxvt::destroy_hook::DESTROY {
1129 ${$_[0]}->(); 828 ${$_[0]}->();
1130} 829}
1131 830
1132sub urxvt::destroy_hook(&) { 831sub urxvt::destroy_hook(&) {
1133 bless \shift, urxvt::destroy_hook:: 832 bless \shift, urxvt::destroy_hook::
1134} 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
1135 948
1136package urxvt::anyevent; 949package urxvt::anyevent;
1137 950
1138=head2 The C<urxvt::anyevent> Class 951=head2 The C<urxvt::anyevent> Class
1139 952
1140The sole purpose of this class is to deliver an interface to the 953The sole purpose of this class is to deliver an interface to the
1141C<AnyEvent> module - any module using it will work inside urxvt without 954C<AnyEvent> module - any module using it will work inside urxvt without
1142further programming. The only exception is that you cannot wait on 955further programming. The only exception is that you cannot wait on
1143condition variables, but non-blocking condvar use is ok. What this means 956condition variables, but non-blocking condvar use is ok.
1144is that you cannot use blocking APIs, but the non-blocking variant should 957
1145work. 958In practical terms this means is that you cannot use blocking APIs, but
959the non-blocking variant should work.
1146 960
1147=cut 961=cut
1148 962
1149our $VERSION = '5.23'; 963our $VERSION = '5.23';
1150 964
1209 1023
1210sub DESTROY { 1024sub DESTROY {
1211 $_[0][1]->stop; 1025 $_[0][1]->stop;
1212} 1026}
1213 1027
1028# only needed for AnyEvent < 6 compatibility
1214sub one_event { 1029sub one_event {
1215 Carp::croak "AnyEvent->one_event blocking wait unsupported in urxvt, use a non-blocking API"; 1030 Carp::croak "AnyEvent->one_event blocking wait unsupported in urxvt, use a non-blocking API";
1216} 1031}
1217 1032
1218package urxvt::term; 1033package urxvt::term;
1233 urxvt::verbose 6, "register package $pkg to $self"; 1048 urxvt::verbose 6, "register package $pkg to $self";
1234 1049
1235 @{"$pkg\::ISA"} = urxvt::term::extension::; 1050 @{"$pkg\::ISA"} = urxvt::term::extension::;
1236 1051
1237 my $proxy = bless { 1052 my $proxy = bless {
1238 _pkg => $pkg, 1053 _pkg => $pkg,
1054 _name => ${"$pkg\::_NAME"}, # hackish
1239 argv => $argv, 1055 argv => $argv,
1240 }, $pkg; 1056 }, $pkg;
1241 Scalar::Util::weaken ($proxy->{term} = $self); 1057 Scalar::Util::weaken ($proxy->{term} = $self);
1242 1058
1243 $self->{_pkg}{$pkg} = $proxy; 1059 $self->{_pkg}{$pkg} = $proxy;
1244 1060
1247 $proxy->enable ($name => $ref); 1063 $proxy->enable ($name => $ref);
1248 } 1064 }
1249 } 1065 }
1250} 1066}
1251 1067
1068sub perl_libdirs {
1069 map { split /:/ }
1070 $_[0]->resource ("perl_lib"),
1071 $ENV{URXVT_PERL_LIB},
1072 "$ENV{HOME}/.urxvt/ext",
1073 "$LIBDIR/perl"
1074}
1075
1076sub scan_meta {
1077 my ($self) = @_;
1078 my @libdirs = perl_libdirs $self;
1079
1080 return if $self->{meta_libdirs} eq join "\x00", @libdirs;
1081
1082 my %meta;
1083
1084 $self->{meta_libdirs} = join "\x00", @libdirs;
1085 $self->{meta} = \%meta;
1086
1087 for my $dir (reverse @libdirs) {
1088 opendir my $fh, $dir
1089 or next;
1090 for my $ext (readdir $fh) {
1091 $ext !~ /^\./
1092 and open my $fh, "<", "$dir/$ext"
1093 or next;
1094
1095 while (<$fh>) {
1096 if (/^#:META:X_RESOURCE:(.*)/) {
1097 my ($pattern, $type, $desc) = split /:/, $1;
1098 $pattern =~ s/^%(\.|$)/$ext$1/g; # % in pattern == extension name
1099 if ($pattern =~ /[^a-zA-Z0-9\-\.]/) {
1100 warn "$dir/$ext: meta resource '$pattern' contains illegal characters (not alphanumeric nor . nor *)\n";
1101 } else {
1102 $meta{resource}{$pattern} = [$ext, $type, $desc];
1103 }
1104 } elsif (/^\s*(?:#|$)/) {
1105 # skip other comments and empty lines
1106 } else {
1107 last; # stop parsing on first non-empty non-comment line
1108 }
1109 }
1110 }
1111 }
1112}
1113
1252=item $term = new urxvt::term $envhashref, $rxvtname, [arg...] 1114=item $term = new urxvt::term $envhashref, $rxvtname, [arg...]
1253 1115
1254Creates a new terminal, very similar as if you had started it with system 1116Creates a new terminal, very similar as if you had started it with system
1255C<$rxvtname, arg...>. C<$envhashref> must be a reference to a C<%ENV>-like 1117C<$rxvtname, arg...>. C<$envhashref> must be a reference to a C<%ENV>-like
1256hash which defines the environment of the new terminal. 1118hash which defines the environment of the new terminal.
1273} 1135}
1274 1136
1275=item $term->destroy 1137=item $term->destroy
1276 1138
1277Destroy the terminal object (close the window, free resources 1139Destroy the terminal object (close the window, free resources
1278etc.). Please note that @@RXVT_NAME@@ will not exit as long as any event 1140etc.). Please note that urxvt will not exit as long as any event
1279watchers (timers, io watchers) are still active. 1141watchers (timers, io watchers) are still active.
1280 1142
1281=item $term->exec_async ($cmd[, @args]) 1143=item $term->exec_async ($cmd[, @args])
1282 1144
1283Works like the combination of the C<fork>/C<exec> builtins, which executes 1145Works like the combination of the C<fork>/C<exec> builtins, which executes
1339 1201
1340Here is a likely non-exhaustive list of resource names, not all of which 1202Here is a likely non-exhaustive list of resource names, not all of which
1341are supported in every build, please see the source file F</src/rsinc.h> 1203are supported in every build, please see the source file F</src/rsinc.h>
1342to see the actual list: 1204to see the actual list:
1343 1205
1344 answerbackstring backgroundPixmap backspace_key blendtype blurradius 1206 answerbackstring backgroundPixmap backspace_key blurradius
1345 boldFont boldItalicFont borderLess buffered chdir color cursorBlink 1207 boldFont boldItalicFont borderLess buffered chdir color cursorBlink
1346 cursorUnderline cutchars delete_key depth display_name embed ext_bwidth 1208 cursorUnderline cutchars delete_key depth display_name embed ext_bwidth
1347 fade font geometry hold iconName iconfile imFont imLocale inputMethod 1209 fade font geometry hold iconName iconfile imFont imLocale inputMethod
1348 insecure int_bwidth intensityStyles iso14755 iso14755_52 italicFont 1210 insecure int_bwidth intensityStyles iso14755 iso14755_52 italicFont
1349 jumpScroll letterSpace lineSpace loginShell mapAlert meta8 modifier 1211 jumpScroll letterSpace lineSpace loginShell mapAlert meta8 modifier
1369Returns the X-Resource for the given pattern, excluding the program or 1231Returns the X-Resource for the given pattern, excluding the program or
1370class name, i.e. C<< $term->x_resource ("boldFont") >> should return the 1232class name, i.e. C<< $term->x_resource ("boldFont") >> should return the
1371same value as used by this instance of rxvt-unicode. Returns C<undef> if no 1233same value as used by this instance of rxvt-unicode. Returns C<undef> if no
1372resource with that pattern exists. 1234resource with that pattern exists.
1373 1235
1236Extensions that define extra resource or command line arguments also need
1237to call this method to access their values.
1238
1239If the method is called on an extension object (basically, from an
1240extension), then the special prefix C<%.> will be replaced by the name of
1241the extension and a dot, and the lone string C<%> will be replaced by the
1242extension name itself. This makes it possible to code extensions so you
1243can rename them and get a new set of commandline switches and resources
1244without having to change the actual code.
1245
1374This method should only be called during the C<on_start> hook, as there is 1246This method should only be called during the C<on_start> hook, as there is
1375only one resource database per display, and later invocations might return 1247only one resource database per display, and later invocations might return
1376the wrong resources. 1248the wrong resources.
1377 1249
1378=item $success = $term->parse_keysym ($keysym_spec, $command_string) 1250=item $value = $term->x_resource_boolean ($pattern)
1379 1251
1252Like C<x_resource>, above, but interprets the string value as a boolean
1253and returns C<1> for true values, C<0> for false values and C<undef> if
1254the resource or option isn't specified.
1255
1256You should always use this method to parse boolean resources.
1257
1258=cut
1259
1260sub x_resource_boolean {
1261 my $res = &x_resource;
1262
1263 $res =~ /^\s*(?:true|yes|on|1)\s*$/i ? 1 : defined $res && 0
1264}
1265
1266=item $success = $term->parse_keysym ($key, $octets)
1267
1380Adds a keymap translation exactly as specified via a resource. See the 1268Adds a key binding exactly as specified via a resource. See the
1381C<keysym> resource in the @@RXVT_NAME@@(1) manpage. 1269C<keysym> resource in the urxvt(1) manpage.
1270
1271=item $term->register_command ($keysym, $modifiermask, $string)
1272
1273Adds a key binding. This is a lower level api compared to
1274C<parse_keysym>, as it expects a parsed key description, and can be
1275used only inside either the C<on_init> hook, to add a binding, or the
1276C<on_register_command> hook, to modify a parsed binding.
1382 1277
1383=item $rend = $term->rstyle ([$new_rstyle]) 1278=item $rend = $term->rstyle ([$new_rstyle])
1384 1279
1385Return and optionally change the current rendition. Text that is output by 1280Return and optionally change the current rendition. Text that is output by
1386the terminal application will use this style. 1281the terminal application will use this style.
1599 1494
1600Adds the specified events to the vt event mask. Useful e.g. when you want 1495Adds the specified events to the vt event mask. Useful e.g. when you want
1601to receive pointer events all the times: 1496to receive pointer events all the times:
1602 1497
1603 $term->vt_emask_add (urxvt::PointerMotionMask); 1498 $term->vt_emask_add (urxvt::PointerMotionMask);
1499
1500=item $term->set_urgency ($set)
1501
1502Enable/disable the urgency hint on the toplevel window.
1604 1503
1605=item $term->focus_in 1504=item $term->focus_in
1606 1505
1607=item $term->focus_out 1506=item $term->focus_out
1608 1507
1805} 1704}
1806 1705
1807sub urxvt::line::t { 1706sub urxvt::line::t {
1808 my ($self) = @_; 1707 my ($self) = @_;
1809 1708
1810 if (@_ > 1) 1709 if (@_ > 1) {
1811 {
1812 $self->{term}->ROW_t ($_, $_[1], 0, ($_ - $self->{beg}) * $self->{ncol}, $self->{ncol}) 1710 $self->{term}->ROW_t ($_, $_[1], 0, ($_ - $self->{beg}) * $self->{ncol}, $self->{ncol})
1813 for $self->{beg} .. $self->{end}; 1711 for $self->{beg} .. $self->{end};
1814 } 1712 }
1815 1713
1816 defined wantarray && 1714 defined wantarray &&
1817 substr +(join "", map $self->{term}->ROW_t ($_), $self->{beg} .. $self->{end}), 1715 substr +(join "", map $self->{term}->ROW_t ($_), $self->{beg} .. $self->{end}),
1818 0, $self->{len} 1716 0, $self->{len}
1819} 1717}
1820 1718
1821sub urxvt::line::r { 1719sub urxvt::line::r {
1822 my ($self) = @_; 1720 my ($self) = @_;
1823 1721
1824 if (@_ > 1) 1722 if (@_ > 1) {
1825 {
1826 $self->{term}->ROW_r ($_, $_[1], 0, ($_ - $self->{beg}) * $self->{ncol}, $self->{ncol}) 1723 $self->{term}->ROW_r ($_, $_[1], 0, ($_ - $self->{beg}) * $self->{ncol}, $self->{ncol})
1827 for $self->{beg} .. $self->{end}; 1724 for $self->{beg} .. $self->{end};
1828 } 1725 }
1829 1726
1830 if (defined wantarray) { 1727 if (defined wantarray) {
1831 my $rend = [ 1728 my $rend = [
1832 map @{ $self->{term}->ROW_r ($_) }, $self->{beg} .. $self->{end} 1729 map @{ $self->{term}->ROW_r ($_) }, $self->{beg} .. $self->{end}
1833 ]; 1730 ];
1924=item $term->XMoveResizeWindow ($window, $x, $y, $width, $height) 1821=item $term->XMoveResizeWindow ($window, $x, $y, $width, $height)
1925 1822
1926=item ($x, $y, $child_window) = $term->XTranslateCoordinates ($src, $dst, $x, $y) 1823=item ($x, $y, $child_window) = $term->XTranslateCoordinates ($src, $dst, $x, $y)
1927 1824
1928=item $term->XChangeInput ($window, $add_events[, $del_events]) 1825=item $term->XChangeInput ($window, $add_events[, $del_events])
1826
1827=item $keysym = $term->XStringToKeysym ($string)
1828
1829=item $string = $term->XKeysymToString ($keysym)
1929 1830
1930Various X or X-related functions. The C<$term> object only serves as 1831Various X or X-related functions. The C<$term> object only serves as
1931the source of the display, otherwise those functions map more-or-less 1832the source of the display, otherwise those functions map more-or-less
1932directly onto the X functions of the same name. 1833directly onto the X functions of the same name.
1933 1834

Diff Legend

Removed lines
+ Added lines
< Changed lines
> Changed lines