[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.60 by root, Mon Jan 9 01:21:43 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.
60		70
61	=item digital-clock	71	=item digital-clock
62		72
63	Displays a digital clock using the built-in overlay.	73	Displays a digital clock using the built-in overlay.
64		74
…		…
179	should extend the selection itelf and return true to suppress the built-in	189	should extend the selection itelf and return true to suppress the built-in
180	processing.	190	processing.
181		191
182	See the F<selection> example extension.	192	See the F<selection> example extension.
183		193
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	194	=item on_view_change $term, $offset
195		195
196	Called whenever the view offset changes, i..e the user or program	196	Called whenever the view offset changes, i..e the user or program
197	scrolls. Offset C<0> means display the normal terminal, positive values	197	scrolls. Offset C<0> means display the normal terminal, positive values
198	show this many lines of scrollback.	198	show this many lines of scrollback.
…		…
261		261
262	Called whenever the user presses a key combination that has a	262	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>	263	C<perl:string> action bound to it (see description of the B<keysym>
264	resource in the @@RXVT_NAME@@(1) manpage).	264	resource in the @@RXVT_NAME@@(1) manpage).
265		265
		266	=item on_focus_in $term
		267
		268	Called whenever the window gets the keyboard focus, before rxvt-unicode
		269	does focus in processing.
		270
		271	=item on_focus_out $term
		272
		273	Called wheneever the window loses keyboard focus, before rxvt-unicode does
		274	focus out processing.
		275
266	=item on_key_press $term, $event, $octets	276	=item on_key_press $term, $event, $octets
267		277
268	=item on_key_release $term, $event	278	=item on_key_release $term, $event
269		279
270	=item on_button_press $term, $event	280	=item on_button_press $term, $event
271		281
272	=item on_button_release $term, $event	282	=item on_button_release $term, $event
273		283
274	=item on_motion_notify $term, $event	284	=item on_motion_notify $term, $event
		285
		286	=item on_map_notify $term, $event
		287
		288	=item on_unmap_notify $term, $event
