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

Comparing rxvt-unicode/src/urxvt.pm (file contents):
Revision 1.57 by root, Sun Jan 8 08:43:11 2006 UTC vs.
Revision 1.71 by root, Mon Jan 9 23:18:49 2006 UTC

…		…
58		58
59	=back	59	=back
60		60
61	=item option-popup (enabled by default)	61	=item option-popup (enabled by default)
62		62
63	Binds a popup menu to Ctrl-Button3 that lets you toggle (some) options at	63	Binds a popup menu to Ctrl-Button2 that lets you toggle (some) options at
64	runtime.	64	runtime.
		65
		66	=item selection-popup (enabled by default)
		67
		68	Binds a popup menu to Ctrl-Button3 that lets you convert the selection
		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.
65		78
66	=item digital-clock	79	=item digital-clock
67		80
68	Displays a digital clock using the built-in overlay.	81	Displays a digital clock using the built-in overlay.
69		82
…		…
119	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
120	locale-specific way.	133	locale-specific way.
121		134
122	=back	135	=back
123		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
124	=head2 Hooks	170	=head2 Hooks
125		171
126	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
127	called whenever the relevant event happens.	173	called whenever the relevant event happens.
128		174
129	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
130	and extension package. You can call all C<urxvt::term> methods on it, but	176	the in the C<Extension Objects> section.
131	its not a real C<urxvt::term> object. Instead, the real C<urxvt::term>
132	object that is shared between all packages is stored in the C<term>
133	member. It is, however, blessed intot he package of the extension script,
134	so for all practical purposes you can treat an extension script as a class.
135		177
136	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
137	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
138	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.
139		181
140	When in doubt, return a false value (preferably C<()>).	182	I<< When in doubt, return a false value (preferably C<()>). >>
141		183
142	=over 4	184	=over 4
143		185
144	=item on_init $term	186	=item on_init $term
145		187
…		…
199	than the scroll back buffer or the terminal.	241	than the scroll back buffer or the terminal.
200		242
201	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,
202	$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
203	number of lines that will be in the scrollback buffer.	245	number of lines that will be in the scrollback buffer.
204
205	=item on_tty_activity $term NYI
206
207	Called whenever the program(s) running in the urxvt window send output.
208		246
209	=item on_osc_seq $term, $string	247	=item on_osc_seq $term, $string
210		248
211	Called whenever the B<ESC ] 777 ; string ST> command sequence (OSC =	249	Called whenever the B<ESC ] 777 ; string ST> command sequence (OSC =
212	operating system command) is processed. Cursor position and other state	250	operating system command) is processed. Cursor position and other state
…		…
266	=item on_focus_out $term	304	=item on_focus_out $term
267		305
268	Called wheneever the window loses keyboard focus, before rxvt-unicode does	306	Called wheneever the window loses keyboard focus, before rxvt-unicode does
269	focus out processing.	307	focus out processing.
270		308
271	=item on_key_press $term, $event, $octets	309	=item on_key_press $term, $event, $keysym, $octets
272		310
273	=item on_key_release $term, $event	311	=item on_key_release $term, $event, $keysym
274		312
275	=item on_button_press $term, $event	313	=item on_button_press $term, $event
276		314
277	=item on_button_release $term, $event	315	=item on_button_release $term, $event
278		316
…		…
332	that calls this function.	370	that calls this function.
333		371
334	Using this function has the advantage that its output ends up in the	372	Using this function has the advantage that its output ends up in the
335	correct place, e.g. on stderr of the connecting urxvtc client.	373	correct place, e.g. on stderr of the connecting urxvtc client.
336		374
		375	=item $is_safe = urxvt::safe
		376
		377	Returns true when it is safe to do potentially unsafe things, such as
		378	evaluating perl code specified by the user. This is true when urxvt was
		379	started setuid or setgid.
		380
