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