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

Comparing rxvt-unicode/src/urxvt.pm (file contents):
Revision 1.246 by root, Fri Dec 26 18:58:19 2014 UTC vs.
Revision 1.259 by sf-exg, Sat May 8 06:16:21 2021 UTC

…		…
45		45
46	URxvt.perl-ext-common: default,selection-autotransform	46	URxvt.perl-ext-common: default,selection-autotransform
47		47
48	Extensions may add additional resources and C<actions>, i.e., methods	48	Extensions may add additional resources and C<actions>, i.e., methods
49	which can be bound to a key and invoked by the user. An extension can	49	which can be bound to a key and invoked by the user. An extension can
50	define the resources it support and also default bindings for one or	50	define the resources it support using so called META comments,
51	more actions it provides using so called META comments, described
52	below. Similarly to builtin resources, extension resources can also be	51	described below. Similarly to builtin resources, extension resources
53	specified on the command line as long options (with C<.> replaced by	52	can also be specified on the command line as long options (with C<.>
54	C<->), in which case the corresponding extension is loaded	53	replaced by C<->), in which case the corresponding extension is loaded
55	automatically. For this to work the extension B<must> define META	54	automatically. For this to work the extension B<must> define META
56	comments for its resources.	55	comments for its resources.
57		56
58	=head1 API DOCUMENTATION	57	=head1 API DOCUMENTATION
59		58
…		…
115	Additional methods only supported for extension objects are described in	114	Additional methods only supported for extension objects are described in
116	the C<urxvt::extension> section below.	115	the C<urxvt::extension> section below.
117		116
118	=head2 META comments	117	=head2 META comments
119		118
120	rxvt-unicode recognizes special comments in extensions that define	119	Rxvt-unicode recognizes special meta comments in extensions that define
121	different types of metadata:	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:
122		125
123	=over 4	126	=over 4
124		127
125	=item #:META:RESOURCE:name:type:desc	128	=item #:META:RESOURCE:name:type:desc
126		129
127	The RESOURCE comment defines a resource used by the extension, where	130	The RESOURCE comment defines a resource used by the extension, where
128	C<name> is the resource name, C<type> is the resource type, C<boolean>	131	C<name> is the resource name, C<type> is the resource type, C<boolean>
129	or C<string>, and C<desc> is the resource description.	132	or C<string>, and C<desc> is the resource description.
130		133
131	=item #:META:BINDING:sym:action	134	The extension will be autoloaded when this resource is specified or used
132		135	as a command line parameter.
133	The BINDING comment defines a default binding for an action provided
134	by the extension, where C<sym> is the key combination that triggers
135	the action, whose format is defined in the description of the
136	B<keysym> resource in the urxvt(1) manpage, and C<action> is the name
137	of the action method.
138		136
139	=back	137	=back
140		138
141	=head2 Hooks	139	=head2 Hooks
142		140
…		…
518	ConfigureRequest, GravityNotify, ResizeRequest, CirculateNotify,	516	ConfigureRequest, GravityNotify, ResizeRequest, CirculateNotify,
519	CirculateRequest, PropertyNotify, SelectionClear, SelectionRequest,	517	CirculateRequest, PropertyNotify, SelectionClear, SelectionRequest,
520	SelectionNotify, ColormapNotify, ClientMessage, MappingNotify	518	SelectionNotify, ColormapNotify, ClientMessage, MappingNotify
521		519
522	Various constants for use in X calls and event processing.	520	Various constants for use in X calls and event processing.
		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.
