[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.42 by root, Fri Jan 6 21:06:09 2006 UTC

…		…
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 loaded scripts, 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.
88		129
89	All of them must return a boolean value. If it is true, then the event	130	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,	131	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.	132	and the relevant action might not be carried out by the C++ code.
92		133
…		…
95	=over 4	136	=over 4
96		137
97	=item on_init $term	138	=item on_init $term
98		139
99	Called after a new terminal object has been initialized, but before	140	Called after a new terminal object has been initialized, but before
100	windows are created or the command gets run.	141	windows are created or the command gets run. Most methods are unsafe to
		142	call or deliver senseless data, as terminal size and other characteristics
		143	have not yet been determined. You can safely query and change resources,
		144	though.
101		145
102	=item on_reset $term	146	=item on_reset $term
103		147
104	Called after the screen is "reset" for any reason, such as resizing or	148	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	149	control sequences. Here is where you can react on changes to size-related
…		…
164		208
165	=item on_tty_activity $term NYI	209	=item on_tty_activity $term NYI
166		210
167	Called whenever the program(s) running in the urxvt window send output.	211	Called whenever the program(s) running in the urxvt window send output.
168		212
		213	=item on_osc_seq $term, $string
		214
		215	Called whenever the B<ESC ] 777 ; string ST> command sequence (OSC =
		216	operating system command) is processed. Cursor position and other state
		217	information is up-to-date when this happens. For interoperability, the
		218	string should start with the extension name and a colon, to distinguish
		219	it from commands for other extensions, and this might be enforced in the
		220	future.
		221
		222	Be careful not ever to trust (in a security sense) the data you receive,
		223	as its source can not easily be controleld (e-mail content, messages from
		224	other users on the same system etc.).
		225
		226	=item on_add_lines $term, $string
		227
		228	Called whenever text is about to be output, with the text as argument. You
		229	can filter/change and output the text yourself by returning a true value
		230	and calling C<< $term->scr_add_lines >> yourself. Please note that this
		231	might be very slow, however, as your hook is called for B<all> text being
		232	output.
		233
		234	=item on_line_update $term, $row
		235
		236	Called whenever a line was updated or changed. Can be used to filter
		237	screen output (e.g. underline urls or other useless stuff). Only lines
		238	that are being shown will be filtered, and, due to performance reasons,
		239	not always immediately.
		240
		241	The row number is always the topmost row of the line if the line spans
		242	multiple rows.
		243
		244	Please note that, if you change the line, then the hook might get called
		245	later with the already-modified line (e.g. if unrelated parts change), so
		246	you cannot just toggle rendition bits, but only set them.
		247
169	=item on_refresh_begin $term	248	=item on_refresh_begin $term
170		249
171	Called just before the screen gets redrawn. Can be used for overlay	250	Called just before the screen gets redrawn. Can be used for overlay
172	or similar effects by modify terminal contents in refresh_begin, and	251	or similar effects by modify terminal contents in refresh_begin, and
173	restoring them in refresh_end. The built-in overlay and selection display	252	restoring them in refresh_end. The built-in overlay and selection display
…		…
181		260
182	Called whenever the user presses a key combination that has a	261	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>	262	C<perl:string> action bound to it (see description of the B<keysym>
184	resource in the @@RXVT_NAME@@(1) manpage).	263	resource in the @@RXVT_NAME@@(1) manpage).
185		264
		265	=item on_key_press $term, $event, $octets
		266
		267	=item on_key_release $term, $event
		268
		269	=item on_button_press $term, $event
		270
		271	=item on_button_release $term, $event
		272
		273	=item on_motion_notify $term, $event
		274
		275	Called whenever the corresponding X event is received for the terminal If
		276	the hook returns true, then the even will be ignored by rxvt-unicode.
		277
		278	The event is a hash with most values as named by Xlib (see the XEvent
		279	manpage), with the additional members C<row> and C<col>, which are the row
		280	and column under the mouse cursor.
		281
		282	C<on_key_press> additionally receives the string rxvt-unicode would
		283	output, if any, in locale-specific encoding.
		284
		285	subwindow.
		286
		287	=back
		288
		289	=head2 Variables in the C<urxvt> Package
		290
		291	=over 4
		292
		293	=item $urxvt::TERM
		294
		295	The current terminal. Whenever a callback/Hook is bein executed, this
		296	variable stores the current C<urxvt::term> object.
		297
