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.92 by root, Fri Jan 13 04:59:04 2006 UTC vs.
Revision 1.108 by root, Thu Jan 19 09:47:15 2006 UTC

… …
66 URxvt.selection.pattern-0: \\|([^|]+)\\| 66 URxvt.selection.pattern-0: \\|([^|]+)\\|
67 67
68You can look at the source of the selection extension to see more 68You can look at the source of the selection extension to see more
69interesting uses, such as parsing a line from beginning to end. 69interesting uses, such as parsing a line from beginning to end.
70 70
71This extension also offers the following bindable keyboard command: 71This extension also offers following bindable keyboard commands:
72 72
73=over 4 73=over 4
74 74
75=item rot13 75=item rot13
76 76
… …
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 };
93 111
94=item searchable-scrollback<hotkey> (enabled by default) 112=item searchable-scrollback<hotkey> (enabled by default)
95 113
96Adds regex search functionality to the scrollback buffer, triggered 114Adds regex search functionality to the scrollback buffer, triggered
97by a hotkey (default: C<M-s>). While in search mode, normal terminal 115by a hotkey (default: C<M-s>). While in search mode, normal terminal
… …
120 138
121For example, the following will transform selections of the form 139For example, the following will transform selections of the form
122C<filename:number>, often seen in compiler messages, into C<vi +$filename 140C<filename:number>, often seen in compiler messages, into C<vi +$filename
123$word>: 141$word>:
124 142
125 URxvt.selection-autotransform.0: s/^(\\S+):(\\d+):?$/vi +$2 \\Q$1\\E\\x0d/ 143 URxvt.selection-autotransform.0: s/^([^:[:space:]]+):(\\d+):?$/vi +$2 \\Q$1\\E\\x0d/
126 144
127And this example matches the same,but replaces it with vi-commands you can 145And this example matches the same,but replaces it with vi-commands you can
128paste directly into your (vi :) editor: 146paste directly into your (vi :) editor:
129 147
130 URxvt.selection-autotransform.0: s/^(S+):(d+):?$/\\x1b:e \\Q$1\\E\\x0d:$2\\x0d/ 148 URxvt.selection-autotransform.0: s/^([^:[:space:]]+(\\d+):?$/:e \\Q$1\\E\\x0d:$2\\x0d/
131 149
132Of course, this can be modified to suit your needs and your editor :) 150Of course, this can be modified to suit your needs and your editor :)
133 151
134To expand the example above to typical perl error messages ("XXX at 152To expand the example above to typical perl error messages ("XXX at
135FILENAME line YYY."), you need a slightly more elaborate solution: 153FILENAME line YYY."), you need a slightly more elaborate solution:
136 154
137 URxvt.selection.pattern-0: ( at .*? line \\d+\\.) 155 URxvt.selection.pattern-0: ( at .*? line \\d+[,.])
138 URxvt.selection-autotransform.0: s/^ at (.*?) line (\\d+)\\.$/\x1b:e \\Q$1\E\\x0d:$2\\x0d/ 156 URxvt.selection-autotransform.0: s/^ at (.*?) line (\\d+)[,.]$/:e \\Q$1\E\\x0d:$2\\x0d/
139 157
140The first line tells the selection code to treat the unchanging part of 158The first line tells the selection code to treat the unchanging part of
141every error message as a selection pattern, and the second line transforms 159every error message as a selection pattern, and the second line transforms
142the message into vi commands to load the file. 160the message into vi commands to load the file.
143 161
… …
146Uses per-line display filtering (C<on_line_update>) to underline urls and 164Uses per-line display filtering (C<on_line_update>) to underline urls and
147make them clickable. When middle-clicked, the program specified in the 165make them clickable. When middle-clicked, the program specified in the
148resource C<urlLauncher> (default C<x-www-browser>) will be started with 166resource C<urlLauncher> (default C<x-www-browser>) will be started with
149the URL as first argument. 167the URL as first argument.
150 168
169=item automove-background
170
171This is basically a one-line extension that dynamically changes the background pixmap offset
172to the window position, in effect creating the same effect as pseudo transparency with
173a custom pixmap. No scaling is supported in this mode. Exmaple:
174
175 @@RXVT_NAME@@ -pixmap background.xpm -pe automove-background
176
151=item block-graphics-to-ascii 177=item block-graphics-to-ascii
152 178
153A not very useful example of filtering all text output to the terminal, 179A not very useful example of filtering all text output to the terminal,
154by replacing all line-drawing characters (U+2500 .. U+259F) by a 180by replacing all line-drawing characters (U+2500 .. U+259F) by a
155similar-looking ascii character. 181similar-looking ascii character.
… …
161=item example-refresh-hooks 187=item example-refresh-hooks
162 188
163Displays a very simple digital clock in the upper right corner of the 189Displays a very simple digital clock in the upper right corner of the
164window. Illustrates overwriting the refresh callbacks to create your own 190window. Illustrates overwriting the refresh callbacks to create your own
165overlays or changes. 191overlays or changes.
192
193=item selection-pastebin
194
195This is a little rarely useful extension that Uploads the selection as
196textfile to a remote site (or does other things). (The implementation is
197not currently secure for use in a multiuser environment as it writes to
198F</tmp> directly.).
199
200It listens to the C<selection-pastebin:remote-pastebin> keyboard command,
201i.e.
202
203 URxvt.keysym.C-M-e: perl:selection-pastebin:remote-pastebin
204
205Pressing this combination runs a command with C<%> replaced by the name of
206the textfile. This command can be set via a resource:
207
208 URxvt.selection-pastebin.cmd: rsync -apP % ruth:/var/www/www.ta-sa.org/files/txt/.
209
210And the default is likely not useful to anybody but the few people around
211here :)
212
213The name of the textfile is the hex encoded md5 sum of the selection, so
214the same content should lead to the same filename.
215
216After a successful upload the selection will be replaced by the text given
217in the C<selection-pastebin-url> resource (again, the % is the placeholder
218for the filename):
219
220 URxvt.selection-pastebin.url: http://www.ta-sa.org/files/txt/%
166 221
167=back 222=back
168 223
169=head1 API DOCUMENTATION 224=head1 API DOCUMENTATION
170 225
… …
270=item on_start $term 325=item on_start $term
271 326
272Called at the very end of initialisation of a new terminal, just before 327Called at the very end of initialisation of a new terminal, just before
273returning to the mainloop. 328returning to the mainloop.
274 329
330=item on_child_start $term, $pid
331
332Called just after the child process has been C<fork>ed.
333
334=item on_child_exit $term, $status
335
336Called just after the child process has exited. C<$status> is the status
337from C<waitpid>.
338
275=item on_sel_make $term, $eventtime 339=item on_sel_make $term, $eventtime
276 340
277Called whenever a selection has been made by the user, but before the 341Called 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 342selection text is copied, so changes to the beginning, end or type of the
279selection will be honored. 343selection will be honored.
… …
387=item on_focus_out $term 451=item on_focus_out $term
388 452
389Called wheneever the window loses keyboard focus, before rxvt-unicode does 453Called wheneever the window loses keyboard focus, before rxvt-unicode does
390focus out processing. 454focus out processing.
391 455
456=item on_configure_notify $term, $event
457
392=item on_key_press $term, $event, $keysym, $octets 458=item on_key_press $term, $event, $keysym, $octets
393 459
394=item on_key_release $term, $event, $keysym 460=item on_key_release $term, $event, $keysym
395 461
396=item on_button_press $term, $event 462=item on_button_press $term, $event
… …
480 546
481Using this function has the advantage that its output ends up in the 547Using this function has the advantage that its output ends up in the
482correct place, e.g. on stderr of the connecting urxvtc client. 548correct place, e.g. on stderr of the connecting urxvtc client.
483 549
484Messages have a size limit of 1023 bytes currently. 550Messages 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 551
492=item $time = urxvt::NOW 552=item $time = urxvt::NOW
493 553
494Returns the "current time" (as per the event loop). 554Returns the "current time" (as per the event loop).
495 555
… …
572=back 632=back
573 633
574=cut 634=cut
575 635
576BEGIN { 636BEGIN {
577 urxvt->bootstrap;
578
579 # overwrite perl's warn 637 # overwrite perl's warn
580 *CORE::GLOBAL::warn = sub { 638 *CORE::GLOBAL::warn = sub {
581 my $msg = join "", @_; 639 my $msg = join "", @_;
582 $msg .= "\n" 640 $msg .= "\n"
583 unless $msg =~ /\n$/; 641 unless $msg =~ /\n$/;
584 urxvt::warn ($msg); 642 urxvt::warn ($msg);
585 }; 643 };
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} 644}
593 645
594my $verbosity = $ENV{URXVT_PERL_VERBOSITY}; 646my $verbosity = $ENV{URXVT_PERL_VERBOSITY};
595 647
596sub verbose { 648sub verbose {
597 my ($level, $msg) = @_; 649 my ($level, $msg) = @_;
598 warn "$msg\n" if $level <= $verbosity; 650 warn "$msg\n" if $level <= $verbosity;
599} 651}
600 652
601my $extension_pkg = "extension0000";
602my %extension_pkg; 653my %extension_pkg;
603 654
604# load a single script into its own package, once only 655# load a single script into its own package, once only
605sub extension_package($) { 656sub extension_package($) {
606 my ($path) = @_; 657 my ($path) = @_;
607 658
659 no strict 'refs';
660
608 $extension_pkg{$path} ||= do { 661 $extension_pkg{$path} ||= do {
609 my $pkg = "urxvt::" . ($extension_pkg++); 662 $path =~ /([^\/\\]+)$/;
663 my $pkg = $1;
664 $pkg =~ s/[^[:word:]]/_/g;
665 $pkg = "urxvt::ext::$pkg";
610 666
611 verbose 3, "loading extension '$path' into package '$pkg'"; 667 verbose 3, "loading extension '$path' into package '$pkg'";
612 668
613 open my $fh, "<:raw", $path 669 open my $fh, "<:raw", $path
614 or die "$path: $!"; 670 or die "$path: $!";
615 671
672 @{"$pkg\::ISA"} = urxvt::term::extension::;
673
616 my $source = untaint 674 my $source =
617 "package $pkg; use strict; use utf8;\n" 675 "package $pkg; use strict; use utf8;\n"
618 . "use base urxvt::term::extension::;\n"
619 . "#line 1 \"$path\"\n{\n" 676 . "#line 1 \"$path\"\n{\n"
620 . (do { local $/; <$fh> }) 677 . (do { local $/; <$fh> })
621 . "\n};\n1"; 678 . "\n};\n1";
622 679
623 eval $source 680 eval $source
… …
696 } 753 }
697 754
698 $retval 755 $retval
699} 756}
700 757
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 758# urxvt::term::extension
714 759
715package urxvt::term::extension; 760package urxvt::term::extension;
716 761
717sub enable { 762sub enable {
… …
894 939
895Destroy the terminal object (close the window, free resources 940Destroy the terminal object (close the window, free resources
896etc.). Please note that @@RXVT_NAME@@ will not exit as long as any event 941etc.). Please note that @@RXVT_NAME@@ will not exit as long as any event
897watchers (timers, io watchers) are still active. 942watchers (timers, io watchers) are still active.
898 943
944=item $term->exec_async ($cmd[, @args])
945
946Works like the combination of the C<fork>/C<exec> builtins, which executes
947("starts") programs in the background. This function takes care of setting
948the user environment before exec'ing the command (e.g. C<PATH>) and should
949be preferred over explicit calls to C<exec> or C<system>.
950
951Returns the pid of the subprocess or C<undef> on error.
952
953=cut
954
955sub exec_async {
956 my $self = shift;
957
958 my $pid = fork;
959
960 return $pid
961 if !defined $pid or $pid;
962
963 %ENV = %{ $self->env };
964
965 exec @_;
966 urxvt::_exit 255;
967}
968
899=item $isset = $term->option ($optval[, $set]) 969=item $isset = $term->option ($optval[, $set])
900 970
901Returns true if the option specified by C<$optval> is enabled, and 971Returns true if the option specified by C<$optval> is enabled, and
902optionally change it. All option values are stored by name in the hash 972optionally 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. 973C<%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 975Here is a a likely non-exhaustive list of option names, please see the
906source file F</src/optinc.h> to see the actual list: 976source file F</src/optinc.h> to see the actual list:
907 977
908 borderLess console cursorBlink cursorUnderline hold iconic insecure 978 borderLess console cursorBlink cursorUnderline hold iconic insecure
909 intensityStyles jumpScroll loginShell mapAlert meta8 mouseWheelScrollPage 979 intensityStyles jumpScroll loginShell mapAlert meta8 mouseWheelScrollPage
910 pastableTabs pointerBlank reverseVideo scrollBar scrollBar_floating 980 override-redirect pastableTabs pointerBlank reverseVideo scrollBar
911 scrollBar_right scrollTtyKeypress scrollTtyOutput scrollWithBuffer 981 scrollBar_floating scrollBar_right scrollTtyKeypress scrollTtyOutput
912 secondaryScreen secondaryScroll skipBuiltinGlyphs transparent 982 scrollWithBuffer secondaryScreen secondaryScroll skipBuiltinGlyphs
913 tripleclickwords utmpInhibit visualBell 983 transparent tripleclickwords utmpInhibit visualBell
914 984
915=item $value = $term->resource ($name[, $newval]) 985=item $value = $term->resource ($name[, $newval])
916 986
917Returns the current resource value associated with a given name and 987Returns the current resource value associated with a given name and
918optionally sets a new value. Setting values is most useful in the C<init> 988optionally sets a new value. Setting values is most useful in the C<init>
… …
935 1005
936 answerbackstring backgroundPixmap backspace_key boldFont boldItalicFont 1006 answerbackstring backgroundPixmap backspace_key boldFont boldItalicFont
937 borderLess color cursorBlink cursorUnderline cutchars delete_key 1007 borderLess color cursorBlink cursorUnderline cutchars delete_key
938 display_name embed ext_bwidth fade font geometry hold iconName 1008 display_name embed ext_bwidth fade font geometry hold iconName
939 imFont imLocale inputMethod insecure int_bwidth intensityStyles 1009 imFont imLocale inputMethod insecure int_bwidth intensityStyles
940 italicFont jumpScroll lineSpace loginShell mapAlert menu meta8 modifier 1010 italicFont jumpScroll lineSpace loginShell mapAlert meta8 modifier
941 mouseWheelScrollPage name pastableTabs path perl_eval perl_ext_1 perl_ext_2 1011 mouseWheelScrollPage name override_redirect pastableTabs path perl_eval
942 perl_lib pointerBlank pointerBlankDelay preeditType print_pipe pty_fd 1012 perl_ext_1 perl_ext_2 perl_lib pointerBlank pointerBlankDelay
943 reverseVideo saveLines scrollBar scrollBar_align scrollBar_floating 1013 preeditType print_pipe pty_fd reverseVideo saveLines scrollBar
944 scrollBar_right scrollBar_thickness scrollTtyKeypress scrollTtyOutput 1014 scrollBar_align scrollBar_floating scrollBar_right scrollBar_thickness
945 scrollWithBuffer scrollstyle secondaryScreen secondaryScroll selectstyle 1015 scrollTtyKeypress scrollTtyOutput scrollWithBuffer scrollstyle
946 shade term_name title transparent transparent_all tripleclickwords 1016 secondaryScreen secondaryScroll selectstyle shade term_name title
947 utmpInhibit visualBell 1017 transient_for transparent transparent_all tripleclickwords utmpInhibit
1018 visualBell
948 1019
949=cut 1020=cut
950 1021
951sub resource($$;$) { 1022sub resource($$;$) {
952 my ($self, $name) = (shift, shift); 1023 my ($self, $name) = (shift, shift);
… …
1182 1253
1183=item $max_scrollback = $term->saveLines 1254=item $max_scrollback = $term->saveLines
1184 1255
1185=item $nrow_plus_saveLines = $term->total_rows 1256=item $nrow_plus_saveLines = $term->total_rows
1186 1257
1187=item $lines_in_scrollback = $term->nsaved 1258=item $topmost_scrollback_row = $term->top_row
1188 1259
1189Return various integers describing terminal characteristics. 1260Return various integers describing terminal characteristics.
1190 1261
1191=item $x_display = $term->display_id 1262=item $x_display = $term->display_id
1192 1263
… …
1220Return the modifier masks corresponding to the "ISO Level 3 Shift" (often 1291Return the modifier masks corresponding to the "ISO Level 3 Shift" (often
1221AltGr), the meta key (often Alt) and the num lock key, if applicable. 1292AltGr), the meta key (often Alt) and the num lock key, if applicable.
1222 1293
1223=item $view_start = $term->view_start ([$newvalue]) 1294=item $view_start = $term->view_start ([$newvalue])
1224 1295
1225Returns the negative row number of the topmost line. Minimum value is 1296Returns the row number of the topmost displayed line. Maximum value is
1226C<0>, which displays the normal terminal contents. Larger values scroll 1297C<0>, which displays the normal terminal contents. Lower values scroll
1227this many lines into the scrollback buffer. 1298this many lines into the scrollback buffer.
1228 1299
1229=item $term->want_refresh 1300=item $term->want_refresh
1230 1301
1231Requests a screen refresh. At the next opportunity, rxvt-unicode will 1302Requests a screen refresh. At the next opportunity, rxvt-unicode will
… …
1544 my $env = $self->{term}->env; 1615 my $env = $self->{term}->env;
1545 # we can't hope to reproduce the locale algorithm, so nuke LC_ALL and set LC_CTYPE. 1616 # we can't hope to reproduce the locale algorithm, so nuke LC_ALL and set LC_CTYPE.
1546 delete $env->{LC_ALL}; 1617 delete $env->{LC_ALL};
1547 $env->{LC_CTYPE} = $self->{term}->locale; 1618 $env->{LC_CTYPE} = $self->{term}->locale;
1548 1619
1549 urxvt::term->new ($env, $self->{term}->resource ("name"), 1620 urxvt::term->new ($env, "popup",
1550 "--perl-lib" => "", "--perl-ext-common" => "", "-pty-fd" => -1, "-sl" => 0, "-b" => 0, 1621 "--perl-lib" => "", "--perl-ext-common" => "",
1622 "-pty-fd" => -1, "-sl" => 0,
1623 "-b" => 1, "-bd" => "grey80", "-bl", "-override-redirect",
1551 "--transient-for" => $self->{term}->parent, 1624 "--transient-for" => $self->{term}->parent,
1552 "-display" => $self->{term}->display_id, 1625 "-display" => $self->{term}->display_id,
1553 "-pe" => "urxvt-popup") 1626 "-pe" => "urxvt-popup")
1554 or die "unable to create popup window\n"; 1627 or die "unable to create popup window\n";
1555} 1628}
… …
1607Start the timer. 1680Start the timer.
1608 1681
1609=item $timer = $timer->start ($tstamp) 1682=item $timer = $timer->start ($tstamp)
1610 1683
1611Set the event trigger time to C<$tstamp> and start the timer. 1684Set the event trigger time to C<$tstamp> and start the timer.
1685
1686=item $timer = $timer->after ($delay)
1687
1688Like C<start>, but sets the expiry timer to c<urxvt::NOW + $delay>.
1612 1689
1613=item $timer = $timer->stop 1690=item $timer = $timer->stop
1614 1691
1615Stop the timer. 1692Stop the timer.
1616 1693

Diff Legend

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