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

Comparing rxvt-unicode/src/urxvt.pm (file contents):
Revision 1.170 by root, Tue Sep 23 07:03:13 2008 UTC vs.
Revision 1.216 by root, Sun Jun 10 13:32:55 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
…		…
303	extension will actually grab a physical key just for this function.	305	extension will actually grab a physical key just for this function.
304		306
305	If you want a quake-like animation, tell your window manager to do so	307	If you want a quake-like animation, tell your window manager to do so
306	(fvwm can do it).	308	(fvwm can do it).
307		309
		310	=item overlay-osc
		311
		312	This extension implements some OSC commands to display timed popups on the
		313	screen - useful for status displays from within scripts. You have to read
		314	the sources for more info.
		315
308	=item block-graphics-to-ascii	316	=item block-graphics-to-ascii
309		317
310	A not very useful example of filtering all text output to the terminal	318	A not very useful example of filtering all text output to the terminal
311	by replacing all line-drawing characters (U+2500 .. U+259F) by a	319	by replacing all line-drawing characters (U+2500 .. U+259F) by a
312	similar-looking ascii character.	320	similar-looking ascii character.
…		…
335	URxvt.remote-selection.store: rsh ruth 'cat >/tmp/distributed-selection'	343	URxvt.remote-selection.store: rsh ruth 'cat >/tmp/distributed-selection'
336	URxvt.remote-selection.fetch: rsh ruth 'cat /tmp/distributed-selection'	344	URxvt.remote-selection.fetch: rsh ruth 'cat /tmp/distributed-selection'
337		345
338	=item selection-pastebin	346	=item selection-pastebin
339		347
340	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
341	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
342	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
343	F</tmp> directly.).	351	F</tmp> directly.).
344		352
345	It listens to the C<selection-pastebin:remote-pastebin> keyboard command,	353	It listens to the C<selection-pastebin:remote-pastebin> keyboard command,
…		…
364		372
365	URxvt.selection-pastebin.url: http://www.ta-sa.org/files/txt/%	373	URxvt.selection-pastebin.url: http://www.ta-sa.org/files/txt/%
366		374
367	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
368	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,
369	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
370	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.
371		393
372	=item example-refresh-hooks	394	=item example-refresh-hooks
373		395
374	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
375	window. Illustrates overwriting the refresh callbacks to create your own	397	window. Illustrates overwriting the refresh callbacks to create your own
376	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"
377		412
378	=back	413	=back
379		414
380	=head1 API DOCUMENTATION	415	=head1 API DOCUMENTATION
381		416
…		…
397		432
398	=over 4	433	=over 4
399		434
400	=item $text	435	=item $text
401		436
402	Rxvt-unicodes special way of encoding text, where one "unicode" character	437	Rxvt-unicode's special way of encoding text, where one "unicode" character
403	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.
404		439
405	=item $string	440	=item $string
406		441
407	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
…		…
411	=item $octets	446	=item $octets
412		447
413	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
414	locale-specific way.	449	locale-specific way.
415		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
416	=back	457	=back
417		458
418	=head2 Extension Objects	459	=head2 Extension Objects
419		460
420	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
421	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,
422	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
423	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
424	extensions or other terminals, with the exception of methods and members	465	extensions or other terminals, with the exception of methods and members
425	that begin with an underscore character C<_>: these are reserved for	466	that begin with an underscore character C<_>: these are reserved for
426	internal use.	467	internal use.
…		…
541		582
542	It is called before lines are scrolled out (so rows 0 .. min ($lines - 1,	583	It is called before lines are scrolled out (so rows 0 .. min ($lines - 1,
543	$nrow - 1) represent the lines to be scrolled out). C<$saved> is the total	584	$nrow - 1) represent the lines to be scrolled out). C<$saved> is the total
544	number of lines that will be in the scrollback buffer.	585	number of lines that will be in the scrollback buffer.
545		586
546	=item on_osc_seq $term, $op, $args	587	=item on_osc_seq $term, $op, $args, $resp
547		588
548	Called on every OSC sequence and can be used to suppress it or modify its	589	Called on every OSC sequence and can be used to suppress it or modify its
549	behaviour. The default should be to return an empty list. A true value	590	behaviour. The default should be to return an empty list. A true value
550	suppresses execution of the request completely. Make sure you don't get	591	suppresses execution of the request completely. Make sure you don't get
551	confused by recursive invocations when you output an osc sequence within	592	confused by recursive invocations when you output an OSC sequence within
552	this callback.	593	this callback.
553		594
554	C<on_osc_seq_perl> should be used for new behaviour.	595	C<on_osc_seq_perl> should be used for new behaviour.
555		596
556	=item on_osc_seq_perl $term, $string	597	=item on_osc_seq_perl $term, $args, $resp
557		598
558	Called whenever the B<ESC ] 777 ; string ST> command sequence (OSC =	599	Called whenever the B<ESC ] 777 ; string ST> command sequence (OSC =
559	operating system command) is processed. Cursor position and other state	600	operating system command) is processed. Cursor position and other state
560	information is up-to-date when this happens. For interoperability, the	601	information is up-to-date when this happens. For interoperability, the
561	string should start with the extension name and a colon, to distinguish	602	string should start with the extension name (sans -osc) and a semicolon,
562	it from commands for other extensions, and this might be enforced in the	603	to distinguish it from commands for other extensions, and this might be
563	future.	604	enforced in the future.
		605
		606	For example, C<overlay-osc> uses this:
		607
		608	sub on_osc_seq_perl {
		609	my ($self, $osc, $resp) = @_;
		610
		611	return unless $osc =~ s/^overlay;//;
		612
		613	... process remaining $osc string
		614	}
