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

Comparing rxvt-unicode/src/urxvt.pm (file contents):
Revision 1.46 by root, Sat Jan 7 20:29:28 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).
		389
		390	=item urxvt::CurrentTime
		391
		392	=item urxvt::ShiftMask, LockMask, ControlMask, Mod1Mask, Mod2Mask,
		393	Mod3Mask, Mod4Mask, Mod5Mask, Button1Mask, Button2Mask, Button3Mask,
		394	Button4Mask, Button5Mask, AnyModifier
		395
		396	Various constants for use in X calls and event processing.
335		397
336	=back	398	=back
337		399
338	=head2 RENDITION	400	=head2 RENDITION
339		401
…		…
389		451
390	=cut	452	=cut
391		453
392	package urxvt;	454	package urxvt;
393		455
		456	use utf8;
394	use strict;	457	use strict;
		458	use Carp ();
395	use Scalar::Util ();	459	use Scalar::Util ();
		460	use List::Util ();
396		461
		462	our $VERSION = 1;
397	our $TERM;	463	our $TERM;
398	our @HOOKNAME;	464	our @HOOKNAME;
		465	our %HOOKTYPE = map +($HOOKNAME[$_] => $_), 0..$#HOOKNAME;
		466	our %OPTION;
		467
399	our $LIBDIR;	468	our $LIBDIR;
		469	our $RESNAME;
		470	our $RESCLASS;
		471	our $RXVTNAME;
400		472
401	BEGIN {	473	BEGIN {
402	urxvt->bootstrap;	474	urxvt->bootstrap;
403		475
404	# overwrite perl's warn	476	# overwrite perl's warn
…		…
406	my $msg = join "", @_;	478	my $msg = join "", @_;
407	$msg .= "\n"	479	$msg .= "\n"
408	unless $msg =~ /\n$/;	480	unless $msg =~ /\n$/;
409	urxvt::warn ($msg);	481	urxvt::warn ($msg);
410	};	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";
411	}	488	}
412		489
413	my @hook_count;	490	my @hook_count;
414	my $verbosity = $ENV{URXVT_PERL_VERBOSITY};	491	my $verbosity = $ENV{URXVT_PERL_VERBOSITY};
415		492
416	sub verbose {	493	sub verbose {
417	my ($level, $msg) = @_;	494	my ($level, $msg) = @_;
418	warn "$msg\n" if $level <= $verbosity;	495	warn "$msg\n" if $level <= $verbosity;
419	}	496	}
420		497
421	# find on_xxx subs in the package and register them
422	# as hooks
423	sub register_package($) {
424	my ($pkg) = @_;
425
426	for my $htype (0.. $#HOOKNAME) {
427	my $name = $HOOKNAME[$htype];
428
429	my $ref = $pkg->can ("on_" . lc $name)
430	or next;
431
432	$TERM->{_hook}[$htype]{$pkg} = $ref;
433	$hook_count[$htype]++
434	or set_should_invoke $htype, 1;
435	}
436	}
437
438	my $extension_pkg = "extension0000";	498	my $extension_pkg = "extension0000";
439	my %extension_pkg;	499	my %extension_pkg;
440		500
441	# load a single script into its own package, once only	501	# load a single script into its own package, once only
442	sub extension_package($) {	502	sub extension_package($) {
…		…
448	verbose 3, "loading extension '$path' into package '$pkg'";	508	verbose 3, "loading extension '$path' into package '$pkg'";
449		509
450	open my $fh, "<:raw", $path	510	open my $fh, "<:raw", $path
451	or die "$path: $!";	511	or die "$path: $!";
452		512
		513	my $source = untaint
453	my $source = "package $pkg; use strict; use utf8;\n"	514	"package $pkg; use strict; use utf8;\n"
454	. "use base urxvt::term::proxy::;\n"	515	. "use base urxvt::term::extension::;\n"
455	. "#line 1 \"$path\"\n{\n"	516	. "#line 1 \"$path\"\n{\n"
456	. (do { local $/; <$fh> })	517	. (do { local $/; <$fh> })
457	. "\n};\n1";	518	. "\n};\n1";
458		519
		520	eval $source
459	eval $source or die "$path: $@";	521	or die "$path: $@";
460		522
461	$pkg	523	$pkg
462	}	524	}
463	}	525	}
464		526
…		…
469	local $TERM = shift;	531	local $TERM = shift;
470	my $htype = shift;	532	my $htype = shift;
471		533
472	if ($htype == 0) { # INIT	534	if ($htype == 0) { # INIT
473	my @dirs = ((split /:/, $TERM->resource ("perl_lib")), "$LIBDIR/perl");	535	my @dirs = ((split /:/, $TERM->resource ("perl_lib")), "$LIBDIR/perl");
		536
		537	my %ext_arg;
474		538
475	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) {
476	my @files = grep -f $_, map "$_/$ext", @dirs;	552	my @files = grep -f $_, map "$_/$ext", @dirs;
477		553
478	if (@files) {	554	if (@files) {
479	register_package extension_package $files[0];	555	$TERM->register_package (extension_package $files[0], $argv);
480	} else {	556	} else {
481	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";
482	}	558	}
483	}	559	}
		560
		561	eval "#line 1 \"--perl-eval resource/argument\"\n" . $TERM->resource ("perl_eval");
		562	warn $@ if $@;
