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

Comparing rxvt-unicode/src/urxvt.pm (file contents):
Revision 1.54 by root, Sun Jan 8 01:59:29 2006 UTC vs.
Revision 1.70 by root, Mon Jan 9 23:00:07 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
342		386
343	=item urxvt::ShiftMask, LockMask, ControlMask, Mod1Mask, Mod2Mask,	387	=item urxvt::ShiftMask, LockMask, ControlMask, Mod1Mask, Mod2Mask,
344	Mod3Mask, Mod4Mask, Mod5Mask, Button1Mask, Button2Mask, Button3Mask,	388	Mod3Mask, Mod4Mask, Mod5Mask, Button1Mask, Button2Mask, Button3Mask,
345	Button4Mask, Button5Mask, AnyModifier	389	Button4Mask, Button5Mask, AnyModifier
346		390
347	Various constants for use in X events.	391	Various constants for use in X calls and event processing.
348		392
349	=back	393	=back
350		394
351	=head2 RENDITION	395	=head2 RENDITION
352		396
…		…
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
		457	our $VERSION = 1;
412	our $TERM;	458	our $TERM;
413	our @HOOKNAME;	459	our @HOOKNAME;
		460	our %HOOKTYPE = map +($HOOKNAME[$_] => $_), 0..$#HOOKNAME;
