[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.121 by root, Fri Jan 20 22:49:34 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
…		…
87		91
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	evaluation, web-browser starting etc.), depending on content.
		97
		98	Other extensions can extend this popup menu by pushing a code reference
		99	onto C<@{ $term->{selection_popup_hook} }>, that is called whenever the
		100	popup is displayed.
		101
		102	It's sole argument is the popup menu, which can be modified. The selection
		103	is in C<$_>, which can be used to decide wether to add something or not.
		104	It should either return nothing or a string and a code reference. The
		105	string will be used as button text and the code reference will be called
		106	when the button gets activated and should transform C<$_>.
		107
		108	The following will add an entry C<a to b> that transforms all C<a>s in
		109	the selection to C<b>s, but only if the selection currently contains any
		110	C<a>s:
		111
		112	push @{ $self->{term}{selection_popup_hook} }, sub {
		113	/a/ ? ("a to be" => sub { s/a/b/g }
		114	: ()
		115	};
93		116
94	=item searchable-scrollback<hotkey> (enabled by default)	117	=item searchable-scrollback<hotkey> (enabled by default)
95		118
96	Adds regex search functionality to the scrollback buffer, triggered	119	Adds regex search functionality to the scrollback buffer, triggered
97	by a hotkey (default: C<M-s>). While in search mode, normal terminal	120	by a hotkey (default: C<M-s>). While in search mode, normal terminal
…		…
117	URxvt.selection-autotransform.0: transform	140	URxvt.selection-autotransform.0: transform
118	URxvt.selection-autotransform.1: transform	141	URxvt.selection-autotransform.1: transform
119	...	142	...
120		143
121	For example, the following will transform selections of the form	144	For example, the following will transform selections of the form
122	C<word:number> into C<vi +$number $word>:	145	C<filename:number>, often seen in compiler messages, into C<vi +$filename
		146	$word>:
123		147
124	URxvt.selection-autotransform.0: s/^(S+):(d+):?$/vi +$2 $1\\x0d/	148	URxvt.selection-autotransform.0: s/^([^:[:space:]]+):(\\d+):?$/vi +$2 \\Q$1\\E\\x0d/
125		149
126	And this example matches the same,but replaces it with vi-commands you can	150	And this example matches the same,but replaces it with vi-commands you can
127	paste directory into your (vi :) editor:	151	paste directly into your (vi :) editor:
128		152
129	URxvt.selection-autotransform.0: s/^(S+):(d+):?$/\\x1b:e $1\\x0d:$2\\x0d/	153	URxvt.selection-autotransform.0: s/^([^:[:space:]]+(\\d+):?$/:e \\Q$1\\E\\x0d:$2\\x0d/
		154
		155	Of course, this can be modified to suit your needs and your editor :)
		156
		157	To expand the example above to typical perl error messages ("XXX at
		158	FILENAME line YYY."), you need a slightly more elaborate solution:
		159
		160	URxvt.selection.pattern-0: ( at .*? line \\d+[,.])
		161	URxvt.selection-autotransform.0: s/^ at (.*?) line (\\d+)[,.]$/:e \\Q$1\E\\x0d:$2\\x0d/
		162
		163	The first line tells the selection code to treat the unchanging part of
		164	every error message as a selection pattern, and the second line transforms
		165	the message into vi commands to load the file.
		166
		167	=item readline
		168
		169	A support package that tries to make editing with readline easier. At the
		170	moment, it reacts to clicking with the left mouse button by trying to
		171	move the text cursor to this position. It does so by generating as many
		172	cursor-left or cursor-right keypresses as required (the this only works
		173	for programs that correctly support wide characters).
		174
		175	It only works when clicking into the same line (possibly extended over
		176	multiple rows) as the text cursor and on the primary screen, to reduce the
		177	risk of misinterpreting. The normal selection isn't disabled, so quick
		178	successive clicks might interfere with selection creation in harmless
		179	ways.
		180
		181	=item tabbed
		182
		183	This transforms the terminal into a tabbar with additional terminals, that
		184	is, it implements what is commonly refered to as "tabbed terminal". The topmost line
		185	displays a "[NEW]" button, which, when clicked, will add a new tab, followed by one
		186	button per tab.
		187
		188	Clicking a button will activate that tab. Pressing B<Shift-Left> and
		189	B<Shift-Right> will switch to the tab left or right of the current one,
		190	while B<Shift-Down> creates a new tab.
130		191
131	=item mark-urls	192	=item mark-urls
132		193
133	Uses per-line display filtering (C<on_line_update>) to underline urls and	194	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	195	make them clickable. When middle-clicked, the program specified in the
135	resource C<urlLauncher> (default C<x-www-browser>) will be started with	196	resource C<urlLauncher> (default C<x-www-browser>) will be started with
136	the URL as first argument.	197	the URL as first argument.
137		198
		199	=item automove-background
		200
		201	This is basically a one-line extension that dynamically changes the background pixmap offset
		202	to the window position, in effect creating the same effect as pseudo transparency with
		203	a custom pixmap. No scaling is supported in this mode. Exmaple:
		204
		205	@@RXVT_NAME@@ -pixmap background.xpm -pe automove-background
		206
138	=item block-graphics-to-ascii	207	=item block-graphics-to-ascii
139		208
140	A not very useful example of filtering all text output to the terminal,	209	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	210	by replacing all line-drawing characters (U+2500 .. U+259F) by a
142	similar-looking ascii character.	211	similar-looking ascii character.
…		…
148	=item example-refresh-hooks	217	=item example-refresh-hooks
149		218
150	Displays a very simple digital clock in the upper right corner of the	219	Displays a very simple digital clock in the upper right corner of the
151	window. Illustrates overwriting the refresh callbacks to create your own	220	window. Illustrates overwriting the refresh callbacks to create your own
152	overlays or changes.	221	overlays or changes.
		222
		223	=item selection-pastebin
		224
		225	This is a little rarely useful extension that Uploads the selection as
		226	textfile to a remote site (or does other things). (The implementation is
		227	not currently secure for use in a multiuser environment as it writes to
		228	F</tmp> directly.).
		229
		230	It listens to the C<selection-pastebin:remote-pastebin> keyboard command,
		231	i.e.
		232
		233	URxvt.keysym.C-M-e: perl:selection-pastebin:remote-pastebin
		234
		235	Pressing this combination runs a command with C<%> replaced by the name of
		236	the textfile. This command can be set via a resource:
		237
		238	URxvt.selection-pastebin.cmd: rsync -apP % ruth:/var/www/www.ta-sa.org/files/txt/.
		239
		240	And the default is likely not useful to anybody but the few people around
		241	here :)
		242
		243	The name of the textfile is the hex encoded md5 sum of the selection, so
		244	the same content should lead to the same filename.
		245
		246	After a successful upload the selection will be replaced by the text given
		247	in the C<selection-pastebin-url> resource (again, the % is the placeholder
		248	for the filename):
		249
		250	URxvt.selection-pastebin.url: http://www.ta-sa.org/files/txt/%
153		251
154	=back	252	=back
155		253
156	=head1 API DOCUMENTATION	254	=head1 API DOCUMENTATION
157		255
…		…
230	called whenever the relevant event happens.	328	called whenever the relevant event happens.
231		329
232	The first argument passed to them is an extension oject as described in	330	The first argument passed to them is an extension oject as described in
233	the in the C<Extension Objects> section.	331	the in the C<Extension Objects> section.
234		332
235	B<All> of these hooks must return a boolean value. If it is true, then the	333	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	334	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.	335	relevant action might not be carried out by the C++ code.
238		336
239	I<< When in doubt, return a false value (preferably C<()>). >>	337	I<< When in doubt, return a false value (preferably C<()>). >>
240		338
241	=over 4	339	=over 4
242		340
243	=item on_init $term	341	=item on_init $term
244		342
245	Called after a new terminal object has been initialized, but before	343	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	344	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	345	call or deliver senseless data, as terminal size and other characteristics
248	have not yet been determined. You can safely query and change resources,	346	have not yet been determined. You can safely query and change resources
249	though.	347	and options, though. For many purposes the C<on_start> hook is a better
		348	place.
		349
		350	=item on_start $term
		351
		352	Called at the very end of initialisation of a new terminal, just before
		353	trying to map (display) the toplevel and returning to the mainloop.
		354
		355	=item on_destroy $term
		356
		357	Called whenever something tries to destroy terminal, before doing anything
		358	yet. If this hook returns true, then destruction is skipped, but this is
		359	rarely a good idea.
250		360
251	=item on_reset $term	361	=item on_reset $term
252		362
253	Called after the screen is "reset" for any reason, such as resizing or	363	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	364	control sequences. Here is where you can react on changes to size-related
255	variables.	365	variables.
256		366
257	=item on_start $term	367	=item on_child_start $term, $pid
258		368
259	Called at the very end of initialisation of a new terminal, just before	369	Called just after the child process has been C<fork>ed.
260	returning to the mainloop.	370
		371	=item on_child_exit $term, $status
		372
		373	Called just after the child process has exited. C<$status> is the status
		374	from C<waitpid>.
261		375
262	=item on_sel_make $term, $eventtime	376	=item on_sel_make $term, $eventtime
263		377
264	Called whenever a selection has been made by the user, but before the	378	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	379	selection text is copied, so changes to the beginning, end or type of the
…		…
358		472
359	Called whenever the user presses a key combination that has a	473	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>	474	C<perl:string> action bound to it (see description of the B<keysym>
361	resource in the @@RXVT_NAME@@(1) manpage).	475	resource in the @@RXVT_NAME@@(1) manpage).
362		476
		477	=item on_x_event $term, $event
		478
		479	Called on every X event received on the vt window (and possibly other
		480	windows). Should only be used as a last resort. Most event structure
		481	members are not passed.
		482
