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

Comparing rxvt-unicode/src/urxvt.pm (file contents):
Revision 1.30 by root, Wed Jan 4 05:35:34 2006 UTC vs.
Revision 1.54 by root, Sun Jan 8 01:59:29 2006 UTC

…		…
17		17
18	@@RXVT_NAME@@ --perl-lib $HOME -pe grab_test	18	@@RXVT_NAME@@ --perl-lib $HOME -pe grab_test
19		19
20	=head1 DESCRIPTION	20	=head1 DESCRIPTION
21		21
22	Everytime a terminal object gets created, scripts specified via the	22	Everytime a terminal object gets created, extension scripts specified via
23	C<perl> resource are loaded and associated with it.	23	the C<perl> resource are loaded and associated with it.
24		24
25	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
26	thus must be encoded as UTF-8.	26	thus must be encoded as UTF-8.
27		27
28	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
…		…
37		37
38	@@RXVT_NAME@@ -pe <extensionname>	38	@@RXVT_NAME@@ -pe <extensionname>
39		39
40	=over 4	40	=over 4
41		41
42	=item selection	42	=item selection (enabled by default)
43		43
44	Intelligent selection. This extension tries to be more intelligent when	44	Intelligent selection. This extension tries to be more intelligent when
45	the user extends selections (double-click). Right now, it tries to select	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,	46	urls and complete shell-quoted arguments, which is very convenient, too,
47	if your F<ls> supports C<--quoting-style=shell>.	47	if your F<ls> supports C<--quoting-style=shell>.
…		…
56		56
57	URxvt.keysym.C-M-r: perl:selection:rot13	57	URxvt.keysym.C-M-r: perl:selection:rot13
58		58
59	=back	59	=back
60		60
		61	=item option-popup (enabled by default)
		62
		63	Binds a popup menu to Ctrl-Button3 that lets you toggle (some) options at
		64	runtime.
		65
61	=item digital-clock	66	=item digital-clock
62		67
63	Displays a digital clock using the built-in overlay.	68	Displays a digital clock using the built-in overlay.
		69
		70	=item mark-urls
		71
		72	Uses per-line display filtering (C<on_line_update>) to underline urls.
		73
		74	=item block-graphics-to-ascii
		75
		76	A not very useful example of filtering all text output to the terminal,
		77	by replacing all line-drawing characters (U+2500 .. U+259F) by a
		78	similar-looking ascii character.
64		79
65	=item example-refresh-hooks	80	=item example-refresh-hooks
66		81
67	Displays a very simple digital clock in the upper right corner of the	82	Displays a very simple digital clock in the upper right corner of the
68	window. Illustrates overwriting the refresh callbacks to create your own	83	window. Illustrates overwriting the refresh callbacks to create your own
…		…
81	When objects are destroyed on the C++ side, the perl object hashes are	96	When objects are destroyed on the C++ side, the perl object hashes are
82	emptied, so its best to store related objects such as time watchers and	97	emptied, so its best to store related objects such as time watchers and
83	the like inside the terminal object so they get destroyed as soon as the	98	the like inside the terminal object so they get destroyed as soon as the
84	terminal is destroyed.	99	terminal is destroyed.
85		100
		101	Argument names also often indicate the type of a parameter. Here are some
		102	hints on what they mean:
		103
		104	=over 4
		105
		106	=item $text
		107
		108	Rxvt-unicodes special way of encoding text, where one "unicode" character
		109	always represents one screen cell. See L<row_t> for a discussion of this format.
		110
		111	=item $string
		112
		113	A perl text string, with an emphasis on I<text>. It can store all unicode
		114	characters and is to be distinguished with text encoded in a specific
		115	encoding (often locale-specific) and binary data.
		116
		117	=item $octets
		118
		119	Either binary data or - more common - a text string encoded in a
		120	locale-specific way.
		121
		122	=back
		123
86	=head2 Hooks	124	=head2 Hooks
87		125
88	The following subroutines can be declared in loaded scripts, and will be	126	The following subroutines can be declared in extension files, and will be
89	called whenever the relevant event happens.	127	called whenever the relevant event happens.
90		128
91	The first argument passed to them is an object private to each terminal	129	The first argument passed to them is an object private to each terminal
92	and extension package. You can call all C<urxvt::term> methods on it, but	130	and extension package. You can call all C<urxvt::term> methods on it, but
93	its not a real C<urxvt::term> object. Instead, the real C<urxvt::term>	131	its not a real C<urxvt::term> object. Instead, the real C<urxvt::term>
94	object that is shared between all packages is stored in the C<term>	132	object that is shared between all packages is stored in the C<term>
95	member.	133	member. It is, however, blessed intot he package of the extension script,
		134	so for all practical purposes you can treat an extension script as a class.
