[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.73 by root, Tue Jan 10 04:23:39 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
…		…
225	can filter/change and output the text yourself by returning a true value	263	can filter/change and output the text yourself by returning a true value
226	and calling C<< $term->scr_add_lines >> yourself. Please note that this	264	and calling C<< $term->scr_add_lines >> yourself. Please note that this
227	might be very slow, however, as your hook is called for B<all> text being	265	might be very slow, however, as your hook is called for B<all> text being
228	output.	266	output.
229		267
		268	=item on_tt_write $term, $octets
		269
		270	Called whenever some data is written to the tty/pty and can be used to
		271	suppress or filter tty input.
		272
230	=item on_line_update $term, $row	273	=item on_line_update $term, $row
231		274
232	Called whenever a line was updated or changed. Can be used to filter	275	Called whenever a line was updated or changed. Can be used to filter
233	screen output (e.g. underline urls or other useless stuff). Only lines	276	screen output (e.g. underline urls or other useless stuff). Only lines
234	that are being shown will be filtered, and, due to performance reasons,	277	that are being shown will be filtered, and, due to performance reasons,
…		…
266	=item on_focus_out $term	309	=item on_focus_out $term
267		310
268	Called wheneever the window loses keyboard focus, before rxvt-unicode does	311	Called wheneever the window loses keyboard focus, before rxvt-unicode does
269	focus out processing.	312	focus out processing.
270		313
271	=item on_key_press $term, $event, $octets	314	=item on_key_press $term, $event, $keysym, $octets
272		315
273	=item on_key_release $term, $event	316	=item on_key_release $term, $event, $keysym
274		317
275	=item on_button_press $term, $event	318	=item on_button_press $term, $event
276		319
277	=item on_button_release $term, $event	320	=item on_button_release $term, $event
278		321
…		…
332	that calls this function.	375	that calls this function.
333		376
334	Using this function has the advantage that its output ends up in the	377	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.	378	correct place, e.g. on stderr of the connecting urxvtc client.
336		379
		380	=item $is_safe = urxvt::safe
		381
		382	Returns true when it is safe to do potentially unsafe things, such as
		383	evaluating perl code specified by the user. This is true when urxvt was
		384	started setuid or setgid.
		385
337	=item $time = urxvt::NOW	386	=item $time = urxvt::NOW
338		387
339	Returns the "current time" (as per the event loop).	388	Returns the "current time" (as per the event loop).
340		389
341	=item urxvt::CurrentTime	390	=item urxvt::CurrentTime
342		391
343	=item urxvt::ShiftMask, LockMask, ControlMask, Mod1Mask, Mod2Mask,	392	=item urxvt::ShiftMask, LockMask, ControlMask, Mod1Mask, Mod2Mask,
344	Mod3Mask, Mod4Mask, Mod5Mask, Button1Mask, Button2Mask, Button3Mask,	393	Mod3Mask, Mod4Mask, Mod5Mask, Button1Mask, Button2Mask, Button3Mask,
345	Button4Mask, Button5Mask, AnyModifier	394	Button4Mask, Button5Mask, AnyModifier
346		395
347	Various constants for use in X events.	396	Various constants for use in X calls and event processing.
348		397
349	=back	398	=back
350		399
351	=head2 RENDITION	400	=head2 RENDITION
352		401
…		…
404		453
405	package urxvt;	454	package urxvt;
406		455
407	use utf8;	456	use utf8;
408	use strict;	457	use strict;
		458	use Carp ();
409	use Scalar::Util ();	459	use Scalar::Util ();
410	use List::Util ();	460	use List::Util ();
411		461
		462	our $VERSION = 1;
412	our $TERM;	463	our $TERM;
413	our @HOOKNAME;	464	our @HOOKNAME;
		465	our %HOOKTYPE = map +($HOOKNAME[$_] => $_), 0..$#HOOKNAME;
414	our %OPTION;	466	our %OPTION;
		467
415	our $LIBDIR;	468	our $LIBDIR;
		469	our $RESNAME;
		470	our $RESCLASS;
		471	our $RXVTNAME;
416		472
417	BEGIN {	473	BEGIN {
418	urxvt->bootstrap;	474	urxvt->bootstrap;
419		475
420	# overwrite perl's warn	476	# overwrite perl's warn
…		…
422	my $msg = join "", @_;	478	my $msg = join "", @_;
423	$msg .= "\n"	479	$msg .= "\n"
424	unless $msg =~ /\n$/;	480	unless $msg =~ /\n$/;
425	urxvt::warn ($msg);	481	urxvt::warn ($msg);
426	};	482	};
		483
		484	delete $ENV{IFS};
		485	delete $ENV{CDPATH};
		486	delete $ENV{BASH_ENV};
		487	$ENV{PATH} = "/bin:/sbin:/usr/bin:/usr/sbin:/usr/local/bin:/usr/local/sbin:/opt/bin:/opt/sbin";
427	}	488	}
428		489
429	my @hook_count;	490	my @hook_count;
430	my $verbosity = $ENV{URXVT_PERL_VERBOSITY};	491	my $verbosity = $ENV{URXVT_PERL_VERBOSITY};
431		492
432	sub verbose {	493	sub verbose {
433	my ($level, $msg) = @_;	494	my ($level, $msg) = @_;
434	warn "$msg\n" if $level <= $verbosity;	495	warn "$msg\n" if $level <= $verbosity;
435	}	496	}
436		497
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";	498	my $extension_pkg = "extension0000";
455	my %extension_pkg;	499	my %extension_pkg;
456		500
457	# load a single script into its own package, once only	501	# load a single script into its own package, once only
458	sub extension_package($) {	502	sub extension_package($) {
…		…
464	verbose 3, "loading extension '$path' into package '$pkg'";	508	verbose 3, "loading extension '$path' into package '$pkg'";
465		509
466	open my $fh, "<:raw", $path	510	open my $fh, "<:raw", $path
467	or die "$path: $!";	511	or die "$path: $!";
468		512
		513	my $source = untaint
469	my $source = "package $pkg; use strict; use utf8;\n"	514	"package $pkg; use strict; use utf8;\n"
470	. "use base urxvt::term::proxy::;\n"	515	. "use base urxvt::term::extension::;\n"
471	. "#line 1 \"$path\"\n{\n"	516	. "#line 1 \"$path\"\n{\n"
472	. (do { local $/; <$fh> })	517	. (do { local $/; <$fh> })
473	. "\n};\n1";	518	. "\n};\n1";
474		519
		520	eval $source
475	eval $source or die "$path: $@";	521	or die "$path: $@";
476		522
477	$pkg	523	$pkg
478	}	524	}
479	}	525	}
480		526
…		…
486	my $htype = shift;	532	my $htype = shift;
487		533
488	if ($htype == 0) { # INIT	534	if ($htype == 0) { # INIT
489	my @dirs = ((split /:/, $TERM->resource ("perl_lib")), "$LIBDIR/perl");	535	my @dirs = ((split /:/, $TERM->resource ("perl_lib")), "$LIBDIR/perl");
490		536
491	my %want_ext;	537	my %ext_arg;
492		538
493	for (map { split /,/, $TERM->resource ("perl_ext_$_") } 1, 2) {	539	for (map { split /,/, $TERM->resource ("perl_ext_$_") } 1, 2) {
494	if ($_ eq "default") {	540	if ($_ eq "default") {
495	$want_ext{$_}++ for qw(selection option-popup);	541	$ext_arg{$_} \|\|= [] for qw(selection option-popup selection-popup searchable-scrollback);
496	} elsif (/^-(.*)$/) {	542	} elsif (/^-(.*)$/) {
497	delete $want_ext{$1};	543	delete $ext_arg{$1};
		544	} elsif (/^([^<]+)<(.*)>$/) {
		545	push @{ $ext_arg{$1} }, $2;
498	} else {	546	} else {
499	$want_ext{$_}++;	547	$ext_arg{$_} \|\|= [];
500	}	548	}
501	}	549	}
502		550
503	for my $ext (keys %want_ext) {	551	while (my ($ext, $argv) = each %ext_arg) {
504	my @files = grep -f $_, map "$_/$ext", @dirs;	552	my @files = grep -f $_, map "$_/$ext", @dirs;
505		553
506	if (@files) {	554	if (@files) {
507	register_package extension_package $files[0];	555	$TERM->register_package (extension_package $files[0], $argv);
508	} else {	556	} else {
509	warn "perl extension '$ext' not found in perl library search path\n";	557	warn "perl extension '$ext' not found in perl library search path\n";
510	}	558	}
511	}	559	}
		560
		561	eval "#line 1 \"--perl-eval resource/argument\"\n" . $TERM->resource ("perl_eval");
		562	warn $@ if $@;
512	}	563	}
513		564
514	$retval = undef;	565	$retval = undef;
515		566
516	if (my $cb = $TERM->{_hook}[$htype]) {	567	if (my $cb = $TERM->{_hook}[$htype]) {
…		…
518	if $verbosity >= 10;	569	if $verbosity >= 10;
519		570
520	keys %$cb;	571	keys %$cb;
521		572
522	while (my ($pkg, $cb) = each %$cb) {	573	while (my ($pkg, $cb) = each %$cb) {
523	eval {	574	$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;	575	and last;
		576
		577	if ($@) {
		578	$TERM->ungrab; # better to lose the grab than the session
		579	warn $@;
532	};	580	}
533	warn $@ if $@;#d#
534	}	581	}
535	}	582	}
536		583
537	if ($htype == 1) { # DESTROY	584	if ($htype == 1) { # DESTROY
538	# remove hooks if unused
539	if (my $hook = $TERM->{_hook}) {	585	if (my $hook = delete $TERM->{_hook}) {
540	for my $htype (0..$#$hook) {	586	for my $htype (0..$#$hook) {
541	$hook_count[$htype] -= scalar keys %{ $hook->[$htype] \|\| {} }	587	$hook_count[$htype] -= scalar keys %{ $hook->[$htype] \|\| {} }
542	or set_should_invoke $htype, 0;	588	or set_should_invoke $htype, 0;
543	}	589	}
544	}	590	}
…		…
551	}	597	}
552		598
553	$retval	599	$retval
554	}	600	}
555		601
556	sub urxvt::term::proxy::AUTOLOAD {	602	# urxvt::term::extension
557	$urxvt::term::proxy::AUTOLOAD =~ /:([^:]+)$/	603
		604	package urxvt::term::extension;
		605
		606	sub enable {
		607	my ($self, %hook) = @_;
		608	my $pkg = $self->{_pkg};
		609
		610	while (my ($name, $cb) = each %hook) {
		611	my $htype = $HOOKTYPE{uc $name};
		612	defined $htype
		613	or Carp::croak "unsupported hook type '$name'";
		614
		615	unless (exists $self->{term}{_hook}[$htype]{$pkg}) {
		616	$hook_count[$htype]++
		617	or urxvt::set_should_invoke $htype, 1;
		618	}
		619
		620	$self->{term}{_hook}[$htype]{$pkg} = $cb;
		621	}
		622	}
		623
		624	sub disable {
		625	my ($self, @hook) = @_;
		626	my $pkg = $self->{_pkg};
		627
		628	for my $name (@hook) {
		629	my $htype = $HOOKTYPE{uc $name};
		630	defined $htype
		631	or Carp::croak "unsupported hook type '$name'";
		632
		633	if (delete $self->{term}{_hook}[$htype]{$pkg}) {
		634	--$hook_count[$htype]
		635	or urxvt::set_should_invoke $htype, 0;
		636	}
		637	}
		638	}
		639
		640	our $AUTOLOAD;
		641
		642	sub AUTOLOAD {
		643	$AUTOLOAD =~ /:([^:]+)$/
558	or die "FATAL: \$AUTOLOAD '$urxvt::term::proxy::AUTOLOAD' unparsable";	644	or die "FATAL: \$AUTOLOAD '$AUTOLOAD' unparsable";
559		645
560	eval qq{	646	eval qq{
561	sub $urxvt::term::proxy::AUTOLOAD {	647	sub $AUTOLOAD {
562	my \$proxy = shift;	648	my \$proxy = shift;
563	\$proxy->{term}->$1 (\@_)	649	\$proxy->{term}->$1 (\@_)
564	}	650	}
565	1	651	1
566	} or die "FATAL: unable to compile method forwarder: $@";	652	} or die "FATAL: unable to compile method forwarder: $@";
567		653
568	goto &$urxvt::term::proxy::AUTOLOAD;	654	goto &$AUTOLOAD;
569	}	655	}
		656
		657	sub DESTROY {
		658	# nop
		659	}
		660
		661	# urxvt::destroy_hook
