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

Comparing rxvt-unicode/src/urxvt.pm (file contents):
Revision 1.220 by root, Tue Jun 19 18:17:56 2012 UTC vs.
Revision 1.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 viewed	37	in F<< <libdir>/urxvt/perl/ >>, and the documentation can be viewed using
38	using F<< man urxvt-<EXTENSIONNAME> >>.	38	F<< man urxvt-<EXTENSIONNAME> >>.
39		39
40	You can activate them like this:	40	You can activate them like this:
41		41
42	@@RXVT_NAME@@ -pe <extensionname>	42	urxvt -pe <extensionname>
43		43
44	Or by adding them to the resource for extensions loaded by default:	44	Or by adding them to the resource for extensions loaded by default:
45		45
46	URxvt.perl-ext-common: default,selection-autotransform	46	URxvt.perl-ext-common: default,selection-autotransform
47		47
48	Extensions that add command line parameters or resources on their own are	48	Extensions may add additional resources and C<actions>, i.e., methods
49	loaded automatically when used.	49	which can be bound to a key and invoked by the user. An extension can
		50	define the resources it support 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	To install additional callbacks for the same hook, you cna use the C<on>
124	method of the C<urxvt::term> class.
125
126	=item $self->disable ($hook_name[, $hook_name..])
127
128	Dynamically disable the given hooks.
129
130	=item $self->x_resource ($pattern)
131
132	=item $self->x_resource_boolean ($pattern)
133
134	These methods support an additional C<%> prefix when called on an
135	extension object - see the description of these methods in the
136	C<urxvt::term> class for details.
137		131
138	=back	132	=back
139		133
140	=head2 Hooks	134	=head2 Hooks
141		135
…		…
310		304
311	=item on_refresh_end $term	305	=item on_refresh_end $term
312		306
313	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>.
314		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
315	=item on_user_command $term, $string	317	=item on_user_command $term, $string DEPRECATED
316		318
317	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
318	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>
319	resource in the @@RXVT_NAME@@(1) manpage).	321	resource in the urxvt(1) manpage).
320		322
321	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
322	slightly in the future.	324	preference to the C<on_action> hook.
323
324	=item on_register_command $term, $keysym, $modifiermask, $string
325
326	Called after parsing a keysym resource but before registering the
327	associated binding. If this hook returns TRUE the binding is not
328	registered. It can be used to modify a binding by calling
329	C<register_command>.
330		325
331	=item on_resize_all_windows $term, $new_width, $new_height	326	=item on_resize_all_windows $term, $new_width, $new_height
332		327
333	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
334	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
335	returns TRUE, setting of the window hints is being skipped.	330	returns a true value, setting of the window hints is being skipped.
336		331
337	=item on_x_event $term, $event	332	=item on_x_event $term, $event
338		333
339	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
340	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
…		…
379	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
380	(real, not screen-based) row and column under the mouse cursor.	375	(real, not screen-based) row and column under the mouse cursor.
381		376
382	C<on_key_press> additionally receives the string rxvt-unicode would	377	C<on_key_press> additionally receives the string rxvt-unicode would
383	output, if any, in locale-specific encoding.	378	output, if any, in locale-specific encoding.
384
385	subwindow.
386		379
387	=item on_client_message $term, $event	380	=item on_client_message $term, $event
388		381
389	=item on_wm_protocols $term, $event	382	=item on_wm_protocols $term, $event
390		383
…		…
518	ConfigureRequest, GravityNotify, ResizeRequest, CirculateNotify,	511	ConfigureRequest, GravityNotify, ResizeRequest, CirculateNotify,
519	CirculateRequest, PropertyNotify, SelectionClear, SelectionRequest,	512	CirculateRequest, PropertyNotify, SelectionClear, SelectionRequest,
520	SelectionNotify, ColormapNotify, ClientMessage, MappingNotify	513	SelectionNotify, ColormapNotify, ClientMessage, MappingNotify
521		514
522	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.
523		528
524	=back	529	=back
525		530
526	=head2 RENDITION	531	=head2 RENDITION
527		532
…		…
593	no warnings 'utf8';	598	no warnings 'utf8';
594		599
595	sub parse_resource {	600	sub parse_resource {
596	my ($term, $name, $isarg, $longopt, $flag, $value) = @_;	601	my ($term, $name, $isarg, $longopt, $flag, $value) = @_;
597		602
598	$name =~ y/-/./ if $isarg;
599
600	$term->scan_meta;	603	$term->scan_extensions;
601		604
602	my $r = $term->{meta}{resource};	605	my $r = $term->{meta}{resource};
603	keys %$r; # reste iterator	606	keys %$r; # reset iterator
604	while (my ($pattern, $v) = each %$r) {	607	while (my ($k, $v) = each %$r) {
605	if (	608	my $pattern = $k;
		609	$pattern =~ y/./-/ if $isarg;
		610	my $prefix = $name;
		611	my $suffix;
606	$pattern =~ /\.$/	612	if ($pattern =~ /\-$/) {
607	? $pattern eq substr $name, 0, length $pattern	613	$prefix = substr $name, 0, length $pattern;
608	: $pattern eq $name	614	$suffix = substr $name, length $pattern;
609	) {	615	}
		616	if ($pattern eq $prefix) {
610	$name = "$urxvt::RESCLASS.$name";	617	$name = "$urxvt::RESCLASS.$k$suffix";
611		618
612	push @{ $term->{perl_ext_3} }, $v->[0];	619	push @{ $term->{perl_ext_3} }, $v->[0];
		620
		621	return 1 unless $isarg;
613		622
614	if ($v->[1] eq "boolean") {	623	if ($v->[1] eq "boolean") {
615	$term->put_option_db ($name, $flag ? "true" : "false");	624	$term->put_option_db ($name, $flag ? "true" : "false");
616	return 1;	625	return 1;
617	} else {	626	} else {
…		…
625	}	634	}
626		635
627	sub usage {	636	sub usage {
628	my ($term, $usage_type) = @_;	637	my ($term, $usage_type) = @_;
629		638
630	$term->scan_meta;	639	$term->scan_extensions;
631		640
632	my $r = $term->{meta}{resource};	641	my $r = $term->{meta}{resource};
633		642
634	for my $pattern (sort keys %$r) {	643	for my $pattern (sort keys %$r) {
635	my ($ext, $type, $desc) = @{ $r->{$pattern} };	644	my ($ext, $type, $desc) = @{ $r->{$pattern} };
…		…
696	# called by the rxvt core	705	# called by the rxvt core
697	sub invoke {	706	sub invoke {
698	local $TERM = shift;	707	local $TERM = shift;
699	my $htype = shift;	708	my $htype = shift;
700		709
701	if ($htype == 0) { # INIT	710	if ($htype == HOOK_INIT) {
702	my @dirs = $TERM->perl_libdirs;	711	my @dirs = $TERM->perl_libdirs;
		712
		713	$TERM->scan_extensions;
703		714
704	my %ext_arg;	715	my %ext_arg;
705		716
706	{	717	{
707	my @init = @TERM_INIT;	718	my @init = @TERM_INIT;
…		…
711	@TERM_EXT = ();	722	@TERM_EXT = ();
712	$TERM->register_package ($_) for @pkg;	723	$TERM->register_package ($_) for @pkg;
713	}	724	}
714		725
715	for (	726	for (
		727	(grep $_, map { split /,/, $TERM->resource ("perl_ext_$_") } 1, 2),
716	@{ delete $TERM->{perl_ext_3} },	728	@{ delete $TERM->{perl_ext_3} }
717	grep $_, map { split /,/, $TERM->resource ("perl_ext_$_") } 1, 2
718	) {	729	) {
719	if ($_ eq "default") {	730	if ($_ eq "default") {
		731
		732	$ext_arg{$_} = []
720	$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
721	} elsif (/^-(.*)$/) {	744	} elsif (/^-(.*)$/) {
722	delete $ext_arg{$1};	745	delete $ext_arg{$1};
		746
723	} elsif (/^([^<]+)<(.*)>$/) {	747	} elsif (/^([^<]+)<(.*)>$/) {
724	push @{ $ext_arg{$1} }, $2;	748	push @{ $ext_arg{$1} }, $2;
		749
725	} else {	750	} else {
726	$ext_arg{$_} \|\|= [];	751	$ext_arg{$_} \|\|= [];
727	}	752	}
728	}	753	}
729		754
…		…
745		770
746	if (my $cb = $TERM->{_hook}[$htype]) {	771	if (my $cb = $TERM->{_hook}[$htype]) {
747	verbose 10, "$HOOKNAME[$htype] (" . (join ", ", $TERM, @_) . ")"	772	verbose 10, "$HOOKNAME[$htype] (" . (join ", ", $TERM, @_) . ")"
748	if $verbosity >= 10;	773	if $verbosity >= 10;
749		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
750	for my $pkg (keys %$cb) {	788	for my $pkg (keys %$cb) {
751	my $retval_ = eval { $cb->{$pkg}->($TERM->{_pkg}{$pkg} \|\| $TERM, @_) };	789	my $retval_ = eval { $cb->{$pkg}->($TERM->{_pkg}{$pkg} \|\| $TERM, @_) };
752	$retval \|\|= $retval_;	790	$retval \|\|= $retval_;
753		791
754	if ($@) {	792	if ($@) {
…		…
759		797
760	verbose 11, "$HOOKNAME[$htype] returning <$retval>"	798	verbose 11, "$HOOKNAME[$htype] returning <$retval>"
761	if $verbosity >= 11;	799	if $verbosity >= 11;
762	}	800	}
763		801
764	if ($htype == 1) { # DESTROY	802	if ($htype == HOOK_DESTROY) {
765	# clear package objects	803	# clear package objects
766	%$_ = () for values %{ $TERM->{_pkg} };	804	%$_ = () for values %{ $TERM->{_pkg} };
767		805
768	# clear package	806	# clear package
769	%$TERM = ();	807	%$TERM = ();
…		…
801	($mask, @color{qw(fg bg)}, \@failed)	839	($mask, @color{qw(fg bg)}, \@failed)
802	}	840	}
803		841
804	package urxvt::term::extension;	842	package urxvt::term::extension;
805		843
806	sub enable {	844	=head2 The C<urxvt::term::extension> class
807	my ($self, %hook) = @_;
808	my $pkg = $self->{_pkg};
809		845
810	while (my ($name, $cb) = each %hook) {	846	Each extension attached to a terminal object is represented by
811	my $htype = $HOOKTYPE{uc $name};	847	a C<urxvt::term::extension> object.
812	defined $htype
813	or Carp::croak "unsupported hook type '$name'";
814		848
815	$self->set_should_invoke ($htype, +1)	849	You can use these objects, which are passed to all callbacks to store any
816	unless exists $self->{term}{_hook}[$htype]{$pkg};	850	state related to the terminal and extension instance.
817		851
818	$self->{term}{_hook}[$htype]{$pkg} = $cb;	852	The methods (And data members) documented below can be called on extension
819	}	853	objects, in addition to call methods documented for the <urxvt::term>
820	}	854	class.
821		855
822	sub disable {	856	=over 4
823	my ($self, @hook) = @_;
824	my $pkg = $self->{_pkg};
825		857
826	for my $name (@hook) {	858	=item $urxvt_term = $self->{term}
827	my $htype = $HOOKTYPE{uc $name};
828	defined $htype
829	or Carp::croak "unsupported hook type '$name'";
830		859
831	$self->set_should_invoke ($htype, -1)	860	Returns the C<urxvt::term> object associated with this instance of the
832	if delete $self->{term}{_hook}[$htype]{$pkg};	861	extension. This member I<must not> be changed in any way.
833	}	862
834	}	863	=cut
835		864
836	our $AUTOLOAD;	865	our $AUTOLOAD;
837		866
838	sub AUTOLOAD {	867	sub AUTOLOAD {
839	$AUTOLOAD =~ /:([^:]+)$/	868	$AUTOLOAD =~ /:([^:]+)$/
…		…
852		881
853	sub DESTROY {	882	sub DESTROY {
854	# nop	883	# nop
855	}	884	}
856		885
857	# urxvt::destroy_hook	886	# urxvt::destroy_hook (basically a cheap Guard:: implementation)
858		887
859	sub urxvt::destroy_hook::DESTROY {	888	sub urxvt::destroy_hook::DESTROY {
860	${$_[0]}->();	889	${$_[0]}->();
861	}	890	}
862		891
863	sub urxvt::destroy_hook(&) {	892	sub urxvt::destroy_hook(&) {
864	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)
865	}	1001	}
866		1002
867	sub x_resource {	1003	sub x_resource {
868	my ($self, $name) = @_;	1004	my ($self, $name) = @_;
869	$name =~ s/^%(\.\|$)/$_[0]{_name}$1/;	1005	$name =~ s/^%(\.\|$)/$_[0]{_name}$1/;
…		…
873	sub x_resource_boolean {	1009	sub x_resource_boolean {
874	my ($self, $name) = @_;	1010	my ($self, $name) = @_;
875	$name =~ s/^%(\.\|$)/$_[0]{_name}$1/;	1011	$name =~ s/^%(\.\|$)/$_[0]{_name}$1/;
876	$self->{term}->x_resource_boolean ($name)	1012	$self->{term}->x_resource_boolean ($name)
877	}	1013	}
		1014
		1015	=back
		1016
		1017	=cut
878		1018
879	package urxvt::anyevent;	1019	package urxvt::anyevent;
880		1020
881	=head2 The C<urxvt::anyevent> Class	1021	=head2 The C<urxvt::anyevent> Class
882		1022
…		…
1001	$ENV{URXVT_PERL_LIB},	1141	$ENV{URXVT_PERL_LIB},
1002	"$ENV{HOME}/.urxvt/ext",	1142	"$ENV{HOME}/.urxvt/ext",
1003	"$LIBDIR/perl"	1143	"$LIBDIR/perl"
1004	}	1144	}
1005		1145
1006	sub scan_meta {	1146	# scan for available extensions and collect their metadata
		1147	sub scan_extensions {
1007	my ($self) = @_;	1148	my ($self) = @_;
		1149
		1150	return if exists $self->{meta};
		1151
1008	my @libdirs = perl_libdirs $self;	1152	my @urxvtdirs = perl_libdirs $self;
		1153	# my @cpandirs = grep -d, map "$_/URxvt/Ext", @INC;
1009		1154
1010	return if $self->{meta_libdirs} eq join "\x00", @libdirs;
1011
1012	my %meta;
1013
1014	$self->{meta_libdirs} = join "\x00", @libdirs;
1015	$self->{meta} = \%meta;	1155	$self->{meta} = \my %meta;
1016		1156
1017	for my $dir (reverse @libdirs) {	1157	# first gather extensions
		1158
		1159	my $gather = sub {
		1160	my ($dir, $core) = @_;
		1161
1018	opendir my $fh, $dir	1162	opendir my $fh, $dir
1019	or next;	1163	or return;
		1164
1020	for my $ext (readdir $fh) {	1165	for my $ext (readdir $fh) {
1021	$ext ne "."	1166	$ext !~ /^\./
1022	and $ext ne ".."
1023	and open my $fh, "<", "$dir/$ext"
1024	or next;	1167	or next;
1025		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
1026	while (<$fh>) {	1180	while (<$fh>) {
1027	if (/^#:META:X_RESOURCE:(.*)/) {	1181	if (/^#:META:(?:X_)?RESOURCE:(.*)/) {
1028	my ($pattern, $type, $desc) = split /:/, $1;	1182	my ($pattern, $type, $desc) = split /:/, $1;
1029	$pattern =~ s/^%(\.\|$)/$ext$1/g; # % in pattern == extension name	1183	$pattern =~ s/^%(\.\|$)/$ext$1/g; # % in pattern == extension name
1030	if ($pattern =~ /[^a-zA-Z0-9\-\.]/) {	1184	if ($pattern =~ /[^a-zA-Z0-9\-\.]/) {
1031	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";
1032	} else {	1186	} else {
1033	$meta{resource}{$pattern} = [$ext, $type, $desc];	1187	$ext{resource}{$pattern} = [$ext, $type, $desc];
1034	}	1188	}
1035	} elsif (/^\s*(?:#\|$)/) {	1189	} elsif (/^\s*(?:#\|$)/) {
1036	# skip other comments and empty lines	1190	# skip other comments and empty lines
1037	} else {	1191	} else {
1038	last; # stop parsing on first non-empty non-comment line	1192	last; # stop parsing on first non-empty non-comment line
1039	}	1193	}
1040	}	1194	}
		1195
		1196	$meta{ext}{$ext} = \%ext;
1041	}	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} });
1042	}	1210	}
1043	}	1211	}
1044		1212
1045	=item $term = new urxvt::term $envhashref, $rxvtname, [arg...]	1213	=item $term = new urxvt::term $envhashref, $rxvtname, [arg...]
1046		1214
…		…
1066	}	1234	}
1067		1235
1068	=item $term->destroy	1236	=item $term->destroy
1069		1237
1070	Destroy the terminal object (close the window, free resources	1238	Destroy the terminal object (close the window, free resources
1071	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
1072	watchers (timers, io watchers) are still active.	1240	watchers (timers, io watchers) are still active.
1073
1074	=item $guard = $self->on ($hook_name => $cb[, $hook_name => $cb..])
1075
1076	Similar to the extension method C<enable>, but installs additional
1077	callbacks for the givne hook(s) (existing ones are not replaced), and
1078	returns a guard object. When the guard object is destroyed the callbacks
1079	are disabled again.
1080
1081	Note that these callbacks receive the normal paramaters, but the first
1082	argument (normally the extension) is currently undefined.
1083
1084	=cut
1085
1086	sub urxvt::term::on_disable::DESTROY {
1087	my $disable = shift;
1088
1089	my $self = delete $disable->{""};
1090
1091	while (my ($htype, $id) = each %$disable) {
1092	delete $self->{_hook}[$htype]{$id};
1093	$self->set_should_invoke ($htype, -1);
1094	}
1095	}
1096
1097	sub on {
1098	my ($self, %hook) = @_;
1099
1100	my %disable = ( "" => $self );
1101
1102	while (my ($name, $cb) = each %hook) {
1103	my $htype = $HOOKTYPE{uc $name};
1104	defined $htype
1105	or Carp::croak "unsupported hook type '$name'";
1106
1107	my $id = $cb+0;
1108
1109	$self->set_should_invoke ($htype, +1);
1110	$disable{$htype} = $id;
1111	$self->{_hook}[$htype]{$id} = $cb;
1112	}
1113
1114	bless \%disable, "urxvt::term::on_disable"
1115	}
1116		1241
1117	=item $term->exec_async ($cmd[, @args])	1242	=item $term->exec_async ($cmd[, @args])
1118		1243
1119	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
1120	("starts") programs in the background. This function takes care of setting	1245	("starts") programs in the background. This function takes care of setting
…		…
1205	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
1206	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
1207	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
1208	resource with that pattern exists.	1333	resource with that pattern exists.
1209		1334
1210	Extensions that define extra resource or command line arguments also need	1335	Extensions that define extra resources also need to call this method
1211	to call this method to access their values.	1336	to access their values.
1212		1337
1213	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
1214	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
1215	the extension and a dot, and the lone string C<%> will be replaced by the	1340	the extension and a dot, and the lone string C<%> will be replaced by the
1216	extension name itself. This makes it possible to code extensions so you	1341	extension name itself. This makes it possible to code extensions so you
1217	can rename them and get a new set of commandline switches and resources	1342	can rename them and get a new set of resources without having to change
1218	without having to change the actual code.	1343	the actual code.
1219		1344
1220	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
1221	only one resource database per display, and later invocations might return	1346	only one resource database per display, and later invocations might return
1222	the wrong resources.	1347	the wrong resources.
1223		1348
…		…
1235	my $res = &x_resource;	1360	my $res = &x_resource;
1236		1361
1237	$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
1238	}	1363	}
1239		1364
1240	=item $success = $term->parse_keysym ($key, $octets)	1365	=item $action = $term->lookup_keysym ($keysym, $state)
1241		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
1242	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
1243	C<keysym> resource in the @@RXVT_NAME@@(1) manpage.	1373	C<keysym> resource in the urxvt(1) manpage.
1244		1374
1245	=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.
1246		1379
1247	Adds a key binding. This is a lower level api compared to	1380	Example: the C<searchable-scrollback> by default binds itself
1248	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<<
1249	used only inside either the C<on_init> hook, to add a binding, or the	1382	$term->bind_action >>.
1250	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	}
1251		1389
1252	=item $rend = $term->rstyle ([$new_rstyle])	1390	=item $rend = $term->rstyle ([$new_rstyle])
1253		1391
1254	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
1255	the terminal application will use this style.	1393	the terminal application will use this style.
…		…
1413		1551
1414	=item $term->scr_add_lines ($string)	1552	=item $term->scr_add_lines ($string)
1415		1553
1416	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
1417	running inside the terminal. It may not contain command sequences (escape	1555	running inside the terminal. It may not contain command sequences (escape
1418	codes), but is free to use line feeds, carriage returns and tabs. The	1556	codes - see C<cmd_parse> for that), but is free to use line feeds,
1419	string is a normal text string, not in locale-dependent encoding.	1557	carriage returns and tabs. The string is a normal text string, not in
		1558	locale-dependent encoding.
1420		1559
1421	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
1422	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
1423	C<on_add_lines> hook, though.	1562	C<on_add_lines> hook, though.
1424		1563
…		…
1432	locale-specific encoding of the terminal and can contain command sequences	1571	locale-specific encoding of the terminal and can contain command sequences
1433	(escape codes) that will be interpreted.	1572	(escape codes) that will be interpreted.
1434		1573
1435	=item $term->tt_write ($octets)	1574	=item $term->tt_write ($octets)
1436		1575
1437	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
1438	pass characters instead of octets, you should convert your strings first	1578	characters instead of octets, you should convert your strings first to the
1439	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.
1440		1588
1441	=item $term->tt_paste ($octets)	1589	=item $term->tt_paste ($octets)
1442		1590
1443	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
1444	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
…		…
1483		1631
1484	=item $term->key_release ($state, $keycode[, $time])	1632	=item $term->key_release ($state, $keycode[, $time])
1485		1633
1486	Deliver various fake events to to terminal.	1634	Deliver various fake events to to terminal.
1487		1635
1488	=item $window_width = $term->width	1636	=item $window_width = $term->width ([$new_value])
1489		1637
1490	=item $window_height = $term->height	1638	=item $window_height = $term->height ([$new_value])
1491		1639
1492	=item $font_width = $term->fwidth	1640	=item $font_width = $term->fwidth ([$new_value])
1493		1641
1494	=item $font_height = $term->fheight	1642	=item $font_height = $term->fheight ([$new_value])
1495		1643
1496	=item $font_ascent = $term->fbase	1644	=item $font_ascent = $term->fbase ([$new_value])
1497		1645
1498	=item $terminal_rows = $term->nrow	1646	=item $terminal_rows = $term->nrow ([$new_value])
1499		1647
1500	=item $terminal_columns = $term->ncol	1648	=item $terminal_columns = $term->ncol ([$new_value])
1501		1649
1502	=item $has_focus = $term->focus	1650	=item $has_focus = $term->focus ([$new_value])
1503		1651
1504	=item $is_mapped = $term->mapped	1652	=item $is_mapped = $term->mapped ([$new_value])
1505		1653
1506	=item $max_scrollback = $term->saveLines	1654	=item $max_scrollback = $term->saveLines ([$new_value])
1507		1655
1508	=item $nrow_plus_saveLines = $term->total_rows	1656	=item $nrow_plus_saveLines = $term->total_rows ([$new_value])
1509		1657
1510	=item $topmost_scrollback_row = $term->top_row	1658	=item $topmost_scrollback_row = $term->top_row ([$new_value])
1511		1659
1512	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.
1513		1662
1514	=item $x_display = $term->display_id	1663	=item $x_display = $term->display_id
1515		1664
1516	Return the DISPLAY used by rxvt-unicode.	1665	Return the DISPLAY used by rxvt-unicode.
1517		1666
…		…
1553	Returns the currently displayed screen (0 primary, 1 secondary).	1702	Returns the currently displayed screen (0 primary, 1 secondary).
1554		1703
1555	=item $cursor_is_hidden = $term->hidden_cursor	1704	=item $cursor_is_hidden = $term->hidden_cursor
1556		1705
1557	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	}
1558		1717
1559	=item $view_start = $term->view_start ([$newvalue])	1718	=item $view_start = $term->view_start ([$newvalue])
1560		1719
1561	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
1562	C<0>, which displays the normal terminal contents. Lower values scroll	1721	C<0>, which displays the normal terminal contents. Lower values scroll
…		…
1567	Requests a screen refresh. At the next opportunity, rxvt-unicode will	1726	Requests a screen refresh. At the next opportunity, rxvt-unicode will
1568	compare the on-screen display with its stored representation. If they	1727	compare the on-screen display with its stored representation. If they
1569	differ, it redraws the differences.	1728	differ, it redraws the differences.
1570		1729
1571	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.
1572		1735
1573	=item $text = $term->ROW_t ($row_number[, $new_text[, $start_col]])	1736	=item $text = $term->ROW_t ($row_number[, $new_text[, $start_col]])
1574		1737
1575	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 >>
1576	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
…		…
1678	}	1841	}
1679		1842
1680	sub urxvt::line::t {	1843	sub urxvt::line::t {
1681	my ($self) = @_;	1844	my ($self) = @_;
1682		1845
1683	if (@_ > 1)	1846	if (@_ > 1) {
1684	{
1685	$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})
1686	for $self->{beg} .. $self->{end};	1848	for $self->{beg} .. $self->{end};
1687	}	1849	}
1688		1850
1689	defined wantarray &&	1851	defined wantarray &&
1690	substr +(join "", map $self->{term}->ROW_t ($_), $self->{beg} .. $self->{end}),	1852	substr +(join "", map $self->{term}->ROW_t ($_), $self->{beg} .. $self->{end}),
1691	0, $self->{len}	1853	0, $self->{len}
1692	}	1854	}
1693		1855
1694	sub urxvt::line::r {	1856	sub urxvt::line::r {
1695	my ($self) = @_;	1857	my ($self) = @_;
1696		1858
1697	if (@_ > 1)	1859	if (@_ > 1) {
1698	{
1699	$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})
1700	for $self->{beg} .. $self->{end};	1861	for $self->{beg} .. $self->{end};
1701	}	1862	}
1702		1863
1703	if (defined wantarray) {	1864	if (defined wantarray) {
1704	my $rend = [	1865	my $rend = [
1705	map @{ $self->{term}->ROW_r ($_) }, $self->{beg} .. $self->{end}	1866	map @{ $self->{term}->ROW_r ($_) }, $self->{beg} .. $self->{end}
1706	];	1867	];

Diff Legend

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

Comparing rxvt-unicode/src/urxvt.pm (file contents): Revision 1.220 by root, Tue Jun 19 18:17:56 2012 UTC vs. Revision 1.257 by root, Thu Jul 13 10:31:27 2017 UTC

Diff Legend

Comparing rxvt-unicode/src/urxvt.pm (file contents):
Revision 1.220 by root, Tue Jun 19 18:17:56 2012 UTC vs.
Revision 1.257 by root, Thu Jul 13 10:31:27 2017 UTC