186	=back	298	=back
187		299
188	=head2 Functions in the C<urxvt> Package	300	=head2 Functions in the C<urxvt> Package
189		301
190	=over 4	302	=over 4
		303
		304	=item $term = new urxvt [arg...]
		305
		306	Creates a new terminal, very similar as if you had started it with
		307	C<system $binfile, arg...>. Croaks (and probably outputs an error message)
		308	if the new instance couldn't be created. Returns C<undef> if the new
		309	instance didn't initialise perl, and the terminal object otherwise. The
		310	C<init> and C<start> hooks will be called during the call.
191		311
192	=item urxvt::fatal $errormessage	312	=item urxvt::fatal $errormessage
193		313
194	Fatally aborts execution with the given error message. Avoid at all	314	Fatally aborts execution with the given error message. Avoid at all
195	costs! The only time this is acceptable is when the terminal process	315	costs! The only time this is acceptable is when the terminal process
…		…
265	=cut	385	=cut
266		386
267	package urxvt;	387	package urxvt;
268		388
269	use strict;	389	use strict;
		390	use Scalar::Util ();
270		391
271	our $term;	392	our $TERM;
272	our @HOOKNAME;	393	our @HOOKNAME;
273	our $LIBDIR;	394	our $LIBDIR;
274		395
275	BEGIN {	396	BEGIN {
276	urxvt->bootstrap;	397	urxvt->bootstrap;
…		…
301	my $name = $HOOKNAME[$htype];	422	my $name = $HOOKNAME[$htype];
302		423
303	my $ref = $pkg->can ("on_" . lc $name)	424	my $ref = $pkg->can ("on_" . lc $name)
304	or next;	425	or next;
305		426
306	$term->{_hook}[$htype]{$ref*1} = $ref;	427	$TERM->{_hook}[$htype]{$pkg} = $ref;
307	$hook_count[$htype]++	428	$hook_count[$htype]++
308	or set_should_invoke $htype, 1;	429	or set_should_invoke $htype, 1;
309	}	430	}
310	}	431	}
311		432
…		…
333		454
334	$pkg	455	$pkg
335	}	456	}
336	}	457	}
337		458
		459	our $retval; # return value for urxvt
		460
