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

Comparing rxvt-unicode/src/urxvt.pm (file contents):
Revision 1.88 by root, Thu Jan 12 12:05:28 2006 UTC vs.
Revision 1.115 by root, Fri Jan 20 15:57:21 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
…		…
117	URxvt.selection-autotransform.0: transform	140	URxvt.selection-autotransform.0: transform
118	URxvt.selection-autotransform.1: transform	141	URxvt.selection-autotransform.1: transform
119	...	142	...
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<word:number> into C<vi +$number $word>:	145	C<filename:number>, often seen in compiler messages, into C<vi +$filename
		146	$word>:
123		147
124	URxvt.selection-autotransform.0: s/^(S+):(d+):?$/vi +$2 $1\\x0d/	148	URxvt.selection-autotransform.0: s/^([^:[:space:]]+):(\\d+):?$/vi +$2 \\Q$1\\E\\x0d/
125		149
126	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
127	paste directory into your (vi :) editor:	151	paste directly into your (vi :) editor:
128		152
129	URxvt.selection-autotransform.0: s/^(S+):(d+):?$/\\x1b:e $1\\x0d:$2\\x0d/	153	URxvt.selection-autotransform.0: s/^([^:[:space:]]+(\\d+):?$/:e \\Q$1\\E\\x0d:$2\\x0d/
		154
		155	Of course, this can be modified to suit your needs and your editor :)
		156
		157	To expand the example above to typical perl error messages ("XXX at
		158	FILENAME line YYY."), you need a slightly more elaborate solution:
		159
		160	URxvt.selection.pattern-0: ( at .*? line \\d+[,.])
		161	URxvt.selection-autotransform.0: s/^ at (.*?) line (\\d+)[,.]$/:e \\Q$1\E\\x0d:$2\\x0d/
		162
		163	The first line tells the selection code to treat the unchanging part of
		164	every error message as a selection pattern, and the second line transforms
		165	the message into vi commands to load the file.
		166
		167	=item tabbed
		168
		169	This transforms the terminal into a tabbar with additional terminals, that
		170	is, it implements what is commonly refered to as "tabbed terminal". The topmost line
		171	displays a "[NEW]" button, which, when clicked, will add a new tab, followed by one
		172	button per tab.
		173
		174	Clicking a button will activate that tab. Pressing Shift-Left and
		175	Shift-Right will switch to the tab left or right of the current one.
130		176
131	=item mark-urls	177	=item mark-urls
132		178
133	Uses per-line display filtering (C<on_line_update>) to underline urls and	179	Uses per-line display filtering (C<on_line_update>) to underline urls and
134	make them clickable. When middle-clicked, the program specified in the	180	make them clickable. When middle-clicked, the program specified in the
135	resource C<urlLauncher> (default C<x-www-browser>) will be started with	181	resource C<urlLauncher> (default C<x-www-browser>) will be started with
136	the URL as first argument.	182	the URL as first argument.
137		183
		184	=item automove-background
		185
		186	This is basically a one-line extension that dynamically changes the background pixmap offset
		187	to the window position, in effect creating the same effect as pseudo transparency with
		188	a custom pixmap. No scaling is supported in this mode. Exmaple:
		189
		190	@@RXVT_NAME@@ -pixmap background.xpm -pe automove-background
		191
138	=item block-graphics-to-ascii	192	=item block-graphics-to-ascii
139		193
140	A not very useful example of filtering all text output to the terminal,	194	A not very useful example of filtering all text output to the terminal,
141	by replacing all line-drawing characters (U+2500 .. U+259F) by a	195	by replacing all line-drawing characters (U+2500 .. U+259F) by a
142	similar-looking ascii character.	196	similar-looking ascii character.
…		…
148	=item example-refresh-hooks	202	=item example-refresh-hooks
149		203
150	Displays a very simple digital clock in the upper right corner of the	204	Displays a very simple digital clock in the upper right corner of the
151	window. Illustrates overwriting the refresh callbacks to create your own	205	window. Illustrates overwriting the refresh callbacks to create your own
152	overlays or changes.	206	overlays or changes.
		207
		208	=item selection-pastebin
		209
		210	This is a little rarely useful extension that Uploads the selection as
		211	textfile to a remote site (or does other things). (The implementation is
		212	not currently secure for use in a multiuser environment as it writes to
		213	F</tmp> directly.).
		214
		215	It listens to the C<selection-pastebin:remote-pastebin> keyboard command,
		216	i.e.
		217
		218	URxvt.keysym.C-M-e: perl:selection-pastebin:remote-pastebin
		219
		220	Pressing this combination runs a command with C<%> replaced by the name of
		221	the textfile. This command can be set via a resource:
		222
		223	URxvt.selection-pastebin.cmd: rsync -apP % ruth:/var/www/www.ta-sa.org/files/txt/.
		224
		225	And the default is likely not useful to anybody but the few people around
		226	here :)
		227
		228	The name of the textfile is the hex encoded md5 sum of the selection, so
		229	the same content should lead to the same filename.
		230
		231	After a successful upload the selection will be replaced by the text given
		232	in the C<selection-pastebin-url> resource (again, the % is the placeholder
		233	for the filename):
		234
		235	URxvt.selection-pastebin.url: http://www.ta-sa.org/files/txt/%
