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

Comparing rxvt-unicode/src/urxvt.pm (file contents):
Revision 1.245 by root, Mon Dec 22 09:10:12 2014 UTC vs.
Revision 1.268 by root, Sat Jul 24 13:07:56 2021 UTC

…		…
4		4
5	urxvtperl - 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 some directory:
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 urxvt using it:	16	# start a urxvt instance using it:
17		17
18	urxvt --perl-lib $HOME -pe grab_test	18	urxvt --perl-lib path/to/somedirectory -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 qw(vars subs)' and 'use utf8'
26	thus must be encoded as UTF-8.	26	environment, and thus must be encoded as UTF-8.
27		27
28	Each script will only ever be loaded once, even in urxvtd, 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"
…		…
45		45
46	URxvt.perl-ext-common: default,selection-autotransform	46	URxvt.perl-ext-common: default,selection-autotransform
47		47
48	Extensions may add additional resources and C<actions>, i.e., methods	48	Extensions may add additional resources and C<actions>, i.e., methods
49	which can be bound to a key and invoked by the user. An extension can	49	which can be bound to a key and invoked by the user. An extension can
50	define the resources it support and also default bindings for one or	50	define the resources it support using so called META comments,
51	more actions it provides using so called META comments, described
52	below. Similarly to builtin resources, extension resources can also be	51	described below. Similarly to builtin resources, extension resources
53	specified on the command line as long options (with C<.> replaced by	52	can also be specified on the command line as long options (with C<.>
54	C<->), in which case the corresponding extension is loaded	53	replaced by C<->), in which case the corresponding extension is loaded
55	automatically. For this to work the extension B<must> define META	54	automatically. For this to work the extension B<must> define META
56	comments for its resources.	55	comments for its resources.
57		56
58	=head1 API DOCUMENTATION	57	=head1 API DOCUMENTATION
59		58
…		…
71	terminal is destroyed.	70	terminal is destroyed.
72		71
73	Argument names also often indicate the type of a parameter. Here are some	72	Argument names also often indicate the type of a parameter. Here are some
74	hints on what they mean:	73	hints on what they mean:
75		74
76	=over 4	75	=over
77		76
78	=item $text	77	=item $text
79		78
80	Rxvt-unicode's special way of encoding text, where one "unicode" character	79	Rxvt-unicode's special way of encoding text, where one "unicode" character
81	always represents one screen cell. See L<ROW_t> for a discussion of this format.	80	always represents one screen cell. See L<ROW_t> for a discussion of this format.
…		…
115	Additional methods only supported for extension objects are described in	114	Additional methods only supported for extension objects are described in
116	the C<urxvt::extension> section below.	115	the C<urxvt::extension> section below.
117		116
118	=head2 META comments	117	=head2 META comments
119		118
120	rxvt-unicode recognizes special comments in extensions that define	119	Rxvt-unicode recognizes special meta comments in extensions that define
121	different types of metadata:	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.
122		123
		124	Currently, it recognises these comments below. Individual components are
		125	separated by colons (C<:>), and should not contain colons themselves -
		126	there is also currently no escaping mechanism provided for this.
		127
123	=over 4	128	=over
124		129
125	=item #:META:RESOURCE:name:type:desc	130	=item #:META:RESOURCE:name:type:desc
126		131
127	The RESOURCE comment defines a resource used by the extension, where	132	The RESOURCE comment defines a resource used by the extension, where
128	C<name> is the resource name, C<type> is the resource type, C<boolean>	133	C<name> is the resource name, C<type> is the resource type, C<boolean>
129	or C<string>, and C<desc> is the resource description.	134	or C<string>, and C<desc> is the resource description.
130		135
131	=item #:META:BINDING:sym:action	136	The extension will be autoloaded when this resource is specified or used
		137	as a command line parameter.
132		138
133	The BINDING comment defines a default binding for an action provided	139	Example: matcher provides the C<matcher.launcher> resource by having this
134	by the extension, where C<sym> is the key combination that triggers	140	comment:
135	the action, whose format is defined in the description of the	141
136	B<keysym> resource in the urxvt(1) manpage, and C<action> is the name	142	#:META:RESOURCE:%.launcher:string:default launcher command
137	of the action method.	143
		144	Example: load this extension when the C<-tr> command line option or
		145	resource name is used.
		146
		147	#:META:RESOURCE:tr:boolean:set root pixmap as background
		148
		149	=item #:META:OSC:number:desc
		150
		151	The OSC comment specifies an OSC sequence, where C<number> is the
		152	numerical OSC code and C<desc> is a short description that is currently
		153	unused.
		154
		155	This will cause the extension to be autoloaded when the OSC sequence is
		156	used for the first time.
		157
		158	Note that autoloading carries some extra responsibilities with it:
		159	although the terminal cannot really protect itself against malicious
		160	sources of command sequences, therefore relying on the programs running
		161	I<inside> to sanitize data that they output, it is very common for
		162	programs to emit command sequences from untrusted sources.
		163
		164	While this means that extensions should, as a defense-in-depth mechanism,
		165	always consider whether OSC sequences are safe, autoloading automatically
		166	exposes any autoloaded extension in all terminal windows, so extra care
		167	should be taken.
		168
		169	Example: the background extension registers OSC C<20> like this:
		170
		171	#:META:OSC:20:change/query background image
		172
		173	=item #:META:OSC_PERL:prefix:desc
		174
		175	The same as the OSC comment, but for the Perl OSC sequence (C<777>). The
		176	C<prefix> should be unique among extensions, of course, which is most
		177	easily arranged by using the extension name, although this is not
		178	required.
		179
		180	Example: the overlay-osc extension registers its Perl OSC like this:
		181
		182	#:META:OSC_PERL:overlay:man overlay-osc
