[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.73 by root, Tue Jan 10 04:23:39 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
…		…
226	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
227	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
228	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
229	output.	266	output.
230		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
231	=item on_line_update $term, $row	273	=item on_line_update $term, $row
232		274
233	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
234	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
235	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,
…		…
267	=item on_focus_out $term	309	=item on_focus_out $term
268		310
269	Called wheneever the window loses keyboard focus, before rxvt-unicode does	311	Called wheneever the window loses keyboard focus, before rxvt-unicode does
270	focus out processing.	312	focus out processing.
271		313
272	=item on_key_press $term, $event, $octets	314	=item on_key_press $term, $event, $keysym, $octets
273		315
274	=item on_key_release $term, $event	316	=item on_key_release $term, $event, $keysym
275		317
276	=item on_button_press $term, $event	318	=item on_button_press $term, $event
277		319
278	=item on_button_release $term, $event	320	=item on_button_release $term, $event
279		321
…		…
411		453
412	package urxvt;	454	package urxvt;
413		455
414	use utf8;	456	use utf8;
415	use strict;	457	use strict;
		458	use Carp ();
416	use Scalar::Util ();	459	use Scalar::Util ();
417	use List::Util ();	460	use List::Util ();
418		461
419	our $VERSION = 1;	462	our $VERSION = 1;
420	our $TERM;	463	our $TERM;
421	our @HOOKNAME;	464	our @HOOKNAME;
		465	our %HOOKTYPE = map +($HOOKNAME[$_] => $_), 0..$#HOOKNAME;
422	our %OPTION;	466	our %OPTION;
		467
423	our $LIBDIR;	468	our $LIBDIR;
		469	our $RESNAME;
		470	our $RESCLASS;
		471	our $RXVTNAME;
424		472
425	BEGIN {	473	BEGIN {
426	urxvt->bootstrap;	474	urxvt->bootstrap;
427		475
428	# overwrite perl's warn	476	# overwrite perl's warn
…		…
445	sub verbose {	493	sub verbose {
446	my ($level, $msg) = @_;	494	my ($level, $msg) = @_;
447	warn "$msg\n" if $level <= $verbosity;	495	warn "$msg\n" if $level <= $verbosity;
448	}	496	}
449		497
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";	498	my $extension_pkg = "extension0000";
468	my %extension_pkg;	499	my %extension_pkg;
469		500
470	# load a single script into its own package, once only	501	# load a single script into its own package, once only
471	sub extension_package($) {	502	sub extension_package($) {
…		…
477	verbose 3, "loading extension '$path' into package '$pkg'";	508	verbose 3, "loading extension '$path' into package '$pkg'";
478		509
479	open my $fh, "<:raw", $path	510	open my $fh, "<:raw", $path
480	or die "$path: $!";	511	or die "$path: $!";
481		512
		513	my $source = untaint
482	my $source = untaint "package $pkg; use strict; use utf8;\n"	514	"package $pkg; use strict; use utf8;\n"
483	. "use base urxvt::term::proxy::;\n"	515	. "use base urxvt::term::extension::;\n"
484	. "#line 1 \"$path\"\n{\n"	516	. "#line 1 \"$path\"\n{\n"
485	. (do { local $/; <$fh> })	517	. (do { local $/; <$fh> })
486	. "\n};\n1";	518	. "\n};\n1";
487		519
		520	eval $source
488	eval $source or die "$path: $@";	521	or die "$path: $@";
489		522
490	$pkg	523	$pkg
491	}	524	}
492	}	525	}
493		526
…		…
499	my $htype = shift;	532	my $htype = shift;
500		533
501	if ($htype == 0) { # INIT	534	if ($htype == 0) { # INIT
502	my @dirs = ((split /:/, $TERM->resource ("perl_lib")), "$LIBDIR/perl");	535	my @dirs = ((split /:/, $TERM->resource ("perl_lib")), "$LIBDIR/perl");
503		536
504	my %want_ext;	537	my %ext_arg;
505		538
506	for (map { split /,/, $TERM->resource ("perl_ext_$_") } 1, 2) {	539	for (map { split /,/, $TERM->resource ("perl_ext_$_") } 1, 2) {
507	if ($_ eq "default") {	540	if ($_ eq "default") {
508	$want_ext{$_}++ for qw(selection option-popup selection-popup);	541	$ext_arg{$_} \|\|= [] for qw(selection option-popup selection-popup searchable-scrollback);
509	} elsif (/^-(.*)$/) {	542	} elsif (/^-(.*)$/) {
510	delete $want_ext{$1};	543	delete $ext_arg{$1};
		544	} elsif (/^([^<]+)<(.*)>$/) {
		545	push @{ $ext_arg{$1} }, $2;
511	} else {	546	} else {
512	$want_ext{$_}++;	547	$ext_arg{$_} \|\|= [];
513	}	548	}
514	}	549	}
515		550
516	for my $ext (keys %want_ext) {	551	while (my ($ext, $argv) = each %ext_arg) {
517	my @files = grep -f $_, map "$_/$ext", @dirs;	552	my @files = grep -f $_, map "$_/$ext", @dirs;
518		553
519	if (@files) {	554	if (@files) {
520	register_package extension_package $files[0];	555	$TERM->register_package (extension_package $files[0], $argv);
521	} else {	556	} else {
522	warn "perl extension '$ext' not found in perl library search path\n";	557	warn "perl extension '$ext' not found in perl library search path\n";
523	}	558	}
524	}	559	}
525		560
…		…
534	if $verbosity >= 10;	569	if $verbosity >= 10;
535		570
536	keys %$cb;	571	keys %$cb;
537		572
538	while (my ($pkg, $cb) = each %$cb) {	573	while (my ($pkg, $cb) = each %$cb) {
539	eval {	574	$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;	575	and last;
548	};	576
549	if ($@) {	577	if ($@) {
550	$TERM->ungrab; # better to lose the grab than the session	578	$TERM->ungrab; # better to lose the grab than the session
551	warn $@;	579	warn $@;
552	}	580	}
553	}	581	}
554	}	582	}
555		583
556	if ($htype == 1) { # DESTROY	584	if ($htype == 1) { # DESTROY
557	# remove hooks if unused
558	if (my $hook = $TERM->{_hook}) {	585	if (my $hook = delete $TERM->{_hook}) {
559	for my $htype (0..$#$hook) {	586	for my $htype (0..$#$hook) {
560	$hook_count[$htype] -= scalar keys %{ $hook->[$htype] \|\| {} }	587	$hook_count[$htype] -= scalar keys %{ $hook->[$htype] \|\| {} }
561	or set_should_invoke $htype, 0;	588	or set_should_invoke $htype, 0;
562	}	589	}
563	}	590	}
…		…
570	}	597	}
571		598
572	$retval	599	$retval
573	}	600	}
574		601
575	# urxvt::term::proxy	602	# urxvt::term::extension
576		603
577	sub urxvt::term::proxy::AUTOLOAD {	604	package urxvt::term::extension;
578	$urxvt::term::proxy::AUTOLOAD =~ /:([^:]+)$/	605
		606	sub enable {
		607	my ($self, %hook) = @_;
		608	my $pkg = $self->{_pkg};
		609
		610	while (my ($name, $cb) = each %hook) {
		611	my $htype = $HOOKTYPE{uc $name};
		612	defined $htype
		613	or Carp::croak "unsupported hook type '$name'";
		614
		615	unless (exists $self->{term}{_hook}[$htype]{$pkg}) {
		616	$hook_count[$htype]++
		617	or urxvt::set_should_invoke $htype, 1;
		618	}
		619
		620	$self->{term}{_hook}[$htype]{$pkg} = $cb;
		621	}
		622	}
		623
		624	sub disable {
		625	my ($self, @hook) = @_;
		626	my $pkg = $self->{_pkg};
		627
		628	for my $name (@hook) {
		629	my $htype = $HOOKTYPE{uc $name};
		630	defined $htype
		631	or Carp::croak "unsupported hook type '$name'";
		632
		633	if (delete $self->{term}{_hook}[$htype]{$pkg}) {
		634	--$hook_count[$htype]
		635	or urxvt::set_should_invoke $htype, 0;
		636	}
		637	}
		638	}
		639
		640	our $AUTOLOAD;
		641
		642	sub AUTOLOAD {
		643	$AUTOLOAD =~ /:([^:]+)$/
579	or die "FATAL: \$AUTOLOAD '$urxvt::term::proxy::AUTOLOAD' unparsable";	644	or die "FATAL: \$AUTOLOAD '$AUTOLOAD' unparsable";
580		645
581	eval qq{	646	eval qq{
582	sub $urxvt::term::proxy::AUTOLOAD {	647	sub $AUTOLOAD {
583	my \$proxy = shift;	648	my \$proxy = shift;
584	\$proxy->{term}->$1 (\@_)	649	\$proxy->{term}->$1 (\@_)
585	}	650	}
586	1	651	1
587	} or die "FATAL: unable to compile method forwarder: $@";	652	} or die "FATAL: unable to compile method forwarder: $@";
588		653
589	goto &$urxvt::term::proxy::AUTOLOAD;	654	goto &$AUTOLOAD;
590	}	655	}
591		656
592	sub urxvt::term::proxy::DESTROY {	657	sub DESTROY {
593	# nop	658	# nop
594	}	659	}
595		660
596	# urxvt::destroy_hook	661	# urxvt::destroy_hook
597		662
…		…
664	${$_[0]}++;	729	${$_[0]}++;
665	}	730	}
666		731
667	sub urxvt::anyevent::condvar::wait {	732	sub urxvt::anyevent::condvar::wait {
668	unless (${$_[0]}) {	733	unless (${$_[0]}) {
669	require Carp;
670	Carp::croak ("AnyEvent->condvar blocking wait unsupported in urxvt, use a non-blocking API");	734	Carp::croak "AnyEvent->condvar blocking wait unsupported in urxvt, use a non-blocking API";
671	}	735	}
672	}	736	}
673		737
674	package urxvt::term;	738	package urxvt::term;
675		739
676	=head2 The C<urxvt::term> Class	740	=head2 The C<urxvt::term> Class
677		741
678	=over 4	742	=over 4
		743
		744	=cut
		745
		746	# find on_xxx subs in the package and register them
		747	# as hooks
		748	sub register_package {
		749	my ($self, $pkg, $argv) = @_;
		750
		751	my $proxy = bless {
		752	_pkg => $pkg,
		753	argv => $argv,
		754	}, $pkg;
		755	Scalar::Util::weaken ($proxy->{term} = $self);
		756
		757	$self->{_pkg}{$pkg} = $proxy;
		758
		759	for my $name (@HOOKNAME) {
		760	if (my $ref = $pkg->can ("on_" . lc $name)) {
		761	$proxy->enable ($name => $ref);
		762	}
		763	}
		764	}
