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.100 by root, Wed Jan 18 08:33:34 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
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
145 168
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.
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
150 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
272called whenever the relevant event happens. 303called whenever the relevant event happens.
273 304
274The 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
275the in the C<Extension Objects> section. 306the in the C<Extension Objects> section.
276 307
277B<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
278event 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
279skipped, and the relevant action might not be carried out by the C++ code. 310relevant action might not be carried out by the C++ code.
280 311
281I<< When in doubt, return a false value (preferably C<()>). >> 312I<< When in doubt, return a false value (preferably C<()>). >>
282 313
283=over 4 314=over 4
284 315
285=item on_init $term 316=item on_init $term
286 317
287Called after a new terminal object has been initialized, but before 318Called after a new terminal object has been initialized, but before
288windows 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
289call or deliver senseless data, as terminal size and other characteristics 320call or deliver senseless data, as terminal size and other characteristics
290have not yet been determined. You can safely query and change resources, 321have not yet been determined. You can safely query and change resources
291though. 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.
292 335
293=item on_reset $term 336=item on_reset $term
294 337
295Called 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
296control 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
297variables. 340variables.
298 341
299=item on_start $term 342=item on_child_start $term, $pid
300 343
301Called at the very end of initialisation of a new terminal, just before 344Called just after the child process has been C<fork>ed.
302returning 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>.
303 350
304=item on_sel_make $term, $eventtime 351=item on_sel_make $term, $eventtime
305 352
306Called 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
307selection 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
416=item on_focus_out $term 463=item on_focus_out $term
417 464
418Called wheneever the window loses keyboard focus, before rxvt-unicode does 465Called wheneever the window loses keyboard focus, before rxvt-unicode does
419focus out processing. 466focus out processing.
420 467
468=item on_configure_notify $term, $event
469
421=item on_key_press $term, $event, $keysym, $octets 470=item on_key_press $term, $event, $keysym, $octets
422 471
423=item on_key_release $term, $event, $keysym 472=item on_key_release $term, $event, $keysym
424 473
425=item on_button_press $term, $event 474=item on_button_press $term, $event
456use Scalar::Util (); 505use Scalar::Util ();
457use List::Util (); 506use List::Util ();
458 507
459our $VERSION = 1; 508our $VERSION = 1;
460our $TERM; 509our $TERM;
510our @TERM_INIT;
511our @TERM_EXT;
461our @HOOKNAME; 512our @HOOKNAME;
462our %HOOKTYPE = map +($HOOKNAME[$_] => $_), 0..$#HOOKNAME; 513our %HOOKTYPE = map +($HOOKNAME[$_] => $_), 0..$#HOOKNAME;
463our %OPTION; 514our %OPTION;
464 515
465our $LIBDIR; 516our $LIBDIR;
486 537
487=item $urxvt::TERM 538=item $urxvt::TERM
488 539
489The current terminal. This variable stores the current C<urxvt::term> 540The current terminal. This variable stores the current C<urxvt::term>
490object, 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>.
491 558
492=back 559=back
493 560
494=head2 Functions in the C<urxvt> Package 561=head2 Functions in the C<urxvt> Package
495 562
602 my $msg = join "", @_; 669 my $msg = join "", @_;
603 $msg .= "\n" 670 $msg .= "\n"
604 unless $msg =~ /\n$/; 671 unless $msg =~ /\n$/;
605 urxvt::warn ($msg); 672 urxvt::warn ($msg);
606 }; 673 };
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} 674}
614 675
615my $verbosity = $ENV{URXVT_PERL_VERBOSITY}; 676my $verbosity = $ENV{URXVT_PERL_VERBOSITY};
616 677
617sub verbose { 678sub verbose {
622my %extension_pkg; 683my %extension_pkg;
623 684
624# load a single script into its own package, once only 685# load a single script into its own package, once only
625sub extension_package($) { 686sub extension_package($) {
626 my ($path) = @_; 687 my ($path) = @_;
627
628 no strict 'refs';
629 688
630 $extension_pkg{$path} ||= do { 689 $extension_pkg{$path} ||= do {
631 $path =~ /([^\/\\]+)$/; 690 $path =~ /([^\/\\]+)$/;
632 my $pkg = $1; 691 my $pkg = $1;
633 $pkg =~ s/[^[:word:]]/_/g; 692 $pkg =~ s/[^[:word:]]/_/g;
636 verbose 3, "loading extension '$path' into package '$pkg'"; 695 verbose 3, "loading extension '$path' into package '$pkg'";
637 696
638 open my $fh, "<:raw", $path 697 open my $fh, "<:raw", $path
639 or die "$path: $!"; 698 or die "$path: $!";
640 699
641 @{"$pkg\::ISA"} = urxvt::term::extension::;
642
643 my $source = 700 my $source =
644 "package $pkg; use strict; use utf8;\n" 701 "package $pkg; use strict; use utf8;\n"
645 . "#line 1 \"$path\"\n{\n" 702 . "#line 1 \"$path\"\n{\n"
646 . (do { local $/; <$fh> }) 703 . (do { local $/; <$fh> })
647 . "\n};\n1"; 704 . "\n};\n1";
663 if ($htype == 0) { # INIT 720 if ($htype == 0) { # INIT
664 my @dirs = ((split /:/, $TERM->resource ("perl_lib")), "$LIBDIR/perl"); 721 my @dirs = ((split /:/, $TERM->resource ("perl_lib")), "$LIBDIR/perl");
665 722
666 my %ext_arg; 723 my %ext_arg;
667 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
668 for (map { split /,/, $TERM->resource ("perl_ext_$_") } 1, 2) { 734 for (grep $_, map { split /,/, $TERM->resource ("perl_ext_$_") } 1, 2) {
669 if ($_ eq "default") { 735 if ($_ eq "default") {
670 $ext_arg{$_} ||= [] for qw(selection option-popup selection-popup searchable-scrollback); 736 $ext_arg{$_} ||= [] for qw(selection option-popup selection-popup searchable-scrollback);
671 } elsif (/^-(.*)$/) { 737 } elsif (/^-(.*)$/) {
672 delete $ext_arg{$1}; 738 delete $ext_arg{$1};
673 } elsif (/^([^<]+)<(.*)>$/) { 739 } elsif (/^([^<]+)<(.*)>$/) {
698 if $verbosity >= 10; 764 if $verbosity >= 10;
699 765
700 keys %$cb; 766 keys %$cb;
701 767
702 while (my ($pkg, $cb) = each %$cb) { 768 while (my ($pkg, $cb) = each %$cb) {
703 $retval = eval { $cb->($TERM->{_pkg}{$pkg}, @_) } 769 my $retval_ = eval { $cb->($TERM->{_pkg}{$pkg}, @_) };
704 and last; 770 $retval ||= $retval_;
705 771
706 if ($@) { 772 if ($@) {
707 $TERM->ungrab; # better to lose the grab than the session 773 $TERM->ungrab; # better to lose the grab than the session
708 warn $@; 774 warn $@;
709 } 775 }
720 # clear package 786 # clear package
721 %$TERM = (); 787 %$TERM = ();
722 } 788 }
723 789
724 $retval 790 $retval
725}
726
727sub exec_async(@) {
728 my $pid = fork;
729
730 return
731 if !defined $pid or $pid;
732
733 %ENV = %{ $TERM->env };
734
735 exec @_;
736 _exit 255;
737} 791}
738 792
739# urxvt::term::extension 793# urxvt::term::extension
740 794
741package urxvt::term::extension; 795package urxvt::term::extension;
880# find on_xxx subs in the package and register them 934# find on_xxx subs in the package and register them
881# as hooks 935# as hooks
882sub register_package { 936sub register_package {
883 my ($self, $pkg, $argv) = @_; 937 my ($self, $pkg, $argv) = @_;
884 938
939 no strict 'refs';
940
941 urxvt::verbose 6, "register package $pkg to $self";
942
943 @{"$pkg\::ISA"} = urxvt::term::extension::;
944
885 my $proxy = bless { 945 my $proxy = bless {
886 _pkg => $pkg, 946 _pkg => $pkg,
887 argv => $argv, 947 argv => $argv,
888 }, $pkg; 948 }, $pkg;
889 Scalar::Util::weaken ($proxy->{term} = $self); 949 Scalar::Util::weaken ($proxy->{term} = $self);
920 980
921Destroy the terminal object (close the window, free resources 981Destroy the terminal object (close the window, free resources
922etc.). 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
923watchers (timers, io watchers) are still active. 983watchers (timers, io watchers) are still active.
924 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
925=item $isset = $term->option ($optval[, $set]) 1010=item $isset = $term->option ($optval[, $set])
926 1011
927Returns true if the option specified by C<$optval> is enabled, and 1012Returns true if the option specified by C<$optval> is enabled, and
928optionally 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
929C<%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.
931Here 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
932source file F</src/optinc.h> to see the actual list: 1017source file F</src/optinc.h> to see the actual list:
933 1018
934 borderLess console cursorBlink cursorUnderline hold iconic insecure 1019 borderLess console cursorBlink cursorUnderline hold iconic insecure
935 intensityStyles jumpScroll loginShell mapAlert meta8 mouseWheelScrollPage 1020 intensityStyles jumpScroll loginShell mapAlert meta8 mouseWheelScrollPage
936 pastableTabs pointerBlank reverseVideo scrollBar scrollBar_floating 1021 override-redirect pastableTabs pointerBlank reverseVideo scrollBar
937 scrollBar_right scrollTtyKeypress scrollTtyOutput scrollWithBuffer 1022 scrollBar_floating scrollBar_right scrollTtyKeypress scrollTtyOutput
938 secondaryScreen secondaryScroll skipBuiltinGlyphs transparent 1023 scrollWithBuffer secondaryScreen secondaryScroll skipBuiltinGlyphs
939 tripleclickwords utmpInhibit visualBell 1024 transparent tripleclickwords utmpInhibit visualBell
940 1025
941=item $value = $term->resource ($name[, $newval]) 1026=item $value = $term->resource ($name[, $newval])
942 1027
943Returns the current resource value associated with a given name and 1028Returns the current resource value associated with a given name and
944optionally 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>
961 1046
962 answerbackstring backgroundPixmap backspace_key boldFont boldItalicFont 1047 answerbackstring backgroundPixmap backspace_key boldFont boldItalicFont
963 borderLess color cursorBlink cursorUnderline cutchars delete_key 1048 borderLess color cursorBlink cursorUnderline cutchars delete_key
964 display_name embed ext_bwidth fade font geometry hold iconName 1049 display_name embed ext_bwidth fade font geometry hold iconName
965 imFont imLocale inputMethod insecure int_bwidth intensityStyles 1050 imFont imLocale inputMethod insecure int_bwidth intensityStyles
966 italicFont jumpScroll lineSpace loginShell mapAlert menu meta8 modifier 1051 italicFont jumpScroll lineSpace loginShell mapAlert meta8 modifier
967 mouseWheelScrollPage name pastableTabs path perl_eval perl_ext_1 perl_ext_2 1052 mouseWheelScrollPage name override_redirect pastableTabs path perl_eval
968 perl_lib pointerBlank pointerBlankDelay preeditType print_pipe pty_fd 1053 perl_ext_1 perl_ext_2 perl_lib pointerBlank pointerBlankDelay
969 reverseVideo saveLines scrollBar scrollBar_align scrollBar_floating 1054 preeditType print_pipe pty_fd reverseVideo saveLines scrollBar
970 scrollBar_right scrollBar_thickness scrollTtyKeypress scrollTtyOutput 1055 scrollBar_align scrollBar_floating scrollBar_right scrollBar_thickness
971 scrollWithBuffer scrollstyle secondaryScreen secondaryScroll selectstyle 1056 scrollTtyKeypress scrollTtyOutput scrollWithBuffer scrollstyle
972 shade term_name title transparent transparent_all tripleclickwords 1057 secondaryScreen secondaryScroll selectstyle shade term_name title
973 utmpInhibit visualBell 1058 transient_for transparent transparent_all tripleclickwords utmpInhibit
1059 visualBell
974 1060
975=cut 1061=cut
976 1062
977sub resource($$;$) { 1063sub resource($$;$) {
978 my ($self, $name) = (shift, shift); 1064 my ($self, $name) = (shift, shift);
1570 my $env = $self->{term}->env; 1656 my $env = $self->{term}->env;
1571 # 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.
1572 delete $env->{LC_ALL}; 1658 delete $env->{LC_ALL};
1573 $env->{LC_CTYPE} = $self->{term}->locale; 1659 $env->{LC_CTYPE} = $self->{term}->locale;
1574 1660
1575 urxvt::term->new ($env, $self->{term}->resource ("name"), 1661 urxvt::term->new ($env, "popup",
1576 "--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",
1577 "--transient-for" => $self->{term}->parent, 1665 "--transient-for" => $self->{term}->parent,
1578 "-display" => $self->{term}->display_id, 1666 "-display" => $self->{term}->display_id,
1579 "-pe" => "urxvt-popup") 1667 "-pe" => "urxvt-popup")
1580 or die "unable to create popup window\n"; 1668 or die "unable to create popup window\n";
1581} 1669}
1586 delete $self->{term}{_destroy}{$self}; 1674 delete $self->{term}{_destroy}{$self};
1587 $self->{term}->ungrab; 1675 $self->{term}->ungrab;
1588} 1676}
1589 1677
1590=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__;
1591 1688
1592=head2 The C<urxvt::timer> Class 1689=head2 The C<urxvt::timer> Class
1593 1690
1594This class implements timer watchers/events. Time is represented as a 1691This class implements timer watchers/events. Time is represented as a
1595fractional number of seconds since the epoch. Example: 1692fractional number of seconds since the epoch. Example:
1633Start the timer. 1730Start the timer.
1634 1731
1635=item $timer = $timer->start ($tstamp) 1732=item $timer = $timer->start ($tstamp)
1636 1733
1637Set 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>.
1638 1739
1639=item $timer = $timer->stop 1740=item $timer = $timer->stop
1640 1741
1641Stop the timer. 1742Stop the timer.
1642 1743

Diff Legend

Removed lines
+ Added lines
< Changed lines
> Changed lines