153		236
154	=back	237	=back
155		238
156	=head1 API DOCUMENTATION	239	=head1 API DOCUMENTATION
157		240
…		…
230	called whenever the relevant event happens.	313	called whenever the relevant event happens.
231		314
232	The first argument passed to them is an extension oject as described in	315	The first argument passed to them is an extension oject as described in
233	the in the C<Extension Objects> section.	316	the in the C<Extension Objects> section.
234		317
235	B<All> of these hooks must return a boolean value. If it is true, then the	318	B<All> of these hooks must return a boolean value. If any of the called
236	event counts as being I<consumed>, and the invocation of other hooks is	319	hooks returns true, then the event counts as being I<consumed>, and the
237	skipped, and the relevant action might not be carried out by the C++ code.	320	relevant action might not be carried out by the C++ code.
238		321
239	I<< When in doubt, return a false value (preferably C<()>). >>	322	I<< When in doubt, return a false value (preferably C<()>). >>
240		323
241	=over 4	324	=over 4
242		325
243	=item on_init $term	326	=item on_init $term
244		327
245	Called after a new terminal object has been initialized, but before	328	Called after a new terminal object has been initialized, but before
246	windows are created or the command gets run. Most methods are unsafe to	329	windows are created or the command gets run. Most methods are unsafe to
247	call or deliver senseless data, as terminal size and other characteristics	330	call or deliver senseless data, as terminal size and other characteristics
248	have not yet been determined. You can safely query and change resources,	331	have not yet been determined. You can safely query and change resources
249	though.	332	and options, though. For many purposes the C<on_start> hook is a better
		333	place.
		334
		335	=item on_start $term
		336
		337	Called at the very end of initialisation of a new terminal, just before
		338	trying to map (display) the toplevel and returning to the mainloop.
		339
		340	=item on_destroy $term
		341
		342	Called whenever something tries to destroy terminal, before doing anything
		343	yet. If this hook returns true, then destruction is skipped, but this is
		344	rarely a good idea.
250		345
251	=item on_reset $term	346	=item on_reset $term
252		347
253	Called after the screen is "reset" for any reason, such as resizing or	348	Called after the screen is "reset" for any reason, such as resizing or
254	control sequences. Here is where you can react on changes to size-related	349	control sequences. Here is where you can react on changes to size-related
255	variables.	350	variables.
256		351
257	=item on_start $term	352	=item on_child_start $term, $pid
258		353
259	Called at the very end of initialisation of a new terminal, just before	354	Called just after the child process has been C<fork>ed.
260	returning to the mainloop.	355
		356	=item on_child_exit $term, $status
		357
		358	Called just after the child process has exited. C<$status> is the status
		359	from C<waitpid>.
261		360
262	=item on_sel_make $term, $eventtime	361	=item on_sel_make $term, $eventtime
263		362
264	Called whenever a selection has been made by the user, but before the	363	Called whenever a selection has been made by the user, but before the
265	selection text is copied, so changes to the beginning, end or type of the	364	selection text is copied, so changes to the beginning, end or type of the
…		…
358		457
359	Called whenever the user presses a key combination that has a	458	Called whenever the user presses a key combination that has a
360	C<perl:string> action bound to it (see description of the B<keysym>	459	C<perl:string> action bound to it (see description of the B<keysym>
361	resource in the @@RXVT_NAME@@(1) manpage).	460	resource in the @@RXVT_NAME@@(1) manpage).
362		461
		462	=item on_x_event $term, $event
		463
		464	Called on every X event received on the vt window (and possibly other
		465	windows). Should only be used as a last resort. Most event structure
		466	members are not passed.
		467
363	=item on_focus_in $term	468	=item on_focus_in $term
364		469
365	Called whenever the window gets the keyboard focus, before rxvt-unicode	470	Called whenever the window gets the keyboard focus, before rxvt-unicode
366	does focus in processing.	471	does focus in processing.
367		472
368	=item on_focus_out $term	473	=item on_focus_out $term
369		474
370	Called wheneever the window loses keyboard focus, before rxvt-unicode does	475	Called wheneever the window loses keyboard focus, before rxvt-unicode does
371	focus out processing.	476	focus out processing.
		477
		478	=item on_configure_notify $term, $event
