[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.245 by root, Mon Dec 22 09:10:12 2014 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 and also default bindings for one or
		51	more actions it provides using so called META comments, described
		52	below. Similarly to builtin resources, extension resources can also be
		53	specified on the command line as long options (with C<.> replaced by
		54	C<->), in which case the corresponding extension is loaded
		55	automatically. For this to work the extension B<must> define META
		56	comments for its resources.
50		57
51	=head1 API DOCUMENTATION	58	=head1 API DOCUMENTATION
52		59
53	=head2 General API Considerations	60	=head2 General API Considerations
54		61
106	C<urxvt::term> class on this object.	113	C<urxvt::term> class on this object.
107		114
108	Additional methods only supported for extension objects are described in	115	Additional methods only supported for extension objects are described in
109	the C<urxvt::extension> section below.	116	the C<urxvt::extension> section below.
110		117
		118	=head2 META comments
		119
		120	rxvt-unicode recognizes special comments in extensions that define
		121	different types of metadata:
		122
		123	=over 4
		124
		125	=item #:META:RESOURCE:name:type:desc
		126
		127	The RESOURCE comment defines a resource used by the extension, where
		128	C<name> is the resource name, C<type> is the resource type, C<boolean>
		129	or C<string>, and C<desc> is the resource description.
		130
		131	=item #:META:BINDING:sym:action
		132
		133	The BINDING comment defines a default binding for an action provided
		134	by the extension, where C<sym> is the key combination that triggers
		135	the action, whose format is defined in the description of the
		136	B<keysym> resource in the urxvt(1) manpage, and C<action> is the name
		137	of the action method.
		138
		139	=back
		140
111	=head2 Hooks	141	=head2 Hooks
112		142
113	The following subroutines can be declared in extension files, and will be	143	The following subroutines can be declared in extension files, and will be
114	called whenever the relevant event happens.	144	called whenever the relevant event happens.
115		145
…		…
281		311
282	=item on_refresh_end $term	312	=item on_refresh_end $term
283		313
284	Called just after the screen gets redrawn. See C<on_refresh_begin>.	314	Called just after the screen gets redrawn. See C<on_refresh_begin>.
285		315
		316	=item on_action $term, $string
		317
		318	Called whenever an action is invoked for the corresponding extension
		319	(e.g. via a C<extension:string> builtin action bound to a key, see
		320	description of the B<keysym> resource in the urxvt(1) manpage). The
		321	event is simply the action string. Note that an action event is always
		322	associated to a single extension.
		323
286	=item on_user_command $term, $string	324	=item on_user_command $term, $string DEPRECATED
287		325
288	Called whenever a user-configured event is being activated (e.g. via	326	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>	327	a C<perl:string> action bound to a key, see description of the B<keysym>
290	resource in the @@RXVT_NAME@@(1) manpage).	328	resource in the urxvt(1) manpage).
291		329
292	The event is simply the action string. This interface is assumed to change	330	The event is simply the action string. This interface is going away in
293	slightly in the future.	331	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		332
302	=item on_resize_all_windows $term, $new_width, $new_height	333	=item on_resize_all_windows $term, $new_width, $new_height
303		334
304	Called just after the new window size has been calculated, but before	335	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	336	windows are actually being resized or hints are being set. If this hook
306	returns TRUE, setting of the window hints is being skipped.	337	returns a true value, setting of the window hints is being skipped.
307		338
308	=item on_x_event $term, $event	339	=item on_x_event $term, $event
309		340
310	Called on every X event received on the vt window (and possibly other	341	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	342	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	381	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.	382	(real, not screen-based) row and column under the mouse cursor.
352		383
353	C<on_key_press> additionally receives the string rxvt-unicode would	384	C<on_key_press> additionally receives the string rxvt-unicode would
354	output, if any, in locale-specific encoding.	385	output, if any, in locale-specific encoding.
355
356	subwindow.
357		386
358	=item on_client_message $term, $event	387	=item on_client_message $term, $event
359		388
360	=item on_wm_protocols $term, $event	389	=item on_wm_protocols $term, $event
361		390
…		…
564	no warnings 'utf8';	593	no warnings 'utf8';
565		594
566	sub parse_resource {	595	sub parse_resource {
567	my ($term, $name, $isarg, $longopt, $flag, $value) = @_;	596	my ($term, $name, $isarg, $longopt, $flag, $value) = @_;
568		597
569	$name =~ y/-/./ if $isarg;
570
571	$term->scan_meta;	598	$term->scan_extensions;
572		599
573	my $r = $term->{meta}{resource};	600	my $r = $term->{meta}{resource};
574	keys %$r; # reste iterator	601	keys %$r; # reset iterator
575	while (my ($pattern, $v) = each %$r) {	602	while (my ($k, $v) = each %$r) {
576	if (	603	my $pattern = $k;
		604	$pattern =~ y/./-/ if $isarg;
		605	my $prefix = $name;
		606	my $suffix;
577	$pattern =~ /\.$/	607	if ($pattern =~ /\-$/) {
578	? $pattern eq substr $name, 0, length $pattern	608	$prefix = substr $name, 0, length $pattern;
579	: $pattern eq $name	609	$suffix = substr $name, length $pattern;
580	) {	610	}
		611	if ($pattern eq $prefix) {
581	$name = "$urxvt::RESCLASS.$name";	612	$name = "$urxvt::RESCLASS.$k$suffix";
582		613
583	push @{ $term->{perl_ext_3} }, $v->[0];	614	push @{ $term->{perl_ext_3} }, $v->[0];
584		615
585	if ($v->[1] eq "boolean") {	616	if ($v->[1] eq "boolean") {
586	$term->put_option_db ($name, $flag ? "true" : "false");	617	$term->put_option_db ($name, $flag ? "true" : "false");
…		…
596	}	627	}
597		628
598	sub usage {	629	sub usage {
599	my ($term, $usage_type) = @_;	630	my ($term, $usage_type) = @_;
600		631
601	$term->scan_meta;	632	$term->scan_extensions;
602		633
603	my $r = $term->{meta}{resource};	634	my $r = $term->{meta}{resource};
604		635
605	for my $pattern (sort keys %$r) {	636	for my $pattern (sort keys %$r) {
606	my ($ext, $type, $desc) = @{ $r->{$pattern} };	637	my ($ext, $type, $desc) = @{ $r->{$pattern} };
…		…
667	# called by the rxvt core	698	# called by the rxvt core
668	sub invoke {	699	sub invoke {
669	local $TERM = shift;	700	local $TERM = shift;
670	my $htype = shift;	701	my $htype = shift;
671		702
672	if ($htype == 0) { # INIT	703	if ($htype == HOOK_INIT) {
673	my @dirs = $TERM->perl_libdirs;	704	my @dirs = $TERM->perl_libdirs;
		705
		706	$TERM->scan_extensions;
674		707
675	my %ext_arg;	708	my %ext_arg;
676		709
677	{	710	{
678	my @init = @TERM_INIT;	711	my @init = @TERM_INIT;
…		…
682	@TERM_EXT = ();	715	@TERM_EXT = ();
683	$TERM->register_package ($_) for @pkg;	716	$TERM->register_package ($_) for @pkg;
684	}	717	}
685		718
686	for (	719	for (
		720	(grep $_, map { split /,/, $TERM->resource ("perl_ext_$_") } 1, 2),
687	@{ delete $TERM->{perl_ext_3} },	721	@{ delete $TERM->{perl_ext_3} }
688	grep $_, map { split /,/, $TERM->resource ("perl_ext_$_") } 1, 2
689	) {	722	) {
690	if ($_ eq "default") {	723	if ($_ eq "default") {
691	$ext_arg{$_} \|\|= [] for qw(selection option-popup selection-popup searchable-scrollback readline);	724
		725	$ext_arg{$_} = []
		726	for
		727	qw(selection option-popup selection-popup readline),
		728	map $_->[0], values %{ $TERM->{meta}{binding} };
		729
		730	for ($TERM->_keysym_resources) {
		731	next if /^(?:string\|command\|builtin\|builtin-string\|perl)/;
		732	next unless /^([A-Za-z0-9_\-]+):/;
		733
		734	my $ext = $1;
		735
		736	$ext_arg{$ext} = [];
		737	}
		738
692	} elsif (/^-(.*)$/) {	739	} elsif (/^-(.*)$/) {
693	delete $ext_arg{$1};	740	delete $ext_arg{$1};
		741
694	} elsif (/^([^<]+)<(.*)>$/) {	742	} elsif (/^([^<]+)<(.*)>$/) {
695	push @{ $ext_arg{$1} }, $2;	743	push @{ $ext_arg{$1} }, $2;
		744
696	} else {	745	} else {
697	$ext_arg{$_} \|\|= [];	746	$ext_arg{$_} \|\|= [];
		747	}
		748	}
		749
		750	# now register default key bindings
		751	for my $ext (sort keys %ext_arg) {
		752	while (my ($k, $v) = each %{ $TERM->{meta}{ext}{$ext}{binding} }) {
		753	$TERM->bind_action ($k, "$v->[0]:$v->[1]");
698	}	754	}
699	}	755	}
700		756
701	for my $ext (sort keys %ext_arg) {	757	for my $ext (sort keys %ext_arg) {
702	my @files = grep -f $_, map "$_/$ext", @dirs;	758	my @files = grep -f $_, map "$_/$ext", @dirs;
…		…
716		772
717	if (my $cb = $TERM->{_hook}[$htype]) {	773	if (my $cb = $TERM->{_hook}[$htype]) {
718	verbose 10, "$HOOKNAME[$htype] (" . (join ", ", $TERM, @_) . ")"	774	verbose 10, "$HOOKNAME[$htype] (" . (join ", ", $TERM, @_) . ")"
719	if $verbosity >= 10;	775	if $verbosity >= 10;
720		776
		777	if ($htype == HOOK_ACTION) {
		778	# this hook is only sent to the extension with the name
		779	# matching the first arg
		780	my $pkg = shift;
		781	$pkg =~ y/-/_/;
		782	$pkg = "urxvt::ext::$pkg";
		783
		784	$cb = $cb->{$pkg}
		785	or return undef; #TODO: maybe warn user?
		786
		787	$cb = { $pkg => $cb };
		788	}
		789
721	for my $pkg (keys %$cb) {	790	for my $pkg (keys %$cb) {
722	my $retval_ = eval { $cb->{$pkg}->($TERM->{_pkg}{$pkg} \|\| $TERM, @_) };	791	my $retval_ = eval { $cb->{$pkg}->($TERM->{_pkg}{$pkg} \|\| $TERM, @_) };
723	$retval \|\|= $retval_;	792	$retval \|\|= $retval_;
724		793
725	if ($@) {	794	if ($@) {
…		…
730		799
731	verbose 11, "$HOOKNAME[$htype] returning <$retval>"	800	verbose 11, "$HOOKNAME[$htype] returning <$retval>"
732	if $verbosity >= 11;	801	if $verbosity >= 11;
733	}	802	}
734		803
735	if ($htype == 1) { # DESTROY	804	if ($htype == HOOK_DESTROY) {
736	# clear package objects	805	# clear package objects
737	%$_ = () for values %{ $TERM->{_pkg} };	806	%$_ = () for values %{ $TERM->{_pkg} };
738		807
739	# clear package	808	# clear package
740	%$TERM = ();	809	%$TERM = ();
…		…
827	}	896	}
828		897
829	=item $self->enable ($hook_name => $cb[, $hook_name => $cb..])	898	=item $self->enable ($hook_name => $cb[, $hook_name => $cb..])
830		899
831	Dynamically enable the given hooks (named without the C<on_> prefix) for	900	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	901	this extension, replacing any hook previously installed via C<enable> in
833	to overwrite time-critical hooks only temporarily.	902	this extension.
		903
		904	This is useful when you want to overwrite time-critical hooks only
		905	temporarily.
834		906
835	To install additional callbacks for the same hook, you can use the C<on>	907	To install additional callbacks for the same hook, you can use the C<on>
836	method of the C<urxvt::term> class.	908	method of the C<urxvt::term> class.
837		909
838	=item $self->disable ($hook_name[, $hook_name..])	910	=item $self->disable ($hook_name[, $hook_name..])
…		…
1062	$ENV{URXVT_PERL_LIB},	1134	$ENV{URXVT_PERL_LIB},
1063	"$ENV{HOME}/.urxvt/ext",	1135	"$ENV{HOME}/.urxvt/ext",
1064	"$LIBDIR/perl"	1136	"$LIBDIR/perl"
1065	}	1137	}
1066		1138
1067	sub scan_meta {	1139	# scan for available extensions and collect their metadata
		1140	sub scan_extensions {
1068	my ($self) = @_;	1141	my ($self) = @_;
		1142
		1143	return if exists $self->{meta};
		1144
1069	my @libdirs = perl_libdirs $self;	1145	my @libdirs = perl_libdirs $self;
1070		1146
1071	return if $self->{meta_libdirs} eq join "\x00", @libdirs;	1147	# return if $self->{meta_libdirs} eq join "\x00", @libdirs;#d#
1072		1148
1073	my %meta;
1074
1075	$self->{meta_libdirs} = join "\x00", @libdirs;	1149	# $self->{meta_libdirs} = join "\x00", @libdirs;#d#
1076	$self->{meta} = \%meta;	1150	$self->{meta} = \my %meta;
1077		1151
		1152	# first gather extensions
1078	for my $dir (reverse @libdirs) {	1153	for my $dir (reverse @libdirs) {
1079	opendir my $fh, $dir	1154	opendir my $fh, $dir
1080	or next;	1155	or next;
1081	for my $ext (readdir $fh) {	1156	for my $ext (readdir $fh) {
1082	$ext ne "."	1157	$ext !~ /^\./
1083	and $ext ne ".."
1084	and open my $fh, "<", "$dir/$ext"	1158	and open my $fh, "<", "$dir/$ext"
1085	or next;	1159	or next;
1086		1160
		1161	my %ext = (dir => $dir);
		1162
1087	while (<$fh>) {	1163	while (<$fh>) {
1088	if (/^#:META:X_RESOURCE:(.*)/) {	1164	if (/^#:META:(?:X_)?RESOURCE:(.*)/) {
1089	my ($pattern, $type, $desc) = split /:/, $1;	1165	my ($pattern, $type, $desc) = split /:/, $1;
1090	$pattern =~ s/^%(\.\|$)/$ext$1/g; # % in pattern == extension name	1166	$pattern =~ s/^%(\.\|$)/$ext$1/g; # % in pattern == extension name
1091	if ($pattern =~ /[^a-zA-Z0-9\-\.]/) {	1167	if ($pattern =~ /[^a-zA-Z0-9\-\.]/) {
1092	warn "$dir/$ext: meta resource '$pattern' contains illegal characters (not alphanumeric nor . nor *)\n";	1168	warn "$dir/$ext: meta resource '$pattern' contains illegal characters (not alphanumeric nor . nor *)\n";
1093	} else {	1169	} else {
1094	$meta{resource}{$pattern} = [$ext, $type, $desc];	1170	$ext{resource}{$pattern} = [$ext, $type, $desc];
1095	}	1171	}
		1172	} elsif (/^#:META:BINDING:(.*)/) {
		1173	my ($keysym, $action) = split /:/, $1;
		1174	$ext{binding}{$keysym} = [$ext, $action];
1096	} elsif (/^\s*(?:#\|$)/) {	1175	} elsif (/^\s*(?:#\|$)/) {
1097	# skip other comments and empty lines	1176	# skip other comments and empty lines
1098	} else {	1177	} else {
1099	last; # stop parsing on first non-empty non-comment line	1178	last; # stop parsing on first non-empty non-comment line
1100	}	1179	}
1101	}	1180	}
		1181
		1182	$meta{ext}{$ext} = \%ext;
1102	}	1183	}
		1184	}
		1185
		1186	# and now merge resources and bindings
		1187	while (my ($k, $v) = each %{ $meta{ext} }) {
		1188	#TODO: should check for extensions overriding each other
		1189	%{ $meta{resource} } = (%{ $meta{resource} }, %{ $v->{resource} });
		1190	%{ $meta{binding} } = (%{ $meta{binding} }, %{ $v->{binding} });
1103	}	1191	}
1104	}	1192	}
1105		1193
1106	=item $term = new urxvt::term $envhashref, $rxvtname, [arg...]	1194	=item $term = new urxvt::term $envhashref, $rxvtname, [arg...]
1107		1195
…		…
1127	}	1215	}
1128		1216
1129	=item $term->destroy	1217	=item $term->destroy
1130		1218
1131	Destroy the terminal object (close the window, free resources	1219	Destroy the terminal object (close the window, free resources
1132	etc.). Please note that @@RXVT_NAME@@ will not exit as long as any event	1220	etc.). Please note that urxvt will not exit as long as any event
1133	watchers (timers, io watchers) are still active.	1221	watchers (timers, io watchers) are still active.
1134		1222
1135	=item $term->exec_async ($cmd[, @args])	1223	=item $term->exec_async ($cmd[, @args])
1136		1224
1137	Works like the combination of the C<fork>/C<exec> builtins, which executes	1225	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	1311	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	1312	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	1313	same value as used by this instance of rxvt-unicode. Returns C<undef> if no
1226	resource with that pattern exists.	1314	resource with that pattern exists.
1227		1315
1228	Extensions that define extra resource or command line arguments also need	1316	Extensions that define extra resources also need to call this method
1229	to call this method to access their values.	1317	to access their values.
1230		1318
1231	If the method is called on an extension object (basically, from an	1319	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	1320	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	1321	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	1322	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	1323	can rename them and get a new set of resources without having to change
1236	without having to change the actual code.	1324	the actual code.
1237		1325
1238	This method should only be called during the C<on_start> hook, as there is	1326	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	1327	only one resource database per display, and later invocations might return
1240	the wrong resources.	1328	the wrong resources.
1241		1329
…		…
1253	my $res = &x_resource;	1341	my $res = &x_resource;
1254		1342
1255	$res =~ /^\s(?:true\|yes\|on\|1)\s$/i ? 1 : defined $res && 0	1343	$res =~ /^\s(?:true\|yes\|on\|1)\s$/i ? 1 : defined $res && 0
1256	}	1344	}
1257		1345
1258	=item $success = $term->parse_keysym ($key, $octets)	1346	=item $success = $term->bind_action ($key, $octets)
1259		1347
1260	Adds a key binding exactly as specified via a resource. See the	1348	Adds a key binding exactly as specified via a C<keysym> resource. See the
1261	C<keysym> resource in the @@RXVT_NAME@@(1) manpage.	1349	C<keysym> resource in the urxvt(1) manpage.
1262
1263	=item $term->register_command ($keysym, $modifiermask, $string)
1264
1265	Adds a key binding. This is a lower level api compared to
1266	C<parse_keysym>, as it expects a parsed key description, and can be
1267	used only inside either the C<on_init> hook, to add a binding, or the
1268	C<on_register_command> hook, to modify a parsed binding.
1269		1350
1270	=item $rend = $term->rstyle ([$new_rstyle])	1351	=item $rend = $term->rstyle ([$new_rstyle])
1271		1352
1272	Return and optionally change the current rendition. Text that is output by	1353	Return and optionally change the current rendition. Text that is output by
1273	the terminal application will use this style.	1354	the terminal application will use this style.
…		…
1431		1512
1432	=item $term->scr_add_lines ($string)	1513	=item $term->scr_add_lines ($string)
1433		1514
1434	Write the given text string to the screen, as if output by the application	1515	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	1516	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	1517	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.	1518	carriage returns and tabs. The string is a normal text string, not in
		1519	locale-dependent encoding.
1438		1520
1439	Normally its not a good idea to use this function, as programs might be	1521	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	1522	confused by changes in cursor position or scrolling. Its useful inside a
1441	C<on_add_lines> hook, though.	1523	C<on_add_lines> hook, though.
1442		1524
…		…
1450	locale-specific encoding of the terminal and can contain command sequences	1532	locale-specific encoding of the terminal and can contain command sequences
1451	(escape codes) that will be interpreted.	1533	(escape codes) that will be interpreted.
1452		1534
1453	=item $term->tt_write ($octets)	1535	=item $term->tt_write ($octets)
1454		1536
1455	Write the octets given in C<$octets> to the tty (i.e. as program input). To	1537	Write the octets given in C<$octets> to the tty (i.e. as user input
		1538	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	1539	characters instead of octets, you should convert your strings first to the
1457	to the locale-specific encoding using C<< $term->locale_encode >>.	1540	locale-specific encoding using C<< $term->locale_encode >>.
		1541
		1542	=item $term->tt_write_user_input ($octets)
		1543
		1544	Like C<tt_write>, but should be used when writing strings in response to
		1545	the user pressing a key, to invoke the additional actions requested by
		1546	the user for that case (C<tt_write> doesn't do that).
		1547
		1548	The typical use case would be inside C<on_action> hooks.
1458		1549
1459	=item $term->tt_paste ($octets)	1550	=item $term->tt_paste ($octets)
1460		1551
1461	Write the octets given in C<$octets> to the tty as a paste, converting NL to	1552	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	1553	CR and bracketing the data with control sequences if bracketed paste mode
…		…
1696	}	1787	}
1697		1788
1698	sub urxvt::line::t {	1789	sub urxvt::line::t {
1699	my ($self) = @_;	1790	my ($self) = @_;
1700		1791
1701	if (@_ > 1)	1792	if (@_ > 1) {
1702	{
1703	$self->{term}->ROW_t ($_, $_[1], 0, ($_ - $self->{beg}) * $self->{ncol}, $self->{ncol})	1793	$self->{term}->ROW_t ($_, $_[1], 0, ($_ - $self->{beg}) * $self->{ncol}, $self->{ncol})
1704	for $self->{beg} .. $self->{end};	1794	for $self->{beg} .. $self->{end};
1705	}	1795	}
1706		1796
1707	defined wantarray &&	1797	defined wantarray &&
1708	substr +(join "", map $self->{term}->ROW_t ($_), $self->{beg} .. $self->{end}),	1798	substr +(join "", map $self->{term}->ROW_t ($_), $self->{beg} .. $self->{end}),
1709	0, $self->{len}	1799	0, $self->{len}
1710	}	1800	}
1711		1801
1712	sub urxvt::line::r {	1802	sub urxvt::line::r {
1713	my ($self) = @_;	1803	my ($self) = @_;
1714		1804
1715	if (@_ > 1)	1805	if (@_ > 1) {
1716	{
1717	$self->{term}->ROW_r ($_, $_[1], 0, ($_ - $self->{beg}) * $self->{ncol}, $self->{ncol})	1806	$self->{term}->ROW_r ($_, $_[1], 0, ($_ - $self->{beg}) * $self->{ncol}, $self->{ncol})
1718	for $self->{beg} .. $self->{end};	1807	for $self->{beg} .. $self->{end};
1719	}	1808	}
1720		1809
1721	if (defined wantarray) {	1810	if (defined wantarray) {
1722	my $rend = [	1811	my $rend = [
1723	map @{ $self->{term}->ROW_r ($_) }, $self->{beg} .. $self->{end}	1812	map @{ $self->{term}->ROW_r ($_) }, $self->{beg} .. $self->{end}
1724	];	1813	];

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.245 by root, Mon Dec 22 09:10:12 2014 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.245 by root, Mon Dec 22 09:10:12 2014 UTC