[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.38 by root, Fri Jan 6 03:43:12 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, $octets
		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
		277	(see the XEvent manpage) If the hook returns true, then the even will be
		278	ignored by rxvt-unicode.
		279
		280	C<on_key_press> additionally receives the string rxvt-unicode would
		281	output, if any, in locale-specific encoding.
		282
		283	subwindow.
		284
		285	=back
		286
		287	=head2 Variables in the C<urxvt> Package
		288
		289	=over 4
		290
		291	=item $urxvt::TERM
		292
		293	The current terminal. Whenever a callback/Hook is bein executed, this
		294	variable stores the current C<urxvt::term> object.
		295
172	=back	296	=back
173		297
174	=head2 Functions in the C<urxvt> Package	298	=head2 Functions in the C<urxvt> Package
175		299
176	=over 4	300	=over 4
		301
		302	=item $term = new urxvt [arg...]
		303
		304	Creates a new terminal, very similar as if you had started it with
		305	C<system $binfile, arg...>. Croaks (and probably outputs an error message)
		306	if the new instance couldn't be created. Returns C<undef> if the new
		307	instance didn't initialise perl, and the terminal object otherwise. The
		308	C<init> and C<start> hooks will be called during the call.
177		309
178	=item urxvt::fatal $errormessage	310	=item urxvt::fatal $errormessage
179		311
180	Fatally aborts execution with the given error message. Avoid at all	312	Fatally aborts execution with the given error message. Avoid at all
181	costs! The only time this is acceptable is when the terminal process	313	costs! The only time this is acceptable is when the terminal process
…		…
192		324
193	=item $time = urxvt::NOW	325	=item $time = urxvt::NOW
194		326
195	Returns the "current time" (as per the event loop).	327	Returns the "current time" (as per the event loop).
196		328
		329	=back
		330
		331	=head2 RENDITION
		332
		333	Rendition bitsets contain information about colour, font, font styles and
		334	similar information for each screen cell.
		335
		336	The following "macros" deal with changes in rendition sets. You should
		337	never just create a bitset, you should always modify an existing one,
		338	as they contain important information required for correct operation of
		339	rxvt-unicode.
		340
		341	=over 4
		342
		343	=item $rend = urxvt::DEFAULT_RSTYLE
		344
		345	Returns the default rendition, as used when the terminal is starting up or
		346	being reset. Useful as a base to start when creating renditions.
		347
		348	=item $rend = urxvt::OVERLAY_RSTYLE
		349
		350	Return the rendition mask used for overlays by default.
		351
		352	=item $rendbit = urxvt::RS_Bold, RS_Italic, RS_Blink, RS_RVid, RS_Uline
		353
		354	Return the bit that enabled bold, italic, blink, reverse-video and
		355	underline, respectively. To enable such a style, just logically OR it into
		356	the bitset.
		357
		358	=item $foreground = urxvt::GET_BASEFG $rend
		359
		360	=item $background = urxvt::GET_BASEBG $rend
		361
		362	Return the foreground/background colour index, respectively.
		363
		364	=item $rend = urxvt::SET_FGCOLOR ($rend, $new_colour)
		365
		366	=item $rend = urxvt::SET_BGCOLOR ($rend, $new_colour)
		367
		368	Replace the foreground/background colour in the rendition mask with the
		369	specified one.
		370
		371	=item $value = urxvt::GET_CUSTOM ($rend)
		372
		373	Return the "custom" value: Every rendition has 5 bits for use by
		374	extensions. They can be set and changed as you like and are initially
		375	zero.
		376
		377	=item $rend = urxvt::SET_CUSTOM ($rend, $new_value)
		378
		379	Change the custom value.
		380
		381	=back
		382
197	=cut	383	=cut
198		384
199	package urxvt;	385	package urxvt;
200		386
201	use strict;	387	use strict;
		388	use Scalar::Util ();
202		389
203	our $term;	390	our $TERM;
204	our @HOOKNAME;	391	our @HOOKNAME;
205	our $LIBDIR;	392	our $LIBDIR;
206		393
207	BEGIN {	394	BEGIN {
208	urxvt->bootstrap;	395	urxvt->bootstrap;
…		…
233	my $name = $HOOKNAME[$htype];	420	my $name = $HOOKNAME[$htype];
234		421
235	my $ref = $pkg->can ("on_" . lc $name)	422	my $ref = $pkg->can ("on_" . lc $name)
236	or next;	423	or next;
237		424
238	$term->{_hook}[$htype]{$ref*1} = $ref;	425	$TERM->{_hook}[$htype]{$pkg} = $ref;
239	$hook_count[$htype]++	426	$hook_count[$htype]++
240	or set_should_invoke $htype, 1;	427	or set_should_invoke $htype, 1;
241	}	428	}
242	}	429	}
243		430
…		…
265		452
266	$pkg	453	$pkg
267	}	454	}
268	}	455	}
269		456
		457	our $retval; # return value for urxvt
		458
