[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.59 by root, Mon Jan 9 00:34:36 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	$ENV{PATH} = "/bin:/sbin:/usr/bin:/usr/sbin:/usr/local/bin:/usr/local/sbin:/opt/bin:/opt/sbin";
		435	delete $ENV{CDPATH};
407	}	436	}
408		437
409	my @hook_count;	438	my @hook_count;
410	my $verbosity = $ENV{URXVT_PERL_VERBOSITY};	439	my $verbosity = $ENV{URXVT_PERL_VERBOSITY};
411		440
…		…
444	verbose 3, "loading extension '$path' into package '$pkg'";	473	verbose 3, "loading extension '$path' into package '$pkg'";
445		474
446	open my $fh, "<:raw", $path	475	open my $fh, "<:raw", $path
447	or die "$path: $!";	476	or die "$path: $!";
448		477
449	my $source = "package $pkg; use strict; use utf8;\n"	478	my $source = untaint "package $pkg; use strict; use utf8;\n"
450	. "use base urxvt::term::proxy::;\n"	479	. "use base urxvt::term::proxy::;\n"
451	. "#line 1 \"$path\"\n{\n"	480	. "#line 1 \"$path\"\n{\n"
452	. (do { local $/; <$fh> })	481	. (do { local $/; <$fh> })
453	. "\n};\n1";	482	. "\n};\n1";
454		483
…		…
465	local $TERM = shift;	494	local $TERM = shift;
466	my $htype = shift;	495	my $htype = shift;
467		496
468	if ($htype == 0) { # INIT	497	if ($htype == 0) { # INIT
469	my @dirs = ((split /:/, $TERM->resource ("perl_lib")), "$LIBDIR/perl");	498	my @dirs = ((split /:/, $TERM->resource ("perl_lib")), "$LIBDIR/perl");
		499
		500	my %want_ext;
470		501
471	for my $ext (map { split /,/, $TERM->resource ("perl_ext_$_") } 1, 2) {	502	for (map { split /,/, $TERM->resource ("perl_ext_$_") } 1, 2) {
		503	if ($_ eq "default") {
		504	$want_ext{$_}++ for qw(selection option-popup selection-popup);
		505	} elsif (/^-(.*)$/) {
		506	delete $want_ext{$1};
		507	} else {
		508	$want_ext{$_}++;
		509	}
		510	}
		511
		512	for my $ext (keys %want_ext) {
472	my @files = grep -f $_, map "$_/$ext", @dirs;	513	my @files = grep -f $_, map "$_/$ext", @dirs;
473		514
474	if (@files) {	515	if (@files) {
475	register_package extension_package $files[0];	516	register_package extension_package $files[0];
476	} else {	517	} else {
477	warn "perl extension '$ext' not found in perl library search path\n";	518	warn "perl extension '$ext' not found in perl library search path\n";
478	}	519	}
479	}	520	}
		521
		522	eval "#line 1 \"--perl-eval resource/argument\"\n" . $TERM->resource ("perl_eval");
		523	warn $@ if $@;
480	}	524	}
481		525
482	$retval = undef;	526	$retval = undef;
483		527
484	if (my $cb = $TERM->{_hook}[$htype]) {	528	if (my $cb = $TERM->{_hook}[$htype]) {
…		…
496	$proxy	540	$proxy
497	},	541	},
498	@_,	542	@_,
499	) and last;	543	) and last;
500	};	544	};
501	warn $@ if $@;#d#	545	if ($@) {
		546	$TERM->ungrab; # better to lose the grab than the session
		547	warn $@;
		548	}
502	}	549	}
503	}	550	}
504		551
505	if ($htype == 1) { # DESTROY	552	if ($htype == 1) { # DESTROY
506	# remove hooks if unused	553	# remove hooks if unused
…		…
519	}	566	}
520		567
521	$retval	568	$retval
522	}	569	}
523		570
		571	# urxvt::term::proxy
		572
