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

Comparing rxvt-unicode/src/urxvt.pm (file contents):
Revision 1.176 by root, Sat Jul 18 05:59:49 2009 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
…		…
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.
377		379
378	=item macosx-pastebin and macosx-pastebin-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
381	used like this:	383	used like this:
382		384
383	URxvt.perl-ext-common: default,macosx-clipboard	385	URxvt.perl-ext-common: default,macosx-clipboard
384	URxvt.keysym.M-c: perl:macosx-clipboard:copy	386	URxvt.keysym.M-c: perl:macosx-clipboard:copy
385	URxvt.keysym.M-v: perl:macosx-clipboard:paste	387	URxvt.keysym.M-v: perl:macosx-clipboard:paste
386		388
387	The difference between them is that the native variant requires a	389	The difference between them is that the native variant requires a
388	perl from apple's devkit or so, and C<maxosx-pastebin> requires the	390	perl from apple's devkit or so, and C<macosx-clipboard> requires the
389	C<Mac::Pasteboard> module, works with other perls, has fewer bugs, is	391	C<Mac::Pasteboard> module, works with other perls, has fewer bugs, is
390	simpler etc. etc.	392	simpler etc. etc.
391		393
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
…		…
417		432
418	=over 4	433	=over 4
419		434
420	=item $text	435	=item $text
421		436
422	Rxvt-unicodes special way of encoding text, where one "unicode" character	437	Rxvt-unicode's special way of encoding text, where one "unicode" character
423	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.
424		439
425	=item $string	440	=item $string
426		441
427	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
…		…
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
…		…
688		723
689	=item on_map_notify $term, $event	724	=item on_map_notify $term, $event
690		725
691	=item on_unmap_notify $term, $event	726	=item on_unmap_notify $term, $event
692		727
693	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
694	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.
695		730
696	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
697	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
698	(real, not screen-based) row and column under the mouse cursor.	733	(real, not screen-based) row and column under the mouse cursor.
699		734
…		…
709	=item on_wm_delete_window $term, $event	744	=item on_wm_delete_window $term, $event
710		745
711	Called when various types of ClientMessage events are received (all with	746	Called when various types of ClientMessage events are received (all with
712	format=32, WM_PROTOCOLS or WM_PROTOCOLS:WM_DELETE_WINDOW).	747	format=32, WM_PROTOCOLS or WM_PROTOCOLS:WM_DELETE_WINDOW).
713		748
		749	=item on_bell $term
		750
		751	Called on receipt of a bell character.
		752
