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

Comparing rxvt-unicode/src/urxvt.pm (file contents):
Revision 1.48 by root, Sat Jan 7 21:43:17 2006 UTC vs.
Revision 1.70 by root, Mon Jan 9 23:00:07 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 (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.
60		78
61	=item digital-clock	79	=item digital-clock
62		80
63	Displays a digital clock using the built-in overlay.	81	Displays a digital clock using the built-in overlay.
64		82
…		…
114	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
115	locale-specific way.	133	locale-specific way.
116		134
117	=back	135	=back
118		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
119	=head2 Hooks	170	=head2 Hooks
120		171
121	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
122	called whenever the relevant event happens.	173	called whenever the relevant event happens.
123		174
124	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
125	and extension package. You can call all C<urxvt::term> methods on it, but	176	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		177
131	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
132	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
133	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.
134		181
135	When in doubt, return a false value (preferably C<()>).	182	I<< When in doubt, return a false value (preferably C<()>). >>
136		183
137	=over 4	184	=over 4
138		185
139	=item on_init $term	186	=item on_init $term
140		187
…		…
194	than the scroll back buffer or the terminal.	241	than the scroll back buffer or the terminal.
195		242
196	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,
197	$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
198	number of lines that will be in the scrollback buffer.	245	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		246
204	=item on_osc_seq $term, $string	247	=item on_osc_seq $term, $string
205		248
206	Called whenever the B<ESC ] 777 ; string ST> command sequence (OSC =	249	Called whenever the B<ESC ] 777 ; string ST> command sequence (OSC =
207	operating system command) is processed. Cursor position and other state	250	operating system command) is processed. Cursor position and other state
…		…
261	=item on_focus_out $term	304	=item on_focus_out $term
262		305
263	Called wheneever the window loses keyboard focus, before rxvt-unicode does	306	Called wheneever the window loses keyboard focus, before rxvt-unicode does
264	focus out processing.	307	focus out processing.
265		308
266	=item on_key_press $term, $event, $octets	309	=item on_key_press $term, $event, $keysym, $octets
267		310
268	=item on_key_release $term, $event	311	=item on_key_release $term, $event, $keysym
269		312
270	=item on_button_press $term, $event	313	=item on_button_press $term, $event
271		314
272	=item on_button_release $term, $event	315	=item on_button_release $term, $event
273		316
…		…
327	that calls this function.	370	that calls this function.
328		371
329	Using this function has the advantage that its output ends up in the	372	Using this function has the advantage that its output ends up in the
330	correct place, e.g. on stderr of the connecting urxvtc client.	373	correct place, e.g. on stderr of the connecting urxvtc client.
331		374
		375	=item $is_safe = urxvt::safe
		376
		377	Returns true when it is safe to do potentially unsafe things, such as
		378	evaluating perl code specified by the user. This is true when urxvt was
		379	started setuid or setgid.
		380
332	=item $time = urxvt::NOW	381	=item $time = urxvt::NOW
333		382
334	Returns the "current time" (as per the event loop).	383	Returns the "current time" (as per the event loop).
335		384
336	=item urxvt::CurrentTime	385	=item urxvt::CurrentTime
337		386
338	=item urxvt::ShiftMask, LockMask, ControlMask, Mod1Mask, Mod2Mask,	387	=item urxvt::ShiftMask, LockMask, ControlMask, Mod1Mask, Mod2Mask,
339	Mod3Mask, Mod4Mask, Mod5Mask, Button1Mask, Button2Mask, Button3Mask,	388	Mod3Mask, Mod4Mask, Mod5Mask, Button1Mask, Button2Mask, Button3Mask,
340	Button4Mask, Button5Mask, AnyModifier	389	Button4Mask, Button5Mask, AnyModifier
341		390
342	Various constants for use in X events.	391	Various constants for use in X calls and event processing.
343		392
344	=back	393	=back
345		394
346	=head2 RENDITION	395	=head2 RENDITION
347		396
…		…
399		448
400	package urxvt;	449	package urxvt;
401		450
402	use utf8;	451	use utf8;
403	use strict;	452	use strict;
		453	use Carp ();
404	use Scalar::Util ();	454	use Scalar::Util ();
405	use List::Util ();	455	use List::Util ();
406		456
		457	our $VERSION = 1;
407	our $TERM;	458	our $TERM;
408	our @HOOKNAME;	459	our @HOOKNAME;
		460	our %HOOKTYPE = map +($HOOKNAME[$_] => $_), 0..$#HOOKNAME;
		461	our %OPTION;
