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

Comparing rxvt-unicode/src/urxvt.pm (file contents):
Revision 1.62 by root, Mon Jan 9 02:06:43 2006 UTC vs.
Revision 1.85 by root, Thu Jan 12 03:32: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
…		…
185	=item on_sel_extend $term	230	=item on_sel_extend $term
186		231
187	Called whenever the user tries to extend the selection (e.g. with a double	232	Called whenever the user tries to extend the selection (e.g. with a double
188	click) and is either supposed to return false (normal operation), or	233	click) and is either supposed to return false (normal operation), or
189	should extend the selection itelf and return true to suppress the built-in	234	should extend the selection itelf and return true to suppress the built-in
190	processing.	235	processing. This can happen multiple times, as long as the callback
		236	returns true, it will be called on every further click by the user and is
		237	supposed to enlarge the selection more and more, if possible.
191		238
192	See the F<selection> example extension.	239	See the F<selection> example extension.
193		240
194	=item on_view_change $term, $offset	241	=item on_view_change $term, $offset
195		242
…		…
226	can filter/change and output the text yourself by returning a true value	273	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	274	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	275	might be very slow, however, as your hook is called for B<all> text being
229	output.	276	output.
230		277
		278	=item on_tt_write $term, $octets
		279
		280	Called whenever some data is written to the tty/pty and can be used to
		281	suppress or filter tty input.
		282
231	=item on_line_update $term, $row	283	=item on_line_update $term, $row
232		284
233	Called whenever a line was updated or changed. Can be used to filter	285	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	286	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,	287	that are being shown will be filtered, and, due to performance reasons,
…		…
267	=item on_focus_out $term	319	=item on_focus_out $term
268		320
269	Called wheneever the window loses keyboard focus, before rxvt-unicode does	321	Called wheneever the window loses keyboard focus, before rxvt-unicode does
270	focus out processing.	322	focus out processing.
271		323
272	=item on_key_press $term, $event, $octets	324	=item on_key_press $term, $event, $keysym, $octets
273		325
274	=item on_key_release $term, $event	326	=item on_key_release $term, $event, $keysym
275		327
276	=item on_button_press $term, $event	328	=item on_button_press $term, $event
277		329
278	=item on_button_release $term, $event	330	=item on_button_release $term, $event
279		331
…		…
295		347
296	subwindow.	348	subwindow.
297		349
298	=back	350	=back
299		351
		352	=cut
		353
		354	package urxvt;
		355
		356	use utf8;
		357	use strict;
		358	use Carp ();
		359	use Scalar::Util ();
		360	use List::Util ();
		361
		362	our $VERSION = 1;
		363	our $TERM;
		364	our @HOOKNAME;
		365	our %HOOKTYPE = map +($HOOKNAME[$_] => $_), 0..$#HOOKNAME;
		366	our %OPTION;
		367
		368	our $LIBDIR;
		369	our $RESNAME;
		370	our $RESCLASS;
		371	our $RXVTNAME;
		372
300	=head2 Variables in the C<urxvt> Package	373	=head2 Variables in the C<urxvt> Package
301		374
302	=over 4	375	=over 4
		376
		377	=item $urxvt::LIBDIR
		378
		379	The rxvt-unicode library directory, where, among other things, the perl
		380	modules and scripts are stored.
		381
		382	=item $urxvt::RESCLASS, $urxvt::RESCLASS
		383
		384	The resource class and name rxvt-unicode uses to look up X resources.
		385
		386	=item $urxvt::RXVTNAME
		387
		388	The basename of the installed binaries, usually C<urxvt>.
303		389
304	=item $urxvt::TERM	390	=item $urxvt::TERM
305		391
306	The current terminal. This variable stores the current C<urxvt::term>	392	The current terminal. This variable stores the current C<urxvt::term>
307	object, whenever a callback/hook is executing.	393	object, whenever a callback/hook is executing.
…		…
309	=back	395	=back
310		396
311	=head2 Functions in the C<urxvt> Package	397	=head2 Functions in the C<urxvt> Package
312		398
313	=over 4	399	=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		400
323	=item urxvt::fatal $errormessage	401	=item urxvt::fatal $errormessage
324		402
325	Fatally aborts execution with the given error message. Avoid at all	403	Fatally aborts execution with the given error message. Avoid at all
326	costs! The only time this is acceptable is when the terminal process	404	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	410	newline. The module also overwrites the C<warn> builtin with a function
333	that calls this function.	411	that calls this function.
334		412
335	Using this function has the advantage that its output ends up in the	413	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.	414	correct place, e.g. on stderr of the connecting urxvtc client.
		415
		416	Messages have a size limit of 1023 bytes currently.
