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

Comparing rxvt-unicode/src/urxvt.pm (file contents):
Revision 1.61 by root, Mon Jan 9 01:36:56 2006 UTC vs.
Revision 1.75 by root, Tue Jan 10 05:00:13 2006 UTC

…		…
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
29	scripts will be shared (but not enabled) for all terminals.	29	scripts will be shared (but not enabled) for all terminals.
30		30
31	=head2 Prepackaged Extensions	31	=head1 PREPACKAGED EXTENSIONS
32		32
33	This section describes the extensiosn delivered with this version. You can	33	This section describes the extensions delivered with this release. You can
34	find them in F<@@RXVT_LIBDIR@@/urxvt/perl/>.	34	find them in F<@@RXVT_LIBDIR@@/urxvt/perl/>.
35		35
36	You can activate them like this:	36	You can activate them like this:
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 (enabled by default)	42	=item selection (enabled by default)
43		43
44	Intelligent selection. This extension tries to be more intelligent when	44	(More) intelligent selection. This extension tries to be more intelligent
45	the user extends selections (double-click). Right now, it tries to select	45	when the user extends selections (double-click). Right now, it tries to
46	urls and complete shell-quoted arguments, which is very convenient, too,	46	select urls and complete shell-quoted arguments, which is very convenient,
47	if your F<ls> supports C<--quoting-style=shell>.	47	too, if your F<ls> supports C<--quoting-style=shell>.
48		48
49	It also offers the following bindable event:	49	It also offers the following bindable keyboard command:
50		50
51	=over 4	51	=over 4
52		52
53	=item rot13	53	=item rot13
54		54
…		…
64	runtime.	64	runtime.
65		65
66	=item selection-popup (enabled by default)	66	=item selection-popup (enabled by default)
67		67
68	Binds a popup menu to Ctrl-Button3 that lets you convert the selection	68	Binds a popup menu to Ctrl-Button3 that lets you convert the selection
69	text into various other formats/action.	69	text into various other formats/action (such as uri unescaping, perl
		70	evalution, web-browser starting etc.), depending on content.
		71
		72	=item searchable-scrollback<hotkey> (enabled by default)
		73
		74	Adds regex search functionality to the scrollback buffer, triggered
		75	by a hotkey (default: C<M-s>). When in search mode, normal terminal
		76	input/output is suspended.
		77
		78	C</> starts an incremental regex search, C<n> searches further, C<p> or
		79	C<N> jump to the previous match, C<G> jumps to the bottom and clears the
		80	history, C<enter> leaves search mode at the current position and C<escape>
		81	returns to the original position.
70		82
71	=item digital-clock	83	=item digital-clock
72		84
73	Displays a digital clock using the built-in overlay.	85	Displays a digital clock using the built-in overlay.
74		86
…		…
87	Displays a very simple digital clock in the upper right corner of the	99	Displays a very simple digital clock in the upper right corner of the
88	window. Illustrates overwriting the refresh callbacks to create your own	100	window. Illustrates overwriting the refresh callbacks to create your own
89	overlays or changes.	101	overlays or changes.
90		102
91	=back	103	=back
		104
		105	=head1 API DOCUMENTATION
92		106
93	=head2 General API Considerations	107	=head2 General API Considerations
94		108
95	All objects (such as terminals, time watchers etc.) are typical	109	All objects (such as terminals, time watchers etc.) are typical
96	reference-to-hash objects. The hash can be used to store anything you	110	reference-to-hash objects. The hash can be used to store anything you
…		…
124	Either binary data or - more common - a text string encoded in a	138	Either binary data or - more common - a text string encoded in a
125	locale-specific way.	139	locale-specific way.
126		140
127	=back	141	=back
128		142
		143	=head2 Extension Objects
		144
		145	Very perl extension is a perl class. A separate perl object is created
		146	for each terminal and each extension and passed as the first parameter to
		147	hooks. So extensions can use their C<$self> object without having to think
		148	about other extensions, with the exception of methods and members that
		149	begin with an underscore character C<_>: these are reserved for internal
		150	use.
		151
		152	Although it isn't a C<urxvt::term> object, you can call all methods of the
		153	C<urxvt::term> class on this object.
		154
		155	It has the following methods and data members:
		156
		157	=over 4
		158
		159	=item $urxvt_term = $self->{term}
		160
		161	Returns the C<urxvt::term> object associated with this instance of the
		162	extension. This member I<must not> be changed in any way.
		163
		164	=item $self->enable ($hook_name => $cb, [$hook_name => $cb..])
		165
		166	Dynamically enable the given hooks (named without the C<on_> prefix) for
		167	this extension, replacing any previous hook. This is useful when you want
		168	to overwrite time-critical hooks only temporarily.
		169
		170	=item $self->disable ($hook_name[, $hook_name..])
		171
		172	Dynamically disable the given hooks.
		173
		174	=back
		175
