[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.32 by root, Wed Jan 4 21:37:55 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
61
62	Displays a digital clock using the built-in overlay (colorful, useless).
63
64	=back	71	=back
65		72
66	=head2 General API Considerations	73	=head2 General API Considerations
67		74
68	All objects (such as terminals, time watchers etc.) are typical	75	All objects (such as terminals, time watchers etc.) are typical
69	reference-to-hash objects. The hash can be used to store anything you	76	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	77	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	78	C<_hook>) are reserved for internal uses and B<MUST NOT> be accessed or
72	modified).	79	modified).
73		80
74	When objects are destroyed on the C++ side, the perl object hashes are	81	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	82	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	83	the like inside the terminal object so they get destroyed as soon as the
77	terminal is destroyed.	84	terminal is destroyed.
78		85
79	=head2 Hooks	86	=head2 Hooks
80		87
81	The following subroutines can be declared in loaded scripts, and will be called	88	The following subroutines can be declared in loaded scripts, and will be
82	whenever the relevant event happens.	89	called whenever the relevant event happens.
		90
		91	The first argument passed to them is an object private to each terminal
		92	and extension package. You can call all C<urxvt::term> methods on it, but
		93	its not a real C<urxvt::term> object. Instead, the real C<urxvt::term>
		94	object that is shared between all packages is stored in the C<term>
		95	member.
83		96
84	All of them must return a boolean value. If it is true, then the event	97	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,	98	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.	99	and the relevant action might not be carried out by the C++ code.
87		100
…		…
120	requested from the server. The selection text can be queried and changed	133	requested from the server. The selection text can be queried and changed
121	by calling C<< $term->selection >>.	134	by calling C<< $term->selection >>.
122		135
123	Returning a true value aborts selection grabbing. It will still be hilighted.	136	Returning a true value aborts selection grabbing. It will still be hilighted.
124		137
		138	=item on_sel_extend $term
		139
		140	Called whenever the user tries to extend the selection (e.g. with a double
		141	click) and is either supposed to return false (normal operation), or
		142	should extend the selection itelf and return true to suppress the built-in
		143	processing.
		144
		145	See the F<selection> example extension.
		146
125	=item on_focus_in $term	147	=item on_focus_in $term
126		148
127	Called whenever the window gets the keyboard focus, before urxvt does	149	Called whenever the window gets the keyboard focus, before urxvt does
128	focus in processing.	150	focus in processing.
129		151
…		…
149	number of lines that will be in the scrollback buffer.	171	number of lines that will be in the scrollback buffer.
150		172
151	=item on_tty_activity $term NYI	173	=item on_tty_activity $term NYI
152		174
153	Called whenever the program(s) running in the urxvt window send output.	175	Called whenever the program(s) running in the urxvt window send output.
		176
		177	=item on_osc_seq $term, $string
		178
		179	Called whenever the B<ESC ] 777 ; string ST> command sequence (OSC =
		180	operating system command) is processed. Cursor position and other state
		181	information is up-to-date when this happens. For interoperability, the
		182	string should start with the extension name and a colon, to distinguish
		183	it from commands for other extensions, and this might be enforced in the
		184	future.
		185
		186	Be careful not ever to trust (in a security sense) the data you receive,
		187	as its source can not easily be controleld (e-mail content, messages from
		188	other users on the same system etc.).
154		189
155	=item on_refresh_begin $term	190	=item on_refresh_begin $term
156		191
157	Called just before the screen gets redrawn. Can be used for overlay	192	Called just before the screen gets redrawn. Can be used for overlay
158	or similar effects by modify terminal contents in refresh_begin, and	193	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>	204	C<perl:string> action bound to it (see description of the B<keysym>
170	resource in the @@RXVT_NAME@@(1) manpage).	205	resource in the @@RXVT_NAME@@(1) manpage).
171		206
172	=back	207	=back
173		208
		209	=head2 Variables in the C<urxvt> Package
		210
		211	=over 4
		212
		213	=item $urxvt::TERM
		214
		215	The current terminal. Whenever a callback/Hook is bein executed, this
		216	variable stores the current C<urxvt::term> object.
		217
		218	=back
		219
