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

Comparing rxvt-unicode/src/urxvt.pm (file contents):
Revision 1.59 by root, Mon Jan 9 00:34:36 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
…		…
204	than the scroll back buffer or the terminal.	241	than the scroll back buffer or the terminal.
205		242
206	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,
207	$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
208	number of lines that will be in the scrollback buffer.	245	number of lines that will be in the scrollback buffer.
209
210	=item on_tty_activity $term NYI
211
212	Called whenever the program(s) running in the urxvt window send output.
213		246
214	=item on_osc_seq $term, $string	247	=item on_osc_seq $term, $string
215		248
216	Called whenever the B<ESC ] 777 ; string ST> command sequence (OSC =	249	Called whenever the B<ESC ] 777 ; string ST> command sequence (OSC =
217	operating system command) is processed. Cursor position and other state	250	operating system command) is processed. Cursor position and other state
…		…
230	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
231	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
232	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
233	output.	266	output.
234		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
235	=item on_line_update $term, $row	273	=item on_line_update $term, $row
236		274
237	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
238	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
239	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,
…		…
271	=item on_focus_out $term	309	=item on_focus_out $term
272		310
273	Called wheneever the window loses keyboard focus, before rxvt-unicode does	311	Called wheneever the window loses keyboard focus, before rxvt-unicode does
274	focus out processing.	312	focus out processing.
275		313
276	=item on_key_press $term, $event, $octets	314	=item on_key_press $term, $event, $keysym, $octets
277		315
278	=item on_key_release $term, $event	316	=item on_key_release $term, $event, $keysym
279		317
280	=item on_button_press $term, $event	318	=item on_button_press $term, $event
281		319
282	=item on_button_release $term, $event	320	=item on_button_release $term, $event
283		321
…		…
337	that calls this function.	375	that calls this function.
338		376
339	Using this function has the advantage that its output ends up in the	377	Using this function has the advantage that its output ends up in the
340	correct place, e.g. on stderr of the connecting urxvtc client.	378	correct place, e.g. on stderr of the connecting urxvtc client.
341		379
		380	=item $is_safe = urxvt::safe
		381
		382	Returns true when it is safe to do potentially unsafe things, such as
		383	evaluating perl code specified by the user. This is true when urxvt was
		384	started setuid or setgid.
		385
342	=item $time = urxvt::NOW	386	=item $time = urxvt::NOW
343		387
344	Returns the "current time" (as per the event loop).	388	Returns the "current time" (as per the event loop).
345		389
346	=item urxvt::CurrentTime	390	=item urxvt::CurrentTime
…		…
409		453
410	package urxvt;	454	package urxvt;
411		455
412	use utf8;	456	use utf8;
413	use strict;	457	use strict;
		458	use Carp ();
414	use Scalar::Util ();	459	use Scalar::Util ();
415	use List::Util ();	460	use List::Util ();
416		461
417	our $VERSION = 1;	462	our $VERSION = 1;
418	our $TERM;	463	our $TERM;
419	our @HOOKNAME;	464	our @HOOKNAME;
		465	our %HOOKTYPE = map +($HOOKNAME[$_] => $_), 0..$#HOOKNAME;
420	our %OPTION;	466	our %OPTION;
421	our $LIBDIR;	467	our $LIBDIR;
422		468
423	BEGIN {	469	BEGIN {
424	urxvt->bootstrap;	470	urxvt->bootstrap;
…		…
429	$msg .= "\n"	475	$msg .= "\n"
430	unless $msg =~ /\n$/;	476	unless $msg =~ /\n$/;
431	urxvt::warn ($msg);	477	urxvt::warn ($msg);
432	};	478	};
433		479
		480	delete $ENV{IFS};
		481	delete $ENV{CDPATH};
		482	delete $ENV{BASH_ENV};
