[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.236 by root, Sat May 17 17:12:29 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<on_action> hook.
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
…		…
595	sub parse_resource {	557	sub parse_resource {
596	my ($term, $name, $isarg, $longopt, $flag, $value) = @_;	558	my ($term, $name, $isarg, $longopt, $flag, $value) = @_;
597		559
598	$name =~ y/-/./ if $isarg;	560	$name =~ y/-/./ if $isarg;
599		561
600	$term->scan_meta;	562	$term->scan_extensions;
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
…		…
625	}	587	}
626		588
627	sub usage {	589	sub usage {
628	my ($term, $usage_type) = @_;	590	my ($term, $usage_type) = @_;
629		591
630	$term->scan_meta;	592	$term->scan_extensions;
631		593
632	my $r = $term->{meta}{resource};	594	my $r = $term->{meta}{resource};
633		595
634	for my $pattern (sort keys %$r) {	596	for my $pattern (sort keys %$r) {
635	my ($ext, $type, $desc) = @{ $r->{$pattern} };	597	my ($ext, $type, $desc) = @{ $r->{$pattern} };
…		…
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;
		665
		666	$TERM->scan_extensions;
703		667
704	my %ext_arg;	668	my %ext_arg;
705		669
706	{	670	{
707	my @init = @TERM_INIT;	671	my @init = @TERM_INIT;
…		…
715	for (	679	for (
716	@{ delete $TERM->{perl_ext_3} },	680	@{ delete $TERM->{perl_ext_3} },
717	grep $_, map { split /,/, $TERM->resource ("perl_ext_$_") } 1, 2	681	grep $_, map { split /,/, $TERM->resource ("perl_ext_$_") } 1, 2
718	) {	682	) {
719	if ($_ eq "default") {	683	if ($_ eq "default") {
720	$ext_arg{$_} \|\|= [] for qw(selection option-popup selection-popup searchable-scrollback readline);	684
		685	$ext_arg{$_} \|\|= []
		686	for
		687	qw(selection option-popup selection-popup readline),
		688	map $_->[0], values %{ $TERM->{meta}{binding} };
		689
721	} elsif (/^-(.*)$/) {	690	} elsif (/^-(.*)$/) {
722	delete $ext_arg{$1};	691	delete $ext_arg{$1};
		692
723	} elsif (/^([^<]+)<(.*)>$/) {	693	} elsif (/^([^<]+)<(.*)>$/) {
724	push @{ $ext_arg{$1} }, $2;	694	push @{ $ext_arg{$1} }, $2;
		695
725	} else {	696	} else {
726	$ext_arg{$_} \|\|= [];	697	$ext_arg{$_} \|\|= [];
727	}	698	}
		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]");
728	}	704	}
729		705
730	for my $ext (sort keys %ext_arg) {	706	for my $ext (sort keys %ext_arg) {
731	my @files = grep -f $_, map "$_/$ext", @dirs;	707	my @files = grep -f $_, map "$_/$ext", @dirs;
732		708
…		…
745		721
746	if (my $cb = $TERM->{_hook}[$htype]) {	722	if (my $cb = $TERM->{_hook}[$htype]) {
747	verbose 10, "$HOOKNAME[$htype] (" . (join ", ", $TERM, @_) . ")"	723	verbose 10, "$HOOKNAME[$htype] (" . (join ", ", $TERM, @_) . ")"
748	if $verbosity >= 10;	724	if $verbosity >= 10;
749		725
		726	if ($htype == HOOK_ACTION) {
		727	# this hook is only sent to the extension with the name
		728	# matching the first arg
		729	my $pkg = shift;
		730	$pkg =~ y/-/_/;
		731	$pkg = "urxvt::ext::$pkg";
		732
		733	$cb = $cb->{$pkg}
		734	or return undef; #TODO: maybe warn user?
		735
		736	$cb = { $pkg => $cb };
		737	}
		738
750	for my $pkg (keys %$cb) {	739	for my $pkg (keys %$cb) {
751	my $retval_ = eval { $cb->{$pkg}->($TERM->{_pkg}{$pkg} \|\| $TERM, @_) };	740	my $retval_ = eval { $cb->{$pkg}->($TERM->{_pkg}{$pkg} \|\| $TERM, @_) };
752	$retval \|\|= $retval_;	741	$retval \|\|= $retval_;
753		742
754	if ($@) {	743	if ($@) {
…		…
759		748
760	verbose 11, "$HOOKNAME[$htype] returning <$retval>"	749	verbose 11, "$HOOKNAME[$htype] returning <$retval>"
761	if $verbosity >= 11;	750	if $verbosity >= 11;
762	}	751	}
763		752
764	if ($htype == 1) { # DESTROY	753	if ($htype == HOOK_DESTROY) {
765	# clear package objects	754	# clear package objects
766	%$_ = () for values %{ $TERM->{_pkg} };	755	%$_ = () for values %{ $TERM->{_pkg} };
767		756
768	# clear package	757	# clear package
769	%$TERM = ();	758	%$TERM = ();
…		…
801	($mask, @color{qw(fg bg)}, \@failed)	790	($mask, @color{qw(fg bg)}, \@failed)
802	}	791	}
803		792
804	package urxvt::term::extension;	793	package urxvt::term::extension;
805		794
806	sub enable {	795	=head2 The C<urxvt::term::extension> class
807	my ($self, %hook) = @_;
808	my $pkg = $self->{_pkg};
809		796
810	while (my ($name, $cb) = each %hook) {	797	Each extension attached to a terminal object is represented by
811	my $htype = $HOOKTYPE{uc $name};	798	a C<urxvt::term::extension> object.
812	defined $htype
813	or Carp::croak "unsupported hook type '$name'";
814		799
815	$self->set_should_invoke ($htype, +1)	800	You can use these objects, which are passed to all callbacks to store any
816	unless exists $self->{term}{_hook}[$htype]{$pkg};	801	state related to the terminal and extension instance.
817		802
818	$self->{term}{_hook}[$htype]{$pkg} = $cb;	803	The methods (And data members) documented below can be called on extension
819	}	804	objects, in addition to call methods documented for the <urxvt::term>
820	}	805	class.
821		806
822	sub disable {	807	=over 4
823	my ($self, @hook) = @_;
824	my $pkg = $self->{_pkg};
825		808
826	for my $name (@hook) {	809	=item $urxvt_term = $self->{term}
827	my $htype = $HOOKTYPE{uc $name};
828	defined $htype
829	or Carp::croak "unsupported hook type '$name'";
830		810
831	$self->set_should_invoke ($htype, -1)	811	Returns the C<urxvt::term> object associated with this instance of the
832	if delete $self->{term}{_hook}[$htype]{$pkg};	812	extension. This member I<must not> be changed in any way.
833	}	813
834	}	814	=cut
835		815
836	our $AUTOLOAD;	816	our $AUTOLOAD;
837		817
838	sub AUTOLOAD {	818	sub AUTOLOAD {
839	$AUTOLOAD =~ /:([^:]+)$/	819	$AUTOLOAD =~ /:([^:]+)$/
…		…
852		832
853	sub DESTROY {	833	sub DESTROY {
854	# nop	834	# nop
855	}	835	}
856		836
857	# urxvt::destroy_hook	837	# urxvt::destroy_hook (basically a cheap Guard:: implementation)
858		838
859	sub urxvt::destroy_hook::DESTROY {	839	sub urxvt::destroy_hook::DESTROY {
860	${$_[0]}->();	840	${$_[0]}->();
861	}	841	}
862		842
863	sub urxvt::destroy_hook(&) {	843	sub urxvt::destroy_hook(&) {
864	bless \shift, urxvt::destroy_hook::	844	bless \shift, urxvt::destroy_hook::
865	}	845	}
		846
		847	=item $self->enable ($hook_name => $cb[, $hook_name => $cb..])
		848
		849	Dynamically enable the given hooks (named without the C<on_> prefix) for
		850	this extension, replacing any hook previously installed via C<enable> in
		851	this extension.
		852
		853	This is useful when you want to overwrite time-critical hooks only
		854	temporarily.
		855
		856	To install additional callbacks for the same hook, you can use the C<on>
		857	method of the C<urxvt::term> class.
		858
		859	=item $self->disable ($hook_name[, $hook_name..])
		860
		861	Dynamically disable the given hooks.
		862
		863	=cut
		864
		865	sub enable {
		866	my ($self, %hook) = @_;
		867	my $pkg = $self->{_pkg};
		868
		869	while (my ($name, $cb) = each %hook) {
		870	my $htype = $HOOKTYPE{uc $name};
		871	defined $htype
		872	or Carp::croak "unsupported hook type '$name'";
		873
		874	$self->set_should_invoke ($htype, +1)
		875	unless exists $self->{term}{_hook}[$htype]{$pkg};
		876
		877	$self->{term}{_hook}[$htype]{$pkg} = $cb;
		878	}
		879	}
		880
		881	sub disable {
		882	my ($self, @hook) = @_;
		883	my $pkg = $self->{_pkg};
		884
		885	for my $name (@hook) {
		886	my $htype = $HOOKTYPE{uc $name};
		887	defined $htype
		888	or Carp::croak "unsupported hook type '$name'";
		889
		890	$self->set_should_invoke ($htype, -1)
		891	if delete $self->{term}{_hook}[$htype]{$pkg};
		892	}
		893	}
		894
		895	=item $guard = $self->on ($hook_name => $cb[, $hook_name => $cb..])
		896
		897	Similar to the C<enable> enable, but installs additional callbacks for
		898	the given hook(s) (that is, it doesn't replace existing callbacks), and
		899	returns a guard object. When the guard object is destroyed the callbacks
		900	are disabled again.
		901
		902	=cut
		903
		904	sub urxvt::extension::on_disable::DESTROY {
		905	my $disable = shift;
		906
		907	my $term = delete $disable->{""};
		908
		909	while (my ($htype, $id) = each %$disable) {
		910	delete $term->{_hook}[$htype]{$id};
		911	$term->set_should_invoke ($htype, -1);
		912	}
		913	}
		914
		915	sub on {
		916	my ($self, %hook) = @_;
		917
		918	my $term = $self->{term};
		919
		920	my %disable = ( "" => $term );
		921
		922	while (my ($name, $cb) = each %hook) {
		923	my $htype = $HOOKTYPE{uc $name};
		924	defined $htype
		925	or Carp::croak "unsupported hook type '$name'";
		926
		927	$term->set_should_invoke ($htype, +1);
		928	$term->{_hook}[$htype]{ $disable{$htype} = $cb+0 }
		929	= sub { shift; $cb->($self, @_) }; # very ugly indeed
		930	}
		931
		932	bless \%disable, "urxvt::extension::on_disable"
		933	}
		934
		935	=item $self->x_resource ($pattern)
		936
		937	=item $self->x_resource_boolean ($pattern)
		938
		939	These methods support an additional C<%> prefix when called on an
		940	extension object - see the description of these methods in the
		941	C<urxvt::term> class for details.
		942
		943	=cut
866		944
867	sub x_resource {	945	sub x_resource {
868	my ($self, $name) = @_;	946	my ($self, $name) = @_;
869	$name =~ s/^%(\.\|$)/$_[0]{_name}$1/;	947	$name =~ s/^%(\.\|$)/$_[0]{_name}$1/;
870	$self->{term}->x_resource ($name)	948	$self->{term}->x_resource ($name)
…		…
873	sub x_resource_boolean {	951	sub x_resource_boolean {
874	my ($self, $name) = @_;	952	my ($self, $name) = @_;
875	$name =~ s/^%(\.\|$)/$_[0]{_name}$1/;	953	$name =~ s/^%(\.\|$)/$_[0]{_name}$1/;
876	$self->{term}->x_resource_boolean ($name)	954	$self->{term}->x_resource_boolean ($name)
877	}	955	}
		956
		957	=back
		958
		959	=cut
878		960
879	package urxvt::anyevent;	961	package urxvt::anyevent;
880		962
881	=head2 The C<urxvt::anyevent> Class	963	=head2 The C<urxvt::anyevent> Class
882		964
…		…
1001	$ENV{URXVT_PERL_LIB},	1083	$ENV{URXVT_PERL_LIB},
1002	"$ENV{HOME}/.urxvt/ext",	1084	"$ENV{HOME}/.urxvt/ext",
1003	"$LIBDIR/perl"	1085	"$LIBDIR/perl"
1004	}	1086	}
1005		1087
1006	sub scan_meta {	1088	# scan for available extensions and collect their metadata
		1089	sub scan_extensions {
1007	my ($self) = @_;	1090	my ($self) = @_;
		1091
		1092	return if exists $self->{meta};
		1093
1008	my @libdirs = perl_libdirs $self;	1094	my @libdirs = perl_libdirs $self;
1009		1095
1010	return if $self->{meta_libdirs} eq join "\x00", @libdirs;	1096	# return if $self->{meta_libdirs} eq join "\x00", @libdirs;#d#
1011		1097
1012	my %meta;
1013
1014	$self->{meta_libdirs} = join "\x00", @libdirs;	1098	# $self->{meta_libdirs} = join "\x00", @libdirs;#d#
1015	$self->{meta} = \%meta;	1099	$self->{meta} = \my %meta;
1016		1100
		1101	# first gather extensions
1017	for my $dir (reverse @libdirs) {	1102	for my $dir (reverse @libdirs) {
1018	opendir my $fh, $dir	1103	opendir my $fh, $dir
1019	or next;	1104	or next;
1020	for my $ext (readdir $fh) {	1105	for my $ext (readdir $fh) {
1021	$ext ne "."	1106	$ext !~ /^\./
1022	and $ext ne ".."
1023	and open my $fh, "<", "$dir/$ext"	1107	and open my $fh, "<", "$dir/$ext"
1024	or next;	1108	or next;
1025		1109
		1110	my %ext = (dir => $dir);
		1111
1026	while (<$fh>) {	1112	while (<$fh>) {
1027	if (/^#:META:X_RESOURCE:(.*)/) {	1113	if (/^#:META:(?:X_)?RESOURCE:(.*)/) {
1028	my ($pattern, $type, $desc) = split /:/, $1;	1114	my ($pattern, $type, $desc) = split /:/, $1;
1029	$pattern =~ s/^%(\.\|$)/$ext$1/g; # % in pattern == extension name	1115	$pattern =~ s/^%(\.\|$)/$ext$1/g; # % in pattern == extension name
1030	if ($pattern =~ /[^a-zA-Z0-9\-\.]/) {	1116	if ($pattern =~ /[^a-zA-Z0-9\-\.]/) {
1031	warn "$dir/$ext: meta resource '$pattern' contains illegal characters (not alphanumeric nor . nor *)\n";	1117	warn "$dir/$ext: meta resource '$pattern' contains illegal characters (not alphanumeric nor . nor *)\n";
1032	} else {	1118	} else {
1033	$meta{resource}{$pattern} = [$ext, $type, $desc];	1119	$ext{resource}{$pattern} = [$ext, $type, $desc];
1034	}	1120	}
		1121	} elsif (/^#:META:BINDING:(.*)/) {
		1122	my ($keysym, $action) = split /:/, $1;
		1123	$ext{binding}{$keysym} = [$ext, $action];
1035	} elsif (/^\s*(?:#\|$)/) {	1124	} elsif (/^\s*(?:#\|$)/) {
1036	# skip other comments and empty lines	1125	# skip other comments and empty lines
1037	} else {	1126	} else {
1038	last; # stop parsing on first non-empty non-comment line	1127	last; # stop parsing on first non-empty non-comment line
1039	}	1128	}
1040	}	1129	}
		1130
		1131	$meta{ext}{$ext} = \%ext;
1041	}	1132	}
		1133	}
		1134
		1135	# and now merge resources and bindings
		1136	while (my ($k, $v) = each %{ $meta{ext} }) {
		1137	#TODO: should check for extensions overriding each other
		1138	%{ $meta{resource} } = (%{ $meta{resource} }, %{ $v->{resource} });
		1139	%{ $meta{binding} } = (%{ $meta{binding} }, %{ $v->{binding} });
1042	}	1140	}
1043	}	1141	}
1044		1142
1045	=item $term = new urxvt::term $envhashref, $rxvtname, [arg...]	1143	=item $term = new urxvt::term $envhashref, $rxvtname, [arg...]
1046		1144
…		…
1066	}	1164	}
1067		1165
1068	=item $term->destroy	1166	=item $term->destroy
1069		1167
1070	Destroy the terminal object (close the window, free resources	1168	Destroy the terminal object (close the window, free resources
1071	etc.). Please note that @@RXVT_NAME@@ will not exit as long as any event	1169	etc.). Please note that urxvt will not exit as long as any event
1072	watchers (timers, io watchers) are still active.	1170	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		1171
1117	=item $term->exec_async ($cmd[, @args])	1172	=item $term->exec_async ($cmd[, @args])
1118		1173
1119	Works like the combination of the C<fork>/C<exec> builtins, which executes	1174	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	1175	("starts") programs in the background. This function takes care of setting
…		…
1235	my $res = &x_resource;	1290	my $res = &x_resource;
1236		1291
1237	$res =~ /^\s(?:true\|yes\|on\|1)\s$/i ? 1 : defined $res && 0	1292	$res =~ /^\s(?:true\|yes\|on\|1)\s$/i ? 1 : defined $res && 0
1238	}	1293	}
1239		1294
1240	=item $success = $term->parse_keysym ($key, $octets)	1295	=item $success = $term->bind_action ($key, $octets)
1241		1296
1242	Adds a key binding exactly as specified via a resource. See the	1297	Adds a key binding exactly as specified via a C<keysym> resource. See the
1243	C<keysym> resource in the @@RXVT_NAME@@(1) manpage.	1298	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		1299
1252	=item $rend = $term->rstyle ([$new_rstyle])	1300	=item $rend = $term->rstyle ([$new_rstyle])
1253		1301
1254	Return and optionally change the current rendition. Text that is output by	1302	Return and optionally change the current rendition. Text that is output by
1255	the terminal application will use this style.	1303	the terminal application will use this style.
…		…
1435	=item $term->tt_write ($octets)	1483	=item $term->tt_write ($octets)
1436		1484
1437	Write the octets given in C<$octets> to the tty (i.e. as program input). To	1485	Write the octets given in C<$octets> to the tty (i.e. as program input). To
1438	pass characters instead of octets, you should convert your strings first	1486	pass characters instead of octets, you should convert your strings first
1439	to the locale-specific encoding using C<< $term->locale_encode >>.	1487	to the locale-specific encoding using C<< $term->locale_encode >>.
		1488
		1489	=item $term->tt_write_user_input ($octets)
		1490
		1491	Like C<tt_write>, but should be used when writing strings in response to
		1492	the user pressing a key, to invokes the additional actions requested by
		1493	the user for that case (C<tt_write> doesn't do that).
		1494
		1495	The typical use case would be inside C<on_action> hooks.
1440		1496
1441	=item $term->tt_paste ($octets)	1497	=item $term->tt_paste ($octets)
1442		1498
1443	Write the octets given in C<$octets> to the tty as a paste, converting NL to	1499	Write the octets given in C<$octets> to the tty as a paste, converting NL to
1444	CR and bracketing the data with control sequences if bracketed paste mode	1500	CR and bracketing the data with control sequences if bracketed paste mode
…		…
1678	}	1734	}
1679		1735
1680	sub urxvt::line::t {	1736	sub urxvt::line::t {
1681	my ($self) = @_;	1737	my ($self) = @_;
1682		1738
1683	if (@_ > 1)	1739	if (@_ > 1) {
1684	{
1685	$self->{term}->ROW_t ($_, $_[1], 0, ($_ - $self->{beg}) * $self->{ncol}, $self->{ncol})	1740	$self->{term}->ROW_t ($_, $_[1], 0, ($_ - $self->{beg}) * $self->{ncol}, $self->{ncol})
1686	for $self->{beg} .. $self->{end};	1741	for $self->{beg} .. $self->{end};
1687	}	1742	}
1688		1743
1689	defined wantarray &&	1744	defined wantarray &&
1690	substr +(join "", map $self->{term}->ROW_t ($_), $self->{beg} .. $self->{end}),	1745	substr +(join "", map $self->{term}->ROW_t ($_), $self->{beg} .. $self->{end}),
1691	0, $self->{len}	1746	0, $self->{len}
1692	}	1747	}
1693		1748
1694	sub urxvt::line::r {	1749	sub urxvt::line::r {
1695	my ($self) = @_;	1750	my ($self) = @_;
1696		1751
1697	if (@_ > 1)	1752	if (@_ > 1) {
1698	{
1699	$self->{term}->ROW_r ($_, $_[1], 0, ($_ - $self->{beg}) * $self->{ncol}, $self->{ncol})	1753	$self->{term}->ROW_r ($_, $_[1], 0, ($_ - $self->{beg}) * $self->{ncol}, $self->{ncol})
1700	for $self->{beg} .. $self->{end};	1754	for $self->{beg} .. $self->{end};
1701	}	1755	}
1702		1756
1703	if (defined wantarray) {	1757	if (defined wantarray) {
1704	my $rend = [	1758	my $rend = [
1705	map @{ $self->{term}->ROW_r ($_) }, $self->{beg} .. $self->{end}	1759	map @{ $self->{term}->ROW_r ($_) }, $self->{beg} .. $self->{end}
1706	];	1760	];

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.236 by root, Sat May 17 17:12:29 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.236 by root, Sat May 17 17:12:29 2014 UTC