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

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.72 by root, Mon Jan 9 23:30:01 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.72 by root, Mon Jan 9 23:30:01 2006 UTC