434	$ENV{PATH} = "/bin:/sbin:/usr/bin:/usr/sbin:/usr/local/bin:/usr/local/sbin:/opt/bin:/opt/sbin";	483	$ENV{PATH} = "/bin:/sbin:/usr/bin:/usr/sbin:/usr/local/bin:/usr/local/sbin:/opt/bin:/opt/sbin";
435	delete $ENV{CDPATH};
436	}	484	}
437		485
438	my @hook_count;	486	my @hook_count;
439	my $verbosity = $ENV{URXVT_PERL_VERBOSITY};	487	my $verbosity = $ENV{URXVT_PERL_VERBOSITY};
440		488
441	sub verbose {	489	sub verbose {
442	my ($level, $msg) = @_;	490	my ($level, $msg) = @_;
443	warn "$msg\n" if $level <= $verbosity;	491	warn "$msg\n" if $level <= $verbosity;
444	}	492	}
445		493
446	# find on_xxx subs in the package and register them
447	# as hooks
448	sub register_package($) {
449	my ($pkg) = @_;
450
451	for my $htype (0.. $#HOOKNAME) {
452	my $name = $HOOKNAME[$htype];
453
454	my $ref = $pkg->can ("on_" . lc $name)
455	or next;
456
457	$TERM->{_hook}[$htype]{$pkg} = $ref;
458	$hook_count[$htype]++
459	or set_should_invoke $htype, 1;
460	}
461	}
462
463	my $extension_pkg = "extension0000";	494	my $extension_pkg = "extension0000";
464	my %extension_pkg;	495	my %extension_pkg;
465		496
466	# load a single script into its own package, once only	497	# load a single script into its own package, once only
467	sub extension_package($) {	498	sub extension_package($) {
…		…
473	verbose 3, "loading extension '$path' into package '$pkg'";	504	verbose 3, "loading extension '$path' into package '$pkg'";
474		505
475	open my $fh, "<:raw", $path	506	open my $fh, "<:raw", $path
476	or die "$path: $!";	507	or die "$path: $!";
477		508
		509	my $source = untaint
478	my $source = untaint "package $pkg; use strict; use utf8;\n"	510	"package $pkg; use strict; use utf8;\n"
479	. "use base urxvt::term::proxy::;\n"	511	. "use base urxvt::term::extension::;\n"
480	. "#line 1 \"$path\"\n{\n"	512	. "#line 1 \"$path\"\n{\n"
481	. (do { local $/; <$fh> })	513	. (do { local $/; <$fh> })
482	. "\n};\n1";	514	. "\n};\n1";
483		515
		516	eval $source
484	eval $source or die "$path: $@";	517	or die "$path: $@";
485		518
486	$pkg	519	$pkg
487	}	520	}
488	}	521	}
489		522
…		…
495	my $htype = shift;	528	my $htype = shift;
496		529
497	if ($htype == 0) { # INIT	530	if ($htype == 0) { # INIT
498	my @dirs = ((split /:/, $TERM->resource ("perl_lib")), "$LIBDIR/perl");	531	my @dirs = ((split /:/, $TERM->resource ("perl_lib")), "$LIBDIR/perl");
499		532
500	my %want_ext;	533	my %ext_arg;
501		534
502	for (map { split /,/, $TERM->resource ("perl_ext_$_") } 1, 2) {	535	for (map { split /,/, $TERM->resource ("perl_ext_$_") } 1, 2) {
503	if ($_ eq "default") {	536	if ($_ eq "default") {
504	$want_ext{$_}++ for qw(selection option-popup selection-popup);	537	$ext_arg{$_} \|\|= [] for qw(selection option-popup selection-popup searchable-scrollback);
505	} elsif (/^-(.*)$/) {	538	} elsif (/^-(.*)$/) {
506	delete $want_ext{$1};	539	delete $ext_arg{$1};
		540	} elsif (/^([^<]+)<(.*)>$/) {
		541	push @{ $ext_arg{$1} }, $2;
507	} else {	542	} else {
508	$want_ext{$_}++;	543	$ext_arg{$_} \|\|= [];
509	}	544	}
510	}	545	}
511		546
512	for my $ext (keys %want_ext) {	547	while (my ($ext, $argv) = each %ext_arg) {
513	my @files = grep -f $_, map "$_/$ext", @dirs;	548	my @files = grep -f $_, map "$_/$ext", @dirs;
514		549
515	if (@files) {	550	if (@files) {
516	register_package extension_package $files[0];	551	$TERM->register_package (extension_package $files[0], $argv);
517	} else {	552	} else {
518	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";
519	}	554	}
520	}	555	}
521		556
…		…
530	if $verbosity >= 10;	565	if $verbosity >= 10;
531		566
532	keys %$cb;	567	keys %$cb;
533		568
534	while (my ($pkg, $cb) = each %$cb) {	569	while (my ($pkg, $cb) = each %$cb) {
535	eval {	570	$retval = eval { $cb->($TERM->{_pkg}{$pkg}, @_) }
536	$retval = $cb->(
537	$TERM->{_pkg}{$pkg} \|\|= do {
538	my $proxy = bless { }, $pkg;
539	Scalar::Util::weaken ($proxy->{term} = $TERM);
540	$proxy
541	},
542	@_,
543	) and last;	571	and last;
544	};	572
545	if ($@) {	573	if ($@) {
546	$TERM->ungrab; # better to lose the grab than the session	574	$TERM->ungrab; # better to lose the grab than the session
547	warn $@;	575	warn $@;
548	}	576	}
549	}	577	}
550	}	578	}
551		579
552	if ($htype == 1) { # DESTROY	580	if ($htype == 1) { # DESTROY
553	# remove hooks if unused
554	if (my $hook = $TERM->{_hook}) {	581	if (my $hook = delete $TERM->{_hook}) {
555	for my $htype (0..$#$hook) {	582	for my $htype (0..$#$hook) {
556	$hook_count[$htype] -= scalar keys %{ $hook->[$htype] \|\| {} }	583	$hook_count[$htype] -= scalar keys %{ $hook->[$htype] \|\| {} }
557	or set_should_invoke $htype, 0;	584	or set_should_invoke $htype, 0;
558	}	585	}
559	}	586	}
…		…
566	}	593	}
567		594
568	$retval	595	$retval
569	}	596	}
570		597
571	# urxvt::term::proxy	598	# urxvt::term::extension
572		599
573	sub urxvt::term::proxy::AUTOLOAD {	600	package urxvt::term::extension;
574	$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 =~ /:([^:]+)$/
575	or die "FATAL: \$AUTOLOAD '$urxvt::term::proxy::AUTOLOAD' unparsable";	640	or die "FATAL: \$AUTOLOAD '$AUTOLOAD' unparsable";
576		641
577	eval qq{	642	eval qq{
578	sub $urxvt::term::proxy::AUTOLOAD {	643	sub $AUTOLOAD {
579	my \$proxy = shift;	644	my \$proxy = shift;
580	\$proxy->{term}->$1 (\@_)	645	\$proxy->{term}->$1 (\@_)
581	}	646	}
582	1	647	1
583	} or die "FATAL: unable to compile method forwarder: $@";	648	} or die "FATAL: unable to compile method forwarder: $@";
584		649
585	goto &$urxvt::term::proxy::AUTOLOAD;	650	goto &$AUTOLOAD;
586	}	651	}
587		652
588	sub urxvt::term::proxy::DESTROY {	653	sub DESTROY {
589	# nop	654	# nop
590	}	655	}
591		656
592	# urxvt::destroy_hook	657	# urxvt::destroy_hook
593		658
…		…
660	${$_[0]}++;	725	${$_[0]}++;
661	}	726	}
662		727
663	sub urxvt::anyevent::condvar::wait {	728	sub urxvt::anyevent::condvar::wait {
664	unless (${$_[0]}) {	729	unless (${$_[0]}) {
665	require Carp;
666	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";
667	}	731	}
668	}	732	}
669		733
670	package urxvt::term;	734	package urxvt::term;
671		735
672	=head2 The C<urxvt::term> Class	736	=head2 The C<urxvt::term> Class
673		737
674	=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	}
675		761
676	=item $term->destroy	762	=item $term->destroy
677		763
678	Destroy the terminal object (close the window, free resources etc.).	764	Destroy the terminal object (close the window, free resources etc.).
679		765
…		…
733	my ($self, $name) = (shift, shift);	819	my ($self, $name) = (shift, shift);
734	unshift @_, $self, $name, ($name =~ s/\s\+\s(\d+)$// ? $1 : 0);	820	unshift @_, $self, $name, ($name =~ s/\s\+\s(\d+)$// ? $1 : 0);
735	&urxvt::term::_resource	821	&urxvt::term::_resource
736	}	822	}
737		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
738	=item $rend = $term->rstyle ([$new_rstyle])	829	=item $rend = $term->rstyle ([$new_rstyle])
739		830
740	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
741	the terminal application will use this style.	832	the terminal application will use this style.
742		833
…		…
761		852
762	=item $oldtext = $term->selection ([$newtext])	853	=item $oldtext = $term->selection ([$newtext])
763		854
764	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>.
765		856
766	#=item $term->overlay ($x, $y, $text)	857	=item $term->overlay_simple ($x, $y, $text)
767	#	858
768	#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.
769	#	860
770	#=cut	861	=cut
771	#	862
772	#sub urxvt::term::scr_overlay {	863	sub overlay_simple {
773	# my ($self, $x, $y, $text) = @_;	864	my ($self, $x, $y, $text) = @_;
774	#	865
775	# my @lines = split /\n/, $text;	866	my @lines = split /\n/, $text;
776	#	867
777	# my $w = 0;	868	my $w = List::Util::max map $self->strwidth ($_), @lines;
778	# for (map $self->strwidth ($_), @lines) {	869
779	# $w = $_ if $w < $_;
780	# }
781	#
782	# $self->scr_overlay_new ($x, $y, $w, scalar @lines);	870	my $overlay = $self->overlay ($x, $y, $w, scalar @lines);
783	# $self->scr_overlay_set (0, $_, $lines[$_]) for 0.. $#lines;	871	$overlay->set (0, $_, $lines[$_]) for 0.. $#lines;
784	#}	872
		873	$overlay
		874	}
