[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.76 by root, Tue Jan 10 19:46:28 2006 UTC

…		…
26	thus must be encoded as UTF-8.	26	thus must be encoded as UTF-8.
27		27
28	Each script will only ever be loaded once, even in @@RXVT_NAME@@d, where	28	Each script will only ever be loaded once, even in @@RXVT_NAME@@d, where
29	scripts will be shared (but not enabled) for all terminals.	29	scripts will be shared (but not enabled) for all terminals.
30		30
31	=head2 Prepackaged Extensions	31	=head1 PREPACKAGED EXTENSIONS
32		32
33	This section describes the extensiosn delivered with this version. You can	33	This section describes the extensions delivered with this release. You can
34	find them in F<@@RXVT_LIBDIR@@/urxvt/perl/>.	34	find them in F<@@RXVT_LIBDIR@@/urxvt/perl/>.
35		35
36	You can activate them like this:	36	You can activate them like this:
37		37
38	@@RXVT_NAME@@ -pe <extensionname>	38	@@RXVT_NAME@@ -pe <extensionname>
39		39
40	=over 4	40	=over 4
41		41
42	=item selection (enabled by default)	42	=item selection (enabled by default)
43		43
44	Intelligent selection. This extension tries to be more intelligent when	44	(More) intelligent selection. This extension tries to be more intelligent
45	the user extends selections (double-click). Right now, it tries to select	45	when the user extends selections (double-click). Right now, it tries to
46	urls and complete shell-quoted arguments, which is very convenient, too,	46	select urls and complete shell-quoted arguments, which is very convenient,
47	if your F<ls> supports C<--quoting-style=shell>.	47	too, if your F<ls> supports C<--quoting-style=shell>.
48		48
49	It also offers the following bindable event:	49	It also offers the following bindable keyboard command:
50		50
51	=over 4	51	=over 4
52		52
53	=item rot13	53	=item rot13
54		54
…		…
64	runtime.	64	runtime.
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 (such as uri unescaping, perl
		70	evalution, web-browser starting etc.), depending on content.
		71
		72	=item searchable-scrollback<hotkey> (enabled by default)
		73
		74	Adds regex search functionality to the scrollback buffer, triggered
		75	by a hotkey (default: C<M-s>). When in search mode, normal terminal
		76	input/output is suspended.
		77
		78	C</> starts an incremental regex search, C<n> searches further, C<p> or
		79	C<N> jump to the previous match, C<G> jumps to the bottom and clears the
		80	history, C<enter> leaves search mode at the current position and C<escape>
		81	returns to the original position.
70		82
71	=item digital-clock	83	=item digital-clock
72		84
73	Displays a digital clock using the built-in overlay.	85	Displays a digital clock using the built-in overlay.
74		86
…		…
87	Displays a very simple digital clock in the upper right corner of the	99	Displays a very simple digital clock in the upper right corner of the
88	window. Illustrates overwriting the refresh callbacks to create your own	100	window. Illustrates overwriting the refresh callbacks to create your own
89	overlays or changes.	101	overlays or changes.
90		102
91	=back	103	=back
		104
		105	=head1 API DOCUMENTATION
92		106
93	=head2 General API Considerations	107	=head2 General API Considerations
94		108
95	All objects (such as terminals, time watchers etc.) are typical	109	All objects (such as terminals, time watchers etc.) are typical
96	reference-to-hash objects. The hash can be used to store anything you	110	reference-to-hash objects. The hash can be used to store anything you
…		…
124	Either binary data or - more common - a text string encoded in a	138	Either binary data or - more common - a text string encoded in a
125	locale-specific way.	139	locale-specific way.
126		140
127	=back	141	=back
128		142
		143	=head2 Extension Objects
		144
		145	Very perl extension is a perl class. A separate perl object is created
		146	for each terminal and each extension and passed as the first parameter to
		147	hooks. So extensions can use their C<$self> object without having to think
		148	about other extensions, with the exception of methods and members that
		149	begin with an underscore character C<_>: these are reserved for internal
		150	use.
		151
		152	Although it isn't a C<urxvt::term> object, you can call all methods of the
		153	C<urxvt::term> class on this object.
		154
		155	It has the following methods and data members:
		156
		157	=over 4
		158
		159	=item $urxvt_term = $self->{term}
		160
		161	Returns the C<urxvt::term> object associated with this instance of the
		162	extension. This member I<must not> be changed in any way.
		163
		164	=item $self->enable ($hook_name => $cb, [$hook_name => $cb..])
		165
		166	Dynamically enable the given hooks (named without the C<on_> prefix) for
		167	this extension, replacing any previous hook. This is useful when you want
		168	to overwrite time-critical hooks only temporarily.
		169
		170	=item $self->disable ($hook_name[, $hook_name..])
		171
		172	Dynamically disable the given hooks.
		173
		174	=back
		175
129	=head2 Hooks	176	=head2 Hooks
130		177
131	The following subroutines can be declared in extension files, and will be	178	The following subroutines can be declared in extension files, and will be
132	called whenever the relevant event happens.	179	called whenever the relevant event happens.
133		180
134	The first argument passed to them is an object private to each terminal	181	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	182	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		183
141	All of them must return a boolean value. If it is true, then the event	184	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,	185	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.	186	skipped, and the relevant action might not be carried out by the C++ code.
144		187
145	When in doubt, return a false value (preferably C<()>).	188	I<< When in doubt, return a false value (preferably C<()>). >>
146		189
147	=over 4	190	=over 4
148		191
149	=item on_init $term	192	=item on_init $term
150		193
…		…
204	than the scroll back buffer or the terminal.	247	than the scroll back buffer or the terminal.
205		248
206	It is called before lines are scrolled out (so rows 0 .. min ($lines - 1,	249	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	250	$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.	251	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		252
214	=item on_osc_seq $term, $string	253	=item on_osc_seq $term, $string
215		254
216	Called whenever the B<ESC ] 777 ; string ST> command sequence (OSC =	255	Called whenever the B<ESC ] 777 ; string ST> command sequence (OSC =
217	operating system command) is processed. Cursor position and other state	256	operating system command) is processed. Cursor position and other state
…		…
230	can filter/change and output the text yourself by returning a true value	269	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	270	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	271	might be very slow, however, as your hook is called for B<all> text being
233	output.	272	output.
234		273
		274	=item on_tt_write $term, $octets
		275
		276	Called whenever some data is written to the tty/pty and can be used to
		277	suppress or filter tty input.
		278
235	=item on_line_update $term, $row	279	=item on_line_update $term, $row
236		280
237	Called whenever a line was updated or changed. Can be used to filter	281	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	282	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,	283	that are being shown will be filtered, and, due to performance reasons,
…		…
271	=item on_focus_out $term	315	=item on_focus_out $term
272		316
273	Called wheneever the window loses keyboard focus, before rxvt-unicode does	317	Called wheneever the window loses keyboard focus, before rxvt-unicode does
274	focus out processing.	318	focus out processing.
275		319
276	=item on_key_press $term, $event, $octets	320	=item on_key_press $term, $event, $keysym, $octets
277		321
278	=item on_key_release $term, $event	322	=item on_key_release $term, $event, $keysym
279		323
280	=item on_button_press $term, $event	324	=item on_button_press $term, $event
281		325
282	=item on_button_release $term, $event	326	=item on_button_release $term, $event
283		327
…		…
303		347
304	=head2 Variables in the C<urxvt> Package	348	=head2 Variables in the C<urxvt> Package
305		349
306	=over 4	350	=over 4
307		351
		352	=item $urxvt::LIBDIR
		353
		354	The rxvt-unicode library directory, where, among other things, the perl
		355	modules and scripts are stored.
		356
		357	=item $urxvt::RESCLASS, $urxvt::RESCLASS
		358
		359	The resource class and name rxvt-unicode uses to look up X resources.
		360
		361	=item $urxvt::RXVTNAME
		362
		363	The basename of the installed binaries, usually C<urxvt>.
		364
308	=item $urxvt::TERM	365	=item $urxvt::TERM
309		366
310	The current terminal. This variable stores the current C<urxvt::term>	367	The current terminal. This variable stores the current C<urxvt::term>
311	object, whenever a callback/hook is executing.	368	object, whenever a callback/hook is executing.
		369
		370	=item
312		371
313	=back	372	=back
314		373
315	=head2 Functions in the C<urxvt> Package	374	=head2 Functions in the C<urxvt> Package
316		375
…		…
337	that calls this function.	396	that calls this function.
338		397
339	Using this function has the advantage that its output ends up in the	398	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.	399	correct place, e.g. on stderr of the connecting urxvtc client.
341		400
		401	=item $is_safe = urxvt::safe
		402
		403	Returns true when it is safe to do potentially unsafe things, such as
		404	evaluating perl code specified by the user. This is true when urxvt was
		405	started setuid or setgid.
		406
342	=item $time = urxvt::NOW	407	=item $time = urxvt::NOW
343		408
344	Returns the "current time" (as per the event loop).	409	Returns the "current time" (as per the event loop).
345		410
346	=item urxvt::CurrentTime	411	=item urxvt::CurrentTime
…		…
384		449
385	=item $background = urxvt::GET_BASEBG $rend	450	=item $background = urxvt::GET_BASEBG $rend
386		451
387	Return the foreground/background colour index, respectively.	452	Return the foreground/background colour index, respectively.
388		453
389	=item $rend = urxvt::SET_FGCOLOR ($rend, $new_colour)	454	=item $rend = urxvt::SET_FGCOLOR $rend, $new_colour
390		455
391	=item $rend = urxvt::SET_BGCOLOR ($rend, $new_colour)	456	=item $rend = urxvt::SET_BGCOLOR $rend, $new_colour
392		457
393	Replace the foreground/background colour in the rendition mask with the	458	Replace the foreground/background colour in the rendition mask with the
394	specified one.	459	specified one.
395		460
396	=item $value = urxvt::GET_CUSTOM ($rend)	461	=item $value = urxvt::GET_CUSTOM $rend
397		462
398	Return the "custom" value: Every rendition has 5 bits for use by	463	Return the "custom" value: Every rendition has 5 bits for use by
399	extensions. They can be set and changed as you like and are initially	464	extensions. They can be set and changed as you like and are initially
400	zero.	465	zero.
401		466
402	=item $rend = urxvt::SET_CUSTOM ($rend, $new_value)	467	=item $rend = urxvt::SET_CUSTOM $rend, $new_value
403		468
404	Change the custom value.	469	Change the custom value.
405		470
406	=back	471	=back
407		472
…		…
409		474
410	package urxvt;	475	package urxvt;
411		476
412	use utf8;	477	use utf8;
413	use strict;	478	use strict;
		479	use Carp ();
414	use Scalar::Util ();	480	use Scalar::Util ();
415	use List::Util ();	481	use List::Util ();
416		482
417	our $VERSION = 1;	483	our $VERSION = 1;
418	our $TERM;	484	our $TERM;
419	our @HOOKNAME;	485	our @HOOKNAME;
		486	our %HOOKTYPE = map +($HOOKNAME[$_] => $_), 0..$#HOOKNAME;
420	our %OPTION;	487	our %OPTION;
		488
421	our $LIBDIR;	489	our $LIBDIR;
		490	our $RESNAME;
		491	our $RESCLASS;
		492	our $RXVTNAME;
422		493
423	BEGIN {	494	BEGIN {
424	urxvt->bootstrap;	495	urxvt->bootstrap;
425		496
426	# overwrite perl's warn	497	# overwrite perl's warn
…		…
429	$msg .= "\n"	500	$msg .= "\n"
430	unless $msg =~ /\n$/;	501	unless $msg =~ /\n$/;
431	urxvt::warn ($msg);	502	urxvt::warn ($msg);
432	};	503	};
433		504
		505	delete $ENV{IFS};
		506	delete $ENV{CDPATH};
		507	delete $ENV{BASH_ENV};
434	$ENV{PATH} = "/bin:/sbin:/usr/bin:/usr/sbin:/usr/local/bin:/usr/local/sbin:/opt/bin:/opt/sbin";	508	$ENV{PATH} = "/bin:/sbin:/usr/bin:/usr/sbin:/usr/local/bin:/usr/local/sbin:/opt/bin:/opt/sbin";
435	delete $ENV{CDPATH};
436	}	509	}
437		510
438	my @hook_count;	511	my @hook_count;
439	my $verbosity = $ENV{URXVT_PERL_VERBOSITY};	512	my $verbosity = $ENV{URXVT_PERL_VERBOSITY};
440		513
441	sub verbose {	514	sub verbose {
442	my ($level, $msg) = @_;	515	my ($level, $msg) = @_;
443	warn "$msg\n" if $level <= $verbosity;	516	warn "$msg\n" if $level <= $verbosity;
444	}	517	}
445		518
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";	519	my $extension_pkg = "extension0000";
464	my %extension_pkg;	520	my %extension_pkg;
465		521
466	# load a single script into its own package, once only	522	# load a single script into its own package, once only
467	sub extension_package($) {	523	sub extension_package($) {
…		…
473	verbose 3, "loading extension '$path' into package '$pkg'";	529	verbose 3, "loading extension '$path' into package '$pkg'";
474		530
475	open my $fh, "<:raw", $path	531	open my $fh, "<:raw", $path
476	or die "$path: $!";	532	or die "$path: $!";
477		533
		534	my $source = untaint
478	my $source = untaint "package $pkg; use strict; use utf8;\n"	535	"package $pkg; use strict; use utf8;\n"
479	. "use base urxvt::term::proxy::;\n"	536	. "use base urxvt::term::extension::;\n"
480	. "#line 1 \"$path\"\n{\n"	537	. "#line 1 \"$path\"\n{\n"
481	. (do { local $/; <$fh> })	538	. (do { local $/; <$fh> })
482	. "\n};\n1";	539	. "\n};\n1";
483		540
		541	eval $source
484	eval $source or die "$path: $@";	542	or die "$path: $@";
485		543
486	$pkg	544	$pkg
487	}	545	}
488	}	546	}
489		547
…		…
495	my $htype = shift;	553	my $htype = shift;
496		554
497	if ($htype == 0) { # INIT	555	if ($htype == 0) { # INIT
498	my @dirs = ((split /:/, $TERM->resource ("perl_lib")), "$LIBDIR/perl");	556	my @dirs = ((split /:/, $TERM->resource ("perl_lib")), "$LIBDIR/perl");
499		557
500	my %want_ext;	558	my %ext_arg;
501		559
502	for (map { split /,/, $TERM->resource ("perl_ext_$_") } 1, 2) {	560	for (map { split /,/, $TERM->resource ("perl_ext_$_") } 1, 2) {
503	if ($_ eq "default") {	561	if ($_ eq "default") {
504	$want_ext{$_}++ for qw(selection option-popup selection-popup);	562	$ext_arg{$_} \|\|= [] for qw(selection option-popup selection-popup searchable-scrollback);
505	} elsif (/^-(.*)$/) {	563	} elsif (/^-(.*)$/) {
506	delete $want_ext{$1};	564	delete $ext_arg{$1};
		565	} elsif (/^([^<]+)<(.*)>$/) {
		566	push @{ $ext_arg{$1} }, $2;
507	} else {	567	} else {
508	$want_ext{$_}++;	568	$ext_arg{$_} \|\|= [];
509	}	569	}
510	}	570	}
511		571
512	for my $ext (keys %want_ext) {	572	while (my ($ext, $argv) = each %ext_arg) {
513	my @files = grep -f $_, map "$_/$ext", @dirs;	573	my @files = grep -f $_, map "$_/$ext", @dirs;
514		574
515	if (@files) {	575	if (@files) {
516	register_package extension_package $files[0];	576	$TERM->register_package (extension_package $files[0], $argv);
517	} else {	577	} else {
518	warn "perl extension '$ext' not found in perl library search path\n";	578	warn "perl extension '$ext' not found in perl library search path\n";
519	}	579	}
520	}	580	}
521		581
…		…
530	if $verbosity >= 10;	590	if $verbosity >= 10;
531		591
532	keys %$cb;	592	keys %$cb;
533		593
534	while (my ($pkg, $cb) = each %$cb) {	594	while (my ($pkg, $cb) = each %$cb) {
535	eval {	595	$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;	596	and last;
544	};	597
545	if ($@) {	598	if ($@) {
546	$TERM->ungrab; # better to lose the grab than the session	599	$TERM->ungrab; # better to lose the grab than the session
547	warn $@;	600	warn $@;
548	}	601	}
549	}	602	}
550	}	603	}
551		604
552	if ($htype == 1) { # DESTROY	605	if ($htype == 1) { # DESTROY
553	# remove hooks if unused
554	if (my $hook = $TERM->{_hook}) {	606	if (my $hook = delete $TERM->{_hook}) {
555	for my $htype (0..$#$hook) {	607	for my $htype (0..$#$hook) {
556	$hook_count[$htype] -= scalar keys %{ $hook->[$htype] \|\| {} }	608	$hook_count[$htype] -= scalar keys %{ $hook->[$htype] \|\| {} }
557	or set_should_invoke $htype, 0;	609	or set_should_invoke $htype, 0;
558	}	610	}
559	}	611	}
…		…
566	}	618	}
567		619
568	$retval	620	$retval
569	}	621	}
570		622
571	# urxvt::term::proxy	623	# urxvt::term::extension
572		624
573	sub urxvt::term::proxy::AUTOLOAD {	625	package urxvt::term::extension;
574	$urxvt::term::proxy::AUTOLOAD =~ /:([^:]+)$/	626
		627	sub enable {
		628	my ($self, %hook) = @_;
		629	my $pkg = $self->{_pkg};
		630
		631	while (my ($name, $cb) = each %hook) {
		632	my $htype = $HOOKTYPE{uc $name};
		633	defined $htype
		634	or Carp::croak "unsupported hook type '$name'";
		635
		636	unless (exists $self->{term}{_hook}[$htype]{$pkg}) {
		637	$hook_count[$htype]++
		638	or urxvt::set_should_invoke $htype, 1;
		639	}
		640
		641	$self->{term}{_hook}[$htype]{$pkg} = $cb;
		642	}
		643	}
		644
		645	sub disable {
		646	my ($self, @hook) = @_;
		647	my $pkg = $self->{_pkg};
		648
		649	for my $name (@hook) {
		650	my $htype = $HOOKTYPE{uc $name};
		651	defined $htype
		652	or Carp::croak "unsupported hook type '$name'";
		653
		654	if (delete $self->{term}{_hook}[$htype]{$pkg}) {
		655	--$hook_count[$htype]
		656	or urxvt::set_should_invoke $htype, 0;
		657	}
		658	}
		659	}
		660
		661	our $AUTOLOAD;
		662
		663	sub AUTOLOAD {
		664	$AUTOLOAD =~ /:([^:]+)$/
575	or die "FATAL: \$AUTOLOAD '$urxvt::term::proxy::AUTOLOAD' unparsable";	665	or die "FATAL: \$AUTOLOAD '$AUTOLOAD' unparsable";
576		666
577	eval qq{	667	eval qq{
578	sub $urxvt::term::proxy::AUTOLOAD {	668	sub $AUTOLOAD {
579	my \$proxy = shift;	669	my \$proxy = shift;
580	\$proxy->{term}->$1 (\@_)	670	\$proxy->{term}->$1 (\@_)
581	}	671	}
582	1	672	1
583	} or die "FATAL: unable to compile method forwarder: $@";	673	} or die "FATAL: unable to compile method forwarder: $@";
584		674
585	goto &$urxvt::term::proxy::AUTOLOAD;	675	goto &$AUTOLOAD;
586	}	676	}
587		677
588	sub urxvt::term::proxy::DESTROY {	678	sub DESTROY {
589	# nop	679	# nop
590	}	680	}
591		681
592	# urxvt::destroy_hook	682	# urxvt::destroy_hook
593		683
…		…
603		693
604	=head2 The C<urxvt::anyevent> Class	694	=head2 The C<urxvt::anyevent> Class
605		695
606	The sole purpose of this class is to deliver an interface to the	696	The sole purpose of this class is to deliver an interface to the
607	C<AnyEvent> module - any module using it will work inside urxvt without	697	C<AnyEvent> module - any module using it will work inside urxvt without
608	further work. The only exception is that you cannot wait on condition	698	further programming. The only exception is that you cannot wait on
609	variables, but non-blocking condvar use is ok. What this means is that you	699	condition variables, but non-blocking condvar use is ok. What this means
610	cannot use blocking APIs, but the non-blocking variant should work.	700	is that you cannot use blocking APIs, but the non-blocking variant should
		701	work.
