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

Comparing rxvt-unicode/src/urxvt.pm (file contents):
Revision 1.15 by root, Tue Jan 3 01:39:17 2006 UTC vs.
Revision 1.34 by root, Fri Jan 6 01:16:58 2006 UTC

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

Diff Legend

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

Comparing rxvt-unicode/src/urxvt.pm (file contents): Revision 1.15 by root, Tue Jan 3 01:39:17 2006 UTC vs. Revision 1.34 by root, Fri Jan 6 01:16:58 2006 UTC

Diff Legend

Comparing rxvt-unicode/src/urxvt.pm (file contents):
Revision 1.15 by root, Tue Jan 3 01:39:17 2006 UTC vs.
Revision 1.34 by root, Fri Jan 6 01:16:58 2006 UTC