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

Comparing rxvt-unicode/src/urxvt.pm (file contents):
Revision 1.21 by root, Tue Jan 3 04:20:37 2006 UTC vs.
Revision 1.36 by root, Fri Jan 6 02:58:02 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
…		…
54	=back	59	=back
55		60
56	=item digital-clock	61	=item digital-clock
57		62
58	Displays a digital clock using the built-in overlay.	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.
59		68
60	=item example-refresh-hooks	69	=item example-refresh-hooks
61		70
62	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
63	window. Illustrates overwriting the refresh callbacks to create your own	72	window. Illustrates overwriting the refresh callbacks to create your own
64	overlays or changes.	73	overlays or changes.
65		74
		75	=item example-filter-input
		76
		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.
		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
…		…
92	=over 4	137	=over 4
93		138
94	=item on_init $term	139	=item on_init $term
95		140
96	Called after a new terminal object has been initialized, but before	141	Called after a new terminal object has been initialized, but before
97	windows are created or the command gets run.	142	windows are created or the command gets run. Most methods are unsafe to
		143	call or deliver senseless data, as terminal size and other characteristics
		144	have not yet been determined. You can safely query and change resources,
		145	though.
98		146
99	=item on_reset $term	147	=item on_reset $term
100		148
101	Called after the screen is "reset" for any reason, such as resizing or	149	Called after the screen is "reset" for any reason, such as resizing or
102	control sequences. Here is where you can react on changes to size-related	150	control sequences. Here is where you can react on changes to size-related
…		…
122	requested from the server. The selection text can be queried and changed	170	requested from the server. The selection text can be queried and changed
123	by calling C<< $term->selection >>.	171	by calling C<< $term->selection >>.
124		172
125	Returning a true value aborts selection grabbing. It will still be hilighted.	173	Returning a true value aborts selection grabbing. It will still be hilighted.
126		174
		175	=item on_sel_extend $term
		176
		177	Called whenever the user tries to extend the selection (e.g. with a double
		178	click) and is either supposed to return false (normal operation), or
		179	should extend the selection itelf and return true to suppress the built-in
		180	processing.
		181
		182	See the F<selection> example extension.
		183
127	=item on_focus_in $term	184	=item on_focus_in $term
128		185
129	Called whenever the window gets the keyboard focus, before urxvt does	186	Called whenever the window gets the keyboard focus, before urxvt does
130	focus in processing.	187	focus in processing.
131		188
…		…
151	number of lines that will be in the scrollback buffer.	208	number of lines that will be in the scrollback buffer.
152		209
153	=item on_tty_activity $term NYI	210	=item on_tty_activity $term NYI
154		211
155	Called whenever the program(s) running in the urxvt window send output.	212	Called whenever the program(s) running in the urxvt window send output.
		213
		214	=item on_osc_seq $term, $string
		215
		216	Called whenever the B<ESC ] 777 ; string ST> command sequence (OSC =
		217	operating system command) is processed. Cursor position and other state
		218	information is up-to-date when this happens. For interoperability, the
		219	string should start with the extension name and a colon, to distinguish
		220	it from commands for other extensions, and this might be enforced in the
		221	future.
		222
		223	Be careful not ever to trust (in a security sense) the data you receive,
		224	as its source can not easily be controleld (e-mail content, messages from
		225	other users on the same system etc.).
		226
		227	=item on_add_lines $term, $string
		228
		229	Called whenever text is about to be output, with the text as argument. You
		230	can filter/change and output the text yourself by returning a true value
		231	and calling C<< $term->scr_add_lines >> yourself. Please note that this
		232	might be very slow, however, as your hook is called for B<all> text being
		233	output.
		234
		235	=item on_line_update $term, $row
		236
		237	Called whenever a line was updated or changed. Can be used to filter
		238	screen output (e.g. underline urls or other useless stuff). Only lines
		239	that are being shown will be filtered, and, due to performance reasons,
		240	not always immediately.
		241
		242	The row number is always the topmost row of the line if the line spans
		243	multiple rows.
		244
		245	Please note that, if you change the line, then the hook might get called
		246	later with the already-modified line (e.g. if unrelated parts change), so
		247	you cannot just toggle rendition bits, but only set them.
