[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.47 by root, Sat Jan 7 21:22:02 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
…		…
323	correct place, e.g. on stderr of the connecting urxvtc client.	330	correct place, e.g. on stderr of the connecting urxvtc client.
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).
		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.
328		343
329	=back	344	=back
330		345
331	=head2 RENDITION	346	=head2 RENDITION
332		347
…		…
426	$hook_count[$htype]++	441	$hook_count[$htype]++
427	or set_should_invoke $htype, 1;	442	or set_should_invoke $htype, 1;
428	}	443	}
429	}	444	}
430		445
431	my $script_pkg = "script0000";	446	my $extension_pkg = "extension0000";
432	my %script_pkg;	447	my %extension_pkg;
433		448
434	# load a single script into its own package, once only	449	# load a single script into its own package, once only
435	sub script_package($) {	450	sub extension_package($) {
436	my ($path) = @_;	451	my ($path) = @_;
437		452
438	$script_pkg{$path} \|\|= do {	453	$extension_pkg{$path} \|\|= do {
439	my $pkg = "urxvt::" . ($script_pkg++);	454	my $pkg = "urxvt::" . ($extension_pkg++);
440		455
441	verbose 3, "loading script '$path' into package '$pkg'";	456	verbose 3, "loading extension '$path' into package '$pkg'";
442		457
443	open my $fh, "<:raw", $path	458	open my $fh, "<:raw", $path
444	or die "$path: $!";	459	or die "$path: $!";
445		460
446	my $source = "package $pkg; use strict; use utf8;\n"	461	my $source = "package $pkg; use strict; use utf8;\n"
		462	. "use base urxvt::term::proxy::;\n"
447	. "#line 1 \"$path\"\n{\n"	463	. "#line 1 \"$path\"\n{\n"
448	. (do { local $/; <$fh> })	464	. (do { local $/; <$fh> })
449	. "\n};\n1";	465	. "\n};\n1";
450		466
451	eval $source or die "$path: $@";	467	eval $source or die "$path: $@";
…		…
462	my $htype = shift;	478	my $htype = shift;
463		479
464	if ($htype == 0) { # INIT	480	if ($htype == 0) { # INIT
465	my @dirs = ((split /:/, $TERM->resource ("perl_lib")), "$LIBDIR/perl");	481	my @dirs = ((split /:/, $TERM->resource ("perl_lib")), "$LIBDIR/perl");
466		482
467	for my $ext (map { split /:/, $TERM->resource ("perl_ext_$_") } 1, 2) {	483	for my $ext (map { split /,/, $TERM->resource ("perl_ext_$_") } 1, 2) {
468	my @files = grep -f $_, map "$_/$ext", @dirs;	484	my @files = grep -f $_, map "$_/$ext", @dirs;
469		485
470	if (@files) {	486	if (@files) {
471	register_package script_package $files[0];	487	register_package extension_package $files[0];
472	} else {	488	} else {
473	warn "perl extension '$ext' not found in perl library search path\n";	489	warn "perl extension '$ext' not found in perl library search path\n";
474	}	490	}
475	}	491	}
476	}	492	}
…		…
482	if $verbosity >= 10;	498	if $verbosity >= 10;
483		499
484	keys %$cb;	500	keys %$cb;
485		501
486	while (my ($pkg, $cb) = each %$cb) {	502	while (my ($pkg, $cb) = each %$cb) {
		503	eval {
487	$retval = $cb->(	504	$retval = $cb->(
488	$TERM->{_pkg}{$pkg} \|\|= do {	505	$TERM->{_pkg}{$pkg} \|\|= do {
489	my $proxy = bless { }, urxvt::term::proxy::;	506	my $proxy = bless { }, $pkg;
490	Scalar::Util::weaken ($proxy->{term} = $TERM);	507	Scalar::Util::weaken ($proxy->{term} = $TERM);
491	$proxy	508	$proxy
492	},	509	},
493	@_,	510	@_,
494	) and last;	511	) and last;
		512	};
		513	warn $@ if $@;#d#
495	}	514	}
496	}	515	}
497		516
498	if ($htype == 1) { # DESTROY	517	if ($htype == 1) { # DESTROY
499	# remove hooks if unused	518	# remove hooks if unused
…		…
525	}	544	}
526	1	545	1
527	} or die "FATAL: unable to compile method forwarder: $@";	546	} or die "FATAL: unable to compile method forwarder: $@";
528		547
529	goto &$urxvt::term::proxy::AUTOLOAD;	548	goto &$urxvt::term::proxy::AUTOLOAD;
		549	}
		550
		551	sub urxvt::destroy_hook::DESTROY {
		552	${$_[0]}->();
		553	}
		554
		555	sub urxvt::destroy_hook(&) {
		556	bless \shift, urxvt::destroy_hook::
530	}	557	}
531		558
532	=head2 The C<urxvt::term> Class	559	=head2 The C<urxvt::term> Class
533		560
534	=over 4	561	=over 4
…		…
574	=cut	601	=cut
575		602
576	sub urxvt::term::resource($$;$) {	603	sub urxvt::term::resource($$;$) {
577	my ($self, $name) = (shift, shift);	604	my ($self, $name) = (shift, shift);
578	unshift @_, $self, $name, ($name =~ s/\s\+\s(\d+)$// ? $1 : 0);	605	unshift @_, $self, $name, ($name =~ s/\s\+\s(\d+)$// ? $1 : 0);
579	goto &urxvt::term::_resource;	606	&urxvt::term::_resource
580	}	607	}
581		608
582	=item $rend = $term->rstyle ([$new_rstyle])	609	=item $rend = $term->rstyle ([$new_rstyle])
583		610
584	Return and optionally change the current rendition. Text that is output by	611	Return and optionally change the current rendition. Text that is output by
…		…
660		687
661	If hidden, display the overlay again.	688	If hidden, display the overlay again.
662		689
663	=back	690	=back
664		691
		692	=item $popup = $term->popup ($event)
		693
		694	Creates a new C<urxvt::popup> object that implements a popup menu. The
		695	C<$event> I<must> be the event causing the menu to pop up (a button event,
		696	currently).
		697
		698	=cut
		699
		700	sub urxvt::term::popup {
		701	my ($self, $event) = @_;
		702
		703	$self->grab ($event->{time}, 1)
		704	or return;
		705
		706	my $popup = bless {
		707	term => $self,
		708	event => $event,
		709	}, urxvt::popup::;
		710
		711	Scalar::Util::weaken $popup->{term};
		712
		713	$self->{_destroy}{$popup} = urxvt::destroy_hook { $popup->{popup}->destroy };
		714	Scalar::Util::weaken $self->{_destroy}{$popup};
		715
		716	$popup
		717	}
		718
665	=item $cellwidth = $term->strwidth $string	719	=item $cellwidth = $term->strwidth ($string)
666		720
667	Returns the number of screen-cells this string would need. Correctly	721	Returns the number of screen-cells this string would need. Correctly
668	accounts for wide and combining characters.	722	accounts for wide and combining characters.
669		723
670	=item $octets = $term->locale_encode $string	724	=item $octets = $term->locale_encode ($string)
671		725
672	Convert the given text string into the corresponding locale encoding.	726	Convert the given text string into the corresponding locale encoding.
673		727
674	=item $string = $term->locale_decode $octets	728	=item $string = $term->locale_decode ($octets)
675		729
676	Convert the given locale-encoded octets into a perl string.	730	Convert the given locale-encoded octets into a perl string.
677		731
678	=item $term->scr_add_lines ($string)	732	=item $term->scr_add_lines ($string)
679		733
…		…
696		750
697	Write the octets given in C<$data> to the tty (i.e. as program input). To	751	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	752	pass characters instead of octets, you should convert your strings first
699	to the locale-specific encoding using C<< $term->locale_encode >>.	753	to the locale-specific encoding using C<< $term->locale_encode >>.
700		754
		755	=item $windowid = $term->parent
		756
		757	Return the window id of the toplevel window.
		758
		759	=item $windowid = $term->vt
		760
		761	Return the window id of the terminal window.
		762
701	=item $window_width = $term->width	763	=item $window_width = $term->width
702		764
703	=item $window_height = $term->height	765	=item $window_height = $term->height
704		766
705	=item $font_width = $term->fwidth	767	=item $font_width = $term->fwidth
…		…
721	=item $nrow_plus_saveLines = $term->total_rows	783	=item $nrow_plus_saveLines = $term->total_rows
722		784
723	=item $lines_in_scrollback = $term->nsaved	785	=item $lines_in_scrollback = $term->nsaved
724		786
725	Return various integers describing terminal characteristics.	787	Return various integers describing terminal characteristics.
		788
		789	=item $modifiermask = $term->ModLevel3Mask
		790
		791	=item $modifiermask = $term->ModMetaMask
		792
		793	=item $modifiermask = $term->ModNumLockMask
		794
		795	Return the modifier masks corresponding to the "ISO Level 3 Shift" (often
		796	AltGr), the meta key (often Alt) and the num lock key, if applicable.
726		797
727	=item $view_start = $term->view_start ([$newvalue])	798	=item $view_start = $term->view_start ([$newvalue])
728		799
729	Returns the negative row number of the topmost line. Minimum value is	800	Returns the negative row number of the topmost line. Minimum value is
730	C<0>, which displays the normal terminal contents. Larger values scroll	801	C<0>, which displays the normal terminal contents. Larger values scroll
…		…
911		982
912	Converts rxvt-unicodes text reprsentation into a perl string. See	983	Converts rxvt-unicodes text reprsentation into a perl string. See
913	C<< $term->ROW_t >> for details.	984	C<< $term->ROW_t >> for details.
914		985
915	=back	986	=back
		987
		988	=head2 The C<urxvt::popup> Class
		989
		990	=over 4
		991
		992	=cut
		993
		994	package urxvt::popup;
		995
		996	sub add_item {
		997	my ($self, $item) = @_;
		998
		999	push @{ $self->{item} }, $item;
		1000	}
		1001
		1002	sub add_button {
		1003	my ($self, $text, $cb) = @_;
		1004
		1005	$self->add_item ({ type => "button", text => "[ $text ]", activate => $cb });
		1006	}
		1007
		1008	sub show {
		1009	my ($self) = @_;
		1010
		1011	local $urxvt::popup::self = $self;
		1012
		1013	urxvt->new ("--perl-lib" => "", "--perl-ext-common" => "", "-pty-fd" => -1, "-sl" => 0, "-b" => 0,
		1014	"--transient-for" => $self->{term}->parent,
		1015	"-pe" => "urxvt-popup")
		1016	or die "unable to create popup window\n";
		1017	}
		1018
		1019	sub DESTROY {
		1020	my ($self) = @_;
		1021
		1022	$self->{term}->ungrab;
		1023	}
916		1024
917	=head2 The C<urxvt::timer> Class	1025	=head2 The C<urxvt::timer> Class
918		1026
919	This class implements timer watchers/events. Time is represented as a	1027	This class implements timer watchers/events. Time is represented as a
920	fractional number of seconds since the epoch. Example:	1028	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.47 by root, Sat Jan 7 21:22:02 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.47 by root, Sat Jan 7 21:22:02 2006 UTC