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

Comparing rxvt-unicode/src/urxvt.pm (file contents):
Revision 1.2 by root, Mon Jan 2 15:36:27 2006 UTC vs.
Revision 1.32 by root, Wed Jan 4 21:37:55 2006 UTC

…		…
		1	=encoding utf8
		2
1	=head1 NAME	3	=head1 NAME
2		4
3	urxvt - rxvt-unicode's embedded perl interpreter	5	@@RXVT_NAME@@perl - rxvt-unicode's embedded perl interpreter
4		6
5	=head1 SYNOPSIS	7	=head1 SYNOPSIS
6		8
7	Put your scripts into $LIBDIR/perl-init/, they will be loaded automatically.	9	# create a file grab_test in $HOME:
8
9	Each script will only be loaded once, even in urxvtd, and will be valid
10	globally.
11
12	Scripts are evaluated in a 'use strict' and 'use utf8' environment, and
13	thus must be written in utf-8.
14		10
15	sub on_sel_grab {	11	sub on_sel_grab {
16	warn "you selected ", $_[0]->selection;	12	warn "you selected ", $_[0]->selection;
		13	()
17	}	14	}
18		15
19	1	16	# start a @@RXVT_NAME@@ using it:
		17
		18	@@RXVT_NAME@@ --perl-lib $HOME -pe grab_test
20		19
21	=head1 DESCRIPTION	20	=head1 DESCRIPTION
22		21
		22	Everytime a terminal object gets created, scripts specified via the
		23	C<perl> resource are loaded and associated with it.
		24
		25	Scripts are compiled in a 'use strict' and 'use utf8' environment, and
		26	thus must be encoded as UTF-8.
		27
		28	Each script will only ever be loaded once, even in @@RXVT_NAME@@d, where
		29	scripts will be shared (but not enabled) for all terminals.
		30
		31	=head2 Prepackaged Extensions
		32
		33	This section describes the extensiosn delivered with this version. You can
		34	find them in F<@@RXVT_LIBDIR@@/urxvt/perl/>.
		35
		36	You can activate them like this:
		37
		38	@@RXVT_NAME@@ -pe <extensionname>
		39
		40	=over 4
		41
		42	=item selection
		43
		44	Intelligent selection. This extension tries to be more intelligent when
		45	the user extends selections (double-click). Right now, it tries to select
		46	urls and complete shell-quoted arguments, which is very convenient, too,
		47	if your F<ls> supports C<--quoting-style=shell>.
		48
		49	It also offers the following bindable event:
		50
		51	=over 4
		52
		53	=item rot13
		54
		55	Rot-13 the selection when activated. Used via keyboard trigger:
		56
		57	URxvt.keysym.C-M-r: perl:selection:rot13
		58
		59	=back
		60
		61	=item digital-clock
		62
		63	Displays a digital clock using the built-in overlay.
		64
		65	=item example-refresh-hooks
		66
		67	Displays a very simple digital clock in the upper right corner of the
		68	window. Illustrates overwriting the refresh callbacks to create your own
		69	overlays or changes.
		70
		71	=back
		72
		73	=head2 General API Considerations
		74
		75	All objects (such as terminals, time watchers etc.) are typical
		76	reference-to-hash objects. The hash can be used to store anything you
		77	like. All members starting with an underscore (such as C<_ptr> or
		78	C<_hook>) are reserved for internal uses and B<MUST NOT> be accessed or
		79	modified).
		80
		81	When objects are destroyed on the C++ side, the perl object hashes are
		82	emptied, so its best to store related objects such as time watchers and
		83	the like inside the terminal object so they get destroyed as soon as the
		84	terminal is destroyed.
		85
23	=head2 Hooks	86	=head2 Hooks
24		87
25	The following subroutines can be declared in loaded scripts, and will be called	88	The following subroutines can be declared in loaded scripts, and will be
26	whenever the relevant event happens.	89	called whenever the relevant event happens.
		90
		91	The first argument passed to them is an object private to each terminal
		92	and extension package. You can call all C<urxvt::term> methods on it, but
		93	its not a real C<urxvt::term> object. Instead, the real C<urxvt::term>
		94	object that is shared between all packages is stored in the C<term>
		95	member.
