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

Comparing rxvt-unicode/src/urxvt.pm (file contents):
Revision 1.187 by sf-exg, Sat Jul 24 10:20:26 2010 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
…		…
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
…		…
393		395
394	Displays a very simple digital clock in the upper right corner of the	396	Displays a very simple digital clock in the upper right corner of the
395	window. Illustrates overwriting the refresh callbacks to create your own	397	window. Illustrates overwriting the refresh callbacks to create your own
396	overlays or changes.	398	overlays or changes.
397		399
		400	=item confirm-paste
		401
		402	Displays a confirmation dialog when a paste containing at least a full
		403	line is detected.
		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
398	=back	413	=back
399		414
400	=head1 API DOCUMENTATION	415	=head1 API DOCUMENTATION
401		416
402	=head2 General API Considerations	417	=head2 General API Considerations
…		…
431	=item $octets	446	=item $octets
432		447
433	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
434	locale-specific way.	449	locale-specific way.
435		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>.
		456
436	=back	457	=back
437		458
438	=head2 Extension Objects	459	=head2 Extension Objects
439		460
440	Every perl extension is a perl class. A separate perl object is created	461	Every perl extension is a perl class. A separate perl object is created
441	for each terminal, and each terminal has its own set of extenion objects,	462	for each terminal, and each terminal has its own set of extension objects,
442	which are passed as the first parameter to hooks. So extensions can use	463	which are passed as the first parameter to hooks. So extensions can use
443	their C<$self> object without having to think about clashes with other	464	their C<$self> object without having to think about clashes with other
444	extensions or other terminals, with the exception of methods and members	465	extensions or other terminals, with the exception of methods and members
445	that begin with an underscore character C<_>: these are reserved for	466	that begin with an underscore character C<_>: these are reserved for
446	internal use.	467	internal use.
…		…
651	resource in the @@RXVT_NAME@@(1) manpage).	672	resource in the @@RXVT_NAME@@(1) manpage).
652		673
653	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
654	slightly in the future.	675	slightly in the future.
655		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
656	=item on_resize_all_windows $term, $new_width, $new_height	684	=item on_resize_all_windows $term, $new_width, $new_height
657		685
658	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
659	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
660	returns TRUE, setting of the window hints is being skipped.	688	returns TRUE, setting of the window hints is being skipped.
…		…
727	=cut	755	=cut
728		756
729	package urxvt;	757	package urxvt;
730		758
731	use utf8;	759	use utf8;
732	use strict;	760	use strict 'vars';
733	use Carp ();	761	use Carp ();
734	use Scalar::Util ();	762	use Scalar::Util ();
735	use List::Util ();	763	use List::Util ();
736		764
737	our $VERSION = 1;	765	our $VERSION = 1;
738	our $TERM;	766	our $TERM;
739	our @TERM_INIT;	767	our @TERM_INIT; # should go, prevents async I/O etc.
740	our @TERM_EXT;	768	our @TERM_EXT; # should go, prevents async I/O etc.
741	our @HOOKNAME;	769	our @HOOKNAME;
742	our %HOOKTYPE = map +($HOOKNAME[$_] => $_), 0..$#HOOKNAME;	770	our %HOOKTYPE = map +($HOOKNAME[$_] => $_), 0..$#HOOKNAME;
743	our %OPTION;	771	our %OPTION;
744		772
745	our $LIBDIR;	773	our $LIBDIR;
…		…
793		821
794	=over 4	822	=over 4
795		823
796	=item urxvt::fatal $errormessage	824	=item urxvt::fatal $errormessage
797		825
798	Fatally aborts execution with the given error message. Avoid at all	826	Fatally aborts execution with the given error message (which should
799	costs! The only time this is acceptable is when the terminal process	827	include a trailing newline). Avoid at all costs! The only time this
800	starts up.	828	is acceptable (and useful) is in the init hook, where it prevents the
		829	terminal from starting up.
