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

Comparing rxvt-unicode/src/urxvt.pm (file contents):
Revision 1.67 by root, Mon Jan 9 19:29:06 2006 UTC vs.
Revision 1.71 by root, Mon Jan 9 23:18:49 2006 UTC

…		…
65		65
66	=item selection-popup (enabled by default)	66	=item selection-popup (enabled by default)
67		67
68	Binds a popup menu to Ctrl-Button3 that lets you convert the selection	68	Binds a popup menu to Ctrl-Button3 that lets you convert the selection
69	text into various other formats/action.	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.
70		78
71	=item digital-clock	79	=item digital-clock
72		80
73	Displays a digital clock using the built-in overlay.	81	Displays a digital clock using the built-in overlay.
74		82
…		…
124	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
125	locale-specific way.	133	locale-specific way.
126		134
127	=back	135	=back
128		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
129	=head2 Hooks	170	=head2 Hooks
130		171
131	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
132	called whenever the relevant event happens.	173	called whenever the relevant event happens.
133		174
134	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
135	and extension package. You can call all C<urxvt::term> methods on it, but	176	the in the C<Extension Objects> section.
136	its not a real C<urxvt::term> object. Instead, the real C<urxvt::term>
137	object that is shared between all packages is stored in the C<term>
138	member. It is, however, blessed intot he package of the extension script,
139	so for all practical purposes you can treat an extension script as a class.
140		177
141	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
142	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
143	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.
144		181
145	When in doubt, return a false value (preferably C<()>).	182	I<< When in doubt, return a false value (preferably C<()>). >>
146		183
147	=over 4	184	=over 4
148		185
149	=item on_init $term	186	=item on_init $term
150		187
…		…
267	=item on_focus_out $term	304	=item on_focus_out $term
268		305
269	Called wheneever the window loses keyboard focus, before rxvt-unicode does	306	Called wheneever the window loses keyboard focus, before rxvt-unicode does
270	focus out processing.	307	focus out processing.
271		308
272	=item on_key_press $term, $event, $octets	309	=item on_key_press $term, $event, $keysym, $octets
273		310
274	=item on_key_release $term, $event	311	=item on_key_release $term, $event, $keysym
275		312
276	=item on_button_press $term, $event	313	=item on_button_press $term, $event
277		314
278	=item on_button_release $term, $event	315	=item on_button_release $term, $event
279		316
…		…
411		448
412	package urxvt;	449	package urxvt;
413		450
414	use utf8;	451	use utf8;
415	use strict;	452	use strict;
		453	use Carp ();
416	use Scalar::Util ();	454	use Scalar::Util ();
417	use List::Util ();	455	use List::Util ();
418		456
419	our $VERSION = 1;	457	our $VERSION = 1;
420	our $TERM;	458	our $TERM;
421	our @HOOKNAME;	459	our @HOOKNAME;
		460	our %HOOKTYPE = map +($HOOKNAME[$_] => $_), 0..$#HOOKNAME;
