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

Comparing rxvt-unicode/src/urxvt.pm (file contents):
Revision 1.112 by root, Thu Jan 19 21:02:06 2006 UTC vs.
Revision 1.119 by root, Fri Jan 20 18:59:31 2006 UTC

…		…
91		91
92	=item selection-popup (enabled by default)	92	=item selection-popup (enabled by default)
93		93
94	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
95	text into various other formats/action (such as uri unescaping, perl	95	text into various other formats/action (such as uri unescaping, perl
96	evalution, web-browser starting etc.), depending on content.	96	evaluation, web-browser starting etc.), depending on content.
97		97
98	Other extensions can extend this popup menu by pushing a code reference	98	Other extensions can extend this popup menu by pushing a code reference
99	onto C<@{ $term->{selection_popup_hook} }>, that is called whenever the	99	onto C<@{ $term->{selection_popup_hook} }>, that is called whenever the
100	popup is displayed.	100	popup is displayed.
101		101
…		…
162		162
163	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
164	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
165	the message into vi commands to load the file.	165	the message into vi commands to load the file.
166		166
		167	=item tabbed
		168
		169	This transforms the terminal into a tabbar with additional terminals, that
		170	is, it implements what is commonly refered to as "tabbed terminal". The topmost line
		171	displays a "[NEW]" button, which, when clicked, will add a new tab, followed by one
		172	button per tab.
		173
		174	Clicking a button will activate that tab. Pressing B<Shift-Left> and
		175	B<Shift-Right> will switch to the tab left or right of the current one,
		176	while B<Shift-Down> creates a new tab.
		177
167	=item mark-urls	178	=item mark-urls
168		179
169	Uses per-line display filtering (C<on_line_update>) to underline urls and	180	Uses per-line display filtering (C<on_line_update>) to underline urls and
170	make them clickable. When middle-clicked, the program specified in the	181	make them clickable. When middle-clicked, the program specified in the
171	resource C<urlLauncher> (default C<x-www-browser>) will be started with	182	resource C<urlLauncher> (default C<x-www-browser>) will be started with
…		…
323	place.	334	place.
324		335
325	=item on_start $term	336	=item on_start $term
326		337
327	Called at the very end of initialisation of a new terminal, just before	338	Called at the very end of initialisation of a new terminal, just before
328	returning to the mainloop.	339	trying to map (display) the toplevel and returning to the mainloop.
		340
		341	=item on_destroy $term
		342
		343	Called whenever something tries to destroy terminal, before doing anything
		344	yet. If this hook returns true, then destruction is skipped, but this is
		345	rarely a good idea.
329		346
330	=item on_reset $term	347	=item on_reset $term
331		348
332	Called after the screen is "reset" for any reason, such as resizing or	349	Called after the screen is "reset" for any reason, such as resizing or
333	control sequences. Here is where you can react on changes to size-related	350	control sequences. Here is where you can react on changes to size-related
…		…
459	Called wheneever the window loses keyboard focus, before rxvt-unicode does	476	Called wheneever the window loses keyboard focus, before rxvt-unicode does
460	focus out processing.	477	focus out processing.
461		478
462	=item on_configure_notify $term, $event	479	=item on_configure_notify $term, $event
463		480
		481	=item on_property_notify $term, $event
		482
464	=item on_key_press $term, $event, $keysym, $octets	483	=item on_key_press $term, $event, $keysym, $octets
465		484
466	=item on_key_release $term, $event, $keysym	485	=item on_key_release $term, $event, $keysym
467		486
468	=item on_button_press $term, $event	487	=item on_button_press $term, $event
…		…
484		503
485	C<on_key_press> additionally receives the string rxvt-unicode would	504	C<on_key_press> additionally receives the string rxvt-unicode would
486	output, if any, in locale-specific encoding.	505	output, if any, in locale-specific encoding.
487		506
488	subwindow.	507	subwindow.
		508
		509	=item on_client_message $term, $event
		510
		511	=item on_wm_protocols $term, $event
		512
		513	=item on_wm_delete_window $term, $event
		514
		515	Called when various types of ClientMessage events are received (all with
		516	format=32, WM_PROTOCOLS or WM_PROTOCOLS:WM_DELETE_WINDOW).
