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

Comparing rxvt-unicode/src/urxvt.pm (file contents):
Revision 1.72 by root, Mon Jan 9 23:30:01 2006 UTC vs.
Revision 1.109 by root, Thu Jan 19 16:07:09 2006 UTC

…		…
26	thus must be encoded as UTF-8.	26	thus must be encoded as UTF-8.
27		27
28	Each script will only ever be loaded once, even in @@RXVT_NAME@@d, where	28	Each script will only ever be loaded once, even in @@RXVT_NAME@@d, where
29	scripts will be shared (but not enabled) for all terminals.	29	scripts will be shared (but not enabled) for all terminals.
30		30
31	=head2 Prepackaged Extensions	31	=head1 PREPACKAGED EXTENSIONS
32		32
33	This section describes the extensiosn delivered with this version. You can	33	This section describes the extensions delivered with this release. You can
34	find them in F<@@RXVT_LIBDIR@@/urxvt/perl/>.	34	find them in F<@@RXVT_LIBDIR@@/urxvt/perl/>.
35		35
36	You can activate them like this:	36	You can activate them like this:
37		37
38	@@RXVT_NAME@@ -pe <extensionname>	38	@@RXVT_NAME@@ -pe <extensionname>
39		39
40	=over 4	40	=over 4
41		41
42	=item selection (enabled by default)	42	=item selection (enabled by default)
43		43
44	Intelligent selection. This extension tries to be more intelligent when	44	(More) intelligent selection. This extension tries to be more intelligent
45	the user extends selections (double-click). Right now, it tries to select	45	when the user extends selections (double-click and further clicks). Right
46	urls and complete shell-quoted arguments, which is very convenient, too,	46	now, it tries to select words, urls and complete shell-quoted
47	if your F<ls> supports C<--quoting-style=shell>.	47	arguments, which is very convenient, too, if your F<ls> supports
		48	C<--quoting-style=shell>.
48		49
49	It also offers the following bindable event:	50	A double-click usually selects the word under the cursor, further clicks
		51	will enlarge the selection.
		52
		53	The selection works by trying to match a number of regexes and displaying
		54	them in increasing order of length. You can add your own regexes by
		55	specifying resources of the form:
		56
		57	URxvt.selection.pattern-0: perl-regex
		58	URxvt.selection.pattern-1: perl-regex
		59	...
		60
		61	The index number (0, 1...) must not have any holes, and each regex must
		62	contain at least one pair of capturing parentheses, which will be used for
		63	the match. For example, the followign adds a regex that matches everything
		64	between two vertical bars:
		65
		66	URxvt.selection.pattern-0: \\\|([^\|]+)\\\|
		67
		68	You can look at the source of the selection extension to see more
		69	interesting uses, such as parsing a line from beginning to end.
		70
		71	This extension also offers following bindable keyboard commands:
50		72
51	=over 4	73	=over 4
52		74
53	=item rot13	75	=item rot13
54		76
…		…
64	runtime.	86	runtime.
65		87
66	=item selection-popup (enabled by default)	88	=item selection-popup (enabled by default)
67		89
68	Binds a popup menu to Ctrl-Button3 that lets you convert the selection	90	Binds a popup menu to Ctrl-Button3 that lets you convert the selection
69	text into various other formats/action.	91	text into various other formats/action (such as uri unescaping, perl
		92	evalution, web-browser starting etc.), depending on content.
