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

Comparing rxvt-unicode/src/urxvt.pm (file contents):
Revision 1.47 by root, Sat Jan 7 21:22:02 2006 UTC vs.
Revision 1.73 by root, Tue Jan 10 04:23:39 2006 UTC

…		…
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	42	=item selection (enabled by default)
43		43
44	Intelligent selection. This extension tries to be more intelligent when	44	Intelligent selection. This extension tries to be more intelligent when
45	the user extends selections (double-click). Right now, it tries to select	45	the user extends selections (double-click). Right now, it tries to select
46	urls and complete shell-quoted arguments, which is very convenient, too,	46	urls and complete shell-quoted arguments, which is very convenient, too,
47	if your F<ls> supports C<--quoting-style=shell>.	47	if your F<ls> supports C<--quoting-style=shell>.
…		…
55	Rot-13 the selection when activated. Used via keyboard trigger:	55	Rot-13 the selection when activated. Used via keyboard trigger:
56		56
57	URxvt.keysym.C-M-r: perl:selection:rot13	57	URxvt.keysym.C-M-r: perl:selection:rot13
58		58
59	=back	59	=back
		60
		61	=item option-popup (enabled by default)
		62
		63	Binds a popup menu to Ctrl-Button2 that lets you toggle (some) options at
		64	runtime.
		65
		66	=item selection-popup (enabled by default)
		67
		68	Binds a popup menu to Ctrl-Button3 that lets you convert the selection
		69	text into various other formats/action.
		70
		71	=item searchable-scrollback (enabled by default)
		72
		73	Adds regex search functionality to the scrollback buffer, triggered by a
		74	hotkey (default: C<M-s>). When in search mode, terminal input/output is
		75	suspended, C</> starts an incremental regex search, C<n> searches further,
		76	C<p> jumps to the previous match. C<enter> leaves search mode at the
		77	current position and C<escape> returns to the original position.
60		78
61	=item digital-clock	79	=item digital-clock
62		80
63	Displays a digital clock using the built-in overlay.	81	Displays a digital clock using the built-in overlay.
64		82
…		…
114	Either binary data or - more common - a text string encoded in a	132	Either binary data or - more common - a text string encoded in a
115	locale-specific way.	133	locale-specific way.
116		134
117	=back	135	=back
118		136
		137	=head2 Extension Objects
		138
		139	Very perl extension is a perl class. A separate perl object is created
		140	for each terminal and each extension and passed as the first parameter to
		141	hooks. So extensions can use their C<$self> object without having to think
		142	about other extensions, with the exception of methods and members that
		143	begin with an underscore character C<_>: these are reserved for internal
		144	use.
		145
		146	Although it isn't a C<urxvt::term> object, you can call all methods of the
		147	C<urxvt::term> class on this object.
		148
		149	It has the following methods and data members:
		150
		151	=over 4
		152
		153	=item $urxvt_term = $self->{term}
		154
		155	Returns the C<urxvt::term> object associated with this instance of the
		156	extension. This member I<must not> be changed in any way.
		157
		158	=item $self->enable ($hook_name => $cb, [$hook_name => $cb..])
		159
		160	Dynamically enable the given hooks (named without the C<on_> prefix) for
		161	this extension, replacing any previous hook. This is useful when you want
		162	to overwrite time-critical hooks only temporarily.
		163
		164	=item $self->disable ($hook_name[, $hook_name..])
		165
		166	Dynamically disable the given hooks.
		167
		168	=back
		169
119	=head2 Hooks	170	=head2 Hooks
120		171
121	The following subroutines can be declared in extension files, and will be	172	The following subroutines can be declared in extension files, and will be
122	called whenever the relevant event happens.	173	called whenever the relevant event happens.
123		174
124	The first argument passed to them is an object private to each terminal	175	The first argument passed to them is an extension oject as described in
125	and extension package. You can call all C<urxvt::term> methods on it, but	176	the in the C<Extension Objects> section.
126	its not a real C<urxvt::term> object. Instead, the real C<urxvt::term>
127	object that is shared between all packages is stored in the C<term>
128	member. It is, however, blessed intot he package of the extension script,
129	so for all practical purposes you can treat an extension script as a class.
130		177
131	All of them must return a boolean value. If it is true, then the event	178	B<All> of these hooks must return a boolean value. If it is true, then the
132	counts as being I<consumed>, and the invocation of other hooks is skipped,	179	event counts as being I<consumed>, and the invocation of other hooks is
133	and the relevant action might not be carried out by the C++ code.	180	skipped, and the relevant action might not be carried out by the C++ code.
134		181
135	When in doubt, return a false value (preferably C<()>).	182	I<< When in doubt, return a false value (preferably C<()>). >>
136		183
137	=over 4	184	=over 4
138		185
139	=item on_init $term	186	=item on_init $term
140		187
…		…
194	than the scroll back buffer or the terminal.	241	than the scroll back buffer or the terminal.
195		242
196	It is called before lines are scrolled out (so rows 0 .. min ($lines - 1,	243	It is called before lines are scrolled out (so rows 0 .. min ($lines - 1,
197	$nrow - 1) represent the lines to be scrolled out). C<$saved> is the total	244	$nrow - 1) represent the lines to be scrolled out). C<$saved> is the total
198	number of lines that will be in the scrollback buffer.	245	number of lines that will be in the scrollback buffer.
199
200	=item on_tty_activity $term NYI
201
202	Called whenever the program(s) running in the urxvt window send output.
203		246
204	=item on_osc_seq $term, $string	247	=item on_osc_seq $term, $string
205		248
206	Called whenever the B<ESC ] 777 ; string ST> command sequence (OSC =	249	Called whenever the B<ESC ] 777 ; string ST> command sequence (OSC =
207	operating system command) is processed. Cursor position and other state	250	operating system command) is processed. Cursor position and other state
…		…
220	can filter/change and output the text yourself by returning a true value	263	can filter/change and output the text yourself by returning a true value
221	and calling C<< $term->scr_add_lines >> yourself. Please note that this	264	and calling C<< $term->scr_add_lines >> yourself. Please note that this
222	might be very slow, however, as your hook is called for B<all> text being	265	might be very slow, however, as your hook is called for B<all> text being
223	output.	266	output.
224		267
		268	=item on_tt_write $term, $octets
		269
		270	Called whenever some data is written to the tty/pty and can be used to
		271	suppress or filter tty input.
		272
