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

Comparing rxvt-unicode/src/urxvt.pm (file contents):
Revision 1.60 by root, Mon Jan 9 01:21:43 2006 UTC vs.
Revision 1.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
…		…
64	runtime.	64	runtime.
65		65
66	=item selection-popup (enabled by default)	66	=item selection-popup (enabled by default)
67		67
68	Binds a popup menu to Ctrl-Button3 that lets you convert the selection	68	Binds a popup menu to Ctrl-Button3 that lets you convert the selection
69	text into various other formats/action.	69	text into various other formats/action (such as uri unescaping, perl
		70	evalution, web-browser starting etc.), depending on content.
		71
		72	=item searchable-scrollback<hotkey> (enabled by default)
		73
		74	Adds regex search functionality to the scrollback buffer, triggered
		75	by a hotkey (default: C<M-s>). When in search mode, normal terminal
		76	input/output is suspended.
		77
		78	C</> starts an incremental regex search, C<n> searches further, C<p> or
		79	C<N> jump to the previous match, C<G> jumps to the bottom and clears the
		80	history, C<enter> leaves search mode at the current position and C<escape>
		81	returns to the original position.
70		82
71	=item digital-clock	83	=item digital-clock
72		84
73	Displays a digital clock using the built-in overlay.	85	Displays a digital clock using the built-in overlay.
74		86
…		…
87	Displays a very simple digital clock in the upper right corner of the	99	Displays a very simple digital clock in the upper right corner of the
88	window. Illustrates overwriting the refresh callbacks to create your own	100	window. Illustrates overwriting the refresh callbacks to create your own
89	overlays or changes.	101	overlays or changes.
90		102
91	=back	103	=back
		104
		105	=head1 API DOCUMENTATION
92		106
93	=head2 General API Considerations	107	=head2 General API Considerations
94		108
95	All objects (such as terminals, time watchers etc.) are typical	109	All objects (such as terminals, time watchers etc.) are typical
96	reference-to-hash objects. The hash can be used to store anything you	110	reference-to-hash objects. The hash can be used to store anything you
…		…
109	=over 4	123	=over 4
110		124
111	=item $text	125	=item $text
112		126
113	Rxvt-unicodes special way of encoding text, where one "unicode" character	127	Rxvt-unicodes special way of encoding text, where one "unicode" character
114	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.
115		129
116	=item $string	130	=item $string
117		131
118	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
119	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
…		…
124	Either binary data or - more common - a text string encoded in a	138	Either binary data or - more common - a text string encoded in a
125	locale-specific way.	139	locale-specific way.
126		140
127	=back	141	=back
128		142
		143	=head2 Extension Objects
		144
		145	Very perl extension is a perl class. A separate perl object is created
		146	for each terminal and each extension and passed as the first parameter to
		147	hooks. So extensions can use their C<$self> object without having to think
		148	about other extensions, with the exception of methods and members that
		149	begin with an underscore character C<_>: these are reserved for internal
		150	use.
		151
		152	Although it isn't a C<urxvt::term> object, you can call all methods of the
		153	C<urxvt::term> class on this object.
		154
		155	It has the following methods and data members:
		156
		157	=over 4
		158
		159	=item $urxvt_term = $self->{term}
		160
		161	Returns the C<urxvt::term> object associated with this instance of the
		162	extension. This member I<must not> be changed in any way.
		163
		164	=item $self->enable ($hook_name => $cb, [$hook_name => $cb..])
		165
		166	Dynamically enable the given hooks (named without the C<on_> prefix) for
		167	this extension, replacing any previous hook. This is useful when you want
		168	to overwrite time-critical hooks only temporarily.
		169
		170	=item $self->disable ($hook_name[, $hook_name..])
		171
		172	Dynamically disable the given hooks.
		173
		174	=back
		175
