[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.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
…		…
204	than the scroll back buffer or the terminal.	244	than the scroll back buffer or the terminal.
205		245
206	It is called before lines are scrolled out (so rows 0 .. min ($lines - 1,	246	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	247	$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.	248	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		249
214	=item on_osc_seq $term, $string	250	=item on_osc_seq $term, $string
215		251
216	Called whenever the B<ESC ] 777 ; string ST> command sequence (OSC =	252	Called whenever the B<ESC ] 777 ; string ST> command sequence (OSC =
217	operating system command) is processed. Cursor position and other state	253	operating system command) is processed. Cursor position and other state
…		…
230	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
231	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
232	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
233	output.	269	output.
234		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
235	=item on_line_update $term, $row	276	=item on_line_update $term, $row
236		277
237	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
238	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
239	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,
…		…
271	=item on_focus_out $term	312	=item on_focus_out $term
272		313
273	Called wheneever the window loses keyboard focus, before rxvt-unicode does	314	Called wheneever the window loses keyboard focus, before rxvt-unicode does
274	focus out processing.	315	focus out processing.
275		316
276	=item on_key_press $term, $event, $octets	317	=item on_key_press $term, $event, $keysym, $octets
277		318
278	=item on_key_release $term, $event	319	=item on_key_release $term, $event, $keysym
279		320
280	=item on_button_press $term, $event	321	=item on_button_press $term, $event
281		322
282	=item on_button_release $term, $event	323	=item on_button_release $term, $event
283		324
…		…
337	that calls this function.	378	that calls this function.
338		379
339	Using this function has the advantage that its output ends up in the	380	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.	381	correct place, e.g. on stderr of the connecting urxvtc client.
341		382
		383	=item $is_safe = urxvt::safe
		384
		385	Returns true when it is safe to do potentially unsafe things, such as
		386	evaluating perl code specified by the user. This is true when urxvt was
		387	started setuid or setgid.
		388
342	=item $time = urxvt::NOW	389	=item $time = urxvt::NOW
343		390
344	Returns the "current time" (as per the event loop).	391	Returns the "current time" (as per the event loop).
345		392
346	=item urxvt::CurrentTime	393	=item urxvt::CurrentTime
…		…
409		456
410	package urxvt;	457	package urxvt;
411		458
412	use utf8;	459	use utf8;
413	use strict;	460	use strict;
		461	use Carp ();
414	use Scalar::Util ();	462	use Scalar::Util ();
415	use List::Util ();	463	use List::Util ();
416		464
417	our $VERSION = 1;	465	our $VERSION = 1;
418	our $TERM;	466	our $TERM;
419	our @HOOKNAME;	467	our @HOOKNAME;
		468	our %HOOKTYPE = map +($HOOKNAME[$_] => $_), 0..$#HOOKNAME;
420	our %OPTION;	469	our %OPTION;
		470
421	our $LIBDIR;	471	our $LIBDIR;
		472	our $RESNAME;
		473	our $RESCLASS;
		474	our $RXVTNAME;
422		475
423	BEGIN {	476	BEGIN {
424	urxvt->bootstrap;	477	urxvt->bootstrap;
425		478
426	# overwrite perl's warn	479	# overwrite perl's warn
…		…
429	$msg .= "\n"	482	$msg .= "\n"
430	unless $msg =~ /\n$/;	483	unless $msg =~ /\n$/;
431	urxvt::warn ($msg);	484	urxvt::warn ($msg);
432	};	485	};
433		486
		487	delete $ENV{IFS};
		488	delete $ENV{CDPATH};
		489	delete $ENV{BASH_ENV};
434	$ENV{PATH} = "/bin:/sbin:/usr/bin:/usr/sbin:/usr/local/bin:/usr/local/sbin:/opt/bin:/opt/sbin";	490	$ENV{PATH} = "/bin:/sbin:/usr/bin:/usr/sbin:/usr/local/bin:/usr/local/sbin:/opt/bin:/opt/sbin";
435	delete $ENV{CDPATH};
436	}	491	}
437		492
438	my @hook_count;	493	my @hook_count;
439	my $verbosity = $ENV{URXVT_PERL_VERBOSITY};	494	my $verbosity = $ENV{URXVT_PERL_VERBOSITY};
440		495
441	sub verbose {	496	sub verbose {
442	my ($level, $msg) = @_;	497	my ($level, $msg) = @_;
443	warn "$msg\n" if $level <= $verbosity;	498	warn "$msg\n" if $level <= $verbosity;
444	}	499	}
445		500
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";	501	my $extension_pkg = "extension0000";
464	my %extension_pkg;	502	my %extension_pkg;
465		503
466	# load a single script into its own package, once only	504	# load a single script into its own package, once only
467	sub extension_package($) {	505	sub extension_package($) {
…		…
473	verbose 3, "loading extension '$path' into package '$pkg'";	511	verbose 3, "loading extension '$path' into package '$pkg'";
474		512
475	open my $fh, "<:raw", $path	513	open my $fh, "<:raw", $path
476	or die "$path: $!";	514	or die "$path: $!";
477		515
		516	my $source = untaint
478	my $source = untaint "package $pkg; use strict; use utf8;\n"	517	"package $pkg; use strict; use utf8;\n"
479	. "use base urxvt::term::proxy::;\n"	518	. "use base urxvt::term::extension::;\n"
480	. "#line 1 \"$path\"\n{\n"	519	. "#line 1 \"$path\"\n{\n"
481	. (do { local $/; <$fh> })	520	. (do { local $/; <$fh> })
482	. "\n};\n1";	521	. "\n};\n1";
483		522
		523	eval $source
484	eval $source or die "$path: $@";	524	or die "$path: $@";
485		525
486	$pkg	526	$pkg
487	}	527	}
488	}	528	}
489		529
…		…
495	my $htype = shift;	535	my $htype = shift;
496		536
497	if ($htype == 0) { # INIT	537	if ($htype == 0) { # INIT
498	my @dirs = ((split /:/, $TERM->resource ("perl_lib")), "$LIBDIR/perl");	538	my @dirs = ((split /:/, $TERM->resource ("perl_lib")), "$LIBDIR/perl");
499		539
500	my %want_ext;	540	my %ext_arg;
501		541
502	for (map { split /,/, $TERM->resource ("perl_ext_$_") } 1, 2) {	542	for (map { split /,/, $TERM->resource ("perl_ext_$_") } 1, 2) {
503	if ($_ eq "default") {	543	if ($_ eq "default") {
504	$want_ext{$_}++ for qw(selection option-popup selection-popup);	544	$ext_arg{$_} \|\|= [] for qw(selection option-popup selection-popup searchable-scrollback);
505	} elsif (/^-(.*)$/) {	545	} elsif (/^-(.*)$/) {
506	delete $want_ext{$1};	546	delete $ext_arg{$1};
		547	} elsif (/^([^<]+)<(.*)>$/) {
		548	push @{ $ext_arg{$1} }, $2;
507	} else {	549	} else {
508	$want_ext{$_}++;	550	$ext_arg{$_} \|\|= [];
509	}	551	}
510	}	552	}
511		553
512	for my $ext (keys %want_ext) {	554	while (my ($ext, $argv) = each %ext_arg) {
513	my @files = grep -f $_, map "$_/$ext", @dirs;	555	my @files = grep -f $_, map "$_/$ext", @dirs;
514		556
515	if (@files) {	557	if (@files) {
516	register_package extension_package $files[0];	558	$TERM->register_package (extension_package $files[0], $argv);
517	} else {	559	} else {
518	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";
519	}	561	}
520	}	562	}
521		563
…		…
530	if $verbosity >= 10;	572	if $verbosity >= 10;
531		573
532	keys %$cb;	574	keys %$cb;
533		575
534	while (my ($pkg, $cb) = each %$cb) {	576	while (my ($pkg, $cb) = each %$cb) {
535	eval {	577	$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;	578	and last;
544	};	579
545	if ($@) {	580	if ($@) {
546	$TERM->ungrab; # better to lose the grab than the session	581	$TERM->ungrab; # better to lose the grab than the session
547	warn $@;	582	warn $@;
548	}	583	}
549	}	584	}
550	}	585	}
551		586
552	if ($htype == 1) { # DESTROY	587	if ($htype == 1) { # DESTROY
553	# remove hooks if unused
554	if (my $hook = $TERM->{_hook}) {	588	if (my $hook = delete $TERM->{_hook}) {
555	for my $htype (0..$#$hook) {	589	for my $htype (0..$#$hook) {
556	$hook_count[$htype] -= scalar keys %{ $hook->[$htype] \|\| {} }	590	$hook_count[$htype] -= scalar keys %{ $hook->[$htype] \|\| {} }
557	or set_should_invoke $htype, 0;	591	or set_should_invoke $htype, 0;
558	}	592	}
559	}	593	}
…		…
566	}	600	}
567		601
568	$retval	602	$retval
569	}	603	}
570		604
571	# urxvt::term::proxy	605	# urxvt::term::extension
572		606
573	sub urxvt::term::proxy::AUTOLOAD {	607	package urxvt::term::extension;
574	$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 =~ /:([^:]+)$/
575	or die "FATAL: \$AUTOLOAD '$urxvt::term::proxy::AUTOLOAD' unparsable";	647	or die "FATAL: \$AUTOLOAD '$AUTOLOAD' unparsable";
576		648
577	eval qq{	649	eval qq{
578	sub $urxvt::term::proxy::AUTOLOAD {	650	sub $AUTOLOAD {
579	my \$proxy = shift;	651	my \$proxy = shift;
580	\$proxy->{term}->$1 (\@_)	652	\$proxy->{term}->$1 (\@_)
581	}	653	}
582	1	654	1
583	} or die "FATAL: unable to compile method forwarder: $@";	655	} or die "FATAL: unable to compile method forwarder: $@";
584		656
585	goto &$urxvt::term::proxy::AUTOLOAD;	657	goto &$AUTOLOAD;
586	}	658	}
587		659
588	sub urxvt::term::proxy::DESTROY {	660	sub DESTROY {
589	# nop	661	# nop
590	}	662	}
591		663
592	# urxvt::destroy_hook	664	# urxvt::destroy_hook
593		665
…		…
660	${$_[0]}++;	732	${$_[0]}++;
661	}	733	}
662		734
663	sub urxvt::anyevent::condvar::wait {	735	sub urxvt::anyevent::condvar::wait {
664	unless (${$_[0]}) {	736	unless (${$_[0]}) {
665	require Carp;
666	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";
667	}	738	}
668	}	739	}
669		740
670	package urxvt::term;	741	package urxvt::term;
671		742
672	=head2 The C<urxvt::term> Class	743	=head2 The C<urxvt::term> Class
673		744
674	=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	}
675		768
676	=item $term->destroy	769	=item $term->destroy
677		770
678	Destroy the terminal object (close the window, free resources etc.).	771	Destroy the terminal object (close the window, free resources etc.).
679		772
…		…
733	my ($self, $name) = (shift, shift);	826	my ($self, $name) = (shift, shift);
734	unshift @_, $self, $name, ($name =~ s/\s\+\s(\d+)$// ? $1 : 0);	827	unshift @_, $self, $name, ($name =~ s/\s\+\s(\d+)$// ? $1 : 0);
735	&urxvt::term::_resource	828	&urxvt::term::_resource
736	}	829	}
737		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
738	=item $rend = $term->rstyle ([$new_rstyle])	836	=item $rend = $term->rstyle ([$new_rstyle])
739		837
740	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
741	the terminal application will use this style.	839	the terminal application will use this style.
742		840
…		…
761		859
762	=item $oldtext = $term->selection ([$newtext])	860	=item $oldtext = $term->selection ([$newtext])
763		861
764	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>.
765		863
766	#=item $term->overlay ($x, $y, $text)	864	=item $term->overlay_simple ($x, $y, $text)
767	#	865
768	#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.
769	#	867
770	#=cut	868	=cut
771	#	869
772	#sub urxvt::term::scr_overlay {	870	sub overlay_simple {
773	# my ($self, $x, $y, $text) = @_;	871	my ($self, $x, $y, $text) = @_;
774	#	872
775	# my @lines = split /\n/, $text;	873	my @lines = split /\n/, $text;
776	#	874
777	# my $w = 0;	875	my $w = List::Util::max map $self->strwidth ($_), @lines;
778	# for (map $self->strwidth ($_), @lines) {	876
779	# $w = $_ if $w < $_;
780	# }
781	#
782	# $self->scr_overlay_new ($x, $y, $w, scalar @lines);	877	my $overlay = $self->overlay ($x, $y, $w, scalar @lines);
783	# $self->scr_overlay_set (0, $_, $lines[$_]) for 0.. $#lines;	878	$overlay->set (0, $_, $lines[$_]) for 0.. $#lines;
784	#}	879
		880	$overlay
		881	}
