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

Comparing rxvt-unicode/src/urxvt.pm (file contents):
Revision 1.87 by root, Thu Jan 12 05:37:34 2006 UTC vs.
Revision 1.128 by root, Wed Jan 25 00:57:57 2006 UTC

…		…
34	find them in F<@@RXVT_LIBDIR@@/urxvt/perl/>.	34	find them in F<@@RXVT_LIBDIR@@/urxvt/perl/>.
35		35
36	You can activate them like this:	36	You can activate them like this:
37		37
38	@@RXVT_NAME@@ -pe <extensionname>	38	@@RXVT_NAME@@ -pe <extensionname>
		39
		40	Or by adding them to the resource for extensions loaded by default:
		41
		42	URxvt.perl-ext-common: default,automove-background,selection-autotransform
39		43
40	=over 4	44	=over 4
41		45
42	=item selection (enabled by default)	46	=item selection (enabled by default)
43		47
…		…
48	C<--quoting-style=shell>.	52	C<--quoting-style=shell>.
49		53
50	A double-click usually selects the word under the cursor, further clicks	54	A double-click usually selects the word under the cursor, further clicks
51	will enlarge the selection.	55	will enlarge the selection.
52		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
53	It also offers the following bindable keyboard command:	82	This extension also offers following bindable keyboard commands:
54		83
55	=over 4	84	=over 4
56		85
57	=item rot13	86	=item rot13
58		87
…		…
69		98
70	=item selection-popup (enabled by default)	99	=item selection-popup (enabled by default)
71		100
72	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
73	text into various other formats/action (such as uri unescaping, perl	102	text into various other formats/action (such as uri unescaping, perl
74	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	};
75		123
76	=item searchable-scrollback<hotkey> (enabled by default)	124	=item searchable-scrollback<hotkey> (enabled by default)
77		125
78	Adds regex search functionality to the scrollback buffer, triggered	126	Adds regex search functionality to the scrollback buffer, triggered
79	by a hotkey (default: C<M-s>). While in search mode, normal terminal	127	by a hotkey (default: C<M-s>). While in search mode, normal terminal
…		…
86	bottom. C<Escape> leaves search mode and returns to the point where search	134	bottom. C<Escape> leaves search mode and returns to the point where search
87	was started, while C<Enter> or C<Return> stay at the current position and	135	was started, while C<Enter> or C<Return> stay at the current position and
88	additionally stores the first match in the current line into the primary	136	additionally stores the first match in the current line into the primary
89	selection.	137	selection.
90		138
91	=item digital-clock	139	=item readline (enabled by default)
92		140
93	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.
94		209
95	=item mark-urls	210	=item mark-urls
96		211
97	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
98	make them clickable. When middle-clicked, the program specified in the	213	make them clickable. When middle-clicked, the program specified in the
99	resource C<urlLauncher> (default C<x-www-browser>) will be started with	214	resource C<urlLauncher> (default C<x-www-browser>) will be started with
100	the URL as first argument.	215	the URL as first argument.
101		216
		217	=item xim-onthespot
		218
		219	This (experimental) perl extension implements OnTheSpot editing. It does
		220	not work perfectly, and some input methods don't seem to work well with
		221	OnTheSpot editing in general, but it seems to work at leats for SCIM and
		222	kinput2.
		223
		224	You enable it by specifying this extension and a preedit style of
		225	C<OnTheSpot>, i.e.:
		226
		227	@@RXVT_NAME@@ -pt OnTheSpot -pe xim-onthespot
		228
		229	=item automove-background
		230
		231	This is basically a one-line extension that dynamically changes the background pixmap offset
		232	to the window position, in effect creating the same effect as pseudo transparency with
		233	a custom pixmap. No scaling is supported in this mode. Exmaple:
		234
		235	@@RXVT_NAME@@ -pixmap background.xpm -pe automove-background
		236
102	=item block-graphics-to-ascii	237	=item block-graphics-to-ascii
103		238
104	A not very useful example of filtering all text output to the terminal,	239	A not very useful example of filtering all text output to the terminal,
105	by replacing all line-drawing characters (U+2500 .. U+259F) by a	240	by replacing all line-drawing characters (U+2500 .. U+259F) by a
106	similar-looking ascii character.	241	similar-looking ascii character.
107		242
		243	=item digital-clock
		244
		245	Displays a digital clock using the built-in overlay.
		246
108	=item example-refresh-hooks	247	=item example-refresh-hooks
109		248
110	Displays a very simple digital clock in the upper right corner of the	249	Displays a very simple digital clock in the upper right corner of the
111	window. Illustrates overwriting the refresh callbacks to create your own	250	window. Illustrates overwriting the refresh callbacks to create your own
112	overlays or changes.	251	overlays or changes.
		252
		253	=item selection-pastebin
		254
		255	This is a little rarely useful extension that Uploads the selection as
		256	textfile to a remote site (or does other things). (The implementation is
		257	not currently secure for use in a multiuser environment as it writes to
		258	F</tmp> directly.).
		259
		260	It listens to the C<selection-pastebin:remote-pastebin> keyboard command,
		261	i.e.
		262
		263	URxvt.keysym.C-M-e: perl:selection-pastebin:remote-pastebin
		264
		265	Pressing this combination runs a command with C<%> replaced by the name of
		266	the textfile. This command can be set via a resource:
		267
		268	URxvt.selection-pastebin.cmd: rsync -apP % ruth:/var/www/www.ta-sa.org/files/txt/.
		269
		270	And the default is likely not useful to anybody but the few people around
		271	here :)
		272
		273	The name of the textfile is the hex encoded md5 sum of the selection, so
		274	the same content should lead to the same filename.
		275
		276	After a successful upload the selection will be replaced by the text given
		277	in the C<selection-pastebin-url> resource (again, the % is the placeholder
		278	for the filename):
		279
		280	URxvt.selection-pastebin.url: http://www.ta-sa.org/files/txt/%