801		830
802	=item urxvt::warn $string	831	=item urxvt::warn $string
803		832
804	Calls C<rxvt_warn> with the given string which should not include a	833	Calls C<rxvt_warn> with the given string which should include a trailing
805	newline. The module also overwrites the C<warn> builtin with a function	834	newline. The module also overwrites the C<warn> builtin with a function
806	that calls this function.	835	that calls this function.
807		836
808	Using this function has the advantage that its output ends up in the	837	Using this function has the advantage that its output ends up in the
809	correct place, e.g. on stderr of the connecting urxvtc client.	838	correct place, e.g. on stderr of the connecting urxvtc client.
…		…
813	=item @terms = urxvt::termlist	842	=item @terms = urxvt::termlist
814		843
815	Returns all urxvt::term objects that exist in this process, regardless of	844	Returns all urxvt::term objects that exist in this process, regardless of
816	whether they are started, being destroyed etc., so be careful. Only term	845	whether they are started, being destroyed etc., so be careful. Only term
817	objects that have perl extensions attached will be returned (because there	846	objects that have perl extensions attached will be returned (because there
818	is no urxvt::term objet associated with others).	847	is no urxvt::term object associated with others).
819		848
820	=item $time = urxvt::NOW	849	=item $time = urxvt::NOW
821		850
822	Returns the "current time" (as per the event loop).	851	Returns the "current time" (as per the event loop).
823		852
…		…
866		895
867	=item $rend = urxvt::OVERLAY_RSTYLE	896	=item $rend = urxvt::OVERLAY_RSTYLE
868		897
869	Return the rendition mask used for overlays by default.	898	Return the rendition mask used for overlays by default.
870		899
871	=item $rendbit = urxvt::RS_Bold, RS_Italic, RS_Blink, RS_RVid, RS_Uline	900	=item $rendbit = urxvt::RS_Bold, urxvt::RS_Italic, urxvt::RS_Blink,
		901	urxvt::RS_RVid, urxvt::RS_Uline