156		248
157	=item on_refresh_begin $term	249	=item on_refresh_begin $term
158		250
159	Called just before the screen gets redrawn. Can be used for overlay	251	Called just before the screen gets redrawn. Can be used for overlay
160	or similar effects by modify terminal contents in refresh_begin, and	252	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>	263	C<perl:string> action bound to it (see description of the B<keysym>
172	resource in the @@RXVT_NAME@@(1) manpage).	264	resource in the @@RXVT_NAME@@(1) manpage).
173		265
174	=back	266	=back
175		267
		268	=head2 Variables in the C<urxvt> Package
		269
		270	=over 4
		271
		272	=item $urxvt::TERM
		273
		274	The current terminal. Whenever a callback/Hook is bein executed, this
		275	variable stores the current C<urxvt::term> object.
		276
		277	=back
		278
176	=head2 Functions in the C<urxvt> Package	279	=head2 Functions in the C<urxvt> Package
177		280
178	=over 4	281	=over 4
		282
		283	=item $term = new urxvt [arg...]
		284
		285	Creates a new terminal, very similar as if you had started it with
		286	C<system $binfile, arg...>. Croaks (and probably outputs an error message)
		287	if the new instance couldn't be created. Returns C<undef> if the new
		288	instance didn't initialise perl, and the terminal object otherwise. The
		289	C<init> and C<start> hooks will be called during the call.
179		290
180	=item urxvt::fatal $errormessage	291	=item urxvt::fatal $errormessage
181		292
182	Fatally aborts execution with the given error message. Avoid at all	293	Fatally aborts execution with the given error message. Avoid at all
183	costs! The only time this is acceptable is when the terminal process	294	costs! The only time this is acceptable is when the terminal process
…		…
253	=cut	364	=cut
254		365
255	package urxvt;	366	package urxvt;
256		367
257	use strict;	368	use strict;
		369	use Scalar::Util ();
258		370
259	our $term;	371	our $TERM;
260	our @HOOKNAME;	372	our @HOOKNAME;
261	our $LIBDIR;	373	our $LIBDIR;
262		374
263	BEGIN {	375	BEGIN {
264	urxvt->bootstrap;	376	urxvt->bootstrap;
…		…
289	my $name = $HOOKNAME[$htype];	401	my $name = $HOOKNAME[$htype];
290		402
291	my $ref = $pkg->can ("on_" . lc $name)	403	my $ref = $pkg->can ("on_" . lc $name)
292	or next;	404	or next;
293		405
294	$term->{_hook}[$htype]{$ref*1} = $ref;	406	$TERM->{_hook}[$htype]{$pkg} = $ref;
295	$hook_count[$htype]++	407	$hook_count[$htype]++
296	or set_should_invoke $htype, 1;	408	or set_should_invoke $htype, 1;
297	}	409	}
298	}	410	}
299		411
…		…
321		433
322	$pkg	434	$pkg
323	}	435	}
324	}	436	}
325		437
		438	our $retval; # return value for urxvt
		439