113		281
114	=back	282	=back
115		283
116	=head1 API DOCUMENTATION	284	=head1 API DOCUMENTATION
117		285
…		…
190	called whenever the relevant event happens.	358	called whenever the relevant event happens.
191		359
192	The first argument passed to them is an extension oject as described in	360	The first argument passed to them is an extension oject as described in
193	the in the C<Extension Objects> section.	361	the in the C<Extension Objects> section.
194		362
195	B<All> of these hooks must return a boolean value. If it is true, then the	363	B<All> of these hooks must return a boolean value. If any of the called
196	event counts as being I<consumed>, and the invocation of other hooks is	364	hooks returns true, then the event counts as being I<consumed>, and the
197	skipped, and the relevant action might not be carried out by the C++ code.	365	relevant action might not be carried out by the C++ code.
198		366
199	I<< When in doubt, return a false value (preferably C<()>). >>	367	I<< When in doubt, return a false value (preferably C<()>). >>
200		368
201	=over 4	369	=over 4
202		370
203	=item on_init $term	371	=item on_init $term
204		372
205	Called after a new terminal object has been initialized, but before	373	Called after a new terminal object has been initialized, but before
206	windows are created or the command gets run. Most methods are unsafe to	374	windows are created or the command gets run. Most methods are unsafe to
207	call or deliver senseless data, as terminal size and other characteristics	375	call or deliver senseless data, as terminal size and other characteristics
208	have not yet been determined. You can safely query and change resources,	376	have not yet been determined. You can safely query and change resources
209	though.	377	and options, though. For many purposes the C<on_start> hook is a better
		378	place.
		379
		380	=item on_start $term
		381
		382	Called at the very end of initialisation of a new terminal, just before
		383	trying to map (display) the toplevel and returning to the mainloop.
		384
		385	=item on_destroy $term
		386
		387	Called whenever something tries to destroy terminal, when the terminal is
		388	still fully functional (not for long, though).
210		389
211	=item on_reset $term	390	=item on_reset $term
212		391
213	Called after the screen is "reset" for any reason, such as resizing or	392	Called after the screen is "reset" for any reason, such as resizing or
214	control sequences. Here is where you can react on changes to size-related	393	control sequences. Here is where you can react on changes to size-related
215	variables.	394	variables.
216		395
217	=item on_start $term	396	=item on_child_start $term, $pid
218		397
219	Called at the very end of initialisation of a new terminal, just before	398	Called just after the child process has been C<fork>ed.
220	returning to the mainloop.	399
		400	=item on_child_exit $term, $status
		401
		402	Called just after the child process has exited. C<$status> is the status
		403	from C<waitpid>.
221		404
222	=item on_sel_make $term, $eventtime	405	=item on_sel_make $term, $eventtime
223		406
224	Called whenever a selection has been made by the user, but before the	407	Called whenever a selection has been made by the user, but before the
225	selection text is copied, so changes to the beginning, end or type of the	408	selection text is copied, so changes to the beginning, end or type of the
…		…
318		501
319	Called whenever the user presses a key combination that has a	502	Called whenever the user presses a key combination that has a
320	C<perl:string> action bound to it (see description of the B<keysym>	503	C<perl:string> action bound to it (see description of the B<keysym>
321	resource in the @@RXVT_NAME@@(1) manpage).	504	resource in the @@RXVT_NAME@@(1) manpage).
322		505
		506	=item on_x_event $term, $event
		507
		508	Called on every X event received on the vt window (and possibly other
		509	windows). Should only be used as a last resort. Most event structure
		510	members are not passed.
		511
323	=item on_focus_in $term	512	=item on_focus_in $term
324		513
325	Called whenever the window gets the keyboard focus, before rxvt-unicode	514	Called whenever the window gets the keyboard focus, before rxvt-unicode
326	does focus in processing.	515	does focus in processing.
327		516
328	=item on_focus_out $term	517	=item on_focus_out $term
329		518
330	Called wheneever the window loses keyboard focus, before rxvt-unicode does	519	Called wheneever the window loses keyboard focus, before rxvt-unicode does
331	focus out processing.	520	focus out processing.
332		521
		522	=item on_configure_notify $term, $event
		523
		524	=item on_property_notify $term, $event
		525
333	=item on_key_press $term, $event, $keysym, $octets	526	=item on_key_press $term, $event, $keysym, $octets
334		527
335	=item on_key_release $term, $event, $keysym	528	=item on_key_release $term, $event, $keysym
336		529
337	=item on_button_press $term, $event	530	=item on_button_press $term, $event
…		…
346		539
347	Called whenever the corresponding X event is received for the terminal If	540	Called whenever the corresponding X event is received for the terminal If
348	the hook returns true, then the even will be ignored by rxvt-unicode.	541	the hook returns true, then the even will be ignored by rxvt-unicode.
349		542
350	The event is a hash with most values as named by Xlib (see the XEvent	543	The event is a hash with most values as named by Xlib (see the XEvent
351	manpage), with the additional members C<row> and C<col>, which are the row	544	manpage), with the additional members C<row> and C<col>, which are the
352	and column under the mouse cursor.	545	(real, not screen-based) row and column under the mouse cursor.
353		546
354	C<on_key_press> additionally receives the string rxvt-unicode would	547	C<on_key_press> additionally receives the string rxvt-unicode would
355	output, if any, in locale-specific encoding.	548	output, if any, in locale-specific encoding.
356		549
357	subwindow.	550	subwindow.
		551
		552	=item on_client_message $term, $event
		553
		554	=item on_wm_protocols $term, $event
		555
		556	=item on_wm_delete_window $term, $event
		557
		558	Called when various types of ClientMessage events are received (all with
		559	format=32, WM_PROTOCOLS or WM_PROTOCOLS:WM_DELETE_WINDOW).
