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

Comparing rxvt-unicode/src/urxvt.pm (file contents):
Revision 1.55 by root, Sun Jan 8 05:50:27 2006 UTC vs.
Revision 1.69 by root, Mon Jan 9 22:41:41 2006 UTC

…		…
58		58
59	=back	59	=back
60		60
61	=item option-popup (enabled by default)	61	=item option-popup (enabled by default)
62		62
63	Binds a popup menu to Ctrl-Button3 that lets you toggle (some) options at	63	Binds a popup menu to Ctrl-Button2 that lets you toggle (some) options at
64	runtime.	64	runtime.
		65
		66	=item selection-popup (enabled by default)
		67
		68	Binds a popup menu to Ctrl-Button3 that lets you convert the selection
		69	text into various other formats/action.
		70
		71	=item searchable-scrollback (enabled by default)
		72
		73	Adds regex search functionality to the scrollback buffer, triggered by a
		74	hotkey (default: C<M-s>). When in search mode, terminal input/output is
		75	suspended, C</> starts an incremental regex search, C<n> searches further,
		76	C<p> jumps to the previous match. C<enter> leaves search mode at the
		77	current position and C<escape> returns to the original position.
65		78
66	=item digital-clock	79	=item digital-clock
67		80
68	Displays a digital clock using the built-in overlay.	81	Displays a digital clock using the built-in overlay.
69		82
…		…
119	Either binary data or - more common - a text string encoded in a	132	Either binary data or - more common - a text string encoded in a
120	locale-specific way.	133	locale-specific way.
121		134
122	=back	135	=back
123		136
		137	=head2 Extension Objects
		138
		139	Very perl extension is a perl class. A separate perl object is created
		140	for each terminal and each extension and passed as the first parameter to
		141	hooks. So extensions can use their C<$self> object without having to think
		142	about other extensions, with the exception of methods and members that
		143	begin with an underscore character C<_>: these are reserved for internal
		144	use.
		145
		146	Although it isn't a C<urxvt::term> object, you can call all methods of the
		147	C<urxvt::term> class on this object.
		148
		149	It has the following methods and data members:
		150
		151	=over 4
		152
		153	=item $urxvt_term = $self->{term}
		154
		155	Returns the C<urxvt::term> object associated with this instance of the
		156	extension. This member I<must not> be changed in any way.
		157
		158	=item $self->enable ($hook_name => $cb, [$hook_name => $cb..])
		159
		160	Dynamically enable the given hooks (named without the C<on_> prefix) for
		161	this extension, replacing any previous hook. This is useful when you want
		162	to overwrite time-critical hooks only temporarily.
		163
		164	=item $self->disable ($hook_name[, $hook_name..])
		165
		166	Dynamically disable the given hooks.
		167
		168	=back
		169