96		135
97	All of them must return a boolean value. If it is true, then the event	136	All of them must return a boolean value. If it is true, then the event
98	counts as being I<consumed>, and the invocation of other hooks is skipped,	137	counts as being I<consumed>, and the invocation of other hooks is skipped,
99	and the relevant action might not be carried out by the C++ code.	138	and the relevant action might not be carried out by the C++ code.
100		139
…		…
103	=over 4	142	=over 4
104		143
105	=item on_init $term	144	=item on_init $term
106		145
107	Called after a new terminal object has been initialized, but before	146	Called after a new terminal object has been initialized, but before
108	windows are created or the command gets run.	147	windows are created or the command gets run. Most methods are unsafe to
		148	call or deliver senseless data, as terminal size and other characteristics
		149	have not yet been determined. You can safely query and change resources,
		150	though.
109		151
110	=item on_reset $term	152	=item on_reset $term
111		153
112	Called after the screen is "reset" for any reason, such as resizing or	154	Called after the screen is "reset" for any reason, such as resizing or
113	control sequences. Here is where you can react on changes to size-related	155	control sequences. Here is where you can react on changes to size-related
…		…
141	click) and is either supposed to return false (normal operation), or	183	click) and is either supposed to return false (normal operation), or
142	should extend the selection itelf and return true to suppress the built-in	184	should extend the selection itelf and return true to suppress the built-in
143	processing.	185	processing.
144		186
145	See the F<selection> example extension.	187	See the F<selection> example extension.
146
147	=item on_focus_in $term
148
149	Called whenever the window gets the keyboard focus, before urxvt does
150	focus in processing.
151
152	=item on_focus_out $term
153
154	Called wheneever the window loses keyboard focus, before urxvt does focus
155	out processing.
156		188
157	=item on_view_change $term, $offset	189	=item on_view_change $term, $offset
158		190
159	Called whenever the view offset changes, i..e the user or program	191	Called whenever the view offset changes, i..e the user or program
160	scrolls. Offset C<0> means display the normal terminal, positive values	192	scrolls. Offset C<0> means display the normal terminal, positive values
…		…
185		217
186	Be careful not ever to trust (in a security sense) the data you receive,	218	Be careful not ever to trust (in a security sense) the data you receive,
187	as its source can not easily be controleld (e-mail content, messages from	219	as its source can not easily be controleld (e-mail content, messages from
188	other users on the same system etc.).	220	other users on the same system etc.).
189		221
		222	=item on_add_lines $term, $string
		223
		224	Called whenever text is about to be output, with the text as argument. You
		225	can filter/change and output the text yourself by returning a true value
		226	and calling C<< $term->scr_add_lines >> yourself. Please note that this
		227	might be very slow, however, as your hook is called for B<all> text being
		228	output.
		229
		230	=item on_line_update $term, $row
		231
		232	Called whenever a line was updated or changed. Can be used to filter
		233	screen output (e.g. underline urls or other useless stuff). Only lines
		234	that are being shown will be filtered, and, due to performance reasons,
		235	not always immediately.
		236
		237	The row number is always the topmost row of the line if the line spans
		238	multiple rows.
		239
		240	Please note that, if you change the line, then the hook might get called
		241	later with the already-modified line (e.g. if unrelated parts change), so
		242	you cannot just toggle rendition bits, but only set them.
		243
190	=item on_refresh_begin $term	244	=item on_refresh_begin $term
191		245
192	Called just before the screen gets redrawn. Can be used for overlay	246	Called just before the screen gets redrawn. Can be used for overlay
193	or similar effects by modify terminal contents in refresh_begin, and	247	or similar effects by modify terminal contents in refresh_begin, and
194	restoring them in refresh_end. The built-in overlay and selection display	248	restoring them in refresh_end. The built-in overlay and selection display
…		…
202		256
203	Called whenever the user presses a key combination that has a	257	Called whenever the user presses a key combination that has a
204	C<perl:string> action bound to it (see description of the B<keysym>	258	C<perl:string> action bound to it (see description of the B<keysym>
205	resource in the @@RXVT_NAME@@(1) manpage).	259	resource in the @@RXVT_NAME@@(1) manpage).
206		260
		261	=item on_focus_in $term
		262
		263	Called whenever the window gets the keyboard focus, before rxvt-unicode
		264	does focus in processing.
		265
		266	=item on_focus_out $term
		267
		268	Called wheneever the window loses keyboard focus, before rxvt-unicode does
		269	focus out processing.
		270
		271	=item on_key_press $term, $event, $octets
		272
		273	=item on_key_release $term, $event
		274
		275	=item on_button_press $term, $event
		276
		277	=item on_button_release $term, $event
		278
		279	=item on_motion_notify $term, $event
		280
		281	=item on_map_notify $term, $event
		282
		283	=item on_unmap_notify $term, $event
		284
		285	Called whenever the corresponding X event is received for the terminal If
		286	the hook returns true, then the even will be ignored by rxvt-unicode.
		287
		288	The event is a hash with most values as named by Xlib (see the XEvent
		289	manpage), with the additional members C<row> and C<col>, which are the row
		290	and column under the mouse cursor.
		291
		292	C<on_key_press> additionally receives the string rxvt-unicode would
		293	output, if any, in locale-specific encoding.
		294
		295	subwindow.
		296
