[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.257 by root, Thu Jul 13 10:31:27 2017 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
…		…
507	ConfigureRequest, GravityNotify, ResizeRequest, CirculateNotify,	511	ConfigureRequest, GravityNotify, ResizeRequest, CirculateNotify,
508	CirculateRequest, PropertyNotify, SelectionClear, SelectionRequest,	512	CirculateRequest, PropertyNotify, SelectionClear, SelectionRequest,
509	SelectionNotify, ColormapNotify, ClientMessage, MappingNotify	513	SelectionNotify, ColormapNotify, ClientMessage, MappingNotify
510		514
511	Various constants for use in X calls and event processing.	515	Various constants for use in X calls and event processing.
		516
		517	=item urxvt::PrivMode_132, PrivMode_132OK, PrivMode_rVideo, PrivMode_relOrigin,
		518	PrivMode_Screen, PrivMode_Autowrap, PrivMode_aplCUR, PrivMode_aplKP,
		519	PrivMode_HaveBackSpace, PrivMode_BackSpace, PrivMode_ShiftKeys,
		520	PrivMode_VisibleCursor, PrivMode_MouseX10, PrivMode_MouseX11,
		521	PrivMode_scrollBar, PrivMode_TtyOutputInh, PrivMode_Keypress,
		522	PrivMode_smoothScroll, PrivMode_vt52, PrivMode_LFNL, PrivMode_MouseBtnEvent,
		523	PrivMode_MouseAnyEvent, PrivMode_BracketPaste, PrivMode_ExtModeMouse,
		524	PrivMode_ExtMouseRight, PrivMode_BlinkingCursor, PrivMode_mouse_report,
		525	PrivMode_Default
		526
		527	Constants for checking DEC private modes.
512		528
513	=back	529	=back
514		530
515	=head2 RENDITION	531	=head2 RENDITION
516		532
…		…
582	no warnings 'utf8';	598	no warnings 'utf8';
583		599
584	sub parse_resource {	600	sub parse_resource {
585	my ($term, $name, $isarg, $longopt, $flag, $value) = @_;	601	my ($term, $name, $isarg, $longopt, $flag, $value) = @_;
586		602
587	$name =~ y/-/./ if $isarg;
588
589	$term->scan_meta;	603	$term->scan_extensions;
590		604
591	my $r = $term->{meta}{resource};	605	my $r = $term->{meta}{resource};
592	keys %$r; # reste iterator	606	keys %$r; # reset iterator
593	while (my ($pattern, $v) = each %$r) {	607	while (my ($k, $v) = each %$r) {
594	if (	608	my $pattern = $k;
		609	$pattern =~ y/./-/ if $isarg;
		610	my $prefix = $name;
		611	my $suffix;
595	$pattern =~ /\.$/	612	if ($pattern =~ /\-$/) {
596	? $pattern eq substr $name, 0, length $pattern	613	$prefix = substr $name, 0, length $pattern;
597	: $pattern eq $name	614	$suffix = substr $name, length $pattern;
598	) {	615	}
		616	if ($pattern eq $prefix) {
599	$name = "$urxvt::RESCLASS.$name";	617	$name = "$urxvt::RESCLASS.$k$suffix";
600		618
601	push @{ $term->{perl_ext_3} }, $v->[0];	619	push @{ $term->{perl_ext_3} }, $v->[0];
		620
		621	return 1 unless $isarg;
602		622
603	if ($v->[1] eq "boolean") {	623	if ($v->[1] eq "boolean") {
604	$term->put_option_db ($name, $flag ? "true" : "false");	624	$term->put_option_db ($name, $flag ? "true" : "false");
605	return 1;	625	return 1;
606	} else {	626	} else {
…		…
614	}	634	}
615		635
616	sub usage {	636	sub usage {
617	my ($term, $usage_type) = @_;	637	my ($term, $usage_type) = @_;
618		638
619	$term->scan_meta;	639	$term->scan_extensions;
620		640
621	my $r = $term->{meta}{resource};	641	my $r = $term->{meta}{resource};
622		642
623	for my $pattern (sort keys %$r) {	643	for my $pattern (sort keys %$r) {
624	my ($ext, $type, $desc) = @{ $r->{$pattern} };	644	my ($ext, $type, $desc) = @{ $r->{$pattern} };
…		…
685	# called by the rxvt core	705	# called by the rxvt core
686	sub invoke {	706	sub invoke {
687	local $TERM = shift;	707	local $TERM = shift;
688	my $htype = shift;	708	my $htype = shift;
689		709
690	if ($htype == 0) { # INIT	710	if ($htype == HOOK_INIT) {
691	my @dirs = $TERM->perl_libdirs;	711	my @dirs = $TERM->perl_libdirs;
		712
		713	$TERM->scan_extensions;
692		714
693	my %ext_arg;	715	my %ext_arg;
694		716
695	{	717	{
696	my @init = @TERM_INIT;	718	my @init = @TERM_INIT;
…		…
700	@TERM_EXT = ();	722	@TERM_EXT = ();
701	$TERM->register_package ($_) for @pkg;	723	$TERM->register_package ($_) for @pkg;
702	}	724	}
703		725
704	for (	726	for (
		727	(grep $_, map { split /,/, $TERM->resource ("perl_ext_$_") } 1, 2),
705	@{ delete $TERM->{perl_ext_3} },	728	@{ delete $TERM->{perl_ext_3} }
706	grep $_, map { split /,/, $TERM->resource ("perl_ext_$_") } 1, 2
707	) {	729	) {
708	if ($_ eq "default") {	730	if ($_ eq "default") {
		731
		732	$ext_arg{$_} = []
709	$ext_arg{$_} \|\|= [] for qw(selection option-popup selection-popup searchable-scrollback readline);	733	for qw(selection option-popup selection-popup readline searchable-scrollback);
		734
		735	for ($TERM->_keysym_resources) {
		736	next if /^(?:string\|command\|builtin\|builtin-string\|perl)/;
		737	next unless /^([A-Za-z0-9_\-]+):/;
		738
		739	my $ext = $1;
		740
		741	$ext_arg{$ext} = [];
		742	}
		743
710	} elsif (/^-(.*)$/) {	744	} elsif (/^-(.*)$/) {
711	delete $ext_arg{$1};	745	delete $ext_arg{$1};
		746
712	} elsif (/^([^<]+)<(.*)>$/) {	747	} elsif (/^([^<]+)<(.*)>$/) {
713	push @{ $ext_arg{$1} }, $2;	748	push @{ $ext_arg{$1} }, $2;
		749
714	} else {	750	} else {
715	$ext_arg{$_} \|\|= [];	751	$ext_arg{$_} \|\|= [];
716	}	752	}
717	}	753	}
718		754
…		…
734		770
735	if (my $cb = $TERM->{_hook}[$htype]) {	771	if (my $cb = $TERM->{_hook}[$htype]) {
736	verbose 10, "$HOOKNAME[$htype] (" . (join ", ", $TERM, @_) . ")"	772	verbose 10, "$HOOKNAME[$htype] (" . (join ", ", $TERM, @_) . ")"
737	if $verbosity >= 10;	773	if $verbosity >= 10;
738		774
		775	if ($htype == HOOK_ACTION) {
		776	# this hook is only sent to the extension with the name
		777	# matching the first arg
		778	my $pkg = shift;
		779	$pkg =~ y/-/_/;
		780	$pkg = "urxvt::ext::$pkg";
		781
		782	$cb = $cb->{$pkg}
		783	or return undef; #TODO: maybe warn user?
		784
		785	$cb = { $pkg => $cb };
		786	}
		787
739	for my $pkg (keys %$cb) {	788	for my $pkg (keys %$cb) {
740	my $retval_ = eval { $cb->{$pkg}->($TERM->{_pkg}{$pkg}, @_) };	789	my $retval_ = eval { $cb->{$pkg}->($TERM->{_pkg}{$pkg} \|\| $TERM, @_) };
741	$retval \|\|= $retval_;	790	$retval \|\|= $retval_;
742		791
743	if ($@) {	792	if ($@) {
744	$TERM->ungrab; # better to lose the grab than the session	793	$TERM->ungrab; # better to lose the grab than the session
745	warn $@;	794	warn $@;
…		…
748		797
749	verbose 11, "$HOOKNAME[$htype] returning <$retval>"	798	verbose 11, "$HOOKNAME[$htype] returning <$retval>"
750	if $verbosity >= 11;	799	if $verbosity >= 11;
751	}	800	}
752		801
753	if ($htype == 1) { # DESTROY	802	if ($htype == HOOK_DESTROY) {
754	# clear package objects	803	# clear package objects
755	%$_ = () for values %{ $TERM->{_pkg} };	804	%$_ = () for values %{ $TERM->{_pkg} };
756		805
757	# clear package	806	# clear package
758	%$TERM = ();	807	%$TERM = ();
…		…
790	($mask, @color{qw(fg bg)}, \@failed)	839	($mask, @color{qw(fg bg)}, \@failed)
791	}	840	}
792		841
793	package urxvt::term::extension;	842	package urxvt::term::extension;
794		843
795	sub enable {	844	=head2 The C<urxvt::term::extension> class
796	my ($self, %hook) = @_;
797	my $pkg = $self->{_pkg};
798		845
799	while (my ($name, $cb) = each %hook) {	846	Each extension attached to a terminal object is represented by
800	my $htype = $HOOKTYPE{uc $name};	847	a C<urxvt::term::extension> object.
801	defined $htype
802	or Carp::croak "unsupported hook type '$name'";
803		848
804	$self->set_should_invoke ($htype, +1)	849	You can use these objects, which are passed to all callbacks to store any
805	unless exists $self->{term}{_hook}[$htype]{$pkg};	850	state related to the terminal and extension instance.
806		851
807	$self->{term}{_hook}[$htype]{$pkg} = $cb;	852	The methods (And data members) documented below can be called on extension
808	}	853	objects, in addition to call methods documented for the <urxvt::term>
809	}	854	class.
810		855
811	sub disable {	856	=over 4
812	my ($self, @hook) = @_;
813	my $pkg = $self->{_pkg};
814		857
815	for my $name (@hook) {	858	=item $urxvt_term = $self->{term}
816	my $htype = $HOOKTYPE{uc $name};
817	defined $htype
818	or Carp::croak "unsupported hook type '$name'";
819		859
820	$self->set_should_invoke ($htype, -1)	860	Returns the C<urxvt::term> object associated with this instance of the
821	if delete $self->{term}{_hook}[$htype]{$pkg};	861	extension. This member I<must not> be changed in any way.
822	}	862
823	}	863	=cut
824		864
825	our $AUTOLOAD;	865	our $AUTOLOAD;
826		866
827	sub AUTOLOAD {	867	sub AUTOLOAD {
828	$AUTOLOAD =~ /:([^:]+)$/	868	$AUTOLOAD =~ /:([^:]+)$/
…		…
841		881
842	sub DESTROY {	882	sub DESTROY {
843	# nop	883	# nop
844	}	884	}
845		885
846	# urxvt::destroy_hook	886	# urxvt::destroy_hook (basically a cheap Guard:: implementation)
847		887
848	sub urxvt::destroy_hook::DESTROY {	888	sub urxvt::destroy_hook::DESTROY {
849	${$_[0]}->();	889	${$_[0]}->();
850	}	890	}
851		891
852	sub urxvt::destroy_hook(&) {	892	sub urxvt::destroy_hook(&) {
853	bless \shift, urxvt::destroy_hook::	893	bless \shift, urxvt::destroy_hook::
		894	}
		895
		896	=item $self->enable ($hook_name => $cb[, $hook_name => $cb..])
		897
		898	Dynamically enable the given hooks (named without the C<on_> prefix) for
		899	this extension, replacing any hook previously installed via C<enable> in
		900	this extension.
		901
		902	This is useful when you want to overwrite time-critical hooks only
		903	temporarily.
		904
		905	To install additional callbacks for the same hook, you can use the C<on>
		906	method of the C<urxvt::term> class.
		907
		908	=item $self->disable ($hook_name[, $hook_name..])
		909
		910	Dynamically disable the given hooks.
		911
		912	=cut
		913
		914	sub enable {
		915	my ($self, %hook) = @_;
		916	my $pkg = $self->{_pkg};
		917
		918	while (my ($name, $cb) = each %hook) {
		919	my $htype = $HOOKTYPE{uc $name};
		920	defined $htype
		921	or Carp::croak "unsupported hook type '$name'";
		922
		923	$self->set_should_invoke ($htype, +1)
		924	unless exists $self->{term}{_hook}[$htype]{$pkg};
		925
		926	$self->{term}{_hook}[$htype]{$pkg} = $cb;
		927	}
		928	}
		929
		930	sub disable {
		931	my ($self, @hook) = @_;
		932	my $pkg = $self->{_pkg};
		933
		934	for my $name (@hook) {
		935	my $htype = $HOOKTYPE{uc $name};
		936	defined $htype
		937	or Carp::croak "unsupported hook type '$name'";
		938
		939	$self->set_should_invoke ($htype, -1)
		940	if delete $self->{term}{_hook}[$htype]{$pkg};
		941	}
		942	}
		943
		944	=item $guard = $self->on ($hook_name => $cb[, $hook_name => $cb..])
		945
		946	Similar to the C<enable> enable, but installs additional callbacks for
		947	the given hook(s) (that is, it doesn't replace existing callbacks), and
		948	returns a guard object. When the guard object is destroyed the callbacks
		949	are disabled again.
		950
		951	=cut
		952
		953	sub urxvt::extension::on_disable::DESTROY {
		954	my $disable = shift;
		955
		956	my $term = delete $disable->{""};
		957
		958	while (my ($htype, $id) = each %$disable) {
		959	delete $term->{_hook}[$htype]{$id};
		960	$term->set_should_invoke ($htype, -1);
		961	}
		962	}
		963
		964	sub on {
		965	my ($self, %hook) = @_;
		966
		967	my $term = $self->{term};
		968
		969	my %disable = ( "" => $term );
		970
		971	while (my ($name, $cb) = each %hook) {
		972	my $htype = $HOOKTYPE{uc $name};
		973	defined $htype
		974	or Carp::croak "unsupported hook type '$name'";
		975
		976	$term->set_should_invoke ($htype, +1);
		977	$term->{_hook}[$htype]{ $disable{$htype} = $cb+0 }
		978	= sub { shift; $cb->($self, @_) }; # very ugly indeed
		979	}
		980
		981	bless \%disable, "urxvt::extension::on_disable"
		982	}
		983
		984	=item $self->bind_action ($hotkey, $action)
		985
		986	=item $self->x_resource ($pattern)
		987
		988	=item $self->x_resource_boolean ($pattern)
		989
		990	These methods support an additional C<%> prefix for C<$action> or
		991	C<$pattern> when called on an extension object, compared to the
		992	C<urxvt::term> methods of the same name - see the description of these
		993	methods in the C<urxvt::term> class for details.
		994
		995	=cut
		996
		997	sub bind_action {
		998	my ($self, $hotkey, $action) = @_;
		999	$action =~ s/^%:/$_[0]{_name}:/;
		1000	$self->{term}->bind_action ($hotkey, $action)
854	}	1001	}
855		1002
856	sub x_resource {	1003	sub x_resource {
857	my ($self, $name) = @_;	1004	my ($self, $name) = @_;
858	$name =~ s/^%(\.\|$)/$_[0]{_name}$1/;	1005	$name =~ s/^%(\.\|$)/$_[0]{_name}$1/;
…		…
862	sub x_resource_boolean {	1009	sub x_resource_boolean {
863	my ($self, $name) = @_;	1010	my ($self, $name) = @_;
864	$name =~ s/^%(\.\|$)/$_[0]{_name}$1/;	1011	$name =~ s/^%(\.\|$)/$_[0]{_name}$1/;
865	$self->{term}->x_resource_boolean ($name)	1012	$self->{term}->x_resource_boolean ($name)
866	}	1013	}
		1014
		1015	=back
		1016
		1017	=cut
867		1018
868	package urxvt::anyevent;	1019	package urxvt::anyevent;
869		1020
870	=head2 The C<urxvt::anyevent> Class	1021	=head2 The C<urxvt::anyevent> Class
871		1022
…		…
990	$ENV{URXVT_PERL_LIB},	1141	$ENV{URXVT_PERL_LIB},
991	"$ENV{HOME}/.urxvt/ext",	1142	"$ENV{HOME}/.urxvt/ext",
992	"$LIBDIR/perl"	1143	"$LIBDIR/perl"
993	}	1144	}
994		1145
995	sub scan_meta {	1146	# scan for available extensions and collect their metadata
		1147	sub scan_extensions {
996	my ($self) = @_;	1148	my ($self) = @_;
		1149
		1150	return if exists $self->{meta};
		1151
997	my @libdirs = perl_libdirs $self;	1152	my @urxvtdirs = perl_libdirs $self;
		1153	# my @cpandirs = grep -d, map "$_/URxvt/Ext", @INC;
998		1154
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;	1155	$self->{meta} = \my %meta;
1005		1156
1006	for my $dir (reverse @libdirs) {	1157	# first gather extensions
		1158
		1159	my $gather = sub {
		1160	my ($dir, $core) = @_;
		1161
1007	opendir my $fh, $dir	1162	opendir my $fh, $dir
1008	or next;	1163	or return;
		1164
1009	for my $ext (readdir $fh) {	1165	for my $ext (readdir $fh) {
1010	$ext ne "."	1166	$ext !~ /^\./
1011	and $ext ne ".."
1012	and open my $fh, "<", "$dir/$ext"
1013	or next;	1167	or next;
1014		1168
		1169	open my $fh, "<", "$dir/$ext"
		1170	or next;
		1171
		1172	-f $fh
		1173	or next;
		1174
		1175	$ext =~ s/\.uext$// or $core
		1176	or next;
		1177
		1178	my %ext = (dir => $dir);
		1179
1015	while (<$fh>) {	1180	while (<$fh>) {
1016	if (/^#:META:X_RESOURCE:(.*)/) {	1181	if (/^#:META:(?:X_)?RESOURCE:(.*)/) {
1017	my ($pattern, $type, $desc) = split /:/, $1;	1182	my ($pattern, $type, $desc) = split /:/, $1;
1018	$pattern =~ s/^%(\.\|$)/$ext$1/g; # % in pattern == extension name	1183	$pattern =~ s/^%(\.\|$)/$ext$1/g; # % in pattern == extension name
1019	if ($pattern =~ /[^a-zA-Z0-9\-\.]/) {	1184	if ($pattern =~ /[^a-zA-Z0-9\-\.]/) {
1020	warn "$dir/$ext: meta resource '$pattern' contains illegal characters (not alphanumeric nor . nor *)\n";	1185	warn "$dir/$ext: meta resource '$pattern' contains illegal characters (not alphanumeric nor . nor *)\n";
1021	} else {	1186	} else {
1022	$meta{resource}{$pattern} = [$ext, $type, $desc];	1187	$ext{resource}{$pattern} = [$ext, $type, $desc];
1023	}	1188	}
1024	} elsif (/^\s*(?:#\|$)/) {	1189	} elsif (/^\s*(?:#\|$)/) {
1025	# skip other comments and empty lines	1190	# skip other comments and empty lines
1026	} else {	1191	} else {
1027	last; # stop parsing on first non-empty non-comment line	1192	last; # stop parsing on first non-empty non-comment line
1028	}	1193	}
1029	}	1194	}
		1195
		1196	$meta{ext}{$ext} = \%ext;
1030	}	1197	}
		1198	};
		1199
		1200	# $gather->($_, 0) for @cpandirs;
		1201	$gather->($_, 1) for @urxvtdirs;
		1202
		1203	# and now merge resources
		1204
		1205	$meta{resource} = \my %resource;
		1206
		1207	while (my ($k, $v) = each %{ $meta{ext} }) {
		1208	#TODO: should check for extensions overriding each other
		1209	%resource = (%resource, %{ $v->{resource} });
1031	}	1210	}
1032	}	1211	}
1033		1212
1034	=item $term = new urxvt::term $envhashref, $rxvtname, [arg...]	1213	=item $term = new urxvt::term $envhashref, $rxvtname, [arg...]
1035		1214
…		…
1055	}	1234	}
1056		1235
1057	=item $term->destroy	1236	=item $term->destroy
1058		1237
1059	Destroy the terminal object (close the window, free resources	1238	Destroy the terminal object (close the window, free resources
1060	etc.). Please note that @@RXVT_NAME@@ will not exit as long as any event	1239	etc.). Please note that urxvt will not exit as long as any event
1061	watchers (timers, io watchers) are still active.	1240	watchers (timers, io watchers) are still active.
1062		1241
1063	=item $term->exec_async ($cmd[, @args])	1242	=item $term->exec_async ($cmd[, @args])
1064		1243
1065	Works like the combination of the C<fork>/C<exec> builtins, which executes	1244	Works like the combination of the C<fork>/C<exec> builtins, which executes
…		…
1121		1300
1122	Here is a likely non-exhaustive list of resource names, not all of which	1301	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>	1302	are supported in every build, please see the source file F</src/rsinc.h>
1124	to see the actual list:	1303	to see the actual list:
1125		1304
1126	answerbackstring backgroundPixmap backspace_key blendtype blurradius	1305	answerbackstring backgroundPixmap backspace_key blurradius
1127	boldFont boldItalicFont borderLess buffered chdir color cursorBlink	1306	boldFont boldItalicFont borderLess buffered chdir color cursorBlink
1128	cursorUnderline cutchars delete_key depth display_name embed ext_bwidth	1307	cursorUnderline cutchars delete_key depth display_name embed ext_bwidth
1129	fade font geometry hold iconName iconfile imFont imLocale inputMethod	1308	fade font geometry hold iconName iconfile imFont imLocale inputMethod
1130	insecure int_bwidth intensityStyles iso14755 iso14755_52 italicFont	1309	insecure int_bwidth intensityStyles iso14755 iso14755_52 italicFont
1131	jumpScroll letterSpace lineSpace loginShell mapAlert meta8 modifier	1310	jumpScroll letterSpace lineSpace loginShell mapAlert meta8 modifier
…		…
1151	Returns the X-Resource for the given pattern, excluding the program or	1330	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	1331	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	1332	same value as used by this instance of rxvt-unicode. Returns C<undef> if no
1154	resource with that pattern exists.	1333	resource with that pattern exists.
1155		1334
1156	Extensions that define extra resource or command line arguments also need	1335	Extensions that define extra resources also need to call this method
1157	to call this method to access their values.	1336	to access their values.
1158		1337
1159	If the method is called on an extension object (basically, from an	1338	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	1339	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	1340	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	1341	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	1342	can rename them and get a new set of resources without having to change
1164	without having to change the actual code.	1343	the actual code.
1165		1344
1166	This method should only be called during the C<on_start> hook, as there is	1345	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	1346	only one resource database per display, and later invocations might return
1168	the wrong resources.	1347	the wrong resources.
1169		1348
…		…
1181	my $res = &x_resource;	1360	my $res = &x_resource;
1182		1361
1183	$res =~ /^\s(?:true\|yes\|on\|1)\s$/i ? 1 : defined $res && 0	1362	$res =~ /^\s(?:true\|yes\|on\|1)\s$/i ? 1 : defined $res && 0
1184	}	1363	}
1185		1364
1186	=item $success = $term->parse_keysym ($key, $octets)	1365	=item $action = $term->lookup_keysym ($keysym, $state)
1187		1366
		1367	Returns the action bound to key combination C<($keysym, $state)>,
		1368	if a binding for it exists, and C<undef> otherwise.
		1369
		1370	=item $success = $term->bind_action ($key, $action)
		1371
1188	Adds a key binding exactly as specified via a resource. See the	1372	Adds a key binding exactly as specified via a C<keysym> resource. See the
1189	C<keysym> resource in the @@RXVT_NAME@@(1) manpage.	1373	C<keysym> resource in the urxvt(1) manpage.
1190		1374
1191	=item $term->register_command ($keysym, $modifiermask, $string)	1375	To add default bindings for actions, an extension should call C<<
		1376	->bind_action >> in its C<init> hook for every such binding. Doing it
		1377	in the C<init> hook allows users to override or remove the binding
		1378	again.
1192		1379
1193	Adds a key binding. This is a lower level api compared to	1380	Example: the C<searchable-scrollback> by default binds itself
1194	C<parse_keysym>, as it expects a parsed key description, and can be	1381	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	1382	$term->bind_action >>.
1196	C<on_register_command> hook, to modify a parsed binding.	1383
		1384	sub init {
		1385	my ($self) = @_;
		1386
		1387	$self->bind_action ("M-s" => "%:start");
		1388	}
1197		1389
1198	=item $rend = $term->rstyle ([$new_rstyle])	1390	=item $rend = $term->rstyle ([$new_rstyle])
1199		1391
1200	Return and optionally change the current rendition. Text that is output by	1392	Return and optionally change the current rendition. Text that is output by
1201	the terminal application will use this style.	1393	the terminal application will use this style.
…		…
1359		1551
1360	=item $term->scr_add_lines ($string)	1552	=item $term->scr_add_lines ($string)
1361		1553
1362	Write the given text string to the screen, as if output by the application	1554	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	1555	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	1556	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.	1557	carriage returns and tabs. The string is a normal text string, not in
		1558	locale-dependent encoding.
1366		1559
1367	Normally its not a good idea to use this function, as programs might be	1560	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	1561	confused by changes in cursor position or scrolling. Its useful inside a
1369	C<on_add_lines> hook, though.	1562	C<on_add_lines> hook, though.
1370		1563
…		…
1378	locale-specific encoding of the terminal and can contain command sequences	1571	locale-specific encoding of the terminal and can contain command sequences
1379	(escape codes) that will be interpreted.	1572	(escape codes) that will be interpreted.
1380		1573
1381	=item $term->tt_write ($octets)	1574	=item $term->tt_write ($octets)
1382		1575
1383	Write the octets given in C<$octets> to the tty (i.e. as program input). To	1576	Write the octets given in C<$octets> to the tty (i.e. as user input
		1577	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	1578	characters instead of octets, you should convert your strings first to the
1385	to the locale-specific encoding using C<< $term->locale_encode >>.	1579	locale-specific encoding using C<< $term->locale_encode >>.
		1580
		1581	=item $term->tt_write_user_input ($octets)
		1582
		1583	Like C<tt_write>, but should be used when writing strings in response to
		1584	the user pressing a key, to invoke the additional actions requested by
		1585	the user for that case (C<tt_write> doesn't do that).
		1586
		1587	The typical use case would be inside C<on_action> hooks.
1386		1588
1387	=item $term->tt_paste ($octets)	1589	=item $term->tt_paste ($octets)
1388		1590
1389	Write the octets given in C<$octets> to the tty as a paste, converting NL to	1591	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	1592	CR and bracketing the data with control sequences if bracketed paste mode
…		…
1429		1631
1430	=item $term->key_release ($state, $keycode[, $time])	1632	=item $term->key_release ($state, $keycode[, $time])
1431		1633
1432	Deliver various fake events to to terminal.	1634	Deliver various fake events to to terminal.
1433		1635
1434	=item $window_width = $term->width	1636	=item $window_width = $term->width ([$new_value])
1435		1637
1436	=item $window_height = $term->height	1638	=item $window_height = $term->height ([$new_value])
1437		1639
1438	=item $font_width = $term->fwidth	1640	=item $font_width = $term->fwidth ([$new_value])
1439		1641
1440	=item $font_height = $term->fheight	1642	=item $font_height = $term->fheight ([$new_value])
1441		1643
1442	=item $font_ascent = $term->fbase	1644	=item $font_ascent = $term->fbase ([$new_value])
1443		1645
1444	=item $terminal_rows = $term->nrow	1646	=item $terminal_rows = $term->nrow ([$new_value])
1445		1647
1446	=item $terminal_columns = $term->ncol	1648	=item $terminal_columns = $term->ncol ([$new_value])
1447		1649
1448	=item $has_focus = $term->focus	1650	=item $has_focus = $term->focus ([$new_value])
1449		1651
1450	=item $is_mapped = $term->mapped	1652	=item $is_mapped = $term->mapped ([$new_value])
1451		1653
1452	=item $max_scrollback = $term->saveLines	1654	=item $max_scrollback = $term->saveLines ([$new_value])
1453		1655
1454	=item $nrow_plus_saveLines = $term->total_rows	1656	=item $nrow_plus_saveLines = $term->total_rows ([$new_value])
1455		1657
1456	=item $topmost_scrollback_row = $term->top_row	1658	=item $topmost_scrollback_row = $term->top_row ([$new_value])
1457		1659
1458	Return various integers describing terminal characteristics.	1660	Return various integers describing terminal characteristics. If an
		1661	argument is given, changes the value and returns the previous one.
1459		1662
1460	=item $x_display = $term->display_id	1663	=item $x_display = $term->display_id
1461		1664
1462	Return the DISPLAY used by rxvt-unicode.	1665	Return the DISPLAY used by rxvt-unicode.
1463		1666
…		…
1499	Returns the currently displayed screen (0 primary, 1 secondary).	1702	Returns the currently displayed screen (0 primary, 1 secondary).
1500		1703
1501	=item $cursor_is_hidden = $term->hidden_cursor	1704	=item $cursor_is_hidden = $term->hidden_cursor
1502		1705
1503	Returns whether the cursor is currently hidden or not.	1706	Returns whether the cursor is currently hidden or not.
		1707
		1708	=item $priv_modes = $term->priv_modes
		1709
		1710	Returns a bitset with the state of DEC private modes.
		1711
		1712	Example:
		1713
		1714	if ($term->priv_modes & urxvt::PrivMode_mouse_report) {
		1715	# mouse reporting is turned on
		1716	}
1504		1717
1505	=item $view_start = $term->view_start ([$newvalue])	1718	=item $view_start = $term->view_start ([$newvalue])
1506		1719
1507	Returns the row number of the topmost displayed line. Maximum value is	1720	Returns the row number of the topmost displayed line. Maximum value is
1508	C<0>, which displays the normal terminal contents. Lower values scroll	1721	C<0>, which displays the normal terminal contents. Lower values scroll
…		…
1513	Requests a screen refresh. At the next opportunity, rxvt-unicode will	1726	Requests a screen refresh. At the next opportunity, rxvt-unicode will
1514	compare the on-screen display with its stored representation. If they	1727	compare the on-screen display with its stored representation. If they
1515	differ, it redraws the differences.	1728	differ, it redraws the differences.
1516		1729
1517	Used after changing terminal contents to display them.	1730	Used after changing terminal contents to display them.
		1731
		1732	=item $term->refresh_check
		1733
		1734	Checks if a refresh has been requested and, if so, schedules one.
1518		1735
1519	=item $text = $term->ROW_t ($row_number[, $new_text[, $start_col]])	1736	=item $text = $term->ROW_t ($row_number[, $new_text[, $start_col]])
1520		1737
1521	Returns the text of the entire row with number C<$row_number>. Row C<< $term->top_row >>	1738	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	1739	is the topmost terminal line, row C<< $term->nrow-1 >> is the bottommost
…		…
1624	}	1841	}
1625		1842
1626	sub urxvt::line::t {	1843	sub urxvt::line::t {
1627	my ($self) = @_;	1844	my ($self) = @_;
1628		1845
1629	if (@_ > 1)	1846	if (@_ > 1) {
1630	{
1631	$self->{term}->ROW_t ($_, $_[1], 0, ($_ - $self->{beg}) * $self->{ncol}, $self->{ncol})	1847	$self->{term}->ROW_t ($_, $_[1], 0, ($_ - $self->{beg}) * $self->{ncol}, $self->{ncol})
1632	for $self->{beg} .. $self->{end};	1848	for $self->{beg} .. $self->{end};
1633	}	1849	}
1634		1850
1635	defined wantarray &&	1851	defined wantarray &&
1636	substr +(join "", map $self->{term}->ROW_t ($_), $self->{beg} .. $self->{end}),	1852	substr +(join "", map $self->{term}->ROW_t ($_), $self->{beg} .. $self->{end}),
1637	0, $self->{len}	1853	0, $self->{len}
1638	}	1854	}
1639		1855
1640	sub urxvt::line::r {	1856	sub urxvt::line::r {
1641	my ($self) = @_;	1857	my ($self) = @_;
1642		1858
1643	if (@_ > 1)	1859	if (@_ > 1) {
1644	{
1645	$self->{term}->ROW_r ($_, $_[1], 0, ($_ - $self->{beg}) * $self->{ncol}, $self->{ncol})	1860	$self->{term}->ROW_r ($_, $_[1], 0, ($_ - $self->{beg}) * $self->{ncol}, $self->{ncol})
1646	for $self->{beg} .. $self->{end};	1861	for $self->{beg} .. $self->{end};
1647	}	1862	}
1648		1863
1649	if (defined wantarray) {	1864	if (defined wantarray) {
1650	my $rend = [	1865	my $rend = [
1651	map @{ $self->{term}->ROW_r ($_) }, $self->{beg} .. $self->{end}	1866	map @{ $self->{term}->ROW_r ($_) }, $self->{beg} .. $self->{end}
1652	];	1867	];

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.257 by root, Thu Jul 13 10:31:27 2017 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.257 by root, Thu Jul 13 10:31:27 2017 UTC