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

Comparing rxvt-unicode/src/urxvt.pm (file contents):
Revision 1.13 by root, Tue Jan 3 00:06:57 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.
		30
		31	=head2 Prepackaged Extensions
		32
		33	This section describes the extensiosn delivered with this version. You can
		34	find them in F<@@RXVT_LIBDIR@@/urxvt/perl/>.
		35
		36	You can activate them like this:
		37
		38	@@RXVT_NAME@@ -pe <extensionname>
		39
		40	=over 4
		41
		42	=item selection
		43
		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:
		50
		51	=over 4
		52
		53	=item rot13
		54
		55	Rot-13 the selection when activated. Used via keyboard trigger:
		56
		57	URxvt.keysym.C-M-r: perl:selection:rot13
		58
		59	=back
		60
		61	=item digital-clock
		62
		63	Displays a digital clock using the built-in overlay.
		64
		65	=item example-refresh-hooks
		66
		67	Displays a very simple digital clock in the upper right corner of the
		68	window. Illustrates overwriting the refresh callbacks to create your own
		69	overlays or changes.
		70
		71	=back
28		72
29	=head2 General API Considerations	73	=head2 General API Considerations
30		74
31	All objects (such as terminals, time watchers etc.) are typical	75	All objects (such as terminals, time watchers etc.) are typical
32	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
33	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
34	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
35	modified).	79	modified).
36		80
37	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
38	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
39	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
40	terminal is destroyed.	84	terminal is destroyed.
41		85
42	=head2 Hooks	86	=head2 Hooks
43		87
44	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
45	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.
46		96
47	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
48	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,
49	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.
50		100
…		…
83	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
84	by calling C<< $term->selection >>.	134	by calling C<< $term->selection >>.
85		135
86	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.
87		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
88	=item on_focus_in $term	147	=item on_focus_in $term
89		148
90	Called whenever the window gets the keyboard focus, before urxvt does	149	Called whenever the window gets the keyboard focus, before urxvt does
91	focus in processing.	150	focus in processing.
92		151
…		…
112	number of lines that will be in the scrollback buffer.	171	number of lines that will be in the scrollback buffer.
113		172
114	=item on_tty_activity $term NYI	173	=item on_tty_activity $term NYI
115		174
116	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.
117		184
118	=item on_refresh_begin $term	185	=item on_refresh_begin $term
119		186
120	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
121	or similar effects by modify terminal contents in refresh_begin, and	188	or similar effects by modify terminal contents in refresh_begin, and
…		…
132	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>
133	resource in the @@RXVT_NAME@@(1) manpage).	200	resource in the @@RXVT_NAME@@(1) manpage).
134		201
135	=back	202	=back
136		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
137	=head2 Functions in the C<urxvt> Package	215	=head2 Functions in the C<urxvt> Package
138		216
139	=over 4	217	=over 4
140		218
141	=item urxvt::fatal $errormessage	219	=item urxvt::fatal $errormessage
…		…
155		233
156	=item $time = urxvt::NOW	234	=item $time = urxvt::NOW
157		235
158	Returns the "current time" (as per the event loop).	236	Returns the "current time" (as per the event loop).
159		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
160	=cut	292	=cut
161		293
162	package urxvt;	294	package urxvt;
163		295
164	use strict;	296	use strict;
		297	use Scalar::Util ();
