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

Comparing rxvt-unicode/src/urxvt.pm (file contents):
Revision 1.86 by root, Thu Jan 12 05:22:47 2006 UTC vs.
Revision 1.122 by root, Sat Jan 21 08:07:38 2006 UTC

…		…
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		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
		43
40	=over 4	44	=over 4
41		45
42	=item selection (enabled by default)	46	=item selection (enabled by default)
43		47
44	(More) intelligent selection. This extension tries to be more intelligent	48	(More) intelligent selection. This extension tries to be more intelligent
45	when the user extends selections (double-click). Right now, it tries to	49	when the user extends selections (double-click and further clicks). Right
46	select urls and complete shell-quoted arguments, which is very convenient,	50	now, it tries to select words, urls and complete shell-quoted
47	too, if your F<ls> supports C<--quoting-style=shell>.	51	arguments, which is very convenient, too, if your F<ls> supports
		52	C<--quoting-style=shell>.
48		53
		54	A double-click usually selects the word under the cursor, further clicks
		55	will enlarge the selection.
		56
		57	The selection works by trying to match a number of regexes and displaying
		58	them in increasing order of length. You can add your own regexes by
		59	specifying resources of the form:
		60
		61	URxvt.selection.pattern-0: perl-regex
		62	URxvt.selection.pattern-1: perl-regex
		63	...
		64
		65	The index number (0, 1...) must not have any holes, and each regex must
		66	contain at least one pair of capturing parentheses, which will be used for
		67	the match. For example, the followign adds a regex that matches everything
		68	between two vertical bars:
		69
		70	URxvt.selection.pattern-0: \\\|([^\|]+)\\\|
		71
		72	You can look at the source of the selection extension to see more
		73	interesting uses, such as parsing a line from beginning to end.
		74
