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

Comparing rxvt-unicode/src/urxvt.pm (file contents):
Revision 1.50 by root, Sun Jan 8 00:11:38 2006 UTC vs.
Revision 1.78 by root, Wed Jan 11 01:01:52 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
…		…
99	=over 4	123	=over 4
100		124
101	=item $text	125	=item $text
102		126
103	Rxvt-unicodes special way of encoding text, where one "unicode" character	127	Rxvt-unicodes special way of encoding text, where one "unicode" character
104	always represents one screen cell. See L<row_t> for a discussion of this format.	128	always represents one screen cell. See L<ROW_t> for a discussion of this format.
105		129
106	=item $string	130	=item $string
107		131
108	A perl text string, with an emphasis on I<text>. It can store all unicode	132	A perl text string, with an emphasis on I<text>. It can store all unicode
109	characters and is to be distinguished with text encoded in a specific	133	characters and is to be distinguished with text encoded in a specific
…		…
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
…		…
289		343
290	subwindow.	344	subwindow.
291		345
292	=back	346	=back
293		347
		348	=cut
		349
		350	package urxvt;
		351
		352	use utf8;
		353	use strict;
		354	use Carp ();
		355	use Scalar::Util ();
		356	use List::Util ();
		357
		358	our $VERSION = 1;
		359	our $TERM;
		360	our @HOOKNAME;
		361	our %HOOKTYPE = map +($HOOKNAME[$_] => $_), 0..$#HOOKNAME;
		362	our %OPTION;
		363
		364	our $LIBDIR;
		365	our $RESNAME;
		366	our $RESCLASS;
		367	our $RXVTNAME;
		368
294	=head2 Variables in the C<urxvt> Package	369	=head2 Variables in the C<urxvt> Package
295		370
296	=over 4	371	=over 4
		372
		373	=item $urxvt::LIBDIR
		374
		375	The rxvt-unicode library directory, where, among other things, the perl
		376	modules and scripts are stored.
		377
		378	=item $urxvt::RESCLASS, $urxvt::RESCLASS
		379
		380	The resource class and name rxvt-unicode uses to look up X resources.
		381
		382	=item $urxvt::RXVTNAME
		383
		384	The basename of the installed binaries, usually C<urxvt>.
297		385
298	=item $urxvt::TERM	386	=item $urxvt::TERM
299		387
300	The current terminal. This variable stores the current C<urxvt::term>	388	The current terminal. This variable stores the current C<urxvt::term>
301	object, whenever a callback/hook is executing.	389	object, whenever a callback/hook is executing.
…		…
303	=back	391	=back
304		392
305	=head2 Functions in the C<urxvt> Package	393	=head2 Functions in the C<urxvt> Package
306		394
307	=over 4	395	=over 4
308
309	=item $term = new urxvt [arg...]
310
311	Creates a new terminal, very similar as if you had started it with
312	C<system $binfile, arg...>. Croaks (and probably outputs an error message)
313	if the new instance couldn't be created. Returns C<undef> if the new
314	instance didn't initialise perl, and the terminal object otherwise. The
315	C<init> and C<start> hooks will be called during the call.
316		396
317	=item urxvt::fatal $errormessage	397	=item urxvt::fatal $errormessage
318		398
319	Fatally aborts execution with the given error message. Avoid at all	399	Fatally aborts execution with the given error message. Avoid at all
320	costs! The only time this is acceptable is when the terminal process	400	costs! The only time this is acceptable is when the terminal process
…		…
327	that calls this function.	407	that calls this function.
328		408
329	Using this function has the advantage that its output ends up in the	409	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.	410	correct place, e.g. on stderr of the connecting urxvtc client.
331		411
		412	Messages have a size limit of 1023 bytes currently.
		413
		414	=item $is_safe = urxvt::safe
		415
		416	Returns true when it is safe to do potentially unsafe things, such as
		417	evaluating perl code specified by the user. This is true when urxvt was
		418	started setuid or setgid.
		419
