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

Comparing rxvt-unicode/src/urxvt.pm (file contents):
Revision 1.5 by root, Mon Jan 2 17:20:00 2006 UTC vs.
Revision 1.23 by root, Tue Jan 3 19:42:53 2006 UTC

…		…
		1	=encoding utf8
		2
1	=head1 NAME	3	=head1 NAME
2		4
3	rxvtperl - rxvt-unicode's embedded perl interpreter	5	@@RXVT_NAME@@perl - rxvt-unicode's embedded perl interpreter
4		6
5	=head1 SYNOPSIS	7	=head1 SYNOPSIS
6		8
7	* Put your scripts into F<@@RXVT_LIBDIR@@/urxvt/perl-ext/>, they will be loaded automatically.	9	# create a file grab_test in $HOME:
8
9	* Each script will only be loaded once, even in urxvtd, and will be valid
10	globally.
11
12	* Scripts are evaluated in a 'use strict' and 'use utf8' environment, and
13	thus must be encoded as UTF-8.
14		10
15	sub on_sel_grab {	11	sub on_sel_grab {
16	warn "you selected ", $_[0]->selection;	12	warn "you selected ", $_[0]->selection;
17	()	13	()
18	}	14	}
19		15
20	1	16	# start a @@RXVT_NAME@@ using it:
		17
		18	@@RXVT_NAME@@ --perl-lib $HOME -pe grab_test
21		19
22	=head1 DESCRIPTION	20	=head1 DESCRIPTION
23		21
		22	Everytime a terminal object gets created, scripts specified via the
		23	C<perl> resource are loaded and associated with it.
		24
		25	Scripts are compiled in a 'use strict' and 'use utf8' environment, and
		26	thus must be encoded as UTF-8.
		27
		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.
		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 etxension tries to be more intelligent when the user
		45	extends selections (double-click).
		46
		47	It also offers the following bindable event:
		48
		49	=over 4
		50
		51	=item rot13
		52
		53	Rot-13 the selection when activated. Used via keyboard trigger:
		54
		55	URxvt.keysym.C-M-r: perl:selection:rot13
		56
		57	=back
		58
		59	=item digital-clock
		60
		61	Displays a digital clock using the built-in overlay.
		62
		63	=item example-refresh-hooks
		64
		65	Displays a very simple digital clock in the upper right corner of the
		66	window. Illustrates overwriting the refresh callbacks to create your own
		67	overlays or changes.
		68
		69	=back
		70
		71	=head2 General API Considerations
		72
		73	All objects (such as terminals, time watchers etc.) are typical
		74	reference-to-hash objects. The hash can be used to store anything you
		75	like. All members starting with an underscore (such as C<_ptr> or
		76	C<_hook>) are reserved for internal uses and B<MUST NOT> be accessed or
		77	modified).
		78
		79	When objects are destroyed on the C++ side, the perl object hashes are
		80	emptied, so its best to store related objects such as time watchers and
		81	the like inside the terminal object so they get destroyed as soon as the
		82	terminal is destroyed.
		83
24	=head2 Hooks	84	=head2 Hooks
25		85
26	The following subroutines can be declared in loaded scripts, and will be called	86	The following subroutines can be declared in loaded scripts, and will be
27	whenever the relevant event happens.	87	called whenever the relevant event happens.
		88
		89	The first argument passed to them is an object private to each terminal
		90	and extension package. You can call all C<urxvt::term> methods on it, but
		91	its not a real C<urxvt::term> object. Instead, the real C<urxvt::term>
		92	object that is shared between all packages is stored in the C<term>
		93	member.
