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

Comparing rxvt-unicode/src/urxvt.pm (file contents):
Revision 1.49 by root, Sun Jan 8 00:07:18 2006 UTC vs.
Revision 1.74 by root, Tue Jan 10 04:26:54 2006 UTC

…		…
37		37
38	@@RXVT_NAME@@ -pe <extensionname>	38	@@RXVT_NAME@@ -pe <extensionname>
39		39
40	=over 4	40	=over 4
41		41
42	=item selection	42	=item selection (enabled by default)
43		43
44	Intelligent selection. This extension tries to be more intelligent when	44	Intelligent selection. This extension tries to be more intelligent when
45	the user extends selections (double-click). Right now, it tries to select	45	the user extends selections (double-click). Right now, it tries to select
46	urls and complete shell-quoted arguments, which is very convenient, too,	46	urls and complete shell-quoted arguments, which is very convenient, too,
47	if your F<ls> supports C<--quoting-style=shell>.	47	if your F<ls> supports C<--quoting-style=shell>.
…		…
55	Rot-13 the selection when activated. Used via keyboard trigger:	55	Rot-13 the selection when activated. Used via keyboard trigger:
56		56
57	URxvt.keysym.C-M-r: perl:selection:rot13	57	URxvt.keysym.C-M-r: perl:selection:rot13
58		58
59	=back	59	=back
		60
		61	=item option-popup (enabled by default)
		62
		63	Binds a popup menu to Ctrl-Button2 that lets you toggle (some) options at
		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<hotkey> (enabled by default)
		72
		73	Adds regex search functionality to the scrollback buffer, triggered
		74	by a hotkey (default: C<M-s>). When in search mode, normal terminal
		75	input/output is suspended.
		76
		77	C</> starts an incremental regex search, C<n> searches further, C<p> or
		78	C<N> jump to the previous match, C<G> jumps to the bottom and clears the
		79	history, C<enter> leaves search mode at the current position and C<escape>
		80	returns to the original position.
60		81
61	=item digital-clock	82	=item digital-clock
62		83
63	Displays a digital clock using the built-in overlay.	84	Displays a digital clock using the built-in overlay.
64		85
…		…
114	Either binary data or - more common - a text string encoded in a	135	Either binary data or - more common - a text string encoded in a
115	locale-specific way.	136	locale-specific way.
116		137
117	=back	138	=back
118		139
		140	=head2 Extension Objects
		141
		142	Very perl extension is a perl class. A separate perl object is created
		143	for each terminal and each extension and passed as the first parameter to
		144	hooks. So extensions can use their C<$self> object without having to think
		145	about other extensions, with the exception of methods and members that
		146	begin with an underscore character C<_>: these are reserved for internal
		147	use.
		148
		149	Although it isn't a C<urxvt::term> object, you can call all methods of the
		150	C<urxvt::term> class on this object.
		151
		152	It has the following methods and data members:
		153
		154	=over 4
		155
		156	=item $urxvt_term = $self->{term}
		157
		158	Returns the C<urxvt::term> object associated with this instance of the
		159	extension. This member I<must not> be changed in any way.
		160
		161	=item $self->enable ($hook_name => $cb, [$hook_name => $cb..])
		162
		163	Dynamically enable the given hooks (named without the C<on_> prefix) for
		164	this extension, replacing any previous hook. This is useful when you want
		165	to overwrite time-critical hooks only temporarily.
		166
		167	=item $self->disable ($hook_name[, $hook_name..])
		168
		169	Dynamically disable the given hooks.
		170
		171	=back
		172
119	=head2 Hooks	173	=head2 Hooks
120		174
121	The following subroutines can be declared in extension files, and will be	175	The following subroutines can be declared in extension files, and will be
122	called whenever the relevant event happens.	176	called whenever the relevant event happens.
123		177
124	The first argument passed to them is an object private to each terminal	178	The first argument passed to them is an extension oject as described in
125	and extension package. You can call all C<urxvt::term> methods on it, but	179	the in the C<Extension Objects> section.
126	its not a real C<urxvt::term> object. Instead, the real C<urxvt::term>
127	object that is shared between all packages is stored in the C<term>
128	member. It is, however, blessed intot he package of the extension script,
129	so for all practical purposes you can treat an extension script as a class.
130		180
131	All of them must return a boolean value. If it is true, then the event	181	B<All> of these hooks must return a boolean value. If it is true, then the
132	counts as being I<consumed>, and the invocation of other hooks is skipped,	182	event counts as being I<consumed>, and the invocation of other hooks is
133	and the relevant action might not be carried out by the C++ code.	183	skipped, and the relevant action might not be carried out by the C++ code.
134		184
135	When in doubt, return a false value (preferably C<()>).	185	I<< When in doubt, return a false value (preferably C<()>). >>
136		186
137	=over 4	187	=over 4
138		188
139	=item on_init $term	189	=item on_init $term
140		190
…		…
194	than the scroll back buffer or the terminal.	244	than the scroll back buffer or the terminal.
195		245
196	It is called before lines are scrolled out (so rows 0 .. min ($lines - 1,	246	It is called before lines are scrolled out (so rows 0 .. min ($lines - 1,
197	$nrow - 1) represent the lines to be scrolled out). C<$saved> is the total	247	$nrow - 1) represent the lines to be scrolled out). C<$saved> is the total
198	number of lines that will be in the scrollback buffer.	248	number of lines that will be in the scrollback buffer.
199
200	=item on_tty_activity $term NYI
201
202	Called whenever the program(s) running in the urxvt window send output.
203		249
204	=item on_osc_seq $term, $string	250	=item on_osc_seq $term, $string
205		251
206	Called whenever the B<ESC ] 777 ; string ST> command sequence (OSC =	252	Called whenever the B<ESC ] 777 ; string ST> command sequence (OSC =
207	operating system command) is processed. Cursor position and other state	253	operating system command) is processed. Cursor position and other state
…		…
220	can filter/change and output the text yourself by returning a true value	266	can filter/change and output the text yourself by returning a true value
221	and calling C<< $term->scr_add_lines >> yourself. Please note that this	267	and calling C<< $term->scr_add_lines >> yourself. Please note that this
222	might be very slow, however, as your hook is called for B<all> text being	268	might be very slow, however, as your hook is called for B<all> text being
223	output.	269	output.
224		270
		271	=item on_tt_write $term, $octets
		272
		273	Called whenever some data is written to the tty/pty and can be used to
		274	suppress or filter tty input.
		275
