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

Comparing rxvt-unicode/src/urxvt.pm (file contents):
Revision 1.239 by sf-exg, Wed May 28 15:51:29 2014 UTC vs.
Revision 1.265 by root, Sat Jul 24 09:48:43 2021 UTC

…		…
4		4
5	urxvtperl - 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 urxvt using it:	16	# start a urxvt instance using it:
17		17
18	urxvt --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.
…		…
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
…		…
64	terminal is destroyed.	70	terminal is destroyed.
65		71
66	Argument names also often indicate the type of a parameter. Here are some	72	Argument names also often indicate the type of a parameter. Here are some
67	hints on what they mean:	73	hints on what they mean:
68		74
69	=over 4	75	=over
70		76
71	=item $text	77	=item $text
72		78
73	Rxvt-unicode's special way of encoding text, where one "unicode" character	79	Rxvt-unicode's special way of encoding text, where one "unicode" character
74	always represents one screen cell. See L<ROW_t> for a discussion of this format.	80	always represents one screen cell. See L<ROW_t> for a discussion of this format.
…		…
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
		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
…		…
120	hooks returns true, then the event counts as being I<consumed>, and the	148	hooks returns true, then the event counts as being I<consumed>, and the
121	relevant action might not be carried out by the C++ code.	149	relevant action might not be carried out by the C++ code.
122		150
123	I<< When in doubt, return a false value (preferably C<()>). >>	151	I<< When in doubt, return a false value (preferably C<()>). >>
124		152
125	=over 4	153	=over
126		154
127	=item on_init $term	155	=item on_init $term
128		156
129	Called after a new terminal object has been initialized, but before	157	Called after a new terminal object has been initialized, but before
130	windows are created or the command gets run. Most methods are unsafe to	158	windows are created or the command gets run. Most methods are unsafe to
…		…
280	code is run after this hook, and takes precedence.	308	code is run after this hook, and takes precedence.
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>.
		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.
285		321
286	=item on_user_command $term, $string DEPRECATED	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>
…		…
386		422
387	our $NOCHAR = chr 0xffff;	423	our $NOCHAR = chr 0xffff;
388		424
389	=head2 Variables in the C<urxvt> Package	425	=head2 Variables in the C<urxvt> Package
390		426
391	=over 4	427	=over
392		428
393	=item $urxvt::LIBDIR	429	=item $urxvt::LIBDIR
394		430
395	The rxvt-unicode library directory, where, among other things, the perl	431	The rxvt-unicode library directory, where, among other things, the perl
396	modules and scripts are stored.	432	modules and scripts are stored.
…		…
426		462
427	=back	463	=back
428		464
429	=head2 Functions in the C<urxvt> Package	465	=head2 Functions in the C<urxvt> Package
430		466
431	=over 4	467	=over
432		468
433	=item urxvt::fatal $errormessage	469	=item urxvt::fatal $errormessage
434		470
435	Fatally aborts execution with the given error message (which should	471	Fatally aborts execution with the given error message (which should
436	include a trailing newline). Avoid at all costs! The only time this	472	include a trailing newline). Avoid at all costs! The only time this
…		…
481	CirculateRequest, PropertyNotify, SelectionClear, SelectionRequest,	517	CirculateRequest, PropertyNotify, SelectionClear, SelectionRequest,
482	SelectionNotify, ColormapNotify, ClientMessage, MappingNotify	518	SelectionNotify, ColormapNotify, ClientMessage, MappingNotify
483		519
484	Various constants for use in X calls and event processing.	520	Various constants for use in X calls and event processing.
485		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.
		533
