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

Comparing rxvt-unicode/src/urxvt.pm (file contents):
Revision 1.107 by root, Wed Jan 18 21:30:50 2006 UTC vs.
Revision 1.135 by root, Sun Feb 12 05:31:53 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
…		…
83	=item option-popup (enabled by default)	94	=item option-popup (enabled by default)
84		95
85	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
86	runtime.	97	runtime.
87		98
		99	Other extensions can extend this popup menu by pushing a code reference
		100	onto C<@{ $term->{option_popup_hook} }>, which gets called whenever the
		101	popup is being displayed.
		102
		103	It's sole argument is the popup menu, which can be modified. It should
		104	either return nothing or a string, the initial boolean value and a code
		105	reference. The string will be used as button text and the code reference
		106	will be called when the toggle changes, with the new boolean value as
		107	first argument.
		108
		109	The following will add an entry C<myoption> that changes
		110	C<$self->{myoption}>:
		111
		112	push @{ $self->{term}{option_popup_hook} }, sub {
		113	("my option" => $myoption, sub { $self->{myoption} = $_[0] })
		114	};
		115
88	=item selection-popup (enabled by default)	116	=item selection-popup (enabled by default)
89		117
90	Binds a popup menu to Ctrl-Button3 that lets you convert the selection	118	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	119	text into various other formats/action (such as uri unescaping, perl
92	evalution, web-browser starting etc.), depending on content.	120	evaluation, web-browser starting etc.), depending on content.
93		121
94	Other extensions can extend this popup menu by pushing a code reference onto	122	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.	123	onto C<@{ $term->{selection_popup_hook} }>, which gets called whenever the
		124	popup is being displayed.
