[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.77 by root, Wed Jan 11 00:59:58 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
…		…
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.
312		390
		391	=item
		392
313	=back	393	=back
314		394
315	=head2 Functions in the C<urxvt> Package	395	=head2 Functions in the C<urxvt> Package
316		396
317	=over 4	397	=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		398
327	=item urxvt::fatal $errormessage	399	=item urxvt::fatal $errormessage
328		400
329	Fatally aborts execution with the given error message. Avoid at all	401	Fatally aborts execution with the given error message. Avoid at all
330	costs! The only time this is acceptable is when the terminal process	402	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	408	newline. The module also overwrites the C<warn> builtin with a function
337	that calls this function.	409	that calls this function.
338		410
339	Using this function has the advantage that its output ends up in the	411	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.	412	correct place, e.g. on stderr of the connecting urxvtc client.
		413
		414	Messages have a size limit of 1023 bytes currently.
		415
		416	=item $is_safe = urxvt::safe
		417
		418	Returns true when it is safe to do potentially unsafe things, such as
		419	evaluating perl code specified by the user. This is true when urxvt was
		420	started setuid or setgid.
341		421
342	=item $time = urxvt::NOW	422	=item $time = urxvt::NOW
343		423
344	Returns the "current time" (as per the event loop).	424	Returns the "current time" (as per the event loop).
345		425
…		…
384		464
385	=item $background = urxvt::GET_BASEBG $rend	465	=item $background = urxvt::GET_BASEBG $rend
386		466
387	Return the foreground/background colour index, respectively.	467	Return the foreground/background colour index, respectively.
388		468
389	=item $rend = urxvt::SET_FGCOLOR ($rend, $new_colour)	469	=item $rend = urxvt::SET_FGCOLOR $rend, $new_colour
390		470
391	=item $rend = urxvt::SET_BGCOLOR ($rend, $new_colour)	471	=item $rend = urxvt::SET_BGCOLOR $rend, $new_colour
392		472
393	Replace the foreground/background colour in the rendition mask with the	473	Replace the foreground/background colour in the rendition mask with the
394	specified one.	474	specified one.
395		475
396	=item $value = urxvt::GET_CUSTOM ($rend)	476	=item $value = urxvt::GET_CUSTOM $rend
397		477
398	Return the "custom" value: Every rendition has 5 bits for use by	478	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	479	extensions. They can be set and changed as you like and are initially
400	zero.	480	zero.
401		481
402	=item $rend = urxvt::SET_CUSTOM ($rend, $new_value)	482	=item $rend = urxvt::SET_CUSTOM $rend, $new_value
403		483
404	Change the custom value.	484	Change the custom value.
405		485
406	=back	486	=back
407		487
408	=cut	488	=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		489
423	BEGIN {	490	BEGIN {
424	urxvt->bootstrap;	491	urxvt->bootstrap;
425		492
426	# overwrite perl's warn	493	# overwrite perl's warn
…		…
443	sub verbose {	510	sub verbose {
444	my ($level, $msg) = @_;	511	my ($level, $msg) = @_;
445	warn "$msg\n" if $level <= $verbosity;	512	warn "$msg\n" if $level <= $verbosity;
446	}	513	}
447		514
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";	515	my $extension_pkg = "extension0000";
466	my %extension_pkg;	516	my %extension_pkg;
467		517
468	# load a single script into its own package, once only	518	# load a single script into its own package, once only
469	sub extension_package($) {	519	sub extension_package($) {
…		…
475	verbose 3, "loading extension '$path' into package '$pkg'";	525	verbose 3, "loading extension '$path' into package '$pkg'";
476		526
477	open my $fh, "<:raw", $path	527	open my $fh, "<:raw", $path
478	or die "$path: $!";	528	or die "$path: $!";
479		529
		530	my $source = untaint
480	my $source = untaint "package $pkg; use strict; use utf8;\n"	531	"package $pkg; use strict; use utf8;\n"
481	. "use base urxvt::term::proxy::;\n"	532	. "use base urxvt::term::extension::;\n"
482	. "#line 1 \"$path\"\n{\n"	533	. "#line 1 \"$path\"\n{\n"
483	. (do { local $/; <$fh> })	534	. (do { local $/; <$fh> })
484	. "\n};\n1";	535	. "\n};\n1";
485		536
		537	eval $source
486	eval $source or die "$path: $@";	538	or die "$path: $@";
487		539
488	$pkg	540	$pkg
489	}	541	}
490	}	542	}
491		543
…		…
497	my $htype = shift;	549	my $htype = shift;
498		550
499	if ($htype == 0) { # INIT	551	if ($htype == 0) { # INIT
500	my @dirs = ((split /:/, $TERM->resource ("perl_lib")), "$LIBDIR/perl");	552	my @dirs = ((split /:/, $TERM->resource ("perl_lib")), "$LIBDIR/perl");
501		553
502	my %want_ext;	554	my %ext_arg;
503		555
504	for (map { split /,/, $TERM->resource ("perl_ext_$_") } 1, 2) {	556	for (map { split /,/, $TERM->resource ("perl_ext_$_") } 1, 2) {
505	if ($_ eq "default") {	557	if ($_ eq "default") {
506	$want_ext{$_}++ for qw(selection option-popup selection-popup);	558	$ext_arg{$_} \|\|= [] for qw(selection option-popup selection-popup searchable-scrollback);
507	} elsif (/^-(.*)$/) {	559	} elsif (/^-(.*)$/) {
508	delete $want_ext{$1};	560	delete $ext_arg{$1};
		561	} elsif (/^([^<]+)<(.*)>$/) {
		562	push @{ $ext_arg{$1} }, $2;
509	} else {	563	} else {
510	$want_ext{$_}++;	564	$ext_arg{$_} \|\|= [];
511	}	565	}
512	}	566	}
513		567
514	for my $ext (keys %want_ext) {	568	while (my ($ext, $argv) = each %ext_arg) {
515	my @files = grep -f $_, map "$_/$ext", @dirs;	569	my @files = grep -f $_, map "$_/$ext", @dirs;
516		570
517	if (@files) {	571	if (@files) {
518	register_package extension_package $files[0];	572	$TERM->register_package (extension_package $files[0], $argv);
519	} else {	573	} else {
520	warn "perl extension '$ext' not found in perl library search path\n";	574	warn "perl extension '$ext' not found in perl library search path\n";
521	}	575	}
522	}	576	}
523		577
…		…
532	if $verbosity >= 10;	586	if $verbosity >= 10;
533		587
534	keys %$cb;	588	keys %$cb;
535		589
536	while (my ($pkg, $cb) = each %$cb) {	590	while (my ($pkg, $cb) = each %$cb) {
537	eval {	591	$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;	592	and last;
546	};	593
547	if ($@) {	594	if ($@) {
548	$TERM->ungrab; # better to lose the grab than the session	595	$TERM->ungrab; # better to lose the grab than the session
549	warn $@;	596	warn $@;
550	}	597	}
551	}	598	}
552	}	599	}
553		600
554	if ($htype == 1) { # DESTROY	601	if ($htype == 1) { # DESTROY
555	# remove hooks if unused
556	if (my $hook = $TERM->{_hook}) {	602	if (my $hook = delete $TERM->{_hook}) {
557	for my $htype (0..$#$hook) {	603	for my $htype (0..$#$hook) {
558	$hook_count[$htype] -= scalar keys %{ $hook->[$htype] \|\| {} }	604	$hook_count[$htype] -= scalar keys %{ $hook->[$htype] \|\| {} }
559	or set_should_invoke $htype, 0;	605	or set_should_invoke $htype, 0;
560	}	606	}
561	}	607	}
…		…
568	}	614	}
569		615
570	$retval	616	$retval
571	}	617	}
572		618
573	# urxvt::term::proxy	619	# urxvt::term::extension
574		620
575	sub urxvt::term::proxy::AUTOLOAD {	621	package urxvt::term::extension;
576	$urxvt::term::proxy::AUTOLOAD =~ /:([^:]+)$/	622
		623	sub enable {
		624	my ($self, %hook) = @_;
		625	my $pkg = $self->{_pkg};
		626
		627	while (my ($name, $cb) = each %hook) {
		628	my $htype = $HOOKTYPE{uc $name};
		629	defined $htype
		630	or Carp::croak "unsupported hook type '$name'";
		631
		632	unless (exists $self->{term}{_hook}[$htype]{$pkg}) {
		633	$hook_count[$htype]++
		634	or urxvt::set_should_invoke $htype, 1;
		635	}
		636
		637	$self->{term}{_hook}[$htype]{$pkg} = $cb;
		638	}
		639	}
		640
		641	sub disable {
		642	my ($self, @hook) = @_;
		643	my $pkg = $self->{_pkg};
		644
		645	for my $name (@hook) {
		646	my $htype = $HOOKTYPE{uc $name};
		647	defined $htype
		648	or Carp::croak "unsupported hook type '$name'";
		649
		650	if (delete $self->{term}{_hook}[$htype]{$pkg}) {
		651	--$hook_count[$htype]
		652	or urxvt::set_should_invoke $htype, 0;
		653	}
		654	}
		655	}
		656
		657	our $AUTOLOAD;
		658
		659	sub AUTOLOAD {
		660	$AUTOLOAD =~ /:([^:]+)$/
577	or die "FATAL: \$AUTOLOAD '$urxvt::term::proxy::AUTOLOAD' unparsable";	661	or die "FATAL: \$AUTOLOAD '$AUTOLOAD' unparsable";
578		662
579	eval qq{	663	eval qq{
580	sub $urxvt::term::proxy::AUTOLOAD {	664	sub $AUTOLOAD {
581	my \$proxy = shift;	665	my \$proxy = shift;
582	\$proxy->{term}->$1 (\@_)	666	\$proxy->{term}->$1 (\@_)
583	}	667	}
584	1	668	1
585	} or die "FATAL: unable to compile method forwarder: $@";	669	} or die "FATAL: unable to compile method forwarder: $@";
586		670
587	goto &$urxvt::term::proxy::AUTOLOAD;	671	goto &$AUTOLOAD;
588	}	672	}
589		673
590	sub urxvt::term::proxy::DESTROY {	674	sub DESTROY {
591	# nop	675	# nop
592	}	676	}
593		677
594	# urxvt::destroy_hook	678	# urxvt::destroy_hook
595		679
…		…
605		689
606	=head2 The C<urxvt::anyevent> Class	690	=head2 The C<urxvt::anyevent> Class
607		691
608	The sole purpose of this class is to deliver an interface to the	692	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	693	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	694	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	695	condition variables, but non-blocking condvar use is ok. What this means
612	cannot use blocking APIs, but the non-blocking variant should work.	696	is that you cannot use blocking APIs, but the non-blocking variant should
		697	work.