70		93
		94	Other extensions can extend this popup menu by pushing a code reference onto
		95	C<@urxvt::ext::selection_popup::hook>, that is called whenever the popup is displayed.
		96
		97	It's sole argument is the popup menu, which can be modified. The selection
		98	is in C<$_>, which can be used to decide wether to add something or not.
		99	It should either return nothing or a string and a code reference. The
		100	string will be used as button text and the code reference will be called
		101	when the button gets activated and should transform C<$_>.
		102
		103	The following will add an entry C<a to b> that transforms all C<a>s in
		104	the selection to C<b>s, but only if the selection currently contains any
		105	C<a>s:
		106
		107	push urxvt::ext::selection_popup::hook, sub {
		108	/a/ ? ("a to be" => sub { s/a/b/g }
		109	: ()
		110	};
		111
		112	Don't run it in a hook, otherwise the menu will grow and grow. Instead put
		113	it at the toplevel of your extension.
		114
71	=item searchable-scrollback (enabled by default)	115	=item searchable-scrollback<hotkey> (enabled by default)
72		116
73	Adds regex search functionality to the scrollback buffer, triggered by a	117	Adds regex search functionality to the scrollback buffer, triggered
74	hotkey (default: C<M-s>). When in search mode, terminal input/output is	118	by a hotkey (default: C<M-s>). While in search mode, normal terminal
75	suspended, C</> starts an incremental regex search, C<n> searches further,	119	input/output is suspended and a regex is displayed at the bottom of the
76	C<p> jumps to the previous match. C<enter> leaves search mode at the	120	screen.
77	current position and C<escape> returns to the original position.
78		121
79	=item digital-clock	122	Inputting characters appends them to the regex and continues incremental
		123	search. C<BackSpace> removes a character from the regex, C<Up> and C<Down>
		124	search upwards/downwards in the scrollback buffer, C<End> jumps to the
		125	bottom. C<Escape> leaves search mode and returns to the point where search
		126	was started, while C<Enter> or C<Return> stay at the current position and
		127	additionally stores the first match in the current line into the primary
		128	selection.
80		129
81	Displays a digital clock using the built-in overlay.	130	=item selection-autotransform
		131
		132	This selection allows you to do automatic transforms on a selection
		133	whenever a selection is made.
		134
		135	It works by specifying perl snippets (most useful is a single C<s///>
		136	operator) that modify C<$_> as resources:
		137
		138	URxvt.selection-autotransform.0: transform
		139	URxvt.selection-autotransform.1: transform
		140	...
		141
		142	For example, the following will transform selections of the form
		143	C<filename:number>, often seen in compiler messages, into C<vi +$filename
		144	$word>:
		145
		146	URxvt.selection-autotransform.0: s/^([^:[:space:]]+):(\\d+):?$/vi +$2 \\Q$1\\E\\x0d/
		147
		148	And this example matches the same,but replaces it with vi-commands you can
		149	paste directly into your (vi :) editor:
		150
		151	URxvt.selection-autotransform.0: s/^([^:[:space:]]+(\\d+):?$/:e \\Q$1\\E\\x0d:$2\\x0d/
		152
		153	Of course, this can be modified to suit your needs and your editor :)
		154
		155	To expand the example above to typical perl error messages ("XXX at
		156	FILENAME line YYY."), you need a slightly more elaborate solution:
		157
		158	URxvt.selection.pattern-0: ( at .*? line \\d+[,.])
		159	URxvt.selection-autotransform.0: s/^ at (.*?) line (\\d+)[,.]$/:e \\Q$1\E\\x0d:$2\\x0d/
		160
		161	The first line tells the selection code to treat the unchanging part of
		162	every error message as a selection pattern, and the second line transforms
		163	the message into vi commands to load the file.
82		164
83	=item mark-urls	165	=item mark-urls
84		166
85	Uses per-line display filtering (C<on_line_update>) to underline urls.	167	Uses per-line display filtering (C<on_line_update>) to underline urls and
		168	make them clickable. When middle-clicked, the program specified in the
		169	resource C<urlLauncher> (default C<x-www-browser>) will be started with
		170	the URL as first argument.
		171
		172	=item automove-background
		173
		174	This is basically a one-line extension that dynamically changes the background pixmap offset
		175	to the window position, in effect creating the same effect as pseudo transparency with
		176	a custom pixmap. No scaling is supported in this mode. Exmaple:
		177
		178	@@RXVT_NAME@@ -pixmap background.xpm -pe automove-background
86		179
87	=item block-graphics-to-ascii	180	=item block-graphics-to-ascii
88		181
89	A not very useful example of filtering all text output to the terminal,	182	A not very useful example of filtering all text output to the terminal,
90	by replacing all line-drawing characters (U+2500 .. U+259F) by a	183	by replacing all line-drawing characters (U+2500 .. U+259F) by a
91	similar-looking ascii character.	184	similar-looking ascii character.
92		185
		186	=item digital-clock
		187
		188	Displays a digital clock using the built-in overlay.
		189
93	=item example-refresh-hooks	190	=item example-refresh-hooks
94		191
95	Displays a very simple digital clock in the upper right corner of the	192	Displays a very simple digital clock in the upper right corner of the
96	window. Illustrates overwriting the refresh callbacks to create your own	193	window. Illustrates overwriting the refresh callbacks to create your own
97	overlays or changes.	194	overlays or changes.
98		195
		196	=item selection-pastebin
		197
		198	This is a little rarely useful extension that Uploads the selection as
		199	textfile to a remote site (or does other things). (The implementation is
		200	not currently secure for use in a multiuser environment as it writes to
		201	F</tmp> directly.).
		202
		203	It listens to the C<selection-pastebin:remote-pastebin> keyboard command,
		204	i.e.
		205
		206	URxvt.keysym.C-M-e: perl:selection-pastebin:remote-pastebin
		207
		208	Pressing this combination runs a command with C<%> replaced by the name of
		209	the textfile. This command can be set via a resource:
		210
		211	URxvt.selection-pastebin.cmd: rsync -apP % ruth:/var/www/www.ta-sa.org/files/txt/.
		212
		213	And the default is likely not useful to anybody but the few people around
		214	here :)
		215
		216	The name of the textfile is the hex encoded md5 sum of the selection, so
		217	the same content should lead to the same filename.
		218
		219	After a successful upload the selection will be replaced by the text given
		220	in the C<selection-pastebin-url> resource (again, the % is the placeholder
		221	for the filename):
		222
		223	URxvt.selection-pastebin.url: http://www.ta-sa.org/files/txt/%
		224
99	=back	225	=back
		226
		227	=head1 API DOCUMENTATION
100		228
101	=head2 General API Considerations	229	=head2 General API Considerations
102		230
103	All objects (such as terminals, time watchers etc.) are typical	231	All objects (such as terminals, time watchers etc.) are typical
104	reference-to-hash objects. The hash can be used to store anything you	232	reference-to-hash objects. The hash can be used to store anything you
…		…
117	=over 4	245	=over 4
118		246
119	=item $text	247	=item $text
120		248
121	Rxvt-unicodes special way of encoding text, where one "unicode" character	249	Rxvt-unicodes special way of encoding text, where one "unicode" character
122	always represents one screen cell. See L<row_t> for a discussion of this format.	250	always represents one screen cell. See L<ROW_t> for a discussion of this format.
123		251
124	=item $string	252	=item $string
125		253
126	A perl text string, with an emphasis on I<text>. It can store all unicode	254	A perl text string, with an emphasis on I<text>. It can store all unicode
127	characters and is to be distinguished with text encoded in a specific	255	characters and is to be distinguished with text encoded in a specific
…		…
200	=item on_start $term	328	=item on_start $term
201		329
202	Called at the very end of initialisation of a new terminal, just before	330	Called at the very end of initialisation of a new terminal, just before
203	returning to the mainloop.	331	returning to the mainloop.
204		332
		333	=item on_child_start $term, $pid
		334
		335	Called just after the child process has been C<fork>ed.
		336
		337	=item on_child_exit $term, $status
		338
		339	Called just after the child process has exited. C<$status> is the status
		340	from C<waitpid>.
		341
205	=item on_sel_make $term, $eventtime	342	=item on_sel_make $term, $eventtime
206		343
207	Called whenever a selection has been made by the user, but before the	344	Called whenever a selection has been made by the user, but before the
208	selection text is copied, so changes to the beginning, end or type of the	345	selection text is copied, so changes to the beginning, end or type of the
209	selection will be honored.	346	selection will be honored.
…		…
222	=item on_sel_extend $term	359	=item on_sel_extend $term
223		360
224	Called whenever the user tries to extend the selection (e.g. with a double	361	Called whenever the user tries to extend the selection (e.g. with a double
225	click) and is either supposed to return false (normal operation), or	362	click) and is either supposed to return false (normal operation), or
226	should extend the selection itelf and return true to suppress the built-in	363	should extend the selection itelf and return true to suppress the built-in
227	processing.	364	processing. This can happen multiple times, as long as the callback
		365	returns true, it will be called on every further click by the user and is
		366	supposed to enlarge the selection more and more, if possible.
228		367
229	See the F<selection> example extension.	368	See the F<selection> example extension.
230		369
231	=item on_view_change $term, $offset	370	=item on_view_change $term, $offset
232		371
…		…
299		438
300	Called whenever the user presses a key combination that has a	439	Called whenever the user presses a key combination that has a
301	C<perl:string> action bound to it (see description of the B<keysym>	440	C<perl:string> action bound to it (see description of the B<keysym>
302	resource in the @@RXVT_NAME@@(1) manpage).	441	resource in the @@RXVT_NAME@@(1) manpage).
303		442
		443	=item on_x_event $term, $event
		444
		445	Called on every X event received on the vt window (and possibly other
		446	windows). Should only be used as a last resort. Most event structure
		447	members are not passed.
		448
304	=item on_focus_in $term	449	=item on_focus_in $term
305		450
306	Called whenever the window gets the keyboard focus, before rxvt-unicode	451	Called whenever the window gets the keyboard focus, before rxvt-unicode
307	does focus in processing.	452	does focus in processing.
308		453
309	=item on_focus_out $term	454	=item on_focus_out $term
310		455
311	Called wheneever the window loses keyboard focus, before rxvt-unicode does	456	Called wheneever the window loses keyboard focus, before rxvt-unicode does
312	focus out processing.	457	focus out processing.
		458
		459	=item on_configure_notify $term, $event
313		460
314	=item on_key_press $term, $event, $keysym, $octets	461	=item on_key_press $term, $event, $keysym, $octets
315		462
316	=item on_key_release $term, $event, $keysym	463	=item on_key_release $term, $event, $keysym
317		464
…		…
334		481
335	C<on_key_press> additionally receives the string rxvt-unicode would	482	C<on_key_press> additionally receives the string rxvt-unicode would
336	output, if any, in locale-specific encoding.	483	output, if any, in locale-specific encoding.
337		484
338	subwindow.	485	subwindow.
339
340	=back
341
342	=head2 Variables in the C<urxvt> Package
343
344	=over 4
345
346	=item $urxvt::TERM
347
348	The current terminal. This variable stores the current C<urxvt::term>
349	object, whenever a callback/hook is executing.
350
351	=back
352
353	=head2 Functions in the C<urxvt> Package
354
355	=over 4
356
357	=item $term = new urxvt [arg...]
358
359	Creates a new terminal, very similar as if you had started it with
360	C<system $binfile, arg...>. Croaks (and probably outputs an error message)
361	if the new instance couldn't be created. Returns C<undef> if the new
362	instance didn't initialise perl, and the terminal object otherwise. The
363	C<init> and C<start> hooks will be called during the call.
364
365	=item urxvt::fatal $errormessage
366
367	Fatally aborts execution with the given error message. Avoid at all
368	costs! The only time this is acceptable is when the terminal process
369	starts up.
370
371	=item urxvt::warn $string
372
373	Calls C<rxvt_warn> with the given string which should not include a
374	newline. The module also overwrites the C<warn> builtin with a function
375	that calls this function.
376
377	Using this function has the advantage that its output ends up in the
378	correct place, e.g. on stderr of the connecting urxvtc client.
379
380	=item $is_safe = urxvt::safe
381
382	Returns true when it is safe to do potentially unsafe things, such as
383	evaluating perl code specified by the user. This is true when urxvt was
384	started setuid or setgid.
385
386	=item $time = urxvt::NOW
387
388	Returns the "current time" (as per the event loop).
389
390	=item urxvt::CurrentTime
391
392	=item urxvt::ShiftMask, LockMask, ControlMask, Mod1Mask, Mod2Mask,
393	Mod3Mask, Mod4Mask, Mod5Mask, Button1Mask, Button2Mask, Button3Mask,
394	Button4Mask, Button5Mask, AnyModifier
395
396	Various constants for use in X calls and event processing.
397
398	=back
399
400	=head2 RENDITION
401
402	Rendition bitsets contain information about colour, font, font styles and
403	similar information for each screen cell.
404
405	The following "macros" deal with changes in rendition sets. You should
406	never just create a bitset, you should always modify an existing one,
407	as they contain important information required for correct operation of
408	rxvt-unicode.
409
410	=over 4
411
412	=item $rend = urxvt::DEFAULT_RSTYLE
413
414	Returns the default rendition, as used when the terminal is starting up or
415	being reset. Useful as a base to start when creating renditions.
416
417	=item $rend = urxvt::OVERLAY_RSTYLE
418
419	Return the rendition mask used for overlays by default.
420
421	=item $rendbit = urxvt::RS_Bold, RS_Italic, RS_Blink, RS_RVid, RS_Uline
422
423	Return the bit that enabled bold, italic, blink, reverse-video and
424	underline, respectively. To enable such a style, just logically OR it into
425	the bitset.
426
427	=item $foreground = urxvt::GET_BASEFG $rend
428
429	=item $background = urxvt::GET_BASEBG $rend
430
431	Return the foreground/background colour index, respectively.
432
433	=item $rend = urxvt::SET_FGCOLOR ($rend, $new_colour)
434
435	=item $rend = urxvt::SET_BGCOLOR ($rend, $new_colour)
436
437	Replace the foreground/background colour in the rendition mask with the
438	specified one.
439
440	=item $value = urxvt::GET_CUSTOM ($rend)
441
442	Return the "custom" value: Every rendition has 5 bits for use by
443	extensions. They can be set and changed as you like and are initially
444	zero.
445
446	=item $rend = urxvt::SET_CUSTOM ($rend, $new_value)
447
448	Change the custom value.
449		486
450	=back	487	=back
451		488
452	=cut	489	=cut
453		490
…		…
462	our $VERSION = 1;	499	our $VERSION = 1;
463	our $TERM;	500	our $TERM;
464	our @HOOKNAME;	501	our @HOOKNAME;
465	our %HOOKTYPE = map +($HOOKNAME[$_] => $_), 0..$#HOOKNAME;	502	our %HOOKTYPE = map +($HOOKNAME[$_] => $_), 0..$#HOOKNAME;
466	our %OPTION;	503	our %OPTION;
		504
467	our $LIBDIR;	505	our $LIBDIR;
		506	our $RESNAME;
		507	our $RESCLASS;
		508	our $RXVTNAME;
		509
		510	=head2 Variables in the C<urxvt> Package
		511
		512	=over 4
		513
		514	=item $urxvt::LIBDIR
		515
		516	The rxvt-unicode library directory, where, among other things, the perl
		517	modules and scripts are stored.
		518
		519	=item $urxvt::RESCLASS, $urxvt::RESCLASS
		520
		521	The resource class and name rxvt-unicode uses to look up X resources.
		522
		523	=item $urxvt::RXVTNAME
		524
		525	The basename of the installed binaries, usually C<urxvt>.
		526
		527	=item $urxvt::TERM
		528
		529	The current terminal. This variable stores the current C<urxvt::term>
		530	object, whenever a callback/hook is executing.
		531
		532	=back
		533
		534	=head2 Functions in the C<urxvt> Package
		535
		536	=over 4
		537
		538	=item urxvt::fatal $errormessage
		539
		540	Fatally aborts execution with the given error message. Avoid at all
		541	costs! The only time this is acceptable is when the terminal process
		542	starts up.
		543
		544	=item urxvt::warn $string
		545
		546	Calls C<rxvt_warn> with the given string which should not include a
		547	newline. The module also overwrites the C<warn> builtin with a function
		548	that calls this function.
		549
		550	Using this function has the advantage that its output ends up in the
		551	correct place, e.g. on stderr of the connecting urxvtc client.
		552
		553	Messages have a size limit of 1023 bytes currently.
		554
		555	=item $time = urxvt::NOW
		556
		557	Returns the "current time" (as per the event loop).
		558
		559	=item urxvt::CurrentTime
		560
		561	=item urxvt::ShiftMask, LockMask, ControlMask, Mod1Mask, Mod2Mask,
		562	Mod3Mask, Mod4Mask, Mod5Mask, Button1Mask, Button2Mask, Button3Mask,
		563	Button4Mask, Button5Mask, AnyModifier
		564
		565	=item urxvt::NoEventMask, KeyPressMask, KeyReleaseMask,
		566	ButtonPressMask, ButtonReleaseMask, EnterWindowMask, LeaveWindowMask,
		567	PointerMotionMask, PointerMotionHintMask, Button1MotionMask, Button2MotionMask,
		568	Button3MotionMask, Button4MotionMask, Button5MotionMask, ButtonMotionMask,
		569	KeymapStateMask, ExposureMask, VisibilityChangeMask, StructureNotifyMask,
		570	ResizeRedirectMask, SubstructureNotifyMask, SubstructureRedirectMask,
		571	FocusChangeMask, PropertyChangeMask, ColormapChangeMask, OwnerGrabButtonMask
		572
		573	=item urxvt::KeyPress, KeyRelease, ButtonPress, ButtonRelease, MotionNotify,
		574	EnterNotify, LeaveNotify, FocusIn, FocusOut, KeymapNotify, Expose,
		575	GraphicsExpose, NoExpose, VisibilityNotify, CreateNotify, DestroyNotify,
		576	UnmapNotify, MapNotify, MapRequest, ReparentNotify, ConfigureNotify,
		577	ConfigureRequest, GravityNotify, ResizeRequest, CirculateNotify,
		578	CirculateRequest, PropertyNotify, SelectionClear, SelectionRequest,
		579	SelectionNotify, ColormapNotify, ClientMessage, MappingNotify
		580
		581	Various constants for use in X calls and event processing.
		582
		583	=back
		584
		585	=head2 RENDITION
		586
		587	Rendition bitsets contain information about colour, font, font styles and
		588	similar information for each screen cell.
		589
		590	The following "macros" deal with changes in rendition sets. You should
		591	never just create a bitset, you should always modify an existing one,
		592	as they contain important information required for correct operation of
		593	rxvt-unicode.
		594
		595	=over 4
		596
		597	=item $rend = urxvt::DEFAULT_RSTYLE
		598
		599	Returns the default rendition, as used when the terminal is starting up or
		600	being reset. Useful as a base to start when creating renditions.
		601
		602	=item $rend = urxvt::OVERLAY_RSTYLE
		603
		604	Return the rendition mask used for overlays by default.
		605
		606	=item $rendbit = urxvt::RS_Bold, RS_Italic, RS_Blink, RS_RVid, RS_Uline
		607
		608	Return the bit that enabled bold, italic, blink, reverse-video and
		609	underline, respectively. To enable such a style, just logically OR it into
		610	the bitset.
		611
		612	=item $foreground = urxvt::GET_BASEFG $rend
		613
		614	=item $background = urxvt::GET_BASEBG $rend
		615
		616	Return the foreground/background colour index, respectively.
		617
		618	=item $rend = urxvt::SET_FGCOLOR $rend, $new_colour
		619
		620	=item $rend = urxvt::SET_BGCOLOR $rend, $new_colour
		621
		622	Replace the foreground/background colour in the rendition mask with the
		623	specified one.
		624
		625	=item $value = urxvt::GET_CUSTOM $rend
		626
		627	Return the "custom" value: Every rendition has 5 bits for use by
		628	extensions. They can be set and changed as you like and are initially
		629	zero.
		630
		631	=item $rend = urxvt::SET_CUSTOM $rend, $new_value
		632
		633	Change the custom value.
		634
		635	=back
		636
		637	=cut
468		638
469	BEGIN {	639	BEGIN {
470	urxvt->bootstrap;
471
472	# overwrite perl's warn	640	# overwrite perl's warn
473	*CORE::GLOBAL::warn = sub {	641	*CORE::GLOBAL::warn = sub {
474	my $msg = join "", @_;	642	my $msg = join "", @_;
475	$msg .= "\n"	643	$msg .= "\n"
476	unless $msg =~ /\n$/;	644	unless $msg =~ /\n$/;
477	urxvt::warn ($msg);	645	urxvt::warn ($msg);
478	};	646	};
479
480	delete $ENV{IFS};
481	delete $ENV{CDPATH};
482	delete $ENV{BASH_ENV};
483	$ENV{PATH} = "/bin:/sbin:/usr/bin:/usr/sbin:/usr/local/bin:/usr/local/sbin:/opt/bin:/opt/sbin";
484	}	647	}
485		648
486	my @hook_count;
487	my $verbosity = $ENV{URXVT_PERL_VERBOSITY};	649	my $verbosity = $ENV{URXVT_PERL_VERBOSITY};
488		650
489	sub verbose {	651	sub verbose {
490	my ($level, $msg) = @_;	652	my ($level, $msg) = @_;
491	warn "$msg\n" if $level <= $verbosity;	653	warn "$msg\n" if $level <= $verbosity;
492	}	654	}
493		655
494	my $extension_pkg = "extension0000";
495	my %extension_pkg;	656	my %extension_pkg;
496		657
497	# load a single script into its own package, once only	658	# load a single script into its own package, once only
498	sub extension_package($) {	659	sub extension_package($) {
499	my ($path) = @_;	660	my ($path) = @_;
500		661
		662	no strict 'refs';
		663
501	$extension_pkg{$path} \|\|= do {	664	$extension_pkg{$path} \|\|= do {
502	my $pkg = "urxvt::" . ($extension_pkg++);	665	$path =~ /([^\/\\]+)$/;
		666	my $pkg = $1;
		667	$pkg =~ s/[^[:word:]]/_/g;
		668	$pkg = "urxvt::ext::$pkg";
503		669
504	verbose 3, "loading extension '$path' into package '$pkg'";	670	verbose 3, "loading extension '$path' into package '$pkg'";
505		671
506	open my $fh, "<:raw", $path	672	open my $fh, "<:raw", $path
507	or die "$path: $!";	673	or die "$path: $!";
508		674
		675	@{"$pkg\::ISA"} = urxvt::term::extension::;
		676
509	my $source = untaint	677	my $source =
510	"package $pkg; use strict; use utf8;\n"	678	"package $pkg; use strict; use utf8;\n"
511	. "use base urxvt::term::extension::;\n"
512	. "#line 1 \"$path\"\n{\n"	679	. "#line 1 \"$path\"\n{\n"
513	. (do { local $/; <$fh> })	680	. (do { local $/; <$fh> })
514	. "\n};\n1";	681	. "\n};\n1";
515		682
516	eval $source	683	eval $source
…		…
573	if ($@) {	740	if ($@) {
574	$TERM->ungrab; # better to lose the grab than the session	741	$TERM->ungrab; # better to lose the grab than the session
575	warn $@;	742	warn $@;
576	}	743	}
577	}	744	}
		745
		746	verbose 11, "$HOOKNAME[$htype] returning <$retval>"
		747	if $verbosity >= 11;
578	}	748	}
579		749
580	if ($htype == 1) { # DESTROY	750	if ($htype == 1) { # DESTROY
581	if (my $hook = delete $TERM->{_hook}) {
582	for my $htype (0..$#$hook) {
583	$hook_count[$htype] -= scalar keys %{ $hook->[$htype] \|\| {} }
584	or set_should_invoke $htype, 0;
585	}
586	}
587
588	# clear package objects	751	# clear package objects
589	%$_ = () for values %{ $TERM->{_pkg} };	752	%$_ = () for values %{ $TERM->{_pkg} };
590		753
591	# clear package	754	# clear package
592	%$TERM = ();	755	%$TERM = ();
…		…
606	while (my ($name, $cb) = each %hook) {	769	while (my ($name, $cb) = each %hook) {
607	my $htype = $HOOKTYPE{uc $name};	770	my $htype = $HOOKTYPE{uc $name};
608	defined $htype	771	defined $htype
609	or Carp::croak "unsupported hook type '$name'";	772	or Carp::croak "unsupported hook type '$name'";
610		773
		774	$self->set_should_invoke ($htype, +1)
611	unless (exists $self->{term}{_hook}[$htype]{$pkg}) {	775	unless exists $self->{term}{_hook}[$htype]{$pkg};
612	$hook_count[$htype]++
613	or urxvt::set_should_invoke $htype, 1;
614	}
615		776
616	$self->{term}{_hook}[$htype]{$pkg} = $cb;	777	$self->{term}{_hook}[$htype]{$pkg} = $cb;
617	}	778	}
618	}	779	}
619		780
…		…
624	for my $name (@hook) {	785	for my $name (@hook) {
625	my $htype = $HOOKTYPE{uc $name};	786	my $htype = $HOOKTYPE{uc $name};
626	defined $htype	787	defined $htype
627	or Carp::croak "unsupported hook type '$name'";	788	or Carp::croak "unsupported hook type '$name'";
628		789
		790	$self->set_should_invoke ($htype, -1)
629	if (delete $self->{term}{_hook}[$htype]{$pkg}) {	791	if delete $self->{term}{_hook}[$htype]{$pkg};
630	--$hook_count[$htype]
631	or urxvt::set_should_invoke $htype, 0;
632	}
633	}	792	}
634	}	793	}
635		794
636	our $AUTOLOAD;	795	our $AUTOLOAD;
637		796
…		…
668		827
669	=head2 The C<urxvt::anyevent> Class	828	=head2 The C<urxvt::anyevent> Class
670		829
671	The sole purpose of this class is to deliver an interface to the	830	The sole purpose of this class is to deliver an interface to the
672	C<AnyEvent> module - any module using it will work inside urxvt without	831	C<AnyEvent> module - any module using it will work inside urxvt without
673	further work. The only exception is that you cannot wait on condition	832	further programming. The only exception is that you cannot wait on
674	variables, but non-blocking condvar use is ok. What this means is that you	833	condition variables, but non-blocking condvar use is ok. What this means
675	cannot use blocking APIs, but the non-blocking variant should work.	834	is that you cannot use blocking APIs, but the non-blocking variant should
		835	work.