225	=item on_line_update $term, $row	276	=item on_line_update $term, $row
226		277
227	Called whenever a line was updated or changed. Can be used to filter	278	Called whenever a line was updated or changed. Can be used to filter
228	screen output (e.g. underline urls or other useless stuff). Only lines	279	screen output (e.g. underline urls or other useless stuff). Only lines
229	that are being shown will be filtered, and, due to performance reasons,	280	that are being shown will be filtered, and, due to performance reasons,
…		…
261	=item on_focus_out $term	312	=item on_focus_out $term
262		313
263	Called wheneever the window loses keyboard focus, before rxvt-unicode does	314	Called wheneever the window loses keyboard focus, before rxvt-unicode does
264	focus out processing.	315	focus out processing.
265		316
266	=item on_key_press $term, $event, $octets	317	=item on_key_press $term, $event, $keysym, $octets
267		318
268	=item on_key_release $term, $event	319	=item on_key_release $term, $event, $keysym
269		320
270	=item on_button_press $term, $event	321	=item on_button_press $term, $event
271		322
272	=item on_button_release $term, $event	323	=item on_button_release $term, $event
273		324
…		…
327	that calls this function.	378	that calls this function.
328		379
329	Using this function has the advantage that its output ends up in the	380	Using this function has the advantage that its output ends up in the
330	correct place, e.g. on stderr of the connecting urxvtc client.	381	correct place, e.g. on stderr of the connecting urxvtc client.
331		382
		383	=item $is_safe = urxvt::safe
		384
		385	Returns true when it is safe to do potentially unsafe things, such as
		386	evaluating perl code specified by the user. This is true when urxvt was
		387	started setuid or setgid.
		388
332	=item $time = urxvt::NOW	389	=item $time = urxvt::NOW
333		390
334	Returns the "current time" (as per the event loop).	391	Returns the "current time" (as per the event loop).
335		392
336	=item urxvt::CurrentTime	393	=item urxvt::CurrentTime
337		394
338	=item urxvt::ShiftMask, LockMask, ControlMask, Mod1Mask, Mod2Mask,	395	=item urxvt::ShiftMask, LockMask, ControlMask, Mod1Mask, Mod2Mask,
339	Mod3Mask, Mod4Mask, Mod5Mask, Button1Mask, Button2Mask, Button3Mask,	396	Mod3Mask, Mod4Mask, Mod5Mask, Button1Mask, Button2Mask, Button3Mask,
340	Button4Mask, Button5Mask, AnyModifier	397	Button4Mask, Button5Mask, AnyModifier
341		398
342	Various constants for use in X events.	399	Various constants for use in X calls and event processing.
343		400
344	=back	401	=back
345		402
346	=head2 RENDITION	403	=head2 RENDITION
347		404
…		…
399		456
400	package urxvt;	457	package urxvt;
401		458
402	use utf8;	459	use utf8;
403	use strict;	460	use strict;
		461	use Carp ();
404	use Scalar::Util ();	462	use Scalar::Util ();
405	use List::Util ();	463	use List::Util ();
406		464
		465	our $VERSION = 1;
407	our $TERM;	466	our $TERM;
408	our @HOOKNAME;	467	our @HOOKNAME;
		468	our %HOOKTYPE = map +($HOOKNAME[$_] => $_), 0..$#HOOKNAME;
409	our %OPTION;	469	our %OPTION;
		470
410	our $LIBDIR;	471	our $LIBDIR;
		472	our $RESNAME;
		473	our $RESCLASS;
		474	our $RXVTNAME;
