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

Comparing rxvt-unicode/src/urxvt.pm (file contents):
Revision 1.32 by root, Wed Jan 4 21:37:55 2006 UTC vs.
Revision 1.56 by root, Sun Jan 8 05:52:42 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 calls and event processing.
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
		412	our $VERSION = 1;
304	our $TERM;	413	our $TERM;
305	our @HOOKNAME;	414	our @HOOKNAME;
		415	our %OPTION;
306	our $LIBDIR;	416	our $LIBDIR;
307		417
308	BEGIN {	418	BEGIN {
309	urxvt->bootstrap;	419	urxvt->bootstrap;
310		420
…		…
340	$hook_count[$htype]++	450	$hook_count[$htype]++
341	or set_should_invoke $htype, 1;	451	or set_should_invoke $htype, 1;
342	}	452	}
343	}	453	}
344		454
345	my $script_pkg = "script0000";	455	my $extension_pkg = "extension0000";
346	my %script_pkg;	456	my %extension_pkg;
347		457
348	# load a single script into its own package, once only	458	# load a single script into its own package, once only
349	sub script_package($) {	459	sub extension_package($) {
350	my ($path) = @_;	460	my ($path) = @_;
351		461
352	$script_pkg{$path} \|\|= do {	462	$extension_pkg{$path} \|\|= do {
353	my $pkg = "urxvt::" . ($script_pkg++);	463	my $pkg = "urxvt::" . ($extension_pkg++);
354		464
355	verbose 3, "loading script '$path' into package '$pkg'";	465	verbose 3, "loading extension '$path' into package '$pkg'";
356		466
357	open my $fh, "<:raw", $path	467	open my $fh, "<:raw", $path
358	or die "$path: $!";	468	or die "$path: $!";
359		469
360	my $source = "package $pkg; use strict; use utf8;\n"	470	my $source = "package $pkg; use strict; use utf8;\n"
		471	. "use base urxvt::term::proxy::;\n"
361	. "#line 1 \"$path\"\n{\n"	472	. "#line 1 \"$path\"\n{\n"
362	. (do { local $/; <$fh> })	473	. (do { local $/; <$fh> })
363	. "\n};\n1";	474	. "\n};\n1";
364		475
365	eval $source or die "$path: $@";	476	eval $source or die "$path: $@";
…		…
375	local $TERM = shift;	486	local $TERM = shift;
376	my $htype = shift;	487	my $htype = shift;
377		488
378	if ($htype == 0) { # INIT	489	if ($htype == 0) { # INIT
379	my @dirs = ((split /:/, $TERM->resource ("perl_lib")), "$LIBDIR/perl");	490	my @dirs = ((split /:/, $TERM->resource ("perl_lib")), "$LIBDIR/perl");
		491
		492	my %want_ext;
380		493
381	for my $ext (map { split /:/, $TERM->resource ("perl_ext_$_") } 1, 2) {	494	for (map { split /,/, $TERM->resource ("perl_ext_$_") } 1, 2) {
		495	if ($_ eq "default") {
		496	$want_ext{$_}++ for qw(selection option-popup);
		497	} elsif (/^-(.*)$/) {
		498	delete $want_ext{$1};
		499	} else {
		500	$want_ext{$_}++;
		501	}
		502	}
		503
		504	for my $ext (keys %want_ext) {
382	my @files = grep -f $_, map "$_/$ext", @dirs;	505	my @files = grep -f $_, map "$_/$ext", @dirs;
383		506
384	if (@files) {	507	if (@files) {
385	register_package script_package $files[0];	508	register_package extension_package $files[0];
386	} else {	509	} else {
387	warn "perl extension '$ext' not found in perl library search path\n";	510	warn "perl extension '$ext' not found in perl library search path\n";
388	}	511	}
389	}	512	}
		513
		514	eval "#line 1 \"--perl-eval resource/argument\"\n" . $TERM->resource ("perl_eval");
		515	warn $@ if $@;
390	}	516	}
391		517
392	$retval = undef;	518	$retval = undef;
393		519
394	if (my $cb = $TERM->{_hook}[$htype]) {	520	if (my $cb = $TERM->{_hook}[$htype]) {
…		…
396	if $verbosity >= 10;	522	if $verbosity >= 10;
397		523
398	keys %$cb;	524	keys %$cb;
399		525
400	while (my ($pkg, $cb) = each %$cb) {	526	while (my ($pkg, $cb) = each %$cb) {
		527	eval {
401	$retval = $cb->(	528	$retval = $cb->(
402	$TERM->{_pkg}{$pkg} \|\|= do {	529	$TERM->{_pkg}{$pkg} \|\|= do {
403	my $proxy = bless { }, urxvt::term::proxy::;	530	my $proxy = bless { }, $pkg;
404	Scalar::Util::weaken ($proxy->{term} = $TERM);	531	Scalar::Util::weaken ($proxy->{term} = $TERM);
405	$proxy	532	$proxy
406	},	533	},
407	@_,	534	@_,
408	) and last;	535	) and last;
		536	};
		537	warn $@ if $@;#d#
409	}	538	}
410	}	539	}
411		540
412	if ($htype == 1) { # DESTROY	541	if ($htype == 1) { # DESTROY
413	# remove hooks if unused	542	# remove hooks if unused
…		…
426	}	555	}
427		556
428	$retval	557	$retval
429	}	558	}
430		559
		560	# urxvt::term::proxy
		561