570		662
571	sub urxvt::destroy_hook::DESTROY {	663	sub urxvt::destroy_hook::DESTROY {
572	${$_[0]}->();	664	${$_[0]}->();
573	}	665	}
574		666
575	sub urxvt::destroy_hook(&) {	667	sub urxvt::destroy_hook(&) {
576	bless \shift, urxvt::destroy_hook::	668	bless \shift, urxvt::destroy_hook::
577	}	669	}
578		670
		671	package urxvt::anyevent;
		672
		673	=head2 The C<urxvt::anyevent> Class
		674
		675	The sole purpose of this class is to deliver an interface to the
		676	C<AnyEvent> module - any module using it will work inside urxvt without
		677	further work. The only exception is that you cannot wait on condition
		678	variables, but non-blocking condvar use is ok. What this means is that you
		679	cannot use blocking APIs, but the non-blocking variant should work.
		680
		681	=cut
		682
		683	our $VERSION = 1;
		684
		685	$INC{"urxvt/anyevent.pm"} = 1; # mark us as there
		686	push @AnyEvent::REGISTRY, [urxvt => urxvt::anyevent::];
		687
		688	sub timer {
		689	my ($class, %arg) = @_;
		690
		691	my $cb = $arg{cb};
		692
		693	urxvt::timer
		694	->new
		695	->start (urxvt::NOW + $arg{after})
		696	->cb (sub {
		697	$_[0]->stop; # need to cancel manually
		698	$cb->();
		699	})
		700	}
		701
		702	sub io {
		703	my ($class, %arg) = @_;
		704
		705	my $cb = $arg{cb};
		706
		707	bless [$arg{fh}, urxvt::iow
		708	->new
		709	->fd (fileno $arg{fh})
		710	->events (($arg{poll} =~ /r/ ? 1 : 0)
		711	\| ($arg{poll} =~ /w/ ? 2 : 0))
		712	->start
		713	->cb (sub {
		714	$cb->(($_[1] & 1 ? 'r' : '')
		715	. ($_[1] & 2 ? 'w' : ''));
		716	})],
		717	urxvt::anyevent::
		718	}
		719
		720	sub DESTROY {
		721	$_[0][1]->stop;
		722	}
		723
		724	sub condvar {
		725	bless \my $flag, urxvt::anyevent::condvar::
		726	}
		727
		728	sub urxvt::anyevent::condvar::broadcast {
		729	${$_[0]}++;
		730	}
		731
		732	sub urxvt::anyevent::condvar::wait {
		733	unless (${$_[0]}) {
		734	Carp::croak "AnyEvent->condvar blocking wait unsupported in urxvt, use a non-blocking API";
		735	}
		736	}
		737
		738	package urxvt::term;
		739