270	# called by the rxvt core	459	# called by the rxvt core
271	sub invoke {	460	sub invoke {
272	local $term = shift;	461	local $TERM = shift;
273	my $htype = shift;	462	my $htype = shift;
274		463
275	if ($htype == 0) { # INIT	464	if ($htype == 0) { # INIT
276	my @dirs = ((split /:/, $term->resource ("perl_lib")), "$LIBDIR/perl");	465	my @dirs = ((split /:/, $TERM->resource ("perl_lib")), "$LIBDIR/perl");
277		466
278	for my $ext (split /:/, $term->resource ("perl_ext")) {	467	for my $ext (map { split /:/, $TERM->resource ("perl_ext_$_") } 1, 2) {
279	my @files = grep -f $_, map "$_/$ext", @dirs;	468	my @files = grep -f $_, map "$_/$ext", @dirs;
280		469
281	if (@files) {	470	if (@files) {
282	register_package script_package $files[0];	471	register_package script_package $files[0];
283	} else {	472	} else {
284	warn "perl extension '$ext' not found in perl library search path\n";	473	warn "perl extension '$ext' not found in perl library search path\n";
285	}	474	}
286	}	475	}
		476	}
287		477
		478	$retval = undef;
		479
		480	if (my $cb = $TERM->{_hook}[$htype]) {
		481	verbose 10, "$HOOKNAME[$htype] (" . (join ", ", $TERM, @_) . ")"
		482	if $verbosity >= 10;
		483
		484	keys %$cb;
		485
		486	while (my ($pkg, $cb) = each %$cb) {
		487	$retval = $cb->(
		488	$TERM->{_pkg}{$pkg} \|\|= do {
		489	my $proxy = bless { }, urxvt::term::proxy::;
		490	Scalar::Util::weaken ($proxy->{term} = $TERM);
		491	$proxy
		492	},
		493	@_,
		494	) and last;
		495	}
		496	}
		497
288	} elsif ($htype == 1) { # DESTROY	498	if ($htype == 1) { # DESTROY
		499	# remove hooks if unused
289	if (my $hook = $term->{_hook}) {	500	if (my $hook = $TERM->{_hook}) {
290	for my $htype (0..$#$hook) {	501	for my $htype (0..$#$hook) {
291	$hook_count[$htype] -= scalar keys %{ $hook->[$htype] \|\| {} }	502	$hook_count[$htype] -= scalar keys %{ $hook->[$htype] \|\| {} }
292	or set_should_invoke $htype, 0;	503	or set_should_invoke $htype, 0;
293	}	504	}
294	}	505	}
		506
		507	# clear package objects
		508	%$_ = () for values %{ $TERM->{_pkg} };
		509
		510	# clear package
		511	%$TERM = ();
295	}	512	}
296		513
297	my $cb = $term->{_hook}[$htype]	514	$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	}	515	}
309		516
310	=back	517	sub urxvt::term::proxy::AUTOLOAD {
		518	$urxvt::term::proxy::AUTOLOAD =~ /:([^:]+)$/
		519	or die "FATAL: \$AUTOLOAD '$urxvt::term::proxy::AUTOLOAD' unparsable";
		520
		521	eval qq{
		522	sub $urxvt::term::proxy::AUTOLOAD {
		523	my \$proxy = shift;
		524	\$proxy->{term}->$1 (\@_)
		525	}
		526	1
		527	} or die "FATAL: unable to compile method forwarder: $@";
		528
		529	goto &$urxvt::term::proxy::AUTOLOAD;
		530	}
