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

Comparing rxvt-unicode/src/urxvt.pm (file contents):
Revision 1.101 by root, Wed Jan 18 10:11:03 2006 UTC vs.
Revision 1.134 by root, Sat Feb 11 02:31:13 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.
93		121
94	Other extensions can extend this popup menu by pushing a code reference onto	122	Other extensions can extend this popup menu by pushing a code reference
95	C<@urxvt::ext::selection_popup::hook>, that is called whenever the popup is displayed.	123	onto C<@{ $term->{selection_popup_hook} }>, which gets called whenever the
		124	popup is being displayed.
96		125
97	It's sole argument is the popup menu, which can be modified. The selection	126	It's sole argument is the popup menu, which can be modified. The selection
98	is in C<$_>, which can be used to decide wether to add something or not.	127	is in C<$_>, which can be used to decide wether to add something or not.
99	It should either return nothing or a string and a code reference. The	128	It should either return nothing or a string and a code reference. The
100	string will be used as button text and the code reference will be called	129	string will be used as button text and the code reference will be called
…		…
102		131
103	The following will add an entry C<a to b> that transforms all C<a>s in	132	The following will add an entry C<a to b> that transforms all C<a>s in
104	the selection to C<b>s, but only if the selection currently contains any	133	the selection to C<b>s, but only if the selection currently contains any
105	C<a>s:	134	C<a>s:
106		135
107	push urxvt::ext::selection_popup::hook, sub {	136	push @{ $self->{term}{selection_popup_hook} }, sub {
108	/a/ ? ("a to be" => sub { s/a/b/g }	137	/a/ ? ("a to be" => sub { s/a/b/g }
109	: ()	138	: ()
110	};	139	};
111		140
112	=item searchable-scrollback<hotkey> (enabled by default)	141	=item searchable-scrollback<hotkey> (enabled by default)
…		…
122	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
123	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
124	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
125	selection.	154	selection.
126		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
127	=item selection-autotransform	181	=item selection-autotransform
128		182
129	This selection allows you to do automatic transforms on a selection	183	This selection allows you to do automatic transforms on a selection
130	whenever a selection is made.	184	whenever a selection is made.
131		185
…		…
143	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/
144		198
145	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
146	paste directly into your (vi :) editor:	200	paste directly into your (vi :) editor:
147		201
148	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/
149		203
150	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 :)
151		205
152	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
153	FILENAME line YYY."), you need a slightly more elaborate solution:	207	FILENAME line YYY."), you need a slightly more elaborate solution:
154		208
155	URxvt.selection.pattern-0: ( at .*? line \\d+\\.)	209	URxvt.selection.pattern-0: ( at .*? line \\d+[,.])
156	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/
157		211
158	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
159	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
160	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.
161		238
162	=item mark-urls	239	=item mark-urls
163		240
164	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
165	make them clickable. When middle-clicked, the program specified in the	242	make them clickable. When middle-clicked, the program specified in the
166	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
167	the URL as first argument.	244	the URL as first argument.
168		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
169	=item block-graphics-to-ascii	266	=item block-graphics-to-ascii
170		267
171	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,
172	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
173	similar-looking ascii character.	270	similar-looking ascii character.
174		271
175	=item digital-clock	272	=item digital-clock
176		273
177	Displays a digital clock using the built-in overlay.	274	Displays a digital clock using the built-in overlay.
178		275
179	=item example-refresh-hooks	276	=item remote-clipboard
180		277
181	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
182	window. Illustrates overwriting the refresh callbacks to create your own	279	selection popup that allows one ti run external commands to store the
183	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'
184		295
185	=item selection-pastebin	296	=item selection-pastebin
186		297
187	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
188	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
…		…
208	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
209	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
210	for the filename):	321	for the filename):
211		322
212	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.
213		330
214	=back	331	=back
215		332
216	=head1 API DOCUMENTATION	333	=head1 API DOCUMENTATION
217		334
…		…
290	called whenever the relevant event happens.	407	called whenever the relevant event happens.
291		408
292	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
293	the in the C<Extension Objects> section.	410	the in the C<Extension Objects> section.
294		411
295	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
296	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
297	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.
298		415
299	I<< When in doubt, return a false value (preferably C<()>). >>	416	I<< When in doubt, return a false value (preferably C<()>). >>
300		417
301	=over 4	418	=over 4
302		419
303	=item on_init $term	420	=item on_init $term
304		421
305	Called after a new terminal object has been initialized, but before	422	Called after a new terminal object has been initialized, but before
306	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
307	call or deliver senseless data, as terminal size and other characteristics	424	call or deliver senseless data, as terminal size and other characteristics
308	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
309	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).
310		438
311	=item on_reset $term	439	=item on_reset $term
312		440
313	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
314	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
315	variables.	443	variables.
316		444
317	=item on_start $term	445	=item on_child_start $term, $pid
318		446
319	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.
320	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>.
321		453
322	=item on_sel_make $term, $eventtime	454	=item on_sel_make $term, $eventtime
323		455
324	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
325	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
…		…
412		544
413	=item on_refresh_end $term	545	=item on_refresh_end $term
414		546
415	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>.
416		548
417	=item on_keyboard_command $term, $string	549	=item on_user_command $term, $string
418		550
419	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
420	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>
421	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.
		557
		558	=item on_resize_all_windows $tern, $new_width, $new_height
		559
		560	Called just after the new window size has been calculcated, but before
		561	windows are actually being resized or hints are being set. If this hook
		562	returns TRUE, setting of the window hints is being skipped.