414	our %OPTION;	461	our %OPTION;
415	our $LIBDIR;	462	our $LIBDIR;
416		463
417	BEGIN {	464	BEGIN {
418	urxvt->bootstrap;	465	urxvt->bootstrap;
…		…
422	my $msg = join "", @_;	469	my $msg = join "", @_;
423	$msg .= "\n"	470	$msg .= "\n"
424	unless $msg =~ /\n$/;	471	unless $msg =~ /\n$/;
425	urxvt::warn ($msg);	472	urxvt::warn ($msg);
426	};	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";
427	}	479	}
428		480
429	my @hook_count;	481	my @hook_count;
430	my $verbosity = $ENV{URXVT_PERL_VERBOSITY};	482	my $verbosity = $ENV{URXVT_PERL_VERBOSITY};
431		483
432	sub verbose {	484	sub verbose {
433	my ($level, $msg) = @_;	485	my ($level, $msg) = @_;
434	warn "$msg\n" if $level <= $verbosity;	486	warn "$msg\n" if $level <= $verbosity;
435	}	487	}
436		488
437	# find on_xxx subs in the package and register them
438	# as hooks
439	sub register_package($) {
440	my ($pkg) = @_;
441
442	for my $htype (0.. $#HOOKNAME) {
443	my $name = $HOOKNAME[$htype];
444
445	my $ref = $pkg->can ("on_" . lc $name)
446	or next;
447
448	$TERM->{_hook}[$htype]{$pkg} = $ref;
449	$hook_count[$htype]++
450	or set_should_invoke $htype, 1;
451	}
452	}
453
454	my $extension_pkg = "extension0000";	489	my $extension_pkg = "extension0000";
455	my %extension_pkg;	490	my %extension_pkg;
456		491
457	# load a single script into its own package, once only	492	# load a single script into its own package, once only
458	sub extension_package($) {	493	sub extension_package($) {
…		…
464	verbose 3, "loading extension '$path' into package '$pkg'";	499	verbose 3, "loading extension '$path' into package '$pkg'";
465		500
466	open my $fh, "<:raw", $path	501	open my $fh, "<:raw", $path
467	or die "$path: $!";	502	or die "$path: $!";
468		503
		504	my $source = untaint
469	my $source = "package $pkg; use strict; use utf8;\n"	505	"package $pkg; use strict; use utf8;\n"
470	. "use base urxvt::term::proxy::;\n"	506	. "use base urxvt::term::proxy::;\n"
471	. "#line 1 \"$path\"\n{\n"	507	. "#line 1 \"$path\"\n{\n"
472	. (do { local $/; <$fh> })	508	. (do { local $/; <$fh> })
473	. "\n};\n1";	509	. "\n};\n1";
474		510
		511	eval $source
475	eval $source or die "$path: $@";	512	or die "$path: $@";
476		513
477	$pkg	514	$pkg
478	}	515	}
479	}	516	}
480		517
…		…
486	my $htype = shift;	523	my $htype = shift;
487		524
488	if ($htype == 0) { # INIT	525	if ($htype == 0) { # INIT
489	my @dirs = ((split /:/, $TERM->resource ("perl_lib")), "$LIBDIR/perl");	526	my @dirs = ((split /:/, $TERM->resource ("perl_lib")), "$LIBDIR/perl");
490		527
491	my %want_ext;	528	my %ext_arg;
492		529
493	for (map { split /,/, $TERM->resource ("perl_ext_$_") } 1, 2) {	530	for (map { split /,/, $TERM->resource ("perl_ext_$_") } 1, 2) {
494	if ($_ eq "default") {	531	if ($_ eq "default") {
495	$want_ext{$_}++ for qw(selection option-popup);	532	$ext_arg{$_} \|\|= [] for qw(selection option-popup selection-popup searchable-scrollback);
496	} elsif (/^-(.*)$/) {	533	} elsif (/^-(.*)$/) {
497	delete $want_ext{$1};	534	delete $ext_arg{$1};
		535	} elsif (/^([^<]+)<(.*)>$/) {
		536	push @{ $ext_arg{$1} }, $2;
498	} else {	537	} else {
499	$want_ext{$_}++;	538	$ext_arg{$_} \|\|= [];
500	}	539	}
501	}	540	}
502		541
503	for my $ext (keys %want_ext) {	542	while (my ($ext, $argv) = each %ext_arg) {
504	my @files = grep -f $_, map "$_/$ext", @dirs;	543	my @files = grep -f $_, map "$_/$ext", @dirs;
505		544
506	if (@files) {	545	if (@files) {
507	register_package extension_package $files[0];	546	$TERM->register_package (extension_package $files[0], $argv);
508	} else {	547	} else {
509	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";
510	}	549	}
511	}	550	}
		551
		552	eval "#line 1 \"--perl-eval resource/argument\"\n" . $TERM->resource ("perl_eval");
		553	warn $@ if $@;
512	}	554	}
513		555
514	$retval = undef;	556	$retval = undef;
515		557
516	if (my $cb = $TERM->{_hook}[$htype]) {	558	if (my $cb = $TERM->{_hook}[$htype]) {
…		…
518	if $verbosity >= 10;	560	if $verbosity >= 10;
519		561
520	keys %$cb;	562	keys %$cb;
521		563
522	while (my ($pkg, $cb) = each %$cb) {	564	while (my ($pkg, $cb) = each %$cb) {
523	eval {	565	$retval = eval { $cb->($TERM->{_pkg}{$pkg}, @_) }
524	$retval = $cb->(
525	$TERM->{_pkg}{$pkg} \|\|= do {
526	my $proxy = bless { }, $pkg;
527	Scalar::Util::weaken ($proxy->{term} = $TERM);
528	$proxy
529	},
530	@_,
531	) and last;	566	and last;
		567
		568	if ($@) {
		569	$TERM->ungrab; # better to lose the grab than the session
		570	warn $@;
532	};	571	}
533	warn $@ if $@;#d#
534	}	572	}
535	}	573	}
536		574
537	if ($htype == 1) { # DESTROY	575	if ($htype == 1) { # DESTROY
538	# remove hooks if unused
539	if (my $hook = $TERM->{_hook}) {	576	if (my $hook = delete $TERM->{_hook}) {
540	for my $htype (0..$#$hook) {	577	for my $htype (0..$#$hook) {
541	$hook_count[$htype] -= scalar keys %{ $hook->[$htype] \|\| {} }	578	$hook_count[$htype] -= scalar keys %{ $hook->[$htype] \|\| {} }
542	or set_should_invoke $htype, 0;	579	or set_should_invoke $htype, 0;
543	}	580	}
544	}	581	}
…		…
551	}	588	}
552		589
553	$retval	590	$retval
554	}	591	}
555		592
556	sub urxvt::term::proxy::AUTOLOAD {	593	# urxvt::term::proxy
557	$urxvt::term::proxy::AUTOLOAD =~ /:([^:]+)$/	594
		595	package urxvt::term::proxy;
		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 =~ /:([^:]+)$/
558	or die "FATAL: \$AUTOLOAD '$urxvt::term::proxy::AUTOLOAD' unparsable";	635	or die "FATAL: \$AUTOLOAD '$AUTOLOAD' unparsable";
559		636
560	eval qq{	637	eval qq{
561	sub $urxvt::term::proxy::AUTOLOAD {	638	sub $AUTOLOAD {
562	my \$proxy = shift;	639	my \$proxy = shift;
563	\$proxy->{term}->$1 (\@_)	640	\$proxy->{term}->$1 (\@_)
564	}	641	}
565	1	642	1
566	} or die "FATAL: unable to compile method forwarder: $@";	643	} or die "FATAL: unable to compile method forwarder: $@";
567		644
568	goto &$urxvt::term::proxy::AUTOLOAD;	645	goto &$AUTOLOAD;
569	}	646	}
		647
		648	sub DESTROY {
		649	# nop
		650	}
		651
		652	# urxvt::destroy_hook