28		94
29	All of them must return a boolean value. If it is true, then the event	95	All of them must return a boolean value. If it is true, then the event
30	counts as being I<consumed>, and the invocation of other hooks is skipped,	96	counts as being I<consumed>, and the invocation of other hooks is skipped,
31	and the relevant action might not be carried out by the C++ code.	97	and the relevant action might not be carried out by the C++ code.
32		98
64	Called whenever a selection has been copied, but before the selection is	130	Called whenever a selection has been copied, but before the selection is
65	requested from the server. The selection text can be queried and changed	131	requested from the server. The selection text can be queried and changed
66	by calling C<< $term->selection >>.	132	by calling C<< $term->selection >>.
67		133
68	Returning a true value aborts selection grabbing. It will still be hilighted.	134	Returning a true value aborts selection grabbing. It will still be hilighted.
		135
		136	=item on_sel_extend $term
		137
		138	Called whenever the user tries to extend the selection (e.g. with a double
		139	click) and is either supposed to return false (normal operation), or
		140	should extend the selection itelf and return true to suppress the built-in
		141	processing.
		142
		143	See the F<selection> example extension.
69		144
70	=item on_focus_in $term	145	=item on_focus_in $term
71		146
72	Called whenever the window gets the keyboard focus, before urxvt does	147	Called whenever the window gets the keyboard focus, before urxvt does
73	focus in processing.	148	focus in processing.
…		…
106		181
107	=item on_refresh_end $term	182	=item on_refresh_end $term
108		183
109	Called just after the screen gets redrawn. See C<on_refresh_begin>.	184	Called just after the screen gets redrawn. See C<on_refresh_begin>.
110		185
		186	=item on_keyboard_command $term, $string
		187
		188	Called whenever the user presses a key combination that has a
		189	C<perl:string> action bound to it (see description of the B<keysym>
		190	resource in the @@RXVT_NAME@@(1) manpage).
		191
		192	=back
		193
		194	=head2 Variables in the C<urxvt> Package
		195
		196	=over 4
		197
		198	=item $urxvt::TERM
		199
		200	The current terminal. Whenever a callback/Hook is bein executed, this
		201	variable stores the current C<urxvt::term> object.
		202
111	=back	203	=back
112		204
113	=head2 Functions in the C<urxvt> Package	205	=head2 Functions in the C<urxvt> Package
114		206
115	=over 4	207	=over 4
…		…
120	costs! The only time this is acceptable is when the terminal process	212	costs! The only time this is acceptable is when the terminal process
121	starts up.	213	starts up.
122		214
123	=item urxvt::warn $string	215	=item urxvt::warn $string
124		216
125	Calls C<rxvt_warn> witht eh given string which should not include a	217	Calls C<rxvt_warn> with the given string which should not include a
126	newline. The module also overwrites the C<warn> builtin with a function	218	newline. The module also overwrites the C<warn> builtin with a function
127	that calls this function.	219	that calls this function.
128		220
129	Using this function has the advantage that its output ends up in the	221	Using this function has the advantage that its output ends up in the
130	correct place, e.g. on stderr of the connecting urxvtc client.	222	correct place, e.g. on stderr of the connecting urxvtc client.
131		223
132	=item $cellwidth = urxvt::wcswidth $string
133
134	Returns the number of screen-cells this string would need. Correctly
135	accounts for wide and combining characters.
136
137	=item $time = urxvt::NOW	224	=item $time = urxvt::NOW
138		225
139	Returns the "current time" (as per the event loop).	226	Returns the "current time" (as per the event loop).
140		227
		228	=back
		229
		230	=head2 RENDITION
		231
		232	Rendition bitsets contain information about colour, font, font styles and
		233	similar information for each screen cell.
		234
		235	The following "macros" deal with changes in rendition sets. You should
		236	never just create a bitset, you should always modify an existing one,
		237	as they contain important information required for correct operation of
		238	rxvt-unicode.
		239
		240	=over 4
		241
		242	=item $rend = urxvt::DEFAULT_RSTYLE
		243
		244	Returns the default rendition, as used when the terminal is starting up or
		245	being reset. Useful as a base to start when creating renditions.
		246
		247	=item $rend = urxvt::OVERLAY_RSTYLE
		248
		249	Return the rendition mask used for overlays by default.
		250
		251	=item $rendbit = urxvt::RS_Bold, RS_Italic, RS_Blink, RS_RVid, RS_Uline
		252
		253	Return the bit that enabled bold, italic, blink, reverse-video and
		254	underline, respectively. To enable such a style, just logically OR it into
		255	the bitset.
		256
		257	=item $foreground = urxvt::GET_BASEFG $rend
		258
		259	=item $background = urxvt::GET_BASEBG $rend
		260
		261	Return the foreground/background colour index, respectively.
		262
		263	=item $rend = urxvt::SET_FGCOLOR ($rend, $new_colour)
		264
		265	=item $rend = urxvt::SET_BGCOLOR ($rend, $new_colour)
		266
		267	Replace the foreground/background colour in the rendition mask with the
		268	specified one.
		269
		270	=item $value = urxvt::GET_CUSTOM ($rend)
		271
		272	Return the "custom" value: Every rendition has 5 bits for use by
		273	extensions. They can be set and changed as you like and are initially
		274	zero.
		275
		276	=item $rend = urxvt::SET_CUSTOM ($rend, $new_value)
		277
		278	Change the custom value.
		279
		280	=back
		281
