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

Comparing rxvt-unicode/src/urxvt.pm (file contents):
Revision 1.15 by root, Tue Jan 3 01:39:17 2006 UTC vs.
Revision 1.37 by root, Fri Jan 6 03:40:19 2006 UTC

…		…
		1	=encoding utf8
		2
1	=head1 NAME	3	=head1 NAME
2		4
3	@@RXVT_NAME@@perl - rxvt-unicode's embedded perl interpreter	5	@@RXVT_NAME@@perl - rxvt-unicode's embedded perl interpreter
4		6
5	=head1 SYNOPSIS	7	=head1 SYNOPSIS
22		24
23	Scripts are compiled in a 'use strict' and 'use utf8' environment, and	25	Scripts are compiled in a 'use strict' and 'use utf8' environment, and
24	thus must be encoded as UTF-8.	26	thus must be encoded as UTF-8.
25		27
26	Each script will only ever be loaded once, even in @@RXVT_NAME@@d, where	28	Each script will only ever be loaded once, even in @@RXVT_NAME@@d, where
27	scripts will be shared (But not enabled) for all terminals.	29	scripts will be shared (but not enabled) for all terminals.
28		30
29	=head1 PACKAGED EXTENSIONS	31	=head2 Prepackaged Extensions
30		32
31	This section describes the extensiosn delivered with this version. You can	33	This section describes the extensiosn delivered with this version. You can
32	find them in F<@@RXVT_LIBDIR@@/urxvt/perl/>.	34	find them in F<@@RXVT_LIBDIR@@/urxvt/perl/>.
33		35
34	You can activate them like this:	36	You can activate them like this:
…		…
37		39
38	=over 4	40	=over 4
39		41
40	=item selection	42	=item selection
41		43
42	Miscellaneous selection modifications.	44	Intelligent selection. This extension tries to be more intelligent when
		45	the user extends selections (double-click). Right now, it tries to select
		46	urls and complete shell-quoted arguments, which is very convenient, too,
		47	if your F<ls> supports C<--quoting-style=shell>.
		48
		49	It also offers the following bindable event:
43		50
44	=over 4	51	=over 4
45		52
46	=item rot13	53	=item rot13
47		54
…		…
50	URxvt.keysym.C-M-r: perl:selection:rot13	57	URxvt.keysym.C-M-r: perl:selection:rot13
51		58
52	=back	59	=back
53		60
54	=item digital-clock	61	=item digital-clock
		62
		63	Displays a digital clock using the built-in overlay.
		64
		65	=item mark-urls
		66
		67	Uses per-line filtering (C<on_line_update>) to underline urls.
		68
		69	=item example-refresh-hooks
55		70
56	Displays a very simple digital clock in the upper right corner of the	71	Displays a very simple digital clock in the upper right corner of the
57	window. Illustrates overwriting the refresh callbacks to create your own	72	window. Illustrates overwriting the refresh callbacks to create your own
58	overlays or changes.	73	overlays or changes.
59		74
60	=item simple-overlay-clock	75	=item example-filter-input
61		76
62	Displays a digital clock using the built-in overlay (colorful, useless).	77	A not very useful example of filtering all text output to the terminal, by
		78	underlining all urls that matches a certain regex (i.e. some urls :). It
		79	is not very useful because urls that are output in multiple steps (e.g.
		80	when typing them) do not get marked.
63		81
64	=back	82	=back
65		83
66	=head2 General API Considerations	84	=head2 General API Considerations
67		85
68	All objects (such as terminals, time watchers etc.) are typical	86	All objects (such as terminals, time watchers etc.) are typical
69	reference-to-hash objects. The hash can be used to store anything you	87	reference-to-hash objects. The hash can be used to store anything you
70	like. All members starting with an underscore (such as C<_ptr> or	88	like. All members starting with an underscore (such as C<_ptr> or
71	C<_hook>) are reserved for internal uses and must not be accessed or	89	C<_hook>) are reserved for internal uses and B<MUST NOT> be accessed or
72	modified).	90	modified).
73		91
74	When objects are destroyed on the C++ side, the perl object hashes are	92	When objects are destroyed on the C++ side, the perl object hashes are
75	emptied, so its best to store related objects such as time watchers and	93	emptied, so its best to store related objects such as time watchers and
76	the like inside the terminal object so they get destroyed as soon as the	94	the like inside the terminal object so they get destroyed as soon as the
77	terminal is destroyed.	95	terminal is destroyed.
78		96
		97	Argument names also often indicate the type of a parameter. Here are some
		98	hints on what they mean:
		99
		100	=over 4
		101
		102	=item $text
		103
		104	Rxvt-unicodes special way of encoding text, where one "unicode" character
		105	always represents one screen cell. See L<row_t> for a discussion of this format.
		106
		107	=item $string
		108
		109	A perl text string, with an emphasis on I<text>. It can store all unicode
		110	characters and is to be distinguished with text encoded in a specific
		111	encoding (often locale-specific) and binary data.
		112
		113	=item $octets
		114
		115	Either binary data or - more common - a text string encoded in a
		116	locale-specific way.
		117
		118	=back
		119
