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

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

Diff Legend

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

Comparing rxvt-unicode/src/urxvt.pm (file contents): Revision 1.221 by sf-exg, Thu Jun 21 06:08:05 2012 UTC vs. Revision 1.241 by sf-exg, Fri Oct 10 14:38:02 2014 UTC

Diff Legend

Comparing rxvt-unicode/src/urxvt.pm (file contents):
Revision 1.221 by sf-exg, Thu Jun 21 06:08:05 2012 UTC vs.
Revision 1.241 by sf-exg, Fri Oct 10 14:38:02 2014 UTC