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.218 by root, Sun Jun 10 17:31:53 2012 UTC vs.
Revision 1.222 by root, Sat Jul 7 07:00:17 2012 UTC

… …
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 vewiwed 37in F<@@RXVT_LIBDIR@@/urxvt/perl/>, and the documentation can be viewed
38using F<< man urxvt-<EXTENSIONNAME> >>. 38using F<< 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 @@RXVT_NAME@@ -pe <extensionname>
… …
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 that add command line parameters or resources on their own are
49laoded automatically when used. 49loaded automatically when used.
50 50
51=head1 API DOCUMENTATION 51=head1 API DOCUMENTATION
52 52
53=head2 General API Considerations 53=head2 General API Considerations
54 54
… …
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
123=item $self->disable ($hook_name[, $hook_name..])
124
125Dynamically disable the given hooks.
126
127=back
128 110
129=head2 Hooks 111=head2 Hooks
130 112
131The following subroutines can be declared in extension files, and will be 113The following subroutines can be declared in extension files, and will be
132called whenever the relevant event happens. 114called whenever the relevant event happens.
… …
735 if (my $cb = $TERM->{_hook}[$htype]) { 717 if (my $cb = $TERM->{_hook}[$htype]) {
736 verbose 10, "$HOOKNAME[$htype] (" . (join ", ", $TERM, @_) . ")" 718 verbose 10, "$HOOKNAME[$htype] (" . (join ", ", $TERM, @_) . ")"
737 if $verbosity >= 10; 719 if $verbosity >= 10;
738 720
739 for my $pkg (keys %$cb) { 721 for my $pkg (keys %$cb) {
740 my $retval_ = eval { $cb->{$pkg}->($TERM->{_pkg}{$pkg}, @_) }; 722 my $retval_ = eval { $cb->{$pkg}->($TERM->{_pkg}{$pkg} || $TERM, @_) };
741 $retval ||= $retval_; 723 $retval ||= $retval_;
742 724
743 if ($@) { 725 if ($@) {
744 $TERM->ungrab; # better to lose the grab than the session 726 $TERM->ungrab; # better to lose the grab than the session
745 warn $@; 727 warn $@;
… …
790 ($mask, @color{qw(fg bg)}, \@failed) 772 ($mask, @color{qw(fg bg)}, \@failed)
791} 773}
792 774
793package urxvt::term::extension; 775package urxvt::term::extension;
794 776
795sub enable { 777=head2 The C<urxvt::term::extension> class
796 my ($self, %hook) = @_;
797 my $pkg = $self->{_pkg};
798 778
799 while (my ($name, $cb) = each %hook) { 779Each extension attached to a terminal object is represented by
800 my $htype = $HOOKTYPE{uc $name}; 780a C<urxvt::term::extension> object.
801 defined $htype
802 or Carp::croak "unsupported hook type '$name'";
803 781
804 $self->set_should_invoke ($htype, +1) 782You can use these objects, which are passed to all callbacks to store any
805 unless exists $self->{term}{_hook}[$htype]{$pkg}; 783state related to the terminal and extension instance.
806 784
807 $self->{term}{_hook}[$htype]{$pkg} = $cb; 785The methods (And data members) documented below can be called on extension
808 } 786objects, in addition to call methods documented for the <urxvt::term>
809} 787class.
810 788
811sub disable { 789=over 4
812 my ($self, @hook) = @_;
813 my $pkg = $self->{_pkg};
814 790
815 for my $name (@hook) { 791=item $urxvt_term = $self->{term}
816 my $htype = $HOOKTYPE{uc $name};
817 defined $htype
818 or Carp::croak "unsupported hook type '$name'";
819 792
820 $self->set_should_invoke ($htype, -1) 793Returns the C<urxvt::term> object associated with this instance of the
821 if delete $self->{term}{_hook}[$htype]{$pkg}; 794extension. This member I<must not> be changed in any way.
822 } 795
823} 796=cut
824 797
825our $AUTOLOAD; 798our $AUTOLOAD;
826 799
827sub AUTOLOAD { 800sub AUTOLOAD {
828 $AUTOLOAD =~ /:([^:]+)$/ 801 $AUTOLOAD =~ /:([^:]+)$/
… …
841 814
842sub DESTROY { 815sub DESTROY {
843 # nop 816 # nop
844} 817}
845 818
846# urxvt::destroy_hook 819# urxvt::destroy_hook (basically a cheap Guard:: implementation)
847 820
848sub urxvt::destroy_hook::DESTROY { 821sub urxvt::destroy_hook::DESTROY {
849 ${$_[0]}->(); 822 ${$_[0]}->();
850} 823}
851 824
852sub urxvt::destroy_hook(&) { 825sub urxvt::destroy_hook(&) {
853 bless \shift, urxvt::destroy_hook:: 826 bless \shift, urxvt::destroy_hook::
854} 827}
828
829=item $self->enable ($hook_name => $cb[, $hook_name => $cb..])
830
831Dynamically enable the given hooks (named without the C<on_> prefix) for
832this extension, replacing any previous hook. This is useful when you want
833to overwrite time-critical hooks only temporarily.
834
835To install additional callbacks for the same hook, you can use the C<on>
836method of the C<urxvt::term> class.
837
838=item $self->disable ($hook_name[, $hook_name..])
839
840Dynamically disable the given hooks.
841
842=cut
843
844sub enable {
845 my ($self, %hook) = @_;
846 my $pkg = $self->{_pkg};
847
848 while (my ($name, $cb) = each %hook) {
849 my $htype = $HOOKTYPE{uc $name};
850 defined $htype
851 or Carp::croak "unsupported hook type '$name'";
852
853 $self->set_should_invoke ($htype, +1)
854 unless exists $self->{term}{_hook}[$htype]{$pkg};
855
856 $self->{term}{_hook}[$htype]{$pkg} = $cb;
857 }
858}
859
860sub disable {
861 my ($self, @hook) = @_;
862 my $pkg = $self->{_pkg};
863
864 for my $name (@hook) {
865 my $htype = $HOOKTYPE{uc $name};
866 defined $htype
867 or Carp::croak "unsupported hook type '$name'";
868
869 $self->set_should_invoke ($htype, -1)
870 if delete $self->{term}{_hook}[$htype]{$pkg};
871 }
872}
873
874=item $guard = $self->on ($hook_name => $cb[, $hook_name => $cb..])
875
876Similar to the C<enable> enable, but installs additional callbacks for
877the given hook(s) (that is, it doesn't replace existing callbacks), and
878returns a guard object. When the guard object is destroyed the callbacks
879are disabled again.
880
881=cut
882
883sub urxvt::extension::on_disable::DESTROY {
884 my $disable = shift;
885
886 my $self = delete $disable->{""};
887
888 while (my ($htype, $id) = each %$disable) {
889 delete $self->{_hook}[$htype]{$id};
890 $self->set_should_invoke ($htype, -1);
891 }
892}
893
894sub on {
895 my ($self, %hook) = @_;
896
897 my %disable = ( "" => $self );
898
899 while (my ($name, $cb) = each %hook) {
900 my $htype = $HOOKTYPE{uc $name};
901 defined $htype
902 or Carp::croak "unsupported hook type '$name'";
903
904 my $id = $cb+0;
905
906 $self->set_should_invoke ($htype, +1);
907 $disable{$htype} = $id;
908 $self->{_hook}[$htype]{$id} = sub { shift; $cb->($self, @_) }; # very ugly indeed
909 }
910
911 bless \%disable, "urxvt::extension::on_disable"
912}
913
914=item $self->x_resource ($pattern)
915
916=item $self->x_resource_boolean ($pattern)
917
918These methods support an additional C<%> prefix when called on an
919extension object - see the description of these methods in the
920C<urxvt::term> class for details.
921
922=cut
855 923
856sub x_resource { 924sub x_resource {
857 my ($self, $name) = @_; 925 my ($self, $name) = @_;
858 $name =~ s/^%(\.|$)/$_[0]{_name}$1/; 926 $name =~ s/^%(\.|$)/$_[0]{_name}$1/;
859 $self->{term}->x_resource ($name) 927 $self->{term}->x_resource ($name)
… …
862sub x_resource_boolean { 930sub x_resource_boolean {
863 my ($self, $name) = @_; 931 my ($self, $name) = @_;
864 $name =~ s/^%(\.|$)/$_[0]{_name}$1/; 932 $name =~ s/^%(\.|$)/$_[0]{_name}$1/;
865 $self->{term}->x_resource_boolean ($name) 933 $self->{term}->x_resource_boolean ($name)
866} 934}
935
936=back
937
938=cut
867 939
868package urxvt::anyevent; 940package urxvt::anyevent;
869 941
870=head2 The C<urxvt::anyevent> Class 942=head2 The C<urxvt::anyevent> Class
871 943
… …
1121 1193
1122Here is a likely non-exhaustive list of resource names, not all of which 1194Here is a likely non-exhaustive list of resource names, not all of which
1123are supported in every build, please see the source file F</src/rsinc.h> 1195are supported in every build, please see the source file F</src/rsinc.h>
1124to see the actual list: 1196to see the actual list:
1125 1197
1126 answerbackstring backgroundPixmap backspace_key blendtype blurradius 1198 answerbackstring backgroundPixmap backspace_key blurradius
1127 boldFont boldItalicFont borderLess buffered chdir color cursorBlink 1199 boldFont boldItalicFont borderLess buffered chdir color cursorBlink
1128 cursorUnderline cutchars delete_key depth display_name embed ext_bwidth 1200 cursorUnderline cutchars delete_key depth display_name embed ext_bwidth
1129 fade font geometry hold iconName iconfile imFont imLocale inputMethod 1201 fade font geometry hold iconName iconfile imFont imLocale inputMethod
1130 insecure int_bwidth intensityStyles iso14755 iso14755_52 italicFont 1202 insecure int_bwidth intensityStyles iso14755 iso14755_52 italicFont
1131 jumpScroll letterSpace lineSpace loginShell mapAlert meta8 modifier 1203 jumpScroll letterSpace lineSpace loginShell mapAlert meta8 modifier
… …
1156Extensions that define extra resource or command line arguments also need 1228Extensions that define extra resource or command line arguments also need
1157to call this method to access their values. 1229to call this method to access their values.
1158 1230
1159If the method is called on an extension object (basically, from an 1231If the method is called on an extension object (basically, from an
1160extension), then the special prefix C<%.> will be replaced by the name of 1232extension), then the special prefix C<%.> will be replaced by the name of
1161the extension and a dot, and the lone string C<%> will be replcaed by the 1233the extension and a dot, and the lone string C<%> will be replaced by the
1162extension name itself. This makes it possible to code extensions so you 1234extension name itself. This makes it possible to code extensions so you
1163can rename them and get a new set of commandline switches and resources 1235can rename them and get a new set of commandline switches and resources
1164without having to change the actual code. 1236without having to change the actual code.
1165 1237
1166This method should only be called during the C<on_start> hook, as there is 1238This method should only be called during the C<on_start> hook, as there is

Diff Legend

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