27		96
28	All of them must return a boolean value. If it is true, then the event	97	All of them must return a boolean value. If it is true, then the event
29	counts as being I<consumed>, and the invocation of other hooks is skipped,	98	counts as being I<consumed>, and the invocation of other hooks is skipped,
30	and the relevant action might not be carried out by the C++ code.	99	and the relevant action might not be carried out by the C++ code.
31		100
64	requested from the server. The selection text can be queried and changed	133	requested from the server. The selection text can be queried and changed
65	by calling C<< $term->selection >>.	134	by calling C<< $term->selection >>.
66		135
67	Returning a true value aborts selection grabbing. It will still be hilighted.	136	Returning a true value aborts selection grabbing. It will still be hilighted.
68		137
		138	=item on_sel_extend $term
		139
		140	Called whenever the user tries to extend the selection (e.g. with a double
		141	click) and is either supposed to return false (normal operation), or
		142	should extend the selection itelf and return true to suppress the built-in
		143	processing.
		144
		145	See the F<selection> example extension.
		146
69	=item on_focus_in $term	147	=item on_focus_in $term
70		148
71	Called whenever the window gets the keyboard focus, before urxvt does	149	Called whenever the window gets the keyboard focus, before urxvt does
72	focus in processing.	150	focus in processing.
73		151
…		…
93	number of lines that will be in the scrollback buffer.	171	number of lines that will be in the scrollback buffer.
94		172
95	=item on_tty_activity $term NYI	173	=item on_tty_activity $term NYI
96		174
97	Called whenever the program(s) running in the urxvt window send output.	175	Called whenever the program(s) running in the urxvt window send output.
		176
		177	=item on_osc_seq $term, $string
		178
		179	Called whenever the B<ESC ] 777 ; string ST> command sequence (OSC =
		180	operating system command) is processed. Cursor position and other state
		181	information is up-to-date when this happens. For interoperability, the
		182	string should start with the extension name and a colon, to distinguish
		183	it from commands for other extensions, and this might be enforced in the
		184	future.
		185
		186	Be careful not ever to trust (in a security sense) the data you receive,
		187	as its source can not easily be controleld (e-mail content, messages from
		188	other users on the same system etc.).
98		189
99	=item on_refresh_begin $term	190	=item on_refresh_begin $term
100		191
101	Called just before the screen gets redrawn. Can be used for overlay	192	Called just before the screen gets redrawn. Can be used for overlay
102	or similar effects by modify terminal contents in refresh_begin, and	193	or similar effects by modify terminal contents in refresh_begin, and
…		…
105		196
106	=item on_refresh_end $term	197	=item on_refresh_end $term
107		198
108	Called just after the screen gets redrawn. See C<on_refresh_begin>.	199	Called just after the screen gets redrawn. See C<on_refresh_begin>.
109		200
		201	=item on_keyboard_command $term, $string
		202
		203	Called whenever the user presses a key combination that has a
		204	C<perl:string> action bound to it (see description of the B<keysym>
		205	resource in the @@RXVT_NAME@@(1) manpage).
		206
		207	=back
		208
		209	=head2 Variables in the C<urxvt> Package
		210
		211	=over 4
		212
		213	=item $urxvt::TERM
		214
		215	The current terminal. Whenever a callback/Hook is bein executed, this
		216	variable stores the current C<urxvt::term> object.
		217
