[ViewVC] Diff of: cvs/rxvt-unicode/src/urxvt.pm

Comparing rxvt-unicode/src/urxvt.pm (file contents):
Revision 1.38 by root, Fri Jan 6 03:43:12 2006 UTC vs.
Revision 1.49 by root, Sun Jan 8 00:07:18 2006 UTC

…		…
17		17
18	@@RXVT_NAME@@ --perl-lib $HOME -pe grab_test	18	@@RXVT_NAME@@ --perl-lib $HOME -pe grab_test
19		19
20	=head1 DESCRIPTION	20	=head1 DESCRIPTION
21		21
22	Everytime a terminal object gets created, scripts specified via the	22	Everytime a terminal object gets created, extension scripts specified via
23	C<perl> resource are loaded and associated with it.	23	the C<perl> resource are loaded and associated with it.
24		24
25	Scripts are compiled in a 'use strict' and 'use utf8' environment, and	25	Scripts are compiled in a 'use strict' and 'use utf8' environment, and
26	thus must be encoded as UTF-8.	26	thus must be encoded as UTF-8.
27		27
28	Each script will only ever be loaded once, even in @@RXVT_NAME@@d, where	28	Each script will only ever be loaded once, even in @@RXVT_NAME@@d, where
…		…
62		62
63	Displays a digital clock using the built-in overlay.	63	Displays a digital clock using the built-in overlay.
64		64
65	=item mark-urls	65	=item mark-urls
66		66
67	Uses per-line filtering (C<on_line_update>) to underline urls.	67	Uses per-line display filtering (C<on_line_update>) to underline urls.
		68
		69	=item block-graphics-to-ascii
		70
		71	A not very useful example of filtering all text output to the terminal,
		72	by replacing all line-drawing characters (U+2500 .. U+259F) by a
		73	similar-looking ascii character.
68		74
69	=item example-refresh-hooks	75	=item example-refresh-hooks
70		76
71	Displays a very simple digital clock in the upper right corner of the	77	Displays a very simple digital clock in the upper right corner of the
72	window. Illustrates overwriting the refresh callbacks to create your own	78	window. Illustrates overwriting the refresh callbacks to create your own
73	overlays or changes.	79	overlays or changes.
74
75	=item example-filter-input
76
77	A not very useful example of filtering all text output to the terminal, by
78	underlining all urls that matches a certain regex (i.e. some urls :). It
79	is not very useful because urls that are output in multiple steps (e.g.
80	when typing them) do not get marked.
81		80
82	=back	81	=back
83		82
84	=head2 General API Considerations	83	=head2 General API Considerations
85		84
…		…
117		116
118	=back	117	=back
119		118
120	=head2 Hooks	119	=head2 Hooks
121		120
122	The following subroutines can be declared in loaded scripts, and will be	121	The following subroutines can be declared in extension files, and will be
123	called whenever the relevant event happens.	122	called whenever the relevant event happens.
124		123
125	The first argument passed to them is an object private to each terminal	124	The first argument passed to them is an object private to each terminal
126	and extension package. You can call all C<urxvt::term> methods on it, but	125	and extension package. You can call all C<urxvt::term> methods on it, but
127	its not a real C<urxvt::term> object. Instead, the real C<urxvt::term>	126	its not a real C<urxvt::term> object. Instead, the real C<urxvt::term>
128	object that is shared between all packages is stored in the C<term>	127	object that is shared between all packages is stored in the C<term>
129	member.	128	member. It is, however, blessed intot he package of the extension script,
		129	so for all practical purposes you can treat an extension script as a class.
