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

Comparing rxvt-unicode/src/urxvt.pm (file contents):
Revision 1.65 by root, Mon Jan 9 19:25:57 2006 UTC vs.
Revision 1.81 by root, Thu Jan 12 00:12:40 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
75	=item mark-urls	87	=item mark-urls
76		88
77	Uses per-line display filtering (C<on_line_update>) to underline urls.	89	Uses per-line display filtering (C<on_line_update>) to underline urls and
		90	make them clickable. When clicked, the program specified in the resource
		91	C<urlLauncher> (default C<x-www-browser>) will be started.
78		92
79	=item block-graphics-to-ascii	93	=item block-graphics-to-ascii
80		94
81	A not very useful example of filtering all text output to the terminal,	95	A not very useful example of filtering all text output to the terminal,
82	by replacing all line-drawing characters (U+2500 .. U+259F) by a	96	by replacing all line-drawing characters (U+2500 .. U+259F) by a
…		…
87	Displays a very simple digital clock in the upper right corner of the	101	Displays a very simple digital clock in the upper right corner of the
88	window. Illustrates overwriting the refresh callbacks to create your own	102	window. Illustrates overwriting the refresh callbacks to create your own
89	overlays or changes.	103	overlays or changes.
90		104
91	=back	105	=back
		106
		107	=head1 API DOCUMENTATION
92		108
93	=head2 General API Considerations	109	=head2 General API Considerations
94		110
95	All objects (such as terminals, time watchers etc.) are typical	111	All objects (such as terminals, time watchers etc.) are typical
96	reference-to-hash objects. The hash can be used to store anything you	112	reference-to-hash objects. The hash can be used to store anything you
…		…
109	=over 4	125	=over 4
110		126
111	=item $text	127	=item $text
112		128
113	Rxvt-unicodes special way of encoding text, where one "unicode" character	129	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.	130	always represents one screen cell. See L<ROW_t> for a discussion of this format.
115		131
116	=item $string	132	=item $string
117		133
118	A perl text string, with an emphasis on I<text>. It can store all unicode	134	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	135	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	140	Either binary data or - more common - a text string encoded in a
125	locale-specific way.	141	locale-specific way.
126		142
127	=back	143	=back
128		144
		145	=head2 Extension Objects
		146
		147	Very perl extension is a perl class. A separate perl object is created
		148	for each terminal and each extension and passed as the first parameter to
		149	hooks. So extensions can use their C<$self> object without having to think
		150	about other extensions, with the exception of methods and members that
		151	begin with an underscore character C<_>: these are reserved for internal
		152	use.
		153
		154	Although it isn't a C<urxvt::term> object, you can call all methods of the
		155	C<urxvt::term> class on this object.
		156
		157	It has the following methods and data members:
		158
		159	=over 4
		160
		161	=item $urxvt_term = $self->{term}
		162
		163	Returns the C<urxvt::term> object associated with this instance of the
		164	extension. This member I<must not> be changed in any way.
		165
		166	=item $self->enable ($hook_name => $cb, [$hook_name => $cb..])
		167
		168	Dynamically enable the given hooks (named without the C<on_> prefix) for
		169	this extension, replacing any previous hook. This is useful when you want
		170	to overwrite time-critical hooks only temporarily.
		171
		172	=item $self->disable ($hook_name[, $hook_name..])
		173
		174	Dynamically disable the given hooks.
		175
		176	=back
		177
129	=head2 Hooks	178	=head2 Hooks
130		179
131	The following subroutines can be declared in extension files, and will be	180	The following subroutines can be declared in extension files, and will be
132	called whenever the relevant event happens.	181	called whenever the relevant event happens.
133		182
134	The first argument passed to them is an object private to each terminal	183	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	184	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		185
141	All of them must return a boolean value. If it is true, then the event	186	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,	187	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.	188	skipped, and the relevant action might not be carried out by the C++ code.
144		189
145	When in doubt, return a false value (preferably C<()>).	190	I<< When in doubt, return a false value (preferably C<()>). >>
146		191
147	=over 4	192	=over 4
148		193
149	=item on_init $term	194	=item on_init $term
150		195
…		…
226	can filter/change and output the text yourself by returning a true value	271	can filter/change and output the text yourself by returning a true value
227	and calling C<< $term->scr_add_lines >> yourself. Please note that this	272	and calling C<< $term->scr_add_lines >> yourself. Please note that this
228	might be very slow, however, as your hook is called for B<all> text being	273	might be very slow, however, as your hook is called for B<all> text being
229	output.	274	output.
230		275
		276	=item on_tt_write $term, $octets
		277
		278	Called whenever some data is written to the tty/pty and can be used to
		279	suppress or filter tty input.
		280
