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

Comparing rxvt-unicode/src/urxvt.pm (file contents):
Revision 1.17 by root, Tue Jan 3 01:45:03 2006 UTC vs.
Revision 1.35 by root, Fri Jan 6 01:27:27 2006 UTC

…		…
39		39
40	=over 4	40	=over 4
41		41
42	=item selection	42	=item selection
43		43
44	Miscellaneous selection modifications.	44	Intelligent selection. This extension tries to be more intelligent when
		45	the user extends selections (double-click). Right now, it tries to select
		46	urls and complete shell-quoted arguments, which is very convenient, too,
		47	if your F<ls> supports C<--quoting-style=shell>.
		48
		49	It also offers the following bindable event:
45		50
46	=over 4	51	=over 4
47		52
48	=item rot13	53	=item rot13
49		54
…		…
52	URxvt.keysym.C-M-r: perl:selection:rot13	57	URxvt.keysym.C-M-r: perl:selection:rot13
53		58
54	=back	59	=back
55		60
56	=item digital-clock	61	=item digital-clock
		62
		63	Displays a digital clock using the built-in overlay.
		64
		65	=item mark-urls
		66
		67	Uses per-line filtering (C<on_line_update>) to underline urls.
		68
		69	=item example-refresh-hooks
57		70
58	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
59	window. Illustrates overwriting the refresh callbacks to create your own	72	window. Illustrates overwriting the refresh callbacks to create your own
60	overlays or changes.	73	overlays or changes.
61		74
62	=item simple-overlay-clock	75	=item example-filter-input
63		76
64	Displays a digital clock using the built-in overlay (colorful, useless).	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.
65		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
…		…
122	requested from the server. The selection text can be queried and changed	167	requested from the server. The selection text can be queried and changed
123	by calling C<< $term->selection >>.	168	by calling C<< $term->selection >>.
124		169
125	Returning a true value aborts selection grabbing. It will still be hilighted.	170	Returning a true value aborts selection grabbing. It will still be hilighted.
126		171
		172	=item on_sel_extend $term
		173
		174	Called whenever the user tries to extend the selection (e.g. with a double
		175	click) and is either supposed to return false (normal operation), or
		176	should extend the selection itelf and return true to suppress the built-in
		177	processing.
		178
		179	See the F<selection> example extension.
		180
127	=item on_focus_in $term	181	=item on_focus_in $term
128		182
129	Called whenever the window gets the keyboard focus, before urxvt does	183	Called whenever the window gets the keyboard focus, before urxvt does
130	focus in processing.	184	focus in processing.
131		185
…		…
151	number of lines that will be in the scrollback buffer.	205	number of lines that will be in the scrollback buffer.
152		206
153	=item on_tty_activity $term NYI	207	=item on_tty_activity $term NYI
154		208
155	Called whenever the program(s) running in the urxvt window send output.	209	Called whenever the program(s) running in the urxvt window send output.
		210
		211	=item on_osc_seq $term, $string
		212
		213	Called whenever the B<ESC ] 777 ; string ST> command sequence (OSC =
		214	operating system command) is processed. Cursor position and other state
		215	information is up-to-date when this happens. For interoperability, the
		216	string should start with the extension name and a colon, to distinguish
		217	it from commands for other extensions, and this might be enforced in the
		218	future.
		219
		220	Be careful not ever to trust (in a security sense) the data you receive,
		221	as its source can not easily be controleld (e-mail content, messages from
		222	other users on the same system etc.).
		223
		224	=item on_add_lines $term, $string
		225
		226	Called whenever text is about to be output, with the text as argument. You
		227	can filter/change and output the text yourself by returning a true value
		228	and calling C<< $term->scr_add_lines >> yourself. Please note that this
		229	might be very slow, however, as your hook is called for B<all> text being
		230	output.
		231
		232	=item on_line_update $term, $row
		233
		234	Called whenever a line was updated or changed. Can be used to filter
		235	screen output (e.g. underline urls or other useless stuff). Only lines
		236	that are being shown will be filtered, and, due to performance reasons,
		237	not always immediately.
		238
		239	The row number is always the topmost row of the line if the line spans
		240	multiple rows.
		241
		242	Please note that, if you change the line, then the hook might get called
		243	later with the already-modified line (e.g. if unrelated parts change), so
		244	you cannot just toggle rendition bits, but only set them.
