[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.72 by root, Mon Jan 9 23:30:01 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;
399	our $LIBDIR;	467	our $LIBDIR;
400		468
401	BEGIN {	469	BEGIN {
402	urxvt->bootstrap;	470	urxvt->bootstrap;
403		471
…		…
406	my $msg = join "", @_;	474	my $msg = join "", @_;
407	$msg .= "\n"	475	$msg .= "\n"
408	unless $msg =~ /\n$/;	476	unless $msg =~ /\n$/;
409	urxvt::warn ($msg);	477	urxvt::warn ($msg);
410	};	478	};
		479
		480	delete $ENV{IFS};
		481	delete $ENV{CDPATH};
		482	delete $ENV{BASH_ENV};
		483	$ENV{PATH} = "/bin:/sbin:/usr/bin:/usr/sbin:/usr/local/bin:/usr/local/sbin:/opt/bin:/opt/sbin";
411	}	484	}
412		485
413	my @hook_count;	486	my @hook_count;
414	my $verbosity = $ENV{URXVT_PERL_VERBOSITY};	487	my $verbosity = $ENV{URXVT_PERL_VERBOSITY};
415		488
416	sub verbose {	489	sub verbose {
417	my ($level, $msg) = @_;	490	my ($level, $msg) = @_;
418	warn "$msg\n" if $level <= $verbosity;	491	warn "$msg\n" if $level <= $verbosity;
419	}	492	}
420		493
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";	494	my $extension_pkg = "extension0000";
439	my %extension_pkg;	495	my %extension_pkg;
440		496
441	# load a single script into its own package, once only	497	# load a single script into its own package, once only
442	sub extension_package($) {	498	sub extension_package($) {
…		…
448	verbose 3, "loading extension '$path' into package '$pkg'";	504	verbose 3, "loading extension '$path' into package '$pkg'";
449		505
450	open my $fh, "<:raw", $path	506	open my $fh, "<:raw", $path
451	or die "$path: $!";	507	or die "$path: $!";
452		508
		509	my $source = untaint
453	my $source = "package $pkg; use strict; use utf8;\n"	510	"package $pkg; use strict; use utf8;\n"
454	. "use base urxvt::term::proxy::;\n"	511	. "use base urxvt::term::extension::;\n"
455	. "#line 1 \"$path\"\n{\n"	512	. "#line 1 \"$path\"\n{\n"
456	. (do { local $/; <$fh> })	513	. (do { local $/; <$fh> })
457	. "\n};\n1";	514	. "\n};\n1";
458		515
		516	eval $source
459	eval $source or die "$path: $@";	517	or die "$path: $@";
460		518
461	$pkg	519	$pkg
462	}	520	}
463	}	521	}
464		522
…		…
469	local $TERM = shift;	527	local $TERM = shift;
470	my $htype = shift;	528	my $htype = shift;
471		529
472	if ($htype == 0) { # INIT	530	if ($htype == 0) { # INIT
473	my @dirs = ((split /:/, $TERM->resource ("perl_lib")), "$LIBDIR/perl");	531	my @dirs = ((split /:/, $TERM->resource ("perl_lib")), "$LIBDIR/perl");
		532
		533	my %ext_arg;
474		534
475	for my $ext (map { split /,/, $TERM->resource ("perl_ext_$_") } 1, 2) {	535	for (map { split /,/, $TERM->resource ("perl_ext_$_") } 1, 2) {
		536	if ($_ eq "default") {
		537	$ext_arg{$_} \|\|= [] for qw(selection option-popup selection-popup searchable-scrollback);
		538	} elsif (/^-(.*)$/) {
		539	delete $ext_arg{$1};
		540	} elsif (/^([^<]+)<(.*)>$/) {
		541	push @{ $ext_arg{$1} }, $2;
		542	} else {
		543	$ext_arg{$_} \|\|= [];
		544	}
		545	}
		546
		547	while (my ($ext, $argv) = each %ext_arg) {
476	my @files = grep -f $_, map "$_/$ext", @dirs;	548	my @files = grep -f $_, map "$_/$ext", @dirs;
477		549
478	if (@files) {	550	if (@files) {
479	register_package extension_package $files[0];	551	$TERM->register_package (extension_package $files[0], $argv);
480	} else {	552	} else {
481	warn "perl extension '$ext' not found in perl library search path\n";	553	warn "perl extension '$ext' not found in perl library search path\n";
482	}	554	}
483	}	555	}
		556
		557	eval "#line 1 \"--perl-eval resource/argument\"\n" . $TERM->resource ("perl_eval");
		558	warn $@ if $@;
484	}	559	}
485		560
486	$retval = undef;	561	$retval = undef;
487		562
488	if (my $cb = $TERM->{_hook}[$htype]) {	563	if (my $cb = $TERM->{_hook}[$htype]) {
…		…
490	if $verbosity >= 10;	565	if $verbosity >= 10;
491		566
492	keys %$cb;	567	keys %$cb;
493		568
494	while (my ($pkg, $cb) = each %$cb) {	569	while (my ($pkg, $cb) = each %$cb) {
495	eval {	570	$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;	571	and last;
		572
		573	if ($@) {
		574	$TERM->ungrab; # better to lose the grab than the session
		575	warn $@;
504	};	576	}
505	warn $@ if $@;#d#
506	}	577	}
507	}	578	}
508		579
509	if ($htype == 1) { # DESTROY	580	if ($htype == 1) { # DESTROY
510	# remove hooks if unused
511	if (my $hook = $TERM->{_hook}) {	581	if (my $hook = delete $TERM->{_hook}) {
512	for my $htype (0..$#$hook) {	582	for my $htype (0..$#$hook) {
513	$hook_count[$htype] -= scalar keys %{ $hook->[$htype] \|\| {} }	583	$hook_count[$htype] -= scalar keys %{ $hook->[$htype] \|\| {} }
514	or set_should_invoke $htype, 0;	584	or set_should_invoke $htype, 0;
515	}	585	}
516	}	586	}
…		…
523	}	593	}
524		594
525	$retval	595	$retval
526	}	596	}
527		597
528	sub urxvt::term::proxy::AUTOLOAD {	598	# urxvt::term::extension
529	$urxvt::term::proxy::AUTOLOAD =~ /:([^:]+)$/	599
		600	package urxvt::term::extension;
		601
		602	sub enable {
		603	my ($self, %hook) = @_;
		604	my $pkg = $self->{_pkg};
		605
		606	while (my ($name, $cb) = each %hook) {
		607	my $htype = $HOOKTYPE{uc $name};
		608	defined $htype
		609	or Carp::croak "unsupported hook type '$name'";
		610
		611	unless (exists $self->{term}{_hook}[$htype]{$pkg}) {
		612	$hook_count[$htype]++
		613	or urxvt::set_should_invoke $htype, 1;
		614	}
		615
		616	$self->{term}{_hook}[$htype]{$pkg} = $cb;
		617	}
		618	}
		619
		620	sub disable {
		621	my ($self, @hook) = @_;
		622	my $pkg = $self->{_pkg};
		623
		624	for my $name (@hook) {
		625	my $htype = $HOOKTYPE{uc $name};
		626	defined $htype
		627	or Carp::croak "unsupported hook type '$name'";
		628
		629	if (delete $self->{term}{_hook}[$htype]{$pkg}) {
		630	--$hook_count[$htype]
		631	or urxvt::set_should_invoke $htype, 0;
		632	}
		633	}
		634	}
		635
		636	our $AUTOLOAD;
		637
		638	sub AUTOLOAD {
		639	$AUTOLOAD =~ /:([^:]+)$/
530	or die "FATAL: \$AUTOLOAD '$urxvt::term::proxy::AUTOLOAD' unparsable";	640	or die "FATAL: \$AUTOLOAD '$AUTOLOAD' unparsable";
531		641
532	eval qq{	642	eval qq{
533	sub $urxvt::term::proxy::AUTOLOAD {	643	sub $AUTOLOAD {
534	my \$proxy = shift;	644	my \$proxy = shift;
535	\$proxy->{term}->$1 (\@_)	645	\$proxy->{term}->$1 (\@_)
536	}	646	}
537	1	647	1
538	} or die "FATAL: unable to compile method forwarder: $@";	648	} or die "FATAL: unable to compile method forwarder: $@";
539		649
540	goto &$urxvt::term::proxy::AUTOLOAD;	650	goto &$AUTOLOAD;
541	}	651	}
		652
		653	sub DESTROY {
		654	# nop
		655	}
		656
		657	# urxvt::destroy_hook