409	our $LIBDIR;	462	our $LIBDIR;
410		463
411	BEGIN {	464	BEGIN {
412	urxvt->bootstrap;	465	urxvt->bootstrap;
413		466
…		…
416	my $msg = join "", @_;	469	my $msg = join "", @_;
417	$msg .= "\n"	470	$msg .= "\n"
418	unless $msg =~ /\n$/;	471	unless $msg =~ /\n$/;
419	urxvt::warn ($msg);	472	urxvt::warn ($msg);
420	};	473	};
		474
		475	delete $ENV{IFS};
		476	delete $ENV{CDPATH};
		477	delete $ENV{BASH_ENV};
		478	$ENV{PATH} = "/bin:/sbin:/usr/bin:/usr/sbin:/usr/local/bin:/usr/local/sbin:/opt/bin:/opt/sbin";
421	}	479	}
422		480
423	my @hook_count;	481	my @hook_count;
424	my $verbosity = $ENV{URXVT_PERL_VERBOSITY};	482	my $verbosity = $ENV{URXVT_PERL_VERBOSITY};
425		483
426	sub verbose {	484	sub verbose {
427	my ($level, $msg) = @_;	485	my ($level, $msg) = @_;
428	warn "$msg\n" if $level <= $verbosity;	486	warn "$msg\n" if $level <= $verbosity;
429	}	487	}
430		488
431	# find on_xxx subs in the package and register them
432	# as hooks
433	sub register_package($) {
434	my ($pkg) = @_;
435
436	for my $htype (0.. $#HOOKNAME) {
437	my $name = $HOOKNAME[$htype];
438
439	my $ref = $pkg->can ("on_" . lc $name)
440	or next;
441
442	$TERM->{_hook}[$htype]{$pkg} = $ref;
443	$hook_count[$htype]++
444	or set_should_invoke $htype, 1;
445	}
446	}
447
448	my $extension_pkg = "extension0000";	489	my $extension_pkg = "extension0000";
449	my %extension_pkg;	490	my %extension_pkg;
450		491
451	# load a single script into its own package, once only	492	# load a single script into its own package, once only
452	sub extension_package($) {	493	sub extension_package($) {
…		…
458	verbose 3, "loading extension '$path' into package '$pkg'";	499	verbose 3, "loading extension '$path' into package '$pkg'";
459		500
460	open my $fh, "<:raw", $path	501	open my $fh, "<:raw", $path
461	or die "$path: $!";	502	or die "$path: $!";
462		503
		504	my $source = untaint
463	my $source = "package $pkg; use strict; use utf8;\n"	505	"package $pkg; use strict; use utf8;\n"
464	. "use base urxvt::term::proxy::;\n"	506	. "use base urxvt::term::proxy::;\n"
465	. "#line 1 \"$path\"\n{\n"	507	. "#line 1 \"$path\"\n{\n"
466	. (do { local $/; <$fh> })	508	. (do { local $/; <$fh> })
467	. "\n};\n1";	509	. "\n};\n1";
468		510
		511	eval $source
469	eval $source or die "$path: $@";	512	or die "$path: $@";
470		513
471	$pkg	514	$pkg
472	}	515	}
473	}	516	}
474		517
…		…
479	local $TERM = shift;	522	local $TERM = shift;
480	my $htype = shift;	523	my $htype = shift;
481		524
482	if ($htype == 0) { # INIT	525	if ($htype == 0) { # INIT
483	my @dirs = ((split /:/, $TERM->resource ("perl_lib")), "$LIBDIR/perl");	526	my @dirs = ((split /:/, $TERM->resource ("perl_lib")), "$LIBDIR/perl");
		527
		528	my %ext_arg;
484		529
485	for my $ext (map { split /,/, $TERM->resource ("perl_ext_$_") } 1, 2) {	530	for (map { split /,/, $TERM->resource ("perl_ext_$_") } 1, 2) {
		531	if ($_ eq "default") {
		532	$ext_arg{$_} \|\|= [] for qw(selection option-popup selection-popup searchable-scrollback);
		533	} elsif (/^-(.*)$/) {
		534	delete $ext_arg{$1};
		535	} elsif (/^([^<]+)<(.*)>$/) {
		536	push @{ $ext_arg{$1} }, $2;
		537	} else {
		538	$ext_arg{$_} \|\|= [];
		539	}
		540	}
		541
		542	while (my ($ext, $argv) = each %ext_arg) {
486	my @files = grep -f $_, map "$_/$ext", @dirs;	543	my @files = grep -f $_, map "$_/$ext", @dirs;
487		544
488	if (@files) {	545	if (@files) {
489	register_package extension_package $files[0];	546	$TERM->register_package (extension_package $files[0], $argv);
490	} else {	547	} else {
491	warn "perl extension '$ext' not found in perl library search path\n";	548	warn "perl extension '$ext' not found in perl library search path\n";
492	}	549	}
493	}	550	}
		551
		552	eval "#line 1 \"--perl-eval resource/argument\"\n" . $TERM->resource ("perl_eval");
		553	warn $@ if $@;
494	}	554	}
495		555
496	$retval = undef;	556	$retval = undef;
497		557
498	if (my $cb = $TERM->{_hook}[$htype]) {	558	if (my $cb = $TERM->{_hook}[$htype]) {
…		…
500	if $verbosity >= 10;	560	if $verbosity >= 10;
501		561
502	keys %$cb;	562	keys %$cb;
503		563
504	while (my ($pkg, $cb) = each %$cb) {	564	while (my ($pkg, $cb) = each %$cb) {
505	eval {	565	$retval = eval { $cb->($TERM->{_pkg}{$pkg}, @_) }
506	$retval = $cb->(
507	$TERM->{_pkg}{$pkg} \|\|= do {
508	my $proxy = bless { }, $pkg;
509	Scalar::Util::weaken ($proxy->{term} = $TERM);
510	$proxy
511	},
512	@_,
513	) and last;	566	and last;
		567
		568	if ($@) {
		569	$TERM->ungrab; # better to lose the grab than the session
		570	warn $@;
514	};	571	}
515	warn $@ if $@;#d#
516	}	572	}
517	}	573	}
518		574
519	if ($htype == 1) { # DESTROY	575	if ($htype == 1) { # DESTROY
520	# remove hooks if unused
521	if (my $hook = $TERM->{_hook}) {	576	if (my $hook = delete $TERM->{_hook}) {
522	for my $htype (0..$#$hook) {	577	for my $htype (0..$#$hook) {
523	$hook_count[$htype] -= scalar keys %{ $hook->[$htype] \|\| {} }	578	$hook_count[$htype] -= scalar keys %{ $hook->[$htype] \|\| {} }
524	or set_should_invoke $htype, 0;	579	or set_should_invoke $htype, 0;
525	}	580	}
526	}	581	}
…		…
533	}	588	}
534		589
535	$retval	590	$retval
536	}	591	}
537		592
538	sub urxvt::term::proxy::AUTOLOAD {	593	# urxvt::term::proxy
539	$urxvt::term::proxy::AUTOLOAD =~ /:([^:]+)$/	594
		595	package urxvt::term::proxy;
		596
		597	sub enable {
		598	my ($self, %hook) = @_;
		599	my $pkg = $self->{_pkg};
		600
		601	while (my ($name, $cb) = each %hook) {
		602	my $htype = $HOOKTYPE{uc $name};
		603	defined $htype
		604	or Carp::croak "unsupported hook type '$name'";
		605
		606	unless (exists $self->{term}{_hook}[$htype]{$pkg}) {
		607	$hook_count[$htype]++
		608	or urxvt::set_should_invoke $htype, 1;
		609	}
		610
		611	$self->{term}{_hook}[$htype]{$pkg} = $cb;
		612	}
		613	}
		614
		615	sub disable {
		616	my ($self, @hook) = @_;
		617	my $pkg = $self->{_pkg};
		618
		619	for my $name (@hook) {
		620	my $htype = $HOOKTYPE{uc $name};
		621	defined $htype
		622	or Carp::croak "unsupported hook type '$name'";
		623
		624	if (delete $self->{term}{_hook}[$htype]{$pkg}) {
		625	--$hook_count[$htype]
		626	or urxvt::set_should_invoke $htype, 0;
		627	}
		628	}
		629	}
		630
		631	our $AUTOLOAD;
		632
		633	sub AUTOLOAD {
		634	$AUTOLOAD =~ /:([^:]+)$/
540	or die "FATAL: \$AUTOLOAD '$urxvt::term::proxy::AUTOLOAD' unparsable";	635	or die "FATAL: \$AUTOLOAD '$AUTOLOAD' unparsable";
541		636
542	eval qq{	637	eval qq{
543	sub $urxvt::term::proxy::AUTOLOAD {	638	sub $AUTOLOAD {
544	my \$proxy = shift;	639	my \$proxy = shift;
545	\$proxy->{term}->$1 (\@_)	640	\$proxy->{term}->$1 (\@_)
546	}	641	}
547	1	642	1
548	} or die "FATAL: unable to compile method forwarder: $@";	643	} or die "FATAL: unable to compile method forwarder: $@";
549		644
550	goto &$urxvt::term::proxy::AUTOLOAD;	645	goto &$AUTOLOAD;
551	}	646	}
		647
		648	sub DESTROY {
		649	# nop
		650	}
		651
		652	# urxvt::destroy_hook
