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

Comparing rxvt-unicode/src/urxvt.pm (file contents):
Revision 1.219 by sf-exg, Sun Jun 10 18:23:18 2012 UTC vs.
Revision 1.268 by root, Sat Jul 24 13:07:56 2021 UTC

…		…
1	=encoding utf8	1	=encoding utf8
2		2
3	=head1 NAME	3	=head1 NAME
4		4
5	@@RXVT_NAME@@perl - rxvt-unicode's embedded perl interpreter	5	urxvtperl - rxvt-unicode's embedded perl interpreter
6		6
7	=head1 SYNOPSIS	7	=head1 SYNOPSIS
8		8
9	# create a file grab_test in $HOME:	9	# create a file grab_test in some directory:
10		10
11	sub on_sel_grab {	11	sub on_sel_grab {
12	warn "you selected ", $_[0]->selection;	12	warn "you selected ", $_[0]->selection;
13	()	13	()
14	}	14	}
15		15
16	# start a @@RXVT_NAME@@ using it:	16	# start a urxvt instance using it:
17		17
18	@@RXVT_NAME@@ --perl-lib $HOME -pe grab_test	18	urxvt --perl-lib path/to/somedirectory -pe grab_test
19		19
20	=head1 DESCRIPTION	20	=head1 DESCRIPTION
21		21
22	Every time a terminal object gets created, extension scripts specified via	22	Every time a terminal object gets created, extension scripts specified via
23	the C<perl> resource are loaded and associated with it.	23	the C<perl> resource are loaded and associated with it.
24		24
25	Scripts are compiled in a 'use strict "vars"' and 'use utf8' environment, and	25	Scripts are compiled in a 'use strict qw(vars subs)' and 'use utf8'
26	thus must be encoded as UTF-8.	26	environment, and thus must be encoded as UTF-8.
27		27
28	Each script will only ever be loaded once, even in @@RXVT_NAME@@d, where	28	Each script will only ever be loaded once, even in urxvtd, where
29	scripts will be shared (but not enabled) for all terminals.	29	scripts will be shared (but not enabled) for all terminals.
30		30
31	You can disable the embedded perl interpreter by setting both "perl-ext"	31	You can disable the embedded perl interpreter by setting both "perl-ext"
32	and "perl-ext-common" resources to the empty string.	32	and "perl-ext-common" resources to the empty string.
33		33
34	=head1 PREPACKAGED EXTENSIONS	34	=head1 PREPACKAGED EXTENSIONS
35		35
36	A number of extensions are delivered with this release. You can find them	36	A number of extensions are delivered with this release. You can find them
37	in F<@@RXVT_LIBDIR@@/urxvt/perl/>, and the documentation can be viewed	37	in F<< <libdir>/urxvt/perl/ >>, and the documentation can be viewed using
38	using F<< man urxvt-<EXTENSIONNAME> >>.	38	F<< man urxvt-<EXTENSIONNAME> >>.
39		39
40	You can activate them like this:	40	You can activate them like this:
41		41
42	@@RXVT_NAME@@ -pe <extensionname>	42	urxvt -pe <extensionname>
43		43
44	Or by adding them to the resource for extensions loaded by default:	44	Or by adding them to the resource for extensions loaded by default:
45		45
46	URxvt.perl-ext-common: default,selection-autotransform	46	URxvt.perl-ext-common: default,selection-autotransform
47		47
48	Extensions that add command line parameters or resources on their own are	48	Extensions may add additional resources and C<actions>, i.e., methods
49	loaded automatically when used.	49	which can be bound to a key and invoked by the user. An extension can
		50	define the resources it support using so called META comments,
		51	described below. Similarly to builtin resources, extension resources
		52	can also be specified on the command line as long options (with C<.>
		53	replaced by C<->), in which case the corresponding extension is loaded
		54	automatically. For this to work the extension B<must> define META
		55	comments for its resources.
50		56
51	=head1 API DOCUMENTATION	57	=head1 API DOCUMENTATION
52		58
53	=head2 General API Considerations	59	=head2 General API Considerations
54		60
64	terminal is destroyed.	70	terminal is destroyed.
65		71
66	Argument names also often indicate the type of a parameter. Here are some	72	Argument names also often indicate the type of a parameter. Here are some
67	hints on what they mean:	73	hints on what they mean:
68		74
69	=over 4	75	=over
70		76
71	=item $text	77	=item $text
72		78
73	Rxvt-unicode's special way of encoding text, where one "unicode" character	79	Rxvt-unicode's special way of encoding text, where one "unicode" character
74	always represents one screen cell. See L<ROW_t> for a discussion of this format.	80	always represents one screen cell. See L<ROW_t> for a discussion of this format.
…		…
103	internal use.	109	internal use.
104		110
105	Although it isn't a C<urxvt::term> object, you can call all methods of the	111	Although it isn't a C<urxvt::term> object, you can call all methods of the
106	C<urxvt::term> class on this object.	112	C<urxvt::term> class on this object.
107		113
108	It has the following methods and data members:	114	Additional methods only supported for extension objects are described in
		115	the C<urxvt::extension> section below.
109		116
		117	=head2 META comments
		118
		119	Rxvt-unicode recognizes special meta comments in extensions that define
		120	different types of metadata. These comments are scanned whenever a
		121	terminal is created and are typically used to autoload extensions when
		122	their resources or command line parameters are used.
		123
		124	Currently, it recognises these comments below. Individual components are
		125	separated by colons (C<:>), and should not contain colons themselves -
		126	there is also currently no escaping mechanism provided for this.
		127
110	=over 4	128	=over
111		129
112	=item $urxvt_term = $self->{term}	130	=item #:META:RESOURCE:name:type:desc
113		131
114	Returns the C<urxvt::term> object associated with this instance of the	132	The RESOURCE comment defines a resource used by the extension, where
115	extension. This member I<must not> be changed in any way.	133	C<name> is the resource name, C<type> is the resource type, C<boolean>
		134	or C<string>, and C<desc> is the resource description.
116		135
117	=item $self->enable ($hook_name => $cb, [$hook_name => $cb..])	136	The extension will be autoloaded when this resource is specified or used
		137	as a command line parameter.