524	sub urxvt::term::proxy::AUTOLOAD {	573	sub urxvt::term::proxy::AUTOLOAD {
525	$urxvt::term::proxy::AUTOLOAD =~ /:([^:]+)$/	574	$urxvt::term::proxy::AUTOLOAD =~ /:([^:]+)$/
526	or die "FATAL: \$AUTOLOAD '$urxvt::term::proxy::AUTOLOAD' unparsable";	575	or die "FATAL: \$AUTOLOAD '$urxvt::term::proxy::AUTOLOAD' unparsable";
527		576
528	eval qq{	577	eval qq{
…		…
534	} or die "FATAL: unable to compile method forwarder: $@";	583	} or die "FATAL: unable to compile method forwarder: $@";
535		584
536	goto &$urxvt::term::proxy::AUTOLOAD;	585	goto &$urxvt::term::proxy::AUTOLOAD;
537	}	586	}
538		587
		588	sub urxvt::term::proxy::DESTROY {
		589	# nop
		590	}
		591
		592	# urxvt::destroy_hook
		593
		594	sub urxvt::destroy_hook::DESTROY {
		595	${$_[0]}->();
		596	}
		597
		598	sub urxvt::destroy_hook(&) {
		599	bless \shift, urxvt::destroy_hook::
		600	}
		601
		602	package urxvt::anyevent;
		603
		604	=head2 The C<urxvt::anyevent> Class
		605
		606	The sole purpose of this class is to deliver an interface to the
		607	C<AnyEvent> module - any module using it will work inside urxvt without
		608	further work. The only exception is that you cannot wait on condition
		609	variables, but non-blocking condvar use is ok. What this means is that you
		610	cannot use blocking APIs, but the non-blocking variant should work.
		611
		612	=cut
		613
		614	our $VERSION = 1;
		615
		616	$INC{"urxvt/anyevent.pm"} = 1; # mark us as there
		617	push @AnyEvent::REGISTRY, [urxvt => urxvt::anyevent::];
		618
		619	sub timer {
		620	my ($class, %arg) = @_;
		621
		622	my $cb = $arg{cb};
		623
		624	urxvt::timer
		625	->new
		626	->start (urxvt::NOW + $arg{after})
		627	->cb (sub {
		628	$_[0]->stop; # need to cancel manually
		629	$cb->();
		630	})
		631	}
		632
		633	sub io {
		634	my ($class, %arg) = @_;
		635
		636	my $cb = $arg{cb};
		637
		638	bless [$arg{fh}, urxvt::iow
		639	->new
		640	->fd (fileno $arg{fh})
		641	->events (($arg{poll} =~ /r/ ? 1 : 0)
		642	\| ($arg{poll} =~ /w/ ? 2 : 0))
		643	->start
		644	->cb (sub {
		645	$cb->(($_[1] & 1 ? 'r' : '')
		646	. ($_[1] & 2 ? 'w' : ''));
		647	})],
		648	urxvt::anyevent::
		649	}
		650
		651	sub DESTROY {
		652	$_[0][1]->stop;
		653	}
		654
		655	sub condvar {
		656	bless \my $flag, urxvt::anyevent::condvar::
		657	}
		658
		659	sub urxvt::anyevent::condvar::broadcast {
		660	${$_[0]}++;
		661	}
		662
		663	sub urxvt::anyevent::condvar::wait {
		664	unless (${$_[0]}) {
		665	require Carp;
		666	Carp::croak ("AnyEvent->condvar blocking wait unsupported in urxvt, use a non-blocking API");
		667	}
		668	}
		669
		670	package urxvt::term;
		671
539	=head2 The C<urxvt::term> Class	672	=head2 The C<urxvt::term> Class
540		673
541	=over 4	674	=over 4
542		675
543	=item $term->destroy	676	=item $term->destroy
544		677
545	Destroy the terminal object (close the window, free resources etc.).	678	Destroy the terminal object (close the window, free resources etc.).
		679
		680	=item $isset = $term->option ($optval[, $set])
		681
		682	Returns true if the option specified by C<$optval> is enabled, and
		683	optionally change it. All option values are stored by name in the hash
		684	C<%urxvt::OPTION>. Options not enabled in this binary are not in the hash.
		685
		686	Here is a a likely non-exhaustive list of option names, please see the
		687	source file F</src/optinc.h> to see the actual list:
		688
		689	borderLess console cursorBlink cursorUnderline hold iconic insecure
		690	intensityStyles jumpScroll loginShell mapAlert meta8 mouseWheelScrollPage
		691	pastableTabs pointerBlank reverseVideo scrollBar scrollBar_floating
		692	scrollBar_right scrollTtyKeypress scrollTtyOutput scrollWithBuffer
		693	secondaryScreen secondaryScroll skipBuiltinGlyphs transparent
		694	tripleclickwords utmpInhibit visualBell