110	=back	218	=back
111		219
112	=head2 Functions in the C<urxvt> Package	220	=head2 Functions in the C<urxvt> Package
113		221
114	=over 4	222	=over 4
…		…
119	costs! The only time this is acceptable is when the terminal process	227	costs! The only time this is acceptable is when the terminal process
120	starts up.	228	starts up.
121		229
122	=item urxvt::warn $string	230	=item urxvt::warn $string
123		231
124	Calls C<rxvt_warn> witht eh given string which should not include a	232	Calls C<rxvt_warn> with the given string which should not include a
125	newline. The module also overwrites the C<warn> builtin with a function	233	newline. The module also overwrites the C<warn> builtin with a function
126	that calls this function.	234	that calls this function.
127		235
128	Using this function has the advantage that its output ends up in the	236	Using this function has the advantage that its output ends up in the
129	correct place, e.g. on stderr of the connecting urxvtc client.	237	correct place, e.g. on stderr of the connecting urxvtc client.
130		238
131	=item $cellwidth = urxvt::wcswidth $string
132
133	Returns the number of screen-cells this string would need. Correctly
134	accounts for wide and combining characters.
135
136	=item $time = urxvt::NOW	239	=item $time = urxvt::NOW
137		240
138	Returns the "current time" (as per the event loop).	241	Returns the "current time" (as per the event loop).
139		242
		243	=back
		244
		245	=head2 RENDITION
		246
		247	Rendition bitsets contain information about colour, font, font styles and
		248	similar information for each screen cell.
		249
		250	The following "macros" deal with changes in rendition sets. You should
		251	never just create a bitset, you should always modify an existing one,
		252	as they contain important information required for correct operation of
		253	rxvt-unicode.
		254
		255	=over 4
		256
		257	=item $rend = urxvt::DEFAULT_RSTYLE
		258
		259	Returns the default rendition, as used when the terminal is starting up or
		260	being reset. Useful as a base to start when creating renditions.
		261
		262	=item $rend = urxvt::OVERLAY_RSTYLE
		263
		264	Return the rendition mask used for overlays by default.
		265
		266	=item $rendbit = urxvt::RS_Bold, RS_Italic, RS_Blink, RS_RVid, RS_Uline
		267
		268	Return the bit that enabled bold, italic, blink, reverse-video and
		269	underline, respectively. To enable such a style, just logically OR it into
		270	the bitset.
		271
		272	=item $foreground = urxvt::GET_BASEFG $rend
		273
		274	=item $background = urxvt::GET_BASEBG $rend
		275
		276	Return the foreground/background colour index, respectively.
		277
		278	=item $rend = urxvt::SET_FGCOLOR ($rend, $new_colour)
		279
		280	=item $rend = urxvt::SET_BGCOLOR ($rend, $new_colour)
		281
		282	Replace the foreground/background colour in the rendition mask with the
		283	specified one.
		284
		285	=item $value = urxvt::GET_CUSTOM ($rend)
		286
		287	Return the "custom" value: Every rendition has 5 bits for use by
		288	extensions. They can be set and changed as you like and are initially
		289	zero.
		290
		291	=item $rend = urxvt::SET_CUSTOM ($rend, $new_value)
		292
		293	Change the custom value.
		294
		295	=back
		296
140	=cut	297	=cut
141		298
142	package urxvt;	299	package urxvt;
143		300
144	use strict;	301	use strict;
		302	use Scalar::Util ();
145		303
146	our $term;	304	our $TERM;
147	our @HOOKNAME;	305	our @HOOKNAME;
148	our $LIBDIR;	306	our $LIBDIR;
149		307
150	BEGIN {	308	BEGIN {
151	urxvt->bootstrap;	309	urxvt->bootstrap;
…		…
157	unless $msg =~ /\n$/;	315	unless $msg =~ /\n$/;
158	urxvt::warn ($msg);	316	urxvt::warn ($msg);
159	};	317	};
160	}	318	}
161		319
		320	my @hook_count;
