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

Comparing rxvt-unicode/src/urxvt.pm (file contents):
Revision 1.22 by root, Tue Jan 3 19:10:54 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
…		…
39		39
40	=over 4	40	=over 4
41		41
42	=item selection	42	=item selection
43		43
44	Intelligent selection. This etxension tries to be more intelligent when the user	44	Intelligent selection. This extension tries to be more intelligent when
45	extends selections (double-click).	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>.
46		48
47	It also offers the following bindable event:	49	It also offers the following bindable event:
48		50
49	=over 4	51	=over 4
50		52
…		…
57	=back	59	=back
58		60
59	=item digital-clock	61	=item digital-clock
60		62
61	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.
62		74
63	=item example-refresh-hooks	75	=item example-refresh-hooks
64		76
65	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
66	window. Illustrates overwriting the refresh callbacks to create your own	78	window. Illustrates overwriting the refresh callbacks to create your own
…		…
71	=head2 General API Considerations	83	=head2 General API Considerations
72		84
73	All objects (such as terminals, time watchers etc.) are typical	85	All objects (such as terminals, time watchers etc.) are typical
74	reference-to-hash objects. The hash can be used to store anything you	86	reference-to-hash objects. The hash can be used to store anything you
75	like. All members starting with an underscore (such as C<_ptr> or	87	like. All members starting with an underscore (such as C<_ptr> or
76	C<_hook>) are reserved for internal uses and must not be accessed or	88	C<_hook>) are reserved for internal uses and B<MUST NOT> be accessed or
77	modified).	89	modified).
78		90
79	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
80	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
81	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
82	terminal is destroyed.	94	terminal is destroyed.
83		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
84	=head2 Hooks	119	=head2 Hooks
85		120
86	The following subroutines can be declared in loaded scripts, and will be called	121	The following subroutines can be declared in extension files, and will be
87	whenever the relevant event happens.	122	called whenever the relevant event happens.
		123
		124	The first argument passed to them is an object private to each terminal
		125	and extension package. You can call all C<urxvt::term> methods on it, but
		126	its not a real C<urxvt::term> object. Instead, the real C<urxvt::term>
		127	object that is shared between all packages is stored in the C<term>
		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.
88		130
89	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
90	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,
91	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.
92		134
…		…
95	=over 4	137	=over 4
96		138
97	=item on_init $term	139	=item on_init $term
98		140
99	Called after a new terminal object has been initialized, but before	141	Called after a new terminal object has been initialized, but before
100	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.
101		146
102	=item on_reset $term	147	=item on_reset $term
103		148
104	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
105	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
…		…
164		209
165	=item on_tty_activity $term NYI	210	=item on_tty_activity $term NYI
166		211
167	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.
168		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
169	=item on_refresh_begin $term	249	=item on_refresh_begin $term
170		250
171	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
172	or similar effects by modify terminal contents in refresh_begin, and	252	or similar effects by modify terminal contents in refresh_begin, and
173	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
…		…
181		261
182	Called whenever the user presses a key combination that has a	262	Called whenever the user presses a key combination that has a
183	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>
184	resource in the @@RXVT_NAME@@(1) manpage).	264	resource in the @@RXVT_NAME@@(1) manpage).
185		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
		288	=back
		289
		290	=head2 Variables in the C<urxvt> Package
		291
		292	=over 4
		293
		294	=item $urxvt::TERM
		295
		296	The current terminal. This variable stores the current C<urxvt::term>
		297	object, whenever a callback/hook is executing.
		298
186	=back	299	=back
187		300
188	=head2 Functions in the C<urxvt> Package	301	=head2 Functions in the C<urxvt> Package
189		302
190	=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.
191		312
192	=item urxvt::fatal $errormessage	313	=item urxvt::fatal $errormessage
193		314
194	Fatally aborts execution with the given error message. Avoid at all	315	Fatally aborts execution with the given error message. Avoid at all
195	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
…		…
265	=cut	386	=cut
266		387
267	package urxvt;	388	package urxvt;
268		389
269	use strict;	390	use strict;
		391	use Scalar::Util ();
