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

Comparing rxvt-unicode/src/urxvt.pm (file contents):
Revision 1.66 by root, Mon Jan 9 19:28:39 2006 UTC vs.
Revision 1.72 by root, Mon Jan 9 23:30:01 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;
423	our $LIBDIR;	467	our $LIBDIR;
424		468
425	BEGIN {	469	BEGIN {
426	urxvt->bootstrap;	470	urxvt->bootstrap;
…		…
445	sub verbose {	489	sub verbose {
446	my ($level, $msg) = @_;	490	my ($level, $msg) = @_;
447	warn "$msg\n" if $level <= $verbosity;	491	warn "$msg\n" if $level <= $verbosity;
448	}	492	}
449		493
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";	494	my $extension_pkg = "extension0000";
468	my %extension_pkg;	495	my %extension_pkg;
469		496
470	# load a single script into its own package, once only	497	# load a single script into its own package, once only
471	sub extension_package($) {	498	sub extension_package($) {
…		…
477	verbose 3, "loading extension '$path' into package '$pkg'";	504	verbose 3, "loading extension '$path' into package '$pkg'";
478		505
479	open my $fh, "<:raw", $path	506	open my $fh, "<:raw", $path
480	or die "$path: $!";	507	or die "$path: $!";
481		508
		509	my $source = untaint
482	my $source = untaint "package $pkg; use strict; use utf8;\n"	510	"package $pkg; use strict; use utf8;\n"
483	. "use base urxvt::term::proxy::;\n"	511	. "use base urxvt::term::extension::;\n"
484	. "#line 1 \"$path\"\n{\n"	512	. "#line 1 \"$path\"\n{\n"
485	. (do { local $/; <$fh> })	513	. (do { local $/; <$fh> })
486	. "\n};\n1";	514	. "\n};\n1";
487		515
		516	eval $source
488	eval $source or die "$path: $@";	517	or die "$path: $@";
489		518
490	$pkg	519	$pkg
491	}	520	}
492	}	521	}
493		522
…		…
499	my $htype = shift;	528	my $htype = shift;
500		529
501	if ($htype == 0) { # INIT	530	if ($htype == 0) { # INIT
502	my @dirs = ((split /:/, $TERM->resource ("perl_lib")), "$LIBDIR/perl");	531	my @dirs = ((split /:/, $TERM->resource ("perl_lib")), "$LIBDIR/perl");
503		532
504	my %want_ext;	533	my %ext_arg;
505		534
506	for (map { split /,/, $TERM->resource ("perl_ext_$_") } 1, 2) {	535	for (map { split /,/, $TERM->resource ("perl_ext_$_") } 1, 2) {
507	if ($_ eq "default") {	536	if ($_ eq "default") {
508	$want_ext{$_}++ for qw(selection option-popup selection-popup);	537	$ext_arg{$_} \|\|= [] for qw(selection option-popup selection-popup searchable-scrollback);
509	} elsif (/^-(.*)$/) {	538	} elsif (/^-(.*)$/) {
510	delete $want_ext{$1};	539	delete $ext_arg{$1};
		540	} elsif (/^([^<]+)<(.*)>$/) {
		541	push @{ $ext_arg{$1} }, $2;
511	} else {	542	} else {
512	$want_ext{$_}++;	543	$ext_arg{$_} \|\|= [];
513	}	544	}
514	}	545	}
515		546
516	for my $ext (keys %want_ext) {	547	while (my ($ext, $argv) = each %ext_arg) {
517	my @files = grep -f $_, map "$_/$ext", @dirs;	548	my @files = grep -f $_, map "$_/$ext", @dirs;
518		549
519	if (@files) {	550	if (@files) {
520	register_package extension_package $files[0];	551	$TERM->register_package (extension_package $files[0], $argv);
521	} else {	552	} else {
522	warn "perl extension '$ext' not found in perl library search path\n";	553	warn "perl extension '$ext' not found in perl library search path\n";
523	}	554	}
524	}	555	}
525		556
…		…
534	if $verbosity >= 10;	565	if $verbosity >= 10;
535		566
536	keys %$cb;	567	keys %$cb;
537		568
538	while (my ($pkg, $cb) = each %$cb) {	569	while (my ($pkg, $cb) = each %$cb) {
539	eval {	570	$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;	571	and last;
548	};	572
549	if ($@) {	573	if ($@) {
550	$TERM->ungrab; # better to lose the grab than the session	574	$TERM->ungrab; # better to lose the grab than the session
551	warn $@;	575	warn $@;
552	}	576	}
553	}	577	}
554	}	578	}
555		579
556	if ($htype == 1) { # DESTROY	580	if ($htype == 1) { # DESTROY
557	# remove hooks if unused
558	if (my $hook = $TERM->{_hook}) {	581	if (my $hook = delete $TERM->{_hook}) {
559	for my $htype (0..$#$hook) {	582	for my $htype (0..$#$hook) {
560	$hook_count[$htype] -= scalar keys %{ $hook->[$htype] \|\| {} }	583	$hook_count[$htype] -= scalar keys %{ $hook->[$htype] \|\| {} }
561	or set_should_invoke $htype, 0;	584	or set_should_invoke $htype, 0;
562	}	585	}
563	}	586	}
…		…
570	}	593	}
571		594
572	$retval	595	$retval
573	}	596	}
574		597
575	# urxvt::term::proxy	598	# urxvt::term::extension
576		599
577	sub urxvt::term::proxy::AUTOLOAD {	600	package urxvt::term::extension;
578	$urxvt::term::proxy::AUTOLOAD =~ /:([^:]+)$/	601
		602	sub enable {
		603	my ($self, %hook) = @_;
		604	my $pkg = $self->{_pkg};
		605
		606	while (my ($name, $cb) = each %hook) {
		607	my $htype = $HOOKTYPE{uc $name};
		608	defined $htype
		609	or Carp::croak "unsupported hook type '$name'";
		610
		611	unless (exists $self->{term}{_hook}[$htype]{$pkg}) {
		612	$hook_count[$htype]++
		613	or urxvt::set_should_invoke $htype, 1;
		614	}
		615
		616	$self->{term}{_hook}[$htype]{$pkg} = $cb;
		617	}
		618	}
		619
		620	sub disable {
		621	my ($self, @hook) = @_;
		622	my $pkg = $self->{_pkg};
		623
		624	for my $name (@hook) {
		625	my $htype = $HOOKTYPE{uc $name};
		626	defined $htype
		627	or Carp::croak "unsupported hook type '$name'";
		628
		629	if (delete $self->{term}{_hook}[$htype]{$pkg}) {
		630	--$hook_count[$htype]
		631	or urxvt::set_should_invoke $htype, 0;
		632	}
		633	}
		634	}
		635
		636	our $AUTOLOAD;
		637
		638	sub AUTOLOAD {
		639	$AUTOLOAD =~ /:([^:]+)$/
579	or die "FATAL: \$AUTOLOAD '$urxvt::term::proxy::AUTOLOAD' unparsable";	640	or die "FATAL: \$AUTOLOAD '$AUTOLOAD' unparsable";
580		641
581	eval qq{	642	eval qq{
582	sub $urxvt::term::proxy::AUTOLOAD {	643	sub $AUTOLOAD {
583	my \$proxy = shift;	644	my \$proxy = shift;
584	\$proxy->{term}->$1 (\@_)	645	\$proxy->{term}->$1 (\@_)
585	}	646	}
586	1	647	1
587	} or die "FATAL: unable to compile method forwarder: $@";	648	} or die "FATAL: unable to compile method forwarder: $@";
588		649
589	goto &$urxvt::term::proxy::AUTOLOAD;	650	goto &$AUTOLOAD;
590	}	651	}
591		652
592	sub urxvt::term::proxy::DESTROY {	653	sub DESTROY {
593	# nop	654	# nop
594	}	655	}
595		656
596	# urxvt::destroy_hook	657	# urxvt::destroy_hook
597		658
…		…
664	${$_[0]}++;	725	${$_[0]}++;
665	}	726	}
666		727
667	sub urxvt::anyevent::condvar::wait {	728	sub urxvt::anyevent::condvar::wait {
668	unless (${$_[0]}) {	729	unless (${$_[0]}) {
669	require Carp;
670	Carp::croak ("AnyEvent->condvar blocking wait unsupported in urxvt, use a non-blocking API");	730	Carp::croak "AnyEvent->condvar blocking wait unsupported in urxvt, use a non-blocking API";
671	}	731	}
672	}	732	}
673		733
674	package urxvt::term;	734	package urxvt::term;
675		735
676	=head2 The C<urxvt::term> Class	736	=head2 The C<urxvt::term> Class
677		737
678	=over 4	738	=over 4
		739
		740	=cut
		741
		742	# find on_xxx subs in the package and register them
		743	# as hooks
		744	sub register_package {
		745	my ($self, $pkg, $argv) = @_;
		746
		747	my $proxy = bless {
		748	_pkg => $pkg,
		749	argv => $argv,
		750	}, $pkg;
		751	Scalar::Util::weaken ($proxy->{term} = $self);
		752
		753	$self->{_pkg}{$pkg} = $proxy;
		754
		755	for my $name (@HOOKNAME) {
		756	if (my $ref = $pkg->can ("on_" . lc $name)) {
		757	$proxy->enable ($name => $ref);
		758	}
		759	}
		760	}