129	=head2 Hooks	176	=head2 Hooks
130		177
131	The following subroutines can be declared in extension files, and will be	178	The following subroutines can be declared in extension files, and will be
132	called whenever the relevant event happens.	179	called whenever the relevant event happens.
133		180
134	The first argument passed to them is an object private to each terminal	181	The first argument passed to them is an extension oject as described in
135	and extension package. You can call all C<urxvt::term> methods on it, but	182	the in the C<Extension Objects> section.
136	its not a real C<urxvt::term> object. Instead, the real C<urxvt::term>
137	object that is shared between all packages is stored in the C<term>
138	member. It is, however, blessed intot he package of the extension script,
139	so for all practical purposes you can treat an extension script as a class.
140		183
141	All of them must return a boolean value. If it is true, then the event	184	B<All> of these hooks must return a boolean value. If it is true, then the
142	counts as being I<consumed>, and the invocation of other hooks is skipped,	185	event counts as being I<consumed>, and the invocation of other hooks is
143	and the relevant action might not be carried out by the C++ code.	186	skipped, and the relevant action might not be carried out by the C++ code.
144		187
145	When in doubt, return a false value (preferably C<()>).	188	I<< When in doubt, return a false value (preferably C<()>). >>
146		189
147	=over 4	190	=over 4
148		191
149	=item on_init $term	192	=item on_init $term
150		193
…		…
204	than the scroll back buffer or the terminal.	247	than the scroll back buffer or the terminal.
205		248
206	It is called before lines are scrolled out (so rows 0 .. min ($lines - 1,	249	It is called before lines are scrolled out (so rows 0 .. min ($lines - 1,
207	$nrow - 1) represent the lines to be scrolled out). C<$saved> is the total	250	$nrow - 1) represent the lines to be scrolled out). C<$saved> is the total
208	number of lines that will be in the scrollback buffer.	251	number of lines that will be in the scrollback buffer.
209
210	=item on_tty_activity $term NYI
211
212	Called whenever the program(s) running in the urxvt window send output.
213		252
214	=item on_osc_seq $term, $string	253	=item on_osc_seq $term, $string
215		254
216	Called whenever the B<ESC ] 777 ; string ST> command sequence (OSC =	255	Called whenever the B<ESC ] 777 ; string ST> command sequence (OSC =
217	operating system command) is processed. Cursor position and other state	256	operating system command) is processed. Cursor position and other state
…		…
230	can filter/change and output the text yourself by returning a true value	269	can filter/change and output the text yourself by returning a true value
231	and calling C<< $term->scr_add_lines >> yourself. Please note that this	270	and calling C<< $term->scr_add_lines >> yourself. Please note that this
232	might be very slow, however, as your hook is called for B<all> text being	271	might be very slow, however, as your hook is called for B<all> text being
233	output.	272	output.
234		273
		274	=item on_tt_write $term, $octets
		275
		276	Called whenever some data is written to the tty/pty and can be used to
		277	suppress or filter tty input.
		278
