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

Comparing rxvt-unicode/src/urxvt.pm (file contents):
Revision 1.27 by root, Tue Jan 3 23:41:37 2006 UTC vs.
Revision 1.44 by root, Sat Jan 7 19:29:17 2006 UTC

…		…
17		17
18	@@RXVT_NAME@@ --perl-lib $HOME -pe grab_test	18	@@RXVT_NAME@@ --perl-lib $HOME -pe grab_test
19		19
20	=head1 DESCRIPTION	20	=head1 DESCRIPTION
21		21
22	Everytime a terminal object gets created, scripts specified via the	22	Everytime a terminal object gets created, extension scripts specified via
23	C<perl> resource are loaded and associated with it.	23	the C<perl> resource are loaded and associated with it.
24		24
25	Scripts are compiled in a 'use strict' and 'use utf8' environment, and	25	Scripts are compiled in a 'use strict' and 'use utf8' environment, and
26	thus must be encoded as UTF-8.	26	thus must be encoded as UTF-8.
27		27
28	Each script will only ever be loaded once, even in @@RXVT_NAME@@d, where	28	Each script will only ever be loaded once, even in @@RXVT_NAME@@d, where
…		…
59	=back	59	=back
60		60
61	=item digital-clock	61	=item digital-clock
62		62
63	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 display filtering (C<on_line_update>) to underline urls.
		68
		69	=item block-graphics-to-ascii
		70
		71	A not very useful example of filtering all text output to the terminal,
		72	by replacing all line-drawing characters (U+2500 .. U+259F) by a
		73	similar-looking ascii character.
64		74
65	=item example-refresh-hooks	75	=item example-refresh-hooks
66		76
67	Displays a very simple digital clock in the upper right corner of the	77	Displays a very simple digital clock in the upper right corner of the
68	window. Illustrates overwriting the refresh callbacks to create your own	78	window. Illustrates overwriting the refresh callbacks to create your own
…		…
81	When objects are destroyed on the C++ side, the perl object hashes are	91	When objects are destroyed on the C++ side, the perl object hashes are
82	emptied, so its best to store related objects such as time watchers and	92	emptied, so its best to store related objects such as time watchers and
83	the like inside the terminal object so they get destroyed as soon as the	93	the like inside the terminal object so they get destroyed as soon as the
84	terminal is destroyed.	94	terminal is destroyed.
85		95
		96	Argument names also often indicate the type of a parameter. Here are some
		97	hints on what they mean:
		98
		99	=over 4
		100
		101	=item $text
		102
		103	Rxvt-unicodes special way of encoding text, where one "unicode" character
		104	always represents one screen cell. See L<row_t> for a discussion of this format.
		105
		106	=item $string
		107
		108	A perl text string, with an emphasis on I<text>. It can store all unicode
		109	characters and is to be distinguished with text encoded in a specific
		110	encoding (often locale-specific) and binary data.
		111
		112	=item $octets
		113
		114	Either binary data or - more common - a text string encoded in a
		115	locale-specific way.
		116
		117	=back
		118
86	=head2 Hooks	119	=head2 Hooks
87		120
88	The following subroutines can be declared in loaded scripts, and will be	121	The following subroutines can be declared in extension files, and will be
89	called whenever the relevant event happens.	122	called whenever the relevant event happens.
90		123
91	The first argument passed to them is an object private to each terminal	124	The first argument passed to them is an object private to each terminal
92	and extension package. You can call all C<urxvt::term> methods on it, but	125	and extension package. You can call all C<urxvt::term> methods on it, but
93	its not a real C<urxvt::term> object. Instead, the real C<urxvt::term>	126	its not a real C<urxvt::term> object. Instead, the real C<urxvt::term>
94	object that is shared between all packages is stored in the C<term>	127	object that is shared between all packages is stored in the C<term>
95	member.	128	member. It is, however, blessed intot he package of the extension script,
		129	so for all practical purposes you can treat an extension script as a class.
