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

Comparing rxvt-unicode/src/urxvt.pm (file contents):
Revision 1.91 by root, Fri Jan 13 01:09:37 2006 UTC vs.
Revision 1.116 by root, Fri Jan 20 16:18:07 2006 UTC

…		…
34	find them in F<@@RXVT_LIBDIR@@/urxvt/perl/>.	34	find them in F<@@RXVT_LIBDIR@@/urxvt/perl/>.
35		35
36	You can activate them like this:	36	You can activate them like this:
37		37
38	@@RXVT_NAME@@ -pe <extensionname>	38	@@RXVT_NAME@@ -pe <extensionname>
		39
		40	Or by adding them to the resource for extensions loaded by default:
		41
		42	URxvt.perl-ext-common: default,automove-background,selection-autotransform
39		43
40	=over 4	44	=over 4
41		45
42	=item selection (enabled by default)	46	=item selection (enabled by default)
43		47
…		…
66	URxvt.selection.pattern-0: \\\|([^\|]+)\\\|	70	URxvt.selection.pattern-0: \\\|([^\|]+)\\\|
67		71
68	You can look at the source of the selection extension to see more	72	You can look at the source of the selection extension to see more
69	interesting uses, such as parsing a line from beginning to end.	73	interesting uses, such as parsing a line from beginning to end.
70		74
71	This extension also offers the following bindable keyboard command:	75	This extension also offers following bindable keyboard commands:
72		76
73	=over 4	77	=over 4
74		78
75	=item rot13	79	=item rot13
76		80
…		…
88	=item selection-popup (enabled by default)	92	=item selection-popup (enabled by default)
89		93
90	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
91	text into various other formats/action (such as uri unescaping, perl	95	text into various other formats/action (such as uri unescaping, perl
92	evalution, web-browser starting etc.), depending on content.	96	evalution, web-browser starting etc.), depending on content.
		97
		98	Other extensions can extend this popup menu by pushing a code reference
		99	onto C<@{ $term->{selection_popup_hook} }>, that is called whenever the
		100	popup is displayed.
		101
		102	It's sole argument is the popup menu, which can be modified. The selection
		103	is in C<$_>, which can be used to decide wether to add something or not.
		104	It should either return nothing or a string and a code reference. The
		105	string will be used as button text and the code reference will be called
		106	when the button gets activated and should transform C<$_>.
		107
		108	The following will add an entry C<a to b> that transforms all C<a>s in
		109	the selection to C<b>s, but only if the selection currently contains any
		110	C<a>s:
		111
		112	push @{ $self->{term}{selection_popup_hook} }, sub {
		113	/a/ ? ("a to be" => sub { s/a/b/g }
		114	: ()
		115	};
93		116
94	=item searchable-scrollback<hotkey> (enabled by default)	117	=item searchable-scrollback<hotkey> (enabled by default)
95		118
96	Adds regex search functionality to the scrollback buffer, triggered	119	Adds regex search functionality to the scrollback buffer, triggered
97	by a hotkey (default: C<M-s>). While in search mode, normal terminal	120	by a hotkey (default: C<M-s>). While in search mode, normal terminal
…		…
120		143
121	For example, the following will transform selections of the form	144	For example, the following will transform selections of the form
122	C<filename:number>, often seen in compiler messages, into C<vi +$filename	145	C<filename:number>, often seen in compiler messages, into C<vi +$filename
123	$word>:	146	$word>:
124		147
125	URxvt.selection-autotransform.0: s/^(\\S+):(\\d+):?$/vi +$2 \\Q$1\\E\\x0d/	148	URxvt.selection-autotransform.0: s/^([^:[:space:]]+):(\\d+):?$/vi +$2 \\Q$1\\E\\x0d/
126		149
127	And this example matches the same,but replaces it with vi-commands you can	150	And this example matches the same,but replaces it with vi-commands you can
128	paste directly into your (vi :) editor:	151	paste directly into your (vi :) editor:
129		152
130	URxvt.selection-autotransform.0: s/^(S+):(d+):?$/\\x1b:e \\Q$1\\E\\x0d:$2\\x0d/	153	URxvt.selection-autotransform.0: s/^([^:[:space:]]+(\\d+):?$/:e \\Q$1\\E\\x0d:$2\\x0d/
131		154
132	Of course, this can be modified to suit your needs and your editor :)	155	Of course, this can be modified to suit your needs and your editor :)
133		156
134	To expand the example above to typical perl error messages ("XXX at	157	To expand the example above to typical perl error messages ("XXX at
135	FILENAME line YYY."), you need a slightly more elaborate solution:	158	FILENAME line YYY."), you need a slightly more elaborate solution:
136		159
137	URxvt.selection.pattern-0: ( at .*? line \\d+\\.)	160	URxvt.selection.pattern-0: ( at .*? line \\d+[,.])
138	URxvt.selection-autotransform.0: s/^ at (.*?) line (\\d+)\\.$/\x1b:e \\Q$1\E\\x0d:$2\\x0d/	161	URxvt.selection-autotransform.0: s/^ at (.*?) line (\\d+)[,.]$/:e \\Q$1\E\\x0d:$2\\x0d/
139		162
140	The first line tells the selection code to treat the unchanging part of	163	The first line tells the selection code to treat the unchanging part of
141	every error message as a selection pattern, and the second line transforms	164	every error message as a selection pattern, and the second line transforms
142	the message into vi commands to load the file.	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 B<Shift-Left> and
		175	B<Shift-Right> will switch to the tab left or right of the current one,
		176	while B<Shift-Down> creates a new tab.