785		875
786	=item $term->overlay ($x, $y, $width, $height[, $rstyle[, $border]])	876	=item $term->overlay ($x, $y, $width, $height[, $rstyle[, $border]])
787		877
788	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
789	width/height. C<$rstyle> defines the initial rendition style	879	width/height. C<$rstyle> defines the initial rendition style
…		…
856		946
857	=item $string = $term->locale_decode ($octets)	947	=item $string = $term->locale_decode ($octets)
858		948
859	Convert the given locale-encoded octets into a perl string.	949	Convert the given locale-encoded octets into a perl string.
860		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
861	=item $term->scr_add_lines ($string)	968	=item $term->scr_add_lines ($string)
862		969
863	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
864	running inside the terminal. It may not contain command sequences (escape	971	running inside the terminal. It may not contain command sequences (escape
865	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
…		…
879		986
880	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
881	pass characters instead of octets, you should convert your strings first	988	pass characters instead of octets, you should convert your strings first
882	to the locale-specific encoding using C<< $term->locale_encode >>.	989	to the locale-specific encoding using C<< $term->locale_encode >>.
883		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.
		997
884	=item $windowid = $term->parent	998	=item $windowid = $term->parent
885		999
886	Return the window id of the toplevel window.	1000	Return the window id of the toplevel window.
887		1001
888	=item $windowid = $term->vt	1002	=item $windowid = $term->vt
…		…
912	=item $nrow_plus_saveLines = $term->total_rows	1026	=item $nrow_plus_saveLines = $term->total_rows
913		1027
914	=item $lines_in_scrollback = $term->nsaved	1028	=item $lines_in_scrollback = $term->nsaved
915		1029
916	Return various integers describing terminal characteristics.	1030	Return various integers describing terminal characteristics.
		1031
		1032	=item $lc_ctype = $term->locale
		1033
		1034	Returns the LC_CTYPE category string used by this rxvt-unicode.
		1035
		1036	=item $x_display = $term->display_id
		1037
		1038	Return the DISPLAY used by rxvt-unicode.
917		1039
918	=item $modifiermask = $term->ModLevel3Mask	1040	=item $modifiermask = $term->ModLevel3Mask
919		1041
920	=item $modifiermask = $term->ModMetaMask	1042	=item $modifiermask = $term->ModMetaMask
921		1043
…		…
1098	$offset / $self->{ncol} + $self->{beg},	1220	$offset / $self->{ncol} + $self->{beg},
1099	$offset % $self->{ncol}	1221	$offset % $self->{ncol}
1100	)	1222	)
1101	}	1223	}
1102		1224
1103	=item ($row, $col) = $line->coord_of ($offset)
1104	=item $text = $term->special_encode $string	1225	=item $text = $term->special_encode $string
1105		1226
1106	Converts a perl string into the special encoding used by rxvt-unicode,	1227	Converts a perl string into the special encoding used by rxvt-unicode,
1107	where one character corresponds to one screen cell. See	1228	where one character corresponds to one screen cell. See
1108	C<< $term->ROW_t >> for details.	1229	C<< $term->ROW_t >> for details.
…		…
1110	=item $string = $term->special_decode $text	1231	=item $string = $term->special_decode $text
1111		1232
1112	Converts rxvt-unicodes text reprsentation into a perl string. See	1233	Converts rxvt-unicodes text reprsentation into a perl string. See
1113	C<< $term->ROW_t >> for details.	1234	C<< $term->ROW_t >> for details.
1114		1235
		1236	=item $success = $term->grab_button ($button, $modifiermask)
		1237
		1238	Registers a synchronous button grab. See the XGrabButton manpage.
		1239
		1240	=item $success = $term->grab ($eventtime[, $sync])
		1241
		1242	Calls XGrabPointer and XGrabKeyboard in asynchronous (default) or
		1243	synchronous (C<$sync> is true). Also remembers the grab timestampe.
		1244
		1245	=item $term->allow_events_async
		1246
		1247	Calls XAllowEvents with AsyncBoth for the most recent grab.
		1248
		1249	=item $term->allow_events_sync
		1250
		1251	Calls XAllowEvents with SyncBoth for the most recent grab.
		1252
		1253	=item $term->allow_events_replay
		1254
		1255	Calls XAllowEvents with both ReplayPointer and ReplayKeyboard for the most
		1256	recent grab.
		1257
		1258	=item $term->ungrab
		1259
		1260	Calls XUngrab for the most recent grab. Is called automatically on
		1261	evaluation errors, as it is better to lose the grab in the error case as
		1262	the session.
		1263
