[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.271 by root, Fri Dec 9 05:06:46 2022 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
		201
		202	=item on_attach $term
		203
		204	Called when an extension package is attached to a running terminal
		205	instance. Must return true in all cases, and runs with the same
		206	limitations as C<on_init>.
		207
		208	Unlike C<on_init> or C<on_start>, this is called when the extension is
		209	attached to a terminal, regardless of whether the extension is loaded
		210	before or after the terminal is started. Extensions that need to do
		211	something before they work can do it in this callback, as opposed to e.g.
		212	C<on_init>, which might not be called.
126		213
127	=item on_init $term	214	=item on_init $term
128		215
129	Called after a new terminal object has been initialized, but before	216	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	217	windows are created or the command gets run. Most methods are unsafe to
…		…
212		299
213	C<on_osc_seq_perl> should be used for new behaviour.	300	C<on_osc_seq_perl> should be used for new behaviour.
214		301
215	=item on_osc_seq_perl $term, $args, $resp	302	=item on_osc_seq_perl $term, $args, $resp
216		303
217	Called whenever the B<ESC ] 777 ; string ST> command sequence (OSC =	304	Called whenever the B<ESC ] 777 ; prefix ; string ST> command sequence
218	operating system command) is processed. Cursor position and other state	305	(OSC = operating system command) is processed. Cursor position and other
219	information is up-to-date when this happens. For interoperability, the	306	state information is up-to-date when this happens. For interoperability,
220	string should start with the extension name (sans -osc) and a semicolon,	307	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	308	other suitable prefix, and a semicolon, to distinguish it from commands
222	enforced in the future.	309	for other extensions.
223		310
224	For example, C<overlay-osc> uses this:	311	For example, C<overlay-osc> uses this:
225		312
226	sub on_osc_seq_perl {	313	sub on_osc_seq_perl {
227	my ($self, $osc, $resp) = @_;	314	my ($self, $osc, $resp) = @_;
…		…
281		368
282	=item on_refresh_end $term	369	=item on_refresh_end $term
283		370
284	Called just after the screen gets redrawn. See C<on_refresh_begin>.	371	Called just after the screen gets redrawn. See C<on_refresh_begin>.
285		372
		373	=item on_action $term, $string
		374
		375	Called whenever an action is invoked for the corresponding extension
		376	(e.g. via a C<extension:string> builtin action bound to a key, see
		377	description of the B<keysym> resource in the urxvt(1) manpage). The
		378	event is simply the action string. Note that an action event is always
		379	associated to a single extension.
		380
286	=item on_user_command $term, $string	381	=item on_user_command $term, $string DEPRECATED
287		382
288	Called whenever a user-configured event is being activated (e.g. via	383	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>	384	a C<perl:string> action bound to a key, see description of the B<keysym>
290	resource in the @@RXVT_NAME@@(1) manpage).	385	resource in the urxvt(1) manpage).
291		386
292	The event is simply the action string. This interface is assumed to change	387	The event is simply the action string. This interface is going away in
293	slightly in the future.	388	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		389
302	=item on_resize_all_windows $term, $new_width, $new_height	390	=item on_resize_all_windows $term, $new_width, $new_height
303		391
304	Called just after the new window size has been calculated, but before	392	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	393	windows are actually being resized or hints are being set. If this hook
306	returns TRUE, setting of the window hints is being skipped.	394	returns a true value, setting of the window hints is being skipped.
307		395
308	=item on_x_event $term, $event	396	=item on_x_event $term, $event
309		397
310	Called on every X event received on the vt window (and possibly other	398	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	399	windows). Should only be used as a last resort. Most event structure
…		…
351	(real, not screen-based) row and column under the mouse cursor.	439	(real, not screen-based) row and column under the mouse cursor.
352		440
353	C<on_key_press> additionally receives the string rxvt-unicode would	441	C<on_key_press> additionally receives the string rxvt-unicode would
354	output, if any, in locale-specific encoding.	442	output, if any, in locale-specific encoding.
355		443
356	subwindow.
357
358	=item on_client_message $term, $event	444	=item on_client_message $term, $event
359		445
360	=item on_wm_protocols $term, $event	446	=item on_wm_protocols $term, $event
361		447
362	=item on_wm_delete_window $term, $event	448	=item on_wm_delete_window $term, $event
…		…
373	=cut	459	=cut
374		460
375	package urxvt;	461	package urxvt;
376		462
377	use utf8;	463	use utf8;
378	use strict 'vars';	464	use strict qw(vars subs);
379	use Carp ();	465	use Carp ();
380	use Scalar::Util ();	466	use Scalar::Util ();
381	use List::Util ();	467	use List::Util ();
382		468
383	our $VERSION = 1;	469	our $VERSION = 1;
…		…
395		481
396	our $NOCHAR = chr 0xffff;	482	our $NOCHAR = chr 0xffff;
397		483
398	=head2 Variables in the C<urxvt> Package	484	=head2 Variables in the C<urxvt> Package
399		485
400	=over 4	486	=over
401		487
402	=item $urxvt::LIBDIR	488	=item $urxvt::LIBDIR
403		489
404	The rxvt-unicode library directory, where, among other things, the perl	490	The rxvt-unicode library directory, where, among other things, the perl
405	modules and scripts are stored.	491	modules and scripts are stored.
…		…
435		521
436	=back	522	=back
437		523
438	=head2 Functions in the C<urxvt> Package	524	=head2 Functions in the C<urxvt> Package
439		525
440	=over 4	526	=over
441		527
442	=item urxvt::fatal $errormessage	528	=item urxvt::fatal $errormessage
443		529
444	Fatally aborts execution with the given error message (which should	530	Fatally aborts execution with the given error message (which should
445	include a trailing newline). Avoid at all costs! The only time this	531	include a trailing newline). Avoid at all costs! The only time this
…		…
490	CirculateRequest, PropertyNotify, SelectionClear, SelectionRequest,	576	CirculateRequest, PropertyNotify, SelectionClear, SelectionRequest,
491	SelectionNotify, ColormapNotify, ClientMessage, MappingNotify	577	SelectionNotify, ColormapNotify, ClientMessage, MappingNotify
492		578
493	Various constants for use in X calls and event processing.	579	Various constants for use in X calls and event processing.
494		580
		581	=item urxvt::PrivMode_132, PrivMode_132OK, PrivMode_rVideo, PrivMode_relOrigin,
		582	PrivMode_Screen, PrivMode_Autowrap, PrivMode_aplCUR, PrivMode_aplKP,
		583	PrivMode_HaveBackSpace, PrivMode_BackSpace, PrivMode_ShiftKeys,
		584	PrivMode_VisibleCursor, PrivMode_MouseX10, PrivMode_MouseX11,
		585	PrivMode_scrollBar, PrivMode_TtyOutputInh, PrivMode_Keypress,
		586	PrivMode_smoothScroll, PrivMode_vt52, PrivMode_LFNL, PrivMode_MouseBtnEvent,
		587	PrivMode_MouseAnyEvent, PrivMode_BracketPaste, PrivMode_ExtMouseUTF8,
		588	PrivMode_ExtMouseUrxvt, PrivMode_BlinkingCursor, PrivMode_mouse_report,
		589	PrivMode_Default
		590
		591	Constants for checking DEC private modes.
		592
495	=back	593	=back
496		594
497	=head2 RENDITION	595	=head2 RENDITION
498		596
499	Rendition bitsets contain information about colour, font, font styles and	597	Rendition bitsets contain information about colour, font, font styles and
…		…
502	The following "macros" deal with changes in rendition sets. You should	600	The following "macros" deal with changes in rendition sets. You should
503	never just create a bitset, you should always modify an existing one,	601	never just create a bitset, you should always modify an existing one,
504	as they contain important information required for correct operation of	602	as they contain important information required for correct operation of
505	rxvt-unicode.	603	rxvt-unicode.
506		604
507	=over 4	605	=over
508		606
509	=item $rend = urxvt::DEFAULT_RSTYLE	607	=item $rend = urxvt::DEFAULT_RSTYLE
510		608
511	Returns the default rendition, as used when the terminal is starting up or	609	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.	610	being reset. Useful as a base to start when creating renditions.
…		…
564	no warnings 'utf8';	662	no warnings 'utf8';
565		663
566	sub parse_resource {	664	sub parse_resource {
567	my ($term, $name, $isarg, $longopt, $flag, $value) = @_;	665	my ($term, $name, $isarg, $longopt, $flag, $value) = @_;
568		666
569	$name =~ y/-/./ if $isarg;
570
571	$term->scan_meta;	667	$term->scan_extensions;
572		668
		669	# iterating over all resources has quadratic time overhead
		670	# overall, maybe this could be optimised?
573	my $r = $term->{meta}{resource};	671	my $r = $term->{meta}{resource};
574	keys %$r; # reste iterator	672	keys %$r; # reset iterator
575	while (my ($pattern, $v) = each %$r) {	673	while (my ($k, $v) = each %$r) {
576	if (	674	my $pattern = $k;
		675	$pattern =~ y/./-/ if $isarg;
		676	my $prefix = $name;
		677	my $suffix;
577	$pattern =~ /\.$/	678	if ($pattern =~ /\-$/) {
578	? $pattern eq substr $name, 0, length $pattern	679	$prefix = substr $name, 0, length $pattern;
579	: $pattern eq $name	680	$suffix = substr $name, length $pattern;
580	) {	681	}
		682	if ($pattern eq $prefix) {
581	$name = "$urxvt::RESCLASS.$name";	683	$name = "$urxvt::RESCLASS.$k$suffix";
582		684
583	push @{ $term->{perl_ext_3} }, $v->[0];	685	push @{ $term->{perl_ext_3} }, $v->[0];
		686
		687	return 1 unless $isarg;
584		688
585	if ($v->[1] eq "boolean") {	689	if ($v->[1] eq "boolean") {
586	$term->put_option_db ($name, $flag ? "true" : "false");	690	$term->put_option_db ($name, $flag ? "true" : "false");
587	return 1;	691	return 1;
588	} else {	692	} else {
…		…
596	}	700	}
597		701
598	sub usage {	702	sub usage {
599	my ($term, $usage_type) = @_;	703	my ($term, $usage_type) = @_;
600		704
601	$term->scan_meta;	705	$term->scan_extensions;
602		706
603	my $r = $term->{meta}{resource};	707	my $r = $term->{meta}{resource};
604		708
605	for my $pattern (sort keys %$r) {	709	for my $pattern (sort keys %$r) {
606	my ($ext, $type, $desc) = @{ $r->{$pattern} };	710	my ($ext, $type, $desc) = @{ $r->{$pattern} };
…		…
621	urxvt::log sprintf " %-31s %s\n", "$pattern:", $type;	725	urxvt::log sprintf " %-31s %s\n", "$pattern:", $type;
622	}	726	}
623	}	727	}
624	}	728	}
625		729
626	my $verbosity = $ENV{URXVT_PERL_VERBOSITY};	730	my $verbosity = $ENV{URXVT_PERL_VERBOSITY} // 2;
627		731
628	sub verbose {	732	sub verbose {
629	my ($level, $msg) = @_;	733	my ($level, $msg) = @_;
630	warn "$msg\n" if $level <= $verbosity;	734	warn "$msg\n" if $level <= $verbosity;
631	}	735	}
…		…
648		752
649	open my $fh, "<:raw", $path	753	open my $fh, "<:raw", $path
650	or die "$path: $!";	754	or die "$path: $!";
651		755
652	my $source =	756	my $source =
653	"package $pkg; use strict 'vars'; use utf8; no warnings 'utf8';\n"	757	"package $pkg; use strict qw(vars subs); use utf8; no warnings 'utf8';\n"
654	. "#line 1 \"$path\"\n{\n"	758	. "#line 1 \"$path\"\n{\n"
655	. (do { local $/; <$fh> })	759	. (do { local $/; <$fh> })
656	. "\n};\n1";	760	. "\n};\n1";
657		761
658	eval $source	762	eval $source
…		…
667	# called by the rxvt core	771	# called by the rxvt core
668	sub invoke {	772	sub invoke {
669	local $TERM = shift;	773	local $TERM = shift;
670	my $htype = shift;	774	my $htype = shift;
671		775
672	if ($htype == 0) { # INIT	776	if ($htype == HOOK_INIT) {
673	my @dirs = $TERM->perl_libdirs;	777	$TERM->scan_extensions;
674		778
675	my %ext_arg;	779	my %ext_arg;
676		780
677	{	781	{
678	my @init = @TERM_INIT;	782	my @init = @TERM_INIT;
…		…
683	$TERM->register_package ($_) for @pkg;	787	$TERM->register_package ($_) for @pkg;
684	}	788	}
685		789
686	for (	790	for (
687	@{ delete $TERM->{perl_ext_3} },	791	@{ delete $TERM->{perl_ext_3} },
688	grep $_, map { split /,/, $TERM->resource ("perl_ext_$_") } 1, 2	792	(grep $_, map { split /,/, $TERM->resource ("perl_ext_$_") } 1, 2),
689	) {	793	) {
690	if ($_ eq "default") {	794	if ($_ eq "default") {
		795
		796	$ext_arg{$_} = []
691	$ext_arg{$_} \|\|= [] for qw(selection option-popup selection-popup searchable-scrollback readline);	797	for qw(selection option-popup selection-popup readline searchable-scrollback confirm-paste);
		798
		799	for ($TERM->_keysym_resources) {
		800	next if /^(?:string\|command\|builtin\|builtin-string\|perl)/;
		801	next unless /^([A-Za-z0-9_\-]+):/;
		802
		803	my $ext = $1;
		804
		805	$ext_arg{$ext} = [];
		806	}
		807
692	} elsif (/^-(.*)$/) {	808	} elsif (/^-(.*)$/) { # remove from set
693	delete $ext_arg{$1};	809	delete $ext_arg{$1};
694	} elsif (/^([^<]+)<(.*)>$/) {	810
		811	} elsif (/^\/(.*)$/) { # prohibit loading
		812	undef $TERM->{ext_prohibit}{$1};
		813
		814	} elsif (/^([^<]+)(?:<(.*)>)?$/) { # add to set, clear prohibit status
		815	delete $TERM->{ext_prohibit}{$1};
695	push @{ $ext_arg{$1} }, $2;	816	push @{ $ext_arg{$1} }, defined $2 ? $2 : ();
		817
696	} else {	818	} else {
697	$ext_arg{$_} \|\|= [];	819	verbose 2, "cannot parse extension specification '$_', ignoring.";
698	}	820	}
699	}	821	}
700		822
		823	$TERM->set_should_invoke (HOOK_OSC_SEQ , +1) if $TERM->{meta}{autoload_osc};
		824	$TERM->set_should_invoke (HOOK_OSC_SEQ_PERL, +1) if $TERM->{meta}{autoload_osc_perl};
		825
701	for my $ext (sort keys %ext_arg) {	826	for my $ext (sort keys %ext_arg) {
702	my @files = grep -f $_, map "$_/$ext", @dirs;	827	my $path = $TERM->extension_path ($ext);
703		828
704	if (@files) {	829	if (defined $path) {
705	$TERM->register_package (extension_package $files[0], $ext_arg{$ext});	830	$TERM->autoload_extension ($ext, $ext_arg{$ext});
706	} else {	831	} else {
707	warn "perl extension '$ext' not found in perl library search path\n";	832	verbose 2, "perl extension '$ext' not found in perl library search path";
708	}	833	}
709	}	834	}
710		835
711	eval "#line 1 \"--perl-eval resource/argument\"\n" . $TERM->resource ("perl_eval");	836	eval "#line 1 \"--perl-eval resource/argument\"\n" . $TERM->resource ("perl_eval");
712	warn $@ if $@;	837	warn $@ if $@;
713	}	838	}
714		839
		840	if ($htype == HOOK_OSC_SEQ) {
		841	if (my $exts = delete $TERM->{meta}{autoload_osc}{$_[0]}) {
		842	$TERM->autoload_extension ($_->[0]) for @$exts;
		843	}
		844	} elsif ($htype == HOOK_OSC_SEQ_PERL) {
		845	if ($_[0] =~ /^([^;]+)/ and (my $exts = delete $TERM->{meta}{autoload_osc_perl}{$1})) {
		846	$TERM->autoload_extension ($_->[0]) for @$exts;
		847	}
		848	}
		849
715	$retval = undef;	850	$retval = undef;
716		851
717	if (my $cb = $TERM->{_hook}[$htype]) {	852	if (my $cb = $TERM->{_hook}[$htype]) {
718	verbose 10, "$HOOKNAME[$htype] (" . (join ", ", $TERM, @_) . ")"	853	verbose 10, "$HOOKNAME[$htype] (" . (join ", ", $TERM, @_) . ")"
719	if $verbosity >= 10;	854	if $verbosity >= 10;
		855
		856	if ($htype == HOOK_ACTION) {
		857	# this hook is only sent to the extension with the name
		858	# matching the first arg
		859	my $pkg = shift;
		860	$pkg =~ y/-/_/;
		861	$pkg = "urxvt::ext::$pkg";
		862
		863	$cb = $cb->{$pkg}
		864	or return undef; #TODO: maybe warn user?
		865
		866	$cb = { $pkg => $cb };
		867	}
720		868
721	for my $pkg (keys %$cb) {	869	for my $pkg (keys %$cb) {
722	my $retval_ = eval { $cb->{$pkg}->($TERM->{_pkg}{$pkg} \|\| $TERM, @_) };	870	my $retval_ = eval { $cb->{$pkg}->($TERM->{_pkg}{$pkg} \|\| $TERM, @_) };
723	$retval \|\|= $retval_;	871	$retval \|\|= $retval_;
724		872
…		…
730		878
731	verbose 11, "$HOOKNAME[$htype] returning <$retval>"	879	verbose 11, "$HOOKNAME[$htype] returning <$retval>"
732	if $verbosity >= 11;	880	if $verbosity >= 11;
733	}	881	}
734		882
735	if ($htype == 1) { # DESTROY	883	if ($htype == HOOK_DESTROY) {
736	# clear package objects	884	# clear package objects
737	%$_ = () for values %{ $TERM->{_pkg} };	885	%$_ = () for values %{ $TERM->{_pkg} };
738		886
739	# clear package	887	# clear package
740	%$TERM = ();	888	%$TERM = ();
…		…
784		932
785	The methods (And data members) documented below can be called on extension	933	The methods (And data members) documented below can be called on extension
786	objects, in addition to call methods documented for the <urxvt::term>	934	objects, in addition to call methods documented for the <urxvt::term>
787	class.	935	class.
788		936
789	=over 4	937	=over
790		938
791	=item $urxvt_term = $self->{term}	939	=item $urxvt_term = $self->{term}
792		940
793	Returns the C<urxvt::term> object associated with this instance of the	941	Returns the C<urxvt::term> object associated with this instance of the
794	extension. This member I<must not> be changed in any way.	942	extension. This member I<must not> be changed in any way.
…		…
827	}	975	}
828		976
829	=item $self->enable ($hook_name => $cb[, $hook_name => $cb..])	977	=item $self->enable ($hook_name => $cb[, $hook_name => $cb..])
830		978
831	Dynamically enable the given hooks (named without the C<on_> prefix) for	979	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	980	this extension, replacing any hook previously installed via C<enable> in
833	to overwrite time-critical hooks only temporarily.	981	this extension.
		982
		983	This is useful when you want to overwrite time-critical hooks only
		984	temporarily.
834		985
835	To install additional callbacks for the same hook, you can use the C<on>	986	To install additional callbacks for the same hook, you can use the C<on>
836	method of the C<urxvt::term> class.	987	method of the C<urxvt::term> class.
837		988
838	=item $self->disable ($hook_name[, $hook_name..])	989	=item $self->disable ($hook_name[, $hook_name..])
…		…
881	=cut	1032	=cut
882		1033
883	sub urxvt::extension::on_disable::DESTROY {	1034	sub urxvt::extension::on_disable::DESTROY {
884	my $disable = shift;	1035	my $disable = shift;
885		1036
886	my $self = delete $disable->{""};	1037	my $term = delete $disable->{""};
887		1038
888	while (my ($htype, $id) = each %$disable) {	1039	while (my ($htype, $id) = each %$disable) {
889	delete $self->{_hook}[$htype]{$id};	1040	delete $term->{_hook}[$htype]{$id};
890	$self->set_should_invoke ($htype, -1);	1041	$term->set_should_invoke ($htype, -1);
891	}	1042	}
892	}	1043	}
893		1044
894	sub on {	1045	sub on {
895	my ($self, %hook) = @_;	1046	my ($self, %hook) = @_;
896		1047
		1048	my $term = $self->{term};
		1049
897	my %disable = ( "" => $self );	1050	my %disable = ( "" => $term );
898		1051
899	while (my ($name, $cb) = each %hook) {	1052	while (my ($name, $cb) = each %hook) {
900	my $htype = $HOOKTYPE{uc $name};	1053	my $htype = $HOOKTYPE{uc $name};
901	defined $htype	1054	defined $htype
902	or Carp::croak "unsupported hook type '$name'";	1055	or Carp::croak "unsupported hook type '$name'";
903		1056
904	my $id = $cb+0;
905
906	$self->set_should_invoke ($htype, +1);	1057	$term->set_should_invoke ($htype, +1);
907	$disable{$htype} = $id;	1058	$term->{_hook}[$htype]{ $disable{$htype} = $cb+0 }
908	$self->{_hook}[$htype]{$id} = sub { shift; $cb->($self, @_) }; # very ugly indeed	1059	= sub { shift; $cb->($self, @_) }; # very ugly indeed
909	}	1060	}
910		1061
911	bless \%disable, "urxvt::extension::on_disable"	1062	bless \%disable, "urxvt::extension::on_disable"
912	}	1063	}
913		1064
		1065	=item $self->bind_action ($hotkey, $action)
		1066
914	=item $self->x_resource ($pattern)	1067	=item $self->x_resource ($pattern)
915		1068
916	=item $self->x_resource_boolean ($pattern)	1069	=item $self->x_resource_boolean ($pattern)
917		1070
918	These methods support an additional C<%> prefix when called on an	1071	These methods support an additional C<%> prefix for C<$action> or
919	extension object - see the description of these methods in the	1072	C<$pattern> when called on an extension object, compared to the
		1073	C<urxvt::term> methods of the same name - see the description of these
920	C<urxvt::term> class for details.	1074	methods in the C<urxvt::term> class for details.
921		1075
922	=cut	1076	=cut
		1077
		1078	sub bind_action {
		1079	my ($self, $hotkey, $action) = @_;
		1080	$action =~ s/^%:/$_[0]{_name}:/;
		1081	$self->{term}->bind_action ($hotkey, $action)
		1082	}
923		1083
924	sub x_resource {	1084	sub x_resource {
925	my ($self, $name) = @_;	1085	my ($self, $name) = @_;
926	$name =~ s/^%(\.\|$)/$_[0]{_name}$1/;	1086	$name =~ s/^%(\.\|$)/$_[0]{_name}$1/;
927	$self->{term}->x_resource ($name)	1087	$self->{term}->x_resource ($name)
…		…
1023		1183
1024	package urxvt::term;	1184	package urxvt::term;
1025		1185
1026	=head2 The C<urxvt::term> Class	1186	=head2 The C<urxvt::term> Class
1027		1187
1028	=over 4	1188	=over
1029		1189
1030	=cut	1190	=cut
1031		1191
1032	# find on_xxx subs in the package and register them	1192	# find on_xxx subs in the package and register them
1033	# as hooks	1193	# as hooks
1034	sub register_package {	1194	sub register_package {
1035	my ($self, $pkg, $argv) = @_;	1195	my ($self, $pkg, $argv) = @_;
		1196
		1197	return if $self->{_pkg}{$pkg};
1036		1198
1037	no strict 'refs';	1199	no strict 'refs';
1038		1200
1039	urxvt::verbose 6, "register package $pkg to $self";	1201	urxvt::verbose 6, "register package $pkg to $self";
1040		1202
…		…
1052	for my $name (@HOOKNAME) {	1214	for my $name (@HOOKNAME) {
1053	if (my $ref = $pkg->can ("on_" . lc $name)) {	1215	if (my $ref = $pkg->can ("on_" . lc $name)) {
1054	$proxy->enable ($name => $ref);	1216	$proxy->enable ($name => $ref);
1055	}	1217	}
1056	}	1218	}
		1219
		1220	if (my $attach_hook = $pkg->can ("on_attach")) {
		1221	$attach_hook->($proxy)
		1222	or urxvt::verbose 1, "$pkg->on_attach returned false, extension failed to attach";
		1223	}
		1224	}
		1225
		1226	# map extension name to filesystem path
		1227	sub extension_path {
		1228	(grep -f $_, map "$_/$_[1]", $_[0]->perl_libdirs)[0]
		1229	}
		1230
		1231	# load an extension by name
		1232	sub load_extension_file {
		1233	my ($self, $path, $argv) = @_;
		1234
		1235	$self->register_package (urxvt::extension_package $path, $argv);
		1236	}
		1237
		1238	# autoload an extension unless loading it is prohibited
		1239	sub autoload_extension {
		1240	my ($self, $name, $argv) = @_;
		1241
		1242	return if exists $self->{ext_prohibit}{$name};
		1243
		1244	my $path = $self->extension_path ($name)
		1245	// return urxvt::verbose 2, "perl extension '$name' not found in perl library search path (during autoload)";
		1246
		1247	$self->load_extension_file ($path, $argv);
1057	}	1248	}
1058		1249
1059	sub perl_libdirs {	1250	sub perl_libdirs {
1060	map { split /:/ }	1251	map { split /:/ }
1061	$_[0]->resource ("perl_lib"),	1252	$_[0]->resource ("perl_lib"),
1062	$ENV{URXVT_PERL_LIB},	1253	$ENV{URXVT_PERL_LIB},
1063	"$ENV{HOME}/.urxvt/ext",	1254	"$ENV{HOME}/.urxvt/ext",
1064	"$LIBDIR/perl"	1255	"$LIBDIR/perl"
1065	}	1256	}
1066		1257
1067	sub scan_meta {	1258	# scan for available extensions and collect their metadata
		1259	sub scan_extensions {
1068	my ($self) = @_;	1260	my ($self) = @_;
		1261
		1262	return if exists $self->{meta};
		1263
1069	my @libdirs = perl_libdirs $self;	1264	my @urxvtdirs = perl_libdirs $self;
		1265	# my @cpandirs = grep -d, map "$_/URxvt/Ext", @INC;
1070		1266
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;	1267	$self->{meta} = \my %allmeta;
1077		1268
1078	for my $dir (reverse @libdirs) {	1269	# first gather extensions
		1270
		1271	my $gather = sub {
		1272	my ($dir, $core) = @_;
		1273
1079	opendir my $fh, $dir	1274	opendir my $fh, $dir
1080	or next;	1275	or return;
		1276
1081	for my $ext (readdir $fh) {	1277	for my $ext (readdir $fh) {
1082	$ext ne "."	1278	$ext !~ /^\./
1083	and $ext ne ".."
1084	and open my $fh, "<", "$dir/$ext"
1085	or next;	1279	or next;
1086		1280
		1281	open my $fh, "<", "$dir/$ext"
		1282	or next;
		1283
		1284	-f $fh
		1285	or next;
		1286
		1287	$ext =~ s/\.uext$// or $core
		1288	or next;
		1289
		1290	my %meta = (dir => $dir);
		1291
1087	while (<$fh>) {	1292	while (<$fh>) {
1088	if (/^#:META:X_RESOURCE:(.*)/) {	1293	if (/^#:META:(?:X_)?RESOURCE:(.*)/) {
1089	my ($pattern, $type, $desc) = split /:/, $1;	1294	my ($pattern, $type, $desc) = split /:/, $1;
1090	$pattern =~ s/^%(\.\|$)/$ext$1/g; # % in pattern == extension name	1295	$pattern =~ s/^%(\.\|$)/$ext$1/g; # % in pattern == extension name
1091	if ($pattern =~ /[^a-zA-Z0-9\-\.]/) {	1296	if ($pattern =~ /[^a-zA-Z0-9\-\.]/) {
1092	warn "$dir/$ext: meta resource '$pattern' contains illegal characters (not alphanumeric nor . nor *)\n";	1297	warn "$dir/$ext: meta resource '$pattern' contains illegal characters (not alphanumeric nor . nor *)\n";
1093	} else {	1298	} else {
1094	$meta{resource}{$pattern} = [$ext, $type, $desc];	1299	$meta{resource}{$pattern} = [$ext, $type, $desc];
1095	}	1300	}
		1301
		1302	} elsif (/^#:META:OSC:([0-9]+):(.*)/) {
		1303	push @{$allmeta{autoload_osc}{$1}}, [$ext, $2];
		1304
		1305	} elsif (/^#:META:OSC_PERL:([^:]+):(.*)/) {
		1306	push @{$allmeta{autoload_osc_perl}{$1}}, [$ext, $2];
		1307
1096	} elsif (/^\s*(?:#\|$)/) {	1308	} elsif (/^\s*(?:#\|$)/) {
1097	# skip other comments and empty lines	1309	# skip other comments and empty lines
		1310
1098	} else {	1311	} else {
1099	last; # stop parsing on first non-empty non-comment line	1312	last; # stop parsing on first non-empty non-comment line
1100	}	1313	}
1101	}	1314	}
		1315
		1316	$allmeta{ext}{$ext} = \%meta;
1102	}	1317	}
		1318	};
		1319
		1320	# $gather->($_, 0) for @cpandirs;
		1321	$gather->($_, 1) for @urxvtdirs;
		1322
		1323	# and now merge resources
		1324
		1325	$allmeta{resource} = \my %resource;
		1326
		1327	while (my ($k, $v) = each %{ $allmeta{ext} }) {
		1328	#TODO: should check for extensions overriding each other
		1329	%resource = (%resource, %{ $v->{resource} });
1103	}	1330	}
1104	}	1331	}
1105		1332
1106	=item $term = new urxvt::term $envhashref, $rxvtname, [arg...]	1333	=item $term = new urxvt::term $envhashref, $rxvtname, [arg...]
1107		1334
…		…
1127	}	1354	}
1128		1355
1129	=item $term->destroy	1356	=item $term->destroy
1130		1357
1131	Destroy the terminal object (close the window, free resources	1358	Destroy the terminal object (close the window, free resources
1132	etc.). Please note that @@RXVT_NAME@@ will not exit as long as any event	1359	etc.). Please note that urxvt will not exit as long as any event
1133	watchers (timers, io watchers) are still active.	1360	watchers (timers, io watchers) are still active.
1134		1361
1135	=item $term->exec_async ($cmd[, @args])	1362	=item $term->exec_async ($cmd[, @args])
1136		1363
1137	Works like the combination of the C<fork>/C<exec> builtins, which executes	1364	Works like the combination of the C<fork>/C<exec> builtins, which executes
1138	("starts") programs in the background. This function takes care of setting	1365	("starts") programs in the background. This function takes care of setting
1139	the user environment before exec'ing the command (e.g. C<PATH>) and should	1366	the user environment before exec'ing the command (e.g. C<PATH>) and should
1140	be preferred over explicit calls to C<exec> or C<system>.	1367	be preferred over explicit calls to C<exec> or C<system>.
1141		1368
		1369	It also sets the C<URXVT_EXT_WINDOWID> environment variable to the window
		1370	ID of the terminal (C<< $self->parent >>), similar to the C<WINDOWID>
		1371	variable set for the process spawned inside the terminal.
		1372
1142	Returns the pid of the subprocess or C<undef> on error.	1373	Returns the pid of the subprocess or C<undef> on error.
1143		1374
1144	=cut	1375	=cut
1145		1376
1146	sub exec_async {	1377	sub exec_async {
…		…
1149	my $pid = fork;	1380	my $pid = fork;
1150		1381
1151	return $pid	1382	return $pid
1152	if !defined $pid or $pid;	1383	if !defined $pid or $pid;
1153		1384
		1385	%ENV = (
1154	%ENV = %{ $self->env };	1386	%{ $self->env },
		1387	URXVT_EXT_WINDOWID => $self->parent,
		1388	);
1155		1389
1156	exec @_;	1390	exec @_;
1157	urxvt::_exit 255;	1391	urxvt::_exit 255;
1158	}	1392	}
1159		1393
…		…
1170	insecure intensityStyles iso14755 iso14755_52 jumpScroll loginShell	1404	insecure intensityStyles iso14755 iso14755_52 jumpScroll loginShell
1171	mapAlert meta8 mouseWheelScrollPage override_redirect pastableTabs	1405	mapAlert meta8 mouseWheelScrollPage override_redirect pastableTabs
1172	pointerBlank reverseVideo scrollBar scrollBar_floating scrollBar_right	1406	pointerBlank reverseVideo scrollBar scrollBar_floating scrollBar_right
1173	scrollTtyKeypress scrollTtyOutput scrollWithBuffer secondaryScreen	1407	scrollTtyKeypress scrollTtyOutput scrollWithBuffer secondaryScreen
1174	secondaryScroll skipBuiltinGlyphs skipScroll transparent tripleclickwords	1408	secondaryScroll skipBuiltinGlyphs skipScroll transparent tripleclickwords
1175	urgentOnBell utmpInhibit visualBell	1409	urgentOnBell utmpInhibit visualBell disablePasteBrackets
1176		1410
1177	=item $value = $term->resource ($name[, $newval])	1411	=item $value = $term->resource ($name[, $newval])
1178		1412
1179	Returns the current resource value associated with a given name and	1413	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>	1414	optionally sets a new value. Setting values is most useful in the C<init>
…		…
1206	preeditType print_pipe pty_fd reverseVideo saveLines scrollBar	1440	preeditType print_pipe pty_fd reverseVideo saveLines scrollBar
1207	scrollBar_align scrollBar_floating scrollBar_right scrollBar_thickness	1441	scrollBar_align scrollBar_floating scrollBar_right scrollBar_thickness
1208	scrollTtyKeypress scrollTtyOutput scrollWithBuffer scrollstyle	1442	scrollTtyKeypress scrollTtyOutput scrollWithBuffer scrollstyle
1209	secondaryScreen secondaryScroll shade skipBuiltinGlyphs skipScroll	1443	secondaryScreen secondaryScroll shade skipBuiltinGlyphs skipScroll
1210	term_name title transient_for transparent tripleclickwords urgentOnBell	1444	term_name title transient_for transparent tripleclickwords urgentOnBell
1211	utmpInhibit visualBell	1445	utmpInhibit visualBell rewrapMode disablePasteBrackets
1212		1446
1213	=cut	1447	=cut
1214		1448
1215	sub resource($$;$) {	1449	sub resource($$;$) {
1216	my ($self, $name) = (shift, shift);	1450	my ($self, $name) = (shift, shift);
…		…
1223	Returns the X-Resource for the given pattern, excluding the program or	1457	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	1458	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	1459	same value as used by this instance of rxvt-unicode. Returns C<undef> if no
1226	resource with that pattern exists.	1460	resource with that pattern exists.
1227		1461
1228	Extensions that define extra resource or command line arguments also need	1462	Extensions that define extra resources also need to call this method
1229	to call this method to access their values.	1463	to access their values.
1230		1464
1231	If the method is called on an extension object (basically, from an	1465	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	1466	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	1467	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	1468	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	1469	can rename them and get a new set of resources without having to change
1236	without having to change the actual code.	1470	the actual code.
1237		1471
1238	This method should only be called during the C<on_start> hook, as there is	1472	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	1473	only one resource database per display, and later invocations might return
1240	the wrong resources.	1474	the wrong resources.
1241		1475
…		…
1253	my $res = &x_resource;	1487	my $res = &x_resource;
1254		1488
1255	$res =~ /^\s(?:true\|yes\|on\|1)\s$/i ? 1 : defined $res && 0	1489	$res =~ /^\s(?:true\|yes\|on\|1)\s$/i ? 1 : defined $res && 0
1256	}	1490	}
1257		1491
1258	=item $success = $term->parse_keysym ($key, $octets)	1492	=item $action = $term->lookup_keysym ($keysym, $state)
1259		1493
		1494	Returns the action bound to key combination C<($keysym, $state)>,
		1495	if a binding for it exists, and C<undef> otherwise.
		1496
		1497	=item $success = $term->bind_action ($key, $action)
		1498
1260	Adds a key binding exactly as specified via a resource. See the	1499	Adds a key binding exactly as specified via a C<keysym> resource. See the
1261	C<keysym> resource in the @@RXVT_NAME@@(1) manpage.	1500	C<keysym> resource in the urxvt(1) manpage.
1262		1501
1263	=item $term->register_command ($keysym, $modifiermask, $string)	1502	To add default bindings for actions, an extension should call C<<
		1503	->bind_action >> in its C<init> hook for every such binding. Doing it
		1504	in the C<init> hook allows users to override or remove the binding
		1505	again.
1264		1506
1265	Adds a key binding. This is a lower level api compared to	1507	Example: the C<searchable-scrollback> by default binds itself
1266	C<parse_keysym>, as it expects a parsed key description, and can be	1508	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	1509	$term->bind_action >>.
1268	C<on_register_command> hook, to modify a parsed binding.	1510
		1511	sub init {
		1512	my ($self) = @_;
		1513
		1514	$self->bind_action ("M-s" => "%:start");
		1515	}
1269		1516
1270	=item $rend = $term->rstyle ([$new_rstyle])	1517	=item $rend = $term->rstyle ([$new_rstyle])
1271		1518
1272	Return and optionally change the current rendition. Text that is output by	1519	Return and optionally change the current rendition. Text that is output by
1273	the terminal application will use this style.	1520	the terminal application will use this style.
…		…
1350	This method returns an urxvt::overlay object. The overlay will be visible	1597	This method returns an urxvt::overlay object. The overlay will be visible
1351	as long as the perl object is referenced.	1598	as long as the perl object is referenced.
1352		1599
1353	The methods currently supported on C<urxvt::overlay> objects are:	1600	The methods currently supported on C<urxvt::overlay> objects are:
1354		1601
1355	=over 4	1602	=over
1356		1603
1357	=item $overlay->set ($x, $y, $text[, $rend])	1604	=item $overlay->set ($x, $y, $text[, $rend])
1358		1605
1359	Similar to C<< $term->ROW_t >> and C<< $term->ROW_r >> in that it puts	1606	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	1607	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	1651	Returns the number of screen-cells this string would need. Correctly
1405	accounts for wide and combining characters.	1652	accounts for wide and combining characters.
1406		1653
1407	=item $octets = $term->locale_encode ($string)	1654	=item $octets = $term->locale_encode ($string)
1408		1655
1409	Convert the given text string into the corresponding locale encoding.	1656	Convert the given text string into the corresponding locale
		1657	encoding. Returns C<undef> if C<$string> is C<undef>.
1410		1658
1411	=item $string = $term->locale_decode ($octets)	1659	=item $string = $term->locale_decode ($octets)
1412		1660
1413	Convert the given locale-encoded octets into a perl string.	1661	Convert the given locale-encoded octets into a perl string. Returns
		1662	C<undef> if C<$octets> is C<undef>.
1414		1663
1415	=item $term->scr_xor_span ($beg_row, $beg_col, $end_row, $end_col[, $rstyle])	1664	=item $term->scr_xor_span ($beg_row, $beg_col, $end_row, $end_col[, $rstyle])
1416		1665
1417	XORs the rendition values in the given span with the provided value	1666	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	1667	(default: C<RS_RVid>), which I<MUST NOT> contain font styles. Useful in
…		…
1431		1680
1432	=item $term->scr_add_lines ($string)	1681	=item $term->scr_add_lines ($string)
1433		1682
1434	Write the given text string to the screen, as if output by the application	1683	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	1684	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	1685	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.	1686	carriage returns and tabs. The string is a normal text string, not in
		1687	locale-dependent encoding.
1438		1688
1439	Normally its not a good idea to use this function, as programs might be	1689	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	1690	confused by changes in cursor position or scrolling. Its useful inside a
1441	C<on_add_lines> hook, though.	1691	C<on_add_lines> hook, though.
1442		1692
…		…
1450	locale-specific encoding of the terminal and can contain command sequences	1700	locale-specific encoding of the terminal and can contain command sequences
1451	(escape codes) that will be interpreted.	1701	(escape codes) that will be interpreted.
1452		1702
1453	=item $term->tt_write ($octets)	1703	=item $term->tt_write ($octets)
1454		1704
1455	Write the octets given in C<$octets> to the tty (i.e. as program input). To	1705	Write the octets given in C<$octets> to the tty (i.e. as user input
		1706	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	1707	characters instead of octets, you should convert your strings first to the
1457	to the locale-specific encoding using C<< $term->locale_encode >>.	1708	locale-specific encoding using C<< $term->locale_encode >>.
		1709
		1710	=item $term->tt_write_user_input ($octets)
		1711
		1712	Like C<tt_write>, but should be used when writing strings in response to
		1713	the user pressing a key, to invoke the additional actions requested by
		1714	the user for that case (C<tt_write> doesn't do that).
		1715
		1716	The typical use case would be inside C<on_action> hooks.
1458		1717
1459	=item $term->tt_paste ($octets)	1718	=item $term->tt_paste ($octets)
1460		1719
1461	Write the octets given in C<$octets> to the tty as a paste, converting NL to	1720	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	1721	CR and bracketing the data with control sequences if bracketed paste mode
…		…
1501		1760
1502	=item $term->key_release ($state, $keycode[, $time])	1761	=item $term->key_release ($state, $keycode[, $time])
1503		1762
1504	Deliver various fake events to to terminal.	1763	Deliver various fake events to to terminal.
1505		1764
1506	=item $window_width = $term->width	1765	=item $window_width = $term->width ([$new_value])
1507		1766
1508	=item $window_height = $term->height	1767	=item $window_height = $term->height ([$new_value])
1509		1768
1510	=item $font_width = $term->fwidth	1769	=item $font_width = $term->fwidth ([$new_value])
1511		1770
1512	=item $font_height = $term->fheight	1771	=item $font_height = $term->fheight ([$new_value])
1513		1772
1514	=item $font_ascent = $term->fbase	1773	=item $font_ascent = $term->fbase ([$new_value])
1515		1774
1516	=item $terminal_rows = $term->nrow	1775	=item $terminal_rows = $term->nrow ([$new_value])
1517		1776
1518	=item $terminal_columns = $term->ncol	1777	=item $terminal_columns = $term->ncol ([$new_value])
1519		1778
1520	=item $has_focus = $term->focus	1779	=item $has_focus = $term->focus ([$new_value])
1521		1780
1522	=item $is_mapped = $term->mapped	1781	=item $is_mapped = $term->mapped ([$new_value])
1523		1782
1524	=item $max_scrollback = $term->saveLines	1783	=item $max_scrollback = $term->saveLines ([$new_value])
1525		1784
1526	=item $nrow_plus_saveLines = $term->total_rows	1785	=item $nrow_plus_saveLines = $term->total_rows ([$new_value])
1527		1786
1528	=item $topmost_scrollback_row = $term->top_row	1787	=item $topmost_scrollback_row = $term->top_row ([$new_value])
1529		1788
1530	Return various integers describing terminal characteristics.	1789	Return various integers describing terminal characteristics. If an
		1790	argument is given, changes the value and returns the previous one.
1531		1791
1532	=item $x_display = $term->display_id	1792	=item $x_display = $term->display_id
1533		1793
1534	Return the DISPLAY used by rxvt-unicode.	1794	Return the DISPLAY used by rxvt-unicode.
1535		1795
…		…
1572		1832
1573	=item $cursor_is_hidden = $term->hidden_cursor	1833	=item $cursor_is_hidden = $term->hidden_cursor
1574		1834
1575	Returns whether the cursor is currently hidden or not.	1835	Returns whether the cursor is currently hidden or not.
1576		1836
		1837	=item $priv_modes = $term->priv_modes
		1838
		1839	Returns a bitset with the state of DEC private modes.
		1840
		1841	Example:
		1842
		1843	if ($term->priv_modes & urxvt::PrivMode_mouse_report) {
		1844	# mouse reporting is turned on
		1845	}
		1846
1577	=item $view_start = $term->view_start ([$newvalue])	1847	=item $view_start = $term->view_start ([$newvalue])
1578		1848
1579	Returns the row number of the topmost displayed line. Maximum value is	1849	Returns the row number of the topmost displayed line and changes it,
1580	C<0>, which displays the normal terminal contents. Lower values scroll	1850	if an argument is given. Values greater than or equal to C<0> display
1581	this many lines into the scrollback buffer.	1851	the terminal contents. Lower values scroll this many lines into the
		1852	scrollback buffer.
1582		1853
1583	=item $term->want_refresh	1854	=item $term->want_refresh
1584		1855
1585	Requests a screen refresh. At the next opportunity, rxvt-unicode will	1856	Requests a screen refresh. At the next opportunity, rxvt-unicode will
1586	compare the on-screen display with its stored representation. If they	1857	compare the on-screen display with its stored representation. If they
1587	differ, it redraws the differences.	1858	differ, it redraws the differences.
1588		1859
1589	Used after changing terminal contents to display them.	1860	Used after changing terminal contents to display them.
		1861
		1862	=item $term->refresh_check
		1863
		1864	Checks if a refresh has been requested and, if so, schedules one.
1590		1865
1591	=item $text = $term->ROW_t ($row_number[, $new_text[, $start_col]])	1866	=item $text = $term->ROW_t ($row_number[, $new_text[, $start_col]])
1592		1867
1593	Returns the text of the entire row with number C<$row_number>. Row C<< $term->top_row >>	1868	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	1869	is the topmost terminal line, row C<< $term->nrow-1 >> is the bottommost
…		…
1640		1915
1641	Create and return a new C<urxvt::line> object that stores information	1916	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	1917	about the logical line that row C<$row_number> is part of. It supports the
1643	following methods:	1918	following methods:
1644		1919
1645	=over 4	1920	=over
1646		1921
1647	=item $text = $line->t ([$new_text])	1922	=item $text = $line->t ([$new_text])
1648		1923
1649	Returns or replaces the full text of the line, similar to C<ROW_t>	1924	Returns or replaces the full text of the line, similar to C<ROW_t>
1650		1925
…		…
1696	}	1971	}
1697		1972
1698	sub urxvt::line::t {	1973	sub urxvt::line::t {
1699	my ($self) = @_;	1974	my ($self) = @_;
1700		1975
1701	if (@_ > 1)	1976	if (@_ > 1) {
1702	{
1703	$self->{term}->ROW_t ($_, $_[1], 0, ($_ - $self->{beg}) * $self->{ncol}, $self->{ncol})	1977	$self->{term}->ROW_t ($_, $_[1], 0, ($_ - $self->{beg}) * $self->{ncol}, $self->{ncol})
1704	for $self->{beg} .. $self->{end};	1978	for $self->{beg} .. $self->{end};
1705	}	1979	}
1706		1980
1707	defined wantarray &&	1981	defined wantarray &&
1708	substr +(join "", map $self->{term}->ROW_t ($_), $self->{beg} .. $self->{end}),	1982	substr +(join "", map $self->{term}->ROW_t ($_), $self->{beg} .. $self->{end}),
1709	0, $self->{len}	1983	0, $self->{len}
1710	}	1984	}
1711		1985
1712	sub urxvt::line::r {	1986	sub urxvt::line::r {
1713	my ($self) = @_;	1987	my ($self) = @_;
1714		1988
1715	if (@_ > 1)	1989	if (@_ > 1) {
1716	{
1717	$self->{term}->ROW_r ($_, $_[1], 0, ($_ - $self->{beg}) * $self->{ncol}, $self->{ncol})	1990	$self->{term}->ROW_r ($_, $_[1], 0, ($_ - $self->{beg}) * $self->{ncol}, $self->{ncol})
1718	for $self->{beg} .. $self->{end};	1991	for $self->{beg} .. $self->{end};
1719	}	1992	}
1720		1993
1721	if (defined wantarray) {	1994	if (defined wantarray) {
1722	my $rend = [	1995	my $rend = [
1723	map @{ $self->{term}->ROW_r ($_) }, $self->{beg} .. $self->{end}	1996	map @{ $self->{term}->ROW_r ($_) }, $self->{beg} .. $self->{end}
1724	];	1997	];
…		…
1756	where one character corresponds to one screen cell. See	2029	where one character corresponds to one screen cell. See
1757	C<< $term->ROW_t >> for details.	2030	C<< $term->ROW_t >> for details.
1758		2031
1759	=item $string = $term->special_decode $text	2032	=item $string = $term->special_decode $text
1760		2033
1761	Converts rxvt-unicodes text representation into a perl string. See	2034	Converts rxvt-unicode's text representation into a perl string. See
1762	C<< $term->ROW_t >> for details.	2035	C<< $term->ROW_t >> for details.
1763		2036
1764	=item $success = $term->grab_button ($button, $modifiermask[, $window = $term->vt])	2037	=item $success = $term->grab_button ($button, $modifiermask[, $window = $term->vt])
1765		2038
1766	=item $term->ungrab_button ($button, $modifiermask[, $window = $term->vt])	2039	=item $term->ungrab_button ($button, $modifiermask[, $window = $term->vt])
…		…
1832		2105
1833	package urxvt::popup;	2106	package urxvt::popup;
1834		2107
1835	=head2 The C<urxvt::popup> Class	2108	=head2 The C<urxvt::popup> Class
1836		2109
1837	=over 4	2110	=over
1838		2111
1839	=cut	2112	=cut
1840		2113
1841	sub add_item {	2114	sub add_item {
1842	my ($self, $item) = @_;	2115	my ($self, $item) = @_;
…		…
1978	->cb (sub {	2251	->cb (sub {
1979	$term->{overlay}->set (0, 0,	2252	$term->{overlay}->set (0, 0,
1980	sprintf "%2d:%02d:%02d", (localtime urxvt::NOW)[2,1,0]);	2253	sprintf "%2d:%02d:%02d", (localtime urxvt::NOW)[2,1,0]);
1981	});	2254	});
1982		2255
1983	=over 4	2256	=over
1984		2257
1985	=item $timer = new urxvt::timer	2258	=item $timer = new urxvt::timer
1986		2259
1987	Create a new timer object in started state. It is scheduled to fire	2260	Create a new timer object in started state. It is scheduled to fire
1988	immediately.	2261	immediately.
…		…
2037	sysread $term->{socket}, my $buf, 8192	2310	sysread $term->{socket}, my $buf, 8192
2038	or end-of-file;	2311	or end-of-file;
2039	});	2312	});
2040		2313
2041		2314
2042	=over 4	2315	=over
2043		2316
2044	=item $iow = new urxvt::iow	2317	=item $iow = new urxvt::iow
2045		2318
2046	Create a new io watcher object in stopped state.	2319	Create a new io watcher object in stopped state.
2047		2320
…		…
2074		2347
2075	This class implements idle watchers, that get called automatically when	2348	This class implements idle watchers, that get called automatically when
2076	the process is idle. They should return as fast as possible, after doing	2349	the process is idle. They should return as fast as possible, after doing
2077	some useful work.	2350	some useful work.
2078		2351
2079	=over 4	2352	=over
2080		2353
2081	=item $iw = new urxvt::iw	2354	=item $iw = new urxvt::iw
2082		2355
2083	Create a new idle watcher object in stopped state.	2356	Create a new idle watcher object in stopped state.
2084		2357
…		…
2109	->cb (sub {	2382	->cb (sub {
2110	my ($pw, $exit_status) = @_;	2383	my ($pw, $exit_status) = @_;
2111	...	2384	...
2112	});	2385	});
2113		2386
2114	=over 4	2387	=over
2115		2388
2116	=item $pw = new urxvt::pw	2389	=item $pw = new urxvt::pw
2117		2390
2118	Create a new process watcher in stopped state.	2391	Create a new process watcher in stopped state.
2119		2392
…		…
2136	=head2 URXVT_PERL_VERBOSITY	2409	=head2 URXVT_PERL_VERBOSITY
2137		2410
2138	This variable controls the verbosity level of the perl extension. Higher	2411	This variable controls the verbosity level of the perl extension. Higher
2139	numbers indicate more verbose output.	2412	numbers indicate more verbose output.
2140		2413
2141	=over 4	2414	=over
2142		2415
2143	=item == 0 - fatal messages	2416	=item == 0 - fatal messages only
		2417
		2418	=item >= 2 - general warnings (default level)
2144		2419
2145	=item >= 3 - script loading and management	2420	=item >= 3 - script loading and management
2146		2421
2147	=item >=10 - all called hooks	2422	=item >=10 - all called hooks
2148		2423

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.271 by root, Fri Dec 9 05:06:46 2022 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.271 by root, Fri Dec 9 05:06:46 2022 UTC