337	=item $time = urxvt::NOW	381	=item $time = urxvt::NOW
338		382
339	Returns the "current time" (as per the event loop).	383	Returns the "current time" (as per the event loop).
340		384
341	=item urxvt::CurrentTime	385	=item urxvt::CurrentTime
…		…
404		448
405	package urxvt;	449	package urxvt;
406		450
407	use utf8;	451	use utf8;
408	use strict;	452	use strict;
		453	use Carp ();
409	use Scalar::Util ();	454	use Scalar::Util ();
410	use List::Util ();	455	use List::Util ();
411		456
412	our $VERSION = 1;	457	our $VERSION = 1;
413	our $TERM;	458	our $TERM;
414	our @HOOKNAME;	459	our @HOOKNAME;
		460	our %HOOKTYPE = map +($HOOKNAME[$_] => $_), 0..$#HOOKNAME;
415	our %OPTION;	461	our %OPTION;
416	our $LIBDIR;	462	our $LIBDIR;
417		463
418	BEGIN {	464	BEGIN {
419	urxvt->bootstrap;	465	urxvt->bootstrap;
…		…
423	my $msg = join "", @_;	469	my $msg = join "", @_;
424	$msg .= "\n"	470	$msg .= "\n"
425	unless $msg =~ /\n$/;	471	unless $msg =~ /\n$/;
426	urxvt::warn ($msg);	472	urxvt::warn ($msg);
427	};	473	};
		474
		475	delete $ENV{IFS};
		476	delete $ENV{CDPATH};
		477	delete $ENV{BASH_ENV};
		478	$ENV{PATH} = "/bin:/sbin:/usr/bin:/usr/sbin:/usr/local/bin:/usr/local/sbin:/opt/bin:/opt/sbin";
