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

Comparing rxvt-unicode/src/urxvt.pm (file contents):
Revision 1.83 by root, Thu Jan 12 01:38:37 2006 UTC vs.
Revision 1.113 by root, Fri Jan 20 10:27:08 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 and	169	Uses per-line display filtering (C<on_line_update>) to underline urls and
90	make them clickable. When middle-clicked, the program specified in the	170	make them clickable. When middle-clicked, the program specified in the
91	resource C<urlLauncher> (default C<x-www-browser>) will be started.	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
92		181
93	=item block-graphics-to-ascii	182	=item block-graphics-to-ascii
94		183
95	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,
96	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
97	similar-looking ascii character.	186	similar-looking ascii character.
98		187
		188	=item digital-clock
		189
		190	Displays a digital clock using the built-in overlay.
		191
99	=item example-refresh-hooks	192	=item example-refresh-hooks
100		193
101	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
102	window. Illustrates overwriting the refresh callbacks to create your own	195	window. Illustrates overwriting the refresh callbacks to create your own
103	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/%
104		226
105	=back	227	=back
106		228
107	=head1 API DOCUMENTATION	229	=head1 API DOCUMENTATION
108		230
…		…
181	called whenever the relevant event happens.	303	called whenever the relevant event happens.
182		304
183	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
184	the in the C<Extension Objects> section.	306	the in the C<Extension Objects> section.
185		307
186	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
187	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
188	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.
189		311
190	I<< When in doubt, return a false value (preferably C<()>). >>	312	I<< When in doubt, return a false value (preferably C<()>). >>
191		313
192	=over 4	314	=over 4
193		315
194	=item on_init $term	316	=item on_init $term
195		317
196	Called after a new terminal object has been initialized, but before	318	Called after a new terminal object has been initialized, but before
197	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
198	call or deliver senseless data, as terminal size and other characteristics	320	call or deliver senseless data, as terminal size and other characteristics
199	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
200	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.
201		335
202	=item on_reset $term	336	=item on_reset $term
203		337
204	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
205	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
206	variables.	340	variables.
207		341
208	=item on_start $term	342	=item on_child_start $term, $pid
209		343
210	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.
211	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>.
212		350
213	=item on_sel_make $term, $eventtime	351	=item on_sel_make $term, $eventtime
214		352
215	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
216	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
…		…
230	=item on_sel_extend $term	368	=item on_sel_extend $term
231		369
232	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
233	click) and is either supposed to return false (normal operation), or	371	click) and is either supposed to return false (normal operation), or
234	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
235	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.
236		376
237	See the F<selection> example extension.	377	See the F<selection> example extension.
238		378
239	=item on_view_change $term, $offset	379	=item on_view_change $term, $offset
240		380
…		…
307		447
308	Called whenever the user presses a key combination that has a	448	Called whenever the user presses a key combination that has a
309	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>
310	resource in the @@RXVT_NAME@@(1) manpage).	450	resource in the @@RXVT_NAME@@(1) manpage).
311		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
312	=item on_focus_in $term	458	=item on_focus_in $term
313		459
314	Called whenever the window gets the keyboard focus, before rxvt-unicode	460	Called whenever the window gets the keyboard focus, before rxvt-unicode
315	does focus in processing.	461	does focus in processing.
316		462
317	=item on_focus_out $term	463	=item on_focus_out $term
318		464
319	Called wheneever the window loses keyboard focus, before rxvt-unicode does	465	Called wheneever the window loses keyboard focus, before rxvt-unicode does
320	focus out processing.	466	focus out processing.
		467
		468	=item on_configure_notify $term, $event
321		469
322	=item on_key_press $term, $event, $keysym, $octets	470	=item on_key_press $term, $event, $keysym, $octets
323		471
324	=item on_key_release $term, $event, $keysym	472	=item on_key_release $term, $event, $keysym
325		473
…		…
357	use Scalar::Util ();	505	use Scalar::Util ();
358	use List::Util ();	506	use List::Util ();
359		507
360	our $VERSION = 1;	508	our $VERSION = 1;
361	our $TERM;	509	our $TERM;
		510	our @TERM_INIT;
		511	our @TERM_EXT;