676		836
677	=cut	837	=cut
678		838
679	our $VERSION = 1;	839	our $VERSION = 1;
680		840
…		…
757	$proxy->enable ($name => $ref);	917	$proxy->enable ($name => $ref);
758	}	918	}
759	}	919	}
760	}	920	}
761		921
		922	=item $term = new urxvt::term $envhashref, $rxvtname, [arg...]
		923
		924	Creates a new terminal, very similar as if you had started it with system
		925	C<$rxvtname, arg...>. C<$envhashref> must be a reference to a C<%ENV>-like
		926	hash which defines the environment of the new terminal.
		927
		928	Croaks (and probably outputs an error message) if the new instance
		929	couldn't be created. Returns C<undef> if the new instance didn't
		930	initialise perl, and the terminal object otherwise. The C<init> and
		931	C<start> hooks will be called during this call.
		932
		933	=cut
		934
		935	sub new {
		936	my ($class, $env, @args) = @_;
		937
		938	_new ([ map "$_=$env->{$_}", keys %$env ], @args);
		939	}
		940
762	=item $term->destroy	941	=item $term->destroy
763		942
764	Destroy the terminal object (close the window, free resources etc.).	943	Destroy the terminal object (close the window, free resources
		944	etc.). Please note that @@RXVT_NAME@@ will not exit as long as any event
		945	watchers (timers, io watchers) are still active.
		946
		947	=item $term->exec_async ($cmd[, @args])
		948
		949	Works like the combination of the C<fork>/C<exec> builtins, which executes
		950	("starts") programs in the background. This function takes care of setting
		951	the user environment before exec'ing the command (e.g. C<PATH>) and should
		952	be preferred over explicit calls to C<exec> or C<system>.
		953
		954	Returns the pid of the subprocess or C<undef> on error.
		955
		956	=cut
		957
		958	sub exec_async {
		959	my $self = shift;
		960
		961	my $pid = fork;
		962
		963	return $pid
		964	if !defined $pid or $pid;
		965
		966	%ENV = %{ $self->env };
		967
		968	exec @_;
		969	urxvt::_exit 255;
		970	}
