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

Comparing rxvt-unicode/src/urxvt.pm (file contents):
Revision 1.7 by root, Mon Jan 2 19:05:05 2006 UTC vs.
Revision 1.31 by root, Wed Jan 4 19:39:46 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	* Scripts are evaluated in a 'use strict' and 'use utf8' environment, and
10	thus must be encoded as UTF-8.
11		10
12	sub on_sel_grab {	11	sub on_sel_grab {
13	warn "you selected ", $_[0]->selection;	12	warn "you selected ", $_[0]->selection;
14	()	13	()
15	}	14	}
16		15
17	1	16	# start a @@RXVT_NAME@@ using it:
		17
		18	@@RXVT_NAME@@ --perl-lib $HOME -pe grab_test
18		19
19	=head1 DESCRIPTION	20	=head1 DESCRIPTION
20		21
21	On startup, @@RXVT_NAME@@ will scan F<@@RXVT_LIBDIR@@/urxvt/perl-ext/>	22	Everytime a terminal object gets created, scripts specified via the
22	for files and will load them. Everytime a terminal object gets created,	23	C<perl> resource are loaded and associated with it.
23	the directory specified by the C<perl-lib> resource will be additionally	24
24	scanned.	25	Scripts are compiled in a 'use strict' and 'use utf8' environment, and
		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 for all terminals.	29	scripts will be shared (but not enabled) for all terminals.
28		30
29	Hooks in scripts specified by C<perl-lib> will only be called for the	31	=head2 Prepackaged Extensions
30	terminals created with that specific option value.	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
31		72
32	=head2 General API Considerations	73	=head2 General API Considerations
33		74
34	All objects (such as terminals, time watchers etc.) are typical	75	All objects (such as terminals, time watchers etc.) are typical
35	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
36	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
37	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
38	modified).	79	modified).
39		80
40	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
41	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
42	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
43	terminal is destroyed.	84	terminal is destroyed.
44		85
45	=head2 Hooks	86	=head2 Hooks
46		87
47	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
48	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.
49		96
50	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
51	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,
52	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.
53		100
86	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
87	by calling C<< $term->selection >>.	134	by calling C<< $term->selection >>.
88		135
89	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.
90		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
91	=item on_focus_in $term	147	=item on_focus_in $term
92		148
93	Called whenever the window gets the keyboard focus, before urxvt does	149	Called whenever the window gets the keyboard focus, before urxvt does
94	focus in processing.	150	focus in processing.
95		151
…		…
115	number of lines that will be in the scrollback buffer.	171	number of lines that will be in the scrollback buffer.
116		172
117	=item on_tty_activity $term NYI	173	=item on_tty_activity $term NYI
118		174
119	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.).
120		189
121	=item on_refresh_begin $term	190	=item on_refresh_begin $term
122		191
123	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
124	or similar effects by modify terminal contents in refresh_begin, and	193	or similar effects by modify terminal contents in refresh_begin, and
…		…
127		196
128	=item on_refresh_end $term	197	=item on_refresh_end $term
129		198
130	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>.
131		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
132	=back	218	=back
133		219
134	=head2 Functions in the C<urxvt> Package	220	=head2 Functions in the C<urxvt> Package
135		221
136	=over 4	222	=over 4
…		…
152		238
153	=item $time = urxvt::NOW	239	=item $time = urxvt::NOW
154		240
155	Returns the "current time" (as per the event loop).	241	Returns the "current time" (as per the event loop).
156		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
157	=cut	297	=cut
158		298
159	package urxvt;	299	package urxvt;
160		300
161	use strict;	301	use strict;
		302	use Scalar::Util ();
162		303
163	our $term;	304	our $TERM;
164	our @HOOKNAME;	305	our @HOOKNAME;
165	our $LIBDIR;	306	our $LIBDIR;
166		307
167	BEGIN {	308	BEGIN {
168	urxvt->bootstrap;	309	urxvt->bootstrap;
…		…
174	unless $msg =~ /\n$/;	315	unless $msg =~ /\n$/;
175	urxvt::warn ($msg);	316	urxvt::warn ($msg);
176	};	317	};
177	}	318	}
178		319
		320	my @hook_count;
