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

Comparing rxvt-unicode/src/urxvt.pm (file contents):
Revision 1.15 by root, Tue Jan 3 01:39:17 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	@@RXVT_NAME@@perl - rxvt-unicode's embedded perl interpreter	5	@@RXVT_NAME@@perl - rxvt-unicode's embedded perl interpreter
4		6
5	=head1 SYNOPSIS	7	=head1 SYNOPSIS
15		17
16	@@RXVT_NAME@@ --perl-lib $HOME -pe grab_test	18	@@RXVT_NAME@@ --perl-lib $HOME -pe grab_test
17		19
18	=head1 DESCRIPTION	20	=head1 DESCRIPTION
19		21
20	Everytime a terminal object gets created, scripts specified via the	22	Everytime a terminal object gets created, extension scripts specified via
21	C<perl> resource are loaded and associated with it.	23	the C<perl> resource are loaded and associated with it.
22		24
23	Scripts are compiled in a 'use strict' and 'use utf8' environment, and	25	Scripts are compiled in a 'use strict' and 'use utf8' environment, and
24	thus must be encoded as UTF-8.	26	thus must be encoded as UTF-8.
25		27
26	Each script will only ever be loaded once, even in @@RXVT_NAME@@d, where	28	Each script will only ever be loaded once, even in @@RXVT_NAME@@d, where
27	scripts will be shared (But not enabled) for all terminals.	29	scripts will be shared (but not enabled) for all terminals.
28		30
29	=head1 PACKAGED EXTENSIONS	31	=head2 Prepackaged Extensions
30		32
31	This section describes the extensiosn delivered with this version. You can	33	This section describes the extensiosn delivered with this version. You can
32	find them in F<@@RXVT_LIBDIR@@/urxvt/perl/>.	34	find them in F<@@RXVT_LIBDIR@@/urxvt/perl/>.
33		35
34	You can activate them like this:	36	You can activate them like this:
…		…
37		39
38	=over 4	40	=over 4
39		41
40	=item selection	42	=item selection
41		43
42	Miscellaneous selection modifications.	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:
43		50
44	=over 4	51	=over 4
45		52
46	=item rot13	53	=item rot13
47		54
…		…
50	URxvt.keysym.C-M-r: perl:selection:rot13	57	URxvt.keysym.C-M-r: perl:selection:rot13
51		58
52	=back	59	=back
53		60
54	=item digital-clock	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
55		76
56	Displays a very simple digital clock in the upper right corner of the	77	Displays a very simple digital clock in the upper right corner of the
57	window. Illustrates overwriting the refresh callbacks to create your own	78	window. Illustrates overwriting the refresh callbacks to create your own
58	overlays or changes.	79	overlays or changes.
59		80
60	=item simple-overlay-clock
61
62	Displays a digital clock using the built-in overlay (colorful, useless).
63
64	=back	81	=back
65		82
66	=head2 General API Considerations	83	=head2 General API Considerations
67		84
68	All objects (such as terminals, time watchers etc.) are typical	85	All objects (such as terminals, time watchers etc.) are typical
69	reference-to-hash objects. The hash can be used to store anything you	86	reference-to-hash objects. The hash can be used to store anything you
70	like. All members starting with an underscore (such as C<_ptr> or	87	like. All members starting with an underscore (such as C<_ptr> or
71	C<_hook>) are reserved for internal uses and must not be accessed or	88	C<_hook>) are reserved for internal uses and B<MUST NOT> be accessed or
72	modified).	89	modified).
73		90
74	When objects are destroyed on the C++ side, the perl object hashes are	91	When objects are destroyed on the C++ side, the perl object hashes are
75	emptied, so its best to store related objects such as time watchers and	92	emptied, so its best to store related objects such as time watchers and
76	the like inside the terminal object so they get destroyed as soon as the	93	the like inside the terminal object so they get destroyed as soon as the
77	terminal is destroyed.	94	terminal is destroyed.
78		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
79	=head2 Hooks	119	=head2 Hooks
80		120
81	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
82	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.
83		130
84	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
85	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,
86	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.
87		134
…		…
90	=over 4	137	=over 4
91		138
92	=item on_init $term	139	=item on_init $term
93		140
94	Called after a new terminal object has been initialized, but before	141	Called after a new terminal object has been initialized, but before
95	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.
96		146
97	=item on_reset $term	147	=item on_reset $term
98		148
99	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
100	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
…		…
120	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
121	by calling C<< $term->selection >>.	171	by calling C<< $term->selection >>.
122		172
123	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.
124		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
125	=item on_focus_in $term	184	=item on_focus_in $term
126		185
127	Called whenever the window gets the keyboard focus, before urxvt does	186	Called whenever the window gets the keyboard focus, before urxvt does
128	focus in processing.	187	focus in processing.
129		188
…		…
149	number of lines that will be in the scrollback buffer.	208	number of lines that will be in the scrollback buffer.
150		209
151	=item on_tty_activity $term NYI	210	=item on_tty_activity $term NYI
152		211
153	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.
154		248
155	=item on_refresh_begin $term	249	=item on_refresh_begin $term
156		250
157	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
158	or similar effects by modify terminal contents in refresh_begin, and	252	or similar effects by modify terminal contents in refresh_begin, and
…		…
167		261
168	Called whenever the user presses a key combination that has a	262	Called whenever the user presses a key combination that has a
169	C<perl:string> action bound to it (see description of the B<keysym>	263	C<perl:string> action bound to it (see description of the B<keysym>
170	resource in the @@RXVT_NAME@@(1) manpage).	264	resource in the @@RXVT_NAME@@(1) manpage).
171		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
172	=back	299	=back
173		300
174	=head2 Functions in the C<urxvt> Package	301	=head2 Functions in the C<urxvt> Package
175		302
176	=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.
177		312
178	=item urxvt::fatal $errormessage	313	=item urxvt::fatal $errormessage
179		314
180	Fatally aborts execution with the given error message. Avoid at all	315	Fatally aborts execution with the given error message. Avoid at all
181	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
…		…
192		327
193	=item $time = urxvt::NOW	328	=item $time = urxvt::NOW
194		329
195	Returns the "current time" (as per the event loop).	330	Returns the "current time" (as per the event loop).
196		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
197	=cut	386	=cut
198		387
199	package urxvt;	388	package urxvt;
200		389
201	use strict;	390	use strict;
		391	use Scalar::Util ();