679		761
680	=item $term->destroy	762	=item $term->destroy
681		763
682	Destroy the terminal object (close the window, free resources etc.).	764	Destroy the terminal object (close the window, free resources etc.).
683		765
…		…
737	my ($self, $name) = (shift, shift);	819	my ($self, $name) = (shift, shift);
738	unshift @_, $self, $name, ($name =~ s/\s\+\s(\d+)$// ? $1 : 0);	820	unshift @_, $self, $name, ($name =~ s/\s\+\s(\d+)$// ? $1 : 0);
739	&urxvt::term::_resource	821	&urxvt::term::_resource
740	}	822	}
741		823
		824	=item $success = $term->parse_keysym ($keysym_spec, $command_string)
		825
		826	Adds a keymap translation exactly as specified via a resource. See the
		827	C<keysym> resource in the @@RXVT_NAME@@(1) manpage.
		828
742	=item $rend = $term->rstyle ([$new_rstyle])	829	=item $rend = $term->rstyle ([$new_rstyle])
743		830
744	Return and optionally change the current rendition. Text that is output by	831	Return and optionally change the current rendition. Text that is output by
745	the terminal application will use this style.	832	the terminal application will use this style.
746		833
…		…
765		852
766	=item $oldtext = $term->selection ([$newtext])	853	=item $oldtext = $term->selection ([$newtext])
767		854
768	Return the current selection text and optionally replace it by C<$newtext>.	855	Return the current selection text and optionally replace it by C<$newtext>.
769		856
770	#=item $term->overlay ($x, $y, $text)	857	=item $term->overlay_simple ($x, $y, $text)
771	#	858
772	#Create a simple multi-line overlay box. See the next method for details.	859	Create a simple multi-line overlay box. See the next method for details.
773	#	860
774	#=cut	861	=cut
775	#	862
776	#sub urxvt::term::scr_overlay {	863	sub overlay_simple {
777	# my ($self, $x, $y, $text) = @_;	864	my ($self, $x, $y, $text) = @_;
778	#	865
779	# my @lines = split /\n/, $text;	866	my @lines = split /\n/, $text;
780	#	867
781	# my $w = 0;	868	my $w = List::Util::max map $self->strwidth ($_), @lines;
782	# for (map $self->strwidth ($_), @lines) {	869
783	# $w = $_ if $w < $_;
784	# }
785	#
786	# $self->scr_overlay_new ($x, $y, $w, scalar @lines);	870	my $overlay = $self->overlay ($x, $y, $w, scalar @lines);
787	# $self->scr_overlay_set (0, $_, $lines[$_]) for 0.. $#lines;	871	$overlay->set (0, $_, $lines[$_]) for 0.. $#lines;
788	#}	872
		873	$overlay
		874	}
