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

Comparing rxvt-unicode/src/urxvt.pm (file contents):
Revision 1.103 by root, Wed Jan 18 11:05:09 2006 UTC vs.
Revision 1.130 by root, Wed Jan 25 15:32:48 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-clipboard
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
…		…
412		515
413	=item on_refresh_end $term	516	=item on_refresh_end $term
414		517
415	Called just after the screen gets redrawn. See C<on_refresh_begin>.	518	Called just after the screen gets redrawn. See C<on_refresh_begin>.
416		519
417	=item on_keyboard_command $term, $string	520	=item on_user_command $term, $string
418		521
419	Called whenever the user presses a key combination that has a	522	Called whenever the a user-configured event is being activated (e.g. via
420	C<perl:string> action bound to it (see description of the B<keysym>	523	a C<perl:string> action bound to a key, see description of the B<keysym>
421	resource in the @@RXVT_NAME@@(1) manpage).	524	resource in the @@RXVT_NAME@@(1) manpage).
		525
		526	The event is simply the action string. This interface is assumed to change
		527	slightly in the future.
422		528
423	=item on_x_event $term, $event	529	=item on_x_event $term, $event
424		530
425	Called on every X event received on the vt window (and possibly other	531	Called on every X event received on the vt window (and possibly other
426	windows). Should only be used as a last resort. Most event structure	532	windows). Should only be used as a last resort. Most event structure
…		…
436	Called wheneever the window loses keyboard focus, before rxvt-unicode does	542	Called wheneever the window loses keyboard focus, before rxvt-unicode does
437	focus out processing.	543	focus out processing.
438		544
439	=item on_configure_notify $term, $event	545	=item on_configure_notify $term, $event
440		546
		547	=item on_property_notify $term, $event
		548
441	=item on_key_press $term, $event, $keysym, $octets	549	=item on_key_press $term, $event, $keysym, $octets
442		550
443	=item on_key_release $term, $event, $keysym	551	=item on_key_release $term, $event, $keysym
444		552
445	=item on_button_press $term, $event	553	=item on_button_press $term, $event
…		…
454		562
455	Called whenever the corresponding X event is received for the terminal If	563	Called whenever the corresponding X event is received for the terminal If
456	the hook returns true, then the even will be ignored by rxvt-unicode.	564	the hook returns true, then the even will be ignored by rxvt-unicode.
457		565
458	The event is a hash with most values as named by Xlib (see the XEvent	566	The event is a hash with most values as named by Xlib (see the XEvent
459	manpage), with the additional members C<row> and C<col>, which are the row	567	manpage), with the additional members C<row> and C<col>, which are the
460	and column under the mouse cursor.	568	(real, not screen-based) row and column under the mouse cursor.
461		569
462	C<on_key_press> additionally receives the string rxvt-unicode would	570	C<on_key_press> additionally receives the string rxvt-unicode would
463	output, if any, in locale-specific encoding.	571	output, if any, in locale-specific encoding.
464		572
465	subwindow.	573	subwindow.
		574
		575	=item on_client_message $term, $event
		576
		577	=item on_wm_protocols $term, $event
		578
		579	=item on_wm_delete_window $term, $event
		580
		581	Called when various types of ClientMessage events are received (all with
		582	format=32, WM_PROTOCOLS or WM_PROTOCOLS:WM_DELETE_WINDOW).
466		583
467	=back	584	=back
468		585
469	=cut	586	=cut
470		587
…		…
476	use Scalar::Util ();	593	use Scalar::Util ();
477	use List::Util ();	594	use List::Util ();
478		595
479	our $VERSION = 1;	596	our $VERSION = 1;
480	our $TERM;	597	our $TERM;
		598	our @TERM_INIT;
		599	our @TERM_EXT;
481	our @HOOKNAME;	600	our @HOOKNAME;
482	our %HOOKTYPE = map +($HOOKNAME[$_] => $_), 0..$#HOOKNAME;	601	our %HOOKTYPE = map +($HOOKNAME[$_] => $_), 0..$#HOOKNAME;
483	our %OPTION;	602	our %OPTION;
484		603
485	our $LIBDIR;	604	our $LIBDIR;
486	our $RESNAME;	605	our $RESNAME;
487	our $RESCLASS;	606	our $RESCLASS;
488	our $RXVTNAME;	607	our $RXVTNAME;
489		608
		609	our $NOCHAR = chr 0xffff;
		610