130		130
131	All of them must return a boolean value. If it is true, then the event	131	All of them must return a boolean value. If it is true, then the event
132	counts as being I<consumed>, and the invocation of other hooks is skipped,	132	counts as being I<consumed>, and the invocation of other hooks is skipped,
133	and the relevant action might not be carried out by the C++ code.	133	and the relevant action might not be carried out by the C++ code.
134		134
…		…
178	click) and is either supposed to return false (normal operation), or	178	click) and is either supposed to return false (normal operation), or
179	should extend the selection itelf and return true to suppress the built-in	179	should extend the selection itelf and return true to suppress the built-in
180	processing.	180	processing.
181		181
182	See the F<selection> example extension.	182	See the F<selection> example extension.
183
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		183
194	=item on_view_change $term, $offset	184	=item on_view_change $term, $offset
195		185
196	Called whenever the view offset changes, i..e the user or program	186	Called whenever the view offset changes, i..e the user or program
197	scrolls. Offset C<0> means display the normal terminal, positive values	187	scrolls. Offset C<0> means display the normal terminal, positive values
…		…
261		251
262	Called whenever the user presses a key combination that has a	252	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>	253	C<perl:string> action bound to it (see description of the B<keysym>
264	resource in the @@RXVT_NAME@@(1) manpage).	254	resource in the @@RXVT_NAME@@(1) manpage).
265		255
		256	=item on_focus_in $term
		257
		258	Called whenever the window gets the keyboard focus, before rxvt-unicode
		259	does focus in processing.
		260
		261	=item on_focus_out $term
		262
		263	Called wheneever the window loses keyboard focus, before rxvt-unicode does
		264	focus out processing.
		265
266	=item on_key_press $term, $event, $octets	266	=item on_key_press $term, $event, $octets
267		267
268	=item on_key_release $term, $event	268	=item on_key_release $term, $event
269		269
270	=item on_button_press $term, $event	270	=item on_button_press $term, $event
271		271
272	=item on_button_release $term, $event	272	=item on_button_release $term, $event
273		273
274	=item on_motion_notify $term, $event	274	=item on_motion_notify $term, $event
275		275
		276	=item on_map_notify $term, $event
		277
		278	=item on_unmap_notify $term, $event
		279
276	Called whenever the corresponding X event is received for the terminal	280	Called whenever the corresponding X event is received for the terminal If
277	(see the XEvent manpage) If the hook returns true, then the even will be	281	the hook returns true, then the even will be ignored by rxvt-unicode.
278	ignored by rxvt-unicode.	282
		283	The event is a hash with most values as named by Xlib (see the XEvent
		284	manpage), with the additional members C<row> and C<col>, which are the row
		285	and column under the mouse cursor.
279		286
280	C<on_key_press> additionally receives the string rxvt-unicode would	287	C<on_key_press> additionally receives the string rxvt-unicode would
281	output, if any, in locale-specific encoding.	288	output, if any, in locale-specific encoding.
282		289
283	subwindow.	290	subwindow.
…		…
288		295
289	=over 4	296	=over 4
290		297
291	=item $urxvt::TERM	298	=item $urxvt::TERM
292		299
293	The current terminal. Whenever a callback/Hook is bein executed, this	300	The current terminal. This variable stores the current C<urxvt::term>
294	variable stores the current C<urxvt::term> object.	301	object, whenever a callback/hook is executing.
295		302
296	=back	303	=back
297		304
298	=head2 Functions in the C<urxvt> Package	305	=head2 Functions in the C<urxvt> Package
299		306
…		…
324		331
325	=item $time = urxvt::NOW	332	=item $time = urxvt::NOW
326		333
327	Returns the "current time" (as per the event loop).	334	Returns the "current time" (as per the event loop).
328		335
		336	=item urxvt::CurrentTime
		337
		338	=item urxvt::ShiftMask, LockMask, ControlMask, Mod1Mask, Mod2Mask,
		339	Mod3Mask, Mod4Mask, Mod5Mask, Button1Mask, Button2Mask, Button3Mask,
		340	Button4Mask, Button5Mask, AnyModifier
		341
		342	Various constants for use in X events.
		343
