[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.132 by root, Mon Feb 6 05:40:15 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.
		209
		210	The tabbar itself can be configured similarly to a normal terminal, but
		211	with a resource class of C<URxvt.tabbed>. In addition, it supports the
		212	following four resources (shown with defaults):
		213
		214	URxvt.tabbed.tabbar-fg: <colour-index, default 3>
		215	URxvt.tabbed.tabbar-bg: <colour-index, default 0>
		216	URxvt.tabbed.tab-fg: <colour-index, default 0>
		217	URxvt.tabbed.tab-bg: <colour-index, default 1>
		218
		219	See I<COLOR AND GRAPHICS> in the @@RXVT_NAME@@(1) manpage for valid
		220	indices.
161		221
162	=item mark-urls	222	=item mark-urls
163		223
164	Uses per-line display filtering (C<on_line_update>) to underline urls and	224	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	225	make them clickable. When middle-clicked, the program specified in the
166	resource C<urlLauncher> (default C<x-www-browser>) will be started with	226	resource C<urlLauncher> (default C<x-www-browser>) will be started with
167	the URL as first argument.	227	the URL as first argument.
168		228
		229	=item xim-onthespot
		230
		231	This (experimental) perl extension implements OnTheSpot editing. It does
		232	not work perfectly, and some input methods don't seem to work well with
		233	OnTheSpot editing in general, but it seems to work at leats for SCIM and
		234	kinput2.
		235
		236	You enable it by specifying this extension and a preedit style of
		237	C<OnTheSpot>, i.e.:
		238
		239	@@RXVT_NAME@@ -pt OnTheSpot -pe xim-onthespot
		240
169	=item automove-background	241	=item automove-background
170		242
171	This is basically a one-line extension that dynamically changes the background pixmap offset	243	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	244	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:	245	a custom pixmap. No scaling is supported in this mode. Exmaple:
…		…
182		254
183	=item digital-clock	255	=item digital-clock
184		256
185	Displays a digital clock using the built-in overlay.	257	Displays a digital clock using the built-in overlay.
186		258
187	=item example-refresh-hooks	259	=item remote-clipboard
188		260
189	Displays a very simple digital clock in the upper right corner of the	261	Somewhat of a misnomer, this extension adds two menu entries to the
190	window. Illustrates overwriting the refresh callbacks to create your own	262	selection popup that allows one ti run external commands to store the
191	overlays or changes.	263	selection somewhere and fetch it again.
		264
		265	We use it to implement a "distributed selection mechanism", which just
		266	means that one command uploads the file to a remote server, and another
		267	reads it.
		268
		269	The commands can be set using the C<URxvt.remote-selection.store> and
		270	C<URxvt.remote-selection.fetch> resources. The first should read the
		271	selection to store from STDIN (always in UTF-8), the second should provide
		272	the selection data on STDOUT (also in UTF-8).
		273
		274	The defaults (which are likely useless to you) use rsh and cat:
		275
		276	URxvt.remote-selection.store: rsh ruth 'cat >/tmp/distributed-selection'
		277	URxvt.remote-selection.fetch: rsh ruth 'cat /tmp/distributed-selection'
192		278
193	=item selection-pastebin	279	=item selection-pastebin
194		280
195	This is a little rarely useful extension that Uploads the selection as	281	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	282	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	302	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	303	in the C<selection-pastebin-url> resource (again, the % is the placeholder
218	for the filename):	304	for the filename):
219		305
220	URxvt.selection-pastebin.url: http://www.ta-sa.org/files/txt/%	306	URxvt.selection-pastebin.url: http://www.ta-sa.org/files/txt/%
		307
		308	=item example-refresh-hooks
		309
		310	Displays a very simple digital clock in the upper right corner of the
		311	window. Illustrates overwriting the refresh callbacks to create your own
		312	overlays or changes.