789		875
790	=item $term->overlay ($x, $y, $width, $height[, $rstyle[, $border]])	876	=item $term->overlay ($x, $y, $width, $height[, $rstyle[, $border]])
791		877
792	Create a new (empty) overlay at the given position with the given	878	Create a new (empty) overlay at the given position with the given
793	width/height. C<$rstyle> defines the initial rendition style	879	width/height. C<$rstyle> defines the initial rendition style
…		…
860		946
861	=item $string = $term->locale_decode ($octets)	947	=item $string = $term->locale_decode ($octets)
862		948
863	Convert the given locale-encoded octets into a perl string.	949	Convert the given locale-encoded octets into a perl string.
864		950
		951	=item $term->scr_xor_span ($beg_row, $beg_col, $end_row, $end_col[, $rstyle])
		952
		953	XORs the rendition values in the given span with the provided value
		954	(default: C<RS_RVid>). Useful in refresh hooks to provide effects similar
		955	to the selection.
		956
		957	=item $term->scr_xor_rect ($beg_row, $beg_col, $end_row, $end_col[, $rstyle1[, $rstyle2]])
		958
		959	Similar to C<scr_xor_span>, but xors a rectangle instead. Trailing
		960	whitespace will additionally be xored with the C<$rstyle2>, which defaults
		961	to C<RS_RVid \| RS_Uline>, which removes reverse video again and underlines
		962	it instead.
		963
		964	=item $term->scr_bell
		965
		966	Ring the bell!
		967
