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

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