372		479
373	=item on_key_press $term, $event, $keysym, $octets	480	=item on_key_press $term, $event, $keysym, $octets
374		481
375	=item on_key_release $term, $event, $keysym	482	=item on_key_release $term, $event, $keysym
376		483
…		…
393		500
394	C<on_key_press> additionally receives the string rxvt-unicode would	501	C<on_key_press> additionally receives the string rxvt-unicode would
395	output, if any, in locale-specific encoding.	502	output, if any, in locale-specific encoding.
396		503
397	subwindow.	504	subwindow.
		505
		506	=item on_client_message $term, $event
		507
		508	=item on_wm_protocols $term, $event
		509
		510	=item on_wm_delete_window $term, $event
		511
		512	Called when various types of ClientMessage events are received (all with
		513	format=32, WM_PROTOCOLS or WM_PROTOCOLS:WM_DELETE_WINDOW).
398		514
399	=back	515	=back
400		516
401	=cut	517	=cut
402		518
…		…
408	use Scalar::Util ();	524	use Scalar::Util ();
409	use List::Util ();	525	use List::Util ();
410		526
411	our $VERSION = 1;	527	our $VERSION = 1;
412	our $TERM;	528	our $TERM;
		529	our @TERM_INIT;
		530	our @TERM_EXT;
413	our @HOOKNAME;	531	our @HOOKNAME;
414	our %HOOKTYPE = map +($HOOKNAME[$_] => $_), 0..$#HOOKNAME;	532	our %HOOKTYPE = map +($HOOKNAME[$_] => $_), 0..$#HOOKNAME;
415	our %OPTION;	533	our %OPTION;
416		534
417	our $LIBDIR;	535	our $LIBDIR;
…		…
439	=item $urxvt::TERM	557	=item $urxvt::TERM
440		558
441	The current terminal. This variable stores the current C<urxvt::term>	559	The current terminal. This variable stores the current C<urxvt::term>
442	object, whenever a callback/hook is executing.	560	object, whenever a callback/hook is executing.
443		561
		562	=item @urxvt::TERM_INIT
		563
		564	All coderefs in this array will be called as methods of the next newly
		565	created C<urxvt::term> object (during the C<on_init> phase). The array
		566	gets cleared before the codereferences that were in it are being executed,
		567	so coderefs can push themselves onto it again if they so desire.
		568
		569	This complements to the perl-eval commandline option, but gets executed
		570	first.
		571
		572	=item @urxvt::TERM_EXT
		573
		574	Works similar to C<@TERM_INIT>, but contains perl package/class names, which
		575	get registered as normal extensions after calling the hooks in C<@TERM_INIT>
		576	but before other extensions. Gets cleared just like C<@TERM_INIT>.
		577
444	=back	578	=back
445		579
446	=head2 Functions in the C<urxvt> Package	580	=head2 Functions in the C<urxvt> Package
447		581
448	=over 4	582	=over 4
…		…
462	Using this function has the advantage that its output ends up in the	596	Using this function has the advantage that its output ends up in the
463	correct place, e.g. on stderr of the connecting urxvtc client.	597	correct place, e.g. on stderr of the connecting urxvtc client.
464		598
465	Messages have a size limit of 1023 bytes currently.	599	Messages have a size limit of 1023 bytes currently.
466		600
467	=item $is_safe = urxvt::safe
468
469	Returns true when it is safe to do potentially unsafe things, such as
470	evaluating perl code specified by the user. This is true when urxvt was
471	started setuid or setgid.
472
473	=item $time = urxvt::NOW	601	=item $time = urxvt::NOW
474		602
475	Returns the "current time" (as per the event loop).	603	Returns the "current time" (as per the event loop).
476		604
477	=item urxvt::CurrentTime	605	=item urxvt::CurrentTime
478		606
479	=item urxvt::ShiftMask, LockMask, ControlMask, Mod1Mask, Mod2Mask,	607	=item urxvt::ShiftMask, LockMask, ControlMask, Mod1Mask, Mod2Mask,
480	Mod3Mask, Mod4Mask, Mod5Mask, Button1Mask, Button2Mask, Button3Mask,	608	Mod3Mask, Mod4Mask, Mod5Mask, Button1Mask, Button2Mask, Button3Mask,
481	Button4Mask, Button5Mask, AnyModifier	609	Button4Mask, Button5Mask, AnyModifier
		610
		611	=item urxvt::NoEventMask, KeyPressMask, KeyReleaseMask,
		612	ButtonPressMask, ButtonReleaseMask, EnterWindowMask, LeaveWindowMask,
		613	PointerMotionMask, PointerMotionHintMask, Button1MotionMask, Button2MotionMask,
		614	Button3MotionMask, Button4MotionMask, Button5MotionMask, ButtonMotionMask,
		615	KeymapStateMask, ExposureMask, VisibilityChangeMask, StructureNotifyMask,
		616	ResizeRedirectMask, SubstructureNotifyMask, SubstructureRedirectMask,
		617	FocusChangeMask, PropertyChangeMask, ColormapChangeMask, OwnerGrabButtonMask
		618
		619	=item urxvt::KeyPress, KeyRelease, ButtonPress, ButtonRelease, MotionNotify,
		620	EnterNotify, LeaveNotify, FocusIn, FocusOut, KeymapNotify, Expose,
		621	GraphicsExpose, NoExpose, VisibilityNotify, CreateNotify, DestroyNotify,
		622	UnmapNotify, MapNotify, MapRequest, ReparentNotify, ConfigureNotify,
		623	ConfigureRequest, GravityNotify, ResizeRequest, CirculateNotify,
		624	CirculateRequest, PropertyNotify, SelectionClear, SelectionRequest,
		625	SelectionNotify, ColormapNotify, ClientMessage, MappingNotify
