[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.74 by root, Tue Jan 10 04:26:54 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<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.
65		81
66	=item digital-clock	82	=item digital-clock
67		83
68	Displays a digital clock using the built-in overlay.	84	Displays a digital clock using the built-in overlay.
69		85
…		…
119	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
120	locale-specific way.	136	locale-specific way.
121		137
122	=back	138	=back
123		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
124	=head2 Hooks	173	=head2 Hooks
125		174
126	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
127	called whenever the relevant event happens.	176	called whenever the relevant event happens.
128		177
129	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
130	and extension package. You can call all C<urxvt::term> methods on it, but	179	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		180
136	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
137	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
138	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.
139		184
140	When in doubt, return a false value (preferably C<()>).	185	I<< When in doubt, return a false value (preferably C<()>). >>
141		186
142	=over 4	187	=over 4
143		188
144	=item on_init $term	189	=item on_init $term
145		190
…		…
199	than the scroll back buffer or the terminal.	244	than the scroll back buffer or the terminal.
200		245
201	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,
202	$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
203	number of lines that will be in the scrollback buffer.	248	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		249
209	=item on_osc_seq $term, $string	250	=item on_osc_seq $term, $string
210		251
211	Called whenever the B<ESC ] 777 ; string ST> command sequence (OSC =	252	Called whenever the B<ESC ] 777 ; string ST> command sequence (OSC =
212	operating system command) is processed. Cursor position and other state	253	operating system command) is processed. Cursor position and other state
…		…
225	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
226	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
227	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
228	output.	269	output.
229		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
230	=item on_line_update $term, $row	276	=item on_line_update $term, $row
231		277
232	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
233	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
234	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,
…		…
266	=item on_focus_out $term	312	=item on_focus_out $term
267		313
268	Called wheneever the window loses keyboard focus, before rxvt-unicode does	314	Called wheneever the window loses keyboard focus, before rxvt-unicode does
269	focus out processing.	315	focus out processing.
270		316
271	=item on_key_press $term, $event, $octets	317	=item on_key_press $term, $event, $keysym, $octets
272		318
273	=item on_key_release $term, $event	319	=item on_key_release $term, $event, $keysym
274		320
275	=item on_button_press $term, $event	321	=item on_button_press $term, $event
276		322
277	=item on_button_release $term, $event	323	=item on_button_release $term, $event
278		324
…		…
332	that calls this function.	378	that calls this function.
333		379
334	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
335	correct place, e.g. on stderr of the connecting urxvtc client.	381	correct place, e.g. on stderr of the connecting urxvtc client.
336		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
337	=item $time = urxvt::NOW	389	=item $time = urxvt::NOW
338		390
339	Returns the "current time" (as per the event loop).	391	Returns the "current time" (as per the event loop).
340		392
341	=item urxvt::CurrentTime	393	=item urxvt::CurrentTime
…		…
404		456
405	package urxvt;	457	package urxvt;
406		458
407	use utf8;	459	use utf8;
408	use strict;	460	use strict;
		461	use Carp ();
409	use Scalar::Util ();	462	use Scalar::Util ();
410	use List::Util ();	463	use List::Util ();
411		464
412	our $VERSION = 1;	465	our $VERSION = 1;
413	our $TERM;	466	our $TERM;
414	our @HOOKNAME;	467	our @HOOKNAME;
		468	our %HOOKTYPE = map +($HOOKNAME[$_] => $_), 0..$#HOOKNAME;
415	our %OPTION;	469	our %OPTION;
		470
416	our $LIBDIR;	471	our $LIBDIR;
		472	our $RESNAME;
		473	our $RESCLASS;
		474	our $RXVTNAME;
417		475
418	BEGIN {	476	BEGIN {
419	urxvt->bootstrap;	477	urxvt->bootstrap;
420		478
421	# overwrite perl's warn	479	# overwrite perl's warn
…		…
423	my $msg = join "", @_;	481	my $msg = join "", @_;
424	$msg .= "\n"	482	$msg .= "\n"
425	unless $msg =~ /\n$/;	483	unless $msg =~ /\n$/;
426	urxvt::warn ($msg);	484	urxvt::warn ($msg);
427	};	485	};
		486
		487	delete $ENV{IFS};
		488	delete $ENV{CDPATH};
		489	delete $ENV{BASH_ENV};
		490	$ENV{PATH} = "/bin:/sbin:/usr/bin:/usr/sbin:/usr/local/bin:/usr/local/sbin:/opt/bin:/opt/sbin";