311		531
312	=head2 The C<urxvt::term> Class	532	=head2 The C<urxvt::term> Class
313		533
314	=over 4	534	=over 4
		535
		536	=item $term->destroy
		537
		538	Destroy the terminal object (close the window, free resources etc.).
315		539
316	=item $value = $term->resource ($name[, $newval])	540	=item $value = $term->resource ($name[, $newval])
317		541
318	Returns the current resource value associated with a given name and	542	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>	543	optionally sets a new value. Setting values is most useful in the C<init>
…		…
337	answerbackstring backgroundPixmap backspace_key boldFont boldItalicFont	561	answerbackstring backgroundPixmap backspace_key boldFont boldItalicFont
338	borderLess color cursorBlink cursorUnderline cutchars delete_key	562	borderLess color cursorBlink cursorUnderline cutchars delete_key
339	display_name embed ext_bwidth fade font geometry hold iconName	563	display_name embed ext_bwidth fade font geometry hold iconName
340	imFont imLocale inputMethod insecure int_bwidth intensityStyles	564	imFont imLocale inputMethod insecure int_bwidth intensityStyles
341	italicFont jumpScroll lineSpace loginShell mapAlert menu meta8 modifier	565	italicFont jumpScroll lineSpace loginShell mapAlert menu meta8 modifier
342	mouseWheelScrollPage name pastableTabs path perl_eval perl_ext	566	mouseWheelScrollPage name pastableTabs path perl_eval perl_ext_1 perl_ext_2
343	perl_lib pointerBlank pointerBlankDelay preeditType print_pipe pty_fd	567	perl_lib pointerBlank pointerBlankDelay preeditType print_pipe pty_fd
344	reverseVideo saveLines scrollBar scrollBar_align scrollBar_floating	568	reverseVideo saveLines scrollBar scrollBar_align scrollBar_floating
345	scrollBar_right scrollBar_thickness scrollTtyKeypress scrollTtyOutput	569	scrollBar_right scrollBar_thickness scrollTtyKeypress scrollTtyOutput
346	scrollWithBuffer scrollstyle secondaryScreen secondaryScroll selectstyle	570	scrollWithBuffer scrollstyle secondaryScreen secondaryScroll selectstyle
347	shade term_name title transparent transparent_all tripleclickwords	571	shade term_name title transparent transparent_all tripleclickwords
…		…
353	my ($self, $name) = (shift, shift);	577	my ($self, $name) = (shift, shift);
354	unshift @_, $self, $name, ($name =~ s/\s\+\s(\d+)$// ? $1 : 0);	578	unshift @_, $self, $name, ($name =~ s/\s\+\s(\d+)$// ? $1 : 0);
355	goto &urxvt::term::_resource;	579	goto &urxvt::term::_resource;
356	}	580	}
357		581
		582	=item $rend = $term->rstyle ([$new_rstyle])
		583
		584	Return and optionally change the current rendition. Text that is output by
		585	the terminal application will use this style.
		586
		587	=item ($row, $col) = $term->screen_cur ([$row, $col])
		588
		589	Return the current coordinates of the text cursor position and optionally
		590	set it (which is usually bad as applications don't expect that).
		591
358	=item ($row, $col) = $term->selection_mark ([$row, $col])	592	=item ($row, $col) = $term->selection_mark ([$row, $col])
359		593
360	=item ($row, $col) = $term->selection_beg ([$row, $col])	594	=item ($row, $col) = $term->selection_beg ([$row, $col])
361		595
362	=item ($row, $col) = $term->selection_end ([$row, $col])	596	=item ($row, $col) = $term->selection_end ([$row, $col])
…		…
371		605
372	=item $oldtext = $term->selection ([$newtext])	606	=item $oldtext = $term->selection ([$newtext])
373		607
374	Return the current selection text and optionally replace it by C<$newtext>.	608	Return the current selection text and optionally replace it by C<$newtext>.
375		609
376	=item $term->scr_overlay ($x, $y, $text)	610	#=item $term->overlay ($x, $y, $text)
377		611	#
378	Create a simple multi-line overlay box. See the next method for details.	612	#Create a simple multi-line overlay box. See the next method for details.
379		613	#
380	=cut	614	#=cut
381		615	#
382	sub urxvt::term::scr_overlay {	616	#sub urxvt::term::scr_overlay {
383	my ($self, $x, $y, $text) = @_;	617	# my ($self, $x, $y, $text) = @_;
384		618	#
385	my @lines = split /\n/, $text;	619	# my @lines = split /\n/, $text;
386		620	#
387	my $w = 0;	621	# my $w = 0;
388	for (map $self->strwidth ($_), @lines) {	622	# for (map $self->strwidth ($_), @lines) {
389	$w = $_ if $w < $_;	623	# $w = $_ if $w < $_;
390	}	624	# }
391		625	#
392	$self->scr_overlay_new ($x, $y, $w, scalar @lines);	626	# $self->scr_overlay_new ($x, $y, $w, scalar @lines);
393	$self->scr_overlay_set (0, $_, $lines[$_]) for 0.. $#lines;	627	# $self->scr_overlay_set (0, $_, $lines[$_]) for 0.. $#lines;
394	}	628	#}
395		629
396	=item $term->scr_overlay_new ($x, $y, $width, $height)	630	=item $term->overlay ($x, $y, $width, $height[, $rstyle[, $border]])
397		631
398	Create a new (empty) overlay at the given position with the given	632	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	633	width/height. C<$rstyle> defines the initial rendition style
400	C<$y> is negative, then this is counted from the right/bottom side,	634	(default: C<OVERLAY_RSTYLE>).
401	respectively.
402		635
403	=item $term->scr_overlay_off	636	If C<$border> is C<2> (default), then a decorative border will be put
		637	around the box.
404		638
405	Switch the overlay off again.	639	If either C<$x> or C<$y> is negative, then this is counted from the
		640	right/bottom side, respectively.
406		641
407	=item $term->scr_overlay_set_char ($x, $y, $char, $rend = OVERLAY_RSTYLE)	642	This method returns an urxvt::overlay object. The overlay will be visible
		643	as long as the perl object is referenced.
408		644
409	Put a single character (specified numerically) at the given overlay	645	The methods currently supported on C<urxvt::overlay> objects are:
410	position.
411		646
		647	=over 4
		648
412	=item $term->scr_overlay_set ($x, $y, $text)	649	=item $overlay->set ($x, $y, $text, $rend)
413		650
414	Write a string at the given position into the overlay.	651	Similar to C<< $term->ROW_t >> and C<< $term->ROW_r >> in that it puts
		652	text in rxvt-unicode's special encoding and an array of rendition values
		653	at a specific position inside the overlay.
		654
		655	=item $overlay->hide
		656
		657	If visible, hide the overlay, but do not destroy it.
		658
		659	=item $overlay->show
		660
		661	If hidden, display the overlay again.
		662
		663	=back
415		664
416	=item $cellwidth = $term->strwidth $string	665	=item $cellwidth = $term->strwidth $string
417		666
418	Returns the number of screen-cells this string would need. Correctly	667	Returns the number of screen-cells this string would need. Correctly
419	accounts for wide and combining characters.	668	accounts for wide and combining characters.
…		…
423	Convert the given text string into the corresponding locale encoding.	672	Convert the given text string into the corresponding locale encoding.
424		673
425	=item $string = $term->locale_decode $octets	674	=item $string = $term->locale_decode $octets
426		675
427	Convert the given locale-encoded octets into a perl string.	676	Convert the given locale-encoded octets into a perl string.
		677
		678	=item $term->scr_add_lines ($string)
		679
		680	Write the given text string to the screen, as if output by the application
		681	running inside the terminal. It may not contain command sequences (escape
		682	codes), but is free to use line feeds, carriage returns and tabs. The
		683	string is a normal text string, not in locale-dependent encoding.
		684
		685	Normally its not a good idea to use this function, as programs might be
		686	confused by changes in cursor position or scrolling. Its useful inside a
		687	C<on_add_lines> hook, though.
		688
		689	=item $term->cmd_parse ($octets)
		690
		691	Similar to C<scr_add_lines>, but the argument must be in the
		692	locale-specific encoding of the terminal and can contain command sequences
		693	(escape codes) that will be interpreted.
428		694
429	=item $term->tt_write ($octets)	695	=item $term->tt_write ($octets)
430		696
431	Write the octets given in C<$data> to the tty (i.e. as program input). To	697	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	698	pass characters instead of octets, you should convert your strings first
433	to the locale-specific encoding using C<< $term->locale_encode >>.	699	to the locale-specific encoding using C<< $term->locale_encode >>.
434		700
		701	=item $window_width = $term->width
		702
		703	=item $window_height = $term->height
		704
		705	=item $font_width = $term->fwidth
		706
		707	=item $font_height = $term->fheight
		708
		709	=item $font_ascent = $term->fbase
		710
435	=item $nrow = $term->nrow	711	=item $terminal_rows = $term->nrow
436		712
437	=item $ncol = $term->ncol	713	=item $terminal_columns = $term->ncol
438		714
439	Return the number of rows/columns of the terminal window (i.e. as	715	=item $has_focus = $term->focus
440	specified by C<-geometry>, excluding any scrollback).
441		716
442	=item $nsaved = $term->nsaved	717	=item $is_mapped = $term->mapped
443		718
444	Returns the number of lines in the scrollback buffer.	719	=item $max_scrollback = $term->saveLines
		720
		721	=item $nrow_plus_saveLines = $term->total_rows
		722
		723	=item $lines_in_scrollback = $term->nsaved
		724
		725	Return various integers describing terminal characteristics.
445		726
446	=item $view_start = $term->view_start ([$newvalue])	727	=item $view_start = $term->view_start ([$newvalue])
447		728
448	Returns the negative row number of the topmost line. Minimum value is	729	Returns the negative row number of the topmost line. Minimum value is
449	C<0>, which displays the normal terminal contents. Larger values scroll	730	C<0>, which displays the normal terminal contents. Larger values scroll
…		…
460	=item $text = $term->ROW_t ($row_number[, $new_text[, $start_col]])	741	=item $text = $term->ROW_t ($row_number[, $new_text[, $start_col]])
461		742
462	Returns the text of the entire row with number C<$row_number>. Row C<0>	743	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	744	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	745	terminal line. The scrollback buffer starts at line C<-1> and extends to
465	line C<< -$term->nsaved >>.	746	line C<< -$term->nsaved >>. Nothing will be returned if a nonexistent line
		747	is requested.
466		748
467	If C<$new_text> is specified, it will replace characters in the current	749	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	750	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	751	to replace only parts of a line. The font index in the rendition will
470	automatically be updated.	752	automatically be updated.
471		753
472	C<$text> is in a special encoding: tabs and wide characters that use more	754	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	755	than one cell when displayed are padded with urxvt::NOCHAR characters
474	(C<chr 65535>). Characters with combining characters and other characters	756	(C<chr 65535>). Characters with combining characters and other characters
…		…
488	bitsets. Rendition bitsets contain information about colour, font, font	770	bitsets. Rendition bitsets contain information about colour, font, font
489	styles and similar information. See also C<< $term->ROW_t >>.	771	styles and similar information. See also C<< $term->ROW_t >>.
490		772
491	When setting rendition, the font mask will be ignored.	773	When setting rendition, the font mask will be ignored.
492		774
493	See the section on RENDITION, below.	775	See the section on RENDITION, above.
494		776
495	=item $length = $term->ROW_l ($row_number[, $new_length])	777	=item $length = $term->ROW_l ($row_number[, $new_length])
496		778
497	Returns the number of screen cells that are in use ("the line length"). If	779	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	780	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.	781	line is joined with the following one.
500		782
		783	=item $bool = $term->is_longer ($row_number)
		784
		785	Returns true if the row is part of a multiple-row logical "line" (i.e.
		786	joined with the following row), which means all characters are in use
		787	and it is continued on the next row (and possibly a continuation of the
		788	previous row(s)).
		789
		790	=item $line = $term->line ($row_number)
		791
		792	Create and return a new C<urxvt::line> object that stores information
		793	about the logical line that row C<$row_number> is part of. It supports the
		794	following methods:
		795
		796	=over 4
		797
		798	=item $text = $line->t ([$new_text])
		799
		800	Returns or replaces the full text of the line, similar to C<ROW_t>
		801
		802	=item $rend = $line->r ([$new_rend])
		803
		804	Returns or replaces the full rendition array of the line, similar to C<ROW_r>
		805
		806	=item $length = $line->l
		807
		808	Returns the length of the line in cells, similar to C<ROW_l>.
		809
		810	=item $rownum = $line->beg
		811
		812	=item $rownum = $line->end
		813
		814	Return the row number of the first/last row of the line, respectively.
		815
		816	=item $offset = $line->offset_of ($row, $col)
		817
		818	Returns the character offset of the given row\|col pair within the logical
		819	line.
		820
		821	=item ($row, $col) = $line->coord_of ($offset)
		822
		823	Translates a string offset into terminal coordinates again.
		824
		825	=back
		826
		827	=cut
		828
		829	sub urxvt::term::line {
		830	my ($self, $row) = @_;
		831
		832	my $maxrow = $self->nrow - 1;
		833
		834	my ($beg, $end) = ($row, $row);
		835
		836	--$beg while $self->ROW_is_longer ($beg - 1);
		837	++$end while $self->ROW_is_longer ($end) && $end < $maxrow;
		838
		839	bless {
		840	term => $self,
		841	beg => $beg,
		842	end => $end,
		843	ncol => $self->ncol,
		844	len => ($end - $beg) * $self->ncol + $self->ROW_l ($end),
		845	}, urxvt::line::
		846	}
		847
		848	sub urxvt::line::t {
		849	my ($self) = @_;
		850
		851	if (@_ > 1)
		852	{
		853	$self->{term}->ROW_t ($_, $_[1], 0, ($_ - $self->{beg}) * $self->{ncol}, $self->{ncol})
		854	for $self->{beg} .. $self->{end};
		855	}
		856
		857	defined wantarray &&
		858	substr +(join "", map $self->{term}->ROW_t ($_), $self->{beg} .. $self->{end}),
		859	0, $self->{len}
		860	}
		861
		862	sub urxvt::line::r {
		863	my ($self) = @_;
		864
		865	if (@_ > 1)
		866	{
		867	$self->{term}->ROW_r ($_, $_[1], 0, ($_ - $self->{beg}) * $self->{ncol}, $self->{ncol})
		868	for $self->{beg} .. $self->{end};
		869	}
		870
		871	if (defined wantarray) {
		872	my $rend = [
		873	map @{ $self->{term}->ROW_r ($_) }, $self->{beg} .. $self->{end}
		874	];
		875	$#$rend = $self->{len} - 1;
		876	return $rend;
		877	}
		878
		879	()
		880	}
		881
		882	sub urxvt::line::beg { $_[0]{beg} }
		883	sub urxvt::line::end { $_[0]{end} }
		884	sub urxvt::line::l { $_[0]{len} }
		885
		886	sub urxvt::line::offset_of {
		887	my ($self, $row, $col) = @_;
		888
		889	($row - $self->{beg}) * $self->{ncol} + $col
		890	}
		891
		892	sub urxvt::line::coord_of {
		893	my ($self, $offset) = @_;
		894
		895	use integer;
		896
		897	(
		898	$offset / $self->{ncol} + $self->{beg},
		899	$offset % $self->{ncol}
		900	)
		901	}
		902
		903	=item ($row, $col) = $line->coord_of ($offset)
501	=item $text = $term->special_encode $string	904	=item $text = $term->special_encode $string
502		905
503	Converts a perl string into the special encoding used by rxvt-unicode,	906	Converts a perl string into the special encoding used by rxvt-unicode,
504	where one character corresponds to one screen cell. See	907	where one character corresponds to one screen cell. See
505	C<< $term->ROW_t >> for details.	908	C<< $term->ROW_t >> for details.
…		…
509	Converts rxvt-unicodes text reprsentation into a perl string. See	912	Converts rxvt-unicodes text reprsentation into a perl string. See
510	C<< $term->ROW_t >> for details.	913	C<< $term->ROW_t >> for details.
511		914
512	=back	915	=back
513		916
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	917	=head2 The C<urxvt::timer> Class
536		918
537	This class implements timer watchers/events. Time is represented as a	919	This class implements timer watchers/events. Time is represented as a
538	fractional number of seconds since the epoch. Example:	920	fractional number of seconds since the epoch. Example:
539		921
540	# create a digital clock display in upper right corner	922	$term->{overlay} = $term->overlay (-1, 0, 8, 1, urxvt::OVERLAY_RSTYLE, 0);
541	$term->{timer} = urxvt::timer	923	$term->{timer} = urxvt::timer
542	->new	924	->new
543	->start (urxvt::NOW)	925	->interval (1)
544	->cb (sub {	926	->cb (sub {
545	my ($timer) = @_;
546	my $time = $timer->at;
547	$timer->start ($time + 1);
548	$self->scr_overlay (-1, 0,	927	$term->{overlay}->set (0, 0,
549	POSIX::strftime "%H:%M:%S", localtime $time);	928	sprintf "%2d:%02d:%02d", (localtime urxvt::NOW)[2,1,0]);
550	});	929	});
551		930
552	=over 4	931	=over 4
553		932
554	=item $timer = new urxvt::timer	933	=item $timer = new urxvt::timer
555		934
556	Create a new timer object in stopped state.	935	Create a new timer object in started state. It is scheduled to fire
		936	immediately.
557		937
558	=item $timer = $timer->cb (sub { my ($timer) = @_; ... })	938	=item $timer = $timer->cb (sub { my ($timer) = @_; ... })
559		939
560	Set the callback to be called when the timer triggers.	940	Set the callback to be called when the timer triggers.
561		941
…		…
564	Return the time this watcher will fire next.	944	Return the time this watcher will fire next.
565		945
566	=item $timer = $timer->set ($tstamp)	946	=item $timer = $timer->set ($tstamp)
567		947
568	Set the time the event is generated to $tstamp.	948	Set the time the event is generated to $tstamp.
		949
		950	=item $timer = $timer->interval ($interval)
		951
		952	Normally (and when C<$interval> is C<0>), the timer will automatically
		953	stop after it has fired once. If C<$interval> is non-zero, then the timer
		954	is automatically rescheduled at the given intervals.
569		955
570	=item $timer = $timer->start	956	=item $timer = $timer->start
571		957
572	Start the timer.	958	Start the timer.
573		959
…		…
636	This variable controls the verbosity level of the perl extension. Higher	1022	This variable controls the verbosity level of the perl extension. Higher
637	numbers indicate more verbose output.	1023	numbers indicate more verbose output.
638		1024
639	=over 4	1025	=over 4
640		1026
641	=item 0 - only fatal messages	1027	=item =0 - only fatal messages
642		1028
643	=item 3 - script loading and management	1029	=item =3 - script loading and management
644		1030
645	=item 10 - all events received	1031	=item =10 - all events received
646		1032
647	=back	1033	=back
648		1034
649	=head1 AUTHOR	1035	=head1 AUTHOR
650		1036

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.38 by root, Fri Jan 6 03:43:12 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.38 by root, Fri Jan 6 03:43:12 2006 UTC