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.194 by sf-exg, Wed Jun 29 21:59:36 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 from the keyboard.
265Simply bind a keysym to "perl:matcher" as seen in the example below.
266
267Example configuration:
268
269 URxvt.perl-ext: default,matcher
270 URxvt.urlLauncher: sensible-browser
271 URxvt.keysym.C-Delete: perl:matcher
272 URxvt.matcher.button: 1
273 URxvt.matcher.pattern.1: \\bwww\\.[\\w-]+\\.[\\w./?&@#-]*[\\w/-]
274 URxvt.matcher.pattern.2: \\B(/\\S+?):(\\d+)(?=:|$)
275 URxvt.matcher.launcher.2: gvim +$2 $1
276
277=item xim-onthespot
278
279This (experimental) perl extension implements OnTheSpot editing. It does
280not work perfectly, and some input methods don't seem to work well with
281OnTheSpot editing in general, but it seems to work at least for SCIM and
282kinput2.
283
284You enable it by specifying this extension and a preedit style of
285C<OnTheSpot>, i.e.:
286
287 @@RXVT_NAME@@ -pt OnTheSpot -pe xim-onthespot
288
289=item kuake<hotkey>
290
291A very primitive quake-console-like extension. It was inspired by a
292description of how the programs C<kuake> and C<yakuake> work: Whenever the
293user presses a global accelerator key (by default C<F10>), the terminal
294will show or hide itself. Another press of the accelerator key will hide
295or show it again.
296
297Initially, the window will not be shown when using this extension.
298
299This is useful if you need a single terminal that is not using any desktop
300space most of the time but is quickly available at the press of a key.
301
302The accelerator key is grabbed regardless of any modifiers, so this
303extension will actually grab a physical key just for this function.
304
305If you want a quake-like animation, tell your window manager to do so
306(fvwm can do it).
307
308=item overlay-osc
309
310This extension implements some OSC commands to display timed popups on the
311screen - useful for status displays from within scripts. You have to read
312the sources for more info.
313
314=item block-graphics-to-ascii
315
316A not very useful example of filtering all text output to the terminal
317by replacing all line-drawing characters (U+2500 .. U+259F) by a
318similar-looking ascii character.
319
320=item digital-clock
321
322Displays a digital clock using the built-in overlay.
323
324=item remote-clipboard
325
326Somewhat of a misnomer, this extension adds two menu entries to the
327selection popup that allows one to run external commands to store the
328selection somewhere and fetch it again.
329
330We use it to implement a "distributed selection mechanism", which just
331means that one command uploads the file to a remote server, and another
332reads it.
333
334The commands can be set using the C<URxvt.remote-selection.store> and
335C<URxvt.remote-selection.fetch> resources. The first should read the
336selection to store from STDIN (always in UTF-8), the second should provide
337the selection data on STDOUT (also in UTF-8).
338
339The defaults (which are likely useless to you) use rsh and cat:
340
341 URxvt.remote-selection.store: rsh ruth 'cat >/tmp/distributed-selection'
342 URxvt.remote-selection.fetch: rsh ruth 'cat /tmp/distributed-selection'
343
344=item selection-pastebin
345
346This is a little rarely useful extension that uploads the selection as
347textfile to a remote site (or does other things). (The implementation is
348not currently secure for use in a multiuser environment as it writes to
349F</tmp> directly.).
350
351It listens to the C<selection-pastebin:remote-pastebin> keyboard command,
352i.e.
353
354 URxvt.keysym.C-M-e: perl:selection-pastebin:remote-pastebin
355
356Pressing this combination runs a command with C<%> replaced by the name of
357the textfile. This command can be set via a resource:
358
359 URxvt.selection-pastebin.cmd: rsync -apP % ruth:/var/www/www.ta-sa.org/files/txt/.
360
361And the default is likely not useful to anybody but the few people around
362here :)
363
364The name of the textfile is the hex encoded md5 sum of the selection, so
365the same content should lead to the same filename.
366
367After a successful upload the selection will be replaced by the text given
368in the C<selection-pastebin-url> resource (again, the % is the placeholder
369for the filename):
370
371 URxvt.selection-pastebin.url: http://www.ta-sa.org/files/txt/%
372
373I<Note to xrdb users:> xrdb uses the C preprocessor, which might interpret
374the double C</> characters as comment start. Use C<\057\057> instead,
375which works regardless of whether xrdb is used to parse the resource file
376or not.
377
378=item macosx-clipboard and macosx-clipboard-native
379
380These two modules implement an extended clipboard for Mac OS X. They are
381used like this:
382
383 URxvt.perl-ext-common: default,macosx-clipboard
384 URxvt.keysym.M-c: perl:macosx-clipboard:copy
385 URxvt.keysym.M-v: perl:macosx-clipboard:paste
386
387The difference between them is that the native variant requires a
388perl from apple's devkit or so, and C<macosx-clipboard> requires the
389C<Mac::Pasteboard> module, works with other perls, has fewer bugs, is
390simpler etc. etc.
391
392=item example-refresh-hooks
393
394Displays a very simple digital clock in the upper right corner of the
395window. Illustrates overwriting the refresh callbacks to create your own
396overlays or changes.
397
398=item confirm-paste
399
400Displays a confirmation dialog when a paste containing at least a full
401line is detected.
402
403=back
404 50
405=head1 API DOCUMENTATION 51=head1 API DOCUMENTATION
406 52
407=head2 General API Considerations 53=head2 General API Considerations
408 54
435 81
436=item $octets 82=item $octets
437 83
438Either binary data or - more common - a text string encoded in a 84Either binary data or - more common - a text string encoded in a
439locale-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>.
440 92
441=back 93=back
442 94
443=head2 Extension Objects 95=head2 Extension Objects
444 96
451internal use. 103internal use.
452 104
453Although 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
454C<urxvt::term> class on this object. 106C<urxvt::term> class on this object.
455 107
456It has the following methods and data members: 108Additional methods only supported for extension objects are described in
457 109the C<urxvt::extension> section below.
458=over 4
459
460=item $urxvt_term = $self->{term}
461
462Returns the C<urxvt::term> object associated with this instance of the
463extension. This member I<must not> be changed in any way.
464
465=item $self->enable ($hook_name => $cb, [$hook_name => $cb..])
466
467Dynamically enable the given hooks (named without the C<on_> prefix) for
468this extension, replacing any previous hook. This is useful when you want
469to overwrite time-critical hooks only temporarily.
470
471=item $self->disable ($hook_name[, $hook_name..])
472
473Dynamically disable the given hooks.
474
475=back
476 110
477=head2 Hooks 111=head2 Hooks
478 112
479The following subroutines can be declared in extension files, and will be 113The following subroutines can be declared in extension files, and will be
480called whenever the relevant event happens. 114called whenever the relevant event happens.
647 281
648=item on_refresh_end $term 282=item on_refresh_end $term
649 283
650Called just after the screen gets redrawn. See C<on_refresh_begin>. 284Called just after the screen gets redrawn. See C<on_refresh_begin>.
651 285
652=item on_user_command $term, $string 286=item on_user_command $term, $string *DEPRECATED*
653 287
654Called whenever a user-configured event is being activated (e.g. via 288Called whenever a user-configured event is being activated (e.g. via
655a 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>
656resource in the @@RXVT_NAME@@(1) manpage). 290resource in the urxvt(1) manpage).
657 291
658The 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
659slightly in the future. 293preference to the C<< ->register_keysym_action >> method.
660 294
661=item on_resize_all_windows $term, $new_width, $new_height 295=item on_resize_all_windows $term, $new_width, $new_height
662 296
663Called just after the new window size has been calculated, but before 297Called just after the new window size has been calculated, but before
664windows 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
665returns TRUE, setting of the window hints is being skipped. 299returns a true value, setting of the window hints is being skipped.
666 300
667=item on_x_event $term, $event 301=item on_x_event $term, $event
668 302
669Called 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
670windows). Should only be used as a last resort. Most event structure 304windows). Should only be used as a last resort. Most event structure
710(real, not screen-based) row and column under the mouse cursor. 344(real, not screen-based) row and column under the mouse cursor.
711 345
712C<on_key_press> additionally receives the string rxvt-unicode would 346C<on_key_press> additionally receives the string rxvt-unicode would
713output, if any, in locale-specific encoding. 347output, if any, in locale-specific encoding.
714 348
715subwindow.
716
717=item on_client_message $term, $event 349=item on_client_message $term, $event
718 350
719=item on_wm_protocols $term, $event 351=item on_wm_protocols $term, $event
720 352
721=item on_wm_delete_window $term, $event 353=item on_wm_delete_window $term, $event
732=cut 364=cut
733 365
734package urxvt; 366package urxvt;
735 367
736use utf8; 368use utf8;
737use strict; 369use strict 'vars';
738use Carp (); 370use Carp ();
739use Scalar::Util (); 371use Scalar::Util ();
740use List::Util (); 372use List::Util ();
741 373
742our $VERSION = 1; 374our $VERSION = 1;
743our $TERM; 375our $TERM;
744our @TERM_INIT; 376our @TERM_INIT; # should go, prevents async I/O etc.
745our @TERM_EXT; 377our @TERM_EXT; # should go, prevents async I/O etc.
746our @HOOKNAME; 378our @HOOKNAME;
747our %HOOKTYPE = map +($HOOKNAME[$_] => $_), 0..$#HOOKNAME; 379our %HOOKTYPE = map +($HOOKNAME[$_] => $_), 0..$#HOOKNAME;
748our %OPTION; 380our %OPTION;
749 381
750our $LIBDIR; 382our $LIBDIR;
920 }; 552 };
921} 553}
922 554
923no warnings 'utf8'; 555no warnings 'utf8';
924 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
925my $verbosity = $ENV{URXVT_PERL_VERBOSITY}; 617my $verbosity = $ENV{URXVT_PERL_VERBOSITY};
926 618
927sub verbose { 619sub verbose {
928 my ($level, $msg) = @_; 620 my ($level, $msg) = @_;
929 warn "$msg\n" if $level <= $verbosity; 621 warn "$msg\n" if $level <= $verbosity;
941 $pkg =~ s/[^[:word:]]/_/g; 633 $pkg =~ s/[^[:word:]]/_/g;
942 $pkg = "urxvt::ext::$pkg"; 634 $pkg = "urxvt::ext::$pkg";
943 635
944 verbose 3, "loading extension '$path' into package '$pkg'"; 636 verbose 3, "loading extension '$path' into package '$pkg'";
945 637
638 (${"$pkg\::_NAME"} = $path) =~ s/^.*[\\\/]//; # hackish
639
946 open my $fh, "<:raw", $path 640 open my $fh, "<:raw", $path
947 or die "$path: $!"; 641 or die "$path: $!";
948 642
949 my $source = 643 my $source =
950 "package $pkg; use strict; use utf8; no warnings 'utf8';\n" 644 "package $pkg; use strict 'vars'; use utf8; no warnings 'utf8';\n"
951 . "#line 1 \"$path\"\n{\n" 645 . "#line 1 \"$path\"\n{\n"
952 . (do { local $/; <$fh> }) 646 . (do { local $/; <$fh> })
953 . "\n};\n1"; 647 . "\n};\n1";
954 648
955 eval $source 649 eval $source
964# called by the rxvt core 658# called by the rxvt core
965sub invoke { 659sub invoke {
966 local $TERM = shift; 660 local $TERM = shift;
967 my $htype = shift; 661 my $htype = shift;
968 662
969 if ($htype == 0) { # INIT 663 if ($htype == HOOK_INIT) {
970 my @dirs = ((split /:/, $TERM->resource ("perl_lib")), "$LIBDIR/perl"); 664 my @dirs = $TERM->perl_libdirs;
971 665
972 my %ext_arg; 666 my %ext_arg;
973 667
974 { 668 {
975 my @init = @TERM_INIT; 669 my @init = @TERM_INIT;
978 my @pkg = @TERM_EXT; 672 my @pkg = @TERM_EXT;
979 @TERM_EXT = (); 673 @TERM_EXT = ();
980 $TERM->register_package ($_) for @pkg; 674 $TERM->register_package ($_) for @pkg;
981 } 675 }
982 676
677 for (
678 @{ delete $TERM->{perl_ext_3} },
983 for (grep $_, map { split /,/, $TERM->resource ("perl_ext_$_") } 1, 2) { 679 grep $_, map { split /,/, $TERM->resource ("perl_ext_$_") } 1, 2
680 ) {
984 if ($_ eq "default") { 681 if ($_ eq "default") {
985 $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);
986 } elsif (/^-(.*)$/) { 683 } elsif (/^-(.*)$/) {
987 delete $ext_arg{$1}; 684 delete $ext_arg{$1};
988 } elsif (/^([^<]+)<(.*)>$/) { 685 } elsif (/^([^<]+)<(.*)>$/) {
1010 707
1011 if (my $cb = $TERM->{_hook}[$htype]) { 708 if (my $cb = $TERM->{_hook}[$htype]) {
1012 verbose 10, "$HOOKNAME[$htype] (" . (join ", ", $TERM, @_) . ")" 709 verbose 10, "$HOOKNAME[$htype] (" . (join ", ", $TERM, @_) . ")"
1013 if $verbosity >= 10; 710 if $verbosity >= 10;
1014 711
1015 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 ) {
1016 my $retval_ = eval { $cb->{$pkg}->($TERM->{_pkg}{$pkg}, @_) }; 719 my $retval_ = eval { $cb->{$pkg}->($TERM->{_pkg}{$pkg} || $TERM, @_) };
1017 $retval ||= $retval_; 720 $retval ||= $retval_;
1018 721
1019 if ($@) { 722 if ($@) {
1020 $TERM->ungrab; # better to lose the grab than the session 723 $TERM->ungrab; # better to lose the grab than the session
1021 warn $@; 724 warn $@;
1024 727
1025 verbose 11, "$HOOKNAME[$htype] returning <$retval>" 728 verbose 11, "$HOOKNAME[$htype] returning <$retval>"
1026 if $verbosity >= 11; 729 if $verbosity >= 11;
1027 } 730 }
1028 731
1029 if ($htype == 1) { # DESTROY 732 if ($htype == HOOK_DESTROY) {
1030 # clear package objects 733 # clear package objects
1031 %$_ = () for values %{ $TERM->{_pkg} }; 734 %$_ = () for values %{ $TERM->{_pkg} };
1032 735
1033 # clear package 736 # clear package
1034 %$TERM = (); 737 %$TERM = ();
1064 } 767 }
1065 } 768 }
1066 ($mask, @color{qw(fg bg)}, \@failed) 769 ($mask, @color{qw(fg bg)}, \@failed)
1067} 770}
1068 771
1069# urxvt::term::extension
1070
1071package urxvt::term::extension; 772package urxvt::term::extension;
1072 773
1073sub enable { 774=head2 The C<urxvt::term::extension> class
1074 my ($self, %hook) = @_;
1075 my $pkg = $self->{_pkg};
1076 775
1077 while (my ($name, $cb) = each %hook) { 776Each extension attached to a terminal object is represented by
1078 my $htype = $HOOKTYPE{uc $name}; 777a C<urxvt::term::extension> object.
1079 defined $htype
1080 or Carp::croak "unsupported hook type '$name'";
1081 778
1082 $self->set_should_invoke ($htype, +1) 779You can use these objects, which are passed to all callbacks to store any
1083 unless exists $self->{term}{_hook}[$htype]{$pkg}; 780state related to the terminal and extension instance.
1084 781
1085 $self->{term}{_hook}[$htype]{$pkg} = $cb; 782The methods (And data members) documented below can be called on extension
1086 } 783objects, in addition to call methods documented for the <urxvt::term>
1087} 784class.
1088 785
1089sub disable { 786=over 4
1090 my ($self, @hook) = @_;
1091 my $pkg = $self->{_pkg};
1092 787
1093 for my $name (@hook) { 788=item $urxvt_term = $self->{term}
1094 my $htype = $HOOKTYPE{uc $name};
1095 defined $htype
1096 or Carp::croak "unsupported hook type '$name'";
1097 789
1098 $self->set_should_invoke ($htype, -1) 790Returns the C<urxvt::term> object associated with this instance of the
1099 if delete $self->{term}{_hook}[$htype]{$pkg}; 791extension. This member I<must not> be changed in any way.
1100 } 792
1101} 793=cut
1102 794
1103our $AUTOLOAD; 795our $AUTOLOAD;
1104 796
1105sub AUTOLOAD { 797sub AUTOLOAD {
1106 $AUTOLOAD =~ /:([^:]+)$/ 798 $AUTOLOAD =~ /:([^:]+)$/
1119 811
1120sub DESTROY { 812sub DESTROY {
1121 # nop 813 # nop
1122} 814}
1123 815
1124# urxvt::destroy_hook 816# urxvt::destroy_hook (basically a cheap Guard:: implementation)
1125 817
1126sub urxvt::destroy_hook::DESTROY { 818sub urxvt::destroy_hook::DESTROY {
1127 ${$_[0]}->(); 819 ${$_[0]}->();
1128} 820}
1129 821
1130sub urxvt::destroy_hook(&) { 822sub urxvt::destroy_hook(&) {
1131 bless \shift, urxvt::destroy_hook:: 823 bless \shift, urxvt::destroy_hook::
1132} 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
1133 939
1134package urxvt::anyevent; 940package urxvt::anyevent;
1135 941
1136=head2 The C<urxvt::anyevent> Class 942=head2 The C<urxvt::anyevent> Class
1137 943
1138The 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
1139C<AnyEvent> module - any module using it will work inside urxvt without 945C<AnyEvent> module - any module using it will work inside urxvt without
1140further programming. The only exception is that you cannot wait on 946further programming. The only exception is that you cannot wait on
1141condition variables, but non-blocking condvar use is ok. What this means 947condition variables, but non-blocking condvar use is ok.
1142is that you cannot use blocking APIs, but the non-blocking variant should 948
1143work. 949In practical terms this means is that you cannot use blocking APIs, but
950the non-blocking variant should work.
1144 951
1145=cut 952=cut
1146 953
1147our $VERSION = '5.23'; 954our $VERSION = '5.23';
1148 955
1207 1014
1208sub DESTROY { 1015sub DESTROY {
1209 $_[0][1]->stop; 1016 $_[0][1]->stop;
1210} 1017}
1211 1018
1019# only needed for AnyEvent < 6 compatibility
1212sub one_event { 1020sub one_event {
1213 Carp::croak "AnyEvent->one_event blocking wait unsupported in urxvt, use a non-blocking API"; 1021 Carp::croak "AnyEvent->one_event blocking wait unsupported in urxvt, use a non-blocking API";
1214} 1022}
1215 1023
1216package urxvt::term; 1024package urxvt::term;
1231 urxvt::verbose 6, "register package $pkg to $self"; 1039 urxvt::verbose 6, "register package $pkg to $self";
1232 1040
1233 @{"$pkg\::ISA"} = urxvt::term::extension::; 1041 @{"$pkg\::ISA"} = urxvt::term::extension::;
1234 1042
1235 my $proxy = bless { 1043 my $proxy = bless {
1236 _pkg => $pkg, 1044 _pkg => $pkg,
1045 _name => ${"$pkg\::_NAME"}, # hackish
1237 argv => $argv, 1046 argv => $argv,
1238 }, $pkg; 1047 }, $pkg;
1239 Scalar::Util::weaken ($proxy->{term} = $self); 1048 Scalar::Util::weaken ($proxy->{term} = $self);
1240 1049
1241 $self->{_pkg}{$pkg} = $proxy; 1050 $self->{_pkg}{$pkg} = $proxy;
1242 1051
1245 $proxy->enable ($name => $ref); 1054 $proxy->enable ($name => $ref);
1246 } 1055 }
1247 } 1056 }
1248} 1057}
1249 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
1250=item $term = new urxvt::term $envhashref, $rxvtname, [arg...] 1105=item $term = new urxvt::term $envhashref, $rxvtname, [arg...]
1251 1106
1252Creates 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
1253C<$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
1254hash which defines the environment of the new terminal. 1109hash which defines the environment of the new terminal.
1271} 1126}
1272 1127
1273=item $term->destroy 1128=item $term->destroy
1274 1129
1275Destroy the terminal object (close the window, free resources 1130Destroy the terminal object (close the window, free resources
1276etc.). 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
1277watchers (timers, io watchers) are still active. 1132watchers (timers, io watchers) are still active.
1278 1133
1279=item $term->exec_async ($cmd[, @args]) 1134=item $term->exec_async ($cmd[, @args])
1280 1135
1281Works 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
1308C<%urxvt::OPTION>. Options not enabled in this binary are not in the hash. 1163C<%urxvt::OPTION>. Options not enabled in this binary are not in the hash.
1309 1164
1310Here is a likely non-exhaustive list of option names, please see the 1165Here is a likely non-exhaustive list of option names, please see the
1311source file F</src/optinc.h> to see the actual list: 1166source file F</src/optinc.h> to see the actual list:
1312 1167
1313 borderLess console cursorBlink cursorUnderline hold iconic insecure 1168 borderLess buffered console cursorBlink cursorUnderline hold iconic
1314 intensityStyles jumpScroll loginShell mapAlert meta8 mouseWheelScrollPage 1169 insecure intensityStyles iso14755 iso14755_52 jumpScroll loginShell
1315 override-redirect pastableTabs pointerBlank reverseVideo scrollBar 1170 mapAlert meta8 mouseWheelScrollPage override_redirect pastableTabs
1316 scrollBar_floating scrollBar_right scrollTtyKeypress scrollTtyOutput 1171 pointerBlank reverseVideo scrollBar scrollBar_floating scrollBar_right
1317 scrollWithBuffer secondaryScreen secondaryScroll skipBuiltinGlyphs 1172 scrollTtyKeypress scrollTtyOutput scrollWithBuffer secondaryScreen
1318 transparent tripleclickwords utmpInhibit visualBell 1173 secondaryScroll skipBuiltinGlyphs skipScroll transparent tripleclickwords
1174 urgentOnBell utmpInhibit visualBell
1319 1175
1320=item $value = $term->resource ($name[, $newval]) 1176=item $value = $term->resource ($name[, $newval])
1321 1177
1322Returns the current resource value associated with a given name and 1178Returns the current resource value associated with a given name and
1323optionally sets a new value. Setting values is most useful in the C<init> 1179optionally sets a new value. Setting values is most useful in the C<init>
1336 1192
1337Here 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
1338are 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>
1339to see the actual list: 1195to see the actual list:
1340 1196
1341 answerbackstring backgroundPixmap backspace_key blendtype blurradius 1197 answerbackstring backgroundPixmap backspace_key blurradius
1342 boldFont boldItalicFont borderLess buffered chdir color cursorBlink 1198 boldFont boldItalicFont borderLess buffered chdir color cursorBlink
1343 cursorUnderline cutchars delete_key depth display_name embed ext_bwidth 1199 cursorUnderline cutchars delete_key depth display_name embed ext_bwidth
1344 fade font geometry hold iconName iconfile imFont imLocale inputMethod 1200 fade font geometry hold iconName iconfile imFont imLocale inputMethod
1345 insecure int_bwidth intensityStyles iso14755 iso14755_52 italicFont 1201 insecure int_bwidth intensityStyles iso14755 iso14755_52 italicFont
1346 jumpScroll letterSpace lineSpace loginShell mapAlert meta8 modifier 1202 jumpScroll letterSpace lineSpace loginShell mapAlert meta8 modifier
1366Returns the X-Resource for the given pattern, excluding the program or 1222Returns the X-Resource for the given pattern, excluding the program or
1367class name, i.e. C<< $term->x_resource ("boldFont") >> should return the 1223class name, i.e. C<< $term->x_resource ("boldFont") >> should return the
1368same 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
1369resource with that pattern exists. 1225resource with that pattern exists.
1370 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
1371This 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
1372only one resource database per display, and later invocations might return 1238only one resource database per display, and later invocations might return
1373the wrong resources. 1239the wrong resources.
1374 1240
1375=item $success = $term->parse_keysym ($keysym_spec, $command_string) 1241=item $value = $term->x_resource_boolean ($pattern)
1376 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
1257=item $success = $term->parse_keysym ($key, $octets)
1258
1377Adds a keymap translation exactly as specified via a resource. See the 1259Adds a key binding exactly as specified via a resource. See the
1378C<keysym> resource in the @@RXVT_NAME@@(1) manpage. 1260C<keysym> resource in the urxvt(1) manpage.
1379 1261
1380=item $rend = $term->rstyle ([$new_rstyle]) 1262=item $rend = $term->rstyle ([$new_rstyle])
1381 1263
1382Return and optionally change the current rendition. Text that is output by 1264Return and optionally change the current rendition. Text that is output by
1383the terminal application will use this style. 1265the terminal application will use this style.
1596 1478
1597Adds 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
1598to receive pointer events all the times: 1480to receive pointer events all the times:
1599 1481
1600 $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.
1601 1487
1602=item $term->focus_in 1488=item $term->focus_in
1603 1489
1604=item $term->focus_out 1490=item $term->focus_out
1605 1491
1802} 1688}
1803 1689
1804sub urxvt::line::t { 1690sub urxvt::line::t {
1805 my ($self) = @_; 1691 my ($self) = @_;
1806 1692
1807 if (@_ > 1) 1693 if (@_ > 1) {
1808 {
1809 $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})
1810 for $self->{beg} .. $self->{end}; 1695 for $self->{beg} .. $self->{end};
1811 } 1696 }
1812 1697
1813 defined wantarray && 1698 defined wantarray &&
1814 substr +(join "", map $self->{term}->ROW_t ($_), $self->{beg} .. $self->{end}), 1699 substr +(join "", map $self->{term}->ROW_t ($_), $self->{beg} .. $self->{end}),
1815 0, $self->{len} 1700 0, $self->{len}
1816} 1701}
1817 1702
1818sub urxvt::line::r { 1703sub urxvt::line::r {
1819 my ($self) = @_; 1704 my ($self) = @_;
1820 1705
1821 if (@_ > 1) 1706 if (@_ > 1) {
1822 {
1823 $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})
1824 for $self->{beg} .. $self->{end}; 1708 for $self->{beg} .. $self->{end};
1825 } 1709 }
1826 1710
1827 if (defined wantarray) { 1711 if (defined wantarray) {
1828 my $rend = [ 1712 my $rend = [
1829 map @{ $self->{term}->ROW_r ($_) }, $self->{beg} .. $self->{end} 1713 map @{ $self->{term}->ROW_r ($_) }, $self->{beg} .. $self->{end}
1830 ]; 1714 ];
1921=item $term->XMoveResizeWindow ($window, $x, $y, $width, $height) 1805=item $term->XMoveResizeWindow ($window, $x, $y, $width, $height)
1922 1806
1923=item ($x, $y, $child_window) = $term->XTranslateCoordinates ($src, $dst, $x, $y) 1807=item ($x, $y, $child_window) = $term->XTranslateCoordinates ($src, $dst, $x, $y)
1924 1808
1925=item $term->XChangeInput ($window, $add_events[, $del_events]) 1809=item $term->XChangeInput ($window, $add_events[, $del_events])
1810
1811=item $keysym = $term->XStringToKeysym ($string)
1812
1813=item $string = $term->XKeysymToString ($keysym)
1926 1814
1927Various X or X-related functions. The C<$term> object only serves as 1815Various X or X-related functions. The C<$term> object only serves as
1928the source of the display, otherwise those functions map more-or-less 1816the source of the display, otherwise those functions map more-or-less
1929directly onto the X functions of the same name. 1817directly onto the X functions of the same name.
1930 1818

Diff Legend

Removed lines
+ Added lines
< Changed lines
> Changed lines