124	=head2 Hooks	170	=head2 Hooks
125		171
126	The following subroutines can be declared in extension files, and will be	172	The following subroutines can be declared in extension files, and will be
127	called whenever the relevant event happens.	173	called whenever the relevant event happens.
128		174
129	The first argument passed to them is an object private to each terminal	175	The first argument passed to them is an extension oject as described in
130	and extension package. You can call all C<urxvt::term> methods on it, but	176	the in the C<Extension Objects> section.
131	its not a real C<urxvt::term> object. Instead, the real C<urxvt::term>
132	object that is shared between all packages is stored in the C<term>
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.
135		177
136	All of them must return a boolean value. If it is true, then the event	178	B<All> of these hooks must return a boolean value. If it is true, then the
137	counts as being I<consumed>, and the invocation of other hooks is skipped,	179	event counts as being I<consumed>, and the invocation of other hooks is
138	and the relevant action might not be carried out by the C++ code.	180	skipped, and the relevant action might not be carried out by the C++ code.
139		181
140	When in doubt, return a false value (preferably C<()>).	182	I<< When in doubt, return a false value (preferably C<()>). >>
141		183
142	=over 4	184	=over 4
143		185
144	=item on_init $term	186	=item on_init $term
145		187
…		…
199	than the scroll back buffer or the terminal.	241	than the scroll back buffer or the terminal.
200		242
201	It is called before lines are scrolled out (so rows 0 .. min ($lines - 1,	243	It is called before lines are scrolled out (so rows 0 .. min ($lines - 1,
202	$nrow - 1) represent the lines to be scrolled out). C<$saved> is the total	244	$nrow - 1) represent the lines to be scrolled out). C<$saved> is the total
203	number of lines that will be in the scrollback buffer.	245	number of lines that will be in the scrollback buffer.
204
205	=item on_tty_activity $term NYI
206
207	Called whenever the program(s) running in the urxvt window send output.
208		246
209	=item on_osc_seq $term, $string	247	=item on_osc_seq $term, $string
210		248
211	Called whenever the B<ESC ] 777 ; string ST> command sequence (OSC =	249	Called whenever the B<ESC ] 777 ; string ST> command sequence (OSC =
212	operating system command) is processed. Cursor position and other state	250	operating system command) is processed. Cursor position and other state
…		…
266	=item on_focus_out $term	304	=item on_focus_out $term
267		305
268	Called wheneever the window loses keyboard focus, before rxvt-unicode does	306	Called wheneever the window loses keyboard focus, before rxvt-unicode does
269	focus out processing.	307	focus out processing.
270		308
271	=item on_key_press $term, $event, $octets	309	=item on_key_press $term, $event, $keysym, $octets
272		310
273	=item on_key_release $term, $event	311	=item on_key_release $term, $event, $keysym
274		312
275	=item on_button_press $term, $event	313	=item on_button_press $term, $event
276		314
277	=item on_button_release $term, $event	315	=item on_button_release $term, $event
278		316
…		…
332	that calls this function.	370	that calls this function.
333		371
334	Using this function has the advantage that its output ends up in the	372	Using this function has the advantage that its output ends up in the
335	correct place, e.g. on stderr of the connecting urxvtc client.	373	correct place, e.g. on stderr of the connecting urxvtc client.
336		374
		375	=item $is_safe = urxvt::safe
		376
		377	Returns true when it is safe to do potentially unsafe things, such as
		378	evaluating perl code specified by the user. This is true when urxvt was
		379	started setuid or setgid.
		380
337	=item $time = urxvt::NOW	381	=item $time = urxvt::NOW
338		382
339	Returns the "current time" (as per the event loop).	383	Returns the "current time" (as per the event loop).
340		384
341	=item urxvt::CurrentTime	385	=item urxvt::CurrentTime
…		…
404		448
405	package urxvt;	449	package urxvt;
406		450
407	use utf8;	451	use utf8;
408	use strict;	452	use strict;
		453	use Carp ();
409	use Scalar::Util ();	454	use Scalar::Util ();
410	use List::Util ();	455	use List::Util ();
411		456
412	our $VERSION = 1;	457	our $VERSION = 1;
413	our $TERM;	458	our $TERM;
414	our @HOOKNAME;	459	our @HOOKNAME;
		460	our %HOOKTYPE = map +($HOOKNAME[$_] => $_), 0..$#HOOKNAME;
415	our %OPTION;	461	our %OPTION;
416	our $LIBDIR;	462	our $LIBDIR;
417		463
418	BEGIN {	464	BEGIN {
419	urxvt->bootstrap;	465	urxvt->bootstrap;
…		…
423	my $msg = join "", @_;	469	my $msg = join "", @_;
424	$msg .= "\n"	470	$msg .= "\n"
425	unless $msg =~ /\n$/;	471	unless $msg =~ /\n$/;
426	urxvt::warn ($msg);	472	urxvt::warn ($msg);
427	};	473	};
		474
		475	delete $ENV{IFS};
		476	delete $ENV{CDPATH};
		477	delete $ENV{BASH_ENV};
		478	$ENV{PATH} = "/bin:/sbin:/usr/bin:/usr/sbin:/usr/local/bin:/usr/local/sbin:/opt/bin:/opt/sbin";