542		658
543	sub urxvt::destroy_hook::DESTROY {	659	sub urxvt::destroy_hook::DESTROY {
544	${$_[0]}->();	660	${$_[0]}->();
545	}	661	}
546		662
547	sub urxvt::destroy_hook(&) {	663	sub urxvt::destroy_hook(&) {
548	bless \shift, urxvt::destroy_hook::	664	bless \shift, urxvt::destroy_hook::
549	}	665	}
550		666
		667	package urxvt::anyevent;
		668
		669	=head2 The C<urxvt::anyevent> Class
		670
		671	The sole purpose of this class is to deliver an interface to the
		672	C<AnyEvent> module - any module using it will work inside urxvt without
		673	further work. The only exception is that you cannot wait on condition
		674	variables, but non-blocking condvar use is ok. What this means is that you
		675	cannot use blocking APIs, but the non-blocking variant should work.
		676
		677	=cut
		678
		679	our $VERSION = 1;
		680
		681	$INC{"urxvt/anyevent.pm"} = 1; # mark us as there
		682	push @AnyEvent::REGISTRY, [urxvt => urxvt::anyevent::];
		683
		684	sub timer {
		685	my ($class, %arg) = @_;
		686
		687	my $cb = $arg{cb};
		688
		689	urxvt::timer
		690	->new
		691	->start (urxvt::NOW + $arg{after})
		692	->cb (sub {
		693	$_[0]->stop; # need to cancel manually
		694	$cb->();
		695	})
		696	}
		697
		698	sub io {
		699	my ($class, %arg) = @_;
		700
		701	my $cb = $arg{cb};
		702
		703	bless [$arg{fh}, urxvt::iow
		704	->new
		705	->fd (fileno $arg{fh})
		706	->events (($arg{poll} =~ /r/ ? 1 : 0)
		707	\| ($arg{poll} =~ /w/ ? 2 : 0))
		708	->start
		709	->cb (sub {
		710	$cb->(($_[1] & 1 ? 'r' : '')
		711	. ($_[1] & 2 ? 'w' : ''));
		712	})],
		713	urxvt::anyevent::
		714	}
		715
		716	sub DESTROY {
		717	$_[0][1]->stop;
		718	}
		719
		720	sub condvar {
		721	bless \my $flag, urxvt::anyevent::condvar::
		722	}
		723
		724	sub urxvt::anyevent::condvar::broadcast {
		725	${$_[0]}++;
		726	}
		727
		728	sub urxvt::anyevent::condvar::wait {
		729	unless (${$_[0]}) {
		730	Carp::croak "AnyEvent->condvar blocking wait unsupported in urxvt, use a non-blocking API";
		731	}
		732	}
		733
		734	package urxvt::term;
		735