785		882
786	=item $term->overlay ($x, $y, $width, $height[, $rstyle[, $border]])	883	=item $term->overlay ($x, $y, $width, $height[, $rstyle[, $border]])
787		884
788	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
789	width/height. C<$rstyle> defines the initial rendition style	886	width/height. C<$rstyle> defines the initial rendition style
…		…
856		953
857	=item $string = $term->locale_decode ($octets)	954	=item $string = $term->locale_decode ($octets)
858		955
859	Convert the given locale-encoded octets into a perl string.	956	Convert the given locale-encoded octets into a perl string.
860		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
861	=item $term->scr_add_lines ($string)	975	=item $term->scr_add_lines ($string)
862		976
863	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
864	running inside the terminal. It may not contain command sequences (escape	978	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	979	codes), but is free to use line feeds, carriage returns and tabs. The
…		…
879		993
880	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
881	pass characters instead of octets, you should convert your strings first	995	pass characters instead of octets, you should convert your strings first
882	to the locale-specific encoding using C<< $term->locale_encode >>.	996	to the locale-specific encoding using C<< $term->locale_encode >>.
883		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.
		1004
884	=item $windowid = $term->parent	1005	=item $windowid = $term->parent
885		1006
886	Return the window id of the toplevel window.	1007	Return the window id of the toplevel window.
887		1008
888	=item $windowid = $term->vt	1009	=item $windowid = $term->vt
…		…
912	=item $nrow_plus_saveLines = $term->total_rows	1033	=item $nrow_plus_saveLines = $term->total_rows
913		1034
914	=item $lines_in_scrollback = $term->nsaved	1035	=item $lines_in_scrollback = $term->nsaved
915		1036
916	Return various integers describing terminal characteristics.	1037	Return various integers describing terminal characteristics.
		1038
		1039	=item $lc_ctype = $term->locale
		1040
		1041	Returns the LC_CTYPE category string used by this rxvt-unicode.
		1042
		1043	=item $x_display = $term->display_id
		1044
		1045	Return the DISPLAY used by rxvt-unicode.