202		392
203	our $term;	393	our $TERM;
204	our @HOOKNAME;	394	our @HOOKNAME;
205	our $LIBDIR;	395	our $LIBDIR;
206		396
207	BEGIN {	397	BEGIN {
208	urxvt->bootstrap;	398	urxvt->bootstrap;
…		…
233	my $name = $HOOKNAME[$htype];	423	my $name = $HOOKNAME[$htype];
234		424
235	my $ref = $pkg->can ("on_" . lc $name)	425	my $ref = $pkg->can ("on_" . lc $name)
236	or next;	426	or next;
237		427
238	$term->{_hook}[$htype]{$ref*1} = $ref;	428	$TERM->{_hook}[$htype]{$pkg} = $ref;
239	$hook_count[$htype]++	429	$hook_count[$htype]++
240	or set_should_invoke $htype, 1;	430	or set_should_invoke $htype, 1;
241	}	431	}
242	}	432	}
243		433
244	my $script_pkg = "script0000";	434	my $extension_pkg = "extension0000";
245	my %script_pkg;	435	my %extension_pkg;
246		436
247	# load a single script into its own package, once only	437	# load a single script into its own package, once only
248	sub script_package($) {	438	sub extension_package($) {
249	my ($path) = @_;	439	my ($path) = @_;
250		440
251	$script_pkg{$path} \|\|= do {	441	$extension_pkg{$path} \|\|= do {
252	my $pkg = "urxvt::" . ($script_pkg++);	442	my $pkg = "urxvt::" . ($extension_pkg++);
253		443
254	verbose 3, "loading script '$path' into package '$pkg'";	444	verbose 3, "loading extension '$path' into package '$pkg'";
255		445
256	open my $fh, "<:raw", $path	446	open my $fh, "<:raw", $path
257	or die "$path: $!";	447	or die "$path: $!";
258		448
259	my $source = "package $pkg; use strict; use utf8;\n"	449	my $source = "package $pkg; use strict; use utf8;\n"
		450	. "use base urxvt::term::proxy::;\n"
260	. "#line 1 \"$path\"\n{\n"	451	. "#line 1 \"$path\"\n{\n"
261	. (do { local $/; <$fh> })	452	. (do { local $/; <$fh> })
262	. "\n};\n1";	453	. "\n};\n1";
263		454
264	eval $source or die "$path: $@";	455	eval $source or die "$path: $@";
265		456
266	$pkg	457	$pkg
267	}	458	}
268	}	459	}
269		460
		461	our $retval; # return value for urxvt
		462
