[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.114 by root, Fri Jan 20 12:16:28 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.
86		166
87	=item mark-urls	167	=item mark-urls
88		168
89	Uses per-line display filtering (C<on_line_update>) to underline urls.	169	Uses per-line display filtering (C<on_line_update>) to underline urls and
		170	make them clickable. When middle-clicked, the program specified in the
		171	resource C<urlLauncher> (default C<x-www-browser>) will be started with
		172	the URL as first argument.
		173
		174	=item automove-background
		175
		176	This is basically a one-line extension that dynamically changes the background pixmap offset
		177	to the window position, in effect creating the same effect as pseudo transparency with
		178	a custom pixmap. No scaling is supported in this mode. Exmaple:
		179
		180	@@RXVT_NAME@@ -pixmap background.xpm -pe automove-background
90		181
91	=item block-graphics-to-ascii	182	=item block-graphics-to-ascii
92		183
93	A not very useful example of filtering all text output to the terminal,	184	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	185	by replacing all line-drawing characters (U+2500 .. U+259F) by a
95	similar-looking ascii character.	186	similar-looking ascii character.
96		187
		188	=item digital-clock
		189
		190	Displays a digital clock using the built-in overlay.
		191
97	=item example-refresh-hooks	192	=item example-refresh-hooks
98		193
99	Displays a very simple digital clock in the upper right corner of the	194	Displays a very simple digital clock in the upper right corner of the
100	window. Illustrates overwriting the refresh callbacks to create your own	195	window. Illustrates overwriting the refresh callbacks to create your own
101	overlays or changes.	196	overlays or changes.
		197
		198	=item selection-pastebin
		199
		200	This is a little rarely useful extension that Uploads the selection as
		201	textfile to a remote site (or does other things). (The implementation is
		202	not currently secure for use in a multiuser environment as it writes to
		203	F</tmp> directly.).
		204
		205	It listens to the C<selection-pastebin:remote-pastebin> keyboard command,
		206	i.e.
		207
		208	URxvt.keysym.C-M-e: perl:selection-pastebin:remote-pastebin
		209
		210	Pressing this combination runs a command with C<%> replaced by the name of
		211	the textfile. This command can be set via a resource:
		212
		213	URxvt.selection-pastebin.cmd: rsync -apP % ruth:/var/www/www.ta-sa.org/files/txt/.
		214
		215	And the default is likely not useful to anybody but the few people around
		216	here :)
		217
		218	The name of the textfile is the hex encoded md5 sum of the selection, so
		219	the same content should lead to the same filename.
		220
		221	After a successful upload the selection will be replaced by the text given
		222	in the C<selection-pastebin-url> resource (again, the % is the placeholder
		223	for the filename):
		224
		225	URxvt.selection-pastebin.url: http://www.ta-sa.org/files/txt/%
102		226
103	=back	227	=back
104		228
105	=head1 API DOCUMENTATION	229	=head1 API DOCUMENTATION
106		230
…		…
179	called whenever the relevant event happens.	303	called whenever the relevant event happens.
180		304
181	The first argument passed to them is an extension oject as described in	305	The first argument passed to them is an extension oject as described in
182	the in the C<Extension Objects> section.	306	the in the C<Extension Objects> section.
183		307
184	B<All> of these hooks must return a boolean value. If it is true, then the	308	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	309	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.	310	relevant action might not be carried out by the C++ code.
187		311
188	I<< When in doubt, return a false value (preferably C<()>). >>	312	I<< When in doubt, return a false value (preferably C<()>). >>
189		313
190	=over 4	314	=over 4
191		315
192	=item on_init $term	316	=item on_init $term
193		317
194	Called after a new terminal object has been initialized, but before	318	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	319	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	320	call or deliver senseless data, as terminal size and other characteristics
197	have not yet been determined. You can safely query and change resources,	321	have not yet been determined. You can safely query and change resources
198	though.	322	and options, though. For many purposes the C<on_start> hook is a better
		323	place.
		324
		325	=item on_start $term
		326
		327	Called at the very end of initialisation of a new terminal, just before
		328	trying to map (display) the toplevel and returning to the mainloop.
		329
		330	=item on_destroy $term
		331
		332	Called whenever something tries to destroy terminal, before doing anything
		333	yet. If this hook returns true, then destruction is skipped, but this is
		334	rarely a good idea.
199		335
200	=item on_reset $term	336	=item on_reset $term
201		337
202	Called after the screen is "reset" for any reason, such as resizing or	338	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	339	control sequences. Here is where you can react on changes to size-related
204	variables.	340	variables.
205		341
206	=item on_start $term	342	=item on_child_start $term, $pid
207		343
208	Called at the very end of initialisation of a new terminal, just before	344	Called just after the child process has been C<fork>ed.
209	returning to the mainloop.	345
		346	=item on_child_exit $term, $status
		347
		348	Called just after the child process has exited. C<$status> is the status
		349	from C<waitpid>.
