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

Comparing rxvt-unicode/src/urxvt.pm (file contents):
Revision 1.224 by root, Sat Jul 14 08:00:34 2012 UTC vs.
Revision 1.256 by sf-exg, Thu Jul 14 05:10:06 2016 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 $HOME:
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 using it:
17		17
18	@@RXVT_NAME@@ --perl-lib $HOME -pe grab_test	18	urxvt --perl-lib $HOME -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.
		121
		122	Currently, it recognises only one such comment:
		123
		124	=over 4
		125
		126	=item #:META:RESOURCE:name:type:desc
		127
		128	The RESOURCE comment defines a resource used by the extension, where
		129	C<name> is the resource name, C<type> is the resource type, C<boolean>
		130	or C<string>, and C<desc> is the resource description.
		131
		132	=back
		133
111	=head2 Hooks	134	=head2 Hooks
112		135
113	The following subroutines can be declared in extension files, and will be	136	The following subroutines can be declared in extension files, and will be
114	called whenever the relevant event happens.	137	called whenever the relevant event happens.
115		138
…		…
281		304
282	=item on_refresh_end $term	305	=item on_refresh_end $term
283		306
284	Called just after the screen gets redrawn. See C<on_refresh_begin>.	307	Called just after the screen gets redrawn. See C<on_refresh_begin>.
285		308
		309	=item on_action $term, $string
		310
		311	Called whenever an action is invoked for the corresponding extension
		312	(e.g. via a C<extension:string> builtin action bound to a key, see
		313	description of the B<keysym> resource in the urxvt(1) manpage). The
		314	event is simply the action string. Note that an action event is always
		315	associated to a single extension.
		316
