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

Comparing rxvt-unicode/src/urxvt.pm (file contents):
Revision 1.18 by root, Tue Jan 3 02:01:27 2006 UTC vs.
Revision 1.35 by root, Fri Jan 6 01:27:27 2006 UTC

…		…
39		39
40	=over 4	40	=over 4
41		41
42	=item selection	42	=item selection
43		43
44	Miscellaneous selection modifications.	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:
45		50
46	=over 4	51	=over 4
47		52
48	=item rot13	53	=item rot13
49		54
…		…
52	URxvt.keysym.C-M-r: perl:selection:rot13	57	URxvt.keysym.C-M-r: perl:selection:rot13
53		58
54	=back	59	=back
55		60
56	=item digital-clock	61	=item digital-clock
		62
		63	Displays a digital clock using the built-in overlay.
		64
		65	=item mark-urls
		66
		67	Uses per-line filtering (C<on_line_update>) to underline urls.
		68
		69	=item example-refresh-hooks
57		70
58	Displays a very simple digital clock in the upper right corner of the	71	Displays a very simple digital clock in the upper right corner of the
59	window. Illustrates overwriting the refresh callbacks to create your own	72	window. Illustrates overwriting the refresh callbacks to create your own
60	overlays or changes.	73	overlays or changes.
61		74
62	=item simple-overlay-clock	75	=item example-filter-input
63		76
64	Displays a digital clock using the built-in overlay (colourful, useless).	77	A not very useful example of filtering all text output to the terminal, by
		78	underlining all urls that matches a certain regex (i.e. some urls :). It
		79	is not very useful because urls that are output in multiple steps (e.g.
		80	when typing them) do not get marked.
65		81
66	=back	82	=back
67		83
68	=head2 General API Considerations	84	=head2 General API Considerations
69		85
70	All objects (such as terminals, time watchers etc.) are typical	86	All objects (such as terminals, time watchers etc.) are typical
71	reference-to-hash objects. The hash can be used to store anything you	87	reference-to-hash objects. The hash can be used to store anything you
72	like. All members starting with an underscore (such as C<_ptr> or	88	like. All members starting with an underscore (such as C<_ptr> or
73	C<_hook>) are reserved for internal uses and must not be accessed or	89	C<_hook>) are reserved for internal uses and B<MUST NOT> be accessed or
74	modified).	90	modified).
75		91
76	When objects are destroyed on the C++ side, the perl object hashes are	92	When objects are destroyed on the C++ side, the perl object hashes are
77	emptied, so its best to store related objects such as time watchers and	93	emptied, so its best to store related objects such as time watchers and
78	the like inside the terminal object so they get destroyed as soon as the	94	the like inside the terminal object so they get destroyed as soon as the
79	terminal is destroyed.	95	terminal is destroyed.
80		96
		97	Argument names also often indicate the type of a parameter. Here are some
		98	hints on what they mean:
		99
		100	=over 4
		101
		102	=item $text
		103
		104	Rxvt-unicodes special way of encoding text, where one "unicode" character
		105	always represents one screen cell. See L<row_t> for a discussion of this format.
		106
		107	=item $string
		108
		109	A perl text string, with an emphasis on I<text>. It can store all unicode
		110	characters and is to be distinguished with text encoded in a specific
		111	encoding (often locale-specific) and binary data.
		112
		113	=item $octets
		114
		115	Either binary data or - more common - a text string encoded in a
		116	locale-specific way.
		117
		118	=back
		119
81	=head2 Hooks	120	=head2 Hooks
82		121
83	The following subroutines can be declared in loaded scripts, and will be called	122	The following subroutines can be declared in loaded scripts, and will be
84	whenever the relevant event happens.	123	called whenever the relevant event happens.
		124
		125	The first argument passed to them is an object private to each terminal
		126	and extension package. You can call all C<urxvt::term> methods on it, but
		127	its not a real C<urxvt::term> object. Instead, the real C<urxvt::term>
		128	object that is shared between all packages is stored in the C<term>
		129	member.