422	our %OPTION;	461	our %OPTION;
423	our $LIBDIR;	462	our $LIBDIR;
424		463
425	BEGIN {	464	BEGIN {
426	urxvt->bootstrap;	465	urxvt->bootstrap;
…		…
445	sub verbose {	484	sub verbose {
446	my ($level, $msg) = @_;	485	my ($level, $msg) = @_;
447	warn "$msg\n" if $level <= $verbosity;	486	warn "$msg\n" if $level <= $verbosity;
448	}	487	}
449		488
450	# find on_xxx subs in the package and register them
451	# as hooks
452	sub register_package($) {
453	my ($pkg) = @_;
454
455	for my $htype (0.. $#HOOKNAME) {
456	my $name = $HOOKNAME[$htype];
457
458	my $ref = $pkg->can ("on_" . lc $name)
459	or next;
460
461	$TERM->{_hook}[$htype]{$pkg} = $ref;
462	$hook_count[$htype]++
463	or set_should_invoke $htype, 1;
464	}
465	}
466
467	my $extension_pkg = "extension0000";	489	my $extension_pkg = "extension0000";
468	my %extension_pkg;	490	my %extension_pkg;
469		491
470	# load a single script into its own package, once only	492	# load a single script into its own package, once only
471	sub extension_package($) {	493	sub extension_package($) {
…		…
477	verbose 3, "loading extension '$path' into package '$pkg'";	499	verbose 3, "loading extension '$path' into package '$pkg'";
478		500
479	open my $fh, "<:raw", $path	501	open my $fh, "<:raw", $path
480	or die "$path: $!";	502	or die "$path: $!";
481		503
		504	my $source = untaint
482	my $source = untaint "package $pkg; use strict; use utf8;\n"	505	"package $pkg; use strict; use utf8;\n"
483	. "use base urxvt::term::proxy::;\n"	506	. "use base urxvt::term::extension::;\n"
484	. "#line 1 \"$path\"\n{\n"	507	. "#line 1 \"$path\"\n{\n"
485	. (do { local $/; <$fh> })	508	. (do { local $/; <$fh> })
486	. "\n};\n1";	509	. "\n};\n1";
487		510
		511	eval $source
488	eval $source or die "$path: $@";	512	or die "$path: $@";
489		513
490	$pkg	514	$pkg
491	}	515	}
492	}	516	}
493		517
…		…
499	my $htype = shift;	523	my $htype = shift;
500		524
501	if ($htype == 0) { # INIT	525	if ($htype == 0) { # INIT
502	my @dirs = ((split /:/, $TERM->resource ("perl_lib")), "$LIBDIR/perl");	526	my @dirs = ((split /:/, $TERM->resource ("perl_lib")), "$LIBDIR/perl");
503		527
504	my %want_ext;	528	my %ext_arg;
505		529
506	for (map { split /,/, $TERM->resource ("perl_ext_$_") } 1, 2) {	530	for (map { split /,/, $TERM->resource ("perl_ext_$_") } 1, 2) {
507	if ($_ eq "default") {	531	if ($_ eq "default") {
508	$want_ext{$_}++ for qw(selection option-popup selection-popup);	532	$ext_arg{$_} \|\|= [] for qw(selection option-popup selection-popup searchable-scrollback);
509	} elsif (/^-(.*)$/) {	533	} elsif (/^-(.*)$/) {
510	delete $want_ext{$1};	534	delete $ext_arg{$1};
		535	} elsif (/^([^<]+)<(.*)>$/) {
		536	push @{ $ext_arg{$1} }, $2;
511	} else {	537	} else {
512	$want_ext{$_}++;	538	$ext_arg{$_} \|\|= [];
513	}	539	}
514	}	540	}
515		541
516	for my $ext (keys %want_ext) {	542	while (my ($ext, $argv) = each %ext_arg) {
517	my @files = grep -f $_, map "$_/$ext", @dirs;	543	my @files = grep -f $_, map "$_/$ext", @dirs;
518		544
519	if (@files) {	545	if (@files) {
520	register_package extension_package $files[0];	546	$TERM->register_package (extension_package $files[0], $argv);
521	} else {	547	} else {
522	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";
523	}	549	}
524	}	550	}
525		551
…		…
534	if $verbosity >= 10;	560	if $verbosity >= 10;
535		561
536	keys %$cb;	562	keys %$cb;
537		563
538	while (my ($pkg, $cb) = each %$cb) {	564	while (my ($pkg, $cb) = each %$cb) {
539	eval {	565	$retval = eval { $cb->($TERM->{_pkg}{$pkg}, @_) }
540	$retval = $cb->(
541	$TERM->{_pkg}{$pkg} \|\|= do {
542	my $proxy = bless { }, $pkg;
543	Scalar::Util::weaken ($proxy->{term} = $TERM);
544	$proxy
545	},
546	@_,
547	) and last;	566	and last;
548	};	567
549	if ($@) {	568	if ($@) {
550	$TERM->ungrab; # better to lose the grab than the session	569	$TERM->ungrab; # better to lose the grab than the session
551	warn $@;	570	warn $@;
552	}	571	}
553	}	572	}
554	}	573	}
555		574
556	if ($htype == 1) { # DESTROY	575	if ($htype == 1) { # DESTROY
557	# remove hooks if unused
558	if (my $hook = $TERM->{_hook}) {	576	if (my $hook = delete $TERM->{_hook}) {
559	for my $htype (0..$#$hook) {	577	for my $htype (0..$#$hook) {
560	$hook_count[$htype] -= scalar keys %{ $hook->[$htype] \|\| {} }	578	$hook_count[$htype] -= scalar keys %{ $hook->[$htype] \|\| {} }
561	or set_should_invoke $htype, 0;	579	or set_should_invoke $htype, 0;
562	}	580	}
563	}	581	}
…		…
570	}	588	}
571		589
572	$retval	590	$retval
573	}	591	}
574		592
575	# urxvt::term::proxy	593	# urxvt::term::extension
576		594
577	sub urxvt::term::proxy::AUTOLOAD {	595	package urxvt::term::extension;
578	$urxvt::term::proxy::AUTOLOAD =~ /:([^:]+)$/	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 =~ /:([^:]+)$/
579	or die "FATAL: \$AUTOLOAD '$urxvt::term::proxy::AUTOLOAD' unparsable";	635	or die "FATAL: \$AUTOLOAD '$AUTOLOAD' unparsable";
580		636
581	eval qq{	637	eval qq{
582	sub $urxvt::term::proxy::AUTOLOAD {	638	sub $AUTOLOAD {
583	my \$proxy = shift;	639	my \$proxy = shift;
584	\$proxy->{term}->$1 (\@_)	640	\$proxy->{term}->$1 (\@_)
585	}	641	}
586	1	642	1
587	} or die "FATAL: unable to compile method forwarder: $@";	643	} or die "FATAL: unable to compile method forwarder: $@";
588		644
589	goto &$urxvt::term::proxy::AUTOLOAD;	645	goto &$AUTOLOAD;
590	}	646	}
591		647
592	sub urxvt::term::proxy::DESTROY {	648	sub DESTROY {
593	# nop	649	# nop
594	}	650	}
595		651
596	# urxvt::destroy_hook	652	# urxvt::destroy_hook
597		653
…		…
664	${$_[0]}++;	720	${$_[0]}++;
665	}	721	}
666		722
667	sub urxvt::anyevent::condvar::wait {	723	sub urxvt::anyevent::condvar::wait {
668	unless (${$_[0]}) {	724	unless (${$_[0]}) {
669	require Carp;
670	Carp::croak ("AnyEvent->condvar blocking wait unsupported in urxvt, use a non-blocking API");	725	Carp::croak "AnyEvent->condvar blocking wait unsupported in urxvt, use a non-blocking API";
671	}	726	}
672	}	727	}
673		728
674	package urxvt::term;	729	package urxvt::term;
675		730
676	=head2 The C<urxvt::term> Class	731	=head2 The C<urxvt::term> Class
677		732
678	=over 4	733	=over 4
		734
		735	=cut
		736
		737	# find on_xxx subs in the package and register them
		738	# as hooks
		739	sub register_package {
		740	my ($self, $pkg, $argv) = @_;
		741
		742	my $proxy = bless {
		743	_pkg => $pkg,
		744	argv => $argv,
		745	}, $pkg;
		746	Scalar::Util::weaken ($proxy->{term} = $self);
		747
		748	$self->{_pkg}{$pkg} = $proxy;
		749
		750	for my $name (@HOOKNAME) {
		751	if (my $ref = $pkg->can ("on_" . lc $name)) {
		752	$proxy->enable ($name => $ref);
		753	}
		754	}
		755	}
