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.222 by root, Sat Jul 7 07:00:17 2012 UTC vs.
Revision 1.227 by root, Sun Mar 31 20:30:32 2013 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
285 285
286=item on_user_command $term, $string 286=item on_user_command $term, $string
287 287
288Called whenever a user-configured event is being activated (e.g. via 288Called 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> 289a C<perl:string> action bound to a key, see description of the B<keysym>
290resource in the @@RXVT_NAME@@(1) manpage). 290resource in the urxvt(1) manpage).
291 291
292The event is simply the action string. This interface is assumed to change 292The event is simply the action string. This interface is assumed to change
293slightly in the future. 293slightly in the future.
294 294
295=item on_register_command $term, $keysym, $modifiermask, $string 295=item on_register_command $term, $keysym, $modifiermask, $string
881=cut 881=cut
882 882
883sub urxvt::extension::on_disable::DESTROY { 883sub urxvt::extension::on_disable::DESTROY {
884 my $disable = shift; 884 my $disable = shift;
885 885
886 my $self = delete $disable->{""}; 886 my $term = delete $disable->{""};
887 887
888 while (my ($htype, $id) = each %$disable) { 888 while (my ($htype, $id) = each %$disable) {
889 delete $self->{_hook}[$htype]{$id}; 889 delete $term->{_hook}[$htype]{$id};
890 $self->set_should_invoke ($htype, -1); 890 $term->set_should_invoke ($htype, -1);
891 } 891 }
892} 892}
893 893
894sub on { 894sub on {
895 my ($self, %hook) = @_; 895 my ($self, %hook) = @_;
896 896
897 my $term = $self->{term};
898
897 my %disable = ( "" => $self ); 899 my %disable = ( "" => $term );
898 900
899 while (my ($name, $cb) = each %hook) { 901 while (my ($name, $cb) = each %hook) {
900 my $htype = $HOOKTYPE{uc $name}; 902 my $htype = $HOOKTYPE{uc $name};
901 defined $htype 903 defined $htype
902 or Carp::croak "unsupported hook type '$name'"; 904 or Carp::croak "unsupported hook type '$name'";
903 905
904 my $id = $cb+0;
905
906 $self->set_should_invoke ($htype, +1); 906 $term->set_should_invoke ($htype, +1);
907 $disable{$htype} = $id; 907 $term->{_hook}[$htype]{ $disable{$htype} = $cb+0 }
908 $self->{_hook}[$htype]{$id} = sub { shift; $cb->($self, @_) }; # very ugly indeed 908 = sub { shift; $cb->($self, @_) }; # very ugly indeed
909 } 909 }
910 910
911 bless \%disable, "urxvt::extension::on_disable" 911 bless \%disable, "urxvt::extension::on_disable"
912} 912}
913 913
1077 1077
1078 for my $dir (reverse @libdirs) { 1078 for my $dir (reverse @libdirs) {
1079 opendir my $fh, $dir 1079 opendir my $fh, $dir
1080 or next; 1080 or next;
1081 for my $ext (readdir $fh) { 1081 for my $ext (readdir $fh) {
1082 $ext ne "." 1082 $ext !~ /^\./
1083 and $ext ne ".."
1084 and open my $fh, "<", "$dir/$ext" 1083 and open my $fh, "<", "$dir/$ext"
1085 or next; 1084 or next;
1086 1085
1087 while (<$fh>) { 1086 while (<$fh>) {
1088 if (/^#:META:X_RESOURCE:(.*)/) { 1087 if (/^#:META:X_RESOURCE:(.*)/) {
1127} 1126}
1128 1127
1129=item $term->destroy 1128=item $term->destroy
1130 1129
1131Destroy the terminal object (close the window, free resources 1130Destroy the terminal object (close the window, free resources
1132etc.). Please note that @@RXVT_NAME@@ will not exit as long as any event 1131etc.). Please note that urxvt will not exit as long as any event
1133watchers (timers, io watchers) are still active. 1132watchers (timers, io watchers) are still active.
1134 1133
1135=item $term->exec_async ($cmd[, @args]) 1134=item $term->exec_async ($cmd[, @args])
1136 1135
1137Works like the combination of the C<fork>/C<exec> builtins, which executes 1136Works like the combination of the C<fork>/C<exec> builtins, which executes
1256} 1255}
1257 1256
1258=item $success = $term->parse_keysym ($key, $octets) 1257=item $success = $term->parse_keysym ($key, $octets)
1259 1258
1260Adds a key binding exactly as specified via a resource. See the 1259Adds a key binding exactly as specified via a resource. See the
1261C<keysym> resource in the @@RXVT_NAME@@(1) manpage. 1260C<keysym> resource in the urxvt(1) manpage.
1262 1261
1263=item $term->register_command ($keysym, $modifiermask, $string) 1262=item $term->register_command ($keysym, $modifiermask, $string)
1264 1263
1265Adds a key binding. This is a lower level api compared to 1264Adds a key binding. This is a lower level api compared to
1266C<parse_keysym>, as it expects a parsed key description, and can be 1265C<parse_keysym>, as it expects a parsed key description, and can be
1696} 1695}
1697 1696
1698sub urxvt::line::t { 1697sub urxvt::line::t {
1699 my ($self) = @_; 1698 my ($self) = @_;
1700 1699
1701 if (@_ > 1) 1700 if (@_ > 1) {
1702 {
1703 $self->{term}->ROW_t ($_, $_[1], 0, ($_ - $self->{beg}) * $self->{ncol}, $self->{ncol}) 1701 $self->{term}->ROW_t ($_, $_[1], 0, ($_ - $self->{beg}) * $self->{ncol}, $self->{ncol})
1704 for $self->{beg} .. $self->{end}; 1702 for $self->{beg} .. $self->{end};
1705 } 1703 }
1706 1704
1707 defined wantarray && 1705 defined wantarray &&
1708 substr +(join "", map $self->{term}->ROW_t ($_), $self->{beg} .. $self->{end}), 1706 substr +(join "", map $self->{term}->ROW_t ($_), $self->{beg} .. $self->{end}),
1709 0, $self->{len} 1707 0, $self->{len}
1710} 1708}
1711 1709
1712sub urxvt::line::r { 1710sub urxvt::line::r {
1713 my ($self) = @_; 1711 my ($self) = @_;
1714 1712
1715 if (@_ > 1) 1713 if (@_ > 1) {
1716 {
1717 $self->{term}->ROW_r ($_, $_[1], 0, ($_ - $self->{beg}) * $self->{ncol}, $self->{ncol}) 1714 $self->{term}->ROW_r ($_, $_[1], 0, ($_ - $self->{beg}) * $self->{ncol}, $self->{ncol})
1718 for $self->{beg} .. $self->{end}; 1715 for $self->{beg} .. $self->{end};
1719 } 1716 }
1720 1717
1721 if (defined wantarray) { 1718 if (defined wantarray) {
1722 my $rend = [ 1719 my $rend = [
1723 map @{ $self->{term}->ROW_r ($_) }, $self->{beg} .. $self->{end} 1720 map @{ $self->{term}->ROW_r ($_) }, $self->{beg} .. $self->{end}
1724 ]; 1721 ];

Diff Legend

Removed lines
+ Added lines
< Changed lines
> Changed lines