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

Comparing rxvt-unicode/src/urxvt.pm (file contents):
Revision 1.44 by root, Sat Jan 7 19:29:17 2006 UTC vs.
Revision 1.57 by root, Sun Jan 8 08:43:11 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-Button3 that lets you toggle (some) options at
		64	runtime.
60		65
61	=item digital-clock	66	=item digital-clock
62		67
63	Displays a digital clock using the built-in overlay.	68	Displays a digital clock using the built-in overlay.
64		69
…		…
179	should extend the selection itelf and return true to suppress the built-in	184	should extend the selection itelf and return true to suppress the built-in
180	processing.	185	processing.
181		186
182	See the F<selection> example extension.	187	See the F<selection> example extension.
183		188
184	=item on_focus_in $term
185
186	Called whenever the window gets the keyboard focus, before urxvt does
187	focus in processing.
188
189	=item on_focus_out $term
190
191	Called wheneever the window loses keyboard focus, before urxvt does focus
192	out processing.
193
194	=item on_view_change $term, $offset	189	=item on_view_change $term, $offset
195		190
196	Called whenever the view offset changes, i..e the user or program	191	Called whenever the view offset changes, i..e the user or program
197	scrolls. Offset C<0> means display the normal terminal, positive values	192	scrolls. Offset C<0> means display the normal terminal, positive values
198	show this many lines of scrollback.	193	show this many lines of scrollback.
…		…
261		256
262	Called whenever the user presses a key combination that has a	257	Called whenever the user presses a key combination that has a
263	C<perl:string> action bound to it (see description of the B<keysym>	258	C<perl:string> action bound to it (see description of the B<keysym>
264	resource in the @@RXVT_NAME@@(1) manpage).	259	resource in the @@RXVT_NAME@@(1) manpage).
265		260
		261	=item on_focus_in $term
		262
		263	Called whenever the window gets the keyboard focus, before rxvt-unicode
		264	does focus in processing.
		265
		266	=item on_focus_out $term
		267
		268	Called wheneever the window loses keyboard focus, before rxvt-unicode does
		269	focus out processing.
		270
266	=item on_key_press $term, $event, $octets	271	=item on_key_press $term, $event, $octets
267		272
268	=item on_key_release $term, $event	273	=item on_key_release $term, $event
269		274
270	=item on_button_press $term, $event	275	=item on_button_press $term, $event
271		276
272	=item on_button_release $term, $event	277	=item on_button_release $term, $event
273		278
274	=item on_motion_notify $term, $event	279	=item on_motion_notify $term, $event
		280
		281	=item on_map_notify $term, $event
		282
		283	=item on_unmap_notify $term, $event
