[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.74 by root, Tue Jan 10 04:26:54 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<hotkey> (enabled by default)
		72
		73	Adds regex search functionality to the scrollback buffer, triggered
		74	by a hotkey (default: C<M-s>). When in search mode, normal terminal
		75	input/output is suspended.
		76
		77	C</> starts an incremental regex search, C<n> searches further, C<p> or
		78	C<N> jump to the previous match, C<G> jumps to the bottom and clears the
		79	history, C<enter> leaves search mode at the current position and C<escape>
		80	returns to the original position.
70		81
71	=item digital-clock	82	=item digital-clock
72		83
73	Displays a digital clock using the built-in overlay.	84	Displays a digital clock using the built-in overlay.
74		85
…		…
124	Either binary data or - more common - a text string encoded in a	135	Either binary data or - more common - a text string encoded in a
125	locale-specific way.	136	locale-specific way.
126		137
127	=back	138	=back
128		139
		140	=head2 Extension Objects
		141
		142	Very perl extension is a perl class. A separate perl object is created
		143	for each terminal and each extension and passed as the first parameter to
		144	hooks. So extensions can use their C<$self> object without having to think
		145	about other extensions, with the exception of methods and members that
		146	begin with an underscore character C<_>: these are reserved for internal
		147	use.
		148
		149	Although it isn't a C<urxvt::term> object, you can call all methods of the
		150	C<urxvt::term> class on this object.
		151
		152	It has the following methods and data members:
		153
		154	=over 4
		155
		156	=item $urxvt_term = $self->{term}
		157
		158	Returns the C<urxvt::term> object associated with this instance of the
		159	extension. This member I<must not> be changed in any way.
		160
		161	=item $self->enable ($hook_name => $cb, [$hook_name => $cb..])
		162
		163	Dynamically enable the given hooks (named without the C<on_> prefix) for
		164	this extension, replacing any previous hook. This is useful when you want
		165	to overwrite time-critical hooks only temporarily.
		166
		167	=item $self->disable ($hook_name[, $hook_name..])
		168
		169	Dynamically disable the given hooks.
		170
		171	=back
		172
129	=head2 Hooks	173	=head2 Hooks
130		174
131	The following subroutines can be declared in extension files, and will be	175	The following subroutines can be declared in extension files, and will be
132	called whenever the relevant event happens.	176	called whenever the relevant event happens.
133		177
134	The first argument passed to them is an object private to each terminal	178	The first argument passed to them is an extension oject as described in
135	and extension package. You can call all C<urxvt::term> methods on it, but	179	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		180
141	All of them must return a boolean value. If it is true, then the event	181	B<All> of these hooks must return a boolean value. If it is true, then the
142	counts as being I<consumed>, and the invocation of other hooks is skipped,	182	event counts as being I<consumed>, and the invocation of other hooks is
143	and the relevant action might not be carried out by the C++ code.	183	skipped, and the relevant action might not be carried out by the C++ code.
144		184
145	When in doubt, return a false value (preferably C<()>).	185	I<< When in doubt, return a false value (preferably C<()>). >>
146		186
147	=over 4	187	=over 4
148		188
149	=item on_init $term	189	=item on_init $term
150		190
…		…
226	can filter/change and output the text yourself by returning a true value	266	can filter/change and output the text yourself by returning a true value
227	and calling C<< $term->scr_add_lines >> yourself. Please note that this	267	and calling C<< $term->scr_add_lines >> yourself. Please note that this
228	might be very slow, however, as your hook is called for B<all> text being	268	might be very slow, however, as your hook is called for B<all> text being
229	output.	269	output.
230		270
		271	=item on_tt_write $term, $octets
		272
		273	Called whenever some data is written to the tty/pty and can be used to
		274	suppress or filter tty input.
		275
231	=item on_line_update $term, $row	276	=item on_line_update $term, $row
232		277
233	Called whenever a line was updated or changed. Can be used to filter	278	Called whenever a line was updated or changed. Can be used to filter
234	screen output (e.g. underline urls or other useless stuff). Only lines	279	screen output (e.g. underline urls or other useless stuff). Only lines
235	that are being shown will be filtered, and, due to performance reasons,	280	that are being shown will be filtered, and, due to performance reasons,
…		…
267	=item on_focus_out $term	312	=item on_focus_out $term
268		313
269	Called wheneever the window loses keyboard focus, before rxvt-unicode does	314	Called wheneever the window loses keyboard focus, before rxvt-unicode does
270	focus out processing.	315	focus out processing.
271		316
272	=item on_key_press $term, $event, $octets	317	=item on_key_press $term, $event, $keysym, $octets
273		318
274	=item on_key_release $term, $event	319	=item on_key_release $term, $event, $keysym
275		320
276	=item on_button_press $term, $event	321	=item on_button_press $term, $event
277		322
278	=item on_button_release $term, $event	323	=item on_button_release $term, $event
279		324
…		…
411		456
412	package urxvt;	457	package urxvt;
413		458
414	use utf8;	459	use utf8;
415	use strict;	460	use strict;
		461	use Carp ();
416	use Scalar::Util ();	462	use Scalar::Util ();
417	use List::Util ();	463	use List::Util ();
418		464
419	our $VERSION = 1;	465	our $VERSION = 1;
420	our $TERM;	466	our $TERM;
421	our @HOOKNAME;	467	our @HOOKNAME;
		468	our %HOOKTYPE = map +($HOOKNAME[$_] => $_), 0..$#HOOKNAME;
422	our %OPTION;	469	our %OPTION;
		470
423	our $LIBDIR;	471	our $LIBDIR;
		472	our $RESNAME;
		473	our $RESCLASS;
		474	our $RXVTNAME;
424		475
425	BEGIN {	476	BEGIN {
426	urxvt->bootstrap;	477	urxvt->bootstrap;
427		478
428	# overwrite perl's warn	479	# overwrite perl's warn
…		…
445	sub verbose {	496	sub verbose {
446	my ($level, $msg) = @_;	497	my ($level, $msg) = @_;
447	warn "$msg\n" if $level <= $verbosity;	498	warn "$msg\n" if $level <= $verbosity;
448	}	499	}
449		500
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";	501	my $extension_pkg = "extension0000";
468	my %extension_pkg;	502	my %extension_pkg;
469		503
470	# load a single script into its own package, once only	504	# load a single script into its own package, once only
471	sub extension_package($) {	505	sub extension_package($) {
…		…
477	verbose 3, "loading extension '$path' into package '$pkg'";	511	verbose 3, "loading extension '$path' into package '$pkg'";
478		512
479	open my $fh, "<:raw", $path	513	open my $fh, "<:raw", $path
480	or die "$path: $!";	514	or die "$path: $!";
481		515
		516	my $source = untaint
482	my $source = untaint "package $pkg; use strict; use utf8;\n"	517	"package $pkg; use strict; use utf8;\n"
483	. "use base urxvt::term::proxy::;\n"	518	. "use base urxvt::term::extension::;\n"
484	. "#line 1 \"$path\"\n{\n"	519	. "#line 1 \"$path\"\n{\n"
485	. (do { local $/; <$fh> })	520	. (do { local $/; <$fh> })
486	. "\n};\n1";	521	. "\n};\n1";
487		522
		523	eval $source
488	eval $source or die "$path: $@";	524	or die "$path: $@";
489		525
490	$pkg	526	$pkg
491	}	527	}
492	}	528	}
493		529
…		…
499	my $htype = shift;	535	my $htype = shift;
500		536
501	if ($htype == 0) { # INIT	537	if ($htype == 0) { # INIT
502	my @dirs = ((split /:/, $TERM->resource ("perl_lib")), "$LIBDIR/perl");	538	my @dirs = ((split /:/, $TERM->resource ("perl_lib")), "$LIBDIR/perl");
503		539
504	my %want_ext;	540	my %ext_arg;
505		541
506	for (map { split /,/, $TERM->resource ("perl_ext_$_") } 1, 2) {	542	for (map { split /,/, $TERM->resource ("perl_ext_$_") } 1, 2) {
507	if ($_ eq "default") {	543	if ($_ eq "default") {
508	$want_ext{$_}++ for qw(selection option-popup selection-popup);	544	$ext_arg{$_} \|\|= [] for qw(selection option-popup selection-popup searchable-scrollback);
509	} elsif (/^-(.*)$/) {	545	} elsif (/^-(.*)$/) {
510	delete $want_ext{$1};	546	delete $ext_arg{$1};
		547	} elsif (/^([^<]+)<(.*)>$/) {
		548	push @{ $ext_arg{$1} }, $2;
511	} else {	549	} else {
512	$want_ext{$_}++;	550	$ext_arg{$_} \|\|= [];
513	}	551	}
514	}	552	}
515		553
516	for my $ext (keys %want_ext) {	554	while (my ($ext, $argv) = each %ext_arg) {
517	my @files = grep -f $_, map "$_/$ext", @dirs;	555	my @files = grep -f $_, map "$_/$ext", @dirs;
518		556
519	if (@files) {	557	if (@files) {
520	register_package extension_package $files[0];	558	$TERM->register_package (extension_package $files[0], $argv);
521	} else {	559	} else {
522	warn "perl extension '$ext' not found in perl library search path\n";	560	warn "perl extension '$ext' not found in perl library search path\n";
523	}	561	}
524	}	562	}
525		563
…		…
534	if $verbosity >= 10;	572	if $verbosity >= 10;
535		573
536	keys %$cb;	574	keys %$cb;
537		575
538	while (my ($pkg, $cb) = each %$cb) {	576	while (my ($pkg, $cb) = each %$cb) {
539	eval {	577	$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;	578	and last;
548	};	579
549	if ($@) {	580	if ($@) {
550	$TERM->ungrab; # better to lose the grab than the session	581	$TERM->ungrab; # better to lose the grab than the session
551	warn $@;	582	warn $@;
552	}	583	}
553	}	584	}
554	}	585	}
555		586
556	if ($htype == 1) { # DESTROY	587	if ($htype == 1) { # DESTROY
557	# remove hooks if unused
558	if (my $hook = $TERM->{_hook}) {	588	if (my $hook = delete $TERM->{_hook}) {
559	for my $htype (0..$#$hook) {	589	for my $htype (0..$#$hook) {
560	$hook_count[$htype] -= scalar keys %{ $hook->[$htype] \|\| {} }	590	$hook_count[$htype] -= scalar keys %{ $hook->[$htype] \|\| {} }
561	or set_should_invoke $htype, 0;	591	or set_should_invoke $htype, 0;
562	}	592	}
563	}	593	}
…		…
570	}	600	}
571		601
572	$retval	602	$retval
573	}	603	}
574		604
575	# urxvt::term::proxy	605	# urxvt::term::extension
576		606
577	sub urxvt::term::proxy::AUTOLOAD {	607	package urxvt::term::extension;
578	$urxvt::term::proxy::AUTOLOAD =~ /:([^:]+)$/	608
		609	sub enable {
		610	my ($self, %hook) = @_;
		611	my $pkg = $self->{_pkg};
		612
		613	while (my ($name, $cb) = each %hook) {
		614	my $htype = $HOOKTYPE{uc $name};
		615	defined $htype
		616	or Carp::croak "unsupported hook type '$name'";
		617
		618	unless (exists $self->{term}{_hook}[$htype]{$pkg}) {
		619	$hook_count[$htype]++
		620	or urxvt::set_should_invoke $htype, 1;
		621	}
		622
		623	$self->{term}{_hook}[$htype]{$pkg} = $cb;
		624	}
		625	}
		626
		627	sub disable {
		628	my ($self, @hook) = @_;
		629	my $pkg = $self->{_pkg};
		630
		631	for my $name (@hook) {
		632	my $htype = $HOOKTYPE{uc $name};
		633	defined $htype
		634	or Carp::croak "unsupported hook type '$name'";
		635
		636	if (delete $self->{term}{_hook}[$htype]{$pkg}) {
		637	--$hook_count[$htype]
		638	or urxvt::set_should_invoke $htype, 0;
		639	}
		640	}
		641	}
		642
		643	our $AUTOLOAD;
		644
		645	sub AUTOLOAD {
		646	$AUTOLOAD =~ /:([^:]+)$/
579	or die "FATAL: \$AUTOLOAD '$urxvt::term::proxy::AUTOLOAD' unparsable";	647	or die "FATAL: \$AUTOLOAD '$AUTOLOAD' unparsable";
580		648
581	eval qq{	649	eval qq{
582	sub $urxvt::term::proxy::AUTOLOAD {	650	sub $AUTOLOAD {
583	my \$proxy = shift;	651	my \$proxy = shift;
584	\$proxy->{term}->$1 (\@_)	652	\$proxy->{term}->$1 (\@_)
585	}	653	}
586	1	654	1
587	} or die "FATAL: unable to compile method forwarder: $@";	655	} or die "FATAL: unable to compile method forwarder: $@";
588		656
589	goto &$urxvt::term::proxy::AUTOLOAD;	657	goto &$AUTOLOAD;
590	}	658	}
591		659
592	sub urxvt::term::proxy::DESTROY {	660	sub DESTROY {
593	# nop	661	# nop
594	}	662	}
595		663
596	# urxvt::destroy_hook	664	# urxvt::destroy_hook
597		665
…		…
664	${$_[0]}++;	732	${$_[0]}++;
665	}	733	}
666		734
667	sub urxvt::anyevent::condvar::wait {	735	sub urxvt::anyevent::condvar::wait {
668	unless (${$_[0]}) {	736	unless (${$_[0]}) {
669	require Carp;
670	Carp::croak ("AnyEvent->condvar blocking wait unsupported in urxvt, use a non-blocking API");	737	Carp::croak "AnyEvent->condvar blocking wait unsupported in urxvt, use a non-blocking API";
671	}	738	}
672	}	739	}
673		740
674	package urxvt::term;	741	package urxvt::term;
675		742
676	=head2 The C<urxvt::term> Class	743	=head2 The C<urxvt::term> Class
677		744
678	=over 4	745	=over 4
		746
		747	=cut
		748
		749	# find on_xxx subs in the package and register them
		750	# as hooks
		751	sub register_package {
		752	my ($self, $pkg, $argv) = @_;
		753
		754	my $proxy = bless {
		755	_pkg => $pkg,
		756	argv => $argv,
		757	}, $pkg;
		758	Scalar::Util::weaken ($proxy->{term} = $self);
		759
		760	$self->{_pkg}{$pkg} = $proxy;
		761
		762	for my $name (@HOOKNAME) {
		763	if (my $ref = $pkg->can ("on_" . lc $name)) {
		764	$proxy->enable ($name => $ref);
		765	}
		766	}
		767	}