570		653
571	sub urxvt::destroy_hook::DESTROY {	654	sub urxvt::destroy_hook::DESTROY {
572	${$_[0]}->();	655	${$_[0]}->();
573	}	656	}
574		657
575	sub urxvt::destroy_hook(&) {	658	sub urxvt::destroy_hook(&) {
576	bless \shift, urxvt::destroy_hook::	659	bless \shift, urxvt::destroy_hook::
577	}	660	}
578		661
		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
		673
		674	our $VERSION = 1;
		675
		676	$INC{"urxvt/anyevent.pm"} = 1; # mark us as there
		677	push @AnyEvent::REGISTRY, [urxvt => urxvt::anyevent::];
		678
		679	sub timer {
		680	my ($class, %arg) = @_;
		681
		682	my $cb = $arg{cb};
		683
		684	urxvt::timer
		685	->new
		686	->start (urxvt::NOW + $arg{after})
		687	->cb (sub {
		688	$_[0]->stop; # need to cancel manually
		689	$cb->();
		690	})
		691	}
		692
		693	sub io {
		694	my ($class, %arg) = @_;
		695
		696	my $cb = $arg{cb};
		697
		698	bless [$arg{fh}, urxvt::iow
		699	->new
		700	->fd (fileno $arg{fh})
		701	->events (($arg{poll} =~ /r/ ? 1 : 0)
		702	\| ($arg{poll} =~ /w/ ? 2 : 0))
		703	->start
		704	->cb (sub {
		705	$cb->(($_[1] & 1 ? 'r' : '')
		706	. ($_[1] & 2 ? 'w' : ''));
		707	})],
		708	urxvt::anyevent::
		709	}
		710
		711	sub DESTROY {
		712	$_[0][1]->stop;
		713	}
		714
		715	sub condvar {
		716	bless \my $flag, urxvt::anyevent::condvar::
		717	}
		718
		719	sub urxvt::anyevent::condvar::broadcast {
		720	${$_[0]}++;
		721	}
		722
		723	sub urxvt::anyevent::condvar::wait {
		724	unless (${$_[0]}) {
		725	Carp::croak "AnyEvent->condvar blocking wait unsupported in urxvt, use a non-blocking API";
		726	}
		727	}
		728
		729	package urxvt::term;
		730
