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

Comparing rxvt-unicode/src/urxvt.pm (file contents):
Revision 1.173 by root, Wed Nov 5 12:45:36 2008 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
…		…
341	URxvt.remote-selection.store: rsh ruth 'cat >/tmp/distributed-selection'	343	URxvt.remote-selection.store: rsh ruth 'cat >/tmp/distributed-selection'
342	URxvt.remote-selection.fetch: rsh ruth 'cat /tmp/distributed-selection'	344	URxvt.remote-selection.fetch: rsh ruth 'cat /tmp/distributed-selection'
343		345
344	=item selection-pastebin	346	=item selection-pastebin
345		347
346	This is a little rarely useful extension that Uploads the selection as	348	This is a little rarely useful extension that uploads the selection as
347	textfile to a remote site (or does other things). (The implementation is	349	textfile to a remote site (or does other things). (The implementation is
348	not currently secure for use in a multiuser environment as it writes to	350	not currently secure for use in a multiuser environment as it writes to
349	F</tmp> directly.).	351	F</tmp> directly.).
350		352
351	It listens to the C<selection-pastebin:remote-pastebin> keyboard command,	353	It listens to the C<selection-pastebin:remote-pastebin> keyboard command,
…		…
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.
		379
		380	=item macosx-clipboard and macosx-clipboard-native
		381
		382	These two modules implement an extended clipboard for Mac OS X. They are
		383	used like this:
		384
		385	URxvt.perl-ext-common: default,macosx-clipboard
		386	URxvt.keysym.M-c: perl:macosx-clipboard:copy
		387	URxvt.keysym.M-v: perl:macosx-clipboard:paste
		388
		389	The difference between them is that the native variant requires a
		390	perl from apple's devkit or so, and C<macosx-clipboard> requires the
		391	C<Mac::Pasteboard> module, works with other perls, has fewer bugs, is
		392	simpler etc. etc.
377		393
378	=item example-refresh-hooks	394	=item example-refresh-hooks
379		395
380	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
381	window. Illustrates overwriting the refresh callbacks to create your own	397	window. Illustrates overwriting the refresh callbacks to create your own
382	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"
383		412
384	=back	413	=back
385		414
386	=head1 API DOCUMENTATION	415	=head1 API DOCUMENTATION
387		416
…		…
403		432
404	=over 4	433	=over 4
405		434
406	=item $text	435	=item $text
407		436
408	Rxvt-unicodes special way of encoding text, where one "unicode" character	437	Rxvt-unicode's special way of encoding text, where one "unicode" character
409	always represents one screen cell. See L<ROW_t> for a discussion of this format.	438	always represents one screen cell. See L<ROW_t> for a discussion of this format.
410		439
411	=item $string	440	=item $string
412		441
413	A perl text string, with an emphasis on I<text>. It can store all unicode	442	A perl text string, with an emphasis on I<text>. It can store all unicode
…		…
417	=item $octets	446	=item $octets
418		447
419	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
420	locale-specific way.	449	locale-specific way.
421		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
422	=back	457	=back
423		458
424	=head2 Extension Objects	459	=head2 Extension Objects
425		460
426	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
427	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,
428	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
429	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
430	extensions or other terminals, with the exception of methods and members	465	extensions or other terminals, with the exception of methods and members
431	that begin with an underscore character C<_>: these are reserved for	466	that begin with an underscore character C<_>: these are reserved for
432	internal use.	467	internal use.
…		…
596	=item on_tt_write $term, $octets	631	=item on_tt_write $term, $octets
597		632
598	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
599	suppress or filter tty input.	634	suppress or filter tty input.
600		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
601	=item on_line_update $term, $row	643	=item on_line_update $term, $row
602		644
603	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
604	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
605	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,
…		…
630	resource in the @@RXVT_NAME@@(1) manpage).	672	resource in the @@RXVT_NAME@@(1) manpage).
631		673
632	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
633	slightly in the future.	675	slightly in the future.
634		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
635	=item on_resize_all_windows $tern, $new_width, $new_height	684	=item on_resize_all_windows $term, $new_width, $new_height
636		685
637	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
638	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
639	returns TRUE, setting of the window hints is being skipped.	688	returns TRUE, setting of the window hints is being skipped.
640		689
…		…
674		723
675	=item on_map_notify $term, $event	724	=item on_map_notify $term, $event
676		725
677	=item on_unmap_notify $term, $event	726	=item on_unmap_notify $term, $event
678		727
679	Called whenever the corresponding X event is received for the terminal If	728	Called whenever the corresponding X event is received for the terminal. If
680	the hook returns true, then the even will be ignored by rxvt-unicode.	729	the hook returns true, then the event will be ignored by rxvt-unicode.
681		730
682	The event is a hash with most values as named by Xlib (see the XEvent	731	The event is a hash with most values as named by Xlib (see the XEvent
683	manpage), with the additional members C<row> and C<col>, which are the	732	manpage), with the additional members C<row> and C<col>, which are the
684	(real, not screen-based) row and column under the mouse cursor.	733	(real, not screen-based) row and column under the mouse cursor.
685		734
…		…
695	=item on_wm_delete_window $term, $event	744	=item on_wm_delete_window $term, $event
696		745
697	Called when various types of ClientMessage events are received (all with	746	Called when various types of ClientMessage events are received (all with
698	format=32, WM_PROTOCOLS or WM_PROTOCOLS:WM_DELETE_WINDOW).	747	format=32, WM_PROTOCOLS or WM_PROTOCOLS:WM_DELETE_WINDOW).
699		748
		749	=item on_bell $term
		750
		751	Called on receipt of a bell character.
		752
