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

Comparing rxvt-unicode/src/urxvt.pm (file contents):
Revision 1.51 by root, Sun Jan 8 00:27:47 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
…		…
399		474
400	package urxvt;	475	package urxvt;
401		476
402	use utf8;	477	use utf8;
403	use strict;	478	use strict;
		479	use Carp ();
404	use Scalar::Util ();	480	use Scalar::Util ();
405	use List::Util ();	481	use List::Util ();
406		482
		483	our $VERSION = 1;
407	our $TERM;	484	our $TERM;
408	our @HOOKNAME;	485	our @HOOKNAME;
		486	our %HOOKTYPE = map +($HOOKNAME[$_] => $_), 0..$#HOOKNAME;
409	our %OPTION;	487	our %OPTION;
		488
410	our $LIBDIR;	489	our $LIBDIR;
		490	our $RESNAME;
		491	our $RESCLASS;
		492	our $RXVTNAME;
411		493
412	BEGIN {	494	BEGIN {
413	urxvt->bootstrap;	495	urxvt->bootstrap;
414		496
415	# overwrite perl's warn	497	# overwrite perl's warn
…		…
417	my $msg = join "", @_;	499	my $msg = join "", @_;
418	$msg .= "\n"	500	$msg .= "\n"
419	unless $msg =~ /\n$/;	501	unless $msg =~ /\n$/;
420	urxvt::warn ($msg);	502	urxvt::warn ($msg);
421	};	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";
422	}	509	}
423		510
424	my @hook_count;	511	my @hook_count;
425	my $verbosity = $ENV{URXVT_PERL_VERBOSITY};	512	my $verbosity = $ENV{URXVT_PERL_VERBOSITY};
426		513
427	sub verbose {	514	sub verbose {
428	my ($level, $msg) = @_;	515	my ($level, $msg) = @_;
429	warn "$msg\n" if $level <= $verbosity;	516	warn "$msg\n" if $level <= $verbosity;
430	}	517	}
431		518
432	# find on_xxx subs in the package and register them
433	# as hooks
434	sub register_package($) {
435	my ($pkg) = @_;
436
437	for my $htype (0.. $#HOOKNAME) {
438	my $name = $HOOKNAME[$htype];
439
440	my $ref = $pkg->can ("on_" . lc $name)
441	or next;
442
443	$TERM->{_hook}[$htype]{$pkg} = $ref;
444	$hook_count[$htype]++
445	or set_should_invoke $htype, 1;
446	}
447	}
448
449	my $extension_pkg = "extension0000";	519	my $extension_pkg = "extension0000";
450	my %extension_pkg;	520	my %extension_pkg;
451		521
452	# load a single script into its own package, once only	522	# load a single script into its own package, once only
453	sub extension_package($) {	523	sub extension_package($) {
…		…
459	verbose 3, "loading extension '$path' into package '$pkg'";	529	verbose 3, "loading extension '$path' into package '$pkg'";
460		530
461	open my $fh, "<:raw", $path	531	open my $fh, "<:raw", $path
462	or die "$path: $!";	532	or die "$path: $!";
463		533
		534	my $source = untaint
464	my $source = "package $pkg; use strict; use utf8;\n"	535	"package $pkg; use strict; use utf8;\n"
465	. "use base urxvt::term::proxy::;\n"	536	. "use base urxvt::term::extension::;\n"
466	. "#line 1 \"$path\"\n{\n"	537	. "#line 1 \"$path\"\n{\n"
467	. (do { local $/; <$fh> })	538	. (do { local $/; <$fh> })
468	. "\n};\n1";	539	. "\n};\n1";
469		540
		541	eval $source
470	eval $source or die "$path: $@";	542	or die "$path: $@";
471		543
472	$pkg	544	$pkg
473	}	545	}
474	}	546	}
475		547
…		…
481	my $htype = shift;	553	my $htype = shift;
482		554
483	if ($htype == 0) { # INIT	555	if ($htype == 0) { # INIT
484	my @dirs = ((split /:/, $TERM->resource ("perl_lib")), "$LIBDIR/perl");	556	my @dirs = ((split /:/, $TERM->resource ("perl_lib")), "$LIBDIR/perl");
485		557
486	my %want_ext;	558	my %ext_arg;
487		559
488	for (map { split /,/, $TERM->resource ("perl_ext_$_") } 1, 2) {	560	for (map { split /,/, $TERM->resource ("perl_ext_$_") } 1, 2) {
489	if ($_ eq "default") {	561	if ($_ eq "default") {
490	$want_ext{$_}++ for qw(selection option-popup);	562	$ext_arg{$_} \|\|= [] for qw(selection option-popup selection-popup searchable-scrollback);
491	} elsif (/^-(.*)$/) {	563	} elsif (/^-(.*)$/) {
492	delete $want_ext{$1};	564	delete $ext_arg{$1};
		565	} elsif (/^([^<]+)<(.*)>$/) {
		566	push @{ $ext_arg{$1} }, $2;
493	} else {	567	} else {
494	$want_ext{$_}++;	568	$ext_arg{$_} \|\|= [];
495	}	569	}
496	}	570	}
497		571
498	for my $ext (keys %want_ext) {	572	while (my ($ext, $argv) = each %ext_arg) {
499	my @files = grep -f $_, map "$_/$ext", @dirs;	573	my @files = grep -f $_, map "$_/$ext", @dirs;
500		574
501	if (@files) {	575	if (@files) {
502	register_package extension_package $files[0];	576	$TERM->register_package (extension_package $files[0], $argv);
503	} else {	577	} else {
504	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";
505	}	579	}
506	}	580	}
		581
		582	eval "#line 1 \"--perl-eval resource/argument\"\n" . $TERM->resource ("perl_eval");
		583	warn $@ if $@;
507	}	584	}
508		585
509	$retval = undef;	586	$retval = undef;
510		587
511	if (my $cb = $TERM->{_hook}[$htype]) {	588	if (my $cb = $TERM->{_hook}[$htype]) {
…		…
513	if $verbosity >= 10;	590	if $verbosity >= 10;
514		591
515	keys %$cb;	592	keys %$cb;
516		593
517	while (my ($pkg, $cb) = each %$cb) {	594	while (my ($pkg, $cb) = each %$cb) {
518	eval {	595	$retval = eval { $cb->($TERM->{_pkg}{$pkg}, @_) }
519	$retval = $cb->(
520	$TERM->{_pkg}{$pkg} \|\|= do {
521	my $proxy = bless { }, $pkg;
522	Scalar::Util::weaken ($proxy->{term} = $TERM);
523	$proxy
524	},
525	@_,
526	) and last;	596	and last;
		597
		598	if ($@) {
		599	$TERM->ungrab; # better to lose the grab than the session
		600	warn $@;
527	};	601	}
528	warn $@ if $@;#d#
529	}	602	}
530	}	603	}
531		604
532	if ($htype == 1) { # DESTROY	605	if ($htype == 1) { # DESTROY
533	# remove hooks if unused
534	if (my $hook = $TERM->{_hook}) {	606	if (my $hook = delete $TERM->{_hook}) {
535	for my $htype (0..$#$hook) {	607	for my $htype (0..$#$hook) {
536	$hook_count[$htype] -= scalar keys %{ $hook->[$htype] \|\| {} }	608	$hook_count[$htype] -= scalar keys %{ $hook->[$htype] \|\| {} }
537	or set_should_invoke $htype, 0;	609	or set_should_invoke $htype, 0;
538	}	610	}
539	}	611	}
…		…
546	}	618	}
547		619
548	$retval	620	$retval
549	}	621	}
550		622
551	sub urxvt::term::proxy::AUTOLOAD {	623	# urxvt::term::extension
552	$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 =~ /:([^:]+)$/
553	or die "FATAL: \$AUTOLOAD '$urxvt::term::proxy::AUTOLOAD' unparsable";	665	or die "FATAL: \$AUTOLOAD '$AUTOLOAD' unparsable";
554		666
555	eval qq{	667	eval qq{
556	sub $urxvt::term::proxy::AUTOLOAD {	668	sub $AUTOLOAD {
557	my \$proxy = shift;	669	my \$proxy = shift;
558	\$proxy->{term}->$1 (\@_)	670	\$proxy->{term}->$1 (\@_)
559	}	671	}
560	1	672	1
561	} or die "FATAL: unable to compile method forwarder: $@";	673	} or die "FATAL: unable to compile method forwarder: $@";
562		674
563	goto &$urxvt::term::proxy::AUTOLOAD;	675	goto &$AUTOLOAD;
564	}	676	}
		677
		678	sub DESTROY {
		679	# nop
		680	}
		681
		682	# urxvt::destroy_hook
