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

Comparing rxvt-unicode/src/urxvt.pm (file contents):
Revision 1.99 by root, Tue Jan 17 17:09:26 2006 UTC vs.
Revision 1.133 by root, Mon Feb 6 06:14:08 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
…		…
63	the match. For example, the followign adds a regex that matches everything	67	the match. For example, the followign adds a regex that matches everything
64	between two vertical bars:	68	between two vertical bars:
65		69
66	URxvt.selection.pattern-0: \\\|([^\|]+)\\\|	70	URxvt.selection.pattern-0: \\\|([^\|]+)\\\|
67		71
		72	Another example: Programs I use often output "absolute path: " at the
		73	beginning of a line when they process multiple files. The following
		74	pattern matches the filename (note, there is a single space at the very
		75	end):
		76
		77	URxvt.selection.pattern-0: ^(/[^:]+):\
		78
68	You can look at the source of the selection extension to see more	79	You can look at the source of the selection extension to see more
69	interesting uses, such as parsing a line from beginning to end.	80	interesting uses, such as parsing a line from beginning to end.
70		81
71	This extension also offers following bindable keyboard commands:	82	This extension also offers following bindable keyboard commands:
72		83
…		…
83	=item option-popup (enabled by default)	94	=item option-popup (enabled by default)
84		95
85	Binds a popup menu to Ctrl-Button2 that lets you toggle (some) options at	96	Binds a popup menu to Ctrl-Button2 that lets you toggle (some) options at
86	runtime.	97	runtime.
87		98
		99	Other extensions can extend this popup menu by pushing a code reference
		100	onto C<@{ $term->{option_popup_hook} }>, which gets called whenever the
		101	popup is being displayed.
		102
		103	It's sole argument is the popup menu, which can be modified. It should
		104	either return nothing or a string, the initial boolean value and a code
		105	reference. The string will be used as button text and the code reference
		106	will be called when the toggle changes, with the new boolean value as
		107	first argument.
		108
		109	The following will add an entry C<myoption> that changes
		110	C<$self->{myoption}>:
		111
		112	push @{ $self->{term}{option_popup_hook} }, sub {
		113	("my option" => $myoption, sub { $self->{myoption} = $_[0] })
		114	};
		115
