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

Comparing rxvt-unicode/src/urxvt.pm (file contents):
Revision 1.47 by root, Sat Jan 7 21:22:02 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	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
55	Rot-13 the selection when activated. Used via keyboard trigger:	55	Rot-13 the selection when activated. Used via keyboard trigger:
56		56
57	URxvt.keysym.C-M-r: perl:selection:rot13	57	URxvt.keysym.C-M-r: perl:selection:rot13
58		58
59	=back	59	=back
		60
		61	=item option-popup (enabled by default)
		62
		63	Binds a popup menu to Ctrl-Button2 that lets you toggle (some) options at
		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.
60		82
61	=item digital-clock	83	=item digital-clock
62		84
63	Displays a digital clock using the built-in overlay.	85	Displays a digital clock using the built-in overlay.
64		86
…		…
77	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
78	window. Illustrates overwriting the refresh callbacks to create your own	100	window. Illustrates overwriting the refresh callbacks to create your own
79	overlays or changes.	101	overlays or changes.
80		102
81	=back	103	=back
		104
		105	=head1 API DOCUMENTATION
82		106
83	=head2 General API Considerations	107	=head2 General API Considerations
84		108
85	All objects (such as terminals, time watchers etc.) are typical	109	All objects (such as terminals, time watchers etc.) are typical
86	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
…		…
114	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
115	locale-specific way.	139	locale-specific way.
116		140
117	=back	141	=back
118		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
119	=head2 Hooks	176	=head2 Hooks
120		177
121	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
122	called whenever the relevant event happens.	179	called whenever the relevant event happens.
123		180
124	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
125	and extension package. You can call all C<urxvt::term> methods on it, but	182	the in the C<Extension Objects> section.
126	its not a real C<urxvt::term> object. Instead, the real C<urxvt::term>
127	object that is shared between all packages is stored in the C<term>
128	member. It is, however, blessed intot he package of the extension script,
129	so for all practical purposes you can treat an extension script as a class.
130		183
131	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
132	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
133	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.
134		187
135	When in doubt, return a false value (preferably C<()>).	188	I<< When in doubt, return a false value (preferably C<()>). >>
136		189
137	=over 4	190	=over 4
138		191
139	=item on_init $term	192	=item on_init $term
140		193
…		…
194	than the scroll back buffer or the terminal.	247	than the scroll back buffer or the terminal.
195		248
196	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,
197	$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
198	number of lines that will be in the scrollback buffer.	251	number of lines that will be in the scrollback buffer.
199
200	=item on_tty_activity $term NYI
201
202	Called whenever the program(s) running in the urxvt window send output.
203		252
204	=item on_osc_seq $term, $string	253	=item on_osc_seq $term, $string
205		254
206	Called whenever the B<ESC ] 777 ; string ST> command sequence (OSC =	255	Called whenever the B<ESC ] 777 ; string ST> command sequence (OSC =
207	operating system command) is processed. Cursor position and other state	256	operating system command) is processed. Cursor position and other state
…		…
220	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
221	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
222	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
223	output.	272	output.
224		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
225	=item on_line_update $term, $row	279	=item on_line_update $term, $row
226		280
227	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
228	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
229	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,
…		…
261	=item on_focus_out $term	315	=item on_focus_out $term
262		316
263	Called wheneever the window loses keyboard focus, before rxvt-unicode does	317	Called wheneever the window loses keyboard focus, before rxvt-unicode does
264	focus out processing.	318	focus out processing.
265		319
266	=item on_key_press $term, $event, $octets	320	=item on_key_press $term, $event, $keysym, $octets
267		321
268	=item on_key_release $term, $event	322	=item on_key_release $term, $event, $keysym
269		323
270	=item on_button_press $term, $event	324	=item on_button_press $term, $event
271		325
272	=item on_button_release $term, $event	326	=item on_button_release $term, $event
273		327
…		…
293		347
294	=head2 Variables in the C<urxvt> Package	348	=head2 Variables in the C<urxvt> Package
295		349
296	=over 4	350	=over 4
297		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
298	=item $urxvt::TERM	365	=item $urxvt::TERM
299		366
300	The current terminal. This variable stores the current C<urxvt::term>	367	The current terminal. This variable stores the current C<urxvt::term>
301	object, whenever a callback/hook is executing.	368	object, whenever a callback/hook is executing.
		369
		370	=item
