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

Comparing rxvt-unicode/src/urxvt.pm (file contents):
Revision 1.65 by root, Mon Jan 9 19:25:57 2006 UTC vs.
Revision 1.76 by root, Tue Jan 10 19:46:28 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
…		…
386		449
387	=item $background = urxvt::GET_BASEBG $rend	450	=item $background = urxvt::GET_BASEBG $rend
388		451
389	Return the foreground/background colour index, respectively.	452	Return the foreground/background colour index, respectively.
390		453
391	=item $rend = urxvt::SET_FGCOLOR ($rend, $new_colour)	454	=item $rend = urxvt::SET_FGCOLOR $rend, $new_colour
392		455
393	=item $rend = urxvt::SET_BGCOLOR ($rend, $new_colour)	456	=item $rend = urxvt::SET_BGCOLOR $rend, $new_colour
394		457
395	Replace the foreground/background colour in the rendition mask with the	458	Replace the foreground/background colour in the rendition mask with the
396	specified one.	459	specified one.
397		460
398	=item $value = urxvt::GET_CUSTOM ($rend)	461	=item $value = urxvt::GET_CUSTOM $rend
399		462
400	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
401	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
402	zero.	465	zero.
403		466
404	=item $rend = urxvt::SET_CUSTOM ($rend, $new_value)	467	=item $rend = urxvt::SET_CUSTOM $rend, $new_value
405		468
406	Change the custom value.	469	Change the custom value.
407		470
408	=back	471	=back
409		472
…		…
411		474
412	package urxvt;	475	package urxvt;
413		476
414	use utf8;	477	use utf8;
415	use strict;	478	use strict;
		479	use Carp ();
416	use Scalar::Util ();	480	use Scalar::Util ();
417	use List::Util ();	481	use List::Util ();
418		482
419	our $VERSION = 1;	483	our $VERSION = 1;
420	our $TERM;	484	our $TERM;
421	our @HOOKNAME;	485	our @HOOKNAME;
		486	our %HOOKTYPE = map +($HOOKNAME[$_] => $_), 0..$#HOOKNAME;
422	our %OPTION;	487	our %OPTION;
		488
423	our $LIBDIR;	489	our $LIBDIR;
		490	our $RESNAME;
		491	our $RESCLASS;
		492	our $RXVTNAME;