484	}	563	}
485		564
486	$retval = undef;	565	$retval = undef;
487		566
488	if (my $cb = $TERM->{_hook}[$htype]) {	567	if (my $cb = $TERM->{_hook}[$htype]) {
…		…
490	if $verbosity >= 10;	569	if $verbosity >= 10;
491		570
492	keys %$cb;	571	keys %$cb;
493		572
494	while (my ($pkg, $cb) = each %$cb) {	573	while (my ($pkg, $cb) = each %$cb) {
495	eval {	574	$retval = eval { $cb->($TERM->{_pkg}{$pkg}, @_) }
496	$retval = $cb->(
497	$TERM->{_pkg}{$pkg} \|\|= do {
498	my $proxy = bless { }, $pkg;
499	Scalar::Util::weaken ($proxy->{term} = $TERM);
500	$proxy
501	},
502	@_,
503	) and last;	575	and last;
		576
		577	if ($@) {
		578	$TERM->ungrab; # better to lose the grab than the session
		579	warn $@;
504	};	580	}
505	warn $@ if $@;#d#
506	}	581	}
507	}	582	}
508		583
509	if ($htype == 1) { # DESTROY	584	if ($htype == 1) { # DESTROY
510	# remove hooks if unused
511	if (my $hook = $TERM->{_hook}) {	585	if (my $hook = delete $TERM->{_hook}) {
512	for my $htype (0..$#$hook) {	586	for my $htype (0..$#$hook) {
513	$hook_count[$htype] -= scalar keys %{ $hook->[$htype] \|\| {} }	587	$hook_count[$htype] -= scalar keys %{ $hook->[$htype] \|\| {} }
514	or set_should_invoke $htype, 0;	588	or set_should_invoke $htype, 0;
515	}	589	}
516	}	590	}
…		…
523	}	597	}
524		598
525	$retval	599	$retval
526	}	600	}
527		601
528	sub urxvt::term::proxy::AUTOLOAD {	602	# urxvt::term::extension
529	$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 =~ /:([^:]+)$/
530	or die "FATAL: \$AUTOLOAD '$urxvt::term::proxy::AUTOLOAD' unparsable";	644	or die "FATAL: \$AUTOLOAD '$AUTOLOAD' unparsable";
531		645
532	eval qq{	646	eval qq{
533	sub $urxvt::term::proxy::AUTOLOAD {	647	sub $AUTOLOAD {
534	my \$proxy = shift;	648	my \$proxy = shift;
535	\$proxy->{term}->$1 (\@_)	649	\$proxy->{term}->$1 (\@_)
536	}	650	}
537	1	651	1
538	} or die "FATAL: unable to compile method forwarder: $@";	652	} or die "FATAL: unable to compile method forwarder: $@";
539		653
540	goto &$urxvt::term::proxy::AUTOLOAD;	654	goto &$AUTOLOAD;
541	}	655	}
		656
		657	sub DESTROY {
		658	# nop
		659	}
		660
		661	# urxvt::destroy_hook