275		284
276	Called whenever the corresponding X event is received for the terminal If	285	Called whenever the corresponding X event is received for the terminal If
277	the hook returns true, then the even will be ignored by rxvt-unicode.	286	the hook returns true, then the even will be ignored by rxvt-unicode.
278		287
279	The event is a hash with most values as named by Xlib (see the XEvent	288	The event is a hash with most values as named by Xlib (see the XEvent
…		…
327		336
328	=item $time = urxvt::NOW	337	=item $time = urxvt::NOW
329		338
330	Returns the "current time" (as per the event loop).	339	Returns the "current time" (as per the event loop).
331		340
		341	=item urxvt::CurrentTime
		342
		343	=item urxvt::ShiftMask, LockMask, ControlMask, Mod1Mask, Mod2Mask,
		344	Mod3Mask, Mod4Mask, Mod5Mask, Button1Mask, Button2Mask, Button3Mask,
		345	Button4Mask, Button5Mask, AnyModifier
		346
		347	Various constants for use in X calls and event processing.
		348
332	=back	349	=back
333		350
334	=head2 RENDITION	351	=head2 RENDITION
335		352
336	Rendition bitsets contain information about colour, font, font styles and	353	Rendition bitsets contain information about colour, font, font styles and
…		…
385		402
386	=cut	403	=cut
387		404
388	package urxvt;	405	package urxvt;
389		406
		407	use utf8;
390	use strict;	408	use strict;
391	use Scalar::Util ();	409	use Scalar::Util ();
		410	use List::Util ();
392		411
		412	our $VERSION = 1;
393	our $TERM;	413	our $TERM;
394	our @HOOKNAME;	414	our @HOOKNAME;
		415	our %OPTION;
395	our $LIBDIR;	416	our $LIBDIR;
396		417
397	BEGIN {	418	BEGIN {
398	urxvt->bootstrap;	419	urxvt->bootstrap;
399		420
…		…
450	. "use base urxvt::term::proxy::;\n"	471	. "use base urxvt::term::proxy::;\n"
451	. "#line 1 \"$path\"\n{\n"	472	. "#line 1 \"$path\"\n{\n"
452	. (do { local $/; <$fh> })	473	. (do { local $/; <$fh> })
453	. "\n};\n1";	474	. "\n};\n1";
454		475
		476	$source =~ /(.*)/s and $source = $1; # untaint
		477
455	eval $source or die "$path: $@";	478	eval $source or die "$path: $@";
456		479
457	$pkg	480	$pkg
458	}	481	}
459	}	482	}
…		…
465	local $TERM = shift;	488	local $TERM = shift;
466	my $htype = shift;	489	my $htype = shift;
467		490
468	if ($htype == 0) { # INIT	491	if ($htype == 0) { # INIT
469	my @dirs = ((split /:/, $TERM->resource ("perl_lib")), "$LIBDIR/perl");	492	my @dirs = ((split /:/, $TERM->resource ("perl_lib")), "$LIBDIR/perl");
		493
		494	my %want_ext;
470		495
471	for my $ext (map { split /,/, $TERM->resource ("perl_ext_$_") } 1, 2) {	496	for (map { split /,/, $TERM->resource ("perl_ext_$_") } 1, 2) {
		497	if ($_ eq "default") {
		498	$want_ext{$_}++ for qw(selection option-popup);
		499	} elsif (/^-(.*)$/) {
		500	delete $want_ext{$1};
		501	} else {
		502	$want_ext{$_}++;
		503	}
		504	}
		505
		506	for my $ext (keys %want_ext) {
472	my @files = grep -f $_, map "$_/$ext", @dirs;	507	my @files = grep -f $_, map "$_/$ext", @dirs;
473		508
474	if (@files) {	509	if (@files) {
475	register_package extension_package $files[0];	510	register_package extension_package $files[0];
476	} else {	511	} else {
477	warn "perl extension '$ext' not found in perl library search path\n";	512	warn "perl extension '$ext' not found in perl library search path\n";
478	}	513	}
479	}	514	}
		515
		516	eval "#line 1 \"--perl-eval resource/argument\"\n" . $TERM->resource ("perl_eval");
		517	warn $@ if $@;
480	}	518	}
481		519
482	$retval = undef;	520	$retval = undef;
483		521
484	if (my $cb = $TERM->{_hook}[$htype]) {	522	if (my $cb = $TERM->{_hook}[$htype]) {
…		…
519	}	557	}
520		558
521	$retval	559	$retval
522	}	560	}
523		561
		562	# urxvt::term::proxy
		563