165		298
166	our $term;	299	our $TERM;
167	our @HOOKNAME;	300	our @HOOKNAME;
168	our $LIBDIR;	301	our $LIBDIR;
169		302
170	BEGIN {	303	BEGIN {
171	urxvt->bootstrap;	304	urxvt->bootstrap;
…		…
196	my $name = $HOOKNAME[$htype];	329	my $name = $HOOKNAME[$htype];
197		330
198	my $ref = $pkg->can ("on_" . lc $name)	331	my $ref = $pkg->can ("on_" . lc $name)
199	or next;	332	or next;
200		333
201	$term->{_hook}[$htype]{$ref*1} = $ref;	334	$TERM->{_hook}[$htype]{$pkg} = $ref;
202	$hook_count[$htype]++	335	$hook_count[$htype]++
203	or set_should_invoke $htype, 1;	336	or set_should_invoke $htype, 1;
204	}	337	}
205	}	338	}
206		339
…		…
230	}	363	}
231	}	364	}
232		365
233	# called by the rxvt core	366	# called by the rxvt core
234	sub invoke {	367	sub invoke {
235	local $term = shift;	368	local $TERM = shift;
236	my $htype = shift;	369	my $htype = shift;
237		370
238	if ($htype == 0) { # INIT	371	if ($htype == 0) { # INIT
239	my @dirs = ((split /:/, $term->resource ("perl_lib")), "$LIBDIR/perl");	372	my @dirs = ((split /:/, $TERM->resource ("perl_lib")), "$LIBDIR/perl");
240		373
241	for my $ext (split /:/, $term->resource ("perl_ext")) {	374	for my $ext (split /:/, $TERM->resource ("perl_ext")) {
242	my @files = grep -f $_, map "$_/$ext", @dirs;	375	my @files = grep -f $_, map "$_/$ext", @dirs;
243		376
244	if (@files) {	377	if (@files) {
245	register_package script_package $files[0];	378	register_package script_package $files[0];
246	} else {	379	} else {
247	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";
248	}	381	}
249	}	382	}
250		383
251	} elsif ($htype == 1) { # DESTROY	384	} elsif ($htype == 1) { # DESTROY
252	if (my $hook = $term->{_hook}) {	385	if (my $hook = $TERM->{_hook}) {
253	for my $htype (0..$#$hook) {	386	for my $htype (0..$#$hook) {
254	$hook_count[$htype] -= scalar keys %{ $hook->[$htype] \|\| {} }	387	$hook_count[$htype] -= scalar keys %{ $hook->[$htype] \|\| {} }
255	or set_should_invoke $htype, 0;	388	or set_should_invoke $htype, 0;
256	}	389	}
257	}	390	}
258	}	391	}
259		392
260	my $cb = $term->{_hook}[$htype]	393	my $cb = $TERM->{_hook}[$htype]
261	or return;	394	or return;
262		395
263	verbose 10, "$HOOKNAME[$htype] (" . (join ", ", $term, @_) . ")"	396	verbose 10, "$HOOKNAME[$htype] (" . (join ", ", $TERM, @_) . ")"
264	if $verbosity >= 10;	397	if $verbosity >= 10;
265		398
		399	keys %$cb;
		400
266	while (my ($k, $v) = each %$cb) {	401	while (my ($pkg, $cb) = each %$cb) {
267	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	);
268	}	411	}
269		412
270	0	413	0
271	}	414	}
272		415
273	=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	}
274		430
275	=head2 The C<urxvt::term> Class	431	=head2 The C<urxvt::term> Class
276		432
277	=over 4	433	=over 4
278		434
…		…
334		490
335	=item $oldtext = $term->selection ([$newtext])	491	=item $oldtext = $term->selection ([$newtext])
336		492
337	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>.
338		494
339	=item $term->scr_overlay ($x, $y, $text)	495	#=item $term->overlay ($x, $y, $text)
340		496	#
341	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.
342		498	#
343	=cut	499	#=cut
344		500
345	sub urxvt::term::scr_overlay {	501	sub urxvt::term::scr_overlay {
		502	die;
346	my ($self, $x, $y, $text) = @_;	503	my ($self, $x, $y, $text) = @_;
347		504
348	my @lines = split /\n/, $text;	505	my @lines = split /\n/, $text;
349		506
350	my $w = 0;	507	my $w = 0;
…		…
354		511
355	$self->scr_overlay_new ($x, $y, $w, scalar @lines);	512	$self->scr_overlay_new ($x, $y, $w, scalar @lines);
356	$self->scr_overlay_set (0, $_, $lines[$_]) for 0.. $#lines;	513	$self->scr_overlay_set (0, $_, $lines[$_]) for 0.. $#lines;
357	}	514	}
358		515
359	=item $term->scr_overlay_new ($x, $y, $width, $height)	516	=item $term->overlay ($x, $y, $width, $height[, $rstyle[, $border]])
360		517
361	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
362	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
363	C<$y> is negative, then this is counted from the right/bottom side,	520	(default: C<OVERLAY_RSTYLE>).
364	respectively.
365		521
366	=item $term->scr_overlay_off	522	If C<$border> is C<2> (default), then a decorative border will be put
		523	around the box.