96		130
97	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
98	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,
99	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.
100		134
…		…
103	=over 4	137	=over 4
104		138
105	=item on_init $term	139	=item on_init $term
106		140
107	Called after a new terminal object has been initialized, but before	141	Called after a new terminal object has been initialized, but before
108	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.
109		146
110	=item on_reset $term	147	=item on_reset $term
111		148
112	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
113	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
…		…
172		209
173	=item on_tty_activity $term NYI	210	=item on_tty_activity $term NYI
174		211
175	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.
176		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.
		248
177	=item on_refresh_begin $term	249	=item on_refresh_begin $term
178		250
179	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
180	or similar effects by modify terminal contents in refresh_begin, and	252	or similar effects by modify terminal contents in refresh_begin, and
181	restoring them in refresh_end. The built-in overlay and selection display	253	restoring them in refresh_end. The built-in overlay and selection display
…		…
189		261
190	Called whenever the user presses a key combination that has a	262	Called whenever the user presses a key combination that has a
191	C<perl:string> action bound to it (see description of the B<keysym>	263	C<perl:string> action bound to it (see description of the B<keysym>
192	resource in the @@RXVT_NAME@@(1) manpage).	264	resource in the @@RXVT_NAME@@(1) manpage).
193		265
		266	=item on_key_press $term, $event, $octets
		267
		268	=item on_key_release $term, $event
		269
		270	=item on_button_press $term, $event
		271
		272	=item on_button_release $term, $event
		273
		274	=item on_motion_notify $term, $event
		275
		276	Called whenever the corresponding X event is received for the terminal If
		277	the hook returns true, then the even will be ignored by rxvt-unicode.
		278
		279	The event is a hash with most values as named by Xlib (see the XEvent
		280	manpage), with the additional members C<row> and C<col>, which are the row
		281	and column under the mouse cursor.
		282
		283	C<on_key_press> additionally receives the string rxvt-unicode would
		284	output, if any, in locale-specific encoding.
		285
		286	subwindow.
		287
194	=back	288	=back
195		289
196	=head2 Variables in the C<urxvt> Package	290	=head2 Variables in the C<urxvt> Package
197		291
198	=over 4	292	=over 4
199		293
200	=item $urxvt::TERM	294	=item $urxvt::TERM
201		295
202	The current terminal. Whenever a callback/Hook is bein executed, this	296	The current terminal. This variable stores the current C<urxvt::term>
203	variable stores the current C<urxvt::term> object.	297	object, whenever a callback/hook is executing.
204		298
205	=back	299	=back
206		300
207	=head2 Functions in the C<urxvt> Package	301	=head2 Functions in the C<urxvt> Package
208		302
209	=over 4	303	=over 4
		304
		305	=item $term = new urxvt [arg...]
		306
		307	Creates a new terminal, very similar as if you had started it with
		308	C<system $binfile, arg...>. Croaks (and probably outputs an error message)
		309	if the new instance couldn't be created. Returns C<undef> if the new
		310	instance didn't initialise perl, and the terminal object otherwise. The
		311	C<init> and C<start> hooks will be called during the call.