231	=item on_line_update $term, $row	281	=item on_line_update $term, $row
232		282
233	Called whenever a line was updated or changed. Can be used to filter	283	Called whenever a line was updated or changed. Can be used to filter
234	screen output (e.g. underline urls or other useless stuff). Only lines	284	screen output (e.g. underline urls or other useless stuff). Only lines
235	that are being shown will be filtered, and, due to performance reasons,	285	that are being shown will be filtered, and, due to performance reasons,
…		…
267	=item on_focus_out $term	317	=item on_focus_out $term
268		318
269	Called wheneever the window loses keyboard focus, before rxvt-unicode does	319	Called wheneever the window loses keyboard focus, before rxvt-unicode does
270	focus out processing.	320	focus out processing.
271		321
272	=item on_key_press $term, $event, $octets	322	=item on_key_press $term, $event, $keysym, $octets
273		323
274	=item on_key_release $term, $event	324	=item on_key_release $term, $event, $keysym
275		325
276	=item on_button_press $term, $event	326	=item on_button_press $term, $event
277		327
278	=item on_button_release $term, $event	328	=item on_button_release $term, $event
279		329
…		…
295		345
296	subwindow.	346	subwindow.
297		347
298	=back	348	=back
299		349
		350	=cut
		351
		352	package urxvt;
		353
		354	use utf8;
		355	use strict;
		356	use Carp ();
		357	use Scalar::Util ();
		358	use List::Util ();
		359
		360	our $VERSION = 1;
		361	our $TERM;
		362	our @HOOKNAME;
		363	our %HOOKTYPE = map +($HOOKNAME[$_] => $_), 0..$#HOOKNAME;
		364	our %OPTION;
		365
		366	our $LIBDIR;
		367	our $RESNAME;
		368	our $RESCLASS;
		369	our $RXVTNAME;
		370
300	=head2 Variables in the C<urxvt> Package	371	=head2 Variables in the C<urxvt> Package
301		372
302	=over 4	373	=over 4
		374
		375	=item $urxvt::LIBDIR
		376
		377	The rxvt-unicode library directory, where, among other things, the perl
		378	modules and scripts are stored.
		379
		380	=item $urxvt::RESCLASS, $urxvt::RESCLASS
		381
		382	The resource class and name rxvt-unicode uses to look up X resources.
		383
		384	=item $urxvt::RXVTNAME
		385
		386	The basename of the installed binaries, usually C<urxvt>.
