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

Comparing rxvt-unicode/src/urxvt.pm (file contents):
Revision 1.85 by root, Thu Jan 12 03:32:56 2006 UTC vs.
Revision 1.129 by root, Wed Jan 25 15:11:31 2006 UTC

…		…
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		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
		43
40	=over 4	44	=over 4
41		45
42	=item selection (enabled by default)	46	=item selection (enabled by default)
43		47
44	(More) intelligent selection. This extension tries to be more intelligent	48	(More) intelligent selection. This extension tries to be more intelligent
45	when the user extends selections (double-click). Right now, it tries to	49	when the user extends selections (double-click and further clicks). Right
46	select urls and complete shell-quoted arguments, which is very convenient,	50	now, it tries to select words, urls and complete shell-quoted
47	too, if your F<ls> supports C<--quoting-style=shell>.	51	arguments, which is very convenient, too, if your F<ls> supports
		52	C<--quoting-style=shell>.
48		53
		54	A double-click usually selects the word under the cursor, further clicks
		55	will enlarge the selection.
		56
		57	The selection works by trying to match a number of regexes and displaying
		58	them in increasing order of length. You can add your own regexes by
		59	specifying resources of the form:
		60
		61	URxvt.selection.pattern-0: perl-regex
		62	URxvt.selection.pattern-1: perl-regex
		63	...
		64
		65	The index number (0, 1...) must not have any holes, and each regex must
		66	contain at least one pair of capturing parentheses, which will be used for
		67	the match. For example, the followign adds a regex that matches everything
		68	between two vertical bars:
		69
		70	URxvt.selection.pattern-0: \\\|([^\|]+)\\\|
		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
		79	You can look at the source of the selection extension to see more
		80	interesting uses, such as parsing a line from beginning to end.
		81
49	It also offers the following bindable keyboard command:	82	This extension also offers following bindable keyboard commands:
50		83
51	=over 4	84	=over 4
52		85
53	=item rot13	86	=item rot13
54		87
…		…
65		98
66	=item selection-popup (enabled by default)	99	=item selection-popup (enabled by default)
67		100
68	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
69	text into various other formats/action (such as uri unescaping, perl	102	text into various other formats/action (such as uri unescaping, perl
70	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	};
71		123
72	=item searchable-scrollback<hotkey> (enabled by default)	124	=item searchable-scrollback<hotkey> (enabled by default)
73		125
74	Adds regex search functionality to the scrollback buffer, triggered	126	Adds regex search functionality to the scrollback buffer, triggered
75	by a hotkey (default: C<M-s>). When in search mode, normal terminal	127	by a hotkey (default: C<M-s>). While in search mode, normal terminal
76	input/output is suspended.	128	input/output is suspended and a regex is displayed at the bottom of the
		129	screen.
77		130
78	C</> starts an incremental regex search, C<n> searches further, C<p> or	131	Inputting characters appends them to the regex and continues incremental
79	C<N> jump to the previous match, C<G> jumps to the bottom and clears the	132	search. C<BackSpace> removes a character from the regex, C<Up> and C<Down>
80	history, C<enter> leaves search mode at the current position and C<escape>	133	search upwards/downwards in the scrollback buffer, C<End> jumps to the
81	returns to the original position.	134	bottom. C<Escape> leaves search mode and returns to the point where search
		135	was started, while C<Enter> or C<Return> stay at the current position and
		136	additionally stores the first match in the current line into the primary
		137	selection.
82		138
83	=item digital-clock	139	=item readline (enabled by default)
84		140
85	Displays a digital clock using the built-in overlay.	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
		164	=item selection-autotransform
		165
		166	This selection allows you to do automatic transforms on a selection
		167	whenever a selection is made.
		168
		169	It works by specifying perl snippets (most useful is a single C<s///>
		170	operator) that modify C<$_> as resources:
		171
		172	URxvt.selection-autotransform.0: transform
		173	URxvt.selection-autotransform.1: transform
		174	...
		175
		176	For example, the following will transform selections of the form
		177	C<filename:number>, often seen in compiler messages, into C<vi +$filename
		178	$word>:
		179
		180	URxvt.selection-autotransform.0: s/^([^:[:space:]]+):(\\d+):?$/vi +$2 \\Q$1\\E\\x0d/
		181
		182	And this example matches the same,but replaces it with vi-commands you can
		183	paste directly into your (vi :) editor:
		184
		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.
86		209
87	=item mark-urls	210	=item mark-urls
88		211
89	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
90	make them clickable. When middle-clicked, the program specified in the	213	make them clickable. When middle-clicked, the program specified in the
91	resource C<urlLauncher> (default C<x-www-browser>) will be started.	214	resource C<urlLauncher> (default C<x-www-browser>) will be started with
		215	the URL as first argument.
		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
92		236
93	=item block-graphics-to-ascii	237	=item block-graphics-to-ascii
94		238
95	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,
96	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
97	similar-looking ascii character.	241	similar-looking ascii character.
		242
		243	=item digital-clock
		244
		245	Displays a digital clock using the built-in overlay.
		246
		247	=item remote-selection
		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/%
98		295
99	=item example-refresh-hooks	296	=item example-refresh-hooks
100		297
101	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
102	window. Illustrates overwriting the refresh callbacks to create your own	299	window. Illustrates overwriting the refresh callbacks to create your own
…		…
181	called whenever the relevant event happens.	378	called whenever the relevant event happens.
182		379
183	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
184	the in the C<Extension Objects> section.	381	the in the C<Extension Objects> section.
185		382
186	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
187	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
188	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.
189		386
190	I<< When in doubt, return a false value (preferably C<()>). >>	387	I<< When in doubt, return a false value (preferably C<()>). >>
191		388
192	=over 4	389	=over 4
193		390
194	=item on_init $term	391	=item on_init $term
195		392
196	Called after a new terminal object has been initialized, but before	393	Called after a new terminal object has been initialized, but before
197	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
198	call or deliver senseless data, as terminal size and other characteristics	395	call or deliver senseless data, as terminal size and other characteristics
199	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
200	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).
201		409
202	=item on_reset $term	410	=item on_reset $term
203		411
204	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
205	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
206	variables.	414	variables.
207		415
208	=item on_start $term	416	=item on_child_start $term, $pid
209		417
210	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.
211	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>.
212		424
213	=item on_sel_make $term, $eventtime	425	=item on_sel_make $term, $eventtime
214		426
215	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
216	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
…		…
309		521
310	Called whenever the user presses a key combination that has a	522	Called whenever the user presses a key combination that has a
311	C<perl:string> action bound to it (see description of the B<keysym>	523	C<perl:string> action bound to it (see description of the B<keysym>
312	resource in the @@RXVT_NAME@@(1) manpage).	524	resource in the @@RXVT_NAME@@(1) manpage).
313		525
		526	=item on_x_event $term, $event
		527
		528	Called on every X event received on the vt window (and possibly other
		529	windows). Should only be used as a last resort. Most event structure
		530	members are not passed.
		531
