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

Comparing rxvt-unicode/src/urxvt.pm (file contents):
Revision 1.101 by root, Wed Jan 18 10:11:03 2006 UTC vs.
Revision 1.129 by root, Wed Jan 25 15:11:31 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
…		…
63	the match. For example, the followign adds a regex that matches everything	67	the match. For example, the followign adds a regex that matches everything
64	between two vertical bars:	68	between two vertical bars:
65		69
66	URxvt.selection.pattern-0: \\\|([^\|]+)\\\|	70	URxvt.selection.pattern-0: \\\|([^\|]+)\\\|
67		71
		72	Another example: Programs I use often output "absolute path: " at the
		73	beginning of a line when they process multiple files. The following
		74	pattern matches the filename (note, there is a single space at the very
		75	end):
		76
		77	URxvt.selection.pattern-0: ^(/[^:]+):\
		78
68	You can look at the source of the selection extension to see more	79	You can look at the source of the selection extension to see more
69	interesting uses, such as parsing a line from beginning to end.	80	interesting uses, such as parsing a line from beginning to end.
70		81
71	This extension also offers following bindable keyboard commands:	82	This extension also offers following bindable keyboard commands:
72		83
…		…
87		98
88	=item selection-popup (enabled by default)	99	=item selection-popup (enabled by default)
89		100
90	Binds a popup menu to Ctrl-Button3 that lets you convert the selection	101	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	102	text into various other formats/action (such as uri unescaping, perl
92	evalution, web-browser starting etc.), depending on content.	103	evaluation, web-browser starting etc.), depending on content.
93		104
94	Other extensions can extend this popup menu by pushing a code reference onto	105	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.	106	onto C<@{ $term->{selection_popup_hook} }>, that is called whenever the
		107	popup is displayed.