714	=back	753	=back
715		754
716	=cut	755	=cut
717		756
718	package urxvt;	757	package urxvt;
719		758
720	use utf8;	759	use utf8;
721	use strict;	760	use strict 'vars';
722	use Carp ();	761	use Carp ();
723	use Scalar::Util ();	762	use Scalar::Util ();
724	use List::Util ();	763	use List::Util ();
725		764
726	our $VERSION = 1;	765	our $VERSION = 1;
727	our $TERM;	766	our $TERM;
728	our @TERM_INIT;	767	our @TERM_INIT; # should go, prevents async I/O etc.
729	our @TERM_EXT;	768	our @TERM_EXT; # should go, prevents async I/O etc.
730	our @HOOKNAME;	769	our @HOOKNAME;
731	our %HOOKTYPE = map +($HOOKNAME[$_] => $_), 0..$#HOOKNAME;	770	our %HOOKTYPE = map +($HOOKNAME[$_] => $_), 0..$#HOOKNAME;
732	our %OPTION;	771	our %OPTION;
733		772
734	our $LIBDIR;	773	our $LIBDIR;
…		…
782		821
783	=over 4	822	=over 4
784		823
785	=item urxvt::fatal $errormessage	824	=item urxvt::fatal $errormessage
786		825
787	Fatally aborts execution with the given error message. Avoid at all	826	Fatally aborts execution with the given error message (which should
788	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
789	starts up.	828	is acceptable (and useful) is in the init hook, where it prevents the
		829	terminal from starting up.
790		830
791	=item urxvt::warn $string	831	=item urxvt::warn $string
792		832
793	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
794	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
795	that calls this function.	835	that calls this function.
796		836
797	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
798	correct place, e.g. on stderr of the connecting urxvtc client.	838	correct place, e.g. on stderr of the connecting urxvtc client.
…		…
802	=item @terms = urxvt::termlist	842	=item @terms = urxvt::termlist
803		843
804	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
805	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
806	objects that have perl extensions attached will be returned (because there	846	objects that have perl extensions attached will be returned (because there
807	is no urxvt::term objet associated with others).	847	is no urxvt::term object associated with others).
808		848
809	=item $time = urxvt::NOW	849	=item $time = urxvt::NOW
810		850
811	Returns the "current time" (as per the event loop).	851	Returns the "current time" (as per the event loop).
812		852
…		…
855		895
856	=item $rend = urxvt::OVERLAY_RSTYLE	896	=item $rend = urxvt::OVERLAY_RSTYLE
857		897
858	Return the rendition mask used for overlays by default.	898	Return the rendition mask used for overlays by default.
859		899
860	=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
861		902
862	Return the bit that enabled bold, italic, blink, reverse-video and	903	Return the bit that enabled bold, italic, blink, reverse-video and
863	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
864	the bitset.	905	the bitset.
865		906
…		…
902	};	943	};
903	}	944	}
904		945
905	no warnings 'utf8';	946	no warnings 'utf8';
906		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
907	my $verbosity = $ENV{URXVT_PERL_VERBOSITY};	1007	my $verbosity = $ENV{URXVT_PERL_VERBOSITY};
908		1008
909	sub verbose {	1009	sub verbose {
910	my ($level, $msg) = @_;	1010	my ($level, $msg) = @_;
911	warn "$msg\n" if $level <= $verbosity;	1011	warn "$msg\n" if $level <= $verbosity;
…		…
927		1027
928	open my $fh, "<:raw", $path	1028	open my $fh, "<:raw", $path
929	or die "$path: $!";	1029	or die "$path: $!";
930		1030
931	my $source =	1031	my $source =
932	"package $pkg; use strict; use utf8; no warnings 'utf8';\n"	1032	"package $pkg; use strict 'vars'; use utf8; no warnings 'utf8';\n"
933	. "#line 1 \"$path\"\n{\n"	1033	. "#line 1 \"$path\"\n{\n"
934	. (do { local $/; <$fh> })	1034	. (do { local $/; <$fh> })
935	. "\n};\n1";	1035	. "\n};\n1";
936		1036
937	eval $source	1037	eval $source
…		…
947	sub invoke {	1047	sub invoke {
948	local $TERM = shift;	1048	local $TERM = shift;
949	my $htype = shift;	1049	my $htype = shift;
950		1050
951	if ($htype == 0) { # INIT	1051	if ($htype == 0) { # INIT
952	my @dirs = ((split /:/, $TERM->resource ("perl_lib")), "$LIBDIR/perl");	1052	my @dirs = $TERM->perl_libdirs;
953		1053
954	my %ext_arg;	1054	my %ext_arg;
955		1055
956	{	1056	{
957	my @init = @TERM_INIT;	1057	my @init = @TERM_INIT;
…		…
960	my @pkg = @TERM_EXT;	1060	my @pkg = @TERM_EXT;
961	@TERM_EXT = ();	1061	@TERM_EXT = ();
962	$TERM->register_package ($_) for @pkg;	1062	$TERM->register_package ($_) for @pkg;
963	}	1063	}
964		1064
		1065	for (
		1066	@{ delete $TERM->{perl_ext_3} },
965	for (grep $_, map { split /,/, $TERM->resource ("perl_ext_$_") } 1, 2) {	1067	grep $_, map { split /,/, $TERM->resource ("perl_ext_$_") } 1, 2
		1068	) {
966	if ($_ eq "default") {	1069	if ($_ eq "default") {
967	$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);
968	} elsif (/^-(.*)$/) {	1071	} elsif (/^-(.*)$/) {
969	delete $ext_arg{$1};	1072	delete $ext_arg{$1};
970	} elsif (/^([^<]+)<(.*)>$/) {	1073	} elsif (/^([^<]+)<(.*)>$/) {
…		…
1118	=head2 The C<urxvt::anyevent> Class	1221	=head2 The C<urxvt::anyevent> Class
1119		1222
1120	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
1121	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
1122	further programming. The only exception is that you cannot wait on	1225	further programming. The only exception is that you cannot wait on
1123	condition variables, but non-blocking condvar use is ok. What this means	1226	condition variables, but non-blocking condvar use is ok.
1124	is that you cannot use blocking APIs, but the non-blocking variant should	1227
1125	work.	1228	In practical terms this means is that you cannot use blocking APIs, but
		1229	the non-blocking variant should work.
1126		1230
1127	=cut	1231	=cut
1128		1232
1129	our $VERSION = '3.4';	1233	our $VERSION = '5.23';
1130		1234
1131	$INC{"urxvt/anyevent.pm"} = 1; # mark us as there	1235	$INC{"urxvt/anyevent.pm"} = 1; # mark us as there
1132	push @AnyEvent::REGISTRY, [urxvt => urxvt::anyevent::];	1236	push @AnyEvent::REGISTRY, [urxvt => urxvt::anyevent::];
1133		1237
1134	sub timer {	1238	sub timer {
…		…
1136		1240
1137	my $cb = $arg{cb};	1241	my $cb = $arg{cb};
1138		1242
1139	urxvt::timer	1243	urxvt::timer
1140	->new	1244	->new
1141	->after ($arg{after})	1245	->after ($arg{after}, $arg{interval})
1142	->interval ($arg{interval})	1246	->cb ($arg{interval} ? $cb : sub {
1143	->start
1144	->cb (sub {
1145	#TODO interval?
1146	$_[0]->stop; # need to cancel manually	1247	$_[0]->stop; # need to cancel manually
1147	$cb->();	1248	$cb->();
1148	})	1249	})
1149	}	1250	}
1150		1251
…		…
1155	my $fd = fileno $arg{fh};	1256	my $fd = fileno $arg{fh};
1156	defined $fd or $fd = $arg{fh};	1257	defined $fd or $fd = $arg{fh};
1157		1258
1158	bless [$arg{fh}, urxvt::iow	1259	bless [$arg{fh}, urxvt::iow
1159	->new	1260	->new
1160	->fd (defined fileno $arg{fh})	1261	->fd ($fd)
1161	->events (($arg{poll} =~ /r/ ? 1 : 0)	1262	->events (($arg{poll} =~ /r/ ? 1 : 0)
1162	\| ($arg{poll} =~ /w/ ? 2 : 0))	1263	\| ($arg{poll} =~ /w/ ? 2 : 0))
1163	->start	1264	->start
1164	->cb ($cb)	1265	->cb ($cb)
1165	], urxvt::anyevent::	1266	], urxvt::anyevent::
…		…
1171	my $cb = $arg{cb};	1272	my $cb = $arg{cb};
1172		1273
1173	urxvt::iw	1274	urxvt::iw
1174	->new	1275	->new
1175	->start	1276	->start
1176	->cb (sub {	1277	->cb ($cb)
1177	#TODO really cancel?
1178	$_[0]->stop; # need to cancel manually
1179	$cb->();
1180	})
1181	}	1278	}
1182		1279
1183	sub child {	1280	sub child {
1184	my ($class, %arg) = @_;	1281	my ($class, %arg) = @_;
1185		1282
…		…
1187		1284
1188	urxvt::pw	1285	urxvt::pw
1189	->new	1286	->new
1190	->start ($arg{pid})	1287	->start ($arg{pid})
1191	->cb (sub {	1288	->cb (sub {
1192	#TODO really cancel?
1193	$_[0]->stop; # need to cancel manually	1289	$_[0]->stop; # need to cancel manually
1194	$cb->($_[0]->rpid, $_[0]->rstatus);	1290	$cb->($_[0]->rpid, $_[0]->rstatus);
1195	})	1291	})
1196	}	1292	}
1197		1293
1198	sub DESTROY {	1294	sub DESTROY {
1199	$_[0][1]->stop;	1295	$_[0][1]->stop;
1200	}	1296	}
1201		1297
		1298	# only needed for AnyEvent < 6 compatibility
1202	sub one_event {	1299	sub one_event {
1203	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";
1204	}	1301	}
1205		1302
1206	package urxvt::term;	1303	package urxvt::term;
…		…
1235	$proxy->enable ($name => $ref);	1332	$proxy->enable ($name => $ref);
1236	}	1333	}
1237	}	1334	}
1238	}	1335	}
1239		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
1240	=item $term = new urxvt::term $envhashref, $rxvtname, [arg...]	1384	=item $term = new urxvt::term $envhashref, $rxvtname, [arg...]
1241		1385
1242	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
1243	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
1244	hash which defines the environment of the new terminal.	1388	hash which defines the environment of the new terminal.
…		…
1298	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.
1299		1443
1300	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
1301	source file F</src/optinc.h> to see the actual list:	1445	source file F</src/optinc.h> to see the actual list:
1302		1446
1303	borderLess console cursorBlink cursorUnderline hold iconic insecure	1447	borderLess buffered console cursorBlink cursorUnderline hold iconic
1304	intensityStyles jumpScroll loginShell mapAlert meta8 mouseWheelScrollPage	1448	insecure intensityStyles iso14755 iso14755_52 jumpScroll loginShell
1305	override-redirect pastableTabs pointerBlank reverseVideo scrollBar	1449	mapAlert meta8 mouseWheelScrollPage override_redirect pastableTabs
1306	scrollBar_floating scrollBar_right scrollTtyKeypress scrollTtyOutput	1450	pointerBlank reverseVideo scrollBar scrollBar_floating scrollBar_right
1307	scrollWithBuffer secondaryScreen secondaryScroll skipBuiltinGlyphs	1451	scrollTtyKeypress scrollTtyOutput scrollWithBuffer secondaryScreen
1308	transparent tripleclickwords utmpInhibit visualBell	1452	secondaryScroll skipBuiltinGlyphs skipScroll transparent tripleclickwords
		1453	urgentOnBell utmpInhibit visualBell
