[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.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
…		…
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.
130		166
131	=item mark-urls	167	=item mark-urls
132		168
133	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
134	make them clickable. When middle-clicked, the program specified in the	170	make them clickable. When middle-clicked, the program specified in the
135	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
136	the URL as first argument.	172	the URL as first argument.
137		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
138	=item block-graphics-to-ascii	182	=item block-graphics-to-ascii
139		183
140	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,
141	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
142	similar-looking ascii character.	186	similar-looking ascii character.
…		…
148	=item example-refresh-hooks	192	=item example-refresh-hooks
149		193
150	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
151	window. Illustrates overwriting the refresh callbacks to create your own	195	window. Illustrates overwriting the refresh callbacks to create your own
152	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/%
153		226
154	=back	227	=back
155		228
156	=head1 API DOCUMENTATION	229	=head1 API DOCUMENTATION
157		230
…		…
230	called whenever the relevant event happens.	303	called whenever the relevant event happens.
231		304
232	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
233	the in the C<Extension Objects> section.	306	the in the C<Extension Objects> section.
234		307
235	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
236	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
237	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.
238		311
239	I<< When in doubt, return a false value (preferably C<()>). >>	312	I<< When in doubt, return a false value (preferably C<()>). >>
240		313
241	=over 4	314	=over 4
242		315
243	=item on_init $term	316	=item on_init $term
244		317
245	Called after a new terminal object has been initialized, but before	318	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	319	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	320	call or deliver senseless data, as terminal size and other characteristics
248	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
249	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.
250		335
251	=item on_reset $term	336	=item on_reset $term
252		337
253	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
254	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
255	variables.	340	variables.
256		341
257	=item on_start $term	342	=item on_child_start $term, $pid
258		343
259	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.
260	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>.
261		350
262	=item on_sel_make $term, $eventtime	351	=item on_sel_make $term, $eventtime
263		352
264	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
265	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
…		…
358		447
359	Called whenever the user presses a key combination that has a	448	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>	449	C<perl:string> action bound to it (see description of the B<keysym>
361	resource in the @@RXVT_NAME@@(1) manpage).	450	resource in the @@RXVT_NAME@@(1) manpage).
362		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
363	=item on_focus_in $term	458	=item on_focus_in $term
364		459
365	Called whenever the window gets the keyboard focus, before rxvt-unicode	460	Called whenever the window gets the keyboard focus, before rxvt-unicode
366	does focus in processing.	461	does focus in processing.
367		462
368	=item on_focus_out $term	463	=item on_focus_out $term
369		464
370	Called wheneever the window loses keyboard focus, before rxvt-unicode does	465	Called wheneever the window loses keyboard focus, before rxvt-unicode does
371	focus out processing.	466	focus out processing.
		467
		468	=item on_configure_notify $term, $event
372		469
373	=item on_key_press $term, $event, $keysym, $octets	470	=item on_key_press $term, $event, $keysym, $octets
374		471
375	=item on_key_release $term, $event, $keysym	472	=item on_key_release $term, $event, $keysym
376		473
…		…
408	use Scalar::Util ();	505	use Scalar::Util ();
409	use List::Util ();	506	use List::Util ();
410		507
411	our $VERSION = 1;	508	our $VERSION = 1;
412	our $TERM;	509	our $TERM;
		510	our @TERM_INIT;
		511	our @TERM_EXT;