337		417
338	=item $is_safe = urxvt::safe	418	=item $is_safe = urxvt::safe
339		419
340	Returns true when it is safe to do potentially unsafe things, such as	420	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	421	evaluating perl code specified by the user. This is true when urxvt was
…		…
386		466
387	=item $background = urxvt::GET_BASEBG $rend	467	=item $background = urxvt::GET_BASEBG $rend
388		468
389	Return the foreground/background colour index, respectively.	469	Return the foreground/background colour index, respectively.
390		470
391	=item $rend = urxvt::SET_FGCOLOR ($rend, $new_colour)	471	=item $rend = urxvt::SET_FGCOLOR $rend, $new_colour
392		472
393	=item $rend = urxvt::SET_BGCOLOR ($rend, $new_colour)	473	=item $rend = urxvt::SET_BGCOLOR $rend, $new_colour
394		474
395	Replace the foreground/background colour in the rendition mask with the	475	Replace the foreground/background colour in the rendition mask with the
396	specified one.	476	specified one.
397		477
398	=item $value = urxvt::GET_CUSTOM ($rend)	478	=item $value = urxvt::GET_CUSTOM $rend
399		479
400	Return the "custom" value: Every rendition has 5 bits for use by	480	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	481	extensions. They can be set and changed as you like and are initially
402	zero.	482	zero.
403		483
404	=item $rend = urxvt::SET_CUSTOM ($rend, $new_value)	484	=item $rend = urxvt::SET_CUSTOM $rend, $new_value
405		485
406	Change the custom value.	486	Change the custom value.
407		487
408	=back	488	=back
409		489
410	=cut	490	=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		491
425	BEGIN {	492	BEGIN {
426	urxvt->bootstrap;	493	urxvt->bootstrap;
427		494
428	# overwrite perl's warn	495	# overwrite perl's warn
…		…
431	$msg .= "\n"	498	$msg .= "\n"
432	unless $msg =~ /\n$/;	499	unless $msg =~ /\n$/;
433	urxvt::warn ($msg);	500	urxvt::warn ($msg);
434	};	501	};
435		502
		503	# %ENV is the original startup environment