210		350
211	=item on_sel_make $term, $eventtime	351	=item on_sel_make $term, $eventtime
212		352
213	Called whenever a selection has been made by the user, but before the	353	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	354	selection text is copied, so changes to the beginning, end or type of the
…		…
228	=item on_sel_extend $term	368	=item on_sel_extend $term
229		369
230	Called whenever the user tries to extend the selection (e.g. with a double	370	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	371	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	372	should extend the selection itelf and return true to suppress the built-in
233	processing.	373	processing. This can happen multiple times, as long as the callback
		374	returns true, it will be called on every further click by the user and is
		375	supposed to enlarge the selection more and more, if possible.
234		376
235	See the F<selection> example extension.	377	See the F<selection> example extension.
236		378
237	=item on_view_change $term, $offset	379	=item on_view_change $term, $offset
238		380
…		…
305		447
306	Called whenever the user presses a key combination that has a	448	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>	449	C<perl:string> action bound to it (see description of the B<keysym>
308	resource in the @@RXVT_NAME@@(1) manpage).	450	resource in the @@RXVT_NAME@@(1) manpage).
309		451
		452	=item on_x_event $term, $event
		453
		454	Called on every X event received on the vt window (and possibly other
		455	windows). Should only be used as a last resort. Most event structure
		456	members are not passed.
		457
310	=item on_focus_in $term	458	=item on_focus_in $term
311		459
312	Called whenever the window gets the keyboard focus, before rxvt-unicode	460	Called whenever the window gets the keyboard focus, before rxvt-unicode
313	does focus in processing.	461	does focus in processing.
314		462
315	=item on_focus_out $term	463	=item on_focus_out $term
316		464
317	Called wheneever the window loses keyboard focus, before rxvt-unicode does	465	Called wheneever the window loses keyboard focus, before rxvt-unicode does
318	focus out processing.	466	focus out processing.
		467
		468	=item on_configure_notify $term, $event
319		469
320	=item on_key_press $term, $event, $keysym, $octets	470	=item on_key_press $term, $event, $keysym, $octets
321		471
322	=item on_key_release $term, $event, $keysym	472	=item on_key_release $term, $event, $keysym
323		473
…		…
340		490
341	C<on_key_press> additionally receives the string rxvt-unicode would	491	C<on_key_press> additionally receives the string rxvt-unicode would
342	output, if any, in locale-specific encoding.	492	output, if any, in locale-specific encoding.
343		493
344	subwindow.	494	subwindow.
		495
		496	=item on_client_message $term, $event
		497
		498	=item on_wm_protocols $term, $event
		499
		500	=item on_wm_delete_window $term, $event
		501
		502	Called when various types of ClientMessage events are received (all with
		503	format=32, WM_PROTOCOLS or WM_PROTOCOLS:WM_DELETE_WINDOW).
345		504
346	=back	505	=back
347		506
348	=cut	507	=cut
349		508
…		…
355	use Scalar::Util ();	514	use Scalar::Util ();
356	use List::Util ();	515	use List::Util ();
357		516
358	our $VERSION = 1;	517	our $VERSION = 1;
359	our $TERM;	518	our $TERM;
		519	our @TERM_INIT;
		520	our @TERM_EXT;
360	our @HOOKNAME;	521	our @HOOKNAME;
361	our %HOOKTYPE = map +($HOOKNAME[$_] => $_), 0..$#HOOKNAME;	522	our %HOOKTYPE = map +($HOOKNAME[$_] => $_), 0..$#HOOKNAME;
362	our %OPTION;	523	our %OPTION;
363		524
364	our $LIBDIR;	525	our $LIBDIR;
…		…
386	=item $urxvt::TERM	547	=item $urxvt::TERM
387		548
388	The current terminal. This variable stores the current C<urxvt::term>	549	The current terminal. This variable stores the current C<urxvt::term>
389	object, whenever a callback/hook is executing.	550	object, whenever a callback/hook is executing.
390		551
		552	=item @urxvt::TERM_INIT
		553
		554	All coderefs in this array will be called as methods of the next newly
		555	created C<urxvt::term> object (during the C<on_init> phase). The array
		556	gets cleared before the codereferences that were in it are being executed,
		557	so coderefs can push themselves onto it again if they so desire.
		558
		559	This complements to the perl-eval commandline option, but gets executed
		560	first.
		561
		562	=item @urxvt::TERM_EXT
		563
		564	Works similar to C<@TERM_INIT>, but contains perl package/class names, which
		565	get registered as normal extensions after calling the hooks in C<@TERM_INIT>
		566	but before other extensions. Gets cleared just like C<@TERM_INIT>.
		567