270		392
271	our $term;	393	our $TERM;
272	our @HOOKNAME;	394	our @HOOKNAME;
273	our $LIBDIR;	395	our $LIBDIR;
274		396
275	BEGIN {	397	BEGIN {
276	urxvt->bootstrap;	398	urxvt->bootstrap;
…		…
301	my $name = $HOOKNAME[$htype];	423	my $name = $HOOKNAME[$htype];
302		424
303	my $ref = $pkg->can ("on_" . lc $name)	425	my $ref = $pkg->can ("on_" . lc $name)
304	or next;	426	or next;
305		427
306	$term->{_hook}[$htype]{$ref*1} = $ref;	428	$TERM->{_hook}[$htype]{$pkg} = $ref;
307	$hook_count[$htype]++	429	$hook_count[$htype]++
308	or set_should_invoke $htype, 1;	430	or set_should_invoke $htype, 1;
309	}	431	}
310	}	432	}
311		433
312	my $script_pkg = "script0000";	434	my $extension_pkg = "extension0000";
313	my %script_pkg;	435	my %extension_pkg;
314		436
315	# load a single script into its own package, once only	437	# load a single script into its own package, once only
316	sub script_package($) {	438	sub extension_package($) {
317	my ($path) = @_;	439	my ($path) = @_;
318		440
319	$script_pkg{$path} \|\|= do {	441	$extension_pkg{$path} \|\|= do {
320	my $pkg = "urxvt::" . ($script_pkg++);	442	my $pkg = "urxvt::" . ($extension_pkg++);
321		443
322	verbose 3, "loading script '$path' into package '$pkg'";	444	verbose 3, "loading extension '$path' into package '$pkg'";
323		445
324	open my $fh, "<:raw", $path	446	open my $fh, "<:raw", $path
325	or die "$path: $!";	447	or die "$path: $!";
326		448
327	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"
328	. "#line 1 \"$path\"\n{\n"	451	. "#line 1 \"$path\"\n{\n"
329	. (do { local $/; <$fh> })	452	. (do { local $/; <$fh> })
330	. "\n};\n1";	453	. "\n};\n1";
331		454
332	eval $source or die "$path: $@";	455	eval $source or die "$path: $@";
333		456
334	$pkg	457	$pkg
335	}	458	}
336	}	459	}
337		460
		461	our $retval; # return value for urxvt
		462
338	# called by the rxvt core	463	# called by the rxvt core
339	sub invoke {	464	sub invoke {
340	local $term = shift;	465	local $TERM = shift;
341	my $htype = shift;	466	my $htype = shift;
342		467
343	if ($htype == 0) { # INIT	468	if ($htype == 0) { # INIT
344	my @dirs = ((split /:/, $term->resource ("perl_lib")), "$LIBDIR/perl");	469	my @dirs = ((split /:/, $TERM->resource ("perl_lib")), "$LIBDIR/perl");
345		470
346	for my $ext (split /:/, $term->resource ("perl_ext")) {	471	for my $ext (map { split /,/, $TERM->resource ("perl_ext_$_") } 1, 2) {
347	my @files = grep -f $_, map "$_/$ext", @dirs;	472	my @files = grep -f $_, map "$_/$ext", @dirs;
348		473
349	if (@files) {	474	if (@files) {
350	register_package script_package $files[0];	475	register_package extension_package $files[0];
351	} else {	476	} else {
352	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";
353	}	478	}
354	}	479	}
		480	}
355		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
356	} elsif ($htype == 1) { # DESTROY	505	if ($htype == 1) { # DESTROY
		506	# remove hooks if unused
357	if (my $hook = $term->{_hook}) {	507	if (my $hook = $TERM->{_hook}) {
358	for my $htype (0..$#$hook) {	508	for my $htype (0..$#$hook) {
359	$hook_count[$htype] -= scalar keys %{ $hook->[$htype] \|\| {} }	509	$hook_count[$htype] -= scalar keys %{ $hook->[$htype] \|\| {} }
360	or set_should_invoke $htype, 0;	510	or set_should_invoke $htype, 0;
361	}	511	}
362	}	512	}
		513
		514	# clear package objects
		515	%$_ = () for values %{ $TERM->{_pkg} };
		516
		517	# clear package
		518	%$TERM = ();
363	}	519	}
364		520
365	my $cb = $term->{_hook}[$htype]	521	$retval
366	or return;	522	}
367		523
368	verbose 10, "$HOOKNAME[$htype] (" . (join ", ", $term, @_) . ")"	524	sub urxvt::term::proxy::AUTOLOAD {
369	if $verbosity >= 10;	525	$urxvt::term::proxy::AUTOLOAD =~ /:([^:]+)$/
		526	or die "FATAL: \$AUTOLOAD '$urxvt::term::proxy::AUTOLOAD' unparsable";
370		527
371	while (my ($k, $v) = each %$cb) {	528	eval qq{
372	return 1 if $v->($term, @_);	529	sub $urxvt::term::proxy::AUTOLOAD {
373	}	530	my \$proxy = shift;
		531	\$proxy->{term}->$1 (\@_)
		532	}
		533	1
		534	} or die "FATAL: unable to compile method forwarder: $@";
374		535
375	0	536	goto &$urxvt::term::proxy::AUTOLOAD;
376	}	537	}
377		538
378	=head2 The C<urxvt::term> Class	539	=head2 The C<urxvt::term> Class
379		540
380	=over 4	541	=over 4
		542
		543	=item $term->destroy
		544
		545	Destroy the terminal object (close the window, free resources etc.).