765		971
766	=item $isset = $term->option ($optval[, $set])	972	=item $isset = $term->option ($optval[, $set])
767		973
768	Returns true if the option specified by C<$optval> is enabled, and	974	Returns true if the option specified by C<$optval> is enabled, and
769	optionally change it. All option values are stored by name in the hash	975	optionally change it. All option values are stored by name in the hash
…		…
772	Here is a a likely non-exhaustive list of option names, please see the	978	Here is a a likely non-exhaustive list of option names, please see the
773	source file F</src/optinc.h> to see the actual list:	979	source file F</src/optinc.h> to see the actual list:
774		980
775	borderLess console cursorBlink cursorUnderline hold iconic insecure	981	borderLess console cursorBlink cursorUnderline hold iconic insecure
776	intensityStyles jumpScroll loginShell mapAlert meta8 mouseWheelScrollPage	982	intensityStyles jumpScroll loginShell mapAlert meta8 mouseWheelScrollPage
777	pastableTabs pointerBlank reverseVideo scrollBar scrollBar_floating	983	override-redirect pastableTabs pointerBlank reverseVideo scrollBar
778	scrollBar_right scrollTtyKeypress scrollTtyOutput scrollWithBuffer	984	scrollBar_floating scrollBar_right scrollTtyKeypress scrollTtyOutput
779	secondaryScreen secondaryScroll skipBuiltinGlyphs transparent	985	scrollWithBuffer secondaryScreen secondaryScroll skipBuiltinGlyphs
780	tripleclickwords utmpInhibit visualBell	986	transparent tripleclickwords utmpInhibit visualBell
781		987
782	=item $value = $term->resource ($name[, $newval])	988	=item $value = $term->resource ($name[, $newval])
783		989
784	Returns the current resource value associated with a given name and	990	Returns the current resource value associated with a given name and
785	optionally sets a new value. Setting values is most useful in the C<init>	991	optionally sets a new value. Setting values is most useful in the C<init>
…		…
802		1008
803	answerbackstring backgroundPixmap backspace_key boldFont boldItalicFont	1009	answerbackstring backgroundPixmap backspace_key boldFont boldItalicFont
804	borderLess color cursorBlink cursorUnderline cutchars delete_key	1010	borderLess color cursorBlink cursorUnderline cutchars delete_key
805	display_name embed ext_bwidth fade font geometry hold iconName	1011	display_name embed ext_bwidth fade font geometry hold iconName
806	imFont imLocale inputMethod insecure int_bwidth intensityStyles	1012	imFont imLocale inputMethod insecure int_bwidth intensityStyles
807	italicFont jumpScroll lineSpace loginShell mapAlert menu meta8 modifier	1013	italicFont jumpScroll lineSpace loginShell mapAlert meta8 modifier
808	mouseWheelScrollPage name pastableTabs path perl_eval perl_ext_1 perl_ext_2	1014	mouseWheelScrollPage name override_redirect pastableTabs path perl_eval
809	perl_lib pointerBlank pointerBlankDelay preeditType print_pipe pty_fd	1015	perl_ext_1 perl_ext_2 perl_lib pointerBlank pointerBlankDelay
810	reverseVideo saveLines scrollBar scrollBar_align scrollBar_floating	1016	preeditType print_pipe pty_fd reverseVideo saveLines scrollBar
811	scrollBar_right scrollBar_thickness scrollTtyKeypress scrollTtyOutput	1017	scrollBar_align scrollBar_floating scrollBar_right scrollBar_thickness
812	scrollWithBuffer scrollstyle secondaryScreen secondaryScroll selectstyle	1018	scrollTtyKeypress scrollTtyOutput scrollWithBuffer scrollstyle
813	shade term_name title transparent transparent_all tripleclickwords	1019	secondaryScreen secondaryScroll selectstyle shade term_name title
814	utmpInhibit visualBell	1020	transient_for transparent transparent_all tripleclickwords utmpInhibit
		1021	visualBell