138		183
139	=back	184	=back
140		185
141	=head2 Hooks	186	=head2 Hooks
142		187
…		…
150	hooks returns true, then the event counts as being I<consumed>, and the	195	hooks returns true, then the event counts as being I<consumed>, and the
151	relevant action might not be carried out by the C++ code.	196	relevant action might not be carried out by the C++ code.
152		197
153	I<< When in doubt, return a false value (preferably C<()>). >>	198	I<< When in doubt, return a false value (preferably C<()>). >>
154		199
155	=over 4	200	=over
156		201
157	=item on_init $term	202	=item on_init $term
158		203
159	Called after a new terminal object has been initialized, but before	204	Called after a new terminal object has been initialized, but before
160	windows are created or the command gets run. Most methods are unsafe to	205	windows are created or the command gets run. Most methods are unsafe to
…		…
242		287
243	C<on_osc_seq_perl> should be used for new behaviour.	288	C<on_osc_seq_perl> should be used for new behaviour.
244		289
245	=item on_osc_seq_perl $term, $args, $resp	290	=item on_osc_seq_perl $term, $args, $resp
246		291
247	Called whenever the B<ESC ] 777 ; string ST> command sequence (OSC =	292	Called whenever the B<ESC ] 777 ; prefix ; string ST> command sequence
248	operating system command) is processed. Cursor position and other state	293	(OSC = operating system command) is processed. Cursor position and other
249	information is up-to-date when this happens. For interoperability, the	294	state information is up-to-date when this happens. For interoperability,
250	string should start with the extension name (sans -osc) and a semicolon,	295	the argument should start with the extension name (sans -osc) or some
251	to distinguish it from commands for other extensions, and this might be	296	other suitable prefix, and a semicolon, to distinguish it from commands
252	enforced in the future.	297	for other extensions.
253		298
254	For example, C<overlay-osc> uses this:	299	For example, C<overlay-osc> uses this:
255		300
256	sub on_osc_seq_perl {	301	sub on_osc_seq_perl {
257	my ($self, $osc, $resp) = @_;	302	my ($self, $osc, $resp) = @_;
…		…
402	=cut	447	=cut
403		448
404	package urxvt;	449	package urxvt;
405		450
406	use utf8;	451	use utf8;
407	use strict 'vars';	452	use strict qw(vars subs);
408	use Carp ();	453	use Carp ();
409	use Scalar::Util ();	454	use Scalar::Util ();
410	use List::Util ();	455	use List::Util ();
411		456
412	our $VERSION = 1;	457	our $VERSION = 1;
…		…
424		469
425	our $NOCHAR = chr 0xffff;	470	our $NOCHAR = chr 0xffff;
426		471
427	=head2 Variables in the C<urxvt> Package	472	=head2 Variables in the C<urxvt> Package
428		473
429	=over 4	474	=over
430		475
431	=item $urxvt::LIBDIR	476	=item $urxvt::LIBDIR
432		477
433	The rxvt-unicode library directory, where, among other things, the perl	478	The rxvt-unicode library directory, where, among other things, the perl
434	modules and scripts are stored.	479	modules and scripts are stored.
…		…
464		509
465	=back	510	=back
466		511
467	=head2 Functions in the C<urxvt> Package	512	=head2 Functions in the C<urxvt> Package
468		513
469	=over 4	514	=over
470		515
471	=item urxvt::fatal $errormessage	516	=item urxvt::fatal $errormessage
472		517
473	Fatally aborts execution with the given error message (which should	518	Fatally aborts execution with the given error message (which should
474	include a trailing newline). Avoid at all costs! The only time this	519	include a trailing newline). Avoid at all costs! The only time this
…		…
519	CirculateRequest, PropertyNotify, SelectionClear, SelectionRequest,	564	CirculateRequest, PropertyNotify, SelectionClear, SelectionRequest,
520	SelectionNotify, ColormapNotify, ClientMessage, MappingNotify	565	SelectionNotify, ColormapNotify, ClientMessage, MappingNotify
521		566
522	Various constants for use in X calls and event processing.	567	Various constants for use in X calls and event processing.
523		568
		569	=item urxvt::PrivMode_132, PrivMode_132OK, PrivMode_rVideo, PrivMode_relOrigin,
		570	PrivMode_Screen, PrivMode_Autowrap, PrivMode_aplCUR, PrivMode_aplKP,
		571	PrivMode_HaveBackSpace, PrivMode_BackSpace, PrivMode_ShiftKeys,
		572	PrivMode_VisibleCursor, PrivMode_MouseX10, PrivMode_MouseX11,
		573	PrivMode_scrollBar, PrivMode_TtyOutputInh, PrivMode_Keypress,
		574	PrivMode_smoothScroll, PrivMode_vt52, PrivMode_LFNL, PrivMode_MouseBtnEvent,
		575	PrivMode_MouseAnyEvent, PrivMode_BracketPaste, PrivMode_ExtMouseUTF8,
		576	PrivMode_ExtMouseUrxvt, PrivMode_BlinkingCursor, PrivMode_mouse_report,
		577	PrivMode_Default
		578
		579	Constants for checking DEC private modes.
		580
524	=back	581	=back
525		582
526	=head2 RENDITION	583	=head2 RENDITION
527		584
528	Rendition bitsets contain information about colour, font, font styles and	585	Rendition bitsets contain information about colour, font, font styles and
…		…
531	The following "macros" deal with changes in rendition sets. You should	588	The following "macros" deal with changes in rendition sets. You should
532	never just create a bitset, you should always modify an existing one,	589	never just create a bitset, you should always modify an existing one,
533	as they contain important information required for correct operation of	590	as they contain important information required for correct operation of
534	rxvt-unicode.	591	rxvt-unicode.
535		592
536	=over 4	593	=over
537		594
538	=item $rend = urxvt::DEFAULT_RSTYLE	595	=item $rend = urxvt::DEFAULT_RSTYLE
539		596
540	Returns the default rendition, as used when the terminal is starting up or	597	Returns the default rendition, as used when the terminal is starting up or
541	being reset. Useful as a base to start when creating renditions.	598	being reset. Useful as a base to start when creating renditions.
…		…
595	sub parse_resource {	652	sub parse_resource {
596	my ($term, $name, $isarg, $longopt, $flag, $value) = @_;	653	my ($term, $name, $isarg, $longopt, $flag, $value) = @_;
597		654
598	$term->scan_extensions;	655	$term->scan_extensions;
599		656
		657	# iterating over all resources has quadratic time overhead
		658	# overall, maybe this could be optimised?
600	my $r = $term->{meta}{resource};	659	my $r = $term->{meta}{resource};
601	keys %$r; # reset iterator	660	keys %$r; # reset iterator
602	while (my ($k, $v) = each %$r) {	661	while (my ($k, $v) = each %$r) {
603	my $pattern = $k;	662	my $pattern = $k;
604	$pattern =~ y/./-/ if $isarg;	663	$pattern =~ y/./-/ if $isarg;
…		…
611	if ($pattern eq $prefix) {	670	if ($pattern eq $prefix) {
612	$name = "$urxvt::RESCLASS.$k$suffix";	671	$name = "$urxvt::RESCLASS.$k$suffix";
613		672
614	push @{ $term->{perl_ext_3} }, $v->[0];	673	push @{ $term->{perl_ext_3} }, $v->[0];
615		674
		675	return 1 unless $isarg;
		676
616	if ($v->[1] eq "boolean") {	677	if ($v->[1] eq "boolean") {
617	$term->put_option_db ($name, $flag ? "true" : "false");	678	$term->put_option_db ($name, $flag ? "true" : "false");
618	return 1;	679	return 1;
619	} else {	680	} else {
620	$term->put_option_db ($name, $value);	681	$term->put_option_db ($name, $value);
…		…
652	urxvt::log sprintf " %-31s %s\n", "$pattern:", $type;	713	urxvt::log sprintf " %-31s %s\n", "$pattern:", $type;
653	}	714	}
654	}	715	}
655	}	716	}
656		717
657	my $verbosity = $ENV{URXVT_PERL_VERBOSITY};	718	my $verbosity = $ENV{URXVT_PERL_VERBOSITY} // 2;
658		719
659	sub verbose {	720	sub verbose {
660	my ($level, $msg) = @_;	721	my ($level, $msg) = @_;
661	warn "$msg\n" if $level <= $verbosity;	722	warn "$msg\n" if $level <= $verbosity;
662	}	723	}
…		…
679		740
680	open my $fh, "<:raw", $path	741	open my $fh, "<:raw", $path
681	or die "$path: $!";	742	or die "$path: $!";
682		743
683	my $source =	744	my $source =
684	"package $pkg; use strict 'vars'; use utf8; no warnings 'utf8';\n"	745	"package $pkg; use strict qw(vars subs); use utf8; no warnings 'utf8';\n"
685	. "#line 1 \"$path\"\n{\n"	746	. "#line 1 \"$path\"\n{\n"
686	. (do { local $/; <$fh> })	747	. (do { local $/; <$fh> })
687	. "\n};\n1";	748	. "\n};\n1";
688		749
689	eval $source	750	eval $source
…		…
699	sub invoke {	760	sub invoke {
700	local $TERM = shift;	761	local $TERM = shift;
701	my $htype = shift;	762	my $htype = shift;
702		763
703	if ($htype == HOOK_INIT) {	764	if ($htype == HOOK_INIT) {
704	my @dirs = $TERM->perl_libdirs;
705
706	$TERM->scan_extensions;	765	$TERM->scan_extensions;
707		766
708	my %ext_arg;	767	my %ext_arg;
709		768
710	{	769	{
…		…
715	@TERM_EXT = ();	774	@TERM_EXT = ();
716	$TERM->register_package ($_) for @pkg;	775	$TERM->register_package ($_) for @pkg;
717	}	776	}
718		777
719	for (	778	for (
		779	@{ delete $TERM->{perl_ext_3} },
720	(grep $_, map { split /,/, $TERM->resource ("perl_ext_$_") } 1, 2),	780	(grep $_, map { split /,/, $TERM->resource ("perl_ext_$_") } 1, 2),
721	@{ delete $TERM->{perl_ext_3} }
722	) {	781	) {
723	if ($_ eq "default") {	782	if ($_ eq "default") {
724		783
725	$ext_arg{$_} = []	784	$ext_arg{$_} = []
726	for
727	qw(selection option-popup selection-popup readline),	785	for qw(selection option-popup selection-popup readline searchable-scrollback confirm-paste);
728	map $_->[0], values %{ $TERM->{meta}{binding} };
729		786
730	for ($TERM->_keysym_resources) {	787	for ($TERM->_keysym_resources) {
731	next if /^(?:string\|command\|builtin\|builtin-string\|perl)/;	788	next if /^(?:string\|command\|builtin\|builtin-string\|perl)/;
732	next unless /^([A-Za-z0-9_\-]+):/;	789	next unless /^([A-Za-z0-9_\-]+):/;
733		790
734	my $ext = $1;	791	my $ext = $1;
735		792
736	$ext_arg{$ext} = [];	793	$ext_arg{$ext} = [];
737	}	794	}
738		795
739	} elsif (/^-(.*)$/) {	796	} elsif (/^-(.*)$/) { # remove from set
740	delete $ext_arg{$1};	797	delete $ext_arg{$1};
741		798
742	} elsif (/^([^<]+)<(.*)>$/) {	799	} elsif (/^\/(.*)$/) { # prohibit loading
		800	undef $TERM->{ext_prohibit}{$1};
		801
		802	} elsif (/^([^<]+)(?:<(.*)>)?$/) { # add to set, clear prohibit status
		803	delete $TERM->{ext_prohibit}{$1};
743	push @{ $ext_arg{$1} }, $2;	804	push @{ $ext_arg{$1} }, defined $2 ? $2 : ();
744		805
745	} else {	806	} else {
746	$ext_arg{$_} \|\|= [];	807	verbose 2, "cannot parse extension specification '$_', ignoring.";
747	}	808	}
748	}	809	}
749		810
750	# now register default key bindings	811	$TERM->set_should_invoke (HOOK_OSC_SEQ , +1) if $TERM->{meta}{autoload_osc};
		812	$TERM->set_should_invoke (HOOK_OSC_SEQ_PERL, +1) if $TERM->{meta}{autoload_osc_perl};
		813
751	for my $ext (sort keys %ext_arg) {	814	for my $ext (sort keys %ext_arg) {
752	while (my ($k, $v) = each %{ $TERM->{meta}{ext}{$ext}{binding} }) {	815	my $path = $TERM->extension_path ($ext);
753	$TERM->bind_action ($k, "$v->[0]:$v->[1]");	816
		817	if (defined $path) {
		818	$TERM->autoload_extension ($ext, $ext_arg{$ext});
		819	} else {
		820	verbose 2, "perl extension '$ext' not found in perl library search path";
754	}	821	}
755	}	822	}
756		823
757	for my $ext (sort keys %ext_arg) {
758	my @files = grep -f $_, map "$_/$ext", @dirs;
759
760	if (@files) {
761	$TERM->register_package (extension_package $files[0], $ext_arg{$ext});
762	} else {
763	warn "perl extension '$ext' not found in perl library search path\n";
764	}
765	}
766
767	eval "#line 1 \"--perl-eval resource/argument\"\n" . $TERM->resource ("perl_eval");	824	eval "#line 1 \"--perl-eval resource/argument\"\n" . $TERM->resource ("perl_eval");
768	warn $@ if $@;	825	warn $@ if $@;
		826	}
		827
		828	if ($htype == HOOK_OSC_SEQ) {
		829	if (my $exts = delete $TERM->{meta}{autoload_osc}{$_[0]}) {
		830	$TERM->autoload_extension ($_->[0]) for @$exts;
		831	}
		832	} elsif ($htype == HOOK_OSC_SEQ_PERL) {
		833	if ($_[0] =~ /^([^;]+)/ and (my $exts = delete $TERM->{meta}{autoload_osc_perl}{$1})) {
		834	$TERM->autoload_extension ($_->[0]) for @$exts;
		835	}
769	}	836	}
770		837
771	$retval = undef;	838	$retval = undef;
772		839
773	if (my $cb = $TERM->{_hook}[$htype]) {	840	if (my $cb = $TERM->{_hook}[$htype]) {
…		…
853		920
854	The methods (And data members) documented below can be called on extension	921	The methods (And data members) documented below can be called on extension
855	objects, in addition to call methods documented for the <urxvt::term>	922	objects, in addition to call methods documented for the <urxvt::term>
856	class.	923	class.
857		924
858	=over 4	925	=over
859		926
860	=item $urxvt_term = $self->{term}	927	=item $urxvt_term = $self->{term}
861		928
862	Returns the C<urxvt::term> object associated with this instance of the	929	Returns the C<urxvt::term> object associated with this instance of the
863	extension. This member I<must not> be changed in any way.	930	extension. This member I<must not> be changed in any way.
…		…
981	}	1048	}
982		1049
983	bless \%disable, "urxvt::extension::on_disable"	1050	bless \%disable, "urxvt::extension::on_disable"
984	}	1051	}
985		1052
		1053	=item $self->bind_action ($hotkey, $action)
		1054
986	=item $self->x_resource ($pattern)	1055	=item $self->x_resource ($pattern)
987		1056
988	=item $self->x_resource_boolean ($pattern)	1057	=item $self->x_resource_boolean ($pattern)
989		1058
990	These methods support an additional C<%> prefix when called on an	1059	These methods support an additional C<%> prefix for C<$action> or
991	extension object - see the description of these methods in the	1060	C<$pattern> when called on an extension object, compared to the
		1061	C<urxvt::term> methods of the same name - see the description of these
992	C<urxvt::term> class for details.	1062	methods in the C<urxvt::term> class for details.
993		1063
994	=cut	1064	=cut
		1065
		1066	sub bind_action {
		1067	my ($self, $hotkey, $action) = @_;
		1068	$action =~ s/^%:/$_[0]{_name}:/;
		1069	$self->{term}->bind_action ($hotkey, $action)
		1070	}
995		1071
996	sub x_resource {	1072	sub x_resource {
997	my ($self, $name) = @_;	1073	my ($self, $name) = @_;
998	$name =~ s/^%(\.\|$)/$_[0]{_name}$1/;	1074	$name =~ s/^%(\.\|$)/$_[0]{_name}$1/;
999	$self->{term}->x_resource ($name)	1075	$self->{term}->x_resource ($name)
…		…
1095		1171
1096	package urxvt::term;	1172	package urxvt::term;
1097		1173
1098	=head2 The C<urxvt::term> Class	1174	=head2 The C<urxvt::term> Class
1099		1175
1100	=over 4	1176	=over
1101		1177
1102	=cut	1178	=cut
1103		1179
1104	# find on_xxx subs in the package and register them	1180	# find on_xxx subs in the package and register them
1105	# as hooks	1181	# as hooks
…		…
1126	$proxy->enable ($name => $ref);	1202	$proxy->enable ($name => $ref);
1127	}	1203	}
1128	}	1204	}
1129	}	1205	}
1130		1206
		1207	# map extension name to filesystem path
		1208	sub extension_path {
		1209	(grep -f $_, map "$_/$_[1]", $_[0]->perl_libdirs)[0]
		1210	}
		1211
		1212	# load an extension by name
		1213	sub load_extension_file {
		1214	my ($self, $path, $argv) = @_;
		1215
		1216	$self->register_package (urxvt::extension_package $path, $argv);
		1217	}
		1218
		1219	# autoload an extension unless loading it is prohibited
		1220	sub autoload_extension {
		1221	my ($self, $name, $argv) = @_;
		1222
		1223	return if exists $self->{ext_prohibit}{$name};
		1224
		1225	my $path = $self->extension_path ($name)
		1226	// return urxvt::verbose 2, "perl extension '$name' not found in perl library search path (during autoload)";
		1227
		1228	$self->load_extension_file ($path, $argv);
		1229	}
		1230