381		546
382	=item $value = $term->resource ($name[, $newval])	547	=item $value = $term->resource ($name[, $newval])
383		548
384	Returns the current resource value associated with a given name and	549	Returns the current resource value associated with a given name and
385	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>
…		…
403	answerbackstring backgroundPixmap backspace_key boldFont boldItalicFont	568	answerbackstring backgroundPixmap backspace_key boldFont boldItalicFont
404	borderLess color cursorBlink cursorUnderline cutchars delete_key	569	borderLess color cursorBlink cursorUnderline cutchars delete_key
405	display_name embed ext_bwidth fade font geometry hold iconName	570	display_name embed ext_bwidth fade font geometry hold iconName
406	imFont imLocale inputMethod insecure int_bwidth intensityStyles	571	imFont imLocale inputMethod insecure int_bwidth intensityStyles
407	italicFont jumpScroll lineSpace loginShell mapAlert menu meta8 modifier	572	italicFont jumpScroll lineSpace loginShell mapAlert menu meta8 modifier
408	mouseWheelScrollPage name pastableTabs path perl_eval perl_ext	573	mouseWheelScrollPage name pastableTabs path perl_eval perl_ext_1 perl_ext_2
409	perl_lib pointerBlank pointerBlankDelay preeditType print_pipe pty_fd	574	perl_lib pointerBlank pointerBlankDelay preeditType print_pipe pty_fd
410	reverseVideo saveLines scrollBar scrollBar_align scrollBar_floating	575	reverseVideo saveLines scrollBar scrollBar_align scrollBar_floating
411	scrollBar_right scrollBar_thickness scrollTtyKeypress scrollTtyOutput	576	scrollBar_right scrollBar_thickness scrollTtyKeypress scrollTtyOutput
412	scrollWithBuffer scrollstyle secondaryScreen secondaryScroll selectstyle	577	scrollWithBuffer scrollstyle secondaryScreen secondaryScroll selectstyle
413	shade term_name title transparent transparent_all tripleclickwords	578	shade term_name title transparent transparent_all tripleclickwords
…		…
419	my ($self, $name) = (shift, shift);	584	my ($self, $name) = (shift, shift);
420	unshift @_, $self, $name, ($name =~ s/\s\+\s(\d+)$// ? $1 : 0);	585	unshift @_, $self, $name, ($name =~ s/\s\+\s(\d+)$// ? $1 : 0);
421	goto &urxvt::term::_resource;	586	goto &urxvt::term::_resource;
422	}	587	}
423		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
424	=item ($row, $col) = $term->selection_mark ([$row, $col])	599	=item ($row, $col) = $term->selection_mark ([$row, $col])
425		600
426	=item ($row, $col) = $term->selection_beg ([$row, $col])	601	=item ($row, $col) = $term->selection_beg ([$row, $col])
427		602
428	=item ($row, $col) = $term->selection_end ([$row, $col])	603	=item ($row, $col) = $term->selection_end ([$row, $col])
…		…
442	#=item $term->overlay ($x, $y, $text)	617	#=item $term->overlay ($x, $y, $text)
443	#	618	#
444	#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.
445	#	620	#
446	#=cut	621	#=cut
447		622	#
448	sub urxvt::term::scr_overlay {	623	#sub urxvt::term::scr_overlay {
449	die;
450	my ($self, $x, $y, $text) = @_;	624	# my ($self, $x, $y, $text) = @_;
451		625	#
452	my @lines = split /\n/, $text;	626	# my @lines = split /\n/, $text;
453		627	#
454	my $w = 0;	628	# my $w = 0;
455	for (map $self->strwidth ($_), @lines) {	629	# for (map $self->strwidth ($_), @lines) {
456	$w = $_ if $w < $_;	630	# $w = $_ if $w < $_;
457	}	631	# }
458		632	#
459	$self->scr_overlay_new ($x, $y, $w, scalar @lines);	633	# $self->scr_overlay_new ($x, $y, $w, scalar @lines);
460	$self->scr_overlay_set (0, $_, $lines[$_]) for 0.. $#lines;	634	# $self->scr_overlay_set (0, $_, $lines[$_]) for 0.. $#lines;
461	}	635	#}
462		636
463	=item $term->overlay ($x, $y, $width, $height[, $rstyle[, $border]])	637	=item $term->overlay ($x, $y, $width, $height[, $rstyle[, $border]])
464		638
465	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
466	width/height. C<$rstyle> defines the initial rendition style	640	width/height. C<$rstyle> defines the initial rendition style
…		…
493		667
494	If hidden, display the overlay again.	668	If hidden, display the overlay again.
495		669
496	=back	670	=back
497		671
498	=item $cellwidth = $term->strwidth $string	672	=item $cellwidth = $term->strwidth ($string)
499		673
500	Returns the number of screen-cells this string would need. Correctly	674	Returns the number of screen-cells this string would need. Correctly
501	accounts for wide and combining characters.	675	accounts for wide and combining characters.
502		676
503	=item $octets = $term->locale_encode $string	677	=item $octets = $term->locale_encode ($string)
504		678
505	Convert the given text string into the corresponding locale encoding.	679	Convert the given text string into the corresponding locale encoding.
506		680
507	=item $string = $term->locale_decode $octets	681	=item $string = $term->locale_decode ($octets)
508		682
509	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.
510		701
511	=item $term->tt_write ($octets)	702	=item $term->tt_write ($octets)
512		703
513	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
514	pass characters instead of octets, you should convert your strings first	705	pass characters instead of octets, you should convert your strings first
515	to the locale-specific encoding using C<< $term->locale_encode >>.	706	to the locale-specific encoding using C<< $term->locale_encode >>.
516		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
517	=item $nrow = $term->nrow	726	=item $terminal_rows = $term->nrow
518		727
519	=item $ncol = $term->ncol	728	=item $terminal_columns = $term->ncol
520		729
521	Return the number of rows/columns of the terminal window (i.e. as	730	=item $has_focus = $term->focus
522	specified by C<-geometry>, excluding any scrollback).
523		731
524	=item $nsaved = $term->nsaved	732	=item $is_mapped = $term->mapped
525		733
526	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.
527		741
528	=item $view_start = $term->view_start ([$newvalue])	742	=item $view_start = $term->view_start ([$newvalue])
529		743
530	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
531	C<0>, which displays the normal terminal contents. Larger values scroll	745	C<0>, which displays the normal terminal contents. Larger values scroll
…		…
542	=item $text = $term->ROW_t ($row_number[, $new_text[, $start_col]])	756	=item $text = $term->ROW_t ($row_number[, $new_text[, $start_col]])
543		757
544	Returns the text of the entire row with number C<$row_number>. Row C<0>	758	Returns the text of the entire row with number C<$row_number>. Row C<0>
545	is the topmost terminal line, row C<< $term->$ncol-1 >> is the bottommost	759	is the topmost terminal line, row C<< $term->$ncol-1 >> is the bottommost
546	terminal line. The scrollback buffer starts at line C<-1> and extends to	760	terminal line. The scrollback buffer starts at line C<-1> and extends to
547	line C<< -$term->nsaved >>.	761	line C<< -$term->nsaved >>. Nothing will be returned if a nonexistent line
		762	is requested.