332	=item $time = urxvt::NOW	420	=item $time = urxvt::NOW
333		421
334	Returns the "current time" (as per the event loop).	422	Returns the "current time" (as per the event loop).
335		423
336	=item urxvt::CurrentTime	424	=item urxvt::CurrentTime
337		425
338	=item urxvt::ShiftMask, LockMask, ControlMask, Mod1Mask, Mod2Mask,	426	=item urxvt::ShiftMask, LockMask, ControlMask, Mod1Mask, Mod2Mask,
339	Mod3Mask, Mod4Mask, Mod5Mask, Button1Mask, Button2Mask, Button3Mask,	427	Mod3Mask, Mod4Mask, Mod5Mask, Button1Mask, Button2Mask, Button3Mask,
340	Button4Mask, Button5Mask, AnyModifier	428	Button4Mask, Button5Mask, AnyModifier
341		429
342	Various constants for use in X events.	430	Various constants for use in X calls and event processing.
343		431
344	=back	432	=back
345		433
346	=head2 RENDITION	434	=head2 RENDITION
347		435
…		…
374		462
375	=item $background = urxvt::GET_BASEBG $rend	463	=item $background = urxvt::GET_BASEBG $rend
376		464
377	Return the foreground/background colour index, respectively.	465	Return the foreground/background colour index, respectively.
378		466
379	=item $rend = urxvt::SET_FGCOLOR ($rend, $new_colour)	467	=item $rend = urxvt::SET_FGCOLOR $rend, $new_colour
380		468
381	=item $rend = urxvt::SET_BGCOLOR ($rend, $new_colour)	469	=item $rend = urxvt::SET_BGCOLOR $rend, $new_colour
382		470
383	Replace the foreground/background colour in the rendition mask with the	471	Replace the foreground/background colour in the rendition mask with the
384	specified one.	472	specified one.
385		473
386	=item $value = urxvt::GET_CUSTOM ($rend)	474	=item $value = urxvt::GET_CUSTOM $rend
387		475
388	Return the "custom" value: Every rendition has 5 bits for use by	476	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	477	extensions. They can be set and changed as you like and are initially
390	zero.	478	zero.
391		479
392	=item $rend = urxvt::SET_CUSTOM ($rend, $new_value)	480	=item $rend = urxvt::SET_CUSTOM $rend, $new_value
393		481
394	Change the custom value.	482	Change the custom value.
395		483
396	=back	484	=back
397		485
398	=cut	486	=cut
399
400	package urxvt;
401
402	use utf8;
403	use strict;
404	use Scalar::Util ();
405	use List::Util ();
406
407	our $TERM;
408	our @HOOKNAME;
409	our %OPTION;
410	our $LIBDIR;
411		487
412	BEGIN {	488	BEGIN {
413	urxvt->bootstrap;	489	urxvt->bootstrap;
414		490
415	# overwrite perl's warn	491	# overwrite perl's warn
…		…
417	my $msg = join "", @_;	493	my $msg = join "", @_;
418	$msg .= "\n"	494	$msg .= "\n"
419	unless $msg =~ /\n$/;	495	unless $msg =~ /\n$/;
420	urxvt::warn ($msg);	496	urxvt::warn ($msg);
421	};	497	};
		498
		499	delete $ENV{IFS};
		500	delete $ENV{CDPATH};
		501	delete $ENV{BASH_ENV};
		502	$ENV{PATH} = "/bin:/sbin:/usr/bin:/usr/sbin:/usr/local/bin:/usr/local/sbin:/opt/bin:/opt/sbin";
