[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.256 by sf-exg, Thu Jul 14 05:10:06 2016 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];
		608
		609	return 1 unless $isarg;
602		610
603	if ($v->[1] eq "boolean") {	611	if ($v->[1] eq "boolean") {
604	$term->put_option_db ($name, $flag ? "true" : "false");	612	$term->put_option_db ($name, $flag ? "true" : "false");
605	return 1;	613	return 1;
606	} else {	614	} else {
…		…
614	}	622	}
615		623
616	sub usage {	624	sub usage {
617	my ($term, $usage_type) = @_;	625	my ($term, $usage_type) = @_;
618		626
619	$term->scan_meta;	627	$term->scan_extensions;
620		628
621	my $r = $term->{meta}{resource};	629	my $r = $term->{meta}{resource};
622		630
623	for my $pattern (sort keys %$r) {	631	for my $pattern (sort keys %$r) {
624	my ($ext, $type, $desc) = @{ $r->{$pattern} };	632	my ($ext, $type, $desc) = @{ $r->{$pattern} };
…		…
685	# called by the rxvt core	693	# called by the rxvt core
686	sub invoke {	694	sub invoke {
687	local $TERM = shift;	695	local $TERM = shift;
688	my $htype = shift;	696	my $htype = shift;
689		697
690	if ($htype == 0) { # INIT	698	if ($htype == HOOK_INIT) {
691	my @dirs = $TERM->perl_libdirs;	699	my @dirs = $TERM->perl_libdirs;
		700
		701	$TERM->scan_extensions;
692		702
693	my %ext_arg;	703	my %ext_arg;
694		704
695	{	705	{
696	my @init = @TERM_INIT;	706	my @init = @TERM_INIT;
…		…
700	@TERM_EXT = ();	710	@TERM_EXT = ();
701	$TERM->register_package ($_) for @pkg;	711	$TERM->register_package ($_) for @pkg;
702	}	712	}
703		713
704	for (	714	for (
		715	(grep $_, map { split /,/, $TERM->resource ("perl_ext_$_") } 1, 2),
705	@{ delete $TERM->{perl_ext_3} },	716	@{ delete $TERM->{perl_ext_3} }
706	grep $_, map { split /,/, $TERM->resource ("perl_ext_$_") } 1, 2
707	) {	717	) {
708	if ($_ eq "default") {	718	if ($_ eq "default") {
		719
		720	$ext_arg{$_} = []
709	$ext_arg{$_} \|\|= [] for qw(selection option-popup selection-popup searchable-scrollback readline);	721	for qw(selection option-popup selection-popup readline searchable-scrollback);
		722
		723	for ($TERM->_keysym_resources) {
		724	next if /^(?:string\|command\|builtin\|builtin-string\|perl)/;
		725	next unless /^([A-Za-z0-9_\-]+):/;
		726
		727	my $ext = $1;
		728
		729	$ext_arg{$ext} = [];
		730	}
		731
710	} elsif (/^-(.*)$/) {	732	} elsif (/^-(.*)$/) {
711	delete $ext_arg{$1};	733	delete $ext_arg{$1};
		734
712	} elsif (/^([^<]+)<(.*)>$/) {	735	} elsif (/^([^<]+)<(.*)>$/) {
713	push @{ $ext_arg{$1} }, $2;	736	push @{ $ext_arg{$1} }, $2;
		737
714	} else {	738	} else {
715	$ext_arg{$_} \|\|= [];	739	$ext_arg{$_} \|\|= [];
716	}	740	}
717	}	741	}
718		742
…		…
734		758
735	if (my $cb = $TERM->{_hook}[$htype]) {	759	if (my $cb = $TERM->{_hook}[$htype]) {
736	verbose 10, "$HOOKNAME[$htype] (" . (join ", ", $TERM, @_) . ")"	760	verbose 10, "$HOOKNAME[$htype] (" . (join ", ", $TERM, @_) . ")"
737	if $verbosity >= 10;	761	if $verbosity >= 10;
738		762
		763	if ($htype == HOOK_ACTION) {
		764	# this hook is only sent to the extension with the name
		765	# matching the first arg
		766	my $pkg = shift;
		767	$pkg =~ y/-/_/;
		768	$pkg = "urxvt::ext::$pkg";
		769
		770	$cb = $cb->{$pkg}
		771	or return undef; #TODO: maybe warn user?
		772
		773	$cb = { $pkg => $cb };
		774	}
		775
739	for my $pkg (keys %$cb) {	776	for my $pkg (keys %$cb) {
740	my $retval_ = eval { $cb->{$pkg}->($TERM->{_pkg}{$pkg}, @_) };	777	my $retval_ = eval { $cb->{$pkg}->($TERM->{_pkg}{$pkg} \|\| $TERM, @_) };
741	$retval \|\|= $retval_;	778	$retval \|\|= $retval_;
742		779
743	if ($@) {	780	if ($@) {
744	$TERM->ungrab; # better to lose the grab than the session	781	$TERM->ungrab; # better to lose the grab than the session
745	warn $@;	782	warn $@;
…		…
748		785
749	verbose 11, "$HOOKNAME[$htype] returning <$retval>"	786	verbose 11, "$HOOKNAME[$htype] returning <$retval>"
750	if $verbosity >= 11;	787	if $verbosity >= 11;
751	}	788	}
752		789
753	if ($htype == 1) { # DESTROY	790	if ($htype == HOOK_DESTROY) {
754	# clear package objects	791	# clear package objects
755	%$_ = () for values %{ $TERM->{_pkg} };	792	%$_ = () for values %{ $TERM->{_pkg} };
756		793
757	# clear package	794	# clear package
758	%$TERM = ();	795	%$TERM = ();
…		…
790	($mask, @color{qw(fg bg)}, \@failed)	827	($mask, @color{qw(fg bg)}, \@failed)
791	}	828	}
792		829
793	package urxvt::term::extension;	830	package urxvt::term::extension;
794		831
795	sub enable {	832	=head2 The C<urxvt::term::extension> class
796	my ($self, %hook) = @_;
797	my $pkg = $self->{_pkg};
798		833
799	while (my ($name, $cb) = each %hook) {	834	Each extension attached to a terminal object is represented by
800	my $htype = $HOOKTYPE{uc $name};	835	a C<urxvt::term::extension> object.
801	defined $htype
802	or Carp::croak "unsupported hook type '$name'";
803		836
804	$self->set_should_invoke ($htype, +1)	837	You can use these objects, which are passed to all callbacks to store any
805	unless exists $self->{term}{_hook}[$htype]{$pkg};	838	state related to the terminal and extension instance.
806		839
807	$self->{term}{_hook}[$htype]{$pkg} = $cb;	840	The methods (And data members) documented below can be called on extension
808	}	841	objects, in addition to call methods documented for the <urxvt::term>
809	}	842	class.
810		843
811	sub disable {	844	=over 4
812	my ($self, @hook) = @_;
813	my $pkg = $self->{_pkg};
814		845
815	for my $name (@hook) {	846	=item $urxvt_term = $self->{term}
816	my $htype = $HOOKTYPE{uc $name};
817	defined $htype
818	or Carp::croak "unsupported hook type '$name'";
819		847
820	$self->set_should_invoke ($htype, -1)	848	Returns the C<urxvt::term> object associated with this instance of the
821	if delete $self->{term}{_hook}[$htype]{$pkg};	849	extension. This member I<must not> be changed in any way.
822	}	850
823	}	851	=cut
824		852
825	our $AUTOLOAD;	853	our $AUTOLOAD;
826		854
827	sub AUTOLOAD {	855	sub AUTOLOAD {
828	$AUTOLOAD =~ /:([^:]+)$/	856	$AUTOLOAD =~ /:([^:]+)$/
…		…
841		869
842	sub DESTROY {	870	sub DESTROY {
843	# nop	871	# nop
844	}	872	}
845		873
846	# urxvt::destroy_hook	874	# urxvt::destroy_hook (basically a cheap Guard:: implementation)
847		875
848	sub urxvt::destroy_hook::DESTROY {	876	sub urxvt::destroy_hook::DESTROY {
849	${$_[0]}->();	877	${$_[0]}->();
850	}	878	}
851		879
852	sub urxvt::destroy_hook(&) {	880	sub urxvt::destroy_hook(&) {
853	bless \shift, urxvt::destroy_hook::	881	bless \shift, urxvt::destroy_hook::
		882	}
		883
		884	=item $self->enable ($hook_name => $cb[, $hook_name => $cb..])
		885
		886	Dynamically enable the given hooks (named without the C<on_> prefix) for
		887	this extension, replacing any hook previously installed via C<enable> in
		888	this extension.
		889
		890	This is useful when you want to overwrite time-critical hooks only
		891	temporarily.
		892
		893	To install additional callbacks for the same hook, you can use the C<on>
		894	method of the C<urxvt::term> class.
		895
		896	=item $self->disable ($hook_name[, $hook_name..])
		897
		898	Dynamically disable the given hooks.
		899
		900	=cut
		901
		902	sub enable {
		903	my ($self, %hook) = @_;
		904	my $pkg = $self->{_pkg};
		905
		906	while (my ($name, $cb) = each %hook) {
		907	my $htype = $HOOKTYPE{uc $name};
		908	defined $htype
		909	or Carp::croak "unsupported hook type '$name'";
		910
		911	$self->set_should_invoke ($htype, +1)
		912	unless exists $self->{term}{_hook}[$htype]{$pkg};
		913
		914	$self->{term}{_hook}[$htype]{$pkg} = $cb;
		915	}
		916	}
		917
		918	sub disable {
		919	my ($self, @hook) = @_;
		920	my $pkg = $self->{_pkg};
		921
		922	for my $name (@hook) {
		923	my $htype = $HOOKTYPE{uc $name};
		924	defined $htype
		925	or Carp::croak "unsupported hook type '$name'";
		926
		927	$self->set_should_invoke ($htype, -1)
		928	if delete $self->{term}{_hook}[$htype]{$pkg};
		929	}
		930	}
		931
		932	=item $guard = $self->on ($hook_name => $cb[, $hook_name => $cb..])
		933
		934	Similar to the C<enable> enable, but installs additional callbacks for
		935	the given hook(s) (that is, it doesn't replace existing callbacks), and
		936	returns a guard object. When the guard object is destroyed the callbacks
		937	are disabled again.
		938
		939	=cut
		940
		941	sub urxvt::extension::on_disable::DESTROY {
		942	my $disable = shift;
		943
		944	my $term = delete $disable->{""};
		945
		946	while (my ($htype, $id) = each %$disable) {
		947	delete $term->{_hook}[$htype]{$id};
		948	$term->set_should_invoke ($htype, -1);
		949	}
		950	}
		951
		952	sub on {
		953	my ($self, %hook) = @_;
		954
		955	my $term = $self->{term};
		956
		957	my %disable = ( "" => $term );
		958
		959	while (my ($name, $cb) = each %hook) {
		960	my $htype = $HOOKTYPE{uc $name};
		961	defined $htype
		962	or Carp::croak "unsupported hook type '$name'";
		963
		964	$term->set_should_invoke ($htype, +1);
		965	$term->{_hook}[$htype]{ $disable{$htype} = $cb+0 }
		966	= sub { shift; $cb->($self, @_) }; # very ugly indeed
		967	}
		968
		969	bless \%disable, "urxvt::extension::on_disable"
		970	}
		971
		972	=item $self->bind_action ($hotkey, $action)
		973
		974	=item $self->x_resource ($pattern)
		975
		976	=item $self->x_resource_boolean ($pattern)
		977
		978	These methods support an additional C<%> prefix for C<$action> or
		979	C<$pattern> when called on an extension object, compared to the
		980	C<urxvt::term> methods of the same name - see the description of these
		981	methods in the C<urxvt::term> class for details.
		982
		983	=cut
		984
		985	sub bind_action {
		986	my ($self, $hotkey, $action) = @_;
		987	$action =~ s/^%:/$_[0]{_name}:/;
		988	$self->{term}->bind_action ($hotkey, $action)
854	}	989	}
855		990
856	sub x_resource {	991	sub x_resource {
857	my ($self, $name) = @_;	992	my ($self, $name) = @_;
858	$name =~ s/^%(\.\|$)/$_[0]{_name}$1/;	993	$name =~ s/^%(\.\|$)/$_[0]{_name}$1/;
…		…
862	sub x_resource_boolean {	997	sub x_resource_boolean {
863	my ($self, $name) = @_;	998	my ($self, $name) = @_;
864	$name =~ s/^%(\.\|$)/$_[0]{_name}$1/;	999	$name =~ s/^%(\.\|$)/$_[0]{_name}$1/;
865	$self->{term}->x_resource_boolean ($name)	1000	$self->{term}->x_resource_boolean ($name)
866	}	1001	}
		1002
		1003	=back
		1004
		1005	=cut
867		1006
868	package urxvt::anyevent;	1007	package urxvt::anyevent;
869		1008
870	=head2 The C<urxvt::anyevent> Class	1009	=head2 The C<urxvt::anyevent> Class
871		1010
…		…
990	$ENV{URXVT_PERL_LIB},	1129	$ENV{URXVT_PERL_LIB},
991	"$ENV{HOME}/.urxvt/ext",	1130	"$ENV{HOME}/.urxvt/ext",
992	"$LIBDIR/perl"	1131	"$LIBDIR/perl"
993	}	1132	}
994		1133
995	sub scan_meta {	1134	# scan for available extensions and collect their metadata
		1135	sub scan_extensions {
996	my ($self) = @_;	1136	my ($self) = @_;
		1137
		1138	return if exists $self->{meta};
		1139
997	my @libdirs = perl_libdirs $self;	1140	my @urxvtdirs = perl_libdirs $self;
		1141	# my @cpandirs = grep -d, map "$_/URxvt/Ext", @INC;
998		1142
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;	1143	$self->{meta} = \my %meta;
1005		1144
1006	for my $dir (reverse @libdirs) {	1145	# first gather extensions
		1146
		1147	my $gather = sub {
		1148	my ($dir, $core) = @_;
		1149
1007	opendir my $fh, $dir	1150	opendir my $fh, $dir
1008	or next;	1151	or return;
		1152
1009	for my $ext (readdir $fh) {	1153	for my $ext (readdir $fh) {
1010	$ext ne "."	1154	$ext !~ /^\./
1011	and $ext ne ".."
1012	and open my $fh, "<", "$dir/$ext"
1013	or next;	1155	or next;
1014		1156
		1157	open my $fh, "<", "$dir/$ext"
		1158	or next;
		1159
		1160	-f $fh
		1161	or next;
		1162
		1163	$ext =~ s/\.uext$// or $core
		1164	or next;
		1165
		1166	my %ext = (dir => $dir);
		1167
1015	while (<$fh>) {	1168	while (<$fh>) {
1016	if (/^#:META:X_RESOURCE:(.*)/) {	1169	if (/^#:META:(?:X_)?RESOURCE:(.*)/) {
1017	my ($pattern, $type, $desc) = split /:/, $1;	1170	my ($pattern, $type, $desc) = split /:/, $1;
1018	$pattern =~ s/^%(\.\|$)/$ext$1/g; # % in pattern == extension name	1171	$pattern =~ s/^%(\.\|$)/$ext$1/g; # % in pattern == extension name
1019	if ($pattern =~ /[^a-zA-Z0-9\-\.]/) {	1172	if ($pattern =~ /[^a-zA-Z0-9\-\.]/) {
1020	warn "$dir/$ext: meta resource '$pattern' contains illegal characters (not alphanumeric nor . nor *)\n";	1173	warn "$dir/$ext: meta resource '$pattern' contains illegal characters (not alphanumeric nor . nor *)\n";
1021	} else {	1174	} else {
1022	$meta{resource}{$pattern} = [$ext, $type, $desc];	1175	$ext{resource}{$pattern} = [$ext, $type, $desc];
1023	}	1176	}
1024	} elsif (/^\s*(?:#\|$)/) {	1177	} elsif (/^\s*(?:#\|$)/) {
1025	# skip other comments and empty lines	1178	# skip other comments and empty lines
1026	} else {	1179	} else {
1027	last; # stop parsing on first non-empty non-comment line	1180	last; # stop parsing on first non-empty non-comment line
1028	}	1181	}
1029	}	1182	}
		1183
		1184	$meta{ext}{$ext} = \%ext;
1030	}	1185	}
		1186	};
		1187
		1188	# $gather->($_, 0) for @cpandirs;
		1189	$gather->($_, 1) for @urxvtdirs;
		1190
		1191	# and now merge resources
		1192
		1193	$meta{resource} = \my %resource;
		1194
		1195	while (my ($k, $v) = each %{ $meta{ext} }) {
		1196	#TODO: should check for extensions overriding each other
		1197	%resource = (%resource, %{ $v->{resource} });
1031	}	1198	}
1032	}	1199	}
1033		1200
1034	=item $term = new urxvt::term $envhashref, $rxvtname, [arg...]	1201	=item $term = new urxvt::term $envhashref, $rxvtname, [arg...]
1035		1202
…		…
1055	}	1222	}
1056		1223
1057	=item $term->destroy	1224	=item $term->destroy
1058		1225
1059	Destroy the terminal object (close the window, free resources	1226	Destroy the terminal object (close the window, free resources
1060	etc.). Please note that @@RXVT_NAME@@ will not exit as long as any event	1227	etc.). Please note that urxvt will not exit as long as any event
1061	watchers (timers, io watchers) are still active.	1228	watchers (timers, io watchers) are still active.
1062		1229
1063	=item $term->exec_async ($cmd[, @args])	1230	=item $term->exec_async ($cmd[, @args])
1064		1231
1065	Works like the combination of the C<fork>/C<exec> builtins, which executes	1232	Works like the combination of the C<fork>/C<exec> builtins, which executes
…		…
1121		1288
1122	Here is a likely non-exhaustive list of resource names, not all of which	1289	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>	1290	are supported in every build, please see the source file F</src/rsinc.h>
1124	to see the actual list:	1291	to see the actual list:
1125		1292
1126	answerbackstring backgroundPixmap backspace_key blendtype blurradius	1293	answerbackstring backgroundPixmap backspace_key blurradius
1127	boldFont boldItalicFont borderLess buffered chdir color cursorBlink	1294	boldFont boldItalicFont borderLess buffered chdir color cursorBlink
1128	cursorUnderline cutchars delete_key depth display_name embed ext_bwidth	1295	cursorUnderline cutchars delete_key depth display_name embed ext_bwidth
1129	fade font geometry hold iconName iconfile imFont imLocale inputMethod	1296	fade font geometry hold iconName iconfile imFont imLocale inputMethod
1130	insecure int_bwidth intensityStyles iso14755 iso14755_52 italicFont	1297	insecure int_bwidth intensityStyles iso14755 iso14755_52 italicFont
1131	jumpScroll letterSpace lineSpace loginShell mapAlert meta8 modifier	1298	jumpScroll letterSpace lineSpace loginShell mapAlert meta8 modifier
…		…
1151	Returns the X-Resource for the given pattern, excluding the program or	1318	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	1319	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	1320	same value as used by this instance of rxvt-unicode. Returns C<undef> if no
1154	resource with that pattern exists.	1321	resource with that pattern exists.
1155		1322
1156	Extensions that define extra resource or command line arguments also need	1323	Extensions that define extra resources also need to call this method
1157	to call this method to access their values.	1324	to access their values.
1158		1325
1159	If the method is called on an extension object (basically, from an	1326	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	1327	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	1328	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	1329	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	1330	can rename them and get a new set of resources without having to change
1164	without having to change the actual code.	1331	the actual code.
1165		1332
1166	This method should only be called during the C<on_start> hook, as there is	1333	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	1334	only one resource database per display, and later invocations might return
1168	the wrong resources.	1335	the wrong resources.
1169		1336
…		…
1181	my $res = &x_resource;	1348	my $res = &x_resource;
1182		1349
1183	$res =~ /^\s(?:true\|yes\|on\|1)\s$/i ? 1 : defined $res && 0	1350	$res =~ /^\s(?:true\|yes\|on\|1)\s$/i ? 1 : defined $res && 0
1184	}	1351	}
1185		1352
1186	=item $success = $term->parse_keysym ($key, $octets)	1353	=item $action = $term->lookup_keysym ($keysym, $state)
1187		1354
		1355	Returns the action bound to key combination C<($keysym, $state)>,
		1356	if a binding for it exists, and C<undef> otherwise.
		1357
		1358	=item $success = $term->bind_action ($key, $action)
		1359
1188	Adds a key binding exactly as specified via a resource. See the	1360	Adds a key binding exactly as specified via a C<keysym> resource. See the
1189	C<keysym> resource in the @@RXVT_NAME@@(1) manpage.	1361	C<keysym> resource in the urxvt(1) manpage.
1190		1362
1191	=item $term->register_command ($keysym, $modifiermask, $string)	1363	To add default bindings for actions, an extension should call C<<
		1364	->bind_action >> in its C<init> hook for every such binding. Doing it
		1365	in the C<init> hook allows users to override or remove the binding
		1366	again.
1192		1367
1193	Adds a key binding. This is a lower level api compared to	1368	Example: the C<searchable-scrollback> by default binds itself
1194	C<parse_keysym>, as it expects a parsed key description, and can be	1369	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	1370	$term->bind_action >>.
1196	C<on_register_command> hook, to modify a parsed binding.	1371
		1372	sub init {
		1373	my ($self) = @_;
		1374
		1375	$self->bind_action ("M-s" => "%:start");
		1376	}
1197		1377
1198	=item $rend = $term->rstyle ([$new_rstyle])	1378	=item $rend = $term->rstyle ([$new_rstyle])
1199		1379
1200	Return and optionally change the current rendition. Text that is output by	1380	Return and optionally change the current rendition. Text that is output by
1201	the terminal application will use this style.	1381	the terminal application will use this style.
…		…
1359		1539
1360	=item $term->scr_add_lines ($string)	1540	=item $term->scr_add_lines ($string)
1361		1541
1362	Write the given text string to the screen, as if output by the application	1542	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	1543	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	1544	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.	1545	carriage returns and tabs. The string is a normal text string, not in
		1546	locale-dependent encoding.
1366		1547
1367	Normally its not a good idea to use this function, as programs might be	1548	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	1549	confused by changes in cursor position or scrolling. Its useful inside a
1369	C<on_add_lines> hook, though.	1550	C<on_add_lines> hook, though.
1370		1551
…		…
1378	locale-specific encoding of the terminal and can contain command sequences	1559	locale-specific encoding of the terminal and can contain command sequences
1379	(escape codes) that will be interpreted.	1560	(escape codes) that will be interpreted.
1380		1561
1381	=item $term->tt_write ($octets)	1562	=item $term->tt_write ($octets)
1382		1563
1383	Write the octets given in C<$octets> to the tty (i.e. as program input). To	1564	Write the octets given in C<$octets> to the tty (i.e. as user input
		1565	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	1566	characters instead of octets, you should convert your strings first to the
1385	to the locale-specific encoding using C<< $term->locale_encode >>.	1567	locale-specific encoding using C<< $term->locale_encode >>.
		1568
		1569	=item $term->tt_write_user_input ($octets)
		1570
		1571	Like C<tt_write>, but should be used when writing strings in response to
		1572	the user pressing a key, to invoke the additional actions requested by
		1573	the user for that case (C<tt_write> doesn't do that).
		1574
		1575	The typical use case would be inside C<on_action> hooks.
1386		1576
1387	=item $term->tt_paste ($octets)	1577	=item $term->tt_paste ($octets)
1388		1578
1389	Write the octets given in C<$octets> to the tty as a paste, converting NL to	1579	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	1580	CR and bracketing the data with control sequences if bracketed paste mode
…		…
1429		1619
1430	=item $term->key_release ($state, $keycode[, $time])	1620	=item $term->key_release ($state, $keycode[, $time])
1431		1621
1432	Deliver various fake events to to terminal.	1622	Deliver various fake events to to terminal.
1433		1623
1434	=item $window_width = $term->width	1624	=item $window_width = $term->width ([$new_value])
1435		1625
1436	=item $window_height = $term->height	1626	=item $window_height = $term->height ([$new_value])
1437		1627
1438	=item $font_width = $term->fwidth	1628	=item $font_width = $term->fwidth ([$new_value])
1439		1629
1440	=item $font_height = $term->fheight	1630	=item $font_height = $term->fheight ([$new_value])
1441		1631
1442	=item $font_ascent = $term->fbase	1632	=item $font_ascent = $term->fbase ([$new_value])
1443		1633
1444	=item $terminal_rows = $term->nrow	1634	=item $terminal_rows = $term->nrow ([$new_value])
1445		1635
1446	=item $terminal_columns = $term->ncol	1636	=item $terminal_columns = $term->ncol ([$new_value])
1447		1637
1448	=item $has_focus = $term->focus	1638	=item $has_focus = $term->focus ([$new_value])
1449		1639
1450	=item $is_mapped = $term->mapped	1640	=item $is_mapped = $term->mapped ([$new_value])
1451		1641
1452	=item $max_scrollback = $term->saveLines	1642	=item $max_scrollback = $term->saveLines ([$new_value])
1453		1643
1454	=item $nrow_plus_saveLines = $term->total_rows	1644	=item $nrow_plus_saveLines = $term->total_rows ([$new_value])
1455		1645
1456	=item $topmost_scrollback_row = $term->top_row	1646	=item $topmost_scrollback_row = $term->top_row ([$new_value])
1457		1647
1458	Return various integers describing terminal characteristics.	1648	Return various integers describing terminal characteristics. If an
		1649	argument is given, changes the value and returns the previous one.
1459		1650
1460	=item $x_display = $term->display_id	1651	=item $x_display = $term->display_id
1461		1652
1462	Return the DISPLAY used by rxvt-unicode.	1653	Return the DISPLAY used by rxvt-unicode.
1463		1654
…		…
1513	Requests a screen refresh. At the next opportunity, rxvt-unicode will	1704	Requests a screen refresh. At the next opportunity, rxvt-unicode will
1514	compare the on-screen display with its stored representation. If they	1705	compare the on-screen display with its stored representation. If they
1515	differ, it redraws the differences.	1706	differ, it redraws the differences.
1516		1707
1517	Used after changing terminal contents to display them.	1708	Used after changing terminal contents to display them.
		1709
		1710	=item $term->refresh_check
		1711
		1712	Checks if a refresh has been requested and, if so, schedules one.
1518		1713
1519	=item $text = $term->ROW_t ($row_number[, $new_text[, $start_col]])	1714	=item $text = $term->ROW_t ($row_number[, $new_text[, $start_col]])
1520		1715
1521	Returns the text of the entire row with number C<$row_number>. Row C<< $term->top_row >>	1716	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	1717	is the topmost terminal line, row C<< $term->nrow-1 >> is the bottommost
…		…
1624	}	1819	}
1625		1820
1626	sub urxvt::line::t {	1821	sub urxvt::line::t {
1627	my ($self) = @_;	1822	my ($self) = @_;
1628		1823
1629	if (@_ > 1)	1824	if (@_ > 1) {
1630	{
1631	$self->{term}->ROW_t ($_, $_[1], 0, ($_ - $self->{beg}) * $self->{ncol}, $self->{ncol})	1825	$self->{term}->ROW_t ($_, $_[1], 0, ($_ - $self->{beg}) * $self->{ncol}, $self->{ncol})
1632	for $self->{beg} .. $self->{end};	1826	for $self->{beg} .. $self->{end};
1633	}	1827	}
1634		1828
1635	defined wantarray &&	1829	defined wantarray &&
1636	substr +(join "", map $self->{term}->ROW_t ($_), $self->{beg} .. $self->{end}),	1830	substr +(join "", map $self->{term}->ROW_t ($_), $self->{beg} .. $self->{end}),
1637	0, $self->{len}	1831	0, $self->{len}
1638	}	1832	}
1639		1833
1640	sub urxvt::line::r {	1834	sub urxvt::line::r {
1641	my ($self) = @_;	1835	my ($self) = @_;
1642		1836
1643	if (@_ > 1)	1837	if (@_ > 1) {
1644	{
1645	$self->{term}->ROW_r ($_, $_[1], 0, ($_ - $self->{beg}) * $self->{ncol}, $self->{ncol})	1838	$self->{term}->ROW_r ($_, $_[1], 0, ($_ - $self->{beg}) * $self->{ncol}, $self->{ncol})
1646	for $self->{beg} .. $self->{end};	1839	for $self->{beg} .. $self->{end};
1647	}	1840	}
1648		1841
1649	if (defined wantarray) {	1842	if (defined wantarray) {
1650	my $rend = [	1843	my $rend = [
1651	map @{ $self->{term}->ROW_r ($_) }, $self->{beg} .. $self->{end}	1844	map @{ $self->{term}->ROW_r ($_) }, $self->{beg} .. $self->{end}
1652	];	1845	];

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.256 by sf-exg, Thu Jul 14 05:10:06 2016 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.256 by sf-exg, Thu Jul 14 05:10:06 2016 UTC