564		615
565	Be careful not ever to trust (in a security sense) the data you receive,	616	Be careful not ever to trust (in a security sense) the data you receive,
566	as its source can not easily be controlled (e-mail content, messages from	617	as its source can not easily be controlled (e-mail content, messages from
567	other users on the same system etc.).	618	other users on the same system etc.).
		619
		620	For responses, C<$resp> contains the end-of-args separator used by the
		621	sender.
568		622
569	=item on_add_lines $term, $string	623	=item on_add_lines $term, $string
570		624
571	Called whenever text is about to be output, with the text as argument. You	625	Called whenever text is about to be output, with the text as argument. You
572	can filter/change and output the text yourself by returning a true value	626	can filter/change and output the text yourself by returning a true value
…		…
577	=item on_tt_write $term, $octets	631	=item on_tt_write $term, $octets
578		632
579	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
580	suppress or filter tty input.	634	suppress or filter tty input.
581		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
582	=item on_line_update $term, $row	643	=item on_line_update $term, $row
583		644
584	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
585	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
586	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,
…		…
593	later with the already-modified line (e.g. if unrelated parts change), so	654	later with the already-modified line (e.g. if unrelated parts change), so
594	you cannot just toggle rendition bits, but only set them.	655	you cannot just toggle rendition bits, but only set them.
595		656
596	=item on_refresh_begin $term	657	=item on_refresh_begin $term
597		658
598	Called just before the screen gets redrawn. Can be used for overlay	659	Called just before the screen gets redrawn. Can be used for overlay or
599	or similar effects by modify terminal contents in refresh_begin, and	660	similar effects by modifying the terminal contents in refresh_begin, and
600	restoring them in refresh_end. The built-in overlay and selection display	661	restoring them in refresh_end. The built-in overlay and selection display
601	code is run after this hook, and takes precedence.	662	code is run after this hook, and takes precedence.
602		663
603	=item on_refresh_end $term	664	=item on_refresh_end $term
604		665
…		…
611	resource in the @@RXVT_NAME@@(1) manpage).	672	resource in the @@RXVT_NAME@@(1) manpage).
612		673
613	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
614	slightly in the future.	675	slightly in the future.
615		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
616	=item on_resize_all_windows $tern, $new_width, $new_height	684	=item on_resize_all_windows $term, $new_width, $new_height
617		685
618	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
619	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
620	returns TRUE, setting of the window hints is being skipped.	688	returns TRUE, setting of the window hints is being skipped.
621		689
…		…
655		723
656	=item on_map_notify $term, $event	724	=item on_map_notify $term, $event
657		725
658	=item on_unmap_notify $term, $event	726	=item on_unmap_notify $term, $event
659		727
660	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
661	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.
662		730
663	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
664	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
665	(real, not screen-based) row and column under the mouse cursor.	733	(real, not screen-based) row and column under the mouse cursor.
666		734
…		…
676	=item on_wm_delete_window $term, $event	744	=item on_wm_delete_window $term, $event
677		745
678	Called when various types of ClientMessage events are received (all with	746	Called when various types of ClientMessage events are received (all with
679	format=32, WM_PROTOCOLS or WM_PROTOCOLS:WM_DELETE_WINDOW).	747	format=32, WM_PROTOCOLS or WM_PROTOCOLS:WM_DELETE_WINDOW).
680		748
		749	=item on_bell $term
		750
		751	Called on receipt of a bell character.
		752
