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

Comparing rxvt-unicode/src/urxvt.pm (file contents):
Revision 1.60 by root, Mon Jan 9 01:21:43 2006 UTC vs.
Revision 1.75 by root, Tue Jan 10 05:00:13 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
…		…
443	sub verbose {	514	sub verbose {
444	my ($level, $msg) = @_;	515	my ($level, $msg) = @_;
445	warn "$msg\n" if $level <= $verbosity;	516	warn "$msg\n" if $level <= $verbosity;
446	}	517	}
447		518
448	# find on_xxx subs in the package and register them
449	# as hooks
450	sub register_package($) {
451	my ($pkg) = @_;
452
453	for my $htype (0.. $#HOOKNAME) {
454	my $name = $HOOKNAME[$htype];
455
456	my $ref = $pkg->can ("on_" . lc $name)
457	or next;
458
459	$TERM->{_hook}[$htype]{$pkg} = $ref;
460	$hook_count[$htype]++
461	or set_should_invoke $htype, 1;
462	}
463	}
464
465	my $extension_pkg = "extension0000";	519	my $extension_pkg = "extension0000";
466	my %extension_pkg;	520	my %extension_pkg;
467		521
468	# load a single script into its own package, once only	522	# load a single script into its own package, once only
469	sub extension_package($) {	523	sub extension_package($) {
…		…
475	verbose 3, "loading extension '$path' into package '$pkg'";	529	verbose 3, "loading extension '$path' into package '$pkg'";
476		530
477	open my $fh, "<:raw", $path	531	open my $fh, "<:raw", $path
478	or die "$path: $!";	532	or die "$path: $!";
479		533
		534	my $source = untaint
480	my $source = untaint "package $pkg; use strict; use utf8;\n"	535	"package $pkg; use strict; use utf8;\n"
481	. "use base urxvt::term::proxy::;\n"	536	. "use base urxvt::term::extension::;\n"
482	. "#line 1 \"$path\"\n{\n"	537	. "#line 1 \"$path\"\n{\n"
483	. (do { local $/; <$fh> })	538	. (do { local $/; <$fh> })
484	. "\n};\n1";	539	. "\n};\n1";
485		540
		541	eval $source
486	eval $source or die "$path: $@";	542	or die "$path: $@";
487		543
488	$pkg	544	$pkg
489	}	545	}
490	}	546	}
491		547
…		…
497	my $htype = shift;	553	my $htype = shift;
498		554
499	if ($htype == 0) { # INIT	555	if ($htype == 0) { # INIT
500	my @dirs = ((split /:/, $TERM->resource ("perl_lib")), "$LIBDIR/perl");	556	my @dirs = ((split /:/, $TERM->resource ("perl_lib")), "$LIBDIR/perl");
501		557
502	my %want_ext;	558	my %ext_arg;
503		559
504	for (map { split /,/, $TERM->resource ("perl_ext_$_") } 1, 2) {	560	for (map { split /,/, $TERM->resource ("perl_ext_$_") } 1, 2) {
505	if ($_ eq "default") {	561	if ($_ eq "default") {
506	$want_ext{$_}++ for qw(selection option-popup selection-popup);	562	$ext_arg{$_} \|\|= [] for qw(selection option-popup selection-popup searchable-scrollback);
507	} elsif (/^-(.*)$/) {	563	} elsif (/^-(.*)$/) {
508	delete $want_ext{$1};	564	delete $ext_arg{$1};
		565	} elsif (/^([^<]+)<(.*)>$/) {
		566	push @{ $ext_arg{$1} }, $2;
509	} else {	567	} else {
510	$want_ext{$_}++;	568	$ext_arg{$_} \|\|= [];
511	}	569	}
512	}	570	}
513		571
514	for my $ext (keys %want_ext) {	572	while (my ($ext, $argv) = each %ext_arg) {
515	my @files = grep -f $_, map "$_/$ext", @dirs;	573	my @files = grep -f $_, map "$_/$ext", @dirs;
516		574
517	if (@files) {	575	if (@files) {
518	register_package extension_package $files[0];	576	$TERM->register_package (extension_package $files[0], $argv);
519	} else {	577	} else {
520	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";
521	}	579	}
522	}	580	}
523		581
…		…
532	if $verbosity >= 10;	590	if $verbosity >= 10;
533		591
534	keys %$cb;	592	keys %$cb;
535		593
536	while (my ($pkg, $cb) = each %$cb) {	594	while (my ($pkg, $cb) = each %$cb) {
537	eval {	595	$retval = eval { $cb->($TERM->{_pkg}{$pkg}, @_) }
538	$retval = $cb->(
539	$TERM->{_pkg}{$pkg} \|\|= do {
540	my $proxy = bless { }, $pkg;
541	Scalar::Util::weaken ($proxy->{term} = $TERM);
542	$proxy
543	},
544	@_,
545	) and last;	596	and last;
546	};	597
547	if ($@) {	598	if ($@) {
548	$TERM->ungrab; # better to lose the grab than the session	599	$TERM->ungrab; # better to lose the grab than the session
549	warn $@;	600	warn $@;
550	}	601	}
551	}	602	}
552	}	603	}
553		604
554	if ($htype == 1) { # DESTROY	605	if ($htype == 1) { # DESTROY
555	# remove hooks if unused
556	if (my $hook = $TERM->{_hook}) {	606	if (my $hook = delete $TERM->{_hook}) {
557	for my $htype (0..$#$hook) {	607	for my $htype (0..$#$hook) {
558	$hook_count[$htype] -= scalar keys %{ $hook->[$htype] \|\| {} }	608	$hook_count[$htype] -= scalar keys %{ $hook->[$htype] \|\| {} }
559	or set_should_invoke $htype, 0;	609	or set_should_invoke $htype, 0;
560	}	610	}
561	}	611	}
…		…
568	}	618	}
569		619
570	$retval	620	$retval
571	}	621	}
572		622
573	# urxvt::term::proxy	623	# urxvt::term::extension
574		624
575	sub urxvt::term::proxy::AUTOLOAD {	625	package urxvt::term::extension;
576	$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 =~ /:([^:]+)$/
577	or die "FATAL: \$AUTOLOAD '$urxvt::term::proxy::AUTOLOAD' unparsable";	665	or die "FATAL: \$AUTOLOAD '$AUTOLOAD' unparsable";
578		666
579	eval qq{	667	eval qq{
580	sub $urxvt::term::proxy::AUTOLOAD {	668	sub $AUTOLOAD {
581	my \$proxy = shift;	669	my \$proxy = shift;
582	\$proxy->{term}->$1 (\@_)	670	\$proxy->{term}->$1 (\@_)
583	}	671	}
584	1	672	1
585	} or die "FATAL: unable to compile method forwarder: $@";	673	} or die "FATAL: unable to compile method forwarder: $@";
586		674
587	goto &$urxvt::term::proxy::AUTOLOAD;	675	goto &$AUTOLOAD;
588	}	676	}
589		677
590	sub urxvt::term::proxy::DESTROY {	678	sub DESTROY {
591	# nop	679	# nop
592	}	680	}
593		681
594	# urxvt::destroy_hook	682	# urxvt::destroy_hook
595		683
…		…
605		693
606	=head2 The C<urxvt::anyevent> Class	694	=head2 The C<urxvt::anyevent> Class
607		695
608	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
609	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
610	further work. The only exception is that you cannot wait on condition	698	further programming. The only exception is that you cannot wait on
611	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
612	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.
613		702
614	=cut	703	=cut
615		704
616	our $VERSION = 1;	705	our $VERSION = 1;
617		706
…		…
662	${$_[0]}++;	751	${$_[0]}++;
663	}	752	}
664		753
665	sub urxvt::anyevent::condvar::wait {	754	sub urxvt::anyevent::condvar::wait {
666	unless (${$_[0]}) {	755	unless (${$_[0]}) {
667	require Carp;
668	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";
669	}	757	}
670	}	758	}
671		759
672	package urxvt::term;	760	package urxvt::term;
673		761
674	=head2 The C<urxvt::term> Class	762	=head2 The C<urxvt::term> Class
675		763
676	=over 4	764	=over 4
677		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
678	=item $term->destroy	788	=item $term->destroy
679		789
680	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.
681		793
682	=item $isset = $term->option ($optval[, $set])	794	=item $isset = $term->option ($optval[, $set])
683		795
684	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
685	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
…		…
735	my ($self, $name) = (shift, shift);	847	my ($self, $name) = (shift, shift);
736	unshift @_, $self, $name, ($name =~ s/\s\+\s(\d+)$// ? $1 : 0);	848	unshift @_, $self, $name, ($name =~ s/\s\+\s(\d+)$// ? $1 : 0);
737	&urxvt::term::_resource	849	&urxvt::term::_resource
738	}	850	}
739		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
740	=item $rend = $term->rstyle ([$new_rstyle])	857	=item $rend = $term->rstyle ([$new_rstyle])
741		858
742	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
743	the terminal application will use this style.	860	the terminal application will use this style.
744		861
…		…
763		880
764	=item $oldtext = $term->selection ([$newtext])	881	=item $oldtext = $term->selection ([$newtext])
765		882
766	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>.
767		884
768	#=item $term->overlay ($x, $y, $text)	885	=item $term->overlay_simple ($x, $y, $text)
769	#	886
770	#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.
771	#	888
772	#=cut	889	=cut
773	#	890
774	#sub urxvt::term::scr_overlay {	891	sub overlay_simple {
775	# my ($self, $x, $y, $text) = @_;	892	my ($self, $x, $y, $text) = @_;
776	#	893
777	# my @lines = split /\n/, $text;	894	my @lines = split /\n/, $text;
778	#	895
779	# my $w = 0;	896	my $w = List::Util::max map $self->strwidth ($_), @lines;
780	# for (map $self->strwidth ($_), @lines) {	897
781	# $w = $_ if $w < $_;
782	# }
783	#
784	# $self->scr_overlay_new ($x, $y, $w, scalar @lines);	898	my $overlay = $self->overlay ($x, $y, $w, scalar @lines);
785	# $self->scr_overlay_set (0, $_, $lines[$_]) for 0.. $#lines;	899	$overlay->set (0, $_, $lines[$_]) for 0.. $#lines;
786	#}	900
		901	$overlay
		902	}