85		130
86	All of them must return a boolean value. If it is true, then the event	131	All of them must return a boolean value. If it is true, then the event
87	counts as being I<consumed>, and the invocation of other hooks is skipped,	132	counts as being I<consumed>, and the invocation of other hooks is skipped,
88	and the relevant action might not be carried out by the C++ code.	133	and the relevant action might not be carried out by the C++ code.
89		134
…		…
122	requested from the server. The selection text can be queried and changed	167	requested from the server. The selection text can be queried and changed
123	by calling C<< $term->selection >>.	168	by calling C<< $term->selection >>.
124		169
125	Returning a true value aborts selection grabbing. It will still be hilighted.	170	Returning a true value aborts selection grabbing. It will still be hilighted.
126		171
		172	=item on_sel_extend $term
		173
		174	Called whenever the user tries to extend the selection (e.g. with a double
		175	click) and is either supposed to return false (normal operation), or
		176	should extend the selection itelf and return true to suppress the built-in
		177	processing.
		178
		179	See the F<selection> example extension.
		180
127	=item on_focus_in $term	181	=item on_focus_in $term
128		182
129	Called whenever the window gets the keyboard focus, before urxvt does	183	Called whenever the window gets the keyboard focus, before urxvt does
130	focus in processing.	184	focus in processing.
131		185
…		…
151	number of lines that will be in the scrollback buffer.	205	number of lines that will be in the scrollback buffer.
152		206
153	=item on_tty_activity $term NYI	207	=item on_tty_activity $term NYI
154		208
155	Called whenever the program(s) running in the urxvt window send output.	209	Called whenever the program(s) running in the urxvt window send output.
		210
		211	=item on_osc_seq $term, $string
		212
		213	Called whenever the B<ESC ] 777 ; string ST> command sequence (OSC =
		214	operating system command) is processed. Cursor position and other state
		215	information is up-to-date when this happens. For interoperability, the
		216	string should start with the extension name and a colon, to distinguish
		217	it from commands for other extensions, and this might be enforced in the
		218	future.
		219
		220	Be careful not ever to trust (in a security sense) the data you receive,
		221	as its source can not easily be controleld (e-mail content, messages from
		222	other users on the same system etc.).
		223
		224	=item on_add_lines $term, $string
		225
		226	Called whenever text is about to be output, with the text as argument. You
		227	can filter/change and output the text yourself by returning a true value
		228	and calling C<< $term->scr_add_lines >> yourself. Please note that this
		229	might be very slow, however, as your hook is called for B<all> text being
		230	output.
		231
		232	=item on_line_update $term, $row
		233
		234	Called whenever a line was updated or changed. Can be used to filter
		235	screen output (e.g. underline urls or other useless stuff). Only lines
		236	that are being shown will be filtered, and, due to performance reasons,
		237	not always immediately.
		238
		239	The row number is always the topmost row of the line if the line spans
		240	multiple rows.
		241
		242	Please note that, if you change the line, then the hook might get called
		243	later with the already-modified line (e.g. if unrelated parts change), so
		244	you cannot just toggle rendition bits, but only set them.
156		245
157	=item on_refresh_begin $term	246	=item on_refresh_begin $term
158		247
159	Called just before the screen gets redrawn. Can be used for overlay	248	Called just before the screen gets redrawn. Can be used for overlay
160	or similar effects by modify terminal contents in refresh_begin, and	249	or similar effects by modify terminal contents in refresh_begin, and
…		…
171	C<perl:string> action bound to it (see description of the B<keysym>	260	C<perl:string> action bound to it (see description of the B<keysym>
172	resource in the @@RXVT_NAME@@(1) manpage).	261	resource in the @@RXVT_NAME@@(1) manpage).
173		262
174	=back	263	=back
175		264
		265	=head2 Variables in the C<urxvt> Package
		266
		267	=over 4
		268
		269	=item $urxvt::TERM
		270
		271	The current terminal. Whenever a callback/Hook is bein executed, this
		272	variable stores the current C<urxvt::term> object.
		273
		274	=back
		275
176	=head2 Functions in the C<urxvt> Package	276	=head2 Functions in the C<urxvt> Package
177		277
178	=over 4	278	=over 4
179		279
180	=item urxvt::fatal $errormessage	280	=item urxvt::fatal $errormessage
…		…
193	correct place, e.g. on stderr of the connecting urxvtc client.	293	correct place, e.g. on stderr of the connecting urxvtc client.
194		294
195	=item $time = urxvt::NOW	295	=item $time = urxvt::NOW
196		296
197	Returns the "current time" (as per the event loop).	297	Returns the "current time" (as per the event loop).
		298
		299	=back