210		312
211	=item urxvt::fatal $errormessage	313	=item urxvt::fatal $errormessage
212		314
213	Fatally aborts execution with the given error message. Avoid at all	315	Fatally aborts execution with the given error message. Avoid at all
214	costs! The only time this is acceptable is when the terminal process	316	costs! The only time this is acceptable is when the terminal process
…		…
327	$hook_count[$htype]++	429	$hook_count[$htype]++
328	or set_should_invoke $htype, 1;	430	or set_should_invoke $htype, 1;
329	}	431	}
330	}	432	}
331		433
332	my $script_pkg = "script0000";	434	my $extension_pkg = "extension0000";
333	my %script_pkg;	435	my %extension_pkg;
334		436
335	# load a single script into its own package, once only	437	# load a single script into its own package, once only
336	sub script_package($) {	438	sub extension_package($) {
337	my ($path) = @_;	439	my ($path) = @_;
338		440
339	$script_pkg{$path} \|\|= do {	441	$extension_pkg{$path} \|\|= do {
340	my $pkg = "urxvt::" . ($script_pkg++);	442	my $pkg = "urxvt::" . ($extension_pkg++);
341		443
342	verbose 3, "loading script '$path' into package '$pkg'";	444	verbose 3, "loading extension '$path' into package '$pkg'";
343		445
344	open my $fh, "<:raw", $path	446	open my $fh, "<:raw", $path
345	or die "$path: $!";	447	or die "$path: $!";
346		448
347	my $source = "package $pkg; use strict; use utf8;\n"	449	my $source = "package $pkg; use strict; use utf8;\n"
		450	. "use base urxvt::term::proxy::;\n"
348	. "#line 1 \"$path\"\n{\n"	451	. "#line 1 \"$path\"\n{\n"
349	. (do { local $/; <$fh> })	452	. (do { local $/; <$fh> })
350	. "\n};\n1";	453	. "\n};\n1";
351		454
352	eval $source or die "$path: $@";	455	eval $source or die "$path: $@";
353		456
354	$pkg	457	$pkg
355	}	458	}
356	}	459	}
		460
		461	our $retval; # return value for urxvt
