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

Comparing rxvt-unicode/src/urxvt.pm (file contents):
Revision 1.56 by root, Sun Jan 8 05:52:42 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
…		…
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 (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.
65		82
66	=item digital-clock	83	=item digital-clock
67		84
68	Displays a digital clock using the built-in overlay.	85	Displays a digital clock using the built-in overlay.
69		86
…		…
82	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
83	window. Illustrates overwriting the refresh callbacks to create your own	100	window. Illustrates overwriting the refresh callbacks to create your own
84	overlays or changes.	101	overlays or changes.
85		102
86	=back	103	=back
		104
		105	=head1 API DOCUMENTATION
87		106
88	=head2 General API Considerations	107	=head2 General API Considerations
89		108
90	All objects (such as terminals, time watchers etc.) are typical	109	All objects (such as terminals, time watchers etc.) are typical
91	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
…		…
119	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
120	locale-specific way.	139	locale-specific way.
121		140
122	=back	141	=back
123		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
124	=head2 Hooks	176	=head2 Hooks
125		177
126	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
127	called whenever the relevant event happens.	179	called whenever the relevant event happens.
128		180
129	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
130	and extension package. You can call all C<urxvt::term> methods on it, but	182	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		183
136	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
137	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
138	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.
139		187
140	When in doubt, return a false value (preferably C<()>).	188	I<< When in doubt, return a false value (preferably C<()>). >>
141		189
142	=over 4	190	=over 4
143		191
144	=item on_init $term	192	=item on_init $term
145		193
…		…
199	than the scroll back buffer or the terminal.	247	than the scroll back buffer or the terminal.
200		248
201	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,
202	$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
203	number of lines that will be in the scrollback buffer.	251	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		252
209	=item on_osc_seq $term, $string	253	=item on_osc_seq $term, $string
210		254
211	Called whenever the B<ESC ] 777 ; string ST> command sequence (OSC =	255	Called whenever the B<ESC ] 777 ; string ST> command sequence (OSC =
212	operating system command) is processed. Cursor position and other state	256	operating system command) is processed. Cursor position and other state
…		…
225	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
226	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
227	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
228	output.	272	output.
229		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
230	=item on_line_update $term, $row	279	=item on_line_update $term, $row
231		280
232	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
233	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
234	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,
…		…
266	=item on_focus_out $term	315	=item on_focus_out $term
267		316
268	Called wheneever the window loses keyboard focus, before rxvt-unicode does	317	Called wheneever the window loses keyboard focus, before rxvt-unicode does
269	focus out processing.	318	focus out processing.
270		319
271	=item on_key_press $term, $event, $octets	320	=item on_key_press $term, $event, $keysym, $octets
272		321
273	=item on_key_release $term, $event	322	=item on_key_release $term, $event, $keysym
274		323
275	=item on_button_press $term, $event	324	=item on_button_press $term, $event
276		325
277	=item on_button_release $term, $event	326	=item on_button_release $term, $event
278		327
…		…
298		347
299	=head2 Variables in the C<urxvt> Package	348	=head2 Variables in the C<urxvt> Package
300		349
301	=over 4	350	=over 4
302		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
303	=item $urxvt::TERM	365	=item $urxvt::TERM
304		366
305	The current terminal. This variable stores the current C<urxvt::term>	367	The current terminal. This variable stores the current C<urxvt::term>
306	object, whenever a callback/hook is executing.	368	object, whenever a callback/hook is executing.
		369
		370	=item
