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

Comparing rxvt-unicode/src/urxvt.pm (file contents):
Revision 1.6 by root, Mon Jan 2 18:20:23 2006 UTC vs.
Revision 1.33 by root, Thu Jan 5 01:04:10 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	=item mark-urls
		72
		73	A not very useful example of filtering all text output to the terminal, by
		74	underlining all urls that matches a certain regex (i.e. some urls :). It
		75	is not very useful because urls that are output in multiple steps (e.g.
		76	when typing them) do not get marked.
		77
		78	=back
31		79
32	=head2 General API Considerations	80	=head2 General API Considerations
33		81
34	All objects (such as terminals, time watchers etc.) are typical	82	All objects (such as terminals, time watchers etc.) are typical
35	reference-to-hash objects. The hash can be used to store anything you	83	reference-to-hash objects. The hash can be used to store anything you
36	like. The only reserved member is C<_ptr>, which must not be changed.	84	like. All members starting with an underscore (such as C<_ptr> or
		85	C<_hook>) are reserved for internal uses and B<MUST NOT> be accessed or
		86	modified).
37		87
38	When objects are destroyed on the C++ side, the perl object hashes are	88	When objects are destroyed on the C++ side, the perl object hashes are
39	emptied, so its best to store related objects such as time watchers and	89	emptied, so its best to store related objects such as time watchers and
40	the like inside the terminal object so they get destroyed as soon as the	90	the like inside the terminal object so they get destroyed as soon as the
41	terminal is destroyed.	91	terminal is destroyed.
42		92
		93	Argument names also often indicate the type of a parameter. Here are some
		94	hints on what they mean:
		95
		96	=over 4
		97
		98	=item $text
		99
		100	Rxvt-unicodes special way of encoding text, where one "unicode" character
		101	always represents one screen cell. See L<row_t> for a discussion of this format.
		102
		103	=item $string
		104
		105	A perl text string, with an emphasis on I<text>. It can store all unicode
		106	characters and is to be distinguished with text encoded in a specific
		107	encoding (often locale-specific) and binary data.
		108
		109	=item $octets
		110
		111	Either binary data or - more common - a text string encoded in a
		112	locale-specific way.
		113
		114	=back
		115
43	=head2 Hooks	116	=head2 Hooks
44		117
45	The following subroutines can be declared in loaded scripts, and will be called	118	The following subroutines can be declared in loaded scripts, and will be
46	whenever the relevant event happens.	119	called whenever the relevant event happens.
		120
		121	The first argument passed to them is an object private to each terminal
		122	and extension package. You can call all C<urxvt::term> methods on it, but
		123	its not a real C<urxvt::term> object. Instead, the real C<urxvt::term>
		124	object that is shared between all packages is stored in the C<term>
		125	member.
47		126
48	All of them must return a boolean value. If it is true, then the event	127	All of them must return a boolean value. If it is true, then the event
49	counts as being I<consumed>, and the invocation of other hooks is skipped,	128	counts as being I<consumed>, and the invocation of other hooks is skipped,
50	and the relevant action might not be carried out by the C++ code.	129	and the relevant action might not be carried out by the C++ code.
51		130
84	requested from the server. The selection text can be queried and changed	163	requested from the server. The selection text can be queried and changed
85	by calling C<< $term->selection >>.	164	by calling C<< $term->selection >>.
86		165
87	Returning a true value aborts selection grabbing. It will still be hilighted.	166	Returning a true value aborts selection grabbing. It will still be hilighted.
88		167
		168	=item on_sel_extend $term
		169
		170	Called whenever the user tries to extend the selection (e.g. with a double
		171	click) and is either supposed to return false (normal operation), or
		172	should extend the selection itelf and return true to suppress the built-in
		173	processing.
		174
		175	See the F<selection> example extension.
		176