141	=cut	282	=cut
142		283
143	package urxvt;	284	package urxvt;
144		285
145	use strict;	286	use strict;
		287	use Scalar::Util ();
146		288
147	our $term;	289	our $TERM;
148	our @HOOKNAME;	290	our @HOOKNAME;
149	our $LIBDIR;	291	our $LIBDIR;
150		292
151	BEGIN {	293	BEGIN {
152	urxvt->bootstrap;	294	urxvt->bootstrap;
…		…
158	unless $msg =~ /\n$/;	300	unless $msg =~ /\n$/;
159	urxvt::warn ($msg);	301	urxvt::warn ($msg);
160	};	302	};
161	}	303	}
162		304
		305	my @hook_count;
163	my $verbosity = $ENV{URXVT_PERL_VERBOSITY} \|\| 10;	306	my $verbosity = $ENV{URXVT_PERL_VERBOSITY};
164		307
165	sub verbose {	308	sub verbose {
166	my ($level, $msg) = @_;	309	my ($level, $msg) = @_;
167	warn "$msg\n"; #d#	310	warn "$msg\n" if $level <= $verbosity;
168	}
169
170	my @invoke_cb;
171
172	# called by the rxvt core
173	sub invoke {
174	local $term = shift;
175	my $htype = shift;
176
177	my $cb = $invoke_cb[$htype];
178
179	verbose 10, "$HOOKNAME[$htype] (" . (join ", ", $term, @_) . ")"
180	if $verbosity >= 10;
181
182	while (my ($k, $v) = each %$cb) {
183	return 1 if $v->($term, @_);
184	}
185
186	0
187	}	311	}
188		312
189	# find on_xxx subs in the package and register them	313	# find on_xxx subs in the package and register them
190	# as hooks	314	# as hooks
191	sub register_package($) {	315	sub register_package($) {
192	my ($pkg) = @_;	316	my ($pkg) = @_;
193		317
194	for my $hook (0.. $#HOOKNAME) {	318	for my $htype (0.. $#HOOKNAME) {
195	my $name = $HOOKNAME[$hook];	319	my $name = $HOOKNAME[$htype];
196		320
197	my $ref = $pkg->can ("on_" . lc $name)	321	my $ref = $pkg->can ("on_" . lc $name)
198	or next;	322	or next;
199		323
200	$invoke_cb[$hook]{$ref*1} = $ref;	324	$TERM->{_hook}[$htype]{$pkg} = $ref;
		325	$hook_count[$htype]++
201	set_should_invoke $hook, 1;	326	or set_should_invoke $htype, 1;
202	}	327	}
203	}	328	}
204		329
205	my $script_pkg = "script0000";	330	my $script_pkg = "script0000";
206	my %script_pkg;	331	my %script_pkg;
207		332
208	# load a single script into its own package, once only	333	# load a single script into its own package, once only
209	sub load_script($) {	334	sub script_package($) {
210	my ($path) = @_;	335	my ($path) = @_;
211		336
212	$script_pkg{$path} \|\|= do {	337	$script_pkg{$path} \|\|= do {
213	my $pkg = $script_pkg++;	338	my $pkg = "urxvt::" . ($script_pkg++);
		339
214	verbose 3, "loading script '$path' into package '$pkg'";	340	verbose 3, "loading script '$path' into package '$pkg'";
215		341
216	open my $fh, "<:raw", $path	342	open my $fh, "<:raw", $path
217	or die "$path: $!";	343	or die "$path: $!";
218		344
219	eval "package $pkg; use strict; use utf8;\n"	345	my $source = "package $pkg; use strict; use utf8;\n"
220	. "#line 1 \"$path\"\n"	346	. "#line 1 \"$path\"\n{\n"
221	. do { local $/; <$fh> }	347	. (do { local $/; <$fh> })
		348	. "\n};\n1";
		349
222	or die "$path: $@";	350	eval $source or die "$path: $@";
223
224	register_package $pkg;
225		351
226	$pkg	352	$pkg
227	};	353	}
228	}	354	}
229		355
230	load_script $_ for grep -f $_, <$LIBDIR/perl-ext/*>;	356	# called by the rxvt core
		357	sub invoke {
		358	local $TERM = shift;
		359	my $htype = shift;
231		360
232	=back	361	if ($htype == 0) { # INIT
		362	my @dirs = ((split /:/, $TERM->resource ("perl_lib")), "$LIBDIR/perl");
		363
		364	for my $ext (split /:/, $TERM->resource ("perl_ext")) {
		365	my @files = grep -f $_, map "$_/$ext", @dirs;
		366
		367	if (@files) {
		368	register_package script_package $files[0];
		369	} else {
		370	warn "perl extension '$ext' not found in perl library search path\n";
		371	}
		372	}
		373
		374	} elsif ($htype == 1) { # DESTROY
		375	if (my $hook = $TERM->{_hook}) {
		376	for my $htype (0..$#$hook) {
		377	$hook_count[$htype] -= scalar keys %{ $hook->[$htype] \|\| {} }
		378	or set_should_invoke $htype, 0;
		379	}
		380	}
		381	}
		382
		383	my $cb = $TERM->{_hook}[$htype]
		384	or return;
		385
		386	verbose 10, "$HOOKNAME[$htype] (" . (join ", ", $TERM, @_) . ")"
		387	if $verbosity >= 10;
		388
		389	while (my ($pkg, $cb) = each %$cb) {
		390	return 1
		391	if $cb->(
		392	$TERM->{$pkg} \|\|= do {
		393	my $proxy = bless { }, urxvt::term::proxy::;
		394	Scalar::Util::weaken ($proxy->{term} = $TERM);
		395	$proxy
		396	},
		397	@_,
		398	);
		399	}
		400
		401	0
		402	}
		403
		404	sub urxvt::term::proxy::AUTOLOAD {
		405	$urxvt::term::proxy::AUTOLOAD =~ /:([^:]+)$/
		406	or die "FATAL: \$AUTOLOAD '$urxvt::term::proxy::AUTOLOAD' unparsable";
		407
		408	eval qq{
		409	sub $urxvt::term::proxy::AUTOLOAD {
		410	unshift \@_, shift->{term};
		411	goto &urxvt::term::$1;
		412	}
		413	1
		414	} or die "FATAL: unable to compile method forwarder: $@";
		415
		416	goto &$urxvt::term::proxy::AUTOLOAD;
		417	}
233		418
234	=head2 The C<urxvt::term> Class	419	=head2 The C<urxvt::term> Class
235		420
236	=over 4	421	=over 4
237		422
…		…
258		443
259	answerbackstring backgroundPixmap backspace_key boldFont boldItalicFont	444	answerbackstring backgroundPixmap backspace_key boldFont boldItalicFont
260	borderLess color cursorBlink cursorUnderline cutchars delete_key	445	borderLess color cursorBlink cursorUnderline cutchars delete_key
261	display_name embed ext_bwidth fade font geometry hold iconName	446	display_name embed ext_bwidth fade font geometry hold iconName
262	imFont imLocale inputMethod insecure int_bwidth intensityStyles	447	imFont imLocale inputMethod insecure int_bwidth intensityStyles
263	italicFont jumpScroll lineSpace loginShell mapAlert menu meta8	448	italicFont jumpScroll lineSpace loginShell mapAlert menu meta8 modifier
264	modifier mouseWheelScrollPage name pastableTabs path pointerBlank	449	mouseWheelScrollPage name pastableTabs path perl_eval perl_ext
265	pointerBlankDelay preeditType print_pipe pty_fd reverseVideo saveLines	450	perl_lib pointerBlank pointerBlankDelay preeditType print_pipe pty_fd
266	scrollBar scrollBar_align scrollBar_floating scrollBar_right	451	reverseVideo saveLines scrollBar scrollBar_align scrollBar_floating
267	scrollBar_thickness scrollTtyKeypress scrollTtyOutput scrollWithBuffer	452	scrollBar_right scrollBar_thickness scrollTtyKeypress scrollTtyOutput
268	scrollstyle secondaryScreen secondaryScroll selectstyle shade term_name	453	scrollWithBuffer scrollstyle secondaryScreen secondaryScroll selectstyle
269	title transparent transparent_all tripleclickwords utmpInhibit	454	shade term_name title transparent transparent_all tripleclickwords
270	visualBell	455	utmpInhibit visualBell
271		456
272	=cut	457	=cut
273		458
274	sub urxvt::term::resource($$;$) {	459	sub urxvt::term::resource($$;$) {
275	my ($self, $name) = (shift, shift);	460	my ($self, $name) = (shift, shift);
…		…
293		478
294	=item $oldtext = $term->selection ([$newtext])	479	=item $oldtext = $term->selection ([$newtext])
295		480
296	Return the current selection text and optionally replace it by C<$newtext>.	481	Return the current selection text and optionally replace it by C<$newtext>.
297		482
298	=item $term->scr_overlay ($x, $y, $text)	483	#=item $term->overlay ($x, $y, $text)
299		484	#
300	Create a simple multi-line overlay box. See the next method for details.	485	#Create a simple multi-line overlay box. See the next method for details.
301		486	#
302	=cut	487	#=cut
303		488
304	sub urxvt::term::scr_overlay {	489	sub urxvt::term::scr_overlay {
		490	die;
305	my ($self, $x, $y, $text) = @_;	491	my ($self, $x, $y, $text) = @_;
306		492
307	my @lines = split /\n/, $text;	493	my @lines = split /\n/, $text;
308		494
309	my $w = 0;	495	my $w = 0;
310	for (map urxvt::wcswidth $_, @lines) {	496	for (map $self->strwidth ($_), @lines) {
311	$w = $_ if $w < $_;	497	$w = $_ if $w < $_;
312	}	498	}
313		499
314	$self->scr_overlay_new ($x, $y, $w, scalar @lines);	500	$self->scr_overlay_new ($x, $y, $w, scalar @lines);
315	$self->scr_overlay_set (0, $_, $lines[$_]) for 0.. $#lines;	501	$self->scr_overlay_set (0, $_, $lines[$_]) for 0.. $#lines;
316	}	502	}
317		503
318	=item $term->scr_overlay_new ($x, $y, $width, $height)	504	=item $term->overlay ($x, $y, $width, $height[, $rstyle[, $border]])
319		505
320	Create a new (empty) overlay at the given position with the given	506	Create a new (empty) overlay at the given position with the given
321	width/height. A border will be put around the box. If either C<$x> or	507	width/height. C<$rstyle> defines the initial rendition style
322	C<$y> is negative, then this is counted from the right/bottom side,	508	(default: C<OVERLAY_RSTYLE>).
323	respectively.
324		509
325	=item $term->scr_overlay_off	510	If C<$border> is C<2> (default), then a decorative border will be put
		511	around the box.
326		512
327	Switch the overlay off again.	513	If either C<$x> or C<$y> is negative, then this is counted from the
		514	right/bottom side, respectively.
328		515
329	=item $term->scr_overlay_set_char ($x, $y, $char, $rend = OVERLAY_RSTYLE)	516	This method returns an urxvt::overlay object. The overlay will be visible
		517	as long as the perl object is referenced.
330		518
331	Put a single character (specified numerically) at the given overlay	519	The methods currently supported on C<urxvt::overlay> objects are:
332	position.
333		520
		521	=over 4
		522
334	=item $term->scr_overlay_set ($x, $y, $text)	523	=item $overlay->set ($x, $y, $text, $rend)
335		524
336	Write a string at the given position into the overlay.	525	Similar to C<< $term->ROW_t >> and C<< $term->ROW_r >> in that it puts
		526	text in rxvt-unicode's special encoding and an array of rendition values
		527	at a specific position inside the overlay.
		528
		529	=item $overlay->hide
		530
		531	If visible, hide the overlay, but do not destroy it.
		532
		533	=item $overlay->show
		534
		535	If hidden, display the overlay again.
		536
		537	=back
		538
		539	=item $cellwidth = $term->strwidth $string
		540
		541	Returns the number of screen-cells this string would need. Correctly
		542	accounts for wide and combining characters.
		543
		544	=item $octets = $term->locale_encode $string
		545
		546	Convert the given text string into the corresponding locale encoding.
		547
		548	=item $string = $term->locale_decode $octets
		549
		550	Convert the given locale-encoded octets into a perl string.
		551
		552	=item $term->tt_write ($octets)
		553
		554	Write the octets given in C<$data> to the tty (i.e. as program input). To
		555	pass characters instead of octets, you should convert your strings first
		556	to the locale-specific encoding using C<< $term->locale_encode >>.
		557
		558	=item $nrow = $term->nrow
		559
		560	=item $ncol = $term->ncol
		561
		562	Return the number of rows/columns of the terminal window (i.e. as
		563	specified by C<-geometry>, excluding any scrollback).
		564
		565	=item $nsaved = $term->nsaved
		566
		567	Returns the number of lines in the scrollback buffer.
		568
		569	=item $view_start = $term->view_start ([$newvalue])
		570
		571	Returns the negative row number of the topmost line. Minimum value is
		572	C<0>, which displays the normal terminal contents. Larger values scroll
		573	this many lines into the scrollback buffer.
		574
		575	=item $term->want_refresh
		576
		577	Requests a screen refresh. At the next opportunity, rxvt-unicode will
		578	compare the on-screen display with its stored representation. If they
		579	differ, it redraws the differences.
		580
		581	Used after changing terminal contents to display them.
		582
		583	=item $text = $term->ROW_t ($row_number[, $new_text[, $start_col]])
		584
		585	Returns the text of the entire row with number C<$row_number>. Row C<0>
		586	is the topmost terminal line, row C<< $term->$ncol-1 >> is the bottommost
		587	terminal line. The scrollback buffer starts at line C<-1> and extends to
		588	line C<< -$term->nsaved >>.
		589
		590	If C<$new_text> is specified, it will replace characters in the current
		591	line, starting at column C<$start_col> (default C<0>), which is useful
		592	to replace only parts of a line. The font index in the rendition will
		593	automatically be updated.
		594
		595	C<$text> is in a special encoding: tabs and wide characters that use more
		596	than one cell when displayed are padded with urxvt::NOCHAR characters
		597	(C<chr 65535>). Characters with combining characters and other characters
		598	that do not fit into the normal tetx encoding will be replaced with
		599	characters in the private use area.
		600
		601	You have to obey this encoding when changing text. The advantage is
		602	that C<substr> and similar functions work on screen cells and not on
		603	characters.
		604
		605	The methods C<< $term->special_encode >> and C<< $term->special_decode >>
		606	can be used to convert normal strings into this encoding and vice versa.
		607
		608	=item $rend = $term->ROW_r ($row_number[, $new_rend[, $start_col]])
		609
		610	Like C<< $term->ROW_t >>, but returns an arrayref with rendition
		611	bitsets. Rendition bitsets contain information about colour, font, font
		612	styles and similar information. See also C<< $term->ROW_t >>.
		613
		614	When setting rendition, the font mask will be ignored.
		615
		616	See the section on RENDITION, above.
		617
		618	=item $length = $term->ROW_l ($row_number[, $new_length])
		619
		620	Returns the number of screen cells that are in use ("the line length"). If
		621	it is C<-1>, then the line is part of a multiple-row logical "line", which
		622	means all characters are in use and it is continued on the next row.
		623
		624	=item $text = $term->special_encode $string
		625
		626	Converts a perl string into the special encoding used by rxvt-unicode,
		627	where one character corresponds to one screen cell. See
		628	C<< $term->ROW_t >> for details.
		629
		630	=item $string = $term->special_decode $text
		631
		632	Converts rxvt-unicodes text reprsentation into a perl string. See
		633	C<< $term->ROW_t >> for details.
337		634
338	=back	635	=back
339		636
340	=head2 The C<urxvt::timer> Class	637	=head2 The C<urxvt::timer> Class
341		638
342	This class implements timer watchers/events. Time is represented as a	639	This class implements timer watchers/events. Time is represented as a
343	fractional number of seconds since the epoch. Example:	640	fractional number of seconds since the epoch. Example:
344		641
345	# create a digital clock display in upper right corner	642	$term->{overlay} = $term->overlay (-1, 0, 8, 1, urxvt::OVERLAY_RSTYLE, 0);
346	$term->{timer} = urxvt::timer	643	$term->{timer} = urxvt::timer
347	->new	644	->new
348	->start (urxvt::NOW)	645	->interval (1)
349	->cb (sub {	646	->cb (sub {
350	my ($timer) = @_;
351	my $time = $timer->at;
352	$timer->start ($time + 1);
353	$self->scr_overlay (-1, 0,	647	$term->{overlay}->set (0, 0,
354	POSIX::strftime "%H:%M:%S", localtime $time);	648	sprintf "%2d:%02d:%02d", (localtime urxvt::NOW)[2,1,0]);
355	});	649	});
356		650
357	=over 4	651	=over 4
358		652
359	=item $timer = new urxvt::timer	653	=item $timer = new urxvt::timer
360		654
361	Create a new timer object in stopped state.	655	Create a new timer object in started state. It is scheduled to fire
		656	immediately.
362		657
363	=item $timer = $timer->cb (sub { my ($timer) = @_; ... })	658	=item $timer = $timer->cb (sub { my ($timer) = @_; ... })
364		659
365	Set the callback to be called when the timer triggers.	660	Set the callback to be called when the timer triggers.
366		661
…		…
369	Return the time this watcher will fire next.	664	Return the time this watcher will fire next.
370		665
371	=item $timer = $timer->set ($tstamp)	666	=item $timer = $timer->set ($tstamp)
372		667
373	Set the time the event is generated to $tstamp.	668	Set the time the event is generated to $tstamp.
		669
		670	=item $timer = $timer->interval ($interval)
		671
		672	Normally (and when C<$interval> is C<0>), the timer will automatically
		673	stop after it has fired once. If C<$interval> is non-zero, then the timer
		674	is automatically rescheduled at the given intervals.
374		675
375	=item $timer = $timer->start	676	=item $timer = $timer->start
376		677
377	Start the timer.	678	Start the timer.
378		679

Diff Legend

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

Comparing rxvt-unicode/src/urxvt.pm (file contents): Revision 1.5 by root, Mon Jan 2 17:20:00 2006 UTC vs. Revision 1.23 by root, Tue Jan 3 19:42:53 2006 UTC

Diff Legend

Comparing rxvt-unicode/src/urxvt.pm (file contents):
Revision 1.5 by root, Mon Jan 2 17:20:00 2006 UTC vs.
Revision 1.23 by root, Tue Jan 3 19:42:53 2006 UTC