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

Comparing rxvt-unicode/src/urxvt.pm (file contents):
Revision 1.95 by elmex, Tue Jan 17 13:19:45 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
…		…
76		87
77	Rot-13 the selection when activated. Used via keyboard trigger:	88	Rot-13 the selection when activated. Used via keyboard trigger:
78		89
79	URxvt.keysym.C-M-r: perl:selection:rot13	90	URxvt.keysym.C-M-r: perl:selection:rot13
80		91
81	=item remote-pastebin
82
83	Upload the selection as textfile to a remote site.
84
85	URxvt.keysym.C-M-e: perl:selection:remote-pastebin
86
87	To set the command to upload the file set this resource:
88
89	URxvt.selection-pastebin-cmd: rsync -apP % ruth:/var/www/www.ta-sa.org/files/txt/.
90
91	The % is the placeholder for the textfile. The name of the textfile is the hex encoded
92	md5 sum of the selection.
93	After an successful upload the selection will be replaced by the following url
94	(the % is the placeholder for the filename):
95
96	URxvt.selection-pastebin-url: http://www.ta-sa.org/files/txt/%
97
98	=back	92	=back
99		93
100	=item option-popup (enabled by default)	94	=item option-popup (enabled by default)
101		95
102	Binds a popup menu to Ctrl-Button2 that lets you toggle (some) options at	96	Binds a popup menu to Ctrl-Button2 that lets you toggle (some) options at
…		…
104		98
105	=item selection-popup (enabled by default)	99	=item selection-popup (enabled by default)
106		100
107	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
108	text into various other formats/action (such as uri unescaping, perl	102	text into various other formats/action (such as uri unescaping, perl
109	evalution, web-browser starting etc.), depending on content.	103	evaluation, web-browser starting etc.), depending on content.
		104
		105	Other extensions can extend this popup menu by pushing a code reference
		106	onto C<@{ $term->{selection_popup_hook} }>, that is called whenever the
		107	popup is displayed.
		108
		109	It's sole argument is the popup menu, which can be modified. The selection
		110	is in C<$_>, which can be used to decide wether to add something or not.
		111	It should either return nothing or a string and a code reference. The
		112	string will be used as button text and the code reference will be called
		113	when the button gets activated and should transform C<$_>.
		114
		115	The following will add an entry C<a to b> that transforms all C<a>s in
		116	the selection to C<b>s, but only if the selection currently contains any
		117	C<a>s:
		118
		119	push @{ $self->{term}{selection_popup_hook} }, sub {
		120	/a/ ? ("a to be" => sub { s/a/b/g }
		121	: ()
		122	};
110		123
111	=item searchable-scrollback<hotkey> (enabled by default)	124	=item searchable-scrollback<hotkey> (enabled by default)
112		125
113	Adds regex search functionality to the scrollback buffer, triggered	126	Adds regex search functionality to the scrollback buffer, triggered
114	by a hotkey (default: C<M-s>). While in search mode, normal terminal	127	by a hotkey (default: C<M-s>). While in search mode, normal terminal
…		…
121	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
122	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
123	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
124	selection.	137	selection.
125		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
126	=item selection-autotransform	164	=item selection-autotransform
127		165
128	This selection allows you to do automatic transforms on a selection	166	This selection allows you to do automatic transforms on a selection
129	whenever a selection is made.	167	whenever a selection is made.
130		168
…		…
142	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/
143		181
144	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
145	paste directly into your (vi :) editor:	183	paste directly into your (vi :) editor:
146		184
147	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/
148		186
149	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 :)
150		188
151	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
152	FILENAME line YYY."), you need a slightly more elaborate solution:	190	FILENAME line YYY."), you need a slightly more elaborate solution:
153		191
154	URxvt.selection.pattern-0: ( at .*? line \\d+\\.)	192	URxvt.selection.pattern-0: ( at .*? line \\d+[,.])
155	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/
156		194
157	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
158	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
159	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.
160		209
161	=item mark-urls	210	=item mark-urls
162		211
163	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
164	make them clickable. When middle-clicked, the program specified in the	213	make them clickable. When middle-clicked, the program specified in the
165	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
166	the URL as first argument.	215	the URL as first argument.
167		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
168	=item block-graphics-to-ascii	237	=item block-graphics-to-ascii
169		238
170	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,
171	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
172	similar-looking ascii character.	241	similar-looking ascii character.
173		242
174	=item digital-clock	243	=item digital-clock
175		244
176	Displays a digital clock using the built-in overlay.	245	Displays a digital clock using the built-in overlay.
		246
		247	=item remote-selection
		248
		249	Somewhat of a misnomer, this extension adds two menu entries to the
		250	selection popup that allows one ti run external commands to store the
		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'
		266
		267	=item selection-pastebin
		268
		269	This is a little rarely useful extension that Uploads the selection as
		270	textfile to a remote site (or does other things). (The implementation is
		271	not currently secure for use in a multiuser environment as it writes to
		272	F</tmp> directly.).
		273
		274	It listens to the C<selection-pastebin:remote-pastebin> keyboard command,
		275	i.e.
		276
		277	URxvt.keysym.C-M-e: perl:selection-pastebin:remote-pastebin
		278
		279	Pressing this combination runs a command with C<%> replaced by the name of
		280	the textfile. This command can be set via a resource:
		281
		282	URxvt.selection-pastebin.cmd: rsync -apP % ruth:/var/www/www.ta-sa.org/files/txt/.
		283
		284	And the default is likely not useful to anybody but the few people around
		285	here :)
		286
		287	The name of the textfile is the hex encoded md5 sum of the selection, so
		288	the same content should lead to the same filename.
		289
		290	After a successful upload the selection will be replaced by the text given
		291	in the C<selection-pastebin-url> resource (again, the % is the placeholder
		292	for the filename):
		293
		294	URxvt.selection-pastebin.url: http://www.ta-sa.org/files/txt/%
