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

Comparing rxvt-unicode/src/urxvt.pm (file contents):
Revision 1.84 by root, Thu Jan 12 02:20:56 2006 UTC vs.
Revision 1.127 by root, Wed Jan 25 00:42:21 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 automove-background
		218
		219	This is basically a one-line extension that dynamically changes the background pixmap offset
		220	to the window position, in effect creating the same effect as pseudo transparency with
		221	a custom pixmap. No scaling is supported in this mode. Exmaple:
		222
		223	@@RXVT_NAME@@ -pixmap background.xpm -pe automove-background
92		224
93	=item block-graphics-to-ascii	225	=item block-graphics-to-ascii
94		226
95	A not very useful example of filtering all text output to the terminal,	227	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	228	by replacing all line-drawing characters (U+2500 .. U+259F) by a
97	similar-looking ascii character.	229	similar-looking ascii character.
98		230
		231	=item digital-clock
		232
		233	Displays a digital clock using the built-in overlay.
		234
99	=item example-refresh-hooks	235	=item example-refresh-hooks
100		236
101	Displays a very simple digital clock in the upper right corner of the	237	Displays a very simple digital clock in the upper right corner of the
102	window. Illustrates overwriting the refresh callbacks to create your own	238	window. Illustrates overwriting the refresh callbacks to create your own
103	overlays or changes.	239	overlays or changes.
		240
		241	=item selection-pastebin
		242
		243	This is a little rarely useful extension that Uploads the selection as
		244	textfile to a remote site (or does other things). (The implementation is
		245	not currently secure for use in a multiuser environment as it writes to
		246	F</tmp> directly.).
		247
		248	It listens to the C<selection-pastebin:remote-pastebin> keyboard command,
		249	i.e.
		250
		251	URxvt.keysym.C-M-e: perl:selection-pastebin:remote-pastebin
		252
		253	Pressing this combination runs a command with C<%> replaced by the name of
		254	the textfile. This command can be set via a resource:
		255
		256	URxvt.selection-pastebin.cmd: rsync -apP % ruth:/var/www/www.ta-sa.org/files/txt/.
		257
		258	And the default is likely not useful to anybody but the few people around
		259	here :)
		260
		261	The name of the textfile is the hex encoded md5 sum of the selection, so
		262	the same content should lead to the same filename.
		263
		264	After a successful upload the selection will be replaced by the text given
		265	in the C<selection-pastebin-url> resource (again, the % is the placeholder
		266	for the filename):
		267
		268	URxvt.selection-pastebin.url: http://www.ta-sa.org/files/txt/%
104		269
105	=back	270	=back
106		271
107	=head1 API DOCUMENTATION	272	=head1 API DOCUMENTATION
108		273
…		…
181	called whenever the relevant event happens.	346	called whenever the relevant event happens.
182		347
183	The first argument passed to them is an extension oject as described in	348	The first argument passed to them is an extension oject as described in
184	the in the C<Extension Objects> section.	349	the in the C<Extension Objects> section.
185		350
186	B<All> of these hooks must return a boolean value. If it is true, then the	351	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	352	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.	353	relevant action might not be carried out by the C++ code.
189		354
190	I<< When in doubt, return a false value (preferably C<()>). >>	355	I<< When in doubt, return a false value (preferably C<()>). >>
191		356
192	=over 4	357	=over 4
193		358
194	=item on_init $term	359	=item on_init $term
195		360
196	Called after a new terminal object has been initialized, but before	361	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	362	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	363	call or deliver senseless data, as terminal size and other characteristics
199	have not yet been determined. You can safely query and change resources,	364	have not yet been determined. You can safely query and change resources
200	though.	365	and options, though. For many purposes the C<on_start> hook is a better
		366	place.
		367
		368	=item on_start $term
		369
		370	Called at the very end of initialisation of a new terminal, just before
		371	trying to map (display) the toplevel and returning to the mainloop.
		372
		373	=item on_destroy $term
		374
		375	Called whenever something tries to destroy terminal, when the terminal is
		376	still fully functional (not for long, though).
201		377
202	=item on_reset $term	378	=item on_reset $term
203		379
204	Called after the screen is "reset" for any reason, such as resizing or	380	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	381	control sequences. Here is where you can react on changes to size-related
206	variables.	382	variables.
207		383
208	=item on_start $term	384	=item on_child_start $term, $pid
209		385
210	Called at the very end of initialisation of a new terminal, just before	386	Called just after the child process has been C<fork>ed.
211	returning to the mainloop.	387
		388	=item on_child_exit $term, $status
		389
		390	Called just after the child process has exited. C<$status> is the status
		391	from C<waitpid>.
212		392
213	=item on_sel_make $term, $eventtime	393	=item on_sel_make $term, $eventtime
214		394
215	Called whenever a selection has been made by the user, but before the	395	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	396	selection text is copied, so changes to the beginning, end or type of the
…		…
230	=item on_sel_extend $term	410	=item on_sel_extend $term
231		411
232	Called whenever the user tries to extend the selection (e.g. with a double	412	Called whenever the user tries to extend the selection (e.g. with a double
233	click) and is either supposed to return false (normal operation), or	413	click) and is either supposed to return false (normal operation), or
234	should extend the selection itelf and return true to suppress the built-in	414	should extend the selection itelf and return true to suppress the built-in
235	processing.	415	processing. This can happen multiple times, as long as the callback
		416	returns true, it will be called on every further click by the user and is
		417	supposed to enlarge the selection more and more, if possible.
236		418
237	See the F<selection> example extension.	419	See the F<selection> example extension.
238		420
239	=item on_view_change $term, $offset	421	=item on_view_change $term, $offset
240		422
…		…
307		489
308	Called whenever the user presses a key combination that has a	490	Called whenever the user presses a key combination that has a
309	C<perl:string> action bound to it (see description of the B<keysym>	491	C<perl:string> action bound to it (see description of the B<keysym>
310	resource in the @@RXVT_NAME@@(1) manpage).	492	resource in the @@RXVT_NAME@@(1) manpage).
311		493
		494	=item on_x_event $term, $event
		495
		496	Called on every X event received on the vt window (and possibly other
		497	windows). Should only be used as a last resort. Most event structure
		498	members are not passed.
		499