198		300
199	=head2 RENDITION	301	=head2 RENDITION
200		302
201	Rendition bitsets contain information about colour, font, font styles and	303	Rendition bitsets contain information about colour, font, font styles and
202	similar information for each screen cell.	304	similar information for each screen cell.
…		…
218	Return the rendition mask used for overlays by default.	320	Return the rendition mask used for overlays by default.
219		321
220	=item $rendbit = urxvt::RS_Bold, RS_Italic, RS_Blink, RS_RVid, RS_Uline	322	=item $rendbit = urxvt::RS_Bold, RS_Italic, RS_Blink, RS_RVid, RS_Uline
221		323
222	Return the bit that enabled bold, italic, blink, reverse-video and	324	Return the bit that enabled bold, italic, blink, reverse-video and
223	underline, respectively. To enable such a style, just or it onto the	325	underline, respectively. To enable such a style, just logically OR it into
224	bitset.	326	the bitset.
225		327
226	=item $foreground = urxvt::GET_BASEFG $rend	328	=item $foreground = urxvt::GET_BASEFG $rend
227		329
228	=item $background = urxvt::GET_BASEBG $rend	330	=item $background = urxvt::GET_BASEBG $rend
229		331
…		…
234	=item $rend = urxvt::SET_BGCOLOR ($rend, $new_colour)	336	=item $rend = urxvt::SET_BGCOLOR ($rend, $new_colour)
235		337
236	Replace the foreground/background colour in the rendition mask with the	338	Replace the foreground/background colour in the rendition mask with the
237	specified one.	339	specified one.
238		340
		341	=item $value = urxvt::GET_CUSTOM ($rend)
		342
		343	Return the "custom" value: Every rendition has 5 bits for use by
		344	extensions. They can be set and changed as you like and are initially
		345	zero.
		346
		347	=item $rend = urxvt::SET_CUSTOM ($rend, $new_value)
		348
		349	Change the custom value.
		350
239	=back	351	=back
240		352
241	=cut	353	=cut
242		354
243	package urxvt;	355	package urxvt;
244		356
245	use strict;	357	use strict;
		358	use Scalar::Util ();
246		359
247	our $term;	360	our $TERM;
248	our @HOOKNAME;	361	our @HOOKNAME;
249	our $LIBDIR;	362	our $LIBDIR;
250		363
251	BEGIN {	364	BEGIN {
252	urxvt->bootstrap;	365	urxvt->bootstrap;
…		…
277	my $name = $HOOKNAME[$htype];	390	my $name = $HOOKNAME[$htype];
278		391
279	my $ref = $pkg->can ("on_" . lc $name)	392	my $ref = $pkg->can ("on_" . lc $name)
280	or next;	393	or next;
281		394
282	$term->{_hook}[$htype]{$ref*1} = $ref;	395	$TERM->{_hook}[$htype]{$pkg} = $ref;
283	$hook_count[$htype]++	396	$hook_count[$htype]++
284	or set_should_invoke $htype, 1;	397	or set_should_invoke $htype, 1;
285	}	398	}
286	}	399	}
287		400
…		…
309		422
310	$pkg	423	$pkg
311	}	424	}
312	}	425	}
313		426
		427	our $retval; # return value for urxvt
		428
