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

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.34 by root, Fri Jan 6 01:16:58 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.34 by root, Fri Jan 6 01:16:58 2006 UTC