872		902
873	Return the bit that enabled bold, italic, blink, reverse-video and	903	Return the bit that enabled bold, italic, blink, reverse-video and
874	underline, respectively. To enable such a style, just logically OR it into	904	underline, respectively. To enable such a style, just logically OR it into
875	the bitset.	905	the bitset.
876		906
…		…
913	};	943	};
914	}	944	}
915		945
916	no warnings 'utf8';	946	no warnings 'utf8';
917		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
918	my $verbosity = $ENV{URXVT_PERL_VERBOSITY};	1008	my $verbosity = $ENV{URXVT_PERL_VERBOSITY};
919		1009
920	sub verbose {	1010	sub verbose {
921	my ($level, $msg) = @_;	1011	my ($level, $msg) = @_;
922	warn "$msg\n" if $level <= $verbosity;	1012	warn "$msg\n" if $level <= $verbosity;
…		…
934	$pkg =~ s/[^[:word:]]/_/g;	1024	$pkg =~ s/[^[:word:]]/_/g;
935	$pkg = "urxvt::ext::$pkg";	1025	$pkg = "urxvt::ext::$pkg";
936		1026
937	verbose 3, "loading extension '$path' into package '$pkg'";	1027	verbose 3, "loading extension '$path' into package '$pkg'";
938		1028
		1029	(${"$pkg\::_NAME"} = $path) =~ s/^.*[\\\/]//; # hackish
		1030
939	open my $fh, "<:raw", $path	1031	open my $fh, "<:raw", $path
940	or die "$path: $!";	1032	or die "$path: $!";
941		1033
942	my $source =	1034	my $source =
943	"package $pkg; use strict; use utf8; no warnings 'utf8';\n"	1035	"package $pkg; use strict 'vars'; use utf8; no warnings 'utf8';\n"
944	. "#line 1 \"$path\"\n{\n"	1036	. "#line 1 \"$path\"\n{\n"
945	. (do { local $/; <$fh> })	1037	. (do { local $/; <$fh> })
946	. "\n};\n1";	1038	. "\n};\n1";
947		1039
948	eval $source	1040	eval $source
…		…
958	sub invoke {	1050	sub invoke {
959	local $TERM = shift;	1051	local $TERM = shift;
960	my $htype = shift;	1052	my $htype = shift;
961		1053
962	if ($htype == 0) { # INIT	1054	if ($htype == 0) { # INIT
963	my @dirs = ((split /:/, $TERM->resource ("perl_lib")), "$LIBDIR/perl");	1055	my @dirs = $TERM->perl_libdirs;
964		1056
965	my %ext_arg;	1057	my %ext_arg;
966		1058
967	{	1059	{
968	my @init = @TERM_INIT;	1060	my @init = @TERM_INIT;
…		…
971	my @pkg = @TERM_EXT;	1063	my @pkg = @TERM_EXT;
972	@TERM_EXT = ();	1064	@TERM_EXT = ();
973	$TERM->register_package ($_) for @pkg;	1065	$TERM->register_package ($_) for @pkg;
974	}	1066	}
975		1067
		1068	for (
		1069	@{ delete $TERM->{perl_ext_3} },
976	for (grep $_, map { split /,/, $TERM->resource ("perl_ext_$_") } 1, 2) {	1070	grep $_, map { split /,/, $TERM->resource ("perl_ext_$_") } 1, 2
		1071	) {
977	if ($_ eq "default") {	1072	if ($_ eq "default") {
978	$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);
979	} elsif (/^-(.*)$/) {	1074	} elsif (/^-(.*)$/) {
980	delete $ext_arg{$1};	1075	delete $ext_arg{$1};
981	} elsif (/^([^<]+)<(.*)>$/) {	1076	} elsif (/^([^<]+)<(.*)>$/) {
…		…
1057	}	1152	}
1058	}	1153	}
1059	($mask, @color{qw(fg bg)}, \@failed)	1154	($mask, @color{qw(fg bg)}, \@failed)
1060	}	1155	}
1061		1156
1062	# urxvt::term::extension
1063
1064	package urxvt::term::extension;	1157	package urxvt::term::extension;
1065		1158
1066	sub enable {	1159	sub enable {
1067	my ($self, %hook) = @_;	1160	my ($self, %hook) = @_;
1068	my $pkg = $self->{_pkg};	1161	my $pkg = $self->{_pkg};
…		…
1122		1215
1123	sub urxvt::destroy_hook(&) {	1216	sub urxvt::destroy_hook(&) {
1124	bless \shift, urxvt::destroy_hook::	1217	bless \shift, urxvt::destroy_hook::
1125	}	1218	}
1126		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
1127	package urxvt::anyevent;	1232	package urxvt::anyevent;
1128		1233
1129	=head2 The C<urxvt::anyevent> Class	1234	=head2 The C<urxvt::anyevent> Class
1130		1235
1131	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
1132	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
1133	further programming. The only exception is that you cannot wait on	1238	further programming. The only exception is that you cannot wait on
1134	condition variables, but non-blocking condvar use is ok. What this means	1239	condition variables, but non-blocking condvar use is ok.
1135	is that you cannot use blocking APIs, but the non-blocking variant should	1240
1136	work.	1241	In practical terms this means is that you cannot use blocking APIs, but
		1242	the non-blocking variant should work.
1137		1243
1138	=cut	1244	=cut
1139		1245
1140	our $VERSION = '5.23';	1246	our $VERSION = '5.23';
1141		1247
…		…
1200		1306
1201	sub DESTROY {	1307	sub DESTROY {
1202	$_[0][1]->stop;	1308	$_[0][1]->stop;
1203	}	1309	}
1204		1310
		1311	# only needed for AnyEvent < 6 compatibility
1205	sub one_event {	1312	sub one_event {
1206	Carp::croak "AnyEvent->one_event blocking wait unsupported in urxvt, use a non-blocking API";	1313	Carp::croak "AnyEvent->one_event blocking wait unsupported in urxvt, use a non-blocking API";
1207	}	1314	}
1208		1315
1209	package urxvt::term;	1316	package urxvt::term;
…		…
1224	urxvt::verbose 6, "register package $pkg to $self";	1331	urxvt::verbose 6, "register package $pkg to $self";
1225		1332
1226	@{"$pkg\::ISA"} = urxvt::term::extension::;	1333	@{"$pkg\::ISA"} = urxvt::term::extension::;
1227		1334
1228	my $proxy = bless {	1335	my $proxy = bless {
1229	_pkg => $pkg,	1336	_pkg => $pkg,
		1337	_name => ${"$pkg\::_NAME"}, # hackish
1230	argv => $argv,	1338	argv => $argv,
1231	}, $pkg;	1339	}, $pkg;
1232	Scalar::Util::weaken ($proxy->{term} = $self);	1340	Scalar::Util::weaken ($proxy->{term} = $self);
1233		1341
1234	$self->{_pkg}{$pkg} = $proxy;	1342	$self->{_pkg}{$pkg} = $proxy;
1235		1343
…		…
1238	$proxy->enable ($name => $ref);	1346	$proxy->enable ($name => $ref);
1239	}	1347	}
1240	}	1348	}
1241	}	1349	}
1242		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	}
		1394	}
		1395	}
		1396	}
		1397
