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

Comparing rxvt-unicode/src/urxvt.pm (file contents):
Revision 1.220 by root, Tue Jun 19 18:17:56 2012 UTC vs.
Revision 1.268 by root, Sat Jul 24 13:07:56 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 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 @@RXVT_NAME@@ using it:	16	# start a urxvt instance using it:
17		17
18	@@RXVT_NAME@@ --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 @@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
64	terminal is destroyed.	70	terminal is destroyed.
65		71
66	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
67	hints on what they mean:	73	hints on what they mean:
68		74
69	=over 4	75	=over
70		76
71	=item $text	77	=item $text
72		78
73	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
74	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.
…		…
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.
109		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 colons (C<:>), and should not contain colons themselves -
		126	there is also currently no escaping mechanism provided for this.
		127
110	=over 4	128	=over
111		129
112	=item $urxvt_term = $self->{term}	130	=item #:META:RESOURCE:name:type:desc
113		131
114	Returns the C<urxvt::term> object associated with this instance of the	132	The RESOURCE comment defines a resource used by the extension, where
115	extension. This member I<must not> be changed in any way.	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.
116		135
117	=item $self->enable ($hook_name => $cb[, $hook_name => $cb..])	136	The extension will be autoloaded when this resource is specified or used
		137	as a command line parameter.
118		138
119	Dynamically enable the given hooks (named without the C<on_> prefix) for	139	Example: matcher provides the C<matcher.launcher> resource by having this
120	this extension, replacing any previous hook. This is useful when you want	140	comment:
121	to overwrite time-critical hooks only temporarily.
122		141
123	To install additional callbacks for the same hook, you cna use the C<on>	142	#:META:RESOURCE:%.launcher:string:default launcher command
124	method of the C<urxvt::term> class.
125		143
126	=item $self->disable ($hook_name[, $hook_name..])	144	Example: load this extension when the C<-tr> command line option or
		145	resource name is used.
127		146
128	Dynamically disable the given hooks.	147	#:META:RESOURCE:tr:boolean:set root pixmap as background
129		148
130	=item $self->x_resource ($pattern)	149	=item #:META:OSC:number:desc
131		150
132	=item $self->x_resource_boolean ($pattern)	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.
133		154
134	These methods support an additional C<%> prefix when called on an	155	This will cause the extension to be autoloaded when the OSC sequence is
135	extension object - see the description of these methods in the	156	used for the first time.
136	C<urxvt::term> class for details.	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
137		183
138	=back	184	=back
139		185
140	=head2 Hooks	186	=head2 Hooks
141		187
…		…
149	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
150	relevant action might not be carried out by the C++ code.	196	relevant action might not be carried out by the C++ code.
151		197
152	I<< When in doubt, return a false value (preferably C<()>). >>	198	I<< When in doubt, return a false value (preferably C<()>). >>
153		199
154	=over 4	200	=over
155		201
156	=item on_init $term	202	=item on_init $term
157		203
158	Called after a new terminal object has been initialized, but before	204	Called after a new terminal object has been initialized, but before
159	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
…		…
241		287
242	C<on_osc_seq_perl> should be used for new behaviour.	288	C<on_osc_seq_perl> should be used for new behaviour.
243		289
244	=item on_osc_seq_perl $term, $args, $resp	290	=item on_osc_seq_perl $term, $args, $resp
245		291
246	Called whenever the B<ESC ] 777 ; string ST> command sequence (OSC =	292	Called whenever the B<ESC ] 777 ; prefix ; string ST> command sequence
247	operating system command) is processed. Cursor position and other state	293	(OSC = operating system command) is processed. Cursor position and other
248	information is up-to-date when this happens. For interoperability, the	294	state information is up-to-date when this happens. For interoperability,
249	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
250	to distinguish it from commands for other extensions, and this might be	296	other suitable prefix, and a semicolon, to distinguish it from commands
251	enforced in the future.	297	for other extensions.
252		298
253	For example, C<overlay-osc> uses this:	299	For example, C<overlay-osc> uses this:
254		300
255	sub on_osc_seq_perl {	301	sub on_osc_seq_perl {
256	my ($self, $osc, $resp) = @_;	302	my ($self, $osc, $resp) = @_;
…		…
310		356
311	=item on_refresh_end $term	357	=item on_refresh_end $term
312		358
313	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>.
314		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
315	=item on_user_command $term, $string	369	=item on_user_command $term, $string DEPRECATED
316		370
317	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
318	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>
319	resource in the @@RXVT_NAME@@(1) manpage).	373	resource in the urxvt(1) manpage).
320		374
321	The event is simply the action string. This interface is assumed to change	375	The event is simply the action string. This interface is going away in
322	slightly in the future.	376	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		377
331	=item on_resize_all_windows $term, $new_width, $new_height	378	=item on_resize_all_windows $term, $new_width, $new_height
332		379
333	Called just after the new window size has been calculated, but before	380	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	381	windows are actually being resized or hints are being set. If this hook
335	returns TRUE, setting of the window hints is being skipped.	382	returns a true value, setting of the window hints is being skipped.
336		383
337	=item on_x_event $term, $event	384	=item on_x_event $term, $event
338		385
339	Called on every X event received on the vt window (and possibly other	386	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	387	windows). Should only be used as a last resort. Most event structure
…		…
380	(real, not screen-based) row and column under the mouse cursor.	427	(real, not screen-based) row and column under the mouse cursor.
381		428
382	C<on_key_press> additionally receives the string rxvt-unicode would	429	C<on_key_press> additionally receives the string rxvt-unicode would
383	output, if any, in locale-specific encoding.	430	output, if any, in locale-specific encoding.
384		431
385	subwindow.
386
387	=item on_client_message $term, $event	432	=item on_client_message $term, $event
388		433
389	=item on_wm_protocols $term, $event	434	=item on_wm_protocols $term, $event
390		435
391	=item on_wm_delete_window $term, $event	436	=item on_wm_delete_window $term, $event
…		…
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.
…		…
593	no warnings 'utf8';	650	no warnings 'utf8';
594		651
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	$name =~ y/-/./ if $isarg;
599
600	$term->scan_meta;	655	$term->scan_extensions;
601		656
		657	# iterating over all resources has quadratic time overhead
		658	# overall, maybe this could be optimised?