611		702
612	=cut	703	=cut
613		704
614	our $VERSION = 1;	705	our $VERSION = 1;
615		706
…		…
660	${$_[0]}++;	751	${$_[0]}++;
661	}	752	}
662		753
663	sub urxvt::anyevent::condvar::wait {	754	sub urxvt::anyevent::condvar::wait {
664	unless (${$_[0]}) {	755	unless (${$_[0]}) {
665	require Carp;
666	Carp::croak ("AnyEvent->condvar blocking wait unsupported in urxvt, use a non-blocking API");	756	Carp::croak "AnyEvent->condvar blocking wait unsupported in urxvt, use a non-blocking API";
667	}	757	}
668	}	758	}
669		759
670	package urxvt::term;	760	package urxvt::term;
671		761
672	=head2 The C<urxvt::term> Class	762	=head2 The C<urxvt::term> Class
673		763
674	=over 4	764	=over 4
675		765
		766	=cut
		767
		768	# find on_xxx subs in the package and register them
		769	# as hooks
		770	sub register_package {
		771	my ($self, $pkg, $argv) = @_;
		772
		773	my $proxy = bless {
		774	_pkg => $pkg,
		775	argv => $argv,
		776	}, $pkg;
		777	Scalar::Util::weaken ($proxy->{term} = $self);
		778
		779	$self->{_pkg}{$pkg} = $proxy;
		780
		781	for my $name (@HOOKNAME) {
		782	if (my $ref = $pkg->can ("on_" . lc $name)) {
		783	$proxy->enable ($name => $ref);
		784	}
		785	}
		786	}
		787