303		387
304	=item $urxvt::TERM	388	=item $urxvt::TERM
305		389
306	The current terminal. This variable stores the current C<urxvt::term>	390	The current terminal. This variable stores the current C<urxvt::term>
307	object, whenever a callback/hook is executing.	391	object, whenever a callback/hook is executing.
…		…
309	=back	393	=back
310		394
311	=head2 Functions in the C<urxvt> Package	395	=head2 Functions in the C<urxvt> Package
312		396
313	=over 4	397	=over 4
314
315	=item $term = new urxvt [arg...]
316
317	Creates a new terminal, very similar as if you had started it with
318	C<system $binfile, arg...>. Croaks (and probably outputs an error message)
319	if the new instance couldn't be created. Returns C<undef> if the new
320	instance didn't initialise perl, and the terminal object otherwise. The
321	C<init> and C<start> hooks will be called during the call.
322		398
323	=item urxvt::fatal $errormessage	399	=item urxvt::fatal $errormessage
324		400
325	Fatally aborts execution with the given error message. Avoid at all	401	Fatally aborts execution with the given error message. Avoid at all
326	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
…		…
332	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
333	that calls this function.	409	that calls this function.
334		410
335	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
336	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.
337		415
338	=item $is_safe = urxvt::safe	416	=item $is_safe = urxvt::safe
339		417
340	Returns true when it is safe to do potentially unsafe things, such as	418	Returns true when it is safe to do potentially unsafe things, such as
341	evaluating perl code specified by the user. This is true when urxvt was	419	evaluating perl code specified by the user. This is true when urxvt was
…		…
386		464
387	=item $background = urxvt::GET_BASEBG $rend	465	=item $background = urxvt::GET_BASEBG $rend
388		466
389	Return the foreground/background colour index, respectively.	467	Return the foreground/background colour index, respectively.
390		468
391	=item $rend = urxvt::SET_FGCOLOR ($rend, $new_colour)	469	=item $rend = urxvt::SET_FGCOLOR $rend, $new_colour
392		470
393	=item $rend = urxvt::SET_BGCOLOR ($rend, $new_colour)	471	=item $rend = urxvt::SET_BGCOLOR $rend, $new_colour
394		472
395	Replace the foreground/background colour in the rendition mask with the	473	Replace the foreground/background colour in the rendition mask with the
396	specified one.	474	specified one.
397		475
398	=item $value = urxvt::GET_CUSTOM ($rend)	476	=item $value = urxvt::GET_CUSTOM $rend
399		477
400	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
401	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
402	zero.	480	zero.
403		481
404	=item $rend = urxvt::SET_CUSTOM ($rend, $new_value)	482	=item $rend = urxvt::SET_CUSTOM $rend, $new_value
405		483
406	Change the custom value.	484	Change the custom value.
407		485
408	=back	486	=back
409		487
410	=cut	488	=cut
411
412	package urxvt;
413
414	use utf8;
415	use strict;
416	use Scalar::Util ();
417	use List::Util ();
418
419	our $VERSION = 1;
420	our $TERM;
421	our @HOOKNAME;
422	our %OPTION;
423	our $LIBDIR;
424		489
425	BEGIN {	490	BEGIN {
426	urxvt->bootstrap;	491	urxvt->bootstrap;
427		492
428	# overwrite perl's warn	493	# overwrite perl's warn
…		…
445	sub verbose {	510	sub verbose {
446	my ($level, $msg) = @_;	511	my ($level, $msg) = @_;
447	warn "$msg\n" if $level <= $verbosity;	512	warn "$msg\n" if $level <= $verbosity;
448	}	513	}
449		514
450	# find on_xxx subs in the package and register them
451	# as hooks
452	sub register_package($) {
453	my ($pkg) = @_;
454
455	for my $htype (0.. $#HOOKNAME) {
456	my $name = $HOOKNAME[$htype];
457
458	my $ref = $pkg->can ("on_" . lc $name)
459	or next;
460
461	$TERM->{_hook}[$htype]{$pkg} = $ref;
462	$hook_count[$htype]++
463	or set_should_invoke $htype, 1;
464	}
465	}
466
467	my $extension_pkg = "extension0000";	515	my $extension_pkg = "extension0000";
468	my %extension_pkg;	516	my %extension_pkg;
469		517
470	# load a single script into its own package, once only	518	# load a single script into its own package, once only
471	sub extension_package($) {	519	sub extension_package($) {
…		…
477	verbose 3, "loading extension '$path' into package '$pkg'";	525	verbose 3, "loading extension '$path' into package '$pkg'";
478		526
479	open my $fh, "<:raw", $path	527	open my $fh, "<:raw", $path
480	or die "$path: $!";	528	or die "$path: $!";
481		529
		530	my $source = untaint
482	my $source = untaint "package $pkg; use strict; use utf8;\n"	531	"package $pkg; use strict; use utf8;\n"
483	. "use base urxvt::term::proxy::;\n"	532	. "use base urxvt::term::extension::;\n"
484	. "#line 1 \"$path\"\n{\n"	533	. "#line 1 \"$path\"\n{\n"
485	. (do { local $/; <$fh> })	534	. (do { local $/; <$fh> })
486	. "\n};\n1";	535	. "\n};\n1";
487		536
		537	eval $source
488	eval $source or die "$path: $@";	538	or die "$path: $@";
489		539
490	$pkg	540	$pkg
491	}	541	}
492	}	542	}
493		543
…		…
499	my $htype = shift;	549	my $htype = shift;
500		550
501	if ($htype == 0) { # INIT	551	if ($htype == 0) { # INIT
502	my @dirs = ((split /:/, $TERM->resource ("perl_lib")), "$LIBDIR/perl");	552	my @dirs = ((split /:/, $TERM->resource ("perl_lib")), "$LIBDIR/perl");
503		553
504	my %want_ext;	554	my %ext_arg;
505		555
506	for (map { split /,/, $TERM->resource ("perl_ext_$_") } 1, 2) {	556	for (map { split /,/, $TERM->resource ("perl_ext_$_") } 1, 2) {
507	if ($_ eq "default") {	557	if ($_ eq "default") {
508	$want_ext{$_}++ for qw(selection option-popup selection-popup);	558	$ext_arg{$_} \|\|= [] for qw(selection option-popup selection-popup searchable-scrollback);
509	} elsif (/^-(.*)$/) {	559	} elsif (/^-(.*)$/) {
510	delete $want_ext{$1};	560	delete $ext_arg{$1};
		561	} elsif (/^([^<]+)<(.*)>$/) {
		562	push @{ $ext_arg{$1} }, $2;
511	} else {	563	} else {
512	$want_ext{$_}++;	564	$ext_arg{$_} \|\|= [];
513	}	565	}
514	}	566	}
515		567
516	for my $ext (keys %want_ext) {	568	while (my ($ext, $argv) = each %ext_arg) {
517	my @files = grep -f $_, map "$_/$ext", @dirs;	569	my @files = grep -f $_, map "$_/$ext", @dirs;
518		570
519	if (@files) {	571	if (@files) {
520	register_package extension_package $files[0];	572	$TERM->register_package (extension_package $files[0], $argv);
521	} else {	573	} else {
522	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";
523	}	575	}
524	}	576	}
525		577
…		…
534	if $verbosity >= 10;	586	if $verbosity >= 10;
535		587
536	keys %$cb;	588	keys %$cb;
537		589
538	while (my ($pkg, $cb) = each %$cb) {	590	while (my ($pkg, $cb) = each %$cb) {
539	eval {	591	$retval = eval { $cb->($TERM->{_pkg}{$pkg}, @_) }
540	$retval = $cb->(
541	$TERM->{_pkg}{$pkg} \|\|= do {
542	my $proxy = bless { }, $pkg;
543	Scalar::Util::weaken ($proxy->{term} = $TERM);
544	$proxy
545	},
546	@_,
547	) and last;	592	and last;
548	};	593
549	if ($@) {	594	if ($@) {
550	$TERM->ungrab; # better to lose the grab than the session	595	$TERM->ungrab; # better to lose the grab than the session
551	warn $@;	596	warn $@;
552	}	597	}
553	}	598	}
554	}	599	}
555		600
556	if ($htype == 1) { # DESTROY	601	if ($htype == 1) { # DESTROY
557	# remove hooks if unused
558	if (my $hook = $TERM->{_hook}) {	602	if (my $hook = delete $TERM->{_hook}) {
559	for my $htype (0..$#$hook) {	603	for my $htype (0..$#$hook) {
560	$hook_count[$htype] -= scalar keys %{ $hook->[$htype] \|\| {} }	604	$hook_count[$htype] -= scalar keys %{ $hook->[$htype] \|\| {} }
561	or set_should_invoke $htype, 0;	605	or set_should_invoke $htype, 0;
562	}	606	}
563	}	607	}
…		…
570	}	614	}
571		615
572	$retval	616	$retval
573	}	617	}
574		618
575	# urxvt::term::proxy	619	# urxvt::term::extension
576		620
577	sub urxvt::term::proxy::AUTOLOAD {	621	package urxvt::term::extension;
578	$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 =~ /:([^:]+)$/
579	or die "FATAL: \$AUTOLOAD '$urxvt::term::proxy::AUTOLOAD' unparsable";	661	or die "FATAL: \$AUTOLOAD '$AUTOLOAD' unparsable";
580		662
581	eval qq{	663	eval qq{
582	sub $urxvt::term::proxy::AUTOLOAD {	664	sub $AUTOLOAD {
583	my \$proxy = shift;	665	my \$proxy = shift;
584	\$proxy->{term}->$1 (\@_)	666	\$proxy->{term}->$1 (\@_)
585	}	667	}
586	1	668	1
587	} or die "FATAL: unable to compile method forwarder: $@";	669	} or die "FATAL: unable to compile method forwarder: $@";
588		670
589	goto &$urxvt::term::proxy::AUTOLOAD;	671	goto &$AUTOLOAD;
590	}	672	}
591		673
592	sub urxvt::term::proxy::DESTROY {	674	sub DESTROY {
593	# nop	675	# nop
594	}	676	}
595		677
596	# urxvt::destroy_hook	678	# urxvt::destroy_hook
597		679
…		…
607		689
608	=head2 The C<urxvt::anyevent> Class	690	=head2 The C<urxvt::anyevent> Class
609		691
610	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
611	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
612	further work. The only exception is that you cannot wait on condition	694	further programming. The only exception is that you cannot wait on
613	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
614	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.
615		698
616	=cut	699	=cut
617		700
618	our $VERSION = 1;	701	our $VERSION = 1;
619		702
…		…
664	${$_[0]}++;	747	${$_[0]}++;
665	}	748	}
666		749
667	sub urxvt::anyevent::condvar::wait {	750	sub urxvt::anyevent::condvar::wait {
668	unless (${$_[0]}) {	751	unless (${$_[0]}) {
669	require Carp;
670	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";
671	}	753	}
672	}	754	}
673		755
674	package urxvt::term;	756	package urxvt::term;
675		757
676	=head2 The C<urxvt::term> Class	758	=head2 The C<urxvt::term> Class
677		759
678	=over 4	760	=over 4
679		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 C<%ENV>-like
		788	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
