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

Comparing rxvt-unicode/src/urxvt.pm (file contents):
Revision 1.10 by root, Mon Jan 2 20:47:52 2006 UTC vs.
Revision 1.30 by root, Wed Jan 4 05:35:34 2006 UTC

…		…
		1	=encoding utf8
		2
1	=head1 NAME	3	=head1 NAME
2		4
3	rxvtperl - rxvt-unicode's embedded perl interpreter	5	@@RXVT_NAME@@perl - rxvt-unicode's embedded perl interpreter
4		6
5	=head1 SYNOPSIS	7	=head1 SYNOPSIS
6		8
7	# create a file grab_test in $HOME:	9	# create a file grab_test in $HOME:
8		10
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.
		30
		31	=head2 Prepackaged Extensions
		32
		33	This section describes the extensiosn delivered with this version. You can
		34	find them in F<@@RXVT_LIBDIR@@/urxvt/perl/>.
		35
		36	You can activate them like this:
		37
		38	@@RXVT_NAME@@ -pe <extensionname>
		39
		40	=over 4
		41
		42	=item selection
		43
		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:
		50
		51	=over 4
		52
		53	=item rot13
		54
		55	Rot-13 the selection when activated. Used via keyboard trigger:
		56
		57	URxvt.keysym.C-M-r: perl:selection:rot13
		58
		59	=back
		60
		61	=item digital-clock
		62
		63	Displays a digital clock using the built-in overlay.
		64
		65	=item example-refresh-hooks
		66
		67	Displays a very simple digital clock in the upper right corner of the
		68	window. Illustrates overwriting the refresh callbacks to create your own
		69	overlays or changes.
		70
		71	=back
28		72
29	=head2 General API Considerations	73	=head2 General API Considerations
30		74
31	All objects (such as terminals, time watchers etc.) are typical	75	All objects (such as terminals, time watchers etc.) are typical
32	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
33	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
34	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
35	modified).	79	modified).
36		80
37	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
38	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
39	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
40	terminal is destroyed.	84	terminal is destroyed.
41		85
42	=head2 Hooks	86	=head2 Hooks
43		87
44	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
45	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.
46		96
47	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
48	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,
49	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.
50		100
…		…
83	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
84	by calling C<< $term->selection >>.	134	by calling C<< $term->selection >>.
85		135
86	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.
87		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
88	=item on_focus_in $term	147	=item on_focus_in $term
89		148
90	Called whenever the window gets the keyboard focus, before urxvt does	149	Called whenever the window gets the keyboard focus, before urxvt does
91	focus in processing.	150	focus in processing.
92		151
…		…
112	number of lines that will be in the scrollback buffer.	171	number of lines that will be in the scrollback buffer.
113		172
114	=item on_tty_activity $term NYI	173	=item on_tty_activity $term NYI
115		174
116	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.).
117		189
118	=item on_refresh_begin $term	190	=item on_refresh_begin $term
119		191
120	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
121	or similar effects by modify terminal contents in refresh_begin, and	193	or similar effects by modify terminal contents in refresh_begin, and
…		…
124		196
125	=item on_refresh_end $term	197	=item on_refresh_end $term
126		198
127	Called just after the screen gets redrawn. See C<on_refresh_begin>.	199	Called just after the screen gets redrawn. See C<on_refresh_begin>.
128		200
		201	=item on_keyboard_command $term, $string
		202
		203	Called whenever the user presses a key combination that has a
		204	C<perl:string> action bound to it (see description of the B<keysym>
		205	resource in the @@RXVT_NAME@@(1) manpage).
		206
		207	=back
		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
129	=back	218	=back
130		219
131	=head2 Functions in the C<urxvt> Package	220	=head2 Functions in the C<urxvt> Package
132		221
133	=over 4	222	=over 4
…		…
149		238
150	=item $time = urxvt::NOW	239	=item $time = urxvt::NOW
151		240
152	Returns the "current time" (as per the event loop).	241	Returns the "current time" (as per the event loop).
153		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
154	=cut	297	=cut
155		298
156	package urxvt;	299	package urxvt;
157		300
158	use strict;	301	use strict;
		302	use Scalar::Util ();