422		563
423	=item on_x_event $term, $event	564	=item on_x_event $term, $event
424		565
425	Called on every X event received on the vt window (and possibly other	566	Called on every X event received on the vt window (and possibly other
426	windows). Should only be used as a last resort. Most event structure	567	windows). Should only be used as a last resort. Most event structure
…		…
434	=item on_focus_out $term	575	=item on_focus_out $term
435		576
436	Called wheneever the window loses keyboard focus, before rxvt-unicode does	577	Called wheneever the window loses keyboard focus, before rxvt-unicode does
437	focus out processing.	578	focus out processing.
438		579
		580	=item on_configure_notify $term, $event
		581
		582	=item on_property_notify $term, $event
		583
439	=item on_key_press $term, $event, $keysym, $octets	584	=item on_key_press $term, $event, $keysym, $octets
440		585
441	=item on_key_release $term, $event, $keysym	586	=item on_key_release $term, $event, $keysym
442		587
443	=item on_button_press $term, $event	588	=item on_button_press $term, $event
…		…
452		597
453	Called whenever the corresponding X event is received for the terminal If	598	Called whenever the corresponding X event is received for the terminal If
454	the hook returns true, then the even will be ignored by rxvt-unicode.	599	the hook returns true, then the even will be ignored by rxvt-unicode.
455		600
456	The event is a hash with most values as named by Xlib (see the XEvent	601	The event is a hash with most values as named by Xlib (see the XEvent
457	manpage), with the additional members C<row> and C<col>, which are the row	602	manpage), with the additional members C<row> and C<col>, which are the
458	and column under the mouse cursor.	603	(real, not screen-based) row and column under the mouse cursor.
459		604
460	C<on_key_press> additionally receives the string rxvt-unicode would	605	C<on_key_press> additionally receives the string rxvt-unicode would
461	output, if any, in locale-specific encoding.	606	output, if any, in locale-specific encoding.
462		607
463	subwindow.	608	subwindow.
		609
		610	=item on_client_message $term, $event
		611
		612	=item on_wm_protocols $term, $event
		613
		614	=item on_wm_delete_window $term, $event
		615
		616	Called when various types of ClientMessage events are received (all with
		617	format=32, WM_PROTOCOLS or WM_PROTOCOLS:WM_DELETE_WINDOW).
464		618
465	=back	619	=back
466		620
467	=cut	621	=cut
468		622
…		…
474	use Scalar::Util ();	628	use Scalar::Util ();
475	use List::Util ();	629	use List::Util ();
476		630
477	our $VERSION = 1;	631	our $VERSION = 1;
478	our $TERM;	632	our $TERM;
		633	our @TERM_INIT;
		634	our @TERM_EXT;
479	our @HOOKNAME;	635	our @HOOKNAME;
480	our %HOOKTYPE = map +($HOOKNAME[$_] => $_), 0..$#HOOKNAME;	636	our %HOOKTYPE = map +($HOOKNAME[$_] => $_), 0..$#HOOKNAME;
481	our %OPTION;	637	our %OPTION;
482		638
483	our $LIBDIR;	639	our $LIBDIR;
484	our $RESNAME;	640	our $RESNAME;
485	our $RESCLASS;	641	our $RESCLASS;
486	our $RXVTNAME;	642	our $RXVTNAME;
487		643
		644	our $NOCHAR = chr 0xffff;
		645
488	=head2 Variables in the C<urxvt> Package	646	=head2 Variables in the C<urxvt> Package
489		647
490	=over 4	648	=over 4
491		649
492	=item $urxvt::LIBDIR	650	=item $urxvt::LIBDIR
…		…
504		662
505	=item $urxvt::TERM	663	=item $urxvt::TERM
506		664
507	The current terminal. This variable stores the current C<urxvt::term>	665	The current terminal. This variable stores the current C<urxvt::term>
508	object, whenever a callback/hook is executing.	666	object, whenever a callback/hook is executing.
		667
		668	=item @urxvt::TERM_INIT
		669
		670	All coderefs in this array will be called as methods of the next newly
		671	created C<urxvt::term> object (during the C<on_init> phase). The array
		672	gets cleared before the codereferences that were in it are being executed,
		673	so coderefs can push themselves onto it again if they so desire.
		674
		675	This complements to the perl-eval commandline option, but gets executed
		676	first.
		677
		678	=item @urxvt::TERM_EXT
		679
		680	Works similar to C<@TERM_INIT>, but contains perl package/class names, which
		681	get registered as normal extensions after calling the hooks in C<@TERM_INIT>
		682	but before other extensions. Gets cleared just like C<@TERM_INIT>.
