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

Comparing rxvt-unicode/src/urxvt.pm (file contents):
Revision 1.7 by root, Mon Jan 2 19:05:05 2006 UTC vs.
Revision 1.24 by root, Tue Jan 3 20:47:36 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	* Scripts are evaluated in a 'use strict' and 'use utf8' environment, and
10	thus must be encoded as UTF-8.
11		10
12	sub on_sel_grab {	11	sub on_sel_grab {
13	warn "you selected ", $_[0]->selection;	12	warn "you selected ", $_[0]->selection;
14	()	13	()
15	}	14	}
16		15
17	1	16	# start a @@RXVT_NAME@@ using it:
		17
		18	@@RXVT_NAME@@ --perl-lib $HOME -pe grab_test
18		19
19	=head1 DESCRIPTION	20	=head1 DESCRIPTION
20		21
21	On startup, @@RXVT_NAME@@ will scan F<@@RXVT_LIBDIR@@/urxvt/perl-ext/>	22	Everytime a terminal object gets created, scripts specified via the
22	for files and will load them. Everytime a terminal object gets created,	23	C<perl> resource are loaded and associated with it.
23	the directory specified by the C<perl-lib> resource will be additionally	24
24	scanned.	25	Scripts are compiled in a 'use strict' and 'use utf8' environment, and
		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 for all terminals.	29	scripts will be shared (but not enabled) for all terminals.
28		30
29	Hooks in scripts specified by C<perl-lib> will only be called for the	31	=head2 Prepackaged Extensions
30	terminals created with that specific option value.	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
31		70
32	=head2 General API Considerations	71	=head2 General API Considerations
33		72
34	All objects (such as terminals, time watchers etc.) are typical	73	All objects (such as terminals, time watchers etc.) are typical
35	reference-to-hash objects. The hash can be used to store anything you	74	reference-to-hash objects. The hash can be used to store anything you
36	like. All members starting with an underscore (such as C<_ptr> or	75	like. All members starting with an underscore (such as C<_ptr> or
37	C<_hook>) are reserved for internal uses and must not be accessed or	76	C<_hook>) are reserved for internal uses and B<MUST NOT> be accessed or
38	modified).	77	modified).
39		78
40	When objects are destroyed on the C++ side, the perl object hashes are	79	When objects are destroyed on the C++ side, the perl object hashes are
41	emptied, so its best to store related objects such as time watchers and	80	emptied, so its best to store related objects such as time watchers and
42	the like inside the terminal object so they get destroyed as soon as the	81	the like inside the terminal object so they get destroyed as soon as the
43	terminal is destroyed.	82	terminal is destroyed.
44		83
45	=head2 Hooks	84	=head2 Hooks
46		85
47	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
48	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.
49		94
50	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
51	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,
52	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.
53		98
85	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
86	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
87	by calling C<< $term->selection >>.	132	by calling C<< $term->selection >>.
88		133
89	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.
90		144
91	=item on_focus_in $term	145	=item on_focus_in $term
92		146
93	Called whenever the window gets the keyboard focus, before urxvt does	147	Called whenever the window gets the keyboard focus, before urxvt does
94	focus in processing.	148	focus in processing.
…		…
127		181
128	=item on_refresh_end $term	182	=item on_refresh_end $term
129		183
130	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>.
131		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
132	=back	203	=back
133		204
134	=head2 Functions in the C<urxvt> Package	205	=head2 Functions in the C<urxvt> Package
135		206
136	=over 4	207	=over 4
…		…
152		223
153	=item $time = urxvt::NOW	224	=item $time = urxvt::NOW
154		225
155	Returns the "current time" (as per the event loop).	226	Returns the "current time" (as per the event loop).
156		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
157	=cut	282	=cut
158		283
159	package urxvt;	284	package urxvt;
160		285
161	use strict;	286	use strict;
		287	use Scalar::Util ();
162		288
163	our $term;	289	our $TERM;
164	our @HOOKNAME;	290	our @HOOKNAME;
165	our $LIBDIR;	291	our $LIBDIR;
166		292
167	BEGIN {	293	BEGIN {
168	urxvt->bootstrap;	294	urxvt->bootstrap;
…		…
174	unless $msg =~ /\n$/;	300	unless $msg =~ /\n$/;
175	urxvt::warn ($msg);	301	urxvt::warn ($msg);
176	};	302	};
177	}	303	}
178		304
		305	my @hook_count;
