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

Comparing rxvt-unicode/src/urxvt.pm (file contents):
Revision 1.15 by root, Tue Jan 3 01:39:17 2006 UTC vs.
Revision 1.28 by root, Wed Jan 4 00:09:12 2006 UTC

…		…
		1	=encoding utf8
		2
1	=head1 NAME	3	=head1 NAME
2		4
3	@@RXVT_NAME@@perl - rxvt-unicode's embedded perl interpreter	5	@@RXVT_NAME@@perl - rxvt-unicode's embedded perl interpreter
4		6
5	=head1 SYNOPSIS	7	=head1 SYNOPSIS
22		24
23	Scripts are compiled in a 'use strict' and 'use utf8' environment, and	25	Scripts are compiled in a 'use strict' and 'use utf8' environment, and
24	thus must be encoded as UTF-8.	26	thus must be encoded as UTF-8.
25		27
26	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
27	scripts will be shared (But not enabled) for all terminals.	29	scripts will be shared (but not enabled) for all terminals.
28		30
29	=head1 PACKAGED EXTENSIONS	31	=head2 Prepackaged Extensions
30		32
31	This section describes the extensiosn delivered with this version. You can	33	This section describes the extensiosn delivered with this version. You can
32	find them in F<@@RXVT_LIBDIR@@/urxvt/perl/>.	34	find them in F<@@RXVT_LIBDIR@@/urxvt/perl/>.
33		35
34	You can activate them like this:	36	You can activate them like this:
…		…
37		39
38	=over 4	40	=over 4
39		41
40	=item selection	42	=item selection
41		43
42	Miscellaneous selection modifications.	44	Intelligent selection. This extension tries to be more intelligent when
		45	the user extends selections (double-click). Right now, it tries to select
		46	urls and complete shell-quoted arguments, which is very convenient, too,
		47	if your F<ls> supports C<--quoting-style=shell>.
		48
		49	It also offers the following bindable event:
43		50
44	=over 4	51	=over 4
45		52
46	=item rot13	53	=item rot13
47		54
…		…
50	URxvt.keysym.C-M-r: perl:selection:rot13	57	URxvt.keysym.C-M-r: perl:selection:rot13
51		58
52	=back	59	=back
53		60
54	=item digital-clock	61	=item digital-clock
		62
		63	Displays a digital clock using the built-in overlay.
		64
		65	=item example-refresh-hooks
55		66
56	Displays a very simple digital clock in the upper right corner of the	67	Displays a very simple digital clock in the upper right corner of the
57	window. Illustrates overwriting the refresh callbacks to create your own	68	window. Illustrates overwriting the refresh callbacks to create your own
58	overlays or changes.	69	overlays or changes.
59		70
60	=item simple-overlay-clock
61
62	Displays a digital clock using the built-in overlay (colorful, useless).
63
64	=back	71	=back
65		72
66	=head2 General API Considerations	73	=head2 General API Considerations
67		74
68	All objects (such as terminals, time watchers etc.) are typical	75	All objects (such as terminals, time watchers etc.) are typical
69	reference-to-hash objects. The hash can be used to store anything you	76	reference-to-hash objects. The hash can be used to store anything you
70	like. All members starting with an underscore (such as C<_ptr> or	77	like. All members starting with an underscore (such as C<_ptr> or
71	C<_hook>) are reserved for internal uses and must not be accessed or	78	C<_hook>) are reserved for internal uses and B<MUST NOT> be accessed or
72	modified).	79	modified).
73		80
74	When objects are destroyed on the C++ side, the perl object hashes are	81	When objects are destroyed on the C++ side, the perl object hashes are
75	emptied, so its best to store related objects such as time watchers and	82	emptied, so its best to store related objects such as time watchers and
76	the like inside the terminal object so they get destroyed as soon as the	83	the like inside the terminal object so they get destroyed as soon as the
77	terminal is destroyed.	84	terminal is destroyed.
78		85
79	=head2 Hooks	86	=head2 Hooks
80		87
81	The following subroutines can be declared in loaded scripts, and will be called	88	The following subroutines can be declared in loaded scripts, and will be
82	whenever the relevant event happens.	89	called whenever the relevant event happens.
		90
		91	The first argument passed to them is an object private to each terminal
		92	and extension package. You can call all C<urxvt::term> methods on it, but
		93	its not a real C<urxvt::term> object. Instead, the real C<urxvt::term>
		94	object that is shared between all packages is stored in the C<term>
		95	member.