422	}	503	}
423		504
424	my @hook_count;	505	my @hook_count;
425	my $verbosity = $ENV{URXVT_PERL_VERBOSITY};	506	my $verbosity = $ENV{URXVT_PERL_VERBOSITY};
426		507
427	sub verbose {	508	sub verbose {
428	my ($level, $msg) = @_;	509	my ($level, $msg) = @_;
429	warn "$msg\n" if $level <= $verbosity;	510	warn "$msg\n" if $level <= $verbosity;
430	}	511	}
431		512
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";	513	my $extension_pkg = "extension0000";
450	my %extension_pkg;	514	my %extension_pkg;
451		515
452	# load a single script into its own package, once only	516	# load a single script into its own package, once only
453	sub extension_package($) {	517	sub extension_package($) {
…		…
459	verbose 3, "loading extension '$path' into package '$pkg'";	523	verbose 3, "loading extension '$path' into package '$pkg'";
460		524
461	open my $fh, "<:raw", $path	525	open my $fh, "<:raw", $path
462	or die "$path: $!";	526	or die "$path: $!";
463		527
		528	my $source = untaint
464	my $source = "package $pkg; use strict; use utf8;\n"	529	"package $pkg; use strict; use utf8;\n"
465	. "use base urxvt::term::proxy::;\n"	530	. "use base urxvt::term::extension::;\n"
466	. "#line 1 \"$path\"\n{\n"	531	. "#line 1 \"$path\"\n{\n"
467	. (do { local $/; <$fh> })	532	. (do { local $/; <$fh> })
468	. "\n};\n1";	533	. "\n};\n1";
469		534
		535	eval $source
470	eval $source or die "$path: $@";	536	or die "$path: $@";
471		537
472	$pkg	538	$pkg
473	}	539	}
474	}	540	}
475		541
…		…
481	my $htype = shift;	547	my $htype = shift;
482		548
483	if ($htype == 0) { # INIT	549	if ($htype == 0) { # INIT
484	my @dirs = ((split /:/, $TERM->resource ("perl_lib")), "$LIBDIR/perl");	550	my @dirs = ((split /:/, $TERM->resource ("perl_lib")), "$LIBDIR/perl");
485		551
486	my %want_ext;	552	my %ext_arg;
487		553
488	for (map { split /,/, $TERM->resource ("perl_ext_$_") } 1, 2) {	554	for (map { split /,/, $TERM->resource ("perl_ext_$_") } 1, 2) {
489	if ($_ eq "default") {	555	if ($_ eq "default") {
490	$want_ext{$_}++ for qw(selection);	556	$ext_arg{$_} \|\|= [] for qw(selection option-popup selection-popup searchable-scrollback);
491	} elsif (/-(.*)/) {	557	} elsif (/^-(.*)$/) {
492	delete $want_ext{$1};	558	delete $ext_arg{$1};
		559	} elsif (/^([^<]+)<(.*)>$/) {
		560	push @{ $ext_arg{$1} }, $2;
493	} else {	561	} else {
494	$want_ext{$_}++;	562	$ext_arg{$_} \|\|= [];
495	}	563	}
496	}	564	}
497		565
498	for my $ext (keys %want_ext) {	566	while (my ($ext, $argv) = each %ext_arg) {
499	my @files = grep -f $_, map "$_/$ext", @dirs;	567	my @files = grep -f $_, map "$_/$ext", @dirs;
500		568
501	if (@files) {	569	if (@files) {
502	register_package extension_package $files[0];	570	$TERM->register_package (extension_package $files[0], $argv);
503	} else {	571	} else {
504	warn "perl extension '$ext' not found in perl library search path\n";	572	warn "perl extension '$ext' not found in perl library search path\n";
505	}	573	}
506	}	574	}
		575
		576	eval "#line 1 \"--perl-eval resource/argument\"\n" . $TERM->resource ("perl_eval");
		577	warn $@ if $@;
507	}	578	}
508		579
509	$retval = undef;	580	$retval = undef;
510		581
511	if (my $cb = $TERM->{_hook}[$htype]) {	582	if (my $cb = $TERM->{_hook}[$htype]) {
…		…
513	if $verbosity >= 10;	584	if $verbosity >= 10;
514		585
515	keys %$cb;	586	keys %$cb;
516		587
517	while (my ($pkg, $cb) = each %$cb) {	588	while (my ($pkg, $cb) = each %$cb) {
518	eval {	589	$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;	590	and last;
		591
		592	if ($@) {
		593	$TERM->ungrab; # better to lose the grab than the session
		594	warn $@;
527	};	595	}
528	warn $@ if $@;#d#
529	}	596	}
530	}	597	}
531		598
532	if ($htype == 1) { # DESTROY	599	if ($htype == 1) { # DESTROY
533	# remove hooks if unused
534	if (my $hook = $TERM->{_hook}) {	600	if (my $hook = delete $TERM->{_hook}) {
535	for my $htype (0..$#$hook) {	601	for my $htype (0..$#$hook) {
536	$hook_count[$htype] -= scalar keys %{ $hook->[$htype] \|\| {} }	602	$hook_count[$htype] -= scalar keys %{ $hook->[$htype] \|\| {} }
537	or set_should_invoke $htype, 0;	603	or set_should_invoke $htype, 0;
538	}	604	}
539	}	605	}
…		…
546	}	612	}
547		613
548	$retval	614	$retval
549	}	615	}
550		616
551	sub urxvt::term::proxy::AUTOLOAD {	617	# urxvt::term::extension
552	$urxvt::term::proxy::AUTOLOAD =~ /:([^:]+)$/	618
		619	package urxvt::term::extension;
		620
		621	sub enable {
		622	my ($self, %hook) = @_;
		623	my $pkg = $self->{_pkg};
		624
		625	while (my ($name, $cb) = each %hook) {
		626	my $htype = $HOOKTYPE{uc $name};
		627	defined $htype
		628	or Carp::croak "unsupported hook type '$name'";
		629
		630	unless (exists $self->{term}{_hook}[$htype]{$pkg}) {
		631	$hook_count[$htype]++
		632	or urxvt::set_should_invoke $htype, 1;
		633	}
		634
		635	$self->{term}{_hook}[$htype]{$pkg} = $cb;
		636	}
		637	}
		638
		639	sub disable {
		640	my ($self, @hook) = @_;
		641	my $pkg = $self->{_pkg};
		642
		643	for my $name (@hook) {
		644	my $htype = $HOOKTYPE{uc $name};
		645	defined $htype
		646	or Carp::croak "unsupported hook type '$name'";
		647
		648	if (delete $self->{term}{_hook}[$htype]{$pkg}) {
		649	--$hook_count[$htype]
		650	or urxvt::set_should_invoke $htype, 0;
		651	}
		652	}
		653	}
		654
		655	our $AUTOLOAD;
		656
		657	sub AUTOLOAD {
		658	$AUTOLOAD =~ /:([^:]+)$/
553	or die "FATAL: \$AUTOLOAD '$urxvt::term::proxy::AUTOLOAD' unparsable";	659	or die "FATAL: \$AUTOLOAD '$AUTOLOAD' unparsable";
554		660
555	eval qq{	661	eval qq{
556	sub $urxvt::term::proxy::AUTOLOAD {	662	sub $AUTOLOAD {
557	my \$proxy = shift;	663	my \$proxy = shift;
558	\$proxy->{term}->$1 (\@_)	664	\$proxy->{term}->$1 (\@_)
559	}	665	}
560	1	666	1
561	} or die "FATAL: unable to compile method forwarder: $@";	667	} or die "FATAL: unable to compile method forwarder: $@";
562		668
563	goto &$urxvt::term::proxy::AUTOLOAD;	669	goto &$AUTOLOAD;
564	}	670	}
		671
		672	sub DESTROY {
		673	# nop
		674	}
		675
		676	# urxvt::destroy_hook
