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

Comparing rxvt-unicode/src/urxvt.pm (file contents):
Revision 1.68 by root, Mon Jan 9 20:00:31 2006 UTC vs.
Revision 1.84 by root, Thu Jan 12 02:20:56 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 middle-clicked, the program specified in the
		91	resource 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
…		…
431	$msg .= "\n"	496	$msg .= "\n"
432	unless $msg =~ /\n$/;	497	unless $msg =~ /\n$/;
433	urxvt::warn ($msg);	498	urxvt::warn ($msg);
434	};	499	};
435		500
		501	# %ENV is the original startup environment
436	delete $ENV{IFS};	502	delete $ENV{IFS};
437	delete $ENV{CDPATH};	503	delete $ENV{CDPATH};
438	delete $ENV{BASH_ENV};	504	delete $ENV{BASH_ENV};
439	$ENV{PATH} = "/bin:/sbin:/usr/bin:/usr/sbin:/usr/local/bin:/usr/local/sbin:/opt/bin:/opt/sbin";	505	$ENV{PATH} = "/bin:/sbin:/usr/bin:/usr/sbin:/usr/local/bin:/usr/local/sbin:/opt/bin:/opt/sbin";
440	}	506	}
…		…
460	verbose 3, "loading extension '$path' into package '$pkg'";	526	verbose 3, "loading extension '$path' into package '$pkg'";
461		527
462	open my $fh, "<:raw", $path	528	open my $fh, "<:raw", $path
463	or die "$path: $!";	529	or die "$path: $!";
464		530
		531	my $source = untaint
465	my $source = untaint "package $pkg; use strict; use utf8;\n"	532	"package $pkg; use strict; use utf8;\n"
466	. "use base urxvt::term::proxy::;\n"	533	. "use base urxvt::term::extension::;\n"
467	. "#line 1 \"$path\"\n{\n"	534	. "#line 1 \"$path\"\n{\n"
468	. (do { local $/; <$fh> })	535	. (do { local $/; <$fh> })
469	. "\n};\n1";	536	. "\n};\n1";
470		537
		538	eval $source
471	eval $source or die "$path: $@";	539	or die "$path: $@";
472		540
473	$pkg	541	$pkg
474	}	542	}
475	}	543	}
476		544
…		…
486		554
487	my %ext_arg;	555	my %ext_arg;
488		556
489	for (map { split /,/, $TERM->resource ("perl_ext_$_") } 1, 2) {	557	for (map { split /,/, $TERM->resource ("perl_ext_$_") } 1, 2) {
490	if ($_ eq "default") {	558	if ($_ eq "default") {
491	$ext_arg{$_} \|\|= [] for qw(selection option-popup selection-popup);	559	$ext_arg{$_} \|\|= [] for qw(selection option-popup selection-popup searchable-scrollback);
492	} elsif (/^-(.*)$/) {	560	} elsif (/^-(.*)$/) {
493	delete $ext_arg{$1};	561	delete $ext_arg{$1};
494	} elsif (/^([^<]+)<(.*)>$/) {	562	} elsif (/^([^<]+)<(.*)>$/) {
495	push @{ $ext_arg{$1} }, $2;	563	push @{ $ext_arg{$1} }, $2;
496	} else {	564	} else {
…		…
530	}	598	}
531	}	599	}
532	}	600	}
533		601
534	if ($htype == 1) { # DESTROY	602	if ($htype == 1) { # DESTROY
535	# remove hooks if unused
536	if (my $hook = $TERM->{_hook}) {	603	if (my $hook = delete $TERM->{_hook}) {
537	for my $htype (0..$#$hook) {	604	for my $htype (0..$#$hook) {
538	$hook_count[$htype] -= scalar keys %{ $hook->[$htype] \|\| {} }	605	$hook_count[$htype] -= scalar keys %{ $hook->[$htype] \|\| {} }
539	or set_should_invoke $htype, 0;	606	or set_should_invoke $htype, 0;
540	}	607	}
541	}	608	}
…		…
548	}	615	}
549		616
550	$retval	617	$retval
551	}	618	}
552		619
553	# urxvt::term::proxy	620	sub exec_async(@) {
		621	my $pid = fork;