679		768
680	=item $term->destroy	769	=item $term->destroy
681		770
682	Destroy the terminal object (close the window, free resources etc.).	771	Destroy the terminal object (close the window, free resources etc.).
683		772
…		…
737	my ($self, $name) = (shift, shift);	826	my ($self, $name) = (shift, shift);
738	unshift @_, $self, $name, ($name =~ s/\s\+\s(\d+)$// ? $1 : 0);	827	unshift @_, $self, $name, ($name =~ s/\s\+\s(\d+)$// ? $1 : 0);
739	&urxvt::term::_resource	828	&urxvt::term::_resource
740	}	829	}
741		830
		831	=item $success = $term->parse_keysym ($keysym_spec, $command_string)
		832
		833	Adds a keymap translation exactly as specified via a resource. See the
		834	C<keysym> resource in the @@RXVT_NAME@@(1) manpage.
		835
742	=item $rend = $term->rstyle ([$new_rstyle])	836	=item $rend = $term->rstyle ([$new_rstyle])
743		837
744	Return and optionally change the current rendition. Text that is output by	838	Return and optionally change the current rendition. Text that is output by
745	the terminal application will use this style.	839	the terminal application will use this style.
746		840
…		…
765		859
766	=item $oldtext = $term->selection ([$newtext])	860	=item $oldtext = $term->selection ([$newtext])
767		861
768	Return the current selection text and optionally replace it by C<$newtext>.	862	Return the current selection text and optionally replace it by C<$newtext>.
769		863
770	#=item $term->overlay ($x, $y, $text)	864	=item $term->overlay_simple ($x, $y, $text)
771	#	865
772	#Create a simple multi-line overlay box. See the next method for details.	866	Create a simple multi-line overlay box. See the next method for details.
773	#	867
774	#=cut	868	=cut
775	#	869
776	#sub urxvt::term::scr_overlay {	870	sub overlay_simple {
777	# my ($self, $x, $y, $text) = @_;	871	my ($self, $x, $y, $text) = @_;
778	#	872
779	# my @lines = split /\n/, $text;	873	my @lines = split /\n/, $text;
780	#	874
781	# my $w = 0;	875	my $w = List::Util::max map $self->strwidth ($_), @lines;
782	# for (map $self->strwidth ($_), @lines) {	876
783	# $w = $_ if $w < $_;
784	# }
785	#
786	# $self->scr_overlay_new ($x, $y, $w, scalar @lines);	877	my $overlay = $self->overlay ($x, $y, $w, scalar @lines);
787	# $self->scr_overlay_set (0, $_, $lines[$_]) for 0.. $#lines;	878	$overlay->set (0, $_, $lines[$_]) for 0.. $#lines;
788	#}	879
		880	$overlay
		881	}
