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

Comparing rxvt-unicode/src/urxvt.pm (file contents):
Revision 1.243 by sf-exg, Sat Oct 11 22:02:50 2014 UTC vs.
Revision 1.266 by root, Sat Jul 24 11:58:27 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"
…		…
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 may add resources on their own. Similarly to builtin	48	Extensions may add additional resources and C<actions>, i.e., methods
49	resources, these resources can also be specified on the command line	49	which can be bound to a key and invoked by the user. An extension can
50	as long options (with '.' replaced by '-'), in which case the	50	define the resources it support using so called META comments,
51	corresponding extension is loaded automatically.	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.
52		56
53	=head1 API DOCUMENTATION	57	=head1 API DOCUMENTATION
54		58
55	=head2 General API Considerations	59	=head2 General API Considerations
56		60
…		…
66	terminal is destroyed.	70	terminal is destroyed.
67		71
68	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
69	hints on what they mean:	73	hints on what they mean:
70		74
71	=over 4	75	=over
72		76
73	=item $text	77	=item $text
74		78
75	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
76	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.
…		…
108	C<urxvt::term> class on this object.	112	C<urxvt::term> class on this object.
109		113
110	Additional methods only supported for extension objects are described in	114	Additional methods only supported for extension objects are described in
111	the C<urxvt::extension> section below.	115	the C<urxvt::extension> section below.
112		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 these comments below. Individual components are
		125	separated by cololns (C<:>), and shoudl not contain colons themselves -
		126	there is also currently no escaping mechanism provided for this.
		127
		128	=over
		129
		130	=item #:META:RESOURCE:name:type:desc
		131
		132	The RESOURCE comment defines a resource used by the extension, where
		133	C<name> is the resource name, C<type> is the resource type, C<boolean>
		134	or C<string>, and C<desc> is the resource description.
		135
		136	The extension will be autoloaded when this resource is specified or used
		137	as a command line parameter.
		138
		139	Example: matcher provides the C<matcher.launcher> ressource by having this
		140	comment:
		141
		142	#:META:RESOURCE:%.launcher:string:default launcher command
		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 cnanot 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
		183
		184	=back
		185
