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

Comparing rxvt-unicode/src/urxvt.pm (file contents):
Revision 1.95 by elmex, Tue Jan 17 13:19:45 2006 UTC vs.
Revision 1.115 by root, Fri Jan 20 15:57:21 2006 UTC

…		…
34	find them in F<@@RXVT_LIBDIR@@/urxvt/perl/>.	34	find them in F<@@RXVT_LIBDIR@@/urxvt/perl/>.
35		35
36	You can activate them like this:	36	You can activate them like this:
37		37
38	@@RXVT_NAME@@ -pe <extensionname>	38	@@RXVT_NAME@@ -pe <extensionname>
		39
		40	Or by adding them to the resource for extensions loaded by default:
		41
		42	URxvt.perl-ext-common: default,automove-background,selection-autotransform
39		43
40	=over 4	44	=over 4
41		45
42	=item selection (enabled by default)	46	=item selection (enabled by default)
43		47
…		…
76		80
77	Rot-13 the selection when activated. Used via keyboard trigger:	81	Rot-13 the selection when activated. Used via keyboard trigger:
78		82
79	URxvt.keysym.C-M-r: perl:selection:rot13	83	URxvt.keysym.C-M-r: perl:selection:rot13
80		84
81	=item remote-pastebin
82
83	Upload the selection as textfile to a remote site.
84
85	URxvt.keysym.C-M-e: perl:selection:remote-pastebin
86
87	To set the command to upload the file set this resource:
88
89	URxvt.selection-pastebin-cmd: rsync -apP % ruth:/var/www/www.ta-sa.org/files/txt/.
90
91	The % is the placeholder for the textfile. The name of the textfile is the hex encoded
92	md5 sum of the selection.
93	After an successful upload the selection will be replaced by the following url
94	(the % is the placeholder for the filename):
95
96	URxvt.selection-pastebin-url: http://www.ta-sa.org/files/txt/%
97
98	=back	85	=back
99		86
100	=item option-popup (enabled by default)	87	=item option-popup (enabled by default)
101		88
102	Binds a popup menu to Ctrl-Button2 that lets you toggle (some) options at	89	Binds a popup menu to Ctrl-Button2 that lets you toggle (some) options at
…		…
105	=item selection-popup (enabled by default)	92	=item selection-popup (enabled by default)
106		93
107	Binds a popup menu to Ctrl-Button3 that lets you convert the selection	94	Binds a popup menu to Ctrl-Button3 that lets you convert the selection
108	text into various other formats/action (such as uri unescaping, perl	95	text into various other formats/action (such as uri unescaping, perl
109	evalution, web-browser starting etc.), depending on content.	96	evalution, web-browser starting etc.), depending on content.
		97
		98	Other extensions can extend this popup menu by pushing a code reference
		99	onto C<@{ $term->{selection_popup_hook} }>, that is called whenever the
		100	popup is displayed.
		101
		102	It's sole argument is the popup menu, which can be modified. The selection
		103	is in C<$_>, which can be used to decide wether to add something or not.
		104	It should either return nothing or a string and a code reference. The
		105	string will be used as button text and the code reference will be called
		106	when the button gets activated and should transform C<$_>.
		107
		108	The following will add an entry C<a to b> that transforms all C<a>s in
		109	the selection to C<b>s, but only if the selection currently contains any
		110	C<a>s:
		111
		112	push @{ $self->{term}{selection_popup_hook} }, sub {
		113	/a/ ? ("a to be" => sub { s/a/b/g }
		114	: ()
		115	};
110		116
111	=item searchable-scrollback<hotkey> (enabled by default)	117	=item searchable-scrollback<hotkey> (enabled by default)
112		118
113	Adds regex search functionality to the scrollback buffer, triggered	119	Adds regex search functionality to the scrollback buffer, triggered
114	by a hotkey (default: C<M-s>). While in search mode, normal terminal	120	by a hotkey (default: C<M-s>). While in search mode, normal terminal
…		…
142	URxvt.selection-autotransform.0: s/^([^:[:space:]]+):(\\d+):?$/vi +$2 \\Q$1\\E\\x0d/	148	URxvt.selection-autotransform.0: s/^([^:[:space:]]+):(\\d+):?$/vi +$2 \\Q$1\\E\\x0d/
143		149
144	And this example matches the same,but replaces it with vi-commands you can	150	And this example matches the same,but replaces it with vi-commands you can
145	paste directly into your (vi :) editor:	151	paste directly into your (vi :) editor:
146		152
147	URxvt.selection-autotransform.0: s/^([^:[:space:]]+(\\d+):?$/\\x1b:e \\Q$1\\E\\x0d:$2\\x0d/	153	URxvt.selection-autotransform.0: s/^([^:[:space:]]+(\\d+):?$/:e \\Q$1\\E\\x0d:$2\\x0d/
148		154
149	Of course, this can be modified to suit your needs and your editor :)	155	Of course, this can be modified to suit your needs and your editor :)
150		156
151	To expand the example above to typical perl error messages ("XXX at	157	To expand the example above to typical perl error messages ("XXX at
152	FILENAME line YYY."), you need a slightly more elaborate solution:	158	FILENAME line YYY."), you need a slightly more elaborate solution:
153		159
154	URxvt.selection.pattern-0: ( at .*? line \\d+\\.)	160	URxvt.selection.pattern-0: ( at .*? line \\d+[,.])
155	URxvt.selection-autotransform.0: s/^ at (.*?) line (\\d+)\\.$/\x1b:e \\Q$1\E\\x0d:$2\\x0d/	161	URxvt.selection-autotransform.0: s/^ at (.*?) line (\\d+)[,.]$/:e \\Q$1\E\\x0d:$2\\x0d/
156		162
157	The first line tells the selection code to treat the unchanging part of	163	The first line tells the selection code to treat the unchanging part of
158	every error message as a selection pattern, and the second line transforms	164	every error message as a selection pattern, and the second line transforms
159	the message into vi commands to load the file.	165	the message into vi commands to load the file.
		166
		167	=item tabbed
		168
		169	This transforms the terminal into a tabbar with additional terminals, that
		170	is, it implements what is commonly refered to as "tabbed terminal". The topmost line
		171	displays a "[NEW]" button, which, when clicked, will add a new tab, followed by one
		172	button per tab.
		173
		174	Clicking a button will activate that tab. Pressing Shift-Left and
		175	Shift-Right will switch to the tab left or right of the current one.
160		176
161	=item mark-urls	177	=item mark-urls
162		178
163	Uses per-line display filtering (C<on_line_update>) to underline urls and	179	Uses per-line display filtering (C<on_line_update>) to underline urls and
164	make them clickable. When middle-clicked, the program specified in the	180	make them clickable. When middle-clicked, the program specified in the
165	resource C<urlLauncher> (default C<x-www-browser>) will be started with	181	resource C<urlLauncher> (default C<x-www-browser>) will be started with
166	the URL as first argument.	182	the URL as first argument.
167		183
		184	=item automove-background
		185
		186	This is basically a one-line extension that dynamically changes the background pixmap offset
		187	to the window position, in effect creating the same effect as pseudo transparency with
		188	a custom pixmap. No scaling is supported in this mode. Exmaple:
		189
		190	@@RXVT_NAME@@ -pixmap background.xpm -pe automove-background
		191
168	=item block-graphics-to-ascii	192	=item block-graphics-to-ascii
169		193
170	A not very useful example of filtering all text output to the terminal,	194	A not very useful example of filtering all text output to the terminal,
171	by replacing all line-drawing characters (U+2500 .. U+259F) by a	195	by replacing all line-drawing characters (U+2500 .. U+259F) by a
172	similar-looking ascii character.	196	similar-looking ascii character.
…		…
178	=item example-refresh-hooks	202	=item example-refresh-hooks
179		203
180	Displays a very simple digital clock in the upper right corner of the	204	Displays a very simple digital clock in the upper right corner of the
181	window. Illustrates overwriting the refresh callbacks to create your own	205	window. Illustrates overwriting the refresh callbacks to create your own
182	overlays or changes.	206	overlays or changes.
		207
		208	=item selection-pastebin
		209
		210	This is a little rarely useful extension that Uploads the selection as
		211	textfile to a remote site (or does other things). (The implementation is
		212	not currently secure for use in a multiuser environment as it writes to
		213	F</tmp> directly.).
		214
		215	It listens to the C<selection-pastebin:remote-pastebin> keyboard command,
		216	i.e.
		217
		218	URxvt.keysym.C-M-e: perl:selection-pastebin:remote-pastebin
		219
		220	Pressing this combination runs a command with C<%> replaced by the name of
		221	the textfile. This command can be set via a resource:
		222
		223	URxvt.selection-pastebin.cmd: rsync -apP % ruth:/var/www/www.ta-sa.org/files/txt/.
		224
		225	And the default is likely not useful to anybody but the few people around
		226	here :)
		227
		228	The name of the textfile is the hex encoded md5 sum of the selection, so
		229	the same content should lead to the same filename.
		230
		231	After a successful upload the selection will be replaced by the text given
		232	in the C<selection-pastebin-url> resource (again, the % is the placeholder
		233	for the filename):
		234
		235	URxvt.selection-pastebin.url: http://www.ta-sa.org/files/txt/%