431	sub urxvt::term::proxy::AUTOLOAD {	562	sub urxvt::term::proxy::AUTOLOAD {
432	$urxvt::term::proxy::AUTOLOAD =~ /:([^:]+)$/	563	$urxvt::term::proxy::AUTOLOAD =~ /:([^:]+)$/
433	or die "FATAL: \$AUTOLOAD '$urxvt::term::proxy::AUTOLOAD' unparsable";	564	or die "FATAL: \$AUTOLOAD '$urxvt::term::proxy::AUTOLOAD' unparsable";
434		565
435	eval qq{	566	eval qq{
…		…
441	} or die "FATAL: unable to compile method forwarder: $@";	572	} or die "FATAL: unable to compile method forwarder: $@";
442		573
443	goto &$urxvt::term::proxy::AUTOLOAD;	574	goto &$urxvt::term::proxy::AUTOLOAD;
444	}	575	}
445		576
		577	# urxvt::destroy_hook
		578
		579	sub urxvt::destroy_hook::DESTROY {
		580	${$_[0]}->();
		581	}
		582
		583	sub urxvt::destroy_hook(&) {
		584	bless \shift, urxvt::destroy_hook::
		585	}
		586
		587	package urxvt::anyevent;
		588
		589	=head2 The C<urxvt::anyevent> Class
		590
		591	The sole purpose of this class is to deliver an interface to the
		592	C<AnyEvent> module - any module using it will work inside urxvt without
		593	further work. The only exception is that you cannot wait on condition
		594	variables, but non-blocking condvar use is ok. What this means is that you
		595	cannot use blocking APIs, but the non-blocking variant should work.
		596
		597	=cut
		598
		599	our $VERSION = 1;
		600
		601	$INC{"urxvt/anyevent.pm"} = 1; # mark us as there
		602	push @AnyEvent::REGISTRY, [urxvt => urxvt::anyevent::];
		603
		604	sub timer {
		605	my ($class, %arg) = @_;
		606
		607	my $cb = $arg{cb};
		608
		609	urxvt::timer
		610	->new
		611	->start (urxvt::NOW + $arg{after})
		612	->cb (sub {
		613	$_[0]->stop; # need to cancel manually
		614	$cb->();
		615	})
		616	}
		617
		618	sub io {
		619	my ($class, %arg) = @_;
		620
		621	my $cb = $arg{cb};
		622
		623	bless [$arg{fh}, urxvt::iow
		624	->new
		625	->fd (fileno $arg{fh})
		626	->events (($arg{poll} =~ /r/ ? 1 : 0)
		627	\| ($arg{poll} =~ /w/ ? 2 : 0))
		628	->start
		629	->cb (sub {
		630	$cb->(($_[1] & 1 ? 'r' : '')
		631	. ($_[1] & 2 ? 'w' : ''));
		632	})],
		633	urxvt::anyevent::
		634	}
		635
		636	sub DESTROY {
		637	$_[0][1]->stop;
		638	}
		639
		640	sub condvar {
		641	bless \my $flag, urxvt::anyevent::condvar::
		642	}
		643
		644	sub urxvt::anyevent::condvar::broadcast {
		645	${$_[0]}++;
		646	}
		647
		648	sub urxvt::anyevent::condvar::wait {
		649	unless (${$_[0]}) {
		650	require Carp;
		651	Carp::croak ("AnyEvent->condvar blocking wait unsupported in urxvt, use a non-blocking API");
		652	}
		653	}
		654
		655	package urxvt::term;
		656
