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.99 by root, Tue Jan 17 17:09:26 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
… …
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
328returning to the mainloop.
292 329
293=item on_reset $term 330=item on_reset $term
294 331
295Called 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
296control 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
297variables. 334variables.
298 335
299=item on_start $term 336=item on_child_start $term, $pid
300 337
301Called at the very end of initialisation of a new terminal, just before 338Called just after the child process has been C<fork>ed.
302returning 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>.
303 344
304=item on_sel_make $term, $eventtime 345=item on_sel_make $term, $eventtime
305 346
306Called 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
307selection 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
… …
415 456
416=item on_focus_out $term 457=item on_focus_out $term
417 458
418Called wheneever the window loses keyboard focus, before rxvt-unicode does 459Called wheneever the window loses keyboard focus, before rxvt-unicode does
419focus out processing. 460focus out processing.
461
462=item on_configure_notify $term, $event
420 463
421=item on_key_press $term, $event, $keysym, $octets 464=item on_key_press $term, $event, $keysym, $octets
422 465
423=item on_key_release $term, $event, $keysym 466=item on_key_release $term, $event, $keysym
424 467
… …
595=back 638=back
596 639
597=cut 640=cut
598 641
599BEGIN { 642BEGIN {
600 urxvt->bootstrap;
601
602 # overwrite perl's warn 643 # overwrite perl's warn
603 *CORE::GLOBAL::warn = sub { 644 *CORE::GLOBAL::warn = sub {
604 my $msg = join "", @_; 645 my $msg = join "", @_;
605 $msg .= "\n" 646 $msg .= "\n"
606 unless $msg =~ /\n$/; 647 unless $msg =~ /\n$/;
607 urxvt::warn ($msg); 648 urxvt::warn ($msg);
608 }; 649 };
609
610 # %ENV is the original startup environment
611 delete $ENV{IFS};
612 delete $ENV{CDPATH};
613 delete $ENV{BASH_ENV};
614 $ENV{PATH} = "/bin:/sbin:/usr/bin:/usr/sbin:/usr/local/bin:/usr/local/sbin:/opt/bin:/opt/sbin";
615} 650}
616 651
617my $verbosity = $ENV{URXVT_PERL_VERBOSITY}; 652my $verbosity = $ENV{URXVT_PERL_VERBOSITY};
618 653
619sub verbose { 654sub verbose {
620 my ($level, $msg) = @_; 655 my ($level, $msg) = @_;
621 warn "$msg\n" if $level <= $verbosity; 656 warn "$msg\n" if $level <= $verbosity;
622} 657}
623 658
624my $extension_pkg = "extension0000";
625my %extension_pkg; 659my %extension_pkg;
626 660
627# load a single script into its own package, once only 661# load a single script into its own package, once only
628sub extension_package($) { 662sub extension_package($) {
629 my ($path) = @_; 663 my ($path) = @_;
630 664
665 no strict 'refs';
666
631 $extension_pkg{$path} ||= do { 667 $extension_pkg{$path} ||= do {
632 my $pkg = "urxvt::" . ($extension_pkg++); 668 $path =~ /([^\/\\]+)$/;
669 my $pkg = $1;
670 $pkg =~ s/[^[:word:]]/_/g;
671 $pkg = "urxvt::ext::$pkg";
633 672
634 verbose 3, "loading extension '$path' into package '$pkg'"; 673 verbose 3, "loading extension '$path' into package '$pkg'";
635 674
636 open my $fh, "<:raw", $path 675 open my $fh, "<:raw", $path
637 or die "$path: $!"; 676 or die "$path: $!";
638 677
678 @{"$pkg\::ISA"} = urxvt::term::extension::;
679
639 my $source = 680 my $source =
640 "package $pkg; use strict; use utf8;\n" 681 "package $pkg; use strict; use utf8;\n"
641 . "use base urxvt::term::extension::;\n"
642 . "#line 1 \"$path\"\n{\n" 682 . "#line 1 \"$path\"\n{\n"
643 . (do { local $/; <$fh> }) 683 . (do { local $/; <$fh> })
644 . "\n};\n1"; 684 . "\n};\n1";
645 685
646 eval $source 686 eval $source
… …
695 if $verbosity >= 10; 735 if $verbosity >= 10;
696 736
697 keys %$cb; 737 keys %$cb;
698 738
699 while (my ($pkg, $cb) = each %$cb) { 739 while (my ($pkg, $cb) = each %$cb) {
700 $retval = eval { $cb->($TERM->{_pkg}{$pkg}, @_) } 740 $retval ||= eval { $cb->($TERM->{_pkg}{$pkg}, @_) };
701 and last;
702 741
703 if ($@) { 742 if ($@) {
704 $TERM->ungrab; # better to lose the grab than the session 743 $TERM->ungrab; # better to lose the grab than the session
705 warn $@; 744 warn $@;
706 } 745 }
… …
717 # clear package 756 # clear package
718 %$TERM = (); 757 %$TERM = ();
719 } 758 }
720 759
721 $retval 760 $retval
722}
723
724sub exec_async(@) {
725 my $pid = fork;
726
727 return
728 if !defined $pid or $pid;
729
730 %ENV = %{ $TERM->env };
731
732 exec @_;
733 _exit 255;
734} 761}
735 762
736# urxvt::term::extension 763# urxvt::term::extension
737 764
738package urxvt::term::extension; 765package urxvt::term::extension;
… …
917 944
918Destroy the terminal object (close the window, free resources 945Destroy the terminal object (close the window, free resources
919etc.). 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
920watchers (timers, io watchers) are still active. 947watchers (timers, io watchers) are still active.
921 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
922=item $isset = $term->option ($optval[, $set]) 974=item $isset = $term->option ($optval[, $set])
923 975
924Returns true if the option specified by C<$optval> is enabled, and 976Returns true if the option specified by C<$optval> is enabled, and
925optionally 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
926C<%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.
… …
928Here 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
929source file F</src/optinc.h> to see the actual list: 981source file F</src/optinc.h> to see the actual list:
930 982
931 borderLess console cursorBlink cursorUnderline hold iconic insecure 983 borderLess console cursorBlink cursorUnderline hold iconic insecure
932 intensityStyles jumpScroll loginShell mapAlert meta8 mouseWheelScrollPage 984 intensityStyles jumpScroll loginShell mapAlert meta8 mouseWheelScrollPage
933 pastableTabs pointerBlank reverseVideo scrollBar scrollBar_floating 985 override-redirect pastableTabs pointerBlank reverseVideo scrollBar
934 scrollBar_right scrollTtyKeypress scrollTtyOutput scrollWithBuffer 986 scrollBar_floating scrollBar_right scrollTtyKeypress scrollTtyOutput
935 secondaryScreen secondaryScroll skipBuiltinGlyphs transparent 987 scrollWithBuffer secondaryScreen secondaryScroll skipBuiltinGlyphs
936 tripleclickwords utmpInhibit visualBell 988 transparent tripleclickwords utmpInhibit visualBell
937 989
938=item $value = $term->resource ($name[, $newval]) 990=item $value = $term->resource ($name[, $newval])
939 991
940Returns the current resource value associated with a given name and 992Returns the current resource value associated with a given name and
941optionally 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>
… …
958 1010
959 answerbackstring backgroundPixmap backspace_key boldFont boldItalicFont 1011 answerbackstring backgroundPixmap backspace_key boldFont boldItalicFont
960 borderLess color cursorBlink cursorUnderline cutchars delete_key 1012 borderLess color cursorBlink cursorUnderline cutchars delete_key
961 display_name embed ext_bwidth fade font geometry hold iconName 1013 display_name embed ext_bwidth fade font geometry hold iconName
962 imFont imLocale inputMethod insecure int_bwidth intensityStyles 1014 imFont imLocale inputMethod insecure int_bwidth intensityStyles
963 italicFont jumpScroll lineSpace loginShell mapAlert menu meta8 modifier 1015 italicFont jumpScroll lineSpace loginShell mapAlert meta8 modifier
964 mouseWheelScrollPage name pastableTabs path perl_eval perl_ext_1 perl_ext_2 1016 mouseWheelScrollPage name override_redirect pastableTabs path perl_eval
965 perl_lib pointerBlank pointerBlankDelay preeditType print_pipe pty_fd 1017 perl_ext_1 perl_ext_2 perl_lib pointerBlank pointerBlankDelay
966 reverseVideo saveLines scrollBar scrollBar_align scrollBar_floating 1018 preeditType print_pipe pty_fd reverseVideo saveLines scrollBar
967 scrollBar_right scrollBar_thickness scrollTtyKeypress scrollTtyOutput 1019 scrollBar_align scrollBar_floating scrollBar_right scrollBar_thickness
968 scrollWithBuffer scrollstyle secondaryScreen secondaryScroll selectstyle 1020 scrollTtyKeypress scrollTtyOutput scrollWithBuffer scrollstyle
969 shade term_name title transparent transparent_all tripleclickwords 1021 secondaryScreen secondaryScroll selectstyle shade term_name title
970 utmpInhibit visualBell 1022 transient_for transparent transparent_all tripleclickwords utmpInhibit
1023 visualBell
971 1024
972=cut 1025=cut
973 1026
974sub resource($$;$) { 1027sub resource($$;$) {
975 my ($self, $name) = (shift, shift); 1028 my ($self, $name) = (shift, shift);
… …
1567 my $env = $self->{term}->env; 1620 my $env = $self->{term}->env;
1568 # 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.
1569 delete $env->{LC_ALL}; 1622 delete $env->{LC_ALL};
1570 $env->{LC_CTYPE} = $self->{term}->locale; 1623 $env->{LC_CTYPE} = $self->{term}->locale;
1571 1624
1572 urxvt::term->new ($env, $self->{term}->resource ("name"), 1625 urxvt::term->new ($env, "popup",
1573 "--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",
1574 "--transient-for" => $self->{term}->parent, 1629 "--transient-for" => $self->{term}->parent,
1575 "-display" => $self->{term}->display_id, 1630 "-display" => $self->{term}->display_id,
1576 "-pe" => "urxvt-popup") 1631 "-pe" => "urxvt-popup")
1577 or die "unable to create popup window\n"; 1632 or die "unable to create popup window\n";
1578} 1633}
… …
1630Start the timer. 1685Start the timer.
1631 1686
1632=item $timer = $timer->start ($tstamp) 1687=item $timer = $timer->start ($tstamp)
1633 1688
1634Set 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>.
1635 1694
1636=item $timer = $timer->stop 1695=item $timer = $timer->stop
1637 1696
1638Stop the timer. 1697Stop the timer.
1639 1698

Diff Legend

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