579	=head2 The C<urxvt::term> Class	731	=head2 The C<urxvt::term> Class
580		732
581	=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	}
582		756
583	=item $term->destroy	757	=item $term->destroy
584		758
585	Destroy the terminal object (close the window, free resources etc.).	759	Destroy the terminal object (close the window, free resources etc.).
586		760
…		…
634	shade term_name title transparent transparent_all tripleclickwords	808	shade term_name title transparent transparent_all tripleclickwords
635	utmpInhibit visualBell	809	utmpInhibit visualBell
636		810
637	=cut	811	=cut
638		812
639	sub urxvt::term::resource($$;$) {	813	sub resource($$;$) {
640	my ($self, $name) = (shift, shift);	814	my ($self, $name) = (shift, shift);
641	unshift @_, $self, $name, ($name =~ s/\s\+\s(\d+)$// ? $1 : 0);	815	unshift @_, $self, $name, ($name =~ s/\s\+\s(\d+)$// ? $1 : 0);
642	&urxvt::term::_resource	816	&urxvt::term::_resource
643	}	817	}
644		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
645	=item $rend = $term->rstyle ([$new_rstyle])	824	=item $rend = $term->rstyle ([$new_rstyle])
646		825
647	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
648	the terminal application will use this style.	827	the terminal application will use this style.
649		828
…		…
668		847
669	=item $oldtext = $term->selection ([$newtext])	848	=item $oldtext = $term->selection ([$newtext])
670		849
671	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>.
672		851
673	#=item $term->overlay ($x, $y, $text)	852	=item $term->overlay_simple ($x, $y, $text)
674	#	853
675	#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.
676	#	855
677	#=cut	856	=cut
678	#	857
679	#sub urxvt::term::scr_overlay {	858	sub overlay_simple {
680	# my ($self, $x, $y, $text) = @_;	859	my ($self, $x, $y, $text) = @_;
681	#	860
682	# my @lines = split /\n/, $text;	861	my @lines = split /\n/, $text;
683	#	862
684	# my $w = 0;	863	my $w = List::Util::max map $self->strwidth ($_), @lines;
685	# for (map $self->strwidth ($_), @lines) {	864
686	# $w = $_ if $w < $_;
687	# }
688	#
689	# $self->scr_overlay_new ($x, $y, $w, scalar @lines);	865	my $overlay = $self->overlay ($x, $y, $w, scalar @lines);
690	# $self->scr_overlay_set (0, $_, $lines[$_]) for 0.. $#lines;	866	$overlay->set (0, $_, $lines[$_]) for 0.. $#lines;
691	#}	867
		868	$overlay
		869	}