235	=item on_line_update $term, $row	279	=item on_line_update $term, $row
236		280
237	Called whenever a line was updated or changed. Can be used to filter	281	Called whenever a line was updated or changed. Can be used to filter
238	screen output (e.g. underline urls or other useless stuff). Only lines	282	screen output (e.g. underline urls or other useless stuff). Only lines
239	that are being shown will be filtered, and, due to performance reasons,	283	that are being shown will be filtered, and, due to performance reasons,
…		…
271	=item on_focus_out $term	315	=item on_focus_out $term
272		316
273	Called wheneever the window loses keyboard focus, before rxvt-unicode does	317	Called wheneever the window loses keyboard focus, before rxvt-unicode does
274	focus out processing.	318	focus out processing.
275		319
276	=item on_key_press $term, $event, $octets	320	=item on_key_press $term, $event, $keysym, $octets
277		321
278	=item on_key_release $term, $event	322	=item on_key_release $term, $event, $keysym
279		323
280	=item on_button_press $term, $event	324	=item on_button_press $term, $event
281		325
282	=item on_button_release $term, $event	326	=item on_button_release $term, $event
283		327
…		…
299		343
300	subwindow.	344	subwindow.
301		345
302	=back	346	=back
303		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
304	=head2 Variables in the C<urxvt> Package	369	=head2 Variables in the C<urxvt> Package
305		370
306	=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>.
307		385
308	=item $urxvt::TERM	386	=item $urxvt::TERM
309		387
310	The current terminal. This variable stores the current C<urxvt::term>	388	The current terminal. This variable stores the current C<urxvt::term>
311	object, whenever a callback/hook is executing.	389	object, whenever a callback/hook is executing.
…		…
313	=back	391	=back
314		392
315	=head2 Functions in the C<urxvt> Package	393	=head2 Functions in the C<urxvt> Package
316		394
317	=over 4	395	=over 4
318
319	=item $term = new urxvt [arg...]
320
321	Creates a new terminal, very similar as if you had started it with
322	C<system $binfile, arg...>. Croaks (and probably outputs an error message)
323	if the new instance couldn't be created. Returns C<undef> if the new
324	instance didn't initialise perl, and the terminal object otherwise. The
325	C<init> and C<start> hooks will be called during the call.
326		396
327	=item urxvt::fatal $errormessage	397	=item urxvt::fatal $errormessage
328		398
329	Fatally aborts execution with the given error message. Avoid at all	399	Fatally aborts execution with the given error message. Avoid at all
330	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
…		…
336	newline. The module also overwrites the C<warn> builtin with a function	406	newline. The module also overwrites the C<warn> builtin with a function
337	that calls this function.	407	that calls this function.
338		408
339	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
340	correct place, e.g. on stderr of the connecting urxvtc client.	410	correct place, e.g. on stderr of the connecting urxvtc client.
		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.