156		245
157	=item on_refresh_begin $term	246	=item on_refresh_begin $term
158		247
159	Called just before the screen gets redrawn. Can be used for overlay	248	Called just before the screen gets redrawn. Can be used for overlay
160	or similar effects by modify terminal contents in refresh_begin, and	249	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>	260	C<perl:string> action bound to it (see description of the B<keysym>
172	resource in the @@RXVT_NAME@@(1) manpage).	261	resource in the @@RXVT_NAME@@(1) manpage).
173		262
174	=back	263	=back
175		264
		265	=head2 Variables in the C<urxvt> Package
		266
		267	=over 4
		268
		269	=item $urxvt::TERM
		270
		271	The current terminal. Whenever a callback/Hook is bein executed, this
		272	variable stores the current C<urxvt::term> object.
		273
		274	=back
		275
176	=head2 Functions in the C<urxvt> Package	276	=head2 Functions in the C<urxvt> Package
177		277
178	=over 4	278	=over 4
179		279
180	=item urxvt::fatal $errormessage	280	=item urxvt::fatal $errormessage
…		…
194		294
195	=item $time = urxvt::NOW	295	=item $time = urxvt::NOW
196		296
197	Returns the "current time" (as per the event loop).	297	Returns the "current time" (as per the event loop).
198		298
		299	=back
		300
		301	=head2 RENDITION
		302
		303	Rendition bitsets contain information about colour, font, font styles and
		304	similar information for each screen cell.
		305
		306	The following "macros" deal with changes in rendition sets. You should
		307	never just create a bitset, you should always modify an existing one,
		308	as they contain important information required for correct operation of
		309	rxvt-unicode.
		310
		311	=over 4
		312
		313	=item $rend = urxvt::DEFAULT_RSTYLE
		314
		315	Returns the default rendition, as used when the terminal is starting up or
		316	being reset. Useful as a base to start when creating renditions.
		317
		318	=item $rend = urxvt::OVERLAY_RSTYLE
		319
		320	Return the rendition mask used for overlays by default.
		321
		322	=item $rendbit = urxvt::RS_Bold, RS_Italic, RS_Blink, RS_RVid, RS_Uline
		323
		324	Return the bit that enabled bold, italic, blink, reverse-video and
		325	underline, respectively. To enable such a style, just logically OR it into
		326	the bitset.
		327
		328	=item $foreground = urxvt::GET_BASEFG $rend
		329
		330	=item $background = urxvt::GET_BASEBG $rend
		331
		332	Return the foreground/background colour index, respectively.
		333
		334	=item $rend = urxvt::SET_FGCOLOR ($rend, $new_colour)
		335
		336	=item $rend = urxvt::SET_BGCOLOR ($rend, $new_colour)
		337
		338	Replace the foreground/background colour in the rendition mask with the
		339	specified one.
		340
		341	=item $value = urxvt::GET_CUSTOM ($rend)
		342
		343	Return the "custom" value: Every rendition has 5 bits for use by
		344	extensions. They can be set and changed as you like and are initially
		345	zero.
		346
		347	=item $rend = urxvt::SET_CUSTOM ($rend, $new_value)
		348
		349	Change the custom value.
		350
		351	=back
		352
199	=cut	353	=cut
200		354
201	package urxvt;	355	package urxvt;
202		356
203	use strict;	357	use strict;
		358	use Scalar::Util ();
204		359
205	our $term;	360	our $TERM;
206	our @HOOKNAME;	361	our @HOOKNAME;
207	our $LIBDIR;	362	our $LIBDIR;
208		363
209	BEGIN {	364	BEGIN {
210	urxvt->bootstrap;	365	urxvt->bootstrap;
…		…
235	my $name = $HOOKNAME[$htype];	390	my $name = $HOOKNAME[$htype];
236		391
237	my $ref = $pkg->can ("on_" . lc $name)	392	my $ref = $pkg->can ("on_" . lc $name)
238	or next;	393	or next;
239		394
240	$term->{_hook}[$htype]{$ref*1} = $ref;	395	$TERM->{_hook}[$htype]{$pkg} = $ref;
241	$hook_count[$htype]++	396	$hook_count[$htype]++
242	or set_should_invoke $htype, 1;	397	or set_should_invoke $htype, 1;
243	}	398	}
244	}	399	}
245		400
…		…
267		422
268	$pkg	423	$pkg
269	}	424	}
270	}	425	}
271		426
		427	our $retval; # return value for urxvt
		428