679		765
680	=item $term->destroy	766	=item $term->destroy
681		767
682	Destroy the terminal object (close the window, free resources etc.).	768	Destroy the terminal object (close the window, free resources etc.).
683		769
…		…
737	my ($self, $name) = (shift, shift);	823	my ($self, $name) = (shift, shift);
738	unshift @_, $self, $name, ($name =~ s/\s\+\s(\d+)$// ? $1 : 0);	824	unshift @_, $self, $name, ($name =~ s/\s\+\s(\d+)$// ? $1 : 0);
739	&urxvt::term::_resource	825	&urxvt::term::_resource
740	}	826	}
741		827
		828	=item $success = $term->parse_keysym ($keysym_spec, $command_string)
		829
		830	Adds a keymap translation exactly as specified via a resource. See the
		831	C<keysym> resource in the @@RXVT_NAME@@(1) manpage.
		832
742	=item $rend = $term->rstyle ([$new_rstyle])	833	=item $rend = $term->rstyle ([$new_rstyle])
743		834
744	Return and optionally change the current rendition. Text that is output by	835	Return and optionally change the current rendition. Text that is output by
745	the terminal application will use this style.	836	the terminal application will use this style.
746		837
…		…
765		856
766	=item $oldtext = $term->selection ([$newtext])	857	=item $oldtext = $term->selection ([$newtext])
767		858
768	Return the current selection text and optionally replace it by C<$newtext>.	859	Return the current selection text and optionally replace it by C<$newtext>.
769		860
770	#=item $term->overlay ($x, $y, $text)	861	=item $term->overlay_simple ($x, $y, $text)
771	#	862
772	#Create a simple multi-line overlay box. See the next method for details.	863	Create a simple multi-line overlay box. See the next method for details.
773	#	864
774	#=cut	865	=cut
775	#	866
776	#sub urxvt::term::scr_overlay {	867	sub overlay_simple {
777	# my ($self, $x, $y, $text) = @_;	868	my ($self, $x, $y, $text) = @_;
778	#	869
779	# my @lines = split /\n/, $text;	870	my @lines = split /\n/, $text;
780	#	871
781	# my $w = 0;	872	my $w = List::Util::max map $self->strwidth ($_), @lines;
782	# for (map $self->strwidth ($_), @lines) {	873
783	# $w = $_ if $w < $_;
784	# }
785	#
786	# $self->scr_overlay_new ($x, $y, $w, scalar @lines);	874	my $overlay = $self->overlay ($x, $y, $w, scalar @lines);
787	# $self->scr_overlay_set (0, $_, $lines[$_]) for 0.. $#lines;	875	$overlay->set (0, $_, $lines[$_]) for 0.. $#lines;
788	#}	876
		877	$overlay
		878	}
