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

Comparing rxvt-unicode/src/urxvt.pm (file contents):
Revision 1.198 by root, Tue Oct 4 22:25:14 2011 UTC vs.
Revision 1.217 by root, Sun Jun 10 13:58:05 2012 UTC

…		…
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.
24		24
25	Scripts are compiled in a 'use strict' and 'use utf8' environment, and	25	Scripts are compiled in a 'use strict "vars"' and 'use utf8' environment, and
26	thus must be encoded as UTF-8.	26	thus must be encoded as UTF-8.
27		27
28	Each script will only ever be loaded once, even in @@RXVT_NAME@@d, where	28	Each script will only ever be loaded once, even in @@RXVT_NAME@@d, where
29	scripts will be shared (but not enabled) for all terminals.	29	scripts will be shared (but not enabled) for all terminals.
30		30
…		…
400	=item confirm-paste	400	=item confirm-paste
401		401
402	Displays a confirmation dialog when a paste containing at least a full	402	Displays a confirmation dialog when a paste containing at least a full
403	line is detected.	403	line is detected.
404		404
		405	=item bell-command
		406
		407	Runs the command specified by the C<URxvt.bell-command> resource when
		408	a bell event occurs. For example, the following pops up a notification
		409	bubble with the text "Beep, Beep" using notify-send:
		410
		411	URxvt.bell-command: notify-send "Beep, Beep"
		412
405	=back	413	=back
406		414
407	=head1 API DOCUMENTATION	415	=head1 API DOCUMENTATION
408		416
409	=head2 General API Considerations	417	=head2 General API Considerations
…		…
437		445
438	=item $octets	446	=item $octets
439		447
440	Either binary data or - more common - a text string encoded in a	448	Either binary data or - more common - a text string encoded in a
441	locale-specific way.	449	locale-specific way.
		450
		451	=item $keysym
		452
		453	an integer that is a valid X11 keysym code. You can convert a string
		454	into a keysym and viceversa by using C<XStringToKeysym> and
		455	C<XKeysymToString>.
442		456
443	=back	457	=back
444		458
445	=head2 Extension Objects	459	=head2 Extension Objects
446		460
…		…
658	resource in the @@RXVT_NAME@@(1) manpage).	672	resource in the @@RXVT_NAME@@(1) manpage).
659		673
660	The event is simply the action string. This interface is assumed to change	674	The event is simply the action string. This interface is assumed to change
661	slightly in the future.	675	slightly in the future.
662		676
		677	=item on_register_command $term, $keysym, $modifiermask, $string
		678
		679	Called after parsing a keysym resource but before registering the
		680	associated binding. If this hook returns TRUE the binding is not
		681	registered. It can be used to modify a binding by calling
		682	C<register_command>.
		683