79	=head2 Hooks	120	=head2 Hooks
80		121
81	The following subroutines can be declared in loaded scripts, and will be called	122	The following subroutines can be declared in loaded scripts, and will be
82	whenever the relevant event happens.	123	called whenever the relevant event happens.
		124
		125	The first argument passed to them is an object private to each terminal
		126	and extension package. You can call all C<urxvt::term> methods on it, but
		127	its not a real C<urxvt::term> object. Instead, the real C<urxvt::term>
		128	object that is shared between all packages is stored in the C<term>
		129	member.
83		130
84	All of them must return a boolean value. If it is true, then the event	131	All of them must return a boolean value. If it is true, then the event
85	counts as being I<consumed>, and the invocation of other hooks is skipped,	132	counts as being I<consumed>, and the invocation of other hooks is skipped,
86	and the relevant action might not be carried out by the C++ code.	133	and the relevant action might not be carried out by the C++ code.
87		134
…		…
90	=over 4	137	=over 4
91		138
92	=item on_init $term	139	=item on_init $term
93		140
94	Called after a new terminal object has been initialized, but before	141	Called after a new terminal object has been initialized, but before
95	windows are created or the command gets run.	142	windows are created or the command gets run. Most methods are unsafe to
		143	call or deliver senseless data, as terminal size and other characteristics
		144	have not yet been determined. You can safely query and change resources,
		145	though.
96		146
97	=item on_reset $term	147	=item on_reset $term
98		148
99	Called after the screen is "reset" for any reason, such as resizing or	149	Called after the screen is "reset" for any reason, such as resizing or
100	control sequences. Here is where you can react on changes to size-related	150	control sequences. Here is where you can react on changes to size-related
…		…
120	requested from the server. The selection text can be queried and changed	170	requested from the server. The selection text can be queried and changed
121	by calling C<< $term->selection >>.	171	by calling C<< $term->selection >>.
122		172
123	Returning a true value aborts selection grabbing. It will still be hilighted.	173	Returning a true value aborts selection grabbing. It will still be hilighted.
124		174
		175	=item on_sel_extend $term
		176
		177	Called whenever the user tries to extend the selection (e.g. with a double
		178	click) and is either supposed to return false (normal operation), or
		179	should extend the selection itelf and return true to suppress the built-in
		180	processing.
		181
		182	See the F<selection> example extension.
		183
125	=item on_focus_in $term	184	=item on_focus_in $term
126		185
127	Called whenever the window gets the keyboard focus, before urxvt does	186	Called whenever the window gets the keyboard focus, before urxvt does
128	focus in processing.	187	focus in processing.
129		188
…		…
149	number of lines that will be in the scrollback buffer.	208	number of lines that will be in the scrollback buffer.
150		209
151	=item on_tty_activity $term NYI	210	=item on_tty_activity $term NYI
152		211
153	Called whenever the program(s) running in the urxvt window send output.	212	Called whenever the program(s) running in the urxvt window send output.
		213
		214	=item on_osc_seq $term, $string
		215
		216	Called whenever the B<ESC ] 777 ; string ST> command sequence (OSC =
		217	operating system command) is processed. Cursor position and other state
		218	information is up-to-date when this happens. For interoperability, the
		219	string should start with the extension name and a colon, to distinguish
		220	it from commands for other extensions, and this might be enforced in the
		221	future.
		222
		223	Be careful not ever to trust (in a security sense) the data you receive,
		224	as its source can not easily be controleld (e-mail content, messages from
		225	other users on the same system etc.).
		226
		227	=item on_add_lines $term, $string
		228
		229	Called whenever text is about to be output, with the text as argument. You
		230	can filter/change and output the text yourself by returning a true value
		231	and calling C<< $term->scr_add_lines >> yourself. Please note that this
		232	might be very slow, however, as your hook is called for B<all> text being
		233	output.
		234
		235	=item on_line_update $term, $row
		236
		237	Called whenever a line was updated or changed. Can be used to filter
		238	screen output (e.g. underline urls or other useless stuff). Only lines
		239	that are being shown will be filtered, and, due to performance reasons,
		240	not always immediately.
		241
		242	The row number is always the topmost row of the line if the line spans
		243	multiple rows.
		244
		245	Please note that, if you change the line, then the hook might get called
		246	later with the already-modified line (e.g. if unrelated parts change), so
		247	you cannot just toggle rendition bits, but only set them.
154		248
155	=item on_refresh_begin $term	249	=item on_refresh_begin $term
156		250
157	Called just before the screen gets redrawn. Can be used for overlay	251	Called just before the screen gets redrawn. Can be used for overlay
158	or similar effects by modify terminal contents in refresh_begin, and	252	or similar effects by modify terminal contents in refresh_begin, and
…		…
167		261
168	Called whenever the user presses a key combination that has a	262	Called whenever the user presses a key combination that has a
169	C<perl:string> action bound to it (see description of the B<keysym>	263	C<perl:string> action bound to it (see description of the B<keysym>
170	resource in the @@RXVT_NAME@@(1) manpage).	264	resource in the @@RXVT_NAME@@(1) manpage).
171		265
		266	=item on_key_press $term, $event
		267
		268	=item on_key_release $term, $event
		269
		270	=item on_button_press $term, $event
		271
		272	=item on_button_release $term, $event
		273
		274	=item on_motion_notify $term, $event
		275
		276	Called whenever the corresponding X event is received for the terminal. If
		277	the hook returns true, then the even will be ignored by rxvt-unicode.
		278
		279	subwindow.
		280
		281	=back
		282
		283	=head2 Variables in the C<urxvt> Package
		284
		285	=over 4
		286
		287	=item $urxvt::TERM
		288
		289	The current terminal. Whenever a callback/Hook is bein executed, this
		290	variable stores the current C<urxvt::term> object.
		291