428	}	479	}
429		480
430	my @hook_count;	481	my @hook_count;
431	my $verbosity = $ENV{URXVT_PERL_VERBOSITY};	482	my $verbosity = $ENV{URXVT_PERL_VERBOSITY};
432		483
433	sub verbose {	484	sub verbose {
434	my ($level, $msg) = @_;	485	my ($level, $msg) = @_;
435	warn "$msg\n" if $level <= $verbosity;	486	warn "$msg\n" if $level <= $verbosity;
436	}	487	}
437		488
438	# find on_xxx subs in the package and register them
439	# as hooks
440	sub register_package($) {
441	my ($pkg) = @_;
442
443	for my $htype (0.. $#HOOKNAME) {
444	my $name = $HOOKNAME[$htype];
445
446	my $ref = $pkg->can ("on_" . lc $name)
447	or next;
448
449	$TERM->{_hook}[$htype]{$pkg} = $ref;
450	$hook_count[$htype]++
451	or set_should_invoke $htype, 1;
452	}
453	}
454
455	my $extension_pkg = "extension0000";	489	my $extension_pkg = "extension0000";
456	my %extension_pkg;	490	my %extension_pkg;
457		491
458	# load a single script into its own package, once only	492	# load a single script into its own package, once only
459	sub extension_package($) {	493	sub extension_package($) {
…		…
465	verbose 3, "loading extension '$path' into package '$pkg'";	499	verbose 3, "loading extension '$path' into package '$pkg'";
466		500
467	open my $fh, "<:raw", $path	501	open my $fh, "<:raw", $path
468	or die "$path: $!";	502	or die "$path: $!";
469		503
		504	my $source = untaint
470	my $source = "package $pkg; use strict; use utf8;\n"	505	"package $pkg; use strict; use utf8;\n"
471	. "use base urxvt::term::proxy::;\n"	506	. "use base urxvt::term::extension::;\n"
472	. "#line 1 \"$path\"\n{\n"	507	. "#line 1 \"$path\"\n{\n"
473	. (do { local $/; <$fh> })	508	. (do { local $/; <$fh> })
474	. "\n};\n1";	509	. "\n};\n1";
475		510
476	$source =~ /(.*)/s and $source = $1; # untaint	511	eval $source
477
478	eval $source or die "$path: $@";	512	or die "$path: $@";
479		513
480	$pkg	514	$pkg
481	}	515	}
482	}	516	}
483		517
…		…
489	my $htype = shift;	523	my $htype = shift;
490		524
491	if ($htype == 0) { # INIT	525	if ($htype == 0) { # INIT
492	my @dirs = ((split /:/, $TERM->resource ("perl_lib")), "$LIBDIR/perl");	526	my @dirs = ((split /:/, $TERM->resource ("perl_lib")), "$LIBDIR/perl");
493		527
494	my %want_ext;	528	my %ext_arg;
495		529
496	for (map { split /,/, $TERM->resource ("perl_ext_$_") } 1, 2) {	530	for (map { split /,/, $TERM->resource ("perl_ext_$_") } 1, 2) {
497	if ($_ eq "default") {	531	if ($_ eq "default") {
498	$want_ext{$_}++ for qw(selection option-popup);	532	$ext_arg{$_} \|\|= [] for qw(selection option-popup selection-popup searchable-scrollback);
499	} elsif (/^-(.*)$/) {	533	} elsif (/^-(.*)$/) {
500	delete $want_ext{$1};	534	delete $ext_arg{$1};
		535	} elsif (/^([^<]+)<(.*)>$/) {
		536	push @{ $ext_arg{$1} }, $2;
501	} else {	537	} else {
502	$want_ext{$_}++;	538	$ext_arg{$_} \|\|= [];
503	}	539	}
504	}	540	}
505		541
506	for my $ext (keys %want_ext) {	542	while (my ($ext, $argv) = each %ext_arg) {
507	my @files = grep -f $_, map "$_/$ext", @dirs;	543	my @files = grep -f $_, map "$_/$ext", @dirs;
508		544
509	if (@files) {	545	if (@files) {
510	register_package extension_package $files[0];	546	$TERM->register_package (extension_package $files[0], $argv);
511	} else {	547	} else {
512	warn "perl extension '$ext' not found in perl library search path\n";	548	warn "perl extension '$ext' not found in perl library search path\n";
513	}	549	}
514	}	550	}
515		551
…		…
524	if $verbosity >= 10;	560	if $verbosity >= 10;
525		561
526	keys %$cb;	562	keys %$cb;
527		563
528	while (my ($pkg, $cb) = each %$cb) {	564	while (my ($pkg, $cb) = each %$cb) {
529	eval {	565	$retval = eval { $cb->($TERM->{_pkg}{$pkg}, @_) }
530	$retval = $cb->(
531	$TERM->{_pkg}{$pkg} \|\|= do {
532	my $proxy = bless { }, $pkg;
533	Scalar::Util::weaken ($proxy->{term} = $TERM);
534	$proxy
535	},
536	@_,
537	) and last;	566	and last;
		567
		568	if ($@) {
		569	$TERM->ungrab; # better to lose the grab than the session
		570	warn $@;
538	};	571	}
539	warn $@ if $@;#d#
540	}	572	}
541	}	573	}
542		574
543	if ($htype == 1) { # DESTROY	575	if ($htype == 1) { # DESTROY
544	# remove hooks if unused
545	if (my $hook = $TERM->{_hook}) {	576	if (my $hook = delete $TERM->{_hook}) {
546	for my $htype (0..$#$hook) {	577	for my $htype (0..$#$hook) {
547	$hook_count[$htype] -= scalar keys %{ $hook->[$htype] \|\| {} }	578	$hook_count[$htype] -= scalar keys %{ $hook->[$htype] \|\| {} }
548	or set_should_invoke $htype, 0;	579	or set_should_invoke $htype, 0;
549	}	580	}
550	}	581	}
…		…
557	}	588	}
558		589
559	$retval	590	$retval
560	}	591	}
561		592
562	# urxvt::term::proxy	593	# urxvt::term::extension
563		594
564	sub urxvt::term::proxy::AUTOLOAD {	595	package urxvt::term::extension;
565	$urxvt::term::proxy::AUTOLOAD =~ /:([^:]+)$/	596
		597	sub enable {
		598	my ($self, %hook) = @_;
		599	my $pkg = $self->{_pkg};
		600
		601	while (my ($name, $cb) = each %hook) {
		602	my $htype = $HOOKTYPE{uc $name};
		603	defined $htype
		604	or Carp::croak "unsupported hook type '$name'";
		605
		606	unless (exists $self->{term}{_hook}[$htype]{$pkg}) {
		607	$hook_count[$htype]++
		608	or urxvt::set_should_invoke $htype, 1;
		609	}
		610
		611	$self->{term}{_hook}[$htype]{$pkg} = $cb;
		612	}
		613	}
		614
		615	sub disable {
		616	my ($self, @hook) = @_;
		617	my $pkg = $self->{_pkg};
		618
		619	for my $name (@hook) {
		620	my $htype = $HOOKTYPE{uc $name};
		621	defined $htype
		622	or Carp::croak "unsupported hook type '$name'";
		623
		624	if (delete $self->{term}{_hook}[$htype]{$pkg}) {
		625	--$hook_count[$htype]
		626	or urxvt::set_should_invoke $htype, 0;
		627	}
		628	}
		629	}
		630
		631	our $AUTOLOAD;
		632
		633	sub AUTOLOAD {
		634	$AUTOLOAD =~ /:([^:]+)$/
566	or die "FATAL: \$AUTOLOAD '$urxvt::term::proxy::AUTOLOAD' unparsable";	635	or die "FATAL: \$AUTOLOAD '$AUTOLOAD' unparsable";
567		636
568	eval qq{	637	eval qq{
569	sub $urxvt::term::proxy::AUTOLOAD {	638	sub $AUTOLOAD {
570	my \$proxy = shift;	639	my \$proxy = shift;
571	\$proxy->{term}->$1 (\@_)	640	\$proxy->{term}->$1 (\@_)
572	}	641	}
573	1	642	1
574	} or die "FATAL: unable to compile method forwarder: $@";	643	} or die "FATAL: unable to compile method forwarder: $@";
575		644
576	goto &$urxvt::term::proxy::AUTOLOAD;	645	goto &$AUTOLOAD;
		646	}
		647
		648	sub DESTROY {
		649	# nop
577	}	650	}
578		651
579	# urxvt::destroy_hook	652	# urxvt::destroy_hook
580		653
581	sub urxvt::destroy_hook::DESTROY {	654	sub urxvt::destroy_hook::DESTROY {
…		…
647	${$_[0]}++;	720	${$_[0]}++;
648	}	721	}
649		722
650	sub urxvt::anyevent::condvar::wait {	723	sub urxvt::anyevent::condvar::wait {
651	unless (${$_[0]}) {	724	unless (${$_[0]}) {
652	require Carp;
653	Carp::croak ("AnyEvent->condvar blocking wait unsupported in urxvt, use a non-blocking API");	725	Carp::croak "AnyEvent->condvar blocking wait unsupported in urxvt, use a non-blocking API";
654	}	726	}
655	}	727	}
656		728
657	package urxvt::term;	729	package urxvt::term;
658		730
659	=head2 The C<urxvt::term> Class	731	=head2 The C<urxvt::term> Class
660		732
661	=over 4	733	=over 4
		734
		735	=cut
		736
		737	# find on_xxx subs in the package and register them
		738	# as hooks
		739	sub register_package {
		740	my ($self, $pkg, $argv) = @_;
		741
		742	my $proxy = bless {
		743	_pkg => $pkg,
		744	argv => $argv,
		745	}, $pkg;
		746	Scalar::Util::weaken ($proxy->{term} = $self);
		747
		748	$self->{_pkg}{$pkg} = $proxy;
		749
		750	for my $name (@HOOKNAME) {
		751	if (my $ref = $pkg->can ("on_" . lc $name)) {
		752	$proxy->enable ($name => $ref);
		753	}
		754	}
		755	}
