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

Comparing rxvt-unicode/src/urxvt.pm (file contents):
Revision 1.91 by root, Fri Jan 13 01:09:37 2006 UTC vs.
Revision 1.127 by root, Wed Jan 25 00:42: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
…		…
63	the match. For example, the followign adds a regex that matches everything	67	the match. For example, the followign adds a regex that matches everything
64	between two vertical bars:	68	between two vertical bars:
65		69
66	URxvt.selection.pattern-0: \\\|([^\|]+)\\\|	70	URxvt.selection.pattern-0: \\\|([^\|]+)\\\|
67		71
		72	Another example: Programs I use often output "absolute path: " at the
		73	beginning of a line when they process multiple files. The following
		74	pattern matches the filename (note, there is a single space at the very
		75	end):
		76
		77	URxvt.selection.pattern-0: ^(/[^:]+):\
		78
68	You can look at the source of the selection extension to see more	79	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.	80	interesting uses, such as parsing a line from beginning to end.
70		81
71	This extension also offers the following bindable keyboard command:	82	This extension also offers following bindable keyboard commands:
72		83
73	=over 4	84	=over 4
74		85
75	=item rot13	86	=item rot13
76		87
…		…
87		98
88	=item selection-popup (enabled by default)	99	=item selection-popup (enabled by default)
89		100
90	Binds a popup menu to Ctrl-Button3 that lets you convert the selection	101	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	102	text into various other formats/action (such as uri unescaping, perl
92	evalution, web-browser starting etc.), depending on content.	103	evaluation, web-browser starting etc.), depending on content.
		104
		105	Other extensions can extend this popup menu by pushing a code reference
		106	onto C<@{ $term->{selection_popup_hook} }>, that is called whenever the
		107	popup is displayed.
		108
		109	It's sole argument is the popup menu, which can be modified. The selection
		110	is in C<$_>, which can be used to decide wether to add something or not.
		111	It should either return nothing or a string and a code reference. The
		112	string will be used as button text and the code reference will be called
		113	when the button gets activated and should transform C<$_>.
		114
		115	The following will add an entry C<a to b> that transforms all C<a>s in
		116	the selection to C<b>s, but only if the selection currently contains any
		117	C<a>s:
		118
		119	push @{ $self->{term}{selection_popup_hook} }, sub {
		120	/a/ ? ("a to be" => sub { s/a/b/g }
		121	: ()
		122	};
93		123
94	=item searchable-scrollback<hotkey> (enabled by default)	124	=item searchable-scrollback<hotkey> (enabled by default)
95		125
96	Adds regex search functionality to the scrollback buffer, triggered	126	Adds regex search functionality to the scrollback buffer, triggered
97	by a hotkey (default: C<M-s>). While in search mode, normal terminal	127	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	134	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	135	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	136	additionally stores the first match in the current line into the primary
107	selection.	137	selection.
108		138
		139	=item readline (enabled by default)
		140
		141	A support package that tries to make editing with readline easier. At the
		142	moment, it reacts to clicking with the left mouse button by trying to
		143	move the text cursor to this position. It does so by generating as many
		144	cursor-left or cursor-right keypresses as required (the this only works
		145	for programs that correctly support wide characters).
		146
		147	To avoid too many false positives, this is only done when:
		148
		149	=over 4
		150
		151	=item - the tty is in ICANON state.
		152
		153	=item - the text cursor is visible.
		154
		155	=item - the primary screen is currently being displayed.
		156
		157	=item - the mouse is on the same (multi-row-) line as the text cursor.
		158
		159	=back
		160
		161	The normal selection mechanism isn't disabled, so quick successive clicks
		162	might interfere with selection creation in harmless ways.
		163
109	=item selection-autotransform	164	=item selection-autotransform
110		165
111	This selection allows you to do automatic transforms on a selection	166	This selection allows you to do automatic transforms on a selection
112	whenever a selection is made.	167	whenever a selection is made.
113		168
…		…
120		175
121	For example, the following will transform selections of the form	176	For example, the following will transform selections of the form
122	C<filename:number>, often seen in compiler messages, into C<vi +$filename	177	C<filename:number>, often seen in compiler messages, into C<vi +$filename
123	$word>:	178	$word>:
124		179
125	URxvt.selection-autotransform.0: s/^(\\S+):(\\d+):?$/vi +$2 \\Q$1\\E\\x0d/	180	URxvt.selection-autotransform.0: s/^([^:[:space:]]+):(\\d+):?$/vi +$2 \\Q$1\\E\\x0d/
126		181
127	And this example matches the same,but replaces it with vi-commands you can	182	And this example matches the same,but replaces it with vi-commands you can
128	paste directly into your (vi :) editor:	183	paste directly into your (vi :) editor:
129		184
130	URxvt.selection-autotransform.0: s/^(S+):(d+):?$/\\x1b:e \\Q$1\\E\\x0d:$2\\x0d/	185	URxvt.selection-autotransform.0: s/^([^:[:space:]]+(\\d+):?$/:e \\Q$1\\E\\x0d:$2\\x0d/
131		186
132	Of course, this can be modified to suit your needs and your editor :)	187	Of course, this can be modified to suit your needs and your editor :)
133		188
134	To expand the example above to typical perl error messages ("XXX at	189	To expand the example above to typical perl error messages ("XXX at
135	FILENAME line YYY."), you need a slightly more elaborate solution:	190	FILENAME line YYY."), you need a slightly more elaborate solution:
136		191
137	URxvt.selection.pattern-0: ( at .*? line \\d+\\.)	192	URxvt.selection.pattern-0: ( at .*? line \\d+[,.])
138	URxvt.selection-autotransform.0: s/^ at (.*?) line (\\d+)\\.$/\x1b:e \\Q$1\E\\x0d:$2\\x0d/	193	URxvt.selection-autotransform.0: s/^ at (.*?) line (\\d+)[,.]$/:e \\Q$1\E\\x0d:$2\\x0d/
139		194
140	The first line tells the selection code to treat the unchanging part of	195	The first line tells the selection code to treat the unchanging part of
141	every error message as a selection pattern, and the second line transforms	196	every error message as a selection pattern, and the second line transforms
142	the message into vi commands to load the file.	197	the message into vi commands to load the file.
		198
		199	=item tabbed
		200
		201	This transforms the terminal into a tabbar with additional terminals, that
		202	is, it implements what is commonly refered to as "tabbed terminal". The topmost line
		203	displays a "[NEW]" button, which, when clicked, will add a new tab, followed by one
		204	button per tab.
		205
		206	Clicking a button will activate that tab. Pressing B<Shift-Left> and
		207	B<Shift-Right> will switch to the tab left or right of the current one,
		208	while B<Shift-Down> creates a new tab.