411		475
412	BEGIN {	476	BEGIN {
413	urxvt->bootstrap;	477	urxvt->bootstrap;
414		478
415	# overwrite perl's warn	479	# overwrite perl's warn
…		…
417	my $msg = join "", @_;	481	my $msg = join "", @_;
418	$msg .= "\n"	482	$msg .= "\n"
419	unless $msg =~ /\n$/;	483	unless $msg =~ /\n$/;
420	urxvt::warn ($msg);	484	urxvt::warn ($msg);
421	};	485	};
		486
		487	delete $ENV{IFS};
		488	delete $ENV{CDPATH};
		489	delete $ENV{BASH_ENV};
		490	$ENV{PATH} = "/bin:/sbin:/usr/bin:/usr/sbin:/usr/local/bin:/usr/local/sbin:/opt/bin:/opt/sbin";
422	}	491	}
423		492
424	my @hook_count;	493	my @hook_count;
425	my $verbosity = $ENV{URXVT_PERL_VERBOSITY};	494	my $verbosity = $ENV{URXVT_PERL_VERBOSITY};
426		495
427	sub verbose {	496	sub verbose {
428	my ($level, $msg) = @_;	497	my ($level, $msg) = @_;
429	warn "$msg\n" if $level <= $verbosity;	498	warn "$msg\n" if $level <= $verbosity;
430	}	499	}
431		500
432	# find on_xxx subs in the package and register them
433	# as hooks
434	sub register_package($) {
435	my ($pkg) = @_;
436
437	for my $htype (0.. $#HOOKNAME) {
438	my $name = $HOOKNAME[$htype];
439
440	my $ref = $pkg->can ("on_" . lc $name)
441	or next;
442
443	$TERM->{_hook}[$htype]{$pkg} = $ref;
444	$hook_count[$htype]++
445	or set_should_invoke $htype, 1;
446	}
447	}
448
449	my $extension_pkg = "extension0000";	501	my $extension_pkg = "extension0000";
450	my %extension_pkg;	502	my %extension_pkg;
451		503
452	# load a single script into its own package, once only	504	# load a single script into its own package, once only
453	sub extension_package($) {	505	sub extension_package($) {
…		…
459	verbose 3, "loading extension '$path' into package '$pkg'";	511	verbose 3, "loading extension '$path' into package '$pkg'";
460		512
461	open my $fh, "<:raw", $path	513	open my $fh, "<:raw", $path
462	or die "$path: $!";	514	or die "$path: $!";
463		515
		516	my $source = untaint
464	my $source = "package $pkg; use strict; use utf8;\n"	517	"package $pkg; use strict; use utf8;\n"
465	. "use base urxvt::term::proxy::;\n"	518	. "use base urxvt::term::extension::;\n"
466	. "#line 1 \"$path\"\n{\n"	519	. "#line 1 \"$path\"\n{\n"
467	. (do { local $/; <$fh> })	520	. (do { local $/; <$fh> })
468	. "\n};\n1";	521	. "\n};\n1";
469		522
		523	eval $source
470	eval $source or die "$path: $@";	524	or die "$path: $@";
471		525
472	$pkg	526	$pkg
473	}	527	}
474	}	528	}
475		529
…		…
481	my $htype = shift;	535	my $htype = shift;
482		536
483	if ($htype == 0) { # INIT	537	if ($htype == 0) { # INIT
484	my @dirs = ((split /:/, $TERM->resource ("perl_lib")), "$LIBDIR/perl");	538	my @dirs = ((split /:/, $TERM->resource ("perl_lib")), "$LIBDIR/perl");
485		539
		540	my %ext_arg;
		541
486	my @ext = (map { split /,/, $TERM->resource ("perl_ext_$_") } 1, 2);	542	for (map { split /,/, $TERM->resource ("perl_ext_$_") } 1, 2) {
487
488	while (@ext) {
489	my $ext = shift @ext;
490	if ($ext eq "default") {	543	if ($_ eq "default") {
491	unshift @ext, qw(selection);	544	$ext_arg{$_} \|\|= [] for qw(selection option-popup selection-popup searchable-scrollback);
		545	} elsif (/^-(.*)$/) {
		546	delete $ext_arg{$1};
		547	} elsif (/^([^<]+)<(.*)>$/) {
		548	push @{ $ext_arg{$1} }, $2;
492	} else {	549	} else {
		550	$ext_arg{$_} \|\|= [];
		551	}
		552	}
		553
		554	while (my ($ext, $argv) = each %ext_arg) {
493	my @files = grep -f $_, map "$_/$ext", @dirs;	555	my @files = grep -f $_, map "$_/$ext", @dirs;
494		556
495	if (@files) {	557	if (@files) {
496	register_package extension_package $files[0];	558	$TERM->register_package (extension_package $files[0], $argv);
497	} else {	559	} else {
498	warn "perl extension '$ext' not found in perl library search path\n";	560	warn "perl extension '$ext' not found in perl library search path\n";
499	}	561	}
		562	}
		563
		564	eval "#line 1 \"--perl-eval resource/argument\"\n" . $TERM->resource ("perl_eval");
		565	warn $@ if $@;
		566	}
		567
		568	$retval = undef;
		569
		570	if (my $cb = $TERM->{_hook}[$htype]) {
		571	verbose 10, "$HOOKNAME[$htype] (" . (join ", ", $TERM, @_) . ")"
		572	if $verbosity >= 10;
		573
		574	keys %$cb;
		575
		576	while (my ($pkg, $cb) = each %$cb) {
		577	$retval = eval { $cb->($TERM->{_pkg}{$pkg}, @_) }
		578	and last;
		579
		580	if ($@) {
		581	$TERM->ungrab; # better to lose the grab than the session
		582	warn $@;
500	}	583	}
501	}	584	}
502	}	585	}
503		586
504	$retval = undef;
505
506	if (my $cb = $TERM->{_hook}[$htype]) {
507	verbose 10, "$HOOKNAME[$htype] (" . (join ", ", $TERM, @_) . ")"
508	if $verbosity >= 10;
509
510	keys %$cb;
511
512	while (my ($pkg, $cb) = each %$cb) {
513	eval {
514	$retval = $cb->(
515	$TERM->{_pkg}{$pkg} \|\|= do {
516	my $proxy = bless { }, $pkg;
517	Scalar::Util::weaken ($proxy->{term} = $TERM);
518	$proxy
519	},
520	@_,
521	) and last;
522	};
523	warn $@ if $@;#d#
524	}
525	}
526
527	if ($htype == 1) { # DESTROY	587	if ($htype == 1) { # DESTROY
528	# remove hooks if unused
529	if (my $hook = $TERM->{_hook}) {	588	if (my $hook = delete $TERM->{_hook}) {
530	for my $htype (0..$#$hook) {	589	for my $htype (0..$#$hook) {
531	$hook_count[$htype] -= scalar keys %{ $hook->[$htype] \|\| {} }	590	$hook_count[$htype] -= scalar keys %{ $hook->[$htype] \|\| {} }
532	or set_should_invoke $htype, 0;	591	or set_should_invoke $htype, 0;
533	}	592	}
534	}	593	}
…		…
541	}	600	}
542		601
543	$retval	602	$retval
544	}	603	}
545		604
546	sub urxvt::term::proxy::AUTOLOAD {	605	# urxvt::term::extension
547	$urxvt::term::proxy::AUTOLOAD =~ /:([^:]+)$/	606
		607	package urxvt::term::extension;
		608
		609	sub enable {
		610	my ($self, %hook) = @_;
		611	my $pkg = $self->{_pkg};
		612
		613	while (my ($name, $cb) = each %hook) {
		614	my $htype = $HOOKTYPE{uc $name};
		615	defined $htype
		616	or Carp::croak "unsupported hook type '$name'";
		617
		618	unless (exists $self->{term}{_hook}[$htype]{$pkg}) {
		619	$hook_count[$htype]++
		620	or urxvt::set_should_invoke $htype, 1;
		621	}
		622
		623	$self->{term}{_hook}[$htype]{$pkg} = $cb;
		624	}
		625	}
		626
		627	sub disable {
		628	my ($self, @hook) = @_;
		629	my $pkg = $self->{_pkg};
		630
		631	for my $name (@hook) {
		632	my $htype = $HOOKTYPE{uc $name};
		633	defined $htype
		634	or Carp::croak "unsupported hook type '$name'";
		635
		636	if (delete $self->{term}{_hook}[$htype]{$pkg}) {
		637	--$hook_count[$htype]
		638	or urxvt::set_should_invoke $htype, 0;
		639	}
		640	}
		641	}
		642
		643	our $AUTOLOAD;
		644
		645	sub AUTOLOAD {
		646	$AUTOLOAD =~ /:([^:]+)$/
548	or die "FATAL: \$AUTOLOAD '$urxvt::term::proxy::AUTOLOAD' unparsable";	647	or die "FATAL: \$AUTOLOAD '$AUTOLOAD' unparsable";
549		648
550	eval qq{	649	eval qq{
551	sub $urxvt::term::proxy::AUTOLOAD {	650	sub $AUTOLOAD {
552	my \$proxy = shift;	651	my \$proxy = shift;
553	\$proxy->{term}->$1 (\@_)	652	\$proxy->{term}->$1 (\@_)
554	}	653	}
555	1	654	1
556	} or die "FATAL: unable to compile method forwarder: $@";	655	} or die "FATAL: unable to compile method forwarder: $@";
557		656
558	goto &$urxvt::term::proxy::AUTOLOAD;	657	goto &$AUTOLOAD;
559	}	658	}
		659
		660	sub DESTROY {
		661	# nop
		662	}
		663
		664	# urxvt::destroy_hook
