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

Comparing rxvt-unicode/src/urxvt.pm (file contents):
Revision 1.78 by root, Wed Jan 11 01:01:52 2006 UTC vs.
Revision 1.115 by root, Fri Jan 20 15:57:21 2006 UTC

…		…
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		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
		43
40	=over 4	44	=over 4
41		45
42	=item selection (enabled by default)	46	=item selection (enabled by default)
43		47
44	(More) intelligent selection. This extension tries to be more intelligent	48	(More) intelligent selection. This extension tries to be more intelligent
45	when the user extends selections (double-click). Right now, it tries to	49	when the user extends selections (double-click and further clicks). Right
46	select urls and complete shell-quoted arguments, which is very convenient,	50	now, it tries to select words, urls and complete shell-quoted
47	too, if your F<ls> supports C<--quoting-style=shell>.	51	arguments, which is very convenient, too, if your F<ls> supports
		52	C<--quoting-style=shell>.
48		53
		54	A double-click usually selects the word under the cursor, further clicks
		55	will enlarge the selection.
		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
49	It also offers the following bindable keyboard command:	75	This extension also offers following bindable keyboard commands:
50		76
51	=over 4	77	=over 4
52		78
53	=item rot13	79	=item rot13
54		80
…		…
67		93
68	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
69	text into various other formats/action (such as uri unescaping, perl	95	text into various other formats/action (such as uri unescaping, perl
70	evalution, web-browser starting etc.), depending on content.	96	evalution, web-browser starting etc.), depending on content.
71		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	};
		116
72	=item searchable-scrollback<hotkey> (enabled by default)	117	=item searchable-scrollback<hotkey> (enabled by default)
73		118
74	Adds regex search functionality to the scrollback buffer, triggered	119	Adds regex search functionality to the scrollback buffer, triggered
75	by a hotkey (default: C<M-s>). When in search mode, normal terminal	120	by a hotkey (default: C<M-s>). While in search mode, normal terminal
76	input/output is suspended.	121	input/output is suspended and a regex is displayed at the bottom of the
		122	screen.
77		123
78	C</> starts an incremental regex search, C<n> searches further, C<p> or	124	Inputting characters appends them to the regex and continues incremental
79	C<N> jump to the previous match, C<G> jumps to the bottom and clears the	125	search. C<BackSpace> removes a character from the regex, C<Up> and C<Down>
80	history, C<enter> leaves search mode at the current position and C<escape>	126	search upwards/downwards in the scrollback buffer, C<End> jumps to the
81	returns to the original position.	127	bottom. C<Escape> leaves search mode and returns to the point where search
		128	was started, while C<Enter> or C<Return> stay at the current position and
		129	additionally stores the first match in the current line into the primary
		130	selection.
82		131
83	=item digital-clock	132	=item selection-autotransform
84		133
85	Displays a digital clock using the built-in overlay.	134	This selection allows you to do automatic transforms on a selection
		135	whenever a selection is made.
		136
		137	It works by specifying perl snippets (most useful is a single C<s///>
		138	operator) that modify C<$_> as resources:
		139
		140	URxvt.selection-autotransform.0: transform
		141	URxvt.selection-autotransform.1: transform
		142	...
		143
		144	For example, the following will transform selections of the form
		145	C<filename:number>, often seen in compiler messages, into C<vi +$filename
		146	$word>:
		147
		148	URxvt.selection-autotransform.0: s/^([^:[:space:]]+):(\\d+):?$/vi +$2 \\Q$1\\E\\x0d/
		149
		150	And this example matches the same,but replaces it with vi-commands you can
		151	paste directly into your (vi :) editor:
		152
		153	URxvt.selection-autotransform.0: s/^([^:[:space:]]+(\\d+):?$/:e \\Q$1\\E\\x0d:$2\\x0d/
		154
		155	Of course, this can be modified to suit your needs and your editor :)
		156
		157	To expand the example above to typical perl error messages ("XXX at
		158	FILENAME line YYY."), you need a slightly more elaborate solution:
		159
		160	URxvt.selection.pattern-0: ( at .*? line \\d+[,.])
		161	URxvt.selection-autotransform.0: s/^ at (.*?) line (\\d+)[,.]$/:e \\Q$1\E\\x0d:$2\\x0d/
		162
		163	The first line tells the selection code to treat the unchanging part of
		164	every error message as a selection pattern, and the second line transforms
		165	the message into vi commands to load the file.
		166
		167	=item tabbed
		168
		169	This transforms the terminal into a tabbar with additional terminals, that
		170	is, it implements what is commonly refered to as "tabbed terminal". The topmost line
		171	displays a "[NEW]" button, which, when clicked, will add a new tab, followed by one
		172	button per tab.
		173
		174	Clicking a button will activate that tab. Pressing Shift-Left and
		175	Shift-Right will switch to the tab left or right of the current one.
86		176
87	=item mark-urls	177	=item mark-urls
88		178
89	Uses per-line display filtering (C<on_line_update>) to underline urls.	179	Uses per-line display filtering (C<on_line_update>) to underline urls and
		180	make them clickable. When middle-clicked, the program specified in the
		181	resource C<urlLauncher> (default C<x-www-browser>) will be started with
		182	the URL as first argument.
		183
		184	=item automove-background
		185
		186	This is basically a one-line extension that dynamically changes the background pixmap offset
		187	to the window position, in effect creating the same effect as pseudo transparency with
		188	a custom pixmap. No scaling is supported in this mode. Exmaple:
		189
		190	@@RXVT_NAME@@ -pixmap background.xpm -pe automove-background
90		191
91	=item block-graphics-to-ascii	192	=item block-graphics-to-ascii
92		193
93	A not very useful example of filtering all text output to the terminal,	194	A not very useful example of filtering all text output to the terminal,
94	by replacing all line-drawing characters (U+2500 .. U+259F) by a	195	by replacing all line-drawing characters (U+2500 .. U+259F) by a
95	similar-looking ascii character.	196	similar-looking ascii character.
96		197
		198	=item digital-clock
		199
		200	Displays a digital clock using the built-in overlay.
		201
97	=item example-refresh-hooks	202	=item example-refresh-hooks
98		203
99	Displays a very simple digital clock in the upper right corner of the	204	Displays a very simple digital clock in the upper right corner of the
100	window. Illustrates overwriting the refresh callbacks to create your own	205	window. Illustrates overwriting the refresh callbacks to create your own
101	overlays or changes.	206	overlays or changes.
		207
		208	=item selection-pastebin
		209
		210	This is a little rarely useful extension that Uploads the selection as
		211	textfile to a remote site (or does other things). (The implementation is
		212	not currently secure for use in a multiuser environment as it writes to
		213	F</tmp> directly.).
		214
		215	It listens to the C<selection-pastebin:remote-pastebin> keyboard command,
		216	i.e.
		217
		218	URxvt.keysym.C-M-e: perl:selection-pastebin:remote-pastebin
		219
		220	Pressing this combination runs a command with C<%> replaced by the name of
		221	the textfile. This command can be set via a resource:
		222
		223	URxvt.selection-pastebin.cmd: rsync -apP % ruth:/var/www/www.ta-sa.org/files/txt/.
		224
		225	And the default is likely not useful to anybody but the few people around
		226	here :)
		227
		228	The name of the textfile is the hex encoded md5 sum of the selection, so
		229	the same content should lead to the same filename.
		230
		231	After a successful upload the selection will be replaced by the text given
		232	in the C<selection-pastebin-url> resource (again, the % is the placeholder
		233	for the filename):
		234
		235	URxvt.selection-pastebin.url: http://www.ta-sa.org/files/txt/%
