[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.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
…		…
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;
		467
421	our $LIBDIR;	468	our $LIBDIR;
		469	our $RESNAME;
		470	our $RESCLASS;
		471	our $RXVTNAME;
422		472
423	BEGIN {	473	BEGIN {
424	urxvt->bootstrap;	474	urxvt->bootstrap;
425		475
426	# overwrite perl's warn	476	# overwrite perl's warn
…		…
429	$msg .= "\n"	479	$msg .= "\n"
430	unless $msg =~ /\n$/;	480	unless $msg =~ /\n$/;
431	urxvt::warn ($msg);	481	urxvt::warn ($msg);
432	};	482	};
433		483
		484	delete $ENV{IFS};
		485	delete $ENV{CDPATH};
		486	delete $ENV{BASH_ENV};
434	$ENV{PATH} = "/bin:/sbin:/usr/bin:/usr/sbin:/usr/local/bin:/usr/local/sbin:/opt/bin:/opt/sbin";	487	$ENV{PATH} = "/bin:/sbin:/usr/bin:/usr/sbin:/usr/local/bin:/usr/local/sbin:/opt/bin:/opt/sbin";
435	delete $ENV{CDPATH};
436	}	488	}
437		489
438	my @hook_count;	490	my @hook_count;
439	my $verbosity = $ENV{URXVT_PERL_VERBOSITY};	491	my $verbosity = $ENV{URXVT_PERL_VERBOSITY};
440		492
441	sub verbose {	493	sub verbose {
442	my ($level, $msg) = @_;	494	my ($level, $msg) = @_;
443	warn "$msg\n" if $level <= $verbosity;	495	warn "$msg\n" if $level <= $verbosity;
444	}	496	}
445		497
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";	498	my $extension_pkg = "extension0000";
464	my %extension_pkg;	499	my %extension_pkg;
465		500
466	# load a single script into its own package, once only	501	# load a single script into its own package, once only
467	sub extension_package($) {	502	sub extension_package($) {
…		…
473	verbose 3, "loading extension '$path' into package '$pkg'";	508	verbose 3, "loading extension '$path' into package '$pkg'";
474		509
475	open my $fh, "<:raw", $path	510	open my $fh, "<:raw", $path
476	or die "$path: $!";	511	or die "$path: $!";
477		512
		513	my $source = untaint
478	my $source = untaint "package $pkg; use strict; use utf8;\n"	514	"package $pkg; use strict; use utf8;\n"
479	. "use base urxvt::term::proxy::;\n"	515	. "use base urxvt::term::extension::;\n"
480	. "#line 1 \"$path\"\n{\n"	516	. "#line 1 \"$path\"\n{\n"
481	. (do { local $/; <$fh> })	517	. (do { local $/; <$fh> })
482	. "\n};\n1";	518	. "\n};\n1";
483		519
		520	eval $source
484	eval $source or die "$path: $@";	521	or die "$path: $@";
485		522
486	$pkg	523	$pkg
487	}	524	}
488	}	525	}
489		526
…		…
495	my $htype = shift;	532	my $htype = shift;
496		533
497	if ($htype == 0) { # INIT	534	if ($htype == 0) { # INIT
498	my @dirs = ((split /:/, $TERM->resource ("perl_lib")), "$LIBDIR/perl");	535	my @dirs = ((split /:/, $TERM->resource ("perl_lib")), "$LIBDIR/perl");
499		536
500	my %want_ext;	537	my %ext_arg;
501		538
502	for (map { split /,/, $TERM->resource ("perl_ext_$_") } 1, 2) {	539	for (map { split /,/, $TERM->resource ("perl_ext_$_") } 1, 2) {
503	if ($_ eq "default") {	540	if ($_ eq "default") {
504	$want_ext{$_}++ for qw(selection option-popup selection-popup);	541	$ext_arg{$_} \|\|= [] for qw(selection option-popup selection-popup searchable-scrollback);
505	} elsif (/^-(.*)$/) {	542	} elsif (/^-(.*)$/) {
506	delete $want_ext{$1};	543	delete $ext_arg{$1};
		544	} elsif (/^([^<]+)<(.*)>$/) {
		545	push @{ $ext_arg{$1} }, $2;
507	} else {	546	} else {
508	$want_ext{$_}++;	547	$ext_arg{$_} \|\|= [];
509	}	548	}
510	}	549	}
511		550
512	for my $ext (keys %want_ext) {	551	while (my ($ext, $argv) = each %ext_arg) {
513	my @files = grep -f $_, map "$_/$ext", @dirs;	552	my @files = grep -f $_, map "$_/$ext", @dirs;
514		553
515	if (@files) {	554	if (@files) {
516	register_package extension_package $files[0];	555	$TERM->register_package (extension_package $files[0], $argv);
517	} else {	556	} else {
518	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";
519	}	558	}
520	}	559	}
521		560
…		…
530	if $verbosity >= 10;	569	if $verbosity >= 10;
531		570
532	keys %$cb;	571	keys %$cb;
533		572
534	while (my ($pkg, $cb) = each %$cb) {	573	while (my ($pkg, $cb) = each %$cb) {
535	eval {	574	$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;	575	and last;
544	};	576
545	if ($@) {	577	if ($@) {
546	$TERM->ungrab; # better to lose the grab than the session	578	$TERM->ungrab; # better to lose the grab than the session
547	warn $@;	579	warn $@;
548	}	580	}
549	}	581	}
550	}	582	}
551		583
552	if ($htype == 1) { # DESTROY	584	if ($htype == 1) { # DESTROY
553	# remove hooks if unused
554	if (my $hook = $TERM->{_hook}) {	585	if (my $hook = delete $TERM->{_hook}) {
555	for my $htype (0..$#$hook) {	586	for my $htype (0..$#$hook) {
556	$hook_count[$htype] -= scalar keys %{ $hook->[$htype] \|\| {} }	587	$hook_count[$htype] -= scalar keys %{ $hook->[$htype] \|\| {} }
557	or set_should_invoke $htype, 0;	588	or set_should_invoke $htype, 0;
558	}	589	}
559	}	590	}
…		…
566	}	597	}
567		598
568	$retval	599	$retval
569	}	600	}
570		601
571	# urxvt::term::proxy	602	# urxvt::term::extension
572		603
573	sub urxvt::term::proxy::AUTOLOAD {	604	package urxvt::term::extension;
574	$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 =~ /:([^:]+)$/
575	or die "FATAL: \$AUTOLOAD '$urxvt::term::proxy::AUTOLOAD' unparsable";	644	or die "FATAL: \$AUTOLOAD '$AUTOLOAD' unparsable";
576		645
577	eval qq{	646	eval qq{
578	sub $urxvt::term::proxy::AUTOLOAD {	647	sub $AUTOLOAD {
579	my \$proxy = shift;	648	my \$proxy = shift;
580	\$proxy->{term}->$1 (\@_)	649	\$proxy->{term}->$1 (\@_)
581	}	650	}
582	1	651	1
583	} or die "FATAL: unable to compile method forwarder: $@";	652	} or die "FATAL: unable to compile method forwarder: $@";
584		653
585	goto &$urxvt::term::proxy::AUTOLOAD;	654	goto &$AUTOLOAD;
586	}	655	}
587		656
588	sub urxvt::term::proxy::DESTROY {	657	sub DESTROY {
589	# nop	658	# nop
590	}	659	}
591		660
592	# urxvt::destroy_hook	661	# urxvt::destroy_hook
593		662
…		…
660	${$_[0]}++;	729	${$_[0]}++;
661	}	730	}
662		731
663	sub urxvt::anyevent::condvar::wait {	732	sub urxvt::anyevent::condvar::wait {
664	unless (${$_[0]}) {	733	unless (${$_[0]}) {
665	require Carp;
666	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";
667	}	735	}
668	}	736	}
669		737
670	package urxvt::term;	738	package urxvt::term;
671		739
672	=head2 The C<urxvt::term> Class	740	=head2 The C<urxvt::term> Class
673		741
674	=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	}
675		765
676	=item $term->destroy	766	=item $term->destroy
677		767
678	Destroy the terminal object (close the window, free resources etc.).	768	Destroy the terminal object (close the window, free resources etc.).
679		769
…		…
733	my ($self, $name) = (shift, shift);	823	my ($self, $name) = (shift, shift);
734	unshift @_, $self, $name, ($name =~ s/\s\+\s(\d+)$// ? $1 : 0);	824	unshift @_, $self, $name, ($name =~ s/\s\+\s(\d+)$// ? $1 : 0);
735	&urxvt::term::_resource	825	&urxvt::term::_resource
736	}	826	}
737		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
738	=item $rend = $term->rstyle ([$new_rstyle])	833	=item $rend = $term->rstyle ([$new_rstyle])
739		834
740	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
741	the terminal application will use this style.	836	the terminal application will use this style.
742		837
…		…
761		856
762	=item $oldtext = $term->selection ([$newtext])	857	=item $oldtext = $term->selection ([$newtext])
763		858
764	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>.
765		860
766	#=item $term->overlay ($x, $y, $text)	861	=item $term->overlay_simple ($x, $y, $text)
767	#	862
768	#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.
769	#	864
770	#=cut	865	=cut
771	#	866
772	#sub urxvt::term::scr_overlay {	867	sub overlay_simple {
773	# my ($self, $x, $y, $text) = @_;	868	my ($self, $x, $y, $text) = @_;
774	#	869
775	# my @lines = split /\n/, $text;	870	my @lines = split /\n/, $text;
776	#	871
777	# my $w = 0;	872	my $w = List::Util::max map $self->strwidth ($_), @lines;
778	# for (map $self->strwidth ($_), @lines) {	873
779	# $w = $_ if $w < $_;
780	# }
781	#
782	# $self->scr_overlay_new ($x, $y, $w, scalar @lines);	874	my $overlay = $self->overlay ($x, $y, $w, scalar @lines);
783	# $self->scr_overlay_set (0, $_, $lines[$_]) for 0.. $#lines;	875	$overlay->set (0, $_, $lines[$_]) for 0.. $#lines;
784	#}	876
		877	$overlay
		878	}