183		236
184	=back	237	=back
185		238
186	=head1 API DOCUMENTATION	239	=head1 API DOCUMENTATION
187		240
…		…
260	called whenever the relevant event happens.	313	called whenever the relevant event happens.
261		314
262	The first argument passed to them is an extension oject as described in	315	The first argument passed to them is an extension oject as described in
263	the in the C<Extension Objects> section.	316	the in the C<Extension Objects> section.
264		317
265	B<All> of these hooks must return a boolean value. If it is true, then the	318	B<All> of these hooks must return a boolean value. If any of the called
266	event counts as being I<consumed>, and the invocation of other hooks is	319	hooks returns true, then the event counts as being I<consumed>, and the
267	skipped, and the relevant action might not be carried out by the C++ code.	320	relevant action might not be carried out by the C++ code.
268		321
269	I<< When in doubt, return a false value (preferably C<()>). >>	322	I<< When in doubt, return a false value (preferably C<()>). >>
270		323
271	=over 4	324	=over 4
272		325
273	=item on_init $term	326	=item on_init $term
274		327
275	Called after a new terminal object has been initialized, but before	328	Called after a new terminal object has been initialized, but before
276	windows are created or the command gets run. Most methods are unsafe to	329	windows are created or the command gets run. Most methods are unsafe to
277	call or deliver senseless data, as terminal size and other characteristics	330	call or deliver senseless data, as terminal size and other characteristics
278	have not yet been determined. You can safely query and change resources,	331	have not yet been determined. You can safely query and change resources
279	though.	332	and options, though. For many purposes the C<on_start> hook is a better
		333	place.
		334
		335	=item on_start $term
		336
		337	Called at the very end of initialisation of a new terminal, just before
		338	trying to map (display) the toplevel and returning to the mainloop.
		339
		340	=item on_destroy $term
		341
		342	Called whenever something tries to destroy terminal, before doing anything
		343	yet. If this hook returns true, then destruction is skipped, but this is
		344	rarely a good idea.