700	=back	753	=back
701		754
702	=cut	755	=cut
703		756
704	package urxvt;	757	package urxvt;
705		758
706	use utf8;	759	use utf8;
707	use strict;	760	use strict 'vars';
708	use Carp ();	761	use Carp ();
709	use Scalar::Util ();	762	use Scalar::Util ();
710	use List::Util ();	763	use List::Util ();
711		764
712	our $VERSION = 1;	765	our $VERSION = 1;
713	our $TERM;	766	our $TERM;
714	our @TERM_INIT;	767	our @TERM_INIT; # should go, prevents async I/O etc.
715	our @TERM_EXT;	768	our @TERM_EXT; # should go, prevents async I/O etc.
716	our @HOOKNAME;	769	our @HOOKNAME;
717	our %HOOKTYPE = map +($HOOKNAME[$_] => $_), 0..$#HOOKNAME;	770	our %HOOKTYPE = map +($HOOKNAME[$_] => $_), 0..$#HOOKNAME;
718	our %OPTION;	771	our %OPTION;
719		772
720	our $LIBDIR;	773	our $LIBDIR;
…		…
768		821
769	=over 4	822	=over 4
770		823
771	=item urxvt::fatal $errormessage	824	=item urxvt::fatal $errormessage
772		825
773	Fatally aborts execution with the given error message. Avoid at all	826	Fatally aborts execution with the given error message (which should
774	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
775	starts up.	828	is acceptable (and useful) is in the init hook, where it prevents the
		829	terminal from starting up.
776		830
777	=item urxvt::warn $string	831	=item urxvt::warn $string
778		832
779	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
780	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
781	that calls this function.	835	that calls this function.
782		836
783	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
784	correct place, e.g. on stderr of the connecting urxvtc client.	838	correct place, e.g. on stderr of the connecting urxvtc client.
…		…
788	=item @terms = urxvt::termlist	842	=item @terms = urxvt::termlist
789		843
790	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
791	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
792	objects that have perl extensions attached will be returned (because there	846	objects that have perl extensions attached will be returned (because there
793	is no urxvt::term objet associated with others).	847	is no urxvt::term object associated with others).
794		848
795	=item $time = urxvt::NOW	849	=item $time = urxvt::NOW
796		850
797	Returns the "current time" (as per the event loop).	851	Returns the "current time" (as per the event loop).
798		852
…		…
841		895
842	=item $rend = urxvt::OVERLAY_RSTYLE	896	=item $rend = urxvt::OVERLAY_RSTYLE
843		897
844	Return the rendition mask used for overlays by default.	898	Return the rendition mask used for overlays by default.
845		899
846	=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
847		902
848	Return the bit that enabled bold, italic, blink, reverse-video and	903	Return the bit that enabled bold, italic, blink, reverse-video and
849	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
850	the bitset.	905	the bitset.
851		906
…		…
888	};	943	};
889	}	944	}
890		945
891	no warnings 'utf8';	946	no warnings 'utf8';
892		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
893	my $verbosity = $ENV{URXVT_PERL_VERBOSITY};	1008	my $verbosity = $ENV{URXVT_PERL_VERBOSITY};
894		1009
895	sub verbose {	1010	sub verbose {
896	my ($level, $msg) = @_;	1011	my ($level, $msg) = @_;
897	warn "$msg\n" if $level <= $verbosity;	1012	warn "$msg\n" if $level <= $verbosity;
…		…
909	$pkg =~ s/[^[:word:]]/_/g;	1024	$pkg =~ s/[^[:word:]]/_/g;
910	$pkg = "urxvt::ext::$pkg";	1025	$pkg = "urxvt::ext::$pkg";
911		1026
912	verbose 3, "loading extension '$path' into package '$pkg'";	1027	verbose 3, "loading extension '$path' into package '$pkg'";
913		1028
		1029	(${"$pkg\::_NAME"} = $path) =~ s/^.*[\\\/]//; # hackish
		1030
914	open my $fh, "<:raw", $path	1031	open my $fh, "<:raw", $path
915	or die "$path: $!";	1032	or die "$path: $!";
916		1033
917	my $source =	1034	my $source =
918	"package $pkg; use strict; use utf8; no warnings 'utf8';\n"	1035	"package $pkg; use strict 'vars'; use utf8; no warnings 'utf8';\n"
919	. "#line 1 \"$path\"\n{\n"	1036	. "#line 1 \"$path\"\n{\n"
920	. (do { local $/; <$fh> })	1037	. (do { local $/; <$fh> })
921	. "\n};\n1";	1038	. "\n};\n1";
922		1039
923	eval $source	1040	eval $source
…		…
933	sub invoke {	1050	sub invoke {
934	local $TERM = shift;	1051	local $TERM = shift;
935	my $htype = shift;	1052	my $htype = shift;
936		1053
937	if ($htype == 0) { # INIT	1054	if ($htype == 0) { # INIT
938	my @dirs = ((split /:/, $TERM->resource ("perl_lib")), "$LIBDIR/perl");	1055	my @dirs = $TERM->perl_libdirs;
939		1056
940	my %ext_arg;	1057	my %ext_arg;
941		1058
942	{	1059	{
943	my @init = @TERM_INIT;	1060	my @init = @TERM_INIT;
…		…
946	my @pkg = @TERM_EXT;	1063	my @pkg = @TERM_EXT;
947	@TERM_EXT = ();	1064	@TERM_EXT = ();
948	$TERM->register_package ($_) for @pkg;	1065	$TERM->register_package ($_) for @pkg;
949	}	1066	}
950		1067
		1068	for (
		1069	@{ delete $TERM->{perl_ext_3} },
951	for (grep $_, map { split /,/, $TERM->resource ("perl_ext_$_") } 1, 2) {	1070	grep $_, map { split /,/, $TERM->resource ("perl_ext_$_") } 1, 2
		1071	) {
952	if ($_ eq "default") {	1072	if ($_ eq "default") {
953	$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);
954	} elsif (/^-(.*)$/) {	1074	} elsif (/^-(.*)$/) {
955	delete $ext_arg{$1};	1075	delete $ext_arg{$1};
956	} elsif (/^([^<]+)<(.*)>$/) {	1076	} elsif (/^([^<]+)<(.*)>$/) {
…		…
1032	}	1152	}
1033	}	1153	}
1034	($mask, @color{qw(fg bg)}, \@failed)	1154	($mask, @color{qw(fg bg)}, \@failed)
1035	}	1155	}
1036		1156
1037	# urxvt::term::extension
1038
1039	package urxvt::term::extension;	1157	package urxvt::term::extension;
1040		1158
1041	sub enable {	1159	sub enable {
1042	my ($self, %hook) = @_;	1160	my ($self, %hook) = @_;
1043	my $pkg = $self->{_pkg};	1161	my $pkg = $self->{_pkg};
…		…
1097		1215
1098	sub urxvt::destroy_hook(&) {	1216	sub urxvt::destroy_hook(&) {
1099	bless \shift, urxvt::destroy_hook::	1217	bless \shift, urxvt::destroy_hook::
1100	}	1218	}
1101		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
1102	package urxvt::anyevent;	1232	package urxvt::anyevent;
1103		1233
1104	=head2 The C<urxvt::anyevent> Class	1234	=head2 The C<urxvt::anyevent> Class
1105		1235
1106	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
1107	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
1108	further programming. The only exception is that you cannot wait on	1238	further programming. The only exception is that you cannot wait on
1109	condition variables, but non-blocking condvar use is ok. What this means	1239	condition variables, but non-blocking condvar use is ok.
1110	is that you cannot use blocking APIs, but the non-blocking variant should	1240
1111	work.	1241	In practical terms this means is that you cannot use blocking APIs, but
		1242	the non-blocking variant should work.
1112		1243
1113	=cut	1244	=cut
1114		1245
1115	our $VERSION = '3.4';	1246	our $VERSION = '5.23';
1116		1247
1117	$INC{"urxvt/anyevent.pm"} = 1; # mark us as there	1248	$INC{"urxvt/anyevent.pm"} = 1; # mark us as there
1118	push @AnyEvent::REGISTRY, [urxvt => urxvt::anyevent::];	1249	push @AnyEvent::REGISTRY, [urxvt => urxvt::anyevent::];
1119		1250
1120	sub timer {	1251	sub timer {
…		…
1122		1253
1123	my $cb = $arg{cb};	1254	my $cb = $arg{cb};
1124		1255
1125	urxvt::timer	1256	urxvt::timer
1126	->new	1257	->new
1127	->start (urxvt::NOW + $arg{after})	1258	->after ($arg{after}, $arg{interval})
1128	->cb (sub {	1259	->cb ($arg{interval} ? $cb : sub {
1129	$_[0]->stop; # need to cancel manually	1260	$_[0]->stop; # need to cancel manually
1130	$cb->();	1261	$cb->();
1131	})	1262	})
1132	}	1263	}
1133		1264
1134	sub io {	1265	sub io {
1135	my ($class, %arg) = @_;	1266	my ($class, %arg) = @_;
1136		1267
1137	my $cb = $arg{cb};	1268	my $cb = $arg{cb};
		1269	my $fd = fileno $arg{fh};
		1270	defined $fd or $fd = $arg{fh};
1138		1271
1139	bless [$arg{fh}, urxvt::iow	1272	bless [$arg{fh}, urxvt::iow
1140	->new	1273	->new
1141	->fd (fileno $arg{fh})	1274	->fd ($fd)
1142	->events (($arg{poll} =~ /r/ ? 1 : 0)	1275	->events (($arg{poll} =~ /r/ ? 1 : 0)
1143	\| ($arg{poll} =~ /w/ ? 2 : 0))	1276	\| ($arg{poll} =~ /w/ ? 2 : 0))
1144	->start	1277	->start
1145	->cb (sub {	1278	->cb ($cb)
1146	$cb->(($_[1] & 1 ? 'r' : '')
1147	. ($_[1] & 2 ? 'w' : ''));
1148	})],
1149	urxvt::anyevent::	1279	], urxvt::anyevent::
		1280	}
		1281
		1282	sub idle {
		1283	my ($class, %arg) = @_;
		1284
		1285	my $cb = $arg{cb};
		1286
		1287	urxvt::iw
		1288	->new
		1289	->start
		1290	->cb ($cb)
		1291	}
		1292
		1293	sub child {
		1294	my ($class, %arg) = @_;
		1295
		1296	my $cb = $arg{cb};
		1297
		1298	urxvt::pw
		1299	->new
		1300	->start ($arg{pid})
		1301	->cb (sub {
		1302	$_[0]->stop; # need to cancel manually
		1303	$cb->($_[0]->rpid, $_[0]->rstatus);
		1304	})
1150	}	1305	}
1151		1306
1152	sub DESTROY {	1307	sub DESTROY {
1153	$_[0][1]->stop;	1308	$_[0][1]->stop;
1154	}	1309	}
1155		1310
		1311	# only needed for AnyEvent < 6 compatibility
1156	sub one_event {	1312	sub one_event {
1157	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";
1158	}	1314	}
1159		1315
1160	package urxvt::term;	1316	package urxvt::term;
…		…
1175	urxvt::verbose 6, "register package $pkg to $self";	1331	urxvt::verbose 6, "register package $pkg to $self";
1176		1332
1177	@{"$pkg\::ISA"} = urxvt::term::extension::;	1333	@{"$pkg\::ISA"} = urxvt::term::extension::;
1178		1334
1179	my $proxy = bless {	1335	my $proxy = bless {
1180	_pkg => $pkg,	1336	_pkg => $pkg,
		1337	_name => ${"$pkg\::_NAME"}, # hackish
1181	argv => $argv,	1338	argv => $argv,
1182	}, $pkg;	1339	}, $pkg;
1183	Scalar::Util::weaken ($proxy->{term} = $self);	1340	Scalar::Util::weaken ($proxy->{term} = $self);
1184		1341
1185	$self->{_pkg}{$pkg} = $proxy;	1342	$self->{_pkg}{$pkg} = $proxy;
1186		1343
…		…
1189	$proxy->enable ($name => $ref);	1346	$proxy->enable ($name => $ref);
1190	}	1347	}
1191	}	1348	}
1192	}	1349	}
1193		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
1194	=item $term = new urxvt::term $envhashref, $rxvtname, [arg...]	1398	=item $term = new urxvt::term $envhashref, $rxvtname, [arg...]
1195		1399
1196	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
1197	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
1198	hash which defines the environment of the new terminal.	1402	hash which defines the environment of the new terminal.
…		…
1252	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.
1253		1457
1254	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
1255	source file F</src/optinc.h> to see the actual list:	1459	source file F</src/optinc.h> to see the actual list:
1256		1460
1257	borderLess console cursorBlink cursorUnderline hold iconic insecure	1461	borderLess buffered console cursorBlink cursorUnderline hold iconic
1258	intensityStyles jumpScroll loginShell mapAlert meta8 mouseWheelScrollPage	1462	insecure intensityStyles iso14755 iso14755_52 jumpScroll loginShell
1259	override-redirect pastableTabs pointerBlank reverseVideo scrollBar	1463	mapAlert meta8 mouseWheelScrollPage override_redirect pastableTabs
1260	scrollBar_floating scrollBar_right scrollTtyKeypress scrollTtyOutput	1464	pointerBlank reverseVideo scrollBar scrollBar_floating scrollBar_right
1261	scrollWithBuffer secondaryScreen secondaryScroll skipBuiltinGlyphs	1465	scrollTtyKeypress scrollTtyOutput scrollWithBuffer secondaryScreen
1262	transparent tripleclickwords utmpInhibit visualBell	1466	secondaryScroll skipBuiltinGlyphs skipScroll transparent tripleclickwords
		1467	urgentOnBell utmpInhibit visualBell