314	# called by the rxvt core	429	# called by the rxvt core
315	sub invoke {	430	sub invoke {
316	local $term = shift;	431	local $TERM = shift;
317	my $htype = shift;	432	my $htype = shift;
318		433
319	if ($htype == 0) { # INIT	434	if ($htype == 0) { # INIT
320	my @dirs = ((split /:/, $term->resource ("perl_lib")), "$LIBDIR/perl");	435	my @dirs = ((split /:/, $TERM->resource ("perl_lib")), "$LIBDIR/perl");
321		436
322	for my $ext (split /:/, $term->resource ("perl_ext")) {	437	for my $ext (map { split /:/, $TERM->resource ("perl_ext_$_") } 1, 2) {
323	my @files = grep -f $_, map "$_/$ext", @dirs;	438	my @files = grep -f $_, map "$_/$ext", @dirs;
324		439
325	if (@files) {	440	if (@files) {
326	register_package script_package $files[0];	441	register_package script_package $files[0];
327	} else {	442	} else {
328	warn "perl extension '$ext' not found in perl library search path\n";	443	warn "perl extension '$ext' not found in perl library search path\n";
329	}	444	}
330	}	445	}
		446	}
331		447
		448	$retval = undef;
		449
		450	if (my $cb = $TERM->{_hook}[$htype]) {
		451	verbose 10, "$HOOKNAME[$htype] (" . (join ", ", $TERM, @_) . ")"
		452	if $verbosity >= 10;
		453
		454	keys %$cb;
		455
		456	while (my ($pkg, $cb) = each %$cb) {
		457	$retval = $cb->(
		458	$TERM->{_pkg}{$pkg} \|\|= do {
		459	my $proxy = bless { }, urxvt::term::proxy::;
		460	Scalar::Util::weaken ($proxy->{term} = $TERM);
		461	$proxy
		462	},
		463	@_,
		464	) and last;
		465	}
		466	}
		467
332	} elsif ($htype == 1) { # DESTROY	468	if ($htype == 1) { # DESTROY
		469	# remove hooks if unused
333	if (my $hook = $term->{_hook}) {	470	if (my $hook = $TERM->{_hook}) {
334	for my $htype (0..$#$hook) {	471	for my $htype (0..$#$hook) {
335	$hook_count[$htype] -= scalar keys %{ $hook->[$htype] \|\| {} }	472	$hook_count[$htype] -= scalar keys %{ $hook->[$htype] \|\| {} }
336	or set_should_invoke $htype, 0;	473	or set_should_invoke $htype, 0;
337	}	474	}
338	}	475	}
		476
		477	# clear package objects
		478	%$_ = () for values %{ $TERM->{_pkg} };
		479
		480	# clear package
		481	%$TERM = ();
339	}	482	}
340		483
341	my $cb = $term->{_hook}[$htype]	484	$retval
342	or return;
343
344	verbose 10, "$HOOKNAME[$htype] (" . (join ", ", $term, @_) . ")"
345	if $verbosity >= 10;
346
347	while (my ($k, $v) = each %$cb) {
348	return 1 if $v->($term, @_);
349	}
350
351	0
352	}	485	}
353		486
354	=back	487	sub urxvt::term::proxy::AUTOLOAD {
		488	$urxvt::term::proxy::AUTOLOAD =~ /:([^:]+)$/
		489	or die "FATAL: \$AUTOLOAD '$urxvt::term::proxy::AUTOLOAD' unparsable";
		490
		491	eval qq{
		492	sub $urxvt::term::proxy::AUTOLOAD {
		493	my \$proxy = shift;
		494	\$proxy->{term}->$1 (\@_)
		495	}
		496	1
		497	} or die "FATAL: unable to compile method forwarder: $@";
		498
		499	goto &$urxvt::term::proxy::AUTOLOAD;
		500	}