314	=item on_focus_in $term	532	=item on_focus_in $term
315		533
316	Called whenever the window gets the keyboard focus, before rxvt-unicode	534	Called whenever the window gets the keyboard focus, before rxvt-unicode
317	does focus in processing.	535	does focus in processing.
318		536
319	=item on_focus_out $term	537	=item on_focus_out $term
320		538
321	Called wheneever the window loses keyboard focus, before rxvt-unicode does	539	Called wheneever the window loses keyboard focus, before rxvt-unicode does
322	focus out processing.	540	focus out processing.
323		541
		542	=item on_configure_notify $term, $event
		543
		544	=item on_property_notify $term, $event
		545
324	=item on_key_press $term, $event, $keysym, $octets	546	=item on_key_press $term, $event, $keysym, $octets
325		547
326	=item on_key_release $term, $event, $keysym	548	=item on_key_release $term, $event, $keysym
327		549
328	=item on_button_press $term, $event	550	=item on_button_press $term, $event
…		…
337		559
338	Called whenever the corresponding X event is received for the terminal If	560	Called whenever the corresponding X event is received for the terminal If
339	the hook returns true, then the even will be ignored by rxvt-unicode.	561	the hook returns true, then the even will be ignored by rxvt-unicode.
340		562
341	The event is a hash with most values as named by Xlib (see the XEvent	563	The event is a hash with most values as named by Xlib (see the XEvent
342	manpage), with the additional members C<row> and C<col>, which are the row	564	manpage), with the additional members C<row> and C<col>, which are the
343	and column under the mouse cursor.	565	(real, not screen-based) row and column under the mouse cursor.
344		566
345	C<on_key_press> additionally receives the string rxvt-unicode would	567	C<on_key_press> additionally receives the string rxvt-unicode would
346	output, if any, in locale-specific encoding.	568	output, if any, in locale-specific encoding.
347		569
348	subwindow.	570	subwindow.
		571
		572	=item on_client_message $term, $event
		573
		574	=item on_wm_protocols $term, $event
		575
		576	=item on_wm_delete_window $term, $event
		577
		578	Called when various types of ClientMessage events are received (all with
		579	format=32, WM_PROTOCOLS or WM_PROTOCOLS:WM_DELETE_WINDOW).
349		580
350	=back	581	=back
351		582
352	=cut	583	=cut
353		584
…		…
359	use Scalar::Util ();	590	use Scalar::Util ();
360	use List::Util ();	591	use List::Util ();
361		592
362	our $VERSION = 1;	593	our $VERSION = 1;
363	our $TERM;	594	our $TERM;
		595	our @TERM_INIT;
		596	our @TERM_EXT;
364	our @HOOKNAME;	597	our @HOOKNAME;
365	our %HOOKTYPE = map +($HOOKNAME[$_] => $_), 0..$#HOOKNAME;	598	our %HOOKTYPE = map +($HOOKNAME[$_] => $_), 0..$#HOOKNAME;
366	our %OPTION;	599	our %OPTION;
367		600
368	our $LIBDIR;	601	our $LIBDIR;
369	our $RESNAME;	602	our $RESNAME;
370	our $RESCLASS;	603	our $RESCLASS;
371	our $RXVTNAME;	604	our $RXVTNAME;
372		605
		606	our $NOCHAR = chr 0xffff;
		607
373	=head2 Variables in the C<urxvt> Package	608	=head2 Variables in the C<urxvt> Package
374		609
375	=over 4	610	=over 4
376		611
377	=item $urxvt::LIBDIR	612	=item $urxvt::LIBDIR
…		…
389		624
390	=item $urxvt::TERM	625	=item $urxvt::TERM
391		626
392	The current terminal. This variable stores the current C<urxvt::term>	627	The current terminal. This variable stores the current C<urxvt::term>
393	object, whenever a callback/hook is executing.	628	object, whenever a callback/hook is executing.
		629
		630	=item @urxvt::TERM_INIT
		631
		632	All coderefs in this array will be called as methods of the next newly
		633	created C<urxvt::term> object (during the C<on_init> phase). The array
		634	gets cleared before the codereferences that were in it are being executed,
		635	so coderefs can push themselves onto it again if they so desire.
		636
		637	This complements to the perl-eval commandline option, but gets executed
		638	first.
		639
		640	=item @urxvt::TERM_EXT
		641
		642	Works similar to C<@TERM_INIT>, but contains perl package/class names, which
		643	get registered as normal extensions after calling the hooks in C<@TERM_INIT>
		644	but before other extensions. Gets cleared just like C<@TERM_INIT>.