428	}	479	}
429		480
430	my @hook_count;	481	my @hook_count;
431	my $verbosity = $ENV{URXVT_PERL_VERBOSITY};	482	my $verbosity = $ENV{URXVT_PERL_VERBOSITY};
432		483
433	sub verbose {	484	sub verbose {
434	my ($level, $msg) = @_;	485	my ($level, $msg) = @_;
435	warn "$msg\n" if $level <= $verbosity;	486	warn "$msg\n" if $level <= $verbosity;
436	}	487	}
437		488
438	# find on_xxx subs in the package and register them
439	# as hooks
440	sub register_package($) {
441	my ($pkg) = @_;
442
443	for my $htype (0.. $#HOOKNAME) {
444	my $name = $HOOKNAME[$htype];
445
446	my $ref = $pkg->can ("on_" . lc $name)
447	or next;
448
449	$TERM->{_hook}[$htype]{$pkg} = $ref;
450	$hook_count[$htype]++
451	or set_should_invoke $htype, 1;
452	}
453	}
454
455	my $extension_pkg = "extension0000";	489	my $extension_pkg = "extension0000";
456	my %extension_pkg;	490	my %extension_pkg;
457		491
458	# load a single script into its own package, once only	492	# load a single script into its own package, once only
459	sub extension_package($) {	493	sub extension_package($) {
…		…
465	verbose 3, "loading extension '$path' into package '$pkg'";	499	verbose 3, "loading extension '$path' into package '$pkg'";
466		500
467	open my $fh, "<:raw", $path	501	open my $fh, "<:raw", $path
468	or die "$path: $!";	502	or die "$path: $!";
469		503
		504	my $source = untaint
470	my $source = "package $pkg; use strict; use utf8;\n"	505	"package $pkg; use strict; use utf8;\n"
471	. "use base urxvt::term::proxy::;\n"	506	. "use base urxvt::term::proxy::;\n"
472	. "#line 1 \"$path\"\n{\n"	507	. "#line 1 \"$path\"\n{\n"
473	. (do { local $/; <$fh> })	508	. (do { local $/; <$fh> })
474	. "\n};\n1";	509	. "\n};\n1";
475		510
		511	eval $source
476	eval $source or die "$path: $@";	512	or die "$path: $@";
477		513
478	$pkg	514	$pkg
479	}	515	}
480	}	516	}
481		517
…		…
487	my $htype = shift;	523	my $htype = shift;
488		524
489	if ($htype == 0) { # INIT	525	if ($htype == 0) { # INIT
490	my @dirs = ((split /:/, $TERM->resource ("perl_lib")), "$LIBDIR/perl");	526	my @dirs = ((split /:/, $TERM->resource ("perl_lib")), "$LIBDIR/perl");
491		527
492	my %want_ext;	528	my %ext_arg;
493		529
494	for (map { split /,/, $TERM->resource ("perl_ext_$_") } 1, 2) {	530	for (map { split /,/, $TERM->resource ("perl_ext_$_") } 1, 2) {
495	if ($_ eq "default") {	531	if ($_ eq "default") {
496	$want_ext{$_}++ for qw(selection option-popup);	532	$ext_arg{$_} \|\|= [] for qw(selection option-popup selection-popup searchable-scrollback);
497	} elsif (/^-(.*)$/) {	533	} elsif (/^-(.*)$/) {
498	delete $want_ext{$1};	534	delete $ext_arg{$1};
		535	} elsif (/^([^<]+)<(.*)>$/) {
		536	push @{ $ext_arg{$1} }, $2;
499	} else {	537	} else {
500	$want_ext{$_}++;	538	$ext_arg{$_} \|\|= [];
501	}	539	}
502	}	540	}
503		541
504	for my $ext (keys %want_ext) {	542	while (my ($ext, $argv) = each %ext_arg) {
505	my @files = grep -f $_, map "$_/$ext", @dirs;	543	my @files = grep -f $_, map "$_/$ext", @dirs;
506		544
507	if (@files) {	545	if (@files) {
508	register_package extension_package $files[0];	546	$TERM->register_package (extension_package $files[0], $argv);
509	} else {	547	} else {
510	warn "perl extension '$ext' not found in perl library search path\n";	548	warn "perl extension '$ext' not found in perl library search path\n";
511	}	549	}
512	}	550	}
513		551
…		…
522	if $verbosity >= 10;	560	if $verbosity >= 10;
523		561
524	keys %$cb;	562	keys %$cb;
525		563
526	while (my ($pkg, $cb) = each %$cb) {	564	while (my ($pkg, $cb) = each %$cb) {
527	eval {	565	$retval = eval { $cb->($TERM->{_pkg}{$pkg}, @_) }
528	$retval = $cb->(
529	$TERM->{_pkg}{$pkg} \|\|= do {
530	my $proxy = bless { }, $pkg;
531	Scalar::Util::weaken ($proxy->{term} = $TERM);
532	$proxy
533	},
534	@_,
535	) and last;	566	and last;
		567
		568	if ($@) {
		569	$TERM->ungrab; # better to lose the grab than the session
		570	warn $@;
536	};	571	}
537	warn $@ if $@;#d#
538	}	572	}
539	}	573	}
540		574
541	if ($htype == 1) { # DESTROY	575	if ($htype == 1) { # DESTROY
542	# remove hooks if unused
543	if (my $hook = $TERM->{_hook}) {	576	if (my $hook = delete $TERM->{_hook}) {
544	for my $htype (0..$#$hook) {	577	for my $htype (0..$#$hook) {
545	$hook_count[$htype] -= scalar keys %{ $hook->[$htype] \|\| {} }	578	$hook_count[$htype] -= scalar keys %{ $hook->[$htype] \|\| {} }
546	or set_should_invoke $htype, 0;	579	or set_should_invoke $htype, 0;
547	}	580	}
548	}	581	}
…		…
557	$retval	590	$retval
558	}	591	}
559		592
560	# urxvt::term::proxy	593	# urxvt::term::proxy
561		594
562	sub urxvt::term::proxy::AUTOLOAD {	595	package urxvt::term::proxy;
563	$urxvt::term::proxy::AUTOLOAD =~ /:([^:]+)$/	596
		597	sub enable {
		598	my ($self, %hook) = @_;
		599	my $pkg = $self->{_pkg};
		600
		601	while (my ($name, $cb) = each %hook) {
		602	my $htype = $HOOKTYPE{uc $name};
		603	defined $htype
		604	or Carp::croak "unsupported hook type '$name'";
		605
		606	unless (exists $self->{term}{_hook}[$htype]{$pkg}) {
		607	$hook_count[$htype]++
		608	or urxvt::set_should_invoke $htype, 1;
		609	}
		610
		611	$self->{term}{_hook}[$htype]{$pkg} = $cb;
		612	}
		613	}
		614
		615	sub disable {
		616	my ($self, @hook) = @_;
		617	my $pkg = $self->{_pkg};
		618
		619	for my $name (@hook) {
		620	my $htype = $HOOKTYPE{uc $name};
		621	defined $htype
		622	or Carp::croak "unsupported hook type '$name'";
		623
		624	if (delete $self->{term}{_hook}[$htype]{$pkg}) {
		625	--$hook_count[$htype]
		626	or urxvt::set_should_invoke $htype, 0;
		627	}
		628	}
		629	}
		630
		631	our $AUTOLOAD;
		632
		633	sub AUTOLOAD {
		634	$AUTOLOAD =~ /:([^:]+)$/
564	or die "FATAL: \$AUTOLOAD '$urxvt::term::proxy::AUTOLOAD' unparsable";	635	or die "FATAL: \$AUTOLOAD '$AUTOLOAD' unparsable";
565		636
566	eval qq{	637	eval qq{
567	sub $urxvt::term::proxy::AUTOLOAD {	638	sub $AUTOLOAD {
568	my \$proxy = shift;	639	my \$proxy = shift;
569	\$proxy->{term}->$1 (\@_)	640	\$proxy->{term}->$1 (\@_)
570	}	641	}
571	1	642	1
572	} or die "FATAL: unable to compile method forwarder: $@";	643	} or die "FATAL: unable to compile method forwarder: $@";
573		644
574	goto &$urxvt::term::proxy::AUTOLOAD;	645	goto &$AUTOLOAD;
		646	}
		647
		648	sub DESTROY {
		649	# nop
575	}	650	}
576		651
577	# urxvt::destroy_hook	652	# urxvt::destroy_hook
578		653
579	sub urxvt::destroy_hook::DESTROY {	654	sub urxvt::destroy_hook::DESTROY {
…		…
582		657
583	sub urxvt::destroy_hook(&) {	658	sub urxvt::destroy_hook(&) {
584	bless \shift, urxvt::destroy_hook::	659	bless \shift, urxvt::destroy_hook::
585	}	660	}
586		661
587	# urxvt::anyevent
588
589	package urxvt::anyevent;	662	package urxvt::anyevent;
		663
		664	=head2 The C<urxvt::anyevent> Class
		665
		666	The sole purpose of this class is to deliver an interface to the
		667	C<AnyEvent> module - any module using it will work inside urxvt without
		668	further work. The only exception is that you cannot wait on condition
		669	variables, but non-blocking condvar use is ok. What this means is that you
		670	cannot use blocking APIs, but the non-blocking variant should work.
		671
		672	=cut
590		673
591	our $VERSION = 1;	674	our $VERSION = 1;
592		675
593	$INC{"urxvt/anyevent.pm"} = 1; # mark us as there	676	$INC{"urxvt/anyevent.pm"} = 1; # mark us as there
594	push @AnyEvent::REGISTRY, [urxvt => urxvt::anyevent::];	677	push @AnyEvent::REGISTRY, [urxvt => urxvt::anyevent::];
…		…
637	${$_[0]}++;	720	${$_[0]}++;
638	}	721	}
639		722
640	sub urxvt::anyevent::condvar::wait {	723	sub urxvt::anyevent::condvar::wait {
641	unless (${$_[0]}) {	724	unless (${$_[0]}) {
642	require Carp;
643	Carp::croak ("AnyEvent->condvar blocking wait unsupported in urxvt, use a non-blocking API");	725	Carp::croak "AnyEvent->condvar blocking wait unsupported in urxvt, use a non-blocking API";
644	}	726	}
645	}	727	}
646		728
647	package urxvt::term;	729	package urxvt::term;
648		730
649	=head2 The C<urxvt::term> Class	731	=head2 The C<urxvt::term> Class
650		732
651	=over 4	733	=over 4
		734
		735	=cut
		736
		737	# find on_xxx subs in the package and register them
		738	# as hooks
		739	sub register_package {
		740	my ($self, $pkg, $argv) = @_;
		741
		742	my $proxy = bless {
		743	_pkg => $pkg,
		744	argv => $argv,
		745	}, $pkg;
		746	Scalar::Util::weaken ($proxy->{term} = $self);
		747
		748	$self->{_pkg}{$pkg} = $proxy;
		749
		750	for my $name (@HOOKNAME) {
		751	if (my $ref = $pkg->can ("on_" . lc $name)) {
		752	$proxy->enable ($name => $ref);
		753	}
		754	}
		755	}
