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

Comparing rxvt-unicode/src/urxvt.pm (file contents):
Revision 1.243 by sf-exg, Sat Oct 11 22:02:50 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 may add resources on their own. Similarly to builtin	48	Extensions may add additional resources and C<actions>, i.e., methods
49	resources, these resources can also be specified on the command line	49	which can be bound to a key and invoked by the user. An extension can
50	as long options (with '.' replaced by '-'), in which case the	50	define the resources it support using so called META comments,
51	corresponding extension is loaded automatically.	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.
52		56
53	=head1 API DOCUMENTATION	57	=head1 API DOCUMENTATION
54		58
55	=head2 General API Considerations	59	=head2 General API Considerations
56		60
…		…
66	terminal is destroyed.	70	terminal is destroyed.
67		71
68	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
69	hints on what they mean:	73	hints on what they mean:
70		74
71	=over 4	75	=over
72		76
73	=item $text	77	=item $text
74		78
75	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
76	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.
…		…
108	C<urxvt::term> class on this object.	112	C<urxvt::term> class on this object.
109		113
110	Additional methods only supported for extension objects are described in	114	Additional methods only supported for extension objects are described in
111	the C<urxvt::extension> section below.	115	the C<urxvt::extension> section below.
112		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
113	=head2 Hooks	139	=head2 Hooks
114		140
115	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
116	called whenever the relevant event happens.	142	called whenever the relevant event happens.
117		143
…		…
122	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
123	relevant action might not be carried out by the C++ code.	149	relevant action might not be carried out by the C++ code.
124		150
125	I<< When in doubt, return a false value (preferably C<()>). >>	151	I<< When in doubt, return a false value (preferably C<()>). >>
126		152
127	=over 4	153	=over
128		154
129	=item on_init $term	155	=item on_init $term
130		156
131	Called after a new terminal object has been initialized, but before	157	Called after a new terminal object has been initialized, but before
132	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
…		…
282	code is run after this hook, and takes precedence.	308	code is run after this hook, and takes precedence.
283		309
284	=item on_refresh_end $term	310	=item on_refresh_end $term
285		311
286	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.
287		321
288	=item on_user_command $term, $string DEPRECATED	322	=item on_user_command $term, $string DEPRECATED
289		323
290	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
291	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>
…		…
388		422
389	our $NOCHAR = chr 0xffff;	423	our $NOCHAR = chr 0xffff;
390		424
391	=head2 Variables in the C<urxvt> Package	425	=head2 Variables in the C<urxvt> Package
392		426
393	=over 4	427	=over
394		428
395	=item $urxvt::LIBDIR	429	=item $urxvt::LIBDIR
396		430
397	The rxvt-unicode library directory, where, among other things, the perl	431	The rxvt-unicode library directory, where, among other things, the perl
398	modules and scripts are stored.	432	modules and scripts are stored.
…		…
428		462
429	=back	463	=back
430		464
431	=head2 Functions in the C<urxvt> Package	465	=head2 Functions in the C<urxvt> Package
432		466
433	=over 4	467	=over
434		468
435	=item urxvt::fatal $errormessage	469	=item urxvt::fatal $errormessage
436		470
437	Fatally aborts execution with the given error message (which should	471	Fatally aborts execution with the given error message (which should
438	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
…		…
483	CirculateRequest, PropertyNotify, SelectionClear, SelectionRequest,	517	CirculateRequest, PropertyNotify, SelectionClear, SelectionRequest,
484	SelectionNotify, ColormapNotify, ClientMessage, MappingNotify	518	SelectionNotify, ColormapNotify, ClientMessage, MappingNotify
485		519
486	Various constants for use in X calls and event processing.	520	Various constants for use in X calls and event processing.
487		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
488	=back	534	=back
489		535
490	=head2 RENDITION	536	=head2 RENDITION
491		537
492	Rendition bitsets contain information about colour, font, font styles and	538	Rendition bitsets contain information about colour, font, font styles and
…		…
495	The following "macros" deal with changes in rendition sets. You should	541	The following "macros" deal with changes in rendition sets. You should
496	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,
497	as they contain important information required for correct operation of	543	as they contain important information required for correct operation of
498	rxvt-unicode.	544	rxvt-unicode.
499		545
500	=over 4	546	=over
501		547
502	=item $rend = urxvt::DEFAULT_RSTYLE	548	=item $rend = urxvt::DEFAULT_RSTYLE
503		549
504	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
505	being reset. Useful as a base to start when creating renditions.	551	being reset. Useful as a base to start when creating renditions.
…		…
559	sub parse_resource {	605	sub parse_resource {
560	my ($term, $name, $isarg, $longopt, $flag, $value) = @_;	606	my ($term, $name, $isarg, $longopt, $flag, $value) = @_;
561		607
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 ($k, $v) = each %$r) {	614	while (my ($k, $v) = each %$r) {
567	my $pattern = $k;	615	my $pattern = $k;
568	$pattern =~ y/./-/ if $isarg;	616	$pattern =~ y/./-/ if $isarg;
…		…
575	if ($pattern eq $prefix) {	623	if ($pattern eq $prefix) {
576	$name = "$urxvt::RESCLASS.$k$suffix";	624	$name = "$urxvt::RESCLASS.$k$suffix";
577		625
578	push @{ $term->{perl_ext_3} }, $v->[0];	626	push @{ $term->{perl_ext_3} }, $v->[0];
579		627
		628	return 1 unless $isarg;
		629
580	if ($v->[1] eq "boolean") {	630	if ($v->[1] eq "boolean") {
581	$term->put_option_db ($name, $flag ? "true" : "false");	631	$term->put_option_db ($name, $flag ? "true" : "false");
582	return 1;	632	return 1;
583	} else {	633	} else {
584	$term->put_option_db ($name, $value);	634	$term->put_option_db ($name, $value);
…		…
679	@TERM_EXT = ();	729	@TERM_EXT = ();
680	$TERM->register_package ($_) for @pkg;	730	$TERM->register_package ($_) for @pkg;
681	}	731	}
682		732
683	for (	733	for (
		734	@{ delete $TERM->{perl_ext_3} },
684	(grep $_, map { split /,/, $TERM->resource ("perl_ext_$_") } 1, 2),	735	(grep $_, map { split /,/, $TERM->resource ("perl_ext_$_") } 1, 2),
685	@{ delete $TERM->{perl_ext_3} }
686	) {	736	) {
687	if ($_ eq "default") {	737	if ($_ eq "default") {
688		738
689	$ext_arg{$_} = []	739	$ext_arg{$_} = []
690	for
691	qw(selection option-popup selection-popup readline),	740	for qw(selection option-popup selection-popup readline searchable-scrollback confirm-paste);
692	map $_->[0], values %{ $TERM->{meta}{binding} };
693		741
694	for ($TERM->_keysym_resources) {	742	for ($TERM->_keysym_resources) {
695	next if /^(?:string\|command\|builtin\|builtin-string\|perl)/;	743	next if /^(?:string\|command\|builtin\|builtin-string\|perl)/;
696	next unless /^([A-Za-z0-9_\-]+):/;	744	next unless /^([A-Za-z0-9_\-]+):/;
697		745
…		…
706	} elsif (/^([^<]+)<(.*)>$/) {	754	} elsif (/^([^<]+)<(.*)>$/) {
707	push @{ $ext_arg{$1} }, $2;	755	push @{ $ext_arg{$1} }, $2;
708		756
709	} else {	757	} else {
710	$ext_arg{$_} \|\|= [];	758	$ext_arg{$_} \|\|= [];
711	}
712	}
713
714	# now register default key bindings
715	for my $ext (sort keys %ext_arg) {
716	while (my ($k, $v) = each %{ $TERM->{meta}{ext}{$ext}{binding} }) {
717	$TERM->bind_action ($k, "$v->[0]:$v->[1]");
718	}	759	}
719	}	760	}
720		761
721	for my $ext (sort keys %ext_arg) {	762	for my $ext (sort keys %ext_arg) {
722	my @files = grep -f $_, map "$_/$ext", @dirs;	763	my @files = grep -f $_, map "$_/$ext", @dirs;
…		…
817		858
818	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
819	objects, in addition to call methods documented for the <urxvt::term>	860	objects, in addition to call methods documented for the <urxvt::term>
820	class.	861	class.
821		862
822	=over 4	863	=over
823		864
824	=item $urxvt_term = $self->{term}	865	=item $urxvt_term = $self->{term}
825		866
826	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
827	extension. This member I<must not> be changed in any way.	868	extension. This member I<must not> be changed in any way.
…		…
945	}	986	}
946		987
947	bless \%disable, "urxvt::extension::on_disable"	988	bless \%disable, "urxvt::extension::on_disable"
948	}	989	}
949		990
		991	=item $self->bind_action ($hotkey, $action)
		992
950	=item $self->x_resource ($pattern)	993	=item $self->x_resource ($pattern)
951		994
952	=item $self->x_resource_boolean ($pattern)	995	=item $self->x_resource_boolean ($pattern)
953		996
954	These methods support an additional C<%> prefix when called on an	997	These methods support an additional C<%> prefix for C<$action> or
955	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
956	C<urxvt::term> class for details.	1000	methods in the C<urxvt::term> class for details.
957		1001
958	=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	}
959		1009
960	sub x_resource {	1010	sub x_resource {
961	my ($self, $name) = @_;	1011	my ($self, $name) = @_;
962	$name =~ s/^%(\.\|$)/$_[0]{_name}$1/;	1012	$name =~ s/^%(\.\|$)/$_[0]{_name}$1/;
963	$self->{term}->x_resource ($name)	1013	$self->{term}->x_resource ($name)
…		…
1059		1109
1060	package urxvt::term;	1110	package urxvt::term;
1061		1111
1062	=head2 The C<urxvt::term> Class	1112	=head2 The C<urxvt::term> Class
1063		1113
1064	=over 4	1114	=over
1065		1115
1066	=cut	1116	=cut
1067		1117
1068	# find on_xxx subs in the package and register them	1118	# find on_xxx subs in the package and register them
1069	# as hooks	1119	# as hooks
…		…
1104	sub scan_extensions {	1154	sub scan_extensions {
1105	my ($self) = @_;	1155	my ($self) = @_;
1106		1156
1107	return if exists $self->{meta};	1157	return if exists $self->{meta};
1108		1158
1109	my @libdirs = perl_libdirs $self;	1159	my @urxvtdirs = perl_libdirs $self;
		1160	# my @cpandirs = grep -d, map "$_/URxvt/Ext", @INC;
1110		1161
1111	# return if $self->{meta_libdirs} eq join "\x00", @libdirs;#d#
1112
1113	# $self->{meta_libdirs} = join "\x00", @libdirs;#d#
1114	$self->{meta} = \my %meta;	1162	$self->{meta} = \my %meta;
1115		1163
1116	# first gather extensions	1164	# first gather extensions
1117	for my $dir (reverse @libdirs) {	1165
		1166	my $gather = sub {
		1167	my ($dir, $core) = @_;
		1168
1118	opendir my $fh, $dir	1169	opendir my $fh, $dir
1119	or next;	1170	or return;
		1171
1120	for my $ext (readdir $fh) {	1172	for my $ext (readdir $fh) {
1121	$ext !~ /^\./	1173	$ext !~ /^\./
		1174	or next;
		1175
1122	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
1123	or next;	1183	or next;
1124		1184
1125	my %ext = (dir => $dir);	1185	my %ext = (dir => $dir);
1126		1186
1127	while (<$fh>) {	1187	while (<$fh>) {
…		…
1131	if ($pattern =~ /[^a-zA-Z0-9\-\.]/) {	1191	if ($pattern =~ /[^a-zA-Z0-9\-\.]/) {
1132	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";
1133	} else {	1193	} else {
1134	$ext{resource}{$pattern} = [$ext, $type, $desc];	1194	$ext{resource}{$pattern} = [$ext, $type, $desc];
1135	}	1195	}
1136	} elsif (/^#:META:BINDING:(.*)/) {
1137	my ($keysym, $action) = split /:/, $1;
1138	$ext{binding}{$keysym} = [$ext, $action];
1139	} elsif (/^\s*(?:#\|$)/) {	1196	} elsif (/^\s*(?:#\|$)/) {
1140	# skip other comments and empty lines	1197	# skip other comments and empty lines
1141	} else {	1198	} else {
1142	last; # stop parsing on first non-empty non-comment line	1199	last; # stop parsing on first non-empty non-comment line
1143	}	1200	}
1144	}	1201	}
1145		1202
1146	$meta{ext}{$ext} = \%ext;	1203	$meta{ext}{$ext} = \%ext;
1147	}	1204	}
1148	}	1205	};
1149		1206
		1207	# $gather->($_, 0) for @cpandirs;
		1208	$gather->($_, 1) for @urxvtdirs;
		1209
1150	# and now merge resources and bindings	1210	# and now merge resources
		1211
		1212	$meta{resource} = \my %resource;
		1213
1151	while (my ($k, $v) = each %{ $meta{ext} }) {	1214	while (my ($k, $v) = each %{ $meta{ext} }) {
1152	#TODO: should check for extensions overriding each other	1215	#TODO: should check for extensions overriding each other
1153	%{ $meta{resource} } = (%{ $meta{resource} }, %{ $v->{resource} });	1216	%resource = (%resource, %{ $v->{resource} });
1154	%{ $meta{binding} } = (%{ $meta{binding} }, %{ $v->{binding} });
1155	}	1217	}
1156	}	1218	}
1157		1219
1158	=item $term = new urxvt::term $envhashref, $rxvtname, [arg...]	1220	=item $term = new urxvt::term $envhashref, $rxvtname, [arg...]
1159		1221
…		…
1222	insecure intensityStyles iso14755 iso14755_52 jumpScroll loginShell	1284	insecure intensityStyles iso14755 iso14755_52 jumpScroll loginShell
1223	mapAlert meta8 mouseWheelScrollPage override_redirect pastableTabs	1285	mapAlert meta8 mouseWheelScrollPage override_redirect pastableTabs
1224	pointerBlank reverseVideo scrollBar scrollBar_floating scrollBar_right	1286	pointerBlank reverseVideo scrollBar scrollBar_floating scrollBar_right
1225	scrollTtyKeypress scrollTtyOutput scrollWithBuffer secondaryScreen	1287	scrollTtyKeypress scrollTtyOutput scrollWithBuffer secondaryScreen
1226	secondaryScroll skipBuiltinGlyphs skipScroll transparent tripleclickwords	1288	secondaryScroll skipBuiltinGlyphs skipScroll transparent tripleclickwords
1227	urgentOnBell utmpInhibit visualBell	1289	urgentOnBell utmpInhibit visualBell disablePasteBrackets
1228		1290
1229	=item $value = $term->resource ($name[, $newval])	1291	=item $value = $term->resource ($name[, $newval])
1230		1292
1231	Returns the current resource value associated with a given name and	1293	Returns the current resource value associated with a given name and
1232	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>
…		…
1258	preeditType print_pipe pty_fd reverseVideo saveLines scrollBar	1320	preeditType print_pipe pty_fd reverseVideo saveLines scrollBar
1259	scrollBar_align scrollBar_floating scrollBar_right scrollBar_thickness	1321	scrollBar_align scrollBar_floating scrollBar_right scrollBar_thickness
1260	scrollTtyKeypress scrollTtyOutput scrollWithBuffer scrollstyle	1322	scrollTtyKeypress scrollTtyOutput scrollWithBuffer scrollstyle
1261	secondaryScreen secondaryScroll shade skipBuiltinGlyphs skipScroll	1323	secondaryScreen secondaryScroll shade skipBuiltinGlyphs skipScroll
1262	term_name title transient_for transparent tripleclickwords urgentOnBell	1324	term_name title transient_for transparent tripleclickwords urgentOnBell
1263	utmpInhibit visualBell	1325	utmpInhibit visualBell rewrapMode disablePasteBrackets
1264		1326
1265	=cut	1327	=cut
1266		1328
1267	sub resource($$;$) {	1329	sub resource($$;$) {
1268	my ($self, $name) = (shift, shift);	1330	my ($self, $name) = (shift, shift);
…		…
1282		1344
1283	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
1284	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
1285	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
1286	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
1287	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
1288	without having to change the actual code.	1350	the actual code.
1289		1351
1290	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
1291	only one resource database per display, and later invocations might return	1353	only one resource database per display, and later invocations might return
1292	the wrong resources.	1354	the wrong resources.
1293		1355
…		…
1305	my $res = &x_resource;	1367	my $res = &x_resource;
1306		1368
1307	$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
1308	}	1370	}
1309		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
1310	=item $success = $term->bind_action ($key, $octets)	1377	=item $success = $term->bind_action ($key, $action)
1311		1378
1312	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
1313	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	}
1314		1396
1315	=item $rend = $term->rstyle ([$new_rstyle])	1397	=item $rend = $term->rstyle ([$new_rstyle])
1316		1398
1317	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
1318	the terminal application will use this style.	1400	the terminal application will use this style.
…		…
1395	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
1396	as long as the perl object is referenced.	1478	as long as the perl object is referenced.
1397		1479
1398	The methods currently supported on C<urxvt::overlay> objects are:	1480	The methods currently supported on C<urxvt::overlay> objects are:
1399		1481
1400	=over 4	1482	=over
1401		1483
1402	=item $overlay->set ($x, $y, $text[, $rend])	1484	=item $overlay->set ($x, $y, $text[, $rend])
1403		1485
1404	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
1405	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
…		…
1476		1558
1477	=item $term->scr_add_lines ($string)	1559	=item $term->scr_add_lines ($string)
1478		1560
1479	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
1480	running inside the terminal. It may not contain command sequences (escape	1562	running inside the terminal. It may not contain command sequences (escape
1481	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,
1482	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.
1483		1566
1484	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
1485	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
1486	C<on_add_lines> hook, though.	1569	C<on_add_lines> hook, though.
1487		1570
…		…
1495	locale-specific encoding of the terminal and can contain command sequences	1578	locale-specific encoding of the terminal and can contain command sequences
1496	(escape codes) that will be interpreted.	1579	(escape codes) that will be interpreted.
1497		1580
1498	=item $term->tt_write ($octets)	1581	=item $term->tt_write ($octets)
1499		1582
1500	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
1501	pass characters instead of octets, you should convert your strings first	1585	characters instead of octets, you should convert your strings first to the
1502	to the locale-specific encoding using C<< $term->locale_encode >>.	1586	locale-specific encoding using C<< $term->locale_encode >>.
1503		1587
1504	=item $term->tt_write_user_input ($octets)	1588	=item $term->tt_write_user_input ($octets)
1505		1589
1506	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
1507	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
…		…
1554		1638
1555	=item $term->key_release ($state, $keycode[, $time])	1639	=item $term->key_release ($state, $keycode[, $time])
1556		1640
1557	Deliver various fake events to to terminal.	1641	Deliver various fake events to to terminal.
1558		1642
1559	=item $window_width = $term->width	1643	=item $window_width = $term->width ([$new_value])
1560		1644
1561	=item $window_height = $term->height	1645	=item $window_height = $term->height ([$new_value])
1562		1646
1563	=item $font_width = $term->fwidth	1647	=item $font_width = $term->fwidth ([$new_value])
1564		1648
1565	=item $font_height = $term->fheight	1649	=item $font_height = $term->fheight ([$new_value])
1566		1650
1567	=item $font_ascent = $term->fbase	1651	=item $font_ascent = $term->fbase ([$new_value])
1568		1652
1569	=item $terminal_rows = $term->nrow	1653	=item $terminal_rows = $term->nrow ([$new_value])
1570		1654
1571	=item $terminal_columns = $term->ncol	1655	=item $terminal_columns = $term->ncol ([$new_value])
1572		1656
1573	=item $has_focus = $term->focus	1657	=item $has_focus = $term->focus ([$new_value])
1574		1658
1575	=item $is_mapped = $term->mapped	1659	=item $is_mapped = $term->mapped ([$new_value])
1576		1660
1577	=item $max_scrollback = $term->saveLines	1661	=item $max_scrollback = $term->saveLines ([$new_value])
1578		1662
1579	=item $nrow_plus_saveLines = $term->total_rows	1663	=item $nrow_plus_saveLines = $term->total_rows ([$new_value])
1580		1664
1581	=item $topmost_scrollback_row = $term->top_row	1665	=item $topmost_scrollback_row = $term->top_row ([$new_value])
1582		1666
1583	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.
1584		1669
1585	=item $x_display = $term->display_id	1670	=item $x_display = $term->display_id
1586		1671
1587	Return the DISPLAY used by rxvt-unicode.	1672	Return the DISPLAY used by rxvt-unicode.
1588		1673
…		…
1625		1710
1626	=item $cursor_is_hidden = $term->hidden_cursor	1711	=item $cursor_is_hidden = $term->hidden_cursor
1627		1712
1628	Returns whether the cursor is currently hidden or not.	1713	Returns whether the cursor is currently hidden or not.
1629		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
1630	=item $view_start = $term->view_start ([$newvalue])	1725	=item $view_start = $term->view_start ([$newvalue])
1631		1726
1632	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,
1633	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
1634	this many lines into the scrollback buffer.	1729	the terminal contents. Lower values scroll this many lines into the
		1730	scrollback buffer.
1635		1731
1636	=item $term->want_refresh	1732	=item $term->want_refresh
1637		1733
1638	Requests a screen refresh. At the next opportunity, rxvt-unicode will	1734	Requests a screen refresh. At the next opportunity, rxvt-unicode will
1639	compare the on-screen display with its stored representation. If they	1735	compare the on-screen display with its stored representation. If they
1640	differ, it redraws the differences.	1736	differ, it redraws the differences.
1641		1737
1642	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.
1643		1743
1644	=item $text = $term->ROW_t ($row_number[, $new_text[, $start_col]])	1744	=item $text = $term->ROW_t ($row_number[, $new_text[, $start_col]])
1645		1745
1646	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 >>
1647	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
…		…
1693		1793
1694	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
1695	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
1696	following methods:	1796	following methods:
1697		1797
1698	=over 4	1798	=over
1699		1799
1700	=item $text = $line->t ([$new_text])	1800	=item $text = $line->t ([$new_text])
1701		1801
1702	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>
1703		1803
…		…
1883		1983
1884	package urxvt::popup;	1984	package urxvt::popup;
1885		1985
1886	=head2 The C<urxvt::popup> Class	1986	=head2 The C<urxvt::popup> Class
1887		1987
1888	=over 4	1988	=over
1889		1989
1890	=cut	1990	=cut
1891		1991
1892	sub add_item {	1992	sub add_item {
1893	my ($self, $item) = @_;	1993	my ($self, $item) = @_;
…		…
2029	->cb (sub {	2129	->cb (sub {
2030	$term->{overlay}->set (0, 0,	2130	$term->{overlay}->set (0, 0,
2031	sprintf "%2d:%02d:%02d", (localtime urxvt::NOW)[2,1,0]);	2131	sprintf "%2d:%02d:%02d", (localtime urxvt::NOW)[2,1,0]);
2032	});	2132	});
2033		2133
2034	=over 4	2134	=over
2035		2135
2036	=item $timer = new urxvt::timer	2136	=item $timer = new urxvt::timer
2037		2137
2038	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
2039	immediately.	2139	immediately.
…		…
2088	sysread $term->{socket}, my $buf, 8192	2188	sysread $term->{socket}, my $buf, 8192
2089	or end-of-file;	2189	or end-of-file;
2090	});	2190	});
2091		2191
2092		2192
2093	=over 4	2193	=over
2094		2194
2095	=item $iow = new urxvt::iow	2195	=item $iow = new urxvt::iow
2096		2196
2097	Create a new io watcher object in stopped state.	2197	Create a new io watcher object in stopped state.
2098		2198
…		…
2125		2225
2126	This class implements idle watchers, that get called automatically when	2226	This class implements idle watchers, that get called automatically when
2127	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
2128	some useful work.	2228	some useful work.
2129		2229
2130	=over 4	2230	=over
2131		2231
2132	=item $iw = new urxvt::iw	2232	=item $iw = new urxvt::iw
2133		2233
2134	Create a new idle watcher object in stopped state.	2234	Create a new idle watcher object in stopped state.
2135		2235
…		…
2160	->cb (sub {	2260	->cb (sub {
2161	my ($pw, $exit_status) = @_;	2261	my ($pw, $exit_status) = @_;
2162	...	2262	...
2163	});	2263	});
2164		2264
2165	=over 4	2265	=over
2166		2266
2167	=item $pw = new urxvt::pw	2267	=item $pw = new urxvt::pw
2168		2268
2169	Create a new process watcher in stopped state.	2269	Create a new process watcher in stopped state.
2170		2270
…		…
2187	=head2 URXVT_PERL_VERBOSITY	2287	=head2 URXVT_PERL_VERBOSITY
2188		2288
2189	This variable controls the verbosity level of the perl extension. Higher	2289	This variable controls the verbosity level of the perl extension. Higher
2190	numbers indicate more verbose output.	2290	numbers indicate more verbose output.
2191		2291
2192	=over 4	2292	=over
2193		2293
2194	=item == 0 - fatal messages	2294	=item == 0 - fatal messages
2195		2295
2196	=item >= 3 - script loading and management	2296	=item >= 3 - script loading and management
2197		2297

Diff Legend

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

Comparing rxvt-unicode/src/urxvt.pm (file contents): Revision 1.243 by sf-exg, Sat Oct 11 22:02:50 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.243 by sf-exg, Sat Oct 11 22:02:50 2014 UTC vs.
Revision 1.265 by root, Sat Jul 24 09:48:43 2021 UTC