88	=item selection-popup (enabled by default)	116	=item selection-popup (enabled by default)
89		117
90	Binds a popup menu to Ctrl-Button3 that lets you convert the selection	118	Binds a popup menu to Ctrl-Button3 that lets you convert the selection
91	text into various other formats/action (such as uri unescaping, perl	119	text into various other formats/action (such as uri unescaping, perl
92	evalution, web-browser starting etc.), depending on content.	120	evaluation, web-browser starting etc.), depending on content.
		121
		122	Other extensions can extend this popup menu by pushing a code reference
		123	onto C<@{ $term->{selection_popup_hook} }>, which gets called whenever the
		124	popup is being displayed.
		125
		126	It's sole argument is the popup menu, which can be modified. The selection
		127	is in C<$_>, which can be used to decide wether to add something or not.
		128	It should either return nothing or a string and a code reference. The
		129	string will be used as button text and the code reference will be called
		130	when the button gets activated and should transform C<$_>.
		131
		132	The following will add an entry C<a to b> that transforms all C<a>s in
		133	the selection to C<b>s, but only if the selection currently contains any
		134	C<a>s:
		135
		136	push @{ $self->{term}{selection_popup_hook} }, sub {
		137	/a/ ? ("a to be" => sub { s/a/b/g }
		138	: ()
		139	};
93		140
94	=item searchable-scrollback<hotkey> (enabled by default)	141	=item searchable-scrollback<hotkey> (enabled by default)
95		142
96	Adds regex search functionality to the scrollback buffer, triggered	143	Adds regex search functionality to the scrollback buffer, triggered
97	by a hotkey (default: C<M-s>). While in search mode, normal terminal	144	by a hotkey (default: C<M-s>). While in search mode, normal terminal
…		…
104	bottom. C<Escape> leaves search mode and returns to the point where search	151	bottom. C<Escape> leaves search mode and returns to the point where search
105	was started, while C<Enter> or C<Return> stay at the current position and	152	was started, while C<Enter> or C<Return> stay at the current position and
106	additionally stores the first match in the current line into the primary	153	additionally stores the first match in the current line into the primary
107	selection.	154	selection.
108		155
		156	=item readline (enabled by default)
		157
		158	A support package that tries to make editing with readline easier. At the
		159	moment, it reacts to clicking with the left mouse button by trying to
		160	move the text cursor to this position. It does so by generating as many
		161	cursor-left or cursor-right keypresses as required (the this only works
		162	for programs that correctly support wide characters).
		163
		164	To avoid too many false positives, this is only done when:
		165
		166	=over 4
		167
		168	=item - the tty is in ICANON state.
		169
		170	=item - the text cursor is visible.
		171
		172	=item - the primary screen is currently being displayed.
		173
		174	=item - the mouse is on the same (multi-row-) line as the text cursor.
		175
		176	=back
		177
		178	The normal selection mechanism isn't disabled, so quick successive clicks
		179	might interfere with selection creation in harmless ways.
		180
109	=item selection-autotransform	181	=item selection-autotransform
110		182
111	This selection allows you to do automatic transforms on a selection	183	This selection allows you to do automatic transforms on a selection
112	whenever a selection is made.	184	whenever a selection is made.
113		185
…		…
125	URxvt.selection-autotransform.0: s/^([^:[:space:]]+):(\\d+):?$/vi +$2 \\Q$1\\E\\x0d/	197	URxvt.selection-autotransform.0: s/^([^:[:space:]]+):(\\d+):?$/vi +$2 \\Q$1\\E\\x0d/
126		198
127	And this example matches the same,but replaces it with vi-commands you can	199	And this example matches the same,but replaces it with vi-commands you can
128	paste directly into your (vi :) editor:	200	paste directly into your (vi :) editor:
129		201
130	URxvt.selection-autotransform.0: s/^([^:[:space:]]+(\\d+):?$/\\x1b:e \\Q$1\\E\\x0d:$2\\x0d/	202	URxvt.selection-autotransform.0: s/^([^:[:space:]]+(\\d+):?$/:e \\Q$1\\E\\x0d:$2\\x0d/
131		203
132	Of course, this can be modified to suit your needs and your editor :)	204	Of course, this can be modified to suit your needs and your editor :)
133		205
134	To expand the example above to typical perl error messages ("XXX at	206	To expand the example above to typical perl error messages ("XXX at
135	FILENAME line YYY."), you need a slightly more elaborate solution:	207	FILENAME line YYY."), you need a slightly more elaborate solution:
136		208
137	URxvt.selection.pattern-0: ( at .*? line \\d+\\.)	209	URxvt.selection.pattern-0: ( at .*? line \\d+[,.])
138	URxvt.selection-autotransform.0: s/^ at (.*?) line (\\d+)\\.$/\x1b:e \\Q$1\E\\x0d:$2\\x0d/	210	URxvt.selection-autotransform.0: s/^ at (.*?) line (\\d+)[,.]$/:e \\Q$1\E\\x0d:$2\\x0d/
139		211
140	The first line tells the selection code to treat the unchanging part of	212	The first line tells the selection code to treat the unchanging part of
141	every error message as a selection pattern, and the second line transforms	213	every error message as a selection pattern, and the second line transforms
142	the message into vi commands to load the file.	214	the message into vi commands to load the file.
		215
		216	=item tabbed
		217
		218	This transforms the terminal into a tabbar with additional terminals, that
		219	is, it implements what is commonly refered to as "tabbed terminal". The topmost line
		220	displays a "[NEW]" button, which, when clicked, will add a new tab, followed by one
		221	button per tab.
		222
		223	Clicking a button will activate that tab. Pressing B<Shift-Left> and
		224	B<Shift-Right> will switch to the tab left or right of the current one,
		225	while B<Shift-Down> creates a new tab.
		226
		227	The tabbar itself can be configured similarly to a normal terminal, but
		228	with a resource class of C<URxvt.tabbed>. In addition, it supports the
		229	following four resources (shown with defaults):
		230
		231	URxvt.tabbed.tabbar-fg: <colour-index, default 3>
		232	URxvt.tabbed.tabbar-bg: <colour-index, default 0>
		233	URxvt.tabbed.tab-fg: <colour-index, default 0>
		234	URxvt.tabbed.tab-bg: <colour-index, default 1>
		235
		236	See I<COLOR AND GRAPHICS> in the @@RXVT_NAME@@(1) manpage for valid
		237	indices.
143		238
144	=item mark-urls	239	=item mark-urls
145		240
146	Uses per-line display filtering (C<on_line_update>) to underline urls and	241	Uses per-line display filtering (C<on_line_update>) to underline urls and
147	make them clickable. When middle-clicked, the program specified in the	242	make them clickable. When middle-clicked, the program specified in the
148	resource C<urlLauncher> (default C<x-www-browser>) will be started with	243	resource C<urlLauncher> (default C<x-www-browser>) will be started with
149	the URL as first argument.	244	the URL as first argument.
150		245
		246	=item xim-onthespot
		247
		248	This (experimental) perl extension implements OnTheSpot editing. It does
		249	not work perfectly, and some input methods don't seem to work well with
		250	OnTheSpot editing in general, but it seems to work at leats for SCIM and
		251	kinput2.
		252
		253	You enable it by specifying this extension and a preedit style of
		254	C<OnTheSpot>, i.e.:
		255
		256	@@RXVT_NAME@@ -pt OnTheSpot -pe xim-onthespot
		257
		258	=item automove-background
		259
		260	This is basically a one-line extension that dynamically changes the background pixmap offset
		261	to the window position, in effect creating the same effect as pseudo transparency with
		262	a custom pixmap. No scaling is supported in this mode. Exmaple:
		263
		264	@@RXVT_NAME@@ -pixmap background.xpm -pe automove-background
		265
151	=item block-graphics-to-ascii	266	=item block-graphics-to-ascii
152		267
153	A not very useful example of filtering all text output to the terminal,	268	A not very useful example of filtering all text output to the terminal,
154	by replacing all line-drawing characters (U+2500 .. U+259F) by a	269	by replacing all line-drawing characters (U+2500 .. U+259F) by a
155	similar-looking ascii character.	270	similar-looking ascii character.
156		271
157	=item digital-clock	272	=item digital-clock
158		273
159	Displays a digital clock using the built-in overlay.	274	Displays a digital clock using the built-in overlay.
160		275
161	=item example-refresh-hooks	276	=item remote-clipboard
162		277
163	Displays a very simple digital clock in the upper right corner of the	278	Somewhat of a misnomer, this extension adds two menu entries to the
164	window. Illustrates overwriting the refresh callbacks to create your own	279	selection popup that allows one ti run external commands to store the
165	overlays or changes.	280	selection somewhere and fetch it again.
		281
		282	We use it to implement a "distributed selection mechanism", which just
		283	means that one command uploads the file to a remote server, and another
		284	reads it.
		285
		286	The commands can be set using the C<URxvt.remote-selection.store> and
		287	C<URxvt.remote-selection.fetch> resources. The first should read the
		288	selection to store from STDIN (always in UTF-8), the second should provide
		289	the selection data on STDOUT (also in UTF-8).
		290
		291	The defaults (which are likely useless to you) use rsh and cat:
		292
		293	URxvt.remote-selection.store: rsh ruth 'cat >/tmp/distributed-selection'
		294	URxvt.remote-selection.fetch: rsh ruth 'cat /tmp/distributed-selection'
166		295
167	=item selection-pastebin	296	=item selection-pastebin
168		297
169	This is a little rarely useful extension that Uploads the selection as	298	This is a little rarely useful extension that Uploads the selection as
170	textfile to a remote site (or does other things). (The implementation is	299	textfile to a remote site (or does other things). (The implementation is
…		…
190	After a successful upload the selection will be replaced by the text given	319	After a successful upload the selection will be replaced by the text given
191	in the C<selection-pastebin-url> resource (again, the % is the placeholder	320	in the C<selection-pastebin-url> resource (again, the % is the placeholder
192	for the filename):	321	for the filename):
193		322
194	URxvt.selection-pastebin.url: http://www.ta-sa.org/files/txt/%	323	URxvt.selection-pastebin.url: http://www.ta-sa.org/files/txt/%
		324
		325	=item example-refresh-hooks
		326
		327	Displays a very simple digital clock in the upper right corner of the
		328	window. Illustrates overwriting the refresh callbacks to create your own
		329	overlays or changes.
195		330
196	=back	331	=back
197		332
198	=head1 API DOCUMENTATION	333	=head1 API DOCUMENTATION
199		334
…		…
272	called whenever the relevant event happens.	407	called whenever the relevant event happens.
273		408
274	The first argument passed to them is an extension oject as described in	409	The first argument passed to them is an extension oject as described in
275	the in the C<Extension Objects> section.	410	the in the C<Extension Objects> section.
276		411
277	B<All> of these hooks must return a boolean value. If it is true, then the	412	B<All> of these hooks must return a boolean value. If any of the called
278	event counts as being I<consumed>, and the invocation of other hooks is	413	hooks returns true, then the event counts as being I<consumed>, and the
279	skipped, and the relevant action might not be carried out by the C++ code.	414	relevant action might not be carried out by the C++ code.
280		415
281	I<< When in doubt, return a false value (preferably C<()>). >>	416	I<< When in doubt, return a false value (preferably C<()>). >>
282		417
283	=over 4	418	=over 4
284		419
285	=item on_init $term	420	=item on_init $term
286		421
287	Called after a new terminal object has been initialized, but before	422	Called after a new terminal object has been initialized, but before
288	windows are created or the command gets run. Most methods are unsafe to	423	windows are created or the command gets run. Most methods are unsafe to
289	call or deliver senseless data, as terminal size and other characteristics	424	call or deliver senseless data, as terminal size and other characteristics
290	have not yet been determined. You can safely query and change resources,	425	have not yet been determined. You can safely query and change resources
291	though.	426	and options, though. For many purposes the C<on_start> hook is a better
		427	place.
		428
		429	=item on_start $term
		430
		431	Called at the very end of initialisation of a new terminal, just before
		432	trying to map (display) the toplevel and returning to the mainloop.
		433
		434	=item on_destroy $term
		435
		436	Called whenever something tries to destroy terminal, when the terminal is
		437	still fully functional (not for long, though).
292		438
293	=item on_reset $term	439	=item on_reset $term
294		440
295	Called after the screen is "reset" for any reason, such as resizing or	441	Called after the screen is "reset" for any reason, such as resizing or
296	control sequences. Here is where you can react on changes to size-related	442	control sequences. Here is where you can react on changes to size-related
297	variables.	443	variables.
298		444
299	=item on_start $term	445	=item on_child_start $term, $pid
300		446
301	Called at the very end of initialisation of a new terminal, just before	447	Called just after the child process has been C<fork>ed.
302	returning to the mainloop.	448
		449	=item on_child_exit $term, $status
		450
		451	Called just after the child process has exited. C<$status> is the status
		452	from C<waitpid>.
303		453
304	=item on_sel_make $term, $eventtime	454	=item on_sel_make $term, $eventtime
305		455
306	Called whenever a selection has been made by the user, but before the	456	Called whenever a selection has been made by the user, but before the
307	selection text is copied, so changes to the beginning, end or type of the	457	selection text is copied, so changes to the beginning, end or type of the
…		…
394		544
395	=item on_refresh_end $term	545	=item on_refresh_end $term
396		546
397	Called just after the screen gets redrawn. See C<on_refresh_begin>.	547	Called just after the screen gets redrawn. See C<on_refresh_begin>.
398		548
399	=item on_keyboard_command $term, $string	549	=item on_user_command $term, $string
400		550
401	Called whenever the user presses a key combination that has a	551	Called whenever the a user-configured event is being activated (e.g. via
402	C<perl:string> action bound to it (see description of the B<keysym>	552	a C<perl:string> action bound to a key, see description of the B<keysym>
403	resource in the @@RXVT_NAME@@(1) manpage).	553	resource in the @@RXVT_NAME@@(1) manpage).
		554
		555	The event is simply the action string. This interface is assumed to change
		556	slightly in the future.
404		557
405	=item on_x_event $term, $event	558	=item on_x_event $term, $event
406		559
407	Called on every X event received on the vt window (and possibly other	560	Called on every X event received on the vt window (and possibly other
408	windows). Should only be used as a last resort. Most event structure	561	windows). Should only be used as a last resort. Most event structure
…		…
416	=item on_focus_out $term	569	=item on_focus_out $term
417		570
418	Called wheneever the window loses keyboard focus, before rxvt-unicode does	571	Called wheneever the window loses keyboard focus, before rxvt-unicode does
419	focus out processing.	572	focus out processing.
420		573
		574	=item on_configure_notify $term, $event
		575
		576	=item on_property_notify $term, $event
		577
421	=item on_key_press $term, $event, $keysym, $octets	578	=item on_key_press $term, $event, $keysym, $octets
422		579
423	=item on_key_release $term, $event, $keysym	580	=item on_key_release $term, $event, $keysym
424		581
425	=item on_button_press $term, $event	582	=item on_button_press $term, $event
…		…
434		591
435	Called whenever the corresponding X event is received for the terminal If	592	Called whenever the corresponding X event is received for the terminal If
436	the hook returns true, then the even will be ignored by rxvt-unicode.	593	the hook returns true, then the even will be ignored by rxvt-unicode.
437		594
438	The event is a hash with most values as named by Xlib (see the XEvent	595	The event is a hash with most values as named by Xlib (see the XEvent
439	manpage), with the additional members C<row> and C<col>, which are the row	596	manpage), with the additional members C<row> and C<col>, which are the
440	and column under the mouse cursor.	597	(real, not screen-based) row and column under the mouse cursor.
441		598
442	C<on_key_press> additionally receives the string rxvt-unicode would	599	C<on_key_press> additionally receives the string rxvt-unicode would
443	output, if any, in locale-specific encoding.	600	output, if any, in locale-specific encoding.
444		601
445	subwindow.	602	subwindow.
		603
		604	=item on_client_message $term, $event
		605
		606	=item on_wm_protocols $term, $event
		607
		608	=item on_wm_delete_window $term, $event
		609
		610	Called when various types of ClientMessage events are received (all with
		611	format=32, WM_PROTOCOLS or WM_PROTOCOLS:WM_DELETE_WINDOW).
446		612
447	=back	613	=back
448		614
449	=cut	615	=cut
450		616
…		…
456	use Scalar::Util ();	622	use Scalar::Util ();
457	use List::Util ();	623	use List::Util ();
458		624
459	our $VERSION = 1;	625	our $VERSION = 1;
460	our $TERM;	626	our $TERM;
		627	our @TERM_INIT;
		628	our @TERM_EXT;
461	our @HOOKNAME;	629	our @HOOKNAME;
462	our %HOOKTYPE = map +($HOOKNAME[$_] => $_), 0..$#HOOKNAME;	630	our %HOOKTYPE = map +($HOOKNAME[$_] => $_), 0..$#HOOKNAME;
463	our %OPTION;	631	our %OPTION;
464		632
465	our $LIBDIR;	633	our $LIBDIR;
466	our $RESNAME;	634	our $RESNAME;
467	our $RESCLASS;	635	our $RESCLASS;
468	our $RXVTNAME;	636	our $RXVTNAME;
469		637
		638	our $NOCHAR = chr 0xffff;
		639
470	=head2 Variables in the C<urxvt> Package	640	=head2 Variables in the C<urxvt> Package
471		641
472	=over 4	642	=over 4
473		643
474	=item $urxvt::LIBDIR	644	=item $urxvt::LIBDIR
…		…
486		656
487	=item $urxvt::TERM	657	=item $urxvt::TERM
488		658
489	The current terminal. This variable stores the current C<urxvt::term>	659	The current terminal. This variable stores the current C<urxvt::term>
490	object, whenever a callback/hook is executing.	660	object, whenever a callback/hook is executing.
		661
		662	=item @urxvt::TERM_INIT
		663
		664	All coderefs in this array will be called as methods of the next newly
		665	created C<urxvt::term> object (during the C<on_init> phase). The array
		666	gets cleared before the codereferences that were in it are being executed,
		667	so coderefs can push themselves onto it again if they so desire.
		668
		669	This complements to the perl-eval commandline option, but gets executed
		670	first.
		671
		672	=item @urxvt::TERM_EXT
		673
		674	Works similar to C<@TERM_INIT>, but contains perl package/class names, which
		675	get registered as normal extensions after calling the hooks in C<@TERM_INIT>
		676	but before other extensions. Gets cleared just like C<@TERM_INIT>.
491		677
492	=back	678	=back
493		679
494	=head2 Functions in the C<urxvt> Package	680	=head2 Functions in the C<urxvt> Package
495		681
…		…
509		695
510	Using this function has the advantage that its output ends up in the	696	Using this function has the advantage that its output ends up in the
511	correct place, e.g. on stderr of the connecting urxvtc client.	697	correct place, e.g. on stderr of the connecting urxvtc client.
512		698
513	Messages have a size limit of 1023 bytes currently.	699	Messages have a size limit of 1023 bytes currently.
		700
		701	=item @terms = urxvt::termlist
		702
		703	Returns all urxvt::term objects that exist in this process, regardless of
		704	wether they are started, being destroyed etc., so be careful. Only term
		705	objects that have perl extensions attached will be returned (because there
		706	is no urxvt::term objet associated with others).
514		707
515	=item $time = urxvt::NOW	708	=item $time = urxvt::NOW
516		709
517	Returns the "current time" (as per the event loop).	710	Returns the "current time" (as per the event loop).
518		711
…		…
577		770
578	=item $rend = urxvt::SET_FGCOLOR $rend, $new_colour	771	=item $rend = urxvt::SET_FGCOLOR $rend, $new_colour
579		772
580	=item $rend = urxvt::SET_BGCOLOR $rend, $new_colour	773	=item $rend = urxvt::SET_BGCOLOR $rend, $new_colour
581		774
		775	=item $rend = urxvt::SET_COLOR $rend, $new_fg, $new_bg
		776
582	Replace the foreground/background colour in the rendition mask with the	777	Replace the foreground/background colour in the rendition mask with the
583	specified one.	778	specified one.
584		779
585	=item $value = urxvt::GET_CUSTOM $rend	780	=item $value = urxvt::GET_CUSTOM $rend
586		781
…		…
595	=back	790	=back
596		791
597	=cut	792	=cut
598		793
599	BEGIN {	794	BEGIN {
600	urxvt->bootstrap;
601
602	# overwrite perl's warn	795	# overwrite perl's warn
603	*CORE::GLOBAL::warn = sub {	796	*CORE::GLOBAL::warn = sub {
604	my $msg = join "", @_;	797	my $msg = join "", @_;
605	$msg .= "\n"	798	$msg .= "\n"
606	unless $msg =~ /\n$/;	799	unless $msg =~ /\n$/;
607	urxvt::warn ($msg);	800	urxvt::warn ($msg);
608	};	801	};
609
610	# %ENV is the original startup environment
611	delete $ENV{IFS};
612	delete $ENV{CDPATH};
613	delete $ENV{BASH_ENV};
614	$ENV{PATH} = "/bin:/sbin:/usr/bin:/usr/sbin:/usr/local/bin:/usr/local/sbin:/opt/bin:/opt/sbin";
615	}	802	}
		803
		804	no warnings 'utf8';
616		805
617	my $verbosity = $ENV{URXVT_PERL_VERBOSITY};	806	my $verbosity = $ENV{URXVT_PERL_VERBOSITY};
618		807
619	sub verbose {	808	sub verbose {
620	my ($level, $msg) = @_;	809	my ($level, $msg) = @_;
621	warn "$msg\n" if $level <= $verbosity;	810	warn "$msg\n" if $level <= $verbosity;
622	}	811	}
623		812
624	my $extension_pkg = "extension0000";
625	my %extension_pkg;	813	my %extension_pkg;
626		814
627	# load a single script into its own package, once only	815	# load a single script into its own package, once only
628	sub extension_package($) {	816	sub extension_package($) {
629	my ($path) = @_;	817	my ($path) = @_;
630		818
631	$extension_pkg{$path} \|\|= do {	819	$extension_pkg{$path} \|\|= do {
632	my $pkg = "urxvt::" . ($extension_pkg++);	820	$path =~ /([^\/\\]+)$/;
		821	my $pkg = $1;
		822	$pkg =~ s/[^[:word:]]/_/g;
		823	$pkg = "urxvt::ext::$pkg";
633		824
634	verbose 3, "loading extension '$path' into package '$pkg'";	825	verbose 3, "loading extension '$path' into package '$pkg'";
635		826
636	open my $fh, "<:raw", $path	827	open my $fh, "<:raw", $path
637	or die "$path: $!";	828	or die "$path: $!";
638		829
639	my $source =	830	my $source =
640	"package $pkg; use strict; use utf8;\n"	831	"package $pkg; use strict; use utf8; no warnings 'utf8';\n"
641	. "use base urxvt::term::extension::;\n"
642	. "#line 1 \"$path\"\n{\n"	832	. "#line 1 \"$path\"\n{\n"
643	. (do { local $/; <$fh> })	833	. (do { local $/; <$fh> })
644	. "\n};\n1";	834	. "\n};\n1";
645		835
646	eval $source	836	eval $source
…		…
660	if ($htype == 0) { # INIT	850	if ($htype == 0) { # INIT
661	my @dirs = ((split /:/, $TERM->resource ("perl_lib")), "$LIBDIR/perl");	851	my @dirs = ((split /:/, $TERM->resource ("perl_lib")), "$LIBDIR/perl");
662		852
663	my %ext_arg;	853	my %ext_arg;
664		854
		855	{
		856	my @init = @TERM_INIT;
		857	@TERM_INIT = ();
		858	$_->($TERM) for @init;
		859	my @pkg = @TERM_EXT;
		860	@TERM_EXT = ();
		861	$TERM->register_package ($_) for @pkg;
		862	}
		863
665	for (map { split /,/, $TERM->resource ("perl_ext_$_") } 1, 2) {	864	for (grep $_, map { split /,/, $TERM->resource ("perl_ext_$_") } 1, 2) {
666	if ($_ eq "default") {	865	if ($_ eq "default") {
667	$ext_arg{$_} \|\|= [] for qw(selection option-popup selection-popup searchable-scrollback);	866	$ext_arg{$_} \|\|= [] for qw(selection option-popup selection-popup searchable-scrollback readline);
668	} elsif (/^-(.*)$/) {	867	} elsif (/^-(.*)$/) {
669	delete $ext_arg{$1};	868	delete $ext_arg{$1};
670	} elsif (/^([^<]+)<(.*)>$/) {	869	} elsif (/^([^<]+)<(.*)>$/) {
671	push @{ $ext_arg{$1} }, $2;	870	push @{ $ext_arg{$1} }, $2;
672	} else {	871	} else {
673	$ext_arg{$_} \|\|= [];	872	$ext_arg{$_} \|\|= [];
674	}	873	}
675	}	874	}
676		875
677	while (my ($ext, $argv) = each %ext_arg) {	876	for my $ext (sort keys %ext_arg) {
678	my @files = grep -f $_, map "$_/$ext", @dirs;	877	my @files = grep -f $_, map "$_/$ext", @dirs;
679		878
680	if (@files) {	879	if (@files) {
681	$TERM->register_package (extension_package $files[0], $argv);	880	$TERM->register_package (extension_package $files[0], $ext_arg{$ext});
682	} else {	881	} else {
683	warn "perl extension '$ext' not found in perl library search path\n";	882	warn "perl extension '$ext' not found in perl library search path\n";
684	}	883	}
685	}	884	}
686		885
…		…
695	if $verbosity >= 10;	894	if $verbosity >= 10;
696		895
697	keys %$cb;	896	keys %$cb;
698		897
699	while (my ($pkg, $cb) = each %$cb) {	898	while (my ($pkg, $cb) = each %$cb) {
700	$retval = eval { $cb->($TERM->{_pkg}{$pkg}, @_) }	899	my $retval_ = eval { $cb->($TERM->{_pkg}{$pkg}, @_) };
701	and last;	900	$retval \|\|= $retval_;
702		901
703	if ($@) {	902	if ($@) {
704	$TERM->ungrab; # better to lose the grab than the session	903	$TERM->ungrab; # better to lose the grab than the session
705	warn $@;	904	warn $@;
706	}	905	}
…		…
719	}	918	}
720		919
721	$retval	920	$retval
722	}	921	}
723		922
724	sub exec_async(@) {	923	sub SET_COLOR($$$) {
725	my $pid = fork;	924	SET_BGCOLOR (SET_FGCOLOR ($_[0], $_[1]), $_[2])
726
727	return
728	if !defined $pid or $pid;
729
730	%ENV = %{ $TERM->env };
731
732	exec @_;
733	_exit 255;
734	}	925	}
735		926
736	# urxvt::term::extension	927	# urxvt::term::extension
737		928
738	package urxvt::term::extension;	929	package urxvt::term::extension;
…		…
877	# find on_xxx subs in the package and register them	1068	# find on_xxx subs in the package and register them
878	# as hooks	1069	# as hooks
879	sub register_package {	1070	sub register_package {
880	my ($self, $pkg, $argv) = @_;	1071	my ($self, $pkg, $argv) = @_;
881		1072
		1073	no strict 'refs';
		1074
		1075	urxvt::verbose 6, "register package $pkg to $self";
		1076
		1077	@{"$pkg\::ISA"} = urxvt::term::extension::;
		1078
882	my $proxy = bless {	1079	my $proxy = bless {
883	_pkg => $pkg,	1080	_pkg => $pkg,
884	argv => $argv,	1081	argv => $argv,
885	}, $pkg;	1082	}, $pkg;
886	Scalar::Util::weaken ($proxy->{term} = $self);	1083	Scalar::Util::weaken ($proxy->{term} = $self);
…		…
901	hash which defines the environment of the new terminal.	1098	hash which defines the environment of the new terminal.
902		1099
903	Croaks (and probably outputs an error message) if the new instance	1100	Croaks (and probably outputs an error message) if the new instance
904	couldn't be created. Returns C<undef> if the new instance didn't	1101	couldn't be created. Returns C<undef> if the new instance didn't
905	initialise perl, and the terminal object otherwise. The C<init> and	1102	initialise perl, and the terminal object otherwise. The C<init> and
906	C<start> hooks will be called during this call.	1103	C<start> hooks will be called before this call returns, and are free to
		1104	refer to global data (which is race free).
907		1105
908	=cut	1106	=cut
909		1107
910	sub new {	1108	sub new {
911	my ($class, $env, @args) = @_;	1109	my ($class, $env, @args) = @_;
912		1110
		1111	$env or Carp::croak "environment hash missing in call to urxvt::term->new";
		1112	@args or Carp::croak "name argument missing in call to urxvt::term->new";
		1113
913	_new ([ map "$_=$env->{$_}", keys %$env ], @args);	1114	_new ([ map "$_=$env->{$_}", keys %$env ], \@args);
914	}	1115	}
915		1116
916	=item $term->destroy	1117	=item $term->destroy
917		1118
918	Destroy the terminal object (close the window, free resources	1119	Destroy the terminal object (close the window, free resources
919	etc.). Please note that @@RXVT_NAME@@ will not exit as long as any event	1120	etc.). Please note that @@RXVT_NAME@@ will not exit as long as any event
920	watchers (timers, io watchers) are still active.	1121	watchers (timers, io watchers) are still active.
921		1122
		1123	=item $term->exec_async ($cmd[, @args])
		1124
		1125	Works like the combination of the C<fork>/C<exec> builtins, which executes
		1126	("starts") programs in the background. This function takes care of setting
		1127	the user environment before exec'ing the command (e.g. C<PATH>) and should
		1128	be preferred over explicit calls to C<exec> or C<system>.
		1129
		1130	Returns the pid of the subprocess or C<undef> on error.
		1131
		1132	=cut
		1133
		1134	sub exec_async {
		1135	my $self = shift;
		1136
		1137	my $pid = fork;
		1138
		1139	return $pid
		1140	if !defined $pid or $pid;
		1141
		1142	%ENV = %{ $self->env };
		1143
		1144	exec @_;
		1145	urxvt::_exit 255;
		1146	}
		1147
922	=item $isset = $term->option ($optval[, $set])	1148	=item $isset = $term->option ($optval[, $set])
923		1149
924	Returns true if the option specified by C<$optval> is enabled, and	1150	Returns true if the option specified by C<$optval> is enabled, and
925	optionally change it. All option values are stored by name in the hash	1151	optionally change it. All option values are stored by name in the hash
926	C<%urxvt::OPTION>. Options not enabled in this binary are not in the hash.	1152	C<%urxvt::OPTION>. Options not enabled in this binary are not in the hash.
…		…
928	Here is a a likely non-exhaustive list of option names, please see the	1154	Here is a a likely non-exhaustive list of option names, please see the
929	source file F</src/optinc.h> to see the actual list:	1155	source file F</src/optinc.h> to see the actual list:
930		1156
931	borderLess console cursorBlink cursorUnderline hold iconic insecure	1157	borderLess console cursorBlink cursorUnderline hold iconic insecure
932	intensityStyles jumpScroll loginShell mapAlert meta8 mouseWheelScrollPage	1158	intensityStyles jumpScroll loginShell mapAlert meta8 mouseWheelScrollPage
933	pastableTabs pointerBlank reverseVideo scrollBar scrollBar_floating	1159	override-redirect pastableTabs pointerBlank reverseVideo scrollBar
934	scrollBar_right scrollTtyKeypress scrollTtyOutput scrollWithBuffer	1160	scrollBar_floating scrollBar_right scrollTtyKeypress scrollTtyOutput
935	secondaryScreen secondaryScroll skipBuiltinGlyphs transparent	1161	scrollWithBuffer secondaryScreen secondaryScroll skipBuiltinGlyphs
936	tripleclickwords utmpInhibit visualBell	1162	transparent tripleclickwords utmpInhibit visualBell
937		1163
938	=item $value = $term->resource ($name[, $newval])	1164	=item $value = $term->resource ($name[, $newval])
939		1165
940	Returns the current resource value associated with a given name and	1166	Returns the current resource value associated with a given name and
941	optionally sets a new value. Setting values is most useful in the C<init>	1167	optionally sets a new value. Setting values is most useful in the C<init>
…		…
958		1184
959	answerbackstring backgroundPixmap backspace_key boldFont boldItalicFont	1185	answerbackstring backgroundPixmap backspace_key boldFont boldItalicFont
960	borderLess color cursorBlink cursorUnderline cutchars delete_key	1186	borderLess color cursorBlink cursorUnderline cutchars delete_key
961	display_name embed ext_bwidth fade font geometry hold iconName	1187	display_name embed ext_bwidth fade font geometry hold iconName
962	imFont imLocale inputMethod insecure int_bwidth intensityStyles	1188	imFont imLocale inputMethod insecure int_bwidth intensityStyles
963	italicFont jumpScroll lineSpace loginShell mapAlert menu meta8 modifier	1189	italicFont jumpScroll lineSpace loginShell mapAlert meta8 modifier
964	mouseWheelScrollPage name pastableTabs path perl_eval perl_ext_1 perl_ext_2	1190	mouseWheelScrollPage name override_redirect pastableTabs path perl_eval
965	perl_lib pointerBlank pointerBlankDelay preeditType print_pipe pty_fd	1191	perl_ext_1 perl_ext_2 perl_lib pointerBlank pointerBlankDelay
966	reverseVideo saveLines scrollBar scrollBar_align scrollBar_floating	1192	preeditType print_pipe pty_fd reverseVideo saveLines scrollBar
967	scrollBar_right scrollBar_thickness scrollTtyKeypress scrollTtyOutput	1193	scrollBar_align scrollBar_floating scrollBar_right scrollBar_thickness
968	scrollWithBuffer scrollstyle secondaryScreen secondaryScroll selectstyle	1194	scrollTtyKeypress scrollTtyOutput scrollWithBuffer scrollstyle
969	shade term_name title transparent transparent_all tripleclickwords	1195	secondaryScreen secondaryScroll selectstyle shade term_name title
970	utmpInhibit visualBell	1196	transient_for transparent transparent_all tripleclickwords utmpInhibit
		1197	visualBell
971		1198
972	=cut	1199	=cut
973		1200
974	sub resource($$;$) {	1201	sub resource($$;$) {
975	my ($self, $name) = (shift, shift);	1202	my ($self, $name) = (shift, shift);
…		…
1149		1376
1150	Normally its not a good idea to use this function, as programs might be	1377	Normally its not a good idea to use this function, as programs might be
1151	confused by changes in cursor position or scrolling. Its useful inside a	1378	confused by changes in cursor position or scrolling. Its useful inside a
1152	C<on_add_lines> hook, though.	1379	C<on_add_lines> hook, though.
1153		1380
		1381	=item $term->scr_change_screen ($screen)
		1382
		1383	Switch to given screen - 0 primary, 1 secondary.
		1384
1154	=item $term->cmd_parse ($octets)	1385	=item $term->cmd_parse ($octets)
1155		1386
1156	Similar to C<scr_add_lines>, but the argument must be in the	1387	Similar to C<scr_add_lines>, but the argument must be in the
1157	locale-specific encoding of the terminal and can contain command sequences	1388	locale-specific encoding of the terminal and can contain command sequences
1158	(escape codes) that will be interpreted.	1389	(escape codes) that will be interpreted.
…		…
1168	Replaces the event mask of the pty watcher by the given event mask. Can	1399	Replaces the event mask of the pty watcher by the given event mask. Can
1169	be used to suppress input and output handling to the pty/tty. See the	1400	be used to suppress input and output handling to the pty/tty. See the
1170	description of C<< urxvt::timer->events >>. Make sure to always restore	1401	description of C<< urxvt::timer->events >>. Make sure to always restore
1171	the previous value.	1402	the previous value.
1172		1403
		1404	=item $fd = $term->pty_fd
		1405
		1406	Returns the master file descriptor for the pty in use, or C<-1> if no pty
		1407	is used.
		1408
1173	=item $windowid = $term->parent	1409	=item $windowid = $term->parent
1174		1410
1175	Return the window id of the toplevel window.	1411	Return the window id of the toplevel window.
1176		1412
1177	=item $windowid = $term->vt	1413	=item $windowid = $term->vt
…		…
1182		1418
1183	Adds the specified events to the vt event mask. Useful e.g. when you want	1419	Adds the specified events to the vt event mask. Useful e.g. when you want
1184	to receive pointer events all the times:	1420	to receive pointer events all the times:
1185		1421
1186	$term->vt_emask_add (urxvt::PointerMotionMask);	1422	$term->vt_emask_add (urxvt::PointerMotionMask);
		1423
		1424	=item $term->focus_in
		1425
		1426	=item $term->focus_out
		1427
		1428	=item $term->key_press ($state, $keycode[, $time])
		1429
		1430	=item $term->key_release ($state, $keycode[, $time])
		1431
		1432	Deliver various fake events to to terminal.
1187		1433
1188	=item $window_width = $term->width	1434	=item $window_width = $term->width
1189		1435
1190	=item $window_height = $term->height	1436	=item $window_height = $term->height
1191		1437
…		…
1241	=item $modifiermask = $term->ModNumLockMask	1487	=item $modifiermask = $term->ModNumLockMask
1242		1488
1243	Return the modifier masks corresponding to the "ISO Level 3 Shift" (often	1489	Return the modifier masks corresponding to the "ISO Level 3 Shift" (often
1244	AltGr), the meta key (often Alt) and the num lock key, if applicable.	1490	AltGr), the meta key (often Alt) and the num lock key, if applicable.
1245		1491
		1492	=item $screen = $term->current_screen
		1493
		1494	Returns the currently displayed screen (0 primary, 1 secondary).
		1495
		1496	=item $cursor_is_hidden = $term->hidden_cursor
		1497
		1498	Returns wether the cursor is currently hidden or not.
		1499
1246	=item $view_start = $term->view_start ([$newvalue])	1500	=item $view_start = $term->view_start ([$newvalue])
1247		1501
1248	Returns the row number of the topmost displayed line. Maximum value is	1502	Returns the row number of the topmost displayed line. Maximum value is
1249	C<0>, which displays the normal terminal contents. Lower values scroll	1503	C<0>, which displays the normal terminal contents. Lower values scroll
1250	this many lines into the scrollback buffer.	1504	this many lines into the scrollback buffer.
…		…
1269	line, starting at column C<$start_col> (default C<0>), which is useful	1523	line, starting at column C<$start_col> (default C<0>), which is useful
1270	to replace only parts of a line. The font index in the rendition will	1524	to replace only parts of a line. The font index in the rendition will
1271	automatically be updated.	1525	automatically be updated.
1272		1526
1273	C<$text> is in a special encoding: tabs and wide characters that use more	1527	C<$text> is in a special encoding: tabs and wide characters that use more
1274	than one cell when displayed are padded with urxvt::NOCHAR characters	1528	than one cell when displayed are padded with C<$urxvt::NOCHAR> (chr 65535)
1275	(C<chr 65535>). Characters with combining characters and other characters	1529	characters. Characters with combining characters and other characters that
1276	that do not fit into the normal tetx encoding will be replaced with	1530	do not fit into the normal tetx encoding will be replaced with characters
1277	characters in the private use area.	1531	in the private use area.
1278		1532
1279	You have to obey this encoding when changing text. The advantage is	1533	You have to obey this encoding when changing text. The advantage is
1280	that C<substr> and similar functions work on screen cells and not on	1534	that C<substr> and similar functions work on screen cells and not on
1281	characters.	1535	characters.
1282		1536
…		…
1429	=item $string = $term->special_decode $text	1683	=item $string = $term->special_decode $text
1430		1684
1431	Converts rxvt-unicodes text reprsentation into a perl string. See	1685	Converts rxvt-unicodes text reprsentation into a perl string. See
1432	C<< $term->ROW_t >> for details.	1686	C<< $term->ROW_t >> for details.
1433		1687
1434	=item $success = $term->grab_button ($button, $modifiermask)	1688	=item $success = $term->grab_button ($button, $modifiermask[, $window = $term->vt])
1435		1689
		1690	=item $term->ungrab_button ($button, $modifiermask[, $window = $term->vt])
		1691
1436	Registers a synchronous button grab. See the XGrabButton manpage.	1692	Register/unregister a synchronous button grab. See the XGrabButton
		1693	manpage.
1437		1694
1438	=item $success = $term->grab ($eventtime[, $sync])	1695	=item $success = $term->grab ($eventtime[, $sync])
1439		1696
1440	Calls XGrabPointer and XGrabKeyboard in asynchronous (default) or	1697	Calls XGrabPointer and XGrabKeyboard in asynchronous (default) or
1441	synchronous (C<$sync> is true). Also remembers the grab timestampe.	1698	synchronous (C<$sync> is true). Also remembers the grab timestampe.
…		…
1456	=item $term->ungrab	1713	=item $term->ungrab
1457		1714
1458	Calls XUngrab for the most recent grab. Is called automatically on	1715	Calls XUngrab for the most recent grab. Is called automatically on
1459	evaluation errors, as it is better to lose the grab in the error case as	1716	evaluation errors, as it is better to lose the grab in the error case as
1460	the session.	1717	the session.
		1718
		1719	=item $atom = $term->XInternAtom ($atom_name[, $only_if_exists])
		1720
		1721	=item $atom_name = $term->XGetAtomName ($atom)
		1722
		1723	=item @atoms = $term->XListProperties ($window)
		1724
		1725	=item ($type,$format,$octets) = $term->XGetWindowProperty ($window, $property)
		1726
		1727	=item $term->XChangeWindowProperty ($window, $property, $type, $format, $octets)
		1728
		1729	=item $term->XDeleteProperty ($window, $property)
		1730
		1731	=item $window = $term->DefaultRootWindow
		1732
		1733	=item $term->XReparentWindow ($window, $parent, [$x, $y])
		1734
		1735	=item $term->XMapWindow ($window)
		1736
		1737	=item $term->XUnmapWindow ($window)
		1738
		1739	=item $term->XMoveResizeWindow ($window, $x, $y, $width, $height)
		1740
		1741	=item ($x, $y, $child_window) = $term->XTranslateCoordinates ($src, $dst, $x, $y)
		1742
		1743	=item $term->XChangeInput ($window, $add_events[, $del_events])
		1744
		1745	Various X or X-related functions. The C<$term> object only serves as
		1746	the source of the display, otherwise those functions map more-or-less
		1747	directory onto the X functions of the same name.
1461		1748
1462	=back	1749	=back
1463		1750
1464	=cut	1751	=cut
1465		1752
…		…
1529	my ($self, $text, $cb) = @_;	1816	my ($self, $text, $cb) = @_;
1530		1817
1531	$self->add_item ({ type => "button", text => $text, activate => $cb});	1818	$self->add_item ({ type => "button", text => $text, activate => $cb});
1532	}	1819	}
1533		1820
1534	=item $popup->add_toggle ($text, $cb, $initial_value)	1821	=item $popup->add_toggle ($text, $initial_value, $cb)
1535		1822
1536	Adds a toggle/checkbox item to the popup. Teh callback gets called	1823	Adds a toggle/checkbox item to the popup. The callback gets called
1537	whenever it gets toggled, with a boolean indicating its value as its first	1824	whenever it gets toggled, with a boolean indicating its new value as its
1538	argument.	1825	first argument.
1539		1826
1540	=cut	1827	=cut
1541		1828
1542	sub add_toggle {	1829	sub add_toggle {
1543	my ($self, $text, $cb, $value) = @_;	1830	my ($self, $text, $value, $cb) = @_;
1544		1831
1545	my $item; $item = {	1832	my $item; $item = {
1546	type => "button",	1833	type => "button",
1547	text => " $text",	1834	text => " $text",
1548	value => $value,	1835	value => $value,
…		…
1567	my $env = $self->{term}->env;	1854	my $env = $self->{term}->env;
1568	# we can't hope to reproduce the locale algorithm, so nuke LC_ALL and set LC_CTYPE.	1855	# we can't hope to reproduce the locale algorithm, so nuke LC_ALL and set LC_CTYPE.
1569	delete $env->{LC_ALL};	1856	delete $env->{LC_ALL};
1570	$env->{LC_CTYPE} = $self->{term}->locale;	1857	$env->{LC_CTYPE} = $self->{term}->locale;
1571		1858
1572	urxvt::term->new ($env, $self->{term}->resource ("name"),	1859	urxvt::term->new ($env, "popup",
1573	"--perl-lib" => "", "--perl-ext-common" => "", "-pty-fd" => -1, "-sl" => 0, "-b" => 0,	1860	"--perl-lib" => "", "--perl-ext-common" => "",
		1861	"-pty-fd" => -1, "-sl" => 0,
		1862	"-b" => 1, "-bd" => "grey80", "-bl", "-override-redirect",
1574	"--transient-for" => $self->{term}->parent,	1863	"--transient-for" => $self->{term}->parent,
1575	"-display" => $self->{term}->display_id,	1864	"-display" => $self->{term}->display_id,
1576	"-pe" => "urxvt-popup")	1865	"-pe" => "urxvt-popup")
1577	or die "unable to create popup window\n";	1866	or die "unable to create popup window\n";
1578	}	1867	}
…		…
1583	delete $self->{term}{_destroy}{$self};	1872	delete $self->{term}{_destroy}{$self};
1584	$self->{term}->ungrab;	1873	$self->{term}->ungrab;
1585	}	1874	}
1586		1875
1587	=back	1876	=back
		1877
		1878	=cut
		1879
		1880	package urxvt::watcher;
		1881
		1882	@urxvt::timer::ISA = __PACKAGE__;
		1883	@urxvt::iow::ISA = __PACKAGE__;
		1884	@urxvt::pw::ISA = __PACKAGE__;
		1885	@urxvt::iw::ISA = __PACKAGE__;
1588		1886
1589	=head2 The C<urxvt::timer> Class	1887	=head2 The C<urxvt::timer> Class
1590		1888
1591	This class implements timer watchers/events. Time is represented as a	1889	This class implements timer watchers/events. Time is represented as a
1592	fractional number of seconds since the epoch. Example:	1890	fractional number of seconds since the epoch. Example:
…		…
1630	Start the timer.	1928	Start the timer.
1631		1929
1632	=item $timer = $timer->start ($tstamp)	1930	=item $timer = $timer->start ($tstamp)
1633		1931
1634	Set the event trigger time to C<$tstamp> and start the timer.	1932	Set the event trigger time to C<$tstamp> and start the timer.
		1933
		1934	=item $timer = $timer->after ($delay)
		1935
		1936	Like C<start>, but sets the expiry timer to c<urxvt::NOW + $delay>.
1635		1937
1636	=item $timer = $timer->stop	1938	=item $timer = $timer->stop
1637		1939
1638	Stop the timer.	1940	Stop the timer.
1639		1941
…		…
1686		1988
1687	Stop watching for events on the given filehandle.	1989	Stop watching for events on the given filehandle.
1688		1990
1689	=back	1991	=back
1690		1992
		1993	=head2 The C<urxvt::iw> Class
		1994
		1995	This class implements idle watchers, that get called automatically when
		1996	the process is idle. They should return as fast as possible, after doing
		1997	some useful work.
		1998
		1999	=over 4
		2000
		2001	=item $iw = new urxvt::iw
		2002
		2003	Create a new idle watcher object in stopped state.
		2004
		2005	=item $iw = $iw->cb (sub { my ($iw) = @_; ... })
		2006
		2007	Set the callback to be called when the watcher triggers.
		2008
		2009	=item $timer = $timer->start
		2010
		2011	Start the watcher.
		2012
		2013	=item $timer = $timer->stop
		2014
		2015	Stop the watcher.
		2016
		2017	=back
		2018
		2019	=head2 The C<urxvt::pw> Class
		2020
		2021	This class implements process watchers. They create an event whenever a
		2022	process exits, after which they stop automatically.
		2023
		2024	my $pid = fork;
		2025	...
		2026	$term->{pw} = urxvt::pw
		2027	->new
		2028	->start ($pid)
		2029	->cb (sub {
		2030	my ($pw, $exit_status) = @_;
		2031	...
		2032	});
		2033
		2034	=over 4
		2035
		2036	=item $pw = new urxvt::pw
		2037
		2038	Create a new process watcher in stopped state.
		2039
		2040	=item $pw = $pw->cb (sub { my ($pw, $exit_status) = @_; ... })
		2041
		2042	Set the callback to be called when the timer triggers.
		2043
		2044	=item $pw = $timer->start ($pid)
		2045
		2046	Tells the wqtcher to start watching for process C<$pid>.
		2047
		2048	=item $pw = $pw->stop
		2049
		2050	Stop the watcher.
		2051
		2052	=back
		2053
1691	=head1 ENVIRONMENT	2054	=head1 ENVIRONMENT
1692		2055
1693	=head2 URXVT_PERL_VERBOSITY	2056	=head2 URXVT_PERL_VERBOSITY
1694		2057
1695	This variable controls the verbosity level of the perl extension. Higher	2058	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.99 by root, Tue Jan 17 17:09:26 2006 UTC vs. Revision 1.133 by root, Mon Feb 6 06:14:08 2006 UTC

Diff Legend

Comparing rxvt-unicode/src/urxvt.pm (file contents):
Revision 1.99 by root, Tue Jan 17 17:09:26 2006 UTC vs.
Revision 1.133 by root, Mon Feb 6 06:14:08 2006 UTC