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

Comparing rxvt-unicode/src/urxvt.pm (file contents):
Revision 1.5 by root, Mon Jan 2 17:20:00 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	* Put your scripts into F<@@RXVT_LIBDIR@@/urxvt/perl-ext/>, they will be loaded automatically.	9	# create a file grab_test in $HOME:
8
9	* Each script will only be loaded once, even in urxvtd, and will be valid
10	globally.
11
12	* Scripts are evaluated in a 'use strict' and 'use utf8' environment, and
13	thus must be encoded as UTF-8.
14		10
15	sub on_sel_grab {	11	sub on_sel_grab {
16	warn "you selected ", $_[0]->selection;	12	warn "you selected ", $_[0]->selection;
17	()	13	()
18	}	14	}
19		15
20	1	16	# start a @@RXVT_NAME@@ using it:
		17
		18	@@RXVT_NAME@@ --perl-lib $HOME -pe grab_test
21		19
22	=head1 DESCRIPTION	20	=head1 DESCRIPTION
23		21
		22	Everytime a terminal object gets created, scripts specified via the
		23	C<perl> resource are loaded and associated with it.
		24
		25	Scripts are compiled in a 'use strict' and 'use utf8' environment, and
		26	thus must be encoded as UTF-8.
		27
		28	Each script will only ever be loaded once, even in @@RXVT_NAME@@d, where
		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
		72
		73	=head2 General API Considerations
		74
		75	All objects (such as terminals, time watchers etc.) are typical
		76	reference-to-hash objects. The hash can be used to store anything you
		77	like. All members starting with an underscore (such as C<_ptr> or
		78	C<_hook>) are reserved for internal uses and B<MUST NOT> be accessed or
		79	modified).
		80
		81	When objects are destroyed on the C++ side, the perl object hashes are
		82	emptied, so its best to store related objects such as time watchers and
		83	the like inside the terminal object so they get destroyed as soon as the
		84	terminal is destroyed.
		85
24	=head2 Hooks	86	=head2 Hooks
25		87
26	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
27	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.
28		96
29	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
30	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,
31	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.
32		100
65	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
66	by calling C<< $term->selection >>.	134	by calling C<< $term->selection >>.
67		135
68	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.
69		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
70	=item on_focus_in $term	147	=item on_focus_in $term
71		148
72	Called whenever the window gets the keyboard focus, before urxvt does	149	Called whenever the window gets the keyboard focus, before urxvt does
73	focus in processing.	150	focus in processing.
74		151
…		…
94	number of lines that will be in the scrollback buffer.	171	number of lines that will be in the scrollback buffer.
95		172
96	=item on_tty_activity $term NYI	173	=item on_tty_activity $term NYI
97		174
98	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.).
99		189
100	=item on_refresh_begin $term	190	=item on_refresh_begin $term
101		191
102	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
103	or similar effects by modify terminal contents in refresh_begin, and	193	or similar effects by modify terminal contents in refresh_begin, and
…		…
106		196
107	=item on_refresh_end $term	197	=item on_refresh_end $term
108		198
109	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>.
110		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
111	=back	218	=back
112		219
113	=head2 Functions in the C<urxvt> Package	220	=head2 Functions in the C<urxvt> Package
114		221
115	=over 4	222	=over 4
…		…
120	costs! The only time this is acceptable is when the terminal process	227	costs! The only time this is acceptable is when the terminal process
121	starts up.	228	starts up.
122		229
123	=item urxvt::warn $string	230	=item urxvt::warn $string
124		231
125	Calls C<rxvt_warn> witht eh given string which should not include a	232	Calls C<rxvt_warn> with the given string which should not include a
126	newline. The module also overwrites the C<warn> builtin with a function	233	newline. The module also overwrites the C<warn> builtin with a function
127	that calls this function.	234	that calls this function.
128		235
129	Using this function has the advantage that its output ends up in the	236	Using this function has the advantage that its output ends up in the
130	correct place, e.g. on stderr of the connecting urxvtc client.	237	correct place, e.g. on stderr of the connecting urxvtc client.
131		238
132	=item $cellwidth = urxvt::wcswidth $string
133
134	Returns the number of screen-cells this string would need. Correctly
135	accounts for wide and combining characters.
136
137	=item $time = urxvt::NOW	239	=item $time = urxvt::NOW
138		240
139	Returns the "current time" (as per the event loop).	241	Returns the "current time" (as per the event loop).
140		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
141	=cut	297	=cut
142		298
143	package urxvt;	299	package urxvt;
144		300
145	use strict;	301	use strict;
		302	use Scalar::Util ();