341		419
342	=item $time = urxvt::NOW	420	=item $time = urxvt::NOW
343		421
344	Returns the "current time" (as per the event loop).	422	Returns the "current time" (as per the event loop).
345		423
…		…
384		462
385	=item $background = urxvt::GET_BASEBG $rend	463	=item $background = urxvt::GET_BASEBG $rend
386		464
387	Return the foreground/background colour index, respectively.	465	Return the foreground/background colour index, respectively.
388		466
389	=item $rend = urxvt::SET_FGCOLOR ($rend, $new_colour)	467	=item $rend = urxvt::SET_FGCOLOR $rend, $new_colour
390		468
391	=item $rend = urxvt::SET_BGCOLOR ($rend, $new_colour)	469	=item $rend = urxvt::SET_BGCOLOR $rend, $new_colour
392		470
393	Replace the foreground/background colour in the rendition mask with the	471	Replace the foreground/background colour in the rendition mask with the
394	specified one.	472	specified one.
395		473
396	=item $value = urxvt::GET_CUSTOM ($rend)	474	=item $value = urxvt::GET_CUSTOM $rend
397		475
398	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
399	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
400	zero.	478	zero.
401		479
402	=item $rend = urxvt::SET_CUSTOM ($rend, $new_value)	480	=item $rend = urxvt::SET_CUSTOM $rend, $new_value
403		481
404	Change the custom value.	482	Change the custom value.
405		483
406	=back	484	=back
407		485
408	=cut	486	=cut
409
410	package urxvt;
411
412	use utf8;
413	use strict;
414	use Scalar::Util ();
415	use List::Util ();
416
417	our $VERSION = 1;
418	our $TERM;
419	our @HOOKNAME;
420	our %OPTION;
421	our $LIBDIR;
422		487
423	BEGIN {	488	BEGIN {
424	urxvt->bootstrap;	489	urxvt->bootstrap;
425		490
426	# overwrite perl's warn	491	# overwrite perl's warn
…		…
443	sub verbose {	508	sub verbose {
444	my ($level, $msg) = @_;	509	my ($level, $msg) = @_;
445	warn "$msg\n" if $level <= $verbosity;	510	warn "$msg\n" if $level <= $verbosity;
446	}	511	}
447		512
448	# find on_xxx subs in the package and register them
449	# as hooks
450	sub register_package($) {
451	my ($pkg) = @_;
452
453	for my $htype (0.. $#HOOKNAME) {
454	my $name = $HOOKNAME[$htype];
455
456	my $ref = $pkg->can ("on_" . lc $name)
457	or next;
458
459	$TERM->{_hook}[$htype]{$pkg} = $ref;
460	$hook_count[$htype]++
461	or set_should_invoke $htype, 1;
462	}
463	}
464
465	my $extension_pkg = "extension0000";	513	my $extension_pkg = "extension0000";
466	my %extension_pkg;	514	my %extension_pkg;
467		515
468	# load a single script into its own package, once only	516	# load a single script into its own package, once only
469	sub extension_package($) {	517	sub extension_package($) {
…		…
475	verbose 3, "loading extension '$path' into package '$pkg'";	523	verbose 3, "loading extension '$path' into package '$pkg'";
476		524
477	open my $fh, "<:raw", $path	525	open my $fh, "<:raw", $path
478	or die "$path: $!";	526	or die "$path: $!";
479		527
		528	my $source = untaint
480	my $source = untaint "package $pkg; use strict; use utf8;\n"	529	"package $pkg; use strict; use utf8;\n"
481	. "use base urxvt::term::proxy::;\n"	530	. "use base urxvt::term::extension::;\n"
482	. "#line 1 \"$path\"\n{\n"	531	. "#line 1 \"$path\"\n{\n"
483	. (do { local $/; <$fh> })	532	. (do { local $/; <$fh> })
484	. "\n};\n1";	533	. "\n};\n1";
485		534
		535	eval $source
486	eval $source or die "$path: $@";	536	or die "$path: $@";
487		537
488	$pkg	538	$pkg
489	}	539	}
490	}	540	}
491		541
…		…
497	my $htype = shift;	547	my $htype = shift;
498		548
499	if ($htype == 0) { # INIT	549	if ($htype == 0) { # INIT
500	my @dirs = ((split /:/, $TERM->resource ("perl_lib")), "$LIBDIR/perl");	550	my @dirs = ((split /:/, $TERM->resource ("perl_lib")), "$LIBDIR/perl");
501		551
502	my %want_ext;	552	my %ext_arg;
503		553
504	for (map { split /,/, $TERM->resource ("perl_ext_$_") } 1, 2) {	554	for (map { split /,/, $TERM->resource ("perl_ext_$_") } 1, 2) {
505	if ($_ eq "default") {	555	if ($_ eq "default") {
506	$want_ext{$_}++ for qw(selection option-popup selection-popup);	556	$ext_arg{$_} \|\|= [] for qw(selection option-popup selection-popup searchable-scrollback);
507	} elsif (/^-(.*)$/) {	557	} elsif (/^-(.*)$/) {
508	delete $want_ext{$1};	558	delete $ext_arg{$1};
		559	} elsif (/^([^<]+)<(.*)>$/) {
		560	push @{ $ext_arg{$1} }, $2;
509	} else {	561	} else {
510	$want_ext{$_}++;	562	$ext_arg{$_} \|\|= [];
511	}	563	}
512	}	564	}
513		565
514	for my $ext (keys %want_ext) {	566	while (my ($ext, $argv) = each %ext_arg) {
515	my @files = grep -f $_, map "$_/$ext", @dirs;	567	my @files = grep -f $_, map "$_/$ext", @dirs;
516		568
517	if (@files) {	569	if (@files) {
518	register_package extension_package $files[0];	570	$TERM->register_package (extension_package $files[0], $argv);
519	} else {	571	} else {
520	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";
521	}	573	}
522	}	574	}
523		575
…		…
532	if $verbosity >= 10;	584	if $verbosity >= 10;
533		585
534	keys %$cb;	586	keys %$cb;
535		587
536	while (my ($pkg, $cb) = each %$cb) {	588	while (my ($pkg, $cb) = each %$cb) {
537	eval {	589	$retval = eval { $cb->($TERM->{_pkg}{$pkg}, @_) }
538	$retval = $cb->(
539	$TERM->{_pkg}{$pkg} \|\|= do {
540	my $proxy = bless { }, $pkg;
541	Scalar::Util::weaken ($proxy->{term} = $TERM);
542	$proxy
543	},
544	@_,
545	) and last;	590	and last;
546	};	591
547	if ($@) {	592	if ($@) {
548	$TERM->ungrab; # better to lose the grab than the session	593	$TERM->ungrab; # better to lose the grab than the session
549	warn $@;	594	warn $@;
550	}	595	}
551	}	596	}
552	}	597	}
553		598
554	if ($htype == 1) { # DESTROY	599	if ($htype == 1) { # DESTROY
555	# remove hooks if unused
556	if (my $hook = $TERM->{_hook}) {	600	if (my $hook = delete $TERM->{_hook}) {
557	for my $htype (0..$#$hook) {	601	for my $htype (0..$#$hook) {
558	$hook_count[$htype] -= scalar keys %{ $hook->[$htype] \|\| {} }	602	$hook_count[$htype] -= scalar keys %{ $hook->[$htype] \|\| {} }
559	or set_should_invoke $htype, 0;	603	or set_should_invoke $htype, 0;
560	}	604	}
561	}	605	}
…		…
568	}	612	}
569		613
570	$retval	614	$retval
571	}	615	}
572		616
573	# urxvt::term::proxy	617	# urxvt::term::extension
574		618
575	sub urxvt::term::proxy::AUTOLOAD {	619	package urxvt::term::extension;
576	$urxvt::term::proxy::AUTOLOAD =~ /:([^:]+)$/	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 =~ /:([^:]+)$/
577	or die "FATAL: \$AUTOLOAD '$urxvt::term::proxy::AUTOLOAD' unparsable";	659	or die "FATAL: \$AUTOLOAD '$AUTOLOAD' unparsable";
578		660
579	eval qq{	661	eval qq{
580	sub $urxvt::term::proxy::AUTOLOAD {	662	sub $AUTOLOAD {
581	my \$proxy = shift;	663	my \$proxy = shift;
582	\$proxy->{term}->$1 (\@_)	664	\$proxy->{term}->$1 (\@_)
583	}	665	}
584	1	666	1
585	} or die "FATAL: unable to compile method forwarder: $@";	667	} or die "FATAL: unable to compile method forwarder: $@";
586		668
587	goto &$urxvt::term::proxy::AUTOLOAD;	669	goto &$AUTOLOAD;
588	}	670	}
589		671
590	sub urxvt::term::proxy::DESTROY {	672	sub DESTROY {
591	# nop	673	# nop
592	}	674	}
593		675
594	# urxvt::destroy_hook	676	# urxvt::destroy_hook
595		677
…		…
605		687
606	=head2 The C<urxvt::anyevent> Class	688	=head2 The C<urxvt::anyevent> Class
607		689
608	The sole purpose of this class is to deliver an interface to the	690	The sole purpose of this class is to deliver an interface to the
609	C<AnyEvent> module - any module using it will work inside urxvt without	691	C<AnyEvent> module - any module using it will work inside urxvt without
610	further work. The only exception is that you cannot wait on condition	692	further programming. The only exception is that you cannot wait on
611	variables, but non-blocking condvar use is ok. What this means is that you	693	condition variables, but non-blocking condvar use is ok. What this means
612	cannot use blocking APIs, but the non-blocking variant should work.	694	is that you cannot use blocking APIs, but the non-blocking variant should
		695	work.
