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

Comparing rxvt-unicode/src/urxvt.pm (file contents):
Revision 1.223 by root, Sat Jul 14 08:00:18 2012 UTC vs.
Revision 1.264 by root, Sat Jul 24 09:42:15 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 "vars"' and 'use utf8' environment, and
26	thus must be encoded as UTF-8.	26	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
106	C<urxvt::term> class on this object.	112	C<urxvt::term> class on this object.
107		113
108	Additional methods only supported for extension objects are described in	114	Additional methods only supported for extension objects are described in
109	the C<urxvt::extension> section below.	115	the C<urxvt::extension> section below.
110		116
		117	=head2 META comments
		118
		119	Rxvt-unicode recognizes special meta comments in extensions that define
		120	different types of metadata. These comments are scanned whenever a
		121	terminal is created and are typically used to autoload extensions when
		122	their resources or command line parameters are used.
		123
		124	Currently, it recognises only one such comment:
		125
		126	=over 4
		127
		128	=item #:META:RESOURCE:name:type:desc
		129
		130	The RESOURCE comment defines a resource used by the extension, where
		131	C<name> is the resource name, C<type> is the resource type, C<boolean>
		132	or C<string>, and C<desc> is the resource description.
		133
		134	The extension will be autoloaded when this resource is specified or used
		135	as a command line parameter.
		136
		137	=back
		138
111	=head2 Hooks	139	=head2 Hooks
112		140
113	The following subroutines can be declared in extension files, and will be	141	The following subroutines can be declared in extension files, and will be
114	called whenever the relevant event happens.	142	called whenever the relevant event happens.
115		143
…		…
281		309
282	=item on_refresh_end $term	310	=item on_refresh_end $term
283		311
284	Called just after the screen gets redrawn. See C<on_refresh_begin>.	312	Called just after the screen gets redrawn. See C<on_refresh_begin>.
285		313
		314	=item on_action $term, $string
		315
		316	Called whenever an action is invoked for the corresponding extension
		317	(e.g. via a C<extension:string> builtin action bound to a key, see
		318	description of the B<keysym> resource in the urxvt(1) manpage). The
		319	event is simply the action string. Note that an action event is always
		320	associated to a single extension.
		321
286	=item on_user_command $term, $string	322	=item on_user_command $term, $string DEPRECATED
287		323
288	Called whenever a user-configured event is being activated (e.g. via	324	Called whenever a user-configured event is being activated (e.g. via
289	a C<perl:string> action bound to a key, see description of the B<keysym>	325	a C<perl:string> action bound to a key, see description of the B<keysym>
290	resource in the @@RXVT_NAME@@(1) manpage).	326	resource in the urxvt(1) manpage).
291		327
292	The event is simply the action string. This interface is assumed to change	328	The event is simply the action string. This interface is going away in
293	slightly in the future.	329	preference to the C<on_action> hook.
294
295	=item on_register_command $term, $keysym, $modifiermask, $string
296
297	Called after parsing a keysym resource but before registering the
298	associated binding. If this hook returns TRUE the binding is not
299	registered. It can be used to modify a binding by calling
300	C<register_command>.
301		330
302	=item on_resize_all_windows $term, $new_width, $new_height	331	=item on_resize_all_windows $term, $new_width, $new_height
303		332
304	Called just after the new window size has been calculated, but before	333	Called just after the new window size has been calculated, but before
305	windows are actually being resized or hints are being set. If this hook	334	windows are actually being resized or hints are being set. If this hook
306	returns TRUE, setting of the window hints is being skipped.	335	returns a true value, setting of the window hints is being skipped.
307		336
308	=item on_x_event $term, $event	337	=item on_x_event $term, $event
309		338
310	Called on every X event received on the vt window (and possibly other	339	Called on every X event received on the vt window (and possibly other
311	windows). Should only be used as a last resort. Most event structure	340	windows). Should only be used as a last resort. Most event structure
…		…
350	manpage), with the additional members C<row> and C<col>, which are the	379	manpage), with the additional members C<row> and C<col>, which are the
351	(real, not screen-based) row and column under the mouse cursor.	380	(real, not screen-based) row and column under the mouse cursor.
352		381
353	C<on_key_press> additionally receives the string rxvt-unicode would	382	C<on_key_press> additionally receives the string rxvt-unicode would
354	output, if any, in locale-specific encoding.	383	output, if any, in locale-specific encoding.
355
356	subwindow.
357		384
358	=item on_client_message $term, $event	385	=item on_client_message $term, $event
359		386
360	=item on_wm_protocols $term, $event	387	=item on_wm_protocols $term, $event
361		388
…		…
489	ConfigureRequest, GravityNotify, ResizeRequest, CirculateNotify,	516	ConfigureRequest, GravityNotify, ResizeRequest, CirculateNotify,
490	CirculateRequest, PropertyNotify, SelectionClear, SelectionRequest,	517	CirculateRequest, PropertyNotify, SelectionClear, SelectionRequest,
491	SelectionNotify, ColormapNotify, ClientMessage, MappingNotify	518	SelectionNotify, ColormapNotify, ClientMessage, MappingNotify
492		519
493	Various constants for use in X calls and event processing.	520	Various constants for use in X calls and event processing.
		521
		522	=item urxvt::PrivMode_132, PrivMode_132OK, PrivMode_rVideo, PrivMode_relOrigin,
		523	PrivMode_Screen, PrivMode_Autowrap, PrivMode_aplCUR, PrivMode_aplKP,
		524	PrivMode_HaveBackSpace, PrivMode_BackSpace, PrivMode_ShiftKeys,
		525	PrivMode_VisibleCursor, PrivMode_MouseX10, PrivMode_MouseX11,
		526	PrivMode_scrollBar, PrivMode_TtyOutputInh, PrivMode_Keypress,
		527	PrivMode_smoothScroll, PrivMode_vt52, PrivMode_LFNL, PrivMode_MouseBtnEvent,
		528	PrivMode_MouseAnyEvent, PrivMode_BracketPaste, PrivMode_ExtMouseUTF8,
		529	PrivMode_ExtMouseUrxvt, PrivMode_BlinkingCursor, PrivMode_mouse_report,
		530	PrivMode_Default
		531
		532	Constants for checking DEC private modes.
