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.109 by root, Thu Jan 19 16:07:09 2006 UTC

… …
88=item selection-popup (enabled by default) 88=item selection-popup (enabled by default)
89 89
90Binds a popup menu to Ctrl-Button3 that lets you convert the selection 90Binds a popup menu to Ctrl-Button3 that lets you convert the selection
91text into various other formats/action (such as uri unescaping, perl 91text into various other formats/action (such as uri unescaping, perl
92evalution, web-browser starting etc.), depending on content. 92evalution, web-browser starting etc.), depending on content.
93
94Other extensions can extend this popup menu by pushing a code reference onto
95C<@urxvt::ext::selection_popup::hook>, that is called whenever the popup is displayed.
96
97It'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.
99It 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
101when the button gets activated and should transform C<$_>.
102
103The 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
105C<a>s:
106
107 push urxvt::ext::selection_popup::hook, sub {
108 /a/ ? ("a to be" => sub { s/a/b/g }
109 : ()
110 };
111
112Don't run it in a hook, otherwise the menu will grow and grow. Instead put
113it at the toplevel of your extension.
93 114
94=item searchable-scrollback<hotkey> (enabled by default) 115=item searchable-scrollback<hotkey> (enabled by default)
95 116
96Adds regex search functionality to the scrollback buffer, triggered 117Adds regex search functionality to the scrollback buffer, triggered
97by a hotkey (default: C<M-s>). While in search mode, normal terminal 118by 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/ 146 URxvt.selection-autotransform.0: s/^([^:[:space:]]+):(\\d+):?$/vi +$2 \\Q$1\\E\\x0d/
126 147
127And this example matches the same,but replaces it with vi-commands you can 148And this example matches the same,but replaces it with vi-commands you can
128paste directly into your (vi :) editor: 149paste directly into your (vi :) editor:
129 150
130 URxvt.selection-autotransform.0: s/^([^:[:space:]]+(\\d+):?$/\\x1b:e \\Q$1\\E\\x0d:$2\\x0d/ 151 URxvt.selection-autotransform.0: s/^([^:[:space:]]+(\\d+):?$/:e \\Q$1\\E\\x0d:$2\\x0d/
131 152
132Of course, this can be modified to suit your needs and your editor :) 153Of course, this can be modified to suit your needs and your editor :)
133 154
134To expand the example above to typical perl error messages ("XXX at 155To expand the example above to typical perl error messages ("XXX at
135FILENAME line YYY."), you need a slightly more elaborate solution: 156FILENAME line YYY."), you need a slightly more elaborate solution:
136 157
137 URxvt.selection.pattern-0: ( at .*? line \\d+\\.) 158 URxvt.selection.pattern-0: ( at .*? line \\d+[,.])
138 URxvt.selection-autotransform.0: s/^ at (.*?) line (\\d+)\\.$/\x1b:e \\Q$1\E\\x0d:$2\\x0d/ 159 URxvt.selection-autotransform.0: s/^ at (.*?) line (\\d+)[,.]$/:e \\Q$1\E\\x0d:$2\\x0d/
139 160
140The first line tells the selection code to treat the unchanging part of 161The first line tells the selection code to treat the unchanging part of
141every error message as a selection pattern, and the second line transforms 162every error message as a selection pattern, and the second line transforms
142the message into vi commands to load the file. 163the message into vi commands to load the file.
143 164
… …
145 166
146Uses per-line display filtering (C<on_line_update>) to underline urls and 167Uses per-line display filtering (C<on_line_update>) to underline urls and
147make them clickable. When middle-clicked, the program specified in the 168make them clickable. When middle-clicked, the program specified in the
148resource C<urlLauncher> (default C<x-www-browser>) will be started with 169resource C<urlLauncher> (default C<x-www-browser>) will be started with
149the URL as first argument. 170the URL as first argument.
171
172=item automove-background
173
174This is basically a one-line extension that dynamically changes the background pixmap offset
175to the window position, in effect creating the same effect as pseudo transparency with
176a custom pixmap. No scaling is supported in this mode. Exmaple:
177
178 @@RXVT_NAME@@ -pixmap background.xpm -pe automove-background
150 179
151=item block-graphics-to-ascii 180=item block-graphics-to-ascii
152 181
153A not very useful example of filtering all text output to the terminal, 182A not very useful example of filtering all text output to the terminal,
154by replacing all line-drawing characters (U+2500 .. U+259F) by a 183by replacing all line-drawing characters (U+2500 .. U+259F) by a
… …
299=item on_start $term 328=item on_start $term
300 329
301Called at the very end of initialisation of a new terminal, just before 330Called at the very end of initialisation of a new terminal, just before
302returning to the mainloop. 331returning to the mainloop.
303 332
333=item on_child_start $term, $pid
334
335Called just after the child process has been C<fork>ed.
336
337=item on_child_exit $term, $status
338
339Called just after the child process has exited. C<$status> is the status
340from C<waitpid>.
341
304=item on_sel_make $term, $eventtime 342=item on_sel_make $term, $eventtime
305 343
306Called whenever a selection has been made by the user, but before the 344Called 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 345selection text is copied, so changes to the beginning, end or type of the
308selection will be honored. 346selection will be honored.
… …
415 453
416=item on_focus_out $term 454=item on_focus_out $term
417 455
418Called wheneever the window loses keyboard focus, before rxvt-unicode does 456Called wheneever the window loses keyboard focus, before rxvt-unicode does
419focus out processing. 457focus out processing.
458
459=item on_configure_notify $term, $event
420 460
421=item on_key_press $term, $event, $keysym, $octets 461=item on_key_press $term, $event, $keysym, $octets
422 462
423=item on_key_release $term, $event, $keysym 463=item on_key_release $term, $event, $keysym
424 464
… …
595=back 635=back
596 636
597=cut 637=cut
598 638
599BEGIN { 639BEGIN {
600 urxvt->bootstrap;
601
602 # overwrite perl's warn 640 # overwrite perl's warn
603 *CORE::GLOBAL::warn = sub { 641 *CORE::GLOBAL::warn = sub {
604 my $msg = join "", @_; 642 my $msg = join "", @_;
605 $msg .= "\n" 643 $msg .= "\n"
606 unless $msg =~ /\n$/; 644 unless $msg =~ /\n$/;
607 urxvt::warn ($msg); 645 urxvt::warn ($msg);
608 }; 646 };
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} 647}
616 648
617my $verbosity = $ENV{URXVT_PERL_VERBOSITY}; 649my $verbosity = $ENV{URXVT_PERL_VERBOSITY};
618 650
619sub verbose { 651sub verbose {
620 my ($level, $msg) = @_; 652 my ($level, $msg) = @_;
621 warn "$msg\n" if $level <= $verbosity; 653 warn "$msg\n" if $level <= $verbosity;
622} 654}
623 655
624my $extension_pkg = "extension0000";
625my %extension_pkg; 656my %extension_pkg;
626 657
627# load a single script into its own package, once only 658# load a single script into its own package, once only
628sub extension_package($) { 659sub extension_package($) {
629 my ($path) = @_; 660 my ($path) = @_;
630 661
662 no strict 'refs';
663
631 $extension_pkg{$path} ||= do { 664 $extension_pkg{$path} ||= do {
632 my $pkg = "urxvt::" . ($extension_pkg++); 665 $path =~ /([^\/\\]+)$/;
666 my $pkg = $1;
667 $pkg =~ s/[^[:word:]]/_/g;
668 $pkg = "urxvt::ext::$pkg";
633 669
634 verbose 3, "loading extension '$path' into package '$pkg'"; 670 verbose 3, "loading extension '$path' into package '$pkg'";
635 671
636 open my $fh, "<:raw", $path 672 open my $fh, "<:raw", $path
637 or die "$path: $!"; 673 or die "$path: $!";
638 674
675 @{"$pkg\::ISA"} = urxvt::term::extension::;
676
639 my $source = 677 my $source =
640 "package $pkg; use strict; use utf8;\n" 678 "package $pkg; use strict; use utf8;\n"
641 . "use base urxvt::term::extension::;\n"
642 . "#line 1 \"$path\"\n{\n" 679 . "#line 1 \"$path\"\n{\n"
643 . (do { local $/; <$fh> }) 680 . (do { local $/; <$fh> })
644 . "\n};\n1"; 681 . "\n};\n1";
645 682
646 eval $source 683 eval $source
… …
719 } 756 }
720 757
721 $retval 758 $retval
722} 759}
723 760
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}
735
736# urxvt::term::extension 761# urxvt::term::extension
737 762
738package urxvt::term::extension; 763package urxvt::term::extension;
739 764
740sub enable { 765sub enable {
… …
917 942
918Destroy the terminal object (close the window, free resources 943Destroy the terminal object (close the window, free resources
919etc.). Please note that @@RXVT_NAME@@ will not exit as long as any event 944etc.). Please note that @@RXVT_NAME@@ will not exit as long as any event
920watchers (timers, io watchers) are still active. 945watchers (timers, io watchers) are still active.
921 946
947=item $term->exec_async ($cmd[, @args])
948
949Works like the combination of the C<fork>/C<exec> builtins, which executes
950("starts") programs in the background. This function takes care of setting
951the user environment before exec'ing the command (e.g. C<PATH>) and should
952be preferred over explicit calls to C<exec> or C<system>.
953
954Returns the pid of the subprocess or C<undef> on error.
955
956=cut
957
958sub exec_async {
959 my $self = shift;
960
961 my $pid = fork;
962
963 return $pid
964 if !defined $pid or $pid;
965
966 %ENV = %{ $self->env };
967
968 exec @_;
969 urxvt::_exit 255;
970}
971
922=item $isset = $term->option ($optval[, $set]) 972=item $isset = $term->option ($optval[, $set])
923 973
924Returns true if the option specified by C<$optval> is enabled, and 974Returns true if the option specified by C<$optval> is enabled, and
925optionally change it. All option values are stored by name in the hash 975optionally 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. 976C<%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 978Here is a a likely non-exhaustive list of option names, please see the
929source file F</src/optinc.h> to see the actual list: 979source file F</src/optinc.h> to see the actual list:
930 980
931 borderLess console cursorBlink cursorUnderline hold iconic insecure 981 borderLess console cursorBlink cursorUnderline hold iconic insecure
932 intensityStyles jumpScroll loginShell mapAlert meta8 mouseWheelScrollPage 982 intensityStyles jumpScroll loginShell mapAlert meta8 mouseWheelScrollPage
933 pastableTabs pointerBlank reverseVideo scrollBar scrollBar_floating 983 override-redirect pastableTabs pointerBlank reverseVideo scrollBar
934 scrollBar_right scrollTtyKeypress scrollTtyOutput scrollWithBuffer 984 scrollBar_floating scrollBar_right scrollTtyKeypress scrollTtyOutput
935 secondaryScreen secondaryScroll skipBuiltinGlyphs transparent 985 scrollWithBuffer secondaryScreen secondaryScroll skipBuiltinGlyphs
936 tripleclickwords utmpInhibit visualBell 986 transparent tripleclickwords utmpInhibit visualBell
937 987
938=item $value = $term->resource ($name[, $newval]) 988=item $value = $term->resource ($name[, $newval])
939 989
940Returns the current resource value associated with a given name and 990Returns the current resource value associated with a given name and
941optionally sets a new value. Setting values is most useful in the C<init> 991optionally sets a new value. Setting values is most useful in the C<init>
… …
958 1008
959 answerbackstring backgroundPixmap backspace_key boldFont boldItalicFont 1009 answerbackstring backgroundPixmap backspace_key boldFont boldItalicFont
960 borderLess color cursorBlink cursorUnderline cutchars delete_key 1010 borderLess color cursorBlink cursorUnderline cutchars delete_key
961 display_name embed ext_bwidth fade font geometry hold iconName 1011 display_name embed ext_bwidth fade font geometry hold iconName
962 imFont imLocale inputMethod insecure int_bwidth intensityStyles 1012 imFont imLocale inputMethod insecure int_bwidth intensityStyles
963 italicFont jumpScroll lineSpace loginShell mapAlert menu meta8 modifier 1013 italicFont jumpScroll lineSpace loginShell mapAlert meta8 modifier
964 mouseWheelScrollPage name pastableTabs path perl_eval perl_ext_1 perl_ext_2 1014 mouseWheelScrollPage name override_redirect pastableTabs path perl_eval
965 perl_lib pointerBlank pointerBlankDelay preeditType print_pipe pty_fd 1015 perl_ext_1 perl_ext_2 perl_lib pointerBlank pointerBlankDelay
966 reverseVideo saveLines scrollBar scrollBar_align scrollBar_floating 1016 preeditType print_pipe pty_fd reverseVideo saveLines scrollBar
967 scrollBar_right scrollBar_thickness scrollTtyKeypress scrollTtyOutput 1017 scrollBar_align scrollBar_floating scrollBar_right scrollBar_thickness
968 scrollWithBuffer scrollstyle secondaryScreen secondaryScroll selectstyle 1018 scrollTtyKeypress scrollTtyOutput scrollWithBuffer scrollstyle
969 shade term_name title transparent transparent_all tripleclickwords 1019 secondaryScreen secondaryScroll selectstyle shade term_name title
970 utmpInhibit visualBell 1020 transient_for transparent transparent_all tripleclickwords utmpInhibit
1021 visualBell
971 1022
972=cut 1023=cut
973 1024
974sub resource($$;$) { 1025sub resource($$;$) {
975 my ($self, $name) = (shift, shift); 1026 my ($self, $name) = (shift, shift);
… …
1567 my $env = $self->{term}->env; 1618 my $env = $self->{term}->env;
1568 # we can't hope to reproduce the locale algorithm, so nuke LC_ALL and set LC_CTYPE. 1619 # we can't hope to reproduce the locale algorithm, so nuke LC_ALL and set LC_CTYPE.
1569 delete $env->{LC_ALL}; 1620 delete $env->{LC_ALL};
1570 $env->{LC_CTYPE} = $self->{term}->locale; 1621 $env->{LC_CTYPE} = $self->{term}->locale;
1571 1622
1572 urxvt::term->new ($env, $self->{term}->resource ("name"), 1623 urxvt::term->new ($env, "popup",
1573 "--perl-lib" => "", "--perl-ext-common" => "", "-pty-fd" => -1, "-sl" => 0, "-b" => 0, 1624 "--perl-lib" => "", "--perl-ext-common" => "",
1625 "-pty-fd" => -1, "-sl" => 0,
1626 "-b" => 1, "-bd" => "grey80", "-bl", "-override-redirect",
1574 "--transient-for" => $self->{term}->parent, 1627 "--transient-for" => $self->{term}->parent,
1575 "-display" => $self->{term}->display_id, 1628 "-display" => $self->{term}->display_id,
1576 "-pe" => "urxvt-popup") 1629 "-pe" => "urxvt-popup")
1577 or die "unable to create popup window\n"; 1630 or die "unable to create popup window\n";
1578} 1631}
… …
1630Start the timer. 1683Start the timer.
1631 1684
1632=item $timer = $timer->start ($tstamp) 1685=item $timer = $timer->start ($tstamp)
1633 1686
1634Set the event trigger time to C<$tstamp> and start the timer. 1687Set the event trigger time to C<$tstamp> and start the timer.
1688
1689=item $timer = $timer->after ($delay)
1690
1691Like C<start>, but sets the expiry timer to c<urxvt::NOW + $delay>.
1635 1692
1636=item $timer = $timer->stop 1693=item $timer = $timer->stop
1637 1694
1638Stop the timer. 1695Stop the timer.
1639 1696

Diff Legend

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