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

Comparing rxvt-unicode/src/urxvt.pm (file contents):
Revision 1.18 by root, Tue Jan 3 02:01:27 2006 UTC vs.
Revision 1.32 by root, Wed Jan 4 21:37:55 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 example-refresh-hooks
57		66
58	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
59	window. Illustrates overwriting the refresh callbacks to create your own	68	window. Illustrates overwriting the refresh callbacks to create your own
60	overlays or changes.	69	overlays or changes.
61		70
62	=item simple-overlay-clock
63
64	Displays a digital clock using the built-in overlay (colourful, useless).
65
66	=back	71	=back
67		72
68	=head2 General API Considerations	73	=head2 General API Considerations
69		74
70	All objects (such as terminals, time watchers etc.) are typical	75	All objects (such as terminals, time watchers etc.) are typical
71	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
72	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
73	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
74	modified).	79	modified).
75		80
76	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
77	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
78	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
79	terminal is destroyed.	84	terminal is destroyed.
80		85
81	=head2 Hooks	86	=head2 Hooks
82		87
83	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
84	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.
85		96
86	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
87	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,
88	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.
89		100
…		…
122	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
123	by calling C<< $term->selection >>.	134	by calling C<< $term->selection >>.
124		135
125	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.
126		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
127	=item on_focus_in $term	147	=item on_focus_in $term
128		148
129	Called whenever the window gets the keyboard focus, before urxvt does	149	Called whenever the window gets the keyboard focus, before urxvt does
130	focus in processing.	150	focus in processing.
131		151
…		…
151	number of lines that will be in the scrollback buffer.	171	number of lines that will be in the scrollback buffer.
152		172
153	=item on_tty_activity $term NYI	173	=item on_tty_activity $term NYI
154		174
155	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.).
156		189
157	=item on_refresh_begin $term	190	=item on_refresh_begin $term
158		191
159	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
160	or similar effects by modify terminal contents in refresh_begin, and	193	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>	204	C<perl:string> action bound to it (see description of the B<keysym>
172	resource in the @@RXVT_NAME@@(1) manpage).	205	resource in the @@RXVT_NAME@@(1) manpage).
173		206
174	=back	207	=back
175		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
176	=head2 Functions in the C<urxvt> Package	220	=head2 Functions in the C<urxvt> Package
177		221
178	=over 4	222	=over 4
179		223
180	=item urxvt::fatal $errormessage	224	=item urxvt::fatal $errormessage
…		…
193	correct place, e.g. on stderr of the connecting urxvtc client.	237	correct place, e.g. on stderr of the connecting urxvtc client.
194		238
195	=item $time = urxvt::NOW	239	=item $time = urxvt::NOW
196		240
197	Returns the "current time" (as per the event loop).	241	Returns the "current time" (as per the event loop).
		242
		243	=back
198		244
199	=head2 RENDITION	245	=head2 RENDITION
200		246
201	Rendition bitsets contain information about colour, font, font styles and	247	Rendition bitsets contain information about colour, font, font styles and
202	similar information for each screen cell.	248	similar information for each screen cell.
…		…
218	Return the rendition mask used for overlays by default.	264	Return the rendition mask used for overlays by default.
219		265
220	=item $rendbit = urxvt::RS_Bold, RS_Italic, RS_Blink, RS_RVid, RS_Uline	266	=item $rendbit = urxvt::RS_Bold, RS_Italic, RS_Blink, RS_RVid, RS_Uline
221		267
222	Return the bit that enabled bold, italic, blink, reverse-video and	268	Return the bit that enabled bold, italic, blink, reverse-video and
223	underline, respectively. To enable such a style, just or it onto the	269	underline, respectively. To enable such a style, just logically OR it into
224	bitset.	270	the bitset.
225		271
226	=item $foreground = urxvt::GET_BASEFG $rend	272	=item $foreground = urxvt::GET_BASEFG $rend
227		273
228	=item $background = urxvt::GET_BASEBG $rend	274	=item $background = urxvt::GET_BASEBG $rend
229		275
…		…
234	=item $rend = urxvt::SET_BGCOLOR ($rend, $new_colour)	280	=item $rend = urxvt::SET_BGCOLOR ($rend, $new_colour)
235		281
236	Replace the foreground/background colour in the rendition mask with the	282	Replace the foreground/background colour in the rendition mask with the
237	specified one.	283	specified one.
238		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
239	=back	295	=back
240		296
241	=cut	297	=cut
242		298
243	package urxvt;	299	package urxvt;
244		300
245	use strict;	301	use strict;
		302	use Scalar::Util ();