363	=item on_focus_in $term	483	=item on_focus_in $term
364		484
365	Called whenever the window gets the keyboard focus, before rxvt-unicode	485	Called whenever the window gets the keyboard focus, before rxvt-unicode
366	does focus in processing.	486	does focus in processing.
367		487
368	=item on_focus_out $term	488	=item on_focus_out $term
369		489
370	Called wheneever the window loses keyboard focus, before rxvt-unicode does	490	Called wheneever the window loses keyboard focus, before rxvt-unicode does
371	focus out processing.	491	focus out processing.
372		492
		493	=item on_configure_notify $term, $event
		494
		495	=item on_property_notify $term, $event
		496
373	=item on_key_press $term, $event, $keysym, $octets	497	=item on_key_press $term, $event, $keysym, $octets
374		498
375	=item on_key_release $term, $event, $keysym	499	=item on_key_release $term, $event, $keysym
376		500
377	=item on_button_press $term, $event	501	=item on_button_press $term, $event
…		…
386		510
387	Called whenever the corresponding X event is received for the terminal If	511	Called whenever the corresponding X event is received for the terminal If
388	the hook returns true, then the even will be ignored by rxvt-unicode.	512	the hook returns true, then the even will be ignored by rxvt-unicode.
389		513
390	The event is a hash with most values as named by Xlib (see the XEvent	514	The event is a hash with most values as named by Xlib (see the XEvent
391	manpage), with the additional members C<row> and C<col>, which are the row	515	manpage), with the additional members C<row> and C<col>, which are the
392	and column under the mouse cursor.	516	(real, not screen-based) row and column under the mouse cursor.
393		517
394	C<on_key_press> additionally receives the string rxvt-unicode would	518	C<on_key_press> additionally receives the string rxvt-unicode would
395	output, if any, in locale-specific encoding.	519	output, if any, in locale-specific encoding.
396		520
397	subwindow.	521	subwindow.
		522
		523	=item on_client_message $term, $event
		524
		525	=item on_wm_protocols $term, $event
		526
		527	=item on_wm_delete_window $term, $event
		528
		529	Called when various types of ClientMessage events are received (all with
		530	format=32, WM_PROTOCOLS or WM_PROTOCOLS:WM_DELETE_WINDOW).