1131	sub perl_libdirs {	1231	sub perl_libdirs {
1132	map { split /:/ }	1232	map { split /:/ }
1133	$_[0]->resource ("perl_lib"),	1233	$_[0]->resource ("perl_lib"),
1134	$ENV{URXVT_PERL_LIB},	1234	$ENV{URXVT_PERL_LIB},
1135	"$ENV{HOME}/.urxvt/ext",	1235	"$ENV{HOME}/.urxvt/ext",
…		…
1140	sub scan_extensions {	1240	sub scan_extensions {
1141	my ($self) = @_;	1241	my ($self) = @_;
1142		1242
1143	return if exists $self->{meta};	1243	return if exists $self->{meta};
1144		1244
1145	my @libdirs = perl_libdirs $self;	1245	my @urxvtdirs = perl_libdirs $self;
		1246	# my @cpandirs = grep -d, map "$_/URxvt/Ext", @INC;
1146		1247
1147	# return if $self->{meta_libdirs} eq join "\x00", @libdirs;#d#
1148
1149	# $self->{meta_libdirs} = join "\x00", @libdirs;#d#
1150	$self->{meta} = \my %meta;	1248	$self->{meta} = \my %allmeta;
1151		1249
1152	# first gather extensions	1250	# first gather extensions
1153	for my $dir (reverse @libdirs) {	1251
		1252	my $gather = sub {
		1253	my ($dir, $core) = @_;
		1254
1154	opendir my $fh, $dir	1255	opendir my $fh, $dir
1155	or next;	1256	or return;
		1257
1156	for my $ext (readdir $fh) {	1258	for my $ext (readdir $fh) {
1157	$ext !~ /^\./	1259	$ext !~ /^\./
1158	and open my $fh, "<", "$dir/$ext"
1159	or next;	1260	or next;
1160		1261
		1262	open my $fh, "<", "$dir/$ext"
		1263	or next;
		1264
		1265	-f $fh
		1266	or next;
		1267
		1268	$ext =~ s/\.uext$// or $core
		1269	or next;
		1270
1161	my %ext = (dir => $dir);	1271	my %meta = (dir => $dir);
1162		1272
1163	while (<$fh>) {	1273	while (<$fh>) {
1164	if (/^#:META:(?:X_)?RESOURCE:(.*)/) {	1274	if (/^#:META:(?:X_)?RESOURCE:(.*)/) {
1165	my ($pattern, $type, $desc) = split /:/, $1;	1275	my ($pattern, $type, $desc) = split /:/, $1;
1166	$pattern =~ s/^%(\.\|$)/$ext$1/g; # % in pattern == extension name	1276	$pattern =~ s/^%(\.\|$)/$ext$1/g; # % in pattern == extension name
1167	if ($pattern =~ /[^a-zA-Z0-9\-\.]/) {	1277	if ($pattern =~ /[^a-zA-Z0-9\-\.]/) {
1168	warn "$dir/$ext: meta resource '$pattern' contains illegal characters (not alphanumeric nor . nor *)\n";	1278	warn "$dir/$ext: meta resource '$pattern' contains illegal characters (not alphanumeric nor . nor *)\n";
1169	} else {	1279	} else {
1170	$ext{resource}{$pattern} = [$ext, $type, $desc];	1280	$meta{resource}{$pattern} = [$ext, $type, $desc];
1171	}	1281	}
		1282
1172	} elsif (/^#:META:BINDING:(.*)/) {	1283	} elsif (/^#:META:OSC:([0-9]+):(.*)/) {
1173	my ($keysym, $action) = split /:/, $1;	1284	push @{$allmeta{autoload_osc}{$1}}, [$ext, $2];
1174	$ext{binding}{$keysym} = [$ext, $action];	1285
		1286	} elsif (/^#:META:OSC_PERL:([^:]+):(.*)/) {
		1287	push @{$allmeta{autoload_osc_perl}{$1}}, [$ext, $2];
		1288
1175	} elsif (/^\s*(?:#\|$)/) {	1289	} elsif (/^\s*(?:#\|$)/) {
1176	# skip other comments and empty lines	1290	# skip other comments and empty lines
		1291
1177	} else {	1292	} else {
1178	last; # stop parsing on first non-empty non-comment line	1293	last; # stop parsing on first non-empty non-comment line
1179	}	1294	}
1180	}	1295	}
1181		1296
1182	$meta{ext}{$ext} = \%ext;	1297	$allmeta{ext}{$ext} = \%meta;
1183	}	1298	}
1184	}	1299	};
1185		1300
		1301	# $gather->($_, 0) for @cpandirs;
		1302	$gather->($_, 1) for @urxvtdirs;
		1303
1186	# and now merge resources and bindings	1304	# and now merge resources
		1305
		1306	$allmeta{resource} = \my %resource;
		1307
1187	while (my ($k, $v) = each %{ $meta{ext} }) {	1308	while (my ($k, $v) = each %{ $allmeta{ext} }) {
1188	#TODO: should check for extensions overriding each other	1309	#TODO: should check for extensions overriding each other
1189	%{ $meta{resource} } = (%{ $meta{resource} }, %{ $v->{resource} });	1310	%resource = (%resource, %{ $v->{resource} });
1190	%{ $meta{binding} } = (%{ $meta{binding} }, %{ $v->{binding} });
1191	}	1311	}
1192	}	1312	}
1193		1313
1194	=item $term = new urxvt::term $envhashref, $rxvtname, [arg...]	1314	=item $term = new urxvt::term $envhashref, $rxvtname, [arg...]
1195		1315
…		…
1258	insecure intensityStyles iso14755 iso14755_52 jumpScroll loginShell	1378	insecure intensityStyles iso14755 iso14755_52 jumpScroll loginShell
1259	mapAlert meta8 mouseWheelScrollPage override_redirect pastableTabs	1379	mapAlert meta8 mouseWheelScrollPage override_redirect pastableTabs
1260	pointerBlank reverseVideo scrollBar scrollBar_floating scrollBar_right	1380	pointerBlank reverseVideo scrollBar scrollBar_floating scrollBar_right
1261	scrollTtyKeypress scrollTtyOutput scrollWithBuffer secondaryScreen	1381	scrollTtyKeypress scrollTtyOutput scrollWithBuffer secondaryScreen
1262	secondaryScroll skipBuiltinGlyphs skipScroll transparent tripleclickwords	1382	secondaryScroll skipBuiltinGlyphs skipScroll transparent tripleclickwords
1263	urgentOnBell utmpInhibit visualBell	1383	urgentOnBell utmpInhibit visualBell disablePasteBrackets
1264		1384
1265	=item $value = $term->resource ($name[, $newval])	1385	=item $value = $term->resource ($name[, $newval])
1266		1386
1267	Returns the current resource value associated with a given name and	1387	Returns the current resource value associated with a given name and
1268	optionally sets a new value. Setting values is most useful in the C<init>	1388	optionally sets a new value. Setting values is most useful in the C<init>
…		…
1294	preeditType print_pipe pty_fd reverseVideo saveLines scrollBar	1414	preeditType print_pipe pty_fd reverseVideo saveLines scrollBar
1295	scrollBar_align scrollBar_floating scrollBar_right scrollBar_thickness	1415	scrollBar_align scrollBar_floating scrollBar_right scrollBar_thickness
1296	scrollTtyKeypress scrollTtyOutput scrollWithBuffer scrollstyle	1416	scrollTtyKeypress scrollTtyOutput scrollWithBuffer scrollstyle
1297	secondaryScreen secondaryScroll shade skipBuiltinGlyphs skipScroll	1417	secondaryScreen secondaryScroll shade skipBuiltinGlyphs skipScroll
1298	term_name title transient_for transparent tripleclickwords urgentOnBell	1418	term_name title transient_for transparent tripleclickwords urgentOnBell
1299	utmpInhibit visualBell	1419	utmpInhibit visualBell rewrapMode disablePasteBrackets
1300		1420
1301	=cut	1421	=cut
1302		1422
1303	sub resource($$;$) {	1423	sub resource($$;$) {
1304	my ($self, $name) = (shift, shift);	1424	my ($self, $name) = (shift, shift);
…		…
1341	my $res = &x_resource;	1461	my $res = &x_resource;
1342		1462
1343	$res =~ /^\s(?:true\|yes\|on\|1)\s$/i ? 1 : defined $res && 0	1463	$res =~ /^\s(?:true\|yes\|on\|1)\s$/i ? 1 : defined $res && 0
1344	}	1464	}
1345		1465
		1466	=item $action = $term->lookup_keysym ($keysym, $state)
		1467
		1468	Returns the action bound to key combination C<($keysym, $state)>,
		1469	if a binding for it exists, and C<undef> otherwise.
		1470
1346	=item $success = $term->bind_action ($key, $octets)	1471	=item $success = $term->bind_action ($key, $action)
1347		1472
1348	Adds a key binding exactly as specified via a C<keysym> resource. See the	1473	Adds a key binding exactly as specified via a C<keysym> resource. See the
1349	C<keysym> resource in the urxvt(1) manpage.	1474	C<keysym> resource in the urxvt(1) manpage.
		1475
		1476	To add default bindings for actions, an extension should call C<<
		1477	->bind_action >> in its C<init> hook for every such binding. Doing it
		1478	in the C<init> hook allows users to override or remove the binding
		1479	again.
		1480
		1481	Example: the C<searchable-scrollback> by default binds itself
		1482	on C<Meta-s>, using C<< $self->bind_action >>, which calls C<<
		1483	$term->bind_action >>.
		1484
		1485	sub init {
		1486	my ($self) = @_;
		1487
		1488	$self->bind_action ("M-s" => "%:start");
		1489	}
1350		1490
1351	=item $rend = $term->rstyle ([$new_rstyle])	1491	=item $rend = $term->rstyle ([$new_rstyle])
1352		1492
1353	Return and optionally change the current rendition. Text that is output by	1493	Return and optionally change the current rendition. Text that is output by
1354	the terminal application will use this style.	1494	the terminal application will use this style.
…		…
1431	This method returns an urxvt::overlay object. The overlay will be visible	1571	This method returns an urxvt::overlay object. The overlay will be visible
1432	as long as the perl object is referenced.	1572	as long as the perl object is referenced.
1433		1573
1434	The methods currently supported on C<urxvt::overlay> objects are:	1574	The methods currently supported on C<urxvt::overlay> objects are:
1435		1575
1436	=over 4	1576	=over
1437		1577
1438	=item $overlay->set ($x, $y, $text[, $rend])	1578	=item $overlay->set ($x, $y, $text[, $rend])
1439		1579
1440	Similar to C<< $term->ROW_t >> and C<< $term->ROW_r >> in that it puts	1580	Similar to C<< $term->ROW_t >> and C<< $term->ROW_r >> in that it puts
1441	text in rxvt-unicode's special encoding and an array of rendition values	1581	text in rxvt-unicode's special encoding and an array of rendition values
…		…
1592		1732
1593	=item $term->key_release ($state, $keycode[, $time])	1733	=item $term->key_release ($state, $keycode[, $time])
1594		1734
1595	Deliver various fake events to to terminal.	1735	Deliver various fake events to to terminal.
1596		1736
1597	=item $window_width = $term->width	1737	=item $window_width = $term->width ([$new_value])
1598		1738
1599	=item $window_height = $term->height	1739	=item $window_height = $term->height ([$new_value])
1600		1740
1601	=item $font_width = $term->fwidth	1741	=item $font_width = $term->fwidth ([$new_value])
1602		1742
1603	=item $font_height = $term->fheight	1743	=item $font_height = $term->fheight ([$new_value])
1604		1744
1605	=item $font_ascent = $term->fbase	1745	=item $font_ascent = $term->fbase ([$new_value])
1606		1746
1607	=item $terminal_rows = $term->nrow	1747	=item $terminal_rows = $term->nrow ([$new_value])
1608		1748
1609	=item $terminal_columns = $term->ncol	1749	=item $terminal_columns = $term->ncol ([$new_value])
1610		1750
1611	=item $has_focus = $term->focus	1751	=item $has_focus = $term->focus ([$new_value])
1612		1752
1613	=item $is_mapped = $term->mapped	1753	=item $is_mapped = $term->mapped ([$new_value])
1614		1754
1615	=item $max_scrollback = $term->saveLines	1755	=item $max_scrollback = $term->saveLines ([$new_value])
1616		1756
1617	=item $nrow_plus_saveLines = $term->total_rows	1757	=item $nrow_plus_saveLines = $term->total_rows ([$new_value])
1618		1758
1619	=item $topmost_scrollback_row = $term->top_row	1759	=item $topmost_scrollback_row = $term->top_row ([$new_value])
1620		1760
1621	Return various integers describing terminal characteristics.	1761	Return various integers describing terminal characteristics. If an
		1762	argument is given, changes the value and returns the previous one.
1622		1763
1623	=item $x_display = $term->display_id	1764	=item $x_display = $term->display_id
1624		1765
1625	Return the DISPLAY used by rxvt-unicode.	1766	Return the DISPLAY used by rxvt-unicode.
1626		1767
…		…
1663		1804
1664	=item $cursor_is_hidden = $term->hidden_cursor	1805	=item $cursor_is_hidden = $term->hidden_cursor
1665		1806
1666	Returns whether the cursor is currently hidden or not.	1807	Returns whether the cursor is currently hidden or not.
1667		1808
		1809	=item $priv_modes = $term->priv_modes
		1810
		1811	Returns a bitset with the state of DEC private modes.
		1812
		1813	Example:
		1814
		1815	if ($term->priv_modes & urxvt::PrivMode_mouse_report) {
		1816	# mouse reporting is turned on
		1817	}
		1818
1668	=item $view_start = $term->view_start ([$newvalue])	1819	=item $view_start = $term->view_start ([$newvalue])
1669		1820
1670	Returns the row number of the topmost displayed line. Maximum value is	1821	Returns the row number of the topmost displayed line and changes it,
1671	C<0>, which displays the normal terminal contents. Lower values scroll	1822	if an argument is given. Values greater than or equal to C<0> display
1672	this many lines into the scrollback buffer.	1823	the terminal contents. Lower values scroll this many lines into the
		1824	scrollback buffer.
1673		1825
1674	=item $term->want_refresh	1826	=item $term->want_refresh
1675		1827
1676	Requests a screen refresh. At the next opportunity, rxvt-unicode will	1828	Requests a screen refresh. At the next opportunity, rxvt-unicode will
1677	compare the on-screen display with its stored representation. If they	1829	compare the on-screen display with its stored representation. If they
1678	differ, it redraws the differences.	1830	differ, it redraws the differences.
1679		1831
1680	Used after changing terminal contents to display them.	1832	Used after changing terminal contents to display them.
		1833
		1834	=item $term->refresh_check
		1835
		1836	Checks if a refresh has been requested and, if so, schedules one.
1681		1837
1682	=item $text = $term->ROW_t ($row_number[, $new_text[, $start_col]])	1838	=item $text = $term->ROW_t ($row_number[, $new_text[, $start_col]])
1683		1839
1684	Returns the text of the entire row with number C<$row_number>. Row C<< $term->top_row >>	1840	Returns the text of the entire row with number C<$row_number>. Row C<< $term->top_row >>
1685	is the topmost terminal line, row C<< $term->nrow-1 >> is the bottommost	1841	is the topmost terminal line, row C<< $term->nrow-1 >> is the bottommost
…		…
1731		1887
1732	Create and return a new C<urxvt::line> object that stores information	1888	Create and return a new C<urxvt::line> object that stores information
1733	about the logical line that row C<$row_number> is part of. It supports the	1889	about the logical line that row C<$row_number> is part of. It supports the
1734	following methods:	1890	following methods:
1735		1891
1736	=over 4	1892	=over
1737		1893
1738	=item $text = $line->t ([$new_text])	1894	=item $text = $line->t ([$new_text])
1739		1895
1740	Returns or replaces the full text of the line, similar to C<ROW_t>	1896	Returns or replaces the full text of the line, similar to C<ROW_t>
1741		1897
…		…
1845	where one character corresponds to one screen cell. See	2001	where one character corresponds to one screen cell. See
1846	C<< $term->ROW_t >> for details.	2002	C<< $term->ROW_t >> for details.
1847		2003
1848	=item $string = $term->special_decode $text	2004	=item $string = $term->special_decode $text
1849		2005
1850	Converts rxvt-unicodes text representation into a perl string. See	2006	Converts rxvt-unicode's text representation into a perl string. See
1851	C<< $term->ROW_t >> for details.	2007	C<< $term->ROW_t >> for details.
1852		2008
1853	=item $success = $term->grab_button ($button, $modifiermask[, $window = $term->vt])	2009	=item $success = $term->grab_button ($button, $modifiermask[, $window = $term->vt])
1854		2010
1855	=item $term->ungrab_button ($button, $modifiermask[, $window = $term->vt])	2011	=item $term->ungrab_button ($button, $modifiermask[, $window = $term->vt])
…		…
1921		2077
1922	package urxvt::popup;	2078	package urxvt::popup;
1923		2079
1924	=head2 The C<urxvt::popup> Class	2080	=head2 The C<urxvt::popup> Class
1925		2081
1926	=over 4	2082	=over
1927		2083
1928	=cut	2084	=cut
1929		2085
1930	sub add_item {	2086	sub add_item {
1931	my ($self, $item) = @_;	2087	my ($self, $item) = @_;
…		…
2067	->cb (sub {	2223	->cb (sub {
2068	$term->{overlay}->set (0, 0,	2224	$term->{overlay}->set (0, 0,
2069	sprintf "%2d:%02d:%02d", (localtime urxvt::NOW)[2,1,0]);	2225	sprintf "%2d:%02d:%02d", (localtime urxvt::NOW)[2,1,0]);
2070	});	2226	});
2071		2227
2072	=over 4	2228	=over
2073		2229
2074	=item $timer = new urxvt::timer	2230	=item $timer = new urxvt::timer
2075		2231
2076	Create a new timer object in started state. It is scheduled to fire	2232	Create a new timer object in started state. It is scheduled to fire
2077	immediately.	2233	immediately.
…		…
2126	sysread $term->{socket}, my $buf, 8192	2282	sysread $term->{socket}, my $buf, 8192
2127	or end-of-file;	2283	or end-of-file;
2128	});	2284	});
2129		2285
2130		2286
2131	=over 4	2287	=over
2132		2288
2133	=item $iow = new urxvt::iow	2289	=item $iow = new urxvt::iow
2134		2290
2135	Create a new io watcher object in stopped state.	2291	Create a new io watcher object in stopped state.
2136		2292
…		…
2163		2319
2164	This class implements idle watchers, that get called automatically when	2320	This class implements idle watchers, that get called automatically when
2165	the process is idle. They should return as fast as possible, after doing	2321	the process is idle. They should return as fast as possible, after doing
2166	some useful work.	2322	some useful work.
2167		2323
2168	=over 4	2324	=over
2169		2325
2170	=item $iw = new urxvt::iw	2326	=item $iw = new urxvt::iw
2171		2327
2172	Create a new idle watcher object in stopped state.	2328	Create a new idle watcher object in stopped state.
2173		2329
…		…
2198	->cb (sub {	2354	->cb (sub {
2199	my ($pw, $exit_status) = @_;	2355	my ($pw, $exit_status) = @_;
2200	...	2356	...
2201	});	2357	});
2202		2358
2203	=over 4	2359	=over
2204		2360
2205	=item $pw = new urxvt::pw	2361	=item $pw = new urxvt::pw
2206		2362
2207	Create a new process watcher in stopped state.	2363	Create a new process watcher in stopped state.
2208		2364
…		…
2225	=head2 URXVT_PERL_VERBOSITY	2381	=head2 URXVT_PERL_VERBOSITY
2226		2382
2227	This variable controls the verbosity level of the perl extension. Higher	2383	This variable controls the verbosity level of the perl extension. Higher
2228	numbers indicate more verbose output.	2384	numbers indicate more verbose output.
2229		2385
2230	=over 4	2386	=over
2231		2387
2232	=item == 0 - fatal messages	2388	=item == 0 - fatal messages only
		2389
		2390	=item >= 2 - general warnings (default level)
2233		2391
2234	=item >= 3 - script loading and management	2392	=item >= 3 - script loading and management
2235		2393
2236	=item >=10 - all called hooks	2394	=item >=10 - all called hooks
2237		2395

Diff Legend

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

Comparing rxvt-unicode/src/urxvt.pm (file contents): Revision 1.245 by root, Mon Dec 22 09:10:12 2014 UTC vs. Revision 1.268 by root, Sat Jul 24 13:07:56 2021 UTC

Diff Legend

Comparing rxvt-unicode/src/urxvt.pm (file contents):
Revision 1.245 by root, Mon Dec 22 09:10:12 2014 UTC vs.
Revision 1.268 by root, Sat Jul 24 13:07:56 2021 UTC