815		1022
816	=cut	1023	=cut
817		1024
818	sub resource($$;$) {	1025	sub resource($$;$) {
819	my ($self, $name) = (shift, shift);	1026	my ($self, $name) = (shift, shift);
820	unshift @_, $self, $name, ($name =~ s/\s\+\s(\d+)$// ? $1 : 0);	1027	unshift @_, $self, $name, ($name =~ s/\s\+\s(\d+)$// ? $1 : 0);
821	&urxvt::term::_resource	1028	&urxvt::term::_resource
822	}	1029	}
823		1030
		1031	=item $value = $term->x_resource ($pattern)
		1032
		1033	Returns the X-Resource for the given pattern, excluding the program or
		1034	class name, i.e. C<< $term->x_resource ("boldFont") >> should return the
		1035	same value as used by this instance of rxvt-unicode. Returns C<undef> if no
		1036	resource with that pattern exists.
		1037
		1038	This method should only be called during the C<on_start> hook, as there is
		1039	only one resource database per display, and later invocations might return
		1040	the wrong resources.
		1041
824	=item $success = $term->parse_keysym ($keysym_spec, $command_string)	1042	=item $success = $term->parse_keysym ($keysym_spec, $command_string)
825		1043
826	Adds a keymap translation exactly as specified via a resource. See the	1044	Adds a keymap translation exactly as specified via a resource. See the
827	C<keysym> resource in the @@RXVT_NAME@@(1) manpage.	1045	C<keysym> resource in the @@RXVT_NAME@@(1) manpage.
828		1046
…		…
843	=item ($row, $col) = $term->selection_end ([$row, $col])	1061	=item ($row, $col) = $term->selection_end ([$row, $col])
844		1062
845	Return the current values of the selection mark, begin or end positions,	1063	Return the current values of the selection mark, begin or end positions,
846	and optionally set them to new values.	1064	and optionally set them to new values.
847		1065
		1066	=item $term->selection_make ($eventtime[, $rectangular])
		1067
		1068	Tries to make a selection as set by C<selection_beg> and
		1069	C<selection_end>. If C<$rectangular> is true (default: false), a
		1070	rectangular selection will be made. This is the prefered function to make
		1071	a selection.
		1072
848	=item $success = $term->selection_grab ($eventtime)	1073	=item $success = $term->selection_grab ($eventtime)
849		1074
850	Try to request the primary selection from the server (for example, as set	1075	Try to request the primary selection text from the server (for example, as
851	by the next method).	1076	set by the next method). No visual feedback will be given. This function
		1077	is mostly useful from within C<on_sel_grab> hooks.
852		1078
853	=item $oldtext = $term->selection ([$newtext])	1079	=item $oldtext = $term->selection ([$newtext])
854		1080
855	Return the current selection text and optionally replace it by C<$newtext>.	1081	Return the current selection text and optionally replace it by C<$newtext>.
856		1082
…		…
949	Convert the given locale-encoded octets into a perl string.	1175	Convert the given locale-encoded octets into a perl string.
950		1176
951	=item $term->scr_xor_span ($beg_row, $beg_col, $end_row, $end_col[, $rstyle])	1177	=item $term->scr_xor_span ($beg_row, $beg_col, $end_row, $end_col[, $rstyle])
952		1178
953	XORs the rendition values in the given span with the provided value	1179	XORs the rendition values in the given span with the provided value
954	(default: C<RS_RVid>). Useful in refresh hooks to provide effects similar	1180	(default: C<RS_RVid>), which I<MUST NOT> contain font styles. Useful in
955	to the selection.	1181	refresh hooks to provide effects similar to the selection.
956		1182
957	=item $term->scr_xor_rect ($beg_row, $beg_col, $end_row, $end_col[, $rstyle1[, $rstyle2]])	1183	=item $term->scr_xor_rect ($beg_row, $beg_col, $end_row, $end_col[, $rstyle1[, $rstyle2]])
958		1184
959	Similar to C<scr_xor_span>, but xors a rectangle instead. Trailing	1185	Similar to C<scr_xor_span>, but xors a rectangle instead. Trailing
960	whitespace will additionally be xored with the C<$rstyle2>, which defaults	1186	whitespace will additionally be xored with the C<$rstyle2>, which defaults
961	to C<RS_RVid \| RS_Uline>, which removes reverse video again and underlines	1187	to C<RS_RVid \| RS_Uline>, which removes reverse video again and underlines
962	it instead.	1188	it instead. Both styles I<MUST NOT> contain font styles.
963		1189
964	=item $term->scr_bell	1190	=item $term->scr_bell
965		1191
966	Ring the bell!	1192	Ring the bell!
967		1193
…		…
1001		1227
1002	=item $windowid = $term->vt	1228	=item $windowid = $term->vt
1003		1229
1004	Return the window id of the terminal window.	1230	Return the window id of the terminal window.
1005		1231
		1232	=item $term->vt_emask_add ($x_event_mask)
		1233
		1234	Adds the specified events to the vt event mask. Useful e.g. when you want
		1235	to receive pointer events all the times:
		1236
		1237	$term->vt_emask_add (urxvt::PointerMotionMask);
		1238
1006	=item $window_width = $term->width	1239	=item $window_width = $term->width
1007		1240
1008	=item $window_height = $term->height	1241	=item $window_height = $term->height
1009		1242
1010	=item $font_width = $term->fwidth	1243	=item $font_width = $term->fwidth
…		…
1023		1256
1024	=item $max_scrollback = $term->saveLines	1257	=item $max_scrollback = $term->saveLines
1025		1258
1026	=item $nrow_plus_saveLines = $term->total_rows	1259	=item $nrow_plus_saveLines = $term->total_rows
1027		1260
1028	=item $lines_in_scrollback = $term->nsaved	1261	=item $topmost_scrollback_row = $term->top_row
1029		1262
1030	Return various integers describing terminal characteristics.	1263	Return various integers describing terminal characteristics.
1031		1264
		1265	=item $x_display = $term->display_id
		1266
		1267	Return the DISPLAY used by rxvt-unicode.
		1268
1032	=item $lc_ctype = $term->locale	1269	=item $lc_ctype = $term->locale
1033		1270
1034	Returns the LC_CTYPE category string used by this rxvt-unicode.	1271	Returns the LC_CTYPE category string used by this rxvt-unicode.
1035		1272
1036	=item $x_display = $term->display_id	1273	=item $env = $term->env
1037		1274
1038	Return the DISPLAY used by rxvt-unicode.	1275	Returns a copy of the environment in effect for the terminal as a hashref
		1276	similar to C<\%ENV>.
		1277
		1278	=cut
		1279
		1280	sub env {
		1281	if (my $env = $_[0]->_env) {
		1282	+{ map /^([^=]+)(?:=(.*))?$/s && ($1 => $2), @$env }
		1283	} else {
		1284	+{ %ENV }
		1285	}
		1286	}
1039		1287
1040	=item $modifiermask = $term->ModLevel3Mask	1288	=item $modifiermask = $term->ModLevel3Mask
1041		1289
1042	=item $modifiermask = $term->ModMetaMask	1290	=item $modifiermask = $term->ModMetaMask
1043		1291
…		…
1046	Return the modifier masks corresponding to the "ISO Level 3 Shift" (often	1294	Return the modifier masks corresponding to the "ISO Level 3 Shift" (often
1047	AltGr), the meta key (often Alt) and the num lock key, if applicable.	1295	AltGr), the meta key (often Alt) and the num lock key, if applicable.
1048		1296
1049	=item $view_start = $term->view_start ([$newvalue])	1297	=item $view_start = $term->view_start ([$newvalue])
1050		1298
1051	Returns the negative row number of the topmost line. Minimum value is	1299	Returns the row number of the topmost displayed line. Maximum value is
1052	C<0>, which displays the normal terminal contents. Larger values scroll	1300	C<0>, which displays the normal terminal contents. Lower values scroll
1053	this many lines into the scrollback buffer.	1301	this many lines into the scrollback buffer.
1054		1302
1055	=item $term->want_refresh	1303	=item $term->want_refresh
1056		1304
1057	Requests a screen refresh. At the next opportunity, rxvt-unicode will	1305	Requests a screen refresh. At the next opportunity, rxvt-unicode will
…		…
1136	Return the row number of the first/last row of the line, respectively.	1384	Return the row number of the first/last row of the line, respectively.
1137		1385
1138	=item $offset = $line->offset_of ($row, $col)	1386	=item $offset = $line->offset_of ($row, $col)
1139		1387
1140	Returns the character offset of the given row\|col pair within the logical	1388	Returns the character offset of the given row\|col pair within the logical
1141	line.	1389	line. Works for rows outside the line, too, and returns corresponding
		1390	offsets outside the string.
1142		1391
1143	=item ($row, $col) = $line->coord_of ($offset)	1392	=item ($row, $col) = $line->coord_of ($offset)
1144		1393
1145	Translates a string offset into terminal coordinates again.	1394	Translates a string offset into terminal coordinates again.
1146		1395
…		…
1283	$item->{render} \|\|= sub { $_[0]{text} };	1532	$item->{render} \|\|= sub { $_[0]{text} };
1284		1533
1285	push @{ $self->{item} }, $item;	1534	push @{ $self->{item} }, $item;
1286	}	1535	}
1287		1536
		1537	=item $popup->add_title ($title)
		1538
		1539	Adds a non-clickable title to the popup.
		1540
		1541	=cut
		1542
		1543	sub add_title {
		1544	my ($self, $title) = @_;
		1545
		1546	$self->add_item ({
		1547	rend => { normal => "\x1b[38;5;11;44m", hover => "\x1b[38;5;11;44m", active => "\x1b[38;5;11;44m" },
		1548	text => $title,
		1549	activate => sub { },
		1550	});
		1551	}
		1552
		1553	=item $popup->add_separator ([$sepchr])
		1554
		1555	Creates a separator, optionally using the character given as C<$sepchr>.
		1556
		1557	=cut
		1558