96		125
97	It's sole argument is the popup menu, which can be modified. The selection	126	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.	127	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	128	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	129	string will be used as button text and the code reference will be called
…		…
102		131
103	The following will add an entry C<a to b> that transforms all C<a>s in	132	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	133	the selection to C<b>s, but only if the selection currently contains any
105	C<a>s:	134	C<a>s:
106		135
107	push urxvt::ext::selection_popup::hook, sub {	136	push @{ $self->{term}{selection_popup_hook} }, sub {
108	/a/ ? ("a to be" => sub { s/a/b/g }	137	/a/ ? ("a to be" => sub { s/a/b/g }
109	: ()	138	: ()
110	};	139	};
111		140
112	=item searchable-scrollback<hotkey> (enabled by default)	141	=item searchable-scrollback<hotkey> (enabled by default)
…		…
122	bottom. C<Escape> leaves search mode and returns to the point where search	151	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	152	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	153	additionally stores the first match in the current line into the primary
125	selection.	154	selection.
126		155
		156	=item readline (enabled by default)
		157
		158	A support package that tries to make editing with readline easier. At
		159	the moment, it reacts to clicking shift-left mouse button by trying to
		160	move the text cursor to this position. It does so by generating as many
		161	cursor-left or cursor-right keypresses as required (the this only works
		162	for programs that correctly support wide characters).
		163
		164	To avoid too many false positives, this is only done when:
		165
		166	=over 4
		167
		168	=item - the tty is in ICANON state.
		169
		170	=item - the text cursor is visible.
		171
		172	=item - the primary screen is currently being displayed.
		173
		174	=item - the mouse is on the same (multi-row-) line as the text cursor.
		175
		176	=back
		177
		178	The normal selection mechanism isn't disabled, so quick successive clicks
		179	might interfere with selection creation in harmless ways.
		180
127	=item selection-autotransform	181	=item selection-autotransform
128		182
129	This selection allows you to do automatic transforms on a selection	183	This selection allows you to do automatic transforms on a selection
130	whenever a selection is made.	184	whenever a selection is made.
131		185
…		…
143	URxvt.selection-autotransform.0: s/^([^:[:space:]]+):(\\d+):?$/vi +$2 \\Q$1\\E\\x0d/	197	URxvt.selection-autotransform.0: s/^([^:[:space:]]+):(\\d+):?$/vi +$2 \\Q$1\\E\\x0d/
144		198
145	And this example matches the same,but replaces it with vi-commands you can	199	And this example matches the same,but replaces it with vi-commands you can
146	paste directly into your (vi :) editor:	200	paste directly into your (vi :) editor:
147		201
148	URxvt.selection-autotransform.0: s/^([^:[:space:]]+(\\d+):?$/\\x1b:e \\Q$1\\E\\x0d:$2\\x0d/	202	URxvt.selection-autotransform.0: s/^([^:[:space:]]+(\\d+):?$/:e \\Q$1\\E\\x0d:$2\\x0d/
149		203
150	Of course, this can be modified to suit your needs and your editor :)	204	Of course, this can be modified to suit your needs and your editor :)
151		205
152	To expand the example above to typical perl error messages ("XXX at	206	To expand the example above to typical perl error messages ("XXX at
153	FILENAME line YYY."), you need a slightly more elaborate solution:	207	FILENAME line YYY."), you need a slightly more elaborate solution:
154		208
155	URxvt.selection.pattern-0: ( at .*? line \\d+\\.)	209	URxvt.selection.pattern-0: ( at .*? line \\d+[,.])
156	URxvt.selection-autotransform.0: s/^ at (.*?) line (\\d+)\\.$/\x1b:e \\Q$1\E\\x0d:$2\\x0d/	210	URxvt.selection-autotransform.0: s/^ at (.*?) line (\\d+)[,.]$/:e \\Q$1\E\\x0d:$2\\x0d/
157		211
158	The first line tells the selection code to treat the unchanging part of	212	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	213	every error message as a selection pattern, and the second line transforms
160	the message into vi commands to load the file.	214	the message into vi commands to load the file.
		215
		216	=item tabbed
		217
		218	This transforms the terminal into a tabbar with additional terminals, that
		219	is, it implements what is commonly refered to as "tabbed terminal". The topmost line
		220	displays a "[NEW]" button, which, when clicked, will add a new tab, followed by one
		221	button per tab.
		222
		223	Clicking a button will activate that tab. Pressing B<Shift-Left> and
		224	B<Shift-Right> will switch to the tab left or right of the current one,
		225	while B<Shift-Down> creates a new tab.
		226
		227	The tabbar itself can be configured similarly to a normal terminal, but
		228	with a resource class of C<URxvt.tabbed>. In addition, it supports the
		229	following four resources (shown with defaults):
		230
		231	URxvt.tabbed.tabbar-fg: <colour-index, default 3>
		232	URxvt.tabbed.tabbar-bg: <colour-index, default 0>
		233	URxvt.tabbed.tab-fg: <colour-index, default 0>
		234	URxvt.tabbed.tab-bg: <colour-index, default 1>
		235
		236	See I<COLOR AND GRAPHICS> in the @@RXVT_NAME@@(1) manpage for valid
		237	indices.
161		238
162	=item mark-urls	239	=item mark-urls
163		240
164	Uses per-line display filtering (C<on_line_update>) to underline urls and	241	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	242	make them clickable. When middle-clicked, the program specified in the
166	resource C<urlLauncher> (default C<x-www-browser>) will be started with	243	resource C<urlLauncher> (default C<x-www-browser>) will be started with
167	the URL as first argument.	244	the URL as first argument.
168		245
		246	=item xim-onthespot
		247
		248	This (experimental) perl extension implements OnTheSpot editing. It does
		249	not work perfectly, and some input methods don't seem to work well with
		250	OnTheSpot editing in general, but it seems to work at leats for SCIM and
		251	kinput2.
		252
		253	You enable it by specifying this extension and a preedit style of
		254	C<OnTheSpot>, i.e.:
		255
		256	@@RXVT_NAME@@ -pt OnTheSpot -pe xim-onthespot
		257
169	=item automove-background	258	=item automove-background
170		259
171	This is basically a one-line extension that dynamically changes the background pixmap offset	260	This is basically a one-line extension that dynamically changes the background pixmap offset
172	to the window position, in effect creating the same effect as pseudo transparency with	261	to the window position, in effect creating the same effect as pseudo transparency with
173	a custom pixmap. No scaling is supported in this mode. Exmaple:	262	a custom pixmap. No scaling is supported in this mode. Exmaple:
…		…
182		271
183	=item digital-clock	272	=item digital-clock
184		273
185	Displays a digital clock using the built-in overlay.	274	Displays a digital clock using the built-in overlay.
186		275
187	=item example-refresh-hooks	276	=item remote-clipboard
188		277
189	Displays a very simple digital clock in the upper right corner of the	278	Somewhat of a misnomer, this extension adds two menu entries to the
190	window. Illustrates overwriting the refresh callbacks to create your own	279	selection popup that allows one ti run external commands to store the
191	overlays or changes.	280	selection somewhere and fetch it again.
		281
		282	We use it to implement a "distributed selection mechanism", which just
		283	means that one command uploads the file to a remote server, and another
		284	reads it.
		285
		286	The commands can be set using the C<URxvt.remote-selection.store> and
		287	C<URxvt.remote-selection.fetch> resources. The first should read the
		288	selection to store from STDIN (always in UTF-8), the second should provide
		289	the selection data on STDOUT (also in UTF-8).
		290
		291	The defaults (which are likely useless to you) use rsh and cat:
		292
		293	URxvt.remote-selection.store: rsh ruth 'cat >/tmp/distributed-selection'
		294	URxvt.remote-selection.fetch: rsh ruth 'cat /tmp/distributed-selection'
192		295
193	=item selection-pastebin	296	=item selection-pastebin
194		297
195	This is a little rarely useful extension that Uploads the selection as	298	This is a little rarely useful extension that Uploads the selection as
196	textfile to a remote site (or does other things). (The implementation is	299	textfile to a remote site (or does other things). (The implementation is
…		…
216	After a successful upload the selection will be replaced by the text given	319	After a successful upload the selection will be replaced by the text given
217	in the C<selection-pastebin-url> resource (again, the % is the placeholder	320	in the C<selection-pastebin-url> resource (again, the % is the placeholder
218	for the filename):	321	for the filename):
219		322
220	URxvt.selection-pastebin.url: http://www.ta-sa.org/files/txt/%	323	URxvt.selection-pastebin.url: http://www.ta-sa.org/files/txt/%
		324
		325	=item example-refresh-hooks
		326
		327	Displays a very simple digital clock in the upper right corner of the
		328	window. Illustrates overwriting the refresh callbacks to create your own
		329	overlays or changes.
221		330
222	=back	331	=back
223		332
224	=head1 API DOCUMENTATION	333	=head1 API DOCUMENTATION
225		334
…		…
298	called whenever the relevant event happens.	407	called whenever the relevant event happens.
299		408
300	The first argument passed to them is an extension oject as described in	409	The first argument passed to them is an extension oject as described in
301	the in the C<Extension Objects> section.	410	the in the C<Extension Objects> section.
302		411
303	B<All> of these hooks must return a boolean value. If it is true, then the	412	B<All> of these hooks must return a boolean value. If any of the called
304	event counts as being I<consumed>, and the invocation of other hooks is	413	hooks returns true, then the event counts as being I<consumed>, and the
305	skipped, and the relevant action might not be carried out by the C++ code.	414	relevant action might not be carried out by the C++ code.
306		415
307	I<< When in doubt, return a false value (preferably C<()>). >>	416	I<< When in doubt, return a false value (preferably C<()>). >>
308		417
309	=over 4	418	=over 4
310		419
311	=item on_init $term	420	=item on_init $term
312		421
313	Called after a new terminal object has been initialized, but before	422	Called after a new terminal object has been initialized, but before
314	windows are created or the command gets run. Most methods are unsafe to	423	windows are created or the command gets run. Most methods are unsafe to
315	call or deliver senseless data, as terminal size and other characteristics	424	call or deliver senseless data, as terminal size and other characteristics
316	have not yet been determined. You can safely query and change resources,	425	have not yet been determined. You can safely query and change resources
317	though.	426	and options, though. For many purposes the C<on_start> hook is a better
		427	place.
		428
		429	=item on_start $term
		430
		431	Called at the very end of initialisation of a new terminal, just before
		432	trying to map (display) the toplevel and returning to the mainloop.
		433
		434	=item on_destroy $term
		435
		436	Called whenever something tries to destroy terminal, when the terminal is
		437	still fully functional (not for long, though).
318		438
319	=item on_reset $term	439	=item on_reset $term
320		440
321	Called after the screen is "reset" for any reason, such as resizing or	441	Called after the screen is "reset" for any reason, such as resizing or
322	control sequences. Here is where you can react on changes to size-related	442	control sequences. Here is where you can react on changes to size-related
323	variables.	443	variables.
324		444
325	=item on_start $term	445	=item on_child_start $term, $pid
326		446
327	Called at the very end of initialisation of a new terminal, just before	447	Called just after the child process has been C<fork>ed.
328	returning to the mainloop.	448
		449	=item on_child_exit $term, $status
		450
		451	Called just after the child process has exited. C<$status> is the status
		452	from C<waitpid>.
329		453
330	=item on_sel_make $term, $eventtime	454	=item on_sel_make $term, $eventtime
331		455
332	Called whenever a selection has been made by the user, but before the	456	Called whenever a selection has been made by the user, but before the
333	selection text is copied, so changes to the beginning, end or type of the	457	selection text is copied, so changes to the beginning, end or type of the
…		…
420		544
421	=item on_refresh_end $term	545	=item on_refresh_end $term
422		546
423	Called just after the screen gets redrawn. See C<on_refresh_begin>.	547	Called just after the screen gets redrawn. See C<on_refresh_begin>.
424		548
425	=item on_keyboard_command $term, $string	549	=item on_user_command $term, $string
426		550
427	Called whenever the user presses a key combination that has a	551	Called whenever the a user-configured event is being activated (e.g. via
428	C<perl:string> action bound to it (see description of the B<keysym>	552	a C<perl:string> action bound to a key, see description of the B<keysym>
429	resource in the @@RXVT_NAME@@(1) manpage).	553	resource in the @@RXVT_NAME@@(1) manpage).
		554
		555	The event is simply the action string. This interface is assumed to change
		556	slightly in the future.
		557
		558	=item on_resize_all_windows $tern, $new_width, $new_height
		559
		560	Called just after the new window size has been calculcated, but before
		561	windows are actually being resized or hints are being set. If this hook
		562	returns TRUE, setting of the window hints is being skipped.
430		563
431	=item on_x_event $term, $event	564	=item on_x_event $term, $event
432		565
433	Called on every X event received on the vt window (and possibly other	566	Called on every X event received on the vt window (and possibly other
434	windows). Should only be used as a last resort. Most event structure	567	windows). Should only be used as a last resort. Most event structure
…		…
444	Called wheneever the window loses keyboard focus, before rxvt-unicode does	577	Called wheneever the window loses keyboard focus, before rxvt-unicode does
445	focus out processing.	578	focus out processing.
446		579
447	=item on_configure_notify $term, $event	580	=item on_configure_notify $term, $event
448		581
		582	=item on_property_notify $term, $event
		583
449	=item on_key_press $term, $event, $keysym, $octets	584	=item on_key_press $term, $event, $keysym, $octets
450		585
451	=item on_key_release $term, $event, $keysym	586	=item on_key_release $term, $event, $keysym
452		587
453	=item on_button_press $term, $event	588	=item on_button_press $term, $event
…		…
462		597
463	Called whenever the corresponding X event is received for the terminal If	598	Called whenever the corresponding X event is received for the terminal If
464	the hook returns true, then the even will be ignored by rxvt-unicode.	599	the hook returns true, then the even will be ignored by rxvt-unicode.
465		600
466	The event is a hash with most values as named by Xlib (see the XEvent	601	The event is a hash with most values as named by Xlib (see the XEvent
467	manpage), with the additional members C<row> and C<col>, which are the row	602	manpage), with the additional members C<row> and C<col>, which are the
468	and column under the mouse cursor.	603	(real, not screen-based) row and column under the mouse cursor.
469		604
470	C<on_key_press> additionally receives the string rxvt-unicode would	605	C<on_key_press> additionally receives the string rxvt-unicode would
471	output, if any, in locale-specific encoding.	606	output, if any, in locale-specific encoding.
472		607
473	subwindow.	608	subwindow.
		609
		610	=item on_client_message $term, $event
		611
		612	=item on_wm_protocols $term, $event
		613
		614	=item on_wm_delete_window $term, $event
		615
		616	Called when various types of ClientMessage events are received (all with
		617	format=32, WM_PROTOCOLS or WM_PROTOCOLS:WM_DELETE_WINDOW).
474		618
475	=back	619	=back
476		620
477	=cut	621	=cut
478		622
…		…
484	use Scalar::Util ();	628	use Scalar::Util ();
485	use List::Util ();	629	use List::Util ();
486		630
487	our $VERSION = 1;	631	our $VERSION = 1;
488	our $TERM;	632	our $TERM;
		633	our @TERM_INIT;
		634	our @TERM_EXT;
489	our @HOOKNAME;	635	our @HOOKNAME;
490	our %HOOKTYPE = map +($HOOKNAME[$_] => $_), 0..$#HOOKNAME;	636	our %HOOKTYPE = map +($HOOKNAME[$_] => $_), 0..$#HOOKNAME;
491	our %OPTION;	637	our %OPTION;
492		638
493	our $LIBDIR;	639	our $LIBDIR;
494	our $RESNAME;	640	our $RESNAME;
495	our $RESCLASS;	641	our $RESCLASS;
496	our $RXVTNAME;	642	our $RXVTNAME;
497		643
		644	our $NOCHAR = chr 0xffff;
		645
498	=head2 Variables in the C<urxvt> Package	646	=head2 Variables in the C<urxvt> Package
499		647
500	=over 4	648	=over 4
501		649
502	=item $urxvt::LIBDIR	650	=item $urxvt::LIBDIR
…		…
514		662
515	=item $urxvt::TERM	663	=item $urxvt::TERM
516		664
517	The current terminal. This variable stores the current C<urxvt::term>	665	The current terminal. This variable stores the current C<urxvt::term>
518	object, whenever a callback/hook is executing.	666	object, whenever a callback/hook is executing.
		667
		668	=item @urxvt::TERM_INIT
		669
		670	All coderefs in this array will be called as methods of the next newly
		671	created C<urxvt::term> object (during the C<on_init> phase). The array
		672	gets cleared before the codereferences that were in it are being executed,
		673	so coderefs can push themselves onto it again if they so desire.
		674
		675	This complements to the perl-eval commandline option, but gets executed
		676	first.
		677
		678	=item @urxvt::TERM_EXT
		679
		680	Works similar to C<@TERM_INIT>, but contains perl package/class names, which
		681	get registered as normal extensions after calling the hooks in C<@TERM_INIT>
		682	but before other extensions. Gets cleared just like C<@TERM_INIT>.
519		683
520	=back	684	=back
521		685
522	=head2 Functions in the C<urxvt> Package	686	=head2 Functions in the C<urxvt> Package
523		687
…		…
537		701
538	Using this function has the advantage that its output ends up in the	702	Using this function has the advantage that its output ends up in the
539	correct place, e.g. on stderr of the connecting urxvtc client.	703	correct place, e.g. on stderr of the connecting urxvtc client.
540		704
541	Messages have a size limit of 1023 bytes currently.	705	Messages have a size limit of 1023 bytes currently.
		706
		707	=item @terms = urxvt::termlist
		708
		709	Returns all urxvt::term objects that exist in this process, regardless of
		710	wether they are started, being destroyed etc., so be careful. Only term
		711	objects that have perl extensions attached will be returned (because there
		712	is no urxvt::term objet associated with others).
542		713
543	=item $time = urxvt::NOW	714	=item $time = urxvt::NOW
544		715
545	Returns the "current time" (as per the event loop).	716	Returns the "current time" (as per the event loop).
546		717
…		…
604	Return the foreground/background colour index, respectively.	775	Return the foreground/background colour index, respectively.
605		776
606	=item $rend = urxvt::SET_FGCOLOR $rend, $new_colour	777	=item $rend = urxvt::SET_FGCOLOR $rend, $new_colour
607		778
608	=item $rend = urxvt::SET_BGCOLOR $rend, $new_colour	779	=item $rend = urxvt::SET_BGCOLOR $rend, $new_colour
		780
		781	=item $rend = urxvt::SET_COLOR $rend, $new_fg, $new_bg
609		782
610	Replace the foreground/background colour in the rendition mask with the	783	Replace the foreground/background colour in the rendition mask with the
611	specified one.	784	specified one.
612		785
613	=item $value = urxvt::GET_CUSTOM $rend	786	=item $value = urxvt::GET_CUSTOM $rend
…		…
632	unless $msg =~ /\n$/;	805	unless $msg =~ /\n$/;
633	urxvt::warn ($msg);	806	urxvt::warn ($msg);
634	};	807	};
635	}	808	}
636		809
		810	no warnings 'utf8';
		811