159		303
160	our $term;	304	our $TERM;
161	our @HOOKNAME;	305	our @HOOKNAME;
162	our $LIBDIR;	306	our $LIBDIR;
163		307
164	BEGIN {	308	BEGIN {
165	urxvt->bootstrap;	309	urxvt->bootstrap;
…		…
190	my $name = $HOOKNAME[$htype];	334	my $name = $HOOKNAME[$htype];
191		335
192	my $ref = $pkg->can ("on_" . lc $name)	336	my $ref = $pkg->can ("on_" . lc $name)
193	or next;	337	or next;
194		338
195	$term->{_hook}[$htype]{$ref*1} = $ref;	339	$TERM->{_hook}[$htype]{$pkg} = $ref;
196	$hook_count[$htype]++	340	$hook_count[$htype]++
197	or set_should_invoke $htype, 1;	341	or set_should_invoke $htype, 1;
198	}	342	}
199	}	343	}
200		344
…		…
224	}	368	}
225	}	369	}
226		370
227	# called by the rxvt core	371	# called by the rxvt core
228	sub invoke {	372	sub invoke {
229	local $term = shift;	373	local $TERM = shift;
230	my $htype = shift;	374	my $htype = shift;
231		375
232	if ($htype == 0) { # INIT	376	if ($htype == 0) { # INIT
233	my @dirs = ((split /:/, $term->resource ("perl_lib")), "$LIBDIR/perl");	377	my @dirs = ((split /:/, $TERM->resource ("perl_lib")), "$LIBDIR/perl");
234		378
235	for my $ext (split /:/, $term->resource ("perl_ext")) {	379	for my $ext (map { split /:/, $TERM->resource ("perl_ext_$_") } 1, 2) {
236	my @files = grep -f $_, map "$_/$ext", @dirs;	380	my @files = grep -f $_, map "$_/$ext", @dirs;
237		381
238	if (@files) {	382	if (@files) {
239	register_package script_package $files[0];	383	register_package script_package $files[0];
240	} else {	384	} else {
241	warn "perl extension '$ext' not found in perl library search path\n";	385	warn "perl extension '$ext' not found in perl library search path\n";
242	}	386	}
243	}	387	}
244		388
245	} elsif ($htype == 1) { # DESTROY	389	} elsif ($htype == 1) { # DESTROY
246	if (my $hook = $term->{_hook}) {	390	if (my $hook = $TERM->{_hook}) {
247	for my $htype (0..$#$hook) {	391	for my $htype (0..$#$hook) {
248	$hook_count[$htype] -= scalar keys %{ $hook->[$htype] \|\| {} }	392	$hook_count[$htype] -= scalar keys %{ $hook->[$htype] \|\| {} }
249	or set_should_invoke $htype, 0;	393	or set_should_invoke $htype, 0;
250	}	394	}
251	}	395	}
252	}	396	}
253		397
254	my $cb = $term->{_hook}[$htype]	398	my $cb = $TERM->{_hook}[$htype]
255	or return;	399	or return;
256		400
257	verbose 10, "$HOOKNAME[$htype] (" . (join ", ", $term, @_) . ")"	401	verbose 10, "$HOOKNAME[$htype] (" . (join ", ", $TERM, @_) . ")"
258	if $verbosity >= 10;	402	if $verbosity >= 10;
259		403
		404	keys %$cb;
		405
260	while (my ($k, $v) = each %$cb) {	406	while (my ($pkg, $cb) = each %$cb) {
261	return 1 if $v->($term, @_);	407	return 1
		408	if $cb->(
		409	$TERM->{$pkg} \|\|= do {
		410	my $proxy = bless { }, urxvt::term::proxy::;
		411	Scalar::Util::weaken ($proxy->{term} = $TERM);
		412	$proxy
		413	},
		414	@_,
		415	);
262	}	416	}
263		417
264	0	418	0
265	}	419	}
266		420
267	=back	421	sub urxvt::term::proxy::AUTOLOAD {
		422	$urxvt::term::proxy::AUTOLOAD =~ /:([^:]+)$/
		423	or die "FATAL: \$AUTOLOAD '$urxvt::term::proxy::AUTOLOAD' unparsable";
		424
		425	eval qq{
		426	sub $urxvt::term::proxy::AUTOLOAD {
		427	my \$proxy = shift;
		428	\$proxy->{term}->$1 (\@_)
		429	}
		430	1
		431	} or die "FATAL: unable to compile method forwarder: $@";
		432
		433	goto &$urxvt::term::proxy::AUTOLOAD;
		434	}