272	# called by the rxvt core	429	# called by the rxvt core
273	sub invoke {	430	sub invoke {
274	local $term = shift;	431	local $TERM = shift;
275	my $htype = shift;	432	my $htype = shift;
276		433
277	if ($htype == 0) { # INIT	434	if ($htype == 0) { # INIT
278	my @dirs = ((split /:/, $term->resource ("perl_lib")), "$LIBDIR/perl");	435	my @dirs = ((split /:/, $TERM->resource ("perl_lib")), "$LIBDIR/perl");
279		436
280	for my $ext (split /:/, $term->resource ("perl_ext")) {	437	for my $ext (map { split /:/, $TERM->resource ("perl_ext_$_") } 1, 2) {
281	my @files = grep -f $_, map "$_/$ext", @dirs;	438	my @files = grep -f $_, map "$_/$ext", @dirs;
282		439
283	if (@files) {	440	if (@files) {
284	register_package script_package $files[0];	441	register_package script_package $files[0];
285	} else {	442	} else {
286	warn "perl extension '$ext' not found in perl library search path\n";	443	warn "perl extension '$ext' not found in perl library search path\n";
287	}	444	}
288	}	445	}
		446	}
289		447
		448	$retval = undef;
		449
		450	if (my $cb = $TERM->{_hook}[$htype]) {
		451	verbose 10, "$HOOKNAME[$htype] (" . (join ", ", $TERM, @_) . ")"
		452	if $verbosity >= 10;
		453
		454	keys %$cb;
		455
		456	while (my ($pkg, $cb) = each %$cb) {
		457	$retval = $cb->(
		458	$TERM->{_pkg}{$pkg} \|\|= do {
		459	my $proxy = bless { }, urxvt::term::proxy::;
		460	Scalar::Util::weaken ($proxy->{term} = $TERM);
		461	$proxy
		462	},
		463	@_,
		464	) and last;
		465	}
		466	}
		467
290	} elsif ($htype == 1) { # DESTROY	468	if ($htype == 1) { # DESTROY
		469	# remove hooks if unused
291	if (my $hook = $term->{_hook}) {	470	if (my $hook = $TERM->{_hook}) {
292	for my $htype (0..$#$hook) {	471	for my $htype (0..$#$hook) {
293	$hook_count[$htype] -= scalar keys %{ $hook->[$htype] \|\| {} }	472	$hook_count[$htype] -= scalar keys %{ $hook->[$htype] \|\| {} }
294	or set_should_invoke $htype, 0;	473	or set_should_invoke $htype, 0;
295	}	474	}
296	}	475	}
		476
		477	# clear package objects
		478	%$_ = () for values %{ $TERM->{_pkg} };
		479
		480	# clear package
		481	%$TERM = ();
297	}	482	}
298		483
299	my $cb = $term->{_hook}[$htype]	484	$retval
300	or return;
301
302	verbose 10, "$HOOKNAME[$htype] (" . (join ", ", $term, @_) . ")"
303	if $verbosity >= 10;
304
305	while (my ($k, $v) = each %$cb) {
306	return 1 if $v->($term, @_);
307	}
308
309	0
310	}	485	}
311		486
312	=back	487	sub urxvt::term::proxy::AUTOLOAD {
		488	$urxvt::term::proxy::AUTOLOAD =~ /:([^:]+)$/
		489	or die "FATAL: \$AUTOLOAD '$urxvt::term::proxy::AUTOLOAD' unparsable";
		490
		491	eval qq{
		492	sub $urxvt::term::proxy::AUTOLOAD {
		493	my \$proxy = shift;
		494	\$proxy->{term}->$1 (\@_)
		495	}
		496	1
		497	} or die "FATAL: unable to compile method forwarder: $@";
		498
		499	goto &$urxvt::term::proxy::AUTOLOAD;
		500	}
