[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.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
…		…
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.
		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.
94		176
95	=item mark-urls	177	=item mark-urls
96		178
97	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
98	make them clickable. When middle-clicked, the program specified in the	180	make them clickable. When middle-clicked, the program specified in the
99	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
100	the URL as first argument.	182	the URL as first argument.
101		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
102	=item block-graphics-to-ascii	192	=item block-graphics-to-ascii
103		193
104	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,
105	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
106	similar-looking ascii character.	196	similar-looking ascii character.
107		197
		198	=item digital-clock
		199
		200	Displays a digital clock using the built-in overlay.
		201
108	=item example-refresh-hooks	202	=item example-refresh-hooks
109		203
110	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
111	window. Illustrates overwriting the refresh callbacks to create your own	205	window. Illustrates overwriting the refresh callbacks to create your own
112	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/%
113		236
114	=back	237	=back
115		238
116	=head1 API DOCUMENTATION	239	=head1 API DOCUMENTATION
117		240
…		…
190	called whenever the relevant event happens.	313	called whenever the relevant event happens.
191		314
192	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
193	the in the C<Extension Objects> section.	316	the in the C<Extension Objects> section.
194		317
195	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
196	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
197	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.
198		321
199	I<< When in doubt, return a false value (preferably C<()>). >>	322	I<< When in doubt, return a false value (preferably C<()>). >>
200		323
201	=over 4	324	=over 4
202		325
203	=item on_init $term	326	=item on_init $term
204		327
205	Called after a new terminal object has been initialized, but before	328	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	329	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	330	call or deliver senseless data, as terminal size and other characteristics
208	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
209	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.
210		345
211	=item on_reset $term	346	=item on_reset $term
212		347
213	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
214	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
215	variables.	350	variables.
216		351
217	=item on_start $term	352	=item on_child_start $term, $pid
218		353
219	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.
220	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>.
221		360
222	=item on_sel_make $term, $eventtime	361	=item on_sel_make $term, $eventtime
223		362
224	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
225	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
…		…
318		457
319	Called whenever the user presses a key combination that has a	458	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>	459	C<perl:string> action bound to it (see description of the B<keysym>
321	resource in the @@RXVT_NAME@@(1) manpage).	460	resource in the @@RXVT_NAME@@(1) manpage).
322		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
323	=item on_focus_in $term	468	=item on_focus_in $term
324		469
325	Called whenever the window gets the keyboard focus, before rxvt-unicode	470	Called whenever the window gets the keyboard focus, before rxvt-unicode
326	does focus in processing.	471	does focus in processing.
327		472
328	=item on_focus_out $term	473	=item on_focus_out $term
329		474
330	Called wheneever the window loses keyboard focus, before rxvt-unicode does	475	Called wheneever the window loses keyboard focus, before rxvt-unicode does
331	focus out processing.	476	focus out processing.
		477
		478	=item on_configure_notify $term, $event
332		479
333	=item on_key_press $term, $event, $keysym, $octets	480	=item on_key_press $term, $event, $keysym, $octets
334		481
335	=item on_key_release $term, $event, $keysym	482	=item on_key_release $term, $event, $keysym
336		483
…		…
353		500
354	C<on_key_press> additionally receives the string rxvt-unicode would	501	C<on_key_press> additionally receives the string rxvt-unicode would
355	output, if any, in locale-specific encoding.	502	output, if any, in locale-specific encoding.
356		503
357	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).
358		514
359	=back	515	=back
360		516
361	=cut	517	=cut
362		518
…		…
368	use Scalar::Util ();	524	use Scalar::Util ();
369	use List::Util ();	525	use List::Util ();
370		526
371	our $VERSION = 1;	527	our $VERSION = 1;
372	our $TERM;	528	our $TERM;
		529	our @TERM_INIT;
		530	our @TERM_EXT;
