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

Comparing rxvt-unicode/src/urxvt.pm (file contents):
Revision 1.221 by sf-exg, Thu Jun 21 06:08:05 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 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. 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	To install additional callbacks for the same hook, you can 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		136
138	=back	137	=back
139		138
140	=head2 Hooks	139	=head2 Hooks
141		140
…		…
310		309
311	=item on_refresh_end $term	310	=item on_refresh_end $term
312		311
313	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>.
314		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
315	=item on_user_command $term, $string	322	=item on_user_command $term, $string DEPRECATED
316		323
317	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
318	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>
319	resource in the @@RXVT_NAME@@(1) manpage).	326	resource in the urxvt(1) manpage).
320		327
321	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
322	slightly in the future.	329	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		330
331	=item on_resize_all_windows $term, $new_width, $new_height	331	=item on_resize_all_windows $term, $new_width, $new_height
332		332
333	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
334	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
335	returns TRUE, setting of the window hints is being skipped.	335	returns a true value, setting of the window hints is being skipped.
336		336
337	=item on_x_event $term, $event	337	=item on_x_event $term, $event
338		338
339	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
340	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
…		…
379	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
380	(real, not screen-based) row and column under the mouse cursor.	380	(real, not screen-based) row and column under the mouse cursor.
381		381
382	C<on_key_press> additionally receives the string rxvt-unicode would	382	C<on_key_press> additionally receives the string rxvt-unicode would
383	output, if any, in locale-specific encoding.	383	output, if any, in locale-specific encoding.
384
385	subwindow.
386		384
387	=item on_client_message $term, $event	385	=item on_client_message $term, $event
388		386
389	=item on_wm_protocols $term, $event	387	=item on_wm_protocols $term, $event
390		388
…		…
518	ConfigureRequest, GravityNotify, ResizeRequest, CirculateNotify,	516	ConfigureRequest, GravityNotify, ResizeRequest, CirculateNotify,
519	CirculateRequest, PropertyNotify, SelectionClear, SelectionRequest,	517	CirculateRequest, PropertyNotify, SelectionClear, SelectionRequest,
520	SelectionNotify, ColormapNotify, ClientMessage, MappingNotify	518	SelectionNotify, ColormapNotify, ClientMessage, MappingNotify
521		519
522	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.
523		533
524	=back	534	=back
525		535
526	=head2 RENDITION	536	=head2 RENDITION
527		537
…		…
593	no warnings 'utf8';	603	no warnings 'utf8';
594		604
595	sub parse_resource {	605	sub parse_resource {
596	my ($term, $name, $isarg, $longopt, $flag, $value) = @_;	606	my ($term, $name, $isarg, $longopt, $flag, $value) = @_;
597		607
598	$name =~ y/-/./ if $isarg;
599
600	$term->scan_meta;	608	$term->scan_extensions;
601		609
		610	# iterating over all resources has quadratic time overhead
		611	# overall, maybe this could be optimised?
602	my $r = $term->{meta}{resource};	612	my $r = $term->{meta}{resource};
603	keys %$r; # reste iterator	613	keys %$r; # reset iterator
604	while (my ($pattern, $v) = each %$r) {	614	while (my ($k, $v) = each %$r) {
605	if (	615	my $pattern = $k;
		616	$pattern =~ y/./-/ if $isarg;
		617	my $prefix = $name;
		618	my $suffix;
606	$pattern =~ /\.$/	619	if ($pattern =~ /\-$/) {
607	? $pattern eq substr $name, 0, length $pattern	620	$prefix = substr $name, 0, length $pattern;
608	: $pattern eq $name	621	$suffix = substr $name, length $pattern;
609	) {	622	}
		623	if ($pattern eq $prefix) {
610	$name = "$urxvt::RESCLASS.$name";	624	$name = "$urxvt::RESCLASS.$k$suffix";
611		625
612	push @{ $term->{perl_ext_3} }, $v->[0];	626	push @{ $term->{perl_ext_3} }, $v->[0];
		627
		628	return 1 unless $isarg;
613		629
614	if ($v->[1] eq "boolean") {	630	if ($v->[1] eq "boolean") {
615	$term->put_option_db ($name, $flag ? "true" : "false");	631	$term->put_option_db ($name, $flag ? "true" : "false");
616	return 1;	632	return 1;
617	} else {	633	} else {
…		…
625	}	641	}
626		642
627	sub usage {	643	sub usage {
628	my ($term, $usage_type) = @_;	644	my ($term, $usage_type) = @_;
629		645
630	$term->scan_meta;	646	$term->scan_extensions;
631		647
632	my $r = $term->{meta}{resource};	648	my $r = $term->{meta}{resource};
633		649
634	for my $pattern (sort keys %$r) {	650	for my $pattern (sort keys %$r) {
635	my ($ext, $type, $desc) = @{ $r->{$pattern} };	651	my ($ext, $type, $desc) = @{ $r->{$pattern} };
…		…
696	# called by the rxvt core	712	# called by the rxvt core
697	sub invoke {	713	sub invoke {
698	local $TERM = shift;	714	local $TERM = shift;
699	my $htype = shift;	715	my $htype = shift;
700		716
701	if ($htype == 0) { # INIT	717	if ($htype == HOOK_INIT) {
702	my @dirs = $TERM->perl_libdirs;	718	my @dirs = $TERM->perl_libdirs;
		719
		720	$TERM->scan_extensions;
703		721
704	my %ext_arg;	722	my %ext_arg;
705		723
706	{	724	{
707	my @init = @TERM_INIT;	725	my @init = @TERM_INIT;
…		…
712	$TERM->register_package ($_) for @pkg;	730	$TERM->register_package ($_) for @pkg;
713	}	731	}
714		732
715	for (	733	for (
716	@{ delete $TERM->{perl_ext_3} },	734	@{ delete $TERM->{perl_ext_3} },
717	grep $_, map { split /,/, $TERM->resource ("perl_ext_$_") } 1, 2	735	(grep $_, map { split /,/, $TERM->resource ("perl_ext_$_") } 1, 2),
718	) {	736	) {
719	if ($_ eq "default") {	737	if ($_ eq "default") {
		738
		739	$ext_arg{$_} = []
720	$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
721	} elsif (/^-(.*)$/) {	751	} elsif (/^-(.*)$/) {
722	delete $ext_arg{$1};	752	delete $ext_arg{$1};
		753
723	} elsif (/^([^<]+)<(.*)>$/) {	754	} elsif (/^([^<]+)<(.*)>$/) {
724	push @{ $ext_arg{$1} }, $2;	755	push @{ $ext_arg{$1} }, $2;
		756
725	} else {	757	} else {
726	$ext_arg{$_} \|\|= [];	758	$ext_arg{$_} \|\|= [];
727	}	759	}
728	}	760	}
729		761
…		…
745		777
746	if (my $cb = $TERM->{_hook}[$htype]) {	778	if (my $cb = $TERM->{_hook}[$htype]) {
747	verbose 10, "$HOOKNAME[$htype] (" . (join ", ", $TERM, @_) . ")"	779	verbose 10, "$HOOKNAME[$htype] (" . (join ", ", $TERM, @_) . ")"
748	if $verbosity >= 10;	780	if $verbosity >= 10;
749		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
750	for my $pkg (keys %$cb) {	795	for my $pkg (keys %$cb) {
751	my $retval_ = eval { $cb->{$pkg}->($TERM->{_pkg}{$pkg} \|\| $TERM, @_) };	796	my $retval_ = eval { $cb->{$pkg}->($TERM->{_pkg}{$pkg} \|\| $TERM, @_) };
752	$retval \|\|= $retval_;	797	$retval \|\|= $retval_;
753		798
754	if ($@) {	799	if ($@) {
…		…
759		804
760	verbose 11, "$HOOKNAME[$htype] returning <$retval>"	805	verbose 11, "$HOOKNAME[$htype] returning <$retval>"
761	if $verbosity >= 11;	806	if $verbosity >= 11;
762	}	807	}
763		808
764	if ($htype == 1) { # DESTROY	809	if ($htype == HOOK_DESTROY) {
765	# clear package objects	810	# clear package objects
766	%$_ = () for values %{ $TERM->{_pkg} };	811	%$_ = () for values %{ $TERM->{_pkg} };
767		812
768	# clear package	813	# clear package
769	%$TERM = ();	814	%$TERM = ();
…		…
801	($mask, @color{qw(fg bg)}, \@failed)	846	($mask, @color{qw(fg bg)}, \@failed)
802	}	847	}
803		848
804	package urxvt::term::extension;	849	package urxvt::term::extension;
805		850
806	sub enable {	851	=head2 The C<urxvt::term::extension> class
807	my ($self, %hook) = @_;
808	my $pkg = $self->{_pkg};
809		852
810	while (my ($name, $cb) = each %hook) {	853	Each extension attached to a terminal object is represented by
811	my $htype = $HOOKTYPE{uc $name};	854	a C<urxvt::term::extension> object.
812	defined $htype
813	or Carp::croak "unsupported hook type '$name'";
814		855
815	$self->set_should_invoke ($htype, +1)	856	You can use these objects, which are passed to all callbacks to store any
816	unless exists $self->{term}{_hook}[$htype]{$pkg};	857	state related to the terminal and extension instance.
817		858
818	$self->{term}{_hook}[$htype]{$pkg} = $cb;	859	The methods (And data members) documented below can be called on extension
819	}	860	objects, in addition to call methods documented for the <urxvt::term>
820	}	861	class.
821		862
822	sub disable {	863	=over 4
823	my ($self, @hook) = @_;
824	my $pkg = $self->{_pkg};
825		864
826	for my $name (@hook) {	865	=item $urxvt_term = $self->{term}
827	my $htype = $HOOKTYPE{uc $name};
828	defined $htype
829	or Carp::croak "unsupported hook type '$name'";
830		866
831	$self->set_should_invoke ($htype, -1)	867	Returns the C<urxvt::term> object associated with this instance of the
832	if delete $self->{term}{_hook}[$htype]{$pkg};	868	extension. This member I<must not> be changed in any way.
833	}	869
834	}	870	=cut
835		871
836	our $AUTOLOAD;	872	our $AUTOLOAD;
837		873
838	sub AUTOLOAD {	874	sub AUTOLOAD {
839	$AUTOLOAD =~ /:([^:]+)$/	875	$AUTOLOAD =~ /:([^:]+)$/
…		…
852		888
853	sub DESTROY {	889	sub DESTROY {
854	# nop	890	# nop
855	}	891	}
856		892
857	# urxvt::destroy_hook	893	# urxvt::destroy_hook (basically a cheap Guard:: implementation)
858		894
859	sub urxvt::destroy_hook::DESTROY {	895	sub urxvt::destroy_hook::DESTROY {
860	${$_[0]}->();	896	${$_[0]}->();
861	}	897	}
862		898
863	sub urxvt::destroy_hook(&) {	899	sub urxvt::destroy_hook(&) {
864	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)
865	}	1008	}
866		1009
867	sub x_resource {	1010	sub x_resource {
868	my ($self, $name) = @_;	1011	my ($self, $name) = @_;
869	$name =~ s/^%(\.\|$)/$_[0]{_name}$1/;	1012	$name =~ s/^%(\.\|$)/$_[0]{_name}$1/;
…		…
873	sub x_resource_boolean {	1016	sub x_resource_boolean {
874	my ($self, $name) = @_;	1017	my ($self, $name) = @_;
875	$name =~ s/^%(\.\|$)/$_[0]{_name}$1/;	1018	$name =~ s/^%(\.\|$)/$_[0]{_name}$1/;
876	$self->{term}->x_resource_boolean ($name)	1019	$self->{term}->x_resource_boolean ($name)
877	}	1020	}
		1021
		1022	=back
		1023
		1024	=cut
878		1025
879	package urxvt::anyevent;	1026	package urxvt::anyevent;
880		1027
881	=head2 The C<urxvt::anyevent> Class	1028	=head2 The C<urxvt::anyevent> Class
882		1029
…		…
1001	$ENV{URXVT_PERL_LIB},	1148	$ENV{URXVT_PERL_LIB},
1002	"$ENV{HOME}/.urxvt/ext",	1149	"$ENV{HOME}/.urxvt/ext",
1003	"$LIBDIR/perl"	1150	"$LIBDIR/perl"
1004	}	1151	}
1005		1152
1006	sub scan_meta {	1153	# scan for available extensions and collect their metadata
		1154	sub scan_extensions {
1007	my ($self) = @_;	1155	my ($self) = @_;
		1156
		1157	return if exists $self->{meta};
		1158
1008	my @libdirs = perl_libdirs $self;	1159	my @urxvtdirs = perl_libdirs $self;
		1160	# my @cpandirs = grep -d, map "$_/URxvt/Ext", @INC;
1009		1161
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;	1162	$self->{meta} = \my %meta;
1016		1163
1017	for my $dir (reverse @libdirs) {	1164	# first gather extensions
		1165
		1166	my $gather = sub {
		1167	my ($dir, $core) = @_;
		1168
1018	opendir my $fh, $dir	1169	opendir my $fh, $dir
1019	or next;	1170	or return;
		1171
1020	for my $ext (readdir $fh) {	1172	for my $ext (readdir $fh) {
1021	$ext ne "."	1173	$ext !~ /^\./
1022	and $ext ne ".."
1023	and open my $fh, "<", "$dir/$ext"
1024	or next;	1174	or next;
1025		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
1026	while (<$fh>) {	1187	while (<$fh>) {
1027	if (/^#:META:X_RESOURCE:(.*)/) {	1188	if (/^#:META:(?:X_)?RESOURCE:(.*)/) {
1028	my ($pattern, $type, $desc) = split /:/, $1;	1189	my ($pattern, $type, $desc) = split /:/, $1;
1029	$pattern =~ s/^%(\.\|$)/$ext$1/g; # % in pattern == extension name	1190	$pattern =~ s/^%(\.\|$)/$ext$1/g; # % in pattern == extension name
1030	if ($pattern =~ /[^a-zA-Z0-9\-\.]/) {	1191	if ($pattern =~ /[^a-zA-Z0-9\-\.]/) {
1031	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";
1032	} else {	1193	} else {
1033	$meta{resource}{$pattern} = [$ext, $type, $desc];	1194	$ext{resource}{$pattern} = [$ext, $type, $desc];
1034	}	1195	}
1035	} elsif (/^\s*(?:#\|$)/) {	1196	} elsif (/^\s*(?:#\|$)/) {
1036	# skip other comments and empty lines	1197	# skip other comments and empty lines
1037	} else {	1198	} else {
1038	last; # stop parsing on first non-empty non-comment line	1199	last; # stop parsing on first non-empty non-comment line
1039	}	1200	}
1040	}	1201	}
		1202
		1203	$meta{ext}{$ext} = \%ext;
1041	}	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} });
1042	}	1217	}
1043	}	1218	}
1044		1219
1045	=item $term = new urxvt::term $envhashref, $rxvtname, [arg...]	1220	=item $term = new urxvt::term $envhashref, $rxvtname, [arg...]
1046		1221
…		…
1066	}	1241	}
1067		1242
1068	=item $term->destroy	1243	=item $term->destroy
1069		1244
1070	Destroy the terminal object (close the window, free resources	1245	Destroy the terminal object (close the window, free resources
1071	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
1072	watchers (timers, io watchers) are still active.	1247	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 given 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 parameters, 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		1248
1117	=item $term->exec_async ($cmd[, @args])	1249	=item $term->exec_async ($cmd[, @args])
1118		1250
1119	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
1120	("starts") programs in the background. This function takes care of setting	1252	("starts") programs in the background. This function takes care of setting
…		…
1205	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
1206	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
1207	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
1208	resource with that pattern exists.	1340	resource with that pattern exists.
1209		1341
1210	Extensions that define extra resource or command line arguments also need	1342	Extensions that define extra resources also need to call this method
1211	to call this method to access their values.	1343	to access their values.
1212		1344
1213	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
1214	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
1215	the extension and a dot, and the lone string C<%> will be replaced by the	1347	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	1348	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	1349	can rename them and get a new set of resources without having to change
1218	without having to change the actual code.	1350	the actual code.
1219		1351
1220	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
1221	only one resource database per display, and later invocations might return	1353	only one resource database per display, and later invocations might return
1222	the wrong resources.	1354	the wrong resources.
1223		1355
…		…
1235	my $res = &x_resource;	1367	my $res = &x_resource;
1236		1368
1237	$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
1238	}	1370	}
1239		1371
1240	=item $success = $term->parse_keysym ($key, $octets)	1372	=item $action = $term->lookup_keysym ($keysym, $state)
1241		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
1242	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
1243	C<keysym> resource in the @@RXVT_NAME@@(1) manpage.	1380	C<keysym> resource in the urxvt(1) manpage.
1244		1381
1245	=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.
1246		1386
1247	Adds a key binding. This is a lower level api compared to	1387	Example: the C<searchable-scrollback> by default binds itself
1248	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<<
1249	used only inside either the C<on_init> hook, to add a binding, or the	1389	$term->bind_action >>.
1250	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	}
1251		1396
1252	=item $rend = $term->rstyle ([$new_rstyle])	1397	=item $rend = $term->rstyle ([$new_rstyle])
1253		1398
1254	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
1255	the terminal application will use this style.	1400	the terminal application will use this style.
…		…
1413		1558
1414	=item $term->scr_add_lines ($string)	1559	=item $term->scr_add_lines ($string)
1415		1560
1416	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
1417	running inside the terminal. It may not contain command sequences (escape	1562	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	1563	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.	1564	carriage returns and tabs. The string is a normal text string, not in
		1565	locale-dependent encoding.
1420		1566
1421	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
1422	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
1423	C<on_add_lines> hook, though.	1569	C<on_add_lines> hook, though.
1424		1570
…		…
1432	locale-specific encoding of the terminal and can contain command sequences	1578	locale-specific encoding of the terminal and can contain command sequences
1433	(escape codes) that will be interpreted.	1579	(escape codes) that will be interpreted.
1434		1580
1435	=item $term->tt_write ($octets)	1581	=item $term->tt_write ($octets)
1436		1582
1437	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
1438	pass characters instead of octets, you should convert your strings first	1585	characters instead of octets, you should convert your strings first to the
1439	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.
1440		1595
1441	=item $term->tt_paste ($octets)	1596	=item $term->tt_paste ($octets)
1442		1597
1443	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
1444	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
…		…
1483		1638
1484	=item $term->key_release ($state, $keycode[, $time])	1639	=item $term->key_release ($state, $keycode[, $time])
1485		1640
1486	Deliver various fake events to to terminal.	1641	Deliver various fake events to to terminal.
1487		1642
1488	=item $window_width = $term->width	1643	=item $window_width = $term->width ([$new_value])
1489		1644
1490	=item $window_height = $term->height	1645	=item $window_height = $term->height ([$new_value])
1491		1646
1492	=item $font_width = $term->fwidth	1647	=item $font_width = $term->fwidth ([$new_value])
1493		1648
1494	=item $font_height = $term->fheight	1649	=item $font_height = $term->fheight ([$new_value])
1495		1650
1496	=item $font_ascent = $term->fbase	1651	=item $font_ascent = $term->fbase ([$new_value])
1497		1652
1498	=item $terminal_rows = $term->nrow	1653	=item $terminal_rows = $term->nrow ([$new_value])
1499		1654
1500	=item $terminal_columns = $term->ncol	1655	=item $terminal_columns = $term->ncol ([$new_value])
1501		1656
1502	=item $has_focus = $term->focus	1657	=item $has_focus = $term->focus ([$new_value])
1503		1658
1504	=item $is_mapped = $term->mapped	1659	=item $is_mapped = $term->mapped ([$new_value])
1505		1660
1506	=item $max_scrollback = $term->saveLines	1661	=item $max_scrollback = $term->saveLines ([$new_value])
1507		1662
1508	=item $nrow_plus_saveLines = $term->total_rows	1663	=item $nrow_plus_saveLines = $term->total_rows ([$new_value])
1509		1664
1510	=item $topmost_scrollback_row = $term->top_row	1665	=item $topmost_scrollback_row = $term->top_row ([$new_value])
1511		1666
1512	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.
1513		1669
1514	=item $x_display = $term->display_id	1670	=item $x_display = $term->display_id
1515		1671
1516	Return the DISPLAY used by rxvt-unicode.	1672	Return the DISPLAY used by rxvt-unicode.
1517		1673
…		…
1553	Returns the currently displayed screen (0 primary, 1 secondary).	1709	Returns the currently displayed screen (0 primary, 1 secondary).
1554		1710
1555	=item $cursor_is_hidden = $term->hidden_cursor	1711	=item $cursor_is_hidden = $term->hidden_cursor
1556		1712
1557	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	}
1558		1724
1559	=item $view_start = $term->view_start ([$newvalue])	1725	=item $view_start = $term->view_start ([$newvalue])
1560		1726
1561	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
1562	C<0>, which displays the normal terminal contents. Lower values scroll	1728	C<0>, which displays the normal terminal contents. Lower values scroll
…		…
1567	Requests a screen refresh. At the next opportunity, rxvt-unicode will	1733	Requests a screen refresh. At the next opportunity, rxvt-unicode will
1568	compare the on-screen display with its stored representation. If they	1734	compare the on-screen display with its stored representation. If they
1569	differ, it redraws the differences.	1735	differ, it redraws the differences.
1570		1736
1571	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.
1572		1742
1573	=item $text = $term->ROW_t ($row_number[, $new_text[, $start_col]])	1743	=item $text = $term->ROW_t ($row_number[, $new_text[, $start_col]])
1574		1744
1575	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 >>
1576	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
…		…
1678	}	1848	}
1679		1849
1680	sub urxvt::line::t {	1850	sub urxvt::line::t {
1681	my ($self) = @_;	1851	my ($self) = @_;
1682		1852
1683	if (@_ > 1)	1853	if (@_ > 1) {
1684	{
1685	$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})
1686	for $self->{beg} .. $self->{end};	1855	for $self->{beg} .. $self->{end};
1687	}	1856	}
1688		1857
1689	defined wantarray &&	1858	defined wantarray &&
1690	substr +(join "", map $self->{term}->ROW_t ($_), $self->{beg} .. $self->{end}),	1859	substr +(join "", map $self->{term}->ROW_t ($_), $self->{beg} .. $self->{end}),
1691	0, $self->{len}	1860	0, $self->{len}
1692	}	1861	}
1693		1862
1694	sub urxvt::line::r {	1863	sub urxvt::line::r {
1695	my ($self) = @_;	1864	my ($self) = @_;
1696		1865
1697	if (@_ > 1)	1866	if (@_ > 1) {
1698	{
1699	$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})
1700	for $self->{beg} .. $self->{end};	1868	for $self->{beg} .. $self->{end};
1701	}	1869	}
1702		1870
1703	if (defined wantarray) {	1871	if (defined wantarray) {
1704	my $rend = [	1872	my $rend = [
1705	map @{ $self->{term}->ROW_r ($_) }, $self->{beg} .. $self->{end}	1873	map @{ $self->{term}->ROW_r ($_) }, $self->{beg} .. $self->{end}
1706	];	1874	];

Diff Legend

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

Comparing rxvt-unicode/src/urxvt.pm (file contents): Revision 1.221 by sf-exg, Thu Jun 21 06:08:05 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.221 by sf-exg, Thu Jun 21 06:08:05 2012 UTC vs.
Revision 1.261 by root, Fri Jun 18 12:35:38 2021 UTC