613		698
614	=cut	699	=cut
615		700
616	our $VERSION = 1;	701	our $VERSION = 1;
617		702
…		…
662	${$_[0]}++;	747	${$_[0]}++;
663	}	748	}
664		749
665	sub urxvt::anyevent::condvar::wait {	750	sub urxvt::anyevent::condvar::wait {
666	unless (${$_[0]}) {	751	unless (${$_[0]}) {
667	require Carp;
668	Carp::croak ("AnyEvent->condvar blocking wait unsupported in urxvt, use a non-blocking API");	752	Carp::croak "AnyEvent->condvar blocking wait unsupported in urxvt, use a non-blocking API";
669	}	753	}
670	}	754	}
671		755
672	package urxvt::term;	756	package urxvt::term;
673		757
674	=head2 The C<urxvt::term> Class	758	=head2 The C<urxvt::term> Class
675		759
676	=over 4	760	=over 4
677		761
		762	=cut
		763
		764	# find on_xxx subs in the package and register them
		765	# as hooks
		766	sub register_package {
		767	my ($self, $pkg, $argv) = @_;
		768
		769	my $proxy = bless {
		770	_pkg => $pkg,
		771	argv => $argv,
		772	}, $pkg;
		773	Scalar::Util::weaken ($proxy->{term} = $self);
		774
		775	$self->{_pkg}{$pkg} = $proxy;
		776
		777	for my $name (@HOOKNAME) {
		778	if (my $ref = $pkg->can ("on_" . lc $name)) {
		779	$proxy->enable ($name => $ref);
		780	}
		781	}
		782	}
		783
		784	=item $term = new urxvt::term $envhashref, $rxvtname, [arg...]
		785
		786	Creates a new terminal, very similar as if you had started it with system
		787	C<$rxvtname, arg...>. C<$envhashref> must be a reference to a %ENV>-like
		788	C<hash which defines the environment of the new terminal.
		789
		790	Croaks (and probably outputs an error message) if the new instance
		791	couldn't be created. Returns C<undef> if the new instance didn't
		792	initialise perl, and the terminal object otherwise. The C<init> and
		793	C<start> hooks will be called during this call.
		794
		795	=cut
		796
		797	sub new {
		798	my ($class, $env, @args) = @_;
		799
		800	_new ([ map "$_=$env->{$_}", keys %$env ], @args);
		801	}
		802