143		209
144	=item mark-urls	210	=item mark-urls
145		211
146	Uses per-line display filtering (C<on_line_update>) to underline urls and	212	Uses per-line display filtering (C<on_line_update>) to underline urls and
147	make them clickable. When middle-clicked, the program specified in the	213	make them clickable. When middle-clicked, the program specified in the
148	resource C<urlLauncher> (default C<x-www-browser>) will be started with	214	resource C<urlLauncher> (default C<x-www-browser>) will be started with
149	the URL as first argument.	215	the URL as first argument.
150		216
		217	=item automove-background
		218
		219	This is basically a one-line extension that dynamically changes the background pixmap offset
		220	to the window position, in effect creating the same effect as pseudo transparency with
		221	a custom pixmap. No scaling is supported in this mode. Exmaple:
		222
		223	@@RXVT_NAME@@ -pixmap background.xpm -pe automove-background
		224
151	=item block-graphics-to-ascii	225	=item block-graphics-to-ascii
152		226
153	A not very useful example of filtering all text output to the terminal,	227	A not very useful example of filtering all text output to the terminal,
154	by replacing all line-drawing characters (U+2500 .. U+259F) by a	228	by replacing all line-drawing characters (U+2500 .. U+259F) by a
155	similar-looking ascii character.	229	similar-looking ascii character.
…		…
161	=item example-refresh-hooks	235	=item example-refresh-hooks
162		236
163	Displays a very simple digital clock in the upper right corner of the	237	Displays a very simple digital clock in the upper right corner of the
164	window. Illustrates overwriting the refresh callbacks to create your own	238	window. Illustrates overwriting the refresh callbacks to create your own
165	overlays or changes.	239	overlays or changes.
		240
		241	=item selection-pastebin
		242
		243	This is a little rarely useful extension that Uploads the selection as
		244	textfile to a remote site (or does other things). (The implementation is
		245	not currently secure for use in a multiuser environment as it writes to
		246	F</tmp> directly.).
		247
		248	It listens to the C<selection-pastebin:remote-pastebin> keyboard command,
		249	i.e.
		250
		251	URxvt.keysym.C-M-e: perl:selection-pastebin:remote-pastebin
		252
		253	Pressing this combination runs a command with C<%> replaced by the name of
		254	the textfile. This command can be set via a resource:
		255
		256	URxvt.selection-pastebin.cmd: rsync -apP % ruth:/var/www/www.ta-sa.org/files/txt/.
		257
		258	And the default is likely not useful to anybody but the few people around
		259	here :)
		260
		261	The name of the textfile is the hex encoded md5 sum of the selection, so
		262	the same content should lead to the same filename.
		263
		264	After a successful upload the selection will be replaced by the text given
		265	in the C<selection-pastebin-url> resource (again, the % is the placeholder
		266	for the filename):
		267
		268	URxvt.selection-pastebin.url: http://www.ta-sa.org/files/txt/%
166		269
167	=back	270	=back
168		271
169	=head1 API DOCUMENTATION	272	=head1 API DOCUMENTATION
170		273
…		…
243	called whenever the relevant event happens.	346	called whenever the relevant event happens.
244		347
245	The first argument passed to them is an extension oject as described in	348	The first argument passed to them is an extension oject as described in
246	the in the C<Extension Objects> section.	349	the in the C<Extension Objects> section.
247		350
248	B<All> of these hooks must return a boolean value. If it is true, then the	351	B<All> of these hooks must return a boolean value. If any of the called
249	event counts as being I<consumed>, and the invocation of other hooks is	352	hooks returns true, then the event counts as being I<consumed>, and the
250	skipped, and the relevant action might not be carried out by the C++ code.	353	relevant action might not be carried out by the C++ code.
251		354
252	I<< When in doubt, return a false value (preferably C<()>). >>	355	I<< When in doubt, return a false value (preferably C<()>). >>
253		356
254	=over 4	357	=over 4
255		358
256	=item on_init $term	359	=item on_init $term
257		360
258	Called after a new terminal object has been initialized, but before	361	Called after a new terminal object has been initialized, but before
259	windows are created or the command gets run. Most methods are unsafe to	362	windows are created or the command gets run. Most methods are unsafe to
260	call or deliver senseless data, as terminal size and other characteristics	363	call or deliver senseless data, as terminal size and other characteristics
261	have not yet been determined. You can safely query and change resources,	364	have not yet been determined. You can safely query and change resources
262	though.	365	and options, though. For many purposes the C<on_start> hook is a better
		366	place.
		367
		368	=item on_start $term
		369
		370	Called at the very end of initialisation of a new terminal, just before
		371	trying to map (display) the toplevel and returning to the mainloop.
		372
		373	=item on_destroy $term
		374
		375	Called whenever something tries to destroy terminal, when the terminal is
		376	still fully functional (not for long, though).
263		377
264	=item on_reset $term	378	=item on_reset $term
265		379
266	Called after the screen is "reset" for any reason, such as resizing or	380	Called after the screen is "reset" for any reason, such as resizing or
267	control sequences. Here is where you can react on changes to size-related	381	control sequences. Here is where you can react on changes to size-related
268	variables.	382	variables.
269		383
270	=item on_start $term	384	=item on_child_start $term, $pid
271		385
272	Called at the very end of initialisation of a new terminal, just before	386	Called just after the child process has been C<fork>ed.
273	returning to the mainloop.	387
		388	=item on_child_exit $term, $status
		389
		390	Called just after the child process has exited. C<$status> is the status
		391	from C<waitpid>.