560		665
561	sub urxvt::destroy_hook::DESTROY {	666	sub urxvt::destroy_hook::DESTROY {
562	${$_[0]}->();	667	${$_[0]}->();
563	}	668	}
564		669
565	sub urxvt::destroy_hook(&) {	670	sub urxvt::destroy_hook(&) {
566	bless \shift, urxvt::destroy_hook::	671	bless \shift, urxvt::destroy_hook::
567	}	672	}
568		673
		674	package urxvt::anyevent;
		675
		676	=head2 The C<urxvt::anyevent> Class
		677
		678	The sole purpose of this class is to deliver an interface to the
		679	C<AnyEvent> module - any module using it will work inside urxvt without
		680	further work. The only exception is that you cannot wait on condition
		681	variables, but non-blocking condvar use is ok. What this means is that you
		682	cannot use blocking APIs, but the non-blocking variant should work.
		683
		684	=cut
		685
		686	our $VERSION = 1;
		687
		688	$INC{"urxvt/anyevent.pm"} = 1; # mark us as there
		689	push @AnyEvent::REGISTRY, [urxvt => urxvt::anyevent::];
		690
		691	sub timer {
		692	my ($class, %arg) = @_;
		693
		694	my $cb = $arg{cb};
		695
		696	urxvt::timer
		697	->new
		698	->start (urxvt::NOW + $arg{after})
		699	->cb (sub {
		700	$_[0]->stop; # need to cancel manually
		701	$cb->();
		702	})
		703	}
		704
		705	sub io {
		706	my ($class, %arg) = @_;
		707
		708	my $cb = $arg{cb};
		709
		710	bless [$arg{fh}, urxvt::iow
		711	->new
		712	->fd (fileno $arg{fh})
		713	->events (($arg{poll} =~ /r/ ? 1 : 0)
		714	\| ($arg{poll} =~ /w/ ? 2 : 0))
		715	->start
		716	->cb (sub {
		717	$cb->(($_[1] & 1 ? 'r' : '')
		718	. ($_[1] & 2 ? 'w' : ''));
		719	})],
		720	urxvt::anyevent::
		721	}
		722
		723	sub DESTROY {
		724	$_[0][1]->stop;
		725	}
		726
		727	sub condvar {
		728	bless \my $flag, urxvt::anyevent::condvar::
		729	}
		730
		731	sub urxvt::anyevent::condvar::broadcast {
		732	${$_[0]}++;
		733	}
		734
		735	sub urxvt::anyevent::condvar::wait {
		736	unless (${$_[0]}) {
		737	Carp::croak "AnyEvent->condvar blocking wait unsupported in urxvt, use a non-blocking API";
		738	}
		739	}
		740
		741	package urxvt::term;
		742
