[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.125 by root, Sun Jan 22 20:39:47 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
…		…
104	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
105	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
106	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
107	selection.	130	selection.
108		131
		132	=item readline (enabled by default)
		133
		134	A support package that tries to make editing with readline easier. At the
		135	moment, it reacts to clicking with the left mouse button by trying to
		136	move the text cursor to this position. It does so by generating as many
		137	cursor-left or cursor-right keypresses as required (the this only works
		138	for programs that correctly support wide characters).
		139
		140	To avoid too many false positives, this is only done when:
		141
		142	=over 4
		143
		144	=item - the tty is in ICANON state.
		145
		146	=item - the text cursor is visible.
		147
		148	=item - the primary screen is currently being displayed.
		149
		150	=item - the mouse is on the same (multi-row-) line as the text cursor.
		151
		152	=back
		153
		154	The normal selection mechanism isn't disabled, so quick successive clicks
		155	might interfere with selection creation in harmless ways.
		156
109	=item selection-autotransform	157	=item selection-autotransform
110		158
111	This selection allows you to do automatic transforms on a selection	159	This selection allows you to do automatic transforms on a selection
112	whenever a selection is made.	160	whenever a selection is made.
113		161
…		…
117	URxvt.selection-autotransform.0: transform	165	URxvt.selection-autotransform.0: transform
118	URxvt.selection-autotransform.1: transform	166	URxvt.selection-autotransform.1: transform
119	...	167	...
120		168
121	For example, the following will transform selections of the form	169	For example, the following will transform selections of the form
122	C<word:number> into C<vi +$number $word>:	170	C<filename:number>, often seen in compiler messages, into C<vi +$filename
		171	$word>:
123		172
124	URxvt.selection-autotransform.0: s/^(S+):(d+):?$/vi +$2 $1\\x0d/	173	URxvt.selection-autotransform.0: s/^([^:[:space:]]+):(\\d+):?$/vi +$2 \\Q$1\\E\\x0d/
125		174
126	And this example matches the same,but replaces it with vi-commands you can	175	And this example matches the same,but replaces it with vi-commands you can
127	paste directory into your (vi :) editor:	176	paste directly into your (vi :) editor:
128		177
129	URxvt.selection-autotransform.0: s/^(S+):(d+):?$/\\x1b:e $1\\x0d:$2\\x0d/	178	URxvt.selection-autotransform.0: s/^([^:[:space:]]+(\\d+):?$/:e \\Q$1\\E\\x0d:$2\\x0d/
		179
		180	Of course, this can be modified to suit your needs and your editor :)
		181
		182	To expand the example above to typical perl error messages ("XXX at
		183	FILENAME line YYY."), you need a slightly more elaborate solution:
		184
		185	URxvt.selection.pattern-0: ( at .*? line \\d+[,.])
		186	URxvt.selection-autotransform.0: s/^ at (.*?) line (\\d+)[,.]$/:e \\Q$1\E\\x0d:$2\\x0d/
		187
		188	The first line tells the selection code to treat the unchanging part of
		189	every error message as a selection pattern, and the second line transforms
		190	the message into vi commands to load the file.
		191
		192	=item tabbed
		193
		194	This transforms the terminal into a tabbar with additional terminals, that
		195	is, it implements what is commonly refered to as "tabbed terminal". The topmost line
		196	displays a "[NEW]" button, which, when clicked, will add a new tab, followed by one
		197	button per tab.
		198
		199	Clicking a button will activate that tab. Pressing B<Shift-Left> and
		200	B<Shift-Right> will switch to the tab left or right of the current one,
		201	while B<Shift-Down> creates a new tab.
130		202
131	=item mark-urls	203	=item mark-urls
132		204
133	Uses per-line display filtering (C<on_line_update>) to underline urls and	205	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	206	make them clickable. When middle-clicked, the program specified in the
135	resource C<urlLauncher> (default C<x-www-browser>) will be started with	207	resource C<urlLauncher> (default C<x-www-browser>) will be started with
136	the URL as first argument.	208	the URL as first argument.
137		209
		210	=item automove-background
		211
		212	This is basically a one-line extension that dynamically changes the background pixmap offset
		213	to the window position, in effect creating the same effect as pseudo transparency with
		214	a custom pixmap. No scaling is supported in this mode. Exmaple:
		215
		216	@@RXVT_NAME@@ -pixmap background.xpm -pe automove-background
		217
138	=item block-graphics-to-ascii	218	=item block-graphics-to-ascii
139		219
140	A not very useful example of filtering all text output to the terminal,	220	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	221	by replacing all line-drawing characters (U+2500 .. U+259F) by a
142	similar-looking ascii character.	222	similar-looking ascii character.
…		…
148	=item example-refresh-hooks	228	=item example-refresh-hooks
149		229
150	Displays a very simple digital clock in the upper right corner of the	230	Displays a very simple digital clock in the upper right corner of the
151	window. Illustrates overwriting the refresh callbacks to create your own	231	window. Illustrates overwriting the refresh callbacks to create your own
152	overlays or changes.	232	overlays or changes.
		233
		234	=item selection-pastebin
		235
		236	This is a little rarely useful extension that Uploads the selection as
		237	textfile to a remote site (or does other things). (The implementation is
		238	not currently secure for use in a multiuser environment as it writes to
		239	F</tmp> directly.).
		240
		241	It listens to the C<selection-pastebin:remote-pastebin> keyboard command,
		242	i.e.
		243
		244	URxvt.keysym.C-M-e: perl:selection-pastebin:remote-pastebin
		245
		246	Pressing this combination runs a command with C<%> replaced by the name of
		247	the textfile. This command can be set via a resource:
		248
		249	URxvt.selection-pastebin.cmd: rsync -apP % ruth:/var/www/www.ta-sa.org/files/txt/.
		250
		251	And the default is likely not useful to anybody but the few people around
		252	here :)
		253
		254	The name of the textfile is the hex encoded md5 sum of the selection, so
		255	the same content should lead to the same filename.
		256
		257	After a successful upload the selection will be replaced by the text given
		258	in the C<selection-pastebin-url> resource (again, the % is the placeholder
		259	for the filename):
		260
		261	URxvt.selection-pastebin.url: http://www.ta-sa.org/files/txt/%
153		262
154	=back	263	=back
155		264
156	=head1 API DOCUMENTATION	265	=head1 API DOCUMENTATION
157		266
…		…
230	called whenever the relevant event happens.	339	called whenever the relevant event happens.
231		340
232	The first argument passed to them is an extension oject as described in	341	The first argument passed to them is an extension oject as described in
233	the in the C<Extension Objects> section.	342	the in the C<Extension Objects> section.
234		343
235	B<All> of these hooks must return a boolean value. If it is true, then the	344	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	345	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.	346	relevant action might not be carried out by the C++ code.
238		347
239	I<< When in doubt, return a false value (preferably C<()>). >>	348	I<< When in doubt, return a false value (preferably C<()>). >>
240		349
241	=over 4	350	=over 4
242		351
243	=item on_init $term	352	=item on_init $term
244		353
245	Called after a new terminal object has been initialized, but before	354	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	355	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	356	call or deliver senseless data, as terminal size and other characteristics
248	have not yet been determined. You can safely query and change resources,	357	have not yet been determined. You can safely query and change resources
249	though.	358	and options, though. For many purposes the C<on_start> hook is a better
		359	place.
		360
		361	=item on_start $term
		362
		363	Called at the very end of initialisation of a new terminal, just before
		364	trying to map (display) the toplevel and returning to the mainloop.
		365
		366	=item on_destroy $term
		367
		368	Called whenever something tries to destroy terminal, before doing anything
		369	yet. If this hook returns true, then destruction is skipped, but this is
		370	rarely a good idea.
250		371
251	=item on_reset $term	372	=item on_reset $term
252		373
253	Called after the screen is "reset" for any reason, such as resizing or	374	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	375	control sequences. Here is where you can react on changes to size-related
255	variables.	376	variables.
256		377
257	=item on_start $term	378	=item on_child_start $term, $pid
258		379
259	Called at the very end of initialisation of a new terminal, just before	380	Called just after the child process has been C<fork>ed.
260	returning to the mainloop.	381
		382	=item on_child_exit $term, $status
		383
		384	Called just after the child process has exited. C<$status> is the status
		385	from C<waitpid>.
261		386
262	=item on_sel_make $term, $eventtime	387	=item on_sel_make $term, $eventtime
263		388
264	Called whenever a selection has been made by the user, but before the	389	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	390	selection text is copied, so changes to the beginning, end or type of the
…		…
358		483
359	Called whenever the user presses a key combination that has a	484	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>	485	C<perl:string> action bound to it (see description of the B<keysym>
361	resource in the @@RXVT_NAME@@(1) manpage).	486	resource in the @@RXVT_NAME@@(1) manpage).
362		487
		488	=item on_x_event $term, $event
		489
		490	Called on every X event received on the vt window (and possibly other
		491	windows). Should only be used as a last resort. Most event structure
		492	members are not passed.
		493
