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

Comparing rxvt-unicode/src/urxvt.pm (file contents):
Revision 1.231 by root, Sun Apr 27 20:26:28 2014 UTC vs.
Revision 1.257 by root, Thu Jul 13 10:31:27 2017 UTC

…		…
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 DEPRECATED	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 urxvt(1) manpage).	321	resource in the urxvt(1) manpage).
291		322
292	The event is simply the action string. This interface is going away in	323	The event is simply the action string. This interface is going away in
293	preference to the C<< ->register_keysym_action >> method.	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 a true value the binding
299	is not 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
…		…
487	ConfigureRequest, GravityNotify, ResizeRequest, CirculateNotify,	511	ConfigureRequest, GravityNotify, ResizeRequest, CirculateNotify,
488	CirculateRequest, PropertyNotify, SelectionClear, SelectionRequest,	512	CirculateRequest, PropertyNotify, SelectionClear, SelectionRequest,
489	SelectionNotify, ColormapNotify, ClientMessage, MappingNotify	513	SelectionNotify, ColormapNotify, ClientMessage, MappingNotify
490		514
491	Various constants for use in X calls and event processing.	515	Various constants for use in X calls and event processing.
		516
		517	=item urxvt::PrivMode_132, PrivMode_132OK, PrivMode_rVideo, PrivMode_relOrigin,
		518	PrivMode_Screen, PrivMode_Autowrap, PrivMode_aplCUR, PrivMode_aplKP,
		519	PrivMode_HaveBackSpace, PrivMode_BackSpace, PrivMode_ShiftKeys,
		520	PrivMode_VisibleCursor, PrivMode_MouseX10, PrivMode_MouseX11,
		521	PrivMode_scrollBar, PrivMode_TtyOutputInh, PrivMode_Keypress,
		522	PrivMode_smoothScroll, PrivMode_vt52, PrivMode_LFNL, PrivMode_MouseBtnEvent,
		523	PrivMode_MouseAnyEvent, PrivMode_BracketPaste, PrivMode_ExtModeMouse,
		524	PrivMode_ExtMouseRight, PrivMode_BlinkingCursor, PrivMode_mouse_report,
		525	PrivMode_Default
		526
		527	Constants for checking DEC private modes.