552		653
553	sub urxvt::destroy_hook::DESTROY {	654	sub urxvt::destroy_hook::DESTROY {
554	${$_[0]}->();	655	${$_[0]}->();
555	}	656	}
556		657
557	sub urxvt::destroy_hook(&) {	658	sub urxvt::destroy_hook(&) {
558	bless \shift, urxvt::destroy_hook::	659	bless \shift, urxvt::destroy_hook::
559	}	660	}
560		661
		662	package urxvt::anyevent;
		663
		664	=head2 The C<urxvt::anyevent> Class
		665
		666	The sole purpose of this class is to deliver an interface to the
		667	C<AnyEvent> module - any module using it will work inside urxvt without
		668	further work. The only exception is that you cannot wait on condition
		669	variables, but non-blocking condvar use is ok. What this means is that you
		670	cannot use blocking APIs, but the non-blocking variant should work.
		671
		672	=cut
		673
		674	our $VERSION = 1;
		675
		676	$INC{"urxvt/anyevent.pm"} = 1; # mark us as there
		677	push @AnyEvent::REGISTRY, [urxvt => urxvt::anyevent::];
		678
		679	sub timer {
		680	my ($class, %arg) = @_;
		681
		682	my $cb = $arg{cb};
		683
		684	urxvt::timer
		685	->new
		686	->start (urxvt::NOW + $arg{after})
		687	->cb (sub {
		688	$_[0]->stop; # need to cancel manually
		689	$cb->();
		690	})
		691	}
		692
		693	sub io {
		694	my ($class, %arg) = @_;
		695
		696	my $cb = $arg{cb};
		697
		698	bless [$arg{fh}, urxvt::iow
		699	->new
		700	->fd (fileno $arg{fh})
		701	->events (($arg{poll} =~ /r/ ? 1 : 0)
		702	\| ($arg{poll} =~ /w/ ? 2 : 0))
		703	->start
		704	->cb (sub {
		705	$cb->(($_[1] & 1 ? 'r' : '')
		706	. ($_[1] & 2 ? 'w' : ''));
		707	})],
		708	urxvt::anyevent::
		709	}
		710
		711	sub DESTROY {
		712	$_[0][1]->stop;
		713	}
		714
		715	sub condvar {
		716	bless \my $flag, urxvt::anyevent::condvar::
		717	}
		718
		719	sub urxvt::anyevent::condvar::broadcast {
		720	${$_[0]}++;
		721	}
		722
		723	sub urxvt::anyevent::condvar::wait {
		724	unless (${$_[0]}) {
		725	Carp::croak "AnyEvent->condvar blocking wait unsupported in urxvt, use a non-blocking API";
		726	}
		727	}
		728
		729	package urxvt::term;
		730
