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

Comparing rxvt-unicode/src/urxvt.pm (file contents):
Revision 1.54 by root, Sun Jan 8 01:59:29 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 (enabled by default)	42	=item selection (enabled by default)
43		43
44	Intelligent selection. This extension tries to be more intelligent when	44	(More) intelligent selection. This extension tries to be more intelligent
45	the user extends selections (double-click). Right now, it tries to select	45	when the user extends selections (double-click). Right now, it tries to
46	urls and complete shell-quoted arguments, which is very convenient, too,	46	select urls and complete shell-quoted arguments, which is very convenient,
47	if your F<ls> supports C<--quoting-style=shell>.	47	too, if your F<ls> supports C<--quoting-style=shell>.
48		48
49	It also offers the following bindable event:	49	It also offers the following bindable keyboard command:
50		50
51	=over 4	51	=over 4
52		52
53	=item rot13	53	=item rot13
54		54
…		…
58		58
59	=back	59	=back
60		60
61	=item option-popup (enabled by default)	61	=item option-popup (enabled by default)
62		62
63	Binds a popup menu to Ctrl-Button3 that lets you toggle (some) options at	63	Binds a popup menu to Ctrl-Button2 that lets you toggle (some) options at
64	runtime.	64	runtime.
		65
		66	=item selection-popup (enabled by default)
		67
		68	Binds a popup menu to Ctrl-Button3 that lets you convert the selection
		69	text into various other formats/action (such as uri unescaping, perl
		70	evalution, web-browser starting etc.), depending on content.
		71
		72	=item searchable-scrollback<hotkey> (enabled by default)
		73
		74	Adds regex search functionality to the scrollback buffer, triggered
		75	by a hotkey (default: C<M-s>). When in search mode, normal terminal
		76	input/output is suspended.
		77
		78	C</> starts an incremental regex search, C<n> searches further, C<p> or
		79	C<N> jump to the previous match, C<G> jumps to the bottom and clears the
		80	history, C<enter> leaves search mode at the current position and C<escape>
		81	returns to the original position.
65		82
66	=item digital-clock	83	=item digital-clock
67		84
68	Displays a digital clock using the built-in overlay.	85	Displays a digital clock using the built-in overlay.
69		86
…		…
82	Displays a very simple digital clock in the upper right corner of the	99	Displays a very simple digital clock in the upper right corner of the
83	window. Illustrates overwriting the refresh callbacks to create your own	100	window. Illustrates overwriting the refresh callbacks to create your own
84	overlays or changes.	101	overlays or changes.
85		102
86	=back	103	=back
		104
		105	=head1 API DOCUMENTATION
87		106
88	=head2 General API Considerations	107	=head2 General API Considerations
89		108
90	All objects (such as terminals, time watchers etc.) are typical	109	All objects (such as terminals, time watchers etc.) are typical
91	reference-to-hash objects. The hash can be used to store anything you	110	reference-to-hash objects. The hash can be used to store anything you
…		…
104	=over 4	123	=over 4
105		124
106	=item $text	125	=item $text
107		126
108	Rxvt-unicodes special way of encoding text, where one "unicode" character	127	Rxvt-unicodes special way of encoding text, where one "unicode" character
109	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.
110		129
111	=item $string	130	=item $string
112		131
113	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
114	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
…		…
119	Either binary data or - more common - a text string encoded in a	138	Either binary data or - more common - a text string encoded in a
120	locale-specific way.	139	locale-specific way.
121		140
122	=back	141	=back
123		142
		143	=head2 Extension Objects
		144
		145	Very perl extension is a perl class. A separate perl object is created
		146	for each terminal and each extension and passed as the first parameter to
		147	hooks. So extensions can use their C<$self> object without having to think
		148	about other extensions, with the exception of methods and members that
		149	begin with an underscore character C<_>: these are reserved for internal
		150	use.
		151
		152	Although it isn't a C<urxvt::term> object, you can call all methods of the
		153	C<urxvt::term> class on this object.
		154
		155	It has the following methods and data members:
		156
		157	=over 4
		158
		159	=item $urxvt_term = $self->{term}
		160
		161	Returns the C<urxvt::term> object associated with this instance of the
		162	extension. This member I<must not> be changed in any way.
		163
		164	=item $self->enable ($hook_name => $cb, [$hook_name => $cb..])
		165
		166	Dynamically enable the given hooks (named without the C<on_> prefix) for
		167	this extension, replacing any previous hook. This is useful when you want
		168	to overwrite time-critical hooks only temporarily.
		169
		170	=item $self->disable ($hook_name[, $hook_name..])
		171
		172	Dynamically disable the given hooks.
		173
		174	=back
		175