143		177
144	=item mark-urls	178	=item mark-urls
145		179
146	Uses per-line display filtering (C<on_line_update>) to underline urls and	180	Uses per-line display filtering (C<on_line_update>) to underline urls and
147	make them clickable. When middle-clicked, the program specified in the	181	make them clickable. When middle-clicked, the program specified in the
148	resource C<urlLauncher> (default C<x-www-browser>) will be started with	182	resource C<urlLauncher> (default C<x-www-browser>) will be started with
149	the URL as first argument.	183	the URL as first argument.
150		184
		185	=item automove-background
		186
		187	This is basically a one-line extension that dynamically changes the background pixmap offset
		188	to the window position, in effect creating the same effect as pseudo transparency with
		189	a custom pixmap. No scaling is supported in this mode. Exmaple:
		190
		191	@@RXVT_NAME@@ -pixmap background.xpm -pe automove-background
		192
151	=item block-graphics-to-ascii	193	=item block-graphics-to-ascii
152		194
153	A not very useful example of filtering all text output to the terminal,	195	A not very useful example of filtering all text output to the terminal,
154	by replacing all line-drawing characters (U+2500 .. U+259F) by a	196	by replacing all line-drawing characters (U+2500 .. U+259F) by a
155	similar-looking ascii character.	197	similar-looking ascii character.
…		…
161	=item example-refresh-hooks	203	=item example-refresh-hooks
162		204
163	Displays a very simple digital clock in the upper right corner of the	205	Displays a very simple digital clock in the upper right corner of the
164	window. Illustrates overwriting the refresh callbacks to create your own	206	window. Illustrates overwriting the refresh callbacks to create your own
165	overlays or changes.	207	overlays or changes.
		208
		209	=item selection-pastebin
		210
		211	This is a little rarely useful extension that Uploads the selection as
		212	textfile to a remote site (or does other things). (The implementation is
		213	not currently secure for use in a multiuser environment as it writes to
		214	F</tmp> directly.).
		215
		216	It listens to the C<selection-pastebin:remote-pastebin> keyboard command,
		217	i.e.
		218
		219	URxvt.keysym.C-M-e: perl:selection-pastebin:remote-pastebin
		220
		221	Pressing this combination runs a command with C<%> replaced by the name of
		222	the textfile. This command can be set via a resource:
		223
		224	URxvt.selection-pastebin.cmd: rsync -apP % ruth:/var/www/www.ta-sa.org/files/txt/.
		225
		226	And the default is likely not useful to anybody but the few people around
		227	here :)
		228
		229	The name of the textfile is the hex encoded md5 sum of the selection, so
		230	the same content should lead to the same filename.
		231
		232	After a successful upload the selection will be replaced by the text given
		233	in the C<selection-pastebin-url> resource (again, the % is the placeholder
		234	for the filename):
		235
		236	URxvt.selection-pastebin.url: http://www.ta-sa.org/files/txt/%
166		237
167	=back	238	=back
168		239
169	=head1 API DOCUMENTATION	240	=head1 API DOCUMENTATION
170		241
…		…
243	called whenever the relevant event happens.	314	called whenever the relevant event happens.
244		315
245	The first argument passed to them is an extension oject as described in	316	The first argument passed to them is an extension oject as described in
246	the in the C<Extension Objects> section.	317	the in the C<Extension Objects> section.
247		318
248	B<All> of these hooks must return a boolean value. If it is true, then the	319	B<All> of these hooks must return a boolean value. If any of the called
249	event counts as being I<consumed>, and the invocation of other hooks is	320	hooks returns true, then the event counts as being I<consumed>, and the
250	skipped, and the relevant action might not be carried out by the C++ code.	321	relevant action might not be carried out by the C++ code.
251		322
252	I<< When in doubt, return a false value (preferably C<()>). >>	323	I<< When in doubt, return a false value (preferably C<()>). >>
253		324
254	=over 4	325	=over 4
255		326
256	=item on_init $term	327	=item on_init $term
257		328
258	Called after a new terminal object has been initialized, but before	329	Called after a new terminal object has been initialized, but before
259	windows are created or the command gets run. Most methods are unsafe to	330	windows are created or the command gets run. Most methods are unsafe to
260	call or deliver senseless data, as terminal size and other characteristics	331	call or deliver senseless data, as terminal size and other characteristics
261	have not yet been determined. You can safely query and change resources,	332	have not yet been determined. You can safely query and change resources
262	though.	333	and options, though. For many purposes the C<on_start> hook is a better
		334	place.
		335
		336	=item on_start $term
		337
		338	Called at the very end of initialisation of a new terminal, just before
		339	trying to map (display) the toplevel and returning to the mainloop.
		340
		341	=item on_destroy $term
		342
		343	Called whenever something tries to destroy terminal, before doing anything
		344	yet. If this hook returns true, then destruction is skipped, but this is
		345	rarely a good idea.