561	=head2 The C<urxvt::term> Class	731	=head2 The C<urxvt::term> Class
562		732
563	=over 4	733	=over 4
564		734
		735	=cut
		736
		737	# find on_xxx subs in the package and register them
		738	# as hooks
		739	sub register_package {
		740	my ($self, $pkg, $argv) = @_;
		741
		742	my $proxy = bless {
		743	_pkg => $pkg,
		744	argv => $argv,
		745	}, $pkg;
		746	Scalar::Util::weaken ($proxy->{term} = $self);
		747
		748	$self->{_pkg}{$pkg} = $proxy;
		749
		750	for my $name (@HOOKNAME) {
		751	if (my $ref = $pkg->can ("on_" . lc $name)) {
		752	$proxy->enable ($name => $ref);
		753	}
		754	}
		755	}
		756
565	=item $term->destroy	757	=item $term->destroy
566		758
567	Destroy the terminal object (close the window, free resources etc.).	759	Destroy the terminal object (close the window, free resources etc.).
		760
		761	=item $isset = $term->option ($optval[, $set])
		762
		763	Returns true if the option specified by C<$optval> is enabled, and
		764	optionally change it. All option values are stored by name in the hash
		765	C<%urxvt::OPTION>. Options not enabled in this binary are not in the hash.
		766
		767	Here is a a likely non-exhaustive list of option names, please see the
		768	source file F</src/optinc.h> to see the actual list:
		769
		770	borderLess console cursorBlink cursorUnderline hold iconic insecure
		771	intensityStyles jumpScroll loginShell mapAlert meta8 mouseWheelScrollPage
		772	pastableTabs pointerBlank reverseVideo scrollBar scrollBar_floating
		773	scrollBar_right scrollTtyKeypress scrollTtyOutput scrollWithBuffer
		774	secondaryScreen secondaryScroll skipBuiltinGlyphs transparent
		775	tripleclickwords utmpInhibit visualBell