523		533
524	=back	534	=back
525		535
526	=head2 RENDITION	536	=head2 RENDITION
527		537
…		…
595	sub parse_resource {	605	sub parse_resource {
596	my ($term, $name, $isarg, $longopt, $flag, $value) = @_;	606	my ($term, $name, $isarg, $longopt, $flag, $value) = @_;
597		607
598	$term->scan_extensions;	608	$term->scan_extensions;
599		609
		610	# iterating over all resources has quadratic time overhead
		611	# overall, maybe this could be optimised?
600	my $r = $term->{meta}{resource};	612	my $r = $term->{meta}{resource};
601	keys %$r; # reset iterator	613	keys %$r; # reset iterator
602	while (my ($k, $v) = each %$r) {	614	while (my ($k, $v) = each %$r) {
603	my $pattern = $k;	615	my $pattern = $k;
604	$pattern =~ y/./-/ if $isarg;	616	$pattern =~ y/./-/ if $isarg;
…		…
611	if ($pattern eq $prefix) {	623	if ($pattern eq $prefix) {
612	$name = "$urxvt::RESCLASS.$k$suffix";	624	$name = "$urxvt::RESCLASS.$k$suffix";
613		625
614	push @{ $term->{perl_ext_3} }, $v->[0];	626	push @{ $term->{perl_ext_3} }, $v->[0];
615		627
		628	return 1 unless $isarg;
		629
616	if ($v->[1] eq "boolean") {	630	if ($v->[1] eq "boolean") {
617	$term->put_option_db ($name, $flag ? "true" : "false");	631	$term->put_option_db ($name, $flag ? "true" : "false");
618	return 1;	632	return 1;
619	} else {	633	} else {
620	$term->put_option_db ($name, $value);	634	$term->put_option_db ($name, $value);
…		…
721	@{ delete $TERM->{perl_ext_3} }	735	@{ delete $TERM->{perl_ext_3} }
722	) {	736	) {
723	if ($_ eq "default") {	737	if ($_ eq "default") {
724		738
725	$ext_arg{$_} = []	739	$ext_arg{$_} = []
726	for
727	qw(selection option-popup selection-popup readline searchable-scrollback),	740	for qw(selection option-popup selection-popup readline searchable-scrollback);
728	map $_->[0], values %{ $TERM->{meta}{binding} };
729		741
730	for ($TERM->_keysym_resources) {	742	for ($TERM->_keysym_resources) {
731	next if /^(?:string\|command\|builtin\|builtin-string\|perl)/;	743	next if /^(?:string\|command\|builtin\|builtin-string\|perl)/;
732	next unless /^([A-Za-z0-9_\-]+):/;	744	next unless /^([A-Za-z0-9_\-]+):/;
733		745
…		…
742	} elsif (/^([^<]+)<(.*)>$/) {	754	} elsif (/^([^<]+)<(.*)>$/) {
743	push @{ $ext_arg{$1} }, $2;	755	push @{ $ext_arg{$1} }, $2;
744		756
745	} else {	757	} else {
746	$ext_arg{$_} \|\|= [];	758	$ext_arg{$_} \|\|= [];
747	}
748	}
749
750	# now register default key bindings
751	for my $ext (sort keys %ext_arg) {
752	while (my ($k, $v) = each %{ $TERM->{meta}{ext}{$ext}{binding} }) {
753	$TERM->bind_action ($k, "$v->[0]:$v->[1]");
754	}	759	}
755	}	760	}
756		761
757	for my $ext (sort keys %ext_arg) {	762	for my $ext (sort keys %ext_arg) {
758	my @files = grep -f $_, map "$_/$ext", @dirs;	763	my @files = grep -f $_, map "$_/$ext", @dirs;
…		…
981	}	986	}
982		987
983	bless \%disable, "urxvt::extension::on_disable"	988	bless \%disable, "urxvt::extension::on_disable"
984	}	989	}
985		990
		991	=item $self->bind_action ($hotkey, $action)
		992
986	=item $self->x_resource ($pattern)	993	=item $self->x_resource ($pattern)
987		994
988	=item $self->x_resource_boolean ($pattern)	995	=item $self->x_resource_boolean ($pattern)
989		996
990	These methods support an additional C<%> prefix when called on an	997	These methods support an additional C<%> prefix for C<$action> or
991	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
992	C<urxvt::term> class for details.	1000	methods in the C<urxvt::term> class for details.
993		1001
994	=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	}
995		1009
996	sub x_resource {	1010	sub x_resource {
997	my ($self, $name) = @_;	1011	my ($self, $name) = @_;
998	$name =~ s/^%(\.\|$)/$_[0]{_name}$1/;	1012	$name =~ s/^%(\.\|$)/$_[0]{_name}$1/;
999	$self->{term}->x_resource ($name)	1013	$self->{term}->x_resource ($name)
…		…
1140	sub scan_extensions {	1154	sub scan_extensions {
1141	my ($self) = @_;	1155	my ($self) = @_;
1142		1156
1143	return if exists $self->{meta};	1157	return if exists $self->{meta};
1144		1158
1145	my @libdirs = perl_libdirs $self;	1159	my @urxvtdirs = perl_libdirs $self;
		1160	# my @cpandirs = grep -d, map "$_/URxvt/Ext", @INC;
1146		1161
1147	# return if $self->{meta_libdirs} eq join "\x00", @libdirs;#d#
1148
1149	# $self->{meta_libdirs} = join "\x00", @libdirs;#d#
1150	$self->{meta} = \my %meta;	1162	$self->{meta} = \my %meta;
1151		1163
1152	# first gather extensions	1164	# first gather extensions
1153	for my $dir (reverse @libdirs) {	1165
		1166	my $gather = sub {
		1167	my ($dir, $core) = @_;
		1168
1154	opendir my $fh, $dir	1169	opendir my $fh, $dir
1155	or next;	1170	or return;
		1171
1156	for my $ext (readdir $fh) {	1172	for my $ext (readdir $fh) {
1157	$ext !~ /^\./	1173	$ext !~ /^\./
		1174	or next;
		1175
1158	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
1159	or next;	1183	or next;
1160		1184
1161	my %ext = (dir => $dir);	1185	my %ext = (dir => $dir);
1162		1186
1163	while (<$fh>) {	1187	while (<$fh>) {
…		…
1167	if ($pattern =~ /[^a-zA-Z0-9\-\.]/) {	1191	if ($pattern =~ /[^a-zA-Z0-9\-\.]/) {
1168	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";
1169	} else {	1193	} else {
1170	$ext{resource}{$pattern} = [$ext, $type, $desc];	1194	$ext{resource}{$pattern} = [$ext, $type, $desc];
1171	}	1195	}
1172	} elsif (/^#:META:BINDING:(.*)/) {
1173	my ($keysym, $action) = split /:/, $1;
1174	$ext{binding}{$keysym} = [$ext, $action];
1175	} elsif (/^\s*(?:#\|$)/) {	1196	} elsif (/^\s*(?:#\|$)/) {
1176	# skip other comments and empty lines	1197	# skip other comments and empty lines
1177	} else {	1198	} else {
1178	last; # stop parsing on first non-empty non-comment line	1199	last; # stop parsing on first non-empty non-comment line
1179	}	1200	}
1180	}	1201	}
1181		1202
1182	$meta{ext}{$ext} = \%ext;	1203	$meta{ext}{$ext} = \%ext;
1183	}	1204	}
1184	}	1205	};
1185		1206
		1207	# $gather->($_, 0) for @cpandirs;
		1208	$gather->($_, 1) for @urxvtdirs;
		1209
1186	# and now merge resources and bindings	1210	# and now merge resources
		1211
		1212	$meta{resource} = \my %resource;
		1213
1187	while (my ($k, $v) = each %{ $meta{ext} }) {	1214	while (my ($k, $v) = each %{ $meta{ext} }) {
1188	#TODO: should check for extensions overriding each other	1215	#TODO: should check for extensions overriding each other
1189	%{ $meta{resource} } = (%{ $meta{resource} }, %{ $v->{resource} });	1216	%resource = (%resource, %{ $v->{resource} });
1190	%{ $meta{binding} } = (%{ $meta{binding} }, %{ $v->{binding} });
1191	}	1217	}
1192	}	1218	}
1193		1219
1194	=item $term = new urxvt::term $envhashref, $rxvtname, [arg...]	1220	=item $term = new urxvt::term $envhashref, $rxvtname, [arg...]
1195		1221
…		…
1341	my $res = &x_resource;	1367	my $res = &x_resource;
1342		1368
1343	$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
1344	}	1370	}
1345		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
1346	=item $success = $term->bind_action ($key, $octets)	1377	=item $success = $term->bind_action ($key, $action)
1347		1378
1348	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
1349	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	}
1350		1396
1351	=item $rend = $term->rstyle ([$new_rstyle])	1397	=item $rend = $term->rstyle ([$new_rstyle])
1352		1398
1353	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
1354	the terminal application will use this style.	1400	the terminal application will use this style.
…		…
1592		1638
1593	=item $term->key_release ($state, $keycode[, $time])	1639	=item $term->key_release ($state, $keycode[, $time])
1594		1640
1595	Deliver various fake events to to terminal.	1641	Deliver various fake events to to terminal.
1596		1642
1597	=item $window_width = $term->width	1643	=item $window_width = $term->width ([$new_value])
1598		1644
1599	=item $window_height = $term->height	1645	=item $window_height = $term->height ([$new_value])
1600		1646
1601	=item $font_width = $term->fwidth	1647	=item $font_width = $term->fwidth ([$new_value])
1602		1648
1603	=item $font_height = $term->fheight	1649	=item $font_height = $term->fheight ([$new_value])
1604		1650
1605	=item $font_ascent = $term->fbase	1651	=item $font_ascent = $term->fbase ([$new_value])
1606		1652
1607	=item $terminal_rows = $term->nrow	1653	=item $terminal_rows = $term->nrow ([$new_value])
1608		1654
1609	=item $terminal_columns = $term->ncol	1655	=item $terminal_columns = $term->ncol ([$new_value])
1610		1656
1611	=item $has_focus = $term->focus	1657	=item $has_focus = $term->focus ([$new_value])
1612		1658
1613	=item $is_mapped = $term->mapped	1659	=item $is_mapped = $term->mapped ([$new_value])
1614		1660
1615	=item $max_scrollback = $term->saveLines	1661	=item $max_scrollback = $term->saveLines ([$new_value])
1616		1662
1617	=item $nrow_plus_saveLines = $term->total_rows	1663	=item $nrow_plus_saveLines = $term->total_rows ([$new_value])
1618		1664
1619	=item $topmost_scrollback_row = $term->top_row	1665	=item $topmost_scrollback_row = $term->top_row ([$new_value])
1620		1666
1621	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.
1622		1669
1623	=item $x_display = $term->display_id	1670	=item $x_display = $term->display_id
1624		1671
1625	Return the DISPLAY used by rxvt-unicode.	1672	Return the DISPLAY used by rxvt-unicode.
1626		1673
…		…
1662	Returns the currently displayed screen (0 primary, 1 secondary).	1709	Returns the currently displayed screen (0 primary, 1 secondary).
1663		1710
1664	=item $cursor_is_hidden = $term->hidden_cursor	1711	=item $cursor_is_hidden = $term->hidden_cursor
1665		1712
1666	Returns whether the cursor is currently hidden or not.	1713	Returns whether the cursor is currently hidden or not.
		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	}
1667		1724
1668	=item $view_start = $term->view_start ([$newvalue])	1725	=item $view_start = $term->view_start ([$newvalue])
1669		1726
1670	Returns the row number of the topmost displayed line. Maximum value is	1727	Returns the row number of the topmost displayed line. Maximum value is
1671	C<0>, which displays the normal terminal contents. Lower values scroll	1728	C<0>, which displays the normal terminal contents. Lower values scroll
…		…
1676	Requests a screen refresh. At the next opportunity, rxvt-unicode will	1733	Requests a screen refresh. At the next opportunity, rxvt-unicode will
1677	compare the on-screen display with its stored representation. If they	1734	compare the on-screen display with its stored representation. If they
1678	differ, it redraws the differences.	1735	differ, it redraws the differences.
1679		1736
1680	Used after changing terminal contents to display them.	1737	Used after changing terminal contents to display them.
		1738
		1739	=item $term->refresh_check
		1740
		1741	Checks if a refresh has been requested and, if so, schedules one.
1681		1742
1682	=item $text = $term->ROW_t ($row_number[, $new_text[, $start_col]])	1743	=item $text = $term->ROW_t ($row_number[, $new_text[, $start_col]])
1683		1744
1684	Returns the text of the entire row with number C<$row_number>. Row C<< $term->top_row >>	1745	Returns the text of the entire row with number C<$row_number>. Row C<< $term->top_row >>
1685	is the topmost terminal line, row C<< $term->nrow-1 >> is the bottommost	1746	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.246 by root, Fri Dec 26 18:58:19 2014 UTC vs. Revision 1.259 by sf-exg, Sat May 8 06:16:21 2021 UTC

Diff Legend

Comparing rxvt-unicode/src/urxvt.pm (file contents):
Revision 1.246 by root, Fri Dec 26 18:58:19 2014 UTC vs.
Revision 1.259 by sf-exg, Sat May 8 06:16:21 2021 UTC