302		371
303	=back	372	=back
304		373
305	=head2 Functions in the C<urxvt> Package	374	=head2 Functions in the C<urxvt> Package
306		375
…		…
327	that calls this function.	396	that calls this function.
328		397
329	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
330	correct place, e.g. on stderr of the connecting urxvtc client.	399	correct place, e.g. on stderr of the connecting urxvtc client.
331		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
332	=item $time = urxvt::NOW	407	=item $time = urxvt::NOW
333		408
334	Returns the "current time" (as per the event loop).	409	Returns the "current time" (as per the event loop).
335		410
336	=item urxvt::CurrentTime	411	=item urxvt::CurrentTime
337		412
338	=item urxvt::ShiftMask, LockMask, ControlMask, Mod1Mask, Mod2Mask,	413	=item urxvt::ShiftMask, LockMask, ControlMask, Mod1Mask, Mod2Mask,
339	Mod3Mask, Mod4Mask, Mod5Mask, Button1Mask, Button2Mask, Button3Mask,	414	Mod3Mask, Mod4Mask, Mod5Mask, Button1Mask, Button2Mask, Button3Mask,
340	Button4Mask, Button5Mask, AnyModifier	415	Button4Mask, Button5Mask, AnyModifier
341		416
342	Various constants for use in X events.	417	Various constants for use in X calls and event processing.
343		418
344	=back	419	=back
345		420
346	=head2 RENDITION	421	=head2 RENDITION
347		422
…		…
374		449
375	=item $background = urxvt::GET_BASEBG $rend	450	=item $background = urxvt::GET_BASEBG $rend
376		451
377	Return the foreground/background colour index, respectively.	452	Return the foreground/background colour index, respectively.
378		453
379	=item $rend = urxvt::SET_FGCOLOR ($rend, $new_colour)	454	=item $rend = urxvt::SET_FGCOLOR $rend, $new_colour
380		455
381	=item $rend = urxvt::SET_BGCOLOR ($rend, $new_colour)	456	=item $rend = urxvt::SET_BGCOLOR $rend, $new_colour
382		457
383	Replace the foreground/background colour in the rendition mask with the	458	Replace the foreground/background colour in the rendition mask with the
384	specified one.	459	specified one.
385		460
386	=item $value = urxvt::GET_CUSTOM ($rend)	461	=item $value = urxvt::GET_CUSTOM $rend
387		462
388	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
389	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
390	zero.	465	zero.
391		466
392	=item $rend = urxvt::SET_CUSTOM ($rend, $new_value)	467	=item $rend = urxvt::SET_CUSTOM $rend, $new_value
393		468
394	Change the custom value.	469	Change the custom value.
395		470
396	=back	471	=back
397		472
398	=cut	473	=cut
399		474
400	package urxvt;	475	package urxvt;
401		476
		477	use utf8;
402	use strict;	478	use strict;
		479	use Carp ();
403	use Scalar::Util ();	480	use Scalar::Util ();
		481	use List::Util ();
404		482
		483	our $VERSION = 1;
405	our $TERM;	484	our $TERM;
406	our @HOOKNAME;	485	our @HOOKNAME;
		486	our %HOOKTYPE = map +($HOOKNAME[$_] => $_), 0..$#HOOKNAME;
		487	our %OPTION;
		488
407	our $LIBDIR;	489	our $LIBDIR;
		490	our $RESNAME;
		491	our $RESCLASS;
		492	our $RXVTNAME;