177		295
178	=item example-refresh-hooks	296	=item example-refresh-hooks
179		297
180	Displays a very simple digital clock in the upper right corner of the	298	Displays a very simple digital clock in the upper right corner of the
181	window. Illustrates overwriting the refresh callbacks to create your own	299	window. Illustrates overwriting the refresh callbacks to create your own
…		…
260	called whenever the relevant event happens.	378	called whenever the relevant event happens.
261		379
262	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
263	the in the C<Extension Objects> section.	381	the in the C<Extension Objects> section.
264		382
265	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
266	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
267	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.
268		386
269	I<< When in doubt, return a false value (preferably C<()>). >>	387	I<< When in doubt, return a false value (preferably C<()>). >>
270		388
271	=over 4	389	=over 4
272		390
273	=item on_init $term	391	=item on_init $term
274		392
275	Called after a new terminal object has been initialized, but before	393	Called after a new terminal object has been initialized, but before
276	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
277	call or deliver senseless data, as terminal size and other characteristics	395	call or deliver senseless data, as terminal size and other characteristics
278	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
279	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).
280		409
281	=item on_reset $term	410	=item on_reset $term
282		411
283	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
284	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
285	variables.	414	variables.
286		415
287	=item on_start $term	416	=item on_child_start $term, $pid
288		417
289	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.
290	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>.
291		424
292	=item on_sel_make $term, $eventtime	425	=item on_sel_make $term, $eventtime
293		426
294	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
295	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
…		…
404	=item on_focus_out $term	537	=item on_focus_out $term
405		538
406	Called wheneever the window loses keyboard focus, before rxvt-unicode does	539	Called wheneever the window loses keyboard focus, before rxvt-unicode does
407	focus out processing.	540	focus out processing.
408		541
		542	=item on_configure_notify $term, $event
		543
		544	=item on_property_notify $term, $event
		545
409	=item on_key_press $term, $event, $keysym, $octets	546	=item on_key_press $term, $event, $keysym, $octets
410		547
411	=item on_key_release $term, $event, $keysym	548	=item on_key_release $term, $event, $keysym
412		549
413	=item on_button_press $term, $event	550	=item on_button_press $term, $event
…		…
422		559
423	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
424	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.
425		562
426	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
427	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
428	and column under the mouse cursor.	565	(real, not screen-based) row and column under the mouse cursor.
429		566
430	C<on_key_press> additionally receives the string rxvt-unicode would	567	C<on_key_press> additionally receives the string rxvt-unicode would
431	output, if any, in locale-specific encoding.	568	output, if any, in locale-specific encoding.
432		569
433	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).
434		580
435	=back	581	=back
436		582
437	=cut	583	=cut
438		584
…		…
444	use Scalar::Util ();	590	use Scalar::Util ();
445	use List::Util ();	591	use List::Util ();
446		592
447	our $VERSION = 1;	593	our $VERSION = 1;
448	our $TERM;	594	our $TERM;
		595	our @TERM_INIT;
		596	our @TERM_EXT;