280		345
281	=item on_reset $term	346	=item on_reset $term
282		347
283	Called after the screen is "reset" for any reason, such as resizing or	348	Called after the screen is "reset" for any reason, such as resizing or
284	control sequences. Here is where you can react on changes to size-related	349	control sequences. Here is where you can react on changes to size-related
285	variables.	350	variables.
286		351
287	=item on_start $term	352	=item on_child_start $term, $pid
288		353
289	Called at the very end of initialisation of a new terminal, just before	354	Called just after the child process has been C<fork>ed.
290	returning to the mainloop.	355
		356	=item on_child_exit $term, $status
		357
		358	Called just after the child process has exited. C<$status> is the status
		359	from C<waitpid>.
291		360
292	=item on_sel_make $term, $eventtime	361	=item on_sel_make $term, $eventtime
293		362
294	Called whenever a selection has been made by the user, but before the	363	Called whenever a selection has been made by the user, but before the
295	selection text is copied, so changes to the beginning, end or type of the	364	selection text is copied, so changes to the beginning, end or type of the
…		…
404	=item on_focus_out $term	473	=item on_focus_out $term
405		474
406	Called wheneever the window loses keyboard focus, before rxvt-unicode does	475	Called wheneever the window loses keyboard focus, before rxvt-unicode does
407	focus out processing.	476	focus out processing.
408		477
		478	=item on_configure_notify $term, $event
		479