565		677
566	sub urxvt::destroy_hook::DESTROY {	678	sub urxvt::destroy_hook::DESTROY {
567	${$_[0]}->();	679	${$_[0]}->();
568	}	680	}
569		681
570	sub urxvt::destroy_hook(&) {	682	sub urxvt::destroy_hook(&) {
571	bless \shift, urxvt::destroy_hook::	683	bless \shift, urxvt::destroy_hook::
572	}	684	}
573		685
		686	package urxvt::anyevent;
		687
		688	=head2 The C<urxvt::anyevent> Class
		689
		690	The sole purpose of this class is to deliver an interface to the
		691	C<AnyEvent> module - any module using it will work inside urxvt without
		692	further programming. The only exception is that you cannot wait on
		693	condition variables, but non-blocking condvar use is ok. What this means
		694	is that you cannot use blocking APIs, but the non-blocking variant should
		695	work.
		696
		697	=cut
		698
		699	our $VERSION = 1;
		700
		701	$INC{"urxvt/anyevent.pm"} = 1; # mark us as there
		702	push @AnyEvent::REGISTRY, [urxvt => urxvt::anyevent::];
		703
		704	sub timer {
		705	my ($class, %arg) = @_;
		706
		707	my $cb = $arg{cb};
		708
		709	urxvt::timer
		710	->new
		711	->start (urxvt::NOW + $arg{after})
		712	->cb (sub {
		713	$_[0]->stop; # need to cancel manually
		714	$cb->();
		715	})
		716	}
		717
		718	sub io {
		719	my ($class, %arg) = @_;
		720
		721	my $cb = $arg{cb};
		722
		723	bless [$arg{fh}, urxvt::iow
		724	->new
		725	->fd (fileno $arg{fh})
		726	->events (($arg{poll} =~ /r/ ? 1 : 0)
		727	\| ($arg{poll} =~ /w/ ? 2 : 0))
		728	->start
		729	->cb (sub {
		730	$cb->(($_[1] & 1 ? 'r' : '')
		731	. ($_[1] & 2 ? 'w' : ''));
		732	})],
		733	urxvt::anyevent::
		734	}
		735
		736	sub DESTROY {
		737	$_[0][1]->stop;
		738	}
		739
		740	sub condvar {
		741	bless \my $flag, urxvt::anyevent::condvar::
		742	}
		743
		744	sub urxvt::anyevent::condvar::broadcast {
		745	${$_[0]}++;
		746	}
		747
		748	sub urxvt::anyevent::condvar::wait {
		749	unless (${$_[0]}) {
		750	Carp::croak "AnyEvent->condvar blocking wait unsupported in urxvt, use a non-blocking API";
		751	}
		752	}
		753
		754	package urxvt::term;
		755
574	=head2 The C<urxvt::term> Class	756	=head2 The C<urxvt::term> Class
575		757
576	=over 4	758	=over 4
577		759
		760	=cut
		761
		762	# find on_xxx subs in the package and register them
		763	# as hooks
		764	sub register_package {
		765	my ($self, $pkg, $argv) = @_;
		766
		767	my $proxy = bless {
		768	_pkg => $pkg,
		769	argv => $argv,
		770	}, $pkg;
		771	Scalar::Util::weaken ($proxy->{term} = $self);
		772
		773	$self->{_pkg}{$pkg} = $proxy;
		774
		775	for my $name (@HOOKNAME) {
		776	if (my $ref = $pkg->can ("on_" . lc $name)) {
		777	$proxy->enable ($name => $ref);
		778	}
		779	}
		780	}
		781
		782	=item $term = new urxvt::term $envhashref, $rxvtname, [arg...]
		783
		784	Creates a new terminal, very similar as if you had started it with system
		785	C<$rxvtname, arg...>. C<$envhashref> must be a reference to a C<%ENV>-like
		786	hash which defines the environment of the new terminal.
		787
		788	Croaks (and probably outputs an error message) if the new instance
		789	couldn't be created. Returns C<undef> if the new instance didn't
		790	initialise perl, and the terminal object otherwise. The C<init> and
		791	C<start> hooks will be called during this call.
		792
		793	=cut
		794
		795	sub new {
		796	my ($class, $env, @args) = @_;
		797
		798	_new ([ map "$_=$env->{$_}", keys %$env ], @args);
		799	}
		800