225	=item on_line_update $term, $row	273	=item on_line_update $term, $row
226		274
227	Called whenever a line was updated or changed. Can be used to filter	275	Called whenever a line was updated or changed. Can be used to filter
228	screen output (e.g. underline urls or other useless stuff). Only lines	276	screen output (e.g. underline urls or other useless stuff). Only lines
229	that are being shown will be filtered, and, due to performance reasons,	277	that are being shown will be filtered, and, due to performance reasons,
…		…
261	=item on_focus_out $term	309	=item on_focus_out $term
262		310
263	Called wheneever the window loses keyboard focus, before rxvt-unicode does	311	Called wheneever the window loses keyboard focus, before rxvt-unicode does
264	focus out processing.	312	focus out processing.
265		313
266	=item on_key_press $term, $event, $octets	314	=item on_key_press $term, $event, $keysym, $octets
267		315
268	=item on_key_release $term, $event	316	=item on_key_release $term, $event, $keysym
269		317
270	=item on_button_press $term, $event	318	=item on_button_press $term, $event
271		319
272	=item on_button_release $term, $event	320	=item on_button_release $term, $event
273		321
…		…
327	that calls this function.	375	that calls this function.
328		376
329	Using this function has the advantage that its output ends up in the	377	Using this function has the advantage that its output ends up in the
330	correct place, e.g. on stderr of the connecting urxvtc client.	378	correct place, e.g. on stderr of the connecting urxvtc client.
331		379
		380	=item $is_safe = urxvt::safe
		381
		382	Returns true when it is safe to do potentially unsafe things, such as
		383	evaluating perl code specified by the user. This is true when urxvt was
		384	started setuid or setgid.
		385
332	=item $time = urxvt::NOW	386	=item $time = urxvt::NOW
333		387
334	Returns the "current time" (as per the event loop).	388	Returns the "current time" (as per the event loop).
335		389
336	=item urxvt::CurrentTime	390	=item urxvt::CurrentTime
337		391
338	=item urxvt::ShiftMask, LockMask, ControlMask, Mod1Mask, Mod2Mask,	392	=item urxvt::ShiftMask, LockMask, ControlMask, Mod1Mask, Mod2Mask,
339	Mod3Mask, Mod4Mask, Mod5Mask, Button1Mask, Button2Mask, Button3Mask,	393	Mod3Mask, Mod4Mask, Mod5Mask, Button1Mask, Button2Mask, Button3Mask,
340	Button4Mask, Button5Mask, AnyModifier	394	Button4Mask, Button5Mask, AnyModifier
341		395
342	Various constants for use in X events.	396	Various constants for use in X calls and event processing.
343		397
344	=back	398	=back
345		399
346	=head2 RENDITION	400	=head2 RENDITION
347		401
…		…
397		451
398	=cut	452	=cut
399		453
400	package urxvt;	454	package urxvt;
401		455
		456	use utf8;
402	use strict;	457	use strict;
		458	use Carp ();
403	use Scalar::Util ();	459	use Scalar::Util ();
		460	use List::Util ();
404		461
		462	our $VERSION = 1;
405	our $TERM;	463	our $TERM;
406	our @HOOKNAME;	464	our @HOOKNAME;
		465	our %HOOKTYPE = map +($HOOKNAME[$_] => $_), 0..$#HOOKNAME;
		466	our %OPTION;
		467
407	our $LIBDIR;	468	our $LIBDIR;
		469	our $RESNAME;
		470	our $RESCLASS;
		471	our $RXVTNAME;
408		472
409	BEGIN {	473	BEGIN {
410	urxvt->bootstrap;	474	urxvt->bootstrap;
411		475
412	# overwrite perl's warn	476	# overwrite perl's warn
…		…
414	my $msg = join "", @_;	478	my $msg = join "", @_;
415	$msg .= "\n"	479	$msg .= "\n"
416	unless $msg =~ /\n$/;	480	unless $msg =~ /\n$/;
417	urxvt::warn ($msg);	481	urxvt::warn ($msg);
418	};	482	};
		483
		484	delete $ENV{IFS};
		485	delete $ENV{CDPATH};
		486	delete $ENV{BASH_ENV};
		487	$ENV{PATH} = "/bin:/sbin:/usr/bin:/usr/sbin:/usr/local/bin:/usr/local/sbin:/opt/bin:/opt/sbin";