268		435
269	=head2 The C<urxvt::term> Class	436	=head2 The C<urxvt::term> Class
270		437
271	=over 4	438	=over 4
272		439
…		…
294	answerbackstring backgroundPixmap backspace_key boldFont boldItalicFont	461	answerbackstring backgroundPixmap backspace_key boldFont boldItalicFont
295	borderLess color cursorBlink cursorUnderline cutchars delete_key	462	borderLess color cursorBlink cursorUnderline cutchars delete_key
296	display_name embed ext_bwidth fade font geometry hold iconName	463	display_name embed ext_bwidth fade font geometry hold iconName
297	imFont imLocale inputMethod insecure int_bwidth intensityStyles	464	imFont imLocale inputMethod insecure int_bwidth intensityStyles
298	italicFont jumpScroll lineSpace loginShell mapAlert menu meta8 modifier	465	italicFont jumpScroll lineSpace loginShell mapAlert menu meta8 modifier
299	mouseWheelScrollPage name pastableTabs path perl_eval perl_ext	466	mouseWheelScrollPage name pastableTabs path perl_eval perl_ext_1 perl_ext_2
300	perl_lib pointerBlank pointerBlankDelay preeditType print_pipe pty_fd	467	perl_lib pointerBlank pointerBlankDelay preeditType print_pipe pty_fd
301	reverseVideo saveLines scrollBar scrollBar_align scrollBar_floating	468	reverseVideo saveLines scrollBar scrollBar_align scrollBar_floating
302	scrollBar_right scrollBar_thickness scrollTtyKeypress scrollTtyOutput	469	scrollBar_right scrollBar_thickness scrollTtyKeypress scrollTtyOutput
303	scrollWithBuffer scrollstyle secondaryScreen secondaryScroll selectstyle	470	scrollWithBuffer scrollstyle secondaryScreen secondaryScroll selectstyle
304	shade term_name title transparent transparent_all tripleclickwords	471	shade term_name title transparent transparent_all tripleclickwords
…		…
328		495
329	=item $oldtext = $term->selection ([$newtext])	496	=item $oldtext = $term->selection ([$newtext])
330		497
331	Return the current selection text and optionally replace it by C<$newtext>.	498	Return the current selection text and optionally replace it by C<$newtext>.
332		499
333	=item $term->scr_overlay ($x, $y, $text)	500	#=item $term->overlay ($x, $y, $text)
334		501	#
335	Create a simple multi-line overlay box. See the next method for details.	502	#Create a simple multi-line overlay box. See the next method for details.
336		503	#
337	=cut	504	#=cut
338		505
339	sub urxvt::term::scr_overlay {	506	sub urxvt::term::scr_overlay {
		507	die;
340	my ($self, $x, $y, $text) = @_;	508	my ($self, $x, $y, $text) = @_;
341		509
342	my @lines = split /\n/, $text;	510	my @lines = split /\n/, $text;
343		511
344	my $w = 0;	512	my $w = 0;
…		…
348		516
349	$self->scr_overlay_new ($x, $y, $w, scalar @lines);	517	$self->scr_overlay_new ($x, $y, $w, scalar @lines);
350	$self->scr_overlay_set (0, $_, $lines[$_]) for 0.. $#lines;	518	$self->scr_overlay_set (0, $_, $lines[$_]) for 0.. $#lines;
351	}	519	}
352		520
353	=item $term->scr_overlay_new ($x, $y, $width, $height)	521	=item $term->overlay ($x, $y, $width, $height[, $rstyle[, $border]])
354		522
355	Create a new (empty) overlay at the given position with the given	523	Create a new (empty) overlay at the given position with the given
356	width/height. A border will be put around the box. If either C<$x> or	524	width/height. C<$rstyle> defines the initial rendition style
357	C<$y> is negative, then this is counted from the right/bottom side,	525	(default: C<OVERLAY_RSTYLE>).
358	respectively.
359		526
360	=item $term->scr_overlay_off	527	If C<$border> is C<2> (default), then a decorative border will be put
		528	around the box.