548		763
549	If C<$new_text> is specified, it will replace characters in the current	764	If C<$new_text> is specified, it will replace characters in the current
550	line, starting at column C<$start_col> (default C<0>), which is useful	765	line, starting at column C<$start_col> (default C<0>), which is useful
551	to replace only parts of a line. The font index in the rendition will	766	to replace only parts of a line. The font index in the rendition will
552	automatically be updated.	767	automatically be updated.
…		…
574		789
575	See the section on RENDITION, above.	790	See the section on RENDITION, above.
576		791
577	=item $length = $term->ROW_l ($row_number[, $new_length])	792	=item $length = $term->ROW_l ($row_number[, $new_length])
578		793
579	Returns the number of screen cells that are in use ("the line length"). If	794	Returns the number of screen cells that are in use ("the line
580	it is C<-1>, then the line is part of a multiple-row logical "line", which	795	length"). Unlike the urxvt core, this returns C<< $term->ncol >> if the
581	means all characters are in use and it is continued on the next row.	796	line is joined with the following one.
582		797
		798	=item $bool = $term->is_longer ($row_number)
		799
		800	Returns true if the row is part of a multiple-row logical "line" (i.e.
		801	joined with the following row), which means all characters are in use
		802	and it is continued on the next row (and possibly a continuation of the
		803	previous row(s)).
		804
		805	=item $line = $term->line ($row_number)
		806
		807	Create and return a new C<urxvt::line> object that stores information
		808	about the logical line that row C<$row_number> is part of. It supports the
		809	following methods:
		810
		811	=over 4
		812
		813	=item $text = $line->t ([$new_text])
		814
		815	Returns or replaces the full text of the line, similar to C<ROW_t>
		816
		817	=item $rend = $line->r ([$new_rend])
		818
		819	Returns or replaces the full rendition array of the line, similar to C<ROW_r>
		820
		821	=item $length = $line->l
		822
		823	Returns the length of the line in cells, similar to C<ROW_l>.
		824
		825	=item $rownum = $line->beg
		826
		827	=item $rownum = $line->end
		828
		829	Return the row number of the first/last row of the line, respectively.
		830
		831	=item $offset = $line->offset_of ($row, $col)
		832
		833	Returns the character offset of the given row\|col pair within the logical
		834	line.
		835
		836	=item ($row, $col) = $line->coord_of ($offset)
		837
		838	Translates a string offset into terminal coordinates again.
		839
		840	=back
		841
		842	=cut
		843
		844	sub urxvt::term::line {
		845	my ($self, $row) = @_;
		846
		847	my $maxrow = $self->nrow - 1;
		848
		849	my ($beg, $end) = ($row, $row);
		850
		851	--$beg while $self->ROW_is_longer ($beg - 1);
		852	++$end while $self->ROW_is_longer ($end) && $end < $maxrow;
		853
		854	bless {
		855	term => $self,
		856	beg => $beg,
		857	end => $end,
		858	ncol => $self->ncol,
		859	len => ($end - $beg) * $self->ncol + $self->ROW_l ($end),
		860	}, urxvt::line::
		861	}
		862
		863	sub urxvt::line::t {
		864	my ($self) = @_;
		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 &&
		873	substr +(join "", map $self->{term}->ROW_t ($_), $self->{beg} .. $self->{end}),
		874	0, $self->{len}
		875	}
		876
		877	sub urxvt::line::r {
		878	my ($self) = @_;
		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) {
		887	my $rend = [
		888	map @{ $self->{term}->ROW_r ($_) }, $self->{beg} .. $self->{end}
		889	];
		890	$#$rend = $self->{len} - 1;
		891	return $rend;
		892	}
		893
		894	()
		895	}
		896
		897	sub urxvt::line::beg { $_[0]{beg} }
		898	sub urxvt::line::end { $_[0]{end} }
		899	sub urxvt::line::l { $_[0]{len} }
		900
		901	sub urxvt::line::offset_of {
		902	my ($self, $row, $col) = @_;
		903
		904	($row - $self->{beg}) * $self->{ncol} + $col
		905	}
		906
		907	sub urxvt::line::coord_of {
		908	my ($self, $offset) = @_;
		909
		910	use integer;
		911
		912	(
		913	$offset / $self->{ncol} + $self->{beg},
		914	$offset % $self->{ncol}
		915	)
		916	}
		917
		918	=item ($row, $col) = $line->coord_of ($offset)
