[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.56 by root, Sun Jan 8 05:52:42 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
…		…
465	local $TERM = shift;	486	local $TERM = shift;
466	my $htype = shift;	487	my $htype = shift;
467		488
468	if ($htype == 0) { # INIT	489	if ($htype == 0) { # INIT
469	my @dirs = ((split /:/, $TERM->resource ("perl_lib")), "$LIBDIR/perl");	490	my @dirs = ((split /:/, $TERM->resource ("perl_lib")), "$LIBDIR/perl");
		491
		492	my %want_ext;
470		493
471	for my $ext (map { split /,/, $TERM->resource ("perl_ext_$_") } 1, 2) {	494	for (map { split /,/, $TERM->resource ("perl_ext_$_") } 1, 2) {
		495	if ($_ eq "default") {
		496	$want_ext{$_}++ for qw(selection option-popup);
		497	} elsif (/^-(.*)$/) {
		498	delete $want_ext{$1};
		499	} else {
		500	$want_ext{$_}++;
		501	}
		502	}
		503
		504	for my $ext (keys %want_ext) {
472	my @files = grep -f $_, map "$_/$ext", @dirs;	505	my @files = grep -f $_, map "$_/$ext", @dirs;
473		506
474	if (@files) {	507	if (@files) {
475	register_package extension_package $files[0];	508	register_package extension_package $files[0];
476	} else {	509	} else {
477	warn "perl extension '$ext' not found in perl library search path\n";	510	warn "perl extension '$ext' not found in perl library search path\n";
478	}	511	}
479	}	512	}
		513
		514	eval "#line 1 \"--perl-eval resource/argument\"\n" . $TERM->resource ("perl_eval");
		515	warn $@ if $@;
480	}	516	}
481		517
482	$retval = undef;	518	$retval = undef;
483		519
484	if (my $cb = $TERM->{_hook}[$htype]) {	520	if (my $cb = $TERM->{_hook}[$htype]) {
…		…
519	}	555	}
520		556
521	$retval	557	$retval
522	}	558	}
523		559
		560	# urxvt::term::proxy
		561
524	sub urxvt::term::proxy::AUTOLOAD {	562	sub urxvt::term::proxy::AUTOLOAD {
525	$urxvt::term::proxy::AUTOLOAD =~ /:([^:]+)$/	563	$urxvt::term::proxy::AUTOLOAD =~ /:([^:]+)$/
526	or die "FATAL: \$AUTOLOAD '$urxvt::term::proxy::AUTOLOAD' unparsable";	564	or die "FATAL: \$AUTOLOAD '$urxvt::term::proxy::AUTOLOAD' unparsable";
527		565
528	eval qq{	566	eval qq{
…		…
534	} or die "FATAL: unable to compile method forwarder: $@";	572	} or die "FATAL: unable to compile method forwarder: $@";
535		573
536	goto &$urxvt::term::proxy::AUTOLOAD;	574	goto &$urxvt::term::proxy::AUTOLOAD;
537	}	575	}
538		576
		577	# urxvt::destroy_hook
		578
		579	sub urxvt::destroy_hook::DESTROY {
		580	${$_[0]}->();
		581	}
		582
		583	sub urxvt::destroy_hook(&) {
		584	bless \shift, urxvt::destroy_hook::
		585	}
		586
		587	package urxvt::anyevent;
		588
		589	=head2 The C<urxvt::anyevent> Class
		590
		591	The sole purpose of this class is to deliver an interface to the
		592	C<AnyEvent> module - any module using it will work inside urxvt without
		593	further work. The only exception is that you cannot wait on condition
		594	variables, but non-blocking condvar use is ok. What this means is that you
		595	cannot use blocking APIs, but the non-blocking variant should work.
		596
		597	=cut
		598
		599	our $VERSION = 1;
		600
		601	$INC{"urxvt/anyevent.pm"} = 1; # mark us as there
		602	push @AnyEvent::REGISTRY, [urxvt => urxvt::anyevent::];
		603
		604	sub timer {
		605	my ($class, %arg) = @_;
		606
		607	my $cb = $arg{cb};
		608
		609	urxvt::timer
		610	->new
		611	->start (urxvt::NOW + $arg{after})
		612	->cb (sub {
		613	$_[0]->stop; # need to cancel manually
		614	$cb->();
		615	})
		616	}
		617
		618	sub io {
		619	my ($class, %arg) = @_;
		620
		621	my $cb = $arg{cb};
		622
		623	bless [$arg{fh}, urxvt::iow
		624	->new
		625	->fd (fileno $arg{fh})
		626	->events (($arg{poll} =~ /r/ ? 1 : 0)
		627	\| ($arg{poll} =~ /w/ ? 2 : 0))
		628	->start
		629	->cb (sub {
		630	$cb->(($_[1] & 1 ? 'r' : '')
		631	. ($_[1] & 2 ? 'w' : ''));
		632	})],
		633	urxvt::anyevent::
		634	}
		635
		636	sub DESTROY {
		637	$_[0][1]->stop;
		638	}
		639
		640	sub condvar {
		641	bless \my $flag, urxvt::anyevent::condvar::
		642	}
		643
		644	sub urxvt::anyevent::condvar::broadcast {
		645	${$_[0]}++;
		646	}
		647
		648	sub urxvt::anyevent::condvar::wait {
		649	unless (${$_[0]}) {
		650	require Carp;
		651	Carp::croak ("AnyEvent->condvar blocking wait unsupported in urxvt, use a non-blocking API");
		652	}
		653	}
		654
		655	package urxvt::term;
		656