679		756
680	=item $term->destroy	757	=item $term->destroy
681		758
682	Destroy the terminal object (close the window, free resources etc.).	759	Destroy the terminal object (close the window, free resources etc.).
683		760
…		…
737	my ($self, $name) = (shift, shift);	814	my ($self, $name) = (shift, shift);
738	unshift @_, $self, $name, ($name =~ s/\s\+\s(\d+)$// ? $1 : 0);	815	unshift @_, $self, $name, ($name =~ s/\s\+\s(\d+)$// ? $1 : 0);
739	&urxvt::term::_resource	816	&urxvt::term::_resource
740	}	817	}
741		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
742	=item $rend = $term->rstyle ([$new_rstyle])	824	=item $rend = $term->rstyle ([$new_rstyle])
743		825
744	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
745	the terminal application will use this style.	827	the terminal application will use this style.
746		828
…		…
765		847
766	=item $oldtext = $term->selection ([$newtext])	848	=item $oldtext = $term->selection ([$newtext])
767		849
768	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>.
769		851
770	#=item $term->overlay ($x, $y, $text)	852	=item $term->overlay_simple ($x, $y, $text)
771	#	853
772	#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.
773	#	855
774	#=cut	856	=cut
775	#	857
776	#sub urxvt::term::scr_overlay {	858	sub overlay_simple {
777	# my ($self, $x, $y, $text) = @_;	859	my ($self, $x, $y, $text) = @_;
778	#	860
779	# my @lines = split /\n/, $text;	861	my @lines = split /\n/, $text;
780	#	862
781	# my $w = 0;	863	my $w = List::Util::max map $self->strwidth ($_), @lines;
782	# for (map $self->strwidth ($_), @lines) {	864
783	# $w = $_ if $w < $_;
784	# }
785	#
786	# $self->scr_overlay_new ($x, $y, $w, scalar @lines);	865	my $overlay = $self->overlay ($x, $y, $w, scalar @lines);
787	# $self->scr_overlay_set (0, $_, $lines[$_]) for 0.. $#lines;	866	$overlay->set (0, $_, $lines[$_]) for 0.. $#lines;
788	#}	867
		868	$overlay
		869	}