613		696
614	=cut	697	=cut
615		698
616	our $VERSION = 1;	699	our $VERSION = 1;
617		700
…		…
662	${$_[0]}++;	745	${$_[0]}++;
663	}	746	}
664		747
665	sub urxvt::anyevent::condvar::wait {	748	sub urxvt::anyevent::condvar::wait {
666	unless (${$_[0]}) {	749	unless (${$_[0]}) {
667	require Carp;
668	Carp::croak ("AnyEvent->condvar blocking wait unsupported in urxvt, use a non-blocking API");	750	Carp::croak "AnyEvent->condvar blocking wait unsupported in urxvt, use a non-blocking API";
669	}	751	}
670	}	752	}
671		753
672	package urxvt::term;	754	package urxvt::term;
673		755
674	=head2 The C<urxvt::term> Class	756	=head2 The C<urxvt::term> Class
675		757
676	=over 4	758	=over 4
677		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
678	=item $term->destroy	801	=item $term->destroy
679		802
680	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.
681		806
682	=item $isset = $term->option ($optval[, $set])	807	=item $isset = $term->option ($optval[, $set])
683		808
684	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
685	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
…		…
735	my ($self, $name) = (shift, shift);	860	my ($self, $name) = (shift, shift);
736	unshift @_, $self, $name, ($name =~ s/\s\+\s(\d+)$// ? $1 : 0);	861	unshift @_, $self, $name, ($name =~ s/\s\+\s(\d+)$// ? $1 : 0);
737	&urxvt::term::_resource	862	&urxvt::term::_resource
738	}	863	}
739		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
740	=item $rend = $term->rstyle ([$new_rstyle])	870	=item $rend = $term->rstyle ([$new_rstyle])
741		871
742	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
743	the terminal application will use this style.	873	the terminal application will use this style.
744		874
…		…
763		893
764	=item $oldtext = $term->selection ([$newtext])	894	=item $oldtext = $term->selection ([$newtext])
765		895
766	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>.
767		897
768	#=item $term->overlay ($x, $y, $text)	898	=item $term->overlay_simple ($x, $y, $text)
769	#	899
770	#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.
771	#	901
772	#=cut	902	=cut
773	#	903
774	#sub urxvt::term::scr_overlay {	904	sub overlay_simple {
775	# my ($self, $x, $y, $text) = @_;	905	my ($self, $x, $y, $text) = @_;
776	#	906
777	# my @lines = split /\n/, $text;	907	my @lines = split /\n/, $text;
778	#	908
779	# my $w = 0;	909	my $w = List::Util::max map $self->strwidth ($_), @lines;
780	# for (map $self->strwidth ($_), @lines) {	910
781	# $w = $_ if $w < $_;
782	# }
783	#
784	# $self->scr_overlay_new ($x, $y, $w, scalar @lines);	911	my $overlay = $self->overlay ($x, $y, $w, scalar @lines);
785	# $self->scr_overlay_set (0, $_, $lines[$_]) for 0.. $#lines;	912	$overlay->set (0, $_, $lines[$_]) for 0.. $#lines;
786	#}	913
		914	$overlay
		915	}