602	my $r = $term->{meta}{resource};	659	my $r = $term->{meta}{resource};
603	keys %$r; # reste iterator	660	keys %$r; # reset iterator
604	while (my ($pattern, $v) = each %$r) {	661	while (my ($k, $v) = each %$r) {
605	if (	662	my $pattern = $k;
		663	$pattern =~ y/./-/ if $isarg;
		664	my $prefix = $name;
		665	my $suffix;
606	$pattern =~ /\.$/	666	if ($pattern =~ /\-$/) {
607	? $pattern eq substr $name, 0, length $pattern	667	$prefix = substr $name, 0, length $pattern;
608	: $pattern eq $name	668	$suffix = substr $name, length $pattern;
609	) {	669	}
		670	if ($pattern eq $prefix) {
610	$name = "$urxvt::RESCLASS.$name";	671	$name = "$urxvt::RESCLASS.$k$suffix";
611		672
612	push @{ $term->{perl_ext_3} }, $v->[0];	673	push @{ $term->{perl_ext_3} }, $v->[0];
		674
		675	return 1 unless $isarg;
613		676
614	if ($v->[1] eq "boolean") {	677	if ($v->[1] eq "boolean") {
615	$term->put_option_db ($name, $flag ? "true" : "false");	678	$term->put_option_db ($name, $flag ? "true" : "false");
616	return 1;	679	return 1;
617	} else {	680	} else {
…		…
625	}	688	}
626		689
627	sub usage {	690	sub usage {
628	my ($term, $usage_type) = @_;	691	my ($term, $usage_type) = @_;
629		692
630	$term->scan_meta;	693	$term->scan_extensions;
631		694
632	my $r = $term->{meta}{resource};	695	my $r = $term->{meta}{resource};
633		696
634	for my $pattern (sort keys %$r) {	697	for my $pattern (sort keys %$r) {
635	my ($ext, $type, $desc) = @{ $r->{$pattern} };	698	my ($ext, $type, $desc) = @{ $r->{$pattern} };
…		…
650	urxvt::log sprintf " %-31s %s\n", "$pattern:", $type;	713	urxvt::log sprintf " %-31s %s\n", "$pattern:", $type;
651	}	714	}
652	}	715	}
653	}	716	}
654		717
655	my $verbosity = $ENV{URXVT_PERL_VERBOSITY};	718	my $verbosity = $ENV{URXVT_PERL_VERBOSITY} // 2;
656		719
657	sub verbose {	720	sub verbose {
658	my ($level, $msg) = @_;	721	my ($level, $msg) = @_;
659	warn "$msg\n" if $level <= $verbosity;	722	warn "$msg\n" if $level <= $verbosity;
660	}	723	}
…		…
677		740
678	open my $fh, "<:raw", $path	741	open my $fh, "<:raw", $path
679	or die "$path: $!";	742	or die "$path: $!";
680		743
681	my $source =	744	my $source =
682	"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"
683	. "#line 1 \"$path\"\n{\n"	746	. "#line 1 \"$path\"\n{\n"
684	. (do { local $/; <$fh> })	747	. (do { local $/; <$fh> })
685	. "\n};\n1";	748	. "\n};\n1";
686		749
687	eval $source	750	eval $source
…		…
696	# called by the rxvt core	759	# called by the rxvt core
697	sub invoke {	760	sub invoke {
698	local $TERM = shift;	761	local $TERM = shift;
699	my $htype = shift;	762	my $htype = shift;
700		763
701	if ($htype == 0) { # INIT	764	if ($htype == HOOK_INIT) {
702	my @dirs = $TERM->perl_libdirs;	765	$TERM->scan_extensions;
703		766
704	my %ext_arg;	767	my %ext_arg;
705		768
706	{	769	{
707	my @init = @TERM_INIT;	770	my @init = @TERM_INIT;
…		…
712	$TERM->register_package ($_) for @pkg;	775	$TERM->register_package ($_) for @pkg;
713	}	776	}
714		777
715	for (	778	for (
716	@{ delete $TERM->{perl_ext_3} },	779	@{ delete $TERM->{perl_ext_3} },
717	grep $_, map { split /,/, $TERM->resource ("perl_ext_$_") } 1, 2	780	(grep $_, map { split /,/, $TERM->resource ("perl_ext_$_") } 1, 2),
718	) {	781	) {
719	if ($_ eq "default") {	782	if ($_ eq "default") {
		783
		784	$ext_arg{$_} = []
720	$ext_arg{$_} \|\|= [] for qw(selection option-popup selection-popup searchable-scrollback readline);	785	for qw(selection option-popup selection-popup readline searchable-scrollback confirm-paste);
		786
		787	for ($TERM->_keysym_resources) {
		788	next if /^(?:string\|command\|builtin\|builtin-string\|perl)/;
		789	next unless /^([A-Za-z0-9_\-]+):/;
		790
		791	my $ext = $1;
		792
		793	$ext_arg{$ext} = [];
		794	}
		795
721	} elsif (/^-(.*)$/) {	796	} elsif (/^-(.*)$/) { # remove from set
722	delete $ext_arg{$1};	797	delete $ext_arg{$1};
723	} elsif (/^([^<]+)<(.*)>$/) {	798
		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};
724	push @{ $ext_arg{$1} }, $2;	804	push @{ $ext_arg{$1} }, defined $2 ? $2 : ();
		805
725	} else {	806	} else {
726	$ext_arg{$_} \|\|= [];	807	verbose 2, "cannot parse extension specification '$_', ignoring.";
727	}	808	}
728	}	809	}
729		810
		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
730	for my $ext (sort keys %ext_arg) {	814	for my $ext (sort keys %ext_arg) {
731	my @files = grep -f $_, map "$_/$ext", @dirs;	815	my $path = $TERM->extension_path ($ext);
732		816
733	if (@files) {	817	if (defined $path) {
734	$TERM->register_package (extension_package $files[0], $ext_arg{$ext});	818	$TERM->autoload_extension ($ext, $ext_arg{$ext});
735	} else {	819	} else {
736	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";
737	}	821	}
738	}	822	}
739		823
740	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");
741	warn $@ if $@;	825	warn $@ if $@;
742	}	826	}
743		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	}
		836	}
		837