1288	sub add_separator {	1559	sub add_separator {
1289	my ($self, $sep) = @_;	1560	my ($self, $sep) = @_;
1290		1561
1291	$sep \|\|= "=";	1562	$sep \|\|= "=";
1292		1563
…		…
1296	render => sub { $sep x $self->{term}->ncol },	1567	render => sub { $sep x $self->{term}->ncol },
1297	activate => sub { },	1568	activate => sub { },
1298	});	1569	});
1299	}	1570	}
1300		1571
1301	sub add_title {	1572	=item $popup->add_button ($text, $cb)
1302	my ($self, $title) = @_;
1303		1573
1304	$self->add_item ({	1574	Adds a clickable button to the popup. C<$cb> is called whenever it is
1305	rend => { normal => "\x1b[38;5;11;44m", hover => "\x1b[38;5;11;44m", active => "\x1b[38;5;11;44m" },	1575	selected.
1306	text => $title,	1576
1307	activate => sub { },	1577	=cut
1308	});
1309	}
1310		1578
1311	sub add_button {	1579	sub add_button {
1312	my ($self, $text, $cb) = @_;	1580	my ($self, $text, $cb) = @_;
1313		1581
1314	$self->add_item ({ type => "button", text => $text, activate => $cb});	1582	$self->add_item ({ type => "button", text => $text, activate => $cb});
1315	}	1583	}
		1584
		1585	=item $popup->add_toggle ($text, $cb, $initial_value)
		1586
		1587	Adds a toggle/checkbox item to the popup. Teh callback gets called
		1588	whenever it gets toggled, with a boolean indicating its value as its first
		1589	argument.
		1590
		1591	=cut