917		1046
918	=item $modifiermask = $term->ModLevel3Mask	1047	=item $modifiermask = $term->ModLevel3Mask
919		1048
920	=item $modifiermask = $term->ModMetaMask	1049	=item $modifiermask = $term->ModMetaMask
921		1050
…		…
1098	$offset / $self->{ncol} + $self->{beg},	1227	$offset / $self->{ncol} + $self->{beg},
1099	$offset % $self->{ncol}	1228	$offset % $self->{ncol}
1100	)	1229	)
1101	}	1230	}
1102		1231
1103	=item ($row, $col) = $line->coord_of ($offset)
1104	=item $text = $term->special_encode $string	1232	=item $text = $term->special_encode $string
1105		1233
1106	Converts a perl string into the special encoding used by rxvt-unicode,	1234	Converts a perl string into the special encoding used by rxvt-unicode,
1107	where one character corresponds to one screen cell. See	1235	where one character corresponds to one screen cell. See
1108	C<< $term->ROW_t >> for details.	1236	C<< $term->ROW_t >> for details.
…		…
1110	=item $string = $term->special_decode $text	1238	=item $string = $term->special_decode $text
1111		1239
1112	Converts rxvt-unicodes text reprsentation into a perl string. See	1240	Converts rxvt-unicodes text reprsentation into a perl string. See
1113	C<< $term->ROW_t >> for details.	1241	C<< $term->ROW_t >> for details.
1114		1242
		1243	=item $success = $term->grab_button ($button, $modifiermask)
		1244
		1245	Registers a synchronous button grab. See the XGrabButton manpage.
		1246
		1247	=item $success = $term->grab ($eventtime[, $sync])
		1248
		1249	Calls XGrabPointer and XGrabKeyboard in asynchronous (default) or
		1250	synchronous (C<$sync> is true). Also remembers the grab timestampe.
		1251
		1252	=item $term->allow_events_async
		1253
		1254	Calls XAllowEvents with AsyncBoth for the most recent grab.
		1255
		1256	=item $term->allow_events_sync
		1257
		1258	Calls XAllowEvents with SyncBoth for the most recent grab.
		1259
		1260	=item $term->allow_events_replay
		1261
		1262	Calls XAllowEvents with both ReplayPointer and ReplayKeyboard for the most
		1263	recent grab.
		1264
		1265	=item $term->ungrab
		1266
		1267	Calls XUngrab for the most recent grab. Is called automatically on
		1268	evaluation errors, as it is better to lose the grab in the error case as
		1269	the session.
		1270