274		392
275	=item on_sel_make $term, $eventtime	393	=item on_sel_make $term, $eventtime
276		394
277	Called whenever a selection has been made by the user, but before the	395	Called whenever a selection has been made by the user, but before the
278	selection text is copied, so changes to the beginning, end or type of the	396	selection text is copied, so changes to the beginning, end or type of the
…		…
371		489
372	Called whenever the user presses a key combination that has a	490	Called whenever the user presses a key combination that has a
373	C<perl:string> action bound to it (see description of the B<keysym>	491	C<perl:string> action bound to it (see description of the B<keysym>
374	resource in the @@RXVT_NAME@@(1) manpage).	492	resource in the @@RXVT_NAME@@(1) manpage).
375		493
		494	=item on_x_event $term, $event
		495
		496	Called on every X event received on the vt window (and possibly other
		497	windows). Should only be used as a last resort. Most event structure
		498	members are not passed.
		499
376	=item on_focus_in $term	500	=item on_focus_in $term
377		501
378	Called whenever the window gets the keyboard focus, before rxvt-unicode	502	Called whenever the window gets the keyboard focus, before rxvt-unicode
379	does focus in processing.	503	does focus in processing.
380		504
381	=item on_focus_out $term	505	=item on_focus_out $term
382		506
383	Called wheneever the window loses keyboard focus, before rxvt-unicode does	507	Called wheneever the window loses keyboard focus, before rxvt-unicode does
384	focus out processing.	508	focus out processing.
385		509
		510	=item on_configure_notify $term, $event
		511
		512	=item on_property_notify $term, $event
		513
386	=item on_key_press $term, $event, $keysym, $octets	514	=item on_key_press $term, $event, $keysym, $octets
387		515
388	=item on_key_release $term, $event, $keysym	516	=item on_key_release $term, $event, $keysym
389		517
390	=item on_button_press $term, $event	518	=item on_button_press $term, $event
…		…
399		527
400	Called whenever the corresponding X event is received for the terminal If	528	Called whenever the corresponding X event is received for the terminal If
401	the hook returns true, then the even will be ignored by rxvt-unicode.	529	the hook returns true, then the even will be ignored by rxvt-unicode.
402		530
403	The event is a hash with most values as named by Xlib (see the XEvent	531	The event is a hash with most values as named by Xlib (see the XEvent
404	manpage), with the additional members C<row> and C<col>, which are the row	532	manpage), with the additional members C<row> and C<col>, which are the
405	and column under the mouse cursor.	533	(real, not screen-based) row and column under the mouse cursor.
406		534
407	C<on_key_press> additionally receives the string rxvt-unicode would	535	C<on_key_press> additionally receives the string rxvt-unicode would
408	output, if any, in locale-specific encoding.	536	output, if any, in locale-specific encoding.
409		537
410	subwindow.	538	subwindow.
		539
		540	=item on_client_message $term, $event
		541
		542	=item on_wm_protocols $term, $event
		543
		544	=item on_wm_delete_window $term, $event
		545
		546	Called when various types of ClientMessage events are received (all with
		547	format=32, WM_PROTOCOLS or WM_PROTOCOLS:WM_DELETE_WINDOW).
411		548
412	=back	549	=back
413		550
414	=cut	551	=cut
415		552
…		…
421	use Scalar::Util ();	558	use Scalar::Util ();
422	use List::Util ();	559	use List::Util ();
423		560
424	our $VERSION = 1;	561	our $VERSION = 1;
425	our $TERM;	562	our $TERM;
		563	our @TERM_INIT;
		564	our @TERM_EXT;
426	our @HOOKNAME;	565	our @HOOKNAME;
427	our %HOOKTYPE = map +($HOOKNAME[$_] => $_), 0..$#HOOKNAME;	566	our %HOOKTYPE = map +($HOOKNAME[$_] => $_), 0..$#HOOKNAME;
428	our %OPTION;	567	our %OPTION;
429		568
430	our $LIBDIR;	569	our $LIBDIR;
431	our $RESNAME;	570	our $RESNAME;
432	our $RESCLASS;	571	our $RESCLASS;
433	our $RXVTNAME;	572	our $RXVTNAME;
434		573
		574	our $NOCHAR = chr 0xffff;
		575
435	=head2 Variables in the C<urxvt> Package	576	=head2 Variables in the C<urxvt> Package
436		577
437	=over 4	578	=over 4
438		579
439	=item $urxvt::LIBDIR	580	=item $urxvt::LIBDIR
…		…
451		592
452	=item $urxvt::TERM	593	=item $urxvt::TERM
453		594
454	The current terminal. This variable stores the current C<urxvt::term>	595	The current terminal. This variable stores the current C<urxvt::term>
455	object, whenever a callback/hook is executing.	596	object, whenever a callback/hook is executing.
		597
		598	=item @urxvt::TERM_INIT
		599
		600	All coderefs in this array will be called as methods of the next newly
		601	created C<urxvt::term> object (during the C<on_init> phase). The array
		602	gets cleared before the codereferences that were in it are being executed,
		603	so coderefs can push themselves onto it again if they so desire.
		604
		605	This complements to the perl-eval commandline option, but gets executed
		606	first.
		607
		608	=item @urxvt::TERM_EXT
		609
		610	Works similar to C<@TERM_INIT>, but contains perl package/class names, which
		611	get registered as normal extensions after calling the hooks in C<@TERM_INIT>
		612	but before other extensions. Gets cleared just like C<@TERM_INIT>.