172	=back	292	=back
173		293
174	=head2 Functions in the C<urxvt> Package	294	=head2 Functions in the C<urxvt> Package
175		295
176	=over 4	296	=over 4
		297
		298	=item $term = new urxvt [arg...]
		299
		300	Creates a new terminal, very similar as if you had started it with
		301	C<system $binfile, arg...>. Croaks (and probably outputs an error message)
		302	if the new instance couldn't be created. Returns C<undef> if the new
		303	instance didn't initialise perl, and the terminal object otherwise. The
		304	C<init> and C<start> hooks will be called during the call.
177		305
178	=item urxvt::fatal $errormessage	306	=item urxvt::fatal $errormessage
179		307
180	Fatally aborts execution with the given error message. Avoid at all	308	Fatally aborts execution with the given error message. Avoid at all
181	costs! The only time this is acceptable is when the terminal process	309	costs! The only time this is acceptable is when the terminal process
…		…
192		320
193	=item $time = urxvt::NOW	321	=item $time = urxvt::NOW
194		322
195	Returns the "current time" (as per the event loop).	323	Returns the "current time" (as per the event loop).
196		324
		325	=back
		326
		327	=head2 RENDITION
		328
		329	Rendition bitsets contain information about colour, font, font styles and
		330	similar information for each screen cell.
		331
		332	The following "macros" deal with changes in rendition sets. You should
		333	never just create a bitset, you should always modify an existing one,
		334	as they contain important information required for correct operation of
		335	rxvt-unicode.
		336
		337	=over 4
		338
		339	=item $rend = urxvt::DEFAULT_RSTYLE
		340
		341	Returns the default rendition, as used when the terminal is starting up or
		342	being reset. Useful as a base to start when creating renditions.
		343
		344	=item $rend = urxvt::OVERLAY_RSTYLE
		345
		346	Return the rendition mask used for overlays by default.
		347
		348	=item $rendbit = urxvt::RS_Bold, RS_Italic, RS_Blink, RS_RVid, RS_Uline
		349
		350	Return the bit that enabled bold, italic, blink, reverse-video and
		351	underline, respectively. To enable such a style, just logically OR it into
		352	the bitset.
		353
		354	=item $foreground = urxvt::GET_BASEFG $rend
		355
		356	=item $background = urxvt::GET_BASEBG $rend
		357
		358	Return the foreground/background colour index, respectively.
		359
		360	=item $rend = urxvt::SET_FGCOLOR ($rend, $new_colour)
		361
		362	=item $rend = urxvt::SET_BGCOLOR ($rend, $new_colour)
		363
		364	Replace the foreground/background colour in the rendition mask with the
		365	specified one.
		366
		367	=item $value = urxvt::GET_CUSTOM ($rend)
		368
		369	Return the "custom" value: Every rendition has 5 bits for use by
		370	extensions. They can be set and changed as you like and are initially
		371	zero.
		372
		373	=item $rend = urxvt::SET_CUSTOM ($rend, $new_value)
		374
		375	Change the custom value.
		376
		377	=back
		378
197	=cut	379	=cut
198		380
199	package urxvt;	381	package urxvt;
200		382
201	use strict;	383	use strict;
		384	use Scalar::Util ();
202		385
203	our $term;	386	our $TERM;
204	our @HOOKNAME;	387	our @HOOKNAME;
205	our $LIBDIR;	388	our $LIBDIR;
206		389
207	BEGIN {	390	BEGIN {
208	urxvt->bootstrap;	391	urxvt->bootstrap;
…		…
233	my $name = $HOOKNAME[$htype];	416	my $name = $HOOKNAME[$htype];
234		417
235	my $ref = $pkg->can ("on_" . lc $name)	418	my $ref = $pkg->can ("on_" . lc $name)
236	or next;	419	or next;
237		420
238	$term->{_hook}[$htype]{$ref*1} = $ref;	421	$TERM->{_hook}[$htype]{$pkg} = $ref;
239	$hook_count[$htype]++	422	$hook_count[$htype]++
240	or set_should_invoke $htype, 1;	423	or set_should_invoke $htype, 1;
241	}	424	}
242	}	425	}
243		426
…		…
265		448
266	$pkg	449	$pkg
267	}	450	}
268	}	451	}
269		452
		453	our $retval; # return value for urxvt
		454
