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.236 by root, Sat May 17 17:12:29 2014 UTC vs.
Revision 1.254 by sf-exg, Tue Mar 17 09:23:08 2015 UTC

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
280code is run after this hook, and takes precedence. 303code is run after this hook, and takes precedence.
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>.
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.
285 316
286=item on_user_command $term, $string *DEPRECATED* 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>
555no warnings 'utf8'; 586no warnings 'utf8';
556 587
557sub parse_resource { 588sub parse_resource {
558 my ($term, $name, $isarg, $longopt, $flag, $value) = @_; 589 my ($term, $name, $isarg, $longopt, $flag, $value) = @_;
559 590
560 $name =~ y/-/./ if $isarg;
561
562 $term->scan_extensions; 591 $term->scan_extensions;
563 592
564 my $r = $term->{meta}{resource}; 593 my $r = $term->{meta}{resource};
565 keys %$r; # reset iterator 594 keys %$r; # reset iterator
566 while (my ($pattern, $v) = each %$r) { 595 while (my ($k, $v) = each %$r) {
567 if ( 596 my $pattern = $k;
597 $pattern =~ y/./-/ if $isarg;
598 my $prefix = $name;
599 my $suffix;
568 $pattern =~ /\.$/ 600 if ($pattern =~ /\-$/) {
569 ? $pattern eq substr $name, 0, length $pattern 601 $prefix = substr $name, 0, length $pattern;
570 : $pattern eq $name 602 $suffix = substr $name, length $pattern;
571 ) { 603 }
604 if ($pattern eq $prefix) {
572 $name = "$urxvt::RESCLASS.$name"; 605 $name = "$urxvt::RESCLASS.$k$suffix";
573 606
574 push @{ $term->{perl_ext_3} }, $v->[0]; 607 push @{ $term->{perl_ext_3} }, $v->[0];
575 608
576 if ($v->[1] eq "boolean") { 609 if ($v->[1] eq "boolean") {
577 $term->put_option_db ($name, $flag ? "true" : "false"); 610 $term->put_option_db ($name, $flag ? "true" : "false");
675 @TERM_EXT = (); 708 @TERM_EXT = ();
676 $TERM->register_package ($_) for @pkg; 709 $TERM->register_package ($_) for @pkg;
677 } 710 }
678 711
679 for ( 712 for (
713 (grep $_, map { split /,/, $TERM->resource ("perl_ext_$_") } 1, 2),
680 @{ delete $TERM->{perl_ext_3} }, 714 @{ delete $TERM->{perl_ext_3} }
681 grep $_, map { split /,/, $TERM->resource ("perl_ext_$_") } 1, 2
682 ) { 715 ) {
683 if ($_ eq "default") { 716 if ($_ eq "default") {
684 717
685 $ext_arg{$_} ||= [] 718 $ext_arg{$_} = []
686 for
687 qw(selection option-popup selection-popup readline), 719 for qw(selection option-popup selection-popup readline searchable-scrollback);
688 map $_->[0], values %{ $TERM->{meta}{binding} }; 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 }
689 729
690 } elsif (/^-(.*)$/) { 730 } elsif (/^-(.*)$/) {
691 delete $ext_arg{$1}; 731 delete $ext_arg{$1};
692 732
693 } elsif (/^([^<]+)<(.*)>$/) { 733 } elsif (/^([^<]+)<(.*)>$/) {
694 push @{ $ext_arg{$1} }, $2; 734 push @{ $ext_arg{$1} }, $2;
695 735
696 } else { 736 } else {
697 $ext_arg{$_} ||= []; 737 $ext_arg{$_} ||= [];
698 } 738 }
699 }
700
701 # now register default key bindings
702 while (my ($k, $v) = each %{ $TERM->{meta}{binding} }) {
703 $TERM->bind_action ($k, "$v->[0]:$v->[1]");
704 } 739 }
705 740
706 for my $ext (sort keys %ext_arg) { 741 for my $ext (sort keys %ext_arg) {
707 my @files = grep -f $_, map "$_/$ext", @dirs; 742 my @files = grep -f $_, map "$_/$ext", @dirs;
708 743
930 } 965 }
931 966
932 bless \%disable, "urxvt::extension::on_disable" 967 bless \%disable, "urxvt::extension::on_disable"
933} 968}
934 969
970=item $self->bind_action ($hotkey, $action)
971
935=item $self->x_resource ($pattern) 972=item $self->x_resource ($pattern)
936 973
937=item $self->x_resource_boolean ($pattern) 974=item $self->x_resource_boolean ($pattern)
938 975
939These methods support an additional C<%> prefix when called on an 976These methods support an additional C<%> prefix for C<$action> or
940extension 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
941C<urxvt::term> class for details. 979methods in the C<urxvt::term> class for details.
942 980
943=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}
944 988
945sub x_resource { 989sub x_resource {
946 my ($self, $name) = @_; 990 my ($self, $name) = @_;
947 $name =~ s/^%(\.|$)/$_[0]{_name}$1/; 991 $name =~ s/^%(\.|$)/$_[0]{_name}$1/;
948 $self->{term}->x_resource ($name) 992 $self->{term}->x_resource ($name)
1089sub scan_extensions { 1133sub scan_extensions {
1090 my ($self) = @_; 1134 my ($self) = @_;
1091 1135
1092 return if exists $self->{meta}; 1136 return if exists $self->{meta};
1093 1137
1094 my @libdirs = perl_libdirs $self; 1138 my @urxvtdirs = perl_libdirs $self;
1139# my @cpandirs = grep -d, map "$_/URxvt/Ext", @INC;
1095 1140
1096# return if $self->{meta_libdirs} eq join "\x00", @libdirs;#d#
1097
1098# $self->{meta_libdirs} = join "\x00", @libdirs;#d#
1099 $self->{meta} = \my %meta; 1141 $self->{meta} = \my %meta;
1100 1142
1101 # first gather extensions 1143 # first gather extensions
1102 for my $dir (reverse @libdirs) { 1144
1145 my $gather = sub {
1146 my ($dir, $core) = @_;
1147
1103 opendir my $fh, $dir 1148 opendir my $fh, $dir
1104 or next; 1149 or return;
1150
1105 for my $ext (readdir $fh) { 1151 for my $ext (readdir $fh) {
1106 $ext !~ /^\./ 1152 $ext !~ /^\./
1153 or next;
1154
1107 and open my $fh, "<", "$dir/$ext" 1155 open my $fh, "<", "$dir/$ext"
1156 or next;
1157
1158 -f $fh
1159 or next;
1160
1161 $ext =~ s/\.uext$// or $core
1108 or next; 1162 or next;
1109 1163
1110 my %ext = (dir => $dir); 1164 my %ext = (dir => $dir);
1111 1165
1112 while (<$fh>) { 1166 while (<$fh>) {
1116 if ($pattern =~ /[^a-zA-Z0-9\-\.]/) { 1170 if ($pattern =~ /[^a-zA-Z0-9\-\.]/) {
1117 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";
1118 } else { 1172 } else {
1119 $ext{resource}{$pattern} = [$ext, $type, $desc]; 1173 $ext{resource}{$pattern} = [$ext, $type, $desc];
1120 } 1174 }
1121 } elsif (/^#:META:BINDING:(.*)/) {
1122 my ($keysym, $action) = split /:/, $1;
1123 $ext{binding}{$keysym} = [$ext, $action];
1124 } elsif (/^\s*(?:#|$)/) { 1175 } elsif (/^\s*(?:#|$)/) {
1125 # skip other comments and empty lines 1176 # skip other comments and empty lines
1126 } else { 1177 } else {
1127 last; # stop parsing on first non-empty non-comment line 1178 last; # stop parsing on first non-empty non-comment line
1128 } 1179 }
1129 } 1180 }
1130 1181
1131 $meta{ext}{$ext} = \%ext; 1182 $meta{ext}{$ext} = \%ext;
1132 } 1183 }
1133 } 1184 };
1134 1185
1186# $gather->($_, 0) for @cpandirs;
1187 $gather->($_, 1) for @urxvtdirs;
1188
1135 # and now merge resources and bindings 1189 # and now merge resources
1190
1191 $meta{resource} = \my %resource;
1192
1136 while (my ($k, $v) = each %{ $meta{ext} }) { 1193 while (my ($k, $v) = each %{ $meta{ext} }) {
1137 #TODO: should check for extensions overriding each other 1194 #TODO: should check for extensions overriding each other
1138 %{ $meta{resource} } = (%{ $meta{resource} }, %{ $v->{resource} }); 1195 %resource = (%resource, %{ $v->{resource} });
1139 %{ $meta{binding} } = (%{ $meta{binding} }, %{ $v->{binding} });
1140 } 1196 }
1141} 1197}
1142 1198
1143=item $term = new urxvt::term $envhashref, $rxvtname, [arg...] 1199=item $term = new urxvt::term $envhashref, $rxvtname, [arg...]
1144 1200
1260Returns the X-Resource for the given pattern, excluding the program or 1316Returns the X-Resource for the given pattern, excluding the program or
1261class name, i.e. C<< $term->x_resource ("boldFont") >> should return the 1317class name, i.e. C<< $term->x_resource ("boldFont") >> should return the
1262same value as used by this instance of rxvt-unicode. Returns C<undef> if no 1318same value as used by this instance of rxvt-unicode. Returns C<undef> if no
1263resource with that pattern exists. 1319resource with that pattern exists.
1264 1320
1265Extensions that define extra resource or command line arguments also need 1321Extensions that define extra resources also need to call this method
1266to call this method to access their values. 1322to access their values.
1267 1323
1268If the method is called on an extension object (basically, from an 1324If the method is called on an extension object (basically, from an
1269extension), then the special prefix C<%.> will be replaced by the name of 1325extension), then the special prefix C<%.> will be replaced by the name of
1270the extension and a dot, and the lone string C<%> will be replaced by the 1326the extension and a dot, and the lone string C<%> will be replaced by the
1271extension name itself. This makes it possible to code extensions so you 1327extension name itself. This makes it possible to code extensions so you
1272can rename them and get a new set of commandline switches and resources 1328can rename them and get a new set of resources without having to change
1273without having to change the actual code. 1329the actual code.
1274 1330
1275This method should only be called during the C<on_start> hook, as there is 1331This method should only be called during the C<on_start> hook, as there is
1276only one resource database per display, and later invocations might return 1332only one resource database per display, and later invocations might return
1277the wrong resources. 1333the wrong resources.
1278 1334
1290 my $res = &x_resource; 1346 my $res = &x_resource;
1291 1347
1292 $res =~ /^\s*(?:true|yes|on|1)\s*$/i ? 1 : defined $res && 0 1348 $res =~ /^\s*(?:true|yes|on|1)\s*$/i ? 1 : defined $res && 0
1293} 1349}
1294 1350
1351=item $action = $term->lookup_keysym ($keysym, $state)
1352
1353Returns the action bound to key combination C<($keysym, $state)>,
1354if a binding for it exists, and C<undef> otherwise.
1355
1295=item $success = $term->bind_action ($key, $octets) 1356=item $success = $term->bind_action ($key, $action)
1296 1357
1297Adds a key binding exactly as specified via a C<keysym> resource. See the 1358Adds a key binding exactly as specified via a C<keysym> resource. See the
1298C<keysym> resource in the urxvt(1) manpage. 1359C<keysym> resource in the urxvt(1) manpage.
1360
1361To add default bindings for actions, an extension should call C<<
1362->bind_action >> in its C<init> hook for every such binding. Doing it
1363in the C<init> hook allows users to override or remove the binding
1364again.
1365
1366Example: the C<searchable-scrollback> by default binds itself
1367on C<Meta-s>, using C<< $self->bind_action >>, which calls C<<
1368$term->bind_action >>.
1369
1370 sub init {
1371 my ($self) = @_;
1372
1373 $self->bind_action ("M-s" => "%:start");
1374 }
1299 1375
1300=item $rend = $term->rstyle ([$new_rstyle]) 1376=item $rend = $term->rstyle ([$new_rstyle])
1301 1377
1302Return and optionally change the current rendition. Text that is output by 1378Return and optionally change the current rendition. Text that is output by
1303the terminal application will use this style. 1379the terminal application will use this style.
1461 1537
1462=item $term->scr_add_lines ($string) 1538=item $term->scr_add_lines ($string)
1463 1539
1464Write the given text string to the screen, as if output by the application 1540Write the given text string to the screen, as if output by the application
1465running inside the terminal. It may not contain command sequences (escape 1541running inside the terminal. It may not contain command sequences (escape
1466codes), but is free to use line feeds, carriage returns and tabs. The 1542codes - see C<cmd_parse> for that), but is free to use line feeds,
1467string is a normal text string, not in locale-dependent encoding. 1543carriage returns and tabs. The string is a normal text string, not in
1544locale-dependent encoding.
1468 1545
1469Normally its not a good idea to use this function, as programs might be 1546Normally its not a good idea to use this function, as programs might be
1470confused by changes in cursor position or scrolling. Its useful inside a 1547confused by changes in cursor position or scrolling. Its useful inside a
1471C<on_add_lines> hook, though. 1548C<on_add_lines> hook, though.
1472 1549
1480locale-specific encoding of the terminal and can contain command sequences 1557locale-specific encoding of the terminal and can contain command sequences
1481(escape codes) that will be interpreted. 1558(escape codes) that will be interpreted.
1482 1559
1483=item $term->tt_write ($octets) 1560=item $term->tt_write ($octets)
1484 1561
1485Write the octets given in C<$octets> to the tty (i.e. as program input). To 1562Write the octets given in C<$octets> to the tty (i.e. as user input
1563to the program, see C<cmd_parse> for the opposite direction). To pass
1486pass characters instead of octets, you should convert your strings first 1564characters instead of octets, you should convert your strings first to the
1487to the locale-specific encoding using C<< $term->locale_encode >>. 1565locale-specific encoding using C<< $term->locale_encode >>.
1488 1566
1489=item $term->tt_write_user_input ($octets) 1567=item $term->tt_write_user_input ($octets)
1490 1568
1491Like C<tt_write>, but should be used when writing strings in response to 1569Like C<tt_write>, but should be used when writing strings in response to
1492the user pressing a key, to invokes the additional actions requested by 1570the user pressing a key, to invoke the additional actions requested by
1493the user for that case (C<tt_write> doesn't do that). 1571the user for that case (C<tt_write> doesn't do that).
1494 1572
1495The typical use case would be inside C<on_action> hooks. 1573The typical use case would be inside C<on_action> hooks.
1496 1574
1497=item $term->tt_paste ($octets) 1575=item $term->tt_paste ($octets)
1623Requests a screen refresh. At the next opportunity, rxvt-unicode will 1701Requests a screen refresh. At the next opportunity, rxvt-unicode will
1624compare the on-screen display with its stored representation. If they 1702compare the on-screen display with its stored representation. If they
1625differ, it redraws the differences. 1703differ, it redraws the differences.
1626 1704
1627Used after changing terminal contents to display them. 1705Used after changing terminal contents to display them.
1706
1707=item $term->refresh_check
1708
1709Checks if a refresh has been requested and, if so, schedules one.
1628 1710
1629=item $text = $term->ROW_t ($row_number[, $new_text[, $start_col]]) 1711=item $text = $term->ROW_t ($row_number[, $new_text[, $start_col]])
1630 1712
1631Returns the text of the entire row with number C<$row_number>. Row C<< $term->top_row >> 1713Returns the text of the entire row with number C<$row_number>. Row C<< $term->top_row >>
1632is the topmost terminal line, row C<< $term->nrow-1 >> is the bottommost 1714is the topmost terminal line, row C<< $term->nrow-1 >> is the bottommost

Diff Legend

Removed lines
+ Added lines
< Changed lines
> Changed lines