785		879
786	=item $term->overlay ($x, $y, $width, $height[, $rstyle[, $border]])	880	=item $term->overlay ($x, $y, $width, $height[, $rstyle[, $border]])
787		881
788	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
789	width/height. C<$rstyle> defines the initial rendition style	883	width/height. C<$rstyle> defines the initial rendition style
…		…
856		950
857	=item $string = $term->locale_decode ($octets)	951	=item $string = $term->locale_decode ($octets)
858		952
859	Convert the given locale-encoded octets into a perl string.	953	Convert the given locale-encoded octets into a perl string.
860		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
861	=item $term->scr_add_lines ($string)	972	=item $term->scr_add_lines ($string)
862		973
863	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
864	running inside the terminal. It may not contain command sequences (escape	975	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	976	codes), but is free to use line feeds, carriage returns and tabs. The
…		…
879		990
880	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
881	pass characters instead of octets, you should convert your strings first	992	pass characters instead of octets, you should convert your strings first
882	to the locale-specific encoding using C<< $term->locale_encode >>.	993	to the locale-specific encoding using C<< $term->locale_encode >>.
883		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.
		1001
884	=item $windowid = $term->parent	1002	=item $windowid = $term->parent
885		1003
886	Return the window id of the toplevel window.	1004	Return the window id of the toplevel window.
887		1005
888	=item $windowid = $term->vt	1006	=item $windowid = $term->vt
…		…
912	=item $nrow_plus_saveLines = $term->total_rows	1030	=item $nrow_plus_saveLines = $term->total_rows
913		1031
914	=item $lines_in_scrollback = $term->nsaved	1032	=item $lines_in_scrollback = $term->nsaved
915		1033
916	Return various integers describing terminal characteristics.	1034	Return various integers describing terminal characteristics.
		1035
		1036	=item $lc_ctype = $term->locale
		1037
		1038	Returns the LC_CTYPE category string used by this rxvt-unicode.
		1039
		1040	=item $x_display = $term->display_id
		1041
		1042	Return the DISPLAY used by rxvt-unicode.