676	=item $term->destroy	788	=item $term->destroy
677		789
678	Destroy the terminal object (close the window, free resources etc.).	790	Destroy the terminal object (close the window, free resources
		791	etc.). Please note that @@RXVT_NAME@@ will not exit as long as any event
		792	watchers (timers, io watchers) are still active.
679		793
680	=item $isset = $term->option ($optval[, $set])	794	=item $isset = $term->option ($optval[, $set])
681		795
682	Returns true if the option specified by C<$optval> is enabled, and	796	Returns true if the option specified by C<$optval> is enabled, and
683	optionally change it. All option values are stored by name in the hash	797	optionally change it. All option values are stored by name in the hash
…		…
733	my ($self, $name) = (shift, shift);	847	my ($self, $name) = (shift, shift);
734	unshift @_, $self, $name, ($name =~ s/\s\+\s(\d+)$// ? $1 : 0);	848	unshift @_, $self, $name, ($name =~ s/\s\+\s(\d+)$// ? $1 : 0);
735	&urxvt::term::_resource	849	&urxvt::term::_resource
736	}	850	}
737		851
		852	=item $success = $term->parse_keysym ($keysym_spec, $command_string)
		853
		854	Adds a keymap translation exactly as specified via a resource. See the
		855	C<keysym> resource in the @@RXVT_NAME@@(1) manpage.
		856