482		626
483	Various constants for use in X calls and event processing.	627	Various constants for use in X calls and event processing.
484		628
485	=back	629	=back
486		630
…		…
537	=back	681	=back
538		682
539	=cut	683	=cut
540		684
541	BEGIN {	685	BEGIN {
542	urxvt->bootstrap;
543
544	# overwrite perl's warn	686	# overwrite perl's warn
545	*CORE::GLOBAL::warn = sub {	687	*CORE::GLOBAL::warn = sub {
546	my $msg = join "", @_;	688	my $msg = join "", @_;
547	$msg .= "\n"	689	$msg .= "\n"
548	unless $msg =~ /\n$/;	690	unless $msg =~ /\n$/;
549	urxvt::warn ($msg);	691	urxvt::warn ($msg);
550	};	692	};
551
552	# %ENV is the original startup environment
553	delete $ENV{IFS};
554	delete $ENV{CDPATH};
555	delete $ENV{BASH_ENV};
556	$ENV{PATH} = "/bin:/sbin:/usr/bin:/usr/sbin:/usr/local/bin:/usr/local/sbin:/opt/bin:/opt/sbin";
557	}	693	}
558		694
559	my @hook_count;
560	my $verbosity = $ENV{URXVT_PERL_VERBOSITY};	695	my $verbosity = $ENV{URXVT_PERL_VERBOSITY};
561		696
562	sub verbose {	697	sub verbose {
563	my ($level, $msg) = @_;	698	my ($level, $msg) = @_;
564	warn "$msg\n" if $level <= $verbosity;	699	warn "$msg\n" if $level <= $verbosity;
565	}	700	}
566		701
567	my $extension_pkg = "extension0000";
568	my %extension_pkg;	702	my %extension_pkg;
569		703
570	# load a single script into its own package, once only	704	# load a single script into its own package, once only
571	sub extension_package($) {	705	sub extension_package($) {
572	my ($path) = @_;	706	my ($path) = @_;
573		707
574	$extension_pkg{$path} \|\|= do {	708	$extension_pkg{$path} \|\|= do {
575	my $pkg = "urxvt::" . ($extension_pkg++);	709	$path =~ /([^\/\\]+)$/;
		710	my $pkg = $1;
		711	$pkg =~ s/[^[:word:]]/_/g;
		712	$pkg = "urxvt::ext::$pkg";
576		713
577	verbose 3, "loading extension '$path' into package '$pkg'";	714	verbose 3, "loading extension '$path' into package '$pkg'";
578		715
579	open my $fh, "<:raw", $path	716	open my $fh, "<:raw", $path
580	or die "$path: $!";	717	or die "$path: $!";
581		718
582	my $source = untaint	719	my $source =
583	"package $pkg; use strict; use utf8;\n"	720	"package $pkg; use strict; use utf8;\n"
584	. "use base urxvt::term::extension::;\n"
585	. "#line 1 \"$path\"\n{\n"	721	. "#line 1 \"$path\"\n{\n"
586	. (do { local $/; <$fh> })	722	. (do { local $/; <$fh> })
587	. "\n};\n1";	723	. "\n};\n1";
588		724
589	eval $source	725	eval $source
…		…
603	if ($htype == 0) { # INIT	739	if ($htype == 0) { # INIT
604	my @dirs = ((split /:/, $TERM->resource ("perl_lib")), "$LIBDIR/perl");	740	my @dirs = ((split /:/, $TERM->resource ("perl_lib")), "$LIBDIR/perl");
605		741
606	my %ext_arg;	742	my %ext_arg;
607		743
		744	{
		745	my @init = @TERM_INIT;
		746	@TERM_INIT = ();
		747	$_->($TERM) for @init;
		748	my @pkg = @TERM_EXT;
		749	@TERM_EXT = ();
		750	$TERM->register_package ($_) for @pkg;
		751	}
		752
608	for (map { split /,/, $TERM->resource ("perl_ext_$_") } 1, 2) {	753	for (grep $_, map { split /,/, $TERM->resource ("perl_ext_$_") } 1, 2) {
609	if ($_ eq "default") {	754	if ($_ eq "default") {
610	$ext_arg{$_} \|\|= [] for qw(selection option-popup selection-popup searchable-scrollback);	755	$ext_arg{$_} \|\|= [] for qw(selection option-popup selection-popup searchable-scrollback);
611	} elsif (/^-(.*)$/) {	756	} elsif (/^-(.*)$/) {
612	delete $ext_arg{$1};	757	delete $ext_arg{$1};
613	} elsif (/^([^<]+)<(.*)>$/) {	758	} elsif (/^([^<]+)<(.*)>$/) {
…		…
638	if $verbosity >= 10;	783	if $verbosity >= 10;
639		784
640	keys %$cb;	785	keys %$cb;
641		786
642	while (my ($pkg, $cb) = each %$cb) {	787	while (my ($pkg, $cb) = each %$cb) {
643	$retval = eval { $cb->($TERM->{_pkg}{$pkg}, @_) }	788	my $retval_ = eval { $cb->($TERM->{_pkg}{$pkg}, @_) };
644	and last;	789	$retval \|\|= $retval_;
645		790
646	if ($@) {	791	if ($@) {
647	$TERM->ungrab; # better to lose the grab than the session	792	$TERM->ungrab; # better to lose the grab than the session
648	warn $@;	793	warn $@;
649	}	794	}
…		…
652	verbose 11, "$HOOKNAME[$htype] returning <$retval>"	797	verbose 11, "$HOOKNAME[$htype] returning <$retval>"
653	if $verbosity >= 11;	798	if $verbosity >= 11;
654	}	799	}
655		800
656	if ($htype == 1) { # DESTROY	801	if ($htype == 1) { # DESTROY
657	if (my $hook = delete $TERM->{_hook}) {
658	for my $htype (0..$#$hook) {
659	$hook_count[$htype] -= scalar keys %{ $hook->[$htype] \|\| {} }
660	or set_should_invoke $htype, 0;
661	}
662	}
663
664	# clear package objects	802	# clear package objects
665	%$_ = () for values %{ $TERM->{_pkg} };	803	%$_ = () for values %{ $TERM->{_pkg} };
666		804
667	# clear package	805	# clear package
668	%$TERM = ();	806	%$TERM = ();
669	}	807	}
670		808
671	$retval	809	$retval
672	}
673
674	sub exec_async(@) {
675	my $pid = fork;
676
677	return
678	if !defined $pid or $pid;
679
680	%ENV = %{ $TERM->env };
681
682	exec @_;
683	_exit 255;
684	}	810	}
685		811
686	# urxvt::term::extension	812	# urxvt::term::extension
687		813
688	package urxvt::term::extension;	814	package urxvt::term::extension;
…		…
694	while (my ($name, $cb) = each %hook) {	820	while (my ($name, $cb) = each %hook) {
695	my $htype = $HOOKTYPE{uc $name};	821	my $htype = $HOOKTYPE{uc $name};
696	defined $htype	822	defined $htype
697	or Carp::croak "unsupported hook type '$name'";	823	or Carp::croak "unsupported hook type '$name'";
698		824
		825	$self->set_should_invoke ($htype, +1)
699	unless (exists $self->{term}{_hook}[$htype]{$pkg}) {	826	unless exists $self->{term}{_hook}[$htype]{$pkg};
700	$hook_count[$htype]++
701	or urxvt::set_should_invoke $htype, 1;
702	}
703		827
704	$self->{term}{_hook}[$htype]{$pkg} = $cb;	828	$self->{term}{_hook}[$htype]{$pkg} = $cb;
705	}	829	}
706	}	830	}
707		831
…		…
712	for my $name (@hook) {	836	for my $name (@hook) {
713	my $htype = $HOOKTYPE{uc $name};	837	my $htype = $HOOKTYPE{uc $name};
714	defined $htype	838	defined $htype
715	or Carp::croak "unsupported hook type '$name'";	839	or Carp::croak "unsupported hook type '$name'";
716		840
		841	$self->set_should_invoke ($htype, -1)
717	if (delete $self->{term}{_hook}[$htype]{$pkg}) {	842	if delete $self->{term}{_hook}[$htype]{$pkg};
718	--$hook_count[$htype]
719	or urxvt::set_should_invoke $htype, 0;
720	}
721	}	843	}
722	}	844	}
723		845
724	our $AUTOLOAD;	846	our $AUTOLOAD;
725		847
…		…
831	# find on_xxx subs in the package and register them	953	# find on_xxx subs in the package and register them
832	# as hooks	954	# as hooks
833	sub register_package {	955	sub register_package {
834	my ($self, $pkg, $argv) = @_;	956	my ($self, $pkg, $argv) = @_;
835		957
		958	no strict 'refs';
		959
		960	urxvt::verbose 6, "register package $pkg to $self";
		961
		962	@{"$pkg\::ISA"} = urxvt::term::extension::;
		963
836	my $proxy = bless {	964	my $proxy = bless {
837	_pkg => $pkg,	965	_pkg => $pkg,
838	argv => $argv,	966	argv => $argv,
839	}, $pkg;	967	}, $pkg;
840	Scalar::Util::weaken ($proxy->{term} = $self);	968	Scalar::Util::weaken ($proxy->{term} = $self);
…		…
871		999
872	Destroy the terminal object (close the window, free resources	1000	Destroy the terminal object (close the window, free resources
873	etc.). Please note that @@RXVT_NAME@@ will not exit as long as any event	1001	etc.). Please note that @@RXVT_NAME@@ will not exit as long as any event
874	watchers (timers, io watchers) are still active.	1002	watchers (timers, io watchers) are still active.
875		1003
		1004	=item $term->exec_async ($cmd[, @args])
		1005
		1006	Works like the combination of the C<fork>/C<exec> builtins, which executes
		1007	("starts") programs in the background. This function takes care of setting
		1008	the user environment before exec'ing the command (e.g. C<PATH>) and should
		1009	be preferred over explicit calls to C<exec> or C<system>.
		1010
		1011	Returns the pid of the subprocess or C<undef> on error.
		1012
		1013	=cut
		1014
		1015	sub exec_async {
		1016	my $self = shift;
		1017
		1018	my $pid = fork;
		1019
		1020	return $pid
		1021	if !defined $pid or $pid;
		1022
		1023	%ENV = %{ $self->env };
		1024
		1025	exec @_;
		1026	urxvt::_exit 255;
		1027	}
		1028
876	=item $isset = $term->option ($optval[, $set])	1029	=item $isset = $term->option ($optval[, $set])
877		1030
878	Returns true if the option specified by C<$optval> is enabled, and	1031	Returns true if the option specified by C<$optval> is enabled, and
879	optionally change it. All option values are stored by name in the hash	1032	optionally change it. All option values are stored by name in the hash
880	C<%urxvt::OPTION>. Options not enabled in this binary are not in the hash.	1033	C<%urxvt::OPTION>. Options not enabled in this binary are not in the hash.
…		…
882	Here is a a likely non-exhaustive list of option names, please see the	1035	Here is a a likely non-exhaustive list of option names, please see the
883	source file F</src/optinc.h> to see the actual list:	1036	source file F</src/optinc.h> to see the actual list:
884		1037
885	borderLess console cursorBlink cursorUnderline hold iconic insecure	1038	borderLess console cursorBlink cursorUnderline hold iconic insecure
886	intensityStyles jumpScroll loginShell mapAlert meta8 mouseWheelScrollPage	1039	intensityStyles jumpScroll loginShell mapAlert meta8 mouseWheelScrollPage
887	pastableTabs pointerBlank reverseVideo scrollBar scrollBar_floating	1040	override-redirect pastableTabs pointerBlank reverseVideo scrollBar
888	scrollBar_right scrollTtyKeypress scrollTtyOutput scrollWithBuffer	1041	scrollBar_floating scrollBar_right scrollTtyKeypress scrollTtyOutput
889	secondaryScreen secondaryScroll skipBuiltinGlyphs transparent	1042	scrollWithBuffer secondaryScreen secondaryScroll skipBuiltinGlyphs
890	tripleclickwords utmpInhibit visualBell	1043	transparent tripleclickwords utmpInhibit visualBell
891		1044
892	=item $value = $term->resource ($name[, $newval])	1045	=item $value = $term->resource ($name[, $newval])
893		1046
894	Returns the current resource value associated with a given name and	1047	Returns the current resource value associated with a given name and
895	optionally sets a new value. Setting values is most useful in the C<init>	1048	optionally sets a new value. Setting values is most useful in the C<init>
…		…
912		1065
913	answerbackstring backgroundPixmap backspace_key boldFont boldItalicFont	1066	answerbackstring backgroundPixmap backspace_key boldFont boldItalicFont
914	borderLess color cursorBlink cursorUnderline cutchars delete_key	1067	borderLess color cursorBlink cursorUnderline cutchars delete_key
915	display_name embed ext_bwidth fade font geometry hold iconName	1068	display_name embed ext_bwidth fade font geometry hold iconName
916	imFont imLocale inputMethod insecure int_bwidth intensityStyles	1069	imFont imLocale inputMethod insecure int_bwidth intensityStyles
917	italicFont jumpScroll lineSpace loginShell mapAlert menu meta8 modifier	1070	italicFont jumpScroll lineSpace loginShell mapAlert meta8 modifier
918	mouseWheelScrollPage name pastableTabs path perl_eval perl_ext_1 perl_ext_2	1071	mouseWheelScrollPage name override_redirect pastableTabs path perl_eval
919	perl_lib pointerBlank pointerBlankDelay preeditType print_pipe pty_fd	1072	perl_ext_1 perl_ext_2 perl_lib pointerBlank pointerBlankDelay
920	reverseVideo saveLines scrollBar scrollBar_align scrollBar_floating	1073	preeditType print_pipe pty_fd reverseVideo saveLines scrollBar
921	scrollBar_right scrollBar_thickness scrollTtyKeypress scrollTtyOutput	1074	scrollBar_align scrollBar_floating scrollBar_right scrollBar_thickness
922	scrollWithBuffer scrollstyle secondaryScreen secondaryScroll selectstyle	1075	scrollTtyKeypress scrollTtyOutput scrollWithBuffer scrollstyle
923	shade term_name title transparent transparent_all tripleclickwords	1076	secondaryScreen secondaryScroll selectstyle shade term_name title
924	utmpInhibit visualBell	1077	transient_for transparent transparent_all tripleclickwords utmpInhibit
		1078	visualBell
925		1079
926	=cut	1080	=cut
927		1081
928	sub resource($$;$) {	1082	sub resource($$;$) {
929	my ($self, $name) = (shift, shift);	1083	my ($self, $name) = (shift, shift);
…		…
1130		1284
1131	=item $windowid = $term->vt	1285	=item $windowid = $term->vt
1132		1286
1133	Return the window id of the terminal window.	1287	Return the window id of the terminal window.
1134		1288
		1289	=item $term->vt_emask_add ($x_event_mask)
		1290
		1291	Adds the specified events to the vt event mask. Useful e.g. when you want
		1292	to receive pointer events all the times:
		1293
		1294	$term->vt_emask_add (urxvt::PointerMotionMask);
		1295
1135	=item $window_width = $term->width	1296	=item $window_width = $term->width
1136		1297
1137	=item $window_height = $term->height	1298	=item $window_height = $term->height
1138		1299
1139	=item $font_width = $term->fwidth	1300	=item $font_width = $term->fwidth
…		…
1152		1313
1153	=item $max_scrollback = $term->saveLines	1314	=item $max_scrollback = $term->saveLines
1154		1315
1155	=item $nrow_plus_saveLines = $term->total_rows	1316	=item $nrow_plus_saveLines = $term->total_rows
1156		1317
1157	=item $lines_in_scrollback = $term->nsaved	1318	=item $topmost_scrollback_row = $term->top_row
1158		1319
1159	Return various integers describing terminal characteristics.	1320	Return various integers describing terminal characteristics.
1160		1321
1161	=item $x_display = $term->display_id	1322	=item $x_display = $term->display_id
1162		1323
…		…
1190	Return the modifier masks corresponding to the "ISO Level 3 Shift" (often	1351	Return the modifier masks corresponding to the "ISO Level 3 Shift" (often
1191	AltGr), the meta key (often Alt) and the num lock key, if applicable.	1352	AltGr), the meta key (often Alt) and the num lock key, if applicable.
1192		1353
1193	=item $view_start = $term->view_start ([$newvalue])	1354	=item $view_start = $term->view_start ([$newvalue])
1194		1355
1195	Returns the negative row number of the topmost line. Minimum value is	1356	Returns the row number of the topmost displayed line. Maximum value is
1196	C<0>, which displays the normal terminal contents. Larger values scroll	1357	C<0>, which displays the normal terminal contents. Lower values scroll
1197	this many lines into the scrollback buffer.	1358	this many lines into the scrollback buffer.
1198		1359
1199	=item $term->want_refresh	1360	=item $term->want_refresh
1200		1361
1201	Requests a screen refresh. At the next opportunity, rxvt-unicode will	1362	Requests a screen refresh. At the next opportunity, rxvt-unicode will
…		…
1514	my $env = $self->{term}->env;	1675	my $env = $self->{term}->env;
1515	# we can't hope to reproduce the locale algorithm, so nuke LC_ALL and set LC_CTYPE.	1676	# we can't hope to reproduce the locale algorithm, so nuke LC_ALL and set LC_CTYPE.
1516	delete $env->{LC_ALL};	1677	delete $env->{LC_ALL};
1517	$env->{LC_CTYPE} = $self->{term}->locale;	1678	$env->{LC_CTYPE} = $self->{term}->locale;
1518		1679
1519	urxvt::term->new ($env, $self->{term}->resource ("name"),	1680	urxvt::term->new ($env, "popup",
1520	"--perl-lib" => "", "--perl-ext-common" => "", "-pty-fd" => -1, "-sl" => 0, "-b" => 0,	1681	"--perl-lib" => "", "--perl-ext-common" => "",
		1682	"-pty-fd" => -1, "-sl" => 0,
		1683	"-b" => 1, "-bd" => "grey80", "-bl", "-override-redirect",
1521	"--transient-for" => $self->{term}->parent,	1684	"--transient-for" => $self->{term}->parent,
1522	"-display" => $self->{term}->display_id,	1685	"-display" => $self->{term}->display_id,
1523	"-pe" => "urxvt-popup")	1686	"-pe" => "urxvt-popup")
1524	or die "unable to create popup window\n";	1687	or die "unable to create popup window\n";
1525	}	1688	}
…		…
1530	delete $self->{term}{_destroy}{$self};	1693	delete $self->{term}{_destroy}{$self};
1531	$self->{term}->ungrab;	1694	$self->{term}->ungrab;
1532	}	1695	}
1533		1696
1534	=back	1697	=back
		1698
		1699	=cut
		1700
		1701	package urxvt::watcher;
		1702
		1703	@urxvt::timer::ISA = __PACKAGE__;
		1704	@urxvt::iow::ISA = __PACKAGE__;
		1705	@urxvt::pw::ISA = __PACKAGE__;
		1706	@urxvt::iw::ISA = __PACKAGE__;
1535		1707
1536	=head2 The C<urxvt::timer> Class	1708	=head2 The C<urxvt::timer> Class
1537		1709
1538	This class implements timer watchers/events. Time is represented as a	1710	This class implements timer watchers/events. Time is represented as a
1539	fractional number of seconds since the epoch. Example:	1711	fractional number of seconds since the epoch. Example:
…		…
1577	Start the timer.	1749	Start the timer.
1578		1750
1579	=item $timer = $timer->start ($tstamp)	1751	=item $timer = $timer->start ($tstamp)
1580		1752
1581	Set the event trigger time to C<$tstamp> and start the timer.	1753	Set the event trigger time to C<$tstamp> and start the timer.
		1754
		1755	=item $timer = $timer->after ($delay)
		1756
		1757	Like C<start>, but sets the expiry timer to c<urxvt::NOW + $delay>.
1582		1758
1583	=item $timer = $timer->stop	1759	=item $timer = $timer->stop
1584		1760
1585	Stop the timer.	1761	Stop the timer.
1586		1762
…		…
1633		1809
1634	Stop watching for events on the given filehandle.	1810	Stop watching for events on the given filehandle.
1635		1811
1636	=back	1812	=back
1637		1813
		1814	=head2 The C<urxvt::iw> Class
		1815
		1816	This class implements idle watchers, that get called automatically when
		1817	the process is idle. They should return as fast as possible, after doing
		1818	some useful work.
		1819
		1820	=over 4
		1821
		1822	=item $iw = new urxvt::iw
		1823
		1824	Create a new idle watcher object in stopped state.
		1825
		1826	=item $iw = $iw->cb (sub { my ($iw) = @_; ... })
		1827
		1828	Set the callback to be called when the watcher triggers.
		1829
		1830	=item $timer = $timer->start
		1831
		1832	Start the watcher.
		1833
		1834	=item $timer = $timer->stop
		1835
		1836	Stop the watcher.
		1837
		1838	=back
		1839
		1840	=head2 The C<urxvt::pw> Class
		1841
		1842	This class implements process watchers. They create an event whenever a
		1843	process exits, after which they stop automatically.
		1844
		1845	my $pid = fork;
		1846	...
		1847	$term->{pw} = urxvt::pw
		1848	->new
		1849	->start ($pid)
		1850	->cb (sub {
		1851	my ($pw, $exit_status) = @_;
		1852	...
		1853	});
		1854
		1855	=over 4
		1856
		1857	=item $pw = new urxvt::pw
		1858
		1859	Create a new process watcher in stopped state.
		1860
		1861	=item $pw = $pw->cb (sub { my ($pw, $exit_status) = @_; ... })
		1862
		1863	Set the callback to be called when the timer triggers.
		1864
		1865	=item $pw = $timer->start ($pid)
		1866
		1867	Tells the wqtcher to start watching for process C<$pid>.
		1868
		1869	=item $pw = $pw->stop
		1870
		1871	Stop the watcher.
		1872
		1873	=back
		1874
1638	=head1 ENVIRONMENT	1875	=head1 ENVIRONMENT
1639		1876
1640	=head2 URXVT_PERL_VERBOSITY	1877	=head2 URXVT_PERL_VERBOSITY
1641		1878
1642	This variable controls the verbosity level of the perl extension. Higher	1879	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.88 by root, Thu Jan 12 12:05:28 2006 UTC vs. Revision 1.115 by root, Fri Jan 20 15:57:21 2006 UTC

Diff Legend

Comparing rxvt-unicode/src/urxvt.pm (file contents):
Revision 1.88 by root, Thu Jan 12 12:05:28 2006 UTC vs.
Revision 1.115 by root, Fri Jan 20 15:57:21 2006 UTC