113	=head2 Hooks	186	=head2 Hooks
114		187
115	The following subroutines can be declared in extension files, and will be	188	The following subroutines can be declared in extension files, and will be
116	called whenever the relevant event happens.	189	called whenever the relevant event happens.
117		190
…		…
122	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
123	relevant action might not be carried out by the C++ code.	196	relevant action might not be carried out by the C++ code.
124		197
125	I<< When in doubt, return a false value (preferably C<()>). >>	198	I<< When in doubt, return a false value (preferably C<()>). >>
126		199
127	=over 4	200	=over
128		201
129	=item on_init $term	202	=item on_init $term
130		203
131	Called after a new terminal object has been initialized, but before	204	Called after a new terminal object has been initialized, but before
132	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
…		…
214		287
215	C<on_osc_seq_perl> should be used for new behaviour.	288	C<on_osc_seq_perl> should be used for new behaviour.
216		289
217	=item on_osc_seq_perl $term, $args, $resp	290	=item on_osc_seq_perl $term, $args, $resp
218		291
219	Called whenever the B<ESC ] 777 ; string ST> command sequence (OSC =	292	Called whenever the B<ESC ] 777 ; prefix ; string ST> command sequence
220	operating system command) is processed. Cursor position and other state	293	(OSC = operating system command) is processed. Cursor position and other
221	information is up-to-date when this happens. For interoperability, the	294	state information is up-to-date when this happens. For interoperability,
222	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
223	to distinguish it from commands for other extensions, and this might be	296	other suitable prefix, and a semicolon, to distinguish it from commands
224	enforced in the future.	297	for other extensions.
225		298
226	For example, C<overlay-osc> uses this:	299	For example, C<overlay-osc> uses this:
227		300
228	sub on_osc_seq_perl {	301	sub on_osc_seq_perl {
229	my ($self, $osc, $resp) = @_;	302	my ($self, $osc, $resp) = @_;
…		…
283		356
284	=item on_refresh_end $term	357	=item on_refresh_end $term
285		358
286	Called just after the screen gets redrawn. See C<on_refresh_begin>.	359	Called just after the screen gets redrawn. See C<on_refresh_begin>.
287		360
		361	=item on_action $term, $string
		362
		363	Called whenever an action is invoked for the corresponding extension
		364	(e.g. via a C<extension:string> builtin action bound to a key, see
		365	description of the B<keysym> resource in the urxvt(1) manpage). The
		366	event is simply the action string. Note that an action event is always
		367	associated to a single extension.
		368
288	=item on_user_command $term, $string DEPRECATED	369	=item on_user_command $term, $string DEPRECATED
289		370
290	Called whenever a user-configured event is being activated (e.g. via	371	Called whenever a user-configured event is being activated (e.g. via
291	a C<perl:string> action bound to a key, see description of the B<keysym>	372	a C<perl:string> action bound to a key, see description of the B<keysym>
292	resource in the urxvt(1) manpage).	373	resource in the urxvt(1) manpage).
…		…
366	=cut	447	=cut
367		448
368	package urxvt;	449	package urxvt;
369		450
370	use utf8;	451	use utf8;
371	use strict 'vars';	452	use strict qw(vars subs);
372	use Carp ();	453	use Carp ();
373	use Scalar::Util ();	454	use Scalar::Util ();
374	use List::Util ();	455	use List::Util ();
375		456
376	our $VERSION = 1;	457	our $VERSION = 1;
…		…
388		469
389	our $NOCHAR = chr 0xffff;	470	our $NOCHAR = chr 0xffff;
390		471
391	=head2 Variables in the C<urxvt> Package	472	=head2 Variables in the C<urxvt> Package
392		473
393	=over 4	474	=over
394		475
395	=item $urxvt::LIBDIR	476	=item $urxvt::LIBDIR
396		477
397	The rxvt-unicode library directory, where, among other things, the perl	478	The rxvt-unicode library directory, where, among other things, the perl
398	modules and scripts are stored.	479	modules and scripts are stored.
…		…
428		509
429	=back	510	=back
430		511
431	=head2 Functions in the C<urxvt> Package	512	=head2 Functions in the C<urxvt> Package
432		513
433	=over 4	514	=over
434		515
435	=item urxvt::fatal $errormessage	516	=item urxvt::fatal $errormessage
436		517
437	Fatally aborts execution with the given error message (which should	518	Fatally aborts execution with the given error message (which should
438	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
…		…
483	CirculateRequest, PropertyNotify, SelectionClear, SelectionRequest,	564	CirculateRequest, PropertyNotify, SelectionClear, SelectionRequest,
484	SelectionNotify, ColormapNotify, ClientMessage, MappingNotify	565	SelectionNotify, ColormapNotify, ClientMessage, MappingNotify
485		566
486	Various constants for use in X calls and event processing.	567	Various constants for use in X calls and event processing.
487		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
488	=back	581	=back
489		582
490	=head2 RENDITION	583	=head2 RENDITION
491		584
492	Rendition bitsets contain information about colour, font, font styles and	585	Rendition bitsets contain information about colour, font, font styles and
…		…
495	The following "macros" deal with changes in rendition sets. You should	588	The following "macros" deal with changes in rendition sets. You should
496	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,
497	as they contain important information required for correct operation of	590	as they contain important information required for correct operation of
498	rxvt-unicode.	591	rxvt-unicode.
499		592
500	=over 4	593	=over
501		594
502	=item $rend = urxvt::DEFAULT_RSTYLE	595	=item $rend = urxvt::DEFAULT_RSTYLE
503		596
504	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
505	being reset. Useful as a base to start when creating renditions.	598	being reset. Useful as a base to start when creating renditions.
…		…
559	sub parse_resource {	652	sub parse_resource {
560	my ($term, $name, $isarg, $longopt, $flag, $value) = @_;	653	my ($term, $name, $isarg, $longopt, $flag, $value) = @_;
561		654
562	$term->scan_extensions;	655	$term->scan_extensions;
563		656
		657	# iterating over all resources has quadratic time overhead
		658	# overall, maybe this could be optimised?
564	my $r = $term->{meta}{resource};	659	my $r = $term->{meta}{resource};
565	keys %$r; # reset iterator	660	keys %$r; # reset iterator
566	while (my ($k, $v) = each %$r) {	661	while (my ($k, $v) = each %$r) {
567	my $pattern = $k;	662	my $pattern = $k;
568	$pattern =~ y/./-/ if $isarg;	663	$pattern =~ y/./-/ if $isarg;
…		…
575	if ($pattern eq $prefix) {	670	if ($pattern eq $prefix) {
576	$name = "$urxvt::RESCLASS.$k$suffix";	671	$name = "$urxvt::RESCLASS.$k$suffix";
577		672
578	push @{ $term->{perl_ext_3} }, $v->[0];	673	push @{ $term->{perl_ext_3} }, $v->[0];
579		674
		675	return 1 unless $isarg;
		676
580	if ($v->[1] eq "boolean") {	677	if ($v->[1] eq "boolean") {
581	$term->put_option_db ($name, $flag ? "true" : "false");	678	$term->put_option_db ($name, $flag ? "true" : "false");
582	return 1;	679	return 1;
583	} else {	680	} else {
584	$term->put_option_db ($name, $value);	681	$term->put_option_db ($name, $value);
…		…
616	urxvt::log sprintf " %-31s %s\n", "$pattern:", $type;	713	urxvt::log sprintf " %-31s %s\n", "$pattern:", $type;
617	}	714	}
618	}	715	}
619	}	716	}
620		717
621	my $verbosity = $ENV{URXVT_PERL_VERBOSITY};	718	my $verbosity = $ENV{URXVT_PERL_VERBOSITY} // 2;
622		719
623	sub verbose {	720	sub verbose {
624	my ($level, $msg) = @_;	721	my ($level, $msg) = @_;
625	warn "$msg\n" if $level <= $verbosity;	722	warn "$msg\n" if $level <= $verbosity;
626	}	723	}
…		…
643		740
644	open my $fh, "<:raw", $path	741	open my $fh, "<:raw", $path
645	or die "$path: $!";	742	or die "$path: $!";
646		743
647	my $source =	744	my $source =
648	"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"
649	. "#line 1 \"$path\"\n{\n"	746	. "#line 1 \"$path\"\n{\n"
650	. (do { local $/; <$fh> })	747	. (do { local $/; <$fh> })
651	. "\n};\n1";	748	. "\n};\n1";
652		749
653	eval $source	750	eval $source
…		…
663	sub invoke {	760	sub invoke {
664	local $TERM = shift;	761	local $TERM = shift;
665	my $htype = shift;	762	my $htype = shift;
666		763
667	if ($htype == HOOK_INIT) {	764	if ($htype == HOOK_INIT) {
668	my @dirs = $TERM->perl_libdirs;
669
670	$TERM->scan_extensions;	765	$TERM->scan_extensions;
671		766
672	my %ext_arg;	767	my %ext_arg;
673		768
674	{	769	{
…		…
679	@TERM_EXT = ();	774	@TERM_EXT = ();
680	$TERM->register_package ($_) for @pkg;	775	$TERM->register_package ($_) for @pkg;
681	}	776	}
682		777
683	for (	778	for (
		779	@{ delete $TERM->{perl_ext_3} },
684	(grep $_, map { split /,/, $TERM->resource ("perl_ext_$_") } 1, 2),	780	(grep $_, map { split /,/, $TERM->resource ("perl_ext_$_") } 1, 2),
685	@{ delete $TERM->{perl_ext_3} }
686	) {	781	) {
687	if ($_ eq "default") {	782	if ($_ eq "default") {
688		783
689	$ext_arg{$_} = []	784	$ext_arg{$_} = []
690	for
691	qw(selection option-popup selection-popup readline),	785	for qw(selection option-popup selection-popup readline searchable-scrollback confirm-paste);
692	map $_->[0], values %{ $TERM->{meta}{binding} };
693		786
694	for ($TERM->_keysym_resources) {	787	for ($TERM->_keysym_resources) {
695	next if /^(?:string\|command\|builtin\|builtin-string\|perl)/;	788	next if /^(?:string\|command\|builtin\|builtin-string\|perl)/;
696	next unless /^([A-Za-z0-9_\-]+):/;	789	next unless /^([A-Za-z0-9_\-]+):/;
697		790
698	my $ext = $1;	791	my $ext = $1;
699		792
700	$ext_arg{$ext} = [];	793	$ext_arg{$ext} = [];
701	}	794	}
702		795
703	} elsif (/^-(.*)$/) {	796	} elsif (/^-(.*)$/) { # remove from set
704	delete $ext_arg{$1};	797	delete $ext_arg{$1};
705		798
706	} 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};
707	push @{ $ext_arg{$1} }, $2;	804	push @{ $ext_arg{$1} }, defined $2 ? $2 : ();
708		805
709	} else {	806	} else {
710	$ext_arg{$_} \|\|= [];	807	verbose 2, "cannot parse extension specification '$_', ignoring.";
711	}	808	}
712	}	809	}
713		810
714	# 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
715	for my $ext (sort keys %ext_arg) {	814	for my $ext (sort keys %ext_arg) {
716	while (my ($k, $v) = each %{ $TERM->{meta}{ext}{$ext}{binding} }) {	815	my $path = $TERM->extension_path ($ext);
717	$TERM->bind_action ($k, "$v->[0]:$v->[1]");
718	}
719	}
720		816
721	for my $ext (sort keys %ext_arg) {	817	if (defined $path) {
722	my @files = grep -f $_, map "$_/$ext", @dirs;	818	$TERM->autoload_extension ($ext, $ext_arg{$ext});
723
724	if (@files) {
725	$TERM->register_package (extension_package $files[0], $ext_arg{$ext});
726	} else {	819	} else {
727	warn "perl extension '$ext' not found in perl library search path\n";	820	verbose 2, "perl extension '$ext' not found in perl library search path";
728	}	821	}
729	}	822	}
730		823
731	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");
732	warn $@ if $@;	825	warn $@ if $@;
733	}	826	}
734		827
735	$retval = undef;	828	$retval = undef;
		829
		830	if ($htype == HOOK_OSC_SEQ) {
		831	if (my $exts = delete $TERM->{meta}{autoload_osc}{$_[0]}) {
		832	$TERM->autoload_extension ($_->[0]) for @$exts;
		833	}
		834	} elsif ($htype == HOOK_OSC_SEQ_PERL) {
		835	if ($_[0] =~ /^([^;]+)/ and (my $exts = delete $TERM->{meta}{autoload_osc_perl}{$1})) {
		836	$TERM->autoload_extension ($_->[0]) for @$exts;
		837	}
		838	}
736		839
737	if (my $cb = $TERM->{_hook}[$htype]) {	840	if (my $cb = $TERM->{_hook}[$htype]) {
738	verbose 10, "$HOOKNAME[$htype] (" . (join ", ", $TERM, @_) . ")"	841	verbose 10, "$HOOKNAME[$htype] (" . (join ", ", $TERM, @_) . ")"
739	if $verbosity >= 10;	842	if $verbosity >= 10;
740		843
…		…
817		920
818	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
819	objects, in addition to call methods documented for the <urxvt::term>	922	objects, in addition to call methods documented for the <urxvt::term>
820	class.	923	class.
821		924
822	=over 4	925	=over
823		926
824	=item $urxvt_term = $self->{term}	927	=item $urxvt_term = $self->{term}
825		928
826	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
827	extension. This member I<must not> be changed in any way.	930	extension. This member I<must not> be changed in any way.
…		…
945	}	1048	}
946		1049
947	bless \%disable, "urxvt::extension::on_disable"	1050	bless \%disable, "urxvt::extension::on_disable"
948	}	1051	}
949		1052
		1053	=item $self->bind_action ($hotkey, $action)
		1054
950	=item $self->x_resource ($pattern)	1055	=item $self->x_resource ($pattern)
951		1056
952	=item $self->x_resource_boolean ($pattern)	1057	=item $self->x_resource_boolean ($pattern)
953		1058
954	These methods support an additional C<%> prefix when called on an	1059	These methods support an additional C<%> prefix for C<$action> or
955	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
956	C<urxvt::term> class for details.	1062	methods in the C<urxvt::term> class for details.
957		1063
958	=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	}
959		1071
960	sub x_resource {	1072	sub x_resource {
961	my ($self, $name) = @_;	1073	my ($self, $name) = @_;
962	$name =~ s/^%(\.\|$)/$_[0]{_name}$1/;	1074	$name =~ s/^%(\.\|$)/$_[0]{_name}$1/;
963	$self->{term}->x_resource ($name)	1075	$self->{term}->x_resource ($name)
…		…
1059		1171
1060	package urxvt::term;	1172	package urxvt::term;
1061		1173
1062	=head2 The C<urxvt::term> Class	1174	=head2 The C<urxvt::term> Class
1063		1175
1064	=over 4	1176	=over
1065		1177
1066	=cut	1178	=cut
1067		1179
1068	# find on_xxx subs in the package and register them	1180	# find on_xxx subs in the package and register them
1069	# as hooks	1181	# as hooks
…		…
1090	$proxy->enable ($name => $ref);	1202	$proxy->enable ($name => $ref);
1091	}	1203	}
1092	}	1204	}
1093	}	1205	}
1094		1206
		1207	# map extension name to filesyystem 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