578	=item $term->destroy	801	=item $term->destroy
579		802
580	Destroy the terminal object (close the window, free resources etc.).	803	Destroy the terminal object (close the window, free resources
		804	etc.). Please note that @@RXVT_NAME@@ will not exit as long as any event
		805	watchers (timers, io watchers) are still active.
581		806
582	=item $isset = $term->option ($optval[, $set])	807	=item $isset = $term->option ($optval[, $set])
583		808
584	Returns true if the option specified by C<$optval> is enabled, and	809	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	810	optionally change it. All option values are stored by name in the hash
…		…
629	shade term_name title transparent transparent_all tripleclickwords	854	shade term_name title transparent transparent_all tripleclickwords
630	utmpInhibit visualBell	855	utmpInhibit visualBell
631		856
632	=cut	857	=cut
633		858
634	sub urxvt::term::resource($$;$) {	859	sub resource($$;$) {
635	my ($self, $name) = (shift, shift);	860	my ($self, $name) = (shift, shift);
636	unshift @_, $self, $name, ($name =~ s/\s\+\s(\d+)$// ? $1 : 0);	861	unshift @_, $self, $name, ($name =~ s/\s\+\s(\d+)$// ? $1 : 0);
637	&urxvt::term::_resource	862	&urxvt::term::_resource
638	}	863	}
639		864
		865	=item $success = $term->parse_keysym ($keysym_spec, $command_string)
		866
		867	Adds a keymap translation exactly as specified via a resource. See the
		868	C<keysym> resource in the @@RXVT_NAME@@(1) manpage.
		869
640	=item $rend = $term->rstyle ([$new_rstyle])	870	=item $rend = $term->rstyle ([$new_rstyle])
641		871
642	Return and optionally change the current rendition. Text that is output by	872	Return and optionally change the current rendition. Text that is output by
643	the terminal application will use this style.	873	the terminal application will use this style.
644		874
…		…
663		893
664	=item $oldtext = $term->selection ([$newtext])	894	=item $oldtext = $term->selection ([$newtext])
665		895
666	Return the current selection text and optionally replace it by C<$newtext>.	896	Return the current selection text and optionally replace it by C<$newtext>.
667		897
668	#=item $term->overlay ($x, $y, $text)	898	=item $term->overlay_simple ($x, $y, $text)
669	#	899
670	#Create a simple multi-line overlay box. See the next method for details.	900	Create a simple multi-line overlay box. See the next method for details.
671	#	901
672	#=cut	902	=cut
673	#	903
674	#sub urxvt::term::scr_overlay {	904	sub overlay_simple {
675	# my ($self, $x, $y, $text) = @_;	905	my ($self, $x, $y, $text) = @_;
676	#	906
677	# my @lines = split /\n/, $text;	907	my @lines = split /\n/, $text;
678	#	908
679	# my $w = 0;	909	my $w = List::Util::max map $self->strwidth ($_), @lines;
680	# for (map $self->strwidth ($_), @lines) {	910
681	# $w = $_ if $w < $_;
682	# }
683	#
684	# $self->scr_overlay_new ($x, $y, $w, scalar @lines);	911	my $overlay = $self->overlay ($x, $y, $w, scalar @lines);
685	# $self->scr_overlay_set (0, $_, $lines[$_]) for 0.. $#lines;	912	$overlay->set (0, $_, $lines[$_]) for 0.. $#lines;
686	#}	913
		914	$overlay
		915	}