312	=item on_focus_in $term	500	=item on_focus_in $term
313		501
314	Called whenever the window gets the keyboard focus, before rxvt-unicode	502	Called whenever the window gets the keyboard focus, before rxvt-unicode
315	does focus in processing.	503	does focus in processing.
316		504
317	=item on_focus_out $term	505	=item on_focus_out $term
318		506
319	Called wheneever the window loses keyboard focus, before rxvt-unicode does	507	Called wheneever the window loses keyboard focus, before rxvt-unicode does
320	focus out processing.	508	focus out processing.
321		509
		510	=item on_configure_notify $term, $event
		511
		512	=item on_property_notify $term, $event
		513
322	=item on_key_press $term, $event, $keysym, $octets	514	=item on_key_press $term, $event, $keysym, $octets
323		515
324	=item on_key_release $term, $event, $keysym	516	=item on_key_release $term, $event, $keysym
325		517
326	=item on_button_press $term, $event	518	=item on_button_press $term, $event
…		…
335		527
336	Called whenever the corresponding X event is received for the terminal If	528	Called whenever the corresponding X event is received for the terminal If
337	the hook returns true, then the even will be ignored by rxvt-unicode.	529	the hook returns true, then the even will be ignored by rxvt-unicode.
338		530
339	The event is a hash with most values as named by Xlib (see the XEvent	531	The event is a hash with most values as named by Xlib (see the XEvent
340	manpage), with the additional members C<row> and C<col>, which are the row	532	manpage), with the additional members C<row> and C<col>, which are the
341	and column under the mouse cursor.	533	(real, not screen-based) row and column under the mouse cursor.
342		534
343	C<on_key_press> additionally receives the string rxvt-unicode would	535	C<on_key_press> additionally receives the string rxvt-unicode would
344	output, if any, in locale-specific encoding.	536	output, if any, in locale-specific encoding.
345		537
346	subwindow.	538	subwindow.
		539
		540	=item on_client_message $term, $event
		541
		542	=item on_wm_protocols $term, $event
		543
		544	=item on_wm_delete_window $term, $event
		545
		546	Called when various types of ClientMessage events are received (all with
		547	format=32, WM_PROTOCOLS or WM_PROTOCOLS:WM_DELETE_WINDOW).
347		548
348	=back	549	=back
349		550
350	=cut	551	=cut
351		552
…		…
357	use Scalar::Util ();	558	use Scalar::Util ();
358	use List::Util ();	559	use List::Util ();
359		560
360	our $VERSION = 1;	561	our $VERSION = 1;
361	our $TERM;	562	our $TERM;
		563	our @TERM_INIT;
		564	our @TERM_EXT;
362	our @HOOKNAME;	565	our @HOOKNAME;
363	our %HOOKTYPE = map +($HOOKNAME[$_] => $_), 0..$#HOOKNAME;	566	our %HOOKTYPE = map +($HOOKNAME[$_] => $_), 0..$#HOOKNAME;
364	our %OPTION;	567	our %OPTION;
365		568
366	our $LIBDIR;	569	our $LIBDIR;
367	our $RESNAME;	570	our $RESNAME;
368	our $RESCLASS;	571	our $RESCLASS;
369	our $RXVTNAME;	572	our $RXVTNAME;
370		573
		574	our $NOCHAR = chr 0xffff;
		575
371	=head2 Variables in the C<urxvt> Package	576	=head2 Variables in the C<urxvt> Package
372		577
373	=over 4	578	=over 4
374		579
375	=item $urxvt::LIBDIR	580	=item $urxvt::LIBDIR
…		…
387		592
388	=item $urxvt::TERM	593	=item $urxvt::TERM
389		594
390	The current terminal. This variable stores the current C<urxvt::term>	595	The current terminal. This variable stores the current C<urxvt::term>
391	object, whenever a callback/hook is executing.	596	object, whenever a callback/hook is executing.
		597
		598	=item @urxvt::TERM_INIT
		599
		600	All coderefs in this array will be called as methods of the next newly
		601	created C<urxvt::term> object (during the C<on_init> phase). The array
		602	gets cleared before the codereferences that were in it are being executed,
		603	so coderefs can push themselves onto it again if they so desire.
		604
		605	This complements to the perl-eval commandline option, but gets executed
		606	first.
		607
		608	=item @urxvt::TERM_EXT
		609
		610	Works similar to C<@TERM_INIT>, but contains perl package/class names, which
		611	get registered as normal extensions after calling the hooks in C<@TERM_INIT>
		612	but before other extensions. Gets cleared just like C<@TERM_INIT>.