275		289
276	Called whenever the corresponding X event is received for the terminal If	290	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.	291	the hook returns true, then the even will be ignored by rxvt-unicode.
278		292
279	The event is a hash with most values as named by Xlib (see the XEvent	293	The event is a hash with most values as named by Xlib (see the XEvent
…		…
327		341
328	=item $time = urxvt::NOW	342	=item $time = urxvt::NOW
329		343
330	Returns the "current time" (as per the event loop).	344	Returns the "current time" (as per the event loop).
331		345
		346	=item urxvt::CurrentTime
		347
		348	=item urxvt::ShiftMask, LockMask, ControlMask, Mod1Mask, Mod2Mask,
		349	Mod3Mask, Mod4Mask, Mod5Mask, Button1Mask, Button2Mask, Button3Mask,
		350	Button4Mask, Button5Mask, AnyModifier
		351
		352	Various constants for use in X calls and event processing.
		353
332	=back	354	=back
333		355
334	=head2 RENDITION	356	=head2 RENDITION
335		357
336	Rendition bitsets contain information about colour, font, font styles and	358	Rendition bitsets contain information about colour, font, font styles and
…		…
385		407
386	=cut	408	=cut
387		409
388	package urxvt;	410	package urxvt;
389		411
		412	use utf8;
390	use strict;	413	use strict;
391	use Scalar::Util ();	414	use Scalar::Util ();
		415	use List::Util ();
392		416
		417	our $VERSION = 1;
393	our $TERM;	418	our $TERM;
394	our @HOOKNAME;	419	our @HOOKNAME;
		420	our %OPTION;
395	our $LIBDIR;	421	our $LIBDIR;
396		422
397	BEGIN {	423	BEGIN {
398	urxvt->bootstrap;	424	urxvt->bootstrap;
399		425
…		…
402	my $msg = join "", @_;	428	my $msg = join "", @_;
403	$msg .= "\n"	429	$msg .= "\n"
404	unless $msg =~ /\n$/;	430	unless $msg =~ /\n$/;
405	urxvt::warn ($msg);	431	urxvt::warn ($msg);
406	};	432	};
		433
		434	delete $ENV{IFS};
		435	delete $ENV{CDPATH};
		436	delete $ENV{BASH_ENV};
		437	$ENV{PATH} = "/bin:/sbin:/usr/bin:/usr/sbin:/usr/local/bin:/usr/local/sbin:/opt/bin:/opt/sbin";
407	}	438	}
408		439
409	my @hook_count;	440	my @hook_count;
410	my $verbosity = $ENV{URXVT_PERL_VERBOSITY};	441	my $verbosity = $ENV{URXVT_PERL_VERBOSITY};
411		442
…		…
444	verbose 3, "loading extension '$path' into package '$pkg'";	475	verbose 3, "loading extension '$path' into package '$pkg'";
445		476
446	open my $fh, "<:raw", $path	477	open my $fh, "<:raw", $path
447	or die "$path: $!";	478	or die "$path: $!";
448		479
449	my $source = "package $pkg; use strict; use utf8;\n"	480	my $source = untaint "package $pkg; use strict; use utf8;\n"
450	. "use base urxvt::term::proxy::;\n"	481	. "use base urxvt::term::proxy::;\n"
451	. "#line 1 \"$path\"\n{\n"	482	. "#line 1 \"$path\"\n{\n"
452	. (do { local $/; <$fh> })	483	. (do { local $/; <$fh> })
453	. "\n};\n1";	484	. "\n};\n1";
454		485
…		…
465	local $TERM = shift;	496	local $TERM = shift;
466	my $htype = shift;	497	my $htype = shift;
467		498
468	if ($htype == 0) { # INIT	499	if ($htype == 0) { # INIT
469	my @dirs = ((split /:/, $TERM->resource ("perl_lib")), "$LIBDIR/perl");	500	my @dirs = ((split /:/, $TERM->resource ("perl_lib")), "$LIBDIR/perl");
		501
		502	my %want_ext;
470		503
471	for my $ext (map { split /,/, $TERM->resource ("perl_ext_$_") } 1, 2) {	504	for (map { split /,/, $TERM->resource ("perl_ext_$_") } 1, 2) {
		505	if ($_ eq "default") {
		506	$want_ext{$_}++ for qw(selection option-popup selection-popup);
		507	} elsif (/^-(.*)$/) {
		508	delete $want_ext{$1};
		509	} else {
		510	$want_ext{$_}++;
		511	}
		512	}
		513
		514	for my $ext (keys %want_ext) {
472	my @files = grep -f $_, map "$_/$ext", @dirs;	515	my @files = grep -f $_, map "$_/$ext", @dirs;
473		516
474	if (@files) {	517	if (@files) {
475	register_package extension_package $files[0];	518	register_package extension_package $files[0];
476	} else {	519	} else {
477	warn "perl extension '$ext' not found in perl library search path\n";	520	warn "perl extension '$ext' not found in perl library search path\n";
478	}	521	}
479	}	522	}
		523
		524	eval "#line 1 \"--perl-eval resource/argument\"\n" . $TERM->resource ("perl_eval");
		525	warn $@ if $@;
480	}	526	}
481		527
482	$retval = undef;	528	$retval = undef;
483		529
484	if (my $cb = $TERM->{_hook}[$htype]) {	530	if (my $cb = $TERM->{_hook}[$htype]) {
…		…
496	$proxy	542	$proxy
497	},	543	},
498	@_,	544	@_,
499	) and last;	545	) and last;
500	};	546	};
501	warn $@ if $@;#d#	547	if ($@) {
		548	$TERM->ungrab; # better to lose the grab than the session
		549	warn $@;
		550	}
502	}	551	}
503	}	552	}
504		553
505	if ($htype == 1) { # DESTROY	554	if ($htype == 1) { # DESTROY
506	# remove hooks if unused	555	# remove hooks if unused
…		…
519	}	568	}
520		569
521	$retval	570	$retval
522	}	571	}
523		572
		573	# urxvt::term::proxy
		574
