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.55 by root, Sun Jan 8 05:50:27 2006 UTC vs.
Revision 1.66 by root, Mon Jan 9 19:28:39 2006 UTC

58 58
59=back 59=back
60 60
61=item option-popup (enabled by default) 61=item option-popup (enabled by default)
62 62
63Binds a popup menu to Ctrl-Button3 that lets you toggle (some) options at 63Binds a popup menu to Ctrl-Button2 that lets you toggle (some) options at
64runtime. 64runtime.
65
66=item selection-popup (enabled by default)
67
68Binds a popup menu to Ctrl-Button3 that lets you convert the selection
69text into various other formats/action.
65 70
66=item digital-clock 71=item digital-clock
67 72
68Displays a digital clock using the built-in overlay. 73Displays a digital clock using the built-in overlay.
69 74
200 205
201It is called before lines are scrolled out (so rows 0 .. min ($lines - 1, 206It is called before lines are scrolled out (so rows 0 .. min ($lines - 1,
202$nrow - 1) represent the lines to be scrolled out). C<$saved> is the total 207$nrow - 1) represent the lines to be scrolled out). C<$saved> is the total
203number of lines that will be in the scrollback buffer. 208number of lines that will be in the scrollback buffer.
204 209
205=item on_tty_activity $term *NYI*
206
207Called whenever the program(s) running in the urxvt window send output.
208
209=item on_osc_seq $term, $string 210=item on_osc_seq $term, $string
210 211
211Called whenever the B<ESC ] 777 ; string ST> command sequence (OSC = 212Called whenever the B<ESC ] 777 ; string ST> command sequence (OSC =
212operating system command) is processed. Cursor position and other state 213operating system command) is processed. Cursor position and other state
213information is up-to-date when this happens. For interoperability, the 214information is up-to-date when this happens. For interoperability, the
331newline. The module also overwrites the C<warn> builtin with a function 332newline. The module also overwrites the C<warn> builtin with a function
332that calls this function. 333that calls this function.
333 334
334Using this function has the advantage that its output ends up in the 335Using this function has the advantage that its output ends up in the
335correct place, e.g. on stderr of the connecting urxvtc client. 336correct place, e.g. on stderr of the connecting urxvtc client.
337
338=item $is_safe = urxvt::safe
339
340Returns true when it is safe to do potentially unsafe things, such as
341evaluating perl code specified by the user. This is true when urxvt was
342started setuid or setgid.
336 343
337=item $time = urxvt::NOW 344=item $time = urxvt::NOW
338 345
339Returns the "current time" (as per the event loop). 346Returns the "current time" (as per the event loop).
340 347
423 my $msg = join "", @_; 430 my $msg = join "", @_;
424 $msg .= "\n" 431 $msg .= "\n"
425 unless $msg =~ /\n$/; 432 unless $msg =~ /\n$/;
426 urxvt::warn ($msg); 433 urxvt::warn ($msg);
427 }; 434 };
435
436 delete $ENV{IFS};
437 delete $ENV{CDPATH};
438 delete $ENV{BASH_ENV};
439 $ENV{PATH} = "/bin:/sbin:/usr/bin:/usr/sbin:/usr/local/bin:/usr/local/sbin:/opt/bin:/opt/sbin";
428} 440}
429 441
430my @hook_count; 442my @hook_count;
431my $verbosity = $ENV{URXVT_PERL_VERBOSITY}; 443my $verbosity = $ENV{URXVT_PERL_VERBOSITY};
432 444
465 verbose 3, "loading extension '$path' into package '$pkg'"; 477 verbose 3, "loading extension '$path' into package '$pkg'";
466 478
467 open my $fh, "<:raw", $path 479 open my $fh, "<:raw", $path
468 or die "$path: $!"; 480 or die "$path: $!";
469 481
470 my $source = "package $pkg; use strict; use utf8;\n" 482 my $source = untaint "package $pkg; use strict; use utf8;\n"
471 . "use base urxvt::term::proxy::;\n" 483 . "use base urxvt::term::proxy::;\n"
472 . "#line 1 \"$path\"\n{\n" 484 . "#line 1 \"$path\"\n{\n"
473 . (do { local $/; <$fh> }) 485 . (do { local $/; <$fh> })
474 . "\n};\n1"; 486 . "\n};\n1";
475 487
491 503
492 my %want_ext; 504 my %want_ext;
493 505
494 for (map { split /,/, $TERM->resource ("perl_ext_$_") } 1, 2) { 506 for (map { split /,/, $TERM->resource ("perl_ext_$_") } 1, 2) {
495 if ($_ eq "default") { 507 if ($_ eq "default") {
496 $want_ext{$_}++ for qw(selection option-popup); 508 $want_ext{$_}++ for qw(selection option-popup selection-popup);
497 } elsif (/^-(.*)$/) { 509 } elsif (/^-(.*)$/) {
498 delete $want_ext{$1}; 510 delete $want_ext{$1};
499 } else { 511 } else {
500 $want_ext{$_}++; 512 $want_ext{$_}++;
501 } 513 }
532 $proxy 544 $proxy
533 }, 545 },
534 @_, 546 @_,
535 ) and last; 547 ) and last;
536 }; 548 };
537 warn $@ if $@;#d# 549 if ($@) {
550 $TERM->ungrab; # better to lose the grab than the session
551 warn $@;
552 }
538 } 553 }
539 } 554 }
540 555
541 if ($htype == 1) { # DESTROY 556 if ($htype == 1) { # DESTROY
542 # remove hooks if unused 557 # remove hooks if unused
572 } or die "FATAL: unable to compile method forwarder: $@"; 587 } or die "FATAL: unable to compile method forwarder: $@";
573 588
574 goto &$urxvt::term::proxy::AUTOLOAD; 589 goto &$urxvt::term::proxy::AUTOLOAD;
575} 590}
576 591
592sub urxvt::term::proxy::DESTROY {
593 # nop
594}
595
577# urxvt::destroy_hook 596# urxvt::destroy_hook
578 597
579sub urxvt::destroy_hook::DESTROY { 598sub urxvt::destroy_hook::DESTROY {
580 ${$_[0]}->(); 599 ${$_[0]}->();
581} 600}
582 601
583sub urxvt::destroy_hook(&) { 602sub urxvt::destroy_hook(&) {
584 bless \shift, urxvt::destroy_hook:: 603 bless \shift, urxvt::destroy_hook::
585} 604}
586 605
587# urxvt::anyevent
588
589package urxvt::anyevent; 606package urxvt::anyevent;
607
608=head2 The C<urxvt::anyevent> Class
609
610The sole purpose of this class is to deliver an interface to the
611C<AnyEvent> module - any module using it will work inside urxvt without
612further work. The only exception is that you cannot wait on condition
613variables, but non-blocking condvar use is ok. What this means is that you
614cannot use blocking APIs, but the non-blocking variant should work.
615
616=cut
590 617
591our $VERSION = 1; 618our $VERSION = 1;
592 619
593$INC{"urxvt/anyevent.pm"} = 1; # mark us as there 620$INC{"urxvt/anyevent.pm"} = 1; # mark us as there
594push @AnyEvent::REGISTRY, [urxvt => urxvt::anyevent::]; 621push @AnyEvent::REGISTRY, [urxvt => urxvt::anyevent::];
890 917
891=item $lines_in_scrollback = $term->nsaved 918=item $lines_in_scrollback = $term->nsaved
892 919
893Return various integers describing terminal characteristics. 920Return various integers describing terminal characteristics.
894 921
922=item $lc_ctype = $term->locale
923
924Returns the LC_CTYPE category string used by this rxvt-unicode.
925
926=item $x_display = $term->display_id
927
928Return the DISPLAY used by rxvt-unicode.
929
895=item $modifiermask = $term->ModLevel3Mask 930=item $modifiermask = $term->ModLevel3Mask
896 931
897=item $modifiermask = $term->ModMetaMask 932=item $modifiermask = $term->ModMetaMask
898 933
899=item $modifiermask = $term->ModNumLockMask 934=item $modifiermask = $term->ModNumLockMask
1075 $offset / $self->{ncol} + $self->{beg}, 1110 $offset / $self->{ncol} + $self->{beg},
1076 $offset % $self->{ncol} 1111 $offset % $self->{ncol}
1077 ) 1112 )
1078} 1113}
1079 1114
1080=item ($row, $col) = $line->coord_of ($offset)
1081=item $text = $term->special_encode $string 1115=item $text = $term->special_encode $string
1082 1116
1083Converts a perl string into the special encoding used by rxvt-unicode, 1117Converts a perl string into the special encoding used by rxvt-unicode,
1084where one character corresponds to one screen cell. See 1118where one character corresponds to one screen cell. See
1085C<< $term->ROW_t >> for details. 1119C<< $term->ROW_t >> for details.
1087=item $string = $term->special_decode $text 1121=item $string = $term->special_decode $text
1088 1122
1089Converts rxvt-unicodes text reprsentation into a perl string. See 1123Converts rxvt-unicodes text reprsentation into a perl string. See
1090C<< $term->ROW_t >> for details. 1124C<< $term->ROW_t >> for details.
1091 1125
1126=item $success = $term->grab_button ($button, $modifiermask)
1127
1128Registers a synchronous button grab. See the XGrabButton manpage.
1129
1130=item $success = $term->grab ($eventtime[, $sync])
1131
1132Calls XGrabPointer and XGrabKeyboard in asynchronous (default) or
1133synchronous (C<$sync> is true). Also remembers the grab timestampe.
1134
1135=item $term->allow_events_async
1136
1137Calls XAllowEvents with AsyncBoth for the most recent grab.
1138
1139=item $term->allow_events_sync
1140
1141Calls XAllowEvents with SyncBoth for the most recent grab.
1142
1143=item $term->allow_events_replay
1144
1145Calls XAllowEvents with both ReplayPointer and ReplayKeyboard for the most
1146recent grab.
1147
1148=item $term->ungrab
1149
1150Calls XUngrab for the most recent grab. Is called automatically on
1151evaluation errors, as it is better to lose the grab in the error case as
1152the session.
1153
1092=back 1154=back
1093 1155
1094=cut 1156=cut
1095 1157
1096package urxvt::popup; 1158package urxvt::popup;
1119 $sep ||= "═"; 1181 $sep ||= "═";
1120 1182
1121 $self->add_item ({ 1183 $self->add_item ({
1122 rend => { normal => "\x1b[0;30;47m", hover => "\x1b[0;30;47m", active => "\x1b[0;30;47m" }, 1184 rend => { normal => "\x1b[0;30;47m", hover => "\x1b[0;30;47m", active => "\x1b[0;30;47m" },
1123 text => "", 1185 text => "",
1124 render => sub { $sep x $urxvt::TERM->ncol }, 1186 render => sub { $sep x $self->{term}->ncol },
1125 activate => sub { }, 1187 activate => sub { },
1126 }); 1188 });
1127} 1189}
1128 1190
1129sub add_title { 1191sub add_title {
1137} 1199}
1138 1200
1139sub add_button { 1201sub add_button {
1140 my ($self, $text, $cb) = @_; 1202 my ($self, $text, $cb) = @_;
1141 1203
1142 $self->add_item ({ type => "button", text => "[ $text ]", activate => $cb}); 1204 $self->add_item ({ type => "button", text => $text, activate => $cb});
1143} 1205}
1144 1206
1145sub add_toggle { 1207sub add_toggle {
1146 my ($self, $text, $cb, $value) = @_; 1208 my ($self, $text, $cb, $value) = @_;
1147 1209
1148 my $item; $item = { 1210 my $item; $item = {
1149 type => "button", 1211 type => "button",
1150 text => " $text", 1212 text => " $text",
1151 value => $value, 1213 value => $value,
1152 render => sub { ($item->{value} ? "* " : " ") . $text }, 1214 render => sub { ($_[0]{value} ? "* " : " ") . $text },
1153 activate => sub { $cb->($item->{value} = !$item->{value}); }, 1215 activate => sub { $cb->($_[0]{value} = !$_[0]{value}); },
1154 }; 1216 };
1155 1217
1156 $self->add_item ($item); 1218 $self->add_item ($item);
1157} 1219}
1158 1220
1159sub show { 1221sub show {
1160 my ($self) = @_; 1222 my ($self) = @_;
1161 1223
1162 local $urxvt::popup::self = $self; 1224 local $urxvt::popup::self = $self;
1163 1225
1226 local $ENV{LC_ALL} = $self->{term}->locale;
1227
1164 urxvt->new ("--perl-lib" => "", "--perl-ext-common" => "", "-pty-fd" => -1, "-sl" => 0, "-b" => 0, 1228 urxvt->new ("--perl-lib" => "", "--perl-ext-common" => "", "-pty-fd" => -1, "-sl" => 0, "-b" => 0,
1165 "--transient-for" => $self->{term}->parent, 1229 "--transient-for" => $self->{term}->parent,
1230 "-display" => $self->{term}->display_id,
1166 "-pe" => "urxvt-popup") 1231 "-pe" => "urxvt-popup")
1167 or die "unable to create popup window\n"; 1232 or die "unable to create popup window\n";
1168} 1233}
1169 1234
1170sub DESTROY { 1235sub DESTROY {
1171 my ($self) = @_; 1236 my ($self) = @_;
1172 1237
1238 delete $self->{term}{_destroy}{$self};
1173 $self->{term}->ungrab; 1239 $self->{term}->ungrab;
1174} 1240}
1175 1241
1176=head2 The C<urxvt::timer> Class 1242=head2 The C<urxvt::timer> Class
1177 1243
1281This variable controls the verbosity level of the perl extension. Higher 1347This variable controls the verbosity level of the perl extension. Higher
1282numbers indicate more verbose output. 1348numbers indicate more verbose output.
1283 1349
1284=over 4 1350=over 4
1285 1351
1286=item =0 - only fatal messages 1352=item == 0 - fatal messages
1287 1353
1288=item =3 - script loading and management 1354=item >= 3 - script loading and management
1289 1355
1290=item =10 - all events received 1356=item >=10 - all events received
1291 1357
1292=back 1358=back
1293 1359
1294=head1 AUTHOR 1360=head1 AUTHOR
1295 1361

Diff Legend

Removed lines
+ Added lines
< Changed lines
> Changed lines