83		96
84	All of them must return a boolean value. If it is true, then the event	97	All of them must return a boolean value. If it is true, then the event
85	counts as being I<consumed>, and the invocation of other hooks is skipped,	98	counts as being I<consumed>, and the invocation of other hooks is skipped,
86	and the relevant action might not be carried out by the C++ code.	99	and the relevant action might not be carried out by the C++ code.
87		100
…		…
120	requested from the server. The selection text can be queried and changed	133	requested from the server. The selection text can be queried and changed
121	by calling C<< $term->selection >>.	134	by calling C<< $term->selection >>.
122		135
123	Returning a true value aborts selection grabbing. It will still be hilighted.	136	Returning a true value aborts selection grabbing. It will still be hilighted.
124		137
		138	=item on_sel_extend $term
		139
		140	Called whenever the user tries to extend the selection (e.g. with a double
		141	click) and is either supposed to return false (normal operation), or
		142	should extend the selection itelf and return true to suppress the built-in
		143	processing.
		144
		145	See the F<selection> example extension.
		146
125	=item on_focus_in $term	147	=item on_focus_in $term
126		148
127	Called whenever the window gets the keyboard focus, before urxvt does	149	Called whenever the window gets the keyboard focus, before urxvt does
128	focus in processing.	150	focus in processing.
129		151
…		…
149	number of lines that will be in the scrollback buffer.	171	number of lines that will be in the scrollback buffer.
150		172
151	=item on_tty_activity $term NYI	173	=item on_tty_activity $term NYI
152		174
153	Called whenever the program(s) running in the urxvt window send output.	175	Called whenever the program(s) running in the urxvt window send output.
		176
		177	=item on_osc_seq $term, $string
		178
		179	Called whenever the B<ESC ] 777 ; string ST> command sequence is
		180	processed. Cursor position and other state information is up-to-date when
		181	this happens. For interoperability, the string should start with the
		182	extension name and a colon, to distinguish it from commands for other
		183	extensions, and this might be enforced in the future.
154		184
155	=item on_refresh_begin $term	185	=item on_refresh_begin $term
156		186
157	Called just before the screen gets redrawn. Can be used for overlay	187	Called just before the screen gets redrawn. Can be used for overlay
158	or similar effects by modify terminal contents in refresh_begin, and	188	or similar effects by modify terminal contents in refresh_begin, and
…		…
169	C<perl:string> action bound to it (see description of the B<keysym>	199	C<perl:string> action bound to it (see description of the B<keysym>
170	resource in the @@RXVT_NAME@@(1) manpage).	200	resource in the @@RXVT_NAME@@(1) manpage).
171		201
172	=back	202	=back
173		203
		204	=head2 Variables in the C<urxvt> Package
		205
		206	=over 4
		207
		208	=item $urxvt::TERM
		209
		210	The current terminal. Whenever a callback/Hook is bein executed, this
		211	variable stores the current C<urxvt::term> object.
		212
		213	=back
		214