1115	=back	1264	=back
1116		1265
1117	=cut	1266	=cut
1118		1267
1119	package urxvt::popup;	1268	package urxvt::popup;
…		…
1137	}	1286	}
1138		1287
1139	sub add_separator {	1288	sub add_separator {
1140	my ($self, $sep) = @_;	1289	my ($self, $sep) = @_;
1141		1290
1142	$sep \|\|= "═";	1291	$sep \|\|= "=";
1143		1292
1144	$self->add_item ({	1293	$self->add_item ({
1145	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" },
1146	text => "",	1295	text => "",
1147	render => sub { $sep x $urxvt::TERM->ncol },	1296	render => sub { $sep x $self->{term}->ncol },
1148	activate => sub { },	1297	activate => sub { },
1149	});	1298	});
1150	}	1299	}
1151		1300
1152	sub add_title {	1301	sub add_title {
…		…
1160	}	1309	}
1161		1310
1162	sub add_button {	1311	sub add_button {
1163	my ($self, $text, $cb) = @_;	1312	my ($self, $text, $cb) = @_;
1164		1313
1165	$self->add_item ({ type => "button", text => "[ $text ]", activate => $cb});	1314	$self->add_item ({ type => "button", text => $text, activate => $cb});
1166	}	1315	}
1167		1316
1168	sub add_toggle {	1317	sub add_toggle {
1169	my ($self, $text, $cb, $value) = @_;	1318	my ($self, $text, $cb, $value) = @_;
1170		1319
…		…
1182	sub show {	1331	sub show {
1183	my ($self) = @_;	1332	my ($self) = @_;
1184		1333
1185	local $urxvt::popup::self = $self;	1334	local $urxvt::popup::self = $self;
1186		1335
		1336	local $ENV{LC_ALL} = $self->{term}->locale;
		1337
1187	urxvt->new ("--perl-lib" => "", "--perl-ext-common" => "", "-pty-fd" => -1, "-sl" => 0, "-b" => 0,	1338	urxvt->new ("--perl-lib" => "", "--perl-ext-common" => "", "-pty-fd" => -1, "-sl" => 0, "-b" => 0,
1188	"--transient-for" => $self->{term}->parent,	1339	"--transient-for" => $self->{term}->parent,
		1340	"-display" => $self->{term}->display_id,
1189	"-pe" => "urxvt-popup")	1341	"-pe" => "urxvt-popup")
1190	or die "unable to create popup window\n";	1342	or die "unable to create popup window\n";
1191	}	1343	}
1192		1344
1193	sub DESTROY {	1345	sub DESTROY {
…		…
1256		1408
1257	$term->{socket} = ...	1409	$term->{socket} = ...
1258	$term->{iow} = urxvt::iow	1410	$term->{iow} = urxvt::iow
1259	->new	1411	->new
1260	->fd (fileno $term->{socket})	1412	->fd (fileno $term->{socket})
1261	->events (1) # wait for read data	1413	->events (urxvt::EVENT_READ)
1262	->start	1414	->start
1263	->cb (sub {	1415	->cb (sub {
1264	my ($iow, $revents) = @_;	1416	my ($iow, $revents) = @_;
1265	# $revents must be 1 here, no need to check	1417	# $revents must be 1 here, no need to check
1266	sysread $term->{socket}, my $buf, 8192	1418	sysread $term->{socket}, my $buf, 8192
…		…
1283		1435
1284	Set the filedescriptor (not handle) to watch.	1436	Set the filedescriptor (not handle) to watch.
1285		1437
1286	=item $iow = $iow->events ($eventmask)	1438	=item $iow = $iow->events ($eventmask)
1287		1439
1288	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
1289	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>.
1290		1443
1291	=item $iow = $iow->start	1444	=item $iow = $iow->start
1292		1445
1293	Start watching for requested events on the given handle.	1446	Start watching for requested events on the given handle.
1294		1447

Diff Legend

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

Comparing rxvt-unicode/src/urxvt.pm (file contents): Revision 1.59 by root, Mon Jan 9 00:34:36 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.59 by root, Mon Jan 9 00:34:36 2006 UTC vs.
Revision 1.72 by root, Mon Jan 9 23:30:01 2006 UTC