207	=back	297	=back
208		298
209	=head2 Variables in the C<urxvt> Package	299	=head2 Variables in the C<urxvt> Package
210		300
211	=over 4	301	=over 4
212		302
213	=item $urxvt::TERM	303	=item $urxvt::TERM
214		304
215	The current terminal. Whenever a callback/Hook is bein executed, this	305	The current terminal. This variable stores the current C<urxvt::term>
216	variable stores the current C<urxvt::term> object.	306	object, whenever a callback/hook is executing.
217		307
218	=back	308	=back
219		309
220	=head2 Functions in the C<urxvt> Package	310	=head2 Functions in the C<urxvt> Package
221		311
222	=over 4	312	=over 4
		313
		314	=item $term = new urxvt [arg...]
		315
		316	Creates a new terminal, very similar as if you had started it with
		317	C<system $binfile, arg...>. Croaks (and probably outputs an error message)
		318	if the new instance couldn't be created. Returns C<undef> if the new
		319	instance didn't initialise perl, and the terminal object otherwise. The
		320	C<init> and C<start> hooks will be called during the call.
223		321
224	=item urxvt::fatal $errormessage	322	=item urxvt::fatal $errormessage
225		323
226	Fatally aborts execution with the given error message. Avoid at all	324	Fatally aborts execution with the given error message. Avoid at all
227	costs! The only time this is acceptable is when the terminal process	325	costs! The only time this is acceptable is when the terminal process
…		…
237	correct place, e.g. on stderr of the connecting urxvtc client.	335	correct place, e.g. on stderr of the connecting urxvtc client.
238		336
239	=item $time = urxvt::NOW	337	=item $time = urxvt::NOW
240		338
241	Returns the "current time" (as per the event loop).	339	Returns the "current time" (as per the event loop).
		340
		341	=item urxvt::CurrentTime
		342
		343	=item urxvt::ShiftMask, LockMask, ControlMask, Mod1Mask, Mod2Mask,
		344	Mod3Mask, Mod4Mask, Mod5Mask, Button1Mask, Button2Mask, Button3Mask,
		345	Button4Mask, Button5Mask, AnyModifier
		346
		347	Various constants for use in X events.
242		348
243	=back	349	=back
244		350
245	=head2 RENDITION	351	=head2 RENDITION
246		352
…		…
296		402
297	=cut	403	=cut
298		404
299	package urxvt;	405	package urxvt;
300		406
		407	use utf8;
301	use strict;	408	use strict;
302	use Scalar::Util ();	409	use Scalar::Util ();
		410	use List::Util ();
303		411
304	our $TERM;	412	our $TERM;
305	our @HOOKNAME;	413	our @HOOKNAME;
		414	our %OPTION;
306	our $LIBDIR;	415	our $LIBDIR;
307		416
308	BEGIN {	417	BEGIN {
309	urxvt->bootstrap;	418	urxvt->bootstrap;
310		419
…		…
340	$hook_count[$htype]++	449	$hook_count[$htype]++
341	or set_should_invoke $htype, 1;	450	or set_should_invoke $htype, 1;
342	}	451	}
343	}	452	}
344		453
345	my $script_pkg = "script0000";	454	my $extension_pkg = "extension0000";
346	my %script_pkg;	455	my %extension_pkg;
347		456
348	# load a single script into its own package, once only	457	# load a single script into its own package, once only
349	sub script_package($) {	458	sub extension_package($) {
350	my ($path) = @_;	459	my ($path) = @_;
351		460
352	$script_pkg{$path} \|\|= do {	461	$extension_pkg{$path} \|\|= do {
353	my $pkg = "urxvt::" . ($script_pkg++);	462	my $pkg = "urxvt::" . ($extension_pkg++);
354		463
355	verbose 3, "loading script '$path' into package '$pkg'";	464	verbose 3, "loading extension '$path' into package '$pkg'";
356		465
357	open my $fh, "<:raw", $path	466	open my $fh, "<:raw", $path
358	or die "$path: $!";	467	or die "$path: $!";
359		468
360	my $source = "package $pkg; use strict; use utf8;\n"	469	my $source = "package $pkg; use strict; use utf8;\n"
		470	. "use base urxvt::term::proxy::;\n"
361	. "#line 1 \"$path\"\n{\n"	471	. "#line 1 \"$path\"\n{\n"
362	. (do { local $/; <$fh> })	472	. (do { local $/; <$fh> })
363	. "\n};\n1";	473	. "\n};\n1";
364		474
365	eval $source or die "$path: $@";	475	eval $source or die "$path: $@";
366		476
367	$pkg	477	$pkg
368	}	478	}
369	}	479	}
		480
		481	our $retval; # return value for urxvt