554		622
555	sub urxvt::term::proxy::AUTOLOAD {	623	return
556	$urxvt::term::proxy::AUTOLOAD =~ /:([^:]+)$/	624	if !defined $pid or $pid;
		625
		626	%ENV = %{ $TERM->env };
		627
		628	exec @_;
		629	_exit 255;
		630	}
		631
		632	# urxvt::term::extension
		633
		634	package urxvt::term::extension;
		635
		636	sub enable {
		637	my ($self, %hook) = @_;
		638	my $pkg = $self->{_pkg};
		639
		640	while (my ($name, $cb) = each %hook) {
		641	my $htype = $HOOKTYPE{uc $name};
		642	defined $htype
		643	or Carp::croak "unsupported hook type '$name'";
		644
		645	unless (exists $self->{term}{_hook}[$htype]{$pkg}) {
		646	$hook_count[$htype]++
		647	or urxvt::set_should_invoke $htype, 1;
		648	}
		649
		650	$self->{term}{_hook}[$htype]{$pkg} = $cb;
		651	}
		652	}
		653
		654	sub disable {
		655	my ($self, @hook) = @_;
		656	my $pkg = $self->{_pkg};
		657
		658	for my $name (@hook) {
		659	my $htype = $HOOKTYPE{uc $name};
		660	defined $htype
		661	or Carp::croak "unsupported hook type '$name'";
		662
		663	if (delete $self->{term}{_hook}[$htype]{$pkg}) {
		664	--$hook_count[$htype]
		665	or urxvt::set_should_invoke $htype, 0;
		666	}
		667	}
		668	}
		669
		670	our $AUTOLOAD;
		671
		672	sub AUTOLOAD {
		673	$AUTOLOAD =~ /:([^:]+)$/
557	or die "FATAL: \$AUTOLOAD '$urxvt::term::proxy::AUTOLOAD' unparsable";	674	or die "FATAL: \$AUTOLOAD '$AUTOLOAD' unparsable";
558		675
559	eval qq{	676	eval qq{
560	sub $urxvt::term::proxy::AUTOLOAD {	677	sub $AUTOLOAD {
561	my \$proxy = shift;	678	my \$proxy = shift;
562	\$proxy->{term}->$1 (\@_)	679	\$proxy->{term}->$1 (\@_)
563	}	680	}
564	1	681	1
565	} or die "FATAL: unable to compile method forwarder: $@";	682	} or die "FATAL: unable to compile method forwarder: $@";
566		683
567	goto &$urxvt::term::proxy::AUTOLOAD;	684	goto &$AUTOLOAD;
568	}	685	}
569		686
570	sub urxvt::term::proxy::DESTROY {	687	sub DESTROY {
571	# nop	688	# nop
572	}	689	}
573		690
574	# urxvt::destroy_hook	691	# urxvt::destroy_hook
575		692
…		…
585		702
586	=head2 The C<urxvt::anyevent> Class	703	=head2 The C<urxvt::anyevent> Class
587		704
588	The sole purpose of this class is to deliver an interface to the	705	The sole purpose of this class is to deliver an interface to the
589	C<AnyEvent> module - any module using it will work inside urxvt without	706	C<AnyEvent> module - any module using it will work inside urxvt without
590	further work. The only exception is that you cannot wait on condition	707	further programming. The only exception is that you cannot wait on
591	variables, but non-blocking condvar use is ok. What this means is that you	708	condition variables, but non-blocking condvar use is ok. What this means
592	cannot use blocking APIs, but the non-blocking variant should work.	709	is that you cannot use blocking APIs, but the non-blocking variant should
		710	work.