551	=head2 The C<urxvt::term> Class	736	=head2 The C<urxvt::term> Class
552		737
553	=over 4	738	=over 4
554		739
		740	=cut
		741
		742	# find on_xxx subs in the package and register them
		743	# as hooks
		744	sub register_package {
		745	my ($self, $pkg, $argv) = @_;
		746
		747	my $proxy = bless {
		748	_pkg => $pkg,
		749	argv => $argv,
		750	}, $pkg;
		751	Scalar::Util::weaken ($proxy->{term} = $self);
		752
		753	$self->{_pkg}{$pkg} = $proxy;
		754
		755	for my $name (@HOOKNAME) {
		756	if (my $ref = $pkg->can ("on_" . lc $name)) {
		757	$proxy->enable ($name => $ref);
		758	}
		759	}
		760	}
		761
555	=item $term->destroy	762	=item $term->destroy
556		763
557	Destroy the terminal object (close the window, free resources etc.).	764	Destroy the terminal object (close the window, free resources etc.).
		765
		766	=item $isset = $term->option ($optval[, $set])
		767
		768	Returns true if the option specified by C<$optval> is enabled, and
		769	optionally change it. All option values are stored by name in the hash
		770	C<%urxvt::OPTION>. Options not enabled in this binary are not in the hash.
		771
		772	Here is a a likely non-exhaustive list of option names, please see the
		773	source file F</src/optinc.h> to see the actual list:
		774
		775	borderLess console cursorBlink cursorUnderline hold iconic insecure
		776	intensityStyles jumpScroll loginShell mapAlert meta8 mouseWheelScrollPage
		777	pastableTabs pointerBlank reverseVideo scrollBar scrollBar_floating
		778	scrollBar_right scrollTtyKeypress scrollTtyOutput scrollWithBuffer
		779	secondaryScreen secondaryScroll skipBuiltinGlyphs transparent
		780	tripleclickwords utmpInhibit visualBell