652		756
653	=item $term->destroy	757	=item $term->destroy
654		758
655	Destroy the terminal object (close the window, free resources etc.).	759	Destroy the terminal object (close the window, free resources etc.).
656		760
…		…
710	my ($self, $name) = (shift, shift);	814	my ($self, $name) = (shift, shift);
711	unshift @_, $self, $name, ($name =~ s/\s\+\s(\d+)$// ? $1 : 0);	815	unshift @_, $self, $name, ($name =~ s/\s\+\s(\d+)$// ? $1 : 0);
712	&urxvt::term::_resource	816	&urxvt::term::_resource
713	}	817	}
714		818
		819	=item $success = $term->parse_keysym ($keysym_spec, $command_string)
		820
		821	Adds a keymap translation exactly as specified via a resource. See the
		822	C<keysym> resource in the @@RXVT_NAME@@(1) manpage.
		823
715	=item $rend = $term->rstyle ([$new_rstyle])	824	=item $rend = $term->rstyle ([$new_rstyle])
716		825
717	Return and optionally change the current rendition. Text that is output by	826	Return and optionally change the current rendition. Text that is output by
718	the terminal application will use this style.	827	the terminal application will use this style.
719		828
…		…
738		847
739	=item $oldtext = $term->selection ([$newtext])	848	=item $oldtext = $term->selection ([$newtext])
740		849
741	Return the current selection text and optionally replace it by C<$newtext>.	850	Return the current selection text and optionally replace it by C<$newtext>.
742		851
743	#=item $term->overlay ($x, $y, $text)	852	=item $term->overlay_simple ($x, $y, $text)
744	#	853
745	#Create a simple multi-line overlay box. See the next method for details.	854	Create a simple multi-line overlay box. See the next method for details.
746	#	855
747	#=cut	856	=cut
748	#	857
749	#sub urxvt::term::scr_overlay {	858	sub overlay_simple {
750	# my ($self, $x, $y, $text) = @_;	859	my ($self, $x, $y, $text) = @_;
751	#	860
752	# my @lines = split /\n/, $text;	861	my @lines = split /\n/, $text;
753	#	862
754	# my $w = 0;	863	my $w = List::Util::max map $self->strwidth ($_), @lines;
755	# for (map $self->strwidth ($_), @lines) {	864
756	# $w = $_ if $w < $_;
757	# }
758	#
759	# $self->scr_overlay_new ($x, $y, $w, scalar @lines);	865	my $overlay = $self->overlay ($x, $y, $w, scalar @lines);
760	# $self->scr_overlay_set (0, $_, $lines[$_]) for 0.. $#lines;	866	$overlay->set (0, $_, $lines[$_]) for 0.. $#lines;
761	#}	867
		868	$overlay
		869	}