662		756
663	=item $term->destroy	757	=item $term->destroy
664		758
665	Destroy the terminal object (close the window, free resources etc.).	759	Destroy the terminal object (close the window, free resources etc.).
666		760
…		…
720	my ($self, $name) = (shift, shift);	814	my ($self, $name) = (shift, shift);
721	unshift @_, $self, $name, ($name =~ s/\s\+\s(\d+)$// ? $1 : 0);	815	unshift @_, $self, $name, ($name =~ s/\s\+\s(\d+)$// ? $1 : 0);
722	&urxvt::term::_resource	816	&urxvt::term::_resource
723	}	817	}
724		818
		819	=item $success = $term->parse_keysym ($keysym_spec, $command_string)
		820
		821	Adds a keymap translation exactly as specified via a resource. See the
		822	C<keysym> resource in the @@RXVT_NAME@@(1) manpage.
		823
725	=item $rend = $term->rstyle ([$new_rstyle])	824	=item $rend = $term->rstyle ([$new_rstyle])
726		825
727	Return and optionally change the current rendition. Text that is output by	826	Return and optionally change the current rendition. Text that is output by
728	the terminal application will use this style.	827	the terminal application will use this style.
729		828
…		…
748		847
749	=item $oldtext = $term->selection ([$newtext])	848	=item $oldtext = $term->selection ([$newtext])
750		849
751	Return the current selection text and optionally replace it by C<$newtext>.	850	Return the current selection text and optionally replace it by C<$newtext>.
752		851
753	#=item $term->overlay ($x, $y, $text)	852	=item $term->overlay_simple ($x, $y, $text)
754	#	853
755	#Create a simple multi-line overlay box. See the next method for details.	854	Create a simple multi-line overlay box. See the next method for details.
756	#	855
757	#=cut	856	=cut
758	#	857
759	#sub urxvt::term::scr_overlay {	858	sub overlay_simple {
760	# my ($self, $x, $y, $text) = @_;	859	my ($self, $x, $y, $text) = @_;
761	#	860
762	# my @lines = split /\n/, $text;	861	my @lines = split /\n/, $text;
763	#	862
764	# my $w = 0;	863	my $w = List::Util::max map $self->strwidth ($_), @lines;
765	# for (map $self->strwidth ($_), @lines) {	864
766	# $w = $_ if $w < $_;
767	# }
768	#
769	# $self->scr_overlay_new ($x, $y, $w, scalar @lines);	865	my $overlay = $self->overlay ($x, $y, $w, scalar @lines);
770	# $self->scr_overlay_set (0, $_, $lines[$_]) for 0.. $#lines;	866	$overlay->set (0, $_, $lines[$_]) for 0.. $#lines;
771	#}	867
		868	$overlay
		869	}