446	=head2 The C<urxvt::term> Class	657	=head2 The C<urxvt::term> Class
447		658
448	=over 4	659	=over 4
		660
		661	=item $term->destroy
		662
		663	Destroy the terminal object (close the window, free resources etc.).
		664
		665	=item $isset = $term->option ($optval[, $set])
		666
		667	Returns true if the option specified by C<$optval> is enabled, and
		668	optionally change it. All option values are stored by name in the hash
		669	C<%urxvt::OPTION>. Options not enabled in this binary are not in the hash.
		670
		671	Here is a a likely non-exhaustive list of option names, please see the
		672	source file F</src/optinc.h> to see the actual list:
		673
		674	borderLess console cursorBlink cursorUnderline hold iconic insecure
		675	intensityStyles jumpScroll loginShell mapAlert meta8 mouseWheelScrollPage
		676	pastableTabs pointerBlank reverseVideo scrollBar scrollBar_floating
		677	scrollBar_right scrollTtyKeypress scrollTtyOutput scrollWithBuffer
		678	secondaryScreen secondaryScroll skipBuiltinGlyphs transparent
		679	tripleclickwords utmpInhibit visualBell
449		680
450	=item $value = $term->resource ($name[, $newval])	681	=item $value = $term->resource ($name[, $newval])
451		682
452	Returns the current resource value associated with a given name and	683	Returns the current resource value associated with a given name and
453	optionally sets a new value. Setting values is most useful in the C<init>	684	optionally sets a new value. Setting values is most useful in the C<init>
…		…
463		694
464	Please note that resource strings will currently only be freed when the	695	Please note that resource strings will currently only be freed when the
465	terminal is destroyed, so changing options frequently will eat memory.	696	terminal is destroyed, so changing options frequently will eat memory.
466		697
467	Here is a a likely non-exhaustive list of resource names, not all of which	698	Here is a a likely non-exhaustive list of resource names, not all of which
468	are supported in every build, please see the source to see the actual	699	are supported in every build, please see the source file F</src/rsinc.h>
469	list:	700	to see the actual list:
470		701
471	answerbackstring backgroundPixmap backspace_key boldFont boldItalicFont	702	answerbackstring backgroundPixmap backspace_key boldFont boldItalicFont
472	borderLess color cursorBlink cursorUnderline cutchars delete_key	703	borderLess color cursorBlink cursorUnderline cutchars delete_key
473	display_name embed ext_bwidth fade font geometry hold iconName	704	display_name embed ext_bwidth fade font geometry hold iconName
474	imFont imLocale inputMethod insecure int_bwidth intensityStyles	705	imFont imLocale inputMethod insecure int_bwidth intensityStyles
…		…
481	shade term_name title transparent transparent_all tripleclickwords	712	shade term_name title transparent transparent_all tripleclickwords
482	utmpInhibit visualBell	713	utmpInhibit visualBell
483		714
484	=cut	715	=cut
485		716
486	sub urxvt::term::resource($$;$) {	717	sub resource($$;$) {
487	my ($self, $name) = (shift, shift);	718	my ($self, $name) = (shift, shift);
488	unshift @_, $self, $name, ($name =~ s/\s\+\s(\d+)$// ? $1 : 0);	719	unshift @_, $self, $name, ($name =~ s/\s\+\s(\d+)$// ? $1 : 0);
489	goto &urxvt::term::_resource;	720	&urxvt::term::_resource
490	}	721	}
491		722
492	=item $rend = $term->screen_rstyle ([$new_rstyle])	723	=item $rend = $term->rstyle ([$new_rstyle])
493		724
494	Return and optionally change the current rendition. Text thta is output by	725	Return and optionally change the current rendition. Text that is output by
495	the temrianl application will use this style.	726	the terminal application will use this style.
496		727
497	=item ($row, $col) = $term->screen_cur ([$row, $col])	728	=item ($row, $col) = $term->screen_cur ([$row, $col])
498		729
499	Return the current coordinates of the text cursor position and optionally	730	Return the current coordinates of the text cursor position and optionally
500	set it (which is usually bad as applications don't expect that).	731	set it (which is usually bad as applications don't expect that).
…		…
520	#=item $term->overlay ($x, $y, $text)	751	#=item $term->overlay ($x, $y, $text)
521	#	752	#
522	#Create a simple multi-line overlay box. See the next method for details.	753	#Create a simple multi-line overlay box. See the next method for details.
523	#	754	#
524	#=cut	755	#=cut
525		756	#
526	sub urxvt::term::scr_overlay {	757	#sub urxvt::term::scr_overlay {
527	die;
528	my ($self, $x, $y, $text) = @_;	758	# my ($self, $x, $y, $text) = @_;
529		759	#
530	my @lines = split /\n/, $text;	760	# my @lines = split /\n/, $text;
531		761	#
532	my $w = 0;	762	# my $w = 0;
533	for (map $self->strwidth ($_), @lines) {	763	# for (map $self->strwidth ($_), @lines) {
534	$w = $_ if $w < $_;	764	# $w = $_ if $w < $_;
535	}	765	# }
536		766	#
537	$self->scr_overlay_new ($x, $y, $w, scalar @lines);	767	# $self->scr_overlay_new ($x, $y, $w, scalar @lines);
538	$self->scr_overlay_set (0, $_, $lines[$_]) for 0.. $#lines;	768	# $self->scr_overlay_set (0, $_, $lines[$_]) for 0.. $#lines;
539	}	769	#}
540		770
541	=item $term->overlay ($x, $y, $width, $height[, $rstyle[, $border]])	771	=item $term->overlay ($x, $y, $width, $height[, $rstyle[, $border]])
542		772
543	Create a new (empty) overlay at the given position with the given	773	Create a new (empty) overlay at the given position with the given
544	width/height. C<$rstyle> defines the initial rendition style	774	width/height. C<$rstyle> defines the initial rendition style
…		…
571		801
572	If hidden, display the overlay again.	802	If hidden, display the overlay again.
573		803
574	=back	804	=back
575		805
		806	=item $popup = $term->popup ($event)
		807
		808	Creates a new C<urxvt::popup> object that implements a popup menu. The
		809	C<$event> I<must> be the event causing the menu to pop up (a button event,
		810	currently).
		811
		812	=cut
		813
		814	sub popup {
		815	my ($self, $event) = @_;
		816
		817	$self->grab ($event->{time}, 1)
		818	or return;
		819
		820	my $popup = bless {
		821	term => $self,
		822	event => $event,
		823	}, urxvt::popup::;
		824
		825	Scalar::Util::weaken $popup->{term};
		826
		827	$self->{_destroy}{$popup} = urxvt::destroy_hook { $popup->{popup}->destroy };
		828	Scalar::Util::weaken $self->{_destroy}{$popup};
		829
		830	$popup
		831	}
		832
576	=item $cellwidth = $term->strwidth $string	833	=item $cellwidth = $term->strwidth ($string)
577		834
578	Returns the number of screen-cells this string would need. Correctly	835	Returns the number of screen-cells this string would need. Correctly
579	accounts for wide and combining characters.	836	accounts for wide and combining characters.
580		837
581	=item $octets = $term->locale_encode $string	838	=item $octets = $term->locale_encode ($string)
582		839
583	Convert the given text string into the corresponding locale encoding.	840	Convert the given text string into the corresponding locale encoding.
584		841
585	=item $string = $term->locale_decode $octets	842	=item $string = $term->locale_decode ($octets)
586		843
587	Convert the given locale-encoded octets into a perl string.	844	Convert the given locale-encoded octets into a perl string.
		845
		846	=item $term->scr_add_lines ($string)
		847
		848	Write the given text string to the screen, as if output by the application
		849	running inside the terminal. It may not contain command sequences (escape
		850	codes), but is free to use line feeds, carriage returns and tabs. The
		851	string is a normal text string, not in locale-dependent encoding.
		852
		853	Normally its not a good idea to use this function, as programs might be
		854	confused by changes in cursor position or scrolling. Its useful inside a
		855	C<on_add_lines> hook, though.
		856
		857	=item $term->cmd_parse ($octets)
		858
		859	Similar to C<scr_add_lines>, but the argument must be in the
		860	locale-specific encoding of the terminal and can contain command sequences
		861	(escape codes) that will be interpreted.
588		862
589	=item $term->tt_write ($octets)	863	=item $term->tt_write ($octets)
590		864
591	Write the octets given in C<$data> to the tty (i.e. as program input). To	865	Write the octets given in C<$data> to the tty (i.e. as program input). To
592	pass characters instead of octets, you should convert your strings first	866	pass characters instead of octets, you should convert your strings first
593	to the locale-specific encoding using C<< $term->locale_encode >>.	867	to the locale-specific encoding using C<< $term->locale_encode >>.
594		868
		869	=item $windowid = $term->parent
		870
		871	Return the window id of the toplevel window.
		872
		873	=item $windowid = $term->vt
		874
		875	Return the window id of the terminal window.
		876
595	=item $window_width = $term->width	877	=item $window_width = $term->width
596		878
597	=item $window_height = $term->height	879	=item $window_height = $term->height
598		880
599	=item $font_width = $term->fwidth	881	=item $font_width = $term->fwidth
…		…
615	=item $nrow_plus_saveLines = $term->total_rows	897	=item $nrow_plus_saveLines = $term->total_rows
616		898
617	=item $lines_in_scrollback = $term->nsaved	899	=item $lines_in_scrollback = $term->nsaved
618		900
619	Return various integers describing terminal characteristics.	901	Return various integers describing terminal characteristics.
		902
		903	=item $modifiermask = $term->ModLevel3Mask
		904
		905	=item $modifiermask = $term->ModMetaMask
		906
		907	=item $modifiermask = $term->ModNumLockMask
		908
		909	Return the modifier masks corresponding to the "ISO Level 3 Shift" (often
		910	AltGr), the meta key (often Alt) and the num lock key, if applicable.
620		911
621	=item $view_start = $term->view_start ([$newvalue])	912	=item $view_start = $term->view_start ([$newvalue])
622		913
623	Returns the negative row number of the topmost line. Minimum value is	914	Returns the negative row number of the topmost line. Minimum value is
624	C<0>, which displays the normal terminal contents. Larger values scroll	915	C<0>, which displays the normal terminal contents. Larger values scroll
…		…
687	about the logical line that row C<$row_number> is part of. It supports the	978	about the logical line that row C<$row_number> is part of. It supports the
688	following methods:	979	following methods:
689		980
690	=over 4	981	=over 4
691		982
692	=item $text = $line->t	983	=item $text = $line->t ([$new_text])
693		984
694	Returns the full text of the line, similar to C<ROW_t>	985	Returns or replaces the full text of the line, similar to C<ROW_t>
695		986
696	=item $rend = $line->r	987	=item $rend = $line->r ([$new_rend])
697		988
698	Returns the full rendition array of the line, similar to C<ROW_r>	989	Returns or replaces the full rendition array of the line, similar to C<ROW_r>
699		990
700	=item $length = $line->l	991	=item $length = $line->l
701		992
702	Returns the length of the line in cells, similar to C<ROW_l>.	993	Returns the length of the line in cells, similar to C<ROW_l>.
703		994
…		…
718		1009
719	=back	1010	=back
720		1011
721	=cut	1012	=cut
722		1013
723	sub urxvt::term::line {	1014	sub line {
724	my ($self, $row) = @_;	1015	my ($self, $row) = @_;
725		1016
726	my $maxrow = $self->nrow - 1;	1017	my $maxrow = $self->nrow - 1;
727		1018
728	my ($beg, $end) = ($row, $row);	1019	my ($beg, $end) = ($row, $row);
…		…
732		1023
733	bless {	1024	bless {
734	term => $self,	1025	term => $self,
735	beg => $beg,	1026	beg => $beg,
736	end => $end,	1027	end => $end,
		1028	ncol => $self->ncol,
737	len => ($end - $beg) * $self->ncol + $self->ROW_l ($end),	1029	len => ($end - $beg) * $self->ncol + $self->ROW_l ($end),
738	}, urxvt::line::	1030	}, urxvt::line::
739	}	1031	}
740		1032
741	sub urxvt::line::t {	1033	sub urxvt::line::t {
742	my ($self) = @_;	1034	my ($self) = @_;
743		1035
		1036	if (@_ > 1)
		1037	{
		1038	$self->{term}->ROW_t ($_, $_[1], 0, ($_ - $self->{beg}) * $self->{ncol}, $self->{ncol})
		1039	for $self->{beg} .. $self->{end};
		1040	}
		1041
		1042	defined wantarray &&
744	substr +(join "", map $self->{term}->ROW_t ($_), $self->{beg} .. $self->{end}),	1043	substr +(join "", map $self->{term}->ROW_t ($_), $self->{beg} .. $self->{end}),
745	0, $self->{len}	1044	0, $self->{len}
746	}	1045	}
747		1046
748	sub urxvt::line::r {	1047	sub urxvt::line::r {
749	my ($self) = @_;	1048	my ($self) = @_;
750		1049
		1050	if (@_ > 1)
		1051	{
		1052	$self->{term}->ROW_r ($_, $_[1], 0, ($_ - $self->{beg}) * $self->{ncol}, $self->{ncol})
		1053	for $self->{beg} .. $self->{end};
		1054	}
		1055
		1056	if (defined wantarray) {
751	my $rend = [	1057	my $rend = [
752	map @{ $self->{term}->ROW_r ($_) }, $self->{beg} .. $self->{end}	1058	map @{ $self->{term}->ROW_r ($_) }, $self->{beg} .. $self->{end}
753	];	1059	];
754	$#$rend = $self->{len} - 1;	1060	$#$rend = $self->{len} - 1;
755	$rend	1061	return $rend;
		1062	}
		1063
		1064	()
756	}	1065	}
757		1066
758	sub urxvt::line::beg { $_[0]{beg} }	1067	sub urxvt::line::beg { $_[0]{beg} }
759	sub urxvt::line::end { $_[0]{end} }	1068	sub urxvt::line::end { $_[0]{end} }
760	sub urxvt::line::l { $_[0]{len} }	1069	sub urxvt::line::l { $_[0]{len} }
761		1070
762	sub urxvt::line::offset_of {	1071	sub urxvt::line::offset_of {
763	my ($self, $row, $col) = @_;	1072	my ($self, $row, $col) = @_;
764		1073
765	($row - $self->{beg}) * $self->{term}->ncol + $col	1074	($row - $self->{beg}) * $self->{ncol} + $col
766	}	1075	}
767		1076
768	sub urxvt::line::coord_of {	1077	sub urxvt::line::coord_of {
769	my ($self, $offset) = @_;	1078	my ($self, $offset) = @_;
770		1079
771	use integer;	1080	use integer;
772		1081
773	(	1082	(
774	$offset / $self->{term}->ncol + $self->{beg},	1083	$offset / $self->{ncol} + $self->{beg},
775	$offset % $self->{term}->ncol	1084	$offset % $self->{ncol}
776	)	1085	)
777	}	1086	}
778		1087
779	=item ($row, $col) = $line->coord_of ($offset)	1088	=item ($row, $col) = $line->coord_of ($offset)
780	=item $text = $term->special_encode $string	1089	=item $text = $term->special_encode $string
…		…
787		1096
788	Converts rxvt-unicodes text reprsentation into a perl string. See	1097	Converts rxvt-unicodes text reprsentation into a perl string. See
789	C<< $term->ROW_t >> for details.	1098	C<< $term->ROW_t >> for details.
790		1099
791	=back	1100	=back
		1101
		1102	=cut
		1103
		1104	package urxvt::popup;
		1105
		1106	=head2 The C<urxvt::popup> Class
		1107
		1108	=over 4
		1109
		1110	=cut
		1111
		1112	sub add_item {
		1113	my ($self, $item) = @_;
		1114
		1115	$item->{rend}{normal} = "\x1b[0;30;47m" unless exists $item->{rend}{normal};
		1116	$item->{rend}{hover} = "\x1b[0;30;46m" unless exists $item->{rend}{hover};
		1117	$item->{rend}{active} = "\x1b[m" unless exists $item->{rend}{active};
		1118
		1119	$item->{render} \|\|= sub { $_[0]{text} };
		1120
		1121	push @{ $self->{item} }, $item;
		1122	}
		1123
		1124	sub add_separator {
		1125	my ($self, $sep) = @_;
		1126
		1127	$sep \|\|= "═";
		1128
		1129	$self->add_item ({
		1130	rend => { normal => "\x1b[0;30;47m", hover => "\x1b[0;30;47m", active => "\x1b[0;30;47m" },
		1131	text => "",
		1132	render => sub { $sep x $urxvt::TERM->ncol },
		1133	activate => sub { },
		1134	});
		1135	}
		1136
		1137	sub add_title {
		1138	my ($self, $title) = @_;
		1139
		1140	$self->add_item ({
		1141	rend => { normal => "\x1b[38;5;11;44m", hover => "\x1b[38;5;11;44m", active => "\x1b[38;5;11;44m" },
		1142	text => $title,
		1143	activate => sub { },
		1144	});
		1145	}
		1146
		1147	sub add_button {
		1148	my ($self, $text, $cb) = @_;
		1149
		1150	$self->add_item ({ type => "button", text => "[ $text ]", activate => $cb});
		1151	}
		1152
		1153	sub add_toggle {
		1154	my ($self, $text, $cb, $value) = @_;
		1155
		1156	my $item; $item = {
		1157	type => "button",
		1158	text => " $text",
		1159	value => $value,
		1160	render => sub { ($item->{value} ? "* " : " ") . $text },
		1161	activate => sub { $cb->($item->{value} = !$item->{value}); },
		1162	};
		1163
		1164	$self->add_item ($item);
		1165	}
		1166
		1167	sub show {
		1168	my ($self) = @_;
		1169
		1170	local $urxvt::popup::self = $self;
		1171
		1172	urxvt->new ("--perl-lib" => "", "--perl-ext-common" => "", "-pty-fd" => -1, "-sl" => 0, "-b" => 0,
		1173	"--transient-for" => $self->{term}->parent,
		1174	"-pe" => "urxvt-popup")
		1175	or die "unable to create popup window\n";
		1176	}
		1177
		1178	sub DESTROY {
		1179	my ($self) = @_;
		1180
		1181	$self->{term}->ungrab;
		1182	}
792		1183
793	=head2 The C<urxvt::timer> Class	1184	=head2 The C<urxvt::timer> Class
794		1185
795	This class implements timer watchers/events. Time is represented as a	1186	This class implements timer watchers/events. Time is represented as a
796	fractional number of seconds since the epoch. Example:	1187	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.32 by root, Wed Jan 4 21:37:55 2006 UTC vs. Revision 1.56 by root, Sun Jan 8 05:52:42 2006 UTC

Diff Legend

Comparing rxvt-unicode/src/urxvt.pm (file contents):
Revision 1.32 by root, Wed Jan 4 21:37:55 2006 UTC vs.
Revision 1.56 by root, Sun Jan 8 05:52:42 2006 UTC