408		493
409	BEGIN {	494	BEGIN {
410	urxvt->bootstrap;	495	urxvt->bootstrap;
411		496
412	# overwrite perl's warn	497	# overwrite perl's warn
…		…
414	my $msg = join "", @_;	499	my $msg = join "", @_;
415	$msg .= "\n"	500	$msg .= "\n"
416	unless $msg =~ /\n$/;	501	unless $msg =~ /\n$/;
417	urxvt::warn ($msg);	502	urxvt::warn ($msg);
418	};	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";
419	}	509	}
420		510
421	my @hook_count;	511	my @hook_count;
422	my $verbosity = $ENV{URXVT_PERL_VERBOSITY};	512	my $verbosity = $ENV{URXVT_PERL_VERBOSITY};
423		513
424	sub verbose {	514	sub verbose {
425	my ($level, $msg) = @_;	515	my ($level, $msg) = @_;
426	warn "$msg\n" if $level <= $verbosity;	516	warn "$msg\n" if $level <= $verbosity;
427	}	517	}
428		518
429	# find on_xxx subs in the package and register them
430	# as hooks
431	sub register_package($) {
432	my ($pkg) = @_;
433
434	for my $htype (0.. $#HOOKNAME) {
435	my $name = $HOOKNAME[$htype];
436
437	my $ref = $pkg->can ("on_" . lc $name)
438	or next;
439
440	$TERM->{_hook}[$htype]{$pkg} = $ref;
441	$hook_count[$htype]++
442	or set_should_invoke $htype, 1;
443	}
444	}
445
446	my $extension_pkg = "extension0000";	519	my $extension_pkg = "extension0000";
447	my %extension_pkg;	520	my %extension_pkg;
448		521
449	# load a single script into its own package, once only	522	# load a single script into its own package, once only
450	sub extension_package($) {	523	sub extension_package($) {
…		…
456	verbose 3, "loading extension '$path' into package '$pkg'";	529	verbose 3, "loading extension '$path' into package '$pkg'";
457		530
458	open my $fh, "<:raw", $path	531	open my $fh, "<:raw", $path
459	or die "$path: $!";	532	or die "$path: $!";
460		533
		534	my $source = untaint
461	my $source = "package $pkg; use strict; use utf8;\n"	535	"package $pkg; use strict; use utf8;\n"
462	. "use base urxvt::term::proxy::;\n"	536	. "use base urxvt::term::extension::;\n"
463	. "#line 1 \"$path\"\n{\n"	537	. "#line 1 \"$path\"\n{\n"
464	. (do { local $/; <$fh> })	538	. (do { local $/; <$fh> })
465	. "\n};\n1";	539	. "\n};\n1";
466		540
		541	eval $source
467	eval $source or die "$path: $@";	542	or die "$path: $@";
468		543
469	$pkg	544	$pkg
470	}	545	}
471	}	546	}
472		547
…		…
477	local $TERM = shift;	552	local $TERM = shift;
478	my $htype = shift;	553	my $htype = shift;
479		554
480	if ($htype == 0) { # INIT	555	if ($htype == 0) { # INIT
481	my @dirs = ((split /:/, $TERM->resource ("perl_lib")), "$LIBDIR/perl");	556	my @dirs = ((split /:/, $TERM->resource ("perl_lib")), "$LIBDIR/perl");
		557
		558	my %ext_arg;
482		559
483	for my $ext (map { split /,/, $TERM->resource ("perl_ext_$_") } 1, 2) {	560	for (map { split /,/, $TERM->resource ("perl_ext_$_") } 1, 2) {
		561	if ($_ eq "default") {
		562	$ext_arg{$_} \|\|= [] for qw(selection option-popup selection-popup searchable-scrollback);
		563	} elsif (/^-(.*)$/) {
		564	delete $ext_arg{$1};
		565	} elsif (/^([^<]+)<(.*)>$/) {
		566	push @{ $ext_arg{$1} }, $2;
		567	} else {
		568	$ext_arg{$_} \|\|= [];
		569	}
		570	}
		571
		572	while (my ($ext, $argv) = each %ext_arg) {
484	my @files = grep -f $_, map "$_/$ext", @dirs;	573	my @files = grep -f $_, map "$_/$ext", @dirs;
485		574
486	if (@files) {	575	if (@files) {
487	register_package extension_package $files[0];	576	$TERM->register_package (extension_package $files[0], $argv);
488	} else {	577	} else {
489	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";
490	}	579	}
491	}	580	}
		581
		582	eval "#line 1 \"--perl-eval resource/argument\"\n" . $TERM->resource ("perl_eval");
		583	warn $@ if $@;
492	}	584	}
493		585
494	$retval = undef;	586	$retval = undef;
495		587
496	if (my $cb = $TERM->{_hook}[$htype]) {	588	if (my $cb = $TERM->{_hook}[$htype]) {
…		…
498	if $verbosity >= 10;	590	if $verbosity >= 10;
499		591
500	keys %$cb;	592	keys %$cb;
501		593
502	while (my ($pkg, $cb) = each %$cb) {	594	while (my ($pkg, $cb) = each %$cb) {
503	eval {	595	$retval = eval { $cb->($TERM->{_pkg}{$pkg}, @_) }
504	$retval = $cb->(
505	$TERM->{_pkg}{$pkg} \|\|= do {
506	my $proxy = bless { }, $pkg;
507	Scalar::Util::weaken ($proxy->{term} = $TERM);
508	$proxy
509	},
510	@_,
511	) and last;	596	and last;
		597
		598	if ($@) {
		599	$TERM->ungrab; # better to lose the grab than the session
		600	warn $@;
512	};	601	}
513	warn $@ if $@;#d#
514	}	602	}
515	}	603	}
516		604
517	if ($htype == 1) { # DESTROY	605	if ($htype == 1) { # DESTROY
518	# remove hooks if unused
519	if (my $hook = $TERM->{_hook}) {	606	if (my $hook = delete $TERM->{_hook}) {
520	for my $htype (0..$#$hook) {	607	for my $htype (0..$#$hook) {
521	$hook_count[$htype] -= scalar keys %{ $hook->[$htype] \|\| {} }	608	$hook_count[$htype] -= scalar keys %{ $hook->[$htype] \|\| {} }
522	or set_should_invoke $htype, 0;	609	or set_should_invoke $htype, 0;
523	}	610	}
524	}	611	}
…		…
531	}	618	}
532		619
533	$retval	620	$retval
534	}	621	}
535		622
536	sub urxvt::term::proxy::AUTOLOAD {	623	# urxvt::term::extension
537	$urxvt::term::proxy::AUTOLOAD =~ /:([^:]+)$/	624
		625	package urxvt::term::extension;
		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 =~ /:([^:]+)$/
538	or die "FATAL: \$AUTOLOAD '$urxvt::term::proxy::AUTOLOAD' unparsable";	665	or die "FATAL: \$AUTOLOAD '$AUTOLOAD' unparsable";
539		666
540	eval qq{	667	eval qq{
541	sub $urxvt::term::proxy::AUTOLOAD {	668	sub $AUTOLOAD {
542	my \$proxy = shift;	669	my \$proxy = shift;
543	\$proxy->{term}->$1 (\@_)	670	\$proxy->{term}->$1 (\@_)
544	}	671	}
545	1	672	1
546	} or die "FATAL: unable to compile method forwarder: $@";	673	} or die "FATAL: unable to compile method forwarder: $@";
547		674
548	goto &$urxvt::term::proxy::AUTOLOAD;	675	goto &$AUTOLOAD;
549	}	676	}
		677
		678	sub DESTROY {
		679	# nop
		680	}
		681
		682	# urxvt::destroy_hook