692		870
693	=item $term->overlay ($x, $y, $width, $height[, $rstyle[, $border]])	871	=item $term->overlay ($x, $y, $width, $height[, $rstyle[, $border]])
694		872
695	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
696	width/height. C<$rstyle> defines the initial rendition style	874	width/height. C<$rstyle> defines the initial rendition style
…		…
731	C<$event> I<must> be the event causing the menu to pop up (a button event,	909	C<$event> I<must> be the event causing the menu to pop up (a button event,
732	currently).	910	currently).
733		911
734	=cut	912	=cut
735		913
736	sub urxvt::term::popup {	914	sub popup {
737	my ($self, $event) = @_;	915	my ($self, $event) = @_;
738		916
739	$self->grab ($event->{time}, 1)	917	$self->grab ($event->{time}, 1)
740	or return;	918	or return;
741		919
…		…
763		941
764	=item $string = $term->locale_decode ($octets)	942	=item $string = $term->locale_decode ($octets)
765		943
766	Convert the given locale-encoded octets into a perl string.	944	Convert the given locale-encoded octets into a perl string.
767		945
		946	=item $term->scr_xor_span ($beg_row, $beg_col, $end_row, $end_col[, $rstyle])
		947
		948	XORs the rendition values in the given span with the provided value
		949	(default: C<RS_RVid>). Useful in refresh hooks to provide effects similar
		950	to the selection.
		951
		952	=item $term->scr_xor_rect ($beg_row, $beg_col, $end_row, $end_col[, $rstyle1[, $rstyle2]])
		953
		954	Similar to C<scr_xor_span>, but xors a rectangle instead. Trailing
		955	whitespace will additionally be xored with the C<$rstyle2>, which defaults
		956	to C<RS_RVid \| RS_Uline>, which removes reverse video again and underlines
		957	it instead.
		958
		959	=item $term->scr_bell
		960
		961	Ring the bell!
		962
768	=item $term->scr_add_lines ($string)	963	=item $term->scr_add_lines ($string)
769		964
770	Write the given text string to the screen, as if output by the application	965	Write the given text string to the screen, as if output by the application
771	running inside the terminal. It may not contain command sequences (escape	966	running inside the terminal. It may not contain command sequences (escape
772	codes), but is free to use line feeds, carriage returns and tabs. The	967	codes), but is free to use line feeds, carriage returns and tabs. The
…		…
786		981
787	Write the octets given in C<$data> to the tty (i.e. as program input). To	982	Write the octets given in C<$data> to the tty (i.e. as program input). To
788	pass characters instead of octets, you should convert your strings first	983	pass characters instead of octets, you should convert your strings first
789	to the locale-specific encoding using C<< $term->locale_encode >>.	984	to the locale-specific encoding using C<< $term->locale_encode >>.
790		985
		986	=item $old_events = $term->pty_ev_events ([$new_events])
		987
		988	Replaces the event mask of the pty watcher by the given event mask. Can
		989	be used to suppress input and output handling to the pty/tty. See the
		990	description of C<< urxvt::timer->events >>. Make sure to always restore
		991	the previous value.
		992
791	=item $windowid = $term->parent	993	=item $windowid = $term->parent
792		994
793	Return the window id of the toplevel window.	995	Return the window id of the toplevel window.
794		996
795	=item $windowid = $term->vt	997	=item $windowid = $term->vt
…		…
819	=item $nrow_plus_saveLines = $term->total_rows	1021	=item $nrow_plus_saveLines = $term->total_rows
820		1022
821	=item $lines_in_scrollback = $term->nsaved	1023	=item $lines_in_scrollback = $term->nsaved
822		1024
823	Return various integers describing terminal characteristics.	1025	Return various integers describing terminal characteristics.
		1026
		1027	=item $lc_ctype = $term->locale
		1028
		1029	Returns the LC_CTYPE category string used by this rxvt-unicode.
		1030
		1031	=item $x_display = $term->display_id
		1032
		1033	Return the DISPLAY used by rxvt-unicode.
824		1034
825	=item $modifiermask = $term->ModLevel3Mask	1035	=item $modifiermask = $term->ModLevel3Mask
826		1036
827	=item $modifiermask = $term->ModMetaMask	1037	=item $modifiermask = $term->ModMetaMask
828		1038
…		…
931		1141
932	=back	1142	=back
933		1143
934	=cut	1144	=cut
935		1145
936	sub urxvt::term::line {	1146	sub line {
937	my ($self, $row) = @_;	1147	my ($self, $row) = @_;
938		1148
939	my $maxrow = $self->nrow - 1;	1149	my $maxrow = $self->nrow - 1;
940		1150
941	my ($beg, $end) = ($row, $row);	1151	my ($beg, $end) = ($row, $row);
…		…
1005	$offset / $self->{ncol} + $self->{beg},	1215	$offset / $self->{ncol} + $self->{beg},
1006	$offset % $self->{ncol}	1216	$offset % $self->{ncol}
1007	)	1217	)
1008	}	1218	}
1009		1219
1010	=item ($row, $col) = $line->coord_of ($offset)
1011	=item $text = $term->special_encode $string	1220	=item $text = $term->special_encode $string
1012		1221
1013	Converts a perl string into the special encoding used by rxvt-unicode,	1222	Converts a perl string into the special encoding used by rxvt-unicode,
1014	where one character corresponds to one screen cell. See	1223	where one character corresponds to one screen cell. See
1015	C<< $term->ROW_t >> for details.	1224	C<< $term->ROW_t >> for details.
…		…
1017	=item $string = $term->special_decode $text	1226	=item $string = $term->special_decode $text
1018		1227
1019	Converts rxvt-unicodes text reprsentation into a perl string. See	1228	Converts rxvt-unicodes text reprsentation into a perl string. See
1020	C<< $term->ROW_t >> for details.	1229	C<< $term->ROW_t >> for details.
1021		1230
		1231	=item $success = $term->grab_button ($button, $modifiermask)
		1232
		1233	Registers a synchronous button grab. See the XGrabButton manpage.
		1234
		1235	=item $success = $term->grab ($eventtime[, $sync])
		1236
		1237	Calls XGrabPointer and XGrabKeyboard in asynchronous (default) or
		1238	synchronous (C<$sync> is true). Also remembers the grab timestampe.
		1239
		1240	=item $term->allow_events_async
		1241
		1242	Calls XAllowEvents with AsyncBoth for the most recent grab.
		1243
		1244	=item $term->allow_events_sync
		1245
		1246	Calls XAllowEvents with SyncBoth for the most recent grab.
		1247
		1248	=item $term->allow_events_replay
		1249
		1250	Calls XAllowEvents with both ReplayPointer and ReplayKeyboard for the most
		1251	recent grab.
		1252
		1253	=item $term->ungrab
		1254
		1255	Calls XUngrab for the most recent grab. Is called automatically on
		1256	evaluation errors, as it is better to lose the grab in the error case as
		1257	the session.
		1258