419	}	488	}
420		489
421	my @hook_count;	490	my @hook_count;
422	my $verbosity = $ENV{URXVT_PERL_VERBOSITY};	491	my $verbosity = $ENV{URXVT_PERL_VERBOSITY};
423		492
424	sub verbose {	493	sub verbose {
425	my ($level, $msg) = @_;	494	my ($level, $msg) = @_;
426	warn "$msg\n" if $level <= $verbosity;	495	warn "$msg\n" if $level <= $verbosity;
427	}	496	}
428		497
429	# find on_xxx subs in the package and register them
430	# as hooks
431	sub register_package($) {
432	my ($pkg) = @_;
433
434	for my $htype (0.. $#HOOKNAME) {
435	my $name = $HOOKNAME[$htype];
436
437	my $ref = $pkg->can ("on_" . lc $name)
438	or next;
439
440	$TERM->{_hook}[$htype]{$pkg} = $ref;
441	$hook_count[$htype]++
442	or set_should_invoke $htype, 1;
443	}
444	}
445
446	my $extension_pkg = "extension0000";	498	my $extension_pkg = "extension0000";
447	my %extension_pkg;	499	my %extension_pkg;
448		500
449	# load a single script into its own package, once only	501	# load a single script into its own package, once only
450	sub extension_package($) {	502	sub extension_package($) {
…		…
456	verbose 3, "loading extension '$path' into package '$pkg'";	508	verbose 3, "loading extension '$path' into package '$pkg'";
457		509
458	open my $fh, "<:raw", $path	510	open my $fh, "<:raw", $path
459	or die "$path: $!";	511	or die "$path: $!";
460		512
		513	my $source = untaint
461	my $source = "package $pkg; use strict; use utf8;\n"	514	"package $pkg; use strict; use utf8;\n"
462	. "use base urxvt::term::proxy::;\n"	515	. "use base urxvt::term::extension::;\n"
463	. "#line 1 \"$path\"\n{\n"	516	. "#line 1 \"$path\"\n{\n"
464	. (do { local $/; <$fh> })	517	. (do { local $/; <$fh> })
465	. "\n};\n1";	518	. "\n};\n1";
466		519
		520	eval $source
467	eval $source or die "$path: $@";	521	or die "$path: $@";
468		522
469	$pkg	523	$pkg
470	}	524	}
471	}	525	}
472		526
…		…
477	local $TERM = shift;	531	local $TERM = shift;
478	my $htype = shift;	532	my $htype = shift;
479		533
480	if ($htype == 0) { # INIT	534	if ($htype == 0) { # INIT
481	my @dirs = ((split /:/, $TERM->resource ("perl_lib")), "$LIBDIR/perl");	535	my @dirs = ((split /:/, $TERM->resource ("perl_lib")), "$LIBDIR/perl");
		536
		537	my %ext_arg;
482		538
483	for my $ext (map { split /,/, $TERM->resource ("perl_ext_$_") } 1, 2) {	539	for (map { split /,/, $TERM->resource ("perl_ext_$_") } 1, 2) {
		540	if ($_ eq "default") {
		541	$ext_arg{$_} \|\|= [] for qw(selection option-popup selection-popup searchable-scrollback);
		542	} elsif (/^-(.*)$/) {
		543	delete $ext_arg{$1};
		544	} elsif (/^([^<]+)<(.*)>$/) {
		545	push @{ $ext_arg{$1} }, $2;
		546	} else {
		547	$ext_arg{$_} \|\|= [];
		548	}
		549	}
		550
		551	while (my ($ext, $argv) = each %ext_arg) {
484	my @files = grep -f $_, map "$_/$ext", @dirs;	552	my @files = grep -f $_, map "$_/$ext", @dirs;
485		553
486	if (@files) {	554	if (@files) {
487	register_package extension_package $files[0];	555	$TERM->register_package (extension_package $files[0], $argv);
488	} else {	556	} else {
489	warn "perl extension '$ext' not found in perl library search path\n";	557	warn "perl extension '$ext' not found in perl library search path\n";
490	}	558	}
491	}	559	}
		560
		561	eval "#line 1 \"--perl-eval resource/argument\"\n" . $TERM->resource ("perl_eval");
		562	warn $@ if $@;
492	}	563	}
493		564
494	$retval = undef;	565	$retval = undef;
495		566
496	if (my $cb = $TERM->{_hook}[$htype]) {	567	if (my $cb = $TERM->{_hook}[$htype]) {
…		…
498	if $verbosity >= 10;	569	if $verbosity >= 10;
499		570
500	keys %$cb;	571	keys %$cb;
501		572
502	while (my ($pkg, $cb) = each %$cb) {	573	while (my ($pkg, $cb) = each %$cb) {
503	eval {	574	$retval = eval { $cb->($TERM->{_pkg}{$pkg}, @_) }
504	$retval = $cb->(
505	$TERM->{_pkg}{$pkg} \|\|= do {
506	my $proxy = bless { }, $pkg;
507	Scalar::Util::weaken ($proxy->{term} = $TERM);
508	$proxy
509	},
510	@_,
511	) and last;	575	and last;
		576
		577	if ($@) {
		578	$TERM->ungrab; # better to lose the grab than the session
		579	warn $@;
512	};	580	}
513	warn $@ if $@;#d#
514	}	581	}
515	}	582	}
516		583
517	if ($htype == 1) { # DESTROY	584	if ($htype == 1) { # DESTROY
518	# remove hooks if unused
519	if (my $hook = $TERM->{_hook}) {	585	if (my $hook = delete $TERM->{_hook}) {
520	for my $htype (0..$#$hook) {	586	for my $htype (0..$#$hook) {
521	$hook_count[$htype] -= scalar keys %{ $hook->[$htype] \|\| {} }	587	$hook_count[$htype] -= scalar keys %{ $hook->[$htype] \|\| {} }
522	or set_should_invoke $htype, 0;	588	or set_should_invoke $htype, 0;
523	}	589	}
524	}	590	}
…		…
531	}	597	}
532		598
533	$retval	599	$retval
534	}	600	}
535		601
536	sub urxvt::term::proxy::AUTOLOAD {	602	# urxvt::term::extension
537	$urxvt::term::proxy::AUTOLOAD =~ /:([^:]+)$/	603
		604	package urxvt::term::extension;
		605
		606	sub enable {
		607	my ($self, %hook) = @_;
		608	my $pkg = $self->{_pkg};
		609
		610	while (my ($name, $cb) = each %hook) {
		611	my $htype = $HOOKTYPE{uc $name};
		612	defined $htype
		613	or Carp::croak "unsupported hook type '$name'";
		614
		615	unless (exists $self->{term}{_hook}[$htype]{$pkg}) {
		616	$hook_count[$htype]++
		617	or urxvt::set_should_invoke $htype, 1;
		618	}
		619
		620	$self->{term}{_hook}[$htype]{$pkg} = $cb;
		621	}
		622	}
		623
		624	sub disable {
		625	my ($self, @hook) = @_;
		626	my $pkg = $self->{_pkg};
		627
		628	for my $name (@hook) {
		629	my $htype = $HOOKTYPE{uc $name};
		630	defined $htype
		631	or Carp::croak "unsupported hook type '$name'";
		632
		633	if (delete $self->{term}{_hook}[$htype]{$pkg}) {
		634	--$hook_count[$htype]
		635	or urxvt::set_should_invoke $htype, 0;
		636	}
		637	}
		638	}
		639
		640	our $AUTOLOAD;
		641
		642	sub AUTOLOAD {
		643	$AUTOLOAD =~ /:([^:]+)$/
538	or die "FATAL: \$AUTOLOAD '$urxvt::term::proxy::AUTOLOAD' unparsable";	644	or die "FATAL: \$AUTOLOAD '$AUTOLOAD' unparsable";
539		645
540	eval qq{	646	eval qq{
541	sub $urxvt::term::proxy::AUTOLOAD {	647	sub $AUTOLOAD {
542	my \$proxy = shift;	648	my \$proxy = shift;
543	\$proxy->{term}->$1 (\@_)	649	\$proxy->{term}->$1 (\@_)
544	}	650	}
545	1	651	1
546	} or die "FATAL: unable to compile method forwarder: $@";	652	} or die "FATAL: unable to compile method forwarder: $@";
547		653
548	goto &$urxvt::term::proxy::AUTOLOAD;	654	goto &$AUTOLOAD;
549	}	655	}
		656
		657	sub DESTROY {
		658	# nop
		659	}
		660
		661	# urxvt::destroy_hook