449	our @HOOKNAME;	597	our @HOOKNAME;
450	our %HOOKTYPE = map +($HOOKNAME[$_] => $_), 0..$#HOOKNAME;	598	our %HOOKTYPE = map +($HOOKNAME[$_] => $_), 0..$#HOOKNAME;
451	our %OPTION;	599	our %OPTION;
452		600
453	our $LIBDIR;	601	our $LIBDIR;
454	our $RESNAME;	602	our $RESNAME;
455	our $RESCLASS;	603	our $RESCLASS;
456	our $RXVTNAME;	604	our $RXVTNAME;
457		605
		606	our $NOCHAR = chr 0xffff;
		607
458	=head2 Variables in the C<urxvt> Package	608	=head2 Variables in the C<urxvt> Package
459		609
460	=over 4	610	=over 4
461		611
462	=item $urxvt::LIBDIR	612	=item $urxvt::LIBDIR
…		…
474		624
475	=item $urxvt::TERM	625	=item $urxvt::TERM
476		626
477	The current terminal. This variable stores the current C<urxvt::term>	627	The current terminal. This variable stores the current C<urxvt::term>
478	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>.
479		645
480	=back	646	=back
481		647
482	=head2 Functions in the C<urxvt> Package	648	=head2 Functions in the C<urxvt> Package
483		649
…		…
497		663
498	Using this function has the advantage that its output ends up in the	664	Using this function has the advantage that its output ends up in the
499	correct place, e.g. on stderr of the connecting urxvtc client.	665	correct place, e.g. on stderr of the connecting urxvtc client.
500		666
501	Messages have a size limit of 1023 bytes currently.	667	Messages have a size limit of 1023 bytes currently.
502
503	=item $is_safe = urxvt::safe
504
505	Returns true when it is safe to do potentially unsafe things, such as
506	evaluating perl code specified by the user. This is true when urxvt was
507	started setuid or setgid.
508		668
509	=item $time = urxvt::NOW	669	=item $time = urxvt::NOW
510		670
511	Returns the "current time" (as per the event loop).	671	Returns the "current time" (as per the event loop).
512		672
…		…
589	=back	749	=back
590		750
591	=cut	751	=cut
592		752
593	BEGIN {	753	BEGIN {
594	urxvt->bootstrap;
595
596	# overwrite perl's warn	754	# overwrite perl's warn
597	*CORE::GLOBAL::warn = sub {	755	*CORE::GLOBAL::warn = sub {
598	my $msg = join "", @_;	756	my $msg = join "", @_;
599	$msg .= "\n"	757	$msg .= "\n"
600	unless $msg =~ /\n$/;	758	unless $msg =~ /\n$/;
601	urxvt::warn ($msg);	759	urxvt::warn ($msg);
602	};	760	};
603
604	# %ENV is the original startup environment
605	delete $ENV{IFS};
606	delete $ENV{CDPATH};
607	delete $ENV{BASH_ENV};
608	$ENV{PATH} = "/bin:/sbin:/usr/bin:/usr/sbin:/usr/local/bin:/usr/local/sbin:/opt/bin:/opt/sbin";
609	}	761	}
		762
		763	no warnings 'utf8';
