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

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.42 by root, Fri Jan 6 21:06:09 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.42 by root, Fri Jan 6 21:06:09 2006 UTC