373	our @HOOKNAME;	531	our @HOOKNAME;
374	our %HOOKTYPE = map +($HOOKNAME[$_] => $_), 0..$#HOOKNAME;	532	our %HOOKTYPE = map +($HOOKNAME[$_] => $_), 0..$#HOOKNAME;
375	our %OPTION;	533	our %OPTION;
376		534
377	our $LIBDIR;	535	our $LIBDIR;
…		…
399	=item $urxvt::TERM	557	=item $urxvt::TERM
400		558
401	The current terminal. This variable stores the current C<urxvt::term>	559	The current terminal. This variable stores the current C<urxvt::term>
402	object, whenever a callback/hook is executing.	560	object, whenever a callback/hook is executing.
403		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
404	=back	578	=back
405		579
406	=head2 Functions in the C<urxvt> Package	580	=head2 Functions in the C<urxvt> Package
407		581
408	=over 4	582	=over 4
…		…
422	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
423	correct place, e.g. on stderr of the connecting urxvtc client.	597	correct place, e.g. on stderr of the connecting urxvtc client.
424		598
425	Messages have a size limit of 1023 bytes currently.	599	Messages have a size limit of 1023 bytes currently.
426		600
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	601	=item $time = urxvt::NOW
434		602
435	Returns the "current time" (as per the event loop).	603	Returns the "current time" (as per the event loop).
436		604
437	=item urxvt::CurrentTime	605	=item urxvt::CurrentTime
438		606
439	=item urxvt::ShiftMask, LockMask, ControlMask, Mod1Mask, Mod2Mask,	607	=item urxvt::ShiftMask, LockMask, ControlMask, Mod1Mask, Mod2Mask,
440	Mod3Mask, Mod4Mask, Mod5Mask, Button1Mask, Button2Mask, Button3Mask,	608	Mod3Mask, Mod4Mask, Mod5Mask, Button1Mask, Button2Mask, Button3Mask,
441	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
442		626
443	Various constants for use in X calls and event processing.	627	Various constants for use in X calls and event processing.
444		628
445	=back	629	=back
446		630
…		…
497	=back	681	=back
498		682
499	=cut	683	=cut
500		684
501	BEGIN {	685	BEGIN {
502	urxvt->bootstrap;
503
504	# overwrite perl's warn	686	# overwrite perl's warn
505	*CORE::GLOBAL::warn = sub {	687	*CORE::GLOBAL::warn = sub {
506	my $msg = join "", @_;	688	my $msg = join "", @_;
507	$msg .= "\n"	689	$msg .= "\n"
508	unless $msg =~ /\n$/;	690	unless $msg =~ /\n$/;
509	urxvt::warn ($msg);	691	urxvt::warn ($msg);
510	};	692	};
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	}	693	}
518		694
519	my @hook_count;
520	my $verbosity = $ENV{URXVT_PERL_VERBOSITY};	695	my $verbosity = $ENV{URXVT_PERL_VERBOSITY};
521		696
522	sub verbose {	697	sub verbose {
523	my ($level, $msg) = @_;	698	my ($level, $msg) = @_;
524	warn "$msg\n" if $level <= $verbosity;	699	warn "$msg\n" if $level <= $verbosity;
525	}	700	}
526		701
527	my $extension_pkg = "extension0000";
528	my %extension_pkg;	702	my %extension_pkg;
529		703
530	# load a single script into its own package, once only	704	# load a single script into its own package, once only
531	sub extension_package($) {	705	sub extension_package($) {
532	my ($path) = @_;	706	my ($path) = @_;
533		707
534	$extension_pkg{$path} \|\|= do {	708	$extension_pkg{$path} \|\|= do {
535	my $pkg = "urxvt::" . ($extension_pkg++);	709	$path =~ /([^\/\\]+)$/;
		710	my $pkg = $1;
		711	$pkg =~ s/[^[:word:]]/_/g;
		712	$pkg = "urxvt::ext::$pkg";
536		713
537	verbose 3, "loading extension '$path' into package '$pkg'";	714	verbose 3, "loading extension '$path' into package '$pkg'";
538		715
539	open my $fh, "<:raw", $path	716	open my $fh, "<:raw", $path
540	or die "$path: $!";	717	or die "$path: $!";
541		718
542	my $source = untaint	719	my $source =
543	"package $pkg; use strict; use utf8;\n"	720	"package $pkg; use strict; use utf8;\n"
544	. "use base urxvt::term::extension::;\n"
545	. "#line 1 \"$path\"\n{\n"	721	. "#line 1 \"$path\"\n{\n"
546	. (do { local $/; <$fh> })	722	. (do { local $/; <$fh> })
547	. "\n};\n1";	723	. "\n};\n1";
548		724
549	eval $source	725	eval $source
…		…
563	if ($htype == 0) { # INIT	739	if ($htype == 0) { # INIT
564	my @dirs = ((split /:/, $TERM->resource ("perl_lib")), "$LIBDIR/perl");	740	my @dirs = ((split /:/, $TERM->resource ("perl_lib")), "$LIBDIR/perl");
565		741
566	my %ext_arg;	742	my %ext_arg;
567		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
568	for (map { split /,/, $TERM->resource ("perl_ext_$_") } 1, 2) {	753	for (grep $_, map { split /,/, $TERM->resource ("perl_ext_$_") } 1, 2) {
569	if ($_ eq "default") {	754	if ($_ eq "default") {
570	$ext_arg{$_} \|\|= [] for qw(selection option-popup selection-popup searchable-scrollback);	755	$ext_arg{$_} \|\|= [] for qw(selection option-popup selection-popup searchable-scrollback);
571	} elsif (/^-(.*)$/) {	756	} elsif (/^-(.*)$/) {
572	delete $ext_arg{$1};	757	delete $ext_arg{$1};
573	} elsif (/^([^<]+)<(.*)>$/) {	758	} elsif (/^([^<]+)<(.*)>$/) {
…		…
598	if $verbosity >= 10;	783	if $verbosity >= 10;
599		784
600	keys %$cb;	785	keys %$cb;
601		786
602	while (my ($pkg, $cb) = each %$cb) {	787	while (my ($pkg, $cb) = each %$cb) {
603	$retval = eval { $cb->($TERM->{_pkg}{$pkg}, @_) }	788	my $retval_ = eval { $cb->($TERM->{_pkg}{$pkg}, @_) };
604	and last;	789	$retval \|\|= $retval_;
605		790
606	if ($@) {	791	if ($@) {
607	$TERM->ungrab; # better to lose the grab than the session	792	$TERM->ungrab; # better to lose the grab than the session
608	warn $@;	793	warn $@;
609	}	794	}
…		…
612	verbose 11, "$HOOKNAME[$htype] returning <$retval>"	797	verbose 11, "$HOOKNAME[$htype] returning <$retval>"
613	if $verbosity >= 11;	798	if $verbosity >= 11;
614	}	799	}
615		800
616	if ($htype == 1) { # DESTROY	801	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	802	# clear package objects
625	%$_ = () for values %{ $TERM->{_pkg} };	803	%$_ = () for values %{ $TERM->{_pkg} };
626		804
627	# clear package	805	# clear package
628	%$TERM = ();	806	%$TERM = ();
629	}	807	}
630		808
631	$retval	809	$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	}	810	}
645		811
646	# urxvt::term::extension	812	# urxvt::term::extension
647		813
648	package urxvt::term::extension;	814	package urxvt::term::extension;
…		…
654	while (my ($name, $cb) = each %hook) {	820	while (my ($name, $cb) = each %hook) {
655	my $htype = $HOOKTYPE{uc $name};	821	my $htype = $HOOKTYPE{uc $name};
656	defined $htype	822	defined $htype
657	or Carp::croak "unsupported hook type '$name'";	823	or Carp::croak "unsupported hook type '$name'";
658		824
		825	$self->set_should_invoke ($htype, +1)
659	unless (exists $self->{term}{_hook}[$htype]{$pkg}) {	826	unless exists $self->{term}{_hook}[$htype]{$pkg};
660	$hook_count[$htype]++
661	or urxvt::set_should_invoke $htype, 1;
662	}
663		827
664	$self->{term}{_hook}[$htype]{$pkg} = $cb;	828	$self->{term}{_hook}[$htype]{$pkg} = $cb;
665	}	829	}
666	}	830	}
667		831
…		…
672	for my $name (@hook) {	836	for my $name (@hook) {
673	my $htype = $HOOKTYPE{uc $name};	837	my $htype = $HOOKTYPE{uc $name};
674	defined $htype	838	defined $htype
675	or Carp::croak "unsupported hook type '$name'";	839	or Carp::croak "unsupported hook type '$name'";
676		840
		841	$self->set_should_invoke ($htype, -1)
677	if (delete $self->{term}{_hook}[$htype]{$pkg}) {	842	if delete $self->{term}{_hook}[$htype]{$pkg};
678	--$hook_count[$htype]
679	or urxvt::set_should_invoke $htype, 0;
680	}
681	}	843	}
682	}	844	}
683		845
684	our $AUTOLOAD;	846	our $AUTOLOAD;
685		847
…		…
791	# find on_xxx subs in the package and register them	953	# find on_xxx subs in the package and register them
792	# as hooks	954	# as hooks
793	sub register_package {	955	sub register_package {
794	my ($self, $pkg, $argv) = @_;	956	my ($self, $pkg, $argv) = @_;
795		957
		958	no strict 'refs';
		959
		960	urxvt::verbose 6, "register package $pkg to $self";
		961
		962	@{"$pkg\::ISA"} = urxvt::term::extension::;
		963
796	my $proxy = bless {	964	my $proxy = bless {
797	_pkg => $pkg,	965	_pkg => $pkg,
798	argv => $argv,	966	argv => $argv,
799	}, $pkg;	967	}, $pkg;
800	Scalar::Util::weaken ($proxy->{term} = $self);	968	Scalar::Util::weaken ($proxy->{term} = $self);
…		…
831		999
832	Destroy the terminal object (close the window, free resources	1000	Destroy the terminal object (close the window, free resources
833	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
834	watchers (timers, io watchers) are still active.	1002	watchers (timers, io watchers) are still active.
835		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
836	=item $isset = $term->option ($optval[, $set])	1029	=item $isset = $term->option ($optval[, $set])
837		1030
838	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
839	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
840	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.
…		…
842	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
843	source file F</src/optinc.h> to see the actual list:	1036	source file F</src/optinc.h> to see the actual list:
844		1037
845	borderLess console cursorBlink cursorUnderline hold iconic insecure	1038	borderLess console cursorBlink cursorUnderline hold iconic insecure
846	intensityStyles jumpScroll loginShell mapAlert meta8 mouseWheelScrollPage	1039	intensityStyles jumpScroll loginShell mapAlert meta8 mouseWheelScrollPage
847	pastableTabs pointerBlank reverseVideo scrollBar scrollBar_floating	1040	override-redirect pastableTabs pointerBlank reverseVideo scrollBar
848	scrollBar_right scrollTtyKeypress scrollTtyOutput scrollWithBuffer	1041	scrollBar_floating scrollBar_right scrollTtyKeypress scrollTtyOutput
849	secondaryScreen secondaryScroll skipBuiltinGlyphs transparent	1042	scrollWithBuffer secondaryScreen secondaryScroll skipBuiltinGlyphs
850	tripleclickwords utmpInhibit visualBell	1043	transparent tripleclickwords utmpInhibit visualBell
851		1044
852	=item $value = $term->resource ($name[, $newval])	1045	=item $value = $term->resource ($name[, $newval])
853		1046
854	Returns the current resource value associated with a given name and	1047	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>	1048	optionally sets a new value. Setting values is most useful in the C<init>
…		…
872		1065
873	answerbackstring backgroundPixmap backspace_key boldFont boldItalicFont	1066	answerbackstring backgroundPixmap backspace_key boldFont boldItalicFont
874	borderLess color cursorBlink cursorUnderline cutchars delete_key	1067	borderLess color cursorBlink cursorUnderline cutchars delete_key
875	display_name embed ext_bwidth fade font geometry hold iconName	1068	display_name embed ext_bwidth fade font geometry hold iconName
876	imFont imLocale inputMethod insecure int_bwidth intensityStyles	1069	imFont imLocale inputMethod insecure int_bwidth intensityStyles
877	italicFont jumpScroll lineSpace loginShell mapAlert menu meta8 modifier	1070	italicFont jumpScroll lineSpace loginShell mapAlert meta8 modifier
878	mouseWheelScrollPage name pastableTabs path perl_eval perl_ext_1 perl_ext_2	1071	mouseWheelScrollPage name override_redirect pastableTabs path perl_eval
879	perl_lib pointerBlank pointerBlankDelay preeditType print_pipe pty_fd	1072	perl_ext_1 perl_ext_2 perl_lib pointerBlank pointerBlankDelay
880	reverseVideo saveLines scrollBar scrollBar_align scrollBar_floating	1073	preeditType print_pipe pty_fd reverseVideo saveLines scrollBar
881	scrollBar_right scrollBar_thickness scrollTtyKeypress scrollTtyOutput	1074	scrollBar_align scrollBar_floating scrollBar_right scrollBar_thickness
882	scrollWithBuffer scrollstyle secondaryScreen secondaryScroll selectstyle	1075	scrollTtyKeypress scrollTtyOutput scrollWithBuffer scrollstyle
883	shade term_name title transparent transparent_all tripleclickwords	1076	secondaryScreen secondaryScroll selectstyle shade term_name title
884	utmpInhibit visualBell	1077	transient_for transparent transparent_all tripleclickwords utmpInhibit
		1078	visualBell
885		1079
886	=cut	1080	=cut
887		1081
888	sub resource($$;$) {	1082	sub resource($$;$) {
889	my ($self, $name) = (shift, shift);	1083	my ($self, $name) = (shift, shift);
…		…
1090		1284
1091	=item $windowid = $term->vt	1285	=item $windowid = $term->vt
1092		1286
1093	Return the window id of the terminal window.	1287	Return the window id of the terminal window.
1094		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
1095	=item $window_width = $term->width	1296	=item $window_width = $term->width
1096		1297
1097	=item $window_height = $term->height	1298	=item $window_height = $term->height
1098		1299
1099	=item $font_width = $term->fwidth	1300	=item $font_width = $term->fwidth
…		…
1112		1313
1113	=item $max_scrollback = $term->saveLines	1314	=item $max_scrollback = $term->saveLines
1114		1315
1115	=item $nrow_plus_saveLines = $term->total_rows	1316	=item $nrow_plus_saveLines = $term->total_rows
1116		1317
1117	=item $lines_in_scrollback = $term->nsaved	1318	=item $topmost_scrollback_row = $term->top_row
1118		1319
1119	Return various integers describing terminal characteristics.	1320	Return various integers describing terminal characteristics.
1120		1321
1121	=item $x_display = $term->display_id	1322	=item $x_display = $term->display_id
1122		1323
…		…
1150	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
1151	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.
1152		1353
1153	=item $view_start = $term->view_start ([$newvalue])	1354	=item $view_start = $term->view_start ([$newvalue])
1154		1355
1155	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
1156	C<0>, which displays the normal terminal contents. Larger values scroll	1357	C<0>, which displays the normal terminal contents. Lower values scroll
1157	this many lines into the scrollback buffer.	1358	this many lines into the scrollback buffer.
1158		1359
1159	=item $term->want_refresh	1360	=item $term->want_refresh
1160		1361
1161	Requests a screen refresh. At the next opportunity, rxvt-unicode will	1362	Requests a screen refresh. At the next opportunity, rxvt-unicode will
…		…
1474	my $env = $self->{term}->env;	1675	my $env = $self->{term}->env;
1475	# 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.
1476	delete $env->{LC_ALL};	1677	delete $env->{LC_ALL};
1477	$env->{LC_CTYPE} = $self->{term}->locale;	1678	$env->{LC_CTYPE} = $self->{term}->locale;
1478		1679
1479	urxvt::term->new ($env, $self->{term}->resource ("name"),	1680	urxvt::term->new ($env, "popup",
1480	"--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",
1481	"--transient-for" => $self->{term}->parent,	1684	"--transient-for" => $self->{term}->parent,
1482	"-display" => $self->{term}->display_id,	1685	"-display" => $self->{term}->display_id,
1483	"-pe" => "urxvt-popup")	1686	"-pe" => "urxvt-popup")
1484	or die "unable to create popup window\n";	1687	or die "unable to create popup window\n";
1485	}	1688	}
…		…
1490	delete $self->{term}{_destroy}{$self};	1693	delete $self->{term}{_destroy}{$self};
1491	$self->{term}->ungrab;	1694	$self->{term}->ungrab;
1492	}	1695	}
1493		1696
1494	=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__;
1495		1707
1496	=head2 The C<urxvt::timer> Class	1708	=head2 The C<urxvt::timer> Class
1497		1709
1498	This class implements timer watchers/events. Time is represented as a	1710	This class implements timer watchers/events. Time is represented as a
1499	fractional number of seconds since the epoch. Example:	1711	fractional number of seconds since the epoch. Example:
…		…
1537	Start the timer.	1749	Start the timer.
1538		1750
1539	=item $timer = $timer->start ($tstamp)	1751	=item $timer = $timer->start ($tstamp)
1540		1752
1541	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>.
1542		1758
1543	=item $timer = $timer->stop	1759	=item $timer = $timer->stop
1544		1760
1545	Stop the timer.	1761	Stop the timer.
1546		1762
…		…
1593		1809
1594	Stop watching for events on the given filehandle.	1810	Stop watching for events on the given filehandle.
1595		1811
1596	=back	1812	=back
1597		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
1598	=head1 ENVIRONMENT	1875	=head1 ENVIRONMENT
1599		1876
1600	=head2 URXVT_PERL_VERBOSITY	1877	=head2 URXVT_PERL_VERBOSITY
1601		1878
1602	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.87 by root, Thu Jan 12 05:37:34 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.87 by root, Thu Jan 12 05:37:34 2006 UTC vs.
Revision 1.115 by root, Fri Jan 20 15:57:21 2006 UTC