363	=item on_focus_in $term	494	=item on_focus_in $term
364		495
365	Called whenever the window gets the keyboard focus, before rxvt-unicode	496	Called whenever the window gets the keyboard focus, before rxvt-unicode
366	does focus in processing.	497	does focus in processing.
367		498
368	=item on_focus_out $term	499	=item on_focus_out $term
369		500
370	Called wheneever the window loses keyboard focus, before rxvt-unicode does	501	Called wheneever the window loses keyboard focus, before rxvt-unicode does
371	focus out processing.	502	focus out processing.
372		503
		504	=item on_configure_notify $term, $event
		505
		506	=item on_property_notify $term, $event
		507
373	=item on_key_press $term, $event, $keysym, $octets	508	=item on_key_press $term, $event, $keysym, $octets
374		509
375	=item on_key_release $term, $event, $keysym	510	=item on_key_release $term, $event, $keysym
376		511
377	=item on_button_press $term, $event	512	=item on_button_press $term, $event
…		…
386		521
387	Called whenever the corresponding X event is received for the terminal If	522	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.	523	the hook returns true, then the even will be ignored by rxvt-unicode.
389		524
390	The event is a hash with most values as named by Xlib (see the XEvent	525	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	526	manpage), with the additional members C<row> and C<col>, which are the
392	and column under the mouse cursor.	527	(real, not screen-based) row and column under the mouse cursor.
393		528
394	C<on_key_press> additionally receives the string rxvt-unicode would	529	C<on_key_press> additionally receives the string rxvt-unicode would
395	output, if any, in locale-specific encoding.	530	output, if any, in locale-specific encoding.
396		531
397	subwindow.	532	subwindow.
		533
		534	=item on_client_message $term, $event
		535
		536	=item on_wm_protocols $term, $event
		537
		538	=item on_wm_delete_window $term, $event
		539
		540	Called when various types of ClientMessage events are received (all with
		541	format=32, WM_PROTOCOLS or WM_PROTOCOLS:WM_DELETE_WINDOW).