129	=head2 Hooks	176	=head2 Hooks
130		177
131	The following subroutines can be declared in extension files, and will be	178	The following subroutines can be declared in extension files, and will be
132	called whenever the relevant event happens.	179	called whenever the relevant event happens.
133		180
134	The first argument passed to them is an object private to each terminal	181	The first argument passed to them is an extension oject as described in
135	and extension package. You can call all C<urxvt::term> methods on it, but	182	the in the C<Extension Objects> section.
136	its not a real C<urxvt::term> object. Instead, the real C<urxvt::term>
137	object that is shared between all packages is stored in the C<term>
138	member. It is, however, blessed intot he package of the extension script,
139	so for all practical purposes you can treat an extension script as a class.
140		183
141	All of them must return a boolean value. If it is true, then the event	184	B<All> of these hooks must return a boolean value. If it is true, then the
142	counts as being I<consumed>, and the invocation of other hooks is skipped,	185	event counts as being I<consumed>, and the invocation of other hooks is
143	and the relevant action might not be carried out by the C++ code.	186	skipped, and the relevant action might not be carried out by the C++ code.
144		187
145	When in doubt, return a false value (preferably C<()>).	188	I<< When in doubt, return a false value (preferably C<()>). >>
146		189
147	=over 4	190	=over 4
148		191
149	=item on_init $term	192	=item on_init $term
150		193
…		…
226	can filter/change and output the text yourself by returning a true value	269	can filter/change and output the text yourself by returning a true value
227	and calling C<< $term->scr_add_lines >> yourself. Please note that this	270	and calling C<< $term->scr_add_lines >> yourself. Please note that this
228	might be very slow, however, as your hook is called for B<all> text being	271	might be very slow, however, as your hook is called for B<all> text being
229	output.	272	output.
230		273
		274	=item on_tt_write $term, $octets
		275
		276	Called whenever some data is written to the tty/pty and can be used to
		277	suppress or filter tty input.
		278
231	=item on_line_update $term, $row	279	=item on_line_update $term, $row
232		280
233	Called whenever a line was updated or changed. Can be used to filter	281	Called whenever a line was updated or changed. Can be used to filter
234	screen output (e.g. underline urls or other useless stuff). Only lines	282	screen output (e.g. underline urls or other useless stuff). Only lines
235	that are being shown will be filtered, and, due to performance reasons,	283	that are being shown will be filtered, and, due to performance reasons,
…		…
267	=item on_focus_out $term	315	=item on_focus_out $term
268		316
269	Called wheneever the window loses keyboard focus, before rxvt-unicode does	317	Called wheneever the window loses keyboard focus, before rxvt-unicode does
270	focus out processing.	318	focus out processing.
271		319
272	=item on_key_press $term, $event, $octets	320	=item on_key_press $term, $event, $keysym, $octets
273		321
274	=item on_key_release $term, $event	322	=item on_key_release $term, $event, $keysym
275		323
276	=item on_button_press $term, $event	324	=item on_button_press $term, $event
277		325
278	=item on_button_release $term, $event	326	=item on_button_release $term, $event
279		327
…		…
299		347
300	=head2 Variables in the C<urxvt> Package	348	=head2 Variables in the C<urxvt> Package
301		349
302	=over 4	350	=over 4
303		351
		352	=item $urxvt::LIBDIR
		353
		354	The rxvt-unicode library directory, where, among other things, the perl
		355	modules and scripts are stored.
		356
		357	=item $urxvt::RESCLASS, $urxvt::RESCLASS
		358
		359	The resource class and name rxvt-unicode uses to look up X resources.
		360
		361	=item $urxvt::RXVTNAME
		362
		363	The basename of the installed binaries, usually C<urxvt>.
		364
304	=item $urxvt::TERM	365	=item $urxvt::TERM
305		366
306	The current terminal. This variable stores the current C<urxvt::term>	367	The current terminal. This variable stores the current C<urxvt::term>
307	object, whenever a callback/hook is executing.	368	object, whenever a callback/hook is executing.
		369
		370	=item