263		346
264	=item on_reset $term	347	=item on_reset $term
265		348
266	Called after the screen is "reset" for any reason, such as resizing or	349	Called after the screen is "reset" for any reason, such as resizing or
267	control sequences. Here is where you can react on changes to size-related	350	control sequences. Here is where you can react on changes to size-related
268	variables.	351	variables.
269		352
270	=item on_start $term	353	=item on_child_start $term, $pid
271		354
272	Called at the very end of initialisation of a new terminal, just before	355	Called just after the child process has been C<fork>ed.
273	returning to the mainloop.	356
		357	=item on_child_exit $term, $status
		358
		359	Called just after the child process has exited. C<$status> is the status
		360	from C<waitpid>.
274		361
275	=item on_sel_make $term, $eventtime	362	=item on_sel_make $term, $eventtime
276		363
277	Called whenever a selection has been made by the user, but before the	364	Called whenever a selection has been made by the user, but before the
278	selection text is copied, so changes to the beginning, end or type of the	365	selection text is copied, so changes to the beginning, end or type of the
…		…
371		458
372	Called whenever the user presses a key combination that has a	459	Called whenever the user presses a key combination that has a
373	C<perl:string> action bound to it (see description of the B<keysym>	460	C<perl:string> action bound to it (see description of the B<keysym>
374	resource in the @@RXVT_NAME@@(1) manpage).	461	resource in the @@RXVT_NAME@@(1) manpage).
375		462
		463	=item on_x_event $term, $event
		464
		465	Called on every X event received on the vt window (and possibly other
		466	windows). Should only be used as a last resort. Most event structure
		467	members are not passed.
		468
376	=item on_focus_in $term	469	=item on_focus_in $term
377		470
378	Called whenever the window gets the keyboard focus, before rxvt-unicode	471	Called whenever the window gets the keyboard focus, before rxvt-unicode
379	does focus in processing.	472	does focus in processing.
380		473
381	=item on_focus_out $term	474	=item on_focus_out $term
382		475
383	Called wheneever the window loses keyboard focus, before rxvt-unicode does	476	Called wheneever the window loses keyboard focus, before rxvt-unicode does
384	focus out processing.	477	focus out processing.
		478
		479	=item on_configure_notify $term, $event
385		480
386	=item on_key_press $term, $event, $keysym, $octets	481	=item on_key_press $term, $event, $keysym, $octets
387		482
388	=item on_key_release $term, $event, $keysym	483	=item on_key_release $term, $event, $keysym
389		484
…		…
406		501
407	C<on_key_press> additionally receives the string rxvt-unicode would	502	C<on_key_press> additionally receives the string rxvt-unicode would
408	output, if any, in locale-specific encoding.	503	output, if any, in locale-specific encoding.
409		504
410	subwindow.	505	subwindow.
		506
		507	=item on_client_message $term, $event
		508
		509	=item on_wm_protocols $term, $event
		510
		511	=item on_wm_delete_window $term, $event
		512
		513	Called when various types of ClientMessage events are received (all with
		514	format=32, WM_PROTOCOLS or WM_PROTOCOLS:WM_DELETE_WINDOW).
411		515
412	=back	516	=back
413		517
414	=cut	518	=cut
415		519
…		…
421	use Scalar::Util ();	525	use Scalar::Util ();
422	use List::Util ();	526	use List::Util ();
423		527
424	our $VERSION = 1;	528	our $VERSION = 1;
425	our $TERM;	529	our $TERM;
		530	our @TERM_INIT;
		531	our @TERM_EXT;
426	our @HOOKNAME;	532	our @HOOKNAME;
427	our %HOOKTYPE = map +($HOOKNAME[$_] => $_), 0..$#HOOKNAME;	533	our %HOOKTYPE = map +($HOOKNAME[$_] => $_), 0..$#HOOKNAME;
428	our %OPTION;	534	our %OPTION;
429		535
430	our $LIBDIR;	536	our $LIBDIR;
…		…
452	=item $urxvt::TERM	558	=item $urxvt::TERM
453		559
454	The current terminal. This variable stores the current C<urxvt::term>	560	The current terminal. This variable stores the current C<urxvt::term>
455	object, whenever a callback/hook is executing.	561	object, whenever a callback/hook is executing.
456		562
		563	=item @urxvt::TERM_INIT
		564
		565	All coderefs in this array will be called as methods of the next newly
		566	created C<urxvt::term> object (during the C<on_init> phase). The array
		567	gets cleared before the codereferences that were in it are being executed,
		568	so coderefs can push themselves onto it again if they so desire.
		569
		570	This complements to the perl-eval commandline option, but gets executed
		571	first.
		572
		573	=item @urxvt::TERM_EXT
		574
		575	Works similar to C<@TERM_INIT>, but contains perl package/class names, which
		576	get registered as normal extensions after calling the hooks in C<@TERM_INIT>
		577	but before other extensions. Gets cleared just like C<@TERM_INIT>.
		578