102		236
103	=back	237	=back
104		238
105	=head1 API DOCUMENTATION	239	=head1 API DOCUMENTATION
106		240
…		…
179	called whenever the relevant event happens.	313	called whenever the relevant event happens.
180		314
181	The first argument passed to them is an extension oject as described in	315	The first argument passed to them is an extension oject as described in
182	the in the C<Extension Objects> section.	316	the in the C<Extension Objects> section.
183		317
184	B<All> of these hooks must return a boolean value. If it is true, then the	318	B<All> of these hooks must return a boolean value. If any of the called
185	event counts as being I<consumed>, and the invocation of other hooks is	319	hooks returns true, then the event counts as being I<consumed>, and the
186	skipped, and the relevant action might not be carried out by the C++ code.	320	relevant action might not be carried out by the C++ code.
187		321
188	I<< When in doubt, return a false value (preferably C<()>). >>	322	I<< When in doubt, return a false value (preferably C<()>). >>
189		323
190	=over 4	324	=over 4
191		325
192	=item on_init $term	326	=item on_init $term
193		327
194	Called after a new terminal object has been initialized, but before	328	Called after a new terminal object has been initialized, but before
195	windows are created or the command gets run. Most methods are unsafe to	329	windows are created or the command gets run. Most methods are unsafe to
196	call or deliver senseless data, as terminal size and other characteristics	330	call or deliver senseless data, as terminal size and other characteristics
197	have not yet been determined. You can safely query and change resources,	331	have not yet been determined. You can safely query and change resources
198	though.	332	and options, though. For many purposes the C<on_start> hook is a better
		333	place.
		334
		335	=item on_start $term
		336
		337	Called at the very end of initialisation of a new terminal, just before
		338	trying to map (display) the toplevel and returning to the mainloop.
		339
		340	=item on_destroy $term
		341
		342	Called whenever something tries to destroy terminal, before doing anything
		343	yet. If this hook returns true, then destruction is skipped, but this is
		344	rarely a good idea.
199		345
200	=item on_reset $term	346	=item on_reset $term
201		347
202	Called after the screen is "reset" for any reason, such as resizing or	348	Called after the screen is "reset" for any reason, such as resizing or
203	control sequences. Here is where you can react on changes to size-related	349	control sequences. Here is where you can react on changes to size-related
204	variables.	350	variables.
205		351
206	=item on_start $term	352	=item on_child_start $term, $pid
207		353
208	Called at the very end of initialisation of a new terminal, just before	354	Called just after the child process has been C<fork>ed.
209	returning to the mainloop.	355
		356	=item on_child_exit $term, $status
		357
		358	Called just after the child process has exited. C<$status> is the status
		359	from C<waitpid>.
210		360
211	=item on_sel_make $term, $eventtime	361	=item on_sel_make $term, $eventtime
212		362
213	Called whenever a selection has been made by the user, but before the	363	Called whenever a selection has been made by the user, but before the
214	selection text is copied, so changes to the beginning, end or type of the	364	selection text is copied, so changes to the beginning, end or type of the
…		…
228	=item on_sel_extend $term	378	=item on_sel_extend $term
229		379
230	Called whenever the user tries to extend the selection (e.g. with a double	380	Called whenever the user tries to extend the selection (e.g. with a double
231	click) and is either supposed to return false (normal operation), or	381	click) and is either supposed to return false (normal operation), or
232	should extend the selection itelf and return true to suppress the built-in	382	should extend the selection itelf and return true to suppress the built-in
233	processing.	383	processing. This can happen multiple times, as long as the callback
		384	returns true, it will be called on every further click by the user and is
		385	supposed to enlarge the selection more and more, if possible.
234		386
235	See the F<selection> example extension.	387	See the F<selection> example extension.
236		388
237	=item on_view_change $term, $offset	389	=item on_view_change $term, $offset
238		390
…		…
305		457
306	Called whenever the user presses a key combination that has a	458	Called whenever the user presses a key combination that has a
307	C<perl:string> action bound to it (see description of the B<keysym>	459	C<perl:string> action bound to it (see description of the B<keysym>
308	resource in the @@RXVT_NAME@@(1) manpage).	460	resource in the @@RXVT_NAME@@(1) manpage).
309		461
		462	=item on_x_event $term, $event
		463
		464	Called on every X event received on the vt window (and possibly other
		465	windows). Should only be used as a last resort. Most event structure
		466	members are not passed.
		467
