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.93 by root, Fri Jan 13 07:03:48 2006 UTC vs.
Revision 1.111 by root, Thu Jan 19 19:52:54 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
… …
66 URxvt.selection.pattern-0: \\|([^|]+)\\| 70 URxvt.selection.pattern-0: \\|([^|]+)\\|
67 71
68You can look at the source of the selection extension to see more 72You can look at the source of the selection extension to see more
69interesting uses, such as parsing a line from beginning to end. 73interesting uses, such as parsing a line from beginning to end.
70 74
71This extension also offers the following bindable keyboard command: 75This extension also offers following bindable keyboard commands:
72 76
73=over 4 77=over 4
74 78
75=item rot13 79=item rot13
76 80
… …
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.
… …
161=item example-refresh-hooks 192=item example-refresh-hooks
162 193
163Displays a very simple digital clock in the upper right corner of the 194Displays a very simple digital clock in the upper right corner of the
164window. Illustrates overwriting the refresh callbacks to create your own 195window. Illustrates overwriting the refresh callbacks to create your own
165overlays or changes. 196overlays or changes.
197
198=item selection-pastebin
199
200This is a little rarely useful extension that Uploads the selection as
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.).
204
205It listens to the C<selection-pastebin:remote-pastebin> keyboard command,
206i.e.
207
208 URxvt.keysym.C-M-e: perl:selection-pastebin:remote-pastebin
209
210Pressing this combination runs a command with C<%> replaced by the name of
211the textfile. This command can be set via a resource:
212
213 URxvt.selection-pastebin.cmd: rsync -apP % ruth:/var/www/www.ta-sa.org/files/txt/.
214
215And the default is likely not useful to anybody but the few people around
216here :)
217
218The name of the textfile is the hex encoded md5 sum of the selection, so
219the same content should lead to the same filename.
220
221After a successful upload the selection will be replaced by the text given
222in the C<selection-pastebin-url> resource (again, the % is the placeholder
223for the filename):
224
225 URxvt.selection-pastebin.url: http://www.ta-sa.org/files/txt/%
166 226
167=back 227=back
168 228
169=head1 API DOCUMENTATION 229=head1 API DOCUMENTATION
170 230
… …
270=item on_start $term 330=item on_start $term
271 331
272Called at the very end of initialisation of a new terminal, just before 332Called at the very end of initialisation of a new terminal, just before
273returning to the mainloop. 333returning to the mainloop.
274 334
335=item on_child_start $term, $pid
336
337Called just after the child process has been C<fork>ed.
338
339=item on_child_exit $term, $status
340
341Called just after the child process has exited. C<$status> is the status
342from C<waitpid>.
343
275=item on_sel_make $term, $eventtime 344=item on_sel_make $term, $eventtime
276 345
277Called whenever a selection has been made by the user, but before the 346Called whenever a selection has been made by the user, but before the
278selection text is copied, so changes to the beginning, end or type of the 347selection text is copied, so changes to the beginning, end or type of the
279selection will be honored. 348selection will be honored.
… …
387=item on_focus_out $term 456=item on_focus_out $term
388 457
389Called wheneever the window loses keyboard focus, before rxvt-unicode does 458Called wheneever the window loses keyboard focus, before rxvt-unicode does
390focus out processing. 459focus out processing.
391 460
461=item on_configure_notify $term, $event
462
392=item on_key_press $term, $event, $keysym, $octets 463=item on_key_press $term, $event, $keysym, $octets
393 464
394=item on_key_release $term, $event, $keysym 465=item on_key_release $term, $event, $keysym
395 466
396=item on_button_press $term, $event 467=item on_button_press $term, $event
… …
480 551
481Using this function has the advantage that its output ends up in the 552Using this function has the advantage that its output ends up in the
482correct place, e.g. on stderr of the connecting urxvtc client. 553correct place, e.g. on stderr of the connecting urxvtc client.
483 554
484Messages have a size limit of 1023 bytes currently. 555Messages have a size limit of 1023 bytes currently.
485
486=item $is_safe = urxvt::safe
487
488Returns true when it is safe to do potentially unsafe things, such as
489evaluating perl code specified by the user. This is true when urxvt was
490started setuid or setgid.
491 556
492=item $time = urxvt::NOW 557=item $time = urxvt::NOW
493 558
494Returns the "current time" (as per the event loop). 559Returns the "current time" (as per the event loop).
495 560
… …
572=back 637=back
573 638
574=cut 639=cut
575 640
576BEGIN { 641BEGIN {
577 urxvt->bootstrap;
578
579 # overwrite perl's warn 642 # overwrite perl's warn
580 *CORE::GLOBAL::warn = sub { 643 *CORE::GLOBAL::warn = sub {
581 my $msg = join "", @_; 644 my $msg = join "", @_;
582 $msg .= "\n" 645 $msg .= "\n"
583 unless $msg =~ /\n$/; 646 unless $msg =~ /\n$/;
584 urxvt::warn ($msg); 647 urxvt::warn ($msg);
585 }; 648 };
586
587 # %ENV is the original startup environment
588 delete $ENV{IFS};
589 delete $ENV{CDPATH};
590 delete $ENV{BASH_ENV};
591 $ENV{PATH} = "/bin:/sbin:/usr/bin:/usr/sbin:/usr/local/bin:/usr/local/sbin:/opt/bin:/opt/sbin";
592} 649}
593 650
594my $verbosity = $ENV{URXVT_PERL_VERBOSITY}; 651my $verbosity = $ENV{URXVT_PERL_VERBOSITY};
595 652
596sub verbose { 653sub verbose {
597 my ($level, $msg) = @_; 654 my ($level, $msg) = @_;
598 warn "$msg\n" if $level <= $verbosity; 655 warn "$msg\n" if $level <= $verbosity;
599} 656}
600 657
601my $extension_pkg = "extension0000";
602my %extension_pkg; 658my %extension_pkg;
603 659
604# load a single script into its own package, once only 660# load a single script into its own package, once only
605sub extension_package($) { 661sub extension_package($) {
606 my ($path) = @_; 662 my ($path) = @_;
607 663
664 no strict 'refs';
665
608 $extension_pkg{$path} ||= do { 666 $extension_pkg{$path} ||= do {
609 my $pkg = "urxvt::" . ($extension_pkg++); 667 $path =~ /([^\/\\]+)$/;
668 my $pkg = $1;
669 $pkg =~ s/[^[:word:]]/_/g;
670 $pkg = "urxvt::ext::$pkg";
610 671
611 verbose 3, "loading extension '$path' into package '$pkg'"; 672 verbose 3, "loading extension '$path' into package '$pkg'";
612 673
613 open my $fh, "<:raw", $path 674 open my $fh, "<:raw", $path
614 or die "$path: $!"; 675 or die "$path: $!";
615 676
677 @{"$pkg\::ISA"} = urxvt::term::extension::;
678
616 my $source = untaint 679 my $source =
617 "package $pkg; use strict; use utf8;\n" 680 "package $pkg; use strict; use utf8;\n"
618 . "use base urxvt::term::extension::;\n"
619 . "#line 1 \"$path\"\n{\n" 681 . "#line 1 \"$path\"\n{\n"
620 . (do { local $/; <$fh> }) 682 . (do { local $/; <$fh> })
621 . "\n};\n1"; 683 . "\n};\n1";
622 684
623 eval $source 685 eval $source
… …
696 } 758 }
697 759
698 $retval 760 $retval
699} 761}
700 762
701sub exec_async(@) {
702 my $pid = fork;
703
704 return
705 if !defined $pid or $pid;
706
707 %ENV = %{ $TERM->env };
708
709 exec @_;
710 _exit 255;
711}
712
713# urxvt::term::extension 763# urxvt::term::extension
714 764
715package urxvt::term::extension; 765package urxvt::term::extension;
716 766
717sub enable { 767sub enable {
… …
894 944
895Destroy the terminal object (close the window, free resources 945Destroy the terminal object (close the window, free resources
896etc.). 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
897watchers (timers, io watchers) are still active. 947watchers (timers, io watchers) are still active.
898 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
899=item $isset = $term->option ($optval[, $set]) 974=item $isset = $term->option ($optval[, $set])
900 975
901Returns true if the option specified by C<$optval> is enabled, and 976Returns true if the option specified by C<$optval> is enabled, and
902optionally 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
903C<%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.
… …
905Here 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
906source file F</src/optinc.h> to see the actual list: 981source file F</src/optinc.h> to see the actual list:
907 982
908 borderLess console cursorBlink cursorUnderline hold iconic insecure 983 borderLess console cursorBlink cursorUnderline hold iconic insecure
909 intensityStyles jumpScroll loginShell mapAlert meta8 mouseWheelScrollPage 984 intensityStyles jumpScroll loginShell mapAlert meta8 mouseWheelScrollPage
910 pastableTabs pointerBlank reverseVideo scrollBar scrollBar_floating 985 override-redirect pastableTabs pointerBlank reverseVideo scrollBar
911 scrollBar_right scrollTtyKeypress scrollTtyOutput scrollWithBuffer 986 scrollBar_floating scrollBar_right scrollTtyKeypress scrollTtyOutput
912 secondaryScreen secondaryScroll skipBuiltinGlyphs transparent 987 scrollWithBuffer secondaryScreen secondaryScroll skipBuiltinGlyphs
913 tripleclickwords utmpInhibit visualBell 988 transparent tripleclickwords utmpInhibit visualBell
914 989
915=item $value = $term->resource ($name[, $newval]) 990=item $value = $term->resource ($name[, $newval])
916 991
917Returns the current resource value associated with a given name and 992Returns the current resource value associated with a given name and
918optionally 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>
… …
935 1010
936 answerbackstring backgroundPixmap backspace_key boldFont boldItalicFont 1011 answerbackstring backgroundPixmap backspace_key boldFont boldItalicFont
937 borderLess color cursorBlink cursorUnderline cutchars delete_key 1012 borderLess color cursorBlink cursorUnderline cutchars delete_key
938 display_name embed ext_bwidth fade font geometry hold iconName 1013 display_name embed ext_bwidth fade font geometry hold iconName
939 imFont imLocale inputMethod insecure int_bwidth intensityStyles 1014 imFont imLocale inputMethod insecure int_bwidth intensityStyles
940 italicFont jumpScroll lineSpace loginShell mapAlert menu meta8 modifier 1015 italicFont jumpScroll lineSpace loginShell mapAlert meta8 modifier
941 mouseWheelScrollPage name pastableTabs path perl_eval perl_ext_1 perl_ext_2 1016 mouseWheelScrollPage name override_redirect pastableTabs path perl_eval
942 perl_lib pointerBlank pointerBlankDelay preeditType print_pipe pty_fd 1017 perl_ext_1 perl_ext_2 perl_lib pointerBlank pointerBlankDelay
943 reverseVideo saveLines scrollBar scrollBar_align scrollBar_floating 1018 preeditType print_pipe pty_fd reverseVideo saveLines scrollBar
944 scrollBar_right scrollBar_thickness scrollTtyKeypress scrollTtyOutput 1019 scrollBar_align scrollBar_floating scrollBar_right scrollBar_thickness
945 scrollWithBuffer scrollstyle secondaryScreen secondaryScroll selectstyle 1020 scrollTtyKeypress scrollTtyOutput scrollWithBuffer scrollstyle
946 shade term_name title transparent transparent_all tripleclickwords 1021 secondaryScreen secondaryScroll selectstyle shade term_name title
947 utmpInhibit visualBell 1022 transient_for transparent transparent_all tripleclickwords utmpInhibit
1023 visualBell
948 1024
949=cut 1025=cut
950 1026
951sub resource($$;$) { 1027sub resource($$;$) {
952 my ($self, $name) = (shift, shift); 1028 my ($self, $name) = (shift, shift);
… …
1182 1258
1183=item $max_scrollback = $term->saveLines 1259=item $max_scrollback = $term->saveLines
1184 1260
1185=item $nrow_plus_saveLines = $term->total_rows 1261=item $nrow_plus_saveLines = $term->total_rows
1186 1262
1187=item $lines_in_scrollback = $term->nsaved 1263=item $topmost_scrollback_row = $term->top_row
1188 1264
1189Return various integers describing terminal characteristics. 1265Return various integers describing terminal characteristics.
1190 1266
1191=item $x_display = $term->display_id 1267=item $x_display = $term->display_id
1192 1268
… …
1220Return the modifier masks corresponding to the "ISO Level 3 Shift" (often 1296Return the modifier masks corresponding to the "ISO Level 3 Shift" (often
1221AltGr), the meta key (often Alt) and the num lock key, if applicable. 1297AltGr), the meta key (often Alt) and the num lock key, if applicable.
1222 1298
1223=item $view_start = $term->view_start ([$newvalue]) 1299=item $view_start = $term->view_start ([$newvalue])
1224 1300
1225Returns the negative row number of the topmost line. Minimum value is 1301Returns the row number of the topmost displayed line. Maximum value is
1226C<0>, which displays the normal terminal contents. Larger values scroll 1302C<0>, which displays the normal terminal contents. Lower values scroll
1227this many lines into the scrollback buffer. 1303this many lines into the scrollback buffer.
1228 1304
1229=item $term->want_refresh 1305=item $term->want_refresh
1230 1306
1231Requests a screen refresh. At the next opportunity, rxvt-unicode will 1307Requests a screen refresh. At the next opportunity, rxvt-unicode will
… …
1544 my $env = $self->{term}->env; 1620 my $env = $self->{term}->env;
1545 # 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.
1546 delete $env->{LC_ALL}; 1622 delete $env->{LC_ALL};
1547 $env->{LC_CTYPE} = $self->{term}->locale; 1623 $env->{LC_CTYPE} = $self->{term}->locale;
1548 1624
1549 urxvt::term->new ($env, $self->{term}->resource ("name"), 1625 urxvt::term->new ($env, "popup",
1550 "--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",
1551 "--transient-for" => $self->{term}->parent, 1629 "--transient-for" => $self->{term}->parent,
1552 "-display" => $self->{term}->display_id, 1630 "-display" => $self->{term}->display_id,
1553 "-pe" => "urxvt-popup") 1631 "-pe" => "urxvt-popup")
1554 or die "unable to create popup window\n"; 1632 or die "unable to create popup window\n";
1555} 1633}
… …
1607Start the timer. 1685Start the timer.
1608 1686
1609=item $timer = $timer->start ($tstamp) 1687=item $timer = $timer->start ($tstamp)
1610 1688
1611Set 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>.
1612 1694
1613=item $timer = $timer->stop 1695=item $timer = $timer->stop
1614 1696
1615Stop the timer. 1697Stop the timer.
1616 1698

Diff Legend

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