398		542
399	=back	543	=back
400		544
401	=cut	545	=cut
402		546
…		…
408	use Scalar::Util ();	552	use Scalar::Util ();
409	use List::Util ();	553	use List::Util ();
410		554
411	our $VERSION = 1;	555	our $VERSION = 1;
412	our $TERM;	556	our $TERM;
		557	our @TERM_INIT;
		558	our @TERM_EXT;
413	our @HOOKNAME;	559	our @HOOKNAME;
414	our %HOOKTYPE = map +($HOOKNAME[$_] => $_), 0..$#HOOKNAME;	560	our %HOOKTYPE = map +($HOOKNAME[$_] => $_), 0..$#HOOKNAME;
415	our %OPTION;	561	our %OPTION;
416		562
417	our $LIBDIR;	563	our $LIBDIR;
418	our $RESNAME;	564	our $RESNAME;
419	our $RESCLASS;	565	our $RESCLASS;
420	our $RXVTNAME;	566	our $RXVTNAME;
421		567
		568	our $NOCHAR = chr 0xffff;
		569
422	=head2 Variables in the C<urxvt> Package	570	=head2 Variables in the C<urxvt> Package
423		571
424	=over 4	572	=over 4
425		573
426	=item $urxvt::LIBDIR	574	=item $urxvt::LIBDIR
…		…
438		586
439	=item $urxvt::TERM	587	=item $urxvt::TERM
440		588
441	The current terminal. This variable stores the current C<urxvt::term>	589	The current terminal. This variable stores the current C<urxvt::term>
442	object, whenever a callback/hook is executing.	590	object, whenever a callback/hook is executing.
		591
		592	=item @urxvt::TERM_INIT
		593
		594	All coderefs in this array will be called as methods of the next newly
		595	created C<urxvt::term> object (during the C<on_init> phase). The array
		596	gets cleared before the codereferences that were in it are being executed,
		597	so coderefs can push themselves onto it again if they so desire.
		598
		599	This complements to the perl-eval commandline option, but gets executed
		600	first.
		601
		602	=item @urxvt::TERM_EXT
		603
		604	Works similar to C<@TERM_INIT>, but contains perl package/class names, which
		605	get registered as normal extensions after calling the hooks in C<@TERM_INIT>
		606	but before other extensions. Gets cleared just like C<@TERM_INIT>.
443		607
444	=back	608	=back
445		609
446	=head2 Functions in the C<urxvt> Package	610	=head2 Functions in the C<urxvt> Package
447		611
…		…
462	Using this function has the advantage that its output ends up in the	626	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.	627	correct place, e.g. on stderr of the connecting urxvtc client.
464		628
465	Messages have a size limit of 1023 bytes currently.	629	Messages have a size limit of 1023 bytes currently.
466		630
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	631	=item $time = urxvt::NOW
474		632
475	Returns the "current time" (as per the event loop).	633	Returns the "current time" (as per the event loop).
476		634
477	=item urxvt::CurrentTime	635	=item urxvt::CurrentTime
478		636
479	=item urxvt::ShiftMask, LockMask, ControlMask, Mod1Mask, Mod2Mask,	637	=item urxvt::ShiftMask, LockMask, ControlMask, Mod1Mask, Mod2Mask,
480	Mod3Mask, Mod4Mask, Mod5Mask, Button1Mask, Button2Mask, Button3Mask,	638	Mod3Mask, Mod4Mask, Mod5Mask, Button1Mask, Button2Mask, Button3Mask,
481	Button4Mask, Button5Mask, AnyModifier	639	Button4Mask, Button5Mask, AnyModifier
		640
		641	=item urxvt::NoEventMask, KeyPressMask, KeyReleaseMask,
		642	ButtonPressMask, ButtonReleaseMask, EnterWindowMask, LeaveWindowMask,
		643	PointerMotionMask, PointerMotionHintMask, Button1MotionMask, Button2MotionMask,
		644	Button3MotionMask, Button4MotionMask, Button5MotionMask, ButtonMotionMask,
		645	KeymapStateMask, ExposureMask, VisibilityChangeMask, StructureNotifyMask,
		646	ResizeRedirectMask, SubstructureNotifyMask, SubstructureRedirectMask,
		647	FocusChangeMask, PropertyChangeMask, ColormapChangeMask, OwnerGrabButtonMask
		648
		649	=item urxvt::KeyPress, KeyRelease, ButtonPress, ButtonRelease, MotionNotify,
		650	EnterNotify, LeaveNotify, FocusIn, FocusOut, KeymapNotify, Expose,
		651	GraphicsExpose, NoExpose, VisibilityNotify, CreateNotify, DestroyNotify,
		652	UnmapNotify, MapNotify, MapRequest, ReparentNotify, ConfigureNotify,
		653	ConfigureRequest, GravityNotify, ResizeRequest, CirculateNotify,
		654	CirculateRequest, PropertyNotify, SelectionClear, SelectionRequest,
		655	SelectionNotify, ColormapNotify, ClientMessage, MappingNotify