313		501
314	=head2 The C<urxvt::term> Class	502	=head2 The C<urxvt::term> Class
315		503
316	=over 4	504	=over 4
317		505
…		…
339	answerbackstring backgroundPixmap backspace_key boldFont boldItalicFont	527	answerbackstring backgroundPixmap backspace_key boldFont boldItalicFont
340	borderLess color cursorBlink cursorUnderline cutchars delete_key	528	borderLess color cursorBlink cursorUnderline cutchars delete_key
341	display_name embed ext_bwidth fade font geometry hold iconName	529	display_name embed ext_bwidth fade font geometry hold iconName
342	imFont imLocale inputMethod insecure int_bwidth intensityStyles	530	imFont imLocale inputMethod insecure int_bwidth intensityStyles
343	italicFont jumpScroll lineSpace loginShell mapAlert menu meta8 modifier	531	italicFont jumpScroll lineSpace loginShell mapAlert menu meta8 modifier
344	mouseWheelScrollPage name pastableTabs path perl_eval perl_ext	532	mouseWheelScrollPage name pastableTabs path perl_eval perl_ext_1 perl_ext_2
345	perl_lib pointerBlank pointerBlankDelay preeditType print_pipe pty_fd	533	perl_lib pointerBlank pointerBlankDelay preeditType print_pipe pty_fd
346	reverseVideo saveLines scrollBar scrollBar_align scrollBar_floating	534	reverseVideo saveLines scrollBar scrollBar_align scrollBar_floating
347	scrollBar_right scrollBar_thickness scrollTtyKeypress scrollTtyOutput	535	scrollBar_right scrollBar_thickness scrollTtyKeypress scrollTtyOutput
348	scrollWithBuffer scrollstyle secondaryScreen secondaryScroll selectstyle	536	scrollWithBuffer scrollstyle secondaryScreen secondaryScroll selectstyle
349	shade term_name title transparent transparent_all tripleclickwords	537	shade term_name title transparent transparent_all tripleclickwords
…		…
355	my ($self, $name) = (shift, shift);	543	my ($self, $name) = (shift, shift);
356	unshift @_, $self, $name, ($name =~ s/\s\+\s(\d+)$// ? $1 : 0);	544	unshift @_, $self, $name, ($name =~ s/\s\+\s(\d+)$// ? $1 : 0);
357	goto &urxvt::term::_resource;	545	goto &urxvt::term::_resource;
358	}	546	}
359		547
		548	=item $rend = $term->rstyle ([$new_rstyle])
		549
		550	Return and optionally change the current rendition. Text that is output by
		551	the terminal application will use this style.
		552
		553	=item ($row, $col) = $term->screen_cur ([$row, $col])
		554
		555	Return the current coordinates of the text cursor position and optionally
		556	set it (which is usually bad as applications don't expect that).
		557
360	=item ($row, $col) = $term->selection_mark ([$row, $col])	558	=item ($row, $col) = $term->selection_mark ([$row, $col])
361		559
362	=item ($row, $col) = $term->selection_beg ([$row, $col])	560	=item ($row, $col) = $term->selection_beg ([$row, $col])
363		561
364	=item ($row, $col) = $term->selection_end ([$row, $col])	562	=item ($row, $col) = $term->selection_end ([$row, $col])
…		…
373		571
374	=item $oldtext = $term->selection ([$newtext])	572	=item $oldtext = $term->selection ([$newtext])
375		573
376	Return the current selection text and optionally replace it by C<$newtext>.	574	Return the current selection text and optionally replace it by C<$newtext>.
377		575
378	=item $term->scr_overlay ($x, $y, $text)	576	#=item $term->overlay ($x, $y, $text)
379		577	#
380	Create a simple multi-line overlay box. See the next method for details.	578	#Create a simple multi-line overlay box. See the next method for details.
381		579	#
382	=cut	580	#=cut
383		581	#
384	sub urxvt::term::scr_overlay {	582	#sub urxvt::term::scr_overlay {
385	my ($self, $x, $y, $text) = @_;	583	# my ($self, $x, $y, $text) = @_;
386		584	#
387	my @lines = split /\n/, $text;	585	# my @lines = split /\n/, $text;
388		586	#
389	my $w = 0;	587	# my $w = 0;
390	for (map $self->strwidth ($_), @lines) {	588	# for (map $self->strwidth ($_), @lines) {
391	$w = $_ if $w < $_;	589	# $w = $_ if $w < $_;
392	}	590	# }
393		591	#
394	$self->scr_overlay_new ($x, $y, $w, scalar @lines);	592	# $self->scr_overlay_new ($x, $y, $w, scalar @lines);
395	$self->scr_overlay_set (0, $_, $lines[$_]) for 0.. $#lines;	593	# $self->scr_overlay_set (0, $_, $lines[$_]) for 0.. $#lines;
396	}	594	#}
397		595
398	=item $term->scr_overlay_new ($x, $y, $width, $height)	596	=item $term->overlay ($x, $y, $width, $height[, $rstyle[, $border]])
399		597
400	Create a new (empty) overlay at the given position with the given	598	Create a new (empty) overlay at the given position with the given
401	width/height. A border will be put around the box. If either C<$x> or	599	width/height. C<$rstyle> defines the initial rendition style
402	C<$y> is negative, then this is counted from the right/bottom side,	600	(default: C<OVERLAY_RSTYLE>).
403	respectively.
404		601
405	=item $term->scr_overlay_off	602	If C<$border> is C<2> (default), then a decorative border will be put
		603	around the box.
406		604
407	Switch the overlay off again.	605	If either C<$x> or C<$y> is negative, then this is counted from the
		606	right/bottom side, respectively.
408		607
409	=item $term->scr_overlay_set_char ($x, $y, $char, $rend = OVERLAY_RSTYLE)	608	This method returns an urxvt::overlay object. The overlay will be visible
		609	as long as the perl object is referenced.
410		610
411	Put a single character (specified numerically) at the given overlay	611	The methods currently supported on C<urxvt::overlay> objects are:
412	position.
413		612
		613	=over 4
		614
414	=item $term->scr_overlay_set ($x, $y, $text)	615	=item $overlay->set ($x, $y, $text, $rend)
415		616
416	Write a string at the given position into the overlay.	617	Similar to C<< $term->ROW_t >> and C<< $term->ROW_r >> in that it puts
		618	text in rxvt-unicode's special encoding and an array of rendition values
		619	at a specific position inside the overlay.
		620
		621	=item $overlay->hide
		622
		623	If visible, hide the overlay, but do not destroy it.
		624
		625	=item $overlay->show
		626
		627	If hidden, display the overlay again.
		628
		629	=back
417		630
418	=item $cellwidth = $term->strwidth $string	631	=item $cellwidth = $term->strwidth $string
419		632
420	Returns the number of screen-cells this string would need. Correctly	633	Returns the number of screen-cells this string would need. Correctly
421	accounts for wide and combining characters.	634	accounts for wide and combining characters.
…		…
425	Convert the given text string into the corresponding locale encoding.	638	Convert the given text string into the corresponding locale encoding.
426		639
427	=item $string = $term->locale_decode $octets	640	=item $string = $term->locale_decode $octets
428		641
429	Convert the given locale-encoded octets into a perl string.	642	Convert the given locale-encoded octets into a perl string.
		643
		644	=item $term->scr_add_lines ($string)
		645
		646	Write the given text string to the screen, as if output by the application
		647	running inside the terminal. It may not contain command sequences (escape
		648	codes), but is free to use line feeds, carriage returns and tabs. The
		649	string is a normal text string, not in locale-dependent encoding.
		650
		651	Normally its not a good idea to use this function, as programs might be
		652	confused by changes in cursor position or scrolling. Its useful inside a
		653	C<on_add_lines> hook, though.
430		654
431	=item $term->tt_write ($octets)	655	=item $term->tt_write ($octets)
432		656
433	Write the octets given in C<$data> to the tty (i.e. as program input). To	657	Write the octets given in C<$data> to the tty (i.e. as program input). To
434	pass characters instead of octets, you should convert your strings first	658	pass characters instead of octets, you should convert your strings first
435	to the locale-specific encoding using C<< $term->locale_encode >>.	659	to the locale-specific encoding using C<< $term->locale_encode >>.
436		660
		661	=item $window_width = $term->width
		662
		663	=item $window_height = $term->height
		664
		665	=item $font_width = $term->fwidth
		666
		667	=item $font_height = $term->fheight
		668
		669	=item $font_ascent = $term->fbase
		670
437	=item $nrow = $term->nrow	671	=item $terminal_rows = $term->nrow
438		672
439	=item $ncol = $term->ncol	673	=item $terminal_columns = $term->ncol
440		674
441	Return the number of rows/columns of the terminal window (i.e. as	675	=item $has_focus = $term->focus
442	specified by C<-geometry>, excluding any scrollback).
443		676
444	=item $nsaved = $term->nsaved	677	=item $is_mapped = $term->mapped
445		678
446	Returns the number of lines in the scrollback buffer.	679	=item $max_scrollback = $term->saveLines
		680
		681	=item $nrow_plus_saveLines = $term->total_rows
		682
		683	=item $lines_in_scrollback = $term->nsaved
		684
		685	Return various integers describing terminal characteristics.
447		686
448	=item $view_start = $term->view_start ([$newvalue])	687	=item $view_start = $term->view_start ([$newvalue])
449		688
450	Returns the negative row number of the topmost line. Minimum value is	689	Returns the negative row number of the topmost line. Minimum value is
451	C<0>, which displays the normal terminal contents. Larger values scroll	690	C<0>, which displays the normal terminal contents. Larger values scroll
…		…
462	=item $text = $term->ROW_t ($row_number[, $new_text[, $start_col]])	701	=item $text = $term->ROW_t ($row_number[, $new_text[, $start_col]])
463		702
464	Returns the text of the entire row with number C<$row_number>. Row C<0>	703	Returns the text of the entire row with number C<$row_number>. Row C<0>
465	is the topmost terminal line, row C<< $term->$ncol-1 >> is the bottommost	704	is the topmost terminal line, row C<< $term->$ncol-1 >> is the bottommost
466	terminal line. The scrollback buffer starts at line C<-1> and extends to	705	terminal line. The scrollback buffer starts at line C<-1> and extends to
467	line C<< -$term->nsaved >>.	706	line C<< -$term->nsaved >>. Nothing will be returned if a nonexistent line
		707	is requested.
468		708
469	If C<$new_text> is specified, it will replace characters in the current	709	If C<$new_text> is specified, it will replace characters in the current
470	line, starting at column C<$start_col> (default C<0>), which is useful	710	line, starting at column C<$start_col> (default C<0>), which is useful
471	to replace only parts of a line. The font iindex in the rendition will	711	to replace only parts of a line. The font index in the rendition will
472	automatically be updated.	712	automatically be updated.
473		713
474	C<$text> is in a special encoding: tabs and wide characters that use more	714	C<$text> is in a special encoding: tabs and wide characters that use more
475	than one cell when displayed are padded with urxvt::NOCHAR characters	715	than one cell when displayed are padded with urxvt::NOCHAR characters
476	(C<chr 65535>). Characters with combining characters and other characters	716	(C<chr 65535>). Characters with combining characters and other characters
…		…
490	bitsets. Rendition bitsets contain information about colour, font, font	730	bitsets. Rendition bitsets contain information about colour, font, font
491	styles and similar information. See also C<< $term->ROW_t >>.	731	styles and similar information. See also C<< $term->ROW_t >>.
492		732
493	When setting rendition, the font mask will be ignored.	733	When setting rendition, the font mask will be ignored.
494		734
495	See the section on RENDITION, below.	735	See the section on RENDITION, above.
496		736
497	=item $length = $term->ROW_l ($row_number[, $new_length])	737	=item $length = $term->ROW_l ($row_number[, $new_length])
498		738
499	Returns the number of screen cells that are in use ("the line length"). If	739	Returns the number of screen cells that are in use ("the line
500	it is C<-1>, then the line is part of a multiple-row logical "line", which	740	length"). Unlike the urxvt core, this returns C<< $term->ncol >> if the
501	means all characters are in use and it is continued on the next row.	741	line is joined with the following one.
502		742
		743	=item $bool = $term->is_longer ($row_number)
		744
		745	Returns true if the row is part of a multiple-row logical "line" (i.e.
		746	joined with the following row), which means all characters are in use
		747	and it is continued on the next row (and possibly a continuation of the
		748	previous row(s)).
		749
		750	=item $line = $term->line ($row_number)
		751
		752	Create and return a new C<urxvt::line> object that stores information
		753	about the logical line that row C<$row_number> is part of. It supports the
		754	following methods:
		755
		756	=over 4
		757
		758	=item $text = $line->t ([$new_text])
		759
		760	Returns or replaces the full text of the line, similar to C<ROW_t>
		761
		762	=item $rend = $line->r ([$new_rend])
		763
		764	Returns or replaces the full rendition array of the line, similar to C<ROW_r>
		765
		766	=item $length = $line->l
		767
		768	Returns the length of the line in cells, similar to C<ROW_l>.
		769
		770	=item $rownum = $line->beg
		771
		772	=item $rownum = $line->end
		773
		774	Return the row number of the first/last row of the line, respectively.
		775
		776	=item $offset = $line->offset_of ($row, $col)
		777
		778	Returns the character offset of the given row\|col pair within the logical
		779	line.
		780
		781	=item ($row, $col) = $line->coord_of ($offset)
		782
		783	Translates a string offset into terminal coordinates again.
		784
		785	=back
		786
		787	=cut
		788
		789	sub urxvt::term::line {
		790	my ($self, $row) = @_;
		791
		792	my $maxrow = $self->nrow - 1;
		793
		794	my ($beg, $end) = ($row, $row);
		795
		796	--$beg while $self->ROW_is_longer ($beg - 1);
		797	++$end while $self->ROW_is_longer ($end) && $end < $maxrow;
		798
		799	bless {
		800	term => $self,
		801	beg => $beg,
		802	end => $end,
		803	ncol => $self->ncol,
		804	len => ($end - $beg) * $self->ncol + $self->ROW_l ($end),
		805	}, urxvt::line::
		806	}
		807
		808	sub urxvt::line::t {
		809	my ($self) = @_;
		810
		811	if (@_ > 1)
		812	{
		813	$self->{term}->ROW_t ($_, $_[1], 0, ($_ - $self->{beg}) * $self->{ncol}, $self->{ncol})
		814	for $self->{beg} .. $self->{end};
		815	}
		816
		817	defined wantarray &&
		818	substr +(join "", map $self->{term}->ROW_t ($_), $self->{beg} .. $self->{end}),
		819	0, $self->{len}
		820	}
		821
		822	sub urxvt::line::r {
		823	my ($self) = @_;
		824
		825	if (@_ > 1)
		826	{
		827	$self->{term}->ROW_r ($_, $_[1], 0, ($_ - $self->{beg}) * $self->{ncol}, $self->{ncol})
		828	for $self->{beg} .. $self->{end};
		829	}
		830
		831	if (defined wantarray) {
		832	my $rend = [
		833	map @{ $self->{term}->ROW_r ($_) }, $self->{beg} .. $self->{end}
		834	];
		835	$#$rend = $self->{len} - 1;
		836	return $rend;
		837	}
		838
		839	()
		840	}
		841
		842	sub urxvt::line::beg { $_[0]{beg} }
		843	sub urxvt::line::end { $_[0]{end} }
		844	sub urxvt::line::l { $_[0]{len} }
		845
		846	sub urxvt::line::offset_of {
		847	my ($self, $row, $col) = @_;
		848
		849	($row - $self->{beg}) * $self->{ncol} + $col
		850	}
		851
		852	sub urxvt::line::coord_of {
		853	my ($self, $offset) = @_;
		854
		855	use integer;
		856
		857	(
		858	$offset / $self->{ncol} + $self->{beg},
		859	$offset % $self->{ncol}
		860	)
		861	}
		862
		863	=item ($row, $col) = $line->coord_of ($offset)
503	=item $text = $term->special_encode $string	864	=item $text = $term->special_encode $string
504		865
505	Converts a perl string into the special encoding used by rxvt-unicode,	866	Converts a perl string into the special encoding used by rxvt-unicode,
506	where one character corresponds to one screen cell. See	867	where one character corresponds to one screen cell. See
507	C<< $term->ROW_t >> for details.	868	C<< $term->ROW_t >> for details.
…		…
511	Converts rxvt-unicodes text reprsentation into a perl string. See	872	Converts rxvt-unicodes text reprsentation into a perl string. See
512	C<< $term->ROW_t >> for details.	873	C<< $term->ROW_t >> for details.
513		874
514	=back	875	=back
515		876
516	=head2 RENDITION
517
518	Rendition bitsets contain information about colour, font, font styles and
519	similar information for each screen cell.
520
521	The following "macros" deal with changes in rendition sets. You should
522	never just create a bitset, you should always modify an existing one,
523	as they contain important information required for correct operation of
524	rxvt-unicode.
525
526	=over 4
527
528	=item $rend = urxvt::DEFAULT_RSTYLE
529
530	Returns the default rendition, as used when the terminal is starting up or
531	being reset. Useful as a base
532
533	=back
534
535	=cut
536
537	=head2 The C<urxvt::timer> Class	877	=head2 The C<urxvt::timer> Class
538		878
539	This class implements timer watchers/events. Time is represented as a	879	This class implements timer watchers/events. Time is represented as a
540	fractional number of seconds since the epoch. Example:	880	fractional number of seconds since the epoch. Example:
541		881
542	# create a digital clock display in upper right corner	882	$term->{overlay} = $term->overlay (-1, 0, 8, 1, urxvt::OVERLAY_RSTYLE, 0);
543	$term->{timer} = urxvt::timer	883	$term->{timer} = urxvt::timer
544	->new	884	->new
545	->start (urxvt::NOW)	885	->interval (1)
546	->cb (sub {	886	->cb (sub {
547	my ($timer) = @_;
548	my $time = $timer->at;
549	$timer->start ($time + 1);
550	$self->scr_overlay (-1, 0,	887	$term->{overlay}->set (0, 0,
551	POSIX::strftime "%H:%M:%S", localtime $time);	888	sprintf "%2d:%02d:%02d", (localtime urxvt::NOW)[2,1,0]);
552	});	889	});
553		890
554	=over 4	891	=over 4
555		892
556	=item $timer = new urxvt::timer	893	=item $timer = new urxvt::timer
557		894
558	Create a new timer object in stopped state.	895	Create a new timer object in started state. It is scheduled to fire
		896	immediately.
559		897
560	=item $timer = $timer->cb (sub { my ($timer) = @_; ... })	898	=item $timer = $timer->cb (sub { my ($timer) = @_; ... })
561		899
562	Set the callback to be called when the timer triggers.	900	Set the callback to be called when the timer triggers.
563		901
…		…
566	Return the time this watcher will fire next.	904	Return the time this watcher will fire next.
567		905
568	=item $timer = $timer->set ($tstamp)	906	=item $timer = $timer->set ($tstamp)
569		907
570	Set the time the event is generated to $tstamp.	908	Set the time the event is generated to $tstamp.
		909
		910	=item $timer = $timer->interval ($interval)
		911
		912	Normally (and when C<$interval> is C<0>), the timer will automatically
		913	stop after it has fired once. If C<$interval> is non-zero, then the timer
		914	is automatically rescheduled at the given intervals.
571		915
572	=item $timer = $timer->start	916	=item $timer = $timer->start
573		917
574	Start the timer.	918	Start the timer.
575		919
…		…
638	This variable controls the verbosity level of the perl extension. Higher	982	This variable controls the verbosity level of the perl extension. Higher
639	numbers indicate more verbose output.	983	numbers indicate more verbose output.
640		984
641	=over 4	985	=over 4
642		986
643	=item 0 - only fatal messages	987	=item =0 - only fatal messages
644		988
645	=item 3 - script loading and management	989	=item =3 - script loading and management
646		990
647	=item 10 - all events received	991	=item =10 - all events received
648		992
649	=back	993	=back
650		994
651	=head1 AUTHOR	995	=head1 AUTHOR
652		996

Diff Legend

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

Comparing rxvt-unicode/src/urxvt.pm (file contents): Revision 1.17 by root, Tue Jan 3 01:45:03 2006 UTC vs. Revision 1.35 by root, Fri Jan 6 01:27:27 2006 UTC

Diff Legend

Comparing rxvt-unicode/src/urxvt.pm (file contents):
Revision 1.17 by root, Tue Jan 3 01:45:03 2006 UTC vs.
Revision 1.35 by root, Fri Jan 6 01:27:27 2006 UTC