436	delete $ENV{IFS};	504	delete $ENV{IFS};
437	delete $ENV{CDPATH};	505	delete $ENV{CDPATH};
438	delete $ENV{BASH_ENV};	506	delete $ENV{BASH_ENV};
439	$ENV{PATH} = "/bin:/sbin:/usr/bin:/usr/sbin:/usr/local/bin:/usr/local/sbin:/opt/bin:/opt/sbin";	507	$ENV{PATH} = "/bin:/sbin:/usr/bin:/usr/sbin:/usr/local/bin:/usr/local/sbin:/opt/bin:/opt/sbin";
440	}	508	}
…		…
445	sub verbose {	513	sub verbose {
446	my ($level, $msg) = @_;	514	my ($level, $msg) = @_;
447	warn "$msg\n" if $level <= $verbosity;	515	warn "$msg\n" if $level <= $verbosity;
448	}	516	}
449		517
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";	518	my $extension_pkg = "extension0000";
468	my %extension_pkg;	519	my %extension_pkg;
469		520
470	# load a single script into its own package, once only	521	# load a single script into its own package, once only
471	sub extension_package($) {	522	sub extension_package($) {
…		…
477	verbose 3, "loading extension '$path' into package '$pkg'";	528	verbose 3, "loading extension '$path' into package '$pkg'";
478		529
479	open my $fh, "<:raw", $path	530	open my $fh, "<:raw", $path
480	or die "$path: $!";	531	or die "$path: $!";
481		532
		533	my $source = untaint
482	my $source = untaint "package $pkg; use strict; use utf8;\n"	534	"package $pkg; use strict; use utf8;\n"
483	. "use base urxvt::term::proxy::;\n"	535	. "use base urxvt::term::extension::;\n"
484	. "#line 1 \"$path\"\n{\n"	536	. "#line 1 \"$path\"\n{\n"
485	. (do { local $/; <$fh> })	537	. (do { local $/; <$fh> })
486	. "\n};\n1";	538	. "\n};\n1";
487		539
		540	eval $source
488	eval $source or die "$path: $@";	541	or die "$path: $@";
489		542
490	$pkg	543	$pkg
491	}	544	}
492	}	545	}
493		546
…		…
499	my $htype = shift;	552	my $htype = shift;
500		553
501	if ($htype == 0) { # INIT	554	if ($htype == 0) { # INIT
502	my @dirs = ((split /:/, $TERM->resource ("perl_lib")), "$LIBDIR/perl");	555	my @dirs = ((split /:/, $TERM->resource ("perl_lib")), "$LIBDIR/perl");
503		556
504	my %want_ext;	557	my %ext_arg;
505		558
506	for (map { split /,/, $TERM->resource ("perl_ext_$_") } 1, 2) {	559	for (map { split /,/, $TERM->resource ("perl_ext_$_") } 1, 2) {
507	if ($_ eq "default") {	560	if ($_ eq "default") {
508	$want_ext{$_}++ for qw(selection option-popup selection-popup);	561	$ext_arg{$_} \|\|= [] for qw(selection option-popup selection-popup searchable-scrollback);
509	} elsif (/^-(.*)$/) {	562	} elsif (/^-(.*)$/) {
510	delete $want_ext{$1};	563	delete $ext_arg{$1};
		564	} elsif (/^([^<]+)<(.*)>$/) {
		565	push @{ $ext_arg{$1} }, $2;
511	} else {	566	} else {
512	$want_ext{$_}++;	567	$ext_arg{$_} \|\|= [];
513	}	568	}
514	}	569	}
515		570
516	for my $ext (keys %want_ext) {	571	while (my ($ext, $argv) = each %ext_arg) {
517	my @files = grep -f $_, map "$_/$ext", @dirs;	572	my @files = grep -f $_, map "$_/$ext", @dirs;
518		573
519	if (@files) {	574	if (@files) {
520	register_package extension_package $files[0];	575	$TERM->register_package (extension_package $files[0], $argv);
521	} else {	576	} else {
522	warn "perl extension '$ext' not found in perl library search path\n";	577	warn "perl extension '$ext' not found in perl library search path\n";
523	}	578	}
524	}	579	}
525		580
…		…
534	if $verbosity >= 10;	589	if $verbosity >= 10;
535		590
536	keys %$cb;	591	keys %$cb;
537		592
538	while (my ($pkg, $cb) = each %$cb) {	593	while (my ($pkg, $cb) = each %$cb) {
539	eval {	594	$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;	595	and last;
548	};	596
549	if ($@) {	597	if ($@) {
550	$TERM->ungrab; # better to lose the grab than the session	598	$TERM->ungrab; # better to lose the grab than the session
551	warn $@;	599	warn $@;
552	}	600	}
553	}	601	}
		602
		603	verbose 11, "$HOOKNAME[$htype] returning <$retval>"
		604	if $verbosity >= 11;
554	}	605	}
555		606
556	if ($htype == 1) { # DESTROY	607	if ($htype == 1) { # DESTROY
557	# remove hooks if unused
558	if (my $hook = $TERM->{_hook}) {	608	if (my $hook = delete $TERM->{_hook}) {
559	for my $htype (0..$#$hook) {	609	for my $htype (0..$#$hook) {
560	$hook_count[$htype] -= scalar keys %{ $hook->[$htype] \|\| {} }	610	$hook_count[$htype] -= scalar keys %{ $hook->[$htype] \|\| {} }
561	or set_should_invoke $htype, 0;	611	or set_should_invoke $htype, 0;
562	}	612	}
563	}	613	}
…		…
570	}	620	}
571		621
572	$retval	622	$retval
573	}	623	}
574		624
575	# urxvt::term::proxy	625	sub exec_async(@) {
		626	my $pid = fork;