221		313
222	=back	314	=back
223		315
224	=head1 API DOCUMENTATION	316	=head1 API DOCUMENTATION
225		317
…		…
298	called whenever the relevant event happens.	390	called whenever the relevant event happens.
299		391
300	The first argument passed to them is an extension oject as described in	392	The first argument passed to them is an extension oject as described in
301	the in the C<Extension Objects> section.	393	the in the C<Extension Objects> section.
302		394
303	B<All> of these hooks must return a boolean value. If it is true, then the	395	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	396	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.	397	relevant action might not be carried out by the C++ code.
306		398
307	I<< When in doubt, return a false value (preferably C<()>). >>	399	I<< When in doubt, return a false value (preferably C<()>). >>
308		400
309	=over 4	401	=over 4
310		402
311	=item on_init $term	403	=item on_init $term
312		404
313	Called after a new terminal object has been initialized, but before	405	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	406	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	407	call or deliver senseless data, as terminal size and other characteristics
316	have not yet been determined. You can safely query and change resources,	408	have not yet been determined. You can safely query and change resources
317	though.	409	and options, though. For many purposes the C<on_start> hook is a better
		410	place.
		411
		412	=item on_start $term
		413
		414	Called at the very end of initialisation of a new terminal, just before
		415	trying to map (display) the toplevel and returning to the mainloop.
		416
		417	=item on_destroy $term
		418
		419	Called whenever something tries to destroy terminal, when the terminal is
		420	still fully functional (not for long, though).
318		421
319	=item on_reset $term	422	=item on_reset $term
320		423
321	Called after the screen is "reset" for any reason, such as resizing or	424	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	425	control sequences. Here is where you can react on changes to size-related
323	variables.	426	variables.
324		427
325	=item on_start $term	428	=item on_child_start $term, $pid
326		429
327	Called at the very end of initialisation of a new terminal, just before	430	Called just after the child process has been C<fork>ed.
328	returning to the mainloop.	431
		432	=item on_child_exit $term, $status
		433
		434	Called just after the child process has exited. C<$status> is the status
		435	from C<waitpid>.
329		436
330	=item on_sel_make $term, $eventtime	437	=item on_sel_make $term, $eventtime
331		438
332	Called whenever a selection has been made by the user, but before the	439	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	440	selection text is copied, so changes to the beginning, end or type of the
…		…
420		527
421	=item on_refresh_end $term	528	=item on_refresh_end $term
422		529
423	Called just after the screen gets redrawn. See C<on_refresh_begin>.	530	Called just after the screen gets redrawn. See C<on_refresh_begin>.
424		531
425	=item on_keyboard_command $term, $string	532	=item on_user_command $term, $string
426		533
427	Called whenever the user presses a key combination that has a	534	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>	535	a C<perl:string> action bound to a key, see description of the B<keysym>
429	resource in the @@RXVT_NAME@@(1) manpage).	536	resource in the @@RXVT_NAME@@(1) manpage).
		537
		538	The event is simply the action string. This interface is assumed to change
		539	slightly in the future.
430		540
431	=item on_x_event $term, $event	541	=item on_x_event $term, $event
432		542
433	Called on every X event received on the vt window (and possibly other	543	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	544	windows). Should only be used as a last resort. Most event structure
…		…
444	Called wheneever the window loses keyboard focus, before rxvt-unicode does	554	Called wheneever the window loses keyboard focus, before rxvt-unicode does
445	focus out processing.	555	focus out processing.
446		556
447	=item on_configure_notify $term, $event	557	=item on_configure_notify $term, $event
448		558
		559	=item on_property_notify $term, $event
		560