492		528
493	=back	529	=back
494		530
495	=head2 RENDITION	531	=head2 RENDITION
496		532
…		…
562	no warnings 'utf8';	598	no warnings 'utf8';
563		599
564	sub parse_resource {	600	sub parse_resource {
565	my ($term, $name, $isarg, $longopt, $flag, $value) = @_;	601	my ($term, $name, $isarg, $longopt, $flag, $value) = @_;
566		602
567	$name =~ y/-/./ if $isarg;
568
569	$term->scan_meta;	603	$term->scan_extensions;
570		604
571	my $r = $term->{meta}{resource};	605	my $r = $term->{meta}{resource};
572	keys %$r; # reset iterator	606	keys %$r; # reset iterator
573	while (my ($pattern, $v) = each %$r) {	607	while (my ($k, $v) = each %$r) {
574	if (	608	my $pattern = $k;
		609	$pattern =~ y/./-/ if $isarg;
		610	my $prefix = $name;
		611	my $suffix;
575	$pattern =~ /\.$/	612	if ($pattern =~ /\-$/) {
576	? $pattern eq substr $name, 0, length $pattern	613	$prefix = substr $name, 0, length $pattern;
577	: $pattern eq $name	614	$suffix = substr $name, length $pattern;
578	) {	615	}
		616	if ($pattern eq $prefix) {
579	$name = "$urxvt::RESCLASS.$name";	617	$name = "$urxvt::RESCLASS.$k$suffix";
580		618
581	push @{ $term->{perl_ext_3} }, $v->[0];	619	push @{ $term->{perl_ext_3} }, $v->[0];
		620
		621	return 1 unless $isarg;
582		622
583	if ($v->[1] eq "boolean") {	623	if ($v->[1] eq "boolean") {
584	$term->put_option_db ($name, $flag ? "true" : "false");	624	$term->put_option_db ($name, $flag ? "true" : "false");
585	return 1;	625	return 1;
586	} else {	626	} else {
…		…
594	}	634	}
595		635
596	sub usage {	636	sub usage {
597	my ($term, $usage_type) = @_;	637	my ($term, $usage_type) = @_;
598		638
599	$term->scan_meta;	639	$term->scan_extensions;
600		640
601	my $r = $term->{meta}{resource};	641	my $r = $term->{meta}{resource};
602		642
603	for my $pattern (sort keys %$r) {	643	for my $pattern (sort keys %$r) {
604	my ($ext, $type, $desc) = @{ $r->{$pattern} };	644	my ($ext, $type, $desc) = @{ $r->{$pattern} };
…		…
668	my $htype = shift;	708	my $htype = shift;
669		709
670	if ($htype == HOOK_INIT) {	710	if ($htype == HOOK_INIT) {
671	my @dirs = $TERM->perl_libdirs;	711	my @dirs = $TERM->perl_libdirs;
672		712
		713	$TERM->scan_extensions;
		714
673	my %ext_arg;	715	my %ext_arg;
674		716
675	{	717	{
676	my @init = @TERM_INIT;	718	my @init = @TERM_INIT;
677	@TERM_INIT = ();	719	@TERM_INIT = ();
…		…
680	@TERM_EXT = ();	722	@TERM_EXT = ();
681	$TERM->register_package ($_) for @pkg;	723	$TERM->register_package ($_) for @pkg;
682	}	724	}
683		725
684	for (	726	for (
		727	(grep $_, map { split /,/, $TERM->resource ("perl_ext_$_") } 1, 2),
685	@{ delete $TERM->{perl_ext_3} },	728	@{ delete $TERM->{perl_ext_3} }
686	grep $_, map { split /,/, $TERM->resource ("perl_ext_$_") } 1, 2
687	) {	729	) {
688	if ($_ eq "default") {	730	if ($_ eq "default") {
		731
		732	$ext_arg{$_} = []
689	$ext_arg{$_} \|\|= [] for qw(selection option-popup selection-popup searchable-scrollback readline);	733	for qw(selection option-popup selection-popup readline searchable-scrollback);
		734
		735	for ($TERM->_keysym_resources) {
		736	next if /^(?:string\|command\|builtin\|builtin-string\|perl)/;
		737	next unless /^([A-Za-z0-9_\-]+):/;
		738
		739	my $ext = $1;
		740
		741	$ext_arg{$ext} = [];
		742	}
		743
690	} elsif (/^-(.*)$/) {	744	} elsif (/^-(.*)$/) {
691	delete $ext_arg{$1};	745	delete $ext_arg{$1};
		746
692	} elsif (/^([^<]+)<(.*)>$/) {	747	} elsif (/^([^<]+)<(.*)>$/) {
693	push @{ $ext_arg{$1} }, $2;	748	push @{ $ext_arg{$1} }, $2;
		749
694	} else {	750	} else {
695	$ext_arg{$_} \|\|= [];	751	$ext_arg{$_} \|\|= [];
696	}	752	}
697	}	753	}
698		754
…		…
714		770
715	if (my $cb = $TERM->{_hook}[$htype]) {	771	if (my $cb = $TERM->{_hook}[$htype]) {
716	verbose 10, "$HOOKNAME[$htype] (" . (join ", ", $TERM, @_) . ")"	772	verbose 10, "$HOOKNAME[$htype] (" . (join ", ", $TERM, @_) . ")"
717	if $verbosity >= 10;	773	if $verbosity >= 10;
718		774
719	for my $pkg (	775	if ($htype == HOOK_ACTION) {
720	# this hook is only sent to the extension with the name	776	# this hook is only sent to the extension with the name
721	# matching the first arg	777	# matching the first arg
722	$htype == HOOK_KEYBOARD_DISPATCH	778	my $pkg = shift;
723	? exists $cb->{"urxvt::ext::$_[0]"} ? "urxvt::ext::" . shift : return undef	779	$pkg =~ y/-/_/;
724	: keys %$cb	780	$pkg = "urxvt::ext::$pkg";
		781
		782	$cb = $cb->{$pkg}
		783	or return undef; #TODO: maybe warn user?
		784
		785	$cb = { $pkg => $cb };
725	) {	786	}
		787
		788	for my $pkg (keys %$cb) {
726	my $retval_ = eval { $cb->{$pkg}->($TERM->{_pkg}{$pkg} \|\| $TERM, @_) };	789	my $retval_ = eval { $cb->{$pkg}->($TERM->{_pkg}{$pkg} \|\| $TERM, @_) };
727	$retval \|\|= $retval_;	790	$retval \|\|= $retval_;
728		791
729	if ($@) {	792	if ($@) {
730	$TERM->ungrab; # better to lose the grab than the session	793	$TERM->ungrab; # better to lose the grab than the session
…		…
916	}	979	}
917		980
918	bless \%disable, "urxvt::extension::on_disable"	981	bless \%disable, "urxvt::extension::on_disable"
919	}	982	}
920		983
		984	=item $self->bind_action ($hotkey, $action)
		985
921	=item $self->x_resource ($pattern)	986	=item $self->x_resource ($pattern)
922		987
923	=item $self->x_resource_boolean ($pattern)	988	=item $self->x_resource_boolean ($pattern)
924		989
925	These methods support an additional C<%> prefix when called on an	990	These methods support an additional C<%> prefix for C<$action> or
926	extension object - see the description of these methods in the	991	C<$pattern> when called on an extension object, compared to the
		992	C<urxvt::term> methods of the same name - see the description of these
927	C<urxvt::term> class for details.	993	methods in the C<urxvt::term> class for details.
928		994
929	=cut	995	=cut
		996
		997	sub bind_action {
		998	my ($self, $hotkey, $action) = @_;
		999	$action =~ s/^%:/$_[0]{_name}:/;
		1000	$self->{term}->bind_action ($hotkey, $action)
		1001	}
930		1002
931	sub x_resource {	1003	sub x_resource {
932	my ($self, $name) = @_;	1004	my ($self, $name) = @_;
933	$name =~ s/^%(\.\|$)/$_[0]{_name}$1/;	1005	$name =~ s/^%(\.\|$)/$_[0]{_name}$1/;
934	$self->{term}->x_resource ($name)	1006	$self->{term}->x_resource ($name)
…		…
1069	$ENV{URXVT_PERL_LIB},	1141	$ENV{URXVT_PERL_LIB},
1070	"$ENV{HOME}/.urxvt/ext",	1142	"$ENV{HOME}/.urxvt/ext",
1071	"$LIBDIR/perl"	1143	"$LIBDIR/perl"
1072	}	1144	}
1073		1145
1074	sub scan_meta {	1146	# scan for available extensions and collect their metadata
		1147	sub scan_extensions {
1075	my ($self) = @_;	1148	my ($self) = @_;
		1149
		1150	return if exists $self->{meta};
		1151
1076	my @libdirs = perl_libdirs $self;	1152	my @urxvtdirs = perl_libdirs $self;
		1153	# my @cpandirs = grep -d, map "$_/URxvt/Ext", @INC;
1077		1154
1078	return if $self->{meta_libdirs} eq join "\x00", @libdirs;
1079
1080	my %meta;
1081
1082	$self->{meta_libdirs} = join "\x00", @libdirs;
1083	$self->{meta} = \%meta;	1155	$self->{meta} = \my %meta;
1084		1156
1085	for my $dir (reverse @libdirs) {	1157	# first gather extensions
		1158
		1159	my $gather = sub {
		1160	my ($dir, $core) = @_;
		1161
1086	opendir my $fh, $dir	1162	opendir my $fh, $dir
1087	or next;	1163	or return;
		1164
1088	for my $ext (readdir $fh) {	1165	for my $ext (readdir $fh) {
1089	$ext !~ /^\./	1166	$ext !~ /^\./
1090	and open my $fh, "<", "$dir/$ext"
1091	or next;	1167	or next;
1092		1168
		1169	open my $fh, "<", "$dir/$ext"
		1170	or next;
		1171
		1172	-f $fh
		1173	or next;
		1174
		1175	$ext =~ s/\.uext$// or $core
		1176	or next;
		1177
		1178	my %ext = (dir => $dir);
		1179
1093	while (<$fh>) {	1180	while (<$fh>) {
1094	if (/^#:META:X_RESOURCE:(.*)/) {	1181	if (/^#:META:(?:X_)?RESOURCE:(.*)/) {
1095	my ($pattern, $type, $desc) = split /:/, $1;	1182	my ($pattern, $type, $desc) = split /:/, $1;
1096	$pattern =~ s/^%(\.\|$)/$ext$1/g; # % in pattern == extension name	1183	$pattern =~ s/^%(\.\|$)/$ext$1/g; # % in pattern == extension name
1097	if ($pattern =~ /[^a-zA-Z0-9\-\.]/) {	1184	if ($pattern =~ /[^a-zA-Z0-9\-\.]/) {
1098	warn "$dir/$ext: meta resource '$pattern' contains illegal characters (not alphanumeric nor . nor *)\n";	1185	warn "$dir/$ext: meta resource '$pattern' contains illegal characters (not alphanumeric nor . nor *)\n";
1099	} else {	1186	} else {
1100	$meta{resource}{$pattern} = [$ext, $type, $desc];	1187	$ext{resource}{$pattern} = [$ext, $type, $desc];
1101	}	1188	}
1102	} elsif (/^\s*(?:#\|$)/) {	1189	} elsif (/^\s*(?:#\|$)/) {
1103	# skip other comments and empty lines	1190	# skip other comments and empty lines
1104	} else {	1191	} else {
1105	last; # stop parsing on first non-empty non-comment line	1192	last; # stop parsing on first non-empty non-comment line
1106	}	1193	}
1107	}	1194	}
		1195
		1196	$meta{ext}{$ext} = \%ext;
1108	}	1197	}
		1198	};
		1199
		1200	# $gather->($_, 0) for @cpandirs;
		1201	$gather->($_, 1) for @urxvtdirs;
		1202
		1203	# and now merge resources
		1204
		1205	$meta{resource} = \my %resource;
		1206
		1207	while (my ($k, $v) = each %{ $meta{ext} }) {
		1208	#TODO: should check for extensions overriding each other
		1209	%resource = (%resource, %{ $v->{resource} });
1109	}	1210	}
1110	}	1211	}
1111		1212
1112	=item $term = new urxvt::term $envhashref, $rxvtname, [arg...]	1213	=item $term = new urxvt::term $envhashref, $rxvtname, [arg...]
1113		1214
…		…
1229	Returns the X-Resource for the given pattern, excluding the program or	1330	Returns the X-Resource for the given pattern, excluding the program or
1230	class name, i.e. C<< $term->x_resource ("boldFont") >> should return the	1331	class name, i.e. C<< $term->x_resource ("boldFont") >> should return the
1231	same value as used by this instance of rxvt-unicode. Returns C<undef> if no	1332	same value as used by this instance of rxvt-unicode. Returns C<undef> if no
1232	resource with that pattern exists.	1333	resource with that pattern exists.
1233		1334
1234	Extensions that define extra resource or command line arguments also need	1335	Extensions that define extra resources also need to call this method
1235	to call this method to access their values.	1336	to access their values.
1236		1337
1237	If the method is called on an extension object (basically, from an	1338	If the method is called on an extension object (basically, from an
1238	extension), then the special prefix C<%.> will be replaced by the name of	1339	extension), then the special prefix C<%.> will be replaced by the name of
1239	the extension and a dot, and the lone string C<%> will be replaced by the	1340	the extension and a dot, and the lone string C<%> will be replaced by the
1240	extension name itself. This makes it possible to code extensions so you	1341	extension name itself. This makes it possible to code extensions so you
1241	can rename them and get a new set of commandline switches and resources	1342	can rename them and get a new set of resources without having to change
1242	without having to change the actual code.	1343	the actual code.
1243		1344
1244	This method should only be called during the C<on_start> hook, as there is	1345	This method should only be called during the C<on_start> hook, as there is
1245	only one resource database per display, and later invocations might return	1346	only one resource database per display, and later invocations might return
1246	the wrong resources.	1347	the wrong resources.
1247		1348
…		…
1259	my $res = &x_resource;	1360	my $res = &x_resource;
1260		1361
1261	$res =~ /^\s(?:true\|yes\|on\|1)\s$/i ? 1 : defined $res && 0	1362	$res =~ /^\s(?:true\|yes\|on\|1)\s$/i ? 1 : defined $res && 0
1262	}	1363	}
1263		1364
1264	=item $success = $term->parse_keysym ($key, $octets)	1365	=item $action = $term->lookup_keysym ($keysym, $state)
1265		1366
		1367	Returns the action bound to key combination C<($keysym, $state)>,
		1368	if a binding for it exists, and C<undef> otherwise.
		1369
		1370	=item $success = $term->bind_action ($key, $action)
		1371
1266	Adds a key binding exactly as specified via a resource. See the	1372	Adds a key binding exactly as specified via a C<keysym> resource. See the
1267	C<keysym> resource in the urxvt(1) manpage.	1373	C<keysym> resource in the urxvt(1) manpage.
1268		1374
1269	=item $term->register_command ($keysym, $modifiermask, $string)	1375	To add default bindings for actions, an extension should call C<<
		1376	->bind_action >> in its C<init> hook for every such binding. Doing it
		1377	in the C<init> hook allows users to override or remove the binding
		1378	again.
1270		1379
1271	Adds a key binding. This is a lower level api compared to	1380	Example: the C<searchable-scrollback> by default binds itself
1272	C<parse_keysym>, as it expects a parsed key description, and can be	1381	on C<Meta-s>, using C<< $self->bind_action >>, which calls C<<
1273	used only inside either the C<on_init> hook, to add a binding, or the	1382	$term->bind_action >>.
1274	C<on_register_command> hook, to modify a parsed binding.	1383
		1384	sub init {
		1385	my ($self) = @_;
		1386
		1387	$self->bind_action ("M-s" => "%:start");
		1388	}
1275		1389
1276	=item $rend = $term->rstyle ([$new_rstyle])	1390	=item $rend = $term->rstyle ([$new_rstyle])
1277		1391
1278	Return and optionally change the current rendition. Text that is output by	1392	Return and optionally change the current rendition. Text that is output by
1279	the terminal application will use this style.	1393	the terminal application will use this style.
…		…
1437		1551
1438	=item $term->scr_add_lines ($string)	1552	=item $term->scr_add_lines ($string)
1439		1553
1440	Write the given text string to the screen, as if output by the application	1554	Write the given text string to the screen, as if output by the application
1441	running inside the terminal. It may not contain command sequences (escape	1555	running inside the terminal. It may not contain command sequences (escape
1442	codes), but is free to use line feeds, carriage returns and tabs. The	1556	codes - see C<cmd_parse> for that), but is free to use line feeds,
1443	string is a normal text string, not in locale-dependent encoding.	1557	carriage returns and tabs. The string is a normal text string, not in
		1558	locale-dependent encoding.
1444		1559
1445	Normally its not a good idea to use this function, as programs might be	1560	Normally its not a good idea to use this function, as programs might be
1446	confused by changes in cursor position or scrolling. Its useful inside a	1561	confused by changes in cursor position or scrolling. Its useful inside a
1447	C<on_add_lines> hook, though.	1562	C<on_add_lines> hook, though.
1448		1563
…		…
1456	locale-specific encoding of the terminal and can contain command sequences	1571	locale-specific encoding of the terminal and can contain command sequences
1457	(escape codes) that will be interpreted.	1572	(escape codes) that will be interpreted.
1458		1573
1459	=item $term->tt_write ($octets)	1574	=item $term->tt_write ($octets)
1460		1575
1461	Write the octets given in C<$octets> to the tty (i.e. as program input). To	1576	Write the octets given in C<$octets> to the tty (i.e. as user input
		1577	to the program, see C<cmd_parse> for the opposite direction). To pass
1462	pass characters instead of octets, you should convert your strings first	1578	characters instead of octets, you should convert your strings first to the
1463	to the locale-specific encoding using C<< $term->locale_encode >>.	1579	locale-specific encoding using C<< $term->locale_encode >>.
		1580
		1581	=item $term->tt_write_user_input ($octets)
		1582
		1583	Like C<tt_write>, but should be used when writing strings in response to
		1584	the user pressing a key, to invoke the additional actions requested by
		1585	the user for that case (C<tt_write> doesn't do that).
		1586
		1587	The typical use case would be inside C<on_action> hooks.
1464		1588
1465	=item $term->tt_paste ($octets)	1589	=item $term->tt_paste ($octets)
1466		1590
1467	Write the octets given in C<$octets> to the tty as a paste, converting NL to	1591	Write the octets given in C<$octets> to the tty as a paste, converting NL to
1468	CR and bracketing the data with control sequences if bracketed paste mode	1592	CR and bracketing the data with control sequences if bracketed paste mode
…		…
1507		1631
1508	=item $term->key_release ($state, $keycode[, $time])	1632	=item $term->key_release ($state, $keycode[, $time])
1509		1633
1510	Deliver various fake events to to terminal.	1634	Deliver various fake events to to terminal.
1511		1635
1512	=item $window_width = $term->width	1636	=item $window_width = $term->width ([$new_value])
1513		1637
1514	=item $window_height = $term->height	1638	=item $window_height = $term->height ([$new_value])
1515		1639
1516	=item $font_width = $term->fwidth	1640	=item $font_width = $term->fwidth ([$new_value])
1517		1641
1518	=item $font_height = $term->fheight	1642	=item $font_height = $term->fheight ([$new_value])
1519		1643
1520	=item $font_ascent = $term->fbase	1644	=item $font_ascent = $term->fbase ([$new_value])
1521		1645
1522	=item $terminal_rows = $term->nrow	1646	=item $terminal_rows = $term->nrow ([$new_value])
1523		1647
1524	=item $terminal_columns = $term->ncol	1648	=item $terminal_columns = $term->ncol ([$new_value])
1525		1649
1526	=item $has_focus = $term->focus	1650	=item $has_focus = $term->focus ([$new_value])
1527		1651
1528	=item $is_mapped = $term->mapped	1652	=item $is_mapped = $term->mapped ([$new_value])
1529		1653
1530	=item $max_scrollback = $term->saveLines	1654	=item $max_scrollback = $term->saveLines ([$new_value])
1531		1655
1532	=item $nrow_plus_saveLines = $term->total_rows	1656	=item $nrow_plus_saveLines = $term->total_rows ([$new_value])
1533		1657
1534	=item $topmost_scrollback_row = $term->top_row	1658	=item $topmost_scrollback_row = $term->top_row ([$new_value])
1535		1659
1536	Return various integers describing terminal characteristics.	1660	Return various integers describing terminal characteristics. If an
		1661	argument is given, changes the value and returns the previous one.
1537		1662
1538	=item $x_display = $term->display_id	1663	=item $x_display = $term->display_id
1539		1664
1540	Return the DISPLAY used by rxvt-unicode.	1665	Return the DISPLAY used by rxvt-unicode.
1541		1666
…		…
1577	Returns the currently displayed screen (0 primary, 1 secondary).	1702	Returns the currently displayed screen (0 primary, 1 secondary).
1578		1703
1579	=item $cursor_is_hidden = $term->hidden_cursor	1704	=item $cursor_is_hidden = $term->hidden_cursor
1580		1705
1581	Returns whether the cursor is currently hidden or not.	1706	Returns whether the cursor is currently hidden or not.
		1707
		1708	=item $priv_modes = $term->priv_modes
		1709
		1710	Returns a bitset with the state of DEC private modes.
		1711
		1712	Example:
		1713
		1714	if ($term->priv_modes & urxvt::PrivMode_mouse_report) {
		1715	# mouse reporting is turned on
		1716	}
1582		1717
1583	=item $view_start = $term->view_start ([$newvalue])	1718	=item $view_start = $term->view_start ([$newvalue])
1584		1719
1585	Returns the row number of the topmost displayed line. Maximum value is	1720	Returns the row number of the topmost displayed line. Maximum value is
1586	C<0>, which displays the normal terminal contents. Lower values scroll	1721	C<0>, which displays the normal terminal contents. Lower values scroll
…		…
1591	Requests a screen refresh. At the next opportunity, rxvt-unicode will	1726	Requests a screen refresh. At the next opportunity, rxvt-unicode will
1592	compare the on-screen display with its stored representation. If they	1727	compare the on-screen display with its stored representation. If they
1593	differ, it redraws the differences.	1728	differ, it redraws the differences.
1594		1729
1595	Used after changing terminal contents to display them.	1730	Used after changing terminal contents to display them.
		1731
		1732	=item $term->refresh_check
		1733
		1734	Checks if a refresh has been requested and, if so, schedules one.
1596		1735
1597	=item $text = $term->ROW_t ($row_number[, $new_text[, $start_col]])	1736	=item $text = $term->ROW_t ($row_number[, $new_text[, $start_col]])
1598		1737
1599	Returns the text of the entire row with number C<$row_number>. Row C<< $term->top_row >>	1738	Returns the text of the entire row with number C<$row_number>. Row C<< $term->top_row >>
1600	is the topmost terminal line, row C<< $term->nrow-1 >> is the bottommost	1739	is the topmost terminal line, row C<< $term->nrow-1 >> is the bottommost

Diff Legend

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

Comparing rxvt-unicode/src/urxvt.pm (file contents): Revision 1.231 by root, Sun Apr 27 20:26:28 2014 UTC vs. Revision 1.257 by root, Thu Jul 13 10:31:27 2017 UTC

Diff Legend

Comparing rxvt-unicode/src/urxvt.pm (file contents):
Revision 1.231 by root, Sun Apr 27 20:26:28 2014 UTC vs.
Revision 1.257 by root, Thu Jul 13 10:31:27 2017 UTC