338	# called by the rxvt core	461	# called by the rxvt core
339	sub invoke {	462	sub invoke {
340	local $term = shift;	463	local $TERM = shift;
341	my $htype = shift;	464	my $htype = shift;
342		465
343	if ($htype == 0) { # INIT	466	if ($htype == 0) { # INIT
344	my @dirs = ((split /:/, $term->resource ("perl_lib")), "$LIBDIR/perl");	467	my @dirs = ((split /:/, $TERM->resource ("perl_lib")), "$LIBDIR/perl");
345		468
346	for my $ext (split /:/, $term->resource ("perl_ext")) {	469	for my $ext (map { split /,/, $TERM->resource ("perl_ext_$_") } 1, 2) {
347	my @files = grep -f $_, map "$_/$ext", @dirs;	470	my @files = grep -f $_, map "$_/$ext", @dirs;
348		471
349	if (@files) {	472	if (@files) {
350	register_package script_package $files[0];	473	register_package script_package $files[0];
351	} else {	474	} else {
352	warn "perl extension '$ext' not found in perl library search path\n";	475	warn "perl extension '$ext' not found in perl library search path\n";
353	}	476	}
354	}	477	}
		478	}
355		479
		480	$retval = undef;
		481
		482	if (my $cb = $TERM->{_hook}[$htype]) {
		483	verbose 10, "$HOOKNAME[$htype] (" . (join ", ", $TERM, @_) . ")"
		484	if $verbosity >= 10;
		485
		486	keys %$cb;
		487
		488	while (my ($pkg, $cb) = each %$cb) {
		489	$retval = $cb->(
		490	$TERM->{_pkg}{$pkg} \|\|= do {
		491	my $proxy = bless { }, urxvt::term::proxy::;
		492	Scalar::Util::weaken ($proxy->{term} = $TERM);
		493	$proxy
		494	},
		495	@_,
		496	) and last;
		497	}
		498	}
		499
356	} elsif ($htype == 1) { # DESTROY	500	if ($htype == 1) { # DESTROY
		501	# remove hooks if unused
357	if (my $hook = $term->{_hook}) {	502	if (my $hook = $TERM->{_hook}) {
358	for my $htype (0..$#$hook) {	503	for my $htype (0..$#$hook) {
359	$hook_count[$htype] -= scalar keys %{ $hook->[$htype] \|\| {} }	504	$hook_count[$htype] -= scalar keys %{ $hook->[$htype] \|\| {} }
360	or set_should_invoke $htype, 0;	505	or set_should_invoke $htype, 0;
361	}	506	}
362	}	507	}
		508
		509	# clear package objects
		510	%$_ = () for values %{ $TERM->{_pkg} };
		511
		512	# clear package
		513	%$TERM = ();
363	}	514	}
364		515
365	my $cb = $term->{_hook}[$htype]	516	$retval
366	or return;	517	}
367		518
368	verbose 10, "$HOOKNAME[$htype] (" . (join ", ", $term, @_) . ")"	519	sub urxvt::term::proxy::AUTOLOAD {
369	if $verbosity >= 10;	520	$urxvt::term::proxy::AUTOLOAD =~ /:([^:]+)$/
		521	or die "FATAL: \$AUTOLOAD '$urxvt::term::proxy::AUTOLOAD' unparsable";
370		522
371	while (my ($k, $v) = each %$cb) {	523	eval qq{
372	return 1 if $v->($term, @_);	524	sub $urxvt::term::proxy::AUTOLOAD {
373	}	525	my \$proxy = shift;
		526	\$proxy->{term}->$1 (\@_)
		527	}
		528	1
		529	} or die "FATAL: unable to compile method forwarder: $@";
374		530
375	0	531	goto &$urxvt::term::proxy::AUTOLOAD;
376	}	532	}
377		533
378	=head2 The C<urxvt::term> Class	534	=head2 The C<urxvt::term> Class
379		535
380	=over 4	536	=over 4
		537
		538	=item $term->destroy
		539
		540	Destroy the terminal object (close the window, free resources etc.).