593		711
594	=cut	712	=cut
595		713
596	our $VERSION = 1;	714	our $VERSION = 1;
597		715
…		…
642	${$_[0]}++;	760	${$_[0]}++;
643	}	761	}
644		762
645	sub urxvt::anyevent::condvar::wait {	763	sub urxvt::anyevent::condvar::wait {
646	unless (${$_[0]}) {	764	unless (${$_[0]}) {
647	require Carp;
648	Carp::croak ("AnyEvent->condvar blocking wait unsupported in urxvt, use a non-blocking API");	765	Carp::croak "AnyEvent->condvar blocking wait unsupported in urxvt, use a non-blocking API";
649	}	766	}
650	}	767	}
651		768
652	package urxvt::term;	769	package urxvt::term;
653		770
…		…
660	# find on_xxx subs in the package and register them	777	# find on_xxx subs in the package and register them
661	# as hooks	778	# as hooks
662	sub register_package {	779	sub register_package {
663	my ($self, $pkg, $argv) = @_;	780	my ($self, $pkg, $argv) = @_;
664		781
665	my $proxy = bless { argv => $argv }, $pkg;	782	my $proxy = bless {
		783	_pkg => $pkg,
		784	argv => $argv,
		785	}, $pkg;
666	Scalar::Util::weaken ($proxy->{term} = $TERM);	786	Scalar::Util::weaken ($proxy->{term} = $self);
667		787
668	$self->{_pkg}{$pkg} = $proxy;	788	$self->{_pkg}{$pkg} = $proxy;
669		789
670	for my $htype (0.. $#HOOKNAME) {	790	for my $name (@HOOKNAME) {
671	my $name = $HOOKNAME[$htype];
672
673	my $ref = $pkg->can ("on_" . lc $name)	791	if (my $ref = $pkg->can ("on_" . lc $name)) {
674	or next;	792	$proxy->enable ($name => $ref);
675		793	}
676	$self->{_hook}[$htype]{$pkg} = $ref;
677	$hook_count[$htype]++
678	or urxvt::set_should_invoke $htype, 1;
679	}	794	}
680	}	795	}
681		796
		797	=item $term = new urxvt::term $envhashref, $rxvtname, [arg...]
		798
		799	Creates a new terminal, very similar as if you had started it with system
		800	C<$rxvtname, arg...>. C<$envhashref> must be a reference to a C<%ENV>-like
		801	hash which defines the environment of the new terminal.
		802
		803	Croaks (and probably outputs an error message) if the new instance
		804	couldn't be created. Returns C<undef> if the new instance didn't
		805	initialise perl, and the terminal object otherwise. The C<init> and
		806	C<start> hooks will be called during this call.
		807
		808	=cut
		809
		810	sub new {
		811	my ($class, $env, @args) = @_;
		812
		813	_new ([ map "$_=$env->{$_}", keys %$env ], @args);
		814	}
		815
682	=item $term->destroy	816	=item $term->destroy
683		817
684	Destroy the terminal object (close the window, free resources etc.).	818	Destroy the terminal object (close the window, free resources
		819	etc.). Please note that @@RXVT_NAME@@ will not exit as long as any event
		820	watchers (timers, io watchers) are still active.
685		821
686	=item $isset = $term->option ($optval[, $set])	822	=item $isset = $term->option ($optval[, $set])
687		823
688	Returns true if the option specified by C<$optval> is enabled, and	824	Returns true if the option specified by C<$optval> is enabled, and
689	optionally change it. All option values are stored by name in the hash	825	optionally change it. All option values are stored by name in the hash
…		…
739	my ($self, $name) = (shift, shift);	875	my ($self, $name) = (shift, shift);
740	unshift @_, $self, $name, ($name =~ s/\s\+\s(\d+)$// ? $1 : 0);	876	unshift @_, $self, $name, ($name =~ s/\s\+\s(\d+)$// ? $1 : 0);
741	&urxvt::term::_resource	877	&urxvt::term::_resource
742	}	878	}
743		879
		880	=item $value = $term->x_resource ($pattern)
		881
		882	Returns the X-Resource for the given pattern, excluding the program or
		883	class name, i.e. C<< $term->x_resource ("boldFont") >> should return the
		884	same value as used by this instance of rxvt-unicode. Returns C<undef> if no
		885	resource with that pattern exists.
		886
		887	This method should only be called during the C<on_start> hook, as there is
		888	only one resource database per display, and later invocations might return
		889	the wrong resources.
		890
		891	=item $success = $term->parse_keysym ($keysym_spec, $command_string)
		892
		893	Adds a keymap translation exactly as specified via a resource. See the
		894	C<keysym> resource in the @@RXVT_NAME@@(1) manpage.
		895
744	=item $rend = $term->rstyle ([$new_rstyle])	896	=item $rend = $term->rstyle ([$new_rstyle])
745		897
746	Return and optionally change the current rendition. Text that is output by	898	Return and optionally change the current rendition. Text that is output by
747	the terminal application will use this style.	899	the terminal application will use this style.
748		900
…		…
767		919
768	=item $oldtext = $term->selection ([$newtext])	920	=item $oldtext = $term->selection ([$newtext])
769		921
770	Return the current selection text and optionally replace it by C<$newtext>.	922	Return the current selection text and optionally replace it by C<$newtext>.
771		923
772	#=item $term->overlay ($x, $y, $text)	924	=item $term->overlay_simple ($x, $y, $text)
773	#	925
774	#Create a simple multi-line overlay box. See the next method for details.	926	Create a simple multi-line overlay box. See the next method for details.
775	#	927
776	#=cut	928	=cut
777	#	929
778	#sub urxvt::term::scr_overlay {	930	sub overlay_simple {
779	# my ($self, $x, $y, $text) = @_;	931	my ($self, $x, $y, $text) = @_;
780	#	932
781	# my @lines = split /\n/, $text;	933	my @lines = split /\n/, $text;
782	#	934
783	# my $w = 0;	935	my $w = List::Util::max map $self->strwidth ($_), @lines;
784	# for (map $self->strwidth ($_), @lines) {	936
785	# $w = $_ if $w < $_;
786	# }
787	#
788	# $self->scr_overlay_new ($x, $y, $w, scalar @lines);	937	my $overlay = $self->overlay ($x, $y, $w, scalar @lines);
789	# $self->scr_overlay_set (0, $_, $lines[$_]) for 0.. $#lines;	938	$overlay->set (0, $_, $lines[$_]) for 0.. $#lines;
790	#}	939
		940	$overlay
		941	}