550		683
551	sub urxvt::destroy_hook::DESTROY {	684	sub urxvt::destroy_hook::DESTROY {
552	${$_[0]}->();	685	${$_[0]}->();
553	}	686	}
554		687
555	sub urxvt::destroy_hook(&) {	688	sub urxvt::destroy_hook(&) {
556	bless \shift, urxvt::destroy_hook::	689	bless \shift, urxvt::destroy_hook::
557	}	690	}
558		691
		692	package urxvt::anyevent;
		693
		694	=head2 The C<urxvt::anyevent> Class
		695
		696	The sole purpose of this class is to deliver an interface to the
		697	C<AnyEvent> module - any module using it will work inside urxvt without
		698	further programming. The only exception is that you cannot wait on
		699	condition variables, but non-blocking condvar use is ok. What this means
		700	is that you cannot use blocking APIs, but the non-blocking variant should
		701	work.
		702
		703	=cut
		704
		705	our $VERSION = 1;
		706
		707	$INC{"urxvt/anyevent.pm"} = 1; # mark us as there
		708	push @AnyEvent::REGISTRY, [urxvt => urxvt::anyevent::];
		709
		710	sub timer {
		711	my ($class, %arg) = @_;
		712
		713	my $cb = $arg{cb};
		714
		715	urxvt::timer
		716	->new
		717	->start (urxvt::NOW + $arg{after})
		718	->cb (sub {
		719	$_[0]->stop; # need to cancel manually
		720	$cb->();
		721	})
		722	}
		723
		724	sub io {
		725	my ($class, %arg) = @_;
		726
		727	my $cb = $arg{cb};
		728
		729	bless [$arg{fh}, urxvt::iow
		730	->new
		731	->fd (fileno $arg{fh})
		732	->events (($arg{poll} =~ /r/ ? 1 : 0)
		733	\| ($arg{poll} =~ /w/ ? 2 : 0))
		734	->start
		735	->cb (sub {
		736	$cb->(($_[1] & 1 ? 'r' : '')
		737	. ($_[1] & 2 ? 'w' : ''));
		738	})],
		739	urxvt::anyevent::
		740	}
		741
		742	sub DESTROY {
		743	$_[0][1]->stop;
		744	}
		745
		746	sub condvar {
		747	bless \my $flag, urxvt::anyevent::condvar::
		748	}
		749
		750	sub urxvt::anyevent::condvar::broadcast {
		751	${$_[0]}++;
		752	}
		753
		754	sub urxvt::anyevent::condvar::wait {
		755	unless (${$_[0]}) {
		756	Carp::croak "AnyEvent->condvar blocking wait unsupported in urxvt, use a non-blocking API";
		757	}
		758	}
		759
		760	package urxvt::term;
		761