550		662
551	sub urxvt::destroy_hook::DESTROY {	663	sub urxvt::destroy_hook::DESTROY {
552	${$_[0]}->();	664	${$_[0]}->();
553	}	665	}
554		666
555	sub urxvt::destroy_hook(&) {	667	sub urxvt::destroy_hook(&) {
556	bless \shift, urxvt::destroy_hook::	668	bless \shift, urxvt::destroy_hook::
557	}	669	}
558		670
		671	package urxvt::anyevent;
		672
		673	=head2 The C<urxvt::anyevent> Class
		674
		675	The sole purpose of this class is to deliver an interface to the
		676	C<AnyEvent> module - any module using it will work inside urxvt without
		677	further work. The only exception is that you cannot wait on condition
		678	variables, but non-blocking condvar use is ok. What this means is that you
		679	cannot use blocking APIs, but the non-blocking variant should work.
		680
		681	=cut
		682
		683	our $VERSION = 1;
		684
		685	$INC{"urxvt/anyevent.pm"} = 1; # mark us as there
		686	push @AnyEvent::REGISTRY, [urxvt => urxvt::anyevent::];
		687
		688	sub timer {
		689	my ($class, %arg) = @_;
		690
		691	my $cb = $arg{cb};
		692
		693	urxvt::timer
		694	->new
		695	->start (urxvt::NOW + $arg{after})
		696	->cb (sub {
		697	$_[0]->stop; # need to cancel manually
		698	$cb->();
		699	})
		700	}
		701
		702	sub io {
		703	my ($class, %arg) = @_;
		704
		705	my $cb = $arg{cb};
		706
		707	bless [$arg{fh}, urxvt::iow
		708	->new
		709	->fd (fileno $arg{fh})
		710	->events (($arg{poll} =~ /r/ ? 1 : 0)
		711	\| ($arg{poll} =~ /w/ ? 2 : 0))
		712	->start
		713	->cb (sub {
		714	$cb->(($_[1] & 1 ? 'r' : '')
		715	. ($_[1] & 2 ? 'w' : ''));
		716	})],
		717	urxvt::anyevent::
		718	}
		719
		720	sub DESTROY {
		721	$_[0][1]->stop;
		722	}
		723
		724	sub condvar {
		725	bless \my $flag, urxvt::anyevent::condvar::
		726	}
		727
		728	sub urxvt::anyevent::condvar::broadcast {
		729	${$_[0]}++;
		730	}
		731
		732	sub urxvt::anyevent::condvar::wait {
		733	unless (${$_[0]}) {
		734	Carp::croak "AnyEvent->condvar blocking wait unsupported in urxvt, use a non-blocking API";
		735	}
		736	}
		737
		738	package urxvt::term;
		739