409	=item on_key_press $term, $event, $keysym, $octets	480	=item on_key_press $term, $event, $keysym, $octets
410		481
411	=item on_key_release $term, $event, $keysym	482	=item on_key_release $term, $event, $keysym
412		483
413	=item on_button_press $term, $event	484	=item on_button_press $term, $event
…		…
429		500
430	C<on_key_press> additionally receives the string rxvt-unicode would	501	C<on_key_press> additionally receives the string rxvt-unicode would
431	output, if any, in locale-specific encoding.	502	output, if any, in locale-specific encoding.
432		503
433	subwindow.	504	subwindow.
		505
		506	=item on_client_message $term, $event
		507
		508	=item on_wm_protocols $term, $event
		509
		510	=item on_wm_delete_window $term, $event
		511
		512	Called when various types of ClientMessage events are received (all with
		513	format=32, WM_PROTOCOLS or WM_PROTOCOLS:WM_DELETE_WINDOW).
434		514
435	=back	515	=back
436		516
437	=cut	517	=cut
438		518
…		…
444	use Scalar::Util ();	524	use Scalar::Util ();
445	use List::Util ();	525	use List::Util ();
446		526
447	our $VERSION = 1;	527	our $VERSION = 1;
448	our $TERM;	528	our $TERM;
		529	our @TERM_INIT;
		530	our @TERM_EXT;
449	our @HOOKNAME;	531	our @HOOKNAME;
450	our %HOOKTYPE = map +($HOOKNAME[$_] => $_), 0..$#HOOKNAME;	532	our %HOOKTYPE = map +($HOOKNAME[$_] => $_), 0..$#HOOKNAME;
451	our %OPTION;	533	our %OPTION;
452		534
453	our $LIBDIR;	535	our $LIBDIR;
…		…
475	=item $urxvt::TERM	557	=item $urxvt::TERM
476		558
477	The current terminal. This variable stores the current C<urxvt::term>	559	The current terminal. This variable stores the current C<urxvt::term>
478	object, whenever a callback/hook is executing.	560	object, whenever a callback/hook is executing.
479		561
		562	=item @urxvt::TERM_INIT
		563
		564	All coderefs in this array will be called as methods of the next newly
		565	created C<urxvt::term> object (during the C<on_init> phase). The array
		566	gets cleared before the codereferences that were in it are being executed,
		567	so coderefs can push themselves onto it again if they so desire.
		568
		569	This complements to the perl-eval commandline option, but gets executed
		570	first.
		571
		572	=item @urxvt::TERM_EXT
		573
		574	Works similar to C<@TERM_INIT>, but contains perl package/class names, which
		575	get registered as normal extensions after calling the hooks in C<@TERM_INIT>
		576	but before other extensions. Gets cleared just like C<@TERM_INIT>.
		577
