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

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

Diff Legend

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

Comparing rxvt-unicode/src/urxvt.pm (file contents): Revision 1.1 by root, Mon Jan 2 15:35:43 2006 UTC vs. Revision 1.44 by root, Sat Jan 7 19:29:17 2006 UTC

Diff Legend

Comparing rxvt-unicode/src/urxvt.pm (file contents):
Revision 1.1 by root, Mon Jan 2 15:35:43 2006 UTC vs.
Revision 1.44 by root, Sat Jan 7 19:29:17 2006 UTC