270	# called by the rxvt core	463	# called by the rxvt core
271	sub invoke {	464	sub invoke {
272	local $term = shift;	465	local $TERM = shift;
273	my $htype = shift;	466	my $htype = shift;
274		467
275	if ($htype == 0) { # INIT	468	if ($htype == 0) { # INIT
276	my @dirs = ((split /:/, $term->resource ("perl_lib")), "$LIBDIR/perl");	469	my @dirs = ((split /:/, $TERM->resource ("perl_lib")), "$LIBDIR/perl");
277		470
278	for my $ext (split /:/, $term->resource ("perl_ext")) {	471	for my $ext (map { split /,/, $TERM->resource ("perl_ext_$_") } 1, 2) {
279	my @files = grep -f $_, map "$_/$ext", @dirs;	472	my @files = grep -f $_, map "$_/$ext", @dirs;
280		473
281	if (@files) {	474	if (@files) {
282	register_package script_package $files[0];	475	register_package extension_package $files[0];
283	} else {	476	} else {
284	warn "perl extension '$ext' not found in perl library search path\n";	477	warn "perl extension '$ext' not found in perl library search path\n";
285	}	478	}
286	}	479	}
		480	}
287		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
288	} elsif ($htype == 1) { # DESTROY	505	if ($htype == 1) { # DESTROY
		506	# remove hooks if unused
289	if (my $hook = $term->{_hook}) {	507	if (my $hook = $TERM->{_hook}) {
290	for my $htype (0..$#$hook) {	508	for my $htype (0..$#$hook) {
291	$hook_count[$htype] -= scalar keys %{ $hook->[$htype] \|\| {} }	509	$hook_count[$htype] -= scalar keys %{ $hook->[$htype] \|\| {} }
292	or set_should_invoke $htype, 0;	510	or set_should_invoke $htype, 0;
293	}	511	}
294	}	512	}
		513
		514	# clear package objects
		515	%$_ = () for values %{ $TERM->{_pkg} };
		516
		517	# clear package
		518	%$TERM = ();
295	}	519	}
296		520
297	my $cb = $term->{_hook}[$htype]	521	$retval
298	or return;
299
300	verbose 10, "$HOOKNAME[$htype] (" . (join ", ", $term, @_) . ")"
301	if $verbosity >= 10;
302
303	while (my ($k, $v) = each %$cb) {
304	return 1 if $v->($term, @_);
305	}
306
307	0
308	}	522	}
309		523
310	=back	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	}
311		538
312	=head2 The C<urxvt::term> Class	539	=head2 The C<urxvt::term> Class
313		540
314	=over 4	541	=over 4
		542
		543	=item $term->destroy
		544
		545	Destroy the terminal object (close the window, free resources etc.).