546		695
547	=item $value = $term->resource ($name[, $newval])	696	=item $value = $term->resource ($name[, $newval])
548		697
549	Returns the current resource value associated with a given name and	698	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>	699	optionally sets a new value. Setting values is most useful in the C<init>
…		…
560		709
561	Please note that resource strings will currently only be freed when the	710	Please note that resource strings will currently only be freed when the
562	terminal is destroyed, so changing options frequently will eat memory.	711	terminal is destroyed, so changing options frequently will eat memory.
563		712
564	Here is a a likely non-exhaustive list of resource names, not all of which	713	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	714	are supported in every build, please see the source file F</src/rsinc.h>
566	list:	715	to see the actual list:
567		716
568	answerbackstring backgroundPixmap backspace_key boldFont boldItalicFont	717	answerbackstring backgroundPixmap backspace_key boldFont boldItalicFont
569	borderLess color cursorBlink cursorUnderline cutchars delete_key	718	borderLess color cursorBlink cursorUnderline cutchars delete_key
570	display_name embed ext_bwidth fade font geometry hold iconName	719	display_name embed ext_bwidth fade font geometry hold iconName
571	imFont imLocale inputMethod insecure int_bwidth intensityStyles	720	imFont imLocale inputMethod insecure int_bwidth intensityStyles
…		…
578	shade term_name title transparent transparent_all tripleclickwords	727	shade term_name title transparent transparent_all tripleclickwords
579	utmpInhibit visualBell	728	utmpInhibit visualBell
580		729
581	=cut	730	=cut
582		731
583	sub urxvt::term::resource($$;$) {	732	sub resource($$;$) {
584	my ($self, $name) = (shift, shift);	733	my ($self, $name) = (shift, shift);
585	unshift @_, $self, $name, ($name =~ s/\s\+\s(\d+)$// ? $1 : 0);	734	unshift @_, $self, $name, ($name =~ s/\s\+\s(\d+)$// ? $1 : 0);
586	goto &urxvt::term::_resource;	735	&urxvt::term::_resource
587	}	736	}
588		737
589	=item $rend = $term->rstyle ([$new_rstyle])	738	=item $rend = $term->rstyle ([$new_rstyle])
590		739
591	Return and optionally change the current rendition. Text that is output by	740	Return and optionally change the current rendition. Text that is output by
…		…
667		816
668	If hidden, display the overlay again.	817	If hidden, display the overlay again.
669		818
670	=back	819	=back
671		820
		821	=item $popup = $term->popup ($event)
		822
		823	Creates a new C<urxvt::popup> object that implements a popup menu. The
		824	C<$event> I<must> be the event causing the menu to pop up (a button event,
		825	currently).
		826
		827	=cut
		828
		829	sub popup {
		830	my ($self, $event) = @_;
		831
		832	$self->grab ($event->{time}, 1)
		833	or return;
		834
		835	my $popup = bless {
		836	term => $self,
		837	event => $event,
		838	}, urxvt::popup::;
		839
		840	Scalar::Util::weaken $popup->{term};
		841
		842	$self->{_destroy}{$popup} = urxvt::destroy_hook { $popup->{popup}->destroy };
		843	Scalar::Util::weaken $self->{_destroy}{$popup};
		844
		845	$popup
		846	}
		847
672	=item $cellwidth = $term->strwidth ($string)	848	=item $cellwidth = $term->strwidth ($string)
673		849
674	Returns the number of screen-cells this string would need. Correctly	850	Returns the number of screen-cells this string would need. Correctly
675	accounts for wide and combining characters.	851	accounts for wide and combining characters.
676		852
…		…
736	=item $nrow_plus_saveLines = $term->total_rows	912	=item $nrow_plus_saveLines = $term->total_rows
737		913
738	=item $lines_in_scrollback = $term->nsaved	914	=item $lines_in_scrollback = $term->nsaved
739		915
740	Return various integers describing terminal characteristics.	916	Return various integers describing terminal characteristics.
		917
		918	=item $modifiermask = $term->ModLevel3Mask
		919
		920	=item $modifiermask = $term->ModMetaMask
		921
		922	=item $modifiermask = $term->ModNumLockMask
		923
		924	Return the modifier masks corresponding to the "ISO Level 3 Shift" (often
		925	AltGr), the meta key (often Alt) and the num lock key, if applicable.
741		926
742	=item $view_start = $term->view_start ([$newvalue])	927	=item $view_start = $term->view_start ([$newvalue])
743		928
744	Returns the negative row number of the topmost line. Minimum value is	929	Returns the negative row number of the topmost line. Minimum value is
745	C<0>, which displays the normal terminal contents. Larger values scroll	930	C<0>, which displays the normal terminal contents. Larger values scroll
…		…
839		1024
840	=back	1025	=back
841		1026
842	=cut	1027	=cut
843		1028
844	sub urxvt::term::line {	1029	sub line {
845	my ($self, $row) = @_;	1030	my ($self, $row) = @_;
846		1031
847	my $maxrow = $self->nrow - 1;	1032	my $maxrow = $self->nrow - 1;
848		1033
849	my ($beg, $end) = ($row, $row);	1034	my ($beg, $end) = ($row, $row);
…		…
926		1111
927	Converts rxvt-unicodes text reprsentation into a perl string. See	1112	Converts rxvt-unicodes text reprsentation into a perl string. See
928	C<< $term->ROW_t >> for details.	1113	C<< $term->ROW_t >> for details.
929		1114
930	=back	1115	=back
		1116
		1117	=cut
		1118
		1119	package urxvt::popup;
		1120
		1121	=head2 The C<urxvt::popup> Class
		1122
		1123	=over 4
		1124
		1125	=cut
		1126
		1127	sub add_item {
		1128	my ($self, $item) = @_;
		1129
		1130	$item->{rend}{normal} = "\x1b[0;30;47m" unless exists $item->{rend}{normal};
		1131	$item->{rend}{hover} = "\x1b[0;30;46m" unless exists $item->{rend}{hover};
		1132	$item->{rend}{active} = "\x1b[m" unless exists $item->{rend}{active};
		1133
		1134	$item->{render} \|\|= sub { $_[0]{text} };
		1135
		1136	push @{ $self->{item} }, $item;
		1137	}
		1138
		1139	sub add_separator {
		1140	my ($self, $sep) = @_;
		1141
		1142	$sep \|\|= "═";
		1143
		1144	$self->add_item ({
		1145	rend => { normal => "\x1b[0;30;47m", hover => "\x1b[0;30;47m", active => "\x1b[0;30;47m" },
		1146	text => "",
		1147	render => sub { $sep x $urxvt::TERM->ncol },
		1148	activate => sub { },
		1149	});
		1150	}
		1151
		1152	sub add_title {
		1153	my ($self, $title) = @_;
		1154
		1155	$self->add_item ({
		1156	rend => { normal => "\x1b[38;5;11;44m", hover => "\x1b[38;5;11;44m", active => "\x1b[38;5;11;44m" },
		1157	text => $title,
		1158	activate => sub { },
		1159	});
		1160	}
		1161
		1162	sub add_button {
		1163	my ($self, $text, $cb) = @_;
		1164
		1165	$self->add_item ({ type => "button", text => "[ $text ]", activate => $cb});
		1166	}
		1167
		1168	sub add_toggle {
		1169	my ($self, $text, $cb, $value) = @_;
		1170
		1171	my $item; $item = {
		1172	type => "button",
		1173	text => " $text",
		1174	value => $value,
		1175	render => sub { ($_[0]{value} ? "* " : " ") . $text },
		1176	activate => sub { $cb->($_[0]{value} = !$_[0]{value}); },
		1177	};
		1178
		1179	$self->add_item ($item);
		1180	}
		1181
		1182	sub show {
		1183	my ($self) = @_;
		1184
		1185	local $urxvt::popup::self = $self;
		1186
		1187	urxvt->new ("--perl-lib" => "", "--perl-ext-common" => "", "-pty-fd" => -1, "-sl" => 0, "-b" => 0,
		1188	"--transient-for" => $self->{term}->parent,
		1189	"-pe" => "urxvt-popup")
		1190	or die "unable to create popup window\n";
		1191	}
		1192
		1193	sub DESTROY {
		1194	my ($self) = @_;
		1195
		1196	delete $self->{term}{_destroy}{$self};
		1197	$self->{term}->ungrab;
		1198	}
931		1199
932	=head2 The C<urxvt::timer> Class	1200	=head2 The C<urxvt::timer> Class
933		1201
934	This class implements timer watchers/events. Time is represented as a	1202	This class implements timer watchers/events. Time is represented as a
935	fractional number of seconds since the epoch. Example:	1203	fractional number of seconds since the epoch. Example:
…		…
1037	This variable controls the verbosity level of the perl extension. Higher	1305	This variable controls the verbosity level of the perl extension. Higher
1038	numbers indicate more verbose output.	1306	numbers indicate more verbose output.
1039		1307
1040	=over 4	1308	=over 4
1041		1309
1042	=item =0 - only fatal messages	1310	=item == 0 - fatal messages
1043		1311
1044	=item =3 - script loading and management	1312	=item >= 3 - script loading and management
1045		1313
1046	=item =10 - all events received	1314	=item >=10 - all events received
1047		1315
1048	=back	1316	=back
1049		1317
1050	=head1 AUTHOR	1318	=head1 AUTHOR
1051		1319

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.59 by root, Mon Jan 9 00:34:36 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.59 by root, Mon Jan 9 00:34:36 2006 UTC