174	=head2 Functions in the C<urxvt> Package	220	=head2 Functions in the C<urxvt> Package
175		221
176	=over 4	222	=over 4
177		223
178	=item urxvt::fatal $errormessage	224	=item urxvt::fatal $errormessage
…		…
192		238
193	=item $time = urxvt::NOW	239	=item $time = urxvt::NOW
194		240
195	Returns the "current time" (as per the event loop).	241	Returns the "current time" (as per the event loop).
196		242
		243	=back
		244
		245	=head2 RENDITION
		246
		247	Rendition bitsets contain information about colour, font, font styles and
		248	similar information for each screen cell.
		249
		250	The following "macros" deal with changes in rendition sets. You should
		251	never just create a bitset, you should always modify an existing one,
		252	as they contain important information required for correct operation of
		253	rxvt-unicode.
		254
		255	=over 4
		256
		257	=item $rend = urxvt::DEFAULT_RSTYLE
		258
		259	Returns the default rendition, as used when the terminal is starting up or
		260	being reset. Useful as a base to start when creating renditions.
		261
		262	=item $rend = urxvt::OVERLAY_RSTYLE
		263
		264	Return the rendition mask used for overlays by default.
		265
		266	=item $rendbit = urxvt::RS_Bold, RS_Italic, RS_Blink, RS_RVid, RS_Uline
		267
		268	Return the bit that enabled bold, italic, blink, reverse-video and
		269	underline, respectively. To enable such a style, just logically OR it into
		270	the bitset.
		271
		272	=item $foreground = urxvt::GET_BASEFG $rend
		273
		274	=item $background = urxvt::GET_BASEBG $rend
		275
		276	Return the foreground/background colour index, respectively.
		277
		278	=item $rend = urxvt::SET_FGCOLOR ($rend, $new_colour)
		279
		280	=item $rend = urxvt::SET_BGCOLOR ($rend, $new_colour)
		281
		282	Replace the foreground/background colour in the rendition mask with the
		283	specified one.
		284
		285	=item $value = urxvt::GET_CUSTOM ($rend)
		286
		287	Return the "custom" value: Every rendition has 5 bits for use by
		288	extensions. They can be set and changed as you like and are initially
		289	zero.
		290
		291	=item $rend = urxvt::SET_CUSTOM ($rend, $new_value)
		292
		293	Change the custom value.
		294
		295	=back
		296
197	=cut	297	=cut
198		298
199	package urxvt;	299	package urxvt;
200		300
201	use strict;	301	use strict;
		302	use Scalar::Util ();
202		303
203	our $term;	304	our $TERM;
204	our @HOOKNAME;	305	our @HOOKNAME;
205	our $LIBDIR;	306	our $LIBDIR;
206		307
207	BEGIN {	308	BEGIN {
208	urxvt->bootstrap;	309	urxvt->bootstrap;
…		…
233	my $name = $HOOKNAME[$htype];	334	my $name = $HOOKNAME[$htype];
234		335
235	my $ref = $pkg->can ("on_" . lc $name)	336	my $ref = $pkg->can ("on_" . lc $name)
236	or next;	337	or next;
237		338
238	$term->{_hook}[$htype]{$ref*1} = $ref;	339	$TERM->{_hook}[$htype]{$pkg} = $ref;
239	$hook_count[$htype]++	340	$hook_count[$htype]++
240	or set_should_invoke $htype, 1;	341	or set_should_invoke $htype, 1;
241	}	342	}
242	}	343	}
243		344
…		…
265		366
266	$pkg	367	$pkg
267	}	368	}
268	}	369	}
269		370
		371	our $retval; # return value for urxvt
		372