789		879
790	=item $term->overlay ($x, $y, $width, $height[, $rstyle[, $border]])	880	=item $term->overlay ($x, $y, $width, $height[, $rstyle[, $border]])
791		881
792	Create a new (empty) overlay at the given position with the given	882	Create a new (empty) overlay at the given position with the given
793	width/height. C<$rstyle> defines the initial rendition style	883	width/height. C<$rstyle> defines the initial rendition style
…		…
860		950
861	=item $string = $term->locale_decode ($octets)	951	=item $string = $term->locale_decode ($octets)
862		952
863	Convert the given locale-encoded octets into a perl string.	953	Convert the given locale-encoded octets into a perl string.
864		954
		955	=item $term->scr_xor_span ($beg_row, $beg_col, $end_row, $end_col[, $rstyle])
		956
		957	XORs the rendition values in the given span with the provided value
		958	(default: C<RS_RVid>). Useful in refresh hooks to provide effects similar
		959	to the selection.
		960
		961	=item $term->scr_xor_rect ($beg_row, $beg_col, $end_row, $end_col[, $rstyle1[, $rstyle2]])
		962
		963	Similar to C<scr_xor_span>, but xors a rectangle instead. Trailing
		964	whitespace will additionally be xored with the C<$rstyle2>, which defaults
		965	to C<RS_RVid \| RS_Uline>, which removes reverse video again and underlines
		966	it instead.
		967
		968	=item $term->scr_bell
		969
		970	Ring the bell!
		971