308		371
309	=back	372	=back
310		373
311	=head2 Functions in the C<urxvt> Package	374	=head2 Functions in the C<urxvt> Package
312		375
…		…
333	that calls this function.	396	that calls this function.
334		397
335	Using this function has the advantage that its output ends up in the	398	Using this function has the advantage that its output ends up in the
336	correct place, e.g. on stderr of the connecting urxvtc client.	399	correct place, e.g. on stderr of the connecting urxvtc client.
337		400
		401	=item $is_safe = urxvt::safe
		402
		403	Returns true when it is safe to do potentially unsafe things, such as
		404	evaluating perl code specified by the user. This is true when urxvt was
		405	started setuid or setgid.
		406
338	=item $time = urxvt::NOW	407	=item $time = urxvt::NOW
339		408
340	Returns the "current time" (as per the event loop).	409	Returns the "current time" (as per the event loop).
341		410
342	=item urxvt::CurrentTime	411	=item urxvt::CurrentTime
…		…
380		449
381	=item $background = urxvt::GET_BASEBG $rend	450	=item $background = urxvt::GET_BASEBG $rend
382		451
383	Return the foreground/background colour index, respectively.	452	Return the foreground/background colour index, respectively.
384		453
385	=item $rend = urxvt::SET_FGCOLOR ($rend, $new_colour)	454	=item $rend = urxvt::SET_FGCOLOR $rend, $new_colour
386		455
387	=item $rend = urxvt::SET_BGCOLOR ($rend, $new_colour)	456	=item $rend = urxvt::SET_BGCOLOR $rend, $new_colour
388		457
389	Replace the foreground/background colour in the rendition mask with the	458	Replace the foreground/background colour in the rendition mask with the
390	specified one.	459	specified one.
391		460
392	=item $value = urxvt::GET_CUSTOM ($rend)	461	=item $value = urxvt::GET_CUSTOM $rend
393		462
394	Return the "custom" value: Every rendition has 5 bits for use by	463	Return the "custom" value: Every rendition has 5 bits for use by
395	extensions. They can be set and changed as you like and are initially	464	extensions. They can be set and changed as you like and are initially
396	zero.	465	zero.
397		466
398	=item $rend = urxvt::SET_CUSTOM ($rend, $new_value)	467	=item $rend = urxvt::SET_CUSTOM $rend, $new_value
399		468
400	Change the custom value.	469	Change the custom value.
401		470
402	=back	471	=back
403		472
…		…
405		474
406	package urxvt;	475	package urxvt;
407		476
408	use utf8;	477	use utf8;
409	use strict;	478	use strict;
		479	use Carp ();
410	use Scalar::Util ();	480	use Scalar::Util ();
411	use List::Util ();	481	use List::Util ();
412		482
413	our $VERSION = 1;	483	our $VERSION = 1;
414	our $TERM;	484	our $TERM;
415	our @HOOKNAME;	485	our @HOOKNAME;
		486	our %HOOKTYPE = map +($HOOKNAME[$_] => $_), 0..$#HOOKNAME;
416	our %OPTION;	487	our %OPTION;
		488
417	our $LIBDIR;	489	our $LIBDIR;
		490	our $RESNAME;
		491	our $RESCLASS;
		492	our $RXVTNAME;