96		108
97	It's sole argument is the popup menu, which can be modified. The selection	109	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.	110	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	111	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	112	string will be used as button text and the code reference will be called
…		…
102		114
103	The following will add an entry C<a to b> that transforms all C<a>s in	115	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	116	the selection to C<b>s, but only if the selection currently contains any
105	C<a>s:	117	C<a>s:
106		118
107	push urxvt::ext::selection_popup::hook, sub {	119	push @{ $self->{term}{selection_popup_hook} }, sub {
108	/a/ ? ("a to be" => sub { s/a/b/g }	120	/a/ ? ("a to be" => sub { s/a/b/g }
109	: ()	121	: ()
110	};	122	};
111		123
112	=item searchable-scrollback<hotkey> (enabled by default)	124	=item searchable-scrollback<hotkey> (enabled by default)
…		…
122	bottom. C<Escape> leaves search mode and returns to the point where search	134	bottom. C<Escape> leaves search mode and returns to the point where search
123	was started, while C<Enter> or C<Return> stay at the current position and	135	was started, while C<Enter> or C<Return> stay at the current position and
124	additionally stores the first match in the current line into the primary	136	additionally stores the first match in the current line into the primary
125	selection.	137	selection.
126		138
		139	=item readline (enabled by default)
		140
		141	A support package that tries to make editing with readline easier. At the
		142	moment, it reacts to clicking with the left mouse button by trying to
		143	move the text cursor to this position. It does so by generating as many
		144	cursor-left or cursor-right keypresses as required (the this only works
		145	for programs that correctly support wide characters).
		146
		147	To avoid too many false positives, this is only done when:
		148
		149	=over 4
		150
		151	=item - the tty is in ICANON state.
		152
		153	=item - the text cursor is visible.
		154
		155	=item - the primary screen is currently being displayed.
		156
		157	=item - the mouse is on the same (multi-row-) line as the text cursor.
		158
		159	=back
		160
		161	The normal selection mechanism isn't disabled, so quick successive clicks
		162	might interfere with selection creation in harmless ways.
		163
127	=item selection-autotransform	164	=item selection-autotransform
128		165
129	This selection allows you to do automatic transforms on a selection	166	This selection allows you to do automatic transforms on a selection
130	whenever a selection is made.	167	whenever a selection is made.
131		168
…		…
143	URxvt.selection-autotransform.0: s/^([^:[:space:]]+):(\\d+):?$/vi +$2 \\Q$1\\E\\x0d/	180	URxvt.selection-autotransform.0: s/^([^:[:space:]]+):(\\d+):?$/vi +$2 \\Q$1\\E\\x0d/
144		181
145	And this example matches the same,but replaces it with vi-commands you can	182	And this example matches the same,but replaces it with vi-commands you can
146	paste directly into your (vi :) editor:	183	paste directly into your (vi :) editor:
147		184
148	URxvt.selection-autotransform.0: s/^([^:[:space:]]+(\\d+):?$/\\x1b:e \\Q$1\\E\\x0d:$2\\x0d/	185	URxvt.selection-autotransform.0: s/^([^:[:space:]]+(\\d+):?$/:e \\Q$1\\E\\x0d:$2\\x0d/
149		186
150	Of course, this can be modified to suit your needs and your editor :)	187	Of course, this can be modified to suit your needs and your editor :)
151		188
152	To expand the example above to typical perl error messages ("XXX at	189	To expand the example above to typical perl error messages ("XXX at
153	FILENAME line YYY."), you need a slightly more elaborate solution:	190	FILENAME line YYY."), you need a slightly more elaborate solution:
154		191
155	URxvt.selection.pattern-0: ( at .*? line \\d+\\.)	192	URxvt.selection.pattern-0: ( at .*? line \\d+[,.])
156	URxvt.selection-autotransform.0: s/^ at (.*?) line (\\d+)\\.$/\x1b:e \\Q$1\E\\x0d:$2\\x0d/	193	URxvt.selection-autotransform.0: s/^ at (.*?) line (\\d+)[,.]$/:e \\Q$1\E\\x0d:$2\\x0d/
157		194
158	The first line tells the selection code to treat the unchanging part of	195	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	196	every error message as a selection pattern, and the second line transforms
160	the message into vi commands to load the file.	197	the message into vi commands to load the file.
		198
		199	=item tabbed
		200
		201	This transforms the terminal into a tabbar with additional terminals, that
		202	is, it implements what is commonly refered to as "tabbed terminal". The topmost line
		203	displays a "[NEW]" button, which, when clicked, will add a new tab, followed by one
		204	button per tab.
		205
		206	Clicking a button will activate that tab. Pressing B<Shift-Left> and
		207	B<Shift-Right> will switch to the tab left or right of the current one,
		208	while B<Shift-Down> creates a new tab.
161		209
162	=item mark-urls	210	=item mark-urls
163		211
164	Uses per-line display filtering (C<on_line_update>) to underline urls and	212	Uses per-line display filtering (C<on_line_update>) to underline urls and
165	make them clickable. When middle-clicked, the program specified in the	213	make them clickable. When middle-clicked, the program specified in the
166	resource C<urlLauncher> (default C<x-www-browser>) will be started with	214	resource C<urlLauncher> (default C<x-www-browser>) will be started with
167	the URL as first argument.	215	the URL as first argument.
168		216
		217	=item xim-onthespot
		218
		219	This (experimental) perl extension implements OnTheSpot editing. It does
		220	not work perfectly, and some input methods don't seem to work well with
		221	OnTheSpot editing in general, but it seems to work at leats for SCIM and
		222	kinput2.
		223
		224	You enable it by specifying this extension and a preedit style of
		225	C<OnTheSpot>, i.e.:
		226
		227	@@RXVT_NAME@@ -pt OnTheSpot -pe xim-onthespot
		228
		229	=item automove-background
		230
		231	This is basically a one-line extension that dynamically changes the background pixmap offset
		232	to the window position, in effect creating the same effect as pseudo transparency with
		233	a custom pixmap. No scaling is supported in this mode. Exmaple:
		234
		235	@@RXVT_NAME@@ -pixmap background.xpm -pe automove-background
		236
169	=item block-graphics-to-ascii	237	=item block-graphics-to-ascii
170		238
171	A not very useful example of filtering all text output to the terminal,	239	A not very useful example of filtering all text output to the terminal,
172	by replacing all line-drawing characters (U+2500 .. U+259F) by a	240	by replacing all line-drawing characters (U+2500 .. U+259F) by a
173	similar-looking ascii character.	241	similar-looking ascii character.
174		242
175	=item digital-clock	243	=item digital-clock
176		244
177	Displays a digital clock using the built-in overlay.	245	Displays a digital clock using the built-in overlay.
178		246
179	=item example-refresh-hooks	247	=item remote-selection
180		248
181	Displays a very simple digital clock in the upper right corner of the	249	Somewhat of a misnomer, this extension adds two menu entries to the
182	window. Illustrates overwriting the refresh callbacks to create your own	250	selection popup that allows one ti run external commands to store the
183	overlays or changes.	251	selection somewhere and fetch it again.
		252
		253	We use it to implement a "distributed selection mechanism", which just
		254	means that one command uploads the file to a remote server, and another
		255	reads it.
		256
		257	The commands can be set using the C<URxvt.remote-selection.store> and
		258	C<URxvt.remote-selection.fetch> resources. The first should read the
		259	selection to store from STDIN (always in UTF-8), the second should provide
		260	the selection data on STDOUT (also in UTF-8).
		261
		262	The defaults (which are likely useless to you) use rsh and cat:
		263
		264	URxvt.remote-selection.store: rsh ruth 'cat >/tmp/distributed-selection'
		265	URxvt.remote-selection.fetch: rsh ruth 'cat /tmp/distributed-selection'
184		266
185	=item selection-pastebin	267	=item selection-pastebin
186		268
187	This is a little rarely useful extension that Uploads the selection as	269	This is a little rarely useful extension that Uploads the selection as
188	textfile to a remote site (or does other things). (The implementation is	270	textfile to a remote site (or does other things). (The implementation is
…		…
208	After a successful upload the selection will be replaced by the text given	290	After a successful upload the selection will be replaced by the text given
209	in the C<selection-pastebin-url> resource (again, the % is the placeholder	291	in the C<selection-pastebin-url> resource (again, the % is the placeholder
210	for the filename):	292	for the filename):
211		293
212	URxvt.selection-pastebin.url: http://www.ta-sa.org/files/txt/%	294	URxvt.selection-pastebin.url: http://www.ta-sa.org/files/txt/%
		295
		296	=item example-refresh-hooks
		297
		298	Displays a very simple digital clock in the upper right corner of the
		299	window. Illustrates overwriting the refresh callbacks to create your own
		300	overlays or changes.
213		301
214	=back	302	=back
215		303
216	=head1 API DOCUMENTATION	304	=head1 API DOCUMENTATION
217		305
…		…
290	called whenever the relevant event happens.	378	called whenever the relevant event happens.
291		379
292	The first argument passed to them is an extension oject as described in	380	The first argument passed to them is an extension oject as described in
293	the in the C<Extension Objects> section.	381	the in the C<Extension Objects> section.
294		382
295	B<All> of these hooks must return a boolean value. If it is true, then the	383	B<All> of these hooks must return a boolean value. If any of the called
296	event counts as being I<consumed>, and the invocation of other hooks is	384	hooks returns true, then the event counts as being I<consumed>, and the
297	skipped, and the relevant action might not be carried out by the C++ code.	385	relevant action might not be carried out by the C++ code.
298		386
299	I<< When in doubt, return a false value (preferably C<()>). >>	387	I<< When in doubt, return a false value (preferably C<()>). >>
300		388
301	=over 4	389	=over 4
302		390
303	=item on_init $term	391	=item on_init $term
304		392
305	Called after a new terminal object has been initialized, but before	393	Called after a new terminal object has been initialized, but before
306	windows are created or the command gets run. Most methods are unsafe to	394	windows are created or the command gets run. Most methods are unsafe to
307	call or deliver senseless data, as terminal size and other characteristics	395	call or deliver senseless data, as terminal size and other characteristics
308	have not yet been determined. You can safely query and change resources,	396	have not yet been determined. You can safely query and change resources
309	though.	397	and options, though. For many purposes the C<on_start> hook is a better
		398	place.
		399
		400	=item on_start $term
		401
		402	Called at the very end of initialisation of a new terminal, just before
		403	trying to map (display) the toplevel and returning to the mainloop.
		404
		405	=item on_destroy $term
		406
		407	Called whenever something tries to destroy terminal, when the terminal is
		408	still fully functional (not for long, though).
310		409
311	=item on_reset $term	410	=item on_reset $term
312		411
313	Called after the screen is "reset" for any reason, such as resizing or	412	Called after the screen is "reset" for any reason, such as resizing or
314	control sequences. Here is where you can react on changes to size-related	413	control sequences. Here is where you can react on changes to size-related
315	variables.	414	variables.
316		415
317	=item on_start $term	416	=item on_child_start $term, $pid
318		417
319	Called at the very end of initialisation of a new terminal, just before	418	Called just after the child process has been C<fork>ed.
320	returning to the mainloop.	419
		420	=item on_child_exit $term, $status
		421
		422	Called just after the child process has exited. C<$status> is the status
		423	from C<waitpid>.
321		424
322	=item on_sel_make $term, $eventtime	425	=item on_sel_make $term, $eventtime
323		426
324	Called whenever a selection has been made by the user, but before the	427	Called whenever a selection has been made by the user, but before the
325	selection text is copied, so changes to the beginning, end or type of the	428	selection text is copied, so changes to the beginning, end or type of the
…		…
434	=item on_focus_out $term	537	=item on_focus_out $term
435		538
436	Called wheneever the window loses keyboard focus, before rxvt-unicode does	539	Called wheneever the window loses keyboard focus, before rxvt-unicode does
437	focus out processing.	540	focus out processing.
438		541
		542	=item on_configure_notify $term, $event
		543
		544	=item on_property_notify $term, $event
		545
439	=item on_key_press $term, $event, $keysym, $octets	546	=item on_key_press $term, $event, $keysym, $octets
440		547
441	=item on_key_release $term, $event, $keysym	548	=item on_key_release $term, $event, $keysym
442		549
443	=item on_button_press $term, $event	550	=item on_button_press $term, $event
…		…
452		559
453	Called whenever the corresponding X event is received for the terminal If	560	Called whenever the corresponding X event is received for the terminal If
454	the hook returns true, then the even will be ignored by rxvt-unicode.	561	the hook returns true, then the even will be ignored by rxvt-unicode.
455		562
456	The event is a hash with most values as named by Xlib (see the XEvent	563	The event is a hash with most values as named by Xlib (see the XEvent
457	manpage), with the additional members C<row> and C<col>, which are the row	564	manpage), with the additional members C<row> and C<col>, which are the
458	and column under the mouse cursor.	565	(real, not screen-based) row and column under the mouse cursor.
459		566
460	C<on_key_press> additionally receives the string rxvt-unicode would	567	C<on_key_press> additionally receives the string rxvt-unicode would
461	output, if any, in locale-specific encoding.	568	output, if any, in locale-specific encoding.
462		569
463	subwindow.	570	subwindow.
		571
		572	=item on_client_message $term, $event
		573
		574	=item on_wm_protocols $term, $event
		575
		576	=item on_wm_delete_window $term, $event
		577
		578	Called when various types of ClientMessage events are received (all with
		579	format=32, WM_PROTOCOLS or WM_PROTOCOLS:WM_DELETE_WINDOW).
464		580
465	=back	581	=back
466		582
467	=cut	583	=cut
468		584
…		…
474	use Scalar::Util ();	590	use Scalar::Util ();
475	use List::Util ();	591	use List::Util ();
476		592
477	our $VERSION = 1;	593	our $VERSION = 1;
478	our $TERM;	594	our $TERM;
		595	our @TERM_INIT;
		596	our @TERM_EXT;
479	our @HOOKNAME;	597	our @HOOKNAME;
480	our %HOOKTYPE = map +($HOOKNAME[$_] => $_), 0..$#HOOKNAME;	598	our %HOOKTYPE = map +($HOOKNAME[$_] => $_), 0..$#HOOKNAME;
481	our %OPTION;	599	our %OPTION;
482		600
483	our $LIBDIR;	601	our $LIBDIR;
484	our $RESNAME;	602	our $RESNAME;
485	our $RESCLASS;	603	our $RESCLASS;
486	our $RXVTNAME;	604	our $RXVTNAME;
487		605
		606	our $NOCHAR = chr 0xffff;
		607
488	=head2 Variables in the C<urxvt> Package	608	=head2 Variables in the C<urxvt> Package
489		609
490	=over 4	610	=over 4
491		611
492	=item $urxvt::LIBDIR	612	=item $urxvt::LIBDIR
…		…
504		624
505	=item $urxvt::TERM	625	=item $urxvt::TERM
506		626
507	The current terminal. This variable stores the current C<urxvt::term>	627	The current terminal. This variable stores the current C<urxvt::term>
508	object, whenever a callback/hook is executing.	628	object, whenever a callback/hook is executing.
		629
		630	=item @urxvt::TERM_INIT
		631
		632	All coderefs in this array will be called as methods of the next newly
		633	created C<urxvt::term> object (during the C<on_init> phase). The array
		634	gets cleared before the codereferences that were in it are being executed,
		635	so coderefs can push themselves onto it again if they so desire.
		636
		637	This complements to the perl-eval commandline option, but gets executed
		638	first.
		639
		640	=item @urxvt::TERM_EXT
		641
		642	Works similar to C<@TERM_INIT>, but contains perl package/class names, which
		643	get registered as normal extensions after calling the hooks in C<@TERM_INIT>
		644	but before other extensions. Gets cleared just like C<@TERM_INIT>.
509		645
510	=back	646	=back
511		647
512	=head2 Functions in the C<urxvt> Package	648	=head2 Functions in the C<urxvt> Package
513		649
…		…
620	my $msg = join "", @_;	756	my $msg = join "", @_;
621	$msg .= "\n"	757	$msg .= "\n"
622	unless $msg =~ /\n$/;	758	unless $msg =~ /\n$/;
623	urxvt::warn ($msg);	759	urxvt::warn ($msg);
624	};	760	};
625
626	# %ENV is the original startup environment
627	delete $ENV{IFS};
628	delete $ENV{CDPATH};
629	delete $ENV{BASH_ENV};
630	$ENV{PATH} = "/bin:/sbin:/usr/bin:/usr/sbin:/usr/local/bin:/usr/local/sbin:/opt/bin:/opt/sbin";
631	}	761	}
		762
		763	no warnings 'utf8';