558		781
559	=item $value = $term->resource ($name[, $newval])	782	=item $value = $term->resource ($name[, $newval])
560		783
561	Returns the current resource value associated with a given name and	784	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>	785	optionally sets a new value. Setting values is most useful in the C<init>
…		…
572		795
573	Please note that resource strings will currently only be freed when the	796	Please note that resource strings will currently only be freed when the
574	terminal is destroyed, so changing options frequently will eat memory.	797	terminal is destroyed, so changing options frequently will eat memory.
575		798
576	Here is a a likely non-exhaustive list of resource names, not all of which	799	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	800	are supported in every build, please see the source file F</src/rsinc.h>
578	list:	801	to see the actual list:
579		802
580	answerbackstring backgroundPixmap backspace_key boldFont boldItalicFont	803	answerbackstring backgroundPixmap backspace_key boldFont boldItalicFont
581	borderLess color cursorBlink cursorUnderline cutchars delete_key	804	borderLess color cursorBlink cursorUnderline cutchars delete_key
582	display_name embed ext_bwidth fade font geometry hold iconName	805	display_name embed ext_bwidth fade font geometry hold iconName
583	imFont imLocale inputMethod insecure int_bwidth intensityStyles	806	imFont imLocale inputMethod insecure int_bwidth intensityStyles
…		…
590	shade term_name title transparent transparent_all tripleclickwords	813	shade term_name title transparent transparent_all tripleclickwords
591	utmpInhibit visualBell	814	utmpInhibit visualBell
592		815
593	=cut	816	=cut
594		817
595	sub urxvt::term::resource($$;$) {	818	sub resource($$;$) {
596	my ($self, $name) = (shift, shift);	819	my ($self, $name) = (shift, shift);
597	unshift @_, $self, $name, ($name =~ s/\s\+\s(\d+)$// ? $1 : 0);	820	unshift @_, $self, $name, ($name =~ s/\s\+\s(\d+)$// ? $1 : 0);
598	&urxvt::term::_resource	821	&urxvt::term::_resource
599	}	822	}
600		823
		824	=item $success = $term->parse_keysym ($keysym_spec, $command_string)
		825
		826	Adds a keymap translation exactly as specified via a resource. See the
		827	C<keysym> resource in the @@RXVT_NAME@@(1) manpage.
		828
601	=item $rend = $term->rstyle ([$new_rstyle])	829	=item $rend = $term->rstyle ([$new_rstyle])
602		830
603	Return and optionally change the current rendition. Text that is output by	831	Return and optionally change the current rendition. Text that is output by
604	the terminal application will use this style.	832	the terminal application will use this style.
605		833
…		…
624		852
625	=item $oldtext = $term->selection ([$newtext])	853	=item $oldtext = $term->selection ([$newtext])
626		854
627	Return the current selection text and optionally replace it by C<$newtext>.	855	Return the current selection text and optionally replace it by C<$newtext>.
628		856
629	#=item $term->overlay ($x, $y, $text)	857	=item $term->overlay_simple ($x, $y, $text)
630	#	858
631	#Create a simple multi-line overlay box. See the next method for details.	859	Create a simple multi-line overlay box. See the next method for details.
632	#	860
633	#=cut	861	=cut
634	#	862
635	#sub urxvt::term::scr_overlay {	863	sub overlay_simple {
636	# my ($self, $x, $y, $text) = @_;	864	my ($self, $x, $y, $text) = @_;
637	#	865
638	# my @lines = split /\n/, $text;	866	my @lines = split /\n/, $text;
639	#	867
640	# my $w = 0;	868	my $w = List::Util::max map $self->strwidth ($_), @lines;
641	# for (map $self->strwidth ($_), @lines) {	869
642	# $w = $_ if $w < $_;
643	# }
644	#
645	# $self->scr_overlay_new ($x, $y, $w, scalar @lines);	870	my $overlay = $self->overlay ($x, $y, $w, scalar @lines);
646	# $self->scr_overlay_set (0, $_, $lines[$_]) for 0.. $#lines;	871	$overlay->set (0, $_, $lines[$_]) for 0.. $#lines;
647	#}	872
		873	$overlay
		874	}