424		493
425	BEGIN {	494	BEGIN {
426	urxvt->bootstrap;	495	urxvt->bootstrap;
427		496
428	# overwrite perl's warn	497	# overwrite perl's warn
…		…
445	sub verbose {	514	sub verbose {
446	my ($level, $msg) = @_;	515	my ($level, $msg) = @_;
447	warn "$msg\n" if $level <= $verbosity;	516	warn "$msg\n" if $level <= $verbosity;
448	}	517	}
449		518
450	# find on_xxx subs in the package and register them
451	# as hooks
452	sub register_package($) {
453	my ($pkg) = @_;
454
455	for my $htype (0.. $#HOOKNAME) {
456	my $name = $HOOKNAME[$htype];
457
458	my $ref = $pkg->can ("on_" . lc $name)
459	or next;
460
461	$TERM->{_hook}[$htype]{$pkg} = $ref;
462	$hook_count[$htype]++
463	or set_should_invoke $htype, 1;
464	}
465	}
466
467	my $extension_pkg = "extension0000";	519	my $extension_pkg = "extension0000";
468	my %extension_pkg;	520	my %extension_pkg;
469		521
470	# load a single script into its own package, once only	522	# load a single script into its own package, once only
471	sub extension_package($) {	523	sub extension_package($) {
…		…
477	verbose 3, "loading extension '$path' into package '$pkg'";	529	verbose 3, "loading extension '$path' into package '$pkg'";
478		530
479	open my $fh, "<:raw", $path	531	open my $fh, "<:raw", $path
480	or die "$path: $!";	532	or die "$path: $!";
481		533
		534	my $source = untaint
482	my $source = untaint "package $pkg; use strict; use utf8;\n"	535	"package $pkg; use strict; use utf8;\n"
483	. "use base urxvt::term::proxy::;\n"	536	. "use base urxvt::term::extension::;\n"
484	. "#line 1 \"$path\"\n{\n"	537	. "#line 1 \"$path\"\n{\n"
485	. (do { local $/; <$fh> })	538	. (do { local $/; <$fh> })
486	. "\n};\n1";	539	. "\n};\n1";
487		540
		541	eval $source
488	eval $source or die "$path: $@";	542	or die "$path: $@";
489		543
490	$pkg	544	$pkg
491	}	545	}
492	}	546	}
493		547
…		…
499	my $htype = shift;	553	my $htype = shift;
500		554
501	if ($htype == 0) { # INIT	555	if ($htype == 0) { # INIT
502	my @dirs = ((split /:/, $TERM->resource ("perl_lib")), "$LIBDIR/perl");	556	my @dirs = ((split /:/, $TERM->resource ("perl_lib")), "$LIBDIR/perl");
503		557
504	my %want_ext;	558	my %ext_arg;
505		559
506	for (map { split /,/, $TERM->resource ("perl_ext_$_") } 1, 2) {	560	for (map { split /,/, $TERM->resource ("perl_ext_$_") } 1, 2) {
507	if ($_ eq "default") {	561	if ($_ eq "default") {
508	$want_ext{$_}++ for qw(selection option-popup selection-popup);	562	$ext_arg{$_} \|\|= [] for qw(selection option-popup selection-popup searchable-scrollback);
509	} elsif (/^-(.*)$/) {	563	} elsif (/^-(.*)$/) {
510	delete $want_ext{$1};	564	delete $ext_arg{$1};
		565	} elsif (/^([^<]+)<(.*)>$/) {
		566	push @{ $ext_arg{$1} }, $2;
511	} else {	567	} else {
512	$want_ext{$_}++;	568	$ext_arg{$_} \|\|= [];
513	}	569	}
514	}	570	}
515		571
516	for my $ext (keys %want_ext) {	572	while (my ($ext, $argv) = each %ext_arg) {
517	my @files = grep -f $_, map "$_/$ext", @dirs;	573	my @files = grep -f $_, map "$_/$ext", @dirs;
518		574
519	if (@files) {	575	if (@files) {
520	register_package extension_package $files[0];	576	$TERM->register_package (extension_package $files[0], $argv);
521	} else {	577	} else {
522	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";
523	}	579	}
524	}	580	}
525		581
…		…
534	if $verbosity >= 10;	590	if $verbosity >= 10;
535		591
536	keys %$cb;	592	keys %$cb;
537		593
538	while (my ($pkg, $cb) = each %$cb) {	594	while (my ($pkg, $cb) = each %$cb) {
539	eval {	595	$retval = eval { $cb->($TERM->{_pkg}{$pkg}, @_) }
540	$retval = $cb->(
541	$TERM->{_pkg}{$pkg} \|\|= do {
542	my $proxy = bless { }, $pkg;
543	Scalar::Util::weaken ($proxy->{term} = $TERM);
544	$proxy
545	},
546	@_,
547	) and last;	596	and last;
548	};	597
549	if ($@) {	598	if ($@) {
550	$TERM->ungrab; # better to lose the grab than the session	599	$TERM->ungrab; # better to lose the grab than the session
551	warn $@;	600	warn $@;
552	}	601	}
553	}	602	}
554	}	603	}
555		604
556	if ($htype == 1) { # DESTROY	605	if ($htype == 1) { # DESTROY
557	# remove hooks if unused
558	if (my $hook = $TERM->{_hook}) {	606	if (my $hook = delete $TERM->{_hook}) {
559	for my $htype (0..$#$hook) {	607	for my $htype (0..$#$hook) {
560	$hook_count[$htype] -= scalar keys %{ $hook->[$htype] \|\| {} }	608	$hook_count[$htype] -= scalar keys %{ $hook->[$htype] \|\| {} }
561	or set_should_invoke $htype, 0;	609	or set_should_invoke $htype, 0;
562	}	610	}
563	}	611	}
…		…
570	}	618	}
571		619
572	$retval	620	$retval
573	}	621	}
574		622
575	# urxvt::term::proxy	623	# urxvt::term::extension
576		624
577	sub urxvt::term::proxy::AUTOLOAD {	625	package urxvt::term::extension;
578	$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 =~ /:([^:]+)$/
579	or die "FATAL: \$AUTOLOAD '$urxvt::term::proxy::AUTOLOAD' unparsable";	665	or die "FATAL: \$AUTOLOAD '$AUTOLOAD' unparsable";
580		666
581	eval qq{	667	eval qq{
582	sub $urxvt::term::proxy::AUTOLOAD {	668	sub $AUTOLOAD {
583	my \$proxy = shift;	669	my \$proxy = shift;
584	\$proxy->{term}->$1 (\@_)	670	\$proxy->{term}->$1 (\@_)
585	}	671	}
586	1	672	1
587	} or die "FATAL: unable to compile method forwarder: $@";	673	} or die "FATAL: unable to compile method forwarder: $@";
588		674
589	goto &$urxvt::term::proxy::AUTOLOAD;	675	goto &$AUTOLOAD;
590	}	676	}
591		677
592	sub urxvt::term::proxy::DESTROY {	678	sub DESTROY {
593	# nop	679	# nop
594	}	680	}
595		681
596	# urxvt::destroy_hook	682	# urxvt::destroy_hook
597		683
…		…
607		693
608	=head2 The C<urxvt::anyevent> Class	694	=head2 The C<urxvt::anyevent> Class
609		695
610	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
611	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
612	further work. The only exception is that you cannot wait on condition	698	further programming. The only exception is that you cannot wait on
613	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
614	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.
615		702
616	=cut	703	=cut
617		704
618	our $VERSION = 1;	705	our $VERSION = 1;
619		706
…		…
664	${$_[0]}++;	751	${$_[0]}++;
665	}	752	}
666		753
667	sub urxvt::anyevent::condvar::wait {	754	sub urxvt::anyevent::condvar::wait {
668	unless (${$_[0]}) {	755	unless (${$_[0]}) {
669	require Carp;
670	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";
671	}	757	}
672	}	758	}
673		759
674	package urxvt::term;	760	package urxvt::term;
675		761
676	=head2 The C<urxvt::term> Class	762	=head2 The C<urxvt::term> Class
677		763
678	=over 4	764	=over 4
679		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
680	=item $term->destroy	788	=item $term->destroy
681		789
682	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.
683		793
684	=item $isset = $term->option ($optval[, $set])	794	=item $isset = $term->option ($optval[, $set])
685		795
686	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
687	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
…		…
737	my ($self, $name) = (shift, shift);	847	my ($self, $name) = (shift, shift);
738	unshift @_, $self, $name, ($name =~ s/\s\+\s(\d+)$// ? $1 : 0);	848	unshift @_, $self, $name, ($name =~ s/\s\+\s(\d+)$// ? $1 : 0);
739	&urxvt::term::_resource	849	&urxvt::term::_resource
740	}	850	}
741		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
742	=item $rend = $term->rstyle ([$new_rstyle])	857	=item $rend = $term->rstyle ([$new_rstyle])
743		858
744	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
745	the terminal application will use this style.	860	the terminal application will use this style.
746		861
…		…
765		880
766	=item $oldtext = $term->selection ([$newtext])	881	=item $oldtext = $term->selection ([$newtext])
767		882
768	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>.
769		884
770	#=item $term->overlay ($x, $y, $text)	885	=item $term->overlay_simple ($x, $y, $text)
771	#	886
772	#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.
773	#	888
774	#=cut	889	=cut
775	#	890
776	#sub urxvt::term::scr_overlay {	891	sub overlay_simple {
777	# my ($self, $x, $y, $text) = @_;	892	my ($self, $x, $y, $text) = @_;
778	#	893
779	# my @lines = split /\n/, $text;	894	my @lines = split /\n/, $text;
780	#	895
781	# my $w = 0;	896	my $w = List::Util::max map $self->strwidth ($_), @lines;
782	# for (map $self->strwidth ($_), @lines) {	897
783	# $w = $_ if $w < $_;
784	# }
785	#
786	# $self->scr_overlay_new ($x, $y, $w, scalar @lines);	898	my $overlay = $self->overlay ($x, $y, $w, scalar @lines);
787	# $self->scr_overlay_set (0, $_, $lines[$_]) for 0.. $#lines;	899	$overlay->set (0, $_, $lines[$_]) for 0.. $#lines;
788	#}	900
		901	$overlay
		902	}