418		493
419	BEGIN {	494	BEGIN {
420	urxvt->bootstrap;	495	urxvt->bootstrap;
421		496
422	# overwrite perl's warn	497	# overwrite perl's warn
…		…
439	sub verbose {	514	sub verbose {
440	my ($level, $msg) = @_;	515	my ($level, $msg) = @_;
441	warn "$msg\n" if $level <= $verbosity;	516	warn "$msg\n" if $level <= $verbosity;
442	}	517	}
443		518
444	# find on_xxx subs in the package and register them
445	# as hooks
446	sub register_package($) {
447	my ($pkg) = @_;
448
449	for my $htype (0.. $#HOOKNAME) {
450	my $name = $HOOKNAME[$htype];
451
452	my $ref = $pkg->can ("on_" . lc $name)
453	or next;
454
455	$TERM->{_hook}[$htype]{$pkg} = $ref;
456	$hook_count[$htype]++
457	or set_should_invoke $htype, 1;
458	}
459	}
460
461	my $extension_pkg = "extension0000";	519	my $extension_pkg = "extension0000";
462	my %extension_pkg;	520	my %extension_pkg;
463		521
464	# load a single script into its own package, once only	522	# load a single script into its own package, once only
465	sub extension_package($) {	523	sub extension_package($) {
…		…
471	verbose 3, "loading extension '$path' into package '$pkg'";	529	verbose 3, "loading extension '$path' into package '$pkg'";
472		530
473	open my $fh, "<:raw", $path	531	open my $fh, "<:raw", $path
474	or die "$path: $!";	532	or die "$path: $!";
475		533
		534	my $source = untaint
476	my $source = untaint "package $pkg; use strict; use utf8;\n"	535	"package $pkg; use strict; use utf8;\n"
477	. "use base urxvt::term::proxy::;\n"	536	. "use base urxvt::term::extension::;\n"
478	. "#line 1 \"$path\"\n{\n"	537	. "#line 1 \"$path\"\n{\n"
479	. (do { local $/; <$fh> })	538	. (do { local $/; <$fh> })
480	. "\n};\n1";	539	. "\n};\n1";
481		540
		541	eval $source
482	eval $source or die "$path: $@";	542	or die "$path: $@";
483		543
484	$pkg	544	$pkg
485	}	545	}
486	}	546	}
487		547
…		…
493	my $htype = shift;	553	my $htype = shift;
494		554
495	if ($htype == 0) { # INIT	555	if ($htype == 0) { # INIT
496	my @dirs = ((split /:/, $TERM->resource ("perl_lib")), "$LIBDIR/perl");	556	my @dirs = ((split /:/, $TERM->resource ("perl_lib")), "$LIBDIR/perl");
497		557
498	my %want_ext;	558	my %ext_arg;
499		559
500	for (map { split /,/, $TERM->resource ("perl_ext_$_") } 1, 2) {	560	for (map { split /,/, $TERM->resource ("perl_ext_$_") } 1, 2) {
501	if ($_ eq "default") {	561	if ($_ eq "default") {
502	$want_ext{$_}++ for qw(selection option-popup selection-popup);	562	$ext_arg{$_} \|\|= [] for qw(selection option-popup selection-popup searchable-scrollback);
503	} elsif (/^-(.*)$/) {	563	} elsif (/^-(.*)$/) {
504	delete $want_ext{$1};	564	delete $ext_arg{$1};
		565	} elsif (/^([^<]+)<(.*)>$/) {
		566	push @{ $ext_arg{$1} }, $2;
505	} else {	567	} else {
506	$want_ext{$_}++;	568	$ext_arg{$_} \|\|= [];
507	}	569	}
508	}	570	}
509		571
510	for my $ext (keys %want_ext) {	572	while (my ($ext, $argv) = each %ext_arg) {
511	my @files = grep -f $_, map "$_/$ext", @dirs;	573	my @files = grep -f $_, map "$_/$ext", @dirs;
512		574
513	if (@files) {	575	if (@files) {
514	register_package extension_package $files[0];	576	$TERM->register_package (extension_package $files[0], $argv);
515	} else {	577	} else {
516	warn "perl extension '$ext' not found in perl library search path\n";	578	warn "perl extension '$ext' not found in perl library search path\n";
517	}	579	}
518	}	580	}
519		581
…		…
528	if $verbosity >= 10;	590	if $verbosity >= 10;
529		591
530	keys %$cb;	592	keys %$cb;
531		593
532	while (my ($pkg, $cb) = each %$cb) {	594	while (my ($pkg, $cb) = each %$cb) {
533	eval {	595	$retval = eval { $cb->($TERM->{_pkg}{$pkg}, @_) }
534	$retval = $cb->(
535	$TERM->{_pkg}{$pkg} \|\|= do {
536	my $proxy = bless { }, $pkg;
537	Scalar::Util::weaken ($proxy->{term} = $TERM);
538	$proxy
539	},
540	@_,
541	) and last;	596	and last;
542	};	597
543	if ($@) {	598	if ($@) {
544	$TERM->ungrab; # better to lose the grab than the session	599	$TERM->ungrab; # better to lose the grab than the session
545	warn $@;	600	warn $@;
546	}	601	}
547	}	602	}
548	}	603	}
549		604
550	if ($htype == 1) { # DESTROY	605	if ($htype == 1) { # DESTROY
551	# remove hooks if unused
552	if (my $hook = $TERM->{_hook}) {	606	if (my $hook = delete $TERM->{_hook}) {
553	for my $htype (0..$#$hook) {	607	for my $htype (0..$#$hook) {
554	$hook_count[$htype] -= scalar keys %{ $hook->[$htype] \|\| {} }	608	$hook_count[$htype] -= scalar keys %{ $hook->[$htype] \|\| {} }
555	or set_should_invoke $htype, 0;	609	or set_should_invoke $htype, 0;
556	}	610	}
557	}	611	}
…		…
564	}	618	}
565		619
566	$retval	620	$retval
567	}	621	}
568		622
569	# urxvt::term::proxy	623	# urxvt::term::extension
570		624
571	sub urxvt::term::proxy::AUTOLOAD {	625	package urxvt::term::extension;
572	$urxvt::term::proxy::AUTOLOAD =~ /:([^:]+)$/	626
		627	sub enable {
		628	my ($self, %hook) = @_;
		629	my $pkg = $self->{_pkg};
		630
		631	while (my ($name, $cb) = each %hook) {
		632	my $htype = $HOOKTYPE{uc $name};
		633	defined $htype
		634	or Carp::croak "unsupported hook type '$name'";
		635
		636	unless (exists $self->{term}{_hook}[$htype]{$pkg}) {
		637	$hook_count[$htype]++
		638	or urxvt::set_should_invoke $htype, 1;
		639	}
		640
		641	$self->{term}{_hook}[$htype]{$pkg} = $cb;
		642	}
		643	}
		644
		645	sub disable {
		646	my ($self, @hook) = @_;
		647	my $pkg = $self->{_pkg};
		648
		649	for my $name (@hook) {
		650	my $htype = $HOOKTYPE{uc $name};
		651	defined $htype
		652	or Carp::croak "unsupported hook type '$name'";
		653
		654	if (delete $self->{term}{_hook}[$htype]{$pkg}) {
		655	--$hook_count[$htype]
		656	or urxvt::set_should_invoke $htype, 0;
		657	}
		658	}
		659	}
		660
		661	our $AUTOLOAD;
		662
		663	sub AUTOLOAD {
		664	$AUTOLOAD =~ /:([^:]+)$/
573	or die "FATAL: \$AUTOLOAD '$urxvt::term::proxy::AUTOLOAD' unparsable";	665	or die "FATAL: \$AUTOLOAD '$AUTOLOAD' unparsable";
574		666
575	eval qq{	667	eval qq{
576	sub $urxvt::term::proxy::AUTOLOAD {	668	sub $AUTOLOAD {
577	my \$proxy = shift;	669	my \$proxy = shift;
578	\$proxy->{term}->$1 (\@_)	670	\$proxy->{term}->$1 (\@_)
579	}	671	}
580	1	672	1
581	} or die "FATAL: unable to compile method forwarder: $@";	673	} or die "FATAL: unable to compile method forwarder: $@";
582		674
583	goto &$urxvt::term::proxy::AUTOLOAD;	675	goto &$AUTOLOAD;
584	}	676	}
585		677
586	sub urxvt::term::proxy::DESTROY {	678	sub DESTROY {
587	# nop	679	# nop
588	}	680	}
589		681
590	# urxvt::destroy_hook	682	# urxvt::destroy_hook
591		683
…		…
601		693
602	=head2 The C<urxvt::anyevent> Class	694	=head2 The C<urxvt::anyevent> Class
603		695
604	The sole purpose of this class is to deliver an interface to the	696	The sole purpose of this class is to deliver an interface to the
605	C<AnyEvent> module - any module using it will work inside urxvt without	697	C<AnyEvent> module - any module using it will work inside urxvt without
606	further work. The only exception is that you cannot wait on condition	698	further programming. The only exception is that you cannot wait on
607	variables, but non-blocking condvar use is ok. What this means is that you	699	condition variables, but non-blocking condvar use is ok. What this means
608	cannot use blocking APIs, but the non-blocking variant should work.	700	is that you cannot use blocking APIs, but the non-blocking variant should
		701	work.