494		533
495	=back	534	=back
496		535
497	=head2 RENDITION	536	=head2 RENDITION
498		537
…		…
564	no warnings 'utf8';	603	no warnings 'utf8';
565		604
566	sub parse_resource {	605	sub parse_resource {
567	my ($term, $name, $isarg, $longopt, $flag, $value) = @_;	606	my ($term, $name, $isarg, $longopt, $flag, $value) = @_;
568		607
569	$name =~ y/-/./ if $isarg;
570
571	$term->scan_meta;	608	$term->scan_extensions;
572		609
		610	# iterating over all resources has quadratic time overhead
		611	# overall, maybe this could be optimised?
573	my $r = $term->{meta}{resource};	612	my $r = $term->{meta}{resource};
574	keys %$r; # reste iterator	613	keys %$r; # reset iterator
575	while (my ($pattern, $v) = each %$r) {	614	while (my ($k, $v) = each %$r) {
576	if (	615	my $pattern = $k;
		616	$pattern =~ y/./-/ if $isarg;
		617	my $prefix = $name;
		618	my $suffix;
577	$pattern =~ /\.$/	619	if ($pattern =~ /\-$/) {
578	? $pattern eq substr $name, 0, length $pattern	620	$prefix = substr $name, 0, length $pattern;
579	: $pattern eq $name	621	$suffix = substr $name, length $pattern;
580	) {	622	}
		623	if ($pattern eq $prefix) {
581	$name = "$urxvt::RESCLASS.$name";	624	$name = "$urxvt::RESCLASS.$k$suffix";
582		625
583	push @{ $term->{perl_ext_3} }, $v->[0];	626	push @{ $term->{perl_ext_3} }, $v->[0];
		627
		628	return 1 unless $isarg;
584		629
585	if ($v->[1] eq "boolean") {	630	if ($v->[1] eq "boolean") {
586	$term->put_option_db ($name, $flag ? "true" : "false");	631	$term->put_option_db ($name, $flag ? "true" : "false");
587	return 1;	632	return 1;
588	} else {	633	} else {
…		…
596	}	641	}
597		642
598	sub usage {	643	sub usage {
599	my ($term, $usage_type) = @_;	644	my ($term, $usage_type) = @_;
600		645
601	$term->scan_meta;	646	$term->scan_extensions;
602		647
603	my $r = $term->{meta}{resource};	648	my $r = $term->{meta}{resource};
604		649
605	for my $pattern (sort keys %$r) {	650	for my $pattern (sort keys %$r) {
606	my ($ext, $type, $desc) = @{ $r->{$pattern} };	651	my ($ext, $type, $desc) = @{ $r->{$pattern} };
…		…
667	# called by the rxvt core	712	# called by the rxvt core
668	sub invoke {	713	sub invoke {
669	local $TERM = shift;	714	local $TERM = shift;
670	my $htype = shift;	715	my $htype = shift;
671		716
672	if ($htype == 0) { # INIT	717	if ($htype == HOOK_INIT) {
673	my @dirs = $TERM->perl_libdirs;	718	my @dirs = $TERM->perl_libdirs;
		719
		720	$TERM->scan_extensions;
674		721
675	my %ext_arg;	722	my %ext_arg;
676		723
677	{	724	{
678	my @init = @TERM_INIT;	725	my @init = @TERM_INIT;
…		…
683	$TERM->register_package ($_) for @pkg;	730	$TERM->register_package ($_) for @pkg;
684	}	731	}
685		732
686	for (	733	for (
687	@{ delete $TERM->{perl_ext_3} },	734	@{ delete $TERM->{perl_ext_3} },
688	grep $_, map { split /,/, $TERM->resource ("perl_ext_$_") } 1, 2	735	(grep $_, map { split /,/, $TERM->resource ("perl_ext_$_") } 1, 2),
689	) {	736	) {
690	if ($_ eq "default") {	737	if ($_ eq "default") {
		738
		739	$ext_arg{$_} = []
691	$ext_arg{$_} \|\|= [] for qw(selection option-popup selection-popup searchable-scrollback readline);	740	for qw(selection option-popup selection-popup readline searchable-scrollback confirm-paste);
		741
		742	for ($TERM->_keysym_resources) {
		743	next if /^(?:string\|command\|builtin\|builtin-string\|perl)/;
		744	next unless /^([A-Za-z0-9_\-]+):/;
		745
		746	my $ext = $1;
		747
		748	$ext_arg{$ext} = [];
		749	}
		750
692	} elsif (/^-(.*)$/) {	751	} elsif (/^-(.*)$/) {
693	delete $ext_arg{$1};	752	delete $ext_arg{$1};
		753
694	} elsif (/^([^<]+)<(.*)>$/) {	754	} elsif (/^([^<]+)<(.*)>$/) {
695	push @{ $ext_arg{$1} }, $2;	755	push @{ $ext_arg{$1} }, $2;
		756
696	} else {	757	} else {
697	$ext_arg{$_} \|\|= [];	758	$ext_arg{$_} \|\|= [];
698	}	759	}
699	}	760	}
700		761
…		…
716		777
717	if (my $cb = $TERM->{_hook}[$htype]) {	778	if (my $cb = $TERM->{_hook}[$htype]) {
718	verbose 10, "$HOOKNAME[$htype] (" . (join ", ", $TERM, @_) . ")"	779	verbose 10, "$HOOKNAME[$htype] (" . (join ", ", $TERM, @_) . ")"
719	if $verbosity >= 10;	780	if $verbosity >= 10;
720		781
		782	if ($htype == HOOK_ACTION) {
		783	# this hook is only sent to the extension with the name
		784	# matching the first arg
		785	my $pkg = shift;
		786	$pkg =~ y/-/_/;
		787	$pkg = "urxvt::ext::$pkg";
		788
		789	$cb = $cb->{$pkg}
		790	or return undef; #TODO: maybe warn user?
		791
		792	$cb = { $pkg => $cb };
		793	}
		794
721	for my $pkg (keys %$cb) {	795	for my $pkg (keys %$cb) {
722	my $retval_ = eval { $cb->{$pkg}->($TERM->{_pkg}{$pkg} \|\| $TERM, @_) };	796	my $retval_ = eval { $cb->{$pkg}->($TERM->{_pkg}{$pkg} \|\| $TERM, @_) };
723	$retval \|\|= $retval_;	797	$retval \|\|= $retval_;
724		798
725	if ($@) {	799	if ($@) {
…		…
730		804
731	verbose 11, "$HOOKNAME[$htype] returning <$retval>"	805	verbose 11, "$HOOKNAME[$htype] returning <$retval>"
732	if $verbosity >= 11;	806	if $verbosity >= 11;
733	}	807	}
734		808
735	if ($htype == 1) { # DESTROY	809	if ($htype == HOOK_DESTROY) {
736	# clear package objects	810	# clear package objects
737	%$_ = () for values %{ $TERM->{_pkg} };	811	%$_ = () for values %{ $TERM->{_pkg} };
738		812
739	# clear package	813	# clear package
740	%$TERM = ();	814	%$TERM = ();
…		…
827	}	901	}
828		902
829	=item $self->enable ($hook_name => $cb[, $hook_name => $cb..])	903	=item $self->enable ($hook_name => $cb[, $hook_name => $cb..])
830		904
831	Dynamically enable the given hooks (named without the C<on_> prefix) for	905	Dynamically enable the given hooks (named without the C<on_> prefix) for
832	this extension, replacing any previous hook. This is useful when you want	906	this extension, replacing any hook previously installed via C<enable> in
833	to overwrite time-critical hooks only temporarily.	907	this extension.
		908
		909	This is useful when you want to overwrite time-critical hooks only
		910	temporarily.
834		911
835	To install additional callbacks for the same hook, you can use the C<on>	912	To install additional callbacks for the same hook, you can use the C<on>
836	method of the C<urxvt::term> class.	913	method of the C<urxvt::term> class.
837		914
838	=item $self->disable ($hook_name[, $hook_name..])	915	=item $self->disable ($hook_name[, $hook_name..])
…		…
884	my $disable = shift;	961	my $disable = shift;
885		962
886	my $term = delete $disable->{""};	963	my $term = delete $disable->{""};
887		964
888	while (my ($htype, $id) = each %$disable) {	965	while (my ($htype, $id) = each %$disable) {
889	warn "disable hook $htype,$id\n";#d#
890	delete $term->{_hook}[$htype]{$id};	966	delete $term->{_hook}[$htype]{$id};
891	$term->set_should_invoke ($htype, -1);	967	$term->set_should_invoke ($htype, -1);
892	}	968	}
893	}	969	}
894		970
…		…
910	}	986	}
911		987
912	bless \%disable, "urxvt::extension::on_disable"	988	bless \%disable, "urxvt::extension::on_disable"
913	}	989	}
914		990
		991	=item $self->bind_action ($hotkey, $action)
		992
915	=item $self->x_resource ($pattern)	993	=item $self->x_resource ($pattern)
916		994
917	=item $self->x_resource_boolean ($pattern)	995	=item $self->x_resource_boolean ($pattern)
918		996
919	These methods support an additional C<%> prefix when called on an	997	These methods support an additional C<%> prefix for C<$action> or
920	extension object - see the description of these methods in the	998	C<$pattern> when called on an extension object, compared to the
		999	C<urxvt::term> methods of the same name - see the description of these
921	C<urxvt::term> class for details.	1000	methods in the C<urxvt::term> class for details.
922		1001
923	=cut	1002	=cut
		1003
		1004	sub bind_action {
		1005	my ($self, $hotkey, $action) = @_;
		1006	$action =~ s/^%:/$_[0]{_name}:/;
		1007	$self->{term}->bind_action ($hotkey, $action)
		1008	}
924		1009
925	sub x_resource {	1010	sub x_resource {
926	my ($self, $name) = @_;	1011	my ($self, $name) = @_;
927	$name =~ s/^%(\.\|$)/$_[0]{_name}$1/;	1012	$name =~ s/^%(\.\|$)/$_[0]{_name}$1/;
928	$self->{term}->x_resource ($name)	1013	$self->{term}->x_resource ($name)
…		…
1063	$ENV{URXVT_PERL_LIB},	1148	$ENV{URXVT_PERL_LIB},
1064	"$ENV{HOME}/.urxvt/ext",	1149	"$ENV{HOME}/.urxvt/ext",
1065	"$LIBDIR/perl"	1150	"$LIBDIR/perl"
1066	}	1151	}
1067		1152
1068	sub scan_meta {	1153	# scan for available extensions and collect their metadata
		1154	sub scan_extensions {
1069	my ($self) = @_;	1155	my ($self) = @_;
		1156
		1157	return if exists $self->{meta};
		1158
1070	my @libdirs = perl_libdirs $self;	1159	my @urxvtdirs = perl_libdirs $self;
		1160	# my @cpandirs = grep -d, map "$_/URxvt/Ext", @INC;
1071		1161
1072	return if $self->{meta_libdirs} eq join "\x00", @libdirs;
1073
1074	my %meta;
1075
1076	$self->{meta_libdirs} = join "\x00", @libdirs;
1077	$self->{meta} = \%meta;	1162	$self->{meta} = \my %meta;
1078		1163
1079	for my $dir (reverse @libdirs) {	1164	# first gather extensions
		1165
		1166	my $gather = sub {
		1167	my ($dir, $core) = @_;
		1168
1080	opendir my $fh, $dir	1169	opendir my $fh, $dir
1081	or next;	1170	or return;
		1171
1082	for my $ext (readdir $fh) {	1172	for my $ext (readdir $fh) {
1083	$ext ne "."	1173	$ext !~ /^\./
1084	and $ext ne ".."
1085	and open my $fh, "<", "$dir/$ext"
1086	or next;	1174	or next;
1087		1175
		1176	open my $fh, "<", "$dir/$ext"
		1177	or next;
		1178
		1179	-f $fh
		1180	or next;
		1181
		1182	$ext =~ s/\.uext$// or $core
		1183	or next;
		1184
		1185	my %ext = (dir => $dir);
		1186
1088	while (<$fh>) {	1187	while (<$fh>) {
1089	if (/^#:META:X_RESOURCE:(.*)/) {	1188	if (/^#:META:(?:X_)?RESOURCE:(.*)/) {
1090	my ($pattern, $type, $desc) = split /:/, $1;	1189	my ($pattern, $type, $desc) = split /:/, $1;
1091	$pattern =~ s/^%(\.\|$)/$ext$1/g; # % in pattern == extension name	1190	$pattern =~ s/^%(\.\|$)/$ext$1/g; # % in pattern == extension name
1092	if ($pattern =~ /[^a-zA-Z0-9\-\.]/) {	1191	if ($pattern =~ /[^a-zA-Z0-9\-\.]/) {
1093	warn "$dir/$ext: meta resource '$pattern' contains illegal characters (not alphanumeric nor . nor *)\n";	1192	warn "$dir/$ext: meta resource '$pattern' contains illegal characters (not alphanumeric nor . nor *)\n";
1094	} else {	1193	} else {
1095	$meta{resource}{$pattern} = [$ext, $type, $desc];	1194	$ext{resource}{$pattern} = [$ext, $type, $desc];
1096	}	1195	}
1097	} elsif (/^\s*(?:#\|$)/) {	1196	} elsif (/^\s*(?:#\|$)/) {
1098	# skip other comments and empty lines	1197	# skip other comments and empty lines
1099	} else {	1198	} else {
1100	last; # stop parsing on first non-empty non-comment line	1199	last; # stop parsing on first non-empty non-comment line
1101	}	1200	}
1102	}	1201	}
		1202
		1203	$meta{ext}{$ext} = \%ext;
1103	}	1204	}
		1205	};
		1206
		1207	# $gather->($_, 0) for @cpandirs;
		1208	$gather->($_, 1) for @urxvtdirs;
		1209
		1210	# and now merge resources
		1211
		1212	$meta{resource} = \my %resource;
		1213
		1214	while (my ($k, $v) = each %{ $meta{ext} }) {
		1215	#TODO: should check for extensions overriding each other
		1216	%resource = (%resource, %{ $v->{resource} });
1104	}	1217	}
1105	}	1218	}
1106		1219
1107	=item $term = new urxvt::term $envhashref, $rxvtname, [arg...]	1220	=item $term = new urxvt::term $envhashref, $rxvtname, [arg...]
1108		1221
…		…
1128	}	1241	}
1129		1242
1130	=item $term->destroy	1243	=item $term->destroy
1131		1244
1132	Destroy the terminal object (close the window, free resources	1245	Destroy the terminal object (close the window, free resources
1133	etc.). Please note that @@RXVT_NAME@@ will not exit as long as any event	1246	etc.). Please note that urxvt will not exit as long as any event
1134	watchers (timers, io watchers) are still active.	1247	watchers (timers, io watchers) are still active.
1135		1248
1136	=item $term->exec_async ($cmd[, @args])	1249	=item $term->exec_async ($cmd[, @args])
1137		1250
1138	Works like the combination of the C<fork>/C<exec> builtins, which executes	1251	Works like the combination of the C<fork>/C<exec> builtins, which executes
…		…
1171	insecure intensityStyles iso14755 iso14755_52 jumpScroll loginShell	1284	insecure intensityStyles iso14755 iso14755_52 jumpScroll loginShell
1172	mapAlert meta8 mouseWheelScrollPage override_redirect pastableTabs	1285	mapAlert meta8 mouseWheelScrollPage override_redirect pastableTabs
1173	pointerBlank reverseVideo scrollBar scrollBar_floating scrollBar_right	1286	pointerBlank reverseVideo scrollBar scrollBar_floating scrollBar_right
1174	scrollTtyKeypress scrollTtyOutput scrollWithBuffer secondaryScreen	1287	scrollTtyKeypress scrollTtyOutput scrollWithBuffer secondaryScreen
1175	secondaryScroll skipBuiltinGlyphs skipScroll transparent tripleclickwords	1288	secondaryScroll skipBuiltinGlyphs skipScroll transparent tripleclickwords
1176	urgentOnBell utmpInhibit visualBell	1289	urgentOnBell utmpInhibit visualBell disablePasteBrackets
1177		1290
1178	=item $value = $term->resource ($name[, $newval])	1291	=item $value = $term->resource ($name[, $newval])
1179		1292
1180	Returns the current resource value associated with a given name and	1293	Returns the current resource value associated with a given name and
1181	optionally sets a new value. Setting values is most useful in the C<init>	1294	optionally sets a new value. Setting values is most useful in the C<init>
…		…
1207	preeditType print_pipe pty_fd reverseVideo saveLines scrollBar	1320	preeditType print_pipe pty_fd reverseVideo saveLines scrollBar
1208	scrollBar_align scrollBar_floating scrollBar_right scrollBar_thickness	1321	scrollBar_align scrollBar_floating scrollBar_right scrollBar_thickness
1209	scrollTtyKeypress scrollTtyOutput scrollWithBuffer scrollstyle	1322	scrollTtyKeypress scrollTtyOutput scrollWithBuffer scrollstyle
1210	secondaryScreen secondaryScroll shade skipBuiltinGlyphs skipScroll	1323	secondaryScreen secondaryScroll shade skipBuiltinGlyphs skipScroll
1211	term_name title transient_for transparent tripleclickwords urgentOnBell	1324	term_name title transient_for transparent tripleclickwords urgentOnBell
1212	utmpInhibit visualBell	1325	utmpInhibit visualBell rewrapMode disablePasteBrackets
1213		1326
1214	=cut	1327	=cut
1215		1328
1216	sub resource($$;$) {	1329	sub resource($$;$) {
1217	my ($self, $name) = (shift, shift);	1330	my ($self, $name) = (shift, shift);
…		…
1224	Returns the X-Resource for the given pattern, excluding the program or	1337	Returns the X-Resource for the given pattern, excluding the program or
1225	class name, i.e. C<< $term->x_resource ("boldFont") >> should return the	1338	class name, i.e. C<< $term->x_resource ("boldFont") >> should return the
1226	same value as used by this instance of rxvt-unicode. Returns C<undef> if no	1339	same value as used by this instance of rxvt-unicode. Returns C<undef> if no
1227	resource with that pattern exists.	1340	resource with that pattern exists.
1228		1341
1229	Extensions that define extra resource or command line arguments also need	1342	Extensions that define extra resources also need to call this method
1230	to call this method to access their values.	1343	to access their values.
1231		1344
1232	If the method is called on an extension object (basically, from an	1345	If the method is called on an extension object (basically, from an
1233	extension), then the special prefix C<%.> will be replaced by the name of	1346	extension), then the special prefix C<%.> will be replaced by the name of
1234	the extension and a dot, and the lone string C<%> will be replaced by the	1347	the extension and a dot, and the lone string C<%> will be replaced by the
1235	extension name itself. This makes it possible to code extensions so you	1348	extension name itself. This makes it possible to code extensions so you
1236	can rename them and get a new set of commandline switches and resources	1349	can rename them and get a new set of resources without having to change
1237	without having to change the actual code.	1350	the actual code.
1238		1351
1239	This method should only be called during the C<on_start> hook, as there is	1352	This method should only be called during the C<on_start> hook, as there is
1240	only one resource database per display, and later invocations might return	1353	only one resource database per display, and later invocations might return
1241	the wrong resources.	1354	the wrong resources.
1242		1355
…		…
1254	my $res = &x_resource;	1367	my $res = &x_resource;
1255		1368
1256	$res =~ /^\s(?:true\|yes\|on\|1)\s$/i ? 1 : defined $res && 0	1369	$res =~ /^\s(?:true\|yes\|on\|1)\s$/i ? 1 : defined $res && 0
1257	}	1370	}
1258		1371
1259	=item $success = $term->parse_keysym ($key, $octets)	1372	=item $action = $term->lookup_keysym ($keysym, $state)
1260		1373
		1374	Returns the action bound to key combination C<($keysym, $state)>,
		1375	if a binding for it exists, and C<undef> otherwise.
		1376
		1377	=item $success = $term->bind_action ($key, $action)
		1378
1261	Adds a key binding exactly as specified via a resource. See the	1379	Adds a key binding exactly as specified via a C<keysym> resource. See the
1262	C<keysym> resource in the @@RXVT_NAME@@(1) manpage.	1380	C<keysym> resource in the urxvt(1) manpage.
1263		1381
1264	=item $term->register_command ($keysym, $modifiermask, $string)	1382	To add default bindings for actions, an extension should call C<<
		1383	->bind_action >> in its C<init> hook for every such binding. Doing it
		1384	in the C<init> hook allows users to override or remove the binding
		1385	again.
1265		1386
1266	Adds a key binding. This is a lower level api compared to	1387	Example: the C<searchable-scrollback> by default binds itself
1267	C<parse_keysym>, as it expects a parsed key description, and can be	1388	on C<Meta-s>, using C<< $self->bind_action >>, which calls C<<
1268	used only inside either the C<on_init> hook, to add a binding, or the	1389	$term->bind_action >>.
1269	C<on_register_command> hook, to modify a parsed binding.	1390
		1391	sub init {
		1392	my ($self) = @_;
		1393
		1394	$self->bind_action ("M-s" => "%:start");
		1395	}
1270		1396
1271	=item $rend = $term->rstyle ([$new_rstyle])	1397	=item $rend = $term->rstyle ([$new_rstyle])
1272		1398
1273	Return and optionally change the current rendition. Text that is output by	1399	Return and optionally change the current rendition. Text that is output by
1274	the terminal application will use this style.	1400	the terminal application will use this style.
…		…
1432		1558
1433	=item $term->scr_add_lines ($string)	1559	=item $term->scr_add_lines ($string)
1434		1560
1435	Write the given text string to the screen, as if output by the application	1561	Write the given text string to the screen, as if output by the application
1436	running inside the terminal. It may not contain command sequences (escape	1562	running inside the terminal. It may not contain command sequences (escape
1437	codes), but is free to use line feeds, carriage returns and tabs. The	1563	codes - see C<cmd_parse> for that), but is free to use line feeds,
1438	string is a normal text string, not in locale-dependent encoding.	1564	carriage returns and tabs. The string is a normal text string, not in
		1565	locale-dependent encoding.
1439		1566
1440	Normally its not a good idea to use this function, as programs might be	1567	Normally its not a good idea to use this function, as programs might be
1441	confused by changes in cursor position or scrolling. Its useful inside a	1568	confused by changes in cursor position or scrolling. Its useful inside a
1442	C<on_add_lines> hook, though.	1569	C<on_add_lines> hook, though.
1443		1570
…		…
1451	locale-specific encoding of the terminal and can contain command sequences	1578	locale-specific encoding of the terminal and can contain command sequences
1452	(escape codes) that will be interpreted.	1579	(escape codes) that will be interpreted.
1453		1580
1454	=item $term->tt_write ($octets)	1581	=item $term->tt_write ($octets)
1455		1582
1456	Write the octets given in C<$octets> to the tty (i.e. as program input). To	1583	Write the octets given in C<$octets> to the tty (i.e. as user input
		1584	to the program, see C<cmd_parse> for the opposite direction). To pass
1457	pass characters instead of octets, you should convert your strings first	1585	characters instead of octets, you should convert your strings first to the
1458	to the locale-specific encoding using C<< $term->locale_encode >>.	1586	locale-specific encoding using C<< $term->locale_encode >>.
		1587
		1588	=item $term->tt_write_user_input ($octets)
		1589
		1590	Like C<tt_write>, but should be used when writing strings in response to
		1591	the user pressing a key, to invoke the additional actions requested by
		1592	the user for that case (C<tt_write> doesn't do that).
		1593
		1594	The typical use case would be inside C<on_action> hooks.
1459		1595
1460	=item $term->tt_paste ($octets)	1596	=item $term->tt_paste ($octets)
1461		1597
1462	Write the octets given in C<$octets> to the tty as a paste, converting NL to	1598	Write the octets given in C<$octets> to the tty as a paste, converting NL to
1463	CR and bracketing the data with control sequences if bracketed paste mode	1599	CR and bracketing the data with control sequences if bracketed paste mode
…		…
1502		1638
1503	=item $term->key_release ($state, $keycode[, $time])	1639	=item $term->key_release ($state, $keycode[, $time])
1504		1640
1505	Deliver various fake events to to terminal.	1641	Deliver various fake events to to terminal.
1506		1642
1507	=item $window_width = $term->width	1643	=item $window_width = $term->width ([$new_value])
1508		1644
1509	=item $window_height = $term->height	1645	=item $window_height = $term->height ([$new_value])
1510		1646
1511	=item $font_width = $term->fwidth	1647	=item $font_width = $term->fwidth ([$new_value])
1512		1648
1513	=item $font_height = $term->fheight	1649	=item $font_height = $term->fheight ([$new_value])
1514		1650
1515	=item $font_ascent = $term->fbase	1651	=item $font_ascent = $term->fbase ([$new_value])
1516		1652
1517	=item $terminal_rows = $term->nrow	1653	=item $terminal_rows = $term->nrow ([$new_value])
1518		1654
1519	=item $terminal_columns = $term->ncol	1655	=item $terminal_columns = $term->ncol ([$new_value])
1520		1656
1521	=item $has_focus = $term->focus	1657	=item $has_focus = $term->focus ([$new_value])
1522		1658
1523	=item $is_mapped = $term->mapped	1659	=item $is_mapped = $term->mapped ([$new_value])
1524		1660
1525	=item $max_scrollback = $term->saveLines	1661	=item $max_scrollback = $term->saveLines ([$new_value])
1526		1662
1527	=item $nrow_plus_saveLines = $term->total_rows	1663	=item $nrow_plus_saveLines = $term->total_rows ([$new_value])
1528		1664
1529	=item $topmost_scrollback_row = $term->top_row	1665	=item $topmost_scrollback_row = $term->top_row ([$new_value])
1530		1666
1531	Return various integers describing terminal characteristics.	1667	Return various integers describing terminal characteristics. If an
		1668	argument is given, changes the value and returns the previous one.
1532		1669
1533	=item $x_display = $term->display_id	1670	=item $x_display = $term->display_id
1534		1671
1535	Return the DISPLAY used by rxvt-unicode.	1672	Return the DISPLAY used by rxvt-unicode.
1536		1673
…		…
1573		1710
1574	=item $cursor_is_hidden = $term->hidden_cursor	1711	=item $cursor_is_hidden = $term->hidden_cursor
1575		1712
1576	Returns whether the cursor is currently hidden or not.	1713	Returns whether the cursor is currently hidden or not.
1577		1714
		1715	=item $priv_modes = $term->priv_modes
		1716
		1717	Returns a bitset with the state of DEC private modes.
		1718
		1719	Example:
		1720
		1721	if ($term->priv_modes & urxvt::PrivMode_mouse_report) {
		1722	# mouse reporting is turned on
		1723	}
		1724
1578	=item $view_start = $term->view_start ([$newvalue])	1725	=item $view_start = $term->view_start ([$newvalue])
1579		1726
1580	Returns the row number of the topmost displayed line. Maximum value is	1727	Returns the row number of the topmost displayed line and changes it,
1581	C<0>, which displays the normal terminal contents. Lower values scroll	1728	if an argument is given. Values greater than or equal to C<0> display
1582	this many lines into the scrollback buffer.	1729	the terminal contents. Lower values scroll this many lines into the
		1730	scrollback buffer.
1583		1731
1584	=item $term->want_refresh	1732	=item $term->want_refresh
1585		1733
1586	Requests a screen refresh. At the next opportunity, rxvt-unicode will	1734	Requests a screen refresh. At the next opportunity, rxvt-unicode will
1587	compare the on-screen display with its stored representation. If they	1735	compare the on-screen display with its stored representation. If they
1588	differ, it redraws the differences.	1736	differ, it redraws the differences.
1589		1737
1590	Used after changing terminal contents to display them.	1738	Used after changing terminal contents to display them.
		1739
		1740	=item $term->refresh_check
		1741
		1742	Checks if a refresh has been requested and, if so, schedules one.
1591		1743
1592	=item $text = $term->ROW_t ($row_number[, $new_text[, $start_col]])	1744	=item $text = $term->ROW_t ($row_number[, $new_text[, $start_col]])
1593		1745
1594	Returns the text of the entire row with number C<$row_number>. Row C<< $term->top_row >>	1746	Returns the text of the entire row with number C<$row_number>. Row C<< $term->top_row >>
1595	is the topmost terminal line, row C<< $term->nrow-1 >> is the bottommost	1747	is the topmost terminal line, row C<< $term->nrow-1 >> is the bottommost
…		…
1697	}	1849	}
1698		1850
1699	sub urxvt::line::t {	1851	sub urxvt::line::t {
1700	my ($self) = @_;	1852	my ($self) = @_;
1701		1853
1702	if (@_ > 1)	1854	if (@_ > 1) {
1703	{
1704	$self->{term}->ROW_t ($_, $_[1], 0, ($_ - $self->{beg}) * $self->{ncol}, $self->{ncol})	1855	$self->{term}->ROW_t ($_, $_[1], 0, ($_ - $self->{beg}) * $self->{ncol}, $self->{ncol})
1705	for $self->{beg} .. $self->{end};	1856	for $self->{beg} .. $self->{end};
1706	}	1857	}
1707		1858
1708	defined wantarray &&	1859	defined wantarray &&
1709	substr +(join "", map $self->{term}->ROW_t ($_), $self->{beg} .. $self->{end}),	1860	substr +(join "", map $self->{term}->ROW_t ($_), $self->{beg} .. $self->{end}),
1710	0, $self->{len}	1861	0, $self->{len}
1711	}	1862	}
1712		1863
1713	sub urxvt::line::r {	1864	sub urxvt::line::r {
1714	my ($self) = @_;	1865	my ($self) = @_;
1715		1866
1716	if (@_ > 1)	1867	if (@_ > 1) {
1717	{
1718	$self->{term}->ROW_r ($_, $_[1], 0, ($_ - $self->{beg}) * $self->{ncol}, $self->{ncol})	1868	$self->{term}->ROW_r ($_, $_[1], 0, ($_ - $self->{beg}) * $self->{ncol}, $self->{ncol})
1719	for $self->{beg} .. $self->{end};	1869	for $self->{beg} .. $self->{end};
1720	}	1870	}
1721		1871
1722	if (defined wantarray) {	1872	if (defined wantarray) {
1723	my $rend = [	1873	my $rend = [
1724	map @{ $self->{term}->ROW_r ($_) }, $self->{beg} .. $self->{end}	1874	map @{ $self->{term}->ROW_r ($_) }, $self->{beg} .. $self->{end}
1725	];	1875	];

Diff Legend

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

Comparing rxvt-unicode/src/urxvt.pm (file contents): Revision 1.223 by root, Sat Jul 14 08:00:18 2012 UTC vs. Revision 1.264 by root, Sat Jul 24 09:42:15 2021 UTC

Diff Legend

Comparing rxvt-unicode/src/urxvt.pm (file contents):
Revision 1.223 by root, Sat Jul 14 08:00:18 2012 UTC vs.
Revision 1.264 by root, Sat Jul 24 09:42:15 2021 UTC