787		916
788	=item $term->overlay ($x, $y, $width, $height[, $rstyle[, $border]])	917	=item $term->overlay ($x, $y, $width, $height[, $rstyle[, $border]])
789		918
790	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
791	width/height. C<$rstyle> defines the initial rendition style	920	width/height. C<$rstyle> defines the initial rendition style
…		…
858		987
859	=item $string = $term->locale_decode ($octets)	988	=item $string = $term->locale_decode ($octets)
860		989
861	Convert the given locale-encoded octets into a perl string.	990	Convert the given locale-encoded octets into a perl string.
862		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
863	=item $term->scr_add_lines ($string)	1009	=item $term->scr_add_lines ($string)
864		1010
865	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
866	running inside the terminal. It may not contain command sequences (escape	1012	running inside the terminal. It may not contain command sequences (escape
867	codes), but is free to use line feeds, carriage returns and tabs. The	1013	codes), but is free to use line feeds, carriage returns and tabs. The
…		…
881		1027
882	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
883	pass characters instead of octets, you should convert your strings first	1029	pass characters instead of octets, you should convert your strings first
884	to the locale-specific encoding using C<< $term->locale_encode >>.	1030	to the locale-specific encoding using C<< $term->locale_encode >>.
885		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
886	=item $windowid = $term->parent	1039	=item $windowid = $term->parent
887		1040
888	Return the window id of the toplevel window.	1041	Return the window id of the toplevel window.
889		1042
890	=item $windowid = $term->vt	1043	=item $windowid = $term->vt
…		…
914	=item $nrow_plus_saveLines = $term->total_rows	1067	=item $nrow_plus_saveLines = $term->total_rows
915		1068
916	=item $lines_in_scrollback = $term->nsaved	1069	=item $lines_in_scrollback = $term->nsaved
917		1070
918	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	}
919		1095
920	=item $modifiermask = $term->ModLevel3Mask	1096	=item $modifiermask = $term->ModLevel3Mask
921		1097
922	=item $modifiermask = $term->ModMetaMask	1098	=item $modifiermask = $term->ModMetaMask
923		1099
…		…
1100	$offset / $self->{ncol} + $self->{beg},	1276	$offset / $self->{ncol} + $self->{beg},
1101	$offset % $self->{ncol}	1277	$offset % $self->{ncol}
1102	)	1278	)
1103	}	1279	}
1104		1280
1105	=item ($row, $col) = $line->coord_of ($offset)
1106	=item $text = $term->special_encode $string	1281	=item $text = $term->special_encode $string
1107		1282
1108	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,
1109	where one character corresponds to one screen cell. See	1284	where one character corresponds to one screen cell. See
1110	C<< $term->ROW_t >> for details.	1285	C<< $term->ROW_t >> for details.
…		…
1112	=item $string = $term->special_decode $text	1287	=item $string = $term->special_decode $text
1113		1288
1114	Converts rxvt-unicodes text reprsentation into a perl string. See	1289	Converts rxvt-unicodes text reprsentation into a perl string. See
1115	C<< $term->ROW_t >> for details.	1290	C<< $term->ROW_t >> for details.
1116		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
1117	=back	1320	=back
1118		1321
1119	=cut	1322	=cut
1120		1323
1121	package urxvt::popup;	1324	package urxvt::popup;
…		…
1136	$item->{render} \|\|= sub { $_[0]{text} };	1339	$item->{render} \|\|= sub { $_[0]{text} };
1137		1340
1138	push @{ $self->{item} }, $item;	1341	push @{ $self->{item} }, $item;
1139	}	1342	}
1140		1343
1141	sub add_separator {	1344	=item $popup->add_title ($title)
1142	my ($self, $sep) = @_;
1143		1345
1144	$sep \|\|= "═";	1346	Adds a non-clickable title to the popup.
1145		1347
1146	$self->add_item ({	1348	=cut
1147	rend => { normal => "\x1b[0;30;47m", hover => "\x1b[0;30;47m", active => "\x1b[0;30;47m" },
1148	text => "",
1149	render => sub { $sep x $urxvt::TERM->ncol },
1150	activate => sub { },
1151	});
1152	}
1153		1349
1154	sub add_title {	1350	sub add_title {
1155	my ($self, $title) = @_;	1351	my ($self, $title) = @_;
1156		1352
1157	$self->add_item ({	1353	$self->add_item ({
…		…
1159	text => $title,	1355	text => $title,
1160	activate => sub { },	1356	activate => sub { },
1161	});	1357	});
1162	}	1358	}
1163		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
1164	sub add_button {	1386	sub add_button {
1165	my ($self, $text, $cb) = @_;	1387	my ($self, $text, $cb) = @_;
1166		1388
1167	$self->add_item ({ type => "button", text => "[ $text ]", activate => $cb});	1389	$self->add_item ({ type => "button", text => $text, activate => $cb});
1168	}	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
1169		1399
1170	sub add_toggle {	1400	sub add_toggle {
1171	my ($self, $text, $cb, $value) = @_;	1401	my ($self, $text, $cb, $value) = @_;
1172		1402
1173	my $item; $item = {	1403	my $item; $item = {
1174	type => "button",	1404	type => "button",
1175	text => " $text",	1405	text => " $text",
1176	value => $value,	1406	value => $value,
1177	render => sub { ($_[0]{value} ? "* " : " ") . $text },	1407	render => sub { ($_[0]{value} ? "* " : " ") . $text },
1178	activate => sub { $cb->($_[0]{value} = !$_[0]{value}); },	1408	activate => sub { $cb->($_[1]{value} = !$_[1]{value}); },
1179	};	1409	};
1180		1410
1181	$self->add_item ($item);	1411	$self->add_item ($item);
1182	}	1412	}
		1413
		1414	=item $popup->show
		1415
		1416	Displays the popup (which is initially hidden).
		1417
		1418	=cut
1183		1419
1184	sub show {	1420	sub show {
1185	my ($self) = @_;	1421	my ($self) = @_;
1186		1422
1187	local $urxvt::popup::self = $self;	1423	local $urxvt::popup::self = $self;
1188		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"),
1189	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,
1190	"--transient-for" => $self->{term}->parent,	1432	"--transient-for" => $self->{term}->parent,
		1433	"-display" => $self->{term}->display_id,
1191	"-pe" => "urxvt-popup")	1434	"-pe" => "urxvt-popup")
1192	or die "unable to create popup window\n";	1435	or die "unable to create popup window\n";
1193	}	1436	}
1194		1437
1195	sub DESTROY {	1438	sub DESTROY {
1196	my ($self) = @_;	1439	my ($self) = @_;
1197		1440
1198	delete $self->{term}{_destroy}{$self};	1441	delete $self->{term}{_destroy}{$self};
1199	$self->{term}->ungrab;	1442	$self->{term}->ungrab;
1200	}	1443	}
		1444
		1445	=back