392		613
393	=back	614	=back
394		615
395	=head2 Functions in the C<urxvt> Package	616	=head2 Functions in the C<urxvt> Package
396		617
…		…
411	Using this function has the advantage that its output ends up in the	632	Using this function has the advantage that its output ends up in the
412	correct place, e.g. on stderr of the connecting urxvtc client.	633	correct place, e.g. on stderr of the connecting urxvtc client.
413		634
414	Messages have a size limit of 1023 bytes currently.	635	Messages have a size limit of 1023 bytes currently.
415		636
416	=item $is_safe = urxvt::safe
417
418	Returns true when it is safe to do potentially unsafe things, such as
419	evaluating perl code specified by the user. This is true when urxvt was
420	started setuid or setgid.
421
422	=item $time = urxvt::NOW	637	=item $time = urxvt::NOW
423		638
424	Returns the "current time" (as per the event loop).	639	Returns the "current time" (as per the event loop).
425		640
426	=item urxvt::CurrentTime	641	=item urxvt::CurrentTime
427		642
428	=item urxvt::ShiftMask, LockMask, ControlMask, Mod1Mask, Mod2Mask,	643	=item urxvt::ShiftMask, LockMask, ControlMask, Mod1Mask, Mod2Mask,
429	Mod3Mask, Mod4Mask, Mod5Mask, Button1Mask, Button2Mask, Button3Mask,	644	Mod3Mask, Mod4Mask, Mod5Mask, Button1Mask, Button2Mask, Button3Mask,
430	Button4Mask, Button5Mask, AnyModifier	645	Button4Mask, Button5Mask, AnyModifier
		646
		647	=item urxvt::NoEventMask, KeyPressMask, KeyReleaseMask,
		648	ButtonPressMask, ButtonReleaseMask, EnterWindowMask, LeaveWindowMask,
		649	PointerMotionMask, PointerMotionHintMask, Button1MotionMask, Button2MotionMask,
		650	Button3MotionMask, Button4MotionMask, Button5MotionMask, ButtonMotionMask,
		651	KeymapStateMask, ExposureMask, VisibilityChangeMask, StructureNotifyMask,
		652	ResizeRedirectMask, SubstructureNotifyMask, SubstructureRedirectMask,
		653	FocusChangeMask, PropertyChangeMask, ColormapChangeMask, OwnerGrabButtonMask
		654
		655	=item urxvt::KeyPress, KeyRelease, ButtonPress, ButtonRelease, MotionNotify,
		656	EnterNotify, LeaveNotify, FocusIn, FocusOut, KeymapNotify, Expose,
		657	GraphicsExpose, NoExpose, VisibilityNotify, CreateNotify, DestroyNotify,
		658	UnmapNotify, MapNotify, MapRequest, ReparentNotify, ConfigureNotify,
		659	ConfigureRequest, GravityNotify, ResizeRequest, CirculateNotify,
		660	CirculateRequest, PropertyNotify, SelectionClear, SelectionRequest,
		661	SelectionNotify, ColormapNotify, ClientMessage, MappingNotify
431		662
432	Various constants for use in X calls and event processing.	663	Various constants for use in X calls and event processing.
433		664
434	=back	665	=back
435		666
…		…
486	=back	717	=back
487		718
488	=cut	719	=cut
489		720
490	BEGIN {	721	BEGIN {
491	urxvt->bootstrap;
492
493	# overwrite perl's warn	722	# overwrite perl's warn
494	*CORE::GLOBAL::warn = sub {	723	*CORE::GLOBAL::warn = sub {
495	my $msg = join "", @_;	724	my $msg = join "", @_;
496	$msg .= "\n"	725	$msg .= "\n"
497	unless $msg =~ /\n$/;	726	unless $msg =~ /\n$/;
498	urxvt::warn ($msg);	727	urxvt::warn ($msg);
499	};	728	};
500
501	# %ENV is the original startup environment
502	delete $ENV{IFS};
503	delete $ENV{CDPATH};
504	delete $ENV{BASH_ENV};
505	$ENV{PATH} = "/bin:/sbin:/usr/bin:/usr/sbin:/usr/local/bin:/usr/local/sbin:/opt/bin:/opt/sbin";
506	}	729	}
507		730
508	my @hook_count;	731	no warnings 'utf8';
		732