542		662
543	sub urxvt::destroy_hook::DESTROY {	663	sub urxvt::destroy_hook::DESTROY {
544	${$_[0]}->();	664	${$_[0]}->();
545	}	665	}
546		666
547	sub urxvt::destroy_hook(&) {	667	sub urxvt::destroy_hook(&) {
548	bless \shift, urxvt::destroy_hook::	668	bless \shift, urxvt::destroy_hook::
549	}	669	}
550		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
551	=head2 The C<urxvt::term> Class	740	=head2 The C<urxvt::term> Class
552		741
553	=over 4	742	=over 4
554		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
555	=item $term->destroy	766	=item $term->destroy
556		767
557	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
558		785
559	=item $value = $term->resource ($name[, $newval])	786	=item $value = $term->resource ($name[, $newval])
560		787
561	Returns the current resource value associated with a given name and	788	Returns the current resource value associated with a given name and
562	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>
…		…
572		799
573	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
574	terminal is destroyed, so changing options frequently will eat memory.	801	terminal is destroyed, so changing options frequently will eat memory.
575		802
576	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
577	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>
578	list:	805	to see the actual list:
579		806
580	answerbackstring backgroundPixmap backspace_key boldFont boldItalicFont	807	answerbackstring backgroundPixmap backspace_key boldFont boldItalicFont
581	borderLess color cursorBlink cursorUnderline cutchars delete_key	808	borderLess color cursorBlink cursorUnderline cutchars delete_key
582	display_name embed ext_bwidth fade font geometry hold iconName	809	display_name embed ext_bwidth fade font geometry hold iconName
583	imFont imLocale inputMethod insecure int_bwidth intensityStyles	810	imFont imLocale inputMethod insecure int_bwidth intensityStyles
…		…
590	shade term_name title transparent transparent_all tripleclickwords	817	shade term_name title transparent transparent_all tripleclickwords
591	utmpInhibit visualBell	818	utmpInhibit visualBell
592		819
593	=cut	820	=cut
594		821
595	sub urxvt::term::resource($$;$) {	822	sub resource($$;$) {
596	my ($self, $name) = (shift, shift);	823	my ($self, $name) = (shift, shift);
597	unshift @_, $self, $name, ($name =~ s/\s\+\s(\d+)$// ? $1 : 0);	824	unshift @_, $self, $name, ($name =~ s/\s\+\s(\d+)$// ? $1 : 0);
598	&urxvt::term::_resource	825	&urxvt::term::_resource
599	}	826	}
600		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
601	=item $rend = $term->rstyle ([$new_rstyle])	833	=item $rend = $term->rstyle ([$new_rstyle])
602		834
603	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
604	the terminal application will use this style.	836	the terminal application will use this style.
605		837
…		…
624		856
625	=item $oldtext = $term->selection ([$newtext])	857	=item $oldtext = $term->selection ([$newtext])
626		858
627	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>.
628		860
629	#=item $term->overlay ($x, $y, $text)	861	=item $term->overlay_simple ($x, $y, $text)
630	#	862
631	#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.
632	#	864
633	#=cut	865	=cut
634	#	866
635	#sub urxvt::term::scr_overlay {	867	sub overlay_simple {
636	# my ($self, $x, $y, $text) = @_;	868	my ($self, $x, $y, $text) = @_;
637	#	869
638	# my @lines = split /\n/, $text;	870	my @lines = split /\n/, $text;
639	#	871
640	# my $w = 0;	872	my $w = List::Util::max map $self->strwidth ($_), @lines;
641	# for (map $self->strwidth ($_), @lines) {	873
642	# $w = $_ if $w < $_;
643	# }
644	#
645	# $self->scr_overlay_new ($x, $y, $w, scalar @lines);	874	my $overlay = $self->overlay ($x, $y, $w, scalar @lines);
646	# $self->scr_overlay_set (0, $_, $lines[$_]) for 0.. $#lines;	875	$overlay->set (0, $_, $lines[$_]) for 0.. $#lines;
647	#}	876
		877	$overlay
		878	}