762		870
763	=item $term->overlay ($x, $y, $width, $height[, $rstyle[, $border]])	871	=item $term->overlay ($x, $y, $width, $height[, $rstyle[, $border]])
764		872
765	Create a new (empty) overlay at the given position with the given	873	Create a new (empty) overlay at the given position with the given
766	width/height. C<$rstyle> defines the initial rendition style	874	width/height. C<$rstyle> defines the initial rendition style
…		…
833		941
834	=item $string = $term->locale_decode ($octets)	942	=item $string = $term->locale_decode ($octets)
835		943
836	Convert the given locale-encoded octets into a perl string.	944	Convert the given locale-encoded octets into a perl string.
837		945
		946	=item $term->scr_bell
		947
		948	Ring the bell!
		949
838	=item $term->scr_add_lines ($string)	950	=item $term->scr_add_lines ($string)
839		951
840	Write the given text string to the screen, as if output by the application	952	Write the given text string to the screen, as if output by the application
841	running inside the terminal. It may not contain command sequences (escape	953	running inside the terminal. It may not contain command sequences (escape
842	codes), but is free to use line feeds, carriage returns and tabs. The	954	codes), but is free to use line feeds, carriage returns and tabs. The
…		…
856		968
857	Write the octets given in C<$data> to the tty (i.e. as program input). To	969	Write the octets given in C<$data> to the tty (i.e. as program input). To
858	pass characters instead of octets, you should convert your strings first	970	pass characters instead of octets, you should convert your strings first
859	to the locale-specific encoding using C<< $term->locale_encode >>.	971	to the locale-specific encoding using C<< $term->locale_encode >>.
860		972
		973	=item $old_events = $term->pty_ev_events ([$new_events])
		974
		975	Replaces the event mask of the pty watcher by the given event mask. Can
		976	be used to suppress input and output handling to the pty/tty. See the
		977	description of C<< urxvt::timer->events >>. Make sure to always restore
		978	the previous value.
		979