509		683
510	=back	684	=back
511		685
512	=head2 Functions in the C<urxvt> Package	686	=head2 Functions in the C<urxvt> Package
513		687
…		…
527		701
528	Using this function has the advantage that its output ends up in the	702	Using this function has the advantage that its output ends up in the
529	correct place, e.g. on stderr of the connecting urxvtc client.	703	correct place, e.g. on stderr of the connecting urxvtc client.
530		704
531	Messages have a size limit of 1023 bytes currently.	705	Messages have a size limit of 1023 bytes currently.
		706
		707	=item @terms = urxvt::termlist
		708
		709	Returns all urxvt::term objects that exist in this process, regardless of
		710	wether they are started, being destroyed etc., so be careful. Only term
		711	objects that have perl extensions attached will be returned (because there
		712	is no urxvt::term objet associated with others).
532		713
533	=item $time = urxvt::NOW	714	=item $time = urxvt::NOW
534		715
535	Returns the "current time" (as per the event loop).	716	Returns the "current time" (as per the event loop).
536		717
…		…
594	Return the foreground/background colour index, respectively.	775	Return the foreground/background colour index, respectively.
595		776
596	=item $rend = urxvt::SET_FGCOLOR $rend, $new_colour	777	=item $rend = urxvt::SET_FGCOLOR $rend, $new_colour
597		778
598	=item $rend = urxvt::SET_BGCOLOR $rend, $new_colour	779	=item $rend = urxvt::SET_BGCOLOR $rend, $new_colour
		780
		781	=item $rend = urxvt::SET_COLOR $rend, $new_fg, $new_bg
599		782
600	Replace the foreground/background colour in the rendition mask with the	783	Replace the foreground/background colour in the rendition mask with the
601	specified one.	784	specified one.
602		785
603	=item $value = urxvt::GET_CUSTOM $rend	786	=item $value = urxvt::GET_CUSTOM $rend
…		…
620	my $msg = join "", @_;	803	my $msg = join "", @_;
621	$msg .= "\n"	804	$msg .= "\n"
622	unless $msg =~ /\n$/;	805	unless $msg =~ /\n$/;
623	urxvt::warn ($msg);	806	urxvt::warn ($msg);
624	};	807	};
625
626	# %ENV is the original startup environment
627	delete $ENV{IFS};
628	delete $ENV{CDPATH};
629	delete $ENV{BASH_ENV};
630	$ENV{PATH} = "/bin:/sbin:/usr/bin:/usr/sbin:/usr/local/bin:/usr/local/sbin:/opt/bin:/opt/sbin";
631	}	808	}
		809
		810	no warnings 'utf8';