329	=back	344	=back
330		345
331	=head2 RENDITION	346	=head2 RENDITION
332		347
333	Rendition bitsets contain information about colour, font, font styles and	348	Rendition bitsets contain information about colour, font, font styles and
…		…
382		397
383	=cut	398	=cut
384		399
385	package urxvt;	400	package urxvt;
386		401
		402	use utf8;
387	use strict;	403	use strict;
388	use Scalar::Util ();	404	use Scalar::Util ();
		405	use List::Util ();
389		406
390	our $TERM;	407	our $TERM;
391	our @HOOKNAME;	408	our @HOOKNAME;
		409	our %OPTION;
392	our $LIBDIR;	410	our $LIBDIR;
393		411
394	BEGIN {	412	BEGIN {
395	urxvt->bootstrap;	413	urxvt->bootstrap;
396		414
…		…
426	$hook_count[$htype]++	444	$hook_count[$htype]++
427	or set_should_invoke $htype, 1;	445	or set_should_invoke $htype, 1;
428	}	446	}
429	}	447	}
430		448
431	my $script_pkg = "script0000";	449	my $extension_pkg = "extension0000";
432	my %script_pkg;	450	my %extension_pkg;
433		451
434	# load a single script into its own package, once only	452	# load a single script into its own package, once only
435	sub script_package($) {	453	sub extension_package($) {
436	my ($path) = @_;	454	my ($path) = @_;
437		455
438	$script_pkg{$path} \|\|= do {	456	$extension_pkg{$path} \|\|= do {
439	my $pkg = "urxvt::" . ($script_pkg++);	457	my $pkg = "urxvt::" . ($extension_pkg++);
440		458
441	verbose 3, "loading script '$path' into package '$pkg'";	459	verbose 3, "loading extension '$path' into package '$pkg'";
442		460
443	open my $fh, "<:raw", $path	461	open my $fh, "<:raw", $path
444	or die "$path: $!";	462	or die "$path: $!";
445		463
446	my $source = "package $pkg; use strict; use utf8;\n"	464	my $source = "package $pkg; use strict; use utf8;\n"
		465	. "use base urxvt::term::proxy::;\n"
447	. "#line 1 \"$path\"\n{\n"	466	. "#line 1 \"$path\"\n{\n"
448	. (do { local $/; <$fh> })	467	. (do { local $/; <$fh> })
449	. "\n};\n1";	468	. "\n};\n1";
450		469
451	eval $source or die "$path: $@";	470	eval $source or die "$path: $@";
…		…
461	local $TERM = shift;	480	local $TERM = shift;
462	my $htype = shift;	481	my $htype = shift;
463		482
464	if ($htype == 0) { # INIT	483	if ($htype == 0) { # INIT
465	my @dirs = ((split /:/, $TERM->resource ("perl_lib")), "$LIBDIR/perl");	484	my @dirs = ((split /:/, $TERM->resource ("perl_lib")), "$LIBDIR/perl");
466		485
467	for my $ext (map { split /:/, $TERM->resource ("perl_ext_$_") } 1, 2) {	486	my @ext = (map { split /,/, $TERM->resource ("perl_ext_$_") } 1, 2);
468	my @files = grep -f $_, map "$_/$ext", @dirs;
469		487
470	if (@files) {	488	while (@ext) {
471	register_package script_package $files[0];	489	my $ext = shift @ext;
		490	if ($ext eq "default") {
		491	unshift @ext, qw(selection);
472	} else {	492	} else {
		493	my @files = grep -f $_, map "$_/$ext", @dirs;
		494
		495	if (@files) {
		496	register_package extension_package $files[0];
		497	} else {
473	warn "perl extension '$ext' not found in perl library search path\n";	498	warn "perl extension '$ext' not found in perl library search path\n";
		499	}
474	}	500	}
475	}	501	}
476	}	502	}
477		503
478	$retval = undef;	504	$retval = undef;
…		…
482	if $verbosity >= 10;	508	if $verbosity >= 10;
483		509
484	keys %$cb;	510	keys %$cb;
485		511
486	while (my ($pkg, $cb) = each %$cb) {	512	while (my ($pkg, $cb) = each %$cb) {
		513	eval {
487	$retval = $cb->(	514	$retval = $cb->(
488	$TERM->{_pkg}{$pkg} \|\|= do {	515	$TERM->{_pkg}{$pkg} \|\|= do {
489	my $proxy = bless { }, urxvt::term::proxy::;	516	my $proxy = bless { }, $pkg;
490	Scalar::Util::weaken ($proxy->{term} = $TERM);	517	Scalar::Util::weaken ($proxy->{term} = $TERM);
491	$proxy	518	$proxy
492	},	519	},
493	@_,	520	@_,
494	) and last;	521	) and last;
		522	};
		523	warn $@ if $@;#d#
495	}	524	}
496	}	525	}
497		526
498	if ($htype == 1) { # DESTROY	527	if ($htype == 1) { # DESTROY
499	# remove hooks if unused	528	# remove hooks if unused
…		…
527	} or die "FATAL: unable to compile method forwarder: $@";	556	} or die "FATAL: unable to compile method forwarder: $@";
528		557
529	goto &$urxvt::term::proxy::AUTOLOAD;	558	goto &$urxvt::term::proxy::AUTOLOAD;
530	}	559	}
531		560
		561	sub urxvt::destroy_hook::DESTROY {
		562	${$_[0]}->();
		563	}
		564
		565	sub urxvt::destroy_hook(&) {
		566	bless \shift, urxvt::destroy_hook::
		567	}
		568