381		541
382	=item $value = $term->resource ($name[, $newval])	542	=item $value = $term->resource ($name[, $newval])
383		543
384	Returns the current resource value associated with a given name and	544	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>	545	optionally sets a new value. Setting values is most useful in the C<init>
…		…
403	answerbackstring backgroundPixmap backspace_key boldFont boldItalicFont	563	answerbackstring backgroundPixmap backspace_key boldFont boldItalicFont
404	borderLess color cursorBlink cursorUnderline cutchars delete_key	564	borderLess color cursorBlink cursorUnderline cutchars delete_key
405	display_name embed ext_bwidth fade font geometry hold iconName	565	display_name embed ext_bwidth fade font geometry hold iconName
406	imFont imLocale inputMethod insecure int_bwidth intensityStyles	566	imFont imLocale inputMethod insecure int_bwidth intensityStyles
407	italicFont jumpScroll lineSpace loginShell mapAlert menu meta8 modifier	567	italicFont jumpScroll lineSpace loginShell mapAlert menu meta8 modifier
408	mouseWheelScrollPage name pastableTabs path perl_eval perl_ext	568	mouseWheelScrollPage name pastableTabs path perl_eval perl_ext_1 perl_ext_2
409	perl_lib pointerBlank pointerBlankDelay preeditType print_pipe pty_fd	569	perl_lib pointerBlank pointerBlankDelay preeditType print_pipe pty_fd
410	reverseVideo saveLines scrollBar scrollBar_align scrollBar_floating	570	reverseVideo saveLines scrollBar scrollBar_align scrollBar_floating
411	scrollBar_right scrollBar_thickness scrollTtyKeypress scrollTtyOutput	571	scrollBar_right scrollBar_thickness scrollTtyKeypress scrollTtyOutput
412	scrollWithBuffer scrollstyle secondaryScreen secondaryScroll selectstyle	572	scrollWithBuffer scrollstyle secondaryScreen secondaryScroll selectstyle
413	shade term_name title transparent transparent_all tripleclickwords	573	shade term_name title transparent transparent_all tripleclickwords
…		…
419	my ($self, $name) = (shift, shift);	579	my ($self, $name) = (shift, shift);
420	unshift @_, $self, $name, ($name =~ s/\s\+\s(\d+)$// ? $1 : 0);	580	unshift @_, $self, $name, ($name =~ s/\s\+\s(\d+)$// ? $1 : 0);
421	goto &urxvt::term::_resource;	581	goto &urxvt::term::_resource;
422	}	582	}
423		583
		584	=item $rend = $term->rstyle ([$new_rstyle])
		585
		586	Return and optionally change the current rendition. Text that is output by
		587	the terminal application will use this style.
		588
		589	=item ($row, $col) = $term->screen_cur ([$row, $col])
		590
		591	Return the current coordinates of the text cursor position and optionally
		592	set it (which is usually bad as applications don't expect that).
		593
424	=item ($row, $col) = $term->selection_mark ([$row, $col])	594	=item ($row, $col) = $term->selection_mark ([$row, $col])
425		595
426	=item ($row, $col) = $term->selection_beg ([$row, $col])	596	=item ($row, $col) = $term->selection_beg ([$row, $col])
427		597
428	=item ($row, $col) = $term->selection_end ([$row, $col])	598	=item ($row, $col) = $term->selection_end ([$row, $col])
…		…
442	#=item $term->overlay ($x, $y, $text)	612	#=item $term->overlay ($x, $y, $text)
443	#	613	#
444	#Create a simple multi-line overlay box. See the next method for details.	614	#Create a simple multi-line overlay box. See the next method for details.
445	#	615	#
446	#=cut	616	#=cut
447		617	#
448	sub urxvt::term::scr_overlay {	618	#sub urxvt::term::scr_overlay {
449	die;
450	my ($self, $x, $y, $text) = @_;	619	# my ($self, $x, $y, $text) = @_;
451		620	#
452	my @lines = split /\n/, $text;	621	# my @lines = split /\n/, $text;
453		622	#
454	my $w = 0;	623	# my $w = 0;
455	for (map $self->strwidth ($_), @lines) {	624	# for (map $self->strwidth ($_), @lines) {
456	$w = $_ if $w < $_;	625	# $w = $_ if $w < $_;
457	}	626	# }
458		627	#
459	$self->scr_overlay_new ($x, $y, $w, scalar @lines);	628	# $self->scr_overlay_new ($x, $y, $w, scalar @lines);
460	$self->scr_overlay_set (0, $_, $lines[$_]) for 0.. $#lines;	629	# $self->scr_overlay_set (0, $_, $lines[$_]) for 0.. $#lines;
461	}	630	#}
462		631
463	=item $term->overlay ($x, $y, $width, $height[, $rstyle[, $border]])	632	=item $term->overlay ($x, $y, $width, $height[, $rstyle[, $border]])
464		633
465	Create a new (empty) overlay at the given position with the given	634	Create a new (empty) overlay at the given position with the given
466	width/height. C<$rstyle> defines the initial rendition style	635	width/height. C<$rstyle> defines the initial rendition style
…		…
493		662
494	If hidden, display the overlay again.	663	If hidden, display the overlay again.
495		664
496	=back	665	=back
497		666
498	=item $cellwidth = $term->strwidth $string	667	=item $cellwidth = $term->strwidth ($string)
499		668
500	Returns the number of screen-cells this string would need. Correctly	669	Returns the number of screen-cells this string would need. Correctly
501	accounts for wide and combining characters.	670	accounts for wide and combining characters.
502		671
503	=item $octets = $term->locale_encode $string	672	=item $octets = $term->locale_encode ($string)
504		673
505	Convert the given text string into the corresponding locale encoding.	674	Convert the given text string into the corresponding locale encoding.
506		675
507	=item $string = $term->locale_decode $octets	676	=item $string = $term->locale_decode ($octets)
508		677
509	Convert the given locale-encoded octets into a perl string.	678	Convert the given locale-encoded octets into a perl string.
		679
		680	=item $term->scr_add_lines ($string)
		681
		682	Write the given text string to the screen, as if output by the application
		683	running inside the terminal. It may not contain command sequences (escape
		684	codes), but is free to use line feeds, carriage returns and tabs. The
		685	string is a normal text string, not in locale-dependent encoding.
		686
		687	Normally its not a good idea to use this function, as programs might be
		688	confused by changes in cursor position or scrolling. Its useful inside a
		689	C<on_add_lines> hook, though.
		690
		691	=item $term->cmd_parse ($octets)
		692
		693	Similar to C<scr_add_lines>, but the argument must be in the
		694	locale-specific encoding of the terminal and can contain command sequences
		695	(escape codes) that will be interpreted.
510		696
511	=item $term->tt_write ($octets)	697	=item $term->tt_write ($octets)
512		698
513	Write the octets given in C<$data> to the tty (i.e. as program input). To	699	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	700	pass characters instead of octets, you should convert your strings first
515	to the locale-specific encoding using C<< $term->locale_encode >>.	701	to the locale-specific encoding using C<< $term->locale_encode >>.
516		702
		703	=item $windowid = $term->parent
		704
		705	Return the window id of the toplevel window.
		706
		707	=item $windowid = $term->vt
		708
		709	Return the window id of the terminal window.
		710
		711	=item $window_width = $term->width
		712
		713	=item $window_height = $term->height
		714
		715	=item $font_width = $term->fwidth
		716
		717	=item $font_height = $term->fheight
		718
		719	=item $font_ascent = $term->fbase
		720
517	=item $nrow = $term->nrow	721	=item $terminal_rows = $term->nrow
518		722
519	=item $ncol = $term->ncol	723	=item $terminal_columns = $term->ncol
520		724
521	Return the number of rows/columns of the terminal window (i.e. as	725	=item $has_focus = $term->focus
522	specified by C<-geometry>, excluding any scrollback).
523		726
524	=item $nsaved = $term->nsaved	727	=item $is_mapped = $term->mapped
525		728
526	Returns the number of lines in the scrollback buffer.	729	=item $max_scrollback = $term->saveLines
		730
		731	=item $nrow_plus_saveLines = $term->total_rows
		732
		733	=item $lines_in_scrollback = $term->nsaved
		734
		735	Return various integers describing terminal characteristics.
527		736
528	=item $view_start = $term->view_start ([$newvalue])	737	=item $view_start = $term->view_start ([$newvalue])
529		738
530	Returns the negative row number of the topmost line. Minimum value is	739	Returns the negative row number of the topmost line. Minimum value is
531	C<0>, which displays the normal terminal contents. Larger values scroll	740	C<0>, which displays the normal terminal contents. Larger values scroll
…		…
542	=item $text = $term->ROW_t ($row_number[, $new_text[, $start_col]])	751	=item $text = $term->ROW_t ($row_number[, $new_text[, $start_col]])
543		752
544	Returns the text of the entire row with number C<$row_number>. Row C<0>	753	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	754	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	755	terminal line. The scrollback buffer starts at line C<-1> and extends to
547	line C<< -$term->nsaved >>.	756	line C<< -$term->nsaved >>. Nothing will be returned if a nonexistent line
		757	is requested.
548		758
549	If C<$new_text> is specified, it will replace characters in the current	759	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	760	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	761	to replace only parts of a line. The font index in the rendition will
552	automatically be updated.	762	automatically be updated.
…		…
574		784
575	See the section on RENDITION, above.	785	See the section on RENDITION, above.
576		786
577	=item $length = $term->ROW_l ($row_number[, $new_length])	787	=item $length = $term->ROW_l ($row_number[, $new_length])
578		788
579	Returns the number of screen cells that are in use ("the line length"). If	789	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	790	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.	791	line is joined with the following one.
582		792
		793	=item $bool = $term->is_longer ($row_number)
		794
		795	Returns true if the row is part of a multiple-row logical "line" (i.e.
		796	joined with the following row), which means all characters are in use
		797	and it is continued on the next row (and possibly a continuation of the
		798	previous row(s)).
		799
		800	=item $line = $term->line ($row_number)
		801
		802	Create and return a new C<urxvt::line> object that stores information
		803	about the logical line that row C<$row_number> is part of. It supports the
		804	following methods:
		805
		806	=over 4
		807
		808	=item $text = $line->t ([$new_text])
		809
		810	Returns or replaces the full text of the line, similar to C<ROW_t>
		811
		812	=item $rend = $line->r ([$new_rend])
		813
		814	Returns or replaces the full rendition array of the line, similar to C<ROW_r>
		815
		816	=item $length = $line->l
		817
		818	Returns the length of the line in cells, similar to C<ROW_l>.
		819
		820	=item $rownum = $line->beg
		821
		822	=item $rownum = $line->end
		823
		824	Return the row number of the first/last row of the line, respectively.
		825
		826	=item $offset = $line->offset_of ($row, $col)
		827
		828	Returns the character offset of the given row\|col pair within the logical
		829	line.
		830
		831	=item ($row, $col) = $line->coord_of ($offset)
		832
		833	Translates a string offset into terminal coordinates again.
		834
		835	=back
		836
		837	=cut
		838
		839	sub urxvt::term::line {
		840	my ($self, $row) = @_;
		841
		842	my $maxrow = $self->nrow - 1;
		843
		844	my ($beg, $end) = ($row, $row);
		845
		846	--$beg while $self->ROW_is_longer ($beg - 1);
		847	++$end while $self->ROW_is_longer ($end) && $end < $maxrow;
		848
		849	bless {
		850	term => $self,
		851	beg => $beg,
		852	end => $end,
		853	ncol => $self->ncol,
		854	len => ($end - $beg) * $self->ncol + $self->ROW_l ($end),
		855	}, urxvt::line::
		856	}
		857
		858	sub urxvt::line::t {
		859	my ($self) = @_;
		860
		861	if (@_ > 1)
		862	{
		863	$self->{term}->ROW_t ($_, $_[1], 0, ($_ - $self->{beg}) * $self->{ncol}, $self->{ncol})
		864	for $self->{beg} .. $self->{end};
		865	}
		866
		867	defined wantarray &&
		868	substr +(join "", map $self->{term}->ROW_t ($_), $self->{beg} .. $self->{end}),
		869	0, $self->{len}
		870	}
		871
		872	sub urxvt::line::r {
		873	my ($self) = @_;
		874
		875	if (@_ > 1)
		876	{
		877	$self->{term}->ROW_r ($_, $_[1], 0, ($_ - $self->{beg}) * $self->{ncol}, $self->{ncol})
		878	for $self->{beg} .. $self->{end};
		879	}
		880
		881	if (defined wantarray) {
		882	my $rend = [
		883	map @{ $self->{term}->ROW_r ($_) }, $self->{beg} .. $self->{end}
		884	];
		885	$#$rend = $self->{len} - 1;
		886	return $rend;
		887	}
		888
		889	()
		890	}
		891
		892	sub urxvt::line::beg { $_[0]{beg} }
		893	sub urxvt::line::end { $_[0]{end} }
		894	sub urxvt::line::l { $_[0]{len} }
		895
		896	sub urxvt::line::offset_of {
		897	my ($self, $row, $col) = @_;
		898
		899	($row - $self->{beg}) * $self->{ncol} + $col
		900	}
		901
		902	sub urxvt::line::coord_of {
		903	my ($self, $offset) = @_;
		904
		905	use integer;
		906
		907	(
		908	$offset / $self->{ncol} + $self->{beg},
		909	$offset % $self->{ncol}
		910	)
		911	}
		912
		913	=item ($row, $col) = $line->coord_of ($offset)
583	=item $text = $term->special_encode $string	914	=item $text = $term->special_encode $string
584		915
585	Converts a perl string into the special encoding used by rxvt-unicode,	916	Converts a perl string into the special encoding used by rxvt-unicode,
586	where one character corresponds to one screen cell. See	917	where one character corresponds to one screen cell. See
587	C<< $term->ROW_t >> for details.	918	C<< $term->ROW_t >> for details.
…		…
701	This variable controls the verbosity level of the perl extension. Higher	1032	This variable controls the verbosity level of the perl extension. Higher
702	numbers indicate more verbose output.	1033	numbers indicate more verbose output.
703		1034
704	=over 4	1035	=over 4
705		1036
706	=item 0 - only fatal messages	1037	=item =0 - only fatal messages
707		1038
708	=item 3 - script loading and management	1039	=item =3 - script loading and management
709		1040
710	=item 10 - all events received	1041	=item =10 - all events received
711		1042
712	=back	1043	=back
713		1044
714	=head1 AUTHOR	1045	=head1 AUTHOR
715		1046

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.42 by root, Fri Jan 6 21:06:09 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.42 by root, Fri Jan 6 21:06:09 2006 UTC