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.220 by root, Tue Jun 19 18:17:56 2012 UTC vs.
Revision 1.234 by root, Sat May 17 15:25:04 2014 UTC

1=encoding utf8 1=encoding utf8
2 2
3=head1 NAME 3=head1 NAME
4 4
5@@RXVT_NAME@@perl - rxvt-unicode's embedded perl interpreter 5urxvtperl - rxvt-unicode's embedded perl interpreter
6 6
7=head1 SYNOPSIS 7=head1 SYNOPSIS
8 8
9 # create a file grab_test in $HOME: 9 # create a file grab_test in $HOME:
10 10
11 sub on_sel_grab { 11 sub on_sel_grab {
12 warn "you selected ", $_[0]->selection; 12 warn "you selected ", $_[0]->selection;
13 () 13 ()
14 } 14 }
15 15
16 # start a @@RXVT_NAME@@ using it: 16 # start a urxvt using it:
17 17
18 @@RXVT_NAME@@ --perl-lib $HOME -pe grab_test 18 urxvt --perl-lib $HOME -pe grab_test
19 19
20=head1 DESCRIPTION 20=head1 DESCRIPTION
21 21
22Every time a terminal object gets created, extension scripts specified via 22Every time a terminal object gets created, extension scripts specified via
23the C<perl> resource are loaded and associated with it. 23the C<perl> resource are loaded and associated with it.
24 24
25Scripts are compiled in a 'use strict "vars"' and 'use utf8' environment, and 25Scripts are compiled in a 'use strict "vars"' and 'use utf8' environment, and
26thus must be encoded as UTF-8. 26thus must be encoded as UTF-8.
27 27
28Each script will only ever be loaded once, even in @@RXVT_NAME@@d, where 28Each script will only ever be loaded once, even in urxvtd, where
29scripts will be shared (but not enabled) for all terminals. 29scripts will be shared (but not enabled) for all terminals.
30 30
31You can disable the embedded perl interpreter by setting both "perl-ext" 31You can disable the embedded perl interpreter by setting both "perl-ext"
32and "perl-ext-common" resources to the empty string. 32and "perl-ext-common" resources to the empty string.
33 33
34=head1 PREPACKAGED EXTENSIONS 34=head1 PREPACKAGED EXTENSIONS
35 35
36A number of extensions are delivered with this release. You can find them 36A number of extensions are delivered with this release. You can find them
37in F<@@RXVT_LIBDIR@@/urxvt/perl/>, and the documentation can be viewed 37in F<< <libdir>/urxvt/perl/ >>, and the documentation can be viewed using
38using F<< man urxvt-<EXTENSIONNAME> >>. 38F<< man urxvt-<EXTENSIONNAME> >>.
39 39
40You can activate them like this: 40You can activate them like this:
41 41
42 @@RXVT_NAME@@ -pe <extensionname> 42 urxvt -pe <extensionname>
43 43
44Or by adding them to the resource for extensions loaded by default: 44Or by adding them to the resource for extensions loaded by default:
45 45
46 URxvt.perl-ext-common: default,selection-autotransform 46 URxvt.perl-ext-common: default,selection-autotransform
47 47
103internal use. 103internal use.
104 104
105Although it isn't a C<urxvt::term> object, you can call all methods of the 105Although it isn't a C<urxvt::term> object, you can call all methods of the
106C<urxvt::term> class on this object. 106C<urxvt::term> class on this object.
107 107
108It has the following methods and data members: 108Additional methods only supported for extension objects are described in
109 109the C<urxvt::extension> section below.
110=over 4
111
112=item $urxvt_term = $self->{term}
113
114Returns the C<urxvt::term> object associated with this instance of the
115extension. This member I<must not> be changed in any way.
116
117=item $self->enable ($hook_name => $cb[, $hook_name => $cb..])
118
119Dynamically enable the given hooks (named without the C<on_> prefix) for
120this extension, replacing any previous hook. This is useful when you want
121to overwrite time-critical hooks only temporarily.
122
123To install additional callbacks for the same hook, you cna use the C<on>
124method of the C<urxvt::term> class.
125
126=item $self->disable ($hook_name[, $hook_name..])
127
128Dynamically disable the given hooks.
129
130=item $self->x_resource ($pattern)
131
132=item $self->x_resource_boolean ($pattern)
133
134These methods support an additional C<%> prefix when called on an
135extension object - see the description of these methods in the
136C<urxvt::term> class for details.
137
138=back
139 110
140=head2 Hooks 111=head2 Hooks
141 112
142The following subroutines can be declared in extension files, and will be 113The following subroutines can be declared in extension files, and will be
143called whenever the relevant event happens. 114called whenever the relevant event happens.
310 281
311=item on_refresh_end $term 282=item on_refresh_end $term
312 283
313Called just after the screen gets redrawn. See C<on_refresh_begin>. 284Called just after the screen gets redrawn. See C<on_refresh_begin>.
314 285
315=item on_user_command $term, $string 286=item on_user_command $term, $string *DEPRECATED*
316 287
317Called whenever a user-configured event is being activated (e.g. via 288Called whenever a user-configured event is being activated (e.g. via
318a C<perl:string> action bound to a key, see description of the B<keysym> 289a C<perl:string> action bound to a key, see description of the B<keysym>
319resource in the @@RXVT_NAME@@(1) manpage). 290resource in the urxvt(1) manpage).
320 291
321The event is simply the action string. This interface is assumed to change 292The event is simply the action string. This interface is going away in
322slightly in the future. 293preference to the C<< ->register_keysym_action >> method.
323
324=item on_register_command $term, $keysym, $modifiermask, $string
325
326Called after parsing a keysym resource but before registering the
327associated binding. If this hook returns TRUE the binding is not
328registered. It can be used to modify a binding by calling
329C<register_command>.
330 294
331=item on_resize_all_windows $term, $new_width, $new_height 295=item on_resize_all_windows $term, $new_width, $new_height
332 296
333Called just after the new window size has been calculated, but before 297Called just after the new window size has been calculated, but before
334windows are actually being resized or hints are being set. If this hook 298windows are actually being resized or hints are being set. If this hook
335returns TRUE, setting of the window hints is being skipped. 299returns a true value, setting of the window hints is being skipped.
336 300
337=item on_x_event $term, $event 301=item on_x_event $term, $event
338 302
339Called on every X event received on the vt window (and possibly other 303Called on every X event received on the vt window (and possibly other
340windows). Should only be used as a last resort. Most event structure 304windows). Should only be used as a last resort. Most event structure
379manpage), with the additional members C<row> and C<col>, which are the 343manpage), with the additional members C<row> and C<col>, which are the
380(real, not screen-based) row and column under the mouse cursor. 344(real, not screen-based) row and column under the mouse cursor.
381 345
382C<on_key_press> additionally receives the string rxvt-unicode would 346C<on_key_press> additionally receives the string rxvt-unicode would
383output, if any, in locale-specific encoding. 347output, if any, in locale-specific encoding.
384
385subwindow.
386 348
387=item on_client_message $term, $event 349=item on_client_message $term, $event
388 350
389=item on_wm_protocols $term, $event 351=item on_wm_protocols $term, $event
390 352
595sub parse_resource { 557sub parse_resource {
596 my ($term, $name, $isarg, $longopt, $flag, $value) = @_; 558 my ($term, $name, $isarg, $longopt, $flag, $value) = @_;
597 559
598 $name =~ y/-/./ if $isarg; 560 $name =~ y/-/./ if $isarg;
599 561
600 $term->scan_meta; 562 $term->scan_extensions;
601 563
602 my $r = $term->{meta}{resource}; 564 my $r = $term->{meta}{resource};
603 keys %$r; # reste iterator 565 keys %$r; # reset iterator
604 while (my ($pattern, $v) = each %$r) { 566 while (my ($pattern, $v) = each %$r) {
605 if ( 567 if (
606 $pattern =~ /\.$/ 568 $pattern =~ /\.$/
607 ? $pattern eq substr $name, 0, length $pattern 569 ? $pattern eq substr $name, 0, length $pattern
608 : $pattern eq $name 570 : $pattern eq $name
625} 587}
626 588
627sub usage { 589sub usage {
628 my ($term, $usage_type) = @_; 590 my ($term, $usage_type) = @_;
629 591
630 $term->scan_meta; 592 $term->scan_extensions;
631 593
632 my $r = $term->{meta}{resource}; 594 my $r = $term->{meta}{resource};
633 595
634 for my $pattern (sort keys %$r) { 596 for my $pattern (sort keys %$r) {
635 my ($ext, $type, $desc) = @{ $r->{$pattern} }; 597 my ($ext, $type, $desc) = @{ $r->{$pattern} };
696# called by the rxvt core 658# called by the rxvt core
697sub invoke { 659sub invoke {
698 local $TERM = shift; 660 local $TERM = shift;
699 my $htype = shift; 661 my $htype = shift;
700 662
701 if ($htype == 0) { # INIT 663 if ($htype == HOOK_INIT) {
702 my @dirs = $TERM->perl_libdirs; 664 my @dirs = $TERM->perl_libdirs;
665
666 $TERM->scan_extensions;
703 667
704 my %ext_arg; 668 my %ext_arg;
705 669
706 { 670 {
707 my @init = @TERM_INIT; 671 my @init = @TERM_INIT;
745 709
746 if (my $cb = $TERM->{_hook}[$htype]) { 710 if (my $cb = $TERM->{_hook}[$htype]) {
747 verbose 10, "$HOOKNAME[$htype] (" . (join ", ", $TERM, @_) . ")" 711 verbose 10, "$HOOKNAME[$htype] (" . (join ", ", $TERM, @_) . ")"
748 if $verbosity >= 10; 712 if $verbosity >= 10;
749 713
714 if ($htype == HOOK_ACTION) {
715 # this hook is only sent to the extension with the name
716 # matching the first arg
717 my $pkg = shift;
718 $pkg =~ y/-/_/;
719 $pkg = "urxvt::ext::$pkg";
720
721 $cb = $cb->{$pkg}
722 or return undef; #TODO: maybe warn user?
723
724 $cb = { $pkg => $cb };
725 }
726
750 for my $pkg (keys %$cb) { 727 for my $pkg (keys %$cb) {
751 my $retval_ = eval { $cb->{$pkg}->($TERM->{_pkg}{$pkg} || $TERM, @_) }; 728 my $retval_ = eval { $cb->{$pkg}->($TERM->{_pkg}{$pkg} || $TERM, @_) };
752 $retval ||= $retval_; 729 $retval ||= $retval_;
753 730
754 if ($@) { 731 if ($@) {
759 736
760 verbose 11, "$HOOKNAME[$htype] returning <$retval>" 737 verbose 11, "$HOOKNAME[$htype] returning <$retval>"
761 if $verbosity >= 11; 738 if $verbosity >= 11;
762 } 739 }
763 740
764 if ($htype == 1) { # DESTROY 741 if ($htype == HOOK_DESTROY) {
765 # clear package objects 742 # clear package objects
766 %$_ = () for values %{ $TERM->{_pkg} }; 743 %$_ = () for values %{ $TERM->{_pkg} };
767 744
768 # clear package 745 # clear package
769 %$TERM = (); 746 %$TERM = ();
801 ($mask, @color{qw(fg bg)}, \@failed) 778 ($mask, @color{qw(fg bg)}, \@failed)
802} 779}
803 780
804package urxvt::term::extension; 781package urxvt::term::extension;
805 782
806sub enable { 783=head2 The C<urxvt::term::extension> class
807 my ($self, %hook) = @_;
808 my $pkg = $self->{_pkg};
809 784
810 while (my ($name, $cb) = each %hook) { 785Each extension attached to a terminal object is represented by
811 my $htype = $HOOKTYPE{uc $name}; 786a C<urxvt::term::extension> object.
812 defined $htype
813 or Carp::croak "unsupported hook type '$name'";
814 787
815 $self->set_should_invoke ($htype, +1) 788You can use these objects, which are passed to all callbacks to store any
816 unless exists $self->{term}{_hook}[$htype]{$pkg}; 789state related to the terminal and extension instance.
817 790
818 $self->{term}{_hook}[$htype]{$pkg} = $cb; 791The methods (And data members) documented below can be called on extension
819 } 792objects, in addition to call methods documented for the <urxvt::term>
820} 793class.
821 794
822sub disable { 795=over 4
823 my ($self, @hook) = @_;
824 my $pkg = $self->{_pkg};
825 796
826 for my $name (@hook) { 797=item $urxvt_term = $self->{term}
827 my $htype = $HOOKTYPE{uc $name};
828 defined $htype
829 or Carp::croak "unsupported hook type '$name'";
830 798
831 $self->set_should_invoke ($htype, -1) 799Returns the C<urxvt::term> object associated with this instance of the
832 if delete $self->{term}{_hook}[$htype]{$pkg}; 800extension. This member I<must not> be changed in any way.
833 } 801
834} 802=cut
835 803
836our $AUTOLOAD; 804our $AUTOLOAD;
837 805
838sub AUTOLOAD { 806sub AUTOLOAD {
839 $AUTOLOAD =~ /:([^:]+)$/ 807 $AUTOLOAD =~ /:([^:]+)$/
852 820
853sub DESTROY { 821sub DESTROY {
854 # nop 822 # nop
855} 823}
856 824
857# urxvt::destroy_hook 825# urxvt::destroy_hook (basically a cheap Guard:: implementation)
858 826
859sub urxvt::destroy_hook::DESTROY { 827sub urxvt::destroy_hook::DESTROY {
860 ${$_[0]}->(); 828 ${$_[0]}->();
861} 829}
862 830
863sub urxvt::destroy_hook(&) { 831sub urxvt::destroy_hook(&) {
864 bless \shift, urxvt::destroy_hook:: 832 bless \shift, urxvt::destroy_hook::
865} 833}
834
835=item $self->enable ($hook_name => $cb[, $hook_name => $cb..])
836
837Dynamically enable the given hooks (named without the C<on_> prefix) for
838this extension, replacing any hook previously installed via C<enable> in
839this extension.
840
841This is useful when you want to overwrite time-critical hooks only
842temporarily.
843
844To install additional callbacks for the same hook, you can use the C<on>
845method of the C<urxvt::term> class.
846
847=item $self->disable ($hook_name[, $hook_name..])
848
849Dynamically disable the given hooks.
850
851=cut
852
853sub enable {
854 my ($self, %hook) = @_;
855 my $pkg = $self->{_pkg};
856
857 while (my ($name, $cb) = each %hook) {
858 my $htype = $HOOKTYPE{uc $name};
859 defined $htype
860 or Carp::croak "unsupported hook type '$name'";
861
862 $self->set_should_invoke ($htype, +1)
863 unless exists $self->{term}{_hook}[$htype]{$pkg};
864
865 $self->{term}{_hook}[$htype]{$pkg} = $cb;
866 }
867}
868
869sub disable {
870 my ($self, @hook) = @_;
871 my $pkg = $self->{_pkg};
872
873 for my $name (@hook) {
874 my $htype = $HOOKTYPE{uc $name};
875 defined $htype
876 or Carp::croak "unsupported hook type '$name'";
877
878 $self->set_should_invoke ($htype, -1)
879 if delete $self->{term}{_hook}[$htype]{$pkg};
880 }
881}
882
883=item $guard = $self->on ($hook_name => $cb[, $hook_name => $cb..])
884
885Similar to the C<enable> enable, but installs additional callbacks for
886the given hook(s) (that is, it doesn't replace existing callbacks), and
887returns a guard object. When the guard object is destroyed the callbacks
888are disabled again.
889
890=cut
891
892sub urxvt::extension::on_disable::DESTROY {
893 my $disable = shift;
894
895 my $term = delete $disable->{""};
896
897 while (my ($htype, $id) = each %$disable) {
898 delete $term->{_hook}[$htype]{$id};
899 $term->set_should_invoke ($htype, -1);
900 }
901}
902
903sub on {
904 my ($self, %hook) = @_;
905
906 my $term = $self->{term};
907
908 my %disable = ( "" => $term );
909
910 while (my ($name, $cb) = each %hook) {
911 my $htype = $HOOKTYPE{uc $name};
912 defined $htype
913 or Carp::croak "unsupported hook type '$name'";
914
915 $term->set_should_invoke ($htype, +1);
916 $term->{_hook}[$htype]{ $disable{$htype} = $cb+0 }
917 = sub { shift; $cb->($self, @_) }; # very ugly indeed
918 }
919
920 bless \%disable, "urxvt::extension::on_disable"
921}
922
923=item $self->x_resource ($pattern)
924
925=item $self->x_resource_boolean ($pattern)
926
927These methods support an additional C<%> prefix when called on an
928extension object - see the description of these methods in the
929C<urxvt::term> class for details.
930
931=cut
866 932
867sub x_resource { 933sub x_resource {
868 my ($self, $name) = @_; 934 my ($self, $name) = @_;
869 $name =~ s/^%(\.|$)/$_[0]{_name}$1/; 935 $name =~ s/^%(\.|$)/$_[0]{_name}$1/;
870 $self->{term}->x_resource ($name) 936 $self->{term}->x_resource ($name)
873sub x_resource_boolean { 939sub x_resource_boolean {
874 my ($self, $name) = @_; 940 my ($self, $name) = @_;
875 $name =~ s/^%(\.|$)/$_[0]{_name}$1/; 941 $name =~ s/^%(\.|$)/$_[0]{_name}$1/;
876 $self->{term}->x_resource_boolean ($name) 942 $self->{term}->x_resource_boolean ($name)
877} 943}
944
945=back
946
947=cut
878 948
879package urxvt::anyevent; 949package urxvt::anyevent;
880 950
881=head2 The C<urxvt::anyevent> Class 951=head2 The C<urxvt::anyevent> Class
882 952
1001 $ENV{URXVT_PERL_LIB}, 1071 $ENV{URXVT_PERL_LIB},
1002 "$ENV{HOME}/.urxvt/ext", 1072 "$ENV{HOME}/.urxvt/ext",
1003 "$LIBDIR/perl" 1073 "$LIBDIR/perl"
1004} 1074}
1005 1075
1006sub scan_meta { 1076# scan for available extensions and collect their metadata
1077sub scan_extensions {
1007 my ($self) = @_; 1078 my ($self) = @_;
1079
1080 return if exists $self->{meta};
1081
1008 my @libdirs = perl_libdirs $self; 1082 my @libdirs = perl_libdirs $self;
1009 1083
1010 return if $self->{meta_libdirs} eq join "\x00", @libdirs; 1084 return if $self->{meta_libdirs} eq join "\x00", @libdirs;
1011 1085
1012 my %meta; 1086 my %meta;
1013 1087
1014 $self->{meta_libdirs} = join "\x00", @libdirs; 1088 $self->{meta_libdirs} = join "\x00", @libdirs;
1015 $self->{meta} = \%meta; 1089 $self->{meta} = \%meta;
1016 1090
1091 my %ext;
1092
1093 # first gather extensions
1017 for my $dir (reverse @libdirs) { 1094 for my $dir (reverse @libdirs) {
1018 opendir my $fh, $dir 1095 opendir my $fh, $dir
1019 or next; 1096 or next;
1020 for my $ext (readdir $fh) { 1097 for my $ext (readdir $fh) {
1021 $ext ne "." 1098 $ext !~ /^\./
1022 and $ext ne ".."
1023 and open my $fh, "<", "$dir/$ext" 1099 and open my $fh, "<", "$dir/$ext"
1024 or next; 1100 or next;
1025 1101
1102 my %ext = (dir => $dir);
1103
1026 while (<$fh>) { 1104 while (<$fh>) {
1027 if (/^#:META:X_RESOURCE:(.*)/) { 1105 if (/^#:META:(?:X_)?RESOURCE:(.*)/) {
1028 my ($pattern, $type, $desc) = split /:/, $1; 1106 my ($pattern, $type, $desc) = split /:/, $1;
1029 $pattern =~ s/^%(\.|$)/$ext$1/g; # % in pattern == extension name 1107 $pattern =~ s/^%(\.|$)/$ext$1/g; # % in pattern == extension name
1030 if ($pattern =~ /[^a-zA-Z0-9\-\.]/) { 1108 if ($pattern =~ /[^a-zA-Z0-9\-\.]/) {
1031 warn "$dir/$ext: meta resource '$pattern' contains illegal characters (not alphanumeric nor . nor *)\n"; 1109 warn "$dir/$ext: meta resource '$pattern' contains illegal characters (not alphanumeric nor . nor *)\n";
1032 } else { 1110 } else {
1033 $meta{resource}{$pattern} = [$ext, $type, $desc]; 1111 $ext{resource}{$pattern} = [$ext, $type, $desc];
1034 } 1112 }
1113 } elsif (/^#:META:BINDING:(.*)/) {
1114 my ($keysym, $action) = split /:/, $1;
1115 $ext{binding}{$keysym} = $action;
1035 } elsif (/^\s*(?:#|$)/) { 1116 } elsif (/^\s*(?:#|$)/) {
1036 # skip other comments and empty lines 1117 # skip other comments and empty lines
1037 } else { 1118 } else {
1038 last; # stop parsing on first non-empty non-comment line 1119 last; # stop parsing on first non-empty non-comment line
1039 } 1120 }
1040 } 1121 }
1122
1123 $meta{$ext} = \%ext;
1041 } 1124 }
1125 }
1126
1127 # and now merge resources and bindings
1128 while (my ($k, $v) = each %ext) {
1129 #TODO: should check for extensions overriding each other
1130 %{ $meta{resource} } = (%{ $meta{resource} }, %{ $v->{resource} });
1131 %{ $meta{binding} } = (%{ $meta{binding} }, %{ $v->{binding} });
1042 } 1132 }
1043} 1133}
1044 1134
1045=item $term = new urxvt::term $envhashref, $rxvtname, [arg...] 1135=item $term = new urxvt::term $envhashref, $rxvtname, [arg...]
1046 1136
1066} 1156}
1067 1157
1068=item $term->destroy 1158=item $term->destroy
1069 1159
1070Destroy the terminal object (close the window, free resources 1160Destroy the terminal object (close the window, free resources
1071etc.). Please note that @@RXVT_NAME@@ will not exit as long as any event 1161etc.). Please note that urxvt will not exit as long as any event
1072watchers (timers, io watchers) are still active. 1162watchers (timers, io watchers) are still active.
1073
1074=item $guard = $self->on ($hook_name => $cb[, $hook_name => $cb..])
1075
1076Similar to the extension method C<enable>, but installs additional
1077callbacks for the givne hook(s) (existing ones are not replaced), and
1078returns a guard object. When the guard object is destroyed the callbacks
1079are disabled again.
1080
1081Note that these callbacks receive the normal paramaters, but the first
1082argument (normally the extension) is currently undefined.
1083
1084=cut
1085
1086sub urxvt::term::on_disable::DESTROY {
1087 my $disable = shift;
1088
1089 my $self = delete $disable->{""};
1090
1091 while (my ($htype, $id) = each %$disable) {
1092 delete $self->{_hook}[$htype]{$id};
1093 $self->set_should_invoke ($htype, -1);
1094 }
1095}
1096
1097sub on {
1098 my ($self, %hook) = @_;
1099
1100 my %disable = ( "" => $self );
1101
1102 while (my ($name, $cb) = each %hook) {
1103 my $htype = $HOOKTYPE{uc $name};
1104 defined $htype
1105 or Carp::croak "unsupported hook type '$name'";
1106
1107 my $id = $cb+0;
1108
1109 $self->set_should_invoke ($htype, +1);
1110 $disable{$htype} = $id;
1111 $self->{_hook}[$htype]{$id} = $cb;
1112 }
1113
1114 bless \%disable, "urxvt::term::on_disable"
1115}
1116 1163
1117=item $term->exec_async ($cmd[, @args]) 1164=item $term->exec_async ($cmd[, @args])
1118 1165
1119Works like the combination of the C<fork>/C<exec> builtins, which executes 1166Works like the combination of the C<fork>/C<exec> builtins, which executes
1120("starts") programs in the background. This function takes care of setting 1167("starts") programs in the background. This function takes care of setting
1235 my $res = &x_resource; 1282 my $res = &x_resource;
1236 1283
1237 $res =~ /^\s*(?:true|yes|on|1)\s*$/i ? 1 : defined $res && 0 1284 $res =~ /^\s*(?:true|yes|on|1)\s*$/i ? 1 : defined $res && 0
1238} 1285}
1239 1286
1240=item $success = $term->parse_keysym ($key, $octets) 1287=item $success = $term->bind_action ($key, $octets)
1241 1288
1242Adds a key binding exactly as specified via a resource. See the 1289Adds a key binding exactly as specified via a C<keysym> resource. See the
1243C<keysym> resource in the @@RXVT_NAME@@(1) manpage. 1290C<keysym> resource in the urxvt(1) manpage.
1244
1245=item $term->register_command ($keysym, $modifiermask, $string)
1246
1247Adds a key binding. This is a lower level api compared to
1248C<parse_keysym>, as it expects a parsed key description, and can be
1249used only inside either the C<on_init> hook, to add a binding, or the
1250C<on_register_command> hook, to modify a parsed binding.
1251 1291
1252=item $rend = $term->rstyle ([$new_rstyle]) 1292=item $rend = $term->rstyle ([$new_rstyle])
1253 1293
1254Return and optionally change the current rendition. Text that is output by 1294Return and optionally change the current rendition. Text that is output by
1255the terminal application will use this style. 1295the terminal application will use this style.
1435=item $term->tt_write ($octets) 1475=item $term->tt_write ($octets)
1436 1476
1437Write the octets given in C<$octets> to the tty (i.e. as program input). To 1477Write the octets given in C<$octets> to the tty (i.e. as program input). To
1438pass characters instead of octets, you should convert your strings first 1478pass characters instead of octets, you should convert your strings first
1439to the locale-specific encoding using C<< $term->locale_encode >>. 1479to the locale-specific encoding using C<< $term->locale_encode >>.
1480
1481=item $term->tt_write_user_input ($octets)
1482
1483Like C<tt_write>, but should be used when writing strings in response to
1484the user pressing a key, to invokes the additional actions requested by
1485the user for that case (C<tt_write> doesn't do that).
1486
1487The typical use case would be inside C<on_action> hooks.
1440 1488
1441=item $term->tt_paste ($octets) 1489=item $term->tt_paste ($octets)
1442 1490
1443Write the octets given in C<$octets> to the tty as a paste, converting NL to 1491Write the octets given in C<$octets> to the tty as a paste, converting NL to
1444CR and bracketing the data with control sequences if bracketed paste mode 1492CR and bracketing the data with control sequences if bracketed paste mode
1678} 1726}
1679 1727
1680sub urxvt::line::t { 1728sub urxvt::line::t {
1681 my ($self) = @_; 1729 my ($self) = @_;
1682 1730
1683 if (@_ > 1) 1731 if (@_ > 1) {
1684 {
1685 $self->{term}->ROW_t ($_, $_[1], 0, ($_ - $self->{beg}) * $self->{ncol}, $self->{ncol}) 1732 $self->{term}->ROW_t ($_, $_[1], 0, ($_ - $self->{beg}) * $self->{ncol}, $self->{ncol})
1686 for $self->{beg} .. $self->{end}; 1733 for $self->{beg} .. $self->{end};
1687 } 1734 }
1688 1735
1689 defined wantarray && 1736 defined wantarray &&
1690 substr +(join "", map $self->{term}->ROW_t ($_), $self->{beg} .. $self->{end}), 1737 substr +(join "", map $self->{term}->ROW_t ($_), $self->{beg} .. $self->{end}),
1691 0, $self->{len} 1738 0, $self->{len}
1692} 1739}
1693 1740
1694sub urxvt::line::r { 1741sub urxvt::line::r {
1695 my ($self) = @_; 1742 my ($self) = @_;
1696 1743
1697 if (@_ > 1) 1744 if (@_ > 1) {
1698 {
1699 $self->{term}->ROW_r ($_, $_[1], 0, ($_ - $self->{beg}) * $self->{ncol}, $self->{ncol}) 1745 $self->{term}->ROW_r ($_, $_[1], 0, ($_ - $self->{beg}) * $self->{ncol}, $self->{ncol})
1700 for $self->{beg} .. $self->{end}; 1746 for $self->{beg} .. $self->{end};
1701 } 1747 }
1702 1748
1703 if (defined wantarray) { 1749 if (defined wantarray) {
1704 my $rend = [ 1750 my $rend = [
1705 map @{ $self->{term}->ROW_r ($_) }, $self->{beg} .. $self->{end} 1751 map @{ $self->{term}->ROW_r ($_) }, $self->{beg} .. $self->{end}
1706 ]; 1752 ];

Diff Legend

Removed lines
+ Added lines
< Changed lines
> Changed lines