569	=head2 The C<urxvt::term> Class	743	=head2 The C<urxvt::term> Class
570		744
571	=over 4	745	=over 4
		746
		747	=cut
		748
		749	# find on_xxx subs in the package and register them
		750	# as hooks
		751	sub register_package {
		752	my ($self, $pkg, $argv) = @_;
		753
		754	my $proxy = bless {
		755	_pkg => $pkg,
		756	argv => $argv,
		757	}, $pkg;
		758	Scalar::Util::weaken ($proxy->{term} = $self);
		759
		760	$self->{_pkg}{$pkg} = $proxy;
		761
		762	for my $name (@HOOKNAME) {
		763	if (my $ref = $pkg->can ("on_" . lc $name)) {
		764	$proxy->enable ($name => $ref);
		765	}
		766	}
		767	}
572		768
573	=item $term->destroy	769	=item $term->destroy
574		770
575	Destroy the terminal object (close the window, free resources etc.).	771	Destroy the terminal object (close the window, free resources etc.).
576		772
…		…
624	shade term_name title transparent transparent_all tripleclickwords	820	shade term_name title transparent transparent_all tripleclickwords
625	utmpInhibit visualBell	821	utmpInhibit visualBell
626		822
627	=cut	823	=cut
628		824
629	sub urxvt::term::resource($$;$) {	825	sub resource($$;$) {
630	my ($self, $name) = (shift, shift);	826	my ($self, $name) = (shift, shift);
631	unshift @_, $self, $name, ($name =~ s/\s\+\s(\d+)$// ? $1 : 0);	827	unshift @_, $self, $name, ($name =~ s/\s\+\s(\d+)$// ? $1 : 0);
632	&urxvt::term::_resource	828	&urxvt::term::_resource
633	}	829	}
634		830
		831	=item $success = $term->parse_keysym ($keysym_spec, $command_string)
		832
		833	Adds a keymap translation exactly as specified via a resource. See the
		834	C<keysym> resource in the @@RXVT_NAME@@(1) manpage.
		835
635	=item $rend = $term->rstyle ([$new_rstyle])	836	=item $rend = $term->rstyle ([$new_rstyle])
636		837
637	Return and optionally change the current rendition. Text that is output by	838	Return and optionally change the current rendition. Text that is output by
638	the terminal application will use this style.	839	the terminal application will use this style.
639		840
…		…
658		859
659	=item $oldtext = $term->selection ([$newtext])	860	=item $oldtext = $term->selection ([$newtext])
660		861
661	Return the current selection text and optionally replace it by C<$newtext>.	862	Return the current selection text and optionally replace it by C<$newtext>.
662		863
663	#=item $term->overlay ($x, $y, $text)	864	=item $term->overlay_simple ($x, $y, $text)
664	#	865
665	#Create a simple multi-line overlay box. See the next method for details.	866	Create a simple multi-line overlay box. See the next method for details.
666	#	867
667	#=cut	868	=cut
668	#	869
669	#sub urxvt::term::scr_overlay {	870	sub overlay_simple {
670	# my ($self, $x, $y, $text) = @_;	871	my ($self, $x, $y, $text) = @_;
671	#	872
672	# my @lines = split /\n/, $text;	873	my @lines = split /\n/, $text;
673	#	874
674	# my $w = 0;	875	my $w = List::Util::max map $self->strwidth ($_), @lines;
675	# for (map $self->strwidth ($_), @lines) {	876
676	# $w = $_ if $w < $_;
677	# }
678	#
679	# $self->scr_overlay_new ($x, $y, $w, scalar @lines);	877	my $overlay = $self->overlay ($x, $y, $w, scalar @lines);
680	# $self->scr_overlay_set (0, $_, $lines[$_]) for 0.. $#lines;	878	$overlay->set (0, $_, $lines[$_]) for 0.. $#lines;
681	#}	879
		880	$overlay
		881	}