744	$retval = undef;	838	$retval = undef;
745		839
746	if (my $cb = $TERM->{_hook}[$htype]) {	840	if (my $cb = $TERM->{_hook}[$htype]) {
747	verbose 10, "$HOOKNAME[$htype] (" . (join ", ", $TERM, @_) . ")"	841	verbose 10, "$HOOKNAME[$htype] (" . (join ", ", $TERM, @_) . ")"
748	if $verbosity >= 10;	842	if $verbosity >= 10;
		843
		844	if ($htype == HOOK_ACTION) {
		845	# this hook is only sent to the extension with the name
		846	# matching the first arg
		847	my $pkg = shift;
		848	$pkg =~ y/-/_/;
		849	$pkg = "urxvt::ext::$pkg";
		850
		851	$cb = $cb->{$pkg}
		852	or return undef; #TODO: maybe warn user?
		853
		854	$cb = { $pkg => $cb };
		855	}
749		856
750	for my $pkg (keys %$cb) {	857	for my $pkg (keys %$cb) {
751	my $retval_ = eval { $cb->{$pkg}->($TERM->{_pkg}{$pkg} \|\| $TERM, @_) };	858	my $retval_ = eval { $cb->{$pkg}->($TERM->{_pkg}{$pkg} \|\| $TERM, @_) };
752	$retval \|\|= $retval_;	859	$retval \|\|= $retval_;
753		860
…		…
759		866
760	verbose 11, "$HOOKNAME[$htype] returning <$retval>"	867	verbose 11, "$HOOKNAME[$htype] returning <$retval>"
761	if $verbosity >= 11;	868	if $verbosity >= 11;
762	}	869	}
763		870
764	if ($htype == 1) { # DESTROY	871	if ($htype == HOOK_DESTROY) {
765	# clear package objects	872	# clear package objects
766	%$_ = () for values %{ $TERM->{_pkg} };	873	%$_ = () for values %{ $TERM->{_pkg} };
767		874
768	# clear package	875	# clear package
769	%$TERM = ();	876	%$TERM = ();
…		…
801	($mask, @color{qw(fg bg)}, \@failed)	908	($mask, @color{qw(fg bg)}, \@failed)
802	}	909	}
803		910
804	package urxvt::term::extension;	911	package urxvt::term::extension;
805		912
806	sub enable {	913	=head2 The C<urxvt::term::extension> class
807	my ($self, %hook) = @_;
808	my $pkg = $self->{_pkg};
809		914
810	while (my ($name, $cb) = each %hook) {	915	Each extension attached to a terminal object is represented by
811	my $htype = $HOOKTYPE{uc $name};	916	a C<urxvt::term::extension> object.
812	defined $htype
813	or Carp::croak "unsupported hook type '$name'";
814		917
815	$self->set_should_invoke ($htype, +1)	918	You can use these objects, which are passed to all callbacks to store any
816	unless exists $self->{term}{_hook}[$htype]{$pkg};	919	state related to the terminal and extension instance.
817		920
818	$self->{term}{_hook}[$htype]{$pkg} = $cb;	921	The methods (And data members) documented below can be called on extension
819	}	922	objects, in addition to call methods documented for the <urxvt::term>
820	}	923	class.
821		924
822	sub disable {	925	=over
823	my ($self, @hook) = @_;
824	my $pkg = $self->{_pkg};
825		926
826	for my $name (@hook) {	927	=item $urxvt_term = $self->{term}
827	my $htype = $HOOKTYPE{uc $name};
828	defined $htype
829	or Carp::croak "unsupported hook type '$name'";
830		928
831	$self->set_should_invoke ($htype, -1)	929	Returns the C<urxvt::term> object associated with this instance of the
832	if delete $self->{term}{_hook}[$htype]{$pkg};	930	extension. This member I<must not> be changed in any way.
833	}	931
834	}	932	=cut
835		933
836	our $AUTOLOAD;	934	our $AUTOLOAD;
837		935
838	sub AUTOLOAD {	936	sub AUTOLOAD {
839	$AUTOLOAD =~ /:([^:]+)$/	937	$AUTOLOAD =~ /:([^:]+)$/
…		…
852		950
853	sub DESTROY {	951	sub DESTROY {
854	# nop	952	# nop
855	}	953	}
856		954
857	# urxvt::destroy_hook	955	# urxvt::destroy_hook (basically a cheap Guard:: implementation)
858		956
859	sub urxvt::destroy_hook::DESTROY {	957	sub urxvt::destroy_hook::DESTROY {
860	${$_[0]}->();	958	${$_[0]}->();
861	}	959	}
862		960
863	sub urxvt::destroy_hook(&) {	961	sub urxvt::destroy_hook(&) {
864	bless \shift, urxvt::destroy_hook::	962	bless \shift, urxvt::destroy_hook::
		963	}
		964
		965	=item $self->enable ($hook_name => $cb[, $hook_name => $cb..])
		966
		967	Dynamically enable the given hooks (named without the C<on_> prefix) for
		968	this extension, replacing any hook previously installed via C<enable> in
		969	this extension.
		970
		971	This is useful when you want to overwrite time-critical hooks only
		972	temporarily.
		973
		974	To install additional callbacks for the same hook, you can use the C<on>
		975	method of the C<urxvt::term> class.
		976
		977	=item $self->disable ($hook_name[, $hook_name..])
		978
		979	Dynamically disable the given hooks.
		980
		981	=cut
		982
		983	sub enable {
		984	my ($self, %hook) = @_;
		985	my $pkg = $self->{_pkg};
		986
		987	while (my ($name, $cb) = each %hook) {
		988	my $htype = $HOOKTYPE{uc $name};
		989	defined $htype
		990	or Carp::croak "unsupported hook type '$name'";
		991
		992	$self->set_should_invoke ($htype, +1)
		993	unless exists $self->{term}{_hook}[$htype]{$pkg};
		994
		995	$self->{term}{_hook}[$htype]{$pkg} = $cb;
		996	}
		997	}
		998
		999	sub disable {
		1000	my ($self, @hook) = @_;
		1001	my $pkg = $self->{_pkg};
		1002
		1003	for my $name (@hook) {
		1004	my $htype = $HOOKTYPE{uc $name};
		1005	defined $htype
		1006	or Carp::croak "unsupported hook type '$name'";
		1007
		1008	$self->set_should_invoke ($htype, -1)
		1009	if delete $self->{term}{_hook}[$htype]{$pkg};
		1010	}
		1011	}
		1012
		1013	=item $guard = $self->on ($hook_name => $cb[, $hook_name => $cb..])
		1014
		1015	Similar to the C<enable> enable, but installs additional callbacks for
		1016	the given hook(s) (that is, it doesn't replace existing callbacks), and
		1017	returns a guard object. When the guard object is destroyed the callbacks
		1018	are disabled again.
		1019
		1020	=cut
		1021
		1022	sub urxvt::extension::on_disable::DESTROY {
		1023	my $disable = shift;
		1024
		1025	my $term = delete $disable->{""};
		1026
		1027	while (my ($htype, $id) = each %$disable) {
		1028	delete $term->{_hook}[$htype]{$id};
		1029	$term->set_should_invoke ($htype, -1);
		1030	}
		1031	}
		1032
		1033	sub on {
		1034	my ($self, %hook) = @_;
		1035
		1036	my $term = $self->{term};
		1037
		1038	my %disable = ( "" => $term );
		1039
		1040	while (my ($name, $cb) = each %hook) {
		1041	my $htype = $HOOKTYPE{uc $name};
		1042	defined $htype
		1043	or Carp::croak "unsupported hook type '$name'";
		1044
		1045	$term->set_should_invoke ($htype, +1);
		1046	$term->{_hook}[$htype]{ $disable{$htype} = $cb+0 }
		1047	= sub { shift; $cb->($self, @_) }; # very ugly indeed
		1048	}
		1049
		1050	bless \%disable, "urxvt::extension::on_disable"
		1051	}
		1052
		1053	=item $self->bind_action ($hotkey, $action)
		1054
		1055	=item $self->x_resource ($pattern)
		1056
		1057	=item $self->x_resource_boolean ($pattern)
		1058
		1059	These methods support an additional C<%> prefix for C<$action> or
		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
		1062	methods in the C<urxvt::term> class for details.
		1063
		1064	=cut
		1065
		1066	sub bind_action {
		1067	my ($self, $hotkey, $action) = @_;
		1068	$action =~ s/^%:/$_[0]{_name}:/;
		1069	$self->{term}->bind_action ($hotkey, $action)
865	}	1070	}
866		1071
867	sub x_resource {	1072	sub x_resource {
868	my ($self, $name) = @_;	1073	my ($self, $name) = @_;
869	$name =~ s/^%(\.\|$)/$_[0]{_name}$1/;	1074	$name =~ s/^%(\.\|$)/$_[0]{_name}$1/;
…		…
873	sub x_resource_boolean {	1078	sub x_resource_boolean {
874	my ($self, $name) = @_;	1079	my ($self, $name) = @_;
875	$name =~ s/^%(\.\|$)/$_[0]{_name}$1/;	1080	$name =~ s/^%(\.\|$)/$_[0]{_name}$1/;
876	$self->{term}->x_resource_boolean ($name)	1081	$self->{term}->x_resource_boolean ($name)
877	}	1082	}
		1083
		1084	=back
		1085
		1086	=cut
878		1087
879	package urxvt::anyevent;	1088	package urxvt::anyevent;
880		1089
881	=head2 The C<urxvt::anyevent> Class	1090	=head2 The C<urxvt::anyevent> Class
882		1091
…		…
962		1171
963	package urxvt::term;	1172	package urxvt::term;
964		1173
965	=head2 The C<urxvt::term> Class	1174	=head2 The C<urxvt::term> Class
966		1175
967	=over 4	1176	=over
968		1177
969	=cut	1178	=cut
970		1179
971	# find on_xxx subs in the package and register them	1180	# find on_xxx subs in the package and register them
972	# as hooks	1181	# as hooks
…		…
993	$proxy->enable ($name => $ref);	1202	$proxy->enable ($name => $ref);
994	}	1203	}
995	}	1204	}
996	}	1205	}
997		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
998	sub perl_libdirs {	1231	sub perl_libdirs {
999	map { split /:/ }	1232	map { split /:/ }
1000	$_[0]->resource ("perl_lib"),	1233	$_[0]->resource ("perl_lib"),
1001	$ENV{URXVT_PERL_LIB},	1234	$ENV{URXVT_PERL_LIB},
1002	"$ENV{HOME}/.urxvt/ext",	1235	"$ENV{HOME}/.urxvt/ext",
1003	"$LIBDIR/perl"	1236	"$LIBDIR/perl"
1004	}	1237	}
1005		1238
1006	sub scan_meta {	1239	# scan for available extensions and collect their metadata
		1240	sub scan_extensions {
1007	my ($self) = @_;	1241	my ($self) = @_;
		1242
		1243	return if exists $self->{meta};
		1244
1008	my @libdirs = perl_libdirs $self;	1245	my @urxvtdirs = perl_libdirs $self;
		1246	# my @cpandirs = grep -d, map "$_/URxvt/Ext", @INC;
1009		1247
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;	1248	$self->{meta} = \my %allmeta;
1016		1249
1017	for my $dir (reverse @libdirs) {	1250	# first gather extensions
		1251
		1252	my $gather = sub {
		1253	my ($dir, $core) = @_;
		1254
1018	opendir my $fh, $dir	1255	opendir my $fh, $dir
1019	or next;	1256	or return;
		1257
1020	for my $ext (readdir $fh) {	1258	for my $ext (readdir $fh) {
1021	$ext ne "."	1259	$ext !~ /^\./
1022	and $ext ne ".."
1023	and open my $fh, "<", "$dir/$ext"
1024	or next;	1260	or next;
1025		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
		1271	my %meta = (dir => $dir);
		1272
1026	while (<$fh>) {	1273	while (<$fh>) {
1027	if (/^#:META:X_RESOURCE:(.*)/) {	1274	if (/^#:META:(?:X_)?RESOURCE:(.*)/) {
1028	my ($pattern, $type, $desc) = split /:/, $1;	1275	my ($pattern, $type, $desc) = split /:/, $1;
1029	$pattern =~ s/^%(\.\|$)/$ext$1/g; # % in pattern == extension name	1276	$pattern =~ s/^%(\.\|$)/$ext$1/g; # % in pattern == extension name
1030	if ($pattern =~ /[^a-zA-Z0-9\-\.]/) {	1277	if ($pattern =~ /[^a-zA-Z0-9\-\.]/) {
1031	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";
1032	} else {	1279	} else {
1033	$meta{resource}{$pattern} = [$ext, $type, $desc];	1280	$meta{resource}{$pattern} = [$ext, $type, $desc];
1034	}	1281	}
		1282
		1283	} elsif (/^#:META:OSC:([0-9]+):(.*)/) {
		1284	push @{$allmeta{autoload_osc}{$1}}, [$ext, $2];
		1285
		1286	} elsif (/^#:META:OSC_PERL:([^:]+):(.*)/) {
		1287	push @{$allmeta{autoload_osc_perl}{$1}}, [$ext, $2];
		1288
1035	} elsif (/^\s*(?:#\|$)/) {	1289	} elsif (/^\s*(?:#\|$)/) {
1036	# skip other comments and empty lines	1290	# skip other comments and empty lines
		1291
1037	} else {	1292	} else {
1038	last; # stop parsing on first non-empty non-comment line	1293	last; # stop parsing on first non-empty non-comment line
1039	}	1294	}
1040	}	1295	}
		1296
		1297	$allmeta{ext}{$ext} = \%meta;
1041	}	1298	}
		1299	};
		1300
		1301	# $gather->($_, 0) for @cpandirs;
		1302	$gather->($_, 1) for @urxvtdirs;
		1303
		1304	# and now merge resources
		1305
		1306	$allmeta{resource} = \my %resource;
		1307
		1308	while (my ($k, $v) = each %{ $allmeta{ext} }) {
		1309	#TODO: should check for extensions overriding each other
		1310	%resource = (%resource, %{ $v->{resource} });
1042	}	1311	}
1043	}	1312	}
1044		1313
1045	=item $term = new urxvt::term $envhashref, $rxvtname, [arg...]	1314	=item $term = new urxvt::term $envhashref, $rxvtname, [arg...]
1046		1315
…		…
1066	}	1335	}
1067		1336
1068	=item $term->destroy	1337	=item $term->destroy
1069		1338
1070	Destroy the terminal object (close the window, free resources	1339	Destroy the terminal object (close the window, free resources
1071	etc.). Please note that @@RXVT_NAME@@ will not exit as long as any event	1340	etc.). Please note that urxvt will not exit as long as any event
1072	watchers (timers, io watchers) are still active.	1341	watchers (timers, io watchers) are still active.
1073
1074	=item $guard = $self->on ($hook_name => $cb[, $hook_name => $cb..])
1075
1076	Similar to the extension method C<enable>, but installs additional
1077	callbacks for the givne hook(s) (existing ones are not replaced), and
1078	returns a guard object. When the guard object is destroyed the callbacks
1079	are disabled again.
1080
1081	Note that these callbacks receive the normal paramaters, but the first
1082	argument (normally the extension) is currently undefined.
1083
1084	=cut
1085
1086	sub urxvt::term::on_disable::DESTROY {
1087	my $disable = shift;
1088
1089	my $self = delete $disable->{""};
1090
1091	while (my ($htype, $id) = each %$disable) {
1092	delete $self->{_hook}[$htype]{$id};
1093	$self->set_should_invoke ($htype, -1);
1094	}
1095	}
1096
1097	sub on {
1098	my ($self, %hook) = @_;
1099
1100	my %disable = ( "" => $self );
1101
1102	while (my ($name, $cb) = each %hook) {
1103	my $htype = $HOOKTYPE{uc $name};
1104	defined $htype
1105	or Carp::croak "unsupported hook type '$name'";
1106
1107	my $id = $cb+0;
1108
1109	$self->set_should_invoke ($htype, +1);
1110	$disable{$htype} = $id;
1111	$self->{_hook}[$htype]{$id} = $cb;
1112	}
1113
1114	bless \%disable, "urxvt::term::on_disable"
1115	}
1116		1342
1117	=item $term->exec_async ($cmd[, @args])	1343	=item $term->exec_async ($cmd[, @args])
1118		1344
1119	Works like the combination of the C<fork>/C<exec> builtins, which executes	1345	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	1346	("starts") programs in the background. This function takes care of setting
…		…
1152	insecure intensityStyles iso14755 iso14755_52 jumpScroll loginShell	1378	insecure intensityStyles iso14755 iso14755_52 jumpScroll loginShell
1153	mapAlert meta8 mouseWheelScrollPage override_redirect pastableTabs	1379	mapAlert meta8 mouseWheelScrollPage override_redirect pastableTabs
1154	pointerBlank reverseVideo scrollBar scrollBar_floating scrollBar_right	1380	pointerBlank reverseVideo scrollBar scrollBar_floating scrollBar_right
1155	scrollTtyKeypress scrollTtyOutput scrollWithBuffer secondaryScreen	1381	scrollTtyKeypress scrollTtyOutput scrollWithBuffer secondaryScreen
1156	secondaryScroll skipBuiltinGlyphs skipScroll transparent tripleclickwords	1382	secondaryScroll skipBuiltinGlyphs skipScroll transparent tripleclickwords
1157	urgentOnBell utmpInhibit visualBell	1383	urgentOnBell utmpInhibit visualBell disablePasteBrackets
1158		1384
1159	=item $value = $term->resource ($name[, $newval])	1385	=item $value = $term->resource ($name[, $newval])
1160		1386
1161	Returns the current resource value associated with a given name and	1387	Returns the current resource value associated with a given name and
1162	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>
…		…
1188	preeditType print_pipe pty_fd reverseVideo saveLines scrollBar	1414	preeditType print_pipe pty_fd reverseVideo saveLines scrollBar
1189	scrollBar_align scrollBar_floating scrollBar_right scrollBar_thickness	1415	scrollBar_align scrollBar_floating scrollBar_right scrollBar_thickness
1190	scrollTtyKeypress scrollTtyOutput scrollWithBuffer scrollstyle	1416	scrollTtyKeypress scrollTtyOutput scrollWithBuffer scrollstyle
1191	secondaryScreen secondaryScroll shade skipBuiltinGlyphs skipScroll	1417	secondaryScreen secondaryScroll shade skipBuiltinGlyphs skipScroll
1192	term_name title transient_for transparent tripleclickwords urgentOnBell	1418	term_name title transient_for transparent tripleclickwords urgentOnBell
1193	utmpInhibit visualBell	1419	utmpInhibit visualBell rewrapMode disablePasteBrackets
1194		1420
1195	=cut	1421	=cut
1196		1422
1197	sub resource($$;$) {	1423	sub resource($$;$) {
1198	my ($self, $name) = (shift, shift);	1424	my ($self, $name) = (shift, shift);
…		…
1205	Returns the X-Resource for the given pattern, excluding the program or	1431	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	1432	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	1433	same value as used by this instance of rxvt-unicode. Returns C<undef> if no
1208	resource with that pattern exists.	1434	resource with that pattern exists.
1209		1435
1210	Extensions that define extra resource or command line arguments also need	1436	Extensions that define extra resources also need to call this method
1211	to call this method to access their values.	1437	to access their values.
1212		1438
1213	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
1214	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
1215	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
1216	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
1217	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
1218	without having to change the actual code.	1444	the actual code.
1219		1445
1220	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
1221	only one resource database per display, and later invocations might return	1447	only one resource database per display, and later invocations might return
1222	the wrong resources.	1448	the wrong resources.
1223		1449
…		…
1235	my $res = &x_resource;	1461	my $res = &x_resource;
1236		1462
1237	$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
1238	}	1464	}
1239		1465
1240	=item $success = $term->parse_keysym ($key, $octets)	1466	=item $action = $term->lookup_keysym ($keysym, $state)
1241		1467
		1468	Returns the action bound to key combination C<($keysym, $state)>,
		1469	if a binding for it exists, and C<undef> otherwise.
		1470
		1471	=item $success = $term->bind_action ($key, $action)
		1472