357		462
358	# called by the rxvt core	463	# called by the rxvt core
359	sub invoke {	464	sub invoke {
360	local $TERM = shift;	465	local $TERM = shift;
361	my $htype = shift;	466	my $htype = shift;
362		467
363	if ($htype == 0) { # INIT	468	if ($htype == 0) { # INIT
364	my @dirs = ((split /:/, $TERM->resource ("perl_lib")), "$LIBDIR/perl");	469	my @dirs = ((split /:/, $TERM->resource ("perl_lib")), "$LIBDIR/perl");
365		470
366	for my $ext (split /:/, $TERM->resource ("perl_ext")) {	471	for my $ext (map { split /,/, $TERM->resource ("perl_ext_$_") } 1, 2) {
367	my @files = grep -f $_, map "$_/$ext", @dirs;	472	my @files = grep -f $_, map "$_/$ext", @dirs;
368		473
369	if (@files) {	474	if (@files) {
370	register_package script_package $files[0];	475	register_package extension_package $files[0];
371	} else {	476	} else {
372	warn "perl extension '$ext' not found in perl library search path\n";	477	warn "perl extension '$ext' not found in perl library search path\n";
373	}	478	}
374	}	479	}
		480	}
375		481
		482	$retval = undef;
		483
		484	if (my $cb = $TERM->{_hook}[$htype]) {
		485	verbose 10, "$HOOKNAME[$htype] (" . (join ", ", $TERM, @_) . ")"
		486	if $verbosity >= 10;
		487
		488	keys %$cb;
		489
		490	while (my ($pkg, $cb) = each %$cb) {
		491	eval {
		492	$retval = $cb->(
		493	$TERM->{_pkg}{$pkg} \|\|= do {
		494	my $proxy = bless { }, $pkg;
		495	Scalar::Util::weaken ($proxy->{term} = $TERM);
		496	$proxy
		497	},
		498	@_,
		499	) and last;
		500	};
		501	warn $@ if $@;#d#
		502	}
		503	}
		504
376	} elsif ($htype == 1) { # DESTROY	505	if ($htype == 1) { # DESTROY
		506	# remove hooks if unused
377	if (my $hook = $TERM->{_hook}) {	507	if (my $hook = $TERM->{_hook}) {
378	for my $htype (0..$#$hook) {	508	for my $htype (0..$#$hook) {
379	$hook_count[$htype] -= scalar keys %{ $hook->[$htype] \|\| {} }	509	$hook_count[$htype] -= scalar keys %{ $hook->[$htype] \|\| {} }
380	or set_should_invoke $htype, 0;	510	or set_should_invoke $htype, 0;
381	}	511	}
382	}	512	}
		513
		514	# clear package objects
		515	%$_ = () for values %{ $TERM->{_pkg} };
		516
		517	# clear package
		518	%$TERM = ();
383	}	519	}
384		520
385	my $cb = $TERM->{_hook}[$htype]	521	$retval
386	or return;
387
388	verbose 10, "$HOOKNAME[$htype] (" . (join ", ", $TERM, @_) . ")"
389	if $verbosity >= 10;
390
391	keys %$cb;
392
393	while (my ($pkg, $cb) = each %$cb) {
394	return 1
395	if $cb->(
396	$TERM->{$pkg} \|\|= do {
397	my $proxy = bless { }, urxvt::term::proxy::;
398	Scalar::Util::weaken ($proxy->{term} = $TERM);
399	$proxy
400	},
401	@_,
402	);
403	}
404
405	0
406	}	522	}
407		523
408	sub urxvt::term::proxy::AUTOLOAD {	524	sub urxvt::term::proxy::AUTOLOAD {
409	$urxvt::term::proxy::AUTOLOAD =~ /:([^:]+)$/	525	$urxvt::term::proxy::AUTOLOAD =~ /:([^:]+)$/
410	or die "FATAL: \$AUTOLOAD '$urxvt::term::proxy::AUTOLOAD' unparsable";	526	or die "FATAL: \$AUTOLOAD '$urxvt::term::proxy::AUTOLOAD' unparsable";
…		…
422		538
423	=head2 The C<urxvt::term> Class	539	=head2 The C<urxvt::term> Class
424		540
425	=over 4	541	=over 4
426		542
		543	=item $term->destroy
		544
		545	Destroy the terminal object (close the window, free resources etc.).
		546
427	=item $value = $term->resource ($name[, $newval])	547	=item $value = $term->resource ($name[, $newval])
428		548
429	Returns the current resource value associated with a given name and	549	Returns the current resource value associated with a given name and
430	optionally sets a new value. Setting values is most useful in the C<init>	550	optionally sets a new value. Setting values is most useful in the C<init>
431	hook. Unset resources are returned and accepted as C<undef>.	551	hook. Unset resources are returned and accepted as C<undef>.
…		…
448	answerbackstring backgroundPixmap backspace_key boldFont boldItalicFont	568	answerbackstring backgroundPixmap backspace_key boldFont boldItalicFont
449	borderLess color cursorBlink cursorUnderline cutchars delete_key	569	borderLess color cursorBlink cursorUnderline cutchars delete_key
450	display_name embed ext_bwidth fade font geometry hold iconName	570	display_name embed ext_bwidth fade font geometry hold iconName
451	imFont imLocale inputMethod insecure int_bwidth intensityStyles	571	imFont imLocale inputMethod insecure int_bwidth intensityStyles
452	italicFont jumpScroll lineSpace loginShell mapAlert menu meta8 modifier	572	italicFont jumpScroll lineSpace loginShell mapAlert menu meta8 modifier
453	mouseWheelScrollPage name pastableTabs path perl_eval perl_ext	573	mouseWheelScrollPage name pastableTabs path perl_eval perl_ext_1 perl_ext_2
454	perl_lib pointerBlank pointerBlankDelay preeditType print_pipe pty_fd	574	perl_lib pointerBlank pointerBlankDelay preeditType print_pipe pty_fd
455	reverseVideo saveLines scrollBar scrollBar_align scrollBar_floating	575	reverseVideo saveLines scrollBar scrollBar_align scrollBar_floating
456	scrollBar_right scrollBar_thickness scrollTtyKeypress scrollTtyOutput	576	scrollBar_right scrollBar_thickness scrollTtyKeypress scrollTtyOutput
457	scrollWithBuffer scrollstyle secondaryScreen secondaryScroll selectstyle	577	scrollWithBuffer scrollstyle secondaryScreen secondaryScroll selectstyle
458	shade term_name title transparent transparent_all tripleclickwords	578	shade term_name title transparent transparent_all tripleclickwords
…		…
464	my ($self, $name) = (shift, shift);	584	my ($self, $name) = (shift, shift);
465	unshift @_, $self, $name, ($name =~ s/\s\+\s(\d+)$// ? $1 : 0);	585	unshift @_, $self, $name, ($name =~ s/\s\+\s(\d+)$// ? $1 : 0);
466	goto &urxvt::term::_resource;	586	goto &urxvt::term::_resource;
467	}	587	}
468		588
		589	=item $rend = $term->rstyle ([$new_rstyle])
		590
		591	Return and optionally change the current rendition. Text that is output by
		592	the terminal application will use this style.
		593
		594	=item ($row, $col) = $term->screen_cur ([$row, $col])
		595
		596	Return the current coordinates of the text cursor position and optionally
		597	set it (which is usually bad as applications don't expect that).
		598
469	=item ($row, $col) = $term->selection_mark ([$row, $col])	599	=item ($row, $col) = $term->selection_mark ([$row, $col])
470		600
471	=item ($row, $col) = $term->selection_beg ([$row, $col])	601	=item ($row, $col) = $term->selection_beg ([$row, $col])
472		602
473	=item ($row, $col) = $term->selection_end ([$row, $col])	603	=item ($row, $col) = $term->selection_end ([$row, $col])
…		…
487	#=item $term->overlay ($x, $y, $text)	617	#=item $term->overlay ($x, $y, $text)
488	#	618	#
489	#Create a simple multi-line overlay box. See the next method for details.	619	#Create a simple multi-line overlay box. See the next method for details.
490	#	620	#
491	#=cut	621	#=cut
492		622	#
493	sub urxvt::term::scr_overlay {	623	#sub urxvt::term::scr_overlay {
494	die;
495	my ($self, $x, $y, $text) = @_;	624	# my ($self, $x, $y, $text) = @_;
496		625	#
497	my @lines = split /\n/, $text;	626	# my @lines = split /\n/, $text;
498		627	#
499	my $w = 0;	628	# my $w = 0;
500	for (map $self->strwidth ($_), @lines) {	629	# for (map $self->strwidth ($_), @lines) {
501	$w = $_ if $w < $_;	630	# $w = $_ if $w < $_;
502	}	631	# }
503		632	#
504	$self->scr_overlay_new ($x, $y, $w, scalar @lines);	633	# $self->scr_overlay_new ($x, $y, $w, scalar @lines);
505	$self->scr_overlay_set (0, $_, $lines[$_]) for 0.. $#lines;	634	# $self->scr_overlay_set (0, $_, $lines[$_]) for 0.. $#lines;
506	}	635	#}
507		636
508	=item $term->overlay ($x, $y, $width, $height[, $rstyle[, $border]])	637	=item $term->overlay ($x, $y, $width, $height[, $rstyle[, $border]])
509		638
510	Create a new (empty) overlay at the given position with the given	639	Create a new (empty) overlay at the given position with the given
511	width/height. C<$rstyle> defines the initial rendition style	640	width/height. C<$rstyle> defines the initial rendition style
…		…
538		667
539	If hidden, display the overlay again.	668	If hidden, display the overlay again.
540		669
541	=back	670	=back
542		671
543	=item $cellwidth = $term->strwidth $string	672	=item $cellwidth = $term->strwidth ($string)
544		673
545	Returns the number of screen-cells this string would need. Correctly	674	Returns the number of screen-cells this string would need. Correctly
546	accounts for wide and combining characters.	675	accounts for wide and combining characters.
547		676
548	=item $octets = $term->locale_encode $string	677	=item $octets = $term->locale_encode ($string)
549		678
550	Convert the given text string into the corresponding locale encoding.	679	Convert the given text string into the corresponding locale encoding.
551		680
552	=item $string = $term->locale_decode $octets	681	=item $string = $term->locale_decode ($octets)
553		682
554	Convert the given locale-encoded octets into a perl string.	683	Convert the given locale-encoded octets into a perl string.
		684
		685	=item $term->scr_add_lines ($string)
		686
		687	Write the given text string to the screen, as if output by the application
		688	running inside the terminal. It may not contain command sequences (escape
		689	codes), but is free to use line feeds, carriage returns and tabs. The
		690	string is a normal text string, not in locale-dependent encoding.
		691
		692	Normally its not a good idea to use this function, as programs might be
		693	confused by changes in cursor position or scrolling. Its useful inside a
		694	C<on_add_lines> hook, though.
		695
		696	=item $term->cmd_parse ($octets)
		697
		698	Similar to C<scr_add_lines>, but the argument must be in the
		699	locale-specific encoding of the terminal and can contain command sequences
		700	(escape codes) that will be interpreted.
555		701
556	=item $term->tt_write ($octets)	702	=item $term->tt_write ($octets)
557		703
558	Write the octets given in C<$data> to the tty (i.e. as program input). To	704	Write the octets given in C<$data> to the tty (i.e. as program input). To
559	pass characters instead of octets, you should convert your strings first	705	pass characters instead of octets, you should convert your strings first
560	to the locale-specific encoding using C<< $term->locale_encode >>.	706	to the locale-specific encoding using C<< $term->locale_encode >>.
561		707
		708	=item $windowid = $term->parent
		709
		710	Return the window id of the toplevel window.
		711
		712	=item $windowid = $term->vt
		713
		714	Return the window id of the terminal window.
		715
		716	=item $window_width = $term->width
		717
		718	=item $window_height = $term->height
		719
		720	=item $font_width = $term->fwidth
		721
		722	=item $font_height = $term->fheight
		723
		724	=item $font_ascent = $term->fbase
		725
562	=item $nrow = $term->nrow	726	=item $terminal_rows = $term->nrow
563		727
564	=item $ncol = $term->ncol	728	=item $terminal_columns = $term->ncol
565		729
566	Return the number of rows/columns of the terminal window (i.e. as	730	=item $has_focus = $term->focus
567	specified by C<-geometry>, excluding any scrollback).
568		731
569	=item $nsaved = $term->nsaved	732	=item $is_mapped = $term->mapped
570		733
571	Returns the number of lines in the scrollback buffer.	734	=item $max_scrollback = $term->saveLines
		735
		736	=item $nrow_plus_saveLines = $term->total_rows
		737
		738	=item $lines_in_scrollback = $term->nsaved
		739
		740	Return various integers describing terminal characteristics.
572		741
573	=item $view_start = $term->view_start ([$newvalue])	742	=item $view_start = $term->view_start ([$newvalue])
574		743
575	Returns the negative row number of the topmost line. Minimum value is	744	Returns the negative row number of the topmost line. Minimum value is
576	C<0>, which displays the normal terminal contents. Larger values scroll	745	C<0>, which displays the normal terminal contents. Larger values scroll
…		…
639	about the logical line that row C<$row_number> is part of. It supports the	808	about the logical line that row C<$row_number> is part of. It supports the
640	following methods:	809	following methods:
641		810
642	=over 4	811	=over 4
643		812
644	=item $text = $line->t	813	=item $text = $line->t ([$new_text])
645		814
646	Returns the full text of the line, similar to C<ROW_t>	815	Returns or replaces the full text of the line, similar to C<ROW_t>
647		816
648	=item $rend = $line->r	817	=item $rend = $line->r ([$new_rend])
649		818
650	Returns the full rendition array of the line, similar to C<ROW_r>	819	Returns or replaces the full rendition array of the line, similar to C<ROW_r>
651		820
652	=item $length = $line->l	821	=item $length = $line->l
653		822
654	Returns the length of the line in cells, similar to C<ROW_l>.	823	Returns the length of the line in cells, similar to C<ROW_l>.
655		824
…		…
684		853
685	bless {	854	bless {
686	term => $self,	855	term => $self,
687	beg => $beg,	856	beg => $beg,
688	end => $end,	857	end => $end,
		858	ncol => $self->ncol,
689	len => ($end - $beg) * $self->ncol + $self->ROW_l ($end),	859	len => ($end - $beg) * $self->ncol + $self->ROW_l ($end),
690	}, urxvt::line::	860	}, urxvt::line::
691	}	861	}
692		862
693	sub urxvt::line::t {	863	sub urxvt::line::t {
694	my ($self) = @_;	864	my ($self) = @_;
695		865
		866	if (@_ > 1)
		867	{
		868	$self->{term}->ROW_t ($_, $_[1], 0, ($_ - $self->{beg}) * $self->{ncol}, $self->{ncol})
		869	for $self->{beg} .. $self->{end};
		870	}
		871
		872	defined wantarray &&
696	substr +(join "", map $self->{term}->ROW_t ($_), $self->{beg} .. $self->{end}),	873	substr +(join "", map $self->{term}->ROW_t ($_), $self->{beg} .. $self->{end}),
697	0, $self->{len}	874	0, $self->{len}
698	}	875	}
699		876
700	sub urxvt::line::r {	877	sub urxvt::line::r {
701	my ($self) = @_;	878	my ($self) = @_;
702		879
		880	if (@_ > 1)
		881	{
		882	$self->{term}->ROW_r ($_, $_[1], 0, ($_ - $self->{beg}) * $self->{ncol}, $self->{ncol})
		883	for $self->{beg} .. $self->{end};
		884	}
		885
		886	if (defined wantarray) {
703	my $rend = [	887	my $rend = [
704	map @{ $self->{term}->ROW_r ($_) }, $self->{beg} .. $self->{end}	888	map @{ $self->{term}->ROW_r ($_) }, $self->{beg} .. $self->{end}
705	];	889	];
706	$#$rend = $self->{len} - 1;	890	$#$rend = $self->{len} - 1;
707	$rend	891	return $rend;
		892	}
		893
		894	()
708	}	895	}
709		896
710	sub urxvt::line::beg { $_[0]{beg} }	897	sub urxvt::line::beg { $_[0]{beg} }
711	sub urxvt::line::end { $_[0]{end} }	898	sub urxvt::line::end { $_[0]{end} }
712	sub urxvt::line::l { $_[0]{len} }	899	sub urxvt::line::l { $_[0]{len} }
713		900
714	sub urxvt::line::offset_of {	901	sub urxvt::line::offset_of {
715	my ($self, $row, $col) = @_;	902	my ($self, $row, $col) = @_;
716		903
717	($row - $self->{beg}) * $self->{term}->ncol + $col	904	($row - $self->{beg}) * $self->{ncol} + $col
718	}	905	}
719		906
720	sub urxvt::line::coord_of {	907	sub urxvt::line::coord_of {
721	my ($self, $offset) = @_;	908	my ($self, $offset) = @_;
722		909
723	use integer;	910	use integer;
724		911
725	(	912	(
726	$offset / $self->{term}->ncol + $self->{beg},	913	$offset / $self->{ncol} + $self->{beg},
727	$offset % $self->{term}->ncol	914	$offset % $self->{ncol}
728	)	915	)
729	}	916	}
730		917
731	=item ($row, $col) = $line->coord_of ($offset)	918	=item ($row, $col) = $line->coord_of ($offset)
732	=item $text = $term->special_encode $string	919	=item $text = $term->special_encode $string

Diff Legend

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

Comparing rxvt-unicode/src/urxvt.pm (file contents): Revision 1.27 by root, Tue Jan 3 23:41:37 2006 UTC vs. Revision 1.44 by root, Sat Jan 7 19:29:17 2006 UTC

Diff Legend

Comparing rxvt-unicode/src/urxvt.pm (file contents):
Revision 1.27 by root, Tue Jan 3 23:41:37 2006 UTC vs.
Revision 1.44 by root, Sat Jan 7 19:29:17 2006 UTC