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

Comparing rxvt-unicode/src/urxvt.pm (file contents):
Revision 1.2 by root, Mon Jan 2 15:36:27 2006 UTC vs.
Revision 1.25 by root, Tue Jan 3 21:08:39 2006 UTC

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

Diff Legend

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

Comparing rxvt-unicode/src/urxvt.pm (file contents): Revision 1.2 by root, Mon Jan 2 15:36:27 2006 UTC vs. Revision 1.25 by root, Tue Jan 3 21:08:39 2006 UTC

Diff Legend

Comparing rxvt-unicode/src/urxvt.pm (file contents):
Revision 1.2 by root, Mon Jan 2 15:36:27 2006 UTC vs.
Revision 1.25 by root, Tue Jan 3 21:08:39 2006 UTC