428	}	491	}
429		492
430	my @hook_count;	493	my @hook_count;
431	my $verbosity = $ENV{URXVT_PERL_VERBOSITY};	494	my $verbosity = $ENV{URXVT_PERL_VERBOSITY};
432		495
433	sub verbose {	496	sub verbose {
434	my ($level, $msg) = @_;	497	my ($level, $msg) = @_;
435	warn "$msg\n" if $level <= $verbosity;	498	warn "$msg\n" if $level <= $verbosity;
436	}	499	}
437		500
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";	501	my $extension_pkg = "extension0000";
456	my %extension_pkg;	502	my %extension_pkg;
457		503
458	# load a single script into its own package, once only	504	# load a single script into its own package, once only
459	sub extension_package($) {	505	sub extension_package($) {
…		…
465	verbose 3, "loading extension '$path' into package '$pkg'";	511	verbose 3, "loading extension '$path' into package '$pkg'";
466		512
467	open my $fh, "<:raw", $path	513	open my $fh, "<:raw", $path
468	or die "$path: $!";	514	or die "$path: $!";
469		515
		516	my $source = untaint
470	my $source = "package $pkg; use strict; use utf8;\n"	517	"package $pkg; use strict; use utf8;\n"
471	. "use base urxvt::term::proxy::;\n"	518	. "use base urxvt::term::extension::;\n"
472	. "#line 1 \"$path\"\n{\n"	519	. "#line 1 \"$path\"\n{\n"
473	. (do { local $/; <$fh> })	520	. (do { local $/; <$fh> })
474	. "\n};\n1";	521	. "\n};\n1";
475		522
476	$source =~ /(.*)/s and $source = $1; # untaint	523	eval $source
477
478	eval $source or die "$path: $@";	524	or die "$path: $@";
479		525
480	$pkg	526	$pkg
481	}	527	}
482	}	528	}
483		529
…		…
489	my $htype = shift;	535	my $htype = shift;
490		536
491	if ($htype == 0) { # INIT	537	if ($htype == 0) { # INIT
492	my @dirs = ((split /:/, $TERM->resource ("perl_lib")), "$LIBDIR/perl");	538	my @dirs = ((split /:/, $TERM->resource ("perl_lib")), "$LIBDIR/perl");
493		539
494	my %want_ext;	540	my %ext_arg;
495		541
496	for (map { split /,/, $TERM->resource ("perl_ext_$_") } 1, 2) {	542	for (map { split /,/, $TERM->resource ("perl_ext_$_") } 1, 2) {
497	if ($_ eq "default") {	543	if ($_ eq "default") {
498	$want_ext{$_}++ for qw(selection option-popup);	544	$ext_arg{$_} \|\|= [] for qw(selection option-popup selection-popup searchable-scrollback);
499	} elsif (/^-(.*)$/) {	545	} elsif (/^-(.*)$/) {
500	delete $want_ext{$1};	546	delete $ext_arg{$1};
		547	} elsif (/^([^<]+)<(.*)>$/) {
		548	push @{ $ext_arg{$1} }, $2;
501	} else {	549	} else {
502	$want_ext{$_}++;	550	$ext_arg{$_} \|\|= [];
503	}	551	}
504	}	552	}
505		553
506	for my $ext (keys %want_ext) {	554	while (my ($ext, $argv) = each %ext_arg) {
507	my @files = grep -f $_, map "$_/$ext", @dirs;	555	my @files = grep -f $_, map "$_/$ext", @dirs;
508		556
509	if (@files) {	557	if (@files) {
510	register_package extension_package $files[0];	558	$TERM->register_package (extension_package $files[0], $argv);
511	} else {	559	} else {
512	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";
513	}	561	}
514	}	562	}
515		563
…		…
524	if $verbosity >= 10;	572	if $verbosity >= 10;
525		573
526	keys %$cb;	574	keys %$cb;
527		575
528	while (my ($pkg, $cb) = each %$cb) {	576	while (my ($pkg, $cb) = each %$cb) {
529	eval {	577	$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;	578	and last;
		579
		580	if ($@) {
		581	$TERM->ungrab; # better to lose the grab than the session
		582	warn $@;
538	};	583	}
539	warn $@ if $@;#d#
540	}	584	}
541	}	585	}
542		586
543	if ($htype == 1) { # DESTROY	587	if ($htype == 1) { # DESTROY
544	# remove hooks if unused
545	if (my $hook = $TERM->{_hook}) {	588	if (my $hook = delete $TERM->{_hook}) {
546	for my $htype (0..$#$hook) {	589	for my $htype (0..$#$hook) {
547	$hook_count[$htype] -= scalar keys %{ $hook->[$htype] \|\| {} }	590	$hook_count[$htype] -= scalar keys %{ $hook->[$htype] \|\| {} }
548	or set_should_invoke $htype, 0;	591	or set_should_invoke $htype, 0;
549	}	592	}
550	}	593	}
…		…
557	}	600	}
558		601
559	$retval	602	$retval
560	}	603	}
561		604
562	# urxvt::term::proxy	605	# urxvt::term::extension
563		606
564	sub urxvt::term::proxy::AUTOLOAD {	607	package urxvt::term::extension;
565	$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 =~ /:([^:]+)$/
566	or die "FATAL: \$AUTOLOAD '$urxvt::term::proxy::AUTOLOAD' unparsable";	647	or die "FATAL: \$AUTOLOAD '$AUTOLOAD' unparsable";
567		648
568	eval qq{	649	eval qq{
569	sub $urxvt::term::proxy::AUTOLOAD {	650	sub $AUTOLOAD {
570	my \$proxy = shift;	651	my \$proxy = shift;
571	\$proxy->{term}->$1 (\@_)	652	\$proxy->{term}->$1 (\@_)
572	}	653	}
573	1	654	1
574	} or die "FATAL: unable to compile method forwarder: $@";	655	} or die "FATAL: unable to compile method forwarder: $@";
575		656
576	goto &$urxvt::term::proxy::AUTOLOAD;	657	goto &$AUTOLOAD;
		658	}
		659
		660	sub DESTROY {
		661	# nop
577	}	662	}
578		663
579	# urxvt::destroy_hook	664	# urxvt::destroy_hook
580		665
581	sub urxvt::destroy_hook::DESTROY {	666	sub urxvt::destroy_hook::DESTROY {
…		…
647	${$_[0]}++;	732	${$_[0]}++;
648	}	733	}
649		734
650	sub urxvt::anyevent::condvar::wait {	735	sub urxvt::anyevent::condvar::wait {
651	unless (${$_[0]}) {	736	unless (${$_[0]}) {
652	require Carp;
653	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";
654	}	738	}
655	}	739	}
656		740
657	package urxvt::term;	741	package urxvt::term;
658		742
659	=head2 The C<urxvt::term> Class	743	=head2 The C<urxvt::term> Class
660		744
661	=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	}
662		768
663	=item $term->destroy	769	=item $term->destroy
664		770
665	Destroy the terminal object (close the window, free resources etc.).	771	Destroy the terminal object (close the window, free resources etc.).
666		772
…		…
720	my ($self, $name) = (shift, shift);	826	my ($self, $name) = (shift, shift);
721	unshift @_, $self, $name, ($name =~ s/\s\+\s(\d+)$// ? $1 : 0);	827	unshift @_, $self, $name, ($name =~ s/\s\+\s(\d+)$// ? $1 : 0);
722	&urxvt::term::_resource	828	&urxvt::term::_resource
723	}	829	}
724		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
725	=item $rend = $term->rstyle ([$new_rstyle])	836	=item $rend = $term->rstyle ([$new_rstyle])
726		837
727	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
728	the terminal application will use this style.	839	the terminal application will use this style.
729		840
…		…
748		859
749	=item $oldtext = $term->selection ([$newtext])	860	=item $oldtext = $term->selection ([$newtext])
750		861
751	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>.
752		863
753	#=item $term->overlay ($x, $y, $text)	864	=item $term->overlay_simple ($x, $y, $text)
754	#	865
755	#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.
756	#	867
757	#=cut	868	=cut
758	#	869
759	#sub urxvt::term::scr_overlay {	870	sub overlay_simple {
760	# my ($self, $x, $y, $text) = @_;	871	my ($self, $x, $y, $text) = @_;
761	#	872
762	# my @lines = split /\n/, $text;	873	my @lines = split /\n/, $text;
763	#	874
764	# my $w = 0;	875	my $w = List::Util::max map $self->strwidth ($_), @lines;
765	# for (map $self->strwidth ($_), @lines) {	876
766	# $w = $_ if $w < $_;
767	# }
768	#
769	# $self->scr_overlay_new ($x, $y, $w, scalar @lines);	877	my $overlay = $self->overlay ($x, $y, $w, scalar @lines);
770	# $self->scr_overlay_set (0, $_, $lines[$_]) for 0.. $#lines;	878	$overlay->set (0, $_, $lines[$_]) for 0.. $#lines;
771	#}	879
		880	$overlay
		881	}