361		529
362	Switch the overlay off again.	530	If either C<$x> or C<$y> is negative, then this is counted from the
		531	right/bottom side, respectively.
363		532
364	=item $term->scr_overlay_set_char ($x, $y, $char, $rend = OVERLAY_RSTYLE)	533	This method returns an urxvt::overlay object. The overlay will be visible
		534	as long as the perl object is referenced.
365		535
366	Put a single character (specified numerically) at the given overlay	536	The methods currently supported on C<urxvt::overlay> objects are:
367	position.
368		537
		538	=over 4
		539
369	=item $term->scr_overlay_set ($x, $y, $text)	540	=item $overlay->set ($x, $y, $text, $rend)
370		541
371	Write a string at the given position into the overlay.	542	Similar to C<< $term->ROW_t >> and C<< $term->ROW_r >> in that it puts
		543	text in rxvt-unicode's special encoding and an array of rendition values
		544	at a specific position inside the overlay.
		545
		546	=item $overlay->hide
		547
		548	If visible, hide the overlay, but do not destroy it.
		549
		550	=item $overlay->show
		551
		552	If hidden, display the overlay again.
		553
		554	=back
372		555
373	=item $cellwidth = $term->strwidth $string	556	=item $cellwidth = $term->strwidth $string
374		557
375	Returns the number of screen-cells this string would need. Correctly	558	Returns the number of screen-cells this string would need. Correctly
376	accounts for wide and combining characters.	559	accounts for wide and combining characters.
…		…
384	Convert the given locale-encoded octets into a perl string.	567	Convert the given locale-encoded octets into a perl string.
385		568
386	=item $term->tt_write ($octets)	569	=item $term->tt_write ($octets)
387		570
388	Write the octets given in C<$data> to the tty (i.e. as program input). To	571	Write the octets given in C<$data> to the tty (i.e. as program input). To
389	pass characters instead of octets, you should convetr you strings first to	572	pass characters instead of octets, you should convert your strings first
390	the locale-specific encoding using C<< $term->locale_encode >>.	573	to the locale-specific encoding using C<< $term->locale_encode >>.
		574
		575	=item $nrow = $term->nrow
		576
		577	=item $ncol = $term->ncol
		578
		579	Return the number of rows/columns of the terminal window (i.e. as
		580	specified by C<-geometry>, excluding any scrollback).
		581
		582	=item $nsaved = $term->nsaved
		583
		584	Returns the number of lines in the scrollback buffer.
		585
		586	=item $view_start = $term->view_start ([$newvalue])
		587
		588	Returns the negative row number of the topmost line. Minimum value is
		589	C<0>, which displays the normal terminal contents. Larger values scroll
		590	this many lines into the scrollback buffer.
		591
		592	=item $term->want_refresh
		593
		594	Requests a screen refresh. At the next opportunity, rxvt-unicode will
		595	compare the on-screen display with its stored representation. If they
		596	differ, it redraws the differences.
		597
		598	Used after changing terminal contents to display them.
		599
		600	=item $text = $term->ROW_t ($row_number[, $new_text[, $start_col]])
		601
		602	Returns the text of the entire row with number C<$row_number>. Row C<0>
		603	is the topmost terminal line, row C<< $term->$ncol-1 >> is the bottommost
		604	terminal line. The scrollback buffer starts at line C<-1> and extends to
		605	line C<< -$term->nsaved >>. Nothing will be returned if a nonexistent line
		606	is requested.
		607
		608	If C<$new_text> is specified, it will replace characters in the current
		609	line, starting at column C<$start_col> (default C<0>), which is useful
		610	to replace only parts of a line. The font index in the rendition will
		611	automatically be updated.
		612
		613	C<$text> is in a special encoding: tabs and wide characters that use more
		614	than one cell when displayed are padded with urxvt::NOCHAR characters
		615	(C<chr 65535>). Characters with combining characters and other characters
		616	that do not fit into the normal tetx encoding will be replaced with
		617	characters in the private use area.
		618
		619	You have to obey this encoding when changing text. The advantage is
		620	that C<substr> and similar functions work on screen cells and not on
		621	characters.
		622
		623	The methods C<< $term->special_encode >> and C<< $term->special_decode >>
		624	can be used to convert normal strings into this encoding and vice versa.
		625
		626	=item $rend = $term->ROW_r ($row_number[, $new_rend[, $start_col]])
		627
		628	Like C<< $term->ROW_t >>, but returns an arrayref with rendition
		629	bitsets. Rendition bitsets contain information about colour, font, font
		630	styles and similar information. See also C<< $term->ROW_t >>.
		631
		632	When setting rendition, the font mask will be ignored.
		633
		634	See the section on RENDITION, above.
		635
		636	=item $length = $term->ROW_l ($row_number[, $new_length])
		637
		638	Returns the number of screen cells that are in use ("the line
		639	length"). Unlike the urxvt core, this returns C<< $term->ncol >> if the
		640	line is joined with the following one.
		641
		642	=item $bool = $term->is_longer ($row_number)
		643
		644	Returns true if the row is part of a multiple-row logical "line" (i.e.
		645	joined with the following row), which means all characters are in use
		646	and it is continued on the next row (and possibly a continuation of the
		647	previous row(s)).
		648
		649	=item $line = $term->line ($row_number)
		650
		651	Create and return a new C<urxvt::line> object that stores information
		652	about the logical line that row C<$row_number> is part of. It supports the
		653	following methods:
		654
		655	=over 4
		656
		657	=item $text = $line->t
		658
		659	Returns the full text of the line, similar to C<ROW_t>
		660
		661	=item $rend = $line->r
		662
		663	Returns the full rendition array of the line, similar to C<ROW_r>
		664
		665	=item $length = $line->l
		666
		667	Returns the length of the line in cells, similar to C<ROW_l>.
		668
		669	=item $rownum = $line->beg
		670
		671	=item $rownum = $line->end
		672
		673	Return the row number of the first/last row of the line, respectively.
		674
		675	=item $offset = $line->offset_of ($row, $col)
		676
		677	Returns the character offset of the given row\|col pair within the logical
		678	line.
		679
		680	=item ($row, $col) = $line->coord_of ($offset)
		681
		682	Translates a string offset into terminal coordinates again.
		683
		684	=back
		685
		686	=cut
		687
		688	sub urxvt::term::line {
		689	my ($self, $row) = @_;
		690
		691	my $maxrow = $self->nrow - 1;
		692
		693	my ($beg, $end) = ($row, $row);
		694
		695	--$beg while $self->ROW_is_longer ($beg - 1);
		696	++$end while $self->ROW_is_longer ($end) && $end < $maxrow;
		697
		698	bless {
		699	term => $self,
		700	beg => $beg,
		701	end => $end,
		702	len => ($end - $beg) * $self->ncol + $self->ROW_l ($end),
		703	}, urxvt::line::
		704	}
		705
		706	sub urxvt::line::t {
		707	my ($self) = @_;
		708
		709	substr +(join "", map $self->{term}->ROW_t ($_), $self->{beg} .. $self->{end}),
		710	0, $self->{len}
		711	}
		712
		713	sub urxvt::line::r {
		714	my ($self) = @_;
		715
		716	my $rend = [
		717	map @{ $self->{term}->ROW_r ($_) }, $self->{beg} .. $self->{end}
		718	];
		719	$#$rend = $self->{len} - 1;
		720	$rend
		721	}
		722
		723	sub urxvt::line::beg { $_[0]{beg} }
		724	sub urxvt::line::end { $_[0]{end} }
		725	sub urxvt::line::l { $_[0]{len} }
		726
		727	sub urxvt::line::offset_of {
		728	my ($self, $row, $col) = @_;
		729
		730	($row - $self->{beg}) * $self->{term}->ncol + $col
		731	}
		732
		733	sub urxvt::line::coord_of {
		734	my ($self, $offset) = @_;
		735
		736	use integer;
		737
		738	(
		739	$offset / $self->{term}->ncol + $self->{beg},
		740	$offset % $self->{term}->ncol
		741	)
		742	}
		743
		744	=item ($row, $col) = $line->coord_of ($offset)
		745	=item $text = $term->special_encode $string
		746
		747	Converts a perl string into the special encoding used by rxvt-unicode,
		748	where one character corresponds to one screen cell. See
		749	C<< $term->ROW_t >> for details.
		750
		751	=item $string = $term->special_decode $text
		752
		753	Converts rxvt-unicodes text reprsentation into a perl string. See
		754	C<< $term->ROW_t >> for details.
391		755
392	=back	756	=back
393		757
394	=head2 The C<urxvt::timer> Class	758	=head2 The C<urxvt::timer> Class
395		759
396	This class implements timer watchers/events. Time is represented as a	760	This class implements timer watchers/events. Time is represented as a
397	fractional number of seconds since the epoch. Example:	761	fractional number of seconds since the epoch. Example:
398		762
399	# create a digital clock display in upper right corner	763	$term->{overlay} = $term->overlay (-1, 0, 8, 1, urxvt::OVERLAY_RSTYLE, 0);
400	$term->{timer} = urxvt::timer	764	$term->{timer} = urxvt::timer
401	->new	765	->new
402	->start (urxvt::NOW)	766	->interval (1)
403	->cb (sub {	767	->cb (sub {
404	my ($timer) = @_;
405	my $time = $timer->at;
406	$timer->start ($time + 1);
407	$self->scr_overlay (-1, 0,	768	$term->{overlay}->set (0, 0,
408	POSIX::strftime "%H:%M:%S", localtime $time);	769	sprintf "%2d:%02d:%02d", (localtime urxvt::NOW)[2,1,0]);
409	});	770	});
410		771
411	=over 4	772	=over 4
412		773
413	=item $timer = new urxvt::timer	774	=item $timer = new urxvt::timer
414		775
415	Create a new timer object in stopped state.	776	Create a new timer object in started state. It is scheduled to fire
		777	immediately.
416		778
417	=item $timer = $timer->cb (sub { my ($timer) = @_; ... })	779	=item $timer = $timer->cb (sub { my ($timer) = @_; ... })
418		780
419	Set the callback to be called when the timer triggers.	781	Set the callback to be called when the timer triggers.
420		782
…		…
423	Return the time this watcher will fire next.	785	Return the time this watcher will fire next.
424		786
425	=item $timer = $timer->set ($tstamp)	787	=item $timer = $timer->set ($tstamp)
426		788
427	Set the time the event is generated to $tstamp.	789	Set the time the event is generated to $tstamp.
		790
		791	=item $timer = $timer->interval ($interval)
		792
		793	Normally (and when C<$interval> is C<0>), the timer will automatically
		794	stop after it has fired once. If C<$interval> is non-zero, then the timer
		795	is automatically rescheduled at the given intervals.
428		796
429	=item $timer = $timer->start	797	=item $timer = $timer->start
430		798
431	Start the timer.	799	Start the timer.
432		800
…		…
495	This variable controls the verbosity level of the perl extension. Higher	863	This variable controls the verbosity level of the perl extension. Higher
496	numbers indicate more verbose output.	864	numbers indicate more verbose output.
497		865
498	=over 4	866	=over 4
499		867
500	=item 0 - only fatal messages	868	=item =0 - only fatal messages
501		869
502	=item 3 - script loading and management	870	=item =3 - script loading and management
503		871
504	=item 10 - all events received	872	=item =10 - all events received
505		873
506	=back	874	=back
507		875
508	=head1 AUTHOR	876	=head1 AUTHOR
509		877

Diff Legend

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

Comparing rxvt-unicode/src/urxvt.pm (file contents): Revision 1.10 by root, Mon Jan 2 20:47:52 2006 UTC vs. Revision 1.30 by root, Wed Jan 4 05:35:34 2006 UTC

Diff Legend

Comparing rxvt-unicode/src/urxvt.pm (file contents):
Revision 1.10 by root, Mon Jan 2 20:47:52 2006 UTC vs.
Revision 1.30 by root, Wed Jan 4 05:35:34 2006 UTC