[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.251 by root, Fri Dec 26 22:52:23 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 using so called META comments,
		51	described below. Similarly to builtin resources, extension resources
		52	can also be specified on the command line as long options (with C<.>
		53	replaced by C<->), in which case the corresponding extension is loaded
		54	automatically. For this to work the extension B<must> define META
		55	comments for its resources.
50		56
51	=head1 API DOCUMENTATION	57	=head1 API DOCUMENTATION
52		58
53	=head2 General API Considerations	59	=head2 General API Considerations
54		60
103	internal use.	109	internal use.
104		110
105	Although it isn't a C<urxvt::term> object, you can call all methods of the	111	Although it isn't a C<urxvt::term> object, you can call all methods of the
106	C<urxvt::term> class on this object.	112	C<urxvt::term> class on this object.
107		113
108	It has the following methods and data members:	114	Additional methods only supported for extension objects are described in
		115	the C<urxvt::extension> section below.
		116
		117	=head2 META comments
		118
		119	Rxvt-unicode recognizes special meta comments in extensions that define
		120	different types of metadata.
		121
		122	Currently, it recognises only one such comment:
109		123
110	=over 4	124	=over 4
111		125
112	=item $urxvt_term = $self->{term}	126	=item #:META:RESOURCE:name:type:desc
113		127
114	Returns the C<urxvt::term> object associated with this instance of the	128	The RESOURCE comment defines a resource used by the extension, where
115	extension. This member I<must not> be changed in any way.	129	C<name> is the resource name, C<type> is the resource type, C<boolean>
116		130	or C<string>, and C<desc> is the resource description.
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		131
138	=back	132	=back
139		133
140	=head2 Hooks	134	=head2 Hooks
141		135
…		…
310		304
311	=item on_refresh_end $term	305	=item on_refresh_end $term
312		306
313	Called just after the screen gets redrawn. See C<on_refresh_begin>.	307	Called just after the screen gets redrawn. See C<on_refresh_begin>.
314		308
		309	=item on_action $term, $string
		310
		311	Called whenever an action is invoked for the corresponding extension
		312	(e.g. via a C<extension:string> builtin action bound to a key, see
		313	description of the B<keysym> resource in the urxvt(1) manpage). The
		314	event is simply the action string. Note that an action event is always
		315	associated to a single extension.
		316
315	=item on_user_command $term, $string	317	=item on_user_command $term, $string DEPRECATED
316		318
317	Called whenever a user-configured event is being activated (e.g. via	319	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>	320	a C<perl:string> action bound to a key, see description of the B<keysym>
319	resource in the @@RXVT_NAME@@(1) manpage).	321	resource in the urxvt(1) manpage).
320		322
321	The event is simply the action string. This interface is assumed to change	323	The event is simply the action string. This interface is going away in
322	slightly in the future.	324	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		325
331	=item on_resize_all_windows $term, $new_width, $new_height	326	=item on_resize_all_windows $term, $new_width, $new_height
332		327
333	Called just after the new window size has been calculated, but before	328	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	329	windows are actually being resized or hints are being set. If this hook
335	returns TRUE, setting of the window hints is being skipped.	330	returns a true value, setting of the window hints is being skipped.
336		331
337	=item on_x_event $term, $event	332	=item on_x_event $term, $event
338		333
339	Called on every X event received on the vt window (and possibly other	334	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	335	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	374	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.	375	(real, not screen-based) row and column under the mouse cursor.
381		376
382	C<on_key_press> additionally receives the string rxvt-unicode would	377	C<on_key_press> additionally receives the string rxvt-unicode would
383	output, if any, in locale-specific encoding.	378	output, if any, in locale-specific encoding.
384
385	subwindow.
386		379
387	=item on_client_message $term, $event	380	=item on_client_message $term, $event
388		381
389	=item on_wm_protocols $term, $event	382	=item on_wm_protocols $term, $event
390		383
…		…
593	no warnings 'utf8';	586	no warnings 'utf8';
594		587
595	sub parse_resource {	588	sub parse_resource {
596	my ($term, $name, $isarg, $longopt, $flag, $value) = @_;	589	my ($term, $name, $isarg, $longopt, $flag, $value) = @_;
597		590
598	$name =~ y/-/./ if $isarg;
599
600	$term->scan_meta;	591	$term->scan_extensions;
601		592
602	my $r = $term->{meta}{resource};	593	my $r = $term->{meta}{resource};
603	keys %$r; # reste iterator	594	keys %$r; # reset iterator
604	while (my ($pattern, $v) = each %$r) {	595	while (my ($k, $v) = each %$r) {
605	if (	596	my $pattern = $k;
		597	$pattern =~ y/./-/ if $isarg;
		598	my $prefix = $name;
		599	my $suffix;
606	$pattern =~ /\.$/	600	if ($pattern =~ /\-$/) {
607	? $pattern eq substr $name, 0, length $pattern	601	$prefix = substr $name, 0, length $pattern;
608	: $pattern eq $name	602	$suffix = substr $name, length $pattern;
609	) {	603	}
		604	if ($pattern eq $prefix) {
610	$name = "$urxvt::RESCLASS.$name";	605	$name = "$urxvt::RESCLASS.$k$suffix";
611		606
612	push @{ $term->{perl_ext_3} }, $v->[0];	607	push @{ $term->{perl_ext_3} }, $v->[0];
613		608
614	if ($v->[1] eq "boolean") {	609	if ($v->[1] eq "boolean") {
615	$term->put_option_db ($name, $flag ? "true" : "false");	610	$term->put_option_db ($name, $flag ? "true" : "false");
…		…
625	}	620	}
626		621
627	sub usage {	622	sub usage {
628	my ($term, $usage_type) = @_;	623	my ($term, $usage_type) = @_;
629		624
630	$term->scan_meta;	625	$term->scan_extensions;
631		626
632	my $r = $term->{meta}{resource};	627	my $r = $term->{meta}{resource};
633		628
634	for my $pattern (sort keys %$r) {	629	for my $pattern (sort keys %$r) {
635	my ($ext, $type, $desc) = @{ $r->{$pattern} };	630	my ($ext, $type, $desc) = @{ $r->{$pattern} };
…		…
696	# called by the rxvt core	691	# called by the rxvt core
697	sub invoke {	692	sub invoke {
698	local $TERM = shift;	693	local $TERM = shift;
699	my $htype = shift;	694	my $htype = shift;
700		695
701	if ($htype == 0) { # INIT	696	if ($htype == HOOK_INIT) {
702	my @dirs = $TERM->perl_libdirs;	697	my @dirs = $TERM->perl_libdirs;
		698
		699	$TERM->scan_extensions;
703		700
704	my %ext_arg;	701	my %ext_arg;
705		702
706	{	703	{
707	my @init = @TERM_INIT;	704	my @init = @TERM_INIT;
…		…
711	@TERM_EXT = ();	708	@TERM_EXT = ();
712	$TERM->register_package ($_) for @pkg;	709	$TERM->register_package ($_) for @pkg;
713	}	710	}
714		711
715	for (	712	for (
		713	(grep $_, map { split /,/, $TERM->resource ("perl_ext_$_") } 1, 2),
716	@{ delete $TERM->{perl_ext_3} },	714	@{ delete $TERM->{perl_ext_3} }
717	grep $_, map { split /,/, $TERM->resource ("perl_ext_$_") } 1, 2
718	) {	715	) {
719	if ($_ eq "default") {	716	if ($_ eq "default") {
		717
		718	$ext_arg{$_} = []
720	$ext_arg{$_} \|\|= [] for qw(selection option-popup selection-popup searchable-scrollback readline);	719	for qw(selection option-popup selection-popup readline searchable-scrollback);
		720
		721	for ($TERM->_keysym_resources) {
		722	next if /^(?:string\|command\|builtin\|builtin-string\|perl)/;
		723	next unless /^([A-Za-z0-9_\-]+):/;
		724
		725	my $ext = $1;
		726
		727	$ext_arg{$ext} = [];
		728	}
		729
721	} elsif (/^-(.*)$/) {	730	} elsif (/^-(.*)$/) {
722	delete $ext_arg{$1};	731	delete $ext_arg{$1};
		732
723	} elsif (/^([^<]+)<(.*)>$/) {	733	} elsif (/^([^<]+)<(.*)>$/) {
724	push @{ $ext_arg{$1} }, $2;	734	push @{ $ext_arg{$1} }, $2;
		735
725	} else {	736	} else {
726	$ext_arg{$_} \|\|= [];	737	$ext_arg{$_} \|\|= [];
727	}	738	}
728	}	739	}
729		740
…		…
745		756
746	if (my $cb = $TERM->{_hook}[$htype]) {	757	if (my $cb = $TERM->{_hook}[$htype]) {
747	verbose 10, "$HOOKNAME[$htype] (" . (join ", ", $TERM, @_) . ")"	758	verbose 10, "$HOOKNAME[$htype] (" . (join ", ", $TERM, @_) . ")"
748	if $verbosity >= 10;	759	if $verbosity >= 10;
749		760
		761	if ($htype == HOOK_ACTION) {
		762	# this hook is only sent to the extension with the name
		763	# matching the first arg
		764	my $pkg = shift;
		765	$pkg =~ y/-/_/;
		766	$pkg = "urxvt::ext::$pkg";
		767
		768	$cb = $cb->{$pkg}
		769	or return undef; #TODO: maybe warn user?
		770
		771	$cb = { $pkg => $cb };
		772	}
		773
750	for my $pkg (keys %$cb) {	774	for my $pkg (keys %$cb) {
751	my $retval_ = eval { $cb->{$pkg}->($TERM->{_pkg}{$pkg} \|\| $TERM, @_) };	775	my $retval_ = eval { $cb->{$pkg}->($TERM->{_pkg}{$pkg} \|\| $TERM, @_) };
752	$retval \|\|= $retval_;	776	$retval \|\|= $retval_;
753		777
754	if ($@) {	778	if ($@) {
…		…
759		783
760	verbose 11, "$HOOKNAME[$htype] returning <$retval>"	784	verbose 11, "$HOOKNAME[$htype] returning <$retval>"
761	if $verbosity >= 11;	785	if $verbosity >= 11;
762	}	786	}
763		787
764	if ($htype == 1) { # DESTROY	788	if ($htype == HOOK_DESTROY) {
765	# clear package objects	789	# clear package objects
766	%$_ = () for values %{ $TERM->{_pkg} };	790	%$_ = () for values %{ $TERM->{_pkg} };
767		791
768	# clear package	792	# clear package
769	%$TERM = ();	793	%$TERM = ();
…		…
801	($mask, @color{qw(fg bg)}, \@failed)	825	($mask, @color{qw(fg bg)}, \@failed)
802	}	826	}
803		827
804	package urxvt::term::extension;	828	package urxvt::term::extension;
805		829
806	sub enable {	830	=head2 The C<urxvt::term::extension> class
807	my ($self, %hook) = @_;
808	my $pkg = $self->{_pkg};
809		831
810	while (my ($name, $cb) = each %hook) {	832	Each extension attached to a terminal object is represented by
811	my $htype = $HOOKTYPE{uc $name};	833	a C<urxvt::term::extension> object.
812	defined $htype
813	or Carp::croak "unsupported hook type '$name'";
814		834
815	$self->set_should_invoke ($htype, +1)	835	You can use these objects, which are passed to all callbacks to store any
816	unless exists $self->{term}{_hook}[$htype]{$pkg};	836	state related to the terminal and extension instance.
817		837
818	$self->{term}{_hook}[$htype]{$pkg} = $cb;	838	The methods (And data members) documented below can be called on extension
819	}	839	objects, in addition to call methods documented for the <urxvt::term>
820	}	840	class.
821		841
822	sub disable {	842	=over 4
823	my ($self, @hook) = @_;
824	my $pkg = $self->{_pkg};
825		843
826	for my $name (@hook) {	844	=item $urxvt_term = $self->{term}
827	my $htype = $HOOKTYPE{uc $name};
828	defined $htype
829	or Carp::croak "unsupported hook type '$name'";
830		845
831	$self->set_should_invoke ($htype, -1)	846	Returns the C<urxvt::term> object associated with this instance of the
832	if delete $self->{term}{_hook}[$htype]{$pkg};	847	extension. This member I<must not> be changed in any way.
833	}	848
834	}	849	=cut
835		850
836	our $AUTOLOAD;	851	our $AUTOLOAD;
837		852
838	sub AUTOLOAD {	853	sub AUTOLOAD {
839	$AUTOLOAD =~ /:([^:]+)$/	854	$AUTOLOAD =~ /:([^:]+)$/
…		…
852		867
853	sub DESTROY {	868	sub DESTROY {
854	# nop	869	# nop
855	}	870	}
856		871
857	# urxvt::destroy_hook	872	# urxvt::destroy_hook (basically a cheap Guard:: implementation)
858		873
859	sub urxvt::destroy_hook::DESTROY {	874	sub urxvt::destroy_hook::DESTROY {
860	${$_[0]}->();	875	${$_[0]}->();
861	}	876	}
862		877
863	sub urxvt::destroy_hook(&) {	878	sub urxvt::destroy_hook(&) {
864	bless \shift, urxvt::destroy_hook::	879	bless \shift, urxvt::destroy_hook::
		880	}
		881
		882	=item $self->enable ($hook_name => $cb[, $hook_name => $cb..])
		883
		884	Dynamically enable the given hooks (named without the C<on_> prefix) for
		885	this extension, replacing any hook previously installed via C<enable> in
		886	this extension.
		887
		888	This is useful when you want to overwrite time-critical hooks only
		889	temporarily.
		890
		891	To install additional callbacks for the same hook, you can use the C<on>
		892	method of the C<urxvt::term> class.
		893
		894	=item $self->disable ($hook_name[, $hook_name..])
		895
		896	Dynamically disable the given hooks.
		897
		898	=cut
		899
		900	sub enable {
		901	my ($self, %hook) = @_;
		902	my $pkg = $self->{_pkg};
		903
		904	while (my ($name, $cb) = each %hook) {
		905	my $htype = $HOOKTYPE{uc $name};
		906	defined $htype
		907	or Carp::croak "unsupported hook type '$name'";
		908
		909	$self->set_should_invoke ($htype, +1)
		910	unless exists $self->{term}{_hook}[$htype]{$pkg};
		911
		912	$self->{term}{_hook}[$htype]{$pkg} = $cb;
		913	}
		914	}
		915
		916	sub disable {
		917	my ($self, @hook) = @_;
		918	my $pkg = $self->{_pkg};
		919
		920	for my $name (@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	if delete $self->{term}{_hook}[$htype]{$pkg};
		927	}
		928	}
		929
		930	=item $guard = $self->on ($hook_name => $cb[, $hook_name => $cb..])
		931
		932	Similar to the C<enable> enable, but installs additional callbacks for
		933	the given hook(s) (that is, it doesn't replace existing callbacks), and
		934	returns a guard object. When the guard object is destroyed the callbacks
		935	are disabled again.
		936
		937	=cut
		938
		939	sub urxvt::extension::on_disable::DESTROY {
		940	my $disable = shift;
		941
		942	my $term = delete $disable->{""};
		943
		944	while (my ($htype, $id) = each %$disable) {
		945	delete $term->{_hook}[$htype]{$id};
		946	$term->set_should_invoke ($htype, -1);
		947	}
		948	}
		949
		950	sub on {
		951	my ($self, %hook) = @_;
		952
		953	my $term = $self->{term};
		954
		955	my %disable = ( "" => $term );
		956
		957	while (my ($name, $cb) = each %hook) {
		958	my $htype = $HOOKTYPE{uc $name};
		959	defined $htype
		960	or Carp::croak "unsupported hook type '$name'";
		961
		962	$term->set_should_invoke ($htype, +1);
		963	$term->{_hook}[$htype]{ $disable{$htype} = $cb+0 }
		964	= sub { shift; $cb->($self, @_) }; # very ugly indeed
		965	}
		966
		967	bless \%disable, "urxvt::extension::on_disable"
		968	}
		969
		970	=item $self->bind_action ($hotkey, $action)
		971
		972	=item $self->x_resource ($pattern)
		973
		974	=item $self->x_resource_boolean ($pattern)
		975
		976	These methods support an additional C<%> prefix for C<$action> or
		977	C<$pattern> when called on an extension object, compared to the
		978	C<urxvt::term> methods of the same name - see the description of these
		979	methods in the C<urxvt::term> class for details.
		980
		981	=cut
		982
		983	sub bind_action {
		984	my ($self, $hotkey, $action) = @_;
		985	$action =~ s/^%:/$_[0]{_name}:/;
		986	$self->{term}->bind_action ($hotkey, $action)
865	}	987	}
866		988
867	sub x_resource {	989	sub x_resource {
868	my ($self, $name) = @_;	990	my ($self, $name) = @_;
869	$name =~ s/^%(\.\|$)/$_[0]{_name}$1/;	991	$name =~ s/^%(\.\|$)/$_[0]{_name}$1/;
…		…
873	sub x_resource_boolean {	995	sub x_resource_boolean {
874	my ($self, $name) = @_;	996	my ($self, $name) = @_;
875	$name =~ s/^%(\.\|$)/$_[0]{_name}$1/;	997	$name =~ s/^%(\.\|$)/$_[0]{_name}$1/;
876	$self->{term}->x_resource_boolean ($name)	998	$self->{term}->x_resource_boolean ($name)
877	}	999	}
		1000
		1001	=back
		1002
		1003	=cut
878		1004
879	package urxvt::anyevent;	1005	package urxvt::anyevent;
880		1006
881	=head2 The C<urxvt::anyevent> Class	1007	=head2 The C<urxvt::anyevent> Class
882		1008
…		…
1001	$ENV{URXVT_PERL_LIB},	1127	$ENV{URXVT_PERL_LIB},
1002	"$ENV{HOME}/.urxvt/ext",	1128	"$ENV{HOME}/.urxvt/ext",
1003	"$LIBDIR/perl"	1129	"$LIBDIR/perl"
1004	}	1130	}
1005		1131
1006	sub scan_meta {	1132	# scan for available extensions and collect their metadata
		1133	sub scan_extensions {
1007	my ($self) = @_;	1134	my ($self) = @_;
		1135
		1136	return if exists $self->{meta};
		1137
1008	my @libdirs = perl_libdirs $self;	1138	my @urxvtdirs = perl_libdirs $self;
		1139	my @cpandirs = grep -d, map "$_/URxvt/Ext", @INC;
1009		1140
1010	return if $self->{meta_libdirs} eq join "\x00", @libdirs;
1011
1012	my %meta;
1013
1014	$self->{meta_libdirs} = join "\x00", @libdirs;
1015	$self->{meta} = \%meta;	1141	$self->{meta} = \my %meta;
1016		1142
1017	for my $dir (reverse @libdirs) {	1143	# first gather extensions
		1144
		1145	my $gather = sub {
		1146	my ($dir, $core) = @_;
		1147
1018	opendir my $fh, $dir	1148	opendir my $fh, $dir
1019	or next;	1149	or return;
		1150
1020	for my $ext (readdir $fh) {	1151	for my $ext (readdir $fh) {
1021	$ext ne "."	1152	$ext !~ /^\./
1022	and $ext ne ".."
1023	and open my $fh, "<", "$dir/$ext"
1024	or next;	1153	or next;
1025		1154
		1155	open my $fh, "<", "$dir/$ext"
		1156	or next;
		1157
		1158	-f $fh
		1159	or next;
		1160
		1161	$ext =~ s/\.uext$// or $core
		1162	or next;
		1163
		1164	my %ext = (dir => $dir);
		1165
1026	while (<$fh>) {	1166	while (<$fh>) {
1027	if (/^#:META:X_RESOURCE:(.*)/) {	1167	if (/^#:META:(?:X_)?RESOURCE:(.*)/) {
1028	my ($pattern, $type, $desc) = split /:/, $1;	1168	my ($pattern, $type, $desc) = split /:/, $1;
1029	$pattern =~ s/^%(\.\|$)/$ext$1/g; # % in pattern == extension name	1169	$pattern =~ s/^%(\.\|$)/$ext$1/g; # % in pattern == extension name
1030	if ($pattern =~ /[^a-zA-Z0-9\-\.]/) {	1170	if ($pattern =~ /[^a-zA-Z0-9\-\.]/) {
1031	warn "$dir/$ext: meta resource '$pattern' contains illegal characters (not alphanumeric nor . nor *)\n";	1171	warn "$dir/$ext: meta resource '$pattern' contains illegal characters (not alphanumeric nor . nor *)\n";
1032	} else {	1172	} else {
1033	$meta{resource}{$pattern} = [$ext, $type, $desc];	1173	$ext{resource}{$pattern} = [$ext, $type, $desc];
1034	}	1174	}
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	$gather->($_, 0) for @cpandirs;
		1187	$gather->($_, 1) for @urxvtdirs;
		1188
		1189	# and now merge resources
		1190
		1191	$meta{resource} = \my %resource;
		1192
		1193	while (my ($k, $v) = each %{ $meta{ext} }) {
		1194	#TODO: should check for extensions overriding each other
		1195	%resource = (%resource, %{ $v->{resource} });
1042	}	1196	}
1043	}	1197	}
1044		1198
1045	=item $term = new urxvt::term $envhashref, $rxvtname, [arg...]	1199	=item $term = new urxvt::term $envhashref, $rxvtname, [arg...]
1046		1200
…		…
1066	}	1220	}
1067		1221
1068	=item $term->destroy	1222	=item $term->destroy
1069		1223
1070	Destroy the terminal object (close the window, free resources	1224	Destroy the terminal object (close the window, free resources
1071	etc.). Please note that @@RXVT_NAME@@ will not exit as long as any event	1225	etc.). Please note that urxvt will not exit as long as any event
1072	watchers (timers, io watchers) are still active.	1226	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		1227
1117	=item $term->exec_async ($cmd[, @args])	1228	=item $term->exec_async ($cmd[, @args])
1118		1229
1119	Works like the combination of the C<fork>/C<exec> builtins, which executes	1230	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	1231	("starts") programs in the background. This function takes care of setting
…		…
1205	Returns the X-Resource for the given pattern, excluding the program or	1316	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	1317	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	1318	same value as used by this instance of rxvt-unicode. Returns C<undef> if no
1208	resource with that pattern exists.	1319	resource with that pattern exists.
1209		1320
1210	Extensions that define extra resource or command line arguments also need	1321	Extensions that define extra resources also need to call this method
1211	to call this method to access their values.	1322	to access their values.
1212		1323
1213	If the method is called on an extension object (basically, from an	1324	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	1325	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	1326	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	1327	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	1328	can rename them and get a new set of resources without having to change
1218	without having to change the actual code.	1329	the actual code.
1219		1330
1220	This method should only be called during the C<on_start> hook, as there is	1331	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	1332	only one resource database per display, and later invocations might return
1222	the wrong resources.	1333	the wrong resources.
1223		1334
…		…
1235	my $res = &x_resource;	1346	my $res = &x_resource;
1236		1347
1237	$res =~ /^\s(?:true\|yes\|on\|1)\s$/i ? 1 : defined $res && 0	1348	$res =~ /^\s(?:true\|yes\|on\|1)\s$/i ? 1 : defined $res && 0
1238	}	1349	}
1239		1350
1240	=item $success = $term->parse_keysym ($key, $octets)	1351	=item $success = $term->bind_action ($key, $action)
1241		1352
1242	Adds a key binding exactly as specified via a resource. See the	1353	Adds a key binding exactly as specified via a C<keysym> resource. See the
1243	C<keysym> resource in the @@RXVT_NAME@@(1) manpage.	1354	C<keysym> resource in the urxvt(1) manpage.
1244		1355
1245	=item $term->register_command ($keysym, $modifiermask, $string)	1356	To add default bindings for actions, an extension should call C<<
		1357	->bind_action >> in its C<init> hook for every such binding. Doing it
		1358	in the C<init> hook allows users to override or remove the binding
		1359	again.
1246		1360
1247	Adds a key binding. This is a lower level api compared to	1361	Example: the C<searchable-scrollback> by default binds itself
1248	C<parse_keysym>, as it expects a parsed key description, and can be	1362	on C<Meta-s>, using C<< $self->bind_action >>, which calls C<<
1249	used only inside either the C<on_init> hook, to add a binding, or the	1363	$term->bind_action >>.
1250	C<on_register_command> hook, to modify a parsed binding.	1364
		1365	sub init {
		1366	my ($self) = @_;
		1367
		1368	$self->bind_action ("M-s" => "%:start");
		1369	}
1251		1370
1252	=item $rend = $term->rstyle ([$new_rstyle])	1371	=item $rend = $term->rstyle ([$new_rstyle])
1253		1372
1254	Return and optionally change the current rendition. Text that is output by	1373	Return and optionally change the current rendition. Text that is output by
1255	the terminal application will use this style.	1374	the terminal application will use this style.
…		…
1413		1532
1414	=item $term->scr_add_lines ($string)	1533	=item $term->scr_add_lines ($string)
1415		1534
1416	Write the given text string to the screen, as if output by the application	1535	Write the given text string to the screen, as if output by the application
1417	running inside the terminal. It may not contain command sequences (escape	1536	running inside the terminal. It may not contain command sequences (escape
1418	codes), but is free to use line feeds, carriage returns and tabs. The	1537	codes - see C<cmd_parse> for that), but is free to use line feeds,
1419	string is a normal text string, not in locale-dependent encoding.	1538	carriage returns and tabs. The string is a normal text string, not in
		1539	locale-dependent encoding.
1420		1540
1421	Normally its not a good idea to use this function, as programs might be	1541	Normally its not a good idea to use this function, as programs might be
1422	confused by changes in cursor position or scrolling. Its useful inside a	1542	confused by changes in cursor position or scrolling. Its useful inside a
1423	C<on_add_lines> hook, though.	1543	C<on_add_lines> hook, though.
1424		1544
…		…
1432	locale-specific encoding of the terminal and can contain command sequences	1552	locale-specific encoding of the terminal and can contain command sequences
1433	(escape codes) that will be interpreted.	1553	(escape codes) that will be interpreted.
1434		1554
1435	=item $term->tt_write ($octets)	1555	=item $term->tt_write ($octets)
1436		1556
1437	Write the octets given in C<$octets> to the tty (i.e. as program input). To	1557	Write the octets given in C<$octets> to the tty (i.e. as user input
		1558	to the program, see C<cmd_parse> for the opposite direction). To pass
1438	pass characters instead of octets, you should convert your strings first	1559	characters instead of octets, you should convert your strings first to the
1439	to the locale-specific encoding using C<< $term->locale_encode >>.	1560	locale-specific encoding using C<< $term->locale_encode >>.
		1561
		1562	=item $term->tt_write_user_input ($octets)
		1563
		1564	Like C<tt_write>, but should be used when writing strings in response to
		1565	the user pressing a key, to invoke the additional actions requested by
		1566	the user for that case (C<tt_write> doesn't do that).
		1567
		1568	The typical use case would be inside C<on_action> hooks.
1440		1569
1441	=item $term->tt_paste ($octets)	1570	=item $term->tt_paste ($octets)
1442		1571
1443	Write the octets given in C<$octets> to the tty as a paste, converting NL to	1572	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	1573	CR and bracketing the data with control sequences if bracketed paste mode
…		…
1678	}	1807	}
1679		1808
1680	sub urxvt::line::t {	1809	sub urxvt::line::t {
1681	my ($self) = @_;	1810	my ($self) = @_;
1682		1811
1683	if (@_ > 1)	1812	if (@_ > 1) {
1684	{
1685	$self->{term}->ROW_t ($_, $_[1], 0, ($_ - $self->{beg}) * $self->{ncol}, $self->{ncol})	1813	$self->{term}->ROW_t ($_, $_[1], 0, ($_ - $self->{beg}) * $self->{ncol}, $self->{ncol})
1686	for $self->{beg} .. $self->{end};	1814	for $self->{beg} .. $self->{end};
1687	}	1815	}
1688		1816
1689	defined wantarray &&	1817	defined wantarray &&
1690	substr +(join "", map $self->{term}->ROW_t ($_), $self->{beg} .. $self->{end}),	1818	substr +(join "", map $self->{term}->ROW_t ($_), $self->{beg} .. $self->{end}),
1691	0, $self->{len}	1819	0, $self->{len}
1692	}	1820	}
1693		1821
1694	sub urxvt::line::r {	1822	sub urxvt::line::r {
1695	my ($self) = @_;	1823	my ($self) = @_;
1696		1824
1697	if (@_ > 1)	1825	if (@_ > 1) {
1698	{
1699	$self->{term}->ROW_r ($_, $_[1], 0, ($_ - $self->{beg}) * $self->{ncol}, $self->{ncol})	1826	$self->{term}->ROW_r ($_, $_[1], 0, ($_ - $self->{beg}) * $self->{ncol}, $self->{ncol})
1700	for $self->{beg} .. $self->{end};	1827	for $self->{beg} .. $self->{end};
1701	}	1828	}
1702		1829
1703	if (defined wantarray) {	1830	if (defined wantarray) {
1704	my $rend = [	1831	my $rend = [
1705	map @{ $self->{term}->ROW_r ($_) }, $self->{beg} .. $self->{end}	1832	map @{ $self->{term}->ROW_r ($_) }, $self->{beg} .. $self->{end}
1706	];	1833	];

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.251 by root, Fri Dec 26 22:52:23 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.251 by root, Fri Dec 26 22:52:23 2014 UTC