565		683
566	sub urxvt::destroy_hook::DESTROY {	684	sub urxvt::destroy_hook::DESTROY {
567	${$_[0]}->();	685	${$_[0]}->();
568	}	686	}
569		687
570	sub urxvt::destroy_hook(&) {	688	sub urxvt::destroy_hook(&) {
571	bless \shift, urxvt::destroy_hook::	689	bless \shift, urxvt::destroy_hook::
572	}	690	}
573		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
574	=head2 The C<urxvt::term> Class	762	=head2 The C<urxvt::term> Class
575		763
576	=over 4	764	=over 4
577		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
578	=item $term->destroy	788	=item $term->destroy
579		789
580	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.
581		793
582	=item $isset = $term->option ($optval[, $set])	794	=item $isset = $term->option ($optval[, $set])
583		795
584	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
585	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
…		…
629	shade term_name title transparent transparent_all tripleclickwords	841	shade term_name title transparent transparent_all tripleclickwords
630	utmpInhibit visualBell	842	utmpInhibit visualBell
631		843
632	=cut	844	=cut
633		845
634	sub urxvt::term::resource($$;$) {	846	sub resource($$;$) {
635	my ($self, $name) = (shift, shift);	847	my ($self, $name) = (shift, shift);
636	unshift @_, $self, $name, ($name =~ s/\s\+\s(\d+)$// ? $1 : 0);	848	unshift @_, $self, $name, ($name =~ s/\s\+\s(\d+)$// ? $1 : 0);
637	&urxvt::term::_resource	849	&urxvt::term::_resource
638	}	850	}
639		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
640	=item $rend = $term->rstyle ([$new_rstyle])	857	=item $rend = $term->rstyle ([$new_rstyle])
641		858
642	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
643	the terminal application will use this style.	860	the terminal application will use this style.
644		861
…		…
663		880
664	=item $oldtext = $term->selection ([$newtext])	881	=item $oldtext = $term->selection ([$newtext])
665		882
666	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>.
667		884
668	#=item $term->overlay ($x, $y, $text)	885	=item $term->overlay_simple ($x, $y, $text)
669	#	886
670	#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.
671	#	888
672	#=cut	889	=cut
673	#	890
674	#sub urxvt::term::scr_overlay {	891	sub overlay_simple {
675	# my ($self, $x, $y, $text) = @_;	892	my ($self, $x, $y, $text) = @_;
676	#	893
677	# my @lines = split /\n/, $text;	894	my @lines = split /\n/, $text;
678	#	895
679	# my $w = 0;	896	my $w = List::Util::max map $self->strwidth ($_), @lines;
680	# for (map $self->strwidth ($_), @lines) {	897
681	# $w = $_ if $w < $_;
682	# }
683	#
684	# $self->scr_overlay_new ($x, $y, $w, scalar @lines);	898	my $overlay = $self->overlay ($x, $y, $w, scalar @lines);
685	# $self->scr_overlay_set (0, $_, $lines[$_]) for 0.. $#lines;	899	$overlay->set (0, $_, $lines[$_]) for 0.. $#lines;
686	#}	900
		901	$overlay
		902	}