524	sub urxvt::term::proxy::AUTOLOAD {	575	sub urxvt::term::proxy::AUTOLOAD {
525	$urxvt::term::proxy::AUTOLOAD =~ /:([^:]+)$/	576	$urxvt::term::proxy::AUTOLOAD =~ /:([^:]+)$/
526	or die "FATAL: \$AUTOLOAD '$urxvt::term::proxy::AUTOLOAD' unparsable";	577	or die "FATAL: \$AUTOLOAD '$urxvt::term::proxy::AUTOLOAD' unparsable";
527		578
528	eval qq{	579	eval qq{
…		…
534	} or die "FATAL: unable to compile method forwarder: $@";	585	} or die "FATAL: unable to compile method forwarder: $@";
535		586
536	goto &$urxvt::term::proxy::AUTOLOAD;	587	goto &$urxvt::term::proxy::AUTOLOAD;
537	}	588	}
538		589
		590	sub urxvt::term::proxy::DESTROY {
		591	# nop
		592	}
		593
		594	# urxvt::destroy_hook
		595
		596	sub urxvt::destroy_hook::DESTROY {
		597	${$_[0]}->();
		598	}
		599
		600	sub urxvt::destroy_hook(&) {
		601	bless \shift, urxvt::destroy_hook::
		602	}
		603
		604	package urxvt::anyevent;
		605
		606	=head2 The C<urxvt::anyevent> Class
		607
		608	The sole purpose of this class is to deliver an interface to the
		609	C<AnyEvent> module - any module using it will work inside urxvt without
		610	further work. The only exception is that you cannot wait on condition
		611	variables, but non-blocking condvar use is ok. What this means is that you
		612	cannot use blocking APIs, but the non-blocking variant should work.
		613
		614	=cut
		615
		616	our $VERSION = 1;
		617
		618	$INC{"urxvt/anyevent.pm"} = 1; # mark us as there
		619	push @AnyEvent::REGISTRY, [urxvt => urxvt::anyevent::];
		620
		621	sub timer {
		622	my ($class, %arg) = @_;
		623
		624	my $cb = $arg{cb};
		625
		626	urxvt::timer
		627	->new
		628	->start (urxvt::NOW + $arg{after})
		629	->cb (sub {
		630	$_[0]->stop; # need to cancel manually
		631	$cb->();
		632	})
		633	}
		634
		635	sub io {
		636	my ($class, %arg) = @_;
		637
		638	my $cb = $arg{cb};
		639
		640	bless [$arg{fh}, urxvt::iow
		641	->new
		642	->fd (fileno $arg{fh})
		643	->events (($arg{poll} =~ /r/ ? 1 : 0)
		644	\| ($arg{poll} =~ /w/ ? 2 : 0))
		645	->start
		646	->cb (sub {
		647	$cb->(($_[1] & 1 ? 'r' : '')
		648	. ($_[1] & 2 ? 'w' : ''));
		649	})],
		650	urxvt::anyevent::
		651	}
		652
		653	sub DESTROY {
		654	$_[0][1]->stop;
		655	}
		656
		657	sub condvar {
		658	bless \my $flag, urxvt::anyevent::condvar::
		659	}
		660
		661	sub urxvt::anyevent::condvar::broadcast {
		662	${$_[0]}++;
		663	}
		664
		665	sub urxvt::anyevent::condvar::wait {
		666	unless (${$_[0]}) {
		667	require Carp;
		668	Carp::croak ("AnyEvent->condvar blocking wait unsupported in urxvt, use a non-blocking API");
		669	}
		670	}
		671
		672	package urxvt::term;
		673
539	=head2 The C<urxvt::term> Class	674	=head2 The C<urxvt::term> Class
540		675
541	=over 4	676	=over 4
542		677
543	=item $term->destroy	678	=item $term->destroy
544		679
545	Destroy the terminal object (close the window, free resources etc.).	680	Destroy the terminal object (close the window, free resources etc.).
		681
		682	=item $isset = $term->option ($optval[, $set])
		683
		684	Returns true if the option specified by C<$optval> is enabled, and
		685	optionally change it. All option values are stored by name in the hash
		686	C<%urxvt::OPTION>. Options not enabled in this binary are not in the hash.
		687
		688	Here is a a likely non-exhaustive list of option names, please see the
		689	source file F</src/optinc.h> to see the actual list:
		690
		691	borderLess console cursorBlink cursorUnderline hold iconic insecure
		692	intensityStyles jumpScroll loginShell mapAlert meta8 mouseWheelScrollPage
		693	pastableTabs pointerBlank reverseVideo scrollBar scrollBar_floating
		694	scrollBar_right scrollTtyKeypress scrollTtyOutput scrollWithBuffer
		695	secondaryScreen secondaryScroll skipBuiltinGlyphs transparent
		696	tripleclickwords utmpInhibit visualBell