1201		1446
1202	=head2 The C<urxvt::timer> Class	1447	=head2 The C<urxvt::timer> Class
1203		1448
1204	This class implements timer watchers/events. Time is represented as a	1449	This class implements timer watchers/events. Time is represented as a
1205	fractional number of seconds since the epoch. Example:	1450	fractional number of seconds since the epoch. Example:
…		…
1258		1503
1259	$term->{socket} = ...	1504	$term->{socket} = ...
1260	$term->{iow} = urxvt::iow	1505	$term->{iow} = urxvt::iow
1261	->new	1506	->new
1262	->fd (fileno $term->{socket})	1507	->fd (fileno $term->{socket})
1263	->events (1) # wait for read data	1508	->events (urxvt::EVENT_READ)
1264	->start	1509	->start
1265	->cb (sub {	1510	->cb (sub {
1266	my ($iow, $revents) = @_;	1511	my ($iow, $revents) = @_;
1267	# $revents must be 1 here, no need to check	1512	# $revents must be 1 here, no need to check
1268	sysread $term->{socket}, my $buf, 8192	1513	sysread $term->{socket}, my $buf, 8192
…		…
1285		1530
1286	Set the filedescriptor (not handle) to watch.	1531	Set the filedescriptor (not handle) to watch.
1287		1532
1288	=item $iow = $iow->events ($eventmask)	1533	=item $iow = $iow->events ($eventmask)
1289		1534
1290	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
1291	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>.
1292		1538
1293	=item $iow = $iow->start	1539	=item $iow = $iow->start
1294		1540
1295	Start watching for requested events on the given handle.	1541	Start watching for requested events on the given handle.
1296		1542

Diff Legend

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

Comparing rxvt-unicode/src/urxvt.pm (file contents): Revision 1.60 by root, Mon Jan 9 01:21:43 2006 UTC vs. Revision 1.78 by root, Wed Jan 11 01:01:52 2006 UTC

Diff Legend

Comparing rxvt-unicode/src/urxvt.pm (file contents):
Revision 1.60 by root, Mon Jan 9 01:21:43 2006 UTC vs.
Revision 1.78 by root, Wed Jan 11 01:01:52 2006 UTC