457	=back	579	=back
458		580
459	=head2 Functions in the C<urxvt> Package	581	=head2 Functions in the C<urxvt> Package
460		582
461	=over 4	583	=over 4
…		…
475	Using this function has the advantage that its output ends up in the	597	Using this function has the advantage that its output ends up in the
476	correct place, e.g. on stderr of the connecting urxvtc client.	598	correct place, e.g. on stderr of the connecting urxvtc client.
477		599
478	Messages have a size limit of 1023 bytes currently.	600	Messages have a size limit of 1023 bytes currently.
479		601
480	=item $is_safe = urxvt::safe
481
482	Returns true when it is safe to do potentially unsafe things, such as
483	evaluating perl code specified by the user. This is true when urxvt was
484	started setuid or setgid.
485
486	=item $time = urxvt::NOW	602	=item $time = urxvt::NOW
487		603
488	Returns the "current time" (as per the event loop).	604	Returns the "current time" (as per the event loop).
489		605
490	=item urxvt::CurrentTime	606	=item urxvt::CurrentTime
491		607
492	=item urxvt::ShiftMask, LockMask, ControlMask, Mod1Mask, Mod2Mask,	608	=item urxvt::ShiftMask, LockMask, ControlMask, Mod1Mask, Mod2Mask,
493	Mod3Mask, Mod4Mask, Mod5Mask, Button1Mask, Button2Mask, Button3Mask,	609	Mod3Mask, Mod4Mask, Mod5Mask, Button1Mask, Button2Mask, Button3Mask,
494	Button4Mask, Button5Mask, AnyModifier	610	Button4Mask, Button5Mask, AnyModifier
		611
		612	=item urxvt::NoEventMask, KeyPressMask, KeyReleaseMask,
		613	ButtonPressMask, ButtonReleaseMask, EnterWindowMask, LeaveWindowMask,
		614	PointerMotionMask, PointerMotionHintMask, Button1MotionMask, Button2MotionMask,
		615	Button3MotionMask, Button4MotionMask, Button5MotionMask, ButtonMotionMask,
		616	KeymapStateMask, ExposureMask, VisibilityChangeMask, StructureNotifyMask,
		617	ResizeRedirectMask, SubstructureNotifyMask, SubstructureRedirectMask,
		618	FocusChangeMask, PropertyChangeMask, ColormapChangeMask, OwnerGrabButtonMask
		619
		620	=item urxvt::KeyPress, KeyRelease, ButtonPress, ButtonRelease, MotionNotify,
		621	EnterNotify, LeaveNotify, FocusIn, FocusOut, KeymapNotify, Expose,
		622	GraphicsExpose, NoExpose, VisibilityNotify, CreateNotify, DestroyNotify,
		623	UnmapNotify, MapNotify, MapRequest, ReparentNotify, ConfigureNotify,
		624	ConfigureRequest, GravityNotify, ResizeRequest, CirculateNotify,
		625	CirculateRequest, PropertyNotify, SelectionClear, SelectionRequest,
		626	SelectionNotify, ColormapNotify, ClientMessage, MappingNotify
