[ViewVC] Diff of: cvs/rxvt-unicode/src/urxvt.pm

Comparing rxvt-unicode/src/urxvt.pm (file contents):
Revision 1.220 by root, Tue Jun 19 18:17:56 2012 UTC vs.
Revision 1.230 by root, Sat Apr 26 20:51:12 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	5	urxvtperl - 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
22	Every time a terminal object gets created, extension scripts specified via	22	Every time a terminal object gets created, extension scripts specified via
23	the C<perl> resource are loaded and associated with it.	23	the C<perl> resource are loaded and associated with it.
24		24
25	Scripts are compiled in a 'use strict "vars"' and 'use utf8' environment, and	25	Scripts are compiled in a 'use strict "vars"' and 'use utf8' environment, and
26	thus must be encoded as UTF-8.	26	thus must be encoded as UTF-8.
27		27
28	Each script will only ever be loaded once, even in @@RXVT_NAME@@d, where	28	Each script will only ever be loaded once, even in urxvtd, where
29	scripts will be shared (but not enabled) for all terminals.	29	scripts will be shared (but not enabled) for all terminals.
30		30
31	You can disable the embedded perl interpreter by setting both "perl-ext"	31	You can disable the embedded perl interpreter by setting both "perl-ext"
32	and "perl-ext-common" resources to the empty string.	32	and "perl-ext-common" resources to the empty string.
33		33
34	=head1 PREPACKAGED EXTENSIONS	34	=head1 PREPACKAGED EXTENSIONS
35		35
36	A number of extensions are delivered with this release. You can find them	36	A number of extensions are delivered with this release. You can find them
37	in F<@@RXVT_LIBDIR@@/urxvt/perl/>, and the documentation can be viewed	37	in F<< <libdir>/urxvt/perl/ >>, and the documentation can be viewed using
38	using F<< man urxvt-<EXTENSIONNAME> >>.	38	F<< man urxvt-<EXTENSIONNAME> >>.
39		39
40	You can activate them like this:	40	You can activate them like this:
41		41
42	@@RXVT_NAME@@ -pe <extensionname>	42	urxvt -pe <extensionname>
43		43
44	Or by adding them to the resource for extensions loaded by default:	44	Or 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
103	internal use.	103	internal use.
104		104
105	Although it isn't a C<urxvt::term> object, you can call all methods of the	105	Although it isn't a C<urxvt::term> object, you can call all methods of the
106	C<urxvt::term> class on this object.	106	C<urxvt::term> class on this object.
107		107
108	It has the following methods and data members:	108	Additional methods only supported for extension objects are described in
109		109	the C<urxvt::extension> section below.
110	=over 4
111
112	=item $urxvt_term = $self->{term}
113
114	Returns the C<urxvt::term> object associated with this instance of the
115	extension. This member I<must not> be changed in any way.
116
117	=item $self->enable ($hook_name => $cb[, $hook_name => $cb..])
118
119	Dynamically enable the given hooks (named without the C<on_> prefix) for
120	this extension, replacing any previous hook. This is useful when you want
121	to overwrite time-critical hooks only temporarily.
122
123	To install additional callbacks for the same hook, you cna use the C<on>
124	method of the C<urxvt::term> class.
125
126	=item $self->disable ($hook_name[, $hook_name..])
127
128	Dynamically disable the given hooks.
129
130	=item $self->x_resource ($pattern)
131
132	=item $self->x_resource_boolean ($pattern)
133
134	These methods support an additional C<%> prefix when called on an
135	extension object - see the description of these methods in the
136	C<urxvt::term> class for details.
137
138	=back
139		110
140	=head2 Hooks	111	=head2 Hooks
141		112
142	The following subroutines can be declared in extension files, and will be	113	The following subroutines can be declared in extension files, and will be
143	called whenever the relevant event happens.	114	called whenever the relevant event happens.
…		…
310		281
311	=item on_refresh_end $term	282	=item on_refresh_end $term
312		283
313	Called just after the screen gets redrawn. See C<on_refresh_begin>.	284	Called 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
317	Called whenever a user-configured event is being activated (e.g. via	288	Called whenever a user-configured event is being activated (e.g. via
318	a C<perl:string> action bound to a key, see description of the B<keysym>	289	a C<perl:string> action bound to a key, see description of the B<keysym>
319	resource in the @@RXVT_NAME@@(1) manpage).	290	resource in the urxvt(1) manpage).
320		291
321	The event is simply the action string. This interface is assumed to change	292	The event is simply the action string. This interface is going away in
322	slightly in the future.	293	preference to the C<< ->register_keysym_action >> method.
323		294
324	=item on_register_command $term, $keysym, $modifiermask, $string	295	=item on_register_command $term, $keysym, $modifiermask, $string
325		296
326	Called after parsing a keysym resource but before registering the	297	Called after parsing a keysym resource but before registering the
327	associated binding. If this hook returns TRUE the binding is not	298	associated binding. If this hook returns a true value the binding
328	registered. It can be used to modify a binding by calling	299	is not registered. It can be used to modify a binding by calling
329	C<register_command>.	300	C<register_command>.
330		301
331	=item on_resize_all_windows $term, $new_width, $new_height	302	=item on_resize_all_windows $term, $new_width, $new_height
332		303
333	Called just after the new window size has been calculated, but before	304	Called just after the new window size has been calculated, but before
334	windows are actually being resized or hints are being set. If this hook	305	windows are actually being resized or hints are being set. If this hook
335	returns TRUE, setting of the window hints is being skipped.	306	returns a true value, setting of the window hints is being skipped.
336		307
337	=item on_x_event $term, $event	308	=item on_x_event $term, $event
338		309
339	Called on every X event received on the vt window (and possibly other	310	Called on every X event received on the vt window (and possibly other
340	windows). Should only be used as a last resort. Most event structure	311	windows). Should only be used as a last resort. Most event structure
…		…
598	$name =~ y/-/./ if $isarg;	569	$name =~ y/-/./ if $isarg;
599		570
600	$term->scan_meta;	571	$term->scan_meta;
601		572
602	my $r = $term->{meta}{resource};	573	my $r = $term->{meta}{resource};
603	keys %$r; # reste iterator	574	keys %$r; # reset iterator
604	while (my ($pattern, $v) = each %$r) {	575	while (my ($pattern, $v) = each %$r) {
605	if (	576	if (
606	$pattern =~ /\.$/	577	$pattern =~ /\.$/
607	? $pattern eq substr $name, 0, length $pattern	578	? $pattern eq substr $name, 0, length $pattern
608	: $pattern eq $name	579	: $pattern eq $name
…		…
696	# called by the rxvt core	667	# called by the rxvt core
697	sub invoke {	668	sub invoke {
698	local $TERM = shift;	669	local $TERM = shift;
699	my $htype = shift;	670	my $htype = shift;
700		671
701	if ($htype == 0) { # INIT	672	if ($htype == HOOK_INIT) {
702	my @dirs = $TERM->perl_libdirs;	673	my @dirs = $TERM->perl_libdirs;
703		674
704	my %ext_arg;	675	my %ext_arg;
705		676
706	{	677	{
…		…
745		716
746	if (my $cb = $TERM->{_hook}[$htype]) {	717	if (my $cb = $TERM->{_hook}[$htype]) {
747	verbose 10, "$HOOKNAME[$htype] (" . (join ", ", $TERM, @_) . ")"	718	verbose 10, "$HOOKNAME[$htype] (" . (join ", ", $TERM, @_) . ")"
748	if $verbosity >= 10;	719	if $verbosity >= 10;
749		720
750	for my $pkg (keys %$cb) {	721	for my $pkg (
		722	# this hook is only sent to the extension with the name
		723	# matching the first arg
		724	$htype == HOOK_KEYBOARD_DISPATCH
		725	? exists $cb->{"urxvt::ext::$_[0]"} ? "urxvt::ext::" . shift : return undef
		726	: keys %$cb
		727	) {
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 ($@) {
755	$TERM->ungrab; # better to lose the grab than the session	732	$TERM->ungrab; # better to lose the grab than the session
…		…
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
804	package urxvt::term::extension;	781	package urxvt::term::extension;
805		782
806	sub 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) {	785	Each extension attached to a terminal object is represented by
811	my $htype = $HOOKTYPE{uc $name};	786	a 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)	788	You can use these objects, which are passed to all callbacks to store any
816	unless exists $self->{term}{_hook}[$htype]{$pkg};	789	state related to the terminal and extension instance.
817		790
818	$self->{term}{_hook}[$htype]{$pkg} = $cb;	791	The methods (And data members) documented below can be called on extension
819	}	792	objects, in addition to call methods documented for the <urxvt::term>
820	}	793	class.
821		794
822	sub 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)	799	Returns the C<urxvt::term> object associated with this instance of the
832	if delete $self->{term}{_hook}[$htype]{$pkg};	800	extension. This member I<must not> be changed in any way.
833	}	801
834	}	802	=cut
835		803
836	our $AUTOLOAD;	804	our $AUTOLOAD;
837		805
838	sub AUTOLOAD {	806	sub AUTOLOAD {
839	$AUTOLOAD =~ /:([^:]+)$/	807	$AUTOLOAD =~ /:([^:]+)$/
…		…
852		820
853	sub DESTROY {	821	sub DESTROY {
854	# nop	822	# nop
855	}	823	}
856		824
857	# urxvt::destroy_hook	825	# urxvt::destroy_hook (basically a cheap Guard:: implementation)
858		826
859	sub urxvt::destroy_hook::DESTROY {	827	sub urxvt::destroy_hook::DESTROY {
860	${$_[0]}->();	828	${$_[0]}->();
861	}	829	}
862		830
863	sub urxvt::destroy_hook(&) {	831	sub 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
		837	Dynamically enable the given hooks (named without the C<on_> prefix) for
		838	this extension, replacing any hook previously installed via C<enable> in
		839	this extension.
		840
		841	This is useful when you want to overwrite time-critical hooks only
		842	temporarily.
		843
		844	To install additional callbacks for the same hook, you can use the C<on>
		845	method of the C<urxvt::term> class.
		846
		847	=item $self->disable ($hook_name[, $hook_name..])
		848
		849	Dynamically disable the given hooks.
		850
		851	=cut
		852
		853	sub 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
		869	sub 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
		885	Similar to the C<enable> enable, but installs additional callbacks for
		886	the given hook(s) (that is, it doesn't replace existing callbacks), and
		887	returns a guard object. When the guard object is destroyed the callbacks
		888	are disabled again.
		889
		890	=cut
		891
		892	sub 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
		903	sub 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
		927	These methods support an additional C<%> prefix when called on an
		928	extension object - see the description of these methods in the
		929	C<urxvt::term> class for details.
		930
		931	=cut
866		932
867	sub x_resource {	933	sub 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)
…		…
873	sub x_resource_boolean {	939	sub 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
879	package urxvt::anyevent;	949	package urxvt::anyevent;
880		950
881	=head2 The C<urxvt::anyevent> Class	951	=head2 The C<urxvt::anyevent> Class
882		952
…		…
1016		1086
1017	for my $dir (reverse @libdirs) {	1087	for my $dir (reverse @libdirs) {
1018	opendir my $fh, $dir	1088	opendir my $fh, $dir
1019	or next;	1089	or next;
1020	for my $ext (readdir $fh) {	1090	for my $ext (readdir $fh) {
1021	$ext ne "."	1091	$ext !~ /^\./
1022	and $ext ne ".."
1023	and open my $fh, "<", "$dir/$ext"	1092	and open my $fh, "<", "$dir/$ext"
1024	or next;	1093	or next;
1025		1094
1026	while (<$fh>) {	1095	while (<$fh>) {
1027	if (/^#:META:X_RESOURCE:(.*)/) {	1096	if (/^#:META:X_RESOURCE:(.*)/) {
…		…
1066	}	1135	}
1067		1136
1068	=item $term->destroy	1137	=item $term->destroy
1069		1138
1070	Destroy the terminal object (close the window, free resources	1139	Destroy the terminal object (close the window, free resources
1071	etc.). Please note that @@RXVT_NAME@@ will not exit as long as any event	1140	etc.). Please note that urxvt will not exit as long as any event
1072	watchers (timers, io watchers) are still active.	1141	watchers (timers, io watchers) are still active.
1073
1074	=item $guard = $self->on ($hook_name => $cb[, $hook_name => $cb..])
1075
1076	Similar to the extension method C<enable>, but installs additional
1077	callbacks for the givne hook(s) (existing ones are not replaced), and
1078	returns a guard object. When the guard object is destroyed the callbacks
1079	are disabled again.
1080
1081	Note that these callbacks receive the normal paramaters, but the first
1082	argument (normally the extension) is currently undefined.
1083
1084	=cut
1085
1086	sub 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
1097	sub 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		1142
1117	=item $term->exec_async ($cmd[, @args])	1143	=item $term->exec_async ($cmd[, @args])
1118		1144
1119	Works like the combination of the C<fork>/C<exec> builtins, which executes	1145	Works like the combination of the C<fork>/C<exec> builtins, which executes
1120	("starts") programs in the background. This function takes care of setting	1146	("starts") programs in the background. This function takes care of setting
…		…
1238	}	1264	}
1239		1265
1240	=item $success = $term->parse_keysym ($key, $octets)	1266	=item $success = $term->parse_keysym ($key, $octets)
1241		1267
1242	Adds a key binding exactly as specified via a resource. See the	1268	Adds a key binding exactly as specified via a resource. See the
1243	C<keysym> resource in the @@RXVT_NAME@@(1) manpage.	1269	C<keysym> resource in the urxvt(1) manpage.
1244		1270
1245	=item $term->register_command ($keysym, $modifiermask, $string)	1271	=item $term->register_command ($keysym, $modifiermask, $string)
1246		1272
1247	Adds a key binding. This is a lower level api compared to	1273	Adds a key binding. This is a lower level api compared to
1248	C<parse_keysym>, as it expects a parsed key description, and can be	1274	C<parse_keysym>, as it expects a parsed key description, and can be
…		…
1678	}	1704	}
1679		1705
1680	sub urxvt::line::t {	1706	sub urxvt::line::t {
1681	my ($self) = @_;	1707	my ($self) = @_;
1682		1708
1683	if (@_ > 1)	1709	if (@_ > 1) {
1684	{
1685	$self->{term}->ROW_t ($_, $_[1], 0, ($_ - $self->{beg}) * $self->{ncol}, $self->{ncol})	1710	$self->{term}->ROW_t ($_, $_[1], 0, ($_ - $self->{beg}) * $self->{ncol}, $self->{ncol})
1686	for $self->{beg} .. $self->{end};	1711	for $self->{beg} .. $self->{end};
1687	}	1712	}
1688		1713
1689	defined wantarray &&	1714	defined wantarray &&
1690	substr +(join "", map $self->{term}->ROW_t ($_), $self->{beg} .. $self->{end}),	1715	substr +(join "", map $self->{term}->ROW_t ($_), $self->{beg} .. $self->{end}),
1691	0, $self->{len}	1716	0, $self->{len}
1692	}	1717	}
1693		1718
1694	sub urxvt::line::r {	1719	sub urxvt::line::r {
1695	my ($self) = @_;	1720	my ($self) = @_;
1696		1721
1697	if (@_ > 1)	1722	if (@_ > 1) {
1698	{
1699	$self->{term}->ROW_r ($_, $_[1], 0, ($_ - $self->{beg}) * $self->{ncol}, $self->{ncol})	1723	$self->{term}->ROW_r ($_, $_[1], 0, ($_ - $self->{beg}) * $self->{ncol}, $self->{ncol})
1700	for $self->{beg} .. $self->{end};	1724	for $self->{beg} .. $self->{end};
1701	}	1725	}
1702		1726
1703	if (defined wantarray) {	1727	if (defined wantarray) {
1704	my $rend = [	1728	my $rend = [
1705	map @{ $self->{term}->ROW_r ($_) }, $self->{beg} .. $self->{end}	1729	map @{ $self->{term}->ROW_r ($_) }, $self->{beg} .. $self->{end}
1706	];	1730	];

Diff Legend

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

Comparing rxvt-unicode/src/urxvt.pm (file contents): Revision 1.220 by root, Tue Jun 19 18:17:56 2012 UTC vs. Revision 1.230 by root, Sat Apr 26 20:51:12 2014 UTC

Diff Legend

Comparing rxvt-unicode/src/urxvt.pm (file contents):
Revision 1.220 by root, Tue Jun 19 18:17:56 2012 UTC vs.
Revision 1.230 by root, Sat Apr 26 20:51:12 2014 UTC