663	=item on_resize_all_windows $term, $new_width, $new_height	684	=item on_resize_all_windows $term, $new_width, $new_height
664		685
665	Called just after the new window size has been calculated, but before	686	Called just after the new window size has been calculated, but before
666	windows are actually being resized or hints are being set. If this hook	687	windows are actually being resized or hints are being set. If this hook
667	returns TRUE, setting of the window hints is being skipped.	688	returns TRUE, setting of the window hints is being skipped.
…		…
734	=cut	755	=cut
735		756
736	package urxvt;	757	package urxvt;
737		758
738	use utf8;	759	use utf8;
739	use strict;	760	use strict 'vars';
740	use Carp ();	761	use Carp ();
741	use Scalar::Util ();	762	use Scalar::Util ();
742	use List::Util ();	763	use List::Util ();
743		764
744	our $VERSION = 1;	765	our $VERSION = 1;
745	our $TERM;	766	our $TERM;
746	our @TERM_INIT;	767	our @TERM_INIT; # should go, prevents async I/O etc.
747	our @TERM_EXT;	768	our @TERM_EXT; # should go, prevents async I/O etc.
748	our @HOOKNAME;	769	our @HOOKNAME;
749	our %HOOKTYPE = map +($HOOKNAME[$_] => $_), 0..$#HOOKNAME;	770	our %HOOKTYPE = map +($HOOKNAME[$_] => $_), 0..$#HOOKNAME;
750	our %OPTION;	771	our %OPTION;
751		772
752	our $LIBDIR;	773	our $LIBDIR;
…		…
922	};	943	};
923	}	944	}
924		945
925	no warnings 'utf8';	946	no warnings 'utf8';
926		947
		948	sub parse_resource {
		949	my ($term, $name, $isarg, $longopt, $flag, $value) = @_;
		950
		951	$name =~ y/-/./ if $isarg;
		952
		953	$term->scan_meta;
		954
		955	my $r = $term->{meta}{resource};
		956	keys %$r; # reste iterator
		957	while (my ($pattern, $v) = each %$r) {
		958	if (
		959	$pattern =~ /\.$/
		960	? $pattern eq substr $name, 0, length $pattern
		961	: $pattern eq $name
		962	) {
		963	$name = "$urxvt::RESCLASS.$name";
		964
		965	push @{ $term->{perl_ext_3} }, $v->[0];
		966
		967	if ($v->[1] eq "boolean") {
		968	$term->put_option_db ($name, $flag ? "true" : "false");
		969	return 1;
		970	} else {
		971	$term->put_option_db ($name, $value);
		972	return 1 + 2;
		973	}
		974	}
		975	}
		976
		977	0
		978	}
		979
		980	sub usage {
		981	my ($term, $usage_type) = @_;
		982
		983	$term->scan_meta;
		984
		985	my $r = $term->{meta}{resource};
		986
		987	for my $pattern (sort keys %$r) {
		988	my ($ext, $type, $desc) = @{ $r->{$pattern} };
		989
		990	$desc .= " (-pe $ext)";
		991
		992	if ($usage_type == 1) {
		993	$pattern =~ y/./-/;
		994	$pattern =~ s/-$/-.../g;
		995
		996	if ($type eq "boolean") {
		997	urxvt::log sprintf " -%-30s %s\n", "/+$pattern", $desc;
		998	} else {
		999	urxvt::log sprintf " -%-30s %s\n", "$pattern $type", $desc;
		1000	}
		1001	} else {
		1002	$pattern =~ s/\.$/.*/g;
		1003	urxvt::log sprintf " %-31s %s\n", "$pattern:", $type;
		1004	}
		1005	}
		1006	}
		1007