678	=item $term->destroy	803	=item $term->destroy
679		804
680	Destroy the terminal object (close the window, free resources etc.).	805	Destroy the terminal object (close the window, free resources
		806	etc.). Please note that @@RXVT_NAME@@ will not exit as long as any event
		807	watchers (timers, io watchers) are still active.
681		808
682	=item $isset = $term->option ($optval[, $set])	809	=item $isset = $term->option ($optval[, $set])
683		810
684	Returns true if the option specified by C<$optval> is enabled, and	811	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	812	optionally change it. All option values are stored by name in the hash
…		…
735	my ($self, $name) = (shift, shift);	862	my ($self, $name) = (shift, shift);
736	unshift @_, $self, $name, ($name =~ s/\s\+\s(\d+)$// ? $1 : 0);	863	unshift @_, $self, $name, ($name =~ s/\s\+\s(\d+)$// ? $1 : 0);
737	&urxvt::term::_resource	864	&urxvt::term::_resource
738	}	865	}
739		866
		867	=item $success = $term->parse_keysym ($keysym_spec, $command_string)
		868
		869	Adds a keymap translation exactly as specified via a resource. See the
		870	C<keysym> resource in the @@RXVT_NAME@@(1) manpage.
		871
740	=item $rend = $term->rstyle ([$new_rstyle])	872	=item $rend = $term->rstyle ([$new_rstyle])
741		873
742	Return and optionally change the current rendition. Text that is output by	874	Return and optionally change the current rendition. Text that is output by
743	the terminal application will use this style.	875	the terminal application will use this style.
744		876
…		…
763		895
764	=item $oldtext = $term->selection ([$newtext])	896	=item $oldtext = $term->selection ([$newtext])
765		897
766	Return the current selection text and optionally replace it by C<$newtext>.	898	Return the current selection text and optionally replace it by C<$newtext>.
767		899
768	#=item $term->overlay ($x, $y, $text)	900	=item $term->overlay_simple ($x, $y, $text)
769	#	901
770	#Create a simple multi-line overlay box. See the next method for details.	902	Create a simple multi-line overlay box. See the next method for details.
771	#	903
772	#=cut	904	=cut
773	#	905
774	#sub urxvt::term::scr_overlay {	906	sub overlay_simple {
775	# my ($self, $x, $y, $text) = @_;	907	my ($self, $x, $y, $text) = @_;
776	#	908
777	# my @lines = split /\n/, $text;	909	my @lines = split /\n/, $text;
778	#	910
779	# my $w = 0;	911	my $w = List::Util::max map $self->strwidth ($_), @lines;
780	# for (map $self->strwidth ($_), @lines) {	912
781	# $w = $_ if $w < $_;
782	# }
783	#
784	# $self->scr_overlay_new ($x, $y, $w, scalar @lines);	913	my $overlay = $self->overlay ($x, $y, $w, scalar @lines);
785	# $self->scr_overlay_set (0, $_, $lines[$_]) for 0.. $#lines;	914	$overlay->set (0, $_, $lines[$_]) for 0.. $#lines;
786	#}	915
		916	$overlay
		917	}