326	# called by the rxvt core	440	# called by the rxvt core
327	sub invoke {	441	sub invoke {
328	local $term = shift;	442	local $TERM = shift;
329	my $htype = shift;	443	my $htype = shift;
330		444
331	if ($htype == 0) { # INIT	445	if ($htype == 0) { # INIT
332	my @dirs = ((split /:/, $term->resource ("perl_lib")), "$LIBDIR/perl");	446	my @dirs = ((split /:/, $TERM->resource ("perl_lib")), "$LIBDIR/perl");
333		447
334	for my $ext (split /:/, $term->resource ("perl_ext")) {	448	for my $ext (map { split /:/, $TERM->resource ("perl_ext_$_") } 1, 2) {
335	my @files = grep -f $_, map "$_/$ext", @dirs;	449	my @files = grep -f $_, map "$_/$ext", @dirs;
336		450
337	if (@files) {	451	if (@files) {
338	register_package script_package $files[0];	452	register_package script_package $files[0];
339	} else {	453	} else {
340	warn "perl extension '$ext' not found in perl library search path\n";	454	warn "perl extension '$ext' not found in perl library search path\n";
341	}	455	}
342	}	456	}
		457	}
343		458
		459	$retval = undef;
		460
		461	if (my $cb = $TERM->{_hook}[$htype]) {
		462	verbose 10, "$HOOKNAME[$htype] (" . (join ", ", $TERM, @_) . ")"
		463	if $verbosity >= 10;
		464
		465	keys %$cb;
		466
		467	while (my ($pkg, $cb) = each %$cb) {
		468	$retval = $cb->(
		469	$TERM->{_pkg}{$pkg} \|\|= do {
		470	my $proxy = bless { }, urxvt::term::proxy::;
		471	Scalar::Util::weaken ($proxy->{term} = $TERM);
		472	$proxy
		473	},
		474	@_,
		475	) and last;
		476	}
		477	}
		478
344	} elsif ($htype == 1) { # DESTROY	479	if ($htype == 1) { # DESTROY
		480	# remove hooks if unused
345	if (my $hook = $term->{_hook}) {	481	if (my $hook = $TERM->{_hook}) {
346	for my $htype (0..$#$hook) {	482	for my $htype (0..$#$hook) {
347	$hook_count[$htype] -= scalar keys %{ $hook->[$htype] \|\| {} }	483	$hook_count[$htype] -= scalar keys %{ $hook->[$htype] \|\| {} }
348	or set_should_invoke $htype, 0;	484	or set_should_invoke $htype, 0;
349	}	485	}
350	}	486	}
		487
		488	# clear package objects
		489	%$_ = () for values %{ $TERM->{_pkg} };
		490
		491	# clear package
		492	%$TERM = ();
351	}	493	}
352		494
353	my $cb = $term->{_hook}[$htype]	495	$retval
354	or return;	496	}
355		497
356	verbose 10, "$HOOKNAME[$htype] (" . (join ", ", $term, @_) . ")"	498	sub urxvt::term::proxy::AUTOLOAD {
357	if $verbosity >= 10;	499	$urxvt::term::proxy::AUTOLOAD =~ /:([^:]+)$/
		500	or die "FATAL: \$AUTOLOAD '$urxvt::term::proxy::AUTOLOAD' unparsable";
358		501
359	while (my ($k, $v) = each %$cb) {	502	eval qq{
360	return 1 if $v->($term, @_);	503	sub $urxvt::term::proxy::AUTOLOAD {
361	}	504	my \$proxy = shift;
		505	\$proxy->{term}->$1 (\@_)
		506	}
		507	1
		508	} or die "FATAL: unable to compile method forwarder: $@";
362		509
363	0	510	goto &$urxvt::term::proxy::AUTOLOAD;
364	}	511	}
365		512
366	=head2 The C<urxvt::term> Class	513	=head2 The C<urxvt::term> Class
367		514
368	=over 4	515	=over 4
		516
		517	=item $term->destroy
		518
		519	Destroy the terminal object (close the window, free resources etc.).