1243	=item $term = new urxvt::term $envhashref, $rxvtname, [arg...]	1398	=item $term = new urxvt::term $envhashref, $rxvtname, [arg...]
1244		1399
1245	Creates a new terminal, very similar as if you had started it with system	1400	Creates a new terminal, very similar as if you had started it with system
1246	C<$rxvtname, arg...>. C<$envhashref> must be a reference to a C<%ENV>-like	1401	C<$rxvtname, arg...>. C<$envhashref> must be a reference to a C<%ENV>-like
1247	hash which defines the environment of the new terminal.	1402	hash which defines the environment of the new terminal.
…		…
1301	C<%urxvt::OPTION>. Options not enabled in this binary are not in the hash.	1456	C<%urxvt::OPTION>. Options not enabled in this binary are not in the hash.
1302		1457
1303	Here is a likely non-exhaustive list of option names, please see the	1458	Here is a likely non-exhaustive list of option names, please see the
1304	source file F</src/optinc.h> to see the actual list:	1459	source file F</src/optinc.h> to see the actual list:
1305		1460
1306	borderLess console cursorBlink cursorUnderline hold iconic insecure	1461	borderLess buffered console cursorBlink cursorUnderline hold iconic
1307	intensityStyles jumpScroll loginShell mapAlert meta8 mouseWheelScrollPage	1462	insecure intensityStyles iso14755 iso14755_52 jumpScroll loginShell
1308	override-redirect pastableTabs pointerBlank reverseVideo scrollBar	1463	mapAlert meta8 mouseWheelScrollPage override_redirect pastableTabs
1309	scrollBar_floating scrollBar_right scrollTtyKeypress scrollTtyOutput	1464	pointerBlank reverseVideo scrollBar scrollBar_floating scrollBar_right
1310	scrollWithBuffer secondaryScreen secondaryScroll skipBuiltinGlyphs	1465	scrollTtyKeypress scrollTtyOutput scrollWithBuffer secondaryScreen
1311	transparent tripleclickwords utmpInhibit visualBell	1466	secondaryScroll skipBuiltinGlyphs skipScroll transparent tripleclickwords
		1467	urgentOnBell utmpInhibit visualBell
1312		1468
1313	=item $value = $term->resource ($name[, $newval])	1469	=item $value = $term->resource ($name[, $newval])
1314		1470
1315	Returns the current resource value associated with a given name and	1471	Returns the current resource value associated with a given name and
1316	optionally sets a new value. Setting values is most useful in the C<init>	1472	optionally sets a new value. Setting values is most useful in the C<init>
…		…
1329		1485
1330	Here is a likely non-exhaustive list of resource names, not all of which	1486	Here is a likely non-exhaustive list of resource names, not all of which
1331	are supported in every build, please see the source file F</src/rsinc.h>	1487	are supported in every build, please see the source file F</src/rsinc.h>
1332	to see the actual list:	1488	to see the actual list:
1333		1489
1334	answerbackstring backgroundPixmap backspace_key boldFont boldItalicFont	1490	answerbackstring backgroundPixmap backspace_key blendtype blurradius
1335	borderLess chdir color cursorBlink cursorUnderline cutchars delete_key	1491	boldFont boldItalicFont borderLess buffered chdir color cursorBlink
1336	display_name embed ext_bwidth fade font geometry hold iconName	1492	cursorUnderline cutchars delete_key depth display_name embed ext_bwidth
1337	imFont imLocale inputMethod insecure int_bwidth intensityStyles	1493	fade font geometry hold iconName iconfile imFont imLocale inputMethod
1338	italicFont jumpScroll lineSpace letterSpace loginShell mapAlert meta8	1494	insecure int_bwidth intensityStyles iso14755 iso14755_52 italicFont
		1495	jumpScroll letterSpace lineSpace loginShell mapAlert meta8 modifier