568		776
569	=item $value = $term->resource ($name[, $newval])	777	=item $value = $term->resource ($name[, $newval])
570		778
571	Returns the current resource value associated with a given name and	779	Returns the current resource value associated with a given name and
572	optionally sets a new value. Setting values is most useful in the C<init>	780	optionally sets a new value. Setting values is most useful in the C<init>
…		…
582		790
583	Please note that resource strings will currently only be freed when the	791	Please note that resource strings will currently only be freed when the
584	terminal is destroyed, so changing options frequently will eat memory.	792	terminal is destroyed, so changing options frequently will eat memory.
585		793
586	Here is a a likely non-exhaustive list of resource names, not all of which	794	Here is a a likely non-exhaustive list of resource names, not all of which
587	are supported in every build, please see the source to see the actual	795	are supported in every build, please see the source file F</src/rsinc.h>
588	list:	796	to see the actual list:
589		797
590	answerbackstring backgroundPixmap backspace_key boldFont boldItalicFont	798	answerbackstring backgroundPixmap backspace_key boldFont boldItalicFont
591	borderLess color cursorBlink cursorUnderline cutchars delete_key	799	borderLess color cursorBlink cursorUnderline cutchars delete_key
592	display_name embed ext_bwidth fade font geometry hold iconName	800	display_name embed ext_bwidth fade font geometry hold iconName
593	imFont imLocale inputMethod insecure int_bwidth intensityStyles	801	imFont imLocale inputMethod insecure int_bwidth intensityStyles
…		…
600	shade term_name title transparent transparent_all tripleclickwords	808	shade term_name title transparent transparent_all tripleclickwords
601	utmpInhibit visualBell	809	utmpInhibit visualBell
602		810
603	=cut	811	=cut
604		812
605	sub urxvt::term::resource($$;$) {	813	sub resource($$;$) {
606	my ($self, $name) = (shift, shift);	814	my ($self, $name) = (shift, shift);
607	unshift @_, $self, $name, ($name =~ s/\s\+\s(\d+)$// ? $1 : 0);	815	unshift @_, $self, $name, ($name =~ s/\s\+\s(\d+)$// ? $1 : 0);
608	&urxvt::term::_resource	816	&urxvt::term::_resource
609	}	817	}
610		818
		819	=item $success = $term->parse_keysym ($keysym_spec, $command_string)
		820
		821	Adds a keymap translation exactly as specified via a resource. See the
		822	C<keysym> resource in the @@RXVT_NAME@@(1) manpage.
		823
611	=item $rend = $term->rstyle ([$new_rstyle])	824	=item $rend = $term->rstyle ([$new_rstyle])
612		825
613	Return and optionally change the current rendition. Text that is output by	826	Return and optionally change the current rendition. Text that is output by
614	the terminal application will use this style.	827	the terminal application will use this style.
615		828
…		…
634		847
635	=item $oldtext = $term->selection ([$newtext])	848	=item $oldtext = $term->selection ([$newtext])
636		849
637	Return the current selection text and optionally replace it by C<$newtext>.	850	Return the current selection text and optionally replace it by C<$newtext>.
638		851
639	#=item $term->overlay ($x, $y, $text)	852	=item $term->overlay_simple ($x, $y, $text)
640	#	853
641	#Create a simple multi-line overlay box. See the next method for details.	854	Create a simple multi-line overlay box. See the next method for details.
642	#	855
643	#=cut	856	=cut
644	#	857
645	#sub urxvt::term::scr_overlay {	858	sub overlay_simple {
646	# my ($self, $x, $y, $text) = @_;	859	my ($self, $x, $y, $text) = @_;
647	#	860
648	# my @lines = split /\n/, $text;	861	my @lines = split /\n/, $text;
649	#	862
650	# my $w = 0;	863	my $w = List::Util::max map $self->strwidth ($_), @lines;
651	# for (map $self->strwidth ($_), @lines) {	864
652	# $w = $_ if $w < $_;
653	# }
654	#
655	# $self->scr_overlay_new ($x, $y, $w, scalar @lines);	865	my $overlay = $self->overlay ($x, $y, $w, scalar @lines);
656	# $self->scr_overlay_set (0, $_, $lines[$_]) for 0.. $#lines;	866	$overlay->set (0, $_, $lines[$_]) for 0.. $#lines;
657	#}	867
		868	$overlay
		869	}