791		942
792	=item $term->overlay ($x, $y, $width, $height[, $rstyle[, $border]])	943	=item $term->overlay ($x, $y, $width, $height[, $rstyle[, $border]])
793		944
794	Create a new (empty) overlay at the given position with the given	945	Create a new (empty) overlay at the given position with the given
795	width/height. C<$rstyle> defines the initial rendition style	946	width/height. C<$rstyle> defines the initial rendition style
…		…
862		1013
863	=item $string = $term->locale_decode ($octets)	1014	=item $string = $term->locale_decode ($octets)
864		1015
865	Convert the given locale-encoded octets into a perl string.	1016	Convert the given locale-encoded octets into a perl string.
866		1017
		1018	=item $term->scr_xor_span ($beg_row, $beg_col, $end_row, $end_col[, $rstyle])
		1019
		1020	XORs the rendition values in the given span with the provided value
		1021	(default: C<RS_RVid>). Useful in refresh hooks to provide effects similar
		1022	to the selection.
		1023
		1024	=item $term->scr_xor_rect ($beg_row, $beg_col, $end_row, $end_col[, $rstyle1[, $rstyle2]])
		1025
		1026	Similar to C<scr_xor_span>, but xors a rectangle instead. Trailing
		1027	whitespace will additionally be xored with the C<$rstyle2>, which defaults
		1028	to C<RS_RVid \| RS_Uline>, which removes reverse video again and underlines
		1029	it instead.
		1030
		1031	=item $term->scr_bell
		1032
		1033	Ring the bell!
		1034
867	=item $term->scr_add_lines ($string)	1035	=item $term->scr_add_lines ($string)
868		1036
869	Write the given text string to the screen, as if output by the application	1037	Write the given text string to the screen, as if output by the application
870	running inside the terminal. It may not contain command sequences (escape	1038	running inside the terminal. It may not contain command sequences (escape
871	codes), but is free to use line feeds, carriage returns and tabs. The	1039	codes), but is free to use line feeds, carriage returns and tabs. The
…		…
885		1053
886	Write the octets given in C<$data> to the tty (i.e. as program input). To	1054	Write the octets given in C<$data> to the tty (i.e. as program input). To
887	pass characters instead of octets, you should convert your strings first	1055	pass characters instead of octets, you should convert your strings first
888	to the locale-specific encoding using C<< $term->locale_encode >>.	1056	to the locale-specific encoding using C<< $term->locale_encode >>.
889		1057
		1058	=item $old_events = $term->pty_ev_events ([$new_events])
		1059
		1060	Replaces the event mask of the pty watcher by the given event mask. Can
		1061	be used to suppress input and output handling to the pty/tty. See the
		1062	description of C<< urxvt::timer->events >>. Make sure to always restore
		1063	the previous value.
		1064
890	=item $windowid = $term->parent	1065	=item $windowid = $term->parent
891		1066
892	Return the window id of the toplevel window.	1067	Return the window id of the toplevel window.
893		1068
894	=item $windowid = $term->vt	1069	=item $windowid = $term->vt
…		…
919		1094
920	=item $lines_in_scrollback = $term->nsaved	1095	=item $lines_in_scrollback = $term->nsaved
921		1096
922	Return various integers describing terminal characteristics.	1097	Return various integers describing terminal characteristics.
923		1098
		1099	=item $x_display = $term->display_id
		1100
		1101	Return the DISPLAY used by rxvt-unicode.
		1102