576		627
577	sub urxvt::term::proxy::AUTOLOAD {	628	return
578	$urxvt::term::proxy::AUTOLOAD =~ /:([^:]+)$/	629	if !defined $pid or $pid;
		630
		631	%ENV = %{ $TERM->env };
		632
		633	exec @_;
		634	_exit 255;
		635	}
		636
		637	# urxvt::term::extension
		638
		639	package urxvt::term::extension;
		640
		641	sub enable {
		642	my ($self, %hook) = @_;
		643	my $pkg = $self->{_pkg};
		644
		645	while (my ($name, $cb) = each %hook) {
		646	my $htype = $HOOKTYPE{uc $name};
		647	defined $htype
		648	or Carp::croak "unsupported hook type '$name'";
		649
		650	unless (exists $self->{term}{_hook}[$htype]{$pkg}) {
		651	$hook_count[$htype]++
		652	or urxvt::set_should_invoke $htype, 1;
		653	}
		654
		655	$self->{term}{_hook}[$htype]{$pkg} = $cb;
		656	}
		657	}
		658
		659	sub disable {
		660	my ($self, @hook) = @_;
		661	my $pkg = $self->{_pkg};
		662
		663	for my $name (@hook) {
		664	my $htype = $HOOKTYPE{uc $name};
		665	defined $htype
		666	or Carp::croak "unsupported hook type '$name'";
		667
		668	if (delete $self->{term}{_hook}[$htype]{$pkg}) {
		669	--$hook_count[$htype]
		670	or urxvt::set_should_invoke $htype, 0;
		671	}
		672	}
		673	}
		674
		675	our $AUTOLOAD;
		676
		677	sub AUTOLOAD {
		678	$AUTOLOAD =~ /:([^:]+)$/
579	or die "FATAL: \$AUTOLOAD '$urxvt::term::proxy::AUTOLOAD' unparsable";	679	or die "FATAL: \$AUTOLOAD '$AUTOLOAD' unparsable";
580		680
581	eval qq{	681	eval qq{
582	sub $urxvt::term::proxy::AUTOLOAD {	682	sub $AUTOLOAD {
583	my \$proxy = shift;	683	my \$proxy = shift;
584	\$proxy->{term}->$1 (\@_)	684	\$proxy->{term}->$1 (\@_)
585	}	685	}
586	1	686	1
587	} or die "FATAL: unable to compile method forwarder: $@";	687	} or die "FATAL: unable to compile method forwarder: $@";
588		688
589	goto &$urxvt::term::proxy::AUTOLOAD;	689	goto &$AUTOLOAD;
590	}	690	}
591		691
592	sub urxvt::term::proxy::DESTROY {	692	sub DESTROY {
593	# nop	693	# nop
594	}	694	}
595		695
596	# urxvt::destroy_hook	696	# urxvt::destroy_hook
597		697
…		…
607		707
608	=head2 The C<urxvt::anyevent> Class	708	=head2 The C<urxvt::anyevent> Class
609		709
610	The sole purpose of this class is to deliver an interface to the	710	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	711	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	712	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	713	condition variables, but non-blocking condvar use is ok. What this means
614	cannot use blocking APIs, but the non-blocking variant should work.	714	is that you cannot use blocking APIs, but the non-blocking variant should
		715	work.
615		716
616	=cut	717	=cut
617		718
618	our $VERSION = 1;	719	our $VERSION = 1;
619		720
…		…
664	${$_[0]}++;	765	${$_[0]}++;
665	}	766	}
666		767
667	sub urxvt::anyevent::condvar::wait {	768	sub urxvt::anyevent::condvar::wait {
668	unless (${$_[0]}) {	769	unless (${$_[0]}) {
669	require Carp;
670	Carp::croak ("AnyEvent->condvar blocking wait unsupported in urxvt, use a non-blocking API");	770	Carp::croak "AnyEvent->condvar blocking wait unsupported in urxvt, use a non-blocking API";
671	}	771	}
672	}	772	}
673		773
674	package urxvt::term;	774	package urxvt::term;
675		775
676	=head2 The C<urxvt::term> Class	776	=head2 The C<urxvt::term> Class
677		777
678	=over 4	778	=over 4
679		779
		780	=cut
		781
		782	# find on_xxx subs in the package and register them
		783	# as hooks
		784	sub register_package {
		785	my ($self, $pkg, $argv) = @_;
		786
		787	my $proxy = bless {
		788	_pkg => $pkg,
		789	argv => $argv,
		790	}, $pkg;
		791	Scalar::Util::weaken ($proxy->{term} = $self);
		792
		793	$self->{_pkg}{$pkg} = $proxy;
		794
		795	for my $name (@HOOKNAME) {
		796	if (my $ref = $pkg->can ("on_" . lc $name)) {
		797	$proxy->enable ($name => $ref);
		798	}
		799	}
		800	}
		801
		802	=item $term = new urxvt::term $envhashref, $rxvtname, [arg...]
		803
		804	Creates a new terminal, very similar as if you had started it with system
		805	C<$rxvtname, arg...>. C<$envhashref> must be a reference to a C<%ENV>-like
		806	hash which defines the environment of the new terminal.
		807
		808	Croaks (and probably outputs an error message) if the new instance
		809	couldn't be created. Returns C<undef> if the new instance didn't
		810	initialise perl, and the terminal object otherwise. The C<init> and
		811	C<start> hooks will be called during this call.
		812
		813	=cut
		814
		815	sub new {
		816	my ($class, $env, @args) = @_;
		817
		818	_new ([ map "$_=$env->{$_}", keys %$env ], @args);
		819	}
		820