394		645
395	=back	646	=back
396		647
397	=head2 Functions in the C<urxvt> Package	648	=head2 Functions in the C<urxvt> Package
398		649
…		…
413	Using this function has the advantage that its output ends up in the	664	Using this function has the advantage that its output ends up in the
414	correct place, e.g. on stderr of the connecting urxvtc client.	665	correct place, e.g. on stderr of the connecting urxvtc client.
415		666
416	Messages have a size limit of 1023 bytes currently.	667	Messages have a size limit of 1023 bytes currently.
417		668
418	=item $is_safe = urxvt::safe
419
420	Returns true when it is safe to do potentially unsafe things, such as
421	evaluating perl code specified by the user. This is true when urxvt was
422	started setuid or setgid.
423
424	=item $time = urxvt::NOW	669	=item $time = urxvt::NOW
425		670
426	Returns the "current time" (as per the event loop).	671	Returns the "current time" (as per the event loop).
427		672
428	=item urxvt::CurrentTime	673	=item urxvt::CurrentTime
429		674
430	=item urxvt::ShiftMask, LockMask, ControlMask, Mod1Mask, Mod2Mask,	675	=item urxvt::ShiftMask, LockMask, ControlMask, Mod1Mask, Mod2Mask,
431	Mod3Mask, Mod4Mask, Mod5Mask, Button1Mask, Button2Mask, Button3Mask,	676	Mod3Mask, Mod4Mask, Mod5Mask, Button1Mask, Button2Mask, Button3Mask,
432	Button4Mask, Button5Mask, AnyModifier	677	Button4Mask, Button5Mask, AnyModifier
		678
		679	=item urxvt::NoEventMask, KeyPressMask, KeyReleaseMask,
		680	ButtonPressMask, ButtonReleaseMask, EnterWindowMask, LeaveWindowMask,
		681	PointerMotionMask, PointerMotionHintMask, Button1MotionMask, Button2MotionMask,
		682	Button3MotionMask, Button4MotionMask, Button5MotionMask, ButtonMotionMask,
		683	KeymapStateMask, ExposureMask, VisibilityChangeMask, StructureNotifyMask,
		684	ResizeRedirectMask, SubstructureNotifyMask, SubstructureRedirectMask,
		685	FocusChangeMask, PropertyChangeMask, ColormapChangeMask, OwnerGrabButtonMask
		686
		687	=item urxvt::KeyPress, KeyRelease, ButtonPress, ButtonRelease, MotionNotify,
		688	EnterNotify, LeaveNotify, FocusIn, FocusOut, KeymapNotify, Expose,
		689	GraphicsExpose, NoExpose, VisibilityNotify, CreateNotify, DestroyNotify,
		690	UnmapNotify, MapNotify, MapRequest, ReparentNotify, ConfigureNotify,
		691	ConfigureRequest, GravityNotify, ResizeRequest, CirculateNotify,
		692	CirculateRequest, PropertyNotify, SelectionClear, SelectionRequest,
		693	SelectionNotify, ColormapNotify, ClientMessage, MappingNotify
433		694
434	Various constants for use in X calls and event processing.	695	Various constants for use in X calls and event processing.
435		696
436	=back	697	=back
437		698
…		…
488	=back	749	=back
489		750
490	=cut	751	=cut
491		752
492	BEGIN {	753	BEGIN {
493	urxvt->bootstrap;
494
495	# overwrite perl's warn	754	# overwrite perl's warn
496	*CORE::GLOBAL::warn = sub {	755	*CORE::GLOBAL::warn = sub {
497	my $msg = join "", @_;	756	my $msg = join "", @_;
498	$msg .= "\n"	757	$msg .= "\n"
499	unless $msg =~ /\n$/;	758	unless $msg =~ /\n$/;
500	urxvt::warn ($msg);	759	urxvt::warn ($msg);
501	};	760	};
502
503	# %ENV is the original startup environment
504	delete $ENV{IFS};
505	delete $ENV{CDPATH};
506	delete $ENV{BASH_ENV};
507	$ENV{PATH} = "/bin:/sbin:/usr/bin:/usr/sbin:/usr/local/bin:/usr/local/sbin:/opt/bin:/opt/sbin";
508	}	761	}
509		762
510	my @hook_count;	763	no warnings 'utf8';
		764