174	=head2 Functions in the C<urxvt> Package	215	=head2 Functions in the C<urxvt> Package
175		216
176	=over 4	217	=over 4
177		218
178	=item urxvt::fatal $errormessage	219	=item urxvt::fatal $errormessage
…		…
192		233
193	=item $time = urxvt::NOW	234	=item $time = urxvt::NOW
194		235
195	Returns the "current time" (as per the event loop).	236	Returns the "current time" (as per the event loop).
196		237
		238	=back
		239
		240	=head2 RENDITION
		241
		242	Rendition bitsets contain information about colour, font, font styles and
		243	similar information for each screen cell.
		244
		245	The following "macros" deal with changes in rendition sets. You should
		246	never just create a bitset, you should always modify an existing one,
		247	as they contain important information required for correct operation of
		248	rxvt-unicode.
		249
		250	=over 4
		251
		252	=item $rend = urxvt::DEFAULT_RSTYLE
		253
		254	Returns the default rendition, as used when the terminal is starting up or
		255	being reset. Useful as a base to start when creating renditions.
		256
		257	=item $rend = urxvt::OVERLAY_RSTYLE
		258
		259	Return the rendition mask used for overlays by default.
		260
		261	=item $rendbit = urxvt::RS_Bold, RS_Italic, RS_Blink, RS_RVid, RS_Uline
		262
		263	Return the bit that enabled bold, italic, blink, reverse-video and
		264	underline, respectively. To enable such a style, just logically OR it into
		265	the bitset.
		266
		267	=item $foreground = urxvt::GET_BASEFG $rend
		268
		269	=item $background = urxvt::GET_BASEBG $rend
		270
		271	Return the foreground/background colour index, respectively.
		272
		273	=item $rend = urxvt::SET_FGCOLOR ($rend, $new_colour)
		274
		275	=item $rend = urxvt::SET_BGCOLOR ($rend, $new_colour)
		276
		277	Replace the foreground/background colour in the rendition mask with the
		278	specified one.
		279
		280	=item $value = urxvt::GET_CUSTOM ($rend)
		281
		282	Return the "custom" value: Every rendition has 5 bits for use by
		283	extensions. They can be set and changed as you like and are initially
		284	zero.
		285
		286	=item $rend = urxvt::SET_CUSTOM ($rend, $new_value)
		287
		288	Change the custom value.
		289
		290	=back
		291
197	=cut	292	=cut
198		293
199	package urxvt;	294	package urxvt;
200		295
201	use strict;	296	use strict;
		297	use Scalar::Util ();
202		298
203	our $term;	299	our $TERM;
204	our @HOOKNAME;	300	our @HOOKNAME;
205	our $LIBDIR;	301	our $LIBDIR;
206		302
207	BEGIN {	303	BEGIN {
208	urxvt->bootstrap;	304	urxvt->bootstrap;
…		…
233	my $name = $HOOKNAME[$htype];	329	my $name = $HOOKNAME[$htype];
234		330
235	my $ref = $pkg->can ("on_" . lc $name)	331	my $ref = $pkg->can ("on_" . lc $name)
236	or next;	332	or next;
237		333
238	$term->{_hook}[$htype]{$ref*1} = $ref;	334	$TERM->{_hook}[$htype]{$pkg} = $ref;
239	$hook_count[$htype]++	335	$hook_count[$htype]++
240	or set_should_invoke $htype, 1;	336	or set_should_invoke $htype, 1;
241	}	337	}
242	}	338	}
243		339
…		…
267	}	363	}
268	}	364	}
269		365
270	# called by the rxvt core	366	# called by the rxvt core
271	sub invoke {	367	sub invoke {
272	local $term = shift;	368	local $TERM = shift;
273	my $htype = shift;	369	my $htype = shift;
274		370
275	if ($htype == 0) { # INIT	371	if ($htype == 0) { # INIT
276	my @dirs = ((split /:/, $term->resource ("perl_lib")), "$LIBDIR/perl");	372	my @dirs = ((split /:/, $TERM->resource ("perl_lib")), "$LIBDIR/perl");
277		373
278	for my $ext (split /:/, $term->resource ("perl_ext")) {	374	for my $ext (split /:/, $TERM->resource ("perl_ext")) {
279	my @files = grep -f $_, map "$_/$ext", @dirs;	375	my @files = grep -f $_, map "$_/$ext", @dirs;
280		376
281	if (@files) {	377	if (@files) {
282	register_package script_package $files[0];	378	register_package script_package $files[0];
283	} else {	379	} else {
284	warn "perl extension '$ext' not found in perl library search path\n";	380	warn "perl extension '$ext' not found in perl library search path\n";
285	}	381	}
286	}	382	}
287		383
288	} elsif ($htype == 1) { # DESTROY	384	} elsif ($htype == 1) { # DESTROY
289	if (my $hook = $term->{_hook}) {	385	if (my $hook = $TERM->{_hook}) {
290	for my $htype (0..$#$hook) {	386	for my $htype (0..$#$hook) {
291	$hook_count[$htype] -= scalar keys %{ $hook->[$htype] \|\| {} }	387	$hook_count[$htype] -= scalar keys %{ $hook->[$htype] \|\| {} }
292	or set_should_invoke $htype, 0;	388	or set_should_invoke $htype, 0;
293	}	389	}
294	}	390	}
295	}	391	}
296		392
297	my $cb = $term->{_hook}[$htype]	393	my $cb = $TERM->{_hook}[$htype]
298	or return;	394	or return;
299		395
300	verbose 10, "$HOOKNAME[$htype] (" . (join ", ", $term, @_) . ")"	396	verbose 10, "$HOOKNAME[$htype] (" . (join ", ", $TERM, @_) . ")"
301	if $verbosity >= 10;	397	if $verbosity >= 10;
302		398
		399	keys %$cb;
		400
