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

Comparing rxvt-unicode/src/urxvt.pm (file contents):
Revision 1.218 by root, Sun Jun 10 17:31:53 2012 UTC vs.
Revision 1.255 by root, Wed Jun 17 11:59:37 2015 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 vewiwed	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	laoded 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	=item $self->disable ($hook_name[, $hook_name..])
124
125	Dynamically disable the given hooks.
126		131
127	=back	132	=back
128		133
129	=head2 Hooks	134	=head2 Hooks
130		135
…		…
299		304
300	=item on_refresh_end $term	305	=item on_refresh_end $term
301		306
302	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>.
303		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
304	=item on_user_command $term, $string	317	=item on_user_command $term, $string DEPRECATED
305		318
306	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
307	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>
308	resource in the @@RXVT_NAME@@(1) manpage).	321	resource in the urxvt(1) manpage).
309		322
310	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
311	slightly in the future.	324	preference to the C<on_action> hook.
312
313	=item on_register_command $term, $keysym, $modifiermask, $string
314
315	Called after parsing a keysym resource but before registering the
316	associated binding. If this hook returns TRUE the binding is not
317	registered. It can be used to modify a binding by calling
318	C<register_command>.
319		325
320	=item on_resize_all_windows $term, $new_width, $new_height	326	=item on_resize_all_windows $term, $new_width, $new_height
321		327
322	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
323	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
324	returns TRUE, setting of the window hints is being skipped.	330	returns a true value, setting of the window hints is being skipped.
325		331
326	=item on_x_event $term, $event	332	=item on_x_event $term, $event
327		333
328	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
329	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
…		…
368	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
369	(real, not screen-based) row and column under the mouse cursor.	375	(real, not screen-based) row and column under the mouse cursor.
370		376
371	C<on_key_press> additionally receives the string rxvt-unicode would	377	C<on_key_press> additionally receives the string rxvt-unicode would
372	output, if any, in locale-specific encoding.	378	output, if any, in locale-specific encoding.
373
374	subwindow.
375		379
376	=item on_client_message $term, $event	380	=item on_client_message $term, $event
377		381
378	=item on_wm_protocols $term, $event	382	=item on_wm_protocols $term, $event
379		383
…		…
582	no warnings 'utf8';	586	no warnings 'utf8';
583		587
584	sub parse_resource {	588	sub parse_resource {
585	my ($term, $name, $isarg, $longopt, $flag, $value) = @_;	589	my ($term, $name, $isarg, $longopt, $flag, $value) = @_;
586		590
587	$name =~ y/-/./ if $isarg;
588
589	$term->scan_meta;	591	$term->scan_extensions;
590		592
591	my $r = $term->{meta}{resource};	593	my $r = $term->{meta}{resource};
592	keys %$r; # reste iterator	594	keys %$r; # reset iterator
593	while (my ($pattern, $v) = each %$r) {	595	while (my ($k, $v) = each %$r) {
594	if (	596	my $pattern = $k;
		597	$pattern =~ y/./-/ if $isarg;
		598	my $prefix = $name;
		599	my $suffix;
595	$pattern =~ /\.$/	600	if ($pattern =~ /\-$/) {
596	? $pattern eq substr $name, 0, length $pattern	601	$prefix = substr $name, 0, length $pattern;
597	: $pattern eq $name	602	$suffix = substr $name, length $pattern;
598	) {	603	}
		604	if ($pattern eq $prefix) {
599	$name = "$urxvt::RESCLASS.$name";	605	$name = "$urxvt::RESCLASS.$k$suffix";
600		606
601	push @{ $term->{perl_ext_3} }, $v->[0];	607	push @{ $term->{perl_ext_3} }, $v->[0];
602		608
603	if ($v->[1] eq "boolean") {	609	if ($v->[1] eq "boolean") {
604	$term->put_option_db ($name, $flag ? "true" : "false");	610	$term->put_option_db ($name, $flag ? "true" : "false");
…		…
614	}	620	}
615		621
616	sub usage {	622	sub usage {
617	my ($term, $usage_type) = @_;	623	my ($term, $usage_type) = @_;
618		624
619	$term->scan_meta;	625	$term->scan_extensions;
620		626
621	my $r = $term->{meta}{resource};	627	my $r = $term->{meta}{resource};
622		628
623	for my $pattern (sort keys %$r) {	629	for my $pattern (sort keys %$r) {
624	my ($ext, $type, $desc) = @{ $r->{$pattern} };	630	my ($ext, $type, $desc) = @{ $r->{$pattern} };
…		…
685	# called by the rxvt core	691	# called by the rxvt core
686	sub invoke {	692	sub invoke {
687	local $TERM = shift;	693	local $TERM = shift;
688	my $htype = shift;	694	my $htype = shift;
689		695
690	if ($htype == 0) { # INIT	696	if ($htype == HOOK_INIT) {
691	my @dirs = $TERM->perl_libdirs;	697	my @dirs = $TERM->perl_libdirs;
		698
		699	$TERM->scan_extensions;
692		700
693	my %ext_arg;	701	my %ext_arg;
694		702
695	{	703	{
696	my @init = @TERM_INIT;	704	my @init = @TERM_INIT;
…		…
700	@TERM_EXT = ();	708	@TERM_EXT = ();
701	$TERM->register_package ($_) for @pkg;	709	$TERM->register_package ($_) for @pkg;
702	}	710	}
703		711
704	for (	712	for (
		713	(grep $_, map { split /,/, $TERM->resource ("perl_ext_$_") } 1, 2),
705	@{ delete $TERM->{perl_ext_3} },	714	@{ delete $TERM->{perl_ext_3} }
706	grep $_, map { split /,/, $TERM->resource ("perl_ext_$_") } 1, 2
707	) {	715	) {
708	if ($_ eq "default") {	716	if ($_ eq "default") {
		717
		718	$ext_arg{$_} = []
709	$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
710	} elsif (/^-(.*)$/) {	730	} elsif (/^-(.*)$/) {
711	delete $ext_arg{$1};	731	delete $ext_arg{$1};
		732
712	} elsif (/^([^<]+)<(.*)>$/) {	733	} elsif (/^([^<]+)<(.*)>$/) {
713	push @{ $ext_arg{$1} }, $2;	734	push @{ $ext_arg{$1} }, $2;
		735
714	} else {	736	} else {
715	$ext_arg{$_} \|\|= [];	737	$ext_arg{$_} \|\|= [];
716	}	738	}
717	}	739	}
718		740
…		…
734		756
735	if (my $cb = $TERM->{_hook}[$htype]) {	757	if (my $cb = $TERM->{_hook}[$htype]) {
736	verbose 10, "$HOOKNAME[$htype] (" . (join ", ", $TERM, @_) . ")"	758	verbose 10, "$HOOKNAME[$htype] (" . (join ", ", $TERM, @_) . ")"
737	if $verbosity >= 10;	759	if $verbosity >= 10;
738		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
739	for my $pkg (keys %$cb) {	774	for my $pkg (keys %$cb) {
740	my $retval_ = eval { $cb->{$pkg}->($TERM->{_pkg}{$pkg}, @_) };	775	my $retval_ = eval { $cb->{$pkg}->($TERM->{_pkg}{$pkg} \|\| $TERM, @_) };
741	$retval \|\|= $retval_;	776	$retval \|\|= $retval_;
742		777
743	if ($@) {	778	if ($@) {
744	$TERM->ungrab; # better to lose the grab than the session	779	$TERM->ungrab; # better to lose the grab than the session
745	warn $@;	780	warn $@;
…		…
748		783
749	verbose 11, "$HOOKNAME[$htype] returning <$retval>"	784	verbose 11, "$HOOKNAME[$htype] returning <$retval>"
750	if $verbosity >= 11;	785	if $verbosity >= 11;
751	}	786	}
752		787
753	if ($htype == 1) { # DESTROY	788	if ($htype == HOOK_DESTROY) {
754	# clear package objects	789	# clear package objects
755	%$_ = () for values %{ $TERM->{_pkg} };	790	%$_ = () for values %{ $TERM->{_pkg} };
756		791
757	# clear package	792	# clear package
758	%$TERM = ();	793	%$TERM = ();
…		…
790	($mask, @color{qw(fg bg)}, \@failed)	825	($mask, @color{qw(fg bg)}, \@failed)
791	}	826	}
792		827
793	package urxvt::term::extension;	828	package urxvt::term::extension;
794		829
795	sub enable {	830	=head2 The C<urxvt::term::extension> class
796	my ($self, %hook) = @_;
797	my $pkg = $self->{_pkg};
798		831
799	while (my ($name, $cb) = each %hook) {	832	Each extension attached to a terminal object is represented by
800	my $htype = $HOOKTYPE{uc $name};	833	a C<urxvt::term::extension> object.
801	defined $htype
802	or Carp::croak "unsupported hook type '$name'";
803		834
804	$self->set_should_invoke ($htype, +1)	835	You can use these objects, which are passed to all callbacks to store any
805	unless exists $self->{term}{_hook}[$htype]{$pkg};	836	state related to the terminal and extension instance.
806		837
807	$self->{term}{_hook}[$htype]{$pkg} = $cb;	838	The methods (And data members) documented below can be called on extension
808	}	839	objects, in addition to call methods documented for the <urxvt::term>
809	}	840	class.
810		841
811	sub disable {	842	=over 4
812	my ($self, @hook) = @_;
813	my $pkg = $self->{_pkg};
814		843
815	for my $name (@hook) {	844	=item $urxvt_term = $self->{term}
816	my $htype = $HOOKTYPE{uc $name};
817	defined $htype
818	or Carp::croak "unsupported hook type '$name'";
819		845
820	$self->set_should_invoke ($htype, -1)	846	Returns the C<urxvt::term> object associated with this instance of the
821	if delete $self->{term}{_hook}[$htype]{$pkg};	847	extension. This member I<must not> be changed in any way.
822	}	848
823	}	849	=cut
824		850
825	our $AUTOLOAD;	851	our $AUTOLOAD;
826		852
827	sub AUTOLOAD {	853	sub AUTOLOAD {
828	$AUTOLOAD =~ /:([^:]+)$/	854	$AUTOLOAD =~ /:([^:]+)$/
…		…
841		867
842	sub DESTROY {	868	sub DESTROY {
843	# nop	869	# nop
844	}	870	}
845		871
846	# urxvt::destroy_hook	872	# urxvt::destroy_hook (basically a cheap Guard:: implementation)
847		873
848	sub urxvt::destroy_hook::DESTROY {	874	sub urxvt::destroy_hook::DESTROY {
849	${$_[0]}->();	875	${$_[0]}->();
850	}	876	}
851		877
852	sub urxvt::destroy_hook(&) {	878	sub urxvt::destroy_hook(&) {
853	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)
854	}	987	}
855		988
856	sub x_resource {	989	sub x_resource {
857	my ($self, $name) = @_;	990	my ($self, $name) = @_;
858	$name =~ s/^%(\.\|$)/$_[0]{_name}$1/;	991	$name =~ s/^%(\.\|$)/$_[0]{_name}$1/;
…		…
862	sub x_resource_boolean {	995	sub x_resource_boolean {
863	my ($self, $name) = @_;	996	my ($self, $name) = @_;
864	$name =~ s/^%(\.\|$)/$_[0]{_name}$1/;	997	$name =~ s/^%(\.\|$)/$_[0]{_name}$1/;
865	$self->{term}->x_resource_boolean ($name)	998	$self->{term}->x_resource_boolean ($name)
866	}	999	}
		1000
		1001	=back
		1002
		1003	=cut
867		1004
868	package urxvt::anyevent;	1005	package urxvt::anyevent;
869		1006
870	=head2 The C<urxvt::anyevent> Class	1007	=head2 The C<urxvt::anyevent> Class
871		1008
…		…
990	$ENV{URXVT_PERL_LIB},	1127	$ENV{URXVT_PERL_LIB},
991	"$ENV{HOME}/.urxvt/ext",	1128	"$ENV{HOME}/.urxvt/ext",
992	"$LIBDIR/perl"	1129	"$LIBDIR/perl"
993	}	1130	}
994		1131
995	sub scan_meta {	1132	# scan for available extensions and collect their metadata
		1133	sub scan_extensions {
996	my ($self) = @_;	1134	my ($self) = @_;
		1135
		1136	return if exists $self->{meta};
		1137
997	my @libdirs = perl_libdirs $self;	1138	my @urxvtdirs = perl_libdirs $self;
		1139	# my @cpandirs = grep -d, map "$_/URxvt/Ext", @INC;
998		1140
999	return if $self->{meta_libdirs} eq join "\x00", @libdirs;
1000
1001	my %meta;
1002
1003	$self->{meta_libdirs} = join "\x00", @libdirs;
1004	$self->{meta} = \%meta;	1141	$self->{meta} = \my %meta;
1005		1142
1006	for my $dir (reverse @libdirs) {	1143	# first gather extensions
		1144
		1145	my $gather = sub {
		1146	my ($dir, $core) = @_;
		1147
1007	opendir my $fh, $dir	1148	opendir my $fh, $dir
1008	or next;	1149	or return;
		1150
1009	for my $ext (readdir $fh) {	1151	for my $ext (readdir $fh) {
1010	$ext ne "."	1152	$ext !~ /^\./
1011	and $ext ne ".."
1012	and open my $fh, "<", "$dir/$ext"
1013	or next;	1153	or next;
1014		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
1015	while (<$fh>) {	1166	while (<$fh>) {
1016	if (/^#:META:X_RESOURCE:(.*)/) {	1167	if (/^#:META:(?:X_)?RESOURCE:(.*)/) {
1017	my ($pattern, $type, $desc) = split /:/, $1;	1168	my ($pattern, $type, $desc) = split /:/, $1;
1018	$pattern =~ s/^%(\.\|$)/$ext$1/g; # % in pattern == extension name	1169	$pattern =~ s/^%(\.\|$)/$ext$1/g; # % in pattern == extension name
1019	if ($pattern =~ /[^a-zA-Z0-9\-\.]/) {	1170	if ($pattern =~ /[^a-zA-Z0-9\-\.]/) {
1020	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";
1021	} else {	1172	} else {
1022	$meta{resource}{$pattern} = [$ext, $type, $desc];	1173	$ext{resource}{$pattern} = [$ext, $type, $desc];
1023	}	1174	}
1024	} elsif (/^\s*(?:#\|$)/) {	1175	} elsif (/^\s*(?:#\|$)/) {
1025	# skip other comments and empty lines	1176	# skip other comments and empty lines
1026	} else {	1177	} else {
1027	last; # stop parsing on first non-empty non-comment line	1178	last; # stop parsing on first non-empty non-comment line
1028	}	1179	}
1029	}	1180	}
		1181
		1182	$meta{ext}{$ext} = \%ext;
1030	}	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} });
1031	}	1196	}
1032	}	1197	}
1033		1198
1034	=item $term = new urxvt::term $envhashref, $rxvtname, [arg...]	1199	=item $term = new urxvt::term $envhashref, $rxvtname, [arg...]
1035		1200
…		…
1055	}	1220	}
1056		1221
1057	=item $term->destroy	1222	=item $term->destroy
1058		1223
1059	Destroy the terminal object (close the window, free resources	1224	Destroy the terminal object (close the window, free resources
1060	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
1061	watchers (timers, io watchers) are still active.	1226	watchers (timers, io watchers) are still active.
1062		1227
1063	=item $term->exec_async ($cmd[, @args])	1228	=item $term->exec_async ($cmd[, @args])
1064		1229
1065	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
…		…
1121		1286
1122	Here is a likely non-exhaustive list of resource names, not all of which	1287	Here is a likely non-exhaustive list of resource names, not all of which
1123	are supported in every build, please see the source file F</src/rsinc.h>	1288	are supported in every build, please see the source file F</src/rsinc.h>
1124	to see the actual list:	1289	to see the actual list:
1125		1290
1126	answerbackstring backgroundPixmap backspace_key blendtype blurradius	1291	answerbackstring backgroundPixmap backspace_key blurradius
1127	boldFont boldItalicFont borderLess buffered chdir color cursorBlink	1292	boldFont boldItalicFont borderLess buffered chdir color cursorBlink
1128	cursorUnderline cutchars delete_key depth display_name embed ext_bwidth	1293	cursorUnderline cutchars delete_key depth display_name embed ext_bwidth
1129	fade font geometry hold iconName iconfile imFont imLocale inputMethod	1294	fade font geometry hold iconName iconfile imFont imLocale inputMethod
1130	insecure int_bwidth intensityStyles iso14755 iso14755_52 italicFont	1295	insecure int_bwidth intensityStyles iso14755 iso14755_52 italicFont
1131	jumpScroll letterSpace lineSpace loginShell mapAlert meta8 modifier	1296	jumpScroll letterSpace lineSpace loginShell mapAlert meta8 modifier
…		…
1151	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
1152	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
1153	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
1154	resource with that pattern exists.	1319	resource with that pattern exists.
1155		1320
1156	Extensions that define extra resource or command line arguments also need	1321	Extensions that define extra resources also need to call this method
1157	to call this method to access their values.	1322	to access their values.
1158		1323
1159	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
1160	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
1161	the extension and a dot, and the lone string C<%> will be replcaed by the	1326	the extension and a dot, and the lone string C<%> will be replaced by the
1162	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
1163	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
1164	without having to change the actual code.	1329	the actual code.
1165		1330
1166	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
1167	only one resource database per display, and later invocations might return	1332	only one resource database per display, and later invocations might return
1168	the wrong resources.	1333	the wrong resources.
1169		1334
…		…
1181	my $res = &x_resource;	1346	my $res = &x_resource;
1182		1347
1183	$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
1184	}	1349	}
1185		1350
1186	=item $success = $term->parse_keysym ($key, $octets)	1351	=item $action = $term->lookup_keysym ($keysym, $state)
1187		1352
		1353	Returns the action bound to key combination C<($keysym, $state)>,
		1354	if a binding for it exists, and C<undef> otherwise.
		1355
		1356	=item $success = $term->bind_action ($key, $action)
		1357
1188	Adds a key binding exactly as specified via a resource. See the	1358	Adds a key binding exactly as specified via a C<keysym> resource. See the
1189	C<keysym> resource in the @@RXVT_NAME@@(1) manpage.	1359	C<keysym> resource in the urxvt(1) manpage.
1190		1360
1191	=item $term->register_command ($keysym, $modifiermask, $string)	1361	To add default bindings for actions, an extension should call C<<
		1362	->bind_action >> in its C<init> hook for every such binding. Doing it
		1363	in the C<init> hook allows users to override or remove the binding
		1364	again.
1192		1365
1193	Adds a key binding. This is a lower level api compared to	1366	Example: the C<searchable-scrollback> by default binds itself
1194	C<parse_keysym>, as it expects a parsed key description, and can be	1367	on C<Meta-s>, using C<< $self->bind_action >>, which calls C<<
1195	used only inside either the C<on_init> hook, to add a binding, or the	1368	$term->bind_action >>.
1196	C<on_register_command> hook, to modify a parsed binding.	1369
		1370	sub init {
		1371	my ($self) = @_;
		1372
		1373	$self->bind_action ("M-s" => "%:start");
		1374	}
1197		1375
1198	=item $rend = $term->rstyle ([$new_rstyle])	1376	=item $rend = $term->rstyle ([$new_rstyle])
1199		1377
1200	Return and optionally change the current rendition. Text that is output by	1378	Return and optionally change the current rendition. Text that is output by
1201	the terminal application will use this style.	1379	the terminal application will use this style.
…		…
1359		1537
1360	=item $term->scr_add_lines ($string)	1538	=item $term->scr_add_lines ($string)
1361		1539
1362	Write the given text string to the screen, as if output by the application	1540	Write the given text string to the screen, as if output by the application
1363	running inside the terminal. It may not contain command sequences (escape	1541	running inside the terminal. It may not contain command sequences (escape
1364	codes), but is free to use line feeds, carriage returns and tabs. The	1542	codes - see C<cmd_parse> for that), but is free to use line feeds,
1365	string is a normal text string, not in locale-dependent encoding.	1543	carriage returns and tabs. The string is a normal text string, not in
		1544	locale-dependent encoding.
1366		1545
1367	Normally its not a good idea to use this function, as programs might be	1546	Normally its not a good idea to use this function, as programs might be
1368	confused by changes in cursor position or scrolling. Its useful inside a	1547	confused by changes in cursor position or scrolling. Its useful inside a
1369	C<on_add_lines> hook, though.	1548	C<on_add_lines> hook, though.
1370		1549
…		…
1378	locale-specific encoding of the terminal and can contain command sequences	1557	locale-specific encoding of the terminal and can contain command sequences
1379	(escape codes) that will be interpreted.	1558	(escape codes) that will be interpreted.
1380		1559
1381	=item $term->tt_write ($octets)	1560	=item $term->tt_write ($octets)
1382		1561
1383	Write the octets given in C<$octets> to the tty (i.e. as program input). To	1562	Write the octets given in C<$octets> to the tty (i.e. as user input
		1563	to the program, see C<cmd_parse> for the opposite direction). To pass
1384	pass characters instead of octets, you should convert your strings first	1564	characters instead of octets, you should convert your strings first to the
1385	to the locale-specific encoding using C<< $term->locale_encode >>.	1565	locale-specific encoding using C<< $term->locale_encode >>.
		1566
		1567	=item $term->tt_write_user_input ($octets)
		1568
		1569	Like C<tt_write>, but should be used when writing strings in response to
		1570	the user pressing a key, to invoke the additional actions requested by
		1571	the user for that case (C<tt_write> doesn't do that).
		1572
		1573	The typical use case would be inside C<on_action> hooks.
1386		1574
1387	=item $term->tt_paste ($octets)	1575	=item $term->tt_paste ($octets)
1388		1576
1389	Write the octets given in C<$octets> to the tty as a paste, converting NL to	1577	Write the octets given in C<$octets> to the tty as a paste, converting NL to
1390	CR and bracketing the data with control sequences if bracketed paste mode	1578	CR and bracketing the data with control sequences if bracketed paste mode
…		…
1429		1617
1430	=item $term->key_release ($state, $keycode[, $time])	1618	=item $term->key_release ($state, $keycode[, $time])
1431		1619
1432	Deliver various fake events to to terminal.	1620	Deliver various fake events to to terminal.
1433		1621
1434	=item $window_width = $term->width	1622	=item $window_width = $term->width ([$new_value])
1435		1623
1436	=item $window_height = $term->height	1624	=item $window_height = $term->height ([$new_value])
1437		1625
1438	=item $font_width = $term->fwidth	1626	=item $font_width = $term->fwidth ([$new_value])
1439		1627
1440	=item $font_height = $term->fheight	1628	=item $font_height = $term->fheight ([$new_value])
1441		1629
1442	=item $font_ascent = $term->fbase	1630	=item $font_ascent = $term->fbase ([$new_value])
1443		1631
1444	=item $terminal_rows = $term->nrow	1632	=item $terminal_rows = $term->nrow ([$new_value])
1445		1633
1446	=item $terminal_columns = $term->ncol	1634	=item $terminal_columns = $term->ncol ([$new_value])
1447		1635
1448	=item $has_focus = $term->focus	1636	=item $has_focus = $term->focus ([$new_value])
1449		1637
1450	=item $is_mapped = $term->mapped	1638	=item $is_mapped = $term->mapped ([$new_value])
1451		1639
1452	=item $max_scrollback = $term->saveLines	1640	=item $max_scrollback = $term->saveLines ([$new_value])
1453		1641
1454	=item $nrow_plus_saveLines = $term->total_rows	1642	=item $nrow_plus_saveLines = $term->total_rows ([$new_value])
1455		1643
1456	=item $topmost_scrollback_row = $term->top_row	1644	=item $topmost_scrollback_row = $term->top_row ([$new_value])
1457		1645
1458	Return various integers describing terminal characteristics.	1646	Return various integers describing terminal characteristics. If an
		1647	argument is given, changes the value and returns the previous one.
1459		1648
1460	=item $x_display = $term->display_id	1649	=item $x_display = $term->display_id
1461		1650
1462	Return the DISPLAY used by rxvt-unicode.	1651	Return the DISPLAY used by rxvt-unicode.
1463		1652
…		…
1513	Requests a screen refresh. At the next opportunity, rxvt-unicode will	1702	Requests a screen refresh. At the next opportunity, rxvt-unicode will
1514	compare the on-screen display with its stored representation. If they	1703	compare the on-screen display with its stored representation. If they
1515	differ, it redraws the differences.	1704	differ, it redraws the differences.
1516		1705
1517	Used after changing terminal contents to display them.	1706	Used after changing terminal contents to display them.
		1707
		1708	=item $term->refresh_check
		1709
		1710	Checks if a refresh has been requested and, if so, schedules one.
1518		1711
1519	=item $text = $term->ROW_t ($row_number[, $new_text[, $start_col]])	1712	=item $text = $term->ROW_t ($row_number[, $new_text[, $start_col]])
1520		1713
1521	Returns the text of the entire row with number C<$row_number>. Row C<< $term->top_row >>	1714	Returns the text of the entire row with number C<$row_number>. Row C<< $term->top_row >>
1522	is the topmost terminal line, row C<< $term->nrow-1 >> is the bottommost	1715	is the topmost terminal line, row C<< $term->nrow-1 >> is the bottommost
…		…
1624	}	1817	}
1625		1818
1626	sub urxvt::line::t {	1819	sub urxvt::line::t {
1627	my ($self) = @_;	1820	my ($self) = @_;
1628		1821
1629	if (@_ > 1)	1822	if (@_ > 1) {
1630	{
1631	$self->{term}->ROW_t ($_, $_[1], 0, ($_ - $self->{beg}) * $self->{ncol}, $self->{ncol})	1823	$self->{term}->ROW_t ($_, $_[1], 0, ($_ - $self->{beg}) * $self->{ncol}, $self->{ncol})
1632	for $self->{beg} .. $self->{end};	1824	for $self->{beg} .. $self->{end};
1633	}	1825	}
1634		1826
1635	defined wantarray &&	1827	defined wantarray &&
1636	substr +(join "", map $self->{term}->ROW_t ($_), $self->{beg} .. $self->{end}),	1828	substr +(join "", map $self->{term}->ROW_t ($_), $self->{beg} .. $self->{end}),
1637	0, $self->{len}	1829	0, $self->{len}
1638	}	1830	}
1639		1831
1640	sub urxvt::line::r {	1832	sub urxvt::line::r {
1641	my ($self) = @_;	1833	my ($self) = @_;
1642		1834
1643	if (@_ > 1)	1835	if (@_ > 1) {
1644	{
1645	$self->{term}->ROW_r ($_, $_[1], 0, ($_ - $self->{beg}) * $self->{ncol}, $self->{ncol})	1836	$self->{term}->ROW_r ($_, $_[1], 0, ($_ - $self->{beg}) * $self->{ncol}, $self->{ncol})
1646	for $self->{beg} .. $self->{end};	1837	for $self->{beg} .. $self->{end};
1647	}	1838	}
1648		1839
1649	if (defined wantarray) {	1840	if (defined wantarray) {
1650	my $rend = [	1841	my $rend = [
1651	map @{ $self->{term}->ROW_r ($_) }, $self->{beg} .. $self->{end}	1842	map @{ $self->{term}->ROW_r ($_) }, $self->{beg} .. $self->{end}
1652	];	1843	];

Diff Legend

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

Comparing rxvt-unicode/src/urxvt.pm (file contents): Revision 1.218 by root, Sun Jun 10 17:31:53 2012 UTC vs. Revision 1.255 by root, Wed Jun 17 11:59:37 2015 UTC

Diff Legend

Comparing rxvt-unicode/src/urxvt.pm (file contents):
Revision 1.218 by root, Sun Jun 10 17:31:53 2012 UTC vs.
Revision 1.255 by root, Wed Jun 17 11:59:37 2015 UTC