648		875
649	=item $term->overlay ($x, $y, $width, $height[, $rstyle[, $border]])	876	=item $term->overlay ($x, $y, $width, $height[, $rstyle[, $border]])
650		877
651	Create a new (empty) overlay at the given position with the given	878	Create a new (empty) overlay at the given position with the given
652	width/height. C<$rstyle> defines the initial rendition style	879	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,	914	C<$event> I<must> be the event causing the menu to pop up (a button event,
688	currently).	915	currently).
689		916
690	=cut	917	=cut
691		918
692	sub urxvt::term::popup {	919	sub popup {
693	my ($self, $event) = @_;	920	my ($self, $event) = @_;
694		921
695	$self->grab ($event->{time}, 1)	922	$self->grab ($event->{time}, 1)
696	or return;	923	or return;
697		924
…		…
719		946
720	=item $string = $term->locale_decode ($octets)	947	=item $string = $term->locale_decode ($octets)
721		948
722	Convert the given locale-encoded octets into a perl string.	949	Convert the given locale-encoded octets into a perl string.
723		950
		951	=item $term->scr_xor_span ($beg_row, $beg_col, $end_row, $end_col[, $rstyle])
		952
		953	XORs the rendition values in the given span with the provided value
		954	(default: C<RS_RVid>). Useful in refresh hooks to provide effects similar
		955	to the selection.
		956
		957	=item $term->scr_xor_rect ($beg_row, $beg_col, $end_row, $end_col[, $rstyle1[, $rstyle2]])
		958
		959	Similar to C<scr_xor_span>, but xors a rectangle instead. Trailing
		960	whitespace will additionally be xored with the C<$rstyle2>, which defaults
		961	to C<RS_RVid \| RS_Uline>, which removes reverse video again and underlines
		962	it instead.
		963
		964	=item $term->scr_bell
		965
		966	Ring the bell!
		967
724	=item $term->scr_add_lines ($string)	968	=item $term->scr_add_lines ($string)
725		969
726	Write the given text string to the screen, as if output by the application	970	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	971	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	972	codes), but is free to use line feeds, carriage returns and tabs. The
…		…
742		986
743	Write the octets given in C<$data> to the tty (i.e. as program input). To	987	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	988	pass characters instead of octets, you should convert your strings first
745	to the locale-specific encoding using C<< $term->locale_encode >>.	989	to the locale-specific encoding using C<< $term->locale_encode >>.
746		990
		991	=item $old_events = $term->pty_ev_events ([$new_events])
		992
		993	Replaces the event mask of the pty watcher by the given event mask. Can
		994	be used to suppress input and output handling to the pty/tty. See the
		995	description of C<< urxvt::timer->events >>. Make sure to always restore
		996	the previous value.
		997
747	=item $windowid = $term->parent	998	=item $windowid = $term->parent
748		999
749	Return the window id of the toplevel window.	1000	Return the window id of the toplevel window.
750		1001
751	=item $windowid = $term->vt	1002	=item $windowid = $term->vt
…		…
775	=item $nrow_plus_saveLines = $term->total_rows	1026	=item $nrow_plus_saveLines = $term->total_rows
776		1027
777	=item $lines_in_scrollback = $term->nsaved	1028	=item $lines_in_scrollback = $term->nsaved
778		1029
779	Return various integers describing terminal characteristics.	1030	Return various integers describing terminal characteristics.
		1031
		1032	=item $lc_ctype = $term->locale
		1033
		1034	Returns the LC_CTYPE category string used by this rxvt-unicode.
		1035
		1036	=item $x_display = $term->display_id
		1037
		1038	Return the DISPLAY used by rxvt-unicode.
		1039
		1040	=item $modifiermask = $term->ModLevel3Mask
		1041
		1042	=item $modifiermask = $term->ModMetaMask
		1043
		1044	=item $modifiermask = $term->ModNumLockMask
		1045
		1046	Return the modifier masks corresponding to the "ISO Level 3 Shift" (often
		1047	AltGr), the meta key (often Alt) and the num lock key, if applicable.
780		1048
781	=item $view_start = $term->view_start ([$newvalue])	1049	=item $view_start = $term->view_start ([$newvalue])
782		1050
783	Returns the negative row number of the topmost line. Minimum value is	1051	Returns the negative row number of the topmost line. Minimum value is
784	C<0>, which displays the normal terminal contents. Larger values scroll	1052	C<0>, which displays the normal terminal contents. Larger values scroll
…		…
878		1146
879	=back	1147	=back
880		1148
881	=cut	1149	=cut
882		1150
883	sub urxvt::term::line {	1151	sub line {
884	my ($self, $row) = @_;	1152	my ($self, $row) = @_;
885		1153
886	my $maxrow = $self->nrow - 1;	1154	my $maxrow = $self->nrow - 1;
887		1155
888	my ($beg, $end) = ($row, $row);	1156	my ($beg, $end) = ($row, $row);
…		…
952	$offset / $self->{ncol} + $self->{beg},	1220	$offset / $self->{ncol} + $self->{beg},
953	$offset % $self->{ncol}	1221	$offset % $self->{ncol}
954	)	1222	)
955	}	1223	}
956		1224
957	=item ($row, $col) = $line->coord_of ($offset)
958	=item $text = $term->special_encode $string	1225	=item $text = $term->special_encode $string
959		1226
960	Converts a perl string into the special encoding used by rxvt-unicode,	1227	Converts a perl string into the special encoding used by rxvt-unicode,
961	where one character corresponds to one screen cell. See	1228	where one character corresponds to one screen cell. See
962	C<< $term->ROW_t >> for details.	1229	C<< $term->ROW_t >> for details.
…		…
964	=item $string = $term->special_decode $text	1231	=item $string = $term->special_decode $text
965		1232
966	Converts rxvt-unicodes text reprsentation into a perl string. See	1233	Converts rxvt-unicodes text reprsentation into a perl string. See
967	C<< $term->ROW_t >> for details.	1234	C<< $term->ROW_t >> for details.
968		1235
		1236	=item $success = $term->grab_button ($button, $modifiermask)
		1237
		1238	Registers a synchronous button grab. See the XGrabButton manpage.
		1239
		1240	=item $success = $term->grab ($eventtime[, $sync])
		1241
		1242	Calls XGrabPointer and XGrabKeyboard in asynchronous (default) or
		1243	synchronous (C<$sync> is true). Also remembers the grab timestampe.
		1244
		1245	=item $term->allow_events_async
		1246
		1247	Calls XAllowEvents with AsyncBoth for the most recent grab.
		1248
		1249	=item $term->allow_events_sync
		1250
		1251	Calls XAllowEvents with SyncBoth for the most recent grab.
		1252
		1253	=item $term->allow_events_replay
		1254
		1255	Calls XAllowEvents with both ReplayPointer and ReplayKeyboard for the most
		1256	recent grab.
		1257
		1258	=item $term->ungrab
		1259
		1260	Calls XUngrab for the most recent grab. Is called automatically on
		1261	evaluation errors, as it is better to lose the grab in the error case as
		1262	the session.
		1263