924	=item $lc_ctype = $term->locale	1103	=item $lc_ctype = $term->locale
925		1104
926	Returns the LC_CTYPE category string used by this rxvt-unicode.	1105	Returns the LC_CTYPE category string used by this rxvt-unicode.
927		1106
928	=item $x_display = $term->display_id	1107	=item $env = $term->env
929		1108
930	Return the DISPLAY used by rxvt-unicode.	1109	Returns a copy of the environment in effect for the terminal as a hashref
		1110	similar to C<\%ENV>.
		1111
		1112	=cut
		1113
		1114	sub env {
		1115	if (my $env = $_[0]->_env) {
		1116	+{ map /^([^=]+)(?:=(.*))?$/s && ($1 => $2), @$env }
		1117	} else {
		1118	+{ %ENV }
		1119	}
		1120	}
931		1121
932	=item $modifiermask = $term->ModLevel3Mask	1122	=item $modifiermask = $term->ModLevel3Mask
933		1123
934	=item $modifiermask = $term->ModMetaMask	1124	=item $modifiermask = $term->ModMetaMask
935		1125
…		…
1175	$item->{render} \|\|= sub { $_[0]{text} };	1365	$item->{render} \|\|= sub { $_[0]{text} };
1176		1366
1177	push @{ $self->{item} }, $item;	1367	push @{ $self->{item} }, $item;
1178	}	1368	}
1179		1369
		1370	=item $popup->add_title ($title)
		1371
		1372	Adds a non-clickable title to the popup.
		1373
		1374	=cut
		1375
		1376	sub add_title {
		1377	my ($self, $title) = @_;
		1378
		1379	$self->add_item ({
		1380	rend => { normal => "\x1b[38;5;11;44m", hover => "\x1b[38;5;11;44m", active => "\x1b[38;5;11;44m" },
		1381	text => $title,
		1382	activate => sub { },
		1383	});
		1384	}
		1385
		1386	=item $popup->add_separator ([$sepchr])
		1387
		1388	Creates a separator, optionally using the character given as C<$sepchr>.
		1389
		1390	=cut
		1391
1180	sub add_separator {	1392	sub add_separator {
1181	my ($self, $sep) = @_;	1393	my ($self, $sep) = @_;
1182		1394
1183	$sep \|\|= "=";	1395	$sep \|\|= "=";
1184		1396
…		…
1188	render => sub { $sep x $self->{term}->ncol },	1400	render => sub { $sep x $self->{term}->ncol },
1189	activate => sub { },	1401	activate => sub { },
1190	});	1402	});
1191	}	1403	}
1192		1404
1193	sub add_title {	1405	=item $popup->add_button ($text, $cb)
1194	my ($self, $title) = @_;
1195		1406
1196	$self->add_item ({	1407	Adds a clickable button to the popup. C<$cb> is called whenever it is
1197	rend => { normal => "\x1b[38;5;11;44m", hover => "\x1b[38;5;11;44m", active => "\x1b[38;5;11;44m" },	1408	selected.
1198	text => $title,	1409
1199	activate => sub { },	1410	=cut
1200	});
1201	}
1202		1411
1203	sub add_button {	1412	sub add_button {
1204	my ($self, $text, $cb) = @_;	1413	my ($self, $text, $cb) = @_;
1205		1414
1206	$self->add_item ({ type => "button", text => $text, activate => $cb});	1415	$self->add_item ({ type => "button", text => $text, activate => $cb});
1207	}	1416	}
		1417
		1418	=item $popup->add_toggle ($text, $cb, $initial_value)
		1419
		1420	Adds a toggle/checkbox item to the popup. Teh callback gets called
		1421	whenever it gets toggled, with a boolean indicating its value as its first
		1422	argument.
		1423
		1424	=cut
1208		1425
1209	sub add_toggle {	1426	sub add_toggle {
1210	my ($self, $text, $cb, $value) = @_;	1427	my ($self, $text, $cb, $value) = @_;
1211		1428
1212	my $item; $item = {	1429	my $item; $item = {
1213	type => "button",	1430	type => "button",
1214	text => " $text",	1431	text => " $text",
1215	value => $value,	1432	value => $value,
1216	render => sub { ($_[0]{value} ? "* " : " ") . $text },	1433	render => sub { ($_[0]{value} ? "* " : " ") . $text },
1217	activate => sub { $cb->($_[0]{value} = !$_[0]{value}); },	1434	activate => sub { $cb->($_[1]{value} = !$_[1]{value}); },
1218	};	1435	};
1219		1436
1220	$self->add_item ($item);	1437	$self->add_item ($item);
1221	}	1438	}
		1439
		1440	=item $popup->show
		1441
		1442	Displays the popup (which is initially hidden).
		1443
		1444	=cut