865	=item $term->scr_add_lines ($string)	968	=item $term->scr_add_lines ($string)
866		969
867	Write the given text string to the screen, as if output by the application	970	Write the given text string to the screen, as if output by the application
868	running inside the terminal. It may not contain command sequences (escape	971	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	972	codes), but is free to use line feeds, carriage returns and tabs. The
…		…
882	=item $term->tt_write ($octets)	985	=item $term->tt_write ($octets)
883		986
884	Write the octets given in C<$data> to the tty (i.e. as program input). To	987	Write the octets given in C<$data> to the tty (i.e. as program input). To
885	pass characters instead of octets, you should convert your strings first	988	pass characters instead of octets, you should convert your strings first
886	to the locale-specific encoding using C<< $term->locale_encode >>.	989	to the locale-specific encoding using C<< $term->locale_encode >>.
		990
		991	=item $old_events = $term->pty_ev_events ([$new_events])
		992
		993	Replaces the event mask of the pty watcher by the given event mask. Can
		994	be used to suppress input and output handling to the pty/tty. See the
		995	description of C<< urxvt::timer->events >>. Make sure to always restore
		996	the previous value.
887		997
888	=item $windowid = $term->parent	998	=item $windowid = $term->parent
889		999
890	Return the window id of the toplevel window.	1000	Return the window id of the toplevel window.
891		1001
…		…
1176	}	1286	}
1177		1287
1178	sub add_separator {	1288	sub add_separator {
1179	my ($self, $sep) = @_;	1289	my ($self, $sep) = @_;
1180		1290
1181	$sep \|\|= "═";	1291	$sep \|\|= "=";
1182		1292
1183	$self->add_item ({	1293	$self->add_item ({
1184	rend => { normal => "\x1b[0;30;47m", hover => "\x1b[0;30;47m", active => "\x1b[0;30;47m" },	1294	rend => { normal => "\x1b[0;30;47m", hover => "\x1b[0;30;47m", active => "\x1b[0;30;47m" },
1185	text => "",	1295	text => "",
1186	render => sub { $sep x $self->{term}->ncol },	1296	render => sub { $sep x $self->{term}->ncol },
…		…
1298		1408
1299	$term->{socket} = ...	1409	$term->{socket} = ...
1300	$term->{iow} = urxvt::iow	1410	$term->{iow} = urxvt::iow
1301	->new	1411	->new
1302	->fd (fileno $term->{socket})	1412	->fd (fileno $term->{socket})
1303	->events (1) # wait for read data	1413	->events (urxvt::EVENT_READ)
1304	->start	1414	->start
1305	->cb (sub {	1415	->cb (sub {
1306	my ($iow, $revents) = @_;	1416	my ($iow, $revents) = @_;
1307	# $revents must be 1 here, no need to check	1417	# $revents must be 1 here, no need to check
1308	sysread $term->{socket}, my $buf, 8192	1418	sysread $term->{socket}, my $buf, 8192
…		…
1325		1435
1326	Set the filedescriptor (not handle) to watch.	1436	Set the filedescriptor (not handle) to watch.
1327		1437
1328	=item $iow = $iow->events ($eventmask)	1438	=item $iow = $iow->events ($eventmask)
1329		1439
1330	Set the event mask to watch. Bit #0 (value C<1>) enables watching for read	1440	Set the event mask to watch. The only allowed values are
1331	data, Bit #1 (value C<2>) enables watching for write data.	1441	C<urxvt::EVENT_READ> and C<urxvt::EVENT_WRITE>, which might be ORed
		1442	together, or C<urxvt::EVENT_NONE>.
1332		1443
1333	=item $iow = $iow->start	1444	=item $iow = $iow->start
1334		1445
1335	Start watching for requested events on the given handle.	1446	Start watching for requested events on the given handle.
1336		1447

Diff Legend

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

Comparing rxvt-unicode/src/urxvt.pm (file contents): Revision 1.66 by root, Mon Jan 9 19:28:39 2006 UTC vs. Revision 1.72 by root, Mon Jan 9 23:30:01 2006 UTC

Diff Legend

Comparing rxvt-unicode/src/urxvt.pm (file contents):
Revision 1.66 by root, Mon Jan 9 19:28:39 2006 UTC vs.
Revision 1.72 by root, Mon Jan 9 23:30:01 2006 UTC