1022	=back	1259	=back
1023		1260
		1261	=cut
		1262
		1263	package urxvt::popup;
		1264
1024	=head2 The C<urxvt::popup> Class	1265	=head2 The C<urxvt::popup> Class
1025		1266
1026	=over 4	1267	=over 4
1027		1268
1028	=cut	1269	=cut
1029
1030	package urxvt::popup;
1031		1270
1032	sub add_item {	1271	sub add_item {
1033	my ($self, $item) = @_;	1272	my ($self, $item) = @_;
1034		1273
1035	$item->{rend}{normal} = "\x1b[0;30;47m" unless exists $item->{rend}{normal};	1274	$item->{rend}{normal} = "\x1b[0;30;47m" unless exists $item->{rend}{normal};
…		…
1042	}	1281	}
1043		1282
1044	sub add_separator {	1283	sub add_separator {
1045	my ($self, $sep) = @_;	1284	my ($self, $sep) = @_;
1046		1285
1047	$sep \|\|= "═";	1286	$sep \|\|= "=";
1048		1287
1049	$self->add_item ({	1288	$self->add_item ({
1050	rend => { normal => "\x1b[0;30;47m", hover => "\x1b[0;30;47m", active => "\x1b[0;30;47m" },	1289	rend => { normal => "\x1b[0;30;47m", hover => "\x1b[0;30;47m", active => "\x1b[0;30;47m" },
1051	text => "",	1290	text => "",
1052	render => sub { $sep x $urxvt::TERM->ncol },	1291	render => sub { $sep x $self->{term}->ncol },
1053	activate => sub { },	1292	activate => sub { },
1054	});	1293	});
1055	}	1294	}
1056		1295
1057	sub add_title {	1296	sub add_title {
…		…
1065	}	1304	}
1066		1305
1067	sub add_button {	1306	sub add_button {
1068	my ($self, $text, $cb) = @_;	1307	my ($self, $text, $cb) = @_;
1069		1308
1070	$self->add_item ({ type => "button", text => "[ $text ]", activate => $cb});	1309	$self->add_item ({ type => "button", text => $text, activate => $cb});
1071	}	1310	}
1072		1311
1073	sub add_toggle {	1312	sub add_toggle {
1074	my ($self, $text, $cb, $value) = @_;	1313	my ($self, $text, $cb, $value) = @_;
1075		1314
1076	my $item; $item = {	1315	my $item; $item = {
1077	type => "button",	1316	type => "button",
1078	text => " $text",	1317	text => " $text",
1079	value => $value,	1318	value => $value,
1080	render => sub { ($item->{value} ? "* " : " ") . $text },	1319	render => sub { ($_[0]{value} ? "* " : " ") . $text },
1081	activate => sub { $cb->($item->{value} = !$item->{value}); },	1320	activate => sub { $cb->($_[0]{value} = !$_[0]{value}); },
1082	};	1321	};
1083		1322
1084	$self->add_item ($item);	1323	$self->add_item ($item);
1085	}	1324	}
1086		1325
1087	sub show {	1326	sub show {
1088	my ($self) = @_;	1327	my ($self) = @_;
1089		1328
1090	local $urxvt::popup::self = $self;	1329	local $urxvt::popup::self = $self;
1091		1330
		1331	local $ENV{LC_ALL} = $self->{term}->locale;
		1332
1092	urxvt->new ("--perl-lib" => "", "--perl-ext-common" => "", "-pty-fd" => -1, "-sl" => 0, "-b" => 0,	1333	urxvt->new ("--perl-lib" => "", "--perl-ext-common" => "", "-pty-fd" => -1, "-sl" => 0, "-b" => 0,
1093	"--transient-for" => $self->{term}->parent,	1334	"--transient-for" => $self->{term}->parent,
		1335	"-display" => $self->{term}->display_id,
1094	"-pe" => "urxvt-popup")	1336	"-pe" => "urxvt-popup")
1095	or die "unable to create popup window\n";	1337	or die "unable to create popup window\n";
1096	}	1338	}
1097		1339
1098	sub DESTROY {	1340	sub DESTROY {
1099	my ($self) = @_;	1341	my ($self) = @_;
1100		1342
		1343	delete $self->{term}{_destroy}{$self};
1101	$self->{term}->ungrab;	1344	$self->{term}->ungrab;
1102	}	1345	}
1103		1346
1104	=head2 The C<urxvt::timer> Class	1347	=head2 The C<urxvt::timer> Class
1105		1348
…		…
1160		1403
1161	$term->{socket} = ...	1404	$term->{socket} = ...
1162	$term->{iow} = urxvt::iow	1405	$term->{iow} = urxvt::iow
1163	->new	1406	->new
1164	->fd (fileno $term->{socket})	1407	->fd (fileno $term->{socket})
1165	->events (1) # wait for read data	1408	->events (urxvt::EVENT_READ)
1166	->start	1409	->start
1167	->cb (sub {	1410	->cb (sub {
1168	my ($iow, $revents) = @_;	1411	my ($iow, $revents) = @_;
1169	# $revents must be 1 here, no need to check	1412	# $revents must be 1 here, no need to check
1170	sysread $term->{socket}, my $buf, 8192	1413	sysread $term->{socket}, my $buf, 8192
…		…
1187		1430
1188	Set the filedescriptor (not handle) to watch.	1431	Set the filedescriptor (not handle) to watch.
1189		1432
1190	=item $iow = $iow->events ($eventmask)	1433	=item $iow = $iow->events ($eventmask)
1191		1434
1192	Set the event mask to watch. Bit #0 (value C<1>) enables watching for read	1435	Set the event mask to watch. The only allowed values are
1193	data, Bit #1 (value C<2>) enables watching for write data.	1436	C<urxvt::EVENT_READ> and C<urxvt::EVENT_WRITE>, which might be ORed
		1437	together, or C<urxvt::EVENT_NONE>.
1194		1438
1195	=item $iow = $iow->start	1439	=item $iow = $iow->start
1196		1440
1197	Start watching for requested events on the given handle.	1441	Start watching for requested events on the given handle.
1198		1442
…		…
1209	This variable controls the verbosity level of the perl extension. Higher	1453	This variable controls the verbosity level of the perl extension. Higher
1210	numbers indicate more verbose output.	1454	numbers indicate more verbose output.
1211		1455
1212	=over 4	1456	=over 4
1213		1457
1214	=item =0 - only fatal messages	1458	=item == 0 - fatal messages
1215		1459
1216	=item =3 - script loading and management	1460	=item >= 3 - script loading and management
1217		1461
1218	=item =10 - all events received	1462	=item >=10 - all events received
1219		1463
1220	=back	1464	=back
1221		1465
1222	=head1 AUTHOR	1466	=head1 AUTHOR
1223		1467

Diff Legend

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

Comparing rxvt-unicode/src/urxvt.pm (file contents): Revision 1.54 by root, Sun Jan 8 01:59:29 2006 UTC vs. Revision 1.70 by root, Mon Jan 9 23:00:07 2006 UTC

Diff Legend

Comparing rxvt-unicode/src/urxvt.pm (file contents):
Revision 1.54 by root, Sun Jan 8 01:59:29 2006 UTC vs.
Revision 1.70 by root, Mon Jan 9 23:00:07 2006 UTC