246		303
247	our $term;	304	our $TERM;
248	our @HOOKNAME;	305	our @HOOKNAME;
249	our $LIBDIR;	306	our $LIBDIR;
250		307
251	BEGIN {	308	BEGIN {
252	urxvt->bootstrap;	309	urxvt->bootstrap;
…		…
277	my $name = $HOOKNAME[$htype];	334	my $name = $HOOKNAME[$htype];
278		335
279	my $ref = $pkg->can ("on_" . lc $name)	336	my $ref = $pkg->can ("on_" . lc $name)
280	or next;	337	or next;
281		338
282	$term->{_hook}[$htype]{$ref*1} = $ref;	339	$TERM->{_hook}[$htype]{$pkg} = $ref;
283	$hook_count[$htype]++	340	$hook_count[$htype]++
284	or set_should_invoke $htype, 1;	341	or set_should_invoke $htype, 1;
285	}	342	}
286	}	343	}
287		344
…		…
309		366
310	$pkg	367	$pkg
311	}	368	}
312	}	369	}
313		370
		371	our $retval; # return value for urxvt
		372
314	# called by the rxvt core	373	# called by the rxvt core
315	sub invoke {	374	sub invoke {
316	local $term = shift;	375	local $TERM = shift;
317	my $htype = shift;	376	my $htype = shift;
318		377
319	if ($htype == 0) { # INIT	378	if ($htype == 0) { # INIT
320	my @dirs = ((split /:/, $term->resource ("perl_lib")), "$LIBDIR/perl");	379	my @dirs = ((split /:/, $TERM->resource ("perl_lib")), "$LIBDIR/perl");
321		380
322	for my $ext (split /:/, $term->resource ("perl_ext")) {	381	for my $ext (map { split /:/, $TERM->resource ("perl_ext_$_") } 1, 2) {
323	my @files = grep -f $_, map "$_/$ext", @dirs;	382	my @files = grep -f $_, map "$_/$ext", @dirs;
324		383
325	if (@files) {	384	if (@files) {
326	register_package script_package $files[0];	385	register_package script_package $files[0];
327	} else {	386	} else {
328	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";
329	}	388	}
330	}	389	}
		390	}
331		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
332	} elsif ($htype == 1) { # DESTROY	412	if ($htype == 1) { # DESTROY
		413	# remove hooks if unused
333	if (my $hook = $term->{_hook}) {	414	if (my $hook = $TERM->{_hook}) {
334	for my $htype (0..$#$hook) {	415	for my $htype (0..$#$hook) {
335	$hook_count[$htype] -= scalar keys %{ $hook->[$htype] \|\| {} }	416	$hook_count[$htype] -= scalar keys %{ $hook->[$htype] \|\| {} }
336	or set_should_invoke $htype, 0;	417	or set_should_invoke $htype, 0;
337	}	418	}
338	}	419	}
		420
		421	# clear package objects
		422	%$_ = () for values %{ $TERM->{_pkg} };
		423
		424	# clear package
		425	%$TERM = ();
339	}	426	}
340		427
341	my $cb = $term->{_hook}[$htype]	428	$retval
342	or return;
343
344	verbose 10, "$HOOKNAME[$htype] (" . (join ", ", $term, @_) . ")"
345	if $verbosity >= 10;
346
347	while (my ($k, $v) = each %$cb) {
348	return 1 if $v->($term, @_);
349	}
350
351	0
352	}	429	}
353		430
354	=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	}
355		445
356	=head2 The C<urxvt::term> Class	446	=head2 The C<urxvt::term> Class
357		447
358	=over 4	448	=over 4
359		449
…		…
381	answerbackstring backgroundPixmap backspace_key boldFont boldItalicFont	471	answerbackstring backgroundPixmap backspace_key boldFont boldItalicFont
382	borderLess color cursorBlink cursorUnderline cutchars delete_key	472	borderLess color cursorBlink cursorUnderline cutchars delete_key
383	display_name embed ext_bwidth fade font geometry hold iconName	473	display_name embed ext_bwidth fade font geometry hold iconName
384	imFont imLocale inputMethod insecure int_bwidth intensityStyles	474	imFont imLocale inputMethod insecure int_bwidth intensityStyles
385	italicFont jumpScroll lineSpace loginShell mapAlert menu meta8 modifier	475	italicFont jumpScroll lineSpace loginShell mapAlert menu meta8 modifier
386	mouseWheelScrollPage name pastableTabs path perl_eval perl_ext	476	mouseWheelScrollPage name pastableTabs path perl_eval perl_ext_1 perl_ext_2
387	perl_lib pointerBlank pointerBlankDelay preeditType print_pipe pty_fd	477	perl_lib pointerBlank pointerBlankDelay preeditType print_pipe pty_fd
388	reverseVideo saveLines scrollBar scrollBar_align scrollBar_floating	478	reverseVideo saveLines scrollBar scrollBar_align scrollBar_floating
389	scrollBar_right scrollBar_thickness scrollTtyKeypress scrollTtyOutput	479	scrollBar_right scrollBar_thickness scrollTtyKeypress scrollTtyOutput
390	scrollWithBuffer scrollstyle secondaryScreen secondaryScroll selectstyle	480	scrollWithBuffer scrollstyle secondaryScreen secondaryScroll selectstyle
391	shade term_name title transparent transparent_all tripleclickwords	481	shade term_name title transparent transparent_all tripleclickwords
…		…
397	my ($self, $name) = (shift, shift);	487	my ($self, $name) = (shift, shift);
398	unshift @_, $self, $name, ($name =~ s/\s\+\s(\d+)$// ? $1 : 0);	488	unshift @_, $self, $name, ($name =~ s/\s\+\s(\d+)$// ? $1 : 0);
399	goto &urxvt::term::_resource;	489	goto &urxvt::term::_resource;
400	}	490	}
401		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
402	=item ($row, $col) = $term->selection_mark ([$row, $col])	502	=item ($row, $col) = $term->selection_mark ([$row, $col])
403		503
404	=item ($row, $col) = $term->selection_beg ([$row, $col])	504	=item ($row, $col) = $term->selection_beg ([$row, $col])
405		505
406	=item ($row, $col) = $term->selection_end ([$row, $col])	506	=item ($row, $col) = $term->selection_end ([$row, $col])
…		…
415		515
416	=item $oldtext = $term->selection ([$newtext])	516	=item $oldtext = $term->selection ([$newtext])
417		517
418	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>.
419		519
420	=item $term->scr_overlay ($x, $y, $text)	520	#=item $term->overlay ($x, $y, $text)
421		521	#
422	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.
423		523	#
424	=cut	524	#=cut
425		525
426	sub urxvt::term::scr_overlay {	526	sub urxvt::term::scr_overlay {
		527	die;
427	my ($self, $x, $y, $text) = @_;	528	my ($self, $x, $y, $text) = @_;
428		529
429	my @lines = split /\n/, $text;	530	my @lines = split /\n/, $text;
430		531
431	my $w = 0;	532	my $w = 0;
…		…
435		536
436	$self->scr_overlay_new ($x, $y, $w, scalar @lines);	537	$self->scr_overlay_new ($x, $y, $w, scalar @lines);
437	$self->scr_overlay_set (0, $_, $lines[$_]) for 0.. $#lines;	538	$self->scr_overlay_set (0, $_, $lines[$_]) for 0.. $#lines;
438	}	539	}
439		540
440	=item $term->scr_overlay_new ($x, $y, $width, $height)	541	=item $term->overlay ($x, $y, $width, $height[, $rstyle[, $border]])
441		542
442	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
443	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
444	C<$y> is negative, then this is counted from the right/bottom side,	545	(default: C<OVERLAY_RSTYLE>).
445	respectively.
446		546
447	=item $term->scr_overlay_off	547	If C<$border> is C<2> (default), then a decorative border will be put
		548	around the box.
