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

Comparing rxvt-unicode/src/urxvt.pm (file contents):
Revision 1.107 by root, Wed Jan 18 21:30:50 2006 UTC vs.
Revision 1.113 by root, Fri Jan 20 10:27:08 2006 UTC

…		…
34	find them in F<@@RXVT_LIBDIR@@/urxvt/perl/>.	34	find them in F<@@RXVT_LIBDIR@@/urxvt/perl/>.
35		35
36	You can activate them like this:	36	You can activate them like this:
37		37
38	@@RXVT_NAME@@ -pe <extensionname>	38	@@RXVT_NAME@@ -pe <extensionname>
		39
		40	Or by adding them to the resource for extensions loaded by default:
		41
		42	URxvt.perl-ext-common: default,automove-background,selection-autotransform
39		43
40	=over 4	44	=over 4
41		45
42	=item selection (enabled by default)	46	=item selection (enabled by default)
43		47
…		…
89		93
90	Binds a popup menu to Ctrl-Button3 that lets you convert the selection	94	Binds a popup menu to Ctrl-Button3 that lets you convert the selection
91	text into various other formats/action (such as uri unescaping, perl	95	text into various other formats/action (such as uri unescaping, perl
92	evalution, web-browser starting etc.), depending on content.	96	evalution, web-browser starting etc.), depending on content.
93		97
94	Other extensions can extend this popup menu by pushing a code reference onto	98	Other extensions can extend this popup menu by pushing a code reference
95	C<@urxvt::ext::selection_popup::hook>, that is called whenever the popup is displayed.	99	onto C<@{ $term->{selection_popup_hook} }>, that is called whenever the
		100	popup is displayed.