1242	Adds a key binding exactly as specified via a resource. See the	1473	Adds a key binding exactly as specified via a C<keysym> resource. See the
1243	C<keysym> resource in the @@RXVT_NAME@@(1) manpage.	1474	C<keysym> resource in the urxvt(1) manpage.
1244		1475
1245	=item $term->register_command ($keysym, $modifiermask, $string)	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.
1246		1480
1247	Adds a key binding. This is a lower level api compared to	1481	Example: the C<searchable-scrollback> by default binds itself
1248	C<parse_keysym>, as it expects a parsed key description, and can be	1482	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	1483	$term->bind_action >>.
1250	C<on_register_command> hook, to modify a parsed binding.	1484
		1485	sub init {
		1486	my ($self) = @_;
		1487
		1488	$self->bind_action ("M-s" => "%:start");
		1489	}
1251		1490
1252	=item $rend = $term->rstyle ([$new_rstyle])	1491	=item $rend = $term->rstyle ([$new_rstyle])
1253		1492
1254	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
1255	the terminal application will use this style.	1494	the terminal application will use this style.
…		…
1332	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
1333	as long as the perl object is referenced.	1572	as long as the perl object is referenced.
1334		1573
1335	The methods currently supported on C<urxvt::overlay> objects are:	1574	The methods currently supported on C<urxvt::overlay> objects are:
1336		1575
1337	=over 4	1576	=over
1338		1577
1339	=item $overlay->set ($x, $y, $text[, $rend])	1578	=item $overlay->set ($x, $y, $text[, $rend])
1340		1579
1341	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
1342	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
…		…
1413		1652
1414	=item $term->scr_add_lines ($string)	1653	=item $term->scr_add_lines ($string)
1415		1654
1416	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
1417	running inside the terminal. It may not contain command sequences (escape	1656	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	1657	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.	1658	carriage returns and tabs. The string is a normal text string, not in
		1659	locale-dependent encoding.
1420		1660
1421	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
1422	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
1423	C<on_add_lines> hook, though.	1663	C<on_add_lines> hook, though.
1424		1664
…		…
1432	locale-specific encoding of the terminal and can contain command sequences	1672	locale-specific encoding of the terminal and can contain command sequences
1433	(escape codes) that will be interpreted.	1673	(escape codes) that will be interpreted.
1434		1674
1435	=item $term->tt_write ($octets)	1675	=item $term->tt_write ($octets)
1436		1676
1437	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
1438	pass characters instead of octets, you should convert your strings first	1679	characters instead of octets, you should convert your strings first to the
1439	to the locale-specific encoding using C<< $term->locale_encode >>.	1680	locale-specific encoding using C<< $term->locale_encode >>.
		1681
		1682	=item $term->tt_write_user_input ($octets)
		1683
		1684	Like C<tt_write>, but should be used when writing strings in response to
		1685	the user pressing a key, to invoke the additional actions requested by
		1686	the user for that case (C<tt_write> doesn't do that).
		1687
		1688	The typical use case would be inside C<on_action> hooks.
1440		1689
1441	=item $term->tt_paste ($octets)	1690	=item $term->tt_paste ($octets)
1442		1691
1443	Write the octets given in C<$octets> to the tty as a paste, converting NL to	1692	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	1693	CR and bracketing the data with control sequences if bracketed paste mode
…		…
1483		1732
1484	=item $term->key_release ($state, $keycode[, $time])	1733	=item $term->key_release ($state, $keycode[, $time])
1485		1734
1486	Deliver various fake events to to terminal.	1735	Deliver various fake events to to terminal.
1487		1736
1488	=item $window_width = $term->width	1737	=item $window_width = $term->width ([$new_value])
1489		1738
1490	=item $window_height = $term->height	1739	=item $window_height = $term->height ([$new_value])
1491		1740
1492	=item $font_width = $term->fwidth	1741	=item $font_width = $term->fwidth ([$new_value])
1493		1742
1494	=item $font_height = $term->fheight	1743	=item $font_height = $term->fheight ([$new_value])
1495		1744
1496	=item $font_ascent = $term->fbase	1745	=item $font_ascent = $term->fbase ([$new_value])
1497		1746
1498	=item $terminal_rows = $term->nrow	1747	=item $terminal_rows = $term->nrow ([$new_value])
1499		1748
1500	=item $terminal_columns = $term->ncol	1749	=item $terminal_columns = $term->ncol ([$new_value])
1501		1750
1502	=item $has_focus = $term->focus	1751	=item $has_focus = $term->focus ([$new_value])
1503		1752
1504	=item $is_mapped = $term->mapped	1753	=item $is_mapped = $term->mapped ([$new_value])
1505		1754
1506	=item $max_scrollback = $term->saveLines	1755	=item $max_scrollback = $term->saveLines ([$new_value])
1507		1756
1508	=item $nrow_plus_saveLines = $term->total_rows	1757	=item $nrow_plus_saveLines = $term->total_rows ([$new_value])
1509		1758
1510	=item $topmost_scrollback_row = $term->top_row	1759	=item $topmost_scrollback_row = $term->top_row ([$new_value])
1511		1760
1512	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.
1513		1763
1514	=item $x_display = $term->display_id	1764	=item $x_display = $term->display_id
1515		1765
1516	Return the DISPLAY used by rxvt-unicode.	1766	Return the DISPLAY used by rxvt-unicode.
1517		1767
…		…
1554		1804
1555	=item $cursor_is_hidden = $term->hidden_cursor	1805	=item $cursor_is_hidden = $term->hidden_cursor
1556		1806
1557	Returns whether the cursor is currently hidden or not.	1807	Returns whether the cursor is currently hidden or not.
1558		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
1559	=item $view_start = $term->view_start ([$newvalue])	1819	=item $view_start = $term->view_start ([$newvalue])
1560		1820
1561	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,
1562	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
1563	this many lines into the scrollback buffer.	1823	the terminal contents. Lower values scroll this many lines into the
		1824	scrollback buffer.
1564		1825
1565	=item $term->want_refresh	1826	=item $term->want_refresh
1566		1827
1567	Requests a screen refresh. At the next opportunity, rxvt-unicode will	1828	Requests a screen refresh. At the next opportunity, rxvt-unicode will
1568	compare the on-screen display with its stored representation. If they	1829	compare the on-screen display with its stored representation. If they
1569	differ, it redraws the differences.	1830	differ, it redraws the differences.
1570		1831
1571	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.
1572		1837
1573	=item $text = $term->ROW_t ($row_number[, $new_text[, $start_col]])	1838	=item $text = $term->ROW_t ($row_number[, $new_text[, $start_col]])
1574		1839
1575	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 >>
1576	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
…		…
1622		1887
1623	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
1624	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
1625	following methods:	1890	following methods:
1626		1891
1627	=over 4	1892	=over
1628		1893
1629	=item $text = $line->t ([$new_text])	1894	=item $text = $line->t ([$new_text])
1630		1895
1631	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>
1632		1897
…		…
1678	}	1943	}
1679		1944
1680	sub urxvt::line::t {	1945	sub urxvt::line::t {
1681	my ($self) = @_;	1946	my ($self) = @_;
1682		1947
1683	if (@_ > 1)	1948	if (@_ > 1) {
1684	{
1685	$self->{term}->ROW_t ($_, $_[1], 0, ($_ - $self->{beg}) * $self->{ncol}, $self->{ncol})	1949	$self->{term}->ROW_t ($_, $_[1], 0, ($_ - $self->{beg}) * $self->{ncol}, $self->{ncol})
1686	for $self->{beg} .. $self->{end};	1950	for $self->{beg} .. $self->{end};
1687	}	1951	}
1688		1952
1689	defined wantarray &&	1953	defined wantarray &&
1690	substr +(join "", map $self->{term}->ROW_t ($_), $self->{beg} .. $self->{end}),	1954	substr +(join "", map $self->{term}->ROW_t ($_), $self->{beg} .. $self->{end}),
1691	0, $self->{len}	1955	0, $self->{len}
1692	}	1956	}
1693		1957
1694	sub urxvt::line::r {	1958	sub urxvt::line::r {
1695	my ($self) = @_;	1959	my ($self) = @_;
1696		1960
1697	if (@_ > 1)	1961	if (@_ > 1) {
1698	{
1699	$self->{term}->ROW_r ($_, $_[1], 0, ($_ - $self->{beg}) * $self->{ncol}, $self->{ncol})	1962	$self->{term}->ROW_r ($_, $_[1], 0, ($_ - $self->{beg}) * $self->{ncol}, $self->{ncol})
1700	for $self->{beg} .. $self->{end};	1963	for $self->{beg} .. $self->{end};
1701	}	1964	}
1702		1965
1703	if (defined wantarray) {	1966	if (defined wantarray) {
1704	my $rend = [	1967	my $rend = [
1705	map @{ $self->{term}->ROW_r ($_) }, $self->{beg} .. $self->{end}	1968	map @{ $self->{term}->ROW_r ($_) }, $self->{beg} .. $self->{end}
1706	];	1969	];
…		…
1738	where one character corresponds to one screen cell. See	2001	where one character corresponds to one screen cell. See
1739	C<< $term->ROW_t >> for details.	2002	C<< $term->ROW_t >> for details.
1740		2003
1741	=item $string = $term->special_decode $text	2004	=item $string = $term->special_decode $text
1742		2005
1743	Converts rxvt-unicodes text representation into a perl string. See	2006	Converts rxvt-unicode's text representation into a perl string. See
1744	C<< $term->ROW_t >> for details.	2007	C<< $term->ROW_t >> for details.
1745		2008
1746	=item $success = $term->grab_button ($button, $modifiermask[, $window = $term->vt])	2009	=item $success = $term->grab_button ($button, $modifiermask[, $window = $term->vt])
1747		2010
1748	=item $term->ungrab_button ($button, $modifiermask[, $window = $term->vt])	2011	=item $term->ungrab_button ($button, $modifiermask[, $window = $term->vt])
…		…
1814		2077
1815	package urxvt::popup;	2078	package urxvt::popup;
1816		2079
1817	=head2 The C<urxvt::popup> Class	2080	=head2 The C<urxvt::popup> Class
1818		2081
1819	=over 4	2082	=over
1820		2083
1821	=cut	2084	=cut
1822		2085
1823	sub add_item {	2086	sub add_item {
1824	my ($self, $item) = @_;	2087	my ($self, $item) = @_;
…		…
1960	->cb (sub {	2223	->cb (sub {
1961	$term->{overlay}->set (0, 0,	2224	$term->{overlay}->set (0, 0,
1962	sprintf "%2d:%02d:%02d", (localtime urxvt::NOW)[2,1,0]);	2225	sprintf "%2d:%02d:%02d", (localtime urxvt::NOW)[2,1,0]);
1963	});	2226	});
1964		2227
1965	=over 4	2228	=over
1966		2229
1967	=item $timer = new urxvt::timer	2230	=item $timer = new urxvt::timer
1968		2231
1969	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
1970	immediately.	2233	immediately.
…		…
2019	sysread $term->{socket}, my $buf, 8192	2282	sysread $term->{socket}, my $buf, 8192
2020	or end-of-file;	2283	or end-of-file;
2021	});	2284	});
2022		2285
2023		2286
2024	=over 4	2287	=over
2025		2288
2026	=item $iow = new urxvt::iow	2289	=item $iow = new urxvt::iow
2027		2290
2028	Create a new io watcher object in stopped state.	2291	Create a new io watcher object in stopped state.
2029		2292
…		…
2056		2319
2057	This class implements idle watchers, that get called automatically when	2320	This class implements idle watchers, that get called automatically when
2058	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
2059	some useful work.	2322	some useful work.
2060		2323
2061	=over 4	2324	=over
2062		2325
2063	=item $iw = new urxvt::iw	2326	=item $iw = new urxvt::iw
2064		2327
2065	Create a new idle watcher object in stopped state.	2328	Create a new idle watcher object in stopped state.
2066		2329
…		…
2091	->cb (sub {	2354	->cb (sub {
2092	my ($pw, $exit_status) = @_;	2355	my ($pw, $exit_status) = @_;
2093	...	2356	...
2094	});	2357	});
2095		2358
2096	=over 4	2359	=over
2097		2360
2098	=item $pw = new urxvt::pw	2361	=item $pw = new urxvt::pw
2099		2362
2100	Create a new process watcher in stopped state.	2363	Create a new process watcher in stopped state.
2101		2364
…		…
2118	=head2 URXVT_PERL_VERBOSITY	2381	=head2 URXVT_PERL_VERBOSITY
2119		2382
2120	This variable controls the verbosity level of the perl extension. Higher	2383	This variable controls the verbosity level of the perl extension. Higher
2121	numbers indicate more verbose output.	2384	numbers indicate more verbose output.
2122		2385
2123	=over 4	2386	=over
2124		2387
2125	=item == 0 - fatal messages	2388	=item == 0 - fatal messages only
		2389
		2390	=item >= 2 - general warnings (default level)
2126		2391
2127	=item >= 3 - script loading and management	2392	=item >= 3 - script loading and management
2128		2393
2129	=item >=10 - all called hooks	2394	=item >=10 - all called hooks
2130		2395

Diff Legend

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

Comparing rxvt-unicode/src/urxvt.pm (file contents): Revision 1.220 by root, Tue Jun 19 18:17:56 2012 UTC vs. Revision 1.268 by root, Sat Jul 24 13:07:56 2021 UTC

Diff Legend

Comparing rxvt-unicode/src/urxvt.pm (file contents):
Revision 1.220 by root, Tue Jun 19 18:17:56 2012 UTC vs.
Revision 1.268 by root, Sat Jul 24 13:07:56 2021 UTC