162	my $verbosity = $ENV{URXVT_PERL_VERBOSITY} \|\| 10;	321	my $verbosity = $ENV{URXVT_PERL_VERBOSITY};
163		322
164	sub verbose {	323	sub verbose {
165	my ($level, $msg) = @_;	324	my ($level, $msg) = @_;
166	warn "$msg\n"; #d#	325	warn "$msg\n" if $level <= $verbosity;
167	}
168
169	my @invoke_cb;
170
171	# called by the rxvt core
172	sub invoke {
173	local $term = shift;
174	my $htype = shift;
175
176	my $cb = $invoke_cb[$htype];
177
178	verbose 10, "$HOOKNAME[$htype] (" . (join ", ", $term, @_) . ")"
179	if $verbosity >= 10;
180
181	while (my ($k, $v) = each %$cb) {
182	return 1 if $v->($term, @_);
183	}
184
185	0
186	}	326	}
187		327
188	# find on_xxx subs in the package and register them	328	# find on_xxx subs in the package and register them
189	# as hooks	329	# as hooks
190	sub register_package($) {	330	sub register_package($) {
191	my ($pkg) = @_;	331	my ($pkg) = @_;
192		332
193	for my $hook (0.. $#HOOKNAME) {	333	for my $htype (0.. $#HOOKNAME) {
194	my $name = $HOOKNAME[$hook];	334	my $name = $HOOKNAME[$htype];
195		335
196	my $ref = $pkg->can ("on_" . lc $name)	336	my $ref = $pkg->can ("on_" . lc $name)
197	or next;	337	or next;
198		338
199	$invoke_cb[$hook]{$ref*1} = $ref;	339	$TERM->{_hook}[$htype]{$pkg} = $ref;
		340	$hook_count[$htype]++
200	set_should_invoke $hook, 1;	341	or set_should_invoke $htype, 1;
201	}	342	}
202	}	343	}
203		344
204	my $script_pkg = "script0000";	345	my $script_pkg = "script0000";
205	my %script_pkg;	346	my %script_pkg;
206		347
207	# load a single script into its own package, once only	348	# load a single script into its own package, once only
208	sub load_script($) {	349	sub script_package($) {
209	my ($path) = @_;	350	my ($path) = @_;
210		351
211	$script_pkg{$path} \|\|= do {	352	$script_pkg{$path} \|\|= do {
212	my $pkg = $script_pkg++;	353	my $pkg = "urxvt::" . ($script_pkg++);
		354
213	verbose 3, "loading script '$path' into package '$pkg'";	355	verbose 3, "loading script '$path' into package '$pkg'";
214		356
215	open my $fh, "<:raw", $path	357	open my $fh, "<:raw", $path
216	or die "$path: $!";	358	or die "$path: $!";
217		359
218	eval "package $pkg; use strict; use utf8;\n"	360	my $source = "package $pkg; use strict; use utf8;\n"
219	. "#line 1 \"$path\"\n"	361	. "#line 1 \"$path\"\n{\n"
220	. do { local $/; <$fh> }	362	. (do { local $/; <$fh> })
		363	. "\n};\n1";
		364
221	or die "$path: $@";	365	eval $source or die "$path: $@";
222
223	register_package $pkg;
224		366
225	$pkg	367	$pkg
226	};	368	}
227	}	369	}
228		370
229	load_script $_ for grep -f $_, <$LIBDIR/perl-ext/*>;	371	our $retval; # return value for urxvt
230		372
		373	# called by the rxvt core
		374	sub invoke {
		375	local $TERM = shift;
		376	my $htype = shift;
231		377
232	=back	378	if ($htype == 0) { # INIT
		379	my @dirs = ((split /:/, $TERM->resource ("perl_lib")), "$LIBDIR/perl");
		380
		381	for my $ext (map { split /:/, $TERM->resource ("perl_ext_$_") } 1, 2) {
		382	my @files = grep -f $_, map "$_/$ext", @dirs;
		383
		384	if (@files) {
		385	register_package script_package $files[0];
		386	} else {
		387	warn "perl extension '$ext' not found in perl library search path\n";
		388	}
		389	}
		390	}
		391
		392	$retval = undef;
		393
		394	if (my $cb = $TERM->{_hook}[$htype]) {
		395	verbose 10, "$HOOKNAME[$htype] (" . (join ", ", $TERM, @_) . ")"
		396	if $verbosity >= 10;
		397
		398	keys %$cb;
		399
		400	while (my ($pkg, $cb) = each %$cb) {
		401	$retval = $cb->(
		402	$TERM->{_pkg}{$pkg} \|\|= do {
		403	my $proxy = bless { }, urxvt::term::proxy::;
		404	Scalar::Util::weaken ($proxy->{term} = $TERM);
		405	$proxy
		406	},
		407	@_,
		408	) and last;
		409	}
		410	}
		411
		412	if ($htype == 1) { # DESTROY
		413	# remove hooks if unused
		414	if (my $hook = $TERM->{_hook}) {
		415	for my $htype (0..$#$hook) {
		416	$hook_count[$htype] -= scalar keys %{ $hook->[$htype] \|\| {} }
		417	or set_should_invoke $htype, 0;
		418	}
		419	}
		420
		421	# clear package objects
		422	%$_ = () for values %{ $TERM->{_pkg} };
		423
		424	# clear package
		425	%$TERM = ();
		426	}
		427
		428	$retval
		429	}
		430
		431	sub urxvt::term::proxy::AUTOLOAD {
		432	$urxvt::term::proxy::AUTOLOAD =~ /:([^:]+)$/
		433	or die "FATAL: \$AUTOLOAD '$urxvt::term::proxy::AUTOLOAD' unparsable";
		434
		435	eval qq{
		436	sub $urxvt::term::proxy::AUTOLOAD {
		437	my \$proxy = shift;
		438	\$proxy->{term}->$1 (\@_)
		439	}
		440	1
		441	} or die "FATAL: unable to compile method forwarder: $@";
		442
		443	goto &$urxvt::term::proxy::AUTOLOAD;
		444	}
233		445
234	=head2 The C<urxvt::term> Class	446	=head2 The C<urxvt::term> Class
235		447
236	=over 4	448	=over 4
		449
		450	=item $value = $term->resource ($name[, $newval])
		451
		452	Returns the current resource value associated with a given name and
		453	optionally sets a new value. Setting values is most useful in the C<init>
		454	hook. Unset resources are returned and accepted as C<undef>.
		455
		456	The new value must be properly encoded to a suitable character encoding
		457	before passing it to this method. Similarly, the returned value may need
		458	to be converted from the used encoding to text.
		459
		460	Resource names are as defined in F<src/rsinc.h>. Colours can be specified
		461	as resource names of the form C<< color+<index> >>, e.g. C<color+5>. (will
		462	likely change).
		463
		464	Please note that resource strings will currently only be freed when the
		465	terminal is destroyed, so changing options frequently will eat memory.
		466
		467	Here is a a likely non-exhaustive list of resource names, not all of which
		468	are supported in every build, please see the source to see the actual
		469	list:
		470
		471	answerbackstring backgroundPixmap backspace_key boldFont boldItalicFont
		472	borderLess color cursorBlink cursorUnderline cutchars delete_key
		473	display_name embed ext_bwidth fade font geometry hold iconName
		474	imFont imLocale inputMethod insecure int_bwidth intensityStyles
		475	italicFont jumpScroll lineSpace loginShell mapAlert menu meta8 modifier
		476	mouseWheelScrollPage name pastableTabs path perl_eval perl_ext_1 perl_ext_2
		477	perl_lib pointerBlank pointerBlankDelay preeditType print_pipe pty_fd
		478	reverseVideo saveLines scrollBar scrollBar_align scrollBar_floating
		479	scrollBar_right scrollBar_thickness scrollTtyKeypress scrollTtyOutput
		480	scrollWithBuffer scrollstyle secondaryScreen secondaryScroll selectstyle
		481	shade term_name title transparent transparent_all tripleclickwords
		482	utmpInhibit visualBell
		483
		484	=cut
		485
		486	sub urxvt::term::resource($$;$) {
		487	my ($self, $name) = (shift, shift);
		488	unshift @_, $self, $name, ($name =~ s/\s\+\s(\d+)$// ? $1 : 0);
		489	goto &urxvt::term::_resource;
		490	}
		491
		492	=item $rend = $term->screen_rstyle ([$new_rstyle])
		493
		494	Return and optionally change the current rendition. Text thta is output by
		495	the temrianl application will use this style.
		496
		497	=item ($row, $col) = $term->screen_cur ([$row, $col])
		498
		499	Return the current coordinates of the text cursor position and optionally
		500	set it (which is usually bad as applications don't expect that).
237		501
238	=item ($row, $col) = $term->selection_mark ([$row, $col])	502	=item ($row, $col) = $term->selection_mark ([$row, $col])
239		503
240	=item ($row, $col) = $term->selection_beg ([$row, $col])	504	=item ($row, $col) = $term->selection_beg ([$row, $col])
241		505
…		…
251		515
252	=item $oldtext = $term->selection ([$newtext])	516	=item $oldtext = $term->selection ([$newtext])
253		517
254	Return the current selection text and optionally replace it by C<$newtext>.	518	Return the current selection text and optionally replace it by C<$newtext>.
255		519
256	=item $term->scr_overlay ($x, $y, $text)	520	#=item $term->overlay ($x, $y, $text)
257		521	#
258	Create a simple multi-line overlay box. See the next method for details.	522	#Create a simple multi-line overlay box. See the next method for details.
259		523	#
260	=cut	524	#=cut
261		525
262	sub urxvt::term::scr_overlay {	526	sub urxvt::term::scr_overlay {
		527	die;
263	my ($self, $x, $y, $text) = @_;	528	my ($self, $x, $y, $text) = @_;
264		529
265	my @lines = split /\n/, $text;	530	my @lines = split /\n/, $text;
266		531
267	my $w = 0;	532	my $w = 0;
268	for (map urxvt::wcswidth $_, @lines) {	533	for (map $self->strwidth ($_), @lines) {
269	$w = $_ if $w < $_;	534	$w = $_ if $w < $_;
270	}	535	}
271		536
272	$self->scr_overlay_new ($x, $y, $w, scalar @lines);	537	$self->scr_overlay_new ($x, $y, $w, scalar @lines);
273	$self->scr_overlay_set (0, $_, $lines[$_]) for 0.. $#lines;	538	$self->scr_overlay_set (0, $_, $lines[$_]) for 0.. $#lines;
274	}	539	}
275		540
276	=item $term->scr_overlay_new ($x, $y, $width, $height)	541	=item $term->overlay ($x, $y, $width, $height[, $rstyle[, $border]])
277		542
278	Create a new (empty) overlay at the given position with the given	543	Create a new (empty) overlay at the given position with the given
279	width/height. A border will be put around the box. If either C<$x> or	544	width/height. C<$rstyle> defines the initial rendition style
280	C<$y> is negative, then this is counted from the right/bottom side,	545	(default: C<OVERLAY_RSTYLE>).
281	respectively.
282		546
283	=item $term->scr_overlay_off	547	If C<$border> is C<2> (default), then a decorative border will be put
		548	around the box.
284		549
285	Switch the overlay off again.	550	If either C<$x> or C<$y> is negative, then this is counted from the
		551	right/bottom side, respectively.
286		552
287	=item $term->scr_overlay_set_char ($x, $y, $char, $rend = OVERLAY_RSTYLE)	553	This method returns an urxvt::overlay object. The overlay will be visible
		554	as long as the perl object is referenced.
288		555
289	Put a single character (specified numerically) at the given overlay	556	The methods currently supported on C<urxvt::overlay> objects are:
290	position.
291		557
		558	=over 4
		559
292	=item $term->scr_overlay_set ($x, $y, $text)	560	=item $overlay->set ($x, $y, $text, $rend)
293		561
294	Write a string at the given position into the overlay.	562	Similar to C<< $term->ROW_t >> and C<< $term->ROW_r >> in that it puts
		563	text in rxvt-unicode's special encoding and an array of rendition values
		564	at a specific position inside the overlay.
		565
		566	=item $overlay->hide
		567
		568	If visible, hide the overlay, but do not destroy it.
		569
		570	=item $overlay->show
		571
		572	If hidden, display the overlay again.
		573
		574	=back
		575
		576	=item $cellwidth = $term->strwidth $string
		577
		578	Returns the number of screen-cells this string would need. Correctly
		579	accounts for wide and combining characters.
		580
		581	=item $octets = $term->locale_encode $string
		582
		583	Convert the given text string into the corresponding locale encoding.
		584
		585	=item $string = $term->locale_decode $octets
		586
		587	Convert the given locale-encoded octets into a perl string.
		588
		589	=item $term->tt_write ($octets)
		590
		591	Write the octets given in C<$data> to the tty (i.e. as program input). To
		592	pass characters instead of octets, you should convert your strings first
		593	to the locale-specific encoding using C<< $term->locale_encode >>.
		594
		595	=item $window_width = $term->width
		596
		597	=item $window_height = $term->height
		598
		599	=item $font_width = $term->fwidth
		600
		601	=item $font_height = $term->fheight
		602
		603	=item $font_ascent = $term->fbase
		604
		605	=item $terminal_rows = $term->nrow
		606
		607	=item $terminal_columns = $term->ncol
		608
		609	=item $has_focus = $term->focus
		610
		611	=item $is_mapped = $term->mapped
		612
		613	=item $max_scrollback = $term->saveLines
		614
		615	=item $nrow_plus_saveLines = $term->total_rows
		616
		617	=item $lines_in_scrollback = $term->nsaved
		618
		619	Return various integers describing terminal characteristics.
		620
		621	=item $view_start = $term->view_start ([$newvalue])
		622
		623	Returns the negative row number of the topmost line. Minimum value is
		624	C<0>, which displays the normal terminal contents. Larger values scroll
		625	this many lines into the scrollback buffer.
		626
		627	=item $term->want_refresh
		628
		629	Requests a screen refresh. At the next opportunity, rxvt-unicode will
		630	compare the on-screen display with its stored representation. If they
		631	differ, it redraws the differences.
		632
		633	Used after changing terminal contents to display them.
		634
		635	=item $text = $term->ROW_t ($row_number[, $new_text[, $start_col]])
		636
		637	Returns the text of the entire row with number C<$row_number>. Row C<0>
		638	is the topmost terminal line, row C<< $term->$ncol-1 >> is the bottommost
		639	terminal line. The scrollback buffer starts at line C<-1> and extends to
		640	line C<< -$term->nsaved >>. Nothing will be returned if a nonexistent line
		641	is requested.
		642
		643	If C<$new_text> is specified, it will replace characters in the current
		644	line, starting at column C<$start_col> (default C<0>), which is useful
		645	to replace only parts of a line. The font index in the rendition will
		646	automatically be updated.
		647
		648	C<$text> is in a special encoding: tabs and wide characters that use more
		649	than one cell when displayed are padded with urxvt::NOCHAR characters
		650	(C<chr 65535>). Characters with combining characters and other characters
		651	that do not fit into the normal tetx encoding will be replaced with
		652	characters in the private use area.
		653
		654	You have to obey this encoding when changing text. The advantage is
		655	that C<substr> and similar functions work on screen cells and not on
		656	characters.
		657
		658	The methods C<< $term->special_encode >> and C<< $term->special_decode >>
		659	can be used to convert normal strings into this encoding and vice versa.
		660
		661	=item $rend = $term->ROW_r ($row_number[, $new_rend[, $start_col]])
		662
		663	Like C<< $term->ROW_t >>, but returns an arrayref with rendition
		664	bitsets. Rendition bitsets contain information about colour, font, font
		665	styles and similar information. See also C<< $term->ROW_t >>.
		666
		667	When setting rendition, the font mask will be ignored.
		668
		669	See the section on RENDITION, above.
		670
		671	=item $length = $term->ROW_l ($row_number[, $new_length])
		672
		673	Returns the number of screen cells that are in use ("the line
		674	length"). Unlike the urxvt core, this returns C<< $term->ncol >> if the
		675	line is joined with the following one.
		676
		677	=item $bool = $term->is_longer ($row_number)
		678
		679	Returns true if the row is part of a multiple-row logical "line" (i.e.
		680	joined with the following row), which means all characters are in use
		681	and it is continued on the next row (and possibly a continuation of the
		682	previous row(s)).
		683
		684	=item $line = $term->line ($row_number)
		685
		686	Create and return a new C<urxvt::line> object that stores information
		687	about the logical line that row C<$row_number> is part of. It supports the
		688	following methods:
		689
		690	=over 4
		691
		692	=item $text = $line->t
		693
		694	Returns the full text of the line, similar to C<ROW_t>
		695
		696	=item $rend = $line->r
		697
		698	Returns the full rendition array of the line, similar to C<ROW_r>
		699
		700	=item $length = $line->l
		701
		702	Returns the length of the line in cells, similar to C<ROW_l>.
		703
		704	=item $rownum = $line->beg
		705
		706	=item $rownum = $line->end
		707
		708	Return the row number of the first/last row of the line, respectively.
		709
		710	=item $offset = $line->offset_of ($row, $col)
		711
		712	Returns the character offset of the given row\|col pair within the logical
		713	line.
		714
		715	=item ($row, $col) = $line->coord_of ($offset)
		716
		717	Translates a string offset into terminal coordinates again.
		718
		719	=back
		720
		721	=cut
		722
		723	sub urxvt::term::line {
		724	my ($self, $row) = @_;
		725
		726	my $maxrow = $self->nrow - 1;
		727
		728	my ($beg, $end) = ($row, $row);
		729
		730	--$beg while $self->ROW_is_longer ($beg - 1);
		731	++$end while $self->ROW_is_longer ($end) && $end < $maxrow;
		732
		733	bless {
		734	term => $self,
		735	beg => $beg,
		736	end => $end,
		737	len => ($end - $beg) * $self->ncol + $self->ROW_l ($end),
		738	}, urxvt::line::
		739	}
		740
		741	sub urxvt::line::t {
		742	my ($self) = @_;
		743
		744	substr +(join "", map $self->{term}->ROW_t ($_), $self->{beg} .. $self->{end}),
		745	0, $self->{len}
		746	}
		747
		748	sub urxvt::line::r {
		749	my ($self) = @_;
		750
		751	my $rend = [
		752	map @{ $self->{term}->ROW_r ($_) }, $self->{beg} .. $self->{end}
		753	];
		754	$#$rend = $self->{len} - 1;
		755	$rend
		756	}
		757
		758	sub urxvt::line::beg { $_[0]{beg} }
		759	sub urxvt::line::end { $_[0]{end} }
		760	sub urxvt::line::l { $_[0]{len} }
		761
		762	sub urxvt::line::offset_of {
		763	my ($self, $row, $col) = @_;
		764
		765	($row - $self->{beg}) * $self->{term}->ncol + $col
		766	}
		767
		768	sub urxvt::line::coord_of {
		769	my ($self, $offset) = @_;
		770
		771	use integer;
		772
		773	(
		774	$offset / $self->{term}->ncol + $self->{beg},
		775	$offset % $self->{term}->ncol
		776	)
		777	}
		778
		779	=item ($row, $col) = $line->coord_of ($offset)
		780	=item $text = $term->special_encode $string
		781
		782	Converts a perl string into the special encoding used by rxvt-unicode,
		783	where one character corresponds to one screen cell. See
		784	C<< $term->ROW_t >> for details.
		785
		786	=item $string = $term->special_decode $text
		787
		788	Converts rxvt-unicodes text reprsentation into a perl string. See
		789	C<< $term->ROW_t >> for details.
295		790
296	=back	791	=back
297		792
298	=head2 The C<urxvt::timer> Class	793	=head2 The C<urxvt::timer> Class
299		794
300	This class implements timer watchers/events. Time is represented as a	795	This class implements timer watchers/events. Time is represented as a
301	fractional number of seconds since the epoch. Example:	796	fractional number of seconds since the epoch. Example:
302		797
303	# create a digital clock display in upper right corner	798	$term->{overlay} = $term->overlay (-1, 0, 8, 1, urxvt::OVERLAY_RSTYLE, 0);
304	$term->{timer} = urxvt::timer	799	$term->{timer} = urxvt::timer
305	->new	800	->new
306	->start (urxvt::NOW)	801	->interval (1)
307	->cb (sub {	802	->cb (sub {
308	my ($timer) = @_;
309	my $time = $timer->at;
310	$timer->start ($time + 1);
311	$self->scr_overlay (-1, 0,	803	$term->{overlay}->set (0, 0,
312	POSIX::strftime "%H:%M:%S", localtime $time);	804	sprintf "%2d:%02d:%02d", (localtime urxvt::NOW)[2,1,0]);
313	});	805	});
314		806
315	=over 4	807	=over 4
316		808
317	=item $timer = new urxvt::timer	809	=item $timer = new urxvt::timer
318		810
319	Create a new timer object in stopped state.	811	Create a new timer object in started state. It is scheduled to fire
		812	immediately.
320		813
321	=item $timer = $timer->cb (sub { my ($timer) = @_; ... })	814	=item $timer = $timer->cb (sub { my ($timer) = @_; ... })
322		815
323	Set the callback to be called when the timer triggers.	816	Set the callback to be called when the timer triggers.
324		817
…		…
327	Return the time this watcher will fire next.	820	Return the time this watcher will fire next.
328		821
329	=item $timer = $timer->set ($tstamp)	822	=item $timer = $timer->set ($tstamp)
330		823
331	Set the time the event is generated to $tstamp.	824	Set the time the event is generated to $tstamp.
		825
		826	=item $timer = $timer->interval ($interval)
		827
		828	Normally (and when C<$interval> is C<0>), the timer will automatically
		829	stop after it has fired once. If C<$interval> is non-zero, then the timer
		830	is automatically rescheduled at the given intervals.
332		831
333	=item $timer = $timer->start	832	=item $timer = $timer->start
334		833
335	Start the timer.	834	Start the timer.
336		835
…		…
390		889
391	Stop watching for events on the given filehandle.	890	Stop watching for events on the given filehandle.
392		891
393	=back	892	=back
394		893
		894	=head1 ENVIRONMENT
		895
		896	=head2 URXVT_PERL_VERBOSITY
		897
		898	This variable controls the verbosity level of the perl extension. Higher
		899	numbers indicate more verbose output.
		900
		901	=over 4
		902
		903	=item =0 - only fatal messages
		904
		905	=item =3 - script loading and management
		906
		907	=item =10 - all events received
		908
		909	=back
		910
395	=head1 AUTHOR	911	=head1 AUTHOR
396		912
397	Marc Lehmann <pcg@goof.com>	913	Marc Lehmann <pcg@goof.com>
398	http://software.schmorp.de/pkg/rxvt-unicode	914	http://software.schmorp.de/pkg/rxvt-unicode
399		915

Diff Legend

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

Comparing rxvt-unicode/src/urxvt.pm (file contents): Revision 1.2 by root, Mon Jan 2 15:36:27 2006 UTC vs. Revision 1.32 by root, Wed Jan 4 21:37:55 2006 UTC

Diff Legend

Comparing rxvt-unicode/src/urxvt.pm (file contents):
Revision 1.2 by root, Mon Jan 2 15:36:27 2006 UTC vs.
Revision 1.32 by root, Wed Jan 4 21:37:55 2006 UTC