96		101
97	It's sole argument is the popup menu, which can be modified. The selection	102	It's sole argument is the popup menu, which can be modified. The selection
98	is in C<$_>, which can be used to decide wether to add something or not.	103	is in C<$_>, which can be used to decide wether to add something or not.
99	It should either return nothing or a string and a code reference. The	104	It should either return nothing or a string and a code reference. The
100	string will be used as button text and the code reference will be called	105	string will be used as button text and the code reference will be called
…		…
102		107
103	The following will add an entry C<a to b> that transforms all C<a>s in	108	The following will add an entry C<a to b> that transforms all C<a>s in
104	the selection to C<b>s, but only if the selection currently contains any	109	the selection to C<b>s, but only if the selection currently contains any
105	C<a>s:	110	C<a>s:
106		111
107	push urxvt::ext::selection_popup::hook, sub {	112	push @{ $self->{term}{selection_popup_hook} }, sub {
108	/a/ ? ("a to be" => sub { s/a/b/g }	113	/a/ ? ("a to be" => sub { s/a/b/g }
109	: ()	114	: ()
110	};	115	};
111		116
112	=item searchable-scrollback<hotkey> (enabled by default)	117	=item searchable-scrollback<hotkey> (enabled by default)
…		…
143	URxvt.selection-autotransform.0: s/^([^:[:space:]]+):(\\d+):?$/vi +$2 \\Q$1\\E\\x0d/	148	URxvt.selection-autotransform.0: s/^([^:[:space:]]+):(\\d+):?$/vi +$2 \\Q$1\\E\\x0d/
144		149
145	And this example matches the same,but replaces it with vi-commands you can	150	And this example matches the same,but replaces it with vi-commands you can
146	paste directly into your (vi :) editor:	151	paste directly into your (vi :) editor:
147		152
148	URxvt.selection-autotransform.0: s/^([^:[:space:]]+(\\d+):?$/\\x1b:e \\Q$1\\E\\x0d:$2\\x0d/	153	URxvt.selection-autotransform.0: s/^([^:[:space:]]+(\\d+):?$/:e \\Q$1\\E\\x0d:$2\\x0d/
149		154
150	Of course, this can be modified to suit your needs and your editor :)	155	Of course, this can be modified to suit your needs and your editor :)
151		156
152	To expand the example above to typical perl error messages ("XXX at	157	To expand the example above to typical perl error messages ("XXX at
153	FILENAME line YYY."), you need a slightly more elaborate solution:	158	FILENAME line YYY."), you need a slightly more elaborate solution:
154		159
155	URxvt.selection.pattern-0: ( at .*? line \\d+\\.)	160	URxvt.selection.pattern-0: ( at .*? line \\d+[,.])
156	URxvt.selection-autotransform.0: s/^ at (.*?) line (\\d+)\\.$/\x1b:e \\Q$1\E\\x0d:$2\\x0d/	161	URxvt.selection-autotransform.0: s/^ at (.*?) line (\\d+)[,.]$/:e \\Q$1\E\\x0d:$2\\x0d/
157		162
158	The first line tells the selection code to treat the unchanging part of	163	The first line tells the selection code to treat the unchanging part of
159	every error message as a selection pattern, and the second line transforms	164	every error message as a selection pattern, and the second line transforms
160	the message into vi commands to load the file.	165	the message into vi commands to load the file.
161		166
…		…
298	called whenever the relevant event happens.	303	called whenever the relevant event happens.
299		304
300	The first argument passed to them is an extension oject as described in	305	The first argument passed to them is an extension oject as described in
301	the in the C<Extension Objects> section.	306	the in the C<Extension Objects> section.
302		307
303	B<All> of these hooks must return a boolean value. If it is true, then the	308	B<All> of these hooks must return a boolean value. If any of the called
304	event counts as being I<consumed>, and the invocation of other hooks is	309	hooks returns true, then the event counts as being I<consumed>, and the
305	skipped, and the relevant action might not be carried out by the C++ code.	310	relevant action might not be carried out by the C++ code.
306		311
307	I<< When in doubt, return a false value (preferably C<()>). >>	312	I<< When in doubt, return a false value (preferably C<()>). >>
308		313
309	=over 4	314	=over 4
310		315
311	=item on_init $term	316	=item on_init $term
312		317
313	Called after a new terminal object has been initialized, but before	318	Called after a new terminal object has been initialized, but before
314	windows are created or the command gets run. Most methods are unsafe to	319	windows are created or the command gets run. Most methods are unsafe to
315	call or deliver senseless data, as terminal size and other characteristics	320	call or deliver senseless data, as terminal size and other characteristics
316	have not yet been determined. You can safely query and change resources,	321	have not yet been determined. You can safely query and change resources
317	though.	322	and options, though. For many purposes the C<on_start> hook is a better
		323	place.
		324
		325	=item on_start $term
		326
		327	Called at the very end of initialisation of a new terminal, just before
		328	trying to map (display) the toplevel and returning to the mainloop.
		329
		330	=item on_destroy $term
		331
		332	Called whenever something tries to destroy terminal, before doing anything
		333	yet. If this hook returns true, then destruction is skipped, but this is
		334	rarely a good idea.
318		335
319	=item on_reset $term	336	=item on_reset $term
320		337
321	Called after the screen is "reset" for any reason, such as resizing or	338	Called after the screen is "reset" for any reason, such as resizing or
322	control sequences. Here is where you can react on changes to size-related	339	control sequences. Here is where you can react on changes to size-related
323	variables.	340	variables.
324		341
325	=item on_start $term	342	=item on_child_start $term, $pid
326		343
327	Called at the very end of initialisation of a new terminal, just before	344	Called just after the child process has been C<fork>ed.
328	returning to the mainloop.	345
		346	=item on_child_exit $term, $status
		347
		348	Called just after the child process has exited. C<$status> is the status
		349	from C<waitpid>.
329		350
330	=item on_sel_make $term, $eventtime	351	=item on_sel_make $term, $eventtime
331		352
332	Called whenever a selection has been made by the user, but before the	353	Called whenever a selection has been made by the user, but before the
333	selection text is copied, so changes to the beginning, end or type of the	354	selection text is copied, so changes to the beginning, end or type of the
…		…
484	use Scalar::Util ();	505	use Scalar::Util ();
485	use List::Util ();	506	use List::Util ();
486		507
487	our $VERSION = 1;	508	our $VERSION = 1;
488	our $TERM;	509	our $TERM;
		510	our @TERM_INIT;
		511	our @TERM_EXT;
489	our @HOOKNAME;	512	our @HOOKNAME;
490	our %HOOKTYPE = map +($HOOKNAME[$_] => $_), 0..$#HOOKNAME;	513	our %HOOKTYPE = map +($HOOKNAME[$_] => $_), 0..$#HOOKNAME;
491	our %OPTION;	514	our %OPTION;
492		515
493	our $LIBDIR;	516	our $LIBDIR;
…		…
514		537
515	=item $urxvt::TERM	538	=item $urxvt::TERM
516		539
517	The current terminal. This variable stores the current C<urxvt::term>	540	The current terminal. This variable stores the current C<urxvt::term>
518	object, whenever a callback/hook is executing.	541	object, whenever a callback/hook is executing.
		542
		543	=item @urxvt::TERM_INIT
		544
		545	All coderefs in this array will be called as methods of the next newly
		546	created C<urxvt::term> object (during the C<on_init> phase). The array
		547	gets cleared before the codereferences that were in it are being executed,
		548	so coderefs can push themselves onto it again if they so desire.
		549
		550	This complements to the perl-eval commandline option, but gets executed
		551	first.
		552
		553	=item @urxvt::TERM_EXT
		554
		555	Works similar to C<@TERM_INIT>, but contains perl package/class names, which
		556	get registered as normal extensions after calling the hooks in C<@TERM_INIT>
		557	but before other extensions. Gets cleared just like C<@TERM_INIT>.
519		558
520	=back	559	=back
521		560
522	=head2 Functions in the C<urxvt> Package	561	=head2 Functions in the C<urxvt> Package
523		562
…		…
645		684
646	# load a single script into its own package, once only	685	# load a single script into its own package, once only
647	sub extension_package($) {	686	sub extension_package($) {
648	my ($path) = @_;	687	my ($path) = @_;
649		688
650	no strict 'refs';
651
652	$extension_pkg{$path} \|\|= do {	689	$extension_pkg{$path} \|\|= do {
653	$path =~ /([^\/\\]+)$/;	690	$path =~ /([^\/\\]+)$/;
654	my $pkg = $1;	691	my $pkg = $1;
655	$pkg =~ s/[^[:word:]]/_/g;	692	$pkg =~ s/[^[:word:]]/_/g;
656	$pkg = "urxvt::ext::$pkg";	693	$pkg = "urxvt::ext::$pkg";
…		…
658	verbose 3, "loading extension '$path' into package '$pkg'";	695	verbose 3, "loading extension '$path' into package '$pkg'";
659		696
660	open my $fh, "<:raw", $path	697	open my $fh, "<:raw", $path
661	or die "$path: $!";	698	or die "$path: $!";
662		699
663	@{"$pkg\::ISA"} = urxvt::term::extension::;
664
665	my $source =	700	my $source =
666	"package $pkg; use strict; use utf8;\n"	701	"package $pkg; use strict; use utf8;\n"
667	. "#line 1 \"$path\"\n{\n"	702	. "#line 1 \"$path\"\n{\n"
668	. (do { local $/; <$fh> })	703	. (do { local $/; <$fh> })
669	. "\n};\n1";	704	. "\n};\n1";
…		…
685	if ($htype == 0) { # INIT	720	if ($htype == 0) { # INIT
686	my @dirs = ((split /:/, $TERM->resource ("perl_lib")), "$LIBDIR/perl");	721	my @dirs = ((split /:/, $TERM->resource ("perl_lib")), "$LIBDIR/perl");
687		722
688	my %ext_arg;	723	my %ext_arg;
689		724
		725	{
		726	my @init = @TERM_INIT;
		727	@TERM_INIT = ();
		728	$_->($TERM) for @init;
		729	my @pkg = @TERM_EXT;
		730	@TERM_EXT = ();
		731	$TERM->register_package ($_) for @pkg;
		732	}
		733
690	for (map { split /,/, $TERM->resource ("perl_ext_$_") } 1, 2) {	734	for (grep $_, map { split /,/, $TERM->resource ("perl_ext_$_") } 1, 2) {
691	if ($_ eq "default") {	735	if ($_ eq "default") {
692	$ext_arg{$_} \|\|= [] for qw(selection option-popup selection-popup searchable-scrollback);	736	$ext_arg{$_} \|\|= [] for qw(selection option-popup selection-popup searchable-scrollback);
693	} elsif (/^-(.*)$/) {	737	} elsif (/^-(.*)$/) {
694	delete $ext_arg{$1};	738	delete $ext_arg{$1};
695	} elsif (/^([^<]+)<(.*)>$/) {	739	} elsif (/^([^<]+)<(.*)>$/) {
…		…
720	if $verbosity >= 10;	764	if $verbosity >= 10;
721		765
722	keys %$cb;	766	keys %$cb;
723		767
724	while (my ($pkg, $cb) = each %$cb) {	768	while (my ($pkg, $cb) = each %$cb) {
725	$retval = eval { $cb->($TERM->{_pkg}{$pkg}, @_) }	769	my $retval_ = eval { $cb->($TERM->{_pkg}{$pkg}, @_) };
726	and last;	770	$retval \|\|= $retval_;
727		771
728	if ($@) {	772	if ($@) {
729	$TERM->ungrab; # better to lose the grab than the session	773	$TERM->ungrab; # better to lose the grab than the session
730	warn $@;	774	warn $@;
731	}	775	}
…		…
742	# clear package	786	# clear package
743	%$TERM = ();	787	%$TERM = ();
744	}	788	}
745		789
746	$retval	790	$retval
747	}
748
749	sub exec_async(@) {
750	my $pid = fork;
751
752	return
753	if !defined $pid or $pid;
754
755	%ENV = %{ $TERM->env };
756
757	exec @_;
758	_exit 255;
759	}	791	}
760		792
761	# urxvt::term::extension	793	# urxvt::term::extension
762		794
763	package urxvt::term::extension;	795	package urxvt::term::extension;
…		…
902	# find on_xxx subs in the package and register them	934	# find on_xxx subs in the package and register them
903	# as hooks	935	# as hooks
904	sub register_package {	936	sub register_package {
905	my ($self, $pkg, $argv) = @_;	937	my ($self, $pkg, $argv) = @_;
906		938
		939	no strict 'refs';
		940
		941	urxvt::verbose 6, "register package $pkg to $self";
		942
		943	@{"$pkg\::ISA"} = urxvt::term::extension::;
		944
907	my $proxy = bless {	945	my $proxy = bless {
908	_pkg => $pkg,	946	_pkg => $pkg,
909	argv => $argv,	947	argv => $argv,
910	}, $pkg;	948	}, $pkg;
911	Scalar::Util::weaken ($proxy->{term} = $self);	949	Scalar::Util::weaken ($proxy->{term} = $self);
…		…
941	=item $term->destroy	979	=item $term->destroy
942		980
943	Destroy the terminal object (close the window, free resources	981	Destroy the terminal object (close the window, free resources
944	etc.). Please note that @@RXVT_NAME@@ will not exit as long as any event	982	etc.). Please note that @@RXVT_NAME@@ will not exit as long as any event
945	watchers (timers, io watchers) are still active.	983	watchers (timers, io watchers) are still active.
		984
		985	=item $term->exec_async ($cmd[, @args])
		986
		987	Works like the combination of the C<fork>/C<exec> builtins, which executes
		988	("starts") programs in the background. This function takes care of setting
		989	the user environment before exec'ing the command (e.g. C<PATH>) and should
		990	be preferred over explicit calls to C<exec> or C<system>.
		991
		992	Returns the pid of the subprocess or C<undef> on error.
		993
		994	=cut
		995
		996	sub exec_async {
		997	my $self = shift;
		998
		999	my $pid = fork;
		1000
		1001	return $pid
		1002	if !defined $pid or $pid;
		1003
		1004	%ENV = %{ $self->env };
		1005
		1006	exec @_;
		1007	urxvt::_exit 255;
		1008	}
946		1009
947	=item $isset = $term->option ($optval[, $set])	1010	=item $isset = $term->option ($optval[, $set])
948		1011
949	Returns true if the option specified by C<$optval> is enabled, and	1012	Returns true if the option specified by C<$optval> is enabled, and
950	optionally change it. All option values are stored by name in the hash	1013	optionally change it. All option values are stored by name in the hash
…		…
1612	$self->{term}->ungrab;	1675	$self->{term}->ungrab;
1613	}	1676	}
1614		1677
1615	=back	1678	=back
1616		1679
		1680	=cut
		1681
		1682	package urxvt::watcher;
		1683
		1684	@urxvt::timer::ISA = __PACKAGE__;
		1685	@urxvt::iow::ISA = __PACKAGE__;
		1686	@urxvt::pw::ISA = __PACKAGE__;
		1687	@urxvt::iw::ISA = __PACKAGE__;
		1688
1617	=head2 The C<urxvt::timer> Class	1689	=head2 The C<urxvt::timer> Class
1618		1690
1619	This class implements timer watchers/events. Time is represented as a	1691	This class implements timer watchers/events. Time is represented as a
1620	fractional number of seconds since the epoch. Example:	1692	fractional number of seconds since the epoch. Example:
1621		1693

Diff Legend

-–
+Removed lines
-+
+Added lines
-<
+Changed lines
->
+Changed lines

Comparing rxvt-unicode/src/urxvt.pm (file contents): Revision 1.107 by root, Wed Jan 18 21:30:50 2006 UTC vs. Revision 1.113 by root, Fri Jan 20 10:27:08 2006 UTC

Diff Legend

Comparing rxvt-unicode/src/urxvt.pm (file contents):
Revision 1.107 by root, Wed Jan 18 21:30:50 2006 UTC vs.
Revision 1.113 by root, Fri Jan 20 10:27:08 2006 UTC