680	=item $term->destroy	821	=item $term->destroy
681		822
682	Destroy the terminal object (close the window, free resources etc.).	823	Destroy the terminal object (close the window, free resources
		824	etc.). Please note that @@RXVT_NAME@@ will not exit as long as any event
		825	watchers (timers, io watchers) are still active.
683		826
684	=item $isset = $term->option ($optval[, $set])	827	=item $isset = $term->option ($optval[, $set])
685		828
686	Returns true if the option specified by C<$optval> is enabled, and	829	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	830	optionally change it. All option values are stored by name in the hash
…		…
737	my ($self, $name) = (shift, shift);	880	my ($self, $name) = (shift, shift);
738	unshift @_, $self, $name, ($name =~ s/\s\+\s(\d+)$// ? $1 : 0);	881	unshift @_, $self, $name, ($name =~ s/\s\+\s(\d+)$// ? $1 : 0);
739	&urxvt::term::_resource	882	&urxvt::term::_resource
740	}	883	}
741		884
		885	=item $value = $term->x_resource ($pattern)
		886
		887	Returns the X-Resource for the given pattern, excluding the program or
		888	class name, i.e. C<< $term->x_resource ("boldFont") >> should return the
		889	same value as used by this instance of rxvt-unicode. Returns C<undef> if no
		890	resource with that pattern exists.
		891
		892	This method should only be called during the C<on_start> hook, as there is
		893	only one resource database per display, and later invocations might return
		894	the wrong resources.
		895
		896	=item $success = $term->parse_keysym ($keysym_spec, $command_string)
		897
		898	Adds a keymap translation exactly as specified via a resource. See the
		899	C<keysym> resource in the @@RXVT_NAME@@(1) manpage.
		900
742	=item $rend = $term->rstyle ([$new_rstyle])	901	=item $rend = $term->rstyle ([$new_rstyle])
743		902
744	Return and optionally change the current rendition. Text that is output by	903	Return and optionally change the current rendition. Text that is output by
745	the terminal application will use this style.	904	the terminal application will use this style.
746		905
…		…
765		924
766	=item $oldtext = $term->selection ([$newtext])	925	=item $oldtext = $term->selection ([$newtext])
767		926
768	Return the current selection text and optionally replace it by C<$newtext>.	927	Return the current selection text and optionally replace it by C<$newtext>.
769		928
770	#=item $term->overlay ($x, $y, $text)	929	=item $term->overlay_simple ($x, $y, $text)
771	#	930
772	#Create a simple multi-line overlay box. See the next method for details.	931	Create a simple multi-line overlay box. See the next method for details.
773	#	932
774	#=cut	933	=cut
775	#	934
776	#sub urxvt::term::scr_overlay {	935	sub overlay_simple {
777	# my ($self, $x, $y, $text) = @_;	936	my ($self, $x, $y, $text) = @_;
778	#	937
779	# my @lines = split /\n/, $text;	938	my @lines = split /\n/, $text;
780	#	939
781	# my $w = 0;	940	my $w = List::Util::max map $self->strwidth ($_), @lines;
782	# for (map $self->strwidth ($_), @lines) {	941
783	# $w = $_ if $w < $_;
784	# }
785	#
786	# $self->scr_overlay_new ($x, $y, $w, scalar @lines);	942	my $overlay = $self->overlay ($x, $y, $w, scalar @lines);
787	# $self->scr_overlay_set (0, $_, $lines[$_]) for 0.. $#lines;	943	$overlay->set (0, $_, $lines[$_]) for 0.. $#lines;
788	#}	944
		945	$overlay
		946	}
789		947
790	=item $term->overlay ($x, $y, $width, $height[, $rstyle[, $border]])	948	=item $term->overlay ($x, $y, $width, $height[, $rstyle[, $border]])
791		949
792	Create a new (empty) overlay at the given position with the given	950	Create a new (empty) overlay at the given position with the given
793	width/height. C<$rstyle> defines the initial rendition style	951	width/height. C<$rstyle> defines the initial rendition style
…		…
860		1018
861	=item $string = $term->locale_decode ($octets)	1019	=item $string = $term->locale_decode ($octets)
862		1020
863	Convert the given locale-encoded octets into a perl string.	1021	Convert the given locale-encoded octets into a perl string.
864		1022
		1023	=item $term->scr_xor_span ($beg_row, $beg_col, $end_row, $end_col[, $rstyle])
		1024
		1025	XORs the rendition values in the given span with the provided value
		1026	(default: C<RS_RVid>). Useful in refresh hooks to provide effects similar
		1027	to the selection.
		1028
		1029	=item $term->scr_xor_rect ($beg_row, $beg_col, $end_row, $end_col[, $rstyle1[, $rstyle2]])
		1030
		1031	Similar to C<scr_xor_span>, but xors a rectangle instead. Trailing
		1032	whitespace will additionally be xored with the C<$rstyle2>, which defaults
		1033	to C<RS_RVid \| RS_Uline>, which removes reverse video again and underlines
		1034	it instead.
		1035
		1036	=item $term->scr_bell
		1037
		1038	Ring the bell!
		1039