355		501
356	=head2 The C<urxvt::term> Class	502	=head2 The C<urxvt::term> Class
357		503
358	=over 4	504	=over 4
359		505
…		…
381	answerbackstring backgroundPixmap backspace_key boldFont boldItalicFont	527	answerbackstring backgroundPixmap backspace_key boldFont boldItalicFont
382	borderLess color cursorBlink cursorUnderline cutchars delete_key	528	borderLess color cursorBlink cursorUnderline cutchars delete_key
383	display_name embed ext_bwidth fade font geometry hold iconName	529	display_name embed ext_bwidth fade font geometry hold iconName
384	imFont imLocale inputMethod insecure int_bwidth intensityStyles	530	imFont imLocale inputMethod insecure int_bwidth intensityStyles
385	italicFont jumpScroll lineSpace loginShell mapAlert menu meta8 modifier	531	italicFont jumpScroll lineSpace loginShell mapAlert menu meta8 modifier
386	mouseWheelScrollPage name pastableTabs path perl_eval perl_ext	532	mouseWheelScrollPage name pastableTabs path perl_eval perl_ext_1 perl_ext_2
387	perl_lib pointerBlank pointerBlankDelay preeditType print_pipe pty_fd	533	perl_lib pointerBlank pointerBlankDelay preeditType print_pipe pty_fd
388	reverseVideo saveLines scrollBar scrollBar_align scrollBar_floating	534	reverseVideo saveLines scrollBar scrollBar_align scrollBar_floating
389	scrollBar_right scrollBar_thickness scrollTtyKeypress scrollTtyOutput	535	scrollBar_right scrollBar_thickness scrollTtyKeypress scrollTtyOutput
390	scrollWithBuffer scrollstyle secondaryScreen secondaryScroll selectstyle	536	scrollWithBuffer scrollstyle secondaryScreen secondaryScroll selectstyle
391	shade term_name title transparent transparent_all tripleclickwords	537	shade term_name title transparent transparent_all tripleclickwords
…		…
397	my ($self, $name) = (shift, shift);	543	my ($self, $name) = (shift, shift);
398	unshift @_, $self, $name, ($name =~ s/\s\+\s(\d+)$// ? $1 : 0);	544	unshift @_, $self, $name, ($name =~ s/\s\+\s(\d+)$// ? $1 : 0);
399	goto &urxvt::term::_resource;	545	goto &urxvt::term::_resource;
400	}	546	}
401		547
		548	=item $rend = $term->rstyle ([$new_rstyle])
		549
		550	Return and optionally change the current rendition. Text that is output by
		551	the terminal application will use this style.
		552
		553	=item ($row, $col) = $term->screen_cur ([$row, $col])
		554
		555	Return the current coordinates of the text cursor position and optionally
		556	set it (which is usually bad as applications don't expect that).
		557
402	=item ($row, $col) = $term->selection_mark ([$row, $col])	558	=item ($row, $col) = $term->selection_mark ([$row, $col])
403		559
404	=item ($row, $col) = $term->selection_beg ([$row, $col])	560	=item ($row, $col) = $term->selection_beg ([$row, $col])
405		561
406	=item ($row, $col) = $term->selection_end ([$row, $col])	562	=item ($row, $col) = $term->selection_end ([$row, $col])
…		…
415		571
416	=item $oldtext = $term->selection ([$newtext])	572	=item $oldtext = $term->selection ([$newtext])
417		573
418	Return the current selection text and optionally replace it by C<$newtext>.	574	Return the current selection text and optionally replace it by C<$newtext>.
419		575
420	=item $term->scr_overlay ($x, $y, $text)	576	#=item $term->overlay ($x, $y, $text)
421		577	#
422	Create a simple multi-line overlay box. See the next method for details.	578	#Create a simple multi-line overlay box. See the next method for details.
423		579	#
424	=cut	580	#=cut
425		581	#
426	sub urxvt::term::scr_overlay {	582	#sub urxvt::term::scr_overlay {
427	my ($self, $x, $y, $text) = @_;	583	# my ($self, $x, $y, $text) = @_;
428		584	#
429	my @lines = split /\n/, $text;	585	# my @lines = split /\n/, $text;
430		586	#
431	my $w = 0;	587	# my $w = 0;
432	for (map $self->strwidth ($_), @lines) {	588	# for (map $self->strwidth ($_), @lines) {
433	$w = $_ if $w < $_;	589	# $w = $_ if $w < $_;
434	}	590	# }
435		591	#
436	$self->scr_overlay_new ($x, $y, $w, scalar @lines);	592	# $self->scr_overlay_new ($x, $y, $w, scalar @lines);
437	$self->scr_overlay_set (0, $_, $lines[$_]) for 0.. $#lines;	593	# $self->scr_overlay_set (0, $_, $lines[$_]) for 0.. $#lines;
438	}	594	#}
439		595
440	=item $term->scr_overlay_new ($x, $y, $width, $height)	596	=item $term->overlay ($x, $y, $width, $height[, $rstyle[, $border]])
441		597
442	Create a new (empty) overlay at the given position with the given	598	Create a new (empty) overlay at the given position with the given
443	width/height. A border will be put around the box. If either C<$x> or	599	width/height. C<$rstyle> defines the initial rendition style
444	C<$y> is negative, then this is counted from the right/bottom side,	600	(default: C<OVERLAY_RSTYLE>).
445	respectively.
446		601
447	=item $term->scr_overlay_off	602	If C<$border> is C<2> (default), then a decorative border will be put
		603	around the box.
448		604
449	Switch the overlay off again.	605	If either C<$x> or C<$y> is negative, then this is counted from the
		606	right/bottom side, respectively.
450		607
451	=item $term->scr_overlay_set_char ($x, $y, $char, $rend = OVERLAY_RSTYLE)	608	This method returns an urxvt::overlay object. The overlay will be visible
		609	as long as the perl object is referenced.
452		610
453	Put a single character (specified numerically) at the given overlay	611	The methods currently supported on C<urxvt::overlay> objects are:
454	position.
455		612
		613	=over 4
		614
456	=item $term->scr_overlay_set ($x, $y, $text)	615	=item $overlay->set ($x, $y, $text, $rend)
457		616
458	Write a string at the given position into the overlay.	617	Similar to C<< $term->ROW_t >> and C<< $term->ROW_r >> in that it puts
		618	text in rxvt-unicode's special encoding and an array of rendition values
		619	at a specific position inside the overlay.
		620
		621	=item $overlay->hide
		622
		623	If visible, hide the overlay, but do not destroy it.
		624
		625	=item $overlay->show
		626
		627	If hidden, display the overlay again.
		628
		629	=back
459		630
460	=item $cellwidth = $term->strwidth $string	631	=item $cellwidth = $term->strwidth $string
461		632
462	Returns the number of screen-cells this string would need. Correctly	633	Returns the number of screen-cells this string would need. Correctly
463	accounts for wide and combining characters.	634	accounts for wide and combining characters.
…		…
467	Convert the given text string into the corresponding locale encoding.	638	Convert the given text string into the corresponding locale encoding.
468		639
469	=item $string = $term->locale_decode $octets	640	=item $string = $term->locale_decode $octets
470		641
471	Convert the given locale-encoded octets into a perl string.	642	Convert the given locale-encoded octets into a perl string.
		643
		644	=item $term->scr_add_lines ($string)
		645
		646	Write the given text string to the screen, as if output by the application
		647	running inside the terminal. It may not contain command sequences (escape
		648	codes), but is free to use line feeds, carriage returns and tabs. The
		649	string is a normal text string, not in locale-dependent encoding.
		650
		651	Normally its not a good idea to use this function, as programs might be
		652	confused by changes in cursor position or scrolling. Its useful inside a
		653	C<on_add_lines> hook, though.
472		654
473	=item $term->tt_write ($octets)	655	=item $term->tt_write ($octets)
474		656
475	Write the octets given in C<$data> to the tty (i.e. as program input). To	657	Write the octets given in C<$data> to the tty (i.e. as program input). To
476	pass characters instead of octets, you should convert your strings first	658	pass characters instead of octets, you should convert your strings first
477	to the locale-specific encoding using C<< $term->locale_encode >>.	659	to the locale-specific encoding using C<< $term->locale_encode >>.
478		660
		661	=item $window_width = $term->width
		662
		663	=item $window_height = $term->height
		664
		665	=item $font_width = $term->fwidth
		666
		667	=item $font_height = $term->fheight
		668
		669	=item $font_ascent = $term->fbase
		670
479	=item $nrow = $term->nrow	671	=item $terminal_rows = $term->nrow
480		672
481	=item $ncol = $term->ncol	673	=item $terminal_columns = $term->ncol
482		674
483	Return the number of rows/columns of the terminal window (i.e. as	675	=item $has_focus = $term->focus
484	specified by C<-geometry>, excluding any scrollback).
485		676
486	=item $nsaved = $term->nsaved	677	=item $is_mapped = $term->mapped
487		678
488	Returns the number of lines in the scrollback buffer.	679	=item $max_scrollback = $term->saveLines
		680
		681	=item $nrow_plus_saveLines = $term->total_rows
		682
		683	=item $lines_in_scrollback = $term->nsaved
		684
		685	Return various integers describing terminal characteristics.
489		686
490	=item $view_start = $term->view_start ([$newvalue])	687	=item $view_start = $term->view_start ([$newvalue])
491		688
492	Returns the negative row number of the topmost line. Minimum value is	689	Returns the negative row number of the topmost line. Minimum value is
493	C<0>, which displays the normal terminal contents. Larger values scroll	690	C<0>, which displays the normal terminal contents. Larger values scroll
…		…
504	=item $text = $term->ROW_t ($row_number[, $new_text[, $start_col]])	701	=item $text = $term->ROW_t ($row_number[, $new_text[, $start_col]])
505		702
506	Returns the text of the entire row with number C<$row_number>. Row C<0>	703	Returns the text of the entire row with number C<$row_number>. Row C<0>
507	is the topmost terminal line, row C<< $term->$ncol-1 >> is the bottommost	704	is the topmost terminal line, row C<< $term->$ncol-1 >> is the bottommost
508	terminal line. The scrollback buffer starts at line C<-1> and extends to	705	terminal line. The scrollback buffer starts at line C<-1> and extends to
509	line C<< -$term->nsaved >>.	706	line C<< -$term->nsaved >>. Nothing will be returned if a nonexistent line
		707	is requested.
510		708
511	If C<$new_text> is specified, it will replace characters in the current	709	If C<$new_text> is specified, it will replace characters in the current
512	line, starting at column C<$start_col> (default C<0>), which is useful	710	line, starting at column C<$start_col> (default C<0>), which is useful
513	to replace only parts of a line. The font index in the rendition will	711	to replace only parts of a line. The font index in the rendition will
514	automatically be updated.	712	automatically be updated.
…		…
536		734
537	See the section on RENDITION, above.	735	See the section on RENDITION, above.
538		736
539	=item $length = $term->ROW_l ($row_number[, $new_length])	737	=item $length = $term->ROW_l ($row_number[, $new_length])
540		738
541	Returns the number of screen cells that are in use ("the line length"). If	739	Returns the number of screen cells that are in use ("the line
542	it is C<-1>, then the line is part of a multiple-row logical "line", which	740	length"). Unlike the urxvt core, this returns C<< $term->ncol >> if the
543	means all characters are in use and it is continued on the next row.	741	line is joined with the following one.
544		742
		743	=item $bool = $term->is_longer ($row_number)
		744
		745	Returns true if the row is part of a multiple-row logical "line" (i.e.
		746	joined with the following row), which means all characters are in use
		747	and it is continued on the next row (and possibly a continuation of the
		748	previous row(s)).
		749
		750	=item $line = $term->line ($row_number)
		751
		752	Create and return a new C<urxvt::line> object that stores information
		753	about the logical line that row C<$row_number> is part of. It supports the
		754	following methods:
		755
		756	=over 4
		757
		758	=item $text = $line->t ([$new_text])
		759
		760	Returns or replaces the full text of the line, similar to C<ROW_t>
		761
		762	=item $rend = $line->r ([$new_rend])
		763
		764	Returns or replaces the full rendition array of the line, similar to C<ROW_r>
		765
		766	=item $length = $line->l
		767
		768	Returns the length of the line in cells, similar to C<ROW_l>.
		769
		770	=item $rownum = $line->beg
		771
		772	=item $rownum = $line->end
		773
		774	Return the row number of the first/last row of the line, respectively.
		775
		776	=item $offset = $line->offset_of ($row, $col)
		777
		778	Returns the character offset of the given row\|col pair within the logical
		779	line.
		780
		781	=item ($row, $col) = $line->coord_of ($offset)
		782
		783	Translates a string offset into terminal coordinates again.
		784
		785	=back
		786
		787	=cut
		788
		789	sub urxvt::term::line {
		790	my ($self, $row) = @_;
		791
		792	my $maxrow = $self->nrow - 1;
		793
		794	my ($beg, $end) = ($row, $row);
		795
		796	--$beg while $self->ROW_is_longer ($beg - 1);
		797	++$end while $self->ROW_is_longer ($end) && $end < $maxrow;
		798
		799	bless {
		800	term => $self,
		801	beg => $beg,
		802	end => $end,
		803	ncol => $self->ncol,
		804	len => ($end - $beg) * $self->ncol + $self->ROW_l ($end),
		805	}, urxvt::line::
		806	}
		807
		808	sub urxvt::line::t {
		809	my ($self) = @_;
		810
		811	if (@_ > 1)
		812	{
		813	$self->{term}->ROW_t ($_, $_[1], 0, ($_ - $self->{beg}) * $self->{ncol}, $self->{ncol})
		814	for $self->{beg} .. $self->{end};
		815	}
		816
		817	defined wantarray &&
		818	substr +(join "", map $self->{term}->ROW_t ($_), $self->{beg} .. $self->{end}),
		819	0, $self->{len}
		820	}
		821
		822	sub urxvt::line::r {
		823	my ($self) = @_;
		824
		825	if (@_ > 1)
		826	{
		827	$self->{term}->ROW_r ($_, $_[1], 0, ($_ - $self->{beg}) * $self->{ncol}, $self->{ncol})
		828	for $self->{beg} .. $self->{end};
		829	}
		830
		831	if (defined wantarray) {
		832	my $rend = [
		833	map @{ $self->{term}->ROW_r ($_) }, $self->{beg} .. $self->{end}
		834	];
		835	$#$rend = $self->{len} - 1;
		836	return $rend;
		837	}
		838
		839	()
		840	}
		841
		842	sub urxvt::line::beg { $_[0]{beg} }
		843	sub urxvt::line::end { $_[0]{end} }
		844	sub urxvt::line::l { $_[0]{len} }
		845
		846	sub urxvt::line::offset_of {
		847	my ($self, $row, $col) = @_;
		848
		849	($row - $self->{beg}) * $self->{ncol} + $col
		850	}
		851
		852	sub urxvt::line::coord_of {
		853	my ($self, $offset) = @_;
		854
		855	use integer;
		856
		857	(
		858	$offset / $self->{ncol} + $self->{beg},
		859	$offset % $self->{ncol}
		860	)
		861	}
		862
		863	=item ($row, $col) = $line->coord_of ($offset)
545	=item $text = $term->special_encode $string	864	=item $text = $term->special_encode $string
546		865
547	Converts a perl string into the special encoding used by rxvt-unicode,	866	Converts a perl string into the special encoding used by rxvt-unicode,
548	where one character corresponds to one screen cell. See	867	where one character corresponds to one screen cell. See
549	C<< $term->ROW_t >> for details.	868	C<< $term->ROW_t >> for details.
…		…
558	=head2 The C<urxvt::timer> Class	877	=head2 The C<urxvt::timer> Class
559		878
560	This class implements timer watchers/events. Time is represented as a	879	This class implements timer watchers/events. Time is represented as a
561	fractional number of seconds since the epoch. Example:	880	fractional number of seconds since the epoch. Example:
562		881
563	# create a digital clock display in upper right corner	882	$term->{overlay} = $term->overlay (-1, 0, 8, 1, urxvt::OVERLAY_RSTYLE, 0);
564	$term->{timer} = urxvt::timer	883	$term->{timer} = urxvt::timer
565	->new	884	->new
566	->start (urxvt::NOW)	885	->interval (1)
567	->cb (sub {	886	->cb (sub {
568	my ($timer) = @_;
569	my $time = $timer->at;
570	$timer->start ($time + 1);
571	$self->scr_overlay (-1, 0,	887	$term->{overlay}->set (0, 0,
572	POSIX::strftime "%H:%M:%S", localtime $time);	888	sprintf "%2d:%02d:%02d", (localtime urxvt::NOW)[2,1,0]);
573	});	889	});
574		890
575	=over 4	891	=over 4
576		892
577	=item $timer = new urxvt::timer	893	=item $timer = new urxvt::timer
578		894
579	Create a new timer object in stopped state.	895	Create a new timer object in started state. It is scheduled to fire
		896	immediately.
580		897
581	=item $timer = $timer->cb (sub { my ($timer) = @_; ... })	898	=item $timer = $timer->cb (sub { my ($timer) = @_; ... })
582		899
583	Set the callback to be called when the timer triggers.	900	Set the callback to be called when the timer triggers.
584		901
…		…
587	Return the time this watcher will fire next.	904	Return the time this watcher will fire next.
588		905
589	=item $timer = $timer->set ($tstamp)	906	=item $timer = $timer->set ($tstamp)
590		907
591	Set the time the event is generated to $tstamp.	908	Set the time the event is generated to $tstamp.
		909
		910	=item $timer = $timer->interval ($interval)
		911
		912	Normally (and when C<$interval> is C<0>), the timer will automatically
		913	stop after it has fired once. If C<$interval> is non-zero, then the timer
		914	is automatically rescheduled at the given intervals.
592		915
593	=item $timer = $timer->start	916	=item $timer = $timer->start
594		917
595	Start the timer.	918	Start the timer.
596		919
…		…
659	This variable controls the verbosity level of the perl extension. Higher	982	This variable controls the verbosity level of the perl extension. Higher
660	numbers indicate more verbose output.	983	numbers indicate more verbose output.
661		984
662	=over 4	985	=over 4
663		986
664	=item 0 - only fatal messages	987	=item =0 - only fatal messages
665		988
666	=item 3 - script loading and management	989	=item =3 - script loading and management
667		990
668	=item 10 - all events received	991	=item =10 - all events received
669		992
670	=back	993	=back
671		994
672	=head1 AUTHOR	995	=head1 AUTHOR
673		996

Diff Legend

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

Comparing rxvt-unicode/src/urxvt.pm (file contents): Revision 1.18 by root, Tue Jan 3 02:01:27 2006 UTC vs. Revision 1.35 by root, Fri Jan 6 01:27:27 2006 UTC

Diff Legend

Comparing rxvt-unicode/src/urxvt.pm (file contents):
Revision 1.18 by root, Tue Jan 3 02:01:27 2006 UTC vs.
Revision 1.35 by root, Fri Jan 6 01:27:27 2006 UTC