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

Comparing rxvt-unicode/src/urxvt.pm (file contents):
Revision 1.194 by sf-exg, Wed Jun 29 21:59:36 2011 UTC vs.
Revision 1.215 by root, Thu Jun 7 16:30:58 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
…		…
259	The default pattern to match URLs can be overridden with the	259	The default pattern to match URLs can be overridden with the
260	C<matcher.pattern.0> resource, and additional patterns can be specified	260	C<matcher.pattern.0> resource, and additional patterns can be specified
261	with numbered patterns, in a manner similar to the "selection" extension.	261	with numbered patterns, in a manner similar to the "selection" extension.
262	The launcher can also be overridden on a per-pattern basis.	262	The launcher can also be overridden on a per-pattern basis.
263		263
264	It is possible to activate the most recently seen match from the keyboard.	264	It is possible to activate the most recently seen match or a list of matches
		265	from the keyboard. Simply bind a keysym to "perl:matcher:last" or
265	Simply bind a keysym to "perl:matcher" as seen in the example below.	266	"perl:matcher:list" as seen in the example below.
266		267
267	Example configuration:	268	Example configuration:
268		269
269	URxvt.perl-ext: default,matcher	270	URxvt.perl-ext: default,matcher
270	URxvt.urlLauncher: sensible-browser	271	URxvt.urlLauncher: sensible-browser
271	URxvt.keysym.C-Delete: perl:matcher	272	URxvt.keysym.C-Delete: perl:matcher:last
		273	URxvt.keysym.M-Delete: perl:matcher:list
272	URxvt.matcher.button: 1	274	URxvt.matcher.button: 1
273	URxvt.matcher.pattern.1: \\bwww\\.[\\w-]+\\.[\\w./?&@#-]*[\\w/-]	275	URxvt.matcher.pattern.1: \\bwww\\.[\\w-]+\\.[\\w./?&@#-]*[\\w/-]
274	URxvt.matcher.pattern.2: \\B(/\\S+?):(\\d+)(?=:\|$)	276	URxvt.matcher.pattern.2: \\B(/\\S+?):(\\d+)(?=:\|$)
275	URxvt.matcher.launcher.2: gvim +$2 $1	277	URxvt.matcher.launcher.2: gvim +$2 $1
276		278
…		…
398	=item confirm-paste	400	=item confirm-paste
399		401
400	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
401	line is detected.	403	line is detected.
402		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
403	=back	413	=back
404		414
405	=head1 API DOCUMENTATION	415	=head1 API DOCUMENTATION
406		416
407	=head2 General API Considerations	417	=head2 General API Considerations
…		…
435		445
436	=item $octets	446	=item $octets
437		447
438	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
439	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>.
440		456
441	=back	457	=back
442		458
443	=head2 Extension Objects	459	=head2 Extension Objects
444		460
…		…
656	resource in the @@RXVT_NAME@@(1) manpage).	672	resource in the @@RXVT_NAME@@(1) manpage).
657		673
658	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
659	slightly in the future.	675	slightly in the future.
660		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
661	=item on_resize_all_windows $term, $new_width, $new_height	684	=item on_resize_all_windows $term, $new_width, $new_height
662		685
663	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
664	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
665	returns TRUE, setting of the window hints is being skipped.	688	returns TRUE, setting of the window hints is being skipped.
…		…
732	=cut	755	=cut
733		756
734	package urxvt;	757	package urxvt;
735		758
736	use utf8;	759	use utf8;
737	use strict;	760	use strict 'vars';
738	use Carp ();	761	use Carp ();
739	use Scalar::Util ();	762	use Scalar::Util ();
740	use List::Util ();	763	use List::Util ();
741		764
742	our $VERSION = 1;	765	our $VERSION = 1;
743	our $TERM;	766	our $TERM;
744	our @TERM_INIT;	767	our @TERM_INIT; # should go, prevents async I/O etc.
745	our @TERM_EXT;	768	our @TERM_EXT; # should go, prevents async I/O etc.
746	our @HOOKNAME;	769	our @HOOKNAME;
747	our %HOOKTYPE = map +($HOOKNAME[$_] => $_), 0..$#HOOKNAME;	770	our %HOOKTYPE = map +($HOOKNAME[$_] => $_), 0..$#HOOKNAME;
748	our %OPTION;	771	our %OPTION;
749		772
750	our $LIBDIR;	773	our $LIBDIR;
…		…
920	};	943	};
921	}	944	}
922		945
923	no warnings 'utf8';	946	no warnings 'utf8';
924		947
		948	sub parse_resource {
		949	my ($term, $name, $isarg, $longopt, $flag, $value) = @_;
		950
		951	$term->scan_meta;
		952
		953	my $r = $term->{meta}{resource};
		954	while (my ($pattern, $v) = each %$r) {
		955	$name =~ y/-/./ if $isarg;
		956
		957	if (
		958	$pattern =~ /\.$/
		959	? $pattern eq substr $name, 0, length $pattern
		960	: $pattern eq $name
		961	) {
		962	$name = "$urxvt::RESCLASS.$name";
		963
		964	push @{ $term->{perl_ext_3} }, $v->[0];
		965
		966	if ($v->[1] eq "boolean") {
		967	$term->put_option_db ($name, $flag ? "true" : "false");
		968	return 1;
		969	} else {
		970	$term->put_option_db ($name, $value);
		971	return 1 + 2;
		972	}
		973	}
		974	}
		975
		976	0
		977	}
		978
		979	sub usage {
		980	my ($term, $usage_type) = @_;
		981
		982	$term->scan_meta;
		983
		984	my $r = $term->{meta}{resource};
		985
		986	for my $pattern (sort keys %$r) {
		987	my ($ext, $type, $desc) = @{ $r->{$pattern} };
		988
		989	$desc .= " (-pe $ext)";
		990
		991	if ($usage_type == 1) {
		992	$pattern =~ y/./-/;
		993	$pattern =~ s/-$/-.../g;
		994
		995	if ($type eq "boolean") {
		996	urxvt::log sprintf " -%-30s %s\n", "/+$pattern", $desc;
		997	} else {
		998	urxvt::log sprintf " -%-30s %s\n", "$pattern $type", $desc;
		999	}
		1000	} else {
		1001	$pattern =~ s/\.$/.*/g;
		1002	urxvt::log sprintf " %-31s %s\n", "$pattern:", $type;
		1003	}
		1004	}
		1005	}
		1006
