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

Comparing rxvt-unicode/src/urxvt.pm (file contents):
Revision 1.4 by root, Mon Jan 2 17:17:02 2006 UTC vs.
Revision 1.27 by root, Tue Jan 3 23:41:37 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 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
		72
		73	=head2 General API Considerations
		74
		75	All objects (such as terminals, time watchers etc.) are typical
		76	reference-to-hash objects. The hash can be used to store anything you
		77	like. All members starting with an underscore (such as C<_ptr> or
		78	C<_hook>) are reserved for internal uses and B<MUST NOT> be accessed or
		79	modified).
		80
		81	When objects are destroyed on the C++ side, the perl object hashes are
		82	emptied, so its best to store related objects such as time watchers and
		83	the like inside the terminal object so they get destroyed as soon as the
		84	terminal is destroyed.
		85
24	=head2 Hooks	86	=head2 Hooks
25		87
26	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
27	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.
28		96
29	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
30	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,
31	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.
32		100
64	Called whenever a selection has been copied, but before the selection is	132	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	133	requested from the server. The selection text can be queried and changed
66	by calling C<< $term->selection >>.	134	by calling C<< $term->selection >>.
67		135
68	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.
		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.
69		146
70	=item on_focus_in $term	147	=item on_focus_in $term
71		148
72	Called whenever the window gets the keyboard focus, before urxvt does	149	Called whenever the window gets the keyboard focus, before urxvt does
73	focus in processing.	150	focus in processing.
…		…
106		183
107	=item on_refresh_end $term	184	=item on_refresh_end $term
108		185
109	Called just after the screen gets redrawn. See C<on_refresh_begin>.	186	Called just after the screen gets redrawn. See C<on_refresh_begin>.
110		187
		188	=item on_keyboard_command $term, $string
		189
		190	Called whenever the user presses a key combination that has a
		191	C<perl:string> action bound to it (see description of the B<keysym>
		192	resource in the @@RXVT_NAME@@(1) manpage).
		193
		194	=back
		195
		196	=head2 Variables in the C<urxvt> Package
		197
		198	=over 4
		199
		200	=item $urxvt::TERM
		201
		202	The current terminal. Whenever a callback/Hook is bein executed, this
		203	variable stores the current C<urxvt::term> object.
		204
111	=back	205	=back
112		206
113	=head2 Functions in the C<urxvt> Package	207	=head2 Functions in the C<urxvt> Package
114		208
115	=over 4	209	=over 4
…		…
120	costs! The only time this is acceptable is when the terminal process	214	costs! The only time this is acceptable is when the terminal process
121	starts up.	215	starts up.
122		216
123	=item urxvt::warn $string	217	=item urxvt::warn $string
124		218
125	Calls C<rxvt_warn> witht eh given string which should not include a	219	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	220	newline. The module also overwrites the C<warn> builtin with a function
127	that calls this function.	221	that calls this function.
128		222
129	Using this function has the advantage that its output ends up in the	223	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.	224	correct place, e.g. on stderr of the connecting urxvtc client.
131		225
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	226	=item $time = urxvt::NOW
138		227
139	Returns the "current time" (as per the event loop).	228	Returns the "current time" (as per the event loop).
140		229
		230	=back
		231
		232	=head2 RENDITION
		233
		234	Rendition bitsets contain information about colour, font, font styles and
		235	similar information for each screen cell.
		236
		237	The following "macros" deal with changes in rendition sets. You should
		238	never just create a bitset, you should always modify an existing one,
		239	as they contain important information required for correct operation of
		240	rxvt-unicode.
		241
		242	=over 4
		243
		244	=item $rend = urxvt::DEFAULT_RSTYLE
		245
		246	Returns the default rendition, as used when the terminal is starting up or
		247	being reset. Useful as a base to start when creating renditions.
		248
		249	=item $rend = urxvt::OVERLAY_RSTYLE
		250
		251	Return the rendition mask used for overlays by default.
		252
		253	=item $rendbit = urxvt::RS_Bold, RS_Italic, RS_Blink, RS_RVid, RS_Uline
		254
		255	Return the bit that enabled bold, italic, blink, reverse-video and
		256	underline, respectively. To enable such a style, just logically OR it into
		257	the bitset.
		258
		259	=item $foreground = urxvt::GET_BASEFG $rend
		260
		261	=item $background = urxvt::GET_BASEBG $rend
		262
		263	Return the foreground/background colour index, respectively.
		264
		265	=item $rend = urxvt::SET_FGCOLOR ($rend, $new_colour)
		266
		267	=item $rend = urxvt::SET_BGCOLOR ($rend, $new_colour)
		268
		269	Replace the foreground/background colour in the rendition mask with the
		270	specified one.
		271
		272	=item $value = urxvt::GET_CUSTOM ($rend)
		273
		274	Return the "custom" value: Every rendition has 5 bits for use by
		275	extensions. They can be set and changed as you like and are initially
		276	zero.
		277
		278	=item $rend = urxvt::SET_CUSTOM ($rend, $new_value)
		279
		280	Change the custom value.
		281
		282	=back
		283