532	=head2 The C<urxvt::term> Class	569	=head2 The C<urxvt::term> Class
533		570
534	=over 4	571	=over 4
535		572
536	=item $term->destroy	573	=item $term->destroy
537		574
538	Destroy the terminal object (close the window, free resources etc.).	575	Destroy the terminal object (close the window, free resources etc.).
		576
		577	=item $isset = $term->option ($optval[, $set])
		578
		579	Returns true if the option specified by C<$optval> is enabled, and
		580	optionally change it. All option values are stored by name in the hash
		581	C<%urxvt::OPTION>. Options not enabled in this binary are not in the hash.
		582
		583	Here is a a likely non-exhaustive list of option names, please see the
		584	source file F</src/optinc.h> to see the actual list:
		585
		586	borderLess console cursorBlink cursorUnderline hold iconic insecure
		587	intensityStyles jumpScroll loginShell mapAlert meta8 mouseWheelScrollPage
		588	pastableTabs pointerBlank reverseVideo scrollBar scrollBar_floating
		589	scrollBar_right scrollTtyKeypress scrollTtyOutput scrollWithBuffer
		590	secondaryScreen secondaryScroll skipBuiltinGlyphs transparent
		591	tripleclickwords utmpInhibit visualBell
539		592
540	=item $value = $term->resource ($name[, $newval])	593	=item $value = $term->resource ($name[, $newval])
541		594
542	Returns the current resource value associated with a given name and	595	Returns the current resource value associated with a given name and
543	optionally sets a new value. Setting values is most useful in the C<init>	596	optionally sets a new value. Setting values is most useful in the C<init>
…		…
553		606
554	Please note that resource strings will currently only be freed when the	607	Please note that resource strings will currently only be freed when the
555	terminal is destroyed, so changing options frequently will eat memory.	608	terminal is destroyed, so changing options frequently will eat memory.
556		609
557	Here is a a likely non-exhaustive list of resource names, not all of which	610	Here is a a likely non-exhaustive list of resource names, not all of which
558	are supported in every build, please see the source to see the actual	611	are supported in every build, please see the source file F</src/rsinc.h>
559	list:	612	to see the actual list:
560		613
561	answerbackstring backgroundPixmap backspace_key boldFont boldItalicFont	614	answerbackstring backgroundPixmap backspace_key boldFont boldItalicFont
562	borderLess color cursorBlink cursorUnderline cutchars delete_key	615	borderLess color cursorBlink cursorUnderline cutchars delete_key
563	display_name embed ext_bwidth fade font geometry hold iconName	616	display_name embed ext_bwidth fade font geometry hold iconName
564	imFont imLocale inputMethod insecure int_bwidth intensityStyles	617	imFont imLocale inputMethod insecure int_bwidth intensityStyles
…		…
574	=cut	627	=cut
575		628
576	sub urxvt::term::resource($$;$) {	629	sub urxvt::term::resource($$;$) {
577	my ($self, $name) = (shift, shift);	630	my ($self, $name) = (shift, shift);
578	unshift @_, $self, $name, ($name =~ s/\s\+\s(\d+)$// ? $1 : 0);	631	unshift @_, $self, $name, ($name =~ s/\s\+\s(\d+)$// ? $1 : 0);
579	goto &urxvt::term::_resource;	632	&urxvt::term::_resource
580	}	633	}
581		634
582	=item $rend = $term->rstyle ([$new_rstyle])	635	=item $rend = $term->rstyle ([$new_rstyle])
583		636
584	Return and optionally change the current rendition. Text that is output by	637	Return and optionally change the current rendition. Text that is output by
…		…
660		713
661	If hidden, display the overlay again.	714	If hidden, display the overlay again.
662		715
663	=back	716	=back
664		717
		718	=item $popup = $term->popup ($event)
		719
		720	Creates a new C<urxvt::popup> object that implements a popup menu. The
		721	C<$event> I<must> be the event causing the menu to pop up (a button event,
		722	currently).
		723
		724	=cut
		725
		726	sub urxvt::term::popup {
		727	my ($self, $event) = @_;
		728
		729	$self->grab ($event->{time}, 1)
		730	or return;
		731
		732	my $popup = bless {
		733	term => $self,
		734	event => $event,
		735	}, urxvt::popup::;
		736
		737	Scalar::Util::weaken $popup->{term};
		738
		739	$self->{_destroy}{$popup} = urxvt::destroy_hook { $popup->{popup}->destroy };
		740	Scalar::Util::weaken $self->{_destroy}{$popup};
		741
		742	$popup
		743	}
		744
665	=item $cellwidth = $term->strwidth $string	745	=item $cellwidth = $term->strwidth ($string)
666		746
667	Returns the number of screen-cells this string would need. Correctly	747	Returns the number of screen-cells this string would need. Correctly
668	accounts for wide and combining characters.	748	accounts for wide and combining characters.
669		749
670	=item $octets = $term->locale_encode $string	750	=item $octets = $term->locale_encode ($string)
671		751
672	Convert the given text string into the corresponding locale encoding.	752	Convert the given text string into the corresponding locale encoding.
673		753
674	=item $string = $term->locale_decode $octets	754	=item $string = $term->locale_decode ($octets)
675		755
676	Convert the given locale-encoded octets into a perl string.	756	Convert the given locale-encoded octets into a perl string.
677		757
678	=item $term->scr_add_lines ($string)	758	=item $term->scr_add_lines ($string)
679		759
…		…
696		776
697	Write the octets given in C<$data> to the tty (i.e. as program input). To	777	Write the octets given in C<$data> to the tty (i.e. as program input). To
698	pass characters instead of octets, you should convert your strings first	778	pass characters instead of octets, you should convert your strings first
699	to the locale-specific encoding using C<< $term->locale_encode >>.	779	to the locale-specific encoding using C<< $term->locale_encode >>.
700		780
		781	=item $windowid = $term->parent
		782
		783	Return the window id of the toplevel window.
		784
		785	=item $windowid = $term->vt
		786
		787	Return the window id of the terminal window.
		788
701	=item $window_width = $term->width	789	=item $window_width = $term->width
702		790
703	=item $window_height = $term->height	791	=item $window_height = $term->height
704		792
705	=item $font_width = $term->fwidth	793	=item $font_width = $term->fwidth
…		…
721	=item $nrow_plus_saveLines = $term->total_rows	809	=item $nrow_plus_saveLines = $term->total_rows
722		810
723	=item $lines_in_scrollback = $term->nsaved	811	=item $lines_in_scrollback = $term->nsaved
724		812
725	Return various integers describing terminal characteristics.	813	Return various integers describing terminal characteristics.
		814
		815	=item $modifiermask = $term->ModLevel3Mask
		816
		817	=item $modifiermask = $term->ModMetaMask
		818
		819	=item $modifiermask = $term->ModNumLockMask
		820
		821	Return the modifier masks corresponding to the "ISO Level 3 Shift" (often
		822	AltGr), the meta key (often Alt) and the num lock key, if applicable.
726		823
727	=item $view_start = $term->view_start ([$newvalue])	824	=item $view_start = $term->view_start ([$newvalue])
728		825
729	Returns the negative row number of the topmost line. Minimum value is	826	Returns the negative row number of the topmost line. Minimum value is
730	C<0>, which displays the normal terminal contents. Larger values scroll	827	C<0>, which displays the normal terminal contents. Larger values scroll
…		…
911		1008
912	Converts rxvt-unicodes text reprsentation into a perl string. See	1009	Converts rxvt-unicodes text reprsentation into a perl string. See
913	C<< $term->ROW_t >> for details.	1010	C<< $term->ROW_t >> for details.
914		1011
915	=back	1012	=back
		1013
		1014	=head2 The C<urxvt::popup> Class
		1015
		1016	=over 4
		1017
		1018	=cut
		1019
		1020	package urxvt::popup;
		1021
		1022	sub add_item {
		1023	my ($self, $item) = @_;
		1024
		1025	push @{ $self->{item} }, $item;
		1026	}
		1027
		1028	sub add_button {
		1029	my ($self, $text, $cb) = @_;
		1030
		1031	$self->add_item ({ type => "button", text => "[ $text ]", activate => $cb,
		1032	render => sub { $_[0]{text} },
		1033	});
		1034	}
		1035
		1036	sub add_toggle {
		1037	my ($self, $text, $cb, $value) = @_;
		1038
		1039	my $item; $item = {
		1040	type => "button",
		1041	text => " $text",
		1042	value => $value,
		1043	render => sub { ($item->{value} ? "✔" : " ") . $text },
		1044	activate => sub { $cb->($item->{value} = !$item->{value}); },
		1045	};
		1046
		1047	$self->add_item ($item);
		1048	}
		1049
		1050	sub show {
		1051	my ($self) = @_;
		1052
		1053	local $urxvt::popup::self = $self;
		1054
		1055	urxvt->new ("--perl-lib" => "", "--perl-ext-common" => "", "-pty-fd" => -1, "-sl" => 0, "-b" => 0,
		1056	"--transient-for" => $self->{term}->parent,
		1057	"-pe" => "urxvt-popup")
		1058	or die "unable to create popup window\n";
		1059	}
		1060
		1061	sub DESTROY {
		1062	my ($self) = @_;
		1063
		1064	$self->{term}->ungrab;
		1065	}
916		1066
917	=head2 The C<urxvt::timer> Class	1067	=head2 The C<urxvt::timer> Class
918		1068
919	This class implements timer watchers/events. Time is represented as a	1069	This class implements timer watchers/events. Time is represented as a
920	fractional number of seconds since the epoch. Example:	1070	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.38 by root, Fri Jan 6 03:43:12 2006 UTC vs. Revision 1.49 by root, Sun Jan 8 00:07:18 2006 UTC

Diff Legend

Comparing rxvt-unicode/src/urxvt.pm (file contents):
Revision 1.38 by root, Fri Jan 6 03:43:12 2006 UTC vs.
Revision 1.49 by root, Sun Jan 8 00:07:18 2006 UTC