[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.261 by root, Fri Jun 18 12:35:38 2021 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. These comments are scanned whenever a
		121	terminal is created and are typically used to autoload extensions when
		122	their resources or command line parameters are used.
		123
		124	Currently, it recognises only one such comment:
109		125
110	=over 4	126	=over 4
111		127
112	=item $urxvt_term = $self->{term}	128	=item #:META:RESOURCE:name:type:desc
113		129
114	Returns the C<urxvt::term> object associated with this instance of the	130	The RESOURCE comment defines a resource used by the extension, where
115	extension. This member I<must not> be changed in any way.	131	C<name> is the resource name, C<type> is the resource type, C<boolean>
		132	or C<string>, and C<desc> is the resource description.
116		133
117	=item $self->enable ($hook_name => $cb, [$hook_name => $cb..])	134	The extension will be autoloaded when this resource is specified or used
118		135	as a command line parameter.
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		136
127	=back	137	=back
128		138
129	=head2 Hooks	139	=head2 Hooks
130		140
…		…
299		309
300	=item on_refresh_end $term	310	=item on_refresh_end $term
301		311
302	Called just after the screen gets redrawn. See C<on_refresh_begin>.	312	Called just after the screen gets redrawn. See C<on_refresh_begin>.
303		313
		314	=item on_action $term, $string
		315
		316	Called whenever an action is invoked for the corresponding extension
		317	(e.g. via a C<extension:string> builtin action bound to a key, see
		318	description of the B<keysym> resource in the urxvt(1) manpage). The
		319	event is simply the action string. Note that an action event is always
		320	associated to a single extension.
		321
304	=item on_user_command $term, $string	322	=item on_user_command $term, $string DEPRECATED
305		323
306	Called whenever a user-configured event is being activated (e.g. via	324	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>	325	a C<perl:string> action bound to a key, see description of the B<keysym>
308	resource in the @@RXVT_NAME@@(1) manpage).	326	resource in the urxvt(1) manpage).
309		327
310	The event is simply the action string. This interface is assumed to change	328	The event is simply the action string. This interface is going away in
311	slightly in the future.	329	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		330
320	=item on_resize_all_windows $term, $new_width, $new_height	331	=item on_resize_all_windows $term, $new_width, $new_height
321		332
322	Called just after the new window size has been calculated, but before	333	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	334	windows are actually being resized or hints are being set. If this hook
324	returns TRUE, setting of the window hints is being skipped.	335	returns a true value, setting of the window hints is being skipped.
325		336
326	=item on_x_event $term, $event	337	=item on_x_event $term, $event
327		338
328	Called on every X event received on the vt window (and possibly other	339	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	340	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	379	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.	380	(real, not screen-based) row and column under the mouse cursor.
370		381
371	C<on_key_press> additionally receives the string rxvt-unicode would	382	C<on_key_press> additionally receives the string rxvt-unicode would
372	output, if any, in locale-specific encoding.	383	output, if any, in locale-specific encoding.
373
374	subwindow.
375		384
376	=item on_client_message $term, $event	385	=item on_client_message $term, $event
377		386
378	=item on_wm_protocols $term, $event	387	=item on_wm_protocols $term, $event
379		388
…		…
507	ConfigureRequest, GravityNotify, ResizeRequest, CirculateNotify,	516	ConfigureRequest, GravityNotify, ResizeRequest, CirculateNotify,
508	CirculateRequest, PropertyNotify, SelectionClear, SelectionRequest,	517	CirculateRequest, PropertyNotify, SelectionClear, SelectionRequest,
509	SelectionNotify, ColormapNotify, ClientMessage, MappingNotify	518	SelectionNotify, ColormapNotify, ClientMessage, MappingNotify
510		519
511	Various constants for use in X calls and event processing.	520	Various constants for use in X calls and event processing.
		521
		522	=item urxvt::PrivMode_132, PrivMode_132OK, PrivMode_rVideo, PrivMode_relOrigin,
		523	PrivMode_Screen, PrivMode_Autowrap, PrivMode_aplCUR, PrivMode_aplKP,
		524	PrivMode_HaveBackSpace, PrivMode_BackSpace, PrivMode_ShiftKeys,
		525	PrivMode_VisibleCursor, PrivMode_MouseX10, PrivMode_MouseX11,
		526	PrivMode_scrollBar, PrivMode_TtyOutputInh, PrivMode_Keypress,
		527	PrivMode_smoothScroll, PrivMode_vt52, PrivMode_LFNL, PrivMode_MouseBtnEvent,
		528	PrivMode_MouseAnyEvent, PrivMode_BracketPaste, PrivMode_ExtMouseUTF8,
		529	PrivMode_ExtMouseUrxvt, PrivMode_BlinkingCursor, PrivMode_mouse_report,
		530	PrivMode_Default
		531
		532	Constants for checking DEC private modes.
512		533
513	=back	534	=back
514		535
515	=head2 RENDITION	536	=head2 RENDITION
516		537
…		…
582	no warnings 'utf8';	603	no warnings 'utf8';
583		604
584	sub parse_resource {	605	sub parse_resource {
585	my ($term, $name, $isarg, $longopt, $flag, $value) = @_;	606	my ($term, $name, $isarg, $longopt, $flag, $value) = @_;
586		607
587	$name =~ y/-/./ if $isarg;
588
589	$term->scan_meta;	608	$term->scan_extensions;
590		609
		610	# iterating over all resources has quadratic time overhead
		611	# overall, maybe this could be optimised?
591	my $r = $term->{meta}{resource};	612	my $r = $term->{meta}{resource};
592	keys %$r; # reste iterator	613	keys %$r; # reset iterator
593	while (my ($pattern, $v) = each %$r) {	614	while (my ($k, $v) = each %$r) {
594	if (	615	my $pattern = $k;
		616	$pattern =~ y/./-/ if $isarg;
		617	my $prefix = $name;
		618	my $suffix;
595	$pattern =~ /\.$/	619	if ($pattern =~ /\-$/) {
596	? $pattern eq substr $name, 0, length $pattern	620	$prefix = substr $name, 0, length $pattern;
597	: $pattern eq $name	621	$suffix = substr $name, length $pattern;
598	) {	622	}
		623	if ($pattern eq $prefix) {
599	$name = "$urxvt::RESCLASS.$name";	624	$name = "$urxvt::RESCLASS.$k$suffix";
600		625
601	push @{ $term->{perl_ext_3} }, $v->[0];	626	push @{ $term->{perl_ext_3} }, $v->[0];
		627
		628	return 1 unless $isarg;
602		629
603	if ($v->[1] eq "boolean") {	630	if ($v->[1] eq "boolean") {
604	$term->put_option_db ($name, $flag ? "true" : "false");	631	$term->put_option_db ($name, $flag ? "true" : "false");
605	return 1;	632	return 1;
606	} else {	633	} else {
…		…
614	}	641	}
615		642
616	sub usage {	643	sub usage {
617	my ($term, $usage_type) = @_;	644	my ($term, $usage_type) = @_;
618		645
619	$term->scan_meta;	646	$term->scan_extensions;
620		647
621	my $r = $term->{meta}{resource};	648	my $r = $term->{meta}{resource};
622		649
623	for my $pattern (sort keys %$r) {	650	for my $pattern (sort keys %$r) {
624	my ($ext, $type, $desc) = @{ $r->{$pattern} };	651	my ($ext, $type, $desc) = @{ $r->{$pattern} };
…		…
685	# called by the rxvt core	712	# called by the rxvt core
686	sub invoke {	713	sub invoke {
687	local $TERM = shift;	714	local $TERM = shift;
688	my $htype = shift;	715	my $htype = shift;
689		716
690	if ($htype == 0) { # INIT	717	if ($htype == HOOK_INIT) {
691	my @dirs = $TERM->perl_libdirs;	718	my @dirs = $TERM->perl_libdirs;
		719
		720	$TERM->scan_extensions;
692		721
693	my %ext_arg;	722	my %ext_arg;
694		723
695	{	724	{
696	my @init = @TERM_INIT;	725	my @init = @TERM_INIT;
…		…
701	$TERM->register_package ($_) for @pkg;	730	$TERM->register_package ($_) for @pkg;
702	}	731	}
703		732
704	for (	733	for (
705	@{ delete $TERM->{perl_ext_3} },	734	@{ delete $TERM->{perl_ext_3} },
706	grep $_, map { split /,/, $TERM->resource ("perl_ext_$_") } 1, 2	735	(grep $_, map { split /,/, $TERM->resource ("perl_ext_$_") } 1, 2),
707	) {	736	) {
708	if ($_ eq "default") {	737	if ($_ eq "default") {
		738
		739	$ext_arg{$_} = []
709	$ext_arg{$_} \|\|= [] for qw(selection option-popup selection-popup searchable-scrollback readline);	740	for qw(selection option-popup selection-popup readline searchable-scrollback confirm-paste);
		741
		742	for ($TERM->_keysym_resources) {
		743	next if /^(?:string\|command\|builtin\|builtin-string\|perl)/;
		744	next unless /^([A-Za-z0-9_\-]+):/;
		745
		746	my $ext = $1;
		747
		748	$ext_arg{$ext} = [];
		749	}
		750
710	} elsif (/^-(.*)$/) {	751	} elsif (/^-(.*)$/) {
711	delete $ext_arg{$1};	752	delete $ext_arg{$1};
		753
712	} elsif (/^([^<]+)<(.*)>$/) {	754	} elsif (/^([^<]+)<(.*)>$/) {
713	push @{ $ext_arg{$1} }, $2;	755	push @{ $ext_arg{$1} }, $2;
		756
714	} else {	757	} else {
715	$ext_arg{$_} \|\|= [];	758	$ext_arg{$_} \|\|= [];
716	}	759	}
717	}	760	}
718		761
…		…
734		777
735	if (my $cb = $TERM->{_hook}[$htype]) {	778	if (my $cb = $TERM->{_hook}[$htype]) {
736	verbose 10, "$HOOKNAME[$htype] (" . (join ", ", $TERM, @_) . ")"	779	verbose 10, "$HOOKNAME[$htype] (" . (join ", ", $TERM, @_) . ")"
737	if $verbosity >= 10;	780	if $verbosity >= 10;
738		781
		782	if ($htype == HOOK_ACTION) {
		783	# this hook is only sent to the extension with the name
		784	# matching the first arg
		785	my $pkg = shift;
		786	$pkg =~ y/-/_/;
		787	$pkg = "urxvt::ext::$pkg";
		788
		789	$cb = $cb->{$pkg}
		790	or return undef; #TODO: maybe warn user?
		791
		792	$cb = { $pkg => $cb };
		793	}
		794
739	for my $pkg (keys %$cb) {	795	for my $pkg (keys %$cb) {
740	my $retval_ = eval { $cb->{$pkg}->($TERM->{_pkg}{$pkg}, @_) };	796	my $retval_ = eval { $cb->{$pkg}->($TERM->{_pkg}{$pkg} \|\| $TERM, @_) };
741	$retval \|\|= $retval_;	797	$retval \|\|= $retval_;
742		798
743	if ($@) {	799	if ($@) {
744	$TERM->ungrab; # better to lose the grab than the session	800	$TERM->ungrab; # better to lose the grab than the session
745	warn $@;	801	warn $@;
…		…
748		804
749	verbose 11, "$HOOKNAME[$htype] returning <$retval>"	805	verbose 11, "$HOOKNAME[$htype] returning <$retval>"
750	if $verbosity >= 11;	806	if $verbosity >= 11;
751	}	807	}
752		808
753	if ($htype == 1) { # DESTROY	809	if ($htype == HOOK_DESTROY) {
754	# clear package objects	810	# clear package objects
755	%$_ = () for values %{ $TERM->{_pkg} };	811	%$_ = () for values %{ $TERM->{_pkg} };
756		812
757	# clear package	813	# clear package
758	%$TERM = ();	814	%$TERM = ();
…		…
790	($mask, @color{qw(fg bg)}, \@failed)	846	($mask, @color{qw(fg bg)}, \@failed)
791	}	847	}
792		848
793	package urxvt::term::extension;	849	package urxvt::term::extension;
794		850
795	sub enable {	851	=head2 The C<urxvt::term::extension> class
796	my ($self, %hook) = @_;
797	my $pkg = $self->{_pkg};
798		852
799	while (my ($name, $cb) = each %hook) {	853	Each extension attached to a terminal object is represented by
800	my $htype = $HOOKTYPE{uc $name};	854	a C<urxvt::term::extension> object.
801	defined $htype
802	or Carp::croak "unsupported hook type '$name'";
803		855
804	$self->set_should_invoke ($htype, +1)	856	You can use these objects, which are passed to all callbacks to store any
805	unless exists $self->{term}{_hook}[$htype]{$pkg};	857	state related to the terminal and extension instance.
806		858
807	$self->{term}{_hook}[$htype]{$pkg} = $cb;	859	The methods (And data members) documented below can be called on extension
808	}	860	objects, in addition to call methods documented for the <urxvt::term>
809	}	861	class.
810		862
811	sub disable {	863	=over 4
812	my ($self, @hook) = @_;
813	my $pkg = $self->{_pkg};
814		864
815	for my $name (@hook) {	865	=item $urxvt_term = $self->{term}
816	my $htype = $HOOKTYPE{uc $name};
817	defined $htype
818	or Carp::croak "unsupported hook type '$name'";
819		866
820	$self->set_should_invoke ($htype, -1)	867	Returns the C<urxvt::term> object associated with this instance of the
821	if delete $self->{term}{_hook}[$htype]{$pkg};	868	extension. This member I<must not> be changed in any way.
822	}	869
823	}	870	=cut
824		871
825	our $AUTOLOAD;	872	our $AUTOLOAD;
826		873
827	sub AUTOLOAD {	874	sub AUTOLOAD {
828	$AUTOLOAD =~ /:([^:]+)$/	875	$AUTOLOAD =~ /:([^:]+)$/
…		…
841		888
842	sub DESTROY {	889	sub DESTROY {
843	# nop	890	# nop
844	}	891	}
845		892
846	# urxvt::destroy_hook	893	# urxvt::destroy_hook (basically a cheap Guard:: implementation)
847		894
848	sub urxvt::destroy_hook::DESTROY {	895	sub urxvt::destroy_hook::DESTROY {
849	${$_[0]}->();	896	${$_[0]}->();
850	}	897	}
851		898
852	sub urxvt::destroy_hook(&) {	899	sub urxvt::destroy_hook(&) {
853	bless \shift, urxvt::destroy_hook::	900	bless \shift, urxvt::destroy_hook::
		901	}
		902
		903	=item $self->enable ($hook_name => $cb[, $hook_name => $cb..])
		904
		905	Dynamically enable the given hooks (named without the C<on_> prefix) for
		906	this extension, replacing any hook previously installed via C<enable> in
		907	this extension.
		908
		909	This is useful when you want to overwrite time-critical hooks only
		910	temporarily.
		911
		912	To install additional callbacks for the same hook, you can use the C<on>
		913	method of the C<urxvt::term> class.
		914
		915	=item $self->disable ($hook_name[, $hook_name..])
		916
		917	Dynamically disable the given hooks.
		918
		919	=cut
		920
		921	sub enable {
		922	my ($self, %hook) = @_;
		923	my $pkg = $self->{_pkg};
		924
		925	while (my ($name, $cb) = each %hook) {
		926	my $htype = $HOOKTYPE{uc $name};
		927	defined $htype
		928	or Carp::croak "unsupported hook type '$name'";
		929
		930	$self->set_should_invoke ($htype, +1)
		931	unless exists $self->{term}{_hook}[$htype]{$pkg};
		932
		933	$self->{term}{_hook}[$htype]{$pkg} = $cb;
		934	}
		935	}
		936
		937	sub disable {
		938	my ($self, @hook) = @_;
		939	my $pkg = $self->{_pkg};
		940
		941	for my $name (@hook) {
		942	my $htype = $HOOKTYPE{uc $name};
		943	defined $htype
		944	or Carp::croak "unsupported hook type '$name'";
		945
		946	$self->set_should_invoke ($htype, -1)
		947	if delete $self->{term}{_hook}[$htype]{$pkg};
		948	}
		949	}
		950
		951	=item $guard = $self->on ($hook_name => $cb[, $hook_name => $cb..])
		952
		953	Similar to the C<enable> enable, but installs additional callbacks for
		954	the given hook(s) (that is, it doesn't replace existing callbacks), and
		955	returns a guard object. When the guard object is destroyed the callbacks
		956	are disabled again.
		957
		958	=cut
		959
		960	sub urxvt::extension::on_disable::DESTROY {
		961	my $disable = shift;
		962
		963	my $term = delete $disable->{""};
		964
		965	while (my ($htype, $id) = each %$disable) {
		966	delete $term->{_hook}[$htype]{$id};
		967	$term->set_should_invoke ($htype, -1);
		968	}
		969	}
		970
		971	sub on {
		972	my ($self, %hook) = @_;
		973
		974	my $term = $self->{term};
		975
		976	my %disable = ( "" => $term );
		977
		978	while (my ($name, $cb) = each %hook) {
		979	my $htype = $HOOKTYPE{uc $name};
		980	defined $htype
		981	or Carp::croak "unsupported hook type '$name'";
		982
		983	$term->set_should_invoke ($htype, +1);
		984	$term->{_hook}[$htype]{ $disable{$htype} = $cb+0 }
		985	= sub { shift; $cb->($self, @_) }; # very ugly indeed
		986	}
		987
		988	bless \%disable, "urxvt::extension::on_disable"
		989	}
		990
		991	=item $self->bind_action ($hotkey, $action)
		992
		993	=item $self->x_resource ($pattern)
		994
		995	=item $self->x_resource_boolean ($pattern)
		996
		997	These methods support an additional C<%> prefix for C<$action> or
		998	C<$pattern> when called on an extension object, compared to the
		999	C<urxvt::term> methods of the same name - see the description of these
		1000	methods in the C<urxvt::term> class for details.
		1001
		1002	=cut
		1003
		1004	sub bind_action {
		1005	my ($self, $hotkey, $action) = @_;
		1006	$action =~ s/^%:/$_[0]{_name}:/;
		1007	$self->{term}->bind_action ($hotkey, $action)
854	}	1008	}
855		1009
856	sub x_resource {	1010	sub x_resource {
857	my ($self, $name) = @_;	1011	my ($self, $name) = @_;
858	$name =~ s/^%(\.\|$)/$_[0]{_name}$1/;	1012	$name =~ s/^%(\.\|$)/$_[0]{_name}$1/;
…		…
862	sub x_resource_boolean {	1016	sub x_resource_boolean {
863	my ($self, $name) = @_;	1017	my ($self, $name) = @_;
864	$name =~ s/^%(\.\|$)/$_[0]{_name}$1/;	1018	$name =~ s/^%(\.\|$)/$_[0]{_name}$1/;
865	$self->{term}->x_resource_boolean ($name)	1019	$self->{term}->x_resource_boolean ($name)
866	}	1020	}
		1021
		1022	=back
		1023
		1024	=cut
867		1025
868	package urxvt::anyevent;	1026	package urxvt::anyevent;
869		1027
870	=head2 The C<urxvt::anyevent> Class	1028	=head2 The C<urxvt::anyevent> Class
871		1029
…		…
990	$ENV{URXVT_PERL_LIB},	1148	$ENV{URXVT_PERL_LIB},
991	"$ENV{HOME}/.urxvt/ext",	1149	"$ENV{HOME}/.urxvt/ext",
992	"$LIBDIR/perl"	1150	"$LIBDIR/perl"
993	}	1151	}
994		1152
995	sub scan_meta {	1153	# scan for available extensions and collect their metadata
		1154	sub scan_extensions {
996	my ($self) = @_;	1155	my ($self) = @_;
		1156
		1157	return if exists $self->{meta};
		1158
997	my @libdirs = perl_libdirs $self;	1159	my @urxvtdirs = perl_libdirs $self;
		1160	# my @cpandirs = grep -d, map "$_/URxvt/Ext", @INC;
998		1161
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;	1162	$self->{meta} = \my %meta;
1005		1163
1006	for my $dir (reverse @libdirs) {	1164	# first gather extensions
		1165
		1166	my $gather = sub {
		1167	my ($dir, $core) = @_;
		1168
1007	opendir my $fh, $dir	1169	opendir my $fh, $dir
1008	or next;	1170	or return;
		1171
1009	for my $ext (readdir $fh) {	1172	for my $ext (readdir $fh) {
1010	$ext ne "."	1173	$ext !~ /^\./
1011	and $ext ne ".."
1012	and open my $fh, "<", "$dir/$ext"
1013	or next;	1174	or next;
1014		1175
		1176	open my $fh, "<", "$dir/$ext"
		1177	or next;
		1178
		1179	-f $fh
		1180	or next;
		1181
		1182	$ext =~ s/\.uext$// or $core
		1183	or next;
		1184
		1185	my %ext = (dir => $dir);
		1186
1015	while (<$fh>) {	1187	while (<$fh>) {
1016	if (/^#:META:X_RESOURCE:(.*)/) {	1188	if (/^#:META:(?:X_)?RESOURCE:(.*)/) {
1017	my ($pattern, $type, $desc) = split /:/, $1;	1189	my ($pattern, $type, $desc) = split /:/, $1;
1018	$pattern =~ s/^%(\.\|$)/$ext$1/g; # % in pattern == extension name	1190	$pattern =~ s/^%(\.\|$)/$ext$1/g; # % in pattern == extension name
1019	if ($pattern =~ /[^a-zA-Z0-9\-\.]/) {	1191	if ($pattern =~ /[^a-zA-Z0-9\-\.]/) {
1020	warn "$dir/$ext: meta resource '$pattern' contains illegal characters (not alphanumeric nor . nor *)\n";	1192	warn "$dir/$ext: meta resource '$pattern' contains illegal characters (not alphanumeric nor . nor *)\n";
1021	} else {	1193	} else {
1022	$meta{resource}{$pattern} = [$ext, $type, $desc];	1194	$ext{resource}{$pattern} = [$ext, $type, $desc];
1023	}	1195	}
1024	} elsif (/^\s*(?:#\|$)/) {	1196	} elsif (/^\s*(?:#\|$)/) {
1025	# skip other comments and empty lines	1197	# skip other comments and empty lines
1026	} else {	1198	} else {
1027	last; # stop parsing on first non-empty non-comment line	1199	last; # stop parsing on first non-empty non-comment line
1028	}	1200	}
1029	}	1201	}
		1202
		1203	$meta{ext}{$ext} = \%ext;
1030	}	1204	}
		1205	};
		1206
		1207	# $gather->($_, 0) for @cpandirs;
		1208	$gather->($_, 1) for @urxvtdirs;
		1209
		1210	# and now merge resources
		1211
		1212	$meta{resource} = \my %resource;
		1213
		1214	while (my ($k, $v) = each %{ $meta{ext} }) {
		1215	#TODO: should check for extensions overriding each other
		1216	%resource = (%resource, %{ $v->{resource} });
1031	}	1217	}
1032	}	1218	}
1033		1219
1034	=item $term = new urxvt::term $envhashref, $rxvtname, [arg...]	1220	=item $term = new urxvt::term $envhashref, $rxvtname, [arg...]
1035		1221
…		…
1055	}	1241	}
1056		1242
1057	=item $term->destroy	1243	=item $term->destroy
1058		1244
1059	Destroy the terminal object (close the window, free resources	1245	Destroy the terminal object (close the window, free resources
1060	etc.). Please note that @@RXVT_NAME@@ will not exit as long as any event	1246	etc.). Please note that urxvt will not exit as long as any event
1061	watchers (timers, io watchers) are still active.	1247	watchers (timers, io watchers) are still active.
1062		1248
1063	=item $term->exec_async ($cmd[, @args])	1249	=item $term->exec_async ($cmd[, @args])
1064		1250
1065	Works like the combination of the C<fork>/C<exec> builtins, which executes	1251	Works like the combination of the C<fork>/C<exec> builtins, which executes
…		…
1121		1307
1122	Here is a likely non-exhaustive list of resource names, not all of which	1308	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>	1309	are supported in every build, please see the source file F</src/rsinc.h>
1124	to see the actual list:	1310	to see the actual list:
1125		1311
1126	answerbackstring backgroundPixmap backspace_key blendtype blurradius	1312	answerbackstring backgroundPixmap backspace_key blurradius
1127	boldFont boldItalicFont borderLess buffered chdir color cursorBlink	1313	boldFont boldItalicFont borderLess buffered chdir color cursorBlink
1128	cursorUnderline cutchars delete_key depth display_name embed ext_bwidth	1314	cursorUnderline cutchars delete_key depth display_name embed ext_bwidth
1129	fade font geometry hold iconName iconfile imFont imLocale inputMethod	1315	fade font geometry hold iconName iconfile imFont imLocale inputMethod
1130	insecure int_bwidth intensityStyles iso14755 iso14755_52 italicFont	1316	insecure int_bwidth intensityStyles iso14755 iso14755_52 italicFont
1131	jumpScroll letterSpace lineSpace loginShell mapAlert meta8 modifier	1317	jumpScroll letterSpace lineSpace loginShell mapAlert meta8 modifier
…		…
1151	Returns the X-Resource for the given pattern, excluding the program or	1337	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	1338	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	1339	same value as used by this instance of rxvt-unicode. Returns C<undef> if no
1154	resource with that pattern exists.	1340	resource with that pattern exists.
1155		1341
1156	Extensions that define extra resource or command line arguments also need	1342	Extensions that define extra resources also need to call this method
1157	to call this method to access their values.	1343	to access their values.
1158		1344
1159	If the method is called on an extension object (basically, from an	1345	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	1346	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	1347	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	1348	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	1349	can rename them and get a new set of resources without having to change
1164	without having to change the actual code.	1350	the actual code.
1165		1351
1166	This method should only be called during the C<on_start> hook, as there is	1352	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	1353	only one resource database per display, and later invocations might return
1168	the wrong resources.	1354	the wrong resources.
1169		1355
…		…
1181	my $res = &x_resource;	1367	my $res = &x_resource;
1182		1368
1183	$res =~ /^\s(?:true\|yes\|on\|1)\s$/i ? 1 : defined $res && 0	1369	$res =~ /^\s(?:true\|yes\|on\|1)\s$/i ? 1 : defined $res && 0
1184	}	1370	}
1185		1371
1186	=item $success = $term->parse_keysym ($key, $octets)	1372	=item $action = $term->lookup_keysym ($keysym, $state)
1187		1373
		1374	Returns the action bound to key combination C<($keysym, $state)>,
		1375	if a binding for it exists, and C<undef> otherwise.
		1376
		1377	=item $success = $term->bind_action ($key, $action)
		1378
1188	Adds a key binding exactly as specified via a resource. See the	1379	Adds a key binding exactly as specified via a C<keysym> resource. See the
1189	C<keysym> resource in the @@RXVT_NAME@@(1) manpage.	1380	C<keysym> resource in the urxvt(1) manpage.
1190		1381
1191	=item $term->register_command ($keysym, $modifiermask, $string)	1382	To add default bindings for actions, an extension should call C<<
		1383	->bind_action >> in its C<init> hook for every such binding. Doing it
		1384	in the C<init> hook allows users to override or remove the binding
		1385	again.
1192		1386
1193	Adds a key binding. This is a lower level api compared to	1387	Example: the C<searchable-scrollback> by default binds itself
1194	C<parse_keysym>, as it expects a parsed key description, and can be	1388	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	1389	$term->bind_action >>.
1196	C<on_register_command> hook, to modify a parsed binding.	1390
		1391	sub init {
		1392	my ($self) = @_;
		1393
		1394	$self->bind_action ("M-s" => "%:start");
		1395	}
1197		1396
1198	=item $rend = $term->rstyle ([$new_rstyle])	1397	=item $rend = $term->rstyle ([$new_rstyle])
1199		1398
1200	Return and optionally change the current rendition. Text that is output by	1399	Return and optionally change the current rendition. Text that is output by
1201	the terminal application will use this style.	1400	the terminal application will use this style.
…		…
1359		1558
1360	=item $term->scr_add_lines ($string)	1559	=item $term->scr_add_lines ($string)
1361		1560
1362	Write the given text string to the screen, as if output by the application	1561	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	1562	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	1563	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.	1564	carriage returns and tabs. The string is a normal text string, not in
		1565	locale-dependent encoding.
1366		1566
1367	Normally its not a good idea to use this function, as programs might be	1567	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	1568	confused by changes in cursor position or scrolling. Its useful inside a
1369	C<on_add_lines> hook, though.	1569	C<on_add_lines> hook, though.
1370		1570
…		…
1378	locale-specific encoding of the terminal and can contain command sequences	1578	locale-specific encoding of the terminal and can contain command sequences
1379	(escape codes) that will be interpreted.	1579	(escape codes) that will be interpreted.
1380		1580
1381	=item $term->tt_write ($octets)	1581	=item $term->tt_write ($octets)
1382		1582
1383	Write the octets given in C<$octets> to the tty (i.e. as program input). To	1583	Write the octets given in C<$octets> to the tty (i.e. as user input
		1584	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	1585	characters instead of octets, you should convert your strings first to the
1385	to the locale-specific encoding using C<< $term->locale_encode >>.	1586	locale-specific encoding using C<< $term->locale_encode >>.
		1587
		1588	=item $term->tt_write_user_input ($octets)
		1589
		1590	Like C<tt_write>, but should be used when writing strings in response to
		1591	the user pressing a key, to invoke the additional actions requested by
		1592	the user for that case (C<tt_write> doesn't do that).
		1593
		1594	The typical use case would be inside C<on_action> hooks.
1386		1595
1387	=item $term->tt_paste ($octets)	1596	=item $term->tt_paste ($octets)
1388		1597
1389	Write the octets given in C<$octets> to the tty as a paste, converting NL to	1598	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	1599	CR and bracketing the data with control sequences if bracketed paste mode
…		…
1429		1638
1430	=item $term->key_release ($state, $keycode[, $time])	1639	=item $term->key_release ($state, $keycode[, $time])
1431		1640
1432	Deliver various fake events to to terminal.	1641	Deliver various fake events to to terminal.
1433		1642
1434	=item $window_width = $term->width	1643	=item $window_width = $term->width ([$new_value])
1435		1644
1436	=item $window_height = $term->height	1645	=item $window_height = $term->height ([$new_value])
1437		1646
1438	=item $font_width = $term->fwidth	1647	=item $font_width = $term->fwidth ([$new_value])
1439		1648
1440	=item $font_height = $term->fheight	1649	=item $font_height = $term->fheight ([$new_value])
1441		1650
1442	=item $font_ascent = $term->fbase	1651	=item $font_ascent = $term->fbase ([$new_value])
1443		1652
1444	=item $terminal_rows = $term->nrow	1653	=item $terminal_rows = $term->nrow ([$new_value])
1445		1654
1446	=item $terminal_columns = $term->ncol	1655	=item $terminal_columns = $term->ncol ([$new_value])
1447		1656
1448	=item $has_focus = $term->focus	1657	=item $has_focus = $term->focus ([$new_value])
1449		1658
1450	=item $is_mapped = $term->mapped	1659	=item $is_mapped = $term->mapped ([$new_value])
1451		1660
1452	=item $max_scrollback = $term->saveLines	1661	=item $max_scrollback = $term->saveLines ([$new_value])
1453		1662
1454	=item $nrow_plus_saveLines = $term->total_rows	1663	=item $nrow_plus_saveLines = $term->total_rows ([$new_value])
1455		1664
1456	=item $topmost_scrollback_row = $term->top_row	1665	=item $topmost_scrollback_row = $term->top_row ([$new_value])
1457		1666
1458	Return various integers describing terminal characteristics.	1667	Return various integers describing terminal characteristics. If an
		1668	argument is given, changes the value and returns the previous one.
1459		1669
1460	=item $x_display = $term->display_id	1670	=item $x_display = $term->display_id
1461		1671
1462	Return the DISPLAY used by rxvt-unicode.	1672	Return the DISPLAY used by rxvt-unicode.
1463		1673
…		…
1499	Returns the currently displayed screen (0 primary, 1 secondary).	1709	Returns the currently displayed screen (0 primary, 1 secondary).
1500		1710
1501	=item $cursor_is_hidden = $term->hidden_cursor	1711	=item $cursor_is_hidden = $term->hidden_cursor
1502		1712
1503	Returns whether the cursor is currently hidden or not.	1713	Returns whether the cursor is currently hidden or not.
		1714
		1715	=item $priv_modes = $term->priv_modes
		1716
		1717	Returns a bitset with the state of DEC private modes.
		1718
		1719	Example:
		1720
		1721	if ($term->priv_modes & urxvt::PrivMode_mouse_report) {
		1722	# mouse reporting is turned on
		1723	}
1504		1724
1505	=item $view_start = $term->view_start ([$newvalue])	1725	=item $view_start = $term->view_start ([$newvalue])
1506		1726
1507	Returns the row number of the topmost displayed line. Maximum value is	1727	Returns the row number of the topmost displayed line. Maximum value is
1508	C<0>, which displays the normal terminal contents. Lower values scroll	1728	C<0>, which displays the normal terminal contents. Lower values scroll
…		…
1513	Requests a screen refresh. At the next opportunity, rxvt-unicode will	1733	Requests a screen refresh. At the next opportunity, rxvt-unicode will
1514	compare the on-screen display with its stored representation. If they	1734	compare the on-screen display with its stored representation. If they
1515	differ, it redraws the differences.	1735	differ, it redraws the differences.
1516		1736
1517	Used after changing terminal contents to display them.	1737	Used after changing terminal contents to display them.
		1738
		1739	=item $term->refresh_check
		1740
		1741	Checks if a refresh has been requested and, if so, schedules one.
1518		1742
1519	=item $text = $term->ROW_t ($row_number[, $new_text[, $start_col]])	1743	=item $text = $term->ROW_t ($row_number[, $new_text[, $start_col]])
1520		1744
1521	Returns the text of the entire row with number C<$row_number>. Row C<< $term->top_row >>	1745	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	1746	is the topmost terminal line, row C<< $term->nrow-1 >> is the bottommost
…		…
1624	}	1848	}
1625		1849
1626	sub urxvt::line::t {	1850	sub urxvt::line::t {
1627	my ($self) = @_;	1851	my ($self) = @_;
1628		1852
1629	if (@_ > 1)	1853	if (@_ > 1) {
1630	{
1631	$self->{term}->ROW_t ($_, $_[1], 0, ($_ - $self->{beg}) * $self->{ncol}, $self->{ncol})	1854	$self->{term}->ROW_t ($_, $_[1], 0, ($_ - $self->{beg}) * $self->{ncol}, $self->{ncol})
1632	for $self->{beg} .. $self->{end};	1855	for $self->{beg} .. $self->{end};
1633	}	1856	}
1634		1857
1635	defined wantarray &&	1858	defined wantarray &&
1636	substr +(join "", map $self->{term}->ROW_t ($_), $self->{beg} .. $self->{end}),	1859	substr +(join "", map $self->{term}->ROW_t ($_), $self->{beg} .. $self->{end}),
1637	0, $self->{len}	1860	0, $self->{len}
1638	}	1861	}
1639		1862
1640	sub urxvt::line::r {	1863	sub urxvt::line::r {
1641	my ($self) = @_;	1864	my ($self) = @_;
1642		1865
1643	if (@_ > 1)	1866	if (@_ > 1) {
1644	{
1645	$self->{term}->ROW_r ($_, $_[1], 0, ($_ - $self->{beg}) * $self->{ncol}, $self->{ncol})	1867	$self->{term}->ROW_r ($_, $_[1], 0, ($_ - $self->{beg}) * $self->{ncol}, $self->{ncol})
1646	for $self->{beg} .. $self->{end};	1868	for $self->{beg} .. $self->{end};
1647	}	1869	}
1648		1870
1649	if (defined wantarray) {	1871	if (defined wantarray) {
1650	my $rend = [	1872	my $rend = [
1651	map @{ $self->{term}->ROW_r ($_) }, $self->{beg} .. $self->{end}	1873	map @{ $self->{term}->ROW_r ($_) }, $self->{beg} .. $self->{end}
1652	];	1874	];

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.261 by root, Fri Jun 18 12:35:38 2021 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.261 by root, Fri Jun 18 12:35:38 2021 UTC