[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.114 by root, Fri Jan 20 12:16:28 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
…		…
470	C<on_key_press> additionally receives the string rxvt-unicode would	491	C<on_key_press> additionally receives the string rxvt-unicode would
471	output, if any, in locale-specific encoding.	492	output, if any, in locale-specific encoding.
472		493
473	subwindow.	494	subwindow.
474		495
		496	=item on_client_message $term, $event
		497
		498	=item on_wm_protocols $term, $event
		499
		500	=item on_wm_delete_window $term, $event
		501
		502	Called when various types of ClientMessage events are received (all with
		503	format=32, WM_PROTOCOLS or WM_PROTOCOLS:WM_DELETE_WINDOW).
		504
475	=back	505	=back
476		506
477	=cut	507	=cut
478		508
479	package urxvt;	509	package urxvt;
…		…
484	use Scalar::Util ();	514	use Scalar::Util ();
485	use List::Util ();	515	use List::Util ();
486		516
487	our $VERSION = 1;	517	our $VERSION = 1;
488	our $TERM;	518	our $TERM;
		519	our @TERM_INIT;
		520	our @TERM_EXT;
489	our @HOOKNAME;	521	our @HOOKNAME;
490	our %HOOKTYPE = map +($HOOKNAME[$_] => $_), 0..$#HOOKNAME;	522	our %HOOKTYPE = map +($HOOKNAME[$_] => $_), 0..$#HOOKNAME;
491	our %OPTION;	523	our %OPTION;
492		524
493	our $LIBDIR;	525	our $LIBDIR;
…		…
514		546
515	=item $urxvt::TERM	547	=item $urxvt::TERM
516		548
517	The current terminal. This variable stores the current C<urxvt::term>	549	The current terminal. This variable stores the current C<urxvt::term>
518	object, whenever a callback/hook is executing.	550	object, whenever a callback/hook is executing.
		551
		552	=item @urxvt::TERM_INIT
		553
		554	All coderefs in this array will be called as methods of the next newly
		555	created C<urxvt::term> object (during the C<on_init> phase). The array
		556	gets cleared before the codereferences that were in it are being executed,
		557	so coderefs can push themselves onto it again if they so desire.
		558
		559	This complements to the perl-eval commandline option, but gets executed
		560	first.
		561
		562	=item @urxvt::TERM_EXT
		563
		564	Works similar to C<@TERM_INIT>, but contains perl package/class names, which
		565	get registered as normal extensions after calling the hooks in C<@TERM_INIT>
		566	but before other extensions. Gets cleared just like C<@TERM_INIT>.
519		567
520	=back	568	=back
521		569
522	=head2 Functions in the C<urxvt> Package	570	=head2 Functions in the C<urxvt> Package
523		571
…		…
645		693
646	# load a single script into its own package, once only	694	# load a single script into its own package, once only
647	sub extension_package($) {	695	sub extension_package($) {
648	my ($path) = @_;	696	my ($path) = @_;
649		697
650	no strict 'refs';
651
652	$extension_pkg{$path} \|\|= do {	698	$extension_pkg{$path} \|\|= do {
653	$path =~ /([^\/\\]+)$/;	699	$path =~ /([^\/\\]+)$/;
654	my $pkg = $1;	700	my $pkg = $1;
655	$pkg =~ s/[^[:word:]]/_/g;	701	$pkg =~ s/[^[:word:]]/_/g;
656	$pkg = "urxvt::ext::$pkg";	702	$pkg = "urxvt::ext::$pkg";
…		…
658	verbose 3, "loading extension '$path' into package '$pkg'";	704	verbose 3, "loading extension '$path' into package '$pkg'";
659		705
660	open my $fh, "<:raw", $path	706	open my $fh, "<:raw", $path
661	or die "$path: $!";	707	or die "$path: $!";
662		708
663	@{"$pkg\::ISA"} = urxvt::term::extension::;
664
665	my $source =	709	my $source =
666	"package $pkg; use strict; use utf8;\n"	710	"package $pkg; use strict; use utf8;\n"
667	. "#line 1 \"$path\"\n{\n"	711	. "#line 1 \"$path\"\n{\n"
668	. (do { local $/; <$fh> })	712	. (do { local $/; <$fh> })
669	. "\n};\n1";	713	. "\n};\n1";
…		…
685	if ($htype == 0) { # INIT	729	if ($htype == 0) { # INIT
686	my @dirs = ((split /:/, $TERM->resource ("perl_lib")), "$LIBDIR/perl");	730	my @dirs = ((split /:/, $TERM->resource ("perl_lib")), "$LIBDIR/perl");
687		731
688	my %ext_arg;	732	my %ext_arg;
689		733
		734	{
		735	my @init = @TERM_INIT;
		736	@TERM_INIT = ();
		737	$_->($TERM) for @init;
		738	my @pkg = @TERM_EXT;
		739	@TERM_EXT = ();
		740	$TERM->register_package ($_) for @pkg;
		741	}
		742
690	for (map { split /,/, $TERM->resource ("perl_ext_$_") } 1, 2) {	743	for (grep $_, map { split /,/, $TERM->resource ("perl_ext_$_") } 1, 2) {
691	if ($_ eq "default") {	744	if ($_ eq "default") {
692	$ext_arg{$_} \|\|= [] for qw(selection option-popup selection-popup searchable-scrollback);	745	$ext_arg{$_} \|\|= [] for qw(selection option-popup selection-popup searchable-scrollback);
693	} elsif (/^-(.*)$/) {	746	} elsif (/^-(.*)$/) {
694	delete $ext_arg{$1};	747	delete $ext_arg{$1};
695	} elsif (/^([^<]+)<(.*)>$/) {	748	} elsif (/^([^<]+)<(.*)>$/) {
…		…
720	if $verbosity >= 10;	773	if $verbosity >= 10;
721		774
722	keys %$cb;	775	keys %$cb;
723		776
724	while (my ($pkg, $cb) = each %$cb) {	777	while (my ($pkg, $cb) = each %$cb) {
725	$retval = eval { $cb->($TERM->{_pkg}{$pkg}, @_) }	778	my $retval_ = eval { $cb->($TERM->{_pkg}{$pkg}, @_) };
726	and last;	779	$retval \|\|= $retval_;
727		780
728	if ($@) {	781	if ($@) {
729	$TERM->ungrab; # better to lose the grab than the session	782	$TERM->ungrab; # better to lose the grab than the session
730	warn $@;	783	warn $@;
731	}	784	}
…		…
742	# clear package	795	# clear package
743	%$TERM = ();	796	%$TERM = ();
744	}	797	}
745		798
746	$retval	799	$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	}	800	}
760		801
761	# urxvt::term::extension	802	# urxvt::term::extension
762		803
763	package urxvt::term::extension;	804	package urxvt::term::extension;
…		…
902	# find on_xxx subs in the package and register them	943	# find on_xxx subs in the package and register them
903	# as hooks	944	# as hooks
904	sub register_package {	945	sub register_package {
905	my ($self, $pkg, $argv) = @_;	946	my ($self, $pkg, $argv) = @_;
906		947
		948	no strict 'refs';
		949
		950	urxvt::verbose 6, "register package $pkg to $self";
		951
		952	@{"$pkg\::ISA"} = urxvt::term::extension::;
		953
907	my $proxy = bless {	954	my $proxy = bless {
908	_pkg => $pkg,	955	_pkg => $pkg,
909	argv => $argv,	956	argv => $argv,
910	}, $pkg;	957	}, $pkg;
911	Scalar::Util::weaken ($proxy->{term} = $self);	958	Scalar::Util::weaken ($proxy->{term} = $self);
…		…
941	=item $term->destroy	988	=item $term->destroy
942		989
943	Destroy the terminal object (close the window, free resources	990	Destroy the terminal object (close the window, free resources
944	etc.). Please note that @@RXVT_NAME@@ will not exit as long as any event	991	etc.). Please note that @@RXVT_NAME@@ will not exit as long as any event
945	watchers (timers, io watchers) are still active.	992	watchers (timers, io watchers) are still active.
		993
		994	=item $term->exec_async ($cmd[, @args])
		995
		996	Works like the combination of the C<fork>/C<exec> builtins, which executes
		997	("starts") programs in the background. This function takes care of setting
		998	the user environment before exec'ing the command (e.g. C<PATH>) and should
		999	be preferred over explicit calls to C<exec> or C<system>.
		1000
		1001	Returns the pid of the subprocess or C<undef> on error.
		1002
		1003	=cut
		1004
		1005	sub exec_async {
		1006	my $self = shift;
		1007
		1008	my $pid = fork;
		1009
		1010	return $pid
		1011	if !defined $pid or $pid;
		1012
		1013	%ENV = %{ $self->env };
		1014
		1015	exec @_;
		1016	urxvt::_exit 255;
		1017	}
946		1018
947	=item $isset = $term->option ($optval[, $set])	1019	=item $isset = $term->option ($optval[, $set])
948		1020
949	Returns true if the option specified by C<$optval> is enabled, and	1021	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	1022	optionally change it. All option values are stored by name in the hash
…		…
1612	$self->{term}->ungrab;	1684	$self->{term}->ungrab;
1613	}	1685	}
1614		1686
1615	=back	1687	=back
1616		1688
		1689	=cut
		1690
		1691	package urxvt::watcher;
		1692
		1693	@urxvt::timer::ISA = __PACKAGE__;
		1694	@urxvt::iow::ISA = __PACKAGE__;
		1695	@urxvt::pw::ISA = __PACKAGE__;
		1696	@urxvt::iw::ISA = __PACKAGE__;
		1697
1617	=head2 The C<urxvt::timer> Class	1698	=head2 The C<urxvt::timer> Class
1618		1699
1619	This class implements timer watchers/events. Time is represented as a	1700	This class implements timer watchers/events. Time is represented as a
1620	fractional number of seconds since the epoch. Example:	1701	fractional number of seconds since the epoch. Example:
1621		1702
…		…
1718		1799
1719	Stop watching for events on the given filehandle.	1800	Stop watching for events on the given filehandle.
1720		1801
1721	=back	1802	=back
1722		1803
		1804	=head2 The C<urxvt::iw> Class
		1805
		1806	This class implements idle watchers, that get called automatically when
		1807	the process is idle. They should return as fast as possible, after doing
		1808	some useful work.
		1809
		1810	=over 4
		1811
		1812	=item $iw = new urxvt::iw
		1813
		1814	Create a new idle watcher object in stopped state.
		1815
		1816	=item $iw = $iw->cb (sub { my ($iw) = @_; ... })
		1817
		1818	Set the callback to be called when the watcher triggers.
		1819
		1820	=item $timer = $timer->start
		1821
		1822	Start the watcher.
		1823
		1824	=item $timer = $timer->stop
		1825
		1826	Stop the watcher.
		1827
		1828	=back
		1829
		1830	=head2 The C<urxvt::pw> Class
		1831
		1832	This class implements process watchers. They create an event whenever a
		1833	process exits, after which they stop automatically.
		1834
		1835	my $pid = fork;
		1836	...
		1837	$term->{pw} = urxvt::pw
		1838	->new
		1839	->start ($pid)
		1840	->cb (sub {
		1841	my ($pw, $exit_status) = @_;
		1842	...
		1843	});
		1844
		1845	=over 4
		1846
		1847	=item $pw = new urxvt::pw
		1848
		1849	Create a new process watcher in stopped state.
		1850
		1851	=item $pw = $pw->cb (sub { my ($pw, $exit_status) = @_; ... })
		1852
		1853	Set the callback to be called when the timer triggers.
		1854
		1855	=item $pw = $timer->start ($pid)
		1856
		1857	Tells the wqtcher to start watching for process C<$pid>.
		1858
		1859	=item $pw = $pw->stop
		1860
		1861	Stop the watcher.
		1862
		1863	=back
		1864
1723	=head1 ENVIRONMENT	1865	=head1 ENVIRONMENT
1724		1866
1725	=head2 URXVT_PERL_VERBOSITY	1867	=head2 URXVT_PERL_VERBOSITY
1726		1868
1727	This variable controls the verbosity level of the perl extension. Higher	1869	This variable controls the verbosity level of the perl extension. Higher

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.114 by root, Fri Jan 20 12:16:28 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.114 by root, Fri Jan 20 12:16:28 2006 UTC