789		882
790	=item $term->overlay ($x, $y, $width, $height[, $rstyle[, $border]])	883	=item $term->overlay ($x, $y, $width, $height[, $rstyle[, $border]])
791		884
792	Create a new (empty) overlay at the given position with the given	885	Create a new (empty) overlay at the given position with the given
793	width/height. C<$rstyle> defines the initial rendition style	886	width/height. C<$rstyle> defines the initial rendition style
…		…
860		953
861	=item $string = $term->locale_decode ($octets)	954	=item $string = $term->locale_decode ($octets)
862		955
863	Convert the given locale-encoded octets into a perl string.	956	Convert the given locale-encoded octets into a perl string.
864		957
		958	=item $term->scr_xor_span ($beg_row, $beg_col, $end_row, $end_col[, $rstyle])
		959
		960	XORs the rendition values in the given span with the provided value
		961	(default: C<RS_RVid>). Useful in refresh hooks to provide effects similar
		962	to the selection.
		963
		964	=item $term->scr_xor_rect ($beg_row, $beg_col, $end_row, $end_col[, $rstyle1[, $rstyle2]])
		965
		966	Similar to C<scr_xor_span>, but xors a rectangle instead. Trailing
		967	whitespace will additionally be xored with the C<$rstyle2>, which defaults
		968	to C<RS_RVid \| RS_Uline>, which removes reverse video again and underlines
		969	it instead.
		970
		971	=item $term->scr_bell
		972
		973	Ring the bell!
		974