315		546
316	=item $value = $term->resource ($name[, $newval])	547	=item $value = $term->resource ($name[, $newval])
317		548
318	Returns the current resource value associated with a given name and	549	Returns the current resource value associated with a given name and
319	optionally sets a new value. Setting values is most useful in the C<init>	550	optionally sets a new value. Setting values is most useful in the C<init>
…		…
337	answerbackstring backgroundPixmap backspace_key boldFont boldItalicFont	568	answerbackstring backgroundPixmap backspace_key boldFont boldItalicFont
338	borderLess color cursorBlink cursorUnderline cutchars delete_key	569	borderLess color cursorBlink cursorUnderline cutchars delete_key
339	display_name embed ext_bwidth fade font geometry hold iconName	570	display_name embed ext_bwidth fade font geometry hold iconName
340	imFont imLocale inputMethod insecure int_bwidth intensityStyles	571	imFont imLocale inputMethod insecure int_bwidth intensityStyles
341	italicFont jumpScroll lineSpace loginShell mapAlert menu meta8 modifier	572	italicFont jumpScroll lineSpace loginShell mapAlert menu meta8 modifier
342	mouseWheelScrollPage name pastableTabs path perl_eval perl_ext	573	mouseWheelScrollPage name pastableTabs path perl_eval perl_ext_1 perl_ext_2
343	perl_lib pointerBlank pointerBlankDelay preeditType print_pipe pty_fd	574	perl_lib pointerBlank pointerBlankDelay preeditType print_pipe pty_fd
344	reverseVideo saveLines scrollBar scrollBar_align scrollBar_floating	575	reverseVideo saveLines scrollBar scrollBar_align scrollBar_floating
345	scrollBar_right scrollBar_thickness scrollTtyKeypress scrollTtyOutput	576	scrollBar_right scrollBar_thickness scrollTtyKeypress scrollTtyOutput
346	scrollWithBuffer scrollstyle secondaryScreen secondaryScroll selectstyle	577	scrollWithBuffer scrollstyle secondaryScreen secondaryScroll selectstyle
347	shade term_name title transparent transparent_all tripleclickwords	578	shade term_name title transparent transparent_all tripleclickwords
…		…
353	my ($self, $name) = (shift, shift);	584	my ($self, $name) = (shift, shift);
354	unshift @_, $self, $name, ($name =~ s/\s\+\s(\d+)$// ? $1 : 0);	585	unshift @_, $self, $name, ($name =~ s/\s\+\s(\d+)$// ? $1 : 0);
355	goto &urxvt::term::_resource;	586	goto &urxvt::term::_resource;
356	}	587	}
357		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).
		598
358	=item ($row, $col) = $term->selection_mark ([$row, $col])	599	=item ($row, $col) = $term->selection_mark ([$row, $col])
359		600
360	=item ($row, $col) = $term->selection_beg ([$row, $col])	601	=item ($row, $col) = $term->selection_beg ([$row, $col])
361		602
362	=item ($row, $col) = $term->selection_end ([$row, $col])	603	=item ($row, $col) = $term->selection_end ([$row, $col])
…		…
371		612
372	=item $oldtext = $term->selection ([$newtext])	613	=item $oldtext = $term->selection ([$newtext])
373		614
374	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>.
375		616
376	=item $term->scr_overlay ($x, $y, $text)	617	#=item $term->overlay ($x, $y, $text)
377		618	#
378	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.
379		620	#
380	=cut	621	#=cut
381		622	#
382	sub urxvt::term::scr_overlay {	623	#sub urxvt::term::scr_overlay {
383	my ($self, $x, $y, $text) = @_;	624	# my ($self, $x, $y, $text) = @_;
384		625	#
385	my @lines = split /\n/, $text;	626	# my @lines = split /\n/, $text;
386		627	#
387	my $w = 0;	628	# my $w = 0;
388	for (map $self->strwidth ($_), @lines) {	629	# for (map $self->strwidth ($_), @lines) {
389	$w = $_ if $w < $_;	630	# $w = $_ if $w < $_;
390	}	631	# }
391		632	#
392	$self->scr_overlay_new ($x, $y, $w, scalar @lines);	633	# $self->scr_overlay_new ($x, $y, $w, scalar @lines);
393	$self->scr_overlay_set (0, $_, $lines[$_]) for 0.. $#lines;	634	# $self->scr_overlay_set (0, $_, $lines[$_]) for 0.. $#lines;
394	}	635	#}
395		636
396	=item $term->scr_overlay_new ($x, $y, $width, $height)	637	=item $term->overlay ($x, $y, $width, $height[, $rstyle[, $border]])
397		638
398	Create a new (empty) overlay at the given position with the given	639	Create a new (empty) overlay at the given position with the given
399	width/height. A border will be put around the box. If either C<$x> or	640	width/height. C<$rstyle> defines the initial rendition style
400	C<$y> is negative, then this is counted from the right/bottom side,	641	(default: C<OVERLAY_RSTYLE>).
401	respectively.
402		642
403	=item $term->scr_overlay_off	643	If C<$border> is C<2> (default), then a decorative border will be put
		644	around the box.