391	=back	568	=back
392		569
393	=head2 Functions in the C<urxvt> Package	570	=head2 Functions in the C<urxvt> Package
394		571
395	=over 4	572	=over 4
…		…
409	Using this function has the advantage that its output ends up in the	586	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.	587	correct place, e.g. on stderr of the connecting urxvtc client.
411		588
412	Messages have a size limit of 1023 bytes currently.	589	Messages have a size limit of 1023 bytes currently.
413		590
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	591	=item $time = urxvt::NOW
421		592
422	Returns the "current time" (as per the event loop).	593	Returns the "current time" (as per the event loop).
423		594
424	=item urxvt::CurrentTime	595	=item urxvt::CurrentTime
425		596
426	=item urxvt::ShiftMask, LockMask, ControlMask, Mod1Mask, Mod2Mask,	597	=item urxvt::ShiftMask, LockMask, ControlMask, Mod1Mask, Mod2Mask,
427	Mod3Mask, Mod4Mask, Mod5Mask, Button1Mask, Button2Mask, Button3Mask,	598	Mod3Mask, Mod4Mask, Mod5Mask, Button1Mask, Button2Mask, Button3Mask,
428	Button4Mask, Button5Mask, AnyModifier	599	Button4Mask, Button5Mask, AnyModifier
		600
		601	=item urxvt::NoEventMask, KeyPressMask, KeyReleaseMask,
		602	ButtonPressMask, ButtonReleaseMask, EnterWindowMask, LeaveWindowMask,
		603	PointerMotionMask, PointerMotionHintMask, Button1MotionMask, Button2MotionMask,
		604	Button3MotionMask, Button4MotionMask, Button5MotionMask, ButtonMotionMask,
		605	KeymapStateMask, ExposureMask, VisibilityChangeMask, StructureNotifyMask,
		606	ResizeRedirectMask, SubstructureNotifyMask, SubstructureRedirectMask,
		607	FocusChangeMask, PropertyChangeMask, ColormapChangeMask, OwnerGrabButtonMask
		608
		609	=item urxvt::KeyPress, KeyRelease, ButtonPress, ButtonRelease, MotionNotify,
		610	EnterNotify, LeaveNotify, FocusIn, FocusOut, KeymapNotify, Expose,
		611	GraphicsExpose, NoExpose, VisibilityNotify, CreateNotify, DestroyNotify,
		612	UnmapNotify, MapNotify, MapRequest, ReparentNotify, ConfigureNotify,
		613	ConfigureRequest, GravityNotify, ResizeRequest, CirculateNotify,
		614	CirculateRequest, PropertyNotify, SelectionClear, SelectionRequest,
		615	SelectionNotify, ColormapNotify, ClientMessage, MappingNotify