738	=item $rend = $term->rstyle ([$new_rstyle])	857	=item $rend = $term->rstyle ([$new_rstyle])
739		858
740	Return and optionally change the current rendition. Text that is output by	859	Return and optionally change the current rendition. Text that is output by
741	the terminal application will use this style.	860	the terminal application will use this style.
742		861
…		…
761		880
762	=item $oldtext = $term->selection ([$newtext])	881	=item $oldtext = $term->selection ([$newtext])
763		882
764	Return the current selection text and optionally replace it by C<$newtext>.	883	Return the current selection text and optionally replace it by C<$newtext>.
765		884
766	#=item $term->overlay ($x, $y, $text)	885	=item $term->overlay_simple ($x, $y, $text)
767	#	886
768	#Create a simple multi-line overlay box. See the next method for details.	887	Create a simple multi-line overlay box. See the next method for details.
769	#	888
770	#=cut	889	=cut
771	#	890
772	#sub urxvt::term::scr_overlay {	891	sub overlay_simple {
773	# my ($self, $x, $y, $text) = @_;	892	my ($self, $x, $y, $text) = @_;
774	#	893
775	# my @lines = split /\n/, $text;	894	my @lines = split /\n/, $text;
776	#	895
777	# my $w = 0;	896	my $w = List::Util::max map $self->strwidth ($_), @lines;
778	# for (map $self->strwidth ($_), @lines) {	897
779	# $w = $_ if $w < $_;
780	# }
781	#
782	# $self->scr_overlay_new ($x, $y, $w, scalar @lines);	898	my $overlay = $self->overlay ($x, $y, $w, scalar @lines);
783	# $self->scr_overlay_set (0, $_, $lines[$_]) for 0.. $#lines;	899	$overlay->set (0, $_, $lines[$_]) for 0.. $#lines;
784	#}	900
		901	$overlay
		902	}
