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.98 by root, Tue Jan 17 17:01:54 2006 UTC vs.
Revision 1.112 by root, Thu Jan 19 21:02:06 2006 UTC

… …
34find them in F<@@RXVT_LIBDIR@@/urxvt/perl/>. 34find them in F<@@RXVT_LIBDIR@@/urxvt/perl/>.
35 35
36You can activate them like this: 36You can activate them like this:
37 37
38 @@RXVT_NAME@@ -pe <extensionname> 38 @@RXVT_NAME@@ -pe <extensionname>
39
40Or by adding them to the resource for extensions loaded by default:
41
42 URxvt.perl-ext-common: default,automove-background,selection-autotransform
39 43
40=over 4 44=over 4
41 45
42=item selection (enabled by default) 46=item selection (enabled by default)
43 47
… …
88=item selection-popup (enabled by default) 92=item selection-popup (enabled by default)
89 93
90Binds a popup menu to Ctrl-Button3 that lets you convert the selection 94Binds a popup menu to Ctrl-Button3 that lets you convert the selection
91text into various other formats/action (such as uri unescaping, perl 95text into various other formats/action (such as uri unescaping, perl
92evalution, web-browser starting etc.), depending on content. 96evalution, web-browser starting etc.), depending on content.
97
98Other extensions can extend this popup menu by pushing a code reference
99onto C<@{ $term->{selection_popup_hook} }>, that is called whenever the
100popup is displayed.
101
102It's sole argument is the popup menu, which can be modified. The selection
103is in C<$_>, which can be used to decide wether to add something or not.
104It should either return nothing or a string and a code reference. The
105string will be used as button text and the code reference will be called
106when the button gets activated and should transform C<$_>.
107
108The following will add an entry C<a to b> that transforms all C<a>s in
109the selection to C<b>s, but only if the selection currently contains any
110C<a>s:
111
112 push @{ $self->{term}{selection_popup_hook} }, sub {
113 /a/ ? ("a to be" => sub { s/a/b/g }
114 : ()
115 };
93 116
94=item searchable-scrollback<hotkey> (enabled by default) 117=item searchable-scrollback<hotkey> (enabled by default)
95 118
96Adds regex search functionality to the scrollback buffer, triggered 119Adds regex search functionality to the scrollback buffer, triggered
97by a hotkey (default: C<M-s>). While in search mode, normal terminal 120by a hotkey (default: C<M-s>). While in search mode, normal terminal
… …
125 URxvt.selection-autotransform.0: s/^([^:[:space:]]+):(\\d+):?$/vi +$2 \\Q$1\\E\\x0d/ 148 URxvt.selection-autotransform.0: s/^([^:[:space:]]+):(\\d+):?$/vi +$2 \\Q$1\\E\\x0d/
126 149
127And this example matches the same,but replaces it with vi-commands you can 150And this example matches the same,but replaces it with vi-commands you can
128paste directly into your (vi :) editor: 151paste directly into your (vi :) editor:
129 152
130 URxvt.selection-autotransform.0: s/^([^:[:space:]]+(\\d+):?$/\\x1b:e \\Q$1\\E\\x0d:$2\\x0d/ 153 URxvt.selection-autotransform.0: s/^([^:[:space:]]+(\\d+):?$/:e \\Q$1\\E\\x0d:$2\\x0d/
131 154
132Of course, this can be modified to suit your needs and your editor :) 155Of course, this can be modified to suit your needs and your editor :)
133 156
134To expand the example above to typical perl error messages ("XXX at 157To expand the example above to typical perl error messages ("XXX at
135FILENAME line YYY."), you need a slightly more elaborate solution: 158FILENAME line YYY."), you need a slightly more elaborate solution:
136 159
137 URxvt.selection.pattern-0: ( at .*? line \\d+\\.) 160 URxvt.selection.pattern-0: ( at .*? line \\d+[,.])
138 URxvt.selection-autotransform.0: s/^ at (.*?) line (\\d+)\\.$/\x1b:e \\Q$1\E\\x0d:$2\\x0d/ 161 URxvt.selection-autotransform.0: s/^ at (.*?) line (\\d+)[,.]$/:e \\Q$1\E\\x0d:$2\\x0d/
139 162
140The first line tells the selection code to treat the unchanging part of 163The first line tells the selection code to treat the unchanging part of
141every error message as a selection pattern, and the second line transforms 164every error message as a selection pattern, and the second line transforms
142the message into vi commands to load the file. 165the message into vi commands to load the file.
143 166
… …
146Uses per-line display filtering (C<on_line_update>) to underline urls and 169Uses per-line display filtering (C<on_line_update>) to underline urls and
147make them clickable. When middle-clicked, the program specified in the 170make them clickable. When middle-clicked, the program specified in the
148resource C<urlLauncher> (default C<x-www-browser>) will be started with 171resource C<urlLauncher> (default C<x-www-browser>) will be started with
149the URL as first argument. 172the URL as first argument.
150 173
174=item automove-background
175
176This is basically a one-line extension that dynamically changes the background pixmap offset
177to the window position, in effect creating the same effect as pseudo transparency with
178a custom pixmap. No scaling is supported in this mode. Exmaple:
179
180 @@RXVT_NAME@@ -pixmap background.xpm -pe automove-background
181
151=item block-graphics-to-ascii 182=item block-graphics-to-ascii
152 183
153A not very useful example of filtering all text output to the terminal, 184A not very useful example of filtering all text output to the terminal,
154by replacing all line-drawing characters (U+2500 .. U+259F) by a 185by replacing all line-drawing characters (U+2500 .. U+259F) by a
155similar-looking ascii character. 186similar-looking ascii character.
… …
165overlays or changes. 196overlays or changes.
166 197
167=item selection-pastebin 198=item selection-pastebin
168 199
169This is a little rarely useful extension that Uploads the selection as 200This is a little rarely useful extension that Uploads the selection as
170textfile to a remote site (or does other things). 201textfile to a remote site (or does other things). (The implementation is
202not currently secure for use in a multiuser environment as it writes to
203F</tmp> directly.).
171 204
172It listens to the C<selection-pastebin:remote-pastebin> keyboard command, 205It listens to the C<selection-pastebin:remote-pastebin> keyboard command,
173i.e. 206i.e.
174 207
175 URxvt.keysym.C-M-e: perl:selection-pastebin:remote-pastebin 208 URxvt.keysym.C-M-e: perl:selection-pastebin:remote-pastebin
… …
270called whenever the relevant event happens. 303called whenever the relevant event happens.
271 304
272The first argument passed to them is an extension oject as described in 305The first argument passed to them is an extension oject as described in
273the in the C<Extension Objects> section. 306the in the C<Extension Objects> section.
274 307
275B<All> of these hooks must return a boolean value. If it is true, then the 308B<All> of these hooks must return a boolean value. If any of the called
276event counts as being I<consumed>, and the invocation of other hooks is 309hooks returns true, then the event counts as being I<consumed>, and the
277skipped, and the relevant action might not be carried out by the C++ code. 310relevant action might not be carried out by the C++ code.
278 311
279I<< When in doubt, return a false value (preferably C<()>). >> 312I<< When in doubt, return a false value (preferably C<()>). >>
280 313
281=over 4 314=over 4
282 315
283=item on_init $term 316=item on_init $term
284 317
285Called after a new terminal object has been initialized, but before 318Called after a new terminal object has been initialized, but before
286windows are created or the command gets run. Most methods are unsafe to 319windows are created or the command gets run. Most methods are unsafe to
287call or deliver senseless data, as terminal size and other characteristics 320call or deliver senseless data, as terminal size and other characteristics
288have not yet been determined. You can safely query and change resources, 321have not yet been determined. You can safely query and change resources
289though. 322and options, though. For many purposes the C<on_start> hook is a better
323place.
324
325=item on_start $term
326
327Called at the very end of initialisation of a new terminal, just before
328returning to the mainloop.
290 329
291=item on_reset $term 330=item on_reset $term
292 331
293Called after the screen is "reset" for any reason, such as resizing or 332Called after the screen is "reset" for any reason, such as resizing or
294control sequences. Here is where you can react on changes to size-related 333control sequences. Here is where you can react on changes to size-related
295variables. 334variables.
296 335
297=item on_start $term 336=item on_child_start $term, $pid
298 337
299Called at the very end of initialisation of a new terminal, just before 338Called just after the child process has been C<fork>ed.
300returning to the mainloop. 339
340=item on_child_exit $term, $status
341
342Called just after the child process has exited. C<$status> is the status
343from C<waitpid>.
301 344
302=item on_sel_make $term, $eventtime 345=item on_sel_make $term, $eventtime
303 346
304Called whenever a selection has been made by the user, but before the 347Called whenever a selection has been made by the user, but before the
305selection text is copied, so changes to the beginning, end or type of the 348selection text is copied, so changes to the beginning, end or type of the
… …
413 456
414=item on_focus_out $term 457=item on_focus_out $term
415 458
416Called wheneever the window loses keyboard focus, before rxvt-unicode does 459Called wheneever the window loses keyboard focus, before rxvt-unicode does
417focus out processing. 460focus out processing.
461
462=item on_configure_notify $term, $event
418 463
419=item on_key_press $term, $event, $keysym, $octets 464=item on_key_press $term, $event, $keysym, $octets
420 465
421=item on_key_release $term, $event, $keysym 466=item on_key_release $term, $event, $keysym
422 467
… …
593=back 638=back
594 639
595=cut 640=cut
596 641
597BEGIN { 642BEGIN {
598 urxvt->bootstrap;
599
600 # overwrite perl's warn 643 # overwrite perl's warn
601 *CORE::GLOBAL::warn = sub { 644 *CORE::GLOBAL::warn = sub {
602 my $msg = join "", @_; 645 my $msg = join "", @_;
603 $msg .= "\n" 646 $msg .= "\n"
604 unless $msg =~ /\n$/; 647 unless $msg =~ /\n$/;
605 urxvt::warn ($msg); 648 urxvt::warn ($msg);
606 }; 649 };
607
608 # %ENV is the original startup environment
609 delete $ENV{IFS};
610 delete $ENV{CDPATH};
611 delete $ENV{BASH_ENV};
612 $ENV{PATH} = "/bin:/sbin:/usr/bin:/usr/sbin:/usr/local/bin:/usr/local/sbin:/opt/bin:/opt/sbin";
613} 650}
614 651
615my $verbosity = $ENV{URXVT_PERL_VERBOSITY}; 652my $verbosity = $ENV{URXVT_PERL_VERBOSITY};
616 653
617sub verbose { 654sub verbose {
618 my ($level, $msg) = @_; 655 my ($level, $msg) = @_;
619 warn "$msg\n" if $level <= $verbosity; 656 warn "$msg\n" if $level <= $verbosity;
620} 657}
621 658
622my $extension_pkg = "extension0000";
623my %extension_pkg; 659my %extension_pkg;
624 660
625# load a single script into its own package, once only 661# load a single script into its own package, once only
626sub extension_package($) { 662sub extension_package($) {
627 my ($path) = @_; 663 my ($path) = @_;
628 664
665 no strict 'refs';
666
629 $extension_pkg{$path} ||= do { 667 $extension_pkg{$path} ||= do {
630 my $pkg = "urxvt::" . ($extension_pkg++); 668 $path =~ /([^\/\\]+)$/;
669 my $pkg = $1;
670 $pkg =~ s/[^[:word:]]/_/g;
671 $pkg = "urxvt::ext::$pkg";
631 672
632 verbose 3, "loading extension '$path' into package '$pkg'"; 673 verbose 3, "loading extension '$path' into package '$pkg'";
633 674
634 open my $fh, "<:raw", $path 675 open my $fh, "<:raw", $path
635 or die "$path: $!"; 676 or die "$path: $!";
636 677
678 @{"$pkg\::ISA"} = urxvt::term::extension::;
679
637 my $source = 680 my $source =
638 "package $pkg; use strict; use utf8;\n" 681 "package $pkg; use strict; use utf8;\n"
639 . "use base urxvt::term::extension::;\n"
640 . "#line 1 \"$path\"\n{\n" 682 . "#line 1 \"$path\"\n{\n"
641 . (do { local $/; <$fh> }) 683 . (do { local $/; <$fh> })
642 . "\n};\n1"; 684 . "\n};\n1";
643 685
644 eval $source 686 eval $source
… …
693 if $verbosity >= 10; 735 if $verbosity >= 10;
694 736
695 keys %$cb; 737 keys %$cb;
696 738
697 while (my ($pkg, $cb) = each %$cb) { 739 while (my ($pkg, $cb) = each %$cb) {
698 $retval = eval { $cb->($TERM->{_pkg}{$pkg}, @_) } 740 $retval ||= eval { $cb->($TERM->{_pkg}{$pkg}, @_) };
699 and last;
700 741
701 if ($@) { 742 if ($@) {
702 $TERM->ungrab; # better to lose the grab than the session 743 $TERM->ungrab; # better to lose the grab than the session
703 warn $@; 744 warn $@;
704 } 745 }
… …
715 # clear package 756 # clear package
716 %$TERM = (); 757 %$TERM = ();
717 } 758 }
718 759
719 $retval 760 $retval
720}
721
722sub exec_async(@) {
723 my $pid = fork;
724
725 return
726 if !defined $pid or $pid;
727
728 %ENV = %{ $TERM->env };
729
730 exec @_;
731 _exit 255;
732} 761}
733 762
734# urxvt::term::extension 763# urxvt::term::extension
735 764
736package urxvt::term::extension; 765package urxvt::term::extension;
… …
915 944
916Destroy the terminal object (close the window, free resources 945Destroy the terminal object (close the window, free resources
917etc.). Please note that @@RXVT_NAME@@ will not exit as long as any event 946etc.). Please note that @@RXVT_NAME@@ will not exit as long as any event
918watchers (timers, io watchers) are still active. 947watchers (timers, io watchers) are still active.
919 948
949=item $term->exec_async ($cmd[, @args])
950
951Works like the combination of the C<fork>/C<exec> builtins, which executes
952("starts") programs in the background. This function takes care of setting
953the user environment before exec'ing the command (e.g. C<PATH>) and should
954be preferred over explicit calls to C<exec> or C<system>.
955
956Returns the pid of the subprocess or C<undef> on error.
957
958=cut
959
960sub exec_async {
961 my $self = shift;
962
963 my $pid = fork;
964
965 return $pid
966 if !defined $pid or $pid;
967
968 %ENV = %{ $self->env };
969
970 exec @_;
971 urxvt::_exit 255;
972}
973
920=item $isset = $term->option ($optval[, $set]) 974=item $isset = $term->option ($optval[, $set])
921 975
922Returns true if the option specified by C<$optval> is enabled, and 976Returns true if the option specified by C<$optval> is enabled, and
923optionally change it. All option values are stored by name in the hash 977optionally change it. All option values are stored by name in the hash
924C<%urxvt::OPTION>. Options not enabled in this binary are not in the hash. 978C<%urxvt::OPTION>. Options not enabled in this binary are not in the hash.
… …
926Here is a a likely non-exhaustive list of option names, please see the 980Here is a a likely non-exhaustive list of option names, please see the
927source file F</src/optinc.h> to see the actual list: 981source file F</src/optinc.h> to see the actual list:
928 982
929 borderLess console cursorBlink cursorUnderline hold iconic insecure 983 borderLess console cursorBlink cursorUnderline hold iconic insecure
930 intensityStyles jumpScroll loginShell mapAlert meta8 mouseWheelScrollPage 984 intensityStyles jumpScroll loginShell mapAlert meta8 mouseWheelScrollPage
931 pastableTabs pointerBlank reverseVideo scrollBar scrollBar_floating 985 override-redirect pastableTabs pointerBlank reverseVideo scrollBar
932 scrollBar_right scrollTtyKeypress scrollTtyOutput scrollWithBuffer 986 scrollBar_floating scrollBar_right scrollTtyKeypress scrollTtyOutput
933 secondaryScreen secondaryScroll skipBuiltinGlyphs transparent 987 scrollWithBuffer secondaryScreen secondaryScroll skipBuiltinGlyphs
934 tripleclickwords utmpInhibit visualBell 988 transparent tripleclickwords utmpInhibit visualBell
935 989
936=item $value = $term->resource ($name[, $newval]) 990=item $value = $term->resource ($name[, $newval])
937 991
938Returns the current resource value associated with a given name and 992Returns the current resource value associated with a given name and
939optionally sets a new value. Setting values is most useful in the C<init> 993optionally sets a new value. Setting values is most useful in the C<init>
… …
956 1010
957 answerbackstring backgroundPixmap backspace_key boldFont boldItalicFont 1011 answerbackstring backgroundPixmap backspace_key boldFont boldItalicFont
958 borderLess color cursorBlink cursorUnderline cutchars delete_key 1012 borderLess color cursorBlink cursorUnderline cutchars delete_key
959 display_name embed ext_bwidth fade font geometry hold iconName 1013 display_name embed ext_bwidth fade font geometry hold iconName
960 imFont imLocale inputMethod insecure int_bwidth intensityStyles 1014 imFont imLocale inputMethod insecure int_bwidth intensityStyles
961 italicFont jumpScroll lineSpace loginShell mapAlert menu meta8 modifier 1015 italicFont jumpScroll lineSpace loginShell mapAlert meta8 modifier
962 mouseWheelScrollPage name pastableTabs path perl_eval perl_ext_1 perl_ext_2 1016 mouseWheelScrollPage name override_redirect pastableTabs path perl_eval
963 perl_lib pointerBlank pointerBlankDelay preeditType print_pipe pty_fd 1017 perl_ext_1 perl_ext_2 perl_lib pointerBlank pointerBlankDelay
964 reverseVideo saveLines scrollBar scrollBar_align scrollBar_floating 1018 preeditType print_pipe pty_fd reverseVideo saveLines scrollBar
965 scrollBar_right scrollBar_thickness scrollTtyKeypress scrollTtyOutput 1019 scrollBar_align scrollBar_floating scrollBar_right scrollBar_thickness
966 scrollWithBuffer scrollstyle secondaryScreen secondaryScroll selectstyle 1020 scrollTtyKeypress scrollTtyOutput scrollWithBuffer scrollstyle
967 shade term_name title transparent transparent_all tripleclickwords 1021 secondaryScreen secondaryScroll selectstyle shade term_name title
968 utmpInhibit visualBell 1022 transient_for transparent transparent_all tripleclickwords utmpInhibit
1023 visualBell
969 1024
970=cut 1025=cut
971 1026
972sub resource($$;$) { 1027sub resource($$;$) {
973 my ($self, $name) = (shift, shift); 1028 my ($self, $name) = (shift, shift);
… …
1565 my $env = $self->{term}->env; 1620 my $env = $self->{term}->env;
1566 # we can't hope to reproduce the locale algorithm, so nuke LC_ALL and set LC_CTYPE. 1621 # we can't hope to reproduce the locale algorithm, so nuke LC_ALL and set LC_CTYPE.
1567 delete $env->{LC_ALL}; 1622 delete $env->{LC_ALL};
1568 $env->{LC_CTYPE} = $self->{term}->locale; 1623 $env->{LC_CTYPE} = $self->{term}->locale;
1569 1624
1570 urxvt::term->new ($env, $self->{term}->resource ("name"), 1625 urxvt::term->new ($env, "popup",
1571 "--perl-lib" => "", "--perl-ext-common" => "", "-pty-fd" => -1, "-sl" => 0, "-b" => 0, 1626 "--perl-lib" => "", "--perl-ext-common" => "",
1627 "-pty-fd" => -1, "-sl" => 0,
1628 "-b" => 1, "-bd" => "grey80", "-bl", "-override-redirect",
1572 "--transient-for" => $self->{term}->parent, 1629 "--transient-for" => $self->{term}->parent,
1573 "-display" => $self->{term}->display_id, 1630 "-display" => $self->{term}->display_id,
1574 "-pe" => "urxvt-popup") 1631 "-pe" => "urxvt-popup")
1575 or die "unable to create popup window\n"; 1632 or die "unable to create popup window\n";
1576} 1633}
… …
1628Start the timer. 1685Start the timer.
1629 1686
1630=item $timer = $timer->start ($tstamp) 1687=item $timer = $timer->start ($tstamp)
1631 1688
1632Set the event trigger time to C<$tstamp> and start the timer. 1689Set the event trigger time to C<$tstamp> and start the timer.
1690
1691=item $timer = $timer->after ($delay)
1692
1693Like C<start>, but sets the expiry timer to c<urxvt::NOW + $delay>.
1633 1694
1634=item $timer = $timer->stop 1695=item $timer = $timer->stop
1635 1696
1636Stop the timer. 1697Stop the timer.
1637 1698

Diff Legend

– Removed lines
+ Added lines
< Changed lines
> Changed lines