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

Comparing rxvt-unicode/src/urxvt.pm (file contents):
Revision 1.87 by root, Thu Jan 12 05:37:34 2006 UTC vs.
Revision 1.124 by root, Sun Jan 22 11:57:06 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
…		…
48	C<--quoting-style=shell>.	52	C<--quoting-style=shell>.
49		53
50	A double-click usually selects the word under the cursor, further clicks	54	A double-click usually selects the word under the cursor, further clicks
51	will enlarge the selection.	55	will enlarge the selection.
52		56
		57	The selection works by trying to match a number of regexes and displaying
		58	them in increasing order of length. You can add your own regexes by
		59	specifying resources of the form:
		60
		61	URxvt.selection.pattern-0: perl-regex
		62	URxvt.selection.pattern-1: perl-regex
		63	...
		64
		65	The index number (0, 1...) must not have any holes, and each regex must
		66	contain at least one pair of capturing parentheses, which will be used for
		67	the match. For example, the followign adds a regex that matches everything
		68	between two vertical bars:
		69
		70	URxvt.selection.pattern-0: \\\|([^\|]+)\\\|
		71
		72	You can look at the source of the selection extension to see more
		73	interesting uses, such as parsing a line from beginning to end.
		74
53	It also offers the following bindable keyboard command:	75	This extension also offers following bindable keyboard commands:
54		76
55	=over 4	77	=over 4
56		78
57	=item rot13	79	=item rot13
58		80
…		…
69		91
70	=item selection-popup (enabled by default)	92	=item selection-popup (enabled by default)
71		93
72	Binds a popup menu to Ctrl-Button3 that lets you convert the selection	94	Binds a popup menu to Ctrl-Button3 that lets you convert the selection
73	text into various other formats/action (such as uri unescaping, perl	95	text into various other formats/action (such as uri unescaping, perl
74	evalution, web-browser starting etc.), depending on content.	96	evaluation, web-browser starting etc.), depending on content.
		97
		98	Other extensions can extend this popup menu by pushing a code reference
		99	onto C<@{ $term->{selection_popup_hook} }>, that is called whenever the
		100	popup is displayed.
		101
		102	It's sole argument is the popup menu, which can be modified. The selection
		103	is in C<$_>, which can be used to decide wether to add something or not.
		104	It should either return nothing or a string and a code reference. The
		105	string will be used as button text and the code reference will be called
		106	when the button gets activated and should transform C<$_>.
		107
		108	The following will add an entry C<a to b> that transforms all C<a>s in
		109	the selection to C<b>s, but only if the selection currently contains any
		110	C<a>s:
		111
		112	push @{ $self->{term}{selection_popup_hook} }, sub {
		113	/a/ ? ("a to be" => sub { s/a/b/g }
		114	: ()
		115	};
75		116
76	=item searchable-scrollback<hotkey> (enabled by default)	117	=item searchable-scrollback<hotkey> (enabled by default)
77		118
78	Adds regex search functionality to the scrollback buffer, triggered	119	Adds regex search functionality to the scrollback buffer, triggered
79	by a hotkey (default: C<M-s>). While in search mode, normal terminal	120	by a hotkey (default: C<M-s>). While in search mode, normal terminal
…		…
86	bottom. C<Escape> leaves search mode and returns to the point where search	127	bottom. C<Escape> leaves search mode and returns to the point where search
87	was started, while C<Enter> or C<Return> stay at the current position and	128	was started, while C<Enter> or C<Return> stay at the current position and
88	additionally stores the first match in the current line into the primary	129	additionally stores the first match in the current line into the primary
89	selection.	130	selection.
90		131
91	=item digital-clock	132	=item readline (enabled by default)
92		133
93	Displays a digital clock using the built-in overlay.	134	A support package that tries to make editing with readline easier. At the
		135	moment, it reacts to clicking with the left mouse button by trying to
		136	move the text cursor to this position. It does so by generating as many
		137	cursor-left or cursor-right keypresses as required (the this only works
		138	for programs that correctly support wide characters).
		139
		140	To avoid too many false positives, this is only done when:
		141
		142	=over 4
		143
		144	=item - the mouse is on the same (multi-row-) line as the text cursor.
		145
		146	=item - the primary screen is currently being displayed.
		147
		148	=item - the text cursor is visible.
		149
		150	=back
		151
		152	The normal selection mechanism isn't disabled, so quick successive clicks
		153	might interfere with selection creation in harmless ways.
		154
		155	=item selection-autotransform
		156
		157	This selection allows you to do automatic transforms on a selection
		158	whenever a selection is made.
		159
		160	It works by specifying perl snippets (most useful is a single C<s///>
		161	operator) that modify C<$_> as resources:
		162
		163	URxvt.selection-autotransform.0: transform
		164	URxvt.selection-autotransform.1: transform
		165	...
		166
		167	For example, the following will transform selections of the form
		168	C<filename:number>, often seen in compiler messages, into C<vi +$filename
		169	$word>:
		170
		171	URxvt.selection-autotransform.0: s/^([^:[:space:]]+):(\\d+):?$/vi +$2 \\Q$1\\E\\x0d/
		172
		173	And this example matches the same,but replaces it with vi-commands you can
		174	paste directly into your (vi :) editor:
		175
		176	URxvt.selection-autotransform.0: s/^([^:[:space:]]+(\\d+):?$/:e \\Q$1\\E\\x0d:$2\\x0d/
		177
		178	Of course, this can be modified to suit your needs and your editor :)
		179
		180	To expand the example above to typical perl error messages ("XXX at
		181	FILENAME line YYY."), you need a slightly more elaborate solution:
		182
		183	URxvt.selection.pattern-0: ( at .*? line \\d+[,.])
		184	URxvt.selection-autotransform.0: s/^ at (.*?) line (\\d+)[,.]$/:e \\Q$1\E\\x0d:$2\\x0d/
		185
		186	The first line tells the selection code to treat the unchanging part of
		187	every error message as a selection pattern, and the second line transforms
		188	the message into vi commands to load the file.
		189
		190	=item tabbed
		191
		192	This transforms the terminal into a tabbar with additional terminals, that
		193	is, it implements what is commonly refered to as "tabbed terminal". The topmost line
		194	displays a "[NEW]" button, which, when clicked, will add a new tab, followed by one
		195	button per tab.
		196
		197	Clicking a button will activate that tab. Pressing B<Shift-Left> and
		198	B<Shift-Right> will switch to the tab left or right of the current one,
		199	while B<Shift-Down> creates a new tab.
94		200
95	=item mark-urls	201	=item mark-urls
96		202
97	Uses per-line display filtering (C<on_line_update>) to underline urls and	203	Uses per-line display filtering (C<on_line_update>) to underline urls and
98	make them clickable. When middle-clicked, the program specified in the	204	make them clickable. When middle-clicked, the program specified in the
99	resource C<urlLauncher> (default C<x-www-browser>) will be started with	205	resource C<urlLauncher> (default C<x-www-browser>) will be started with
100	the URL as first argument.	206	the URL as first argument.
101		207
		208	=item automove-background
		209
		210	This is basically a one-line extension that dynamically changes the background pixmap offset
		211	to the window position, in effect creating the same effect as pseudo transparency with
		212	a custom pixmap. No scaling is supported in this mode. Exmaple:
		213
		214	@@RXVT_NAME@@ -pixmap background.xpm -pe automove-background
		215
102	=item block-graphics-to-ascii	216	=item block-graphics-to-ascii
103		217
104	A not very useful example of filtering all text output to the terminal,	218	A not very useful example of filtering all text output to the terminal,
105	by replacing all line-drawing characters (U+2500 .. U+259F) by a	219	by replacing all line-drawing characters (U+2500 .. U+259F) by a
106	similar-looking ascii character.	220	similar-looking ascii character.
107		221
		222	=item digital-clock
		223
		224	Displays a digital clock using the built-in overlay.
		225
108	=item example-refresh-hooks	226	=item example-refresh-hooks
109		227
110	Displays a very simple digital clock in the upper right corner of the	228	Displays a very simple digital clock in the upper right corner of the
111	window. Illustrates overwriting the refresh callbacks to create your own	229	window. Illustrates overwriting the refresh callbacks to create your own
112	overlays or changes.	230	overlays or changes.
		231
		232	=item selection-pastebin
		233
		234	This is a little rarely useful extension that Uploads the selection as
		235	textfile to a remote site (or does other things). (The implementation is
		236	not currently secure for use in a multiuser environment as it writes to
		237	F</tmp> directly.).
		238
		239	It listens to the C<selection-pastebin:remote-pastebin> keyboard command,
		240	i.e.
		241
		242	URxvt.keysym.C-M-e: perl:selection-pastebin:remote-pastebin
		243
		244	Pressing this combination runs a command with C<%> replaced by the name of
		245	the textfile. This command can be set via a resource:
		246
		247	URxvt.selection-pastebin.cmd: rsync -apP % ruth:/var/www/www.ta-sa.org/files/txt/.
		248
		249	And the default is likely not useful to anybody but the few people around
		250	here :)
		251
		252	The name of the textfile is the hex encoded md5 sum of the selection, so
		253	the same content should lead to the same filename.
		254
		255	After a successful upload the selection will be replaced by the text given
		256	in the C<selection-pastebin-url> resource (again, the % is the placeholder
		257	for the filename):
		258
		259	URxvt.selection-pastebin.url: http://www.ta-sa.org/files/txt/%
113		260
114	=back	261	=back
115		262
116	=head1 API DOCUMENTATION	263	=head1 API DOCUMENTATION
117		264
…		…
190	called whenever the relevant event happens.	337	called whenever the relevant event happens.
191		338
192	The first argument passed to them is an extension oject as described in	339	The first argument passed to them is an extension oject as described in
193	the in the C<Extension Objects> section.	340	the in the C<Extension Objects> section.
194		341
195	B<All> of these hooks must return a boolean value. If it is true, then the	342	B<All> of these hooks must return a boolean value. If any of the called
196	event counts as being I<consumed>, and the invocation of other hooks is	343	hooks returns true, then the event counts as being I<consumed>, and the
197	skipped, and the relevant action might not be carried out by the C++ code.	344	relevant action might not be carried out by the C++ code.
198		345
199	I<< When in doubt, return a false value (preferably C<()>). >>	346	I<< When in doubt, return a false value (preferably C<()>). >>
200		347
201	=over 4	348	=over 4
202		349
203	=item on_init $term	350	=item on_init $term
204		351
205	Called after a new terminal object has been initialized, but before	352	Called after a new terminal object has been initialized, but before
206	windows are created or the command gets run. Most methods are unsafe to	353	windows are created or the command gets run. Most methods are unsafe to
207	call or deliver senseless data, as terminal size and other characteristics	354	call or deliver senseless data, as terminal size and other characteristics
208	have not yet been determined. You can safely query and change resources,	355	have not yet been determined. You can safely query and change resources
209	though.	356	and options, though. For many purposes the C<on_start> hook is a better
		357	place.
		358
		359	=item on_start $term
		360
		361	Called at the very end of initialisation of a new terminal, just before
		362	trying to map (display) the toplevel and returning to the mainloop.
		363
		364	=item on_destroy $term
		365
		366	Called whenever something tries to destroy terminal, before doing anything
		367	yet. If this hook returns true, then destruction is skipped, but this is
		368	rarely a good idea.
210		369
211	=item on_reset $term	370	=item on_reset $term
212		371
213	Called after the screen is "reset" for any reason, such as resizing or	372	Called after the screen is "reset" for any reason, such as resizing or
214	control sequences. Here is where you can react on changes to size-related	373	control sequences. Here is where you can react on changes to size-related
215	variables.	374	variables.
216		375
217	=item on_start $term	376	=item on_child_start $term, $pid
218		377
219	Called at the very end of initialisation of a new terminal, just before	378	Called just after the child process has been C<fork>ed.
220	returning to the mainloop.	379
		380	=item on_child_exit $term, $status
		381
		382	Called just after the child process has exited. C<$status> is the status
		383	from C<waitpid>.
221		384
222	=item on_sel_make $term, $eventtime	385	=item on_sel_make $term, $eventtime
223		386
224	Called whenever a selection has been made by the user, but before the	387	Called whenever a selection has been made by the user, but before the
225	selection text is copied, so changes to the beginning, end or type of the	388	selection text is copied, so changes to the beginning, end or type of the
…		…
318		481
319	Called whenever the user presses a key combination that has a	482	Called whenever the user presses a key combination that has a
320	C<perl:string> action bound to it (see description of the B<keysym>	483	C<perl:string> action bound to it (see description of the B<keysym>
321	resource in the @@RXVT_NAME@@(1) manpage).	484	resource in the @@RXVT_NAME@@(1) manpage).
322		485
		486	=item on_x_event $term, $event
		487
		488	Called on every X event received on the vt window (and possibly other
		489	windows). Should only be used as a last resort. Most event structure
		490	members are not passed.
		491
323	=item on_focus_in $term	492	=item on_focus_in $term
324		493
325	Called whenever the window gets the keyboard focus, before rxvt-unicode	494	Called whenever the window gets the keyboard focus, before rxvt-unicode
326	does focus in processing.	495	does focus in processing.
327		496
328	=item on_focus_out $term	497	=item on_focus_out $term
329		498
330	Called wheneever the window loses keyboard focus, before rxvt-unicode does	499	Called wheneever the window loses keyboard focus, before rxvt-unicode does
331	focus out processing.	500	focus out processing.
332		501
		502	=item on_configure_notify $term, $event
		503
		504	=item on_property_notify $term, $event
		505
333	=item on_key_press $term, $event, $keysym, $octets	506	=item on_key_press $term, $event, $keysym, $octets
334		507
335	=item on_key_release $term, $event, $keysym	508	=item on_key_release $term, $event, $keysym
336		509
337	=item on_button_press $term, $event	510	=item on_button_press $term, $event
…		…
346		519
347	Called whenever the corresponding X event is received for the terminal If	520	Called whenever the corresponding X event is received for the terminal If
348	the hook returns true, then the even will be ignored by rxvt-unicode.	521	the hook returns true, then the even will be ignored by rxvt-unicode.
349		522
350	The event is a hash with most values as named by Xlib (see the XEvent	523	The event is a hash with most values as named by Xlib (see the XEvent
351	manpage), with the additional members C<row> and C<col>, which are the row	524	manpage), with the additional members C<row> and C<col>, which are the
352	and column under the mouse cursor.	525	(real, not screen-based) row and column under the mouse cursor.
353		526
354	C<on_key_press> additionally receives the string rxvt-unicode would	527	C<on_key_press> additionally receives the string rxvt-unicode would
355	output, if any, in locale-specific encoding.	528	output, if any, in locale-specific encoding.
356		529
357	subwindow.	530	subwindow.
		531
		532	=item on_client_message $term, $event
		533
		534	=item on_wm_protocols $term, $event
		535
		536	=item on_wm_delete_window $term, $event
		537
		538	Called when various types of ClientMessage events are received (all with
		539	format=32, WM_PROTOCOLS or WM_PROTOCOLS:WM_DELETE_WINDOW).
358		540
359	=back	541	=back
360		542
361	=cut	543	=cut
362		544
…		…
368	use Scalar::Util ();	550	use Scalar::Util ();
369	use List::Util ();	551	use List::Util ();
370		552
371	our $VERSION = 1;	553	our $VERSION = 1;
372	our $TERM;	554	our $TERM;
		555	our @TERM_INIT;
		556	our @TERM_EXT;
373	our @HOOKNAME;	557	our @HOOKNAME;
374	our %HOOKTYPE = map +($HOOKNAME[$_] => $_), 0..$#HOOKNAME;	558	our %HOOKTYPE = map +($HOOKNAME[$_] => $_), 0..$#HOOKNAME;
375	our %OPTION;	559	our %OPTION;
376		560
377	our $LIBDIR;	561	our $LIBDIR;
378	our $RESNAME;	562	our $RESNAME;
379	our $RESCLASS;	563	our $RESCLASS;
380	our $RXVTNAME;	564	our $RXVTNAME;
381		565
		566	our $NOCHAR = chr 0xffff;
		567
382	=head2 Variables in the C<urxvt> Package	568	=head2 Variables in the C<urxvt> Package
383		569
384	=over 4	570	=over 4
385		571
386	=item $urxvt::LIBDIR	572	=item $urxvt::LIBDIR
…		…
398		584
399	=item $urxvt::TERM	585	=item $urxvt::TERM
400		586
401	The current terminal. This variable stores the current C<urxvt::term>	587	The current terminal. This variable stores the current C<urxvt::term>
402	object, whenever a callback/hook is executing.	588	object, whenever a callback/hook is executing.
		589
		590	=item @urxvt::TERM_INIT
		591
		592	All coderefs in this array will be called as methods of the next newly
		593	created C<urxvt::term> object (during the C<on_init> phase). The array
		594	gets cleared before the codereferences that were in it are being executed,
		595	so coderefs can push themselves onto it again if they so desire.
		596
		597	This complements to the perl-eval commandline option, but gets executed
		598	first.
		599
		600	=item @urxvt::TERM_EXT
		601
		602	Works similar to C<@TERM_INIT>, but contains perl package/class names, which
		603	get registered as normal extensions after calling the hooks in C<@TERM_INIT>
		604	but before other extensions. Gets cleared just like C<@TERM_INIT>.
403		605
404	=back	606	=back
405		607
406	=head2 Functions in the C<urxvt> Package	608	=head2 Functions in the C<urxvt> Package
407		609
…		…
422	Using this function has the advantage that its output ends up in the	624	Using this function has the advantage that its output ends up in the
423	correct place, e.g. on stderr of the connecting urxvtc client.	625	correct place, e.g. on stderr of the connecting urxvtc client.
424		626
425	Messages have a size limit of 1023 bytes currently.	627	Messages have a size limit of 1023 bytes currently.
426		628
427	=item $is_safe = urxvt::safe
428
429	Returns true when it is safe to do potentially unsafe things, such as
430	evaluating perl code specified by the user. This is true when urxvt was
431	started setuid or setgid.
432
433	=item $time = urxvt::NOW	629	=item $time = urxvt::NOW
434		630
435	Returns the "current time" (as per the event loop).	631	Returns the "current time" (as per the event loop).
436		632
437	=item urxvt::CurrentTime	633	=item urxvt::CurrentTime
438		634
439	=item urxvt::ShiftMask, LockMask, ControlMask, Mod1Mask, Mod2Mask,	635	=item urxvt::ShiftMask, LockMask, ControlMask, Mod1Mask, Mod2Mask,
440	Mod3Mask, Mod4Mask, Mod5Mask, Button1Mask, Button2Mask, Button3Mask,	636	Mod3Mask, Mod4Mask, Mod5Mask, Button1Mask, Button2Mask, Button3Mask,
441	Button4Mask, Button5Mask, AnyModifier	637	Button4Mask, Button5Mask, AnyModifier
		638
		639	=item urxvt::NoEventMask, KeyPressMask, KeyReleaseMask,
		640	ButtonPressMask, ButtonReleaseMask, EnterWindowMask, LeaveWindowMask,
		641	PointerMotionMask, PointerMotionHintMask, Button1MotionMask, Button2MotionMask,
		642	Button3MotionMask, Button4MotionMask, Button5MotionMask, ButtonMotionMask,
		643	KeymapStateMask, ExposureMask, VisibilityChangeMask, StructureNotifyMask,
		644	ResizeRedirectMask, SubstructureNotifyMask, SubstructureRedirectMask,
		645	FocusChangeMask, PropertyChangeMask, ColormapChangeMask, OwnerGrabButtonMask
		646
		647	=item urxvt::KeyPress, KeyRelease, ButtonPress, ButtonRelease, MotionNotify,
		648	EnterNotify, LeaveNotify, FocusIn, FocusOut, KeymapNotify, Expose,
		649	GraphicsExpose, NoExpose, VisibilityNotify, CreateNotify, DestroyNotify,
		650	UnmapNotify, MapNotify, MapRequest, ReparentNotify, ConfigureNotify,
		651	ConfigureRequest, GravityNotify, ResizeRequest, CirculateNotify,
		652	CirculateRequest, PropertyNotify, SelectionClear, SelectionRequest,
		653	SelectionNotify, ColormapNotify, ClientMessage, MappingNotify
442		654
443	Various constants for use in X calls and event processing.	655	Various constants for use in X calls and event processing.
444		656
445	=back	657	=back
446		658
…		…
497	=back	709	=back
498		710
499	=cut	711	=cut
500		712
501	BEGIN {	713	BEGIN {
502	urxvt->bootstrap;
503
504	# overwrite perl's warn	714	# overwrite perl's warn
505	*CORE::GLOBAL::warn = sub {	715	*CORE::GLOBAL::warn = sub {
506	my $msg = join "", @_;	716	my $msg = join "", @_;
507	$msg .= "\n"	717	$msg .= "\n"
508	unless $msg =~ /\n$/;	718	unless $msg =~ /\n$/;
509	urxvt::warn ($msg);	719	urxvt::warn ($msg);
510	};	720	};
511
512	# %ENV is the original startup environment
513	delete $ENV{IFS};
514	delete $ENV{CDPATH};
515	delete $ENV{BASH_ENV};
516	$ENV{PATH} = "/bin:/sbin:/usr/bin:/usr/sbin:/usr/local/bin:/usr/local/sbin:/opt/bin:/opt/sbin";
517	}	721	}
518		722
519	my @hook_count;	723	no warnings 'utf8';
		724
520	my $verbosity = $ENV{URXVT_PERL_VERBOSITY};	725	my $verbosity = $ENV{URXVT_PERL_VERBOSITY};
521		726
522	sub verbose {	727	sub verbose {
523	my ($level, $msg) = @_;	728	my ($level, $msg) = @_;
524	warn "$msg\n" if $level <= $verbosity;	729	warn "$msg\n" if $level <= $verbosity;
525	}	730	}
526		731
527	my $extension_pkg = "extension0000";
528	my %extension_pkg;	732	my %extension_pkg;
529		733
530	# load a single script into its own package, once only	734	# load a single script into its own package, once only
531	sub extension_package($) {	735	sub extension_package($) {
532	my ($path) = @_;	736	my ($path) = @_;
533		737
534	$extension_pkg{$path} \|\|= do {	738	$extension_pkg{$path} \|\|= do {
535	my $pkg = "urxvt::" . ($extension_pkg++);	739	$path =~ /([^\/\\]+)$/;
		740	my $pkg = $1;
		741	$pkg =~ s/[^[:word:]]/_/g;
		742	$pkg = "urxvt::ext::$pkg";
536		743
537	verbose 3, "loading extension '$path' into package '$pkg'";	744	verbose 3, "loading extension '$path' into package '$pkg'";
538		745
539	open my $fh, "<:raw", $path	746	open my $fh, "<:raw", $path
540	or die "$path: $!";	747	or die "$path: $!";
541		748
542	my $source = untaint	749	my $source =
543	"package $pkg; use strict; use utf8;\n"	750	"package $pkg; use strict; use utf8; no warnings 'utf8';\n"
544	. "use base urxvt::term::extension::;\n"
545	. "#line 1 \"$path\"\n{\n"	751	. "#line 1 \"$path\"\n{\n"
546	. (do { local $/; <$fh> })	752	. (do { local $/; <$fh> })
547	. "\n};\n1";	753	. "\n};\n1";
548		754
549	eval $source	755	eval $source
…		…
563	if ($htype == 0) { # INIT	769	if ($htype == 0) { # INIT
564	my @dirs = ((split /:/, $TERM->resource ("perl_lib")), "$LIBDIR/perl");	770	my @dirs = ((split /:/, $TERM->resource ("perl_lib")), "$LIBDIR/perl");
565		771
566	my %ext_arg;	772	my %ext_arg;
567		773
		774	{
		775	my @init = @TERM_INIT;
		776	@TERM_INIT = ();
		777	$_->($TERM) for @init;
		778	my @pkg = @TERM_EXT;
		779	@TERM_EXT = ();
		780	$TERM->register_package ($_) for @pkg;
		781	}
		782
568	for (map { split /,/, $TERM->resource ("perl_ext_$_") } 1, 2) {	783	for (grep $_, map { split /,/, $TERM->resource ("perl_ext_$_") } 1, 2) {
569	if ($_ eq "default") {	784	if ($_ eq "default") {
570	$ext_arg{$_} \|\|= [] for qw(selection option-popup selection-popup searchable-scrollback);	785	$ext_arg{$_} \|\|= [] for qw(selection option-popup selection-popup searchable-scrollback readline);
571	} elsif (/^-(.*)$/) {	786	} elsif (/^-(.*)$/) {
572	delete $ext_arg{$1};	787	delete $ext_arg{$1};
573	} elsif (/^([^<]+)<(.*)>$/) {	788	} elsif (/^([^<]+)<(.*)>$/) {
574	push @{ $ext_arg{$1} }, $2;	789	push @{ $ext_arg{$1} }, $2;
575	} else {	790	} else {
…		…
598	if $verbosity >= 10;	813	if $verbosity >= 10;
599		814
600	keys %$cb;	815	keys %$cb;
601		816
602	while (my ($pkg, $cb) = each %$cb) {	817	while (my ($pkg, $cb) = each %$cb) {
603	$retval = eval { $cb->($TERM->{_pkg}{$pkg}, @_) }	818	my $retval_ = eval { $cb->($TERM->{_pkg}{$pkg}, @_) };
604	and last;	819	$retval \|\|= $retval_;
605		820
606	if ($@) {	821	if ($@) {
607	$TERM->ungrab; # better to lose the grab than the session	822	$TERM->ungrab; # better to lose the grab than the session
608	warn $@;	823	warn $@;
609	}	824	}
…		…
612	verbose 11, "$HOOKNAME[$htype] returning <$retval>"	827	verbose 11, "$HOOKNAME[$htype] returning <$retval>"
613	if $verbosity >= 11;	828	if $verbosity >= 11;
614	}	829	}
615		830
616	if ($htype == 1) { # DESTROY	831	if ($htype == 1) { # DESTROY
617	if (my $hook = delete $TERM->{_hook}) {
618	for my $htype (0..$#$hook) {
619	$hook_count[$htype] -= scalar keys %{ $hook->[$htype] \|\| {} }
620	or set_should_invoke $htype, 0;
621	}
622	}
623
624	# clear package objects	832	# clear package objects
625	%$_ = () for values %{ $TERM->{_pkg} };	833	%$_ = () for values %{ $TERM->{_pkg} };
626		834
627	# clear package	835	# clear package
628	%$TERM = ();	836	%$TERM = ();
629	}	837	}
630		838
631	$retval	839	$retval
632	}
633
634	sub exec_async(@) {
635	my $pid = fork;
636
637	return
638	if !defined $pid or $pid;
639
640	%ENV = %{ $TERM->env };
641
642	exec @_;
643	_exit 255;
644	}	840	}
645		841
646	# urxvt::term::extension	842	# urxvt::term::extension
647		843
648	package urxvt::term::extension;	844	package urxvt::term::extension;
…		…
654	while (my ($name, $cb) = each %hook) {	850	while (my ($name, $cb) = each %hook) {
655	my $htype = $HOOKTYPE{uc $name};	851	my $htype = $HOOKTYPE{uc $name};
656	defined $htype	852	defined $htype
657	or Carp::croak "unsupported hook type '$name'";	853	or Carp::croak "unsupported hook type '$name'";
658		854
		855	$self->set_should_invoke ($htype, +1)
659	unless (exists $self->{term}{_hook}[$htype]{$pkg}) {	856	unless exists $self->{term}{_hook}[$htype]{$pkg};
660	$hook_count[$htype]++
661	or urxvt::set_should_invoke $htype, 1;
662	}
663		857
664	$self->{term}{_hook}[$htype]{$pkg} = $cb;	858	$self->{term}{_hook}[$htype]{$pkg} = $cb;
665	}	859	}
666	}	860	}
667		861
…		…
672	for my $name (@hook) {	866	for my $name (@hook) {
673	my $htype = $HOOKTYPE{uc $name};	867	my $htype = $HOOKTYPE{uc $name};
674	defined $htype	868	defined $htype
675	or Carp::croak "unsupported hook type '$name'";	869	or Carp::croak "unsupported hook type '$name'";
676		870
		871	$self->set_should_invoke ($htype, -1)
677	if (delete $self->{term}{_hook}[$htype]{$pkg}) {	872	if delete $self->{term}{_hook}[$htype]{$pkg};
678	--$hook_count[$htype]
679	or urxvt::set_should_invoke $htype, 0;
680	}
681	}	873	}
682	}	874	}
683		875
684	our $AUTOLOAD;	876	our $AUTOLOAD;
685		877
…		…
791	# find on_xxx subs in the package and register them	983	# find on_xxx subs in the package and register them
792	# as hooks	984	# as hooks
793	sub register_package {	985	sub register_package {
794	my ($self, $pkg, $argv) = @_;	986	my ($self, $pkg, $argv) = @_;
795		987
		988	no strict 'refs';
		989
		990	urxvt::verbose 6, "register package $pkg to $self";
		991
		992	@{"$pkg\::ISA"} = urxvt::term::extension::;
		993
796	my $proxy = bless {	994	my $proxy = bless {
797	_pkg => $pkg,	995	_pkg => $pkg,
798	argv => $argv,	996	argv => $argv,
799	}, $pkg;	997	}, $pkg;
800	Scalar::Util::weaken ($proxy->{term} = $self);	998	Scalar::Util::weaken ($proxy->{term} = $self);
…		…
831		1029
832	Destroy the terminal object (close the window, free resources	1030	Destroy the terminal object (close the window, free resources
833	etc.). Please note that @@RXVT_NAME@@ will not exit as long as any event	1031	etc.). Please note that @@RXVT_NAME@@ will not exit as long as any event
834	watchers (timers, io watchers) are still active.	1032	watchers (timers, io watchers) are still active.
835		1033
		1034	=item $term->exec_async ($cmd[, @args])
		1035
		1036	Works like the combination of the C<fork>/C<exec> builtins, which executes
		1037	("starts") programs in the background. This function takes care of setting
		1038	the user environment before exec'ing the command (e.g. C<PATH>) and should
		1039	be preferred over explicit calls to C<exec> or C<system>.
		1040
		1041	Returns the pid of the subprocess or C<undef> on error.
		1042
		1043	=cut
		1044
		1045	sub exec_async {
		1046	my $self = shift;
		1047
		1048	my $pid = fork;
		1049
		1050	return $pid
		1051	if !defined $pid or $pid;
		1052
		1053	%ENV = %{ $self->env };
		1054
		1055	exec @_;
		1056	urxvt::_exit 255;
		1057	}
		1058
836	=item $isset = $term->option ($optval[, $set])	1059	=item $isset = $term->option ($optval[, $set])
837		1060
838	Returns true if the option specified by C<$optval> is enabled, and	1061	Returns true if the option specified by C<$optval> is enabled, and
839	optionally change it. All option values are stored by name in the hash	1062	optionally change it. All option values are stored by name in the hash
840	C<%urxvt::OPTION>. Options not enabled in this binary are not in the hash.	1063	C<%urxvt::OPTION>. Options not enabled in this binary are not in the hash.
…		…
842	Here is a a likely non-exhaustive list of option names, please see the	1065	Here is a a likely non-exhaustive list of option names, please see the
843	source file F</src/optinc.h> to see the actual list:	1066	source file F</src/optinc.h> to see the actual list:
844		1067
845	borderLess console cursorBlink cursorUnderline hold iconic insecure	1068	borderLess console cursorBlink cursorUnderline hold iconic insecure
846	intensityStyles jumpScroll loginShell mapAlert meta8 mouseWheelScrollPage	1069	intensityStyles jumpScroll loginShell mapAlert meta8 mouseWheelScrollPage
847	pastableTabs pointerBlank reverseVideo scrollBar scrollBar_floating	1070	override-redirect pastableTabs pointerBlank reverseVideo scrollBar
848	scrollBar_right scrollTtyKeypress scrollTtyOutput scrollWithBuffer	1071	scrollBar_floating scrollBar_right scrollTtyKeypress scrollTtyOutput
849	secondaryScreen secondaryScroll skipBuiltinGlyphs transparent	1072	scrollWithBuffer secondaryScreen secondaryScroll skipBuiltinGlyphs
850	tripleclickwords utmpInhibit visualBell	1073	transparent tripleclickwords utmpInhibit visualBell
851		1074
852	=item $value = $term->resource ($name[, $newval])	1075	=item $value = $term->resource ($name[, $newval])
853		1076
854	Returns the current resource value associated with a given name and	1077	Returns the current resource value associated with a given name and
855	optionally sets a new value. Setting values is most useful in the C<init>	1078	optionally sets a new value. Setting values is most useful in the C<init>
…		…
872		1095
873	answerbackstring backgroundPixmap backspace_key boldFont boldItalicFont	1096	answerbackstring backgroundPixmap backspace_key boldFont boldItalicFont
874	borderLess color cursorBlink cursorUnderline cutchars delete_key	1097	borderLess color cursorBlink cursorUnderline cutchars delete_key
875	display_name embed ext_bwidth fade font geometry hold iconName	1098	display_name embed ext_bwidth fade font geometry hold iconName
876	imFont imLocale inputMethod insecure int_bwidth intensityStyles	1099	imFont imLocale inputMethod insecure int_bwidth intensityStyles
877	italicFont jumpScroll lineSpace loginShell mapAlert menu meta8 modifier	1100	italicFont jumpScroll lineSpace loginShell mapAlert meta8 modifier
878	mouseWheelScrollPage name pastableTabs path perl_eval perl_ext_1 perl_ext_2	1101	mouseWheelScrollPage name override_redirect pastableTabs path perl_eval
879	perl_lib pointerBlank pointerBlankDelay preeditType print_pipe pty_fd	1102	perl_ext_1 perl_ext_2 perl_lib pointerBlank pointerBlankDelay
880	reverseVideo saveLines scrollBar scrollBar_align scrollBar_floating	1103	preeditType print_pipe pty_fd reverseVideo saveLines scrollBar
881	scrollBar_right scrollBar_thickness scrollTtyKeypress scrollTtyOutput	1104	scrollBar_align scrollBar_floating scrollBar_right scrollBar_thickness
882	scrollWithBuffer scrollstyle secondaryScreen secondaryScroll selectstyle	1105	scrollTtyKeypress scrollTtyOutput scrollWithBuffer scrollstyle
883	shade term_name title transparent transparent_all tripleclickwords	1106	secondaryScreen secondaryScroll selectstyle shade term_name title
884	utmpInhibit visualBell	1107	transient_for transparent transparent_all tripleclickwords utmpInhibit
		1108	visualBell
885		1109
886	=cut	1110	=cut
887		1111
888	sub resource($$;$) {	1112	sub resource($$;$) {
889	my ($self, $name) = (shift, shift);	1113	my ($self, $name) = (shift, shift);
…		…
1063		1287
1064	Normally its not a good idea to use this function, as programs might be	1288	Normally its not a good idea to use this function, as programs might be
1065	confused by changes in cursor position or scrolling. Its useful inside a	1289	confused by changes in cursor position or scrolling. Its useful inside a
1066	C<on_add_lines> hook, though.	1290	C<on_add_lines> hook, though.
1067		1291
		1292	=item $term->scr_change_screen ($screen)
		1293
		1294	Switch to given screen - 0 primary, 1 secondary.
		1295
1068	=item $term->cmd_parse ($octets)	1296	=item $term->cmd_parse ($octets)
1069		1297
1070	Similar to C<scr_add_lines>, but the argument must be in the	1298	Similar to C<scr_add_lines>, but the argument must be in the
1071	locale-specific encoding of the terminal and can contain command sequences	1299	locale-specific encoding of the terminal and can contain command sequences
1072	(escape codes) that will be interpreted.	1300	(escape codes) that will be interpreted.
…		…
1090		1318
1091	=item $windowid = $term->vt	1319	=item $windowid = $term->vt
1092		1320
1093	Return the window id of the terminal window.	1321	Return the window id of the terminal window.
1094		1322
		1323	=item $term->vt_emask_add ($x_event_mask)
		1324
		1325	Adds the specified events to the vt event mask. Useful e.g. when you want
		1326	to receive pointer events all the times:
		1327
		1328	$term->vt_emask_add (urxvt::PointerMotionMask);
		1329
1095	=item $window_width = $term->width	1330	=item $window_width = $term->width
1096		1331
1097	=item $window_height = $term->height	1332	=item $window_height = $term->height
1098		1333
1099	=item $font_width = $term->fwidth	1334	=item $font_width = $term->fwidth
…		…
1112		1347
1113	=item $max_scrollback = $term->saveLines	1348	=item $max_scrollback = $term->saveLines
1114		1349
1115	=item $nrow_plus_saveLines = $term->total_rows	1350	=item $nrow_plus_saveLines = $term->total_rows
1116		1351
1117	=item $lines_in_scrollback = $term->nsaved	1352	=item $topmost_scrollback_row = $term->top_row
1118		1353
1119	Return various integers describing terminal characteristics.	1354	Return various integers describing terminal characteristics.
1120		1355
1121	=item $x_display = $term->display_id	1356	=item $x_display = $term->display_id
1122		1357
…		…
1148	=item $modifiermask = $term->ModNumLockMask	1383	=item $modifiermask = $term->ModNumLockMask
1149		1384
1150	Return the modifier masks corresponding to the "ISO Level 3 Shift" (often	1385	Return the modifier masks corresponding to the "ISO Level 3 Shift" (often
1151	AltGr), the meta key (often Alt) and the num lock key, if applicable.	1386	AltGr), the meta key (often Alt) and the num lock key, if applicable.
1152		1387
		1388	=item $screen = $term->current_screen
		1389
		1390	Returns the currently displayed screen (0 primary, 1 secondary).
		1391
		1392	=item $cursor_is_hidden = $term->hidden_cursor
		1393
		1394	Returns wether the cursor is currently hidden or not.
		1395
1153	=item $view_start = $term->view_start ([$newvalue])	1396	=item $view_start = $term->view_start ([$newvalue])
1154		1397
1155	Returns the negative row number of the topmost line. Minimum value is	1398	Returns the row number of the topmost displayed line. Maximum value is
1156	C<0>, which displays the normal terminal contents. Larger values scroll	1399	C<0>, which displays the normal terminal contents. Lower values scroll
1157	this many lines into the scrollback buffer.	1400	this many lines into the scrollback buffer.
1158		1401
1159	=item $term->want_refresh	1402	=item $term->want_refresh
1160		1403
1161	Requests a screen refresh. At the next opportunity, rxvt-unicode will	1404	Requests a screen refresh. At the next opportunity, rxvt-unicode will
…		…
1176	line, starting at column C<$start_col> (default C<0>), which is useful	1419	line, starting at column C<$start_col> (default C<0>), which is useful
1177	to replace only parts of a line. The font index in the rendition will	1420	to replace only parts of a line. The font index in the rendition will
1178	automatically be updated.	1421	automatically be updated.
1179		1422
1180	C<$text> is in a special encoding: tabs and wide characters that use more	1423	C<$text> is in a special encoding: tabs and wide characters that use more
1181	than one cell when displayed are padded with urxvt::NOCHAR characters	1424	than one cell when displayed are padded with C<$urxvt::NOCHAR> (chr 65535)
1182	(C<chr 65535>). Characters with combining characters and other characters	1425	characters. Characters with combining characters and other characters that
1183	that do not fit into the normal tetx encoding will be replaced with	1426	do not fit into the normal tetx encoding will be replaced with characters
1184	characters in the private use area.	1427	in the private use area.
1185		1428
1186	You have to obey this encoding when changing text. The advantage is	1429	You have to obey this encoding when changing text. The advantage is
1187	that C<substr> and similar functions work on screen cells and not on	1430	that C<substr> and similar functions work on screen cells and not on
1188	characters.	1431	characters.
1189		1432
…		…
1364		1607
1365	Calls XUngrab for the most recent grab. Is called automatically on	1608	Calls XUngrab for the most recent grab. Is called automatically on
1366	evaluation errors, as it is better to lose the grab in the error case as	1609	evaluation errors, as it is better to lose the grab in the error case as
1367	the session.	1610	the session.
1368		1611
		1612	=item $atom = $term->XInternAtom ($atom_name[, $only_if_exists])
		1613
		1614	=item $atom_name = $term->XGetAtomName ($atom)
		1615
		1616	=item @atoms = $term->XListProperties ($window)
		1617
		1618	=item ($type,$format,$octets) = $term->XGetWindowProperty ($window, $property)
		1619
		1620	=item $term->XChangeWindowProperty ($window, $property, $type, $format, $octets)
		1621
		1622	=item $term->XDeleteProperty ($window, $property)
		1623
		1624	=item $window = $term->DefaultRootWindow
		1625
		1626	=item $term->XReparentWindow ($window, $parent, [$x, $y])
		1627
		1628	=item $term->XMapWindow ($window)
		1629
		1630	=item $term->XUnmapWindow ($window)
		1631
		1632	=item $term->XMoveResizeWindow ($window, $x, $y, $width, $height)
		1633
		1634	=item ($x, $y, $child_window) = $term->XTranslateCoordinates ($src, $dst, $x, $y)
		1635
		1636	=item $term->XChangeInput ($window, $add_events[, $del_events])
		1637
		1638	Various X or X-related functions. The C<$term> object only serves as
		1639	the source of the display, otherwise those functions map more-or-less
		1640	directory onto the X functions of the same name.
		1641
1369	=back	1642	=back
1370		1643
1371	=cut	1644	=cut
1372		1645
1373	package urxvt::popup;	1646	package urxvt::popup;
…		…
1474	my $env = $self->{term}->env;	1747	my $env = $self->{term}->env;
1475	# we can't hope to reproduce the locale algorithm, so nuke LC_ALL and set LC_CTYPE.	1748	# we can't hope to reproduce the locale algorithm, so nuke LC_ALL and set LC_CTYPE.
1476	delete $env->{LC_ALL};	1749	delete $env->{LC_ALL};
1477	$env->{LC_CTYPE} = $self->{term}->locale;	1750	$env->{LC_CTYPE} = $self->{term}->locale;
1478		1751
1479	urxvt::term->new ($env, $self->{term}->resource ("name"),	1752	urxvt::term->new ($env, "popup",
1480	"--perl-lib" => "", "--perl-ext-common" => "", "-pty-fd" => -1, "-sl" => 0, "-b" => 0,	1753	"--perl-lib" => "", "--perl-ext-common" => "",
		1754	"-pty-fd" => -1, "-sl" => 0,
		1755	"-b" => 1, "-bd" => "grey80", "-bl", "-override-redirect",
1481	"--transient-for" => $self->{term}->parent,	1756	"--transient-for" => $self->{term}->parent,
1482	"-display" => $self->{term}->display_id,	1757	"-display" => $self->{term}->display_id,
1483	"-pe" => "urxvt-popup")	1758	"-pe" => "urxvt-popup")
1484	or die "unable to create popup window\n";	1759	or die "unable to create popup window\n";
1485	}	1760	}
…		…
1490	delete $self->{term}{_destroy}{$self};	1765	delete $self->{term}{_destroy}{$self};
1491	$self->{term}->ungrab;	1766	$self->{term}->ungrab;
1492	}	1767	}
1493		1768
1494	=back	1769	=back
		1770
		1771	=cut
		1772
		1773	package urxvt::watcher;
		1774
		1775	@urxvt::timer::ISA = __PACKAGE__;
		1776	@urxvt::iow::ISA = __PACKAGE__;
		1777	@urxvt::pw::ISA = __PACKAGE__;
		1778	@urxvt::iw::ISA = __PACKAGE__;
1495		1779
1496	=head2 The C<urxvt::timer> Class	1780	=head2 The C<urxvt::timer> Class
1497		1781
1498	This class implements timer watchers/events. Time is represented as a	1782	This class implements timer watchers/events. Time is represented as a
1499	fractional number of seconds since the epoch. Example:	1783	fractional number of seconds since the epoch. Example:
…		…
1537	Start the timer.	1821	Start the timer.
1538		1822
1539	=item $timer = $timer->start ($tstamp)	1823	=item $timer = $timer->start ($tstamp)
1540		1824
1541	Set the event trigger time to C<$tstamp> and start the timer.	1825	Set the event trigger time to C<$tstamp> and start the timer.
		1826
		1827	=item $timer = $timer->after ($delay)
		1828
		1829	Like C<start>, but sets the expiry timer to c<urxvt::NOW + $delay>.
1542		1830
1543	=item $timer = $timer->stop	1831	=item $timer = $timer->stop
1544		1832
1545	Stop the timer.	1833	Stop the timer.
1546		1834
…		…
1593		1881
1594	Stop watching for events on the given filehandle.	1882	Stop watching for events on the given filehandle.
1595		1883
1596	=back	1884	=back
1597		1885
		1886	=head2 The C<urxvt::iw> Class
		1887
		1888	This class implements idle watchers, that get called automatically when
		1889	the process is idle. They should return as fast as possible, after doing
		1890	some useful work.
		1891
		1892	=over 4
		1893
		1894	=item $iw = new urxvt::iw
		1895
		1896	Create a new idle watcher object in stopped state.
		1897
		1898	=item $iw = $iw->cb (sub { my ($iw) = @_; ... })
		1899
		1900	Set the callback to be called when the watcher triggers.
		1901
		1902	=item $timer = $timer->start
		1903
		1904	Start the watcher.
		1905
		1906	=item $timer = $timer->stop
		1907
		1908	Stop the watcher.
		1909
		1910	=back
		1911
		1912	=head2 The C<urxvt::pw> Class
		1913
		1914	This class implements process watchers. They create an event whenever a
		1915	process exits, after which they stop automatically.
		1916
		1917	my $pid = fork;
		1918	...
		1919	$term->{pw} = urxvt::pw
		1920	->new
		1921	->start ($pid)
		1922	->cb (sub {
		1923	my ($pw, $exit_status) = @_;
		1924	...
		1925	});
		1926
		1927	=over 4
		1928
		1929	=item $pw = new urxvt::pw
		1930
		1931	Create a new process watcher in stopped state.
		1932
		1933	=item $pw = $pw->cb (sub { my ($pw, $exit_status) = @_; ... })
		1934
		1935	Set the callback to be called when the timer triggers.
		1936
		1937	=item $pw = $timer->start ($pid)
		1938
		1939	Tells the wqtcher to start watching for process C<$pid>.
		1940
		1941	=item $pw = $pw->stop
		1942
		1943	Stop the watcher.
		1944
		1945	=back
		1946
1598	=head1 ENVIRONMENT	1947	=head1 ENVIRONMENT
1599		1948
1600	=head2 URXVT_PERL_VERBOSITY	1949	=head2 URXVT_PERL_VERBOSITY
1601		1950
1602	This variable controls the verbosity level of the perl extension. Higher	1951	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.87 by root, Thu Jan 12 05:37:34 2006 UTC vs. Revision 1.124 by root, Sun Jan 22 11:57:06 2006 UTC

Diff Legend

Comparing rxvt-unicode/src/urxvt.pm (file contents):
Revision 1.87 by root, Thu Jan 12 05:37:34 2006 UTC vs.
Revision 1.124 by root, Sun Jan 22 11:57:06 2006 UTC