270	# called by the rxvt core	455	# called by the rxvt core
271	sub invoke {	456	sub invoke {
272	local $term = shift;	457	local $TERM = shift;
273	my $htype = shift;	458	my $htype = shift;
274		459
275	if ($htype == 0) { # INIT	460	if ($htype == 0) { # INIT
276	my @dirs = ((split /:/, $term->resource ("perl_lib")), "$LIBDIR/perl");	461	my @dirs = ((split /:/, $TERM->resource ("perl_lib")), "$LIBDIR/perl");
277		462
278	for my $ext (split /:/, $term->resource ("perl_ext")) {	463	for my $ext (map { split /:/, $TERM->resource ("perl_ext_$_") } 1, 2) {
279	my @files = grep -f $_, map "$_/$ext", @dirs;	464	my @files = grep -f $_, map "$_/$ext", @dirs;
280		465
281	if (@files) {	466	if (@files) {
282	register_package script_package $files[0];	467	register_package script_package $files[0];
283	} else {	468	} else {
284	warn "perl extension '$ext' not found in perl library search path\n";	469	warn "perl extension '$ext' not found in perl library search path\n";
285	}	470	}
286	}	471	}
		472	}
287		473
		474	$retval = undef;
		475
		476	if (my $cb = $TERM->{_hook}[$htype]) {
		477	verbose 10, "$HOOKNAME[$htype] (" . (join ", ", $TERM, @_) . ")"
		478	if $verbosity >= 10;
		479
		480	keys %$cb;
		481
		482	while (my ($pkg, $cb) = each %$cb) {
		483	$retval = $cb->(
		484	$TERM->{_pkg}{$pkg} \|\|= do {
		485	my $proxy = bless { }, urxvt::term::proxy::;
		486	Scalar::Util::weaken ($proxy->{term} = $TERM);
		487	$proxy
		488	},
		489	@_,
		490	) and last;
		491	}
		492	}
		493
288	} elsif ($htype == 1) { # DESTROY	494	if ($htype == 1) { # DESTROY
		495	# remove hooks if unused
289	if (my $hook = $term->{_hook}) {	496	if (my $hook = $TERM->{_hook}) {
290	for my $htype (0..$#$hook) {	497	for my $htype (0..$#$hook) {
291	$hook_count[$htype] -= scalar keys %{ $hook->[$htype] \|\| {} }	498	$hook_count[$htype] -= scalar keys %{ $hook->[$htype] \|\| {} }
292	or set_should_invoke $htype, 0;	499	or set_should_invoke $htype, 0;
293	}	500	}
294	}	501	}
		502
		503	# clear package objects
		504	%$_ = () for values %{ $TERM->{_pkg} };
		505
		506	# clear package
		507	%$TERM = ();
295	}	508	}
296		509
297	my $cb = $term->{_hook}[$htype]	510	$retval
298	or return;
299
300	verbose 10, "$HOOKNAME[$htype] (" . (join ", ", $term, @_) . ")"
301	if $verbosity >= 10;
302
303	while (my ($k, $v) = each %$cb) {
304	return 1 if $v->($term, @_);
305	}
306
307	0
308	}	511	}
309		512
310	=back	513	sub urxvt::term::proxy::AUTOLOAD {
		514	$urxvt::term::proxy::AUTOLOAD =~ /:([^:]+)$/
		515	or die "FATAL: \$AUTOLOAD '$urxvt::term::proxy::AUTOLOAD' unparsable";
		516
		517	eval qq{
		518	sub $urxvt::term::proxy::AUTOLOAD {
		519	my \$proxy = shift;
		520	\$proxy->{term}->$1 (\@_)
		521	}
		522	1
		523	} or die "FATAL: unable to compile method forwarder: $@";
		524
		525	goto &$urxvt::term::proxy::AUTOLOAD;
		526	}
311		527
312	=head2 The C<urxvt::term> Class	528	=head2 The C<urxvt::term> Class
313		529
314	=over 4	530	=over 4
		531
		532	=item $term->destroy
		533
		534	Destroy the terminal object (close the window, free resources etc.).