609		702
610	=cut	703	=cut
611		704
612	our $VERSION = 1;	705	our $VERSION = 1;
613		706
…		…
658	${$_[0]}++;	751	${$_[0]}++;
659	}	752	}
660		753
661	sub urxvt::anyevent::condvar::wait {	754	sub urxvt::anyevent::condvar::wait {
662	unless (${$_[0]}) {	755	unless (${$_[0]}) {
663	require Carp;
664	Carp::croak ("AnyEvent->condvar blocking wait unsupported in urxvt, use a non-blocking API");	756	Carp::croak "AnyEvent->condvar blocking wait unsupported in urxvt, use a non-blocking API";
665	}	757	}
666	}	758	}
667		759
668	package urxvt::term;	760	package urxvt::term;
669		761
670	=head2 The C<urxvt::term> Class	762	=head2 The C<urxvt::term> Class
671		763
672	=over 4	764	=over 4
673		765
		766	=cut
		767
		768	# find on_xxx subs in the package and register them
		769	# as hooks
		770	sub register_package {
		771	my ($self, $pkg, $argv) = @_;
		772
		773	my $proxy = bless {
		774	_pkg => $pkg,
		775	argv => $argv,
		776	}, $pkg;
		777	Scalar::Util::weaken ($proxy->{term} = $self);
		778
		779	$self->{_pkg}{$pkg} = $proxy;
		780
		781	for my $name (@HOOKNAME) {
		782	if (my $ref = $pkg->can ("on_" . lc $name)) {
		783	$proxy->enable ($name => $ref);
		784	}
		785	}
		786	}
		787