785		903
786	=item $term->overlay ($x, $y, $width, $height[, $rstyle[, $border]])	904	=item $term->overlay ($x, $y, $width, $height[, $rstyle[, $border]])
787		905
788	Create a new (empty) overlay at the given position with the given	906	Create a new (empty) overlay at the given position with the given
789	width/height. C<$rstyle> defines the initial rendition style	907	width/height. C<$rstyle> defines the initial rendition style
…		…
856		974
857	=item $string = $term->locale_decode ($octets)	975	=item $string = $term->locale_decode ($octets)
858		976
859	Convert the given locale-encoded octets into a perl string.	977	Convert the given locale-encoded octets into a perl string.
860		978
		979	=item $term->scr_xor_span ($beg_row, $beg_col, $end_row, $end_col[, $rstyle])
		980
		981	XORs the rendition values in the given span with the provided value
		982	(default: C<RS_RVid>). Useful in refresh hooks to provide effects similar
		983	to the selection.
		984
		985	=item $term->scr_xor_rect ($beg_row, $beg_col, $end_row, $end_col[, $rstyle1[, $rstyle2]])
		986
		987	Similar to C<scr_xor_span>, but xors a rectangle instead. Trailing
		988	whitespace will additionally be xored with the C<$rstyle2>, which defaults
		989	to C<RS_RVid \| RS_Uline>, which removes reverse video again and underlines
		990	it instead.
		991
		992	=item $term->scr_bell
		993
		994	Ring the bell!
		995