559	=head2 The C<urxvt::term> Class	762	=head2 The C<urxvt::term> Class
560		763
561	=over 4	764	=over 4
562		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
563	=item $term->destroy	788	=item $term->destroy
564		789
565	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.
		793
		794	=item $isset = $term->option ($optval[, $set])
		795
		796	Returns true if the option specified by C<$optval> is enabled, and
		797	optionally change it. All option values are stored by name in the hash
		798	C<%urxvt::OPTION>. Options not enabled in this binary are not in the hash.
		799
		800	Here is a a likely non-exhaustive list of option names, please see the
		801	source file F</src/optinc.h> to see the actual list:
		802
		803	borderLess console cursorBlink cursorUnderline hold iconic insecure
		804	intensityStyles jumpScroll loginShell mapAlert meta8 mouseWheelScrollPage
		805	pastableTabs pointerBlank reverseVideo scrollBar scrollBar_floating
		806	scrollBar_right scrollTtyKeypress scrollTtyOutput scrollWithBuffer
		807	secondaryScreen secondaryScroll skipBuiltinGlyphs transparent
		808	tripleclickwords utmpInhibit visualBell
566		809
567	=item $value = $term->resource ($name[, $newval])	810	=item $value = $term->resource ($name[, $newval])
568		811
569	Returns the current resource value associated with a given name and	812	Returns the current resource value associated with a given name and
570	optionally sets a new value. Setting values is most useful in the C<init>	813	optionally sets a new value. Setting values is most useful in the C<init>
…		…
580		823
581	Please note that resource strings will currently only be freed when the	824	Please note that resource strings will currently only be freed when the
582	terminal is destroyed, so changing options frequently will eat memory.	825	terminal is destroyed, so changing options frequently will eat memory.
583		826
584	Here is a a likely non-exhaustive list of resource names, not all of which	827	Here is a a likely non-exhaustive list of resource names, not all of which
585	are supported in every build, please see the source to see the actual	828	are supported in every build, please see the source file F</src/rsinc.h>
586	list:	829	to see the actual list:
587		830
588	answerbackstring backgroundPixmap backspace_key boldFont boldItalicFont	831	answerbackstring backgroundPixmap backspace_key boldFont boldItalicFont
589	borderLess color cursorBlink cursorUnderline cutchars delete_key	832	borderLess color cursorBlink cursorUnderline cutchars delete_key
590	display_name embed ext_bwidth fade font geometry hold iconName	833	display_name embed ext_bwidth fade font geometry hold iconName
591	imFont imLocale inputMethod insecure int_bwidth intensityStyles	834	imFont imLocale inputMethod insecure int_bwidth intensityStyles
…		…
598	shade term_name title transparent transparent_all tripleclickwords	841	shade term_name title transparent transparent_all tripleclickwords
599	utmpInhibit visualBell	842	utmpInhibit visualBell
600		843
601	=cut	844	=cut
602		845
603	sub urxvt::term::resource($$;$) {	846	sub resource($$;$) {
604	my ($self, $name) = (shift, shift);	847	my ($self, $name) = (shift, shift);
605	unshift @_, $self, $name, ($name =~ s/\s\+\s(\d+)$// ? $1 : 0);	848	unshift @_, $self, $name, ($name =~ s/\s\+\s(\d+)$// ? $1 : 0);
606	&urxvt::term::_resource	849	&urxvt::term::_resource
607	}	850	}
608		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
609	=item $rend = $term->rstyle ([$new_rstyle])	857	=item $rend = $term->rstyle ([$new_rstyle])
610		858
611	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
612	the terminal application will use this style.	860	the terminal application will use this style.
613		861
…		…
632		880
633	=item $oldtext = $term->selection ([$newtext])	881	=item $oldtext = $term->selection ([$newtext])
634		882
635	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>.
636		884
637	#=item $term->overlay ($x, $y, $text)	885	=item $term->overlay_simple ($x, $y, $text)
638	#	886
639	#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.
640	#	888
641	#=cut	889	=cut
642	#	890
643	#sub urxvt::term::scr_overlay {	891	sub overlay_simple {
644	# my ($self, $x, $y, $text) = @_;	892	my ($self, $x, $y, $text) = @_;
645	#	893
646	# my @lines = split /\n/, $text;	894	my @lines = split /\n/, $text;
647	#	895
648	# my $w = 0;	896	my $w = List::Util::max map $self->strwidth ($_), @lines;
649	# for (map $self->strwidth ($_), @lines) {	897
650	# $w = $_ if $w < $_;
651	# }
652	#
653	# $self->scr_overlay_new ($x, $y, $w, scalar @lines);	898	my $overlay = $self->overlay ($x, $y, $w, scalar @lines);
654	# $self->scr_overlay_set (0, $_, $lines[$_]) for 0.. $#lines;	899	$overlay->set (0, $_, $lines[$_]) for 0.. $#lines;
655	#}	900
		901	$overlay
		902	}