303	while (my ($k, $v) = each %$cb) {	401	while (my ($pkg, $cb) = each %$cb) {
304	return 1 if $v->($term, @_);	402	return 1
		403	if $cb->(
		404	$TERM->{$pkg} \|\|= do {
		405	my $proxy = bless { }, urxvt::term::proxy::;
		406	Scalar::Util::weaken ($proxy->{term} = $TERM);
		407	$proxy
		408	},
		409	@_,
		410	);
305	}	411	}
306		412
307	0	413	0
308	}	414	}
309		415
310	=back	416	sub urxvt::term::proxy::AUTOLOAD {
		417	$urxvt::term::proxy::AUTOLOAD =~ /:([^:]+)$/
		418	or die "FATAL: \$AUTOLOAD '$urxvt::term::proxy::AUTOLOAD' unparsable";
		419
		420	eval qq{
		421	sub $urxvt::term::proxy::AUTOLOAD {
		422	my \$proxy = shift;
		423	\$proxy->{term}->$1 (\@_)
		424	}
		425	1
		426	} or die "FATAL: unable to compile method forwarder: $@";
		427
		428	goto &$urxvt::term::proxy::AUTOLOAD;
		429	}
311		430
312	=head2 The C<urxvt::term> Class	431	=head2 The C<urxvt::term> Class
313		432
314	=over 4	433	=over 4
315		434
…		…
371		490
372	=item $oldtext = $term->selection ([$newtext])	491	=item $oldtext = $term->selection ([$newtext])
373		492
374	Return the current selection text and optionally replace it by C<$newtext>.	493	Return the current selection text and optionally replace it by C<$newtext>.
375		494
376	=item $term->scr_overlay ($x, $y, $text)	495	#=item $term->overlay ($x, $y, $text)
377		496	#
378	Create a simple multi-line overlay box. See the next method for details.	497	#Create a simple multi-line overlay box. See the next method for details.
379		498	#
380	=cut	499	#=cut
381		500
382	sub urxvt::term::scr_overlay {	501	sub urxvt::term::scr_overlay {
		502	die;
383	my ($self, $x, $y, $text) = @_;	503	my ($self, $x, $y, $text) = @_;
384		504
385	my @lines = split /\n/, $text;	505	my @lines = split /\n/, $text;
386		506
387	my $w = 0;	507	my $w = 0;
…		…
391		511
392	$self->scr_overlay_new ($x, $y, $w, scalar @lines);	512	$self->scr_overlay_new ($x, $y, $w, scalar @lines);
393	$self->scr_overlay_set (0, $_, $lines[$_]) for 0.. $#lines;	513	$self->scr_overlay_set (0, $_, $lines[$_]) for 0.. $#lines;
394	}	514	}
395		515
396	=item $term->scr_overlay_new ($x, $y, $width, $height)	516	=item $term->overlay ($x, $y, $width, $height[, $rstyle[, $border]])
397		517
398	Create a new (empty) overlay at the given position with the given	518	Create a new (empty) overlay at the given position with the given
399	width/height. A border will be put around the box. If either C<$x> or	519	width/height. C<$rstyle> defines the initial rendition style
400	C<$y> is negative, then this is counted from the right/bottom side,	520	(default: C<OVERLAY_RSTYLE>).
401	respectively.
402		521
403	=item $term->scr_overlay_off	522	If C<$border> is C<2> (default), then a decorative border will be put
		523	around the box.