658		870
659	=item $term->overlay ($x, $y, $width, $height[, $rstyle[, $border]])	871	=item $term->overlay ($x, $y, $width, $height[, $rstyle[, $border]])
660		872
661	Create a new (empty) overlay at the given position with the given	873	Create a new (empty) overlay at the given position with the given
662	width/height. C<$rstyle> defines the initial rendition style	874	width/height. C<$rstyle> defines the initial rendition style
…		…
697	C<$event> I<must> be the event causing the menu to pop up (a button event,	909	C<$event> I<must> be the event causing the menu to pop up (a button event,
698	currently).	910	currently).
699		911
700	=cut	912	=cut
701		913
702	sub urxvt::term::popup {	914	sub popup {
703	my ($self, $event) = @_;	915	my ($self, $event) = @_;
704		916
705	$self->grab ($event->{time}, 1)	917	$self->grab ($event->{time}, 1)
706	or return;	918	or return;
707		919
…		…
729		941
730	=item $string = $term->locale_decode ($octets)	942	=item $string = $term->locale_decode ($octets)
731		943
732	Convert the given locale-encoded octets into a perl string.	944	Convert the given locale-encoded octets into a perl string.
733		945
		946	=item $term->scr_xor_span ($beg_row, $beg_col, $end_row, $end_col[, $rstyle])
		947
		948	XORs the rendition values in the given span with the provided value
		949	(default: C<RS_RVid>). Useful in refresh hooks to provide effects similar
		950	to the selection.
		951
		952	=item $term->scr_xor_rect ($beg_row, $beg_col, $end_row, $end_col[, $rstyle1[, $rstyle2]])
		953
		954	Similar to C<scr_xor_span>, but xors a rectangle instead. Trailing
		955	whitespace will additionally be xored with the C<$rstyle2>, which defaults
		956	to C<RS_RVid \| RS_Uline>, which removes reverse video again and underlines
		957	it instead.
		958
		959	=item $term->scr_bell
		960
		961	Ring the bell!
		962
734	=item $term->scr_add_lines ($string)	963	=item $term->scr_add_lines ($string)
735		964
736	Write the given text string to the screen, as if output by the application	965	Write the given text string to the screen, as if output by the application
737	running inside the terminal. It may not contain command sequences (escape	966	running inside the terminal. It may not contain command sequences (escape
738	codes), but is free to use line feeds, carriage returns and tabs. The	967	codes), but is free to use line feeds, carriage returns and tabs. The
…		…
752		981
753	Write the octets given in C<$data> to the tty (i.e. as program input). To	982	Write the octets given in C<$data> to the tty (i.e. as program input). To
754	pass characters instead of octets, you should convert your strings first	983	pass characters instead of octets, you should convert your strings first
755	to the locale-specific encoding using C<< $term->locale_encode >>.	984	to the locale-specific encoding using C<< $term->locale_encode >>.
756		985
		986	=item $old_events = $term->pty_ev_events ([$new_events])
		987
		988	Replaces the event mask of the pty watcher by the given event mask. Can
		989	be used to suppress input and output handling to the pty/tty. See the
		990	description of C<< urxvt::timer->events >>. Make sure to always restore
		991	the previous value.
		992
757	=item $windowid = $term->parent	993	=item $windowid = $term->parent
758		994
759	Return the window id of the toplevel window.	995	Return the window id of the toplevel window.
760		996
761	=item $windowid = $term->vt	997	=item $windowid = $term->vt
…		…
785	=item $nrow_plus_saveLines = $term->total_rows	1021	=item $nrow_plus_saveLines = $term->total_rows
786		1022
787	=item $lines_in_scrollback = $term->nsaved	1023	=item $lines_in_scrollback = $term->nsaved
788		1024
789	Return various integers describing terminal characteristics.	1025	Return various integers describing terminal characteristics.
		1026
		1027	=item $lc_ctype = $term->locale
		1028
		1029	Returns the LC_CTYPE category string used by this rxvt-unicode.
		1030
		1031	=item $x_display = $term->display_id
		1032
		1033	Return the DISPLAY used by rxvt-unicode.
790		1034
791	=item $modifiermask = $term->ModLevel3Mask	1035	=item $modifiermask = $term->ModLevel3Mask
792		1036
793	=item $modifiermask = $term->ModMetaMask	1037	=item $modifiermask = $term->ModMetaMask
794		1038
…		…
897		1141
898	=back	1142	=back
899		1143
900	=cut	1144	=cut
901		1145
902	sub urxvt::term::line {	1146	sub line {
903	my ($self, $row) = @_;	1147	my ($self, $row) = @_;
904		1148
905	my $maxrow = $self->nrow - 1;	1149	my $maxrow = $self->nrow - 1;
906		1150
907	my ($beg, $end) = ($row, $row);	1151	my ($beg, $end) = ($row, $row);
…		…
971	$offset / $self->{ncol} + $self->{beg},	1215	$offset / $self->{ncol} + $self->{beg},
972	$offset % $self->{ncol}	1216	$offset % $self->{ncol}
973	)	1217	)
974	}	1218	}
975		1219
976	=item ($row, $col) = $line->coord_of ($offset)
977	=item $text = $term->special_encode $string	1220	=item $text = $term->special_encode $string
978		1221
979	Converts a perl string into the special encoding used by rxvt-unicode,	1222	Converts a perl string into the special encoding used by rxvt-unicode,
980	where one character corresponds to one screen cell. See	1223	where one character corresponds to one screen cell. See
981	C<< $term->ROW_t >> for details.	1224	C<< $term->ROW_t >> for details.
…		…
983	=item $string = $term->special_decode $text	1226	=item $string = $term->special_decode $text
984		1227
985	Converts rxvt-unicodes text reprsentation into a perl string. See	1228	Converts rxvt-unicodes text reprsentation into a perl string. See
986	C<< $term->ROW_t >> for details.	1229	C<< $term->ROW_t >> for details.
987		1230
		1231	=item $success = $term->grab_button ($button, $modifiermask)
		1232
		1233	Registers a synchronous button grab. See the XGrabButton manpage.
		1234
		1235	=item $success = $term->grab ($eventtime[, $sync])
		1236
		1237	Calls XGrabPointer and XGrabKeyboard in asynchronous (default) or
		1238	synchronous (C<$sync> is true). Also remembers the grab timestampe.
		1239
		1240	=item $term->allow_events_async
		1241
		1242	Calls XAllowEvents with AsyncBoth for the most recent grab.
		1243
		1244	=item $term->allow_events_sync
		1245
		1246	Calls XAllowEvents with SyncBoth for the most recent grab.
		1247
		1248	=item $term->allow_events_replay
		1249
		1250	Calls XAllowEvents with both ReplayPointer and ReplayKeyboard for the most
		1251	recent grab.
		1252
		1253	=item $term->ungrab
		1254
		1255	Calls XUngrab for the most recent grab. Is called automatically on
		1256	evaluation errors, as it is better to lose the grab in the error case as
		1257	the session.
		1258