674	=item $term->destroy	788	=item $term->destroy
675		789
676	Destroy the terminal object (close the window, free resources etc.).	790	Destroy the terminal object (close the window, free resources
		791	etc.). Please note that @@RXVT_NAME@@ will not exit as long as any event
		792	watchers (timers, io watchers) are still active.
677		793
678	=item $isset = $term->option ($optval[, $set])	794	=item $isset = $term->option ($optval[, $set])
679		795
680	Returns true if the option specified by C<$optval> is enabled, and	796	Returns true if the option specified by C<$optval> is enabled, and
681	optionally change it. All option values are stored by name in the hash	797	optionally change it. All option values are stored by name in the hash
…		…
731	my ($self, $name) = (shift, shift);	847	my ($self, $name) = (shift, shift);
732	unshift @_, $self, $name, ($name =~ s/\s\+\s(\d+)$// ? $1 : 0);	848	unshift @_, $self, $name, ($name =~ s/\s\+\s(\d+)$// ? $1 : 0);
733	&urxvt::term::_resource	849	&urxvt::term::_resource
734	}	850	}
735		851
		852	=item $success = $term->parse_keysym ($keysym_spec, $command_string)
		853
		854	Adds a keymap translation exactly as specified via a resource. See the
		855	C<keysym> resource in the @@RXVT_NAME@@(1) manpage.
		856
736	=item $rend = $term->rstyle ([$new_rstyle])	857	=item $rend = $term->rstyle ([$new_rstyle])
737		858
738	Return and optionally change the current rendition. Text that is output by	859	Return and optionally change the current rendition. Text that is output by
739	the terminal application will use this style.	860	the terminal application will use this style.
740		861
…		…
759		880
760	=item $oldtext = $term->selection ([$newtext])	881	=item $oldtext = $term->selection ([$newtext])
761		882
762	Return the current selection text and optionally replace it by C<$newtext>.	883	Return the current selection text and optionally replace it by C<$newtext>.
763		884
764	#=item $term->overlay ($x, $y, $text)	885	=item $term->overlay_simple ($x, $y, $text)
765	#	886
766	#Create a simple multi-line overlay box. See the next method for details.	887	Create a simple multi-line overlay box. See the next method for details.
767	#	888
768	#=cut	889	=cut
769	#	890
770	#sub urxvt::term::scr_overlay {	891	sub overlay_simple {
771	# my ($self, $x, $y, $text) = @_;	892	my ($self, $x, $y, $text) = @_;
772	#	893
773	# my @lines = split /\n/, $text;	894	my @lines = split /\n/, $text;
774	#	895
775	# my $w = 0;	896	my $w = List::Util::max map $self->strwidth ($_), @lines;
776	# for (map $self->strwidth ($_), @lines) {	897
777	# $w = $_ if $w < $_;
778	# }
779	#
780	# $self->scr_overlay_new ($x, $y, $w, scalar @lines);	898	my $overlay = $self->overlay ($x, $y, $w, scalar @lines);
781	# $self->scr_overlay_set (0, $_, $lines[$_]) for 0.. $#lines;	899	$overlay->set (0, $_, $lines[$_]) for 0.. $#lines;
782	#}	900
		901	$overlay
		902	}