124	=head2 Hooks	176	=head2 Hooks
125		177
126	The following subroutines can be declared in extension files, and will be	178	The following subroutines can be declared in extension files, and will be
127	called whenever the relevant event happens.	179	called whenever the relevant event happens.
128		180
129	The first argument passed to them is an object private to each terminal	181	The first argument passed to them is an extension oject as described in
130	and extension package. You can call all C<urxvt::term> methods on it, but	182	the in the C<Extension Objects> section.
131	its not a real C<urxvt::term> object. Instead, the real C<urxvt::term>
132	object that is shared between all packages is stored in the C<term>
133	member. It is, however, blessed intot he package of the extension script,
134	so for all practical purposes you can treat an extension script as a class.
135		183
136	All of them must return a boolean value. If it is true, then the event	184	B<All> of these hooks must return a boolean value. If it is true, then the
137	counts as being I<consumed>, and the invocation of other hooks is skipped,	185	event counts as being I<consumed>, and the invocation of other hooks is
138	and the relevant action might not be carried out by the C++ code.	186	skipped, and the relevant action might not be carried out by the C++ code.
139		187
140	When in doubt, return a false value (preferably C<()>).	188	I<< When in doubt, return a false value (preferably C<()>). >>
141		189
142	=over 4	190	=over 4
143		191
144	=item on_init $term	192	=item on_init $term
145		193
…		…
199	than the scroll back buffer or the terminal.	247	than the scroll back buffer or the terminal.
200		248
201	It is called before lines are scrolled out (so rows 0 .. min ($lines - 1,	249	It is called before lines are scrolled out (so rows 0 .. min ($lines - 1,
202	$nrow - 1) represent the lines to be scrolled out). C<$saved> is the total	250	$nrow - 1) represent the lines to be scrolled out). C<$saved> is the total
203	number of lines that will be in the scrollback buffer.	251	number of lines that will be in the scrollback buffer.
204
205	=item on_tty_activity $term NYI
206
207	Called whenever the program(s) running in the urxvt window send output.
208		252
209	=item on_osc_seq $term, $string	253	=item on_osc_seq $term, $string
210		254
211	Called whenever the B<ESC ] 777 ; string ST> command sequence (OSC =	255	Called whenever the B<ESC ] 777 ; string ST> command sequence (OSC =
212	operating system command) is processed. Cursor position and other state	256	operating system command) is processed. Cursor position and other state
…		…
225	can filter/change and output the text yourself by returning a true value	269	can filter/change and output the text yourself by returning a true value
226	and calling C<< $term->scr_add_lines >> yourself. Please note that this	270	and calling C<< $term->scr_add_lines >> yourself. Please note that this
227	might be very slow, however, as your hook is called for B<all> text being	271	might be very slow, however, as your hook is called for B<all> text being
228	output.	272	output.
229		273
		274	=item on_tt_write $term, $octets
		275
		276	Called whenever some data is written to the tty/pty and can be used to
		277	suppress or filter tty input.
		278