490	=head2 Variables in the C<urxvt> Package	611	=head2 Variables in the C<urxvt> Package
491		612
492	=over 4	613	=over 4
493		614
494	=item $urxvt::LIBDIR	615	=item $urxvt::LIBDIR
…		…
506		627
507	=item $urxvt::TERM	628	=item $urxvt::TERM
508		629
509	The current terminal. This variable stores the current C<urxvt::term>	630	The current terminal. This variable stores the current C<urxvt::term>
510	object, whenever a callback/hook is executing.	631	object, whenever a callback/hook is executing.
		632
		633	=item @urxvt::TERM_INIT
		634
		635	All coderefs in this array will be called as methods of the next newly
		636	created C<urxvt::term> object (during the C<on_init> phase). The array
		637	gets cleared before the codereferences that were in it are being executed,
		638	so coderefs can push themselves onto it again if they so desire.
		639
		640	This complements to the perl-eval commandline option, but gets executed
		641	first.
		642
		643	=item @urxvt::TERM_EXT
		644
		645	Works similar to C<@TERM_INIT>, but contains perl package/class names, which
		646	get registered as normal extensions after calling the hooks in C<@TERM_INIT>
		647	but before other extensions. Gets cleared just like C<@TERM_INIT>.
511		648
512	=back	649	=back
513		650
514	=head2 Functions in the C<urxvt> Package	651	=head2 Functions in the C<urxvt> Package
515		652
…		…
622	my $msg = join "", @_;	759	my $msg = join "", @_;
623	$msg .= "\n"	760	$msg .= "\n"
624	unless $msg =~ /\n$/;	761	unless $msg =~ /\n$/;
625	urxvt::warn ($msg);	762	urxvt::warn ($msg);
626	};	763	};
627
628	# %ENV is the original startup environment
629	delete $ENV{IFS};
630	delete $ENV{CDPATH};
631	delete $ENV{BASH_ENV};
632	$ENV{PATH} = "/bin:/sbin:/usr/bin:/usr/sbin:/usr/local/bin:/usr/local/sbin:/opt/bin:/opt/sbin";
633	}	764	}
		765
		766	no warnings 'utf8';