632		811
633	my $verbosity = $ENV{URXVT_PERL_VERBOSITY};	812	my $verbosity = $ENV{URXVT_PERL_VERBOSITY};
634		813
635	sub verbose {	814	sub verbose {
636	my ($level, $msg) = @_;	815	my ($level, $msg) = @_;
…		…
640	my %extension_pkg;	819	my %extension_pkg;
641		820
642	# load a single script into its own package, once only	821	# load a single script into its own package, once only
643	sub extension_package($) {	822	sub extension_package($) {
644	my ($path) = @_;	823	my ($path) = @_;
645
646	no strict 'refs';
647		824
648	$extension_pkg{$path} \|\|= do {	825	$extension_pkg{$path} \|\|= do {
649	$path =~ /([^\/\\]+)$/;	826	$path =~ /([^\/\\]+)$/;
650	my $pkg = $1;	827	my $pkg = $1;
651	$pkg =~ s/[^[:word:]]/_/g;	828	$pkg =~ s/[^[:word:]]/_/g;
…		…
654	verbose 3, "loading extension '$path' into package '$pkg'";	831	verbose 3, "loading extension '$path' into package '$pkg'";
655		832
656	open my $fh, "<:raw", $path	833	open my $fh, "<:raw", $path
657	or die "$path: $!";	834	or die "$path: $!";
658		835
659	@{"$pkg\::ISA"} = urxvt::term::extension::;
660
661	my $source =	836	my $source =
662	"package $pkg; use strict; use utf8;\n"	837	"package $pkg; use strict; use utf8; no warnings 'utf8';\n"
663	. "#line 1 \"$path\"\n{\n"	838	. "#line 1 \"$path\"\n{\n"
664	. (do { local $/; <$fh> })	839	. (do { local $/; <$fh> })
665	. "\n};\n1";	840	. "\n};\n1";
666		841
667	eval $source	842	eval $source
…		…
681	if ($htype == 0) { # INIT	856	if ($htype == 0) { # INIT
682	my @dirs = ((split /:/, $TERM->resource ("perl_lib")), "$LIBDIR/perl");	857	my @dirs = ((split /:/, $TERM->resource ("perl_lib")), "$LIBDIR/perl");
683		858
684	my %ext_arg;	859	my %ext_arg;
685		860
		861	{
		862	my @init = @TERM_INIT;
		863	@TERM_INIT = ();
		864	$_->($TERM) for @init;
		865	my @pkg = @TERM_EXT;
		866	@TERM_EXT = ();
		867	$TERM->register_package ($_) for @pkg;
		868	}
		869
686	for (map { split /,/, $TERM->resource ("perl_ext_$_") } 1, 2) {	870	for (grep $_, map { split /,/, $TERM->resource ("perl_ext_$_") } 1, 2) {
687	if ($_ eq "default") {	871	if ($_ eq "default") {
688	$ext_arg{$_} \|\|= [] for qw(selection option-popup selection-popup searchable-scrollback);	872	$ext_arg{$_} \|\|= [] for qw(selection option-popup selection-popup searchable-scrollback readline);
689	} elsif (/^-(.*)$/) {	873	} elsif (/^-(.*)$/) {
690	delete $ext_arg{$1};	874	delete $ext_arg{$1};
691	} elsif (/^([^<]+)<(.*)>$/) {	875	} elsif (/^([^<]+)<(.*)>$/) {
692	push @{ $ext_arg{$1} }, $2;	876	push @{ $ext_arg{$1} }, $2;
693	} else {	877	} else {
694	$ext_arg{$_} \|\|= [];	878	$ext_arg{$_} \|\|= [];
695	}	879	}
696	}	880	}
697		881
698	while (my ($ext, $argv) = each %ext_arg) {	882	for my $ext (sort keys %ext_arg) {
699	my @files = grep -f $_, map "$_/$ext", @dirs;	883	my @files = grep -f $_, map "$_/$ext", @dirs;
700		884
701	if (@files) {	885	if (@files) {
702	$TERM->register_package (extension_package $files[0], $argv);	886	$TERM->register_package (extension_package $files[0], $ext_arg{$ext});
703	} else {	887	} else {
704	warn "perl extension '$ext' not found in perl library search path\n";	888	warn "perl extension '$ext' not found in perl library search path\n";
705	}	889	}
706	}	890	}
707		891
…		…
716	if $verbosity >= 10;	900	if $verbosity >= 10;
717		901
718	keys %$cb;	902	keys %$cb;
719		903
720	while (my ($pkg, $cb) = each %$cb) {	904	while (my ($pkg, $cb) = each %$cb) {
721	$retval = eval { $cb->($TERM->{_pkg}{$pkg}, @_) }	905	my $retval_ = eval { $cb->($TERM->{_pkg}{$pkg}, @_) };
722	and last;	906	$retval \|\|= $retval_;
723		907
724	if ($@) {	908	if ($@) {
725	$TERM->ungrab; # better to lose the grab than the session	909	$TERM->ungrab; # better to lose the grab than the session
726	warn $@;	910	warn $@;
727	}	911	}
…		…
740	}	924	}
741		925
742	$retval	926	$retval
743	}	927	}
744		928
745	sub exec_async(@) {	929	sub SET_COLOR($$$) {
746	my $pid = fork;	930	SET_BGCOLOR (SET_FGCOLOR ($_[0], $_[1]), $_[2])
747
748	return
749	if !defined $pid or $pid;
750
751	%ENV = %{ $TERM->env };
752
753	exec @_;
754	_exit 255;
755	}	931	}
756		932
757	# urxvt::term::extension	933	# urxvt::term::extension
758		934
759	package urxvt::term::extension;	935	package urxvt::term::extension;
…		…
898	# find on_xxx subs in the package and register them	1074	# find on_xxx subs in the package and register them
899	# as hooks	1075	# as hooks
900	sub register_package {	1076	sub register_package {
901	my ($self, $pkg, $argv) = @_;	1077	my ($self, $pkg, $argv) = @_;
902		1078
		1079	no strict 'refs';
		1080
		1081	urxvt::verbose 6, "register package $pkg to $self";
		1082
		1083	@{"$pkg\::ISA"} = urxvt::term::extension::;
		1084
903	my $proxy = bless {	1085	my $proxy = bless {
904	_pkg => $pkg,	1086	_pkg => $pkg,
905	argv => $argv,	1087	argv => $argv,
906	}, $pkg;	1088	}, $pkg;
907	Scalar::Util::weaken ($proxy->{term} = $self);	1089	Scalar::Util::weaken ($proxy->{term} = $self);
…		…
922	hash which defines the environment of the new terminal.	1104	hash which defines the environment of the new terminal.
923		1105
924	Croaks (and probably outputs an error message) if the new instance	1106	Croaks (and probably outputs an error message) if the new instance
925	couldn't be created. Returns C<undef> if the new instance didn't	1107	couldn't be created. Returns C<undef> if the new instance didn't
926	initialise perl, and the terminal object otherwise. The C<init> and	1108	initialise perl, and the terminal object otherwise. The C<init> and
927	C<start> hooks will be called during this call.	1109	C<start> hooks will be called before this call returns, and are free to
		1110	refer to global data (which is race free).
928		1111
929	=cut	1112	=cut
930		1113
931	sub new {	1114	sub new {
932	my ($class, $env, @args) = @_;	1115	my ($class, $env, @args) = @_;
933		1116
		1117	$env or Carp::croak "environment hash missing in call to urxvt::term->new";
		1118	@args or Carp::croak "name argument missing in call to urxvt::term->new";
		1119
934	_new ([ map "$_=$env->{$_}", keys %$env ], @args);	1120	_new ([ map "$_=$env->{$_}", keys %$env ], \@args);
935	}	1121	}
936		1122
937	=item $term->destroy	1123	=item $term->destroy
938		1124
939	Destroy the terminal object (close the window, free resources	1125	Destroy the terminal object (close the window, free resources
940	etc.). Please note that @@RXVT_NAME@@ will not exit as long as any event	1126	etc.). Please note that @@RXVT_NAME@@ will not exit as long as any event
941	watchers (timers, io watchers) are still active.	1127	watchers (timers, io watchers) are still active.
942		1128
		1129	=item $term->exec_async ($cmd[, @args])
		1130
		1131	Works like the combination of the C<fork>/C<exec> builtins, which executes
		1132	("starts") programs in the background. This function takes care of setting
		1133	the user environment before exec'ing the command (e.g. C<PATH>) and should
		1134	be preferred over explicit calls to C<exec> or C<system>.
		1135
		1136	Returns the pid of the subprocess or C<undef> on error.
		1137
		1138	=cut
		1139
		1140	sub exec_async {
		1141	my $self = shift;
		1142
		1143	my $pid = fork;
		1144
		1145	return $pid
		1146	if !defined $pid or $pid;
		1147
		1148	%ENV = %{ $self->env };
		1149
		1150	exec @_;
		1151	urxvt::_exit 255;
		1152	}
		1153
943	=item $isset = $term->option ($optval[, $set])	1154	=item $isset = $term->option ($optval[, $set])
944		1155
945	Returns true if the option specified by C<$optval> is enabled, and	1156	Returns true if the option specified by C<$optval> is enabled, and
946	optionally change it. All option values are stored by name in the hash	1157	optionally change it. All option values are stored by name in the hash
947	C<%urxvt::OPTION>. Options not enabled in this binary are not in the hash.	1158	C<%urxvt::OPTION>. Options not enabled in this binary are not in the hash.
…		…
949	Here is a a likely non-exhaustive list of option names, please see the	1160	Here is a a likely non-exhaustive list of option names, please see the
950	source file F</src/optinc.h> to see the actual list:	1161	source file F</src/optinc.h> to see the actual list:
951		1162
952	borderLess console cursorBlink cursorUnderline hold iconic insecure	1163	borderLess console cursorBlink cursorUnderline hold iconic insecure
953	intensityStyles jumpScroll loginShell mapAlert meta8 mouseWheelScrollPage	1164	intensityStyles jumpScroll loginShell mapAlert meta8 mouseWheelScrollPage
954	pastableTabs pointerBlank reverseVideo scrollBar scrollBar_floating	1165	override-redirect pastableTabs pointerBlank reverseVideo scrollBar
955	scrollBar_right scrollTtyKeypress scrollTtyOutput scrollWithBuffer	1166	scrollBar_floating scrollBar_right scrollTtyKeypress scrollTtyOutput
956	secondaryScreen secondaryScroll skipBuiltinGlyphs transparent	1167	scrollWithBuffer secondaryScreen secondaryScroll skipBuiltinGlyphs
957	tripleclickwords utmpInhibit visualBell	1168	transparent tripleclickwords utmpInhibit visualBell
958		1169
959	=item $value = $term->resource ($name[, $newval])	1170	=item $value = $term->resource ($name[, $newval])
960		1171
961	Returns the current resource value associated with a given name and	1172	Returns the current resource value associated with a given name and
962	optionally sets a new value. Setting values is most useful in the C<init>	1173	optionally sets a new value. Setting values is most useful in the C<init>
…		…
979		1190
980	answerbackstring backgroundPixmap backspace_key boldFont boldItalicFont	1191	answerbackstring backgroundPixmap backspace_key boldFont boldItalicFont
981	borderLess color cursorBlink cursorUnderline cutchars delete_key	1192	borderLess color cursorBlink cursorUnderline cutchars delete_key
982	display_name embed ext_bwidth fade font geometry hold iconName	1193	display_name embed ext_bwidth fade font geometry hold iconName
983	imFont imLocale inputMethod insecure int_bwidth intensityStyles	1194	imFont imLocale inputMethod insecure int_bwidth intensityStyles
984	italicFont jumpScroll lineSpace loginShell mapAlert menu meta8 modifier	1195	italicFont jumpScroll lineSpace loginShell mapAlert meta8 modifier
985	mouseWheelScrollPage name pastableTabs path perl_eval perl_ext_1 perl_ext_2	1196	mouseWheelScrollPage name override_redirect pastableTabs path perl_eval
986	perl_lib pointerBlank pointerBlankDelay preeditType print_pipe pty_fd	1197	perl_ext_1 perl_ext_2 perl_lib pointerBlank pointerBlankDelay
987	reverseVideo saveLines scrollBar scrollBar_align scrollBar_floating	1198	preeditType print_pipe pty_fd reverseVideo saveLines scrollBar
988	scrollBar_right scrollBar_thickness scrollTtyKeypress scrollTtyOutput	1199	scrollBar_align scrollBar_floating scrollBar_right scrollBar_thickness
989	scrollWithBuffer scrollstyle secondaryScreen secondaryScroll selectstyle	1200	scrollTtyKeypress scrollTtyOutput scrollWithBuffer scrollstyle
990	shade term_name title transparent transparent_all tripleclickwords	1201	secondaryScreen secondaryScroll selectstyle shade term_name title
991	utmpInhibit visualBell	1202	transient_for transparent transparent_all tripleclickwords utmpInhibit
		1203	visualBell
992		1204
993	=cut	1205	=cut
994		1206
995	sub resource($$;$) {	1207	sub resource($$;$) {
996	my ($self, $name) = (shift, shift);	1208	my ($self, $name) = (shift, shift);
…		…
1170		1382
1171	Normally its not a good idea to use this function, as programs might be	1383	Normally its not a good idea to use this function, as programs might be
1172	confused by changes in cursor position or scrolling. Its useful inside a	1384	confused by changes in cursor position or scrolling. Its useful inside a
1173	C<on_add_lines> hook, though.	1385	C<on_add_lines> hook, though.
1174		1386
		1387	=item $term->scr_change_screen ($screen)
		1388
		1389	Switch to given screen - 0 primary, 1 secondary.
		1390
1175	=item $term->cmd_parse ($octets)	1391	=item $term->cmd_parse ($octets)
1176		1392
1177	Similar to C<scr_add_lines>, but the argument must be in the	1393	Similar to C<scr_add_lines>, but the argument must be in the
1178	locale-specific encoding of the terminal and can contain command sequences	1394	locale-specific encoding of the terminal and can contain command sequences
1179	(escape codes) that will be interpreted.	1395	(escape codes) that will be interpreted.
…		…
1189	Replaces the event mask of the pty watcher by the given event mask. Can	1405	Replaces the event mask of the pty watcher by the given event mask. Can
1190	be used to suppress input and output handling to the pty/tty. See the	1406	be used to suppress input and output handling to the pty/tty. See the
1191	description of C<< urxvt::timer->events >>. Make sure to always restore	1407	description of C<< urxvt::timer->events >>. Make sure to always restore
1192	the previous value.	1408	the previous value.
1193		1409
		1410	=item $fd = $term->pty_fd
		1411
		1412	Returns the master file descriptor for the pty in use, or C<-1> if no pty
		1413	is used.
		1414
1194	=item $windowid = $term->parent	1415	=item $windowid = $term->parent
1195		1416
1196	Return the window id of the toplevel window.	1417	Return the window id of the toplevel window.
1197		1418
1198	=item $windowid = $term->vt	1419	=item $windowid = $term->vt
…		…
1203		1424
1204	Adds the specified events to the vt event mask. Useful e.g. when you want	1425	Adds the specified events to the vt event mask. Useful e.g. when you want
1205	to receive pointer events all the times:	1426	to receive pointer events all the times:
1206		1427
1207	$term->vt_emask_add (urxvt::PointerMotionMask);	1428	$term->vt_emask_add (urxvt::PointerMotionMask);
		1429
		1430	=item $term->focus_in
		1431
		1432	=item $term->focus_out
		1433
		1434	=item $term->key_press ($state, $keycode[, $time])
		1435
		1436	=item $term->key_release ($state, $keycode[, $time])
		1437
		1438	Deliver various fake events to to terminal.
1208		1439
1209	=item $window_width = $term->width	1440	=item $window_width = $term->width
1210		1441
1211	=item $window_height = $term->height	1442	=item $window_height = $term->height
1212		1443
…		…
1262	=item $modifiermask = $term->ModNumLockMask	1493	=item $modifiermask = $term->ModNumLockMask
1263		1494
1264	Return the modifier masks corresponding to the "ISO Level 3 Shift" (often	1495	Return the modifier masks corresponding to the "ISO Level 3 Shift" (often
1265	AltGr), the meta key (often Alt) and the num lock key, if applicable.	1496	AltGr), the meta key (often Alt) and the num lock key, if applicable.
1266		1497
		1498	=item $screen = $term->current_screen
		1499
		1500	Returns the currently displayed screen (0 primary, 1 secondary).
		1501
		1502	=item $cursor_is_hidden = $term->hidden_cursor
		1503
		1504	Returns wether the cursor is currently hidden or not.
		1505
1267	=item $view_start = $term->view_start ([$newvalue])	1506	=item $view_start = $term->view_start ([$newvalue])
1268		1507
1269	Returns the row number of the topmost displayed line. Maximum value is	1508	Returns the row number of the topmost displayed line. Maximum value is
1270	C<0>, which displays the normal terminal contents. Lower values scroll	1509	C<0>, which displays the normal terminal contents. Lower values scroll
1271	this many lines into the scrollback buffer.	1510	this many lines into the scrollback buffer.
…		…
1290	line, starting at column C<$start_col> (default C<0>), which is useful	1529	line, starting at column C<$start_col> (default C<0>), which is useful
1291	to replace only parts of a line. The font index in the rendition will	1530	to replace only parts of a line. The font index in the rendition will
1292	automatically be updated.	1531	automatically be updated.
1293		1532
1294	C<$text> is in a special encoding: tabs and wide characters that use more	1533	C<$text> is in a special encoding: tabs and wide characters that use more
1295	than one cell when displayed are padded with urxvt::NOCHAR characters	1534	than one cell when displayed are padded with C<$urxvt::NOCHAR> (chr 65535)
1296	(C<chr 65535>). Characters with combining characters and other characters	1535	characters. Characters with combining characters and other characters that
1297	that do not fit into the normal tetx encoding will be replaced with	1536	do not fit into the normal tetx encoding will be replaced with characters
1298	characters in the private use area.	1537	in the private use area.
1299		1538
1300	You have to obey this encoding when changing text. The advantage is	1539	You have to obey this encoding when changing text. The advantage is
1301	that C<substr> and similar functions work on screen cells and not on	1540	that C<substr> and similar functions work on screen cells and not on
1302	characters.	1541	characters.
1303		1542
…		…
1450	=item $string = $term->special_decode $text	1689	=item $string = $term->special_decode $text
1451		1690
1452	Converts rxvt-unicodes text reprsentation into a perl string. See	1691	Converts rxvt-unicodes text reprsentation into a perl string. See
1453	C<< $term->ROW_t >> for details.	1692	C<< $term->ROW_t >> for details.
1454		1693
1455	=item $success = $term->grab_button ($button, $modifiermask)	1694	=item $success = $term->grab_button ($button, $modifiermask[, $window = $term->vt])
1456		1695
		1696	=item $term->ungrab_button ($button, $modifiermask[, $window = $term->vt])
		1697
1457	Registers a synchronous button grab. See the XGrabButton manpage.	1698	Register/unregister a synchronous button grab. See the XGrabButton
		1699	manpage.
1458		1700
1459	=item $success = $term->grab ($eventtime[, $sync])	1701	=item $success = $term->grab ($eventtime[, $sync])
1460		1702
1461	Calls XGrabPointer and XGrabKeyboard in asynchronous (default) or	1703	Calls XGrabPointer and XGrabKeyboard in asynchronous (default) or
1462	synchronous (C<$sync> is true). Also remembers the grab timestampe.	1704	synchronous (C<$sync> is true). Also remembers the grab timestampe.
…		…
1477	=item $term->ungrab	1719	=item $term->ungrab
1478		1720
1479	Calls XUngrab for the most recent grab. Is called automatically on	1721	Calls XUngrab for the most recent grab. Is called automatically on
1480	evaluation errors, as it is better to lose the grab in the error case as	1722	evaluation errors, as it is better to lose the grab in the error case as
1481	the session.	1723	the session.
		1724
		1725	=item $atom = $term->XInternAtom ($atom_name[, $only_if_exists])
		1726
		1727	=item $atom_name = $term->XGetAtomName ($atom)
		1728
		1729	=item @atoms = $term->XListProperties ($window)
		1730
		1731	=item ($type,$format,$octets) = $term->XGetWindowProperty ($window, $property)
		1732
		1733	=item $term->XChangeWindowProperty ($window, $property, $type, $format, $octets)
		1734
		1735	=item $term->XDeleteProperty ($window, $property)
		1736
		1737	=item $window = $term->DefaultRootWindow
		1738
		1739	=item $term->XReparentWindow ($window, $parent, [$x, $y])
		1740
		1741	=item $term->XMapWindow ($window)
		1742
		1743	=item $term->XUnmapWindow ($window)
		1744
		1745	=item $term->XMoveResizeWindow ($window, $x, $y, $width, $height)
		1746
		1747	=item ($x, $y, $child_window) = $term->XTranslateCoordinates ($src, $dst, $x, $y)
		1748
		1749	=item $term->XChangeInput ($window, $add_events[, $del_events])
		1750
		1751	Various X or X-related functions. The C<$term> object only serves as
		1752	the source of the display, otherwise those functions map more-or-less
		1753	directory onto the X functions of the same name.
1482		1754
1483	=back	1755	=back
1484		1756
1485	=cut	1757	=cut
1486		1758
…		…
1550	my ($self, $text, $cb) = @_;	1822	my ($self, $text, $cb) = @_;
1551		1823
1552	$self->add_item ({ type => "button", text => $text, activate => $cb});	1824	$self->add_item ({ type => "button", text => $text, activate => $cb});
1553	}	1825	}
1554		1826
1555	=item $popup->add_toggle ($text, $cb, $initial_value)	1827	=item $popup->add_toggle ($text, $initial_value, $cb)
1556		1828
1557	Adds a toggle/checkbox item to the popup. Teh callback gets called	1829	Adds a toggle/checkbox item to the popup. The callback gets called
1558	whenever it gets toggled, with a boolean indicating its value as its first	1830	whenever it gets toggled, with a boolean indicating its new value as its
1559	argument.	1831	first argument.
1560		1832
1561	=cut	1833	=cut
1562		1834
1563	sub add_toggle {	1835	sub add_toggle {
1564	my ($self, $text, $cb, $value) = @_;	1836	my ($self, $text, $value, $cb) = @_;
1565		1837
1566	my $item; $item = {	1838	my $item; $item = {
1567	type => "button",	1839	type => "button",
1568	text => " $text",	1840	text => " $text",
1569	value => $value,	1841	value => $value,
…		…
1588	my $env = $self->{term}->env;	1860	my $env = $self->{term}->env;
1589	# we can't hope to reproduce the locale algorithm, so nuke LC_ALL and set LC_CTYPE.	1861	# we can't hope to reproduce the locale algorithm, so nuke LC_ALL and set LC_CTYPE.
1590	delete $env->{LC_ALL};	1862	delete $env->{LC_ALL};
1591	$env->{LC_CTYPE} = $self->{term}->locale;	1863	$env->{LC_CTYPE} = $self->{term}->locale;
1592		1864
1593	urxvt::term->new ($env, $self->{term}->resource ("name"),	1865	urxvt::term->new ($env, "popup",
1594	"--perl-lib" => "", "--perl-ext-common" => "", "-pty-fd" => -1, "-sl" => 0, "-b" => 0,	1866	"--perl-lib" => "", "--perl-ext-common" => "",
		1867	"-pty-fd" => -1, "-sl" => 0,
		1868	"-b" => 1, "-bd" => "grey80", "-bl", "-override-redirect",
1595	"--transient-for" => $self->{term}->parent,	1869	"--transient-for" => $self->{term}->parent,
1596	"-display" => $self->{term}->display_id,	1870	"-display" => $self->{term}->display_id,
1597	"-pe" => "urxvt-popup")	1871	"-pe" => "urxvt-popup")
1598	or die "unable to create popup window\n";	1872	or die "unable to create popup window\n";
1599	}	1873	}
…		…
1604	delete $self->{term}{_destroy}{$self};	1878	delete $self->{term}{_destroy}{$self};
1605	$self->{term}->ungrab;	1879	$self->{term}->ungrab;
1606	}	1880	}
1607		1881
1608	=back	1882	=back
		1883
		1884	=cut
		1885
		1886	package urxvt::watcher;
		1887
		1888	@urxvt::timer::ISA = __PACKAGE__;
		1889	@urxvt::iow::ISA = __PACKAGE__;
		1890	@urxvt::pw::ISA = __PACKAGE__;
		1891	@urxvt::iw::ISA = __PACKAGE__;
1609		1892
1610	=head2 The C<urxvt::timer> Class	1893	=head2 The C<urxvt::timer> Class
1611		1894
1612	This class implements timer watchers/events. Time is represented as a	1895	This class implements timer watchers/events. Time is represented as a
1613	fractional number of seconds since the epoch. Example:	1896	fractional number of seconds since the epoch. Example:
…		…
1651	Start the timer.	1934	Start the timer.
1652		1935
1653	=item $timer = $timer->start ($tstamp)	1936	=item $timer = $timer->start ($tstamp)
1654		1937
1655	Set the event trigger time to C<$tstamp> and start the timer.	1938	Set the event trigger time to C<$tstamp> and start the timer.
		1939
		1940	=item $timer = $timer->after ($delay)
		1941
		1942	Like C<start>, but sets the expiry timer to c<urxvt::NOW + $delay>.
1656		1943
1657	=item $timer = $timer->stop	1944	=item $timer = $timer->stop
1658		1945
1659	Stop the timer.	1946	Stop the timer.
1660		1947
…		…
1707		1994
1708	Stop watching for events on the given filehandle.	1995	Stop watching for events on the given filehandle.
1709		1996
1710	=back	1997	=back
1711		1998
		1999	=head2 The C<urxvt::iw> Class
		2000
		2001	This class implements idle watchers, that get called automatically when
		2002	the process is idle. They should return as fast as possible, after doing
		2003	some useful work.
		2004
		2005	=over 4
		2006
		2007	=item $iw = new urxvt::iw
		2008
		2009	Create a new idle watcher object in stopped state.
		2010
		2011	=item $iw = $iw->cb (sub { my ($iw) = @_; ... })
		2012
		2013	Set the callback to be called when the watcher triggers.
		2014
		2015	=item $timer = $timer->start
		2016
		2017	Start the watcher.
		2018
		2019	=item $timer = $timer->stop
		2020
		2021	Stop the watcher.
		2022
		2023	=back
		2024
		2025	=head2 The C<urxvt::pw> Class
		2026
		2027	This class implements process watchers. They create an event whenever a
		2028	process exits, after which they stop automatically.
		2029
		2030	my $pid = fork;
		2031	...
		2032	$term->{pw} = urxvt::pw
		2033	->new
		2034	->start ($pid)
		2035	->cb (sub {
		2036	my ($pw, $exit_status) = @_;
		2037	...
		2038	});
		2039
		2040	=over 4
		2041
		2042	=item $pw = new urxvt::pw
		2043
		2044	Create a new process watcher in stopped state.
		2045
		2046	=item $pw = $pw->cb (sub { my ($pw, $exit_status) = @_; ... })
		2047
		2048	Set the callback to be called when the timer triggers.
		2049
		2050	=item $pw = $timer->start ($pid)
		2051
		2052	Tells the wqtcher to start watching for process C<$pid>.
		2053
		2054	=item $pw = $pw->stop
		2055
		2056	Stop the watcher.
		2057
		2058	=back
		2059
1712	=head1 ENVIRONMENT	2060	=head1 ENVIRONMENT
1713		2061
1714	=head2 URXVT_PERL_VERBOSITY	2062	=head2 URXVT_PERL_VERBOSITY
1715		2063
1716	This variable controls the verbosity level of the perl extension. Higher	2064	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.101 by root, Wed Jan 18 10:11:03 2006 UTC vs. Revision 1.134 by root, Sat Feb 11 02:31:13 2006 UTC

Diff Legend

Comparing rxvt-unicode/src/urxvt.pm (file contents):
Revision 1.101 by root, Wed Jan 18 10:11:03 2006 UTC vs.
Revision 1.134 by root, Sat Feb 11 02:31:13 2006 UTC