865	=item $term->scr_add_lines ($string)	975	=item $term->scr_add_lines ($string)
866		976
867	Write the given text string to the screen, as if output by the application	977	Write the given text string to the screen, as if output by the application
868	running inside the terminal. It may not contain command sequences (escape	978	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	979	codes), but is free to use line feeds, carriage returns and tabs. The
…		…
882	=item $term->tt_write ($octets)	992	=item $term->tt_write ($octets)
883		993
884	Write the octets given in C<$data> to the tty (i.e. as program input). To	994	Write the octets given in C<$data> to the tty (i.e. as program input). To
885	pass characters instead of octets, you should convert your strings first	995	pass characters instead of octets, you should convert your strings first
886	to the locale-specific encoding using C<< $term->locale_encode >>.	996	to the locale-specific encoding using C<< $term->locale_encode >>.
		997
		998	=item $old_events = $term->pty_ev_events ([$new_events])
		999
		1000	Replaces the event mask of the pty watcher by the given event mask. Can
		1001	be used to suppress input and output handling to the pty/tty. See the
		1002	description of C<< urxvt::timer->events >>. Make sure to always restore
		1003	the previous value.
887		1004
888	=item $windowid = $term->parent	1005	=item $windowid = $term->parent
889		1006
890	Return the window id of the toplevel window.	1007	Return the window id of the toplevel window.
891		1008
…		…
1176	}	1293	}
1177		1294
1178	sub add_separator {	1295	sub add_separator {
1179	my ($self, $sep) = @_;	1296	my ($self, $sep) = @_;
1180		1297
1181	$sep \|\|= "═";	1298	$sep \|\|= "=";
1182		1299
1183	$self->add_item ({	1300	$self->add_item ({
1184	rend => { normal => "\x1b[0;30;47m", hover => "\x1b[0;30;47m", active => "\x1b[0;30;47m" },	1301	rend => { normal => "\x1b[0;30;47m", hover => "\x1b[0;30;47m", active => "\x1b[0;30;47m" },
1185	text => "",	1302	text => "",
1186	render => sub { $sep x $self->{term}->ncol },	1303	render => sub { $sep x $self->{term}->ncol },
…		…
1298		1415
1299	$term->{socket} = ...	1416	$term->{socket} = ...
1300	$term->{iow} = urxvt::iow	1417	$term->{iow} = urxvt::iow
1301	->new	1418	->new
1302	->fd (fileno $term->{socket})	1419	->fd (fileno $term->{socket})
1303	->events (1) # wait for read data	1420	->events (urxvt::EVENT_READ)
1304	->start	1421	->start
1305	->cb (sub {	1422	->cb (sub {
1306	my ($iow, $revents) = @_;	1423	my ($iow, $revents) = @_;
1307	# $revents must be 1 here, no need to check	1424	# $revents must be 1 here, no need to check
1308	sysread $term->{socket}, my $buf, 8192	1425	sysread $term->{socket}, my $buf, 8192
…		…
1325		1442
1326	Set the filedescriptor (not handle) to watch.	1443	Set the filedescriptor (not handle) to watch.
1327		1444
1328	=item $iow = $iow->events ($eventmask)	1445	=item $iow = $iow->events ($eventmask)
1329		1446
1330	Set the event mask to watch. Bit #0 (value C<1>) enables watching for read	1447	Set the event mask to watch. The only allowed values are
1331	data, Bit #1 (value C<2>) enables watching for write data.	1448	C<urxvt::EVENT_READ> and C<urxvt::EVENT_WRITE>, which might be ORed
		1449	together, or C<urxvt::EVENT_NONE>.
1332		1450
1333	=item $iow = $iow->start	1451	=item $iow = $iow->start
1334		1452
1335	Start watching for requested events on the given handle.	1453	Start watching for requested events on the given handle.
1336		1454

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.74 by root, Tue Jan 10 04:26:54 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.74 by root, Tue Jan 10 04:26:54 2006 UTC