687		916
688	=item $term->overlay ($x, $y, $width, $height[, $rstyle[, $border]])	917	=item $term->overlay ($x, $y, $width, $height[, $rstyle[, $border]])
689		918
690	Create a new (empty) overlay at the given position with the given	919	Create a new (empty) overlay at the given position with the given
691	width/height. C<$rstyle> defines the initial rendition style	920	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,	955	C<$event> I<must> be the event causing the menu to pop up (a button event,
727	currently).	956	currently).
728		957
729	=cut	958	=cut
730		959
731	sub urxvt::term::popup {	960	sub popup {
732	my ($self, $event) = @_;	961	my ($self, $event) = @_;
733		962
734	$self->grab ($event->{time}, 1)	963	$self->grab ($event->{time}, 1)
735	or return;	964	or return;
736		965
…		…
758		987
759	=item $string = $term->locale_decode ($octets)	988	=item $string = $term->locale_decode ($octets)
760		989
761	Convert the given locale-encoded octets into a perl string.	990	Convert the given locale-encoded octets into a perl string.
762		991
		992	=item $term->scr_xor_span ($beg_row, $beg_col, $end_row, $end_col[, $rstyle])
		993
		994	XORs the rendition values in the given span with the provided value
		995	(default: C<RS_RVid>). Useful in refresh hooks to provide effects similar
		996	to the selection.
		997
		998	=item $term->scr_xor_rect ($beg_row, $beg_col, $end_row, $end_col[, $rstyle1[, $rstyle2]])
		999
		1000	Similar to C<scr_xor_span>, but xors a rectangle instead. Trailing
		1001	whitespace will additionally be xored with the C<$rstyle2>, which defaults
		1002	to C<RS_RVid \| RS_Uline>, which removes reverse video again and underlines
		1003	it instead.
		1004
		1005	=item $term->scr_bell
		1006
		1007	Ring the bell!
		1008
763	=item $term->scr_add_lines ($string)	1009	=item $term->scr_add_lines ($string)
764		1010
765	Write the given text string to the screen, as if output by the application	1011	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	1012	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	1013	codes), but is free to use line feeds, carriage returns and tabs. The
…		…
781		1027
782	Write the octets given in C<$data> to the tty (i.e. as program input). To	1028	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	1029	pass characters instead of octets, you should convert your strings first
784	to the locale-specific encoding using C<< $term->locale_encode >>.	1030	to the locale-specific encoding using C<< $term->locale_encode >>.
785		1031
		1032	=item $old_events = $term->pty_ev_events ([$new_events])
		1033
		1034	Replaces the event mask of the pty watcher by the given event mask. Can
		1035	be used to suppress input and output handling to the pty/tty. See the
		1036	description of C<< urxvt::timer->events >>. Make sure to always restore
		1037	the previous value.
		1038
786	=item $windowid = $term->parent	1039	=item $windowid = $term->parent
787		1040
788	Return the window id of the toplevel window.	1041	Return the window id of the toplevel window.
789		1042
790	=item $windowid = $term->vt	1043	=item $windowid = $term->vt
…		…
814	=item $nrow_plus_saveLines = $term->total_rows	1067	=item $nrow_plus_saveLines = $term->total_rows
815		1068
816	=item $lines_in_scrollback = $term->nsaved	1069	=item $lines_in_scrollback = $term->nsaved
817		1070
818	Return various integers describing terminal characteristics.	1071	Return various integers describing terminal characteristics.
		1072
		1073	=item $x_display = $term->display_id
		1074
		1075	Return the DISPLAY used by rxvt-unicode.
		1076
		1077	=item $lc_ctype = $term->locale
		1078
		1079	Returns the LC_CTYPE category string used by this rxvt-unicode.
		1080
		1081	=item $env = $term->env
		1082
		1083	Returns a copy of the environment in effect for the terminal as a hashref
		1084	similar to C<\%ENV>.
		1085
		1086	=cut
		1087
		1088	sub env {
		1089	if (my $env = $_[0]->_env) {
		1090	+{ map /^([^=]+)(?:=(.*))?$/s && ($1 => $2), @$env }
		1091	} else {
		1092	+{ %ENV }
		1093	}
		1094	}
819		1095
820	=item $modifiermask = $term->ModLevel3Mask	1096	=item $modifiermask = $term->ModLevel3Mask
821		1097
822	=item $modifiermask = $term->ModMetaMask	1098	=item $modifiermask = $term->ModMetaMask
823		1099
…		…
926		1202
927	=back	1203	=back
928		1204
929	=cut	1205	=cut
930		1206
931	sub urxvt::term::line {	1207	sub line {
932	my ($self, $row) = @_;	1208	my ($self, $row) = @_;
933		1209
934	my $maxrow = $self->nrow - 1;	1210	my $maxrow = $self->nrow - 1;
935		1211
936	my ($beg, $end) = ($row, $row);	1212	my ($beg, $end) = ($row, $row);
…		…
1000	$offset / $self->{ncol} + $self->{beg},	1276	$offset / $self->{ncol} + $self->{beg},
1001	$offset % $self->{ncol}	1277	$offset % $self->{ncol}
1002	)	1278	)
1003	}	1279	}
1004		1280
1005	=item ($row, $col) = $line->coord_of ($offset)
1006	=item $text = $term->special_encode $string	1281	=item $text = $term->special_encode $string
1007		1282
1008	Converts a perl string into the special encoding used by rxvt-unicode,	1283	Converts a perl string into the special encoding used by rxvt-unicode,
1009	where one character corresponds to one screen cell. See	1284	where one character corresponds to one screen cell. See
1010	C<< $term->ROW_t >> for details.	1285	C<< $term->ROW_t >> for details.
…		…
1012	=item $string = $term->special_decode $text	1287	=item $string = $term->special_decode $text
1013		1288
1014	Converts rxvt-unicodes text reprsentation into a perl string. See	1289	Converts rxvt-unicodes text reprsentation into a perl string. See
1015	C<< $term->ROW_t >> for details.	1290	C<< $term->ROW_t >> for details.
1016		1291
		1292	=item $success = $term->grab_button ($button, $modifiermask)
		1293
		1294	Registers a synchronous button grab. See the XGrabButton manpage.
		1295
		1296	=item $success = $term->grab ($eventtime[, $sync])
		1297
		1298	Calls XGrabPointer and XGrabKeyboard in asynchronous (default) or
		1299	synchronous (C<$sync> is true). Also remembers the grab timestampe.
		1300
		1301	=item $term->allow_events_async
		1302
		1303	Calls XAllowEvents with AsyncBoth for the most recent grab.
		1304
		1305	=item $term->allow_events_sync
		1306
		1307	Calls XAllowEvents with SyncBoth for the most recent grab.
		1308
		1309	=item $term->allow_events_replay
		1310
		1311	Calls XAllowEvents with both ReplayPointer and ReplayKeyboard for the most
		1312	recent grab.
		1313
		1314	=item $term->ungrab
		1315
		1316	Calls XUngrab for the most recent grab. Is called automatically on
		1317	evaluation errors, as it is better to lose the grab in the error case as
		1318	the session.
		1319