1095	sub perl_libdirs {	1231	sub perl_libdirs {
1096	map { split /:/ }	1232	map { split /:/ }
1097	$_[0]->resource ("perl_lib"),	1233	$_[0]->resource ("perl_lib"),
1098	$ENV{URXVT_PERL_LIB},	1234	$ENV{URXVT_PERL_LIB},
1099	"$ENV{HOME}/.urxvt/ext",	1235	"$ENV{HOME}/.urxvt/ext",
…		…
1104	sub scan_extensions {	1240	sub scan_extensions {
1105	my ($self) = @_;	1241	my ($self) = @_;
1106		1242
1107	return if exists $self->{meta};	1243	return if exists $self->{meta};
1108		1244
1109	my @libdirs = perl_libdirs $self;	1245	my @urxvtdirs = perl_libdirs $self;
		1246	# my @cpandirs = grep -d, map "$_/URxvt/Ext", @INC;
1110		1247
1111	# return if $self->{meta_libdirs} eq join "\x00", @libdirs;#d#
1112
1113	# $self->{meta_libdirs} = join "\x00", @libdirs;#d#
1114	$self->{meta} = \my %meta;	1248	$self->{meta} = \my %allmeta;
1115		1249
1116	# first gather extensions	1250	# first gather extensions
1117	for my $dir (reverse @libdirs) {	1251
		1252	my $gather = sub {
		1253	my ($dir, $core) = @_;
		1254
1118	opendir my $fh, $dir	1255	opendir my $fh, $dir
1119	or next;	1256	or return;
		1257
1120	for my $ext (readdir $fh) {	1258	for my $ext (readdir $fh) {
1121	$ext !~ /^\./	1259	$ext !~ /^\./
1122	and open my $fh, "<", "$dir/$ext"
1123	or next;	1260	or next;
1124		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
1125	my %ext = (dir => $dir);	1271	my %meta = (dir => $dir);
1126		1272
1127	while (<$fh>) {	1273	while (<$fh>) {
1128	if (/^#:META:(?:X_)?RESOURCE:(.*)/) {	1274	if (/^#:META:(?:X_)?RESOURCE:(.*)/) {
1129	my ($pattern, $type, $desc) = split /:/, $1;	1275	my ($pattern, $type, $desc) = split /:/, $1;
1130	$pattern =~ s/^%(\.\|$)/$ext$1/g; # % in pattern == extension name	1276	$pattern =~ s/^%(\.\|$)/$ext$1/g; # % in pattern == extension name
1131	if ($pattern =~ /[^a-zA-Z0-9\-\.]/) {	1277	if ($pattern =~ /[^a-zA-Z0-9\-\.]/) {
1132	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";
1133	} else {	1279	} else {
1134	$ext{resource}{$pattern} = [$ext, $type, $desc];	1280	$meta{resource}{$pattern} = [$ext, $type, $desc];
1135	}	1281	}
		1282
1136	} elsif (/^#:META:BINDING:(.*)/) {	1283	} elsif (/^#:META:OSC:([0-9]+):(.*)/) {
1137	my ($keysym, $action) = split /:/, $1;	1284	push @{$allmeta{autoload_osc}{$1}}, [$ext, $2];
1138	$ext{binding}{$keysym} = [$ext, $action];	1285
		1286	} elsif (/^#:META:OSC_PERL:([^:]+):(.*)/) {
		1287	push @{$allmeta{autoload_osc_perl}{$1}}, [$ext, $2];
		1288
1139	} elsif (/^\s*(?:#\|$)/) {	1289	} elsif (/^\s*(?:#\|$)/) {
1140	# skip other comments and empty lines	1290	# skip other comments and empty lines
		1291
1141	} else {	1292	} else {
1142	last; # stop parsing on first non-empty non-comment line	1293	last; # stop parsing on first non-empty non-comment line
1143	}	1294	}
1144	}	1295	}
1145		1296
1146	$meta{ext}{$ext} = \%ext;	1297	$allmeta{ext}{$ext} = \%meta;
1147	}	1298	}
1148	}	1299	};
1149		1300
		1301	# $gather->($_, 0) for @cpandirs;
		1302	$gather->($_, 1) for @urxvtdirs;
		1303
1150	# and now merge resources and bindings	1304	# and now merge resources
		1305
		1306	$allmeta{resource} = \my %resource;
		1307
1151	while (my ($k, $v) = each %{ $meta{ext} }) {	1308	while (my ($k, $v) = each %{ $allmeta{ext} }) {
1152	#TODO: should check for extensions overriding each other	1309	#TODO: should check for extensions overriding each other
1153	%{ $meta{resource} } = (%{ $meta{resource} }, %{ $v->{resource} });	1310	%resource = (%resource, %{ $v->{resource} });
1154	%{ $meta{binding} } = (%{ $meta{binding} }, %{ $v->{binding} });
1155	}	1311	}
1156	}	1312	}
1157		1313
1158	=item $term = new urxvt::term $envhashref, $rxvtname, [arg...]	1314	=item $term = new urxvt::term $envhashref, $rxvtname, [arg...]
1159		1315
…		…
1222	insecure intensityStyles iso14755 iso14755_52 jumpScroll loginShell	1378	insecure intensityStyles iso14755 iso14755_52 jumpScroll loginShell
1223	mapAlert meta8 mouseWheelScrollPage override_redirect pastableTabs	1379	mapAlert meta8 mouseWheelScrollPage override_redirect pastableTabs
1224	pointerBlank reverseVideo scrollBar scrollBar_floating scrollBar_right	1380	pointerBlank reverseVideo scrollBar scrollBar_floating scrollBar_right
1225	scrollTtyKeypress scrollTtyOutput scrollWithBuffer secondaryScreen	1381	scrollTtyKeypress scrollTtyOutput scrollWithBuffer secondaryScreen
1226	secondaryScroll skipBuiltinGlyphs skipScroll transparent tripleclickwords	1382	secondaryScroll skipBuiltinGlyphs skipScroll transparent tripleclickwords
1227	urgentOnBell utmpInhibit visualBell	1383	urgentOnBell utmpInhibit visualBell disablePasteBrackets
1228		1384
1229	=item $value = $term->resource ($name[, $newval])	1385	=item $value = $term->resource ($name[, $newval])
1230		1386
1231	Returns the current resource value associated with a given name and	1387	Returns the current resource value associated with a given name and
1232	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>
…		…
1258	preeditType print_pipe pty_fd reverseVideo saveLines scrollBar	1414	preeditType print_pipe pty_fd reverseVideo saveLines scrollBar
1259	scrollBar_align scrollBar_floating scrollBar_right scrollBar_thickness	1415	scrollBar_align scrollBar_floating scrollBar_right scrollBar_thickness
1260	scrollTtyKeypress scrollTtyOutput scrollWithBuffer scrollstyle	1416	scrollTtyKeypress scrollTtyOutput scrollWithBuffer scrollstyle
1261	secondaryScreen secondaryScroll shade skipBuiltinGlyphs skipScroll	1417	secondaryScreen secondaryScroll shade skipBuiltinGlyphs skipScroll
1262	term_name title transient_for transparent tripleclickwords urgentOnBell	1418	term_name title transient_for transparent tripleclickwords urgentOnBell
1263	utmpInhibit visualBell	1419	utmpInhibit visualBell rewrapMode disablePasteBrackets
1264		1420
1265	=cut	1421	=cut
1266		1422
1267	sub resource($$;$) {	1423	sub resource($$;$) {
1268	my ($self, $name) = (shift, shift);	1424	my ($self, $name) = (shift, shift);
…		…
1282		1438
1283	If the method is called on an extension object (basically, from an	1439	If the method is called on an extension object (basically, from an
1284	extension), then the special prefix C<%.> will be replaced by the name of	1440	extension), then the special prefix C<%.> will be replaced by the name of
1285	the extension and a dot, and the lone string C<%> will be replaced by the	1441	the extension and a dot, and the lone string C<%> will be replaced by the
1286	extension name itself. This makes it possible to code extensions so you	1442	extension name itself. This makes it possible to code extensions so you
1287	can rename them and get a new set of commandline switches and resources	1443	can rename them and get a new set of resources without having to change
1288	without having to change the actual code.	1444	the actual code.
1289		1445
1290	This method should only be called during the C<on_start> hook, as there is	1446	This method should only be called during the C<on_start> hook, as there is
1291	only one resource database per display, and later invocations might return	1447	only one resource database per display, and later invocations might return
1292	the wrong resources.	1448	the wrong resources.
1293		1449
…		…
1305	my $res = &x_resource;	1461	my $res = &x_resource;
1306		1462
1307	$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
1308	}	1464	}
1309		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
1310	=item $success = $term->bind_action ($key, $octets)	1471	=item $success = $term->bind_action ($key, $action)
1311		1472
1312	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
1313	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	}
1314		1490
1315	=item $rend = $term->rstyle ([$new_rstyle])	1491	=item $rend = $term->rstyle ([$new_rstyle])
1316		1492
1317	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
1318	the terminal application will use this style.	1494	the terminal application will use this style.
…		…
1395	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
1396	as long as the perl object is referenced.	1572	as long as the perl object is referenced.
1397		1573
1398	The methods currently supported on C<urxvt::overlay> objects are:	1574	The methods currently supported on C<urxvt::overlay> objects are:
1399		1575
1400	=over 4	1576	=over
1401		1577
1402	=item $overlay->set ($x, $y, $text[, $rend])	1578	=item $overlay->set ($x, $y, $text[, $rend])
1403		1579
1404	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
1405	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
…		…
1476		1652
1477	=item $term->scr_add_lines ($string)	1653	=item $term->scr_add_lines ($string)
1478		1654
1479	Write the given text string to the screen, as if output by the application	1655	Write the given text string to the screen, as if output by the application
1480	running inside the terminal. It may not contain command sequences (escape	1656	running inside the terminal. It may not contain command sequences (escape
1481	codes), but is free to use line feeds, carriage returns and tabs. The	1657	codes - see C<cmd_parse> for that), but is free to use line feeds,
1482	string is a normal text string, not in locale-dependent encoding.	1658	carriage returns and tabs. The string is a normal text string, not in
		1659	locale-dependent encoding.
1483		1660
1484	Normally its not a good idea to use this function, as programs might be	1661	Normally its not a good idea to use this function, as programs might be
1485	confused by changes in cursor position or scrolling. Its useful inside a	1662	confused by changes in cursor position or scrolling. Its useful inside a
1486	C<on_add_lines> hook, though.	1663	C<on_add_lines> hook, though.
1487		1664
…		…
1495	locale-specific encoding of the terminal and can contain command sequences	1672	locale-specific encoding of the terminal and can contain command sequences
1496	(escape codes) that will be interpreted.	1673	(escape codes) that will be interpreted.
1497		1674
1498	=item $term->tt_write ($octets)	1675	=item $term->tt_write ($octets)
1499		1676
1500	Write the octets given in C<$octets> to the tty (i.e. as program input). To	1677	Write the octets given in C<$octets> to the tty (i.e. as user input
		1678	to the program, see C<cmd_parse> for the opposite direction). To pass
1501	pass characters instead of octets, you should convert your strings first	1679	characters instead of octets, you should convert your strings first to the
1502	to the locale-specific encoding using C<< $term->locale_encode >>.	1680	locale-specific encoding using C<< $term->locale_encode >>.
1503		1681
1504	=item $term->tt_write_user_input ($octets)	1682	=item $term->tt_write_user_input ($octets)
1505		1683
1506	Like C<tt_write>, but should be used when writing strings in response to	1684	Like C<tt_write>, but should be used when writing strings in response to
1507	the user pressing a key, to invoke the additional actions requested by	1685	the user pressing a key, to invoke the additional actions requested by
…		…
1554		1732
1555	=item $term->key_release ($state, $keycode[, $time])	1733	=item $term->key_release ($state, $keycode[, $time])
1556		1734
1557	Deliver various fake events to to terminal.	1735	Deliver various fake events to to terminal.
1558		1736
1559	=item $window_width = $term->width	1737	=item $window_width = $term->width ([$new_value])
1560		1738
1561	=item $window_height = $term->height	1739	=item $window_height = $term->height ([$new_value])
1562		1740
1563	=item $font_width = $term->fwidth	1741	=item $font_width = $term->fwidth ([$new_value])
1564		1742
1565	=item $font_height = $term->fheight	1743	=item $font_height = $term->fheight ([$new_value])
1566		1744
1567	=item $font_ascent = $term->fbase	1745	=item $font_ascent = $term->fbase ([$new_value])
1568		1746
1569	=item $terminal_rows = $term->nrow	1747	=item $terminal_rows = $term->nrow ([$new_value])
1570		1748
1571	=item $terminal_columns = $term->ncol	1749	=item $terminal_columns = $term->ncol ([$new_value])
1572		1750
1573	=item $has_focus = $term->focus	1751	=item $has_focus = $term->focus ([$new_value])
1574		1752
1575	=item $is_mapped = $term->mapped	1753	=item $is_mapped = $term->mapped ([$new_value])
1576		1754
1577	=item $max_scrollback = $term->saveLines	1755	=item $max_scrollback = $term->saveLines ([$new_value])
1578		1756
1579	=item $nrow_plus_saveLines = $term->total_rows	1757	=item $nrow_plus_saveLines = $term->total_rows ([$new_value])
1580		1758
1581	=item $topmost_scrollback_row = $term->top_row	1759	=item $topmost_scrollback_row = $term->top_row ([$new_value])
1582		1760
1583	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.
1584		1763
1585	=item $x_display = $term->display_id	1764	=item $x_display = $term->display_id
1586		1765
1587	Return the DISPLAY used by rxvt-unicode.	1766	Return the DISPLAY used by rxvt-unicode.
1588		1767
…		…
1625		1804
1626	=item $cursor_is_hidden = $term->hidden_cursor	1805	=item $cursor_is_hidden = $term->hidden_cursor
1627		1806
1628	Returns whether the cursor is currently hidden or not.	1807	Returns whether the cursor is currently hidden or not.
1629		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
1630	=item $view_start = $term->view_start ([$newvalue])	1819	=item $view_start = $term->view_start ([$newvalue])
1631		1820
1632	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,
1633	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
1634	this many lines into the scrollback buffer.	1823	the terminal contents. Lower values scroll this many lines into the
		1824	scrollback buffer.
1635		1825
1636	=item $term->want_refresh	1826	=item $term->want_refresh
1637		1827
1638	Requests a screen refresh. At the next opportunity, rxvt-unicode will	1828	Requests a screen refresh. At the next opportunity, rxvt-unicode will
1639	compare the on-screen display with its stored representation. If they	1829	compare the on-screen display with its stored representation. If they
1640	differ, it redraws the differences.	1830	differ, it redraws the differences.
1641		1831
1642	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.
1643		1837
1644	=item $text = $term->ROW_t ($row_number[, $new_text[, $start_col]])	1838	=item $text = $term->ROW_t ($row_number[, $new_text[, $start_col]])
1645		1839
1646	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 >>
1647	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
…		…
1693		1887
1694	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
1695	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
1696	following methods:	1890	following methods:
1697		1891
1698	=over 4	1892	=over
1699		1893
1700	=item $text = $line->t ([$new_text])	1894	=item $text = $line->t ([$new_text])
1701		1895
1702	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>
1703		1897
…		…
1883		2077
1884	package urxvt::popup;	2078	package urxvt::popup;
1885		2079
1886	=head2 The C<urxvt::popup> Class	2080	=head2 The C<urxvt::popup> Class
1887		2081
1888	=over 4	2082	=over
1889		2083
1890	=cut	2084	=cut
1891		2085
1892	sub add_item {	2086	sub add_item {
1893	my ($self, $item) = @_;	2087	my ($self, $item) = @_;
…		…
2029	->cb (sub {	2223	->cb (sub {
2030	$term->{overlay}->set (0, 0,	2224	$term->{overlay}->set (0, 0,
2031	sprintf "%2d:%02d:%02d", (localtime urxvt::NOW)[2,1,0]);	2225	sprintf "%2d:%02d:%02d", (localtime urxvt::NOW)[2,1,0]);
2032	});	2226	});
2033		2227
2034	=over 4	2228	=over
2035		2229
2036	=item $timer = new urxvt::timer	2230	=item $timer = new urxvt::timer
2037		2231
2038	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
2039	immediately.	2233	immediately.
…		…
2088	sysread $term->{socket}, my $buf, 8192	2282	sysread $term->{socket}, my $buf, 8192
2089	or end-of-file;	2283	or end-of-file;
2090	});	2284	});
2091		2285
2092		2286
2093	=over 4	2287	=over
2094		2288
2095	=item $iow = new urxvt::iow	2289	=item $iow = new urxvt::iow
2096		2290
2097	Create a new io watcher object in stopped state.	2291	Create a new io watcher object in stopped state.
2098		2292
…		…
2125		2319
2126	This class implements idle watchers, that get called automatically when	2320	This class implements idle watchers, that get called automatically when
2127	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
2128	some useful work.	2322	some useful work.
2129		2323
2130	=over 4	2324	=over
2131		2325
2132	=item $iw = new urxvt::iw	2326	=item $iw = new urxvt::iw
2133		2327
2134	Create a new idle watcher object in stopped state.	2328	Create a new idle watcher object in stopped state.
2135		2329
…		…
2160	->cb (sub {	2354	->cb (sub {
2161	my ($pw, $exit_status) = @_;	2355	my ($pw, $exit_status) = @_;
2162	...	2356	...
2163	});	2357	});
2164		2358
2165	=over 4	2359	=over
2166		2360
2167	=item $pw = new urxvt::pw	2361	=item $pw = new urxvt::pw
2168		2362
2169	Create a new process watcher in stopped state.	2363	Create a new process watcher in stopped state.
2170		2364
…		…
2187	=head2 URXVT_PERL_VERBOSITY	2381	=head2 URXVT_PERL_VERBOSITY
2188		2382
2189	This variable controls the verbosity level of the perl extension. Higher	2383	This variable controls the verbosity level of the perl extension. Higher
2190	numbers indicate more verbose output.	2384	numbers indicate more verbose output.
2191		2385
2192	=over 4	2386	=over
2193		2387
2194	=item == 0 - fatal messages	2388	=item == 0 - fatal messages only
		2389
		2390	=item >= 2 - general warnings (default level)
2195		2391
2196	=item >= 3 - script loading and management	2392	=item >= 3 - script loading and management
2197		2393
2198	=item >=10 - all called hooks	2394	=item >=10 - all called hooks
2199		2395

Diff Legend

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

Comparing rxvt-unicode/src/urxvt.pm (file contents): Revision 1.243 by sf-exg, Sat Oct 11 22:02:50 2014 UTC vs. Revision 1.266 by root, Sat Jul 24 11:58:27 2021 UTC

Diff Legend

Comparing rxvt-unicode/src/urxvt.pm (file contents):
Revision 1.243 by sf-exg, Sat Oct 11 22:02:50 2014 UTC vs.
Revision 1.266 by root, Sat Jul 24 11:58:27 2021 UTC