367		524
368	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.
369		527
370	=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.
371		530
372	Put a single character (specified numerically) at the given overlay	531	The methods currently supported on C<urxvt::overlay> objects are:
373	position.
374		532
		533	=over 4
		534
375	=item $term->scr_overlay_set ($x, $y, $text)	535	=item $overlay->set ($x, $y, $text, $rend)
376		536
377	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
378		550
379	=item $cellwidth = $term->strwidth $string	551	=item $cellwidth = $term->strwidth $string
380		552
381	Returns the number of screen-cells this string would need. Correctly	553	Returns the number of screen-cells this string would need. Correctly
382	accounts for wide and combining characters.	554	accounts for wide and combining characters.
…		…
410		582
411	Returns the negative row number of the topmost line. Minimum value is	583	Returns the negative row number of the topmost line. Minimum value is
412	C<0>, which displays the normal terminal contents. Larger values scroll	584	C<0>, which displays the normal terminal contents. Larger values scroll
413	this many lines into the scrollback buffer.	585	this many lines into the scrollback buffer.
414		586
		587	=item $term->want_refresh
		588
		589	Requests a screen refresh. At the next opportunity, rxvt-unicode will
		590	compare the on-screen display with its stored representation. If they
		591	differ, it redraws the differences.
		592
		593	Used after changing terminal contents to display them.
		594
415	=item $text = $term->ROW_t ($row_number[, $new_text[, $start_col]])	595	=item $text = $term->ROW_t ($row_number[, $new_text[, $start_col]])
416		596
417	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>
418	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
419	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
420	line C<< -$term->nsaved >>.	600	line C<< -$term->nsaved >>. Nothing will be returned if a nonexistent line
		601	is requested.