369		520
370	=item $value = $term->resource ($name[, $newval])	521	=item $value = $term->resource ($name[, $newval])
371		522
372	Returns the current resource value associated with a given name and	523	Returns the current resource value associated with a given name and
373	optionally sets a new value. Setting values is most useful in the C<init>	524	optionally sets a new value. Setting values is most useful in the C<init>
…		…
391	answerbackstring backgroundPixmap backspace_key boldFont boldItalicFont	542	answerbackstring backgroundPixmap backspace_key boldFont boldItalicFont
392	borderLess color cursorBlink cursorUnderline cutchars delete_key	543	borderLess color cursorBlink cursorUnderline cutchars delete_key
393	display_name embed ext_bwidth fade font geometry hold iconName	544	display_name embed ext_bwidth fade font geometry hold iconName
394	imFont imLocale inputMethod insecure int_bwidth intensityStyles	545	imFont imLocale inputMethod insecure int_bwidth intensityStyles
395	italicFont jumpScroll lineSpace loginShell mapAlert menu meta8 modifier	546	italicFont jumpScroll lineSpace loginShell mapAlert menu meta8 modifier
396	mouseWheelScrollPage name pastableTabs path perl_eval perl_ext	547	mouseWheelScrollPage name pastableTabs path perl_eval perl_ext_1 perl_ext_2
397	perl_lib pointerBlank pointerBlankDelay preeditType print_pipe pty_fd	548	perl_lib pointerBlank pointerBlankDelay preeditType print_pipe pty_fd
398	reverseVideo saveLines scrollBar scrollBar_align scrollBar_floating	549	reverseVideo saveLines scrollBar scrollBar_align scrollBar_floating
399	scrollBar_right scrollBar_thickness scrollTtyKeypress scrollTtyOutput	550	scrollBar_right scrollBar_thickness scrollTtyKeypress scrollTtyOutput
400	scrollWithBuffer scrollstyle secondaryScreen secondaryScroll selectstyle	551	scrollWithBuffer scrollstyle secondaryScreen secondaryScroll selectstyle
401	shade term_name title transparent transparent_all tripleclickwords	552	shade term_name title transparent transparent_all tripleclickwords
…		…
407	my ($self, $name) = (shift, shift);	558	my ($self, $name) = (shift, shift);
408	unshift @_, $self, $name, ($name =~ s/\s\+\s(\d+)$// ? $1 : 0);	559	unshift @_, $self, $name, ($name =~ s/\s\+\s(\d+)$// ? $1 : 0);
409	goto &urxvt::term::_resource;	560	goto &urxvt::term::_resource;
410	}	561	}
411		562
		563	=item $rend = $term->rstyle ([$new_rstyle])
		564
		565	Return and optionally change the current rendition. Text that is output by
		566	the terminal application will use this style.
		567
		568	=item ($row, $col) = $term->screen_cur ([$row, $col])
		569
		570	Return the current coordinates of the text cursor position and optionally
		571	set it (which is usually bad as applications don't expect that).
		572
412	=item ($row, $col) = $term->selection_mark ([$row, $col])	573	=item ($row, $col) = $term->selection_mark ([$row, $col])
413		574
414	=item ($row, $col) = $term->selection_beg ([$row, $col])	575	=item ($row, $col) = $term->selection_beg ([$row, $col])
415		576
416	=item ($row, $col) = $term->selection_end ([$row, $col])	577	=item ($row, $col) = $term->selection_end ([$row, $col])
…		…
430	#=item $term->overlay ($x, $y, $text)	591	#=item $term->overlay ($x, $y, $text)
431	#	592	#
432	#Create a simple multi-line overlay box. See the next method for details.	593	#Create a simple multi-line overlay box. See the next method for details.
433	#	594	#
434	#=cut	595	#=cut
435		596	#
436	sub urxvt::term::scr_overlay {	597	#sub urxvt::term::scr_overlay {
437	die;
438	my ($self, $x, $y, $text) = @_;	598	# my ($self, $x, $y, $text) = @_;
439		599	#
440	my @lines = split /\n/, $text;	600	# my @lines = split /\n/, $text;
441		601	#
442	my $w = 0;	602	# my $w = 0;
443	for (map $self->strwidth ($_), @lines) {	603	# for (map $self->strwidth ($_), @lines) {
444	$w = $_ if $w < $_;	604	# $w = $_ if $w < $_;
445	}	605	# }
446		606	#
447	$self->scr_overlay_new ($x, $y, $w, scalar @lines);	607	# $self->scr_overlay_new ($x, $y, $w, scalar @lines);
448	$self->scr_overlay_set (0, $_, $lines[$_]) for 0.. $#lines;	608	# $self->scr_overlay_set (0, $_, $lines[$_]) for 0.. $#lines;
449	}	609	#}
450		610
451	=item $term->overlay ($x, $y, $width, $height[, $rstyle[, $border]])	611	=item $term->overlay ($x, $y, $width, $height[, $rstyle[, $border]])
452		612
453	Create a new (empty) overlay at the given position with the given	613	Create a new (empty) overlay at the given position with the given
454	width/height. C<$rstyle> defines the initial rendition style	614	width/height. C<$rstyle> defines the initial rendition style
…		…
461	right/bottom side, respectively.	621	right/bottom side, respectively.
462		622
463	This method returns an urxvt::overlay object. The overlay will be visible	623	This method returns an urxvt::overlay object. The overlay will be visible
464	as long as the perl object is referenced.	624	as long as the perl object is referenced.
465		625
466	Currently, the only method on the C<urxvt::overlay> object is C<set>:	626	The methods currently supported on C<urxvt::overlay> objects are:
		627
		628	=over 4
467		629
468	=item $overlay->set ($x, $y, $text, $rend)	630	=item $overlay->set ($x, $y, $text, $rend)
469		631
470	Similar to C<< $term->ROW_t >> and C<< $term->ROW_r >> in that it puts	632	Similar to C<< $term->ROW_t >> and C<< $term->ROW_r >> in that it puts
471	text in rxvt-unicode's special encoding and an array of rendition values	633	text in rxvt-unicode's special encoding and an array of rendition values
472	at a specific position inside the overlay.	634	at a specific position inside the overlay.
473		635
		636	=item $overlay->hide
		637
		638	If visible, hide the overlay, but do not destroy it.
		639
		640	=item $overlay->show
		641
		642	If hidden, display the overlay again.
		643
		644	=back
		645
474	=item $cellwidth = $term->strwidth $string	646	=item $cellwidth = $term->strwidth $string
475		647
476	Returns the number of screen-cells this string would need. Correctly	648	Returns the number of screen-cells this string would need. Correctly
477	accounts for wide and combining characters.	649	accounts for wide and combining characters.
478		650
…		…
481	Convert the given text string into the corresponding locale encoding.	653	Convert the given text string into the corresponding locale encoding.
482		654
483	=item $string = $term->locale_decode $octets	655	=item $string = $term->locale_decode $octets
484		656
485	Convert the given locale-encoded octets into a perl string.	657	Convert the given locale-encoded octets into a perl string.
		658
		659	=item $term->scr_add_lines ($string)
		660
		661	Write the given text string to the screen, as if output by the application
		662	running inside the terminal. It may not contain command sequences (escape
		663	codes), but is free to use line feeds, carriage returns and tabs. The
		664	string is a normal text string, not in locale-dependent encoding.
		665
		666	Normally its not a good idea to use this function, as programs might be
		667	confused by changes in cursor position or scrolling. Its useful inside a
		668	C<on_add_lines> hook, though.
		669
		670	=item $term->cmd_parse ($octets)
		671
		672	Similar to C<scr_add_lines>, but the argument must be in the
		673	locale-specific encoding of the terminal and can contain command sequences
		674	(escape codes) that will be interpreted.
486		675
487	=item $term->tt_write ($octets)	676	=item $term->tt_write ($octets)
488		677
489	Write the octets given in C<$data> to the tty (i.e. as program input). To	678	Write the octets given in C<$data> to the tty (i.e. as program input). To
490	pass characters instead of octets, you should convert your strings first	679	pass characters instead of octets, you should convert your strings first
491	to the locale-specific encoding using C<< $term->locale_encode >>.	680	to the locale-specific encoding using C<< $term->locale_encode >>.
492		681
		682	=item $window_width = $term->width
		683
		684	=item $window_height = $term->height
		685
		686	=item $font_width = $term->fwidth
		687
		688	=item $font_height = $term->fheight
		689
		690	=item $font_ascent = $term->fbase
		691
493	=item $nrow = $term->nrow	692	=item $terminal_rows = $term->nrow
494		693
495	=item $ncol = $term->ncol	694	=item $terminal_columns = $term->ncol
496		695
497	Return the number of rows/columns of the terminal window (i.e. as	696	=item $has_focus = $term->focus
498	specified by C<-geometry>, excluding any scrollback).
499		697
500	=item $nsaved = $term->nsaved	698	=item $is_mapped = $term->mapped
501		699
502	Returns the number of lines in the scrollback buffer.	700	=item $max_scrollback = $term->saveLines
		701
		702	=item $nrow_plus_saveLines = $term->total_rows
		703
		704	=item $lines_in_scrollback = $term->nsaved
		705
		706	Return various integers describing terminal characteristics.
503		707
504	=item $view_start = $term->view_start ([$newvalue])	708	=item $view_start = $term->view_start ([$newvalue])
505		709
506	Returns the negative row number of the topmost line. Minimum value is	710	Returns the negative row number of the topmost line. Minimum value is
507	C<0>, which displays the normal terminal contents. Larger values scroll	711	C<0>, which displays the normal terminal contents. Larger values scroll
…		…
518	=item $text = $term->ROW_t ($row_number[, $new_text[, $start_col]])	722	=item $text = $term->ROW_t ($row_number[, $new_text[, $start_col]])
519		723
520	Returns the text of the entire row with number C<$row_number>. Row C<0>	724	Returns the text of the entire row with number C<$row_number>. Row C<0>
521	is the topmost terminal line, row C<< $term->$ncol-1 >> is the bottommost	725	is the topmost terminal line, row C<< $term->$ncol-1 >> is the bottommost
522	terminal line. The scrollback buffer starts at line C<-1> and extends to	726	terminal line. The scrollback buffer starts at line C<-1> and extends to
523	line C<< -$term->nsaved >>.	727	line C<< -$term->nsaved >>. Nothing will be returned if a nonexistent line
		728	is requested.
524		729
525	If C<$new_text> is specified, it will replace characters in the current	730	If C<$new_text> is specified, it will replace characters in the current
526	line, starting at column C<$start_col> (default C<0>), which is useful	731	line, starting at column C<$start_col> (default C<0>), which is useful
527	to replace only parts of a line. The font index in the rendition will	732	to replace only parts of a line. The font index in the rendition will
528	automatically be updated.	733	automatically be updated.
…		…
550		755
551	See the section on RENDITION, above.	756	See the section on RENDITION, above.
552		757
553	=item $length = $term->ROW_l ($row_number[, $new_length])	758	=item $length = $term->ROW_l ($row_number[, $new_length])
554		759
555	Returns the number of screen cells that are in use ("the line length"). If	760	Returns the number of screen cells that are in use ("the line
556	it is C<-1>, then the line is part of a multiple-row logical "line", which	761	length"). Unlike the urxvt core, this returns C<< $term->ncol >> if the
557	means all characters are in use and it is continued on the next row.	762	line is joined with the following one.
558		763
		764	=item $bool = $term->is_longer ($row_number)
		765
		766	Returns true if the row is part of a multiple-row logical "line" (i.e.
		767	joined with the following row), which means all characters are in use
		768	and it is continued on the next row (and possibly a continuation of the
		769	previous row(s)).
		770
		771	=item $line = $term->line ($row_number)
		772
		773	Create and return a new C<urxvt::line> object that stores information
		774	about the logical line that row C<$row_number> is part of. It supports the
		775	following methods:
		776
		777	=over 4
		778
		779	=item $text = $line->t ([$new_text])
		780
		781	Returns or replaces the full text of the line, similar to C<ROW_t>
		782
		783	=item $rend = $line->r ([$new_rend])
		784
		785	Returns or replaces the full rendition array of the line, similar to C<ROW_r>
		786
		787	=item $length = $line->l
		788
		789	Returns the length of the line in cells, similar to C<ROW_l>.
		790
		791	=item $rownum = $line->beg
		792
		793	=item $rownum = $line->end
		794
		795	Return the row number of the first/last row of the line, respectively.
		796
		797	=item $offset = $line->offset_of ($row, $col)
		798
		799	Returns the character offset of the given row\|col pair within the logical
		800	line.
		801
		802	=item ($row, $col) = $line->coord_of ($offset)
		803
		804	Translates a string offset into terminal coordinates again.
		805
		806	=back
		807
		808	=cut
		809
		810	sub urxvt::term::line {
		811	my ($self, $row) = @_;
		812
		813	my $maxrow = $self->nrow - 1;
		814
		815	my ($beg, $end) = ($row, $row);
		816
		817	--$beg while $self->ROW_is_longer ($beg - 1);
		818	++$end while $self->ROW_is_longer ($end) && $end < $maxrow;
		819
		820	bless {
		821	term => $self,
		822	beg => $beg,
		823	end => $end,
		824	ncol => $self->ncol,
		825	len => ($end - $beg) * $self->ncol + $self->ROW_l ($end),
		826	}, urxvt::line::
		827	}
		828
		829	sub urxvt::line::t {
		830	my ($self) = @_;
		831
		832	if (@_ > 1)
		833	{
		834	$self->{term}->ROW_t ($_, $_[1], 0, ($_ - $self->{beg}) * $self->{ncol}, $self->{ncol})
		835	for $self->{beg} .. $self->{end};
		836	}
		837
		838	defined wantarray &&
		839	substr +(join "", map $self->{term}->ROW_t ($_), $self->{beg} .. $self->{end}),
		840	0, $self->{len}
		841	}
		842
		843	sub urxvt::line::r {
		844	my ($self) = @_;
		845
		846	if (@_ > 1)
		847	{
		848	$self->{term}->ROW_r ($_, $_[1], 0, ($_ - $self->{beg}) * $self->{ncol}, $self->{ncol})
		849	for $self->{beg} .. $self->{end};
		850	}
		851
		852	if (defined wantarray) {
		853	my $rend = [
		854	map @{ $self->{term}->ROW_r ($_) }, $self->{beg} .. $self->{end}
		855	];
		856	$#$rend = $self->{len} - 1;
		857	return $rend;
		858	}
		859
		860	()
		861	}
		862
		863	sub urxvt::line::beg { $_[0]{beg} }
		864	sub urxvt::line::end { $_[0]{end} }
		865	sub urxvt::line::l { $_[0]{len} }
		866
		867	sub urxvt::line::offset_of {
		868	my ($self, $row, $col) = @_;
		869
		870	($row - $self->{beg}) * $self->{ncol} + $col
		871	}
		872
		873	sub urxvt::line::coord_of {
		874	my ($self, $offset) = @_;
		875
		876	use integer;
		877
		878	(
		879	$offset / $self->{ncol} + $self->{beg},
		880	$offset % $self->{ncol}
		881	)
		882	}
		883
		884	=item ($row, $col) = $line->coord_of ($offset)
559	=item $text = $term->special_encode $string	885	=item $text = $term->special_encode $string
560		886
561	Converts a perl string into the special encoding used by rxvt-unicode,	887	Converts a perl string into the special encoding used by rxvt-unicode,
562	where one character corresponds to one screen cell. See	888	where one character corresponds to one screen cell. See
563	C<< $term->ROW_t >> for details.	889	C<< $term->ROW_t >> for details.
…		…
677	This variable controls the verbosity level of the perl extension. Higher	1003	This variable controls the verbosity level of the perl extension. Higher
678	numbers indicate more verbose output.	1004	numbers indicate more verbose output.
679		1005
680	=over 4	1006	=over 4
681		1007
682	=item 0 - only fatal messages	1008	=item =0 - only fatal messages
683		1009
684	=item 3 - script loading and management	1010	=item =3 - script loading and management
685		1011
686	=item 10 - all events received	1012	=item =10 - all events received
687		1013
688	=back	1014	=back
689		1015
690	=head1 AUTHOR	1016	=head1 AUTHOR
691		1017

Diff Legend

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

Comparing rxvt-unicode/src/urxvt.pm (file contents): Revision 1.21 by root, Tue Jan 3 04:20:37 2006 UTC vs. Revision 1.36 by root, Fri Jan 6 02:58:02 2006 UTC

Diff Legend

Comparing rxvt-unicode/src/urxvt.pm (file contents):
Revision 1.21 by root, Tue Jan 3 04:20:37 2006 UTC vs.
Revision 1.36 by root, Fri Jan 6 02:58:02 2006 UTC