[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.238 by root, Sun May 18 18:15:04 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;
…		…
711	@TERM_EXT = ();	675	@TERM_EXT = ();
712	$TERM->register_package ($_) for @pkg;	676	$TERM->register_package ($_) for @pkg;
713	}	677	}
714		678
715	for (	679	for (
716	@{ delete $TERM->{perl_ext_3} },
717	grep $_, map { split /,/, $TERM->resource ("perl_ext_$_") } 1, 2	680	grep $_, map { split /,/, $TERM->resource ("perl_ext_$_") } 1, 2
718	) {	681	) {
719	if ($_ eq "default") {	682	if ($_ eq "default") {
720	$ext_arg{$_} \|\|= [] for qw(selection option-popup selection-popup searchable-scrollback readline);	683
		684	$ext_arg{$_} = []
		685	for
		686	qw(selection option-popup selection-popup readline),
		687	map $_->[0], values %{ $TERM->{meta}{binding} },
		688	@{ delete $TERM->{perl_ext_3} };
		689
		690	for ($TERM->_keysym_resources) {
		691	next if /^(?:string\|command\|builtin\|builtin-string\|perl)/;
		692	next unless /^([A-Za-z0-9_\-]+):/;
		693
		694	my $ext = $1;
		695	$ext =~ y/-/_/;
		696
		697	$ext_arg{$ext} = [];
		698	}
		699
721	} elsif (/^-(.*)$/) {	700	} elsif (/^-(.*)$/) {
722	delete $ext_arg{$1};	701	delete $ext_arg{$1};
		702
723	} elsif (/^([^<]+)<(.*)>$/) {	703	} elsif (/^([^<]+)<(.*)>$/) {
724	push @{ $ext_arg{$1} }, $2;	704	push @{ $ext_arg{$1} }, $2;
		705
725	} else {	706	} else {
726	$ext_arg{$_} \|\|= [];	707	$ext_arg{$_} \|\|= [];
		708	}
		709	}
		710
		711	# now register default key bindings
		712	for my $ext (sort keys %ext_arg) {
		713	while (my ($k, $v) = each %{ $TERM->{meta}{ext}{$ext}{binding} }) {
		714	$TERM->bind_action ($k, "$v->[0]:$v->[1]");
727	}	715	}
728	}	716	}
729		717
730	for my $ext (sort keys %ext_arg) {	718	for my $ext (sort keys %ext_arg) {
731	my @files = grep -f $_, map "$_/$ext", @dirs;	719	my @files = grep -f $_, map "$_/$ext", @dirs;
…		…
745		733
746	if (my $cb = $TERM->{_hook}[$htype]) {	734	if (my $cb = $TERM->{_hook}[$htype]) {
747	verbose 10, "$HOOKNAME[$htype] (" . (join ", ", $TERM, @_) . ")"	735	verbose 10, "$HOOKNAME[$htype] (" . (join ", ", $TERM, @_) . ")"
748	if $verbosity >= 10;	736	if $verbosity >= 10;
749		737
		738	if ($htype == HOOK_ACTION) {
		739	# this hook is only sent to the extension with the name
		740	# matching the first arg
		741	my $pkg = shift;
		742	$pkg =~ y/-/_/;
		743	$pkg = "urxvt::ext::$pkg";
		744
		745	$cb = $cb->{$pkg}
		746	or return undef; #TODO: maybe warn user?
		747
		748	$cb = { $pkg => $cb };
		749	}
		750
750	for my $pkg (keys %$cb) {	751	for my $pkg (keys %$cb) {
751	my $retval_ = eval { $cb->{$pkg}->($TERM->{_pkg}{$pkg} \|\| $TERM, @_) };	752	my $retval_ = eval { $cb->{$pkg}->($TERM->{_pkg}{$pkg} \|\| $TERM, @_) };
752	$retval \|\|= $retval_;	753	$retval \|\|= $retval_;
753		754
754	if ($@) {	755	if ($@) {
…		…
759		760
760	verbose 11, "$HOOKNAME[$htype] returning <$retval>"	761	verbose 11, "$HOOKNAME[$htype] returning <$retval>"
761	if $verbosity >= 11;	762	if $verbosity >= 11;
762	}	763	}
763		764
764	if ($htype == 1) { # DESTROY	765	if ($htype == HOOK_DESTROY) {
765	# clear package objects	766	# clear package objects
766	%$_ = () for values %{ $TERM->{_pkg} };	767	%$_ = () for values %{ $TERM->{_pkg} };
767		768
768	# clear package	769	# clear package
769	%$TERM = ();	770	%$TERM = ();
…		…
801	($mask, @color{qw(fg bg)}, \@failed)	802	($mask, @color{qw(fg bg)}, \@failed)
802	}	803	}
803		804
804	package urxvt::term::extension;	805	package urxvt::term::extension;
805		806
806	sub enable {	807	=head2 The C<urxvt::term::extension> class
807	my ($self, %hook) = @_;
808	my $pkg = $self->{_pkg};
809		808
810	while (my ($name, $cb) = each %hook) {	809	Each extension attached to a terminal object is represented by
811	my $htype = $HOOKTYPE{uc $name};	810	a C<urxvt::term::extension> object.
812	defined $htype
813	or Carp::croak "unsupported hook type '$name'";
814		811
815	$self->set_should_invoke ($htype, +1)	812	You can use these objects, which are passed to all callbacks to store any
816	unless exists $self->{term}{_hook}[$htype]{$pkg};	813	state related to the terminal and extension instance.
817		814
818	$self->{term}{_hook}[$htype]{$pkg} = $cb;	815	The methods (And data members) documented below can be called on extension
819	}	816	objects, in addition to call methods documented for the <urxvt::term>
820	}	817	class.
821		818
822	sub disable {	819	=over 4
823	my ($self, @hook) = @_;
824	my $pkg = $self->{_pkg};
825		820
826	for my $name (@hook) {	821	=item $urxvt_term = $self->{term}
827	my $htype = $HOOKTYPE{uc $name};
828	defined $htype
829	or Carp::croak "unsupported hook type '$name'";
830		822
831	$self->set_should_invoke ($htype, -1)	823	Returns the C<urxvt::term> object associated with this instance of the
832	if delete $self->{term}{_hook}[$htype]{$pkg};	824	extension. This member I<must not> be changed in any way.
833	}	825
834	}	826	=cut
835		827
836	our $AUTOLOAD;	828	our $AUTOLOAD;
837		829
838	sub AUTOLOAD {	830	sub AUTOLOAD {
839	$AUTOLOAD =~ /:([^:]+)$/	831	$AUTOLOAD =~ /:([^:]+)$/
…		…
852		844
853	sub DESTROY {	845	sub DESTROY {
854	# nop	846	# nop
855	}	847	}
856		848
857	# urxvt::destroy_hook	849	# urxvt::destroy_hook (basically a cheap Guard:: implementation)
858		850
859	sub urxvt::destroy_hook::DESTROY {	851	sub urxvt::destroy_hook::DESTROY {
860	${$_[0]}->();	852	${$_[0]}->();
861	}	853	}
862		854
863	sub urxvt::destroy_hook(&) {	855	sub urxvt::destroy_hook(&) {
864	bless \shift, urxvt::destroy_hook::	856	bless \shift, urxvt::destroy_hook::
865	}	857	}
		858
		859	=item $self->enable ($hook_name => $cb[, $hook_name => $cb..])
		860
		861	Dynamically enable the given hooks (named without the C<on_> prefix) for
		862	this extension, replacing any hook previously installed via C<enable> in
		863	this extension.
		864
		865	This is useful when you want to overwrite time-critical hooks only
		866	temporarily.
		867
		868	To install additional callbacks for the same hook, you can use the C<on>
		869	method of the C<urxvt::term> class.
		870
		871	=item $self->disable ($hook_name[, $hook_name..])
		872
		873	Dynamically disable the given hooks.
		874
		875	=cut
		876
		877	sub enable {
		878	my ($self, %hook) = @_;
		879	my $pkg = $self->{_pkg};
		880
		881	while (my ($name, $cb) = each %hook) {
		882	my $htype = $HOOKTYPE{uc $name};
		883	defined $htype
		884	or Carp::croak "unsupported hook type '$name'";
		885
		886	$self->set_should_invoke ($htype, +1)
		887	unless exists $self->{term}{_hook}[$htype]{$pkg};
		888
		889	$self->{term}{_hook}[$htype]{$pkg} = $cb;
		890	}
		891	}
		892
		893	sub disable {
		894	my ($self, @hook) = @_;
		895	my $pkg = $self->{_pkg};
		896
		897	for my $name (@hook) {
		898	my $htype = $HOOKTYPE{uc $name};
		899	defined $htype
		900	or Carp::croak "unsupported hook type '$name'";
		901
		902	$self->set_should_invoke ($htype, -1)
		903	if delete $self->{term}{_hook}[$htype]{$pkg};
		904	}
		905	}
		906
		907	=item $guard = $self->on ($hook_name => $cb[, $hook_name => $cb..])
		908
		909	Similar to the C<enable> enable, but installs additional callbacks for
		910	the given hook(s) (that is, it doesn't replace existing callbacks), and
		911	returns a guard object. When the guard object is destroyed the callbacks
		912	are disabled again.
		913
		914	=cut
		915
		916	sub urxvt::extension::on_disable::DESTROY {
		917	my $disable = shift;
		918
		919	my $term = delete $disable->{""};
		920
		921	while (my ($htype, $id) = each %$disable) {
		922	delete $term->{_hook}[$htype]{$id};
		923	$term->set_should_invoke ($htype, -1);
		924	}
		925	}
		926
		927	sub on {
		928	my ($self, %hook) = @_;
		929
		930	my $term = $self->{term};
		931
		932	my %disable = ( "" => $term );
		933
		934	while (my ($name, $cb) = each %hook) {
		935	my $htype = $HOOKTYPE{uc $name};
		936	defined $htype
		937	or Carp::croak "unsupported hook type '$name'";
		938
		939	$term->set_should_invoke ($htype, +1);
		940	$term->{_hook}[$htype]{ $disable{$htype} = $cb+0 }
		941	= sub { shift; $cb->($self, @_) }; # very ugly indeed
		942	}
		943
		944	bless \%disable, "urxvt::extension::on_disable"
		945	}
		946
		947	=item $self->x_resource ($pattern)
		948
		949	=item $self->x_resource_boolean ($pattern)
		950
		951	These methods support an additional C<%> prefix when called on an
		952	extension object - see the description of these methods in the
		953	C<urxvt::term> class for details.
		954
		955	=cut
866		956
867	sub x_resource {	957	sub x_resource {
868	my ($self, $name) = @_;	958	my ($self, $name) = @_;
869	$name =~ s/^%(\.\|$)/$_[0]{_name}$1/;	959	$name =~ s/^%(\.\|$)/$_[0]{_name}$1/;
870	$self->{term}->x_resource ($name)	960	$self->{term}->x_resource ($name)
…		…
873	sub x_resource_boolean {	963	sub x_resource_boolean {
874	my ($self, $name) = @_;	964	my ($self, $name) = @_;
875	$name =~ s/^%(\.\|$)/$_[0]{_name}$1/;	965	$name =~ s/^%(\.\|$)/$_[0]{_name}$1/;
876	$self->{term}->x_resource_boolean ($name)	966	$self->{term}->x_resource_boolean ($name)
877	}	967	}
		968
		969	=back
		970
		971	=cut
878		972
879	package urxvt::anyevent;	973	package urxvt::anyevent;
880		974
881	=head2 The C<urxvt::anyevent> Class	975	=head2 The C<urxvt::anyevent> Class
882		976
…		…
1001	$ENV{URXVT_PERL_LIB},	1095	$ENV{URXVT_PERL_LIB},
1002	"$ENV{HOME}/.urxvt/ext",	1096	"$ENV{HOME}/.urxvt/ext",
1003	"$LIBDIR/perl"	1097	"$LIBDIR/perl"
1004	}	1098	}
1005		1099
1006	sub scan_meta {	1100	# scan for available extensions and collect their metadata
		1101	sub scan_extensions {
1007	my ($self) = @_;	1102	my ($self) = @_;
		1103
		1104	return if exists $self->{meta};
		1105
1008	my @libdirs = perl_libdirs $self;	1106	my @libdirs = perl_libdirs $self;
1009		1107
1010	return if $self->{meta_libdirs} eq join "\x00", @libdirs;	1108	# return if $self->{meta_libdirs} eq join "\x00", @libdirs;#d#
1011		1109
1012	my %meta;
1013
1014	$self->{meta_libdirs} = join "\x00", @libdirs;	1110	# $self->{meta_libdirs} = join "\x00", @libdirs;#d#
1015	$self->{meta} = \%meta;	1111	$self->{meta} = \my %meta;
1016		1112
		1113	# first gather extensions
1017	for my $dir (reverse @libdirs) {	1114	for my $dir (reverse @libdirs) {
1018	opendir my $fh, $dir	1115	opendir my $fh, $dir
1019	or next;	1116	or next;
1020	for my $ext (readdir $fh) {	1117	for my $ext (readdir $fh) {
1021	$ext ne "."	1118	$ext !~ /^\./
1022	and $ext ne ".."
1023	and open my $fh, "<", "$dir/$ext"	1119	and open my $fh, "<", "$dir/$ext"
1024	or next;	1120	or next;
1025		1121
		1122	my %ext = (dir => $dir);
		1123
1026	while (<$fh>) {	1124	while (<$fh>) {
1027	if (/^#:META:X_RESOURCE:(.*)/) {	1125	if (/^#:META:(?:X_)?RESOURCE:(.*)/) {
1028	my ($pattern, $type, $desc) = split /:/, $1;	1126	my ($pattern, $type, $desc) = split /:/, $1;
1029	$pattern =~ s/^%(\.\|$)/$ext$1/g; # % in pattern == extension name	1127	$pattern =~ s/^%(\.\|$)/$ext$1/g; # % in pattern == extension name
1030	if ($pattern =~ /[^a-zA-Z0-9\-\.]/) {	1128	if ($pattern =~ /[^a-zA-Z0-9\-\.]/) {
1031	warn "$dir/$ext: meta resource '$pattern' contains illegal characters (not alphanumeric nor . nor *)\n";	1129	warn "$dir/$ext: meta resource '$pattern' contains illegal characters (not alphanumeric nor . nor *)\n";
1032	} else {	1130	} else {
1033	$meta{resource}{$pattern} = [$ext, $type, $desc];	1131	$ext{resource}{$pattern} = [$ext, $type, $desc];
1034	}	1132	}
		1133	} elsif (/^#:META:BINDING:(.*)/) {
		1134	my ($keysym, $action) = split /:/, $1;
		1135	$ext{binding}{$keysym} = [$ext, $action];
1035	} elsif (/^\s*(?:#\|$)/) {	1136	} elsif (/^\s*(?:#\|$)/) {
1036	# skip other comments and empty lines	1137	# skip other comments and empty lines
1037	} else {	1138	} else {
1038	last; # stop parsing on first non-empty non-comment line	1139	last; # stop parsing on first non-empty non-comment line
1039	}	1140	}
1040	}	1141	}
		1142
		1143	$meta{ext}{$ext} = \%ext;
1041	}	1144	}
		1145	}
		1146
		1147	# and now merge resources and bindings
		1148	while (my ($k, $v) = each %{ $meta{ext} }) {
		1149	#TODO: should check for extensions overriding each other
		1150	%{ $meta{resource} } = (%{ $meta{resource} }, %{ $v->{resource} });
		1151	%{ $meta{binding} } = (%{ $meta{binding} }, %{ $v->{binding} });
1042	}	1152	}
1043	}	1153	}
1044		1154
1045	=item $term = new urxvt::term $envhashref, $rxvtname, [arg...]	1155	=item $term = new urxvt::term $envhashref, $rxvtname, [arg...]
1046		1156
…		…
1066	}	1176	}
1067		1177
1068	=item $term->destroy	1178	=item $term->destroy
1069		1179
1070	Destroy the terminal object (close the window, free resources	1180	Destroy the terminal object (close the window, free resources
1071	etc.). Please note that @@RXVT_NAME@@ will not exit as long as any event	1181	etc.). Please note that urxvt will not exit as long as any event
1072	watchers (timers, io watchers) are still active.	1182	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		1183
1117	=item $term->exec_async ($cmd[, @args])	1184	=item $term->exec_async ($cmd[, @args])
1118		1185
1119	Works like the combination of the C<fork>/C<exec> builtins, which executes	1186	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	1187	("starts") programs in the background. This function takes care of setting
…		…
1235	my $res = &x_resource;	1302	my $res = &x_resource;
1236		1303
1237	$res =~ /^\s(?:true\|yes\|on\|1)\s$/i ? 1 : defined $res && 0	1304	$res =~ /^\s(?:true\|yes\|on\|1)\s$/i ? 1 : defined $res && 0
1238	}	1305	}
1239		1306
1240	=item $success = $term->parse_keysym ($key, $octets)	1307	=item $success = $term->bind_action ($key, $octets)
1241		1308
1242	Adds a key binding exactly as specified via a resource. See the	1309	Adds a key binding exactly as specified via a C<keysym> resource. See the
1243	C<keysym> resource in the @@RXVT_NAME@@(1) manpage.	1310	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		1311
1252	=item $rend = $term->rstyle ([$new_rstyle])	1312	=item $rend = $term->rstyle ([$new_rstyle])
1253		1313
1254	Return and optionally change the current rendition. Text that is output by	1314	Return and optionally change the current rendition. Text that is output by
1255	the terminal application will use this style.	1315	the terminal application will use this style.
…		…
1435	=item $term->tt_write ($octets)	1495	=item $term->tt_write ($octets)
1436		1496
1437	Write the octets given in C<$octets> to the tty (i.e. as program input). To	1497	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	1498	pass characters instead of octets, you should convert your strings first
1439	to the locale-specific encoding using C<< $term->locale_encode >>.	1499	to the locale-specific encoding using C<< $term->locale_encode >>.
		1500
		1501	=item $term->tt_write_user_input ($octets)
		1502
		1503	Like C<tt_write>, but should be used when writing strings in response to
		1504	the user pressing a key, to invokes the additional actions requested by
		1505	the user for that case (C<tt_write> doesn't do that).
		1506
		1507	The typical use case would be inside C<on_action> hooks.
1440		1508
1441	=item $term->tt_paste ($octets)	1509	=item $term->tt_paste ($octets)
1442		1510
1443	Write the octets given in C<$octets> to the tty as a paste, converting NL to	1511	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	1512	CR and bracketing the data with control sequences if bracketed paste mode
…		…
1678	}	1746	}
1679		1747
1680	sub urxvt::line::t {	1748	sub urxvt::line::t {
1681	my ($self) = @_;	1749	my ($self) = @_;
1682		1750
1683	if (@_ > 1)	1751	if (@_ > 1) {
1684	{
1685	$self->{term}->ROW_t ($_, $_[1], 0, ($_ - $self->{beg}) * $self->{ncol}, $self->{ncol})	1752	$self->{term}->ROW_t ($_, $_[1], 0, ($_ - $self->{beg}) * $self->{ncol}, $self->{ncol})
1686	for $self->{beg} .. $self->{end};	1753	for $self->{beg} .. $self->{end};
1687	}	1754	}
1688		1755
1689	defined wantarray &&	1756	defined wantarray &&
1690	substr +(join "", map $self->{term}->ROW_t ($_), $self->{beg} .. $self->{end}),	1757	substr +(join "", map $self->{term}->ROW_t ($_), $self->{beg} .. $self->{end}),
1691	0, $self->{len}	1758	0, $self->{len}
1692	}	1759	}
1693		1760
1694	sub urxvt::line::r {	1761	sub urxvt::line::r {
1695	my ($self) = @_;	1762	my ($self) = @_;
1696		1763
1697	if (@_ > 1)	1764	if (@_ > 1) {
1698	{
1699	$self->{term}->ROW_r ($_, $_[1], 0, ($_ - $self->{beg}) * $self->{ncol}, $self->{ncol})	1765	$self->{term}->ROW_r ($_, $_[1], 0, ($_ - $self->{beg}) * $self->{ncol}, $self->{ncol})
1700	for $self->{beg} .. $self->{end};	1766	for $self->{beg} .. $self->{end};
1701	}	1767	}
1702		1768
1703	if (defined wantarray) {	1769	if (defined wantarray) {
1704	my $rend = [	1770	my $rend = [
1705	map @{ $self->{term}->ROW_r ($_) }, $self->{beg} .. $self->{end}	1771	map @{ $self->{term}->ROW_r ($_) }, $self->{beg} .. $self->{end}
1706	];	1772	];

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.238 by root, Sun May 18 18:15:04 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.238 by root, Sun May 18 18:15:04 2014 UTC