772		870
773	=item $term->overlay ($x, $y, $width, $height[, $rstyle[, $border]])	871	=item $term->overlay ($x, $y, $width, $height[, $rstyle[, $border]])
774		872
775	Create a new (empty) overlay at the given position with the given	873	Create a new (empty) overlay at the given position with the given
776	width/height. C<$rstyle> defines the initial rendition style	874	width/height. C<$rstyle> defines the initial rendition style
…		…
843		941
844	=item $string = $term->locale_decode ($octets)	942	=item $string = $term->locale_decode ($octets)
845		943
846	Convert the given locale-encoded octets into a perl string.	944	Convert the given locale-encoded octets into a perl string.
847		945
		946	=item $term->scr_xor_span ($beg_row, $beg_col, $end_row, $end_col[, $rstyle])
		947
		948	XORs the rendition values in the given span with the provided value
		949	(default: C<RS_RVid>). Useful in refresh hooks to provide effects similar
		950	to the selection.
		951
		952	=item $term->scr_xor_rect ($beg_row, $beg_col, $end_row, $end_col[, $rstyle1[, $rstyle2]])
		953
		954	Similar to C<scr_xor_span>, but xors a rectangle instead. Trailing
		955	whitespace will additionally be xored with the C<$rstyle2>, which defaults
		956	to C<RS_RVid \| RS_Uline>, which removes reverse video again and underlines
		957	it instead.
		958
		959	=item $term->scr_bell
		960
		961	Ring the bell!
		962