509	my $verbosity = $ENV{URXVT_PERL_VERBOSITY};	733	my $verbosity = $ENV{URXVT_PERL_VERBOSITY};
510		734
511	sub verbose {	735	sub verbose {
512	my ($level, $msg) = @_;	736	my ($level, $msg) = @_;
513	warn "$msg\n" if $level <= $verbosity;	737	warn "$msg\n" if $level <= $verbosity;
514	}	738	}
515		739
516	my $extension_pkg = "extension0000";
517	my %extension_pkg;	740	my %extension_pkg;
518		741
519	# load a single script into its own package, once only	742	# load a single script into its own package, once only
520	sub extension_package($) {	743	sub extension_package($) {
521	my ($path) = @_;	744	my ($path) = @_;
522		745
523	$extension_pkg{$path} \|\|= do {	746	$extension_pkg{$path} \|\|= do {
524	my $pkg = "urxvt::" . ($extension_pkg++);	747	$path =~ /([^\/\\]+)$/;
		748	my $pkg = $1;
		749	$pkg =~ s/[^[:word:]]/_/g;
		750	$pkg = "urxvt::ext::$pkg";
525		751
526	verbose 3, "loading extension '$path' into package '$pkg'";	752	verbose 3, "loading extension '$path' into package '$pkg'";
527		753
528	open my $fh, "<:raw", $path	754	open my $fh, "<:raw", $path
529	or die "$path: $!";	755	or die "$path: $!";
530		756
531	my $source = untaint	757	my $source =
532	"package $pkg; use strict; use utf8;\n"	758	"package $pkg; use strict; use utf8; no warnings 'utf8';\n"
533	. "use base urxvt::term::extension::;\n"
534	. "#line 1 \"$path\"\n{\n"	759	. "#line 1 \"$path\"\n{\n"
535	. (do { local $/; <$fh> })	760	. (do { local $/; <$fh> })
536	. "\n};\n1";	761	. "\n};\n1";
537		762
538	eval $source	763	eval $source
…		…
552	if ($htype == 0) { # INIT	777	if ($htype == 0) { # INIT
553	my @dirs = ((split /:/, $TERM->resource ("perl_lib")), "$LIBDIR/perl");	778	my @dirs = ((split /:/, $TERM->resource ("perl_lib")), "$LIBDIR/perl");
554		779
555	my %ext_arg;	780	my %ext_arg;
556		781
		782	{
		783	my @init = @TERM_INIT;
		784	@TERM_INIT = ();
		785	$_->($TERM) for @init;
		786	my @pkg = @TERM_EXT;
		787	@TERM_EXT = ();
		788	$TERM->register_package ($_) for @pkg;
		789	}
		790
557	for (map { split /,/, $TERM->resource ("perl_ext_$_") } 1, 2) {	791	for (grep $_, map { split /,/, $TERM->resource ("perl_ext_$_") } 1, 2) {
558	if ($_ eq "default") {	792	if ($_ eq "default") {
559	$ext_arg{$_} \|\|= [] for qw(selection option-popup selection-popup searchable-scrollback);	793	$ext_arg{$_} \|\|= [] for qw(selection option-popup selection-popup searchable-scrollback readline);
560	} elsif (/^-(.*)$/) {	794	} elsif (/^-(.*)$/) {
561	delete $ext_arg{$1};	795	delete $ext_arg{$1};
562	} elsif (/^([^<]+)<(.*)>$/) {	796	} elsif (/^([^<]+)<(.*)>$/) {
563	push @{ $ext_arg{$1} }, $2;	797	push @{ $ext_arg{$1} }, $2;
564	} else {	798	} else {
…		…
587	if $verbosity >= 10;	821	if $verbosity >= 10;
588		822
589	keys %$cb;	823	keys %$cb;
590		824
591	while (my ($pkg, $cb) = each %$cb) {	825	while (my ($pkg, $cb) = each %$cb) {
592	$retval = eval { $cb->($TERM->{_pkg}{$pkg}, @_) }	826	my $retval_ = eval { $cb->($TERM->{_pkg}{$pkg}, @_) };
593	and last;	827	$retval \|\|= $retval_;
594		828
595	if ($@) {	829	if ($@) {
596	$TERM->ungrab; # better to lose the grab than the session	830	$TERM->ungrab; # better to lose the grab than the session
597	warn $@;	831	warn $@;
598	}	832	}
599	}	833	}
		834
		835	verbose 11, "$HOOKNAME[$htype] returning <$retval>"
		836	if $verbosity >= 11;
600	}	837	}
601		838
602	if ($htype == 1) { # DESTROY	839	if ($htype == 1) { # DESTROY
603	if (my $hook = delete $TERM->{_hook}) {
604	for my $htype (0..$#$hook) {
605	$hook_count[$htype] -= scalar keys %{ $hook->[$htype] \|\| {} }
606	or set_should_invoke $htype, 0;
607	}
608	}
609
610	# clear package objects	840	# clear package objects
611	%$_ = () for values %{ $TERM->{_pkg} };	841	%$_ = () for values %{ $TERM->{_pkg} };
612		842
613	# clear package	843	# clear package
614	%$TERM = ();	844	%$TERM = ();
615	}	845	}
616		846
617	$retval	847	$retval
618	}
619
620	sub exec_async(@) {
621	my $pid = fork;
622
623	return
624	if !defined $pid or $pid;
625
626	%ENV = %{ $TERM->env };
627
628	exec @_;
629	_exit 255;
630	}	848	}
631		849
632	# urxvt::term::extension	850	# urxvt::term::extension
633		851
634	package urxvt::term::extension;	852	package urxvt::term::extension;
…		…
640	while (my ($name, $cb) = each %hook) {	858	while (my ($name, $cb) = each %hook) {
641	my $htype = $HOOKTYPE{uc $name};	859	my $htype = $HOOKTYPE{uc $name};
642	defined $htype	860	defined $htype
643	or Carp::croak "unsupported hook type '$name'";	861	or Carp::croak "unsupported hook type '$name'";
644		862
		863	$self->set_should_invoke ($htype, +1)
645	unless (exists $self->{term}{_hook}[$htype]{$pkg}) {	864	unless exists $self->{term}{_hook}[$htype]{$pkg};
646	$hook_count[$htype]++
647	or urxvt::set_should_invoke $htype, 1;
648	}
649		865
650	$self->{term}{_hook}[$htype]{$pkg} = $cb;	866	$self->{term}{_hook}[$htype]{$pkg} = $cb;
651	}	867	}
652	}	868	}
653		869
…		…
658	for my $name (@hook) {	874	for my $name (@hook) {
659	my $htype = $HOOKTYPE{uc $name};	875	my $htype = $HOOKTYPE{uc $name};
660	defined $htype	876	defined $htype
661	or Carp::croak "unsupported hook type '$name'";	877	or Carp::croak "unsupported hook type '$name'";
662		878
		879	$self->set_should_invoke ($htype, -1)
663	if (delete $self->{term}{_hook}[$htype]{$pkg}) {	880	if delete $self->{term}{_hook}[$htype]{$pkg};
664	--$hook_count[$htype]
665	or urxvt::set_should_invoke $htype, 0;
666	}
667	}	881	}
668	}	882	}
669		883
670	our $AUTOLOAD;	884	our $AUTOLOAD;
671		885
…		…
777	# find on_xxx subs in the package and register them	991	# find on_xxx subs in the package and register them
778	# as hooks	992	# as hooks
779	sub register_package {	993	sub register_package {
780	my ($self, $pkg, $argv) = @_;	994	my ($self, $pkg, $argv) = @_;
781		995
		996	no strict 'refs';
		997
		998	urxvt::verbose 6, "register package $pkg to $self";
		999
		1000	@{"$pkg\::ISA"} = urxvt::term::extension::;
		1001
782	my $proxy = bless {	1002	my $proxy = bless {
783	_pkg => $pkg,	1003	_pkg => $pkg,
784	argv => $argv,	1004	argv => $argv,
785	}, $pkg;	1005	}, $pkg;
786	Scalar::Util::weaken ($proxy->{term} = $self);	1006	Scalar::Util::weaken ($proxy->{term} = $self);
…		…
817		1037
818	Destroy the terminal object (close the window, free resources	1038	Destroy the terminal object (close the window, free resources
819	etc.). Please note that @@RXVT_NAME@@ will not exit as long as any event	1039	etc.). Please note that @@RXVT_NAME@@ will not exit as long as any event
820	watchers (timers, io watchers) are still active.	1040	watchers (timers, io watchers) are still active.
821		1041
		1042	=item $term->exec_async ($cmd[, @args])
		1043
		1044	Works like the combination of the C<fork>/C<exec> builtins, which executes
		1045	("starts") programs in the background. This function takes care of setting
		1046	the user environment before exec'ing the command (e.g. C<PATH>) and should
		1047	be preferred over explicit calls to C<exec> or C<system>.
		1048
		1049	Returns the pid of the subprocess or C<undef> on error.
		1050
		1051	=cut
		1052
		1053	sub exec_async {
		1054	my $self = shift;
		1055
		1056	my $pid = fork;
		1057
		1058	return $pid
		1059	if !defined $pid or $pid;
		1060
		1061	%ENV = %{ $self->env };
		1062
		1063	exec @_;
		1064	urxvt::_exit 255;
		1065	}
		1066
822	=item $isset = $term->option ($optval[, $set])	1067	=item $isset = $term->option ($optval[, $set])
823		1068
824	Returns true if the option specified by C<$optval> is enabled, and	1069	Returns true if the option specified by C<$optval> is enabled, and
825	optionally change it. All option values are stored by name in the hash	1070	optionally change it. All option values are stored by name in the hash
826	C<%urxvt::OPTION>. Options not enabled in this binary are not in the hash.	1071	C<%urxvt::OPTION>. Options not enabled in this binary are not in the hash.
…		…
828	Here is a a likely non-exhaustive list of option names, please see the	1073	Here is a a likely non-exhaustive list of option names, please see the
829	source file F</src/optinc.h> to see the actual list:	1074	source file F</src/optinc.h> to see the actual list:
830		1075
831	borderLess console cursorBlink cursorUnderline hold iconic insecure	1076	borderLess console cursorBlink cursorUnderline hold iconic insecure
832	intensityStyles jumpScroll loginShell mapAlert meta8 mouseWheelScrollPage	1077	intensityStyles jumpScroll loginShell mapAlert meta8 mouseWheelScrollPage
833	pastableTabs pointerBlank reverseVideo scrollBar scrollBar_floating	1078	override-redirect pastableTabs pointerBlank reverseVideo scrollBar
834	scrollBar_right scrollTtyKeypress scrollTtyOutput scrollWithBuffer	1079	scrollBar_floating scrollBar_right scrollTtyKeypress scrollTtyOutput
835	secondaryScreen secondaryScroll skipBuiltinGlyphs transparent	1080	scrollWithBuffer secondaryScreen secondaryScroll skipBuiltinGlyphs
836	tripleclickwords utmpInhibit visualBell	1081	transparent tripleclickwords utmpInhibit visualBell
837		1082
838	=item $value = $term->resource ($name[, $newval])	1083	=item $value = $term->resource ($name[, $newval])
839		1084
840	Returns the current resource value associated with a given name and	1085	Returns the current resource value associated with a given name and
841	optionally sets a new value. Setting values is most useful in the C<init>	1086	optionally sets a new value. Setting values is most useful in the C<init>
…		…
858		1103
859	answerbackstring backgroundPixmap backspace_key boldFont boldItalicFont	1104	answerbackstring backgroundPixmap backspace_key boldFont boldItalicFont
860	borderLess color cursorBlink cursorUnderline cutchars delete_key	1105	borderLess color cursorBlink cursorUnderline cutchars delete_key
861	display_name embed ext_bwidth fade font geometry hold iconName	1106	display_name embed ext_bwidth fade font geometry hold iconName
862	imFont imLocale inputMethod insecure int_bwidth intensityStyles	1107	imFont imLocale inputMethod insecure int_bwidth intensityStyles
863	italicFont jumpScroll lineSpace loginShell mapAlert menu meta8 modifier	1108	italicFont jumpScroll lineSpace loginShell mapAlert meta8 modifier
864	mouseWheelScrollPage name pastableTabs path perl_eval perl_ext_1 perl_ext_2	1109	mouseWheelScrollPage name override_redirect pastableTabs path perl_eval
865	perl_lib pointerBlank pointerBlankDelay preeditType print_pipe pty_fd	1110	perl_ext_1 perl_ext_2 perl_lib pointerBlank pointerBlankDelay
866	reverseVideo saveLines scrollBar scrollBar_align scrollBar_floating	1111	preeditType print_pipe pty_fd reverseVideo saveLines scrollBar
867	scrollBar_right scrollBar_thickness scrollTtyKeypress scrollTtyOutput	1112	scrollBar_align scrollBar_floating scrollBar_right scrollBar_thickness
868	scrollWithBuffer scrollstyle secondaryScreen secondaryScroll selectstyle	1113	scrollTtyKeypress scrollTtyOutput scrollWithBuffer scrollstyle
869	shade term_name title transparent transparent_all tripleclickwords	1114	secondaryScreen secondaryScroll selectstyle shade term_name title
870	utmpInhibit visualBell	1115	transient_for transparent transparent_all tripleclickwords utmpInhibit
		1116	visualBell
871		1117
872	=cut	1118	=cut
873		1119
874	sub resource($$;$) {	1120	sub resource($$;$) {
875	my ($self, $name) = (shift, shift);	1121	my ($self, $name) = (shift, shift);
…		…
910	=item ($row, $col) = $term->selection_end ([$row, $col])	1156	=item ($row, $col) = $term->selection_end ([$row, $col])
911		1157
912	Return the current values of the selection mark, begin or end positions,	1158	Return the current values of the selection mark, begin or end positions,
913	and optionally set them to new values.	1159	and optionally set them to new values.
914		1160
		1161	=item $term->selection_make ($eventtime[, $rectangular])
		1162
		1163	Tries to make a selection as set by C<selection_beg> and
		1164	C<selection_end>. If C<$rectangular> is true (default: false), a
		1165	rectangular selection will be made. This is the prefered function to make
		1166	a selection.
		1167
915	=item $success = $term->selection_grab ($eventtime)	1168	=item $success = $term->selection_grab ($eventtime)
916		1169
917	Try to request the primary selection from the server (for example, as set	1170	Try to request the primary selection text from the server (for example, as
918	by the next method).	1171	set by the next method). No visual feedback will be given. This function
		1172	is mostly useful from within C<on_sel_grab> hooks.
919		1173
920	=item $oldtext = $term->selection ([$newtext])	1174	=item $oldtext = $term->selection ([$newtext])
921		1175
922	Return the current selection text and optionally replace it by C<$newtext>.	1176	Return the current selection text and optionally replace it by C<$newtext>.
923		1177
…		…
1016	Convert the given locale-encoded octets into a perl string.	1270	Convert the given locale-encoded octets into a perl string.
1017		1271
1018	=item $term->scr_xor_span ($beg_row, $beg_col, $end_row, $end_col[, $rstyle])	1272	=item $term->scr_xor_span ($beg_row, $beg_col, $end_row, $end_col[, $rstyle])
1019		1273
1020	XORs the rendition values in the given span with the provided value	1274	XORs the rendition values in the given span with the provided value
1021	(default: C<RS_RVid>). Useful in refresh hooks to provide effects similar	1275	(default: C<RS_RVid>), which I<MUST NOT> contain font styles. Useful in
1022	to the selection.	1276	refresh hooks to provide effects similar to the selection.
1023		1277
1024	=item $term->scr_xor_rect ($beg_row, $beg_col, $end_row, $end_col[, $rstyle1[, $rstyle2]])	1278	=item $term->scr_xor_rect ($beg_row, $beg_col, $end_row, $end_col[, $rstyle1[, $rstyle2]])
1025		1279
1026	Similar to C<scr_xor_span>, but xors a rectangle instead. Trailing	1280	Similar to C<scr_xor_span>, but xors a rectangle instead. Trailing
1027	whitespace will additionally be xored with the C<$rstyle2>, which defaults	1281	whitespace will additionally be xored with the C<$rstyle2>, which defaults
1028	to C<RS_RVid \| RS_Uline>, which removes reverse video again and underlines	1282	to C<RS_RVid \| RS_Uline>, which removes reverse video again and underlines
1029	it instead.	1283	it instead. Both styles I<MUST NOT> contain font styles.
1030		1284
1031	=item $term->scr_bell	1285	=item $term->scr_bell
1032		1286
1033	Ring the bell!	1287	Ring the bell!
1034		1288
…		…
1041		1295
1042	Normally its not a good idea to use this function, as programs might be	1296	Normally its not a good idea to use this function, as programs might be
1043	confused by changes in cursor position or scrolling. Its useful inside a	1297	confused by changes in cursor position or scrolling. Its useful inside a
1044	C<on_add_lines> hook, though.	1298	C<on_add_lines> hook, though.
1045		1299
		1300	=item $term->scr_change_screen ($screen)
		1301
		1302	Switch to given screen - 0 primary, 1 secondary.
		1303
1046	=item $term->cmd_parse ($octets)	1304	=item $term->cmd_parse ($octets)
1047		1305
1048	Similar to C<scr_add_lines>, but the argument must be in the	1306	Similar to C<scr_add_lines>, but the argument must be in the
1049	locale-specific encoding of the terminal and can contain command sequences	1307	locale-specific encoding of the terminal and can contain command sequences
1050	(escape codes) that will be interpreted.	1308	(escape codes) that will be interpreted.
…		…
1060	Replaces the event mask of the pty watcher by the given event mask. Can	1318	Replaces the event mask of the pty watcher by the given event mask. Can
1061	be used to suppress input and output handling to the pty/tty. See the	1319	be used to suppress input and output handling to the pty/tty. See the
1062	description of C<< urxvt::timer->events >>. Make sure to always restore	1320	description of C<< urxvt::timer->events >>. Make sure to always restore
1063	the previous value.	1321	the previous value.
1064		1322
		1323	=item $fd = $term->pty_fd
		1324
		1325	Returns the master file descriptor for the pty in use, or C<-1> if no pty
		1326	is used.
		1327
1065	=item $windowid = $term->parent	1328	=item $windowid = $term->parent
1066		1329
1067	Return the window id of the toplevel window.	1330	Return the window id of the toplevel window.
1068		1331
1069	=item $windowid = $term->vt	1332	=item $windowid = $term->vt
1070		1333
1071	Return the window id of the terminal window.	1334	Return the window id of the terminal window.
1072		1335
		1336	=item $term->vt_emask_add ($x_event_mask)
		1337
		1338	Adds the specified events to the vt event mask. Useful e.g. when you want
		1339	to receive pointer events all the times:
		1340
		1341	$term->vt_emask_add (urxvt::PointerMotionMask);
		1342
1073	=item $window_width = $term->width	1343	=item $window_width = $term->width
1074		1344
1075	=item $window_height = $term->height	1345	=item $window_height = $term->height
1076		1346
1077	=item $font_width = $term->fwidth	1347	=item $font_width = $term->fwidth
…		…
1090		1360
1091	=item $max_scrollback = $term->saveLines	1361	=item $max_scrollback = $term->saveLines
1092		1362
1093	=item $nrow_plus_saveLines = $term->total_rows	1363	=item $nrow_plus_saveLines = $term->total_rows
1094		1364
1095	=item $lines_in_scrollback = $term->nsaved	1365	=item $topmost_scrollback_row = $term->top_row
1096		1366
1097	Return various integers describing terminal characteristics.	1367	Return various integers describing terminal characteristics.
1098		1368
1099	=item $x_display = $term->display_id	1369	=item $x_display = $term->display_id
1100		1370
…		…
1126	=item $modifiermask = $term->ModNumLockMask	1396	=item $modifiermask = $term->ModNumLockMask
1127		1397
1128	Return the modifier masks corresponding to the "ISO Level 3 Shift" (often	1398	Return the modifier masks corresponding to the "ISO Level 3 Shift" (often
1129	AltGr), the meta key (often Alt) and the num lock key, if applicable.	1399	AltGr), the meta key (often Alt) and the num lock key, if applicable.
1130		1400
		1401	=item $screen = $term->current_screen
		1402
		1403	Returns the currently displayed screen (0 primary, 1 secondary).
		1404
		1405	=item $cursor_is_hidden = $term->hidden_cursor
		1406
		1407	Returns wether the cursor is currently hidden or not.
		1408
1131	=item $view_start = $term->view_start ([$newvalue])	1409	=item $view_start = $term->view_start ([$newvalue])
1132		1410
1133	Returns the negative row number of the topmost line. Minimum value is	1411	Returns the row number of the topmost displayed line. Maximum value is
1134	C<0>, which displays the normal terminal contents. Larger values scroll	1412	C<0>, which displays the normal terminal contents. Lower values scroll
1135	this many lines into the scrollback buffer.	1413	this many lines into the scrollback buffer.
1136		1414
1137	=item $term->want_refresh	1415	=item $term->want_refresh
1138		1416
1139	Requests a screen refresh. At the next opportunity, rxvt-unicode will	1417	Requests a screen refresh. At the next opportunity, rxvt-unicode will
…		…
1154	line, starting at column C<$start_col> (default C<0>), which is useful	1432	line, starting at column C<$start_col> (default C<0>), which is useful
1155	to replace only parts of a line. The font index in the rendition will	1433	to replace only parts of a line. The font index in the rendition will
1156	automatically be updated.	1434	automatically be updated.
1157		1435
1158	C<$text> is in a special encoding: tabs and wide characters that use more	1436	C<$text> is in a special encoding: tabs and wide characters that use more
1159	than one cell when displayed are padded with urxvt::NOCHAR characters	1437	than one cell when displayed are padded with C<$urxvt::NOCHAR> (chr 65535)
1160	(C<chr 65535>). Characters with combining characters and other characters	1438	characters. Characters with combining characters and other characters that
1161	that do not fit into the normal tetx encoding will be replaced with	1439	do not fit into the normal tetx encoding will be replaced with characters
1162	characters in the private use area.	1440	in the private use area.
1163		1441
1164	You have to obey this encoding when changing text. The advantage is	1442	You have to obey this encoding when changing text. The advantage is
1165	that C<substr> and similar functions work on screen cells and not on	1443	that C<substr> and similar functions work on screen cells and not on
1166	characters.	1444	characters.
1167		1445
…		…
1218	Return the row number of the first/last row of the line, respectively.	1496	Return the row number of the first/last row of the line, respectively.
1219		1497
1220	=item $offset = $line->offset_of ($row, $col)	1498	=item $offset = $line->offset_of ($row, $col)
1221		1499
1222	Returns the character offset of the given row\|col pair within the logical	1500	Returns the character offset of the given row\|col pair within the logical
1223	line.	1501	line. Works for rows outside the line, too, and returns corresponding
		1502	offsets outside the string.
1224		1503
1225	=item ($row, $col) = $line->coord_of ($offset)	1504	=item ($row, $col) = $line->coord_of ($offset)
1226		1505
1227	Translates a string offset into terminal coordinates again.	1506	Translates a string offset into terminal coordinates again.
1228		1507
…		…
1341		1620
1342	Calls XUngrab for the most recent grab. Is called automatically on	1621	Calls XUngrab for the most recent grab. Is called automatically on
1343	evaluation errors, as it is better to lose the grab in the error case as	1622	evaluation errors, as it is better to lose the grab in the error case as
1344	the session.	1623	the session.
1345		1624
		1625	=item $atom = $term->XInternAtom ($atom_name[, $only_if_exists])
		1626
		1627	=item $atom_name = $term->XGetAtomName ($atom)
		1628
		1629	=item @atoms = $term->XListProperties ($window)
		1630
		1631	=item ($type,$format,$octets) = $term->XGetWindowProperty ($window, $property)
		1632
		1633	=item $term->XChangeWindowProperty ($window, $property, $type, $format, $octets)
		1634
		1635	=item $term->XDeleteProperty ($window, $property)
		1636
		1637	=item $window = $term->DefaultRootWindow
		1638
		1639	=item $term->XReparentWindow ($window, $parent, [$x, $y])
		1640
		1641	=item $term->XMapWindow ($window)
		1642
		1643	=item $term->XUnmapWindow ($window)
		1644
		1645	=item $term->XMoveResizeWindow ($window, $x, $y, $width, $height)
		1646
		1647	=item ($x, $y, $child_window) = $term->XTranslateCoordinates ($src, $dst, $x, $y)
		1648
		1649	=item $term->XChangeInput ($window, $add_events[, $del_events])
		1650
		1651	Various X or X-related functions. The C<$term> object only serves as
		1652	the source of the display, otherwise those functions map more-or-less
		1653	directory onto the X functions of the same name.
		1654
1346	=back	1655	=back
1347		1656
1348	=cut	1657	=cut
1349		1658
1350	package urxvt::popup;	1659	package urxvt::popup;
…		…
1451	my $env = $self->{term}->env;	1760	my $env = $self->{term}->env;
1452	# we can't hope to reproduce the locale algorithm, so nuke LC_ALL and set LC_CTYPE.	1761	# we can't hope to reproduce the locale algorithm, so nuke LC_ALL and set LC_CTYPE.
1453	delete $env->{LC_ALL};	1762	delete $env->{LC_ALL};
1454	$env->{LC_CTYPE} = $self->{term}->locale;	1763	$env->{LC_CTYPE} = $self->{term}->locale;
1455		1764
1456	urxvt::term->new ($env, $self->{term}->resource ("name"),	1765	urxvt::term->new ($env, "popup",
1457	"--perl-lib" => "", "--perl-ext-common" => "", "-pty-fd" => -1, "-sl" => 0, "-b" => 0,	1766	"--perl-lib" => "", "--perl-ext-common" => "",
		1767	"-pty-fd" => -1, "-sl" => 0,
		1768	"-b" => 1, "-bd" => "grey80", "-bl", "-override-redirect",
1458	"--transient-for" => $self->{term}->parent,	1769	"--transient-for" => $self->{term}->parent,
1459	"-display" => $self->{term}->display_id,	1770	"-display" => $self->{term}->display_id,
1460	"-pe" => "urxvt-popup")	1771	"-pe" => "urxvt-popup")
1461	or die "unable to create popup window\n";	1772	or die "unable to create popup window\n";
1462	}	1773	}
…		…
1467	delete $self->{term}{_destroy}{$self};	1778	delete $self->{term}{_destroy}{$self};
1468	$self->{term}->ungrab;	1779	$self->{term}->ungrab;
1469	}	1780	}
1470		1781
1471	=back	1782	=back
		1783
		1784	=cut
		1785
		1786	package urxvt::watcher;
		1787
		1788	@urxvt::timer::ISA = __PACKAGE__;
		1789	@urxvt::iow::ISA = __PACKAGE__;
		1790	@urxvt::pw::ISA = __PACKAGE__;
		1791	@urxvt::iw::ISA = __PACKAGE__;