49	It also offers the following bindable keyboard command:	75	This extension also offers following bindable keyboard commands:
50		76
51	=over 4	77	=over 4
52		78
53	=item rot13	79	=item rot13
54		80
…		…
65		91
66	=item selection-popup (enabled by default)	92	=item selection-popup (enabled by default)
67		93
68	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
69	text into various other formats/action (such as uri unescaping, perl	95	text into various other formats/action (such as uri unescaping, perl
70	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	};
71		116
72	=item searchable-scrollback<hotkey> (enabled by default)	117	=item searchable-scrollback<hotkey> (enabled by default)
73		118
74	Adds regex search functionality to the scrollback buffer, triggered	119	Adds regex search functionality to the scrollback buffer, triggered
75	by a hotkey (default: C<M-s>). When in search mode, normal terminal	120	by a hotkey (default: C<M-s>). While in search mode, normal terminal
76	input/output is suspended.	121	input/output is suspended and a regex is displayed at the bottom of the
		122	screen.
77		123
78	C</> starts an incremental regex search, C<n> searches further, C<p> or	124	Inputting characters appends them to the regex and continues incremental
79	C<N> jump to the previous match, C<G> jumps to the bottom and clears the	125	search. C<BackSpace> removes a character from the regex, C<Up> and C<Down>
80	history, C<enter> leaves search mode at the current position and C<escape>	126	search upwards/downwards in the scrollback buffer, C<End> jumps to the
81	returns to the original position.	127	bottom. C<Escape> leaves search mode and returns to the point where search
		128	was started, while C<Enter> or C<Return> stay at the current position and
		129	additionally stores the first match in the current line into the primary
		130	selection.
82		131
83	=item digital-clock	132	=item selection-autotransform
84		133
85	Displays a digital clock using the built-in overlay.	134	This selection allows you to do automatic transforms on a selection
		135	whenever a selection is made.
		136
		137	It works by specifying perl snippets (most useful is a single C<s///>
		138	operator) that modify C<$_> as resources:
		139
		140	URxvt.selection-autotransform.0: transform
		141	URxvt.selection-autotransform.1: transform
		142	...
		143
		144	For example, the following will transform selections of the form
		145	C<filename:number>, often seen in compiler messages, into C<vi +$filename
		146	$word>:
		147
		148	URxvt.selection-autotransform.0: s/^([^:[:space:]]+):(\\d+):?$/vi +$2 \\Q$1\\E\\x0d/
		149
		150	And this example matches the same,but replaces it with vi-commands you can
		151	paste directly into your (vi :) editor:
		152
		153	URxvt.selection-autotransform.0: s/^([^:[:space:]]+(\\d+):?$/:e \\Q$1\\E\\x0d:$2\\x0d/
		154
		155	Of course, this can be modified to suit your needs and your editor :)
		156
		157	To expand the example above to typical perl error messages ("XXX at
		158	FILENAME line YYY."), you need a slightly more elaborate solution:
		159
		160	URxvt.selection.pattern-0: ( at .*? line \\d+[,.])
		161	URxvt.selection-autotransform.0: s/^ at (.*?) line (\\d+)[,.]$/:e \\Q$1\E\\x0d:$2\\x0d/
		162
		163	The first line tells the selection code to treat the unchanging part of
		164	every error message as a selection pattern, and the second line transforms
		165	the message into vi commands to load the file.
		166
		167	=item readline
		168
		169	A support package that tries to make editing with readline easier. At the
		170	moment, it reacts to clicking with the left mouse button by trying to
		171	move the text cursor to this position. It does so by generating as many
		172	cursor-left or cursor-right keypresses as required (the this only works
		173	for programs that correctly support wide characters).
		174
		175	To avoid too many false positives, this is only done when:
		176
		177	=over 4
		178
		179	=item - the mouse is on the same (multi-row-) line as the text cursor.
		180
		181	=item - the primary screen is currently being displayed.
		182
		183	=item - the text cursor is visible.
		184
		185	=back
		186
		187	The normal selection mechanism isn't disabled, so quick successive clicks
		188	might interfere with selection creation in harmless ways.
		189
		190	=item tabbed
		191
		192	This transforms the terminal into a tabbar with additional terminals, that
		193	is, it implements what is commonly refered to as "tabbed terminal". The topmost line
		194	displays a "[NEW]" button, which, when clicked, will add a new tab, followed by one
		195	button per tab.
		196
		197	Clicking a button will activate that tab. Pressing B<Shift-Left> and
		198	B<Shift-Right> will switch to the tab left or right of the current one,
		199	while B<Shift-Down> creates a new tab.
86		200
87	=item mark-urls	201	=item mark-urls
88		202
89	Uses per-line display filtering (C<on_line_update>) to underline urls and	203	Uses per-line display filtering (C<on_line_update>) to underline urls and
90	make them clickable. When middle-clicked, the program specified in the	204	make them clickable. When middle-clicked, the program specified in the
91	resource C<urlLauncher> (default C<x-www-browser>) will be started.	205	resource C<urlLauncher> (default C<x-www-browser>) will be started with
		206	the URL as first argument.
		207
		208	=item automove-background
		209
		210	This is basically a one-line extension that dynamically changes the background pixmap offset
		211	to the window position, in effect creating the same effect as pseudo transparency with
		212	a custom pixmap. No scaling is supported in this mode. Exmaple:
		213
		214	@@RXVT_NAME@@ -pixmap background.xpm -pe automove-background
92		215
93	=item block-graphics-to-ascii	216	=item block-graphics-to-ascii
94		217
95	A not very useful example of filtering all text output to the terminal,	218	A not very useful example of filtering all text output to the terminal,
96	by replacing all line-drawing characters (U+2500 .. U+259F) by a	219	by replacing all line-drawing characters (U+2500 .. U+259F) by a
97	similar-looking ascii character.	220	similar-looking ascii character.
98		221
		222	=item digital-clock
		223
		224	Displays a digital clock using the built-in overlay.
		225
99	=item example-refresh-hooks	226	=item example-refresh-hooks
100		227
101	Displays a very simple digital clock in the upper right corner of the	228	Displays a very simple digital clock in the upper right corner of the
102	window. Illustrates overwriting the refresh callbacks to create your own	229	window. Illustrates overwriting the refresh callbacks to create your own
103	overlays or changes.	230	overlays or changes.
		231
		232	=item selection-pastebin
		233
		234	This is a little rarely useful extension that Uploads the selection as
		235	textfile to a remote site (or does other things). (The implementation is
		236	not currently secure for use in a multiuser environment as it writes to
		237	F</tmp> directly.).
		238
		239	It listens to the C<selection-pastebin:remote-pastebin> keyboard command,
		240	i.e.
		241
		242	URxvt.keysym.C-M-e: perl:selection-pastebin:remote-pastebin
		243
		244	Pressing this combination runs a command with C<%> replaced by the name of
		245	the textfile. This command can be set via a resource:
		246
		247	URxvt.selection-pastebin.cmd: rsync -apP % ruth:/var/www/www.ta-sa.org/files/txt/.
		248
		249	And the default is likely not useful to anybody but the few people around
		250	here :)
		251
		252	The name of the textfile is the hex encoded md5 sum of the selection, so
		253	the same content should lead to the same filename.
		254
		255	After a successful upload the selection will be replaced by the text given
		256	in the C<selection-pastebin-url> resource (again, the % is the placeholder
		257	for the filename):
		258
		259	URxvt.selection-pastebin.url: http://www.ta-sa.org/files/txt/%
104		260
105	=back	261	=back
106		262
107	=head1 API DOCUMENTATION	263	=head1 API DOCUMENTATION
108		264
…		…
181	called whenever the relevant event happens.	337	called whenever the relevant event happens.
182		338
183	The first argument passed to them is an extension oject as described in	339	The first argument passed to them is an extension oject as described in
184	the in the C<Extension Objects> section.	340	the in the C<Extension Objects> section.
185		341
186	B<All> of these hooks must return a boolean value. If it is true, then the	342	B<All> of these hooks must return a boolean value. If any of the called
187	event counts as being I<consumed>, and the invocation of other hooks is	343	hooks returns true, then the event counts as being I<consumed>, and the
188	skipped, and the relevant action might not be carried out by the C++ code.	344	relevant action might not be carried out by the C++ code.
189		345
190	I<< When in doubt, return a false value (preferably C<()>). >>	346	I<< When in doubt, return a false value (preferably C<()>). >>
191		347
192	=over 4	348	=over 4
193		349
194	=item on_init $term	350	=item on_init $term
195		351
196	Called after a new terminal object has been initialized, but before	352	Called after a new terminal object has been initialized, but before
197	windows are created or the command gets run. Most methods are unsafe to	353	windows are created or the command gets run. Most methods are unsafe to
198	call or deliver senseless data, as terminal size and other characteristics	354	call or deliver senseless data, as terminal size and other characteristics
199	have not yet been determined. You can safely query and change resources,	355	have not yet been determined. You can safely query and change resources
200	though.	356	and options, though. For many purposes the C<on_start> hook is a better
		357	place.
		358
		359	=item on_start $term
		360
		361	Called at the very end of initialisation of a new terminal, just before
		362	trying to map (display) the toplevel and returning to the mainloop.
		363
		364	=item on_destroy $term
		365
		366	Called whenever something tries to destroy terminal, before doing anything
		367	yet. If this hook returns true, then destruction is skipped, but this is
		368	rarely a good idea.
201		369
202	=item on_reset $term	370	=item on_reset $term
203		371
204	Called after the screen is "reset" for any reason, such as resizing or	372	Called after the screen is "reset" for any reason, such as resizing or
205	control sequences. Here is where you can react on changes to size-related	373	control sequences. Here is where you can react on changes to size-related
206	variables.	374	variables.
207		375
208	=item on_start $term	376	=item on_child_start $term, $pid
209		377
210	Called at the very end of initialisation of a new terminal, just before	378	Called just after the child process has been C<fork>ed.
211	returning to the mainloop.	379
		380	=item on_child_exit $term, $status
		381
		382	Called just after the child process has exited. C<$status> is the status
		383	from C<waitpid>.
212		384
213	=item on_sel_make $term, $eventtime	385	=item on_sel_make $term, $eventtime
214		386
215	Called whenever a selection has been made by the user, but before the	387	Called whenever a selection has been made by the user, but before the
216	selection text is copied, so changes to the beginning, end or type of the	388	selection text is copied, so changes to the beginning, end or type of the
…		…
309		481
310	Called whenever the user presses a key combination that has a	482	Called whenever the user presses a key combination that has a
311	C<perl:string> action bound to it (see description of the B<keysym>	483	C<perl:string> action bound to it (see description of the B<keysym>
312	resource in the @@RXVT_NAME@@(1) manpage).	484	resource in the @@RXVT_NAME@@(1) manpage).
313		485
		486	=item on_x_event $term, $event
		487
		488	Called on every X event received on the vt window (and possibly other
		489	windows). Should only be used as a last resort. Most event structure
		490	members are not passed.
		491
314	=item on_focus_in $term	492	=item on_focus_in $term
315		493
316	Called whenever the window gets the keyboard focus, before rxvt-unicode	494	Called whenever the window gets the keyboard focus, before rxvt-unicode
317	does focus in processing.	495	does focus in processing.
318		496
319	=item on_focus_out $term	497	=item on_focus_out $term
320		498
321	Called wheneever the window loses keyboard focus, before rxvt-unicode does	499	Called wheneever the window loses keyboard focus, before rxvt-unicode does
322	focus out processing.	500	focus out processing.
323		501
		502	=item on_configure_notify $term, $event
		503
		504	=item on_property_notify $term, $event
		505
324	=item on_key_press $term, $event, $keysym, $octets	506	=item on_key_press $term, $event, $keysym, $octets
325		507
326	=item on_key_release $term, $event, $keysym	508	=item on_key_release $term, $event, $keysym
327		509
328	=item on_button_press $term, $event	510	=item on_button_press $term, $event
…		…
337		519
338	Called whenever the corresponding X event is received for the terminal If	520	Called whenever the corresponding X event is received for the terminal If
339	the hook returns true, then the even will be ignored by rxvt-unicode.	521	the hook returns true, then the even will be ignored by rxvt-unicode.
340		522
341	The event is a hash with most values as named by Xlib (see the XEvent	523	The event is a hash with most values as named by Xlib (see the XEvent
342	manpage), with the additional members C<row> and C<col>, which are the row	524	manpage), with the additional members C<row> and C<col>, which are the
343	and column under the mouse cursor.	525	(real, not screen-based) row and column under the mouse cursor.
344		526
345	C<on_key_press> additionally receives the string rxvt-unicode would	527	C<on_key_press> additionally receives the string rxvt-unicode would
346	output, if any, in locale-specific encoding.	528	output, if any, in locale-specific encoding.
347		529
348	subwindow.	530	subwindow.
		531
		532	=item on_client_message $term, $event
		533
		534	=item on_wm_protocols $term, $event
		535
		536	=item on_wm_delete_window $term, $event
		537
		538	Called when various types of ClientMessage events are received (all with
		539	format=32, WM_PROTOCOLS or WM_PROTOCOLS:WM_DELETE_WINDOW).
349		540
350	=back	541	=back
351		542
352	=cut	543	=cut
353		544
…		…
359	use Scalar::Util ();	550	use Scalar::Util ();
360	use List::Util ();	551	use List::Util ();
361		552
362	our $VERSION = 1;	553	our $VERSION = 1;
363	our $TERM;	554	our $TERM;
		555	our @TERM_INIT;
		556	our @TERM_EXT;
364	our @HOOKNAME;	557	our @HOOKNAME;
365	our %HOOKTYPE = map +($HOOKNAME[$_] => $_), 0..$#HOOKNAME;	558	our %HOOKTYPE = map +($HOOKNAME[$_] => $_), 0..$#HOOKNAME;
366	our %OPTION;	559	our %OPTION;
367		560
368	our $LIBDIR;	561	our $LIBDIR;
369	our $RESNAME;	562	our $RESNAME;
370	our $RESCLASS;	563	our $RESCLASS;
371	our $RXVTNAME;	564	our $RXVTNAME;
372		565
		566	our $NOCHAR = chr 0xfffe;
		567
373	=head2 Variables in the C<urxvt> Package	568	=head2 Variables in the C<urxvt> Package
374		569
375	=over 4	570	=over 4
376		571
377	=item $urxvt::LIBDIR	572	=item $urxvt::LIBDIR
…		…
389		584
390	=item $urxvt::TERM	585	=item $urxvt::TERM
391		586
392	The current terminal. This variable stores the current C<urxvt::term>	587	The current terminal. This variable stores the current C<urxvt::term>
393	object, whenever a callback/hook is executing.	588	object, whenever a callback/hook is executing.
		589
		590	=item @urxvt::TERM_INIT
		591
		592	All coderefs in this array will be called as methods of the next newly
		593	created C<urxvt::term> object (during the C<on_init> phase). The array
		594	gets cleared before the codereferences that were in it are being executed,
		595	so coderefs can push themselves onto it again if they so desire.
		596
		597	This complements to the perl-eval commandline option, but gets executed
		598	first.
		599
		600	=item @urxvt::TERM_EXT
		601
		602	Works similar to C<@TERM_INIT>, but contains perl package/class names, which
		603	get registered as normal extensions after calling the hooks in C<@TERM_INIT>
		604	but before other extensions. Gets cleared just like C<@TERM_INIT>.
394		605
395	=back	606	=back
396		607
397	=head2 Functions in the C<urxvt> Package	608	=head2 Functions in the C<urxvt> Package
398		609
…		…
413	Using this function has the advantage that its output ends up in the	624	Using this function has the advantage that its output ends up in the
414	correct place, e.g. on stderr of the connecting urxvtc client.	625	correct place, e.g. on stderr of the connecting urxvtc client.
415		626
416	Messages have a size limit of 1023 bytes currently.	627	Messages have a size limit of 1023 bytes currently.
417		628
418	=item $is_safe = urxvt::safe
419
420	Returns true when it is safe to do potentially unsafe things, such as
421	evaluating perl code specified by the user. This is true when urxvt was
422	started setuid or setgid.
423
424	=item $time = urxvt::NOW	629	=item $time = urxvt::NOW
425		630
426	Returns the "current time" (as per the event loop).	631	Returns the "current time" (as per the event loop).
427		632
428	=item urxvt::CurrentTime	633	=item urxvt::CurrentTime
429		634
430	=item urxvt::ShiftMask, LockMask, ControlMask, Mod1Mask, Mod2Mask,	635	=item urxvt::ShiftMask, LockMask, ControlMask, Mod1Mask, Mod2Mask,
431	Mod3Mask, Mod4Mask, Mod5Mask, Button1Mask, Button2Mask, Button3Mask,	636	Mod3Mask, Mod4Mask, Mod5Mask, Button1Mask, Button2Mask, Button3Mask,
432	Button4Mask, Button5Mask, AnyModifier	637	Button4Mask, Button5Mask, AnyModifier
		638
		639	=item urxvt::NoEventMask, KeyPressMask, KeyReleaseMask,
		640	ButtonPressMask, ButtonReleaseMask, EnterWindowMask, LeaveWindowMask,
		641	PointerMotionMask, PointerMotionHintMask, Button1MotionMask, Button2MotionMask,
		642	Button3MotionMask, Button4MotionMask, Button5MotionMask, ButtonMotionMask,
		643	KeymapStateMask, ExposureMask, VisibilityChangeMask, StructureNotifyMask,
		644	ResizeRedirectMask, SubstructureNotifyMask, SubstructureRedirectMask,
		645	FocusChangeMask, PropertyChangeMask, ColormapChangeMask, OwnerGrabButtonMask
		646
		647	=item urxvt::KeyPress, KeyRelease, ButtonPress, ButtonRelease, MotionNotify,
		648	EnterNotify, LeaveNotify, FocusIn, FocusOut, KeymapNotify, Expose,
		649	GraphicsExpose, NoExpose, VisibilityNotify, CreateNotify, DestroyNotify,
		650	UnmapNotify, MapNotify, MapRequest, ReparentNotify, ConfigureNotify,
		651	ConfigureRequest, GravityNotify, ResizeRequest, CirculateNotify,
		652	CirculateRequest, PropertyNotify, SelectionClear, SelectionRequest,
		653	SelectionNotify, ColormapNotify, ClientMessage, MappingNotify
433		654
434	Various constants for use in X calls and event processing.	655	Various constants for use in X calls and event processing.
435		656
436	=back	657	=back
437		658
…		…
488	=back	709	=back
489		710
490	=cut	711	=cut
491		712
492	BEGIN {	713	BEGIN {
493	urxvt->bootstrap;
494
495	# overwrite perl's warn	714	# overwrite perl's warn
496	*CORE::GLOBAL::warn = sub {	715	*CORE::GLOBAL::warn = sub {
497	my $msg = join "", @_;	716	my $msg = join "", @_;
498	$msg .= "\n"	717	$msg .= "\n"
499	unless $msg =~ /\n$/;	718	unless $msg =~ /\n$/;
500	urxvt::warn ($msg);	719	urxvt::warn ($msg);
501	};	720	};
502
503	# %ENV is the original startup environment
504	delete $ENV{IFS};
505	delete $ENV{CDPATH};
506	delete $ENV{BASH_ENV};
507	$ENV{PATH} = "/bin:/sbin:/usr/bin:/usr/sbin:/usr/local/bin:/usr/local/sbin:/opt/bin:/opt/sbin";
508	}	721	}
509		722
510	my @hook_count;
511	my $verbosity = $ENV{URXVT_PERL_VERBOSITY};	723	my $verbosity = $ENV{URXVT_PERL_VERBOSITY};
512		724
513	sub verbose {	725	sub verbose {
514	my ($level, $msg) = @_;	726	my ($level, $msg) = @_;
515	warn "$msg\n" if $level <= $verbosity;	727	warn "$msg\n" if $level <= $verbosity;
516	}	728	}
517		729
518	my $extension_pkg = "extension0000";
519	my %extension_pkg;	730	my %extension_pkg;
520		731
521	# load a single script into its own package, once only	732	# load a single script into its own package, once only
522	sub extension_package($) {	733	sub extension_package($) {
523	my ($path) = @_;	734	my ($path) = @_;
524		735
525	$extension_pkg{$path} \|\|= do {	736	$extension_pkg{$path} \|\|= do {
526	my $pkg = "urxvt::" . ($extension_pkg++);	737	$path =~ /([^\/\\]+)$/;
		738	my $pkg = $1;
		739	$pkg =~ s/[^[:word:]]/_/g;
		740	$pkg = "urxvt::ext::$pkg";
527		741
528	verbose 3, "loading extension '$path' into package '$pkg'";	742	verbose 3, "loading extension '$path' into package '$pkg'";
529		743
530	open my $fh, "<:raw", $path	744	open my $fh, "<:raw", $path
531	or die "$path: $!";	745	or die "$path: $!";
532		746
533	my $source = untaint	747	my $source =
534	"package $pkg; use strict; use utf8;\n"	748	"package $pkg; use strict; use utf8;\n"
535	. "use base urxvt::term::extension::;\n"
536	. "#line 1 \"$path\"\n{\n"	749	. "#line 1 \"$path\"\n{\n"
537	. (do { local $/; <$fh> })	750	. (do { local $/; <$fh> })
538	. "\n};\n1";	751	. "\n};\n1";
539		752
540	eval $source	753	eval $source
…		…
554	if ($htype == 0) { # INIT	767	if ($htype == 0) { # INIT
555	my @dirs = ((split /:/, $TERM->resource ("perl_lib")), "$LIBDIR/perl");	768	my @dirs = ((split /:/, $TERM->resource ("perl_lib")), "$LIBDIR/perl");
556		769
557	my %ext_arg;	770	my %ext_arg;
558		771
		772	{
		773	my @init = @TERM_INIT;
		774	@TERM_INIT = ();
		775	$_->($TERM) for @init;
		776	my @pkg = @TERM_EXT;
		777	@TERM_EXT = ();
		778	$TERM->register_package ($_) for @pkg;
		779	}
		780
559	for (map { split /,/, $TERM->resource ("perl_ext_$_") } 1, 2) {	781	for (grep $_, map { split /,/, $TERM->resource ("perl_ext_$_") } 1, 2) {
560	if ($_ eq "default") {	782	if ($_ eq "default") {
561	$ext_arg{$_} \|\|= [] for qw(selection option-popup selection-popup searchable-scrollback);	783	$ext_arg{$_} \|\|= [] for qw(selection option-popup selection-popup searchable-scrollback);
562	} elsif (/^-(.*)$/) {	784	} elsif (/^-(.*)$/) {
563	delete $ext_arg{$1};	785	delete $ext_arg{$1};
564	} elsif (/^([^<]+)<(.*)>$/) {	786	} elsif (/^([^<]+)<(.*)>$/) {
…		…
589	if $verbosity >= 10;	811	if $verbosity >= 10;
590		812
591	keys %$cb;	813	keys %$cb;
592		814
593	while (my ($pkg, $cb) = each %$cb) {	815	while (my ($pkg, $cb) = each %$cb) {
594	$retval = eval { $cb->($TERM->{_pkg}{$pkg}, @_) }	816	my $retval_ = eval { $cb->($TERM->{_pkg}{$pkg}, @_) };
595	and last;	817	$retval \|\|= $retval_;
596		818
597	if ($@) {	819	if ($@) {
598	$TERM->ungrab; # better to lose the grab than the session	820	$TERM->ungrab; # better to lose the grab than the session
599	warn $@;	821	warn $@;
600	}	822	}
…		…
603	verbose 11, "$HOOKNAME[$htype] returning <$retval>"	825	verbose 11, "$HOOKNAME[$htype] returning <$retval>"
604	if $verbosity >= 11;	826	if $verbosity >= 11;
605	}	827	}
606		828
607	if ($htype == 1) { # DESTROY	829	if ($htype == 1) { # DESTROY
608	if (my $hook = delete $TERM->{_hook}) {
609	for my $htype (0..$#$hook) {
610	$hook_count[$htype] -= scalar keys %{ $hook->[$htype] \|\| {} }
611	or set_should_invoke $htype, 0;
612	}
613	}
614
615	# clear package objects	830	# clear package objects
616	%$_ = () for values %{ $TERM->{_pkg} };	831	%$_ = () for values %{ $TERM->{_pkg} };
617		832
618	# clear package	833	# clear package
619	%$TERM = ();	834	%$TERM = ();
620	}	835	}
621		836
622	$retval	837	$retval
623	}
624
625	sub exec_async(@) {
626	my $pid = fork;
627
628	return
629	if !defined $pid or $pid;
630
631	%ENV = %{ $TERM->env };
632
633	exec @_;
634	_exit 255;
635	}	838	}
636		839
637	# urxvt::term::extension	840	# urxvt::term::extension
638		841
639	package urxvt::term::extension;	842	package urxvt::term::extension;
…		…
645	while (my ($name, $cb) = each %hook) {	848	while (my ($name, $cb) = each %hook) {
646	my $htype = $HOOKTYPE{uc $name};	849	my $htype = $HOOKTYPE{uc $name};
647	defined $htype	850	defined $htype
648	or Carp::croak "unsupported hook type '$name'";	851	or Carp::croak "unsupported hook type '$name'";
649		852
		853	$self->set_should_invoke ($htype, +1)
650	unless (exists $self->{term}{_hook}[$htype]{$pkg}) {	854	unless exists $self->{term}{_hook}[$htype]{$pkg};
651	$hook_count[$htype]++
652	or urxvt::set_should_invoke $htype, 1;
653	}
654		855
655	$self->{term}{_hook}[$htype]{$pkg} = $cb;	856	$self->{term}{_hook}[$htype]{$pkg} = $cb;
656	}	857	}
657	}	858	}
658		859
…		…
663	for my $name (@hook) {	864	for my $name (@hook) {
664	my $htype = $HOOKTYPE{uc $name};	865	my $htype = $HOOKTYPE{uc $name};
665	defined $htype	866	defined $htype
666	or Carp::croak "unsupported hook type '$name'";	867	or Carp::croak "unsupported hook type '$name'";
667		868
		869	$self->set_should_invoke ($htype, -1)
668	if (delete $self->{term}{_hook}[$htype]{$pkg}) {	870	if delete $self->{term}{_hook}[$htype]{$pkg};
669	--$hook_count[$htype]
670	or urxvt::set_should_invoke $htype, 0;
671	}
672	}	871	}
673	}	872	}
674		873
675	our $AUTOLOAD;	874	our $AUTOLOAD;
676		875
…		…
782	# find on_xxx subs in the package and register them	981	# find on_xxx subs in the package and register them
783	# as hooks	982	# as hooks
784	sub register_package {	983	sub register_package {
785	my ($self, $pkg, $argv) = @_;	984	my ($self, $pkg, $argv) = @_;
786		985
		986	no strict 'refs';
		987
		988	urxvt::verbose 6, "register package $pkg to $self";
		989
		990	@{"$pkg\::ISA"} = urxvt::term::extension::;
		991
787	my $proxy = bless {	992	my $proxy = bless {
788	_pkg => $pkg,	993	_pkg => $pkg,
789	argv => $argv,	994	argv => $argv,
790	}, $pkg;	995	}, $pkg;
791	Scalar::Util::weaken ($proxy->{term} = $self);	996	Scalar::Util::weaken ($proxy->{term} = $self);
…		…
822		1027
823	Destroy the terminal object (close the window, free resources	1028	Destroy the terminal object (close the window, free resources
824	etc.). Please note that @@RXVT_NAME@@ will not exit as long as any event	1029	etc.). Please note that @@RXVT_NAME@@ will not exit as long as any event
825	watchers (timers, io watchers) are still active.	1030	watchers (timers, io watchers) are still active.
826		1031
		1032	=item $term->exec_async ($cmd[, @args])
		1033
		1034	Works like the combination of the C<fork>/C<exec> builtins, which executes
		1035	("starts") programs in the background. This function takes care of setting
		1036	the user environment before exec'ing the command (e.g. C<PATH>) and should
		1037	be preferred over explicit calls to C<exec> or C<system>.
		1038
		1039	Returns the pid of the subprocess or C<undef> on error.
		1040
		1041	=cut
		1042
		1043	sub exec_async {
		1044	my $self = shift;
		1045
		1046	my $pid = fork;
		1047
		1048	return $pid
		1049	if !defined $pid or $pid;
		1050
		1051	%ENV = %{ $self->env };
		1052
		1053	exec @_;
		1054	urxvt::_exit 255;
		1055	}
		1056
827	=item $isset = $term->option ($optval[, $set])	1057	=item $isset = $term->option ($optval[, $set])
828		1058
829	Returns true if the option specified by C<$optval> is enabled, and	1059	Returns true if the option specified by C<$optval> is enabled, and
830	optionally change it. All option values are stored by name in the hash	1060	optionally change it. All option values are stored by name in the hash
831	C<%urxvt::OPTION>. Options not enabled in this binary are not in the hash.	1061	C<%urxvt::OPTION>. Options not enabled in this binary are not in the hash.
…		…
833	Here is a a likely non-exhaustive list of option names, please see the	1063	Here is a a likely non-exhaustive list of option names, please see the
834	source file F</src/optinc.h> to see the actual list:	1064	source file F</src/optinc.h> to see the actual list:
835		1065
836	borderLess console cursorBlink cursorUnderline hold iconic insecure	1066	borderLess console cursorBlink cursorUnderline hold iconic insecure
837	intensityStyles jumpScroll loginShell mapAlert meta8 mouseWheelScrollPage	1067	intensityStyles jumpScroll loginShell mapAlert meta8 mouseWheelScrollPage
838	pastableTabs pointerBlank reverseVideo scrollBar scrollBar_floating	1068	override-redirect pastableTabs pointerBlank reverseVideo scrollBar
839	scrollBar_right scrollTtyKeypress scrollTtyOutput scrollWithBuffer	1069	scrollBar_floating scrollBar_right scrollTtyKeypress scrollTtyOutput
840	secondaryScreen secondaryScroll skipBuiltinGlyphs transparent	1070	scrollWithBuffer secondaryScreen secondaryScroll skipBuiltinGlyphs
841	tripleclickwords utmpInhibit visualBell	1071	transparent tripleclickwords utmpInhibit visualBell
842		1072
843	=item $value = $term->resource ($name[, $newval])	1073	=item $value = $term->resource ($name[, $newval])
844		1074
845	Returns the current resource value associated with a given name and	1075	Returns the current resource value associated with a given name and
846	optionally sets a new value. Setting values is most useful in the C<init>	1076	optionally sets a new value. Setting values is most useful in the C<init>
…		…
863		1093
864	answerbackstring backgroundPixmap backspace_key boldFont boldItalicFont	1094	answerbackstring backgroundPixmap backspace_key boldFont boldItalicFont
865	borderLess color cursorBlink cursorUnderline cutchars delete_key	1095	borderLess color cursorBlink cursorUnderline cutchars delete_key
866	display_name embed ext_bwidth fade font geometry hold iconName	1096	display_name embed ext_bwidth fade font geometry hold iconName
867	imFont imLocale inputMethod insecure int_bwidth intensityStyles	1097	imFont imLocale inputMethod insecure int_bwidth intensityStyles
868	italicFont jumpScroll lineSpace loginShell mapAlert menu meta8 modifier	1098	italicFont jumpScroll lineSpace loginShell mapAlert meta8 modifier
869	mouseWheelScrollPage name pastableTabs path perl_eval perl_ext_1 perl_ext_2	1099	mouseWheelScrollPage name override_redirect pastableTabs path perl_eval
870	perl_lib pointerBlank pointerBlankDelay preeditType print_pipe pty_fd	1100	perl_ext_1 perl_ext_2 perl_lib pointerBlank pointerBlankDelay
871	reverseVideo saveLines scrollBar scrollBar_align scrollBar_floating	1101	preeditType print_pipe pty_fd reverseVideo saveLines scrollBar
872	scrollBar_right scrollBar_thickness scrollTtyKeypress scrollTtyOutput	1102	scrollBar_align scrollBar_floating scrollBar_right scrollBar_thickness
873	scrollWithBuffer scrollstyle secondaryScreen secondaryScroll selectstyle	1103	scrollTtyKeypress scrollTtyOutput scrollWithBuffer scrollstyle
874	shade term_name title transparent transparent_all tripleclickwords	1104	secondaryScreen secondaryScroll selectstyle shade term_name title
875	utmpInhibit visualBell	1105	transient_for transparent transparent_all tripleclickwords utmpInhibit
		1106	visualBell
876		1107
877	=cut	1108	=cut
878		1109
879	sub resource($$;$) {	1110	sub resource($$;$) {
880	my ($self, $name) = (shift, shift);	1111	my ($self, $name) = (shift, shift);
…		…
1054		1285
1055	Normally its not a good idea to use this function, as programs might be	1286	Normally its not a good idea to use this function, as programs might be
1056	confused by changes in cursor position or scrolling. Its useful inside a	1287	confused by changes in cursor position or scrolling. Its useful inside a
1057	C<on_add_lines> hook, though.	1288	C<on_add_lines> hook, though.
1058		1289
		1290	=item $term->scr_change_screen ($screen)
		1291
		1292	Switch to given screen - 0 primary, 1 secondary.
		1293
1059	=item $term->cmd_parse ($octets)	1294	=item $term->cmd_parse ($octets)
1060		1295
1061	Similar to C<scr_add_lines>, but the argument must be in the	1296	Similar to C<scr_add_lines>, but the argument must be in the
1062	locale-specific encoding of the terminal and can contain command sequences	1297	locale-specific encoding of the terminal and can contain command sequences
1063	(escape codes) that will be interpreted.	1298	(escape codes) that will be interpreted.
…		…
1081		1316
1082	=item $windowid = $term->vt	1317	=item $windowid = $term->vt
1083		1318
1084	Return the window id of the terminal window.	1319	Return the window id of the terminal window.
1085		1320
		1321	=item $term->vt_emask_add ($x_event_mask)
		1322
		1323	Adds the specified events to the vt event mask. Useful e.g. when you want
		1324	to receive pointer events all the times:
		1325
		1326	$term->vt_emask_add (urxvt::PointerMotionMask);
		1327
1086	=item $window_width = $term->width	1328	=item $window_width = $term->width
1087		1329
1088	=item $window_height = $term->height	1330	=item $window_height = $term->height
1089		1331
1090	=item $font_width = $term->fwidth	1332	=item $font_width = $term->fwidth
…		…
1103		1345
1104	=item $max_scrollback = $term->saveLines	1346	=item $max_scrollback = $term->saveLines
1105		1347
1106	=item $nrow_plus_saveLines = $term->total_rows	1348	=item $nrow_plus_saveLines = $term->total_rows
1107		1349
1108	=item $lines_in_scrollback = $term->nsaved	1350	=item $topmost_scrollback_row = $term->top_row
1109		1351
1110	Return various integers describing terminal characteristics.	1352	Return various integers describing terminal characteristics.
1111		1353
1112	=item $x_display = $term->display_id	1354	=item $x_display = $term->display_id
1113		1355
…		…
1139	=item $modifiermask = $term->ModNumLockMask	1381	=item $modifiermask = $term->ModNumLockMask
1140		1382
1141	Return the modifier masks corresponding to the "ISO Level 3 Shift" (often	1383	Return the modifier masks corresponding to the "ISO Level 3 Shift" (often
1142	AltGr), the meta key (often Alt) and the num lock key, if applicable.	1384	AltGr), the meta key (often Alt) and the num lock key, if applicable.
1143		1385
		1386	=item $screen = $term->current_screen
		1387
		1388	Returns the currently displayed screen (0 primary, 1 secondary).
		1389
		1390	=item $cursor_is_hidden = $term->hidden_cursor
		1391
		1392	Returns wether the cursor is currently hidden or not.
		1393
1144	=item $view_start = $term->view_start ([$newvalue])	1394	=item $view_start = $term->view_start ([$newvalue])
1145		1395
1146	Returns the negative row number of the topmost line. Minimum value is	1396	Returns the row number of the topmost displayed line. Maximum value is
1147	C<0>, which displays the normal terminal contents. Larger values scroll	1397	C<0>, which displays the normal terminal contents. Lower values scroll
1148	this many lines into the scrollback buffer.	1398	this many lines into the scrollback buffer.
1149		1399
1150	=item $term->want_refresh	1400	=item $term->want_refresh
1151		1401
1152	Requests a screen refresh. At the next opportunity, rxvt-unicode will	1402	Requests a screen refresh. At the next opportunity, rxvt-unicode will
…		…
1166	If C<$new_text> is specified, it will replace characters in the current	1416	If C<$new_text> is specified, it will replace characters in the current
1167	line, starting at column C<$start_col> (default C<0>), which is useful	1417	line, starting at column C<$start_col> (default C<0>), which is useful
1168	to replace only parts of a line. The font index in the rendition will	1418	to replace only parts of a line. The font index in the rendition will
1169	automatically be updated.	1419	automatically be updated.
1170		1420
1171	C<$text> is in a special encoding: tabs and wide characters that use more	1421	C<$text> is in a special encoding: tabs and wide characters that use
1172	than one cell when displayed are padded with urxvt::NOCHAR characters	1422	more than one cell when displayed are padded with C<$urxvt::NOCHAR>
1173	(C<chr 65535>). Characters with combining characters and other characters	1423	characters. Characters with combining characters and other characters that
1174	that do not fit into the normal tetx encoding will be replaced with	1424	do not fit into the normal tetx encoding will be replaced with characters
1175	characters in the private use area.	1425	in the private use area.
1176		1426
1177	You have to obey this encoding when changing text. The advantage is	1427	You have to obey this encoding when changing text. The advantage is
1178	that C<substr> and similar functions work on screen cells and not on	1428	that C<substr> and similar functions work on screen cells and not on
1179	characters.	1429	characters.
1180		1430
…		…
1355		1605
1356	Calls XUngrab for the most recent grab. Is called automatically on	1606	Calls XUngrab for the most recent grab. Is called automatically on
1357	evaluation errors, as it is better to lose the grab in the error case as	1607	evaluation errors, as it is better to lose the grab in the error case as
1358	the session.	1608	the session.
1359		1609
		1610	=item $atom = $term->XInternAtom ($atom_name[, $only_if_exists])
		1611
		1612	=item $atom_name = $term->XGetAtomName ($atom)
		1613
		1614	=item @atoms = $term->XListProperties ($window)
		1615
		1616	=item ($type,$format,$octets) = $term->XGetWindowProperty ($window, $property)
		1617
		1618	=item $term->XChangeWindowProperty ($window, $property, $type, $format, $octets)
		1619
		1620	=item $term->XDeleteProperty ($window, $property)
		1621
		1622	=item $window = $term->DefaultRootWindow
		1623
		1624	=item $term->XReparentWindow ($window, $parent, [$x, $y])
		1625
		1626	=item $term->XMapWindow ($window)
		1627
		1628	=item $term->XUnmapWindow ($window)
		1629
		1630	=item $term->XMoveResizeWindow ($window, $x, $y, $width, $height)
		1631
		1632	=item ($x, $y, $child_window) = $term->XTranslateCoordinates ($src, $dst, $x, $y)
		1633
		1634	=item $term->XChangeInput ($window, $add_events[, $del_events])
		1635
		1636	Various X or X-related functions. The C<$term> object only serves as
		1637	the source of the display, otherwise those functions map more-or-less
		1638	directory onto the X functions of the same name.
		1639
1360	=back	1640	=back
1361		1641
1362	=cut	1642	=cut
1363		1643
1364	package urxvt::popup;	1644	package urxvt::popup;
…		…
1465	my $env = $self->{term}->env;	1745	my $env = $self->{term}->env;
1466	# we can't hope to reproduce the locale algorithm, so nuke LC_ALL and set LC_CTYPE.	1746	# we can't hope to reproduce the locale algorithm, so nuke LC_ALL and set LC_CTYPE.
1467	delete $env->{LC_ALL};	1747	delete $env->{LC_ALL};
1468	$env->{LC_CTYPE} = $self->{term}->locale;	1748	$env->{LC_CTYPE} = $self->{term}->locale;
1469		1749
1470	urxvt::term->new ($env, $self->{term}->resource ("name"),	1750	urxvt::term->new ($env, "popup",
1471	"--perl-lib" => "", "--perl-ext-common" => "", "-pty-fd" => -1, "-sl" => 0, "-b" => 0,	1751	"--perl-lib" => "", "--perl-ext-common" => "",
		1752	"-pty-fd" => -1, "-sl" => 0,
		1753	"-b" => 1, "-bd" => "grey80", "-bl", "-override-redirect",
1472	"--transient-for" => $self->{term}->parent,	1754	"--transient-for" => $self->{term}->parent,
1473	"-display" => $self->{term}->display_id,	1755	"-display" => $self->{term}->display_id,
1474	"-pe" => "urxvt-popup")	1756	"-pe" => "urxvt-popup")
1475	or die "unable to create popup window\n";	1757	or die "unable to create popup window\n";
1476	}	1758	}
…		…
1481	delete $self->{term}{_destroy}{$self};	1763	delete $self->{term}{_destroy}{$self};
1482	$self->{term}->ungrab;	1764	$self->{term}->ungrab;
1483	}	1765	}
1484		1766
1485	=back	1767	=back
		1768
		1769	=cut
		1770
		1771	package urxvt::watcher;
		1772
		1773	@urxvt::timer::ISA = __PACKAGE__;
		1774	@urxvt::iow::ISA = __PACKAGE__;
		1775	@urxvt::pw::ISA = __PACKAGE__;
		1776	@urxvt::iw::ISA = __PACKAGE__;
1486		1777
1487	=head2 The C<urxvt::timer> Class	1778	=head2 The C<urxvt::timer> Class
1488		1779
1489	This class implements timer watchers/events. Time is represented as a	1780	This class implements timer watchers/events. Time is represented as a
1490	fractional number of seconds since the epoch. Example:	1781	fractional number of seconds since the epoch. Example:
…		…
1528	Start the timer.	1819	Start the timer.
1529		1820
1530	=item $timer = $timer->start ($tstamp)	1821	=item $timer = $timer->start ($tstamp)
1531		1822
1532	Set the event trigger time to C<$tstamp> and start the timer.	1823	Set the event trigger time to C<$tstamp> and start the timer.
		1824
		1825	=item $timer = $timer->after ($delay)
		1826
		1827	Like C<start>, but sets the expiry timer to c<urxvt::NOW + $delay>.
1533		1828
1534	=item $timer = $timer->stop	1829	=item $timer = $timer->stop
1535		1830
1536	Stop the timer.	1831	Stop the timer.
1537		1832
…		…
1584		1879
1585	Stop watching for events on the given filehandle.	1880	Stop watching for events on the given filehandle.
1586		1881
1587	=back	1882	=back
1588		1883
		1884	=head2 The C<urxvt::iw> Class
		1885
		1886	This class implements idle watchers, that get called automatically when
		1887	the process is idle. They should return as fast as possible, after doing
		1888	some useful work.
		1889
		1890	=over 4
		1891
		1892	=item $iw = new urxvt::iw
		1893
		1894	Create a new idle watcher object in stopped state.
		1895
		1896	=item $iw = $iw->cb (sub { my ($iw) = @_; ... })
		1897
		1898	Set the callback to be called when the watcher triggers.
		1899
		1900	=item $timer = $timer->start
		1901
		1902	Start the watcher.
		1903
		1904	=item $timer = $timer->stop
		1905
		1906	Stop the watcher.
		1907
		1908	=back
		1909
		1910	=head2 The C<urxvt::pw> Class
		1911
		1912	This class implements process watchers. They create an event whenever a
		1913	process exits, after which they stop automatically.
		1914
		1915	my $pid = fork;
		1916	...
		1917	$term->{pw} = urxvt::pw
		1918	->new
		1919	->start ($pid)
		1920	->cb (sub {
		1921	my ($pw, $exit_status) = @_;
		1922	...
		1923	});
		1924
		1925	=over 4
		1926
		1927	=item $pw = new urxvt::pw
		1928
		1929	Create a new process watcher in stopped state.
		1930
		1931	=item $pw = $pw->cb (sub { my ($pw, $exit_status) = @_; ... })
		1932
		1933	Set the callback to be called when the timer triggers.
		1934
		1935	=item $pw = $timer->start ($pid)
		1936
		1937	Tells the wqtcher to start watching for process C<$pid>.
		1938
		1939	=item $pw = $pw->stop
		1940
		1941	Stop the watcher.
		1942
		1943	=back
		1944
1589	=head1 ENVIRONMENT	1945	=head1 ENVIRONMENT
1590		1946
1591	=head2 URXVT_PERL_VERBOSITY	1947	=head2 URXVT_PERL_VERBOSITY
1592		1948
1593	This variable controls the verbosity level of the perl extension. Higher	1949	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.86 by root, Thu Jan 12 05:22:47 2006 UTC vs. Revision 1.122 by root, Sat Jan 21 08:07:38 2006 UTC

Diff Legend

Comparing rxvt-unicode/src/urxvt.pm (file contents):
Revision 1.86 by root, Thu Jan 12 05:22:47 2006 UTC vs.
Revision 1.122 by root, Sat Jan 21 08:07:38 2006 UTC