230	=item on_line_update $term, $row	279	=item on_line_update $term, $row
231		280
232	Called whenever a line was updated or changed. Can be used to filter	281	Called whenever a line was updated or changed. Can be used to filter
233	screen output (e.g. underline urls or other useless stuff). Only lines	282	screen output (e.g. underline urls or other useless stuff). Only lines
234	that are being shown will be filtered, and, due to performance reasons,	283	that are being shown will be filtered, and, due to performance reasons,
…		…
266	=item on_focus_out $term	315	=item on_focus_out $term
267		316
268	Called wheneever the window loses keyboard focus, before rxvt-unicode does	317	Called wheneever the window loses keyboard focus, before rxvt-unicode does
269	focus out processing.	318	focus out processing.
270		319
271	=item on_key_press $term, $event, $octets	320	=item on_key_press $term, $event, $keysym, $octets
272		321
273	=item on_key_release $term, $event	322	=item on_key_release $term, $event, $keysym
274		323
275	=item on_button_press $term, $event	324	=item on_button_press $term, $event
276		325
277	=item on_button_release $term, $event	326	=item on_button_release $term, $event
278		327
…		…
294		343
295	subwindow.	344	subwindow.
296		345
297	=back	346	=back
298		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
299	=head2 Variables in the C<urxvt> Package	369	=head2 Variables in the C<urxvt> Package
300		370
301	=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>.
302		385
303	=item $urxvt::TERM	386	=item $urxvt::TERM
304		387
305	The current terminal. This variable stores the current C<urxvt::term>	388	The current terminal. This variable stores the current C<urxvt::term>
306	object, whenever a callback/hook is executing.	389	object, whenever a callback/hook is executing.
…		…
308	=back	391	=back
309		392
310	=head2 Functions in the C<urxvt> Package	393	=head2 Functions in the C<urxvt> Package
311		394
312	=over 4	395	=over 4
313
314	=item $term = new urxvt [arg...]
315
316	Creates a new terminal, very similar as if you had started it with
317	C<system $binfile, arg...>. Croaks (and probably outputs an error message)
318	if the new instance couldn't be created. Returns C<undef> if the new
319	instance didn't initialise perl, and the terminal object otherwise. The
320	C<init> and C<start> hooks will be called during the call.
321		396
322	=item urxvt::fatal $errormessage	397	=item urxvt::fatal $errormessage
323		398
324	Fatally aborts execution with the given error message. Avoid at all	399	Fatally aborts execution with the given error message. Avoid at all
325	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
…		…
332	that calls this function.	407	that calls this function.
333		408
334	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
335	correct place, e.g. on stderr of the connecting urxvtc client.	410	correct place, e.g. on stderr of the connecting urxvtc client.
336		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
337	=item $time = urxvt::NOW	420	=item $time = urxvt::NOW
338		421
339	Returns the "current time" (as per the event loop).	422	Returns the "current time" (as per the event loop).
340		423
341	=item urxvt::CurrentTime	424	=item urxvt::CurrentTime
342		425
343	=item urxvt::ShiftMask, LockMask, ControlMask, Mod1Mask, Mod2Mask,	426	=item urxvt::ShiftMask, LockMask, ControlMask, Mod1Mask, Mod2Mask,
344	Mod3Mask, Mod4Mask, Mod5Mask, Button1Mask, Button2Mask, Button3Mask,	427	Mod3Mask, Mod4Mask, Mod5Mask, Button1Mask, Button2Mask, Button3Mask,
345	Button4Mask, Button5Mask, AnyModifier	428	Button4Mask, Button5Mask, AnyModifier
346		429
347	Various constants for use in X events.	430	Various constants for use in X calls and event processing.
348		431
349	=back	432	=back
350		433
351	=head2 RENDITION	434	=head2 RENDITION
352		435
…		…
379		462
380	=item $background = urxvt::GET_BASEBG $rend	463	=item $background = urxvt::GET_BASEBG $rend
381		464
382	Return the foreground/background colour index, respectively.	465	Return the foreground/background colour index, respectively.
383		466
384	=item $rend = urxvt::SET_FGCOLOR ($rend, $new_colour)	467	=item $rend = urxvt::SET_FGCOLOR $rend, $new_colour
385		468
386	=item $rend = urxvt::SET_BGCOLOR ($rend, $new_colour)	469	=item $rend = urxvt::SET_BGCOLOR $rend, $new_colour
387		470
388	Replace the foreground/background colour in the rendition mask with the	471	Replace the foreground/background colour in the rendition mask with the
389	specified one.	472	specified one.
390		473
391	=item $value = urxvt::GET_CUSTOM ($rend)	474	=item $value = urxvt::GET_CUSTOM $rend
392		475
393	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
394	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
395	zero.	478	zero.
396		479
397	=item $rend = urxvt::SET_CUSTOM ($rend, $new_value)	480	=item $rend = urxvt::SET_CUSTOM $rend, $new_value
398		481
399	Change the custom value.	482	Change the custom value.
400		483
401	=back	484	=back
402		485
403	=cut	486	=cut
404
405	package urxvt;
406
407	use utf8;
408	use strict;
409	use Scalar::Util ();
410	use List::Util ();
411
412	our $TERM;
413	our @HOOKNAME;
414	our %OPTION;
415	our $LIBDIR;
416		487
417	BEGIN {	488	BEGIN {
418	urxvt->bootstrap;	489	urxvt->bootstrap;
419		490
420	# overwrite perl's warn	491	# overwrite perl's warn
…		…
422	my $msg = join "", @_;	493	my $msg = join "", @_;
423	$msg .= "\n"	494	$msg .= "\n"
424	unless $msg =~ /\n$/;	495	unless $msg =~ /\n$/;
425	urxvt::warn ($msg);	496	urxvt::warn ($msg);
426	};	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";
427	}	503	}
428		504
429	my @hook_count;	505	my @hook_count;
430	my $verbosity = $ENV{URXVT_PERL_VERBOSITY};	506	my $verbosity = $ENV{URXVT_PERL_VERBOSITY};
431		507
432	sub verbose {	508	sub verbose {
433	my ($level, $msg) = @_;	509	my ($level, $msg) = @_;
434	warn "$msg\n" if $level <= $verbosity;	510	warn "$msg\n" if $level <= $verbosity;
435	}	511	}
436		512
437	# find on_xxx subs in the package and register them
438	# as hooks
439	sub register_package($) {
440	my ($pkg) = @_;
441
442	for my $htype (0.. $#HOOKNAME) {
443	my $name = $HOOKNAME[$htype];
444
445	my $ref = $pkg->can ("on_" . lc $name)
446	or next;
447
448	$TERM->{_hook}[$htype]{$pkg} = $ref;
449	$hook_count[$htype]++
450	or set_should_invoke $htype, 1;
451	}
452	}
453
454	my $extension_pkg = "extension0000";	513	my $extension_pkg = "extension0000";
455	my %extension_pkg;	514	my %extension_pkg;
456		515
457	# load a single script into its own package, once only	516	# load a single script into its own package, once only
458	sub extension_package($) {	517	sub extension_package($) {
…		…
464	verbose 3, "loading extension '$path' into package '$pkg'";	523	verbose 3, "loading extension '$path' into package '$pkg'";
465		524
466	open my $fh, "<:raw", $path	525	open my $fh, "<:raw", $path
467	or die "$path: $!";	526	or die "$path: $!";
468		527
		528	my $source = untaint
469	my $source = "package $pkg; use strict; use utf8;\n"	529	"package $pkg; use strict; use utf8;\n"
470	. "use base urxvt::term::proxy::;\n"	530	. "use base urxvt::term::extension::;\n"
471	. "#line 1 \"$path\"\n{\n"	531	. "#line 1 \"$path\"\n{\n"
472	. (do { local $/; <$fh> })	532	. (do { local $/; <$fh> })
473	. "\n};\n1";	533	. "\n};\n1";
474		534
		535	eval $source
475	eval $source or die "$path: $@";	536	or die "$path: $@";
476		537
477	$pkg	538	$pkg
478	}	539	}
479	}	540	}
480		541
…		…
486	my $htype = shift;	547	my $htype = shift;
487		548
488	if ($htype == 0) { # INIT	549	if ($htype == 0) { # INIT
489	my @dirs = ((split /:/, $TERM->resource ("perl_lib")), "$LIBDIR/perl");	550	my @dirs = ((split /:/, $TERM->resource ("perl_lib")), "$LIBDIR/perl");
490		551
491	my %want_ext;	552	my %ext_arg;
492		553
493	for (map { split /,/, $TERM->resource ("perl_ext_$_") } 1, 2) {	554	for (map { split /,/, $TERM->resource ("perl_ext_$_") } 1, 2) {
494	if ($_ eq "default") {	555	if ($_ eq "default") {
495	$want_ext{$_}++ for qw(selection option-popup);	556	$ext_arg{$_} \|\|= [] for qw(selection option-popup selection-popup searchable-scrollback);
496	} elsif (/^-(.*)$/) {	557	} elsif (/^-(.*)$/) {
497	delete $want_ext{$1};	558	delete $ext_arg{$1};
		559	} elsif (/^([^<]+)<(.*)>$/) {
		560	push @{ $ext_arg{$1} }, $2;
498	} else {	561	} else {
499	$want_ext{$_}++;	562	$ext_arg{$_} \|\|= [];
500	}	563	}
501	}	564	}
502		565
503	for my $ext (keys %want_ext) {	566	while (my ($ext, $argv) = each %ext_arg) {
504	my @files = grep -f $_, map "$_/$ext", @dirs;	567	my @files = grep -f $_, map "$_/$ext", @dirs;
505		568
506	if (@files) {	569	if (@files) {
507	register_package extension_package $files[0];	570	$TERM->register_package (extension_package $files[0], $argv);
508	} else {	571	} else {
509	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";
510	}	573	}
511	}	574	}
		575
		576	eval "#line 1 \"--perl-eval resource/argument\"\n" . $TERM->resource ("perl_eval");
		577	warn $@ if $@;
512	}	578	}
513		579
514	$retval = undef;	580	$retval = undef;
515		581
516	if (my $cb = $TERM->{_hook}[$htype]) {	582	if (my $cb = $TERM->{_hook}[$htype]) {
…		…
518	if $verbosity >= 10;	584	if $verbosity >= 10;
519		585
520	keys %$cb;	586	keys %$cb;
521		587
522	while (my ($pkg, $cb) = each %$cb) {	588	while (my ($pkg, $cb) = each %$cb) {
523	eval {	589	$retval = eval { $cb->($TERM->{_pkg}{$pkg}, @_) }
524	$retval = $cb->(
525	$TERM->{_pkg}{$pkg} \|\|= do {
526	my $proxy = bless { }, $pkg;
527	Scalar::Util::weaken ($proxy->{term} = $TERM);
528	$proxy
529	},
530	@_,
531	) and last;	590	and last;
		591
		592	if ($@) {
		593	$TERM->ungrab; # better to lose the grab than the session
		594	warn $@;
532	};	595	}
533	warn $@ if $@;#d#
534	}	596	}
535	}	597	}
536		598
537	if ($htype == 1) { # DESTROY	599	if ($htype == 1) { # DESTROY
538	# remove hooks if unused
539	if (my $hook = $TERM->{_hook}) {	600	if (my $hook = delete $TERM->{_hook}) {
540	for my $htype (0..$#$hook) {	601	for my $htype (0..$#$hook) {
541	$hook_count[$htype] -= scalar keys %{ $hook->[$htype] \|\| {} }	602	$hook_count[$htype] -= scalar keys %{ $hook->[$htype] \|\| {} }
542	or set_should_invoke $htype, 0;	603	or set_should_invoke $htype, 0;
543	}	604	}
544	}	605	}
…		…
551	}	612	}
552		613
553	$retval	614	$retval
554	}	615	}
555		616
556	sub urxvt::term::proxy::AUTOLOAD {	617	# urxvt::term::extension
557	$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 =~ /:([^:]+)$/
558	or die "FATAL: \$AUTOLOAD '$urxvt::term::proxy::AUTOLOAD' unparsable";	659	or die "FATAL: \$AUTOLOAD '$AUTOLOAD' unparsable";
559		660
560	eval qq{	661	eval qq{
561	sub $urxvt::term::proxy::AUTOLOAD {	662	sub $AUTOLOAD {
562	my \$proxy = shift;	663	my \$proxy = shift;
563	\$proxy->{term}->$1 (\@_)	664	\$proxy->{term}->$1 (\@_)
564	}	665	}
565	1	666	1
566	} or die "FATAL: unable to compile method forwarder: $@";	667	} or die "FATAL: unable to compile method forwarder: $@";
567		668
568	goto &$urxvt::term::proxy::AUTOLOAD;	669	goto &$AUTOLOAD;
569	}	670	}
		671
		672	sub DESTROY {
		673	# nop
		674	}
		675
		676	# urxvt::destroy_hook