1339	modifier mouseWheelScrollPage name override_redirect pastableTabs path	1496	mouseWheelScrollPage name override_redirect pastableTabs path perl_eval
1340	perl_eval perl_ext_1 perl_ext_2 perl_lib pointerBlank pointerBlankDelay	1497	perl_ext_1 perl_ext_2 perl_lib pointerBlank pointerBlankDelay
1341	preeditType print_pipe pty_fd reverseVideo saveLines scrollBar	1498	preeditType print_pipe pty_fd reverseVideo saveLines scrollBar
1342	scrollBar_align scrollBar_floating scrollBar_right scrollBar_thickness	1499	scrollBar_align scrollBar_floating scrollBar_right scrollBar_thickness
1343	scrollTtyKeypress scrollTtyOutput scrollWithBuffer scrollstyle	1500	scrollTtyKeypress scrollTtyOutput scrollWithBuffer scrollstyle
1344	secondaryScreen secondaryScroll shade term_name title	1501	secondaryScreen secondaryScroll shade skipBuiltinGlyphs skipScroll
1345	transient_for transparent transparent_all tripleclickwords utmpInhibit	1502	term_name title transient_for transparent tripleclickwords urgentOnBell
1346	visualBell	1503	utmpInhibit visualBell
1347		1504
1348	=cut	1505	=cut
1349		1506
1350	sub resource($$;$) {	1507	sub resource($$;$) {
1351	my ($self, $name) = (shift, shift);	1508	my ($self, $name) = (shift, shift);
…		…
1358	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
1359	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
1360	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
1361	resource with that pattern exists.	1518	resource with that pattern exists.
1362		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
1363	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
1364	only one resource database per display, and later invocations might return	1531	only one resource database per display, and later invocations might return
1365	the wrong resources.	1532	the wrong resources.
1366		1533
1367	=item $success = $term->parse_keysym ($keysym_spec, $command_string)	1534	=item $value = $term->x_resource_boolean ($pattern)
1368		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
1369	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
1370	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.
1371		1561
1372	=item $rend = $term->rstyle ([$new_rstyle])	1562	=item $rend = $term->rstyle ([$new_rstyle])
1373		1563
1374	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
1375	the terminal application will use this style.	1565	the terminal application will use this style.
…		…
1588		1778
1589	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
1590	to receive pointer events all the times:	1780	to receive pointer events all the times:
1591		1781
1592	$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.
1593		1787
1594	=item $term->focus_in	1788	=item $term->focus_in
1595		1789
1596	=item $term->focus_out	1790	=item $term->focus_out
1597		1791
…		…
1913	=item $term->XMoveResizeWindow ($window, $x, $y, $width, $height)	2107	=item $term->XMoveResizeWindow ($window, $x, $y, $width, $height)
1914		2108
1915	=item ($x, $y, $child_window) = $term->XTranslateCoordinates ($src, $dst, $x, $y)	2109	=item ($x, $y, $child_window) = $term->XTranslateCoordinates ($src, $dst, $x, $y)
1916		2110
1917	=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)
1918		2116
1919	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
1920	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
1921	directly onto the X functions of the same name.	2119	directly onto the X functions of the same name.
1922		2120
…		…
2244		2442
2245	=back	2443	=back
2246		2444
2247	=head1 AUTHOR	2445	=head1 AUTHOR
2248		2446
2249	Marc Lehmann <pcg@goof.com>	2447	Marc Lehmann <schmorp@schmorp.de>
2250	http://software.schmorp.de/pkg/rxvt-unicode	2448	http://software.schmorp.de/pkg/rxvt-unicode
2251		2449
2252	=cut	2450	=cut
2253		2451
2254	1	2452	1

Diff Legend

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

Comparing rxvt-unicode/src/urxvt.pm (file contents): Revision 1.187 by sf-exg, Sat Jul 24 10:20:26 2010 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.187 by sf-exg, Sat Jul 24 10:20:26 2010 UTC vs.
Revision 1.217 by root, Sun Jun 10 13:58:05 2012 UTC