[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.54 by root, Sun Jan 8 01:59:29 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 events.
		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
393	our $TERM;	412	our $TERM;
394	our @HOOKNAME;	413	our @HOOKNAME;
		414	our %OPTION;
395	our $LIBDIR;	415	our $LIBDIR;
396		416
397	BEGIN {	417	BEGIN {
398	urxvt->bootstrap;	418	urxvt->bootstrap;
399		419
…		…
465	local $TERM = shift;	485	local $TERM = shift;
466	my $htype = shift;	486	my $htype = shift;
467		487
468	if ($htype == 0) { # INIT	488	if ($htype == 0) { # INIT
469	my @dirs = ((split /:/, $TERM->resource ("perl_lib")), "$LIBDIR/perl");	489	my @dirs = ((split /:/, $TERM->resource ("perl_lib")), "$LIBDIR/perl");
		490
		491	my %want_ext;
470		492
471	for my $ext (map { split /,/, $TERM->resource ("perl_ext_$_") } 1, 2) {	493	for (map { split /,/, $TERM->resource ("perl_ext_$_") } 1, 2) {
		494	if ($_ eq "default") {
		495	$want_ext{$_}++ for qw(selection option-popup);
		496	} elsif (/^-(.*)$/) {
		497	delete $want_ext{$1};
		498	} else {
		499	$want_ext{$_}++;
		500	}
		501	}
		502
		503	for my $ext (keys %want_ext) {
472	my @files = grep -f $_, map "$_/$ext", @dirs;	504	my @files = grep -f $_, map "$_/$ext", @dirs;
473		505
474	if (@files) {	506	if (@files) {
475	register_package extension_package $files[0];	507	register_package extension_package $files[0];
476	} else {	508	} else {
…		…
534	} or die "FATAL: unable to compile method forwarder: $@";	566	} or die "FATAL: unable to compile method forwarder: $@";
535		567
536	goto &$urxvt::term::proxy::AUTOLOAD;	568	goto &$urxvt::term::proxy::AUTOLOAD;
537	}	569	}
538		570
		571	sub urxvt::destroy_hook::DESTROY {
		572	${$_[0]}->();
		573	}
		574
		575	sub urxvt::destroy_hook(&) {
		576	bless \shift, urxvt::destroy_hook::
		577	}
		578
539	=head2 The C<urxvt::term> Class	579	=head2 The C<urxvt::term> Class
540		580
541	=over 4	581	=over 4
542		582
543	=item $term->destroy	583	=item $term->destroy
544		584
545	Destroy the terminal object (close the window, free resources etc.).	585	Destroy the terminal object (close the window, free resources etc.).
		586
		587	=item $isset = $term->option ($optval[, $set])
		588
		589	Returns true if the option specified by C<$optval> is enabled, and
		590	optionally change it. All option values are stored by name in the hash
		591	C<%urxvt::OPTION>. Options not enabled in this binary are not in the hash.
		592
		593	Here is a a likely non-exhaustive list of option names, please see the
		594	source file F</src/optinc.h> to see the actual list:
		595
		596	borderLess console cursorBlink cursorUnderline hold iconic insecure
		597	intensityStyles jumpScroll loginShell mapAlert meta8 mouseWheelScrollPage
		598	pastableTabs pointerBlank reverseVideo scrollBar scrollBar_floating
		599	scrollBar_right scrollTtyKeypress scrollTtyOutput scrollWithBuffer
		600	secondaryScreen secondaryScroll skipBuiltinGlyphs transparent
		601	tripleclickwords utmpInhibit visualBell
546		602
547	=item $value = $term->resource ($name[, $newval])	603	=item $value = $term->resource ($name[, $newval])
548		604
549	Returns the current resource value associated with a given name and	605	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>	606	optionally sets a new value. Setting values is most useful in the C<init>
…		…
560		616
561	Please note that resource strings will currently only be freed when the	617	Please note that resource strings will currently only be freed when the
562	terminal is destroyed, so changing options frequently will eat memory.	618	terminal is destroyed, so changing options frequently will eat memory.
563		619
564	Here is a a likely non-exhaustive list of resource names, not all of which	620	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	621	are supported in every build, please see the source file F</src/rsinc.h>
566	list:	622	to see the actual list:
567		623
568	answerbackstring backgroundPixmap backspace_key boldFont boldItalicFont	624	answerbackstring backgroundPixmap backspace_key boldFont boldItalicFont
569	borderLess color cursorBlink cursorUnderline cutchars delete_key	625	borderLess color cursorBlink cursorUnderline cutchars delete_key
570	display_name embed ext_bwidth fade font geometry hold iconName	626	display_name embed ext_bwidth fade font geometry hold iconName
571	imFont imLocale inputMethod insecure int_bwidth intensityStyles	627	imFont imLocale inputMethod insecure int_bwidth intensityStyles
…		…
581	=cut	637	=cut
582		638
583	sub urxvt::term::resource($$;$) {	639	sub urxvt::term::resource($$;$) {
584	my ($self, $name) = (shift, shift);	640	my ($self, $name) = (shift, shift);
585	unshift @_, $self, $name, ($name =~ s/\s\+\s(\d+)$// ? $1 : 0);	641	unshift @_, $self, $name, ($name =~ s/\s\+\s(\d+)$// ? $1 : 0);
586	goto &urxvt::term::_resource;	642	&urxvt::term::_resource
587	}	643	}
588		644
589	=item $rend = $term->rstyle ([$new_rstyle])	645	=item $rend = $term->rstyle ([$new_rstyle])
590		646
591	Return and optionally change the current rendition. Text that is output by	647	Return and optionally change the current rendition. Text that is output by
…		…
667		723
668	If hidden, display the overlay again.	724	If hidden, display the overlay again.
669		725
670	=back	726	=back
671		727
		728	=item $popup = $term->popup ($event)
		729
		730	Creates a new C<urxvt::popup> object that implements a popup menu. The
		731	C<$event> I<must> be the event causing the menu to pop up (a button event,
		732	currently).
		733
		734	=cut
		735
		736	sub urxvt::term::popup {
		737	my ($self, $event) = @_;
		738
		739	$self->grab ($event->{time}, 1)
		740	or return;
		741
		742	my $popup = bless {
		743	term => $self,
		744	event => $event,
		745	}, urxvt::popup::;
		746
		747	Scalar::Util::weaken $popup->{term};
		748
		749	$self->{_destroy}{$popup} = urxvt::destroy_hook { $popup->{popup}->destroy };
		750	Scalar::Util::weaken $self->{_destroy}{$popup};
		751
		752	$popup
		753	}
		754
672	=item $cellwidth = $term->strwidth ($string)	755	=item $cellwidth = $term->strwidth ($string)
673		756
674	Returns the number of screen-cells this string would need. Correctly	757	Returns the number of screen-cells this string would need. Correctly
675	accounts for wide and combining characters.	758	accounts for wide and combining characters.
676		759
…		…
736	=item $nrow_plus_saveLines = $term->total_rows	819	=item $nrow_plus_saveLines = $term->total_rows
737		820
738	=item $lines_in_scrollback = $term->nsaved	821	=item $lines_in_scrollback = $term->nsaved
739		822
740	Return various integers describing terminal characteristics.	823	Return various integers describing terminal characteristics.
		824
		825	=item $modifiermask = $term->ModLevel3Mask
		826
		827	=item $modifiermask = $term->ModMetaMask
		828
		829	=item $modifiermask = $term->ModNumLockMask
		830
		831	Return the modifier masks corresponding to the "ISO Level 3 Shift" (often
		832	AltGr), the meta key (often Alt) and the num lock key, if applicable.
741		833
742	=item $view_start = $term->view_start ([$newvalue])	834	=item $view_start = $term->view_start ([$newvalue])
743		835
744	Returns the negative row number of the topmost line. Minimum value is	836	Returns the negative row number of the topmost line. Minimum value is
745	C<0>, which displays the normal terminal contents. Larger values scroll	837	C<0>, which displays the normal terminal contents. Larger values scroll
…		…
926		1018
927	Converts rxvt-unicodes text reprsentation into a perl string. See	1019	Converts rxvt-unicodes text reprsentation into a perl string. See
928	C<< $term->ROW_t >> for details.	1020	C<< $term->ROW_t >> for details.
929		1021
930	=back	1022	=back
		1023
		1024	=head2 The C<urxvt::popup> Class
		1025
		1026	=over 4
		1027
		1028	=cut
		1029
		1030	package urxvt::popup;
		1031
		1032	sub add_item {
		1033	my ($self, $item) = @_;
		1034
		1035	$item->{rend}{normal} = "\x1b[0;30;47m" unless exists $item->{rend}{normal};
		1036	$item->{rend}{hover} = "\x1b[0;30;46m" unless exists $item->{rend}{hover};
		1037	$item->{rend}{active} = "\x1b[m" unless exists $item->{rend}{active};
		1038
		1039	$item->{render} \|\|= sub { $_[0]{text} };
		1040
		1041	push @{ $self->{item} }, $item;
		1042	}
		1043
		1044	sub add_separator {
		1045	my ($self, $sep) = @_;
		1046
		1047	$sep \|\|= "═";
		1048
		1049	$self->add_item ({
		1050	rend => { normal => "\x1b[0;30;47m", hover => "\x1b[0;30;47m", active => "\x1b[0;30;47m" },
		1051	text => "",
		1052	render => sub { $sep x $urxvt::TERM->ncol },
		1053	activate => sub { },
		1054	});
		1055	}
		1056
		1057	sub add_title {
		1058	my ($self, $title) = @_;
		1059
		1060	$self->add_item ({
		1061	rend => { normal => "\x1b[38;5;11;44m", hover => "\x1b[38;5;11;44m", active => "\x1b[38;5;11;44m" },
		1062	text => $title,
		1063	activate => sub { },
		1064	});
		1065	}
		1066
		1067	sub add_button {
		1068	my ($self, $text, $cb) = @_;
		1069
		1070	$self->add_item ({ type => "button", text => "[ $text ]", activate => $cb});
		1071	}
		1072
		1073	sub add_toggle {
		1074	my ($self, $text, $cb, $value) = @_;
		1075
		1076	my $item; $item = {
		1077	type => "button",
		1078	text => " $text",
		1079	value => $value,
		1080	render => sub { ($item->{value} ? "* " : " ") . $text },
		1081	activate => sub { $cb->($item->{value} = !$item->{value}); },
		1082	};
		1083
		1084	$self->add_item ($item);
		1085	}
		1086
		1087	sub show {
		1088	my ($self) = @_;
		1089
		1090	local $urxvt::popup::self = $self;
		1091
		1092	urxvt->new ("--perl-lib" => "", "--perl-ext-common" => "", "-pty-fd" => -1, "-sl" => 0, "-b" => 0,
		1093	"--transient-for" => $self->{term}->parent,
		1094	"-pe" => "urxvt-popup")
		1095	or die "unable to create popup window\n";
		1096	}
		1097
		1098	sub DESTROY {
		1099	my ($self) = @_;
		1100
		1101	$self->{term}->ungrab;
		1102	}
931		1103
932	=head2 The C<urxvt::timer> Class	1104	=head2 The C<urxvt::timer> Class
933		1105
934	This class implements timer watchers/events. Time is represented as a	1106	This class implements timer watchers/events. Time is represented as a
935	fractional number of seconds since the epoch. Example:	1107	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.54 by root, Sun Jan 8 01:59:29 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.54 by root, Sun Jan 8 01:59:29 2006 UTC