848	=item $term->scr_add_lines ($string)	963	=item $term->scr_add_lines ($string)
849		964
850	Write the given text string to the screen, as if output by the application	965	Write the given text string to the screen, as if output by the application
851	running inside the terminal. It may not contain command sequences (escape	966	running inside the terminal. It may not contain command sequences (escape
852	codes), but is free to use line feeds, carriage returns and tabs. The	967	codes), but is free to use line feeds, carriage returns and tabs. The
…		…
866		981
867	Write the octets given in C<$data> to the tty (i.e. as program input). To	982	Write the octets given in C<$data> to the tty (i.e. as program input). To
868	pass characters instead of octets, you should convert your strings first	983	pass characters instead of octets, you should convert your strings first
869	to the locale-specific encoding using C<< $term->locale_encode >>.	984	to the locale-specific encoding using C<< $term->locale_encode >>.
870		985
		986	=item $old_events = $term->pty_ev_events ([$new_events])
		987
		988	Replaces the event mask of the pty watcher by the given event mask. Can
		989	be used to suppress input and output handling to the pty/tty. See the
		990	description of C<< urxvt::timer->events >>. Make sure to always restore
		991	the previous value.
		992
871	=item $windowid = $term->parent	993	=item $windowid = $term->parent
872		994
873	Return the window id of the toplevel window.	995	Return the window id of the toplevel window.
874		996
875	=item $windowid = $term->vt	997	=item $windowid = $term->vt
…		…
899	=item $nrow_plus_saveLines = $term->total_rows	1021	=item $nrow_plus_saveLines = $term->total_rows
900		1022
901	=item $lines_in_scrollback = $term->nsaved	1023	=item $lines_in_scrollback = $term->nsaved
902		1024
903	Return various integers describing terminal characteristics.	1025	Return various integers describing terminal characteristics.
		1026
		1027	=item $lc_ctype = $term->locale
		1028
		1029	Returns the LC_CTYPE category string used by this rxvt-unicode.
		1030
		1031	=item $x_display = $term->display_id
		1032
		1033	Return the DISPLAY used by rxvt-unicode.
904		1034
905	=item $modifiermask = $term->ModLevel3Mask	1035	=item $modifiermask = $term->ModLevel3Mask
906		1036
907	=item $modifiermask = $term->ModMetaMask	1037	=item $modifiermask = $term->ModMetaMask
908		1038
…		…
1085	$offset / $self->{ncol} + $self->{beg},	1215	$offset / $self->{ncol} + $self->{beg},
1086	$offset % $self->{ncol}	1216	$offset % $self->{ncol}
1087	)	1217	)
1088	}	1218	}
1089		1219
1090	=item ($row, $col) = $line->coord_of ($offset)
1091	=item $text = $term->special_encode $string	1220	=item $text = $term->special_encode $string
1092		1221
1093	Converts a perl string into the special encoding used by rxvt-unicode,	1222	Converts a perl string into the special encoding used by rxvt-unicode,
1094	where one character corresponds to one screen cell. See	1223	where one character corresponds to one screen cell. See
1095	C<< $term->ROW_t >> for details.	1224	C<< $term->ROW_t >> for details.
…		…
1097	=item $string = $term->special_decode $text	1226	=item $string = $term->special_decode $text
1098		1227
1099	Converts rxvt-unicodes text reprsentation into a perl string. See	1228	Converts rxvt-unicodes text reprsentation into a perl string. See
1100	C<< $term->ROW_t >> for details.	1229	C<< $term->ROW_t >> for details.
1101		1230
		1231	=item $success = $term->grab_button ($button, $modifiermask)
		1232
		1233	Registers a synchronous button grab. See the XGrabButton manpage.
		1234
		1235	=item $success = $term->grab ($eventtime[, $sync])
		1236
		1237	Calls XGrabPointer and XGrabKeyboard in asynchronous (default) or
		1238	synchronous (C<$sync> is true). Also remembers the grab timestampe.
		1239
		1240	=item $term->allow_events_async
		1241
		1242	Calls XAllowEvents with AsyncBoth for the most recent grab.
		1243
		1244	=item $term->allow_events_sync
		1245
		1246	Calls XAllowEvents with SyncBoth for the most recent grab.
		1247
		1248	=item $term->allow_events_replay
		1249
		1250	Calls XAllowEvents with both ReplayPointer and ReplayKeyboard for the most
		1251	recent grab.
		1252
		1253	=item $term->ungrab
		1254
		1255	Calls XUngrab for the most recent grab. Is called automatically on
		1256	evaluation errors, as it is better to lose the grab in the error case as
		1257	the session.
		1258
