[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.256 by sf-exg, Thu Jul 14 05:10:06 2016 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.
		121
		122	Currently, it recognises only one such comment:
122		123
123	=over 4	124	=over 4
124		125
125	=item #:META:RESOURCE:name:type:desc	126	=item #:META:RESOURCE:name:type:desc
126		127
127	The RESOURCE comment defines a resource used by the extension, where	128	The RESOURCE comment defines a resource used by the extension, where
128	C<name> is the resource name, C<type> is the resource type, C<boolean>	129	C<name> is the resource name, C<type> is the resource type, C<boolean>
129	or C<string>, and C<desc> is the resource description.	130	or C<string>, and C<desc> is the resource description.
130
131	=item #:META:BINDING:sym:action
132
133	The BINDING comment defines a default binding for an action provided
134	by the extension, where C<sym> is the key combination that triggers
135	the action, whose format is defined in the description of the
136	B<keysym> resource in the urxvt(1) manpage, and C<action> is the name
137	of the action method.
138		131
139	=back	132	=back
140		133
141	=head2 Hooks	134	=head2 Hooks
142		135
…		…
611	if ($pattern eq $prefix) {	604	if ($pattern eq $prefix) {
612	$name = "$urxvt::RESCLASS.$k$suffix";	605	$name = "$urxvt::RESCLASS.$k$suffix";
613		606
614	push @{ $term->{perl_ext_3} }, $v->[0];	607	push @{ $term->{perl_ext_3} }, $v->[0];
615		608
		609	return 1 unless $isarg;
		610
616	if ($v->[1] eq "boolean") {	611	if ($v->[1] eq "boolean") {
617	$term->put_option_db ($name, $flag ? "true" : "false");	612	$term->put_option_db ($name, $flag ? "true" : "false");
618	return 1;	613	return 1;
619	} else {	614	} else {
620	$term->put_option_db ($name, $value);	615	$term->put_option_db ($name, $value);
…		…
721	@{ delete $TERM->{perl_ext_3} }	716	@{ delete $TERM->{perl_ext_3} }
722	) {	717	) {
723	if ($_ eq "default") {	718	if ($_ eq "default") {
724		719
725	$ext_arg{$_} = []	720	$ext_arg{$_} = []
726	for
727	qw(selection option-popup selection-popup readline searchable-scrollback),	721	for qw(selection option-popup selection-popup readline searchable-scrollback);
728	map $_->[0], values %{ $TERM->{meta}{binding} };
729		722
730	for ($TERM->_keysym_resources) {	723	for ($TERM->_keysym_resources) {
731	next if /^(?:string\|command\|builtin\|builtin-string\|perl)/;	724	next if /^(?:string\|command\|builtin\|builtin-string\|perl)/;
732	next unless /^([A-Za-z0-9_\-]+):/;	725	next unless /^([A-Za-z0-9_\-]+):/;
733		726
…		…
742	} elsif (/^([^<]+)<(.*)>$/) {	735	} elsif (/^([^<]+)<(.*)>$/) {
743	push @{ $ext_arg{$1} }, $2;	736	push @{ $ext_arg{$1} }, $2;
744		737
745	} else {	738	} else {
746	$ext_arg{$_} \|\|= [];	739	$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	}	740	}
755	}	741	}
756		742
757	for my $ext (sort keys %ext_arg) {	743	for my $ext (sort keys %ext_arg) {
758	my @files = grep -f $_, map "$_/$ext", @dirs;	744	my @files = grep -f $_, map "$_/$ext", @dirs;
…		…
981	}	967	}
982		968
983	bless \%disable, "urxvt::extension::on_disable"	969	bless \%disable, "urxvt::extension::on_disable"
984	}	970	}
985		971
		972	=item $self->bind_action ($hotkey, $action)
		973
986	=item $self->x_resource ($pattern)	974	=item $self->x_resource ($pattern)
987		975
988	=item $self->x_resource_boolean ($pattern)	976	=item $self->x_resource_boolean ($pattern)
989		977
990	These methods support an additional C<%> prefix when called on an	978	These methods support an additional C<%> prefix for C<$action> or
991	extension object - see the description of these methods in the	979	C<$pattern> when called on an extension object, compared to the
		980	C<urxvt::term> methods of the same name - see the description of these
992	C<urxvt::term> class for details.	981	methods in the C<urxvt::term> class for details.
993		982
994	=cut	983	=cut
		984
		985	sub bind_action {
		986	my ($self, $hotkey, $action) = @_;
		987	$action =~ s/^%:/$_[0]{_name}:/;
		988	$self->{term}->bind_action ($hotkey, $action)
		989	}
995		990
996	sub x_resource {	991	sub x_resource {
997	my ($self, $name) = @_;	992	my ($self, $name) = @_;
998	$name =~ s/^%(\.\|$)/$_[0]{_name}$1/;	993	$name =~ s/^%(\.\|$)/$_[0]{_name}$1/;
999	$self->{term}->x_resource ($name)	994	$self->{term}->x_resource ($name)
…		…
1140	sub scan_extensions {	1135	sub scan_extensions {
1141	my ($self) = @_;	1136	my ($self) = @_;
1142		1137
1143	return if exists $self->{meta};	1138	return if exists $self->{meta};
1144		1139
1145	my @libdirs = perl_libdirs $self;	1140	my @urxvtdirs = perl_libdirs $self;
		1141	# my @cpandirs = grep -d, map "$_/URxvt/Ext", @INC;
1146		1142
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;	1143	$self->{meta} = \my %meta;
1151		1144
1152	# first gather extensions	1145	# first gather extensions
1153	for my $dir (reverse @libdirs) {	1146
		1147	my $gather = sub {
		1148	my ($dir, $core) = @_;
		1149
1154	opendir my $fh, $dir	1150	opendir my $fh, $dir
1155	or next;	1151	or return;
		1152
1156	for my $ext (readdir $fh) {	1153	for my $ext (readdir $fh) {
1157	$ext !~ /^\./	1154	$ext !~ /^\./
		1155	or next;
		1156
1158	and open my $fh, "<", "$dir/$ext"	1157	open my $fh, "<", "$dir/$ext"
		1158	or next;
		1159
		1160	-f $fh
		1161	or next;
		1162
		1163	$ext =~ s/\.uext$// or $core
1159	or next;	1164	or next;
1160		1165
1161	my %ext = (dir => $dir);	1166	my %ext = (dir => $dir);
1162		1167
1163	while (<$fh>) {	1168	while (<$fh>) {
…		…
1167	if ($pattern =~ /[^a-zA-Z0-9\-\.]/) {	1172	if ($pattern =~ /[^a-zA-Z0-9\-\.]/) {
1168	warn "$dir/$ext: meta resource '$pattern' contains illegal characters (not alphanumeric nor . nor *)\n";	1173	warn "$dir/$ext: meta resource '$pattern' contains illegal characters (not alphanumeric nor . nor *)\n";
1169	} else {	1174	} else {
1170	$ext{resource}{$pattern} = [$ext, $type, $desc];	1175	$ext{resource}{$pattern} = [$ext, $type, $desc];
1171	}	1176	}
1172	} elsif (/^#:META:BINDING:(.*)/) {
1173	my ($keysym, $action) = split /:/, $1;
1174	$ext{binding}{$keysym} = [$ext, $action];
1175	} elsif (/^\s*(?:#\|$)/) {	1177	} elsif (/^\s*(?:#\|$)/) {
1176	# skip other comments and empty lines	1178	# skip other comments and empty lines
1177	} else {	1179	} else {
1178	last; # stop parsing on first non-empty non-comment line	1180	last; # stop parsing on first non-empty non-comment line
1179	}	1181	}
1180	}	1182	}
1181		1183
1182	$meta{ext}{$ext} = \%ext;	1184	$meta{ext}{$ext} = \%ext;
1183	}	1185	}
1184	}	1186	};
1185		1187
		1188	# $gather->($_, 0) for @cpandirs;
		1189	$gather->($_, 1) for @urxvtdirs;
		1190
1186	# and now merge resources and bindings	1191	# and now merge resources
		1192
		1193	$meta{resource} = \my %resource;
		1194
1187	while (my ($k, $v) = each %{ $meta{ext} }) {	1195	while (my ($k, $v) = each %{ $meta{ext} }) {
1188	#TODO: should check for extensions overriding each other	1196	#TODO: should check for extensions overriding each other
1189	%{ $meta{resource} } = (%{ $meta{resource} }, %{ $v->{resource} });	1197	%resource = (%resource, %{ $v->{resource} });
1190	%{ $meta{binding} } = (%{ $meta{binding} }, %{ $v->{binding} });
1191	}	1198	}
1192	}	1199	}
1193		1200
1194	=item $term = new urxvt::term $envhashref, $rxvtname, [arg...]	1201	=item $term = new urxvt::term $envhashref, $rxvtname, [arg...]
1195		1202
…		…
1341	my $res = &x_resource;	1348	my $res = &x_resource;
1342		1349
1343	$res =~ /^\s(?:true\|yes\|on\|1)\s$/i ? 1 : defined $res && 0	1350	$res =~ /^\s(?:true\|yes\|on\|1)\s$/i ? 1 : defined $res && 0
1344	}	1351	}
1345		1352
		1353	=item $action = $term->lookup_keysym ($keysym, $state)
		1354
		1355	Returns the action bound to key combination C<($keysym, $state)>,
		1356	if a binding for it exists, and C<undef> otherwise.
		1357
1346	=item $success = $term->bind_action ($key, $octets)	1358	=item $success = $term->bind_action ($key, $action)
1347		1359
1348	Adds a key binding exactly as specified via a C<keysym> resource. See the	1360	Adds a key binding exactly as specified via a C<keysym> resource. See the
1349	C<keysym> resource in the urxvt(1) manpage.	1361	C<keysym> resource in the urxvt(1) manpage.
		1362
		1363	To add default bindings for actions, an extension should call C<<
		1364	->bind_action >> in its C<init> hook for every such binding. Doing it
		1365	in the C<init> hook allows users to override or remove the binding
		1366	again.
		1367
		1368	Example: the C<searchable-scrollback> by default binds itself
		1369	on C<Meta-s>, using C<< $self->bind_action >>, which calls C<<
		1370	$term->bind_action >>.
		1371
		1372	sub init {
		1373	my ($self) = @_;
		1374
		1375	$self->bind_action ("M-s" => "%:start");
		1376	}
1350		1377
1351	=item $rend = $term->rstyle ([$new_rstyle])	1378	=item $rend = $term->rstyle ([$new_rstyle])
1352		1379
1353	Return and optionally change the current rendition. Text that is output by	1380	Return and optionally change the current rendition. Text that is output by
1354	the terminal application will use this style.	1381	the terminal application will use this style.
…		…
1592		1619
1593	=item $term->key_release ($state, $keycode[, $time])	1620	=item $term->key_release ($state, $keycode[, $time])
1594		1621
1595	Deliver various fake events to to terminal.	1622	Deliver various fake events to to terminal.
1596		1623
1597	=item $window_width = $term->width	1624	=item $window_width = $term->width ([$new_value])
1598		1625
1599	=item $window_height = $term->height	1626	=item $window_height = $term->height ([$new_value])
1600		1627
1601	=item $font_width = $term->fwidth	1628	=item $font_width = $term->fwidth ([$new_value])
1602		1629
1603	=item $font_height = $term->fheight	1630	=item $font_height = $term->fheight ([$new_value])
1604		1631
1605	=item $font_ascent = $term->fbase	1632	=item $font_ascent = $term->fbase ([$new_value])
1606		1633
1607	=item $terminal_rows = $term->nrow	1634	=item $terminal_rows = $term->nrow ([$new_value])
1608		1635
1609	=item $terminal_columns = $term->ncol	1636	=item $terminal_columns = $term->ncol ([$new_value])
1610		1637
1611	=item $has_focus = $term->focus	1638	=item $has_focus = $term->focus ([$new_value])
1612		1639
1613	=item $is_mapped = $term->mapped	1640	=item $is_mapped = $term->mapped ([$new_value])
1614		1641
1615	=item $max_scrollback = $term->saveLines	1642	=item $max_scrollback = $term->saveLines ([$new_value])
1616		1643
1617	=item $nrow_plus_saveLines = $term->total_rows	1644	=item $nrow_plus_saveLines = $term->total_rows ([$new_value])
1618		1645
1619	=item $topmost_scrollback_row = $term->top_row	1646	=item $topmost_scrollback_row = $term->top_row ([$new_value])
1620		1647
1621	Return various integers describing terminal characteristics.	1648	Return various integers describing terminal characteristics. If an
		1649	argument is given, changes the value and returns the previous one.
1622		1650
1623	=item $x_display = $term->display_id	1651	=item $x_display = $term->display_id
1624		1652
1625	Return the DISPLAY used by rxvt-unicode.	1653	Return the DISPLAY used by rxvt-unicode.
1626		1654
…		…
1676	Requests a screen refresh. At the next opportunity, rxvt-unicode will	1704	Requests a screen refresh. At the next opportunity, rxvt-unicode will
1677	compare the on-screen display with its stored representation. If they	1705	compare the on-screen display with its stored representation. If they
1678	differ, it redraws the differences.	1706	differ, it redraws the differences.
1679		1707
1680	Used after changing terminal contents to display them.	1708	Used after changing terminal contents to display them.
		1709
		1710	=item $term->refresh_check
		1711
		1712	Checks if a refresh has been requested and, if so, schedules one.
1681		1713
1682	=item $text = $term->ROW_t ($row_number[, $new_text[, $start_col]])	1714	=item $text = $term->ROW_t ($row_number[, $new_text[, $start_col]])
1683		1715
1684	Returns the text of the entire row with number C<$row_number>. Row C<< $term->top_row >>	1716	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	1717	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.256 by sf-exg, Thu Jul 14 05:10:06 2016 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.256 by sf-exg, Thu Jul 14 05:10:06 2016 UTC