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

Comparing rxvt-unicode/src/urxvt.pm (file contents):
Revision 1.5 by root, Mon Jan 2 17:20:00 2006 UTC vs.
Revision 1.35 by root, Fri Jan 6 01:27:27 2006 UTC

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

Diff Legend

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

Comparing rxvt-unicode/src/urxvt.pm (file contents): Revision 1.5 by root, Mon Jan 2 17:20:00 2006 UTC vs. Revision 1.35 by root, Fri Jan 6 01:27:27 2006 UTC

Diff Legend

Comparing rxvt-unicode/src/urxvt.pm (file contents):
Revision 1.5 by root, Mon Jan 2 17:20:00 2006 UTC vs.
Revision 1.35 by root, Fri Jan 6 01:27:27 2006 UTC