865	=item $term->scr_add_lines ($string)	972	=item $term->scr_add_lines ($string)
866		973
867	Write the given text string to the screen, as if output by the application	974	Write the given text string to the screen, as if output by the application
868	running inside the terminal. It may not contain command sequences (escape	975	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	976	codes), but is free to use line feeds, carriage returns and tabs. The
…		…
882	=item $term->tt_write ($octets)	989	=item $term->tt_write ($octets)
883		990
884	Write the octets given in C<$data> to the tty (i.e. as program input). To	991	Write the octets given in C<$data> to the tty (i.e. as program input). To
885	pass characters instead of octets, you should convert your strings first	992	pass characters instead of octets, you should convert your strings first
886	to the locale-specific encoding using C<< $term->locale_encode >>.	993	to the locale-specific encoding using C<< $term->locale_encode >>.
		994
		995	=item $old_events = $term->pty_ev_events ([$new_events])
		996
		997	Replaces the event mask of the pty watcher by the given event mask. Can
		998	be used to suppress input and output handling to the pty/tty. See the
		999	description of C<< urxvt::timer->events >>. Make sure to always restore
		1000	the previous value.
887		1001
888	=item $windowid = $term->parent	1002	=item $windowid = $term->parent
889		1003
890	Return the window id of the toplevel window.	1004	Return the window id of the toplevel window.
891		1005
…		…
1298		1412
1299	$term->{socket} = ...	1413	$term->{socket} = ...
1300	$term->{iow} = urxvt::iow	1414	$term->{iow} = urxvt::iow
1301	->new	1415	->new
1302	->fd (fileno $term->{socket})	1416	->fd (fileno $term->{socket})
1303	->events (1) # wait for read data	1417	->events (urxvt::EVENT_READ)
1304	->start	1418	->start
1305	->cb (sub {	1419	->cb (sub {
1306	my ($iow, $revents) = @_;	1420	my ($iow, $revents) = @_;
1307	# $revents must be 1 here, no need to check	1421	# $revents must be 1 here, no need to check
1308	sysread $term->{socket}, my $buf, 8192	1422	sysread $term->{socket}, my $buf, 8192
…		…
1325		1439
1326	Set the filedescriptor (not handle) to watch.	1440	Set the filedescriptor (not handle) to watch.
1327		1441
1328	=item $iow = $iow->events ($eventmask)	1442	=item $iow = $iow->events ($eventmask)
1329		1443
1330	Set the event mask to watch. Bit #0 (value C<1>) enables watching for read	1444	Set the event mask to watch. The only allowed values are
1331	data, Bit #1 (value C<2>) enables watching for write data.	1445	C<urxvt::EVENT_READ> and C<urxvt::EVENT_WRITE>, which might be ORed
		1446	together, or C<urxvt::EVENT_NONE>.
1332		1447
1333	=item $iow = $iow->start	1448	=item $iow = $iow->start
1334		1449
1335	Start watching for requested events on the given handle.	1450	Start watching for requested events on the given handle.
1336		1451

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