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

Comparing rxvt-unicode/src/urxvt.pm (file contents):
Revision 1.222 by root, Sat Jul 7 07:00:17 2012 UTC vs.
Revision 1.269 by root, Sun Nov 21 15:15:02 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.
…		…
106	C<urxvt::term> class on this object.	112	C<urxvt::term> class on this object.
107		113
108	Additional methods only supported for extension objects are described in	114	Additional methods only supported for extension objects are described in
109	the C<urxvt::extension> section below.	115	the C<urxvt::extension> section below.
110		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
		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> resource 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 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
		183
		184	=back
		185
111	=head2 Hooks	186	=head2 Hooks
112		187
113	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
114	called whenever the relevant event happens.	189	called whenever the relevant event happens.
115		190
…		…
120	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
121	relevant action might not be carried out by the C++ code.	196	relevant action might not be carried out by the C++ code.
122		197
123	I<< When in doubt, return a false value (preferably C<()>). >>	198	I<< When in doubt, return a false value (preferably C<()>). >>
124		199
125	=over 4	200	=over
126		201
127	=item on_init $term	202	=item on_init $term
128		203
129	Called after a new terminal object has been initialized, but before	204	Called after a new terminal object has been initialized, but before
130	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
…		…
212		287
213	C<on_osc_seq_perl> should be used for new behaviour.	288	C<on_osc_seq_perl> should be used for new behaviour.
214		289
215	=item on_osc_seq_perl $term, $args, $resp	290	=item on_osc_seq_perl $term, $args, $resp
216		291
217	Called whenever the B<ESC ] 777 ; string ST> command sequence (OSC =	292	Called whenever the B<ESC ] 777 ; prefix ; string ST> command sequence
218	operating system command) is processed. Cursor position and other state	293	(OSC = operating system command) is processed. Cursor position and other
219	information is up-to-date when this happens. For interoperability, the	294	state information is up-to-date when this happens. For interoperability,
220	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
221	to distinguish it from commands for other extensions, and this might be	296	other suitable prefix, and a semicolon, to distinguish it from commands
222	enforced in the future.	297	for other extensions.
223		298
224	For example, C<overlay-osc> uses this:	299	For example, C<overlay-osc> uses this:
225		300
226	sub on_osc_seq_perl {	301	sub on_osc_seq_perl {
227	my ($self, $osc, $resp) = @_;	302	my ($self, $osc, $resp) = @_;
…		…
281		356
282	=item on_refresh_end $term	357	=item on_refresh_end $term
283		358
284	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>.
285		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
286	=item on_user_command $term, $string	369	=item on_user_command $term, $string DEPRECATED
287		370
288	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
289	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>
290	resource in the @@RXVT_NAME@@(1) manpage).	373	resource in the urxvt(1) manpage).
291		374
292	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
293	slightly in the future.	376	preference to the C<on_action> hook.
294
295	=item on_register_command $term, $keysym, $modifiermask, $string
296
297	Called after parsing a keysym resource but before registering the
298	associated binding. If this hook returns TRUE the binding is not
299	registered. It can be used to modify a binding by calling
300	C<register_command>.
301		377
302	=item on_resize_all_windows $term, $new_width, $new_height	378	=item on_resize_all_windows $term, $new_width, $new_height
303		379
304	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
305	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
306	returns TRUE, setting of the window hints is being skipped.	382	returns a true value, setting of the window hints is being skipped.
307		383
308	=item on_x_event $term, $event	384	=item on_x_event $term, $event
309		385
310	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
311	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
…		…
351	(real, not screen-based) row and column under the mouse cursor.	427	(real, not screen-based) row and column under the mouse cursor.
352		428
353	C<on_key_press> additionally receives the string rxvt-unicode would	429	C<on_key_press> additionally receives the string rxvt-unicode would
354	output, if any, in locale-specific encoding.	430	output, if any, in locale-specific encoding.
355		431
356	subwindow.
357
358	=item on_client_message $term, $event	432	=item on_client_message $term, $event
359		433
360	=item on_wm_protocols $term, $event	434	=item on_wm_protocols $term, $event
361		435
362	=item on_wm_delete_window $term, $event	436	=item on_wm_delete_window $term, $event
…		…
373	=cut	447	=cut
374		448
375	package urxvt;	449	package urxvt;
376		450
377	use utf8;	451	use utf8;
378	use strict 'vars';	452	use strict qw(vars subs);
379	use Carp ();	453	use Carp ();
380	use Scalar::Util ();	454	use Scalar::Util ();
381	use List::Util ();	455	use List::Util ();
382		456
383	our $VERSION = 1;	457	our $VERSION = 1;
…		…
395		469
396	our $NOCHAR = chr 0xffff;	470	our $NOCHAR = chr 0xffff;
397		471
398	=head2 Variables in the C<urxvt> Package	472	=head2 Variables in the C<urxvt> Package
399		473
400	=over 4	474	=over
401		475
402	=item $urxvt::LIBDIR	476	=item $urxvt::LIBDIR
403		477
404	The rxvt-unicode library directory, where, among other things, the perl	478	The rxvt-unicode library directory, where, among other things, the perl
405	modules and scripts are stored.	479	modules and scripts are stored.
…		…
435		509
436	=back	510	=back
437		511
438	=head2 Functions in the C<urxvt> Package	512	=head2 Functions in the C<urxvt> Package
439		513
440	=over 4	514	=over
441		515
442	=item urxvt::fatal $errormessage	516	=item urxvt::fatal $errormessage
443		517
444	Fatally aborts execution with the given error message (which should	518	Fatally aborts execution with the given error message (which should
445	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
…		…
490	CirculateRequest, PropertyNotify, SelectionClear, SelectionRequest,	564	CirculateRequest, PropertyNotify, SelectionClear, SelectionRequest,
491	SelectionNotify, ColormapNotify, ClientMessage, MappingNotify	565	SelectionNotify, ColormapNotify, ClientMessage, MappingNotify
492		566
493	Various constants for use in X calls and event processing.	567	Various constants for use in X calls and event processing.
494		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
495	=back	581	=back
496		582
497	=head2 RENDITION	583	=head2 RENDITION
498		584
499	Rendition bitsets contain information about colour, font, font styles and	585	Rendition bitsets contain information about colour, font, font styles and
…		…
502	The following "macros" deal with changes in rendition sets. You should	588	The following "macros" deal with changes in rendition sets. You should
503	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,
504	as they contain important information required for correct operation of	590	as they contain important information required for correct operation of
505	rxvt-unicode.	591	rxvt-unicode.
506		592
507	=over 4	593	=over
508		594
509	=item $rend = urxvt::DEFAULT_RSTYLE	595	=item $rend = urxvt::DEFAULT_RSTYLE
510		596
511	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
512	being reset. Useful as a base to start when creating renditions.	598	being reset. Useful as a base to start when creating renditions.
…		…
564	no warnings 'utf8';	650	no warnings 'utf8';
565		651
566	sub parse_resource {	652	sub parse_resource {
567	my ($term, $name, $isarg, $longopt, $flag, $value) = @_;	653	my ($term, $name, $isarg, $longopt, $flag, $value) = @_;
568		654
569	$name =~ y/-/./ if $isarg;
570
571	$term->scan_meta;	655	$term->scan_extensions;
572		656
		657	# iterating over all resources has quadratic time overhead
		658	# overall, maybe this could be optimised?
573	my $r = $term->{meta}{resource};	659	my $r = $term->{meta}{resource};
574	keys %$r; # reste iterator	660	keys %$r; # reset iterator
575	while (my ($pattern, $v) = each %$r) {	661	while (my ($k, $v) = each %$r) {
576	if (	662	my $pattern = $k;
		663	$pattern =~ y/./-/ if $isarg;
		664	my $prefix = $name;
		665	my $suffix;
577	$pattern =~ /\.$/	666	if ($pattern =~ /\-$/) {
578	? $pattern eq substr $name, 0, length $pattern	667	$prefix = substr $name, 0, length $pattern;
579	: $pattern eq $name	668	$suffix = substr $name, length $pattern;
580	) {	669	}
		670	if ($pattern eq $prefix) {
581	$name = "$urxvt::RESCLASS.$name";	671	$name = "$urxvt::RESCLASS.$k$suffix";
582		672
583	push @{ $term->{perl_ext_3} }, $v->[0];	673	push @{ $term->{perl_ext_3} }, $v->[0];
		674
		675	return 1 unless $isarg;
584		676
585	if ($v->[1] eq "boolean") {	677	if ($v->[1] eq "boolean") {
586	$term->put_option_db ($name, $flag ? "true" : "false");	678	$term->put_option_db ($name, $flag ? "true" : "false");
587	return 1;	679	return 1;
588	} else {	680	} else {
…		…
596	}	688	}
597		689
598	sub usage {	690	sub usage {
599	my ($term, $usage_type) = @_;	691	my ($term, $usage_type) = @_;
600		692
601	$term->scan_meta;	693	$term->scan_extensions;
602		694
603	my $r = $term->{meta}{resource};	695	my $r = $term->{meta}{resource};
604		696
605	for my $pattern (sort keys %$r) {	697	for my $pattern (sort keys %$r) {
606	my ($ext, $type, $desc) = @{ $r->{$pattern} };	698	my ($ext, $type, $desc) = @{ $r->{$pattern} };
…		…
621	urxvt::log sprintf " %-31s %s\n", "$pattern:", $type;	713	urxvt::log sprintf " %-31s %s\n", "$pattern:", $type;
622	}	714	}
623	}	715	}
624	}	716	}
625		717
626	my $verbosity = $ENV{URXVT_PERL_VERBOSITY};	718	my $verbosity = $ENV{URXVT_PERL_VERBOSITY} // 2;
627		719
628	sub verbose {	720	sub verbose {
629	my ($level, $msg) = @_;	721	my ($level, $msg) = @_;
630	warn "$msg\n" if $level <= $verbosity;	722	warn "$msg\n" if $level <= $verbosity;
631	}	723	}
…		…
648		740
649	open my $fh, "<:raw", $path	741	open my $fh, "<:raw", $path
650	or die "$path: $!";	742	or die "$path: $!";
651		743
652	my $source =	744	my $source =
653	"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"
654	. "#line 1 \"$path\"\n{\n"	746	. "#line 1 \"$path\"\n{\n"
655	. (do { local $/; <$fh> })	747	. (do { local $/; <$fh> })
656	. "\n};\n1";	748	. "\n};\n1";
657		749
658	eval $source	750	eval $source
…		…
667	# called by the rxvt core	759	# called by the rxvt core
668	sub invoke {	760	sub invoke {
669	local $TERM = shift;	761	local $TERM = shift;
670	my $htype = shift;	762	my $htype = shift;
671		763
672	if ($htype == 0) { # INIT	764	if ($htype == HOOK_INIT) {
673	my @dirs = $TERM->perl_libdirs;	765	$TERM->scan_extensions;
674		766
675	my %ext_arg;	767	my %ext_arg;
676		768
677	{	769	{
678	my @init = @TERM_INIT;	770	my @init = @TERM_INIT;
…		…
683	$TERM->register_package ($_) for @pkg;	775	$TERM->register_package ($_) for @pkg;
684	}	776	}
685		777
686	for (	778	for (
687	@{ delete $TERM->{perl_ext_3} },	779	@{ delete $TERM->{perl_ext_3} },
688	grep $_, map { split /,/, $TERM->resource ("perl_ext_$_") } 1, 2	780	(grep $_, map { split /,/, $TERM->resource ("perl_ext_$_") } 1, 2),
689	) {	781	) {
690	if ($_ eq "default") {	782	if ($_ eq "default") {
		783
		784	$ext_arg{$_} = []
691	$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
692	} elsif (/^-(.*)$/) {	796	} elsif (/^-(.*)$/) { # remove from set
693	delete $ext_arg{$1};	797	delete $ext_arg{$1};
694	} 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};
695	push @{ $ext_arg{$1} }, $2;	804	push @{ $ext_arg{$1} }, defined $2 ? $2 : ();
		805
696	} else {	806	} else {
697	$ext_arg{$_} \|\|= [];	807	verbose 2, "cannot parse extension specification '$_', ignoring.";
698	}	808	}
699	}	809	}
700		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
701	for my $ext (sort keys %ext_arg) {	814	for my $ext (sort keys %ext_arg) {
702	my @files = grep -f $_, map "$_/$ext", @dirs;	815	my $path = $TERM->extension_path ($ext);
703		816
704	if (@files) {	817	if (defined $path) {
705	$TERM->register_package (extension_package $files[0], $ext_arg{$ext});	818	$TERM->autoload_extension ($ext, $ext_arg{$ext});
706	} else {	819	} else {
707	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";
708	}	821	}
709	}	822	}
710		823
711	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");
712	warn $@ if $@;	825	warn $@ if $@;
713	}	826	}
714		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
715	$retval = undef;	838	$retval = undef;
716		839
717	if (my $cb = $TERM->{_hook}[$htype]) {	840	if (my $cb = $TERM->{_hook}[$htype]) {
718	verbose 10, "$HOOKNAME[$htype] (" . (join ", ", $TERM, @_) . ")"	841	verbose 10, "$HOOKNAME[$htype] (" . (join ", ", $TERM, @_) . ")"
719	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	}
720		856
721	for my $pkg (keys %$cb) {	857	for my $pkg (keys %$cb) {
722	my $retval_ = eval { $cb->{$pkg}->($TERM->{_pkg}{$pkg} \|\| $TERM, @_) };	858	my $retval_ = eval { $cb->{$pkg}->($TERM->{_pkg}{$pkg} \|\| $TERM, @_) };
723	$retval \|\|= $retval_;	859	$retval \|\|= $retval_;
724		860
…		…
730		866
731	verbose 11, "$HOOKNAME[$htype] returning <$retval>"	867	verbose 11, "$HOOKNAME[$htype] returning <$retval>"
732	if $verbosity >= 11;	868	if $verbosity >= 11;
733	}	869	}
734		870
735	if ($htype == 1) { # DESTROY	871	if ($htype == HOOK_DESTROY) {
736	# clear package objects	872	# clear package objects
737	%$_ = () for values %{ $TERM->{_pkg} };	873	%$_ = () for values %{ $TERM->{_pkg} };
738		874
739	# clear package	875	# clear package
740	%$TERM = ();	876	%$TERM = ();
…		…
784		920
785	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
786	objects, in addition to call methods documented for the <urxvt::term>	922	objects, in addition to call methods documented for the <urxvt::term>
787	class.	923	class.
788		924
789	=over 4	925	=over
790		926
791	=item $urxvt_term = $self->{term}	927	=item $urxvt_term = $self->{term}
792		928
793	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
794	extension. This member I<must not> be changed in any way.	930	extension. This member I<must not> be changed in any way.
…		…
827	}	963	}
828		964
829	=item $self->enable ($hook_name => $cb[, $hook_name => $cb..])	965	=item $self->enable ($hook_name => $cb[, $hook_name => $cb..])
830		966
831	Dynamically enable the given hooks (named without the C<on_> prefix) for	967	Dynamically enable the given hooks (named without the C<on_> prefix) for
832	this extension, replacing any previous hook. This is useful when you want	968	this extension, replacing any hook previously installed via C<enable> in
833	to overwrite time-critical hooks only temporarily.	969	this extension.
		970
		971	This is useful when you want to overwrite time-critical hooks only
		972	temporarily.
834		973
835	To install additional callbacks for the same hook, you can use the C<on>	974	To install additional callbacks for the same hook, you can use the C<on>
836	method of the C<urxvt::term> class.	975	method of the C<urxvt::term> class.
837		976
838	=item $self->disable ($hook_name[, $hook_name..])	977	=item $self->disable ($hook_name[, $hook_name..])
…		…
881	=cut	1020	=cut
882		1021
883	sub urxvt::extension::on_disable::DESTROY {	1022	sub urxvt::extension::on_disable::DESTROY {
884	my $disable = shift;	1023	my $disable = shift;
885		1024
886	my $self = delete $disable->{""};	1025	my $term = delete $disable->{""};
887		1026
888	while (my ($htype, $id) = each %$disable) {	1027	while (my ($htype, $id) = each %$disable) {
889	delete $self->{_hook}[$htype]{$id};	1028	delete $term->{_hook}[$htype]{$id};
890	$self->set_should_invoke ($htype, -1);	1029	$term->set_should_invoke ($htype, -1);
891	}	1030	}
892	}	1031	}
893		1032
894	sub on {	1033	sub on {
895	my ($self, %hook) = @_;	1034	my ($self, %hook) = @_;
896		1035
		1036	my $term = $self->{term};
		1037
897	my %disable = ( "" => $self );	1038	my %disable = ( "" => $term );
898		1039
899	while (my ($name, $cb) = each %hook) {	1040	while (my ($name, $cb) = each %hook) {
900	my $htype = $HOOKTYPE{uc $name};	1041	my $htype = $HOOKTYPE{uc $name};
901	defined $htype	1042	defined $htype
902	or Carp::croak "unsupported hook type '$name'";	1043	or Carp::croak "unsupported hook type '$name'";
903		1044
904	my $id = $cb+0;
905
906	$self->set_should_invoke ($htype, +1);	1045	$term->set_should_invoke ($htype, +1);
907	$disable{$htype} = $id;	1046	$term->{_hook}[$htype]{ $disable{$htype} = $cb+0 }
908	$self->{_hook}[$htype]{$id} = sub { shift; $cb->($self, @_) }; # very ugly indeed	1047	= sub { shift; $cb->($self, @_) }; # very ugly indeed
909	}	1048	}
910		1049
911	bless \%disable, "urxvt::extension::on_disable"	1050	bless \%disable, "urxvt::extension::on_disable"
912	}	1051	}
913		1052
		1053	=item $self->bind_action ($hotkey, $action)
		1054
914	=item $self->x_resource ($pattern)	1055	=item $self->x_resource ($pattern)
915		1056
916	=item $self->x_resource_boolean ($pattern)	1057	=item $self->x_resource_boolean ($pattern)
917		1058
918	These methods support an additional C<%> prefix when called on an	1059	These methods support an additional C<%> prefix for C<$action> or
919	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
920	C<urxvt::term> class for details.	1062	methods in the C<urxvt::term> class for details.
921		1063
922	=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	}
923		1071
924	sub x_resource {	1072	sub x_resource {
925	my ($self, $name) = @_;	1073	my ($self, $name) = @_;
926	$name =~ s/^%(\.\|$)/$_[0]{_name}$1/;	1074	$name =~ s/^%(\.\|$)/$_[0]{_name}$1/;
927	$self->{term}->x_resource ($name)	1075	$self->{term}->x_resource ($name)
…		…
1023		1171
1024	package urxvt::term;	1172	package urxvt::term;
1025		1173
1026	=head2 The C<urxvt::term> Class	1174	=head2 The C<urxvt::term> Class
1027		1175
1028	=over 4	1176	=over
1029		1177
1030	=cut	1178	=cut
1031		1179
1032	# find on_xxx subs in the package and register them	1180	# find on_xxx subs in the package and register them
1033	# as hooks	1181	# as hooks
…		…
1054	$proxy->enable ($name => $ref);	1202	$proxy->enable ($name => $ref);
1055	}	1203	}
1056	}	1204	}
1057	}	1205	}
1058		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
1059	sub perl_libdirs {	1231	sub perl_libdirs {
1060	map { split /:/ }	1232	map { split /:/ }
1061	$_[0]->resource ("perl_lib"),	1233	$_[0]->resource ("perl_lib"),
1062	$ENV{URXVT_PERL_LIB},	1234	$ENV{URXVT_PERL_LIB},
1063	"$ENV{HOME}/.urxvt/ext",	1235	"$ENV{HOME}/.urxvt/ext",
1064	"$LIBDIR/perl"	1236	"$LIBDIR/perl"
1065	}	1237	}
1066		1238
1067	sub scan_meta {	1239	# scan for available extensions and collect their metadata
		1240	sub scan_extensions {
1068	my ($self) = @_;	1241	my ($self) = @_;
		1242
		1243	return if exists $self->{meta};
		1244
1069	my @libdirs = perl_libdirs $self;	1245	my @urxvtdirs = perl_libdirs $self;
		1246	# my @cpandirs = grep -d, map "$_/URxvt/Ext", @INC;
1070		1247
1071	return if $self->{meta_libdirs} eq join "\x00", @libdirs;
1072
1073	my %meta;
1074
1075	$self->{meta_libdirs} = join "\x00", @libdirs;
1076	$self->{meta} = \%meta;	1248	$self->{meta} = \my %allmeta;
1077		1249
1078	for my $dir (reverse @libdirs) {	1250	# first gather extensions
		1251
		1252	my $gather = sub {
		1253	my ($dir, $core) = @_;
		1254
1079	opendir my $fh, $dir	1255	opendir my $fh, $dir
1080	or next;	1256	or return;
		1257
1081	for my $ext (readdir $fh) {	1258	for my $ext (readdir $fh) {
1082	$ext ne "."	1259	$ext !~ /^\./
1083	and $ext ne ".."
1084	and open my $fh, "<", "$dir/$ext"
1085	or next;	1260	or next;
1086		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
1087	while (<$fh>) {	1273	while (<$fh>) {
1088	if (/^#:META:X_RESOURCE:(.*)/) {	1274	if (/^#:META:(?:X_)?RESOURCE:(.*)/) {
1089	my ($pattern, $type, $desc) = split /:/, $1;	1275	my ($pattern, $type, $desc) = split /:/, $1;
1090	$pattern =~ s/^%(\.\|$)/$ext$1/g; # % in pattern == extension name	1276	$pattern =~ s/^%(\.\|$)/$ext$1/g; # % in pattern == extension name
1091	if ($pattern =~ /[^a-zA-Z0-9\-\.]/) {	1277	if ($pattern =~ /[^a-zA-Z0-9\-\.]/) {
1092	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";
1093	} else {	1279	} else {
1094	$meta{resource}{$pattern} = [$ext, $type, $desc];	1280	$meta{resource}{$pattern} = [$ext, $type, $desc];
1095	}	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
1096	} elsif (/^\s*(?:#\|$)/) {	1289	} elsif (/^\s*(?:#\|$)/) {
1097	# skip other comments and empty lines	1290	# skip other comments and empty lines
		1291
1098	} else {	1292	} else {
1099	last; # stop parsing on first non-empty non-comment line	1293	last; # stop parsing on first non-empty non-comment line
1100	}	1294	}
1101	}	1295	}
		1296
		1297	$allmeta{ext}{$ext} = \%meta;
1102	}	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} });
1103	}	1311	}
1104	}	1312	}
1105		1313
1106	=item $term = new urxvt::term $envhashref, $rxvtname, [arg...]	1314	=item $term = new urxvt::term $envhashref, $rxvtname, [arg...]
1107		1315
…		…
1127	}	1335	}
1128		1336
1129	=item $term->destroy	1337	=item $term->destroy
1130		1338
1131	Destroy the terminal object (close the window, free resources	1339	Destroy the terminal object (close the window, free resources
1132	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
1133	watchers (timers, io watchers) are still active.	1341	watchers (timers, io watchers) are still active.
1134		1342
1135	=item $term->exec_async ($cmd[, @args])	1343	=item $term->exec_async ($cmd[, @args])
1136		1344
1137	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
…		…
1170	insecure intensityStyles iso14755 iso14755_52 jumpScroll loginShell	1378	insecure intensityStyles iso14755 iso14755_52 jumpScroll loginShell
1171	mapAlert meta8 mouseWheelScrollPage override_redirect pastableTabs	1379	mapAlert meta8 mouseWheelScrollPage override_redirect pastableTabs
1172	pointerBlank reverseVideo scrollBar scrollBar_floating scrollBar_right	1380	pointerBlank reverseVideo scrollBar scrollBar_floating scrollBar_right
1173	scrollTtyKeypress scrollTtyOutput scrollWithBuffer secondaryScreen	1381	scrollTtyKeypress scrollTtyOutput scrollWithBuffer secondaryScreen
1174	secondaryScroll skipBuiltinGlyphs skipScroll transparent tripleclickwords	1382	secondaryScroll skipBuiltinGlyphs skipScroll transparent tripleclickwords
1175	urgentOnBell utmpInhibit visualBell	1383	urgentOnBell utmpInhibit visualBell disablePasteBrackets
1176		1384
1177	=item $value = $term->resource ($name[, $newval])	1385	=item $value = $term->resource ($name[, $newval])
1178		1386
1179	Returns the current resource value associated with a given name and	1387	Returns the current resource value associated with a given name and
1180	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>
…		…
1206	preeditType print_pipe pty_fd reverseVideo saveLines scrollBar	1414	preeditType print_pipe pty_fd reverseVideo saveLines scrollBar
1207	scrollBar_align scrollBar_floating scrollBar_right scrollBar_thickness	1415	scrollBar_align scrollBar_floating scrollBar_right scrollBar_thickness
1208	scrollTtyKeypress scrollTtyOutput scrollWithBuffer scrollstyle	1416	scrollTtyKeypress scrollTtyOutput scrollWithBuffer scrollstyle
1209	secondaryScreen secondaryScroll shade skipBuiltinGlyphs skipScroll	1417	secondaryScreen secondaryScroll shade skipBuiltinGlyphs skipScroll
1210	term_name title transient_for transparent tripleclickwords urgentOnBell	1418	term_name title transient_for transparent tripleclickwords urgentOnBell
1211	utmpInhibit visualBell	1419	utmpInhibit visualBell rewrapMode disablePasteBrackets
1212		1420
1213	=cut	1421	=cut
1214		1422
1215	sub resource($$;$) {	1423	sub resource($$;$) {
1216	my ($self, $name) = (shift, shift);	1424	my ($self, $name) = (shift, shift);
…		…
1223	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
1224	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
1225	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
1226	resource with that pattern exists.	1434	resource with that pattern exists.
1227		1435
1228	Extensions that define extra resource or command line arguments also need	1436	Extensions that define extra resources also need to call this method
1229	to call this method to access their values.	1437	to access their values.
1230		1438
1231	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
1232	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
1233	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
1234	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
1235	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
1236	without having to change the actual code.	1444	the actual code.
1237		1445
1238	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
1239	only one resource database per display, and later invocations might return	1447	only one resource database per display, and later invocations might return
1240	the wrong resources.	1448	the wrong resources.
1241		1449
…		…
1253	my $res = &x_resource;	1461	my $res = &x_resource;
1254		1462
1255	$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
1256	}	1464	}
1257		1465
1258	=item $success = $term->parse_keysym ($key, $octets)	1466	=item $action = $term->lookup_keysym ($keysym, $state)
1259		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
1260	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
1261	C<keysym> resource in the @@RXVT_NAME@@(1) manpage.	1474	C<keysym> resource in the urxvt(1) manpage.
1262		1475
1263	=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.
1264		1480
1265	Adds a key binding. This is a lower level api compared to	1481	Example: the C<searchable-scrollback> by default binds itself
1266	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<<
1267	used only inside either the C<on_init> hook, to add a binding, or the	1483	$term->bind_action >>.
1268	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	}
1269		1490
1270	=item $rend = $term->rstyle ([$new_rstyle])	1491	=item $rend = $term->rstyle ([$new_rstyle])
1271		1492
1272	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
1273	the terminal application will use this style.	1494	the terminal application will use this style.
…		…
1350	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
1351	as long as the perl object is referenced.	1572	as long as the perl object is referenced.
1352		1573
1353	The methods currently supported on C<urxvt::overlay> objects are:	1574	The methods currently supported on C<urxvt::overlay> objects are:
1354		1575
1355	=over 4	1576	=over
1356		1577
1357	=item $overlay->set ($x, $y, $text[, $rend])	1578	=item $overlay->set ($x, $y, $text[, $rend])
1358		1579
1359	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
1360	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
…		…
1404	Returns the number of screen-cells this string would need. Correctly	1625	Returns the number of screen-cells this string would need. Correctly
1405	accounts for wide and combining characters.	1626	accounts for wide and combining characters.
1406		1627
1407	=item $octets = $term->locale_encode ($string)	1628	=item $octets = $term->locale_encode ($string)
1408		1629
1409	Convert the given text string into the corresponding locale encoding.	1630	Convert the given text string into the corresponding locale
		1631	encoding. Returns C<undef> if C<$string> is C<undef>.
1410		1632
1411	=item $string = $term->locale_decode ($octets)	1633	=item $string = $term->locale_decode ($octets)
1412		1634
1413	Convert the given locale-encoded octets into a perl string.	1635	Convert the given locale-encoded octets into a perl string. Returns
		1636	C<undef> if C<$octets> is C<undef>.
1414		1637
1415	=item $term->scr_xor_span ($beg_row, $beg_col, $end_row, $end_col[, $rstyle])	1638	=item $term->scr_xor_span ($beg_row, $beg_col, $end_row, $end_col[, $rstyle])
1416		1639
1417	XORs the rendition values in the given span with the provided value	1640	XORs the rendition values in the given span with the provided value
1418	(default: C<RS_RVid>), which I<MUST NOT> contain font styles. Useful in	1641	(default: C<RS_RVid>), which I<MUST NOT> contain font styles. Useful in
…		…
1431		1654
1432	=item $term->scr_add_lines ($string)	1655	=item $term->scr_add_lines ($string)
1433		1656
1434	Write the given text string to the screen, as if output by the application	1657	Write the given text string to the screen, as if output by the application
1435	running inside the terminal. It may not contain command sequences (escape	1658	running inside the terminal. It may not contain command sequences (escape
1436	codes), but is free to use line feeds, carriage returns and tabs. The	1659	codes - see C<cmd_parse> for that), but is free to use line feeds,
1437	string is a normal text string, not in locale-dependent encoding.	1660	carriage returns and tabs. The string is a normal text string, not in
		1661	locale-dependent encoding.
1438		1662
1439	Normally its not a good idea to use this function, as programs might be	1663	Normally its not a good idea to use this function, as programs might be
1440	confused by changes in cursor position or scrolling. Its useful inside a	1664	confused by changes in cursor position or scrolling. Its useful inside a
1441	C<on_add_lines> hook, though.	1665	C<on_add_lines> hook, though.
1442		1666
…		…
1450	locale-specific encoding of the terminal and can contain command sequences	1674	locale-specific encoding of the terminal and can contain command sequences
1451	(escape codes) that will be interpreted.	1675	(escape codes) that will be interpreted.
1452		1676
1453	=item $term->tt_write ($octets)	1677	=item $term->tt_write ($octets)
1454		1678
1455	Write the octets given in C<$octets> to the tty (i.e. as program input). To	1679	Write the octets given in C<$octets> to the tty (i.e. as user input
		1680	to the program, see C<cmd_parse> for the opposite direction). To pass
1456	pass characters instead of octets, you should convert your strings first	1681	characters instead of octets, you should convert your strings first to the
1457	to the locale-specific encoding using C<< $term->locale_encode >>.	1682	locale-specific encoding using C<< $term->locale_encode >>.
		1683
		1684	=item $term->tt_write_user_input ($octets)
		1685
		1686	Like C<tt_write>, but should be used when writing strings in response to
		1687	the user pressing a key, to invoke the additional actions requested by
		1688	the user for that case (C<tt_write> doesn't do that).
		1689
		1690	The typical use case would be inside C<on_action> hooks.
1458		1691
1459	=item $term->tt_paste ($octets)	1692	=item $term->tt_paste ($octets)
1460		1693
1461	Write the octets given in C<$octets> to the tty as a paste, converting NL to	1694	Write the octets given in C<$octets> to the tty as a paste, converting NL to
1462	CR and bracketing the data with control sequences if bracketed paste mode	1695	CR and bracketing the data with control sequences if bracketed paste mode
…		…
1501		1734
1502	=item $term->key_release ($state, $keycode[, $time])	1735	=item $term->key_release ($state, $keycode[, $time])
1503		1736
1504	Deliver various fake events to to terminal.	1737	Deliver various fake events to to terminal.
1505		1738
1506	=item $window_width = $term->width	1739	=item $window_width = $term->width ([$new_value])
1507		1740
1508	=item $window_height = $term->height	1741	=item $window_height = $term->height ([$new_value])
1509		1742
1510	=item $font_width = $term->fwidth	1743	=item $font_width = $term->fwidth ([$new_value])
1511		1744
1512	=item $font_height = $term->fheight	1745	=item $font_height = $term->fheight ([$new_value])
1513		1746
1514	=item $font_ascent = $term->fbase	1747	=item $font_ascent = $term->fbase ([$new_value])
1515		1748
1516	=item $terminal_rows = $term->nrow	1749	=item $terminal_rows = $term->nrow ([$new_value])
1517		1750
1518	=item $terminal_columns = $term->ncol	1751	=item $terminal_columns = $term->ncol ([$new_value])
1519		1752
1520	=item $has_focus = $term->focus	1753	=item $has_focus = $term->focus ([$new_value])
1521		1754
1522	=item $is_mapped = $term->mapped	1755	=item $is_mapped = $term->mapped ([$new_value])
1523		1756
1524	=item $max_scrollback = $term->saveLines	1757	=item $max_scrollback = $term->saveLines ([$new_value])
1525		1758
1526	=item $nrow_plus_saveLines = $term->total_rows	1759	=item $nrow_plus_saveLines = $term->total_rows ([$new_value])
1527		1760
1528	=item $topmost_scrollback_row = $term->top_row	1761	=item $topmost_scrollback_row = $term->top_row ([$new_value])
1529		1762
1530	Return various integers describing terminal characteristics.	1763	Return various integers describing terminal characteristics. If an
		1764	argument is given, changes the value and returns the previous one.
1531		1765
1532	=item $x_display = $term->display_id	1766	=item $x_display = $term->display_id
1533		1767
1534	Return the DISPLAY used by rxvt-unicode.	1768	Return the DISPLAY used by rxvt-unicode.
1535		1769
…		…
1572		1806
1573	=item $cursor_is_hidden = $term->hidden_cursor	1807	=item $cursor_is_hidden = $term->hidden_cursor
1574		1808
1575	Returns whether the cursor is currently hidden or not.	1809	Returns whether the cursor is currently hidden or not.
1576		1810
		1811	=item $priv_modes = $term->priv_modes
		1812
		1813	Returns a bitset with the state of DEC private modes.
		1814
		1815	Example:
		1816
		1817	if ($term->priv_modes & urxvt::PrivMode_mouse_report) {
		1818	# mouse reporting is turned on
		1819	}
		1820
1577	=item $view_start = $term->view_start ([$newvalue])	1821	=item $view_start = $term->view_start ([$newvalue])
1578		1822
1579	Returns the row number of the topmost displayed line. Maximum value is	1823	Returns the row number of the topmost displayed line and changes it,
1580	C<0>, which displays the normal terminal contents. Lower values scroll	1824	if an argument is given. Values greater than or equal to C<0> display
1581	this many lines into the scrollback buffer.	1825	the terminal contents. Lower values scroll this many lines into the
		1826	scrollback buffer.
1582		1827
1583	=item $term->want_refresh	1828	=item $term->want_refresh
1584		1829
1585	Requests a screen refresh. At the next opportunity, rxvt-unicode will	1830	Requests a screen refresh. At the next opportunity, rxvt-unicode will
1586	compare the on-screen display with its stored representation. If they	1831	compare the on-screen display with its stored representation. If they
1587	differ, it redraws the differences.	1832	differ, it redraws the differences.
1588		1833
1589	Used after changing terminal contents to display them.	1834	Used after changing terminal contents to display them.
		1835
		1836	=item $term->refresh_check
		1837
		1838	Checks if a refresh has been requested and, if so, schedules one.
1590		1839
1591	=item $text = $term->ROW_t ($row_number[, $new_text[, $start_col]])	1840	=item $text = $term->ROW_t ($row_number[, $new_text[, $start_col]])
1592		1841
1593	Returns the text of the entire row with number C<$row_number>. Row C<< $term->top_row >>	1842	Returns the text of the entire row with number C<$row_number>. Row C<< $term->top_row >>
1594	is the topmost terminal line, row C<< $term->nrow-1 >> is the bottommost	1843	is the topmost terminal line, row C<< $term->nrow-1 >> is the bottommost
…		…
1640		1889
1641	Create and return a new C<urxvt::line> object that stores information	1890	Create and return a new C<urxvt::line> object that stores information
1642	about the logical line that row C<$row_number> is part of. It supports the	1891	about the logical line that row C<$row_number> is part of. It supports the
1643	following methods:	1892	following methods:
1644		1893
1645	=over 4	1894	=over
1646		1895
1647	=item $text = $line->t ([$new_text])	1896	=item $text = $line->t ([$new_text])
1648		1897
1649	Returns or replaces the full text of the line, similar to C<ROW_t>	1898	Returns or replaces the full text of the line, similar to C<ROW_t>
1650		1899
…		…
1696	}	1945	}
1697		1946
1698	sub urxvt::line::t {	1947	sub urxvt::line::t {
1699	my ($self) = @_;	1948	my ($self) = @_;
1700		1949
1701	if (@_ > 1)	1950	if (@_ > 1) {
1702	{
1703	$self->{term}->ROW_t ($_, $_[1], 0, ($_ - $self->{beg}) * $self->{ncol}, $self->{ncol})	1951	$self->{term}->ROW_t ($_, $_[1], 0, ($_ - $self->{beg}) * $self->{ncol}, $self->{ncol})
1704	for $self->{beg} .. $self->{end};	1952	for $self->{beg} .. $self->{end};
1705	}	1953	}
1706		1954
1707	defined wantarray &&	1955	defined wantarray &&
1708	substr +(join "", map $self->{term}->ROW_t ($_), $self->{beg} .. $self->{end}),	1956	substr +(join "", map $self->{term}->ROW_t ($_), $self->{beg} .. $self->{end}),
1709	0, $self->{len}	1957	0, $self->{len}
1710	}	1958	}
1711		1959
1712	sub urxvt::line::r {	1960	sub urxvt::line::r {
1713	my ($self) = @_;	1961	my ($self) = @_;
1714		1962
1715	if (@_ > 1)	1963	if (@_ > 1) {
1716	{
1717	$self->{term}->ROW_r ($_, $_[1], 0, ($_ - $self->{beg}) * $self->{ncol}, $self->{ncol})	1964	$self->{term}->ROW_r ($_, $_[1], 0, ($_ - $self->{beg}) * $self->{ncol}, $self->{ncol})
1718	for $self->{beg} .. $self->{end};	1965	for $self->{beg} .. $self->{end};
1719	}	1966	}
1720		1967
1721	if (defined wantarray) {	1968	if (defined wantarray) {
1722	my $rend = [	1969	my $rend = [
1723	map @{ $self->{term}->ROW_r ($_) }, $self->{beg} .. $self->{end}	1970	map @{ $self->{term}->ROW_r ($_) }, $self->{beg} .. $self->{end}
1724	];	1971	];
…		…
1756	where one character corresponds to one screen cell. See	2003	where one character corresponds to one screen cell. See
1757	C<< $term->ROW_t >> for details.	2004	C<< $term->ROW_t >> for details.
1758		2005
1759	=item $string = $term->special_decode $text	2006	=item $string = $term->special_decode $text
1760		2007
1761	Converts rxvt-unicodes text representation into a perl string. See	2008	Converts rxvt-unicode's text representation into a perl string. See
1762	C<< $term->ROW_t >> for details.	2009	C<< $term->ROW_t >> for details.
1763		2010
1764	=item $success = $term->grab_button ($button, $modifiermask[, $window = $term->vt])	2011	=item $success = $term->grab_button ($button, $modifiermask[, $window = $term->vt])
1765		2012
1766	=item $term->ungrab_button ($button, $modifiermask[, $window = $term->vt])	2013	=item $term->ungrab_button ($button, $modifiermask[, $window = $term->vt])
…		…
1832		2079
1833	package urxvt::popup;	2080	package urxvt::popup;
1834		2081
1835	=head2 The C<urxvt::popup> Class	2082	=head2 The C<urxvt::popup> Class
1836		2083
1837	=over 4	2084	=over
1838		2085
1839	=cut	2086	=cut
1840		2087
1841	sub add_item {	2088	sub add_item {
1842	my ($self, $item) = @_;	2089	my ($self, $item) = @_;
…		…
1978	->cb (sub {	2225	->cb (sub {
1979	$term->{overlay}->set (0, 0,	2226	$term->{overlay}->set (0, 0,
1980	sprintf "%2d:%02d:%02d", (localtime urxvt::NOW)[2,1,0]);	2227	sprintf "%2d:%02d:%02d", (localtime urxvt::NOW)[2,1,0]);
1981	});	2228	});
1982		2229
1983	=over 4	2230	=over
1984		2231
1985	=item $timer = new urxvt::timer	2232	=item $timer = new urxvt::timer
1986		2233
1987	Create a new timer object in started state. It is scheduled to fire	2234	Create a new timer object in started state. It is scheduled to fire
1988	immediately.	2235	immediately.
…		…
2037	sysread $term->{socket}, my $buf, 8192	2284	sysread $term->{socket}, my $buf, 8192
2038	or end-of-file;	2285	or end-of-file;
2039	});	2286	});
2040		2287
2041		2288
2042	=over 4	2289	=over
2043		2290
2044	=item $iow = new urxvt::iow	2291	=item $iow = new urxvt::iow
2045		2292
2046	Create a new io watcher object in stopped state.	2293	Create a new io watcher object in stopped state.
2047		2294
…		…
2074		2321
2075	This class implements idle watchers, that get called automatically when	2322	This class implements idle watchers, that get called automatically when
2076	the process is idle. They should return as fast as possible, after doing	2323	the process is idle. They should return as fast as possible, after doing
2077	some useful work.	2324	some useful work.
2078		2325
2079	=over 4	2326	=over
2080		2327
2081	=item $iw = new urxvt::iw	2328	=item $iw = new urxvt::iw
2082		2329
2083	Create a new idle watcher object in stopped state.	2330	Create a new idle watcher object in stopped state.
2084		2331
…		…
2109	->cb (sub {	2356	->cb (sub {
2110	my ($pw, $exit_status) = @_;	2357	my ($pw, $exit_status) = @_;
2111	...	2358	...
2112	});	2359	});
2113		2360
2114	=over 4	2361	=over
2115		2362
2116	=item $pw = new urxvt::pw	2363	=item $pw = new urxvt::pw
2117		2364
2118	Create a new process watcher in stopped state.	2365	Create a new process watcher in stopped state.
2119		2366
…		…
2136	=head2 URXVT_PERL_VERBOSITY	2383	=head2 URXVT_PERL_VERBOSITY
2137		2384
2138	This variable controls the verbosity level of the perl extension. Higher	2385	This variable controls the verbosity level of the perl extension. Higher
2139	numbers indicate more verbose output.	2386	numbers indicate more verbose output.
2140		2387
2141	=over 4	2388	=over
2142		2389
2143	=item == 0 - fatal messages	2390	=item == 0 - fatal messages only
		2391
		2392	=item >= 2 - general warnings (default level)
2144		2393
2145	=item >= 3 - script loading and management	2394	=item >= 3 - script loading and management
2146		2395
2147	=item >=10 - all called hooks	2396	=item >=10 - all called hooks
2148		2397

Diff Legend

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

Comparing rxvt-unicode/src/urxvt.pm (file contents): Revision 1.222 by root, Sat Jul 7 07:00:17 2012 UTC vs. Revision 1.269 by root, Sun Nov 21 15:15:02 2021 UTC

Diff Legend

Comparing rxvt-unicode/src/urxvt.pm (file contents):
Revision 1.222 by root, Sat Jul 7 07:00:17 2012 UTC vs.
Revision 1.269 by root, Sun Nov 21 15:15:02 2021 UTC