482		656
483	Various constants for use in X calls and event processing.	657	Various constants for use in X calls and event processing.
484		658
485	=back	659	=back
486		660
…		…
537	=back	711	=back
538		712
539	=cut	713	=cut
540		714
541	BEGIN {	715	BEGIN {
542	urxvt->bootstrap;
543
544	# overwrite perl's warn	716	# overwrite perl's warn
545	*CORE::GLOBAL::warn = sub {	717	*CORE::GLOBAL::warn = sub {
546	my $msg = join "", @_;	718	my $msg = join "", @_;
547	$msg .= "\n"	719	$msg .= "\n"
548	unless $msg =~ /\n$/;	720	unless $msg =~ /\n$/;
549	urxvt::warn ($msg);	721	urxvt::warn ($msg);
550	};	722	};
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	}	723	}
558		724
559	my @hook_count;	725	no warnings 'utf8';
		726
560	my $verbosity = $ENV{URXVT_PERL_VERBOSITY};	727	my $verbosity = $ENV{URXVT_PERL_VERBOSITY};
561		728
562	sub verbose {	729	sub verbose {
563	my ($level, $msg) = @_;	730	my ($level, $msg) = @_;
564	warn "$msg\n" if $level <= $verbosity;	731	warn "$msg\n" if $level <= $verbosity;
565	}	732	}
566		733
567	my $extension_pkg = "extension0000";
568	my %extension_pkg;	734	my %extension_pkg;
569		735
570	# load a single script into its own package, once only	736	# load a single script into its own package, once only
571	sub extension_package($) {	737	sub extension_package($) {
572	my ($path) = @_;	738	my ($path) = @_;
573		739
574	$extension_pkg{$path} \|\|= do {	740	$extension_pkg{$path} \|\|= do {
575	my $pkg = "urxvt::" . ($extension_pkg++);	741	$path =~ /([^\/\\]+)$/;
		742	my $pkg = $1;
		743	$pkg =~ s/[^[:word:]]/_/g;
		744	$pkg = "urxvt::ext::$pkg";
576		745
577	verbose 3, "loading extension '$path' into package '$pkg'";	746	verbose 3, "loading extension '$path' into package '$pkg'";
578		747
579	open my $fh, "<:raw", $path	748	open my $fh, "<:raw", $path
580	or die "$path: $!";	749	or die "$path: $!";
581		750
582	my $source = untaint	751	my $source =
583	"package $pkg; use strict; use utf8;\n"	752	"package $pkg; use strict; use utf8; no warnings 'utf8';\n"
584	. "use base urxvt::term::extension::;\n"
585	. "#line 1 \"$path\"\n{\n"	753	. "#line 1 \"$path\"\n{\n"
586	. (do { local $/; <$fh> })	754	. (do { local $/; <$fh> })
587	. "\n};\n1";	755	. "\n};\n1";
588		756
589	eval $source	757	eval $source
…		…
603	if ($htype == 0) { # INIT	771	if ($htype == 0) { # INIT
604	my @dirs = ((split /:/, $TERM->resource ("perl_lib")), "$LIBDIR/perl");	772	my @dirs = ((split /:/, $TERM->resource ("perl_lib")), "$LIBDIR/perl");
605		773
606	my %ext_arg;	774	my %ext_arg;
607		775
		776	{
		777	my @init = @TERM_INIT;
		778	@TERM_INIT = ();
		779	$_->($TERM) for @init;
		780	my @pkg = @TERM_EXT;
		781	@TERM_EXT = ();
		782	$TERM->register_package ($_) for @pkg;
		783	}
		784
608	for (map { split /,/, $TERM->resource ("perl_ext_$_") } 1, 2) {	785	for (grep $_, map { split /,/, $TERM->resource ("perl_ext_$_") } 1, 2) {
609	if ($_ eq "default") {	786	if ($_ eq "default") {
610	$ext_arg{$_} \|\|= [] for qw(selection option-popup selection-popup searchable-scrollback);	787	$ext_arg{$_} \|\|= [] for qw(selection option-popup selection-popup searchable-scrollback readline);
611	} elsif (/^-(.*)$/) {	788	} elsif (/^-(.*)$/) {
612	delete $ext_arg{$1};	789	delete $ext_arg{$1};
613	} elsif (/^([^<]+)<(.*)>$/) {	790	} elsif (/^([^<]+)<(.*)>$/) {
614	push @{ $ext_arg{$1} }, $2;	791	push @{ $ext_arg{$1} }, $2;
615	} else {	792	} else {
…		…
638	if $verbosity >= 10;	815	if $verbosity >= 10;
639		816
640	keys %$cb;	817	keys %$cb;
641		818
642	while (my ($pkg, $cb) = each %$cb) {	819	while (my ($pkg, $cb) = each %$cb) {
643	$retval = eval { $cb->($TERM->{_pkg}{$pkg}, @_) }	820	my $retval_ = eval { $cb->($TERM->{_pkg}{$pkg}, @_) };
644	and last;	821	$retval \|\|= $retval_;
645		822
646	if ($@) {	823	if ($@) {
647	$TERM->ungrab; # better to lose the grab than the session	824	$TERM->ungrab; # better to lose the grab than the session
648	warn $@;	825	warn $@;
649	}	826	}
…		…
652	verbose 11, "$HOOKNAME[$htype] returning <$retval>"	829	verbose 11, "$HOOKNAME[$htype] returning <$retval>"
653	if $verbosity >= 11;	830	if $verbosity >= 11;
654	}	831	}
655		832
656	if ($htype == 1) { # DESTROY	833	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	834	# clear package objects
665	%$_ = () for values %{ $TERM->{_pkg} };	835	%$_ = () for values %{ $TERM->{_pkg} };
666		836
667	# clear package	837	# clear package
668	%$TERM = ();	838	%$TERM = ();
669	}	839	}
670		840
671	$retval	841	$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	}	842	}
685		843
686	# urxvt::term::extension	844	# urxvt::term::extension
687		845
688	package urxvt::term::extension;	846	package urxvt::term::extension;
…		…
694	while (my ($name, $cb) = each %hook) {	852	while (my ($name, $cb) = each %hook) {
695	my $htype = $HOOKTYPE{uc $name};	853	my $htype = $HOOKTYPE{uc $name};
696	defined $htype	854	defined $htype
697	or Carp::croak "unsupported hook type '$name'";	855	or Carp::croak "unsupported hook type '$name'";
698		856
		857	$self->set_should_invoke ($htype, +1)
699	unless (exists $self->{term}{_hook}[$htype]{$pkg}) {	858	unless exists $self->{term}{_hook}[$htype]{$pkg};
700	$hook_count[$htype]++
701	or urxvt::set_should_invoke $htype, 1;
702	}
703		859
704	$self->{term}{_hook}[$htype]{$pkg} = $cb;	860	$self->{term}{_hook}[$htype]{$pkg} = $cb;
705	}	861	}
706	}	862	}
707		863
…		…
712	for my $name (@hook) {	868	for my $name (@hook) {
713	my $htype = $HOOKTYPE{uc $name};	869	my $htype = $HOOKTYPE{uc $name};
714	defined $htype	870	defined $htype
715	or Carp::croak "unsupported hook type '$name'";	871	or Carp::croak "unsupported hook type '$name'";
716		872
		873	$self->set_should_invoke ($htype, -1)
717	if (delete $self->{term}{_hook}[$htype]{$pkg}) {	874	if delete $self->{term}{_hook}[$htype]{$pkg};
718	--$hook_count[$htype]
719	or urxvt::set_should_invoke $htype, 0;
720	}
721	}	875	}
722	}	876	}
723		877
724	our $AUTOLOAD;	878	our $AUTOLOAD;
725		879
…		…
831	# find on_xxx subs in the package and register them	985	# find on_xxx subs in the package and register them
832	# as hooks	986	# as hooks
833	sub register_package {	987	sub register_package {
834	my ($self, $pkg, $argv) = @_;	988	my ($self, $pkg, $argv) = @_;
835		989
		990	no strict 'refs';
		991
		992	urxvt::verbose 6, "register package $pkg to $self";
		993
		994	@{"$pkg\::ISA"} = urxvt::term::extension::;
		995
836	my $proxy = bless {	996	my $proxy = bless {
837	_pkg => $pkg,	997	_pkg => $pkg,
838	argv => $argv,	998	argv => $argv,
839	}, $pkg;	999	}, $pkg;
840	Scalar::Util::weaken ($proxy->{term} = $self);	1000	Scalar::Util::weaken ($proxy->{term} = $self);
…		…
871		1031
872	Destroy the terminal object (close the window, free resources	1032	Destroy the terminal object (close the window, free resources
873	etc.). Please note that @@RXVT_NAME@@ will not exit as long as any event	1033	etc.). Please note that @@RXVT_NAME@@ will not exit as long as any event
874	watchers (timers, io watchers) are still active.	1034	watchers (timers, io watchers) are still active.
875		1035
		1036	=item $term->exec_async ($cmd[, @args])
		1037
		1038	Works like the combination of the C<fork>/C<exec> builtins, which executes
		1039	("starts") programs in the background. This function takes care of setting
		1040	the user environment before exec'ing the command (e.g. C<PATH>) and should
		1041	be preferred over explicit calls to C<exec> or C<system>.
		1042
		1043	Returns the pid of the subprocess or C<undef> on error.
		1044
		1045	=cut
		1046
		1047	sub exec_async {
		1048	my $self = shift;
		1049
		1050	my $pid = fork;
		1051
		1052	return $pid
		1053	if !defined $pid or $pid;
		1054
		1055	%ENV = %{ $self->env };
		1056
		1057	exec @_;
		1058	urxvt::_exit 255;
		1059	}
		1060
876	=item $isset = $term->option ($optval[, $set])	1061	=item $isset = $term->option ($optval[, $set])
877		1062
878	Returns true if the option specified by C<$optval> is enabled, and	1063	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	1064	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.	1065	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	1067	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:	1068	source file F</src/optinc.h> to see the actual list:
884		1069
885	borderLess console cursorBlink cursorUnderline hold iconic insecure	1070	borderLess console cursorBlink cursorUnderline hold iconic insecure
886	intensityStyles jumpScroll loginShell mapAlert meta8 mouseWheelScrollPage	1071	intensityStyles jumpScroll loginShell mapAlert meta8 mouseWheelScrollPage
887	pastableTabs pointerBlank reverseVideo scrollBar scrollBar_floating	1072	override-redirect pastableTabs pointerBlank reverseVideo scrollBar
888	scrollBar_right scrollTtyKeypress scrollTtyOutput scrollWithBuffer	1073	scrollBar_floating scrollBar_right scrollTtyKeypress scrollTtyOutput
889	secondaryScreen secondaryScroll skipBuiltinGlyphs transparent	1074	scrollWithBuffer secondaryScreen secondaryScroll skipBuiltinGlyphs
890	tripleclickwords utmpInhibit visualBell	1075	transparent tripleclickwords utmpInhibit visualBell
891		1076
892	=item $value = $term->resource ($name[, $newval])	1077	=item $value = $term->resource ($name[, $newval])
893		1078
894	Returns the current resource value associated with a given name and	1079	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>	1080	optionally sets a new value. Setting values is most useful in the C<init>
…		…
912		1097
913	answerbackstring backgroundPixmap backspace_key boldFont boldItalicFont	1098	answerbackstring backgroundPixmap backspace_key boldFont boldItalicFont
914	borderLess color cursorBlink cursorUnderline cutchars delete_key	1099	borderLess color cursorBlink cursorUnderline cutchars delete_key
915	display_name embed ext_bwidth fade font geometry hold iconName	1100	display_name embed ext_bwidth fade font geometry hold iconName
916	imFont imLocale inputMethod insecure int_bwidth intensityStyles	1101	imFont imLocale inputMethod insecure int_bwidth intensityStyles
917	italicFont jumpScroll lineSpace loginShell mapAlert menu meta8 modifier	1102	italicFont jumpScroll lineSpace loginShell mapAlert meta8 modifier
918	mouseWheelScrollPage name pastableTabs path perl_eval perl_ext_1 perl_ext_2	1103	mouseWheelScrollPage name override_redirect pastableTabs path perl_eval
919	perl_lib pointerBlank pointerBlankDelay preeditType print_pipe pty_fd	1104	perl_ext_1 perl_ext_2 perl_lib pointerBlank pointerBlankDelay
920	reverseVideo saveLines scrollBar scrollBar_align scrollBar_floating	1105	preeditType print_pipe pty_fd reverseVideo saveLines scrollBar
921	scrollBar_right scrollBar_thickness scrollTtyKeypress scrollTtyOutput	1106	scrollBar_align scrollBar_floating scrollBar_right scrollBar_thickness
922	scrollWithBuffer scrollstyle secondaryScreen secondaryScroll selectstyle	1107	scrollTtyKeypress scrollTtyOutput scrollWithBuffer scrollstyle
923	shade term_name title transparent transparent_all tripleclickwords	1108	secondaryScreen secondaryScroll selectstyle shade term_name title
924	utmpInhibit visualBell	1109	transient_for transparent transparent_all tripleclickwords utmpInhibit
		1110	visualBell
925		1111
926	=cut	1112	=cut
927		1113
928	sub resource($$;$) {	1114	sub resource($$;$) {
929	my ($self, $name) = (shift, shift);	1115	my ($self, $name) = (shift, shift);
…		…
1103		1289
1104	Normally its not a good idea to use this function, as programs might be	1290	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	1291	confused by changes in cursor position or scrolling. Its useful inside a
1106	C<on_add_lines> hook, though.	1292	C<on_add_lines> hook, though.
1107		1293
		1294	=item $term->scr_change_screen ($screen)
		1295
		1296	Switch to given screen - 0 primary, 1 secondary.
		1297
1108	=item $term->cmd_parse ($octets)	1298	=item $term->cmd_parse ($octets)
1109		1299
1110	Similar to C<scr_add_lines>, but the argument must be in the	1300	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	1301	locale-specific encoding of the terminal and can contain command sequences
1112	(escape codes) that will be interpreted.	1302	(escape codes) that will be interpreted.
…		…
1122	Replaces the event mask of the pty watcher by the given event mask. Can	1312	Replaces the event mask of the pty watcher by the given event mask. Can
1123	be used to suppress input and output handling to the pty/tty. See the	1313	be used to suppress input and output handling to the pty/tty. See the
1124	description of C<< urxvt::timer->events >>. Make sure to always restore	1314	description of C<< urxvt::timer->events >>. Make sure to always restore
1125	the previous value.	1315	the previous value.
1126		1316
		1317	=item $fd = $term->pty_fd
		1318
		1319	Returns the master file descriptor for the pty in use, or C<-1> if no pty
		1320	is used.
		1321
1127	=item $windowid = $term->parent	1322	=item $windowid = $term->parent
1128		1323
1129	Return the window id of the toplevel window.	1324	Return the window id of the toplevel window.
1130		1325
1131	=item $windowid = $term->vt	1326	=item $windowid = $term->vt
1132		1327
1133	Return the window id of the terminal window.	1328	Return the window id of the terminal window.
1134		1329
		1330	=item $term->vt_emask_add ($x_event_mask)
		1331
		1332	Adds the specified events to the vt event mask. Useful e.g. when you want
		1333	to receive pointer events all the times:
		1334
		1335	$term->vt_emask_add (urxvt::PointerMotionMask);
		1336
1135	=item $window_width = $term->width	1337	=item $window_width = $term->width
1136		1338
1137	=item $window_height = $term->height	1339	=item $window_height = $term->height
1138		1340
1139	=item $font_width = $term->fwidth	1341	=item $font_width = $term->fwidth
…		…
1152		1354
1153	=item $max_scrollback = $term->saveLines	1355	=item $max_scrollback = $term->saveLines
1154		1356
1155	=item $nrow_plus_saveLines = $term->total_rows	1357	=item $nrow_plus_saveLines = $term->total_rows
1156		1358
1157	=item $lines_in_scrollback = $term->nsaved	1359	=item $topmost_scrollback_row = $term->top_row
1158		1360
1159	Return various integers describing terminal characteristics.	1361	Return various integers describing terminal characteristics.
1160		1362
1161	=item $x_display = $term->display_id	1363	=item $x_display = $term->display_id
1162		1364
…		…
1188	=item $modifiermask = $term->ModNumLockMask	1390	=item $modifiermask = $term->ModNumLockMask
1189		1391
1190	Return the modifier masks corresponding to the "ISO Level 3 Shift" (often	1392	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.	1393	AltGr), the meta key (often Alt) and the num lock key, if applicable.
1192		1394
		1395	=item $screen = $term->current_screen
		1396
		1397	Returns the currently displayed screen (0 primary, 1 secondary).
		1398
		1399	=item $cursor_is_hidden = $term->hidden_cursor
		1400
		1401	Returns wether the cursor is currently hidden or not.
		1402
1193	=item $view_start = $term->view_start ([$newvalue])	1403	=item $view_start = $term->view_start ([$newvalue])
1194		1404
1195	Returns the negative row number of the topmost line. Minimum value is	1405	Returns the row number of the topmost displayed line. Maximum value is
1196	C<0>, which displays the normal terminal contents. Larger values scroll	1406	C<0>, which displays the normal terminal contents. Lower values scroll
1197	this many lines into the scrollback buffer.	1407	this many lines into the scrollback buffer.
1198		1408
1199	=item $term->want_refresh	1409	=item $term->want_refresh
1200		1410
1201	Requests a screen refresh. At the next opportunity, rxvt-unicode will	1411	Requests a screen refresh. At the next opportunity, rxvt-unicode will
…		…
1216	line, starting at column C<$start_col> (default C<0>), which is useful	1426	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	1427	to replace only parts of a line. The font index in the rendition will
1218	automatically be updated.	1428	automatically be updated.
1219		1429
1220	C<$text> is in a special encoding: tabs and wide characters that use more	1430	C<$text> is in a special encoding: tabs and wide characters that use more
1221	than one cell when displayed are padded with urxvt::NOCHAR characters	1431	than one cell when displayed are padded with C<$urxvt::NOCHAR> (chr 65535)
1222	(C<chr 65535>). Characters with combining characters and other characters	1432	characters. Characters with combining characters and other characters that
1223	that do not fit into the normal tetx encoding will be replaced with	1433	do not fit into the normal tetx encoding will be replaced with characters
1224	characters in the private use area.	1434	in the private use area.
1225		1435
1226	You have to obey this encoding when changing text. The advantage is	1436	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	1437	that C<substr> and similar functions work on screen cells and not on
1228	characters.	1438	characters.
1229		1439
…		…
1404		1614
1405	Calls XUngrab for the most recent grab. Is called automatically on	1615	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	1616	evaluation errors, as it is better to lose the grab in the error case as
1407	the session.	1617	the session.
1408		1618
		1619	=item $atom = $term->XInternAtom ($atom_name[, $only_if_exists])
		1620
		1621	=item $atom_name = $term->XGetAtomName ($atom)
		1622
		1623	=item @atoms = $term->XListProperties ($window)
		1624
		1625	=item ($type,$format,$octets) = $term->XGetWindowProperty ($window, $property)
		1626
		1627	=item $term->XChangeWindowProperty ($window, $property, $type, $format, $octets)
		1628
		1629	=item $term->XDeleteProperty ($window, $property)
		1630
		1631	=item $window = $term->DefaultRootWindow
		1632
		1633	=item $term->XReparentWindow ($window, $parent, [$x, $y])
		1634
		1635	=item $term->XMapWindow ($window)
		1636
		1637	=item $term->XUnmapWindow ($window)
		1638
		1639	=item $term->XMoveResizeWindow ($window, $x, $y, $width, $height)
		1640
		1641	=item ($x, $y, $child_window) = $term->XTranslateCoordinates ($src, $dst, $x, $y)
		1642
		1643	=item $term->XChangeInput ($window, $add_events[, $del_events])
		1644
		1645	Various X or X-related functions. The C<$term> object only serves as
		1646	the source of the display, otherwise those functions map more-or-less
		1647	directory onto the X functions of the same name.
		1648
1409	=back	1649	=back
1410		1650
1411	=cut	1651	=cut
1412		1652
1413	package urxvt::popup;	1653	package urxvt::popup;
…		…
1514	my $env = $self->{term}->env;	1754	my $env = $self->{term}->env;
1515	# we can't hope to reproduce the locale algorithm, so nuke LC_ALL and set LC_CTYPE.	1755	# we can't hope to reproduce the locale algorithm, so nuke LC_ALL and set LC_CTYPE.
1516	delete $env->{LC_ALL};	1756	delete $env->{LC_ALL};
1517	$env->{LC_CTYPE} = $self->{term}->locale;	1757	$env->{LC_CTYPE} = $self->{term}->locale;
1518		1758
1519	urxvt::term->new ($env, $self->{term}->resource ("name"),	1759	urxvt::term->new ($env, "popup",
1520	"--perl-lib" => "", "--perl-ext-common" => "", "-pty-fd" => -1, "-sl" => 0, "-b" => 0,	1760	"--perl-lib" => "", "--perl-ext-common" => "",
		1761	"-pty-fd" => -1, "-sl" => 0,
		1762	"-b" => 1, "-bd" => "grey80", "-bl", "-override-redirect",
1521	"--transient-for" => $self->{term}->parent,	1763	"--transient-for" => $self->{term}->parent,
1522	"-display" => $self->{term}->display_id,	1764	"-display" => $self->{term}->display_id,
1523	"-pe" => "urxvt-popup")	1765	"-pe" => "urxvt-popup")
1524	or die "unable to create popup window\n";	1766	or die "unable to create popup window\n";
1525	}	1767	}
…		…
1530	delete $self->{term}{_destroy}{$self};	1772	delete $self->{term}{_destroy}{$self};
1531	$self->{term}->ungrab;	1773	$self->{term}->ungrab;
1532	}	1774	}
1533		1775
1534	=back	1776	=back
		1777
		1778	=cut
		1779
		1780	package urxvt::watcher;
		1781
		1782	@urxvt::timer::ISA = __PACKAGE__;
		1783	@urxvt::iow::ISA = __PACKAGE__;
		1784	@urxvt::pw::ISA = __PACKAGE__;
		1785	@urxvt::iw::ISA = __PACKAGE__;
1535		1786
1536	=head2 The C<urxvt::timer> Class	1787	=head2 The C<urxvt::timer> Class
1537		1788
1538	This class implements timer watchers/events. Time is represented as a	1789	This class implements timer watchers/events. Time is represented as a
1539	fractional number of seconds since the epoch. Example:	1790	fractional number of seconds since the epoch. Example:
…		…
1577	Start the timer.	1828	Start the timer.
1578		1829
1579	=item $timer = $timer->start ($tstamp)	1830	=item $timer = $timer->start ($tstamp)
1580		1831
1581	Set the event trigger time to C<$tstamp> and start the timer.	1832	Set the event trigger time to C<$tstamp> and start the timer.
		1833
		1834	=item $timer = $timer->after ($delay)
		1835
		1836	Like C<start>, but sets the expiry timer to c<urxvt::NOW + $delay>.
1582		1837
1583	=item $timer = $timer->stop	1838	=item $timer = $timer->stop
1584		1839
1585	Stop the timer.	1840	Stop the timer.
1586		1841
…		…
1633		1888
1634	Stop watching for events on the given filehandle.	1889	Stop watching for events on the given filehandle.
1635		1890
1636	=back	1891	=back
1637		1892
		1893	=head2 The C<urxvt::iw> Class
		1894
		1895	This class implements idle watchers, that get called automatically when
		1896	the process is idle. They should return as fast as possible, after doing
		1897	some useful work.
		1898
		1899	=over 4
		1900
		1901	=item $iw = new urxvt::iw
		1902
		1903	Create a new idle watcher object in stopped state.
		1904
		1905	=item $iw = $iw->cb (sub { my ($iw) = @_; ... })
		1906
		1907	Set the callback to be called when the watcher triggers.
		1908
		1909	=item $timer = $timer->start
		1910
		1911	Start the watcher.
		1912
		1913	=item $timer = $timer->stop
		1914
		1915	Stop the watcher.
		1916
		1917	=back
		1918
		1919	=head2 The C<urxvt::pw> Class
		1920
		1921	This class implements process watchers. They create an event whenever a
		1922	process exits, after which they stop automatically.
		1923
		1924	my $pid = fork;
		1925	...
		1926	$term->{pw} = urxvt::pw
		1927	->new
		1928	->start ($pid)
		1929	->cb (sub {
		1930	my ($pw, $exit_status) = @_;
		1931	...
		1932	});
		1933
		1934	=over 4
		1935
		1936	=item $pw = new urxvt::pw
		1937
		1938	Create a new process watcher in stopped state.
		1939
		1940	=item $pw = $pw->cb (sub { my ($pw, $exit_status) = @_; ... })
		1941
		1942	Set the callback to be called when the timer triggers.
		1943
		1944	=item $pw = $timer->start ($pid)
		1945
		1946	Tells the wqtcher to start watching for process C<$pid>.
		1947
		1948	=item $pw = $pw->stop
		1949
		1950	Stop the watcher.
		1951
		1952	=back
		1953
1638	=head1 ENVIRONMENT	1954	=head1 ENVIRONMENT
1639		1955
1640	=head2 URXVT_PERL_VERBOSITY	1956	=head2 URXVT_PERL_VERBOSITY
1641		1957
1642	This variable controls the verbosity level of the perl extension. Higher	1958	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.125 by root, Sun Jan 22 20:39:47 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.125 by root, Sun Jan 22 20:39:47 2006 UTC