632		764
633	my $verbosity = $ENV{URXVT_PERL_VERBOSITY};	765	my $verbosity = $ENV{URXVT_PERL_VERBOSITY};
634		766
635	sub verbose {	767	sub verbose {
636	my ($level, $msg) = @_;	768	my ($level, $msg) = @_;
…		…
640	my %extension_pkg;	772	my %extension_pkg;
641		773
642	# load a single script into its own package, once only	774	# load a single script into its own package, once only
643	sub extension_package($) {	775	sub extension_package($) {
644	my ($path) = @_;	776	my ($path) = @_;
645
646	no strict 'refs';
647		777
648	$extension_pkg{$path} \|\|= do {	778	$extension_pkg{$path} \|\|= do {
649	$path =~ /([^\/\\]+)$/;	779	$path =~ /([^\/\\]+)$/;
650	my $pkg = $1;	780	my $pkg = $1;
651	$pkg =~ s/[^[:word:]]/_/g;	781	$pkg =~ s/[^[:word:]]/_/g;
…		…
654	verbose 3, "loading extension '$path' into package '$pkg'";	784	verbose 3, "loading extension '$path' into package '$pkg'";
655		785
656	open my $fh, "<:raw", $path	786	open my $fh, "<:raw", $path
657	or die "$path: $!";	787	or die "$path: $!";
658		788
659	@{"$pkg\::ISA"} = urxvt::term::extension::;
660
661	my $source =	789	my $source =
662	"package $pkg; use strict; use utf8;\n"	790	"package $pkg; use strict; use utf8; no warnings 'utf8';\n"
663	. "#line 1 \"$path\"\n{\n"	791	. "#line 1 \"$path\"\n{\n"
664	. (do { local $/; <$fh> })	792	. (do { local $/; <$fh> })
665	. "\n};\n1";	793	. "\n};\n1";
666		794
667	eval $source	795	eval $source
…		…
681	if ($htype == 0) { # INIT	809	if ($htype == 0) { # INIT
682	my @dirs = ((split /:/, $TERM->resource ("perl_lib")), "$LIBDIR/perl");	810	my @dirs = ((split /:/, $TERM->resource ("perl_lib")), "$LIBDIR/perl");
683		811
684	my %ext_arg;	812	my %ext_arg;
685		813
		814	{
		815	my @init = @TERM_INIT;
		816	@TERM_INIT = ();
		817	$_->($TERM) for @init;
		818	my @pkg = @TERM_EXT;
		819	@TERM_EXT = ();
		820	$TERM->register_package ($_) for @pkg;
		821	}
		822
686	for (map { split /,/, $TERM->resource ("perl_ext_$_") } 1, 2) {	823	for (grep $_, map { split /,/, $TERM->resource ("perl_ext_$_") } 1, 2) {
687	if ($_ eq "default") {	824	if ($_ eq "default") {
688	$ext_arg{$_} \|\|= [] for qw(selection option-popup selection-popup searchable-scrollback);	825	$ext_arg{$_} \|\|= [] for qw(selection option-popup selection-popup searchable-scrollback readline);
689	} elsif (/^-(.*)$/) {	826	} elsif (/^-(.*)$/) {
690	delete $ext_arg{$1};	827	delete $ext_arg{$1};
691	} elsif (/^([^<]+)<(.*)>$/) {	828	} elsif (/^([^<]+)<(.*)>$/) {
692	push @{ $ext_arg{$1} }, $2;	829	push @{ $ext_arg{$1} }, $2;
693	} else {	830	} else {
…		…
716	if $verbosity >= 10;	853	if $verbosity >= 10;
717		854
718	keys %$cb;	855	keys %$cb;
719		856
720	while (my ($pkg, $cb) = each %$cb) {	857	while (my ($pkg, $cb) = each %$cb) {
721	$retval = eval { $cb->($TERM->{_pkg}{$pkg}, @_) }	858	my $retval_ = eval { $cb->($TERM->{_pkg}{$pkg}, @_) };
722	and last;	859	$retval \|\|= $retval_;
723		860
724	if ($@) {	861	if ($@) {
725	$TERM->ungrab; # better to lose the grab than the session	862	$TERM->ungrab; # better to lose the grab than the session
726	warn $@;	863	warn $@;
727	}	864	}
…		…
738	# clear package	875	# clear package
739	%$TERM = ();	876	%$TERM = ();
740	}	877	}
741		878
742	$retval	879	$retval
743	}
744
745	sub exec_async(@) {
746	my $pid = fork;
747
748	return
749	if !defined $pid or $pid;
750
751	%ENV = %{ $TERM->env };
752
753	exec @_;
754	_exit 255;
755	}	880	}
756		881
757	# urxvt::term::extension	882	# urxvt::term::extension
758		883
759	package urxvt::term::extension;	884	package urxvt::term::extension;
…		…
898	# find on_xxx subs in the package and register them	1023	# find on_xxx subs in the package and register them
899	# as hooks	1024	# as hooks
900	sub register_package {	1025	sub register_package {
901	my ($self, $pkg, $argv) = @_;	1026	my ($self, $pkg, $argv) = @_;
902		1027
		1028	no strict 'refs';
		1029
		1030	urxvt::verbose 6, "register package $pkg to $self";
		1031
		1032	@{"$pkg\::ISA"} = urxvt::term::extension::;
		1033
903	my $proxy = bless {	1034	my $proxy = bless {
904	_pkg => $pkg,	1035	_pkg => $pkg,
905	argv => $argv,	1036	argv => $argv,
906	}, $pkg;	1037	}, $pkg;
907	Scalar::Util::weaken ($proxy->{term} = $self);	1038	Scalar::Util::weaken ($proxy->{term} = $self);
…		…
938		1069
939	Destroy the terminal object (close the window, free resources	1070	Destroy the terminal object (close the window, free resources
940	etc.). Please note that @@RXVT_NAME@@ will not exit as long as any event	1071	etc.). Please note that @@RXVT_NAME@@ will not exit as long as any event
941	watchers (timers, io watchers) are still active.	1072	watchers (timers, io watchers) are still active.
942		1073
		1074	=item $term->exec_async ($cmd[, @args])
		1075
		1076	Works like the combination of the C<fork>/C<exec> builtins, which executes
		1077	("starts") programs in the background. This function takes care of setting
		1078	the user environment before exec'ing the command (e.g. C<PATH>) and should
		1079	be preferred over explicit calls to C<exec> or C<system>.
		1080
		1081	Returns the pid of the subprocess or C<undef> on error.
		1082
		1083	=cut
		1084
		1085	sub exec_async {
		1086	my $self = shift;
		1087
		1088	my $pid = fork;
		1089
		1090	return $pid
		1091	if !defined $pid or $pid;
		1092
		1093	%ENV = %{ $self->env };
		1094
		1095	exec @_;
		1096	urxvt::_exit 255;
		1097	}
		1098
943	=item $isset = $term->option ($optval[, $set])	1099	=item $isset = $term->option ($optval[, $set])
944		1100
945	Returns true if the option specified by C<$optval> is enabled, and	1101	Returns true if the option specified by C<$optval> is enabled, and
946	optionally change it. All option values are stored by name in the hash	1102	optionally change it. All option values are stored by name in the hash
947	C<%urxvt::OPTION>. Options not enabled in this binary are not in the hash.	1103	C<%urxvt::OPTION>. Options not enabled in this binary are not in the hash.
…		…
949	Here is a a likely non-exhaustive list of option names, please see the	1105	Here is a a likely non-exhaustive list of option names, please see the
950	source file F</src/optinc.h> to see the actual list:	1106	source file F</src/optinc.h> to see the actual list:
951		1107
952	borderLess console cursorBlink cursorUnderline hold iconic insecure	1108	borderLess console cursorBlink cursorUnderline hold iconic insecure
953	intensityStyles jumpScroll loginShell mapAlert meta8 mouseWheelScrollPage	1109	intensityStyles jumpScroll loginShell mapAlert meta8 mouseWheelScrollPage
954	pastableTabs pointerBlank reverseVideo scrollBar scrollBar_floating	1110	override-redirect pastableTabs pointerBlank reverseVideo scrollBar
955	scrollBar_right scrollTtyKeypress scrollTtyOutput scrollWithBuffer	1111	scrollBar_floating scrollBar_right scrollTtyKeypress scrollTtyOutput
956	secondaryScreen secondaryScroll skipBuiltinGlyphs transparent	1112	scrollWithBuffer secondaryScreen secondaryScroll skipBuiltinGlyphs
957	tripleclickwords utmpInhibit visualBell	1113	transparent tripleclickwords utmpInhibit visualBell
958		1114
959	=item $value = $term->resource ($name[, $newval])	1115	=item $value = $term->resource ($name[, $newval])
960		1116
961	Returns the current resource value associated with a given name and	1117	Returns the current resource value associated with a given name and
962	optionally sets a new value. Setting values is most useful in the C<init>	1118	optionally sets a new value. Setting values is most useful in the C<init>
…		…
979		1135
980	answerbackstring backgroundPixmap backspace_key boldFont boldItalicFont	1136	answerbackstring backgroundPixmap backspace_key boldFont boldItalicFont
981	borderLess color cursorBlink cursorUnderline cutchars delete_key	1137	borderLess color cursorBlink cursorUnderline cutchars delete_key
982	display_name embed ext_bwidth fade font geometry hold iconName	1138	display_name embed ext_bwidth fade font geometry hold iconName
983	imFont imLocale inputMethod insecure int_bwidth intensityStyles	1139	imFont imLocale inputMethod insecure int_bwidth intensityStyles
984	italicFont jumpScroll lineSpace loginShell mapAlert menu meta8 modifier	1140	italicFont jumpScroll lineSpace loginShell mapAlert meta8 modifier
985	mouseWheelScrollPage name pastableTabs path perl_eval perl_ext_1 perl_ext_2	1141	mouseWheelScrollPage name override_redirect pastableTabs path perl_eval
986	perl_lib pointerBlank pointerBlankDelay preeditType print_pipe pty_fd	1142	perl_ext_1 perl_ext_2 perl_lib pointerBlank pointerBlankDelay
987	reverseVideo saveLines scrollBar scrollBar_align scrollBar_floating	1143	preeditType print_pipe pty_fd reverseVideo saveLines scrollBar
988	scrollBar_right scrollBar_thickness scrollTtyKeypress scrollTtyOutput	1144	scrollBar_align scrollBar_floating scrollBar_right scrollBar_thickness
989	scrollWithBuffer scrollstyle secondaryScreen secondaryScroll selectstyle	1145	scrollTtyKeypress scrollTtyOutput scrollWithBuffer scrollstyle
990	shade term_name title transparent transparent_all tripleclickwords	1146	secondaryScreen secondaryScroll selectstyle shade term_name title
991	utmpInhibit visualBell	1147	transient_for transparent transparent_all tripleclickwords utmpInhibit
		1148	visualBell
992		1149
993	=cut	1150	=cut
994		1151
995	sub resource($$;$) {	1152	sub resource($$;$) {
996	my ($self, $name) = (shift, shift);	1153	my ($self, $name) = (shift, shift);
…		…
1170		1327
1171	Normally its not a good idea to use this function, as programs might be	1328	Normally its not a good idea to use this function, as programs might be
1172	confused by changes in cursor position or scrolling. Its useful inside a	1329	confused by changes in cursor position or scrolling. Its useful inside a
1173	C<on_add_lines> hook, though.	1330	C<on_add_lines> hook, though.
1174		1331
		1332	=item $term->scr_change_screen ($screen)
		1333
		1334	Switch to given screen - 0 primary, 1 secondary.
		1335
1175	=item $term->cmd_parse ($octets)	1336	=item $term->cmd_parse ($octets)
1176		1337
1177	Similar to C<scr_add_lines>, but the argument must be in the	1338	Similar to C<scr_add_lines>, but the argument must be in the
1178	locale-specific encoding of the terminal and can contain command sequences	1339	locale-specific encoding of the terminal and can contain command sequences
1179	(escape codes) that will be interpreted.	1340	(escape codes) that will be interpreted.
…		…
1188		1349
1189	Replaces the event mask of the pty watcher by the given event mask. Can	1350	Replaces the event mask of the pty watcher by the given event mask. Can
1190	be used to suppress input and output handling to the pty/tty. See the	1351	be used to suppress input and output handling to the pty/tty. See the
1191	description of C<< urxvt::timer->events >>. Make sure to always restore	1352	description of C<< urxvt::timer->events >>. Make sure to always restore
1192	the previous value.	1353	the previous value.
		1354
		1355	=item $fd = $term->pty_fd
		1356
		1357	Returns the master file descriptor for the pty in use, or C<-1> if no pty
		1358	is used.
1193		1359
1194	=item $windowid = $term->parent	1360	=item $windowid = $term->parent
1195		1361
1196	Return the window id of the toplevel window.	1362	Return the window id of the toplevel window.
1197		1363
…		…
1262	=item $modifiermask = $term->ModNumLockMask	1428	=item $modifiermask = $term->ModNumLockMask
1263		1429
1264	Return the modifier masks corresponding to the "ISO Level 3 Shift" (often	1430	Return the modifier masks corresponding to the "ISO Level 3 Shift" (often
1265	AltGr), the meta key (often Alt) and the num lock key, if applicable.	1431	AltGr), the meta key (often Alt) and the num lock key, if applicable.
1266		1432
		1433	=item $screen = $term->current_screen
		1434
		1435	Returns the currently displayed screen (0 primary, 1 secondary).
		1436
		1437	=item $cursor_is_hidden = $term->hidden_cursor
		1438
		1439	Returns wether the cursor is currently hidden or not.
		1440
1267	=item $view_start = $term->view_start ([$newvalue])	1441	=item $view_start = $term->view_start ([$newvalue])
1268		1442
1269	Returns the row number of the topmost displayed line. Maximum value is	1443	Returns the row number of the topmost displayed line. Maximum value is
1270	C<0>, which displays the normal terminal contents. Lower values scroll	1444	C<0>, which displays the normal terminal contents. Lower values scroll
1271	this many lines into the scrollback buffer.	1445	this many lines into the scrollback buffer.
…		…
1290	line, starting at column C<$start_col> (default C<0>), which is useful	1464	line, starting at column C<$start_col> (default C<0>), which is useful
1291	to replace only parts of a line. The font index in the rendition will	1465	to replace only parts of a line. The font index in the rendition will
1292	automatically be updated.	1466	automatically be updated.
1293		1467
1294	C<$text> is in a special encoding: tabs and wide characters that use more	1468	C<$text> is in a special encoding: tabs and wide characters that use more
1295	than one cell when displayed are padded with urxvt::NOCHAR characters	1469	than one cell when displayed are padded with C<$urxvt::NOCHAR> (chr 65535)
1296	(C<chr 65535>). Characters with combining characters and other characters	1470	characters. Characters with combining characters and other characters that
1297	that do not fit into the normal tetx encoding will be replaced with	1471	do not fit into the normal tetx encoding will be replaced with characters
1298	characters in the private use area.	1472	in the private use area.
1299		1473
1300	You have to obey this encoding when changing text. The advantage is	1474	You have to obey this encoding when changing text. The advantage is
1301	that C<substr> and similar functions work on screen cells and not on	1475	that C<substr> and similar functions work on screen cells and not on
1302	characters.	1476	characters.
1303		1477
…		…
1478		1652
1479	Calls XUngrab for the most recent grab. Is called automatically on	1653	Calls XUngrab for the most recent grab. Is called automatically on
1480	evaluation errors, as it is better to lose the grab in the error case as	1654	evaluation errors, as it is better to lose the grab in the error case as
1481	the session.	1655	the session.
1482		1656
		1657	=item $atom = $term->XInternAtom ($atom_name[, $only_if_exists])
		1658
		1659	=item $atom_name = $term->XGetAtomName ($atom)
		1660
		1661	=item @atoms = $term->XListProperties ($window)
		1662
		1663	=item ($type,$format,$octets) = $term->XGetWindowProperty ($window, $property)
		1664
		1665	=item $term->XChangeWindowProperty ($window, $property, $type, $format, $octets)
		1666
		1667	=item $term->XDeleteProperty ($window, $property)
		1668
		1669	=item $window = $term->DefaultRootWindow
		1670
		1671	=item $term->XReparentWindow ($window, $parent, [$x, $y])
		1672
		1673	=item $term->XMapWindow ($window)
		1674
		1675	=item $term->XUnmapWindow ($window)
		1676
		1677	=item $term->XMoveResizeWindow ($window, $x, $y, $width, $height)
		1678
		1679	=item ($x, $y, $child_window) = $term->XTranslateCoordinates ($src, $dst, $x, $y)
		1680
		1681	=item $term->XChangeInput ($window, $add_events[, $del_events])
		1682
		1683	Various X or X-related functions. The C<$term> object only serves as
		1684	the source of the display, otherwise those functions map more-or-less
		1685	directory onto the X functions of the same name.
		1686
1483	=back	1687	=back
1484		1688
1485	=cut	1689	=cut
1486		1690
1487	package urxvt::popup;	1691	package urxvt::popup;
…		…
1588	my $env = $self->{term}->env;	1792	my $env = $self->{term}->env;
1589	# we can't hope to reproduce the locale algorithm, so nuke LC_ALL and set LC_CTYPE.	1793	# we can't hope to reproduce the locale algorithm, so nuke LC_ALL and set LC_CTYPE.
1590	delete $env->{LC_ALL};	1794	delete $env->{LC_ALL};
1591	$env->{LC_CTYPE} = $self->{term}->locale;	1795	$env->{LC_CTYPE} = $self->{term}->locale;
1592		1796
1593	urxvt::term->new ($env, $self->{term}->resource ("name"),	1797	urxvt::term->new ($env, "popup",
1594	"--perl-lib" => "", "--perl-ext-common" => "", "-pty-fd" => -1, "-sl" => 0, "-b" => 0,	1798	"--perl-lib" => "", "--perl-ext-common" => "",
		1799	"-pty-fd" => -1, "-sl" => 0,
		1800	"-b" => 1, "-bd" => "grey80", "-bl", "-override-redirect",
1595	"--transient-for" => $self->{term}->parent,	1801	"--transient-for" => $self->{term}->parent,
1596	"-display" => $self->{term}->display_id,	1802	"-display" => $self->{term}->display_id,
1597	"-pe" => "urxvt-popup")	1803	"-pe" => "urxvt-popup")
1598	or die "unable to create popup window\n";	1804	or die "unable to create popup window\n";
1599	}	1805	}
…		…
1604	delete $self->{term}{_destroy}{$self};	1810	delete $self->{term}{_destroy}{$self};
1605	$self->{term}->ungrab;	1811	$self->{term}->ungrab;
1606	}	1812	}
1607		1813
1608	=back	1814	=back
		1815
		1816	=cut
		1817
		1818	package urxvt::watcher;
		1819
		1820	@urxvt::timer::ISA = __PACKAGE__;
		1821	@urxvt::iow::ISA = __PACKAGE__;
		1822	@urxvt::pw::ISA = __PACKAGE__;
		1823	@urxvt::iw::ISA = __PACKAGE__;
1609		1824
1610	=head2 The C<urxvt::timer> Class	1825	=head2 The C<urxvt::timer> Class
1611		1826
1612	This class implements timer watchers/events. Time is represented as a	1827	This class implements timer watchers/events. Time is represented as a
1613	fractional number of seconds since the epoch. Example:	1828	fractional number of seconds since the epoch. Example:
…		…
1651	Start the timer.	1866	Start the timer.
1652		1867
1653	=item $timer = $timer->start ($tstamp)	1868	=item $timer = $timer->start ($tstamp)
1654		1869
1655	Set the event trigger time to C<$tstamp> and start the timer.	1870	Set the event trigger time to C<$tstamp> and start the timer.
		1871
		1872	=item $timer = $timer->after ($delay)
		1873
		1874	Like C<start>, but sets the expiry timer to c<urxvt::NOW + $delay>.
1656		1875
1657	=item $timer = $timer->stop	1876	=item $timer = $timer->stop
1658		1877
1659	Stop the timer.	1878	Stop the timer.
1660		1879
…		…
1707		1926
1708	Stop watching for events on the given filehandle.	1927	Stop watching for events on the given filehandle.
1709		1928
1710	=back	1929	=back
1711		1930
		1931	=head2 The C<urxvt::iw> Class
		1932
		1933	This class implements idle watchers, that get called automatically when
		1934	the process is idle. They should return as fast as possible, after doing
		1935	some useful work.
		1936
		1937	=over 4
		1938
		1939	=item $iw = new urxvt::iw
		1940
		1941	Create a new idle watcher object in stopped state.
		1942
		1943	=item $iw = $iw->cb (sub { my ($iw) = @_; ... })
		1944
		1945	Set the callback to be called when the watcher triggers.
		1946
		1947	=item $timer = $timer->start
		1948
		1949	Start the watcher.
		1950
		1951	=item $timer = $timer->stop
		1952
		1953	Stop the watcher.
		1954
		1955	=back
		1956
		1957	=head2 The C<urxvt::pw> Class
		1958
		1959	This class implements process watchers. They create an event whenever a
		1960	process exits, after which they stop automatically.
		1961
		1962	my $pid = fork;
		1963	...
		1964	$term->{pw} = urxvt::pw
		1965	->new
		1966	->start ($pid)
		1967	->cb (sub {
		1968	my ($pw, $exit_status) = @_;
		1969	...
		1970	});
		1971
		1972	=over 4
		1973
		1974	=item $pw = new urxvt::pw
		1975
		1976	Create a new process watcher in stopped state.
		1977
		1978	=item $pw = $pw->cb (sub { my ($pw, $exit_status) = @_; ... })
		1979
		1980	Set the callback to be called when the timer triggers.
		1981
		1982	=item $pw = $timer->start ($pid)
		1983
		1984	Tells the wqtcher to start watching for process C<$pid>.
		1985
		1986	=item $pw = $pw->stop
		1987
		1988	Stop the watcher.
		1989
		1990	=back
		1991
1712	=head1 ENVIRONMENT	1992	=head1 ENVIRONMENT
1713		1993
1714	=head2 URXVT_PERL_VERBOSITY	1994	=head2 URXVT_PERL_VERBOSITY
1715		1995
1716	This variable controls the verbosity level of the perl extension. Higher	1996	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.101 by root, Wed Jan 18 10:11:03 2006 UTC vs. Revision 1.129 by root, Wed Jan 25 15:11:31 2006 UTC

Diff Legend

Comparing rxvt-unicode/src/urxvt.pm (file contents):
Revision 1.101 by root, Wed Jan 18 10:11:03 2006 UTC vs.
Revision 1.129 by root, Wed Jan 25 15:11:31 2006 UTC