570		677
571	sub urxvt::destroy_hook::DESTROY {	678	sub urxvt::destroy_hook::DESTROY {
572	${$_[0]}->();	679	${$_[0]}->();
573	}	680	}
574		681
575	sub urxvt::destroy_hook(&) {	682	sub urxvt::destroy_hook(&) {
576	bless \shift, urxvt::destroy_hook::	683	bless \shift, urxvt::destroy_hook::
577	}	684	}
578		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
579	=head2 The C<urxvt::term> Class	756	=head2 The C<urxvt::term> Class
580		757
581	=over 4	758	=over 4
582		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
583	=item $term->destroy	801	=item $term->destroy
584		802
585	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.
586		806
587	=item $isset = $term->option ($optval[, $set])	807	=item $isset = $term->option ($optval[, $set])
588		808
589	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
590	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
…		…
634	shade term_name title transparent transparent_all tripleclickwords	854	shade term_name title transparent transparent_all tripleclickwords
635	utmpInhibit visualBell	855	utmpInhibit visualBell
636		856
637	=cut	857	=cut
638		858
639	sub urxvt::term::resource($$;$) {	859	sub resource($$;$) {
640	my ($self, $name) = (shift, shift);	860	my ($self, $name) = (shift, shift);
641	unshift @_, $self, $name, ($name =~ s/\s\+\s(\d+)$// ? $1 : 0);	861	unshift @_, $self, $name, ($name =~ s/\s\+\s(\d+)$// ? $1 : 0);
642	&urxvt::term::_resource	862	&urxvt::term::_resource
643	}	863	}
644		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
645	=item $rend = $term->rstyle ([$new_rstyle])	870	=item $rend = $term->rstyle ([$new_rstyle])
646		871
647	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
648	the terminal application will use this style.	873	the terminal application will use this style.
649		874
…		…
668		893
669	=item $oldtext = $term->selection ([$newtext])	894	=item $oldtext = $term->selection ([$newtext])
670		895
671	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>.
672		897
673	#=item $term->overlay ($x, $y, $text)	898	=item $term->overlay_simple ($x, $y, $text)
674	#	899
675	#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.
676	#	901
677	#=cut	902	=cut
678	#	903
679	#sub urxvt::term::scr_overlay {	904	sub overlay_simple {
680	# my ($self, $x, $y, $text) = @_;	905	my ($self, $x, $y, $text) = @_;
681	#	906
682	# my @lines = split /\n/, $text;	907	my @lines = split /\n/, $text;
683	#	908
684	# my $w = 0;	909	my $w = List::Util::max map $self->strwidth ($_), @lines;
685	# for (map $self->strwidth ($_), @lines) {	910
686	# $w = $_ if $w < $_;
687	# }
688	#
689	# $self->scr_overlay_new ($x, $y, $w, scalar @lines);	911	my $overlay = $self->overlay ($x, $y, $w, scalar @lines);
690	# $self->scr_overlay_set (0, $_, $lines[$_]) for 0.. $#lines;	912	$overlay->set (0, $_, $lines[$_]) for 0.. $#lines;
691	#}	913
		914	$overlay
		915	}