861	=item $windowid = $term->parent	980	=item $windowid = $term->parent
862		981
863	Return the window id of the toplevel window.	982	Return the window id of the toplevel window.
864		983
865	=item $windowid = $term->vt	984	=item $windowid = $term->vt
…		…
889	=item $nrow_plus_saveLines = $term->total_rows	1008	=item $nrow_plus_saveLines = $term->total_rows
890		1009
891	=item $lines_in_scrollback = $term->nsaved	1010	=item $lines_in_scrollback = $term->nsaved
892		1011
893	Return various integers describing terminal characteristics.	1012	Return various integers describing terminal characteristics.
		1013
		1014	=item $lc_ctype = $term->locale
		1015
		1016	Returns the LC_CTYPE category string used by this rxvt-unicode.
		1017
		1018	=item $x_display = $term->display_id
		1019
		1020	Return the DISPLAY used by rxvt-unicode.
894		1021
895	=item $modifiermask = $term->ModLevel3Mask	1022	=item $modifiermask = $term->ModLevel3Mask
896		1023
897	=item $modifiermask = $term->ModMetaMask	1024	=item $modifiermask = $term->ModMetaMask
898		1025
…		…
1075	$offset / $self->{ncol} + $self->{beg},	1202	$offset / $self->{ncol} + $self->{beg},
1076	$offset % $self->{ncol}	1203	$offset % $self->{ncol}
1077	)	1204	)
1078	}	1205	}
1079		1206
1080	=item ($row, $col) = $line->coord_of ($offset)
1081	=item $text = $term->special_encode $string	1207	=item $text = $term->special_encode $string
1082		1208
1083	Converts a perl string into the special encoding used by rxvt-unicode,	1209	Converts a perl string into the special encoding used by rxvt-unicode,
1084	where one character corresponds to one screen cell. See	1210	where one character corresponds to one screen cell. See
1085	C<< $term->ROW_t >> for details.	1211	C<< $term->ROW_t >> for details.
…		…
1087	=item $string = $term->special_decode $text	1213	=item $string = $term->special_decode $text
1088		1214
1089	Converts rxvt-unicodes text reprsentation into a perl string. See	1215	Converts rxvt-unicodes text reprsentation into a perl string. See
1090	C<< $term->ROW_t >> for details.	1216	C<< $term->ROW_t >> for details.
1091		1217
		1218	=item $success = $term->grab_button ($button, $modifiermask)
		1219
		1220	Registers a synchronous button grab. See the XGrabButton manpage.
		1221
		1222	=item $success = $term->grab ($eventtime[, $sync])
		1223
		1224	Calls XGrabPointer and XGrabKeyboard in asynchronous (default) or
		1225	synchronous (C<$sync> is true). Also remembers the grab timestampe.
		1226
		1227	=item $term->allow_events_async
		1228
		1229	Calls XAllowEvents with AsyncBoth for the most recent grab.
		1230
		1231	=item $term->allow_events_sync
		1232
		1233	Calls XAllowEvents with SyncBoth for the most recent grab.
		1234
		1235	=item $term->allow_events_replay
		1236
		1237	Calls XAllowEvents with both ReplayPointer and ReplayKeyboard for the most
		1238	recent grab.
		1239
		1240	=item $term->ungrab
		1241
		1242	Calls XUngrab for the most recent grab. Is called automatically on
		1243	evaluation errors, as it is better to lose the grab in the error case as
		1244	the session.
		1245