358		560
359	=back	561	=back
360		562
361	=cut	563	=cut
362		564
…		…
368	use Scalar::Util ();	570	use Scalar::Util ();
369	use List::Util ();	571	use List::Util ();
370		572
371	our $VERSION = 1;	573	our $VERSION = 1;
372	our $TERM;	574	our $TERM;
		575	our @TERM_INIT;
		576	our @TERM_EXT;
373	our @HOOKNAME;	577	our @HOOKNAME;
374	our %HOOKTYPE = map +($HOOKNAME[$_] => $_), 0..$#HOOKNAME;	578	our %HOOKTYPE = map +($HOOKNAME[$_] => $_), 0..$#HOOKNAME;
375	our %OPTION;	579	our %OPTION;
376		580
377	our $LIBDIR;	581	our $LIBDIR;
378	our $RESNAME;	582	our $RESNAME;
379	our $RESCLASS;	583	our $RESCLASS;
380	our $RXVTNAME;	584	our $RXVTNAME;
381		585
		586	our $NOCHAR = chr 0xffff;
		587
382	=head2 Variables in the C<urxvt> Package	588	=head2 Variables in the C<urxvt> Package
383		589
384	=over 4	590	=over 4
385		591
386	=item $urxvt::LIBDIR	592	=item $urxvt::LIBDIR
…		…
398		604
399	=item $urxvt::TERM	605	=item $urxvt::TERM
400		606
401	The current terminal. This variable stores the current C<urxvt::term>	607	The current terminal. This variable stores the current C<urxvt::term>
402	object, whenever a callback/hook is executing.	608	object, whenever a callback/hook is executing.
		609
		610	=item @urxvt::TERM_INIT
		611
		612	All coderefs in this array will be called as methods of the next newly
		613	created C<urxvt::term> object (during the C<on_init> phase). The array
		614	gets cleared before the codereferences that were in it are being executed,
		615	so coderefs can push themselves onto it again if they so desire.
		616
		617	This complements to the perl-eval commandline option, but gets executed
		618	first.
		619
		620	=item @urxvt::TERM_EXT
		621
		622	Works similar to C<@TERM_INIT>, but contains perl package/class names, which
		623	get registered as normal extensions after calling the hooks in C<@TERM_INIT>
		624	but before other extensions. Gets cleared just like C<@TERM_INIT>.
403		625
404	=back	626	=back
405		627
406	=head2 Functions in the C<urxvt> Package	628	=head2 Functions in the C<urxvt> Package
407		629
…		…
422	Using this function has the advantage that its output ends up in the	644	Using this function has the advantage that its output ends up in the
423	correct place, e.g. on stderr of the connecting urxvtc client.	645	correct place, e.g. on stderr of the connecting urxvtc client.
424		646
425	Messages have a size limit of 1023 bytes currently.	647	Messages have a size limit of 1023 bytes currently.
426		648
427	=item $is_safe = urxvt::safe
428
429	Returns true when it is safe to do potentially unsafe things, such as
430	evaluating perl code specified by the user. This is true when urxvt was
431	started setuid or setgid.
432
433	=item $time = urxvt::NOW	649	=item $time = urxvt::NOW
434		650
435	Returns the "current time" (as per the event loop).	651	Returns the "current time" (as per the event loop).
436		652
437	=item urxvt::CurrentTime	653	=item urxvt::CurrentTime
438		654
439	=item urxvt::ShiftMask, LockMask, ControlMask, Mod1Mask, Mod2Mask,	655	=item urxvt::ShiftMask, LockMask, ControlMask, Mod1Mask, Mod2Mask,
440	Mod3Mask, Mod4Mask, Mod5Mask, Button1Mask, Button2Mask, Button3Mask,	656	Mod3Mask, Mod4Mask, Mod5Mask, Button1Mask, Button2Mask, Button3Mask,
441	Button4Mask, Button5Mask, AnyModifier	657	Button4Mask, Button5Mask, AnyModifier
		658
		659	=item urxvt::NoEventMask, KeyPressMask, KeyReleaseMask,
		660	ButtonPressMask, ButtonReleaseMask, EnterWindowMask, LeaveWindowMask,
		661	PointerMotionMask, PointerMotionHintMask, Button1MotionMask, Button2MotionMask,
		662	Button3MotionMask, Button4MotionMask, Button5MotionMask, ButtonMotionMask,
		663	KeymapStateMask, ExposureMask, VisibilityChangeMask, StructureNotifyMask,
		664	ResizeRedirectMask, SubstructureNotifyMask, SubstructureRedirectMask,
		665	FocusChangeMask, PropertyChangeMask, ColormapChangeMask, OwnerGrabButtonMask
		666
		667	=item urxvt::KeyPress, KeyRelease, ButtonPress, ButtonRelease, MotionNotify,
		668	EnterNotify, LeaveNotify, FocusIn, FocusOut, KeymapNotify, Expose,
		669	GraphicsExpose, NoExpose, VisibilityNotify, CreateNotify, DestroyNotify,
		670	UnmapNotify, MapNotify, MapRequest, ReparentNotify, ConfigureNotify,
		671	ConfigureRequest, GravityNotify, ResizeRequest, CirculateNotify,
		672	CirculateRequest, PropertyNotify, SelectionClear, SelectionRequest,
		673	SelectionNotify, ColormapNotify, ClientMessage, MappingNotify