988	=back	1259	=back
989		1260
		1261	=cut
		1262
		1263	package urxvt::popup;
		1264
990	=head2 The C<urxvt::popup> Class	1265	=head2 The C<urxvt::popup> Class
991		1266
992	=over 4	1267	=over 4
993		1268
994	=cut	1269	=cut
995
996	package urxvt::popup;
997		1270
998	sub add_item {	1271	sub add_item {
999	my ($self, $item) = @_;	1272	my ($self, $item) = @_;
1000		1273
		1274	$item->{rend}{normal} = "\x1b[0;30;47m" unless exists $item->{rend}{normal};
		1275	$item->{rend}{hover} = "\x1b[0;30;46m" unless exists $item->{rend}{hover};
		1276	$item->{rend}{active} = "\x1b[m" unless exists $item->{rend}{active};
		1277
		1278	$item->{render} \|\|= sub { $_[0]{text} };
		1279
1001	push @{ $self->{item} }, $item;	1280	push @{ $self->{item} }, $item;
		1281	}
		1282
		1283	sub add_separator {
		1284	my ($self, $sep) = @_;
		1285
		1286	$sep \|\|= "=";
		1287
		1288	$self->add_item ({
		1289	rend => { normal => "\x1b[0;30;47m", hover => "\x1b[0;30;47m", active => "\x1b[0;30;47m" },
		1290	text => "",
		1291	render => sub { $sep x $self->{term}->ncol },
		1292	activate => sub { },
		1293	});
		1294	}
		1295
		1296	sub add_title {
		1297	my ($self, $title) = @_;
		1298
		1299	$self->add_item ({
		1300	rend => { normal => "\x1b[38;5;11;44m", hover => "\x1b[38;5;11;44m", active => "\x1b[38;5;11;44m" },
		1301	text => $title,
		1302	activate => sub { },
		1303	});
1002	}	1304	}
1003		1305
1004	sub add_button {	1306	sub add_button {
1005	my ($self, $text, $cb) = @_;	1307	my ($self, $text, $cb) = @_;
1006		1308
1007	$self->add_item ({ type => "button", text => "[ $text ]", activate => $cb,	1309	$self->add_item ({ type => "button", text => $text, activate => $cb});
1008	render => sub { $_[0]{text} },
1009	});
1010	}	1310	}
1011		1311
1012	sub add_toggle {	1312	sub add_toggle {
1013	my ($self, $text, $cb, $value) = @_;	1313	my ($self, $text, $cb, $value) = @_;
1014		1314
1015	$self->add_item ({ type => "button", text => " $text", value => $value,	1315	my $item; $item = {
		1316	type => "button",
		1317	text => " $text",
		1318	value => $value,
1016	render => sub { ($_[0]{value} ? "✔" : " ") . substr $_[0]{text}, 1 },	1319	render => sub { ($_[0]{value} ? "* " : " ") . $text },
1017	activate => sub { $cb->($_[0]{value} = !$_[0]{value}); },	1320	activate => sub { $cb->($_[0]{value} = !$_[0]{value}); },
1018	});	1321	};
		1322
		1323	$self->add_item ($item);
1019	}	1324	}
1020		1325
1021	sub show {	1326	sub show {
1022	my ($self) = @_;	1327	my ($self) = @_;
1023		1328
1024	local $urxvt::popup::self = $self;	1329	local $urxvt::popup::self = $self;
1025		1330
		1331	local $ENV{LC_ALL} = $self->{term}->locale;
		1332
1026	urxvt->new ("--perl-lib" => "", "--perl-ext-common" => "", "-pty-fd" => -1, "-sl" => 0, "-b" => 0,	1333	urxvt->new ("--perl-lib" => "", "--perl-ext-common" => "", "-pty-fd" => -1, "-sl" => 0, "-b" => 0,
1027	"--transient-for" => $self->{term}->parent,	1334	"--transient-for" => $self->{term}->parent,
		1335	"-display" => $self->{term}->display_id,
1028	"-pe" => "urxvt-popup")	1336	"-pe" => "urxvt-popup")
1029	or die "unable to create popup window\n";	1337	or die "unable to create popup window\n";
1030	}	1338	}
1031		1339
1032	sub DESTROY {	1340	sub DESTROY {
1033	my ($self) = @_;	1341	my ($self) = @_;
1034		1342
		1343	delete $self->{term}{_destroy}{$self};
1035	$self->{term}->ungrab;	1344	$self->{term}->ungrab;
1036	}	1345	}
1037		1346
1038	=head2 The C<urxvt::timer> Class	1347	=head2 The C<urxvt::timer> Class
1039		1348
…		…
1094		1403
1095	$term->{socket} = ...	1404	$term->{socket} = ...
1096	$term->{iow} = urxvt::iow	1405	$term->{iow} = urxvt::iow
1097	->new	1406	->new
1098	->fd (fileno $term->{socket})	1407	->fd (fileno $term->{socket})
1099	->events (1) # wait for read data	1408	->events (urxvt::EVENT_READ)
1100	->start	1409	->start
1101	->cb (sub {	1410	->cb (sub {
1102	my ($iow, $revents) = @_;	1411	my ($iow, $revents) = @_;
1103	# $revents must be 1 here, no need to check	1412	# $revents must be 1 here, no need to check
1104	sysread $term->{socket}, my $buf, 8192	1413	sysread $term->{socket}, my $buf, 8192
…		…
1121		1430
1122	Set the filedescriptor (not handle) to watch.	1431	Set the filedescriptor (not handle) to watch.
1123		1432
1124	=item $iow = $iow->events ($eventmask)	1433	=item $iow = $iow->events ($eventmask)
1125		1434
1126	Set the event mask to watch. Bit #0 (value C<1>) enables watching for read	1435	Set the event mask to watch. The only allowed values are
1127	data, Bit #1 (value C<2>) enables watching for write data.	1436	C<urxvt::EVENT_READ> and C<urxvt::EVENT_WRITE>, which might be ORed
		1437	together, or C<urxvt::EVENT_NONE>.
1128		1438
1129	=item $iow = $iow->start	1439	=item $iow = $iow->start
1130		1440
1131	Start watching for requested events on the given handle.	1441	Start watching for requested events on the given handle.
1132		1442
…		…
1143	This variable controls the verbosity level of the perl extension. Higher	1453	This variable controls the verbosity level of the perl extension. Higher
1144	numbers indicate more verbose output.	1454	numbers indicate more verbose output.
1145		1455
1146	=over 4	1456	=over 4
1147		1457
1148	=item =0 - only fatal messages	1458	=item == 0 - fatal messages
1149		1459
1150	=item =3 - script loading and management	1460	=item >= 3 - script loading and management
1151		1461
1152	=item =10 - all events received	1462	=item >=10 - all events received
1153		1463
1154	=back	1464	=back
1155		1465
1156	=head1 AUTHOR	1466	=head1 AUTHOR
1157		1467

Diff Legend

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

Comparing rxvt-unicode/src/urxvt.pm (file contents): Revision 1.48 by root, Sat Jan 7 21:43:17 2006 UTC vs. Revision 1.70 by root, Mon Jan 9 23:00:07 2006 UTC

Diff Legend

Comparing rxvt-unicode/src/urxvt.pm (file contents):
Revision 1.48 by root, Sat Jan 7 21:43:17 2006 UTC vs.
Revision 1.70 by root, Mon Jan 9 23:00:07 2006 UTC