680	=item $term->destroy	803	=item $term->destroy
681		804
682	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.
683		808
684	=item $isset = $term->option ($optval[, $set])	809	=item $isset = $term->option ($optval[, $set])
685		810
686	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
687	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
…		…
737	my ($self, $name) = (shift, shift);	862	my ($self, $name) = (shift, shift);
738	unshift @_, $self, $name, ($name =~ s/\s\+\s(\d+)$// ? $1 : 0);	863	unshift @_, $self, $name, ($name =~ s/\s\+\s(\d+)$// ? $1 : 0);
739	&urxvt::term::_resource	864	&urxvt::term::_resource
740	}	865	}
741		866
		867	=item $value = $term->x_resource ($pattern)
		868
		869	Returns the X-Resource for the given pattern, excluding the program or
		870	class name, i.e. C<< $term->x_resource ("boldFont") >> should return the
		871	same value as used by this instance of rxvt-unicode. Returns C<undef> if no
		872	resource with that pattern exists.
		873
		874	This method should only be called during the C<on_start> hook, as there is
		875	only one resource database per display, and later invocations might return
		876	the wrong resources.
		877
		878	=item $success = $term->parse_keysym ($keysym_spec, $command_string)
		879
		880	Adds a keymap translation exactly as specified via a resource. See the
		881	C<keysym> resource in the @@RXVT_NAME@@(1) manpage.
		882
