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

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.247 by root, Fri Dec 26 19:19:30 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.247 by root, Fri Dec 26 19:19:30 2014 UTC