179	my $verbosity = $ENV{URXVT_PERL_VERBOSITY};	306	my $verbosity = $ENV{URXVT_PERL_VERBOSITY};
180		307
181	sub verbose {	308	sub verbose {
182	my ($level, $msg) = @_;	309	my ($level, $msg) = @_;
183	warn "$msg\n" if $level < $verbosity;	310	warn "$msg\n" if $level <= $verbosity;
184	}
185
186	my %hook_global;
187	my @hook_count;
188
189	# called by the rxvt core
190	sub invoke {
191	local $term = shift;
192	my $htype = shift;
193
194	verbose 10, "$HOOKNAME[$htype] (" . (join ", ", $term, @_) . ")"
195	if $verbosity >= 10;
196
197	for my $cb ($hook_global{_hook}[$htype], $term->{_hook}[$htype]) {
198	$cb or next;
199
200	while (my ($k, $v) = each %$cb) {
201	return 1 if $v->($term, @_);
202	}
203	}
204
205	0
206	}	311	}
207		312
208	# find on_xxx subs in the package and register them	313	# find on_xxx subs in the package and register them
209	# as hooks	314	# as hooks
210	sub register_package($) {	315	sub register_package($) {
…		…
214	my $name = $HOOKNAME[$htype];	319	my $name = $HOOKNAME[$htype];
215		320
216	my $ref = $pkg->can ("on_" . lc $name)	321	my $ref = $pkg->can ("on_" . lc $name)
217	or next;	322	or next;
218		323
219	$term->{_hook}[$htype]{$ref*1} = $ref;	324	$TERM->{_hook}[$htype]{$pkg} = $ref;
220	$hook_count[$htype]++	325	$hook_count[$htype]++
221	or set_should_invoke $htype, 1;	326	or set_should_invoke $htype, 1;
222	}	327	}
223	}	328	}
224		329
…		…
228	# load a single script into its own package, once only	333	# load a single script into its own package, once only
229	sub script_package($) {	334	sub script_package($) {
230	my ($path) = @_;	335	my ($path) = @_;
231		336
232	$script_pkg{$path} \|\|= do {	337	$script_pkg{$path} \|\|= do {
233	my $pkg = $script_pkg++;	338	my $pkg = "urxvt::" . ($script_pkg++);
		339
234	verbose 3, "loading script '$path' into package '$pkg'";	340	verbose 3, "loading script '$path' into package '$pkg'";
235		341
236	open my $fh, "<:raw", $path	342	open my $fh, "<:raw", $path
237	or die "$path: $!";	343	or die "$path: $!";
238		344
239	eval "package $pkg; use strict; use utf8;\n"	345	my $source = "package $pkg; use strict; use utf8;\n"
240	. "#line 1 \"$path\"\n"	346	. "#line 1 \"$path\"\n{\n"
241	. do { local $/; <$fh> }	347	. (do { local $/; <$fh> })
		348	. "\n};\n1";
		349
242	or die "$path: $@";	350	eval $source or die "$path: $@";
243		351
244	$pkg	352	$pkg
245	}	353	}
246	}	354	}
247		355
248	sub load_scripts($) {	356	# called by the rxvt core
249	my ($dir) = @_;	357	sub invoke {
		358	local $TERM = shift;
		359	my $htype = shift;
250		360
251	verbose 3, "loading scripts from '$dir'";	361	if ($htype == 0) { # INIT
		362	my @dirs = ((split /:/, $TERM->resource ("perl_lib")), "$LIBDIR/perl");
252		363
		364	for my $ext (split /:/, $TERM->resource ("perl_ext")) {
		365	my @files = grep -f $_, map "$_/$ext", @dirs;
		366
		367	if (@files) {
253	register_package script_package $_	368	register_package script_package $files[0];
254	for grep -f $_,	369	} else {
255	<$dir/*>;	370	warn "perl extension '$ext' not found in perl library search path\n";
256	}	371	}
		372	}
257		373
258	sub on_init {	374	} elsif ($htype == 1) { # DESTROY
259	my ($term) = @_;	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	}
260		382
261	my $libdir = $term->resource ("perl_lib");	383	my $cb = $TERM->{_hook}[$htype]
262
263	load_scripts $libdir
264	if defined $libdir;
265	}
266
267	sub on_destroy {
268	my ($term) = @_;
269
270	my $hook = $term->{_hook}
271	or return;	384	or return;
272		385
273	for my $htype (0..$#$hook) {	386	verbose 10, "$HOOKNAME[$htype] (" . (join ", ", $TERM, @_) . ")"
274	$hook_count[$htype] -= scalar keys %{ $hook->[$htype] \|\| {} }	387	if $verbosity >= 10;
275	or set_should_invoke $htype, 0;	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	);
276	}	399	}
277	}
278		400
279	{	401	0
280	local $term = \%hook_global;
281
282	register_package __PACKAGE__;
283	load_scripts "$LIBDIR/perl-ext";
284	}	402	}
285		403
286	=back	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	my \$proxy = shift;
		411	\$proxy->{term}->$1 (\@_)
		412	}
		413	1
		414	} or die "FATAL: unable to compile method forwarder: $@";
		415
		416	goto &$urxvt::term::proxy::AUTOLOAD;
		417	}
287		418
288	=head2 The C<urxvt::term> Class	419	=head2 The C<urxvt::term> Class
289		420
290	=over 4	421	=over 4
291		422
…		…
312		443
313	answerbackstring backgroundPixmap backspace_key boldFont boldItalicFont	444	answerbackstring backgroundPixmap backspace_key boldFont boldItalicFont
314	borderLess color cursorBlink cursorUnderline cutchars delete_key	445	borderLess color cursorBlink cursorUnderline cutchars delete_key
315	display_name embed ext_bwidth fade font geometry hold iconName	446	display_name embed ext_bwidth fade font geometry hold iconName
316	imFont imLocale inputMethod insecure int_bwidth intensityStyles	447	imFont imLocale inputMethod insecure int_bwidth intensityStyles
317	italicFont jumpScroll lineSpace loginShell mapAlert menu meta8	448	italicFont jumpScroll lineSpace loginShell mapAlert menu meta8 modifier
318	modifier mouseWheelScrollPage name pastableTabs path perl perl_eval	449	mouseWheelScrollPage name pastableTabs path perl_eval perl_ext
319	perl_lib pointerBlank pointerBlankDelay preeditType print_pipe pty_fd	450	perl_lib pointerBlank pointerBlankDelay preeditType print_pipe pty_fd
320	reverseVideo saveLines scrollBar scrollBar_align scrollBar_floating	451	reverseVideo saveLines scrollBar scrollBar_align scrollBar_floating
321	scrollBar_right scrollBar_thickness scrollTtyKeypress scrollTtyOutput	452	scrollBar_right scrollBar_thickness scrollTtyKeypress scrollTtyOutput
322	scrollWithBuffer scrollstyle secondaryScreen secondaryScroll selectstyle	453	scrollWithBuffer scrollstyle secondaryScreen secondaryScroll selectstyle
323	shade term_name title transparent transparent_all tripleclickwords	454	shade term_name title transparent transparent_all tripleclickwords
…		…
347		478
348	=item $oldtext = $term->selection ([$newtext])	479	=item $oldtext = $term->selection ([$newtext])
349		480
350	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>.
351		482
352	=item $term->scr_overlay ($x, $y, $text)	483	#=item $term->overlay ($x, $y, $text)
353		484	#
354	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.
355		486	#
356	=cut	487	#=cut
357		488
358	sub urxvt::term::scr_overlay {	489	sub urxvt::term::scr_overlay {
		490	die;
359	my ($self, $x, $y, $text) = @_;	491	my ($self, $x, $y, $text) = @_;
360		492
361	my @lines = split /\n/, $text;	493	my @lines = split /\n/, $text;
362		494
363	my $w = 0;	495	my $w = 0;
…		…
367		499
368	$self->scr_overlay_new ($x, $y, $w, scalar @lines);	500	$self->scr_overlay_new ($x, $y, $w, scalar @lines);
369	$self->scr_overlay_set (0, $_, $lines[$_]) for 0.. $#lines;	501	$self->scr_overlay_set (0, $_, $lines[$_]) for 0.. $#lines;
370	}	502	}
371		503
372	=item $term->scr_overlay_new ($x, $y, $width, $height)	504	=item $term->overlay ($x, $y, $width, $height[, $rstyle[, $border]])
373		505
374	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
375	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
376	C<$y> is negative, then this is counted from the right/bottom side,	508	(default: C<OVERLAY_RSTYLE>).
377	respectively.
378		509
379	=item $term->scr_overlay_off	510	If C<$border> is C<2> (default), then a decorative border will be put
		511	around the box.
380		512
381	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.
382		515
383	=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.
384		518
385	Put a single character (specified numerically) at the given overlay	519	The methods currently supported on C<urxvt::overlay> objects are:
386	position.
387		520
		521	=over 4
		522
388	=item $term->scr_overlay_set ($x, $y, $text)	523	=item $overlay->set ($x, $y, $text, $rend)
389		524
390	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
391		538
392	=item $cellwidth = $term->strwidth $string	539	=item $cellwidth = $term->strwidth $string
393		540
394	Returns the number of screen-cells this string would need. Correctly	541	Returns the number of screen-cells this string would need. Correctly
395	accounts for wide and combining characters.	542	accounts for wide and combining characters.
…		…
403	Convert the given locale-encoded octets into a perl string.	550	Convert the given locale-encoded octets into a perl string.
404		551
405	=item $term->tt_write ($octets)	552	=item $term->tt_write ($octets)
406		553
407	Write the octets given in C<$data> to the tty (i.e. as program input). To	554	Write the octets given in C<$data> to the tty (i.e. as program input). To
408	pass characters instead of octets, you should convetr you strings first to	555	pass characters instead of octets, you should convert your strings first
409	the locale-specific encoding using C<< $term->locale_encode >>.	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 >>. Nothing will be returned if a nonexistent line
		589	is requested.
		590
		591	If C<$new_text> is specified, it will replace characters in the current
		592	line, starting at column C<$start_col> (default C<0>), which is useful
		593	to replace only parts of a line. The font index in the rendition will
		594	automatically be updated.
		595
		596	C<$text> is in a special encoding: tabs and wide characters that use more
		597	than one cell when displayed are padded with urxvt::NOCHAR characters
		598	(C<chr 65535>). Characters with combining characters and other characters
		599	that do not fit into the normal tetx encoding will be replaced with
		600	characters in the private use area.
		601
		602	You have to obey this encoding when changing text. The advantage is
		603	that C<substr> and similar functions work on screen cells and not on
		604	characters.
		605
		606	The methods C<< $term->special_encode >> and C<< $term->special_decode >>
		607	can be used to convert normal strings into this encoding and vice versa.
		608
		609	=item $rend = $term->ROW_r ($row_number[, $new_rend[, $start_col]])
		610
		611	Like C<< $term->ROW_t >>, but returns an arrayref with rendition
		612	bitsets. Rendition bitsets contain information about colour, font, font
		613	styles and similar information. See also C<< $term->ROW_t >>.
		614
		615	When setting rendition, the font mask will be ignored.
		616
		617	See the section on RENDITION, above.
		618
		619	=item $length = $term->ROW_l ($row_number[, $new_length])
		620
		621	Returns the number of screen cells that are in use ("the line
		622	length"). Unlike the urxvt core, this returns C<< $term->ncol >> if the
		623	line is joined with the following one.
		624
		625	=item $bool = $term->is_longer ($row_number)
		626
		627	Returns true if the row is part of a multiple-row logical "line" (i.e.
		628	joined with the following row), which means all characters are in use
		629	and it is continued on the next row (and possibly a continuation of the
		630	previous row(s)).
		631
		632	=item $line = $term->line ($row_number)
		633
		634	Create and return a new C<urxvt::line> object that stores information
		635	about the logical line that row C<$row_number> is part of. It supports the
		636	following methods:
		637
		638	=over 4
		639
		640	=item $text = $line->t
		641
		642	Returns the full text of the line, similar to C<ROW_t>
		643
		644	=item $rend = $line->r
		645
		646	Returns the full rendition array of the line, similar to C<ROW_r>
		647
		648	=item $length = $line->l
		649
		650	Returns the length of the line in cells, similar to C<ROW_l>.
		651
		652	=item $rownum = $line->beg
		653
		654	=item $rownum = $line->end
		655
		656	Return the row number of the first/last row of the line, respectively.
		657
		658	=item $offset = $line->offset_of ($row, $col)
		659
		660	Returns the character offset of the given row\|col pair within the logical
		661	line.
		662
		663	=item ($row, $col) = $line->coord_of ($offset)
		664
		665	Translates a string offset into terminal coordinates again.
		666
		667	=back
		668
		669	=cut
		670
		671	sub urxvt::term::line {
		672	my ($self, $row) = @_;
		673
		674	my $maxrow = $self->nrow - 1;
		675
		676	my ($beg, $end) = ($row, $row);
		677
		678	--$beg while $self->ROW_is_longer ($beg - 1);
		679	++$end while $self->ROW_is_longer ($end) && $end < $maxrow;
		680
		681	bless {
		682	term => $self,
		683	beg => $beg,
		684	end => $end,
		685	len => ($end - $beg) * $self->ncol + $self->ROW_l ($end),
		686	}, urxvt::line::
		687	}
		688
		689	sub urxvt::line::t {
		690	my ($self) = @_;
		691
		692	substr +(join "", map $self->{term}->ROW_t ($_), $self->{beg} .. $self->{end}),
		693	0, $self->{len}
		694	}
		695
		696	sub urxvt::line::r {
		697	my ($self) = @_;
		698
		699	my $rend = [
		700	map @{ $self->{term}->ROW_r ($_) }, $self->{beg} .. $self->{end}
		701	];
		702	$#$rend = $self->{len} - 1;
		703	$rend
		704	}
		705
		706	sub urxvt::line::beg { $_[0]{beg} }
		707	sub urxvt::line::end { $_[0]{end} }
		708	sub urxvt::line::l { $_[0]{len} }
		709
		710	sub urxvt::line::offset_of {
		711	my ($self, $row, $col) = @_;
		712
		713	($row - $self->{beg}) * $self->{term}->ncol + $col
		714	}
		715
		716	sub urxvt::line::coord_of {
		717	my ($self, $offset) = @_;
		718
		719	use integer;
		720
		721	(
		722	$offset / $self->{term}->ncol + $self->{beg},
		723	$offset % $self->{term}->ncol
		724	)
		725	}
		726
		727	=item ($row, $col) = $line->coord_of ($offset)
		728	=item $text = $term->special_encode $string
		729
		730	Converts a perl string into the special encoding used by rxvt-unicode,
		731	where one character corresponds to one screen cell. See
		732	C<< $term->ROW_t >> for details.
		733
		734	=item $string = $term->special_decode $text
		735
		736	Converts rxvt-unicodes text reprsentation into a perl string. See
		737	C<< $term->ROW_t >> for details.
410		738
411	=back	739	=back
412		740
413	=head2 The C<urxvt::timer> Class	741	=head2 The C<urxvt::timer> Class
414		742
415	This class implements timer watchers/events. Time is represented as a	743	This class implements timer watchers/events. Time is represented as a
416	fractional number of seconds since the epoch. Example:	744	fractional number of seconds since the epoch. Example:
417		745
418	# create a digital clock display in upper right corner	746	$term->{overlay} = $term->overlay (-1, 0, 8, 1, urxvt::OVERLAY_RSTYLE, 0);
419	$term->{timer} = urxvt::timer	747	$term->{timer} = urxvt::timer
420	->new	748	->new
421	->start (urxvt::NOW)	749	->interval (1)
422	->cb (sub {	750	->cb (sub {
423	my ($timer) = @_;
424	my $time = $timer->at;
425	$timer->start ($time + 1);
426	$self->scr_overlay (-1, 0,	751	$term->{overlay}->set (0, 0,
427	POSIX::strftime "%H:%M:%S", localtime $time);	752	sprintf "%2d:%02d:%02d", (localtime urxvt::NOW)[2,1,0]);
428	});	753	});
429		754
430	=over 4	755	=over 4
431		756
432	=item $timer = new urxvt::timer	757	=item $timer = new urxvt::timer
433		758
434	Create a new timer object in stopped state.	759	Create a new timer object in started state. It is scheduled to fire
		760	immediately.
435		761
436	=item $timer = $timer->cb (sub { my ($timer) = @_; ... })	762	=item $timer = $timer->cb (sub { my ($timer) = @_; ... })
437		763
438	Set the callback to be called when the timer triggers.	764	Set the callback to be called when the timer triggers.
439		765
…		…
442	Return the time this watcher will fire next.	768	Return the time this watcher will fire next.
443		769
444	=item $timer = $timer->set ($tstamp)	770	=item $timer = $timer->set ($tstamp)
445		771
446	Set the time the event is generated to $tstamp.	772	Set the time the event is generated to $tstamp.
		773
		774	=item $timer = $timer->interval ($interval)
		775
		776	Normally (and when C<$interval> is C<0>), the timer will automatically
		777	stop after it has fired once. If C<$interval> is non-zero, then the timer
		778	is automatically rescheduled at the given intervals.
447		779
448	=item $timer = $timer->start	780	=item $timer = $timer->start
449		781
450	Start the timer.	782	Start the timer.
451		783

Diff Legend

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

Comparing rxvt-unicode/src/urxvt.pm (file contents): Revision 1.7 by root, Mon Jan 2 19:05:05 2006 UTC vs. Revision 1.24 by root, Tue Jan 3 20:47:36 2006 UTC

Diff Legend

Comparing rxvt-unicode/src/urxvt.pm (file contents):
Revision 1.7 by root, Mon Jan 2 19:05:05 2006 UTC vs.
Revision 1.24 by root, Tue Jan 3 20:47:36 2006 UTC