656		903
657	=item $term->overlay ($x, $y, $width, $height[, $rstyle[, $border]])	904	=item $term->overlay ($x, $y, $width, $height[, $rstyle[, $border]])
658		905
659	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
660	width/height. C<$rstyle> defines the initial rendition style	907	width/height. C<$rstyle> defines the initial rendition style
…		…
695	C<$event> I<must> be the event causing the menu to pop up (a button event,	942	C<$event> I<must> be the event causing the menu to pop up (a button event,
696	currently).	943	currently).
697		944
698	=cut	945	=cut
699		946
700	sub urxvt::term::popup {	947	sub popup {
701	my ($self, $event) = @_;	948	my ($self, $event) = @_;
702		949
703	$self->grab ($event->{time}, 1)	950	$self->grab ($event->{time}, 1)
704	or return;	951	or return;
705		952
…		…
727		974
728	=item $string = $term->locale_decode ($octets)	975	=item $string = $term->locale_decode ($octets)
729		976
730	Convert the given locale-encoded octets into a perl string.	977	Convert the given locale-encoded octets into a perl string.
731		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
732	=item $term->scr_add_lines ($string)	996	=item $term->scr_add_lines ($string)
733		997
734	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
735	running inside the terminal. It may not contain command sequences (escape	999	running inside the terminal. It may not contain command sequences (escape
736	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
…		…
750		1014
751	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
752	pass characters instead of octets, you should convert your strings first	1016	pass characters instead of octets, you should convert your strings first
753	to the locale-specific encoding using C<< $term->locale_encode >>.	1017	to the locale-specific encoding using C<< $term->locale_encode >>.
754		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
755	=item $windowid = $term->parent	1026	=item $windowid = $term->parent
756		1027
757	Return the window id of the toplevel window.	1028	Return the window id of the toplevel window.
758		1029
759	=item $windowid = $term->vt	1030	=item $windowid = $term->vt
…		…
783	=item $nrow_plus_saveLines = $term->total_rows	1054	=item $nrow_plus_saveLines = $term->total_rows
784		1055
785	=item $lines_in_scrollback = $term->nsaved	1056	=item $lines_in_scrollback = $term->nsaved
786		1057
787	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.
788		1067
789	=item $modifiermask = $term->ModLevel3Mask	1068	=item $modifiermask = $term->ModLevel3Mask
790		1069
791	=item $modifiermask = $term->ModMetaMask	1070	=item $modifiermask = $term->ModMetaMask
792		1071
…		…
895		1174
896	=back	1175	=back
897		1176
898	=cut	1177	=cut
899		1178
900	sub urxvt::term::line {	1179	sub line {
901	my ($self, $row) = @_;	1180	my ($self, $row) = @_;
902		1181
903	my $maxrow = $self->nrow - 1;	1182	my $maxrow = $self->nrow - 1;
904		1183
905	my ($beg, $end) = ($row, $row);	1184	my ($beg, $end) = ($row, $row);
…		…
969	$offset / $self->{ncol} + $self->{beg},	1248	$offset / $self->{ncol} + $self->{beg},
970	$offset % $self->{ncol}	1249	$offset % $self->{ncol}
971	)	1250	)
972	}	1251	}
973		1252
974	=item ($row, $col) = $line->coord_of ($offset)
975	=item $text = $term->special_encode $string	1253	=item $text = $term->special_encode $string
976		1254
977	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,
978	where one character corresponds to one screen cell. See	1256	where one character corresponds to one screen cell. See
979	C<< $term->ROW_t >> for details.	1257	C<< $term->ROW_t >> for details.
…		…
981	=item $string = $term->special_decode $text	1259	=item $string = $term->special_decode $text
982		1260
983	Converts rxvt-unicodes text reprsentation into a perl string. See	1261	Converts rxvt-unicodes text reprsentation into a perl string. See
984	C<< $term->ROW_t >> for details.	1262	C<< $term->ROW_t >> for details.
985		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
986	=back	1292	=back
987		1293
		1294	=cut
		1295
		1296	package urxvt::popup;
		1297
988	=head2 The C<urxvt::popup> Class	1298	=head2 The C<urxvt::popup> Class
989		1299
990	=over 4	1300	=over 4
991		1301
992	=cut	1302	=cut
993
994	package urxvt::popup;
995		1303
996	sub add_item {	1304	sub add_item {
997	my ($self, $item) = @_;	1305	my ($self, $item) = @_;
998		1306
		1307	$item->{rend}{normal} = "\x1b[0;30;47m" unless exists $item->{rend}{normal};
		1308	$item->{rend}{hover} = "\x1b[0;30;46m" unless exists $item->{rend}{hover};
		1309	$item->{rend}{active} = "\x1b[m" unless exists $item->{rend}{active};
		1310
		1311	$item->{render} \|\|= sub { $_[0]{text} };
		1312
999	push @{ $self->{item} }, $item;	1313	push @{ $self->{item} }, $item;
		1314	}
		1315
		1316	sub add_separator {
		1317	my ($self, $sep) = @_;
		1318
		1319	$sep \|\|= "=";
		1320
		1321	$self->add_item ({
		1322	rend => { normal => "\x1b[0;30;47m", hover => "\x1b[0;30;47m", active => "\x1b[0;30;47m" },
		1323	text => "",
		1324	render => sub { $sep x $self->{term}->ncol },
		1325	activate => sub { },
		1326	});
		1327	}
		1328
		1329	sub add_title {
		1330	my ($self, $title) = @_;
		1331
		1332	$self->add_item ({
		1333	rend => { normal => "\x1b[38;5;11;44m", hover => "\x1b[38;5;11;44m", active => "\x1b[38;5;11;44m" },
		1334	text => $title,
		1335	activate => sub { },
		1336	});
1000	}	1337	}
1001		1338
1002	sub add_button {	1339	sub add_button {
1003	my ($self, $text, $cb) = @_;	1340	my ($self, $text, $cb) = @_;
1004		1341
1005	$self->add_item ({ type => "button", text => "[ $text ]", activate => $cb });	1342	$self->add_item ({ type => "button", text => $text, activate => $cb});
		1343	}
		1344
		1345	sub add_toggle {
		1346	my ($self, $text, $cb, $value) = @_;
		1347
		1348	my $item; $item = {
		1349	type => "button",
		1350	text => " $text",
		1351	value => $value,
		1352	render => sub { ($_[0]{value} ? "* " : " ") . $text },
		1353	activate => sub { $cb->($_[0]{value} = !$_[0]{value}); },
		1354	};
		1355
		1356	$self->add_item ($item);
1006	}	1357	}
1007		1358
1008	sub show {	1359	sub show {
1009	my ($self) = @_;	1360	my ($self) = @_;
1010		1361
1011	local $urxvt::popup::self = $self;	1362	local $urxvt::popup::self = $self;
1012		1363
		1364	local $ENV{LC_ALL} = $self->{term}->locale;
		1365
1013	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,
1014	"--transient-for" => $self->{term}->parent,	1367	"--transient-for" => $self->{term}->parent,
		1368	"-display" => $self->{term}->display_id,
1015	"-pe" => "urxvt-popup")	1369	"-pe" => "urxvt-popup")
1016	or die "unable to create popup window\n";	1370	or die "unable to create popup window\n";
1017	}	1371	}
1018		1372
1019	sub DESTROY {	1373	sub DESTROY {
1020	my ($self) = @_;	1374	my ($self) = @_;
1021		1375
		1376	delete $self->{term}{_destroy}{$self};
1022	$self->{term}->ungrab;	1377	$self->{term}->ungrab;
1023	}	1378	}
1024		1379
1025	=head2 The C<urxvt::timer> Class	1380	=head2 The C<urxvt::timer> Class
1026		1381
…		…
1081		1436
1082	$term->{socket} = ...	1437	$term->{socket} = ...
1083	$term->{iow} = urxvt::iow	1438	$term->{iow} = urxvt::iow
1084	->new	1439	->new
1085	->fd (fileno $term->{socket})	1440	->fd (fileno $term->{socket})
1086	->events (1) # wait for read data	1441	->events (urxvt::EVENT_READ)
1087	->start	1442	->start
1088	->cb (sub {	1443	->cb (sub {
1089	my ($iow, $revents) = @_;	1444	my ($iow, $revents) = @_;
1090	# $revents must be 1 here, no need to check	1445	# $revents must be 1 here, no need to check
1091	sysread $term->{socket}, my $buf, 8192	1446	sysread $term->{socket}, my $buf, 8192
…		…
1108		1463
1109	Set the filedescriptor (not handle) to watch.	1464	Set the filedescriptor (not handle) to watch.
1110		1465
1111	=item $iow = $iow->events ($eventmask)	1466	=item $iow = $iow->events ($eventmask)
1112		1467
1113	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
1114	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>.
1115		1471
1116	=item $iow = $iow->start	1472	=item $iow = $iow->start
1117		1473
1118	Start watching for requested events on the given handle.	1474	Start watching for requested events on the given handle.
1119		1475
…		…
1130	This variable controls the verbosity level of the perl extension. Higher	1486	This variable controls the verbosity level of the perl extension. Higher
1131	numbers indicate more verbose output.	1487	numbers indicate more verbose output.
1132		1488
1133	=over 4	1489	=over 4
1134		1490
1135	=item =0 - only fatal messages	1491	=item == 0 - fatal messages
1136		1492
1137	=item =3 - script loading and management	1493	=item >= 3 - script loading and management
1138		1494
1139	=item =10 - all events received	1495	=item >=10 - all events received
1140		1496
1141	=back	1497	=back
1142		1498
1143	=head1 AUTHOR	1499	=head1 AUTHOR
1144		1500

Diff Legend

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

Comparing rxvt-unicode/src/urxvt.pm (file contents): Revision 1.47 by root, Sat Jan 7 21:22:02 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.47 by root, Sat Jan 7 21:22:02 2006 UTC vs.
Revision 1.75 by root, Tue Jan 10 05:00:13 2006 UTC