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

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

Diff Legend

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

Comparing rxvt-unicode/src/urxvt.pm (file contents): Revision 1.3 by root, Mon Jan 2 15:59:25 2006 UTC vs. Revision 1.36 by root, Fri Jan 6 02:58:02 2006 UTC

Diff Legend

Comparing rxvt-unicode/src/urxvt.pm (file contents):
Revision 1.3 by root, Mon Jan 2 15:59:25 2006 UTC vs.
Revision 1.36 by root, Fri Jan 6 02:58:02 2006 UTC