404		524
405	Switch the overlay off again.	525	If either C<$x> or C<$y> is negative, then this is counted from the
		526	right/bottom side, respectively.
406		527
407	=item $term->scr_overlay_set_char ($x, $y, $char, $rend = OVERLAY_RSTYLE)	528	This method returns an urxvt::overlay object. The overlay will be visible
		529	as long as the perl object is referenced.
408		530
409	Put a single character (specified numerically) at the given overlay	531	The methods currently supported on C<urxvt::overlay> objects are:
410	position.
411		532
		533	=over 4
		534
412	=item $term->scr_overlay_set ($x, $y, $text)	535	=item $overlay->set ($x, $y, $text, $rend)
413		536
414	Write a string at the given position into the overlay.	537	Similar to C<< $term->ROW_t >> and C<< $term->ROW_r >> in that it puts
		538	text in rxvt-unicode's special encoding and an array of rendition values
		539	at a specific position inside the overlay.
		540
		541	=item $overlay->hide
		542
		543	If visible, hide the overlay, but do not destroy it.
		544
		545	=item $overlay->show
		546
		547	If hidden, display the overlay again.
		548
		549	=back
415		550
416	=item $cellwidth = $term->strwidth $string	551	=item $cellwidth = $term->strwidth $string
417		552
418	Returns the number of screen-cells this string would need. Correctly	553	Returns the number of screen-cells this string would need. Correctly
419	accounts for wide and combining characters.	554	accounts for wide and combining characters.
…		…
460	=item $text = $term->ROW_t ($row_number[, $new_text[, $start_col]])	595	=item $text = $term->ROW_t ($row_number[, $new_text[, $start_col]])
461		596
462	Returns the text of the entire row with number C<$row_number>. Row C<0>	597	Returns the text of the entire row with number C<$row_number>. Row C<0>
463	is the topmost terminal line, row C<< $term->$ncol-1 >> is the bottommost	598	is the topmost terminal line, row C<< $term->$ncol-1 >> is the bottommost
464	terminal line. The scrollback buffer starts at line C<-1> and extends to	599	terminal line. The scrollback buffer starts at line C<-1> and extends to
465	line C<< -$term->nsaved >>.	600	line C<< -$term->nsaved >>. Nothing will be returned if a nonexistent line
		601	is requested.