362	our @HOOKNAME;	512	our @HOOKNAME;
363	our %HOOKTYPE = map +($HOOKNAME[$_] => $_), 0..$#HOOKNAME;	513	our %HOOKTYPE = map +($HOOKNAME[$_] => $_), 0..$#HOOKNAME;
364	our %OPTION;	514	our %OPTION;
365		515
366	our $LIBDIR;	516	our $LIBDIR;
…		…
388	=item $urxvt::TERM	538	=item $urxvt::TERM
389		539
390	The current terminal. This variable stores the current C<urxvt::term>	540	The current terminal. This variable stores the current C<urxvt::term>
391	object, whenever a callback/hook is executing.	541	object, whenever a callback/hook is executing.
392		542
		543	=item @urxvt::TERM_INIT
		544
		545	All coderefs in this array will be called as methods of the next newly
		546	created C<urxvt::term> object (during the C<on_init> phase). The array
		547	gets cleared before the codereferences that were in it are being executed,
		548	so coderefs can push themselves onto it again if they so desire.
		549
		550	This complements to the perl-eval commandline option, but gets executed
		551	first.
		552
		553	=item @urxvt::TERM_EXT
		554
		555	Works similar to C<@TERM_INIT>, but contains perl package/class names, which
		556	get registered as normal extensions after calling the hooks in C<@TERM_INIT>
		557	but before other extensions. Gets cleared just like C<@TERM_INIT>.
		558
393	=back	559	=back
394		560
395	=head2 Functions in the C<urxvt> Package	561	=head2 Functions in the C<urxvt> Package
396		562
397	=over 4	563	=over 4
…		…
411	Using this function has the advantage that its output ends up in the	577	Using this function has the advantage that its output ends up in the
412	correct place, e.g. on stderr of the connecting urxvtc client.	578	correct place, e.g. on stderr of the connecting urxvtc client.
413		579
414	Messages have a size limit of 1023 bytes currently.	580	Messages have a size limit of 1023 bytes currently.
415		581
416	=item $is_safe = urxvt::safe
417
418	Returns true when it is safe to do potentially unsafe things, such as
419	evaluating perl code specified by the user. This is true when urxvt was
420	started setuid or setgid.
421
422	=item $time = urxvt::NOW	582	=item $time = urxvt::NOW
423		583
424	Returns the "current time" (as per the event loop).	584	Returns the "current time" (as per the event loop).
425		585
426	=item urxvt::CurrentTime	586	=item urxvt::CurrentTime
427		587
428	=item urxvt::ShiftMask, LockMask, ControlMask, Mod1Mask, Mod2Mask,	588	=item urxvt::ShiftMask, LockMask, ControlMask, Mod1Mask, Mod2Mask,
429	Mod3Mask, Mod4Mask, Mod5Mask, Button1Mask, Button2Mask, Button3Mask,	589	Mod3Mask, Mod4Mask, Mod5Mask, Button1Mask, Button2Mask, Button3Mask,
430	Button4Mask, Button5Mask, AnyModifier	590	Button4Mask, Button5Mask, AnyModifier
		591
		592	=item urxvt::NoEventMask, KeyPressMask, KeyReleaseMask,
		593	ButtonPressMask, ButtonReleaseMask, EnterWindowMask, LeaveWindowMask,
		594	PointerMotionMask, PointerMotionHintMask, Button1MotionMask, Button2MotionMask,
		595	Button3MotionMask, Button4MotionMask, Button5MotionMask, ButtonMotionMask,
		596	KeymapStateMask, ExposureMask, VisibilityChangeMask, StructureNotifyMask,
		597	ResizeRedirectMask, SubstructureNotifyMask, SubstructureRedirectMask,
		598	FocusChangeMask, PropertyChangeMask, ColormapChangeMask, OwnerGrabButtonMask
		599
		600	=item urxvt::KeyPress, KeyRelease, ButtonPress, ButtonRelease, MotionNotify,
		601	EnterNotify, LeaveNotify, FocusIn, FocusOut, KeymapNotify, Expose,
		602	GraphicsExpose, NoExpose, VisibilityNotify, CreateNotify, DestroyNotify,
		603	UnmapNotify, MapNotify, MapRequest, ReparentNotify, ConfigureNotify,
		604	ConfigureRequest, GravityNotify, ResizeRequest, CirculateNotify,
		605	CirculateRequest, PropertyNotify, SelectionClear, SelectionRequest,
		606	SelectionNotify, ColormapNotify, ClientMessage, MappingNotify
