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

Comparing rxvt-unicode/src/urxvt.pm (file contents):
Revision 1.182 by sf-exg, Wed Feb 17 08:27:56 2010 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
…		…
370		372
371	URxvt.selection-pastebin.url: http://www.ta-sa.org/files/txt/%	373	URxvt.selection-pastebin.url: http://www.ta-sa.org/files/txt/%
372		374
373	I<Note to xrdb users:> xrdb uses the C preprocessor, which might interpret	375	I<Note to xrdb users:> xrdb uses the C preprocessor, which might interpret
374	the double C</> characters as comment start. Use C<\057\057> instead,	376	the double C</> characters as comment start. Use C<\057\057> instead,
375	which works regardless of wether xrdb is used to parse the resource file	377	which works regardless of whether xrdb is used to parse the resource file
376	or not.	378	or not.
377		379
378	=item macosx-clipboard and macosx-clipboard-native	380	=item macosx-clipboard and macosx-clipboard-native
379		381
380	These two modules implement an extended clipboard for Mac OS X. They are	382	These two modules implement an extended clipboard for Mac OS X. They are
…		…
392	=item example-refresh-hooks	394	=item example-refresh-hooks
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.
		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"
397		412
398	=back	413	=back
399		414
400	=head1 API DOCUMENTATION	415	=head1 API DOCUMENTATION
401		416
…		…
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.
…		…
610	=item on_tt_write $term, $octets	631	=item on_tt_write $term, $octets
611		632
612	Called whenever some data is written to the tty/pty and can be used to	633	Called whenever some data is written to the tty/pty and can be used to
613	suppress or filter tty input.	634	suppress or filter tty input.
614		635
		636	=item on_tt_paste $term, $octets
		637
		638	Called whenever text is about to be pasted, with the text as argument. You
		639	can filter/change and paste the text yourself by returning a true value
		640	and calling C<< $term->tt_paste >> yourself. C<$octets> is
		641	locale-encoded.
		642