118		138
119	Dynamically enable the given hooks (named without the C<on_> prefix) for	139	Example: matcher provides the C<matcher.launcher> resource by having this
120	this extension, replacing any previous hook. This is useful when you want	140	comment:
121	to overwrite time-critical hooks only temporarily.
122		141
123	=item $self->disable ($hook_name[, $hook_name..])	142	#:META:RESOURCE:%.launcher:string:default launcher command
124		143
125	Dynamically disable the given hooks.	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
126		183
127	=back	184	=back
128		185
129	=head2 Hooks	186	=head2 Hooks
130		187
…		…
138	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
139	relevant action might not be carried out by the C++ code.	196	relevant action might not be carried out by the C++ code.
140		197
141	I<< When in doubt, return a false value (preferably C<()>). >>	198	I<< When in doubt, return a false value (preferably C<()>). >>
142		199
143	=over 4	200	=over
144		201
145	=item on_init $term	202	=item on_init $term
146		203
147	Called after a new terminal object has been initialized, but before	204	Called after a new terminal object has been initialized, but before
148	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
…		…
230		287
231	C<on_osc_seq_perl> should be used for new behaviour.	288	C<on_osc_seq_perl> should be used for new behaviour.
232		289
233	=item on_osc_seq_perl $term, $args, $resp	290	=item on_osc_seq_perl $term, $args, $resp
234		291
235	Called whenever the B<ESC ] 777 ; string ST> command sequence (OSC =	292	Called whenever the B<ESC ] 777 ; prefix ; string ST> command sequence
236	operating system command) is processed. Cursor position and other state	293	(OSC = operating system command) is processed. Cursor position and other
237	information is up-to-date when this happens. For interoperability, the	294	state information is up-to-date when this happens. For interoperability,
238	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
239	to distinguish it from commands for other extensions, and this might be	296	other suitable prefix, and a semicolon, to distinguish it from commands
240	enforced in the future.	297	for other extensions.
241		298
242	For example, C<overlay-osc> uses this:	299	For example, C<overlay-osc> uses this:
243		300
244	sub on_osc_seq_perl {	301	sub on_osc_seq_perl {
245	my ($self, $osc, $resp) = @_;	302	my ($self, $osc, $resp) = @_;
…		…
299		356
300	=item on_refresh_end $term	357	=item on_refresh_end $term
301		358
302	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>.
303		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
304	=item on_user_command $term, $string	369	=item on_user_command $term, $string DEPRECATED
305		370
306	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
307	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>
308	resource in the @@RXVT_NAME@@(1) manpage).	373	resource in the urxvt(1) manpage).
309		374
310	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
311	slightly in the future.	376	preference to the C<on_action> hook.
312
313	=item on_register_command $term, $keysym, $modifiermask, $string
314
315	Called after parsing a keysym resource but before registering the
316	associated binding. If this hook returns TRUE the binding is not
317	registered. It can be used to modify a binding by calling
318	C<register_command>.
319		377
320	=item on_resize_all_windows $term, $new_width, $new_height	378	=item on_resize_all_windows $term, $new_width, $new_height
321		379
322	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
323	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
324	returns TRUE, setting of the window hints is being skipped.	382	returns a true value, setting of the window hints is being skipped.
325		383
326	=item on_x_event $term, $event	384	=item on_x_event $term, $event
327		385
328	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
329	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
…		…
369	(real, not screen-based) row and column under the mouse cursor.	427	(real, not screen-based) row and column under the mouse cursor.
370		428
371	C<on_key_press> additionally receives the string rxvt-unicode would	429	C<on_key_press> additionally receives the string rxvt-unicode would
372	output, if any, in locale-specific encoding.	430	output, if any, in locale-specific encoding.
373		431
374	subwindow.
375
376	=item on_client_message $term, $event	432	=item on_client_message $term, $event
377		433
378	=item on_wm_protocols $term, $event	434	=item on_wm_protocols $term, $event
379		435
380	=item on_wm_delete_window $term, $event	436	=item on_wm_delete_window $term, $event
…		…
391	=cut	447	=cut
392		448
393	package urxvt;	449	package urxvt;
394		450
395	use utf8;	451	use utf8;
396	use strict 'vars';	452	use strict qw(vars subs);
397	use Carp ();	453	use Carp ();
398	use Scalar::Util ();	454	use Scalar::Util ();
399	use List::Util ();	455	use List::Util ();
400		456
401	our $VERSION = 1;	457	our $VERSION = 1;
…		…
413		469
414	our $NOCHAR = chr 0xffff;	470	our $NOCHAR = chr 0xffff;
415		471
416	=head2 Variables in the C<urxvt> Package	472	=head2 Variables in the C<urxvt> Package
417		473
418	=over 4	474	=over
419		475
420	=item $urxvt::LIBDIR	476	=item $urxvt::LIBDIR
421		477
422	The rxvt-unicode library directory, where, among other things, the perl	478	The rxvt-unicode library directory, where, among other things, the perl
423	modules and scripts are stored.	479	modules and scripts are stored.
…		…
453		509
454	=back	510	=back
455		511
456	=head2 Functions in the C<urxvt> Package	512	=head2 Functions in the C<urxvt> Package
457		513
458	=over 4	514	=over
459		515
460	=item urxvt::fatal $errormessage	516	=item urxvt::fatal $errormessage
461		517
462	Fatally aborts execution with the given error message (which should	518	Fatally aborts execution with the given error message (which should
463	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
…		…
508	CirculateRequest, PropertyNotify, SelectionClear, SelectionRequest,	564	CirculateRequest, PropertyNotify, SelectionClear, SelectionRequest,
509	SelectionNotify, ColormapNotify, ClientMessage, MappingNotify	565	SelectionNotify, ColormapNotify, ClientMessage, MappingNotify
510		566
511	Various constants for use in X calls and event processing.	567	Various constants for use in X calls and event processing.
512		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
513	=back	581	=back
514		582
515	=head2 RENDITION	583	=head2 RENDITION
516		584
517	Rendition bitsets contain information about colour, font, font styles and	585	Rendition bitsets contain information about colour, font, font styles and
…		…
520	The following "macros" deal with changes in rendition sets. You should	588	The following "macros" deal with changes in rendition sets. You should
521	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,
522	as they contain important information required for correct operation of	590	as they contain important information required for correct operation of
523	rxvt-unicode.	591	rxvt-unicode.
524		592
525	=over 4	593	=over
526		594
527	=item $rend = urxvt::DEFAULT_RSTYLE	595	=item $rend = urxvt::DEFAULT_RSTYLE
528		596
529	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
530	being reset. Useful as a base to start when creating renditions.	598	being reset. Useful as a base to start when creating renditions.
…		…
582	no warnings 'utf8';	650	no warnings 'utf8';
583		651
584	sub parse_resource {	652	sub parse_resource {
585	my ($term, $name, $isarg, $longopt, $flag, $value) = @_;	653	my ($term, $name, $isarg, $longopt, $flag, $value) = @_;
586		654
587	$name =~ y/-/./ if $isarg;
588
589	$term->scan_meta;	655	$term->scan_extensions;
590		656
		657	# iterating over all resources has quadratic time overhead
		658	# overall, maybe this could be optimised?
591	my $r = $term->{meta}{resource};	659	my $r = $term->{meta}{resource};
592	keys %$r; # reste iterator	660	keys %$r; # reset iterator
593	while (my ($pattern, $v) = each %$r) {	661	while (my ($k, $v) = each %$r) {
594	if (	662	my $pattern = $k;
		663	$pattern =~ y/./-/ if $isarg;
		664	my $prefix = $name;
		665	my $suffix;
595	$pattern =~ /\.$/	666	if ($pattern =~ /\-$/) {
596	? $pattern eq substr $name, 0, length $pattern	667	$prefix = substr $name, 0, length $pattern;
597	: $pattern eq $name	668	$suffix = substr $name, length $pattern;
598	) {	669	}
		670	if ($pattern eq $prefix) {
599	$name = "$urxvt::RESCLASS.$name";	671	$name = "$urxvt::RESCLASS.$k$suffix";
600		672
601	push @{ $term->{perl_ext_3} }, $v->[0];	673	push @{ $term->{perl_ext_3} }, $v->[0];
		674
		675	return 1 unless $isarg;
602		676
603	if ($v->[1] eq "boolean") {	677	if ($v->[1] eq "boolean") {
604	$term->put_option_db ($name, $flag ? "true" : "false");	678	$term->put_option_db ($name, $flag ? "true" : "false");
605	return 1;	679	return 1;
606	} else {	680	} else {
…		…
614	}	688	}
615		689
616	sub usage {	690	sub usage {
617	my ($term, $usage_type) = @_;	691	my ($term, $usage_type) = @_;
618		692
619	$term->scan_meta;	693	$term->scan_extensions;
620		694
621	my $r = $term->{meta}{resource};	695	my $r = $term->{meta}{resource};
622		696
623	for my $pattern (sort keys %$r) {	697	for my $pattern (sort keys %$r) {
624	my ($ext, $type, $desc) = @{ $r->{$pattern} };	698	my ($ext, $type, $desc) = @{ $r->{$pattern} };
…		…
639	urxvt::log sprintf " %-31s %s\n", "$pattern:", $type;	713	urxvt::log sprintf " %-31s %s\n", "$pattern:", $type;
640	}	714	}
641	}	715	}
642	}	716	}
643		717
644	my $verbosity = $ENV{URXVT_PERL_VERBOSITY};	718	my $verbosity = $ENV{URXVT_PERL_VERBOSITY} // 2;
645		719
646	sub verbose {	720	sub verbose {
647	my ($level, $msg) = @_;	721	my ($level, $msg) = @_;
648	warn "$msg\n" if $level <= $verbosity;	722	warn "$msg\n" if $level <= $verbosity;
649	}	723	}
…		…
666		740
667	open my $fh, "<:raw", $path	741	open my $fh, "<:raw", $path
668	or die "$path: $!";	742	or die "$path: $!";
669		743
670	my $source =	744	my $source =
671	"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"
672	. "#line 1 \"$path\"\n{\n"	746	. "#line 1 \"$path\"\n{\n"
673	. (do { local $/; <$fh> })	747	. (do { local $/; <$fh> })
674	. "\n};\n1";	748	. "\n};\n1";
675		749
676	eval $source	750	eval $source
…		…
685	# called by the rxvt core	759	# called by the rxvt core
686	sub invoke {	760	sub invoke {
687	local $TERM = shift;	761	local $TERM = shift;
688	my $htype = shift;	762	my $htype = shift;
689		763
690	if ($htype == 0) { # INIT	764	if ($htype == HOOK_INIT) {
691	my @dirs = $TERM->perl_libdirs;	765	$TERM->scan_extensions;
692		766
693	my %ext_arg;	767	my %ext_arg;
694		768
695	{	769	{
696	my @init = @TERM_INIT;	770	my @init = @TERM_INIT;
…		…
701	$TERM->register_package ($_) for @pkg;	775	$TERM->register_package ($_) for @pkg;
702	}	776	}
703		777
704	for (	778	for (
705	@{ delete $TERM->{perl_ext_3} },	779	@{ delete $TERM->{perl_ext_3} },
706	grep $_, map { split /,/, $TERM->resource ("perl_ext_$_") } 1, 2	780	(grep $_, map { split /,/, $TERM->resource ("perl_ext_$_") } 1, 2),
707	) {	781	) {
708	if ($_ eq "default") {	782	if ($_ eq "default") {
		783
		784	$ext_arg{$_} = []
709	$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
710	} elsif (/^-(.*)$/) {	796	} elsif (/^-(.*)$/) { # remove from set
711	delete $ext_arg{$1};	797	delete $ext_arg{$1};
712	} 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};
713	push @{ $ext_arg{$1} }, $2;	804	push @{ $ext_arg{$1} }, defined $2 ? $2 : ();
		805
714	} else {	806	} else {
715	$ext_arg{$_} \|\|= [];	807	verbose 2, "cannot parse extension specification '$_', ignoring.";
716	}	808	}
717	}	809	}
718		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
719	for my $ext (sort keys %ext_arg) {	814	for my $ext (sort keys %ext_arg) {
720	my @files = grep -f $_, map "$_/$ext", @dirs;	815	my $path = $TERM->extension_path ($ext);
721		816
722	if (@files) {	817	if (defined $path) {
723	$TERM->register_package (extension_package $files[0], $ext_arg{$ext});	818	$TERM->autoload_extension ($ext, $ext_arg{$ext});
724	} else {	819	} else {
725	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";
726	}	821	}
727	}	822	}
728		823
729	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");
730	warn $@ if $@;	825	warn $@ if $@;
731	}	826	}
732		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
733	$retval = undef;	838	$retval = undef;
734		839
735	if (my $cb = $TERM->{_hook}[$htype]) {	840	if (my $cb = $TERM->{_hook}[$htype]) {
736	verbose 10, "$HOOKNAME[$htype] (" . (join ", ", $TERM, @_) . ")"	841	verbose 10, "$HOOKNAME[$htype] (" . (join ", ", $TERM, @_) . ")"
737	if $verbosity >= 10;	842	if $verbosity >= 10;
738		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	}
		856
739	for my $pkg (keys %$cb) {	857	for my $pkg (keys %$cb) {
740	my $retval_ = eval { $cb->{$pkg}->($TERM->{_pkg}{$pkg}, @_) };	858	my $retval_ = eval { $cb->{$pkg}->($TERM->{_pkg}{$pkg} \|\| $TERM, @_) };
741	$retval \|\|= $retval_;	859	$retval \|\|= $retval_;
742		860
743	if ($@) {	861	if ($@) {
744	$TERM->ungrab; # better to lose the grab than the session	862	$TERM->ungrab; # better to lose the grab than the session
745	warn $@;	863	warn $@;
…		…
748		866
749	verbose 11, "$HOOKNAME[$htype] returning <$retval>"	867	verbose 11, "$HOOKNAME[$htype] returning <$retval>"
750	if $verbosity >= 11;	868	if $verbosity >= 11;
751	}	869	}
752		870
753	if ($htype == 1) { # DESTROY	871	if ($htype == HOOK_DESTROY) {
754	# clear package objects	872	# clear package objects
755	%$_ = () for values %{ $TERM->{_pkg} };	873	%$_ = () for values %{ $TERM->{_pkg} };
756		874
757	# clear package	875	# clear package
758	%$TERM = ();	876	%$TERM = ();
…		…
790	($mask, @color{qw(fg bg)}, \@failed)	908	($mask, @color{qw(fg bg)}, \@failed)
791	}	909	}
792		910
793	package urxvt::term::extension;	911	package urxvt::term::extension;
794		912
795	sub enable {	913	=head2 The C<urxvt::term::extension> class
796	my ($self, %hook) = @_;
797	my $pkg = $self->{_pkg};
798		914
799	while (my ($name, $cb) = each %hook) {	915	Each extension attached to a terminal object is represented by
800	my $htype = $HOOKTYPE{uc $name};	916	a C<urxvt::term::extension> object.
801	defined $htype
802	or Carp::croak "unsupported hook type '$name'";
803		917
804	$self->set_should_invoke ($htype, +1)	918	You can use these objects, which are passed to all callbacks to store any
805	unless exists $self->{term}{_hook}[$htype]{$pkg};	919	state related to the terminal and extension instance.
806		920
807	$self->{term}{_hook}[$htype]{$pkg} = $cb;	921	The methods (And data members) documented below can be called on extension
808	}	922	objects, in addition to call methods documented for the <urxvt::term>
809	}	923	class.
810		924
811	sub disable {	925	=over
812	my ($self, @hook) = @_;
813	my $pkg = $self->{_pkg};
814		926
815	for my $name (@hook) {	927	=item $urxvt_term = $self->{term}
816	my $htype = $HOOKTYPE{uc $name};
817	defined $htype
818	or Carp::croak "unsupported hook type '$name'";
819		928
820	$self->set_should_invoke ($htype, -1)	929	Returns the C<urxvt::term> object associated with this instance of the
821	if delete $self->{term}{_hook}[$htype]{$pkg};	930	extension. This member I<must not> be changed in any way.
822	}	931
823	}	932	=cut
824		933
825	our $AUTOLOAD;	934	our $AUTOLOAD;
826		935
827	sub AUTOLOAD {	936	sub AUTOLOAD {
828	$AUTOLOAD =~ /:([^:]+)$/	937	$AUTOLOAD =~ /:([^:]+)$/
…		…
841		950
842	sub DESTROY {	951	sub DESTROY {
843	# nop	952	# nop
844	}	953	}
845		954
846	# urxvt::destroy_hook	955	# urxvt::destroy_hook (basically a cheap Guard:: implementation)
847		956
848	sub urxvt::destroy_hook::DESTROY {	957	sub urxvt::destroy_hook::DESTROY {
849	${$_[0]}->();	958	${$_[0]}->();
850	}	959	}
851		960
852	sub urxvt::destroy_hook(&) {	961	sub urxvt::destroy_hook(&) {
853	bless \shift, urxvt::destroy_hook::	962	bless \shift, urxvt::destroy_hook::
		963	}
		964
		965	=item $self->enable ($hook_name => $cb[, $hook_name => $cb..])
		966
		967	Dynamically enable the given hooks (named without the C<on_> prefix) for
		968	this extension, replacing any hook previously installed via C<enable> in
		969	this extension.
		970
		971	This is useful when you want to overwrite time-critical hooks only
		972	temporarily.
		973
		974	To install additional callbacks for the same hook, you can use the C<on>
		975	method of the C<urxvt::term> class.
		976
		977	=item $self->disable ($hook_name[, $hook_name..])
		978
		979	Dynamically disable the given hooks.
		980
		981	=cut
		982
		983	sub enable {
		984	my ($self, %hook) = @_;
		985	my $pkg = $self->{_pkg};
		986
		987	while (my ($name, $cb) = each %hook) {
		988	my $htype = $HOOKTYPE{uc $name};
		989	defined $htype
		990	or Carp::croak "unsupported hook type '$name'";
		991
		992	$self->set_should_invoke ($htype, +1)
		993	unless exists $self->{term}{_hook}[$htype]{$pkg};
		994
		995	$self->{term}{_hook}[$htype]{$pkg} = $cb;
		996	}
		997	}
		998
		999	sub disable {
		1000	my ($self, @hook) = @_;
		1001	my $pkg = $self->{_pkg};
		1002
		1003	for my $name (@hook) {
		1004	my $htype = $HOOKTYPE{uc $name};
		1005	defined $htype
		1006	or Carp::croak "unsupported hook type '$name'";
		1007
		1008	$self->set_should_invoke ($htype, -1)
		1009	if delete $self->{term}{_hook}[$htype]{$pkg};
		1010	}
		1011	}
		1012
		1013	=item $guard = $self->on ($hook_name => $cb[, $hook_name => $cb..])
		1014
		1015	Similar to the C<enable> enable, but installs additional callbacks for
		1016	the given hook(s) (that is, it doesn't replace existing callbacks), and
		1017	returns a guard object. When the guard object is destroyed the callbacks
		1018	are disabled again.
		1019
		1020	=cut
		1021
		1022	sub urxvt::extension::on_disable::DESTROY {
		1023	my $disable = shift;
		1024
		1025	my $term = delete $disable->{""};
		1026
		1027	while (my ($htype, $id) = each %$disable) {
		1028	delete $term->{_hook}[$htype]{$id};
		1029	$term->set_should_invoke ($htype, -1);
		1030	}
		1031	}
		1032
		1033	sub on {
		1034	my ($self, %hook) = @_;
		1035
		1036	my $term = $self->{term};
		1037
		1038	my %disable = ( "" => $term );
		1039
		1040	while (my ($name, $cb) = each %hook) {
		1041	my $htype = $HOOKTYPE{uc $name};
		1042	defined $htype
		1043	or Carp::croak "unsupported hook type '$name'";
		1044
		1045	$term->set_should_invoke ($htype, +1);
		1046	$term->{_hook}[$htype]{ $disable{$htype} = $cb+0 }
		1047	= sub { shift; $cb->($self, @_) }; # very ugly indeed
		1048	}
		1049
		1050	bless \%disable, "urxvt::extension::on_disable"
		1051	}
		1052
		1053	=item $self->bind_action ($hotkey, $action)
		1054
		1055	=item $self->x_resource ($pattern)
		1056
		1057	=item $self->x_resource_boolean ($pattern)
		1058
		1059	These methods support an additional C<%> prefix for C<$action> or
		1060	C<$pattern> when called on an extension object, compared to the
		1061	C<urxvt::term> methods of the same name - see the description of these
		1062	methods in the C<urxvt::term> class for details.
		1063
		1064	=cut
		1065
		1066	sub bind_action {
		1067	my ($self, $hotkey, $action) = @_;
		1068	$action =~ s/^%:/$_[0]{_name}:/;
		1069	$self->{term}->bind_action ($hotkey, $action)
854	}	1070	}
855		1071
856	sub x_resource {	1072	sub x_resource {
857	my ($self, $name) = @_;	1073	my ($self, $name) = @_;
858	$name =~ s/^%(\.\|$)/$_[0]{_name}$1/;	1074	$name =~ s/^%(\.\|$)/$_[0]{_name}$1/;
…		…
862	sub x_resource_boolean {	1078	sub x_resource_boolean {
863	my ($self, $name) = @_;	1079	my ($self, $name) = @_;
864	$name =~ s/^%(\.\|$)/$_[0]{_name}$1/;	1080	$name =~ s/^%(\.\|$)/$_[0]{_name}$1/;
865	$self->{term}->x_resource_boolean ($name)	1081	$self->{term}->x_resource_boolean ($name)
866	}	1082	}
		1083
		1084	=back
		1085
		1086	=cut
867		1087
868	package urxvt::anyevent;	1088	package urxvt::anyevent;
869		1089
870	=head2 The C<urxvt::anyevent> Class	1090	=head2 The C<urxvt::anyevent> Class
871		1091
…		…
951		1171
952	package urxvt::term;	1172	package urxvt::term;
953		1173
954	=head2 The C<urxvt::term> Class	1174	=head2 The C<urxvt::term> Class
955		1175
956	=over 4	1176	=over
957		1177
958	=cut	1178	=cut
959		1179
960	# find on_xxx subs in the package and register them	1180	# find on_xxx subs in the package and register them
961	# as hooks	1181	# as hooks
…		…
982	$proxy->enable ($name => $ref);	1202	$proxy->enable ($name => $ref);
983	}	1203	}
984	}	1204	}
985	}	1205	}
986		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
987	sub perl_libdirs {	1231	sub perl_libdirs {
988	map { split /:/ }	1232	map { split /:/ }
989	$_[0]->resource ("perl_lib"),	1233	$_[0]->resource ("perl_lib"),
990	$ENV{URXVT_PERL_LIB},	1234	$ENV{URXVT_PERL_LIB},
991	"$ENV{HOME}/.urxvt/ext",	1235	"$ENV{HOME}/.urxvt/ext",
992	"$LIBDIR/perl"	1236	"$LIBDIR/perl"
993	}	1237	}
994		1238
995	sub scan_meta {	1239	# scan for available extensions and collect their metadata
		1240	sub scan_extensions {
996	my ($self) = @_;	1241	my ($self) = @_;
		1242
		1243	return if exists $self->{meta};
		1244
997	my @libdirs = perl_libdirs $self;	1245	my @urxvtdirs = perl_libdirs $self;
		1246	# my @cpandirs = grep -d, map "$_/URxvt/Ext", @INC;
998		1247
999	return if $self->{meta_libdirs} eq join "\x00", @libdirs;
1000
1001	my %meta;
1002
1003	$self->{meta_libdirs} = join "\x00", @libdirs;
1004	$self->{meta} = \%meta;	1248	$self->{meta} = \my %allmeta;
1005		1249
1006	for my $dir (reverse @libdirs) {	1250	# first gather extensions
		1251
		1252	my $gather = sub {
		1253	my ($dir, $core) = @_;
		1254
1007	opendir my $fh, $dir	1255	opendir my $fh, $dir
1008	or next;	1256	or return;
		1257
1009	for my $ext (readdir $fh) {	1258	for my $ext (readdir $fh) {
1010	$ext ne "."	1259	$ext !~ /^\./
1011	and $ext ne ".."
1012	and open my $fh, "<", "$dir/$ext"
1013	or next;	1260	or next;
1014		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
1015	while (<$fh>) {	1273	while (<$fh>) {
1016	if (/^#:META:X_RESOURCE:(.*)/) {	1274	if (/^#:META:(?:X_)?RESOURCE:(.*)/) {
1017	my ($pattern, $type, $desc) = split /:/, $1;	1275	my ($pattern, $type, $desc) = split /:/, $1;
1018	$pattern =~ s/^%(\.\|$)/$ext$1/g; # % in pattern == extension name	1276	$pattern =~ s/^%(\.\|$)/$ext$1/g; # % in pattern == extension name
1019	if ($pattern =~ /[^a-zA-Z0-9\-\.]/) {	1277	if ($pattern =~ /[^a-zA-Z0-9\-\.]/) {
1020	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";
1021	} else {	1279	} else {
1022	$meta{resource}{$pattern} = [$ext, $type, $desc];	1280	$meta{resource}{$pattern} = [$ext, $type, $desc];
1023	}	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
1024	} elsif (/^\s*(?:#\|$)/) {	1289	} elsif (/^\s*(?:#\|$)/) {
1025	# skip other comments and empty lines	1290	# skip other comments and empty lines
		1291
1026	} else {	1292	} else {
1027	last; # stop parsing on first non-empty non-comment line	1293	last; # stop parsing on first non-empty non-comment line
1028	}	1294	}
1029	}	1295	}
		1296
		1297	$allmeta{ext}{$ext} = \%meta;
1030	}	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} });
1031	}	1311	}
1032	}	1312	}
1033		1313
1034	=item $term = new urxvt::term $envhashref, $rxvtname, [arg...]	1314	=item $term = new urxvt::term $envhashref, $rxvtname, [arg...]
1035		1315
…		…
1055	}	1335	}
1056		1336
1057	=item $term->destroy	1337	=item $term->destroy
1058		1338
1059	Destroy the terminal object (close the window, free resources	1339	Destroy the terminal object (close the window, free resources
1060	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
1061	watchers (timers, io watchers) are still active.	1341	watchers (timers, io watchers) are still active.
1062		1342
1063	=item $term->exec_async ($cmd[, @args])	1343	=item $term->exec_async ($cmd[, @args])
1064		1344
1065	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
…		…
1098	insecure intensityStyles iso14755 iso14755_52 jumpScroll loginShell	1378	insecure intensityStyles iso14755 iso14755_52 jumpScroll loginShell
1099	mapAlert meta8 mouseWheelScrollPage override_redirect pastableTabs	1379	mapAlert meta8 mouseWheelScrollPage override_redirect pastableTabs
1100	pointerBlank reverseVideo scrollBar scrollBar_floating scrollBar_right	1380	pointerBlank reverseVideo scrollBar scrollBar_floating scrollBar_right
1101	scrollTtyKeypress scrollTtyOutput scrollWithBuffer secondaryScreen	1381	scrollTtyKeypress scrollTtyOutput scrollWithBuffer secondaryScreen
1102	secondaryScroll skipBuiltinGlyphs skipScroll transparent tripleclickwords	1382	secondaryScroll skipBuiltinGlyphs skipScroll transparent tripleclickwords
1103	urgentOnBell utmpInhibit visualBell	1383	urgentOnBell utmpInhibit visualBell disablePasteBrackets
1104		1384
1105	=item $value = $term->resource ($name[, $newval])	1385	=item $value = $term->resource ($name[, $newval])
1106		1386
1107	Returns the current resource value associated with a given name and	1387	Returns the current resource value associated with a given name and
1108	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>
…		…
1134	preeditType print_pipe pty_fd reverseVideo saveLines scrollBar	1414	preeditType print_pipe pty_fd reverseVideo saveLines scrollBar
1135	scrollBar_align scrollBar_floating scrollBar_right scrollBar_thickness	1415	scrollBar_align scrollBar_floating scrollBar_right scrollBar_thickness
1136	scrollTtyKeypress scrollTtyOutput scrollWithBuffer scrollstyle	1416	scrollTtyKeypress scrollTtyOutput scrollWithBuffer scrollstyle
1137	secondaryScreen secondaryScroll shade skipBuiltinGlyphs skipScroll	1417	secondaryScreen secondaryScroll shade skipBuiltinGlyphs skipScroll
1138	term_name title transient_for transparent tripleclickwords urgentOnBell	1418	term_name title transient_for transparent tripleclickwords urgentOnBell
1139	utmpInhibit visualBell	1419	utmpInhibit visualBell rewrapMode disablePasteBrackets
1140		1420
1141	=cut	1421	=cut
1142		1422
1143	sub resource($$;$) {	1423	sub resource($$;$) {
1144	my ($self, $name) = (shift, shift);	1424	my ($self, $name) = (shift, shift);
…		…
1151	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
1152	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
1153	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
1154	resource with that pattern exists.	1434	resource with that pattern exists.
1155		1435
1156	Extensions that define extra resource or command line arguments also need	1436	Extensions that define extra resources also need to call this method
1157	to call this method to access their values.	1437	to access their values.
1158		1438
1159	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
1160	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
1161	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
1162	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
1163	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
1164	without having to change the actual code.	1444	the actual code.
1165		1445
1166	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
1167	only one resource database per display, and later invocations might return	1447	only one resource database per display, and later invocations might return
1168	the wrong resources.	1448	the wrong resources.
1169		1449
…		…
1181	my $res = &x_resource;	1461	my $res = &x_resource;
1182		1462
1183	$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
1184	}	1464	}
1185		1465
1186	=item $success = $term->parse_keysym ($key, $octets)	1466	=item $action = $term->lookup_keysym ($keysym, $state)
1187		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
1188	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
1189	C<keysym> resource in the @@RXVT_NAME@@(1) manpage.	1474	C<keysym> resource in the urxvt(1) manpage.
1190		1475
1191	=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.
1192		1480
1193	Adds a key binding. This is a lower level api compared to	1481	Example: the C<searchable-scrollback> by default binds itself
1194	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<<
1195	used only inside either the C<on_init> hook, to add a binding, or the	1483	$term->bind_action >>.
1196	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	}
1197		1490
1198	=item $rend = $term->rstyle ([$new_rstyle])	1491	=item $rend = $term->rstyle ([$new_rstyle])
1199		1492
1200	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
1201	the terminal application will use this style.	1494	the terminal application will use this style.
…		…
1278	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
1279	as long as the perl object is referenced.	1572	as long as the perl object is referenced.
1280		1573
1281	The methods currently supported on C<urxvt::overlay> objects are:	1574	The methods currently supported on C<urxvt::overlay> objects are:
1282		1575
1283	=over 4	1576	=over
1284		1577
1285	=item $overlay->set ($x, $y, $text[, $rend])	1578	=item $overlay->set ($x, $y, $text[, $rend])
1286		1579
1287	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
1288	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
…		…
1359		1652
1360	=item $term->scr_add_lines ($string)	1653	=item $term->scr_add_lines ($string)
1361		1654
1362	Write the given text string to the screen, as if output by the application	1655	Write the given text string to the screen, as if output by the application
1363	running inside the terminal. It may not contain command sequences (escape	1656	running inside the terminal. It may not contain command sequences (escape
1364	codes), but is free to use line feeds, carriage returns and tabs. The	1657	codes - see C<cmd_parse> for that), but is free to use line feeds,
1365	string is a normal text string, not in locale-dependent encoding.	1658	carriage returns and tabs. The string is a normal text string, not in
		1659	locale-dependent encoding.
1366		1660
1367	Normally its not a good idea to use this function, as programs might be	1661	Normally its not a good idea to use this function, as programs might be
1368	confused by changes in cursor position or scrolling. Its useful inside a	1662	confused by changes in cursor position or scrolling. Its useful inside a
1369	C<on_add_lines> hook, though.	1663	C<on_add_lines> hook, though.
1370		1664
…		…
1378	locale-specific encoding of the terminal and can contain command sequences	1672	locale-specific encoding of the terminal and can contain command sequences
1379	(escape codes) that will be interpreted.	1673	(escape codes) that will be interpreted.
1380		1674
1381	=item $term->tt_write ($octets)	1675	=item $term->tt_write ($octets)
1382		1676
1383	Write the octets given in C<$octets> to the tty (i.e. as program input). To	1677	Write the octets given in C<$octets> to the tty (i.e. as user input
		1678	to the program, see C<cmd_parse> for the opposite direction). To pass
1384	pass characters instead of octets, you should convert your strings first	1679	characters instead of octets, you should convert your strings first to the
1385	to the locale-specific encoding using C<< $term->locale_encode >>.	1680	locale-specific encoding using C<< $term->locale_encode >>.
		1681
		1682	=item $term->tt_write_user_input ($octets)
		1683
		1684	Like C<tt_write>, but should be used when writing strings in response to
		1685	the user pressing a key, to invoke the additional actions requested by
		1686	the user for that case (C<tt_write> doesn't do that).
		1687
		1688	The typical use case would be inside C<on_action> hooks.
1386		1689
1387	=item $term->tt_paste ($octets)	1690	=item $term->tt_paste ($octets)
1388		1691
1389	Write the octets given in C<$octets> to the tty as a paste, converting NL to	1692	Write the octets given in C<$octets> to the tty as a paste, converting NL to
1390	CR and bracketing the data with control sequences if bracketed paste mode	1693	CR and bracketing the data with control sequences if bracketed paste mode
…		…
1429		1732
1430	=item $term->key_release ($state, $keycode[, $time])	1733	=item $term->key_release ($state, $keycode[, $time])
1431		1734
1432	Deliver various fake events to to terminal.	1735	Deliver various fake events to to terminal.
1433		1736
1434	=item $window_width = $term->width	1737	=item $window_width = $term->width ([$new_value])
1435		1738
1436	=item $window_height = $term->height	1739	=item $window_height = $term->height ([$new_value])
1437		1740
1438	=item $font_width = $term->fwidth	1741	=item $font_width = $term->fwidth ([$new_value])
1439		1742
1440	=item $font_height = $term->fheight	1743	=item $font_height = $term->fheight ([$new_value])
1441		1744
1442	=item $font_ascent = $term->fbase	1745	=item $font_ascent = $term->fbase ([$new_value])
1443		1746
1444	=item $terminal_rows = $term->nrow	1747	=item $terminal_rows = $term->nrow ([$new_value])
1445		1748
1446	=item $terminal_columns = $term->ncol	1749	=item $terminal_columns = $term->ncol ([$new_value])
1447		1750
1448	=item $has_focus = $term->focus	1751	=item $has_focus = $term->focus ([$new_value])
1449		1752
1450	=item $is_mapped = $term->mapped	1753	=item $is_mapped = $term->mapped ([$new_value])
1451		1754
1452	=item $max_scrollback = $term->saveLines	1755	=item $max_scrollback = $term->saveLines ([$new_value])
1453		1756
1454	=item $nrow_plus_saveLines = $term->total_rows	1757	=item $nrow_plus_saveLines = $term->total_rows ([$new_value])
1455		1758
1456	=item $topmost_scrollback_row = $term->top_row	1759	=item $topmost_scrollback_row = $term->top_row ([$new_value])
1457		1760
1458	Return various integers describing terminal characteristics.	1761	Return various integers describing terminal characteristics. If an
		1762	argument is given, changes the value and returns the previous one.
1459		1763
1460	=item $x_display = $term->display_id	1764	=item $x_display = $term->display_id
1461		1765
1462	Return the DISPLAY used by rxvt-unicode.	1766	Return the DISPLAY used by rxvt-unicode.
1463		1767
…		…
1500		1804
1501	=item $cursor_is_hidden = $term->hidden_cursor	1805	=item $cursor_is_hidden = $term->hidden_cursor
1502		1806
1503	Returns whether the cursor is currently hidden or not.	1807	Returns whether the cursor is currently hidden or not.
1504		1808
		1809	=item $priv_modes = $term->priv_modes
		1810
		1811	Returns a bitset with the state of DEC private modes.
		1812
		1813	Example:
		1814
		1815	if ($term->priv_modes & urxvt::PrivMode_mouse_report) {
		1816	# mouse reporting is turned on
		1817	}
		1818
1505	=item $view_start = $term->view_start ([$newvalue])	1819	=item $view_start = $term->view_start ([$newvalue])
1506		1820
1507	Returns the row number of the topmost displayed line. Maximum value is	1821	Returns the row number of the topmost displayed line and changes it,
1508	C<0>, which displays the normal terminal contents. Lower values scroll	1822	if an argument is given. Values greater than or equal to C<0> display
1509	this many lines into the scrollback buffer.	1823	the terminal contents. Lower values scroll this many lines into the
		1824	scrollback buffer.
1510		1825
1511	=item $term->want_refresh	1826	=item $term->want_refresh
1512		1827
1513	Requests a screen refresh. At the next opportunity, rxvt-unicode will	1828	Requests a screen refresh. At the next opportunity, rxvt-unicode will
1514	compare the on-screen display with its stored representation. If they	1829	compare the on-screen display with its stored representation. If they
1515	differ, it redraws the differences.	1830	differ, it redraws the differences.
1516		1831
1517	Used after changing terminal contents to display them.	1832	Used after changing terminal contents to display them.
		1833
		1834	=item $term->refresh_check
		1835
		1836	Checks if a refresh has been requested and, if so, schedules one.
1518		1837
1519	=item $text = $term->ROW_t ($row_number[, $new_text[, $start_col]])	1838	=item $text = $term->ROW_t ($row_number[, $new_text[, $start_col]])
1520		1839
1521	Returns the text of the entire row with number C<$row_number>. Row C<< $term->top_row >>	1840	Returns the text of the entire row with number C<$row_number>. Row C<< $term->top_row >>
1522	is the topmost terminal line, row C<< $term->nrow-1 >> is the bottommost	1841	is the topmost terminal line, row C<< $term->nrow-1 >> is the bottommost
…		…
1568		1887
1569	Create and return a new C<urxvt::line> object that stores information	1888	Create and return a new C<urxvt::line> object that stores information
1570	about the logical line that row C<$row_number> is part of. It supports the	1889	about the logical line that row C<$row_number> is part of. It supports the
1571	following methods:	1890	following methods:
1572		1891
1573	=over 4	1892	=over
1574		1893
1575	=item $text = $line->t ([$new_text])	1894	=item $text = $line->t ([$new_text])
1576		1895
1577	Returns or replaces the full text of the line, similar to C<ROW_t>	1896	Returns or replaces the full text of the line, similar to C<ROW_t>
1578		1897
…		…
1624	}	1943	}
1625		1944
1626	sub urxvt::line::t {	1945	sub urxvt::line::t {
1627	my ($self) = @_;	1946	my ($self) = @_;
1628		1947
1629	if (@_ > 1)	1948	if (@_ > 1) {
1630	{
1631	$self->{term}->ROW_t ($_, $_[1], 0, ($_ - $self->{beg}) * $self->{ncol}, $self->{ncol})	1949	$self->{term}->ROW_t ($_, $_[1], 0, ($_ - $self->{beg}) * $self->{ncol}, $self->{ncol})
1632	for $self->{beg} .. $self->{end};	1950	for $self->{beg} .. $self->{end};
1633	}	1951	}
1634		1952
1635	defined wantarray &&	1953	defined wantarray &&
1636	substr +(join "", map $self->{term}->ROW_t ($_), $self->{beg} .. $self->{end}),	1954	substr +(join "", map $self->{term}->ROW_t ($_), $self->{beg} .. $self->{end}),
1637	0, $self->{len}	1955	0, $self->{len}
1638	}	1956	}
1639		1957
1640	sub urxvt::line::r {	1958	sub urxvt::line::r {
1641	my ($self) = @_;	1959	my ($self) = @_;
1642		1960
1643	if (@_ > 1)	1961	if (@_ > 1) {
1644	{
1645	$self->{term}->ROW_r ($_, $_[1], 0, ($_ - $self->{beg}) * $self->{ncol}, $self->{ncol})	1962	$self->{term}->ROW_r ($_, $_[1], 0, ($_ - $self->{beg}) * $self->{ncol}, $self->{ncol})
1646	for $self->{beg} .. $self->{end};	1963	for $self->{beg} .. $self->{end};
1647	}	1964	}
1648		1965
1649	if (defined wantarray) {	1966	if (defined wantarray) {
1650	my $rend = [	1967	my $rend = [
1651	map @{ $self->{term}->ROW_r ($_) }, $self->{beg} .. $self->{end}	1968	map @{ $self->{term}->ROW_r ($_) }, $self->{beg} .. $self->{end}
1652	];	1969	];
…		…
1684	where one character corresponds to one screen cell. See	2001	where one character corresponds to one screen cell. See
1685	C<< $term->ROW_t >> for details.	2002	C<< $term->ROW_t >> for details.
1686		2003
1687	=item $string = $term->special_decode $text	2004	=item $string = $term->special_decode $text
1688		2005
1689	Converts rxvt-unicodes text representation into a perl string. See	2006	Converts rxvt-unicode's text representation into a perl string. See
1690	C<< $term->ROW_t >> for details.	2007	C<< $term->ROW_t >> for details.
1691		2008
1692	=item $success = $term->grab_button ($button, $modifiermask[, $window = $term->vt])	2009	=item $success = $term->grab_button ($button, $modifiermask[, $window = $term->vt])
1693		2010
1694	=item $term->ungrab_button ($button, $modifiermask[, $window = $term->vt])	2011	=item $term->ungrab_button ($button, $modifiermask[, $window = $term->vt])
…		…
1760		2077
1761	package urxvt::popup;	2078	package urxvt::popup;
1762		2079
1763	=head2 The C<urxvt::popup> Class	2080	=head2 The C<urxvt::popup> Class
1764		2081
1765	=over 4	2082	=over
1766		2083
1767	=cut	2084	=cut
1768		2085
1769	sub add_item {	2086	sub add_item {
1770	my ($self, $item) = @_;	2087	my ($self, $item) = @_;
…		…
1906	->cb (sub {	2223	->cb (sub {
1907	$term->{overlay}->set (0, 0,	2224	$term->{overlay}->set (0, 0,
1908	sprintf "%2d:%02d:%02d", (localtime urxvt::NOW)[2,1,0]);	2225	sprintf "%2d:%02d:%02d", (localtime urxvt::NOW)[2,1,0]);
1909	});	2226	});
1910		2227
1911	=over 4	2228	=over
1912		2229
1913	=item $timer = new urxvt::timer	2230	=item $timer = new urxvt::timer
1914		2231
1915	Create a new timer object in started state. It is scheduled to fire	2232	Create a new timer object in started state. It is scheduled to fire
1916	immediately.	2233	immediately.
…		…
1965	sysread $term->{socket}, my $buf, 8192	2282	sysread $term->{socket}, my $buf, 8192
1966	or end-of-file;	2283	or end-of-file;
1967	});	2284	});
1968		2285
1969		2286
1970	=over 4	2287	=over
1971		2288
1972	=item $iow = new urxvt::iow	2289	=item $iow = new urxvt::iow
1973		2290
1974	Create a new io watcher object in stopped state.	2291	Create a new io watcher object in stopped state.
1975		2292
…		…
2002		2319
2003	This class implements idle watchers, that get called automatically when	2320	This class implements idle watchers, that get called automatically when
2004	the process is idle. They should return as fast as possible, after doing	2321	the process is idle. They should return as fast as possible, after doing
2005	some useful work.	2322	some useful work.
2006		2323
2007	=over 4	2324	=over
2008		2325
2009	=item $iw = new urxvt::iw	2326	=item $iw = new urxvt::iw
2010		2327
2011	Create a new idle watcher object in stopped state.	2328	Create a new idle watcher object in stopped state.
2012		2329
…		…
2037	->cb (sub {	2354	->cb (sub {
2038	my ($pw, $exit_status) = @_;	2355	my ($pw, $exit_status) = @_;
2039	...	2356	...
2040	});	2357	});
2041		2358
2042	=over 4	2359	=over
2043		2360
2044	=item $pw = new urxvt::pw	2361	=item $pw = new urxvt::pw
2045		2362
2046	Create a new process watcher in stopped state.	2363	Create a new process watcher in stopped state.
2047		2364
…		…
2064	=head2 URXVT_PERL_VERBOSITY	2381	=head2 URXVT_PERL_VERBOSITY
2065		2382
2066	This variable controls the verbosity level of the perl extension. Higher	2383	This variable controls the verbosity level of the perl extension. Higher
2067	numbers indicate more verbose output.	2384	numbers indicate more verbose output.
2068		2385
2069	=over 4	2386	=over
2070		2387
2071	=item == 0 - fatal messages	2388	=item == 0 - fatal messages only
		2389
		2390	=item >= 2 - general warnings (default level)
2072		2391
2073	=item >= 3 - script loading and management	2392	=item >= 3 - script loading and management
2074		2393
2075	=item >=10 - all called hooks	2394	=item >=10 - all called hooks
2076		2395

Diff Legend

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

Comparing rxvt-unicode/src/urxvt.pm (file contents): Revision 1.219 by sf-exg, Sun Jun 10 18:23:18 2012 UTC vs. Revision 1.268 by root, Sat Jul 24 13:07:56 2021 UTC

Diff Legend

Comparing rxvt-unicode/src/urxvt.pm (file contents):
Revision 1.219 by sf-exg, Sun Jun 10 18:23:18 2012 UTC vs.
Revision 1.268 by root, Sat Jul 24 13:07:56 2021 UTC