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.223 by root, Sat Jul 14 08:00:18 2012 UTC vs.
Revision 1.250 by sf-exg, Fri Dec 26 21:49:11 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
48Extensions that add command line parameters or resources on their own are 48Extensions may add additional resources and C<actions>, i.e., methods
49loaded automatically when used. 49which can be bound to a key and invoked by the user. An extension can
50define the resources it support using so called META comments,
51described below. Similarly to builtin resources, extension resources
52can also be specified on the command line as long options (with C<.>
53replaced by C<->), in which case the corresponding extension is loaded
54automatically. For this to work the extension B<must> define META
55comments for its resources.
50 56
51=head1 API DOCUMENTATION 57=head1 API DOCUMENTATION
52 58
53=head2 General API Considerations 59=head2 General API Considerations
54 60
… …
106C<urxvt::term> class on this object. 112C<urxvt::term> class on this object.
107 113
108Additional methods only supported for extension objects are described in 114Additional methods only supported for extension objects are described in
109the C<urxvt::extension> section below. 115the C<urxvt::extension> section below.
110 116
117=head2 META comments
118
119Rxvt-unicode recognizes special meta comments in extensions that define
120different types of metadata.
121
122Currently, it recognises only one such comment:
123
124=over 4
125
126=item #:META:RESOURCE:name:type:desc
127
128The RESOURCE comment defines a resource used by the extension, where
129C<name> is the resource name, C<type> is the resource type, C<boolean>
130or C<string>, and C<desc> is the resource description.
131
132=back
133
111=head2 Hooks 134=head2 Hooks
112 135
113The following subroutines can be declared in extension files, and will be 136The following subroutines can be declared in extension files, and will be
114called whenever the relevant event happens. 137called whenever the relevant event happens.
115 138
… …
281 304
282=item on_refresh_end $term 305=item on_refresh_end $term
283 306
284Called just after the screen gets redrawn. See C<on_refresh_begin>. 307Called just after the screen gets redrawn. See C<on_refresh_begin>.
285 308
309=item on_action $term, $string
310
311Called whenever an action is invoked for the corresponding extension
312(e.g. via a C<extension:string> builtin action bound to a key, see
313description of the B<keysym> resource in the urxvt(1) manpage). The
314event is simply the action string. Note that an action event is always
315associated to a single extension.
316
286=item on_user_command $term, $string 317=item on_user_command $term, $string *DEPRECATED*
287 318
288Called whenever a user-configured event is being activated (e.g. via 319Called whenever a user-configured event is being activated (e.g. via
289a C<perl:string> action bound to a key, see description of the B<keysym> 320a C<perl:string> action bound to a key, see description of the B<keysym>
290resource in the @@RXVT_NAME@@(1) manpage). 321resource in the urxvt(1) manpage).
291 322
292The event is simply the action string. This interface is assumed to change 323The event is simply the action string. This interface is going away in
293slightly in the future. 324preference to the C<on_action> hook.
294
295=item on_register_command $term, $keysym, $modifiermask, $string
296
297Called after parsing a keysym resource but before registering the
298associated binding. If this hook returns TRUE the binding is not
299registered. It can be used to modify a binding by calling
300C<register_command>.
301 325
302=item on_resize_all_windows $term, $new_width, $new_height 326=item on_resize_all_windows $term, $new_width, $new_height
303 327
304Called just after the new window size has been calculated, but before 328Called just after the new window size has been calculated, but before
305windows are actually being resized or hints are being set. If this hook 329windows are actually being resized or hints are being set. If this hook
306returns TRUE, setting of the window hints is being skipped. 330returns a true value, setting of the window hints is being skipped.
307 331
308=item on_x_event $term, $event 332=item on_x_event $term, $event
309 333
310Called on every X event received on the vt window (and possibly other 334Called on every X event received on the vt window (and possibly other
311windows). Should only be used as a last resort. Most event structure 335windows). Should only be used as a last resort. Most event structure
… …
350manpage), with the additional members C<row> and C<col>, which are the 374manpage), with the additional members C<row> and C<col>, which are the
351(real, not screen-based) row and column under the mouse cursor. 375(real, not screen-based) row and column under the mouse cursor.
352 376
353C<on_key_press> additionally receives the string rxvt-unicode would 377C<on_key_press> additionally receives the string rxvt-unicode would
354output, if any, in locale-specific encoding. 378output, if any, in locale-specific encoding.
355
356subwindow.
357 379
358=item on_client_message $term, $event 380=item on_client_message $term, $event
359 381
360=item on_wm_protocols $term, $event 382=item on_wm_protocols $term, $event
361 383
… …
564no warnings 'utf8'; 586no warnings 'utf8';
565 587
566sub parse_resource { 588sub parse_resource {
567 my ($term, $name, $isarg, $longopt, $flag, $value) = @_; 589 my ($term, $name, $isarg, $longopt, $flag, $value) = @_;
568 590
569 $name =~ y/-/./ if $isarg;
570
571 $term->scan_meta; 591 $term->scan_extensions;
572 592
573 my $r = $term->{meta}{resource}; 593 my $r = $term->{meta}{resource};
574 keys %$r; # reste iterator 594 keys %$r; # reset iterator
575 while (my ($pattern, $v) = each %$r) { 595 while (my ($k, $v) = each %$r) {
576 if ( 596 my $pattern = $k;
597 $pattern =~ y/./-/ if $isarg;
598 my $prefix = $name;
599 my $suffix;
577 $pattern =~ /\.$/ 600 if ($pattern =~ /\-$/) {
578 ? $pattern eq substr $name, 0, length $pattern 601 $prefix = substr $name, 0, length $pattern;
579 : $pattern eq $name 602 $suffix = substr $name, length $pattern;
580 ) { 603 }
604 if ($pattern eq $prefix) {
581 $name = "$urxvt::RESCLASS.$name"; 605 $name = "$urxvt::RESCLASS.$k$suffix";
582 606
583 push @{ $term->{perl_ext_3} }, $v->[0]; 607 push @{ $term->{perl_ext_3} }, $v->[0];
584 608
585 if ($v->[1] eq "boolean") { 609 if ($v->[1] eq "boolean") {
586 $term->put_option_db ($name, $flag ? "true" : "false"); 610 $term->put_option_db ($name, $flag ? "true" : "false");
… …
596} 620}
597 621
598sub usage { 622sub usage {
599 my ($term, $usage_type) = @_; 623 my ($term, $usage_type) = @_;
600 624
601 $term->scan_meta; 625 $term->scan_extensions;
602 626
603 my $r = $term->{meta}{resource}; 627 my $r = $term->{meta}{resource};
604 628
605 for my $pattern (sort keys %$r) { 629 for my $pattern (sort keys %$r) {
606 my ($ext, $type, $desc) = @{ $r->{$pattern} }; 630 my ($ext, $type, $desc) = @{ $r->{$pattern} };
… …
667# called by the rxvt core 691# called by the rxvt core
668sub invoke { 692sub invoke {
669 local $TERM = shift; 693 local $TERM = shift;
670 my $htype = shift; 694 my $htype = shift;
671 695
672 if ($htype == 0) { # INIT 696 if ($htype == HOOK_INIT) {
673 my @dirs = $TERM->perl_libdirs; 697 my @dirs = $TERM->perl_libdirs;
698
699 $TERM->scan_extensions;
674 700
675 my %ext_arg; 701 my %ext_arg;
676 702
677 { 703 {
678 my @init = @TERM_INIT; 704 my @init = @TERM_INIT;
… …
682 @TERM_EXT = (); 708 @TERM_EXT = ();
683 $TERM->register_package ($_) for @pkg; 709 $TERM->register_package ($_) for @pkg;
684 } 710 }
685 711
686 for ( 712 for (
713 (grep $_, map { split /,/, $TERM->resource ("perl_ext_$_") } 1, 2),
687 @{ delete $TERM->{perl_ext_3} }, 714 @{ delete $TERM->{perl_ext_3} }
688 grep $_, map { split /,/, $TERM->resource ("perl_ext_$_") } 1, 2
689 ) { 715 ) {
690 if ($_ eq "default") { 716 if ($_ eq "default") {
717
718 $ext_arg{$_} = []
691 $ext_arg{$_} ||= [] for qw(selection option-popup selection-popup searchable-scrollback readline); 719 for qw(selection option-popup selection-popup readline searchable-scrollback);
720
721 for ($TERM->_keysym_resources) {
722 next if /^(?:string|command|builtin|builtin-string|perl)/;
723 next unless /^([A-Za-z0-9_\-]+):/;
724
725 my $ext = $1;
726
727 $ext_arg{$ext} = [];
728 }
729
692 } elsif (/^-(.*)$/) { 730 } elsif (/^-(.*)$/) {
693 delete $ext_arg{$1}; 731 delete $ext_arg{$1};
732
694 } elsif (/^([^<]+)<(.*)>$/) { 733 } elsif (/^([^<]+)<(.*)>$/) {
695 push @{ $ext_arg{$1} }, $2; 734 push @{ $ext_arg{$1} }, $2;
735
696 } else { 736 } else {
697 $ext_arg{$_} ||= []; 737 $ext_arg{$_} ||= [];
698 } 738 }
699 } 739 }
700 740
… …
716 756
717 if (my $cb = $TERM->{_hook}[$htype]) { 757 if (my $cb = $TERM->{_hook}[$htype]) {
718 verbose 10, "$HOOKNAME[$htype] (" . (join ", ", $TERM, @_) . ")" 758 verbose 10, "$HOOKNAME[$htype] (" . (join ", ", $TERM, @_) . ")"
719 if $verbosity >= 10; 759 if $verbosity >= 10;
720 760
761 if ($htype == HOOK_ACTION) {
762 # this hook is only sent to the extension with the name
763 # matching the first arg
764 my $pkg = shift;
765 $pkg =~ y/-/_/;
766 $pkg = "urxvt::ext::$pkg";
767
768 $cb = $cb->{$pkg}
769 or return undef; #TODO: maybe warn user?
770
771 $cb = { $pkg => $cb };
772 }
773
721 for my $pkg (keys %$cb) { 774 for my $pkg (keys %$cb) {
722 my $retval_ = eval { $cb->{$pkg}->($TERM->{_pkg}{$pkg} || $TERM, @_) }; 775 my $retval_ = eval { $cb->{$pkg}->($TERM->{_pkg}{$pkg} || $TERM, @_) };
723 $retval ||= $retval_; 776 $retval ||= $retval_;
724 777
725 if ($@) { 778 if ($@) {
… …
730 783
731 verbose 11, "$HOOKNAME[$htype] returning <$retval>" 784 verbose 11, "$HOOKNAME[$htype] returning <$retval>"
732 if $verbosity >= 11; 785 if $verbosity >= 11;
733 } 786 }
734 787
735 if ($htype == 1) { # DESTROY 788 if ($htype == HOOK_DESTROY) {
736 # clear package objects 789 # clear package objects
737 %$_ = () for values %{ $TERM->{_pkg} }; 790 %$_ = () for values %{ $TERM->{_pkg} };
738 791
739 # clear package 792 # clear package
740 %$TERM = (); 793 %$TERM = ();
… …
827} 880}
828 881
829=item $self->enable ($hook_name => $cb[, $hook_name => $cb..]) 882=item $self->enable ($hook_name => $cb[, $hook_name => $cb..])
830 883
831Dynamically enable the given hooks (named without the C<on_> prefix) for 884Dynamically enable the given hooks (named without the C<on_> prefix) for
832this extension, replacing any previous hook. This is useful when you want 885this extension, replacing any hook previously installed via C<enable> in
833to overwrite time-critical hooks only temporarily. 886this extension.
887
888This is useful when you want to overwrite time-critical hooks only
889temporarily.
834 890
835To install additional callbacks for the same hook, you can use the C<on> 891To install additional callbacks for the same hook, you can use the C<on>
836method of the C<urxvt::term> class. 892method of the C<urxvt::term> class.
837 893
838=item $self->disable ($hook_name[, $hook_name..]) 894=item $self->disable ($hook_name[, $hook_name..])
… …
884 my $disable = shift; 940 my $disable = shift;
885 941
886 my $term = delete $disable->{""}; 942 my $term = delete $disable->{""};
887 943
888 while (my ($htype, $id) = each %$disable) { 944 while (my ($htype, $id) = each %$disable) {
889 warn "disable hook $htype,$id\n";#d#
890 delete $term->{_hook}[$htype]{$id}; 945 delete $term->{_hook}[$htype]{$id};
891 $term->set_should_invoke ($htype, -1); 946 $term->set_should_invoke ($htype, -1);
892 } 947 }
893} 948}
894 949
… …
910 } 965 }
911 966
912 bless \%disable, "urxvt::extension::on_disable" 967 bless \%disable, "urxvt::extension::on_disable"
913} 968}
914 969
970=item $self->bind_action ($hotkey, $action)
971
915=item $self->x_resource ($pattern) 972=item $self->x_resource ($pattern)
916 973
917=item $self->x_resource_boolean ($pattern) 974=item $self->x_resource_boolean ($pattern)
918 975
919These methods support an additional C<%> prefix when called on an 976These methods support an additional C<%> prefix for C<$action> or
920extension object - see the description of these methods in the 977C<$pattern> when called on an extension object, compared to the
978C<urxvt::term> methods of the same name - see the description of these
921C<urxvt::term> class for details. 979methods in the C<urxvt::term> class for details.
922 980
923=cut 981=cut
982
983sub bind_action {
984 my ($self, $hotkey, $action) = @_;
985 $action =~ s/^%:/$_[0]{_name}:/;
986 $self->{term}->bind_action ($hotkey, $action)
987}
924 988
925sub x_resource { 989sub x_resource {
926 my ($self, $name) = @_; 990 my ($self, $name) = @_;
927 $name =~ s/^%(\.|$)/$_[0]{_name}$1/; 991 $name =~ s/^%(\.|$)/$_[0]{_name}$1/;
928 $self->{term}->x_resource ($name) 992 $self->{term}->x_resource ($name)
… …
1063 $ENV{URXVT_PERL_LIB}, 1127 $ENV{URXVT_PERL_LIB},
1064 "$ENV{HOME}/.urxvt/ext", 1128 "$ENV{HOME}/.urxvt/ext",
1065 "$LIBDIR/perl" 1129 "$LIBDIR/perl"
1066} 1130}
1067 1131
1068sub scan_meta { 1132# scan for available extensions and collect their metadata
1133sub scan_extensions {
1069 my ($self) = @_; 1134 my ($self) = @_;
1135
1136 return if exists $self->{meta};
1137
1070 my @libdirs = perl_libdirs $self; 1138 my @urxvtdirs = perl_libdirs $self;
1139 my @cpandirs = grep -d, map "$_/URxvt/Ext", @INC;
1071 1140
1072 return if $self->{meta_libdirs} eq join "\x00", @libdirs;
1073
1074 my %meta;
1075
1076 $self->{meta_libdirs} = join "\x00", @libdirs;
1077 $self->{meta} = \%meta; 1141 $self->{meta} = \my %meta;
1078 1142
1079 for my $dir (reverse @libdirs) { 1143 # first gather extensions
1144
1145 my $gather = sub {
1146 my ($dir, $core) = @_;
1147
1080 opendir my $fh, $dir 1148 opendir my $fh, $dir
1081 or next; 1149 or return;
1150
1082 for my $ext (readdir $fh) { 1151 for my $ext (readdir $fh) {
1083 $ext ne "." 1152 $ext !~ /^\./
1084 and $ext ne ".."
1085 and open my $fh, "<", "$dir/$ext"
1086 or next; 1153 or next;
1087 1154
1155 open my $fh, "<", "$dir/$ext"
1156 or next;
1157
1158 -f $fh
1159 or next;
1160
1161 $ext =~ s/\.uext$// or $core
1162 or next;
1163
1164 my %ext = (dir => $dir);
1165
1088 while (<$fh>) { 1166 while (<$fh>) {
1089 if (/^#:META:X_RESOURCE:(.*)/) { 1167 if (/^#:META:(?:X_)?RESOURCE:(.*)/) {
1090 my ($pattern, $type, $desc) = split /:/, $1; 1168 my ($pattern, $type, $desc) = split /:/, $1;
1091 $pattern =~ s/^%(\.|$)/$ext$1/g; # % in pattern == extension name 1169 $pattern =~ s/^%(\.|$)/$ext$1/g; # % in pattern == extension name
1092 if ($pattern =~ /[^a-zA-Z0-9\-\.]/) { 1170 if ($pattern =~ /[^a-zA-Z0-9\-\.]/) {
1093 warn "$dir/$ext: meta resource '$pattern' contains illegal characters (not alphanumeric nor . nor *)\n"; 1171 warn "$dir/$ext: meta resource '$pattern' contains illegal characters (not alphanumeric nor . nor *)\n";
1094 } else { 1172 } else {
1095 $meta{resource}{$pattern} = [$ext, $type, $desc]; 1173 $ext{resource}{$pattern} = [$ext, $type, $desc];
1096 } 1174 }
1097 } elsif (/^\s*(?:#|$)/) { 1175 } elsif (/^\s*(?:#|$)/) {
1098 # skip other comments and empty lines 1176 # skip other comments and empty lines
1099 } else { 1177 } else {
1100 last; # stop parsing on first non-empty non-comment line 1178 last; # stop parsing on first non-empty non-comment line
1101 } 1179 }
1102 } 1180 }
1181
1182 $meta{ext}{$ext} = \%ext;
1103 } 1183 }
1184 };
1185
1186 $gather->($_, 0) for @cpandirs;
1187 $gather->($_, 1) for @urxvtdirs;
1188
1189 # and now merge resources
1190 while (my ($k, $v) = each %{ $meta{ext} }) {
1191 #TODO: should check for extensions overriding each other
1192 %{ $meta{resource} } = (%{ $meta{resource} }, %{ $v->{resource} });
1104 } 1193 }
1105} 1194}
1106 1195
1107=item $term = new urxvt::term $envhashref, $rxvtname, [arg...] 1196=item $term = new urxvt::term $envhashref, $rxvtname, [arg...]
1108 1197
… …
1128} 1217}
1129 1218
1130=item $term->destroy 1219=item $term->destroy
1131 1220
1132Destroy the terminal object (close the window, free resources 1221Destroy the terminal object (close the window, free resources
1133etc.). Please note that @@RXVT_NAME@@ will not exit as long as any event 1222etc.). Please note that urxvt will not exit as long as any event
1134watchers (timers, io watchers) are still active. 1223watchers (timers, io watchers) are still active.
1135 1224
1136=item $term->exec_async ($cmd[, @args]) 1225=item $term->exec_async ($cmd[, @args])
1137 1226
1138Works like the combination of the C<fork>/C<exec> builtins, which executes 1227Works like the combination of the C<fork>/C<exec> builtins, which executes
… …
1224Returns the X-Resource for the given pattern, excluding the program or 1313Returns the X-Resource for the given pattern, excluding the program or
1225class name, i.e. C<< $term->x_resource ("boldFont") >> should return the 1314class name, i.e. C<< $term->x_resource ("boldFont") >> should return the
1226same value as used by this instance of rxvt-unicode. Returns C<undef> if no 1315same value as used by this instance of rxvt-unicode. Returns C<undef> if no
1227resource with that pattern exists. 1316resource with that pattern exists.
1228 1317
1229Extensions that define extra resource or command line arguments also need 1318Extensions that define extra resources also need to call this method
1230to call this method to access their values. 1319to access their values.
1231 1320
1232If the method is called on an extension object (basically, from an 1321If the method is called on an extension object (basically, from an
1233extension), then the special prefix C<%.> will be replaced by the name of 1322extension), then the special prefix C<%.> will be replaced by the name of
1234the extension and a dot, and the lone string C<%> will be replaced by the 1323the extension and a dot, and the lone string C<%> will be replaced by the
1235extension name itself. This makes it possible to code extensions so you 1324extension name itself. This makes it possible to code extensions so you
1236can rename them and get a new set of commandline switches and resources 1325can rename them and get a new set of resources without having to change
1237without having to change the actual code. 1326the actual code.
1238 1327
1239This method should only be called during the C<on_start> hook, as there is 1328This method should only be called during the C<on_start> hook, as there is
1240only one resource database per display, and later invocations might return 1329only one resource database per display, and later invocations might return
1241the wrong resources. 1330the wrong resources.
1242 1331
… …
1254 my $res = &x_resource; 1343 my $res = &x_resource;
1255 1344
1256 $res =~ /^\s*(?:true|yes|on|1)\s*$/i ? 1 : defined $res && 0 1345 $res =~ /^\s*(?:true|yes|on|1)\s*$/i ? 1 : defined $res && 0
1257} 1346}
1258 1347
1259=item $success = $term->parse_keysym ($key, $octets) 1348=item $success = $term->bind_action ($key, $action)
1260 1349
1261Adds a key binding exactly as specified via a resource. See the 1350Adds a key binding exactly as specified via a C<keysym> resource. See the
1262C<keysym> resource in the @@RXVT_NAME@@(1) manpage. 1351C<keysym> resource in the urxvt(1) manpage.
1263 1352
1264=item $term->register_command ($keysym, $modifiermask, $string) 1353To add default bindings for actions, an extension should call C<<
1354->bind_action >> in its C<init> hook for every such binding. Doing it
1355in the C<init> hook allows users to override or remove the binding
1356again.
1265 1357
1266Adds a key binding. This is a lower level api compared to 1358Example: the C<searchable-scrollback> by default binds itself
1267C<parse_keysym>, as it expects a parsed key description, and can be 1359on C<Meta-s>, using C<< $self->bind_action >>, which calls C<<
1268used only inside either the C<on_init> hook, to add a binding, or the 1360$term->bind_action >>.
1269C<on_register_command> hook, to modify a parsed binding. 1361
1362 sub init {
1363 my ($self) = @_;
1364
1365 $self->bind_action ("M-s" => "%:start");
1366 }
1270 1367
1271=item $rend = $term->rstyle ([$new_rstyle]) 1368=item $rend = $term->rstyle ([$new_rstyle])
1272 1369
1273Return and optionally change the current rendition. Text that is output by 1370Return and optionally change the current rendition. Text that is output by
1274the terminal application will use this style. 1371the terminal application will use this style.
… …
1432 1529
1433=item $term->scr_add_lines ($string) 1530=item $term->scr_add_lines ($string)
1434 1531
1435Write the given text string to the screen, as if output by the application 1532Write the given text string to the screen, as if output by the application
1436running inside the terminal. It may not contain command sequences (escape 1533running inside the terminal. It may not contain command sequences (escape
1437codes), but is free to use line feeds, carriage returns and tabs. The 1534codes - see C<cmd_parse> for that), but is free to use line feeds,
1438string is a normal text string, not in locale-dependent encoding. 1535carriage returns and tabs. The string is a normal text string, not in
1536locale-dependent encoding.
1439 1537
1440Normally its not a good idea to use this function, as programs might be 1538Normally its not a good idea to use this function, as programs might be
1441confused by changes in cursor position or scrolling. Its useful inside a 1539confused by changes in cursor position or scrolling. Its useful inside a
1442C<on_add_lines> hook, though. 1540C<on_add_lines> hook, though.
1443 1541
… …
1451locale-specific encoding of the terminal and can contain command sequences 1549locale-specific encoding of the terminal and can contain command sequences
1452(escape codes) that will be interpreted. 1550(escape codes) that will be interpreted.
1453 1551
1454=item $term->tt_write ($octets) 1552=item $term->tt_write ($octets)
1455 1553
1456Write the octets given in C<$octets> to the tty (i.e. as program input). To 1554Write the octets given in C<$octets> to the tty (i.e. as user input
1555to the program, see C<cmd_parse> for the opposite direction). To pass
1457pass characters instead of octets, you should convert your strings first 1556characters instead of octets, you should convert your strings first to the
1458to the locale-specific encoding using C<< $term->locale_encode >>. 1557locale-specific encoding using C<< $term->locale_encode >>.
1558
1559=item $term->tt_write_user_input ($octets)
1560
1561Like C<tt_write>, but should be used when writing strings in response to
1562the user pressing a key, to invoke the additional actions requested by
1563the user for that case (C<tt_write> doesn't do that).
1564
1565The typical use case would be inside C<on_action> hooks.
1459 1566
1460=item $term->tt_paste ($octets) 1567=item $term->tt_paste ($octets)
1461 1568
1462Write the octets given in C<$octets> to the tty as a paste, converting NL to 1569Write the octets given in C<$octets> to the tty as a paste, converting NL to
1463CR and bracketing the data with control sequences if bracketed paste mode 1570CR and bracketing the data with control sequences if bracketed paste mode
… …
1697} 1804}
1698 1805
1699sub urxvt::line::t { 1806sub urxvt::line::t {
1700 my ($self) = @_; 1807 my ($self) = @_;
1701 1808
1702 if (@_ > 1) 1809 if (@_ > 1) {
1703 {
1704 $self->{term}->ROW_t ($_, $_[1], 0, ($_ - $self->{beg}) * $self->{ncol}, $self->{ncol}) 1810 $self->{term}->ROW_t ($_, $_[1], 0, ($_ - $self->{beg}) * $self->{ncol}, $self->{ncol})
1705 for $self->{beg} .. $self->{end}; 1811 for $self->{beg} .. $self->{end};
1706 } 1812 }
1707 1813
1708 defined wantarray && 1814 defined wantarray &&
1709 substr +(join "", map $self->{term}->ROW_t ($_), $self->{beg} .. $self->{end}), 1815 substr +(join "", map $self->{term}->ROW_t ($_), $self->{beg} .. $self->{end}),
1710 0, $self->{len} 1816 0, $self->{len}
1711} 1817}
1712 1818
1713sub urxvt::line::r { 1819sub urxvt::line::r {
1714 my ($self) = @_; 1820 my ($self) = @_;
1715 1821
1716 if (@_ > 1) 1822 if (@_ > 1) {
1717 {
1718 $self->{term}->ROW_r ($_, $_[1], 0, ($_ - $self->{beg}) * $self->{ncol}, $self->{ncol}) 1823 $self->{term}->ROW_r ($_, $_[1], 0, ($_ - $self->{beg}) * $self->{ncol}, $self->{ncol})
1719 for $self->{beg} .. $self->{end}; 1824 for $self->{beg} .. $self->{end};
1720 } 1825 }
1721 1826
1722 if (defined wantarray) { 1827 if (defined wantarray) {
1723 my $rend = [ 1828 my $rend = [
1724 map @{ $self->{term}->ROW_r ($_) }, $self->{beg} .. $self->{end} 1829 map @{ $self->{term}->ROW_r ($_) }, $self->{beg} .. $self->{end}
1725 ]; 1830 ];

Diff Legend

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