865	=item $term->scr_add_lines ($string)	1040	=item $term->scr_add_lines ($string)
866		1041
867	Write the given text string to the screen, as if output by the application	1042	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	1043	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	1044	codes), but is free to use line feeds, carriage returns and tabs. The
…		…
883		1058
884	Write the octets given in C<$data> to the tty (i.e. as program input). To	1059	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	1060	pass characters instead of octets, you should convert your strings first
886	to the locale-specific encoding using C<< $term->locale_encode >>.	1061	to the locale-specific encoding using C<< $term->locale_encode >>.
887		1062
		1063	=item $old_events = $term->pty_ev_events ([$new_events])
		1064
		1065	Replaces the event mask of the pty watcher by the given event mask. Can
		1066	be used to suppress input and output handling to the pty/tty. See the
		1067	description of C<< urxvt::timer->events >>. Make sure to always restore
		1068	the previous value.
		1069
888	=item $windowid = $term->parent	1070	=item $windowid = $term->parent
889		1071
890	Return the window id of the toplevel window.	1072	Return the window id of the toplevel window.
891		1073
892	=item $windowid = $term->vt	1074	=item $windowid = $term->vt
…		…
916	=item $nrow_plus_saveLines = $term->total_rows	1098	=item $nrow_plus_saveLines = $term->total_rows
917		1099
918	=item $lines_in_scrollback = $term->nsaved	1100	=item $lines_in_scrollback = $term->nsaved
919		1101
920	Return various integers describing terminal characteristics.	1102	Return various integers describing terminal characteristics.
		1103
		1104	=item $x_display = $term->display_id
		1105
		1106	Return the DISPLAY used by rxvt-unicode.
		1107
		1108	=item $lc_ctype = $term->locale
		1109
		1110	Returns the LC_CTYPE category string used by this rxvt-unicode.
		1111
		1112	=item $env = $term->env
		1113
		1114	Returns a copy of the environment in effect for the terminal as a hashref
		1115	similar to C<\%ENV>.
		1116
		1117	=cut
		1118
		1119	sub env {
		1120	if (my $env = $_[0]->_env) {
		1121	+{ map /^([^=]+)(?:=(.*))?$/s && ($1 => $2), @$env }
		1122	} else {
		1123	+{ %ENV }
		1124	}
		1125	}
921		1126
922	=item $modifiermask = $term->ModLevel3Mask	1127	=item $modifiermask = $term->ModLevel3Mask
923		1128
924	=item $modifiermask = $term->ModMetaMask	1129	=item $modifiermask = $term->ModMetaMask
925		1130
…		…
1018	Return the row number of the first/last row of the line, respectively.	1223	Return the row number of the first/last row of the line, respectively.
1019		1224
1020	=item $offset = $line->offset_of ($row, $col)	1225	=item $offset = $line->offset_of ($row, $col)
1021		1226
1022	Returns the character offset of the given row\|col pair within the logical	1227	Returns the character offset of the given row\|col pair within the logical
1023	line.	1228	line. Works for rows outside the line, too, and returns corresponding
		1229	offsets outside the string.