141	=cut	284	=cut
142		285
143	package urxvt;	286	package urxvt;
144		287
145	use strict;	288	use strict;
		289	use Scalar::Util ();
146		290
147	our $term;	291	our $TERM;
148	our @HOOKNAME;	292	our @HOOKNAME;
149	our $LIBDIR;	293	our $LIBDIR;
150		294
151	BEGIN {	295	BEGIN {
152	urxvt->bootstrap;	296	urxvt->bootstrap;
…		…
158	unless $msg =~ /\n$/;	302	unless $msg =~ /\n$/;
159	urxvt::warn ($msg);	303	urxvt::warn ($msg);
160	};	304	};
161	}	305	}
162		306
		307	my @hook_count;
163	my $verbosity = $ENV{URXVT_PERL_VERBOSITY} \|\| 10;	308	my $verbosity = $ENV{URXVT_PERL_VERBOSITY};
164		309
165	sub verbose {	310	sub verbose {
166	my ($level, $msg) = @_;	311	my ($level, $msg) = @_;
167	warn "$msg\n"; #d#	312	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	}	313	}
188		314
189	# find on_xxx subs in the package and register them	315	# find on_xxx subs in the package and register them
190	# as hooks	316	# as hooks
191	sub register_package($) {	317	sub register_package($) {
192	my ($pkg) = @_;	318	my ($pkg) = @_;
193		319
194	for my $hook (0.. $#HOOKNAME) {	320	for my $htype (0.. $#HOOKNAME) {
195	my $name = $HOOKNAME[$hook];	321	my $name = $HOOKNAME[$htype];
196		322
197	my $ref = $pkg->can ("on_" . lc $name)	323	my $ref = $pkg->can ("on_" . lc $name)
198	or next;	324	or next;
199		325
200	$invoke_cb[$hook]{$ref*1} = $ref;	326	$TERM->{_hook}[$htype]{$pkg} = $ref;
		327	$hook_count[$htype]++
201	set_should_invoke $hook, 1;	328	or set_should_invoke $htype, 1;
202	}	329	}
203	}	330	}
204		331
205	my $script_pkg = "script0000";	332	my $script_pkg = "script0000";
206	my %script_pkg;	333	my %script_pkg;
207		334
208	# load a single script into its own package, once only	335	# load a single script into its own package, once only
209	sub load_script($) {	336	sub script_package($) {
210	my ($path) = @_;	337	my ($path) = @_;
211		338
212	$script_pkg{$path} \|\|= do {	339	$script_pkg{$path} \|\|= do {
213	my $pkg = $script_pkg++;	340	my $pkg = "urxvt::" . ($script_pkg++);
		341
214	verbose 3, "loading script '$path' into package '$pkg'";	342	verbose 3, "loading script '$path' into package '$pkg'";
215		343
216	open my $fh, "<:raw", $path	344	open my $fh, "<:raw", $path
217	or die "$path: $!";	345	or die "$path: $!";
218		346
219	eval "package $pkg; use strict; use utf8;\n"	347	my $source = "package $pkg; use strict; use utf8;\n"
220	. "#line 1 \"$path\"\n"	348	. "#line 1 \"$path\"\n{\n"
221	. do { local $/; <$fh> }	349	. (do { local $/; <$fh> })
		350	. "\n};\n1";
		351
222	or die "$path: $@";	352	eval $source or die "$path: $@";
223
224	register_package $pkg;
225		353
226	$pkg	354	$pkg
227	};	355	}
228	}	356	}
229		357
230	load_script $_ for grep -f $_, <$LIBDIR/perl-ext/*>;	358	# called by the rxvt core
		359	sub invoke {
		360	local $TERM = shift;
		361	my $htype = shift;
231		362
232	=back	363	if ($htype == 0) { # INIT
		364	my @dirs = ((split /:/, $TERM->resource ("perl_lib")), "$LIBDIR/perl");
		365
		366	for my $ext (split /:/, $TERM->resource ("perl_ext")) {
		367	my @files = grep -f $_, map "$_/$ext", @dirs;
		368
		369	if (@files) {
		370	register_package script_package $files[0];
		371	} else {
		372	warn "perl extension '$ext' not found in perl library search path\n";
		373	}
		374	}
		375
		376	} elsif ($htype == 1) { # DESTROY
		377	if (my $hook = $TERM->{_hook}) {
		378	for my $htype (0..$#$hook) {
		379	$hook_count[$htype] -= scalar keys %{ $hook->[$htype] \|\| {} }
		380	or set_should_invoke $htype, 0;
		381	}
		382	}
		383	}
		384
		385	my $cb = $TERM->{_hook}[$htype]
		386	or return;
		387
		388	verbose 10, "$HOOKNAME[$htype] (" . (join ", ", $TERM, @_) . ")"
		389	if $verbosity >= 10;
		390
		391	keys %$cb;
		392
		393	while (my ($pkg, $cb) = each %$cb) {
		394	return 1
		395	if $cb->(
		396	$TERM->{$pkg} \|\|= do {
		397	my $proxy = bless { }, urxvt::term::proxy::;
		398	Scalar::Util::weaken ($proxy->{term} = $TERM);
		399	$proxy
		400	},
		401	@_,
		402	);
		403	}
		404
		405	0
		406	}
		407
		408	sub urxvt::term::proxy::AUTOLOAD {
		409	$urxvt::term::proxy::AUTOLOAD =~ /:([^:]+)$/
		410	or die "FATAL: \$AUTOLOAD '$urxvt::term::proxy::AUTOLOAD' unparsable";
		411
		412	eval qq{
		413	sub $urxvt::term::proxy::AUTOLOAD {
		414	my \$proxy = shift;
		415	\$proxy->{term}->$1 (\@_)
		416	}
		417	1
		418	} or die "FATAL: unable to compile method forwarder: $@";
		419
		420	goto &$urxvt::term::proxy::AUTOLOAD;
		421	}
233		422
234	=head2 The C<urxvt::term> Class	423	=head2 The C<urxvt::term> Class
235		424
236	=over 4	425	=over 4
237		426
…		…
249	as resource names of the form C<< color+<index> >>, e.g. C<color+5>. (will	438	as resource names of the form C<< color+<index> >>, e.g. C<color+5>. (will
250	likely change).	439	likely change).
251		440
252	Please note that resource strings will currently only be freed when the	441	Please note that resource strings will currently only be freed when the
253	terminal is destroyed, so changing options frequently will eat memory.	442	terminal is destroyed, so changing options frequently will eat memory.
		443
		444	Here is a a likely non-exhaustive list of resource names, not all of which
		445	are supported in every build, please see the source to see the actual
		446	list:
		447
		448	answerbackstring backgroundPixmap backspace_key boldFont boldItalicFont
		449	borderLess color cursorBlink cursorUnderline cutchars delete_key
		450	display_name embed ext_bwidth fade font geometry hold iconName
		451	imFont imLocale inputMethod insecure int_bwidth intensityStyles
		452	italicFont jumpScroll lineSpace loginShell mapAlert menu meta8 modifier
		453	mouseWheelScrollPage name pastableTabs path perl_eval perl_ext
		454	perl_lib pointerBlank pointerBlankDelay preeditType print_pipe pty_fd
		455	reverseVideo saveLines scrollBar scrollBar_align scrollBar_floating
		456	scrollBar_right scrollBar_thickness scrollTtyKeypress scrollTtyOutput
		457	scrollWithBuffer scrollstyle secondaryScreen secondaryScroll selectstyle
		458	shade term_name title transparent transparent_all tripleclickwords
		459	utmpInhibit visualBell
254		460
255	=cut	461	=cut
256		462
257	sub urxvt::term::resource($$;$) {	463	sub urxvt::term::resource($$;$) {
258	my ($self, $name) = (shift, shift);	464	my ($self, $name) = (shift, shift);
…		…
276		482
277	=item $oldtext = $term->selection ([$newtext])	483	=item $oldtext = $term->selection ([$newtext])
278		484
279	Return the current selection text and optionally replace it by C<$newtext>.	485	Return the current selection text and optionally replace it by C<$newtext>.
280		486
281	=item $term->scr_overlay ($x, $y, $text)	487	#=item $term->overlay ($x, $y, $text)
282		488	#
283	Create a simple multi-line overlay box. See the next method for details.	489	#Create a simple multi-line overlay box. See the next method for details.
284		490	#
285	=cut	491	#=cut
286		492
287	sub urxvt::term::scr_overlay {	493	sub urxvt::term::scr_overlay {
		494	die;
288	my ($self, $x, $y, $text) = @_;	495	my ($self, $x, $y, $text) = @_;
289		496
290	my @lines = split /\n/, $text;	497	my @lines = split /\n/, $text;
291		498
292	my $w = 0;	499	my $w = 0;
293	for (map urxvt::wcswidth $_, @lines) {	500	for (map $self->strwidth ($_), @lines) {
294	$w = $_ if $w < $_;	501	$w = $_ if $w < $_;
295	}	502	}
296		503
297	$self->scr_overlay_new ($x, $y, $w, scalar @lines);	504	$self->scr_overlay_new ($x, $y, $w, scalar @lines);
298	$self->scr_overlay_set (0, $_, $lines[$_]) for 0.. $#lines;	505	$self->scr_overlay_set (0, $_, $lines[$_]) for 0.. $#lines;
299	}	506	}
300		507
301	=item $term->scr_overlay_new ($x, $y, $width, $height)	508	=item $term->overlay ($x, $y, $width, $height[, $rstyle[, $border]])
302		509
303	Create a new (empty) overlay at the given position with the given	510	Create a new (empty) overlay at the given position with the given
304	width/height. A border will be put around the box. If either C<$x> or	511	width/height. C<$rstyle> defines the initial rendition style
305	C<$y> is negative, then this is counted from the right/bottom side,	512	(default: C<OVERLAY_RSTYLE>).
306	respectively.
307		513
308	=item $term->scr_overlay_off	514	If C<$border> is C<2> (default), then a decorative border will be put
		515	around the box.
309		516
310	Switch the overlay off again.	517	If either C<$x> or C<$y> is negative, then this is counted from the
		518	right/bottom side, respectively.
311		519
312	=item $term->scr_overlay_set_char ($x, $y, $char, $rend = OVERLAY_RSTYLE)	520	This method returns an urxvt::overlay object. The overlay will be visible
		521	as long as the perl object is referenced.
313		522
314	Put a single character (specified numerically) at the given overlay	523	The methods currently supported on C<urxvt::overlay> objects are:
315	position.
316		524
		525	=over 4
		526
317	=item $term->scr_overlay_set ($x, $y, $text)	527	=item $overlay->set ($x, $y, $text, $rend)
318		528
319	Write a string at the given position into the overlay.	529	Similar to C<< $term->ROW_t >> and C<< $term->ROW_r >> in that it puts
		530	text in rxvt-unicode's special encoding and an array of rendition values
		531	at a specific position inside the overlay.
		532
		533	=item $overlay->hide
		534
		535	If visible, hide the overlay, but do not destroy it.
		536
		537	=item $overlay->show
		538
		539	If hidden, display the overlay again.
		540
		541	=back
		542
		543	=item $cellwidth = $term->strwidth $string
		544
		545	Returns the number of screen-cells this string would need. Correctly
		546	accounts for wide and combining characters.
		547
		548	=item $octets = $term->locale_encode $string
		549
		550	Convert the given text string into the corresponding locale encoding.
		551
		552	=item $string = $term->locale_decode $octets
		553
		554	Convert the given locale-encoded octets into a perl string.
		555
		556	=item $term->tt_write ($octets)
		557
		558	Write the octets given in C<$data> to the tty (i.e. as program input). To
		559	pass characters instead of octets, you should convert your strings first
		560	to the locale-specific encoding using C<< $term->locale_encode >>.
		561
		562	=item $nrow = $term->nrow
		563
		564	=item $ncol = $term->ncol
		565
		566	Return the number of rows/columns of the terminal window (i.e. as
		567	specified by C<-geometry>, excluding any scrollback).
		568
		569	=item $nsaved = $term->nsaved
		570
		571	Returns the number of lines in the scrollback buffer.
		572
		573	=item $view_start = $term->view_start ([$newvalue])
		574
		575	Returns the negative row number of the topmost line. Minimum value is
		576	C<0>, which displays the normal terminal contents. Larger values scroll
		577	this many lines into the scrollback buffer.
		578
		579	=item $term->want_refresh
		580
		581	Requests a screen refresh. At the next opportunity, rxvt-unicode will
		582	compare the on-screen display with its stored representation. If they
		583	differ, it redraws the differences.
		584
		585	Used after changing terminal contents to display them.
		586
		587	=item $text = $term->ROW_t ($row_number[, $new_text[, $start_col]])
		588
		589	Returns the text of the entire row with number C<$row_number>. Row C<0>
		590	is the topmost terminal line, row C<< $term->$ncol-1 >> is the bottommost
		591	terminal line. The scrollback buffer starts at line C<-1> and extends to
		592	line C<< -$term->nsaved >>. Nothing will be returned if a nonexistent line
		593	is requested.
		594
		595	If C<$new_text> is specified, it will replace characters in the current
		596	line, starting at column C<$start_col> (default C<0>), which is useful
		597	to replace only parts of a line. The font index in the rendition will
		598	automatically be updated.
		599
		600	C<$text> is in a special encoding: tabs and wide characters that use more
		601	than one cell when displayed are padded with urxvt::NOCHAR characters
		602	(C<chr 65535>). Characters with combining characters and other characters
		603	that do not fit into the normal tetx encoding will be replaced with
		604	characters in the private use area.
		605
		606	You have to obey this encoding when changing text. The advantage is
		607	that C<substr> and similar functions work on screen cells and not on
		608	characters.
		609
		610	The methods C<< $term->special_encode >> and C<< $term->special_decode >>
		611	can be used to convert normal strings into this encoding and vice versa.
		612
		613	=item $rend = $term->ROW_r ($row_number[, $new_rend[, $start_col]])
		614
		615	Like C<< $term->ROW_t >>, but returns an arrayref with rendition
		616	bitsets. Rendition bitsets contain information about colour, font, font
		617	styles and similar information. See also C<< $term->ROW_t >>.
		618
		619	When setting rendition, the font mask will be ignored.
		620
		621	See the section on RENDITION, above.
		622
		623	=item $length = $term->ROW_l ($row_number[, $new_length])
		624
		625	Returns the number of screen cells that are in use ("the line
		626	length"). Unlike the urxvt core, this returns C<< $term->ncol >> if the
		627	line is joined with the following one.
		628
		629	=item $bool = $term->is_longer ($row_number)
		630
		631	Returns true if the row is part of a multiple-row logical "line" (i.e.
		632	joined with the following row), which means all characters are in use
		633	and it is continued on the next row (and possibly a continuation of the
		634	previous row(s)).
		635
		636	=item $line = $term->line ($row_number)
		637
		638	Create and return a new C<urxvt::line> object that stores information
		639	about the logical line that row C<$row_number> is part of. It supports the
		640	following methods:
		641
		642	=over 4
		643
		644	=item $text = $line->t
		645
		646	Returns the full text of the line, similar to C<ROW_t>
		647
		648	=item $rend = $line->r
		649
		650	Returns the full rendition array of the line, similar to C<ROW_r>
		651
		652	=item $length = $line->l
		653
		654	Returns the length of the line in cells, similar to C<ROW_l>.
		655
		656	=item $rownum = $line->beg
		657
		658	=item $rownum = $line->end
		659
		660	Return the row number of the first/last row of the line, respectively.
		661
		662	=item $offset = $line->offset_of ($row, $col)
		663
		664	Returns the character offset of the given row\|col pair within the logical
		665	line.
		666
		667	=item ($row, $col) = $line->coord_of ($offset)
		668
		669	Translates a string offset into terminal coordinates again.
		670
		671	=back
		672
		673	=cut
		674
		675	sub urxvt::term::line {
		676	my ($self, $row) = @_;
		677
		678	my $maxrow = $self->nrow - 1;
		679
		680	my ($beg, $end) = ($row, $row);
		681
		682	--$beg while $self->ROW_is_longer ($beg - 1);
		683	++$end while $self->ROW_is_longer ($end) && $end < $maxrow;
		684
		685	bless {
		686	term => $self,
		687	beg => $beg,
		688	end => $end,
		689	len => ($end - $beg) * $self->ncol + $self->ROW_l ($end),
		690	}, urxvt::line::
		691	}
		692
		693	sub urxvt::line::t {
		694	my ($self) = @_;
		695
		696	substr +(join "", map $self->{term}->ROW_t ($_), $self->{beg} .. $self->{end}),
		697	0, $self->{len}
		698	}
		699
		700	sub urxvt::line::r {
		701	my ($self) = @_;
		702
		703	my $rend = [
		704	map @{ $self->{term}->ROW_r ($_) }, $self->{beg} .. $self->{end}
		705	];
		706	$#$rend = $self->{len} - 1;
		707	$rend
		708	}
		709
		710	sub urxvt::line::beg { $_[0]{beg} }
		711	sub urxvt::line::end { $_[0]{end} }
		712	sub urxvt::line::l { $_[0]{len} }
		713
		714	sub urxvt::line::offset_of {
		715	my ($self, $row, $col) = @_;
		716
		717	($row - $self->{beg}) * $self->{term}->ncol + $col
		718	}
		719
		720	sub urxvt::line::coord_of {
		721	my ($self, $offset) = @_;
		722
		723	use integer;
		724
		725	(
		726	$offset / $self->{term}->ncol + $self->{beg},
		727	$offset % $self->{term}->ncol
		728	)
		729	}
		730
		731	=item ($row, $col) = $line->coord_of ($offset)
		732	=item $text = $term->special_encode $string
		733
		734	Converts a perl string into the special encoding used by rxvt-unicode,
		735	where one character corresponds to one screen cell. See
		736	C<< $term->ROW_t >> for details.
		737
		738	=item $string = $term->special_decode $text
		739
		740	Converts rxvt-unicodes text reprsentation into a perl string. See
		741	C<< $term->ROW_t >> for details.
320		742
321	=back	743	=back
322		744
323	=head2 The C<urxvt::timer> Class	745	=head2 The C<urxvt::timer> Class
324		746
325	This class implements timer watchers/events. Time is represented as a	747	This class implements timer watchers/events. Time is represented as a
326	fractional number of seconds since the epoch. Example:	748	fractional number of seconds since the epoch. Example:
327		749
328	# create a digital clock display in upper right corner	750	$term->{overlay} = $term->overlay (-1, 0, 8, 1, urxvt::OVERLAY_RSTYLE, 0);
329	$term->{timer} = urxvt::timer	751	$term->{timer} = urxvt::timer
330	->new	752	->new
331	->start (urxvt::NOW)	753	->interval (1)
332	->cb (sub {	754	->cb (sub {
333	my ($timer) = @_;
334	my $time = $timer->at;
335	$timer->start ($time + 1);
336	$self->scr_overlay (-1, 0,	755	$term->{overlay}->set (0, 0,
337	POSIX::strftime "%H:%M:%S", localtime $time);	756	sprintf "%2d:%02d:%02d", (localtime urxvt::NOW)[2,1,0]);
338	});	757	});
339		758
340	=over 4	759	=over 4
341		760
342	=item $timer = new urxvt::timer	761	=item $timer = new urxvt::timer
343		762
344	Create a new timer object in stopped state.	763	Create a new timer object in started state. It is scheduled to fire
		764	immediately.
345		765
346	=item $timer = $timer->cb (sub { my ($timer) = @_; ... })	766	=item $timer = $timer->cb (sub { my ($timer) = @_; ... })
347		767
348	Set the callback to be called when the timer triggers.	768	Set the callback to be called when the timer triggers.
349		769
…		…
352	Return the time this watcher will fire next.	772	Return the time this watcher will fire next.
353		773
354	=item $timer = $timer->set ($tstamp)	774	=item $timer = $timer->set ($tstamp)
355		775
356	Set the time the event is generated to $tstamp.	776	Set the time the event is generated to $tstamp.
		777
		778	=item $timer = $timer->interval ($interval)
		779
		780	Normally (and when C<$interval> is C<0>), the timer will automatically
		781	stop after it has fired once. If C<$interval> is non-zero, then the timer
		782	is automatically rescheduled at the given intervals.
357		783
358	=item $timer = $timer->start	784	=item $timer = $timer->start
359		785
360	Start the timer.	786	Start the timer.
361		787
…		…
424	This variable controls the verbosity level of the perl extension. Higher	850	This variable controls the verbosity level of the perl extension. Higher
425	numbers indicate more verbose output.	851	numbers indicate more verbose output.
426		852
427	=over 4	853	=over 4
428		854
429	=item 0 - only fatal messages	855	=item =0 - only fatal messages
430		856
431	=item 3 - script loading and management	857	=item =3 - script loading and management
432		858
433	=item 10 - all events received	859	=item =10 - all events received
434		860
435	=back	861	=back
436		862
437	=head1 AUTHOR	863	=head1 AUTHOR
438		864

Diff Legend

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

Comparing rxvt-unicode/src/urxvt.pm (file contents): Revision 1.4 by root, Mon Jan 2 17:17:02 2006 UTC vs. Revision 1.27 by root, Tue Jan 3 23:41:37 2006 UTC

Diff Legend

Comparing rxvt-unicode/src/urxvt.pm (file contents):
Revision 1.4 by root, Mon Jan 2 17:17:02 2006 UTC vs.
Revision 1.27 by root, Tue Jan 3 23:41:37 2006 UTC