787		918
788	=item $term->overlay ($x, $y, $width, $height[, $rstyle[, $border]])	919	=item $term->overlay ($x, $y, $width, $height[, $rstyle[, $border]])
789		920
790	Create a new (empty) overlay at the given position with the given	921	Create a new (empty) overlay at the given position with the given
791	width/height. C<$rstyle> defines the initial rendition style	922	width/height. C<$rstyle> defines the initial rendition style
…		…
858		989
859	=item $string = $term->locale_decode ($octets)	990	=item $string = $term->locale_decode ($octets)
860		991
861	Convert the given locale-encoded octets into a perl string.	992	Convert the given locale-encoded octets into a perl string.
862		993
		994	=item $term->scr_xor_span ($beg_row, $beg_col, $end_row, $end_col[, $rstyle])
		995
		996	XORs the rendition values in the given span with the provided value
		997	(default: C<RS_RVid>). Useful in refresh hooks to provide effects similar
		998	to the selection.
		999
		1000	=item $term->scr_xor_rect ($beg_row, $beg_col, $end_row, $end_col[, $rstyle1[, $rstyle2]])
		1001
		1002	Similar to C<scr_xor_span>, but xors a rectangle instead. Trailing
		1003	whitespace will additionally be xored with the C<$rstyle2>, which defaults
		1004	to C<RS_RVid \| RS_Uline>, which removes reverse video again and underlines
		1005	it instead.
		1006
		1007	=item $term->scr_bell
		1008
		1009	Ring the bell!
		1010