449	=item on_key_press $term, $event, $keysym, $octets	561	=item on_key_press $term, $event, $keysym, $octets
450		562
451	=item on_key_release $term, $event, $keysym	563	=item on_key_release $term, $event, $keysym
452		564
453	=item on_button_press $term, $event	565	=item on_button_press $term, $event
…		…
462		574
463	Called whenever the corresponding X event is received for the terminal If	575	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.	576	the hook returns true, then the even will be ignored by rxvt-unicode.
465		577
466	The event is a hash with most values as named by Xlib (see the XEvent	578	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	579	manpage), with the additional members C<row> and C<col>, which are the
468	and column under the mouse cursor.	580	(real, not screen-based) row and column under the mouse cursor.
469		581
470	C<on_key_press> additionally receives the string rxvt-unicode would	582	C<on_key_press> additionally receives the string rxvt-unicode would
471	output, if any, in locale-specific encoding.	583	output, if any, in locale-specific encoding.
472		584
473	subwindow.	585	subwindow.
		586
		587	=item on_client_message $term, $event
		588
		589	=item on_wm_protocols $term, $event
		590
		591	=item on_wm_delete_window $term, $event
		592
		593	Called when various types of ClientMessage events are received (all with
		594	format=32, WM_PROTOCOLS or WM_PROTOCOLS:WM_DELETE_WINDOW).
474		595
475	=back	596	=back
476		597
477	=cut	598	=cut
478		599
…		…
484	use Scalar::Util ();	605	use Scalar::Util ();
485	use List::Util ();	606	use List::Util ();
486		607
487	our $VERSION = 1;	608	our $VERSION = 1;
488	our $TERM;	609	our $TERM;
		610	our @TERM_INIT;
		611	our @TERM_EXT;
489	our @HOOKNAME;	612	our @HOOKNAME;
490	our %HOOKTYPE = map +($HOOKNAME[$_] => $_), 0..$#HOOKNAME;	613	our %HOOKTYPE = map +($HOOKNAME[$_] => $_), 0..$#HOOKNAME;
491	our %OPTION;	614	our %OPTION;
492		615
493	our $LIBDIR;	616	our $LIBDIR;
494	our $RESNAME;	617	our $RESNAME;
495	our $RESCLASS;	618	our $RESCLASS;
496	our $RXVTNAME;	619	our $RXVTNAME;
497		620
		621	our $NOCHAR = chr 0xffff;
		622
498	=head2 Variables in the C<urxvt> Package	623	=head2 Variables in the C<urxvt> Package
499		624
500	=over 4	625	=over 4
501		626
502	=item $urxvt::LIBDIR	627	=item $urxvt::LIBDIR
…		…
514		639
515	=item $urxvt::TERM	640	=item $urxvt::TERM
516		641
517	The current terminal. This variable stores the current C<urxvt::term>	642	The current terminal. This variable stores the current C<urxvt::term>
518	object, whenever a callback/hook is executing.	643	object, whenever a callback/hook is executing.
		644
		645	=item @urxvt::TERM_INIT
		646
		647	All coderefs in this array will be called as methods of the next newly
		648	created C<urxvt::term> object (during the C<on_init> phase). The array
		649	gets cleared before the codereferences that were in it are being executed,
		650	so coderefs can push themselves onto it again if they so desire.
		651
		652	This complements to the perl-eval commandline option, but gets executed
		653	first.
		654
		655	=item @urxvt::TERM_EXT
		656
		657	Works similar to C<@TERM_INIT>, but contains perl package/class names, which
		658	get registered as normal extensions after calling the hooks in C<@TERM_INIT>
		659	but before other extensions. Gets cleared just like C<@TERM_INIT>.
519		660
520	=back	661	=back
521		662
522	=head2 Functions in the C<urxvt> Package	663	=head2 Functions in the C<urxvt> Package
523		664
…		…
537		678
538	Using this function has the advantage that its output ends up in the	679	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.	680	correct place, e.g. on stderr of the connecting urxvtc client.
540		681
541	Messages have a size limit of 1023 bytes currently.	682	Messages have a size limit of 1023 bytes currently.
		683
		684	=item @terms = urxvt::termlist
		685
		686	Returns all urxvt::term objects that exist in this process, regardless of
		687	wether they are started, being destroyed etc., so be careful. Only term
		688	objects that have perl extensions attached will be returned (because there
		689	is no urxvt::term objet associated with others).