466		602
467	If C<$new_text> is specified, it will replace characters in the current	603	If C<$new_text> is specified, it will replace characters in the current
468	line, starting at column C<$start_col> (default C<0>), which is useful	604	line, starting at column C<$start_col> (default C<0>), which is useful
469	to replace only parts of a line. The font iindex in the rendition will	605	to replace only parts of a line. The font index in the rendition will
470	automatically be updated.	606	automatically be updated.
471		607
472	C<$text> is in a special encoding: tabs and wide characters that use more	608	C<$text> is in a special encoding: tabs and wide characters that use more
473	than one cell when displayed are padded with urxvt::NOCHAR characters	609	than one cell when displayed are padded with urxvt::NOCHAR characters
474	(C<chr 65535>). Characters with combining characters and other characters	610	(C<chr 65535>). Characters with combining characters and other characters
…		…
488	bitsets. Rendition bitsets contain information about colour, font, font	624	bitsets. Rendition bitsets contain information about colour, font, font
489	styles and similar information. See also C<< $term->ROW_t >>.	625	styles and similar information. See also C<< $term->ROW_t >>.
490		626
491	When setting rendition, the font mask will be ignored.	627	When setting rendition, the font mask will be ignored.
492		628
493	See the section on RENDITION, below.	629	See the section on RENDITION, above.
494		630
495	=item $length = $term->ROW_l ($row_number[, $new_length])	631	=item $length = $term->ROW_l ($row_number[, $new_length])
496		632
497	Returns the number of screen cells that are in use ("the line length"). If	633	Returns the number of screen cells that are in use ("the line
498	it is C<-1>, then the line is part of a multiple-row logical "line", which	634	length"). Unlike the urxvt core, this returns C<< $term->ncol >> if the
499	means all characters are in use and it is continued on the next row.	635	line is joined with the following one.
500		636
		637	=item $bool = $term->is_longer ($row_number)
		638
		639	Returns true if the row is part of a multiple-row logical "line" (i.e.
		640	joined with the following row), which means all characters are in use
		641	and it is continued on the next row (and possibly a continuation of the
		642	previous row(s)).
		643
		644	=item $line = $term->line ($row_number)
		645
		646	Create and return a new C<urxvt::line> object that stores information
		647	about the logical line that row C<$row_number> is part of. It supports the
		648	following methods:
		649
		650	=over 4
		651
		652	=item $text = $line->t
		653
		654	Returns the full text of the line, similar to C<ROW_t>
		655
		656	=item $rend = $line->r
		657
		658	Returns the full rendition array of the line, similar to C<ROW_r>
		659
		660	=item $length = $line->l
		661
		662	Returns the length of the line in cells, similar to C<ROW_l>.
		663
		664	=item $rownum = $line->beg
		665
		666	=item $rownum = $line->end
		667
		668	Return the row number of the first/last row of the line, respectively.
		669
		670	=item $offset = $line->offset_of ($row, $col)
		671
		672	Returns the character offset of the given row\|col pair within the logical
		673	line.
		674
		675	=item ($row, $col) = $line->coord_of ($offset)
		676
		677	Translates a string offset into terminal coordinates again.
		678
		679	=back
		680
		681	=cut
		682
		683	sub urxvt::term::line {
		684	my ($self, $row) = @_;
		685
		686	my $maxrow = $self->nrow - 1;
		687
		688	my ($beg, $end) = ($row, $row);
		689
		690	--$beg while $self->ROW_is_longer ($beg - 1);
		691	++$end while $self->ROW_is_longer ($end) && $end < $maxrow;
		692
		693	bless {
		694	term => $self,
		695	beg => $beg,
		696	end => $end,
		697	len => ($end - $beg) * $self->ncol + $self->ROW_l ($end),
		698	}, urxvt::line::
		699	}
		700
		701	sub urxvt::line::t {
		702	my ($self) = @_;
		703
		704	substr +(join "", map $self->{term}->ROW_t ($_), $self->{beg} .. $self->{end}),
		705	0, $self->{len}
		706	}
		707
		708	sub urxvt::line::r {
		709	my ($self) = @_;
		710
		711	my $rend = [
		712	map @{ $self->{term}->ROW_r ($_) }, $self->{beg} .. $self->{end}
		713	];
		714	$#$rend = $self->{len} - 1;
		715	$rend
		716	}
		717
		718	sub urxvt::line::beg { $_[0]{beg} }
		719	sub urxvt::line::end { $_[0]{end} }
		720	sub urxvt::line::l { $_[0]{len} }
		721
		722	sub urxvt::line::offset_of {
		723	my ($self, $row, $col) = @_;
		724
		725	($row - $self->{beg}) * $self->{term}->ncol + $col
		726	}
		727
		728	sub urxvt::line::coord_of {
		729	my ($self, $offset) = @_;
		730
		731	use integer;
		732
		733	(
		734	$offset / $self->{term}->ncol + $self->{beg},
		735	$offset % $self->{term}->ncol
		736	)
		737	}
		738
		739	=item ($row, $col) = $line->coord_of ($offset)
501	=item $text = $term->special_encode $string	740	=item $text = $term->special_encode $string
502		741
503	Converts a perl string into the special encoding used by rxvt-unicode,	742	Converts a perl string into the special encoding used by rxvt-unicode,
504	where one character corresponds to one screen cell. See	743	where one character corresponds to one screen cell. See
505	C<< $term->ROW_t >> for details.	744	C<< $term->ROW_t >> for details.
…		…
509	Converts rxvt-unicodes text reprsentation into a perl string. See	748	Converts rxvt-unicodes text reprsentation into a perl string. See
510	C<< $term->ROW_t >> for details.	749	C<< $term->ROW_t >> for details.
511		750
512	=back	751	=back
513		752
514	=head2 RENDITION
515
516	Rendition bitsets contain information about colour, font, font styles and
517	similar information for each screen cell.
518
519	The following "macros" deal with changes in rendition sets. You should
520	never just create a bitset, you should always modify an existing one,
521	as they contain important information required for correct operation of
522	rxvt-unicode.
523
524	=over 4
525
526	=item $rend = urxvt::DEFAULT_RSTYLE
527
528	Returns the default rendition, as used when the terminal is starting up or
529	being reset. Useful as a base
530
531	=back
532
533	=cut
534
535	=head2 The C<urxvt::timer> Class	753	=head2 The C<urxvt::timer> Class
536		754
537	This class implements timer watchers/events. Time is represented as a	755	This class implements timer watchers/events. Time is represented as a
538	fractional number of seconds since the epoch. Example:	756	fractional number of seconds since the epoch. Example:
539		757
540	# create a digital clock display in upper right corner	758	$term->{overlay} = $term->overlay (-1, 0, 8, 1, urxvt::OVERLAY_RSTYLE, 0);
541	$term->{timer} = urxvt::timer	759	$term->{timer} = urxvt::timer
542	->new	760	->new
543	->start (urxvt::NOW)	761	->interval (1)
544	->cb (sub {	762	->cb (sub {
545	my ($timer) = @_;
546	my $time = $timer->at;
547	$timer->start ($time + 1);
548	$self->scr_overlay (-1, 0,	763	$term->{overlay}->set (0, 0,
549	POSIX::strftime "%H:%M:%S", localtime $time);	764	sprintf "%2d:%02d:%02d", (localtime urxvt::NOW)[2,1,0]);
550	});	765	});
551		766
552	=over 4	767	=over 4
553		768
554	=item $timer = new urxvt::timer	769	=item $timer = new urxvt::timer
555		770
556	Create a new timer object in stopped state.	771	Create a new timer object in started state. It is scheduled to fire
		772	immediately.
557		773
558	=item $timer = $timer->cb (sub { my ($timer) = @_; ... })	774	=item $timer = $timer->cb (sub { my ($timer) = @_; ... })
559		775
560	Set the callback to be called when the timer triggers.	776	Set the callback to be called when the timer triggers.
561		777
…		…
564	Return the time this watcher will fire next.	780	Return the time this watcher will fire next.
565		781
566	=item $timer = $timer->set ($tstamp)	782	=item $timer = $timer->set ($tstamp)
567		783
568	Set the time the event is generated to $tstamp.	784	Set the time the event is generated to $tstamp.
		785
		786	=item $timer = $timer->interval ($interval)
		787
		788	Normally (and when C<$interval> is C<0>), the timer will automatically
		789	stop after it has fired once. If C<$interval> is non-zero, then the timer
		790	is automatically rescheduled at the given intervals.
569		791
570	=item $timer = $timer->start	792	=item $timer = $timer->start
571		793
572	Start the timer.	794	Start the timer.
573		795
…		…
636	This variable controls the verbosity level of the perl extension. Higher	858	This variable controls the verbosity level of the perl extension. Higher
637	numbers indicate more verbose output.	859	numbers indicate more verbose output.
638		860
639	=over 4	861	=over 4
640		862
641	=item 0 - only fatal messages	863	=item =0 - only fatal messages
642		864
643	=item 3 - script loading and management	865	=item =3 - script loading and management
644		866
645	=item 10 - all events received	867	=item =10 - all events received
646		868
647	=back	869	=back
648		870
649	=head1 AUTHOR	871	=head1 AUTHOR
650		872

Diff Legend

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

Comparing rxvt-unicode/src/urxvt.pm (file contents): Revision 1.15 by root, Tue Jan 3 01:39:17 2006 UTC vs. Revision 1.28 by root, Wed Jan 4 00:09:12 2006 UTC

Diff Legend

Comparing rxvt-unicode/src/urxvt.pm (file contents):
Revision 1.15 by root, Tue Jan 3 01:39:17 2006 UTC vs.
Revision 1.28 by root, Wed Jan 4 00:09:12 2006 UTC