925	my $verbosity = $ENV{URXVT_PERL_VERBOSITY};	1007	my $verbosity = $ENV{URXVT_PERL_VERBOSITY};
926		1008
927	sub verbose {	1009	sub verbose {
928	my ($level, $msg) = @_;	1010	my ($level, $msg) = @_;
929	warn "$msg\n" if $level <= $verbosity;	1011	warn "$msg\n" if $level <= $verbosity;
…		…
945		1027
946	open my $fh, "<:raw", $path	1028	open my $fh, "<:raw", $path
947	or die "$path: $!";	1029	or die "$path: $!";
948		1030
949	my $source =	1031	my $source =
950	"package $pkg; use strict; use utf8; no warnings 'utf8';\n"	1032	"package $pkg; use strict 'vars'; use utf8; no warnings 'utf8';\n"
951	. "#line 1 \"$path\"\n{\n"	1033	. "#line 1 \"$path\"\n{\n"
952	. (do { local $/; <$fh> })	1034	. (do { local $/; <$fh> })
953	. "\n};\n1";	1035	. "\n};\n1";
954		1036
955	eval $source	1037	eval $source
…		…
965	sub invoke {	1047	sub invoke {
966	local $TERM = shift;	1048	local $TERM = shift;
967	my $htype = shift;	1049	my $htype = shift;
968		1050
969	if ($htype == 0) { # INIT	1051	if ($htype == 0) { # INIT
970	my @dirs = ((split /:/, $TERM->resource ("perl_lib")), "$LIBDIR/perl");	1052	my @dirs = $TERM->perl_libdirs;
971		1053
972	my %ext_arg;	1054	my %ext_arg;
973		1055
974	{	1056	{
975	my @init = @TERM_INIT;	1057	my @init = @TERM_INIT;
…		…
978	my @pkg = @TERM_EXT;	1060	my @pkg = @TERM_EXT;
979	@TERM_EXT = ();	1061	@TERM_EXT = ();
980	$TERM->register_package ($_) for @pkg;	1062	$TERM->register_package ($_) for @pkg;
981	}	1063	}
982		1064
		1065	for (
		1066	@{ delete $TERM->{perl_ext_3} },
983	for (grep $_, map { split /,/, $TERM->resource ("perl_ext_$_") } 1, 2) {	1067	grep $_, map { split /,/, $TERM->resource ("perl_ext_$_") } 1, 2
		1068	) {
984	if ($_ eq "default") {	1069	if ($_ eq "default") {
985	$ext_arg{$_} \|\|= [] for qw(selection option-popup selection-popup searchable-scrollback readline);	1070	$ext_arg{$_} \|\|= [] for qw(selection option-popup selection-popup searchable-scrollback readline);
986	} elsif (/^-(.*)$/) {	1071	} elsif (/^-(.*)$/) {
987	delete $ext_arg{$1};	1072	delete $ext_arg{$1};
988	} elsif (/^([^<]+)<(.*)>$/) {	1073	} elsif (/^([^<]+)<(.*)>$/) {
…		…
1136	=head2 The C<urxvt::anyevent> Class	1221	=head2 The C<urxvt::anyevent> Class
1137		1222
1138	The sole purpose of this class is to deliver an interface to the	1223	The sole purpose of this class is to deliver an interface to the
1139	C<AnyEvent> module - any module using it will work inside urxvt without	1224	C<AnyEvent> module - any module using it will work inside urxvt without
1140	further programming. The only exception is that you cannot wait on	1225	further programming. The only exception is that you cannot wait on
1141	condition variables, but non-blocking condvar use is ok. What this means	1226	condition variables, but non-blocking condvar use is ok.
1142	is that you cannot use blocking APIs, but the non-blocking variant should	1227
1143	work.	1228	In practical terms this means is that you cannot use blocking APIs, but
		1229	the non-blocking variant should work.
1144		1230
1145	=cut	1231	=cut
1146		1232
1147	our $VERSION = '5.23';	1233	our $VERSION = '5.23';
1148		1234
…		…
1207		1293
1208	sub DESTROY {	1294	sub DESTROY {
1209	$_[0][1]->stop;	1295	$_[0][1]->stop;
1210	}	1296	}
1211		1297
		1298	# only needed for AnyEvent < 6 compatibility
1212	sub one_event {	1299	sub one_event {
1213	Carp::croak "AnyEvent->one_event blocking wait unsupported in urxvt, use a non-blocking API";	1300	Carp::croak "AnyEvent->one_event blocking wait unsupported in urxvt, use a non-blocking API";
1214	}	1301	}
1215		1302
1216	package urxvt::term;	1303	package urxvt::term;
…		…
1245	$proxy->enable ($name => $ref);	1332	$proxy->enable ($name => $ref);
1246	}	1333	}
1247	}	1334	}
1248	}	1335	}
1249		1336
		1337	sub perl_libdirs {
		1338	map { split /:/ }
		1339	$_[0]->resource ("perl_lib"),
		1340	$ENV{URXVT_PERL_LIB},
		1341	"$ENV{HOME}/.urxvt/ext",
		1342	"$LIBDIR/perl"
		1343	}
		1344
		1345	sub scan_meta {
		1346	my ($self) = @_;
		1347	my @libdirs = perl_libdirs $self;
		1348
		1349	return if $self->{meta_libdirs} eq join "\x00", @libdirs;
		1350
		1351	my %meta;
		1352
		1353	$self->{meta_libdirs} = join "\x00", @libdirs;
		1354	$self->{meta} = \%meta;
		1355
		1356	for my $dir (reverse @libdirs) {
		1357	opendir my $fh, $dir
		1358	or next;
		1359	for my $ext (readdir $fh) {
		1360	$ext ne "."
		1361	and $ext ne ".."
		1362	and open my $fh, "<", "$dir/$ext"
		1363	or next;
		1364
		1365	while (<$fh>) {
		1366	if (/^#:META:X_RESOURCE:(.*)/) {
		1367	my ($pattern, $type, $desc) = split /:/, $1;
		1368	$pattern =~ s/^%(\.\|$)/$ext$1/g; # % in pattern == extension name
		1369	if ($pattern =~ /[^a-zA-Z0-9\-\.]/) {
		1370	warn "$dir/$ext: meta resource '$pattern' contains illegal characters (not alphanumeric nor . nor *)\n";
		1371	} else {
		1372	$meta{resource}{$pattern} = [$ext, $type, $desc];
		1373	}
		1374	} elsif (/^\s*(?:#\|$)/) {
		1375	# skip other comments and empty lines
		1376	} else {
		1377	last; # stop parsing on first non-empty non-comment line
		1378	}
		1379	}
		1380	}
		1381	}
		1382	}
		1383
1250	=item $term = new urxvt::term $envhashref, $rxvtname, [arg...]	1384	=item $term = new urxvt::term $envhashref, $rxvtname, [arg...]
1251		1385
1252	Creates a new terminal, very similar as if you had started it with system	1386	Creates a new terminal, very similar as if you had started it with system
1253	C<$rxvtname, arg...>. C<$envhashref> must be a reference to a C<%ENV>-like	1387	C<$rxvtname, arg...>. C<$envhashref> must be a reference to a C<%ENV>-like
1254	hash which defines the environment of the new terminal.	1388	hash which defines the environment of the new terminal.
…		…
1308	C<%urxvt::OPTION>. Options not enabled in this binary are not in the hash.	1442	C<%urxvt::OPTION>. Options not enabled in this binary are not in the hash.
1309		1443
1310	Here is a likely non-exhaustive list of option names, please see the	1444	Here is a likely non-exhaustive list of option names, please see the
1311	source file F</src/optinc.h> to see the actual list:	1445	source file F</src/optinc.h> to see the actual list:
1312		1446
1313	borderLess console cursorBlink cursorUnderline hold iconic insecure	1447	borderLess buffered console cursorBlink cursorUnderline hold iconic
1314	intensityStyles jumpScroll loginShell mapAlert meta8 mouseWheelScrollPage	1448	insecure intensityStyles iso14755 iso14755_52 jumpScroll loginShell
1315	override-redirect pastableTabs pointerBlank reverseVideo scrollBar	1449	mapAlert meta8 mouseWheelScrollPage override_redirect pastableTabs
1316	scrollBar_floating scrollBar_right scrollTtyKeypress scrollTtyOutput	1450	pointerBlank reverseVideo scrollBar scrollBar_floating scrollBar_right
1317	scrollWithBuffer secondaryScreen secondaryScroll skipBuiltinGlyphs	1451	scrollTtyKeypress scrollTtyOutput scrollWithBuffer secondaryScreen
1318	transparent tripleclickwords utmpInhibit visualBell	1452	secondaryScroll skipBuiltinGlyphs skipScroll transparent tripleclickwords
		1453	urgentOnBell utmpInhibit visualBell
1319		1454
1320	=item $value = $term->resource ($name[, $newval])	1455	=item $value = $term->resource ($name[, $newval])
1321		1456
1322	Returns the current resource value associated with a given name and	1457	Returns the current resource value associated with a given name and
1323	optionally sets a new value. Setting values is most useful in the C<init>	1458	optionally sets a new value. Setting values is most useful in the C<init>
…		…
1370		1505
1371	This method should only be called during the C<on_start> hook, as there is	1506	This method should only be called during the C<on_start> hook, as there is
1372	only one resource database per display, and later invocations might return	1507	only one resource database per display, and later invocations might return
1373	the wrong resources.	1508	the wrong resources.
1374		1509
1375	=item $success = $term->parse_keysym ($keysym_spec, $command_string)	1510	=item $value = $term->x_resource_boolean ($pattern)
1376		1511
		1512	Like C<x_resource>, above, but interprets the string value as a boolean
		1513	and returns C<1> for true values, C<0> for false values and C<undef> if
		1514	the resource or option isn't specified.
		1515
		1516	You should always use this method to parse boolean resources.
		1517
		1518	=cut
		1519
		1520	sub x_resource_boolean {
		1521	my $res = &x_resource;
		1522
		1523	$res =~ /^\s(?:true\|yes\|on\|1)\s$/i ? 1 : defined $res && 0
		1524	}
		1525
		1526	=item $success = $term->parse_keysym ($key, $octets)
		1527
1377	Adds a keymap translation exactly as specified via a resource. See the	1528	Adds a key binding exactly as specified via a resource. See the
1378	C<keysym> resource in the @@RXVT_NAME@@(1) manpage.	1529	C<keysym> resource in the @@RXVT_NAME@@(1) manpage.
		1530
		1531	=item $term->register_command ($keysym, $modifiermask, $string)
		1532
		1533	Adds a key binding. This is a lower level api compared to
		1534	C<parse_keysym>, as it expects a parsed key description, and can be
		1535	used only inside either the C<on_init> hook, to add a binding, or the
		1536	C<on_register_command> hook, to modify a parsed binding.
1379		1537
1380	=item $rend = $term->rstyle ([$new_rstyle])	1538	=item $rend = $term->rstyle ([$new_rstyle])
1381		1539
1382	Return and optionally change the current rendition. Text that is output by	1540	Return and optionally change the current rendition. Text that is output by
1383	the terminal application will use this style.	1541	the terminal application will use this style.
…		…
1596		1754
1597	Adds the specified events to the vt event mask. Useful e.g. when you want	1755	Adds the specified events to the vt event mask. Useful e.g. when you want
1598	to receive pointer events all the times:	1756	to receive pointer events all the times:
1599		1757
1600	$term->vt_emask_add (urxvt::PointerMotionMask);	1758	$term->vt_emask_add (urxvt::PointerMotionMask);
		1759
		1760	=item $term->set_urgency ($set)
		1761
		1762	Enable/disable the urgency hint on the toplevel window.
1601		1763
1602	=item $term->focus_in	1764	=item $term->focus_in
1603		1765
1604	=item $term->focus_out	1766	=item $term->focus_out
1605		1767
…		…
1921	=item $term->XMoveResizeWindow ($window, $x, $y, $width, $height)	2083	=item $term->XMoveResizeWindow ($window, $x, $y, $width, $height)
1922		2084
1923	=item ($x, $y, $child_window) = $term->XTranslateCoordinates ($src, $dst, $x, $y)	2085	=item ($x, $y, $child_window) = $term->XTranslateCoordinates ($src, $dst, $x, $y)
1924		2086
1925	=item $term->XChangeInput ($window, $add_events[, $del_events])	2087	=item $term->XChangeInput ($window, $add_events[, $del_events])
		2088
		2089	=item $keysym = $term->XStringToKeysym ($string)
		2090
		2091	=item $string = $term->XKeysymToString ($keysym)
1926		2092
1927	Various X or X-related functions. The C<$term> object only serves as	2093	Various X or X-related functions. The C<$term> object only serves as
1928	the source of the display, otherwise those functions map more-or-less	2094	the source of the display, otherwise those functions map more-or-less
1929	directly onto the X functions of the same name.	2095	directly onto the X functions of the same name.
1930		2096

Diff Legend

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

Comparing rxvt-unicode/src/urxvt.pm (file contents): Revision 1.194 by sf-exg, Wed Jun 29 21:59:36 2011 UTC vs. Revision 1.215 by root, Thu Jun 7 16:30:58 2012 UTC

Diff Legend

Comparing rxvt-unicode/src/urxvt.pm (file contents):
Revision 1.194 by sf-exg, Wed Jun 29 21:59:36 2011 UTC vs.
Revision 1.215 by root, Thu Jun 7 16:30:58 2012 UTC