486	=back	534	=back
487		535
488	=head2 RENDITION	536	=head2 RENDITION
489		537
490	Rendition bitsets contain information about colour, font, font styles and	538	Rendition bitsets contain information about colour, font, font styles and
…		…
493	The following "macros" deal with changes in rendition sets. You should	541	The following "macros" deal with changes in rendition sets. You should
494	never just create a bitset, you should always modify an existing one,	542	never just create a bitset, you should always modify an existing one,
495	as they contain important information required for correct operation of	543	as they contain important information required for correct operation of
496	rxvt-unicode.	544	rxvt-unicode.
497		545
498	=over 4	546	=over
499		547
500	=item $rend = urxvt::DEFAULT_RSTYLE	548	=item $rend = urxvt::DEFAULT_RSTYLE
501		549
502	Returns the default rendition, as used when the terminal is starting up or	550	Returns the default rendition, as used when the terminal is starting up or
503	being reset. Useful as a base to start when creating renditions.	551	being reset. Useful as a base to start when creating renditions.
…		…
555	no warnings 'utf8';	603	no warnings 'utf8';
556		604
557	sub parse_resource {	605	sub parse_resource {
558	my ($term, $name, $isarg, $longopt, $flag, $value) = @_;	606	my ($term, $name, $isarg, $longopt, $flag, $value) = @_;
559		607
560	$name =~ y/-/./ if $isarg;
561
562	$term->scan_extensions;	608	$term->scan_extensions;
563		609
		610	# iterating over all resources has quadratic time overhead
		611	# overall, maybe this could be optimised?
564	my $r = $term->{meta}{resource};	612	my $r = $term->{meta}{resource};
565	keys %$r; # reset iterator	613	keys %$r; # reset iterator
566	while (my ($pattern, $v) = each %$r) {	614	while (my ($k, $v) = each %$r) {
567	if (	615	my $pattern = $k;
		616	$pattern =~ y/./-/ if $isarg;
		617	my $prefix = $name;
		618	my $suffix;
568	$pattern =~ /\.$/	619	if ($pattern =~ /\-$/) {
569	? $pattern eq substr $name, 0, length $pattern	620	$prefix = substr $name, 0, length $pattern;
570	: $pattern eq $name	621	$suffix = substr $name, length $pattern;
571	) {	622	}
		623	if ($pattern eq $prefix) {
572	$name = "$urxvt::RESCLASS.$name";	624	$name = "$urxvt::RESCLASS.$k$suffix";
573		625
574	push @{ $term->{perl_ext_3} }, $v->[0];	626	push @{ $term->{perl_ext_3} }, $v->[0];
		627
		628	return 1 unless $isarg;
575		629
576	if ($v->[1] eq "boolean") {	630	if ($v->[1] eq "boolean") {
577	$term->put_option_db ($name, $flag ? "true" : "false");	631	$term->put_option_db ($name, $flag ? "true" : "false");
578	return 1;	632	return 1;
579	} else {	633	} else {
…		…
675	@TERM_EXT = ();	729	@TERM_EXT = ();
676	$TERM->register_package ($_) for @pkg;	730	$TERM->register_package ($_) for @pkg;
677	}	731	}
678		732
679	for (	733	for (
		734	@{ delete $TERM->{perl_ext_3} },
680	grep $_, map { split /,/, $TERM->resource ("perl_ext_$_") } 1, 2	735	(grep $_, map { split /,/, $TERM->resource ("perl_ext_$_") } 1, 2),
681	) {	736	) {
682	if ($_ eq "default") {	737	if ($_ eq "default") {
683		738
684	$ext_arg{$_} = []	739	$ext_arg{$_} = []
685	for
686	qw(selection option-popup selection-popup readline),	740	for qw(selection option-popup selection-popup readline searchable-scrollback confirm-paste);
687	map $_->[0], values %{ $TERM->{meta}{binding} },
688	@{ delete $TERM->{perl_ext_3} };
689		741
690	for ($TERM->_keysym_resources) {	742	for ($TERM->_keysym_resources) {
691	next if /^(?:string\|command\|builtin\|builtin-string\|perl)/;	743	next if /^(?:string\|command\|builtin\|builtin-string\|perl)/;
692	next unless /^([A-Za-z0-9_\-]+):/;	744	next unless /^([A-Za-z0-9_\-]+):/;
693		745
694	my $ext = $1;	746	my $ext = $1;
695	$ext =~ y/-/_/;
696		747
697	$ext_arg{$ext} = [];	748	$ext_arg{$ext} = [];
698	}	749	}
699		750
700	} elsif (/^-(.*)$/) {	751	} elsif (/^-(.*)$/) {
…		…
703	} elsif (/^([^<]+)<(.*)>$/) {	754	} elsif (/^([^<]+)<(.*)>$/) {
704	push @{ $ext_arg{$1} }, $2;	755	push @{ $ext_arg{$1} }, $2;
705		756
706	} else {	757	} else {
707	$ext_arg{$_} \|\|= [];	758	$ext_arg{$_} \|\|= [];
708	}
709	}
710
711	# now register default key bindings
712	for my $ext (sort keys %ext_arg) {
713	while (my ($k, $v) = each %{ $TERM->{meta}{ext}{$ext}{binding} }) {
714	$TERM->bind_action ($k, "$v->[0]:$v->[1]");
715	}	759	}
716	}	760	}
717		761
718	for my $ext (sort keys %ext_arg) {	762	for my $ext (sort keys %ext_arg) {
719	my @files = grep -f $_, map "$_/$ext", @dirs;	763	my @files = grep -f $_, map "$_/$ext", @dirs;
…		…
814		858
815	The methods (And data members) documented below can be called on extension	859	The methods (And data members) documented below can be called on extension
816	objects, in addition to call methods documented for the <urxvt::term>	860	objects, in addition to call methods documented for the <urxvt::term>
817	class.	861	class.
818		862
819	=over 4	863	=over
820		864
821	=item $urxvt_term = $self->{term}	865	=item $urxvt_term = $self->{term}
822		866
823	Returns the C<urxvt::term> object associated with this instance of the	867	Returns the C<urxvt::term> object associated with this instance of the
824	extension. This member I<must not> be changed in any way.	868	extension. This member I<must not> be changed in any way.
…		…
942	}	986	}
943		987
944	bless \%disable, "urxvt::extension::on_disable"	988	bless \%disable, "urxvt::extension::on_disable"
945	}	989	}
946		990
		991	=item $self->bind_action ($hotkey, $action)
		992
947	=item $self->x_resource ($pattern)	993	=item $self->x_resource ($pattern)
948		994
949	=item $self->x_resource_boolean ($pattern)	995	=item $self->x_resource_boolean ($pattern)
950		996
951	These methods support an additional C<%> prefix when called on an	997	These methods support an additional C<%> prefix for C<$action> or
952	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
953	C<urxvt::term> class for details.	1000	methods in the C<urxvt::term> class for details.
954		1001
955	=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	}
956		1009
957	sub x_resource {	1010	sub x_resource {
958	my ($self, $name) = @_;	1011	my ($self, $name) = @_;
959	$name =~ s/^%(\.\|$)/$_[0]{_name}$1/;	1012	$name =~ s/^%(\.\|$)/$_[0]{_name}$1/;
960	$self->{term}->x_resource ($name)	1013	$self->{term}->x_resource ($name)
…		…
1056		1109
1057	package urxvt::term;	1110	package urxvt::term;
1058		1111
1059	=head2 The C<urxvt::term> Class	1112	=head2 The C<urxvt::term> Class
1060		1113
1061	=over 4	1114	=over
1062		1115
1063	=cut	1116	=cut
1064		1117
1065	# find on_xxx subs in the package and register them	1118	# find on_xxx subs in the package and register them
1066	# as hooks	1119	# as hooks
…		…
1101	sub scan_extensions {	1154	sub scan_extensions {
1102	my ($self) = @_;	1155	my ($self) = @_;
1103		1156
1104	return if exists $self->{meta};	1157	return if exists $self->{meta};
1105		1158
1106	my @libdirs = perl_libdirs $self;	1159	my @urxvtdirs = perl_libdirs $self;
		1160	# my @cpandirs = grep -d, map "$_/URxvt/Ext", @INC;
1107		1161
1108	# return if $self->{meta_libdirs} eq join "\x00", @libdirs;#d#
1109
1110	# $self->{meta_libdirs} = join "\x00", @libdirs;#d#
1111	$self->{meta} = \my %meta;	1162	$self->{meta} = \my %meta;
1112		1163
1113	# first gather extensions	1164	# first gather extensions
1114	for my $dir (reverse @libdirs) {	1165
		1166	my $gather = sub {
		1167	my ($dir, $core) = @_;
		1168
1115	opendir my $fh, $dir	1169	opendir my $fh, $dir
1116	or next;	1170	or return;
		1171
1117	for my $ext (readdir $fh) {	1172	for my $ext (readdir $fh) {
1118	$ext !~ /^\./	1173	$ext !~ /^\./
		1174	or next;
		1175
1119	and open my $fh, "<", "$dir/$ext"	1176	open my $fh, "<", "$dir/$ext"
		1177	or next;
		1178
		1179	-f $fh
		1180	or next;
		1181
		1182	$ext =~ s/\.uext$// or $core
1120	or next;	1183	or next;
1121		1184
1122	my %ext = (dir => $dir);	1185	my %ext = (dir => $dir);
1123		1186
1124	while (<$fh>) {	1187	while (<$fh>) {
…		…
1128	if ($pattern =~ /[^a-zA-Z0-9\-\.]/) {	1191	if ($pattern =~ /[^a-zA-Z0-9\-\.]/) {
1129	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";
1130	} else {	1193	} else {
1131	$ext{resource}{$pattern} = [$ext, $type, $desc];	1194	$ext{resource}{$pattern} = [$ext, $type, $desc];
1132	}	1195	}
1133	} elsif (/^#:META:BINDING:(.*)/) {
1134	my ($keysym, $action) = split /:/, $1;
1135	$ext{binding}{$keysym} = [$ext, $action];
1136	} elsif (/^\s*(?:#\|$)/) {	1196	} elsif (/^\s*(?:#\|$)/) {
1137	# skip other comments and empty lines	1197	# skip other comments and empty lines
1138	} else {	1198	} else {
1139	last; # stop parsing on first non-empty non-comment line	1199	last; # stop parsing on first non-empty non-comment line
1140	}	1200	}
1141	}	1201	}
1142		1202
1143	$meta{ext}{$ext} = \%ext;	1203	$meta{ext}{$ext} = \%ext;
1144	}	1204	}
1145	}	1205	};
1146		1206
		1207	# $gather->($_, 0) for @cpandirs;
		1208	$gather->($_, 1) for @urxvtdirs;
		1209
1147	# and now merge resources and bindings	1210	# and now merge resources
		1211
		1212	$meta{resource} = \my %resource;
		1213
1148	while (my ($k, $v) = each %{ $meta{ext} }) {	1214	while (my ($k, $v) = each %{ $meta{ext} }) {
1149	#TODO: should check for extensions overriding each other	1215	#TODO: should check for extensions overriding each other
1150	%{ $meta{resource} } = (%{ $meta{resource} }, %{ $v->{resource} });	1216	%resource = (%resource, %{ $v->{resource} });
1151	%{ $meta{binding} } = (%{ $meta{binding} }, %{ $v->{binding} });
1152	}	1217	}
1153	}	1218	}
1154		1219
1155	=item $term = new urxvt::term $envhashref, $rxvtname, [arg...]	1220	=item $term = new urxvt::term $envhashref, $rxvtname, [arg...]
1156		1221
…		…
1219	insecure intensityStyles iso14755 iso14755_52 jumpScroll loginShell	1284	insecure intensityStyles iso14755 iso14755_52 jumpScroll loginShell
1220	mapAlert meta8 mouseWheelScrollPage override_redirect pastableTabs	1285	mapAlert meta8 mouseWheelScrollPage override_redirect pastableTabs
1221	pointerBlank reverseVideo scrollBar scrollBar_floating scrollBar_right	1286	pointerBlank reverseVideo scrollBar scrollBar_floating scrollBar_right
1222	scrollTtyKeypress scrollTtyOutput scrollWithBuffer secondaryScreen	1287	scrollTtyKeypress scrollTtyOutput scrollWithBuffer secondaryScreen
1223	secondaryScroll skipBuiltinGlyphs skipScroll transparent tripleclickwords	1288	secondaryScroll skipBuiltinGlyphs skipScroll transparent tripleclickwords
1224	urgentOnBell utmpInhibit visualBell	1289	urgentOnBell utmpInhibit visualBell disablePasteBrackets
1225		1290
1226	=item $value = $term->resource ($name[, $newval])	1291	=item $value = $term->resource ($name[, $newval])
1227		1292
1228	Returns the current resource value associated with a given name and	1293	Returns the current resource value associated with a given name and
1229	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>
…		…
1255	preeditType print_pipe pty_fd reverseVideo saveLines scrollBar	1320	preeditType print_pipe pty_fd reverseVideo saveLines scrollBar
1256	scrollBar_align scrollBar_floating scrollBar_right scrollBar_thickness	1321	scrollBar_align scrollBar_floating scrollBar_right scrollBar_thickness
1257	scrollTtyKeypress scrollTtyOutput scrollWithBuffer scrollstyle	1322	scrollTtyKeypress scrollTtyOutput scrollWithBuffer scrollstyle
1258	secondaryScreen secondaryScroll shade skipBuiltinGlyphs skipScroll	1323	secondaryScreen secondaryScroll shade skipBuiltinGlyphs skipScroll
1259	term_name title transient_for transparent tripleclickwords urgentOnBell	1324	term_name title transient_for transparent tripleclickwords urgentOnBell
1260	utmpInhibit visualBell	1325	utmpInhibit visualBell rewrapMode disablePasteBrackets
1261		1326
1262	=cut	1327	=cut
1263		1328
1264	sub resource($$;$) {	1329	sub resource($$;$) {
1265	my ($self, $name) = (shift, shift);	1330	my ($self, $name) = (shift, shift);
…		…
1272	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
1273	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
1274	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
1275	resource with that pattern exists.	1340	resource with that pattern exists.
1276		1341
1277	Extensions that define extra resource or command line arguments also need	1342	Extensions that define extra resources also need to call this method
1278	to call this method to access their values.	1343	to access their values.
1279		1344
1280	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
1281	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
1282	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
1283	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
1284	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
1285	without having to change the actual code.	1350	the actual code.
1286		1351
1287	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
1288	only one resource database per display, and later invocations might return	1353	only one resource database per display, and later invocations might return
1289	the wrong resources.	1354	the wrong resources.
1290		1355
…		…
1302	my $res = &x_resource;	1367	my $res = &x_resource;
1303		1368
1304	$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
1305	}	1370	}
1306		1371
		1372	=item $action = $term->lookup_keysym ($keysym, $state)
		1373
		1374	Returns the action bound to key combination C<($keysym, $state)>,
		1375	if a binding for it exists, and C<undef> otherwise.
		1376
1307	=item $success = $term->bind_action ($key, $octets)	1377	=item $success = $term->bind_action ($key, $action)
1308		1378
1309	Adds a key binding exactly as specified via a C<keysym> resource. See the	1379	Adds a key binding exactly as specified via a C<keysym> resource. See the
1310	C<keysym> resource in the urxvt(1) manpage.	1380	C<keysym> resource in the urxvt(1) manpage.
		1381
		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.
		1386
		1387	Example: the C<searchable-scrollback> by default binds itself
		1388	on C<Meta-s>, using C<< $self->bind_action >>, which calls C<<
		1389	$term->bind_action >>.
		1390
		1391	sub init {
		1392	my ($self) = @_;
		1393
		1394	$self->bind_action ("M-s" => "%:start");
		1395	}
1311		1396
1312	=item $rend = $term->rstyle ([$new_rstyle])	1397	=item $rend = $term->rstyle ([$new_rstyle])
1313		1398
1314	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
1315	the terminal application will use this style.	1400	the terminal application will use this style.
…		…
1392	This method returns an urxvt::overlay object. The overlay will be visible	1477	This method returns an urxvt::overlay object. The overlay will be visible
1393	as long as the perl object is referenced.	1478	as long as the perl object is referenced.
1394		1479
1395	The methods currently supported on C<urxvt::overlay> objects are:	1480	The methods currently supported on C<urxvt::overlay> objects are:
1396		1481
1397	=over 4	1482	=over
1398		1483
1399	=item $overlay->set ($x, $y, $text[, $rend])	1484	=item $overlay->set ($x, $y, $text[, $rend])
1400		1485
1401	Similar to C<< $term->ROW_t >> and C<< $term->ROW_r >> in that it puts	1486	Similar to C<< $term->ROW_t >> and C<< $term->ROW_r >> in that it puts
1402	text in rxvt-unicode's special encoding and an array of rendition values	1487	text in rxvt-unicode's special encoding and an array of rendition values
…		…
1473		1558
1474	=item $term->scr_add_lines ($string)	1559	=item $term->scr_add_lines ($string)
1475		1560
1476	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
1477	running inside the terminal. It may not contain command sequences (escape	1562	running inside the terminal. It may not contain command sequences (escape
1478	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,
1479	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.
1480		1566
1481	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
1482	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
1483	C<on_add_lines> hook, though.	1569	C<on_add_lines> hook, though.
1484		1570
…		…
1492	locale-specific encoding of the terminal and can contain command sequences	1578	locale-specific encoding of the terminal and can contain command sequences
1493	(escape codes) that will be interpreted.	1579	(escape codes) that will be interpreted.
1494		1580
1495	=item $term->tt_write ($octets)	1581	=item $term->tt_write ($octets)
1496		1582
1497	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
1498	pass characters instead of octets, you should convert your strings first	1585	characters instead of octets, you should convert your strings first to the
1499	to the locale-specific encoding using C<< $term->locale_encode >>.	1586	locale-specific encoding using C<< $term->locale_encode >>.
1500		1587
1501	=item $term->tt_write_user_input ($octets)	1588	=item $term->tt_write_user_input ($octets)
1502		1589
1503	Like C<tt_write>, but should be used when writing strings in response to	1590	Like C<tt_write>, but should be used when writing strings in response to
1504	the user pressing a key, to invoke the additional actions requested by	1591	the user pressing a key, to invoke the additional actions requested by
…		…
1551		1638
1552	=item $term->key_release ($state, $keycode[, $time])	1639	=item $term->key_release ($state, $keycode[, $time])
1553		1640
1554	Deliver various fake events to to terminal.	1641	Deliver various fake events to to terminal.
1555		1642
1556	=item $window_width = $term->width	1643	=item $window_width = $term->width ([$new_value])
1557		1644
1558	=item $window_height = $term->height	1645	=item $window_height = $term->height ([$new_value])
1559		1646
1560	=item $font_width = $term->fwidth	1647	=item $font_width = $term->fwidth ([$new_value])
1561		1648
1562	=item $font_height = $term->fheight	1649	=item $font_height = $term->fheight ([$new_value])
1563		1650
1564	=item $font_ascent = $term->fbase	1651	=item $font_ascent = $term->fbase ([$new_value])
1565		1652
1566	=item $terminal_rows = $term->nrow	1653	=item $terminal_rows = $term->nrow ([$new_value])
1567		1654
1568	=item $terminal_columns = $term->ncol	1655	=item $terminal_columns = $term->ncol ([$new_value])
1569		1656
1570	=item $has_focus = $term->focus	1657	=item $has_focus = $term->focus ([$new_value])
1571		1658
1572	=item $is_mapped = $term->mapped	1659	=item $is_mapped = $term->mapped ([$new_value])
1573		1660
1574	=item $max_scrollback = $term->saveLines	1661	=item $max_scrollback = $term->saveLines ([$new_value])
1575		1662
1576	=item $nrow_plus_saveLines = $term->total_rows	1663	=item $nrow_plus_saveLines = $term->total_rows ([$new_value])
1577		1664
1578	=item $topmost_scrollback_row = $term->top_row	1665	=item $topmost_scrollback_row = $term->top_row ([$new_value])
1579		1666
1580	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.
1581		1669
1582	=item $x_display = $term->display_id	1670	=item $x_display = $term->display_id
1583		1671
1584	Return the DISPLAY used by rxvt-unicode.	1672	Return the DISPLAY used by rxvt-unicode.
1585		1673
…		…
1622		1710
1623	=item $cursor_is_hidden = $term->hidden_cursor	1711	=item $cursor_is_hidden = $term->hidden_cursor
1624		1712
1625	Returns whether the cursor is currently hidden or not.	1713	Returns whether the cursor is currently hidden or not.
1626		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
1627	=item $view_start = $term->view_start ([$newvalue])	1725	=item $view_start = $term->view_start ([$newvalue])
1628		1726
1629	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,
1630	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
1631	this many lines into the scrollback buffer.	1729	the terminal contents. Lower values scroll this many lines into the
		1730	scrollback buffer.
1632		1731
1633	=item $term->want_refresh	1732	=item $term->want_refresh
1634		1733
1635	Requests a screen refresh. At the next opportunity, rxvt-unicode will	1734	Requests a screen refresh. At the next opportunity, rxvt-unicode will
1636	compare the on-screen display with its stored representation. If they	1735	compare the on-screen display with its stored representation. If they
1637	differ, it redraws the differences.	1736	differ, it redraws the differences.
1638		1737
1639	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.
1640		1743
1641	=item $text = $term->ROW_t ($row_number[, $new_text[, $start_col]])	1744	=item $text = $term->ROW_t ($row_number[, $new_text[, $start_col]])
1642		1745
1643	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 >>
1644	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
…		…
1690		1793
1691	Create and return a new C<urxvt::line> object that stores information	1794	Create and return a new C<urxvt::line> object that stores information
1692	about the logical line that row C<$row_number> is part of. It supports the	1795	about the logical line that row C<$row_number> is part of. It supports the
1693	following methods:	1796	following methods:
1694		1797
1695	=over 4	1798	=over
1696		1799
1697	=item $text = $line->t ([$new_text])	1800	=item $text = $line->t ([$new_text])
1698		1801
1699	Returns or replaces the full text of the line, similar to C<ROW_t>	1802	Returns or replaces the full text of the line, similar to C<ROW_t>
1700		1803
…		…
1880		1983
1881	package urxvt::popup;	1984	package urxvt::popup;
1882		1985
1883	=head2 The C<urxvt::popup> Class	1986	=head2 The C<urxvt::popup> Class
1884		1987
1885	=over 4	1988	=over
1886		1989
1887	=cut	1990	=cut
1888		1991
1889	sub add_item {	1992	sub add_item {
1890	my ($self, $item) = @_;	1993	my ($self, $item) = @_;
…		…
2026	->cb (sub {	2129	->cb (sub {
2027	$term->{overlay}->set (0, 0,	2130	$term->{overlay}->set (0, 0,
2028	sprintf "%2d:%02d:%02d", (localtime urxvt::NOW)[2,1,0]);	2131	sprintf "%2d:%02d:%02d", (localtime urxvt::NOW)[2,1,0]);
2029	});	2132	});
2030		2133
2031	=over 4	2134	=over
2032		2135
2033	=item $timer = new urxvt::timer	2136	=item $timer = new urxvt::timer
2034		2137
2035	Create a new timer object in started state. It is scheduled to fire	2138	Create a new timer object in started state. It is scheduled to fire
2036	immediately.	2139	immediately.
…		…
2085	sysread $term->{socket}, my $buf, 8192	2188	sysread $term->{socket}, my $buf, 8192
2086	or end-of-file;	2189	or end-of-file;
2087	});	2190	});
2088		2191
2089		2192
2090	=over 4	2193	=over
2091		2194
2092	=item $iow = new urxvt::iow	2195	=item $iow = new urxvt::iow
2093		2196
2094	Create a new io watcher object in stopped state.	2197	Create a new io watcher object in stopped state.
2095		2198
…		…
2122		2225
2123	This class implements idle watchers, that get called automatically when	2226	This class implements idle watchers, that get called automatically when
2124	the process is idle. They should return as fast as possible, after doing	2227	the process is idle. They should return as fast as possible, after doing
2125	some useful work.	2228	some useful work.
2126		2229
2127	=over 4	2230	=over
2128		2231
2129	=item $iw = new urxvt::iw	2232	=item $iw = new urxvt::iw
2130		2233
2131	Create a new idle watcher object in stopped state.	2234	Create a new idle watcher object in stopped state.
2132		2235
…		…
2157	->cb (sub {	2260	->cb (sub {
2158	my ($pw, $exit_status) = @_;	2261	my ($pw, $exit_status) = @_;
2159	...	2262	...
2160	});	2263	});
2161		2264
2162	=over 4	2265	=over
2163		2266
2164	=item $pw = new urxvt::pw	2267	=item $pw = new urxvt::pw
2165		2268
2166	Create a new process watcher in stopped state.	2269	Create a new process watcher in stopped state.
2167		2270
…		…
2184	=head2 URXVT_PERL_VERBOSITY	2287	=head2 URXVT_PERL_VERBOSITY
2185		2288
2186	This variable controls the verbosity level of the perl extension. Higher	2289	This variable controls the verbosity level of the perl extension. Higher
2187	numbers indicate more verbose output.	2290	numbers indicate more verbose output.
2188		2291
2189	=over 4	2292	=over
2190		2293
2191	=item == 0 - fatal messages	2294	=item == 0 - fatal messages
2192		2295
2193	=item >= 3 - script loading and management	2296	=item >= 3 - script loading and management
2194		2297

Diff Legend

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

Comparing rxvt-unicode/src/urxvt.pm (file contents): Revision 1.239 by sf-exg, Wed May 28 15:51:29 2014 UTC vs. Revision 1.265 by root, Sat Jul 24 09:48:43 2021 UTC

Diff Legend

Comparing rxvt-unicode/src/urxvt.pm (file contents):
Revision 1.239 by sf-exg, Wed May 28 15:51:29 2014 UTC vs.
Revision 1.265 by root, Sat Jul 24 09:48:43 2021 UTC