742	=item $rend = $term->rstyle ([$new_rstyle])	883	=item $rend = $term->rstyle ([$new_rstyle])
743		884
744	Return and optionally change the current rendition. Text that is output by	885	Return and optionally change the current rendition. Text that is output by
745	the terminal application will use this style.	886	the terminal application will use this style.
746		887
…		…
765		906
766	=item $oldtext = $term->selection ([$newtext])	907	=item $oldtext = $term->selection ([$newtext])
767		908
768	Return the current selection text and optionally replace it by C<$newtext>.	909	Return the current selection text and optionally replace it by C<$newtext>.
769		910
770	#=item $term->overlay ($x, $y, $text)	911	=item $term->overlay_simple ($x, $y, $text)
771	#	912
772	#Create a simple multi-line overlay box. See the next method for details.	913	Create a simple multi-line overlay box. See the next method for details.
773	#	914
774	#=cut	915	=cut
775	#	916
776	#sub urxvt::term::scr_overlay {	917	sub overlay_simple {
777	# my ($self, $x, $y, $text) = @_;	918	my ($self, $x, $y, $text) = @_;
778	#	919
779	# my @lines = split /\n/, $text;	920	my @lines = split /\n/, $text;
780	#	921
781	# my $w = 0;	922	my $w = List::Util::max map $self->strwidth ($_), @lines;
782	# for (map $self->strwidth ($_), @lines) {	923
783	# $w = $_ if $w < $_;
784	# }
785	#
786	# $self->scr_overlay_new ($x, $y, $w, scalar @lines);	924	my $overlay = $self->overlay ($x, $y, $w, scalar @lines);
787	# $self->scr_overlay_set (0, $_, $lines[$_]) for 0.. $#lines;	925	$overlay->set (0, $_, $lines[$_]) for 0.. $#lines;
788	#}	926
		927	$overlay
		928	}