969	=back	1264	=back
970		1265
		1266	=cut
		1267
		1268	package urxvt::popup;
		1269
971	=head2 The C<urxvt::popup> Class	1270	=head2 The C<urxvt::popup> Class
972		1271
973	=over 4	1272	=over 4
974		1273
975	=cut	1274	=cut
976
977	package urxvt::popup;
978		1275
979	sub add_item {	1276	sub add_item {
980	my ($self, $item) = @_;	1277	my ($self, $item) = @_;
981		1278
		1279	$item->{rend}{normal} = "\x1b[0;30;47m" unless exists $item->{rend}{normal};
		1280	$item->{rend}{hover} = "\x1b[0;30;46m" unless exists $item->{rend}{hover};
		1281	$item->{rend}{active} = "\x1b[m" unless exists $item->{rend}{active};
		1282
		1283	$item->{render} \|\|= sub { $_[0]{text} };
		1284
982	push @{ $self->{item} }, $item;	1285	push @{ $self->{item} }, $item;
		1286	}
		1287
		1288	sub add_separator {
		1289	my ($self, $sep) = @_;
		1290
		1291	$sep \|\|= "=";
		1292
		1293	$self->add_item ({
		1294	rend => { normal => "\x1b[0;30;47m", hover => "\x1b[0;30;47m", active => "\x1b[0;30;47m" },
		1295	text => "",
		1296	render => sub { $sep x $self->{term}->ncol },
		1297	activate => sub { },
		1298	});
		1299	}
		1300
		1301	sub add_title {
		1302	my ($self, $title) = @_;
		1303
		1304	$self->add_item ({
		1305	rend => { normal => "\x1b[38;5;11;44m", hover => "\x1b[38;5;11;44m", active => "\x1b[38;5;11;44m" },
		1306	text => $title,
		1307	activate => sub { },
		1308	});
983	}	1309	}
984		1310
985	sub add_button {	1311	sub add_button {
986	my ($self, $text, $cb) = @_;	1312	my ($self, $text, $cb) = @_;
987		1313
988	$self->add_item ({ type => "button", text => "[ $text ]", activate => $cb });	1314	$self->add_item ({ type => "button", text => $text, activate => $cb});
		1315	}
		1316
		1317	sub add_toggle {
		1318	my ($self, $text, $cb, $value) = @_;
		1319
		1320	my $item; $item = {
		1321	type => "button",
		1322	text => " $text",
		1323	value => $value,
		1324	render => sub { ($_[0]{value} ? "* " : " ") . $text },
		1325	activate => sub { $cb->($_[0]{value} = !$_[0]{value}); },
		1326	};
		1327
		1328	$self->add_item ($item);
989	}	1329	}
990		1330
991	sub show {	1331	sub show {
992	my ($self) = @_;	1332	my ($self) = @_;
993		1333
994	local $urxvt::popup::self = $self;	1334	local $urxvt::popup::self = $self;
995		1335
		1336	local $ENV{LC_ALL} = $self->{term}->locale;
		1337
996	urxvt->new ("--perl-lib" => "", "--perl-ext-common" => "", "-pty-fd" => -1, "-sl" => 0, "-b" => 0,	1338	urxvt->new ("--perl-lib" => "", "--perl-ext-common" => "", "-pty-fd" => -1, "-sl" => 0, "-b" => 0,
997	"--transient-for" => $self->{term}->parent,	1339	"--transient-for" => $self->{term}->parent,
		1340	"-display" => $self->{term}->display_id,
998	"-pe" => "urxvt-popup")	1341	"-pe" => "urxvt-popup")
999	or die "unable to create popup window\n";	1342	or die "unable to create popup window\n";
1000	}	1343	}
1001		1344
1002	sub DESTROY {	1345	sub DESTROY {
1003	my ($self) = @_;	1346	my ($self) = @_;
1004		1347
		1348	delete $self->{term}{_destroy}{$self};
1005	$self->{term}->ungrab;	1349	$self->{term}->ungrab;
1006	}	1350	}
1007		1351
1008	=head2 The C<urxvt::timer> Class	1352	=head2 The C<urxvt::timer> Class
1009		1353
…		…
1064		1408
1065	$term->{socket} = ...	1409	$term->{socket} = ...
1066	$term->{iow} = urxvt::iow	1410	$term->{iow} = urxvt::iow
1067	->new	1411	->new
1068	->fd (fileno $term->{socket})	1412	->fd (fileno $term->{socket})
1069	->events (1) # wait for read data	1413	->events (urxvt::EVENT_READ)
1070	->start	1414	->start
1071	->cb (sub {	1415	->cb (sub {
1072	my ($iow, $revents) = @_;	1416	my ($iow, $revents) = @_;
1073	# $revents must be 1 here, no need to check	1417	# $revents must be 1 here, no need to check
1074	sysread $term->{socket}, my $buf, 8192	1418	sysread $term->{socket}, my $buf, 8192
…		…
1091		1435
1092	Set the filedescriptor (not handle) to watch.	1436	Set the filedescriptor (not handle) to watch.
1093		1437
1094	=item $iow = $iow->events ($eventmask)	1438	=item $iow = $iow->events ($eventmask)
1095		1439
1096	Set the event mask to watch. Bit #0 (value C<1>) enables watching for read	1440	Set the event mask to watch. The only allowed values are
1097	data, Bit #1 (value C<2>) enables watching for write data.	1441	C<urxvt::EVENT_READ> and C<urxvt::EVENT_WRITE>, which might be ORed
		1442	together, or C<urxvt::EVENT_NONE>.
1098		1443
1099	=item $iow = $iow->start	1444	=item $iow = $iow->start
1100		1445
1101	Start watching for requested events on the given handle.	1446	Start watching for requested events on the given handle.
1102		1447
…		…
1113	This variable controls the verbosity level of the perl extension. Higher	1458	This variable controls the verbosity level of the perl extension. Higher
1114	numbers indicate more verbose output.	1459	numbers indicate more verbose output.
1115		1460
1116	=over 4	1461	=over 4
1117		1462
1118	=item =0 - only fatal messages	1463	=item == 0 - fatal messages
1119		1464
1120	=item =3 - script loading and management	1465	=item >= 3 - script loading and management
1121		1466
1122	=item =10 - all events received	1467	=item >=10 - all events received
1123		1468
1124	=back	1469	=back
1125		1470
1126	=head1 AUTHOR	1471	=head1 AUTHOR
1127		1472

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.72 by root, Mon Jan 9 23:30:01 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.72 by root, Mon Jan 9 23:30:01 2006 UTC