448		549
449	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.
450		552
451	=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.
452		555
453	Put a single character (specified numerically) at the given overlay	556	The methods currently supported on C<urxvt::overlay> objects are:
454	position.
455		557
		558	=over 4
		559
456	=item $term->scr_overlay_set ($x, $y, $text)	560	=item $overlay->set ($x, $y, $text, $rend)
457		561
458	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
459		575
460	=item $cellwidth = $term->strwidth $string	576	=item $cellwidth = $term->strwidth $string
461		577
462	Returns the number of screen-cells this string would need. Correctly	578	Returns the number of screen-cells this string would need. Correctly
463	accounts for wide and combining characters.	579	accounts for wide and combining characters.
…		…
474		590
475	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
476	pass characters instead of octets, you should convert your strings first	592	pass characters instead of octets, you should convert your strings first
477	to the locale-specific encoding using C<< $term->locale_encode >>.	593	to the locale-specific encoding using C<< $term->locale_encode >>.
478		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
479	=item $nrow = $term->nrow	605	=item $terminal_rows = $term->nrow
480		606
481	=item $ncol = $term->ncol	607	=item $terminal_columns = $term->ncol
482		608
483	Return the number of rows/columns of the terminal window (i.e. as	609	=item $has_focus = $term->focus
484	specified by C<-geometry>, excluding any scrollback).
485		610
486	=item $nsaved = $term->nsaved	611	=item $is_mapped = $term->mapped
487		612
488	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.
489		620
490	=item $view_start = $term->view_start ([$newvalue])	621	=item $view_start = $term->view_start ([$newvalue])
491		622
492	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
493	C<0>, which displays the normal terminal contents. Larger values scroll	624	C<0>, which displays the normal terminal contents. Larger values scroll
…		…
504	=item $text = $term->ROW_t ($row_number[, $new_text[, $start_col]])	635	=item $text = $term->ROW_t ($row_number[, $new_text[, $start_col]])
505		636
506	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>
507	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
508	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
509	line C<< -$term->nsaved >>.	640	line C<< -$term->nsaved >>. Nothing will be returned if a nonexistent line
		641	is requested.
