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

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.43 by root, Sat Jan 7 04:19:43 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.43 by root, Sat Jan 7 04:19:43 2006 UTC