861	=item $term->scr_add_lines ($string)	996	=item $term->scr_add_lines ($string)
862		997
863	Write the given text string to the screen, as if output by the application	998	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	999	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	1000	codes), but is free to use line feeds, carriage returns and tabs. The
…		…
879		1014
880	Write the octets given in C<$data> to the tty (i.e. as program input). To	1015	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	1016	pass characters instead of octets, you should convert your strings first
882	to the locale-specific encoding using C<< $term->locale_encode >>.	1017	to the locale-specific encoding using C<< $term->locale_encode >>.
883		1018
		1019	=item $old_events = $term->pty_ev_events ([$new_events])
		1020
		1021	Replaces the event mask of the pty watcher by the given event mask. Can
		1022	be used to suppress input and output handling to the pty/tty. See the
		1023	description of C<< urxvt::timer->events >>. Make sure to always restore
		1024	the previous value.
		1025
884	=item $windowid = $term->parent	1026	=item $windowid = $term->parent
885		1027
886	Return the window id of the toplevel window.	1028	Return the window id of the toplevel window.
887		1029
888	=item $windowid = $term->vt	1030	=item $windowid = $term->vt
…		…
912	=item $nrow_plus_saveLines = $term->total_rows	1054	=item $nrow_plus_saveLines = $term->total_rows
913		1055
914	=item $lines_in_scrollback = $term->nsaved	1056	=item $lines_in_scrollback = $term->nsaved
915		1057
916	Return various integers describing terminal characteristics.	1058	Return various integers describing terminal characteristics.
		1059
		1060	=item $lc_ctype = $term->locale
		1061
		1062	Returns the LC_CTYPE category string used by this rxvt-unicode.
		1063
		1064	=item $x_display = $term->display_id
		1065
		1066	Return the DISPLAY used by rxvt-unicode.
