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

Comparing rxvt-unicode/src/urxvt.pm (file contents):
Revision 1.87 by root, Thu Jan 12 05:37:34 2006 UTC vs.
Revision 1.113 by root, Fri Jan 20 10:27:08 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
…		…
48	C<--quoting-style=shell>.	52	C<--quoting-style=shell>.
49		53
50	A double-click usually selects the word under the cursor, further clicks	54	A double-click usually selects the word under the cursor, further clicks
51	will enlarge the selection.	55	will enlarge the selection.
52		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
53	It also offers the following bindable keyboard command:	75	This extension also offers following bindable keyboard commands:
54		76
55	=over 4	77	=over 4
56		78
57	=item rot13	79	=item rot13
58		80
…		…
70	=item selection-popup (enabled by default)	92	=item selection-popup (enabled by default)
71		93
72	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
73	text into various other formats/action (such as uri unescaping, perl	95	text into various other formats/action (such as uri unescaping, perl
74	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	};
75		116
76	=item searchable-scrollback<hotkey> (enabled by default)	117	=item searchable-scrollback<hotkey> (enabled by default)
77		118
78	Adds regex search functionality to the scrollback buffer, triggered	119	Adds regex search functionality to the scrollback buffer, triggered
79	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
…		…
86	bottom. C<Escape> leaves search mode and returns to the point where search	127	bottom. C<Escape> leaves search mode and returns to the point where search
87	was started, while C<Enter> or C<Return> stay at the current position and	128	was started, while C<Enter> or C<Return> stay at the current position and
88	additionally stores the first match in the current line into the primary	129	additionally stores the first match in the current line into the primary
89	selection.	130	selection.
90		131
91	=item digital-clock	132	=item selection-autotransform
92		133
93	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.
94		166
95	=item mark-urls	167	=item mark-urls
96		168
97	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
98	make them clickable. When middle-clicked, the program specified in the	170	make them clickable. When middle-clicked, the program specified in the
99	resource C<urlLauncher> (default C<x-www-browser>) will be started with	171	resource C<urlLauncher> (default C<x-www-browser>) will be started with
100	the URL as first argument.	172	the URL as first argument.
101		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
		181
102	=item block-graphics-to-ascii	182	=item block-graphics-to-ascii
103		183
104	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,
105	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
106	similar-looking ascii character.	186	similar-looking ascii character.
107		187
		188	=item digital-clock
		189
		190	Displays a digital clock using the built-in overlay.
		191
108	=item example-refresh-hooks	192	=item example-refresh-hooks
109		193
110	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
111	window. Illustrates overwriting the refresh callbacks to create your own	195	window. Illustrates overwriting the refresh callbacks to create your own
112	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/%
113		226
114	=back	227	=back
115		228
116	=head1 API DOCUMENTATION	229	=head1 API DOCUMENTATION
117		230
…		…
190	called whenever the relevant event happens.	303	called whenever the relevant event happens.
191		304
192	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
193	the in the C<Extension Objects> section.	306	the in the C<Extension Objects> section.
194		307
195	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
196	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
197	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.
198		311
199	I<< When in doubt, return a false value (preferably C<()>). >>	312	I<< When in doubt, return a false value (preferably C<()>). >>
200		313
201	=over 4	314	=over 4
202		315
203	=item on_init $term	316	=item on_init $term
204		317
205	Called after a new terminal object has been initialized, but before	318	Called after a new terminal object has been initialized, but before
206	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
207	call or deliver senseless data, as terminal size and other characteristics	320	call or deliver senseless data, as terminal size and other characteristics
208	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
209	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.
210		335
211	=item on_reset $term	336	=item on_reset $term
212		337
213	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
214	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
215	variables.	340	variables.
216		341
217	=item on_start $term	342	=item on_child_start $term, $pid
218		343
219	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.
220	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>.
221		350
222	=item on_sel_make $term, $eventtime	351	=item on_sel_make $term, $eventtime
223		352
224	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
225	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
…		…
318		447
319	Called whenever the user presses a key combination that has a	448	Called whenever the user presses a key combination that has a
320	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>
321	resource in the @@RXVT_NAME@@(1) manpage).	450	resource in the @@RXVT_NAME@@(1) manpage).
322		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
323	=item on_focus_in $term	458	=item on_focus_in $term
324		459
325	Called whenever the window gets the keyboard focus, before rxvt-unicode	460	Called whenever the window gets the keyboard focus, before rxvt-unicode
326	does focus in processing.	461	does focus in processing.
327		462
328	=item on_focus_out $term	463	=item on_focus_out $term
329		464
330	Called wheneever the window loses keyboard focus, before rxvt-unicode does	465	Called wheneever the window loses keyboard focus, before rxvt-unicode does
331	focus out processing.	466	focus out processing.
		467
		468	=item on_configure_notify $term, $event