610		764
611	my $verbosity = $ENV{URXVT_PERL_VERBOSITY};	765	my $verbosity = $ENV{URXVT_PERL_VERBOSITY};
612		766
613	sub verbose {	767	sub verbose {
614	my ($level, $msg) = @_;	768	my ($level, $msg) = @_;
615	warn "$msg\n" if $level <= $verbosity;	769	warn "$msg\n" if $level <= $verbosity;
616	}	770	}
617		771
618	my $extension_pkg = "extension0000";
619	my %extension_pkg;	772	my %extension_pkg;
620		773
621	# load a single script into its own package, once only	774	# load a single script into its own package, once only
622	sub extension_package($) {	775	sub extension_package($) {
623	my ($path) = @_;	776	my ($path) = @_;
624		777
625	$extension_pkg{$path} \|\|= do {	778	$extension_pkg{$path} \|\|= do {
626	my $pkg = "urxvt::" . ($extension_pkg++);	779	$path =~ /([^\/\\]+)$/;
		780	my $pkg = $1;
		781	$pkg =~ s/[^[:word:]]/_/g;
		782	$pkg = "urxvt::ext::$pkg";
627		783
628	verbose 3, "loading extension '$path' into package '$pkg'";	784	verbose 3, "loading extension '$path' into package '$pkg'";
629		785
630	open my $fh, "<:raw", $path	786	open my $fh, "<:raw", $path
631	or die "$path: $!";	787	or die "$path: $!";
632		788
633	my $source = untaint	789	my $source =
634	"package $pkg; use strict; use utf8;\n"	790	"package $pkg; use strict; use utf8; no warnings 'utf8';\n"
635	. "use base urxvt::term::extension::;\n"
636	. "#line 1 \"$path\"\n{\n"	791	. "#line 1 \"$path\"\n{\n"
637	. (do { local $/; <$fh> })	792	. (do { local $/; <$fh> })
638	. "\n};\n1";	793	. "\n};\n1";
639		794
640	eval $source	795	eval $source
…		…
654	if ($htype == 0) { # INIT	809	if ($htype == 0) { # INIT
655	my @dirs = ((split /:/, $TERM->resource ("perl_lib")), "$LIBDIR/perl");	810	my @dirs = ((split /:/, $TERM->resource ("perl_lib")), "$LIBDIR/perl");
656		811
657	my %ext_arg;	812	my %ext_arg;
658		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
659	for (map { split /,/, $TERM->resource ("perl_ext_$_") } 1, 2) {	823	for (grep $_, map { split /,/, $TERM->resource ("perl_ext_$_") } 1, 2) {
660	if ($_ eq "default") {	824	if ($_ eq "default") {
661	$ext_arg{$_} \|\|= [] for qw(selection option-popup selection-popup searchable-scrollback);	825	$ext_arg{$_} \|\|= [] for qw(selection option-popup selection-popup searchable-scrollback readline);
662	} elsif (/^-(.*)$/) {	826	} elsif (/^-(.*)$/) {
663	delete $ext_arg{$1};	827	delete $ext_arg{$1};
664	} elsif (/^([^<]+)<(.*)>$/) {	828	} elsif (/^([^<]+)<(.*)>$/) {
665	push @{ $ext_arg{$1} }, $2;	829	push @{ $ext_arg{$1} }, $2;
666	} else {	830	} else {
…		…
689	if $verbosity >= 10;	853	if $verbosity >= 10;
690		854
691	keys %$cb;	855	keys %$cb;
692		856
693	while (my ($pkg, $cb) = each %$cb) {	857	while (my ($pkg, $cb) = each %$cb) {
694	$retval = eval { $cb->($TERM->{_pkg}{$pkg}, @_) }	858	my $retval_ = eval { $cb->($TERM->{_pkg}{$pkg}, @_) };
695	and last;	859	$retval \|\|= $retval_;
696		860
697	if ($@) {	861	if ($@) {
698	$TERM->ungrab; # better to lose the grab than the session	862	$TERM->ungrab; # better to lose the grab than the session
699	warn $@;	863	warn $@;
700	}	864	}
…		…
711	# clear package	875	# clear package
712	%$TERM = ();	876	%$TERM = ();
713	}	877	}
714		878
715	$retval	879	$retval
716	}
717
718	sub exec_async(@) {
719	my $pid = fork;
720
721	return
722	if !defined $pid or $pid;
723
724	%ENV = %{ $TERM->env };
725
726	exec @_;
727	_exit 255;
728	}	880	}
729		881
730	# urxvt::term::extension	882	# urxvt::term::extension
731		883
732	package urxvt::term::extension;	884	package urxvt::term::extension;
…		…
871	# find on_xxx subs in the package and register them	1023	# find on_xxx subs in the package and register them
872	# as hooks	1024	# as hooks
873	sub register_package {	1025	sub register_package {
874	my ($self, $pkg, $argv) = @_;	1026	my ($self, $pkg, $argv) = @_;
875		1027
		1028	no strict 'refs';
		1029
		1030	urxvt::verbose 6, "register package $pkg to $self";
		1031
		1032	@{"$pkg\::ISA"} = urxvt::term::extension::;
		1033
876	my $proxy = bless {	1034	my $proxy = bless {
877	_pkg => $pkg,	1035	_pkg => $pkg,
878	argv => $argv,	1036	argv => $argv,
879	}, $pkg;	1037	}, $pkg;
880	Scalar::Util::weaken ($proxy->{term} = $self);	1038	Scalar::Util::weaken ($proxy->{term} = $self);
…		…
911		1069
912	Destroy the terminal object (close the window, free resources	1070	Destroy the terminal object (close the window, free resources
913	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
914	watchers (timers, io watchers) are still active.	1072	watchers (timers, io watchers) are still active.
915		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
916	=item $isset = $term->option ($optval[, $set])	1099	=item $isset = $term->option ($optval[, $set])
917		1100
918	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
919	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
920	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.
…		…
922	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
923	source file F</src/optinc.h> to see the actual list:	1106	source file F</src/optinc.h> to see the actual list:
924		1107
925	borderLess console cursorBlink cursorUnderline hold iconic insecure	1108	borderLess console cursorBlink cursorUnderline hold iconic insecure
926	intensityStyles jumpScroll loginShell mapAlert meta8 mouseWheelScrollPage	1109	intensityStyles jumpScroll loginShell mapAlert meta8 mouseWheelScrollPage
927	pastableTabs pointerBlank reverseVideo scrollBar scrollBar_floating	1110	override-redirect pastableTabs pointerBlank reverseVideo scrollBar
928	scrollBar_right scrollTtyKeypress scrollTtyOutput scrollWithBuffer	1111	scrollBar_floating scrollBar_right scrollTtyKeypress scrollTtyOutput
929	secondaryScreen secondaryScroll skipBuiltinGlyphs transparent	1112	scrollWithBuffer secondaryScreen secondaryScroll skipBuiltinGlyphs
930	tripleclickwords utmpInhibit visualBell	1113	transparent tripleclickwords utmpInhibit visualBell
931		1114
932	=item $value = $term->resource ($name[, $newval])	1115	=item $value = $term->resource ($name[, $newval])
933		1116
934	Returns the current resource value associated with a given name and	1117	Returns the current resource value associated with a given name and
935	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>
…		…
952		1135
953	answerbackstring backgroundPixmap backspace_key boldFont boldItalicFont	1136	answerbackstring backgroundPixmap backspace_key boldFont boldItalicFont
954	borderLess color cursorBlink cursorUnderline cutchars delete_key	1137	borderLess color cursorBlink cursorUnderline cutchars delete_key
955	display_name embed ext_bwidth fade font geometry hold iconName	1138	display_name embed ext_bwidth fade font geometry hold iconName
956	imFont imLocale inputMethod insecure int_bwidth intensityStyles	1139	imFont imLocale inputMethod insecure int_bwidth intensityStyles
957	italicFont jumpScroll lineSpace loginShell mapAlert menu meta8 modifier	1140	italicFont jumpScroll lineSpace loginShell mapAlert meta8 modifier
958	mouseWheelScrollPage name pastableTabs path perl_eval perl_ext_1 perl_ext_2	1141	mouseWheelScrollPage name override_redirect pastableTabs path perl_eval
959	perl_lib pointerBlank pointerBlankDelay preeditType print_pipe pty_fd	1142	perl_ext_1 perl_ext_2 perl_lib pointerBlank pointerBlankDelay
960	reverseVideo saveLines scrollBar scrollBar_align scrollBar_floating	1143	preeditType print_pipe pty_fd reverseVideo saveLines scrollBar
961	scrollBar_right scrollBar_thickness scrollTtyKeypress scrollTtyOutput	1144	scrollBar_align scrollBar_floating scrollBar_right scrollBar_thickness
962	scrollWithBuffer scrollstyle secondaryScreen secondaryScroll selectstyle	1145	scrollTtyKeypress scrollTtyOutput scrollWithBuffer scrollstyle
963	shade term_name title transparent transparent_all tripleclickwords	1146	secondaryScreen secondaryScroll selectstyle shade term_name title
964	utmpInhibit visualBell	1147	transient_for transparent transparent_all tripleclickwords utmpInhibit
		1148	visualBell
965		1149
966	=cut	1150	=cut
967		1151
968	sub resource($$;$) {	1152	sub resource($$;$) {
969	my ($self, $name) = (shift, shift);	1153	my ($self, $name) = (shift, shift);
…		…
1143		1327
1144	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
1145	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
1146	C<on_add_lines> hook, though.	1330	C<on_add_lines> hook, though.
1147		1331
		1332	=item $term->scr_change_screen ($screen)
		1333
		1334	Switch to given screen - 0 primary, 1 secondary.
		1335
1148	=item $term->cmd_parse ($octets)	1336	=item $term->cmd_parse ($octets)
1149		1337
1150	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
1151	locale-specific encoding of the terminal and can contain command sequences	1339	locale-specific encoding of the terminal and can contain command sequences
1152	(escape codes) that will be interpreted.	1340	(escape codes) that will be interpreted.
…		…
1161		1349
1162	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
1163	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
1164	description of C<< urxvt::timer->events >>. Make sure to always restore	1352	description of C<< urxvt::timer->events >>. Make sure to always restore
1165	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.
1166		1359
1167	=item $windowid = $term->parent	1360	=item $windowid = $term->parent
1168		1361
1169	Return the window id of the toplevel window.	1362	Return the window id of the toplevel window.
1170		1363
…		…
1235	=item $modifiermask = $term->ModNumLockMask	1428	=item $modifiermask = $term->ModNumLockMask
1236		1429
1237	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
1238	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.
1239		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
1240	=item $view_start = $term->view_start ([$newvalue])	1441	=item $view_start = $term->view_start ([$newvalue])
1241		1442
1242	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
1243	C<0>, which displays the normal terminal contents. Lower values scroll	1444	C<0>, which displays the normal terminal contents. Lower values scroll
1244	this many lines into the scrollback buffer.	1445	this many lines into the scrollback buffer.
…		…
1263	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
1264	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
1265	automatically be updated.	1466	automatically be updated.
1266		1467
1267	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
1268	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)
1269	(C<chr 65535>). Characters with combining characters and other characters	1470	characters. Characters with combining characters and other characters that
1270	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
1271	characters in the private use area.	1472	in the private use area.
1272		1473
1273	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
1274	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
1275	characters.	1476	characters.
1276		1477
…		…
1451		1652
1452	Calls XUngrab for the most recent grab. Is called automatically on	1653	Calls XUngrab for the most recent grab. Is called automatically on
1453	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
1454	the session.	1655	the session.
1455		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
1456	=back	1687	=back
1457		1688
1458	=cut	1689	=cut
1459		1690
1460	package urxvt::popup;	1691	package urxvt::popup;
…		…
1561	my $env = $self->{term}->env;	1792	my $env = $self->{term}->env;
1562	# 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.
1563	delete $env->{LC_ALL};	1794	delete $env->{LC_ALL};
1564	$env->{LC_CTYPE} = $self->{term}->locale;	1795	$env->{LC_CTYPE} = $self->{term}->locale;
1565		1796
1566	urxvt::term->new ($env, $self->{term}->resource ("name"),	1797	urxvt::term->new ($env, "popup",
1567	"--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",
1568	"--transient-for" => $self->{term}->parent,	1801	"--transient-for" => $self->{term}->parent,
1569	"-display" => $self->{term}->display_id,	1802	"-display" => $self->{term}->display_id,
1570	"-pe" => "urxvt-popup")	1803	"-pe" => "urxvt-popup")
1571	or die "unable to create popup window\n";	1804	or die "unable to create popup window\n";
1572	}	1805	}
…		…
1577	delete $self->{term}{_destroy}{$self};	1810	delete $self->{term}{_destroy}{$self};
1578	$self->{term}->ungrab;	1811	$self->{term}->ungrab;
1579	}	1812	}
1580		1813
1581	=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__;
1582		1824
1583	=head2 The C<urxvt::timer> Class	1825	=head2 The C<urxvt::timer> Class
1584		1826
1585	This class implements timer watchers/events. Time is represented as a	1827	This class implements timer watchers/events. Time is represented as a
1586	fractional number of seconds since the epoch. Example:	1828	fractional number of seconds since the epoch. Example:
…		…
1624	Start the timer.	1866	Start the timer.
1625		1867
1626	=item $timer = $timer->start ($tstamp)	1868	=item $timer = $timer->start ($tstamp)
1627		1869
1628	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>.
1629		1875
1630	=item $timer = $timer->stop	1876	=item $timer = $timer->stop
1631		1877
1632	Stop the timer.	1878	Stop the timer.
1633		1879
…		…
1680		1926
1681	Stop watching for events on the given filehandle.	1927	Stop watching for events on the given filehandle.
1682		1928
1683	=back	1929	=back
1684		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
1685	=head1 ENVIRONMENT	1992	=head1 ENVIRONMENT
1686		1993
1687	=head2 URXVT_PERL_VERBOSITY	1994	=head2 URXVT_PERL_VERBOSITY
1688		1995
1689	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.95 by elmex, Tue Jan 17 13:19:45 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.95 by elmex, Tue Jan 17 13:19:45 2006 UTC vs.
Revision 1.129 by root, Wed Jan 25 15:11:31 2006 UTC