495		627
496	Various constants for use in X calls and event processing.	628	Various constants for use in X calls and event processing.
497		629
498	=back	630	=back
499		631
…		…
550	=back	682	=back
551		683
552	=cut	684	=cut
553		685
554	BEGIN {	686	BEGIN {
555	urxvt->bootstrap;
556
557	# overwrite perl's warn	687	# overwrite perl's warn
558	*CORE::GLOBAL::warn = sub {	688	*CORE::GLOBAL::warn = sub {
559	my $msg = join "", @_;	689	my $msg = join "", @_;
560	$msg .= "\n"	690	$msg .= "\n"
561	unless $msg =~ /\n$/;	691	unless $msg =~ /\n$/;
562	urxvt::warn ($msg);	692	urxvt::warn ($msg);
563	};	693	};
564
565	# %ENV is the original startup environment
566	delete $ENV{IFS};
567	delete $ENV{CDPATH};
568	delete $ENV{BASH_ENV};
569	$ENV{PATH} = "/bin:/sbin:/usr/bin:/usr/sbin:/usr/local/bin:/usr/local/sbin:/opt/bin:/opt/sbin";
570	}	694	}
571		695
572	my @hook_count;
573	my $verbosity = $ENV{URXVT_PERL_VERBOSITY};	696	my $verbosity = $ENV{URXVT_PERL_VERBOSITY};
574		697
575	sub verbose {	698	sub verbose {
576	my ($level, $msg) = @_;	699	my ($level, $msg) = @_;
577	warn "$msg\n" if $level <= $verbosity;	700	warn "$msg\n" if $level <= $verbosity;
578	}	701	}
579		702
580	my $extension_pkg = "extension0000";
581	my %extension_pkg;	703	my %extension_pkg;
582		704
583	# load a single script into its own package, once only	705	# load a single script into its own package, once only
584	sub extension_package($) {	706	sub extension_package($) {
585	my ($path) = @_;	707	my ($path) = @_;
586		708
587	$extension_pkg{$path} \|\|= do {	709	$extension_pkg{$path} \|\|= do {
588	my $pkg = "urxvt::" . ($extension_pkg++);	710	$path =~ /([^\/\\]+)$/;
		711	my $pkg = $1;
		712	$pkg =~ s/[^[:word:]]/_/g;
		713	$pkg = "urxvt::ext::$pkg";
589		714
590	verbose 3, "loading extension '$path' into package '$pkg'";	715	verbose 3, "loading extension '$path' into package '$pkg'";
591		716
592	open my $fh, "<:raw", $path	717	open my $fh, "<:raw", $path
593	or die "$path: $!";	718	or die "$path: $!";
594		719
595	my $source = untaint	720	my $source =
596	"package $pkg; use strict; use utf8;\n"	721	"package $pkg; use strict; use utf8;\n"
597	. "use base urxvt::term::extension::;\n"
598	. "#line 1 \"$path\"\n{\n"	722	. "#line 1 \"$path\"\n{\n"
599	. (do { local $/; <$fh> })	723	. (do { local $/; <$fh> })
600	. "\n};\n1";	724	. "\n};\n1";
601		725
602	eval $source	726	eval $source
…		…
616	if ($htype == 0) { # INIT	740	if ($htype == 0) { # INIT
617	my @dirs = ((split /:/, $TERM->resource ("perl_lib")), "$LIBDIR/perl");	741	my @dirs = ((split /:/, $TERM->resource ("perl_lib")), "$LIBDIR/perl");
618		742
619	my %ext_arg;	743	my %ext_arg;
620		744
		745	{
		746	my @init = @TERM_INIT;
		747	@TERM_INIT = ();
		748	$_->($TERM) for @init;
		749	my @pkg = @TERM_EXT;
		750	@TERM_EXT = ();
		751	$TERM->register_package ($_) for @pkg;
		752	}
		753
621	for (map { split /,/, $TERM->resource ("perl_ext_$_") } 1, 2) {	754	for (grep $_, map { split /,/, $TERM->resource ("perl_ext_$_") } 1, 2) {
622	if ($_ eq "default") {	755	if ($_ eq "default") {
623	$ext_arg{$_} \|\|= [] for qw(selection option-popup selection-popup searchable-scrollback);	756	$ext_arg{$_} \|\|= [] for qw(selection option-popup selection-popup searchable-scrollback);
624	} elsif (/^-(.*)$/) {	757	} elsif (/^-(.*)$/) {
625	delete $ext_arg{$1};	758	delete $ext_arg{$1};
626	} elsif (/^([^<]+)<(.*)>$/) {	759	} elsif (/^([^<]+)<(.*)>$/) {
…		…
651	if $verbosity >= 10;	784	if $verbosity >= 10;
652		785
653	keys %$cb;	786	keys %$cb;
654		787
655	while (my ($pkg, $cb) = each %$cb) {	788	while (my ($pkg, $cb) = each %$cb) {
656	$retval = eval { $cb->($TERM->{_pkg}{$pkg}, @_) }	789	my $retval_ = eval { $cb->($TERM->{_pkg}{$pkg}, @_) };
657	and last;	790	$retval \|\|= $retval_;
658		791
659	if ($@) {	792	if ($@) {
660	$TERM->ungrab; # better to lose the grab than the session	793	$TERM->ungrab; # better to lose the grab than the session
661	warn $@;	794	warn $@;
662	}	795	}
…		…
665	verbose 11, "$HOOKNAME[$htype] returning <$retval>"	798	verbose 11, "$HOOKNAME[$htype] returning <$retval>"
666	if $verbosity >= 11;	799	if $verbosity >= 11;
667	}	800	}
668		801
669	if ($htype == 1) { # DESTROY	802	if ($htype == 1) { # DESTROY
670	if (my $hook = delete $TERM->{_hook}) {
671	for my $htype (0..$#$hook) {
672	$hook_count[$htype] -= scalar keys %{ $hook->[$htype] \|\| {} }
673	or set_should_invoke $htype, 0;
674	}
675	}
676
677	# clear package objects	803	# clear package objects
678	%$_ = () for values %{ $TERM->{_pkg} };	804	%$_ = () for values %{ $TERM->{_pkg} };
679		805
680	# clear package	806	# clear package
681	%$TERM = ();	807	%$TERM = ();
682	}	808	}
683		809
684	$retval	810	$retval
685	}
686
687	sub exec_async(@) {
688	my $pid = fork;
689
690	return
691	if !defined $pid or $pid;
692
693	%ENV = %{ $TERM->env };
694
695	exec @_;
696	_exit 255;
697	}	811	}
698		812
699	# urxvt::term::extension	813	# urxvt::term::extension
700		814
701	package urxvt::term::extension;	815	package urxvt::term::extension;
…		…
707	while (my ($name, $cb) = each %hook) {	821	while (my ($name, $cb) = each %hook) {
708	my $htype = $HOOKTYPE{uc $name};	822	my $htype = $HOOKTYPE{uc $name};
709	defined $htype	823	defined $htype
710	or Carp::croak "unsupported hook type '$name'";	824	or Carp::croak "unsupported hook type '$name'";
711		825
		826	$self->set_should_invoke ($htype, +1)
712	unless (exists $self->{term}{_hook}[$htype]{$pkg}) {	827	unless exists $self->{term}{_hook}[$htype]{$pkg};
713	$hook_count[$htype]++
714	or urxvt::set_should_invoke $htype, 1;
715	}
716		828
717	$self->{term}{_hook}[$htype]{$pkg} = $cb;	829	$self->{term}{_hook}[$htype]{$pkg} = $cb;
718	}	830	}
719	}	831	}
720		832
…		…
725	for my $name (@hook) {	837	for my $name (@hook) {
726	my $htype = $HOOKTYPE{uc $name};	838	my $htype = $HOOKTYPE{uc $name};
727	defined $htype	839	defined $htype
728	or Carp::croak "unsupported hook type '$name'";	840	or Carp::croak "unsupported hook type '$name'";
729		841
		842	$self->set_should_invoke ($htype, -1)
730	if (delete $self->{term}{_hook}[$htype]{$pkg}) {	843	if delete $self->{term}{_hook}[$htype]{$pkg};
731	--$hook_count[$htype]
732	or urxvt::set_should_invoke $htype, 0;
733	}
734	}	844	}
735	}	845	}
736		846
737	our $AUTOLOAD;	847	our $AUTOLOAD;
738		848
…		…
844	# find on_xxx subs in the package and register them	954	# find on_xxx subs in the package and register them
845	# as hooks	955	# as hooks
846	sub register_package {	956	sub register_package {
847	my ($self, $pkg, $argv) = @_;	957	my ($self, $pkg, $argv) = @_;
848		958
		959	no strict 'refs';
		960
		961	urxvt::verbose 6, "register package $pkg to $self";
		962
		963	@{"$pkg\::ISA"} = urxvt::term::extension::;
		964
849	my $proxy = bless {	965	my $proxy = bless {
850	_pkg => $pkg,	966	_pkg => $pkg,
851	argv => $argv,	967	argv => $argv,
852	}, $pkg;	968	}, $pkg;
853	Scalar::Util::weaken ($proxy->{term} = $self);	969	Scalar::Util::weaken ($proxy->{term} = $self);
…		…
884		1000
885	Destroy the terminal object (close the window, free resources	1001	Destroy the terminal object (close the window, free resources
886	etc.). Please note that @@RXVT_NAME@@ will not exit as long as any event	1002	etc.). Please note that @@RXVT_NAME@@ will not exit as long as any event
887	watchers (timers, io watchers) are still active.	1003	watchers (timers, io watchers) are still active.
888		1004
		1005	=item $term->exec_async ($cmd[, @args])
		1006
		1007	Works like the combination of the C<fork>/C<exec> builtins, which executes
		1008	("starts") programs in the background. This function takes care of setting
		1009	the user environment before exec'ing the command (e.g. C<PATH>) and should
		1010	be preferred over explicit calls to C<exec> or C<system>.
		1011
		1012	Returns the pid of the subprocess or C<undef> on error.
		1013
		1014	=cut
		1015
		1016	sub exec_async {
		1017	my $self = shift;
		1018
		1019	my $pid = fork;
		1020
		1021	return $pid
		1022	if !defined $pid or $pid;
		1023
		1024	%ENV = %{ $self->env };
		1025
		1026	exec @_;
		1027	urxvt::_exit 255;
		1028	}
		1029
889	=item $isset = $term->option ($optval[, $set])	1030	=item $isset = $term->option ($optval[, $set])
890		1031
891	Returns true if the option specified by C<$optval> is enabled, and	1032	Returns true if the option specified by C<$optval> is enabled, and
892	optionally change it. All option values are stored by name in the hash	1033	optionally change it. All option values are stored by name in the hash
893	C<%urxvt::OPTION>. Options not enabled in this binary are not in the hash.	1034	C<%urxvt::OPTION>. Options not enabled in this binary are not in the hash.
…		…
895	Here is a a likely non-exhaustive list of option names, please see the	1036	Here is a a likely non-exhaustive list of option names, please see the
896	source file F</src/optinc.h> to see the actual list:	1037	source file F</src/optinc.h> to see the actual list:
897		1038
898	borderLess console cursorBlink cursorUnderline hold iconic insecure	1039	borderLess console cursorBlink cursorUnderline hold iconic insecure
899	intensityStyles jumpScroll loginShell mapAlert meta8 mouseWheelScrollPage	1040	intensityStyles jumpScroll loginShell mapAlert meta8 mouseWheelScrollPage
900	pastableTabs pointerBlank reverseVideo scrollBar scrollBar_floating	1041	override-redirect pastableTabs pointerBlank reverseVideo scrollBar
901	scrollBar_right scrollTtyKeypress scrollTtyOutput scrollWithBuffer	1042	scrollBar_floating scrollBar_right scrollTtyKeypress scrollTtyOutput
902	secondaryScreen secondaryScroll skipBuiltinGlyphs transparent	1043	scrollWithBuffer secondaryScreen secondaryScroll skipBuiltinGlyphs
903	tripleclickwords utmpInhibit visualBell	1044	transparent tripleclickwords utmpInhibit visualBell
904		1045
905	=item $value = $term->resource ($name[, $newval])	1046	=item $value = $term->resource ($name[, $newval])
906		1047
907	Returns the current resource value associated with a given name and	1048	Returns the current resource value associated with a given name and
908	optionally sets a new value. Setting values is most useful in the C<init>	1049	optionally sets a new value. Setting values is most useful in the C<init>
…		…
925		1066
926	answerbackstring backgroundPixmap backspace_key boldFont boldItalicFont	1067	answerbackstring backgroundPixmap backspace_key boldFont boldItalicFont
927	borderLess color cursorBlink cursorUnderline cutchars delete_key	1068	borderLess color cursorBlink cursorUnderline cutchars delete_key
928	display_name embed ext_bwidth fade font geometry hold iconName	1069	display_name embed ext_bwidth fade font geometry hold iconName
929	imFont imLocale inputMethod insecure int_bwidth intensityStyles	1070	imFont imLocale inputMethod insecure int_bwidth intensityStyles
930	italicFont jumpScroll lineSpace loginShell mapAlert menu meta8 modifier	1071	italicFont jumpScroll lineSpace loginShell mapAlert meta8 modifier
931	mouseWheelScrollPage name pastableTabs path perl_eval perl_ext_1 perl_ext_2	1072	mouseWheelScrollPage name override_redirect pastableTabs path perl_eval
932	perl_lib pointerBlank pointerBlankDelay preeditType print_pipe pty_fd	1073	perl_ext_1 perl_ext_2 perl_lib pointerBlank pointerBlankDelay
933	reverseVideo saveLines scrollBar scrollBar_align scrollBar_floating	1074	preeditType print_pipe pty_fd reverseVideo saveLines scrollBar
934	scrollBar_right scrollBar_thickness scrollTtyKeypress scrollTtyOutput	1075	scrollBar_align scrollBar_floating scrollBar_right scrollBar_thickness
935	scrollWithBuffer scrollstyle secondaryScreen secondaryScroll selectstyle	1076	scrollTtyKeypress scrollTtyOutput scrollWithBuffer scrollstyle
936	shade term_name title transparent transparent_all tripleclickwords	1077	secondaryScreen secondaryScroll selectstyle shade term_name title
937	utmpInhibit visualBell	1078	transient_for transparent transparent_all tripleclickwords utmpInhibit
		1079	visualBell
938		1080
939	=cut	1081	=cut
940		1082
941	sub resource($$;$) {	1083	sub resource($$;$) {
942	my ($self, $name) = (shift, shift);	1084	my ($self, $name) = (shift, shift);
…		…
1143		1285
1144	=item $windowid = $term->vt	1286	=item $windowid = $term->vt
1145		1287
1146	Return the window id of the terminal window.	1288	Return the window id of the terminal window.
1147		1289
		1290	=item $term->vt_emask_add ($x_event_mask)
		1291
		1292	Adds the specified events to the vt event mask. Useful e.g. when you want
		1293	to receive pointer events all the times:
		1294
		1295	$term->vt_emask_add (urxvt::PointerMotionMask);
		1296
1148	=item $window_width = $term->width	1297	=item $window_width = $term->width
1149		1298
1150	=item $window_height = $term->height	1299	=item $window_height = $term->height
1151		1300
1152	=item $font_width = $term->fwidth	1301	=item $font_width = $term->fwidth
…		…
1165		1314
1166	=item $max_scrollback = $term->saveLines	1315	=item $max_scrollback = $term->saveLines
1167		1316
1168	=item $nrow_plus_saveLines = $term->total_rows	1317	=item $nrow_plus_saveLines = $term->total_rows
1169		1318
1170	=item $lines_in_scrollback = $term->nsaved	1319	=item $topmost_scrollback_row = $term->top_row
1171		1320
1172	Return various integers describing terminal characteristics.	1321	Return various integers describing terminal characteristics.
1173		1322
1174	=item $x_display = $term->display_id	1323	=item $x_display = $term->display_id
1175		1324
…		…
1203	Return the modifier masks corresponding to the "ISO Level 3 Shift" (often	1352	Return the modifier masks corresponding to the "ISO Level 3 Shift" (often
1204	AltGr), the meta key (often Alt) and the num lock key, if applicable.	1353	AltGr), the meta key (often Alt) and the num lock key, if applicable.
1205		1354
1206	=item $view_start = $term->view_start ([$newvalue])	1355	=item $view_start = $term->view_start ([$newvalue])
1207		1356
1208	Returns the negative row number of the topmost line. Minimum value is	1357	Returns the row number of the topmost displayed line. Maximum value is
1209	C<0>, which displays the normal terminal contents. Larger values scroll	1358	C<0>, which displays the normal terminal contents. Lower values scroll
1210	this many lines into the scrollback buffer.	1359	this many lines into the scrollback buffer.
1211		1360
1212	=item $term->want_refresh	1361	=item $term->want_refresh
1213		1362
1214	Requests a screen refresh. At the next opportunity, rxvt-unicode will	1363	Requests a screen refresh. At the next opportunity, rxvt-unicode will
…		…
1527	my $env = $self->{term}->env;	1676	my $env = $self->{term}->env;
1528	# we can't hope to reproduce the locale algorithm, so nuke LC_ALL and set LC_CTYPE.	1677	# we can't hope to reproduce the locale algorithm, so nuke LC_ALL and set LC_CTYPE.
1529	delete $env->{LC_ALL};	1678	delete $env->{LC_ALL};
1530	$env->{LC_CTYPE} = $self->{term}->locale;	1679	$env->{LC_CTYPE} = $self->{term}->locale;
1531		1680
1532	urxvt::term->new ($env, $self->{term}->resource ("name"),	1681	urxvt::term->new ($env, "popup",
1533	"--perl-lib" => "", "--perl-ext-common" => "", "-pty-fd" => -1, "-sl" => 0, "-b" => 0,	1682	"--perl-lib" => "", "--perl-ext-common" => "",
		1683	"-pty-fd" => -1, "-sl" => 0,
		1684	"-b" => 1, "-bd" => "grey80", "-bl", "-override-redirect",
1534	"--transient-for" => $self->{term}->parent,	1685	"--transient-for" => $self->{term}->parent,
1535	"-display" => $self->{term}->display_id,	1686	"-display" => $self->{term}->display_id,
1536	"-pe" => "urxvt-popup")	1687	"-pe" => "urxvt-popup")
1537	or die "unable to create popup window\n";	1688	or die "unable to create popup window\n";
1538	}	1689	}
…		…
1543	delete $self->{term}{_destroy}{$self};	1694	delete $self->{term}{_destroy}{$self};
1544	$self->{term}->ungrab;	1695	$self->{term}->ungrab;
1545	}	1696	}
1546		1697
1547	=back	1698	=back
		1699
		1700	=cut
		1701
		1702	package urxvt::watcher;
		1703
		1704	@urxvt::timer::ISA = __PACKAGE__;
		1705	@urxvt::iow::ISA = __PACKAGE__;
		1706	@urxvt::pw::ISA = __PACKAGE__;
		1707	@urxvt::iw::ISA = __PACKAGE__;
1548		1708
1549	=head2 The C<urxvt::timer> Class	1709	=head2 The C<urxvt::timer> Class
1550		1710
1551	This class implements timer watchers/events. Time is represented as a	1711	This class implements timer watchers/events. Time is represented as a
1552	fractional number of seconds since the epoch. Example:	1712	fractional number of seconds since the epoch. Example:
…		…
1590	Start the timer.	1750	Start the timer.
1591		1751
1592	=item $timer = $timer->start ($tstamp)	1752	=item $timer = $timer->start ($tstamp)
1593		1753
1594	Set the event trigger time to C<$tstamp> and start the timer.	1754	Set the event trigger time to C<$tstamp> and start the timer.
		1755
		1756	=item $timer = $timer->after ($delay)
		1757
		1758	Like C<start>, but sets the expiry timer to c<urxvt::NOW + $delay>.
1595		1759
1596	=item $timer = $timer->stop	1760	=item $timer = $timer->stop
1597		1761
1598	Stop the timer.	1762	Stop the timer.
1599		1763
…		…
1646		1810
1647	Stop watching for events on the given filehandle.	1811	Stop watching for events on the given filehandle.
1648		1812
1649	=back	1813	=back
1650		1814
		1815	=head2 The C<urxvt::iw> Class
		1816
		1817	This class implements idle watchers, that get called automatically when
		1818	the process is idle. They should return as fast as possible, after doing
		1819	some useful work.
		1820
		1821	=over 4
		1822
		1823	=item $iw = new urxvt::iw
		1824
		1825	Create a new idle watcher object in stopped state.
		1826
		1827	=item $iw = $iw->cb (sub { my ($iw) = @_; ... })
		1828
		1829	Set the callback to be called when the watcher triggers.
		1830
		1831	=item $timer = $timer->start
		1832
		1833	Start the watcher.
		1834
		1835	=item $timer = $timer->stop
		1836
		1837	Stop the watcher.
		1838
		1839	=back
		1840
		1841	=head2 The C<urxvt::pw> Class
		1842
		1843	This class implements process watchers. They create an event whenever a
		1844	process exits, after which they stop automatically.
		1845
		1846	my $pid = fork;
		1847	...
		1848	$term->{pw} = urxvt::pw
		1849	->new
		1850	->start ($pid)
		1851	->cb (sub {
		1852	my ($pw, $exit_status) = @_;
		1853	...
		1854	});
		1855
		1856	=over 4
		1857
		1858	=item $pw = new urxvt::pw
		1859
		1860	Create a new process watcher in stopped state.
		1861
		1862	=item $pw = $pw->cb (sub { my ($pw, $exit_status) = @_; ... })
		1863
		1864	Set the callback to be called when the timer triggers.
		1865
		1866	=item $pw = $timer->start ($pid)
		1867
		1868	Tells the wqtcher to start watching for process C<$pid>.
		1869
		1870	=item $pw = $pw->stop
		1871
		1872	Stop the watcher.
		1873
		1874	=back
		1875
1651	=head1 ENVIRONMENT	1876	=head1 ENVIRONMENT
1652		1877
1653	=head2 URXVT_PERL_VERBOSITY	1878	=head2 URXVT_PERL_VERBOSITY
1654		1879
1655	This variable controls the verbosity level of the perl extension. Higher	1880	This variable controls the verbosity level of the perl extension. Higher

Diff Legend

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

Comparing rxvt-unicode/src/urxvt.pm (file contents): Revision 1.91 by root, Fri Jan 13 01:09:37 2006 UTC vs. Revision 1.116 by root, Fri Jan 20 16:18:07 2006 UTC

Diff Legend

Comparing rxvt-unicode/src/urxvt.pm (file contents):
Revision 1.91 by root, Fri Jan 13 01:09:37 2006 UTC vs.
Revision 1.116 by root, Fri Jan 20 16:18:07 2006 UTC