1316		1592
1317	sub add_toggle {	1593	sub add_toggle {
1318	my ($self, $text, $cb, $value) = @_;	1594	my ($self, $text, $cb, $value) = @_;
1319		1595
1320	my $item; $item = {	1596	my $item; $item = {
1321	type => "button",	1597	type => "button",
1322	text => " $text",	1598	text => " $text",
1323	value => $value,	1599	value => $value,
1324	render => sub { ($_[0]{value} ? "* " : " ") . $text },	1600	render => sub { ($_[0]{value} ? "* " : " ") . $text },
1325	activate => sub { $cb->($_[0]{value} = !$_[0]{value}); },	1601	activate => sub { $cb->($_[1]{value} = !$_[1]{value}); },
1326	};	1602	};
1327		1603
1328	$self->add_item ($item);	1604	$self->add_item ($item);
1329	}	1605	}
		1606
		1607	=item $popup->show
		1608
		1609	Displays the popup (which is initially hidden).
		1610
		1611	=cut
1330		1612
1331	sub show {	1613	sub show {
1332	my ($self) = @_;	1614	my ($self) = @_;
1333		1615
1334	local $urxvt::popup::self = $self;	1616	local $urxvt::popup::self = $self;
1335		1617
		1618	my $env = $self->{term}->env;
		1619	# we can't hope to reproduce the locale algorithm, so nuke LC_ALL and set LC_CTYPE.
		1620	delete $env->{LC_ALL};
1336	local $ENV{LC_ALL} = $self->{term}->locale;	1621	$env->{LC_CTYPE} = $self->{term}->locale;
1337		1622
1338	urxvt->new ("--perl-lib" => "", "--perl-ext-common" => "", "-pty-fd" => -1, "-sl" => 0, "-b" => 0,	1623	urxvt::term->new ($env, "popup",
		1624	"--perl-lib" => "", "--perl-ext-common" => "",
		1625	"-pty-fd" => -1, "-sl" => 0,
		1626	"-b" => 1, "-bd" => "grey80", "-bl", "-override-redirect",
1339	"--transient-for" => $self->{term}->parent,	1627	"--transient-for" => $self->{term}->parent,
1340	"-display" => $self->{term}->display_id,	1628	"-display" => $self->{term}->display_id,
1341	"-pe" => "urxvt-popup")	1629	"-pe" => "urxvt-popup")
1342	or die "unable to create popup window\n";	1630	or die "unable to create popup window\n";
1343	}	1631	}
1344		1632
1345	sub DESTROY {	1633	sub DESTROY {
1346	my ($self) = @_;	1634	my ($self) = @_;
1347		1635
1348	delete $self->{term}{_destroy}{$self};	1636	delete $self->{term}{_destroy}{$self};
1349	$self->{term}->ungrab;	1637	$self->{term}->ungrab;
1350	}	1638	}
		1639
		1640	=back