480	=back	578	=back
481		579
482	=head2 Functions in the C<urxvt> Package	580	=head2 Functions in the C<urxvt> Package
483		581
484	=over 4	582	=over 4
…		…
497		595
498	Using this function has the advantage that its output ends up in the	596	Using this function has the advantage that its output ends up in the
499	correct place, e.g. on stderr of the connecting urxvtc client.	597	correct place, e.g. on stderr of the connecting urxvtc client.
500		598
501	Messages have a size limit of 1023 bytes currently.	599	Messages have a size limit of 1023 bytes currently.
502
503	=item $is_safe = urxvt::safe
504
505	Returns true when it is safe to do potentially unsafe things, such as
506	evaluating perl code specified by the user. This is true when urxvt was
507	started setuid or setgid.
508		600
509	=item $time = urxvt::NOW	601	=item $time = urxvt::NOW
510		602
511	Returns the "current time" (as per the event loop).	603	Returns the "current time" (as per the event loop).
512		604
…		…
589	=back	681	=back
590		682
591	=cut	683	=cut
592		684
593	BEGIN {	685	BEGIN {
594	urxvt->bootstrap;
595
596	# overwrite perl's warn	686	# overwrite perl's warn
597	*CORE::GLOBAL::warn = sub {	687	*CORE::GLOBAL::warn = sub {
598	my $msg = join "", @_;	688	my $msg = join "", @_;
599	$msg .= "\n"	689	$msg .= "\n"
600	unless $msg =~ /\n$/;	690	unless $msg =~ /\n$/;
601	urxvt::warn ($msg);	691	urxvt::warn ($msg);
602	};	692	};
603
604	# %ENV is the original startup environment
605	delete $ENV{IFS};
606	delete $ENV{CDPATH};
607	delete $ENV{BASH_ENV};
608	$ENV{PATH} = "/bin:/sbin:/usr/bin:/usr/sbin:/usr/local/bin:/usr/local/sbin:/opt/bin:/opt/sbin";
609	}	693	}
610		694
611	my $verbosity = $ENV{URXVT_PERL_VERBOSITY};	695	my $verbosity = $ENV{URXVT_PERL_VERBOSITY};
612		696
613	sub verbose {	697	sub verbose {
614	my ($level, $msg) = @_;	698	my ($level, $msg) = @_;
615	warn "$msg\n" if $level <= $verbosity;	699	warn "$msg\n" if $level <= $verbosity;
616	}	700	}
617		701
618	my $extension_pkg = "extension0000";
619	my %extension_pkg;	702	my %extension_pkg;
620		703
621	# load a single script into its own package, once only	704	# load a single script into its own package, once only
622	sub extension_package($) {	705	sub extension_package($) {
623	my ($path) = @_;	706	my ($path) = @_;
624		707
625	$extension_pkg{$path} \|\|= do {	708	$extension_pkg{$path} \|\|= do {
626	my $pkg = "urxvt::" . ($extension_pkg++);	709	$path =~ /([^\/\\]+)$/;
		710	my $pkg = $1;
		711	$pkg =~ s/[^[:word:]]/_/g;
		712	$pkg = "urxvt::ext::$pkg";
627		713
628	verbose 3, "loading extension '$path' into package '$pkg'";	714	verbose 3, "loading extension '$path' into package '$pkg'";
629		715
630	open my $fh, "<:raw", $path	716	open my $fh, "<:raw", $path
631	or die "$path: $!";	717	or die "$path: $!";
632		718
633	my $source = untaint	719	my $source =
634	"package $pkg; use strict; use utf8;\n"	720	"package $pkg; use strict; use utf8;\n"
635	. "use base urxvt::term::extension::;\n"
636	. "#line 1 \"$path\"\n{\n"	721	. "#line 1 \"$path\"\n{\n"
637	. (do { local $/; <$fh> })	722	. (do { local $/; <$fh> })
638	. "\n};\n1";	723	. "\n};\n1";
639		724
640	eval $source	725	eval $source
…		…
654	if ($htype == 0) { # INIT	739	if ($htype == 0) { # INIT
655	my @dirs = ((split /:/, $TERM->resource ("perl_lib")), "$LIBDIR/perl");	740	my @dirs = ((split /:/, $TERM->resource ("perl_lib")), "$LIBDIR/perl");
656		741
657	my %ext_arg;	742	my %ext_arg;
658		743
		744	{
		745	my @init = @TERM_INIT;
		746	@TERM_INIT = ();
		747	$_->($TERM) for @init;
		748	my @pkg = @TERM_EXT;
		749	@TERM_EXT = ();
		750	$TERM->register_package ($_) for @pkg;
		751	}
		752
659	for (map { split /,/, $TERM->resource ("perl_ext_$_") } 1, 2) {	753	for (grep $_, map { split /,/, $TERM->resource ("perl_ext_$_") } 1, 2) {
660	if ($_ eq "default") {	754	if ($_ eq "default") {
661	$ext_arg{$_} \|\|= [] for qw(selection option-popup selection-popup searchable-scrollback);	755	$ext_arg{$_} \|\|= [] for qw(selection option-popup selection-popup searchable-scrollback);
662	} elsif (/^-(.*)$/) {	756	} elsif (/^-(.*)$/) {
663	delete $ext_arg{$1};	757	delete $ext_arg{$1};
664	} elsif (/^([^<]+)<(.*)>$/) {	758	} elsif (/^([^<]+)<(.*)>$/) {
…		…
689	if $verbosity >= 10;	783	if $verbosity >= 10;
690		784
691	keys %$cb;	785	keys %$cb;
692		786
693	while (my ($pkg, $cb) = each %$cb) {	787	while (my ($pkg, $cb) = each %$cb) {
694	$retval = eval { $cb->($TERM->{_pkg}{$pkg}, @_) }	788	my $retval_ = eval { $cb->($TERM->{_pkg}{$pkg}, @_) };
695	and last;	789	$retval \|\|= $retval_;
696		790
697	if ($@) {	791	if ($@) {
698	$TERM->ungrab; # better to lose the grab than the session	792	$TERM->ungrab; # better to lose the grab than the session
699	warn $@;	793	warn $@;
700	}	794	}
…		…
711	# clear package	805	# clear package
712	%$TERM = ();	806	%$TERM = ();
713	}	807	}
714		808
715	$retval	809	$retval
716	}
717
718	sub exec_async(@) {
719	my $pid = fork;
720
721	return
722	if !defined $pid or $pid;
723
724	%ENV = %{ $TERM->env };
725
726	exec @_;
727	_exit 255;
728	}	810	}
729		811
730	# urxvt::term::extension	812	# urxvt::term::extension
731		813
732	package urxvt::term::extension;	814	package urxvt::term::extension;
…		…
871	# find on_xxx subs in the package and register them	953	# find on_xxx subs in the package and register them
872	# as hooks	954	# as hooks
873	sub register_package {	955	sub register_package {
874	my ($self, $pkg, $argv) = @_;	956	my ($self, $pkg, $argv) = @_;
875		957
		958	no strict 'refs';
		959
		960	urxvt::verbose 6, "register package $pkg to $self";
		961
		962	@{"$pkg\::ISA"} = urxvt::term::extension::;
		963
876	my $proxy = bless {	964	my $proxy = bless {
877	_pkg => $pkg,	965	_pkg => $pkg,
878	argv => $argv,	966	argv => $argv,
879	}, $pkg;	967	}, $pkg;
880	Scalar::Util::weaken ($proxy->{term} = $self);	968	Scalar::Util::weaken ($proxy->{term} = $self);
…		…
911		999
912	Destroy the terminal object (close the window, free resources	1000	Destroy the terminal object (close the window, free resources
913	etc.). Please note that @@RXVT_NAME@@ will not exit as long as any event	1001	etc.). Please note that @@RXVT_NAME@@ will not exit as long as any event
914	watchers (timers, io watchers) are still active.	1002	watchers (timers, io watchers) are still active.
915		1003
		1004	=item $term->exec_async ($cmd[, @args])
		1005
		1006	Works like the combination of the C<fork>/C<exec> builtins, which executes
		1007	("starts") programs in the background. This function takes care of setting
		1008	the user environment before exec'ing the command (e.g. C<PATH>) and should
		1009	be preferred over explicit calls to C<exec> or C<system>.
		1010
		1011	Returns the pid of the subprocess or C<undef> on error.
		1012
		1013	=cut
		1014
		1015	sub exec_async {
		1016	my $self = shift;
		1017
		1018	my $pid = fork;
		1019
		1020	return $pid
		1021	if !defined $pid or $pid;
		1022
		1023	%ENV = %{ $self->env };
		1024
		1025	exec @_;
		1026	urxvt::_exit 255;
		1027	}
		1028
916	=item $isset = $term->option ($optval[, $set])	1029	=item $isset = $term->option ($optval[, $set])
917		1030
918	Returns true if the option specified by C<$optval> is enabled, and	1031	Returns true if the option specified by C<$optval> is enabled, and
919	optionally change it. All option values are stored by name in the hash	1032	optionally change it. All option values are stored by name in the hash
920	C<%urxvt::OPTION>. Options not enabled in this binary are not in the hash.	1033	C<%urxvt::OPTION>. Options not enabled in this binary are not in the hash.
…		…
922	Here is a a likely non-exhaustive list of option names, please see the	1035	Here is a a likely non-exhaustive list of option names, please see the
923	source file F</src/optinc.h> to see the actual list:	1036	source file F</src/optinc.h> to see the actual list:
924		1037
925	borderLess console cursorBlink cursorUnderline hold iconic insecure	1038	borderLess console cursorBlink cursorUnderline hold iconic insecure
926	intensityStyles jumpScroll loginShell mapAlert meta8 mouseWheelScrollPage	1039	intensityStyles jumpScroll loginShell mapAlert meta8 mouseWheelScrollPage
927	pastableTabs pointerBlank reverseVideo scrollBar scrollBar_floating	1040	override-redirect pastableTabs pointerBlank reverseVideo scrollBar
928	scrollBar_right scrollTtyKeypress scrollTtyOutput scrollWithBuffer	1041	scrollBar_floating scrollBar_right scrollTtyKeypress scrollTtyOutput
929	secondaryScreen secondaryScroll skipBuiltinGlyphs transparent	1042	scrollWithBuffer secondaryScreen secondaryScroll skipBuiltinGlyphs
930	tripleclickwords utmpInhibit visualBell	1043	transparent tripleclickwords utmpInhibit visualBell
931		1044
932	=item $value = $term->resource ($name[, $newval])	1045	=item $value = $term->resource ($name[, $newval])
933		1046
934	Returns the current resource value associated with a given name and	1047	Returns the current resource value associated with a given name and
935	optionally sets a new value. Setting values is most useful in the C<init>	1048	optionally sets a new value. Setting values is most useful in the C<init>
…		…
952		1065
953	answerbackstring backgroundPixmap backspace_key boldFont boldItalicFont	1066	answerbackstring backgroundPixmap backspace_key boldFont boldItalicFont
954	borderLess color cursorBlink cursorUnderline cutchars delete_key	1067	borderLess color cursorBlink cursorUnderline cutchars delete_key
955	display_name embed ext_bwidth fade font geometry hold iconName	1068	display_name embed ext_bwidth fade font geometry hold iconName
956	imFont imLocale inputMethod insecure int_bwidth intensityStyles	1069	imFont imLocale inputMethod insecure int_bwidth intensityStyles
957	italicFont jumpScroll lineSpace loginShell mapAlert menu meta8 modifier	1070	italicFont jumpScroll lineSpace loginShell mapAlert meta8 modifier
958	mouseWheelScrollPage name pastableTabs path perl_eval perl_ext_1 perl_ext_2	1071	mouseWheelScrollPage name override_redirect pastableTabs path perl_eval
959	perl_lib pointerBlank pointerBlankDelay preeditType print_pipe pty_fd	1072	perl_ext_1 perl_ext_2 perl_lib pointerBlank pointerBlankDelay
960	reverseVideo saveLines scrollBar scrollBar_align scrollBar_floating	1073	preeditType print_pipe pty_fd reverseVideo saveLines scrollBar
961	scrollBar_right scrollBar_thickness scrollTtyKeypress scrollTtyOutput	1074	scrollBar_align scrollBar_floating scrollBar_right scrollBar_thickness
962	scrollWithBuffer scrollstyle secondaryScreen secondaryScroll selectstyle	1075	scrollTtyKeypress scrollTtyOutput scrollWithBuffer scrollstyle
963	shade term_name title transparent transparent_all tripleclickwords	1076	secondaryScreen secondaryScroll selectstyle shade term_name title
964	utmpInhibit visualBell	1077	transient_for transparent transparent_all tripleclickwords utmpInhibit
		1078	visualBell
965		1079
966	=cut	1080	=cut
967		1081
968	sub resource($$;$) {	1082	sub resource($$;$) {
969	my ($self, $name) = (shift, shift);	1083	my ($self, $name) = (shift, shift);
…		…
1561	my $env = $self->{term}->env;	1675	my $env = $self->{term}->env;
1562	# we can't hope to reproduce the locale algorithm, so nuke LC_ALL and set LC_CTYPE.	1676	# we can't hope to reproduce the locale algorithm, so nuke LC_ALL and set LC_CTYPE.
1563	delete $env->{LC_ALL};	1677	delete $env->{LC_ALL};
1564	$env->{LC_CTYPE} = $self->{term}->locale;	1678	$env->{LC_CTYPE} = $self->{term}->locale;
1565		1679
1566	urxvt::term->new ($env, $self->{term}->resource ("name"),	1680	urxvt::term->new ($env, "popup",
1567	"--perl-lib" => "", "--perl-ext-common" => "", "-pty-fd" => -1, "-sl" => 0, "-b" => 0,	1681	"--perl-lib" => "", "--perl-ext-common" => "",
		1682	"-pty-fd" => -1, "-sl" => 0,
		1683	"-b" => 1, "-bd" => "grey80", "-bl", "-override-redirect",
1568	"--transient-for" => $self->{term}->parent,	1684	"--transient-for" => $self->{term}->parent,
1569	"-display" => $self->{term}->display_id,	1685	"-display" => $self->{term}->display_id,
1570	"-pe" => "urxvt-popup")	1686	"-pe" => "urxvt-popup")
1571	or die "unable to create popup window\n";	1687	or die "unable to create popup window\n";
1572	}	1688	}
…		…
1577	delete $self->{term}{_destroy}{$self};	1693	delete $self->{term}{_destroy}{$self};
1578	$self->{term}->ungrab;	1694	$self->{term}->ungrab;
1579	}	1695	}
1580		1696
1581	=back	1697	=back
		1698
		1699	=cut
		1700
		1701	package urxvt::watcher;
		1702
		1703	@urxvt::timer::ISA = __PACKAGE__;
		1704	@urxvt::iow::ISA = __PACKAGE__;
		1705	@urxvt::pw::ISA = __PACKAGE__;
		1706	@urxvt::iw::ISA = __PACKAGE__;
1582		1707
1583	=head2 The C<urxvt::timer> Class	1708	=head2 The C<urxvt::timer> Class
1584		1709
1585	This class implements timer watchers/events. Time is represented as a	1710	This class implements timer watchers/events. Time is represented as a
1586	fractional number of seconds since the epoch. Example:	1711	fractional number of seconds since the epoch. Example:
…		…
1624	Start the timer.	1749	Start the timer.
1625		1750
1626	=item $timer = $timer->start ($tstamp)	1751	=item $timer = $timer->start ($tstamp)
1627		1752
1628	Set the event trigger time to C<$tstamp> and start the timer.	1753	Set the event trigger time to C<$tstamp> and start the timer.
		1754
		1755	=item $timer = $timer->after ($delay)
		1756
		1757	Like C<start>, but sets the expiry timer to c<urxvt::NOW + $delay>.
1629		1758
1630	=item $timer = $timer->stop	1759	=item $timer = $timer->stop
1631		1760
1632	Stop the timer.	1761	Stop the timer.
1633		1762
…		…
1680		1809
1681	Stop watching for events on the given filehandle.	1810	Stop watching for events on the given filehandle.
1682		1811
1683	=back	1812	=back
1684		1813
		1814	=head2 The C<urxvt::iw> Class
		1815
		1816	This class implements idle watchers, that get called automatically when
		1817	the process is idle. They should return as fast as possible, after doing
		1818	some useful work.
		1819
		1820	=over 4
		1821
		1822	=item $iw = new urxvt::iw
		1823
		1824	Create a new idle watcher object in stopped state.
		1825
		1826	=item $iw = $iw->cb (sub { my ($iw) = @_; ... })
		1827
		1828	Set the callback to be called when the watcher triggers.
		1829
		1830	=item $timer = $timer->start
		1831
		1832	Start the watcher.
		1833
		1834	=item $timer = $timer->stop
		1835
		1836	Stop the watcher.
		1837
		1838	=back
		1839
		1840	=head2 The C<urxvt::pw> Class
		1841
		1842	This class implements process watchers. They create an event whenever a
		1843	process exits, after which they stop automatically.
		1844
		1845	my $pid = fork;
		1846	...
		1847	$term->{pw} = urxvt::pw
		1848	->new
		1849	->start ($pid)
		1850	->cb (sub {
		1851	my ($pw, $exit_status) = @_;
		1852	...
		1853	});
		1854
		1855	=over 4
		1856
		1857	=item $pw = new urxvt::pw
		1858
		1859	Create a new process watcher in stopped state.
		1860
		1861	=item $pw = $pw->cb (sub { my ($pw, $exit_status) = @_; ... })
		1862
		1863	Set the callback to be called when the timer triggers.
		1864
		1865	=item $pw = $timer->start ($pid)
		1866
		1867	Tells the wqtcher to start watching for process C<$pid>.
		1868
		1869	=item $pw = $pw->stop
		1870
		1871	Stop the watcher.
		1872
		1873	=back
		1874
1685	=head1 ENVIRONMENT	1875	=head1 ENVIRONMENT
1686		1876
1687	=head2 URXVT_PERL_VERBOSITY	1877	=head2 URXVT_PERL_VERBOSITY
1688		1878
1689	This variable controls the verbosity level of the perl extension. Higher	1879	This variable controls the verbosity level of the perl extension. Higher

Diff Legend

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

Comparing rxvt-unicode/src/urxvt.pm (file contents): Revision 1.95 by elmex, Tue Jan 17 13:19:45 2006 UTC vs. Revision 1.115 by root, Fri Jan 20 15:57:21 2006 UTC

Diff Legend

Comparing rxvt-unicode/src/urxvt.pm (file contents):
Revision 1.95 by elmex, Tue Jan 17 13:19:45 2006 UTC vs.
Revision 1.115 by root, Fri Jan 20 15:57:21 2006 UTC