1263		1468
1264	=item $value = $term->resource ($name[, $newval])	1469	=item $value = $term->resource ($name[, $newval])
1265		1470
1266	Returns the current resource value associated with a given name and	1471	Returns the current resource value associated with a given name and
1267	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>
…		…
1280		1485
1281	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
1282	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>
1283	to see the actual list:	1488	to see the actual list:
1284		1489
1285	answerbackstring backgroundPixmap backspace_key boldFont boldItalicFont	1490	answerbackstring backgroundPixmap backspace_key blendtype blurradius
1286	borderLess chdir color cursorBlink cursorUnderline cutchars delete_key	1491	boldFont boldItalicFont borderLess buffered chdir color cursorBlink
1287	display_name embed ext_bwidth fade font geometry hold iconName	1492	cursorUnderline cutchars delete_key depth display_name embed ext_bwidth
1288	imFont imLocale inputMethod insecure int_bwidth intensityStyles	1493	fade font geometry hold iconName iconfile imFont imLocale inputMethod
		1494	insecure int_bwidth intensityStyles iso14755 iso14755_52 italicFont
1289	italicFont jumpScroll lineSpace loginShell mapAlert meta8 modifier	1495	jumpScroll letterSpace lineSpace loginShell mapAlert meta8 modifier
1290	mouseWheelScrollPage name override_redirect pastableTabs path perl_eval	1496	mouseWheelScrollPage name override_redirect pastableTabs path perl_eval
1291	perl_ext_1 perl_ext_2 perl_lib pointerBlank pointerBlankDelay	1497	perl_ext_1 perl_ext_2 perl_lib pointerBlank pointerBlankDelay
1292	preeditType print_pipe pty_fd reverseVideo saveLines scrollBar	1498	preeditType print_pipe pty_fd reverseVideo saveLines scrollBar
1293	scrollBar_align scrollBar_floating scrollBar_right scrollBar_thickness	1499	scrollBar_align scrollBar_floating scrollBar_right scrollBar_thickness
1294	scrollTtyKeypress scrollTtyOutput scrollWithBuffer scrollstyle	1500	scrollTtyKeypress scrollTtyOutput scrollWithBuffer scrollstyle
1295	secondaryScreen secondaryScroll shade term_name title	1501	secondaryScreen secondaryScroll shade skipBuiltinGlyphs skipScroll
1296	transient_for transparent transparent_all tripleclickwords utmpInhibit	1502	term_name title transient_for transparent tripleclickwords urgentOnBell
1297	visualBell	1503	utmpInhibit visualBell
1298		1504
1299	=cut	1505	=cut
1300		1506
1301	sub resource($$;$) {	1507	sub resource($$;$) {
1302	my ($self, $name) = (shift, shift);	1508	my ($self, $name) = (shift, shift);
…		…
1309	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
1310	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
1311	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
1312	resource with that pattern exists.	1518	resource with that pattern exists.
1313		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
1314	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
1315	only one resource database per display, and later invocations might return	1531	only one resource database per display, and later invocations might return
1316	the wrong resources.	1532	the wrong resources.
1317		1533
1318	=item $success = $term->parse_keysym ($keysym_spec, $command_string)	1534	=item $value = $term->x_resource_boolean ($pattern)
1319		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
1320	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
1321	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.
1322		1561
1323	=item $rend = $term->rstyle ([$new_rstyle])	1562	=item $rend = $term->rstyle ([$new_rstyle])
1324		1563
1325	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
1326	the terminal application will use this style.	1565	the terminal application will use this style.
…		…
1334		1573
1335	=item ($row, $col) = $term->selection_beg ([$row, $col])	1574	=item ($row, $col) = $term->selection_beg ([$row, $col])
1336		1575
1337	=item ($row, $col) = $term->selection_end ([$row, $col])	1576	=item ($row, $col) = $term->selection_end ([$row, $col])
1338		1577
1339	Return the current values of the selection mark, begin or end positions,	1578	Return the current values of the selection mark, begin or end positions.
1340	and optionally set them to new values.	1579
		1580	When arguments are given, then the selection coordinates are set to
		1581	C<$row> and C<$col>, and the selection screen is set to the current
		1582	screen.
		1583
		1584	=item $screen = $term->selection_screen ([$screen])
		1585
		1586	Returns the current selection screen, and then optionally sets it.
1341		1587
1342	=item $term->selection_make ($eventtime[, $rectangular])	1588	=item $term->selection_make ($eventtime[, $rectangular])
1343		1589
1344	Tries to make a selection as set by C<selection_beg> and	1590	Tries to make a selection as set by C<selection_beg> and
1345	C<selection_end>. If C<$rectangular> is true (default: false), a	1591	C<selection_end>. If C<$rectangular> is true (default: false), a
1346	rectangular selection will be made. This is the prefered function to make	1592	rectangular selection will be made. This is the preferred function to make
1347	a selection.	1593	a selection.
1348		1594
1349	=item $success = $term->selection_grab ($eventtime)	1595	=item $success = $term->selection_grab ($eventtime[, $clipboard])
1350		1596
1351	Try to request the primary selection text from the server (for example, as	1597	Try to acquire ownership of the primary (clipboard if C<$clipboard> is
		1598	true) selection from the server. The corresponding text can be set
1352	set by the next method). No visual feedback will be given. This function	1599	with the next method. No visual feedback will be given. This function
1353	is mostly useful from within C<on_sel_grab> hooks.	1600	is mostly useful from within C<on_sel_grab> hooks.
1354		1601
1355	=item $oldtext = $term->selection ([$newtext])	1602	=item $oldtext = $term->selection ([$newtext, $clipboard])
1356		1603
1357	Return the current selection text and optionally replace it by C<$newtext>.	1604	Return the current selection (clipboard if C<$clipboard> is true) text
		1605	and optionally replace it by C<$newtext>.
		1606
		1607	=item $term->selection_clear ([$clipboard])
		1608
		1609	Revoke ownership of the primary (clipboard if C<$clipboard> is true) selection.
1358		1610
1359	=item $term->overlay_simple ($x, $y, $text)	1611	=item $term->overlay_simple ($x, $y, $text)
1360		1612
1361	Create a simple multi-line overlay box. See the next method for details.	1613	Create a simple multi-line overlay box. See the next method for details.
1362		1614
…		…
1490	locale-specific encoding of the terminal and can contain command sequences	1742	locale-specific encoding of the terminal and can contain command sequences
1491	(escape codes) that will be interpreted.	1743	(escape codes) that will be interpreted.
1492		1744
1493	=item $term->tt_write ($octets)	1745	=item $term->tt_write ($octets)
1494		1746
1495	Write the octets given in C<$data> to the tty (i.e. as program input). To	1747	Write the octets given in C<$octets> to the tty (i.e. as program input). To
1496	pass characters instead of octets, you should convert your strings first	1748	pass characters instead of octets, you should convert your strings first
1497	to the locale-specific encoding using C<< $term->locale_encode >>.	1749	to the locale-specific encoding using C<< $term->locale_encode >>.
		1750
		1751	=item $term->tt_paste ($octets)
		1752
		1753	Write the octets given in C<$octets> to the tty as a paste, converting NL to
		1754	CR and bracketing the data with control sequences if bracketed paste mode
		1755	is set.
1498		1756
1499	=item $old_events = $term->pty_ev_events ([$new_events])	1757	=item $old_events = $term->pty_ev_events ([$new_events])
1500		1758
1501	Replaces the event mask of the pty watcher by the given event mask. Can	1759	Replaces the event mask of the pty watcher by the given event mask. Can
1502	be used to suppress input and output handling to the pty/tty. See the	1760	be used to suppress input and output handling to the pty/tty. See the
…		…
1520		1778
1521	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
1522	to receive pointer events all the times:	1780	to receive pointer events all the times:
1523		1781
1524	$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.
1525		1787
1526	=item $term->focus_in	1788	=item $term->focus_in
1527		1789
1528	=item $term->focus_out	1790	=item $term->focus_out
1529		1791
…		…
1816	Calls XAllowEvents with both ReplayPointer and ReplayKeyboard for the most	2078	Calls XAllowEvents with both ReplayPointer and ReplayKeyboard for the most
1817	recent grab.	2079	recent grab.
1818		2080
1819	=item $term->ungrab	2081	=item $term->ungrab
1820		2082
1821	Calls XUngrab for the most recent grab. Is called automatically on	2083	Calls XUngrabPointer and XUngrabKeyboard for the most recent grab. Is called automatically on
1822	evaluation errors, as it is better to lose the grab in the error case as	2084	evaluation errors, as it is better to lose the grab in the error case as
1823	the session.	2085	the session.
1824		2086
1825	=item $atom = $term->XInternAtom ($atom_name[, $only_if_exists])	2087	=item $atom = $term->XInternAtom ($atom_name[, $only_if_exists])
1826		2088
…		…
1846		2108
1847	=item ($x, $y, $child_window) = $term->XTranslateCoordinates ($src, $dst, $x, $y)	2109	=item ($x, $y, $child_window) = $term->XTranslateCoordinates ($src, $dst, $x, $y)
1848		2110
1849	=item $term->XChangeInput ($window, $add_events[, $del_events])	2111	=item $term->XChangeInput ($window, $add_events[, $del_events])
1850		2112
		2113	=item $keysym = $term->XStringToKeysym ($string)
		2114
		2115	=item $string = $term->XKeysymToString ($keysym)
		2116
1851	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
1852	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
1853	directory onto the X functions of the same name.	2119	directly onto the X functions of the same name.
1854		2120
1855	=back	2121	=back
1856		2122
1857	=cut	2123	=cut
1858		2124
…		…
2015		2281
2016	=item $timer = $timer->cb (sub { my ($timer) = @_; ... })	2282	=item $timer = $timer->cb (sub { my ($timer) = @_; ... })
2017		2283
2018	Set the callback to be called when the timer triggers.	2284	Set the callback to be called when the timer triggers.
2019		2285
2020	=item $tstamp = $timer->at
2021
2022	Return the time this watcher will fire next.
2023
2024	=item $timer = $timer->set ($tstamp)	2286	=item $timer = $timer->set ($tstamp[, $interval])
2025		2287
2026	Set the time the event is generated to $tstamp.	2288	Set the time the event is generated to $tstamp (and optionally specifies a
		2289	new $interval).
2027		2290
2028	=item $timer = $timer->interval ($interval)	2291	=item $timer = $timer->interval ($interval)
2029		2292
2030	Normally (and when C<$interval> is C<0>), the timer will automatically	2293	By default (and when C<$interval> is C<0>), the timer will automatically
2031	stop after it has fired once. If C<$interval> is non-zero, then the timer	2294	stop after it has fired once. If C<$interval> is non-zero, then the timer
2032	is automatically rescheduled at the given intervals.	2295	is automatically rescheduled at the given intervals.
2033		2296
2034	=item $timer = $timer->start	2297	=item $timer = $timer->start
2035		2298
2036	Start the timer.	2299	Start the timer.
2037		2300
2038	=item $timer = $timer->start ($tstamp)	2301	=item $timer = $timer->start ($tstamp[, $interval])
2039		2302
2040	Set the event trigger time to C<$tstamp> and start the timer.	2303	Set the event trigger time to C<$tstamp> and start the timer. Optionally
		2304	also replaces the interval.
2041		2305
2042	=item $timer = $timer->after ($delay)	2306	=item $timer = $timer->after ($delay[, $interval])
2043		2307
2044	Like C<start>, but sets the expiry timer to c<urxvt::NOW + $delay>.	2308	Like C<start>, but sets the expiry timer to c<urxvt::NOW + $delay>.
2045		2309
2046	=item $timer = $timer->stop	2310	=item $timer = $timer->stop
2047		2311
…		…
2178		2442
2179	=back	2443	=back
2180		2444
2181	=head1 AUTHOR	2445	=head1 AUTHOR
2182		2446
2183	Marc Lehmann <pcg@goof.com>	2447	Marc Lehmann <schmorp@schmorp.de>
2184	http://software.schmorp.de/pkg/rxvt-unicode	2448	http://software.schmorp.de/pkg/rxvt-unicode
2185		2449
2186	=cut	2450	=cut
2187		2451
2188	1	2452	1

Diff Legend

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

Comparing rxvt-unicode/src/urxvt.pm (file contents): Revision 1.173 by root, Wed Nov 5 12:45:36 2008 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.173 by root, Wed Nov 5 12:45:36 2008 UTC vs.
Revision 1.217 by root, Sun Jun 10 13:58:05 2012 UTC