615	=item on_line_update $term, $row	643	=item on_line_update $term, $row
616		644
617	Called whenever a line was updated or changed. Can be used to filter	645	Called whenever a line was updated or changed. Can be used to filter
618	screen output (e.g. underline urls or other useless stuff). Only lines	646	screen output (e.g. underline urls or other useless stuff). Only lines
619	that are being shown will be filtered, and, due to performance reasons,	647	that are being shown will be filtered, and, due to performance reasons,
…		…
644	resource in the @@RXVT_NAME@@(1) manpage).	672	resource in the @@RXVT_NAME@@(1) manpage).
645		673
646	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
647	slightly in the future.	675	slightly in the future.
648		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
649	=item on_resize_all_windows $tern, $new_width, $new_height	684	=item on_resize_all_windows $term, $new_width, $new_height
650		685
651	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
652	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
653	returns TRUE, setting of the window hints is being skipped.	688	returns TRUE, setting of the window hints is being skipped.
654		689
…		…
720	=cut	755	=cut
721		756
722	package urxvt;	757	package urxvt;
723		758
724	use utf8;	759	use utf8;
725	use strict;	760	use strict 'vars';
726	use Carp ();	761	use Carp ();
727	use Scalar::Util ();	762	use Scalar::Util ();
728	use List::Util ();	763	use List::Util ();
729		764
730	our $VERSION = 1;	765	our $VERSION = 1;
731	our $TERM;	766	our $TERM;
732	our @TERM_INIT;	767	our @TERM_INIT; # should go, prevents async I/O etc.
733	our @TERM_EXT;	768	our @TERM_EXT; # should go, prevents async I/O etc.
734	our @HOOKNAME;	769	our @HOOKNAME;
735	our %HOOKTYPE = map +($HOOKNAME[$_] => $_), 0..$#HOOKNAME;	770	our %HOOKTYPE = map +($HOOKNAME[$_] => $_), 0..$#HOOKNAME;
736	our %OPTION;	771	our %OPTION;
737		772
738	our $LIBDIR;	773	our $LIBDIR;
…		…
786		821
787	=over 4	822	=over 4
788		823
789	=item urxvt::fatal $errormessage	824	=item urxvt::fatal $errormessage
790		825
791	Fatally aborts execution with the given error message. Avoid at all	826	Fatally aborts execution with the given error message (which should
792	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
793	starts up.	828	is acceptable (and useful) is in the init hook, where it prevents the
		829	terminal from starting up.
794		830
795	=item urxvt::warn $string	831	=item urxvt::warn $string
796		832
797	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
798	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
799	that calls this function.	835	that calls this function.
800		836
801	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
802	correct place, e.g. on stderr of the connecting urxvtc client.	838	correct place, e.g. on stderr of the connecting urxvtc client.
…		…
806	=item @terms = urxvt::termlist	842	=item @terms = urxvt::termlist
807		843
808	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
809	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
810	objects that have perl extensions attached will be returned (because there	846	objects that have perl extensions attached will be returned (because there
811	is no urxvt::term objet associated with others).	847	is no urxvt::term object associated with others).
812		848
813	=item $time = urxvt::NOW	849	=item $time = urxvt::NOW
814		850
815	Returns the "current time" (as per the event loop).	851	Returns the "current time" (as per the event loop).
816		852
…		…
859		895
860	=item $rend = urxvt::OVERLAY_RSTYLE	896	=item $rend = urxvt::OVERLAY_RSTYLE
861		897
862	Return the rendition mask used for overlays by default.	898	Return the rendition mask used for overlays by default.
863		899
864	=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
865		902
866	Return the bit that enabled bold, italic, blink, reverse-video and	903	Return the bit that enabled bold, italic, blink, reverse-video and
867	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
868	the bitset.	905	the bitset.
869		906
…		…
906	};	943	};
907	}	944	}
908		945
909	no warnings 'utf8';	946	no warnings 'utf8';
910		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
911	my $verbosity = $ENV{URXVT_PERL_VERBOSITY};	1007	my $verbosity = $ENV{URXVT_PERL_VERBOSITY};
912		1008
913	sub verbose {	1009	sub verbose {
914	my ($level, $msg) = @_;	1010	my ($level, $msg) = @_;
915	warn "$msg\n" if $level <= $verbosity;	1011	warn "$msg\n" if $level <= $verbosity;
…		…
931		1027
932	open my $fh, "<:raw", $path	1028	open my $fh, "<:raw", $path
933	or die "$path: $!";	1029	or die "$path: $!";
934		1030
935	my $source =	1031	my $source =
936	"package $pkg; use strict; use utf8; no warnings 'utf8';\n"	1032	"package $pkg; use strict 'vars'; use utf8; no warnings 'utf8';\n"
937	. "#line 1 \"$path\"\n{\n"	1033	. "#line 1 \"$path\"\n{\n"
938	. (do { local $/; <$fh> })	1034	. (do { local $/; <$fh> })
939	. "\n};\n1";	1035	. "\n};\n1";
940		1036
941	eval $source	1037	eval $source
…		…
951	sub invoke {	1047	sub invoke {
952	local $TERM = shift;	1048	local $TERM = shift;
953	my $htype = shift;	1049	my $htype = shift;
954		1050
955	if ($htype == 0) { # INIT	1051	if ($htype == 0) { # INIT
956	my @dirs = ((split /:/, $TERM->resource ("perl_lib")), "$LIBDIR/perl");	1052	my @dirs = $TERM->perl_libdirs;
957		1053
958	my %ext_arg;	1054	my %ext_arg;
959		1055
960	{	1056	{
961	my @init = @TERM_INIT;	1057	my @init = @TERM_INIT;
…		…
964	my @pkg = @TERM_EXT;	1060	my @pkg = @TERM_EXT;
965	@TERM_EXT = ();	1061	@TERM_EXT = ();
966	$TERM->register_package ($_) for @pkg;	1062	$TERM->register_package ($_) for @pkg;
967	}	1063	}
968		1064
		1065	for (
		1066	@{ delete $TERM->{perl_ext_3} },
969	for (grep $_, map { split /,/, $TERM->resource ("perl_ext_$_") } 1, 2) {	1067	grep $_, map { split /,/, $TERM->resource ("perl_ext_$_") } 1, 2
		1068	) {
970	if ($_ eq "default") {	1069	if ($_ eq "default") {
971	$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);
972	} elsif (/^-(.*)$/) {	1071	} elsif (/^-(.*)$/) {
973	delete $ext_arg{$1};	1072	delete $ext_arg{$1};
974	} elsif (/^([^<]+)<(.*)>$/) {	1073	} elsif (/^([^<]+)<(.*)>$/) {
…		…
1122	=head2 The C<urxvt::anyevent> Class	1221	=head2 The C<urxvt::anyevent> Class
1123		1222
1124	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
1125	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
1126	further programming. The only exception is that you cannot wait on	1225	further programming. The only exception is that you cannot wait on
1127	condition variables, but non-blocking condvar use is ok. What this means	1226	condition variables, but non-blocking condvar use is ok.
1128	is that you cannot use blocking APIs, but the non-blocking variant should	1227
1129	work.	1228	In practical terms this means is that you cannot use blocking APIs, but
		1229	the non-blocking variant should work.
1130		1230
1131	=cut	1231	=cut
1132		1232
1133	our $VERSION = '5.23';	1233	our $VERSION = '5.23';
1134		1234
…		…
1193		1293
1194	sub DESTROY {	1294	sub DESTROY {
1195	$_[0][1]->stop;	1295	$_[0][1]->stop;
1196	}	1296	}
1197		1297
		1298	# only needed for AnyEvent < 6 compatibility
1198	sub one_event {	1299	sub one_event {
1199	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";
1200	}	1301	}
1201		1302
1202	package urxvt::term;	1303	package urxvt::term;
…		…
1231	$proxy->enable ($name => $ref);	1332	$proxy->enable ($name => $ref);
1232	}	1333	}
1233	}	1334	}
1234	}	1335	}
1235		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
1236	=item $term = new urxvt::term $envhashref, $rxvtname, [arg...]	1384	=item $term = new urxvt::term $envhashref, $rxvtname, [arg...]
1237		1385
1238	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
1239	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
1240	hash which defines the environment of the new terminal.	1388	hash which defines the environment of the new terminal.
…		…
1294	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.
1295		1443
1296	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
1297	source file F</src/optinc.h> to see the actual list:	1445	source file F</src/optinc.h> to see the actual list:
1298		1446
1299	borderLess console cursorBlink cursorUnderline hold iconic insecure	1447	borderLess buffered console cursorBlink cursorUnderline hold iconic
1300	intensityStyles jumpScroll loginShell mapAlert meta8 mouseWheelScrollPage	1448	insecure intensityStyles iso14755 iso14755_52 jumpScroll loginShell
1301	override-redirect pastableTabs pointerBlank reverseVideo scrollBar	1449	mapAlert meta8 mouseWheelScrollPage override_redirect pastableTabs
1302	scrollBar_floating scrollBar_right scrollTtyKeypress scrollTtyOutput	1450	pointerBlank reverseVideo scrollBar scrollBar_floating scrollBar_right
1303	scrollWithBuffer secondaryScreen secondaryScroll skipBuiltinGlyphs	1451	scrollTtyKeypress scrollTtyOutput scrollWithBuffer secondaryScreen
1304	transparent tripleclickwords utmpInhibit visualBell	1452	secondaryScroll skipBuiltinGlyphs skipScroll transparent tripleclickwords
		1453	urgentOnBell utmpInhibit visualBell
1305		1454
1306	=item $value = $term->resource ($name[, $newval])	1455	=item $value = $term->resource ($name[, $newval])
1307		1456
1308	Returns the current resource value associated with a given name and	1457	Returns the current resource value associated with a given name and
1309	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>
…		…
1322		1471
1323	Here is a likely non-exhaustive list of resource names, not all of which	1472	Here is a likely non-exhaustive list of resource names, not all of which
1324	are supported in every build, please see the source file F</src/rsinc.h>	1473	are supported in every build, please see the source file F</src/rsinc.h>
1325	to see the actual list:	1474	to see the actual list:
1326		1475
1327	answerbackstring backgroundPixmap backspace_key boldFont boldItalicFont	1476	answerbackstring backgroundPixmap backspace_key blendtype blurradius
1328	borderLess chdir color cursorBlink cursorUnderline cutchars delete_key	1477	boldFont boldItalicFont borderLess buffered chdir color cursorBlink
1329	display_name embed ext_bwidth fade font geometry hold iconName	1478	cursorUnderline cutchars delete_key depth display_name embed ext_bwidth
1330	imFont imLocale inputMethod insecure int_bwidth intensityStyles	1479	fade font geometry hold iconName iconfile imFont imLocale inputMethod
1331	italicFont jumpScroll lineSpace letterSpace loginShell mapAlert meta8	1480	insecure int_bwidth intensityStyles iso14755 iso14755_52 italicFont
		1481	jumpScroll letterSpace lineSpace loginShell mapAlert meta8 modifier
1332	modifier mouseWheelScrollPage name override_redirect pastableTabs path	1482	mouseWheelScrollPage name override_redirect pastableTabs path perl_eval
1333	perl_eval perl_ext_1 perl_ext_2 perl_lib pointerBlank pointerBlankDelay	1483	perl_ext_1 perl_ext_2 perl_lib pointerBlank pointerBlankDelay
1334	preeditType print_pipe pty_fd reverseVideo saveLines scrollBar	1484	preeditType print_pipe pty_fd reverseVideo saveLines scrollBar
1335	scrollBar_align scrollBar_floating scrollBar_right scrollBar_thickness	1485	scrollBar_align scrollBar_floating scrollBar_right scrollBar_thickness
1336	scrollTtyKeypress scrollTtyOutput scrollWithBuffer scrollstyle	1486	scrollTtyKeypress scrollTtyOutput scrollWithBuffer scrollstyle
1337	secondaryScreen secondaryScroll shade term_name title	1487	secondaryScreen secondaryScroll shade skipBuiltinGlyphs skipScroll
1338	transient_for transparent transparent_all tripleclickwords utmpInhibit	1488	term_name title transient_for transparent tripleclickwords urgentOnBell
1339	visualBell	1489	utmpInhibit visualBell
1340		1490
1341	=cut	1491	=cut
1342		1492
1343	sub resource($$;$) {	1493	sub resource($$;$) {
1344	my ($self, $name) = (shift, shift);	1494	my ($self, $name) = (shift, shift);
…		…
1355		1505
1356	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
1357	only one resource database per display, and later invocations might return	1507	only one resource database per display, and later invocations might return
1358	the wrong resources.	1508	the wrong resources.
1359		1509
1360	=item $success = $term->parse_keysym ($keysym_spec, $command_string)	1510	=item $value = $term->x_resource_boolean ($pattern)
1361		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
1362	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
1363	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.
1364		1537
1365	=item $rend = $term->rstyle ([$new_rstyle])	1538	=item $rend = $term->rstyle ([$new_rstyle])
1366		1539
1367	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
1368	the terminal application will use this style.	1541	the terminal application will use this style.
…		…
1390		1563
1391	=item $term->selection_make ($eventtime[, $rectangular])	1564	=item $term->selection_make ($eventtime[, $rectangular])
1392		1565
1393	Tries to make a selection as set by C<selection_beg> and	1566	Tries to make a selection as set by C<selection_beg> and
1394	C<selection_end>. If C<$rectangular> is true (default: false), a	1567	C<selection_end>. If C<$rectangular> is true (default: false), a
1395	rectangular selection will be made. This is the prefered function to make	1568	rectangular selection will be made. This is the preferred function to make
1396	a selection.	1569	a selection.
1397		1570
1398	=item $success = $term->selection_grab ($eventtime)	1571	=item $success = $term->selection_grab ($eventtime[, $clipboard])
1399		1572
1400	Try to request the primary selection text from the server (for example, as	1573	Try to acquire ownership of the primary (clipboard if C<$clipboard> is
		1574	true) selection from the server. The corresponding text can be set
1401	set by the next method). No visual feedback will be given. This function	1575	with the next method. No visual feedback will be given. This function
1402	is mostly useful from within C<on_sel_grab> hooks.	1576	is mostly useful from within C<on_sel_grab> hooks.
1403		1577
1404	=item $oldtext = $term->selection ([$newtext])	1578	=item $oldtext = $term->selection ([$newtext, $clipboard])
1405		1579
1406	Return the current selection text and optionally replace it by C<$newtext>.	1580	Return the current selection (clipboard if C<$clipboard> is true) text
		1581	and optionally replace it by C<$newtext>.
		1582
		1583	=item $term->selection_clear ([$clipboard])
		1584
		1585	Revoke ownership of the primary (clipboard if C<$clipboard> is true) selection.
1407		1586
1408	=item $term->overlay_simple ($x, $y, $text)	1587	=item $term->overlay_simple ($x, $y, $text)
1409		1588
1410	Create a simple multi-line overlay box. See the next method for details.	1589	Create a simple multi-line overlay box. See the next method for details.
1411		1590
…		…
1539	locale-specific encoding of the terminal and can contain command sequences	1718	locale-specific encoding of the terminal and can contain command sequences
1540	(escape codes) that will be interpreted.	1719	(escape codes) that will be interpreted.
1541		1720
1542	=item $term->tt_write ($octets)	1721	=item $term->tt_write ($octets)
1543		1722
1544	Write the octets given in C<$data> to the tty (i.e. as program input). To	1723	Write the octets given in C<$octets> to the tty (i.e. as program input). To
1545	pass characters instead of octets, you should convert your strings first	1724	pass characters instead of octets, you should convert your strings first
1546	to the locale-specific encoding using C<< $term->locale_encode >>.	1725	to the locale-specific encoding using C<< $term->locale_encode >>.
		1726
		1727	=item $term->tt_paste ($octets)
		1728
		1729	Write the octets given in C<$octets> to the tty as a paste, converting NL to
		1730	CR and bracketing the data with control sequences if bracketed paste mode
		1731	is set.
1547		1732
1548	=item $old_events = $term->pty_ev_events ([$new_events])	1733	=item $old_events = $term->pty_ev_events ([$new_events])
1549		1734
1550	Replaces the event mask of the pty watcher by the given event mask. Can	1735	Replaces the event mask of the pty watcher by the given event mask. Can
1551	be used to suppress input and output handling to the pty/tty. See the	1736	be used to suppress input and output handling to the pty/tty. See the
…		…
1569		1754
1570	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
1571	to receive pointer events all the times:	1756	to receive pointer events all the times:
1572		1757
1573	$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.
1574		1763
1575	=item $term->focus_in	1764	=item $term->focus_in
1576		1765
1577	=item $term->focus_out	1766	=item $term->focus_out
1578		1767
…		…
1894	=item $term->XMoveResizeWindow ($window, $x, $y, $width, $height)	2083	=item $term->XMoveResizeWindow ($window, $x, $y, $width, $height)
1895		2084
1896	=item ($x, $y, $child_window) = $term->XTranslateCoordinates ($src, $dst, $x, $y)	2085	=item ($x, $y, $child_window) = $term->XTranslateCoordinates ($src, $dst, $x, $y)
1897		2086
1898	=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)
1899		2092
1900	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
1901	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
1902	directly onto the X functions of the same name.	2095	directly onto the X functions of the same name.
1903		2096
…		…
2225		2418
2226	=back	2419	=back
2227		2420
2228	=head1 AUTHOR	2421	=head1 AUTHOR
2229		2422
2230	Marc Lehmann <pcg@goof.com>	2423	Marc Lehmann <schmorp@schmorp.de>
2231	http://software.schmorp.de/pkg/rxvt-unicode	2424	http://software.schmorp.de/pkg/rxvt-unicode
2232		2425
2233	=cut	2426	=cut
2234		2427
2235	1	2428	1

Diff Legend

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

Comparing rxvt-unicode/src/urxvt.pm (file contents): Revision 1.182 by sf-exg, Wed Feb 17 08:27:56 2010 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.182 by sf-exg, Wed Feb 17 08:27:56 2010 UTC vs.
Revision 1.215 by root, Thu Jun 7 16:30:58 2012 UTC