510		642
511	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
512	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
513	to replace only parts of a line. The font index in the rendition will	645	to replace only parts of a line. The font index in the rendition will
514	automatically be updated.	646	automatically be updated.
…		…
536		668
537	See the section on RENDITION, above.	669	See the section on RENDITION, above.
538		670
539	=item $length = $term->ROW_l ($row_number[, $new_length])	671	=item $length = $term->ROW_l ($row_number[, $new_length])
540		672
541	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
542	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
543	means all characters are in use and it is continued on the next row.	675	line is joined with the following one.
544		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)
545	=item $text = $term->special_encode $string	780	=item $text = $term->special_encode $string
546		781
547	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,
548	where one character corresponds to one screen cell. See	783	where one character corresponds to one screen cell. See
549	C<< $term->ROW_t >> for details.	784	C<< $term->ROW_t >> for details.
…		…
558	=head2 The C<urxvt::timer> Class	793	=head2 The C<urxvt::timer> Class
559		794
560	This class implements timer watchers/events. Time is represented as a	795	This class implements timer watchers/events. Time is represented as a
561	fractional number of seconds since the epoch. Example:	796	fractional number of seconds since the epoch. Example:
562		797
563	# create a digital clock display in upper right corner	798	$term->{overlay} = $term->overlay (-1, 0, 8, 1, urxvt::OVERLAY_RSTYLE, 0);
564	$term->{timer} = urxvt::timer	799	$term->{timer} = urxvt::timer
565	->new	800	->new
566	->start (urxvt::NOW)	801	->interval (1)
567	->cb (sub {	802	->cb (sub {
568	my ($timer) = @_;
569	my $time = $timer->at;
570	$timer->start ($time + 1);
571	$self->scr_overlay (-1, 0,	803	$term->{overlay}->set (0, 0,
572	POSIX::strftime "%H:%M:%S", localtime $time);	804	sprintf "%2d:%02d:%02d", (localtime urxvt::NOW)[2,1,0]);
573	});	805	});
574		806
575	=over 4	807	=over 4
576		808
577	=item $timer = new urxvt::timer	809	=item $timer = new urxvt::timer
578		810
579	Create a new timer object in stopped state.	811	Create a new timer object in started state. It is scheduled to fire
		812	immediately.
580		813
581	=item $timer = $timer->cb (sub { my ($timer) = @_; ... })	814	=item $timer = $timer->cb (sub { my ($timer) = @_; ... })
582		815
583	Set the callback to be called when the timer triggers.	816	Set the callback to be called when the timer triggers.
584		817
…		…
587	Return the time this watcher will fire next.	820	Return the time this watcher will fire next.
588		821
589	=item $timer = $timer->set ($tstamp)	822	=item $timer = $timer->set ($tstamp)
590		823
591	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.
592		831
593	=item $timer = $timer->start	832	=item $timer = $timer->start
594		833
595	Start the timer.	834	Start the timer.
596		835
…		…
659	This variable controls the verbosity level of the perl extension. Higher	898	This variable controls the verbosity level of the perl extension. Higher
660	numbers indicate more verbose output.	899	numbers indicate more verbose output.
661		900
662	=over 4	901	=over 4
663		902
664	=item 0 - only fatal messages	903	=item =0 - only fatal messages
665		904
666	=item 3 - script loading and management	905	=item =3 - script loading and management
667		906
668	=item 10 - all events received	907	=item =10 - all events received
669		908
670	=back	909	=back
671		910
672	=head1 AUTHOR	911	=head1 AUTHOR
673		912

Diff Legend

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

Comparing rxvt-unicode/src/urxvt.pm (file contents): Revision 1.18 by root, Tue Jan 3 02:01:27 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.18 by root, Tue Jan 3 02:01:27 2006 UTC vs.
Revision 1.32 by root, Wed Jan 4 21:37:55 2006 UTC