270	# called by the rxvt core	373	# called by the rxvt core
271	sub invoke {	374	sub invoke {
272	local $term = shift;	375	local $TERM = shift;
273	my $htype = shift;	376	my $htype = shift;
274		377
275	if ($htype == 0) { # INIT	378	if ($htype == 0) { # INIT
276	my @dirs = ((split /:/, $term->resource ("perl_lib")), "$LIBDIR/perl");	379	my @dirs = ((split /:/, $TERM->resource ("perl_lib")), "$LIBDIR/perl");
277		380
278	for my $ext (split /:/, $term->resource ("perl_ext")) {	381	for my $ext (map { split /:/, $TERM->resource ("perl_ext_$_") } 1, 2) {
279	my @files = grep -f $_, map "$_/$ext", @dirs;	382	my @files = grep -f $_, map "$_/$ext", @dirs;
280		383
281	if (@files) {	384	if (@files) {
282	register_package script_package $files[0];	385	register_package script_package $files[0];
283	} else {	386	} else {
284	warn "perl extension '$ext' not found in perl library search path\n";	387	warn "perl extension '$ext' not found in perl library search path\n";
285	}	388	}
286	}	389	}
		390	}
287		391
		392	$retval = undef;
		393
		394	if (my $cb = $TERM->{_hook}[$htype]) {
		395	verbose 10, "$HOOKNAME[$htype] (" . (join ", ", $TERM, @_) . ")"
		396	if $verbosity >= 10;
		397
		398	keys %$cb;
		399
		400	while (my ($pkg, $cb) = each %$cb) {
		401	$retval = $cb->(
		402	$TERM->{_pkg}{$pkg} \|\|= do {
		403	my $proxy = bless { }, urxvt::term::proxy::;
		404	Scalar::Util::weaken ($proxy->{term} = $TERM);
		405	$proxy
		406	},
		407	@_,
		408	) and last;
		409	}
		410	}
		411
288	} elsif ($htype == 1) { # DESTROY	412	if ($htype == 1) { # DESTROY
		413	# remove hooks if unused
289	if (my $hook = $term->{_hook}) {	414	if (my $hook = $TERM->{_hook}) {
290	for my $htype (0..$#$hook) {	415	for my $htype (0..$#$hook) {
291	$hook_count[$htype] -= scalar keys %{ $hook->[$htype] \|\| {} }	416	$hook_count[$htype] -= scalar keys %{ $hook->[$htype] \|\| {} }
292	or set_should_invoke $htype, 0;	417	or set_should_invoke $htype, 0;
293	}	418	}
294	}	419	}
		420
		421	# clear package objects
		422	%$_ = () for values %{ $TERM->{_pkg} };
		423
		424	# clear package
		425	%$TERM = ();
295	}	426	}
296		427
297	my $cb = $term->{_hook}[$htype]	428	$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	}	429	}
309		430
310	=back	431	sub urxvt::term::proxy::AUTOLOAD {
		432	$urxvt::term::proxy::AUTOLOAD =~ /:([^:]+)$/
		433	or die "FATAL: \$AUTOLOAD '$urxvt::term::proxy::AUTOLOAD' unparsable";
		434
		435	eval qq{
		436	sub $urxvt::term::proxy::AUTOLOAD {
		437	my \$proxy = shift;
		438	\$proxy->{term}->$1 (\@_)
		439	}
		440	1
		441	} or die "FATAL: unable to compile method forwarder: $@";
		442
		443	goto &$urxvt::term::proxy::AUTOLOAD;
		444	}