634		767
635	my $verbosity = $ENV{URXVT_PERL_VERBOSITY};	768	my $verbosity = $ENV{URXVT_PERL_VERBOSITY};
636		769
637	sub verbose {	770	sub verbose {
638	my ($level, $msg) = @_;	771	my ($level, $msg) = @_;
…		…
642	my %extension_pkg;	775	my %extension_pkg;
643		776
644	# load a single script into its own package, once only	777	# load a single script into its own package, once only
645	sub extension_package($) {	778	sub extension_package($) {
646	my ($path) = @_;	779	my ($path) = @_;
647
648	no strict 'refs';
649		780
650	$extension_pkg{$path} \|\|= do {	781	$extension_pkg{$path} \|\|= do {
651	$path =~ /([^\/\\]+)$/;	782	$path =~ /([^\/\\]+)$/;
652	my $pkg = $1;	783	my $pkg = $1;
653	$pkg =~ s/[^[:word:]]/_/g;	784	$pkg =~ s/[^[:word:]]/_/g;
…		…
656	verbose 3, "loading extension '$path' into package '$pkg'";	787	verbose 3, "loading extension '$path' into package '$pkg'";
657		788
658	open my $fh, "<:raw", $path	789	open my $fh, "<:raw", $path
659	or die "$path: $!";	790	or die "$path: $!";
660		791
661	@{"$pkg\::ISA"} = urxvt::term::extension::;
662
663	my $source =	792	my $source =
664	"package $pkg; use strict; use utf8;\n"	793	"package $pkg; use strict; use utf8; no warnings 'utf8';\n"
665	. "#line 1 \"$path\"\n{\n"	794	. "#line 1 \"$path\"\n{\n"
666	. (do { local $/; <$fh> })	795	. (do { local $/; <$fh> })
667	. "\n};\n1";	796	. "\n};\n1";
668		797
669	eval $source	798	eval $source
…		…
683	if ($htype == 0) { # INIT	812	if ($htype == 0) { # INIT
684	my @dirs = ((split /:/, $TERM->resource ("perl_lib")), "$LIBDIR/perl");	813	my @dirs = ((split /:/, $TERM->resource ("perl_lib")), "$LIBDIR/perl");
685		814
686	my %ext_arg;	815	my %ext_arg;
687		816
		817	{
		818	my @init = @TERM_INIT;
		819	@TERM_INIT = ();
		820	$_->($TERM) for @init;
		821	my @pkg = @TERM_EXT;
		822	@TERM_EXT = ();
		823	$TERM->register_package ($_) for @pkg;
		824	}
		825
688	for (map { split /,/, $TERM->resource ("perl_ext_$_") } 1, 2) {	826	for (grep $_, map { split /,/, $TERM->resource ("perl_ext_$_") } 1, 2) {
689	if ($_ eq "default") {	827	if ($_ eq "default") {
690	$ext_arg{$_} \|\|= [] for qw(selection option-popup selection-popup searchable-scrollback);	828	$ext_arg{$_} \|\|= [] for qw(selection option-popup selection-popup searchable-scrollback readline);
691	} elsif (/^-(.*)$/) {	829	} elsif (/^-(.*)$/) {
692	delete $ext_arg{$1};	830	delete $ext_arg{$1};
693	} elsif (/^([^<]+)<(.*)>$/) {	831	} elsif (/^([^<]+)<(.*)>$/) {
694	push @{ $ext_arg{$1} }, $2;	832	push @{ $ext_arg{$1} }, $2;
695	} else {	833	} else {
…		…
718	if $verbosity >= 10;	856	if $verbosity >= 10;
719		857
720	keys %$cb;	858	keys %$cb;
721		859
722	while (my ($pkg, $cb) = each %$cb) {	860	while (my ($pkg, $cb) = each %$cb) {
723	$retval = eval { $cb->($TERM->{_pkg}{$pkg}, @_) }	861	my $retval_ = eval { $cb->($TERM->{_pkg}{$pkg}, @_) };
724	and last;	862	$retval \|\|= $retval_;
725		863
726	if ($@) {	864	if ($@) {
727	$TERM->ungrab; # better to lose the grab than the session	865	$TERM->ungrab; # better to lose the grab than the session
728	warn $@;	866	warn $@;
729	}	867	}
…		…
740	# clear package	878	# clear package
741	%$TERM = ();	879	%$TERM = ();
742	}	880	}
743		881
744	$retval	882	$retval
745	}
746
747	sub exec_async(@) {
748	my $pid = fork;
749
750	return
751	if !defined $pid or $pid;
752
753	%ENV = %{ $TERM->env };
754
755	exec @_;
756	_exit 255;
757	}	883	}
758		884
759	# urxvt::term::extension	885	# urxvt::term::extension
760		886
761	package urxvt::term::extension;	887	package urxvt::term::extension;
…		…
900	# find on_xxx subs in the package and register them	1026	# find on_xxx subs in the package and register them
901	# as hooks	1027	# as hooks
902	sub register_package {	1028	sub register_package {
903	my ($self, $pkg, $argv) = @_;	1029	my ($self, $pkg, $argv) = @_;
904		1030
		1031	no strict 'refs';
		1032
		1033	urxvt::verbose 6, "register package $pkg to $self";
		1034
		1035	@{"$pkg\::ISA"} = urxvt::term::extension::;
		1036
905	my $proxy = bless {	1037	my $proxy = bless {
906	_pkg => $pkg,	1038	_pkg => $pkg,
907	argv => $argv,	1039	argv => $argv,
908	}, $pkg;	1040	}, $pkg;
909	Scalar::Util::weaken ($proxy->{term} = $self);	1041	Scalar::Util::weaken ($proxy->{term} = $self);
…		…
940		1072
941	Destroy the terminal object (close the window, free resources	1073	Destroy the terminal object (close the window, free resources
942	etc.). Please note that @@RXVT_NAME@@ will not exit as long as any event	1074	etc.). Please note that @@RXVT_NAME@@ will not exit as long as any event
943	watchers (timers, io watchers) are still active.	1075	watchers (timers, io watchers) are still active.
944		1076
		1077	=item $term->exec_async ($cmd[, @args])
		1078
		1079	Works like the combination of the C<fork>/C<exec> builtins, which executes
		1080	("starts") programs in the background. This function takes care of setting
		1081	the user environment before exec'ing the command (e.g. C<PATH>) and should
		1082	be preferred over explicit calls to C<exec> or C<system>.
		1083
		1084	Returns the pid of the subprocess or C<undef> on error.
		1085
		1086	=cut
		1087
		1088	sub exec_async {
		1089	my $self = shift;
		1090
		1091	my $pid = fork;
		1092
		1093	return $pid
		1094	if !defined $pid or $pid;
		1095
		1096	%ENV = %{ $self->env };
		1097
		1098	exec @_;
		1099	urxvt::_exit 255;
		1100	}
		1101
945	=item $isset = $term->option ($optval[, $set])	1102	=item $isset = $term->option ($optval[, $set])
946		1103
947	Returns true if the option specified by C<$optval> is enabled, and	1104	Returns true if the option specified by C<$optval> is enabled, and
948	optionally change it. All option values are stored by name in the hash	1105	optionally change it. All option values are stored by name in the hash
949	C<%urxvt::OPTION>. Options not enabled in this binary are not in the hash.	1106	C<%urxvt::OPTION>. Options not enabled in this binary are not in the hash.
…		…
951	Here is a a likely non-exhaustive list of option names, please see the	1108	Here is a a likely non-exhaustive list of option names, please see the
952	source file F</src/optinc.h> to see the actual list:	1109	source file F</src/optinc.h> to see the actual list:
953		1110
954	borderLess console cursorBlink cursorUnderline hold iconic insecure	1111	borderLess console cursorBlink cursorUnderline hold iconic insecure
955	intensityStyles jumpScroll loginShell mapAlert meta8 mouseWheelScrollPage	1112	intensityStyles jumpScroll loginShell mapAlert meta8 mouseWheelScrollPage
956	pastableTabs pointerBlank reverseVideo scrollBar scrollBar_floating	1113	override-redirect pastableTabs pointerBlank reverseVideo scrollBar
957	scrollBar_right scrollTtyKeypress scrollTtyOutput scrollWithBuffer	1114	scrollBar_floating scrollBar_right scrollTtyKeypress scrollTtyOutput
958	secondaryScreen secondaryScroll skipBuiltinGlyphs transparent	1115	scrollWithBuffer secondaryScreen secondaryScroll skipBuiltinGlyphs
959	tripleclickwords utmpInhibit visualBell	1116	transparent tripleclickwords utmpInhibit visualBell
960		1117
961	=item $value = $term->resource ($name[, $newval])	1118	=item $value = $term->resource ($name[, $newval])
962		1119
963	Returns the current resource value associated with a given name and	1120	Returns the current resource value associated with a given name and
964	optionally sets a new value. Setting values is most useful in the C<init>	1121	optionally sets a new value. Setting values is most useful in the C<init>
…		…
981		1138
982	answerbackstring backgroundPixmap backspace_key boldFont boldItalicFont	1139	answerbackstring backgroundPixmap backspace_key boldFont boldItalicFont
983	borderLess color cursorBlink cursorUnderline cutchars delete_key	1140	borderLess color cursorBlink cursorUnderline cutchars delete_key
984	display_name embed ext_bwidth fade font geometry hold iconName	1141	display_name embed ext_bwidth fade font geometry hold iconName
985	imFont imLocale inputMethod insecure int_bwidth intensityStyles	1142	imFont imLocale inputMethod insecure int_bwidth intensityStyles
986	italicFont jumpScroll lineSpace loginShell mapAlert menu meta8 modifier	1143	italicFont jumpScroll lineSpace loginShell mapAlert meta8 modifier
987	mouseWheelScrollPage name pastableTabs path perl_eval perl_ext_1 perl_ext_2	1144	mouseWheelScrollPage name override_redirect pastableTabs path perl_eval
988	perl_lib pointerBlank pointerBlankDelay preeditType print_pipe pty_fd	1145	perl_ext_1 perl_ext_2 perl_lib pointerBlank pointerBlankDelay
989	reverseVideo saveLines scrollBar scrollBar_align scrollBar_floating	1146	preeditType print_pipe pty_fd reverseVideo saveLines scrollBar
990	scrollBar_right scrollBar_thickness scrollTtyKeypress scrollTtyOutput	1147	scrollBar_align scrollBar_floating scrollBar_right scrollBar_thickness
991	scrollWithBuffer scrollstyle secondaryScreen secondaryScroll selectstyle	1148	scrollTtyKeypress scrollTtyOutput scrollWithBuffer scrollstyle
992	shade term_name title transparent transparent_all tripleclickwords	1149	secondaryScreen secondaryScroll selectstyle shade term_name title
993	utmpInhibit visualBell	1150	transient_for transparent transparent_all tripleclickwords utmpInhibit
		1151	visualBell
994		1152
995	=cut	1153	=cut
996		1154
997	sub resource($$;$) {	1155	sub resource($$;$) {
998	my ($self, $name) = (shift, shift);	1156	my ($self, $name) = (shift, shift);
…		…
1172		1330
1173	Normally its not a good idea to use this function, as programs might be	1331	Normally its not a good idea to use this function, as programs might be
1174	confused by changes in cursor position or scrolling. Its useful inside a	1332	confused by changes in cursor position or scrolling. Its useful inside a
1175	C<on_add_lines> hook, though.	1333	C<on_add_lines> hook, though.
1176		1334
		1335	=item $term->scr_change_screen ($screen)
		1336
		1337	Switch to given screen - 0 primary, 1 secondary.
		1338
1177	=item $term->cmd_parse ($octets)	1339	=item $term->cmd_parse ($octets)
1178		1340
1179	Similar to C<scr_add_lines>, but the argument must be in the	1341	Similar to C<scr_add_lines>, but the argument must be in the
1180	locale-specific encoding of the terminal and can contain command sequences	1342	locale-specific encoding of the terminal and can contain command sequences
1181	(escape codes) that will be interpreted.	1343	(escape codes) that will be interpreted.
…		…
1190		1352
1191	Replaces the event mask of the pty watcher by the given event mask. Can	1353	Replaces the event mask of the pty watcher by the given event mask. Can
1192	be used to suppress input and output handling to the pty/tty. See the	1354	be used to suppress input and output handling to the pty/tty. See the
1193	description of C<< urxvt::timer->events >>. Make sure to always restore	1355	description of C<< urxvt::timer->events >>. Make sure to always restore
1194	the previous value.	1356	the previous value.
		1357
		1358	=item $fd = $term->pty_fd
		1359
		1360	Returns the master file descriptor for the pty in use, or C<-1> if no pty
		1361	is used.
1195		1362
1196	=item $windowid = $term->parent	1363	=item $windowid = $term->parent
1197		1364
1198	Return the window id of the toplevel window.	1365	Return the window id of the toplevel window.
1199		1366
…		…
1264	=item $modifiermask = $term->ModNumLockMask	1431	=item $modifiermask = $term->ModNumLockMask
1265		1432
1266	Return the modifier masks corresponding to the "ISO Level 3 Shift" (often	1433	Return the modifier masks corresponding to the "ISO Level 3 Shift" (often
1267	AltGr), the meta key (often Alt) and the num lock key, if applicable.	1434	AltGr), the meta key (often Alt) and the num lock key, if applicable.
1268		1435
		1436	=item $screen = $term->current_screen
		1437
		1438	Returns the currently displayed screen (0 primary, 1 secondary).
		1439
		1440	=item $cursor_is_hidden = $term->hidden_cursor
		1441
		1442	Returns wether the cursor is currently hidden or not.
		1443
1269	=item $view_start = $term->view_start ([$newvalue])	1444	=item $view_start = $term->view_start ([$newvalue])
1270		1445
1271	Returns the row number of the topmost displayed line. Maximum value is	1446	Returns the row number of the topmost displayed line. Maximum value is
1272	C<0>, which displays the normal terminal contents. Lower values scroll	1447	C<0>, which displays the normal terminal contents. Lower values scroll
1273	this many lines into the scrollback buffer.	1448	this many lines into the scrollback buffer.
…		…
1292	line, starting at column C<$start_col> (default C<0>), which is useful	1467	line, starting at column C<$start_col> (default C<0>), which is useful
1293	to replace only parts of a line. The font index in the rendition will	1468	to replace only parts of a line. The font index in the rendition will
1294	automatically be updated.	1469	automatically be updated.
1295		1470
1296	C<$text> is in a special encoding: tabs and wide characters that use more	1471	C<$text> is in a special encoding: tabs and wide characters that use more
1297	than one cell when displayed are padded with urxvt::NOCHAR characters	1472	than one cell when displayed are padded with C<$urxvt::NOCHAR> (chr 65535)
1298	(C<chr 65535>). Characters with combining characters and other characters	1473	characters. Characters with combining characters and other characters that
1299	that do not fit into the normal tetx encoding will be replaced with	1474	do not fit into the normal tetx encoding will be replaced with characters
1300	characters in the private use area.	1475	in the private use area.
1301		1476
1302	You have to obey this encoding when changing text. The advantage is	1477	You have to obey this encoding when changing text. The advantage is
1303	that C<substr> and similar functions work on screen cells and not on	1478	that C<substr> and similar functions work on screen cells and not on
1304	characters.	1479	characters.
1305		1480
…		…
1480		1655
1481	Calls XUngrab for the most recent grab. Is called automatically on	1656	Calls XUngrab for the most recent grab. Is called automatically on
1482	evaluation errors, as it is better to lose the grab in the error case as	1657	evaluation errors, as it is better to lose the grab in the error case as
1483	the session.	1658	the session.
1484		1659
		1660	=item $atom = $term->XInternAtom ($atom_name[, $only_if_exists])
		1661
		1662	=item $atom_name = $term->XGetAtomName ($atom)
		1663
		1664	=item @atoms = $term->XListProperties ($window)
		1665
		1666	=item ($type,$format,$octets) = $term->XGetWindowProperty ($window, $property)
		1667
		1668	=item $term->XChangeWindowProperty ($window, $property, $type, $format, $octets)
		1669
		1670	=item $term->XDeleteProperty ($window, $property)
		1671
		1672	=item $window = $term->DefaultRootWindow
		1673
		1674	=item $term->XReparentWindow ($window, $parent, [$x, $y])
		1675
		1676	=item $term->XMapWindow ($window)
		1677
		1678	=item $term->XUnmapWindow ($window)
		1679
		1680	=item $term->XMoveResizeWindow ($window, $x, $y, $width, $height)
		1681
		1682	=item ($x, $y, $child_window) = $term->XTranslateCoordinates ($src, $dst, $x, $y)
		1683
		1684	=item $term->XChangeInput ($window, $add_events[, $del_events])
		1685
		1686	Various X or X-related functions. The C<$term> object only serves as
		1687	the source of the display, otherwise those functions map more-or-less
		1688	directory onto the X functions of the same name.
		1689
1485	=back	1690	=back
1486		1691
1487	=cut	1692	=cut
1488		1693
1489	package urxvt::popup;	1694	package urxvt::popup;
…		…
1591	# we can't hope to reproduce the locale algorithm, so nuke LC_ALL and set LC_CTYPE.	1796	# we can't hope to reproduce the locale algorithm, so nuke LC_ALL and set LC_CTYPE.
1592	delete $env->{LC_ALL};	1797	delete $env->{LC_ALL};
1593	$env->{LC_CTYPE} = $self->{term}->locale;	1798	$env->{LC_CTYPE} = $self->{term}->locale;
1594		1799
1595	urxvt::term->new ($env, "popup",	1800	urxvt::term->new ($env, "popup",
1596	"--perl-lib" => "", "--perl-ext-common" => "", "-pty-fd" => -1, "-sl" => 0, "-b" => 0,	1801	"--perl-lib" => "", "--perl-ext-common" => "",
		1802	"-pty-fd" => -1, "-sl" => 0,
		1803	"-b" => 1, "-bd" => "grey80", "-bl", "-override-redirect",
1597	"--transient-for" => $self->{term}->parent,	1804	"--transient-for" => $self->{term}->parent,
1598	"-display" => $self->{term}->display_id,	1805	"-display" => $self->{term}->display_id,
1599	"-pe" => "urxvt-popup")	1806	"-pe" => "urxvt-popup")
1600	or die "unable to create popup window\n";	1807	or die "unable to create popup window\n";
1601	}	1808	}
…		…
1606	delete $self->{term}{_destroy}{$self};	1813	delete $self->{term}{_destroy}{$self};
1607	$self->{term}->ungrab;	1814	$self->{term}->ungrab;
1608	}	1815	}
1609		1816
1610	=back	1817	=back
		1818
		1819	=cut
		1820
		1821	package urxvt::watcher;
		1822
		1823	@urxvt::timer::ISA = __PACKAGE__;
		1824	@urxvt::iow::ISA = __PACKAGE__;
		1825	@urxvt::pw::ISA = __PACKAGE__;
		1826	@urxvt::iw::ISA = __PACKAGE__;
1611		1827
1612	=head2 The C<urxvt::timer> Class	1828	=head2 The C<urxvt::timer> Class
1613		1829
1614	This class implements timer watchers/events. Time is represented as a	1830	This class implements timer watchers/events. Time is represented as a
1615	fractional number of seconds since the epoch. Example:	1831	fractional number of seconds since the epoch. Example:
…		…
1713		1929
1714	Stop watching for events on the given filehandle.	1930	Stop watching for events on the given filehandle.
1715		1931
1716	=back	1932	=back
1717		1933
		1934	=head2 The C<urxvt::iw> Class
		1935
		1936	This class implements idle watchers, that get called automatically when
		1937	the process is idle. They should return as fast as possible, after doing
		1938	some useful work.
		1939
		1940	=over 4
		1941
		1942	=item $iw = new urxvt::iw
		1943
		1944	Create a new idle watcher object in stopped state.
		1945
		1946	=item $iw = $iw->cb (sub { my ($iw) = @_; ... })
		1947
		1948	Set the callback to be called when the watcher triggers.
		1949
		1950	=item $timer = $timer->start
		1951
		1952	Start the watcher.
		1953
		1954	=item $timer = $timer->stop
		1955
		1956	Stop the watcher.
		1957
		1958	=back
		1959
		1960	=head2 The C<urxvt::pw> Class
		1961
		1962	This class implements process watchers. They create an event whenever a
		1963	process exits, after which they stop automatically.
		1964
		1965	my $pid = fork;
		1966	...
		1967	$term->{pw} = urxvt::pw
		1968	->new
		1969	->start ($pid)
		1970	->cb (sub {
		1971	my ($pw, $exit_status) = @_;
		1972	...
		1973	});
		1974
		1975	=over 4
		1976
		1977	=item $pw = new urxvt::pw
		1978
		1979	Create a new process watcher in stopped state.
		1980
		1981	=item $pw = $pw->cb (sub { my ($pw, $exit_status) = @_; ... })
		1982
		1983	Set the callback to be called when the timer triggers.
		1984
		1985	=item $pw = $timer->start ($pid)
		1986
		1987	Tells the wqtcher to start watching for process C<$pid>.
		1988
		1989	=item $pw = $pw->stop
		1990
		1991	Stop the watcher.
		1992
		1993	=back
		1994
1718	=head1 ENVIRONMENT	1995	=head1 ENVIRONMENT
1719		1996
1720	=head2 URXVT_PERL_VERBOSITY	1997	=head2 URXVT_PERL_VERBOSITY
1721		1998
1722	This variable controls the verbosity level of the perl extension. Higher	1999	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.103 by root, Wed Jan 18 11:05:09 2006 UTC vs. Revision 1.130 by root, Wed Jan 25 15:32:48 2006 UTC

Diff Legend

Comparing rxvt-unicode/src/urxvt.pm (file contents):
Revision 1.103 by root, Wed Jan 18 11:05:09 2006 UTC vs.
Revision 1.130 by root, Wed Jan 25 15:32:48 2006 UTC