1309		1454
1310	=item $value = $term->resource ($name[, $newval])	1455	=item $value = $term->resource ($name[, $newval])
1311		1456
1312	Returns the current resource value associated with a given name and	1457	Returns the current resource value associated with a given name and
1313	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>
…		…
1326		1471
1327	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
1328	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>
1329	to see the actual list:	1474	to see the actual list:
1330		1475
1331	answerbackstring backgroundPixmap backspace_key boldFont boldItalicFont	1476	answerbackstring backgroundPixmap backspace_key blendtype blurradius
1332	borderLess chdir color cursorBlink cursorUnderline cutchars delete_key	1477	boldFont boldItalicFont borderLess buffered chdir color cursorBlink
1333	display_name embed ext_bwidth fade font geometry hold iconName	1478	cursorUnderline cutchars delete_key depth display_name embed ext_bwidth
1334	imFont imLocale inputMethod insecure int_bwidth intensityStyles	1479	fade font geometry hold iconName iconfile imFont imLocale inputMethod
1335	italicFont jumpScroll lineSpace letterSpace loginShell mapAlert meta8	1480	insecure int_bwidth intensityStyles iso14755 iso14755_52 italicFont
		1481	jumpScroll letterSpace lineSpace loginShell mapAlert meta8 modifier
1336	modifier mouseWheelScrollPage name override_redirect pastableTabs path	1482	mouseWheelScrollPage name override_redirect pastableTabs path perl_eval
1337	perl_eval perl_ext_1 perl_ext_2 perl_lib pointerBlank pointerBlankDelay	1483	perl_ext_1 perl_ext_2 perl_lib pointerBlank pointerBlankDelay
1338	preeditType print_pipe pty_fd reverseVideo saveLines scrollBar	1484	preeditType print_pipe pty_fd reverseVideo saveLines scrollBar
1339	scrollBar_align scrollBar_floating scrollBar_right scrollBar_thickness	1485	scrollBar_align scrollBar_floating scrollBar_right scrollBar_thickness
1340	scrollTtyKeypress scrollTtyOutput scrollWithBuffer scrollstyle	1486	scrollTtyKeypress scrollTtyOutput scrollWithBuffer scrollstyle
1341	secondaryScreen secondaryScroll shade term_name title	1487	secondaryScreen secondaryScroll shade skipBuiltinGlyphs skipScroll
1342	transient_for transparent transparent_all tripleclickwords utmpInhibit	1488	term_name title transient_for transparent tripleclickwords urgentOnBell
1343	visualBell	1489	utmpInhibit visualBell
1344		1490
1345	=cut	1491	=cut
1346		1492
1347	sub resource($$;$) {	1493	sub resource($$;$) {
1348	my ($self, $name) = (shift, shift);	1494	my ($self, $name) = (shift, shift);
…		…
1359		1505
1360	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
1361	only one resource database per display, and later invocations might return	1507	only one resource database per display, and later invocations might return
1362	the wrong resources.	1508	the wrong resources.
1363		1509
1364	=item $success = $term->parse_keysym ($keysym_spec, $command_string)	1510	=item $value = $term->x_resource_boolean ($pattern)
1365		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
1366	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
1367	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.
1368		1537
1369	=item $rend = $term->rstyle ([$new_rstyle])	1538	=item $rend = $term->rstyle ([$new_rstyle])
1370		1539
1371	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
1372	the terminal application will use this style.	1541	the terminal application will use this style.
…		…
1380		1549
1381	=item ($row, $col) = $term->selection_beg ([$row, $col])	1550	=item ($row, $col) = $term->selection_beg ([$row, $col])
1382		1551
1383	=item ($row, $col) = $term->selection_end ([$row, $col])	1552	=item ($row, $col) = $term->selection_end ([$row, $col])
1384		1553
1385	Return the current values of the selection mark, begin or end positions,	1554	Return the current values of the selection mark, begin or end positions.
1386	and optionally set them to new values.	1555
		1556	When arguments are given, then the selection coordinates are set to
		1557	C<$row> and C<$col>, and the selection screen is set to the current
		1558	screen.
		1559
		1560	=item $screen = $term->selection_screen ([$screen])
		1561
		1562	Returns the current selection screen, and then optionally sets it.
1387		1563
1388	=item $term->selection_make ($eventtime[, $rectangular])	1564	=item $term->selection_make ($eventtime[, $rectangular])
1389		1565
1390	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
1391	C<selection_end>. If C<$rectangular> is true (default: false), a	1567	C<selection_end>. If C<$rectangular> is true (default: false), a
1392	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
1393	a selection.	1569	a selection.
1394		1570
1395	=item $success = $term->selection_grab ($eventtime)	1571	=item $success = $term->selection_grab ($eventtime[, $clipboard])
1396		1572
1397	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
1398	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
1399	is mostly useful from within C<on_sel_grab> hooks.	1576	is mostly useful from within C<on_sel_grab> hooks.
1400		1577
1401	=item $oldtext = $term->selection ([$newtext])	1578	=item $oldtext = $term->selection ([$newtext, $clipboard])
1402		1579
1403	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.
1404		1586
1405	=item $term->overlay_simple ($x, $y, $text)	1587	=item $term->overlay_simple ($x, $y, $text)
1406		1588
1407	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.
1408		1590
…		…
1536	locale-specific encoding of the terminal and can contain command sequences	1718	locale-specific encoding of the terminal and can contain command sequences
1537	(escape codes) that will be interpreted.	1719	(escape codes) that will be interpreted.
1538		1720
1539	=item $term->tt_write ($octets)	1721	=item $term->tt_write ($octets)
1540		1722
1541	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
1542	pass characters instead of octets, you should convert your strings first	1724	pass characters instead of octets, you should convert your strings first
1543	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.
1544		1732
1545	=item $old_events = $term->pty_ev_events ([$new_events])	1733	=item $old_events = $term->pty_ev_events ([$new_events])
1546		1734
1547	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
1548	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
…		…
1566		1754
1567	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
1568	to receive pointer events all the times:	1756	to receive pointer events all the times:
1569		1757
1570	$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.
1571		1763
1572	=item $term->focus_in	1764	=item $term->focus_in
1573		1765
1574	=item $term->focus_out	1766	=item $term->focus_out
1575		1767
…		…
1862	Calls XAllowEvents with both ReplayPointer and ReplayKeyboard for the most	2054	Calls XAllowEvents with both ReplayPointer and ReplayKeyboard for the most
1863	recent grab.	2055	recent grab.
1864		2056
1865	=item $term->ungrab	2057	=item $term->ungrab
1866		2058
1867	Calls XUngrab for the most recent grab. Is called automatically on	2059	Calls XUngrabPointer and XUngrabKeyboard for the most recent grab. Is called automatically on
1868	evaluation errors, as it is better to lose the grab in the error case as	2060	evaluation errors, as it is better to lose the grab in the error case as
1869	the session.	2061	the session.
1870		2062
1871	=item $atom = $term->XInternAtom ($atom_name[, $only_if_exists])	2063	=item $atom = $term->XInternAtom ($atom_name[, $only_if_exists])
1872		2064
…		…
1892		2084
1893	=item ($x, $y, $child_window) = $term->XTranslateCoordinates ($src, $dst, $x, $y)	2085	=item ($x, $y, $child_window) = $term->XTranslateCoordinates ($src, $dst, $x, $y)
1894		2086
1895	=item $term->XChangeInput ($window, $add_events[, $del_events])	2087	=item $term->XChangeInput ($window, $add_events[, $del_events])
1896		2088
		2089	=item $keysym = $term->XStringToKeysym ($string)
		2090
		2091	=item $string = $term->XKeysymToString ($keysym)
		2092
1897	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
1898	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
1899	directory onto the X functions of the same name.	2095	directly onto the X functions of the same name.
1900		2096
1901	=back	2097	=back
1902		2098
1903	=cut	2099	=cut
1904		2100
…		…
2061		2257
2062	=item $timer = $timer->cb (sub { my ($timer) = @_; ... })	2258	=item $timer = $timer->cb (sub { my ($timer) = @_; ... })
2063		2259
2064	Set the callback to be called when the timer triggers.	2260	Set the callback to be called when the timer triggers.
2065		2261
2066	=item $tstamp = $timer->at
2067
2068	Return the time this watcher will fire next.
2069
2070	=item $timer = $timer->set ($tstamp)	2262	=item $timer = $timer->set ($tstamp[, $interval])
2071		2263
2072	Set the time the event is generated to $tstamp.	2264	Set the time the event is generated to $tstamp (and optionally specifies a
		2265	new $interval).
2073		2266
2074	=item $timer = $timer->interval ($interval)	2267	=item $timer = $timer->interval ($interval)
2075		2268
2076	Normally (and when C<$interval> is C<0>), the timer will automatically	2269	By default (and when C<$interval> is C<0>), the timer will automatically
2077	stop after it has fired once. If C<$interval> is non-zero, then the timer	2270	stop after it has fired once. If C<$interval> is non-zero, then the timer
2078	is automatically rescheduled at the given intervals.	2271	is automatically rescheduled at the given intervals.
2079		2272
2080	=item $timer = $timer->start	2273	=item $timer = $timer->start
2081		2274
2082	Start the timer.	2275	Start the timer.
2083		2276
2084	=item $timer = $timer->start ($tstamp)	2277	=item $timer = $timer->start ($tstamp[, $interval])
2085		2278
2086	Set the event trigger time to C<$tstamp> and start the timer.	2279	Set the event trigger time to C<$tstamp> and start the timer. Optionally
		2280	also replaces the interval.
2087		2281
2088	=item $timer = $timer->after ($delay)	2282	=item $timer = $timer->after ($delay[, $interval])
2089		2283
2090	Like C<start>, but sets the expiry timer to c<urxvt::NOW + $delay>.	2284	Like C<start>, but sets the expiry timer to c<urxvt::NOW + $delay>.
2091		2285
2092	=item $timer = $timer->stop	2286	=item $timer = $timer->stop
2093		2287
…		…
2224		2418
2225	=back	2419	=back
2226		2420
2227	=head1 AUTHOR	2421	=head1 AUTHOR
2228		2422
2229	Marc Lehmann <pcg@goof.com>	2423	Marc Lehmann <schmorp@schmorp.de>
2230	http://software.schmorp.de/pkg/rxvt-unicode	2424	http://software.schmorp.de/pkg/rxvt-unicode
2231		2425
2232	=cut	2426	=cut
2233		2427
2234	1	2428	1

Diff Legend

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

Comparing rxvt-unicode/src/urxvt.pm (file contents): Revision 1.176 by root, Sat Jul 18 05:59:49 2009 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.176 by root, Sat Jul 18 05:59:49 2009 UTC vs.
Revision 1.215 by root, Thu Jun 7 16:30:58 2012 UTC