546		697
547	=item $value = $term->resource ($name[, $newval])	698	=item $value = $term->resource ($name[, $newval])
548		699
549	Returns the current resource value associated with a given name and	700	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>	701	optionally sets a new value. Setting values is most useful in the C<init>
…		…
560		711
561	Please note that resource strings will currently only be freed when the	712	Please note that resource strings will currently only be freed when the
562	terminal is destroyed, so changing options frequently will eat memory.	713	terminal is destroyed, so changing options frequently will eat memory.
563		714
564	Here is a a likely non-exhaustive list of resource names, not all of which	715	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	716	are supported in every build, please see the source file F</src/rsinc.h>
566	list:	717	to see the actual list:
567		718
568	answerbackstring backgroundPixmap backspace_key boldFont boldItalicFont	719	answerbackstring backgroundPixmap backspace_key boldFont boldItalicFont
569	borderLess color cursorBlink cursorUnderline cutchars delete_key	720	borderLess color cursorBlink cursorUnderline cutchars delete_key
570	display_name embed ext_bwidth fade font geometry hold iconName	721	display_name embed ext_bwidth fade font geometry hold iconName
571	imFont imLocale inputMethod insecure int_bwidth intensityStyles	722	imFont imLocale inputMethod insecure int_bwidth intensityStyles
…		…
578	shade term_name title transparent transparent_all tripleclickwords	729	shade term_name title transparent transparent_all tripleclickwords
579	utmpInhibit visualBell	730	utmpInhibit visualBell
580		731
581	=cut	732	=cut
582		733
583	sub urxvt::term::resource($$;$) {	734	sub resource($$;$) {
584	my ($self, $name) = (shift, shift);	735	my ($self, $name) = (shift, shift);
585	unshift @_, $self, $name, ($name =~ s/\s\+\s(\d+)$// ? $1 : 0);	736	unshift @_, $self, $name, ($name =~ s/\s\+\s(\d+)$// ? $1 : 0);
586	goto &urxvt::term::_resource;	737	&urxvt::term::_resource
587	}	738	}
588		739
589	=item $rend = $term->rstyle ([$new_rstyle])	740	=item $rend = $term->rstyle ([$new_rstyle])
590		741
591	Return and optionally change the current rendition. Text that is output by	742	Return and optionally change the current rendition. Text that is output by
…		…
667		818
668	If hidden, display the overlay again.	819	If hidden, display the overlay again.
669		820
670	=back	821	=back
671		822
		823	=item $popup = $term->popup ($event)
		824
		825	Creates a new C<urxvt::popup> object that implements a popup menu. The
		826	C<$event> I<must> be the event causing the menu to pop up (a button event,
		827	currently).
		828
		829	=cut
		830
		831	sub popup {
		832	my ($self, $event) = @_;
		833
		834	$self->grab ($event->{time}, 1)
		835	or return;
		836
		837	my $popup = bless {
		838	term => $self,
		839	event => $event,
		840	}, urxvt::popup::;
		841
		842	Scalar::Util::weaken $popup->{term};
		843
		844	$self->{_destroy}{$popup} = urxvt::destroy_hook { $popup->{popup}->destroy };
		845	Scalar::Util::weaken $self->{_destroy}{$popup};
		846
		847	$popup
		848	}
		849
672	=item $cellwidth = $term->strwidth ($string)	850	=item $cellwidth = $term->strwidth ($string)
673		851
674	Returns the number of screen-cells this string would need. Correctly	852	Returns the number of screen-cells this string would need. Correctly
675	accounts for wide and combining characters.	853	accounts for wide and combining characters.
676		854
…		…
736	=item $nrow_plus_saveLines = $term->total_rows	914	=item $nrow_plus_saveLines = $term->total_rows
737		915
738	=item $lines_in_scrollback = $term->nsaved	916	=item $lines_in_scrollback = $term->nsaved
739		917
740	Return various integers describing terminal characteristics.	918	Return various integers describing terminal characteristics.
		919
		920	=item $modifiermask = $term->ModLevel3Mask
		921
		922	=item $modifiermask = $term->ModMetaMask
		923
		924	=item $modifiermask = $term->ModNumLockMask
		925
		926	Return the modifier masks corresponding to the "ISO Level 3 Shift" (often
		927	AltGr), the meta key (often Alt) and the num lock key, if applicable.
741		928
742	=item $view_start = $term->view_start ([$newvalue])	929	=item $view_start = $term->view_start ([$newvalue])
743		930
744	Returns the negative row number of the topmost line. Minimum value is	931	Returns the negative row number of the topmost line. Minimum value is
745	C<0>, which displays the normal terminal contents. Larger values scroll	932	C<0>, which displays the normal terminal contents. Larger values scroll
…		…
839		1026
840	=back	1027	=back
841		1028
842	=cut	1029	=cut
843		1030
844	sub urxvt::term::line {	1031	sub line {
845	my ($self, $row) = @_;	1032	my ($self, $row) = @_;
846		1033
847	my $maxrow = $self->nrow - 1;	1034	my $maxrow = $self->nrow - 1;
848		1035
849	my ($beg, $end) = ($row, $row);	1036	my ($beg, $end) = ($row, $row);
…		…
926		1113
927	Converts rxvt-unicodes text reprsentation into a perl string. See	1114	Converts rxvt-unicodes text reprsentation into a perl string. See
928	C<< $term->ROW_t >> for details.	1115	C<< $term->ROW_t >> for details.
929		1116
930	=back	1117	=back
		1118
		1119	=cut
		1120
		1121	package urxvt::popup;
		1122
		1123	=head2 The C<urxvt::popup> Class
		1124
		1125	=over 4
		1126
		1127	=cut
		1128
		1129	sub add_item {
		1130	my ($self, $item) = @_;
		1131
		1132	$item->{rend}{normal} = "\x1b[0;30;47m" unless exists $item->{rend}{normal};
		1133	$item->{rend}{hover} = "\x1b[0;30;46m" unless exists $item->{rend}{hover};
		1134	$item->{rend}{active} = "\x1b[m" unless exists $item->{rend}{active};
		1135
		1136	$item->{render} \|\|= sub { $_[0]{text} };
		1137
		1138	push @{ $self->{item} }, $item;
		1139	}
		1140
		1141	sub add_separator {
		1142	my ($self, $sep) = @_;
		1143
		1144	$sep \|\|= "═";
		1145
		1146	$self->add_item ({
		1147	rend => { normal => "\x1b[0;30;47m", hover => "\x1b[0;30;47m", active => "\x1b[0;30;47m" },
		1148	text => "",
		1149	render => sub { $sep x $urxvt::TERM->ncol },
		1150	activate => sub { },
		1151	});
		1152	}
		1153
		1154	sub add_title {
		1155	my ($self, $title) = @_;
		1156
		1157	$self->add_item ({
		1158	rend => { normal => "\x1b[38;5;11;44m", hover => "\x1b[38;5;11;44m", active => "\x1b[38;5;11;44m" },
		1159	text => $title,
		1160	activate => sub { },
		1161	});
		1162	}
		1163
		1164	sub add_button {
		1165	my ($self, $text, $cb) = @_;
		1166
		1167	$self->add_item ({ type => "button", text => "[ $text ]", activate => $cb});
		1168	}
		1169
		1170	sub add_toggle {
		1171	my ($self, $text, $cb, $value) = @_;
		1172
		1173	my $item; $item = {
		1174	type => "button",
		1175	text => " $text",
		1176	value => $value,
		1177	render => sub { ($_[0]{value} ? "* " : " ") . $text },
		1178	activate => sub { $cb->($_[0]{value} = !$_[0]{value}); },
		1179	};
		1180
		1181	$self->add_item ($item);
		1182	}
		1183
		1184	sub show {
		1185	my ($self) = @_;
		1186
		1187	local $urxvt::popup::self = $self;
		1188
		1189	urxvt->new ("--perl-lib" => "", "--perl-ext-common" => "", "-pty-fd" => -1, "-sl" => 0, "-b" => 0,
		1190	"--transient-for" => $self->{term}->parent,
		1191	"-pe" => "urxvt-popup")
		1192	or die "unable to create popup window\n";
		1193	}
		1194
		1195	sub DESTROY {
		1196	my ($self) = @_;
		1197
		1198	delete $self->{term}{_destroy}{$self};
		1199	$self->{term}->ungrab;
		1200	}
931		1201
932	=head2 The C<urxvt::timer> Class	1202	=head2 The C<urxvt::timer> Class
933		1203
934	This class implements timer watchers/events. Time is represented as a	1204	This class implements timer watchers/events. Time is represented as a
935	fractional number of seconds since the epoch. Example:	1205	fractional number of seconds since the epoch. Example:
…		…
1037	This variable controls the verbosity level of the perl extension. Higher	1307	This variable controls the verbosity level of the perl extension. Higher
1038	numbers indicate more verbose output.	1308	numbers indicate more verbose output.
1039		1309
1040	=over 4	1310	=over 4
1041		1311
1042	=item =0 - only fatal messages	1312	=item == 0 - fatal messages
1043		1313
1044	=item =3 - script loading and management	1314	=item >= 3 - script loading and management
1045		1315
1046	=item =10 - all events received	1316	=item >=10 - all events received
1047		1317
1048	=back	1318	=back
1049		1319
1050	=head1 AUTHOR	1320	=head1 AUTHOR
1051		1321

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.60 by root, Mon Jan 9 01:21:43 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.60 by root, Mon Jan 9 01:21:43 2006 UTC