1472		1792
1473	=head2 The C<urxvt::timer> Class	1793	=head2 The C<urxvt::timer> Class
1474		1794
1475	This class implements timer watchers/events. Time is represented as a	1795	This class implements timer watchers/events. Time is represented as a
1476	fractional number of seconds since the epoch. Example:	1796	fractional number of seconds since the epoch. Example:
…		…
1514	Start the timer.	1834	Start the timer.
1515		1835
1516	=item $timer = $timer->start ($tstamp)	1836	=item $timer = $timer->start ($tstamp)
1517		1837
1518	Set the event trigger time to C<$tstamp> and start the timer.	1838	Set the event trigger time to C<$tstamp> and start the timer.
		1839
		1840	=item $timer = $timer->after ($delay)
		1841
		1842	Like C<start>, but sets the expiry timer to c<urxvt::NOW + $delay>.
1519		1843
1520	=item $timer = $timer->stop	1844	=item $timer = $timer->stop
1521		1845
1522	Stop the timer.	1846	Stop the timer.
1523		1847
…		…
1570		1894
1571	Stop watching for events on the given filehandle.	1895	Stop watching for events on the given filehandle.
1572		1896
1573	=back	1897	=back
1574		1898
		1899	=head2 The C<urxvt::iw> Class
		1900
		1901	This class implements idle watchers, that get called automatically when
		1902	the process is idle. They should return as fast as possible, after doing
		1903	some useful work.
		1904
		1905	=over 4
		1906
		1907	=item $iw = new urxvt::iw
		1908
		1909	Create a new idle watcher object in stopped state.
		1910
		1911	=item $iw = $iw->cb (sub { my ($iw) = @_; ... })
		1912
		1913	Set the callback to be called when the watcher triggers.
		1914
		1915	=item $timer = $timer->start
		1916
		1917	Start the watcher.
		1918
		1919	=item $timer = $timer->stop
		1920
		1921	Stop the watcher.
		1922
		1923	=back
		1924
		1925	=head2 The C<urxvt::pw> Class
		1926
		1927	This class implements process watchers. They create an event whenever a
		1928	process exits, after which they stop automatically.
		1929
		1930	my $pid = fork;
		1931	...
		1932	$term->{pw} = urxvt::pw
		1933	->new
		1934	->start ($pid)
		1935	->cb (sub {
		1936	my ($pw, $exit_status) = @_;
		1937	...
		1938	});
		1939
		1940	=over 4
		1941
		1942	=item $pw = new urxvt::pw
		1943
		1944	Create a new process watcher in stopped state.
		1945
		1946	=item $pw = $pw->cb (sub { my ($pw, $exit_status) = @_; ... })
		1947
		1948	Set the callback to be called when the timer triggers.
		1949
		1950	=item $pw = $timer->start ($pid)
		1951
		1952	Tells the wqtcher to start watching for process C<$pid>.
		1953
		1954	=item $pw = $pw->stop
		1955
		1956	Stop the watcher.
		1957
		1958	=back
		1959
