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

Comparing rxvt-unicode/src/urxvt.pm (file contents):
Revision 1.88 by root, Thu Jan 12 12:05:28 2006 UTC vs.
Revision 1.131 by root, Sun Jan 29 20:51:28 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 the following bindable keyboard command:	82	This extension also offers following bindable keyboard commands:
72		83
73	=over 4	84	=over 4
74		85
75	=item rot13	86	=item rot13
76		87
…		…
87		98
88	=item selection-popup (enabled by default)	99	=item selection-popup (enabled by default)
89		100
90	Binds a popup menu to Ctrl-Button3 that lets you convert the selection	101	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	102	text into various other formats/action (such as uri unescaping, perl
92	evalution, web-browser starting etc.), depending on content.	103	evaluation, web-browser starting etc.), depending on content.
		104
		105	Other extensions can extend this popup menu by pushing a code reference
		106	onto C<@{ $term->{selection_popup_hook} }>, that is called whenever the
		107	popup is displayed.
		108
		109	It's sole argument is the popup menu, which can be modified. The selection
		110	is in C<$_>, which can be used to decide wether to add something or not.
		111	It should either return nothing or a string and a code reference. The
		112	string will be used as button text and the code reference will be called
		113	when the button gets activated and should transform C<$_>.
		114
		115	The following will add an entry C<a to b> that transforms all C<a>s in
		116	the selection to C<b>s, but only if the selection currently contains any
		117	C<a>s:
		118
		119	push @{ $self->{term}{selection_popup_hook} }, sub {
		120	/a/ ? ("a to be" => sub { s/a/b/g }
		121	: ()
		122	};
93		123
94	=item searchable-scrollback<hotkey> (enabled by default)	124	=item searchable-scrollback<hotkey> (enabled by default)
95		125
96	Adds regex search functionality to the scrollback buffer, triggered	126	Adds regex search functionality to the scrollback buffer, triggered
97	by a hotkey (default: C<M-s>). While in search mode, normal terminal	127	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	134	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	135	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	136	additionally stores the first match in the current line into the primary
107	selection.	137	selection.
108		138
		139	=item readline (enabled by default)
		140
		141	A support package that tries to make editing with readline easier. At the
		142	moment, it reacts to clicking with the left mouse button by trying to
		143	move the text cursor to this position. It does so by generating as many
		144	cursor-left or cursor-right keypresses as required (the this only works
		145	for programs that correctly support wide characters).
		146
		147	To avoid too many false positives, this is only done when:
		148
		149	=over 4
		150
		151	=item - the tty is in ICANON state.
		152
		153	=item - the text cursor is visible.
		154
		155	=item - the primary screen is currently being displayed.
		156
		157	=item - the mouse is on the same (multi-row-) line as the text cursor.
		158
		159	=back
		160
		161	The normal selection mechanism isn't disabled, so quick successive clicks
		162	might interfere with selection creation in harmless ways.
		163
109	=item selection-autotransform	164	=item selection-autotransform
110		165
111	This selection allows you to do automatic transforms on a selection	166	This selection allows you to do automatic transforms on a selection
112	whenever a selection is made.	167	whenever a selection is made.
113		168
…		…
117	URxvt.selection-autotransform.0: transform	172	URxvt.selection-autotransform.0: transform
118	URxvt.selection-autotransform.1: transform	173	URxvt.selection-autotransform.1: transform
119	...	174	...
120		175
121	For example, the following will transform selections of the form	176	For example, the following will transform selections of the form
122	C<word:number> into C<vi +$number $word>:	177	C<filename:number>, often seen in compiler messages, into C<vi +$filename
		178	$word>:
123		179
124	URxvt.selection-autotransform.0: s/^(S+):(d+):?$/vi +$2 $1\\x0d/	180	URxvt.selection-autotransform.0: s/^([^:[:space:]]+):(\\d+):?$/vi +$2 \\Q$1\\E\\x0d/
125		181
126	And this example matches the same,but replaces it with vi-commands you can	182	And this example matches the same,but replaces it with vi-commands you can
127	paste directory into your (vi :) editor:	183	paste directly into your (vi :) editor:
128		184
129	URxvt.selection-autotransform.0: s/^(S+):(d+):?$/\\x1b:e $1\\x0d:$2\\x0d/	185	URxvt.selection-autotransform.0: s/^([^:[:space:]]+(\\d+):?$/:e \\Q$1\\E\\x0d:$2\\x0d/
		186
		187	Of course, this can be modified to suit your needs and your editor :)
		188
		189	To expand the example above to typical perl error messages ("XXX at
		190	FILENAME line YYY."), you need a slightly more elaborate solution:
		191
		192	URxvt.selection.pattern-0: ( at .*? line \\d+[,.])
		193	URxvt.selection-autotransform.0: s/^ at (.*?) line (\\d+)[,.]$/:e \\Q$1\E\\x0d:$2\\x0d/
		194
		195	The first line tells the selection code to treat the unchanging part of
		196	every error message as a selection pattern, and the second line transforms
		197	the message into vi commands to load the file.
		198
		199	=item tabbed
		200
		201	This transforms the terminal into a tabbar with additional terminals, that
		202	is, it implements what is commonly refered to as "tabbed terminal". The topmost line
		203	displays a "[NEW]" button, which, when clicked, will add a new tab, followed by one
		204	button per tab.
		205
		206	Clicking a button will activate that tab. Pressing B<Shift-Left> and
		207	B<Shift-Right> will switch to the tab left or right of the current one,
		208	while B<Shift-Down> creates a new tab.
130		209
131	=item mark-urls	210	=item mark-urls
132		211
133	Uses per-line display filtering (C<on_line_update>) to underline urls and	212	Uses per-line display filtering (C<on_line_update>) to underline urls and
134	make them clickable. When middle-clicked, the program specified in the	213	make them clickable. When middle-clicked, the program specified in the
135	resource C<urlLauncher> (default C<x-www-browser>) will be started with	214	resource C<urlLauncher> (default C<x-www-browser>) will be started with
136	the URL as first argument.	215	the URL as first argument.
137		216
		217	=item xim-onthespot
		218
		219	This (experimental) perl extension implements OnTheSpot editing. It does
		220	not work perfectly, and some input methods don't seem to work well with
		221	OnTheSpot editing in general, but it seems to work at leats for SCIM and
		222	kinput2.
		223
		224	You enable it by specifying this extension and a preedit style of
		225	C<OnTheSpot>, i.e.:
		226
		227	@@RXVT_NAME@@ -pt OnTheSpot -pe xim-onthespot
		228
		229	=item automove-background
		230
		231	This is basically a one-line extension that dynamically changes the background pixmap offset
		232	to the window position, in effect creating the same effect as pseudo transparency with
		233	a custom pixmap. No scaling is supported in this mode. Exmaple:
		234
		235	@@RXVT_NAME@@ -pixmap background.xpm -pe automove-background
		236
138	=item block-graphics-to-ascii	237	=item block-graphics-to-ascii
139		238
140	A not very useful example of filtering all text output to the terminal,	239	A not very useful example of filtering all text output to the terminal,
141	by replacing all line-drawing characters (U+2500 .. U+259F) by a	240	by replacing all line-drawing characters (U+2500 .. U+259F) by a
142	similar-looking ascii character.	241	similar-looking ascii character.
143		242
144	=item digital-clock	243	=item digital-clock
145		244
146	Displays a digital clock using the built-in overlay.	245	Displays a digital clock using the built-in overlay.
		246
		247	=item remote-clipboard
		248
		249	Somewhat of a misnomer, this extension adds two menu entries to the
		250	selection popup that allows one ti run external commands to store the
		251	selection somewhere and fetch it again.
		252
		253	We use it to implement a "distributed selection mechanism", which just
		254	means that one command uploads the file to a remote server, and another
		255	reads it.
		256
		257	The commands can be set using the C<URxvt.remote-selection.store> and
		258	C<URxvt.remote-selection.fetch> resources. The first should read the
		259	selection to store from STDIN (always in UTF-8), the second should provide
		260	the selection data on STDOUT (also in UTF-8).
		261
		262	The defaults (which are likely useless to you) use rsh and cat:
		263
		264	URxvt.remote-selection.store: rsh ruth 'cat >/tmp/distributed-selection'
		265	URxvt.remote-selection.fetch: rsh ruth 'cat /tmp/distributed-selection'
		266
		267	=item selection-pastebin
		268
		269	This is a little rarely useful extension that Uploads the selection as
		270	textfile to a remote site (or does other things). (The implementation is
		271	not currently secure for use in a multiuser environment as it writes to
		272	F</tmp> directly.).
		273
		274	It listens to the C<selection-pastebin:remote-pastebin> keyboard command,
		275	i.e.
		276
		277	URxvt.keysym.C-M-e: perl:selection-pastebin:remote-pastebin
		278
		279	Pressing this combination runs a command with C<%> replaced by the name of
		280	the textfile. This command can be set via a resource:
		281
		282	URxvt.selection-pastebin.cmd: rsync -apP % ruth:/var/www/www.ta-sa.org/files/txt/.
		283
		284	And the default is likely not useful to anybody but the few people around
		285	here :)
		286
		287	The name of the textfile is the hex encoded md5 sum of the selection, so
		288	the same content should lead to the same filename.
		289
		290	After a successful upload the selection will be replaced by the text given
		291	in the C<selection-pastebin-url> resource (again, the % is the placeholder
		292	for the filename):
		293
		294	URxvt.selection-pastebin.url: http://www.ta-sa.org/files/txt/%
147		295
148	=item example-refresh-hooks	296	=item example-refresh-hooks
149		297
150	Displays a very simple digital clock in the upper right corner of the	298	Displays a very simple digital clock in the upper right corner of the
151	window. Illustrates overwriting the refresh callbacks to create your own	299	window. Illustrates overwriting the refresh callbacks to create your own
…		…
230	called whenever the relevant event happens.	378	called whenever the relevant event happens.
231		379
232	The first argument passed to them is an extension oject as described in	380	The first argument passed to them is an extension oject as described in
233	the in the C<Extension Objects> section.	381	the in the C<Extension Objects> section.
234		382
235	B<All> of these hooks must return a boolean value. If it is true, then the	383	B<All> of these hooks must return a boolean value. If any of the called
236	event counts as being I<consumed>, and the invocation of other hooks is	384	hooks returns true, then the event counts as being I<consumed>, and the
237	skipped, and the relevant action might not be carried out by the C++ code.	385	relevant action might not be carried out by the C++ code.
238		386
239	I<< When in doubt, return a false value (preferably C<()>). >>	387	I<< When in doubt, return a false value (preferably C<()>). >>
240		388
241	=over 4	389	=over 4
242		390
243	=item on_init $term	391	=item on_init $term
244		392
245	Called after a new terminal object has been initialized, but before	393	Called after a new terminal object has been initialized, but before
246	windows are created or the command gets run. Most methods are unsafe to	394	windows are created or the command gets run. Most methods are unsafe to
247	call or deliver senseless data, as terminal size and other characteristics	395	call or deliver senseless data, as terminal size and other characteristics
248	have not yet been determined. You can safely query and change resources,	396	have not yet been determined. You can safely query and change resources
249	though.	397	and options, though. For many purposes the C<on_start> hook is a better
		398	place.
		399
		400	=item on_start $term
		401
		402	Called at the very end of initialisation of a new terminal, just before
		403	trying to map (display) the toplevel and returning to the mainloop.
		404
		405	=item on_destroy $term
		406
		407	Called whenever something tries to destroy terminal, when the terminal is
		408	still fully functional (not for long, though).
250		409
251	=item on_reset $term	410	=item on_reset $term
252		411
253	Called after the screen is "reset" for any reason, such as resizing or	412	Called after the screen is "reset" for any reason, such as resizing or
254	control sequences. Here is where you can react on changes to size-related	413	control sequences. Here is where you can react on changes to size-related
255	variables.	414	variables.
256		415
257	=item on_start $term	416	=item on_child_start $term, $pid
258		417
259	Called at the very end of initialisation of a new terminal, just before	418	Called just after the child process has been C<fork>ed.
260	returning to the mainloop.	419
		420	=item on_child_exit $term, $status
		421
		422	Called just after the child process has exited. C<$status> is the status
		423	from C<waitpid>.
261		424
262	=item on_sel_make $term, $eventtime	425	=item on_sel_make $term, $eventtime
263		426
264	Called whenever a selection has been made by the user, but before the	427	Called whenever a selection has been made by the user, but before the
265	selection text is copied, so changes to the beginning, end or type of the	428	selection text is copied, so changes to the beginning, end or type of the
…		…
352		515
353	=item on_refresh_end $term	516	=item on_refresh_end $term
354		517
355	Called just after the screen gets redrawn. See C<on_refresh_begin>.	518	Called just after the screen gets redrawn. See C<on_refresh_begin>.
356		519
357	=item on_keyboard_command $term, $string	520	=item on_user_command $term, $string
358		521
359	Called whenever the user presses a key combination that has a	522	Called whenever the a user-configured event is being activated (e.g. via
360	C<perl:string> action bound to it (see description of the B<keysym>	523	a C<perl:string> action bound to a key, see description of the B<keysym>
361	resource in the @@RXVT_NAME@@(1) manpage).	524	resource in the @@RXVT_NAME@@(1) manpage).
		525
		526	The event is simply the action string. This interface is assumed to change
		527	slightly in the future.
		528
		529	=item on_x_event $term, $event
		530
		531	Called on every X event received on the vt window (and possibly other
		532	windows). Should only be used as a last resort. Most event structure
		533	members are not passed.
362		534
363	=item on_focus_in $term	535	=item on_focus_in $term
364		536
365	Called whenever the window gets the keyboard focus, before rxvt-unicode	537	Called whenever the window gets the keyboard focus, before rxvt-unicode
366	does focus in processing.	538	does focus in processing.
…		…
368	=item on_focus_out $term	540	=item on_focus_out $term
369		541
370	Called wheneever the window loses keyboard focus, before rxvt-unicode does	542	Called wheneever the window loses keyboard focus, before rxvt-unicode does
371	focus out processing.	543	focus out processing.
372		544
		545	=item on_configure_notify $term, $event
		546
		547	=item on_property_notify $term, $event
		548
373	=item on_key_press $term, $event, $keysym, $octets	549	=item on_key_press $term, $event, $keysym, $octets
374		550
375	=item on_key_release $term, $event, $keysym	551	=item on_key_release $term, $event, $keysym
376		552
377	=item on_button_press $term, $event	553	=item on_button_press $term, $event
…		…
386		562
387	Called whenever the corresponding X event is received for the terminal If	563	Called whenever the corresponding X event is received for the terminal If
388	the hook returns true, then the even will be ignored by rxvt-unicode.	564	the hook returns true, then the even will be ignored by rxvt-unicode.
389		565
390	The event is a hash with most values as named by Xlib (see the XEvent	566	The event is a hash with most values as named by Xlib (see the XEvent
391	manpage), with the additional members C<row> and C<col>, which are the row	567	manpage), with the additional members C<row> and C<col>, which are the
392	and column under the mouse cursor.	568	(real, not screen-based) row and column under the mouse cursor.
393		569
394	C<on_key_press> additionally receives the string rxvt-unicode would	570	C<on_key_press> additionally receives the string rxvt-unicode would
395	output, if any, in locale-specific encoding.	571	output, if any, in locale-specific encoding.
396		572
397	subwindow.	573	subwindow.
		574
		575	=item on_client_message $term, $event
		576
		577	=item on_wm_protocols $term, $event
		578
		579	=item on_wm_delete_window $term, $event
		580
		581	Called when various types of ClientMessage events are received (all with
		582	format=32, WM_PROTOCOLS or WM_PROTOCOLS:WM_DELETE_WINDOW).
398		583
399	=back	584	=back
400		585
401	=cut	586	=cut
402		587
…		…
408	use Scalar::Util ();	593	use Scalar::Util ();
409	use List::Util ();	594	use List::Util ();
410		595
411	our $VERSION = 1;	596	our $VERSION = 1;
412	our $TERM;	597	our $TERM;
		598	our @TERM_INIT;
		599	our @TERM_EXT;
413	our @HOOKNAME;	600	our @HOOKNAME;
414	our %HOOKTYPE = map +($HOOKNAME[$_] => $_), 0..$#HOOKNAME;	601	our %HOOKTYPE = map +($HOOKNAME[$_] => $_), 0..$#HOOKNAME;
415	our %OPTION;	602	our %OPTION;
416		603
417	our $LIBDIR;	604	our $LIBDIR;
418	our $RESNAME;	605	our $RESNAME;
419	our $RESCLASS;	606	our $RESCLASS;
420	our $RXVTNAME;	607	our $RXVTNAME;
421		608
		609	our $NOCHAR = chr 0xffff;
		610
422	=head2 Variables in the C<urxvt> Package	611	=head2 Variables in the C<urxvt> Package
423		612
424	=over 4	613	=over 4
425		614
426	=item $urxvt::LIBDIR	615	=item $urxvt::LIBDIR
…		…
438		627
439	=item $urxvt::TERM	628	=item $urxvt::TERM
440		629
441	The current terminal. This variable stores the current C<urxvt::term>	630	The current terminal. This variable stores the current C<urxvt::term>
442	object, whenever a callback/hook is executing.	631	object, whenever a callback/hook is executing.
		632
		633	=item @urxvt::TERM_INIT
		634
		635	All coderefs in this array will be called as methods of the next newly
		636	created C<urxvt::term> object (during the C<on_init> phase). The array
		637	gets cleared before the codereferences that were in it are being executed,
		638	so coderefs can push themselves onto it again if they so desire.
		639
		640	This complements to the perl-eval commandline option, but gets executed
		641	first.
		642
		643	=item @urxvt::TERM_EXT
		644
		645	Works similar to C<@TERM_INIT>, but contains perl package/class names, which
		646	get registered as normal extensions after calling the hooks in C<@TERM_INIT>
		647	but before other extensions. Gets cleared just like C<@TERM_INIT>.
443		648
444	=back	649	=back
445		650
446	=head2 Functions in the C<urxvt> Package	651	=head2 Functions in the C<urxvt> Package
447		652
…		…
462	Using this function has the advantage that its output ends up in the	667	Using this function has the advantage that its output ends up in the
463	correct place, e.g. on stderr of the connecting urxvtc client.	668	correct place, e.g. on stderr of the connecting urxvtc client.
464		669
465	Messages have a size limit of 1023 bytes currently.	670	Messages have a size limit of 1023 bytes currently.
466		671
467	=item $is_safe = urxvt::safe	672	=item @terms = urxvt::termlist
468		673
469	Returns true when it is safe to do potentially unsafe things, such as	674	Returns all urxvt::term objects that exist in this process, regardless of
470	evaluating perl code specified by the user. This is true when urxvt was	675	wether they are started, being destroyed etc., so be careful. Only term
471	started setuid or setgid.	676	objects that have perl extensions attached will be returned (because there
		677	is no urxvt::term objet associated with others).
472		678
473	=item $time = urxvt::NOW	679	=item $time = urxvt::NOW
474		680
475	Returns the "current time" (as per the event loop).	681	Returns the "current time" (as per the event loop).
476		682
477	=item urxvt::CurrentTime	683	=item urxvt::CurrentTime
478		684
479	=item urxvt::ShiftMask, LockMask, ControlMask, Mod1Mask, Mod2Mask,	685	=item urxvt::ShiftMask, LockMask, ControlMask, Mod1Mask, Mod2Mask,
480	Mod3Mask, Mod4Mask, Mod5Mask, Button1Mask, Button2Mask, Button3Mask,	686	Mod3Mask, Mod4Mask, Mod5Mask, Button1Mask, Button2Mask, Button3Mask,
481	Button4Mask, Button5Mask, AnyModifier	687	Button4Mask, Button5Mask, AnyModifier
		688
		689	=item urxvt::NoEventMask, KeyPressMask, KeyReleaseMask,
		690	ButtonPressMask, ButtonReleaseMask, EnterWindowMask, LeaveWindowMask,
		691	PointerMotionMask, PointerMotionHintMask, Button1MotionMask, Button2MotionMask,
		692	Button3MotionMask, Button4MotionMask, Button5MotionMask, ButtonMotionMask,
		693	KeymapStateMask, ExposureMask, VisibilityChangeMask, StructureNotifyMask,
		694	ResizeRedirectMask, SubstructureNotifyMask, SubstructureRedirectMask,
		695	FocusChangeMask, PropertyChangeMask, ColormapChangeMask, OwnerGrabButtonMask
		696
		697	=item urxvt::KeyPress, KeyRelease, ButtonPress, ButtonRelease, MotionNotify,
		698	EnterNotify, LeaveNotify, FocusIn, FocusOut, KeymapNotify, Expose,
		699	GraphicsExpose, NoExpose, VisibilityNotify, CreateNotify, DestroyNotify,
		700	UnmapNotify, MapNotify, MapRequest, ReparentNotify, ConfigureNotify,
		701	ConfigureRequest, GravityNotify, ResizeRequest, CirculateNotify,
		702	CirculateRequest, PropertyNotify, SelectionClear, SelectionRequest,
		703	SelectionNotify, ColormapNotify, ClientMessage, MappingNotify
482		704
483	Various constants for use in X calls and event processing.	705	Various constants for use in X calls and event processing.
484		706
485	=back	707	=back
486		708
…		…
537	=back	759	=back
538		760
539	=cut	761	=cut
540		762
541	BEGIN {	763	BEGIN {
542	urxvt->bootstrap;
543
544	# overwrite perl's warn	764	# overwrite perl's warn
545	*CORE::GLOBAL::warn = sub {	765	*CORE::GLOBAL::warn = sub {
546	my $msg = join "", @_;	766	my $msg = join "", @_;
547	$msg .= "\n"	767	$msg .= "\n"
548	unless $msg =~ /\n$/;	768	unless $msg =~ /\n$/;
549	urxvt::warn ($msg);	769	urxvt::warn ($msg);
550	};	770	};
551
552	# %ENV is the original startup environment
553	delete $ENV{IFS};
554	delete $ENV{CDPATH};
555	delete $ENV{BASH_ENV};
556	$ENV{PATH} = "/bin:/sbin:/usr/bin:/usr/sbin:/usr/local/bin:/usr/local/sbin:/opt/bin:/opt/sbin";
557	}	771	}
558		772
559	my @hook_count;	773	no warnings 'utf8';
		774
560	my $verbosity = $ENV{URXVT_PERL_VERBOSITY};	775	my $verbosity = $ENV{URXVT_PERL_VERBOSITY};
561		776
562	sub verbose {	777	sub verbose {
563	my ($level, $msg) = @_;	778	my ($level, $msg) = @_;
564	warn "$msg\n" if $level <= $verbosity;	779	warn "$msg\n" if $level <= $verbosity;
565	}	780	}
566		781
567	my $extension_pkg = "extension0000";
568	my %extension_pkg;	782	my %extension_pkg;
569		783
570	# load a single script into its own package, once only	784	# load a single script into its own package, once only
571	sub extension_package($) {	785	sub extension_package($) {
572	my ($path) = @_;	786	my ($path) = @_;
573		787
574	$extension_pkg{$path} \|\|= do {	788	$extension_pkg{$path} \|\|= do {
575	my $pkg = "urxvt::" . ($extension_pkg++);	789	$path =~ /([^\/\\]+)$/;
		790	my $pkg = $1;
		791	$pkg =~ s/[^[:word:]]/_/g;
		792	$pkg = "urxvt::ext::$pkg";
576		793
577	verbose 3, "loading extension '$path' into package '$pkg'";	794	verbose 3, "loading extension '$path' into package '$pkg'";
578		795
579	open my $fh, "<:raw", $path	796	open my $fh, "<:raw", $path
580	or die "$path: $!";	797	or die "$path: $!";
581		798
582	my $source = untaint	799	my $source =
583	"package $pkg; use strict; use utf8;\n"	800	"package $pkg; use strict; use utf8; no warnings 'utf8';\n"
584	. "use base urxvt::term::extension::;\n"
585	. "#line 1 \"$path\"\n{\n"	801	. "#line 1 \"$path\"\n{\n"
586	. (do { local $/; <$fh> })	802	. (do { local $/; <$fh> })
587	. "\n};\n1";	803	. "\n};\n1";
588		804
589	eval $source	805	eval $source
…		…
603	if ($htype == 0) { # INIT	819	if ($htype == 0) { # INIT
604	my @dirs = ((split /:/, $TERM->resource ("perl_lib")), "$LIBDIR/perl");	820	my @dirs = ((split /:/, $TERM->resource ("perl_lib")), "$LIBDIR/perl");
605		821
606	my %ext_arg;	822	my %ext_arg;
607		823
		824	{
		825	my @init = @TERM_INIT;
		826	@TERM_INIT = ();
		827	$_->($TERM) for @init;
		828	my @pkg = @TERM_EXT;
		829	@TERM_EXT = ();
		830	$TERM->register_package ($_) for @pkg;
		831	}
		832
608	for (map { split /,/, $TERM->resource ("perl_ext_$_") } 1, 2) {	833	for (grep $_, map { split /,/, $TERM->resource ("perl_ext_$_") } 1, 2) {
609	if ($_ eq "default") {	834	if ($_ eq "default") {
610	$ext_arg{$_} \|\|= [] for qw(selection option-popup selection-popup searchable-scrollback);	835	$ext_arg{$_} \|\|= [] for qw(selection option-popup selection-popup searchable-scrollback readline);
611	} elsif (/^-(.*)$/) {	836	} elsif (/^-(.*)$/) {
612	delete $ext_arg{$1};	837	delete $ext_arg{$1};
613	} elsif (/^([^<]+)<(.*)>$/) {	838	} elsif (/^([^<]+)<(.*)>$/) {
614	push @{ $ext_arg{$1} }, $2;	839	push @{ $ext_arg{$1} }, $2;
615	} else {	840	} else {
…		…
638	if $verbosity >= 10;	863	if $verbosity >= 10;
639		864
640	keys %$cb;	865	keys %$cb;
641		866
642	while (my ($pkg, $cb) = each %$cb) {	867	while (my ($pkg, $cb) = each %$cb) {
643	$retval = eval { $cb->($TERM->{_pkg}{$pkg}, @_) }	868	my $retval_ = eval { $cb->($TERM->{_pkg}{$pkg}, @_) };
644	and last;	869	$retval \|\|= $retval_;
645		870
646	if ($@) {	871	if ($@) {
647	$TERM->ungrab; # better to lose the grab than the session	872	$TERM->ungrab; # better to lose the grab than the session
648	warn $@;	873	warn $@;
649	}	874	}
…		…
652	verbose 11, "$HOOKNAME[$htype] returning <$retval>"	877	verbose 11, "$HOOKNAME[$htype] returning <$retval>"
653	if $verbosity >= 11;	878	if $verbosity >= 11;
654	}	879	}
655		880
656	if ($htype == 1) { # DESTROY	881	if ($htype == 1) { # DESTROY
657	if (my $hook = delete $TERM->{_hook}) {
658	for my $htype (0..$#$hook) {
659	$hook_count[$htype] -= scalar keys %{ $hook->[$htype] \|\| {} }
660	or set_should_invoke $htype, 0;
661	}
662	}
663
664	# clear package objects	882	# clear package objects
665	%$_ = () for values %{ $TERM->{_pkg} };	883	%$_ = () for values %{ $TERM->{_pkg} };
666		884
667	# clear package	885	# clear package
668	%$TERM = ();	886	%$TERM = ();
669	}	887	}
670		888
671	$retval	889	$retval
672	}
673
674	sub exec_async(@) {
675	my $pid = fork;
676
677	return
678	if !defined $pid or $pid;
679
680	%ENV = %{ $TERM->env };
681
682	exec @_;
683	_exit 255;
684	}	890	}
685		891
686	# urxvt::term::extension	892	# urxvt::term::extension
687		893
688	package urxvt::term::extension;	894	package urxvt::term::extension;
…		…
694	while (my ($name, $cb) = each %hook) {	900	while (my ($name, $cb) = each %hook) {
695	my $htype = $HOOKTYPE{uc $name};	901	my $htype = $HOOKTYPE{uc $name};
696	defined $htype	902	defined $htype
697	or Carp::croak "unsupported hook type '$name'";	903	or Carp::croak "unsupported hook type '$name'";
698		904
		905	$self->set_should_invoke ($htype, +1)
699	unless (exists $self->{term}{_hook}[$htype]{$pkg}) {	906	unless exists $self->{term}{_hook}[$htype]{$pkg};
700	$hook_count[$htype]++
701	or urxvt::set_should_invoke $htype, 1;
702	}
703		907
704	$self->{term}{_hook}[$htype]{$pkg} = $cb;	908	$self->{term}{_hook}[$htype]{$pkg} = $cb;
705	}	909	}
706	}	910	}
707		911
…		…
712	for my $name (@hook) {	916	for my $name (@hook) {
713	my $htype = $HOOKTYPE{uc $name};	917	my $htype = $HOOKTYPE{uc $name};
714	defined $htype	918	defined $htype
715	or Carp::croak "unsupported hook type '$name'";	919	or Carp::croak "unsupported hook type '$name'";
716		920
		921	$self->set_should_invoke ($htype, -1)
717	if (delete $self->{term}{_hook}[$htype]{$pkg}) {	922	if delete $self->{term}{_hook}[$htype]{$pkg};
718	--$hook_count[$htype]
719	or urxvt::set_should_invoke $htype, 0;
720	}
721	}	923	}
722	}	924	}
723		925
724	our $AUTOLOAD;	926	our $AUTOLOAD;
725		927
…		…
831	# find on_xxx subs in the package and register them	1033	# find on_xxx subs in the package and register them
832	# as hooks	1034	# as hooks
833	sub register_package {	1035	sub register_package {
834	my ($self, $pkg, $argv) = @_;	1036	my ($self, $pkg, $argv) = @_;
835		1037
		1038	no strict 'refs';
		1039
		1040	urxvt::verbose 6, "register package $pkg to $self";
		1041
		1042	@{"$pkg\::ISA"} = urxvt::term::extension::;
		1043
836	my $proxy = bless {	1044	my $proxy = bless {
837	_pkg => $pkg,	1045	_pkg => $pkg,
838	argv => $argv,	1046	argv => $argv,
839	}, $pkg;	1047	}, $pkg;
840	Scalar::Util::weaken ($proxy->{term} = $self);	1048	Scalar::Util::weaken ($proxy->{term} = $self);
…		…
855	hash which defines the environment of the new terminal.	1063	hash which defines the environment of the new terminal.
856		1064
857	Croaks (and probably outputs an error message) if the new instance	1065	Croaks (and probably outputs an error message) if the new instance
858	couldn't be created. Returns C<undef> if the new instance didn't	1066	couldn't be created. Returns C<undef> if the new instance didn't
859	initialise perl, and the terminal object otherwise. The C<init> and	1067	initialise perl, and the terminal object otherwise. The C<init> and
860	C<start> hooks will be called during this call.	1068	C<start> hooks will be called before this call returns, and are free to
		1069	refer to global data (which is race free).
861		1070
862	=cut	1071	=cut
863		1072
864	sub new {	1073	sub new {
865	my ($class, $env, @args) = @_;	1074	my ($class, $env, @args) = @_;
866		1075
		1076	$env or Carp::croak "environment hash missing in call to urxvt::term->new";
		1077	@args or Carp::croak "name argument missing in call to urxvt::term->new";
		1078
867	_new ([ map "$_=$env->{$_}", keys %$env ], @args);	1079	_new ([ map "$_=$env->{$_}", keys %$env ], \@args);
868	}	1080	}
869		1081
870	=item $term->destroy	1082	=item $term->destroy
871		1083
872	Destroy the terminal object (close the window, free resources	1084	Destroy the terminal object (close the window, free resources
873	etc.). Please note that @@RXVT_NAME@@ will not exit as long as any event	1085	etc.). Please note that @@RXVT_NAME@@ will not exit as long as any event
874	watchers (timers, io watchers) are still active.	1086	watchers (timers, io watchers) are still active.
875		1087
		1088	=item $term->exec_async ($cmd[, @args])
		1089
		1090	Works like the combination of the C<fork>/C<exec> builtins, which executes
		1091	("starts") programs in the background. This function takes care of setting
		1092	the user environment before exec'ing the command (e.g. C<PATH>) and should
		1093	be preferred over explicit calls to C<exec> or C<system>.
		1094
		1095	Returns the pid of the subprocess or C<undef> on error.
		1096
		1097	=cut
		1098
		1099	sub exec_async {
		1100	my $self = shift;
		1101
		1102	my $pid = fork;
		1103
		1104	return $pid
		1105	if !defined $pid or $pid;
		1106
		1107	%ENV = %{ $self->env };
		1108
		1109	exec @_;
		1110	urxvt::_exit 255;
		1111	}
		1112
876	=item $isset = $term->option ($optval[, $set])	1113	=item $isset = $term->option ($optval[, $set])
877		1114
878	Returns true if the option specified by C<$optval> is enabled, and	1115	Returns true if the option specified by C<$optval> is enabled, and
879	optionally change it. All option values are stored by name in the hash	1116	optionally change it. All option values are stored by name in the hash
880	C<%urxvt::OPTION>. Options not enabled in this binary are not in the hash.	1117	C<%urxvt::OPTION>. Options not enabled in this binary are not in the hash.
…		…
882	Here is a a likely non-exhaustive list of option names, please see the	1119	Here is a a likely non-exhaustive list of option names, please see the
883	source file F</src/optinc.h> to see the actual list:	1120	source file F</src/optinc.h> to see the actual list:
884		1121
885	borderLess console cursorBlink cursorUnderline hold iconic insecure	1122	borderLess console cursorBlink cursorUnderline hold iconic insecure
886	intensityStyles jumpScroll loginShell mapAlert meta8 mouseWheelScrollPage	1123	intensityStyles jumpScroll loginShell mapAlert meta8 mouseWheelScrollPage
887	pastableTabs pointerBlank reverseVideo scrollBar scrollBar_floating	1124	override-redirect pastableTabs pointerBlank reverseVideo scrollBar
888	scrollBar_right scrollTtyKeypress scrollTtyOutput scrollWithBuffer	1125	scrollBar_floating scrollBar_right scrollTtyKeypress scrollTtyOutput
889	secondaryScreen secondaryScroll skipBuiltinGlyphs transparent	1126	scrollWithBuffer secondaryScreen secondaryScroll skipBuiltinGlyphs
890	tripleclickwords utmpInhibit visualBell	1127	transparent tripleclickwords utmpInhibit visualBell
891		1128
892	=item $value = $term->resource ($name[, $newval])	1129	=item $value = $term->resource ($name[, $newval])
893		1130
894	Returns the current resource value associated with a given name and	1131	Returns the current resource value associated with a given name and
895	optionally sets a new value. Setting values is most useful in the C<init>	1132	optionally sets a new value. Setting values is most useful in the C<init>
…		…
912		1149
913	answerbackstring backgroundPixmap backspace_key boldFont boldItalicFont	1150	answerbackstring backgroundPixmap backspace_key boldFont boldItalicFont
914	borderLess color cursorBlink cursorUnderline cutchars delete_key	1151	borderLess color cursorBlink cursorUnderline cutchars delete_key
915	display_name embed ext_bwidth fade font geometry hold iconName	1152	display_name embed ext_bwidth fade font geometry hold iconName
916	imFont imLocale inputMethod insecure int_bwidth intensityStyles	1153	imFont imLocale inputMethod insecure int_bwidth intensityStyles
917	italicFont jumpScroll lineSpace loginShell mapAlert menu meta8 modifier	1154	italicFont jumpScroll lineSpace loginShell mapAlert meta8 modifier
918	mouseWheelScrollPage name pastableTabs path perl_eval perl_ext_1 perl_ext_2	1155	mouseWheelScrollPage name override_redirect pastableTabs path perl_eval
919	perl_lib pointerBlank pointerBlankDelay preeditType print_pipe pty_fd	1156	perl_ext_1 perl_ext_2 perl_lib pointerBlank pointerBlankDelay
920	reverseVideo saveLines scrollBar scrollBar_align scrollBar_floating	1157	preeditType print_pipe pty_fd reverseVideo saveLines scrollBar
921	scrollBar_right scrollBar_thickness scrollTtyKeypress scrollTtyOutput	1158	scrollBar_align scrollBar_floating scrollBar_right scrollBar_thickness
922	scrollWithBuffer scrollstyle secondaryScreen secondaryScroll selectstyle	1159	scrollTtyKeypress scrollTtyOutput scrollWithBuffer scrollstyle
923	shade term_name title transparent transparent_all tripleclickwords	1160	secondaryScreen secondaryScroll selectstyle shade term_name title
924	utmpInhibit visualBell	1161	transient_for transparent transparent_all tripleclickwords utmpInhibit
		1162	visualBell
925		1163
926	=cut	1164	=cut
927		1165
928	sub resource($$;$) {	1166	sub resource($$;$) {
929	my ($self, $name) = (shift, shift);	1167	my ($self, $name) = (shift, shift);
…		…
1103		1341
1104	Normally its not a good idea to use this function, as programs might be	1342	Normally its not a good idea to use this function, as programs might be
1105	confused by changes in cursor position or scrolling. Its useful inside a	1343	confused by changes in cursor position or scrolling. Its useful inside a
1106	C<on_add_lines> hook, though.	1344	C<on_add_lines> hook, though.
1107		1345
		1346	=item $term->scr_change_screen ($screen)
		1347
		1348	Switch to given screen - 0 primary, 1 secondary.
		1349
1108	=item $term->cmd_parse ($octets)	1350	=item $term->cmd_parse ($octets)
1109		1351
1110	Similar to C<scr_add_lines>, but the argument must be in the	1352	Similar to C<scr_add_lines>, but the argument must be in the
1111	locale-specific encoding of the terminal and can contain command sequences	1353	locale-specific encoding of the terminal and can contain command sequences
1112	(escape codes) that will be interpreted.	1354	(escape codes) that will be interpreted.
…		…
1122	Replaces the event mask of the pty watcher by the given event mask. Can	1364	Replaces the event mask of the pty watcher by the given event mask. Can
1123	be used to suppress input and output handling to the pty/tty. See the	1365	be used to suppress input and output handling to the pty/tty. See the
1124	description of C<< urxvt::timer->events >>. Make sure to always restore	1366	description of C<< urxvt::timer->events >>. Make sure to always restore
1125	the previous value.	1367	the previous value.
1126		1368
		1369	=item $fd = $term->pty_fd
		1370
		1371	Returns the master file descriptor for the pty in use, or C<-1> if no pty
		1372	is used.
		1373
1127	=item $windowid = $term->parent	1374	=item $windowid = $term->parent
1128		1375
1129	Return the window id of the toplevel window.	1376	Return the window id of the toplevel window.
1130		1377
1131	=item $windowid = $term->vt	1378	=item $windowid = $term->vt
1132		1379
1133	Return the window id of the terminal window.	1380	Return the window id of the terminal window.
1134		1381
		1382	=item $term->vt_emask_add ($x_event_mask)
		1383
		1384	Adds the specified events to the vt event mask. Useful e.g. when you want
		1385	to receive pointer events all the times:
		1386
		1387	$term->vt_emask_add (urxvt::PointerMotionMask);
		1388
1135	=item $window_width = $term->width	1389	=item $window_width = $term->width
1136		1390
1137	=item $window_height = $term->height	1391	=item $window_height = $term->height
1138		1392
1139	=item $font_width = $term->fwidth	1393	=item $font_width = $term->fwidth
…		…
1152		1406
1153	=item $max_scrollback = $term->saveLines	1407	=item $max_scrollback = $term->saveLines
1154		1408
1155	=item $nrow_plus_saveLines = $term->total_rows	1409	=item $nrow_plus_saveLines = $term->total_rows
1156		1410
1157	=item $lines_in_scrollback = $term->nsaved	1411	=item $topmost_scrollback_row = $term->top_row
1158		1412
1159	Return various integers describing terminal characteristics.	1413	Return various integers describing terminal characteristics.
1160		1414
1161	=item $x_display = $term->display_id	1415	=item $x_display = $term->display_id
1162		1416
…		…
1188	=item $modifiermask = $term->ModNumLockMask	1442	=item $modifiermask = $term->ModNumLockMask
1189		1443
1190	Return the modifier masks corresponding to the "ISO Level 3 Shift" (often	1444	Return the modifier masks corresponding to the "ISO Level 3 Shift" (often
1191	AltGr), the meta key (often Alt) and the num lock key, if applicable.	1445	AltGr), the meta key (often Alt) and the num lock key, if applicable.
1192		1446
		1447	=item $screen = $term->current_screen
		1448
		1449	Returns the currently displayed screen (0 primary, 1 secondary).
		1450
		1451	=item $cursor_is_hidden = $term->hidden_cursor
		1452
		1453	Returns wether the cursor is currently hidden or not.
		1454
1193	=item $view_start = $term->view_start ([$newvalue])	1455	=item $view_start = $term->view_start ([$newvalue])
1194		1456
1195	Returns the negative row number of the topmost line. Minimum value is	1457	Returns the row number of the topmost displayed line. Maximum value is
1196	C<0>, which displays the normal terminal contents. Larger values scroll	1458	C<0>, which displays the normal terminal contents. Lower values scroll
1197	this many lines into the scrollback buffer.	1459	this many lines into the scrollback buffer.
1198		1460
1199	=item $term->want_refresh	1461	=item $term->want_refresh
1200		1462
1201	Requests a screen refresh. At the next opportunity, rxvt-unicode will	1463	Requests a screen refresh. At the next opportunity, rxvt-unicode will
…		…
1216	line, starting at column C<$start_col> (default C<0>), which is useful	1478	line, starting at column C<$start_col> (default C<0>), which is useful
1217	to replace only parts of a line. The font index in the rendition will	1479	to replace only parts of a line. The font index in the rendition will
1218	automatically be updated.	1480	automatically be updated.
1219		1481
1220	C<$text> is in a special encoding: tabs and wide characters that use more	1482	C<$text> is in a special encoding: tabs and wide characters that use more
1221	than one cell when displayed are padded with urxvt::NOCHAR characters	1483	than one cell when displayed are padded with C<$urxvt::NOCHAR> (chr 65535)
1222	(C<chr 65535>). Characters with combining characters and other characters	1484	characters. Characters with combining characters and other characters that
1223	that do not fit into the normal tetx encoding will be replaced with	1485	do not fit into the normal tetx encoding will be replaced with characters
1224	characters in the private use area.	1486	in the private use area.
1225		1487
1226	You have to obey this encoding when changing text. The advantage is	1488	You have to obey this encoding when changing text. The advantage is
1227	that C<substr> and similar functions work on screen cells and not on	1489	that C<substr> and similar functions work on screen cells and not on
1228	characters.	1490	characters.
1229		1491
…		…
1376	=item $string = $term->special_decode $text	1638	=item $string = $term->special_decode $text
1377		1639
1378	Converts rxvt-unicodes text reprsentation into a perl string. See	1640	Converts rxvt-unicodes text reprsentation into a perl string. See
1379	C<< $term->ROW_t >> for details.	1641	C<< $term->ROW_t >> for details.
1380		1642
1381	=item $success = $term->grab_button ($button, $modifiermask)	1643	=item $success = $term->grab_button ($button, $modifiermask[, $window = $term->vt])
1382		1644
		1645	=item $term->ungrab_button ($button, $modifiermask[, $window = $term->vt])
		1646
1383	Registers a synchronous button grab. See the XGrabButton manpage.	1647	Register/unregister a synchronous button grab. See the XGrabButton
		1648	manpage.
1384		1649
1385	=item $success = $term->grab ($eventtime[, $sync])	1650	=item $success = $term->grab ($eventtime[, $sync])
1386		1651
1387	Calls XGrabPointer and XGrabKeyboard in asynchronous (default) or	1652	Calls XGrabPointer and XGrabKeyboard in asynchronous (default) or
1388	synchronous (C<$sync> is true). Also remembers the grab timestampe.	1653	synchronous (C<$sync> is true). Also remembers the grab timestampe.
…		…
1403	=item $term->ungrab	1668	=item $term->ungrab
1404		1669
1405	Calls XUngrab for the most recent grab. Is called automatically on	1670	Calls XUngrab for the most recent grab. Is called automatically on
1406	evaluation errors, as it is better to lose the grab in the error case as	1671	evaluation errors, as it is better to lose the grab in the error case as
1407	the session.	1672	the session.
		1673
		1674	=item $atom = $term->XInternAtom ($atom_name[, $only_if_exists])
		1675
		1676	=item $atom_name = $term->XGetAtomName ($atom)
		1677
		1678	=item @atoms = $term->XListProperties ($window)
		1679
		1680	=item ($type,$format,$octets) = $term->XGetWindowProperty ($window, $property)
		1681
		1682	=item $term->XChangeWindowProperty ($window, $property, $type, $format, $octets)
		1683
		1684	=item $term->XDeleteProperty ($window, $property)
		1685
		1686	=item $window = $term->DefaultRootWindow
		1687
		1688	=item $term->XReparentWindow ($window, $parent, [$x, $y])
		1689
		1690	=item $term->XMapWindow ($window)
		1691
		1692	=item $term->XUnmapWindow ($window)
		1693
		1694	=item $term->XMoveResizeWindow ($window, $x, $y, $width, $height)
		1695
		1696	=item ($x, $y, $child_window) = $term->XTranslateCoordinates ($src, $dst, $x, $y)
		1697
		1698	=item $term->XChangeInput ($window, $add_events[, $del_events])
		1699
		1700	Various X or X-related functions. The C<$term> object only serves as
		1701	the source of the display, otherwise those functions map more-or-less
		1702	directory onto the X functions of the same name.
1408		1703
1409	=back	1704	=back
1410		1705
1411	=cut	1706	=cut
1412		1707
…		…
1514	my $env = $self->{term}->env;	1809	my $env = $self->{term}->env;
1515	# we can't hope to reproduce the locale algorithm, so nuke LC_ALL and set LC_CTYPE.	1810	# we can't hope to reproduce the locale algorithm, so nuke LC_ALL and set LC_CTYPE.
1516	delete $env->{LC_ALL};	1811	delete $env->{LC_ALL};
1517	$env->{LC_CTYPE} = $self->{term}->locale;	1812	$env->{LC_CTYPE} = $self->{term}->locale;
1518		1813
1519	urxvt::term->new ($env, $self->{term}->resource ("name"),	1814	urxvt::term->new ($env, "popup",
1520	"--perl-lib" => "", "--perl-ext-common" => "", "-pty-fd" => -1, "-sl" => 0, "-b" => 0,	1815	"--perl-lib" => "", "--perl-ext-common" => "",
		1816	"-pty-fd" => -1, "-sl" => 0,
		1817	"-b" => 1, "-bd" => "grey80", "-bl", "-override-redirect",
1521	"--transient-for" => $self->{term}->parent,	1818	"--transient-for" => $self->{term}->parent,
1522	"-display" => $self->{term}->display_id,	1819	"-display" => $self->{term}->display_id,
1523	"-pe" => "urxvt-popup")	1820	"-pe" => "urxvt-popup")
1524	or die "unable to create popup window\n";	1821	or die "unable to create popup window\n";
1525	}	1822	}
…		…
1530	delete $self->{term}{_destroy}{$self};	1827	delete $self->{term}{_destroy}{$self};
1531	$self->{term}->ungrab;	1828	$self->{term}->ungrab;
1532	}	1829	}
1533		1830
1534	=back	1831	=back
		1832
		1833	=cut
		1834
		1835	package urxvt::watcher;
		1836
		1837	@urxvt::timer::ISA = __PACKAGE__;
		1838	@urxvt::iow::ISA = __PACKAGE__;
		1839	@urxvt::pw::ISA = __PACKAGE__;
		1840	@urxvt::iw::ISA = __PACKAGE__;
1535		1841
1536	=head2 The C<urxvt::timer> Class	1842	=head2 The C<urxvt::timer> Class
1537		1843
1538	This class implements timer watchers/events. Time is represented as a	1844	This class implements timer watchers/events. Time is represented as a
1539	fractional number of seconds since the epoch. Example:	1845	fractional number of seconds since the epoch. Example:
…		…
1577	Start the timer.	1883	Start the timer.
1578		1884
1579	=item $timer = $timer->start ($tstamp)	1885	=item $timer = $timer->start ($tstamp)
1580		1886
1581	Set the event trigger time to C<$tstamp> and start the timer.	1887	Set the event trigger time to C<$tstamp> and start the timer.
		1888
		1889	=item $timer = $timer->after ($delay)
		1890
		1891	Like C<start>, but sets the expiry timer to c<urxvt::NOW + $delay>.
1582		1892
1583	=item $timer = $timer->stop	1893	=item $timer = $timer->stop
1584		1894
1585	Stop the timer.	1895	Stop the timer.
1586		1896
…		…
1633		1943
1634	Stop watching for events on the given filehandle.	1944	Stop watching for events on the given filehandle.
1635		1945
1636	=back	1946	=back
1637		1947
		1948	=head2 The C<urxvt::iw> Class
		1949
		1950	This class implements idle watchers, that get called automatically when
		1951	the process is idle. They should return as fast as possible, after doing
		1952	some useful work.
		1953
		1954	=over 4
		1955
		1956	=item $iw = new urxvt::iw
		1957
		1958	Create a new idle watcher object in stopped state.
		1959
		1960	=item $iw = $iw->cb (sub { my ($iw) = @_; ... })
		1961
		1962	Set the callback to be called when the watcher triggers.
		1963
		1964	=item $timer = $timer->start
		1965
		1966	Start the watcher.
		1967
		1968	=item $timer = $timer->stop
		1969
		1970	Stop the watcher.
		1971
		1972	=back
		1973
		1974	=head2 The C<urxvt::pw> Class
		1975
		1976	This class implements process watchers. They create an event whenever a
		1977	process exits, after which they stop automatically.
		1978
		1979	my $pid = fork;
		1980	...
		1981	$term->{pw} = urxvt::pw
		1982	->new
		1983	->start ($pid)
		1984	->cb (sub {
		1985	my ($pw, $exit_status) = @_;
		1986	...
		1987	});
		1988
		1989	=over 4
		1990
		1991	=item $pw = new urxvt::pw
		1992
		1993	Create a new process watcher in stopped state.
		1994
		1995	=item $pw = $pw->cb (sub { my ($pw, $exit_status) = @_; ... })
		1996
		1997	Set the callback to be called when the timer triggers.
		1998
		1999	=item $pw = $timer->start ($pid)
		2000
		2001	Tells the wqtcher to start watching for process C<$pid>.
		2002
		2003	=item $pw = $pw->stop
		2004
		2005	Stop the watcher.
		2006
		2007	=back
		2008
1638	=head1 ENVIRONMENT	2009	=head1 ENVIRONMENT
1639		2010
1640	=head2 URXVT_PERL_VERBOSITY	2011	=head2 URXVT_PERL_VERBOSITY
1641		2012
1642	This variable controls the verbosity level of the perl extension. Higher	2013	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.88 by root, Thu Jan 12 12:05:28 2006 UTC vs. Revision 1.131 by root, Sun Jan 29 20:51:28 2006 UTC

Diff Legend

Comparing rxvt-unicode/src/urxvt.pm (file contents):
Revision 1.88 by root, Thu Jan 12 12:05:28 2006 UTC vs.
Revision 1.131 by root, Sun Jan 29 20:51:28 2006 UTC