311		445
312	=head2 The C<urxvt::term> Class	446	=head2 The C<urxvt::term> Class
313		447
314	=over 4	448	=over 4
315		449
…		…
337	answerbackstring backgroundPixmap backspace_key boldFont boldItalicFont	471	answerbackstring backgroundPixmap backspace_key boldFont boldItalicFont
338	borderLess color cursorBlink cursorUnderline cutchars delete_key	472	borderLess color cursorBlink cursorUnderline cutchars delete_key
339	display_name embed ext_bwidth fade font geometry hold iconName	473	display_name embed ext_bwidth fade font geometry hold iconName
340	imFont imLocale inputMethod insecure int_bwidth intensityStyles	474	imFont imLocale inputMethod insecure int_bwidth intensityStyles
341	italicFont jumpScroll lineSpace loginShell mapAlert menu meta8 modifier	475	italicFont jumpScroll lineSpace loginShell mapAlert menu meta8 modifier
342	mouseWheelScrollPage name pastableTabs path perl_eval perl_ext	476	mouseWheelScrollPage name pastableTabs path perl_eval perl_ext_1 perl_ext_2
343	perl_lib pointerBlank pointerBlankDelay preeditType print_pipe pty_fd	477	perl_lib pointerBlank pointerBlankDelay preeditType print_pipe pty_fd
344	reverseVideo saveLines scrollBar scrollBar_align scrollBar_floating	478	reverseVideo saveLines scrollBar scrollBar_align scrollBar_floating
345	scrollBar_right scrollBar_thickness scrollTtyKeypress scrollTtyOutput	479	scrollBar_right scrollBar_thickness scrollTtyKeypress scrollTtyOutput
346	scrollWithBuffer scrollstyle secondaryScreen secondaryScroll selectstyle	480	scrollWithBuffer scrollstyle secondaryScreen secondaryScroll selectstyle
347	shade term_name title transparent transparent_all tripleclickwords	481	shade term_name title transparent transparent_all tripleclickwords
…		…
353	my ($self, $name) = (shift, shift);	487	my ($self, $name) = (shift, shift);
354	unshift @_, $self, $name, ($name =~ s/\s\+\s(\d+)$// ? $1 : 0);	488	unshift @_, $self, $name, ($name =~ s/\s\+\s(\d+)$// ? $1 : 0);
355	goto &urxvt::term::_resource;	489	goto &urxvt::term::_resource;
356	}	490	}
357		491
		492	=item $rend = $term->screen_rstyle ([$new_rstyle])
		493
		494	Return and optionally change the current rendition. Text thta is output by
		495	the temrianl application will use this style.
		496
		497	=item ($row, $col) = $term->screen_cur ([$row, $col])
		498
		499	Return the current coordinates of the text cursor position and optionally
		500	set it (which is usually bad as applications don't expect that).
		501
358	=item ($row, $col) = $term->selection_mark ([$row, $col])	502	=item ($row, $col) = $term->selection_mark ([$row, $col])
359		503
360	=item ($row, $col) = $term->selection_beg ([$row, $col])	504	=item ($row, $col) = $term->selection_beg ([$row, $col])
361		505
362	=item ($row, $col) = $term->selection_end ([$row, $col])	506	=item ($row, $col) = $term->selection_end ([$row, $col])
…		…
371		515
372	=item $oldtext = $term->selection ([$newtext])	516	=item $oldtext = $term->selection ([$newtext])
373		517
374	Return the current selection text and optionally replace it by C<$newtext>.	518	Return the current selection text and optionally replace it by C<$newtext>.
375		519
376	=item $term->scr_overlay ($x, $y, $text)	520	#=item $term->overlay ($x, $y, $text)
377		521	#
378	Create a simple multi-line overlay box. See the next method for details.	522	#Create a simple multi-line overlay box. See the next method for details.
379		523	#
380	=cut	524	#=cut
381		525
382	sub urxvt::term::scr_overlay {	526	sub urxvt::term::scr_overlay {
		527	die;
383	my ($self, $x, $y, $text) = @_;	528	my ($self, $x, $y, $text) = @_;
384		529
385	my @lines = split /\n/, $text;	530	my @lines = split /\n/, $text;
386		531
387	my $w = 0;	532	my $w = 0;
…		…
391		536
392	$self->scr_overlay_new ($x, $y, $w, scalar @lines);	537	$self->scr_overlay_new ($x, $y, $w, scalar @lines);
393	$self->scr_overlay_set (0, $_, $lines[$_]) for 0.. $#lines;	538	$self->scr_overlay_set (0, $_, $lines[$_]) for 0.. $#lines;
394	}	539	}
395		540
396	=item $term->scr_overlay_new ($x, $y, $width, $height)	541	=item $term->overlay ($x, $y, $width, $height[, $rstyle[, $border]])
397		542
398	Create a new (empty) overlay at the given position with the given	543	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	544	width/height. C<$rstyle> defines the initial rendition style
400	C<$y> is negative, then this is counted from the right/bottom side,	545	(default: C<OVERLAY_RSTYLE>).
401	respectively.
402		546
403	=item $term->scr_overlay_off	547	If C<$border> is C<2> (default), then a decorative border will be put
		548	around the box.
404		549
405	Switch the overlay off again.	550	If either C<$x> or C<$y> is negative, then this is counted from the
		551	right/bottom side, respectively.
406		552
407	=item $term->scr_overlay_set_char ($x, $y, $char, $rend = OVERLAY_RSTYLE)	553	This method returns an urxvt::overlay object. The overlay will be visible
		554	as long as the perl object is referenced.
408		555
409	Put a single character (specified numerically) at the given overlay	556	The methods currently supported on C<urxvt::overlay> objects are:
410	position.
411		557
		558	=over 4
		559
412	=item $term->scr_overlay_set ($x, $y, $text)	560	=item $overlay->set ($x, $y, $text, $rend)
413		561
414	Write a string at the given position into the overlay.	562	Similar to C<< $term->ROW_t >> and C<< $term->ROW_r >> in that it puts
		563	text in rxvt-unicode's special encoding and an array of rendition values
		564	at a specific position inside the overlay.
		565
		566	=item $overlay->hide
		567
		568	If visible, hide the overlay, but do not destroy it.
		569
		570	=item $overlay->show
		571
		572	If hidden, display the overlay again.
		573
		574	=back
415		575
416	=item $cellwidth = $term->strwidth $string	576	=item $cellwidth = $term->strwidth $string
417		577
418	Returns the number of screen-cells this string would need. Correctly	578	Returns the number of screen-cells this string would need. Correctly
419	accounts for wide and combining characters.	579	accounts for wide and combining characters.
…		…
430		590
431	Write the octets given in C<$data> to the tty (i.e. as program input). To	591	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	592	pass characters instead of octets, you should convert your strings first
433	to the locale-specific encoding using C<< $term->locale_encode >>.	593	to the locale-specific encoding using C<< $term->locale_encode >>.
434		594
		595	=item $window_width = $term->width
		596
		597	=item $window_height = $term->height
		598
		599	=item $font_width = $term->fwidth
		600
		601	=item $font_height = $term->fheight
		602
		603	=item $font_ascent = $term->fbase
		604
435	=item $nrow = $term->nrow	605	=item $terminal_rows = $term->nrow
436		606
437	=item $ncol = $term->ncol	607	=item $terminal_columns = $term->ncol
438		608
439	Return the number of rows/columns of the terminal window (i.e. as	609	=item $has_focus = $term->focus
440	specified by C<-geometry>, excluding any scrollback).
441		610
442	=item $nsaved = $term->nsaved	611	=item $is_mapped = $term->mapped
443		612
444	Returns the number of lines in the scrollback buffer.	613	=item $max_scrollback = $term->saveLines
		614
		615	=item $nrow_plus_saveLines = $term->total_rows
		616
		617	=item $lines_in_scrollback = $term->nsaved
		618
		619	Return various integers describing terminal characteristics.
445		620
446	=item $view_start = $term->view_start ([$newvalue])	621	=item $view_start = $term->view_start ([$newvalue])
447		622
448	Returns the negative row number of the topmost line. Minimum value is	623	Returns the negative row number of the topmost line. Minimum value is
449	C<0>, which displays the normal terminal contents. Larger values scroll	624	C<0>, which displays the normal terminal contents. Larger values scroll
…		…
460	=item $text = $term->ROW_t ($row_number[, $new_text[, $start_col]])	635	=item $text = $term->ROW_t ($row_number[, $new_text[, $start_col]])
461		636
462	Returns the text of the entire row with number C<$row_number>. Row C<0>	637	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	638	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	639	terminal line. The scrollback buffer starts at line C<-1> and extends to
465	line C<< -$term->nsaved >>.	640	line C<< -$term->nsaved >>. Nothing will be returned if a nonexistent line
		641	is requested.
466		642
467	If C<$new_text> is specified, it will replace characters in the current	643	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	644	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	645	to replace only parts of a line. The font index in the rendition will
470	automatically be updated.	646	automatically be updated.
471		647
472	C<$text> is in a special encoding: tabs and wide characters that use more	648	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	649	than one cell when displayed are padded with urxvt::NOCHAR characters
474	(C<chr 65535>). Characters with combining characters and other characters	650	(C<chr 65535>). Characters with combining characters and other characters
…		…
488	bitsets. Rendition bitsets contain information about colour, font, font	664	bitsets. Rendition bitsets contain information about colour, font, font
489	styles and similar information. See also C<< $term->ROW_t >>.	665	styles and similar information. See also C<< $term->ROW_t >>.
490		666
491	When setting rendition, the font mask will be ignored.	667	When setting rendition, the font mask will be ignored.
492		668
493	See the section on RENDITION, below.	669	See the section on RENDITION, above.
494		670
495	=item $length = $term->ROW_l ($row_number[, $new_length])	671	=item $length = $term->ROW_l ($row_number[, $new_length])
496		672
497	Returns the number of screen cells that are in use ("the line length"). If	673	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	674	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.	675	line is joined with the following one.
500		676
		677	=item $bool = $term->is_longer ($row_number)
		678
		679	Returns true if the row is part of a multiple-row logical "line" (i.e.
		680	joined with the following row), which means all characters are in use
		681	and it is continued on the next row (and possibly a continuation of the
		682	previous row(s)).
		683
		684	=item $line = $term->line ($row_number)
		685
		686	Create and return a new C<urxvt::line> object that stores information
		687	about the logical line that row C<$row_number> is part of. It supports the
		688	following methods:
		689
		690	=over 4
		691
		692	=item $text = $line->t
		693
		694	Returns the full text of the line, similar to C<ROW_t>
		695
		696	=item $rend = $line->r
		697
		698	Returns the full rendition array of the line, similar to C<ROW_r>
		699
		700	=item $length = $line->l
		701
		702	Returns the length of the line in cells, similar to C<ROW_l>.
		703
		704	=item $rownum = $line->beg
		705
		706	=item $rownum = $line->end
		707
		708	Return the row number of the first/last row of the line, respectively.
		709
		710	=item $offset = $line->offset_of ($row, $col)
		711
		712	Returns the character offset of the given row\|col pair within the logical
		713	line.
		714
		715	=item ($row, $col) = $line->coord_of ($offset)
		716
		717	Translates a string offset into terminal coordinates again.
		718
		719	=back
		720
		721	=cut
		722
		723	sub urxvt::term::line {
		724	my ($self, $row) = @_;
		725
		726	my $maxrow = $self->nrow - 1;
		727
		728	my ($beg, $end) = ($row, $row);
		729
		730	--$beg while $self->ROW_is_longer ($beg - 1);
		731	++$end while $self->ROW_is_longer ($end) && $end < $maxrow;
		732
		733	bless {
		734	term => $self,
		735	beg => $beg,
		736	end => $end,
		737	len => ($end - $beg) * $self->ncol + $self->ROW_l ($end),
		738	}, urxvt::line::
		739	}
		740
		741	sub urxvt::line::t {
		742	my ($self) = @_;
		743
		744	substr +(join "", map $self->{term}->ROW_t ($_), $self->{beg} .. $self->{end}),
		745	0, $self->{len}
		746	}
		747
		748	sub urxvt::line::r {
		749	my ($self) = @_;
		750
		751	my $rend = [
		752	map @{ $self->{term}->ROW_r ($_) }, $self->{beg} .. $self->{end}
		753	];
		754	$#$rend = $self->{len} - 1;
		755	$rend
		756	}
		757
		758	sub urxvt::line::beg { $_[0]{beg} }
		759	sub urxvt::line::end { $_[0]{end} }
		760	sub urxvt::line::l { $_[0]{len} }
		761
		762	sub urxvt::line::offset_of {
		763	my ($self, $row, $col) = @_;
		764
		765	($row - $self->{beg}) * $self->{term}->ncol + $col
		766	}
		767
		768	sub urxvt::line::coord_of {
		769	my ($self, $offset) = @_;
		770
		771	use integer;
		772
		773	(
		774	$offset / $self->{term}->ncol + $self->{beg},
		775	$offset % $self->{term}->ncol
		776	)
		777	}
		778
		779	=item ($row, $col) = $line->coord_of ($offset)
501	=item $text = $term->special_encode $string	780	=item $text = $term->special_encode $string
502		781
503	Converts a perl string into the special encoding used by rxvt-unicode,	782	Converts a perl string into the special encoding used by rxvt-unicode,
504	where one character corresponds to one screen cell. See	783	where one character corresponds to one screen cell. See
505	C<< $term->ROW_t >> for details.	784	C<< $term->ROW_t >> for details.
…		…
509	Converts rxvt-unicodes text reprsentation into a perl string. See	788	Converts rxvt-unicodes text reprsentation into a perl string. See
510	C<< $term->ROW_t >> for details.	789	C<< $term->ROW_t >> for details.
511		790
512	=back	791	=back
513		792
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	793	=head2 The C<urxvt::timer> Class
536		794
537	This class implements timer watchers/events. Time is represented as a	795	This class implements timer watchers/events. Time is represented as a
538	fractional number of seconds since the epoch. Example:	796	fractional number of seconds since the epoch. Example:
539		797
540	# create a digital clock display in upper right corner	798	$term->{overlay} = $term->overlay (-1, 0, 8, 1, urxvt::OVERLAY_RSTYLE, 0);
541	$term->{timer} = urxvt::timer	799	$term->{timer} = urxvt::timer
542	->new	800	->new
543	->start (urxvt::NOW)	801	->interval (1)
544	->cb (sub {	802	->cb (sub {
545	my ($timer) = @_;
546	my $time = $timer->at;
547	$timer->start ($time + 1);
548	$self->scr_overlay (-1, 0,	803	$term->{overlay}->set (0, 0,
549	POSIX::strftime "%H:%M:%S", localtime $time);	804	sprintf "%2d:%02d:%02d", (localtime urxvt::NOW)[2,1,0]);
550	});	805	});
551		806
552	=over 4	807	=over 4
553		808
554	=item $timer = new urxvt::timer	809	=item $timer = new urxvt::timer
555		810
556	Create a new timer object in stopped state.	811	Create a new timer object in started state. It is scheduled to fire
		812	immediately.
557		813
558	=item $timer = $timer->cb (sub { my ($timer) = @_; ... })	814	=item $timer = $timer->cb (sub { my ($timer) = @_; ... })
559		815
560	Set the callback to be called when the timer triggers.	816	Set the callback to be called when the timer triggers.
561		817
…		…
564	Return the time this watcher will fire next.	820	Return the time this watcher will fire next.
565		821
566	=item $timer = $timer->set ($tstamp)	822	=item $timer = $timer->set ($tstamp)
567		823
568	Set the time the event is generated to $tstamp.	824	Set the time the event is generated to $tstamp.
		825
		826	=item $timer = $timer->interval ($interval)
		827
		828	Normally (and when C<$interval> is C<0>), the timer will automatically
		829	stop after it has fired once. If C<$interval> is non-zero, then the timer
		830	is automatically rescheduled at the given intervals.
569		831
570	=item $timer = $timer->start	832	=item $timer = $timer->start
571		833
572	Start the timer.	834	Start the timer.
573		835
…		…
636	This variable controls the verbosity level of the perl extension. Higher	898	This variable controls the verbosity level of the perl extension. Higher
637	numbers indicate more verbose output.	899	numbers indicate more verbose output.
638		900
639	=over 4	901	=over 4
640		902
641	=item 0 - only fatal messages	903	=item =0 - only fatal messages
642		904
643	=item 3 - script loading and management	905	=item =3 - script loading and management
644		906
645	=item 10 - all events received	907	=item =10 - all events received
646		908
647	=back	909	=back
648		910
649	=head1 AUTHOR	911	=head1 AUTHOR
650		912

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.32 by root, Wed Jan 4 21:37:55 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.32 by root, Wed Jan 4 21:37:55 2006 UTC