1102	=back	1259	=back
1103		1260
1104	=cut	1261	=cut
1105		1262
1106	package urxvt::popup;	1263	package urxvt::popup;
…		…
1124	}	1281	}
1125		1282
1126	sub add_separator {	1283	sub add_separator {
1127	my ($self, $sep) = @_;	1284	my ($self, $sep) = @_;
1128		1285
1129	$sep \|\|= "═";	1286	$sep \|\|= "=";
1130		1287
1131	$self->add_item ({	1288	$self->add_item ({
1132	rend => { normal => "\x1b[0;30;47m", hover => "\x1b[0;30;47m", active => "\x1b[0;30;47m" },	1289	rend => { normal => "\x1b[0;30;47m", hover => "\x1b[0;30;47m", active => "\x1b[0;30;47m" },
1133	text => "",	1290	text => "",
1134	render => sub { $sep x $urxvt::TERM->ncol },	1291	render => sub { $sep x $self->{term}->ncol },
1135	activate => sub { },	1292	activate => sub { },
1136	});	1293	});
1137	}	1294	}
1138		1295
1139	sub add_title {	1296	sub add_title {
…		…
1147	}	1304	}
1148		1305
1149	sub add_button {	1306	sub add_button {
1150	my ($self, $text, $cb) = @_;	1307	my ($self, $text, $cb) = @_;
1151		1308
1152	$self->add_item ({ type => "button", text => "[ $text ]", activate => $cb});	1309	$self->add_item ({ type => "button", text => $text, activate => $cb});
1153	}	1310	}
1154		1311
1155	sub add_toggle {	1312	sub add_toggle {
1156	my ($self, $text, $cb, $value) = @_;	1313	my ($self, $text, $cb, $value) = @_;
1157		1314
1158	my $item; $item = {	1315	my $item; $item = {
1159	type => "button",	1316	type => "button",
1160	text => " $text",	1317	text => " $text",
1161	value => $value,	1318	value => $value,
1162	render => sub { ($item->{value} ? "* " : " ") . $text },	1319	render => sub { ($_[0]{value} ? "* " : " ") . $text },
1163	activate => sub { $cb->($item->{value} = !$item->{value}); },	1320	activate => sub { $cb->($_[0]{value} = !$_[0]{value}); },
1164	};	1321	};
1165		1322
1166	$self->add_item ($item);	1323	$self->add_item ($item);
1167	}	1324	}
1168		1325
1169	sub show {	1326	sub show {
1170	my ($self) = @_;	1327	my ($self) = @_;
1171		1328
1172	local $urxvt::popup::self = $self;	1329	local $urxvt::popup::self = $self;
1173		1330
		1331	local $ENV{LC_ALL} = $self->{term}->locale;
		1332
1174	urxvt->new ("--perl-lib" => "", "--perl-ext-common" => "", "-pty-fd" => -1, "-sl" => 0, "-b" => 0,	1333	urxvt->new ("--perl-lib" => "", "--perl-ext-common" => "", "-pty-fd" => -1, "-sl" => 0, "-b" => 0,
1175	"--transient-for" => $self->{term}->parent,	1334	"--transient-for" => $self->{term}->parent,
		1335	"-display" => $self->{term}->display_id,
1176	"-pe" => "urxvt-popup")	1336	"-pe" => "urxvt-popup")
1177	or die "unable to create popup window\n";	1337	or die "unable to create popup window\n";
1178	}	1338	}
1179		1339
1180	sub DESTROY {	1340	sub DESTROY {
1181	my ($self) = @_;	1341	my ($self) = @_;
1182		1342
		1343	delete $self->{term}{_destroy}{$self};
1183	$self->{term}->ungrab;	1344	$self->{term}->ungrab;
1184	}	1345	}
1185		1346
1186	=head2 The C<urxvt::timer> Class	1347	=head2 The C<urxvt::timer> Class
1187		1348
…		…
1242		1403
1243	$term->{socket} = ...	1404	$term->{socket} = ...
1244	$term->{iow} = urxvt::iow	1405	$term->{iow} = urxvt::iow
1245	->new	1406	->new
1246	->fd (fileno $term->{socket})	1407	->fd (fileno $term->{socket})
1247	->events (1) # wait for read data	1408	->events (urxvt::EVENT_READ)
1248	->start	1409	->start
1249	->cb (sub {	1410	->cb (sub {
1250	my ($iow, $revents) = @_;	1411	my ($iow, $revents) = @_;
1251	# $revents must be 1 here, no need to check	1412	# $revents must be 1 here, no need to check
1252	sysread $term->{socket}, my $buf, 8192	1413	sysread $term->{socket}, my $buf, 8192
…		…
1269		1430
1270	Set the filedescriptor (not handle) to watch.	1431	Set the filedescriptor (not handle) to watch.
1271		1432
1272	=item $iow = $iow->events ($eventmask)	1433	=item $iow = $iow->events ($eventmask)
1273		1434
1274	Set the event mask to watch. Bit #0 (value C<1>) enables watching for read	1435	Set the event mask to watch. The only allowed values are
1275	data, Bit #1 (value C<2>) enables watching for write data.	1436	C<urxvt::EVENT_READ> and C<urxvt::EVENT_WRITE>, which might be ORed
		1437	together, or C<urxvt::EVENT_NONE>.
1276		1438
1277	=item $iow = $iow->start	1439	=item $iow = $iow->start
1278		1440
1279	Start watching for requested events on the given handle.	1441	Start watching for requested events on the given handle.
1280		1442
…		…
1291	This variable controls the verbosity level of the perl extension. Higher	1453	This variable controls the verbosity level of the perl extension. Higher
1292	numbers indicate more verbose output.	1454	numbers indicate more verbose output.
1293		1455
1294	=over 4	1456	=over 4
1295		1457
1296	=item =0 - only fatal messages	1458	=item == 0 - fatal messages
1297		1459
1298	=item =3 - script loading and management	1460	=item >= 3 - script loading and management
1299		1461
1300	=item =10 - all events received	1462	=item >=10 - all events received
1301		1463
1302	=back	1464	=back
1303		1465
1304	=head1 AUTHOR	1466	=head1 AUTHOR
1305		1467

Diff Legend

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

Comparing rxvt-unicode/src/urxvt.pm (file contents): Revision 1.57 by root, Sun Jan 8 08:43:11 2006 UTC vs. Revision 1.71 by root, Mon Jan 9 23:18:49 2006 UTC

Diff Legend

Comparing rxvt-unicode/src/urxvt.pm (file contents):
Revision 1.57 by root, Sun Jan 8 08:43:11 2006 UTC vs.
Revision 1.71 by root, Mon Jan 9 23:18:49 2006 UTC