307		371
308	=back	372	=back
309		373
310	=head2 Functions in the C<urxvt> Package	374	=head2 Functions in the C<urxvt> Package
311		375
…		…
332	that calls this function.	396	that calls this function.
333		397
334	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
335	correct place, e.g. on stderr of the connecting urxvtc client.	399	correct place, e.g. on stderr of the connecting urxvtc client.
336		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
337	=item $time = urxvt::NOW	407	=item $time = urxvt::NOW
338		408
339	Returns the "current time" (as per the event loop).	409	Returns the "current time" (as per the event loop).
340		410
341	=item urxvt::CurrentTime	411	=item urxvt::CurrentTime
…		…
379		449
380	=item $background = urxvt::GET_BASEBG $rend	450	=item $background = urxvt::GET_BASEBG $rend
381		451
382	Return the foreground/background colour index, respectively.	452	Return the foreground/background colour index, respectively.
383		453
384	=item $rend = urxvt::SET_FGCOLOR ($rend, $new_colour)	454	=item $rend = urxvt::SET_FGCOLOR $rend, $new_colour
385		455
386	=item $rend = urxvt::SET_BGCOLOR ($rend, $new_colour)	456	=item $rend = urxvt::SET_BGCOLOR $rend, $new_colour
387		457
388	Replace the foreground/background colour in the rendition mask with the	458	Replace the foreground/background colour in the rendition mask with the
389	specified one.	459	specified one.
390		460
391	=item $value = urxvt::GET_CUSTOM ($rend)	461	=item $value = urxvt::GET_CUSTOM $rend
392		462
393	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
394	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
395	zero.	465	zero.
396		466
397	=item $rend = urxvt::SET_CUSTOM ($rend, $new_value)	467	=item $rend = urxvt::SET_CUSTOM $rend, $new_value
398		468
399	Change the custom value.	469	Change the custom value.
400		470
401	=back	471	=back
402		472
…		…
404		474
405	package urxvt;	475	package urxvt;
406		476
407	use utf8;	477	use utf8;
408	use strict;	478	use strict;
		479	use Carp ();
409	use Scalar::Util ();	480	use Scalar::Util ();
410	use List::Util ();	481	use List::Util ();
411		482
412	our $VERSION = 1;	483	our $VERSION = 1;
413	our $TERM;	484	our $TERM;
414	our @HOOKNAME;	485	our @HOOKNAME;
		486	our %HOOKTYPE = map +($HOOKNAME[$_] => $_), 0..$#HOOKNAME;
415	our %OPTION;	487	our %OPTION;
		488
416	our $LIBDIR;	489	our $LIBDIR;
		490	our $RESNAME;
		491	our $RESCLASS;
		492	our $RXVTNAME;
417		493
418	BEGIN {	494	BEGIN {
419	urxvt->bootstrap;	495	urxvt->bootstrap;
420		496
421	# overwrite perl's warn	497	# overwrite perl's warn
…		…
423	my $msg = join "", @_;	499	my $msg = join "", @_;
424	$msg .= "\n"	500	$msg .= "\n"
425	unless $msg =~ /\n$/;	501	unless $msg =~ /\n$/;
426	urxvt::warn ($msg);	502	urxvt::warn ($msg);
427	};	503	};
		504
		505	delete $ENV{IFS};
		506	delete $ENV{CDPATH};
		507	delete $ENV{BASH_ENV};
		508	$ENV{PATH} = "/bin:/sbin:/usr/bin:/usr/sbin:/usr/local/bin:/usr/local/sbin:/opt/bin:/opt/sbin";