863	=item $term->scr_add_lines ($string)	1011	=item $term->scr_add_lines ($string)
864		1012
865	Write the given text string to the screen, as if output by the application	1013	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	1014	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	1015	codes), but is free to use line feeds, carriage returns and tabs. The
…		…
881		1029
882	Write the octets given in C<$data> to the tty (i.e. as program input). To	1030	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	1031	pass characters instead of octets, you should convert your strings first
884	to the locale-specific encoding using C<< $term->locale_encode >>.	1032	to the locale-specific encoding using C<< $term->locale_encode >>.
885		1033
		1034	=item $old_events = $term->pty_ev_events ([$new_events])
		1035
		1036	Replaces the event mask of the pty watcher by the given event mask. Can
		1037	be used to suppress input and output handling to the pty/tty. See the
		1038	description of C<< urxvt::timer->events >>. Make sure to always restore
		1039	the previous value.
		1040
886	=item $windowid = $term->parent	1041	=item $windowid = $term->parent
887		1042
888	Return the window id of the toplevel window.	1043	Return the window id of the toplevel window.
889		1044
890	=item $windowid = $term->vt	1045	=item $windowid = $term->vt
…		…
914	=item $nrow_plus_saveLines = $term->total_rows	1069	=item $nrow_plus_saveLines = $term->total_rows
915		1070
916	=item $lines_in_scrollback = $term->nsaved	1071	=item $lines_in_scrollback = $term->nsaved
917		1072
918	Return various integers describing terminal characteristics.	1073	Return various integers describing terminal characteristics.
		1074
		1075	=item $x_display = $term->display_id
		1076
		1077	Return the DISPLAY used by rxvt-unicode.
		1078
		1079	=item $lc_ctype = $term->locale
		1080
		1081	Returns the LC_CTYPE category string used by this rxvt-unicode.
		1082
		1083	=item $env = $term->env
		1084
		1085	Returns a copy of the environment in effect for the terminal as a hashref
		1086	similar to C<\%ENV>.
		1087
		1088	=cut
		1089
		1090	sub env {
		1091	if (my $env = $_[0]->_env) {
		1092	+{ map /^([^=]+)(?:=(.*))?$/s && ($1 => $2), @$env }
		1093	} else {
		1094	+{ %ENV }
		1095	}
		1096	}