442		674
443	Various constants for use in X calls and event processing.	675	Various constants for use in X calls and event processing.
444		676
445	=back	677	=back
446		678
…		…
497	=back	729	=back
498		730
499	=cut	731	=cut
500		732
501	BEGIN {	733	BEGIN {
502	urxvt->bootstrap;
503
504	# overwrite perl's warn	734	# overwrite perl's warn
505	*CORE::GLOBAL::warn = sub {	735	*CORE::GLOBAL::warn = sub {
506	my $msg = join "", @_;	736	my $msg = join "", @_;
507	$msg .= "\n"	737	$msg .= "\n"
508	unless $msg =~ /\n$/;	738	unless $msg =~ /\n$/;
509	urxvt::warn ($msg);	739	urxvt::warn ($msg);
510	};	740	};
511
512	# %ENV is the original startup environment
513	delete $ENV{IFS};
514	delete $ENV{CDPATH};
515	delete $ENV{BASH_ENV};
516	$ENV{PATH} = "/bin:/sbin:/usr/bin:/usr/sbin:/usr/local/bin:/usr/local/sbin:/opt/bin:/opt/sbin";
517	}	741	}
518		742
519	my @hook_count;	743	no warnings 'utf8';
		744
520	my $verbosity = $ENV{URXVT_PERL_VERBOSITY};	745	my $verbosity = $ENV{URXVT_PERL_VERBOSITY};
521		746
522	sub verbose {	747	sub verbose {
523	my ($level, $msg) = @_;	748	my ($level, $msg) = @_;
524	warn "$msg\n" if $level <= $verbosity;	749	warn "$msg\n" if $level <= $verbosity;
525	}	750	}
526		751
527	my $extension_pkg = "extension0000";
528	my %extension_pkg;	752	my %extension_pkg;
529		753
530	# load a single script into its own package, once only	754	# load a single script into its own package, once only
531	sub extension_package($) {	755	sub extension_package($) {
532	my ($path) = @_;	756	my ($path) = @_;
533		757
534	$extension_pkg{$path} \|\|= do {	758	$extension_pkg{$path} \|\|= do {
535	my $pkg = "urxvt::" . ($extension_pkg++);	759	$path =~ /([^\/\\]+)$/;
		760	my $pkg = $1;
		761	$pkg =~ s/[^[:word:]]/_/g;
		762	$pkg = "urxvt::ext::$pkg";
536		763
537	verbose 3, "loading extension '$path' into package '$pkg'";	764	verbose 3, "loading extension '$path' into package '$pkg'";
538		765
539	open my $fh, "<:raw", $path	766	open my $fh, "<:raw", $path
540	or die "$path: $!";	767	or die "$path: $!";
541		768
542	my $source = untaint	769	my $source =
543	"package $pkg; use strict; use utf8;\n"	770	"package $pkg; use strict; use utf8; no warnings 'utf8';\n"
544	. "use base urxvt::term::extension::;\n"
545	. "#line 1 \"$path\"\n{\n"	771	. "#line 1 \"$path\"\n{\n"
546	. (do { local $/; <$fh> })	772	. (do { local $/; <$fh> })
547	. "\n};\n1";	773	. "\n};\n1";
548		774
549	eval $source	775	eval $source
…		…
563	if ($htype == 0) { # INIT	789	if ($htype == 0) { # INIT
564	my @dirs = ((split /:/, $TERM->resource ("perl_lib")), "$LIBDIR/perl");	790	my @dirs = ((split /:/, $TERM->resource ("perl_lib")), "$LIBDIR/perl");
565		791
566	my %ext_arg;	792	my %ext_arg;
567		793
		794	{
		795	my @init = @TERM_INIT;
		796	@TERM_INIT = ();
		797	$_->($TERM) for @init;
		798	my @pkg = @TERM_EXT;
		799	@TERM_EXT = ();
		800	$TERM->register_package ($_) for @pkg;
		801	}
		802
568	for (map { split /,/, $TERM->resource ("perl_ext_$_") } 1, 2) {	803	for (grep $_, map { split /,/, $TERM->resource ("perl_ext_$_") } 1, 2) {
569	if ($_ eq "default") {	804	if ($_ eq "default") {
570	$ext_arg{$_} \|\|= [] for qw(selection option-popup selection-popup searchable-scrollback);	805	$ext_arg{$_} \|\|= [] for qw(selection option-popup selection-popup searchable-scrollback readline);
571	} elsif (/^-(.*)$/) {	806	} elsif (/^-(.*)$/) {
572	delete $ext_arg{$1};	807	delete $ext_arg{$1};
573	} elsif (/^([^<]+)<(.*)>$/) {	808	} elsif (/^([^<]+)<(.*)>$/) {
574	push @{ $ext_arg{$1} }, $2;	809	push @{ $ext_arg{$1} }, $2;
575	} else {	810	} else {
…		…
598	if $verbosity >= 10;	833	if $verbosity >= 10;
599		834
600	keys %$cb;	835	keys %$cb;
601		836
602	while (my ($pkg, $cb) = each %$cb) {	837	while (my ($pkg, $cb) = each %$cb) {
603	$retval = eval { $cb->($TERM->{_pkg}{$pkg}, @_) }	838	my $retval_ = eval { $cb->($TERM->{_pkg}{$pkg}, @_) };
604	and last;	839	$retval \|\|= $retval_;
605		840
606	if ($@) {	841	if ($@) {
607	$TERM->ungrab; # better to lose the grab than the session	842	$TERM->ungrab; # better to lose the grab than the session
608	warn $@;	843	warn $@;
609	}	844	}
…		…
612	verbose 11, "$HOOKNAME[$htype] returning <$retval>"	847	verbose 11, "$HOOKNAME[$htype] returning <$retval>"
613	if $verbosity >= 11;	848	if $verbosity >= 11;
614	}	849	}
615		850
616	if ($htype == 1) { # DESTROY	851	if ($htype == 1) { # DESTROY
617	if (my $hook = delete $TERM->{_hook}) {
618	for my $htype (0..$#$hook) {
619	$hook_count[$htype] -= scalar keys %{ $hook->[$htype] \|\| {} }
620	or set_should_invoke $htype, 0;
621	}
622	}
623
624	# clear package objects	852	# clear package objects
625	%$_ = () for values %{ $TERM->{_pkg} };	853	%$_ = () for values %{ $TERM->{_pkg} };
626		854
627	# clear package	855	# clear package
628	%$TERM = ();	856	%$TERM = ();
629	}	857	}
630		858
631	$retval	859	$retval
632	}
633
634	sub exec_async(@) {
635	my $pid = fork;
636
637	return
638	if !defined $pid or $pid;
639
640	%ENV = %{ $TERM->env };
641
642	exec @_;
643	_exit 255;
644	}	860	}
645		861
646	# urxvt::term::extension	862	# urxvt::term::extension
647		863
648	package urxvt::term::extension;	864	package urxvt::term::extension;
…		…
654	while (my ($name, $cb) = each %hook) {	870	while (my ($name, $cb) = each %hook) {
655	my $htype = $HOOKTYPE{uc $name};	871	my $htype = $HOOKTYPE{uc $name};
656	defined $htype	872	defined $htype
657	or Carp::croak "unsupported hook type '$name'";	873	or Carp::croak "unsupported hook type '$name'";
658		874
		875	$self->set_should_invoke ($htype, +1)
659	unless (exists $self->{term}{_hook}[$htype]{$pkg}) {	876	unless exists $self->{term}{_hook}[$htype]{$pkg};
660	$hook_count[$htype]++
661	or urxvt::set_should_invoke $htype, 1;
662	}
663		877
664	$self->{term}{_hook}[$htype]{$pkg} = $cb;	878	$self->{term}{_hook}[$htype]{$pkg} = $cb;
665	}	879	}
666	}	880	}
667		881
…		…
672	for my $name (@hook) {	886	for my $name (@hook) {
673	my $htype = $HOOKTYPE{uc $name};	887	my $htype = $HOOKTYPE{uc $name};
674	defined $htype	888	defined $htype
675	or Carp::croak "unsupported hook type '$name'";	889	or Carp::croak "unsupported hook type '$name'";
676		890
		891	$self->set_should_invoke ($htype, -1)
677	if (delete $self->{term}{_hook}[$htype]{$pkg}) {	892	if delete $self->{term}{_hook}[$htype]{$pkg};
678	--$hook_count[$htype]
679	or urxvt::set_should_invoke $htype, 0;
680	}
681	}	893	}
682	}	894	}
683		895
684	our $AUTOLOAD;	896	our $AUTOLOAD;
685		897
…		…
791	# find on_xxx subs in the package and register them	1003	# find on_xxx subs in the package and register them
792	# as hooks	1004	# as hooks
793	sub register_package {	1005	sub register_package {
794	my ($self, $pkg, $argv) = @_;	1006	my ($self, $pkg, $argv) = @_;
795		1007
		1008	no strict 'refs';
		1009
		1010	urxvt::verbose 6, "register package $pkg to $self";
		1011
		1012	@{"$pkg\::ISA"} = urxvt::term::extension::;
		1013
796	my $proxy = bless {	1014	my $proxy = bless {
797	_pkg => $pkg,	1015	_pkg => $pkg,
798	argv => $argv,	1016	argv => $argv,
799	}, $pkg;	1017	}, $pkg;
800	Scalar::Util::weaken ($proxy->{term} = $self);	1018	Scalar::Util::weaken ($proxy->{term} = $self);
…		…
831		1049
832	Destroy the terminal object (close the window, free resources	1050	Destroy the terminal object (close the window, free resources
833	etc.). Please note that @@RXVT_NAME@@ will not exit as long as any event	1051	etc.). Please note that @@RXVT_NAME@@ will not exit as long as any event
834	watchers (timers, io watchers) are still active.	1052	watchers (timers, io watchers) are still active.
835		1053
		1054	=item $term->exec_async ($cmd[, @args])
		1055
		1056	Works like the combination of the C<fork>/C<exec> builtins, which executes
		1057	("starts") programs in the background. This function takes care of setting
		1058	the user environment before exec'ing the command (e.g. C<PATH>) and should
		1059	be preferred over explicit calls to C<exec> or C<system>.
		1060
		1061	Returns the pid of the subprocess or C<undef> on error.
		1062
		1063	=cut
		1064
		1065	sub exec_async {
		1066	my $self = shift;
		1067
		1068	my $pid = fork;
		1069
		1070	return $pid
		1071	if !defined $pid or $pid;
		1072
		1073	%ENV = %{ $self->env };
		1074
		1075	exec @_;
		1076	urxvt::_exit 255;
		1077	}
		1078
836	=item $isset = $term->option ($optval[, $set])	1079	=item $isset = $term->option ($optval[, $set])
837		1080
838	Returns true if the option specified by C<$optval> is enabled, and	1081	Returns true if the option specified by C<$optval> is enabled, and
839	optionally change it. All option values are stored by name in the hash	1082	optionally change it. All option values are stored by name in the hash
840	C<%urxvt::OPTION>. Options not enabled in this binary are not in the hash.	1083	C<%urxvt::OPTION>. Options not enabled in this binary are not in the hash.
…		…
842	Here is a a likely non-exhaustive list of option names, please see the	1085	Here is a a likely non-exhaustive list of option names, please see the
843	source file F</src/optinc.h> to see the actual list:	1086	source file F</src/optinc.h> to see the actual list:
844		1087
845	borderLess console cursorBlink cursorUnderline hold iconic insecure	1088	borderLess console cursorBlink cursorUnderline hold iconic insecure
846	intensityStyles jumpScroll loginShell mapAlert meta8 mouseWheelScrollPage	1089	intensityStyles jumpScroll loginShell mapAlert meta8 mouseWheelScrollPage
847	pastableTabs pointerBlank reverseVideo scrollBar scrollBar_floating	1090	override-redirect pastableTabs pointerBlank reverseVideo scrollBar
848	scrollBar_right scrollTtyKeypress scrollTtyOutput scrollWithBuffer	1091	scrollBar_floating scrollBar_right scrollTtyKeypress scrollTtyOutput
849	secondaryScreen secondaryScroll skipBuiltinGlyphs transparent	1092	scrollWithBuffer secondaryScreen secondaryScroll skipBuiltinGlyphs
850	tripleclickwords utmpInhibit visualBell	1093	transparent tripleclickwords utmpInhibit visualBell
851		1094
852	=item $value = $term->resource ($name[, $newval])	1095	=item $value = $term->resource ($name[, $newval])
853		1096
854	Returns the current resource value associated with a given name and	1097	Returns the current resource value associated with a given name and
855	optionally sets a new value. Setting values is most useful in the C<init>	1098	optionally sets a new value. Setting values is most useful in the C<init>
…		…
872		1115
873	answerbackstring backgroundPixmap backspace_key boldFont boldItalicFont	1116	answerbackstring backgroundPixmap backspace_key boldFont boldItalicFont
874	borderLess color cursorBlink cursorUnderline cutchars delete_key	1117	borderLess color cursorBlink cursorUnderline cutchars delete_key
875	display_name embed ext_bwidth fade font geometry hold iconName	1118	display_name embed ext_bwidth fade font geometry hold iconName
876	imFont imLocale inputMethod insecure int_bwidth intensityStyles	1119	imFont imLocale inputMethod insecure int_bwidth intensityStyles
877	italicFont jumpScroll lineSpace loginShell mapAlert menu meta8 modifier	1120	italicFont jumpScroll lineSpace loginShell mapAlert meta8 modifier
878	mouseWheelScrollPage name pastableTabs path perl_eval perl_ext_1 perl_ext_2	1121	mouseWheelScrollPage name override_redirect pastableTabs path perl_eval
879	perl_lib pointerBlank pointerBlankDelay preeditType print_pipe pty_fd	1122	perl_ext_1 perl_ext_2 perl_lib pointerBlank pointerBlankDelay
880	reverseVideo saveLines scrollBar scrollBar_align scrollBar_floating	1123	preeditType print_pipe pty_fd reverseVideo saveLines scrollBar
881	scrollBar_right scrollBar_thickness scrollTtyKeypress scrollTtyOutput	1124	scrollBar_align scrollBar_floating scrollBar_right scrollBar_thickness
882	scrollWithBuffer scrollstyle secondaryScreen secondaryScroll selectstyle	1125	scrollTtyKeypress scrollTtyOutput scrollWithBuffer scrollstyle
883	shade term_name title transparent transparent_all tripleclickwords	1126	secondaryScreen secondaryScroll selectstyle shade term_name title
884	utmpInhibit visualBell	1127	transient_for transparent transparent_all tripleclickwords utmpInhibit
		1128	visualBell
885		1129
886	=cut	1130	=cut
887		1131
888	sub resource($$;$) {	1132	sub resource($$;$) {
889	my ($self, $name) = (shift, shift);	1133	my ($self, $name) = (shift, shift);
…		…
1063		1307
1064	Normally its not a good idea to use this function, as programs might be	1308	Normally its not a good idea to use this function, as programs might be
1065	confused by changes in cursor position or scrolling. Its useful inside a	1309	confused by changes in cursor position or scrolling. Its useful inside a
1066	C<on_add_lines> hook, though.	1310	C<on_add_lines> hook, though.
1067		1311
		1312	=item $term->scr_change_screen ($screen)
		1313
		1314	Switch to given screen - 0 primary, 1 secondary.
		1315
1068	=item $term->cmd_parse ($octets)	1316	=item $term->cmd_parse ($octets)
1069		1317
1070	Similar to C<scr_add_lines>, but the argument must be in the	1318	Similar to C<scr_add_lines>, but the argument must be in the
1071	locale-specific encoding of the terminal and can contain command sequences	1319	locale-specific encoding of the terminal and can contain command sequences
1072	(escape codes) that will be interpreted.	1320	(escape codes) that will be interpreted.
…		…
1082	Replaces the event mask of the pty watcher by the given event mask. Can	1330	Replaces the event mask of the pty watcher by the given event mask. Can
1083	be used to suppress input and output handling to the pty/tty. See the	1331	be used to suppress input and output handling to the pty/tty. See the
1084	description of C<< urxvt::timer->events >>. Make sure to always restore	1332	description of C<< urxvt::timer->events >>. Make sure to always restore
1085	the previous value.	1333	the previous value.
1086		1334
		1335	=item $fd = $term->pty_fd
		1336
		1337	Returns the master file descriptor for the pty in use, or C<-1> if no pty
		1338	is used.
		1339
1087	=item $windowid = $term->parent	1340	=item $windowid = $term->parent
1088		1341
1089	Return the window id of the toplevel window.	1342	Return the window id of the toplevel window.
1090		1343
1091	=item $windowid = $term->vt	1344	=item $windowid = $term->vt
1092		1345
1093	Return the window id of the terminal window.	1346	Return the window id of the terminal window.
1094		1347
		1348	=item $term->vt_emask_add ($x_event_mask)
		1349
		1350	Adds the specified events to the vt event mask. Useful e.g. when you want
		1351	to receive pointer events all the times:
		1352
		1353	$term->vt_emask_add (urxvt::PointerMotionMask);
		1354
1095	=item $window_width = $term->width	1355	=item $window_width = $term->width
1096		1356
1097	=item $window_height = $term->height	1357	=item $window_height = $term->height
1098		1358
1099	=item $font_width = $term->fwidth	1359	=item $font_width = $term->fwidth
…		…
1112		1372
1113	=item $max_scrollback = $term->saveLines	1373	=item $max_scrollback = $term->saveLines
1114		1374
1115	=item $nrow_plus_saveLines = $term->total_rows	1375	=item $nrow_plus_saveLines = $term->total_rows
1116		1376
1117	=item $lines_in_scrollback = $term->nsaved	1377	=item $topmost_scrollback_row = $term->top_row
1118		1378
1119	Return various integers describing terminal characteristics.	1379	Return various integers describing terminal characteristics.
1120		1380
1121	=item $x_display = $term->display_id	1381	=item $x_display = $term->display_id
1122		1382
…		…
1148	=item $modifiermask = $term->ModNumLockMask	1408	=item $modifiermask = $term->ModNumLockMask
1149		1409
1150	Return the modifier masks corresponding to the "ISO Level 3 Shift" (often	1410	Return the modifier masks corresponding to the "ISO Level 3 Shift" (often
1151	AltGr), the meta key (often Alt) and the num lock key, if applicable.	1411	AltGr), the meta key (often Alt) and the num lock key, if applicable.
1152		1412
		1413	=item $screen = $term->current_screen
		1414
		1415	Returns the currently displayed screen (0 primary, 1 secondary).
		1416
		1417	=item $cursor_is_hidden = $term->hidden_cursor
		1418
		1419	Returns wether the cursor is currently hidden or not.
		1420
1153	=item $view_start = $term->view_start ([$newvalue])	1421	=item $view_start = $term->view_start ([$newvalue])
1154		1422
1155	Returns the negative row number of the topmost line. Minimum value is	1423	Returns the row number of the topmost displayed line. Maximum value is
1156	C<0>, which displays the normal terminal contents. Larger values scroll	1424	C<0>, which displays the normal terminal contents. Lower values scroll
1157	this many lines into the scrollback buffer.	1425	this many lines into the scrollback buffer.
1158		1426
1159	=item $term->want_refresh	1427	=item $term->want_refresh
1160		1428
1161	Requests a screen refresh. At the next opportunity, rxvt-unicode will	1429	Requests a screen refresh. At the next opportunity, rxvt-unicode will
…		…
1176	line, starting at column C<$start_col> (default C<0>), which is useful	1444	line, starting at column C<$start_col> (default C<0>), which is useful
1177	to replace only parts of a line. The font index in the rendition will	1445	to replace only parts of a line. The font index in the rendition will
1178	automatically be updated.	1446	automatically be updated.
1179		1447
1180	C<$text> is in a special encoding: tabs and wide characters that use more	1448	C<$text> is in a special encoding: tabs and wide characters that use more
1181	than one cell when displayed are padded with urxvt::NOCHAR characters	1449	than one cell when displayed are padded with C<$urxvt::NOCHAR> (chr 65535)
1182	(C<chr 65535>). Characters with combining characters and other characters	1450	characters. Characters with combining characters and other characters that
1183	that do not fit into the normal tetx encoding will be replaced with	1451	do not fit into the normal tetx encoding will be replaced with characters
1184	characters in the private use area.	1452	in the private use area.
1185		1453
1186	You have to obey this encoding when changing text. The advantage is	1454	You have to obey this encoding when changing text. The advantage is
1187	that C<substr> and similar functions work on screen cells and not on	1455	that C<substr> and similar functions work on screen cells and not on
1188	characters.	1456	characters.
1189		1457
…		…
1364		1632
1365	Calls XUngrab for the most recent grab. Is called automatically on	1633	Calls XUngrab for the most recent grab. Is called automatically on
1366	evaluation errors, as it is better to lose the grab in the error case as	1634	evaluation errors, as it is better to lose the grab in the error case as
1367	the session.	1635	the session.
1368		1636
		1637	=item $atom = $term->XInternAtom ($atom_name[, $only_if_exists])
		1638
		1639	=item $atom_name = $term->XGetAtomName ($atom)
		1640
		1641	=item @atoms = $term->XListProperties ($window)
		1642
		1643	=item ($type,$format,$octets) = $term->XGetWindowProperty ($window, $property)
		1644
		1645	=item $term->XChangeWindowProperty ($window, $property, $type, $format, $octets)
		1646
		1647	=item $term->XDeleteProperty ($window, $property)
		1648
		1649	=item $window = $term->DefaultRootWindow
		1650
		1651	=item $term->XReparentWindow ($window, $parent, [$x, $y])
		1652
		1653	=item $term->XMapWindow ($window)
		1654
		1655	=item $term->XUnmapWindow ($window)
		1656
		1657	=item $term->XMoveResizeWindow ($window, $x, $y, $width, $height)
		1658
		1659	=item ($x, $y, $child_window) = $term->XTranslateCoordinates ($src, $dst, $x, $y)
		1660
		1661	=item $term->XChangeInput ($window, $add_events[, $del_events])
		1662
		1663	Various X or X-related functions. The C<$term> object only serves as
		1664	the source of the display, otherwise those functions map more-or-less
		1665	directory onto the X functions of the same name.
		1666
1369	=back	1667	=back
1370		1668
1371	=cut	1669	=cut
1372		1670
1373	package urxvt::popup;	1671	package urxvt::popup;
…		…
1474	my $env = $self->{term}->env;	1772	my $env = $self->{term}->env;
1475	# we can't hope to reproduce the locale algorithm, so nuke LC_ALL and set LC_CTYPE.	1773	# we can't hope to reproduce the locale algorithm, so nuke LC_ALL and set LC_CTYPE.
1476	delete $env->{LC_ALL};	1774	delete $env->{LC_ALL};
1477	$env->{LC_CTYPE} = $self->{term}->locale;	1775	$env->{LC_CTYPE} = $self->{term}->locale;
1478		1776
1479	urxvt::term->new ($env, $self->{term}->resource ("name"),	1777	urxvt::term->new ($env, "popup",
1480	"--perl-lib" => "", "--perl-ext-common" => "", "-pty-fd" => -1, "-sl" => 0, "-b" => 0,	1778	"--perl-lib" => "", "--perl-ext-common" => "",
		1779	"-pty-fd" => -1, "-sl" => 0,
		1780	"-b" => 1, "-bd" => "grey80", "-bl", "-override-redirect",
1481	"--transient-for" => $self->{term}->parent,	1781	"--transient-for" => $self->{term}->parent,
1482	"-display" => $self->{term}->display_id,	1782	"-display" => $self->{term}->display_id,
1483	"-pe" => "urxvt-popup")	1783	"-pe" => "urxvt-popup")
1484	or die "unable to create popup window\n";	1784	or die "unable to create popup window\n";
1485	}	1785	}
…		…
1490	delete $self->{term}{_destroy}{$self};	1790	delete $self->{term}{_destroy}{$self};
1491	$self->{term}->ungrab;	1791	$self->{term}->ungrab;
1492	}	1792	}
1493		1793
1494	=back	1794	=back
		1795
		1796	=cut
		1797
		1798	package urxvt::watcher;
		1799
		1800	@urxvt::timer::ISA = __PACKAGE__;
		1801	@urxvt::iow::ISA = __PACKAGE__;
		1802	@urxvt::pw::ISA = __PACKAGE__;
		1803	@urxvt::iw::ISA = __PACKAGE__;
1495		1804
1496	=head2 The C<urxvt::timer> Class	1805	=head2 The C<urxvt::timer> Class
1497		1806
1498	This class implements timer watchers/events. Time is represented as a	1807	This class implements timer watchers/events. Time is represented as a
1499	fractional number of seconds since the epoch. Example:	1808	fractional number of seconds since the epoch. Example:
…		…
1537	Start the timer.	1846	Start the timer.
1538		1847
1539	=item $timer = $timer->start ($tstamp)	1848	=item $timer = $timer->start ($tstamp)
1540		1849
1541	Set the event trigger time to C<$tstamp> and start the timer.	1850	Set the event trigger time to C<$tstamp> and start the timer.
		1851
		1852	=item $timer = $timer->after ($delay)
		1853
		1854	Like C<start>, but sets the expiry timer to c<urxvt::NOW + $delay>.
1542		1855
1543	=item $timer = $timer->stop	1856	=item $timer = $timer->stop
1544		1857
1545	Stop the timer.	1858	Stop the timer.
1546		1859
…		…
1593		1906
1594	Stop watching for events on the given filehandle.	1907	Stop watching for events on the given filehandle.
1595		1908
1596	=back	1909	=back
1597		1910
		1911	=head2 The C<urxvt::iw> Class
		1912
		1913	This class implements idle watchers, that get called automatically when
		1914	the process is idle. They should return as fast as possible, after doing
		1915	some useful work.
		1916
		1917	=over 4
		1918
		1919	=item $iw = new urxvt::iw
		1920
		1921	Create a new idle watcher object in stopped state.
		1922
		1923	=item $iw = $iw->cb (sub { my ($iw) = @_; ... })
		1924
		1925	Set the callback to be called when the watcher triggers.
		1926
		1927	=item $timer = $timer->start
		1928
		1929	Start the watcher.
		1930
		1931	=item $timer = $timer->stop
		1932
		1933	Stop the watcher.
		1934
		1935	=back
		1936
		1937	=head2 The C<urxvt::pw> Class
		1938
		1939	This class implements process watchers. They create an event whenever a
		1940	process exits, after which they stop automatically.
		1941
		1942	my $pid = fork;
		1943	...
		1944	$term->{pw} = urxvt::pw
		1945	->new
		1946	->start ($pid)
		1947	->cb (sub {
		1948	my ($pw, $exit_status) = @_;
		1949	...
		1950	});
		1951
		1952	=over 4
		1953
		1954	=item $pw = new urxvt::pw
		1955
		1956	Create a new process watcher in stopped state.
		1957
		1958	=item $pw = $pw->cb (sub { my ($pw, $exit_status) = @_; ... })
		1959
		1960	Set the callback to be called when the timer triggers.
		1961
		1962	=item $pw = $timer->start ($pid)
		1963
		1964	Tells the wqtcher to start watching for process C<$pid>.
		1965
		1966	=item $pw = $pw->stop
		1967
		1968	Stop the watcher.
		1969
		1970	=back
		1971
1598	=head1 ENVIRONMENT	1972	=head1 ENVIRONMENT
1599		1973
1600	=head2 URXVT_PERL_VERBOSITY	1974	=head2 URXVT_PERL_VERBOSITY
1601		1975
1602	This variable controls the verbosity level of the perl extension. Higher	1976	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.87 by root, Thu Jan 12 05:37:34 2006 UTC vs. Revision 1.128 by root, Wed Jan 25 00:57:57 2006 UTC

Diff Legend

Comparing rxvt-unicode/src/urxvt.pm (file contents):
Revision 1.87 by root, Thu Jan 12 05:37:34 2006 UTC vs.
Revision 1.128 by root, Wed Jan 25 00:57:57 2006 UTC