579	=head2 The C<urxvt::term> Class	740	=head2 The C<urxvt::term> Class
580		741
581	=over 4	742	=over 4
		743
		744	=cut
		745
		746	# find on_xxx subs in the package and register them
		747	# as hooks
		748	sub register_package {
		749	my ($self, $pkg, $argv) = @_;
		750
		751	my $proxy = bless {
		752	_pkg => $pkg,
		753	argv => $argv,
		754	}, $pkg;
		755	Scalar::Util::weaken ($proxy->{term} = $self);
		756
		757	$self->{_pkg}{$pkg} = $proxy;
		758
		759	for my $name (@HOOKNAME) {
		760	if (my $ref = $pkg->can ("on_" . lc $name)) {
		761	$proxy->enable ($name => $ref);
		762	}
		763	}
		764	}
582		765
583	=item $term->destroy	766	=item $term->destroy
584		767
585	Destroy the terminal object (close the window, free resources etc.).	768	Destroy the terminal object (close the window, free resources etc.).
586		769
…		…
634	shade term_name title transparent transparent_all tripleclickwords	817	shade term_name title transparent transparent_all tripleclickwords
635	utmpInhibit visualBell	818	utmpInhibit visualBell
636		819
637	=cut	820	=cut
638		821
639	sub urxvt::term::resource($$;$) {	822	sub resource($$;$) {
640	my ($self, $name) = (shift, shift);	823	my ($self, $name) = (shift, shift);
641	unshift @_, $self, $name, ($name =~ s/\s\+\s(\d+)$// ? $1 : 0);	824	unshift @_, $self, $name, ($name =~ s/\s\+\s(\d+)$// ? $1 : 0);
642	&urxvt::term::_resource	825	&urxvt::term::_resource
643	}	826	}
644		827
		828	=item $success = $term->parse_keysym ($keysym_spec, $command_string)
		829
		830	Adds a keymap translation exactly as specified via a resource. See the
		831	C<keysym> resource in the @@RXVT_NAME@@(1) manpage.
		832
645	=item $rend = $term->rstyle ([$new_rstyle])	833	=item $rend = $term->rstyle ([$new_rstyle])
646		834
647	Return and optionally change the current rendition. Text that is output by	835	Return and optionally change the current rendition. Text that is output by
648	the terminal application will use this style.	836	the terminal application will use this style.
649		837
…		…
668		856
669	=item $oldtext = $term->selection ([$newtext])	857	=item $oldtext = $term->selection ([$newtext])
670		858
671	Return the current selection text and optionally replace it by C<$newtext>.	859	Return the current selection text and optionally replace it by C<$newtext>.
672		860
673	#=item $term->overlay ($x, $y, $text)	861	=item $term->overlay_simple ($x, $y, $text)
674	#	862
675	#Create a simple multi-line overlay box. See the next method for details.	863	Create a simple multi-line overlay box. See the next method for details.
676	#	864
677	#=cut	865	=cut
678	#	866
679	#sub urxvt::term::scr_overlay {	867	sub overlay_simple {
680	# my ($self, $x, $y, $text) = @_;	868	my ($self, $x, $y, $text) = @_;
681	#	869
682	# my @lines = split /\n/, $text;	870	my @lines = split /\n/, $text;
683	#	871
684	# my $w = 0;	872	my $w = List::Util::max map $self->strwidth ($_), @lines;
685	# for (map $self->strwidth ($_), @lines) {	873
686	# $w = $_ if $w < $_;
687	# }
688	#
689	# $self->scr_overlay_new ($x, $y, $w, scalar @lines);	874	my $overlay = $self->overlay ($x, $y, $w, scalar @lines);
690	# $self->scr_overlay_set (0, $_, $lines[$_]) for 0.. $#lines;	875	$overlay->set (0, $_, $lines[$_]) for 0.. $#lines;
691	#}	876
		877	$overlay
		878	}