1222		1445
1223	sub show {	1446	sub show {
1224	my ($self) = @_;	1447	my ($self) = @_;
1225		1448
1226	local $urxvt::popup::self = $self;	1449	local $urxvt::popup::self = $self;
1227		1450
		1451	my $env = $self->{term}->env;
		1452	# we can't hope to reproduce the locale algorithm, so nuke LC_ALL and set LC_CTYPE.
		1453	delete $env->{LC_ALL};
1228	local $ENV{LC_ALL} = $self->{term}->locale;	1454	$env->{LC_CTYPE} = $self->{term}->locale;
1229		1455
		1456	urxvt::term->new ($env, $self->{term}->resource ("name"),
1230	urxvt->new ("--perl-lib" => "", "--perl-ext-common" => "", "-pty-fd" => -1, "-sl" => 0, "-b" => 0,	1457	"--perl-lib" => "", "--perl-ext-common" => "", "-pty-fd" => -1, "-sl" => 0, "-b" => 0,
1231	"--transient-for" => $self->{term}->parent,	1458	"--transient-for" => $self->{term}->parent,
1232	"-display" => $self->{term}->display_id,	1459	"-display" => $self->{term}->display_id,
1233	"-pe" => "urxvt-popup")	1460	"-pe" => "urxvt-popup")
1234	or die "unable to create popup window\n";	1461	or die "unable to create popup window\n";
1235	}	1462	}
1236		1463
1237	sub DESTROY {	1464	sub DESTROY {
1238	my ($self) = @_;	1465	my ($self) = @_;
1239		1466
1240	delete $self->{term}{_destroy}{$self};	1467	delete $self->{term}{_destroy}{$self};
1241	$self->{term}->ungrab;	1468	$self->{term}->ungrab;
1242	}	1469	}
		1470
		1471	=back
1243		1472
1244	=head2 The C<urxvt::timer> Class	1473	=head2 The C<urxvt::timer> Class
1245		1474
1246	This class implements timer watchers/events. Time is represented as a	1475	This class implements timer watchers/events. Time is represented as a
1247	fractional number of seconds since the epoch. Example:	1476	fractional number of seconds since the epoch. Example:
…		…
1300		1529
1301	$term->{socket} = ...	1530	$term->{socket} = ...
1302	$term->{iow} = urxvt::iow	1531	$term->{iow} = urxvt::iow
1303	->new	1532	->new
1304	->fd (fileno $term->{socket})	1533	->fd (fileno $term->{socket})
1305	->events (1) # wait for read data	1534	->events (urxvt::EVENT_READ)
1306	->start	1535	->start
1307	->cb (sub {	1536	->cb (sub {
1308	my ($iow, $revents) = @_;	1537	my ($iow, $revents) = @_;
1309	# $revents must be 1 here, no need to check	1538	# $revents must be 1 here, no need to check
1310	sysread $term->{socket}, my $buf, 8192	1539	sysread $term->{socket}, my $buf, 8192
…		…
1327		1556
1328	Set the filedescriptor (not handle) to watch.	1557	Set the filedescriptor (not handle) to watch.
1329		1558
1330	=item $iow = $iow->events ($eventmask)	1559	=item $iow = $iow->events ($eventmask)
1331		1560
1332	Set the event mask to watch. Bit #0 (value C<1>) enables watching for read	1561	Set the event mask to watch. The only allowed values are
1333	data, Bit #1 (value C<2>) enables watching for write data.	1562	C<urxvt::EVENT_READ> and C<urxvt::EVENT_WRITE>, which might be ORed
		1563	together, or C<urxvt::EVENT_NONE>.
1334		1564
1335	=item $iow = $iow->start	1565	=item $iow = $iow->start
1336		1566
1337	Start watching for requested events on the given handle.	1567	Start watching for requested events on the given handle.
1338		1568

Diff Legend

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

Comparing rxvt-unicode/src/urxvt.pm (file contents): Revision 1.68 by root, Mon Jan 9 20:00:31 2006 UTC vs. Revision 1.84 by root, Thu Jan 12 02:20:56 2006 UTC

Diff Legend

Comparing rxvt-unicode/src/urxvt.pm (file contents):
Revision 1.68 by root, Mon Jan 9 20:00:31 2006 UTC vs.
Revision 1.84 by root, Thu Jan 12 02:20:56 2006 UTC