404		645
405	Switch the overlay off again.	646	If either C<$x> or C<$y> is negative, then this is counted from the
		647	right/bottom side, respectively.
406		648
407	=item $term->scr_overlay_set_char ($x, $y, $char, $rend = OVERLAY_RSTYLE)	649	This method returns an urxvt::overlay object. The overlay will be visible
		650	as long as the perl object is referenced.
408		651
409	Put a single character (specified numerically) at the given overlay	652	The methods currently supported on C<urxvt::overlay> objects are:
410	position.
411		653
		654	=over 4
		655
412	=item $term->scr_overlay_set ($x, $y, $text)	656	=item $overlay->set ($x, $y, $text, $rend)
413		657
414	Write a string at the given position into the overlay.	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.
415		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
416	=item $cellwidth = $term->strwidth $string	672	=item $cellwidth = $term->strwidth ($string)
417		673
418	Returns the number of screen-cells this string would need. Correctly	674	Returns the number of screen-cells this string would need. Correctly
419	accounts for wide and combining characters.	675	accounts for wide and combining characters.
420		676
421	=item $octets = $term->locale_encode $string	677	=item $octets = $term->locale_encode ($string)
422		678
423	Convert the given text string into the corresponding locale encoding.	679	Convert the given text string into the corresponding locale encoding.
424		680
425	=item $string = $term->locale_decode $octets	681	=item $string = $term->locale_decode ($octets)
426		682
427	Convert the given locale-encoded octets into a perl string.	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.
428		701
429	=item $term->tt_write ($octets)	702	=item $term->tt_write ($octets)
430		703
431	Write the octets given in C<$data> to the tty (i.e. as program input). To	704	Write the octets given in C<$data> to the tty (i.e. as program input). To
432	pass characters instead of octets, you should convert your strings first	705	pass characters instead of octets, you should convert your strings first
433	to the locale-specific encoding using C<< $term->locale_encode >>.	706	to the locale-specific encoding using C<< $term->locale_encode >>.
434		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
435	=item $nrow = $term->nrow	726	=item $terminal_rows = $term->nrow
436		727
437	=item $ncol = $term->ncol	728	=item $terminal_columns = $term->ncol
438		729
439	Return the number of rows/columns of the terminal window (i.e. as	730	=item $has_focus = $term->focus
440	specified by C<-geometry>, excluding any scrollback).
441		731
442	=item $nsaved = $term->nsaved	732	=item $is_mapped = $term->mapped
443		733
444	Returns the number of lines in the scrollback buffer.	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.
445		741
446	=item $view_start = $term->view_start ([$newvalue])	742	=item $view_start = $term->view_start ([$newvalue])
447		743
448	Returns the negative row number of the topmost line. Minimum value is	744	Returns the negative row number of the topmost line. Minimum value is
449	C<0>, which displays the normal terminal contents. Larger values scroll	745	C<0>, which displays the normal terminal contents. Larger values scroll
…		…
460	=item $text = $term->ROW_t ($row_number[, $new_text[, $start_col]])	756	=item $text = $term->ROW_t ($row_number[, $new_text[, $start_col]])
461		757
462	Returns the text of the entire row with number C<$row_number>. Row C<0>	758	Returns the text of the entire row with number C<$row_number>. Row C<0>
463	is the topmost terminal line, row C<< $term->$ncol-1 >> is the bottommost	759	is the topmost terminal line, row C<< $term->$ncol-1 >> is the bottommost
464	terminal line. The scrollback buffer starts at line C<-1> and extends to	760	terminal line. The scrollback buffer starts at line C<-1> and extends to
465	line C<< -$term->nsaved >>.	761	line C<< -$term->nsaved >>. Nothing will be returned if a nonexistent line
		762	is requested.