787		903
788	=item $term->overlay ($x, $y, $width, $height[, $rstyle[, $border]])	904	=item $term->overlay ($x, $y, $width, $height[, $rstyle[, $border]])
789		905
790	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
791	width/height. C<$rstyle> defines the initial rendition style	907	width/height. C<$rstyle> defines the initial rendition style
…		…
858		974
859	=item $string = $term->locale_decode ($octets)	975	=item $string = $term->locale_decode ($octets)
860		976
861	Convert the given locale-encoded octets into a perl string.	977	Convert the given locale-encoded octets into a perl string.
862		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
863	=item $term->scr_add_lines ($string)	996	=item $term->scr_add_lines ($string)
864		997
865	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
866	running inside the terminal. It may not contain command sequences (escape	999	running inside the terminal. It may not contain command sequences (escape
867	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
…		…
881		1014
882	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
883	pass characters instead of octets, you should convert your strings first	1016	pass characters instead of octets, you should convert your strings first
884	to the locale-specific encoding using C<< $term->locale_encode >>.	1017	to the locale-specific encoding using C<< $term->locale_encode >>.
885		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
886	=item $windowid = $term->parent	1026	=item $windowid = $term->parent
887		1027
888	Return the window id of the toplevel window.	1028	Return the window id of the toplevel window.
889		1029
890	=item $windowid = $term->vt	1030	=item $windowid = $term->vt
…		…
914	=item $nrow_plus_saveLines = $term->total_rows	1054	=item $nrow_plus_saveLines = $term->total_rows
915		1055
916	=item $lines_in_scrollback = $term->nsaved	1056	=item $lines_in_scrollback = $term->nsaved
917		1057
918	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.
919		1067
920	=item $modifiermask = $term->ModLevel3Mask	1068	=item $modifiermask = $term->ModLevel3Mask
921		1069
922	=item $modifiermask = $term->ModMetaMask	1070	=item $modifiermask = $term->ModMetaMask
923		1071
…		…
1100	$offset / $self->{ncol} + $self->{beg},	1248	$offset / $self->{ncol} + $self->{beg},
1101	$offset % $self->{ncol}	1249	$offset % $self->{ncol}
1102	)	1250	)
1103	}	1251	}
1104		1252
1105	=item ($row, $col) = $line->coord_of ($offset)
1106	=item $text = $term->special_encode $string	1253	=item $text = $term->special_encode $string
1107		1254
1108	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,
1109	where one character corresponds to one screen cell. See	1256	where one character corresponds to one screen cell. See
1110	C<< $term->ROW_t >> for details.	1257	C<< $term->ROW_t >> for details.
…		…
1112	=item $string = $term->special_decode $text	1259	=item $string = $term->special_decode $text
1113		1260
1114	Converts rxvt-unicodes text reprsentation into a perl string. See	1261	Converts rxvt-unicodes text reprsentation into a perl string. See
1115	C<< $term->ROW_t >> for details.	1262	C<< $term->ROW_t >> for details.
1116		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
1117	=back	1292	=back
1118		1293
1119	=cut	1294	=cut
1120		1295
1121	package urxvt::popup;	1296	package urxvt::popup;
…		…
1139	}	1314	}
1140		1315
1141	sub add_separator {	1316	sub add_separator {
1142	my ($self, $sep) = @_;	1317	my ($self, $sep) = @_;
1143		1318
1144	$sep \|\|= "═";	1319	$sep \|\|= "=";
1145		1320
1146	$self->add_item ({	1321	$self->add_item ({
1147	rend => { normal => "\x1b[0;30;47m", hover => "\x1b[0;30;47m", active => "\x1b[0;30;47m" },	1322	rend => { normal => "\x1b[0;30;47m", hover => "\x1b[0;30;47m", active => "\x1b[0;30;47m" },
1148	text => "",	1323	text => "",
1149	render => sub { $sep x $urxvt::TERM->ncol },	1324	render => sub { $sep x $self->{term}->ncol },
1150	activate => sub { },	1325	activate => sub { },
1151	});	1326	});
1152	}	1327	}
1153		1328
1154	sub add_title {	1329	sub add_title {
…		…
1162	}	1337	}
1163		1338
1164	sub add_button {	1339	sub add_button {
1165	my ($self, $text, $cb) = @_;	1340	my ($self, $text, $cb) = @_;
1166		1341
1167	$self->add_item ({ type => "button", text => "[ $text ]", activate => $cb});	1342	$self->add_item ({ type => "button", text => $text, activate => $cb});
1168	}	1343	}
1169		1344
1170	sub add_toggle {	1345	sub add_toggle {
1171	my ($self, $text, $cb, $value) = @_;	1346	my ($self, $text, $cb, $value) = @_;
1172		1347
…		…
1184	sub show {	1359	sub show {
1185	my ($self) = @_;	1360	my ($self) = @_;
1186		1361
1187	local $urxvt::popup::self = $self;	1362	local $urxvt::popup::self = $self;
1188		1363
		1364	local $ENV{LC_ALL} = $self->{term}->locale;
		1365
1189	urxvt->new ("--perl-lib" => "", "--perl-ext-common" => "", "-pty-fd" => -1, "-sl" => 0, "-b" => 0,	1366	urxvt->new ("--perl-lib" => "", "--perl-ext-common" => "", "-pty-fd" => -1, "-sl" => 0, "-b" => 0,
1190	"--transient-for" => $self->{term}->parent,	1367	"--transient-for" => $self->{term}->parent,
		1368	"-display" => $self->{term}->display_id,
1191	"-pe" => "urxvt-popup")	1369	"-pe" => "urxvt-popup")
1192	or die "unable to create popup window\n";	1370	or die "unable to create popup window\n";
1193	}	1371	}
1194		1372
1195	sub DESTROY {	1373	sub DESTROY {
…		…
1258		1436
1259	$term->{socket} = ...	1437	$term->{socket} = ...
1260	$term->{iow} = urxvt::iow	1438	$term->{iow} = urxvt::iow
1261	->new	1439	->new
1262	->fd (fileno $term->{socket})	1440	->fd (fileno $term->{socket})
1263	->events (1) # wait for read data	1441	->events (urxvt::EVENT_READ)
1264	->start	1442	->start
1265	->cb (sub {	1443	->cb (sub {
1266	my ($iow, $revents) = @_;	1444	my ($iow, $revents) = @_;
1267	# $revents must be 1 here, no need to check	1445	# $revents must be 1 here, no need to check
1268	sysread $term->{socket}, my $buf, 8192	1446	sysread $term->{socket}, my $buf, 8192
…		…
1285		1463
1286	Set the filedescriptor (not handle) to watch.	1464	Set the filedescriptor (not handle) to watch.
1287		1465
1288	=item $iow = $iow->events ($eventmask)	1466	=item $iow = $iow->events ($eventmask)
1289		1467
1290	Set the event mask to watch. Bit #0 (value C<1>) enables watching for read	1468	Set the event mask to watch. The only allowed values are
1291	data, Bit #1 (value C<2>) enables watching for write data.	1469	C<urxvt::EVENT_READ> and C<urxvt::EVENT_WRITE>, which might be ORed
		1470	together, or C<urxvt::EVENT_NONE>.
1292		1471
1293	=item $iow = $iow->start	1472	=item $iow = $iow->start
1294		1473
1295	Start watching for requested events on the given handle.	1474	Start watching for requested events on the given handle.
1296		1475

Diff Legend

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

Comparing rxvt-unicode/src/urxvt.pm (file contents): Revision 1.60 by root, Mon Jan 9 01:21:43 2006 UTC vs. Revision 1.75 by root, Tue Jan 10 05:00:13 2006 UTC

Diff Legend

Comparing rxvt-unicode/src/urxvt.pm (file contents):
Revision 1.60 by root, Mon Jan 9 01:21:43 2006 UTC vs.
Revision 1.75 by root, Tue Jan 10 05:00:13 2006 UTC