927	my $verbosity = $ENV{URXVT_PERL_VERBOSITY};	1008	my $verbosity = $ENV{URXVT_PERL_VERBOSITY};
928		1009
929	sub verbose {	1010	sub verbose {
930	my ($level, $msg) = @_;	1011	my ($level, $msg) = @_;
931	warn "$msg\n" if $level <= $verbosity;	1012	warn "$msg\n" if $level <= $verbosity;
…		…
943	$pkg =~ s/[^[:word:]]/_/g;	1024	$pkg =~ s/[^[:word:]]/_/g;
944	$pkg = "urxvt::ext::$pkg";	1025	$pkg = "urxvt::ext::$pkg";
945		1026
946	verbose 3, "loading extension '$path' into package '$pkg'";	1027	verbose 3, "loading extension '$path' into package '$pkg'";
947		1028
		1029	(${"$pkg\::_NAME"} = $path) =~ s/^.*[\\\/]//; # hackish
		1030
948	open my $fh, "<:raw", $path	1031	open my $fh, "<:raw", $path
949	or die "$path: $!";	1032	or die "$path: $!";
950		1033
951	my $source =	1034	my $source =
952	"package $pkg; use strict; use utf8; no warnings 'utf8';\n"	1035	"package $pkg; use strict 'vars'; use utf8; no warnings 'utf8';\n"
953	. "#line 1 \"$path\"\n{\n"	1036	. "#line 1 \"$path\"\n{\n"
954	. (do { local $/; <$fh> })	1037	. (do { local $/; <$fh> })
955	. "\n};\n1";	1038	. "\n};\n1";
956		1039
957	eval $source	1040	eval $source
…		…
967	sub invoke {	1050	sub invoke {
968	local $TERM = shift;	1051	local $TERM = shift;
969	my $htype = shift;	1052	my $htype = shift;
970		1053
971	if ($htype == 0) { # INIT	1054	if ($htype == 0) { # INIT
972	my @dirs = ((split /:/, $TERM->resource ("perl_lib")), "$LIBDIR/perl");	1055	my @dirs = $TERM->perl_libdirs;
973		1056
974	my %ext_arg;	1057	my %ext_arg;
975		1058
976	{	1059	{
977	my @init = @TERM_INIT;	1060	my @init = @TERM_INIT;
…		…
980	my @pkg = @TERM_EXT;	1063	my @pkg = @TERM_EXT;
981	@TERM_EXT = ();	1064	@TERM_EXT = ();
982	$TERM->register_package ($_) for @pkg;	1065	$TERM->register_package ($_) for @pkg;
983	}	1066	}
984		1067
		1068	for (
		1069	@{ delete $TERM->{perl_ext_3} },
985	for (grep $_, map { split /,/, $TERM->resource ("perl_ext_$_") } 1, 2) {	1070	grep $_, map { split /,/, $TERM->resource ("perl_ext_$_") } 1, 2
		1071	) {
986	if ($_ eq "default") {	1072	if ($_ eq "default") {
987	$ext_arg{$_} \|\|= [] for qw(selection option-popup selection-popup searchable-scrollback readline);	1073	$ext_arg{$_} \|\|= [] for qw(selection option-popup selection-popup searchable-scrollback readline);
988	} elsif (/^-(.*)$/) {	1074	} elsif (/^-(.*)$/) {
989	delete $ext_arg{$1};	1075	delete $ext_arg{$1};
990	} elsif (/^([^<]+)<(.*)>$/) {	1076	} elsif (/^([^<]+)<(.*)>$/) {
…		…
1066	}	1152	}
1067	}	1153	}
1068	($mask, @color{qw(fg bg)}, \@failed)	1154	($mask, @color{qw(fg bg)}, \@failed)
1069	}	1155	}
1070		1156
1071	# urxvt::term::extension
1072
1073	package urxvt::term::extension;	1157	package urxvt::term::extension;
1074		1158
1075	sub enable {	1159	sub enable {
1076	my ($self, %hook) = @_;	1160	my ($self, %hook) = @_;
1077	my $pkg = $self->{_pkg};	1161	my $pkg = $self->{_pkg};
…		…
1131		1215
1132	sub urxvt::destroy_hook(&) {	1216	sub urxvt::destroy_hook(&) {
1133	bless \shift, urxvt::destroy_hook::	1217	bless \shift, urxvt::destroy_hook::
1134	}	1218	}
1135		1219
		1220	sub x_resource {
		1221	my ($self, $name) = @_;
		1222	$name =~ s/^%(\.\|$)/$_[0]{_name}$1/;
		1223	$self->{term}->x_resource ($name)
		1224	}
		1225
		1226	sub x_resource_boolean {
		1227	my ($self, $name) = @_;
		1228	$name =~ s/^%(\.\|$)/$_[0]{_name}$1/;
		1229	$self->{term}->x_resource_boolean ($name)
		1230	}
		1231
1136	package urxvt::anyevent;	1232	package urxvt::anyevent;
1137		1233
1138	=head2 The C<urxvt::anyevent> Class	1234	=head2 The C<urxvt::anyevent> Class
1139		1235
1140	The sole purpose of this class is to deliver an interface to the	1236	The sole purpose of this class is to deliver an interface to the
1141	C<AnyEvent> module - any module using it will work inside urxvt without	1237	C<AnyEvent> module - any module using it will work inside urxvt without
1142	further programming. The only exception is that you cannot wait on	1238	further programming. The only exception is that you cannot wait on
1143	condition variables, but non-blocking condvar use is ok. What this means	1239	condition variables, but non-blocking condvar use is ok.
1144	is that you cannot use blocking APIs, but the non-blocking variant should	1240
1145	work.	1241	In practical terms this means is that you cannot use blocking APIs, but
		1242	the non-blocking variant should work.
1146		1243
1147	=cut	1244	=cut
1148		1245
1149	our $VERSION = '5.23';	1246	our $VERSION = '5.23';
1150		1247
…		…
1234	urxvt::verbose 6, "register package $pkg to $self";	1331	urxvt::verbose 6, "register package $pkg to $self";
1235		1332
1236	@{"$pkg\::ISA"} = urxvt::term::extension::;	1333	@{"$pkg\::ISA"} = urxvt::term::extension::;
1237		1334
1238	my $proxy = bless {	1335	my $proxy = bless {
1239	_pkg => $pkg,	1336	_pkg => $pkg,
		1337	_name => ${"$pkg\::_NAME"}, # hackish
1240	argv => $argv,	1338	argv => $argv,
1241	}, $pkg;	1339	}, $pkg;
1242	Scalar::Util::weaken ($proxy->{term} = $self);	1340	Scalar::Util::weaken ($proxy->{term} = $self);
1243		1341
1244	$self->{_pkg}{$pkg} = $proxy;	1342	$self->{_pkg}{$pkg} = $proxy;
1245		1343
1246	for my $name (@HOOKNAME) {	1344	for my $name (@HOOKNAME) {
1247	if (my $ref = $pkg->can ("on_" . lc $name)) {	1345	if (my $ref = $pkg->can ("on_" . lc $name)) {
1248	$proxy->enable ($name => $ref);	1346	$proxy->enable ($name => $ref);
		1347	}
		1348	}
		1349	}
		1350
		1351	sub perl_libdirs {
		1352	map { split /:/ }
		1353	$_[0]->resource ("perl_lib"),
		1354	$ENV{URXVT_PERL_LIB},
		1355	"$ENV{HOME}/.urxvt/ext",
		1356	"$LIBDIR/perl"
		1357	}
		1358
		1359	sub scan_meta {
		1360	my ($self) = @_;
		1361	my @libdirs = perl_libdirs $self;
		1362
		1363	return if $self->{meta_libdirs} eq join "\x00", @libdirs;
		1364
		1365	my %meta;
		1366
		1367	$self->{meta_libdirs} = join "\x00", @libdirs;
		1368	$self->{meta} = \%meta;
		1369
		1370	for my $dir (reverse @libdirs) {
		1371	opendir my $fh, $dir
		1372	or next;
		1373	for my $ext (readdir $fh) {
		1374	$ext ne "."
		1375	and $ext ne ".."
		1376	and open my $fh, "<", "$dir/$ext"
		1377	or next;
		1378
		1379	while (<$fh>) {
		1380	if (/^#:META:X_RESOURCE:(.*)/) {
		1381	my ($pattern, $type, $desc) = split /:/, $1;
		1382	$pattern =~ s/^%(\.\|$)/$ext$1/g; # % in pattern == extension name
		1383	if ($pattern =~ /[^a-zA-Z0-9\-\.]/) {
		1384	warn "$dir/$ext: meta resource '$pattern' contains illegal characters (not alphanumeric nor . nor *)\n";
		1385	} else {
		1386	$meta{resource}{$pattern} = [$ext, $type, $desc];
		1387	}
		1388	} elsif (/^\s*(?:#\|$)/) {
		1389	# skip other comments and empty lines
		1390	} else {
		1391	last; # stop parsing on first non-empty non-comment line
		1392	}
		1393	}
1249	}	1394	}
1250	}	1395	}
1251	}	1396	}
1252		1397
1253	=item $term = new urxvt::term $envhashref, $rxvtname, [arg...]	1398	=item $term = new urxvt::term $envhashref, $rxvtname, [arg...]
…		…
1370	Returns the X-Resource for the given pattern, excluding the program or	1515	Returns the X-Resource for the given pattern, excluding the program or
1371	class name, i.e. C<< $term->x_resource ("boldFont") >> should return the	1516	class name, i.e. C<< $term->x_resource ("boldFont") >> should return the
1372	same value as used by this instance of rxvt-unicode. Returns C<undef> if no	1517	same value as used by this instance of rxvt-unicode. Returns C<undef> if no
1373	resource with that pattern exists.	1518	resource with that pattern exists.
1374		1519
		1520	Extensions that define extra resource or command line arguments also need
		1521	to call this method to access their values.
		1522
		1523	If the method is called on an extension object (basically, from an
		1524	extension), then the special prefix C<%.> will be replaced by the name of
		1525	the extension and a dot, and the lone string C<%> will be replcaed by the
		1526	extension name itself. This makes it possible to code extensions so you
		1527	can rename them and get a new set of commandline switches and resources
		1528	without having to change the actual code.
		1529
1375	This method should only be called during the C<on_start> hook, as there is	1530	This method should only be called during the C<on_start> hook, as there is
1376	only one resource database per display, and later invocations might return	1531	only one resource database per display, and later invocations might return
1377	the wrong resources.	1532	the wrong resources.
1378		1533
1379	=item $success = $term->parse_keysym ($keysym_spec, $command_string)	1534	=item $value = $term->x_resource_boolean ($pattern)
1380		1535
		1536	Like C<x_resource>, above, but interprets the string value as a boolean
		1537	and returns C<1> for true values, C<0> for false values and C<undef> if
		1538	the resource or option isn't specified.
		1539
		1540	You should always use this method to parse boolean resources.
		1541
		1542	=cut
		1543
		1544	sub x_resource_boolean {
		1545	my $res = &x_resource;
		1546
		1547	$res =~ /^\s(?:true\|yes\|on\|1)\s$/i ? 1 : defined $res && 0
		1548	}
		1549
		1550	=item $success = $term->parse_keysym ($key, $octets)
		1551
1381	Adds a keymap translation exactly as specified via a resource. See the	1552	Adds a key binding exactly as specified via a resource. See the
1382	C<keysym> resource in the @@RXVT_NAME@@(1) manpage.	1553	C<keysym> resource in the @@RXVT_NAME@@(1) manpage.
		1554
		1555	=item $term->register_command ($keysym, $modifiermask, $string)
		1556
		1557	Adds a key binding. This is a lower level api compared to
		1558	C<parse_keysym>, as it expects a parsed key description, and can be
		1559	used only inside either the C<on_init> hook, to add a binding, or the
		1560	C<on_register_command> hook, to modify a parsed binding.
1383		1561
1384	=item $rend = $term->rstyle ([$new_rstyle])	1562	=item $rend = $term->rstyle ([$new_rstyle])
1385		1563
1386	Return and optionally change the current rendition. Text that is output by	1564	Return and optionally change the current rendition. Text that is output by
1387	the terminal application will use this style.	1565	the terminal application will use this style.
…		…
1600		1778
1601	Adds the specified events to the vt event mask. Useful e.g. when you want	1779	Adds the specified events to the vt event mask. Useful e.g. when you want
1602	to receive pointer events all the times:	1780	to receive pointer events all the times:
1603		1781
1604	$term->vt_emask_add (urxvt::PointerMotionMask);	1782	$term->vt_emask_add (urxvt::PointerMotionMask);
		1783
		1784	=item $term->set_urgency ($set)
		1785
		1786	Enable/disable the urgency hint on the toplevel window.
1605		1787
1606	=item $term->focus_in	1788	=item $term->focus_in
1607		1789
1608	=item $term->focus_out	1790	=item $term->focus_out
1609		1791
…		…
1925	=item $term->XMoveResizeWindow ($window, $x, $y, $width, $height)	2107	=item $term->XMoveResizeWindow ($window, $x, $y, $width, $height)
1926		2108
1927	=item ($x, $y, $child_window) = $term->XTranslateCoordinates ($src, $dst, $x, $y)	2109	=item ($x, $y, $child_window) = $term->XTranslateCoordinates ($src, $dst, $x, $y)
1928		2110
1929	=item $term->XChangeInput ($window, $add_events[, $del_events])	2111	=item $term->XChangeInput ($window, $add_events[, $del_events])
		2112
		2113	=item $keysym = $term->XStringToKeysym ($string)
		2114
		2115	=item $string = $term->XKeysymToString ($keysym)
1930		2116
1931	Various X or X-related functions. The C<$term> object only serves as	2117	Various X or X-related functions. The C<$term> object only serves as
1932	the source of the display, otherwise those functions map more-or-less	2118	the source of the display, otherwise those functions map more-or-less
1933	directly onto the X functions of the same name.	2119	directly onto the X functions of the same name.
1934		2120

Diff Legend

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

Comparing rxvt-unicode/src/urxvt.pm (file contents): Revision 1.198 by root, Tue Oct 4 22:25:14 2011 UTC vs. Revision 1.217 by root, Sun Jun 10 13:58:05 2012 UTC

Diff Legend

Comparing rxvt-unicode/src/urxvt.pm (file contents):
Revision 1.198 by root, Tue Oct 4 22:25:14 2011 UTC vs.
Revision 1.217 by root, Sun Jun 10 13:58:05 2012 UTC