370		482
371	# called by the rxvt core	483	# called by the rxvt core
372	sub invoke {	484	sub invoke {
373	local $TERM = shift;	485	local $TERM = shift;
374	my $htype = shift;	486	my $htype = shift;
375		487
376	if ($htype == 0) { # INIT	488	if ($htype == 0) { # INIT
377	my @dirs = ((split /:/, $TERM->resource ("perl_lib")), "$LIBDIR/perl");	489	my @dirs = ((split /:/, $TERM->resource ("perl_lib")), "$LIBDIR/perl");
		490
		491	my %want_ext;
378		492
379	for my $ext (map { split /:/, $TERM->resource ("perl_ext_$_") } 1, 2) {	493	for (map { split /,/, $TERM->resource ("perl_ext_$_") } 1, 2) {
		494	if ($_ eq "default") {
		495	$want_ext{$_}++ for qw(selection option-popup);
		496	} elsif (/^-(.*)$/) {
		497	delete $want_ext{$1};
		498	} else {
		499	$want_ext{$_}++;
		500	}
		501	}
		502
		503	for my $ext (keys %want_ext) {
380	my @files = grep -f $_, map "$_/$ext", @dirs;	504	my @files = grep -f $_, map "$_/$ext", @dirs;
381		505
382	if (@files) {	506	if (@files) {
383	register_package script_package $files[0];	507	register_package extension_package $files[0];
384	} else {	508	} else {
385	warn "perl extension '$ext' not found in perl library search path\n";	509	warn "perl extension '$ext' not found in perl library search path\n";
386	}	510	}
387	}	511	}
		512	}
388		513
		514	$retval = undef;
		515
		516	if (my $cb = $TERM->{_hook}[$htype]) {
		517	verbose 10, "$HOOKNAME[$htype] (" . (join ", ", $TERM, @_) . ")"
		518	if $verbosity >= 10;
		519
		520	keys %$cb;
		521
		522	while (my ($pkg, $cb) = each %$cb) {
		523	eval {
		524	$retval = $cb->(
		525	$TERM->{_pkg}{$pkg} \|\|= do {
		526	my $proxy = bless { }, $pkg;
		527	Scalar::Util::weaken ($proxy->{term} = $TERM);
		528	$proxy
		529	},
		530	@_,
		531	) and last;
		532	};
		533	warn $@ if $@;#d#
		534	}
		535	}
		536
389	} elsif ($htype == 1) { # DESTROY	537	if ($htype == 1) { # DESTROY
		538	# remove hooks if unused
390	if (my $hook = $TERM->{_hook}) {	539	if (my $hook = $TERM->{_hook}) {
391	for my $htype (0..$#$hook) {	540	for my $htype (0..$#$hook) {
392	$hook_count[$htype] -= scalar keys %{ $hook->[$htype] \|\| {} }	541	$hook_count[$htype] -= scalar keys %{ $hook->[$htype] \|\| {} }
393	or set_should_invoke $htype, 0;	542	or set_should_invoke $htype, 0;
394	}	543	}
395	}	544	}
		545
		546	# clear package objects
		547	%$_ = () for values %{ $TERM->{_pkg} };
		548
		549	# clear package
		550	%$TERM = ();
396	}	551	}
397		552
398	my $cb = $TERM->{_hook}[$htype]	553	$retval
399	or return;
400
401	verbose 10, "$HOOKNAME[$htype] (" . (join ", ", $TERM, @_) . ")"
402	if $verbosity >= 10;
403
404	keys %$cb;
405
406	while (my ($pkg, $cb) = each %$cb) {
407	return 1
408	if $cb->(
409	$TERM->{$pkg} \|\|= do {
410	my $proxy = bless { }, urxvt::term::proxy::;
411	Scalar::Util::weaken ($proxy->{term} = $TERM);
412	$proxy
413	},
414	@_,
415	);
416	}
417
418	0
419	}	554	}
420		555
421	sub urxvt::term::proxy::AUTOLOAD {	556	sub urxvt::term::proxy::AUTOLOAD {
422	$urxvt::term::proxy::AUTOLOAD =~ /:([^:]+)$/	557	$urxvt::term::proxy::AUTOLOAD =~ /:([^:]+)$/
423	or die "FATAL: \$AUTOLOAD '$urxvt::term::proxy::AUTOLOAD' unparsable";	558	or die "FATAL: \$AUTOLOAD '$urxvt::term::proxy::AUTOLOAD' unparsable";
…		…
431	} or die "FATAL: unable to compile method forwarder: $@";	566	} or die "FATAL: unable to compile method forwarder: $@";
432		567
433	goto &$urxvt::term::proxy::AUTOLOAD;	568	goto &$urxvt::term::proxy::AUTOLOAD;
434	}	569	}
435		570
		571	sub urxvt::destroy_hook::DESTROY {
		572	${$_[0]}->();
		573	}
		574
		575	sub urxvt::destroy_hook(&) {
		576	bless \shift, urxvt::destroy_hook::
		577	}
		578