559	=head2 The C<urxvt::term> Class	740	=head2 The C<urxvt::term> Class
560		741
561	=over 4	742	=over 4
562		743
		744	=cut
		745
		746	# find on_xxx subs in the package and register them
		747	# as hooks
		748	sub register_package {
		749	my ($self, $pkg, $argv) = @_;
		750
		751	my $proxy = bless {
		752	_pkg => $pkg,
		753	argv => $argv,
		754	}, $pkg;
		755	Scalar::Util::weaken ($proxy->{term} = $self);
		756
		757	$self->{_pkg}{$pkg} = $proxy;
		758
		759	for my $name (@HOOKNAME) {
		760	if (my $ref = $pkg->can ("on_" . lc $name)) {
		761	$proxy->enable ($name => $ref);
		762	}
		763	}
		764	}
		765
563	=item $term->destroy	766	=item $term->destroy
564		767
565	Destroy the terminal object (close the window, free resources etc.).	768	Destroy the terminal object (close the window, free resources etc.).
		769
		770	=item $isset = $term->option ($optval[, $set])
		771
		772	Returns true if the option specified by C<$optval> is enabled, and
		773	optionally change it. All option values are stored by name in the hash
		774	C<%urxvt::OPTION>. Options not enabled in this binary are not in the hash.
		775
		776	Here is a a likely non-exhaustive list of option names, please see the
		777	source file F</src/optinc.h> to see the actual list:
		778
		779	borderLess console cursorBlink cursorUnderline hold iconic insecure
		780	intensityStyles jumpScroll loginShell mapAlert meta8 mouseWheelScrollPage
		781	pastableTabs pointerBlank reverseVideo scrollBar scrollBar_floating
		782	scrollBar_right scrollTtyKeypress scrollTtyOutput scrollWithBuffer
		783	secondaryScreen secondaryScroll skipBuiltinGlyphs transparent
		784	tripleclickwords utmpInhibit visualBell
566		785
567	=item $value = $term->resource ($name[, $newval])	786	=item $value = $term->resource ($name[, $newval])
568		787
569	Returns the current resource value associated with a given name and	788	Returns the current resource value associated with a given name and
570	optionally sets a new value. Setting values is most useful in the C<init>	789	optionally sets a new value. Setting values is most useful in the C<init>
…		…
580		799
581	Please note that resource strings will currently only be freed when the	800	Please note that resource strings will currently only be freed when the
582	terminal is destroyed, so changing options frequently will eat memory.	801	terminal is destroyed, so changing options frequently will eat memory.
583		802
584	Here is a a likely non-exhaustive list of resource names, not all of which	803	Here is a a likely non-exhaustive list of resource names, not all of which
585	are supported in every build, please see the source to see the actual	804	are supported in every build, please see the source file F</src/rsinc.h>
586	list:	805	to see the actual list:
587		806
588	answerbackstring backgroundPixmap backspace_key boldFont boldItalicFont	807	answerbackstring backgroundPixmap backspace_key boldFont boldItalicFont
589	borderLess color cursorBlink cursorUnderline cutchars delete_key	808	borderLess color cursorBlink cursorUnderline cutchars delete_key
590	display_name embed ext_bwidth fade font geometry hold iconName	809	display_name embed ext_bwidth fade font geometry hold iconName
591	imFont imLocale inputMethod insecure int_bwidth intensityStyles	810	imFont imLocale inputMethod insecure int_bwidth intensityStyles
…		…
598	shade term_name title transparent transparent_all tripleclickwords	817	shade term_name title transparent transparent_all tripleclickwords
599	utmpInhibit visualBell	818	utmpInhibit visualBell
600		819
601	=cut	820	=cut
602		821
603	sub urxvt::term::resource($$;$) {	822	sub resource($$;$) {
604	my ($self, $name) = (shift, shift);	823	my ($self, $name) = (shift, shift);
605	unshift @_, $self, $name, ($name =~ s/\s\+\s(\d+)$// ? $1 : 0);	824	unshift @_, $self, $name, ($name =~ s/\s\+\s(\d+)$// ? $1 : 0);
606	&urxvt::term::_resource	825	&urxvt::term::_resource
607	}	826	}
608		827
		828	=item $success = $term->parse_keysym ($keysym_spec, $command_string)
		829
		830	Adds a keymap translation exactly as specified via a resource. See the
		831	C<keysym> resource in the @@RXVT_NAME@@(1) manpage.
		832
609	=item $rend = $term->rstyle ([$new_rstyle])	833	=item $rend = $term->rstyle ([$new_rstyle])
610		834
611	Return and optionally change the current rendition. Text that is output by	835	Return and optionally change the current rendition. Text that is output by
612	the terminal application will use this style.	836	the terminal application will use this style.
613		837
…		…
632		856
633	=item $oldtext = $term->selection ([$newtext])	857	=item $oldtext = $term->selection ([$newtext])
634		858
635	Return the current selection text and optionally replace it by C<$newtext>.	859	Return the current selection text and optionally replace it by C<$newtext>.
636		860
637	#=item $term->overlay ($x, $y, $text)	861	=item $term->overlay_simple ($x, $y, $text)
638	#	862
639	#Create a simple multi-line overlay box. See the next method for details.	863	Create a simple multi-line overlay box. See the next method for details.
640	#	864
641	#=cut	865	=cut
642	#	866
643	#sub urxvt::term::scr_overlay {	867	sub overlay_simple {
644	# my ($self, $x, $y, $text) = @_;	868	my ($self, $x, $y, $text) = @_;
645	#	869
646	# my @lines = split /\n/, $text;	870	my @lines = split /\n/, $text;
647	#	871
648	# my $w = 0;	872	my $w = List::Util::max map $self->strwidth ($_), @lines;
649	# for (map $self->strwidth ($_), @lines) {	873
650	# $w = $_ if $w < $_;
651	# }
652	#
653	# $self->scr_overlay_new ($x, $y, $w, scalar @lines);	874	my $overlay = $self->overlay ($x, $y, $w, scalar @lines);
654	# $self->scr_overlay_set (0, $_, $lines[$_]) for 0.. $#lines;	875	$overlay->set (0, $_, $lines[$_]) for 0.. $#lines;
655	#}	876
		877	$overlay
		878	}