511	my $verbosity = $ENV{URXVT_PERL_VERBOSITY};	765	my $verbosity = $ENV{URXVT_PERL_VERBOSITY};
512		766
513	sub verbose {	767	sub verbose {
514	my ($level, $msg) = @_;	768	my ($level, $msg) = @_;
515	warn "$msg\n" if $level <= $verbosity;	769	warn "$msg\n" if $level <= $verbosity;
516	}	770	}
517		771
518	my $extension_pkg = "extension0000";
519	my %extension_pkg;	772	my %extension_pkg;
520		773
521	# load a single script into its own package, once only	774	# load a single script into its own package, once only
522	sub extension_package($) {	775	sub extension_package($) {
523	my ($path) = @_;	776	my ($path) = @_;
524		777
525	$extension_pkg{$path} \|\|= do {	778	$extension_pkg{$path} \|\|= do {
526	my $pkg = "urxvt::" . ($extension_pkg++);	779	$path =~ /([^\/\\]+)$/;
		780	my $pkg = $1;
		781	$pkg =~ s/[^[:word:]]/_/g;
		782	$pkg = "urxvt::ext::$pkg";
527		783
528	verbose 3, "loading extension '$path' into package '$pkg'";	784	verbose 3, "loading extension '$path' into package '$pkg'";
529		785
530	open my $fh, "<:raw", $path	786	open my $fh, "<:raw", $path
531	or die "$path: $!";	787	or die "$path: $!";
532		788
533	my $source = untaint	789	my $source =
534	"package $pkg; use strict; use utf8;\n"	790	"package $pkg; use strict; use utf8; no warnings 'utf8';\n"
535	. "use base urxvt::term::extension::;\n"
536	. "#line 1 \"$path\"\n{\n"	791	. "#line 1 \"$path\"\n{\n"
537	. (do { local $/; <$fh> })	792	. (do { local $/; <$fh> })
538	. "\n};\n1";	793	. "\n};\n1";
539		794
540	eval $source	795	eval $source
…		…
554	if ($htype == 0) { # INIT	809	if ($htype == 0) { # INIT
555	my @dirs = ((split /:/, $TERM->resource ("perl_lib")), "$LIBDIR/perl");	810	my @dirs = ((split /:/, $TERM->resource ("perl_lib")), "$LIBDIR/perl");
556		811
557	my %ext_arg;	812	my %ext_arg;
558		813
		814	{
		815	my @init = @TERM_INIT;
		816	@TERM_INIT = ();
		817	$_->($TERM) for @init;
		818	my @pkg = @TERM_EXT;
		819	@TERM_EXT = ();
		820	$TERM->register_package ($_) for @pkg;
		821	}
		822
559	for (map { split /,/, $TERM->resource ("perl_ext_$_") } 1, 2) {	823	for (grep $_, map { split /,/, $TERM->resource ("perl_ext_$_") } 1, 2) {
560	if ($_ eq "default") {	824	if ($_ eq "default") {
561	$ext_arg{$_} \|\|= [] for qw(selection option-popup selection-popup searchable-scrollback);	825	$ext_arg{$_} \|\|= [] for qw(selection option-popup selection-popup searchable-scrollback readline);
562	} elsif (/^-(.*)$/) {	826	} elsif (/^-(.*)$/) {
563	delete $ext_arg{$1};	827	delete $ext_arg{$1};
564	} elsif (/^([^<]+)<(.*)>$/) {	828	} elsif (/^([^<]+)<(.*)>$/) {
565	push @{ $ext_arg{$1} }, $2;	829	push @{ $ext_arg{$1} }, $2;
566	} else {	830	} else {
…		…
589	if $verbosity >= 10;	853	if $verbosity >= 10;
590		854
591	keys %$cb;	855	keys %$cb;
592		856
593	while (my ($pkg, $cb) = each %$cb) {	857	while (my ($pkg, $cb) = each %$cb) {
594	$retval = eval { $cb->($TERM->{_pkg}{$pkg}, @_) }	858	my $retval_ = eval { $cb->($TERM->{_pkg}{$pkg}, @_) };
595	and last;	859	$retval \|\|= $retval_;
596		860
597	if ($@) {	861	if ($@) {
598	$TERM->ungrab; # better to lose the grab than the session	862	$TERM->ungrab; # better to lose the grab than the session
599	warn $@;	863	warn $@;
600	}	864	}
…		…
603	verbose 11, "$HOOKNAME[$htype] returning <$retval>"	867	verbose 11, "$HOOKNAME[$htype] returning <$retval>"
604	if $verbosity >= 11;	868	if $verbosity >= 11;
605	}	869	}
606		870
607	if ($htype == 1) { # DESTROY	871	if ($htype == 1) { # DESTROY
608	if (my $hook = delete $TERM->{_hook}) {
609	for my $htype (0..$#$hook) {
610	$hook_count[$htype] -= scalar keys %{ $hook->[$htype] \|\| {} }
611	or set_should_invoke $htype, 0;
612	}
613	}
614
615	# clear package objects	872	# clear package objects
616	%$_ = () for values %{ $TERM->{_pkg} };	873	%$_ = () for values %{ $TERM->{_pkg} };
617		874
618	# clear package	875	# clear package
619	%$TERM = ();	876	%$TERM = ();
620	}	877	}
621		878
622	$retval	879	$retval
623	}
624
625	sub exec_async(@) {
626	my $pid = fork;
627
628	return
629	if !defined $pid or $pid;
630
631	%ENV = %{ $TERM->env };
632
633	exec @_;
634	_exit 255;
635	}	880	}
636		881
637	# urxvt::term::extension	882	# urxvt::term::extension
638		883
639	package urxvt::term::extension;	884	package urxvt::term::extension;
…		…
645	while (my ($name, $cb) = each %hook) {	890	while (my ($name, $cb) = each %hook) {
646	my $htype = $HOOKTYPE{uc $name};	891	my $htype = $HOOKTYPE{uc $name};
647	defined $htype	892	defined $htype
648	or Carp::croak "unsupported hook type '$name'";	893	or Carp::croak "unsupported hook type '$name'";
649		894
		895	$self->set_should_invoke ($htype, +1)
650	unless (exists $self->{term}{_hook}[$htype]{$pkg}) {	896	unless exists $self->{term}{_hook}[$htype]{$pkg};
651	$hook_count[$htype]++
652	or urxvt::set_should_invoke $htype, 1;
653	}
654		897
655	$self->{term}{_hook}[$htype]{$pkg} = $cb;	898	$self->{term}{_hook}[$htype]{$pkg} = $cb;
656	}	899	}
657	}	900	}
658		901
…		…
663	for my $name (@hook) {	906	for my $name (@hook) {
664	my $htype = $HOOKTYPE{uc $name};	907	my $htype = $HOOKTYPE{uc $name};
665	defined $htype	908	defined $htype
666	or Carp::croak "unsupported hook type '$name'";	909	or Carp::croak "unsupported hook type '$name'";
667		910
		911	$self->set_should_invoke ($htype, -1)
668	if (delete $self->{term}{_hook}[$htype]{$pkg}) {	912	if delete $self->{term}{_hook}[$htype]{$pkg};
669	--$hook_count[$htype]
670	or urxvt::set_should_invoke $htype, 0;
671	}
672	}	913	}
673	}	914	}
674		915
675	our $AUTOLOAD;	916	our $AUTOLOAD;
676		917
…		…
782	# find on_xxx subs in the package and register them	1023	# find on_xxx subs in the package and register them
783	# as hooks	1024	# as hooks
784	sub register_package {	1025	sub register_package {
785	my ($self, $pkg, $argv) = @_;	1026	my ($self, $pkg, $argv) = @_;
786		1027
		1028	no strict 'refs';
		1029
		1030	urxvt::verbose 6, "register package $pkg to $self";
		1031
		1032	@{"$pkg\::ISA"} = urxvt::term::extension::;
		1033
787	my $proxy = bless {	1034	my $proxy = bless {
788	_pkg => $pkg,	1035	_pkg => $pkg,
789	argv => $argv,	1036	argv => $argv,
790	}, $pkg;	1037	}, $pkg;
791	Scalar::Util::weaken ($proxy->{term} = $self);	1038	Scalar::Util::weaken ($proxy->{term} = $self);
…		…
822		1069
823	Destroy the terminal object (close the window, free resources	1070	Destroy the terminal object (close the window, free resources
824	etc.). Please note that @@RXVT_NAME@@ will not exit as long as any event	1071	etc.). Please note that @@RXVT_NAME@@ will not exit as long as any event
825	watchers (timers, io watchers) are still active.	1072	watchers (timers, io watchers) are still active.
826		1073
		1074	=item $term->exec_async ($cmd[, @args])
		1075
		1076	Works like the combination of the C<fork>/C<exec> builtins, which executes
		1077	("starts") programs in the background. This function takes care of setting
		1078	the user environment before exec'ing the command (e.g. C<PATH>) and should
		1079	be preferred over explicit calls to C<exec> or C<system>.
		1080
		1081	Returns the pid of the subprocess or C<undef> on error.
		1082
		1083	=cut
		1084
		1085	sub exec_async {
		1086	my $self = shift;
		1087
		1088	my $pid = fork;
		1089
		1090	return $pid
		1091	if !defined $pid or $pid;
		1092
		1093	%ENV = %{ $self->env };
		1094
		1095	exec @_;
		1096	urxvt::_exit 255;
		1097	}
		1098
827	=item $isset = $term->option ($optval[, $set])	1099	=item $isset = $term->option ($optval[, $set])
828		1100
829	Returns true if the option specified by C<$optval> is enabled, and	1101	Returns true if the option specified by C<$optval> is enabled, and
830	optionally change it. All option values are stored by name in the hash	1102	optionally change it. All option values are stored by name in the hash
831	C<%urxvt::OPTION>. Options not enabled in this binary are not in the hash.	1103	C<%urxvt::OPTION>. Options not enabled in this binary are not in the hash.
…		…
833	Here is a a likely non-exhaustive list of option names, please see the	1105	Here is a a likely non-exhaustive list of option names, please see the
834	source file F</src/optinc.h> to see the actual list:	1106	source file F</src/optinc.h> to see the actual list:
835		1107
836	borderLess console cursorBlink cursorUnderline hold iconic insecure	1108	borderLess console cursorBlink cursorUnderline hold iconic insecure
837	intensityStyles jumpScroll loginShell mapAlert meta8 mouseWheelScrollPage	1109	intensityStyles jumpScroll loginShell mapAlert meta8 mouseWheelScrollPage
838	pastableTabs pointerBlank reverseVideo scrollBar scrollBar_floating	1110	override-redirect pastableTabs pointerBlank reverseVideo scrollBar
839	scrollBar_right scrollTtyKeypress scrollTtyOutput scrollWithBuffer	1111	scrollBar_floating scrollBar_right scrollTtyKeypress scrollTtyOutput
840	secondaryScreen secondaryScroll skipBuiltinGlyphs transparent	1112	scrollWithBuffer secondaryScreen secondaryScroll skipBuiltinGlyphs
841	tripleclickwords utmpInhibit visualBell	1113	transparent tripleclickwords utmpInhibit visualBell
842		1114
843	=item $value = $term->resource ($name[, $newval])	1115	=item $value = $term->resource ($name[, $newval])
844		1116
845	Returns the current resource value associated with a given name and	1117	Returns the current resource value associated with a given name and
846	optionally sets a new value. Setting values is most useful in the C<init>	1118	optionally sets a new value. Setting values is most useful in the C<init>
…		…
863		1135
864	answerbackstring backgroundPixmap backspace_key boldFont boldItalicFont	1136	answerbackstring backgroundPixmap backspace_key boldFont boldItalicFont
865	borderLess color cursorBlink cursorUnderline cutchars delete_key	1137	borderLess color cursorBlink cursorUnderline cutchars delete_key
866	display_name embed ext_bwidth fade font geometry hold iconName	1138	display_name embed ext_bwidth fade font geometry hold iconName
867	imFont imLocale inputMethod insecure int_bwidth intensityStyles	1139	imFont imLocale inputMethod insecure int_bwidth intensityStyles
868	italicFont jumpScroll lineSpace loginShell mapAlert menu meta8 modifier	1140	italicFont jumpScroll lineSpace loginShell mapAlert meta8 modifier
869	mouseWheelScrollPage name pastableTabs path perl_eval perl_ext_1 perl_ext_2	1141	mouseWheelScrollPage name override_redirect pastableTabs path perl_eval
870	perl_lib pointerBlank pointerBlankDelay preeditType print_pipe pty_fd	1142	perl_ext_1 perl_ext_2 perl_lib pointerBlank pointerBlankDelay
871	reverseVideo saveLines scrollBar scrollBar_align scrollBar_floating	1143	preeditType print_pipe pty_fd reverseVideo saveLines scrollBar
872	scrollBar_right scrollBar_thickness scrollTtyKeypress scrollTtyOutput	1144	scrollBar_align scrollBar_floating scrollBar_right scrollBar_thickness
873	scrollWithBuffer scrollstyle secondaryScreen secondaryScroll selectstyle	1145	scrollTtyKeypress scrollTtyOutput scrollWithBuffer scrollstyle
874	shade term_name title transparent transparent_all tripleclickwords	1146	secondaryScreen secondaryScroll selectstyle shade term_name title
875	utmpInhibit visualBell	1147	transient_for transparent transparent_all tripleclickwords utmpInhibit
		1148	visualBell
876		1149
877	=cut	1150	=cut
878		1151
879	sub resource($$;$) {	1152	sub resource($$;$) {
880	my ($self, $name) = (shift, shift);	1153	my ($self, $name) = (shift, shift);
…		…
915	=item ($row, $col) = $term->selection_end ([$row, $col])	1188	=item ($row, $col) = $term->selection_end ([$row, $col])
916		1189
917	Return the current values of the selection mark, begin or end positions,	1190	Return the current values of the selection mark, begin or end positions,
918	and optionally set them to new values.	1191	and optionally set them to new values.
919		1192
		1193	=item $term->selection_make ($eventtime[, $rectangular])
		1194
		1195	Tries to make a selection as set by C<selection_beg> and
		1196	C<selection_end>. If C<$rectangular> is true (default: false), a
		1197	rectangular selection will be made. This is the prefered function to make
		1198	a selection.
		1199
920	=item $success = $term->selection_grab ($eventtime)	1200	=item $success = $term->selection_grab ($eventtime)
921		1201
922	Try to request the primary selection from the server (for example, as set	1202	Try to request the primary selection text from the server (for example, as
923	by the next method).	1203	set by the next method). No visual feedback will be given. This function
		1204	is mostly useful from within C<on_sel_grab> hooks.
924		1205
925	=item $oldtext = $term->selection ([$newtext])	1206	=item $oldtext = $term->selection ([$newtext])
926		1207
927	Return the current selection text and optionally replace it by C<$newtext>.	1208	Return the current selection text and optionally replace it by C<$newtext>.
928		1209
…		…
1021	Convert the given locale-encoded octets into a perl string.	1302	Convert the given locale-encoded octets into a perl string.
1022		1303
1023	=item $term->scr_xor_span ($beg_row, $beg_col, $end_row, $end_col[, $rstyle])	1304	=item $term->scr_xor_span ($beg_row, $beg_col, $end_row, $end_col[, $rstyle])
1024		1305
1025	XORs the rendition values in the given span with the provided value	1306	XORs the rendition values in the given span with the provided value
1026	(default: C<RS_RVid>). Useful in refresh hooks to provide effects similar	1307	(default: C<RS_RVid>), which I<MUST NOT> contain font styles. Useful in
1027	to the selection.	1308	refresh hooks to provide effects similar to the selection.
1028		1309
1029	=item $term->scr_xor_rect ($beg_row, $beg_col, $end_row, $end_col[, $rstyle1[, $rstyle2]])	1310	=item $term->scr_xor_rect ($beg_row, $beg_col, $end_row, $end_col[, $rstyle1[, $rstyle2]])
1030		1311
1031	Similar to C<scr_xor_span>, but xors a rectangle instead. Trailing	1312	Similar to C<scr_xor_span>, but xors a rectangle instead. Trailing
1032	whitespace will additionally be xored with the C<$rstyle2>, which defaults	1313	whitespace will additionally be xored with the C<$rstyle2>, which defaults
1033	to C<RS_RVid \| RS_Uline>, which removes reverse video again and underlines	1314	to C<RS_RVid \| RS_Uline>, which removes reverse video again and underlines
1034	it instead.	1315	it instead. Both styles I<MUST NOT> contain font styles.
1035		1316
1036	=item $term->scr_bell	1317	=item $term->scr_bell
1037		1318
1038	Ring the bell!	1319	Ring the bell!
1039		1320
…		…
1046		1327
1047	Normally its not a good idea to use this function, as programs might be	1328	Normally its not a good idea to use this function, as programs might be
1048	confused by changes in cursor position or scrolling. Its useful inside a	1329	confused by changes in cursor position or scrolling. Its useful inside a
1049	C<on_add_lines> hook, though.	1330	C<on_add_lines> hook, though.
1050		1331
		1332	=item $term->scr_change_screen ($screen)
		1333
		1334	Switch to given screen - 0 primary, 1 secondary.
		1335
1051	=item $term->cmd_parse ($octets)	1336	=item $term->cmd_parse ($octets)
1052		1337
1053	Similar to C<scr_add_lines>, but the argument must be in the	1338	Similar to C<scr_add_lines>, but the argument must be in the
1054	locale-specific encoding of the terminal and can contain command sequences	1339	locale-specific encoding of the terminal and can contain command sequences
1055	(escape codes) that will be interpreted.	1340	(escape codes) that will be interpreted.
…		…
1065	Replaces the event mask of the pty watcher by the given event mask. Can	1350	Replaces the event mask of the pty watcher by the given event mask. Can
1066	be used to suppress input and output handling to the pty/tty. See the	1351	be used to suppress input and output handling to the pty/tty. See the
1067	description of C<< urxvt::timer->events >>. Make sure to always restore	1352	description of C<< urxvt::timer->events >>. Make sure to always restore
1068	the previous value.	1353	the previous value.
1069		1354
		1355	=item $fd = $term->pty_fd
		1356
		1357	Returns the master file descriptor for the pty in use, or C<-1> if no pty
		1358	is used.
		1359
1070	=item $windowid = $term->parent	1360	=item $windowid = $term->parent
1071		1361
1072	Return the window id of the toplevel window.	1362	Return the window id of the toplevel window.
1073		1363
1074	=item $windowid = $term->vt	1364	=item $windowid = $term->vt
1075		1365
1076	Return the window id of the terminal window.	1366	Return the window id of the terminal window.
1077		1367
		1368	=item $term->vt_emask_add ($x_event_mask)
		1369
		1370	Adds the specified events to the vt event mask. Useful e.g. when you want
		1371	to receive pointer events all the times:
		1372
		1373	$term->vt_emask_add (urxvt::PointerMotionMask);
		1374
1078	=item $window_width = $term->width	1375	=item $window_width = $term->width
1079		1376
1080	=item $window_height = $term->height	1377	=item $window_height = $term->height
1081		1378
1082	=item $font_width = $term->fwidth	1379	=item $font_width = $term->fwidth
…		…
1095		1392
1096	=item $max_scrollback = $term->saveLines	1393	=item $max_scrollback = $term->saveLines
1097		1394
1098	=item $nrow_plus_saveLines = $term->total_rows	1395	=item $nrow_plus_saveLines = $term->total_rows
1099		1396
1100	=item $lines_in_scrollback = $term->nsaved	1397	=item $topmost_scrollback_row = $term->top_row
1101		1398
1102	Return various integers describing terminal characteristics.	1399	Return various integers describing terminal characteristics.
1103		1400
1104	=item $x_display = $term->display_id	1401	=item $x_display = $term->display_id
1105		1402
…		…
1131	=item $modifiermask = $term->ModNumLockMask	1428	=item $modifiermask = $term->ModNumLockMask
1132		1429
1133	Return the modifier masks corresponding to the "ISO Level 3 Shift" (often	1430	Return the modifier masks corresponding to the "ISO Level 3 Shift" (often
1134	AltGr), the meta key (often Alt) and the num lock key, if applicable.	1431	AltGr), the meta key (often Alt) and the num lock key, if applicable.
1135		1432
		1433	=item $screen = $term->current_screen
		1434
		1435	Returns the currently displayed screen (0 primary, 1 secondary).
		1436
		1437	=item $cursor_is_hidden = $term->hidden_cursor
		1438
		1439	Returns wether the cursor is currently hidden or not.
		1440
1136	=item $view_start = $term->view_start ([$newvalue])	1441	=item $view_start = $term->view_start ([$newvalue])
1137		1442
1138	Returns the negative row number of the topmost line. Minimum value is	1443	Returns the row number of the topmost displayed line. Maximum value is
1139	C<0>, which displays the normal terminal contents. Larger values scroll	1444	C<0>, which displays the normal terminal contents. Lower values scroll
1140	this many lines into the scrollback buffer.	1445	this many lines into the scrollback buffer.
1141		1446
1142	=item $term->want_refresh	1447	=item $term->want_refresh
1143		1448
1144	Requests a screen refresh. At the next opportunity, rxvt-unicode will	1449	Requests a screen refresh. At the next opportunity, rxvt-unicode will
…		…
1159	line, starting at column C<$start_col> (default C<0>), which is useful	1464	line, starting at column C<$start_col> (default C<0>), which is useful
1160	to replace only parts of a line. The font index in the rendition will	1465	to replace only parts of a line. The font index in the rendition will
1161	automatically be updated.	1466	automatically be updated.
1162		1467
1163	C<$text> is in a special encoding: tabs and wide characters that use more	1468	C<$text> is in a special encoding: tabs and wide characters that use more
1164	than one cell when displayed are padded with urxvt::NOCHAR characters	1469	than one cell when displayed are padded with C<$urxvt::NOCHAR> (chr 65535)
1165	(C<chr 65535>). Characters with combining characters and other characters	1470	characters. Characters with combining characters and other characters that
1166	that do not fit into the normal tetx encoding will be replaced with	1471	do not fit into the normal tetx encoding will be replaced with characters
1167	characters in the private use area.	1472	in the private use area.
1168		1473
1169	You have to obey this encoding when changing text. The advantage is	1474	You have to obey this encoding when changing text. The advantage is
1170	that C<substr> and similar functions work on screen cells and not on	1475	that C<substr> and similar functions work on screen cells and not on
1171	characters.	1476	characters.
1172		1477
…		…
1347		1652
1348	Calls XUngrab for the most recent grab. Is called automatically on	1653	Calls XUngrab for the most recent grab. Is called automatically on
1349	evaluation errors, as it is better to lose the grab in the error case as	1654	evaluation errors, as it is better to lose the grab in the error case as
1350	the session.	1655	the session.
1351		1656
		1657	=item $atom = $term->XInternAtom ($atom_name[, $only_if_exists])
		1658
		1659	=item $atom_name = $term->XGetAtomName ($atom)
		1660
		1661	=item @atoms = $term->XListProperties ($window)
		1662
		1663	=item ($type,$format,$octets) = $term->XGetWindowProperty ($window, $property)
		1664
		1665	=item $term->XChangeWindowProperty ($window, $property, $type, $format, $octets)
		1666
		1667	=item $term->XDeleteProperty ($window, $property)
		1668
		1669	=item $window = $term->DefaultRootWindow
		1670
		1671	=item $term->XReparentWindow ($window, $parent, [$x, $y])
		1672
		1673	=item $term->XMapWindow ($window)
		1674
		1675	=item $term->XUnmapWindow ($window)
		1676
		1677	=item $term->XMoveResizeWindow ($window, $x, $y, $width, $height)
		1678
		1679	=item ($x, $y, $child_window) = $term->XTranslateCoordinates ($src, $dst, $x, $y)
		1680
		1681	=item $term->XChangeInput ($window, $add_events[, $del_events])
		1682
		1683	Various X or X-related functions. The C<$term> object only serves as
		1684	the source of the display, otherwise those functions map more-or-less
		1685	directory onto the X functions of the same name.
		1686
1352	=back	1687	=back
1353		1688
1354	=cut	1689	=cut
1355		1690
1356	package urxvt::popup;	1691	package urxvt::popup;
…		…
1457	my $env = $self->{term}->env;	1792	my $env = $self->{term}->env;
1458	# we can't hope to reproduce the locale algorithm, so nuke LC_ALL and set LC_CTYPE.	1793	# we can't hope to reproduce the locale algorithm, so nuke LC_ALL and set LC_CTYPE.
1459	delete $env->{LC_ALL};	1794	delete $env->{LC_ALL};
1460	$env->{LC_CTYPE} = $self->{term}->locale;	1795	$env->{LC_CTYPE} = $self->{term}->locale;
1461		1796
1462	urxvt::term->new ($env, $self->{term}->resource ("name"),	1797	urxvt::term->new ($env, "popup",
1463	"--perl-lib" => "", "--perl-ext-common" => "", "-pty-fd" => -1, "-sl" => 0, "-b" => 0,	1798	"--perl-lib" => "", "--perl-ext-common" => "",
		1799	"-pty-fd" => -1, "-sl" => 0,
		1800	"-b" => 1, "-bd" => "grey80", "-bl", "-override-redirect",
1464	"--transient-for" => $self->{term}->parent,	1801	"--transient-for" => $self->{term}->parent,
1465	"-display" => $self->{term}->display_id,	1802	"-display" => $self->{term}->display_id,
1466	"-pe" => "urxvt-popup")	1803	"-pe" => "urxvt-popup")
1467	or die "unable to create popup window\n";	1804	or die "unable to create popup window\n";
1468	}	1805	}
…		…
1473	delete $self->{term}{_destroy}{$self};	1810	delete $self->{term}{_destroy}{$self};
1474	$self->{term}->ungrab;	1811	$self->{term}->ungrab;
1475	}	1812	}
1476		1813
1477	=back	1814	=back
		1815
		1816	=cut
		1817
		1818	package urxvt::watcher;
		1819
		1820	@urxvt::timer::ISA = __PACKAGE__;
		1821	@urxvt::iow::ISA = __PACKAGE__;
		1822	@urxvt::pw::ISA = __PACKAGE__;
		1823	@urxvt::iw::ISA = __PACKAGE__;
1478		1824
1479	=head2 The C<urxvt::timer> Class	1825	=head2 The C<urxvt::timer> Class
1480		1826
1481	This class implements timer watchers/events. Time is represented as a	1827	This class implements timer watchers/events. Time is represented as a
1482	fractional number of seconds since the epoch. Example:	1828	fractional number of seconds since the epoch. Example:
…		…
1520	Start the timer.	1866	Start the timer.
1521		1867
1522	=item $timer = $timer->start ($tstamp)	1868	=item $timer = $timer->start ($tstamp)
1523		1869
1524	Set the event trigger time to C<$tstamp> and start the timer.	1870	Set the event trigger time to C<$tstamp> and start the timer.
		1871
		1872	=item $timer = $timer->after ($delay)
		1873
		1874	Like C<start>, but sets the expiry timer to c<urxvt::NOW + $delay>.
1525		1875
1526	=item $timer = $timer->stop	1876	=item $timer = $timer->stop
1527		1877
1528	Stop the timer.	1878	Stop the timer.
1529		1879
…		…
1576		1926
1577	Stop watching for events on the given filehandle.	1927	Stop watching for events on the given filehandle.
1578		1928
1579	=back	1929	=back
1580		1930
		1931	=head2 The C<urxvt::iw> Class
		1932
		1933	This class implements idle watchers, that get called automatically when
		1934	the process is idle. They should return as fast as possible, after doing
		1935	some useful work.
		1936
		1937	=over 4
		1938
		1939	=item $iw = new urxvt::iw
		1940
		1941	Create a new idle watcher object in stopped state.
		1942
		1943	=item $iw = $iw->cb (sub { my ($iw) = @_; ... })
		1944
		1945	Set the callback to be called when the watcher triggers.
		1946
		1947	=item $timer = $timer->start
		1948
		1949	Start the watcher.
		1950
		1951	=item $timer = $timer->stop
		1952
		1953	Stop the watcher.
		1954
		1955	=back
		1956
		1957	=head2 The C<urxvt::pw> Class
		1958
		1959	This class implements process watchers. They create an event whenever a
		1960	process exits, after which they stop automatically.
		1961
		1962	my $pid = fork;
		1963	...
		1964	$term->{pw} = urxvt::pw
		1965	->new
		1966	->start ($pid)
		1967	->cb (sub {
		1968	my ($pw, $exit_status) = @_;
		1969	...
		1970	});
		1971
		1972	=over 4
		1973
		1974	=item $pw = new urxvt::pw
		1975
		1976	Create a new process watcher in stopped state.
		1977
		1978	=item $pw = $pw->cb (sub { my ($pw, $exit_status) = @_; ... })
		1979
		1980	Set the callback to be called when the timer triggers.
		1981
		1982	=item $pw = $timer->start ($pid)
		1983
		1984	Tells the wqtcher to start watching for process C<$pid>.
		1985
		1986	=item $pw = $pw->stop
		1987
		1988	Stop the watcher.
		1989
		1990	=back
		1991
1581	=head1 ENVIRONMENT	1992	=head1 ENVIRONMENT
1582		1993
1583	=head2 URXVT_PERL_VERBOSITY	1994	=head2 URXVT_PERL_VERBOSITY
1584		1995
1585	This variable controls the verbosity level of the perl extension. Higher	1996	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.85 by root, Thu Jan 12 03:32:56 2006 UTC vs. Revision 1.129 by root, Wed Jan 25 15:11:31 2006 UTC

Diff Legend

Comparing rxvt-unicode/src/urxvt.pm (file contents):
Revision 1.85 by root, Thu Jan 12 03:32:56 2006 UTC vs.
Revision 1.129 by root, Wed Jan 25 15:11:31 2006 UTC