637	my $verbosity = $ENV{URXVT_PERL_VERBOSITY};	812	my $verbosity = $ENV{URXVT_PERL_VERBOSITY};
638		813
639	sub verbose {	814	sub verbose {
640	my ($level, $msg) = @_;	815	my ($level, $msg) = @_;
641	warn "$msg\n" if $level <= $verbosity;	816	warn "$msg\n" if $level <= $verbosity;
…		…
644	my %extension_pkg;	819	my %extension_pkg;
645		820
646	# load a single script into its own package, once only	821	# load a single script into its own package, once only
647	sub extension_package($) {	822	sub extension_package($) {
648	my ($path) = @_;	823	my ($path) = @_;
649
650	no strict 'refs';
651		824
652	$extension_pkg{$path} \|\|= do {	825	$extension_pkg{$path} \|\|= do {
653	$path =~ /([^\/\\]+)$/;	826	$path =~ /([^\/\\]+)$/;
654	my $pkg = $1;	827	my $pkg = $1;
655	$pkg =~ s/[^[:word:]]/_/g;	828	$pkg =~ s/[^[:word:]]/_/g;
…		…
658	verbose 3, "loading extension '$path' into package '$pkg'";	831	verbose 3, "loading extension '$path' into package '$pkg'";
659		832
660	open my $fh, "<:raw", $path	833	open my $fh, "<:raw", $path
661	or die "$path: $!";	834	or die "$path: $!";
662		835
663	@{"$pkg\::ISA"} = urxvt::term::extension::;
664
665	my $source =	836	my $source =
666	"package $pkg; use strict; use utf8;\n"	837	"package $pkg; use strict; use utf8; no warnings 'utf8';\n"
667	. "#line 1 \"$path\"\n{\n"	838	. "#line 1 \"$path\"\n{\n"
668	. (do { local $/; <$fh> })	839	. (do { local $/; <$fh> })
669	. "\n};\n1";	840	. "\n};\n1";
670		841
671	eval $source	842	eval $source
…		…
685	if ($htype == 0) { # INIT	856	if ($htype == 0) { # INIT
686	my @dirs = ((split /:/, $TERM->resource ("perl_lib")), "$LIBDIR/perl");	857	my @dirs = ((split /:/, $TERM->resource ("perl_lib")), "$LIBDIR/perl");
687		858
688	my %ext_arg;	859	my %ext_arg;
689		860
		861	{
		862	my @init = @TERM_INIT;
		863	@TERM_INIT = ();
		864	$_->($TERM) for @init;
		865	my @pkg = @TERM_EXT;
		866	@TERM_EXT = ();
		867	$TERM->register_package ($_) for @pkg;
		868	}
		869
690	for (map { split /,/, $TERM->resource ("perl_ext_$_") } 1, 2) {	870	for (grep $_, map { split /,/, $TERM->resource ("perl_ext_$_") } 1, 2) {
691	if ($_ eq "default") {	871	if ($_ eq "default") {
692	$ext_arg{$_} \|\|= [] for qw(selection option-popup selection-popup searchable-scrollback);	872	$ext_arg{$_} \|\|= [] for qw(selection option-popup selection-popup searchable-scrollback readline);
693	} elsif (/^-(.*)$/) {	873	} elsif (/^-(.*)$/) {
694	delete $ext_arg{$1};	874	delete $ext_arg{$1};
695	} elsif (/^([^<]+)<(.*)>$/) {	875	} elsif (/^([^<]+)<(.*)>$/) {
696	push @{ $ext_arg{$1} }, $2;	876	push @{ $ext_arg{$1} }, $2;
697	} else {	877	} else {
698	$ext_arg{$_} \|\|= [];	878	$ext_arg{$_} \|\|= [];
699	}	879	}
700	}	880	}
701		881
702	while (my ($ext, $argv) = each %ext_arg) {	882	for my $ext (sort keys %ext_arg) {
703	my @files = grep -f $_, map "$_/$ext", @dirs;	883	my @files = grep -f $_, map "$_/$ext", @dirs;
704		884
705	if (@files) {	885	if (@files) {
706	$TERM->register_package (extension_package $files[0], $argv);	886	$TERM->register_package (extension_package $files[0], $ext_arg{$ext});
707	} else {	887	} else {
708	warn "perl extension '$ext' not found in perl library search path\n";	888	warn "perl extension '$ext' not found in perl library search path\n";
709	}	889	}
710	}	890	}
711		891
…		…
720	if $verbosity >= 10;	900	if $verbosity >= 10;
721		901
722	keys %$cb;	902	keys %$cb;
723		903
724	while (my ($pkg, $cb) = each %$cb) {	904	while (my ($pkg, $cb) = each %$cb) {
725	$retval = eval { $cb->($TERM->{_pkg}{$pkg}, @_) }	905	my $retval_ = eval { $cb->($TERM->{_pkg}{$pkg}, @_) };
726	and last;	906	$retval \|\|= $retval_;
727		907
728	if ($@) {	908	if ($@) {
729	$TERM->ungrab; # better to lose the grab than the session	909	$TERM->ungrab; # better to lose the grab than the session
730	warn $@;	910	warn $@;
731	}	911	}
…		…
744	}	924	}
745		925
746	$retval	926	$retval
747	}	927	}
748		928
749	sub exec_async(@) {	929	sub SET_COLOR($$$) {
750	my $pid = fork;	930	SET_BGCOLOR (SET_FGCOLOR ($_[0], $_[1]), $_[2])
751
752	return
753	if !defined $pid or $pid;
754
755	%ENV = %{ $TERM->env };
756
757	exec @_;
758	_exit 255;
759	}	931	}
760		932
761	# urxvt::term::extension	933	# urxvt::term::extension
762		934
763	package urxvt::term::extension;	935	package urxvt::term::extension;
…		…
902	# find on_xxx subs in the package and register them	1074	# find on_xxx subs in the package and register them
903	# as hooks	1075	# as hooks
904	sub register_package {	1076	sub register_package {
905	my ($self, $pkg, $argv) = @_;	1077	my ($self, $pkg, $argv) = @_;
906		1078
		1079	no strict 'refs';
		1080
		1081	urxvt::verbose 6, "register package $pkg to $self";
		1082
		1083	@{"$pkg\::ISA"} = urxvt::term::extension::;
		1084
907	my $proxy = bless {	1085	my $proxy = bless {
908	_pkg => $pkg,	1086	_pkg => $pkg,
909	argv => $argv,	1087	argv => $argv,
910	}, $pkg;	1088	}, $pkg;
911	Scalar::Util::weaken ($proxy->{term} = $self);	1089	Scalar::Util::weaken ($proxy->{term} = $self);
…		…
926	hash which defines the environment of the new terminal.	1104	hash which defines the environment of the new terminal.
927		1105
928	Croaks (and probably outputs an error message) if the new instance	1106	Croaks (and probably outputs an error message) if the new instance
929	couldn't be created. Returns C<undef> if the new instance didn't	1107	couldn't be created. Returns C<undef> if the new instance didn't
930	initialise perl, and the terminal object otherwise. The C<init> and	1108	initialise perl, and the terminal object otherwise. The C<init> and
931	C<start> hooks will be called during this call.	1109	C<start> hooks will be called before this call returns, and are free to
		1110	refer to global data (which is race free).
932		1111
933	=cut	1112	=cut
934		1113
935	sub new {	1114	sub new {
936	my ($class, $env, @args) = @_;	1115	my ($class, $env, @args) = @_;
937		1116
		1117	$env or Carp::croak "environment hash missing in call to urxvt::term->new";
		1118	@args or Carp::croak "name argument missing in call to urxvt::term->new";
		1119
938	_new ([ map "$_=$env->{$_}", keys %$env ], @args);	1120	_new ([ map "$_=$env->{$_}", keys %$env ], \@args);
939	}	1121	}
940		1122
941	=item $term->destroy	1123	=item $term->destroy
942		1124
943	Destroy the terminal object (close the window, free resources	1125	Destroy the terminal object (close the window, free resources
944	etc.). Please note that @@RXVT_NAME@@ will not exit as long as any event	1126	etc.). Please note that @@RXVT_NAME@@ will not exit as long as any event
945	watchers (timers, io watchers) are still active.	1127	watchers (timers, io watchers) are still active.
		1128
		1129	=item $term->exec_async ($cmd[, @args])
		1130
		1131	Works like the combination of the C<fork>/C<exec> builtins, which executes
		1132	("starts") programs in the background. This function takes care of setting
		1133	the user environment before exec'ing the command (e.g. C<PATH>) and should
		1134	be preferred over explicit calls to C<exec> or C<system>.
		1135
		1136	Returns the pid of the subprocess or C<undef> on error.
		1137
		1138	=cut
		1139
		1140	sub exec_async {
		1141	my $self = shift;
		1142
		1143	my $pid = fork;
		1144
		1145	return $pid
		1146	if !defined $pid or $pid;
		1147
		1148	%ENV = %{ $self->env };
		1149
		1150	exec @_;
		1151	urxvt::_exit 255;
		1152	}
946		1153
947	=item $isset = $term->option ($optval[, $set])	1154	=item $isset = $term->option ($optval[, $set])
948		1155
949	Returns true if the option specified by C<$optval> is enabled, and	1156	Returns true if the option specified by C<$optval> is enabled, and
950	optionally change it. All option values are stored by name in the hash	1157	optionally change it. All option values are stored by name in the hash
…		…
1175		1382
1176	Normally its not a good idea to use this function, as programs might be	1383	Normally its not a good idea to use this function, as programs might be
1177	confused by changes in cursor position or scrolling. Its useful inside a	1384	confused by changes in cursor position or scrolling. Its useful inside a
1178	C<on_add_lines> hook, though.	1385	C<on_add_lines> hook, though.
1179		1386
		1387	=item $term->scr_change_screen ($screen)
		1388
		1389	Switch to given screen - 0 primary, 1 secondary.
		1390
1180	=item $term->cmd_parse ($octets)	1391	=item $term->cmd_parse ($octets)
1181		1392
1182	Similar to C<scr_add_lines>, but the argument must be in the	1393	Similar to C<scr_add_lines>, but the argument must be in the
1183	locale-specific encoding of the terminal and can contain command sequences	1394	locale-specific encoding of the terminal and can contain command sequences
1184	(escape codes) that will be interpreted.	1395	(escape codes) that will be interpreted.
…		…
1194	Replaces the event mask of the pty watcher by the given event mask. Can	1405	Replaces the event mask of the pty watcher by the given event mask. Can
1195	be used to suppress input and output handling to the pty/tty. See the	1406	be used to suppress input and output handling to the pty/tty. See the
1196	description of C<< urxvt::timer->events >>. Make sure to always restore	1407	description of C<< urxvt::timer->events >>. Make sure to always restore
1197	the previous value.	1408	the previous value.
1198		1409
		1410	=item $fd = $term->pty_fd
		1411
		1412	Returns the master file descriptor for the pty in use, or C<-1> if no pty
		1413	is used.
		1414
1199	=item $windowid = $term->parent	1415	=item $windowid = $term->parent
1200		1416
1201	Return the window id of the toplevel window.	1417	Return the window id of the toplevel window.
1202		1418
1203	=item $windowid = $term->vt	1419	=item $windowid = $term->vt
…		…
1208		1424
1209	Adds the specified events to the vt event mask. Useful e.g. when you want	1425	Adds the specified events to the vt event mask. Useful e.g. when you want
1210	to receive pointer events all the times:	1426	to receive pointer events all the times:
1211		1427
1212	$term->vt_emask_add (urxvt::PointerMotionMask);	1428	$term->vt_emask_add (urxvt::PointerMotionMask);
		1429
		1430	=item $term->focus_in
		1431
		1432	=item $term->focus_out
		1433
		1434	=item $term->key_press ($state, $keycode[, $time])
		1435
		1436	=item $term->key_release ($state, $keycode[, $time])
		1437
		1438	Deliver various fake events to to terminal.
1213		1439
1214	=item $window_width = $term->width	1440	=item $window_width = $term->width
1215		1441
1216	=item $window_height = $term->height	1442	=item $window_height = $term->height
1217		1443
…		…
1267	=item $modifiermask = $term->ModNumLockMask	1493	=item $modifiermask = $term->ModNumLockMask
1268		1494
1269	Return the modifier masks corresponding to the "ISO Level 3 Shift" (often	1495	Return the modifier masks corresponding to the "ISO Level 3 Shift" (often
1270	AltGr), the meta key (often Alt) and the num lock key, if applicable.	1496	AltGr), the meta key (often Alt) and the num lock key, if applicable.
1271		1497
		1498	=item $screen = $term->current_screen
		1499
		1500	Returns the currently displayed screen (0 primary, 1 secondary).
		1501
		1502	=item $cursor_is_hidden = $term->hidden_cursor
		1503
		1504	Returns wether the cursor is currently hidden or not.
		1505
1272	=item $view_start = $term->view_start ([$newvalue])	1506	=item $view_start = $term->view_start ([$newvalue])
1273		1507
1274	Returns the row number of the topmost displayed line. Maximum value is	1508	Returns the row number of the topmost displayed line. Maximum value is
1275	C<0>, which displays the normal terminal contents. Lower values scroll	1509	C<0>, which displays the normal terminal contents. Lower values scroll
1276	this many lines into the scrollback buffer.	1510	this many lines into the scrollback buffer.
…		…
1295	line, starting at column C<$start_col> (default C<0>), which is useful	1529	line, starting at column C<$start_col> (default C<0>), which is useful
1296	to replace only parts of a line. The font index in the rendition will	1530	to replace only parts of a line. The font index in the rendition will
1297	automatically be updated.	1531	automatically be updated.
1298		1532
1299	C<$text> is in a special encoding: tabs and wide characters that use more	1533	C<$text> is in a special encoding: tabs and wide characters that use more
1300	than one cell when displayed are padded with urxvt::NOCHAR characters	1534	than one cell when displayed are padded with C<$urxvt::NOCHAR> (chr 65535)
1301	(C<chr 65535>). Characters with combining characters and other characters	1535	characters. Characters with combining characters and other characters that
1302	that do not fit into the normal tetx encoding will be replaced with	1536	do not fit into the normal tetx encoding will be replaced with characters
1303	characters in the private use area.	1537	in the private use area.
1304		1538
1305	You have to obey this encoding when changing text. The advantage is	1539	You have to obey this encoding when changing text. The advantage is
1306	that C<substr> and similar functions work on screen cells and not on	1540	that C<substr> and similar functions work on screen cells and not on
1307	characters.	1541	characters.
1308		1542
…		…
1455	=item $string = $term->special_decode $text	1689	=item $string = $term->special_decode $text
1456		1690
1457	Converts rxvt-unicodes text reprsentation into a perl string. See	1691	Converts rxvt-unicodes text reprsentation into a perl string. See
1458	C<< $term->ROW_t >> for details.	1692	C<< $term->ROW_t >> for details.
1459		1693
1460	=item $success = $term->grab_button ($button, $modifiermask)	1694	=item $success = $term->grab_button ($button, $modifiermask[, $window = $term->vt])
1461		1695
		1696	=item $term->ungrab_button ($button, $modifiermask[, $window = $term->vt])
		1697
1462	Registers a synchronous button grab. See the XGrabButton manpage.	1698	Register/unregister a synchronous button grab. See the XGrabButton
		1699	manpage.
1463		1700
1464	=item $success = $term->grab ($eventtime[, $sync])	1701	=item $success = $term->grab ($eventtime[, $sync])
1465		1702
1466	Calls XGrabPointer and XGrabKeyboard in asynchronous (default) or	1703	Calls XGrabPointer and XGrabKeyboard in asynchronous (default) or
1467	synchronous (C<$sync> is true). Also remembers the grab timestampe.	1704	synchronous (C<$sync> is true). Also remembers the grab timestampe.
…		…
1482	=item $term->ungrab	1719	=item $term->ungrab
1483		1720
1484	Calls XUngrab for the most recent grab. Is called automatically on	1721	Calls XUngrab for the most recent grab. Is called automatically on
1485	evaluation errors, as it is better to lose the grab in the error case as	1722	evaluation errors, as it is better to lose the grab in the error case as
1486	the session.	1723	the session.
		1724
		1725	=item $atom = $term->XInternAtom ($atom_name[, $only_if_exists])
		1726
		1727	=item $atom_name = $term->XGetAtomName ($atom)
		1728
		1729	=item @atoms = $term->XListProperties ($window)
		1730
		1731	=item ($type,$format,$octets) = $term->XGetWindowProperty ($window, $property)
		1732
		1733	=item $term->XChangeWindowProperty ($window, $property, $type, $format, $octets)
		1734
		1735	=item $term->XDeleteProperty ($window, $property)
		1736
		1737	=item $window = $term->DefaultRootWindow
		1738
		1739	=item $term->XReparentWindow ($window, $parent, [$x, $y])
		1740
		1741	=item $term->XMapWindow ($window)
		1742
		1743	=item $term->XUnmapWindow ($window)
		1744
		1745	=item $term->XMoveResizeWindow ($window, $x, $y, $width, $height)
		1746
		1747	=item ($x, $y, $child_window) = $term->XTranslateCoordinates ($src, $dst, $x, $y)
		1748
		1749	=item $term->XChangeInput ($window, $add_events[, $del_events])
		1750
		1751	Various X or X-related functions. The C<$term> object only serves as
		1752	the source of the display, otherwise those functions map more-or-less
		1753	directory onto the X functions of the same name.
1487		1754
1488	=back	1755	=back
1489		1756
1490	=cut	1757	=cut
1491		1758
…		…
1555	my ($self, $text, $cb) = @_;	1822	my ($self, $text, $cb) = @_;
1556		1823
1557	$self->add_item ({ type => "button", text => $text, activate => $cb});	1824	$self->add_item ({ type => "button", text => $text, activate => $cb});
1558	}	1825	}
1559		1826
1560	=item $popup->add_toggle ($text, $cb, $initial_value)	1827	=item $popup->add_toggle ($text, $initial_value, $cb)
1561		1828
1562	Adds a toggle/checkbox item to the popup. Teh callback gets called	1829	Adds a toggle/checkbox item to the popup. The callback gets called
1563	whenever it gets toggled, with a boolean indicating its value as its first	1830	whenever it gets toggled, with a boolean indicating its new value as its
1564	argument.	1831	first argument.
1565		1832
1566	=cut	1833	=cut
1567		1834
1568	sub add_toggle {	1835	sub add_toggle {
1569	my ($self, $text, $cb, $value) = @_;	1836	my ($self, $text, $value, $cb) = @_;
1570		1837
1571	my $item; $item = {	1838	my $item; $item = {
1572	type => "button",	1839	type => "button",
1573	text => " $text",	1840	text => " $text",
1574	value => $value,	1841	value => $value,
…		…
1611	delete $self->{term}{_destroy}{$self};	1878	delete $self->{term}{_destroy}{$self};
1612	$self->{term}->ungrab;	1879	$self->{term}->ungrab;
1613	}	1880	}
1614		1881
1615	=back	1882	=back
		1883
		1884	=cut
		1885
		1886	package urxvt::watcher;
		1887
		1888	@urxvt::timer::ISA = __PACKAGE__;
		1889	@urxvt::iow::ISA = __PACKAGE__;
		1890	@urxvt::pw::ISA = __PACKAGE__;
		1891	@urxvt::iw::ISA = __PACKAGE__;
1616		1892
1617	=head2 The C<urxvt::timer> Class	1893	=head2 The C<urxvt::timer> Class
1618		1894
1619	This class implements timer watchers/events. Time is represented as a	1895	This class implements timer watchers/events. Time is represented as a
1620	fractional number of seconds since the epoch. Example:	1896	fractional number of seconds since the epoch. Example:
…		…
1718		1994
1719	Stop watching for events on the given filehandle.	1995	Stop watching for events on the given filehandle.
1720		1996
1721	=back	1997	=back
1722		1998
		1999	=head2 The C<urxvt::iw> Class
		2000
		2001	This class implements idle watchers, that get called automatically when
		2002	the process is idle. They should return as fast as possible, after doing
		2003	some useful work.
		2004
		2005	=over 4
		2006
		2007	=item $iw = new urxvt::iw
		2008
		2009	Create a new idle watcher object in stopped state.
		2010
		2011	=item $iw = $iw->cb (sub { my ($iw) = @_; ... })
		2012
		2013	Set the callback to be called when the watcher triggers.
		2014
		2015	=item $timer = $timer->start
		2016
		2017	Start the watcher.
		2018
		2019	=item $timer = $timer->stop
		2020
		2021	Stop the watcher.
		2022
		2023	=back
		2024
		2025	=head2 The C<urxvt::pw> Class
		2026
		2027	This class implements process watchers. They create an event whenever a
		2028	process exits, after which they stop automatically.
		2029
		2030	my $pid = fork;
		2031	...
		2032	$term->{pw} = urxvt::pw
		2033	->new
		2034	->start ($pid)
		2035	->cb (sub {
		2036	my ($pw, $exit_status) = @_;
		2037	...
		2038	});
		2039
		2040	=over 4
		2041
		2042	=item $pw = new urxvt::pw
		2043
		2044	Create a new process watcher in stopped state.
		2045
		2046	=item $pw = $pw->cb (sub { my ($pw, $exit_status) = @_; ... })
		2047
		2048	Set the callback to be called when the timer triggers.
		2049
		2050	=item $pw = $timer->start ($pid)
		2051
		2052	Tells the wqtcher to start watching for process C<$pid>.
		2053
		2054	=item $pw = $pw->stop
		2055
		2056	Stop the watcher.
		2057
		2058	=back
		2059
1723	=head1 ENVIRONMENT	2060	=head1 ENVIRONMENT
1724		2061
1725	=head2 URXVT_PERL_VERBOSITY	2062	=head2 URXVT_PERL_VERBOSITY
1726		2063
1727	This variable controls the verbosity level of the perl extension. Higher	2064	This variable controls the verbosity level of the perl extension. Higher

Diff Legend

-–
+Removed lines
-+
+Added lines
-<
+Changed lines
->
+Changed lines

Comparing rxvt-unicode/src/urxvt.pm (file contents): Revision 1.107 by root, Wed Jan 18 21:30:50 2006 UTC vs. Revision 1.135 by root, Sun Feb 12 05:31:53 2006 UTC

Diff Legend

Comparing rxvt-unicode/src/urxvt.pm (file contents):
Revision 1.107 by root, Wed Jan 18 21:30:50 2006 UTC vs.
Revision 1.135 by root, Sun Feb 12 05:31:53 2006 UTC