315		535
316	=item $value = $term->resource ($name[, $newval])	536	=item $value = $term->resource ($name[, $newval])
317		537
318	Returns the current resource value associated with a given name and	538	Returns the current resource value associated with a given name and
319	optionally sets a new value. Setting values is most useful in the C<init>	539	optionally sets a new value. Setting values is most useful in the C<init>
…		…
337	answerbackstring backgroundPixmap backspace_key boldFont boldItalicFont	557	answerbackstring backgroundPixmap backspace_key boldFont boldItalicFont
338	borderLess color cursorBlink cursorUnderline cutchars delete_key	558	borderLess color cursorBlink cursorUnderline cutchars delete_key
339	display_name embed ext_bwidth fade font geometry hold iconName	559	display_name embed ext_bwidth fade font geometry hold iconName
340	imFont imLocale inputMethod insecure int_bwidth intensityStyles	560	imFont imLocale inputMethod insecure int_bwidth intensityStyles
341	italicFont jumpScroll lineSpace loginShell mapAlert menu meta8 modifier	561	italicFont jumpScroll lineSpace loginShell mapAlert menu meta8 modifier
342	mouseWheelScrollPage name pastableTabs path perl_eval perl_ext	562	mouseWheelScrollPage name pastableTabs path perl_eval perl_ext_1 perl_ext_2
343	perl_lib pointerBlank pointerBlankDelay preeditType print_pipe pty_fd	563	perl_lib pointerBlank pointerBlankDelay preeditType print_pipe pty_fd
344	reverseVideo saveLines scrollBar scrollBar_align scrollBar_floating	564	reverseVideo saveLines scrollBar scrollBar_align scrollBar_floating
345	scrollBar_right scrollBar_thickness scrollTtyKeypress scrollTtyOutput	565	scrollBar_right scrollBar_thickness scrollTtyKeypress scrollTtyOutput
346	scrollWithBuffer scrollstyle secondaryScreen secondaryScroll selectstyle	566	scrollWithBuffer scrollstyle secondaryScreen secondaryScroll selectstyle
347	shade term_name title transparent transparent_all tripleclickwords	567	shade term_name title transparent transparent_all tripleclickwords
…		…
353	my ($self, $name) = (shift, shift);	573	my ($self, $name) = (shift, shift);
354	unshift @_, $self, $name, ($name =~ s/\s\+\s(\d+)$// ? $1 : 0);	574	unshift @_, $self, $name, ($name =~ s/\s\+\s(\d+)$// ? $1 : 0);
355	goto &urxvt::term::_resource;	575	goto &urxvt::term::_resource;
356	}	576	}
357		577
		578	=item $rend = $term->rstyle ([$new_rstyle])
		579
		580	Return and optionally change the current rendition. Text that is output by
		581	the terminal application will use this style.
		582
		583	=item ($row, $col) = $term->screen_cur ([$row, $col])
		584
		585	Return the current coordinates of the text cursor position and optionally
		586	set it (which is usually bad as applications don't expect that).
		587
358	=item ($row, $col) = $term->selection_mark ([$row, $col])	588	=item ($row, $col) = $term->selection_mark ([$row, $col])
359		589
360	=item ($row, $col) = $term->selection_beg ([$row, $col])	590	=item ($row, $col) = $term->selection_beg ([$row, $col])
361		591
362	=item ($row, $col) = $term->selection_end ([$row, $col])	592	=item ($row, $col) = $term->selection_end ([$row, $col])
…		…
371		601
372	=item $oldtext = $term->selection ([$newtext])	602	=item $oldtext = $term->selection ([$newtext])
373		603
374	Return the current selection text and optionally replace it by C<$newtext>.	604	Return the current selection text and optionally replace it by C<$newtext>.
375		605
376	=item $term->scr_overlay ($x, $y, $text)	606	#=item $term->overlay ($x, $y, $text)
377		607	#
378	Create a simple multi-line overlay box. See the next method for details.	608	#Create a simple multi-line overlay box. See the next method for details.
379		609	#
380	=cut	610	#=cut
381		611	#
382	sub urxvt::term::scr_overlay {	612	#sub urxvt::term::scr_overlay {
383	my ($self, $x, $y, $text) = @_;	613	# my ($self, $x, $y, $text) = @_;
384		614	#
385	my @lines = split /\n/, $text;	615	# my @lines = split /\n/, $text;
386		616	#
387	my $w = 0;	617	# my $w = 0;
388	for (map $self->strwidth ($_), @lines) {	618	# for (map $self->strwidth ($_), @lines) {
389	$w = $_ if $w < $_;	619	# $w = $_ if $w < $_;
390	}	620	# }
391		621	#
392	$self->scr_overlay_new ($x, $y, $w, scalar @lines);	622	# $self->scr_overlay_new ($x, $y, $w, scalar @lines);
393	$self->scr_overlay_set (0, $_, $lines[$_]) for 0.. $#lines;	623	# $self->scr_overlay_set (0, $_, $lines[$_]) for 0.. $#lines;
394	}	624	#}
395		625
396	=item $term->scr_overlay_new ($x, $y, $width, $height)	626	=item $term->overlay ($x, $y, $width, $height[, $rstyle[, $border]])
397		627
398	Create a new (empty) overlay at the given position with the given	628	Create a new (empty) overlay at the given position with the given
399	width/height. A border will be put around the box. If either C<$x> or	629	width/height. C<$rstyle> defines the initial rendition style
400	C<$y> is negative, then this is counted from the right/bottom side,	630	(default: C<OVERLAY_RSTYLE>).
401	respectively.
402		631
403	=item $term->scr_overlay_off	632	If C<$border> is C<2> (default), then a decorative border will be put
		633	around the box.
404		634
405	Switch the overlay off again.	635	If either C<$x> or C<$y> is negative, then this is counted from the
		636	right/bottom side, respectively.
406		637
407	=item $term->scr_overlay_set_char ($x, $y, $char, $rend = OVERLAY_RSTYLE)	638	This method returns an urxvt::overlay object. The overlay will be visible
		639	as long as the perl object is referenced.
408		640
409	Put a single character (specified numerically) at the given overlay	641	The methods currently supported on C<urxvt::overlay> objects are:
410	position.
411		642
		643	=over 4
		644
412	=item $term->scr_overlay_set ($x, $y, $text)	645	=item $overlay->set ($x, $y, $text, $rend)
413		646
414	Write a string at the given position into the overlay.	647	Similar to C<< $term->ROW_t >> and C<< $term->ROW_r >> in that it puts
		648	text in rxvt-unicode's special encoding and an array of rendition values
		649	at a specific position inside the overlay.
		650
		651	=item $overlay->hide
		652
		653	If visible, hide the overlay, but do not destroy it.
		654
		655	=item $overlay->show
		656
		657	If hidden, display the overlay again.
		658
		659	=back
415		660
416	=item $cellwidth = $term->strwidth $string	661	=item $cellwidth = $term->strwidth $string
417		662
418	Returns the number of screen-cells this string would need. Correctly	663	Returns the number of screen-cells this string would need. Correctly
419	accounts for wide and combining characters.	664	accounts for wide and combining characters.
…		…
423	Convert the given text string into the corresponding locale encoding.	668	Convert the given text string into the corresponding locale encoding.
424		669
425	=item $string = $term->locale_decode $octets	670	=item $string = $term->locale_decode $octets
426		671
427	Convert the given locale-encoded octets into a perl string.	672	Convert the given locale-encoded octets into a perl string.
		673
		674	=item $term->scr_add_lines ($string)
		675
		676	Write the given text string to the screen, as if output by the application
		677	running inside the terminal. It may not contain command sequences (escape
		678	codes), but is free to use line feeds, carriage returns and tabs. The
		679	string is a normal text string, not in locale-dependent encoding.
		680
		681	Normally its not a good idea to use this function, as programs might be
		682	confused by changes in cursor position or scrolling. Its useful inside a
		683	C<on_add_lines> hook, though.
		684
		685	=item $term->cmd_parse ($octets)
		686
		687	Similar to C<scr_add_lines>, but the argument must be in the
		688	locale-specific encoding of the terminal and can contain command sequences
		689	(escape codes) that will be interpreted.
428		690
429	=item $term->tt_write ($octets)	691	=item $term->tt_write ($octets)
430		692
431	Write the octets given in C<$data> to the tty (i.e. as program input). To	693	Write the octets given in C<$data> to the tty (i.e. as program input). To
432	pass characters instead of octets, you should convert your strings first	694	pass characters instead of octets, you should convert your strings first
433	to the locale-specific encoding using C<< $term->locale_encode >>.	695	to the locale-specific encoding using C<< $term->locale_encode >>.
434		696
		697	=item $window_width = $term->width
		698
		699	=item $window_height = $term->height
		700
		701	=item $font_width = $term->fwidth
		702
		703	=item $font_height = $term->fheight
		704
		705	=item $font_ascent = $term->fbase
		706
435	=item $nrow = $term->nrow	707	=item $terminal_rows = $term->nrow
436		708
437	=item $ncol = $term->ncol	709	=item $terminal_columns = $term->ncol
438		710
439	Return the number of rows/columns of the terminal window (i.e. as	711	=item $has_focus = $term->focus
440	specified by C<-geometry>, excluding any scrollback).
441		712
442	=item $nsaved = $term->nsaved	713	=item $is_mapped = $term->mapped
443		714
444	Returns the number of lines in the scrollback buffer.	715	=item $max_scrollback = $term->saveLines
		716
		717	=item $nrow_plus_saveLines = $term->total_rows
		718
		719	=item $lines_in_scrollback = $term->nsaved
		720
		721	Return various integers describing terminal characteristics.
445		722
446	=item $view_start = $term->view_start ([$newvalue])	723	=item $view_start = $term->view_start ([$newvalue])
447		724
448	Returns the negative row number of the topmost line. Minimum value is	725	Returns the negative row number of the topmost line. Minimum value is
449	C<0>, which displays the normal terminal contents. Larger values scroll	726	C<0>, which displays the normal terminal contents. Larger values scroll
…		…
460	=item $text = $term->ROW_t ($row_number[, $new_text[, $start_col]])	737	=item $text = $term->ROW_t ($row_number[, $new_text[, $start_col]])
461		738
462	Returns the text of the entire row with number C<$row_number>. Row C<0>	739	Returns the text of the entire row with number C<$row_number>. Row C<0>
463	is the topmost terminal line, row C<< $term->$ncol-1 >> is the bottommost	740	is the topmost terminal line, row C<< $term->$ncol-1 >> is the bottommost
464	terminal line. The scrollback buffer starts at line C<-1> and extends to	741	terminal line. The scrollback buffer starts at line C<-1> and extends to
465	line C<< -$term->nsaved >>.	742	line C<< -$term->nsaved >>. Nothing will be returned if a nonexistent line
		743	is requested.
466		744
467	If C<$new_text> is specified, it will replace characters in the current	745	If C<$new_text> is specified, it will replace characters in the current
468	line, starting at column C<$start_col> (default C<0>), which is useful	746	line, starting at column C<$start_col> (default C<0>), which is useful
469	to replace only parts of a line. The font iindex in the rendition will	747	to replace only parts of a line. The font index in the rendition will
470	automatically be updated.	748	automatically be updated.
471		749
472	C<$text> is in a special encoding: tabs and wide characters that use more	750	C<$text> is in a special encoding: tabs and wide characters that use more
473	than one cell when displayed are padded with urxvt::NOCHAR characters	751	than one cell when displayed are padded with urxvt::NOCHAR characters
474	(C<chr 65535>). Characters with combining characters and other characters	752	(C<chr 65535>). Characters with combining characters and other characters
…		…
488	bitsets. Rendition bitsets contain information about colour, font, font	766	bitsets. Rendition bitsets contain information about colour, font, font
489	styles and similar information. See also C<< $term->ROW_t >>.	767	styles and similar information. See also C<< $term->ROW_t >>.
490		768
491	When setting rendition, the font mask will be ignored.	769	When setting rendition, the font mask will be ignored.
492		770
493	See the section on RENDITION, below.	771	See the section on RENDITION, above.
494		772
495	=item $length = $term->ROW_l ($row_number[, $new_length])	773	=item $length = $term->ROW_l ($row_number[, $new_length])
496		774
497	Returns the number of screen cells that are in use ("the line length"). If	775	Returns the number of screen cells that are in use ("the line
498	it is C<-1>, then the line is part of a multiple-row logical "line", which	776	length"). Unlike the urxvt core, this returns C<< $term->ncol >> if the
499	means all characters are in use and it is continued on the next row.	777	line is joined with the following one.
500		778
		779	=item $bool = $term->is_longer ($row_number)
		780
		781	Returns true if the row is part of a multiple-row logical "line" (i.e.
		782	joined with the following row), which means all characters are in use
		783	and it is continued on the next row (and possibly a continuation of the
		784	previous row(s)).
		785
		786	=item $line = $term->line ($row_number)
		787
		788	Create and return a new C<urxvt::line> object that stores information
		789	about the logical line that row C<$row_number> is part of. It supports the
		790	following methods:
		791
		792	=over 4
		793
		794	=item $text = $line->t ([$new_text])
		795
		796	Returns or replaces the full text of the line, similar to C<ROW_t>
		797
		798	=item $rend = $line->r ([$new_rend])
		799
		800	Returns or replaces the full rendition array of the line, similar to C<ROW_r>
		801
		802	=item $length = $line->l
		803
		804	Returns the length of the line in cells, similar to C<ROW_l>.
		805
		806	=item $rownum = $line->beg
		807
		808	=item $rownum = $line->end
		809
		810	Return the row number of the first/last row of the line, respectively.
		811
		812	=item $offset = $line->offset_of ($row, $col)
		813
		814	Returns the character offset of the given row\|col pair within the logical
		815	line.
		816
		817	=item ($row, $col) = $line->coord_of ($offset)
		818
		819	Translates a string offset into terminal coordinates again.
		820
		821	=back
		822
		823	=cut
		824
		825	sub urxvt::term::line {
		826	my ($self, $row) = @_;
		827
		828	my $maxrow = $self->nrow - 1;
		829
		830	my ($beg, $end) = ($row, $row);
		831
		832	--$beg while $self->ROW_is_longer ($beg - 1);
		833	++$end while $self->ROW_is_longer ($end) && $end < $maxrow;
		834
		835	bless {
		836	term => $self,
		837	beg => $beg,
		838	end => $end,
		839	ncol => $self->ncol,
		840	len => ($end - $beg) * $self->ncol + $self->ROW_l ($end),
		841	}, urxvt::line::
		842	}
		843
		844	sub urxvt::line::t {
		845	my ($self) = @_;
		846
		847	if (@_ > 1)
		848	{
		849	$self->{term}->ROW_t ($_, $_[1], 0, ($_ - $self->{beg}) * $self->{ncol}, $self->{ncol})
		850	for $self->{beg} .. $self->{end};
		851	}
		852
		853	defined wantarray &&
		854	substr +(join "", map $self->{term}->ROW_t ($_), $self->{beg} .. $self->{end}),
		855	0, $self->{len}
		856	}
		857
		858	sub urxvt::line::r {
		859	my ($self) = @_;
		860
		861	if (@_ > 1)
		862	{
		863	$self->{term}->ROW_r ($_, $_[1], 0, ($_ - $self->{beg}) * $self->{ncol}, $self->{ncol})
		864	for $self->{beg} .. $self->{end};
		865	}
		866
		867	if (defined wantarray) {
		868	my $rend = [
		869	map @{ $self->{term}->ROW_r ($_) }, $self->{beg} .. $self->{end}
		870	];
		871	$#$rend = $self->{len} - 1;
		872	return $rend;
		873	}
		874
		875	()
		876	}
		877
		878	sub urxvt::line::beg { $_[0]{beg} }
		879	sub urxvt::line::end { $_[0]{end} }
		880	sub urxvt::line::l { $_[0]{len} }
		881
		882	sub urxvt::line::offset_of {
		883	my ($self, $row, $col) = @_;
		884
		885	($row - $self->{beg}) * $self->{ncol} + $col
		886	}
		887
		888	sub urxvt::line::coord_of {
		889	my ($self, $offset) = @_;
		890
		891	use integer;
		892
		893	(
		894	$offset / $self->{ncol} + $self->{beg},
		895	$offset % $self->{ncol}
		896	)
		897	}
		898
		899	=item ($row, $col) = $line->coord_of ($offset)
501	=item $text = $term->special_encode $string	900	=item $text = $term->special_encode $string
502		901
503	Converts a perl string into the special encoding used by rxvt-unicode,	902	Converts a perl string into the special encoding used by rxvt-unicode,
504	where one character corresponds to one screen cell. See	903	where one character corresponds to one screen cell. See
505	C<< $term->ROW_t >> for details.	904	C<< $term->ROW_t >> for details.
…		…
509	Converts rxvt-unicodes text reprsentation into a perl string. See	908	Converts rxvt-unicodes text reprsentation into a perl string. See
510	C<< $term->ROW_t >> for details.	909	C<< $term->ROW_t >> for details.
511		910
512	=back	911	=back
513		912
514	=head2 RENDITION
515
516	Rendition bitsets contain information about colour, font, font styles and
517	similar information for each screen cell.
518
519	The following "macros" deal with changes in rendition sets. You should
520	never just create a bitset, you should always modify an existing one,
521	as they contain important information required for correct operation of
522	rxvt-unicode.
523
524	=over 4
525
526	=item $rend = urxvt::DEFAULT_RSTYLE
527
528	Returns the default rendition, as used when the terminal is starting up or
529	being reset. Useful as a base
530
531	=back
532
533	=cut
534
535	=head2 The C<urxvt::timer> Class	913	=head2 The C<urxvt::timer> Class
536		914
537	This class implements timer watchers/events. Time is represented as a	915	This class implements timer watchers/events. Time is represented as a
538	fractional number of seconds since the epoch. Example:	916	fractional number of seconds since the epoch. Example:
539		917
540	# create a digital clock display in upper right corner	918	$term->{overlay} = $term->overlay (-1, 0, 8, 1, urxvt::OVERLAY_RSTYLE, 0);
541	$term->{timer} = urxvt::timer	919	$term->{timer} = urxvt::timer
542	->new	920	->new
543	->start (urxvt::NOW)	921	->interval (1)
544	->cb (sub {	922	->cb (sub {
545	my ($timer) = @_;
546	my $time = $timer->at;
547	$timer->start ($time + 1);
548	$self->scr_overlay (-1, 0,	923	$term->{overlay}->set (0, 0,
549	POSIX::strftime "%H:%M:%S", localtime $time);	924	sprintf "%2d:%02d:%02d", (localtime urxvt::NOW)[2,1,0]);
550	});	925	});
551		926
552	=over 4	927	=over 4
553		928
554	=item $timer = new urxvt::timer	929	=item $timer = new urxvt::timer
555		930
556	Create a new timer object in stopped state.	931	Create a new timer object in started state. It is scheduled to fire
		932	immediately.
557		933
558	=item $timer = $timer->cb (sub { my ($timer) = @_; ... })	934	=item $timer = $timer->cb (sub { my ($timer) = @_; ... })
559		935
560	Set the callback to be called when the timer triggers.	936	Set the callback to be called when the timer triggers.
561		937
…		…
564	Return the time this watcher will fire next.	940	Return the time this watcher will fire next.
565		941
566	=item $timer = $timer->set ($tstamp)	942	=item $timer = $timer->set ($tstamp)
567		943
568	Set the time the event is generated to $tstamp.	944	Set the time the event is generated to $tstamp.
		945
		946	=item $timer = $timer->interval ($interval)
		947
		948	Normally (and when C<$interval> is C<0>), the timer will automatically
		949	stop after it has fired once. If C<$interval> is non-zero, then the timer
		950	is automatically rescheduled at the given intervals.
569		951
570	=item $timer = $timer->start	952	=item $timer = $timer->start
571		953
572	Start the timer.	954	Start the timer.
573		955
…		…
636	This variable controls the verbosity level of the perl extension. Higher	1018	This variable controls the verbosity level of the perl extension. Higher
637	numbers indicate more verbose output.	1019	numbers indicate more verbose output.
638		1020
639	=over 4	1021	=over 4
640		1022
641	=item 0 - only fatal messages	1023	=item =0 - only fatal messages
642		1024
643	=item 3 - script loading and management	1025	=item =3 - script loading and management
644		1026
645	=item 10 - all events received	1027	=item =10 - all events received
646		1028
647	=back	1029	=back
648		1030
649	=head1 AUTHOR	1031	=head1 AUTHOR
650		1032

Diff Legend

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

Comparing rxvt-unicode/src/urxvt.pm (file contents): Revision 1.15 by root, Tue Jan 3 01:39:17 2006 UTC vs. Revision 1.37 by root, Fri Jan 6 03:40:19 2006 UTC

Diff Legend

Comparing rxvt-unicode/src/urxvt.pm (file contents):
Revision 1.15 by root, Tue Jan 3 01:39:17 2006 UTC vs.
Revision 1.37 by root, Fri Jan 6 03:40:19 2006 UTC