789		903
790	=item $term->overlay ($x, $y, $width, $height[, $rstyle[, $border]])	904	=item $term->overlay ($x, $y, $width, $height[, $rstyle[, $border]])
791		905
792	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
793	width/height. C<$rstyle> defines the initial rendition style	907	width/height. C<$rstyle> defines the initial rendition style
…		…
860		974
861	=item $string = $term->locale_decode ($octets)	975	=item $string = $term->locale_decode ($octets)
862		976
863	Convert the given locale-encoded octets into a perl string.	977	Convert the given locale-encoded octets into a perl string.
864		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
865	=item $term->scr_add_lines ($string)	996	=item $term->scr_add_lines ($string)
866		997
867	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
868	running inside the terminal. It may not contain command sequences (escape	999	running inside the terminal. It may not contain command sequences (escape
869	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
…		…
883		1014
884	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
885	pass characters instead of octets, you should convert your strings first	1016	pass characters instead of octets, you should convert your strings first
886	to the locale-specific encoding using C<< $term->locale_encode >>.	1017	to the locale-specific encoding using C<< $term->locale_encode >>.
887		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
888	=item $windowid = $term->parent	1026	=item $windowid = $term->parent
889		1027
890	Return the window id of the toplevel window.	1028	Return the window id of the toplevel window.
891		1029
892	=item $windowid = $term->vt	1030	=item $windowid = $term->vt
…		…
916	=item $nrow_plus_saveLines = $term->total_rows	1054	=item $nrow_plus_saveLines = $term->total_rows
917		1055
918	=item $lines_in_scrollback = $term->nsaved	1056	=item $lines_in_scrollback = $term->nsaved
919		1057
920	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.
921		1067
922	=item $modifiermask = $term->ModLevel3Mask	1068	=item $modifiermask = $term->ModLevel3Mask
923		1069
924	=item $modifiermask = $term->ModMetaMask	1070	=item $modifiermask = $term->ModMetaMask
925		1071
…		…
1165	$item->{render} \|\|= sub { $_[0]{text} };	1311	$item->{render} \|\|= sub { $_[0]{text} };
1166		1312
1167	push @{ $self->{item} }, $item;	1313	push @{ $self->{item} }, $item;
1168	}	1314	}
1169		1315
		1316	=item $popup->add_title ($title)
		1317
		1318	Adds a non-clickable title to the popup.
		1319
		1320	=cut
		1321
		1322	sub add_title {
		1323	my ($self, $title) = @_;
		1324
		1325	$self->add_item ({
		1326	rend => { normal => "\x1b[38;5;11;44m", hover => "\x1b[38;5;11;44m", active => "\x1b[38;5;11;44m" },
		1327	text => $title,
		1328	activate => sub { },
		1329	});
		1330	}
		1331
		1332	=item $popup->add_separator ([$sepchr])
		1333
		1334	Creates a separator, optionally using the character given as C<$sepchr>.
		1335
		1336	=cut
		1337