436	=head2 The C<urxvt::term> Class	579	=head2 The C<urxvt::term> Class
437		580
438	=over 4	581	=over 4
		582
		583	=item $term->destroy
		584
		585	Destroy the terminal object (close the window, free resources etc.).
		586
		587	=item $isset = $term->option ($optval[, $set])
		588
		589	Returns true if the option specified by C<$optval> is enabled, and
		590	optionally change it. All option values are stored by name in the hash
		591	C<%urxvt::OPTION>. Options not enabled in this binary are not in the hash.
		592
		593	Here is a a likely non-exhaustive list of option names, please see the
		594	source file F</src/optinc.h> to see the actual list:
		595
		596	borderLess console cursorBlink cursorUnderline hold iconic insecure
		597	intensityStyles jumpScroll loginShell mapAlert meta8 mouseWheelScrollPage
		598	pastableTabs pointerBlank reverseVideo scrollBar scrollBar_floating
		599	scrollBar_right scrollTtyKeypress scrollTtyOutput scrollWithBuffer
		600	secondaryScreen secondaryScroll skipBuiltinGlyphs transparent
		601	tripleclickwords utmpInhibit visualBell
439		602
440	=item $value = $term->resource ($name[, $newval])	603	=item $value = $term->resource ($name[, $newval])
441		604
442	Returns the current resource value associated with a given name and	605	Returns the current resource value associated with a given name and
443	optionally sets a new value. Setting values is most useful in the C<init>	606	optionally sets a new value. Setting values is most useful in the C<init>
…		…
453		616
454	Please note that resource strings will currently only be freed when the	617	Please note that resource strings will currently only be freed when the
455	terminal is destroyed, so changing options frequently will eat memory.	618	terminal is destroyed, so changing options frequently will eat memory.
456		619
457	Here is a a likely non-exhaustive list of resource names, not all of which	620	Here is a a likely non-exhaustive list of resource names, not all of which
458	are supported in every build, please see the source to see the actual	621	are supported in every build, please see the source file F</src/rsinc.h>
459	list:	622	to see the actual list:
460		623
461	answerbackstring backgroundPixmap backspace_key boldFont boldItalicFont	624	answerbackstring backgroundPixmap backspace_key boldFont boldItalicFont
462	borderLess color cursorBlink cursorUnderline cutchars delete_key	625	borderLess color cursorBlink cursorUnderline cutchars delete_key
463	display_name embed ext_bwidth fade font geometry hold iconName	626	display_name embed ext_bwidth fade font geometry hold iconName
464	imFont imLocale inputMethod insecure int_bwidth intensityStyles	627	imFont imLocale inputMethod insecure int_bwidth intensityStyles
…		…
474	=cut	637	=cut
475		638
476	sub urxvt::term::resource($$;$) {	639	sub urxvt::term::resource($$;$) {
477	my ($self, $name) = (shift, shift);	640	my ($self, $name) = (shift, shift);
478	unshift @_, $self, $name, ($name =~ s/\s\+\s(\d+)$// ? $1 : 0);	641	unshift @_, $self, $name, ($name =~ s/\s\+\s(\d+)$// ? $1 : 0);
479	goto &urxvt::term::_resource;	642	&urxvt::term::_resource
480	}	643	}
		644
		645	=item $rend = $term->rstyle ([$new_rstyle])
		646
		647	Return and optionally change the current rendition. Text that is output by
		648	the terminal application will use this style.
		649
		650	=item ($row, $col) = $term->screen_cur ([$row, $col])
		651
		652	Return the current coordinates of the text cursor position and optionally
		653	set it (which is usually bad as applications don't expect that).
481		654
482	=item ($row, $col) = $term->selection_mark ([$row, $col])	655	=item ($row, $col) = $term->selection_mark ([$row, $col])
483		656
484	=item ($row, $col) = $term->selection_beg ([$row, $col])	657	=item ($row, $col) = $term->selection_beg ([$row, $col])
485		658
…		…
500	#=item $term->overlay ($x, $y, $text)	673	#=item $term->overlay ($x, $y, $text)
501	#	674	#
502	#Create a simple multi-line overlay box. See the next method for details.	675	#Create a simple multi-line overlay box. See the next method for details.
503	#	676	#
504	#=cut	677	#=cut
505		678	#
506	sub urxvt::term::scr_overlay {	679	#sub urxvt::term::scr_overlay {
507	die;
508	my ($self, $x, $y, $text) = @_;	680	# my ($self, $x, $y, $text) = @_;
509		681	#
510	my @lines = split /\n/, $text;	682	# my @lines = split /\n/, $text;
511		683	#
512	my $w = 0;	684	# my $w = 0;
513	for (map $self->strwidth ($_), @lines) {	685	# for (map $self->strwidth ($_), @lines) {
514	$w = $_ if $w < $_;	686	# $w = $_ if $w < $_;
515	}	687	# }
516		688	#
517	$self->scr_overlay_new ($x, $y, $w, scalar @lines);	689	# $self->scr_overlay_new ($x, $y, $w, scalar @lines);
518	$self->scr_overlay_set (0, $_, $lines[$_]) for 0.. $#lines;	690	# $self->scr_overlay_set (0, $_, $lines[$_]) for 0.. $#lines;
519	}	691	#}
520		692
521	=item $term->overlay ($x, $y, $width, $height[, $rstyle[, $border]])	693	=item $term->overlay ($x, $y, $width, $height[, $rstyle[, $border]])
522		694
523	Create a new (empty) overlay at the given position with the given	695	Create a new (empty) overlay at the given position with the given
524	width/height. C<$rstyle> defines the initial rendition style	696	width/height. C<$rstyle> defines the initial rendition style
…		…
551		723
552	If hidden, display the overlay again.	724	If hidden, display the overlay again.
553		725
554	=back	726	=back
555		727
		728	=item $popup = $term->popup ($event)
		729
		730	Creates a new C<urxvt::popup> object that implements a popup menu. The
		731	C<$event> I<must> be the event causing the menu to pop up (a button event,
		732	currently).
		733
		734	=cut
		735
		736	sub urxvt::term::popup {
		737	my ($self, $event) = @_;
		738
		739	$self->grab ($event->{time}, 1)
		740	or return;
		741
		742	my $popup = bless {
		743	term => $self,
		744	event => $event,
		745	}, urxvt::popup::;
		746
		747	Scalar::Util::weaken $popup->{term};
		748
		749	$self->{_destroy}{$popup} = urxvt::destroy_hook { $popup->{popup}->destroy };
		750	Scalar::Util::weaken $self->{_destroy}{$popup};
		751
		752	$popup
		753	}
		754
556	=item $cellwidth = $term->strwidth $string	755	=item $cellwidth = $term->strwidth ($string)
557		756
558	Returns the number of screen-cells this string would need. Correctly	757	Returns the number of screen-cells this string would need. Correctly
559	accounts for wide and combining characters.	758	accounts for wide and combining characters.
560		759
561	=item $octets = $term->locale_encode $string	760	=item $octets = $term->locale_encode ($string)
562		761
563	Convert the given text string into the corresponding locale encoding.	762	Convert the given text string into the corresponding locale encoding.
564		763
565	=item $string = $term->locale_decode $octets	764	=item $string = $term->locale_decode ($octets)
566		765
567	Convert the given locale-encoded octets into a perl string.	766	Convert the given locale-encoded octets into a perl string.
		767
		768	=item $term->scr_add_lines ($string)
		769
		770	Write the given text string to the screen, as if output by the application
		771	running inside the terminal. It may not contain command sequences (escape
		772	codes), but is free to use line feeds, carriage returns and tabs. The
		773	string is a normal text string, not in locale-dependent encoding.
		774
		775	Normally its not a good idea to use this function, as programs might be
		776	confused by changes in cursor position or scrolling. Its useful inside a
		777	C<on_add_lines> hook, though.
		778
		779	=item $term->cmd_parse ($octets)
		780
		781	Similar to C<scr_add_lines>, but the argument must be in the
		782	locale-specific encoding of the terminal and can contain command sequences
		783	(escape codes) that will be interpreted.
568		784
569	=item $term->tt_write ($octets)	785	=item $term->tt_write ($octets)
570		786
571	Write the octets given in C<$data> to the tty (i.e. as program input). To	787	Write the octets given in C<$data> to the tty (i.e. as program input). To
572	pass characters instead of octets, you should convert your strings first	788	pass characters instead of octets, you should convert your strings first
573	to the locale-specific encoding using C<< $term->locale_encode >>.	789	to the locale-specific encoding using C<< $term->locale_encode >>.
574		790
		791	=item $windowid = $term->parent
		792
		793	Return the window id of the toplevel window.
		794
		795	=item $windowid = $term->vt
		796
		797	Return the window id of the terminal window.
		798
		799	=item $window_width = $term->width
		800
		801	=item $window_height = $term->height
		802
		803	=item $font_width = $term->fwidth
		804
		805	=item $font_height = $term->fheight
		806
		807	=item $font_ascent = $term->fbase
		808
575	=item $nrow = $term->nrow	809	=item $terminal_rows = $term->nrow
576		810
577	=item $ncol = $term->ncol	811	=item $terminal_columns = $term->ncol
578		812
579	Return the number of rows/columns of the terminal window (i.e. as	813	=item $has_focus = $term->focus
580	specified by C<-geometry>, excluding any scrollback).
581		814
582	=item $nsaved = $term->nsaved	815	=item $is_mapped = $term->mapped
583		816
584	Returns the number of lines in the scrollback buffer.	817	=item $max_scrollback = $term->saveLines
		818
		819	=item $nrow_plus_saveLines = $term->total_rows
		820
		821	=item $lines_in_scrollback = $term->nsaved
		822
		823	Return various integers describing terminal characteristics.
		824
		825	=item $modifiermask = $term->ModLevel3Mask
		826
		827	=item $modifiermask = $term->ModMetaMask
		828
		829	=item $modifiermask = $term->ModNumLockMask
		830
		831	Return the modifier masks corresponding to the "ISO Level 3 Shift" (often
		832	AltGr), the meta key (often Alt) and the num lock key, if applicable.
585		833
586	=item $view_start = $term->view_start ([$newvalue])	834	=item $view_start = $term->view_start ([$newvalue])
587		835
588	Returns the negative row number of the topmost line. Minimum value is	836	Returns the negative row number of the topmost line. Minimum value is
589	C<0>, which displays the normal terminal contents. Larger values scroll	837	C<0>, which displays the normal terminal contents. Larger values scroll
…		…
652	about the logical line that row C<$row_number> is part of. It supports the	900	about the logical line that row C<$row_number> is part of. It supports the
653	following methods:	901	following methods:
654		902
655	=over 4	903	=over 4
656		904
657	=item $text = $line->t	905	=item $text = $line->t ([$new_text])
658		906
659	Returns the full text of the line, similar to C<ROW_t>	907	Returns or replaces the full text of the line, similar to C<ROW_t>
660		908
661	=item $rend = $line->r	909	=item $rend = $line->r ([$new_rend])
662		910
663	Returns the full rendition array of the line, similar to C<ROW_r>	911	Returns or replaces the full rendition array of the line, similar to C<ROW_r>
664		912
665	=item $length = $line->l	913	=item $length = $line->l
666		914
667	Returns the length of the line in cells, similar to C<ROW_l>.	915	Returns the length of the line in cells, similar to C<ROW_l>.
668		916
…		…
697		945
698	bless {	946	bless {
699	term => $self,	947	term => $self,
700	beg => $beg,	948	beg => $beg,
701	end => $end,	949	end => $end,
		950	ncol => $self->ncol,
702	len => ($end - $beg) * $self->ncol + $self->ROW_l ($end),	951	len => ($end - $beg) * $self->ncol + $self->ROW_l ($end),
703	}, urxvt::line::	952	}, urxvt::line::
704	}	953	}
705		954
706	sub urxvt::line::t {	955	sub urxvt::line::t {
707	my ($self) = @_;	956	my ($self) = @_;
708		957
		958	if (@_ > 1)
		959	{
		960	$self->{term}->ROW_t ($_, $_[1], 0, ($_ - $self->{beg}) * $self->{ncol}, $self->{ncol})
		961	for $self->{beg} .. $self->{end};
		962	}
		963
		964	defined wantarray &&
709	substr +(join "", map $self->{term}->ROW_t ($_), $self->{beg} .. $self->{end}),	965	substr +(join "", map $self->{term}->ROW_t ($_), $self->{beg} .. $self->{end}),
710	0, $self->{len}	966	0, $self->{len}
711	}	967	}
712		968
713	sub urxvt::line::r {	969	sub urxvt::line::r {
714	my ($self) = @_;	970	my ($self) = @_;
715		971
		972	if (@_ > 1)
		973	{
		974	$self->{term}->ROW_r ($_, $_[1], 0, ($_ - $self->{beg}) * $self->{ncol}, $self->{ncol})
		975	for $self->{beg} .. $self->{end};
		976	}
		977
		978	if (defined wantarray) {
716	my $rend = [	979	my $rend = [
717	map @{ $self->{term}->ROW_r ($_) }, $self->{beg} .. $self->{end}	980	map @{ $self->{term}->ROW_r ($_) }, $self->{beg} .. $self->{end}
718	];	981	];
719	$#$rend = $self->{len} - 1;	982	$#$rend = $self->{len} - 1;
720	$rend	983	return $rend;
		984	}
		985
		986	()
721	}	987	}
722		988
723	sub urxvt::line::beg { $_[0]{beg} }	989	sub urxvt::line::beg { $_[0]{beg} }
724	sub urxvt::line::end { $_[0]{end} }	990	sub urxvt::line::end { $_[0]{end} }
725	sub urxvt::line::l { $_[0]{len} }	991	sub urxvt::line::l { $_[0]{len} }
726		992
727	sub urxvt::line::offset_of {	993	sub urxvt::line::offset_of {
728	my ($self, $row, $col) = @_;	994	my ($self, $row, $col) = @_;
729		995
730	($row - $self->{beg}) * $self->{term}->ncol + $col	996	($row - $self->{beg}) * $self->{ncol} + $col
731	}	997	}
732		998
733	sub urxvt::line::coord_of {	999	sub urxvt::line::coord_of {
734	my ($self, $offset) = @_;	1000	my ($self, $offset) = @_;
735		1001
736	use integer;	1002	use integer;
737		1003
738	(	1004	(
739	$offset / $self->{term}->ncol + $self->{beg},	1005	$offset / $self->{ncol} + $self->{beg},
740	$offset % $self->{term}->ncol	1006	$offset % $self->{ncol}
741	)	1007	)
742	}	1008	}
743		1009
744	=item ($row, $col) = $line->coord_of ($offset)	1010	=item ($row, $col) = $line->coord_of ($offset)
745	=item $text = $term->special_encode $string	1011	=item $text = $term->special_encode $string
…		…
752		1018
753	Converts rxvt-unicodes text reprsentation into a perl string. See	1019	Converts rxvt-unicodes text reprsentation into a perl string. See
754	C<< $term->ROW_t >> for details.	1020	C<< $term->ROW_t >> for details.
755		1021
756	=back	1022	=back
		1023
		1024	=head2 The C<urxvt::popup> Class
		1025
		1026	=over 4
		1027
		1028	=cut
		1029
		1030	package urxvt::popup;
		1031
		1032	sub add_item {
		1033	my ($self, $item) = @_;
		1034
		1035	$item->{rend}{normal} = "\x1b[0;30;47m" unless exists $item->{rend}{normal};
		1036	$item->{rend}{hover} = "\x1b[0;30;46m" unless exists $item->{rend}{hover};
		1037	$item->{rend}{active} = "\x1b[m" unless exists $item->{rend}{active};
		1038
		1039	$item->{render} \|\|= sub { $_[0]{text} };
		1040
		1041	push @{ $self->{item} }, $item;
		1042	}
		1043
		1044	sub add_separator {
		1045	my ($self, $sep) = @_;
		1046
		1047	$sep \|\|= "═";
		1048
		1049	$self->add_item ({
		1050	rend => { normal => "\x1b[0;30;47m", hover => "\x1b[0;30;47m", active => "\x1b[0;30;47m" },
		1051	text => "",
		1052	render => sub { $sep x $urxvt::TERM->ncol },
		1053	activate => sub { },
		1054	});
		1055	}
		1056
		1057	sub add_title {
		1058	my ($self, $title) = @_;
		1059
		1060	$self->add_item ({
		1061	rend => { normal => "\x1b[38;5;11;44m", hover => "\x1b[38;5;11;44m", active => "\x1b[38;5;11;44m" },
		1062	text => $title,
		1063	activate => sub { },
		1064	});
		1065	}
		1066
		1067	sub add_button {
		1068	my ($self, $text, $cb) = @_;
		1069
		1070	$self->add_item ({ type => "button", text => "[ $text ]", activate => $cb});
		1071	}
		1072
		1073	sub add_toggle {
		1074	my ($self, $text, $cb, $value) = @_;
		1075
		1076	my $item; $item = {
		1077	type => "button",
		1078	text => " $text",
		1079	value => $value,
		1080	render => sub { ($item->{value} ? "* " : " ") . $text },
		1081	activate => sub { $cb->($item->{value} = !$item->{value}); },
		1082	};
		1083
		1084	$self->add_item ($item);
		1085	}
		1086
		1087	sub show {
		1088	my ($self) = @_;
		1089
		1090	local $urxvt::popup::self = $self;
		1091
		1092	urxvt->new ("--perl-lib" => "", "--perl-ext-common" => "", "-pty-fd" => -1, "-sl" => 0, "-b" => 0,
		1093	"--transient-for" => $self->{term}->parent,
		1094	"-pe" => "urxvt-popup")
		1095	or die "unable to create popup window\n";
		1096	}
		1097
		1098	sub DESTROY {
		1099	my ($self) = @_;
		1100
		1101	$self->{term}->ungrab;
		1102	}
757		1103
758	=head2 The C<urxvt::timer> Class	1104	=head2 The C<urxvt::timer> Class
759		1105
760	This class implements timer watchers/events. Time is represented as a	1106	This class implements timer watchers/events. Time is represented as a
761	fractional number of seconds since the epoch. Example:	1107	fractional number of seconds since the epoch. Example:

Diff Legend

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

Comparing rxvt-unicode/src/urxvt.pm (file contents): Revision 1.30 by root, Wed Jan 4 05:35:34 2006 UTC vs. Revision 1.54 by root, Sun Jan 8 01:59:29 2006 UTC

Diff Legend

Comparing rxvt-unicode/src/urxvt.pm (file contents):
Revision 1.30 by root, Wed Jan 4 05:35:34 2006 UTC vs.
Revision 1.54 by root, Sun Jan 8 01:59:29 2006 UTC