413	our @HOOKNAME;	512	our @HOOKNAME;
414	our %HOOKTYPE = map +($HOOKNAME[$_] => $_), 0..$#HOOKNAME;	513	our %HOOKTYPE = map +($HOOKNAME[$_] => $_), 0..$#HOOKNAME;
415	our %OPTION;	514	our %OPTION;
416		515
417	our $LIBDIR;	516	our $LIBDIR;
…		…
439	=item $urxvt::TERM	538	=item $urxvt::TERM
440		539
441	The current terminal. This variable stores the current C<urxvt::term>	540	The current terminal. This variable stores the current C<urxvt::term>
442	object, whenever a callback/hook is executing.	541	object, whenever a callback/hook is executing.
443		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
444	=back	559	=back
445		560
446	=head2 Functions in the C<urxvt> Package	561	=head2 Functions in the C<urxvt> Package
447		562
448	=over 4	563	=over 4
…		…
462	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
463	correct place, e.g. on stderr of the connecting urxvtc client.	578	correct place, e.g. on stderr of the connecting urxvtc client.
464		579
465	Messages have a size limit of 1023 bytes currently.	580	Messages have a size limit of 1023 bytes currently.
466		581
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	582	=item $time = urxvt::NOW
474		583
475	Returns the "current time" (as per the event loop).	584	Returns the "current time" (as per the event loop).
476		585
477	=item urxvt::CurrentTime	586	=item urxvt::CurrentTime
478		587
479	=item urxvt::ShiftMask, LockMask, ControlMask, Mod1Mask, Mod2Mask,	588	=item urxvt::ShiftMask, LockMask, ControlMask, Mod1Mask, Mod2Mask,
480	Mod3Mask, Mod4Mask, Mod5Mask, Button1Mask, Button2Mask, Button3Mask,	589	Mod3Mask, Mod4Mask, Mod5Mask, Button1Mask, Button2Mask, Button3Mask,
481	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
482		607
483	Various constants for use in X calls and event processing.	608	Various constants for use in X calls and event processing.
484		609
485	=back	610	=back
486		611
…		…
537	=back	662	=back
538		663
539	=cut	664	=cut
540		665
541	BEGIN {	666	BEGIN {
542	urxvt->bootstrap;
543
544	# overwrite perl's warn	667	# overwrite perl's warn
545	*CORE::GLOBAL::warn = sub {	668	*CORE::GLOBAL::warn = sub {
546	my $msg = join "", @_;	669	my $msg = join "", @_;
547	$msg .= "\n"	670	$msg .= "\n"
548	unless $msg =~ /\n$/;	671	unless $msg =~ /\n$/;
549	urxvt::warn ($msg);	672	urxvt::warn ($msg);
550	};	673	};
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	}	674	}
558		675
559	my @hook_count;
560	my $verbosity = $ENV{URXVT_PERL_VERBOSITY};	676	my $verbosity = $ENV{URXVT_PERL_VERBOSITY};
561		677
562	sub verbose {	678	sub verbose {
563	my ($level, $msg) = @_;	679	my ($level, $msg) = @_;
564	warn "$msg\n" if $level <= $verbosity;	680	warn "$msg\n" if $level <= $verbosity;
565	}	681	}
566		682
567	my $extension_pkg = "extension0000";
568	my %extension_pkg;	683	my %extension_pkg;
569		684
570	# load a single script into its own package, once only	685	# load a single script into its own package, once only
571	sub extension_package($) {	686	sub extension_package($) {
572	my ($path) = @_;	687	my ($path) = @_;
573		688
574	$extension_pkg{$path} \|\|= do {	689	$extension_pkg{$path} \|\|= do {
575	my $pkg = "urxvt::" . ($extension_pkg++);	690	$path =~ /([^\/\\]+)$/;
		691	my $pkg = $1;
		692	$pkg =~ s/[^[:word:]]/_/g;
		693	$pkg = "urxvt::ext::$pkg";
576		694
577	verbose 3, "loading extension '$path' into package '$pkg'";	695	verbose 3, "loading extension '$path' into package '$pkg'";
578		696
579	open my $fh, "<:raw", $path	697	open my $fh, "<:raw", $path
580	or die "$path: $!";	698	or die "$path: $!";
581		699
582	my $source = untaint	700	my $source =
583	"package $pkg; use strict; use utf8;\n"	701	"package $pkg; use strict; use utf8;\n"
584	. "use base urxvt::term::extension::;\n"
585	. "#line 1 \"$path\"\n{\n"	702	. "#line 1 \"$path\"\n{\n"
586	. (do { local $/; <$fh> })	703	. (do { local $/; <$fh> })
587	. "\n};\n1";	704	. "\n};\n1";
588		705
589	eval $source	706	eval $source
…		…
603	if ($htype == 0) { # INIT	720	if ($htype == 0) { # INIT
604	my @dirs = ((split /:/, $TERM->resource ("perl_lib")), "$LIBDIR/perl");	721	my @dirs = ((split /:/, $TERM->resource ("perl_lib")), "$LIBDIR/perl");
605		722
606	my %ext_arg;	723	my %ext_arg;
607		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
608	for (map { split /,/, $TERM->resource ("perl_ext_$_") } 1, 2) {	734	for (grep $_, map { split /,/, $TERM->resource ("perl_ext_$_") } 1, 2) {
609	if ($_ eq "default") {	735	if ($_ eq "default") {
610	$ext_arg{$_} \|\|= [] for qw(selection option-popup selection-popup searchable-scrollback);	736	$ext_arg{$_} \|\|= [] for qw(selection option-popup selection-popup searchable-scrollback);
611	} elsif (/^-(.*)$/) {	737	} elsif (/^-(.*)$/) {
612	delete $ext_arg{$1};	738	delete $ext_arg{$1};
613	} elsif (/^([^<]+)<(.*)>$/) {	739	} elsif (/^([^<]+)<(.*)>$/) {
…		…
638	if $verbosity >= 10;	764	if $verbosity >= 10;
639		765
640	keys %$cb;	766	keys %$cb;
641		767
642	while (my ($pkg, $cb) = each %$cb) {	768	while (my ($pkg, $cb) = each %$cb) {
643	$retval = eval { $cb->($TERM->{_pkg}{$pkg}, @_) }	769	my $retval_ = eval { $cb->($TERM->{_pkg}{$pkg}, @_) };
644	and last;	770	$retval \|\|= $retval_;
645		771
646	if ($@) {	772	if ($@) {
647	$TERM->ungrab; # better to lose the grab than the session	773	$TERM->ungrab; # better to lose the grab than the session
648	warn $@;	774	warn $@;
649	}	775	}
…		…
652	verbose 11, "$HOOKNAME[$htype] returning <$retval>"	778	verbose 11, "$HOOKNAME[$htype] returning <$retval>"
653	if $verbosity >= 11;	779	if $verbosity >= 11;
654	}	780	}
655		781
656	if ($htype == 1) { # DESTROY	782	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	783	# clear package objects
665	%$_ = () for values %{ $TERM->{_pkg} };	784	%$_ = () for values %{ $TERM->{_pkg} };
666		785
667	# clear package	786	# clear package
668	%$TERM = ();	787	%$TERM = ();
669	}	788	}
670		789
671	$retval	790	$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	}	791	}
685		792
686	# urxvt::term::extension	793	# urxvt::term::extension
687		794
688	package urxvt::term::extension;	795	package urxvt::term::extension;
…		…
694	while (my ($name, $cb) = each %hook) {	801	while (my ($name, $cb) = each %hook) {
695	my $htype = $HOOKTYPE{uc $name};	802	my $htype = $HOOKTYPE{uc $name};
696	defined $htype	803	defined $htype
697	or Carp::croak "unsupported hook type '$name'";	804	or Carp::croak "unsupported hook type '$name'";
698		805
		806	$self->set_should_invoke ($htype, +1)
699	unless (exists $self->{term}{_hook}[$htype]{$pkg}) {	807	unless exists $self->{term}{_hook}[$htype]{$pkg};
700	$hook_count[$htype]++
701	or urxvt::set_should_invoke $htype, 1;
702	}
703		808
704	$self->{term}{_hook}[$htype]{$pkg} = $cb;	809	$self->{term}{_hook}[$htype]{$pkg} = $cb;
705	}	810	}
706	}	811	}
707		812
…		…
712	for my $name (@hook) {	817	for my $name (@hook) {
713	my $htype = $HOOKTYPE{uc $name};	818	my $htype = $HOOKTYPE{uc $name};
714	defined $htype	819	defined $htype
715	or Carp::croak "unsupported hook type '$name'";	820	or Carp::croak "unsupported hook type '$name'";
716		821
		822	$self->set_should_invoke ($htype, -1)
717	if (delete $self->{term}{_hook}[$htype]{$pkg}) {	823	if delete $self->{term}{_hook}[$htype]{$pkg};
718	--$hook_count[$htype]
719	or urxvt::set_should_invoke $htype, 0;
720	}
721	}	824	}
722	}	825	}
723		826
724	our $AUTOLOAD;	827	our $AUTOLOAD;
725		828
…		…
831	# find on_xxx subs in the package and register them	934	# find on_xxx subs in the package and register them
832	# as hooks	935	# as hooks
833	sub register_package {	936	sub register_package {
834	my ($self, $pkg, $argv) = @_;	937	my ($self, $pkg, $argv) = @_;
835		938
		939	no strict 'refs';
		940
		941	urxvt::verbose 6, "register package $pkg to $self";
		942
		943	@{"$pkg\::ISA"} = urxvt::term::extension::;
		944
836	my $proxy = bless {	945	my $proxy = bless {
837	_pkg => $pkg,	946	_pkg => $pkg,
838	argv => $argv,	947	argv => $argv,
839	}, $pkg;	948	}, $pkg;
840	Scalar::Util::weaken ($proxy->{term} = $self);	949	Scalar::Util::weaken ($proxy->{term} = $self);
…		…
871		980
872	Destroy the terminal object (close the window, free resources	981	Destroy the terminal object (close the window, free resources
873	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
874	watchers (timers, io watchers) are still active.	983	watchers (timers, io watchers) are still active.
875		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
876	=item $isset = $term->option ($optval[, $set])	1010	=item $isset = $term->option ($optval[, $set])
877		1011
878	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
879	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
880	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.
…		…
882	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
883	source file F</src/optinc.h> to see the actual list:	1017	source file F</src/optinc.h> to see the actual list:
884		1018
885	borderLess console cursorBlink cursorUnderline hold iconic insecure	1019	borderLess console cursorBlink cursorUnderline hold iconic insecure
886	intensityStyles jumpScroll loginShell mapAlert meta8 mouseWheelScrollPage	1020	intensityStyles jumpScroll loginShell mapAlert meta8 mouseWheelScrollPage
887	pastableTabs pointerBlank reverseVideo scrollBar scrollBar_floating	1021	override-redirect pastableTabs pointerBlank reverseVideo scrollBar
888	scrollBar_right scrollTtyKeypress scrollTtyOutput scrollWithBuffer	1022	scrollBar_floating scrollBar_right scrollTtyKeypress scrollTtyOutput
889	secondaryScreen secondaryScroll skipBuiltinGlyphs transparent	1023	scrollWithBuffer secondaryScreen secondaryScroll skipBuiltinGlyphs
890	tripleclickwords utmpInhibit visualBell	1024	transparent tripleclickwords utmpInhibit visualBell
891		1025
892	=item $value = $term->resource ($name[, $newval])	1026	=item $value = $term->resource ($name[, $newval])
893		1027
894	Returns the current resource value associated with a given name and	1028	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>	1029	optionally sets a new value. Setting values is most useful in the C<init>
…		…
912		1046
913	answerbackstring backgroundPixmap backspace_key boldFont boldItalicFont	1047	answerbackstring backgroundPixmap backspace_key boldFont boldItalicFont
914	borderLess color cursorBlink cursorUnderline cutchars delete_key	1048	borderLess color cursorBlink cursorUnderline cutchars delete_key
915	display_name embed ext_bwidth fade font geometry hold iconName	1049	display_name embed ext_bwidth fade font geometry hold iconName
916	imFont imLocale inputMethod insecure int_bwidth intensityStyles	1050	imFont imLocale inputMethod insecure int_bwidth intensityStyles
917	italicFont jumpScroll lineSpace loginShell mapAlert menu meta8 modifier	1051	italicFont jumpScroll lineSpace loginShell mapAlert meta8 modifier
918	mouseWheelScrollPage name pastableTabs path perl_eval perl_ext_1 perl_ext_2	1052	mouseWheelScrollPage name override_redirect pastableTabs path perl_eval
919	perl_lib pointerBlank pointerBlankDelay preeditType print_pipe pty_fd	1053	perl_ext_1 perl_ext_2 perl_lib pointerBlank pointerBlankDelay
920	reverseVideo saveLines scrollBar scrollBar_align scrollBar_floating	1054	preeditType print_pipe pty_fd reverseVideo saveLines scrollBar
921	scrollBar_right scrollBar_thickness scrollTtyKeypress scrollTtyOutput	1055	scrollBar_align scrollBar_floating scrollBar_right scrollBar_thickness
922	scrollWithBuffer scrollstyle secondaryScreen secondaryScroll selectstyle	1056	scrollTtyKeypress scrollTtyOutput scrollWithBuffer scrollstyle
923	shade term_name title transparent transparent_all tripleclickwords	1057	secondaryScreen secondaryScroll selectstyle shade term_name title
924	utmpInhibit visualBell	1058	transient_for transparent transparent_all tripleclickwords utmpInhibit
		1059	visualBell
925		1060
926	=cut	1061	=cut
927		1062
928	sub resource($$;$) {	1063	sub resource($$;$) {
929	my ($self, $name) = (shift, shift);	1064	my ($self, $name) = (shift, shift);
…		…
1130		1265
1131	=item $windowid = $term->vt	1266	=item $windowid = $term->vt
1132		1267
1133	Return the window id of the terminal window.	1268	Return the window id of the terminal window.
1134		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
1135	=item $window_width = $term->width	1277	=item $window_width = $term->width
1136		1278
1137	=item $window_height = $term->height	1279	=item $window_height = $term->height
1138		1280
1139	=item $font_width = $term->fwidth	1281	=item $font_width = $term->fwidth
…		…
1152		1294
1153	=item $max_scrollback = $term->saveLines	1295	=item $max_scrollback = $term->saveLines
1154		1296
1155	=item $nrow_plus_saveLines = $term->total_rows	1297	=item $nrow_plus_saveLines = $term->total_rows
1156		1298
1157	=item $lines_in_scrollback = $term->nsaved	1299	=item $topmost_scrollback_row = $term->top_row
1158		1300
1159	Return various integers describing terminal characteristics.	1301	Return various integers describing terminal characteristics.
1160		1302
1161	=item $x_display = $term->display_id	1303	=item $x_display = $term->display_id
1162		1304
…		…
1190	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
1191	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.
1192		1334
1193	=item $view_start = $term->view_start ([$newvalue])	1335	=item $view_start = $term->view_start ([$newvalue])
1194		1336
1195	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
1196	C<0>, which displays the normal terminal contents. Larger values scroll	1338	C<0>, which displays the normal terminal contents. Lower values scroll
1197	this many lines into the scrollback buffer.	1339	this many lines into the scrollback buffer.
1198		1340
1199	=item $term->want_refresh	1341	=item $term->want_refresh
1200		1342
1201	Requests a screen refresh. At the next opportunity, rxvt-unicode will	1343	Requests a screen refresh. At the next opportunity, rxvt-unicode will
…		…
1514	my $env = $self->{term}->env;	1656	my $env = $self->{term}->env;
1515	# 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.
1516	delete $env->{LC_ALL};	1658	delete $env->{LC_ALL};
1517	$env->{LC_CTYPE} = $self->{term}->locale;	1659	$env->{LC_CTYPE} = $self->{term}->locale;
1518		1660
1519	urxvt::term->new ($env, $self->{term}->resource ("name"),	1661	urxvt::term->new ($env, "popup",
1520	"--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",
1521	"--transient-for" => $self->{term}->parent,	1665	"--transient-for" => $self->{term}->parent,
1522	"-display" => $self->{term}->display_id,	1666	"-display" => $self->{term}->display_id,
1523	"-pe" => "urxvt-popup")	1667	"-pe" => "urxvt-popup")
1524	or die "unable to create popup window\n";	1668	or die "unable to create popup window\n";
1525	}	1669	}
…		…
1530	delete $self->{term}{_destroy}{$self};	1674	delete $self->{term}{_destroy}{$self};
1531	$self->{term}->ungrab;	1675	$self->{term}->ungrab;
1532	}	1676	}
1533		1677
1534	=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__;
1535		1688
1536	=head2 The C<urxvt::timer> Class	1689	=head2 The C<urxvt::timer> Class
1537		1690
1538	This class implements timer watchers/events. Time is represented as a	1691	This class implements timer watchers/events. Time is represented as a
1539	fractional number of seconds since the epoch. Example:	1692	fractional number of seconds since the epoch. Example:
…		…
1577	Start the timer.	1730	Start the timer.
1578		1731
1579	=item $timer = $timer->start ($tstamp)	1732	=item $timer = $timer->start ($tstamp)
1580		1733
1581	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>.
1582		1739
1583	=item $timer = $timer->stop	1740	=item $timer = $timer->stop
1584		1741
1585	Stop the timer.	1742	Stop the timer.
1586		1743

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.113 by root, Fri Jan 20 10:27:08 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.113 by root, Fri Jan 20 10:27:08 2006 UTC