692		879
693	=item $term->overlay ($x, $y, $width, $height[, $rstyle[, $border]])	880	=item $term->overlay ($x, $y, $width, $height[, $rstyle[, $border]])
694		881
695	Create a new (empty) overlay at the given position with the given	882	Create a new (empty) overlay at the given position with the given
696	width/height. C<$rstyle> defines the initial rendition style	883	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,	918	C<$event> I<must> be the event causing the menu to pop up (a button event,
732	currently).	919	currently).
733		920
734	=cut	921	=cut
735		922
736	sub urxvt::term::popup {	923	sub popup {
737	my ($self, $event) = @_;	924	my ($self, $event) = @_;
738		925
739	$self->grab ($event->{time}, 1)	926	$self->grab ($event->{time}, 1)
740	or return;	927	or return;
741		928
…		…
763		950
764	=item $string = $term->locale_decode ($octets)	951	=item $string = $term->locale_decode ($octets)
765		952
766	Convert the given locale-encoded octets into a perl string.	953	Convert the given locale-encoded octets into a perl string.
767		954
		955	=item $term->scr_xor_span ($beg_row, $beg_col, $end_row, $end_col[, $rstyle])
		956
		957	XORs the rendition values in the given span with the provided value
		958	(default: C<RS_RVid>). Useful in refresh hooks to provide effects similar
		959	to the selection.
		960
		961	=item $term->scr_xor_rect ($beg_row, $beg_col, $end_row, $end_col[, $rstyle1[, $rstyle2]])
		962
		963	Similar to C<scr_xor_span>, but xors a rectangle instead. Trailing
		964	whitespace will additionally be xored with the C<$rstyle2>, which defaults
		965	to C<RS_RVid \| RS_Uline>, which removes reverse video again and underlines
		966	it instead.
		967
		968	=item $term->scr_bell
		969
		970	Ring the bell!
		971
768	=item $term->scr_add_lines ($string)	972	=item $term->scr_add_lines ($string)
769		973
770	Write the given text string to the screen, as if output by the application	974	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	975	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	976	codes), but is free to use line feeds, carriage returns and tabs. The
…		…
786		990
787	Write the octets given in C<$data> to the tty (i.e. as program input). To	991	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	992	pass characters instead of octets, you should convert your strings first
789	to the locale-specific encoding using C<< $term->locale_encode >>.	993	to the locale-specific encoding using C<< $term->locale_encode >>.
790		994
		995	=item $old_events = $term->pty_ev_events ([$new_events])
		996
		997	Replaces the event mask of the pty watcher by the given event mask. Can
		998	be used to suppress input and output handling to the pty/tty. See the
		999	description of C<< urxvt::timer->events >>. Make sure to always restore
		1000	the previous value.
		1001
791	=item $windowid = $term->parent	1002	=item $windowid = $term->parent
792		1003
793	Return the window id of the toplevel window.	1004	Return the window id of the toplevel window.
794		1005
795	=item $windowid = $term->vt	1006	=item $windowid = $term->vt
…		…
819	=item $nrow_plus_saveLines = $term->total_rows	1030	=item $nrow_plus_saveLines = $term->total_rows
820		1031
821	=item $lines_in_scrollback = $term->nsaved	1032	=item $lines_in_scrollback = $term->nsaved
822		1033
823	Return various integers describing terminal characteristics.	1034	Return various integers describing terminal characteristics.
		1035
		1036	=item $lc_ctype = $term->locale
		1037
		1038	Returns the LC_CTYPE category string used by this rxvt-unicode.
		1039
		1040	=item $x_display = $term->display_id
		1041
		1042	Return the DISPLAY used by rxvt-unicode.
824		1043
825	=item $modifiermask = $term->ModLevel3Mask	1044	=item $modifiermask = $term->ModLevel3Mask
826		1045
827	=item $modifiermask = $term->ModMetaMask	1046	=item $modifiermask = $term->ModMetaMask
828		1047
…		…
931		1150
932	=back	1151	=back
933		1152
934	=cut	1153	=cut
935		1154
936	sub urxvt::term::line {	1155	sub line {
937	my ($self, $row) = @_;	1156	my ($self, $row) = @_;
938		1157
939	my $maxrow = $self->nrow - 1;	1158	my $maxrow = $self->nrow - 1;
940		1159
941	my ($beg, $end) = ($row, $row);	1160	my ($beg, $end) = ($row, $row);
…		…
1005	$offset / $self->{ncol} + $self->{beg},	1224	$offset / $self->{ncol} + $self->{beg},
1006	$offset % $self->{ncol}	1225	$offset % $self->{ncol}
1007	)	1226	)
1008	}	1227	}
1009		1228
1010	=item ($row, $col) = $line->coord_of ($offset)
1011	=item $text = $term->special_encode $string	1229	=item $text = $term->special_encode $string
1012		1230
1013	Converts a perl string into the special encoding used by rxvt-unicode,	1231	Converts a perl string into the special encoding used by rxvt-unicode,
1014	where one character corresponds to one screen cell. See	1232	where one character corresponds to one screen cell. See
1015	C<< $term->ROW_t >> for details.	1233	C<< $term->ROW_t >> for details.
…		…
1017	=item $string = $term->special_decode $text	1235	=item $string = $term->special_decode $text
1018		1236
1019	Converts rxvt-unicodes text reprsentation into a perl string. See	1237	Converts rxvt-unicodes text reprsentation into a perl string. See
1020	C<< $term->ROW_t >> for details.	1238	C<< $term->ROW_t >> for details.
1021		1239
		1240	=item $success = $term->grab_button ($button, $modifiermask)
		1241
		1242	Registers a synchronous button grab. See the XGrabButton manpage.
		1243
		1244	=item $success = $term->grab ($eventtime[, $sync])
		1245
		1246	Calls XGrabPointer and XGrabKeyboard in asynchronous (default) or
		1247	synchronous (C<$sync> is true). Also remembers the grab timestampe.
		1248
		1249	=item $term->allow_events_async
		1250
		1251	Calls XAllowEvents with AsyncBoth for the most recent grab.
		1252
		1253	=item $term->allow_events_sync
		1254
		1255	Calls XAllowEvents with SyncBoth for the most recent grab.
		1256
		1257	=item $term->allow_events_replay
		1258
		1259	Calls XAllowEvents with both ReplayPointer and ReplayKeyboard for the most
		1260	recent grab.
		1261
		1262	=item $term->ungrab
		1263
		1264	Calls XUngrab for the most recent grab. Is called automatically on
		1265	evaluation errors, as it is better to lose the grab in the error case as
		1266	the session.
		1267