421		602
422	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
423	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
424	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
425	automatically be updated.	606	automatically be updated.
426		607
427	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
428	than one cell when displayed are padded with urxvt::NOCHAR characters	609	than one cell when displayed are padded with urxvt::NOCHAR characters
429	(C<chr 65535>). Characters with combining characters and other characters	610	(C<chr 65535>). Characters with combining characters and other characters
…		…
443	bitsets. Rendition bitsets contain information about colour, font, font	624	bitsets. Rendition bitsets contain information about colour, font, font
444	styles and similar information. See also C<< $term->ROW_t >>.	625	styles and similar information. See also C<< $term->ROW_t >>.
445		626
446	When setting rendition, the font mask will be ignored.	627	When setting rendition, the font mask will be ignored.
447		628
448	See the section on RENDITION, below.	629	See the section on RENDITION, above.
449		630
450	=item $length = $term->ROW_l ($row_number[, $new_length])	631	=item $length = $term->ROW_l ($row_number[, $new_length])
451		632
452	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
453	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
454	means all characters are in use and it is continued on the next row.	635	line is joined with the following one.
455		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)
456	=item $text = $term->special_encode $string	740	=item $text = $term->special_encode $string
457		741
458	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,
459	where one character corresponds to one screen cell. See	743	where one character corresponds to one screen cell. See
460	C<< $term->ROW_t >> for details.	744	C<< $term->ROW_t >> for details.
…		…
464	Converts rxvt-unicodes text reprsentation into a perl string. See	748	Converts rxvt-unicodes text reprsentation into a perl string. See
465	C<< $term->ROW_t >> for details.	749	C<< $term->ROW_t >> for details.
466		750
467	=back	751	=back
468		752
469	=head2 RENDITION
470
471	Rendition bitsets contain information about colour, font, font styles and
472	similar information for each screen cell.
473
474	The following "macros" deal with changes in rendition sets. You should
475	never just create a bitset, you should always modify an existing one,
476	as they contain important information required for correct operation of
477	rxvt-unicode.
478
479	=over 4
480
481	=item $rend = urxvt::DEFAULT_RSTYLE
482
483	Returns the default rendition, as used when the terminal is starting up or
484	being reset. Useful as a base
485
486	=back
487
488	=cut
489
490	=head2 The C<urxvt::timer> Class	753	=head2 The C<urxvt::timer> Class
491		754
492	This class implements timer watchers/events. Time is represented as a	755	This class implements timer watchers/events. Time is represented as a
493	fractional number of seconds since the epoch. Example:	756	fractional number of seconds since the epoch. Example:
494		757
495	# create a digital clock display in upper right corner	758	$term->{overlay} = $term->overlay (-1, 0, 8, 1, urxvt::OVERLAY_RSTYLE, 0);
496	$term->{timer} = urxvt::timer	759	$term->{timer} = urxvt::timer
497	->new	760	->new
498	->start (urxvt::NOW)	761	->interval (1)
499	->cb (sub {	762	->cb (sub {
500	my ($timer) = @_;
501	my $time = $timer->at;
502	$timer->start ($time + 1);
503	$self->scr_overlay (-1, 0,	763	$term->{overlay}->set (0, 0,
504	POSIX::strftime "%H:%M:%S", localtime $time);	764	sprintf "%2d:%02d:%02d", (localtime urxvt::NOW)[2,1,0]);
505	});	765	});
506		766
507	=over 4	767	=over 4
508		768
509	=item $timer = new urxvt::timer	769	=item $timer = new urxvt::timer
510		770
511	Create a new timer object in stopped state.	771	Create a new timer object in started state. It is scheduled to fire
		772	immediately.
512		773
513	=item $timer = $timer->cb (sub { my ($timer) = @_; ... })	774	=item $timer = $timer->cb (sub { my ($timer) = @_; ... })
514		775
515	Set the callback to be called when the timer triggers.	776	Set the callback to be called when the timer triggers.
516		777
…		…
519	Return the time this watcher will fire next.	780	Return the time this watcher will fire next.
520		781
521	=item $timer = $timer->set ($tstamp)	782	=item $timer = $timer->set ($tstamp)
522		783
523	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.
524		791
525	=item $timer = $timer->start	792	=item $timer = $timer->start
526		793
527	Start the timer.	794	Start the timer.
528		795
…		…
591	This variable controls the verbosity level of the perl extension. Higher	858	This variable controls the verbosity level of the perl extension. Higher
592	numbers indicate more verbose output.	859	numbers indicate more verbose output.
593		860
594	=over 4	861	=over 4
595		862
596	=item 0 - only fatal messages	863	=item =0 - only fatal messages
597		864
598	=item 3 - script loading and management	865	=item =3 - script loading and management
599		866
600	=item 10 - all events received	867	=item =10 - all events received
601		868
602	=back	869	=back
603		870
604	=head1 AUTHOR	871	=head1 AUTHOR
605		872

Diff Legend

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

Comparing rxvt-unicode/src/urxvt.pm (file contents): Revision 1.13 by root, Tue Jan 3 00:06:57 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.13 by root, Tue Jan 3 00:06:57 2006 UTC vs.
Revision 1.28 by root, Wed Jan 4 00:09:12 2006 UTC