1170	sub add_separator {	1338	sub add_separator {
1171	my ($self, $sep) = @_;	1339	my ($self, $sep) = @_;
1172		1340
1173	$sep \|\|= "═";	1341	$sep \|\|= "=";
1174		1342
1175	$self->add_item ({	1343	$self->add_item ({
1176	rend => { normal => "\x1b[0;30;47m", hover => "\x1b[0;30;47m", active => "\x1b[0;30;47m" },	1344	rend => { normal => "\x1b[0;30;47m", hover => "\x1b[0;30;47m", active => "\x1b[0;30;47m" },
1177	text => "",	1345	text => "",
1178	render => sub { $sep x $self->{term}->ncol },	1346	render => sub { $sep x $self->{term}->ncol },
1179	activate => sub { },	1347	activate => sub { },
1180	});	1348	});
1181	}	1349	}
1182		1350
1183	sub add_title {	1351	=item $popup->add_button ($text, $cb)
1184	my ($self, $title) = @_;
1185		1352
1186	$self->add_item ({	1353	Adds a clickable button to the popup. C<$cb> is called whenever it is
1187	rend => { normal => "\x1b[38;5;11;44m", hover => "\x1b[38;5;11;44m", active => "\x1b[38;5;11;44m" },	1354	selected.
1188	text => $title,	1355
1189	activate => sub { },	1356	=cut
1190	});
1191	}
1192		1357
1193	sub add_button {	1358	sub add_button {
1194	my ($self, $text, $cb) = @_;	1359	my ($self, $text, $cb) = @_;
1195		1360
1196	$self->add_item ({ type => "button", text => $text, activate => $cb});	1361	$self->add_item ({ type => "button", text => $text, activate => $cb});
1197	}	1362	}
		1363
		1364	=item $popup->add_toggle ($text, $cb, $initial_value)
		1365
		1366	Adds a toggle/checkbox item to the popup. Teh callback gets called
		1367	whenever it gets toggled, with a boolean indicating its value as its first
		1368	argument.
		1369
		1370	=cut