542		690
543	=item $time = urxvt::NOW	691	=item $time = urxvt::NOW
544		692
545	Returns the "current time" (as per the event loop).	693	Returns the "current time" (as per the event loop).
546		694
…		…
604	Return the foreground/background colour index, respectively.	752	Return the foreground/background colour index, respectively.
605		753
606	=item $rend = urxvt::SET_FGCOLOR $rend, $new_colour	754	=item $rend = urxvt::SET_FGCOLOR $rend, $new_colour
607		755
608	=item $rend = urxvt::SET_BGCOLOR $rend, $new_colour	756	=item $rend = urxvt::SET_BGCOLOR $rend, $new_colour
		757
		758	=item $rend = urxvt::SET_COLOR $rend, $new_fg, $new_bg
609		759
610	Replace the foreground/background colour in the rendition mask with the	760	Replace the foreground/background colour in the rendition mask with the
611	specified one.	761	specified one.
612		762
613	=item $value = urxvt::GET_CUSTOM $rend	763	=item $value = urxvt::GET_CUSTOM $rend
…		…
632	unless $msg =~ /\n$/;	782	unless $msg =~ /\n$/;
633	urxvt::warn ($msg);	783	urxvt::warn ($msg);
634	};	784	};
635	}	785	}
636		786
		787	no warnings 'utf8';
		788