917		1043
918	=item $modifiermask = $term->ModLevel3Mask	1044	=item $modifiermask = $term->ModLevel3Mask
919		1045
920	=item $modifiermask = $term->ModMetaMask	1046	=item $modifiermask = $term->ModMetaMask
921		1047
…		…
1098	$offset / $self->{ncol} + $self->{beg},	1224	$offset / $self->{ncol} + $self->{beg},
1099	$offset % $self->{ncol}	1225	$offset % $self->{ncol}
1100	)	1226	)
1101	}	1227	}
1102		1228
1103	=item ($row, $col) = $line->coord_of ($offset)
1104	=item $text = $term->special_encode $string	1229	=item $text = $term->special_encode $string
1105		1230
1106	Converts a perl string into the special encoding used by rxvt-unicode,	1231	Converts a perl string into the special encoding used by rxvt-unicode,
1107	where one character corresponds to one screen cell. See	1232	where one character corresponds to one screen cell. See
1108	C<< $term->ROW_t >> for details.	1233	C<< $term->ROW_t >> for details.
…		…
1110	=item $string = $term->special_decode $text	1235	=item $string = $term->special_decode $text
1111		1236
1112	Converts rxvt-unicodes text reprsentation into a perl string. See	1237	Converts rxvt-unicodes text reprsentation into a perl string. See
1113	C<< $term->ROW_t >> for details.	1238	C<< $term->ROW_t >> for details.
1114		1239
		1240	=item $success = $term->grab_button ($button, $modifiermask)
		1241
		1242	Registers a synchronous button grab. See the XGrabButton manpage.
		1243
		1244	=item $success = $term->grab ($eventtime[, $sync])
		1245
		1246	Calls XGrabPointer and XGrabKeyboard in asynchronous (default) or
		1247	synchronous (C<$sync> is true). Also remembers the grab timestampe.
		1248
		1249	=item $term->allow_events_async
		1250
		1251	Calls XAllowEvents with AsyncBoth for the most recent grab.
		1252
		1253	=item $term->allow_events_sync
		1254
		1255	Calls XAllowEvents with SyncBoth for the most recent grab.
		1256
		1257	=item $term->allow_events_replay
		1258
		1259	Calls XAllowEvents with both ReplayPointer and ReplayKeyboard for the most
		1260	recent grab.
		1261
		1262	=item $term->ungrab
		1263
		1264	Calls XUngrab for the most recent grab. Is called automatically on
		1265	evaluation errors, as it is better to lose the grab in the error case as
		1266	the session.
		1267
