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.46 by root, Sat Jan 7 20:29:28 2006 UTC vs.
Revision 1.61 by root, Mon Jan 9 01:36:56 2006 UTC

37 37
38 @@RXVT_NAME@@ -pe <extensionname> 38 @@RXVT_NAME@@ -pe <extensionname>
39 39
40=over 4 40=over 4
41 41
42=item selection 42=item selection (enabled by default)
43 43
44Intelligent selection. This extension tries to be more intelligent when 44Intelligent selection. This extension tries to be more intelligent when
45the user extends selections (double-click). Right now, it tries to select 45the user extends selections (double-click). Right now, it tries to select
46urls and complete shell-quoted arguments, which is very convenient, too, 46urls and complete shell-quoted arguments, which is very convenient, too,
47if your F<ls> supports C<--quoting-style=shell>. 47if your F<ls> supports C<--quoting-style=shell>.
55Rot-13 the selection when activated. Used via keyboard trigger: 55Rot-13 the selection when activated. Used via keyboard trigger:
56 56
57 URxvt.keysym.C-M-r: perl:selection:rot13 57 URxvt.keysym.C-M-r: perl:selection:rot13
58 58
59=back 59=back
60
61=item option-popup (enabled by default)
62
63Binds a popup menu to Ctrl-Button2 that lets you toggle (some) options at
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.
60 70
61=item digital-clock 71=item digital-clock
62 72
63Displays a digital clock using the built-in overlay. 73Displays a digital clock using the built-in overlay.
64 74
195 205
196It 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,
197$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
198number of lines that will be in the scrollback buffer. 208number of lines that will be in the scrollback buffer.
199 209
200=item on_tty_activity $term *NYI*
201
202Called whenever the program(s) running in the urxvt window send output.
203
204=item on_osc_seq $term, $string 210=item on_osc_seq $term, $string
205 211
206Called whenever the B<ESC ] 777 ; string ST> command sequence (OSC = 212Called whenever the B<ESC ] 777 ; string ST> command sequence (OSC =
207operating system command) is processed. Cursor position and other state 213operating system command) is processed. Cursor position and other state
208information is up-to-date when this happens. For interoperability, the 214information is up-to-date when this happens. For interoperability, the
331 337
332=item $time = urxvt::NOW 338=item $time = urxvt::NOW
333 339
334Returns the "current time" (as per the event loop). 340Returns the "current time" (as per the event loop).
335 341
342=item urxvt::CurrentTime
343
344=item urxvt::ShiftMask, LockMask, ControlMask, Mod1Mask, Mod2Mask,
345Mod3Mask, Mod4Mask, Mod5Mask, Button1Mask, Button2Mask, Button3Mask,
346Button4Mask, Button5Mask, AnyModifier
347
348Various constants for use in X calls and event processing.
349
336=back 350=back
337 351
338=head2 RENDITION 352=head2 RENDITION
339 353
340Rendition bitsets contain information about colour, font, font styles and 354Rendition bitsets contain information about colour, font, font styles and
389 403
390=cut 404=cut
391 405
392package urxvt; 406package urxvt;
393 407
408use utf8;
394use strict; 409use strict;
395use Scalar::Util (); 410use Scalar::Util ();
411use List::Util ();
396 412
413our $VERSION = 1;
397our $TERM; 414our $TERM;
398our @HOOKNAME; 415our @HOOKNAME;
416our %OPTION;
399our $LIBDIR; 417our $LIBDIR;
400 418
401BEGIN { 419BEGIN {
402 urxvt->bootstrap; 420 urxvt->bootstrap;
403 421
406 my $msg = join "", @_; 424 my $msg = join "", @_;
407 $msg .= "\n" 425 $msg .= "\n"
408 unless $msg =~ /\n$/; 426 unless $msg =~ /\n$/;
409 urxvt::warn ($msg); 427 urxvt::warn ($msg);
410 }; 428 };
429
430 delete $ENV{IFS};
431 delete $ENV{CDPATH};
432 delete $ENV{BASH_ENV};
433 $ENV{PATH} = "/bin:/sbin:/usr/bin:/usr/sbin:/usr/local/bin:/usr/local/sbin:/opt/bin:/opt/sbin";
411} 434}
412 435
413my @hook_count; 436my @hook_count;
414my $verbosity = $ENV{URXVT_PERL_VERBOSITY}; 437my $verbosity = $ENV{URXVT_PERL_VERBOSITY};
415 438
448 verbose 3, "loading extension '$path' into package '$pkg'"; 471 verbose 3, "loading extension '$path' into package '$pkg'";
449 472
450 open my $fh, "<:raw", $path 473 open my $fh, "<:raw", $path
451 or die "$path: $!"; 474 or die "$path: $!";
452 475
453 my $source = "package $pkg; use strict; use utf8;\n" 476 my $source = untaint "package $pkg; use strict; use utf8;\n"
454 . "use base urxvt::term::proxy::;\n" 477 . "use base urxvt::term::proxy::;\n"
455 . "#line 1 \"$path\"\n{\n" 478 . "#line 1 \"$path\"\n{\n"
456 . (do { local $/; <$fh> }) 479 . (do { local $/; <$fh> })
457 . "\n};\n1"; 480 . "\n};\n1";
458 481
469 local $TERM = shift; 492 local $TERM = shift;
470 my $htype = shift; 493 my $htype = shift;
471 494
472 if ($htype == 0) { # INIT 495 if ($htype == 0) { # INIT
473 my @dirs = ((split /:/, $TERM->resource ("perl_lib")), "$LIBDIR/perl"); 496 my @dirs = ((split /:/, $TERM->resource ("perl_lib")), "$LIBDIR/perl");
497
498 my %want_ext;
474 499
475 for my $ext (map { split /,/, $TERM->resource ("perl_ext_$_") } 1, 2) { 500 for (map { split /,/, $TERM->resource ("perl_ext_$_") } 1, 2) {
501 if ($_ eq "default") {
502 $want_ext{$_}++ for qw(selection option-popup selection-popup);
503 } elsif (/^-(.*)$/) {
504 delete $want_ext{$1};
505 } else {
506 $want_ext{$_}++;
507 }
508 }
509
510 for my $ext (keys %want_ext) {
476 my @files = grep -f $_, map "$_/$ext", @dirs; 511 my @files = grep -f $_, map "$_/$ext", @dirs;
477 512
478 if (@files) { 513 if (@files) {
479 register_package extension_package $files[0]; 514 register_package extension_package $files[0];
480 } else { 515 } else {
481 warn "perl extension '$ext' not found in perl library search path\n"; 516 warn "perl extension '$ext' not found in perl library search path\n";
482 } 517 }
483 } 518 }
519
520 eval "#line 1 \"--perl-eval resource/argument\"\n" . $TERM->resource ("perl_eval");
521 warn $@ if $@;
484 } 522 }
485 523
486 $retval = undef; 524 $retval = undef;
487 525
488 if (my $cb = $TERM->{_hook}[$htype]) { 526 if (my $cb = $TERM->{_hook}[$htype]) {
500 $proxy 538 $proxy
501 }, 539 },
502 @_, 540 @_,
503 ) and last; 541 ) and last;
504 }; 542 };
505 warn $@ if $@;#d# 543 if ($@) {
544 $TERM->ungrab; # better to lose the grab than the session
545 warn $@;
546 }
506 } 547 }
507 } 548 }
508 549
509 if ($htype == 1) { # DESTROY 550 if ($htype == 1) { # DESTROY
510 # remove hooks if unused 551 # remove hooks if unused
523 } 564 }
524 565
525 $retval 566 $retval
526} 567}
527 568
569# urxvt::term::proxy
570
528sub urxvt::term::proxy::AUTOLOAD { 571sub urxvt::term::proxy::AUTOLOAD {
529 $urxvt::term::proxy::AUTOLOAD =~ /:([^:]+)$/ 572 $urxvt::term::proxy::AUTOLOAD =~ /:([^:]+)$/
530 or die "FATAL: \$AUTOLOAD '$urxvt::term::proxy::AUTOLOAD' unparsable"; 573 or die "FATAL: \$AUTOLOAD '$urxvt::term::proxy::AUTOLOAD' unparsable";
531 574
532 eval qq{ 575 eval qq{
538 } or die "FATAL: unable to compile method forwarder: $@"; 581 } or die "FATAL: unable to compile method forwarder: $@";
539 582
540 goto &$urxvt::term::proxy::AUTOLOAD; 583 goto &$urxvt::term::proxy::AUTOLOAD;
541} 584}
542 585
586sub urxvt::term::proxy::DESTROY {
587 # nop
588}
589
590# urxvt::destroy_hook
591
543sub urxvt::destroy_hook::DESTROY { 592sub urxvt::destroy_hook::DESTROY {
544 ${$_[0]}->(); 593 ${$_[0]}->();
545} 594}
546 595
547sub urxvt::destroy_hook(&) { 596sub urxvt::destroy_hook(&) {
548 bless \shift, urxvt::destroy_hook:: 597 bless \shift, urxvt::destroy_hook::
549} 598}
550 599
600package urxvt::anyevent;
601
602=head2 The C<urxvt::anyevent> Class
603
604The sole purpose of this class is to deliver an interface to the
605C<AnyEvent> module - any module using it will work inside urxvt without
606further work. The only exception is that you cannot wait on condition
607variables, but non-blocking condvar use is ok. What this means is that you
608cannot use blocking APIs, but the non-blocking variant should work.
609
610=cut
611
612our $VERSION = 1;
613
614$INC{"urxvt/anyevent.pm"} = 1; # mark us as there
615push @AnyEvent::REGISTRY, [urxvt => urxvt::anyevent::];
616
617sub timer {
618 my ($class, %arg) = @_;
619
620 my $cb = $arg{cb};
621
622 urxvt::timer
623 ->new
624 ->start (urxvt::NOW + $arg{after})
625 ->cb (sub {
626 $_[0]->stop; # need to cancel manually
627 $cb->();
628 })
629}
630
631sub io {
632 my ($class, %arg) = @_;
633
634 my $cb = $arg{cb};
635
636 bless [$arg{fh}, urxvt::iow
637 ->new
638 ->fd (fileno $arg{fh})
639 ->events (($arg{poll} =~ /r/ ? 1 : 0)
640 | ($arg{poll} =~ /w/ ? 2 : 0))
641 ->start
642 ->cb (sub {
643 $cb->(($_[1] & 1 ? 'r' : '')
644 . ($_[1] & 2 ? 'w' : ''));
645 })],
646 urxvt::anyevent::
647}
648
649sub DESTROY {
650 $_[0][1]->stop;
651}
652
653sub condvar {
654 bless \my $flag, urxvt::anyevent::condvar::
655}
656
657sub urxvt::anyevent::condvar::broadcast {
658 ${$_[0]}++;
659}
660
661sub urxvt::anyevent::condvar::wait {
662 unless (${$_[0]}) {
663 require Carp;
664 Carp::croak ("AnyEvent->condvar blocking wait unsupported in urxvt, use a non-blocking API");
665 }
666}
667
668package urxvt::term;
669
551=head2 The C<urxvt::term> Class 670=head2 The C<urxvt::term> Class
552 671
553=over 4 672=over 4
554 673
555=item $term->destroy 674=item $term->destroy
556 675
557Destroy the terminal object (close the window, free resources etc.). 676Destroy the terminal object (close the window, free resources etc.).
677
678=item $isset = $term->option ($optval[, $set])
679
680Returns true if the option specified by C<$optval> is enabled, and
681optionally change it. All option values are stored by name in the hash
682C<%urxvt::OPTION>. Options not enabled in this binary are not in the hash.
683
684Here is a a likely non-exhaustive list of option names, please see the
685source file F</src/optinc.h> to see the actual list:
686
687 borderLess console cursorBlink cursorUnderline hold iconic insecure
688 intensityStyles jumpScroll loginShell mapAlert meta8 mouseWheelScrollPage
689 pastableTabs pointerBlank reverseVideo scrollBar scrollBar_floating
690 scrollBar_right scrollTtyKeypress scrollTtyOutput scrollWithBuffer
691 secondaryScreen secondaryScroll skipBuiltinGlyphs transparent
692 tripleclickwords utmpInhibit visualBell
558 693
559=item $value = $term->resource ($name[, $newval]) 694=item $value = $term->resource ($name[, $newval])
560 695
561Returns the current resource value associated with a given name and 696Returns the current resource value associated with a given name and
562optionally sets a new value. Setting values is most useful in the C<init> 697optionally sets a new value. Setting values is most useful in the C<init>
572 707
573Please note that resource strings will currently only be freed when the 708Please note that resource strings will currently only be freed when the
574terminal is destroyed, so changing options frequently will eat memory. 709terminal is destroyed, so changing options frequently will eat memory.
575 710
576Here is a a likely non-exhaustive list of resource names, not all of which 711Here is a a likely non-exhaustive list of resource names, not all of which
577are supported in every build, please see the source to see the actual 712are supported in every build, please see the source file F</src/rsinc.h>
578list: 713to see the actual list:
579 714
580 answerbackstring backgroundPixmap backspace_key boldFont boldItalicFont 715 answerbackstring backgroundPixmap backspace_key boldFont boldItalicFont
581 borderLess color cursorBlink cursorUnderline cutchars delete_key 716 borderLess color cursorBlink cursorUnderline cutchars delete_key
582 display_name embed ext_bwidth fade font geometry hold iconName 717 display_name embed ext_bwidth fade font geometry hold iconName
583 imFont imLocale inputMethod insecure int_bwidth intensityStyles 718 imFont imLocale inputMethod insecure int_bwidth intensityStyles
590 shade term_name title transparent transparent_all tripleclickwords 725 shade term_name title transparent transparent_all tripleclickwords
591 utmpInhibit visualBell 726 utmpInhibit visualBell
592 727
593=cut 728=cut
594 729
595sub urxvt::term::resource($$;$) { 730sub resource($$;$) {
596 my ($self, $name) = (shift, shift); 731 my ($self, $name) = (shift, shift);
597 unshift @_, $self, $name, ($name =~ s/\s*\+\s*(\d+)$// ? $1 : 0); 732 unshift @_, $self, $name, ($name =~ s/\s*\+\s*(\d+)$// ? $1 : 0);
598 &urxvt::term::_resource 733 &urxvt::term::_resource
599} 734}
600 735
687C<$event> I<must> be the event causing the menu to pop up (a button event, 822C<$event> I<must> be the event causing the menu to pop up (a button event,
688currently). 823currently).
689 824
690=cut 825=cut
691 826
692sub urxvt::term::popup { 827sub popup {
693 my ($self, $event) = @_; 828 my ($self, $event) = @_;
694 829
695 $self->grab ($event->{time}, 1) 830 $self->grab ($event->{time}, 1)
696 or return; 831 or return;
697 832
775=item $nrow_plus_saveLines = $term->total_rows 910=item $nrow_plus_saveLines = $term->total_rows
776 911
777=item $lines_in_scrollback = $term->nsaved 912=item $lines_in_scrollback = $term->nsaved
778 913
779Return various integers describing terminal characteristics. 914Return various integers describing terminal characteristics.
915
916=item $modifiermask = $term->ModLevel3Mask
917
918=item $modifiermask = $term->ModMetaMask
919
920=item $modifiermask = $term->ModNumLockMask
921
922Return the modifier masks corresponding to the "ISO Level 3 Shift" (often
923AltGr), the meta key (often Alt) and the num lock key, if applicable.
780 924
781=item $view_start = $term->view_start ([$newvalue]) 925=item $view_start = $term->view_start ([$newvalue])
782 926
783Returns the negative row number of the topmost line. Minimum value is 927Returns the negative row number of the topmost line. Minimum value is
784C<0>, which displays the normal terminal contents. Larger values scroll 928C<0>, which displays the normal terminal contents. Larger values scroll
878 1022
879=back 1023=back
880 1024
881=cut 1025=cut
882 1026
883sub urxvt::term::line { 1027sub line {
884 my ($self, $row) = @_; 1028 my ($self, $row) = @_;
885 1029
886 my $maxrow = $self->nrow - 1; 1030 my $maxrow = $self->nrow - 1;
887 1031
888 my ($beg, $end) = ($row, $row); 1032 my ($beg, $end) = ($row, $row);
952 $offset / $self->{ncol} + $self->{beg}, 1096 $offset / $self->{ncol} + $self->{beg},
953 $offset % $self->{ncol} 1097 $offset % $self->{ncol}
954 ) 1098 )
955} 1099}
956 1100
957=item ($row, $col) = $line->coord_of ($offset)
958=item $text = $term->special_encode $string 1101=item $text = $term->special_encode $string
959 1102
960Converts a perl string into the special encoding used by rxvt-unicode, 1103Converts a perl string into the special encoding used by rxvt-unicode,
961where one character corresponds to one screen cell. See 1104where one character corresponds to one screen cell. See
962C<< $term->ROW_t >> for details. 1105C<< $term->ROW_t >> for details.
964=item $string = $term->special_decode $text 1107=item $string = $term->special_decode $text
965 1108
966Converts rxvt-unicodes text reprsentation into a perl string. See 1109Converts rxvt-unicodes text reprsentation into a perl string. See
967C<< $term->ROW_t >> for details. 1110C<< $term->ROW_t >> for details.
968 1111
1112=item $success = $term->grab_button ($button, $modifiermask)
1113
1114Registers a synchronous button grab. See XGrabButton.
1115
1116=item $success = $term->grab ($eventtime[, $sync])
1117
1118Calls XGrabPointer and XGrabKeyboard in asynchronous (default) or
1119synchronous (C<$sync> is true). Also remembers the grab timestampe.
1120
1121=item $term->allow_events_async
1122
1123Calls XAllowEvents with AsyncBoth for the most recent grab.
1124
1125=item $term->allow_events_sync
1126
1127Calls XAllowEvents with SyncBoth for the most recent grab.
1128
1129=item $term->allow_events_replay
1130
1131Calls XAllowEvents with both ReplayPointer and ReplayKeyboard for the most
1132recent grab.
1133
1134=item $term->ungrab
1135
1136Calls XUngrab for the most recent grab. Is called automatically on
1137evaluation errors, as it is better to lose the grab in the error case as
1138the session.
1139
969=back 1140=back
970 1141
1142=cut
1143
1144package urxvt::popup;
1145
971=head2 The C<urxvt::popup> Class 1146=head2 The C<urxvt::popup> Class
972 1147
973=over 4 1148=over 4
974 1149
975=cut 1150=cut
976
977package urxvt::popup;
978 1151
979sub add_item { 1152sub add_item {
980 my ($self, $item) = @_; 1153 my ($self, $item) = @_;
981 1154
1155 $item->{rend}{normal} = "\x1b[0;30;47m" unless exists $item->{rend}{normal};
1156 $item->{rend}{hover} = "\x1b[0;30;46m" unless exists $item->{rend}{hover};
1157 $item->{rend}{active} = "\x1b[m" unless exists $item->{rend}{active};
1158
1159 $item->{render} ||= sub { $_[0]{text} };
1160
982 push @{ $self->{item} }, $item; 1161 push @{ $self->{item} }, $item;
1162}
1163
1164sub add_separator {
1165 my ($self, $sep) = @_;
1166
1167 $sep ||= "═";
1168
1169 $self->add_item ({
1170 rend => { normal => "\x1b[0;30;47m", hover => "\x1b[0;30;47m", active => "\x1b[0;30;47m" },
1171 text => "",
1172 render => sub { $sep x $urxvt::TERM->ncol },
1173 activate => sub { },
1174 });
1175}
1176
1177sub add_title {
1178 my ($self, $title) = @_;
1179
1180 $self->add_item ({
1181 rend => { normal => "\x1b[38;5;11;44m", hover => "\x1b[38;5;11;44m", active => "\x1b[38;5;11;44m" },
1182 text => $title,
1183 activate => sub { },
1184 });
983} 1185}
984 1186
985sub add_button { 1187sub add_button {
986 my ($self, $text, $cb) = @_; 1188 my ($self, $text, $cb) = @_;
987 1189
988 $self->add_item ({ type => "button", text => "[ $text ]", activate => $cb }); 1190 $self->add_item ({ type => "button", text => "[ $text ]", activate => $cb});
1191}
1192
1193sub add_toggle {
1194 my ($self, $text, $cb, $value) = @_;
1195
1196 my $item; $item = {
1197 type => "button",
1198 text => " $text",
1199 value => $value,
1200 render => sub { ($_[0]{value} ? "* " : " ") . $text },
1201 activate => sub { $cb->($_[0]{value} = !$_[0]{value}); },
1202 };
1203
1204 $self->add_item ($item);
989} 1205}
990 1206
991sub show { 1207sub show {
992 my ($self) = @_; 1208 my ($self) = @_;
993 1209
1000} 1216}
1001 1217
1002sub DESTROY { 1218sub DESTROY {
1003 my ($self) = @_; 1219 my ($self) = @_;
1004 1220
1221 delete $self->{term}{_destroy}{$self};
1005 $self->{term}->ungrab; 1222 $self->{term}->ungrab;
1006} 1223}
1007 1224
1008=head2 The C<urxvt::timer> Class 1225=head2 The C<urxvt::timer> Class
1009 1226
1113This variable controls the verbosity level of the perl extension. Higher 1330This variable controls the verbosity level of the perl extension. Higher
1114numbers indicate more verbose output. 1331numbers indicate more verbose output.
1115 1332
1116=over 4 1333=over 4
1117 1334
1118=item =0 - only fatal messages 1335=item == 0 - fatal messages
1119 1336
1120=item =3 - script loading and management 1337=item >= 3 - script loading and management
1121 1338
1122=item =10 - all events received 1339=item >=10 - all events received
1123 1340
1124=back 1341=back
1125 1342
1126=head1 AUTHOR 1343=head1 AUTHOR
1127 1344

Diff Legend

Removed lines
+ Added lines
< Changed lines
> Changed lines