398		531
399	=back	532	=back
400		533
401	=cut	534	=cut
402		535
…		…
408	use Scalar::Util ();	541	use Scalar::Util ();
409	use List::Util ();	542	use List::Util ();
410		543
411	our $VERSION = 1;	544	our $VERSION = 1;
412	our $TERM;	545	our $TERM;
		546	our @TERM_INIT;
		547	our @TERM_EXT;
413	our @HOOKNAME;	548	our @HOOKNAME;
414	our %HOOKTYPE = map +($HOOKNAME[$_] => $_), 0..$#HOOKNAME;	549	our %HOOKTYPE = map +($HOOKNAME[$_] => $_), 0..$#HOOKNAME;
415	our %OPTION;	550	our %OPTION;
416		551
417	our $LIBDIR;	552	our $LIBDIR;
418	our $RESNAME;	553	our $RESNAME;
419	our $RESCLASS;	554	our $RESCLASS;
420	our $RXVTNAME;	555	our $RXVTNAME;
421		556
		557	our $NOCHAR = chr 0xfffe;
		558
422	=head2 Variables in the C<urxvt> Package	559	=head2 Variables in the C<urxvt> Package
423		560
424	=over 4	561	=over 4
425		562
426	=item $urxvt::LIBDIR	563	=item $urxvt::LIBDIR
…		…
438		575
439	=item $urxvt::TERM	576	=item $urxvt::TERM
440		577
441	The current terminal. This variable stores the current C<urxvt::term>	578	The current terminal. This variable stores the current C<urxvt::term>
442	object, whenever a callback/hook is executing.	579	object, whenever a callback/hook is executing.
		580
		581	=item @urxvt::TERM_INIT
		582
		583	All coderefs in this array will be called as methods of the next newly
		584	created C<urxvt::term> object (during the C<on_init> phase). The array
		585	gets cleared before the codereferences that were in it are being executed,
		586	so coderefs can push themselves onto it again if they so desire.
		587
		588	This complements to the perl-eval commandline option, but gets executed
		589	first.
		590
		591	=item @urxvt::TERM_EXT
		592
		593	Works similar to C<@TERM_INIT>, but contains perl package/class names, which
		594	get registered as normal extensions after calling the hooks in C<@TERM_INIT>
		595	but before other extensions. Gets cleared just like C<@TERM_INIT>.
443		596
444	=back	597	=back
445		598
446	=head2 Functions in the C<urxvt> Package	599	=head2 Functions in the C<urxvt> Package
447		600
…		…
462	Using this function has the advantage that its output ends up in the	615	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.	616	correct place, e.g. on stderr of the connecting urxvtc client.
464		617
465	Messages have a size limit of 1023 bytes currently.	618	Messages have a size limit of 1023 bytes currently.
466		619
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	620	=item $time = urxvt::NOW
474		621
475	Returns the "current time" (as per the event loop).	622	Returns the "current time" (as per the event loop).
476		623
477	=item urxvt::CurrentTime	624	=item urxvt::CurrentTime
478		625
479	=item urxvt::ShiftMask, LockMask, ControlMask, Mod1Mask, Mod2Mask,	626	=item urxvt::ShiftMask, LockMask, ControlMask, Mod1Mask, Mod2Mask,
480	Mod3Mask, Mod4Mask, Mod5Mask, Button1Mask, Button2Mask, Button3Mask,	627	Mod3Mask, Mod4Mask, Mod5Mask, Button1Mask, Button2Mask, Button3Mask,
481	Button4Mask, Button5Mask, AnyModifier	628	Button4Mask, Button5Mask, AnyModifier
		629
		630	=item urxvt::NoEventMask, KeyPressMask, KeyReleaseMask,
		631	ButtonPressMask, ButtonReleaseMask, EnterWindowMask, LeaveWindowMask,
		632	PointerMotionMask, PointerMotionHintMask, Button1MotionMask, Button2MotionMask,
		633	Button3MotionMask, Button4MotionMask, Button5MotionMask, ButtonMotionMask,
		634	KeymapStateMask, ExposureMask, VisibilityChangeMask, StructureNotifyMask,
		635	ResizeRedirectMask, SubstructureNotifyMask, SubstructureRedirectMask,
		636	FocusChangeMask, PropertyChangeMask, ColormapChangeMask, OwnerGrabButtonMask
		637
		638	=item urxvt::KeyPress, KeyRelease, ButtonPress, ButtonRelease, MotionNotify,
		639	EnterNotify, LeaveNotify, FocusIn, FocusOut, KeymapNotify, Expose,
		640	GraphicsExpose, NoExpose, VisibilityNotify, CreateNotify, DestroyNotify,
		641	UnmapNotify, MapNotify, MapRequest, ReparentNotify, ConfigureNotify,
		642	ConfigureRequest, GravityNotify, ResizeRequest, CirculateNotify,
		643	CirculateRequest, PropertyNotify, SelectionClear, SelectionRequest,
		644	SelectionNotify, ColormapNotify, ClientMessage, MappingNotify