539	=head2 The C<urxvt::term> Class	657	=head2 The C<urxvt::term> Class
540		658
541	=over 4	659	=over 4
542		660
543	=item $term->destroy	661	=item $term->destroy
544		662
545	Destroy the terminal object (close the window, free resources etc.).	663	Destroy the terminal object (close the window, free resources etc.).
		664
		665	=item $isset = $term->option ($optval[, $set])
		666
		667	Returns true if the option specified by C<$optval> is enabled, and
		668	optionally change it. All option values are stored by name in the hash
		669	C<%urxvt::OPTION>. Options not enabled in this binary are not in the hash.
		670
		671	Here is a a likely non-exhaustive list of option names, please see the
		672	source file F</src/optinc.h> to see the actual list:
		673
		674	borderLess console cursorBlink cursorUnderline hold iconic insecure
		675	intensityStyles jumpScroll loginShell mapAlert meta8 mouseWheelScrollPage
		676	pastableTabs pointerBlank reverseVideo scrollBar scrollBar_floating
		677	scrollBar_right scrollTtyKeypress scrollTtyOutput scrollWithBuffer
		678	secondaryScreen secondaryScroll skipBuiltinGlyphs transparent
		679	tripleclickwords utmpInhibit visualBell
546		680
547	=item $value = $term->resource ($name[, $newval])	681	=item $value = $term->resource ($name[, $newval])
548		682
549	Returns the current resource value associated with a given name and	683	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>	684	optionally sets a new value. Setting values is most useful in the C<init>
…		…
560		694
561	Please note that resource strings will currently only be freed when the	695	Please note that resource strings will currently only be freed when the
562	terminal is destroyed, so changing options frequently will eat memory.	696	terminal is destroyed, so changing options frequently will eat memory.
563		697
564	Here is a a likely non-exhaustive list of resource names, not all of which	698	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	699	are supported in every build, please see the source file F</src/rsinc.h>
566	list:	700	to see the actual list:
567		701
568	answerbackstring backgroundPixmap backspace_key boldFont boldItalicFont	702	answerbackstring backgroundPixmap backspace_key boldFont boldItalicFont
569	borderLess color cursorBlink cursorUnderline cutchars delete_key	703	borderLess color cursorBlink cursorUnderline cutchars delete_key
570	display_name embed ext_bwidth fade font geometry hold iconName	704	display_name embed ext_bwidth fade font geometry hold iconName
571	imFont imLocale inputMethod insecure int_bwidth intensityStyles	705	imFont imLocale inputMethod insecure int_bwidth intensityStyles
…		…
578	shade term_name title transparent transparent_all tripleclickwords	712	shade term_name title transparent transparent_all tripleclickwords
579	utmpInhibit visualBell	713	utmpInhibit visualBell
580		714
581	=cut	715	=cut
582		716
583	sub urxvt::term::resource($$;$) {	717	sub resource($$;$) {
584	my ($self, $name) = (shift, shift);	718	my ($self, $name) = (shift, shift);
585	unshift @_, $self, $name, ($name =~ s/\s\+\s(\d+)$// ? $1 : 0);	719	unshift @_, $self, $name, ($name =~ s/\s\+\s(\d+)$// ? $1 : 0);
586	goto &urxvt::term::_resource;	720	&urxvt::term::_resource
587	}	721	}
588		722
589	=item $rend = $term->rstyle ([$new_rstyle])	723	=item $rend = $term->rstyle ([$new_rstyle])
590		724
591	Return and optionally change the current rendition. Text that is output by	725	Return and optionally change the current rendition. Text that is output by
…		…
667		801
668	If hidden, display the overlay again.	802	If hidden, display the overlay again.
669		803
670	=back	804	=back
671		805
		806	=item $popup = $term->popup ($event)
		807
		808	Creates a new C<urxvt::popup> object that implements a popup menu. The
		809	C<$event> I<must> be the event causing the menu to pop up (a button event,
		810	currently).
		811
		812	=cut
		813
		814	sub popup {
		815	my ($self, $event) = @_;
		816
		817	$self->grab ($event->{time}, 1)
		818	or return;
		819
		820	my $popup = bless {
		821	term => $self,
		822	event => $event,
		823	}, urxvt::popup::;
		824
		825	Scalar::Util::weaken $popup->{term};
		826
		827	$self->{_destroy}{$popup} = urxvt::destroy_hook { $popup->{popup}->destroy };
		828	Scalar::Util::weaken $self->{_destroy}{$popup};
		829
		830	$popup
		831	}
		832
672	=item $cellwidth = $term->strwidth ($string)	833	=item $cellwidth = $term->strwidth ($string)
673		834
674	Returns the number of screen-cells this string would need. Correctly	835	Returns the number of screen-cells this string would need. Correctly
675	accounts for wide and combining characters.	836	accounts for wide and combining characters.
676		837
…		…
736	=item $nrow_plus_saveLines = $term->total_rows	897	=item $nrow_plus_saveLines = $term->total_rows
737		898
738	=item $lines_in_scrollback = $term->nsaved	899	=item $lines_in_scrollback = $term->nsaved
739		900
740	Return various integers describing terminal characteristics.	901	Return various integers describing terminal characteristics.
		902
		903	=item $modifiermask = $term->ModLevel3Mask
		904
		905	=item $modifiermask = $term->ModMetaMask
		906
		907	=item $modifiermask = $term->ModNumLockMask
		908
		909	Return the modifier masks corresponding to the "ISO Level 3 Shift" (often
		910	AltGr), the meta key (often Alt) and the num lock key, if applicable.
741		911
742	=item $view_start = $term->view_start ([$newvalue])	912	=item $view_start = $term->view_start ([$newvalue])
743		913
744	Returns the negative row number of the topmost line. Minimum value is	914	Returns the negative row number of the topmost line. Minimum value is
745	C<0>, which displays the normal terminal contents. Larger values scroll	915	C<0>, which displays the normal terminal contents. Larger values scroll
…		…
839		1009
840	=back	1010	=back
841		1011
842	=cut	1012	=cut
843		1013
844	sub urxvt::term::line {	1014	sub line {
845	my ($self, $row) = @_;	1015	my ($self, $row) = @_;
846		1016
847	my $maxrow = $self->nrow - 1;	1017	my $maxrow = $self->nrow - 1;
848		1018
849	my ($beg, $end) = ($row, $row);	1019	my ($beg, $end) = ($row, $row);
…		…
926		1096
927	Converts rxvt-unicodes text reprsentation into a perl string. See	1097	Converts rxvt-unicodes text reprsentation into a perl string. See
928	C<< $term->ROW_t >> for details.	1098	C<< $term->ROW_t >> for details.
929		1099
930	=back	1100	=back
		1101
		1102	=cut
		1103
		1104	package urxvt::popup;
		1105
		1106	=head2 The C<urxvt::popup> Class
		1107
		1108	=over 4
		1109
		1110	=cut
		1111
		1112	sub add_item {
		1113	my ($self, $item) = @_;
		1114
		1115	$item->{rend}{normal} = "\x1b[0;30;47m" unless exists $item->{rend}{normal};
		1116	$item->{rend}{hover} = "\x1b[0;30;46m" unless exists $item->{rend}{hover};
		1117	$item->{rend}{active} = "\x1b[m" unless exists $item->{rend}{active};
		1118
		1119	$item->{render} \|\|= sub { $_[0]{text} };
		1120
		1121	push @{ $self->{item} }, $item;
		1122	}
		1123
		1124	sub add_separator {
		1125	my ($self, $sep) = @_;
		1126
		1127	$sep \|\|= "═";
		1128
		1129	$self->add_item ({
		1130	rend => { normal => "\x1b[0;30;47m", hover => "\x1b[0;30;47m", active => "\x1b[0;30;47m" },
		1131	text => "",
		1132	render => sub { $sep x $urxvt::TERM->ncol },
		1133	activate => sub { },
		1134	});
		1135	}
		1136
		1137	sub add_title {
		1138	my ($self, $title) = @_;
		1139
		1140	$self->add_item ({
		1141	rend => { normal => "\x1b[38;5;11;44m", hover => "\x1b[38;5;11;44m", active => "\x1b[38;5;11;44m" },
		1142	text => $title,
		1143	activate => sub { },
		1144	});
		1145	}
		1146
		1147	sub add_button {
		1148	my ($self, $text, $cb) = @_;
		1149
		1150	$self->add_item ({ type => "button", text => "[ $text ]", activate => $cb});
		1151	}
		1152
		1153	sub add_toggle {
		1154	my ($self, $text, $cb, $value) = @_;
		1155
		1156	my $item; $item = {
		1157	type => "button",
		1158	text => " $text",
		1159	value => $value,
		1160	render => sub { ($item->{value} ? "* " : " ") . $text },
		1161	activate => sub { $cb->($item->{value} = !$item->{value}); },
		1162	};
		1163
		1164	$self->add_item ($item);
		1165	}
		1166
		1167	sub show {
		1168	my ($self) = @_;
		1169
		1170	local $urxvt::popup::self = $self;
		1171
		1172	urxvt->new ("--perl-lib" => "", "--perl-ext-common" => "", "-pty-fd" => -1, "-sl" => 0, "-b" => 0,
		1173	"--transient-for" => $self->{term}->parent,
		1174	"-pe" => "urxvt-popup")
		1175	or die "unable to create popup window\n";
		1176	}
		1177
		1178	sub DESTROY {
		1179	my ($self) = @_;
		1180
		1181	$self->{term}->ungrab;
		1182	}
931		1183
932	=head2 The C<urxvt::timer> Class	1184	=head2 The C<urxvt::timer> Class
933		1185
934	This class implements timer watchers/events. Time is represented as a	1186	This class implements timer watchers/events. Time is represented as a
935	fractional number of seconds since the epoch. Example:	1187	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.56 by root, Sun Jan 8 05:52:42 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.56 by root, Sun Jan 8 05:52:42 2006 UTC