428	}	509	}
429		510
430	my @hook_count;	511	my @hook_count;
431	my $verbosity = $ENV{URXVT_PERL_VERBOSITY};	512	my $verbosity = $ENV{URXVT_PERL_VERBOSITY};
432		513
433	sub verbose {	514	sub verbose {
434	my ($level, $msg) = @_;	515	my ($level, $msg) = @_;
435	warn "$msg\n" if $level <= $verbosity;	516	warn "$msg\n" if $level <= $verbosity;
436	}	517	}
437		518
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";	519	my $extension_pkg = "extension0000";
456	my %extension_pkg;	520	my %extension_pkg;
457		521
458	# load a single script into its own package, once only	522	# load a single script into its own package, once only
459	sub extension_package($) {	523	sub extension_package($) {
…		…
465	verbose 3, "loading extension '$path' into package '$pkg'";	529	verbose 3, "loading extension '$path' into package '$pkg'";
466		530
467	open my $fh, "<:raw", $path	531	open my $fh, "<:raw", $path
468	or die "$path: $!";	532	or die "$path: $!";
469		533
		534	my $source = untaint
470	my $source = "package $pkg; use strict; use utf8;\n"	535	"package $pkg; use strict; use utf8;\n"
471	. "use base urxvt::term::proxy::;\n"	536	. "use base urxvt::term::extension::;\n"
472	. "#line 1 \"$path\"\n{\n"	537	. "#line 1 \"$path\"\n{\n"
473	. (do { local $/; <$fh> })	538	. (do { local $/; <$fh> })
474	. "\n};\n1";	539	. "\n};\n1";
475		540
		541	eval $source
476	eval $source or die "$path: $@";	542	or die "$path: $@";
477		543
478	$pkg	544	$pkg
479	}	545	}
480	}	546	}
481		547
…		…
487	my $htype = shift;	553	my $htype = shift;
488		554
489	if ($htype == 0) { # INIT	555	if ($htype == 0) { # INIT
490	my @dirs = ((split /:/, $TERM->resource ("perl_lib")), "$LIBDIR/perl");	556	my @dirs = ((split /:/, $TERM->resource ("perl_lib")), "$LIBDIR/perl");
491		557
492	my %want_ext;	558	my %ext_arg;
493		559
494	for (map { split /,/, $TERM->resource ("perl_ext_$_") } 1, 2) {	560	for (map { split /,/, $TERM->resource ("perl_ext_$_") } 1, 2) {
495	if ($_ eq "default") {	561	if ($_ eq "default") {
496	$want_ext{$_}++ for qw(selection option-popup);	562	$ext_arg{$_} \|\|= [] for qw(selection option-popup selection-popup searchable-scrollback);
497	} elsif (/^-(.*)$/) {	563	} elsif (/^-(.*)$/) {
498	delete $want_ext{$1};	564	delete $ext_arg{$1};
		565	} elsif (/^([^<]+)<(.*)>$/) {
		566	push @{ $ext_arg{$1} }, $2;
499	} else {	567	} else {
500	$want_ext{$_}++;	568	$ext_arg{$_} \|\|= [];
501	}	569	}
502	}	570	}
503		571
504	for my $ext (keys %want_ext) {	572	while (my ($ext, $argv) = each %ext_arg) {
505	my @files = grep -f $_, map "$_/$ext", @dirs;	573	my @files = grep -f $_, map "$_/$ext", @dirs;
506		574
507	if (@files) {	575	if (@files) {
508	register_package extension_package $files[0];	576	$TERM->register_package (extension_package $files[0], $argv);
509	} else {	577	} else {
510	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";
511	}	579	}
512	}	580	}
513		581
…		…
522	if $verbosity >= 10;	590	if $verbosity >= 10;
523		591
524	keys %$cb;	592	keys %$cb;
525		593
526	while (my ($pkg, $cb) = each %$cb) {	594	while (my ($pkg, $cb) = each %$cb) {
527	eval {	595	$retval = eval { $cb->($TERM->{_pkg}{$pkg}, @_) }
528	$retval = $cb->(
529	$TERM->{_pkg}{$pkg} \|\|= do {
530	my $proxy = bless { }, $pkg;
531	Scalar::Util::weaken ($proxy->{term} = $TERM);
532	$proxy
533	},
534	@_,
535	) and last;	596	and last;
		597
		598	if ($@) {
		599	$TERM->ungrab; # better to lose the grab than the session
		600	warn $@;
536	};	601	}
537	warn $@ if $@;#d#
538	}	602	}
539	}	603	}
540		604
541	if ($htype == 1) { # DESTROY	605	if ($htype == 1) { # DESTROY
542	# remove hooks if unused
543	if (my $hook = $TERM->{_hook}) {	606	if (my $hook = delete $TERM->{_hook}) {
544	for my $htype (0..$#$hook) {	607	for my $htype (0..$#$hook) {
545	$hook_count[$htype] -= scalar keys %{ $hook->[$htype] \|\| {} }	608	$hook_count[$htype] -= scalar keys %{ $hook->[$htype] \|\| {} }
546	or set_should_invoke $htype, 0;	609	or set_should_invoke $htype, 0;
547	}	610	}
548	}	611	}
…		…
555	}	618	}
556		619
557	$retval	620	$retval
558	}	621	}
559		622
560	# urxvt::term::proxy	623	# urxvt::term::extension
561		624
562	sub urxvt::term::proxy::AUTOLOAD {	625	package urxvt::term::extension;
563	$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 =~ /:([^:]+)$/
564	or die "FATAL: \$AUTOLOAD '$urxvt::term::proxy::AUTOLOAD' unparsable";	665	or die "FATAL: \$AUTOLOAD '$AUTOLOAD' unparsable";
565		666
566	eval qq{	667	eval qq{
567	sub $urxvt::term::proxy::AUTOLOAD {	668	sub $AUTOLOAD {
568	my \$proxy = shift;	669	my \$proxy = shift;
569	\$proxy->{term}->$1 (\@_)	670	\$proxy->{term}->$1 (\@_)
570	}	671	}
571	1	672	1
572	} or die "FATAL: unable to compile method forwarder: $@";	673	} or die "FATAL: unable to compile method forwarder: $@";
573		674
574	goto &$urxvt::term::proxy::AUTOLOAD;	675	goto &$AUTOLOAD;
		676	}
		677
		678	sub DESTROY {
		679	# nop
575	}	680	}
576		681
577	# urxvt::destroy_hook	682	# urxvt::destroy_hook
578		683
579	sub urxvt::destroy_hook::DESTROY {	684	sub urxvt::destroy_hook::DESTROY {
…		…
588		693
589	=head2 The C<urxvt::anyevent> Class	694	=head2 The C<urxvt::anyevent> Class
590		695
591	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
592	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
593	further work. The only exception is that you cannot wait on condition	698	further programming. The only exception is that you cannot wait on
594	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
595	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.
596		702
597	=cut	703	=cut
598		704
599	our $VERSION = 1;	705	our $VERSION = 1;
600		706
…		…
645	${$_[0]}++;	751	${$_[0]}++;
646	}	752	}
647		753
648	sub urxvt::anyevent::condvar::wait {	754	sub urxvt::anyevent::condvar::wait {
649	unless (${$_[0]}) {	755	unless (${$_[0]}) {
650	require Carp;
651	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";
652	}	757	}
653	}	758	}
654		759
655	package urxvt::term;	760	package urxvt::term;
656		761
657	=head2 The C<urxvt::term> Class	762	=head2 The C<urxvt::term> Class
658		763
659	=over 4	764	=over 4
660		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
661	=item $term->destroy	788	=item $term->destroy
662		789
663	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.
664		793
665	=item $isset = $term->option ($optval[, $set])	794	=item $isset = $term->option ($optval[, $set])
666		795
667	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
668	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
…		…
718	my ($self, $name) = (shift, shift);	847	my ($self, $name) = (shift, shift);
719	unshift @_, $self, $name, ($name =~ s/\s\+\s(\d+)$// ? $1 : 0);	848	unshift @_, $self, $name, ($name =~ s/\s\+\s(\d+)$// ? $1 : 0);
720	&urxvt::term::_resource	849	&urxvt::term::_resource
721	}	850	}
722		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
723	=item $rend = $term->rstyle ([$new_rstyle])	857	=item $rend = $term->rstyle ([$new_rstyle])
724		858
725	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
726	the terminal application will use this style.	860	the terminal application will use this style.
727		861
…		…
746		880
747	=item $oldtext = $term->selection ([$newtext])	881	=item $oldtext = $term->selection ([$newtext])
748		882
749	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>.
750		884
751	#=item $term->overlay ($x, $y, $text)	885	=item $term->overlay_simple ($x, $y, $text)
752	#	886
753	#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.
754	#	888
755	#=cut	889	=cut
756	#	890
757	#sub urxvt::term::scr_overlay {	891	sub overlay_simple {
758	# my ($self, $x, $y, $text) = @_;	892	my ($self, $x, $y, $text) = @_;
759	#	893
760	# my @lines = split /\n/, $text;	894	my @lines = split /\n/, $text;
761	#	895
762	# my $w = 0;	896	my $w = List::Util::max map $self->strwidth ($_), @lines;
763	# for (map $self->strwidth ($_), @lines) {	897
764	# $w = $_ if $w < $_;
765	# }
766	#
767	# $self->scr_overlay_new ($x, $y, $w, scalar @lines);	898	my $overlay = $self->overlay ($x, $y, $w, scalar @lines);
768	# $self->scr_overlay_set (0, $_, $lines[$_]) for 0.. $#lines;	899	$overlay->set (0, $_, $lines[$_]) for 0.. $#lines;
769	#}	900
		901	$overlay
		902	}