648		879
649	=item $term->overlay ($x, $y, $width, $height[, $rstyle[, $border]])	880	=item $term->overlay ($x, $y, $width, $height[, $rstyle[, $border]])
650		881
651	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
652	width/height. C<$rstyle> defines the initial rendition style	883	width/height. C<$rstyle> defines the initial rendition style
…		…
687	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,
688	currently).	919	currently).
689		920
690	=cut	921	=cut
691		922
692	sub urxvt::term::popup {	923	sub popup {
693	my ($self, $event) = @_;	924	my ($self, $event) = @_;
694		925
695	$self->grab ($event->{time}, 1)	926	$self->grab ($event->{time}, 1)
696	or return;	927	or return;
697		928
…		…
719		950
720	=item $string = $term->locale_decode ($octets)	951	=item $string = $term->locale_decode ($octets)
721		952
722	Convert the given locale-encoded octets into a perl string.	953	Convert the given locale-encoded octets into a perl string.
723		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
724	=item $term->scr_add_lines ($string)	972	=item $term->scr_add_lines ($string)
725		973
726	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
727	running inside the terminal. It may not contain command sequences (escape	975	running inside the terminal. It may not contain command sequences (escape
728	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
…		…
742		990
743	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
744	pass characters instead of octets, you should convert your strings first	992	pass characters instead of octets, you should convert your strings first
745	to the locale-specific encoding using C<< $term->locale_encode >>.	993	to the locale-specific encoding using C<< $term->locale_encode >>.
746		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
747	=item $windowid = $term->parent	1002	=item $windowid = $term->parent
748		1003
749	Return the window id of the toplevel window.	1004	Return the window id of the toplevel window.
750		1005
751	=item $windowid = $term->vt	1006	=item $windowid = $term->vt
…		…
775	=item $nrow_plus_saveLines = $term->total_rows	1030	=item $nrow_plus_saveLines = $term->total_rows
776		1031
777	=item $lines_in_scrollback = $term->nsaved	1032	=item $lines_in_scrollback = $term->nsaved
778		1033
779	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.
		1043
		1044	=item $modifiermask = $term->ModLevel3Mask
		1045
		1046	=item $modifiermask = $term->ModMetaMask
		1047
		1048	=item $modifiermask = $term->ModNumLockMask
		1049
		1050	Return the modifier masks corresponding to the "ISO Level 3 Shift" (often
		1051	AltGr), the meta key (often Alt) and the num lock key, if applicable.
780		1052
781	=item $view_start = $term->view_start ([$newvalue])	1053	=item $view_start = $term->view_start ([$newvalue])
782		1054
783	Returns the negative row number of the topmost line. Minimum value is	1055	Returns the negative row number of the topmost line. Minimum value is
784	C<0>, which displays the normal terminal contents. Larger values scroll	1056	C<0>, which displays the normal terminal contents. Larger values scroll
…		…
878		1150
879	=back	1151	=back
880		1152
881	=cut	1153	=cut
882		1154
883	sub urxvt::term::line {	1155	sub line {
884	my ($self, $row) = @_;	1156	my ($self, $row) = @_;
885		1157
886	my $maxrow = $self->nrow - 1;	1158	my $maxrow = $self->nrow - 1;
887		1159
888	my ($beg, $end) = ($row, $row);	1160	my ($beg, $end) = ($row, $row);
…		…
952	$offset / $self->{ncol} + $self->{beg},	1224	$offset / $self->{ncol} + $self->{beg},
953	$offset % $self->{ncol}	1225	$offset % $self->{ncol}
954	)	1226	)
955	}	1227	}
956		1228
957	=item ($row, $col) = $line->coord_of ($offset)
958	=item $text = $term->special_encode $string	1229	=item $text = $term->special_encode $string
959		1230
960	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,
961	where one character corresponds to one screen cell. See	1232	where one character corresponds to one screen cell. See
962	C<< $term->ROW_t >> for details.	1233	C<< $term->ROW_t >> for details.
…		…
964	=item $string = $term->special_decode $text	1235	=item $string = $term->special_decode $text
965		1236
966	Converts rxvt-unicodes text reprsentation into a perl string. See	1237	Converts rxvt-unicodes text reprsentation into a perl string. See
967	C<< $term->ROW_t >> for details.	1238	C<< $term->ROW_t >> for details.
968		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
969	=back	1268	=back
970		1269
		1270	=cut
		1271
		1272	package urxvt::popup;
		1273
971	=head2 The C<urxvt::popup> Class	1274	=head2 The C<urxvt::popup> Class
972		1275
973	=over 4	1276	=over 4
974		1277
975	=cut	1278	=cut
976
977	package urxvt::popup;
978		1279
979	sub add_item {	1280	sub add_item {
980	my ($self, $item) = @_;	1281	my ($self, $item) = @_;
981		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
982	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	});
983	}	1313	}
984		1314
985	sub add_button {	1315	sub add_button {
986	my ($self, $text, $cb) = @_;	1316	my ($self, $text, $cb) = @_;
987		1317
988	$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);
989	}	1333	}
990		1334
991	sub show {	1335	sub show {
992	my ($self) = @_;	1336	my ($self) = @_;
993		1337
994	local $urxvt::popup::self = $self;	1338	local $urxvt::popup::self = $self;
995		1339
		1340	local $ENV{LC_ALL} = $self->{term}->locale;
		1341
996	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,
997	"--transient-for" => $self->{term}->parent,	1343	"--transient-for" => $self->{term}->parent,
		1344	"-display" => $self->{term}->display_id,
998	"-pe" => "urxvt-popup")	1345	"-pe" => "urxvt-popup")
999	or die "unable to create popup window\n";	1346	or die "unable to create popup window\n";
1000	}	1347	}
1001		1348
1002	sub DESTROY {	1349	sub DESTROY {
1003	my ($self) = @_;	1350	my ($self) = @_;
1004		1351
		1352	delete $self->{term}{_destroy}{$self};
1005	$self->{term}->ungrab;	1353	$self->{term}->ungrab;
1006	}	1354	}
1007		1355
1008	=head2 The C<urxvt::timer> Class	1356	=head2 The C<urxvt::timer> Class
1009		1357
…		…
1064		1412
1065	$term->{socket} = ...	1413	$term->{socket} = ...
1066	$term->{iow} = urxvt::iow	1414	$term->{iow} = urxvt::iow
1067	->new	1415	->new
1068	->fd (fileno $term->{socket})	1416	->fd (fileno $term->{socket})
1069	->events (1) # wait for read data	1417	->events (urxvt::EVENT_READ)
1070	->start	1418	->start
1071	->cb (sub {	1419	->cb (sub {
1072	my ($iow, $revents) = @_;	1420	my ($iow, $revents) = @_;
1073	# $revents must be 1 here, no need to check	1421	# $revents must be 1 here, no need to check
1074	sysread $term->{socket}, my $buf, 8192	1422	sysread $term->{socket}, my $buf, 8192
…		…
1091		1439
1092	Set the filedescriptor (not handle) to watch.	1440	Set the filedescriptor (not handle) to watch.
1093		1441
1094	=item $iow = $iow->events ($eventmask)	1442	=item $iow = $iow->events ($eventmask)
1095		1443
1096	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
1097	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>.
1098		1447
1099	=item $iow = $iow->start	1448	=item $iow = $iow->start
1100		1449
1101	Start watching for requested events on the given handle.	1450	Start watching for requested events on the given handle.
1102		1451
…		…
1113	This variable controls the verbosity level of the perl extension. Higher	1462	This variable controls the verbosity level of the perl extension. Higher
1114	numbers indicate more verbose output.	1463	numbers indicate more verbose output.
1115		1464
1116	=over 4	1465	=over 4
1117		1466
1118	=item =0 - only fatal messages	1467	=item == 0 - fatal messages
1119		1468
1120	=item =3 - script loading and management	1469	=item >= 3 - script loading and management
1121		1470
1122	=item =10 - all events received	1471	=item >=10 - all events received
1123		1472
1124	=back	1473	=back
1125		1474
1126	=head1 AUTHOR	1475	=head1 AUTHOR
1127		1476

Diff Legend

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

Comparing rxvt-unicode/src/urxvt.pm (file contents): Revision 1.46 by root, Sat Jan 7 20:29:28 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.46 by root, Sat Jan 7 20:29:28 2006 UTC vs.
Revision 1.73 by root, Tue Jan 10 04:23:39 2006 UTC