772		882
773	=item $term->overlay ($x, $y, $width, $height[, $rstyle[, $border]])	883	=item $term->overlay ($x, $y, $width, $height[, $rstyle[, $border]])
774		884
775	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
776	width/height. C<$rstyle> defines the initial rendition style	886	width/height. C<$rstyle> defines the initial rendition style
…		…
843		953
844	=item $string = $term->locale_decode ($octets)	954	=item $string = $term->locale_decode ($octets)
845		955
846	Convert the given locale-encoded octets into a perl string.	956	Convert the given locale-encoded octets into a perl string.
847		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
848	=item $term->scr_add_lines ($string)	975	=item $term->scr_add_lines ($string)
849		976
850	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
851	running inside the terminal. It may not contain command sequences (escape	978	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	979	codes), but is free to use line feeds, carriage returns and tabs. The
…		…
866		993
867	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
868	pass characters instead of octets, you should convert your strings first	995	pass characters instead of octets, you should convert your strings first
869	to the locale-specific encoding using C<< $term->locale_encode >>.	996	to the locale-specific encoding using C<< $term->locale_encode >>.
870		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
871	=item $windowid = $term->parent	1005	=item $windowid = $term->parent
872		1006
873	Return the window id of the toplevel window.	1007	Return the window id of the toplevel window.
874		1008
875	=item $windowid = $term->vt	1009	=item $windowid = $term->vt
…		…
899	=item $nrow_plus_saveLines = $term->total_rows	1033	=item $nrow_plus_saveLines = $term->total_rows
900		1034
901	=item $lines_in_scrollback = $term->nsaved	1035	=item $lines_in_scrollback = $term->nsaved
902		1036
903	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.
904		1046
905	=item $modifiermask = $term->ModLevel3Mask	1047	=item $modifiermask = $term->ModLevel3Mask
906		1048
907	=item $modifiermask = $term->ModMetaMask	1049	=item $modifiermask = $term->ModMetaMask
908		1050
…		…
1085	$offset / $self->{ncol} + $self->{beg},	1227	$offset / $self->{ncol} + $self->{beg},
1086	$offset % $self->{ncol}	1228	$offset % $self->{ncol}
1087	)	1229	)
1088	}	1230	}
1089		1231
1090	=item ($row, $col) = $line->coord_of ($offset)
1091	=item $text = $term->special_encode $string	1232	=item $text = $term->special_encode $string
1092		1233
1093	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,
1094	where one character corresponds to one screen cell. See	1235	where one character corresponds to one screen cell. See
1095	C<< $term->ROW_t >> for details.	1236	C<< $term->ROW_t >> for details.
…		…
1097	=item $string = $term->special_decode $text	1238	=item $string = $term->special_decode $text
1098		1239
1099	Converts rxvt-unicodes text reprsentation into a perl string. See	1240	Converts rxvt-unicodes text reprsentation into a perl string. See
1100	C<< $term->ROW_t >> for details.	1241	C<< $term->ROW_t >> for details.
1101		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
1102	=back	1271	=back
1103		1272
1104	=cut	1273	=cut
1105		1274
1106	package urxvt::popup;	1275	package urxvt::popup;
…		…
1124	}	1293	}
1125		1294
1126	sub add_separator {	1295	sub add_separator {
1127	my ($self, $sep) = @_;	1296	my ($self, $sep) = @_;
1128		1297
1129	$sep \|\|= "═";	1298	$sep \|\|= "=";
1130		1299
1131	$self->add_item ({	1300	$self->add_item ({
1132	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" },
1133	text => "",	1302	text => "",
1134	render => sub { $sep x $urxvt::TERM->ncol },	1303	render => sub { $sep x $self->{term}->ncol },
1135	activate => sub { },	1304	activate => sub { },
1136	});	1305	});
1137	}	1306	}
1138		1307
1139	sub add_title {	1308	sub add_title {
…		…
1147	}	1316	}
1148		1317
1149	sub add_button {	1318	sub add_button {
1150	my ($self, $text, $cb) = @_;	1319	my ($self, $text, $cb) = @_;
1151		1320
1152	$self->add_item ({ type => "button", text => "[ $text ]", activate => $cb});	1321	$self->add_item ({ type => "button", text => $text, activate => $cb});
1153	}	1322	}
1154		1323
1155	sub add_toggle {	1324	sub add_toggle {
1156	my ($self, $text, $cb, $value) = @_;	1325	my ($self, $text, $cb, $value) = @_;
1157		1326
1158	my $item; $item = {	1327	my $item; $item = {
1159	type => "button",	1328	type => "button",
1160	text => " $text",	1329	text => " $text",
1161	value => $value,	1330	value => $value,
1162	render => sub { ($item->{value} ? "* " : " ") . $text },	1331	render => sub { ($_[0]{value} ? "* " : " ") . $text },
1163	activate => sub { $cb->($item->{value} = !$item->{value}); },	1332	activate => sub { $cb->($_[0]{value} = !$_[0]{value}); },
1164	};	1333	};
1165		1334
1166	$self->add_item ($item);	1335	$self->add_item ($item);
1167	}	1336	}
1168		1337
1169	sub show {	1338	sub show {
1170	my ($self) = @_;	1339	my ($self) = @_;
1171		1340
1172	local $urxvt::popup::self = $self;	1341	local $urxvt::popup::self = $self;
1173		1342
		1343	local $ENV{LC_ALL} = $self->{term}->locale;
		1344
1174	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,
1175	"--transient-for" => $self->{term}->parent,	1346	"--transient-for" => $self->{term}->parent,
		1347	"-display" => $self->{term}->display_id,
1176	"-pe" => "urxvt-popup")	1348	"-pe" => "urxvt-popup")
1177	or die "unable to create popup window\n";	1349	or die "unable to create popup window\n";
1178	}	1350	}
1179		1351
1180	sub DESTROY {	1352	sub DESTROY {
1181	my ($self) = @_;	1353	my ($self) = @_;
1182		1354
		1355	delete $self->{term}{_destroy}{$self};
1183	$self->{term}->ungrab;	1356	$self->{term}->ungrab;
1184	}	1357	}
1185		1358
1186	=head2 The C<urxvt::timer> Class	1359	=head2 The C<urxvt::timer> Class
1187		1360
…		…
1242		1415
1243	$term->{socket} = ...	1416	$term->{socket} = ...
1244	$term->{iow} = urxvt::iow	1417	$term->{iow} = urxvt::iow
1245	->new	1418	->new
1246	->fd (fileno $term->{socket})	1419	->fd (fileno $term->{socket})
1247	->events (1) # wait for read data	1420	->events (urxvt::EVENT_READ)
1248	->start	1421	->start
1249	->cb (sub {	1422	->cb (sub {
1250	my ($iow, $revents) = @_;	1423	my ($iow, $revents) = @_;
1251	# $revents must be 1 here, no need to check	1424	# $revents must be 1 here, no need to check
1252	sysread $term->{socket}, my $buf, 8192	1425	sysread $term->{socket}, my $buf, 8192
…		…
1269		1442
1270	Set the filedescriptor (not handle) to watch.	1443	Set the filedescriptor (not handle) to watch.
1271		1444
1272	=item $iow = $iow->events ($eventmask)	1445	=item $iow = $iow->events ($eventmask)
1273		1446
1274	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
1275	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>.
1276		1450
1277	=item $iow = $iow->start	1451	=item $iow = $iow->start
1278		1452
1279	Start watching for requested events on the given handle.	1453	Start watching for requested events on the given handle.
1280		1454
…		…
1291	This variable controls the verbosity level of the perl extension. Higher	1465	This variable controls the verbosity level of the perl extension. Higher
1292	numbers indicate more verbose output.	1466	numbers indicate more verbose output.
1293		1467
1294	=over 4	1468	=over 4
1295		1469
1296	=item =0 - only fatal messages	1470	=item == 0 - fatal messages
1297		1471
1298	=item =3 - script loading and management	1472	=item >= 3 - script loading and management
1299		1473
1300	=item =10 - all events received	1474	=item >=10 - all events received
1301		1475
1302	=back	1476	=back
1303		1477
1304	=head1 AUTHOR	1478	=head1 AUTHOR
1305		1479

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