1351		1641
1352	=head2 The C<urxvt::timer> Class	1642	=head2 The C<urxvt::timer> Class
1353		1643
1354	This class implements timer watchers/events. Time is represented as a	1644	This class implements timer watchers/events. Time is represented as a
1355	fractional number of seconds since the epoch. Example:	1645	fractional number of seconds since the epoch. Example:
…		…
1393	Start the timer.	1683	Start the timer.
1394		1684
1395	=item $timer = $timer->start ($tstamp)	1685	=item $timer = $timer->start ($tstamp)
1396		1686
1397	Set the event trigger time to C<$tstamp> and start the timer.	1687	Set the event trigger time to C<$tstamp> and start the timer.
		1688
		1689	=item $timer = $timer->after ($delay)
		1690
		1691	Like C<start>, but sets the expiry timer to c<urxvt::NOW + $delay>.
1398		1692
1399	=item $timer = $timer->stop	1693	=item $timer = $timer->stop
1400		1694
1401	Stop the timer.	1695	Stop the timer.
1402		1696
…		…
1462		1756
1463	=item == 0 - fatal messages	1757	=item == 0 - fatal messages
1464		1758
1465	=item >= 3 - script loading and management	1759	=item >= 3 - script loading and management
1466		1760
1467	=item >=10 - all events received	1761	=item >=10 - all called hooks
		1762
		1763	=item >=11 - hook reutrn values
1468		1764
1469	=back	1765	=back
1470		1766
1471	=head1 AUTHOR	1767	=head1 AUTHOR
1472		1768

Diff Legend

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

Comparing rxvt-unicode/src/urxvt.pm (file contents): Revision 1.72 by root, Mon Jan 9 23:30:01 2006 UTC vs. Revision 1.109 by root, Thu Jan 19 16:07:09 2006 UTC

Diff Legend

Comparing rxvt-unicode/src/urxvt.pm (file contents):
Revision 1.72 by root, Mon Jan 9 23:30:01 2006 UTC vs.
Revision 1.109 by root, Thu Jan 19 16:07:09 2006 UTC