783		903
784	=item $term->overlay ($x, $y, $width, $height[, $rstyle[, $border]])	904	=item $term->overlay ($x, $y, $width, $height[, $rstyle[, $border]])
785		905
786	Create a new (empty) overlay at the given position with the given	906	Create a new (empty) overlay at the given position with the given
787	width/height. C<$rstyle> defines the initial rendition style	907	width/height. C<$rstyle> defines the initial rendition style
…		…
854		974
855	=item $string = $term->locale_decode ($octets)	975	=item $string = $term->locale_decode ($octets)
856		976
857	Convert the given locale-encoded octets into a perl string.	977	Convert the given locale-encoded octets into a perl string.
858		978
		979	=item $term->scr_xor_span ($beg_row, $beg_col, $end_row, $end_col[, $rstyle])
		980
		981	XORs the rendition values in the given span with the provided value
		982	(default: C<RS_RVid>). Useful in refresh hooks to provide effects similar
		983	to the selection.
		984
		985	=item $term->scr_xor_rect ($beg_row, $beg_col, $end_row, $end_col[, $rstyle1[, $rstyle2]])
		986
		987	Similar to C<scr_xor_span>, but xors a rectangle instead. Trailing
		988	whitespace will additionally be xored with the C<$rstyle2>, which defaults
		989	to C<RS_RVid \| RS_Uline>, which removes reverse video again and underlines
		990	it instead.
		991
		992	=item $term->scr_bell
		993
		994	Ring the bell!
		995
859	=item $term->scr_add_lines ($string)	996	=item $term->scr_add_lines ($string)
860		997
861	Write the given text string to the screen, as if output by the application	998	Write the given text string to the screen, as if output by the application
862	running inside the terminal. It may not contain command sequences (escape	999	running inside the terminal. It may not contain command sequences (escape
863	codes), but is free to use line feeds, carriage returns and tabs. The	1000	codes), but is free to use line feeds, carriage returns and tabs. The
…		…
877		1014
878	Write the octets given in C<$data> to the tty (i.e. as program input). To	1015	Write the octets given in C<$data> to the tty (i.e. as program input). To
879	pass characters instead of octets, you should convert your strings first	1016	pass characters instead of octets, you should convert your strings first
880	to the locale-specific encoding using C<< $term->locale_encode >>.	1017	to the locale-specific encoding using C<< $term->locale_encode >>.
881		1018
		1019	=item $old_events = $term->pty_ev_events ([$new_events])
		1020
		1021	Replaces the event mask of the pty watcher by the given event mask. Can
		1022	be used to suppress input and output handling to the pty/tty. See the
		1023	description of C<< urxvt::timer->events >>. Make sure to always restore
		1024	the previous value.
		1025
882	=item $windowid = $term->parent	1026	=item $windowid = $term->parent
883		1027
884	Return the window id of the toplevel window.	1028	Return the window id of the toplevel window.
885		1029
886	=item $windowid = $term->vt	1030	=item $windowid = $term->vt
…		…
910	=item $nrow_plus_saveLines = $term->total_rows	1054	=item $nrow_plus_saveLines = $term->total_rows
911		1055
912	=item $lines_in_scrollback = $term->nsaved	1056	=item $lines_in_scrollback = $term->nsaved
913		1057
914	Return various integers describing terminal characteristics.	1058	Return various integers describing terminal characteristics.
		1059
		1060	=item $lc_ctype = $term->locale
		1061
		1062	Returns the LC_CTYPE category string used by this rxvt-unicode.
		1063
		1064	=item $x_display = $term->display_id
		1065
		1066	Return the DISPLAY used by rxvt-unicode.