310	=item on_focus_in $term	468	=item on_focus_in $term
311		469
312	Called whenever the window gets the keyboard focus, before rxvt-unicode	470	Called whenever the window gets the keyboard focus, before rxvt-unicode
313	does focus in processing.	471	does focus in processing.
314		472
315	=item on_focus_out $term	473	=item on_focus_out $term
316		474
317	Called wheneever the window loses keyboard focus, before rxvt-unicode does	475	Called wheneever the window loses keyboard focus, before rxvt-unicode does
318	focus out processing.	476	focus out processing.
		477
		478	=item on_configure_notify $term, $event
319		479
320	=item on_key_press $term, $event, $keysym, $octets	480	=item on_key_press $term, $event, $keysym, $octets
321		481
322	=item on_key_release $term, $event, $keysym	482	=item on_key_release $term, $event, $keysym
323		483
…		…
340		500
341	C<on_key_press> additionally receives the string rxvt-unicode would	501	C<on_key_press> additionally receives the string rxvt-unicode would
342	output, if any, in locale-specific encoding.	502	output, if any, in locale-specific encoding.
343		503
344	subwindow.	504	subwindow.
		505
		506	=item on_client_message $term, $event
		507
		508	=item on_wm_protocols $term, $event
		509
		510	=item on_wm_delete_window $term, $event
		511
		512	Called when various types of ClientMessage events are received (all with
		513	format=32, WM_PROTOCOLS or WM_PROTOCOLS:WM_DELETE_WINDOW).
345		514
346	=back	515	=back
347		516
348	=cut	517	=cut
349		518
…		…
355	use Scalar::Util ();	524	use Scalar::Util ();
356	use List::Util ();	525	use List::Util ();
357		526
358	our $VERSION = 1;	527	our $VERSION = 1;
359	our $TERM;	528	our $TERM;
		529	our @TERM_INIT;
		530	our @TERM_EXT;
360	our @HOOKNAME;	531	our @HOOKNAME;
361	our %HOOKTYPE = map +($HOOKNAME[$_] => $_), 0..$#HOOKNAME;	532	our %HOOKTYPE = map +($HOOKNAME[$_] => $_), 0..$#HOOKNAME;
362	our %OPTION;	533	our %OPTION;
363		534
364	our $LIBDIR;	535	our $LIBDIR;
…		…
386	=item $urxvt::TERM	557	=item $urxvt::TERM
387		558
388	The current terminal. This variable stores the current C<urxvt::term>	559	The current terminal. This variable stores the current C<urxvt::term>
389	object, whenever a callback/hook is executing.	560	object, whenever a callback/hook is executing.
390		561
		562	=item @urxvt::TERM_INIT
		563
		564	All coderefs in this array will be called as methods of the next newly
		565	created C<urxvt::term> object (during the C<on_init> phase). The array
		566	gets cleared before the codereferences that were in it are being executed,
		567	so coderefs can push themselves onto it again if they so desire.
		568
		569	This complements to the perl-eval commandline option, but gets executed
		570	first.
		571
		572	=item @urxvt::TERM_EXT
		573
		574	Works similar to C<@TERM_INIT>, but contains perl package/class names, which
		575	get registered as normal extensions after calling the hooks in C<@TERM_INIT>
		576	but before other extensions. Gets cleared just like C<@TERM_INIT>.
		577
391	=back	578	=back
392		579
393	=head2 Functions in the C<urxvt> Package	580	=head2 Functions in the C<urxvt> Package
394		581
395	=over 4	582	=over 4
…		…
409	Using this function has the advantage that its output ends up in the	596	Using this function has the advantage that its output ends up in the
410	correct place, e.g. on stderr of the connecting urxvtc client.	597	correct place, e.g. on stderr of the connecting urxvtc client.
411		598
412	Messages have a size limit of 1023 bytes currently.	599	Messages have a size limit of 1023 bytes currently.
413		600
414	=item $is_safe = urxvt::safe
415
416	Returns true when it is safe to do potentially unsafe things, such as
417	evaluating perl code specified by the user. This is true when urxvt was
418	started setuid or setgid.
419
420	=item $time = urxvt::NOW	601	=item $time = urxvt::NOW
421		602
422	Returns the "current time" (as per the event loop).	603	Returns the "current time" (as per the event loop).
423		604
424	=item urxvt::CurrentTime	605	=item urxvt::CurrentTime
425		606
426	=item urxvt::ShiftMask, LockMask, ControlMask, Mod1Mask, Mod2Mask,	607	=item urxvt::ShiftMask, LockMask, ControlMask, Mod1Mask, Mod2Mask,
427	Mod3Mask, Mod4Mask, Mod5Mask, Button1Mask, Button2Mask, Button3Mask,	608	Mod3Mask, Mod4Mask, Mod5Mask, Button1Mask, Button2Mask, Button3Mask,
428	Button4Mask, Button5Mask, AnyModifier	609	Button4Mask, Button5Mask, AnyModifier
		610
		611	=item urxvt::NoEventMask, KeyPressMask, KeyReleaseMask,
		612	ButtonPressMask, ButtonReleaseMask, EnterWindowMask, LeaveWindowMask,
		613	PointerMotionMask, PointerMotionHintMask, Button1MotionMask, Button2MotionMask,
		614	Button3MotionMask, Button4MotionMask, Button5MotionMask, ButtonMotionMask,
		615	KeymapStateMask, ExposureMask, VisibilityChangeMask, StructureNotifyMask,
		616	ResizeRedirectMask, SubstructureNotifyMask, SubstructureRedirectMask,
		617	FocusChangeMask, PropertyChangeMask, ColormapChangeMask, OwnerGrabButtonMask
		618
		619	=item urxvt::KeyPress, KeyRelease, ButtonPress, ButtonRelease, MotionNotify,
		620	EnterNotify, LeaveNotify, FocusIn, FocusOut, KeymapNotify, Expose,
		621	GraphicsExpose, NoExpose, VisibilityNotify, CreateNotify, DestroyNotify,
		622	UnmapNotify, MapNotify, MapRequest, ReparentNotify, ConfigureNotify,
		623	ConfigureRequest, GravityNotify, ResizeRequest, CirculateNotify,
		624	CirculateRequest, PropertyNotify, SelectionClear, SelectionRequest,
		625	SelectionNotify, ColormapNotify, ClientMessage, MappingNotify