466		763
467	If C<$new_text> is specified, it will replace characters in the current	764	If C<$new_text> is specified, it will replace characters in the current
468	line, starting at column C<$start_col> (default C<0>), which is useful	765	line, starting at column C<$start_col> (default C<0>), which is useful
469	to replace only parts of a line. The font iindex in the rendition will	766	to replace only parts of a line. The font index in the rendition will
470	automatically be updated.	767	automatically be updated.
471		768
472	C<$text> is in a special encoding: tabs and wide characters that use more	769	C<$text> is in a special encoding: tabs and wide characters that use more
473	than one cell when displayed are padded with urxvt::NOCHAR characters	770	than one cell when displayed are padded with urxvt::NOCHAR characters
474	(C<chr 65535>). Characters with combining characters and other characters	771	(C<chr 65535>). Characters with combining characters and other characters
…		…
488	bitsets. Rendition bitsets contain information about colour, font, font	785	bitsets. Rendition bitsets contain information about colour, font, font
489	styles and similar information. See also C<< $term->ROW_t >>.	786	styles and similar information. See also C<< $term->ROW_t >>.
490		787
491	When setting rendition, the font mask will be ignored.	788	When setting rendition, the font mask will be ignored.
492		789
493	See the section on RENDITION, below.	790	See the section on RENDITION, above.
494		791
495	=item $length = $term->ROW_l ($row_number[, $new_length])	792	=item $length = $term->ROW_l ($row_number[, $new_length])
496		793
497	Returns the number of screen cells that are in use ("the line length"). If	794	Returns the number of screen cells that are in use ("the line
498	it is C<-1>, then the line is part of a multiple-row logical "line", which	795	length"). Unlike the urxvt core, this returns C<< $term->ncol >> if the
499	means all characters are in use and it is continued on the next row.	796	line is joined with the following one.
500		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
		841
		842	=cut
		843
		844	sub urxvt::term::line {
		845	my ($self, $row) = @_;
		846
		847	my $maxrow = $self->nrow - 1;
		848
		849	my ($beg, $end) = ($row, $row);
		850
		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;
		892	}
		893
		894	()
		895	}
		896
		897	sub urxvt::line::beg { $_[0]{beg} }
		898	sub urxvt::line::end { $_[0]{end} }
		899	sub urxvt::line::l { $_[0]{len} }
		900
		901	sub urxvt::line::offset_of {
		902	my ($self, $row, $col) = @_;
		903
		904	($row - $self->{beg}) * $self->{ncol} + $col
		905	}
		906
		907	sub urxvt::line::coord_of {
		908	my ($self, $offset) = @_;
		909
		910	use integer;
		911
		912	(
		913	$offset / $self->{ncol} + $self->{beg},
		914	$offset % $self->{ncol}
		915	)
		916	}
		917
		918	=item ($row, $col) = $line->coord_of ($offset)
