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

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.58 by root, Sun Jan 8 22:58:13 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.58 by root, Sun Jan 8 22:58:13 2006 UTC