789		870
790	=item $term->overlay ($x, $y, $width, $height[, $rstyle[, $border]])	871	=item $term->overlay ($x, $y, $width, $height[, $rstyle[, $border]])
791		872
792	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
793	width/height. C<$rstyle> defines the initial rendition style	874	width/height. C<$rstyle> defines the initial rendition style
…		…
860		941
861	=item $string = $term->locale_decode ($octets)	942	=item $string = $term->locale_decode ($octets)
862		943
863	Convert the given locale-encoded octets into a perl string.	944	Convert the given locale-encoded octets into a perl string.
864		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
865	=item $term->scr_add_lines ($string)	963	=item $term->scr_add_lines ($string)
866		964
867	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
868	running inside the terminal. It may not contain command sequences (escape	966	running inside the terminal. It may not contain command sequences (escape
869	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
…		…
882	=item $term->tt_write ($octets)	980	=item $term->tt_write ($octets)
883		981
884	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
885	pass characters instead of octets, you should convert your strings first	983	pass characters instead of octets, you should convert your strings first
886	to the locale-specific encoding using C<< $term->locale_encode >>.	984	to the locale-specific encoding using C<< $term->locale_encode >>.
		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.
887		992
888	=item $windowid = $term->parent	993	=item $windowid = $term->parent
889		994
890	Return the window id of the toplevel window.	995	Return the window id of the toplevel window.
891		996
…		…
1298		1403
1299	$term->{socket} = ...	1404	$term->{socket} = ...
1300	$term->{iow} = urxvt::iow	1405	$term->{iow} = urxvt::iow
1301	->new	1406	->new
1302	->fd (fileno $term->{socket})	1407	->fd (fileno $term->{socket})
1303	->events (1) # wait for read data	1408	->events (urxvt::EVENT_READ)
1304	->start	1409	->start
1305	->cb (sub {	1410	->cb (sub {
1306	my ($iow, $revents) = @_;	1411	my ($iow, $revents) = @_;
1307	# $revents must be 1 here, no need to check	1412	# $revents must be 1 here, no need to check
1308	sysread $term->{socket}, my $buf, 8192	1413	sysread $term->{socket}, my $buf, 8192
…		…
1325		1430
1326	Set the filedescriptor (not handle) to watch.	1431	Set the filedescriptor (not handle) to watch.
1327		1432
1328	=item $iow = $iow->events ($eventmask)	1433	=item $iow = $iow->events ($eventmask)
1329		1434
1330	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
1331	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>.
1332		1438
1333	=item $iow = $iow->start	1439	=item $iow = $iow->start
1334		1440
1335	Start watching for requested events on the given handle.	1441	Start watching for requested events on the given handle.
1336		1442

Diff Legend

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

Comparing rxvt-unicode/src/urxvt.pm (file contents): Revision 1.67 by root, Mon Jan 9 19:29:06 2006 UTC vs. Revision 1.71 by root, Mon Jan 9 23:18:49 2006 UTC

Diff Legend

Comparing rxvt-unicode/src/urxvt.pm (file contents):
Revision 1.67 by root, Mon Jan 9 19:29:06 2006 UTC vs.
Revision 1.71 by root, Mon Jan 9 23:18:49 2006 UTC