1115	=back	1271	=back
1116		1272
1117	=cut	1273	=cut
1118		1274
1119	package urxvt::popup;	1275	package urxvt::popup;
…		…
1137	}	1293	}
1138		1294
1139	sub add_separator {	1295	sub add_separator {
1140	my ($self, $sep) = @_;	1296	my ($self, $sep) = @_;
1141		1297
1142	$sep \|\|= "═";	1298	$sep \|\|= "=";
1143		1299
1144	$self->add_item ({	1300	$self->add_item ({
1145	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" },
1146	text => "",	1302	text => "",
1147	render => sub { $sep x $urxvt::TERM->ncol },	1303	render => sub { $sep x $self->{term}->ncol },
1148	activate => sub { },	1304	activate => sub { },
1149	});	1305	});
1150	}	1306	}
1151		1307
1152	sub add_title {	1308	sub add_title {
…		…
1160	}	1316	}
1161		1317
1162	sub add_button {	1318	sub add_button {
1163	my ($self, $text, $cb) = @_;	1319	my ($self, $text, $cb) = @_;
1164		1320
1165	$self->add_item ({ type => "button", text => "[ $text ]", activate => $cb});	1321	$self->add_item ({ type => "button", text => $text, activate => $cb});
1166	}	1322	}
1167		1323
1168	sub add_toggle {	1324	sub add_toggle {
1169	my ($self, $text, $cb, $value) = @_;	1325	my ($self, $text, $cb, $value) = @_;
1170		1326
…		…
1182	sub show {	1338	sub show {
1183	my ($self) = @_;	1339	my ($self) = @_;
1184		1340
1185	local $urxvt::popup::self = $self;	1341	local $urxvt::popup::self = $self;
1186		1342
		1343	local $ENV{LC_ALL} = $self->{term}->locale;
		1344
1187	urxvt->new ("--perl-lib" => "", "--perl-ext-common" => "", "-pty-fd" => -1, "-sl" => 0, "-b" => 0,	1345	urxvt->new ("--perl-lib" => "", "--perl-ext-common" => "", "-pty-fd" => -1, "-sl" => 0, "-b" => 0,
1188	"--transient-for" => $self->{term}->parent,	1346	"--transient-for" => $self->{term}->parent,
		1347	"-display" => $self->{term}->display_id,
1189	"-pe" => "urxvt-popup")	1348	"-pe" => "urxvt-popup")
1190	or die "unable to create popup window\n";	1349	or die "unable to create popup window\n";
1191	}	1350	}
1192		1351
1193	sub DESTROY {	1352	sub DESTROY {
…		…
1256		1415
1257	$term->{socket} = ...	1416	$term->{socket} = ...
1258	$term->{iow} = urxvt::iow	1417	$term->{iow} = urxvt::iow
1259	->new	1418	->new
1260	->fd (fileno $term->{socket})	1419	->fd (fileno $term->{socket})
1261	->events (1) # wait for read data	1420	->events (urxvt::EVENT_READ)
1262	->start	1421	->start
1263	->cb (sub {	1422	->cb (sub {
1264	my ($iow, $revents) = @_;	1423	my ($iow, $revents) = @_;
1265	# $revents must be 1 here, no need to check	1424	# $revents must be 1 here, no need to check
1266	sysread $term->{socket}, my $buf, 8192	1425	sysread $term->{socket}, my $buf, 8192
…		…
1283		1442
1284	Set the filedescriptor (not handle) to watch.	1443	Set the filedescriptor (not handle) to watch.
1285		1444
1286	=item $iow = $iow->events ($eventmask)	1445	=item $iow = $iow->events ($eventmask)
1287		1446
1288	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
1289	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>.
1290		1450
1291	=item $iow = $iow->start	1451	=item $iow = $iow->start
1292		1452
1293	Start watching for requested events on the given handle.	1453	Start watching for requested events on the given handle.
1294		1454

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