429		616
430	Various constants for use in X calls and event processing.	617	Various constants for use in X calls and event processing.
431		618
432	=back	619	=back
433		620
…		…
484	=back	671	=back
485		672
486	=cut	673	=cut
487		674
488	BEGIN {	675	BEGIN {
489	urxvt->bootstrap;
490
491	# overwrite perl's warn	676	# overwrite perl's warn
492	*CORE::GLOBAL::warn = sub {	677	*CORE::GLOBAL::warn = sub {
493	my $msg = join "", @_;	678	my $msg = join "", @_;
494	$msg .= "\n"	679	$msg .= "\n"
495	unless $msg =~ /\n$/;	680	unless $msg =~ /\n$/;
496	urxvt::warn ($msg);	681	urxvt::warn ($msg);
497	};	682	};
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	}	683	}
504		684
505	my @hook_count;
506	my $verbosity = $ENV{URXVT_PERL_VERBOSITY};	685	my $verbosity = $ENV{URXVT_PERL_VERBOSITY};
507		686
508	sub verbose {	687	sub verbose {
509	my ($level, $msg) = @_;	688	my ($level, $msg) = @_;
510	warn "$msg\n" if $level <= $verbosity;	689	warn "$msg\n" if $level <= $verbosity;
511	}	690	}
512		691
513	my $extension_pkg = "extension0000";
514	my %extension_pkg;	692	my %extension_pkg;
515		693
516	# load a single script into its own package, once only	694	# load a single script into its own package, once only
517	sub extension_package($) {	695	sub extension_package($) {
518	my ($path) = @_;	696	my ($path) = @_;
519		697
520	$extension_pkg{$path} \|\|= do {	698	$extension_pkg{$path} \|\|= do {
521	my $pkg = "urxvt::" . ($extension_pkg++);	699	$path =~ /([^\/\\]+)$/;
		700	my $pkg = $1;
		701	$pkg =~ s/[^[:word:]]/_/g;
		702	$pkg = "urxvt::ext::$pkg";
522		703
523	verbose 3, "loading extension '$path' into package '$pkg'";	704	verbose 3, "loading extension '$path' into package '$pkg'";
524		705
525	open my $fh, "<:raw", $path	706	open my $fh, "<:raw", $path
526	or die "$path: $!";	707	or die "$path: $!";
527		708
528	my $source = untaint	709	my $source =
529	"package $pkg; use strict; use utf8;\n"	710	"package $pkg; use strict; use utf8;\n"
530	. "use base urxvt::term::extension::;\n"
531	. "#line 1 \"$path\"\n{\n"	711	. "#line 1 \"$path\"\n{\n"
532	. (do { local $/; <$fh> })	712	. (do { local $/; <$fh> })
533	. "\n};\n1";	713	. "\n};\n1";
534		714
535	eval $source	715	eval $source
…		…
549	if ($htype == 0) { # INIT	729	if ($htype == 0) { # INIT
550	my @dirs = ((split /:/, $TERM->resource ("perl_lib")), "$LIBDIR/perl");	730	my @dirs = ((split /:/, $TERM->resource ("perl_lib")), "$LIBDIR/perl");
551		731
552	my %ext_arg;	732	my %ext_arg;
553		733
		734	{
		735	my @init = @TERM_INIT;
		736	@TERM_INIT = ();
		737	$_->($TERM) for @init;
		738	my @pkg = @TERM_EXT;
		739	@TERM_EXT = ();
		740	$TERM->register_package ($_) for @pkg;
		741	}
		742
554	for (map { split /,/, $TERM->resource ("perl_ext_$_") } 1, 2) {	743	for (grep $_, map { split /,/, $TERM->resource ("perl_ext_$_") } 1, 2) {
555	if ($_ eq "default") {	744	if ($_ eq "default") {
556	$ext_arg{$_} \|\|= [] for qw(selection option-popup selection-popup searchable-scrollback);	745	$ext_arg{$_} \|\|= [] for qw(selection option-popup selection-popup searchable-scrollback);
557	} elsif (/^-(.*)$/) {	746	} elsif (/^-(.*)$/) {
558	delete $ext_arg{$1};	747	delete $ext_arg{$1};
559	} elsif (/^([^<]+)<(.*)>$/) {	748	} elsif (/^([^<]+)<(.*)>$/) {
…		…
584	if $verbosity >= 10;	773	if $verbosity >= 10;
585		774
586	keys %$cb;	775	keys %$cb;
587		776
588	while (my ($pkg, $cb) = each %$cb) {	777	while (my ($pkg, $cb) = each %$cb) {
589	$retval = eval { $cb->($TERM->{_pkg}{$pkg}, @_) }	778	my $retval_ = eval { $cb->($TERM->{_pkg}{$pkg}, @_) };
590	and last;	779	$retval \|\|= $retval_;
591		780
592	if ($@) {	781	if ($@) {
593	$TERM->ungrab; # better to lose the grab than the session	782	$TERM->ungrab; # better to lose the grab than the session
594	warn $@;	783	warn $@;
595	}	784	}
596	}	785	}
		786
		787	verbose 11, "$HOOKNAME[$htype] returning <$retval>"
		788	if $verbosity >= 11;
597	}	789	}
598		790
599	if ($htype == 1) { # DESTROY	791	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	792	# clear package objects
608	%$_ = () for values %{ $TERM->{_pkg} };	793	%$_ = () for values %{ $TERM->{_pkg} };
609		794
610	# clear package	795	# clear package
611	%$TERM = ();	796	%$TERM = ();
…		…
625	while (my ($name, $cb) = each %hook) {	810	while (my ($name, $cb) = each %hook) {
626	my $htype = $HOOKTYPE{uc $name};	811	my $htype = $HOOKTYPE{uc $name};
627	defined $htype	812	defined $htype
628	or Carp::croak "unsupported hook type '$name'";	813	or Carp::croak "unsupported hook type '$name'";
629		814
		815	$self->set_should_invoke ($htype, +1)
630	unless (exists $self->{term}{_hook}[$htype]{$pkg}) {	816	unless exists $self->{term}{_hook}[$htype]{$pkg};
631	$hook_count[$htype]++
632	or urxvt::set_should_invoke $htype, 1;
633	}
634		817
635	$self->{term}{_hook}[$htype]{$pkg} = $cb;	818	$self->{term}{_hook}[$htype]{$pkg} = $cb;
636	}	819	}
637	}	820	}
638		821
…		…
643	for my $name (@hook) {	826	for my $name (@hook) {
644	my $htype = $HOOKTYPE{uc $name};	827	my $htype = $HOOKTYPE{uc $name};
645	defined $htype	828	defined $htype
646	or Carp::croak "unsupported hook type '$name'";	829	or Carp::croak "unsupported hook type '$name'";
647		830
		831	$self->set_should_invoke ($htype, -1)
648	if (delete $self->{term}{_hook}[$htype]{$pkg}) {	832	if delete $self->{term}{_hook}[$htype]{$pkg};
649	--$hook_count[$htype]
650	or urxvt::set_should_invoke $htype, 0;
651	}
652	}	833	}
653	}	834	}
654		835
655	our $AUTOLOAD;	836	our $AUTOLOAD;
656		837
…		…
762	# find on_xxx subs in the package and register them	943	# find on_xxx subs in the package and register them
763	# as hooks	944	# as hooks
764	sub register_package {	945	sub register_package {
765	my ($self, $pkg, $argv) = @_;	946	my ($self, $pkg, $argv) = @_;
766		947
		948	no strict 'refs';
		949
		950	urxvt::verbose 6, "register package $pkg to $self";
		951
		952	@{"$pkg\::ISA"} = urxvt::term::extension::;
		953
767	my $proxy = bless {	954	my $proxy = bless {
768	_pkg => $pkg,	955	_pkg => $pkg,
769	argv => $argv,	956	argv => $argv,
770	}, $pkg;	957	}, $pkg;
771	Scalar::Util::weaken ($proxy->{term} = $self);	958	Scalar::Util::weaken ($proxy->{term} = $self);
…		…
802		989
803	Destroy the terminal object (close the window, free resources	990	Destroy the terminal object (close the window, free resources
804	etc.). Please note that @@RXVT_NAME@@ will not exit as long as any event	991	etc.). Please note that @@RXVT_NAME@@ will not exit as long as any event
805	watchers (timers, io watchers) are still active.	992	watchers (timers, io watchers) are still active.
806		993
		994	=item $term->exec_async ($cmd[, @args])
		995
		996	Works like the combination of the C<fork>/C<exec> builtins, which executes
		997	("starts") programs in the background. This function takes care of setting
		998	the user environment before exec'ing the command (e.g. C<PATH>) and should
		999	be preferred over explicit calls to C<exec> or C<system>.
		1000
		1001	Returns the pid of the subprocess or C<undef> on error.
		1002
		1003	=cut
		1004
		1005	sub exec_async {
		1006	my $self = shift;
		1007
		1008	my $pid = fork;
		1009
		1010	return $pid
		1011	if !defined $pid or $pid;
		1012
		1013	%ENV = %{ $self->env };
		1014
		1015	exec @_;
		1016	urxvt::_exit 255;
		1017	}
		1018
807	=item $isset = $term->option ($optval[, $set])	1019	=item $isset = $term->option ($optval[, $set])
808		1020
809	Returns true if the option specified by C<$optval> is enabled, and	1021	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	1022	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.	1023	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	1025	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:	1026	source file F</src/optinc.h> to see the actual list:
815		1027
816	borderLess console cursorBlink cursorUnderline hold iconic insecure	1028	borderLess console cursorBlink cursorUnderline hold iconic insecure
817	intensityStyles jumpScroll loginShell mapAlert meta8 mouseWheelScrollPage	1029	intensityStyles jumpScroll loginShell mapAlert meta8 mouseWheelScrollPage
818	pastableTabs pointerBlank reverseVideo scrollBar scrollBar_floating	1030	override-redirect pastableTabs pointerBlank reverseVideo scrollBar
819	scrollBar_right scrollTtyKeypress scrollTtyOutput scrollWithBuffer	1031	scrollBar_floating scrollBar_right scrollTtyKeypress scrollTtyOutput
820	secondaryScreen secondaryScroll skipBuiltinGlyphs transparent	1032	scrollWithBuffer secondaryScreen secondaryScroll skipBuiltinGlyphs
821	tripleclickwords utmpInhibit visualBell	1033	transparent tripleclickwords utmpInhibit visualBell
822		1034
823	=item $value = $term->resource ($name[, $newval])	1035	=item $value = $term->resource ($name[, $newval])
824		1036
825	Returns the current resource value associated with a given name and	1037	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>	1038	optionally sets a new value. Setting values is most useful in the C<init>
…		…
843		1055
844	answerbackstring backgroundPixmap backspace_key boldFont boldItalicFont	1056	answerbackstring backgroundPixmap backspace_key boldFont boldItalicFont
845	borderLess color cursorBlink cursorUnderline cutchars delete_key	1057	borderLess color cursorBlink cursorUnderline cutchars delete_key
846	display_name embed ext_bwidth fade font geometry hold iconName	1058	display_name embed ext_bwidth fade font geometry hold iconName
847	imFont imLocale inputMethod insecure int_bwidth intensityStyles	1059	imFont imLocale inputMethod insecure int_bwidth intensityStyles
848	italicFont jumpScroll lineSpace loginShell mapAlert menu meta8 modifier	1060	italicFont jumpScroll lineSpace loginShell mapAlert meta8 modifier
849	mouseWheelScrollPage name pastableTabs path perl_eval perl_ext_1 perl_ext_2	1061	mouseWheelScrollPage name override_redirect pastableTabs path perl_eval
850	perl_lib pointerBlank pointerBlankDelay preeditType print_pipe pty_fd	1062	perl_ext_1 perl_ext_2 perl_lib pointerBlank pointerBlankDelay
851	reverseVideo saveLines scrollBar scrollBar_align scrollBar_floating	1063	preeditType print_pipe pty_fd reverseVideo saveLines scrollBar
852	scrollBar_right scrollBar_thickness scrollTtyKeypress scrollTtyOutput	1064	scrollBar_align scrollBar_floating scrollBar_right scrollBar_thickness
853	scrollWithBuffer scrollstyle secondaryScreen secondaryScroll selectstyle	1065	scrollTtyKeypress scrollTtyOutput scrollWithBuffer scrollstyle
854	shade term_name title transparent transparent_all tripleclickwords	1066	secondaryScreen secondaryScroll selectstyle shade term_name title
855	utmpInhibit visualBell	1067	transient_for transparent transparent_all tripleclickwords utmpInhibit
		1068	visualBell
856		1069
857	=cut	1070	=cut
858		1071
859	sub resource($$;$) {	1072	sub resource($$;$) {
860	my ($self, $name) = (shift, shift);	1073	my ($self, $name) = (shift, shift);
861	unshift @_, $self, $name, ($name =~ s/\s\+\s(\d+)$// ? $1 : 0);	1074	unshift @_, $self, $name, ($name =~ s/\s\+\s(\d+)$// ? $1 : 0);
862	&urxvt::term::_resource	1075	&urxvt::term::_resource
863	}	1076	}
864		1077
		1078	=item $value = $term->x_resource ($pattern)
		1079
		1080	Returns the X-Resource for the given pattern, excluding the program or
		1081	class name, i.e. C<< $term->x_resource ("boldFont") >> should return the
		1082	same value as used by this instance of rxvt-unicode. Returns C<undef> if no
		1083	resource with that pattern exists.
		1084
		1085	This method should only be called during the C<on_start> hook, as there is
		1086	only one resource database per display, and later invocations might return
		1087	the wrong resources.
		1088
865	=item $success = $term->parse_keysym ($keysym_spec, $command_string)	1089	=item $success = $term->parse_keysym ($keysym_spec, $command_string)
866		1090
867	Adds a keymap translation exactly as specified via a resource. See the	1091	Adds a keymap translation exactly as specified via a resource. See the
868	C<keysym> resource in the @@RXVT_NAME@@(1) manpage.	1092	C<keysym> resource in the @@RXVT_NAME@@(1) manpage.
869		1093
…		…
884	=item ($row, $col) = $term->selection_end ([$row, $col])	1108	=item ($row, $col) = $term->selection_end ([$row, $col])
885		1109
886	Return the current values of the selection mark, begin or end positions,	1110	Return the current values of the selection mark, begin or end positions,
887	and optionally set them to new values.	1111	and optionally set them to new values.
888		1112
		1113	=item $term->selection_make ($eventtime[, $rectangular])
		1114
		1115	Tries to make a selection as set by C<selection_beg> and
		1116	C<selection_end>. If C<$rectangular> is true (default: false), a
		1117	rectangular selection will be made. This is the prefered function to make
		1118	a selection.
		1119
889	=item $success = $term->selection_grab ($eventtime)	1120	=item $success = $term->selection_grab ($eventtime)
890		1121
891	Try to request the primary selection from the server (for example, as set	1122	Try to request the primary selection text from the server (for example, as
892	by the next method).	1123	set by the next method). No visual feedback will be given. This function
		1124	is mostly useful from within C<on_sel_grab> hooks.
893		1125
894	=item $oldtext = $term->selection ([$newtext])	1126	=item $oldtext = $term->selection ([$newtext])
895		1127
896	Return the current selection text and optionally replace it by C<$newtext>.	1128	Return the current selection text and optionally replace it by C<$newtext>.
897		1129
…		…
990	Convert the given locale-encoded octets into a perl string.	1222	Convert the given locale-encoded octets into a perl string.
991		1223
992	=item $term->scr_xor_span ($beg_row, $beg_col, $end_row, $end_col[, $rstyle])	1224	=item $term->scr_xor_span ($beg_row, $beg_col, $end_row, $end_col[, $rstyle])
993		1225
994	XORs the rendition values in the given span with the provided value	1226	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	1227	(default: C<RS_RVid>), which I<MUST NOT> contain font styles. Useful in
996	to the selection.	1228	refresh hooks to provide effects similar to the selection.
997		1229
998	=item $term->scr_xor_rect ($beg_row, $beg_col, $end_row, $end_col[, $rstyle1[, $rstyle2]])	1230	=item $term->scr_xor_rect ($beg_row, $beg_col, $end_row, $end_col[, $rstyle1[, $rstyle2]])
999		1231
1000	Similar to C<scr_xor_span>, but xors a rectangle instead. Trailing	1232	Similar to C<scr_xor_span>, but xors a rectangle instead. Trailing
1001	whitespace will additionally be xored with the C<$rstyle2>, which defaults	1233	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	1234	to C<RS_RVid \| RS_Uline>, which removes reverse video again and underlines
1003	it instead.	1235	it instead. Both styles I<MUST NOT> contain font styles.
1004		1236
1005	=item $term->scr_bell	1237	=item $term->scr_bell
1006		1238
1007	Ring the bell!	1239	Ring the bell!
1008		1240
…		…
1042		1274
1043	=item $windowid = $term->vt	1275	=item $windowid = $term->vt
1044		1276
1045	Return the window id of the terminal window.	1277	Return the window id of the terminal window.
1046		1278
		1279	=item $term->vt_emask_add ($x_event_mask)
		1280
		1281	Adds the specified events to the vt event mask. Useful e.g. when you want
		1282	to receive pointer events all the times:
		1283
		1284	$term->vt_emask_add (urxvt::PointerMotionMask);
		1285
1047	=item $window_width = $term->width	1286	=item $window_width = $term->width
1048		1287
1049	=item $window_height = $term->height	1288	=item $window_height = $term->height
1050		1289
1051	=item $font_width = $term->fwidth	1290	=item $font_width = $term->fwidth
…		…
1064		1303
1065	=item $max_scrollback = $term->saveLines	1304	=item $max_scrollback = $term->saveLines
1066		1305
1067	=item $nrow_plus_saveLines = $term->total_rows	1306	=item $nrow_plus_saveLines = $term->total_rows
1068		1307
1069	=item $lines_in_scrollback = $term->nsaved	1308	=item $topmost_scrollback_row = $term->top_row
1070		1309
1071	Return various integers describing terminal characteristics.	1310	Return various integers describing terminal characteristics.
1072		1311
1073	=item $x_display = $term->display_id	1312	=item $x_display = $term->display_id
1074		1313
…		…
1102	Return the modifier masks corresponding to the "ISO Level 3 Shift" (often	1341	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.	1342	AltGr), the meta key (often Alt) and the num lock key, if applicable.
1104		1343
1105	=item $view_start = $term->view_start ([$newvalue])	1344	=item $view_start = $term->view_start ([$newvalue])
1106		1345
1107	Returns the negative row number of the topmost line. Minimum value is	1346	Returns the row number of the topmost displayed line. Maximum value is
1108	C<0>, which displays the normal terminal contents. Larger values scroll	1347	C<0>, which displays the normal terminal contents. Lower values scroll
1109	this many lines into the scrollback buffer.	1348	this many lines into the scrollback buffer.
1110		1349
1111	=item $term->want_refresh	1350	=item $term->want_refresh
1112		1351
1113	Requests a screen refresh. At the next opportunity, rxvt-unicode will	1352	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.	1431	Return the row number of the first/last row of the line, respectively.
1193		1432
1194	=item $offset = $line->offset_of ($row, $col)	1433	=item $offset = $line->offset_of ($row, $col)
1195		1434
1196	Returns the character offset of the given row\|col pair within the logical	1435	Returns the character offset of the given row\|col pair within the logical
1197	line.	1436	line. Works for rows outside the line, too, and returns corresponding
		1437	offsets outside the string.
1198		1438
1199	=item ($row, $col) = $line->coord_of ($offset)	1439	=item ($row, $col) = $line->coord_of ($offset)
1200		1440
1201	Translates a string offset into terminal coordinates again.	1441	Translates a string offset into terminal coordinates again.
1202		1442
…		…
1425	my $env = $self->{term}->env;	1665	my $env = $self->{term}->env;
1426	# we can't hope to reproduce the locale algorithm, so nuke LC_ALL and set LC_CTYPE.	1666	# we can't hope to reproduce the locale algorithm, so nuke LC_ALL and set LC_CTYPE.
1427	delete $env->{LC_ALL};	1667	delete $env->{LC_ALL};
1428	$env->{LC_CTYPE} = $self->{term}->locale;	1668	$env->{LC_CTYPE} = $self->{term}->locale;
1429		1669
1430	urxvt::term->new ($env, $self->{term}->resource ("name"),	1670	urxvt::term->new ($env, "popup",
1431	"--perl-lib" => "", "--perl-ext-common" => "", "-pty-fd" => -1, "-sl" => 0, "-b" => 0,	1671	"--perl-lib" => "", "--perl-ext-common" => "",
		1672	"-pty-fd" => -1, "-sl" => 0,
		1673	"-b" => 1, "-bd" => "grey80", "-bl", "-override-redirect",
1432	"--transient-for" => $self->{term}->parent,	1674	"--transient-for" => $self->{term}->parent,
1433	"-display" => $self->{term}->display_id,	1675	"-display" => $self->{term}->display_id,
1434	"-pe" => "urxvt-popup")	1676	"-pe" => "urxvt-popup")
1435	or die "unable to create popup window\n";	1677	or die "unable to create popup window\n";
1436	}	1678	}
…		…
1441	delete $self->{term}{_destroy}{$self};	1683	delete $self->{term}{_destroy}{$self};
1442	$self->{term}->ungrab;	1684	$self->{term}->ungrab;
1443	}	1685	}
1444		1686
1445	=back	1687	=back
		1688
		1689	=cut
		1690
		1691	package urxvt::watcher;
		1692
		1693	@urxvt::timer::ISA = __PACKAGE__;
		1694	@urxvt::iow::ISA = __PACKAGE__;
		1695	@urxvt::pw::ISA = __PACKAGE__;
		1696	@urxvt::iw::ISA = __PACKAGE__;
1446		1697
1447	=head2 The C<urxvt::timer> Class	1698	=head2 The C<urxvt::timer> Class
1448		1699
1449	This class implements timer watchers/events. Time is represented as a	1700	This class implements timer watchers/events. Time is represented as a
1450	fractional number of seconds since the epoch. Example:	1701	fractional number of seconds since the epoch. Example:
…		…
1488	Start the timer.	1739	Start the timer.
1489		1740
1490	=item $timer = $timer->start ($tstamp)	1741	=item $timer = $timer->start ($tstamp)
1491		1742
1492	Set the event trigger time to C<$tstamp> and start the timer.	1743	Set the event trigger time to C<$tstamp> and start the timer.
		1744
		1745	=item $timer = $timer->after ($delay)
		1746
		1747	Like C<start>, but sets the expiry timer to c<urxvt::NOW + $delay>.
1493		1748
1494	=item $timer = $timer->stop	1749	=item $timer = $timer->stop
1495		1750
1496	Stop the timer.	1751	Stop the timer.
1497		1752
…		…
1544		1799
1545	Stop watching for events on the given filehandle.	1800	Stop watching for events on the given filehandle.
1546		1801
1547	=back	1802	=back
1548		1803
		1804	=head2 The C<urxvt::iw> Class
		1805
		1806	This class implements idle watchers, that get called automatically when
		1807	the process is idle. They should return as fast as possible, after doing
		1808	some useful work.
		1809
		1810	=over 4
		1811
		1812	=item $iw = new urxvt::iw
		1813
		1814	Create a new idle watcher object in stopped state.
		1815
		1816	=item $iw = $iw->cb (sub { my ($iw) = @_; ... })
		1817
		1818	Set the callback to be called when the watcher triggers.
		1819
		1820	=item $timer = $timer->start
		1821
		1822	Start the watcher.
		1823
		1824	=item $timer = $timer->stop
		1825
		1826	Stop the watcher.
		1827
		1828	=back
		1829
		1830	=head2 The C<urxvt::pw> Class
		1831
		1832	This class implements process watchers. They create an event whenever a
		1833	process exits, after which they stop automatically.
		1834
		1835	my $pid = fork;
		1836	...
		1837	$term->{pw} = urxvt::pw
		1838	->new
		1839	->start ($pid)
		1840	->cb (sub {
		1841	my ($pw, $exit_status) = @_;
		1842	...
		1843	});
		1844
		1845	=over 4
		1846
		1847	=item $pw = new urxvt::pw
		1848
		1849	Create a new process watcher in stopped state.
		1850
		1851	=item $pw = $pw->cb (sub { my ($pw, $exit_status) = @_; ... })
		1852
		1853	Set the callback to be called when the timer triggers.
		1854
		1855	=item $pw = $timer->start ($pid)
		1856
		1857	Tells the wqtcher to start watching for process C<$pid>.
		1858
		1859	=item $pw = $pw->stop
		1860
		1861	Stop the watcher.
		1862
		1863	=back
		1864
1549	=head1 ENVIRONMENT	1865	=head1 ENVIRONMENT
1550		1866
1551	=head2 URXVT_PERL_VERBOSITY	1867	=head2 URXVT_PERL_VERBOSITY
1552		1868
1553	This variable controls the verbosity level of the perl extension. Higher	1869	This variable controls the verbosity level of the perl extension. Higher
…		…
1557		1873
1558	=item == 0 - fatal messages	1874	=item == 0 - fatal messages
1559		1875
1560	=item >= 3 - script loading and management	1876	=item >= 3 - script loading and management
1561		1877
1562	=item >=10 - all events received	1878	=item >=10 - all called hooks
		1879
		1880	=item >=11 - hook reutrn values
1563		1881
1564	=back	1882	=back
1565		1883
1566	=head1 AUTHOR	1884	=head1 AUTHOR
1567		1885

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.114 by root, Fri Jan 20 12:16:28 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.114 by root, Fri Jan 20 12:16:28 2006 UTC