770		903
771	=item $term->overlay ($x, $y, $width, $height[, $rstyle[, $border]])	904	=item $term->overlay ($x, $y, $width, $height[, $rstyle[, $border]])
772		905
773	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
774	width/height. C<$rstyle> defines the initial rendition style	907	width/height. C<$rstyle> defines the initial rendition style
…		…
841		974
842	=item $string = $term->locale_decode ($octets)	975	=item $string = $term->locale_decode ($octets)
843		976
844	Convert the given locale-encoded octets into a perl string.	977	Convert the given locale-encoded octets into a perl string.
845		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
846	=item $term->scr_add_lines ($string)	996	=item $term->scr_add_lines ($string)
847		997
848	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
849	running inside the terminal. It may not contain command sequences (escape	999	running inside the terminal. It may not contain command sequences (escape
850	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
…		…
864		1014
865	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
866	pass characters instead of octets, you should convert your strings first	1016	pass characters instead of octets, you should convert your strings first
867	to the locale-specific encoding using C<< $term->locale_encode >>.	1017	to the locale-specific encoding using C<< $term->locale_encode >>.
868		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
869	=item $windowid = $term->parent	1026	=item $windowid = $term->parent
870		1027
871	Return the window id of the toplevel window.	1028	Return the window id of the toplevel window.
872		1029
873	=item $windowid = $term->vt	1030	=item $windowid = $term->vt
…		…
897	=item $nrow_plus_saveLines = $term->total_rows	1054	=item $nrow_plus_saveLines = $term->total_rows
898		1055
899	=item $lines_in_scrollback = $term->nsaved	1056	=item $lines_in_scrollback = $term->nsaved
900		1057
901	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.
902		1067
903	=item $modifiermask = $term->ModLevel3Mask	1068	=item $modifiermask = $term->ModLevel3Mask
904		1069
905	=item $modifiermask = $term->ModMetaMask	1070	=item $modifiermask = $term->ModMetaMask
906		1071
…		…
1083	$offset / $self->{ncol} + $self->{beg},	1248	$offset / $self->{ncol} + $self->{beg},
1084	$offset % $self->{ncol}	1249	$offset % $self->{ncol}
1085	)	1250	)
1086	}	1251	}
1087		1252
1088	=item ($row, $col) = $line->coord_of ($offset)
1089	=item $text = $term->special_encode $string	1253	=item $text = $term->special_encode $string
1090		1254
1091	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,
1092	where one character corresponds to one screen cell. See	1256	where one character corresponds to one screen cell. See
1093	C<< $term->ROW_t >> for details.	1257	C<< $term->ROW_t >> for details.
…		…
1095	=item $string = $term->special_decode $text	1259	=item $string = $term->special_decode $text
1096		1260
1097	Converts rxvt-unicodes text reprsentation into a perl string. See	1261	Converts rxvt-unicodes text reprsentation into a perl string. See
1098	C<< $term->ROW_t >> for details.	1262	C<< $term->ROW_t >> for details.
1099		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
1100	=back	1292	=back
1101		1293
1102	=cut	1294	=cut
1103		1295
1104	package urxvt::popup;	1296	package urxvt::popup;
…		…
1119	$item->{render} \|\|= sub { $_[0]{text} };	1311	$item->{render} \|\|= sub { $_[0]{text} };
1120		1312
1121	push @{ $self->{item} }, $item;	1313	push @{ $self->{item} }, $item;
1122	}	1314	}
1123		1315
1124	sub add_separator {	1316	=item $popup->add_title ($title)
1125	my ($self, $sep) = @_;
1126		1317
1127	$sep \|\|= "═";	1318	Adds a non-clickable title to the popup.
1128		1319
1129	$self->add_item ({	1320	=cut
1130	rend => { normal => "\x1b[0;30;47m", hover => "\x1b[0;30;47m", active => "\x1b[0;30;47m" },
1131	text => "",
1132	render => sub { $sep x $urxvt::TERM->ncol },
1133	activate => sub { },
1134	});
1135	}
1136		1321
1137	sub add_title {	1322	sub add_title {
1138	my ($self, $title) = @_;	1323	my ($self, $title) = @_;
1139		1324
1140	$self->add_item ({	1325	$self->add_item ({
…		…
1142	text => $title,	1327	text => $title,
1143	activate => sub { },	1328	activate => sub { },
1144	});	1329	});
1145	}	1330	}
1146		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
1147	sub add_button {	1358	sub add_button {
1148	my ($self, $text, $cb) = @_;	1359	my ($self, $text, $cb) = @_;
1149		1360
1150	$self->add_item ({ type => "button", text => "[ $text ]", activate => $cb});	1361	$self->add_item ({ type => "button", text => $text, activate => $cb});
1151	}	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
1152		1371
1153	sub add_toggle {	1372	sub add_toggle {
1154	my ($self, $text, $cb, $value) = @_;	1373	my ($self, $text, $cb, $value) = @_;
1155		1374
1156	my $item; $item = {	1375	my $item; $item = {
1157	type => "button",	1376	type => "button",
1158	text => " $text",	1377	text => " $text",
1159	value => $value,	1378	value => $value,
1160	render => sub { ($item->{value} ? "* " : " ") . $text },	1379	render => sub { ($_[0]{value} ? "* " : " ") . $text },
1161	activate => sub { $cb->($item->{value} = !$item->{value}); },	1380	activate => sub { $cb->($_[1]{value} = !$_[1]{value}); },
1162	};	1381	};
1163		1382
1164	$self->add_item ($item);	1383	$self->add_item ($item);
1165	}	1384	}
		1385
		1386	=item $popup->show
		1387
		1388	Displays the popup (which is initially hidden).
		1389
		1390	=cut
1166		1391
1167	sub show {	1392	sub show {
1168	my ($self) = @_;	1393	my ($self) = @_;
1169		1394
1170	local $urxvt::popup::self = $self;	1395	local $urxvt::popup::self = $self;
1171		1396
		1397	local $ENV{LC_ALL} = $self->{term}->locale;
		1398
1172	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,
1173	"--transient-for" => $self->{term}->parent,	1400	"--transient-for" => $self->{term}->parent,
		1401	"-display" => $self->{term}->display_id,
1174	"-pe" => "urxvt-popup")	1402	"-pe" => "urxvt-popup")
1175	or die "unable to create popup window\n";	1403	or die "unable to create popup window\n";
1176	}	1404	}
1177		1405
1178	sub DESTROY {	1406	sub DESTROY {
1179	my ($self) = @_;	1407	my ($self) = @_;
1180		1408
		1409	delete $self->{term}{_destroy}{$self};
1181	$self->{term}->ungrab;	1410	$self->{term}->ungrab;
1182	}	1411	}
1183		1412
1184	=head2 The C<urxvt::timer> Class	1413	=head2 The C<urxvt::timer> Class
1185		1414
…		…
1240		1469
1241	$term->{socket} = ...	1470	$term->{socket} = ...
1242	$term->{iow} = urxvt::iow	1471	$term->{iow} = urxvt::iow
1243	->new	1472	->new
1244	->fd (fileno $term->{socket})	1473	->fd (fileno $term->{socket})
1245	->events (1) # wait for read data	1474	->events (urxvt::EVENT_READ)
1246	->start	1475	->start
1247	->cb (sub {	1476	->cb (sub {
1248	my ($iow, $revents) = @_;	1477	my ($iow, $revents) = @_;
1249	# $revents must be 1 here, no need to check	1478	# $revents must be 1 here, no need to check
1250	sysread $term->{socket}, my $buf, 8192	1479	sysread $term->{socket}, my $buf, 8192
…		…
1267		1496
1268	Set the filedescriptor (not handle) to watch.	1497	Set the filedescriptor (not handle) to watch.
1269		1498
1270	=item $iow = $iow->events ($eventmask)	1499	=item $iow = $iow->events ($eventmask)
1271		1500
1272	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
1273	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>.
1274		1504
1275	=item $iow = $iow->start	1505	=item $iow = $iow->start
1276		1506
1277	Start watching for requested events on the given handle.	1507	Start watching for requested events on the given handle.
1278		1508
…		…
1289	This variable controls the verbosity level of the perl extension. Higher	1519	This variable controls the verbosity level of the perl extension. Higher
1290	numbers indicate more verbose output.	1520	numbers indicate more verbose output.
1291		1521
1292	=over 4	1522	=over 4
1293		1523
1294	=item =0 - only fatal messages	1524	=item == 0 - fatal messages
1295		1525
1296	=item =3 - script loading and management	1526	=item >= 3 - script loading and management
1297		1527
1298	=item =10 - all events received	1528	=item >=10 - all events received
1299		1529
1300	=back	1530	=back
1301		1531
1302	=head1 AUTHOR	1532	=head1 AUTHOR
1303		1533

Diff Legend

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

Comparing rxvt-unicode/src/urxvt.pm (file contents): Revision 1.56 by root, Sun Jan 8 05:52:42 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.56 by root, Sun Jan 8 05:52:42 2006 UTC vs.
Revision 1.76 by root, Tue Jan 10 19:46:28 2006 UTC