656		879
657	=item $term->overlay ($x, $y, $width, $height[, $rstyle[, $border]])	880	=item $term->overlay ($x, $y, $width, $height[, $rstyle[, $border]])
658		881
659	Create a new (empty) overlay at the given position with the given	882	Create a new (empty) overlay at the given position with the given
660	width/height. C<$rstyle> defines the initial rendition style	883	width/height. C<$rstyle> defines the initial rendition style
…		…
695	C<$event> I<must> be the event causing the menu to pop up (a button event,	918	C<$event> I<must> be the event causing the menu to pop up (a button event,
696	currently).	919	currently).
697		920
698	=cut	921	=cut
699		922
700	sub urxvt::term::popup {	923	sub popup {
701	my ($self, $event) = @_;	924	my ($self, $event) = @_;
702		925
703	$self->grab ($event->{time}, 1)	926	$self->grab ($event->{time}, 1)
704	or return;	927	or return;
705		928
…		…
727		950
728	=item $string = $term->locale_decode ($octets)	951	=item $string = $term->locale_decode ($octets)
729		952
730	Convert the given locale-encoded octets into a perl string.	953	Convert the given locale-encoded octets into a perl string.
731		954
		955	=item $term->scr_xor_span ($beg_row, $beg_col, $end_row, $end_col[, $rstyle])
		956
		957	XORs the rendition values in the given span with the provided value
		958	(default: C<RS_RVid>). Useful in refresh hooks to provide effects similar
		959	to the selection.
		960
		961	=item $term->scr_xor_rect ($beg_row, $beg_col, $end_row, $end_col[, $rstyle1[, $rstyle2]])
		962
		963	Similar to C<scr_xor_span>, but xors a rectangle instead. Trailing
		964	whitespace will additionally be xored with the C<$rstyle2>, which defaults
		965	to C<RS_RVid \| RS_Uline>, which removes reverse video again and underlines
		966	it instead.
		967
		968	=item $term->scr_bell
		969
		970	Ring the bell!
		971
732	=item $term->scr_add_lines ($string)	972	=item $term->scr_add_lines ($string)
733		973
734	Write the given text string to the screen, as if output by the application	974	Write the given text string to the screen, as if output by the application
735	running inside the terminal. It may not contain command sequences (escape	975	running inside the terminal. It may not contain command sequences (escape
736	codes), but is free to use line feeds, carriage returns and tabs. The	976	codes), but is free to use line feeds, carriage returns and tabs. The
…		…
750		990
751	Write the octets given in C<$data> to the tty (i.e. as program input). To	991	Write the octets given in C<$data> to the tty (i.e. as program input). To
752	pass characters instead of octets, you should convert your strings first	992	pass characters instead of octets, you should convert your strings first
753	to the locale-specific encoding using C<< $term->locale_encode >>.	993	to the locale-specific encoding using C<< $term->locale_encode >>.
754		994
		995	=item $old_events = $term->pty_ev_events ([$new_events])
		996
		997	Replaces the event mask of the pty watcher by the given event mask. Can
		998	be used to suppress input and output handling to the pty/tty. See the
		999	description of C<< urxvt::timer->events >>. Make sure to always restore
		1000	the previous value.
		1001
755	=item $windowid = $term->parent	1002	=item $windowid = $term->parent
756		1003
757	Return the window id of the toplevel window.	1004	Return the window id of the toplevel window.
758		1005
759	=item $windowid = $term->vt	1006	=item $windowid = $term->vt
…		…
783	=item $nrow_plus_saveLines = $term->total_rows	1030	=item $nrow_plus_saveLines = $term->total_rows
784		1031
785	=item $lines_in_scrollback = $term->nsaved	1032	=item $lines_in_scrollback = $term->nsaved
786		1033
787	Return various integers describing terminal characteristics.	1034	Return various integers describing terminal characteristics.
		1035
		1036	=item $lc_ctype = $term->locale
		1037
		1038	Returns the LC_CTYPE category string used by this rxvt-unicode.
		1039
		1040	=item $x_display = $term->display_id
		1041
		1042	Return the DISPLAY used by rxvt-unicode.
788		1043
789	=item $modifiermask = $term->ModLevel3Mask	1044	=item $modifiermask = $term->ModLevel3Mask
790		1045
791	=item $modifiermask = $term->ModMetaMask	1046	=item $modifiermask = $term->ModMetaMask
792		1047
…		…
895		1150
896	=back	1151	=back
897		1152
898	=cut	1153	=cut
899		1154
900	sub urxvt::term::line {	1155	sub line {
901	my ($self, $row) = @_;	1156	my ($self, $row) = @_;
902		1157
903	my $maxrow = $self->nrow - 1;	1158	my $maxrow = $self->nrow - 1;
904		1159
905	my ($beg, $end) = ($row, $row);	1160	my ($beg, $end) = ($row, $row);
…		…
969	$offset / $self->{ncol} + $self->{beg},	1224	$offset / $self->{ncol} + $self->{beg},
970	$offset % $self->{ncol}	1225	$offset % $self->{ncol}
971	)	1226	)
972	}	1227	}
973		1228
974	=item ($row, $col) = $line->coord_of ($offset)
975	=item $text = $term->special_encode $string	1229	=item $text = $term->special_encode $string
976		1230
977	Converts a perl string into the special encoding used by rxvt-unicode,	1231	Converts a perl string into the special encoding used by rxvt-unicode,
978	where one character corresponds to one screen cell. See	1232	where one character corresponds to one screen cell. See
979	C<< $term->ROW_t >> for details.	1233	C<< $term->ROW_t >> for details.
…		…
981	=item $string = $term->special_decode $text	1235	=item $string = $term->special_decode $text
982		1236
983	Converts rxvt-unicodes text reprsentation into a perl string. See	1237	Converts rxvt-unicodes text reprsentation into a perl string. See
984	C<< $term->ROW_t >> for details.	1238	C<< $term->ROW_t >> for details.
985		1239
		1240	=item $success = $term->grab_button ($button, $modifiermask)
		1241
		1242	Registers a synchronous button grab. See the XGrabButton manpage.
		1243
		1244	=item $success = $term->grab ($eventtime[, $sync])
		1245
		1246	Calls XGrabPointer and XGrabKeyboard in asynchronous (default) or
		1247	synchronous (C<$sync> is true). Also remembers the grab timestampe.
		1248
		1249	=item $term->allow_events_async
		1250
		1251	Calls XAllowEvents with AsyncBoth for the most recent grab.
		1252
		1253	=item $term->allow_events_sync
		1254
		1255	Calls XAllowEvents with SyncBoth for the most recent grab.
		1256
		1257	=item $term->allow_events_replay
		1258
		1259	Calls XAllowEvents with both ReplayPointer and ReplayKeyboard for the most
		1260	recent grab.
		1261
		1262	=item $term->ungrab
		1263
		1264	Calls XUngrab for the most recent grab. Is called automatically on
		1265	evaluation errors, as it is better to lose the grab in the error case as
		1266	the session.
		1267