789		929
790	=item $term->overlay ($x, $y, $width, $height[, $rstyle[, $border]])	930	=item $term->overlay ($x, $y, $width, $height[, $rstyle[, $border]])
791		931
792	Create a new (empty) overlay at the given position with the given	932	Create a new (empty) overlay at the given position with the given
793	width/height. C<$rstyle> defines the initial rendition style	933	width/height. C<$rstyle> defines the initial rendition style
…		…
860		1000
861	=item $string = $term->locale_decode ($octets)	1001	=item $string = $term->locale_decode ($octets)
862		1002
863	Convert the given locale-encoded octets into a perl string.	1003	Convert the given locale-encoded octets into a perl string.
864		1004
		1005	=item $term->scr_xor_span ($beg_row, $beg_col, $end_row, $end_col[, $rstyle])
		1006
		1007	XORs the rendition values in the given span with the provided value
		1008	(default: C<RS_RVid>). Useful in refresh hooks to provide effects similar
		1009	to the selection.
		1010
		1011	=item $term->scr_xor_rect ($beg_row, $beg_col, $end_row, $end_col[, $rstyle1[, $rstyle2]])
		1012
		1013	Similar to C<scr_xor_span>, but xors a rectangle instead. Trailing
		1014	whitespace will additionally be xored with the C<$rstyle2>, which defaults
		1015	to C<RS_RVid \| RS_Uline>, which removes reverse video again and underlines
		1016	it instead.
		1017
		1018	=item $term->scr_bell
		1019
		1020	Ring the bell!
		1021
865	=item $term->scr_add_lines ($string)	1022	=item $term->scr_add_lines ($string)
866		1023
867	Write the given text string to the screen, as if output by the application	1024	Write the given text string to the screen, as if output by the application
868	running inside the terminal. It may not contain command sequences (escape	1025	running inside the terminal. It may not contain command sequences (escape
869	codes), but is free to use line feeds, carriage returns and tabs. The	1026	codes), but is free to use line feeds, carriage returns and tabs. The
…		…
883		1040
884	Write the octets given in C<$data> to the tty (i.e. as program input). To	1041	Write the octets given in C<$data> to the tty (i.e. as program input). To
885	pass characters instead of octets, you should convert your strings first	1042	pass characters instead of octets, you should convert your strings first
886	to the locale-specific encoding using C<< $term->locale_encode >>.	1043	to the locale-specific encoding using C<< $term->locale_encode >>.
887		1044
		1045	=item $old_events = $term->pty_ev_events ([$new_events])
		1046
		1047	Replaces the event mask of the pty watcher by the given event mask. Can
		1048	be used to suppress input and output handling to the pty/tty. See the
		1049	description of C<< urxvt::timer->events >>. Make sure to always restore
		1050	the previous value.
		1051
888	=item $windowid = $term->parent	1052	=item $windowid = $term->parent
889		1053
890	Return the window id of the toplevel window.	1054	Return the window id of the toplevel window.
891		1055
892	=item $windowid = $term->vt	1056	=item $windowid = $term->vt
…		…
916	=item $nrow_plus_saveLines = $term->total_rows	1080	=item $nrow_plus_saveLines = $term->total_rows
917		1081
918	=item $lines_in_scrollback = $term->nsaved	1082	=item $lines_in_scrollback = $term->nsaved
919		1083
920	Return various integers describing terminal characteristics.	1084	Return various integers describing terminal characteristics.
		1085
		1086	=item $x_display = $term->display_id
		1087
		1088	Return the DISPLAY used by rxvt-unicode.
		1089
		1090	=item $lc_ctype = $term->locale
		1091
		1092	Returns the LC_CTYPE category string used by this rxvt-unicode.
		1093
		1094	=item $env = $term->env
		1095
		1096	Returns a copy of the environment in effect for the terminal as a hashref
		1097	similar to C<\%ENV>.
		1098
		1099	=cut
		1100
		1101	sub env {
		1102	if (my $env = $_[0]->_env) {
		1103	+{ map /^([^=]+)(?:=(.*))?$/s && ($1 => $2), @$env }
		1104	} else {
		1105	+{ %ENV }
		1106	}
		1107	}