524	sub urxvt::term::proxy::AUTOLOAD {	564	sub urxvt::term::proxy::AUTOLOAD {
525	$urxvt::term::proxy::AUTOLOAD =~ /:([^:]+)$/	565	$urxvt::term::proxy::AUTOLOAD =~ /:([^:]+)$/
526	or die "FATAL: \$AUTOLOAD '$urxvt::term::proxy::AUTOLOAD' unparsable";	566	or die "FATAL: \$AUTOLOAD '$urxvt::term::proxy::AUTOLOAD' unparsable";
527		567
528	eval qq{	568	eval qq{
…		…
534	} or die "FATAL: unable to compile method forwarder: $@";	574	} or die "FATAL: unable to compile method forwarder: $@";
535		575
536	goto &$urxvt::term::proxy::AUTOLOAD;	576	goto &$urxvt::term::proxy::AUTOLOAD;
537	}	577	}
538		578
		579	# urxvt::destroy_hook
		580
		581	sub urxvt::destroy_hook::DESTROY {
		582	${$_[0]}->();
		583	}
		584
		585	sub urxvt::destroy_hook(&) {
		586	bless \shift, urxvt::destroy_hook::
		587	}
		588
		589	package urxvt::anyevent;
		590
		591	=head2 The C<urxvt::anyevent> Class
		592
		593	The sole purpose of this class is to deliver an interface to the
		594	C<AnyEvent> module - any module using it will work inside urxvt without
		595	further work. The only exception is that you cannot wait on condition
		596	variables, but non-blocking condvar use is ok. What this means is that you
		597	cannot use blocking APIs, but the non-blocking variant should work.
		598
		599	=cut
		600
		601	our $VERSION = 1;
		602
		603	$INC{"urxvt/anyevent.pm"} = 1; # mark us as there
		604	push @AnyEvent::REGISTRY, [urxvt => urxvt::anyevent::];
		605
		606	sub timer {
		607	my ($class, %arg) = @_;
		608
		609	my $cb = $arg{cb};
		610
		611	urxvt::timer
		612	->new
		613	->start (urxvt::NOW + $arg{after})
		614	->cb (sub {
		615	$_[0]->stop; # need to cancel manually
		616	$cb->();
		617	})
		618	}
		619
		620	sub io {
		621	my ($class, %arg) = @_;
		622
		623	my $cb = $arg{cb};
		624
		625	bless [$arg{fh}, urxvt::iow
		626	->new
		627	->fd (fileno $arg{fh})
		628	->events (($arg{poll} =~ /r/ ? 1 : 0)
		629	\| ($arg{poll} =~ /w/ ? 2 : 0))
		630	->start
		631	->cb (sub {
		632	$cb->(($_[1] & 1 ? 'r' : '')
		633	. ($_[1] & 2 ? 'w' : ''));
		634	})],
		635	urxvt::anyevent::
		636	}
		637
		638	sub DESTROY {
		639	$_[0][1]->stop;
		640	}
		641
		642	sub condvar {
		643	bless \my $flag, urxvt::anyevent::condvar::
		644	}
		645
		646	sub urxvt::anyevent::condvar::broadcast {
		647	${$_[0]}++;
		648	}
		649
		650	sub urxvt::anyevent::condvar::wait {
		651	unless (${$_[0]}) {
		652	require Carp;
		653	Carp::croak ("AnyEvent->condvar blocking wait unsupported in urxvt, use a non-blocking API");
		654	}
		655	}
		656
		657	package urxvt::term;
		658
539	=head2 The C<urxvt::term> Class	659	=head2 The C<urxvt::term> Class
540		660
541	=over 4	661	=over 4
542		662
543	=item $term->destroy	663	=item $term->destroy
544		664
545	Destroy the terminal object (close the window, free resources etc.).	665	Destroy the terminal object (close the window, free resources etc.).
		666
		667	=item $isset = $term->option ($optval[, $set])
		668
		669	Returns true if the option specified by C<$optval> is enabled, and
		670	optionally change it. All option values are stored by name in the hash
		671	C<%urxvt::OPTION>. Options not enabled in this binary are not in the hash.
		672
		673	Here is a a likely non-exhaustive list of option names, please see the
		674	source file F</src/optinc.h> to see the actual list:
		675
		676	borderLess console cursorBlink cursorUnderline hold iconic insecure
		677	intensityStyles jumpScroll loginShell mapAlert meta8 mouseWheelScrollPage
		678	pastableTabs pointerBlank reverseVideo scrollBar scrollBar_floating
		679	scrollBar_right scrollTtyKeypress scrollTtyOutput scrollWithBuffer
		680	secondaryScreen secondaryScroll skipBuiltinGlyphs transparent
		681	tripleclickwords utmpInhibit visualBell