489		517
490	=back	518	=back
491		519
492	=cut	520	=cut
493		521
…		…
499	use Scalar::Util ();	527	use Scalar::Util ();
500	use List::Util ();	528	use List::Util ();
501		529
502	our $VERSION = 1;	530	our $VERSION = 1;
503	our $TERM;	531	our $TERM;
		532	our @TERM_INIT;
		533	our @TERM_EXT;
504	our @HOOKNAME;	534	our @HOOKNAME;
505	our %HOOKTYPE = map +($HOOKNAME[$_] => $_), 0..$#HOOKNAME;	535	our %HOOKTYPE = map +($HOOKNAME[$_] => $_), 0..$#HOOKNAME;
506	our %OPTION;	536	our %OPTION;
507		537
508	our $LIBDIR;	538	our $LIBDIR;
…		…
529		559
530	=item $urxvt::TERM	560	=item $urxvt::TERM
531		561
532	The current terminal. This variable stores the current C<urxvt::term>	562	The current terminal. This variable stores the current C<urxvt::term>
533	object, whenever a callback/hook is executing.	563	object, whenever a callback/hook is executing.
		564
		565	=item @urxvt::TERM_INIT
		566
		567	All coderefs in this array will be called as methods of the next newly
		568	created C<urxvt::term> object (during the C<on_init> phase). The array
		569	gets cleared before the codereferences that were in it are being executed,
		570	so coderefs can push themselves onto it again if they so desire.
		571
		572	This complements to the perl-eval commandline option, but gets executed
		573	first.
		574
		575	=item @urxvt::TERM_EXT
		576
		577	Works similar to C<@TERM_INIT>, but contains perl package/class names, which
		578	get registered as normal extensions after calling the hooks in C<@TERM_INIT>
		579	but before other extensions. Gets cleared just like C<@TERM_INIT>.