682		882
683	=item $term->overlay ($x, $y, $width, $height[, $rstyle[, $border]])	883	=item $term->overlay ($x, $y, $width, $height[, $rstyle[, $border]])
684		884
685	Create a new (empty) overlay at the given position with the given	885	Create a new (empty) overlay at the given position with the given
686	width/height. C<$rstyle> defines the initial rendition style	886	width/height. C<$rstyle> defines the initial rendition style
…		…
721	C<$event> I<must> be the event causing the menu to pop up (a button event,	921	C<$event> I<must> be the event causing the menu to pop up (a button event,
722	currently).	922	currently).
723		923
724	=cut	924	=cut
725		925
726	sub urxvt::term::popup {	926	sub popup {
727	my ($self, $event) = @_;	927	my ($self, $event) = @_;
728		928
729	$self->grab ($event->{time}, 1)	929	$self->grab ($event->{time}, 1)
730	or return;	930	or return;
731		931
…		…
753		953
754	=item $string = $term->locale_decode ($octets)	954	=item $string = $term->locale_decode ($octets)
755		955
756	Convert the given locale-encoded octets into a perl string.	956	Convert the given locale-encoded octets into a perl string.
757		957
		958	=item $term->scr_xor_span ($beg_row, $beg_col, $end_row, $end_col[, $rstyle])
		959
		960	XORs the rendition values in the given span with the provided value
		961	(default: C<RS_RVid>). Useful in refresh hooks to provide effects similar
		962	to the selection.
		963
		964	=item $term->scr_xor_rect ($beg_row, $beg_col, $end_row, $end_col[, $rstyle1[, $rstyle2]])
		965
		966	Similar to C<scr_xor_span>, but xors a rectangle instead. Trailing
		967	whitespace will additionally be xored with the C<$rstyle2>, which defaults
		968	to C<RS_RVid \| RS_Uline>, which removes reverse video again and underlines
		969	it instead.
		970
		971	=item $term->scr_bell
		972
		973	Ring the bell!
		974
758	=item $term->scr_add_lines ($string)	975	=item $term->scr_add_lines ($string)
759		976
760	Write the given text string to the screen, as if output by the application	977	Write the given text string to the screen, as if output by the application
761	running inside the terminal. It may not contain command sequences (escape	978	running inside the terminal. It may not contain command sequences (escape
762	codes), but is free to use line feeds, carriage returns and tabs. The	979	codes), but is free to use line feeds, carriage returns and tabs. The
…		…
776		993
777	Write the octets given in C<$data> to the tty (i.e. as program input). To	994	Write the octets given in C<$data> to the tty (i.e. as program input). To
778	pass characters instead of octets, you should convert your strings first	995	pass characters instead of octets, you should convert your strings first
779	to the locale-specific encoding using C<< $term->locale_encode >>.	996	to the locale-specific encoding using C<< $term->locale_encode >>.
780		997
		998	=item $old_events = $term->pty_ev_events ([$new_events])
		999
		1000	Replaces the event mask of the pty watcher by the given event mask. Can
		1001	be used to suppress input and output handling to the pty/tty. See the
		1002	description of C<< urxvt::timer->events >>. Make sure to always restore
		1003	the previous value.
		1004
781	=item $windowid = $term->parent	1005	=item $windowid = $term->parent
782		1006
783	Return the window id of the toplevel window.	1007	Return the window id of the toplevel window.
784		1008
785	=item $windowid = $term->vt	1009	=item $windowid = $term->vt
…		…
809	=item $nrow_plus_saveLines = $term->total_rows	1033	=item $nrow_plus_saveLines = $term->total_rows
810		1034
811	=item $lines_in_scrollback = $term->nsaved	1035	=item $lines_in_scrollback = $term->nsaved
812		1036
813	Return various integers describing terminal characteristics.	1037	Return various integers describing terminal characteristics.
		1038
		1039	=item $lc_ctype = $term->locale
		1040
		1041	Returns the LC_CTYPE category string used by this rxvt-unicode.
		1042
		1043	=item $x_display = $term->display_id
		1044
		1045	Return the DISPLAY used by rxvt-unicode.
814		1046
815	=item $modifiermask = $term->ModLevel3Mask	1047	=item $modifiermask = $term->ModLevel3Mask
816		1048
817	=item $modifiermask = $term->ModMetaMask	1049	=item $modifiermask = $term->ModMetaMask
818		1050
…		…
921		1153
922	=back	1154	=back
923		1155
924	=cut	1156	=cut
925		1157
926	sub urxvt::term::line {	1158	sub line {
927	my ($self, $row) = @_;	1159	my ($self, $row) = @_;
928		1160
929	my $maxrow = $self->nrow - 1;	1161	my $maxrow = $self->nrow - 1;
930		1162
931	my ($beg, $end) = ($row, $row);	1163	my ($beg, $end) = ($row, $row);
…		…
995	$offset / $self->{ncol} + $self->{beg},	1227	$offset / $self->{ncol} + $self->{beg},
996	$offset % $self->{ncol}	1228	$offset % $self->{ncol}
997	)	1229	)
998	}	1230	}
999		1231
1000	=item ($row, $col) = $line->coord_of ($offset)
1001	=item $text = $term->special_encode $string	1232	=item $text = $term->special_encode $string
1002		1233
1003	Converts a perl string into the special encoding used by rxvt-unicode,	1234	Converts a perl string into the special encoding used by rxvt-unicode,
1004	where one character corresponds to one screen cell. See	1235	where one character corresponds to one screen cell. See
1005	C<< $term->ROW_t >> for details.	1236	C<< $term->ROW_t >> for details.
…		…
1007	=item $string = $term->special_decode $text	1238	=item $string = $term->special_decode $text
1008		1239
1009	Converts rxvt-unicodes text reprsentation into a perl string. See	1240	Converts rxvt-unicodes text reprsentation into a perl string. See
1010	C<< $term->ROW_t >> for details.	1241	C<< $term->ROW_t >> for details.
1011		1242
		1243	=item $success = $term->grab_button ($button, $modifiermask)
		1244
		1245	Registers a synchronous button grab. See the XGrabButton manpage.
		1246
		1247	=item $success = $term->grab ($eventtime[, $sync])
		1248
		1249	Calls XGrabPointer and XGrabKeyboard in asynchronous (default) or
		1250	synchronous (C<$sync> is true). Also remembers the grab timestampe.
		1251
		1252	=item $term->allow_events_async
		1253
		1254	Calls XAllowEvents with AsyncBoth for the most recent grab.
		1255
		1256	=item $term->allow_events_sync
		1257
		1258	Calls XAllowEvents with SyncBoth for the most recent grab.
		1259
		1260	=item $term->allow_events_replay
		1261
		1262	Calls XAllowEvents with both ReplayPointer and ReplayKeyboard for the most
		1263	recent grab.
		1264
		1265	=item $term->ungrab
		1266
		1267	Calls XUngrab for the most recent grab. Is called automatically on
		1268	evaluation errors, as it is better to lose the grab in the error case as
		1269	the session.
		1270