286	=item on_user_command $term, $string	317	=item on_user_command $term, $string DEPRECATED
287		318
288	Called whenever a user-configured event is being activated (e.g. via	319	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>	320	a C<perl:string> action bound to a key, see description of the B<keysym>
290	resource in the @@RXVT_NAME@@(1) manpage).	321	resource in the urxvt(1) manpage).
291		322
292	The event is simply the action string. This interface is assumed to change	323	The event is simply the action string. This interface is going away in
293	slightly in the future.	324	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		325
302	=item on_resize_all_windows $term, $new_width, $new_height	326	=item on_resize_all_windows $term, $new_width, $new_height
303		327
304	Called just after the new window size has been calculated, but before	328	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	329	windows are actually being resized or hints are being set. If this hook
306	returns TRUE, setting of the window hints is being skipped.	330	returns a true value, setting of the window hints is being skipped.
307		331
308	=item on_x_event $term, $event	332	=item on_x_event $term, $event
309		333
310	Called on every X event received on the vt window (and possibly other	334	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	335	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	374	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.	375	(real, not screen-based) row and column under the mouse cursor.
352		376
353	C<on_key_press> additionally receives the string rxvt-unicode would	377	C<on_key_press> additionally receives the string rxvt-unicode would
354	output, if any, in locale-specific encoding.	378	output, if any, in locale-specific encoding.
355
356	subwindow.
357		379
358	=item on_client_message $term, $event	380	=item on_client_message $term, $event
359		381
360	=item on_wm_protocols $term, $event	382	=item on_wm_protocols $term, $event
361		383
…		…
564	no warnings 'utf8';	586	no warnings 'utf8';
565		587
566	sub parse_resource {	588	sub parse_resource {
567	my ($term, $name, $isarg, $longopt, $flag, $value) = @_;	589	my ($term, $name, $isarg, $longopt, $flag, $value) = @_;
568		590
569	$name =~ y/-/./ if $isarg;
570
571	$term->scan_meta;	591	$term->scan_extensions;
572		592
573	my $r = $term->{meta}{resource};	593	my $r = $term->{meta}{resource};
574	keys %$r; # reste iterator	594	keys %$r; # reset iterator
575	while (my ($pattern, $v) = each %$r) {	595	while (my ($k, $v) = each %$r) {
576	if (	596	my $pattern = $k;
		597	$pattern =~ y/./-/ if $isarg;
		598	my $prefix = $name;
		599	my $suffix;
577	$pattern =~ /\.$/	600	if ($pattern =~ /\-$/) {
578	? $pattern eq substr $name, 0, length $pattern	601	$prefix = substr $name, 0, length $pattern;
579	: $pattern eq $name	602	$suffix = substr $name, length $pattern;
580	) {	603	}
		604	if ($pattern eq $prefix) {
581	$name = "$urxvt::RESCLASS.$name";	605	$name = "$urxvt::RESCLASS.$k$suffix";
582		606
583	push @{ $term->{perl_ext_3} }, $v->[0];	607	push @{ $term->{perl_ext_3} }, $v->[0];
		608
		609	return 1 unless $isarg;
584		610
585	if ($v->[1] eq "boolean") {	611	if ($v->[1] eq "boolean") {
586	$term->put_option_db ($name, $flag ? "true" : "false");	612	$term->put_option_db ($name, $flag ? "true" : "false");
587	return 1;	613	return 1;
588	} else {	614	} else {
…		…
596	}	622	}
597		623
598	sub usage {	624	sub usage {
599	my ($term, $usage_type) = @_;	625	my ($term, $usage_type) = @_;
600		626
601	$term->scan_meta;	627	$term->scan_extensions;
602		628
603	my $r = $term->{meta}{resource};	629	my $r = $term->{meta}{resource};
604		630
605	for my $pattern (sort keys %$r) {	631	for my $pattern (sort keys %$r) {
606	my ($ext, $type, $desc) = @{ $r->{$pattern} };	632	my ($ext, $type, $desc) = @{ $r->{$pattern} };
…		…
667	# called by the rxvt core	693	# called by the rxvt core
668	sub invoke {	694	sub invoke {
669	local $TERM = shift;	695	local $TERM = shift;
670	my $htype = shift;	696	my $htype = shift;
671		697
672	if ($htype == 0) { # INIT	698	if ($htype == HOOK_INIT) {
673	my @dirs = $TERM->perl_libdirs;	699	my @dirs = $TERM->perl_libdirs;
		700
		701	$TERM->scan_extensions;
674		702
675	my %ext_arg;	703	my %ext_arg;
676		704
677	{	705	{
678	my @init = @TERM_INIT;	706	my @init = @TERM_INIT;
…		…
682	@TERM_EXT = ();	710	@TERM_EXT = ();
683	$TERM->register_package ($_) for @pkg;	711	$TERM->register_package ($_) for @pkg;
684	}	712	}
685		713
686	for (	714	for (
		715	(grep $_, map { split /,/, $TERM->resource ("perl_ext_$_") } 1, 2),
687	@{ delete $TERM->{perl_ext_3} },	716	@{ delete $TERM->{perl_ext_3} }
688	grep $_, map { split /,/, $TERM->resource ("perl_ext_$_") } 1, 2
689	) {	717	) {
690	if ($_ eq "default") {	718	if ($_ eq "default") {
		719
		720	$ext_arg{$_} = []
691	$ext_arg{$_} \|\|= [] for qw(selection option-popup selection-popup searchable-scrollback readline);	721	for qw(selection option-popup selection-popup readline searchable-scrollback);
		722
		723	for ($TERM->_keysym_resources) {
		724	next if /^(?:string\|command\|builtin\|builtin-string\|perl)/;
		725	next unless /^([A-Za-z0-9_\-]+):/;
		726
		727	my $ext = $1;
		728
		729	$ext_arg{$ext} = [];
		730	}
		731
692	} elsif (/^-(.*)$/) {	732	} elsif (/^-(.*)$/) {
693	delete $ext_arg{$1};	733	delete $ext_arg{$1};
		734
694	} elsif (/^([^<]+)<(.*)>$/) {	735	} elsif (/^([^<]+)<(.*)>$/) {
695	push @{ $ext_arg{$1} }, $2;	736	push @{ $ext_arg{$1} }, $2;
		737
696	} else {	738	} else {
697	$ext_arg{$_} \|\|= [];	739	$ext_arg{$_} \|\|= [];
698	}	740	}
699	}	741	}
700		742
…		…
716		758
717	if (my $cb = $TERM->{_hook}[$htype]) {	759	if (my $cb = $TERM->{_hook}[$htype]) {
718	verbose 10, "$HOOKNAME[$htype] (" . (join ", ", $TERM, @_) . ")"	760	verbose 10, "$HOOKNAME[$htype] (" . (join ", ", $TERM, @_) . ")"
719	if $verbosity >= 10;	761	if $verbosity >= 10;
720		762
		763	if ($htype == HOOK_ACTION) {
		764	# this hook is only sent to the extension with the name
		765	# matching the first arg
		766	my $pkg = shift;
		767	$pkg =~ y/-/_/;
		768	$pkg = "urxvt::ext::$pkg";
		769
		770	$cb = $cb->{$pkg}
		771	or return undef; #TODO: maybe warn user?
		772
		773	$cb = { $pkg => $cb };
		774	}
		775
721	for my $pkg (keys %$cb) {	776	for my $pkg (keys %$cb) {
722	my $retval_ = eval { $cb->{$pkg}->($TERM->{_pkg}{$pkg} \|\| $TERM, @_) };	777	my $retval_ = eval { $cb->{$pkg}->($TERM->{_pkg}{$pkg} \|\| $TERM, @_) };
723	$retval \|\|= $retval_;	778	$retval \|\|= $retval_;
724		779
725	if ($@) {	780	if ($@) {
…		…
730		785
731	verbose 11, "$HOOKNAME[$htype] returning <$retval>"	786	verbose 11, "$HOOKNAME[$htype] returning <$retval>"
732	if $verbosity >= 11;	787	if $verbosity >= 11;
733	}	788	}
734		789
735	if ($htype == 1) { # DESTROY	790	if ($htype == HOOK_DESTROY) {
736	# clear package objects	791	# clear package objects
737	%$_ = () for values %{ $TERM->{_pkg} };	792	%$_ = () for values %{ $TERM->{_pkg} };
738		793
739	# clear package	794	# clear package
740	%$TERM = ();	795	%$TERM = ();
…		…
827	}	882	}
828		883
829	=item $self->enable ($hook_name => $cb[, $hook_name => $cb..])	884	=item $self->enable ($hook_name => $cb[, $hook_name => $cb..])
830		885
831	Dynamically enable the given hooks (named without the C<on_> prefix) for	886	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	887	this extension, replacing any hook previously installed via C<enable> in
833	to overwrite time-critical hooks only temporarily.	888	this extension.
		889
		890	This is useful when you want to overwrite time-critical hooks only
		891	temporarily.
834		892
835	To install additional callbacks for the same hook, you can use the C<on>	893	To install additional callbacks for the same hook, you can use the C<on>
836	method of the C<urxvt::term> class.	894	method of the C<urxvt::term> class.
837		895
838	=item $self->disable ($hook_name[, $hook_name..])	896	=item $self->disable ($hook_name[, $hook_name..])
…		…
909	}	967	}
910		968
911	bless \%disable, "urxvt::extension::on_disable"	969	bless \%disable, "urxvt::extension::on_disable"
912	}	970	}
913		971
		972	=item $self->bind_action ($hotkey, $action)
		973
914	=item $self->x_resource ($pattern)	974	=item $self->x_resource ($pattern)
915		975
916	=item $self->x_resource_boolean ($pattern)	976	=item $self->x_resource_boolean ($pattern)
917		977
918	These methods support an additional C<%> prefix when called on an	978	These methods support an additional C<%> prefix for C<$action> or
919	extension object - see the description of these methods in the	979	C<$pattern> when called on an extension object, compared to the
		980	C<urxvt::term> methods of the same name - see the description of these
920	C<urxvt::term> class for details.	981	methods in the C<urxvt::term> class for details.
921		982
922	=cut	983	=cut
		984
		985	sub bind_action {
		986	my ($self, $hotkey, $action) = @_;
		987	$action =~ s/^%:/$_[0]{_name}:/;
		988	$self->{term}->bind_action ($hotkey, $action)
		989	}
923		990
924	sub x_resource {	991	sub x_resource {
925	my ($self, $name) = @_;	992	my ($self, $name) = @_;
926	$name =~ s/^%(\.\|$)/$_[0]{_name}$1/;	993	$name =~ s/^%(\.\|$)/$_[0]{_name}$1/;
927	$self->{term}->x_resource ($name)	994	$self->{term}->x_resource ($name)
…		…
1062	$ENV{URXVT_PERL_LIB},	1129	$ENV{URXVT_PERL_LIB},
1063	"$ENV{HOME}/.urxvt/ext",	1130	"$ENV{HOME}/.urxvt/ext",
1064	"$LIBDIR/perl"	1131	"$LIBDIR/perl"
1065	}	1132	}
1066		1133
1067	sub scan_meta {	1134	# scan for available extensions and collect their metadata
		1135	sub scan_extensions {
1068	my ($self) = @_;	1136	my ($self) = @_;
		1137
		1138	return if exists $self->{meta};
		1139
1069	my @libdirs = perl_libdirs $self;	1140	my @urxvtdirs = perl_libdirs $self;
		1141	# my @cpandirs = grep -d, map "$_/URxvt/Ext", @INC;
1070		1142
1071	return if $self->{meta_libdirs} eq join "\x00", @libdirs;
1072
1073	my %meta;
1074
1075	$self->{meta_libdirs} = join "\x00", @libdirs;
1076	$self->{meta} = \%meta;	1143	$self->{meta} = \my %meta;
1077		1144
1078	for my $dir (reverse @libdirs) {	1145	# first gather extensions
		1146
		1147	my $gather = sub {
		1148	my ($dir, $core) = @_;
		1149
1079	opendir my $fh, $dir	1150	opendir my $fh, $dir
1080	or next;	1151	or return;
		1152
1081	for my $ext (readdir $fh) {	1153	for my $ext (readdir $fh) {
1082	$ext ne "."	1154	$ext !~ /^\./
1083	and $ext ne ".."
1084	and open my $fh, "<", "$dir/$ext"
1085	or next;	1155	or next;
1086		1156
		1157	open my $fh, "<", "$dir/$ext"
		1158	or next;
		1159
		1160	-f $fh
		1161	or next;
		1162
		1163	$ext =~ s/\.uext$// or $core
		1164	or next;
		1165
		1166	my %ext = (dir => $dir);
		1167
1087	while (<$fh>) {	1168	while (<$fh>) {
1088	if (/^#:META:X_RESOURCE:(.*)/) {	1169	if (/^#:META:(?:X_)?RESOURCE:(.*)/) {
1089	my ($pattern, $type, $desc) = split /:/, $1;	1170	my ($pattern, $type, $desc) = split /:/, $1;
1090	$pattern =~ s/^%(\.\|$)/$ext$1/g; # % in pattern == extension name	1171	$pattern =~ s/^%(\.\|$)/$ext$1/g; # % in pattern == extension name
1091	if ($pattern =~ /[^a-zA-Z0-9\-\.]/) {	1172	if ($pattern =~ /[^a-zA-Z0-9\-\.]/) {
1092	warn "$dir/$ext: meta resource '$pattern' contains illegal characters (not alphanumeric nor . nor *)\n";	1173	warn "$dir/$ext: meta resource '$pattern' contains illegal characters (not alphanumeric nor . nor *)\n";
1093	} else {	1174	} else {
1094	$meta{resource}{$pattern} = [$ext, $type, $desc];	1175	$ext{resource}{$pattern} = [$ext, $type, $desc];
1095	}	1176	}
1096	} elsif (/^\s*(?:#\|$)/) {	1177	} elsif (/^\s*(?:#\|$)/) {
1097	# skip other comments and empty lines	1178	# skip other comments and empty lines
1098	} else {	1179	} else {
1099	last; # stop parsing on first non-empty non-comment line	1180	last; # stop parsing on first non-empty non-comment line
1100	}	1181	}
1101	}	1182	}
		1183
		1184	$meta{ext}{$ext} = \%ext;
1102	}	1185	}
		1186	};
		1187
		1188	# $gather->($_, 0) for @cpandirs;
		1189	$gather->($_, 1) for @urxvtdirs;
		1190
		1191	# and now merge resources
		1192
		1193	$meta{resource} = \my %resource;
		1194
		1195	while (my ($k, $v) = each %{ $meta{ext} }) {
		1196	#TODO: should check for extensions overriding each other
		1197	%resource = (%resource, %{ $v->{resource} });
1103	}	1198	}
1104	}	1199	}
1105		1200
1106	=item $term = new urxvt::term $envhashref, $rxvtname, [arg...]	1201	=item $term = new urxvt::term $envhashref, $rxvtname, [arg...]
1107		1202
…		…
1127	}	1222	}
1128		1223
1129	=item $term->destroy	1224	=item $term->destroy
1130		1225
1131	Destroy the terminal object (close the window, free resources	1226	Destroy the terminal object (close the window, free resources
1132	etc.). Please note that @@RXVT_NAME@@ will not exit as long as any event	1227	etc.). Please note that urxvt will not exit as long as any event
1133	watchers (timers, io watchers) are still active.	1228	watchers (timers, io watchers) are still active.
1134		1229
1135	=item $term->exec_async ($cmd[, @args])	1230	=item $term->exec_async ($cmd[, @args])
1136		1231
1137	Works like the combination of the C<fork>/C<exec> builtins, which executes	1232	Works like the combination of the C<fork>/C<exec> builtins, which executes
…		…
1223	Returns the X-Resource for the given pattern, excluding the program or	1318	Returns the X-Resource for the given pattern, excluding the program or
1224	class name, i.e. C<< $term->x_resource ("boldFont") >> should return the	1319	class name, i.e. C<< $term->x_resource ("boldFont") >> should return the
1225	same value as used by this instance of rxvt-unicode. Returns C<undef> if no	1320	same value as used by this instance of rxvt-unicode. Returns C<undef> if no
1226	resource with that pattern exists.	1321	resource with that pattern exists.
1227		1322
1228	Extensions that define extra resource or command line arguments also need	1323	Extensions that define extra resources also need to call this method
1229	to call this method to access their values.	1324	to access their values.
1230		1325
1231	If the method is called on an extension object (basically, from an	1326	If the method is called on an extension object (basically, from an
1232	extension), then the special prefix C<%.> will be replaced by the name of	1327	extension), then the special prefix C<%.> will be replaced by the name of
1233	the extension and a dot, and the lone string C<%> will be replaced by the	1328	the extension and a dot, and the lone string C<%> will be replaced by the
1234	extension name itself. This makes it possible to code extensions so you	1329	extension name itself. This makes it possible to code extensions so you
1235	can rename them and get a new set of commandline switches and resources	1330	can rename them and get a new set of resources without having to change
1236	without having to change the actual code.	1331	the actual code.
1237		1332
1238	This method should only be called during the C<on_start> hook, as there is	1333	This method should only be called during the C<on_start> hook, as there is
1239	only one resource database per display, and later invocations might return	1334	only one resource database per display, and later invocations might return
1240	the wrong resources.	1335	the wrong resources.
1241		1336
…		…
1253	my $res = &x_resource;	1348	my $res = &x_resource;
1254		1349
1255	$res =~ /^\s(?:true\|yes\|on\|1)\s$/i ? 1 : defined $res && 0	1350	$res =~ /^\s(?:true\|yes\|on\|1)\s$/i ? 1 : defined $res && 0
1256	}	1351	}
1257		1352
1258	=item $success = $term->parse_keysym ($key, $octets)	1353	=item $action = $term->lookup_keysym ($keysym, $state)
1259		1354
		1355	Returns the action bound to key combination C<($keysym, $state)>,
		1356	if a binding for it exists, and C<undef> otherwise.
		1357
		1358	=item $success = $term->bind_action ($key, $action)
		1359
1260	Adds a key binding exactly as specified via a resource. See the	1360	Adds a key binding exactly as specified via a C<keysym> resource. See the
1261	C<keysym> resource in the @@RXVT_NAME@@(1) manpage.	1361	C<keysym> resource in the urxvt(1) manpage.
1262		1362
1263	=item $term->register_command ($keysym, $modifiermask, $string)	1363	To add default bindings for actions, an extension should call C<<
		1364	->bind_action >> in its C<init> hook for every such binding. Doing it
		1365	in the C<init> hook allows users to override or remove the binding
		1366	again.
1264		1367
1265	Adds a key binding. This is a lower level api compared to	1368	Example: the C<searchable-scrollback> by default binds itself
1266	C<parse_keysym>, as it expects a parsed key description, and can be	1369	on C<Meta-s>, using C<< $self->bind_action >>, which calls C<<
1267	used only inside either the C<on_init> hook, to add a binding, or the	1370	$term->bind_action >>.
1268	C<on_register_command> hook, to modify a parsed binding.	1371
		1372	sub init {
		1373	my ($self) = @_;
		1374
		1375	$self->bind_action ("M-s" => "%:start");
		1376	}
1269		1377
1270	=item $rend = $term->rstyle ([$new_rstyle])	1378	=item $rend = $term->rstyle ([$new_rstyle])
1271		1379
1272	Return and optionally change the current rendition. Text that is output by	1380	Return and optionally change the current rendition. Text that is output by
1273	the terminal application will use this style.	1381	the terminal application will use this style.
…		…
1431		1539
1432	=item $term->scr_add_lines ($string)	1540	=item $term->scr_add_lines ($string)
1433		1541
1434	Write the given text string to the screen, as if output by the application	1542	Write the given text string to the screen, as if output by the application
1435	running inside the terminal. It may not contain command sequences (escape	1543	running inside the terminal. It may not contain command sequences (escape
1436	codes), but is free to use line feeds, carriage returns and tabs. The	1544	codes - see C<cmd_parse> for that), but is free to use line feeds,
1437	string is a normal text string, not in locale-dependent encoding.	1545	carriage returns and tabs. The string is a normal text string, not in
		1546	locale-dependent encoding.
1438		1547
1439	Normally its not a good idea to use this function, as programs might be	1548	Normally its not a good idea to use this function, as programs might be
1440	confused by changes in cursor position or scrolling. Its useful inside a	1549	confused by changes in cursor position or scrolling. Its useful inside a
1441	C<on_add_lines> hook, though.	1550	C<on_add_lines> hook, though.
1442		1551
…		…
1450	locale-specific encoding of the terminal and can contain command sequences	1559	locale-specific encoding of the terminal and can contain command sequences
1451	(escape codes) that will be interpreted.	1560	(escape codes) that will be interpreted.
1452		1561
1453	=item $term->tt_write ($octets)	1562	=item $term->tt_write ($octets)
1454		1563
1455	Write the octets given in C<$octets> to the tty (i.e. as program input). To	1564	Write the octets given in C<$octets> to the tty (i.e. as user input
		1565	to the program, see C<cmd_parse> for the opposite direction). To pass
1456	pass characters instead of octets, you should convert your strings first	1566	characters instead of octets, you should convert your strings first to the
1457	to the locale-specific encoding using C<< $term->locale_encode >>.	1567	locale-specific encoding using C<< $term->locale_encode >>.
		1568
		1569	=item $term->tt_write_user_input ($octets)
		1570
		1571	Like C<tt_write>, but should be used when writing strings in response to
		1572	the user pressing a key, to invoke the additional actions requested by
		1573	the user for that case (C<tt_write> doesn't do that).
		1574
		1575	The typical use case would be inside C<on_action> hooks.
1458		1576
1459	=item $term->tt_paste ($octets)	1577	=item $term->tt_paste ($octets)
1460		1578
1461	Write the octets given in C<$octets> to the tty as a paste, converting NL to	1579	Write the octets given in C<$octets> to the tty as a paste, converting NL to
1462	CR and bracketing the data with control sequences if bracketed paste mode	1580	CR and bracketing the data with control sequences if bracketed paste mode
…		…
1501		1619
1502	=item $term->key_release ($state, $keycode[, $time])	1620	=item $term->key_release ($state, $keycode[, $time])
1503		1621
1504	Deliver various fake events to to terminal.	1622	Deliver various fake events to to terminal.
1505		1623
1506	=item $window_width = $term->width	1624	=item $window_width = $term->width ([$new_value])
1507		1625
1508	=item $window_height = $term->height	1626	=item $window_height = $term->height ([$new_value])
1509		1627
1510	=item $font_width = $term->fwidth	1628	=item $font_width = $term->fwidth ([$new_value])
1511		1629
1512	=item $font_height = $term->fheight	1630	=item $font_height = $term->fheight ([$new_value])
1513		1631
1514	=item $font_ascent = $term->fbase	1632	=item $font_ascent = $term->fbase ([$new_value])
1515		1633
1516	=item $terminal_rows = $term->nrow	1634	=item $terminal_rows = $term->nrow ([$new_value])
1517		1635
1518	=item $terminal_columns = $term->ncol	1636	=item $terminal_columns = $term->ncol ([$new_value])
1519		1637
1520	=item $has_focus = $term->focus	1638	=item $has_focus = $term->focus ([$new_value])
1521		1639
1522	=item $is_mapped = $term->mapped	1640	=item $is_mapped = $term->mapped ([$new_value])
1523		1641
1524	=item $max_scrollback = $term->saveLines	1642	=item $max_scrollback = $term->saveLines ([$new_value])
1525		1643
1526	=item $nrow_plus_saveLines = $term->total_rows	1644	=item $nrow_plus_saveLines = $term->total_rows ([$new_value])
1527		1645
1528	=item $topmost_scrollback_row = $term->top_row	1646	=item $topmost_scrollback_row = $term->top_row ([$new_value])
1529		1647
1530	Return various integers describing terminal characteristics.	1648	Return various integers describing terminal characteristics. If an
		1649	argument is given, changes the value and returns the previous one.
1531		1650
1532	=item $x_display = $term->display_id	1651	=item $x_display = $term->display_id
1533		1652
1534	Return the DISPLAY used by rxvt-unicode.	1653	Return the DISPLAY used by rxvt-unicode.
1535		1654
…		…
1585	Requests a screen refresh. At the next opportunity, rxvt-unicode will	1704	Requests a screen refresh. At the next opportunity, rxvt-unicode will
1586	compare the on-screen display with its stored representation. If they	1705	compare the on-screen display with its stored representation. If they
1587	differ, it redraws the differences.	1706	differ, it redraws the differences.
1588		1707
1589	Used after changing terminal contents to display them.	1708	Used after changing terminal contents to display them.
		1709
		1710	=item $term->refresh_check
		1711
		1712	Checks if a refresh has been requested and, if so, schedules one.
1590		1713
1591	=item $text = $term->ROW_t ($row_number[, $new_text[, $start_col]])	1714	=item $text = $term->ROW_t ($row_number[, $new_text[, $start_col]])
1592		1715
1593	Returns the text of the entire row with number C<$row_number>. Row C<< $term->top_row >>	1716	Returns the text of the entire row with number C<$row_number>. Row C<< $term->top_row >>
1594	is the topmost terminal line, row C<< $term->nrow-1 >> is the bottommost	1717	is the topmost terminal line, row C<< $term->nrow-1 >> is the bottommost
…		…
1696	}	1819	}
1697		1820
1698	sub urxvt::line::t {	1821	sub urxvt::line::t {
1699	my ($self) = @_;	1822	my ($self) = @_;
1700		1823
1701	if (@_ > 1)	1824	if (@_ > 1) {
1702	{
1703	$self->{term}->ROW_t ($_, $_[1], 0, ($_ - $self->{beg}) * $self->{ncol}, $self->{ncol})	1825	$self->{term}->ROW_t ($_, $_[1], 0, ($_ - $self->{beg}) * $self->{ncol}, $self->{ncol})
1704	for $self->{beg} .. $self->{end};	1826	for $self->{beg} .. $self->{end};
1705	}	1827	}
1706		1828
1707	defined wantarray &&	1829	defined wantarray &&
1708	substr +(join "", map $self->{term}->ROW_t ($_), $self->{beg} .. $self->{end}),	1830	substr +(join "", map $self->{term}->ROW_t ($_), $self->{beg} .. $self->{end}),
1709	0, $self->{len}	1831	0, $self->{len}
1710	}	1832	}
1711		1833
1712	sub urxvt::line::r {	1834	sub urxvt::line::r {
1713	my ($self) = @_;	1835	my ($self) = @_;
1714		1836
1715	if (@_ > 1)	1837	if (@_ > 1) {
1716	{
1717	$self->{term}->ROW_r ($_, $_[1], 0, ($_ - $self->{beg}) * $self->{ncol}, $self->{ncol})	1838	$self->{term}->ROW_r ($_, $_[1], 0, ($_ - $self->{beg}) * $self->{ncol}, $self->{ncol})
1718	for $self->{beg} .. $self->{end};	1839	for $self->{beg} .. $self->{end};
1719	}	1840	}
1720		1841
1721	if (defined wantarray) {	1842	if (defined wantarray) {
1722	my $rend = [	1843	my $rend = [
1723	map @{ $self->{term}->ROW_r ($_) }, $self->{beg} .. $self->{end}	1844	map @{ $self->{term}->ROW_r ($_) }, $self->{beg} .. $self->{end}
1724	];	1845	];

Diff Legend

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

Comparing rxvt-unicode/src/urxvt.pm (file contents): Revision 1.224 by root, Sat Jul 14 08:00:34 2012 UTC vs. Revision 1.256 by sf-exg, Thu Jul 14 05:10:06 2016 UTC

Diff Legend

Comparing rxvt-unicode/src/urxvt.pm (file contents):
Revision 1.224 by root, Sat Jul 14 08:00:34 2012 UTC vs.
Revision 1.256 by sf-exg, Thu Jul 14 05:10:06 2016 UTC