1024		1230
1025	=item ($row, $col) = $line->coord_of ($offset)	1231	=item ($row, $col) = $line->coord_of ($offset)
1026		1232
1027	Translates a string offset into terminal coordinates again.	1233	Translates a string offset into terminal coordinates again.
1028		1234
…		…
1115	Converts rxvt-unicodes text reprsentation into a perl string. See	1321	Converts rxvt-unicodes text reprsentation into a perl string. See
1116	C<< $term->ROW_t >> for details.	1322	C<< $term->ROW_t >> for details.
1117		1323
1118	=item $success = $term->grab_button ($button, $modifiermask)	1324	=item $success = $term->grab_button ($button, $modifiermask)
1119		1325
1120	Registers a synchronous button grab. See XGrabButton.	1326	Registers a synchronous button grab. See the XGrabButton manpage.
1121		1327
1122	=item $success = $term->grab ($eventtime[, $sync])	1328	=item $success = $term->grab ($eventtime[, $sync])
1123		1329
1124	Calls XGrabPointer and XGrabKeyboard in asynchronous (default) or	1330	Calls XGrabPointer and XGrabKeyboard in asynchronous (default) or
1125	synchronous (C<$sync> is true). Also remembers the grab timestampe.	1331	synchronous (C<$sync> is true). Also remembers the grab timestampe.
…		…
1165	$item->{render} \|\|= sub { $_[0]{text} };	1371	$item->{render} \|\|= sub { $_[0]{text} };
1166		1372
1167	push @{ $self->{item} }, $item;	1373	push @{ $self->{item} }, $item;
1168	}	1374	}
1169		1375
1170	sub add_separator {	1376	=item $popup->add_title ($title)
1171	my ($self, $sep) = @_;
1172		1377
1173	$sep \|\|= "═";	1378	Adds a non-clickable title to the popup.
1174		1379
1175	$self->add_item ({	1380	=cut
1176	rend => { normal => "\x1b[0;30;47m", hover => "\x1b[0;30;47m", active => "\x1b[0;30;47m" },
1177	text => "",
1178	render => sub { $sep x $urxvt::TERM->ncol },
1179	activate => sub { },
1180	});
1181	}
1182		1381
1183	sub add_title {	1382	sub add_title {
1184	my ($self, $title) = @_;	1383	my ($self, $title) = @_;
1185		1384
1186	$self->add_item ({	1385	$self->add_item ({
…		…
1188	text => $title,	1387	text => $title,
1189	activate => sub { },	1388	activate => sub { },
1190	});	1389	});
1191	}	1390	}
1192		1391
		1392	=item $popup->add_separator ([$sepchr])
		1393
		1394	Creates a separator, optionally using the character given as C<$sepchr>.
		1395
		1396	=cut
		1397
		1398	sub add_separator {
		1399	my ($self, $sep) = @_;
		1400
		1401	$sep \|\|= "=";
		1402
		1403	$self->add_item ({
		1404	rend => { normal => "\x1b[0;30;47m", hover => "\x1b[0;30;47m", active => "\x1b[0;30;47m" },
		1405	text => "",
		1406	render => sub { $sep x $self->{term}->ncol },
		1407	activate => sub { },
		1408	});
		1409	}
		1410
		1411	=item $popup->add_button ($text, $cb)
		1412
		1413	Adds a clickable button to the popup. C<$cb> is called whenever it is
		1414	selected.
		1415
		1416	=cut
		1417
1193	sub add_button {	1418	sub add_button {
1194	my ($self, $text, $cb) = @_;	1419	my ($self, $text, $cb) = @_;
1195		1420
1196	$self->add_item ({ type => "button", text => "[ $text ]", activate => $cb});	1421	$self->add_item ({ type => "button", text => $text, activate => $cb});
1197	}	1422	}
		1423
		1424	=item $popup->add_toggle ($text, $cb, $initial_value)
		1425
		1426	Adds a toggle/checkbox item to the popup. Teh callback gets called
		1427	whenever it gets toggled, with a boolean indicating its value as its first
		1428	argument.
		1429
		1430	=cut
1198		1431
1199	sub add_toggle {	1432	sub add_toggle {
1200	my ($self, $text, $cb, $value) = @_;	1433	my ($self, $text, $cb, $value) = @_;
1201		1434
1202	my $item; $item = {	1435	my $item; $item = {
1203	type => "button",	1436	type => "button",
1204	text => " $text",	1437	text => " $text",
1205	value => $value,	1438	value => $value,
1206	render => sub { ($_[0]{value} ? "* " : " ") . $text },	1439	render => sub { ($_[0]{value} ? "* " : " ") . $text },
1207	activate => sub { $cb->($_[0]{value} = !$_[0]{value}); },	1440	activate => sub { $cb->($_[1]{value} = !$_[1]{value}); },
1208	};	1441	};
1209		1442
1210	$self->add_item ($item);	1443	$self->add_item ($item);
1211	}	1444	}
		1445
		1446	=item $popup->show
		1447
		1448	Displays the popup (which is initially hidden).
		1449
		1450	=cut