456		613
457	=back	614	=back
458		615
459	=head2 Functions in the C<urxvt> Package	616	=head2 Functions in the C<urxvt> Package
460		617
…		…
475	Using this function has the advantage that its output ends up in the	632	Using this function has the advantage that its output ends up in the
476	correct place, e.g. on stderr of the connecting urxvtc client.	633	correct place, e.g. on stderr of the connecting urxvtc client.
477		634
478	Messages have a size limit of 1023 bytes currently.	635	Messages have a size limit of 1023 bytes currently.
479		636
480	=item $is_safe = urxvt::safe
481
482	Returns true when it is safe to do potentially unsafe things, such as
483	evaluating perl code specified by the user. This is true when urxvt was
484	started setuid or setgid.
485
486	=item $time = urxvt::NOW	637	=item $time = urxvt::NOW
487		638
488	Returns the "current time" (as per the event loop).	639	Returns the "current time" (as per the event loop).
489		640
490	=item urxvt::CurrentTime	641	=item urxvt::CurrentTime
491		642
492	=item urxvt::ShiftMask, LockMask, ControlMask, Mod1Mask, Mod2Mask,	643	=item urxvt::ShiftMask, LockMask, ControlMask, Mod1Mask, Mod2Mask,
493	Mod3Mask, Mod4Mask, Mod5Mask, Button1Mask, Button2Mask, Button3Mask,	644	Mod3Mask, Mod4Mask, Mod5Mask, Button1Mask, Button2Mask, Button3Mask,
494	Button4Mask, Button5Mask, AnyModifier	645	Button4Mask, Button5Mask, AnyModifier
		646
		647	=item urxvt::NoEventMask, KeyPressMask, KeyReleaseMask,
		648	ButtonPressMask, ButtonReleaseMask, EnterWindowMask, LeaveWindowMask,
		649	PointerMotionMask, PointerMotionHintMask, Button1MotionMask, Button2MotionMask,
		650	Button3MotionMask, Button4MotionMask, Button5MotionMask, ButtonMotionMask,
		651	KeymapStateMask, ExposureMask, VisibilityChangeMask, StructureNotifyMask,
		652	ResizeRedirectMask, SubstructureNotifyMask, SubstructureRedirectMask,
		653	FocusChangeMask, PropertyChangeMask, ColormapChangeMask, OwnerGrabButtonMask
		654
		655	=item urxvt::KeyPress, KeyRelease, ButtonPress, ButtonRelease, MotionNotify,
		656	EnterNotify, LeaveNotify, FocusIn, FocusOut, KeymapNotify, Expose,
		657	GraphicsExpose, NoExpose, VisibilityNotify, CreateNotify, DestroyNotify,
		658	UnmapNotify, MapNotify, MapRequest, ReparentNotify, ConfigureNotify,
		659	ConfigureRequest, GravityNotify, ResizeRequest, CirculateNotify,
		660	CirculateRequest, PropertyNotify, SelectionClear, SelectionRequest,
		661	SelectionNotify, ColormapNotify, ClientMessage, MappingNotify
495		662
496	Various constants for use in X calls and event processing.	663	Various constants for use in X calls and event processing.
497		664
498	=back	665	=back
499		666
…		…
550	=back	717	=back
551		718
552	=cut	719	=cut
553		720
554	BEGIN {	721	BEGIN {
555	urxvt->bootstrap;
556
557	# overwrite perl's warn	722	# overwrite perl's warn
558	*CORE::GLOBAL::warn = sub {	723	*CORE::GLOBAL::warn = sub {
559	my $msg = join "", @_;	724	my $msg = join "", @_;
560	$msg .= "\n"	725	$msg .= "\n"
561	unless $msg =~ /\n$/;	726	unless $msg =~ /\n$/;
562	urxvt::warn ($msg);	727	urxvt::warn ($msg);
563	};	728	};
564
565	# %ENV is the original startup environment
566	delete $ENV{IFS};
567	delete $ENV{CDPATH};
568	delete $ENV{BASH_ENV};
569	$ENV{PATH} = "/bin:/sbin:/usr/bin:/usr/sbin:/usr/local/bin:/usr/local/sbin:/opt/bin:/opt/sbin";
570	}	729	}
571		730
572	my @hook_count;	731	no warnings 'utf8';
		732