917		1067
918	=item $modifiermask = $term->ModLevel3Mask	1068	=item $modifiermask = $term->ModLevel3Mask
919		1069
920	=item $modifiermask = $term->ModMetaMask	1070	=item $modifiermask = $term->ModMetaMask
921		1071
…		…
1098	$offset / $self->{ncol} + $self->{beg},	1248	$offset / $self->{ncol} + $self->{beg},
1099	$offset % $self->{ncol}	1249	$offset % $self->{ncol}
1100	)	1250	)
1101	}	1251	}
1102		1252
1103	=item ($row, $col) = $line->coord_of ($offset)
1104	=item $text = $term->special_encode $string	1253	=item $text = $term->special_encode $string
1105		1254
1106	Converts a perl string into the special encoding used by rxvt-unicode,	1255	Converts a perl string into the special encoding used by rxvt-unicode,
1107	where one character corresponds to one screen cell. See	1256	where one character corresponds to one screen cell. See
1108	C<< $term->ROW_t >> for details.	1257	C<< $term->ROW_t >> for details.
…		…
1110	=item $string = $term->special_decode $text	1259	=item $string = $term->special_decode $text
1111		1260
1112	Converts rxvt-unicodes text reprsentation into a perl string. See	1261	Converts rxvt-unicodes text reprsentation into a perl string. See
1113	C<< $term->ROW_t >> for details.	1262	C<< $term->ROW_t >> for details.
1114		1263
		1264	=item $success = $term->grab_button ($button, $modifiermask)
		1265
		1266	Registers a synchronous button grab. See the XGrabButton manpage.
		1267
		1268	=item $success = $term->grab ($eventtime[, $sync])
		1269
		1270	Calls XGrabPointer and XGrabKeyboard in asynchronous (default) or
		1271	synchronous (C<$sync> is true). Also remembers the grab timestampe.
		1272
		1273	=item $term->allow_events_async
		1274
		1275	Calls XAllowEvents with AsyncBoth for the most recent grab.
		1276
		1277	=item $term->allow_events_sync
		1278
		1279	Calls XAllowEvents with SyncBoth for the most recent grab.
		1280
		1281	=item $term->allow_events_replay
		1282
		1283	Calls XAllowEvents with both ReplayPointer and ReplayKeyboard for the most
		1284	recent grab.
		1285
		1286	=item $term->ungrab
		1287
		1288	Calls XUngrab for the most recent grab. Is called automatically on
		1289	evaluation errors, as it is better to lose the grab in the error case as
		1290	the session.
		1291
1115	=back	1292	=back
1116		1293
1117	=cut	1294	=cut
1118		1295
1119	package urxvt::popup;	1296	package urxvt::popup;
…		…
1134	$item->{render} \|\|= sub { $_[0]{text} };	1311	$item->{render} \|\|= sub { $_[0]{text} };
1135		1312
1136	push @{ $self->{item} }, $item;	1313	push @{ $self->{item} }, $item;
1137	}	1314	}
1138		1315
1139	sub add_separator {	1316	=item $popup->add_title ($title)
1140	my ($self, $sep) = @_;
1141		1317
1142	$sep \|\|= "═";	1318	Adds a non-clickable title to the popup.
1143		1319
1144	$self->add_item ({	1320	=cut
1145	rend => { normal => "\x1b[0;30;47m", hover => "\x1b[0;30;47m", active => "\x1b[0;30;47m" },
1146	text => "",
1147	render => sub { $sep x $urxvt::TERM->ncol },
1148	activate => sub { },
1149	});
1150	}
1151		1321
1152	sub add_title {	1322	sub add_title {
1153	my ($self, $title) = @_;	1323	my ($self, $title) = @_;
1154		1324
1155	$self->add_item ({	1325	$self->add_item ({
…		…
1157	text => $title,	1327	text => $title,
1158	activate => sub { },	1328	activate => sub { },
1159	});	1329	});
1160	}	1330	}
1161		1331
		1332	=item $popup->add_separator ([$sepchr])
		1333
		1334	Creates a separator, optionally using the character given as C<$sepchr>.
		1335
		1336	=cut
		1337
		1338	sub add_separator {
		1339	my ($self, $sep) = @_;
		1340
		1341	$sep \|\|= "=";
		1342
		1343	$self->add_item ({
		1344	rend => { normal => "\x1b[0;30;47m", hover => "\x1b[0;30;47m", active => "\x1b[0;30;47m" },
		1345	text => "",
		1346	render => sub { $sep x $self->{term}->ncol },
		1347	activate => sub { },
		1348	});
		1349	}
		1350
		1351	=item $popup->add_button ($text, $cb)
		1352
		1353	Adds a clickable button to the popup. C<$cb> is called whenever it is
		1354	selected.
		1355
		1356	=cut
		1357