687		903
688	=item $term->overlay ($x, $y, $width, $height[, $rstyle[, $border]])	904	=item $term->overlay ($x, $y, $width, $height[, $rstyle[, $border]])
689		905
690	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
691	width/height. C<$rstyle> defines the initial rendition style	907	width/height. C<$rstyle> defines the initial rendition style
…		…
726	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,
727	currently).	943	currently).
728		944
729	=cut	945	=cut
730		946
731	sub urxvt::term::popup {	947	sub popup {
732	my ($self, $event) = @_;	948	my ($self, $event) = @_;
733		949
734	$self->grab ($event->{time}, 1)	950	$self->grab ($event->{time}, 1)
735	or return;	951	or return;
736		952
…		…
758		974
759	=item $string = $term->locale_decode ($octets)	975	=item $string = $term->locale_decode ($octets)
760		976
761	Convert the given locale-encoded octets into a perl string.	977	Convert the given locale-encoded octets into a perl string.
762		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
763	=item $term->scr_add_lines ($string)	996	=item $term->scr_add_lines ($string)
764		997
765	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
766	running inside the terminal. It may not contain command sequences (escape	999	running inside the terminal. It may not contain command sequences (escape
767	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
…		…
781		1014
782	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
783	pass characters instead of octets, you should convert your strings first	1016	pass characters instead of octets, you should convert your strings first
784	to the locale-specific encoding using C<< $term->locale_encode >>.	1017	to the locale-specific encoding using C<< $term->locale_encode >>.
785		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
786	=item $windowid = $term->parent	1026	=item $windowid = $term->parent
787		1027
788	Return the window id of the toplevel window.	1028	Return the window id of the toplevel window.
789		1029
790	=item $windowid = $term->vt	1030	=item $windowid = $term->vt
…		…
814	=item $nrow_plus_saveLines = $term->total_rows	1054	=item $nrow_plus_saveLines = $term->total_rows
815		1055
816	=item $lines_in_scrollback = $term->nsaved	1056	=item $lines_in_scrollback = $term->nsaved
817		1057
818	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.
819		1067
820	=item $modifiermask = $term->ModLevel3Mask	1068	=item $modifiermask = $term->ModLevel3Mask
821		1069
822	=item $modifiermask = $term->ModMetaMask	1070	=item $modifiermask = $term->ModMetaMask
823		1071
…		…
926		1174
927	=back	1175	=back
928		1176
929	=cut	1177	=cut
930		1178
931	sub urxvt::term::line {	1179	sub line {
932	my ($self, $row) = @_;	1180	my ($self, $row) = @_;
933		1181
934	my $maxrow = $self->nrow - 1;	1182	my $maxrow = $self->nrow - 1;
935		1183
936	my ($beg, $end) = ($row, $row);	1184	my ($beg, $end) = ($row, $row);
…		…
1000	$offset / $self->{ncol} + $self->{beg},	1248	$offset / $self->{ncol} + $self->{beg},
1001	$offset % $self->{ncol}	1249	$offset % $self->{ncol}
1002	)	1250	)
1003	}	1251	}
1004		1252
1005	=item ($row, $col) = $line->coord_of ($offset)
1006	=item $text = $term->special_encode $string	1253	=item $text = $term->special_encode $string
1007		1254
1008	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,
1009	where one character corresponds to one screen cell. See	1256	where one character corresponds to one screen cell. See
1010	C<< $term->ROW_t >> for details.	1257	C<< $term->ROW_t >> for details.
…		…
1012	=item $string = $term->special_decode $text	1259	=item $string = $term->special_decode $text
1013		1260
1014	Converts rxvt-unicodes text reprsentation into a perl string. See	1261	Converts rxvt-unicodes text reprsentation into a perl string. See
1015	C<< $term->ROW_t >> for details.	1262	C<< $term->ROW_t >> for details.
1016		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
1017	=back	1292	=back
1018		1293
		1294	=cut
		1295
		1296	package urxvt::popup;
		1297
1019	=head2 The C<urxvt::popup> Class	1298	=head2 The C<urxvt::popup> Class
1020		1299
1021	=over 4	1300	=over 4
1022		1301
1023	=cut	1302	=cut
1024
1025	package urxvt::popup;
1026		1303
1027	sub add_item {	1304	sub add_item {
1028	my ($self, $item) = @_;	1305	my ($self, $item) = @_;
1029		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
1030	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	});
1031	}	1337	}
1032		1338
1033	sub add_button {	1339	sub add_button {
1034	my ($self, $text, $cb) = @_;	1340	my ($self, $text, $cb) = @_;
1035		1341
1036	$self->add_item ({ type => "button", text => "[ $text ]", activate => $cb,	1342	$self->add_item ({ type => "button", text => $text, activate => $cb});
1037	render => sub { $_[0]{text} },
1038	});
1039	}	1343	}
1040		1344
1041	sub add_toggle {	1345	sub add_toggle {
1042	my ($self, $text, $cb, $value) = @_;	1346	my ($self, $text, $cb, $value) = @_;
1043		1347
1044	my $item; $item = {	1348	my $item; $item = {
1045	type => "button",	1349	type => "button",
1046	text => " $text",	1350	text => " $text",
1047	value => $value,	1351	value => $value,
1048	render => sub { ($item->{value} ? "✔" : " ") . $text },	1352	render => sub { ($_[0]{value} ? "* " : " ") . $text },
1049	activate => sub { $cb->($item->{value} = !$item->{value}); },	1353	activate => sub { $cb->($_[0]{value} = !$_[0]{value}); },
1050	};	1354	};
1051		1355
1052	$self->add_item ($item);	1356	$self->add_item ($item);
1053	}	1357	}
1054		1358
1055	sub show {	1359	sub show {
1056	my ($self) = @_;	1360	my ($self) = @_;
1057		1361
1058	local $urxvt::popup::self = $self;	1362	local $urxvt::popup::self = $self;
1059		1363
		1364	local $ENV{LC_ALL} = $self->{term}->locale;
		1365
1060	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,
1061	"--transient-for" => $self->{term}->parent,	1367	"--transient-for" => $self->{term}->parent,
		1368	"-display" => $self->{term}->display_id,
1062	"-pe" => "urxvt-popup")	1369	"-pe" => "urxvt-popup")
1063	or die "unable to create popup window\n";	1370	or die "unable to create popup window\n";
1064	}	1371	}
1065		1372
1066	sub DESTROY {	1373	sub DESTROY {
1067	my ($self) = @_;	1374	my ($self) = @_;
1068		1375
		1376	delete $self->{term}{_destroy}{$self};
1069	$self->{term}->ungrab;	1377	$self->{term}->ungrab;
1070	}	1378	}
1071		1379
1072	=head2 The C<urxvt::timer> Class	1380	=head2 The C<urxvt::timer> Class
1073		1381
…		…
1128		1436
1129	$term->{socket} = ...	1437	$term->{socket} = ...
1130	$term->{iow} = urxvt::iow	1438	$term->{iow} = urxvt::iow
1131	->new	1439	->new
1132	->fd (fileno $term->{socket})	1440	->fd (fileno $term->{socket})
1133	->events (1) # wait for read data	1441	->events (urxvt::EVENT_READ)
1134	->start	1442	->start
1135	->cb (sub {	1443	->cb (sub {
1136	my ($iow, $revents) = @_;	1444	my ($iow, $revents) = @_;
1137	# $revents must be 1 here, no need to check	1445	# $revents must be 1 here, no need to check
1138	sysread $term->{socket}, my $buf, 8192	1446	sysread $term->{socket}, my $buf, 8192
…		…
1155		1463
1156	Set the filedescriptor (not handle) to watch.	1464	Set the filedescriptor (not handle) to watch.
1157		1465
1158	=item $iow = $iow->events ($eventmask)	1466	=item $iow = $iow->events ($eventmask)
1159		1467
1160	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
1161	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>.
1162		1471
1163	=item $iow = $iow->start	1472	=item $iow = $iow->start
1164		1473
1165	Start watching for requested events on the given handle.	1474	Start watching for requested events on the given handle.
1166		1475
…		…
1177	This variable controls the verbosity level of the perl extension. Higher	1486	This variable controls the verbosity level of the perl extension. Higher
1178	numbers indicate more verbose output.	1487	numbers indicate more verbose output.
1179		1488
1180	=over 4	1489	=over 4
1181		1490
1182	=item =0 - only fatal messages	1491	=item == 0 - fatal messages
1183		1492
1184	=item =3 - script loading and management	1493	=item >= 3 - script loading and management
1185		1494
1186	=item =10 - all events received	1495	=item >=10 - all events received
1187		1496
1188	=back	1497	=back
1189		1498
1190	=head1 AUTHOR	1499	=head1 AUTHOR
1191		1500

Diff Legend

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

Comparing rxvt-unicode/src/urxvt.pm (file contents): Revision 1.51 by root, Sun Jan 8 00:27:47 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.51 by root, Sun Jan 8 00:27:47 2006 UTC vs.
Revision 1.75 by root, Tue Jan 10 05:00:13 2006 UTC