146		303
147	our $term;	304	our $TERM;
148	our @HOOKNAME;	305	our @HOOKNAME;
149	our $LIBDIR;	306	our $LIBDIR;
150		307
151	BEGIN {	308	BEGIN {
152	urxvt->bootstrap;	309	urxvt->bootstrap;
…		…
158	unless $msg =~ /\n$/;	315	unless $msg =~ /\n$/;
159	urxvt::warn ($msg);	316	urxvt::warn ($msg);
160	};	317	};
161	}	318	}
162		319
		320	my @hook_count;
163	my $verbosity = $ENV{URXVT_PERL_VERBOSITY} \|\| 10;	321	my $verbosity = $ENV{URXVT_PERL_VERBOSITY};
164		322
165	sub verbose {	323	sub verbose {
166	my ($level, $msg) = @_;	324	my ($level, $msg) = @_;
167	warn "$msg\n"; #d#	325	warn "$msg\n" if $level <= $verbosity;
168	}
169
170	my @invoke_cb;
171
172	# called by the rxvt core
173	sub invoke {
174	local $term = shift;
175	my $htype = shift;
176
177	my $cb = $invoke_cb[$htype];
178
179	verbose 10, "$HOOKNAME[$htype] (" . (join ", ", $term, @_) . ")"
180	if $verbosity >= 10;
181
182	while (my ($k, $v) = each %$cb) {
183	return 1 if $v->($term, @_);
184	}
185
186	0
187	}	326	}
188		327
189	# find on_xxx subs in the package and register them	328	# find on_xxx subs in the package and register them
190	# as hooks	329	# as hooks
191	sub register_package($) {	330	sub register_package($) {
192	my ($pkg) = @_;	331	my ($pkg) = @_;
193		332
194	for my $hook (0.. $#HOOKNAME) {	333	for my $htype (0.. $#HOOKNAME) {
195	my $name = $HOOKNAME[$hook];	334	my $name = $HOOKNAME[$htype];
196		335
197	my $ref = $pkg->can ("on_" . lc $name)	336	my $ref = $pkg->can ("on_" . lc $name)
198	or next;	337	or next;
199		338
200	$invoke_cb[$hook]{$ref*1} = $ref;	339	$TERM->{_hook}[$htype]{$pkg} = $ref;
		340	$hook_count[$htype]++
201	set_should_invoke $hook, 1;	341	or set_should_invoke $htype, 1;
202	}	342	}
203	}	343	}
204		344
205	my $script_pkg = "script0000";	345	my $script_pkg = "script0000";
206	my %script_pkg;	346	my %script_pkg;
207		347
208	# load a single script into its own package, once only	348	# load a single script into its own package, once only
209	sub load_script($) {	349	sub script_package($) {
210	my ($path) = @_;	350	my ($path) = @_;
211		351
212	$script_pkg{$path} \|\|= do {	352	$script_pkg{$path} \|\|= do {
213	my $pkg = $script_pkg++;	353	my $pkg = "urxvt::" . ($script_pkg++);
		354
214	verbose 3, "loading script '$path' into package '$pkg'";	355	verbose 3, "loading script '$path' into package '$pkg'";
215		356
216	open my $fh, "<:raw", $path	357	open my $fh, "<:raw", $path
217	or die "$path: $!";	358	or die "$path: $!";
218		359
219	eval "package $pkg; use strict; use utf8;\n"	360	my $source = "package $pkg; use strict; use utf8;\n"
220	. "#line 1 \"$path\"\n"	361	. "#line 1 \"$path\"\n{\n"
221	. do { local $/; <$fh> }	362	. (do { local $/; <$fh> })
		363	. "\n};\n1";
		364
222	or die "$path: $@";	365	eval $source or die "$path: $@";
223
224	register_package $pkg;
225		366
226	$pkg	367	$pkg
227	};	368	}
228	}	369	}
229		370
230	load_script $_ for grep -f $_, <$LIBDIR/perl-ext/*>;	371	# called by the rxvt core
		372	sub invoke {
		373	local $TERM = shift;
		374	my $htype = shift;
231		375
232	=back	376	if ($htype == 0) { # INIT
		377	my @dirs = ((split /:/, $TERM->resource ("perl_lib")), "$LIBDIR/perl");
		378
		379	for my $ext (map { split /:/, $TERM->resource ("perl_ext_$_") } 1, 2) {
		380	my @files = grep -f $_, map "$_/$ext", @dirs;
		381
		382	if (@files) {
		383	register_package script_package $files[0];
		384	} else {
		385	warn "perl extension '$ext' not found in perl library search path\n";
		386	}
		387	}
		388
		389	} elsif ($htype == 1) { # DESTROY
		390	if (my $hook = $TERM->{_hook}) {
		391	for my $htype (0..$#$hook) {
		392	$hook_count[$htype] -= scalar keys %{ $hook->[$htype] \|\| {} }
		393	or set_should_invoke $htype, 0;
		394	}
		395	}
		396	}
		397
		398	my $cb = $TERM->{_hook}[$htype]
		399	or return;
		400
		401	verbose 10, "$HOOKNAME[$htype] (" . (join ", ", $TERM, @_) . ")"
		402	if $verbosity >= 10;
		403
		404	keys %$cb;
		405
		406	while (my ($pkg, $cb) = each %$cb) {
		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	);
		416	}
		417
		418	0
		419	}
		420
		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	}
233		435
234	=head2 The C<urxvt::term> Class	436	=head2 The C<urxvt::term> Class
235		437
236	=over 4	438	=over 4
237		439
…		…
258		460
259	answerbackstring backgroundPixmap backspace_key boldFont boldItalicFont	461	answerbackstring backgroundPixmap backspace_key boldFont boldItalicFont
260	borderLess color cursorBlink cursorUnderline cutchars delete_key	462	borderLess color cursorBlink cursorUnderline cutchars delete_key
261	display_name embed ext_bwidth fade font geometry hold iconName	463	display_name embed ext_bwidth fade font geometry hold iconName
262	imFont imLocale inputMethod insecure int_bwidth intensityStyles	464	imFont imLocale inputMethod insecure int_bwidth intensityStyles
263	italicFont jumpScroll lineSpace loginShell mapAlert menu meta8	465	italicFont jumpScroll lineSpace loginShell mapAlert menu meta8 modifier
264	modifier mouseWheelScrollPage name pastableTabs path pointerBlank	466	mouseWheelScrollPage name pastableTabs path perl_eval perl_ext_1 perl_ext_2
265	pointerBlankDelay preeditType print_pipe pty_fd reverseVideo saveLines	467	perl_lib pointerBlank pointerBlankDelay preeditType print_pipe pty_fd
266	scrollBar scrollBar_align scrollBar_floating scrollBar_right	468	reverseVideo saveLines scrollBar scrollBar_align scrollBar_floating
267	scrollBar_thickness scrollTtyKeypress scrollTtyOutput scrollWithBuffer	469	scrollBar_right scrollBar_thickness scrollTtyKeypress scrollTtyOutput
268	scrollstyle secondaryScreen secondaryScroll selectstyle shade term_name	470	scrollWithBuffer scrollstyle secondaryScreen secondaryScroll selectstyle
269	title transparent transparent_all tripleclickwords utmpInhibit	471	shade term_name title transparent transparent_all tripleclickwords
270	visualBell	472	utmpInhibit visualBell
271		473
272	=cut	474	=cut
273		475
274	sub urxvt::term::resource($$;$) {	476	sub urxvt::term::resource($$;$) {
275	my ($self, $name) = (shift, shift);	477	my ($self, $name) = (shift, shift);
…		…
293		495
294	=item $oldtext = $term->selection ([$newtext])	496	=item $oldtext = $term->selection ([$newtext])
295		497
296	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>.
297		499
298	=item $term->scr_overlay ($x, $y, $text)	500	#=item $term->overlay ($x, $y, $text)
299		501	#
300	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.
301		503	#
302	=cut	504	#=cut
303		505
304	sub urxvt::term::scr_overlay {	506	sub urxvt::term::scr_overlay {
		507	die;
305	my ($self, $x, $y, $text) = @_;	508	my ($self, $x, $y, $text) = @_;
306		509
307	my @lines = split /\n/, $text;	510	my @lines = split /\n/, $text;
308		511
309	my $w = 0;	512	my $w = 0;
310	for (map urxvt::wcswidth $_, @lines) {	513	for (map $self->strwidth ($_), @lines) {
311	$w = $_ if $w < $_;	514	$w = $_ if $w < $_;
312	}	515	}
313		516
314	$self->scr_overlay_new ($x, $y, $w, scalar @lines);	517	$self->scr_overlay_new ($x, $y, $w, scalar @lines);
315	$self->scr_overlay_set (0, $_, $lines[$_]) for 0.. $#lines;	518	$self->scr_overlay_set (0, $_, $lines[$_]) for 0.. $#lines;
316	}	519	}
317		520
318	=item $term->scr_overlay_new ($x, $y, $width, $height)	521	=item $term->overlay ($x, $y, $width, $height[, $rstyle[, $border]])
319		522
320	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
321	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
322	C<$y> is negative, then this is counted from the right/bottom side,	525	(default: C<OVERLAY_RSTYLE>).
323	respectively.
324		526
325	=item $term->scr_overlay_off	527	If C<$border> is C<2> (default), then a decorative border will be put
		528	around the box.
326		529
327	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.
328		532
329	=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.
330		535
331	Put a single character (specified numerically) at the given overlay	536	The methods currently supported on C<urxvt::overlay> objects are:
332	position.
333		537
		538	=over 4
		539
334	=item $term->scr_overlay_set ($x, $y, $text)	540	=item $overlay->set ($x, $y, $text, $rend)
335		541
336	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
		555
		556	=item $cellwidth = $term->strwidth $string
		557
		558	Returns the number of screen-cells this string would need. Correctly
		559	accounts for wide and combining characters.
		560
		561	=item $octets = $term->locale_encode $string
		562
		563	Convert the given text string into the corresponding locale encoding.
		564
		565	=item $string = $term->locale_decode $octets
		566
		567	Convert the given locale-encoded octets into a perl string.
		568
		569	=item $term->tt_write ($octets)
		570
		571	Write the octets given in C<$data> to the tty (i.e. as program input). To
		572	pass characters instead of octets, you should convert your strings first
		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.
337		755
338	=back	756	=back
339		757
340	=head2 The C<urxvt::timer> Class	758	=head2 The C<urxvt::timer> Class
341		759
342	This class implements timer watchers/events. Time is represented as a	760	This class implements timer watchers/events. Time is represented as a
343	fractional number of seconds since the epoch. Example:	761	fractional number of seconds since the epoch. Example:
344		762
345	# create a digital clock display in upper right corner	763	$term->{overlay} = $term->overlay (-1, 0, 8, 1, urxvt::OVERLAY_RSTYLE, 0);
346	$term->{timer} = urxvt::timer	764	$term->{timer} = urxvt::timer
347	->new	765	->new
348	->start (urxvt::NOW)	766	->interval (1)
349	->cb (sub {	767	->cb (sub {
350	my ($timer) = @_;
351	my $time = $timer->at;
352	$timer->start ($time + 1);
353	$self->scr_overlay (-1, 0,	768	$term->{overlay}->set (0, 0,
354	POSIX::strftime "%H:%M:%S", localtime $time);	769	sprintf "%2d:%02d:%02d", (localtime urxvt::NOW)[2,1,0]);
355	});	770	});
356		771
357	=over 4	772	=over 4
358		773
359	=item $timer = new urxvt::timer	774	=item $timer = new urxvt::timer
360		775
361	Create a new timer object in stopped state.	776	Create a new timer object in started state. It is scheduled to fire
		777	immediately.
362		778
363	=item $timer = $timer->cb (sub { my ($timer) = @_; ... })	779	=item $timer = $timer->cb (sub { my ($timer) = @_; ... })
364		780
365	Set the callback to be called when the timer triggers.	781	Set the callback to be called when the timer triggers.
366		782
…		…
369	Return the time this watcher will fire next.	785	Return the time this watcher will fire next.
370		786
371	=item $timer = $timer->set ($tstamp)	787	=item $timer = $timer->set ($tstamp)
372		788
373	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.
374		796
375	=item $timer = $timer->start	797	=item $timer = $timer->start
376		798
377	Start the timer.	799	Start the timer.
378		800
…		…
441	This variable controls the verbosity level of the perl extension. Higher	863	This variable controls the verbosity level of the perl extension. Higher
442	numbers indicate more verbose output.	864	numbers indicate more verbose output.
443		865
444	=over 4	866	=over 4
445		867
446	=item 0 - only fatal messages	868	=item =0 - only fatal messages
447		869
448	=item 3 - script loading and management	870	=item =3 - script loading and management
449		871
450	=item 10 - all events received	872	=item =10 - all events received
451		873
452	=back	874	=back
453		875
454	=head1 AUTHOR	876	=head1 AUTHOR
455		877

Diff Legend

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

Comparing rxvt-unicode/src/urxvt.pm (file contents): Revision 1.5 by root, Mon Jan 2 17:20:00 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.5 by root, Mon Jan 2 17:20:00 2006 UTC vs.
Revision 1.30 by root, Wed Jan 4 05:35:34 2006 UTC