1198		1371
1199	sub add_toggle {	1372	sub add_toggle {
1200	my ($self, $text, $cb, $value) = @_;	1373	my ($self, $text, $cb, $value) = @_;
1201		1374
1202	my $item; $item = {	1375	my $item; $item = {
1203	type => "button",	1376	type => "button",
1204	text => " $text",	1377	text => " $text",
1205	value => $value,	1378	value => $value,
1206	render => sub { ($_[0]{value} ? "* " : " ") . $text },	1379	render => sub { ($_[0]{value} ? "* " : " ") . $text },
1207	activate => sub { $cb->($_[0]{value} = !$_[0]{value}); },	1380	activate => sub { $cb->($_[1]{value} = !$_[1]{value}); },
1208	};	1381	};
1209		1382
1210	$self->add_item ($item);	1383	$self->add_item ($item);
1211	}	1384	}
		1385
		1386	=item $popup->show
		1387
		1388	Displays the popup (which is initially hidden).
		1389
		1390	=cut
1212		1391
1213	sub show {	1392	sub show {
1214	my ($self) = @_;	1393	my ($self) = @_;
1215		1394
1216	local $urxvt::popup::self = $self;	1395	local $urxvt::popup::self = $self;
…		…
1290		1469
1291	$term->{socket} = ...	1470	$term->{socket} = ...
1292	$term->{iow} = urxvt::iow	1471	$term->{iow} = urxvt::iow
1293	->new	1472	->new
1294	->fd (fileno $term->{socket})	1473	->fd (fileno $term->{socket})
1295	->events (1) # wait for read data	1474	->events (urxvt::EVENT_READ)
1296	->start	1475	->start
1297	->cb (sub {	1476	->cb (sub {
1298	my ($iow, $revents) = @_;	1477	my ($iow, $revents) = @_;
1299	# $revents must be 1 here, no need to check	1478	# $revents must be 1 here, no need to check
1300	sysread $term->{socket}, my $buf, 8192	1479	sysread $term->{socket}, my $buf, 8192
…		…
1317		1496
1318	Set the filedescriptor (not handle) to watch.	1497	Set the filedescriptor (not handle) to watch.
1319		1498
1320	=item $iow = $iow->events ($eventmask)	1499	=item $iow = $iow->events ($eventmask)
1321		1500
1322	Set the event mask to watch. Bit #0 (value C<1>) enables watching for read	1501	Set the event mask to watch. The only allowed values are
1323	data, Bit #1 (value C<2>) enables watching for write data.	1502	C<urxvt::EVENT_READ> and C<urxvt::EVENT_WRITE>, which might be ORed
		1503	together, or C<urxvt::EVENT_NONE>.
1324		1504
1325	=item $iow = $iow->start	1505	=item $iow = $iow->start
1326		1506
1327	Start watching for requested events on the given handle.	1507	Start watching for requested events on the given handle.
1328		1508

Diff Legend

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

Comparing rxvt-unicode/src/urxvt.pm (file contents): Revision 1.65 by root, Mon Jan 9 19:25:57 2006 UTC vs. Revision 1.76 by root, Tue Jan 10 19:46:28 2006 UTC

Diff Legend

Comparing rxvt-unicode/src/urxvt.pm (file contents):
Revision 1.65 by root, Mon Jan 9 19:25:57 2006 UTC vs.
Revision 1.76 by root, Tue Jan 10 19:46:28 2006 UTC