692		916
693	=item $term->overlay ($x, $y, $width, $height[, $rstyle[, $border]])	917	=item $term->overlay ($x, $y, $width, $height[, $rstyle[, $border]])
694		918
695	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
696	width/height. C<$rstyle> defines the initial rendition style	920	width/height. C<$rstyle> defines the initial rendition style
…		…
731	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,
732	currently).	956	currently).
733		957
734	=cut	958	=cut
735		959
736	sub urxvt::term::popup {	960	sub popup {
737	my ($self, $event) = @_;	961	my ($self, $event) = @_;
738		962
739	$self->grab ($event->{time}, 1)	963	$self->grab ($event->{time}, 1)
740	or return;	964	or return;
741		965
…		…
763		987
764	=item $string = $term->locale_decode ($octets)	988	=item $string = $term->locale_decode ($octets)
765		989
766	Convert the given locale-encoded octets into a perl string.	990	Convert the given locale-encoded octets into a perl string.
767		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
768	=item $term->scr_add_lines ($string)	1009	=item $term->scr_add_lines ($string)
769		1010
770	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
771	running inside the terminal. It may not contain command sequences (escape	1012	running inside the terminal. It may not contain command sequences (escape
772	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
…		…
786		1027
787	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
788	pass characters instead of octets, you should convert your strings first	1029	pass characters instead of octets, you should convert your strings first
789	to the locale-specific encoding using C<< $term->locale_encode >>.	1030	to the locale-specific encoding using C<< $term->locale_encode >>.
790		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
791	=item $windowid = $term->parent	1039	=item $windowid = $term->parent
792		1040
793	Return the window id of the toplevel window.	1041	Return the window id of the toplevel window.
794		1042
795	=item $windowid = $term->vt	1043	=item $windowid = $term->vt
…		…
819	=item $nrow_plus_saveLines = $term->total_rows	1067	=item $nrow_plus_saveLines = $term->total_rows
820		1068
821	=item $lines_in_scrollback = $term->nsaved	1069	=item $lines_in_scrollback = $term->nsaved
822		1070
823	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	}
824		1095
825	=item $modifiermask = $term->ModLevel3Mask	1096	=item $modifiermask = $term->ModLevel3Mask
826		1097
827	=item $modifiermask = $term->ModMetaMask	1098	=item $modifiermask = $term->ModMetaMask
828		1099
…		…
931		1202
932	=back	1203	=back
933		1204
934	=cut	1205	=cut
935		1206
936	sub urxvt::term::line {	1207	sub line {
937	my ($self, $row) = @_;	1208	my ($self, $row) = @_;
938		1209
939	my $maxrow = $self->nrow - 1;	1210	my $maxrow = $self->nrow - 1;
940		1211
941	my ($beg, $end) = ($row, $row);	1212	my ($beg, $end) = ($row, $row);
…		…
1005	$offset / $self->{ncol} + $self->{beg},	1276	$offset / $self->{ncol} + $self->{beg},
1006	$offset % $self->{ncol}	1277	$offset % $self->{ncol}
1007	)	1278	)
1008	}	1279	}
1009		1280
1010	=item ($row, $col) = $line->coord_of ($offset)
1011	=item $text = $term->special_encode $string	1281	=item $text = $term->special_encode $string
1012		1282
1013	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,
1014	where one character corresponds to one screen cell. See	1284	where one character corresponds to one screen cell. See
1015	C<< $term->ROW_t >> for details.	1285	C<< $term->ROW_t >> for details.
…		…
1017	=item $string = $term->special_decode $text	1287	=item $string = $term->special_decode $text
1018		1288
1019	Converts rxvt-unicodes text reprsentation into a perl string. See	1289	Converts rxvt-unicodes text reprsentation into a perl string. See
1020	C<< $term->ROW_t >> for details.	1290	C<< $term->ROW_t >> for details.
1021		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
1022	=back	1320	=back
1023		1321
		1322	=cut
		1323
		1324	package urxvt::popup;
		1325
1024	=head2 The C<urxvt::popup> Class	1326	=head2 The C<urxvt::popup> Class
1025		1327
1026	=over 4	1328	=over 4
1027		1329
1028	=cut	1330	=cut
1029
1030	package urxvt::popup;
1031		1331
1032	sub add_item {	1332	sub add_item {
1033	my ($self, $item) = @_;	1333	my ($self, $item) = @_;
1034		1334
1035	$item->{rend}{normal} = "\x1b[0;30;47m" unless exists $item->{rend}{normal};	1335	$item->{rend}{normal} = "\x1b[0;30;47m" unless exists $item->{rend}{normal};
…		…
1039	$item->{render} \|\|= sub { $_[0]{text} };	1339	$item->{render} \|\|= sub { $_[0]{text} };
1040		1340
1041	push @{ $self->{item} }, $item;	1341	push @{ $self->{item} }, $item;
1042	}	1342	}
1043		1343
1044	sub add_separator {	1344	=item $popup->add_title ($title)
1045	my ($self, $sep) = @_;
1046		1345
1047	$sep \|\|= "═";	1346	Adds a non-clickable title to the popup.
1048		1347
1049	$self->add_item ({	1348	=cut
1050	rend => { normal => "\x1b[0;30;47m", hover => "\x1b[0;30;47m", active => "\x1b[0;30;47m" },
1051	text => "",
1052	render => sub { $sep x $urxvt::TERM->ncol },
1053	activate => sub { },
1054	});
1055	}
1056		1349
1057	sub add_title {	1350	sub add_title {
1058	my ($self, $title) = @_;	1351	my ($self, $title) = @_;
1059		1352
1060	$self->add_item ({	1353	$self->add_item ({
…		…
1062	text => $title,	1355	text => $title,
1063	activate => sub { },	1356	activate => sub { },
1064	});	1357	});
1065	}	1358	}
1066		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
		1385
1067	sub add_button {	1386	sub add_button {
1068	my ($self, $text, $cb) = @_;	1387	my ($self, $text, $cb) = @_;
1069		1388
1070	$self->add_item ({ type => "button", text => "[ $text ]", activate => $cb});	1389	$self->add_item ({ type => "button", text => $text, activate => $cb});
1071	}	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
1072		1399
1073	sub add_toggle {	1400	sub add_toggle {
1074	my ($self, $text, $cb, $value) = @_;	1401	my ($self, $text, $cb, $value) = @_;
1075		1402
1076	my $item; $item = {	1403	my $item; $item = {
1077	type => "button",	1404	type => "button",
1078	text => " $text",	1405	text => " $text",
1079	value => $value,	1406	value => $value,
1080	render => sub { ($item->{value} ? "* " : " ") . $text },	1407	render => sub { ($_[0]{value} ? "* " : " ") . $text },
1081	activate => sub { $cb->($item->{value} = !$item->{value}); },	1408	activate => sub { $cb->($_[1]{value} = !$_[1]{value}); },
1082	};	1409	};
1083		1410
1084	$self->add_item ($item);	1411	$self->add_item ($item);
1085	}	1412	}
		1413
		1414	=item $popup->show
		1415
		1416	Displays the popup (which is initially hidden).
		1417
		1418	=cut
1086		1419
1087	sub show {	1420	sub show {
1088	my ($self) = @_;	1421	my ($self) = @_;
1089		1422
1090	local $urxvt::popup::self = $self;	1423	local $urxvt::popup::self = $self;
1091		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"),
1092	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,
1093	"--transient-for" => $self->{term}->parent,	1432	"--transient-for" => $self->{term}->parent,
		1433	"-display" => $self->{term}->display_id,
1094	"-pe" => "urxvt-popup")	1434	"-pe" => "urxvt-popup")
1095	or die "unable to create popup window\n";	1435	or die "unable to create popup window\n";
1096	}	1436	}
1097		1437
1098	sub DESTROY {	1438	sub DESTROY {
1099	my ($self) = @_;	1439	my ($self) = @_;
1100		1440
		1441	delete $self->{term}{_destroy}{$self};
1101	$self->{term}->ungrab;	1442	$self->{term}->ungrab;
1102	}	1443	}
		1444
		1445	=back