919		1097
920	=item $modifiermask = $term->ModLevel3Mask	1098	=item $modifiermask = $term->ModLevel3Mask
921		1099
922	=item $modifiermask = $term->ModMetaMask	1100	=item $modifiermask = $term->ModMetaMask
923		1101
…		…
1100	$offset / $self->{ncol} + $self->{beg},	1278	$offset / $self->{ncol} + $self->{beg},
1101	$offset % $self->{ncol}	1279	$offset % $self->{ncol}
1102	)	1280	)
1103	}	1281	}
1104		1282
1105	=item ($row, $col) = $line->coord_of ($offset)
1106	=item $text = $term->special_encode $string	1283	=item $text = $term->special_encode $string
1107		1284
1108	Converts a perl string into the special encoding used by rxvt-unicode,	1285	Converts a perl string into the special encoding used by rxvt-unicode,
1109	where one character corresponds to one screen cell. See	1286	where one character corresponds to one screen cell. See
1110	C<< $term->ROW_t >> for details.	1287	C<< $term->ROW_t >> for details.
…		…
1112	=item $string = $term->special_decode $text	1289	=item $string = $term->special_decode $text
1113		1290
1114	Converts rxvt-unicodes text reprsentation into a perl string. See	1291	Converts rxvt-unicodes text reprsentation into a perl string. See
1115	C<< $term->ROW_t >> for details.	1292	C<< $term->ROW_t >> for details.
1116		1293
		1294	=item $success = $term->grab_button ($button, $modifiermask)
		1295
		1296	Registers a synchronous button grab. See the XGrabButton manpage.
		1297
		1298	=item $success = $term->grab ($eventtime[, $sync])
		1299
		1300	Calls XGrabPointer and XGrabKeyboard in asynchronous (default) or
		1301	synchronous (C<$sync> is true). Also remembers the grab timestampe.
		1302
		1303	=item $term->allow_events_async
		1304
		1305	Calls XAllowEvents with AsyncBoth for the most recent grab.
		1306
		1307	=item $term->allow_events_sync
		1308
		1309	Calls XAllowEvents with SyncBoth for the most recent grab.
		1310
		1311	=item $term->allow_events_replay
		1312
		1313	Calls XAllowEvents with both ReplayPointer and ReplayKeyboard for the most
		1314	recent grab.
		1315
		1316	=item $term->ungrab
		1317
		1318	Calls XUngrab for the most recent grab. Is called automatically on
		1319	evaluation errors, as it is better to lose the grab in the error case as
		1320	the session.
		1321