637	my $verbosity = $ENV{URXVT_PERL_VERBOSITY};	789	my $verbosity = $ENV{URXVT_PERL_VERBOSITY};
638		790
639	sub verbose {	791	sub verbose {
640	my ($level, $msg) = @_;	792	my ($level, $msg) = @_;
641	warn "$msg\n" if $level <= $verbosity;	793	warn "$msg\n" if $level <= $verbosity;
…		…
644	my %extension_pkg;	796	my %extension_pkg;
645		797
646	# load a single script into its own package, once only	798	# load a single script into its own package, once only
647	sub extension_package($) {	799	sub extension_package($) {
648	my ($path) = @_;	800	my ($path) = @_;
649
650	no strict 'refs';
651		801
652	$extension_pkg{$path} \|\|= do {	802	$extension_pkg{$path} \|\|= do {
653	$path =~ /([^\/\\]+)$/;	803	$path =~ /([^\/\\]+)$/;
654	my $pkg = $1;	804	my $pkg = $1;
655	$pkg =~ s/[^[:word:]]/_/g;	805	$pkg =~ s/[^[:word:]]/_/g;
…		…
658	verbose 3, "loading extension '$path' into package '$pkg'";	808	verbose 3, "loading extension '$path' into package '$pkg'";
659		809
660	open my $fh, "<:raw", $path	810	open my $fh, "<:raw", $path
661	or die "$path: $!";	811	or die "$path: $!";
662		812
663	@{"$pkg\::ISA"} = urxvt::term::extension::;
664
665	my $source =	813	my $source =
666	"package $pkg; use strict; use utf8;\n"	814	"package $pkg; use strict; use utf8; no warnings 'utf8';\n"
667	. "#line 1 \"$path\"\n{\n"	815	. "#line 1 \"$path\"\n{\n"
668	. (do { local $/; <$fh> })	816	. (do { local $/; <$fh> })
669	. "\n};\n1";	817	. "\n};\n1";
670		818
671	eval $source	819	eval $source
…		…
685	if ($htype == 0) { # INIT	833	if ($htype == 0) { # INIT
686	my @dirs = ((split /:/, $TERM->resource ("perl_lib")), "$LIBDIR/perl");	834	my @dirs = ((split /:/, $TERM->resource ("perl_lib")), "$LIBDIR/perl");
687		835
688	my %ext_arg;	836	my %ext_arg;
689		837
		838	{
		839	my @init = @TERM_INIT;
		840	@TERM_INIT = ();
		841	$_->($TERM) for @init;
		842	my @pkg = @TERM_EXT;
		843	@TERM_EXT = ();
		844	$TERM->register_package ($_) for @pkg;
		845	}
		846
690	for (map { split /,/, $TERM->resource ("perl_ext_$_") } 1, 2) {	847	for (grep $_, map { split /,/, $TERM->resource ("perl_ext_$_") } 1, 2) {
691	if ($_ eq "default") {	848	if ($_ eq "default") {
692	$ext_arg{$_} \|\|= [] for qw(selection option-popup selection-popup searchable-scrollback);	849	$ext_arg{$_} \|\|= [] for qw(selection option-popup selection-popup searchable-scrollback readline);
693	} elsif (/^-(.*)$/) {	850	} elsif (/^-(.*)$/) {
694	delete $ext_arg{$1};	851	delete $ext_arg{$1};
695	} elsif (/^([^<]+)<(.*)>$/) {	852	} elsif (/^([^<]+)<(.*)>$/) {
696	push @{ $ext_arg{$1} }, $2;	853	push @{ $ext_arg{$1} }, $2;
697	} else {	854	} else {
…		…
720	if $verbosity >= 10;	877	if $verbosity >= 10;
721		878
722	keys %$cb;	879	keys %$cb;
723		880
724	while (my ($pkg, $cb) = each %$cb) {	881	while (my ($pkg, $cb) = each %$cb) {
725	$retval = eval { $cb->($TERM->{_pkg}{$pkg}, @_) }	882	my $retval_ = eval { $cb->($TERM->{_pkg}{$pkg}, @_) };
726	and last;	883	$retval \|\|= $retval_;
727		884
728	if ($@) {	885	if ($@) {
729	$TERM->ungrab; # better to lose the grab than the session	886	$TERM->ungrab; # better to lose the grab than the session
730	warn $@;	887	warn $@;
731	}	888	}
…		…
744	}	901	}
745		902
746	$retval	903	$retval
747	}	904	}
748		905
749	sub exec_async(@) {	906	sub SET_COLOR($$$) {
750	my $pid = fork;	907	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	}	908	}
760		909
761	# urxvt::term::extension	910	# urxvt::term::extension
762		911
763	package urxvt::term::extension;	912	package urxvt::term::extension;
…		…
902	# find on_xxx subs in the package and register them	1051	# find on_xxx subs in the package and register them
903	# as hooks	1052	# as hooks
904	sub register_package {	1053	sub register_package {
905	my ($self, $pkg, $argv) = @_;	1054	my ($self, $pkg, $argv) = @_;
906		1055
		1056	no strict 'refs';
		1057
		1058	urxvt::verbose 6, "register package $pkg to $self";
		1059
		1060	@{"$pkg\::ISA"} = urxvt::term::extension::;
		1061
907	my $proxy = bless {	1062	my $proxy = bless {
908	_pkg => $pkg,	1063	_pkg => $pkg,
909	argv => $argv,	1064	argv => $argv,
910	}, $pkg;	1065	}, $pkg;
911	Scalar::Util::weaken ($proxy->{term} = $self);	1066	Scalar::Util::weaken ($proxy->{term} = $self);
…		…
926	hash which defines the environment of the new terminal.	1081	hash which defines the environment of the new terminal.
927		1082
928	Croaks (and probably outputs an error message) if the new instance	1083	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	1084	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	1085	initialise perl, and the terminal object otherwise. The C<init> and
931	C<start> hooks will be called during this call.	1086	C<start> hooks will be called before this call returns, and are free to
		1087	refer to global data (which is race free).
932		1088
933	=cut	1089	=cut
934		1090
935	sub new {	1091	sub new {
936	my ($class, $env, @args) = @_;	1092	my ($class, $env, @args) = @_;
937		1093
		1094	$env or Carp::croak "environment hash missing in call to urxvt::term->new";
		1095	@args or Carp::croak "name argument missing in call to urxvt::term->new";
		1096
938	_new ([ map "$_=$env->{$_}", keys %$env ], @args);	1097	_new ([ map "$_=$env->{$_}", keys %$env ], \@args);
939	}	1098	}
940		1099
941	=item $term->destroy	1100	=item $term->destroy
942		1101
943	Destroy the terminal object (close the window, free resources	1102	Destroy the terminal object (close the window, free resources
944	etc.). Please note that @@RXVT_NAME@@ will not exit as long as any event	1103	etc.). Please note that @@RXVT_NAME@@ will not exit as long as any event
945	watchers (timers, io watchers) are still active.	1104	watchers (timers, io watchers) are still active.
		1105
		1106	=item $term->exec_async ($cmd[, @args])
		1107
		1108	Works like the combination of the C<fork>/C<exec> builtins, which executes
		1109	("starts") programs in the background. This function takes care of setting
		1110	the user environment before exec'ing the command (e.g. C<PATH>) and should
		1111	be preferred over explicit calls to C<exec> or C<system>.
		1112
		1113	Returns the pid of the subprocess or C<undef> on error.
		1114
		1115	=cut
		1116
		1117	sub exec_async {
		1118	my $self = shift;
		1119
		1120	my $pid = fork;
		1121
		1122	return $pid
		1123	if !defined $pid or $pid;
		1124
		1125	%ENV = %{ $self->env };
		1126
		1127	exec @_;
		1128	urxvt::_exit 255;
		1129	}
946		1130
947	=item $isset = $term->option ($optval[, $set])	1131	=item $isset = $term->option ($optval[, $set])
948		1132
949	Returns true if the option specified by C<$optval> is enabled, and	1133	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	1134	optionally change it. All option values are stored by name in the hash
…		…
1175		1359
1176	Normally its not a good idea to use this function, as programs might be	1360	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	1361	confused by changes in cursor position or scrolling. Its useful inside a
1178	C<on_add_lines> hook, though.	1362	C<on_add_lines> hook, though.
1179		1363
		1364	=item $term->scr_change_screen ($screen)
		1365
		1366	Switch to given screen - 0 primary, 1 secondary.
		1367
1180	=item $term->cmd_parse ($octets)	1368	=item $term->cmd_parse ($octets)
1181		1369
1182	Similar to C<scr_add_lines>, but the argument must be in the	1370	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	1371	locale-specific encoding of the terminal and can contain command sequences
1184	(escape codes) that will be interpreted.	1372	(escape codes) that will be interpreted.
…		…
1194	Replaces the event mask of the pty watcher by the given event mask. Can	1382	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	1383	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	1384	description of C<< urxvt::timer->events >>. Make sure to always restore
1197	the previous value.	1385	the previous value.
1198		1386
		1387	=item $fd = $term->pty_fd
		1388
		1389	Returns the master file descriptor for the pty in use, or C<-1> if no pty
		1390	is used.
		1391
1199	=item $windowid = $term->parent	1392	=item $windowid = $term->parent
1200		1393
1201	Return the window id of the toplevel window.	1394	Return the window id of the toplevel window.
1202		1395
1203	=item $windowid = $term->vt	1396	=item $windowid = $term->vt
…		…
1208		1401
1209	Adds the specified events to the vt event mask. Useful e.g. when you want	1402	Adds the specified events to the vt event mask. Useful e.g. when you want
1210	to receive pointer events all the times:	1403	to receive pointer events all the times:
1211		1404
1212	$term->vt_emask_add (urxvt::PointerMotionMask);	1405	$term->vt_emask_add (urxvt::PointerMotionMask);
		1406
		1407	=item $term->focus_in
		1408
		1409	=item $term->focus_out
		1410
		1411	=item $term->key_press ($state, $keycode[, $time])
		1412
		1413	=item $term->key_release ($state, $keycode[, $time])
		1414
		1415	Deliver various fake events to to terminal.
1213		1416
1214	=item $window_width = $term->width	1417	=item $window_width = $term->width
1215		1418
1216	=item $window_height = $term->height	1419	=item $window_height = $term->height
1217		1420
…		…
1267	=item $modifiermask = $term->ModNumLockMask	1470	=item $modifiermask = $term->ModNumLockMask
1268		1471
1269	Return the modifier masks corresponding to the "ISO Level 3 Shift" (often	1472	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.	1473	AltGr), the meta key (often Alt) and the num lock key, if applicable.
1271		1474
		1475	=item $screen = $term->current_screen
		1476
		1477	Returns the currently displayed screen (0 primary, 1 secondary).
		1478
		1479	=item $cursor_is_hidden = $term->hidden_cursor
		1480
		1481	Returns wether the cursor is currently hidden or not.
		1482
1272	=item $view_start = $term->view_start ([$newvalue])	1483	=item $view_start = $term->view_start ([$newvalue])
1273		1484
1274	Returns the row number of the topmost displayed line. Maximum value is	1485	Returns the row number of the topmost displayed line. Maximum value is
1275	C<0>, which displays the normal terminal contents. Lower values scroll	1486	C<0>, which displays the normal terminal contents. Lower values scroll
1276	this many lines into the scrollback buffer.	1487	this many lines into the scrollback buffer.
…		…
1295	line, starting at column C<$start_col> (default C<0>), which is useful	1506	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	1507	to replace only parts of a line. The font index in the rendition will
1297	automatically be updated.	1508	automatically be updated.
1298		1509
1299	C<$text> is in a special encoding: tabs and wide characters that use more	1510	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	1511	than one cell when displayed are padded with C<$urxvt::NOCHAR> (chr 65535)
1301	(C<chr 65535>). Characters with combining characters and other characters	1512	characters. Characters with combining characters and other characters that
1302	that do not fit into the normal tetx encoding will be replaced with	1513	do not fit into the normal tetx encoding will be replaced with characters
1303	characters in the private use area.	1514	in the private use area.
1304		1515
1305	You have to obey this encoding when changing text. The advantage is	1516	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	1517	that C<substr> and similar functions work on screen cells and not on
1307	characters.	1518	characters.
1308		1519
…		…
1455	=item $string = $term->special_decode $text	1666	=item $string = $term->special_decode $text
1456		1667
1457	Converts rxvt-unicodes text reprsentation into a perl string. See	1668	Converts rxvt-unicodes text reprsentation into a perl string. See
1458	C<< $term->ROW_t >> for details.	1669	C<< $term->ROW_t >> for details.
1459		1670
1460	=item $success = $term->grab_button ($button, $modifiermask)	1671	=item $success = $term->grab_button ($button, $modifiermask[, $window = $term->vt])
1461		1672
		1673	=item $term->ungrab_button ($button, $modifiermask[, $window = $term->vt])
		1674
1462	Registers a synchronous button grab. See the XGrabButton manpage.	1675	Register/unregister a synchronous button grab. See the XGrabButton
		1676	manpage.
1463		1677
1464	=item $success = $term->grab ($eventtime[, $sync])	1678	=item $success = $term->grab ($eventtime[, $sync])
1465		1679
1466	Calls XGrabPointer and XGrabKeyboard in asynchronous (default) or	1680	Calls XGrabPointer and XGrabKeyboard in asynchronous (default) or
1467	synchronous (C<$sync> is true). Also remembers the grab timestampe.	1681	synchronous (C<$sync> is true). Also remembers the grab timestampe.
…		…
1482	=item $term->ungrab	1696	=item $term->ungrab
1483		1697
1484	Calls XUngrab for the most recent grab. Is called automatically on	1698	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	1699	evaluation errors, as it is better to lose the grab in the error case as
1486	the session.	1700	the session.
		1701
		1702	=item $atom = $term->XInternAtom ($atom_name[, $only_if_exists])
		1703
		1704	=item $atom_name = $term->XGetAtomName ($atom)
		1705
		1706	=item @atoms = $term->XListProperties ($window)
		1707
		1708	=item ($type,$format,$octets) = $term->XGetWindowProperty ($window, $property)
		1709
		1710	=item $term->XChangeWindowProperty ($window, $property, $type, $format, $octets)
		1711
		1712	=item $term->XDeleteProperty ($window, $property)
		1713
		1714	=item $window = $term->DefaultRootWindow
		1715
		1716	=item $term->XReparentWindow ($window, $parent, [$x, $y])
		1717
		1718	=item $term->XMapWindow ($window)
		1719
		1720	=item $term->XUnmapWindow ($window)
		1721
		1722	=item $term->XMoveResizeWindow ($window, $x, $y, $width, $height)
		1723
		1724	=item ($x, $y, $child_window) = $term->XTranslateCoordinates ($src, $dst, $x, $y)
		1725
		1726	=item $term->XChangeInput ($window, $add_events[, $del_events])
		1727
		1728	Various X or X-related functions. The C<$term> object only serves as
		1729	the source of the display, otherwise those functions map more-or-less
		1730	directory onto the X functions of the same name.
1487		1731
1488	=back	1732	=back
1489		1733
1490	=cut	1734	=cut
1491		1735
…		…
1611	delete $self->{term}{_destroy}{$self};	1855	delete $self->{term}{_destroy}{$self};
1612	$self->{term}->ungrab;	1856	$self->{term}->ungrab;
1613	}	1857	}
1614		1858
1615	=back	1859	=back
		1860
		1861	=cut
		1862
		1863	package urxvt::watcher;
		1864
		1865	@urxvt::timer::ISA = __PACKAGE__;
		1866	@urxvt::iow::ISA = __PACKAGE__;
		1867	@urxvt::pw::ISA = __PACKAGE__;
		1868	@urxvt::iw::ISA = __PACKAGE__;
1616		1869
1617	=head2 The C<urxvt::timer> Class	1870	=head2 The C<urxvt::timer> Class
1618		1871
1619	This class implements timer watchers/events. Time is represented as a	1872	This class implements timer watchers/events. Time is represented as a
1620	fractional number of seconds since the epoch. Example:	1873	fractional number of seconds since the epoch. Example:
…		…
1718		1971
1719	Stop watching for events on the given filehandle.	1972	Stop watching for events on the given filehandle.
1720		1973
1721	=back	1974	=back
1722		1975
		1976	=head2 The C<urxvt::iw> Class
		1977
		1978	This class implements idle watchers, that get called automatically when
		1979	the process is idle. They should return as fast as possible, after doing
		1980	some useful work.
		1981
		1982	=over 4
		1983
		1984	=item $iw = new urxvt::iw
		1985
		1986	Create a new idle watcher object in stopped state.
		1987
		1988	=item $iw = $iw->cb (sub { my ($iw) = @_; ... })
		1989
		1990	Set the callback to be called when the watcher triggers.
		1991
		1992	=item $timer = $timer->start
		1993
		1994	Start the watcher.
		1995
		1996	=item $timer = $timer->stop
		1997
		1998	Stop the watcher.
		1999
		2000	=back
		2001
		2002	=head2 The C<urxvt::pw> Class
		2003
		2004	This class implements process watchers. They create an event whenever a
		2005	process exits, after which they stop automatically.
		2006
		2007	my $pid = fork;
		2008	...
		2009	$term->{pw} = urxvt::pw
		2010	->new
		2011	->start ($pid)
		2012	->cb (sub {
		2013	my ($pw, $exit_status) = @_;
		2014	...
		2015	});
		2016
		2017	=over 4
		2018
		2019	=item $pw = new urxvt::pw
		2020
		2021	Create a new process watcher in stopped state.
		2022
		2023	=item $pw = $pw->cb (sub { my ($pw, $exit_status) = @_; ... })
		2024
		2025	Set the callback to be called when the timer triggers.
		2026
		2027	=item $pw = $timer->start ($pid)
		2028
		2029	Tells the wqtcher to start watching for process C<$pid>.
		2030
		2031	=item $pw = $pw->stop
		2032
		2033	Stop the watcher.
		2034
		2035	=back
		2036
1723	=head1 ENVIRONMENT	2037	=head1 ENVIRONMENT
1724		2038
1725	=head2 URXVT_PERL_VERBOSITY	2039	=head2 URXVT_PERL_VERBOSITY
1726		2040
1727	This variable controls the verbosity level of the perl extension. Higher	2041	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.132 by root, Mon Feb 6 05:40:15 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.132 by root, Mon Feb 6 05:40:15 2006 UTC