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

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.110 by root, Thu Jan 19 16:22:13 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.110 by root, Thu Jan 19 16:22:13 2006 UTC