1022	=back	1268	=back
1023		1269
		1270	=cut
		1271
		1272	package urxvt::popup;
		1273
1024	=head2 The C<urxvt::popup> Class	1274	=head2 The C<urxvt::popup> Class
1025		1275
1026	=over 4	1276	=over 4
1027		1277
1028	=cut	1278	=cut
1029
1030	package urxvt::popup;
1031		1279
1032	sub add_item {	1280	sub add_item {
1033	my ($self, $item) = @_;	1281	my ($self, $item) = @_;
1034		1282
1035	$item->{rend}{normal} = "\x1b[0;30;47m" unless exists $item->{rend}{normal};	1283	$item->{rend}{normal} = "\x1b[0;30;47m" unless exists $item->{rend}{normal};
…		…
1042	}	1290	}
1043		1291
1044	sub add_separator {	1292	sub add_separator {
1045	my ($self, $sep) = @_;	1293	my ($self, $sep) = @_;
1046		1294
1047	$sep \|\|= "═";	1295	$sep \|\|= "=";
1048		1296
1049	$self->add_item ({	1297	$self->add_item ({
1050	rend => { normal => "\x1b[0;30;47m", hover => "\x1b[0;30;47m", active => "\x1b[0;30;47m" },	1298	rend => { normal => "\x1b[0;30;47m", hover => "\x1b[0;30;47m", active => "\x1b[0;30;47m" },
1051	text => "",	1299	text => "",
1052	render => sub { $sep x $urxvt::TERM->ncol },	1300	render => sub { $sep x $self->{term}->ncol },
1053	activate => sub { },	1301	activate => sub { },
1054	});	1302	});
1055	}	1303	}
1056		1304
1057	sub add_title {	1305	sub add_title {
…		…
1065	}	1313	}
1066		1314
1067	sub add_button {	1315	sub add_button {
1068	my ($self, $text, $cb) = @_;	1316	my ($self, $text, $cb) = @_;
1069		1317
1070	$self->add_item ({ type => "button", text => "[ $text ]", activate => $cb});	1318	$self->add_item ({ type => "button", text => $text, activate => $cb});
1071	}	1319	}
1072		1320
1073	sub add_toggle {	1321	sub add_toggle {
1074	my ($self, $text, $cb, $value) = @_;	1322	my ($self, $text, $cb, $value) = @_;
1075		1323
1076	my $item; $item = {	1324	my $item; $item = {
1077	type => "button",	1325	type => "button",
1078	text => " $text",	1326	text => " $text",
1079	value => $value,	1327	value => $value,
1080	render => sub { ($item->{value} ? "* " : " ") . $text },	1328	render => sub { ($_[0]{value} ? "* " : " ") . $text },
1081	activate => sub { $cb->($item->{value} = !$item->{value}); },	1329	activate => sub { $cb->($_[0]{value} = !$_[0]{value}); },
1082	};	1330	};
1083		1331
1084	$self->add_item ($item);	1332	$self->add_item ($item);
1085	}	1333	}
1086		1334
1087	sub show {	1335	sub show {
1088	my ($self) = @_;	1336	my ($self) = @_;
1089		1337
1090	local $urxvt::popup::self = $self;	1338	local $urxvt::popup::self = $self;
1091		1339
		1340	local $ENV{LC_ALL} = $self->{term}->locale;
		1341
1092	urxvt->new ("--perl-lib" => "", "--perl-ext-common" => "", "-pty-fd" => -1, "-sl" => 0, "-b" => 0,	1342	urxvt->new ("--perl-lib" => "", "--perl-ext-common" => "", "-pty-fd" => -1, "-sl" => 0, "-b" => 0,
1093	"--transient-for" => $self->{term}->parent,	1343	"--transient-for" => $self->{term}->parent,
		1344	"-display" => $self->{term}->display_id,
1094	"-pe" => "urxvt-popup")	1345	"-pe" => "urxvt-popup")
1095	or die "unable to create popup window\n";	1346	or die "unable to create popup window\n";
1096	}	1347	}
1097		1348
1098	sub DESTROY {	1349	sub DESTROY {
1099	my ($self) = @_;	1350	my ($self) = @_;
1100		1351
		1352	delete $self->{term}{_destroy}{$self};
1101	$self->{term}->ungrab;	1353	$self->{term}->ungrab;
1102	}	1354	}
1103		1355
1104	=head2 The C<urxvt::timer> Class	1356	=head2 The C<urxvt::timer> Class
1105		1357
…		…
1160		1412
1161	$term->{socket} = ...	1413	$term->{socket} = ...
1162	$term->{iow} = urxvt::iow	1414	$term->{iow} = urxvt::iow
1163	->new	1415	->new
1164	->fd (fileno $term->{socket})	1416	->fd (fileno $term->{socket})
1165	->events (1) # wait for read data	1417	->events (urxvt::EVENT_READ)
1166	->start	1418	->start
1167	->cb (sub {	1419	->cb (sub {
1168	my ($iow, $revents) = @_;	1420	my ($iow, $revents) = @_;
1169	# $revents must be 1 here, no need to check	1421	# $revents must be 1 here, no need to check
1170	sysread $term->{socket}, my $buf, 8192	1422	sysread $term->{socket}, my $buf, 8192
…		…
1187		1439
1188	Set the filedescriptor (not handle) to watch.	1440	Set the filedescriptor (not handle) to watch.
1189		1441
1190	=item $iow = $iow->events ($eventmask)	1442	=item $iow = $iow->events ($eventmask)
1191		1443
1192	Set the event mask to watch. Bit #0 (value C<1>) enables watching for read	1444	Set the event mask to watch. The only allowed values are
1193	data, Bit #1 (value C<2>) enables watching for write data.	1445	C<urxvt::EVENT_READ> and C<urxvt::EVENT_WRITE>, which might be ORed
		1446	together, or C<urxvt::EVENT_NONE>.
1194		1447
1195	=item $iow = $iow->start	1448	=item $iow = $iow->start
1196		1449
1197	Start watching for requested events on the given handle.	1450	Start watching for requested events on the given handle.
1198		1451
…		…
1209	This variable controls the verbosity level of the perl extension. Higher	1462	This variable controls the verbosity level of the perl extension. Higher
1210	numbers indicate more verbose output.	1463	numbers indicate more verbose output.
1211		1464
1212	=over 4	1465	=over 4
1213		1466
1214	=item =0 - only fatal messages	1467	=item == 0 - fatal messages
1215		1468
1216	=item =3 - script loading and management	1469	=item >= 3 - script loading and management
1217		1470
1218	=item =10 - all events received	1471	=item >=10 - all events received
1219		1472
1220	=back	1473	=back
1221		1474
1222	=head1 AUTHOR	1475	=head1 AUTHOR
1223		1476

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.73 by root, Tue Jan 10 04:23:39 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.73 by root, Tue Jan 10 04:23:39 2006 UTC