1212		1451
1213	sub show {	1452	sub show {
1214	my ($self) = @_;	1453	my ($self) = @_;
1215		1454
1216	local $urxvt::popup::self = $self;	1455	local $urxvt::popup::self = $self;
1217		1456
		1457	my $env = $self->{term}->env;
		1458	# we can't hope to reproduce the locale algorithm, so nuke LC_ALL and set LC_CTYPE.
		1459	delete $env->{LC_ALL};
		1460	$env->{LC_CTYPE} = $self->{term}->locale;
		1461
		1462	urxvt::term->new ($env, $self->{term}->resource ("name"),
1218	urxvt->new ("--perl-lib" => "", "--perl-ext-common" => "", "-pty-fd" => -1, "-sl" => 0, "-b" => 0,	1463	"--perl-lib" => "", "--perl-ext-common" => "", "-pty-fd" => -1, "-sl" => 0, "-b" => 0,
1219	"--transient-for" => $self->{term}->parent,	1464	"--transient-for" => $self->{term}->parent,
		1465	"-display" => $self->{term}->display_id,
1220	"-pe" => "urxvt-popup")	1466	"-pe" => "urxvt-popup")
1221	or die "unable to create popup window\n";	1467	or die "unable to create popup window\n";
1222	}	1468	}
1223		1469
1224	sub DESTROY {	1470	sub DESTROY {
1225	my ($self) = @_;	1471	my ($self) = @_;
1226		1472
1227	delete $self->{term}{_destroy}{$self};	1473	delete $self->{term}{_destroy}{$self};
1228	$self->{term}->ungrab;	1474	$self->{term}->ungrab;
1229	}	1475	}
		1476
		1477	=back
1230		1478
1231	=head2 The C<urxvt::timer> Class	1479	=head2 The C<urxvt::timer> Class
1232		1480
1233	This class implements timer watchers/events. Time is represented as a	1481	This class implements timer watchers/events. Time is represented as a
1234	fractional number of seconds since the epoch. Example:	1482	fractional number of seconds since the epoch. Example:
…		…
1287		1535
1288	$term->{socket} = ...	1536	$term->{socket} = ...
1289	$term->{iow} = urxvt::iow	1537	$term->{iow} = urxvt::iow
1290	->new	1538	->new
1291	->fd (fileno $term->{socket})	1539	->fd (fileno $term->{socket})
1292	->events (1) # wait for read data	1540	->events (urxvt::EVENT_READ)
1293	->start	1541	->start
1294	->cb (sub {	1542	->cb (sub {
1295	my ($iow, $revents) = @_;	1543	my ($iow, $revents) = @_;
1296	# $revents must be 1 here, no need to check	1544	# $revents must be 1 here, no need to check
1297	sysread $term->{socket}, my $buf, 8192	1545	sysread $term->{socket}, my $buf, 8192
…		…
1314		1562
1315	Set the filedescriptor (not handle) to watch.	1563	Set the filedescriptor (not handle) to watch.
1316		1564
1317	=item $iow = $iow->events ($eventmask)	1565	=item $iow = $iow->events ($eventmask)
1318		1566
1319	Set the event mask to watch. Bit #0 (value C<1>) enables watching for read	1567	Set the event mask to watch. The only allowed values are
1320	data, Bit #1 (value C<2>) enables watching for write data.	1568	C<urxvt::EVENT_READ> and C<urxvt::EVENT_WRITE>, which might be ORed
		1569	together, or C<urxvt::EVENT_NONE>.
1321		1570
1322	=item $iow = $iow->start	1571	=item $iow = $iow->start
1323		1572
1324	Start watching for requested events on the given handle.	1573	Start watching for requested events on the given handle.
1325		1574
…		…
1340		1589
1341	=item == 0 - fatal messages	1590	=item == 0 - fatal messages
1342		1591
1343	=item >= 3 - script loading and management	1592	=item >= 3 - script loading and management
1344		1593
1345	=item >=10 - all events received	1594	=item >=10 - all called hooks
		1595
		1596	=item >=11 - hook reutrn values
1346		1597
1347	=back	1598	=back
1348		1599
1349	=head1 AUTHOR	1600	=head1 AUTHOR
1350		1601

Diff Legend

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

Comparing rxvt-unicode/src/urxvt.pm (file contents): Revision 1.62 by root, Mon Jan 9 02:06:43 2006 UTC vs. Revision 1.85 by root, Thu Jan 12 03:32:56 2006 UTC

Diff Legend

Comparing rxvt-unicode/src/urxvt.pm (file contents):
Revision 1.62 by root, Mon Jan 9 02:06:43 2006 UTC vs.
Revision 1.85 by root, Thu Jan 12 03:32:56 2006 UTC