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.102 by root, Wed Jan 18 10:31:37 2006 UTC vs.
Revision 1.113 by root, Fri Jan 20 10:27:08 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
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.
93 97
94Other extensions can extend this popup menu by pushing a code reference onto 98Other extensions can extend this popup menu by pushing a code reference
95C<@urxvt::ext::selection_popup::hook>, that is called whenever the popup is displayed. 99onto C<@{ $term->{selection_popup_hook} }>, that is called whenever the
100popup is displayed.
96 101
97It's sole argument is the popup menu, which can be modified. The selection 102It's sole argument is the popup menu, which can be modified. The selection
98is in C<$_>, which can be used to decide wether to add something or not. 103is in C<$_>, which can be used to decide wether to add something or not.
99It should either return nothing or a string and a code reference. The 104It should either return nothing or a string and a code reference. The
100string will be used as button text and the code reference will be called 105string will be used as button text and the code reference will be called
102 107
103The following will add an entry C<a to b> that transforms all C<a>s in 108The following will add an entry C<a to b> that transforms all C<a>s in
104the selection to C<b>s, but only if the selection currently contains any 109the selection to C<b>s, but only if the selection currently contains any
105C<a>s: 110C<a>s:
106 111
107 push urxvt::ext::selection_popup::hook, sub { 112 push @{ $self->{term}{selection_popup_hook} }, sub {
108 /a/ ? ("a to be" => sub { s/a/b/g } 113 /a/ ? ("a to be" => sub { s/a/b/g }
109 : () 114 : ()
110 }; 115 };
111 116
112=item searchable-scrollback<hotkey> (enabled by default) 117=item searchable-scrollback<hotkey> (enabled by default)
143 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/
144 149
145And 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
146paste directly into your (vi :) editor: 151paste directly into your (vi :) editor:
147 152
148 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/
149 154
150Of 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 :)
151 156
152To expand the example above to typical perl error messages ("XXX at 157To expand the example above to typical perl error messages ("XXX at
153FILENAME line YYY."), you need a slightly more elaborate solution: 158FILENAME line YYY."), you need a slightly more elaborate solution:
154 159
155 URxvt.selection.pattern-0: ( at .*? line \\d+\\.) 160 URxvt.selection.pattern-0: ( at .*? line \\d+[,.])
156 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/
157 162
158The 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
159every error message as a selection pattern, and the second line transforms 164every error message as a selection pattern, and the second line transforms
160the message into vi commands to load the file. 165the message into vi commands to load the file.
161 166
163 168
164Uses 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
165make them clickable. When middle-clicked, the program specified in the 170make them clickable. When middle-clicked, the program specified in the
166resource C<urlLauncher> (default C<x-www-browser>) will be started with 171resource C<urlLauncher> (default C<x-www-browser>) will be started with
167the URL as first argument. 172the URL as first argument.
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
168 181
169=item block-graphics-to-ascii 182=item block-graphics-to-ascii
170 183
171A 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,
172by replacing all line-drawing characters (U+2500 .. U+259F) by a 185by replacing all line-drawing characters (U+2500 .. U+259F) by a
290called whenever the relevant event happens. 303called whenever the relevant event happens.
291 304
292The 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
293the in the C<Extension Objects> section. 306the in the C<Extension Objects> section.
294 307
295B<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
296event 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
297skipped, and the relevant action might not be carried out by the C++ code. 310relevant action might not be carried out by the C++ code.
298 311
299I<< When in doubt, return a false value (preferably C<()>). >> 312I<< When in doubt, return a false value (preferably C<()>). >>
300 313
301=over 4 314=over 4
302 315
303=item on_init $term 316=item on_init $term
304 317
305Called after a new terminal object has been initialized, but before 318Called after a new terminal object has been initialized, but before
306windows 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
307call or deliver senseless data, as terminal size and other characteristics 320call or deliver senseless data, as terminal size and other characteristics
308have not yet been determined. You can safely query and change resources, 321have not yet been determined. You can safely query and change resources
309though. 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
328trying to map (display) the toplevel and returning to the mainloop.
329
330=item on_destroy $term
331
332Called whenever something tries to destroy terminal, before doing anything
333yet. If this hook returns true, then destruction is skipped, but this is
334rarely a good idea.
310 335
311=item on_reset $term 336=item on_reset $term
312 337
313Called after the screen is "reset" for any reason, such as resizing or 338Called after the screen is "reset" for any reason, such as resizing or
314control sequences. Here is where you can react on changes to size-related 339control sequences. Here is where you can react on changes to size-related
315variables. 340variables.
316 341
317=item on_start $term 342=item on_child_start $term, $pid
318 343
319Called at the very end of initialisation of a new terminal, just before 344Called just after the child process has been C<fork>ed.
320returning to the mainloop. 345
346=item on_child_exit $term, $status
347
348Called just after the child process has exited. C<$status> is the status
349from C<waitpid>.
321 350
322=item on_sel_make $term, $eventtime 351=item on_sel_make $term, $eventtime
323 352
324Called whenever a selection has been made by the user, but before the 353Called whenever a selection has been made by the user, but before the
325selection text is copied, so changes to the beginning, end or type of the 354selection text is copied, so changes to the beginning, end or type of the
476use Scalar::Util (); 505use Scalar::Util ();
477use List::Util (); 506use List::Util ();
478 507
479our $VERSION = 1; 508our $VERSION = 1;
480our $TERM; 509our $TERM;
510our @TERM_INIT;
511our @TERM_EXT;
481our @HOOKNAME; 512our @HOOKNAME;
482our %HOOKTYPE = map +($HOOKNAME[$_] => $_), 0..$#HOOKNAME; 513our %HOOKTYPE = map +($HOOKNAME[$_] => $_), 0..$#HOOKNAME;
483our %OPTION; 514our %OPTION;
484 515
485our $LIBDIR; 516our $LIBDIR;
506 537
507=item $urxvt::TERM 538=item $urxvt::TERM
508 539
509The current terminal. This variable stores the current C<urxvt::term> 540The current terminal. This variable stores the current C<urxvt::term>
510object, whenever a callback/hook is executing. 541object, whenever a callback/hook is executing.
542
543=item @urxvt::TERM_INIT
544
545All coderefs in this array will be called as methods of the next newly
546created C<urxvt::term> object (during the C<on_init> phase). The array
547gets cleared before the codereferences that were in it are being executed,
548so coderefs can push themselves onto it again if they so desire.
549
550This complements to the perl-eval commandline option, but gets executed
551first.
552
553=item @urxvt::TERM_EXT
554
555Works similar to C<@TERM_INIT>, but contains perl package/class names, which
556get registered as normal extensions after calling the hooks in C<@TERM_INIT>
557but before other extensions. Gets cleared just like C<@TERM_INIT>.
511 558
512=back 559=back
513 560
514=head2 Functions in the C<urxvt> Package 561=head2 Functions in the C<urxvt> Package
515 562
622 my $msg = join "", @_; 669 my $msg = join "", @_;
623 $msg .= "\n" 670 $msg .= "\n"
624 unless $msg =~ /\n$/; 671 unless $msg =~ /\n$/;
625 urxvt::warn ($msg); 672 urxvt::warn ($msg);
626 }; 673 };
627
628 # %ENV is the original startup environment
629 delete $ENV{IFS};
630 delete $ENV{CDPATH};
631 delete $ENV{BASH_ENV};
632 $ENV{PATH} = "/bin:/sbin:/usr/bin:/usr/sbin:/usr/local/bin:/usr/local/sbin:/opt/bin:/opt/sbin";
633} 674}
634 675
635my $verbosity = $ENV{URXVT_PERL_VERBOSITY}; 676my $verbosity = $ENV{URXVT_PERL_VERBOSITY};
636 677
637sub verbose { 678sub verbose {
642my %extension_pkg; 683my %extension_pkg;
643 684
644# load a single script into its own package, once only 685# load a single script into its own package, once only
645sub extension_package($) { 686sub extension_package($) {
646 my ($path) = @_; 687 my ($path) = @_;
647
648 no strict 'refs';
649 688
650 $extension_pkg{$path} ||= do { 689 $extension_pkg{$path} ||= do {
651 $path =~ /([^\/\\]+)$/; 690 $path =~ /([^\/\\]+)$/;
652 my $pkg = $1; 691 my $pkg = $1;
653 $pkg =~ s/[^[:word:]]/_/g; 692 $pkg =~ s/[^[:word:]]/_/g;
656 verbose 3, "loading extension '$path' into package '$pkg'"; 695 verbose 3, "loading extension '$path' into package '$pkg'";
657 696
658 open my $fh, "<:raw", $path 697 open my $fh, "<:raw", $path
659 or die "$path: $!"; 698 or die "$path: $!";
660 699
661 @{"$pkg\::ISA"} = urxvt::term::extension::;
662
663 my $source = 700 my $source =
664 "package $pkg; use strict; use utf8;\n" 701 "package $pkg; use strict; use utf8;\n"
665 . "#line 1 \"$path\"\n{\n" 702 . "#line 1 \"$path\"\n{\n"
666 . (do { local $/; <$fh> }) 703 . (do { local $/; <$fh> })
667 . "\n};\n1"; 704 . "\n};\n1";
683 if ($htype == 0) { # INIT 720 if ($htype == 0) { # INIT
684 my @dirs = ((split /:/, $TERM->resource ("perl_lib")), "$LIBDIR/perl"); 721 my @dirs = ((split /:/, $TERM->resource ("perl_lib")), "$LIBDIR/perl");
685 722
686 my %ext_arg; 723 my %ext_arg;
687 724
725 {
726 my @init = @TERM_INIT;
727 @TERM_INIT = ();
728 $_->($TERM) for @init;
729 my @pkg = @TERM_EXT;
730 @TERM_EXT = ();
731 $TERM->register_package ($_) for @pkg;
732 }
733
688 for (map { split /,/, $TERM->resource ("perl_ext_$_") } 1, 2) { 734 for (grep $_, map { split /,/, $TERM->resource ("perl_ext_$_") } 1, 2) {
689 if ($_ eq "default") { 735 if ($_ eq "default") {
690 $ext_arg{$_} ||= [] for qw(selection option-popup selection-popup searchable-scrollback); 736 $ext_arg{$_} ||= [] for qw(selection option-popup selection-popup searchable-scrollback);
691 } elsif (/^-(.*)$/) { 737 } elsif (/^-(.*)$/) {
692 delete $ext_arg{$1}; 738 delete $ext_arg{$1};
693 } elsif (/^([^<]+)<(.*)>$/) { 739 } elsif (/^([^<]+)<(.*)>$/) {
718 if $verbosity >= 10; 764 if $verbosity >= 10;
719 765
720 keys %$cb; 766 keys %$cb;
721 767
722 while (my ($pkg, $cb) = each %$cb) { 768 while (my ($pkg, $cb) = each %$cb) {
723 $retval = eval { $cb->($TERM->{_pkg}{$pkg}, @_) } 769 my $retval_ = eval { $cb->($TERM->{_pkg}{$pkg}, @_) };
724 and last; 770 $retval ||= $retval_;
725 771
726 if ($@) { 772 if ($@) {
727 $TERM->ungrab; # better to lose the grab than the session 773 $TERM->ungrab; # better to lose the grab than the session
728 warn $@; 774 warn $@;
729 } 775 }
740 # clear package 786 # clear package
741 %$TERM = (); 787 %$TERM = ();
742 } 788 }
743 789
744 $retval 790 $retval
745}
746
747sub exec_async(@) {
748 my $pid = fork;
749
750 return
751 if !defined $pid or $pid;
752
753 %ENV = %{ $TERM->env };
754
755 exec @_;
756 _exit 255;
757} 791}
758 792
759# urxvt::term::extension 793# urxvt::term::extension
760 794
761package urxvt::term::extension; 795package urxvt::term::extension;
900# find on_xxx subs in the package and register them 934# find on_xxx subs in the package and register them
901# as hooks 935# as hooks
902sub register_package { 936sub register_package {
903 my ($self, $pkg, $argv) = @_; 937 my ($self, $pkg, $argv) = @_;
904 938
939 no strict 'refs';
940
941 urxvt::verbose 6, "register package $pkg to $self";
942
943 @{"$pkg\::ISA"} = urxvt::term::extension::;
944
905 my $proxy = bless { 945 my $proxy = bless {
906 _pkg => $pkg, 946 _pkg => $pkg,
907 argv => $argv, 947 argv => $argv,
908 }, $pkg; 948 }, $pkg;
909 Scalar::Util::weaken ($proxy->{term} = $self); 949 Scalar::Util::weaken ($proxy->{term} = $self);
940 980
941Destroy the terminal object (close the window, free resources 981Destroy the terminal object (close the window, free resources
942etc.). Please note that @@RXVT_NAME@@ will not exit as long as any event 982etc.). Please note that @@RXVT_NAME@@ will not exit as long as any event
943watchers (timers, io watchers) are still active. 983watchers (timers, io watchers) are still active.
944 984
985=item $term->exec_async ($cmd[, @args])
986
987Works like the combination of the C<fork>/C<exec> builtins, which executes
988("starts") programs in the background. This function takes care of setting
989the user environment before exec'ing the command (e.g. C<PATH>) and should
990be preferred over explicit calls to C<exec> or C<system>.
991
992Returns the pid of the subprocess or C<undef> on error.
993
994=cut
995
996sub exec_async {
997 my $self = shift;
998
999 my $pid = fork;
1000
1001 return $pid
1002 if !defined $pid or $pid;
1003
1004 %ENV = %{ $self->env };
1005
1006 exec @_;
1007 urxvt::_exit 255;
1008}
1009
945=item $isset = $term->option ($optval[, $set]) 1010=item $isset = $term->option ($optval[, $set])
946 1011
947Returns true if the option specified by C<$optval> is enabled, and 1012Returns true if the option specified by C<$optval> is enabled, and
948optionally change it. All option values are stored by name in the hash 1013optionally change it. All option values are stored by name in the hash
949C<%urxvt::OPTION>. Options not enabled in this binary are not in the hash. 1014C<%urxvt::OPTION>. Options not enabled in this binary are not in the hash.
951Here is a a likely non-exhaustive list of option names, please see the 1016Here is a a likely non-exhaustive list of option names, please see the
952source file F</src/optinc.h> to see the actual list: 1017source file F</src/optinc.h> to see the actual list:
953 1018
954 borderLess console cursorBlink cursorUnderline hold iconic insecure 1019 borderLess console cursorBlink cursorUnderline hold iconic insecure
955 intensityStyles jumpScroll loginShell mapAlert meta8 mouseWheelScrollPage 1020 intensityStyles jumpScroll loginShell mapAlert meta8 mouseWheelScrollPage
956 pastableTabs pointerBlank reverseVideo scrollBar scrollBar_floating 1021 override-redirect pastableTabs pointerBlank reverseVideo scrollBar
957 scrollBar_right scrollTtyKeypress scrollTtyOutput scrollWithBuffer 1022 scrollBar_floating scrollBar_right scrollTtyKeypress scrollTtyOutput
958 secondaryScreen secondaryScroll skipBuiltinGlyphs transparent 1023 scrollWithBuffer secondaryScreen secondaryScroll skipBuiltinGlyphs
959 tripleclickwords utmpInhibit visualBell 1024 transparent tripleclickwords utmpInhibit visualBell
960 1025
961=item $value = $term->resource ($name[, $newval]) 1026=item $value = $term->resource ($name[, $newval])
962 1027
963Returns the current resource value associated with a given name and 1028Returns the current resource value associated with a given name and
964optionally sets a new value. Setting values is most useful in the C<init> 1029optionally sets a new value. Setting values is most useful in the C<init>
981 1046
982 answerbackstring backgroundPixmap backspace_key boldFont boldItalicFont 1047 answerbackstring backgroundPixmap backspace_key boldFont boldItalicFont
983 borderLess color cursorBlink cursorUnderline cutchars delete_key 1048 borderLess color cursorBlink cursorUnderline cutchars delete_key
984 display_name embed ext_bwidth fade font geometry hold iconName 1049 display_name embed ext_bwidth fade font geometry hold iconName
985 imFont imLocale inputMethod insecure int_bwidth intensityStyles 1050 imFont imLocale inputMethod insecure int_bwidth intensityStyles
986 italicFont jumpScroll lineSpace loginShell mapAlert menu meta8 modifier 1051 italicFont jumpScroll lineSpace loginShell mapAlert meta8 modifier
987 mouseWheelScrollPage name pastableTabs path perl_eval perl_ext_1 perl_ext_2 1052 mouseWheelScrollPage name override_redirect pastableTabs path perl_eval
988 perl_lib pointerBlank pointerBlankDelay preeditType print_pipe pty_fd 1053 perl_ext_1 perl_ext_2 perl_lib pointerBlank pointerBlankDelay
989 reverseVideo saveLines scrollBar scrollBar_align scrollBar_floating 1054 preeditType print_pipe pty_fd reverseVideo saveLines scrollBar
990 scrollBar_right scrollBar_thickness scrollTtyKeypress scrollTtyOutput 1055 scrollBar_align scrollBar_floating scrollBar_right scrollBar_thickness
991 scrollWithBuffer scrollstyle secondaryScreen secondaryScroll selectstyle 1056 scrollTtyKeypress scrollTtyOutput scrollWithBuffer scrollstyle
992 shade term_name title transparent transparent_all tripleclickwords 1057 secondaryScreen secondaryScroll selectstyle shade term_name title
993 utmpInhibit visualBell 1058 transient_for transparent transparent_all tripleclickwords utmpInhibit
1059 visualBell
994 1060
995=cut 1061=cut
996 1062
997sub resource($$;$) { 1063sub resource($$;$) {
998 my ($self, $name) = (shift, shift); 1064 my ($self, $name) = (shift, shift);
1590 my $env = $self->{term}->env; 1656 my $env = $self->{term}->env;
1591 # we can't hope to reproduce the locale algorithm, so nuke LC_ALL and set LC_CTYPE. 1657 # we can't hope to reproduce the locale algorithm, so nuke LC_ALL and set LC_CTYPE.
1592 delete $env->{LC_ALL}; 1658 delete $env->{LC_ALL};
1593 $env->{LC_CTYPE} = $self->{term}->locale; 1659 $env->{LC_CTYPE} = $self->{term}->locale;
1594 1660
1595 urxvt::term->new ($env, $self->{term}->resource ("name"), 1661 urxvt::term->new ($env, "popup",
1596 "--perl-lib" => "", "--perl-ext-common" => "", "-pty-fd" => -1, "-sl" => 0, "-b" => 0, 1662 "--perl-lib" => "", "--perl-ext-common" => "",
1663 "-pty-fd" => -1, "-sl" => 0,
1664 "-b" => 1, "-bd" => "grey80", "-bl", "-override-redirect",
1597 "--transient-for" => $self->{term}->parent, 1665 "--transient-for" => $self->{term}->parent,
1598 "-display" => $self->{term}->display_id, 1666 "-display" => $self->{term}->display_id,
1599 "-pe" => "urxvt-popup") 1667 "-pe" => "urxvt-popup")
1600 or die "unable to create popup window\n"; 1668 or die "unable to create popup window\n";
1601} 1669}
1606 delete $self->{term}{_destroy}{$self}; 1674 delete $self->{term}{_destroy}{$self};
1607 $self->{term}->ungrab; 1675 $self->{term}->ungrab;
1608} 1676}
1609 1677
1610=back 1678=back
1679
1680=cut
1681
1682package urxvt::watcher;
1683
1684@urxvt::timer::ISA = __PACKAGE__;
1685@urxvt::iow::ISA = __PACKAGE__;
1686@urxvt::pw::ISA = __PACKAGE__;
1687@urxvt::iw::ISA = __PACKAGE__;
1611 1688
1612=head2 The C<urxvt::timer> Class 1689=head2 The C<urxvt::timer> Class
1613 1690
1614This class implements timer watchers/events. Time is represented as a 1691This class implements timer watchers/events. Time is represented as a
1615fractional number of seconds since the epoch. Example: 1692fractional number of seconds since the epoch. Example:
1653Start the timer. 1730Start the timer.
1654 1731
1655=item $timer = $timer->start ($tstamp) 1732=item $timer = $timer->start ($tstamp)
1656 1733
1657Set the event trigger time to C<$tstamp> and start the timer. 1734Set the event trigger time to C<$tstamp> and start the timer.
1735
1736=item $timer = $timer->after ($delay)
1737
1738Like C<start>, but sets the expiry timer to c<urxvt::NOW + $delay>.
1658 1739
1659=item $timer = $timer->stop 1740=item $timer = $timer->stop
1660 1741
1661Stop the timer. 1742Stop the timer.
1662 1743

Diff Legend

Removed lines
+ Added lines
< Changed lines
> Changed lines