501	=item $text = $term->special_encode $string	919	=item $text = $term->special_encode $string
502		920
503	Converts a perl string into the special encoding used by rxvt-unicode,	921	Converts a perl string into the special encoding used by rxvt-unicode,
504	where one character corresponds to one screen cell. See	922	where one character corresponds to one screen cell. See
505	C<< $term->ROW_t >> for details.	923	C<< $term->ROW_t >> for details.
…		…
509	Converts rxvt-unicodes text reprsentation into a perl string. See	927	Converts rxvt-unicodes text reprsentation into a perl string. See
510	C<< $term->ROW_t >> for details.	928	C<< $term->ROW_t >> for details.
511		929
512	=back	930	=back
513		931
514	=head2 RENDITION
515
516	Rendition bitsets contain information about colour, font, font styles and
517	similar information for each screen cell.
518
519	The following "macros" deal with changes in rendition sets. You should
520	never just create a bitset, you should always modify an existing one,
521	as they contain important information required for correct operation of
522	rxvt-unicode.
523
524	=over 4
525
526	=item $rend = urxvt::DEFAULT_RSTYLE
527
528	Returns the default rendition, as used when the terminal is starting up or
529	being reset. Useful as a base
530
531	=back
532
533	=cut
534
535	=head2 The C<urxvt::timer> Class	932	=head2 The C<urxvt::timer> Class
536		933
537	This class implements timer watchers/events. Time is represented as a	934	This class implements timer watchers/events. Time is represented as a
538	fractional number of seconds since the epoch. Example:	935	fractional number of seconds since the epoch. Example:
539		936
540	# create a digital clock display in upper right corner	937	$term->{overlay} = $term->overlay (-1, 0, 8, 1, urxvt::OVERLAY_RSTYLE, 0);
541	$term->{timer} = urxvt::timer	938	$term->{timer} = urxvt::timer
542	->new	939	->new
543	->start (urxvt::NOW)	940	->interval (1)
544	->cb (sub {	941	->cb (sub {
545	my ($timer) = @_;
546	my $time = $timer->at;
547	$timer->start ($time + 1);
548	$self->scr_overlay (-1, 0,	942	$term->{overlay}->set (0, 0,
549	POSIX::strftime "%H:%M:%S", localtime $time);	943	sprintf "%2d:%02d:%02d", (localtime urxvt::NOW)[2,1,0]);
550	});	944	});
551		945
552	=over 4	946	=over 4
553		947
554	=item $timer = new urxvt::timer	948	=item $timer = new urxvt::timer
555		949
556	Create a new timer object in stopped state.	950	Create a new timer object in started state. It is scheduled to fire
		951	immediately.
557		952
558	=item $timer = $timer->cb (sub { my ($timer) = @_; ... })	953	=item $timer = $timer->cb (sub { my ($timer) = @_; ... })
559		954
560	Set the callback to be called when the timer triggers.	955	Set the callback to be called when the timer triggers.
561		956
…		…
564	Return the time this watcher will fire next.	959	Return the time this watcher will fire next.
565		960
566	=item $timer = $timer->set ($tstamp)	961	=item $timer = $timer->set ($tstamp)
567		962
568	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.
569		970
570	=item $timer = $timer->start	971	=item $timer = $timer->start
571		972
572	Start the timer.	973	Start the timer.
573		974
…		…
636	This variable controls the verbosity level of the perl extension. Higher	1037	This variable controls the verbosity level of the perl extension. Higher
637	numbers indicate more verbose output.	1038	numbers indicate more verbose output.
638		1039
639	=over 4	1040	=over 4
640		1041
641	=item 0 - only fatal messages	1042	=item =0 - only fatal messages
642		1043
643	=item 3 - script loading and management	1044	=item =3 - script loading and management
644		1045
645	=item 10 - all events received	1046	=item =10 - all events received
646		1047
647	=back	1048	=back
648		1049
649	=head1 AUTHOR	1050	=head1 AUTHOR
650		1051

Diff Legend

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

Comparing rxvt-unicode/src/urxvt.pm (file contents): Revision 1.15 by root, Tue Jan 3 01:39:17 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.15 by root, Tue Jan 3 01:39:17 2006 UTC vs.
Revision 1.44 by root, Sat Jan 7 19:29:17 2006 UTC