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

Comparing rxvt-unicode/src/urxvt.pm (file contents):
Revision 1.218 by root, Sun Jun 10 17:31:53 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 vewiwed	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	laoded 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
		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.
144		213
145	=item on_init $term	214	=item on_init $term
146		215
147	Called after a new terminal object has been initialized, but before	216	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	217	windows are created or the command gets run. Most methods are unsafe to
…		…
230		299
231	C<on_osc_seq_perl> should be used for new behaviour.	300	C<on_osc_seq_perl> should be used for new behaviour.
232		301
233	=item on_osc_seq_perl $term, $args, $resp	302	=item on_osc_seq_perl $term, $args, $resp
234		303
235	Called whenever the B<ESC ] 777 ; string ST> command sequence (OSC =	304	Called whenever the B<ESC ] 777 ; prefix ; string ST> command sequence
236	operating system command) is processed. Cursor position and other state	305	(OSC = operating system command) is processed. Cursor position and other
237	information is up-to-date when this happens. For interoperability, the	306	state information is up-to-date when this happens. For interoperability,
238	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
239	to distinguish it from commands for other extensions, and this might be	308	other suitable prefix, and a semicolon, to distinguish it from commands
240	enforced in the future.	309	for other extensions.
241		310
242	For example, C<overlay-osc> uses this:	311	For example, C<overlay-osc> uses this:
243		312
244	sub on_osc_seq_perl {	313	sub on_osc_seq_perl {
245	my ($self, $osc, $resp) = @_;	314	my ($self, $osc, $resp) = @_;
…		…
299		368
300	=item on_refresh_end $term	369	=item on_refresh_end $term
301		370
302	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>.
303		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
304	=item on_user_command $term, $string	381	=item on_user_command $term, $string DEPRECATED
305		382
306	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
307	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>
308	resource in the @@RXVT_NAME@@(1) manpage).	385	resource in the urxvt(1) manpage).
309		386
310	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
311	slightly in the future.	388	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		389
320	=item on_resize_all_windows $term, $new_width, $new_height	390	=item on_resize_all_windows $term, $new_width, $new_height
321		391
322	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
323	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
324	returns TRUE, setting of the window hints is being skipped.	394	returns a true value, setting of the window hints is being skipped.
325		395
326	=item on_x_event $term, $event	396	=item on_x_event $term, $event
327		397
328	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
329	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
…		…
369	(real, not screen-based) row and column under the mouse cursor.	439	(real, not screen-based) row and column under the mouse cursor.
370		440
371	C<on_key_press> additionally receives the string rxvt-unicode would	441	C<on_key_press> additionally receives the string rxvt-unicode would
372	output, if any, in locale-specific encoding.	442	output, if any, in locale-specific encoding.
373		443
374	subwindow.
375
376	=item on_client_message $term, $event	444	=item on_client_message $term, $event
377		445
378	=item on_wm_protocols $term, $event	446	=item on_wm_protocols $term, $event
379		447
380	=item on_wm_delete_window $term, $event	448	=item on_wm_delete_window $term, $event
…		…
391	=cut	459	=cut
392		460
393	package urxvt;	461	package urxvt;
394		462
395	use utf8;	463	use utf8;
396	use strict 'vars';	464	use strict qw(vars subs);
397	use Carp ();	465	use Carp ();
398	use Scalar::Util ();	466	use Scalar::Util ();
399	use List::Util ();	467	use List::Util ();
400		468
401	our $VERSION = 1;	469	our $VERSION = 1;
…		…
413		481
414	our $NOCHAR = chr 0xffff;	482	our $NOCHAR = chr 0xffff;
415		483
416	=head2 Variables in the C<urxvt> Package	484	=head2 Variables in the C<urxvt> Package
417		485
418	=over 4	486	=over
419		487
420	=item $urxvt::LIBDIR	488	=item $urxvt::LIBDIR
421		489
422	The rxvt-unicode library directory, where, among other things, the perl	490	The rxvt-unicode library directory, where, among other things, the perl
423	modules and scripts are stored.	491	modules and scripts are stored.
…		…
453		521
454	=back	522	=back
455		523
456	=head2 Functions in the C<urxvt> Package	524	=head2 Functions in the C<urxvt> Package
457		525
458	=over 4	526	=over
459		527
460	=item urxvt::fatal $errormessage	528	=item urxvt::fatal $errormessage
461		529
462	Fatally aborts execution with the given error message (which should	530	Fatally aborts execution with the given error message (which should
463	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
…		…
508	CirculateRequest, PropertyNotify, SelectionClear, SelectionRequest,	576	CirculateRequest, PropertyNotify, SelectionClear, SelectionRequest,
509	SelectionNotify, ColormapNotify, ClientMessage, MappingNotify	577	SelectionNotify, ColormapNotify, ClientMessage, MappingNotify
510		578
511	Various constants for use in X calls and event processing.	579	Various constants for use in X calls and event processing.
512		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
513	=back	593	=back
514		594
515	=head2 RENDITION	595	=head2 RENDITION
516		596
517	Rendition bitsets contain information about colour, font, font styles and	597	Rendition bitsets contain information about colour, font, font styles and
…		…
520	The following "macros" deal with changes in rendition sets. You should	600	The following "macros" deal with changes in rendition sets. You should
521	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,
522	as they contain important information required for correct operation of	602	as they contain important information required for correct operation of
523	rxvt-unicode.	603	rxvt-unicode.
524		604
525	=over 4	605	=over
526		606
527	=item $rend = urxvt::DEFAULT_RSTYLE	607	=item $rend = urxvt::DEFAULT_RSTYLE
528		608
529	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
530	being reset. Useful as a base to start when creating renditions.	610	being reset. Useful as a base to start when creating renditions.
…		…
582	no warnings 'utf8';	662	no warnings 'utf8';
583		663
584	sub parse_resource {	664	sub parse_resource {
585	my ($term, $name, $isarg, $longopt, $flag, $value) = @_;	665	my ($term, $name, $isarg, $longopt, $flag, $value) = @_;
586		666
587	$name =~ y/-/./ if $isarg;
588
589	$term->scan_meta;	667	$term->scan_extensions;
590		668
		669	# iterating over all resources has quadratic time overhead
		670	# overall, maybe this could be optimised?
591	my $r = $term->{meta}{resource};	671	my $r = $term->{meta}{resource};
592	keys %$r; # reste iterator	672	keys %$r; # reset iterator
593	while (my ($pattern, $v) = each %$r) {	673	while (my ($k, $v) = each %$r) {
594	if (	674	my $pattern = $k;
		675	$pattern =~ y/./-/ if $isarg;
		676	my $prefix = $name;
		677	my $suffix;
595	$pattern =~ /\.$/	678	if ($pattern =~ /\-$/) {
596	? $pattern eq substr $name, 0, length $pattern	679	$prefix = substr $name, 0, length $pattern;
597	: $pattern eq $name	680	$suffix = substr $name, length $pattern;
598	) {	681	}
		682	if ($pattern eq $prefix) {
599	$name = "$urxvt::RESCLASS.$name";	683	$name = "$urxvt::RESCLASS.$k$suffix";
600		684
601	push @{ $term->{perl_ext_3} }, $v->[0];	685	push @{ $term->{perl_ext_3} }, $v->[0];
		686
		687	return 1 unless $isarg;
602		688
603	if ($v->[1] eq "boolean") {	689	if ($v->[1] eq "boolean") {
604	$term->put_option_db ($name, $flag ? "true" : "false");	690	$term->put_option_db ($name, $flag ? "true" : "false");
605	return 1;	691	return 1;
606	} else {	692	} else {
…		…
614	}	700	}
615		701
616	sub usage {	702	sub usage {
617	my ($term, $usage_type) = @_;	703	my ($term, $usage_type) = @_;
618		704
619	$term->scan_meta;	705	$term->scan_extensions;
620		706
621	my $r = $term->{meta}{resource};	707	my $r = $term->{meta}{resource};
622		708
623	for my $pattern (sort keys %$r) {	709	for my $pattern (sort keys %$r) {
624	my ($ext, $type, $desc) = @{ $r->{$pattern} };	710	my ($ext, $type, $desc) = @{ $r->{$pattern} };
…		…
639	urxvt::log sprintf " %-31s %s\n", "$pattern:", $type;	725	urxvt::log sprintf " %-31s %s\n", "$pattern:", $type;
640	}	726	}
641	}	727	}
642	}	728	}
643		729
644	my $verbosity = $ENV{URXVT_PERL_VERBOSITY};	730	my $verbosity = $ENV{URXVT_PERL_VERBOSITY} // 2;
645		731
646	sub verbose {	732	sub verbose {
647	my ($level, $msg) = @_;	733	my ($level, $msg) = @_;
648	warn "$msg\n" if $level <= $verbosity;	734	warn "$msg\n" if $level <= $verbosity;
649	}	735	}
…		…
666		752
667	open my $fh, "<:raw", $path	753	open my $fh, "<:raw", $path
668	or die "$path: $!";	754	or die "$path: $!";
669		755
670	my $source =	756	my $source =
671	"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"
672	. "#line 1 \"$path\"\n{\n"	758	. "#line 1 \"$path\"\n{\n"
673	. (do { local $/; <$fh> })	759	. (do { local $/; <$fh> })
674	. "\n};\n1";	760	. "\n};\n1";
675		761
676	eval $source	762	eval $source
…		…
685	# called by the rxvt core	771	# called by the rxvt core
686	sub invoke {	772	sub invoke {
687	local $TERM = shift;	773	local $TERM = shift;
688	my $htype = shift;	774	my $htype = shift;
689		775
690	if ($htype == 0) { # INIT	776	if ($htype == HOOK_INIT) {
691	my @dirs = $TERM->perl_libdirs;	777	$TERM->scan_extensions;
692		778
693	my %ext_arg;	779	my %ext_arg;
694		780
695	{	781	{
696	my @init = @TERM_INIT;	782	my @init = @TERM_INIT;
…		…
701	$TERM->register_package ($_) for @pkg;	787	$TERM->register_package ($_) for @pkg;
702	}	788	}
703		789
704	for (	790	for (
705	@{ delete $TERM->{perl_ext_3} },	791	@{ delete $TERM->{perl_ext_3} },
706	grep $_, map { split /,/, $TERM->resource ("perl_ext_$_") } 1, 2	792	(grep $_, map { split /,/, $TERM->resource ("perl_ext_$_") } 1, 2),
707	) {	793	) {
708	if ($_ eq "default") {	794	if ($_ eq "default") {
		795
		796	$ext_arg{$_} = []
709	$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
710	} elsif (/^-(.*)$/) {	808	} elsif (/^-(.*)$/) { # remove from set
711	delete $ext_arg{$1};	809	delete $ext_arg{$1};
712	} 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};
713	push @{ $ext_arg{$1} }, $2;	816	push @{ $ext_arg{$1} }, defined $2 ? $2 : ();
		817
714	} else {	818	} else {
715	$ext_arg{$_} \|\|= [];	819	verbose 2, "cannot parse extension specification '$_', ignoring.";
716	}	820	}
717	}	821	}
718		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
719	for my $ext (sort keys %ext_arg) {	826	for my $ext (sort keys %ext_arg) {
720	my @files = grep -f $_, map "$_/$ext", @dirs;	827	my $path = $TERM->extension_path ($ext);
721		828
722	if (@files) {	829	if (defined $path) {
723	$TERM->register_package (extension_package $files[0], $ext_arg{$ext});	830	$TERM->autoload_extension ($ext, $ext_arg{$ext});
724	} else {	831	} else {
725	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";
726	}	833	}
727	}	834	}
728		835
729	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");
730	warn $@ if $@;	837	warn $@ if $@;
731	}	838	}
732		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
733	$retval = undef;	850	$retval = undef;
734		851
735	if (my $cb = $TERM->{_hook}[$htype]) {	852	if (my $cb = $TERM->{_hook}[$htype]) {
736	verbose 10, "$HOOKNAME[$htype] (" . (join ", ", $TERM, @_) . ")"	853	verbose 10, "$HOOKNAME[$htype] (" . (join ", ", $TERM, @_) . ")"
737	if $verbosity >= 10;	854	if $verbosity >= 10;
738		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	}
		868
739	for my $pkg (keys %$cb) {	869	for my $pkg (keys %$cb) {
740	my $retval_ = eval { $cb->{$pkg}->($TERM->{_pkg}{$pkg}, @_) };	870	my $retval_ = eval { $cb->{$pkg}->($TERM->{_pkg}{$pkg} \|\| $TERM, @_) };
741	$retval \|\|= $retval_;	871	$retval \|\|= $retval_;
742		872
743	if ($@) {	873	if ($@) {
744	$TERM->ungrab; # better to lose the grab than the session	874	$TERM->ungrab; # better to lose the grab than the session
745	warn $@;	875	warn $@;
…		…
748		878
749	verbose 11, "$HOOKNAME[$htype] returning <$retval>"	879	verbose 11, "$HOOKNAME[$htype] returning <$retval>"
750	if $verbosity >= 11;	880	if $verbosity >= 11;
751	}	881	}
752		882
753	if ($htype == 1) { # DESTROY	883	if ($htype == HOOK_DESTROY) {
754	# clear package objects	884	# clear package objects
755	%$_ = () for values %{ $TERM->{_pkg} };	885	%$_ = () for values %{ $TERM->{_pkg} };
756		886
757	# clear package	887	# clear package
758	%$TERM = ();	888	%$TERM = ();
…		…
790	($mask, @color{qw(fg bg)}, \@failed)	920	($mask, @color{qw(fg bg)}, \@failed)
791	}	921	}
792		922
793	package urxvt::term::extension;	923	package urxvt::term::extension;
794		924
795	sub enable {	925	=head2 The C<urxvt::term::extension> class
796	my ($self, %hook) = @_;
797	my $pkg = $self->{_pkg};
798		926
799	while (my ($name, $cb) = each %hook) {	927	Each extension attached to a terminal object is represented by
800	my $htype = $HOOKTYPE{uc $name};	928	a C<urxvt::term::extension> object.
801	defined $htype
802	or Carp::croak "unsupported hook type '$name'";
803		929
804	$self->set_should_invoke ($htype, +1)	930	You can use these objects, which are passed to all callbacks to store any
805	unless exists $self->{term}{_hook}[$htype]{$pkg};	931	state related to the terminal and extension instance.
806		932
807	$self->{term}{_hook}[$htype]{$pkg} = $cb;	933	The methods (And data members) documented below can be called on extension
808	}	934	objects, in addition to call methods documented for the <urxvt::term>
809	}	935	class.
810		936
811	sub disable {	937	=over
812	my ($self, @hook) = @_;
813	my $pkg = $self->{_pkg};
814		938
815	for my $name (@hook) {	939	=item $urxvt_term = $self->{term}
816	my $htype = $HOOKTYPE{uc $name};
817	defined $htype
818	or Carp::croak "unsupported hook type '$name'";
819		940
820	$self->set_should_invoke ($htype, -1)	941	Returns the C<urxvt::term> object associated with this instance of the
821	if delete $self->{term}{_hook}[$htype]{$pkg};	942	extension. This member I<must not> be changed in any way.
822	}	943
823	}	944	=cut
824		945
825	our $AUTOLOAD;	946	our $AUTOLOAD;
826		947
827	sub AUTOLOAD {	948	sub AUTOLOAD {
828	$AUTOLOAD =~ /:([^:]+)$/	949	$AUTOLOAD =~ /:([^:]+)$/
…		…
841		962
842	sub DESTROY {	963	sub DESTROY {
843	# nop	964	# nop
844	}	965	}
845		966
846	# urxvt::destroy_hook	967	# urxvt::destroy_hook (basically a cheap Guard:: implementation)
847		968
848	sub urxvt::destroy_hook::DESTROY {	969	sub urxvt::destroy_hook::DESTROY {
849	${$_[0]}->();	970	${$_[0]}->();
850	}	971	}
851		972
852	sub urxvt::destroy_hook(&) {	973	sub urxvt::destroy_hook(&) {
853	bless \shift, urxvt::destroy_hook::	974	bless \shift, urxvt::destroy_hook::
		975	}
		976
		977	=item $self->enable ($hook_name => $cb[, $hook_name => $cb..])
		978
		979	Dynamically enable the given hooks (named without the C<on_> prefix) for
		980	this extension, replacing any hook previously installed via C<enable> in
		981	this extension.
		982
		983	This is useful when you want to overwrite time-critical hooks only
		984	temporarily.
		985
		986	To install additional callbacks for the same hook, you can use the C<on>
		987	method of the C<urxvt::term> class.
		988
		989	=item $self->disable ($hook_name[, $hook_name..])
		990
		991	Dynamically disable the given hooks.
		992
		993	=cut
		994
		995	sub enable {
		996	my ($self, %hook) = @_;
		997	my $pkg = $self->{_pkg};
		998
		999	while (my ($name, $cb) = each %hook) {
		1000	my $htype = $HOOKTYPE{uc $name};
		1001	defined $htype
		1002	or Carp::croak "unsupported hook type '$name'";
		1003
		1004	$self->set_should_invoke ($htype, +1)
		1005	unless exists $self->{term}{_hook}[$htype]{$pkg};
		1006
		1007	$self->{term}{_hook}[$htype]{$pkg} = $cb;
		1008	}
		1009	}
		1010
		1011	sub disable {
		1012	my ($self, @hook) = @_;
		1013	my $pkg = $self->{_pkg};
		1014
		1015	for my $name (@hook) {
		1016	my $htype = $HOOKTYPE{uc $name};
		1017	defined $htype
		1018	or Carp::croak "unsupported hook type '$name'";
		1019
		1020	$self->set_should_invoke ($htype, -1)
		1021	if delete $self->{term}{_hook}[$htype]{$pkg};
		1022	}
		1023	}
		1024
		1025	=item $guard = $self->on ($hook_name => $cb[, $hook_name => $cb..])
		1026
		1027	Similar to the C<enable> enable, but installs additional callbacks for
		1028	the given hook(s) (that is, it doesn't replace existing callbacks), and
		1029	returns a guard object. When the guard object is destroyed the callbacks
		1030	are disabled again.
		1031
		1032	=cut
		1033
		1034	sub urxvt::extension::on_disable::DESTROY {
		1035	my $disable = shift;
		1036
		1037	my $term = delete $disable->{""};
		1038
		1039	while (my ($htype, $id) = each %$disable) {
		1040	delete $term->{_hook}[$htype]{$id};
		1041	$term->set_should_invoke ($htype, -1);
		1042	}
		1043	}
		1044
		1045	sub on {
		1046	my ($self, %hook) = @_;
		1047
		1048	my $term = $self->{term};
		1049
		1050	my %disable = ( "" => $term );
		1051
		1052	while (my ($name, $cb) = each %hook) {
		1053	my $htype = $HOOKTYPE{uc $name};
		1054	defined $htype
		1055	or Carp::croak "unsupported hook type '$name'";
		1056
		1057	$term->set_should_invoke ($htype, +1);
		1058	$term->{_hook}[$htype]{ $disable{$htype} = $cb+0 }
		1059	= sub { shift; $cb->($self, @_) }; # very ugly indeed
		1060	}
		1061
		1062	bless \%disable, "urxvt::extension::on_disable"
		1063	}
		1064
		1065	=item $self->bind_action ($hotkey, $action)
		1066
		1067	=item $self->x_resource ($pattern)
		1068
		1069	=item $self->x_resource_boolean ($pattern)
		1070
		1071	These methods support an additional C<%> prefix for C<$action> or
		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
		1074	methods in the C<urxvt::term> class for details.
		1075
		1076	=cut
		1077
		1078	sub bind_action {
		1079	my ($self, $hotkey, $action) = @_;
		1080	$action =~ s/^%:/$_[0]{_name}:/;
		1081	$self->{term}->bind_action ($hotkey, $action)
854	}	1082	}
855		1083
856	sub x_resource {	1084	sub x_resource {
857	my ($self, $name) = @_;	1085	my ($self, $name) = @_;
858	$name =~ s/^%(\.\|$)/$_[0]{_name}$1/;	1086	$name =~ s/^%(\.\|$)/$_[0]{_name}$1/;
…		…
862	sub x_resource_boolean {	1090	sub x_resource_boolean {
863	my ($self, $name) = @_;	1091	my ($self, $name) = @_;
864	$name =~ s/^%(\.\|$)/$_[0]{_name}$1/;	1092	$name =~ s/^%(\.\|$)/$_[0]{_name}$1/;
865	$self->{term}->x_resource_boolean ($name)	1093	$self->{term}->x_resource_boolean ($name)
866	}	1094	}
		1095
		1096	=back
		1097
		1098	=cut
867		1099
868	package urxvt::anyevent;	1100	package urxvt::anyevent;
869		1101
870	=head2 The C<urxvt::anyevent> Class	1102	=head2 The C<urxvt::anyevent> Class
871		1103
…		…
951		1183
952	package urxvt::term;	1184	package urxvt::term;
953		1185
954	=head2 The C<urxvt::term> Class	1186	=head2 The C<urxvt::term> Class
955		1187
956	=over 4	1188	=over
957		1189
958	=cut	1190	=cut
959		1191
960	# find on_xxx subs in the package and register them	1192	# find on_xxx subs in the package and register them
961	# as hooks	1193	# as hooks
962	sub register_package {	1194	sub register_package {
963	my ($self, $pkg, $argv) = @_;	1195	my ($self, $pkg, $argv) = @_;
		1196
		1197	return if $self->{_pkg}{$pkg};
964		1198
965	no strict 'refs';	1199	no strict 'refs';
966		1200
967	urxvt::verbose 6, "register package $pkg to $self";	1201	urxvt::verbose 6, "register package $pkg to $self";
968		1202
…		…
980	for my $name (@HOOKNAME) {	1214	for my $name (@HOOKNAME) {
981	if (my $ref = $pkg->can ("on_" . lc $name)) {	1215	if (my $ref = $pkg->can ("on_" . lc $name)) {
982	$proxy->enable ($name => $ref);	1216	$proxy->enable ($name => $ref);
983	}	1217	}
984	}	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);
985	}	1248	}
986		1249
987	sub perl_libdirs {	1250	sub perl_libdirs {
988	map { split /:/ }	1251	map { split /:/ }
989	$_[0]->resource ("perl_lib"),	1252	$_[0]->resource ("perl_lib"),
990	$ENV{URXVT_PERL_LIB},	1253	$ENV{URXVT_PERL_LIB},
991	"$ENV{HOME}/.urxvt/ext",	1254	"$ENV{HOME}/.urxvt/ext",
992	"$LIBDIR/perl"	1255	"$LIBDIR/perl"
993	}	1256	}
994		1257
995	sub scan_meta {	1258	# scan for available extensions and collect their metadata
		1259	sub scan_extensions {
996	my ($self) = @_;	1260	my ($self) = @_;
		1261
		1262	return if exists $self->{meta};
		1263
997	my @libdirs = perl_libdirs $self;	1264	my @urxvtdirs = perl_libdirs $self;
		1265	# my @cpandirs = grep -d, map "$_/URxvt/Ext", @INC;
998		1266
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;	1267	$self->{meta} = \my %allmeta;
1005		1268
1006	for my $dir (reverse @libdirs) {	1269	# first gather extensions
		1270
		1271	my $gather = sub {
		1272	my ($dir, $core) = @_;
		1273
1007	opendir my $fh, $dir	1274	opendir my $fh, $dir
1008	or next;	1275	or return;
		1276
1009	for my $ext (readdir $fh) {	1277	for my $ext (readdir $fh) {
1010	$ext ne "."	1278	$ext !~ /^\./
1011	and $ext ne ".."
1012	and open my $fh, "<", "$dir/$ext"
1013	or next;	1279	or next;
1014		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
1015	while (<$fh>) {	1292	while (<$fh>) {
1016	if (/^#:META:X_RESOURCE:(.*)/) {	1293	if (/^#:META:(?:X_)?RESOURCE:(.*)/) {
1017	my ($pattern, $type, $desc) = split /:/, $1;	1294	my ($pattern, $type, $desc) = split /:/, $1;
1018	$pattern =~ s/^%(\.\|$)/$ext$1/g; # % in pattern == extension name	1295	$pattern =~ s/^%(\.\|$)/$ext$1/g; # % in pattern == extension name
1019	if ($pattern =~ /[^a-zA-Z0-9\-\.]/) {	1296	if ($pattern =~ /[^a-zA-Z0-9\-\.]/) {
1020	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";
1021	} else {	1298	} else {
1022	$meta{resource}{$pattern} = [$ext, $type, $desc];	1299	$meta{resource}{$pattern} = [$ext, $type, $desc];
1023	}	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
1024	} elsif (/^\s*(?:#\|$)/) {	1308	} elsif (/^\s*(?:#\|$)/) {
1025	# skip other comments and empty lines	1309	# skip other comments and empty lines
		1310
1026	} else {	1311	} else {
1027	last; # stop parsing on first non-empty non-comment line	1312	last; # stop parsing on first non-empty non-comment line
1028	}	1313	}
1029	}	1314	}
		1315
		1316	$allmeta{ext}{$ext} = \%meta;
1030	}	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} });
1031	}	1330	}
1032	}	1331	}
1033		1332
1034	=item $term = new urxvt::term $envhashref, $rxvtname, [arg...]	1333	=item $term = new urxvt::term $envhashref, $rxvtname, [arg...]
1035		1334
…		…
1055	}	1354	}
1056		1355
1057	=item $term->destroy	1356	=item $term->destroy
1058		1357
1059	Destroy the terminal object (close the window, free resources	1358	Destroy the terminal object (close the window, free resources
1060	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
1061	watchers (timers, io watchers) are still active.	1360	watchers (timers, io watchers) are still active.
1062		1361
1063	=item $term->exec_async ($cmd[, @args])	1362	=item $term->exec_async ($cmd[, @args])
1064		1363
1065	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
1066	("starts") programs in the background. This function takes care of setting	1365	("starts") programs in the background. This function takes care of setting
1067	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
1068	be preferred over explicit calls to C<exec> or C<system>.	1367	be preferred over explicit calls to C<exec> or C<system>.
1069		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
1070	Returns the pid of the subprocess or C<undef> on error.	1373	Returns the pid of the subprocess or C<undef> on error.
1071		1374
1072	=cut	1375	=cut
1073		1376
1074	sub exec_async {	1377	sub exec_async {
…		…
1077	my $pid = fork;	1380	my $pid = fork;
1078		1381
1079	return $pid	1382	return $pid
1080	if !defined $pid or $pid;	1383	if !defined $pid or $pid;
1081		1384
		1385	%ENV = (
1082	%ENV = %{ $self->env };	1386	%{ $self->env },
		1387	URXVT_EXT_WINDOWID => $self->parent,
		1388	);
1083		1389
1084	exec @_;	1390	exec @_;
1085	urxvt::_exit 255;	1391	urxvt::_exit 255;
1086	}	1392	}
1087		1393
…		…
1098	insecure intensityStyles iso14755 iso14755_52 jumpScroll loginShell	1404	insecure intensityStyles iso14755 iso14755_52 jumpScroll loginShell
1099	mapAlert meta8 mouseWheelScrollPage override_redirect pastableTabs	1405	mapAlert meta8 mouseWheelScrollPage override_redirect pastableTabs
1100	pointerBlank reverseVideo scrollBar scrollBar_floating scrollBar_right	1406	pointerBlank reverseVideo scrollBar scrollBar_floating scrollBar_right
1101	scrollTtyKeypress scrollTtyOutput scrollWithBuffer secondaryScreen	1407	scrollTtyKeypress scrollTtyOutput scrollWithBuffer secondaryScreen
1102	secondaryScroll skipBuiltinGlyphs skipScroll transparent tripleclickwords	1408	secondaryScroll skipBuiltinGlyphs skipScroll transparent tripleclickwords
1103	urgentOnBell utmpInhibit visualBell	1409	urgentOnBell utmpInhibit visualBell disablePasteBrackets
1104		1410
1105	=item $value = $term->resource ($name[, $newval])	1411	=item $value = $term->resource ($name[, $newval])
1106		1412
1107	Returns the current resource value associated with a given name and	1413	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>	1414	optionally sets a new value. Setting values is most useful in the C<init>
…		…
1121		1427
1122	Here is a likely non-exhaustive list of resource names, not all of which	1428	Here is a likely non-exhaustive list of resource names, not all of which
1123	are supported in every build, please see the source file F</src/rsinc.h>	1429	are supported in every build, please see the source file F</src/rsinc.h>
1124	to see the actual list:	1430	to see the actual list:
1125		1431
1126	answerbackstring backgroundPixmap backspace_key blendtype blurradius	1432	answerbackstring backgroundPixmap backspace_key blurradius
1127	boldFont boldItalicFont borderLess buffered chdir color cursorBlink	1433	boldFont boldItalicFont borderLess buffered chdir color cursorBlink
1128	cursorUnderline cutchars delete_key depth display_name embed ext_bwidth	1434	cursorUnderline cutchars delete_key depth display_name embed ext_bwidth
1129	fade font geometry hold iconName iconfile imFont imLocale inputMethod	1435	fade font geometry hold iconName iconfile imFont imLocale inputMethod
1130	insecure int_bwidth intensityStyles iso14755 iso14755_52 italicFont	1436	insecure int_bwidth intensityStyles iso14755 iso14755_52 italicFont
1131	jumpScroll letterSpace lineSpace loginShell mapAlert meta8 modifier	1437	jumpScroll letterSpace lineSpace loginShell mapAlert meta8 modifier
…		…
1134	preeditType print_pipe pty_fd reverseVideo saveLines scrollBar	1440	preeditType print_pipe pty_fd reverseVideo saveLines scrollBar
1135	scrollBar_align scrollBar_floating scrollBar_right scrollBar_thickness	1441	scrollBar_align scrollBar_floating scrollBar_right scrollBar_thickness
1136	scrollTtyKeypress scrollTtyOutput scrollWithBuffer scrollstyle	1442	scrollTtyKeypress scrollTtyOutput scrollWithBuffer scrollstyle
1137	secondaryScreen secondaryScroll shade skipBuiltinGlyphs skipScroll	1443	secondaryScreen secondaryScroll shade skipBuiltinGlyphs skipScroll
1138	term_name title transient_for transparent tripleclickwords urgentOnBell	1444	term_name title transient_for transparent tripleclickwords urgentOnBell
1139	utmpInhibit visualBell	1445	utmpInhibit visualBell rewrapMode disablePasteBrackets
1140		1446
1141	=cut	1447	=cut
1142		1448
1143	sub resource($$;$) {	1449	sub resource($$;$) {
1144	my ($self, $name) = (shift, shift);	1450	my ($self, $name) = (shift, shift);
…		…
1151	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
1152	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
1153	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
1154	resource with that pattern exists.	1460	resource with that pattern exists.
1155		1461
1156	Extensions that define extra resource or command line arguments also need	1462	Extensions that define extra resources also need to call this method
1157	to call this method to access their values.	1463	to access their values.
1158		1464
1159	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
1160	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
1161	the extension and a dot, and the lone string C<%> will be replcaed by the	1467	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	1468	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	1469	can rename them and get a new set of resources without having to change
1164	without having to change the actual code.	1470	the actual code.
1165		1471
1166	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
1167	only one resource database per display, and later invocations might return	1473	only one resource database per display, and later invocations might return
1168	the wrong resources.	1474	the wrong resources.
1169		1475
…		…
1181	my $res = &x_resource;	1487	my $res = &x_resource;
1182		1488
1183	$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
1184	}	1490	}
1185		1491
1186	=item $success = $term->parse_keysym ($key, $octets)	1492	=item $action = $term->lookup_keysym ($keysym, $state)
1187		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
1188	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
1189	C<keysym> resource in the @@RXVT_NAME@@(1) manpage.	1500	C<keysym> resource in the urxvt(1) manpage.
1190		1501
1191	=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.
1192		1506
1193	Adds a key binding. This is a lower level api compared to	1507	Example: the C<searchable-scrollback> by default binds itself
1194	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<<
1195	used only inside either the C<on_init> hook, to add a binding, or the	1509	$term->bind_action >>.
1196	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	}
1197		1516
1198	=item $rend = $term->rstyle ([$new_rstyle])	1517	=item $rend = $term->rstyle ([$new_rstyle])
1199		1518
1200	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
1201	the terminal application will use this style.	1520	the terminal application will use this style.
…		…
1278	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
1279	as long as the perl object is referenced.	1598	as long as the perl object is referenced.
1280		1599
1281	The methods currently supported on C<urxvt::overlay> objects are:	1600	The methods currently supported on C<urxvt::overlay> objects are:
1282		1601
1283	=over 4	1602	=over
1284		1603
1285	=item $overlay->set ($x, $y, $text[, $rend])	1604	=item $overlay->set ($x, $y, $text[, $rend])
1286		1605
1287	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
1288	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
…		…
1332	Returns the number of screen-cells this string would need. Correctly	1651	Returns the number of screen-cells this string would need. Correctly
1333	accounts for wide and combining characters.	1652	accounts for wide and combining characters.
1334		1653
1335	=item $octets = $term->locale_encode ($string)	1654	=item $octets = $term->locale_encode ($string)
1336		1655
1337	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>.
1338		1658
1339	=item $string = $term->locale_decode ($octets)	1659	=item $string = $term->locale_decode ($octets)
1340		1660
1341	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>.
1342		1663
1343	=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])
1344		1665
1345	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
1346	(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
…		…
1359		1680
1360	=item $term->scr_add_lines ($string)	1681	=item $term->scr_add_lines ($string)
1361		1682
1362	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
1363	running inside the terminal. It may not contain command sequences (escape	1684	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	1685	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.	1686	carriage returns and tabs. The string is a normal text string, not in
		1687	locale-dependent encoding.
1366		1688
1367	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
1368	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
1369	C<on_add_lines> hook, though.	1691	C<on_add_lines> hook, though.
1370		1692
…		…
1378	locale-specific encoding of the terminal and can contain command sequences	1700	locale-specific encoding of the terminal and can contain command sequences
1379	(escape codes) that will be interpreted.	1701	(escape codes) that will be interpreted.
1380		1702
1381	=item $term->tt_write ($octets)	1703	=item $term->tt_write ($octets)
1382		1704
1383	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
1384	pass characters instead of octets, you should convert your strings first	1707	characters instead of octets, you should convert your strings first to the
1385	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.
1386		1717
1387	=item $term->tt_paste ($octets)	1718	=item $term->tt_paste ($octets)
1388		1719
1389	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
1390	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
…		…
1429		1760
1430	=item $term->key_release ($state, $keycode[, $time])	1761	=item $term->key_release ($state, $keycode[, $time])
1431		1762
1432	Deliver various fake events to to terminal.	1763	Deliver various fake events to to terminal.
1433		1764
1434	=item $window_width = $term->width	1765	=item $window_width = $term->width ([$new_value])
1435		1766
1436	=item $window_height = $term->height	1767	=item $window_height = $term->height ([$new_value])
1437		1768
1438	=item $font_width = $term->fwidth	1769	=item $font_width = $term->fwidth ([$new_value])
1439		1770
1440	=item $font_height = $term->fheight	1771	=item $font_height = $term->fheight ([$new_value])
1441		1772
1442	=item $font_ascent = $term->fbase	1773	=item $font_ascent = $term->fbase ([$new_value])
1443		1774
1444	=item $terminal_rows = $term->nrow	1775	=item $terminal_rows = $term->nrow ([$new_value])
1445		1776
1446	=item $terminal_columns = $term->ncol	1777	=item $terminal_columns = $term->ncol ([$new_value])
1447		1778
1448	=item $has_focus = $term->focus	1779	=item $has_focus = $term->focus ([$new_value])
1449		1780
1450	=item $is_mapped = $term->mapped	1781	=item $is_mapped = $term->mapped ([$new_value])
1451		1782
1452	=item $max_scrollback = $term->saveLines	1783	=item $max_scrollback = $term->saveLines ([$new_value])
1453		1784
1454	=item $nrow_plus_saveLines = $term->total_rows	1785	=item $nrow_plus_saveLines = $term->total_rows ([$new_value])
1455		1786
1456	=item $topmost_scrollback_row = $term->top_row	1787	=item $topmost_scrollback_row = $term->top_row ([$new_value])
1457		1788
1458	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.
1459		1791
1460	=item $x_display = $term->display_id	1792	=item $x_display = $term->display_id
1461		1793
1462	Return the DISPLAY used by rxvt-unicode.	1794	Return the DISPLAY used by rxvt-unicode.
1463		1795
…		…
1500		1832
1501	=item $cursor_is_hidden = $term->hidden_cursor	1833	=item $cursor_is_hidden = $term->hidden_cursor
1502		1834
1503	Returns whether the cursor is currently hidden or not.	1835	Returns whether the cursor is currently hidden or not.
1504		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
1505	=item $view_start = $term->view_start ([$newvalue])	1847	=item $view_start = $term->view_start ([$newvalue])
1506		1848
1507	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,
1508	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
1509	this many lines into the scrollback buffer.	1851	the terminal contents. Lower values scroll this many lines into the
		1852	scrollback buffer.
1510		1853
1511	=item $term->want_refresh	1854	=item $term->want_refresh
1512		1855
1513	Requests a screen refresh. At the next opportunity, rxvt-unicode will	1856	Requests a screen refresh. At the next opportunity, rxvt-unicode will
1514	compare the on-screen display with its stored representation. If they	1857	compare the on-screen display with its stored representation. If they
1515	differ, it redraws the differences.	1858	differ, it redraws the differences.
1516		1859
1517	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.
1518		1865
1519	=item $text = $term->ROW_t ($row_number[, $new_text[, $start_col]])	1866	=item $text = $term->ROW_t ($row_number[, $new_text[, $start_col]])
1520		1867
1521	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 >>
1522	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
…		…
1568		1915
1569	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
1570	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
1571	following methods:	1918	following methods:
1572		1919
1573	=over 4	1920	=over
1574		1921
1575	=item $text = $line->t ([$new_text])	1922	=item $text = $line->t ([$new_text])
1576		1923
1577	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>
1578		1925
…		…
1624	}	1971	}
1625		1972
1626	sub urxvt::line::t {	1973	sub urxvt::line::t {
1627	my ($self) = @_;	1974	my ($self) = @_;
1628		1975
1629	if (@_ > 1)	1976	if (@_ > 1) {
1630	{
1631	$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})
1632	for $self->{beg} .. $self->{end};	1978	for $self->{beg} .. $self->{end};
1633	}	1979	}
1634		1980
1635	defined wantarray &&	1981	defined wantarray &&
1636	substr +(join "", map $self->{term}->ROW_t ($_), $self->{beg} .. $self->{end}),	1982	substr +(join "", map $self->{term}->ROW_t ($_), $self->{beg} .. $self->{end}),
1637	0, $self->{len}	1983	0, $self->{len}
1638	}	1984	}
1639		1985
1640	sub urxvt::line::r {	1986	sub urxvt::line::r {
1641	my ($self) = @_;	1987	my ($self) = @_;
1642		1988
1643	if (@_ > 1)	1989	if (@_ > 1) {
1644	{
1645	$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})
1646	for $self->{beg} .. $self->{end};	1991	for $self->{beg} .. $self->{end};
1647	}	1992	}
1648		1993
1649	if (defined wantarray) {	1994	if (defined wantarray) {
1650	my $rend = [	1995	my $rend = [
1651	map @{ $self->{term}->ROW_r ($_) }, $self->{beg} .. $self->{end}	1996	map @{ $self->{term}->ROW_r ($_) }, $self->{beg} .. $self->{end}
1652	];	1997	];
…		…
1684	where one character corresponds to one screen cell. See	2029	where one character corresponds to one screen cell. See
1685	C<< $term->ROW_t >> for details.	2030	C<< $term->ROW_t >> for details.
1686		2031
1687	=item $string = $term->special_decode $text	2032	=item $string = $term->special_decode $text
1688		2033
1689	Converts rxvt-unicodes text representation into a perl string. See	2034	Converts rxvt-unicode's text representation into a perl string. See
1690	C<< $term->ROW_t >> for details.	2035	C<< $term->ROW_t >> for details.
1691		2036
1692	=item $success = $term->grab_button ($button, $modifiermask[, $window = $term->vt])	2037	=item $success = $term->grab_button ($button, $modifiermask[, $window = $term->vt])
1693		2038
1694	=item $term->ungrab_button ($button, $modifiermask[, $window = $term->vt])	2039	=item $term->ungrab_button ($button, $modifiermask[, $window = $term->vt])
…		…
1760		2105
1761	package urxvt::popup;	2106	package urxvt::popup;
1762		2107
1763	=head2 The C<urxvt::popup> Class	2108	=head2 The C<urxvt::popup> Class
1764		2109
1765	=over 4	2110	=over
1766		2111
1767	=cut	2112	=cut
1768		2113
1769	sub add_item {	2114	sub add_item {
1770	my ($self, $item) = @_;	2115	my ($self, $item) = @_;
…		…
1906	->cb (sub {	2251	->cb (sub {
1907	$term->{overlay}->set (0, 0,	2252	$term->{overlay}->set (0, 0,
1908	sprintf "%2d:%02d:%02d", (localtime urxvt::NOW)[2,1,0]);	2253	sprintf "%2d:%02d:%02d", (localtime urxvt::NOW)[2,1,0]);
1909	});	2254	});
1910		2255
1911	=over 4	2256	=over
1912		2257
1913	=item $timer = new urxvt::timer	2258	=item $timer = new urxvt::timer
1914		2259
1915	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
1916	immediately.	2261	immediately.
…		…
1965	sysread $term->{socket}, my $buf, 8192	2310	sysread $term->{socket}, my $buf, 8192
1966	or end-of-file;	2311	or end-of-file;
1967	});	2312	});
1968		2313
1969		2314
1970	=over 4	2315	=over
1971		2316
1972	=item $iow = new urxvt::iow	2317	=item $iow = new urxvt::iow
1973		2318
1974	Create a new io watcher object in stopped state.	2319	Create a new io watcher object in stopped state.
1975		2320
…		…
2002		2347
2003	This class implements idle watchers, that get called automatically when	2348	This class implements idle watchers, that get called automatically when
2004	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
2005	some useful work.	2350	some useful work.
2006		2351
2007	=over 4	2352	=over
2008		2353
2009	=item $iw = new urxvt::iw	2354	=item $iw = new urxvt::iw
2010		2355
2011	Create a new idle watcher object in stopped state.	2356	Create a new idle watcher object in stopped state.
2012		2357
…		…
2037	->cb (sub {	2382	->cb (sub {
2038	my ($pw, $exit_status) = @_;	2383	my ($pw, $exit_status) = @_;
2039	...	2384	...
2040	});	2385	});
2041		2386
2042	=over 4	2387	=over
2043		2388
2044	=item $pw = new urxvt::pw	2389	=item $pw = new urxvt::pw
2045		2390
2046	Create a new process watcher in stopped state.	2391	Create a new process watcher in stopped state.
2047		2392
…		…
2064	=head2 URXVT_PERL_VERBOSITY	2409	=head2 URXVT_PERL_VERBOSITY
2065		2410
2066	This variable controls the verbosity level of the perl extension. Higher	2411	This variable controls the verbosity level of the perl extension. Higher
2067	numbers indicate more verbose output.	2412	numbers indicate more verbose output.
2068		2413
2069	=over 4	2414	=over
2070		2415
2071	=item == 0 - fatal messages	2416	=item == 0 - fatal messages only
		2417
		2418	=item >= 2 - general warnings (default level)
2072		2419
2073	=item >= 3 - script loading and management	2420	=item >= 3 - script loading and management
2074		2421
2075	=item >=10 - all called hooks	2422	=item >=10 - all called hooks
2076		2423

Diff Legend

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

Comparing rxvt-unicode/src/urxvt.pm (file contents): Revision 1.218 by root, Sun Jun 10 17:31:53 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.218 by root, Sun Jun 10 17:31:53 2012 UTC vs.
Revision 1.271 by root, Fri Dec 9 05:06:46 2022 UTC