1103		1446
1104	=head2 The C<urxvt::timer> Class	1447	=head2 The C<urxvt::timer> Class
1105		1448
1106	This class implements timer watchers/events. Time is represented as a	1449	This class implements timer watchers/events. Time is represented as a
1107	fractional number of seconds since the epoch. Example:	1450	fractional number of seconds since the epoch. Example:
…		…
1160		1503
1161	$term->{socket} = ...	1504	$term->{socket} = ...
1162	$term->{iow} = urxvt::iow	1505	$term->{iow} = urxvt::iow
1163	->new	1506	->new
1164	->fd (fileno $term->{socket})	1507	->fd (fileno $term->{socket})
1165	->events (1) # wait for read data	1508	->events (urxvt::EVENT_READ)
1166	->start	1509	->start
1167	->cb (sub {	1510	->cb (sub {
1168	my ($iow, $revents) = @_;	1511	my ($iow, $revents) = @_;
1169	# $revents must be 1 here, no need to check	1512	# $revents must be 1 here, no need to check
1170	sysread $term->{socket}, my $buf, 8192	1513	sysread $term->{socket}, my $buf, 8192
…		…
1187		1530
1188	Set the filedescriptor (not handle) to watch.	1531	Set the filedescriptor (not handle) to watch.
1189		1532
1190	=item $iow = $iow->events ($eventmask)	1533	=item $iow = $iow->events ($eventmask)
1191		1534
1192	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
1193	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>.
1194		1538
1195	=item $iow = $iow->start	1539	=item $iow = $iow->start
1196		1540
1197	Start watching for requested events on the given handle.	1541	Start watching for requested events on the given handle.
1198		1542
…		…
1209	This variable controls the verbosity level of the perl extension. Higher	1553	This variable controls the verbosity level of the perl extension. Higher
1210	numbers indicate more verbose output.	1554	numbers indicate more verbose output.
1211		1555
1212	=over 4	1556	=over 4
1213		1557
1214	=item =0 - only fatal messages	1558	=item == 0 - fatal messages
1215		1559
1216	=item =3 - script loading and management	1560	=item >= 3 - script loading and management
1217		1561
1218	=item =10 - all events received	1562	=item >=10 - all events received
1219		1563
1220	=back	1564	=back
1221		1565
1222	=head1 AUTHOR	1566	=head1 AUTHOR
1223		1567

Diff Legend

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

Comparing rxvt-unicode/src/urxvt.pm (file contents): Revision 1.54 by root, Sun Jan 8 01:59:29 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.54 by root, Sun Jan 8 01:59:29 2006 UTC vs.
Revision 1.78 by root, Wed Jan 11 01:01:52 2006 UTC