921		1108
922	=item $modifiermask = $term->ModLevel3Mask	1109	=item $modifiermask = $term->ModLevel3Mask
923		1110
924	=item $modifiermask = $term->ModMetaMask	1111	=item $modifiermask = $term->ModMetaMask
925		1112
…		…
1165	$item->{render} \|\|= sub { $_[0]{text} };	1352	$item->{render} \|\|= sub { $_[0]{text} };
1166		1353
1167	push @{ $self->{item} }, $item;	1354	push @{ $self->{item} }, $item;
1168	}	1355	}
1169		1356
		1357	=item $popup->add_title ($title)
		1358
		1359	Adds a non-clickable title to the popup.
		1360
		1361	=cut
		1362
		1363	sub add_title {
		1364	my ($self, $title) = @_;
		1365
		1366	$self->add_item ({
		1367	rend => { normal => "\x1b[38;5;11;44m", hover => "\x1b[38;5;11;44m", active => "\x1b[38;5;11;44m" },
		1368	text => $title,
		1369	activate => sub { },
		1370	});
		1371	}
		1372
		1373	=item $popup->add_separator ([$sepchr])
		1374
		1375	Creates a separator, optionally using the character given as C<$sepchr>.
		1376
		1377	=cut
		1378
1170	sub add_separator {	1379	sub add_separator {
1171	my ($self, $sep) = @_;	1380	my ($self, $sep) = @_;
1172		1381
1173	$sep \|\|= "═";	1382	$sep \|\|= "=";
1174		1383
1175	$self->add_item ({	1384	$self->add_item ({
1176	rend => { normal => "\x1b[0;30;47m", hover => "\x1b[0;30;47m", active => "\x1b[0;30;47m" },	1385	rend => { normal => "\x1b[0;30;47m", hover => "\x1b[0;30;47m", active => "\x1b[0;30;47m" },
1177	text => "",	1386	text => "",
1178	render => sub { $sep x $self->{term}->ncol },	1387	render => sub { $sep x $self->{term}->ncol },
1179	activate => sub { },	1388	activate => sub { },
1180	});	1389	});
1181	}	1390	}
1182		1391
1183	sub add_title {	1392	=item $popup->add_button ($text, $cb)
1184	my ($self, $title) = @_;
1185		1393
1186	$self->add_item ({	1394	Adds a clickable button to the popup. C<$cb> is called whenever it is
1187	rend => { normal => "\x1b[38;5;11;44m", hover => "\x1b[38;5;11;44m", active => "\x1b[38;5;11;44m" },	1395	selected.
1188	text => $title,	1396
1189	activate => sub { },	1397	=cut
1190	});
1191	}
1192		1398
1193	sub add_button {	1399	sub add_button {
1194	my ($self, $text, $cb) = @_;	1400	my ($self, $text, $cb) = @_;
1195		1401
1196	$self->add_item ({ type => "button", text => $text, activate => $cb});	1402	$self->add_item ({ type => "button", text => $text, activate => $cb});
1197	}	1403	}
		1404
		1405	=item $popup->add_toggle ($text, $cb, $initial_value)
		1406
		1407	Adds a toggle/checkbox item to the popup. Teh callback gets called
		1408	whenever it gets toggled, with a boolean indicating its value as its first
		1409	argument.
		1410
		1411	=cut
1198		1412
1199	sub add_toggle {	1413	sub add_toggle {
1200	my ($self, $text, $cb, $value) = @_;	1414	my ($self, $text, $cb, $value) = @_;
1201		1415
1202	my $item; $item = {	1416	my $item; $item = {
1203	type => "button",	1417	type => "button",
1204	text => " $text",	1418	text => " $text",
1205	value => $value,	1419	value => $value,
1206	render => sub { ($_[0]{value} ? "* " : " ") . $text },	1420	render => sub { ($_[0]{value} ? "* " : " ") . $text },
1207	activate => sub { $cb->($_[0]{value} = !$_[0]{value}); },	1421	activate => sub { $cb->($_[1]{value} = !$_[1]{value}); },
1208	};	1422	};
1209		1423
1210	$self->add_item ($item);	1424	$self->add_item ($item);
1211	}	1425	}
		1426
		1427	=item $popup->show
		1428
		1429	Displays the popup (which is initially hidden).
		1430
		1431	=cut