89	=item on_focus_in $term	177	=item on_focus_in $term
90		178
91	Called whenever the window gets the keyboard focus, before urxvt does	179	Called whenever the window gets the keyboard focus, before urxvt does
92	focus in processing.	180	focus in processing.
93		181
…		…
113	number of lines that will be in the scrollback buffer.	201	number of lines that will be in the scrollback buffer.
114		202
115	=item on_tty_activity $term NYI	203	=item on_tty_activity $term NYI
116		204
117	Called whenever the program(s) running in the urxvt window send output.	205	Called whenever the program(s) running in the urxvt window send output.
		206
		207	=item on_osc_seq $term, $string
		208
		209	Called whenever the B<ESC ] 777 ; string ST> command sequence (OSC =
		210	operating system command) is processed. Cursor position and other state
		211	information is up-to-date when this happens. For interoperability, the
		212	string should start with the extension name and a colon, to distinguish
		213	it from commands for other extensions, and this might be enforced in the
		214	future.
		215
		216	Be careful not ever to trust (in a security sense) the data you receive,
		217	as its source can not easily be controleld (e-mail content, messages from
		218	other users on the same system etc.).
		219
		220	=item on_add_lines $term, $string
		221
		222	Called whenever text is about to be output, with the text as argument. You
		223	can filter/change and output the text yourself by returning a true value
		224	and calling C<< $term->scr_add_lines >> yourself. Please note that this
		225	might be very slow, however, as your hook is called for B<all> text being
		226	output.
118		227
119	=item on_refresh_begin $term	228	=item on_refresh_begin $term
120		229
121	Called just before the screen gets redrawn. Can be used for overlay	230	Called just before the screen gets redrawn. Can be used for overlay
122	or similar effects by modify terminal contents in refresh_begin, and	231	or similar effects by modify terminal contents in refresh_begin, and
…		…
125		234
126	=item on_refresh_end $term	235	=item on_refresh_end $term
127		236
128	Called just after the screen gets redrawn. See C<on_refresh_begin>.	237	Called just after the screen gets redrawn. See C<on_refresh_begin>.
129		238
		239	=item on_keyboard_command $term, $string
		240
		241	Called whenever the user presses a key combination that has a
		242	C<perl:string> action bound to it (see description of the B<keysym>
		243	resource in the @@RXVT_NAME@@(1) manpage).
		244
		245	=back
		246
		247	=head2 Variables in the C<urxvt> Package
		248
		249	=over 4
		250
		251	=item $urxvt::TERM
		252
		253	The current terminal. Whenever a callback/Hook is bein executed, this
		254	variable stores the current C<urxvt::term> object.
		255
130	=back	256	=back
131		257
132	=head2 Functions in the C<urxvt> Package	258	=head2 Functions in the C<urxvt> Package
133		259
134	=over 4	260	=over 4
…		…
150		276
151	=item $time = urxvt::NOW	277	=item $time = urxvt::NOW
152		278
153	Returns the "current time" (as per the event loop).	279	Returns the "current time" (as per the event loop).
154		280
		281	=back
		282
		283	=head2 RENDITION
		284
		285	Rendition bitsets contain information about colour, font, font styles and
		286	similar information for each screen cell.
		287
		288	The following "macros" deal with changes in rendition sets. You should
		289	never just create a bitset, you should always modify an existing one,
		290	as they contain important information required for correct operation of
		291	rxvt-unicode.
		292
		293	=over 4
		294
		295	=item $rend = urxvt::DEFAULT_RSTYLE
		296
		297	Returns the default rendition, as used when the terminal is starting up or
		298	being reset. Useful as a base to start when creating renditions.
		299
		300	=item $rend = urxvt::OVERLAY_RSTYLE
		301
		302	Return the rendition mask used for overlays by default.
		303
		304	=item $rendbit = urxvt::RS_Bold, RS_Italic, RS_Blink, RS_RVid, RS_Uline
		305
		306	Return the bit that enabled bold, italic, blink, reverse-video and
		307	underline, respectively. To enable such a style, just logically OR it into
		308	the bitset.
		309
		310	=item $foreground = urxvt::GET_BASEFG $rend
		311
		312	=item $background = urxvt::GET_BASEBG $rend
		313
		314	Return the foreground/background colour index, respectively.
		315
		316	=item $rend = urxvt::SET_FGCOLOR ($rend, $new_colour)
		317
		318	=item $rend = urxvt::SET_BGCOLOR ($rend, $new_colour)
		319
		320	Replace the foreground/background colour in the rendition mask with the
		321	specified one.
		322
		323	=item $value = urxvt::GET_CUSTOM ($rend)
		324
		325	Return the "custom" value: Every rendition has 5 bits for use by
		326	extensions. They can be set and changed as you like and are initially
		327	zero.
		328
		329	=item $rend = urxvt::SET_CUSTOM ($rend, $new_value)
		330
		331	Change the custom value.
		332
		333	=back
		334