482		645
483	Various constants for use in X calls and event processing.	646	Various constants for use in X calls and event processing.
484		647
485	=back	648	=back
486		649
…		…
537	=back	700	=back
538		701
539	=cut	702	=cut
540		703
541	BEGIN {	704	BEGIN {
542	urxvt->bootstrap;
543
544	# overwrite perl's warn	705	# overwrite perl's warn
545	*CORE::GLOBAL::warn = sub {	706	*CORE::GLOBAL::warn = sub {
546	my $msg = join "", @_;	707	my $msg = join "", @_;
547	$msg .= "\n"	708	$msg .= "\n"
548	unless $msg =~ /\n$/;	709	unless $msg =~ /\n$/;
549	urxvt::warn ($msg);	710	urxvt::warn ($msg);
550	};	711	};
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	}	712	}
558		713
559	my @hook_count;
560	my $verbosity = $ENV{URXVT_PERL_VERBOSITY};	714	my $verbosity = $ENV{URXVT_PERL_VERBOSITY};
561		715
562	sub verbose {	716	sub verbose {
563	my ($level, $msg) = @_;	717	my ($level, $msg) = @_;
564	warn "$msg\n" if $level <= $verbosity;	718	warn "$msg\n" if $level <= $verbosity;
565	}	719	}
566		720
567	my $extension_pkg = "extension0000";
568	my %extension_pkg;	721	my %extension_pkg;
569		722
570	# load a single script into its own package, once only	723	# load a single script into its own package, once only
571	sub extension_package($) {	724	sub extension_package($) {
572	my ($path) = @_;	725	my ($path) = @_;
573		726
574	$extension_pkg{$path} \|\|= do {	727	$extension_pkg{$path} \|\|= do {
575	my $pkg = "urxvt::" . ($extension_pkg++);	728	$path =~ /([^\/\\]+)$/;
		729	my $pkg = $1;
		730	$pkg =~ s/[^[:word:]]/_/g;
		731	$pkg = "urxvt::ext::$pkg";
576		732
577	verbose 3, "loading extension '$path' into package '$pkg'";	733	verbose 3, "loading extension '$path' into package '$pkg'";
578		734
579	open my $fh, "<:raw", $path	735	open my $fh, "<:raw", $path
580	or die "$path: $!";	736	or die "$path: $!";
581		737
582	my $source = untaint	738	my $source =
583	"package $pkg; use strict; use utf8;\n"	739	"package $pkg; use strict; use utf8;\n"
584	. "use base urxvt::term::extension::;\n"
585	. "#line 1 \"$path\"\n{\n"	740	. "#line 1 \"$path\"\n{\n"
586	. (do { local $/; <$fh> })	741	. (do { local $/; <$fh> })
587	. "\n};\n1";	742	. "\n};\n1";
588		743
589	eval $source	744	eval $source
…		…
603	if ($htype == 0) { # INIT	758	if ($htype == 0) { # INIT
604	my @dirs = ((split /:/, $TERM->resource ("perl_lib")), "$LIBDIR/perl");	759	my @dirs = ((split /:/, $TERM->resource ("perl_lib")), "$LIBDIR/perl");
605		760
606	my %ext_arg;	761	my %ext_arg;
607		762
		763	{
		764	my @init = @TERM_INIT;
		765	@TERM_INIT = ();
		766	$_->($TERM) for @init;
		767	my @pkg = @TERM_EXT;
		768	@TERM_EXT = ();
		769	$TERM->register_package ($_) for @pkg;
		770	}
		771
608	for (map { split /,/, $TERM->resource ("perl_ext_$_") } 1, 2) {	772	for (grep $_, map { split /,/, $TERM->resource ("perl_ext_$_") } 1, 2) {
609	if ($_ eq "default") {	773	if ($_ eq "default") {
610	$ext_arg{$_} \|\|= [] for qw(selection option-popup selection-popup searchable-scrollback);	774	$ext_arg{$_} \|\|= [] for qw(selection option-popup selection-popup searchable-scrollback);
611	} elsif (/^-(.*)$/) {	775	} elsif (/^-(.*)$/) {
612	delete $ext_arg{$1};	776	delete $ext_arg{$1};
613	} elsif (/^([^<]+)<(.*)>$/) {	777	} elsif (/^([^<]+)<(.*)>$/) {
…		…
638	if $verbosity >= 10;	802	if $verbosity >= 10;
639		803
640	keys %$cb;	804	keys %$cb;
641		805
642	while (my ($pkg, $cb) = each %$cb) {	806	while (my ($pkg, $cb) = each %$cb) {
643	$retval = eval { $cb->($TERM->{_pkg}{$pkg}, @_) }	807	my $retval_ = eval { $cb->($TERM->{_pkg}{$pkg}, @_) };
644	and last;	808	$retval \|\|= $retval_;
645		809
646	if ($@) {	810	if ($@) {
647	$TERM->ungrab; # better to lose the grab than the session	811	$TERM->ungrab; # better to lose the grab than the session
648	warn $@;	812	warn $@;
649	}	813	}
…		…
652	verbose 11, "$HOOKNAME[$htype] returning <$retval>"	816	verbose 11, "$HOOKNAME[$htype] returning <$retval>"
653	if $verbosity >= 11;	817	if $verbosity >= 11;
654	}	818	}
655		819
656	if ($htype == 1) { # DESTROY	820	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	821	# clear package objects
665	%$_ = () for values %{ $TERM->{_pkg} };	822	%$_ = () for values %{ $TERM->{_pkg} };
666		823
667	# clear package	824	# clear package
668	%$TERM = ();	825	%$TERM = ();
669	}	826	}
670		827
671	$retval	828	$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	}	829	}
685		830
686	# urxvt::term::extension	831	# urxvt::term::extension
687		832
688	package urxvt::term::extension;	833	package urxvt::term::extension;
…		…
694	while (my ($name, $cb) = each %hook) {	839	while (my ($name, $cb) = each %hook) {
695	my $htype = $HOOKTYPE{uc $name};	840	my $htype = $HOOKTYPE{uc $name};
696	defined $htype	841	defined $htype
697	or Carp::croak "unsupported hook type '$name'";	842	or Carp::croak "unsupported hook type '$name'";
698		843
		844	$self->set_should_invoke ($htype, +1)
699	unless (exists $self->{term}{_hook}[$htype]{$pkg}) {	845	unless exists $self->{term}{_hook}[$htype]{$pkg};
700	$hook_count[$htype]++
701	or urxvt::set_should_invoke $htype, 1;
702	}
703		846
704	$self->{term}{_hook}[$htype]{$pkg} = $cb;	847	$self->{term}{_hook}[$htype]{$pkg} = $cb;
705	}	848	}
706	}	849	}
707		850
…		…
712	for my $name (@hook) {	855	for my $name (@hook) {
713	my $htype = $HOOKTYPE{uc $name};	856	my $htype = $HOOKTYPE{uc $name};
714	defined $htype	857	defined $htype
715	or Carp::croak "unsupported hook type '$name'";	858	or Carp::croak "unsupported hook type '$name'";
716		859
		860	$self->set_should_invoke ($htype, -1)
717	if (delete $self->{term}{_hook}[$htype]{$pkg}) {	861	if delete $self->{term}{_hook}[$htype]{$pkg};
718	--$hook_count[$htype]
719	or urxvt::set_should_invoke $htype, 0;
720	}
721	}	862	}
722	}	863	}
723		864
724	our $AUTOLOAD;	865	our $AUTOLOAD;
725		866
…		…
831	# find on_xxx subs in the package and register them	972	# find on_xxx subs in the package and register them
832	# as hooks	973	# as hooks
833	sub register_package {	974	sub register_package {
834	my ($self, $pkg, $argv) = @_;	975	my ($self, $pkg, $argv) = @_;
835		976
		977	no strict 'refs';
		978
		979	urxvt::verbose 6, "register package $pkg to $self";
		980
		981	@{"$pkg\::ISA"} = urxvt::term::extension::;
		982
836	my $proxy = bless {	983	my $proxy = bless {
837	_pkg => $pkg,	984	_pkg => $pkg,
838	argv => $argv,	985	argv => $argv,
839	}, $pkg;	986	}, $pkg;
840	Scalar::Util::weaken ($proxy->{term} = $self);	987	Scalar::Util::weaken ($proxy->{term} = $self);
…		…
871		1018
872	Destroy the terminal object (close the window, free resources	1019	Destroy the terminal object (close the window, free resources
873	etc.). Please note that @@RXVT_NAME@@ will not exit as long as any event	1020	etc.). Please note that @@RXVT_NAME@@ will not exit as long as any event
874	watchers (timers, io watchers) are still active.	1021	watchers (timers, io watchers) are still active.
875		1022
		1023	=item $term->exec_async ($cmd[, @args])
		1024
		1025	Works like the combination of the C<fork>/C<exec> builtins, which executes
		1026	("starts") programs in the background. This function takes care of setting
		1027	the user environment before exec'ing the command (e.g. C<PATH>) and should
		1028	be preferred over explicit calls to C<exec> or C<system>.
		1029
		1030	Returns the pid of the subprocess or C<undef> on error.
		1031
		1032	=cut
		1033
		1034	sub exec_async {
		1035	my $self = shift;
		1036
		1037	my $pid = fork;
		1038
		1039	return $pid
		1040	if !defined $pid or $pid;
		1041
		1042	%ENV = %{ $self->env };
		1043
		1044	exec @_;
		1045	urxvt::_exit 255;
		1046	}
		1047
876	=item $isset = $term->option ($optval[, $set])	1048	=item $isset = $term->option ($optval[, $set])
877		1049
878	Returns true if the option specified by C<$optval> is enabled, and	1050	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	1051	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.	1052	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	1054	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:	1055	source file F</src/optinc.h> to see the actual list:
884		1056
885	borderLess console cursorBlink cursorUnderline hold iconic insecure	1057	borderLess console cursorBlink cursorUnderline hold iconic insecure
886	intensityStyles jumpScroll loginShell mapAlert meta8 mouseWheelScrollPage	1058	intensityStyles jumpScroll loginShell mapAlert meta8 mouseWheelScrollPage
887	pastableTabs pointerBlank reverseVideo scrollBar scrollBar_floating	1059	override-redirect pastableTabs pointerBlank reverseVideo scrollBar
888	scrollBar_right scrollTtyKeypress scrollTtyOutput scrollWithBuffer	1060	scrollBar_floating scrollBar_right scrollTtyKeypress scrollTtyOutput
889	secondaryScreen secondaryScroll skipBuiltinGlyphs transparent	1061	scrollWithBuffer secondaryScreen secondaryScroll skipBuiltinGlyphs
890	tripleclickwords utmpInhibit visualBell	1062	transparent tripleclickwords utmpInhibit visualBell
891		1063
892	=item $value = $term->resource ($name[, $newval])	1064	=item $value = $term->resource ($name[, $newval])
893		1065
894	Returns the current resource value associated with a given name and	1066	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>	1067	optionally sets a new value. Setting values is most useful in the C<init>
…		…
912		1084
913	answerbackstring backgroundPixmap backspace_key boldFont boldItalicFont	1085	answerbackstring backgroundPixmap backspace_key boldFont boldItalicFont
914	borderLess color cursorBlink cursorUnderline cutchars delete_key	1086	borderLess color cursorBlink cursorUnderline cutchars delete_key
915	display_name embed ext_bwidth fade font geometry hold iconName	1087	display_name embed ext_bwidth fade font geometry hold iconName
916	imFont imLocale inputMethod insecure int_bwidth intensityStyles	1088	imFont imLocale inputMethod insecure int_bwidth intensityStyles
917	italicFont jumpScroll lineSpace loginShell mapAlert menu meta8 modifier	1089	italicFont jumpScroll lineSpace loginShell mapAlert meta8 modifier
918	mouseWheelScrollPage name pastableTabs path perl_eval perl_ext_1 perl_ext_2	1090	mouseWheelScrollPage name override_redirect pastableTabs path perl_eval
919	perl_lib pointerBlank pointerBlankDelay preeditType print_pipe pty_fd	1091	perl_ext_1 perl_ext_2 perl_lib pointerBlank pointerBlankDelay
920	reverseVideo saveLines scrollBar scrollBar_align scrollBar_floating	1092	preeditType print_pipe pty_fd reverseVideo saveLines scrollBar
921	scrollBar_right scrollBar_thickness scrollTtyKeypress scrollTtyOutput	1093	scrollBar_align scrollBar_floating scrollBar_right scrollBar_thickness
922	scrollWithBuffer scrollstyle secondaryScreen secondaryScroll selectstyle	1094	scrollTtyKeypress scrollTtyOutput scrollWithBuffer scrollstyle
923	shade term_name title transparent transparent_all tripleclickwords	1095	secondaryScreen secondaryScroll selectstyle shade term_name title
924	utmpInhibit visualBell	1096	transient_for transparent transparent_all tripleclickwords utmpInhibit
		1097	visualBell
925		1098
926	=cut	1099	=cut
927		1100
928	sub resource($$;$) {	1101	sub resource($$;$) {
929	my ($self, $name) = (shift, shift);	1102	my ($self, $name) = (shift, shift);
…		…
1103		1276
1104	Normally its not a good idea to use this function, as programs might be	1277	Normally its not a good idea to use this function, as programs might be
1105	confused by changes in cursor position or scrolling. Its useful inside a	1278	confused by changes in cursor position or scrolling. Its useful inside a
1106	C<on_add_lines> hook, though.	1279	C<on_add_lines> hook, though.
1107		1280
		1281	=item $term->scr_change_screen ($screen)
		1282
		1283	Switch to given screen - 0 primary, 1 secondary.
		1284
1108	=item $term->cmd_parse ($octets)	1285	=item $term->cmd_parse ($octets)
1109		1286
1110	Similar to C<scr_add_lines>, but the argument must be in the	1287	Similar to C<scr_add_lines>, but the argument must be in the
1111	locale-specific encoding of the terminal and can contain command sequences	1288	locale-specific encoding of the terminal and can contain command sequences
1112	(escape codes) that will be interpreted.	1289	(escape codes) that will be interpreted.
…		…
1130		1307
1131	=item $windowid = $term->vt	1308	=item $windowid = $term->vt
1132		1309
1133	Return the window id of the terminal window.	1310	Return the window id of the terminal window.
1134		1311
		1312	=item $term->vt_emask_add ($x_event_mask)
		1313
		1314	Adds the specified events to the vt event mask. Useful e.g. when you want
		1315	to receive pointer events all the times:
		1316
		1317	$term->vt_emask_add (urxvt::PointerMotionMask);
		1318
1135	=item $window_width = $term->width	1319	=item $window_width = $term->width
1136		1320
1137	=item $window_height = $term->height	1321	=item $window_height = $term->height
1138		1322
1139	=item $font_width = $term->fwidth	1323	=item $font_width = $term->fwidth
…		…
1152		1336
1153	=item $max_scrollback = $term->saveLines	1337	=item $max_scrollback = $term->saveLines
1154		1338
1155	=item $nrow_plus_saveLines = $term->total_rows	1339	=item $nrow_plus_saveLines = $term->total_rows
1156		1340
1157	=item $lines_in_scrollback = $term->nsaved	1341	=item $topmost_scrollback_row = $term->top_row
1158		1342
1159	Return various integers describing terminal characteristics.	1343	Return various integers describing terminal characteristics.
1160		1344
1161	=item $x_display = $term->display_id	1345	=item $x_display = $term->display_id
1162		1346
…		…
1188	=item $modifiermask = $term->ModNumLockMask	1372	=item $modifiermask = $term->ModNumLockMask
1189		1373
1190	Return the modifier masks corresponding to the "ISO Level 3 Shift" (often	1374	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.	1375	AltGr), the meta key (often Alt) and the num lock key, if applicable.
1192		1376
		1377	=item $screen = $term->current_screen
		1378
		1379	Returns the currently displayed screen (0 primary, 1 secondary).
		1380
1193	=item $view_start = $term->view_start ([$newvalue])	1381	=item $view_start = $term->view_start ([$newvalue])
1194		1382
1195	Returns the negative row number of the topmost line. Minimum value is	1383	Returns the row number of the topmost displayed line. Maximum value is
1196	C<0>, which displays the normal terminal contents. Larger values scroll	1384	C<0>, which displays the normal terminal contents. Lower values scroll
1197	this many lines into the scrollback buffer.	1385	this many lines into the scrollback buffer.
1198		1386
1199	=item $term->want_refresh	1387	=item $term->want_refresh
1200		1388
1201	Requests a screen refresh. At the next opportunity, rxvt-unicode will	1389	Requests a screen refresh. At the next opportunity, rxvt-unicode will
…		…
1215	If C<$new_text> is specified, it will replace characters in the current	1403	If C<$new_text> is specified, it will replace characters in the current
1216	line, starting at column C<$start_col> (default C<0>), which is useful	1404	line, starting at column C<$start_col> (default C<0>), which is useful
1217	to replace only parts of a line. The font index in the rendition will	1405	to replace only parts of a line. The font index in the rendition will
1218	automatically be updated.	1406	automatically be updated.
1219		1407
1220	C<$text> is in a special encoding: tabs and wide characters that use more	1408	C<$text> is in a special encoding: tabs and wide characters that use
1221	than one cell when displayed are padded with urxvt::NOCHAR characters	1409	more than one cell when displayed are padded with C<$urxvt::NOCHAR>
1222	(C<chr 65535>). Characters with combining characters and other characters	1410	characters. Characters with combining characters and other characters that
1223	that do not fit into the normal tetx encoding will be replaced with	1411	do not fit into the normal tetx encoding will be replaced with characters
1224	characters in the private use area.	1412	in the private use area.
1225		1413
1226	You have to obey this encoding when changing text. The advantage is	1414	You have to obey this encoding when changing text. The advantage is
1227	that C<substr> and similar functions work on screen cells and not on	1415	that C<substr> and similar functions work on screen cells and not on
1228	characters.	1416	characters.
1229		1417
…		…
1404		1592
1405	Calls XUngrab for the most recent grab. Is called automatically on	1593	Calls XUngrab for the most recent grab. Is called automatically on
1406	evaluation errors, as it is better to lose the grab in the error case as	1594	evaluation errors, as it is better to lose the grab in the error case as
1407	the session.	1595	the session.
1408		1596
		1597	=item $atom = $term->XInternAtom ($atom_name[, $only_if_exists])
		1598
		1599	=item $atom_name = $term->XGetAtomName ($atom)
		1600
		1601	=item @atoms = $term->XListProperties ($window)
		1602
		1603	=item ($type,$format,$octets) = $term->XGetWindowProperty ($window, $property)
		1604
		1605	=item $term->XChangeWindowProperty ($window, $property, $type, $format, $octets)
		1606
		1607	=item $term->XDeleteProperty ($window, $property)
		1608
		1609	=item $window = $term->DefaultRootWindow
		1610
		1611	=item $term->XReparentWindow ($window, $parent, [$x, $y])
		1612
		1613	=item $term->XMapWindow ($window)
		1614
		1615	=item $term->XUnmapWindow ($window)
		1616
		1617	=item $term->XMoveResizeWindow ($window, $x, $y, $width, $height)
		1618
		1619	=item ($x, $y, $child_window) = $term->XTranslateCoordinates ($src, $dst, $x, $y)
		1620
		1621	=item $term->XChangeInput ($window, $add_events[, $del_events])
		1622
		1623	Various X or X-related functions. The C<$term> object only serves as
		1624	the source of the display, otherwise those functions map more-or-less
		1625	directory onto the X functions of the same name.
		1626
1409	=back	1627	=back
1410		1628
1411	=cut	1629	=cut
1412		1630
1413	package urxvt::popup;	1631	package urxvt::popup;
…		…
1514	my $env = $self->{term}->env;	1732	my $env = $self->{term}->env;
1515	# we can't hope to reproduce the locale algorithm, so nuke LC_ALL and set LC_CTYPE.	1733	# we can't hope to reproduce the locale algorithm, so nuke LC_ALL and set LC_CTYPE.
1516	delete $env->{LC_ALL};	1734	delete $env->{LC_ALL};
1517	$env->{LC_CTYPE} = $self->{term}->locale;	1735	$env->{LC_CTYPE} = $self->{term}->locale;
1518		1736
1519	urxvt::term->new ($env, $self->{term}->resource ("name"),	1737	urxvt::term->new ($env, "popup",
1520	"--perl-lib" => "", "--perl-ext-common" => "", "-pty-fd" => -1, "-sl" => 0, "-b" => 0,	1738	"--perl-lib" => "", "--perl-ext-common" => "",
		1739	"-pty-fd" => -1, "-sl" => 0,
		1740	"-b" => 1, "-bd" => "grey80", "-bl", "-override-redirect",
1521	"--transient-for" => $self->{term}->parent,	1741	"--transient-for" => $self->{term}->parent,
1522	"-display" => $self->{term}->display_id,	1742	"-display" => $self->{term}->display_id,
1523	"-pe" => "urxvt-popup")	1743	"-pe" => "urxvt-popup")
1524	or die "unable to create popup window\n";	1744	or die "unable to create popup window\n";
1525	}	1745	}
…		…
1530	delete $self->{term}{_destroy}{$self};	1750	delete $self->{term}{_destroy}{$self};
1531	$self->{term}->ungrab;	1751	$self->{term}->ungrab;
1532	}	1752	}
1533		1753
1534	=back	1754	=back
		1755
		1756	=cut
		1757
		1758	package urxvt::watcher;
		1759
		1760	@urxvt::timer::ISA = __PACKAGE__;
		1761	@urxvt::iow::ISA = __PACKAGE__;
		1762	@urxvt::pw::ISA = __PACKAGE__;
		1763	@urxvt::iw::ISA = __PACKAGE__;
1535		1764
1536	=head2 The C<urxvt::timer> Class	1765	=head2 The C<urxvt::timer> Class
1537		1766
1538	This class implements timer watchers/events. Time is represented as a	1767	This class implements timer watchers/events. Time is represented as a
1539	fractional number of seconds since the epoch. Example:	1768	fractional number of seconds since the epoch. Example:
…		…
1577	Start the timer.	1806	Start the timer.
1578		1807
1579	=item $timer = $timer->start ($tstamp)	1808	=item $timer = $timer->start ($tstamp)
1580		1809
1581	Set the event trigger time to C<$tstamp> and start the timer.	1810	Set the event trigger time to C<$tstamp> and start the timer.
		1811
		1812	=item $timer = $timer->after ($delay)
		1813
		1814	Like C<start>, but sets the expiry timer to c<urxvt::NOW + $delay>.
1582		1815
1583	=item $timer = $timer->stop	1816	=item $timer = $timer->stop
1584		1817
1585	Stop the timer.	1818	Stop the timer.
1586		1819
…		…
1633		1866
1634	Stop watching for events on the given filehandle.	1867	Stop watching for events on the given filehandle.
1635		1868
1636	=back	1869	=back
1637		1870
		1871	=head2 The C<urxvt::iw> Class
		1872
		1873	This class implements idle watchers, that get called automatically when
		1874	the process is idle. They should return as fast as possible, after doing
		1875	some useful work.
		1876
		1877	=over 4
		1878
		1879	=item $iw = new urxvt::iw
		1880
		1881	Create a new idle watcher object in stopped state.
		1882
		1883	=item $iw = $iw->cb (sub { my ($iw) = @_; ... })
		1884
		1885	Set the callback to be called when the watcher triggers.
		1886
		1887	=item $timer = $timer->start
		1888
		1889	Start the watcher.
		1890
		1891	=item $timer = $timer->stop
		1892
		1893	Stop the watcher.
		1894
		1895	=back
		1896
		1897	=head2 The C<urxvt::pw> Class
		1898
		1899	This class implements process watchers. They create an event whenever a
		1900	process exits, after which they stop automatically.
		1901
		1902	my $pid = fork;
		1903	...
		1904	$term->{pw} = urxvt::pw
		1905	->new
		1906	->start ($pid)
		1907	->cb (sub {
		1908	my ($pw, $exit_status) = @_;
		1909	...
		1910	});
		1911
		1912	=over 4
		1913
		1914	=item $pw = new urxvt::pw
		1915
		1916	Create a new process watcher in stopped state.
		1917
		1918	=item $pw = $pw->cb (sub { my ($pw, $exit_status) = @_; ... })
		1919
		1920	Set the callback to be called when the timer triggers.
		1921
		1922	=item $pw = $timer->start ($pid)
		1923
		1924	Tells the wqtcher to start watching for process C<$pid>.
		1925
		1926	=item $pw = $pw->stop
		1927
		1928	Stop the watcher.
		1929
		1930	=back
		1931
1638	=head1 ENVIRONMENT	1932	=head1 ENVIRONMENT
1639		1933
1640	=head2 URXVT_PERL_VERBOSITY	1934	=head2 URXVT_PERL_VERBOSITY
1641		1935
1642	This variable controls the verbosity level of the perl extension. Higher	1936	This variable controls the verbosity level of the perl extension. Higher

Diff Legend

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

Comparing rxvt-unicode/src/urxvt.pm (file contents): Revision 1.88 by root, Thu Jan 12 12:05:28 2006 UTC vs. Revision 1.121 by root, Fri Jan 20 22:49:34 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.121 by root, Fri Jan 20 22:49:34 2006 UTC