546		682
547	=item $value = $term->resource ($name[, $newval])	683	=item $value = $term->resource ($name[, $newval])
548		684
549	Returns the current resource value associated with a given name and	685	Returns the current resource value associated with a given name and
550	optionally sets a new value. Setting values is most useful in the C<init>	686	optionally sets a new value. Setting values is most useful in the C<init>
…		…
560		696
561	Please note that resource strings will currently only be freed when the	697	Please note that resource strings will currently only be freed when the
562	terminal is destroyed, so changing options frequently will eat memory.	698	terminal is destroyed, so changing options frequently will eat memory.
563		699
564	Here is a a likely non-exhaustive list of resource names, not all of which	700	Here is a a likely non-exhaustive list of resource names, not all of which
565	are supported in every build, please see the source to see the actual	701	are supported in every build, please see the source file F</src/rsinc.h>
566	list:	702	to see the actual list:
567		703
568	answerbackstring backgroundPixmap backspace_key boldFont boldItalicFont	704	answerbackstring backgroundPixmap backspace_key boldFont boldItalicFont
569	borderLess color cursorBlink cursorUnderline cutchars delete_key	705	borderLess color cursorBlink cursorUnderline cutchars delete_key
570	display_name embed ext_bwidth fade font geometry hold iconName	706	display_name embed ext_bwidth fade font geometry hold iconName
571	imFont imLocale inputMethod insecure int_bwidth intensityStyles	707	imFont imLocale inputMethod insecure int_bwidth intensityStyles
…		…
578	shade term_name title transparent transparent_all tripleclickwords	714	shade term_name title transparent transparent_all tripleclickwords
579	utmpInhibit visualBell	715	utmpInhibit visualBell
580		716
581	=cut	717	=cut
582		718
583	sub urxvt::term::resource($$;$) {	719	sub resource($$;$) {
584	my ($self, $name) = (shift, shift);	720	my ($self, $name) = (shift, shift);
585	unshift @_, $self, $name, ($name =~ s/\s\+\s(\d+)$// ? $1 : 0);	721	unshift @_, $self, $name, ($name =~ s/\s\+\s(\d+)$// ? $1 : 0);
586	goto &urxvt::term::_resource;	722	&urxvt::term::_resource
587	}	723	}
588		724
589	=item $rend = $term->rstyle ([$new_rstyle])	725	=item $rend = $term->rstyle ([$new_rstyle])
590		726
591	Return and optionally change the current rendition. Text that is output by	727	Return and optionally change the current rendition. Text that is output by
…		…
667		803
668	If hidden, display the overlay again.	804	If hidden, display the overlay again.
669		805
670	=back	806	=back
671		807
		808	=item $popup = $term->popup ($event)
		809
		810	Creates a new C<urxvt::popup> object that implements a popup menu. The
		811	C<$event> I<must> be the event causing the menu to pop up (a button event,
		812	currently).
		813
		814	=cut
		815
		816	sub popup {
		817	my ($self, $event) = @_;
		818
		819	$self->grab ($event->{time}, 1)
		820	or return;
		821
		822	my $popup = bless {
		823	term => $self,
		824	event => $event,
		825	}, urxvt::popup::;
		826
		827	Scalar::Util::weaken $popup->{term};
		828
		829	$self->{_destroy}{$popup} = urxvt::destroy_hook { $popup->{popup}->destroy };
		830	Scalar::Util::weaken $self->{_destroy}{$popup};
		831
		832	$popup
		833	}
		834
672	=item $cellwidth = $term->strwidth ($string)	835	=item $cellwidth = $term->strwidth ($string)
673		836
674	Returns the number of screen-cells this string would need. Correctly	837	Returns the number of screen-cells this string would need. Correctly
675	accounts for wide and combining characters.	838	accounts for wide and combining characters.
676		839
…		…
736	=item $nrow_plus_saveLines = $term->total_rows	899	=item $nrow_plus_saveLines = $term->total_rows
737		900
738	=item $lines_in_scrollback = $term->nsaved	901	=item $lines_in_scrollback = $term->nsaved
739		902
740	Return various integers describing terminal characteristics.	903	Return various integers describing terminal characteristics.
		904
		905	=item $modifiermask = $term->ModLevel3Mask
		906
		907	=item $modifiermask = $term->ModMetaMask
		908
		909	=item $modifiermask = $term->ModNumLockMask
		910
		911	Return the modifier masks corresponding to the "ISO Level 3 Shift" (often
		912	AltGr), the meta key (often Alt) and the num lock key, if applicable.
741		913
742	=item $view_start = $term->view_start ([$newvalue])	914	=item $view_start = $term->view_start ([$newvalue])
743		915
744	Returns the negative row number of the topmost line. Minimum value is	916	Returns the negative row number of the topmost line. Minimum value is
745	C<0>, which displays the normal terminal contents. Larger values scroll	917	C<0>, which displays the normal terminal contents. Larger values scroll
…		…
839		1011
840	=back	1012	=back
841		1013
842	=cut	1014	=cut
843		1015
844	sub urxvt::term::line {	1016	sub line {
845	my ($self, $row) = @_;	1017	my ($self, $row) = @_;
846		1018
847	my $maxrow = $self->nrow - 1;	1019	my $maxrow = $self->nrow - 1;
848		1020
849	my ($beg, $end) = ($row, $row);	1021	my ($beg, $end) = ($row, $row);
…		…
926		1098
927	Converts rxvt-unicodes text reprsentation into a perl string. See	1099	Converts rxvt-unicodes text reprsentation into a perl string. See
928	C<< $term->ROW_t >> for details.	1100	C<< $term->ROW_t >> for details.
929		1101
930	=back	1102	=back
		1103
		1104	=cut
		1105
		1106	package urxvt::popup;
		1107
		1108	=head2 The C<urxvt::popup> Class
		1109
		1110	=over 4
		1111
		1112	=cut
		1113
		1114	sub add_item {
		1115	my ($self, $item) = @_;
		1116
		1117	$item->{rend}{normal} = "\x1b[0;30;47m" unless exists $item->{rend}{normal};
		1118	$item->{rend}{hover} = "\x1b[0;30;46m" unless exists $item->{rend}{hover};
		1119	$item->{rend}{active} = "\x1b[m" unless exists $item->{rend}{active};
		1120
		1121	$item->{render} \|\|= sub { $_[0]{text} };
		1122
		1123	push @{ $self->{item} }, $item;
		1124	}
		1125
		1126	sub add_separator {
		1127	my ($self, $sep) = @_;
		1128
		1129	$sep \|\|= "═";
		1130
		1131	$self->add_item ({
		1132	rend => { normal => "\x1b[0;30;47m", hover => "\x1b[0;30;47m", active => "\x1b[0;30;47m" },
		1133	text => "",
		1134	render => sub { $sep x $urxvt::TERM->ncol },
		1135	activate => sub { },
		1136	});
		1137	}
		1138
		1139	sub add_title {
		1140	my ($self, $title) = @_;
		1141
		1142	$self->add_item ({
		1143	rend => { normal => "\x1b[38;5;11;44m", hover => "\x1b[38;5;11;44m", active => "\x1b[38;5;11;44m" },
		1144	text => $title,
		1145	activate => sub { },
		1146	});
		1147	}
		1148
		1149	sub add_button {
		1150	my ($self, $text, $cb) = @_;
		1151
		1152	$self->add_item ({ type => "button", text => "[ $text ]", activate => $cb});
		1153	}
		1154
		1155	sub add_toggle {
		1156	my ($self, $text, $cb, $value) = @_;
		1157
		1158	my $item; $item = {
		1159	type => "button",
		1160	text => " $text",
		1161	value => $value,
		1162	render => sub { ($item->{value} ? "* " : " ") . $text },
		1163	activate => sub { $cb->($item->{value} = !$item->{value}); },
		1164	};
		1165
		1166	$self->add_item ($item);
		1167	}
		1168
		1169	sub show {
		1170	my ($self) = @_;
		1171
		1172	local $urxvt::popup::self = $self;
		1173
		1174	urxvt->new ("--perl-lib" => "", "--perl-ext-common" => "", "-pty-fd" => -1, "-sl" => 0, "-b" => 0,
		1175	"--transient-for" => $self->{term}->parent,
		1176	"-pe" => "urxvt-popup")
		1177	or die "unable to create popup window\n";
		1178	}
		1179
		1180	sub DESTROY {
		1181	my ($self) = @_;
		1182
		1183	$self->{term}->ungrab;
		1184	}
931		1185
932	=head2 The C<urxvt::timer> Class	1186	=head2 The C<urxvt::timer> Class
933		1187
934	This class implements timer watchers/events. Time is represented as a	1188	This class implements timer watchers/events. Time is represented as a
935	fractional number of seconds since the epoch. Example:	1189	fractional number of seconds since the epoch. Example:

Diff Legend

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

Comparing rxvt-unicode/src/urxvt.pm (file contents): Revision 1.44 by root, Sat Jan 7 19:29:17 2006 UTC vs. Revision 1.57 by root, Sun Jan 8 08:43:11 2006 UTC

Diff Legend

Comparing rxvt-unicode/src/urxvt.pm (file contents):
Revision 1.44 by root, Sat Jan 7 19:29:17 2006 UTC vs.
Revision 1.57 by root, Sun Jan 8 08:43:11 2006 UTC