332		469
333	=item on_key_press $term, $event, $keysym, $octets	470	=item on_key_press $term, $event, $keysym, $octets
334		471
335	=item on_key_release $term, $event, $keysym	472	=item on_key_release $term, $event, $keysym
336		473
…		…
368	use Scalar::Util ();	505	use Scalar::Util ();
369	use List::Util ();	506	use List::Util ();
370		507
371	our $VERSION = 1;	508	our $VERSION = 1;
372	our $TERM;	509	our $TERM;
		510	our @TERM_INIT;
		511	our @TERM_EXT;
373	our @HOOKNAME;	512	our @HOOKNAME;
374	our %HOOKTYPE = map +($HOOKNAME[$_] => $_), 0..$#HOOKNAME;	513	our %HOOKTYPE = map +($HOOKNAME[$_] => $_), 0..$#HOOKNAME;
375	our %OPTION;	514	our %OPTION;
376		515
377	our $LIBDIR;	516	our $LIBDIR;
…		…
399	=item $urxvt::TERM	538	=item $urxvt::TERM
400		539
401	The current terminal. This variable stores the current C<urxvt::term>	540	The current terminal. This variable stores the current C<urxvt::term>
402	object, whenever a callback/hook is executing.	541	object, whenever a callback/hook is executing.
403		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
404	=back	559	=back
405		560
406	=head2 Functions in the C<urxvt> Package	561	=head2 Functions in the C<urxvt> Package
407		562
408	=over 4	563	=over 4
…		…
422	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
423	correct place, e.g. on stderr of the connecting urxvtc client.	578	correct place, e.g. on stderr of the connecting urxvtc client.
424		579
425	Messages have a size limit of 1023 bytes currently.	580	Messages have a size limit of 1023 bytes currently.
426		581
427	=item $is_safe = urxvt::safe
428
429	Returns true when it is safe to do potentially unsafe things, such as
430	evaluating perl code specified by the user. This is true when urxvt was
431	started setuid or setgid.
432
433	=item $time = urxvt::NOW	582	=item $time = urxvt::NOW
434		583
435	Returns the "current time" (as per the event loop).	584	Returns the "current time" (as per the event loop).
436		585
437	=item urxvt::CurrentTime	586	=item urxvt::CurrentTime
438		587
439	=item urxvt::ShiftMask, LockMask, ControlMask, Mod1Mask, Mod2Mask,	588	=item urxvt::ShiftMask, LockMask, ControlMask, Mod1Mask, Mod2Mask,
440	Mod3Mask, Mod4Mask, Mod5Mask, Button1Mask, Button2Mask, Button3Mask,	589	Mod3Mask, Mod4Mask, Mod5Mask, Button1Mask, Button2Mask, Button3Mask,
441	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
442		607
443	Various constants for use in X calls and event processing.	608	Various constants for use in X calls and event processing.
444		609
445	=back	610	=back
446		611
…		…
497	=back	662	=back
498		663
499	=cut	664	=cut
500		665
501	BEGIN {	666	BEGIN {
502	urxvt->bootstrap;
503
504	# overwrite perl's warn	667	# overwrite perl's warn
505	*CORE::GLOBAL::warn = sub {	668	*CORE::GLOBAL::warn = sub {
506	my $msg = join "", @_;	669	my $msg = join "", @_;
507	$msg .= "\n"	670	$msg .= "\n"
508	unless $msg =~ /\n$/;	671	unless $msg =~ /\n$/;
509	urxvt::warn ($msg);	672	urxvt::warn ($msg);
510	};	673	};
511
512	# %ENV is the original startup environment
513	delete $ENV{IFS};
514	delete $ENV{CDPATH};
515	delete $ENV{BASH_ENV};
516	$ENV{PATH} = "/bin:/sbin:/usr/bin:/usr/sbin:/usr/local/bin:/usr/local/sbin:/opt/bin:/opt/sbin";
517	}	674	}
518		675
519	my @hook_count;
520	my $verbosity = $ENV{URXVT_PERL_VERBOSITY};	676	my $verbosity = $ENV{URXVT_PERL_VERBOSITY};
521		677
522	sub verbose {	678	sub verbose {
523	my ($level, $msg) = @_;	679	my ($level, $msg) = @_;
524	warn "$msg\n" if $level <= $verbosity;	680	warn "$msg\n" if $level <= $verbosity;
525	}	681	}
526		682
527	my $extension_pkg = "extension0000";
528	my %extension_pkg;	683	my %extension_pkg;
529		684
530	# load a single script into its own package, once only	685	# load a single script into its own package, once only
531	sub extension_package($) {	686	sub extension_package($) {
532	my ($path) = @_;	687	my ($path) = @_;
533		688
534	$extension_pkg{$path} \|\|= do {	689	$extension_pkg{$path} \|\|= do {
535	my $pkg = "urxvt::" . ($extension_pkg++);	690	$path =~ /([^\/\\]+)$/;
		691	my $pkg = $1;
		692	$pkg =~ s/[^[:word:]]/_/g;
		693	$pkg = "urxvt::ext::$pkg";
536		694
537	verbose 3, "loading extension '$path' into package '$pkg'";	695	verbose 3, "loading extension '$path' into package '$pkg'";
538		696
539	open my $fh, "<:raw", $path	697	open my $fh, "<:raw", $path
540	or die "$path: $!";	698	or die "$path: $!";
541		699
542	my $source = untaint	700	my $source =
543	"package $pkg; use strict; use utf8;\n"	701	"package $pkg; use strict; use utf8;\n"
544	. "use base urxvt::term::extension::;\n"
545	. "#line 1 \"$path\"\n{\n"	702	. "#line 1 \"$path\"\n{\n"
546	. (do { local $/; <$fh> })	703	. (do { local $/; <$fh> })
547	. "\n};\n1";	704	. "\n};\n1";
548		705
549	eval $source	706	eval $source
…		…
563	if ($htype == 0) { # INIT	720	if ($htype == 0) { # INIT
564	my @dirs = ((split /:/, $TERM->resource ("perl_lib")), "$LIBDIR/perl");	721	my @dirs = ((split /:/, $TERM->resource ("perl_lib")), "$LIBDIR/perl");
565		722
566	my %ext_arg;	723	my %ext_arg;
567		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
568	for (map { split /,/, $TERM->resource ("perl_ext_$_") } 1, 2) {	734	for (grep $_, map { split /,/, $TERM->resource ("perl_ext_$_") } 1, 2) {
569	if ($_ eq "default") {	735	if ($_ eq "default") {
570	$ext_arg{$_} \|\|= [] for qw(selection option-popup selection-popup searchable-scrollback);	736	$ext_arg{$_} \|\|= [] for qw(selection option-popup selection-popup searchable-scrollback);
571	} elsif (/^-(.*)$/) {	737	} elsif (/^-(.*)$/) {
572	delete $ext_arg{$1};	738	delete $ext_arg{$1};
573	} elsif (/^([^<]+)<(.*)>$/) {	739	} elsif (/^([^<]+)<(.*)>$/) {
…		…
598	if $verbosity >= 10;	764	if $verbosity >= 10;
599		765
600	keys %$cb;	766	keys %$cb;
601		767
602	while (my ($pkg, $cb) = each %$cb) {	768	while (my ($pkg, $cb) = each %$cb) {
603	$retval = eval { $cb->($TERM->{_pkg}{$pkg}, @_) }	769	my $retval_ = eval { $cb->($TERM->{_pkg}{$pkg}, @_) };
604	and last;	770	$retval \|\|= $retval_;
605		771
606	if ($@) {	772	if ($@) {
607	$TERM->ungrab; # better to lose the grab than the session	773	$TERM->ungrab; # better to lose the grab than the session
608	warn $@;	774	warn $@;
609	}	775	}
…		…
612	verbose 11, "$HOOKNAME[$htype] returning <$retval>"	778	verbose 11, "$HOOKNAME[$htype] returning <$retval>"
613	if $verbosity >= 11;	779	if $verbosity >= 11;
614	}	780	}
615		781
616	if ($htype == 1) { # DESTROY	782	if ($htype == 1) { # DESTROY
617	if (my $hook = delete $TERM->{_hook}) {
618	for my $htype (0..$#$hook) {
619	$hook_count[$htype] -= scalar keys %{ $hook->[$htype] \|\| {} }
620	or set_should_invoke $htype, 0;
621	}
622	}
623
624	# clear package objects	783	# clear package objects
625	%$_ = () for values %{ $TERM->{_pkg} };	784	%$_ = () for values %{ $TERM->{_pkg} };
626		785
627	# clear package	786	# clear package
628	%$TERM = ();	787	%$TERM = ();
629	}	788	}
630		789
631	$retval	790	$retval
632	}
633
634	sub exec_async(@) {
635	my $pid = fork;
636
637	return
638	if !defined $pid or $pid;
639
640	%ENV = %{ $TERM->env };
641
642	exec @_;
643	_exit 255;
644	}	791	}
645		792
646	# urxvt::term::extension	793	# urxvt::term::extension
647		794
648	package urxvt::term::extension;	795	package urxvt::term::extension;
…		…
654	while (my ($name, $cb) = each %hook) {	801	while (my ($name, $cb) = each %hook) {
655	my $htype = $HOOKTYPE{uc $name};	802	my $htype = $HOOKTYPE{uc $name};
656	defined $htype	803	defined $htype
657	or Carp::croak "unsupported hook type '$name'";	804	or Carp::croak "unsupported hook type '$name'";
658		805
		806	$self->set_should_invoke ($htype, +1)
659	unless (exists $self->{term}{_hook}[$htype]{$pkg}) {	807	unless exists $self->{term}{_hook}[$htype]{$pkg};
660	$hook_count[$htype]++
661	or urxvt::set_should_invoke $htype, 1;
662	}
663		808
664	$self->{term}{_hook}[$htype]{$pkg} = $cb;	809	$self->{term}{_hook}[$htype]{$pkg} = $cb;
665	}	810	}
666	}	811	}
667		812
…		…
672	for my $name (@hook) {	817	for my $name (@hook) {
673	my $htype = $HOOKTYPE{uc $name};	818	my $htype = $HOOKTYPE{uc $name};
674	defined $htype	819	defined $htype
675	or Carp::croak "unsupported hook type '$name'";	820	or Carp::croak "unsupported hook type '$name'";
676		821
		822	$self->set_should_invoke ($htype, -1)
677	if (delete $self->{term}{_hook}[$htype]{$pkg}) {	823	if delete $self->{term}{_hook}[$htype]{$pkg};
678	--$hook_count[$htype]
679	or urxvt::set_should_invoke $htype, 0;
680	}
681	}	824	}
682	}	825	}
683		826
684	our $AUTOLOAD;	827	our $AUTOLOAD;
685		828
…		…
791	# find on_xxx subs in the package and register them	934	# find on_xxx subs in the package and register them
792	# as hooks	935	# as hooks
793	sub register_package {	936	sub register_package {
794	my ($self, $pkg, $argv) = @_;	937	my ($self, $pkg, $argv) = @_;
795		938
		939	no strict 'refs';
		940
		941	urxvt::verbose 6, "register package $pkg to $self";
		942
		943	@{"$pkg\::ISA"} = urxvt::term::extension::;
		944
796	my $proxy = bless {	945	my $proxy = bless {
797	_pkg => $pkg,	946	_pkg => $pkg,
798	argv => $argv,	947	argv => $argv,
799	}, $pkg;	948	}, $pkg;
800	Scalar::Util::weaken ($proxy->{term} = $self);	949	Scalar::Util::weaken ($proxy->{term} = $self);
…		…
831		980
832	Destroy the terminal object (close the window, free resources	981	Destroy the terminal object (close the window, free resources
833	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
834	watchers (timers, io watchers) are still active.	983	watchers (timers, io watchers) are still active.
835		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
836	=item $isset = $term->option ($optval[, $set])	1010	=item $isset = $term->option ($optval[, $set])
837		1011
838	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
839	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
840	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.
…		…
842	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
843	source file F</src/optinc.h> to see the actual list:	1017	source file F</src/optinc.h> to see the actual list:
844		1018
845	borderLess console cursorBlink cursorUnderline hold iconic insecure	1019	borderLess console cursorBlink cursorUnderline hold iconic insecure
846	intensityStyles jumpScroll loginShell mapAlert meta8 mouseWheelScrollPage	1020	intensityStyles jumpScroll loginShell mapAlert meta8 mouseWheelScrollPage
847	pastableTabs pointerBlank reverseVideo scrollBar scrollBar_floating	1021	override-redirect pastableTabs pointerBlank reverseVideo scrollBar
848	scrollBar_right scrollTtyKeypress scrollTtyOutput scrollWithBuffer	1022	scrollBar_floating scrollBar_right scrollTtyKeypress scrollTtyOutput
849	secondaryScreen secondaryScroll skipBuiltinGlyphs transparent	1023	scrollWithBuffer secondaryScreen secondaryScroll skipBuiltinGlyphs
850	tripleclickwords utmpInhibit visualBell	1024	transparent tripleclickwords utmpInhibit visualBell
851		1025
852	=item $value = $term->resource ($name[, $newval])	1026	=item $value = $term->resource ($name[, $newval])
853		1027
854	Returns the current resource value associated with a given name and	1028	Returns the current resource value associated with a given name and
855	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>
…		…
872		1046
873	answerbackstring backgroundPixmap backspace_key boldFont boldItalicFont	1047	answerbackstring backgroundPixmap backspace_key boldFont boldItalicFont
874	borderLess color cursorBlink cursorUnderline cutchars delete_key	1048	borderLess color cursorBlink cursorUnderline cutchars delete_key
875	display_name embed ext_bwidth fade font geometry hold iconName	1049	display_name embed ext_bwidth fade font geometry hold iconName
876	imFont imLocale inputMethod insecure int_bwidth intensityStyles	1050	imFont imLocale inputMethod insecure int_bwidth intensityStyles
877	italicFont jumpScroll lineSpace loginShell mapAlert menu meta8 modifier	1051	italicFont jumpScroll lineSpace loginShell mapAlert meta8 modifier
878	mouseWheelScrollPage name pastableTabs path perl_eval perl_ext_1 perl_ext_2	1052	mouseWheelScrollPage name override_redirect pastableTabs path perl_eval
879	perl_lib pointerBlank pointerBlankDelay preeditType print_pipe pty_fd	1053	perl_ext_1 perl_ext_2 perl_lib pointerBlank pointerBlankDelay
880	reverseVideo saveLines scrollBar scrollBar_align scrollBar_floating	1054	preeditType print_pipe pty_fd reverseVideo saveLines scrollBar
881	scrollBar_right scrollBar_thickness scrollTtyKeypress scrollTtyOutput	1055	scrollBar_align scrollBar_floating scrollBar_right scrollBar_thickness
882	scrollWithBuffer scrollstyle secondaryScreen secondaryScroll selectstyle	1056	scrollTtyKeypress scrollTtyOutput scrollWithBuffer scrollstyle
883	shade term_name title transparent transparent_all tripleclickwords	1057	secondaryScreen secondaryScroll selectstyle shade term_name title
884	utmpInhibit visualBell	1058	transient_for transparent transparent_all tripleclickwords utmpInhibit
		1059	visualBell
885		1060
886	=cut	1061	=cut
887		1062
888	sub resource($$;$) {	1063	sub resource($$;$) {
889	my ($self, $name) = (shift, shift);	1064	my ($self, $name) = (shift, shift);
…		…
1090		1265
1091	=item $windowid = $term->vt	1266	=item $windowid = $term->vt
1092		1267
1093	Return the window id of the terminal window.	1268	Return the window id of the terminal window.
1094		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
1095	=item $window_width = $term->width	1277	=item $window_width = $term->width
1096		1278
1097	=item $window_height = $term->height	1279	=item $window_height = $term->height
1098		1280
1099	=item $font_width = $term->fwidth	1281	=item $font_width = $term->fwidth
…		…
1112		1294
1113	=item $max_scrollback = $term->saveLines	1295	=item $max_scrollback = $term->saveLines
1114		1296
1115	=item $nrow_plus_saveLines = $term->total_rows	1297	=item $nrow_plus_saveLines = $term->total_rows
1116		1298
1117	=item $lines_in_scrollback = $term->nsaved	1299	=item $topmost_scrollback_row = $term->top_row
1118		1300
1119	Return various integers describing terminal characteristics.	1301	Return various integers describing terminal characteristics.
1120		1302
1121	=item $x_display = $term->display_id	1303	=item $x_display = $term->display_id
1122		1304
…		…
1150	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
1151	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.
1152		1334
1153	=item $view_start = $term->view_start ([$newvalue])	1335	=item $view_start = $term->view_start ([$newvalue])
1154		1336
1155	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
1156	C<0>, which displays the normal terminal contents. Larger values scroll	1338	C<0>, which displays the normal terminal contents. Lower values scroll
1157	this many lines into the scrollback buffer.	1339	this many lines into the scrollback buffer.
1158		1340
1159	=item $term->want_refresh	1341	=item $term->want_refresh
1160		1342
1161	Requests a screen refresh. At the next opportunity, rxvt-unicode will	1343	Requests a screen refresh. At the next opportunity, rxvt-unicode will
…		…
1474	my $env = $self->{term}->env;	1656	my $env = $self->{term}->env;
1475	# 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.
1476	delete $env->{LC_ALL};	1658	delete $env->{LC_ALL};
1477	$env->{LC_CTYPE} = $self->{term}->locale;	1659	$env->{LC_CTYPE} = $self->{term}->locale;
1478		1660
1479	urxvt::term->new ($env, $self->{term}->resource ("name"),	1661	urxvt::term->new ($env, "popup",
1480	"--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",
1481	"--transient-for" => $self->{term}->parent,	1665	"--transient-for" => $self->{term}->parent,
1482	"-display" => $self->{term}->display_id,	1666	"-display" => $self->{term}->display_id,
1483	"-pe" => "urxvt-popup")	1667	"-pe" => "urxvt-popup")
1484	or die "unable to create popup window\n";	1668	or die "unable to create popup window\n";
1485	}	1669	}
…		…
1490	delete $self->{term}{_destroy}{$self};	1674	delete $self->{term}{_destroy}{$self};
1491	$self->{term}->ungrab;	1675	$self->{term}->ungrab;
1492	}	1676	}
1493		1677
1494	=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__;
1495		1688
1496	=head2 The C<urxvt::timer> Class	1689	=head2 The C<urxvt::timer> Class
1497		1690
1498	This class implements timer watchers/events. Time is represented as a	1691	This class implements timer watchers/events. Time is represented as a
1499	fractional number of seconds since the epoch. Example:	1692	fractional number of seconds since the epoch. Example:
…		…
1537	Start the timer.	1730	Start the timer.
1538		1731
1539	=item $timer = $timer->start ($tstamp)	1732	=item $timer = $timer->start ($tstamp)
1540		1733
1541	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>.
1542		1739
1543	=item $timer = $timer->stop	1740	=item $timer = $timer->stop
1544		1741
1545	Stop the timer.	1742	Stop the timer.
1546		1743

Diff Legend

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

Comparing rxvt-unicode/src/urxvt.pm (file contents): Revision 1.87 by root, Thu Jan 12 05:37:34 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.87 by root, Thu Jan 12 05:37:34 2006 UTC vs.
Revision 1.113 by root, Fri Jan 20 10:27:08 2006 UTC