1017	=back	1320	=back
1018		1321
		1322	=cut
		1323
		1324	package urxvt::popup;
		1325
1019	=head2 The C<urxvt::popup> Class	1326	=head2 The C<urxvt::popup> Class
1020		1327
1021	=over 4	1328	=over 4
1022		1329
1023	=cut	1330	=cut
1024
1025	package urxvt::popup;
1026		1331
1027	sub add_item {	1332	sub add_item {
1028	my ($self, $item) = @_;	1333	my ($self, $item) = @_;
1029		1334
		1335	$item->{rend}{normal} = "\x1b[0;30;47m" unless exists $item->{rend}{normal};
		1336	$item->{rend}{hover} = "\x1b[0;30;46m" unless exists $item->{rend}{hover};
		1337	$item->{rend}{active} = "\x1b[m" unless exists $item->{rend}{active};
		1338
		1339	$item->{render} \|\|= sub { $_[0]{text} };
		1340
1030	push @{ $self->{item} }, $item;	1341	push @{ $self->{item} }, $item;
1031	}	1342	}
		1343
		1344	=item $popup->add_title ($title)
		1345
		1346	Adds a non-clickable title to the popup.
		1347
		1348	=cut
		1349
		1350	sub add_title {
		1351	my ($self, $title) = @_;
		1352
		1353	$self->add_item ({
		1354	rend => { normal => "\x1b[38;5;11;44m", hover => "\x1b[38;5;11;44m", active => "\x1b[38;5;11;44m" },
		1355	text => $title,
		1356	activate => sub { },
		1357	});
		1358	}
		1359
		1360	=item $popup->add_separator ([$sepchr])
		1361
		1362	Creates a separator, optionally using the character given as C<$sepchr>.
		1363
		1364	=cut
		1365
		1366	sub add_separator {
		1367	my ($self, $sep) = @_;
		1368
		1369	$sep \|\|= "=";
		1370
		1371	$self->add_item ({
		1372	rend => { normal => "\x1b[0;30;47m", hover => "\x1b[0;30;47m", active => "\x1b[0;30;47m" },
		1373	text => "",
		1374	render => sub { $sep x $self->{term}->ncol },
		1375	activate => sub { },
		1376	});
		1377	}
		1378
		1379	=item $popup->add_button ($text, $cb)
		1380
		1381	Adds a clickable button to the popup. C<$cb> is called whenever it is
		1382	selected.
		1383
		1384	=cut
1032		1385
1033	sub add_button {	1386	sub add_button {
1034	my ($self, $text, $cb) = @_;	1387	my ($self, $text, $cb) = @_;
1035		1388
1036	$self->add_item ({ type => "button", text => "[ $text ]", activate => $cb,	1389	$self->add_item ({ type => "button", text => $text, activate => $cb});
1037	render => sub { $_[0]{text} },
1038	});
1039	}	1390	}
		1391
		1392	=item $popup->add_toggle ($text, $cb, $initial_value)
		1393
		1394	Adds a toggle/checkbox item to the popup. Teh callback gets called
		1395	whenever it gets toggled, with a boolean indicating its value as its first
		1396	argument.
		1397
		1398	=cut
1040		1399
1041	sub add_toggle {	1400	sub add_toggle {
1042	my ($self, $text, $cb, $value) = @_;	1401	my ($self, $text, $cb, $value) = @_;
1043		1402
1044	my $item; $item = {	1403	my $item; $item = {
1045	type => "button",	1404	type => "button",
1046	text => " $text",	1405	text => " $text",
1047	value => $value,	1406	value => $value,
1048	render => sub { ($item->{value} ? "✔" : " ") . $text },	1407	render => sub { ($_[0]{value} ? "* " : " ") . $text },
1049	activate => sub { $cb->($item->{value} = !$item->{value}); },	1408	activate => sub { $cb->($_[1]{value} = !$_[1]{value}); },
1050	};	1409	};
1051		1410
1052	$self->add_item ($item);	1411	$self->add_item ($item);
1053	}	1412	}
		1413
		1414	=item $popup->show
		1415
		1416	Displays the popup (which is initially hidden).
		1417
		1418	=cut