429		626
430	Various constants for use in X calls and event processing.	627	Various constants for use in X calls and event processing.
431		628
432	=back	629	=back
433		630
…		…
484	=back	681	=back
485		682
486	=cut	683	=cut
487		684
488	BEGIN {	685	BEGIN {
489	urxvt->bootstrap;
490
491	# overwrite perl's warn	686	# overwrite perl's warn
492	*CORE::GLOBAL::warn = sub {	687	*CORE::GLOBAL::warn = sub {
493	my $msg = join "", @_;	688	my $msg = join "", @_;
494	$msg .= "\n"	689	$msg .= "\n"
495	unless $msg =~ /\n$/;	690	unless $msg =~ /\n$/;
496	urxvt::warn ($msg);	691	urxvt::warn ($msg);
497	};	692	};
498
499	delete $ENV{IFS};
500	delete $ENV{CDPATH};
501	delete $ENV{BASH_ENV};
502	$ENV{PATH} = "/bin:/sbin:/usr/bin:/usr/sbin:/usr/local/bin:/usr/local/sbin:/opt/bin:/opt/sbin";
503	}	693	}
504		694
505	my @hook_count;
506	my $verbosity = $ENV{URXVT_PERL_VERBOSITY};	695	my $verbosity = $ENV{URXVT_PERL_VERBOSITY};
507		696
508	sub verbose {	697	sub verbose {
509	my ($level, $msg) = @_;	698	my ($level, $msg) = @_;
510	warn "$msg\n" if $level <= $verbosity;	699	warn "$msg\n" if $level <= $verbosity;
511	}	700	}
512		701
513	my $extension_pkg = "extension0000";
514	my %extension_pkg;	702	my %extension_pkg;
515		703
516	# load a single script into its own package, once only	704	# load a single script into its own package, once only
517	sub extension_package($) {	705	sub extension_package($) {
518	my ($path) = @_;	706	my ($path) = @_;
519		707
520	$extension_pkg{$path} \|\|= do {	708	$extension_pkg{$path} \|\|= do {
521	my $pkg = "urxvt::" . ($extension_pkg++);	709	$path =~ /([^\/\\]+)$/;
		710	my $pkg = $1;
		711	$pkg =~ s/[^[:word:]]/_/g;
		712	$pkg = "urxvt::ext::$pkg";
522		713
523	verbose 3, "loading extension '$path' into package '$pkg'";	714	verbose 3, "loading extension '$path' into package '$pkg'";
524		715
525	open my $fh, "<:raw", $path	716	open my $fh, "<:raw", $path
526	or die "$path: $!";	717	or die "$path: $!";
527		718
528	my $source = untaint	719	my $source =
529	"package $pkg; use strict; use utf8;\n"	720	"package $pkg; use strict; use utf8;\n"
530	. "use base urxvt::term::extension::;\n"
531	. "#line 1 \"$path\"\n{\n"	721	. "#line 1 \"$path\"\n{\n"
532	. (do { local $/; <$fh> })	722	. (do { local $/; <$fh> })
533	. "\n};\n1";	723	. "\n};\n1";
534		724
535	eval $source	725	eval $source
…		…
549	if ($htype == 0) { # INIT	739	if ($htype == 0) { # INIT
550	my @dirs = ((split /:/, $TERM->resource ("perl_lib")), "$LIBDIR/perl");	740	my @dirs = ((split /:/, $TERM->resource ("perl_lib")), "$LIBDIR/perl");
551		741
552	my %ext_arg;	742	my %ext_arg;
553		743
		744	{
		745	my @init = @TERM_INIT;
		746	@TERM_INIT = ();
		747	$_->($TERM) for @init;
		748	my @pkg = @TERM_EXT;
		749	@TERM_EXT = ();
		750	$TERM->register_package ($_) for @pkg;
		751	}
		752
554	for (map { split /,/, $TERM->resource ("perl_ext_$_") } 1, 2) {	753	for (grep $_, map { split /,/, $TERM->resource ("perl_ext_$_") } 1, 2) {
555	if ($_ eq "default") {	754	if ($_ eq "default") {
556	$ext_arg{$_} \|\|= [] for qw(selection option-popup selection-popup searchable-scrollback);	755	$ext_arg{$_} \|\|= [] for qw(selection option-popup selection-popup searchable-scrollback);
557	} elsif (/^-(.*)$/) {	756	} elsif (/^-(.*)$/) {
558	delete $ext_arg{$1};	757	delete $ext_arg{$1};
559	} elsif (/^([^<]+)<(.*)>$/) {	758	} elsif (/^([^<]+)<(.*)>$/) {
…		…
584	if $verbosity >= 10;	783	if $verbosity >= 10;
585		784
586	keys %$cb;	785	keys %$cb;
587		786
588	while (my ($pkg, $cb) = each %$cb) {	787	while (my ($pkg, $cb) = each %$cb) {
589	$retval = eval { $cb->($TERM->{_pkg}{$pkg}, @_) }	788	my $retval_ = eval { $cb->($TERM->{_pkg}{$pkg}, @_) };
590	and last;	789	$retval \|\|= $retval_;
591		790
592	if ($@) {	791	if ($@) {
593	$TERM->ungrab; # better to lose the grab than the session	792	$TERM->ungrab; # better to lose the grab than the session
594	warn $@;	793	warn $@;
595	}	794	}
596	}	795	}
		796
		797	verbose 11, "$HOOKNAME[$htype] returning <$retval>"
		798	if $verbosity >= 11;
597	}	799	}
598		800
599	if ($htype == 1) { # DESTROY	801	if ($htype == 1) { # DESTROY
600	if (my $hook = delete $TERM->{_hook}) {
601	for my $htype (0..$#$hook) {
602	$hook_count[$htype] -= scalar keys %{ $hook->[$htype] \|\| {} }
603	or set_should_invoke $htype, 0;
604	}
605	}
606
607	# clear package objects	802	# clear package objects
608	%$_ = () for values %{ $TERM->{_pkg} };	803	%$_ = () for values %{ $TERM->{_pkg} };
609		804
610	# clear package	805	# clear package
611	%$TERM = ();	806	%$TERM = ();
…		…
625	while (my ($name, $cb) = each %hook) {	820	while (my ($name, $cb) = each %hook) {
626	my $htype = $HOOKTYPE{uc $name};	821	my $htype = $HOOKTYPE{uc $name};
627	defined $htype	822	defined $htype
628	or Carp::croak "unsupported hook type '$name'";	823	or Carp::croak "unsupported hook type '$name'";
629		824
		825	$self->set_should_invoke ($htype, +1)
630	unless (exists $self->{term}{_hook}[$htype]{$pkg}) {	826	unless exists $self->{term}{_hook}[$htype]{$pkg};
631	$hook_count[$htype]++
632	or urxvt::set_should_invoke $htype, 1;
633	}
634		827
635	$self->{term}{_hook}[$htype]{$pkg} = $cb;	828	$self->{term}{_hook}[$htype]{$pkg} = $cb;
636	}	829	}
637	}	830	}
638		831
…		…
643	for my $name (@hook) {	836	for my $name (@hook) {
644	my $htype = $HOOKTYPE{uc $name};	837	my $htype = $HOOKTYPE{uc $name};
645	defined $htype	838	defined $htype
646	or Carp::croak "unsupported hook type '$name'";	839	or Carp::croak "unsupported hook type '$name'";
647		840
		841	$self->set_should_invoke ($htype, -1)
648	if (delete $self->{term}{_hook}[$htype]{$pkg}) {	842	if delete $self->{term}{_hook}[$htype]{$pkg};
649	--$hook_count[$htype]
650	or urxvt::set_should_invoke $htype, 0;
651	}
652	}	843	}
653	}	844	}
654		845
655	our $AUTOLOAD;	846	our $AUTOLOAD;
656		847
…		…
762	# find on_xxx subs in the package and register them	953	# find on_xxx subs in the package and register them
763	# as hooks	954	# as hooks
764	sub register_package {	955	sub register_package {
765	my ($self, $pkg, $argv) = @_;	956	my ($self, $pkg, $argv) = @_;
766		957
		958	no strict 'refs';
		959
		960	urxvt::verbose 6, "register package $pkg to $self";
		961
		962	@{"$pkg\::ISA"} = urxvt::term::extension::;
		963
767	my $proxy = bless {	964	my $proxy = bless {
768	_pkg => $pkg,	965	_pkg => $pkg,
769	argv => $argv,	966	argv => $argv,
770	}, $pkg;	967	}, $pkg;
771	Scalar::Util::weaken ($proxy->{term} = $self);	968	Scalar::Util::weaken ($proxy->{term} = $self);
…		…
802		999
803	Destroy the terminal object (close the window, free resources	1000	Destroy the terminal object (close the window, free resources
804	etc.). Please note that @@RXVT_NAME@@ will not exit as long as any event	1001	etc.). Please note that @@RXVT_NAME@@ will not exit as long as any event
805	watchers (timers, io watchers) are still active.	1002	watchers (timers, io watchers) are still active.
806		1003
		1004	=item $term->exec_async ($cmd[, @args])
		1005
		1006	Works like the combination of the C<fork>/C<exec> builtins, which executes
		1007	("starts") programs in the background. This function takes care of setting
		1008	the user environment before exec'ing the command (e.g. C<PATH>) and should
		1009	be preferred over explicit calls to C<exec> or C<system>.
		1010
		1011	Returns the pid of the subprocess or C<undef> on error.
		1012
		1013	=cut
		1014
		1015	sub exec_async {
		1016	my $self = shift;
		1017
		1018	my $pid = fork;
		1019
		1020	return $pid
		1021	if !defined $pid or $pid;
		1022
		1023	%ENV = %{ $self->env };
		1024
		1025	exec @_;
		1026	urxvt::_exit 255;
		1027	}
		1028
807	=item $isset = $term->option ($optval[, $set])	1029	=item $isset = $term->option ($optval[, $set])
808		1030
809	Returns true if the option specified by C<$optval> is enabled, and	1031	Returns true if the option specified by C<$optval> is enabled, and
810	optionally change it. All option values are stored by name in the hash	1032	optionally change it. All option values are stored by name in the hash
811	C<%urxvt::OPTION>. Options not enabled in this binary are not in the hash.	1033	C<%urxvt::OPTION>. Options not enabled in this binary are not in the hash.
…		…
813	Here is a a likely non-exhaustive list of option names, please see the	1035	Here is a a likely non-exhaustive list of option names, please see the
814	source file F</src/optinc.h> to see the actual list:	1036	source file F</src/optinc.h> to see the actual list:
815		1037
816	borderLess console cursorBlink cursorUnderline hold iconic insecure	1038	borderLess console cursorBlink cursorUnderline hold iconic insecure
817	intensityStyles jumpScroll loginShell mapAlert meta8 mouseWheelScrollPage	1039	intensityStyles jumpScroll loginShell mapAlert meta8 mouseWheelScrollPage
818	pastableTabs pointerBlank reverseVideo scrollBar scrollBar_floating	1040	override-redirect pastableTabs pointerBlank reverseVideo scrollBar
819	scrollBar_right scrollTtyKeypress scrollTtyOutput scrollWithBuffer	1041	scrollBar_floating scrollBar_right scrollTtyKeypress scrollTtyOutput
820	secondaryScreen secondaryScroll skipBuiltinGlyphs transparent	1042	scrollWithBuffer secondaryScreen secondaryScroll skipBuiltinGlyphs
821	tripleclickwords utmpInhibit visualBell	1043	transparent tripleclickwords utmpInhibit visualBell
822		1044
823	=item $value = $term->resource ($name[, $newval])	1045	=item $value = $term->resource ($name[, $newval])
824		1046
825	Returns the current resource value associated with a given name and	1047	Returns the current resource value associated with a given name and
826	optionally sets a new value. Setting values is most useful in the C<init>	1048	optionally sets a new value. Setting values is most useful in the C<init>
…		…
843		1065
844	answerbackstring backgroundPixmap backspace_key boldFont boldItalicFont	1066	answerbackstring backgroundPixmap backspace_key boldFont boldItalicFont
845	borderLess color cursorBlink cursorUnderline cutchars delete_key	1067	borderLess color cursorBlink cursorUnderline cutchars delete_key
846	display_name embed ext_bwidth fade font geometry hold iconName	1068	display_name embed ext_bwidth fade font geometry hold iconName
847	imFont imLocale inputMethod insecure int_bwidth intensityStyles	1069	imFont imLocale inputMethod insecure int_bwidth intensityStyles
848	italicFont jumpScroll lineSpace loginShell mapAlert menu meta8 modifier	1070	italicFont jumpScroll lineSpace loginShell mapAlert meta8 modifier
849	mouseWheelScrollPage name pastableTabs path perl_eval perl_ext_1 perl_ext_2	1071	mouseWheelScrollPage name override_redirect pastableTabs path perl_eval
850	perl_lib pointerBlank pointerBlankDelay preeditType print_pipe pty_fd	1072	perl_ext_1 perl_ext_2 perl_lib pointerBlank pointerBlankDelay
851	reverseVideo saveLines scrollBar scrollBar_align scrollBar_floating	1073	preeditType print_pipe pty_fd reverseVideo saveLines scrollBar
852	scrollBar_right scrollBar_thickness scrollTtyKeypress scrollTtyOutput	1074	scrollBar_align scrollBar_floating scrollBar_right scrollBar_thickness
853	scrollWithBuffer scrollstyle secondaryScreen secondaryScroll selectstyle	1075	scrollTtyKeypress scrollTtyOutput scrollWithBuffer scrollstyle
854	shade term_name title transparent transparent_all tripleclickwords	1076	secondaryScreen secondaryScroll selectstyle shade term_name title
855	utmpInhibit visualBell	1077	transient_for transparent transparent_all tripleclickwords utmpInhibit
		1078	visualBell
856		1079
857	=cut	1080	=cut
858		1081
859	sub resource($$;$) {	1082	sub resource($$;$) {
860	my ($self, $name) = (shift, shift);	1083	my ($self, $name) = (shift, shift);
861	unshift @_, $self, $name, ($name =~ s/\s\+\s(\d+)$// ? $1 : 0);	1084	unshift @_, $self, $name, ($name =~ s/\s\+\s(\d+)$// ? $1 : 0);
862	&urxvt::term::_resource	1085	&urxvt::term::_resource
863	}	1086	}
864		1087
		1088	=item $value = $term->x_resource ($pattern)
		1089
		1090	Returns the X-Resource for the given pattern, excluding the program or
		1091	class name, i.e. C<< $term->x_resource ("boldFont") >> should return the
		1092	same value as used by this instance of rxvt-unicode. Returns C<undef> if no
		1093	resource with that pattern exists.
		1094
		1095	This method should only be called during the C<on_start> hook, as there is
		1096	only one resource database per display, and later invocations might return
		1097	the wrong resources.
		1098
865	=item $success = $term->parse_keysym ($keysym_spec, $command_string)	1099	=item $success = $term->parse_keysym ($keysym_spec, $command_string)
866		1100
867	Adds a keymap translation exactly as specified via a resource. See the	1101	Adds a keymap translation exactly as specified via a resource. See the
868	C<keysym> resource in the @@RXVT_NAME@@(1) manpage.	1102	C<keysym> resource in the @@RXVT_NAME@@(1) manpage.
869		1103
…		…
884	=item ($row, $col) = $term->selection_end ([$row, $col])	1118	=item ($row, $col) = $term->selection_end ([$row, $col])
885		1119
886	Return the current values of the selection mark, begin or end positions,	1120	Return the current values of the selection mark, begin or end positions,
887	and optionally set them to new values.	1121	and optionally set them to new values.
888		1122
		1123	=item $term->selection_make ($eventtime[, $rectangular])
		1124
		1125	Tries to make a selection as set by C<selection_beg> and
		1126	C<selection_end>. If C<$rectangular> is true (default: false), a
		1127	rectangular selection will be made. This is the prefered function to make
		1128	a selection.
		1129
889	=item $success = $term->selection_grab ($eventtime)	1130	=item $success = $term->selection_grab ($eventtime)
890		1131
891	Try to request the primary selection from the server (for example, as set	1132	Try to request the primary selection text from the server (for example, as
892	by the next method).	1133	set by the next method). No visual feedback will be given. This function
		1134	is mostly useful from within C<on_sel_grab> hooks.
893		1135
894	=item $oldtext = $term->selection ([$newtext])	1136	=item $oldtext = $term->selection ([$newtext])
895		1137
896	Return the current selection text and optionally replace it by C<$newtext>.	1138	Return the current selection text and optionally replace it by C<$newtext>.
897		1139
…		…
990	Convert the given locale-encoded octets into a perl string.	1232	Convert the given locale-encoded octets into a perl string.
991		1233
992	=item $term->scr_xor_span ($beg_row, $beg_col, $end_row, $end_col[, $rstyle])	1234	=item $term->scr_xor_span ($beg_row, $beg_col, $end_row, $end_col[, $rstyle])
993		1235
994	XORs the rendition values in the given span with the provided value	1236	XORs the rendition values in the given span with the provided value
995	(default: C<RS_RVid>). Useful in refresh hooks to provide effects similar	1237	(default: C<RS_RVid>), which I<MUST NOT> contain font styles. Useful in
996	to the selection.	1238	refresh hooks to provide effects similar to the selection.
997		1239
998	=item $term->scr_xor_rect ($beg_row, $beg_col, $end_row, $end_col[, $rstyle1[, $rstyle2]])	1240	=item $term->scr_xor_rect ($beg_row, $beg_col, $end_row, $end_col[, $rstyle1[, $rstyle2]])
999		1241
1000	Similar to C<scr_xor_span>, but xors a rectangle instead. Trailing	1242	Similar to C<scr_xor_span>, but xors a rectangle instead. Trailing
1001	whitespace will additionally be xored with the C<$rstyle2>, which defaults	1243	whitespace will additionally be xored with the C<$rstyle2>, which defaults
1002	to C<RS_RVid \| RS_Uline>, which removes reverse video again and underlines	1244	to C<RS_RVid \| RS_Uline>, which removes reverse video again and underlines
1003	it instead.	1245	it instead. Both styles I<MUST NOT> contain font styles.
1004		1246
1005	=item $term->scr_bell	1247	=item $term->scr_bell
1006		1248
1007	Ring the bell!	1249	Ring the bell!
1008		1250
…		…
1042		1284
1043	=item $windowid = $term->vt	1285	=item $windowid = $term->vt
1044		1286
1045	Return the window id of the terminal window.	1287	Return the window id of the terminal window.
1046		1288
		1289	=item $term->vt_emask_add ($x_event_mask)
		1290
		1291	Adds the specified events to the vt event mask. Useful e.g. when you want
		1292	to receive pointer events all the times:
		1293
		1294	$term->vt_emask_add (urxvt::PointerMotionMask);
		1295
1047	=item $window_width = $term->width	1296	=item $window_width = $term->width
1048		1297
1049	=item $window_height = $term->height	1298	=item $window_height = $term->height
1050		1299
1051	=item $font_width = $term->fwidth	1300	=item $font_width = $term->fwidth
…		…
1064		1313
1065	=item $max_scrollback = $term->saveLines	1314	=item $max_scrollback = $term->saveLines
1066		1315
1067	=item $nrow_plus_saveLines = $term->total_rows	1316	=item $nrow_plus_saveLines = $term->total_rows
1068		1317
1069	=item $lines_in_scrollback = $term->nsaved	1318	=item $topmost_scrollback_row = $term->top_row
1070		1319
1071	Return various integers describing terminal characteristics.	1320	Return various integers describing terminal characteristics.
1072		1321
1073	=item $x_display = $term->display_id	1322	=item $x_display = $term->display_id
1074		1323
…		…
1102	Return the modifier masks corresponding to the "ISO Level 3 Shift" (often	1351	Return the modifier masks corresponding to the "ISO Level 3 Shift" (often
1103	AltGr), the meta key (often Alt) and the num lock key, if applicable.	1352	AltGr), the meta key (often Alt) and the num lock key, if applicable.
1104		1353
1105	=item $view_start = $term->view_start ([$newvalue])	1354	=item $view_start = $term->view_start ([$newvalue])
1106		1355
1107	Returns the negative row number of the topmost line. Minimum value is	1356	Returns the row number of the topmost displayed line. Maximum value is
1108	C<0>, which displays the normal terminal contents. Larger values scroll	1357	C<0>, which displays the normal terminal contents. Lower values scroll
1109	this many lines into the scrollback buffer.	1358	this many lines into the scrollback buffer.
1110		1359
1111	=item $term->want_refresh	1360	=item $term->want_refresh
1112		1361
1113	Requests a screen refresh. At the next opportunity, rxvt-unicode will	1362	Requests a screen refresh. At the next opportunity, rxvt-unicode will
…		…
1192	Return the row number of the first/last row of the line, respectively.	1441	Return the row number of the first/last row of the line, respectively.
1193		1442
1194	=item $offset = $line->offset_of ($row, $col)	1443	=item $offset = $line->offset_of ($row, $col)
1195		1444
1196	Returns the character offset of the given row\|col pair within the logical	1445	Returns the character offset of the given row\|col pair within the logical
1197	line.	1446	line. Works for rows outside the line, too, and returns corresponding
		1447	offsets outside the string.
1198		1448
1199	=item ($row, $col) = $line->coord_of ($offset)	1449	=item ($row, $col) = $line->coord_of ($offset)
1200		1450
1201	Translates a string offset into terminal coordinates again.	1451	Translates a string offset into terminal coordinates again.
1202		1452
…		…
1425	my $env = $self->{term}->env;	1675	my $env = $self->{term}->env;
1426	# we can't hope to reproduce the locale algorithm, so nuke LC_ALL and set LC_CTYPE.	1676	# we can't hope to reproduce the locale algorithm, so nuke LC_ALL and set LC_CTYPE.
1427	delete $env->{LC_ALL};	1677	delete $env->{LC_ALL};
1428	$env->{LC_CTYPE} = $self->{term}->locale;	1678	$env->{LC_CTYPE} = $self->{term}->locale;
1429		1679
1430	urxvt::term->new ($env, $self->{term}->resource ("name"),	1680	urxvt::term->new ($env, "popup",
1431	"--perl-lib" => "", "--perl-ext-common" => "", "-pty-fd" => -1, "-sl" => 0, "-b" => 0,	1681	"--perl-lib" => "", "--perl-ext-common" => "",
		1682	"-pty-fd" => -1, "-sl" => 0,
		1683	"-b" => 1, "-bd" => "grey80", "-bl", "-override-redirect",
1432	"--transient-for" => $self->{term}->parent,	1684	"--transient-for" => $self->{term}->parent,
1433	"-display" => $self->{term}->display_id,	1685	"-display" => $self->{term}->display_id,
1434	"-pe" => "urxvt-popup")	1686	"-pe" => "urxvt-popup")
1435	or die "unable to create popup window\n";	1687	or die "unable to create popup window\n";
1436	}	1688	}
…		…
1441	delete $self->{term}{_destroy}{$self};	1693	delete $self->{term}{_destroy}{$self};
1442	$self->{term}->ungrab;	1694	$self->{term}->ungrab;
1443	}	1695	}
1444		1696
1445	=back	1697	=back
		1698
		1699	=cut
		1700
		1701	package urxvt::watcher;
		1702
		1703	@urxvt::timer::ISA = __PACKAGE__;
		1704	@urxvt::iow::ISA = __PACKAGE__;
		1705	@urxvt::pw::ISA = __PACKAGE__;
		1706	@urxvt::iw::ISA = __PACKAGE__;
1446		1707
1447	=head2 The C<urxvt::timer> Class	1708	=head2 The C<urxvt::timer> Class
1448		1709
1449	This class implements timer watchers/events. Time is represented as a	1710	This class implements timer watchers/events. Time is represented as a
1450	fractional number of seconds since the epoch. Example:	1711	fractional number of seconds since the epoch. Example:
…		…
1488	Start the timer.	1749	Start the timer.
1489		1750
1490	=item $timer = $timer->start ($tstamp)	1751	=item $timer = $timer->start ($tstamp)
1491		1752
1492	Set the event trigger time to C<$tstamp> and start the timer.	1753	Set the event trigger time to C<$tstamp> and start the timer.
		1754
		1755	=item $timer = $timer->after ($delay)
		1756
		1757	Like C<start>, but sets the expiry timer to c<urxvt::NOW + $delay>.
1493		1758
1494	=item $timer = $timer->stop	1759	=item $timer = $timer->stop
1495		1760
1496	Stop the timer.	1761	Stop the timer.
1497		1762
…		…
1544		1809
1545	Stop watching for events on the given filehandle.	1810	Stop watching for events on the given filehandle.
1546		1811
1547	=back	1812	=back
1548		1813
		1814	=head2 The C<urxvt::iw> Class
		1815
		1816	This class implements idle watchers, that get called automatically when
		1817	the process is idle. They should return as fast as possible, after doing
		1818	some useful work.
		1819
		1820	=over 4
		1821
		1822	=item $iw = new urxvt::iw
		1823
		1824	Create a new idle watcher object in stopped state.
		1825
		1826	=item $iw = $iw->cb (sub { my ($iw) = @_; ... })
		1827
		1828	Set the callback to be called when the watcher triggers.
		1829
		1830	=item $timer = $timer->start
		1831
		1832	Start the watcher.
		1833
		1834	=item $timer = $timer->stop
		1835
		1836	Stop the watcher.
		1837
		1838	=back
		1839
		1840	=head2 The C<urxvt::pw> Class
		1841
		1842	This class implements process watchers. They create an event whenever a
		1843	process exits, after which they stop automatically.
		1844
		1845	my $pid = fork;
		1846	...
		1847	$term->{pw} = urxvt::pw
		1848	->new
		1849	->start ($pid)
		1850	->cb (sub {
		1851	my ($pw, $exit_status) = @_;
		1852	...
		1853	});
		1854
		1855	=over 4
		1856
		1857	=item $pw = new urxvt::pw
		1858
		1859	Create a new process watcher in stopped state.
		1860
		1861	=item $pw = $pw->cb (sub { my ($pw, $exit_status) = @_; ... })
		1862
		1863	Set the callback to be called when the timer triggers.
		1864
		1865	=item $pw = $timer->start ($pid)
		1866
		1867	Tells the wqtcher to start watching for process C<$pid>.
		1868
		1869	=item $pw = $pw->stop
		1870
		1871	Stop the watcher.
		1872
		1873	=back
		1874
1549	=head1 ENVIRONMENT	1875	=head1 ENVIRONMENT
1550		1876
1551	=head2 URXVT_PERL_VERBOSITY	1877	=head2 URXVT_PERL_VERBOSITY
1552		1878
1553	This variable controls the verbosity level of the perl extension. Higher	1879	This variable controls the verbosity level of the perl extension. Higher
…		…
1557		1883
1558	=item == 0 - fatal messages	1884	=item == 0 - fatal messages
1559		1885
1560	=item >= 3 - script loading and management	1886	=item >= 3 - script loading and management
1561		1887
1562	=item >=10 - all events received	1888	=item >=10 - all called hooks
		1889
		1890	=item >=11 - hook reutrn values
1563		1891
1564	=back	1892	=back
1565		1893
1566	=head1 AUTHOR	1894	=head1 AUTHOR
1567		1895

Diff Legend

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

Comparing rxvt-unicode/src/urxvt.pm (file contents): Revision 1.78 by root, Wed Jan 11 01:01:52 2006 UTC vs. Revision 1.115 by root, Fri Jan 20 15:57:21 2006 UTC

Diff Legend

Comparing rxvt-unicode/src/urxvt.pm (file contents):
Revision 1.78 by root, Wed Jan 11 01:01:52 2006 UTC vs.
Revision 1.115 by root, Fri Jan 20 15:57:21 2006 UTC