681	=back	753	=back
682		754
683	=cut	755	=cut
684		756
685	package urxvt;	757	package urxvt;
686		758
687	use utf8;	759	use utf8;
688	use strict;	760	use strict 'vars';
689	use Carp ();	761	use Carp ();
690	use Scalar::Util ();	762	use Scalar::Util ();
691	use List::Util ();	763	use List::Util ();
692		764
693	our $VERSION = 1;	765	our $VERSION = 1;
694	our $TERM;	766	our $TERM;
695	our @TERM_INIT;	767	our @TERM_INIT; # should go, prevents async I/O etc.
696	our @TERM_EXT;	768	our @TERM_EXT; # should go, prevents async I/O etc.
697	our @HOOKNAME;	769	our @HOOKNAME;
698	our %HOOKTYPE = map +($HOOKNAME[$_] => $_), 0..$#HOOKNAME;	770	our %HOOKTYPE = map +($HOOKNAME[$_] => $_), 0..$#HOOKNAME;
699	our %OPTION;	771	our %OPTION;
700		772
701	our $LIBDIR;	773	our $LIBDIR;
…		…
749		821
750	=over 4	822	=over 4
751		823
752	=item urxvt::fatal $errormessage	824	=item urxvt::fatal $errormessage
753		825
754	Fatally aborts execution with the given error message. Avoid at all	826	Fatally aborts execution with the given error message (which should
755	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
756	starts up.	828	is acceptable (and useful) is in the init hook, where it prevents the
		829	terminal from starting up.
757		830
758	=item urxvt::warn $string	831	=item urxvt::warn $string
759		832
760	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
761	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
762	that calls this function.	835	that calls this function.
763		836
764	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
765	correct place, e.g. on stderr of the connecting urxvtc client.	838	correct place, e.g. on stderr of the connecting urxvtc client.
…		…
769	=item @terms = urxvt::termlist	842	=item @terms = urxvt::termlist
770		843
771	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
772	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
773	objects that have perl extensions attached will be returned (because there	846	objects that have perl extensions attached will be returned (because there
774	is no urxvt::term objet associated with others).	847	is no urxvt::term object associated with others).
775		848
776	=item $time = urxvt::NOW	849	=item $time = urxvt::NOW
777		850
778	Returns the "current time" (as per the event loop).	851	Returns the "current time" (as per the event loop).
779		852
…		…
822		895
823	=item $rend = urxvt::OVERLAY_RSTYLE	896	=item $rend = urxvt::OVERLAY_RSTYLE
824		897
825	Return the rendition mask used for overlays by default.	898	Return the rendition mask used for overlays by default.
826		899
827	=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
828		902
829	Return the bit that enabled bold, italic, blink, reverse-video and	903	Return the bit that enabled bold, italic, blink, reverse-video and
830	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
831	the bitset.	905	the bitset.
832		906
…		…
869	};	943	};
870	}	944	}
871		945
872	no warnings 'utf8';	946	no warnings 'utf8';
873		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
874	my $verbosity = $ENV{URXVT_PERL_VERBOSITY};	1008	my $verbosity = $ENV{URXVT_PERL_VERBOSITY};
875		1009
876	sub verbose {	1010	sub verbose {
877	my ($level, $msg) = @_;	1011	my ($level, $msg) = @_;
878	warn "$msg\n" if $level <= $verbosity;	1012	warn "$msg\n" if $level <= $verbosity;
…		…
894		1028
895	open my $fh, "<:raw", $path	1029	open my $fh, "<:raw", $path
896	or die "$path: $!";	1030	or die "$path: $!";
897		1031
898	my $source =	1032	my $source =
899	"package $pkg; use strict; use utf8; no warnings 'utf8';\n"	1033	"package $pkg; use strict 'vars'; use utf8; no warnings 'utf8';\n"
900	. "#line 1 \"$path\"\n{\n"	1034	. "#line 1 \"$path\"\n{\n"
901	. (do { local $/; <$fh> })	1035	. (do { local $/; <$fh> })
902	. "\n};\n1";	1036	. "\n};\n1";
903		1037
904	eval $source	1038	eval $source
…		…
914	sub invoke {	1048	sub invoke {
915	local $TERM = shift;	1049	local $TERM = shift;
916	my $htype = shift;	1050	my $htype = shift;
917		1051
918	if ($htype == 0) { # INIT	1052	if ($htype == 0) { # INIT
919	my @dirs = ((split /:/, $TERM->resource ("perl_lib")), "$LIBDIR/perl");	1053	my @dirs = $TERM->perl_libdirs;
920		1054
921	my %ext_arg;	1055	my %ext_arg;
922		1056
923	{	1057	{
924	my @init = @TERM_INIT;	1058	my @init = @TERM_INIT;
…		…
927	my @pkg = @TERM_EXT;	1061	my @pkg = @TERM_EXT;
928	@TERM_EXT = ();	1062	@TERM_EXT = ();
929	$TERM->register_package ($_) for @pkg;	1063	$TERM->register_package ($_) for @pkg;
930	}	1064	}
931		1065
		1066	for (
		1067	@{ delete $TERM->{perl_ext_3} },
932	for (grep $_, map { split /,/, $TERM->resource ("perl_ext_$_") } 1, 2) {	1068	grep $_, map { split /,/, $TERM->resource ("perl_ext_$_") } 1, 2
		1069	) {
933	if ($_ eq "default") {	1070	if ($_ eq "default") {
934	$ext_arg{$_} \|\|= [] for qw(selection option-popup selection-popup searchable-scrollback readline);	1071	$ext_arg{$_} \|\|= [] for qw(selection option-popup selection-popup searchable-scrollback readline);
935	} elsif (/^-(.*)$/) {	1072	} elsif (/^-(.*)$/) {
936	delete $ext_arg{$1};	1073	delete $ext_arg{$1};
937	} elsif (/^([^<]+)<(.*)>$/) {	1074	} elsif (/^([^<]+)<(.*)>$/) {
…		…
1085	=head2 The C<urxvt::anyevent> Class	1222	=head2 The C<urxvt::anyevent> Class
1086		1223
1087	The sole purpose of this class is to deliver an interface to the	1224	The sole purpose of this class is to deliver an interface to the
1088	C<AnyEvent> module - any module using it will work inside urxvt without	1225	C<AnyEvent> module - any module using it will work inside urxvt without
1089	further programming. The only exception is that you cannot wait on	1226	further programming. The only exception is that you cannot wait on
1090	condition variables, but non-blocking condvar use is ok. What this means	1227	condition variables, but non-blocking condvar use is ok.
1091	is that you cannot use blocking APIs, but the non-blocking variant should	1228
1092	work.	1229	In practical terms this means is that you cannot use blocking APIs, but
		1230	the non-blocking variant should work.
1093		1231
1094	=cut	1232	=cut
1095		1233
1096	our $VERSION = '3.4';	1234	our $VERSION = '5.23';
1097		1235
1098	$INC{"urxvt/anyevent.pm"} = 1; # mark us as there	1236	$INC{"urxvt/anyevent.pm"} = 1; # mark us as there
1099	push @AnyEvent::REGISTRY, [urxvt => urxvt::anyevent::];	1237	push @AnyEvent::REGISTRY, [urxvt => urxvt::anyevent::];
1100		1238
1101	sub timer {	1239	sub timer {
…		…
1103		1241
1104	my $cb = $arg{cb};	1242	my $cb = $arg{cb};
1105		1243
1106	urxvt::timer	1244	urxvt::timer
1107	->new	1245	->new
1108	->start (urxvt::NOW + $arg{after})	1246	->after ($arg{after}, $arg{interval})
1109	->cb (sub {	1247	->cb ($arg{interval} ? $cb : sub {
1110	$_[0]->stop; # need to cancel manually	1248	$_[0]->stop; # need to cancel manually
1111	$cb->();	1249	$cb->();
1112	})	1250	})
1113	}	1251	}
1114		1252
1115	sub io {	1253	sub io {
1116	my ($class, %arg) = @_;	1254	my ($class, %arg) = @_;
1117		1255
1118	my $cb = $arg{cb};	1256	my $cb = $arg{cb};
		1257	my $fd = fileno $arg{fh};
		1258	defined $fd or $fd = $arg{fh};
1119		1259
1120	bless [$arg{fh}, urxvt::iow	1260	bless [$arg{fh}, urxvt::iow
1121	->new	1261	->new
1122	->fd (fileno $arg{fh})	1262	->fd ($fd)
1123	->events (($arg{poll} =~ /r/ ? 1 : 0)	1263	->events (($arg{poll} =~ /r/ ? 1 : 0)
1124	\| ($arg{poll} =~ /w/ ? 2 : 0))	1264	\| ($arg{poll} =~ /w/ ? 2 : 0))
1125	->start	1265	->start
1126	->cb (sub {	1266	->cb ($cb)
1127	$cb->(($_[1] & 1 ? 'r' : '')
1128	. ($_[1] & 2 ? 'w' : ''));
1129	})],
1130	urxvt::anyevent::	1267	], urxvt::anyevent::
		1268	}
		1269
		1270	sub idle {
		1271	my ($class, %arg) = @_;
		1272
		1273	my $cb = $arg{cb};
		1274
		1275	urxvt::iw
		1276	->new
		1277	->start
		1278	->cb ($cb)
		1279	}
		1280
		1281	sub child {
		1282	my ($class, %arg) = @_;
		1283
		1284	my $cb = $arg{cb};
		1285
		1286	urxvt::pw
		1287	->new
		1288	->start ($arg{pid})
		1289	->cb (sub {
		1290	$_[0]->stop; # need to cancel manually
		1291	$cb->($_[0]->rpid, $_[0]->rstatus);
		1292	})
1131	}	1293	}
1132		1294
1133	sub DESTROY {	1295	sub DESTROY {
1134	$_[0][1]->stop;	1296	$_[0][1]->stop;
1135	}	1297	}
1136		1298
		1299	# only needed for AnyEvent < 6 compatibility
1137	sub one_event {	1300	sub one_event {
1138	Carp::croak "AnyEvent->one_event blocking wait unsupported in urxvt, use a non-blocking API";	1301	Carp::croak "AnyEvent->one_event blocking wait unsupported in urxvt, use a non-blocking API";
1139	}	1302	}
1140		1303
1141	package urxvt::term;	1304	package urxvt::term;
…		…
1170	$proxy->enable ($name => $ref);	1333	$proxy->enable ($name => $ref);
1171	}	1334	}
1172	}	1335	}
1173	}	1336	}
1174		1337
		1338	sub perl_libdirs {
		1339	map { split /:/ }
		1340	$_[0]->resource ("perl_lib"),
		1341	$ENV{URXVT_PERL_LIB},
		1342	"$ENV{HOME}/.urxvt/ext",
		1343	"$LIBDIR/perl"
		1344	}
		1345
		1346	sub scan_meta {
		1347	my ($self) = @_;
		1348	my @libdirs = perl_libdirs $self;
		1349
		1350	return if $self->{meta_libdirs} eq join "\x00", @libdirs;
		1351
		1352	my %meta;
		1353
		1354	$self->{meta_libdirs} = join "\x00", @libdirs;
		1355	$self->{meta} = \%meta;
		1356
		1357	for my $dir (reverse @libdirs) {
		1358	opendir my $fh, $dir
		1359	or next;
		1360	for my $ext (readdir $fh) {
		1361	$ext ne "."
		1362	and $ext ne ".."
		1363	and open my $fh, "<", "$dir/$ext"
		1364	or next;
		1365
		1366	while (<$fh>) {
		1367	if (/^#:META:X_RESOURCE:(.*)/) {
		1368	my ($pattern, $type, $desc) = split /:/, $1;
		1369	$pattern =~ s/^%(\.\|$)/$ext$1/g; # % in pattern == extension name
		1370	if ($pattern =~ /[^a-zA-Z0-9\-\.]/) {
		1371	warn "$dir/$ext: meta resource '$pattern' contains illegal characters (not alphanumeric nor . nor *)\n";
		1372	} else {
		1373	$meta{resource}{$pattern} = [$ext, $type, $desc];
		1374	}
		1375	} elsif (/^\s*(?:#\|$)/) {
		1376	# skip other comments and empty lines
		1377	} else {
		1378	last; # stop parsing on first non-empty non-comment line
		1379	}
		1380	}
		1381	}
		1382	}
		1383	}
		1384
1175	=item $term = new urxvt::term $envhashref, $rxvtname, [arg...]	1385	=item $term = new urxvt::term $envhashref, $rxvtname, [arg...]
1176		1386
1177	Creates a new terminal, very similar as if you had started it with system	1387	Creates a new terminal, very similar as if you had started it with system
1178	C<$rxvtname, arg...>. C<$envhashref> must be a reference to a C<%ENV>-like	1388	C<$rxvtname, arg...>. C<$envhashref> must be a reference to a C<%ENV>-like
1179	hash which defines the environment of the new terminal.	1389	hash which defines the environment of the new terminal.
…		…
1233	C<%urxvt::OPTION>. Options not enabled in this binary are not in the hash.	1443	C<%urxvt::OPTION>. Options not enabled in this binary are not in the hash.
1234		1444
1235	Here is a likely non-exhaustive list of option names, please see the	1445	Here is a likely non-exhaustive list of option names, please see the
1236	source file F</src/optinc.h> to see the actual list:	1446	source file F</src/optinc.h> to see the actual list:
1237		1447
1238	borderLess console cursorBlink cursorUnderline hold iconic insecure	1448	borderLess buffered console cursorBlink cursorUnderline hold iconic
1239	intensityStyles jumpScroll loginShell mapAlert meta8 mouseWheelScrollPage	1449	insecure intensityStyles iso14755 iso14755_52 jumpScroll loginShell
1240	override-redirect pastableTabs pointerBlank reverseVideo scrollBar	1450	mapAlert meta8 mouseWheelScrollPage override_redirect pastableTabs
1241	scrollBar_floating scrollBar_right scrollTtyKeypress scrollTtyOutput	1451	pointerBlank reverseVideo scrollBar scrollBar_floating scrollBar_right
1242	scrollWithBuffer secondaryScreen secondaryScroll skipBuiltinGlyphs	1452	scrollTtyKeypress scrollTtyOutput scrollWithBuffer secondaryScreen
1243	transparent tripleclickwords utmpInhibit visualBell	1453	secondaryScroll skipBuiltinGlyphs skipScroll transparent tripleclickwords
		1454	urgentOnBell utmpInhibit visualBell
1244		1455
1245	=item $value = $term->resource ($name[, $newval])	1456	=item $value = $term->resource ($name[, $newval])
1246		1457
1247	Returns the current resource value associated with a given name and	1458	Returns the current resource value associated with a given name and
1248	optionally sets a new value. Setting values is most useful in the C<init>	1459	optionally sets a new value. Setting values is most useful in the C<init>
…		…
1261		1472
1262	Here is a likely non-exhaustive list of resource names, not all of which	1473	Here is a likely non-exhaustive list of resource names, not all of which
1263	are supported in every build, please see the source file F</src/rsinc.h>	1474	are supported in every build, please see the source file F</src/rsinc.h>
1264	to see the actual list:	1475	to see the actual list:
1265		1476
1266	answerbackstring backgroundPixmap backspace_key boldFont boldItalicFont	1477	answerbackstring backgroundPixmap backspace_key blendtype blurradius
1267	borderLess chdir color cursorBlink cursorUnderline cutchars delete_key	1478	boldFont boldItalicFont borderLess buffered chdir color cursorBlink
1268	display_name embed ext_bwidth fade font geometry hold iconName	1479	cursorUnderline cutchars delete_key depth display_name embed ext_bwidth
1269	imFont imLocale inputMethod insecure int_bwidth intensityStyles	1480	fade font geometry hold iconName iconfile imFont imLocale inputMethod
		1481	insecure int_bwidth intensityStyles iso14755 iso14755_52 italicFont
1270	italicFont jumpScroll lineSpace loginShell mapAlert meta8 modifier	1482	jumpScroll letterSpace lineSpace loginShell mapAlert meta8 modifier
1271	mouseWheelScrollPage name override_redirect pastableTabs path perl_eval	1483	mouseWheelScrollPage name override_redirect pastableTabs path perl_eval
1272	perl_ext_1 perl_ext_2 perl_lib pointerBlank pointerBlankDelay	1484	perl_ext_1 perl_ext_2 perl_lib pointerBlank pointerBlankDelay
1273	preeditType print_pipe pty_fd reverseVideo saveLines scrollBar	1485	preeditType print_pipe pty_fd reverseVideo saveLines scrollBar
1274	scrollBar_align scrollBar_floating scrollBar_right scrollBar_thickness	1486	scrollBar_align scrollBar_floating scrollBar_right scrollBar_thickness
1275	scrollTtyKeypress scrollTtyOutput scrollWithBuffer scrollstyle	1487	scrollTtyKeypress scrollTtyOutput scrollWithBuffer scrollstyle
1276	secondaryScreen secondaryScroll shade term_name title	1488	secondaryScreen secondaryScroll shade skipBuiltinGlyphs skipScroll
1277	transient_for transparent transparent_all tripleclickwords utmpInhibit	1489	term_name title transient_for transparent tripleclickwords urgentOnBell
1278	visualBell	1490	utmpInhibit visualBell
1279		1491
1280	=cut	1492	=cut
1281		1493
1282	sub resource($$;$) {	1494	sub resource($$;$) {
1283	my ($self, $name) = (shift, shift);	1495	my ($self, $name) = (shift, shift);
…		…
1294		1506
1295	This method should only be called during the C<on_start> hook, as there is	1507	This method should only be called during the C<on_start> hook, as there is
1296	only one resource database per display, and later invocations might return	1508	only one resource database per display, and later invocations might return
1297	the wrong resources.	1509	the wrong resources.
1298		1510
1299	=item $success = $term->parse_keysym ($keysym_spec, $command_string)	1511	=item $value = $term->x_resource_boolean ($pattern)
1300		1512
		1513	Like C<x_resource>, above, but interprets the string value as a boolean
		1514	and returns C<1> for true values, C<0> for false values and C<undef> if
		1515	the resource or option isn't specified.
		1516
		1517	You should always use this method to parse boolean resources.
		1518
		1519	=cut
		1520
		1521	sub x_resource_boolean {
		1522	my $res = &x_resource;
		1523
		1524	$res =~ /^\s(?:true\|yes\|on\|1)\s$/i ? 1 : defined $res && 0
		1525	}
		1526
		1527	=item $success = $term->parse_keysym ($key, $octets)
		1528
1301	Adds a keymap translation exactly as specified via a resource. See the	1529	Adds a key binding exactly as specified via a resource. See the
1302	C<keysym> resource in the @@RXVT_NAME@@(1) manpage.	1530	C<keysym> resource in the @@RXVT_NAME@@(1) manpage.
		1531
		1532	=item $term->register_command ($keysym, $modifiermask, $string)
		1533
		1534	Adds a key binding. This is a lower level api compared to
		1535	C<parse_keysym>, as it expects a parsed key description, and can be
		1536	used only inside either the C<on_init> hook, to add a binding, or the
		1537	C<on_register_command> hook, to modify a parsed binding.
1303		1538
1304	=item $rend = $term->rstyle ([$new_rstyle])	1539	=item $rend = $term->rstyle ([$new_rstyle])
1305		1540
1306	Return and optionally change the current rendition. Text that is output by	1541	Return and optionally change the current rendition. Text that is output by
1307	the terminal application will use this style.	1542	the terminal application will use this style.
…		…
1315		1550
1316	=item ($row, $col) = $term->selection_beg ([$row, $col])	1551	=item ($row, $col) = $term->selection_beg ([$row, $col])
1317		1552
1318	=item ($row, $col) = $term->selection_end ([$row, $col])	1553	=item ($row, $col) = $term->selection_end ([$row, $col])
1319		1554
1320	Return the current values of the selection mark, begin or end positions,	1555	Return the current values of the selection mark, begin or end positions.
1321	and optionally set them to new values.	1556
		1557	When arguments are given, then the selection coordinates are set to
		1558	C<$row> and C<$col>, and the selection screen is set to the current
		1559	screen.
		1560
		1561	=item $screen = $term->selection_screen ([$screen])
		1562
		1563	Returns the current selection screen, and then optionally sets it.
1322		1564
1323	=item $term->selection_make ($eventtime[, $rectangular])	1565	=item $term->selection_make ($eventtime[, $rectangular])
1324		1566
1325	Tries to make a selection as set by C<selection_beg> and	1567	Tries to make a selection as set by C<selection_beg> and
1326	C<selection_end>. If C<$rectangular> is true (default: false), a	1568	C<selection_end>. If C<$rectangular> is true (default: false), a
1327	rectangular selection will be made. This is the prefered function to make	1569	rectangular selection will be made. This is the preferred function to make
1328	a selection.	1570	a selection.
1329		1571
1330	=item $success = $term->selection_grab ($eventtime)	1572	=item $success = $term->selection_grab ($eventtime[, $clipboard])
1331		1573
1332	Try to request the primary selection text from the server (for example, as	1574	Try to acquire ownership of the primary (clipboard if C<$clipboard> is
		1575	true) selection from the server. The corresponding text can be set
1333	set by the next method). No visual feedback will be given. This function	1576	with the next method. No visual feedback will be given. This function
1334	is mostly useful from within C<on_sel_grab> hooks.	1577	is mostly useful from within C<on_sel_grab> hooks.
1335		1578
1336	=item $oldtext = $term->selection ([$newtext])	1579	=item $oldtext = $term->selection ([$newtext, $clipboard])
1337		1580
1338	Return the current selection text and optionally replace it by C<$newtext>.	1581	Return the current selection (clipboard if C<$clipboard> is true) text
		1582	and optionally replace it by C<$newtext>.
		1583
		1584	=item $term->selection_clear ([$clipboard])
		1585
		1586	Revoke ownership of the primary (clipboard if C<$clipboard> is true) selection.
1339		1587
1340	=item $term->overlay_simple ($x, $y, $text)	1588	=item $term->overlay_simple ($x, $y, $text)
1341		1589
1342	Create a simple multi-line overlay box. See the next method for details.	1590	Create a simple multi-line overlay box. See the next method for details.
1343		1591
…		…
1373		1621
1374	The methods currently supported on C<urxvt::overlay> objects are:	1622	The methods currently supported on C<urxvt::overlay> objects are:
1375		1623
1376	=over 4	1624	=over 4
1377		1625
1378	=item $overlay->set ($x, $y, $text, $rend)	1626	=item $overlay->set ($x, $y, $text[, $rend])
1379		1627
1380	Similar to C<< $term->ROW_t >> and C<< $term->ROW_r >> in that it puts	1628	Similar to C<< $term->ROW_t >> and C<< $term->ROW_r >> in that it puts
1381	text in rxvt-unicode's special encoding and an array of rendition values	1629	text in rxvt-unicode's special encoding and an array of rendition values
1382	at a specific position inside the overlay.	1630	at a specific position inside the overlay.
		1631
		1632	If C<$rend> is missing, then the rendition will not be changed.
1383		1633
1384	=item $overlay->hide	1634	=item $overlay->hide
1385		1635
1386	If visible, hide the overlay, but do not destroy it.	1636	If visible, hide the overlay, but do not destroy it.
1387		1637
…		…
1469	locale-specific encoding of the terminal and can contain command sequences	1719	locale-specific encoding of the terminal and can contain command sequences
1470	(escape codes) that will be interpreted.	1720	(escape codes) that will be interpreted.
1471		1721
1472	=item $term->tt_write ($octets)	1722	=item $term->tt_write ($octets)
1473		1723
1474	Write the octets given in C<$data> to the tty (i.e. as program input). To	1724	Write the octets given in C<$octets> to the tty (i.e. as program input). To
1475	pass characters instead of octets, you should convert your strings first	1725	pass characters instead of octets, you should convert your strings first
1476	to the locale-specific encoding using C<< $term->locale_encode >>.	1726	to the locale-specific encoding using C<< $term->locale_encode >>.
		1727
		1728	=item $term->tt_paste ($octets)
		1729
		1730	Write the octets given in C<$octets> to the tty as a paste, converting NL to
		1731	CR and bracketing the data with control sequences if bracketed paste mode
		1732	is set.
1477		1733
1478	=item $old_events = $term->pty_ev_events ([$new_events])	1734	=item $old_events = $term->pty_ev_events ([$new_events])
1479		1735
1480	Replaces the event mask of the pty watcher by the given event mask. Can	1736	Replaces the event mask of the pty watcher by the given event mask. Can
1481	be used to suppress input and output handling to the pty/tty. See the	1737	be used to suppress input and output handling to the pty/tty. See the
…		…
1499		1755
1500	Adds the specified events to the vt event mask. Useful e.g. when you want	1756	Adds the specified events to the vt event mask. Useful e.g. when you want
1501	to receive pointer events all the times:	1757	to receive pointer events all the times:
1502		1758
1503	$term->vt_emask_add (urxvt::PointerMotionMask);	1759	$term->vt_emask_add (urxvt::PointerMotionMask);
		1760
		1761	=item $term->set_urgency ($set)
		1762
		1763	Enable/disable the urgency hint on the toplevel window.
1504		1764
1505	=item $term->focus_in	1765	=item $term->focus_in
1506		1766
1507	=item $term->focus_out	1767	=item $term->focus_out
1508		1768
…		…
1795	Calls XAllowEvents with both ReplayPointer and ReplayKeyboard for the most	2055	Calls XAllowEvents with both ReplayPointer and ReplayKeyboard for the most
1796	recent grab.	2056	recent grab.
1797		2057
1798	=item $term->ungrab	2058	=item $term->ungrab
1799		2059
1800	Calls XUngrab for the most recent grab. Is called automatically on	2060	Calls XUngrabPointer and XUngrabKeyboard for the most recent grab. Is called automatically on
1801	evaluation errors, as it is better to lose the grab in the error case as	2061	evaluation errors, as it is better to lose the grab in the error case as
1802	the session.	2062	the session.
1803		2063
1804	=item $atom = $term->XInternAtom ($atom_name[, $only_if_exists])	2064	=item $atom = $term->XInternAtom ($atom_name[, $only_if_exists])
1805		2065
…		…
1825		2085
1826	=item ($x, $y, $child_window) = $term->XTranslateCoordinates ($src, $dst, $x, $y)	2086	=item ($x, $y, $child_window) = $term->XTranslateCoordinates ($src, $dst, $x, $y)
1827		2087
1828	=item $term->XChangeInput ($window, $add_events[, $del_events])	2088	=item $term->XChangeInput ($window, $add_events[, $del_events])
1829		2089
		2090	=item $keysym = $term->XStringToKeysym ($string)
		2091
		2092	=item $string = $term->XKeysymToString ($keysym)
		2093
1830	Various X or X-related functions. The C<$term> object only serves as	2094	Various X or X-related functions. The C<$term> object only serves as
1831	the source of the display, otherwise those functions map more-or-less	2095	the source of the display, otherwise those functions map more-or-less
1832	directory onto the X functions of the same name.	2096	directly onto the X functions of the same name.
1833		2097
1834	=back	2098	=back
1835		2099
1836	=cut	2100	=cut
1837		2101
…		…
1994		2258
1995	=item $timer = $timer->cb (sub { my ($timer) = @_; ... })	2259	=item $timer = $timer->cb (sub { my ($timer) = @_; ... })
1996		2260
1997	Set the callback to be called when the timer triggers.	2261	Set the callback to be called when the timer triggers.
1998		2262
1999	=item $tstamp = $timer->at
2000
2001	Return the time this watcher will fire next.
2002
2003	=item $timer = $timer->set ($tstamp)	2263	=item $timer = $timer->set ($tstamp[, $interval])
2004		2264
2005	Set the time the event is generated to $tstamp.	2265	Set the time the event is generated to $tstamp (and optionally specifies a
		2266	new $interval).
2006		2267
2007	=item $timer = $timer->interval ($interval)	2268	=item $timer = $timer->interval ($interval)
2008		2269
2009	Normally (and when C<$interval> is C<0>), the timer will automatically	2270	By default (and when C<$interval> is C<0>), the timer will automatically
2010	stop after it has fired once. If C<$interval> is non-zero, then the timer	2271	stop after it has fired once. If C<$interval> is non-zero, then the timer
2011	is automatically rescheduled at the given intervals.	2272	is automatically rescheduled at the given intervals.
2012		2273
2013	=item $timer = $timer->start	2274	=item $timer = $timer->start
2014		2275
2015	Start the timer.	2276	Start the timer.
2016		2277
2017	=item $timer = $timer->start ($tstamp)	2278	=item $timer = $timer->start ($tstamp[, $interval])
2018		2279
2019	Set the event trigger time to C<$tstamp> and start the timer.	2280	Set the event trigger time to C<$tstamp> and start the timer. Optionally
		2281	also replaces the interval.
2020		2282
2021	=item $timer = $timer->after ($delay)	2283	=item $timer = $timer->after ($delay[, $interval])
2022		2284
2023	Like C<start>, but sets the expiry timer to c<urxvt::NOW + $delay>.	2285	Like C<start>, but sets the expiry timer to c<urxvt::NOW + $delay>.
2024		2286
2025	=item $timer = $timer->stop	2287	=item $timer = $timer->stop
2026		2288
…		…
2157		2419
2158	=back	2420	=back
2159		2421
2160	=head1 AUTHOR	2422	=head1 AUTHOR
2161		2423
2162	Marc Lehmann <pcg@goof.com>	2424	Marc Lehmann <schmorp@schmorp.de>
2163	http://software.schmorp.de/pkg/rxvt-unicode	2425	http://software.schmorp.de/pkg/rxvt-unicode
2164		2426
2165	=cut	2427	=cut
2166		2428
2167	1	2429	1

Diff Legend

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

Comparing rxvt-unicode/src/urxvt.pm (file contents): Revision 1.170 by root, Tue Sep 23 07:03:13 2008 UTC vs. Revision 1.216 by root, Sun Jun 10 13:32:55 2012 UTC

Diff Legend

Comparing rxvt-unicode/src/urxvt.pm (file contents):
Revision 1.170 by root, Tue Sep 23 07:03:13 2008 UTC vs.
Revision 1.216 by root, Sun Jun 10 13:32:55 2012 UTC