1575	=head1 ENVIRONMENT	1960	=head1 ENVIRONMENT
1576		1961
1577	=head2 URXVT_PERL_VERBOSITY	1962	=head2 URXVT_PERL_VERBOSITY
1578		1963
1579	This variable controls the verbosity level of the perl extension. Higher	1964	This variable controls the verbosity level of the perl extension. Higher
…		…
1583		1968
1584	=item == 0 - fatal messages	1969	=item == 0 - fatal messages
1585		1970
1586	=item >= 3 - script loading and management	1971	=item >= 3 - script loading and management
1587		1972
1588	=item >=10 - all events received	1973	=item >=10 - all called hooks
		1974
		1975	=item >=11 - hook reutrn values
1589		1976
1590	=back	1977	=back
1591		1978
1592	=head1 AUTHOR	1979	=head1 AUTHOR
1593		1980

Diff Legend

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

Comparing rxvt-unicode/src/urxvt.pm (file contents): Revision 1.84 by root, Thu Jan 12 02:20:56 2006 UTC vs. Revision 1.127 by root, Wed Jan 25 00:42:21 2006 UTC

Diff Legend

Comparing rxvt-unicode/src/urxvt.pm (file contents):
Revision 1.84 by root, Thu Jan 12 02:20:56 2006 UTC vs.
Revision 1.127 by root, Wed Jan 25 00:42:21 2006 UTC