155	=cut	335	=cut
156		336
157	package urxvt;	337	package urxvt;
158		338
159	use strict;	339	use strict;
		340	use Scalar::Util ();
160		341
161	our $term;	342	our $TERM;
162	our @HOOKNAME;	343	our @HOOKNAME;
163	our $LIBDIR;	344	our $LIBDIR;
164		345
165	BEGIN {	346	BEGIN {
166	urxvt->bootstrap;	347	urxvt->bootstrap;
…		…
172	unless $msg =~ /\n$/;	353	unless $msg =~ /\n$/;
173	urxvt::warn ($msg);	354	urxvt::warn ($msg);
174	};	355	};
175	}	356	}
176		357
		358	my @hook_count;
177	my $verbosity = $ENV{URXVT_PERL_VERBOSITY} \|\| 10;	359	my $verbosity = $ENV{URXVT_PERL_VERBOSITY};
178		360
179	sub verbose {	361	sub verbose {
180	my ($level, $msg) = @_;	362	my ($level, $msg) = @_;
181	warn "$msg\n"; #d#	363	warn "$msg\n" if $level <= $verbosity;
182	}
183
184	my @invoke_cb;
185
186	# called by the rxvt core
187	sub invoke {
188	local $term = shift;
189	my $htype = shift;
190
191	my $cb = $invoke_cb[$htype];
192
193	verbose 10, "$HOOKNAME[$htype] (" . (join ", ", $term, @_) . ")"
194	if $verbosity >= 10;
195
196	while (my ($k, $v) = each %$cb) {
197	return 1 if $v->($term, @_);
198	}
199
200	0
201	}	364	}
202		365
203	# find on_xxx subs in the package and register them	366	# find on_xxx subs in the package and register them
204	# as hooks	367	# as hooks
205	sub register_package($) {	368	sub register_package($) {
206	my ($pkg) = @_;	369	my ($pkg) = @_;
207		370
208	for my $hook (0.. $#HOOKNAME) {	371	for my $htype (0.. $#HOOKNAME) {
209	my $name = $HOOKNAME[$hook];	372	my $name = $HOOKNAME[$htype];
210		373
211	my $ref = $pkg->can ("on_" . lc $name)	374	my $ref = $pkg->can ("on_" . lc $name)
212	or next;	375	or next;
213		376
214	$invoke_cb[$hook]{$ref*1} = $ref;	377	$TERM->{_hook}[$htype]{$pkg} = $ref;
		378	$hook_count[$htype]++
215	set_should_invoke $hook, 1;	379	or set_should_invoke $htype, 1;
216	}	380	}
217	}	381	}
218		382
219	my $script_pkg = "script0000";	383	my $script_pkg = "script0000";
220	my %script_pkg;	384	my %script_pkg;
221		385
222	# load a single script into its own package, once only	386	# load a single script into its own package, once only
223	sub load_script($) {	387	sub script_package($) {
224	my ($path) = @_;	388	my ($path) = @_;
225		389
226	$script_pkg{$path} \|\|= do {	390	$script_pkg{$path} \|\|= do {
227	my $pkg = $script_pkg++;	391	my $pkg = "urxvt::" . ($script_pkg++);
		392
228	verbose 3, "loading script '$path' into package '$pkg'";	393	verbose 3, "loading script '$path' into package '$pkg'";
229		394
230	open my $fh, "<:raw", $path	395	open my $fh, "<:raw", $path
231	or die "$path: $!";	396	or die "$path: $!";
232		397
233	eval "package $pkg; use strict; use utf8;\n"	398	my $source = "package $pkg; use strict; use utf8;\n"
234	. "#line 1 \"$path\"\n"	399	. "#line 1 \"$path\"\n{\n"
235	. do { local $/; <$fh> }	400	. (do { local $/; <$fh> })
		401	. "\n};\n1";
		402
236	or die "$path: $@";	403	eval $source or die "$path: $@";
237
238	register_package $pkg;
239		404
240	$pkg	405	$pkg
241	};	406	}
242	}	407	}
243		408
244	sub load_scripts($) {	409	our $retval; # return value for urxvt
245	my ($dir) = @_;
246		410
247	verbose 3, "loading scripts from '$dir'";	411	# called by the rxvt core
		412	sub invoke {
		413	local $TERM = shift;
		414	my $htype = shift;
248		415
249	load_script $_	416	if ($htype == 0) { # INIT
250	for grep -f $_,	417	my @dirs = ((split /:/, $TERM->resource ("perl_lib")), "$LIBDIR/perl");
251	<$dir/perl-ext/*>;
252	}
253		418
254	sub on_init {	419	for my $ext (map { split /:/, $TERM->resource ("perl_ext_$_") } 1, 2) {
255	my ($term) = @_;	420	my @files = grep -f $_, map "$_/$ext", @dirs;
256		421
257	my $libdir = $term->resource ("perl_lib");	422	if (@files) {
		423	register_package script_package $files[0];
		424	} else {
		425	warn "perl extension '$ext' not found in perl library search path\n";
		426	}
		427	}
		428	}
258		429
259	load_scripts $libdir	430	$retval = undef;
260	if defined $libdir;
261	}
262		431
263	register_package __PACKAGE__;	432	if (my $cb = $TERM->{_hook}[$htype]) {
264	load_scripts $LIBDIR;	433	verbose 10, "$HOOKNAME[$htype] (" . (join ", ", $TERM, @_) . ")"
		434	if $verbosity >= 10;
265		435
266	=back	436	keys %$cb;
		437
		438	while (my ($pkg, $cb) = each %$cb) {
		439	$retval = $cb->(
		440	$TERM->{_pkg}{$pkg} \|\|= do {
		441	my $proxy = bless { }, urxvt::term::proxy::;
		442	Scalar::Util::weaken ($proxy->{term} = $TERM);
		443	$proxy
		444	},
		445	@_,
		446	) and last;
		447	}
		448	}
		449
		450	if ($htype == 1) { # DESTROY
		451	# remove hooks if unused
		452	if (my $hook = $TERM->{_hook}) {
		453	for my $htype (0..$#$hook) {
		454	$hook_count[$htype] -= scalar keys %{ $hook->[$htype] \|\| {} }
		455	or set_should_invoke $htype, 0;
		456	}
		457	}
		458
		459	# clear package objects
		460	%$_ = () for values %{ $TERM->{_pkg} };
		461
		462	# clear package
		463	%$TERM = ();
		464	}
		465
		466	$retval
		467	}
		468
		469	sub urxvt::term::proxy::AUTOLOAD {
		470	$urxvt::term::proxy::AUTOLOAD =~ /:([^:]+)$/
		471	or die "FATAL: \$AUTOLOAD '$urxvt::term::proxy::AUTOLOAD' unparsable";
		472
		473	eval qq{
		474	sub $urxvt::term::proxy::AUTOLOAD {
		475	my \$proxy = shift;
		476	\$proxy->{term}->$1 (\@_)
		477	}
		478	1
		479	} or die "FATAL: unable to compile method forwarder: $@";
		480
		481	goto &$urxvt::term::proxy::AUTOLOAD;
		482	}
267		483
268	=head2 The C<urxvt::term> Class	484	=head2 The C<urxvt::term> Class
269		485
270	=over 4	486	=over 4
271		487
…		…
292		508
293	answerbackstring backgroundPixmap backspace_key boldFont boldItalicFont	509	answerbackstring backgroundPixmap backspace_key boldFont boldItalicFont
294	borderLess color cursorBlink cursorUnderline cutchars delete_key	510	borderLess color cursorBlink cursorUnderline cutchars delete_key
295	display_name embed ext_bwidth fade font geometry hold iconName	511	display_name embed ext_bwidth fade font geometry hold iconName
296	imFont imLocale inputMethod insecure int_bwidth intensityStyles	512	imFont imLocale inputMethod insecure int_bwidth intensityStyles
297	italicFont jumpScroll lineSpace loginShell mapAlert menu meta8	513	italicFont jumpScroll lineSpace loginShell mapAlert menu meta8 modifier
298	modifier mouseWheelScrollPage name pastableTabs path perl perl_eval	514	mouseWheelScrollPage name pastableTabs path perl_eval perl_ext_1 perl_ext_2
299	perl_lib pointerBlank pointerBlankDelay preeditType print_pipe pty_fd	515	perl_lib pointerBlank pointerBlankDelay preeditType print_pipe pty_fd
300	reverseVideo saveLines scrollBar scrollBar_align scrollBar_floating	516	reverseVideo saveLines scrollBar scrollBar_align scrollBar_floating
301	scrollBar_right scrollBar_thickness scrollTtyKeypress scrollTtyOutput	517	scrollBar_right scrollBar_thickness scrollTtyKeypress scrollTtyOutput
302	scrollWithBuffer scrollstyle secondaryScreen secondaryScroll selectstyle	518	scrollWithBuffer scrollstyle secondaryScreen secondaryScroll selectstyle
303	shade term_name title transparent transparent_all tripleclickwords	519	shade term_name title transparent transparent_all tripleclickwords
…		…
309	my ($self, $name) = (shift, shift);	525	my ($self, $name) = (shift, shift);
310	unshift @_, $self, $name, ($name =~ s/\s\+\s(\d+)$// ? $1 : 0);	526	unshift @_, $self, $name, ($name =~ s/\s\+\s(\d+)$// ? $1 : 0);
311	goto &urxvt::term::_resource;	527	goto &urxvt::term::_resource;
312	}	528	}
313		529
		530	=item $rend = $term->rstyle ([$new_rstyle])
		531
		532	Return and optionally change the current rendition. Text that is output by
		533	the terminal application will use this style.
		534
		535	=item ($row, $col) = $term->screen_cur ([$row, $col])
		536
		537	Return the current coordinates of the text cursor position and optionally
		538	set it (which is usually bad as applications don't expect that).
		539
314	=item ($row, $col) = $term->selection_mark ([$row, $col])	540	=item ($row, $col) = $term->selection_mark ([$row, $col])
315		541
316	=item ($row, $col) = $term->selection_beg ([$row, $col])	542	=item ($row, $col) = $term->selection_beg ([$row, $col])
317		543
318	=item ($row, $col) = $term->selection_end ([$row, $col])	544	=item ($row, $col) = $term->selection_end ([$row, $col])
…		…
327		553
328	=item $oldtext = $term->selection ([$newtext])	554	=item $oldtext = $term->selection ([$newtext])
329		555
330	Return the current selection text and optionally replace it by C<$newtext>.	556	Return the current selection text and optionally replace it by C<$newtext>.
331		557
332	=item $term->scr_overlay ($x, $y, $text)	558	#=item $term->overlay ($x, $y, $text)
333		559	#
334	Create a simple multi-line overlay box. See the next method for details.	560	#Create a simple multi-line overlay box. See the next method for details.
335		561	#
336	=cut	562	#=cut
337		563	#
338	sub urxvt::term::scr_overlay {	564	#sub urxvt::term::scr_overlay {
339	my ($self, $x, $y, $text) = @_;	565	# my ($self, $x, $y, $text) = @_;
340		566	#
341	my @lines = split /\n/, $text;	567	# my @lines = split /\n/, $text;
342		568	#
343	my $w = 0;	569	# my $w = 0;
344	for (map $self->strwidth ($_), @lines) {	570	# for (map $self->strwidth ($_), @lines) {
345	$w = $_ if $w < $_;	571	# $w = $_ if $w < $_;
346	}	572	# }
347		573	#
348	$self->scr_overlay_new ($x, $y, $w, scalar @lines);	574	# $self->scr_overlay_new ($x, $y, $w, scalar @lines);
349	$self->scr_overlay_set (0, $_, $lines[$_]) for 0.. $#lines;	575	# $self->scr_overlay_set (0, $_, $lines[$_]) for 0.. $#lines;
350	}	576	#}
351		577
352	=item $term->scr_overlay_new ($x, $y, $width, $height)	578	=item $term->overlay ($x, $y, $width, $height[, $rstyle[, $border]])
353		579
354	Create a new (empty) overlay at the given position with the given	580	Create a new (empty) overlay at the given position with the given
355	width/height. A border will be put around the box. If either C<$x> or	581	width/height. C<$rstyle> defines the initial rendition style
356	C<$y> is negative, then this is counted from the right/bottom side,	582	(default: C<OVERLAY_RSTYLE>).
357	respectively.
358		583
359	=item $term->scr_overlay_off	584	If C<$border> is C<2> (default), then a decorative border will be put
		585	around the box.
360		586
361	Switch the overlay off again.	587	If either C<$x> or C<$y> is negative, then this is counted from the
		588	right/bottom side, respectively.
362		589
363	=item $term->scr_overlay_set_char ($x, $y, $char, $rend = OVERLAY_RSTYLE)	590	This method returns an urxvt::overlay object. The overlay will be visible
		591	as long as the perl object is referenced.
364		592
365	Put a single character (specified numerically) at the given overlay	593	The methods currently supported on C<urxvt::overlay> objects are:
366	position.
367		594
		595	=over 4
		596
368	=item $term->scr_overlay_set ($x, $y, $text)	597	=item $overlay->set ($x, $y, $text, $rend)
369		598
370	Write a string at the given position into the overlay.	599	Similar to C<< $term->ROW_t >> and C<< $term->ROW_r >> in that it puts
		600	text in rxvt-unicode's special encoding and an array of rendition values
		601	at a specific position inside the overlay.
		602
		603	=item $overlay->hide
		604
		605	If visible, hide the overlay, but do not destroy it.
		606
		607	=item $overlay->show
		608
		609	If hidden, display the overlay again.
		610
		611	=back
371		612
372	=item $cellwidth = $term->strwidth $string	613	=item $cellwidth = $term->strwidth $string
373		614
374	Returns the number of screen-cells this string would need. Correctly	615	Returns the number of screen-cells this string would need. Correctly
375	accounts for wide and combining characters.	616	accounts for wide and combining characters.
…		…
380		621
381	=item $string = $term->locale_decode $octets	622	=item $string = $term->locale_decode $octets
382		623
383	Convert the given locale-encoded octets into a perl string.	624	Convert the given locale-encoded octets into a perl string.
384		625
		626	=item $term->scr_add_lines ($string)
		627
		628	Write the given text string to the screen, as if output by the application
		629	running inside the terminal. It may not contain command sequences (escape
		630	codes), but is free to use line feeds, carriage returns and tabs. The
		631	string is a normal text string, not in locale-dependent encoding.
		632
		633	Normally its not a good idea to use this function, as programs might be
		634	confused by changes in cursor position or scrolling. Its useful inside a
		635	C<on_add_lines> hook, though.
		636
385	=item $term->tt_write ($octets)	637	=item $term->tt_write ($octets)
386		638
387	Write the octets given in C<$data> to the tty (i.e. as program input). To	639	Write the octets given in C<$data> to the tty (i.e. as program input). To
388	pass characters instead of octets, you should convetr you strings first to	640	pass characters instead of octets, you should convert your strings first
389	the locale-specific encoding using C<< $term->locale_encode >>.	641	to the locale-specific encoding using C<< $term->locale_encode >>.
		642
		643	=item $window_width = $term->width
		644
		645	=item $window_height = $term->height
		646
		647	=item $font_width = $term->fwidth
		648
		649	=item $font_height = $term->fheight
		650
		651	=item $font_ascent = $term->fbase
		652
		653	=item $terminal_rows = $term->nrow
		654
		655	=item $terminal_columns = $term->ncol
		656
		657	=item $has_focus = $term->focus
		658
		659	=item $is_mapped = $term->mapped
		660
		661	=item $max_scrollback = $term->saveLines
		662
		663	=item $nrow_plus_saveLines = $term->total_rows
		664
		665	=item $lines_in_scrollback = $term->nsaved
		666
		667	Return various integers describing terminal characteristics.
		668
		669	=item $view_start = $term->view_start ([$newvalue])
		670
		671	Returns the negative row number of the topmost line. Minimum value is
		672	C<0>, which displays the normal terminal contents. Larger values scroll
		673	this many lines into the scrollback buffer.
		674
		675	=item $term->want_refresh
		676
		677	Requests a screen refresh. At the next opportunity, rxvt-unicode will
		678	compare the on-screen display with its stored representation. If they
		679	differ, it redraws the differences.
		680
		681	Used after changing terminal contents to display them.
		682
		683	=item $text = $term->ROW_t ($row_number[, $new_text[, $start_col]])
		684
		685	Returns the text of the entire row with number C<$row_number>. Row C<0>
		686	is the topmost terminal line, row C<< $term->$ncol-1 >> is the bottommost
		687	terminal line. The scrollback buffer starts at line C<-1> and extends to
		688	line C<< -$term->nsaved >>. Nothing will be returned if a nonexistent line
		689	is requested.
		690
		691	If C<$new_text> is specified, it will replace characters in the current
		692	line, starting at column C<$start_col> (default C<0>), which is useful
		693	to replace only parts of a line. The font index in the rendition will
		694	automatically be updated.
		695
		696	C<$text> is in a special encoding: tabs and wide characters that use more
		697	than one cell when displayed are padded with urxvt::NOCHAR characters
		698	(C<chr 65535>). Characters with combining characters and other characters
		699	that do not fit into the normal tetx encoding will be replaced with
		700	characters in the private use area.
		701
		702	You have to obey this encoding when changing text. The advantage is
		703	that C<substr> and similar functions work on screen cells and not on
		704	characters.
		705
		706	The methods C<< $term->special_encode >> and C<< $term->special_decode >>
		707	can be used to convert normal strings into this encoding and vice versa.
		708
		709	=item $rend = $term->ROW_r ($row_number[, $new_rend[, $start_col]])
		710
		711	Like C<< $term->ROW_t >>, but returns an arrayref with rendition
		712	bitsets. Rendition bitsets contain information about colour, font, font
		713	styles and similar information. See also C<< $term->ROW_t >>.
		714
		715	When setting rendition, the font mask will be ignored.
		716
		717	See the section on RENDITION, above.
		718
		719	=item $length = $term->ROW_l ($row_number[, $new_length])
		720
		721	Returns the number of screen cells that are in use ("the line
		722	length"). Unlike the urxvt core, this returns C<< $term->ncol >> if the
		723	line is joined with the following one.
		724
		725	=item $bool = $term->is_longer ($row_number)
		726
		727	Returns true if the row is part of a multiple-row logical "line" (i.e.
		728	joined with the following row), which means all characters are in use
		729	and it is continued on the next row (and possibly a continuation of the
		730	previous row(s)).
		731
		732	=item $line = $term->line ($row_number)
		733
		734	Create and return a new C<urxvt::line> object that stores information
		735	about the logical line that row C<$row_number> is part of. It supports the
		736	following methods:
		737
		738	=over 4
		739
		740	=item $text = $line->t
		741
		742	Returns the full text of the line, similar to C<ROW_t>
		743
		744	=item $rend = $line->r
		745
		746	Returns the full rendition array of the line, similar to C<ROW_r>
		747
		748	=item $length = $line->l
		749
		750	Returns the length of the line in cells, similar to C<ROW_l>.
		751
		752	=item $rownum = $line->beg
		753
		754	=item $rownum = $line->end
		755
		756	Return the row number of the first/last row of the line, respectively.
		757
		758	=item $offset = $line->offset_of ($row, $col)
		759
		760	Returns the character offset of the given row\|col pair within the logical
		761	line.
		762
		763	=item ($row, $col) = $line->coord_of ($offset)
		764
		765	Translates a string offset into terminal coordinates again.
		766
		767	=back
		768
		769	=cut
		770
		771	sub urxvt::term::line {
		772	my ($self, $row) = @_;
		773
		774	my $maxrow = $self->nrow - 1;
		775
		776	my ($beg, $end) = ($row, $row);
		777
		778	--$beg while $self->ROW_is_longer ($beg - 1);
		779	++$end while $self->ROW_is_longer ($end) && $end < $maxrow;
		780
		781	bless {
		782	term => $self,
		783	beg => $beg,
		784	end => $end,
		785	len => ($end - $beg) * $self->ncol + $self->ROW_l ($end),
		786	}, urxvt::line::
		787	}
		788
		789	sub urxvt::line::t {
		790	my ($self) = @_;
		791
		792	substr +(join "", map $self->{term}->ROW_t ($_), $self->{beg} .. $self->{end}),
		793	0, $self->{len}
		794	}
		795
		796	sub urxvt::line::r {
		797	my ($self) = @_;
		798
		799	my $rend = [
		800	map @{ $self->{term}->ROW_r ($_) }, $self->{beg} .. $self->{end}
		801	];
		802	$#$rend = $self->{len} - 1;
		803	$rend
		804	}
		805
		806	sub urxvt::line::beg { $_[0]{beg} }
		807	sub urxvt::line::end { $_[0]{end} }
		808	sub urxvt::line::l { $_[0]{len} }
		809
		810	sub urxvt::line::offset_of {
		811	my ($self, $row, $col) = @_;
		812
		813	($row - $self->{beg}) * $self->{term}->ncol + $col
		814	}
		815
		816	sub urxvt::line::coord_of {
		817	my ($self, $offset) = @_;
		818
		819	use integer;
		820
		821	(
		822	$offset / $self->{term}->ncol + $self->{beg},
		823	$offset % $self->{term}->ncol
		824	)
		825	}
		826
		827	=item ($row, $col) = $line->coord_of ($offset)
		828	=item $text = $term->special_encode $string
		829
		830	Converts a perl string into the special encoding used by rxvt-unicode,
		831	where one character corresponds to one screen cell. See
		832	C<< $term->ROW_t >> for details.
		833
		834	=item $string = $term->special_decode $text
		835
		836	Converts rxvt-unicodes text reprsentation into a perl string. See
		837	C<< $term->ROW_t >> for details.
390		838
391	=back	839	=back
392		840
393	=head2 The C<urxvt::timer> Class	841	=head2 The C<urxvt::timer> Class
394		842
395	This class implements timer watchers/events. Time is represented as a	843	This class implements timer watchers/events. Time is represented as a
396	fractional number of seconds since the epoch. Example:	844	fractional number of seconds since the epoch. Example:
397		845
398	# create a digital clock display in upper right corner	846	$term->{overlay} = $term->overlay (-1, 0, 8, 1, urxvt::OVERLAY_RSTYLE, 0);
399	$term->{timer} = urxvt::timer	847	$term->{timer} = urxvt::timer
400	->new	848	->new
401	->start (urxvt::NOW)	849	->interval (1)
402	->cb (sub {	850	->cb (sub {
403	my ($timer) = @_;
404	my $time = $timer->at;
405	$timer->start ($time + 1);
406	$self->scr_overlay (-1, 0,	851	$term->{overlay}->set (0, 0,
407	POSIX::strftime "%H:%M:%S", localtime $time);	852	sprintf "%2d:%02d:%02d", (localtime urxvt::NOW)[2,1,0]);
408	});	853	});
409		854
410	=over 4	855	=over 4
411		856
412	=item $timer = new urxvt::timer	857	=item $timer = new urxvt::timer
413		858
414	Create a new timer object in stopped state.	859	Create a new timer object in started state. It is scheduled to fire
		860	immediately.
415		861
416	=item $timer = $timer->cb (sub { my ($timer) = @_; ... })	862	=item $timer = $timer->cb (sub { my ($timer) = @_; ... })
417		863
418	Set the callback to be called when the timer triggers.	864	Set the callback to be called when the timer triggers.
419		865
…		…
422	Return the time this watcher will fire next.	868	Return the time this watcher will fire next.
423		869
424	=item $timer = $timer->set ($tstamp)	870	=item $timer = $timer->set ($tstamp)
425		871
426	Set the time the event is generated to $tstamp.	872	Set the time the event is generated to $tstamp.
		873
		874	=item $timer = $timer->interval ($interval)
		875
		876	Normally (and when C<$interval> is C<0>), the timer will automatically
		877	stop after it has fired once. If C<$interval> is non-zero, then the timer
		878	is automatically rescheduled at the given intervals.
427		879
428	=item $timer = $timer->start	880	=item $timer = $timer->start
429		881
430	Start the timer.	882	Start the timer.
431		883
…		…
494	This variable controls the verbosity level of the perl extension. Higher	946	This variable controls the verbosity level of the perl extension. Higher
495	numbers indicate more verbose output.	947	numbers indicate more verbose output.
496		948
497	=over 4	949	=over 4
498		950
499	=item 0 - only fatal messages	951	=item =0 - only fatal messages
500		952
501	=item 3 - script loading and management	953	=item =3 - script loading and management
502		954
503	=item 10 - all events received	955	=item =10 - all events received
504		956
505	=back	957	=back
506		958
507	=head1 AUTHOR	959	=head1 AUTHOR
508		960

Diff Legend

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

Comparing rxvt-unicode/src/urxvt.pm (file contents): Revision 1.6 by root, Mon Jan 2 18:20:23 2006 UTC vs. Revision 1.33 by root, Thu Jan 5 01:04:10 2006 UTC

Diff Legend

Comparing rxvt-unicode/src/urxvt.pm (file contents):
Revision 1.6 by root, Mon Jan 2 18:20:23 2006 UTC vs.
Revision 1.33 by root, Thu Jan 5 01:04:10 2006 UTC