[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.246 by root, Fri Dec 26 18:58:19 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 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 and also default bindings for one or
		51	more actions it provides using so called META comments, described
		52	below. Similarly to builtin resources, extension resources can also be
		53	specified on the command line as long options (with C<.> replaced by
		54	C<->), in which case the corresponding extension is loaded
		55	automatically. For this to work the extension B<must> define META
		56	comments for its resources.
50		57
51	=head1 API DOCUMENTATION	58	=head1 API DOCUMENTATION
52		59
53	=head2 General API Considerations	60	=head2 General API Considerations
54		61
103	internal use.	110	internal use.
104		111
105	Although it isn't a C<urxvt::term> object, you can call all methods of the	112	Although it isn't a C<urxvt::term> object, you can call all methods of the
106	C<urxvt::term> class on this object.	113	C<urxvt::term> class on this object.
107		114
108	It has the following methods and data members:	115	Additional methods only supported for extension objects are described in
		116	the C<urxvt::extension> section below.
		117
		118	=head2 META comments
		119
		120	rxvt-unicode recognizes special comments in extensions that define
		121	different types of metadata:
109		122
110	=over 4	123	=over 4
111		124
112	=item $urxvt_term = $self->{term}	125	=item #:META:RESOURCE:name:type:desc
113		126
114	Returns the C<urxvt::term> object associated with this instance of the	127	The RESOURCE comment defines a resource used by the extension, where
115	extension. This member I<must not> be changed in any way.	128	C<name> is the resource name, C<type> is the resource type, C<boolean>
		129	or C<string>, and C<desc> is the resource description.
116		130
117	=item $self->enable ($hook_name => $cb, [$hook_name => $cb..])	131	=item #:META:BINDING:sym:action
118		132
119	Dynamically enable the given hooks (named without the C<on_> prefix) for	133	The BINDING comment defines a default binding for an action provided
120	this extension, replacing any previous hook. This is useful when you want	134	by the extension, where C<sym> is the key combination that triggers
121	to overwrite time-critical hooks only temporarily.	135	the action, whose format is defined in the description of the
122		136	B<keysym> resource in the urxvt(1) manpage, and C<action> is the name
123	=item $self->disable ($hook_name[, $hook_name..])	137	of the action method.
124
125	Dynamically disable the given hooks.
126		138
127	=back	139	=back
128		140
129	=head2 Hooks	141	=head2 Hooks
130		142
…		…
299		311
300	=item on_refresh_end $term	312	=item on_refresh_end $term
301		313
302	Called just after the screen gets redrawn. See C<on_refresh_begin>.	314	Called just after the screen gets redrawn. See C<on_refresh_begin>.
303		315
		316	=item on_action $term, $string
		317
		318	Called whenever an action is invoked for the corresponding extension
		319	(e.g. via a C<extension:string> builtin action bound to a key, see
		320	description of the B<keysym> resource in the urxvt(1) manpage). The
		321	event is simply the action string. Note that an action event is always
		322	associated to a single extension.
		323
304	=item on_user_command $term, $string	324	=item on_user_command $term, $string DEPRECATED
305		325
306	Called whenever a user-configured event is being activated (e.g. via	326	Called whenever a user-configured event is being activated (e.g. via
307	a C<perl:string> action bound to a key, see description of the B<keysym>	327	a C<perl:string> action bound to a key, see description of the B<keysym>
308	resource in the @@RXVT_NAME@@(1) manpage).	328	resource in the urxvt(1) manpage).
309		329
310	The event is simply the action string. This interface is assumed to change	330	The event is simply the action string. This interface is going away in
311	slightly in the future.	331	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		332
320	=item on_resize_all_windows $term, $new_width, $new_height	333	=item on_resize_all_windows $term, $new_width, $new_height
321		334
322	Called just after the new window size has been calculated, but before	335	Called just after the new window size has been calculated, but before
323	windows are actually being resized or hints are being set. If this hook	336	windows are actually being resized or hints are being set. If this hook
324	returns TRUE, setting of the window hints is being skipped.	337	returns a true value, setting of the window hints is being skipped.
325		338
326	=item on_x_event $term, $event	339	=item on_x_event $term, $event
327		340
328	Called on every X event received on the vt window (and possibly other	341	Called on every X event received on the vt window (and possibly other
329	windows). Should only be used as a last resort. Most event structure	342	windows). Should only be used as a last resort. Most event structure
…		…
368	manpage), with the additional members C<row> and C<col>, which are the	381	manpage), with the additional members C<row> and C<col>, which are the
369	(real, not screen-based) row and column under the mouse cursor.	382	(real, not screen-based) row and column under the mouse cursor.
370		383
371	C<on_key_press> additionally receives the string rxvt-unicode would	384	C<on_key_press> additionally receives the string rxvt-unicode would
372	output, if any, in locale-specific encoding.	385	output, if any, in locale-specific encoding.
373
374	subwindow.
375		386
376	=item on_client_message $term, $event	387	=item on_client_message $term, $event
377		388
378	=item on_wm_protocols $term, $event	389	=item on_wm_protocols $term, $event
379		390
…		…
582	no warnings 'utf8';	593	no warnings 'utf8';
583		594
584	sub parse_resource {	595	sub parse_resource {
585	my ($term, $name, $isarg, $longopt, $flag, $value) = @_;	596	my ($term, $name, $isarg, $longopt, $flag, $value) = @_;
586		597
587	$name =~ y/-/./ if $isarg;
588
589	$term->scan_meta;	598	$term->scan_extensions;
590		599
591	my $r = $term->{meta}{resource};	600	my $r = $term->{meta}{resource};
592	keys %$r; # reste iterator	601	keys %$r; # reset iterator
593	while (my ($pattern, $v) = each %$r) {	602	while (my ($k, $v) = each %$r) {
594	if (	603	my $pattern = $k;
		604	$pattern =~ y/./-/ if $isarg;
		605	my $prefix = $name;
		606	my $suffix;
595	$pattern =~ /\.$/	607	if ($pattern =~ /\-$/) {
596	? $pattern eq substr $name, 0, length $pattern	608	$prefix = substr $name, 0, length $pattern;
597	: $pattern eq $name	609	$suffix = substr $name, length $pattern;
598	) {	610	}
		611	if ($pattern eq $prefix) {
599	$name = "$urxvt::RESCLASS.$name";	612	$name = "$urxvt::RESCLASS.$k$suffix";
600		613
601	push @{ $term->{perl_ext_3} }, $v->[0];	614	push @{ $term->{perl_ext_3} }, $v->[0];
602		615
603	if ($v->[1] eq "boolean") {	616	if ($v->[1] eq "boolean") {
604	$term->put_option_db ($name, $flag ? "true" : "false");	617	$term->put_option_db ($name, $flag ? "true" : "false");
…		…
614	}	627	}
615		628
616	sub usage {	629	sub usage {
617	my ($term, $usage_type) = @_;	630	my ($term, $usage_type) = @_;
618		631
619	$term->scan_meta;	632	$term->scan_extensions;
620		633
621	my $r = $term->{meta}{resource};	634	my $r = $term->{meta}{resource};
622		635
623	for my $pattern (sort keys %$r) {	636	for my $pattern (sort keys %$r) {
624	my ($ext, $type, $desc) = @{ $r->{$pattern} };	637	my ($ext, $type, $desc) = @{ $r->{$pattern} };
…		…
685	# called by the rxvt core	698	# called by the rxvt core
686	sub invoke {	699	sub invoke {
687	local $TERM = shift;	700	local $TERM = shift;
688	my $htype = shift;	701	my $htype = shift;
689		702
690	if ($htype == 0) { # INIT	703	if ($htype == HOOK_INIT) {
691	my @dirs = $TERM->perl_libdirs;	704	my @dirs = $TERM->perl_libdirs;
		705
		706	$TERM->scan_extensions;
692		707
693	my %ext_arg;	708	my %ext_arg;
694		709
695	{	710	{
696	my @init = @TERM_INIT;	711	my @init = @TERM_INIT;
…		…
700	@TERM_EXT = ();	715	@TERM_EXT = ();
701	$TERM->register_package ($_) for @pkg;	716	$TERM->register_package ($_) for @pkg;
702	}	717	}
703		718
704	for (	719	for (
		720	(grep $_, map { split /,/, $TERM->resource ("perl_ext_$_") } 1, 2),
705	@{ delete $TERM->{perl_ext_3} },	721	@{ delete $TERM->{perl_ext_3} }
706	grep $_, map { split /,/, $TERM->resource ("perl_ext_$_") } 1, 2
707	) {	722	) {
708	if ($_ eq "default") {	723	if ($_ eq "default") {
		724
		725	$ext_arg{$_} = []
		726	for
709	$ext_arg{$_} \|\|= [] for qw(selection option-popup selection-popup searchable-scrollback readline);	727	qw(selection option-popup selection-popup readline searchable-scrollback),
		728	map $_->[0], values %{ $TERM->{meta}{binding} };
		729
		730	for ($TERM->_keysym_resources) {
		731	next if /^(?:string\|command\|builtin\|builtin-string\|perl)/;
		732	next unless /^([A-Za-z0-9_\-]+):/;
		733
		734	my $ext = $1;
		735
		736	$ext_arg{$ext} = [];
		737	}
		738
710	} elsif (/^-(.*)$/) {	739	} elsif (/^-(.*)$/) {
711	delete $ext_arg{$1};	740	delete $ext_arg{$1};
		741
712	} elsif (/^([^<]+)<(.*)>$/) {	742	} elsif (/^([^<]+)<(.*)>$/) {
713	push @{ $ext_arg{$1} }, $2;	743	push @{ $ext_arg{$1} }, $2;
		744
714	} else {	745	} else {
715	$ext_arg{$_} \|\|= [];	746	$ext_arg{$_} \|\|= [];
		747	}
		748	}
		749
		750	# now register default key bindings
		751	for my $ext (sort keys %ext_arg) {
		752	while (my ($k, $v) = each %{ $TERM->{meta}{ext}{$ext}{binding} }) {
		753	$TERM->bind_action ($k, "$v->[0]:$v->[1]");
716	}	754	}
717	}	755	}
718		756
719	for my $ext (sort keys %ext_arg) {	757	for my $ext (sort keys %ext_arg) {
720	my @files = grep -f $_, map "$_/$ext", @dirs;	758	my @files = grep -f $_, map "$_/$ext", @dirs;
…		…
734		772
735	if (my $cb = $TERM->{_hook}[$htype]) {	773	if (my $cb = $TERM->{_hook}[$htype]) {
736	verbose 10, "$HOOKNAME[$htype] (" . (join ", ", $TERM, @_) . ")"	774	verbose 10, "$HOOKNAME[$htype] (" . (join ", ", $TERM, @_) . ")"
737	if $verbosity >= 10;	775	if $verbosity >= 10;
738		776
		777	if ($htype == HOOK_ACTION) {
		778	# this hook is only sent to the extension with the name
		779	# matching the first arg
		780	my $pkg = shift;
		781	$pkg =~ y/-/_/;
		782	$pkg = "urxvt::ext::$pkg";
		783
		784	$cb = $cb->{$pkg}
		785	or return undef; #TODO: maybe warn user?
		786
		787	$cb = { $pkg => $cb };
		788	}
		789
739	for my $pkg (keys %$cb) {	790	for my $pkg (keys %$cb) {
740	my $retval_ = eval { $cb->{$pkg}->($TERM->{_pkg}{$pkg}, @_) };	791	my $retval_ = eval { $cb->{$pkg}->($TERM->{_pkg}{$pkg} \|\| $TERM, @_) };
741	$retval \|\|= $retval_;	792	$retval \|\|= $retval_;
742		793
743	if ($@) {	794	if ($@) {
744	$TERM->ungrab; # better to lose the grab than the session	795	$TERM->ungrab; # better to lose the grab than the session
745	warn $@;	796	warn $@;
…		…
748		799
749	verbose 11, "$HOOKNAME[$htype] returning <$retval>"	800	verbose 11, "$HOOKNAME[$htype] returning <$retval>"
750	if $verbosity >= 11;	801	if $verbosity >= 11;
751	}	802	}
752		803
753	if ($htype == 1) { # DESTROY	804	if ($htype == HOOK_DESTROY) {
754	# clear package objects	805	# clear package objects
755	%$_ = () for values %{ $TERM->{_pkg} };	806	%$_ = () for values %{ $TERM->{_pkg} };
756		807
757	# clear package	808	# clear package
758	%$TERM = ();	809	%$TERM = ();
…		…
790	($mask, @color{qw(fg bg)}, \@failed)	841	($mask, @color{qw(fg bg)}, \@failed)
791	}	842	}
792		843
793	package urxvt::term::extension;	844	package urxvt::term::extension;
794		845
795	sub enable {	846	=head2 The C<urxvt::term::extension> class
796	my ($self, %hook) = @_;
797	my $pkg = $self->{_pkg};
798		847
799	while (my ($name, $cb) = each %hook) {	848	Each extension attached to a terminal object is represented by
800	my $htype = $HOOKTYPE{uc $name};	849	a C<urxvt::term::extension> object.
801	defined $htype
802	or Carp::croak "unsupported hook type '$name'";
803		850
804	$self->set_should_invoke ($htype, +1)	851	You can use these objects, which are passed to all callbacks to store any
805	unless exists $self->{term}{_hook}[$htype]{$pkg};	852	state related to the terminal and extension instance.
806		853
807	$self->{term}{_hook}[$htype]{$pkg} = $cb;	854	The methods (And data members) documented below can be called on extension
808	}	855	objects, in addition to call methods documented for the <urxvt::term>
809	}	856	class.
810		857
811	sub disable {	858	=over 4
812	my ($self, @hook) = @_;
813	my $pkg = $self->{_pkg};
814		859
815	for my $name (@hook) {	860	=item $urxvt_term = $self->{term}
816	my $htype = $HOOKTYPE{uc $name};
817	defined $htype
818	or Carp::croak "unsupported hook type '$name'";
819		861
820	$self->set_should_invoke ($htype, -1)	862	Returns the C<urxvt::term> object associated with this instance of the
821	if delete $self->{term}{_hook}[$htype]{$pkg};	863	extension. This member I<must not> be changed in any way.
822	}	864
823	}	865	=cut
824		866
825	our $AUTOLOAD;	867	our $AUTOLOAD;
826		868
827	sub AUTOLOAD {	869	sub AUTOLOAD {
828	$AUTOLOAD =~ /:([^:]+)$/	870	$AUTOLOAD =~ /:([^:]+)$/
…		…
841		883
842	sub DESTROY {	884	sub DESTROY {
843	# nop	885	# nop
844	}	886	}
845		887
846	# urxvt::destroy_hook	888	# urxvt::destroy_hook (basically a cheap Guard:: implementation)
847		889
848	sub urxvt::destroy_hook::DESTROY {	890	sub urxvt::destroy_hook::DESTROY {
849	${$_[0]}->();	891	${$_[0]}->();
850	}	892	}
851		893
852	sub urxvt::destroy_hook(&) {	894	sub urxvt::destroy_hook(&) {
853	bless \shift, urxvt::destroy_hook::	895	bless \shift, urxvt::destroy_hook::
854	}	896	}
		897
		898	=item $self->enable ($hook_name => $cb[, $hook_name => $cb..])
		899
		900	Dynamically enable the given hooks (named without the C<on_> prefix) for
		901	this extension, replacing any hook previously installed via C<enable> in
		902	this extension.
		903
		904	This is useful when you want to overwrite time-critical hooks only
		905	temporarily.
		906
		907	To install additional callbacks for the same hook, you can use the C<on>
		908	method of the C<urxvt::term> class.
		909
		910	=item $self->disable ($hook_name[, $hook_name..])
		911
		912	Dynamically disable the given hooks.
		913
		914	=cut
		915
		916	sub enable {
		917	my ($self, %hook) = @_;
		918	my $pkg = $self->{_pkg};
		919
		920	while (my ($name, $cb) = each %hook) {
		921	my $htype = $HOOKTYPE{uc $name};
		922	defined $htype
		923	or Carp::croak "unsupported hook type '$name'";
		924
		925	$self->set_should_invoke ($htype, +1)
		926	unless exists $self->{term}{_hook}[$htype]{$pkg};
		927
		928	$self->{term}{_hook}[$htype]{$pkg} = $cb;
		929	}
		930	}
		931
		932	sub disable {
		933	my ($self, @hook) = @_;
		934	my $pkg = $self->{_pkg};
		935
		936	for my $name (@hook) {
		937	my $htype = $HOOKTYPE{uc $name};
		938	defined $htype
		939	or Carp::croak "unsupported hook type '$name'";
		940
		941	$self->set_should_invoke ($htype, -1)
		942	if delete $self->{term}{_hook}[$htype]{$pkg};
		943	}
		944	}
		945
		946	=item $guard = $self->on ($hook_name => $cb[, $hook_name => $cb..])
		947
		948	Similar to the C<enable> enable, but installs additional callbacks for
		949	the given hook(s) (that is, it doesn't replace existing callbacks), and
		950	returns a guard object. When the guard object is destroyed the callbacks
		951	are disabled again.
		952
		953	=cut
		954
		955	sub urxvt::extension::on_disable::DESTROY {
		956	my $disable = shift;
		957
		958	my $term = delete $disable->{""};
		959
		960	while (my ($htype, $id) = each %$disable) {
		961	delete $term->{_hook}[$htype]{$id};
		962	$term->set_should_invoke ($htype, -1);
		963	}
		964	}
		965
		966	sub on {
		967	my ($self, %hook) = @_;
		968
		969	my $term = $self->{term};
		970
		971	my %disable = ( "" => $term );
		972
		973	while (my ($name, $cb) = each %hook) {
		974	my $htype = $HOOKTYPE{uc $name};
		975	defined $htype
		976	or Carp::croak "unsupported hook type '$name'";
		977
		978	$term->set_should_invoke ($htype, +1);
		979	$term->{_hook}[$htype]{ $disable{$htype} = $cb+0 }
		980	= sub { shift; $cb->($self, @_) }; # very ugly indeed
		981	}
		982
		983	bless \%disable, "urxvt::extension::on_disable"
		984	}
		985
		986	=item $self->x_resource ($pattern)
		987
		988	=item $self->x_resource_boolean ($pattern)
		989
		990	These methods support an additional C<%> prefix when called on an
		991	extension object - see the description of these methods in the
		992	C<urxvt::term> class for details.
		993
		994	=cut
855		995
856	sub x_resource {	996	sub x_resource {
857	my ($self, $name) = @_;	997	my ($self, $name) = @_;
858	$name =~ s/^%(\.\|$)/$_[0]{_name}$1/;	998	$name =~ s/^%(\.\|$)/$_[0]{_name}$1/;
859	$self->{term}->x_resource ($name)	999	$self->{term}->x_resource ($name)
…		…
862	sub x_resource_boolean {	1002	sub x_resource_boolean {
863	my ($self, $name) = @_;	1003	my ($self, $name) = @_;
864	$name =~ s/^%(\.\|$)/$_[0]{_name}$1/;	1004	$name =~ s/^%(\.\|$)/$_[0]{_name}$1/;
865	$self->{term}->x_resource_boolean ($name)	1005	$self->{term}->x_resource_boolean ($name)
866	}	1006	}
		1007
		1008	=back
		1009
		1010	=cut
867		1011
868	package urxvt::anyevent;	1012	package urxvt::anyevent;
869		1013
870	=head2 The C<urxvt::anyevent> Class	1014	=head2 The C<urxvt::anyevent> Class
871		1015
…		…
990	$ENV{URXVT_PERL_LIB},	1134	$ENV{URXVT_PERL_LIB},
991	"$ENV{HOME}/.urxvt/ext",	1135	"$ENV{HOME}/.urxvt/ext",
992	"$LIBDIR/perl"	1136	"$LIBDIR/perl"
993	}	1137	}
994		1138
995	sub scan_meta {	1139	# scan for available extensions and collect their metadata
		1140	sub scan_extensions {
996	my ($self) = @_;	1141	my ($self) = @_;
		1142
		1143	return if exists $self->{meta};
		1144
997	my @libdirs = perl_libdirs $self;	1145	my @libdirs = perl_libdirs $self;
998		1146
999	return if $self->{meta_libdirs} eq join "\x00", @libdirs;	1147	# return if $self->{meta_libdirs} eq join "\x00", @libdirs;#d#
1000		1148
1001	my %meta;
1002
1003	$self->{meta_libdirs} = join "\x00", @libdirs;	1149	# $self->{meta_libdirs} = join "\x00", @libdirs;#d#
1004	$self->{meta} = \%meta;	1150	$self->{meta} = \my %meta;
1005		1151
		1152	# first gather extensions
1006	for my $dir (reverse @libdirs) {	1153	for my $dir (reverse @libdirs) {
1007	opendir my $fh, $dir	1154	opendir my $fh, $dir
1008	or next;	1155	or next;
1009	for my $ext (readdir $fh) {	1156	for my $ext (readdir $fh) {
1010	$ext ne "."	1157	$ext !~ /^\./
1011	and $ext ne ".."
1012	and open my $fh, "<", "$dir/$ext"	1158	and open my $fh, "<", "$dir/$ext"
1013	or next;	1159	or next;
1014		1160
		1161	my %ext = (dir => $dir);
		1162
1015	while (<$fh>) {	1163	while (<$fh>) {
1016	if (/^#:META:X_RESOURCE:(.*)/) {	1164	if (/^#:META:(?:X_)?RESOURCE:(.*)/) {
1017	my ($pattern, $type, $desc) = split /:/, $1;	1165	my ($pattern, $type, $desc) = split /:/, $1;
1018	$pattern =~ s/^%(\.\|$)/$ext$1/g; # % in pattern == extension name	1166	$pattern =~ s/^%(\.\|$)/$ext$1/g; # % in pattern == extension name
1019	if ($pattern =~ /[^a-zA-Z0-9\-\.]/) {	1167	if ($pattern =~ /[^a-zA-Z0-9\-\.]/) {
1020	warn "$dir/$ext: meta resource '$pattern' contains illegal characters (not alphanumeric nor . nor *)\n";	1168	warn "$dir/$ext: meta resource '$pattern' contains illegal characters (not alphanumeric nor . nor *)\n";
1021	} else {	1169	} else {
1022	$meta{resource}{$pattern} = [$ext, $type, $desc];	1170	$ext{resource}{$pattern} = [$ext, $type, $desc];
1023	}	1171	}
		1172	} elsif (/^#:META:BINDING:(.*)/) {
		1173	my ($keysym, $action) = split /:/, $1;
		1174	$ext{binding}{$keysym} = [$ext, $action];
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	# and now merge resources and bindings
		1187	while (my ($k, $v) = each %{ $meta{ext} }) {
		1188	#TODO: should check for extensions overriding each other
		1189	%{ $meta{resource} } = (%{ $meta{resource} }, %{ $v->{resource} });
		1190	%{ $meta{binding} } = (%{ $meta{binding} }, %{ $v->{binding} });
1031	}	1191	}
1032	}	1192	}
1033		1193
1034	=item $term = new urxvt::term $envhashref, $rxvtname, [arg...]	1194	=item $term = new urxvt::term $envhashref, $rxvtname, [arg...]
1035		1195
…		…
1055	}	1215	}
1056		1216
1057	=item $term->destroy	1217	=item $term->destroy
1058		1218
1059	Destroy the terminal object (close the window, free resources	1219	Destroy the terminal object (close the window, free resources
1060	etc.). Please note that @@RXVT_NAME@@ will not exit as long as any event	1220	etc.). Please note that urxvt will not exit as long as any event
1061	watchers (timers, io watchers) are still active.	1221	watchers (timers, io watchers) are still active.
1062		1222
1063	=item $term->exec_async ($cmd[, @args])	1223	=item $term->exec_async ($cmd[, @args])
1064		1224
1065	Works like the combination of the C<fork>/C<exec> builtins, which executes	1225	Works like the combination of the C<fork>/C<exec> builtins, which executes
…		…
1121		1281
1122	Here is a likely non-exhaustive list of resource names, not all of which	1282	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>	1283	are supported in every build, please see the source file F</src/rsinc.h>
1124	to see the actual list:	1284	to see the actual list:
1125		1285
1126	answerbackstring backgroundPixmap backspace_key blendtype blurradius	1286	answerbackstring backgroundPixmap backspace_key blurradius
1127	boldFont boldItalicFont borderLess buffered chdir color cursorBlink	1287	boldFont boldItalicFont borderLess buffered chdir color cursorBlink
1128	cursorUnderline cutchars delete_key depth display_name embed ext_bwidth	1288	cursorUnderline cutchars delete_key depth display_name embed ext_bwidth
1129	fade font geometry hold iconName iconfile imFont imLocale inputMethod	1289	fade font geometry hold iconName iconfile imFont imLocale inputMethod
1130	insecure int_bwidth intensityStyles iso14755 iso14755_52 italicFont	1290	insecure int_bwidth intensityStyles iso14755 iso14755_52 italicFont
1131	jumpScroll letterSpace lineSpace loginShell mapAlert meta8 modifier	1291	jumpScroll letterSpace lineSpace loginShell mapAlert meta8 modifier
…		…
1151	Returns the X-Resource for the given pattern, excluding the program or	1311	Returns the X-Resource for the given pattern, excluding the program or
1152	class name, i.e. C<< $term->x_resource ("boldFont") >> should return the	1312	class name, i.e. C<< $term->x_resource ("boldFont") >> should return the
1153	same value as used by this instance of rxvt-unicode. Returns C<undef> if no	1313	same value as used by this instance of rxvt-unicode. Returns C<undef> if no
1154	resource with that pattern exists.	1314	resource with that pattern exists.
1155		1315
1156	Extensions that define extra resource or command line arguments also need	1316	Extensions that define extra resources also need to call this method
1157	to call this method to access their values.	1317	to access their values.
1158		1318
1159	If the method is called on an extension object (basically, from an	1319	If the method is called on an extension object (basically, from an
1160	extension), then the special prefix C<%.> will be replaced by the name of	1320	extension), then the special prefix C<%.> will be replaced by the name of
1161	the extension and a dot, and the lone string C<%> will be replcaed by the	1321	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	1322	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	1323	can rename them and get a new set of resources without having to change
1164	without having to change the actual code.	1324	the actual code.
1165		1325
1166	This method should only be called during the C<on_start> hook, as there is	1326	This method should only be called during the C<on_start> hook, as there is
1167	only one resource database per display, and later invocations might return	1327	only one resource database per display, and later invocations might return
1168	the wrong resources.	1328	the wrong resources.
1169		1329
…		…
1181	my $res = &x_resource;	1341	my $res = &x_resource;
1182		1342
1183	$res =~ /^\s(?:true\|yes\|on\|1)\s$/i ? 1 : defined $res && 0	1343	$res =~ /^\s(?:true\|yes\|on\|1)\s$/i ? 1 : defined $res && 0
1184	}	1344	}
1185		1345
1186	=item $success = $term->parse_keysym ($key, $octets)	1346	=item $success = $term->bind_action ($key, $octets)
1187		1347
1188	Adds a key binding exactly as specified via a resource. See the	1348	Adds a key binding exactly as specified via a C<keysym> resource. See the
1189	C<keysym> resource in the @@RXVT_NAME@@(1) manpage.	1349	C<keysym> resource in the urxvt(1) manpage.
1190
1191	=item $term->register_command ($keysym, $modifiermask, $string)
1192
1193	Adds a key binding. This is a lower level api compared to
1194	C<parse_keysym>, as it expects a parsed key description, and can be
1195	used only inside either the C<on_init> hook, to add a binding, or the
1196	C<on_register_command> hook, to modify a parsed binding.
1197		1350
1198	=item $rend = $term->rstyle ([$new_rstyle])	1351	=item $rend = $term->rstyle ([$new_rstyle])
1199		1352
1200	Return and optionally change the current rendition. Text that is output by	1353	Return and optionally change the current rendition. Text that is output by
1201	the terminal application will use this style.	1354	the terminal application will use this style.
…		…
1359		1512
1360	=item $term->scr_add_lines ($string)	1513	=item $term->scr_add_lines ($string)
1361		1514
1362	Write the given text string to the screen, as if output by the application	1515	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	1516	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	1517	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.	1518	carriage returns and tabs. The string is a normal text string, not in
		1519	locale-dependent encoding.
1366		1520
1367	Normally its not a good idea to use this function, as programs might be	1521	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	1522	confused by changes in cursor position or scrolling. Its useful inside a
1369	C<on_add_lines> hook, though.	1523	C<on_add_lines> hook, though.
1370		1524
…		…
1378	locale-specific encoding of the terminal and can contain command sequences	1532	locale-specific encoding of the terminal and can contain command sequences
1379	(escape codes) that will be interpreted.	1533	(escape codes) that will be interpreted.
1380		1534
1381	=item $term->tt_write ($octets)	1535	=item $term->tt_write ($octets)
1382		1536
1383	Write the octets given in C<$octets> to the tty (i.e. as program input). To	1537	Write the octets given in C<$octets> to the tty (i.e. as user input
		1538	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	1539	characters instead of octets, you should convert your strings first to the
1385	to the locale-specific encoding using C<< $term->locale_encode >>.	1540	locale-specific encoding using C<< $term->locale_encode >>.
		1541
		1542	=item $term->tt_write_user_input ($octets)
		1543
		1544	Like C<tt_write>, but should be used when writing strings in response to
		1545	the user pressing a key, to invoke the additional actions requested by
		1546	the user for that case (C<tt_write> doesn't do that).
		1547
		1548	The typical use case would be inside C<on_action> hooks.
1386		1549
1387	=item $term->tt_paste ($octets)	1550	=item $term->tt_paste ($octets)
1388		1551
1389	Write the octets given in C<$octets> to the tty as a paste, converting NL to	1552	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	1553	CR and bracketing the data with control sequences if bracketed paste mode
…		…
1624	}	1787	}
1625		1788
1626	sub urxvt::line::t {	1789	sub urxvt::line::t {
1627	my ($self) = @_;	1790	my ($self) = @_;
1628		1791
1629	if (@_ > 1)	1792	if (@_ > 1) {
1630	{
1631	$self->{term}->ROW_t ($_, $_[1], 0, ($_ - $self->{beg}) * $self->{ncol}, $self->{ncol})	1793	$self->{term}->ROW_t ($_, $_[1], 0, ($_ - $self->{beg}) * $self->{ncol}, $self->{ncol})
1632	for $self->{beg} .. $self->{end};	1794	for $self->{beg} .. $self->{end};
1633	}	1795	}
1634		1796
1635	defined wantarray &&	1797	defined wantarray &&
1636	substr +(join "", map $self->{term}->ROW_t ($_), $self->{beg} .. $self->{end}),	1798	substr +(join "", map $self->{term}->ROW_t ($_), $self->{beg} .. $self->{end}),
1637	0, $self->{len}	1799	0, $self->{len}
1638	}	1800	}
1639		1801
1640	sub urxvt::line::r {	1802	sub urxvt::line::r {
1641	my ($self) = @_;	1803	my ($self) = @_;
1642		1804
1643	if (@_ > 1)	1805	if (@_ > 1) {
1644	{
1645	$self->{term}->ROW_r ($_, $_[1], 0, ($_ - $self->{beg}) * $self->{ncol}, $self->{ncol})	1806	$self->{term}->ROW_r ($_, $_[1], 0, ($_ - $self->{beg}) * $self->{ncol}, $self->{ncol})
1646	for $self->{beg} .. $self->{end};	1807	for $self->{beg} .. $self->{end};
1647	}	1808	}
1648		1809
1649	if (defined wantarray) {	1810	if (defined wantarray) {
1650	my $rend = [	1811	my $rend = [
1651	map @{ $self->{term}->ROW_r ($_) }, $self->{beg} .. $self->{end}	1812	map @{ $self->{term}->ROW_r ($_) }, $self->{beg} .. $self->{end}
1652	];	1813	];

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.246 by root, Fri Dec 26 18:58:19 2014 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.246 by root, Fri Dec 26 18:58:19 2014 UTC