1054		1419
1055	sub show {	1420	sub show {
1056	my ($self) = @_;	1421	my ($self) = @_;
1057		1422
1058	local $urxvt::popup::self = $self;	1423	local $urxvt::popup::self = $self;
1059		1424
		1425	my $env = $self->{term}->env;
		1426	# we can't hope to reproduce the locale algorithm, so nuke LC_ALL and set LC_CTYPE.
		1427	delete $env->{LC_ALL};
		1428	$env->{LC_CTYPE} = $self->{term}->locale;
		1429
		1430	urxvt::term->new ($env, $self->{term}->resource ("name"),
1060	urxvt->new ("--perl-lib" => "", "--perl-ext-common" => "", "-pty-fd" => -1, "-sl" => 0, "-b" => 0,	1431	"--perl-lib" => "", "--perl-ext-common" => "", "-pty-fd" => -1, "-sl" => 0, "-b" => 0,
1061	"--transient-for" => $self->{term}->parent,	1432	"--transient-for" => $self->{term}->parent,
		1433	"-display" => $self->{term}->display_id,
1062	"-pe" => "urxvt-popup")	1434	"-pe" => "urxvt-popup")
1063	or die "unable to create popup window\n";	1435	or die "unable to create popup window\n";
1064	}	1436	}
1065		1437
1066	sub DESTROY {	1438	sub DESTROY {
1067	my ($self) = @_;	1439	my ($self) = @_;
1068		1440
		1441	delete $self->{term}{_destroy}{$self};
1069	$self->{term}->ungrab;	1442	$self->{term}->ungrab;
1070	}	1443	}
		1444
		1445	=back
1071		1446
1072	=head2 The C<urxvt::timer> Class	1447	=head2 The C<urxvt::timer> Class
1073		1448
1074	This class implements timer watchers/events. Time is represented as a	1449	This class implements timer watchers/events. Time is represented as a
1075	fractional number of seconds since the epoch. Example:	1450	fractional number of seconds since the epoch. Example:
…		…
1128		1503
1129	$term->{socket} = ...	1504	$term->{socket} = ...
1130	$term->{iow} = urxvt::iow	1505	$term->{iow} = urxvt::iow
1131	->new	1506	->new
1132	->fd (fileno $term->{socket})	1507	->fd (fileno $term->{socket})
1133	->events (1) # wait for read data	1508	->events (urxvt::EVENT_READ)
1134	->start	1509	->start
1135	->cb (sub {	1510	->cb (sub {
1136	my ($iow, $revents) = @_;	1511	my ($iow, $revents) = @_;
1137	# $revents must be 1 here, no need to check	1512	# $revents must be 1 here, no need to check
1138	sysread $term->{socket}, my $buf, 8192	1513	sysread $term->{socket}, my $buf, 8192
…		…
1155		1530
1156	Set the filedescriptor (not handle) to watch.	1531	Set the filedescriptor (not handle) to watch.
1157		1532
1158	=item $iow = $iow->events ($eventmask)	1533	=item $iow = $iow->events ($eventmask)
1159		1534
1160	Set the event mask to watch. Bit #0 (value C<1>) enables watching for read	1535	Set the event mask to watch. The only allowed values are
1161	data, Bit #1 (value C<2>) enables watching for write data.	1536	C<urxvt::EVENT_READ> and C<urxvt::EVENT_WRITE>, which might be ORed
		1537	together, or C<urxvt::EVENT_NONE>.
1162		1538
1163	=item $iow = $iow->start	1539	=item $iow = $iow->start
1164		1540
1165	Start watching for requested events on the given handle.	1541	Start watching for requested events on the given handle.
1166		1542
…		…
1177	This variable controls the verbosity level of the perl extension. Higher	1553	This variable controls the verbosity level of the perl extension. Higher
1178	numbers indicate more verbose output.	1554	numbers indicate more verbose output.
1179		1555
1180	=over 4	1556	=over 4
1181		1557
1182	=item =0 - only fatal messages	1558	=item == 0 - fatal messages
1183		1559
1184	=item =3 - script loading and management	1560	=item >= 3 - script loading and management
1185		1561
1186	=item =10 - all events received	1562	=item >=10 - all events received
1187		1563
1188	=back	1564	=back
1189		1565
1190	=head1 AUTHOR	1566	=head1 AUTHOR
1191		1567

Diff Legend

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

Comparing rxvt-unicode/src/urxvt.pm (file contents): Revision 1.50 by root, Sun Jan 8 00:11:38 2006 UTC vs. Revision 1.78 by root, Wed Jan 11 01:01:52 2006 UTC

Diff Legend

Comparing rxvt-unicode/src/urxvt.pm (file contents):
Revision 1.50 by root, Sun Jan 8 00:11:38 2006 UTC vs.
Revision 1.78 by root, Wed Jan 11 01:01:52 2006 UTC