915		1067
916	=item $modifiermask = $term->ModLevel3Mask	1068	=item $modifiermask = $term->ModLevel3Mask
917		1069
918	=item $modifiermask = $term->ModMetaMask	1070	=item $modifiermask = $term->ModMetaMask
919		1071
…		…
1109	Converts rxvt-unicodes text reprsentation into a perl string. See	1261	Converts rxvt-unicodes text reprsentation into a perl string. See
1110	C<< $term->ROW_t >> for details.	1262	C<< $term->ROW_t >> for details.
1111		1263
1112	=item $success = $term->grab_button ($button, $modifiermask)	1264	=item $success = $term->grab_button ($button, $modifiermask)
1113		1265
1114	Registers a synchronous button grab. See XGrabButton.	1266	Registers a synchronous button grab. See the XGrabButton manpage.
1115		1267
1116	=item $success = $term->grab ($eventtime[, $sync])	1268	=item $success = $term->grab ($eventtime[, $sync])
1117		1269
1118	Calls XGrabPointer and XGrabKeyboard in asynchronous (default) or	1270	Calls XGrabPointer and XGrabKeyboard in asynchronous (default) or
1119	synchronous (C<$sync> is true). Also remembers the grab timestampe.	1271	synchronous (C<$sync> is true). Also remembers the grab timestampe.
…		…
1162	}	1314	}
1163		1315
1164	sub add_separator {	1316	sub add_separator {
1165	my ($self, $sep) = @_;	1317	my ($self, $sep) = @_;
1166		1318
1167	$sep \|\|= "═";	1319	$sep \|\|= "=";
1168		1320
1169	$self->add_item ({	1321	$self->add_item ({
1170	rend => { normal => "\x1b[0;30;47m", hover => "\x1b[0;30;47m", active => "\x1b[0;30;47m" },	1322	rend => { normal => "\x1b[0;30;47m", hover => "\x1b[0;30;47m", active => "\x1b[0;30;47m" },
1171	text => "",	1323	text => "",
1172	render => sub { $sep x $urxvt::TERM->ncol },	1324	render => sub { $sep x $self->{term}->ncol },
1173	activate => sub { },	1325	activate => sub { },
1174	});	1326	});
1175	}	1327	}
1176		1328
1177	sub add_title {	1329	sub add_title {
…		…
1185	}	1337	}
1186		1338
1187	sub add_button {	1339	sub add_button {
1188	my ($self, $text, $cb) = @_;	1340	my ($self, $text, $cb) = @_;
1189		1341
1190	$self->add_item ({ type => "button", text => "[ $text ]", activate => $cb});	1342	$self->add_item ({ type => "button", text => $text, activate => $cb});
1191	}	1343	}
1192		1344
1193	sub add_toggle {	1345	sub add_toggle {
1194	my ($self, $text, $cb, $value) = @_;	1346	my ($self, $text, $cb, $value) = @_;
1195		1347
…		…
1207	sub show {	1359	sub show {
1208	my ($self) = @_;	1360	my ($self) = @_;
1209		1361
1210	local $urxvt::popup::self = $self;	1362	local $urxvt::popup::self = $self;
1211		1363
		1364	local $ENV{LC_ALL} = $self->{term}->locale;
		1365
1212	urxvt->new ("--perl-lib" => "", "--perl-ext-common" => "", "-pty-fd" => -1, "-sl" => 0, "-b" => 0,	1366	urxvt->new ("--perl-lib" => "", "--perl-ext-common" => "", "-pty-fd" => -1, "-sl" => 0, "-b" => 0,
1213	"--transient-for" => $self->{term}->parent,	1367	"--transient-for" => $self->{term}->parent,
		1368	"-display" => $self->{term}->display_id,
1214	"-pe" => "urxvt-popup")	1369	"-pe" => "urxvt-popup")
1215	or die "unable to create popup window\n";	1370	or die "unable to create popup window\n";
1216	}	1371	}
1217		1372
1218	sub DESTROY {	1373	sub DESTROY {
…		…
1281		1436
1282	$term->{socket} = ...	1437	$term->{socket} = ...
1283	$term->{iow} = urxvt::iow	1438	$term->{iow} = urxvt::iow
1284	->new	1439	->new
1285	->fd (fileno $term->{socket})	1440	->fd (fileno $term->{socket})
1286	->events (1) # wait for read data	1441	->events (urxvt::EVENT_READ)
1287	->start	1442	->start
1288	->cb (sub {	1443	->cb (sub {
1289	my ($iow, $revents) = @_;	1444	my ($iow, $revents) = @_;
1290	# $revents must be 1 here, no need to check	1445	# $revents must be 1 here, no need to check
1291	sysread $term->{socket}, my $buf, 8192	1446	sysread $term->{socket}, my $buf, 8192
…		…
1308		1463
1309	Set the filedescriptor (not handle) to watch.	1464	Set the filedescriptor (not handle) to watch.
1310		1465
1311	=item $iow = $iow->events ($eventmask)	1466	=item $iow = $iow->events ($eventmask)
1312		1467
1313	Set the event mask to watch. Bit #0 (value C<1>) enables watching for read	1468	Set the event mask to watch. The only allowed values are
1314	data, Bit #1 (value C<2>) enables watching for write data.	1469	C<urxvt::EVENT_READ> and C<urxvt::EVENT_WRITE>, which might be ORed
		1470	together, or C<urxvt::EVENT_NONE>.
1315		1471
1316	=item $iow = $iow->start	1472	=item $iow = $iow->start
1317		1473
1318	Start watching for requested events on the given handle.	1474	Start watching for requested events on the given handle.
1319		1475

Diff Legend

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

Comparing rxvt-unicode/src/urxvt.pm (file contents): Revision 1.61 by root, Mon Jan 9 01:36:56 2006 UTC vs. Revision 1.75 by root, Tue Jan 10 05:00:13 2006 UTC

Diff Legend

Comparing rxvt-unicode/src/urxvt.pm (file contents):
Revision 1.61 by root, Mon Jan 9 01:36:56 2006 UTC vs.
Revision 1.75 by root, Tue Jan 10 05:00:13 2006 UTC