1115	=back	1268	=back
1116		1269
1117	=cut	1270	=cut
1118		1271
1119	package urxvt::popup;	1272	package urxvt::popup;
…		…
1137	}	1290	}
1138		1291
1139	sub add_separator {	1292	sub add_separator {
1140	my ($self, $sep) = @_;	1293	my ($self, $sep) = @_;
1141		1294
1142	$sep \|\|= "═";	1295	$sep \|\|= "=";
1143		1296
1144	$self->add_item ({	1297	$self->add_item ({
1145	rend => { normal => "\x1b[0;30;47m", hover => "\x1b[0;30;47m", active => "\x1b[0;30;47m" },	1298	rend => { normal => "\x1b[0;30;47m", hover => "\x1b[0;30;47m", active => "\x1b[0;30;47m" },
1146	text => "",	1299	text => "",
1147	render => sub { $sep x $urxvt::TERM->ncol },	1300	render => sub { $sep x $self->{term}->ncol },
1148	activate => sub { },	1301	activate => sub { },
1149	});	1302	});
1150	}	1303	}
1151		1304
1152	sub add_title {	1305	sub add_title {
…		…
1160	}	1313	}
1161		1314
1162	sub add_button {	1315	sub add_button {
1163	my ($self, $text, $cb) = @_;	1316	my ($self, $text, $cb) = @_;
1164		1317
1165	$self->add_item ({ type => "button", text => "[ $text ]", activate => $cb});	1318	$self->add_item ({ type => "button", text => $text, activate => $cb});
1166	}	1319	}
1167		1320
1168	sub add_toggle {	1321	sub add_toggle {
1169	my ($self, $text, $cb, $value) = @_;	1322	my ($self, $text, $cb, $value) = @_;
1170		1323
…		…
1182	sub show {	1335	sub show {
1183	my ($self) = @_;	1336	my ($self) = @_;
1184		1337
1185	local $urxvt::popup::self = $self;	1338	local $urxvt::popup::self = $self;
1186		1339
		1340	local $ENV{LC_ALL} = $self->{term}->locale;
		1341
1187	urxvt->new ("--perl-lib" => "", "--perl-ext-common" => "", "-pty-fd" => -1, "-sl" => 0, "-b" => 0,	1342	urxvt->new ("--perl-lib" => "", "--perl-ext-common" => "", "-pty-fd" => -1, "-sl" => 0, "-b" => 0,
1188	"--transient-for" => $self->{term}->parent,	1343	"--transient-for" => $self->{term}->parent,
		1344	"-display" => $self->{term}->display_id,
1189	"-pe" => "urxvt-popup")	1345	"-pe" => "urxvt-popup")
1190	or die "unable to create popup window\n";	1346	or die "unable to create popup window\n";
1191	}	1347	}
1192		1348
1193	sub DESTROY {	1349	sub DESTROY {
…		…
1256		1412
1257	$term->{socket} = ...	1413	$term->{socket} = ...
1258	$term->{iow} = urxvt::iow	1414	$term->{iow} = urxvt::iow
1259	->new	1415	->new
1260	->fd (fileno $term->{socket})	1416	->fd (fileno $term->{socket})
1261	->events (1) # wait for read data	1417	->events (urxvt::EVENT_READ)
1262	->start	1418	->start
1263	->cb (sub {	1419	->cb (sub {
1264	my ($iow, $revents) = @_;	1420	my ($iow, $revents) = @_;
1265	# $revents must be 1 here, no need to check	1421	# $revents must be 1 here, no need to check
1266	sysread $term->{socket}, my $buf, 8192	1422	sysread $term->{socket}, my $buf, 8192
…		…
1283		1439
1284	Set the filedescriptor (not handle) to watch.	1440	Set the filedescriptor (not handle) to watch.
1285		1441
1286	=item $iow = $iow->events ($eventmask)	1442	=item $iow = $iow->events ($eventmask)
1287		1443
1288	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
1289	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>.
1290		1447
1291	=item $iow = $iow->start	1448	=item $iow = $iow->start
1292		1449
1293	Start watching for requested events on the given handle.	1450	Start watching for requested events on the given handle.
1294		1451

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