573	my $verbosity = $ENV{URXVT_PERL_VERBOSITY};	733	my $verbosity = $ENV{URXVT_PERL_VERBOSITY};
574		734
575	sub verbose {	735	sub verbose {
576	my ($level, $msg) = @_;	736	my ($level, $msg) = @_;
577	warn "$msg\n" if $level <= $verbosity;	737	warn "$msg\n" if $level <= $verbosity;
578	}	738	}
579		739
580	my $extension_pkg = "extension0000";
581	my %extension_pkg;	740	my %extension_pkg;
582		741
583	# load a single script into its own package, once only	742	# load a single script into its own package, once only
584	sub extension_package($) {	743	sub extension_package($) {
585	my ($path) = @_;	744	my ($path) = @_;
586		745
587	$extension_pkg{$path} \|\|= do {	746	$extension_pkg{$path} \|\|= do {
588	my $pkg = "urxvt::" . ($extension_pkg++);	747	$path =~ /([^\/\\]+)$/;
		748	my $pkg = $1;
		749	$pkg =~ s/[^[:word:]]/_/g;
		750	$pkg = "urxvt::ext::$pkg";
589		751
590	verbose 3, "loading extension '$path' into package '$pkg'";	752	verbose 3, "loading extension '$path' into package '$pkg'";
591		753
592	open my $fh, "<:raw", $path	754	open my $fh, "<:raw", $path
593	or die "$path: $!";	755	or die "$path: $!";
594		756
595	my $source = untaint	757	my $source =
596	"package $pkg; use strict; use utf8;\n"	758	"package $pkg; use strict; use utf8; no warnings 'utf8';\n"
597	. "use base urxvt::term::extension::;\n"
598	. "#line 1 \"$path\"\n{\n"	759	. "#line 1 \"$path\"\n{\n"
599	. (do { local $/; <$fh> })	760	. (do { local $/; <$fh> })
600	. "\n};\n1";	761	. "\n};\n1";
601		762
602	eval $source	763	eval $source
…		…
616	if ($htype == 0) { # INIT	777	if ($htype == 0) { # INIT
617	my @dirs = ((split /:/, $TERM->resource ("perl_lib")), "$LIBDIR/perl");	778	my @dirs = ((split /:/, $TERM->resource ("perl_lib")), "$LIBDIR/perl");
618		779
619	my %ext_arg;	780	my %ext_arg;
620		781
		782	{
		783	my @init = @TERM_INIT;
		784	@TERM_INIT = ();
		785	$_->($TERM) for @init;
		786	my @pkg = @TERM_EXT;
		787	@TERM_EXT = ();
		788	$TERM->register_package ($_) for @pkg;
		789	}
		790
621	for (map { split /,/, $TERM->resource ("perl_ext_$_") } 1, 2) {	791	for (grep $_, map { split /,/, $TERM->resource ("perl_ext_$_") } 1, 2) {
622	if ($_ eq "default") {	792	if ($_ eq "default") {
623	$ext_arg{$_} \|\|= [] for qw(selection option-popup selection-popup searchable-scrollback);	793	$ext_arg{$_} \|\|= [] for qw(selection option-popup selection-popup searchable-scrollback readline);
624	} elsif (/^-(.*)$/) {	794	} elsif (/^-(.*)$/) {
625	delete $ext_arg{$1};	795	delete $ext_arg{$1};
626	} elsif (/^([^<]+)<(.*)>$/) {	796	} elsif (/^([^<]+)<(.*)>$/) {
627	push @{ $ext_arg{$1} }, $2;	797	push @{ $ext_arg{$1} }, $2;
628	} else {	798	} else {
…		…
651	if $verbosity >= 10;	821	if $verbosity >= 10;
652		822
653	keys %$cb;	823	keys %$cb;
654		824
655	while (my ($pkg, $cb) = each %$cb) {	825	while (my ($pkg, $cb) = each %$cb) {
656	$retval = eval { $cb->($TERM->{_pkg}{$pkg}, @_) }	826	my $retval_ = eval { $cb->($TERM->{_pkg}{$pkg}, @_) };
657	and last;	827	$retval \|\|= $retval_;
658		828
659	if ($@) {	829	if ($@) {
660	$TERM->ungrab; # better to lose the grab than the session	830	$TERM->ungrab; # better to lose the grab than the session
661	warn $@;	831	warn $@;
662	}	832	}
…		…
665	verbose 11, "$HOOKNAME[$htype] returning <$retval>"	835	verbose 11, "$HOOKNAME[$htype] returning <$retval>"
666	if $verbosity >= 11;	836	if $verbosity >= 11;
667	}	837	}
668		838
669	if ($htype == 1) { # DESTROY	839	if ($htype == 1) { # DESTROY
670	if (my $hook = delete $TERM->{_hook}) {
671	for my $htype (0..$#$hook) {
672	$hook_count[$htype] -= scalar keys %{ $hook->[$htype] \|\| {} }
673	or set_should_invoke $htype, 0;
674	}
675	}
676
677	# clear package objects	840	# clear package objects
678	%$_ = () for values %{ $TERM->{_pkg} };	841	%$_ = () for values %{ $TERM->{_pkg} };
679		842
680	# clear package	843	# clear package
681	%$TERM = ();	844	%$TERM = ();
682	}	845	}
683		846
684	$retval	847	$retval
685	}
686
687	sub exec_async(@) {
688	my $pid = fork;
689
690	return
691	if !defined $pid or $pid;
692
693	%ENV = %{ $TERM->env };
694
695	exec @_;
696	_exit 255;
697	}	848	}
698		849
699	# urxvt::term::extension	850	# urxvt::term::extension
700		851
701	package urxvt::term::extension;	852	package urxvt::term::extension;
…		…
707	while (my ($name, $cb) = each %hook) {	858	while (my ($name, $cb) = each %hook) {
708	my $htype = $HOOKTYPE{uc $name};	859	my $htype = $HOOKTYPE{uc $name};
709	defined $htype	860	defined $htype
710	or Carp::croak "unsupported hook type '$name'";	861	or Carp::croak "unsupported hook type '$name'";
711		862
		863	$self->set_should_invoke ($htype, +1)
712	unless (exists $self->{term}{_hook}[$htype]{$pkg}) {	864	unless exists $self->{term}{_hook}[$htype]{$pkg};
713	$hook_count[$htype]++
714	or urxvt::set_should_invoke $htype, 1;
715	}
716		865
717	$self->{term}{_hook}[$htype]{$pkg} = $cb;	866	$self->{term}{_hook}[$htype]{$pkg} = $cb;
718	}	867	}
719	}	868	}
720		869
…		…
725	for my $name (@hook) {	874	for my $name (@hook) {
726	my $htype = $HOOKTYPE{uc $name};	875	my $htype = $HOOKTYPE{uc $name};
727	defined $htype	876	defined $htype
728	or Carp::croak "unsupported hook type '$name'";	877	or Carp::croak "unsupported hook type '$name'";
729		878
		879	$self->set_should_invoke ($htype, -1)
730	if (delete $self->{term}{_hook}[$htype]{$pkg}) {	880	if delete $self->{term}{_hook}[$htype]{$pkg};
731	--$hook_count[$htype]
732	or urxvt::set_should_invoke $htype, 0;
733	}
734	}	881	}
735	}	882	}
736		883
737	our $AUTOLOAD;	884	our $AUTOLOAD;
738		885
…		…
844	# find on_xxx subs in the package and register them	991	# find on_xxx subs in the package and register them
845	# as hooks	992	# as hooks
846	sub register_package {	993	sub register_package {
847	my ($self, $pkg, $argv) = @_;	994	my ($self, $pkg, $argv) = @_;
848		995
		996	no strict 'refs';
		997
		998	urxvt::verbose 6, "register package $pkg to $self";
		999
		1000	@{"$pkg\::ISA"} = urxvt::term::extension::;
		1001
849	my $proxy = bless {	1002	my $proxy = bless {
850	_pkg => $pkg,	1003	_pkg => $pkg,
851	argv => $argv,	1004	argv => $argv,
852	}, $pkg;	1005	}, $pkg;
853	Scalar::Util::weaken ($proxy->{term} = $self);	1006	Scalar::Util::weaken ($proxy->{term} = $self);
…		…
884		1037
885	Destroy the terminal object (close the window, free resources	1038	Destroy the terminal object (close the window, free resources
886	etc.). Please note that @@RXVT_NAME@@ will not exit as long as any event	1039	etc.). Please note that @@RXVT_NAME@@ will not exit as long as any event
887	watchers (timers, io watchers) are still active.	1040	watchers (timers, io watchers) are still active.
888		1041
		1042	=item $term->exec_async ($cmd[, @args])
		1043
		1044	Works like the combination of the C<fork>/C<exec> builtins, which executes
		1045	("starts") programs in the background. This function takes care of setting
		1046	the user environment before exec'ing the command (e.g. C<PATH>) and should
		1047	be preferred over explicit calls to C<exec> or C<system>.
		1048
		1049	Returns the pid of the subprocess or C<undef> on error.
		1050
		1051	=cut
		1052
		1053	sub exec_async {
		1054	my $self = shift;
		1055
		1056	my $pid = fork;
		1057
		1058	return $pid
		1059	if !defined $pid or $pid;
		1060
		1061	%ENV = %{ $self->env };
		1062
		1063	exec @_;
		1064	urxvt::_exit 255;
		1065	}
		1066
889	=item $isset = $term->option ($optval[, $set])	1067	=item $isset = $term->option ($optval[, $set])
890		1068
891	Returns true if the option specified by C<$optval> is enabled, and	1069	Returns true if the option specified by C<$optval> is enabled, and
892	optionally change it. All option values are stored by name in the hash	1070	optionally change it. All option values are stored by name in the hash
893	C<%urxvt::OPTION>. Options not enabled in this binary are not in the hash.	1071	C<%urxvt::OPTION>. Options not enabled in this binary are not in the hash.
…		…
895	Here is a a likely non-exhaustive list of option names, please see the	1073	Here is a a likely non-exhaustive list of option names, please see the
896	source file F</src/optinc.h> to see the actual list:	1074	source file F</src/optinc.h> to see the actual list:
897		1075
898	borderLess console cursorBlink cursorUnderline hold iconic insecure	1076	borderLess console cursorBlink cursorUnderline hold iconic insecure
899	intensityStyles jumpScroll loginShell mapAlert meta8 mouseWheelScrollPage	1077	intensityStyles jumpScroll loginShell mapAlert meta8 mouseWheelScrollPage
900	pastableTabs pointerBlank reverseVideo scrollBar scrollBar_floating	1078	override-redirect pastableTabs pointerBlank reverseVideo scrollBar
901	scrollBar_right scrollTtyKeypress scrollTtyOutput scrollWithBuffer	1079	scrollBar_floating scrollBar_right scrollTtyKeypress scrollTtyOutput
902	secondaryScreen secondaryScroll skipBuiltinGlyphs transparent	1080	scrollWithBuffer secondaryScreen secondaryScroll skipBuiltinGlyphs
903	tripleclickwords utmpInhibit visualBell	1081	transparent tripleclickwords utmpInhibit visualBell
904		1082
905	=item $value = $term->resource ($name[, $newval])	1083	=item $value = $term->resource ($name[, $newval])
906		1084
907	Returns the current resource value associated with a given name and	1085	Returns the current resource value associated with a given name and
908	optionally sets a new value. Setting values is most useful in the C<init>	1086	optionally sets a new value. Setting values is most useful in the C<init>
…		…
925		1103
926	answerbackstring backgroundPixmap backspace_key boldFont boldItalicFont	1104	answerbackstring backgroundPixmap backspace_key boldFont boldItalicFont
927	borderLess color cursorBlink cursorUnderline cutchars delete_key	1105	borderLess color cursorBlink cursorUnderline cutchars delete_key
928	display_name embed ext_bwidth fade font geometry hold iconName	1106	display_name embed ext_bwidth fade font geometry hold iconName
929	imFont imLocale inputMethod insecure int_bwidth intensityStyles	1107	imFont imLocale inputMethod insecure int_bwidth intensityStyles
930	italicFont jumpScroll lineSpace loginShell mapAlert menu meta8 modifier	1108	italicFont jumpScroll lineSpace loginShell mapAlert meta8 modifier
931	mouseWheelScrollPage name pastableTabs path perl_eval perl_ext_1 perl_ext_2	1109	mouseWheelScrollPage name override_redirect pastableTabs path perl_eval
932	perl_lib pointerBlank pointerBlankDelay preeditType print_pipe pty_fd	1110	perl_ext_1 perl_ext_2 perl_lib pointerBlank pointerBlankDelay
933	reverseVideo saveLines scrollBar scrollBar_align scrollBar_floating	1111	preeditType print_pipe pty_fd reverseVideo saveLines scrollBar
934	scrollBar_right scrollBar_thickness scrollTtyKeypress scrollTtyOutput	1112	scrollBar_align scrollBar_floating scrollBar_right scrollBar_thickness
935	scrollWithBuffer scrollstyle secondaryScreen secondaryScroll selectstyle	1113	scrollTtyKeypress scrollTtyOutput scrollWithBuffer scrollstyle
936	shade term_name title transparent transparent_all tripleclickwords	1114	secondaryScreen secondaryScroll selectstyle shade term_name title
937	utmpInhibit visualBell	1115	transient_for transparent transparent_all tripleclickwords utmpInhibit
		1116	visualBell
938		1117
939	=cut	1118	=cut
940		1119
941	sub resource($$;$) {	1120	sub resource($$;$) {
942	my ($self, $name) = (shift, shift);	1121	my ($self, $name) = (shift, shift);
…		…
1116		1295
1117	Normally its not a good idea to use this function, as programs might be	1296	Normally its not a good idea to use this function, as programs might be
1118	confused by changes in cursor position or scrolling. Its useful inside a	1297	confused by changes in cursor position or scrolling. Its useful inside a
1119	C<on_add_lines> hook, though.	1298	C<on_add_lines> hook, though.
1120		1299
		1300	=item $term->scr_change_screen ($screen)
		1301
		1302	Switch to given screen - 0 primary, 1 secondary.
		1303
1121	=item $term->cmd_parse ($octets)	1304	=item $term->cmd_parse ($octets)
1122		1305
1123	Similar to C<scr_add_lines>, but the argument must be in the	1306	Similar to C<scr_add_lines>, but the argument must be in the
1124	locale-specific encoding of the terminal and can contain command sequences	1307	locale-specific encoding of the terminal and can contain command sequences
1125	(escape codes) that will be interpreted.	1308	(escape codes) that will be interpreted.
…		…
1135	Replaces the event mask of the pty watcher by the given event mask. Can	1318	Replaces the event mask of the pty watcher by the given event mask. Can
1136	be used to suppress input and output handling to the pty/tty. See the	1319	be used to suppress input and output handling to the pty/tty. See the
1137	description of C<< urxvt::timer->events >>. Make sure to always restore	1320	description of C<< urxvt::timer->events >>. Make sure to always restore
1138	the previous value.	1321	the previous value.
1139		1322
		1323	=item $fd = $term->pty_fd
		1324
		1325	Returns the master file descriptor for the pty in use, or C<-1> if no pty
		1326	is used.
		1327
1140	=item $windowid = $term->parent	1328	=item $windowid = $term->parent
1141		1329
1142	Return the window id of the toplevel window.	1330	Return the window id of the toplevel window.
1143		1331
1144	=item $windowid = $term->vt	1332	=item $windowid = $term->vt
1145		1333
1146	Return the window id of the terminal window.	1334	Return the window id of the terminal window.
1147		1335
		1336	=item $term->vt_emask_add ($x_event_mask)
		1337
		1338	Adds the specified events to the vt event mask. Useful e.g. when you want
		1339	to receive pointer events all the times:
		1340
		1341	$term->vt_emask_add (urxvt::PointerMotionMask);
		1342
1148	=item $window_width = $term->width	1343	=item $window_width = $term->width
1149		1344
1150	=item $window_height = $term->height	1345	=item $window_height = $term->height
1151		1346
1152	=item $font_width = $term->fwidth	1347	=item $font_width = $term->fwidth
…		…
1165		1360
1166	=item $max_scrollback = $term->saveLines	1361	=item $max_scrollback = $term->saveLines
1167		1362
1168	=item $nrow_plus_saveLines = $term->total_rows	1363	=item $nrow_plus_saveLines = $term->total_rows
1169		1364
1170	=item $lines_in_scrollback = $term->nsaved	1365	=item $topmost_scrollback_row = $term->top_row
1171		1366
1172	Return various integers describing terminal characteristics.	1367	Return various integers describing terminal characteristics.
1173		1368
1174	=item $x_display = $term->display_id	1369	=item $x_display = $term->display_id
1175		1370
…		…
1201	=item $modifiermask = $term->ModNumLockMask	1396	=item $modifiermask = $term->ModNumLockMask
1202		1397
1203	Return the modifier masks corresponding to the "ISO Level 3 Shift" (often	1398	Return the modifier masks corresponding to the "ISO Level 3 Shift" (often
1204	AltGr), the meta key (often Alt) and the num lock key, if applicable.	1399	AltGr), the meta key (often Alt) and the num lock key, if applicable.
1205		1400
		1401	=item $screen = $term->current_screen
		1402
		1403	Returns the currently displayed screen (0 primary, 1 secondary).
		1404
		1405	=item $cursor_is_hidden = $term->hidden_cursor
		1406
		1407	Returns wether the cursor is currently hidden or not.
		1408
1206	=item $view_start = $term->view_start ([$newvalue])	1409	=item $view_start = $term->view_start ([$newvalue])
1207		1410
1208	Returns the negative row number of the topmost line. Minimum value is	1411	Returns the row number of the topmost displayed line. Maximum value is
1209	C<0>, which displays the normal terminal contents. Larger values scroll	1412	C<0>, which displays the normal terminal contents. Lower values scroll
1210	this many lines into the scrollback buffer.	1413	this many lines into the scrollback buffer.
1211		1414
1212	=item $term->want_refresh	1415	=item $term->want_refresh
1213		1416
1214	Requests a screen refresh. At the next opportunity, rxvt-unicode will	1417	Requests a screen refresh. At the next opportunity, rxvt-unicode will
…		…
1229	line, starting at column C<$start_col> (default C<0>), which is useful	1432	line, starting at column C<$start_col> (default C<0>), which is useful
1230	to replace only parts of a line. The font index in the rendition will	1433	to replace only parts of a line. The font index in the rendition will
1231	automatically be updated.	1434	automatically be updated.
1232		1435
1233	C<$text> is in a special encoding: tabs and wide characters that use more	1436	C<$text> is in a special encoding: tabs and wide characters that use more
1234	than one cell when displayed are padded with urxvt::NOCHAR characters	1437	than one cell when displayed are padded with C<$urxvt::NOCHAR> (chr 65535)
1235	(C<chr 65535>). Characters with combining characters and other characters	1438	characters. Characters with combining characters and other characters that
1236	that do not fit into the normal tetx encoding will be replaced with	1439	do not fit into the normal tetx encoding will be replaced with characters
1237	characters in the private use area.	1440	in the private use area.
1238		1441
1239	You have to obey this encoding when changing text. The advantage is	1442	You have to obey this encoding when changing text. The advantage is
1240	that C<substr> and similar functions work on screen cells and not on	1443	that C<substr> and similar functions work on screen cells and not on
1241	characters.	1444	characters.
1242		1445
…		…
1417		1620
1418	Calls XUngrab for the most recent grab. Is called automatically on	1621	Calls XUngrab for the most recent grab. Is called automatically on
1419	evaluation errors, as it is better to lose the grab in the error case as	1622	evaluation errors, as it is better to lose the grab in the error case as
1420	the session.	1623	the session.
1421		1624
		1625	=item $atom = $term->XInternAtom ($atom_name[, $only_if_exists])
		1626
		1627	=item $atom_name = $term->XGetAtomName ($atom)
		1628
		1629	=item @atoms = $term->XListProperties ($window)
		1630
		1631	=item ($type,$format,$octets) = $term->XGetWindowProperty ($window, $property)
		1632
		1633	=item $term->XChangeWindowProperty ($window, $property, $type, $format, $octets)
		1634
		1635	=item $term->XDeleteProperty ($window, $property)
		1636
		1637	=item $window = $term->DefaultRootWindow
		1638
		1639	=item $term->XReparentWindow ($window, $parent, [$x, $y])
		1640
		1641	=item $term->XMapWindow ($window)
		1642
		1643	=item $term->XUnmapWindow ($window)
		1644
		1645	=item $term->XMoveResizeWindow ($window, $x, $y, $width, $height)
		1646
		1647	=item ($x, $y, $child_window) = $term->XTranslateCoordinates ($src, $dst, $x, $y)
		1648
		1649	=item $term->XChangeInput ($window, $add_events[, $del_events])
		1650
		1651	Various X or X-related functions. The C<$term> object only serves as
		1652	the source of the display, otherwise those functions map more-or-less
		1653	directory onto the X functions of the same name.
		1654
1422	=back	1655	=back
1423		1656
1424	=cut	1657	=cut
1425		1658
1426	package urxvt::popup;	1659	package urxvt::popup;
…		…
1527	my $env = $self->{term}->env;	1760	my $env = $self->{term}->env;
1528	# we can't hope to reproduce the locale algorithm, so nuke LC_ALL and set LC_CTYPE.	1761	# we can't hope to reproduce the locale algorithm, so nuke LC_ALL and set LC_CTYPE.
1529	delete $env->{LC_ALL};	1762	delete $env->{LC_ALL};
1530	$env->{LC_CTYPE} = $self->{term}->locale;	1763	$env->{LC_CTYPE} = $self->{term}->locale;
1531		1764
1532	urxvt::term->new ($env, $self->{term}->resource ("name"),	1765	urxvt::term->new ($env, "popup",
1533	"--perl-lib" => "", "--perl-ext-common" => "", "-pty-fd" => -1, "-sl" => 0, "-b" => 0,	1766	"--perl-lib" => "", "--perl-ext-common" => "",
		1767	"-pty-fd" => -1, "-sl" => 0,
		1768	"-b" => 1, "-bd" => "grey80", "-bl", "-override-redirect",
1534	"--transient-for" => $self->{term}->parent,	1769	"--transient-for" => $self->{term}->parent,
1535	"-display" => $self->{term}->display_id,	1770	"-display" => $self->{term}->display_id,
1536	"-pe" => "urxvt-popup")	1771	"-pe" => "urxvt-popup")
1537	or die "unable to create popup window\n";	1772	or die "unable to create popup window\n";
1538	}	1773	}
…		…
1543	delete $self->{term}{_destroy}{$self};	1778	delete $self->{term}{_destroy}{$self};
1544	$self->{term}->ungrab;	1779	$self->{term}->ungrab;
1545	}	1780	}
1546		1781
1547	=back	1782	=back
		1783
		1784	=cut
		1785
		1786	package urxvt::watcher;
		1787
		1788	@urxvt::timer::ISA = __PACKAGE__;
		1789	@urxvt::iow::ISA = __PACKAGE__;
		1790	@urxvt::pw::ISA = __PACKAGE__;
		1791	@urxvt::iw::ISA = __PACKAGE__;
1548		1792
1549	=head2 The C<urxvt::timer> Class	1793	=head2 The C<urxvt::timer> Class
1550		1794
1551	This class implements timer watchers/events. Time is represented as a	1795	This class implements timer watchers/events. Time is represented as a
1552	fractional number of seconds since the epoch. Example:	1796	fractional number of seconds since the epoch. Example:
…		…
1590	Start the timer.	1834	Start the timer.
1591		1835
1592	=item $timer = $timer->start ($tstamp)	1836	=item $timer = $timer->start ($tstamp)
1593		1837
1594	Set the event trigger time to C<$tstamp> and start the timer.	1838	Set the event trigger time to C<$tstamp> and start the timer.
		1839
		1840	=item $timer = $timer->after ($delay)
		1841
		1842	Like C<start>, but sets the expiry timer to c<urxvt::NOW + $delay>.
1595		1843
1596	=item $timer = $timer->stop	1844	=item $timer = $timer->stop
1597		1845
1598	Stop the timer.	1846	Stop the timer.
1599		1847
…		…
1646		1894
1647	Stop watching for events on the given filehandle.	1895	Stop watching for events on the given filehandle.
1648		1896
1649	=back	1897	=back
1650		1898
		1899	=head2 The C<urxvt::iw> Class
		1900
		1901	This class implements idle watchers, that get called automatically when
		1902	the process is idle. They should return as fast as possible, after doing
		1903	some useful work.
		1904
		1905	=over 4
		1906
		1907	=item $iw = new urxvt::iw
		1908
		1909	Create a new idle watcher object in stopped state.
		1910
		1911	=item $iw = $iw->cb (sub { my ($iw) = @_; ... })
		1912
		1913	Set the callback to be called when the watcher triggers.
		1914
		1915	=item $timer = $timer->start
		1916
		1917	Start the watcher.
		1918
		1919	=item $timer = $timer->stop
		1920
		1921	Stop the watcher.
		1922
		1923	=back
		1924
		1925	=head2 The C<urxvt::pw> Class
		1926
		1927	This class implements process watchers. They create an event whenever a
		1928	process exits, after which they stop automatically.
		1929
		1930	my $pid = fork;
		1931	...
		1932	$term->{pw} = urxvt::pw
		1933	->new
		1934	->start ($pid)
		1935	->cb (sub {
		1936	my ($pw, $exit_status) = @_;
		1937	...
		1938	});
		1939
		1940	=over 4
		1941
		1942	=item $pw = new urxvt::pw
		1943
		1944	Create a new process watcher in stopped state.
		1945
		1946	=item $pw = $pw->cb (sub { my ($pw, $exit_status) = @_; ... })
		1947
		1948	Set the callback to be called when the timer triggers.
		1949
		1950	=item $pw = $timer->start ($pid)
		1951
		1952	Tells the wqtcher to start watching for process C<$pid>.
		1953
		1954	=item $pw = $pw->stop
		1955
		1956	Stop the watcher.
		1957
		1958	=back
		1959
1651	=head1 ENVIRONMENT	1960	=head1 ENVIRONMENT
1652		1961
1653	=head2 URXVT_PERL_VERBOSITY	1962	=head2 URXVT_PERL_VERBOSITY
1654		1963
1655	This variable controls the verbosity level of the perl extension. Higher	1964	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.91 by root, Fri Jan 13 01:09:37 2006 UTC vs. Revision 1.127 by root, Wed Jan 25 00:42:21 2006 UTC

Diff Legend

Comparing rxvt-unicode/src/urxvt.pm (file contents):
Revision 1.91 by root, Fri Jan 13 01:09:37 2006 UTC vs.
Revision 1.127 by root, Wed Jan 25 00:42:21 2006 UTC