1092	=back	1246	=back
1093		1247
1094	=cut	1248	=cut
1095		1249
1096	package urxvt::popup;	1250	package urxvt::popup;
…		…
1114	}	1268	}
1115		1269
1116	sub add_separator {	1270	sub add_separator {
1117	my ($self, $sep) = @_;	1271	my ($self, $sep) = @_;
1118		1272
1119	$sep \|\|= "═";	1273	$sep \|\|= "=";
1120		1274
1121	$self->add_item ({	1275	$self->add_item ({
1122	rend => { normal => "\x1b[0;30;47m", hover => "\x1b[0;30;47m", active => "\x1b[0;30;47m" },	1276	rend => { normal => "\x1b[0;30;47m", hover => "\x1b[0;30;47m", active => "\x1b[0;30;47m" },
1123	text => "",	1277	text => "",
1124	render => sub { $sep x $urxvt::TERM->ncol },	1278	render => sub { $sep x $self->{term}->ncol },
1125	activate => sub { },	1279	activate => sub { },
1126	});	1280	});
1127	}	1281	}
1128		1282
1129	sub add_title {	1283	sub add_title {
…		…
1137	}	1291	}
1138		1292
1139	sub add_button {	1293	sub add_button {
1140	my ($self, $text, $cb) = @_;	1294	my ($self, $text, $cb) = @_;
1141		1295
1142	$self->add_item ({ type => "button", text => "[ $text ]", activate => $cb});	1296	$self->add_item ({ type => "button", text => $text, activate => $cb});
1143	}	1297	}
1144		1298
1145	sub add_toggle {	1299	sub add_toggle {
1146	my ($self, $text, $cb, $value) = @_;	1300	my ($self, $text, $cb, $value) = @_;
1147		1301
1148	my $item; $item = {	1302	my $item; $item = {
1149	type => "button",	1303	type => "button",
1150	text => " $text",	1304	text => " $text",
1151	value => $value,	1305	value => $value,
1152	render => sub { ($item->{value} ? "* " : " ") . $text },	1306	render => sub { ($_[0]{value} ? "* " : " ") . $text },
1153	activate => sub { $cb->($item->{value} = !$item->{value}); },	1307	activate => sub { $cb->($_[0]{value} = !$_[0]{value}); },
1154	};	1308	};
1155		1309
1156	$self->add_item ($item);	1310	$self->add_item ($item);
1157	}	1311	}
1158		1312
1159	sub show {	1313	sub show {
1160	my ($self) = @_;	1314	my ($self) = @_;
1161		1315
1162	local $urxvt::popup::self = $self;	1316	local $urxvt::popup::self = $self;
1163		1317
		1318	local $ENV{LC_ALL} = $self->{term}->locale;
		1319
1164	urxvt->new ("--perl-lib" => "", "--perl-ext-common" => "", "-pty-fd" => -1, "-sl" => 0, "-b" => 0,	1320	urxvt->new ("--perl-lib" => "", "--perl-ext-common" => "", "-pty-fd" => -1, "-sl" => 0, "-b" => 0,
1165	"--transient-for" => $self->{term}->parent,	1321	"--transient-for" => $self->{term}->parent,
		1322	"-display" => $self->{term}->display_id,
1166	"-pe" => "urxvt-popup")	1323	"-pe" => "urxvt-popup")
1167	or die "unable to create popup window\n";	1324	or die "unable to create popup window\n";
1168	}	1325	}
1169		1326
1170	sub DESTROY {	1327	sub DESTROY {
1171	my ($self) = @_;	1328	my ($self) = @_;
1172		1329
		1330	delete $self->{term}{_destroy}{$self};
1173	$self->{term}->ungrab;	1331	$self->{term}->ungrab;
1174	}	1332	}
1175		1333
1176	=head2 The C<urxvt::timer> Class	1334	=head2 The C<urxvt::timer> Class
1177		1335
…		…
1232		1390
1233	$term->{socket} = ...	1391	$term->{socket} = ...
1234	$term->{iow} = urxvt::iow	1392	$term->{iow} = urxvt::iow
1235	->new	1393	->new
1236	->fd (fileno $term->{socket})	1394	->fd (fileno $term->{socket})
1237	->events (1) # wait for read data	1395	->events (urxvt::EVENT_READ)
1238	->start	1396	->start
1239	->cb (sub {	1397	->cb (sub {
1240	my ($iow, $revents) = @_;	1398	my ($iow, $revents) = @_;
1241	# $revents must be 1 here, no need to check	1399	# $revents must be 1 here, no need to check
1242	sysread $term->{socket}, my $buf, 8192	1400	sysread $term->{socket}, my $buf, 8192
…		…
1259		1417
1260	Set the filedescriptor (not handle) to watch.	1418	Set the filedescriptor (not handle) to watch.
1261		1419
1262	=item $iow = $iow->events ($eventmask)	1420	=item $iow = $iow->events ($eventmask)
1263		1421
1264	Set the event mask to watch. Bit #0 (value C<1>) enables watching for read	1422	Set the event mask to watch. The only allowed values are
1265	data, Bit #1 (value C<2>) enables watching for write data.	1423	C<urxvt::EVENT_READ> and C<urxvt::EVENT_WRITE>, which might be ORed
		1424	together, or C<urxvt::EVENT_NONE>.
1266		1425
1267	=item $iow = $iow->start	1426	=item $iow = $iow->start
1268		1427
1269	Start watching for requested events on the given handle.	1428	Start watching for requested events on the given handle.
1270		1429
…		…
1281	This variable controls the verbosity level of the perl extension. Higher	1440	This variable controls the verbosity level of the perl extension. Higher
1282	numbers indicate more verbose output.	1441	numbers indicate more verbose output.
1283		1442
1284	=over 4	1443	=over 4
1285		1444
1286	=item =0 - only fatal messages	1445	=item == 0 - fatal messages
1287		1446
1288	=item =3 - script loading and management	1447	=item >= 3 - script loading and management
1289		1448
1290	=item =10 - all events received	1449	=item >=10 - all events received
1291		1450
1292	=back	1451	=back
1293		1452
1294	=head1 AUTHOR	1453	=head1 AUTHOR
1295		1454

Diff Legend

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

Comparing rxvt-unicode/src/urxvt.pm (file contents): Revision 1.55 by root, Sun Jan 8 05:50:27 2006 UTC vs. Revision 1.69 by root, Mon Jan 9 22:41:41 2006 UTC

Diff Legend

Comparing rxvt-unicode/src/urxvt.pm (file contents):
Revision 1.55 by root, Sun Jan 8 05:50:27 2006 UTC vs.
Revision 1.69 by root, Mon Jan 9 22:41:41 2006 UTC