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.202 by sf-exg, Wed Nov 30 10:29:51 2011 UTC vs.
Revision 1.243 by sf-exg, Sat Oct 11 22:02:50 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 may add resources on their own. Similarly to builtin
48 49resources, these resources can also be specified on the command line
49=item selection (enabled by default) 50as long options (with '.' replaced by '-'), in which case the
50 51corresponding extension is loaded automatically.
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 52
415=head1 API DOCUMENTATION 53=head1 API DOCUMENTATION
416 54
417=head2 General API Considerations 55=head2 General API Considerations
418 56
467internal use. 105internal use.
468 106
469Although it isn't a C<urxvt::term> object, you can call all methods of the 107Although it isn't a C<urxvt::term> object, you can call all methods of the
470C<urxvt::term> class on this object. 108C<urxvt::term> class on this object.
471 109
472It has the following methods and data members: 110Additional methods only supported for extension objects are described in
473 111the 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 112
493=head2 Hooks 113=head2 Hooks
494 114
495The following subroutines can be declared in extension files, and will be 115The following subroutines can be declared in extension files, and will be
496called whenever the relevant event happens. 116called whenever the relevant event happens.
663 283
664=item on_refresh_end $term 284=item on_refresh_end $term
665 285
666Called just after the screen gets redrawn. See C<on_refresh_begin>. 286Called just after the screen gets redrawn. See C<on_refresh_begin>.
667 287
668=item on_user_command $term, $string 288=item on_user_command $term, $string *DEPRECATED*
669 289
670Called whenever a user-configured event is being activated (e.g. via 290Called 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> 291a C<perl:string> action bound to a key, see description of the B<keysym>
672resource in the @@RXVT_NAME@@(1) manpage). 292resource in the urxvt(1) manpage).
673 293
674The event is simply the action string. This interface is assumed to change 294The event is simply the action string. This interface is going away in
675slightly in the future. 295preference to the C<on_action> hook.
676 296
677=item on_resize_all_windows $term, $new_width, $new_height 297=item on_resize_all_windows $term, $new_width, $new_height
678 298
679Called just after the new window size has been calculated, but before 299Called just after the new window size has been calculated, but before
680windows are actually being resized or hints are being set. If this hook 300windows are actually being resized or hints are being set. If this hook
681returns TRUE, setting of the window hints is being skipped. 301returns a true value, setting of the window hints is being skipped.
682 302
683=item on_x_event $term, $event 303=item on_x_event $term, $event
684 304
685Called on every X event received on the vt window (and possibly other 305Called on every X event received on the vt window (and possibly other
686windows). Should only be used as a last resort. Most event structure 306windows). Should only be used as a last resort. Most event structure
726(real, not screen-based) row and column under the mouse cursor. 346(real, not screen-based) row and column under the mouse cursor.
727 347
728C<on_key_press> additionally receives the string rxvt-unicode would 348C<on_key_press> additionally receives the string rxvt-unicode would
729output, if any, in locale-specific encoding. 349output, if any, in locale-specific encoding.
730 350
731subwindow.
732
733=item on_client_message $term, $event 351=item on_client_message $term, $event
734 352
735=item on_wm_protocols $term, $event 353=item on_wm_protocols $term, $event
736 354
737=item on_wm_delete_window $term, $event 355=item on_wm_delete_window $term, $event
748=cut 366=cut
749 367
750package urxvt; 368package urxvt;
751 369
752use utf8; 370use utf8;
753use strict; 371use strict 'vars';
754use Carp (); 372use Carp ();
755use Scalar::Util (); 373use Scalar::Util ();
756use List::Util (); 374use List::Util ();
757 375
758our $VERSION = 1; 376our $VERSION = 1;
759our $TERM; 377our $TERM;
760our @TERM_INIT; 378our @TERM_INIT; # should go, prevents async I/O etc.
761our @TERM_EXT; 379our @TERM_EXT; # should go, prevents async I/O etc.
762our @HOOKNAME; 380our @HOOKNAME;
763our %HOOKTYPE = map +($HOOKNAME[$_] => $_), 0..$#HOOKNAME; 381our %HOOKTYPE = map +($HOOKNAME[$_] => $_), 0..$#HOOKNAME;
764our %OPTION; 382our %OPTION;
765 383
766our $LIBDIR; 384our $LIBDIR;
936 }; 554 };
937} 555}
938 556
939no warnings 'utf8'; 557no warnings 'utf8';
940 558
559sub parse_resource {
560 my ($term, $name, $isarg, $longopt, $flag, $value) = @_;
561
562 $term->scan_extensions;
563
564 my $r = $term->{meta}{resource};
565 keys %$r; # reset iterator
566 while (my ($k, $v) = each %$r) {
567 my $pattern = $k;
568 $pattern =~ y/./-/ if $isarg;
569 my $prefix = $name;
570 my $suffix;
571 if ($pattern =~ /\-$/) {
572 $prefix = substr $name, 0, length $pattern;
573 $suffix = substr $name, length $pattern;
574 }
575 if ($pattern eq $prefix) {
576 $name = "$urxvt::RESCLASS.$k$suffix";
577
578 push @{ $term->{perl_ext_3} }, $v->[0];
579
580 if ($v->[1] eq "boolean") {
581 $term->put_option_db ($name, $flag ? "true" : "false");
582 return 1;
583 } else {
584 $term->put_option_db ($name, $value);
585 return 1 + 2;
586 }
587 }
588 }
589
590 0
591}
592
593sub usage {
594 my ($term, $usage_type) = @_;
595
596 $term->scan_extensions;
597
598 my $r = $term->{meta}{resource};
599
600 for my $pattern (sort keys %$r) {
601 my ($ext, $type, $desc) = @{ $r->{$pattern} };
602
603 $desc .= " (-pe $ext)";
604
605 if ($usage_type == 1) {
606 $pattern =~ y/./-/;
607 $pattern =~ s/-$/-.../g;
608
609 if ($type eq "boolean") {
610 urxvt::log sprintf " -%-30s %s\n", "/+$pattern", $desc;
611 } else {
612 urxvt::log sprintf " -%-30s %s\n", "$pattern $type", $desc;
613 }
614 } else {
615 $pattern =~ s/\.$/.*/g;
616 urxvt::log sprintf " %-31s %s\n", "$pattern:", $type;
617 }
618 }
619}
620
941my $verbosity = $ENV{URXVT_PERL_VERBOSITY}; 621my $verbosity = $ENV{URXVT_PERL_VERBOSITY};
942 622
943sub verbose { 623sub verbose {
944 my ($level, $msg) = @_; 624 my ($level, $msg) = @_;
945 warn "$msg\n" if $level <= $verbosity; 625 warn "$msg\n" if $level <= $verbosity;
957 $pkg =~ s/[^[:word:]]/_/g; 637 $pkg =~ s/[^[:word:]]/_/g;
958 $pkg = "urxvt::ext::$pkg"; 638 $pkg = "urxvt::ext::$pkg";
959 639
960 verbose 3, "loading extension '$path' into package '$pkg'"; 640 verbose 3, "loading extension '$path' into package '$pkg'";
961 641
642 (${"$pkg\::_NAME"} = $path) =~ s/^.*[\\\/]//; # hackish
643
962 open my $fh, "<:raw", $path 644 open my $fh, "<:raw", $path
963 or die "$path: $!"; 645 or die "$path: $!";
964 646
965 my $source = 647 my $source =
966 "package $pkg; use strict; use utf8; no warnings 'utf8';\n" 648 "package $pkg; use strict 'vars'; use utf8; no warnings 'utf8';\n"
967 . "#line 1 \"$path\"\n{\n" 649 . "#line 1 \"$path\"\n{\n"
968 . (do { local $/; <$fh> }) 650 . (do { local $/; <$fh> })
969 . "\n};\n1"; 651 . "\n};\n1";
970 652
971 eval $source 653 eval $source
980# called by the rxvt core 662# called by the rxvt core
981sub invoke { 663sub invoke {
982 local $TERM = shift; 664 local $TERM = shift;
983 my $htype = shift; 665 my $htype = shift;
984 666
985 if ($htype == 0) { # INIT 667 if ($htype == HOOK_INIT) {
986 my @dirs = ((split /:/, $TERM->resource ("perl_lib")), "$ENV{HOME}/.urxvt/ext", "$LIBDIR/perl"); 668 my @dirs = $TERM->perl_libdirs;
669
670 $TERM->scan_extensions;
987 671
988 my %ext_arg; 672 my %ext_arg;
989 673
990 { 674 {
991 my @init = @TERM_INIT; 675 my @init = @TERM_INIT;
994 my @pkg = @TERM_EXT; 678 my @pkg = @TERM_EXT;
995 @TERM_EXT = (); 679 @TERM_EXT = ();
996 $TERM->register_package ($_) for @pkg; 680 $TERM->register_package ($_) for @pkg;
997 } 681 }
998 682
683 for (
999 for (grep $_, map { split /,/, $TERM->resource ("perl_ext_$_") } 1, 2) { 684 (grep $_, map { split /,/, $TERM->resource ("perl_ext_$_") } 1, 2),
685 @{ delete $TERM->{perl_ext_3} }
686 ) {
1000 if ($_ eq "default") { 687 if ($_ eq "default") {
1001 $ext_arg{$_} ||= [] for qw(selection option-popup selection-popup searchable-scrollback readline); 688
689 $ext_arg{$_} = []
690 for
691 qw(selection option-popup selection-popup readline),
692 map $_->[0], values %{ $TERM->{meta}{binding} };
693
694 for ($TERM->_keysym_resources) {
695 next if /^(?:string|command|builtin|builtin-string|perl)/;
696 next unless /^([A-Za-z0-9_\-]+):/;
697
698 my $ext = $1;
699
700 $ext_arg{$ext} = [];
701 }
702
1002 } elsif (/^-(.*)$/) { 703 } elsif (/^-(.*)$/) {
1003 delete $ext_arg{$1}; 704 delete $ext_arg{$1};
705
1004 } elsif (/^([^<]+)<(.*)>$/) { 706 } elsif (/^([^<]+)<(.*)>$/) {
1005 push @{ $ext_arg{$1} }, $2; 707 push @{ $ext_arg{$1} }, $2;
708
1006 } else { 709 } else {
1007 $ext_arg{$_} ||= []; 710 $ext_arg{$_} ||= [];
711 }
712 }
713
714 # now register default key bindings
715 for my $ext (sort keys %ext_arg) {
716 while (my ($k, $v) = each %{ $TERM->{meta}{ext}{$ext}{binding} }) {
717 $TERM->bind_action ($k, "$v->[0]:$v->[1]");
1008 } 718 }
1009 } 719 }
1010 720
1011 for my $ext (sort keys %ext_arg) { 721 for my $ext (sort keys %ext_arg) {
1012 my @files = grep -f $_, map "$_/$ext", @dirs; 722 my @files = grep -f $_, map "$_/$ext", @dirs;
1026 736
1027 if (my $cb = $TERM->{_hook}[$htype]) { 737 if (my $cb = $TERM->{_hook}[$htype]) {
1028 verbose 10, "$HOOKNAME[$htype] (" . (join ", ", $TERM, @_) . ")" 738 verbose 10, "$HOOKNAME[$htype] (" . (join ", ", $TERM, @_) . ")"
1029 if $verbosity >= 10; 739 if $verbosity >= 10;
1030 740
741 if ($htype == HOOK_ACTION) {
742 # this hook is only sent to the extension with the name
743 # matching the first arg
744 my $pkg = shift;
745 $pkg =~ y/-/_/;
746 $pkg = "urxvt::ext::$pkg";
747
748 $cb = $cb->{$pkg}
749 or return undef; #TODO: maybe warn user?
750
751 $cb = { $pkg => $cb };
752 }
753
1031 for my $pkg (keys %$cb) { 754 for my $pkg (keys %$cb) {
1032 my $retval_ = eval { $cb->{$pkg}->($TERM->{_pkg}{$pkg}, @_) }; 755 my $retval_ = eval { $cb->{$pkg}->($TERM->{_pkg}{$pkg} || $TERM, @_) };
1033 $retval ||= $retval_; 756 $retval ||= $retval_;
1034 757
1035 if ($@) { 758 if ($@) {
1036 $TERM->ungrab; # better to lose the grab than the session 759 $TERM->ungrab; # better to lose the grab than the session
1037 warn $@; 760 warn $@;
1040 763
1041 verbose 11, "$HOOKNAME[$htype] returning <$retval>" 764 verbose 11, "$HOOKNAME[$htype] returning <$retval>"
1042 if $verbosity >= 11; 765 if $verbosity >= 11;
1043 } 766 }
1044 767
1045 if ($htype == 1) { # DESTROY 768 if ($htype == HOOK_DESTROY) {
1046 # clear package objects 769 # clear package objects
1047 %$_ = () for values %{ $TERM->{_pkg} }; 770 %$_ = () for values %{ $TERM->{_pkg} };
1048 771
1049 # clear package 772 # clear package
1050 %$TERM = (); 773 %$TERM = ();
1080 } 803 }
1081 } 804 }
1082 ($mask, @color{qw(fg bg)}, \@failed) 805 ($mask, @color{qw(fg bg)}, \@failed)
1083} 806}
1084 807
1085# urxvt::term::extension
1086
1087package urxvt::term::extension; 808package urxvt::term::extension;
1088 809
1089sub enable { 810=head2 The C<urxvt::term::extension> class
1090 my ($self, %hook) = @_;
1091 my $pkg = $self->{_pkg};
1092 811
1093 while (my ($name, $cb) = each %hook) { 812Each extension attached to a terminal object is represented by
1094 my $htype = $HOOKTYPE{uc $name}; 813a C<urxvt::term::extension> object.
1095 defined $htype
1096 or Carp::croak "unsupported hook type '$name'";
1097 814
1098 $self->set_should_invoke ($htype, +1) 815You can use these objects, which are passed to all callbacks to store any
1099 unless exists $self->{term}{_hook}[$htype]{$pkg}; 816state related to the terminal and extension instance.
1100 817
1101 $self->{term}{_hook}[$htype]{$pkg} = $cb; 818The methods (And data members) documented below can be called on extension
1102 } 819objects, in addition to call methods documented for the <urxvt::term>
1103} 820class.
1104 821
1105sub disable { 822=over 4
1106 my ($self, @hook) = @_;
1107 my $pkg = $self->{_pkg};
1108 823
1109 for my $name (@hook) { 824=item $urxvt_term = $self->{term}
1110 my $htype = $HOOKTYPE{uc $name};
1111 defined $htype
1112 or Carp::croak "unsupported hook type '$name'";
1113 825
1114 $self->set_should_invoke ($htype, -1) 826Returns the C<urxvt::term> object associated with this instance of the
1115 if delete $self->{term}{_hook}[$htype]{$pkg}; 827extension. This member I<must not> be changed in any way.
1116 } 828
1117} 829=cut
1118 830
1119our $AUTOLOAD; 831our $AUTOLOAD;
1120 832
1121sub AUTOLOAD { 833sub AUTOLOAD {
1122 $AUTOLOAD =~ /:([^:]+)$/ 834 $AUTOLOAD =~ /:([^:]+)$/
1135 847
1136sub DESTROY { 848sub DESTROY {
1137 # nop 849 # nop
1138} 850}
1139 851
1140# urxvt::destroy_hook 852# urxvt::destroy_hook (basically a cheap Guard:: implementation)
1141 853
1142sub urxvt::destroy_hook::DESTROY { 854sub urxvt::destroy_hook::DESTROY {
1143 ${$_[0]}->(); 855 ${$_[0]}->();
1144} 856}
1145 857
1146sub urxvt::destroy_hook(&) { 858sub urxvt::destroy_hook(&) {
1147 bless \shift, urxvt::destroy_hook:: 859 bless \shift, urxvt::destroy_hook::
1148} 860}
861
862=item $self->enable ($hook_name => $cb[, $hook_name => $cb..])
863
864Dynamically enable the given hooks (named without the C<on_> prefix) for
865this extension, replacing any hook previously installed via C<enable> in
866this extension.
867
868This is useful when you want to overwrite time-critical hooks only
869temporarily.
870
871To install additional callbacks for the same hook, you can use the C<on>
872method of the C<urxvt::term> class.
873
874=item $self->disable ($hook_name[, $hook_name..])
875
876Dynamically disable the given hooks.
877
878=cut
879
880sub enable {
881 my ($self, %hook) = @_;
882 my $pkg = $self->{_pkg};
883
884 while (my ($name, $cb) = each %hook) {
885 my $htype = $HOOKTYPE{uc $name};
886 defined $htype
887 or Carp::croak "unsupported hook type '$name'";
888
889 $self->set_should_invoke ($htype, +1)
890 unless exists $self->{term}{_hook}[$htype]{$pkg};
891
892 $self->{term}{_hook}[$htype]{$pkg} = $cb;
893 }
894}
895
896sub disable {
897 my ($self, @hook) = @_;
898 my $pkg = $self->{_pkg};
899
900 for my $name (@hook) {
901 my $htype = $HOOKTYPE{uc $name};
902 defined $htype
903 or Carp::croak "unsupported hook type '$name'";
904
905 $self->set_should_invoke ($htype, -1)
906 if delete $self->{term}{_hook}[$htype]{$pkg};
907 }
908}
909
910=item $guard = $self->on ($hook_name => $cb[, $hook_name => $cb..])
911
912Similar to the C<enable> enable, but installs additional callbacks for
913the given hook(s) (that is, it doesn't replace existing callbacks), and
914returns a guard object. When the guard object is destroyed the callbacks
915are disabled again.
916
917=cut
918
919sub urxvt::extension::on_disable::DESTROY {
920 my $disable = shift;
921
922 my $term = delete $disable->{""};
923
924 while (my ($htype, $id) = each %$disable) {
925 delete $term->{_hook}[$htype]{$id};
926 $term->set_should_invoke ($htype, -1);
927 }
928}
929
930sub on {
931 my ($self, %hook) = @_;
932
933 my $term = $self->{term};
934
935 my %disable = ( "" => $term );
936
937 while (my ($name, $cb) = each %hook) {
938 my $htype = $HOOKTYPE{uc $name};
939 defined $htype
940 or Carp::croak "unsupported hook type '$name'";
941
942 $term->set_should_invoke ($htype, +1);
943 $term->{_hook}[$htype]{ $disable{$htype} = $cb+0 }
944 = sub { shift; $cb->($self, @_) }; # very ugly indeed
945 }
946
947 bless \%disable, "urxvt::extension::on_disable"
948}
949
950=item $self->x_resource ($pattern)
951
952=item $self->x_resource_boolean ($pattern)
953
954These methods support an additional C<%> prefix when called on an
955extension object - see the description of these methods in the
956C<urxvt::term> class for details.
957
958=cut
959
960sub x_resource {
961 my ($self, $name) = @_;
962 $name =~ s/^%(\.|$)/$_[0]{_name}$1/;
963 $self->{term}->x_resource ($name)
964}
965
966sub x_resource_boolean {
967 my ($self, $name) = @_;
968 $name =~ s/^%(\.|$)/$_[0]{_name}$1/;
969 $self->{term}->x_resource_boolean ($name)
970}
971
972=back
973
974=cut
1149 975
1150package urxvt::anyevent; 976package urxvt::anyevent;
1151 977
1152=head2 The C<urxvt::anyevent> Class 978=head2 The C<urxvt::anyevent> Class
1153 979
1154The sole purpose of this class is to deliver an interface to the 980The sole purpose of this class is to deliver an interface to the
1155C<AnyEvent> module - any module using it will work inside urxvt without 981C<AnyEvent> module - any module using it will work inside urxvt without
1156further programming. The only exception is that you cannot wait on 982further programming. The only exception is that you cannot wait on
1157condition variables, but non-blocking condvar use is ok. What this means 983condition variables, but non-blocking condvar use is ok.
1158is that you cannot use blocking APIs, but the non-blocking variant should 984
1159work. 985In practical terms this means is that you cannot use blocking APIs, but
986the non-blocking variant should work.
1160 987
1161=cut 988=cut
1162 989
1163our $VERSION = '5.23'; 990our $VERSION = '5.23';
1164 991
1248 urxvt::verbose 6, "register package $pkg to $self"; 1075 urxvt::verbose 6, "register package $pkg to $self";
1249 1076
1250 @{"$pkg\::ISA"} = urxvt::term::extension::; 1077 @{"$pkg\::ISA"} = urxvt::term::extension::;
1251 1078
1252 my $proxy = bless { 1079 my $proxy = bless {
1253 _pkg => $pkg, 1080 _pkg => $pkg,
1081 _name => ${"$pkg\::_NAME"}, # hackish
1254 argv => $argv, 1082 argv => $argv,
1255 }, $pkg; 1083 }, $pkg;
1256 Scalar::Util::weaken ($proxy->{term} = $self); 1084 Scalar::Util::weaken ($proxy->{term} = $self);
1257 1085
1258 $self->{_pkg}{$pkg} = $proxy; 1086 $self->{_pkg}{$pkg} = $proxy;
1259 1087
1262 $proxy->enable ($name => $ref); 1090 $proxy->enable ($name => $ref);
1263 } 1091 }
1264 } 1092 }
1265} 1093}
1266 1094
1095sub perl_libdirs {
1096 map { split /:/ }
1097 $_[0]->resource ("perl_lib"),
1098 $ENV{URXVT_PERL_LIB},
1099 "$ENV{HOME}/.urxvt/ext",
1100 "$LIBDIR/perl"
1101}
1102
1103# scan for available extensions and collect their metadata
1104sub scan_extensions {
1105 my ($self) = @_;
1106
1107 return if exists $self->{meta};
1108
1109 my @libdirs = perl_libdirs $self;
1110
1111# return if $self->{meta_libdirs} eq join "\x00", @libdirs;#d#
1112
1113# $self->{meta_libdirs} = join "\x00", @libdirs;#d#
1114 $self->{meta} = \my %meta;
1115
1116 # first gather extensions
1117 for my $dir (reverse @libdirs) {
1118 opendir my $fh, $dir
1119 or next;
1120 for my $ext (readdir $fh) {
1121 $ext !~ /^\./
1122 and open my $fh, "<", "$dir/$ext"
1123 or next;
1124
1125 my %ext = (dir => $dir);
1126
1127 while (<$fh>) {
1128 if (/^#:META:(?:X_)?RESOURCE:(.*)/) {
1129 my ($pattern, $type, $desc) = split /:/, $1;
1130 $pattern =~ s/^%(\.|$)/$ext$1/g; # % in pattern == extension name
1131 if ($pattern =~ /[^a-zA-Z0-9\-\.]/) {
1132 warn "$dir/$ext: meta resource '$pattern' contains illegal characters (not alphanumeric nor . nor *)\n";
1133 } else {
1134 $ext{resource}{$pattern} = [$ext, $type, $desc];
1135 }
1136 } elsif (/^#:META:BINDING:(.*)/) {
1137 my ($keysym, $action) = split /:/, $1;
1138 $ext{binding}{$keysym} = [$ext, $action];
1139 } elsif (/^\s*(?:#|$)/) {
1140 # skip other comments and empty lines
1141 } else {
1142 last; # stop parsing on first non-empty non-comment line
1143 }
1144 }
1145
1146 $meta{ext}{$ext} = \%ext;
1147 }
1148 }
1149
1150 # and now merge resources and bindings
1151 while (my ($k, $v) = each %{ $meta{ext} }) {
1152 #TODO: should check for extensions overriding each other
1153 %{ $meta{resource} } = (%{ $meta{resource} }, %{ $v->{resource} });
1154 %{ $meta{binding} } = (%{ $meta{binding} }, %{ $v->{binding} });
1155 }
1156}
1157
1267=item $term = new urxvt::term $envhashref, $rxvtname, [arg...] 1158=item $term = new urxvt::term $envhashref, $rxvtname, [arg...]
1268 1159
1269Creates a new terminal, very similar as if you had started it with system 1160Creates a new terminal, very similar as if you had started it with system
1270C<$rxvtname, arg...>. C<$envhashref> must be a reference to a C<%ENV>-like 1161C<$rxvtname, arg...>. C<$envhashref> must be a reference to a C<%ENV>-like
1271hash which defines the environment of the new terminal. 1162hash which defines the environment of the new terminal.
1288} 1179}
1289 1180
1290=item $term->destroy 1181=item $term->destroy
1291 1182
1292Destroy the terminal object (close the window, free resources 1183Destroy the terminal object (close the window, free resources
1293etc.). Please note that @@RXVT_NAME@@ will not exit as long as any event 1184etc.). Please note that urxvt will not exit as long as any event
1294watchers (timers, io watchers) are still active. 1185watchers (timers, io watchers) are still active.
1295 1186
1296=item $term->exec_async ($cmd[, @args]) 1187=item $term->exec_async ($cmd[, @args])
1297 1188
1298Works like the combination of the C<fork>/C<exec> builtins, which executes 1189Works like the combination of the C<fork>/C<exec> builtins, which executes
1354 1245
1355Here is a likely non-exhaustive list of resource names, not all of which 1246Here is a likely non-exhaustive list of resource names, not all of which
1356are supported in every build, please see the source file F</src/rsinc.h> 1247are supported in every build, please see the source file F</src/rsinc.h>
1357to see the actual list: 1248to see the actual list:
1358 1249
1359 answerbackstring backgroundPixmap backspace_key blendtype blurradius 1250 answerbackstring backgroundPixmap backspace_key blurradius
1360 boldFont boldItalicFont borderLess buffered chdir color cursorBlink 1251 boldFont boldItalicFont borderLess buffered chdir color cursorBlink
1361 cursorUnderline cutchars delete_key depth display_name embed ext_bwidth 1252 cursorUnderline cutchars delete_key depth display_name embed ext_bwidth
1362 fade font geometry hold iconName iconfile imFont imLocale inputMethod 1253 fade font geometry hold iconName iconfile imFont imLocale inputMethod
1363 insecure int_bwidth intensityStyles iso14755 iso14755_52 italicFont 1254 insecure int_bwidth intensityStyles iso14755 iso14755_52 italicFont
1364 jumpScroll letterSpace lineSpace loginShell mapAlert meta8 modifier 1255 jumpScroll letterSpace lineSpace loginShell mapAlert meta8 modifier
1384Returns the X-Resource for the given pattern, excluding the program or 1275Returns the X-Resource for the given pattern, excluding the program or
1385class name, i.e. C<< $term->x_resource ("boldFont") >> should return the 1276class name, i.e. C<< $term->x_resource ("boldFont") >> should return the
1386same value as used by this instance of rxvt-unicode. Returns C<undef> if no 1277same value as used by this instance of rxvt-unicode. Returns C<undef> if no
1387resource with that pattern exists. 1278resource with that pattern exists.
1388 1279
1280Extensions that define extra resources also need to call this method
1281to access their values.
1282
1283If the method is called on an extension object (basically, from an
1284extension), then the special prefix C<%.> will be replaced by the name of
1285the extension and a dot, and the lone string C<%> will be replaced by the
1286extension name itself. This makes it possible to code extensions so you
1287can rename them and get a new set of commandline switches and resources
1288without having to change the actual code.
1289
1389This method should only be called during the C<on_start> hook, as there is 1290This method should only be called during the C<on_start> hook, as there is
1390only one resource database per display, and later invocations might return 1291only one resource database per display, and later invocations might return
1391the wrong resources. 1292the wrong resources.
1392 1293
1294=item $value = $term->x_resource_boolean ($pattern)
1295
1296Like C<x_resource>, above, but interprets the string value as a boolean
1297and returns C<1> for true values, C<0> for false values and C<undef> if
1298the resource or option isn't specified.
1299
1300You should always use this method to parse boolean resources.
1301
1302=cut
1303
1304sub x_resource_boolean {
1305 my $res = &x_resource;
1306
1307 $res =~ /^\s*(?:true|yes|on|1)\s*$/i ? 1 : defined $res && 0
1308}
1309
1393=item $success = $term->parse_keysym ($key, $octets) 1310=item $success = $term->bind_action ($key, $octets)
1394 1311
1395Adds a key binding exactly as specified via a resource. See the 1312Adds a key binding exactly as specified via a C<keysym> resource. See the
1396C<keysym> resource in the @@RXVT_NAME@@(1) manpage. 1313C<keysym> resource in the urxvt(1) manpage.
1397 1314
1398=item $rend = $term->rstyle ([$new_rstyle]) 1315=item $rend = $term->rstyle ([$new_rstyle])
1399 1316
1400Return and optionally change the current rendition. Text that is output by 1317Return and optionally change the current rendition. Text that is output by
1401the terminal application will use this style. 1318the terminal application will use this style.
1582 1499
1583Write the octets given in C<$octets> to the tty (i.e. as program input). To 1500Write the octets given in C<$octets> to the tty (i.e. as program input). To
1584pass characters instead of octets, you should convert your strings first 1501pass characters instead of octets, you should convert your strings first
1585to the locale-specific encoding using C<< $term->locale_encode >>. 1502to the locale-specific encoding using C<< $term->locale_encode >>.
1586 1503
1504=item $term->tt_write_user_input ($octets)
1505
1506Like C<tt_write>, but should be used when writing strings in response to
1507the user pressing a key, to invoke the additional actions requested by
1508the user for that case (C<tt_write> doesn't do that).
1509
1510The typical use case would be inside C<on_action> hooks.
1511
1587=item $term->tt_paste ($octets) 1512=item $term->tt_paste ($octets)
1588 1513
1589Write the octets given in C<$octets> to the tty as a paste, converting NL to 1514Write the octets given in C<$octets> to the tty as a paste, converting NL to
1590CR and bracketing the data with control sequences if bracketed paste mode 1515CR and bracketing the data with control sequences if bracketed paste mode
1591is set. 1516is set.
1614 1539
1615Adds the specified events to the vt event mask. Useful e.g. when you want 1540Adds the specified events to the vt event mask. Useful e.g. when you want
1616to receive pointer events all the times: 1541to receive pointer events all the times:
1617 1542
1618 $term->vt_emask_add (urxvt::PointerMotionMask); 1543 $term->vt_emask_add (urxvt::PointerMotionMask);
1544
1545=item $term->set_urgency ($set)
1546
1547Enable/disable the urgency hint on the toplevel window.
1619 1548
1620=item $term->focus_in 1549=item $term->focus_in
1621 1550
1622=item $term->focus_out 1551=item $term->focus_out
1623 1552
1820} 1749}
1821 1750
1822sub urxvt::line::t { 1751sub urxvt::line::t {
1823 my ($self) = @_; 1752 my ($self) = @_;
1824 1753
1825 if (@_ > 1) 1754 if (@_ > 1) {
1826 {
1827 $self->{term}->ROW_t ($_, $_[1], 0, ($_ - $self->{beg}) * $self->{ncol}, $self->{ncol}) 1755 $self->{term}->ROW_t ($_, $_[1], 0, ($_ - $self->{beg}) * $self->{ncol}, $self->{ncol})
1828 for $self->{beg} .. $self->{end}; 1756 for $self->{beg} .. $self->{end};
1829 } 1757 }
1830 1758
1831 defined wantarray && 1759 defined wantarray &&
1832 substr +(join "", map $self->{term}->ROW_t ($_), $self->{beg} .. $self->{end}), 1760 substr +(join "", map $self->{term}->ROW_t ($_), $self->{beg} .. $self->{end}),
1833 0, $self->{len} 1761 0, $self->{len}
1834} 1762}
1835 1763
1836sub urxvt::line::r { 1764sub urxvt::line::r {
1837 my ($self) = @_; 1765 my ($self) = @_;
1838 1766
1839 if (@_ > 1) 1767 if (@_ > 1) {
1840 {
1841 $self->{term}->ROW_r ($_, $_[1], 0, ($_ - $self->{beg}) * $self->{ncol}, $self->{ncol}) 1768 $self->{term}->ROW_r ($_, $_[1], 0, ($_ - $self->{beg}) * $self->{ncol}, $self->{ncol})
1842 for $self->{beg} .. $self->{end}; 1769 for $self->{beg} .. $self->{end};
1843 } 1770 }
1844 1771
1845 if (defined wantarray) { 1772 if (defined wantarray) {
1846 my $rend = [ 1773 my $rend = [
1847 map @{ $self->{term}->ROW_r ($_) }, $self->{beg} .. $self->{end} 1774 map @{ $self->{term}->ROW_r ($_) }, $self->{beg} .. $self->{end}
1848 ]; 1775 ];

Diff Legend

Removed lines
+ Added lines
< Changed lines
> Changed lines