1212		1432
1213	sub show {	1433	sub show {
1214	my ($self) = @_;	1434	my ($self) = @_;
1215		1435
1216	local $urxvt::popup::self = $self;	1436	local $urxvt::popup::self = $self;
1217		1437
		1438	my $env = $self->{term}->env;
		1439	# we can't hope to reproduce the locale algorithm, so nuke LC_ALL and set LC_CTYPE.
		1440	delete $env->{LC_ALL};
1218	local $ENV{LC_ALL} = $self->{term}->locale;	1441	$env->{LC_CTYPE} = $self->{term}->locale;
1219		1442
		1443	urxvt::term->new ($env, $self->{term}->resource ("name"),
1220	urxvt->new ("--perl-lib" => "", "--perl-ext-common" => "", "-pty-fd" => -1, "-sl" => 0, "-b" => 0,	1444	"--perl-lib" => "", "--perl-ext-common" => "", "-pty-fd" => -1, "-sl" => 0, "-b" => 0,
1221	"--transient-for" => $self->{term}->parent,	1445	"--transient-for" => $self->{term}->parent,
1222	"-display" => $self->{term}->display_id,	1446	"-display" => $self->{term}->display_id,
1223	"-pe" => "urxvt-popup")	1447	"-pe" => "urxvt-popup")
1224	or die "unable to create popup window\n";	1448	or die "unable to create popup window\n";
1225	}	1449	}
1226		1450
1227	sub DESTROY {	1451	sub DESTROY {
1228	my ($self) = @_;	1452	my ($self) = @_;
1229		1453
1230	delete $self->{term}{_destroy}{$self};	1454	delete $self->{term}{_destroy}{$self};
1231	$self->{term}->ungrab;	1455	$self->{term}->ungrab;
1232	}	1456	}
		1457
		1458	=back
1233		1459
1234	=head2 The C<urxvt::timer> Class	1460	=head2 The C<urxvt::timer> Class
1235		1461
1236	This class implements timer watchers/events. Time is represented as a	1462	This class implements timer watchers/events. Time is represented as a
1237	fractional number of seconds since the epoch. Example:	1463	fractional number of seconds since the epoch. Example:
…		…
1290		1516
1291	$term->{socket} = ...	1517	$term->{socket} = ...
1292	$term->{iow} = urxvt::iow	1518	$term->{iow} = urxvt::iow
1293	->new	1519	->new
1294	->fd (fileno $term->{socket})	1520	->fd (fileno $term->{socket})
1295	->events (1) # wait for read data	1521	->events (urxvt::EVENT_READ)
1296	->start	1522	->start
1297	->cb (sub {	1523	->cb (sub {
1298	my ($iow, $revents) = @_;	1524	my ($iow, $revents) = @_;
1299	# $revents must be 1 here, no need to check	1525	# $revents must be 1 here, no need to check
1300	sysread $term->{socket}, my $buf, 8192	1526	sysread $term->{socket}, my $buf, 8192
…		…
1317		1543
1318	Set the filedescriptor (not handle) to watch.	1544	Set the filedescriptor (not handle) to watch.
1319		1545
1320	=item $iow = $iow->events ($eventmask)	1546	=item $iow = $iow->events ($eventmask)
1321		1547
1322	Set the event mask to watch. Bit #0 (value C<1>) enables watching for read	1548	Set the event mask to watch. The only allowed values are
1323	data, Bit #1 (value C<2>) enables watching for write data.	1549	C<urxvt::EVENT_READ> and C<urxvt::EVENT_WRITE>, which might be ORed
		1550	together, or C<urxvt::EVENT_NONE>.
1324		1551
1325	=item $iow = $iow->start	1552	=item $iow = $iow->start
1326		1553
1327	Start watching for requested events on the given handle.	1554	Start watching for requested events on the given handle.
1328		1555

Diff Legend

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

Comparing rxvt-unicode/src/urxvt.pm (file contents): Revision 1.65 by root, Mon Jan 9 19:25:57 2006 UTC vs. Revision 1.81 by root, Thu Jan 12 00:12:40 2006 UTC

Diff Legend

Comparing rxvt-unicode/src/urxvt.pm (file contents):
Revision 1.65 by root, Mon Jan 9 19:25:57 2006 UTC vs.
Revision 1.81 by root, Thu Jan 12 00:12:40 2006 UTC