534		580
535	=back	581	=back
536		582
537	=head2 Functions in the C<urxvt> Package	583	=head2 Functions in the C<urxvt> Package
538		584
…		…
660		706
661	# load a single script into its own package, once only	707	# load a single script into its own package, once only
662	sub extension_package($) {	708	sub extension_package($) {
663	my ($path) = @_;	709	my ($path) = @_;
664		710
665	no strict 'refs';
666
667	$extension_pkg{$path} \|\|= do {	711	$extension_pkg{$path} \|\|= do {
668	$path =~ /([^\/\\]+)$/;	712	$path =~ /([^\/\\]+)$/;
669	my $pkg = $1;	713	my $pkg = $1;
670	$pkg =~ s/[^[:word:]]/_/g;	714	$pkg =~ s/[^[:word:]]/_/g;
671	$pkg = "urxvt::ext::$pkg";	715	$pkg = "urxvt::ext::$pkg";
…		…
673	verbose 3, "loading extension '$path' into package '$pkg'";	717	verbose 3, "loading extension '$path' into package '$pkg'";
674		718
675	open my $fh, "<:raw", $path	719	open my $fh, "<:raw", $path
676	or die "$path: $!";	720	or die "$path: $!";
677		721
678	@{"$pkg\::ISA"} = urxvt::term::extension::;
679
680	my $source =	722	my $source =
681	"package $pkg; use strict; use utf8;\n"	723	"package $pkg; use strict; use utf8;\n"
682	. "#line 1 \"$path\"\n{\n"	724	. "#line 1 \"$path\"\n{\n"
683	. (do { local $/; <$fh> })	725	. (do { local $/; <$fh> })
684	. "\n};\n1";	726	. "\n};\n1";
…		…
700	if ($htype == 0) { # INIT	742	if ($htype == 0) { # INIT
701	my @dirs = ((split /:/, $TERM->resource ("perl_lib")), "$LIBDIR/perl");	743	my @dirs = ((split /:/, $TERM->resource ("perl_lib")), "$LIBDIR/perl");
702		744
703	my %ext_arg;	745	my %ext_arg;
704		746
		747	{
		748	my @init = @TERM_INIT;
		749	@TERM_INIT = ();
		750	$_->($TERM) for @init;
		751	my @pkg = @TERM_EXT;
		752	@TERM_EXT = ();
		753	$TERM->register_package ($_) for @pkg;
		754	}
		755
705	for (map { split /,/, $TERM->resource ("perl_ext_$_") } 1, 2) {	756	for (grep $_, map { split /,/, $TERM->resource ("perl_ext_$_") } 1, 2) {
706	if ($_ eq "default") {	757	if ($_ eq "default") {
707	$ext_arg{$_} \|\|= [] for qw(selection option-popup selection-popup searchable-scrollback);	758	$ext_arg{$_} \|\|= [] for qw(selection option-popup selection-popup searchable-scrollback);
708	} elsif (/^-(.*)$/) {	759	} elsif (/^-(.*)$/) {
709	delete $ext_arg{$1};	760	delete $ext_arg{$1};
710	} elsif (/^([^<]+)<(.*)>$/) {	761	} elsif (/^([^<]+)<(.*)>$/) {
…		…
735	if $verbosity >= 10;	786	if $verbosity >= 10;
736		787
737	keys %$cb;	788	keys %$cb;
738		789
739	while (my ($pkg, $cb) = each %$cb) {	790	while (my ($pkg, $cb) = each %$cb) {
740	$retval \|\|= eval { $cb->($TERM->{_pkg}{$pkg}, @_) };	791	my $retval_ = eval { $cb->($TERM->{_pkg}{$pkg}, @_) };
		792	$retval \|\|= $retval_;
741		793
742	if ($@) {	794	if ($@) {
743	$TERM->ungrab; # better to lose the grab than the session	795	$TERM->ungrab; # better to lose the grab than the session
744	warn $@;	796	warn $@;
745	}	797	}
…		…
903		955
904	# find on_xxx subs in the package and register them	956	# find on_xxx subs in the package and register them
905	# as hooks	957	# as hooks
906	sub register_package {	958	sub register_package {
907	my ($self, $pkg, $argv) = @_;	959	my ($self, $pkg, $argv) = @_;
		960
		961	no strict 'refs';
		962
		963	urxvt::verbose 6, "register package $pkg to $self";
		964
		965	@{"$pkg\::ISA"} = urxvt::term::extension::;
908		966
909	my $proxy = bless {	967	my $proxy = bless {
910	_pkg => $pkg,	968	_pkg => $pkg,
911	argv => $argv,	969	argv => $argv,
912	}, $pkg;	970	}, $pkg;
…		…
1510		1568
1511	Calls XUngrab for the most recent grab. Is called automatically on	1569	Calls XUngrab for the most recent grab. Is called automatically on
1512	evaluation errors, as it is better to lose the grab in the error case as	1570	evaluation errors, as it is better to lose the grab in the error case as
1513	the session.	1571	the session.
1514		1572
		1573	=item $atom = $term->XInternAtom ($atom_name[, $only_if_exists])
		1574
		1575	=item $atom_name = $term->XGetAtomName ($atom)
		1576
		1577	=item @atoms = $term->XListProperties ($window)
		1578
		1579	=item ($type,$format,$octets) = $term->XGetWindowProperty ($window, $property)
		1580
		1581	=item $term->XChangeWindowProperty ($window, $property, $type, $format, $octets)
		1582
		1583	=item $term->XDeleteProperty ($window, $property)
		1584
		1585	=item $window = $term->DefaultRootWindow
		1586
		1587	=item $term->XReparentWindow ($window, $parent, [$x, $y])
		1588
		1589	=item $term->XMapWindow ($window)
		1590
		1591	=item $term->XUnmapWindow ($window)
		1592
		1593	=item $term->XMoveResizeWindow ($window, $x, $y, $width, $height)
		1594
		1595	=item ($x, $y, $child_window) = $term->XTranslateCoordinates ($src, $dst, $x, $y)
		1596
		1597	=item $term->XChangeInput ($window, $add_events[, $del_events])
		1598
		1599	Various X or X-related functions. The C<$term> object only serves as
		1600	the source of the display, otherwise those functions map more-or-less
		1601	directory onto the X functions of the same name.
		1602
1515	=back	1603	=back
1516		1604
1517	=cut	1605	=cut
1518		1606
1519	package urxvt::popup;	1607	package urxvt::popup;
…		…
1638	delete $self->{term}{_destroy}{$self};	1726	delete $self->{term}{_destroy}{$self};
1639	$self->{term}->ungrab;	1727	$self->{term}->ungrab;
1640	}	1728	}
1641		1729
1642	=back	1730	=back
		1731
		1732	=cut
		1733
		1734	package urxvt::watcher;
		1735
		1736	@urxvt::timer::ISA = __PACKAGE__;
		1737	@urxvt::iow::ISA = __PACKAGE__;
		1738	@urxvt::pw::ISA = __PACKAGE__;
		1739	@urxvt::iw::ISA = __PACKAGE__;
1643		1740
1644	=head2 The C<urxvt::timer> Class	1741	=head2 The C<urxvt::timer> Class
1645		1742
1646	This class implements timer watchers/events. Time is represented as a	1743	This class implements timer watchers/events. Time is represented as a
1647	fractional number of seconds since the epoch. Example:	1744	fractional number of seconds since the epoch. Example:
…		…
1745		1842
1746	Stop watching for events on the given filehandle.	1843	Stop watching for events on the given filehandle.
1747		1844
1748	=back	1845	=back
1749		1846
		1847	=head2 The C<urxvt::iw> Class
		1848
		1849	This class implements idle watchers, that get called automatically when
		1850	the process is idle. They should return as fast as possible, after doing
		1851	some useful work.
		1852
		1853	=over 4
		1854
		1855	=item $iw = new urxvt::iw
		1856
		1857	Create a new idle watcher object in stopped state.
		1858
		1859	=item $iw = $iw->cb (sub { my ($iw) = @_; ... })
		1860
		1861	Set the callback to be called when the watcher triggers.
		1862
		1863	=item $timer = $timer->start
		1864
		1865	Start the watcher.
		1866
		1867	=item $timer = $timer->stop
		1868
		1869	Stop the watcher.
		1870
		1871	=back
		1872
		1873	=head2 The C<urxvt::pw> Class
		1874
		1875	This class implements process watchers. They create an event whenever a
		1876	process exits, after which they stop automatically.
		1877
		1878	my $pid = fork;
		1879	...
		1880	$term->{pw} = urxvt::pw
		1881	->new
		1882	->start ($pid)
		1883	->cb (sub {
		1884	my ($pw, $exit_status) = @_;
		1885	...
		1886	});
		1887
		1888	=over 4
		1889
		1890	=item $pw = new urxvt::pw
		1891
		1892	Create a new process watcher in stopped state.
		1893
		1894	=item $pw = $pw->cb (sub { my ($pw, $exit_status) = @_; ... })
		1895
		1896	Set the callback to be called when the timer triggers.
		1897
		1898	=item $pw = $timer->start ($pid)
		1899
		1900	Tells the wqtcher to start watching for process C<$pid>.
		1901
		1902	=item $pw = $pw->stop
		1903
		1904	Stop the watcher.
		1905
		1906	=back
		1907
1750	=head1 ENVIRONMENT	1908	=head1 ENVIRONMENT
1751		1909
1752	=head2 URXVT_PERL_VERBOSITY	1910	=head2 URXVT_PERL_VERBOSITY
1753		1911
1754	This variable controls the verbosity level of the perl extension. Higher	1912	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.112 by root, Thu Jan 19 21:02:06 2006 UTC vs. Revision 1.119 by root, Fri Jan 20 18:59:31 2006 UTC

Diff Legend

Comparing rxvt-unicode/src/urxvt.pm (file contents):
Revision 1.112 by root, Thu Jan 19 21:02:06 2006 UTC vs.
Revision 1.119 by root, Fri Jan 20 18:59:31 2006 UTC