1162	sub add_button {	1358	sub add_button {
1163	my ($self, $text, $cb) = @_;	1359	my ($self, $text, $cb) = @_;
1164		1360
1165	$self->add_item ({ type => "button", text => "[ $text ]", activate => $cb});	1361	$self->add_item ({ type => "button", text => $text, activate => $cb});
1166	}	1362	}
		1363
		1364	=item $popup->add_toggle ($text, $cb, $initial_value)
		1365
		1366	Adds a toggle/checkbox item to the popup. Teh callback gets called
		1367	whenever it gets toggled, with a boolean indicating its value as its first
		1368	argument.
		1369
		1370	=cut
1167		1371
1168	sub add_toggle {	1372	sub add_toggle {
1169	my ($self, $text, $cb, $value) = @_;	1373	my ($self, $text, $cb, $value) = @_;
1170		1374
1171	my $item; $item = {	1375	my $item; $item = {
1172	type => "button",	1376	type => "button",
1173	text => " $text",	1377	text => " $text",
1174	value => $value,	1378	value => $value,
1175	render => sub { ($_[0]{value} ? "* " : " ") . $text },	1379	render => sub { ($_[0]{value} ? "* " : " ") . $text },
1176	activate => sub { $cb->($_[0]{value} = !$_[0]{value}); },	1380	activate => sub { $cb->($_[1]{value} = !$_[1]{value}); },
1177	};	1381	};
1178		1382
1179	$self->add_item ($item);	1383	$self->add_item ($item);
1180	}	1384	}
		1385
		1386	=item $popup->show
		1387
		1388	Displays the popup (which is initially hidden).
		1389
		1390	=cut
1181		1391
1182	sub show {	1392	sub show {
1183	my ($self) = @_;	1393	my ($self) = @_;
1184		1394
1185	local $urxvt::popup::self = $self;	1395	local $urxvt::popup::self = $self;
1186		1396
		1397	local $ENV{LC_ALL} = $self->{term}->locale;
		1398
1187	urxvt->new ("--perl-lib" => "", "--perl-ext-common" => "", "-pty-fd" => -1, "-sl" => 0, "-b" => 0,	1399	urxvt->new ("--perl-lib" => "", "--perl-ext-common" => "", "-pty-fd" => -1, "-sl" => 0, "-b" => 0,
1188	"--transient-for" => $self->{term}->parent,	1400	"--transient-for" => $self->{term}->parent,
		1401	"-display" => $self->{term}->display_id,
1189	"-pe" => "urxvt-popup")	1402	"-pe" => "urxvt-popup")
1190	or die "unable to create popup window\n";	1403	or die "unable to create popup window\n";
1191	}	1404	}
1192		1405
1193	sub DESTROY {	1406	sub DESTROY {
…		…
1256		1469
1257	$term->{socket} = ...	1470	$term->{socket} = ...
1258	$term->{iow} = urxvt::iow	1471	$term->{iow} = urxvt::iow
1259	->new	1472	->new
1260	->fd (fileno $term->{socket})	1473	->fd (fileno $term->{socket})
1261	->events (1) # wait for read data	1474	->events (urxvt::EVENT_READ)
1262	->start	1475	->start
1263	->cb (sub {	1476	->cb (sub {
1264	my ($iow, $revents) = @_;	1477	my ($iow, $revents) = @_;
1265	# $revents must be 1 here, no need to check	1478	# $revents must be 1 here, no need to check
1266	sysread $term->{socket}, my $buf, 8192	1479	sysread $term->{socket}, my $buf, 8192
…		…
1283		1496
1284	Set the filedescriptor (not handle) to watch.	1497	Set the filedescriptor (not handle) to watch.
1285		1498
1286	=item $iow = $iow->events ($eventmask)	1499	=item $iow = $iow->events ($eventmask)
1287		1500
1288	Set the event mask to watch. Bit #0 (value C<1>) enables watching for read	1501	Set the event mask to watch. The only allowed values are
1289	data, Bit #1 (value C<2>) enables watching for write data.	1502	C<urxvt::EVENT_READ> and C<urxvt::EVENT_WRITE>, which might be ORed
		1503	together, or C<urxvt::EVENT_NONE>.
1290		1504
1291	=item $iow = $iow->start	1505	=item $iow = $iow->start
1292		1506
1293	Start watching for requested events on the given handle.	1507	Start watching for requested events on the given handle.
1294		1508

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.76 by root, Tue Jan 10 19:46:28 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.76 by root, Tue Jan 10 19:46:28 2006 UTC