[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.233 by sf-exg, Fri May 2 20:34:24 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
324	=item on_register_command $term, $keysym, $modifiermask, $string
325
326	Called after parsing a keysym resource but before registering the
327	associated binding. If this hook returns TRUE the binding is not
328	registered. It can be used to modify a binding by calling
329	C<register_command>.
330		294
331	=item on_resize_all_windows $term, $new_width, $new_height	295	=item on_resize_all_windows $term, $new_width, $new_height
332		296
333	Called just after the new window size has been calculated, but before	297	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	298	windows are actually being resized or hints are being set. If this hook
335	returns TRUE, setting of the window hints is being skipped.	299	returns a true value, setting of the window hints is being skipped.
336		300
337	=item on_x_event $term, $event	301	=item on_x_event $term, $event
338		302
339	Called on every X event received on the vt window (and possibly other	303	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	304	windows). Should only be used as a last resort. Most event structure
…		…
379	manpage), with the additional members C<row> and C<col>, which are the	343	manpage), with the additional members C<row> and C<col>, which are the
380	(real, not screen-based) row and column under the mouse cursor.	344	(real, not screen-based) row and column under the mouse cursor.
381		345
382	C<on_key_press> additionally receives the string rxvt-unicode would	346	C<on_key_press> additionally receives the string rxvt-unicode would
383	output, if any, in locale-specific encoding.	347	output, if any, in locale-specific encoding.
384
385	subwindow.
386		348
387	=item on_client_message $term, $event	349	=item on_client_message $term, $event
388		350
389	=item on_wm_protocols $term, $event	351	=item on_wm_protocols $term, $event
390		352
…		…
598	$name =~ y/-/./ if $isarg;	560	$name =~ y/-/./ if $isarg;
599		561
600	$term->scan_meta;	562	$term->scan_meta;
601		563
602	my $r = $term->{meta}{resource};	564	my $r = $term->{meta}{resource};
603	keys %$r; # reste iterator	565	keys %$r; # reset iterator
604	while (my ($pattern, $v) = each %$r) {	566	while (my ($pattern, $v) = each %$r) {
605	if (	567	if (
606	$pattern =~ /\.$/	568	$pattern =~ /\.$/
607	? $pattern eq substr $name, 0, length $pattern	569	? $pattern eq substr $name, 0, length $pattern
608	: $pattern eq $name	570	: $pattern eq $name
…		…
696	# called by the rxvt core	658	# called by the rxvt core
697	sub invoke {	659	sub invoke {
698	local $TERM = shift;	660	local $TERM = shift;
699	my $htype = shift;	661	my $htype = shift;
700		662
701	if ($htype == 0) { # INIT	663	if ($htype == HOOK_INIT) {
702	my @dirs = $TERM->perl_libdirs;	664	my @dirs = $TERM->perl_libdirs;
703		665
704	my %ext_arg;	666	my %ext_arg;
705		667
706	{	668	{
…		…
745		707
746	if (my $cb = $TERM->{_hook}[$htype]) {	708	if (my $cb = $TERM->{_hook}[$htype]) {
747	verbose 10, "$HOOKNAME[$htype] (" . (join ", ", $TERM, @_) . ")"	709	verbose 10, "$HOOKNAME[$htype] (" . (join ", ", $TERM, @_) . ")"
748	if $verbosity >= 10;	710	if $verbosity >= 10;
749		711
750	for my $pkg (keys %$cb) {	712	for my $pkg (
		713	# this hook is only sent to the extension with the name
		714	# matching the first arg
		715	$htype == HOOK_KEYBOARD_DISPATCH
		716	? exists $cb->{"urxvt::ext::$_[0]"} ? "urxvt::ext::" . shift : return undef
		717	: keys %$cb
		718	) {
751	my $retval_ = eval { $cb->{$pkg}->($TERM->{_pkg}{$pkg} \|\| $TERM, @_) };	719	my $retval_ = eval { $cb->{$pkg}->($TERM->{_pkg}{$pkg} \|\| $TERM, @_) };
752	$retval \|\|= $retval_;	720	$retval \|\|= $retval_;
753		721
754	if ($@) {	722	if ($@) {
755	$TERM->ungrab; # better to lose the grab than the session	723	$TERM->ungrab; # better to lose the grab than the session
…		…
759		727
760	verbose 11, "$HOOKNAME[$htype] returning <$retval>"	728	verbose 11, "$HOOKNAME[$htype] returning <$retval>"
761	if $verbosity >= 11;	729	if $verbosity >= 11;
762	}	730	}
763		731
764	if ($htype == 1) { # DESTROY	732	if ($htype == HOOK_DESTROY) {
765	# clear package objects	733	# clear package objects
766	%$_ = () for values %{ $TERM->{_pkg} };	734	%$_ = () for values %{ $TERM->{_pkg} };
767		735
768	# clear package	736	# clear package
769	%$TERM = ();	737	%$TERM = ();
…		…
801	($mask, @color{qw(fg bg)}, \@failed)	769	($mask, @color{qw(fg bg)}, \@failed)
802	}	770	}
803		771
804	package urxvt::term::extension;	772	package urxvt::term::extension;
805		773
806	sub enable {	774	=head2 The C<urxvt::term::extension> class
807	my ($self, %hook) = @_;
808	my $pkg = $self->{_pkg};
809		775
810	while (my ($name, $cb) = each %hook) {	776	Each extension attached to a terminal object is represented by
811	my $htype = $HOOKTYPE{uc $name};	777	a C<urxvt::term::extension> object.
812	defined $htype
813	or Carp::croak "unsupported hook type '$name'";
814		778
815	$self->set_should_invoke ($htype, +1)	779	You can use these objects, which are passed to all callbacks to store any
816	unless exists $self->{term}{_hook}[$htype]{$pkg};	780	state related to the terminal and extension instance.
817		781
818	$self->{term}{_hook}[$htype]{$pkg} = $cb;	782	The methods (And data members) documented below can be called on extension
819	}	783	objects, in addition to call methods documented for the <urxvt::term>
820	}	784	class.
821		785
822	sub disable {	786	=over 4
823	my ($self, @hook) = @_;
824	my $pkg = $self->{_pkg};
825		787
826	for my $name (@hook) {	788	=item $urxvt_term = $self->{term}
827	my $htype = $HOOKTYPE{uc $name};
828	defined $htype
829	or Carp::croak "unsupported hook type '$name'";
830		789
831	$self->set_should_invoke ($htype, -1)	790	Returns the C<urxvt::term> object associated with this instance of the
832	if delete $self->{term}{_hook}[$htype]{$pkg};	791	extension. This member I<must not> be changed in any way.
833	}	792
834	}	793	=cut
835		794
836	our $AUTOLOAD;	795	our $AUTOLOAD;
837		796
838	sub AUTOLOAD {	797	sub AUTOLOAD {
839	$AUTOLOAD =~ /:([^:]+)$/	798	$AUTOLOAD =~ /:([^:]+)$/
…		…
852		811
853	sub DESTROY {	812	sub DESTROY {
854	# nop	813	# nop
855	}	814	}
856		815
857	# urxvt::destroy_hook	816	# urxvt::destroy_hook (basically a cheap Guard:: implementation)
858		817
859	sub urxvt::destroy_hook::DESTROY {	818	sub urxvt::destroy_hook::DESTROY {
860	${$_[0]}->();	819	${$_[0]}->();
861	}	820	}
862		821
863	sub urxvt::destroy_hook(&) {	822	sub urxvt::destroy_hook(&) {
864	bless \shift, urxvt::destroy_hook::	823	bless \shift, urxvt::destroy_hook::
865	}	824	}
		825
		826	=item $self->enable ($hook_name => $cb[, $hook_name => $cb..])
		827
		828	Dynamically enable the given hooks (named without the C<on_> prefix) for
		829	this extension, replacing any hook previously installed via C<enable> in
		830	this extension.
		831
		832	This is useful when you want to overwrite time-critical hooks only
		833	temporarily.
		834
		835	To install additional callbacks for the same hook, you can use the C<on>
		836	method of the C<urxvt::term> class.
		837
		838	=item $self->disable ($hook_name[, $hook_name..])
		839
		840	Dynamically disable the given hooks.
		841
		842	=cut
		843
		844	sub 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
		860	sub 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
		876	Similar to the C<enable> enable, but installs additional callbacks for
		877	the given hook(s) (that is, it doesn't replace existing callbacks), and
		878	returns a guard object. When the guard object is destroyed the callbacks
		879	are disabled again.
		880
		881	=cut
		882
		883	sub urxvt::extension::on_disable::DESTROY {
		884	my $disable = shift;
		885
		886	my $term = delete $disable->{""};
		887
		888	while (my ($htype, $id) = each %$disable) {
		889	delete $term->{_hook}[$htype]{$id};
		890	$term->set_should_invoke ($htype, -1);
		891	}
		892	}
		893
		894	sub on {
		895	my ($self, %hook) = @_;
		896
		897	my $term = $self->{term};
		898
		899	my %disable = ( "" => $term );
		900
		901	while (my ($name, $cb) = each %hook) {
		902	my $htype = $HOOKTYPE{uc $name};
		903	defined $htype
		904	or Carp::croak "unsupported hook type '$name'";
		905
		906	$term->set_should_invoke ($htype, +1);
		907	$term->{_hook}[$htype]{ $disable{$htype} = $cb+0 }
		908	= 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
		918	These methods support an additional C<%> prefix when called on an
		919	extension object - see the description of these methods in the
		920	C<urxvt::term> class for details.
		921
		922	=cut
866		923
867	sub x_resource {	924	sub x_resource {
868	my ($self, $name) = @_;	925	my ($self, $name) = @_;
869	$name =~ s/^%(\.\|$)/$_[0]{_name}$1/;	926	$name =~ s/^%(\.\|$)/$_[0]{_name}$1/;
870	$self->{term}->x_resource ($name)	927	$self->{term}->x_resource ($name)
…		…
873	sub x_resource_boolean {	930	sub x_resource_boolean {
874	my ($self, $name) = @_;	931	my ($self, $name) = @_;
875	$name =~ s/^%(\.\|$)/$_[0]{_name}$1/;	932	$name =~ s/^%(\.\|$)/$_[0]{_name}$1/;
876	$self->{term}->x_resource_boolean ($name)	933	$self->{term}->x_resource_boolean ($name)
877	}	934	}
		935
		936	=back
		937
		938	=cut
878		939
879	package urxvt::anyevent;	940	package urxvt::anyevent;
880		941
881	=head2 The C<urxvt::anyevent> Class	942	=head2 The C<urxvt::anyevent> Class
882		943
…		…
1016		1077
1017	for my $dir (reverse @libdirs) {	1078	for my $dir (reverse @libdirs) {
1018	opendir my $fh, $dir	1079	opendir my $fh, $dir
1019	or next;	1080	or next;
1020	for my $ext (readdir $fh) {	1081	for my $ext (readdir $fh) {
1021	$ext ne "."	1082	$ext !~ /^\./
1022	and $ext ne ".."
1023	and open my $fh, "<", "$dir/$ext"	1083	and open my $fh, "<", "$dir/$ext"
1024	or next;	1084	or next;
1025		1085
1026	while (<$fh>) {	1086	while (<$fh>) {
1027	if (/^#:META:X_RESOURCE:(.*)/) {	1087	if (/^#:META:X_RESOURCE:(.*)/) {
…		…
1066	}	1126	}
1067		1127
1068	=item $term->destroy	1128	=item $term->destroy
1069		1129
1070	Destroy the terminal object (close the window, free resources	1130	Destroy the terminal object (close the window, free resources
1071	etc.). Please note that @@RXVT_NAME@@ will not exit as long as any event	1131	etc.). Please note that urxvt will not exit as long as any event
1072	watchers (timers, io watchers) are still active.	1132	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		1133
1117	=item $term->exec_async ($cmd[, @args])	1134	=item $term->exec_async ($cmd[, @args])
1118		1135
1119	Works like the combination of the C<fork>/C<exec> builtins, which executes	1136	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	1137	("starts") programs in the background. This function takes care of setting
…		…
1235	my $res = &x_resource;	1252	my $res = &x_resource;
1236		1253
1237	$res =~ /^\s(?:true\|yes\|on\|1)\s$/i ? 1 : defined $res && 0	1254	$res =~ /^\s(?:true\|yes\|on\|1)\s$/i ? 1 : defined $res && 0
1238	}	1255	}
1239		1256
1240	=item $success = $term->parse_keysym ($key, $octets)	1257	=item $success = $term->bind_action ($key, $octets)
1241		1258
1242	Adds a key binding exactly as specified via a resource. See the	1259	Adds a key binding exactly as specified via a resource. See the
1243	C<keysym> resource in the @@RXVT_NAME@@(1) manpage.	1260	C<keysym> resource in the urxvt(1) manpage.
1244
1245	=item $term->register_command ($keysym, $modifiermask, $string)
1246
1247	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
1249	used only inside either the C<on_init> hook, to add a binding, or the
1250	C<on_register_command> hook, to modify a parsed binding.
1251		1261
1252	=item $rend = $term->rstyle ([$new_rstyle])	1262	=item $rend = $term->rstyle ([$new_rstyle])
1253		1263
1254	Return and optionally change the current rendition. Text that is output by	1264	Return and optionally change the current rendition. Text that is output by
1255	the terminal application will use this style.	1265	the terminal application will use this style.
…		…
1678	}	1688	}
1679		1689
1680	sub urxvt::line::t {	1690	sub urxvt::line::t {
1681	my ($self) = @_;	1691	my ($self) = @_;
1682		1692
1683	if (@_ > 1)	1693	if (@_ > 1) {
1684	{
1685	$self->{term}->ROW_t ($_, $_[1], 0, ($_ - $self->{beg}) * $self->{ncol}, $self->{ncol})	1694	$self->{term}->ROW_t ($_, $_[1], 0, ($_ - $self->{beg}) * $self->{ncol}, $self->{ncol})
1686	for $self->{beg} .. $self->{end};	1695	for $self->{beg} .. $self->{end};
1687	}	1696	}
1688		1697
1689	defined wantarray &&	1698	defined wantarray &&
1690	substr +(join "", map $self->{term}->ROW_t ($_), $self->{beg} .. $self->{end}),	1699	substr +(join "", map $self->{term}->ROW_t ($_), $self->{beg} .. $self->{end}),
1691	0, $self->{len}	1700	0, $self->{len}
1692	}	1701	}
1693		1702
1694	sub urxvt::line::r {	1703	sub urxvt::line::r {
1695	my ($self) = @_;	1704	my ($self) = @_;
1696		1705
1697	if (@_ > 1)	1706	if (@_ > 1) {
1698	{
1699	$self->{term}->ROW_r ($_, $_[1], 0, ($_ - $self->{beg}) * $self->{ncol}, $self->{ncol})	1707	$self->{term}->ROW_r ($_, $_[1], 0, ($_ - $self->{beg}) * $self->{ncol}, $self->{ncol})
1700	for $self->{beg} .. $self->{end};	1708	for $self->{beg} .. $self->{end};
1701	}	1709	}
1702		1710
1703	if (defined wantarray) {	1711	if (defined wantarray) {
1704	my $rend = [	1712	my $rend = [
1705	map @{ $self->{term}->ROW_r ($_) }, $self->{beg} .. $self->{end}	1713	map @{ $self->{term}->ROW_r ($_) }, $self->{beg} .. $self->{end}
1706	];	1714	];

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.233 by sf-exg, Fri May 2 20:34:24 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.233 by sf-exg, Fri May 2 20:34:24 2014 UTC