[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.244 by sf-exg, Mon Oct 13 12:17:48 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
48	Extensions that add command line parameters or resources on their own are	48	Extensions may add additional resources and C<actions>, i.e., methods
49	loaded automatically when used.	49	which can be bound to a key and invoked by the user. An extension can
		50	define the resources it support and also default bindings for one or
		51	more actions it provides using so called META comments, described
		52	below. Similarly to builtin resources, extension resources can also be
		53	specified on the command line as long options (with C<.> replaced by
		54	C<->), in which case the corresponding extension is loaded
		55	automatically. For this to work the extension B<must> define META
		56	comments for its resources.
50		57
51	=head1 API DOCUMENTATION	58	=head1 API DOCUMENTATION
52		59
53	=head2 General API Considerations	60	=head2 General API Considerations
54		61
103	internal use.	110	internal use.
104		111
105	Although it isn't a C<urxvt::term> object, you can call all methods of the	112	Although it isn't a C<urxvt::term> object, you can call all methods of the
106	C<urxvt::term> class on this object.	113	C<urxvt::term> class on this object.
107		114
108	It has the following methods and data members:	115	Additional methods only supported for extension objects are described in
		116	the C<urxvt::extension> section below.
		117
		118	=head2 META comments
		119
		120	rxvt-unicode recognizes special comments in extensions that define
		121	different types of metadata:
109		122
110	=over 4	123	=over 4
111		124
112	=item $urxvt_term = $self->{term}	125	=item #:META:RESOURCE:name:type:desc
113		126
114	Returns the C<urxvt::term> object associated with this instance of the	127	The RESOURCE comment defines a resource used by the extension, where
115	extension. This member I<must not> be changed in any way.	128	C<name> is the resource name, C<type> is the resource type, C<boolean>
		129	or C<string>, and C<desc> is the resource description.
116		130
117	=item $self->enable ($hook_name => $cb[, $hook_name => $cb..])	131	=item #:META:BINDING:sym:action
118		132
119	Dynamically enable the given hooks (named without the C<on_> prefix) for	133	The BINDING comment defines a default binding for an action provided
120	this extension, replacing any previous hook. This is useful when you want	134	by the extension, where C<sym> is the key combination that triggers
121	to overwrite time-critical hooks only temporarily.	135	the action, whose format is defined in the description of the
122		136	B<keysym> resource in the urxvt(1) manpage, and C<action> is the name
123	To install additional callbacks for the same hook, you cna use the C<on>	137	of the action method.
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
138	=back	139	=back
139		140
140	=head2 Hooks	141	=head2 Hooks
141		142
…		…
310		311
311	=item on_refresh_end $term	312	=item on_refresh_end $term
312		313
313	Called just after the screen gets redrawn. See C<on_refresh_begin>.	314	Called just after the screen gets redrawn. See C<on_refresh_begin>.
314		315
		316	=item on_action $term, $string
		317
		318	Called whenever an action is invoked for the corresponding extension
		319	(e.g. via a C<extension:string> builtin action bound to a key, see
		320	description of the B<keysym> resource in the urxvt(1) manpage). The
		321	event is simply the action string. Note that an action event is always
		322	associated to a single extension.
		323
315	=item on_user_command $term, $string	324	=item on_user_command $term, $string DEPRECATED
316		325
317	Called whenever a user-configured event is being activated (e.g. via	326	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>	327	a C<perl:string> action bound to a key, see description of the B<keysym>
319	resource in the @@RXVT_NAME@@(1) manpage).	328	resource in the urxvt(1) manpage).
320		329
321	The event is simply the action string. This interface is assumed to change	330	The event is simply the action string. This interface is going away in
322	slightly in the future.	331	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		332
331	=item on_resize_all_windows $term, $new_width, $new_height	333	=item on_resize_all_windows $term, $new_width, $new_height
332		334
333	Called just after the new window size has been calculated, but before	335	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	336	windows are actually being resized or hints are being set. If this hook
335	returns TRUE, setting of the window hints is being skipped.	337	returns a true value, setting of the window hints is being skipped.
336		338
337	=item on_x_event $term, $event	339	=item on_x_event $term, $event
338		340
339	Called on every X event received on the vt window (and possibly other	341	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	342	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	381	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.	382	(real, not screen-based) row and column under the mouse cursor.
381		383
382	C<on_key_press> additionally receives the string rxvt-unicode would	384	C<on_key_press> additionally receives the string rxvt-unicode would
383	output, if any, in locale-specific encoding.	385	output, if any, in locale-specific encoding.
384
385	subwindow.
386		386
387	=item on_client_message $term, $event	387	=item on_client_message $term, $event
388		388
389	=item on_wm_protocols $term, $event	389	=item on_wm_protocols $term, $event
390		390
…		…
593	no warnings 'utf8';	593	no warnings 'utf8';
594		594
595	sub parse_resource {	595	sub parse_resource {
596	my ($term, $name, $isarg, $longopt, $flag, $value) = @_;	596	my ($term, $name, $isarg, $longopt, $flag, $value) = @_;
597		597
598	$name =~ y/-/./ if $isarg;
599
600	$term->scan_meta;	598	$term->scan_extensions;
601		599
602	my $r = $term->{meta}{resource};	600	my $r = $term->{meta}{resource};
603	keys %$r; # reste iterator	601	keys %$r; # reset iterator
604	while (my ($pattern, $v) = each %$r) {	602	while (my ($k, $v) = each %$r) {
605	if (	603	my $pattern = $k;
		604	$pattern =~ y/./-/ if $isarg;
		605	my $prefix = $name;
		606	my $suffix;
606	$pattern =~ /\.$/	607	if ($pattern =~ /\-$/) {
607	? $pattern eq substr $name, 0, length $pattern	608	$prefix = substr $name, 0, length $pattern;
608	: $pattern eq $name	609	$suffix = substr $name, length $pattern;
609	) {	610	}
		611	if ($pattern eq $prefix) {
610	$name = "$urxvt::RESCLASS.$name";	612	$name = "$urxvt::RESCLASS.$k$suffix";
611		613
612	push @{ $term->{perl_ext_3} }, $v->[0];	614	push @{ $term->{perl_ext_3} }, $v->[0];
613		615
614	if ($v->[1] eq "boolean") {	616	if ($v->[1] eq "boolean") {
615	$term->put_option_db ($name, $flag ? "true" : "false");	617	$term->put_option_db ($name, $flag ? "true" : "false");
…		…
625	}	627	}
626		628
627	sub usage {	629	sub usage {
628	my ($term, $usage_type) = @_;	630	my ($term, $usage_type) = @_;
629		631
630	$term->scan_meta;	632	$term->scan_extensions;
631		633
632	my $r = $term->{meta}{resource};	634	my $r = $term->{meta}{resource};
633		635
634	for my $pattern (sort keys %$r) {	636	for my $pattern (sort keys %$r) {
635	my ($ext, $type, $desc) = @{ $r->{$pattern} };	637	my ($ext, $type, $desc) = @{ $r->{$pattern} };
…		…
696	# called by the rxvt core	698	# called by the rxvt core
697	sub invoke {	699	sub invoke {
698	local $TERM = shift;	700	local $TERM = shift;
699	my $htype = shift;	701	my $htype = shift;
700		702
701	if ($htype == 0) { # INIT	703	if ($htype == HOOK_INIT) {
702	my @dirs = $TERM->perl_libdirs;	704	my @dirs = $TERM->perl_libdirs;
		705
		706	$TERM->scan_extensions;
703		707
704	my %ext_arg;	708	my %ext_arg;
705		709
706	{	710	{
707	my @init = @TERM_INIT;	711	my @init = @TERM_INIT;
…		…
711	@TERM_EXT = ();	715	@TERM_EXT = ();
712	$TERM->register_package ($_) for @pkg;	716	$TERM->register_package ($_) for @pkg;
713	}	717	}
714		718
715	for (	719	for (
		720	(grep $_, map { split /,/, $TERM->resource ("perl_ext_$_") } 1, 2),
716	@{ delete $TERM->{perl_ext_3} },	721	@{ delete $TERM->{perl_ext_3} }
717	grep $_, map { split /,/, $TERM->resource ("perl_ext_$_") } 1, 2
718	) {	722	) {
719	if ($_ eq "default") {	723	if ($_ eq "default") {
720	$ext_arg{$_} \|\|= [] for qw(selection option-popup selection-popup searchable-scrollback readline);	724
		725	$ext_arg{$_} = []
		726	for
		727	qw(selection option-popup selection-popup readline),
		728	map $_->[0], values %{ $TERM->{meta}{binding} };
		729
		730	for ($TERM->_keysym_resources) {
		731	next if /^(?:string\|command\|builtin\|builtin-string\|perl)/;
		732	next unless /^([A-Za-z0-9_\-]+):/;
		733
		734	my $ext = $1;
		735
		736	$ext_arg{$ext} = [];
		737	}
		738
721	} elsif (/^-(.*)$/) {	739	} elsif (/^-(.*)$/) {
722	delete $ext_arg{$1};	740	delete $ext_arg{$1};
		741
723	} elsif (/^([^<]+)<(.*)>$/) {	742	} elsif (/^([^<]+)<(.*)>$/) {
724	push @{ $ext_arg{$1} }, $2;	743	push @{ $ext_arg{$1} }, $2;
		744
725	} else {	745	} else {
726	$ext_arg{$_} \|\|= [];	746	$ext_arg{$_} \|\|= [];
		747	}
		748	}
		749
		750	# now register default key bindings
		751	for my $ext (sort keys %ext_arg) {
		752	while (my ($k, $v) = each %{ $TERM->{meta}{ext}{$ext}{binding} }) {
		753	$TERM->bind_action ($k, "$v->[0]:$v->[1]");
727	}	754	}
728	}	755	}
729		756
730	for my $ext (sort keys %ext_arg) {	757	for my $ext (sort keys %ext_arg) {
731	my @files = grep -f $_, map "$_/$ext", @dirs;	758	my @files = grep -f $_, map "$_/$ext", @dirs;
…		…
745		772
746	if (my $cb = $TERM->{_hook}[$htype]) {	773	if (my $cb = $TERM->{_hook}[$htype]) {
747	verbose 10, "$HOOKNAME[$htype] (" . (join ", ", $TERM, @_) . ")"	774	verbose 10, "$HOOKNAME[$htype] (" . (join ", ", $TERM, @_) . ")"
748	if $verbosity >= 10;	775	if $verbosity >= 10;
749		776
		777	if ($htype == HOOK_ACTION) {
		778	# this hook is only sent to the extension with the name
		779	# matching the first arg
		780	my $pkg = shift;
		781	$pkg =~ y/-/_/;
		782	$pkg = "urxvt::ext::$pkg";
		783
		784	$cb = $cb->{$pkg}
		785	or return undef; #TODO: maybe warn user?
		786
		787	$cb = { $pkg => $cb };
		788	}
		789
750	for my $pkg (keys %$cb) {	790	for my $pkg (keys %$cb) {
751	my $retval_ = eval { $cb->{$pkg}->($TERM->{_pkg}{$pkg} \|\| $TERM, @_) };	791	my $retval_ = eval { $cb->{$pkg}->($TERM->{_pkg}{$pkg} \|\| $TERM, @_) };
752	$retval \|\|= $retval_;	792	$retval \|\|= $retval_;
753		793
754	if ($@) {	794	if ($@) {
…		…
759		799
760	verbose 11, "$HOOKNAME[$htype] returning <$retval>"	800	verbose 11, "$HOOKNAME[$htype] returning <$retval>"
761	if $verbosity >= 11;	801	if $verbosity >= 11;
762	}	802	}
763		803
764	if ($htype == 1) { # DESTROY	804	if ($htype == HOOK_DESTROY) {
765	# clear package objects	805	# clear package objects
766	%$_ = () for values %{ $TERM->{_pkg} };	806	%$_ = () for values %{ $TERM->{_pkg} };
767		807
768	# clear package	808	# clear package
769	%$TERM = ();	809	%$TERM = ();
…		…
801	($mask, @color{qw(fg bg)}, \@failed)	841	($mask, @color{qw(fg bg)}, \@failed)
802	}	842	}
803		843
804	package urxvt::term::extension;	844	package urxvt::term::extension;
805		845
806	sub enable {	846	=head2 The C<urxvt::term::extension> class
807	my ($self, %hook) = @_;
808	my $pkg = $self->{_pkg};
809		847
810	while (my ($name, $cb) = each %hook) {	848	Each extension attached to a terminal object is represented by
811	my $htype = $HOOKTYPE{uc $name};	849	a C<urxvt::term::extension> object.
812	defined $htype
813	or Carp::croak "unsupported hook type '$name'";
814		850
815	$self->set_should_invoke ($htype, +1)	851	You can use these objects, which are passed to all callbacks to store any
816	unless exists $self->{term}{_hook}[$htype]{$pkg};	852	state related to the terminal and extension instance.
817		853
818	$self->{term}{_hook}[$htype]{$pkg} = $cb;	854	The methods (And data members) documented below can be called on extension
819	}	855	objects, in addition to call methods documented for the <urxvt::term>
820	}	856	class.
821		857
822	sub disable {	858	=over 4
823	my ($self, @hook) = @_;
824	my $pkg = $self->{_pkg};
825		859
826	for my $name (@hook) {	860	=item $urxvt_term = $self->{term}
827	my $htype = $HOOKTYPE{uc $name};
828	defined $htype
829	or Carp::croak "unsupported hook type '$name'";
830		861
831	$self->set_should_invoke ($htype, -1)	862	Returns the C<urxvt::term> object associated with this instance of the
832	if delete $self->{term}{_hook}[$htype]{$pkg};	863	extension. This member I<must not> be changed in any way.
833	}	864
834	}	865	=cut
835		866
836	our $AUTOLOAD;	867	our $AUTOLOAD;
837		868
838	sub AUTOLOAD {	869	sub AUTOLOAD {
839	$AUTOLOAD =~ /:([^:]+)$/	870	$AUTOLOAD =~ /:([^:]+)$/
…		…
852		883
853	sub DESTROY {	884	sub DESTROY {
854	# nop	885	# nop
855	}	886	}
856		887
857	# urxvt::destroy_hook	888	# urxvt::destroy_hook (basically a cheap Guard:: implementation)
858		889
859	sub urxvt::destroy_hook::DESTROY {	890	sub urxvt::destroy_hook::DESTROY {
860	${$_[0]}->();	891	${$_[0]}->();
861	}	892	}
862		893
863	sub urxvt::destroy_hook(&) {	894	sub urxvt::destroy_hook(&) {
864	bless \shift, urxvt::destroy_hook::	895	bless \shift, urxvt::destroy_hook::
865	}	896	}
		897
		898	=item $self->enable ($hook_name => $cb[, $hook_name => $cb..])
		899
		900	Dynamically enable the given hooks (named without the C<on_> prefix) for
		901	this extension, replacing any hook previously installed via C<enable> in
		902	this extension.
		903
		904	This is useful when you want to overwrite time-critical hooks only
		905	temporarily.
		906
		907	To install additional callbacks for the same hook, you can use the C<on>
		908	method of the C<urxvt::term> class.
		909
		910	=item $self->disable ($hook_name[, $hook_name..])
		911
		912	Dynamically disable the given hooks.
		913
		914	=cut
		915
		916	sub enable {
		917	my ($self, %hook) = @_;
		918	my $pkg = $self->{_pkg};
		919
		920	while (my ($name, $cb) = each %hook) {
		921	my $htype = $HOOKTYPE{uc $name};
		922	defined $htype
		923	or Carp::croak "unsupported hook type '$name'";
		924
		925	$self->set_should_invoke ($htype, +1)
		926	unless exists $self->{term}{_hook}[$htype]{$pkg};
		927
		928	$self->{term}{_hook}[$htype]{$pkg} = $cb;
		929	}
		930	}
		931
		932	sub disable {
		933	my ($self, @hook) = @_;
		934	my $pkg = $self->{_pkg};
		935
		936	for my $name (@hook) {
		937	my $htype = $HOOKTYPE{uc $name};
		938	defined $htype
		939	or Carp::croak "unsupported hook type '$name'";
		940
		941	$self->set_should_invoke ($htype, -1)
		942	if delete $self->{term}{_hook}[$htype]{$pkg};
		943	}
		944	}
		945
		946	=item $guard = $self->on ($hook_name => $cb[, $hook_name => $cb..])
		947
		948	Similar to the C<enable> enable, but installs additional callbacks for
		949	the given hook(s) (that is, it doesn't replace existing callbacks), and
		950	returns a guard object. When the guard object is destroyed the callbacks
		951	are disabled again.
		952
		953	=cut
		954
		955	sub urxvt::extension::on_disable::DESTROY {
		956	my $disable = shift;
		957
		958	my $term = delete $disable->{""};
		959
		960	while (my ($htype, $id) = each %$disable) {
		961	delete $term->{_hook}[$htype]{$id};
		962	$term->set_should_invoke ($htype, -1);
		963	}
		964	}
		965
		966	sub on {
		967	my ($self, %hook) = @_;
		968
		969	my $term = $self->{term};
		970
		971	my %disable = ( "" => $term );
		972
		973	while (my ($name, $cb) = each %hook) {
		974	my $htype = $HOOKTYPE{uc $name};
		975	defined $htype
		976	or Carp::croak "unsupported hook type '$name'";
		977
		978	$term->set_should_invoke ($htype, +1);
		979	$term->{_hook}[$htype]{ $disable{$htype} = $cb+0 }
		980	= sub { shift; $cb->($self, @_) }; # very ugly indeed
		981	}
		982
		983	bless \%disable, "urxvt::extension::on_disable"
		984	}
		985
		986	=item $self->x_resource ($pattern)
		987
		988	=item $self->x_resource_boolean ($pattern)
		989
		990	These methods support an additional C<%> prefix when called on an
		991	extension object - see the description of these methods in the
		992	C<urxvt::term> class for details.
		993
		994	=cut
866		995
867	sub x_resource {	996	sub x_resource {
868	my ($self, $name) = @_;	997	my ($self, $name) = @_;
869	$name =~ s/^%(\.\|$)/$_[0]{_name}$1/;	998	$name =~ s/^%(\.\|$)/$_[0]{_name}$1/;
870	$self->{term}->x_resource ($name)	999	$self->{term}->x_resource ($name)
…		…
873	sub x_resource_boolean {	1002	sub x_resource_boolean {
874	my ($self, $name) = @_;	1003	my ($self, $name) = @_;
875	$name =~ s/^%(\.\|$)/$_[0]{_name}$1/;	1004	$name =~ s/^%(\.\|$)/$_[0]{_name}$1/;
876	$self->{term}->x_resource_boolean ($name)	1005	$self->{term}->x_resource_boolean ($name)
877	}	1006	}
		1007
		1008	=back
		1009
		1010	=cut
878		1011
879	package urxvt::anyevent;	1012	package urxvt::anyevent;
880		1013
881	=head2 The C<urxvt::anyevent> Class	1014	=head2 The C<urxvt::anyevent> Class
882		1015
…		…
1001	$ENV{URXVT_PERL_LIB},	1134	$ENV{URXVT_PERL_LIB},
1002	"$ENV{HOME}/.urxvt/ext",	1135	"$ENV{HOME}/.urxvt/ext",
1003	"$LIBDIR/perl"	1136	"$LIBDIR/perl"
1004	}	1137	}
1005		1138
1006	sub scan_meta {	1139	# scan for available extensions and collect their metadata
		1140	sub scan_extensions {
1007	my ($self) = @_;	1141	my ($self) = @_;
		1142
		1143	return if exists $self->{meta};
		1144
1008	my @libdirs = perl_libdirs $self;	1145	my @libdirs = perl_libdirs $self;
1009		1146
1010	return if $self->{meta_libdirs} eq join "\x00", @libdirs;	1147	# return if $self->{meta_libdirs} eq join "\x00", @libdirs;#d#
1011		1148
1012	my %meta;
1013
1014	$self->{meta_libdirs} = join "\x00", @libdirs;	1149	# $self->{meta_libdirs} = join "\x00", @libdirs;#d#
1015	$self->{meta} = \%meta;	1150	$self->{meta} = \my %meta;
1016		1151
		1152	# first gather extensions
1017	for my $dir (reverse @libdirs) {	1153	for my $dir (reverse @libdirs) {
1018	opendir my $fh, $dir	1154	opendir my $fh, $dir
1019	or next;	1155	or next;
1020	for my $ext (readdir $fh) {	1156	for my $ext (readdir $fh) {
1021	$ext ne "."	1157	$ext !~ /^\./
1022	and $ext ne ".."
1023	and open my $fh, "<", "$dir/$ext"	1158	and open my $fh, "<", "$dir/$ext"
1024	or next;	1159	or next;
1025		1160
		1161	my %ext = (dir => $dir);
		1162
1026	while (<$fh>) {	1163	while (<$fh>) {
1027	if (/^#:META:X_RESOURCE:(.*)/) {	1164	if (/^#:META:(?:X_)?RESOURCE:(.*)/) {
1028	my ($pattern, $type, $desc) = split /:/, $1;	1165	my ($pattern, $type, $desc) = split /:/, $1;
1029	$pattern =~ s/^%(\.\|$)/$ext$1/g; # % in pattern == extension name	1166	$pattern =~ s/^%(\.\|$)/$ext$1/g; # % in pattern == extension name
1030	if ($pattern =~ /[^a-zA-Z0-9\-\.]/) {	1167	if ($pattern =~ /[^a-zA-Z0-9\-\.]/) {
1031	warn "$dir/$ext: meta resource '$pattern' contains illegal characters (not alphanumeric nor . nor *)\n";	1168	warn "$dir/$ext: meta resource '$pattern' contains illegal characters (not alphanumeric nor . nor *)\n";
1032	} else {	1169	} else {
1033	$meta{resource}{$pattern} = [$ext, $type, $desc];	1170	$ext{resource}{$pattern} = [$ext, $type, $desc];
1034	}	1171	}
		1172	} elsif (/^#:META:BINDING:(.*)/) {
		1173	my ($keysym, $action) = split /:/, $1;
		1174	$ext{binding}{$keysym} = [$ext, $action];
1035	} elsif (/^\s*(?:#\|$)/) {	1175	} elsif (/^\s*(?:#\|$)/) {
1036	# skip other comments and empty lines	1176	# skip other comments and empty lines
1037	} else {	1177	} else {
1038	last; # stop parsing on first non-empty non-comment line	1178	last; # stop parsing on first non-empty non-comment line
1039	}	1179	}
1040	}	1180	}
		1181
		1182	$meta{ext}{$ext} = \%ext;
1041	}	1183	}
		1184	}
		1185
		1186	# and now merge resources and bindings
		1187	while (my ($k, $v) = each %{ $meta{ext} }) {
		1188	#TODO: should check for extensions overriding each other
		1189	%{ $meta{resource} } = (%{ $meta{resource} }, %{ $v->{resource} });
		1190	%{ $meta{binding} } = (%{ $meta{binding} }, %{ $v->{binding} });
1042	}	1191	}
1043	}	1192	}
1044		1193
1045	=item $term = new urxvt::term $envhashref, $rxvtname, [arg...]	1194	=item $term = new urxvt::term $envhashref, $rxvtname, [arg...]
1046		1195
…		…
1066	}	1215	}
1067		1216
1068	=item $term->destroy	1217	=item $term->destroy
1069		1218
1070	Destroy the terminal object (close the window, free resources	1219	Destroy the terminal object (close the window, free resources
1071	etc.). Please note that @@RXVT_NAME@@ will not exit as long as any event	1220	etc.). Please note that urxvt will not exit as long as any event
1072	watchers (timers, io watchers) are still active.	1221	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		1222
1117	=item $term->exec_async ($cmd[, @args])	1223	=item $term->exec_async ($cmd[, @args])
1118		1224
1119	Works like the combination of the C<fork>/C<exec> builtins, which executes	1225	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	1226	("starts") programs in the background. This function takes care of setting
…		…
1205	Returns the X-Resource for the given pattern, excluding the program or	1311	Returns the X-Resource for the given pattern, excluding the program or
1206	class name, i.e. C<< $term->x_resource ("boldFont") >> should return the	1312	class name, i.e. C<< $term->x_resource ("boldFont") >> should return the
1207	same value as used by this instance of rxvt-unicode. Returns C<undef> if no	1313	same value as used by this instance of rxvt-unicode. Returns C<undef> if no
1208	resource with that pattern exists.	1314	resource with that pattern exists.
1209		1315
1210	Extensions that define extra resource or command line arguments also need	1316	Extensions that define extra resources also need to call this method
1211	to call this method to access their values.	1317	to access their values.
1212		1318
1213	If the method is called on an extension object (basically, from an	1319	If the method is called on an extension object (basically, from an
1214	extension), then the special prefix C<%.> will be replaced by the name of	1320	extension), then the special prefix C<%.> will be replaced by the name of
1215	the extension and a dot, and the lone string C<%> will be replaced by the	1321	the extension and a dot, and the lone string C<%> will be replaced by the
1216	extension name itself. This makes it possible to code extensions so you	1322	extension name itself. This makes it possible to code extensions so you
1217	can rename them and get a new set of commandline switches and resources	1323	can rename them and get a new set of resources without having to change
1218	without having to change the actual code.	1324	the actual code.
1219		1325
1220	This method should only be called during the C<on_start> hook, as there is	1326	This method should only be called during the C<on_start> hook, as there is
1221	only one resource database per display, and later invocations might return	1327	only one resource database per display, and later invocations might return
1222	the wrong resources.	1328	the wrong resources.
1223		1329
…		…
1235	my $res = &x_resource;	1341	my $res = &x_resource;
1236		1342
1237	$res =~ /^\s(?:true\|yes\|on\|1)\s$/i ? 1 : defined $res && 0	1343	$res =~ /^\s(?:true\|yes\|on\|1)\s$/i ? 1 : defined $res && 0
1238	}	1344	}
1239		1345
1240	=item $success = $term->parse_keysym ($key, $octets)	1346	=item $success = $term->bind_action ($key, $octets)
1241		1347
1242	Adds a key binding exactly as specified via a resource. See the	1348	Adds a key binding exactly as specified via a C<keysym> resource. See the
1243	C<keysym> resource in the @@RXVT_NAME@@(1) manpage.	1349	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		1350
1252	=item $rend = $term->rstyle ([$new_rstyle])	1351	=item $rend = $term->rstyle ([$new_rstyle])
1253		1352
1254	Return and optionally change the current rendition. Text that is output by	1353	Return and optionally change the current rendition. Text that is output by
1255	the terminal application will use this style.	1354	the terminal application will use this style.
…		…
1435	=item $term->tt_write ($octets)	1534	=item $term->tt_write ($octets)
1436		1535
1437	Write the octets given in C<$octets> to the tty (i.e. as program input). To	1536	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	1537	pass characters instead of octets, you should convert your strings first
1439	to the locale-specific encoding using C<< $term->locale_encode >>.	1538	to the locale-specific encoding using C<< $term->locale_encode >>.
		1539
		1540	=item $term->tt_write_user_input ($octets)
		1541
		1542	Like C<tt_write>, but should be used when writing strings in response to
		1543	the user pressing a key, to invoke the additional actions requested by
		1544	the user for that case (C<tt_write> doesn't do that).
		1545
		1546	The typical use case would be inside C<on_action> hooks.
1440		1547
1441	=item $term->tt_paste ($octets)	1548	=item $term->tt_paste ($octets)
1442		1549
1443	Write the octets given in C<$octets> to the tty as a paste, converting NL to	1550	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	1551	CR and bracketing the data with control sequences if bracketed paste mode
…		…
1678	}	1785	}
1679		1786
1680	sub urxvt::line::t {	1787	sub urxvt::line::t {
1681	my ($self) = @_;	1788	my ($self) = @_;
1682		1789
1683	if (@_ > 1)	1790	if (@_ > 1) {
1684	{
1685	$self->{term}->ROW_t ($_, $_[1], 0, ($_ - $self->{beg}) * $self->{ncol}, $self->{ncol})	1791	$self->{term}->ROW_t ($_, $_[1], 0, ($_ - $self->{beg}) * $self->{ncol}, $self->{ncol})
1686	for $self->{beg} .. $self->{end};	1792	for $self->{beg} .. $self->{end};
1687	}	1793	}
1688		1794
1689	defined wantarray &&	1795	defined wantarray &&
1690	substr +(join "", map $self->{term}->ROW_t ($_), $self->{beg} .. $self->{end}),	1796	substr +(join "", map $self->{term}->ROW_t ($_), $self->{beg} .. $self->{end}),
1691	0, $self->{len}	1797	0, $self->{len}
1692	}	1798	}
1693		1799
1694	sub urxvt::line::r {	1800	sub urxvt::line::r {
1695	my ($self) = @_;	1801	my ($self) = @_;
1696		1802
1697	if (@_ > 1)	1803	if (@_ > 1) {
1698	{
1699	$self->{term}->ROW_r ($_, $_[1], 0, ($_ - $self->{beg}) * $self->{ncol}, $self->{ncol})	1804	$self->{term}->ROW_r ($_, $_[1], 0, ($_ - $self->{beg}) * $self->{ncol}, $self->{ncol})
1700	for $self->{beg} .. $self->{end};	1805	for $self->{beg} .. $self->{end};
1701	}	1806	}
1702		1807
1703	if (defined wantarray) {	1808	if (defined wantarray) {
1704	my $rend = [	1809	my $rend = [
1705	map @{ $self->{term}->ROW_r ($_) }, $self->{beg} .. $self->{end}	1810	map @{ $self->{term}->ROW_r ($_) }, $self->{beg} .. $self->{end}
1706	];	1811	];

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.244 by sf-exg, Mon Oct 13 12:17:48 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.244 by sf-exg, Mon Oct 13 12:17:48 2014 UTC