583	=item $text = $term->special_encode $string	919	=item $text = $term->special_encode $string
584		920
585	Converts a perl string into the special encoding used by rxvt-unicode,	921	Converts a perl string into the special encoding used by rxvt-unicode,
586	where one character corresponds to one screen cell. See	922	where one character corresponds to one screen cell. See
587	C<< $term->ROW_t >> for details.	923	C<< $term->ROW_t >> for details.
…		…
701	This variable controls the verbosity level of the perl extension. Higher	1037	This variable controls the verbosity level of the perl extension. Higher
702	numbers indicate more verbose output.	1038	numbers indicate more verbose output.
703		1039
704	=over 4	1040	=over 4
705		1041
706	=item 0 - only fatal messages	1042	=item =0 - only fatal messages
707		1043
708	=item 3 - script loading and management	1044	=item =3 - script loading and management
709		1045
710	=item 10 - all events received	1046	=item =10 - all events received
711		1047
712	=back	1048	=back
713		1049
714	=head1 AUTHOR	1050	=head1 AUTHOR
715		1051

Diff Legend

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

Comparing rxvt-unicode/src/urxvt.pm (file contents): Revision 1.22 by root, Tue Jan 3 19:10:54 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.22 by root, Tue Jan 3 19:10:54 2006 UTC vs.
Revision 1.44 by root, Sat Jan 7 19:29:17 2006 UTC