431		607
432	Various constants for use in X calls and event processing.	608	Various constants for use in X calls and event processing.
433		609
434	=back	610	=back
435		611
…		…
486	=back	662	=back
487		663
488	=cut	664	=cut
489		665
490	BEGIN {	666	BEGIN {
491	urxvt->bootstrap;
492
493	# overwrite perl's warn	667	# overwrite perl's warn
494	*CORE::GLOBAL::warn = sub {	668	*CORE::GLOBAL::warn = sub {
495	my $msg = join "", @_;	669	my $msg = join "", @_;
496	$msg .= "\n"	670	$msg .= "\n"
497	unless $msg =~ /\n$/;	671	unless $msg =~ /\n$/;
498	urxvt::warn ($msg);	672	urxvt::warn ($msg);
499	};	673	};
500
501	# %ENV is the original startup environment
502	delete $ENV{IFS};
503	delete $ENV{CDPATH};
504	delete $ENV{BASH_ENV};
505	$ENV{PATH} = "/bin:/sbin:/usr/bin:/usr/sbin:/usr/local/bin:/usr/local/sbin:/opt/bin:/opt/sbin";
506	}	674	}
507		675
508	my @hook_count;
509	my $verbosity = $ENV{URXVT_PERL_VERBOSITY};	676	my $verbosity = $ENV{URXVT_PERL_VERBOSITY};
510		677
511	sub verbose {	678	sub verbose {
512	my ($level, $msg) = @_;	679	my ($level, $msg) = @_;
513	warn "$msg\n" if $level <= $verbosity;	680	warn "$msg\n" if $level <= $verbosity;
514	}	681	}
515		682
516	my $extension_pkg = "extension0000";
517	my %extension_pkg;	683	my %extension_pkg;
518		684
519	# load a single script into its own package, once only	685	# load a single script into its own package, once only
520	sub extension_package($) {	686	sub extension_package($) {
521	my ($path) = @_;	687	my ($path) = @_;
522		688
523	$extension_pkg{$path} \|\|= do {	689	$extension_pkg{$path} \|\|= do {
524	my $pkg = "urxvt::" . ($extension_pkg++);	690	$path =~ /([^\/\\]+)$/;
		691	my $pkg = $1;
		692	$pkg =~ s/[^[:word:]]/_/g;
		693	$pkg = "urxvt::ext::$pkg";
525		694
526	verbose 3, "loading extension '$path' into package '$pkg'";	695	verbose 3, "loading extension '$path' into package '$pkg'";
527		696
528	open my $fh, "<:raw", $path	697	open my $fh, "<:raw", $path
529	or die "$path: $!";	698	or die "$path: $!";
530		699
531	my $source = untaint	700	my $source =
532	"package $pkg; use strict; use utf8;\n"	701	"package $pkg; use strict; use utf8;\n"
533	. "use base urxvt::term::extension::;\n"
534	. "#line 1 \"$path\"\n{\n"	702	. "#line 1 \"$path\"\n{\n"
535	. (do { local $/; <$fh> })	703	. (do { local $/; <$fh> })
536	. "\n};\n1";	704	. "\n};\n1";
537		705
538	eval $source	706	eval $source
…		…
552	if ($htype == 0) { # INIT	720	if ($htype == 0) { # INIT
553	my @dirs = ((split /:/, $TERM->resource ("perl_lib")), "$LIBDIR/perl");	721	my @dirs = ((split /:/, $TERM->resource ("perl_lib")), "$LIBDIR/perl");
554		722
555	my %ext_arg;	723	my %ext_arg;
556		724
		725	{
		726	my @init = @TERM_INIT;
		727	@TERM_INIT = ();
		728	$_->($TERM) for @init;
		729	my @pkg = @TERM_EXT;
		730	@TERM_EXT = ();
		731	$TERM->register_package ($_) for @pkg;
		732	}
		733
557	for (map { split /,/, $TERM->resource ("perl_ext_$_") } 1, 2) {	734	for (grep $_, map { split /,/, $TERM->resource ("perl_ext_$_") } 1, 2) {
558	if ($_ eq "default") {	735	if ($_ eq "default") {
559	$ext_arg{$_} \|\|= [] for qw(selection option-popup selection-popup searchable-scrollback);	736	$ext_arg{$_} \|\|= [] for qw(selection option-popup selection-popup searchable-scrollback);
560	} elsif (/^-(.*)$/) {	737	} elsif (/^-(.*)$/) {
561	delete $ext_arg{$1};	738	delete $ext_arg{$1};
562	} elsif (/^([^<]+)<(.*)>$/) {	739	} elsif (/^([^<]+)<(.*)>$/) {
…		…
587	if $verbosity >= 10;	764	if $verbosity >= 10;
588		765
589	keys %$cb;	766	keys %$cb;
590		767
591	while (my ($pkg, $cb) = each %$cb) {	768	while (my ($pkg, $cb) = each %$cb) {
592	$retval = eval { $cb->($TERM->{_pkg}{$pkg}, @_) }	769	my $retval_ = eval { $cb->($TERM->{_pkg}{$pkg}, @_) };
593	and last;	770	$retval \|\|= $retval_;
594		771
595	if ($@) {	772	if ($@) {
596	$TERM->ungrab; # better to lose the grab than the session	773	$TERM->ungrab; # better to lose the grab than the session
597	warn $@;	774	warn $@;
598	}	775	}
599	}	776	}
		777
		778	verbose 11, "$HOOKNAME[$htype] returning <$retval>"
		779	if $verbosity >= 11;
600	}	780	}
601		781
602	if ($htype == 1) { # DESTROY	782	if ($htype == 1) { # DESTROY
603	if (my $hook = delete $TERM->{_hook}) {
604	for my $htype (0..$#$hook) {
605	$hook_count[$htype] -= scalar keys %{ $hook->[$htype] \|\| {} }
606	or set_should_invoke $htype, 0;
607	}
608	}
609
610	# clear package objects	783	# clear package objects
611	%$_ = () for values %{ $TERM->{_pkg} };	784	%$_ = () for values %{ $TERM->{_pkg} };
612		785
613	# clear package	786	# clear package
614	%$TERM = ();	787	%$TERM = ();
…		…
628	while (my ($name, $cb) = each %hook) {	801	while (my ($name, $cb) = each %hook) {
629	my $htype = $HOOKTYPE{uc $name};	802	my $htype = $HOOKTYPE{uc $name};
630	defined $htype	803	defined $htype
631	or Carp::croak "unsupported hook type '$name'";	804	or Carp::croak "unsupported hook type '$name'";
632		805
		806	$self->set_should_invoke ($htype, +1)
633	unless (exists $self->{term}{_hook}[$htype]{$pkg}) {	807	unless exists $self->{term}{_hook}[$htype]{$pkg};
634	$hook_count[$htype]++
635	or urxvt::set_should_invoke $htype, 1;
636	}
637		808
638	$self->{term}{_hook}[$htype]{$pkg} = $cb;	809	$self->{term}{_hook}[$htype]{$pkg} = $cb;
639	}	810	}
640	}	811	}
641		812
…		…
646	for my $name (@hook) {	817	for my $name (@hook) {
647	my $htype = $HOOKTYPE{uc $name};	818	my $htype = $HOOKTYPE{uc $name};
648	defined $htype	819	defined $htype
649	or Carp::croak "unsupported hook type '$name'";	820	or Carp::croak "unsupported hook type '$name'";
650		821
		822	$self->set_should_invoke ($htype, -1)
651	if (delete $self->{term}{_hook}[$htype]{$pkg}) {	823	if delete $self->{term}{_hook}[$htype]{$pkg};
652	--$hook_count[$htype]
653	or urxvt::set_should_invoke $htype, 0;
654	}
655	}	824	}
656	}	825	}
657		826
658	our $AUTOLOAD;	827	our $AUTOLOAD;
659		828
…		…
765	# find on_xxx subs in the package and register them	934	# find on_xxx subs in the package and register them
766	# as hooks	935	# as hooks
767	sub register_package {	936	sub register_package {
768	my ($self, $pkg, $argv) = @_;	937	my ($self, $pkg, $argv) = @_;
769		938
		939	no strict 'refs';
		940
		941	urxvt::verbose 6, "register package $pkg to $self";
		942
		943	@{"$pkg\::ISA"} = urxvt::term::extension::;
		944
770	my $proxy = bless {	945	my $proxy = bless {
771	_pkg => $pkg,	946	_pkg => $pkg,
772	argv => $argv,	947	argv => $argv,
773	}, $pkg;	948	}, $pkg;
774	Scalar::Util::weaken ($proxy->{term} = $self);	949	Scalar::Util::weaken ($proxy->{term} = $self);
…		…
805		980
806	Destroy the terminal object (close the window, free resources	981	Destroy the terminal object (close the window, free resources
807	etc.). Please note that @@RXVT_NAME@@ will not exit as long as any event	982	etc.). Please note that @@RXVT_NAME@@ will not exit as long as any event
808	watchers (timers, io watchers) are still active.	983	watchers (timers, io watchers) are still active.
809		984
		985	=item $term->exec_async ($cmd[, @args])
		986
		987	Works like the combination of the C<fork>/C<exec> builtins, which executes
		988	("starts") programs in the background. This function takes care of setting
		989	the user environment before exec'ing the command (e.g. C<PATH>) and should
		990	be preferred over explicit calls to C<exec> or C<system>.
		991
		992	Returns the pid of the subprocess or C<undef> on error.
		993
		994	=cut
		995
		996	sub exec_async {
		997	my $self = shift;
		998
		999	my $pid = fork;
		1000
		1001	return $pid
		1002	if !defined $pid or $pid;
		1003
		1004	%ENV = %{ $self->env };
		1005
		1006	exec @_;
		1007	urxvt::_exit 255;
		1008	}
		1009
810	=item $isset = $term->option ($optval[, $set])	1010	=item $isset = $term->option ($optval[, $set])
811		1011
812	Returns true if the option specified by C<$optval> is enabled, and	1012	Returns true if the option specified by C<$optval> is enabled, and
813	optionally change it. All option values are stored by name in the hash	1013	optionally change it. All option values are stored by name in the hash
814	C<%urxvt::OPTION>. Options not enabled in this binary are not in the hash.	1014	C<%urxvt::OPTION>. Options not enabled in this binary are not in the hash.
…		…
816	Here is a a likely non-exhaustive list of option names, please see the	1016	Here is a a likely non-exhaustive list of option names, please see the
817	source file F</src/optinc.h> to see the actual list:	1017	source file F</src/optinc.h> to see the actual list:
818		1018
819	borderLess console cursorBlink cursorUnderline hold iconic insecure	1019	borderLess console cursorBlink cursorUnderline hold iconic insecure
820	intensityStyles jumpScroll loginShell mapAlert meta8 mouseWheelScrollPage	1020	intensityStyles jumpScroll loginShell mapAlert meta8 mouseWheelScrollPage
821	pastableTabs pointerBlank reverseVideo scrollBar scrollBar_floating	1021	override-redirect pastableTabs pointerBlank reverseVideo scrollBar
822	scrollBar_right scrollTtyKeypress scrollTtyOutput scrollWithBuffer	1022	scrollBar_floating scrollBar_right scrollTtyKeypress scrollTtyOutput
823	secondaryScreen secondaryScroll skipBuiltinGlyphs transparent	1023	scrollWithBuffer secondaryScreen secondaryScroll skipBuiltinGlyphs
824	tripleclickwords utmpInhibit visualBell	1024	transparent tripleclickwords utmpInhibit visualBell
825		1025
826	=item $value = $term->resource ($name[, $newval])	1026	=item $value = $term->resource ($name[, $newval])
827		1027
828	Returns the current resource value associated with a given name and	1028	Returns the current resource value associated with a given name and
829	optionally sets a new value. Setting values is most useful in the C<init>	1029	optionally sets a new value. Setting values is most useful in the C<init>
…		…
846		1046
847	answerbackstring backgroundPixmap backspace_key boldFont boldItalicFont	1047	answerbackstring backgroundPixmap backspace_key boldFont boldItalicFont
848	borderLess color cursorBlink cursorUnderline cutchars delete_key	1048	borderLess color cursorBlink cursorUnderline cutchars delete_key
849	display_name embed ext_bwidth fade font geometry hold iconName	1049	display_name embed ext_bwidth fade font geometry hold iconName
850	imFont imLocale inputMethod insecure int_bwidth intensityStyles	1050	imFont imLocale inputMethod insecure int_bwidth intensityStyles
851	italicFont jumpScroll lineSpace loginShell mapAlert menu meta8 modifier	1051	italicFont jumpScroll lineSpace loginShell mapAlert meta8 modifier
852	mouseWheelScrollPage name pastableTabs path perl_eval perl_ext_1 perl_ext_2	1052	mouseWheelScrollPage name override_redirect pastableTabs path perl_eval
853	perl_lib pointerBlank pointerBlankDelay preeditType print_pipe pty_fd	1053	perl_ext_1 perl_ext_2 perl_lib pointerBlank pointerBlankDelay
854	reverseVideo saveLines scrollBar scrollBar_align scrollBar_floating	1054	preeditType print_pipe pty_fd reverseVideo saveLines scrollBar
855	scrollBar_right scrollBar_thickness scrollTtyKeypress scrollTtyOutput	1055	scrollBar_align scrollBar_floating scrollBar_right scrollBar_thickness
856	scrollWithBuffer scrollstyle secondaryScreen secondaryScroll selectstyle	1056	scrollTtyKeypress scrollTtyOutput scrollWithBuffer scrollstyle
857	shade term_name title transparent transparent_all tripleclickwords	1057	secondaryScreen secondaryScroll selectstyle shade term_name title
858	utmpInhibit visualBell	1058	transient_for transparent transparent_all tripleclickwords utmpInhibit
		1059	visualBell
859		1060
860	=cut	1061	=cut
861		1062
862	sub resource($$;$) {	1063	sub resource($$;$) {
863	my ($self, $name) = (shift, shift);	1064	my ($self, $name) = (shift, shift);
…		…
898	=item ($row, $col) = $term->selection_end ([$row, $col])	1099	=item ($row, $col) = $term->selection_end ([$row, $col])
899		1100
900	Return the current values of the selection mark, begin or end positions,	1101	Return the current values of the selection mark, begin or end positions,
901	and optionally set them to new values.	1102	and optionally set them to new values.
902		1103
		1104	=item $term->selection_make ($eventtime[, $rectangular])
		1105
		1106	Tries to make a selection as set by C<selection_beg> and
		1107	C<selection_end>. If C<$rectangular> is true (default: false), a
		1108	rectangular selection will be made. This is the prefered function to make
		1109	a selection.
		1110
903	=item $success = $term->selection_grab ($eventtime)	1111	=item $success = $term->selection_grab ($eventtime)
904		1112
905	Try to request the primary selection from the server (for example, as set	1113	Try to request the primary selection text from the server (for example, as
906	by the next method).	1114	set by the next method). No visual feedback will be given. This function
		1115	is mostly useful from within C<on_sel_grab> hooks.
907		1116
908	=item $oldtext = $term->selection ([$newtext])	1117	=item $oldtext = $term->selection ([$newtext])
909		1118
910	Return the current selection text and optionally replace it by C<$newtext>.	1119	Return the current selection text and optionally replace it by C<$newtext>.
911		1120
…		…
1004	Convert the given locale-encoded octets into a perl string.	1213	Convert the given locale-encoded octets into a perl string.
1005		1214
1006	=item $term->scr_xor_span ($beg_row, $beg_col, $end_row, $end_col[, $rstyle])	1215	=item $term->scr_xor_span ($beg_row, $beg_col, $end_row, $end_col[, $rstyle])
1007		1216
1008	XORs the rendition values in the given span with the provided value	1217	XORs the rendition values in the given span with the provided value
1009	(default: C<RS_RVid>). Useful in refresh hooks to provide effects similar	1218	(default: C<RS_RVid>), which I<MUST NOT> contain font styles. Useful in
1010	to the selection.	1219	refresh hooks to provide effects similar to the selection.
1011		1220
1012	=item $term->scr_xor_rect ($beg_row, $beg_col, $end_row, $end_col[, $rstyle1[, $rstyle2]])	1221	=item $term->scr_xor_rect ($beg_row, $beg_col, $end_row, $end_col[, $rstyle1[, $rstyle2]])
1013		1222
1014	Similar to C<scr_xor_span>, but xors a rectangle instead. Trailing	1223	Similar to C<scr_xor_span>, but xors a rectangle instead. Trailing
1015	whitespace will additionally be xored with the C<$rstyle2>, which defaults	1224	whitespace will additionally be xored with the C<$rstyle2>, which defaults
1016	to C<RS_RVid \| RS_Uline>, which removes reverse video again and underlines	1225	to C<RS_RVid \| RS_Uline>, which removes reverse video again and underlines
1017	it instead.	1226	it instead. Both styles I<MUST NOT> contain font styles.
1018		1227
1019	=item $term->scr_bell	1228	=item $term->scr_bell
1020		1229
1021	Ring the bell!	1230	Ring the bell!
1022		1231
…		…
1056		1265
1057	=item $windowid = $term->vt	1266	=item $windowid = $term->vt
1058		1267
1059	Return the window id of the terminal window.	1268	Return the window id of the terminal window.
1060		1269
		1270	=item $term->vt_emask_add ($x_event_mask)
		1271
		1272	Adds the specified events to the vt event mask. Useful e.g. when you want
		1273	to receive pointer events all the times:
		1274
		1275	$term->vt_emask_add (urxvt::PointerMotionMask);
		1276
1061	=item $window_width = $term->width	1277	=item $window_width = $term->width
1062		1278
1063	=item $window_height = $term->height	1279	=item $window_height = $term->height
1064		1280
1065	=item $font_width = $term->fwidth	1281	=item $font_width = $term->fwidth
…		…
1078		1294
1079	=item $max_scrollback = $term->saveLines	1295	=item $max_scrollback = $term->saveLines
1080		1296
1081	=item $nrow_plus_saveLines = $term->total_rows	1297	=item $nrow_plus_saveLines = $term->total_rows
1082		1298
1083	=item $lines_in_scrollback = $term->nsaved	1299	=item $topmost_scrollback_row = $term->top_row
1084		1300
1085	Return various integers describing terminal characteristics.	1301	Return various integers describing terminal characteristics.
1086		1302
1087	=item $x_display = $term->display_id	1303	=item $x_display = $term->display_id
1088		1304
…		…
1116	Return the modifier masks corresponding to the "ISO Level 3 Shift" (often	1332	Return the modifier masks corresponding to the "ISO Level 3 Shift" (often
1117	AltGr), the meta key (often Alt) and the num lock key, if applicable.	1333	AltGr), the meta key (often Alt) and the num lock key, if applicable.
1118		1334
1119	=item $view_start = $term->view_start ([$newvalue])	1335	=item $view_start = $term->view_start ([$newvalue])
1120		1336
1121	Returns the negative row number of the topmost line. Minimum value is	1337	Returns the row number of the topmost displayed line. Maximum value is
1122	C<0>, which displays the normal terminal contents. Larger values scroll	1338	C<0>, which displays the normal terminal contents. Lower values scroll
1123	this many lines into the scrollback buffer.	1339	this many lines into the scrollback buffer.
1124		1340
1125	=item $term->want_refresh	1341	=item $term->want_refresh
1126		1342
1127	Requests a screen refresh. At the next opportunity, rxvt-unicode will	1343	Requests a screen refresh. At the next opportunity, rxvt-unicode will
…		…
1206	Return the row number of the first/last row of the line, respectively.	1422	Return the row number of the first/last row of the line, respectively.
1207		1423
1208	=item $offset = $line->offset_of ($row, $col)	1424	=item $offset = $line->offset_of ($row, $col)
1209		1425
1210	Returns the character offset of the given row\|col pair within the logical	1426	Returns the character offset of the given row\|col pair within the logical
1211	line.	1427	line. Works for rows outside the line, too, and returns corresponding
		1428	offsets outside the string.
1212		1429
1213	=item ($row, $col) = $line->coord_of ($offset)	1430	=item ($row, $col) = $line->coord_of ($offset)
1214		1431
1215	Translates a string offset into terminal coordinates again.	1432	Translates a string offset into terminal coordinates again.
1216		1433
…		…
1439	my $env = $self->{term}->env;	1656	my $env = $self->{term}->env;
1440	# we can't hope to reproduce the locale algorithm, so nuke LC_ALL and set LC_CTYPE.	1657	# we can't hope to reproduce the locale algorithm, so nuke LC_ALL and set LC_CTYPE.
1441	delete $env->{LC_ALL};	1658	delete $env->{LC_ALL};
1442	$env->{LC_CTYPE} = $self->{term}->locale;	1659	$env->{LC_CTYPE} = $self->{term}->locale;
1443		1660
1444	urxvt::term->new ($env, $self->{term}->resource ("name"),	1661	urxvt::term->new ($env, "popup",
1445	"--perl-lib" => "", "--perl-ext-common" => "", "-pty-fd" => -1, "-sl" => 0, "-b" => 0,	1662	"--perl-lib" => "", "--perl-ext-common" => "",
		1663	"-pty-fd" => -1, "-sl" => 0,
		1664	"-b" => 1, "-bd" => "grey80", "-bl", "-override-redirect",
1446	"--transient-for" => $self->{term}->parent,	1665	"--transient-for" => $self->{term}->parent,
1447	"-display" => $self->{term}->display_id,	1666	"-display" => $self->{term}->display_id,
1448	"-pe" => "urxvt-popup")	1667	"-pe" => "urxvt-popup")
1449	or die "unable to create popup window\n";	1668	or die "unable to create popup window\n";
1450	}	1669	}
…		…
1455	delete $self->{term}{_destroy}{$self};	1674	delete $self->{term}{_destroy}{$self};
1456	$self->{term}->ungrab;	1675	$self->{term}->ungrab;
1457	}	1676	}
1458		1677
1459	=back	1678	=back
		1679
		1680	=cut
		1681
		1682	package urxvt::watcher;
		1683
		1684	@urxvt::timer::ISA = __PACKAGE__;
		1685	@urxvt::iow::ISA = __PACKAGE__;
		1686	@urxvt::pw::ISA = __PACKAGE__;
		1687	@urxvt::iw::ISA = __PACKAGE__;
1460		1688
1461	=head2 The C<urxvt::timer> Class	1689	=head2 The C<urxvt::timer> Class
1462		1690
1463	This class implements timer watchers/events. Time is represented as a	1691	This class implements timer watchers/events. Time is represented as a
1464	fractional number of seconds since the epoch. Example:	1692	fractional number of seconds since the epoch. Example:
…		…
1502	Start the timer.	1730	Start the timer.
1503		1731
1504	=item $timer = $timer->start ($tstamp)	1732	=item $timer = $timer->start ($tstamp)
1505		1733
1506	Set the event trigger time to C<$tstamp> and start the timer.	1734	Set the event trigger time to C<$tstamp> and start the timer.
		1735
		1736	=item $timer = $timer->after ($delay)
		1737
		1738	Like C<start>, but sets the expiry timer to c<urxvt::NOW + $delay>.
1507		1739
1508	=item $timer = $timer->stop	1740	=item $timer = $timer->stop
1509		1741
1510	Stop the timer.	1742	Stop the timer.
1511		1743
…		…
1571		1803
1572	=item == 0 - fatal messages	1804	=item == 0 - fatal messages
1573		1805
1574	=item >= 3 - script loading and management	1806	=item >= 3 - script loading and management
1575		1807
1576	=item >=10 - all events received	1808	=item >=10 - all called hooks
		1809
		1810	=item >=11 - hook reutrn values
1577		1811
1578	=back	1812	=back
1579		1813
1580	=head1 AUTHOR	1814	=head1 AUTHOR
1581		1815

Diff Legend

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

Comparing rxvt-unicode/src/urxvt.pm (file contents): Revision 1.83 by root, Thu Jan 12 01:38:37 2006 UTC vs. Revision 1.113 by root, Fri Jan 20 10:27:08 2006 UTC

Diff Legend

Comparing rxvt-unicode/src/urxvt.pm (file contents):
Revision 1.83 by root, Thu Jan 12 01:38:37 2006 UTC vs.
Revision 1.113 by root, Fri Jan 20 10:27:08 2006 UTC