179	my $verbosity = $ENV{URXVT_PERL_VERBOSITY};	321	my $verbosity = $ENV{URXVT_PERL_VERBOSITY};
180		322
181	sub verbose {	323	sub verbose {
182	my ($level, $msg) = @_;	324	my ($level, $msg) = @_;
183	warn "$msg\n" if $level < $verbosity;	325	warn "$msg\n" if $level <= $verbosity;
184	}
185
186	my %hook_global;
187	my @hook_count;
188
189	# called by the rxvt core
190	sub invoke {
191	local $term = shift;
192	my $htype = shift;
193
194	verbose 10, "$HOOKNAME[$htype] (" . (join ", ", $term, @_) . ")"
195	if $verbosity >= 10;
196
197	for my $cb ($hook_global{_hook}[$htype], $term->{_hook}[$htype]) {
198	$cb or next;
199
200	while (my ($k, $v) = each %$cb) {
201	return 1 if $v->($term, @_);
202	}
203	}
204
205	0
206	}	326	}
207		327
208	# find on_xxx subs in the package and register them	328	# find on_xxx subs in the package and register them
209	# as hooks	329	# as hooks
210	sub register_package($) {	330	sub register_package($) {
…		…
214	my $name = $HOOKNAME[$htype];	334	my $name = $HOOKNAME[$htype];
215		335
216	my $ref = $pkg->can ("on_" . lc $name)	336	my $ref = $pkg->can ("on_" . lc $name)
217	or next;	337	or next;
218		338
219	$term->{_hook}[$htype]{$ref*1} = $ref;	339	$TERM->{_hook}[$htype]{$pkg} = $ref;
220	$hook_count[$htype]++	340	$hook_count[$htype]++
221	or set_should_invoke $htype, 1;	341	or set_should_invoke $htype, 1;
222	}	342	}
223	}	343	}
224		344
…		…
228	# load a single script into its own package, once only	348	# load a single script into its own package, once only
229	sub script_package($) {	349	sub script_package($) {
230	my ($path) = @_;	350	my ($path) = @_;
231		351
232	$script_pkg{$path} \|\|= do {	352	$script_pkg{$path} \|\|= do {
233	my $pkg = $script_pkg++;	353	my $pkg = "urxvt::" . ($script_pkg++);
		354
234	verbose 3, "loading script '$path' into package '$pkg'";	355	verbose 3, "loading script '$path' into package '$pkg'";
235		356
236	open my $fh, "<:raw", $path	357	open my $fh, "<:raw", $path
237	or die "$path: $!";	358	or die "$path: $!";
238		359
239	eval "package $pkg; use strict; use utf8;\n"	360	my $source = "package $pkg; use strict; use utf8;\n"
240	. "#line 1 \"$path\"\n"	361	. "#line 1 \"$path\"\n{\n"
241	. do { local $/; <$fh> }	362	. (do { local $/; <$fh> })
		363	. "\n};\n1";
		364
242	or die "$path: $@";	365	eval $source or die "$path: $@";
243		366
244	$pkg	367	$pkg
245	}	368	}
246	}	369	}
247		370
248	sub load_scripts($) {	371	our $retval; # return value for urxvt
249	my ($dir) = @_;
250		372
251	verbose 3, "loading scripts from '$dir'";	373	# called by the rxvt core
		374	sub invoke {
		375	local $TERM = shift;
		376	my $htype = shift;
252		377
		378	if ($htype == 0) { # INIT
		379	my @dirs = ((split /:/, $TERM->resource ("perl_lib")), "$LIBDIR/perl");
		380
		381	for my $ext (map { split /:/, $TERM->resource ("perl_ext_$_") } 1, 2) {
		382	my @files = grep -f $_, map "$_/$ext", @dirs;
		383
		384	if (@files) {
253	register_package script_package $_	385	register_package script_package $files[0];
254	for grep -f $_,	386	} else {
255	<$dir/*>;	387	warn "perl extension '$ext' not found in perl library search path\n";
256	}	388	}
257		389	}
258	sub on_init {
259	my ($term) = @_;
260
261	my $libdir = $term->resource ("perl_lib");
262
263	load_scripts $libdir
264	if defined $libdir;
265	}
266
267	sub on_destroy {
268	my ($term) = @_;
269
270	my $hook = $term->{_hook}
271	or return;
272
273	for my $htype (0..$#$hook) {
274	$hook_count[$htype] -= scalar keys %{ $hook->[$htype] \|\| {} }
275	or set_should_invoke $htype, 0;
276	}	390	}
277	}
278		391
279	{	392	$retval = undef;
280	local $term = \%hook_global;
281		393
282	register_package __PACKAGE__;	394	if (my $cb = $TERM->{_hook}[$htype]) {
283	load_scripts "$LIBDIR/perl-ext";	395	verbose 10, "$HOOKNAME[$htype] (" . (join ", ", $TERM, @_) . ")"
284	}	396	if $verbosity >= 10;
285		397
286	=back	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
		412	if ($htype == 1) { # DESTROY
		413	# remove hooks if unused
		414	if (my $hook = $TERM->{_hook}) {
		415	for my $htype (0..$#$hook) {
		416	$hook_count[$htype] -= scalar keys %{ $hook->[$htype] \|\| {} }
		417	or set_should_invoke $htype, 0;
		418	}
		419	}
		420
		421	# clear package objects
		422	%$_ = () for values %{ $TERM->{_pkg} };
		423
		424	# clear package
		425	%$TERM = ();
		426	}
		427
		428	$retval
		429	}
		430
		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	}
287		445
288	=head2 The C<urxvt::term> Class	446	=head2 The C<urxvt::term> Class
289		447
290	=over 4	448	=over 4
291		449
…		…
312		470
313	answerbackstring backgroundPixmap backspace_key boldFont boldItalicFont	471	answerbackstring backgroundPixmap backspace_key boldFont boldItalicFont
314	borderLess color cursorBlink cursorUnderline cutchars delete_key	472	borderLess color cursorBlink cursorUnderline cutchars delete_key
315	display_name embed ext_bwidth fade font geometry hold iconName	473	display_name embed ext_bwidth fade font geometry hold iconName
316	imFont imLocale inputMethod insecure int_bwidth intensityStyles	474	imFont imLocale inputMethod insecure int_bwidth intensityStyles
317	italicFont jumpScroll lineSpace loginShell mapAlert menu meta8	475	italicFont jumpScroll lineSpace loginShell mapAlert menu meta8 modifier
318	modifier mouseWheelScrollPage name pastableTabs path perl perl_eval	476	mouseWheelScrollPage name pastableTabs path perl_eval perl_ext_1 perl_ext_2
319	perl_lib pointerBlank pointerBlankDelay preeditType print_pipe pty_fd	477	perl_lib pointerBlank pointerBlankDelay preeditType print_pipe pty_fd
320	reverseVideo saveLines scrollBar scrollBar_align scrollBar_floating	478	reverseVideo saveLines scrollBar scrollBar_align scrollBar_floating
321	scrollBar_right scrollBar_thickness scrollTtyKeypress scrollTtyOutput	479	scrollBar_right scrollBar_thickness scrollTtyKeypress scrollTtyOutput
322	scrollWithBuffer scrollstyle secondaryScreen secondaryScroll selectstyle	480	scrollWithBuffer scrollstyle secondaryScreen secondaryScroll selectstyle
323	shade term_name title transparent transparent_all tripleclickwords	481	shade term_name title transparent transparent_all tripleclickwords
…		…
347		505
348	=item $oldtext = $term->selection ([$newtext])	506	=item $oldtext = $term->selection ([$newtext])
349		507
350	Return the current selection text and optionally replace it by C<$newtext>.	508	Return the current selection text and optionally replace it by C<$newtext>.
351		509
352	=item $term->scr_overlay ($x, $y, $text)	510	#=item $term->overlay ($x, $y, $text)
353		511	#
354	Create a simple multi-line overlay box. See the next method for details.	512	#Create a simple multi-line overlay box. See the next method for details.
355		513	#
356	=cut	514	#=cut
357		515
358	sub urxvt::term::scr_overlay {	516	sub urxvt::term::scr_overlay {
		517	die;
359	my ($self, $x, $y, $text) = @_;	518	my ($self, $x, $y, $text) = @_;
360		519
361	my @lines = split /\n/, $text;	520	my @lines = split /\n/, $text;
362		521
363	my $w = 0;	522	my $w = 0;
…		…
367		526
368	$self->scr_overlay_new ($x, $y, $w, scalar @lines);	527	$self->scr_overlay_new ($x, $y, $w, scalar @lines);
369	$self->scr_overlay_set (0, $_, $lines[$_]) for 0.. $#lines;	528	$self->scr_overlay_set (0, $_, $lines[$_]) for 0.. $#lines;
370	}	529	}
371		530
372	=item $term->scr_overlay_new ($x, $y, $width, $height)	531	=item $term->overlay ($x, $y, $width, $height[, $rstyle[, $border]])
373		532
374	Create a new (empty) overlay at the given position with the given	533	Create a new (empty) overlay at the given position with the given
375	width/height. A border will be put around the box. If either C<$x> or	534	width/height. C<$rstyle> defines the initial rendition style
376	C<$y> is negative, then this is counted from the right/bottom side,	535	(default: C<OVERLAY_RSTYLE>).
377	respectively.
378		536
379	=item $term->scr_overlay_off	537	If C<$border> is C<2> (default), then a decorative border will be put
		538	around the box.
380		539
381	Switch the overlay off again.	540	If either C<$x> or C<$y> is negative, then this is counted from the
		541	right/bottom side, respectively.
382		542
383	=item $term->scr_overlay_set_char ($x, $y, $char, $rend = OVERLAY_RSTYLE)	543	This method returns an urxvt::overlay object. The overlay will be visible
		544	as long as the perl object is referenced.
384		545
385	Put a single character (specified numerically) at the given overlay	546	The methods currently supported on C<urxvt::overlay> objects are:
386	position.
387		547
		548	=over 4
		549
388	=item $term->scr_overlay_set ($x, $y, $text)	550	=item $overlay->set ($x, $y, $text, $rend)
389		551
390	Write a string at the given position into the overlay.	552	Similar to C<< $term->ROW_t >> and C<< $term->ROW_r >> in that it puts
		553	text in rxvt-unicode's special encoding and an array of rendition values
		554	at a specific position inside the overlay.
		555
		556	=item $overlay->hide
		557
		558	If visible, hide the overlay, but do not destroy it.
		559
		560	=item $overlay->show
		561
		562	If hidden, display the overlay again.
		563
		564	=back
391		565
392	=item $cellwidth = $term->strwidth $string	566	=item $cellwidth = $term->strwidth $string
393		567
394	Returns the number of screen-cells this string would need. Correctly	568	Returns the number of screen-cells this string would need. Correctly
395	accounts for wide and combining characters.	569	accounts for wide and combining characters.
…		…
403	Convert the given locale-encoded octets into a perl string.	577	Convert the given locale-encoded octets into a perl string.
404		578
405	=item $term->tt_write ($octets)	579	=item $term->tt_write ($octets)
406		580
407	Write the octets given in C<$data> to the tty (i.e. as program input). To	581	Write the octets given in C<$data> to the tty (i.e. as program input). To
408	pass characters instead of octets, you should convetr you strings first to	582	pass characters instead of octets, you should convert your strings first
409	the locale-specific encoding using C<< $term->locale_encode >>.	583	to the locale-specific encoding using C<< $term->locale_encode >>.
		584
		585	=item $nrow = $term->nrow
		586
		587	=item $ncol = $term->ncol
		588
		589	Return the number of rows/columns of the terminal window (i.e. as
		590	specified by C<-geometry>, excluding any scrollback).
		591
		592	=item $nsaved = $term->nsaved
		593
		594	Returns the number of lines in the scrollback buffer.
		595
		596	=item $view_start = $term->view_start ([$newvalue])
		597
		598	Returns the negative row number of the topmost line. Minimum value is
		599	C<0>, which displays the normal terminal contents. Larger values scroll
		600	this many lines into the scrollback buffer.
		601
		602	=item $term->want_refresh
		603
		604	Requests a screen refresh. At the next opportunity, rxvt-unicode will
		605	compare the on-screen display with its stored representation. If they
		606	differ, it redraws the differences.
		607
		608	Used after changing terminal contents to display them.
		609
		610	=item $text = $term->ROW_t ($row_number[, $new_text[, $start_col]])
		611
		612	Returns the text of the entire row with number C<$row_number>. Row C<0>
		613	is the topmost terminal line, row C<< $term->$ncol-1 >> is the bottommost
		614	terminal line. The scrollback buffer starts at line C<-1> and extends to
		615	line C<< -$term->nsaved >>. Nothing will be returned if a nonexistent line
		616	is requested.
		617
		618	If C<$new_text> is specified, it will replace characters in the current
		619	line, starting at column C<$start_col> (default C<0>), which is useful
		620	to replace only parts of a line. The font index in the rendition will
		621	automatically be updated.
		622
		623	C<$text> is in a special encoding: tabs and wide characters that use more
		624	than one cell when displayed are padded with urxvt::NOCHAR characters
		625	(C<chr 65535>). Characters with combining characters and other characters
		626	that do not fit into the normal tetx encoding will be replaced with
		627	characters in the private use area.
		628
		629	You have to obey this encoding when changing text. The advantage is
		630	that C<substr> and similar functions work on screen cells and not on
		631	characters.
		632
		633	The methods C<< $term->special_encode >> and C<< $term->special_decode >>
		634	can be used to convert normal strings into this encoding and vice versa.
		635
		636	=item $rend = $term->ROW_r ($row_number[, $new_rend[, $start_col]])
		637
		638	Like C<< $term->ROW_t >>, but returns an arrayref with rendition
		639	bitsets. Rendition bitsets contain information about colour, font, font
		640	styles and similar information. See also C<< $term->ROW_t >>.
		641
		642	When setting rendition, the font mask will be ignored.
		643
		644	See the section on RENDITION, above.
		645
		646	=item $length = $term->ROW_l ($row_number[, $new_length])
		647
		648	Returns the number of screen cells that are in use ("the line
		649	length"). Unlike the urxvt core, this returns C<< $term->ncol >> if the
		650	line is joined with the following one.
		651
		652	=item $bool = $term->is_longer ($row_number)
		653
		654	Returns true if the row is part of a multiple-row logical "line" (i.e.
		655	joined with the following row), which means all characters are in use
		656	and it is continued on the next row (and possibly a continuation of the
		657	previous row(s)).
		658
		659	=item $line = $term->line ($row_number)
		660
		661	Create and return a new C<urxvt::line> object that stores information
		662	about the logical line that row C<$row_number> is part of. It supports the
		663	following methods:
		664
		665	=over 4
		666
		667	=item $text = $line->t
		668
		669	Returns the full text of the line, similar to C<ROW_t>
		670
		671	=item $rend = $line->r
		672
		673	Returns the full rendition array of the line, similar to C<ROW_r>
		674
		675	=item $length = $line->l
		676
		677	Returns the length of the line in cells, similar to C<ROW_l>.
		678
		679	=item $rownum = $line->beg
		680
		681	=item $rownum = $line->end
		682
		683	Return the row number of the first/last row of the line, respectively.
		684
		685	=item $offset = $line->offset_of ($row, $col)
		686
		687	Returns the character offset of the given row\|col pair within the logical
		688	line.
		689
		690	=item ($row, $col) = $line->coord_of ($offset)
		691
		692	Translates a string offset into terminal coordinates again.
		693
		694	=back
		695
		696	=cut
		697
		698	sub urxvt::term::line {
		699	my ($self, $row) = @_;
		700
		701	my $maxrow = $self->nrow - 1;
		702
		703	my ($beg, $end) = ($row, $row);
		704
		705	--$beg while $self->ROW_is_longer ($beg - 1);
		706	++$end while $self->ROW_is_longer ($end) && $end < $maxrow;
		707
		708	bless {
		709	term => $self,
		710	beg => $beg,
		711	end => $end,
		712	len => ($end - $beg) * $self->ncol + $self->ROW_l ($end),
		713	}, urxvt::line::
		714	}
		715
		716	sub urxvt::line::t {
		717	my ($self) = @_;
		718
		719	substr +(join "", map $self->{term}->ROW_t ($_), $self->{beg} .. $self->{end}),
		720	0, $self->{len}
		721	}
		722
		723	sub urxvt::line::r {
		724	my ($self) = @_;
		725
		726	my $rend = [
		727	map @{ $self->{term}->ROW_r ($_) }, $self->{beg} .. $self->{end}
		728	];
		729	$#$rend = $self->{len} - 1;
		730	$rend
		731	}
		732
		733	sub urxvt::line::beg { $_[0]{beg} }
		734	sub urxvt::line::end { $_[0]{end} }
		735	sub urxvt::line::l { $_[0]{len} }
		736
		737	sub urxvt::line::offset_of {
		738	my ($self, $row, $col) = @_;
		739
		740	($row - $self->{beg}) * $self->{term}->ncol + $col
		741	}
		742
		743	sub urxvt::line::coord_of {
		744	my ($self, $offset) = @_;
		745
		746	use integer;
		747
		748	(
		749	$offset / $self->{term}->ncol + $self->{beg},
		750	$offset % $self->{term}->ncol
		751	)
		752	}
		753
		754	=item ($row, $col) = $line->coord_of ($offset)
		755	=item $text = $term->special_encode $string
		756
		757	Converts a perl string into the special encoding used by rxvt-unicode,
		758	where one character corresponds to one screen cell. See
		759	C<< $term->ROW_t >> for details.
		760
		761	=item $string = $term->special_decode $text
		762
		763	Converts rxvt-unicodes text reprsentation into a perl string. See
		764	C<< $term->ROW_t >> for details.
410		765
411	=back	766	=back
412		767
413	=head2 The C<urxvt::timer> Class	768	=head2 The C<urxvt::timer> Class
414		769
415	This class implements timer watchers/events. Time is represented as a	770	This class implements timer watchers/events. Time is represented as a
416	fractional number of seconds since the epoch. Example:	771	fractional number of seconds since the epoch. Example:
417		772
418	# create a digital clock display in upper right corner	773	$term->{overlay} = $term->overlay (-1, 0, 8, 1, urxvt::OVERLAY_RSTYLE, 0);
419	$term->{timer} = urxvt::timer	774	$term->{timer} = urxvt::timer
420	->new	775	->new
421	->start (urxvt::NOW)	776	->interval (1)
422	->cb (sub {	777	->cb (sub {
423	my ($timer) = @_;
424	my $time = $timer->at;
425	$timer->start ($time + 1);
426	$self->scr_overlay (-1, 0,	778	$term->{overlay}->set (0, 0,
427	POSIX::strftime "%H:%M:%S", localtime $time);	779	sprintf "%2d:%02d:%02d", (localtime urxvt::NOW)[2,1,0]);
428	});	780	});
429		781
430	=over 4	782	=over 4
431		783
432	=item $timer = new urxvt::timer	784	=item $timer = new urxvt::timer
433		785
434	Create a new timer object in stopped state.	786	Create a new timer object in started state. It is scheduled to fire
		787	immediately.
435		788
436	=item $timer = $timer->cb (sub { my ($timer) = @_; ... })	789	=item $timer = $timer->cb (sub { my ($timer) = @_; ... })
437		790
438	Set the callback to be called when the timer triggers.	791	Set the callback to be called when the timer triggers.
439		792
…		…
442	Return the time this watcher will fire next.	795	Return the time this watcher will fire next.
443		796
444	=item $timer = $timer->set ($tstamp)	797	=item $timer = $timer->set ($tstamp)
445		798
446	Set the time the event is generated to $tstamp.	799	Set the time the event is generated to $tstamp.
		800
		801	=item $timer = $timer->interval ($interval)
		802
		803	Normally (and when C<$interval> is C<0>), the timer will automatically
		804	stop after it has fired once. If C<$interval> is non-zero, then the timer
		805	is automatically rescheduled at the given intervals.
447		806
448	=item $timer = $timer->start	807	=item $timer = $timer->start
449		808
450	Start the timer.	809	Start the timer.
451		810
…		…
514	This variable controls the verbosity level of the perl extension. Higher	873	This variable controls the verbosity level of the perl extension. Higher
515	numbers indicate more verbose output.	874	numbers indicate more verbose output.
516		875
517	=over 4	876	=over 4
518		877
519	=item 0 - only fatal messages	878	=item =0 - only fatal messages
520		879
521	=item 3 - script loading and management	880	=item =3 - script loading and management
522		881
523	=item 10 - all events received	882	=item =10 - all events received
524		883
525	=back	884	=back
526		885
527	=head1 AUTHOR	886	=head1 AUTHOR
528		887

Diff Legend

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

Comparing rxvt-unicode/src/urxvt.pm (file contents): Revision 1.7 by root, Mon Jan 2 19:05:05 2006 UTC vs. Revision 1.31 by root, Wed Jan 4 19:39:46 2006 UTC

Diff Legend

Comparing rxvt-unicode/src/urxvt.pm (file contents):
Revision 1.7 by root, Mon Jan 2 19:05:05 2006 UTC vs.
Revision 1.31 by root, Wed Jan 4 19:39:46 2006 UTC