986	=back	1268	=back
987		1269
		1270	=cut
		1271
		1272	package urxvt::popup;
		1273
988	=head2 The C<urxvt::popup> Class	1274	=head2 The C<urxvt::popup> Class
989		1275
990	=over 4	1276	=over 4
991		1277
992	=cut	1278	=cut
993
994	package urxvt::popup;
995		1279
996	sub add_item {	1280	sub add_item {
997	my ($self, $item) = @_;	1281	my ($self, $item) = @_;
998		1282
		1283	$item->{rend}{normal} = "\x1b[0;30;47m" unless exists $item->{rend}{normal};
		1284	$item->{rend}{hover} = "\x1b[0;30;46m" unless exists $item->{rend}{hover};
		1285	$item->{rend}{active} = "\x1b[m" unless exists $item->{rend}{active};
		1286
		1287	$item->{render} \|\|= sub { $_[0]{text} };
		1288
999	push @{ $self->{item} }, $item;	1289	push @{ $self->{item} }, $item;
		1290	}
		1291
		1292	sub add_separator {
		1293	my ($self, $sep) = @_;
		1294
		1295	$sep \|\|= "=";
		1296
		1297	$self->add_item ({
		1298	rend => { normal => "\x1b[0;30;47m", hover => "\x1b[0;30;47m", active => "\x1b[0;30;47m" },
		1299	text => "",
		1300	render => sub { $sep x $self->{term}->ncol },
		1301	activate => sub { },
		1302	});
		1303	}
		1304
		1305	sub add_title {
		1306	my ($self, $title) = @_;
		1307
		1308	$self->add_item ({
		1309	rend => { normal => "\x1b[38;5;11;44m", hover => "\x1b[38;5;11;44m", active => "\x1b[38;5;11;44m" },
		1310	text => $title,
		1311	activate => sub { },
		1312	});
1000	}	1313	}
1001		1314
1002	sub add_button {	1315	sub add_button {
1003	my ($self, $text, $cb) = @_;	1316	my ($self, $text, $cb) = @_;
1004		1317
1005	$self->add_item ({ type => "button", text => "[ $text ]", activate => $cb });	1318	$self->add_item ({ type => "button", text => $text, activate => $cb});
		1319	}
		1320
		1321	sub add_toggle {
		1322	my ($self, $text, $cb, $value) = @_;
		1323
		1324	my $item; $item = {
		1325	type => "button",
		1326	text => " $text",
		1327	value => $value,
		1328	render => sub { ($_[0]{value} ? "* " : " ") . $text },
		1329	activate => sub { $cb->($_[0]{value} = !$_[0]{value}); },
		1330	};
		1331
		1332	$self->add_item ($item);
1006	}	1333	}
1007		1334
1008	sub show {	1335	sub show {
1009	my ($self) = @_;	1336	my ($self) = @_;
1010		1337
1011	local $urxvt::popup::self = $self;	1338	local $urxvt::popup::self = $self;
1012		1339
		1340	local $ENV{LC_ALL} = $self->{term}->locale;
		1341
1013	urxvt->new ("--perl-lib" => "", "--perl-ext-common" => "", "-pty-fd" => -1, "-sl" => 0, "-b" => 0,	1342	urxvt->new ("--perl-lib" => "", "--perl-ext-common" => "", "-pty-fd" => -1, "-sl" => 0, "-b" => 0,
1014	"--transient-for" => $self->{term}->parent,	1343	"--transient-for" => $self->{term}->parent,
		1344	"-display" => $self->{term}->display_id,
1015	"-pe" => "urxvt-popup")	1345	"-pe" => "urxvt-popup")
1016	or die "unable to create popup window\n";	1346	or die "unable to create popup window\n";
1017	}	1347	}
1018		1348
1019	sub DESTROY {	1349	sub DESTROY {
1020	my ($self) = @_;	1350	my ($self) = @_;
1021		1351
		1352	delete $self->{term}{_destroy}{$self};
1022	$self->{term}->ungrab;	1353	$self->{term}->ungrab;
1023	}	1354	}
1024		1355
1025	=head2 The C<urxvt::timer> Class	1356	=head2 The C<urxvt::timer> Class
1026		1357
…		…
1081		1412
1082	$term->{socket} = ...	1413	$term->{socket} = ...
1083	$term->{iow} = urxvt::iow	1414	$term->{iow} = urxvt::iow
1084	->new	1415	->new
1085	->fd (fileno $term->{socket})	1416	->fd (fileno $term->{socket})
1086	->events (1) # wait for read data	1417	->events (urxvt::EVENT_READ)
1087	->start	1418	->start
1088	->cb (sub {	1419	->cb (sub {
1089	my ($iow, $revents) = @_;	1420	my ($iow, $revents) = @_;
1090	# $revents must be 1 here, no need to check	1421	# $revents must be 1 here, no need to check
1091	sysread $term->{socket}, my $buf, 8192	1422	sysread $term->{socket}, my $buf, 8192
…		…
1108		1439
1109	Set the filedescriptor (not handle) to watch.	1440	Set the filedescriptor (not handle) to watch.
1110		1441
1111	=item $iow = $iow->events ($eventmask)	1442	=item $iow = $iow->events ($eventmask)
1112		1443
1113	Set the event mask to watch. Bit #0 (value C<1>) enables watching for read	1444	Set the event mask to watch. The only allowed values are
1114	data, Bit #1 (value C<2>) enables watching for write data.	1445	C<urxvt::EVENT_READ> and C<urxvt::EVENT_WRITE>, which might be ORed
		1446	together, or C<urxvt::EVENT_NONE>.
1115		1447
1116	=item $iow = $iow->start	1448	=item $iow = $iow->start
1117		1449
1118	Start watching for requested events on the given handle.	1450	Start watching for requested events on the given handle.
1119		1451
…		…
1130	This variable controls the verbosity level of the perl extension. Higher	1462	This variable controls the verbosity level of the perl extension. Higher
1131	numbers indicate more verbose output.	1463	numbers indicate more verbose output.
1132		1464
1133	=over 4	1465	=over 4
1134		1466
1135	=item =0 - only fatal messages	1467	=item == 0 - fatal messages
1136		1468
1137	=item =3 - script loading and management	1469	=item >= 3 - script loading and management
1138		1470
1139	=item =10 - all events received	1471	=item >=10 - all events received
1140		1472
1141	=back	1473	=back
1142		1474
1143	=head1 AUTHOR	1475	=head1 AUTHOR
1144		1476

Diff Legend

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

Comparing rxvt-unicode/src/urxvt.pm (file contents): Revision 1.47 by root, Sat Jan 7 21:22:02 2006 UTC vs. Revision 1.73 by root, Tue Jan 10 04:23:39 2006 UTC

Diff Legend

Comparing rxvt-unicode/src/urxvt.pm (file contents):
Revision 1.47 by root, Sat Jan 7 21:22:02 2006 UTC vs.
Revision 1.73 by root, Tue Jan 10 04:23:39 2006 UTC