1117	=back	1322	=back
1118		1323
1119	=cut	1324	=cut
1120		1325
1121	package urxvt::popup;	1326	package urxvt::popup;
…		…
1136	$item->{render} \|\|= sub { $_[0]{text} };	1341	$item->{render} \|\|= sub { $_[0]{text} };
1137		1342
1138	push @{ $self->{item} }, $item;	1343	push @{ $self->{item} }, $item;
1139	}	1344	}
1140		1345
1141	sub add_separator {	1346	=item $popup->add_title ($title)
1142	my ($self, $sep) = @_;
1143		1347
1144	$sep \|\|= "═";	1348	Adds a non-clickable title to the popup.
1145		1349
1146	$self->add_item ({	1350	=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		1351
1154	sub add_title {	1352	sub add_title {
1155	my ($self, $title) = @_;	1353	my ($self, $title) = @_;
1156		1354
1157	$self->add_item ({	1355	$self->add_item ({
…		…
1159	text => $title,	1357	text => $title,
1160	activate => sub { },	1358	activate => sub { },
1161	});	1359	});
1162	}	1360	}
1163		1361
		1362	=item $popup->add_separator ([$sepchr])
		1363
		1364	Creates a separator, optionally using the character given as C<$sepchr>.
		1365
		1366	=cut
		1367
		1368	sub add_separator {
		1369	my ($self, $sep) = @_;
		1370
		1371	$sep \|\|= "=";
		1372
		1373	$self->add_item ({
		1374	rend => { normal => "\x1b[0;30;47m", hover => "\x1b[0;30;47m", active => "\x1b[0;30;47m" },
		1375	text => "",
		1376	render => sub { $sep x $self->{term}->ncol },
		1377	activate => sub { },
		1378	});
		1379	}
		1380
		1381	=item $popup->add_button ($text, $cb)
		1382
		1383	Adds a clickable button to the popup. C<$cb> is called whenever it is
		1384	selected.
		1385
		1386	=cut
		1387
1164	sub add_button {	1388	sub add_button {
1165	my ($self, $text, $cb) = @_;	1389	my ($self, $text, $cb) = @_;
1166		1390
1167	$self->add_item ({ type => "button", text => "[ $text ]", activate => $cb});	1391	$self->add_item ({ type => "button", text => $text, activate => $cb});
1168	}	1392	}
		1393
		1394	=item $popup->add_toggle ($text, $cb, $initial_value)
		1395
		1396	Adds a toggle/checkbox item to the popup. Teh callback gets called
		1397	whenever it gets toggled, with a boolean indicating its value as its first
		1398	argument.
		1399
		1400	=cut
1169		1401
1170	sub add_toggle {	1402	sub add_toggle {
1171	my ($self, $text, $cb, $value) = @_;	1403	my ($self, $text, $cb, $value) = @_;
1172		1404
1173	my $item; $item = {	1405	my $item; $item = {
1174	type => "button",	1406	type => "button",
1175	text => " $text",	1407	text => " $text",
1176	value => $value,	1408	value => $value,
1177	render => sub { ($_[0]{value} ? "* " : " ") . $text },	1409	render => sub { ($_[0]{value} ? "* " : " ") . $text },
1178	activate => sub { $cb->($_[0]{value} = !$_[0]{value}); },	1410	activate => sub { $cb->($_[1]{value} = !$_[1]{value}); },
1179	};	1411	};
1180		1412
1181	$self->add_item ($item);	1413	$self->add_item ($item);
1182	}	1414	}
		1415
		1416	=item $popup->show
		1417
		1418	Displays the popup (which is initially hidden).
		1419
		1420	=cut
1183		1421
1184	sub show {	1422	sub show {
1185	my ($self) = @_;	1423	my ($self) = @_;
1186		1424
1187	local $urxvt::popup::self = $self;	1425	local $urxvt::popup::self = $self;
1188		1426
		1427	my $env = $self->{term}->env;
		1428	# we can't hope to reproduce the locale algorithm, so nuke LC_ALL and set LC_CTYPE.
		1429	delete $env->{LC_ALL};
		1430	$env->{LC_CTYPE} = $self->{term}->locale;
		1431
		1432	urxvt::term->new ($env, $self->{term}->resource ("name"),
1189	urxvt->new ("--perl-lib" => "", "--perl-ext-common" => "", "-pty-fd" => -1, "-sl" => 0, "-b" => 0,	1433	"--perl-lib" => "", "--perl-ext-common" => "", "-pty-fd" => -1, "-sl" => 0, "-b" => 0,
1190	"--transient-for" => $self->{term}->parent,	1434	"--transient-for" => $self->{term}->parent,
		1435	"-display" => $self->{term}->display_id,
1191	"-pe" => "urxvt-popup")	1436	"-pe" => "urxvt-popup")
1192	or die "unable to create popup window\n";	1437	or die "unable to create popup window\n";
1193	}	1438	}
1194		1439
1195	sub DESTROY {	1440	sub DESTROY {
1196	my ($self) = @_;	1441	my ($self) = @_;
…		…
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.77 by root, Wed Jan 11 00:59:58 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.77 by root, Wed Jan 11 00:59:58 2006 UTC