[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.126 by root, Tue Jan 24 19:14:36 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	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
		79	You can look at the source of the selection extension to see more
		80	interesting uses, such as parsing a line from beginning to end.
		81
49	It also offers the following bindable keyboard command:	82	This extension also offers following bindable keyboard commands:
50		83
51	=over 4	84	=over 4
52		85
53	=item rot13	86	=item rot13
54		87
…		…
65		98
66	=item selection-popup (enabled by default)	99	=item selection-popup (enabled by default)
67		100
68	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
69	text into various other formats/action (such as uri unescaping, perl	102	text into various other formats/action (such as uri unescaping, perl
70	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	};
71		123
72	=item searchable-scrollback<hotkey> (enabled by default)	124	=item searchable-scrollback<hotkey> (enabled by default)
73		125
74	Adds regex search functionality to the scrollback buffer, triggered	126	Adds regex search functionality to the scrollback buffer, triggered
75	by a hotkey (default: C<M-s>). When in search mode, normal terminal	127	by a hotkey (default: C<M-s>). While in search mode, normal terminal
76	input/output is suspended.	128	input/output is suspended and a regex is displayed at the bottom of the
		129	screen.
77		130
78	C</> starts an incremental regex search, C<n> searches further, C<p> or	131	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	132	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>	133	search upwards/downwards in the scrollback buffer, C<End> jumps to the
81	returns to the original position.	134	bottom. C<Escape> leaves search mode and returns to the point where search
		135	was started, while C<Enter> or C<Return> stay at the current position and
		136	additionally stores the first match in the current line into the primary
		137	selection.
82		138
83	=item digital-clock	139	=item readline (enabled by default)
84		140
85	Displays a digital clock using the built-in overlay.	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
		164	=item selection-autotransform
		165
		166	This selection allows you to do automatic transforms on a selection
		167	whenever a selection is made.
		168
		169	It works by specifying perl snippets (most useful is a single C<s///>
		170	operator) that modify C<$_> as resources:
		171
		172	URxvt.selection-autotransform.0: transform
		173	URxvt.selection-autotransform.1: transform
		174	...
		175
		176	For example, the following will transform selections of the form
		177	C<filename:number>, often seen in compiler messages, into C<vi +$filename
		178	$word>:
		179
		180	URxvt.selection-autotransform.0: s/^([^:[:space:]]+):(\\d+):?$/vi +$2 \\Q$1\\E\\x0d/
		181
		182	And this example matches the same,but replaces it with vi-commands you can
		183	paste directly into your (vi :) editor:
		184
		185	URxvt.selection-autotransform.0: s/^([^:[:space:]]+(\\d+):?$/:e \\Q$1\\E\\x0d:$2\\x0d/
		186
		187	Of course, this can be modified to suit your needs and your editor :)
		188
		189	To expand the example above to typical perl error messages ("XXX at
		190	FILENAME line YYY."), you need a slightly more elaborate solution:
		191
		192	URxvt.selection.pattern-0: ( at .*? line \\d+[,.])
		193	URxvt.selection-autotransform.0: s/^ at (.*?) line (\\d+)[,.]$/:e \\Q$1\E\\x0d:$2\\x0d/
		194
		195	The first line tells the selection code to treat the unchanging part of
		196	every error message as a selection pattern, and the second line transforms
		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.
86		209
87	=item mark-urls	210	=item mark-urls
88		211
89	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
90	make them clickable. When middle-clicked, the program specified in the	213	make them clickable. When middle-clicked, the program specified in the
91	resource C<urlLauncher> (default C<x-www-browser>) will be started.	214	resource C<urlLauncher> (default C<x-www-browser>) will be started with
		215	the URL as first argument.
		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
92		224
93	=item block-graphics-to-ascii	225	=item block-graphics-to-ascii
94		226
95	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,
96	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
97	similar-looking ascii character.	229	similar-looking ascii character.
98		230
		231	=item digital-clock
		232
		233	Displays a digital clock using the built-in overlay.
		234
99	=item example-refresh-hooks	235	=item example-refresh-hooks
100		236
101	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
102	window. Illustrates overwriting the refresh callbacks to create your own	238	window. Illustrates overwriting the refresh callbacks to create your own
103	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/%
104		269
105	=back	270	=back
106		271
107	=head1 API DOCUMENTATION	272	=head1 API DOCUMENTATION
108		273
…		…
181	called whenever the relevant event happens.	346	called whenever the relevant event happens.
182		347
183	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
184	the in the C<Extension Objects> section.	349	the in the C<Extension Objects> section.
185		350
186	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
187	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
188	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.
189		354
190	I<< When in doubt, return a false value (preferably C<()>). >>	355	I<< When in doubt, return a false value (preferably C<()>). >>
191		356
192	=over 4	357	=over 4
193		358
194	=item on_init $term	359	=item on_init $term
195		360
196	Called after a new terminal object has been initialized, but before	361	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	362	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	363	call or deliver senseless data, as terminal size and other characteristics
199	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
200	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, before doing anything
		376	yet. If this hook returns true, then destruction is skipped, but this is
		377	rarely a good idea.
201		378
202	=item on_reset $term	379	=item on_reset $term
203		380
204	Called after the screen is "reset" for any reason, such as resizing or	381	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	382	control sequences. Here is where you can react on changes to size-related
206	variables.	383	variables.
207		384
208	=item on_start $term	385	=item on_child_start $term, $pid
209		386
210	Called at the very end of initialisation of a new terminal, just before	387	Called just after the child process has been C<fork>ed.
211	returning to the mainloop.	388
		389	=item on_child_exit $term, $status
		390
		391	Called just after the child process has exited. C<$status> is the status
		392	from C<waitpid>.
212		393
213	=item on_sel_make $term, $eventtime	394	=item on_sel_make $term, $eventtime
214		395
215	Called whenever a selection has been made by the user, but before the	396	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	397	selection text is copied, so changes to the beginning, end or type of the
…		…
309		490
310	Called whenever the user presses a key combination that has a	491	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>	492	C<perl:string> action bound to it (see description of the B<keysym>
312	resource in the @@RXVT_NAME@@(1) manpage).	493	resource in the @@RXVT_NAME@@(1) manpage).
313		494
		495	=item on_x_event $term, $event
		496
		497	Called on every X event received on the vt window (and possibly other
		498	windows). Should only be used as a last resort. Most event structure
		499	members are not passed.
		500
314	=item on_focus_in $term	501	=item on_focus_in $term
315		502
316	Called whenever the window gets the keyboard focus, before rxvt-unicode	503	Called whenever the window gets the keyboard focus, before rxvt-unicode
317	does focus in processing.	504	does focus in processing.
318		505
319	=item on_focus_out $term	506	=item on_focus_out $term
320		507
321	Called wheneever the window loses keyboard focus, before rxvt-unicode does	508	Called wheneever the window loses keyboard focus, before rxvt-unicode does
322	focus out processing.	509	focus out processing.
323		510
		511	=item on_configure_notify $term, $event
		512
		513	=item on_property_notify $term, $event
		514
324	=item on_key_press $term, $event, $keysym, $octets	515	=item on_key_press $term, $event, $keysym, $octets
325		516
326	=item on_key_release $term, $event, $keysym	517	=item on_key_release $term, $event, $keysym
327		518
328	=item on_button_press $term, $event	519	=item on_button_press $term, $event
…		…
337		528
338	Called whenever the corresponding X event is received for the terminal If	529	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.	530	the hook returns true, then the even will be ignored by rxvt-unicode.
340		531
341	The event is a hash with most values as named by Xlib (see the XEvent	532	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	533	manpage), with the additional members C<row> and C<col>, which are the
343	and column under the mouse cursor.	534	(real, not screen-based) row and column under the mouse cursor.
344		535
345	C<on_key_press> additionally receives the string rxvt-unicode would	536	C<on_key_press> additionally receives the string rxvt-unicode would
346	output, if any, in locale-specific encoding.	537	output, if any, in locale-specific encoding.
347		538
348	subwindow.	539	subwindow.
		540
		541	=item on_client_message $term, $event
		542
		543	=item on_wm_protocols $term, $event
		544
		545	=item on_wm_delete_window $term, $event
		546
		547	Called when various types of ClientMessage events are received (all with
		548	format=32, WM_PROTOCOLS or WM_PROTOCOLS:WM_DELETE_WINDOW).
349		549
350	=back	550	=back
351		551
352	=cut	552	=cut
353		553
…		…
359	use Scalar::Util ();	559	use Scalar::Util ();
360	use List::Util ();	560	use List::Util ();
361		561
362	our $VERSION = 1;	562	our $VERSION = 1;
363	our $TERM;	563	our $TERM;
		564	our @TERM_INIT;
		565	our @TERM_EXT;
364	our @HOOKNAME;	566	our @HOOKNAME;
365	our %HOOKTYPE = map +($HOOKNAME[$_] => $_), 0..$#HOOKNAME;	567	our %HOOKTYPE = map +($HOOKNAME[$_] => $_), 0..$#HOOKNAME;
366	our %OPTION;	568	our %OPTION;
367		569
368	our $LIBDIR;	570	our $LIBDIR;
369	our $RESNAME;	571	our $RESNAME;
370	our $RESCLASS;	572	our $RESCLASS;
371	our $RXVTNAME;	573	our $RXVTNAME;
372		574
		575	our $NOCHAR = chr 0xffff;
		576
373	=head2 Variables in the C<urxvt> Package	577	=head2 Variables in the C<urxvt> Package
374		578
375	=over 4	579	=over 4
376		580
377	=item $urxvt::LIBDIR	581	=item $urxvt::LIBDIR
…		…
389		593
390	=item $urxvt::TERM	594	=item $urxvt::TERM
391		595
392	The current terminal. This variable stores the current C<urxvt::term>	596	The current terminal. This variable stores the current C<urxvt::term>
393	object, whenever a callback/hook is executing.	597	object, whenever a callback/hook is executing.
		598
		599	=item @urxvt::TERM_INIT
		600
		601	All coderefs in this array will be called as methods of the next newly
		602	created C<urxvt::term> object (during the C<on_init> phase). The array
		603	gets cleared before the codereferences that were in it are being executed,
		604	so coderefs can push themselves onto it again if they so desire.
		605
		606	This complements to the perl-eval commandline option, but gets executed
		607	first.
		608
		609	=item @urxvt::TERM_EXT
		610
		611	Works similar to C<@TERM_INIT>, but contains perl package/class names, which
		612	get registered as normal extensions after calling the hooks in C<@TERM_INIT>
		613	but before other extensions. Gets cleared just like C<@TERM_INIT>.
394		614
395	=back	615	=back
396		616
397	=head2 Functions in the C<urxvt> Package	617	=head2 Functions in the C<urxvt> Package
398		618
…		…
413	Using this function has the advantage that its output ends up in the	633	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.	634	correct place, e.g. on stderr of the connecting urxvtc client.
415		635
416	Messages have a size limit of 1023 bytes currently.	636	Messages have a size limit of 1023 bytes currently.
417		637
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	638	=item $time = urxvt::NOW
425		639
426	Returns the "current time" (as per the event loop).	640	Returns the "current time" (as per the event loop).
427		641
428	=item urxvt::CurrentTime	642	=item urxvt::CurrentTime
429		643
430	=item urxvt::ShiftMask, LockMask, ControlMask, Mod1Mask, Mod2Mask,	644	=item urxvt::ShiftMask, LockMask, ControlMask, Mod1Mask, Mod2Mask,
431	Mod3Mask, Mod4Mask, Mod5Mask, Button1Mask, Button2Mask, Button3Mask,	645	Mod3Mask, Mod4Mask, Mod5Mask, Button1Mask, Button2Mask, Button3Mask,
432	Button4Mask, Button5Mask, AnyModifier	646	Button4Mask, Button5Mask, AnyModifier
		647
		648	=item urxvt::NoEventMask, KeyPressMask, KeyReleaseMask,
		649	ButtonPressMask, ButtonReleaseMask, EnterWindowMask, LeaveWindowMask,
		650	PointerMotionMask, PointerMotionHintMask, Button1MotionMask, Button2MotionMask,
		651	Button3MotionMask, Button4MotionMask, Button5MotionMask, ButtonMotionMask,
		652	KeymapStateMask, ExposureMask, VisibilityChangeMask, StructureNotifyMask,
		653	ResizeRedirectMask, SubstructureNotifyMask, SubstructureRedirectMask,
		654	FocusChangeMask, PropertyChangeMask, ColormapChangeMask, OwnerGrabButtonMask
		655
		656	=item urxvt::KeyPress, KeyRelease, ButtonPress, ButtonRelease, MotionNotify,
		657	EnterNotify, LeaveNotify, FocusIn, FocusOut, KeymapNotify, Expose,
		658	GraphicsExpose, NoExpose, VisibilityNotify, CreateNotify, DestroyNotify,
		659	UnmapNotify, MapNotify, MapRequest, ReparentNotify, ConfigureNotify,
		660	ConfigureRequest, GravityNotify, ResizeRequest, CirculateNotify,
		661	CirculateRequest, PropertyNotify, SelectionClear, SelectionRequest,
		662	SelectionNotify, ColormapNotify, ClientMessage, MappingNotify
433		663
434	Various constants for use in X calls and event processing.	664	Various constants for use in X calls and event processing.
435		665
436	=back	666	=back
437		667
…		…
488	=back	718	=back
489		719
490	=cut	720	=cut
491		721
492	BEGIN {	722	BEGIN {
493	urxvt->bootstrap;
494
495	# overwrite perl's warn	723	# overwrite perl's warn
496	*CORE::GLOBAL::warn = sub {	724	*CORE::GLOBAL::warn = sub {
497	my $msg = join "", @_;	725	my $msg = join "", @_;
498	$msg .= "\n"	726	$msg .= "\n"
499	unless $msg =~ /\n$/;	727	unless $msg =~ /\n$/;
500	urxvt::warn ($msg);	728	urxvt::warn ($msg);
501	};	729	};
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	}	730	}
509		731
510	my @hook_count;	732	no warnings 'utf8';
		733
511	my $verbosity = $ENV{URXVT_PERL_VERBOSITY};	734	my $verbosity = $ENV{URXVT_PERL_VERBOSITY};
512		735
513	sub verbose {	736	sub verbose {
514	my ($level, $msg) = @_;	737	my ($level, $msg) = @_;
515	warn "$msg\n" if $level <= $verbosity;	738	warn "$msg\n" if $level <= $verbosity;
516	}	739	}
517		740
518	my $extension_pkg = "extension0000";
519	my %extension_pkg;	741	my %extension_pkg;
520		742
521	# load a single script into its own package, once only	743	# load a single script into its own package, once only
522	sub extension_package($) {	744	sub extension_package($) {
523	my ($path) = @_;	745	my ($path) = @_;
524		746
525	$extension_pkg{$path} \|\|= do {	747	$extension_pkg{$path} \|\|= do {
526	my $pkg = "urxvt::" . ($extension_pkg++);	748	$path =~ /([^\/\\]+)$/;
		749	my $pkg = $1;
		750	$pkg =~ s/[^[:word:]]/_/g;
		751	$pkg = "urxvt::ext::$pkg";
527		752
528	verbose 3, "loading extension '$path' into package '$pkg'";	753	verbose 3, "loading extension '$path' into package '$pkg'";
529		754
530	open my $fh, "<:raw", $path	755	open my $fh, "<:raw", $path
531	or die "$path: $!";	756	or die "$path: $!";
532		757
533	my $source = untaint	758	my $source =
534	"package $pkg; use strict; use utf8;\n"	759	"package $pkg; use strict; use utf8; no warnings 'utf8';\n"
535	. "use base urxvt::term::extension::;\n"
536	. "#line 1 \"$path\"\n{\n"	760	. "#line 1 \"$path\"\n{\n"
537	. (do { local $/; <$fh> })	761	. (do { local $/; <$fh> })
538	. "\n};\n1";	762	. "\n};\n1";
539		763
540	eval $source	764	eval $source
…		…
554	if ($htype == 0) { # INIT	778	if ($htype == 0) { # INIT
555	my @dirs = ((split /:/, $TERM->resource ("perl_lib")), "$LIBDIR/perl");	779	my @dirs = ((split /:/, $TERM->resource ("perl_lib")), "$LIBDIR/perl");
556		780
557	my %ext_arg;	781	my %ext_arg;
558		782
		783	{
		784	my @init = @TERM_INIT;
		785	@TERM_INIT = ();
		786	$_->($TERM) for @init;
		787	my @pkg = @TERM_EXT;
		788	@TERM_EXT = ();
		789	$TERM->register_package ($_) for @pkg;
		790	}
		791
559	for (map { split /,/, $TERM->resource ("perl_ext_$_") } 1, 2) {	792	for (grep $_, map { split /,/, $TERM->resource ("perl_ext_$_") } 1, 2) {
560	if ($_ eq "default") {	793	if ($_ eq "default") {
561	$ext_arg{$_} \|\|= [] for qw(selection option-popup selection-popup searchable-scrollback);	794	$ext_arg{$_} \|\|= [] for qw(selection option-popup selection-popup searchable-scrollback readline);
562	} elsif (/^-(.*)$/) {	795	} elsif (/^-(.*)$/) {
563	delete $ext_arg{$1};	796	delete $ext_arg{$1};
564	} elsif (/^([^<]+)<(.*)>$/) {	797	} elsif (/^([^<]+)<(.*)>$/) {
565	push @{ $ext_arg{$1} }, $2;	798	push @{ $ext_arg{$1} }, $2;
566	} else {	799	} else {
…		…
589	if $verbosity >= 10;	822	if $verbosity >= 10;
590		823
591	keys %$cb;	824	keys %$cb;
592		825
593	while (my ($pkg, $cb) = each %$cb) {	826	while (my ($pkg, $cb) = each %$cb) {
594	$retval = eval { $cb->($TERM->{_pkg}{$pkg}, @_) }	827	my $retval_ = eval { $cb->($TERM->{_pkg}{$pkg}, @_) };
595	and last;	828	$retval \|\|= $retval_;
596		829
597	if ($@) {	830	if ($@) {
598	$TERM->ungrab; # better to lose the grab than the session	831	$TERM->ungrab; # better to lose the grab than the session
599	warn $@;	832	warn $@;
600	}	833	}
…		…
603	verbose 11, "$HOOKNAME[$htype] returning <$retval>"	836	verbose 11, "$HOOKNAME[$htype] returning <$retval>"
604	if $verbosity >= 11;	837	if $verbosity >= 11;
605	}	838	}
606		839
607	if ($htype == 1) { # DESTROY	840	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	841	# clear package objects
616	%$_ = () for values %{ $TERM->{_pkg} };	842	%$_ = () for values %{ $TERM->{_pkg} };
617		843
618	# clear package	844	# clear package
619	%$TERM = ();	845	%$TERM = ();
620	}	846	}
621		847
622	$retval	848	$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	}	849	}
636		850
637	# urxvt::term::extension	851	# urxvt::term::extension
638		852
639	package urxvt::term::extension;	853	package urxvt::term::extension;
…		…
645	while (my ($name, $cb) = each %hook) {	859	while (my ($name, $cb) = each %hook) {
646	my $htype = $HOOKTYPE{uc $name};	860	my $htype = $HOOKTYPE{uc $name};
647	defined $htype	861	defined $htype
648	or Carp::croak "unsupported hook type '$name'";	862	or Carp::croak "unsupported hook type '$name'";
649		863
		864	$self->set_should_invoke ($htype, +1)
650	unless (exists $self->{term}{_hook}[$htype]{$pkg}) {	865	unless exists $self->{term}{_hook}[$htype]{$pkg};
651	$hook_count[$htype]++
652	or urxvt::set_should_invoke $htype, 1;
653	}
654		866
655	$self->{term}{_hook}[$htype]{$pkg} = $cb;	867	$self->{term}{_hook}[$htype]{$pkg} = $cb;
656	}	868	}
657	}	869	}
658		870
…		…
663	for my $name (@hook) {	875	for my $name (@hook) {
664	my $htype = $HOOKTYPE{uc $name};	876	my $htype = $HOOKTYPE{uc $name};
665	defined $htype	877	defined $htype
666	or Carp::croak "unsupported hook type '$name'";	878	or Carp::croak "unsupported hook type '$name'";
667		879
		880	$self->set_should_invoke ($htype, -1)
668	if (delete $self->{term}{_hook}[$htype]{$pkg}) {	881	if delete $self->{term}{_hook}[$htype]{$pkg};
669	--$hook_count[$htype]
670	or urxvt::set_should_invoke $htype, 0;
671	}
672	}	882	}
673	}	883	}
674		884
675	our $AUTOLOAD;	885	our $AUTOLOAD;
676		886
…		…
782	# find on_xxx subs in the package and register them	992	# find on_xxx subs in the package and register them
783	# as hooks	993	# as hooks
784	sub register_package {	994	sub register_package {
785	my ($self, $pkg, $argv) = @_;	995	my ($self, $pkg, $argv) = @_;
786		996
		997	no strict 'refs';
		998
		999	urxvt::verbose 6, "register package $pkg to $self";
		1000
		1001	@{"$pkg\::ISA"} = urxvt::term::extension::;
		1002
787	my $proxy = bless {	1003	my $proxy = bless {
788	_pkg => $pkg,	1004	_pkg => $pkg,
789	argv => $argv,	1005	argv => $argv,
790	}, $pkg;	1006	}, $pkg;
791	Scalar::Util::weaken ($proxy->{term} = $self);	1007	Scalar::Util::weaken ($proxy->{term} = $self);
…		…
822		1038
823	Destroy the terminal object (close the window, free resources	1039	Destroy the terminal object (close the window, free resources
824	etc.). Please note that @@RXVT_NAME@@ will not exit as long as any event	1040	etc.). Please note that @@RXVT_NAME@@ will not exit as long as any event
825	watchers (timers, io watchers) are still active.	1041	watchers (timers, io watchers) are still active.
826		1042
		1043	=item $term->exec_async ($cmd[, @args])
		1044
		1045	Works like the combination of the C<fork>/C<exec> builtins, which executes
		1046	("starts") programs in the background. This function takes care of setting
		1047	the user environment before exec'ing the command (e.g. C<PATH>) and should
		1048	be preferred over explicit calls to C<exec> or C<system>.
		1049
		1050	Returns the pid of the subprocess or C<undef> on error.
		1051
		1052	=cut
		1053
		1054	sub exec_async {
		1055	my $self = shift;
		1056
		1057	my $pid = fork;
		1058
		1059	return $pid
		1060	if !defined $pid or $pid;
		1061
		1062	%ENV = %{ $self->env };
		1063
		1064	exec @_;
		1065	urxvt::_exit 255;
		1066	}
		1067
827	=item $isset = $term->option ($optval[, $set])	1068	=item $isset = $term->option ($optval[, $set])
828		1069
829	Returns true if the option specified by C<$optval> is enabled, and	1070	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	1071	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.	1072	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	1074	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:	1075	source file F</src/optinc.h> to see the actual list:
835		1076
836	borderLess console cursorBlink cursorUnderline hold iconic insecure	1077	borderLess console cursorBlink cursorUnderline hold iconic insecure
837	intensityStyles jumpScroll loginShell mapAlert meta8 mouseWheelScrollPage	1078	intensityStyles jumpScroll loginShell mapAlert meta8 mouseWheelScrollPage
838	pastableTabs pointerBlank reverseVideo scrollBar scrollBar_floating	1079	override-redirect pastableTabs pointerBlank reverseVideo scrollBar
839	scrollBar_right scrollTtyKeypress scrollTtyOutput scrollWithBuffer	1080	scrollBar_floating scrollBar_right scrollTtyKeypress scrollTtyOutput
840	secondaryScreen secondaryScroll skipBuiltinGlyphs transparent	1081	scrollWithBuffer secondaryScreen secondaryScroll skipBuiltinGlyphs
841	tripleclickwords utmpInhibit visualBell	1082	transparent tripleclickwords utmpInhibit visualBell
842		1083
843	=item $value = $term->resource ($name[, $newval])	1084	=item $value = $term->resource ($name[, $newval])
844		1085
845	Returns the current resource value associated with a given name and	1086	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>	1087	optionally sets a new value. Setting values is most useful in the C<init>
…		…
863		1104
864	answerbackstring backgroundPixmap backspace_key boldFont boldItalicFont	1105	answerbackstring backgroundPixmap backspace_key boldFont boldItalicFont
865	borderLess color cursorBlink cursorUnderline cutchars delete_key	1106	borderLess color cursorBlink cursorUnderline cutchars delete_key
866	display_name embed ext_bwidth fade font geometry hold iconName	1107	display_name embed ext_bwidth fade font geometry hold iconName
867	imFont imLocale inputMethod insecure int_bwidth intensityStyles	1108	imFont imLocale inputMethod insecure int_bwidth intensityStyles
868	italicFont jumpScroll lineSpace loginShell mapAlert menu meta8 modifier	1109	italicFont jumpScroll lineSpace loginShell mapAlert meta8 modifier
869	mouseWheelScrollPage name pastableTabs path perl_eval perl_ext_1 perl_ext_2	1110	mouseWheelScrollPage name override_redirect pastableTabs path perl_eval
870	perl_lib pointerBlank pointerBlankDelay preeditType print_pipe pty_fd	1111	perl_ext_1 perl_ext_2 perl_lib pointerBlank pointerBlankDelay
871	reverseVideo saveLines scrollBar scrollBar_align scrollBar_floating	1112	preeditType print_pipe pty_fd reverseVideo saveLines scrollBar
872	scrollBar_right scrollBar_thickness scrollTtyKeypress scrollTtyOutput	1113	scrollBar_align scrollBar_floating scrollBar_right scrollBar_thickness
873	scrollWithBuffer scrollstyle secondaryScreen secondaryScroll selectstyle	1114	scrollTtyKeypress scrollTtyOutput scrollWithBuffer scrollstyle
874	shade term_name title transparent transparent_all tripleclickwords	1115	secondaryScreen secondaryScroll selectstyle shade term_name title
875	utmpInhibit visualBell	1116	transient_for transparent transparent_all tripleclickwords utmpInhibit
		1117	visualBell
876		1118
877	=cut	1119	=cut
878		1120
879	sub resource($$;$) {	1121	sub resource($$;$) {
880	my ($self, $name) = (shift, shift);	1122	my ($self, $name) = (shift, shift);
…		…
1054		1296
1055	Normally its not a good idea to use this function, as programs might be	1297	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	1298	confused by changes in cursor position or scrolling. Its useful inside a
1057	C<on_add_lines> hook, though.	1299	C<on_add_lines> hook, though.
1058		1300
		1301	=item $term->scr_change_screen ($screen)
		1302
		1303	Switch to given screen - 0 primary, 1 secondary.
		1304
1059	=item $term->cmd_parse ($octets)	1305	=item $term->cmd_parse ($octets)
1060		1306
1061	Similar to C<scr_add_lines>, but the argument must be in the	1307	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	1308	locale-specific encoding of the terminal and can contain command sequences
1063	(escape codes) that will be interpreted.	1309	(escape codes) that will be interpreted.
…		…
1073	Replaces the event mask of the pty watcher by the given event mask. Can	1319	Replaces the event mask of the pty watcher by the given event mask. Can
1074	be used to suppress input and output handling to the pty/tty. See the	1320	be used to suppress input and output handling to the pty/tty. See the
1075	description of C<< urxvt::timer->events >>. Make sure to always restore	1321	description of C<< urxvt::timer->events >>. Make sure to always restore
1076	the previous value.	1322	the previous value.
1077		1323
		1324	=item $fd = $term->pty_fd
		1325
		1326	Returns the master file descriptor for the pty in use, or C<-1> if no pty
		1327	is used.
		1328
1078	=item $windowid = $term->parent	1329	=item $windowid = $term->parent
1079		1330
1080	Return the window id of the toplevel window.	1331	Return the window id of the toplevel window.
1081		1332
1082	=item $windowid = $term->vt	1333	=item $windowid = $term->vt
1083		1334
1084	Return the window id of the terminal window.	1335	Return the window id of the terminal window.
1085		1336
		1337	=item $term->vt_emask_add ($x_event_mask)
		1338
		1339	Adds the specified events to the vt event mask. Useful e.g. when you want
		1340	to receive pointer events all the times:
		1341
		1342	$term->vt_emask_add (urxvt::PointerMotionMask);
		1343
1086	=item $window_width = $term->width	1344	=item $window_width = $term->width
1087		1345
1088	=item $window_height = $term->height	1346	=item $window_height = $term->height
1089		1347
1090	=item $font_width = $term->fwidth	1348	=item $font_width = $term->fwidth
…		…
1103		1361
1104	=item $max_scrollback = $term->saveLines	1362	=item $max_scrollback = $term->saveLines
1105		1363
1106	=item $nrow_plus_saveLines = $term->total_rows	1364	=item $nrow_plus_saveLines = $term->total_rows
1107		1365
1108	=item $lines_in_scrollback = $term->nsaved	1366	=item $topmost_scrollback_row = $term->top_row
1109		1367
1110	Return various integers describing terminal characteristics.	1368	Return various integers describing terminal characteristics.
1111		1369
1112	=item $x_display = $term->display_id	1370	=item $x_display = $term->display_id
1113		1371
…		…
1139	=item $modifiermask = $term->ModNumLockMask	1397	=item $modifiermask = $term->ModNumLockMask
1140		1398
1141	Return the modifier masks corresponding to the "ISO Level 3 Shift" (often	1399	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.	1400	AltGr), the meta key (often Alt) and the num lock key, if applicable.
1143		1401
		1402	=item $screen = $term->current_screen
		1403
		1404	Returns the currently displayed screen (0 primary, 1 secondary).
		1405
		1406	=item $cursor_is_hidden = $term->hidden_cursor
		1407
		1408	Returns wether the cursor is currently hidden or not.
		1409
1144	=item $view_start = $term->view_start ([$newvalue])	1410	=item $view_start = $term->view_start ([$newvalue])
1145		1411
1146	Returns the negative row number of the topmost line. Minimum value is	1412	Returns the row number of the topmost displayed line. Maximum value is
1147	C<0>, which displays the normal terminal contents. Larger values scroll	1413	C<0>, which displays the normal terminal contents. Lower values scroll
1148	this many lines into the scrollback buffer.	1414	this many lines into the scrollback buffer.
1149		1415
1150	=item $term->want_refresh	1416	=item $term->want_refresh
1151		1417
1152	Requests a screen refresh. At the next opportunity, rxvt-unicode will	1418	Requests a screen refresh. At the next opportunity, rxvt-unicode will
…		…
1167	line, starting at column C<$start_col> (default C<0>), which is useful	1433	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	1434	to replace only parts of a line. The font index in the rendition will
1169	automatically be updated.	1435	automatically be updated.
1170		1436
1171	C<$text> is in a special encoding: tabs and wide characters that use more	1437	C<$text> is in a special encoding: tabs and wide characters that use more
1172	than one cell when displayed are padded with urxvt::NOCHAR characters	1438	than one cell when displayed are padded with C<$urxvt::NOCHAR> (chr 65535)
1173	(C<chr 65535>). Characters with combining characters and other characters	1439	characters. Characters with combining characters and other characters that
1174	that do not fit into the normal tetx encoding will be replaced with	1440	do not fit into the normal tetx encoding will be replaced with characters
1175	characters in the private use area.	1441	in the private use area.
1176		1442
1177	You have to obey this encoding when changing text. The advantage is	1443	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	1444	that C<substr> and similar functions work on screen cells and not on
1179	characters.	1445	characters.
1180		1446
…		…
1355		1621
1356	Calls XUngrab for the most recent grab. Is called automatically on	1622	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	1623	evaluation errors, as it is better to lose the grab in the error case as
1358	the session.	1624	the session.
1359		1625
		1626	=item $atom = $term->XInternAtom ($atom_name[, $only_if_exists])
		1627
		1628	=item $atom_name = $term->XGetAtomName ($atom)
		1629
		1630	=item @atoms = $term->XListProperties ($window)
		1631
		1632	=item ($type,$format,$octets) = $term->XGetWindowProperty ($window, $property)
		1633
		1634	=item $term->XChangeWindowProperty ($window, $property, $type, $format, $octets)
		1635
		1636	=item $term->XDeleteProperty ($window, $property)
		1637
		1638	=item $window = $term->DefaultRootWindow
		1639
		1640	=item $term->XReparentWindow ($window, $parent, [$x, $y])
		1641
		1642	=item $term->XMapWindow ($window)
		1643
		1644	=item $term->XUnmapWindow ($window)
		1645
		1646	=item $term->XMoveResizeWindow ($window, $x, $y, $width, $height)
		1647
		1648	=item ($x, $y, $child_window) = $term->XTranslateCoordinates ($src, $dst, $x, $y)
		1649
		1650	=item $term->XChangeInput ($window, $add_events[, $del_events])
		1651
		1652	Various X or X-related functions. The C<$term> object only serves as
		1653	the source of the display, otherwise those functions map more-or-less
		1654	directory onto the X functions of the same name.
		1655
1360	=back	1656	=back
1361		1657
1362	=cut	1658	=cut
1363		1659
1364	package urxvt::popup;	1660	package urxvt::popup;
…		…
1465	my $env = $self->{term}->env;	1761	my $env = $self->{term}->env;
1466	# we can't hope to reproduce the locale algorithm, so nuke LC_ALL and set LC_CTYPE.	1762	# we can't hope to reproduce the locale algorithm, so nuke LC_ALL and set LC_CTYPE.
1467	delete $env->{LC_ALL};	1763	delete $env->{LC_ALL};
1468	$env->{LC_CTYPE} = $self->{term}->locale;	1764	$env->{LC_CTYPE} = $self->{term}->locale;
1469		1765
1470	urxvt::term->new ($env, $self->{term}->resource ("name"),	1766	urxvt::term->new ($env, "popup",
1471	"--perl-lib" => "", "--perl-ext-common" => "", "-pty-fd" => -1, "-sl" => 0, "-b" => 0,	1767	"--perl-lib" => "", "--perl-ext-common" => "",
		1768	"-pty-fd" => -1, "-sl" => 0,
		1769	"-b" => 1, "-bd" => "grey80", "-bl", "-override-redirect",
1472	"--transient-for" => $self->{term}->parent,	1770	"--transient-for" => $self->{term}->parent,
1473	"-display" => $self->{term}->display_id,	1771	"-display" => $self->{term}->display_id,
1474	"-pe" => "urxvt-popup")	1772	"-pe" => "urxvt-popup")
1475	or die "unable to create popup window\n";	1773	or die "unable to create popup window\n";
1476	}	1774	}
…		…
1481	delete $self->{term}{_destroy}{$self};	1779	delete $self->{term}{_destroy}{$self};
1482	$self->{term}->ungrab;	1780	$self->{term}->ungrab;
1483	}	1781	}
1484		1782
1485	=back	1783	=back
		1784
		1785	=cut
		1786
		1787	package urxvt::watcher;
		1788
		1789	@urxvt::timer::ISA = __PACKAGE__;
		1790	@urxvt::iow::ISA = __PACKAGE__;
		1791	@urxvt::pw::ISA = __PACKAGE__;
		1792	@urxvt::iw::ISA = __PACKAGE__;
1486		1793
1487	=head2 The C<urxvt::timer> Class	1794	=head2 The C<urxvt::timer> Class
1488		1795
1489	This class implements timer watchers/events. Time is represented as a	1796	This class implements timer watchers/events. Time is represented as a
1490	fractional number of seconds since the epoch. Example:	1797	fractional number of seconds since the epoch. Example:
…		…
1528	Start the timer.	1835	Start the timer.
1529		1836
1530	=item $timer = $timer->start ($tstamp)	1837	=item $timer = $timer->start ($tstamp)
1531		1838
1532	Set the event trigger time to C<$tstamp> and start the timer.	1839	Set the event trigger time to C<$tstamp> and start the timer.
		1840
		1841	=item $timer = $timer->after ($delay)
		1842
		1843	Like C<start>, but sets the expiry timer to c<urxvt::NOW + $delay>.
1533		1844
1534	=item $timer = $timer->stop	1845	=item $timer = $timer->stop
1535		1846
1536	Stop the timer.	1847	Stop the timer.
1537		1848
…		…
1584		1895
1585	Stop watching for events on the given filehandle.	1896	Stop watching for events on the given filehandle.
1586		1897
1587	=back	1898	=back
1588		1899
		1900	=head2 The C<urxvt::iw> Class
		1901
		1902	This class implements idle watchers, that get called automatically when
		1903	the process is idle. They should return as fast as possible, after doing
		1904	some useful work.
		1905
		1906	=over 4
		1907
		1908	=item $iw = new urxvt::iw
		1909
		1910	Create a new idle watcher object in stopped state.
		1911
		1912	=item $iw = $iw->cb (sub { my ($iw) = @_; ... })
		1913
		1914	Set the callback to be called when the watcher triggers.
		1915
		1916	=item $timer = $timer->start
		1917
		1918	Start the watcher.
		1919
		1920	=item $timer = $timer->stop
		1921
		1922	Stop the watcher.
		1923
		1924	=back
		1925
		1926	=head2 The C<urxvt::pw> Class
		1927
		1928	This class implements process watchers. They create an event whenever a
		1929	process exits, after which they stop automatically.
		1930
		1931	my $pid = fork;
		1932	...
		1933	$term->{pw} = urxvt::pw
		1934	->new
		1935	->start ($pid)
		1936	->cb (sub {
		1937	my ($pw, $exit_status) = @_;
		1938	...
		1939	});
		1940
		1941	=over 4
		1942
		1943	=item $pw = new urxvt::pw
		1944
		1945	Create a new process watcher in stopped state.
		1946
		1947	=item $pw = $pw->cb (sub { my ($pw, $exit_status) = @_; ... })
		1948
		1949	Set the callback to be called when the timer triggers.
		1950
		1951	=item $pw = $timer->start ($pid)
		1952
		1953	Tells the wqtcher to start watching for process C<$pid>.
		1954
		1955	=item $pw = $pw->stop
		1956
		1957	Stop the watcher.
		1958
		1959	=back
		1960
1589	=head1 ENVIRONMENT	1961	=head1 ENVIRONMENT
1590		1962
1591	=head2 URXVT_PERL_VERBOSITY	1963	=head2 URXVT_PERL_VERBOSITY
1592		1964
1593	This variable controls the verbosity level of the perl extension. Higher	1965	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.126 by root, Tue Jan 24 19:14:36 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.126 by root, Tue Jan 24 19:14:36 2006 UTC