1012	=back	1271	=back
1013		1272
		1273	=cut
		1274
		1275	package urxvt::popup;
		1276
1014	=head2 The C<urxvt::popup> Class	1277	=head2 The C<urxvt::popup> Class
1015		1278
1016	=over 4	1279	=over 4
1017		1280
1018	=cut	1281	=cut
1019
1020	package urxvt::popup;
1021		1282
1022	sub add_item {	1283	sub add_item {
1023	my ($self, $item) = @_;	1284	my ($self, $item) = @_;
1024		1285
		1286	$item->{rend}{normal} = "\x1b[0;30;47m" unless exists $item->{rend}{normal};
		1287	$item->{rend}{hover} = "\x1b[0;30;46m" unless exists $item->{rend}{hover};
		1288	$item->{rend}{active} = "\x1b[m" unless exists $item->{rend}{active};
		1289
		1290	$item->{render} \|\|= sub { $_[0]{text} };
		1291
1025	push @{ $self->{item} }, $item;	1292	push @{ $self->{item} }, $item;
		1293	}
		1294
		1295	sub add_separator {
		1296	my ($self, $sep) = @_;
		1297
		1298	$sep \|\|= "=";
		1299
		1300	$self->add_item ({
		1301	rend => { normal => "\x1b[0;30;47m", hover => "\x1b[0;30;47m", active => "\x1b[0;30;47m" },
		1302	text => "",
		1303	render => sub { $sep x $self->{term}->ncol },
		1304	activate => sub { },
		1305	});
		1306	}
		1307
		1308	sub add_title {
		1309	my ($self, $title) = @_;
		1310
		1311	$self->add_item ({
		1312	rend => { normal => "\x1b[38;5;11;44m", hover => "\x1b[38;5;11;44m", active => "\x1b[38;5;11;44m" },
		1313	text => $title,
		1314	activate => sub { },
		1315	});
1026	}	1316	}
1027		1317
1028	sub add_button {	1318	sub add_button {
1029	my ($self, $text, $cb) = @_;	1319	my ($self, $text, $cb) = @_;
1030		1320
1031	$self->add_item ({ type => "button", text => "[ $text ]", activate => $cb,	1321	$self->add_item ({ type => "button", text => $text, activate => $cb});
1032	render => sub { $_[0]{text} },
1033	});
1034	}	1322	}
1035		1323
1036	sub add_toggle {	1324	sub add_toggle {
1037	my ($self, $text, $cb, $value) = @_;	1325	my ($self, $text, $cb, $value) = @_;
1038		1326
1039	my $item; $item = {	1327	my $item; $item = {
1040	type => "button",	1328	type => "button",
1041	text => " $text",	1329	text => " $text",
1042	value => $value,	1330	value => $value,
1043	render => sub { ($item->{value} ? "✔" : " ") . $text },	1331	render => sub { ($_[0]{value} ? "* " : " ") . $text },
1044	activate => sub { $cb->($item->{value} = !$item->{value}); },	1332	activate => sub { $cb->($_[0]{value} = !$_[0]{value}); },
1045	};	1333	};
1046		1334
1047	$self->add_item ($item);	1335	$self->add_item ($item);
1048	}	1336	}
1049		1337
1050	sub show {	1338	sub show {
1051	my ($self) = @_;	1339	my ($self) = @_;
1052		1340
1053	local $urxvt::popup::self = $self;	1341	local $urxvt::popup::self = $self;
1054		1342
		1343	local $ENV{LC_ALL} = $self->{term}->locale;
		1344
1055	urxvt->new ("--perl-lib" => "", "--perl-ext-common" => "", "-pty-fd" => -1, "-sl" => 0, "-b" => 0,	1345	urxvt->new ("--perl-lib" => "", "--perl-ext-common" => "", "-pty-fd" => -1, "-sl" => 0, "-b" => 0,
1056	"--transient-for" => $self->{term}->parent,	1346	"--transient-for" => $self->{term}->parent,
		1347	"-display" => $self->{term}->display_id,
1057	"-pe" => "urxvt-popup")	1348	"-pe" => "urxvt-popup")
1058	or die "unable to create popup window\n";	1349	or die "unable to create popup window\n";
1059	}	1350	}
1060		1351
1061	sub DESTROY {	1352	sub DESTROY {
1062	my ($self) = @_;	1353	my ($self) = @_;
1063		1354
		1355	delete $self->{term}{_destroy}{$self};
1064	$self->{term}->ungrab;	1356	$self->{term}->ungrab;
1065	}	1357	}
1066		1358
1067	=head2 The C<urxvt::timer> Class	1359	=head2 The C<urxvt::timer> Class
1068		1360
…		…
1123		1415
1124	$term->{socket} = ...	1416	$term->{socket} = ...
1125	$term->{iow} = urxvt::iow	1417	$term->{iow} = urxvt::iow
1126	->new	1418	->new
1127	->fd (fileno $term->{socket})	1419	->fd (fileno $term->{socket})
1128	->events (1) # wait for read data	1420	->events (urxvt::EVENT_READ)
1129	->start	1421	->start
1130	->cb (sub {	1422	->cb (sub {
1131	my ($iow, $revents) = @_;	1423	my ($iow, $revents) = @_;
1132	# $revents must be 1 here, no need to check	1424	# $revents must be 1 here, no need to check
1133	sysread $term->{socket}, my $buf, 8192	1425	sysread $term->{socket}, my $buf, 8192
…		…
1150		1442
1151	Set the filedescriptor (not handle) to watch.	1443	Set the filedescriptor (not handle) to watch.
1152		1444
1153	=item $iow = $iow->events ($eventmask)	1445	=item $iow = $iow->events ($eventmask)
1154		1446
1155	Set the event mask to watch. Bit #0 (value C<1>) enables watching for read	1447	Set the event mask to watch. The only allowed values are
1156	data, Bit #1 (value C<2>) enables watching for write data.	1448	C<urxvt::EVENT_READ> and C<urxvt::EVENT_WRITE>, which might be ORed
		1449	together, or C<urxvt::EVENT_NONE>.
1157		1450
1158	=item $iow = $iow->start	1451	=item $iow = $iow->start
1159		1452
1160	Start watching for requested events on the given handle.	1453	Start watching for requested events on the given handle.
1161		1454
…		…
1172	This variable controls the verbosity level of the perl extension. Higher	1465	This variable controls the verbosity level of the perl extension. Higher
1173	numbers indicate more verbose output.	1466	numbers indicate more verbose output.
1174		1467
1175	=over 4	1468	=over 4
1176		1469
1177	=item =0 - only fatal messages	1470	=item == 0 - fatal messages
1178		1471
1179	=item =3 - script loading and management	1472	=item >= 3 - script loading and management
1180		1473
1181	=item =10 - all events received	1474	=item >=10 - all events received
1182		1475
1183	=back	1476	=back
1184		1477
1185	=head1 AUTHOR	1478	=head1 AUTHOR
1186		1479

Diff Legend

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

Comparing rxvt-unicode/src/urxvt.pm (file contents): Revision 1.49 by root, Sun Jan 8 00:07:18 2006 UTC vs. Revision 1.74 by root, Tue Jan 10 04:26:54 2006 UTC

Diff Legend

Comparing rxvt-unicode/src/urxvt.pm (file contents):
Revision 1.49 by root, Sun Jan 8 00:07:18 2006 UTC vs.
Revision 1.74 by root, Tue Jan 10 04:26:54 2006 UTC