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

Comparing rxvt-unicode/src/urxvt.pm (file contents):
Revision 1.84 by root, Thu Jan 12 02:20:56 2006 UTC vs.
Revision 1.120 by root, Fri Jan 20 22:05:41 2006 UTC

…		…
35		35
36	You can activate them like this:	36	You can activate them like this:
37		37
38	@@RXVT_NAME@@ -pe <extensionname>	38	@@RXVT_NAME@@ -pe <extensionname>
39		39
		40	Or by adding them to the resource for extensions loaded by default:
		41
		42	URxvt.perl-ext-common: default,automove-background,selection-autotransform
		43
40	=over 4	44	=over 4
41		45
42	=item selection (enabled by default)	46	=item selection (enabled by default)
43		47
44	(More) intelligent selection. This extension tries to be more intelligent	48	(More) intelligent selection. This extension tries to be more intelligent
45	when the user extends selections (double-click). Right now, it tries to	49	when the user extends selections (double-click and further clicks). Right
46	select urls and complete shell-quoted arguments, which is very convenient,	50	now, it tries to select words, urls and complete shell-quoted
47	too, if your F<ls> supports C<--quoting-style=shell>.	51	arguments, which is very convenient, too, if your F<ls> supports
		52	C<--quoting-style=shell>.
48		53
		54	A double-click usually selects the word under the cursor, further clicks
		55	will enlarge the selection.
		56
		57	The selection works by trying to match a number of regexes and displaying
		58	them in increasing order of length. You can add your own regexes by
		59	specifying resources of the form:
		60
		61	URxvt.selection.pattern-0: perl-regex
		62	URxvt.selection.pattern-1: perl-regex
		63	...
		64
		65	The index number (0, 1...) must not have any holes, and each regex must
		66	contain at least one pair of capturing parentheses, which will be used for
		67	the match. For example, the followign adds a regex that matches everything
		68	between two vertical bars:
		69
		70	URxvt.selection.pattern-0: \\\|([^\|]+)\\\|
		71
		72	You can look at the source of the selection extension to see more
		73	interesting uses, such as parsing a line from beginning to end.
		74
49	It also offers the following bindable keyboard command:	75	This extension also offers following bindable keyboard commands:
50		76
51	=over 4	77	=over 4
52		78
53	=item rot13	79	=item rot13
54		80
…		…
65		91
66	=item selection-popup (enabled by default)	92	=item selection-popup (enabled by default)
67		93
68	Binds a popup menu to Ctrl-Button3 that lets you convert the selection	94	Binds a popup menu to Ctrl-Button3 that lets you convert the selection
69	text into various other formats/action (such as uri unescaping, perl	95	text into various other formats/action (such as uri unescaping, perl
70	evalution, web-browser starting etc.), depending on content.	96	evaluation, web-browser starting etc.), depending on content.
		97
		98	Other extensions can extend this popup menu by pushing a code reference
		99	onto C<@{ $term->{selection_popup_hook} }>, that is called whenever the
		100	popup is displayed.
		101
		102	It's sole argument is the popup menu, which can be modified. The selection
		103	is in C<$_>, which can be used to decide wether to add something or not.
		104	It should either return nothing or a string and a code reference. The
		105	string will be used as button text and the code reference will be called
		106	when the button gets activated and should transform C<$_>.
		107
		108	The following will add an entry C<a to b> that transforms all C<a>s in
		109	the selection to C<b>s, but only if the selection currently contains any
		110	C<a>s:
		111
		112	push @{ $self->{term}{selection_popup_hook} }, sub {
		113	/a/ ? ("a to be" => sub { s/a/b/g }
		114	: ()
		115	};
71		116
72	=item searchable-scrollback<hotkey> (enabled by default)	117	=item searchable-scrollback<hotkey> (enabled by default)
73		118
74	Adds regex search functionality to the scrollback buffer, triggered	119	Adds regex search functionality to the scrollback buffer, triggered
75	by a hotkey (default: C<M-s>). When in search mode, normal terminal	120	by a hotkey (default: C<M-s>). While in search mode, normal terminal
76	input/output is suspended.	121	input/output is suspended and a regex is displayed at the bottom of the
		122	screen.
77		123
78	C</> starts an incremental regex search, C<n> searches further, C<p> or	124	Inputting characters appends them to the regex and continues incremental
79	C<N> jump to the previous match, C<G> jumps to the bottom and clears the	125	search. C<BackSpace> removes a character from the regex, C<Up> and C<Down>
80	history, C<enter> leaves search mode at the current position and C<escape>	126	search upwards/downwards in the scrollback buffer, C<End> jumps to the
81	returns to the original position.	127	bottom. C<Escape> leaves search mode and returns to the point where search
		128	was started, while C<Enter> or C<Return> stay at the current position and
		129	additionally stores the first match in the current line into the primary
		130	selection.
82		131
83	=item digital-clock	132	=item selection-autotransform
84		133
85	Displays a digital clock using the built-in overlay.	134	This selection allows you to do automatic transforms on a selection
		135	whenever a selection is made.
		136
		137	It works by specifying perl snippets (most useful is a single C<s///>
		138	operator) that modify C<$_> as resources:
		139
		140	URxvt.selection-autotransform.0: transform
		141	URxvt.selection-autotransform.1: transform
		142	...
		143
		144	For example, the following will transform selections of the form
		145	C<filename:number>, often seen in compiler messages, into C<vi +$filename
		146	$word>:
		147
		148	URxvt.selection-autotransform.0: s/^([^:[:space:]]+):(\\d+):?$/vi +$2 \\Q$1\\E\\x0d/
		149
		150	And this example matches the same,but replaces it with vi-commands you can
		151	paste directly into your (vi :) editor:
		152
		153	URxvt.selection-autotransform.0: s/^([^:[:space:]]+(\\d+):?$/:e \\Q$1\\E\\x0d:$2\\x0d/
		154
		155	Of course, this can be modified to suit your needs and your editor :)
		156
		157	To expand the example above to typical perl error messages ("XXX at
		158	FILENAME line YYY."), you need a slightly more elaborate solution:
		159
		160	URxvt.selection.pattern-0: ( at .*? line \\d+[,.])
		161	URxvt.selection-autotransform.0: s/^ at (.*?) line (\\d+)[,.]$/:e \\Q$1\E\\x0d:$2\\x0d/
		162
		163	The first line tells the selection code to treat the unchanging part of
		164	every error message as a selection pattern, and the second line transforms
		165	the message into vi commands to load the file.
		166
		167	=item tabbed
		168
		169	This transforms the terminal into a tabbar with additional terminals, that
		170	is, it implements what is commonly refered to as "tabbed terminal". The topmost line
		171	displays a "[NEW]" button, which, when clicked, will add a new tab, followed by one
		172	button per tab.
		173
		174	Clicking a button will activate that tab. Pressing B<Shift-Left> and
		175	B<Shift-Right> will switch to the tab left or right of the current one,
		176	while B<Shift-Down> creates a new tab.
86		177
87	=item mark-urls	178	=item mark-urls
88		179
89	Uses per-line display filtering (C<on_line_update>) to underline urls and	180	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	181	make them clickable. When middle-clicked, the program specified in the
91	resource C<urlLauncher> (default C<x-www-browser>) will be started.	182	resource C<urlLauncher> (default C<x-www-browser>) will be started with
		183	the URL as first argument.
		184
		185	=item automove-background
		186
		187	This is basically a one-line extension that dynamically changes the background pixmap offset
		188	to the window position, in effect creating the same effect as pseudo transparency with
		189	a custom pixmap. No scaling is supported in this mode. Exmaple:
		190
		191	@@RXVT_NAME@@ -pixmap background.xpm -pe automove-background
92		192
93	=item block-graphics-to-ascii	193	=item block-graphics-to-ascii
94		194
95	A not very useful example of filtering all text output to the terminal,	195	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	196	by replacing all line-drawing characters (U+2500 .. U+259F) by a
97	similar-looking ascii character.	197	similar-looking ascii character.
98		198
		199	=item digital-clock
		200
		201	Displays a digital clock using the built-in overlay.
		202
99	=item example-refresh-hooks	203	=item example-refresh-hooks
100		204
101	Displays a very simple digital clock in the upper right corner of the	205	Displays a very simple digital clock in the upper right corner of the
102	window. Illustrates overwriting the refresh callbacks to create your own	206	window. Illustrates overwriting the refresh callbacks to create your own
103	overlays or changes.	207	overlays or changes.
		208
		209	=item selection-pastebin
		210
		211	This is a little rarely useful extension that Uploads the selection as
		212	textfile to a remote site (or does other things). (The implementation is
		213	not currently secure for use in a multiuser environment as it writes to
		214	F</tmp> directly.).
		215
		216	It listens to the C<selection-pastebin:remote-pastebin> keyboard command,
		217	i.e.
		218
		219	URxvt.keysym.C-M-e: perl:selection-pastebin:remote-pastebin
		220
		221	Pressing this combination runs a command with C<%> replaced by the name of
		222	the textfile. This command can be set via a resource:
		223
		224	URxvt.selection-pastebin.cmd: rsync -apP % ruth:/var/www/www.ta-sa.org/files/txt/.
		225
		226	And the default is likely not useful to anybody but the few people around
		227	here :)
		228
		229	The name of the textfile is the hex encoded md5 sum of the selection, so
		230	the same content should lead to the same filename.
		231
		232	After a successful upload the selection will be replaced by the text given
		233	in the C<selection-pastebin-url> resource (again, the % is the placeholder
		234	for the filename):
		235
		236	URxvt.selection-pastebin.url: http://www.ta-sa.org/files/txt/%
104		237
105	=back	238	=back
106		239
107	=head1 API DOCUMENTATION	240	=head1 API DOCUMENTATION
108		241
…		…
181	called whenever the relevant event happens.	314	called whenever the relevant event happens.
182		315
183	The first argument passed to them is an extension oject as described in	316	The first argument passed to them is an extension oject as described in
184	the in the C<Extension Objects> section.	317	the in the C<Extension Objects> section.
185		318
186	B<All> of these hooks must return a boolean value. If it is true, then the	319	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	320	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.	321	relevant action might not be carried out by the C++ code.
189		322
190	I<< When in doubt, return a false value (preferably C<()>). >>	323	I<< When in doubt, return a false value (preferably C<()>). >>
191		324
192	=over 4	325	=over 4
193		326
194	=item on_init $term	327	=item on_init $term
195		328
196	Called after a new terminal object has been initialized, but before	329	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	330	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	331	call or deliver senseless data, as terminal size and other characteristics
199	have not yet been determined. You can safely query and change resources,	332	have not yet been determined. You can safely query and change resources
200	though.	333	and options, though. For many purposes the C<on_start> hook is a better
		334	place.
		335
		336	=item on_start $term
		337
		338	Called at the very end of initialisation of a new terminal, just before
		339	trying to map (display) the toplevel and returning to the mainloop.
		340
		341	=item on_destroy $term
		342
		343	Called whenever something tries to destroy terminal, before doing anything
		344	yet. If this hook returns true, then destruction is skipped, but this is
		345	rarely a good idea.
201		346
202	=item on_reset $term	347	=item on_reset $term
203		348
204	Called after the screen is "reset" for any reason, such as resizing or	349	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	350	control sequences. Here is where you can react on changes to size-related
206	variables.	351	variables.
207		352
208	=item on_start $term	353	=item on_child_start $term, $pid
209		354
210	Called at the very end of initialisation of a new terminal, just before	355	Called just after the child process has been C<fork>ed.
211	returning to the mainloop.	356
		357	=item on_child_exit $term, $status
		358
		359	Called just after the child process has exited. C<$status> is the status
		360	from C<waitpid>.
212		361
213	=item on_sel_make $term, $eventtime	362	=item on_sel_make $term, $eventtime
214		363
215	Called whenever a selection has been made by the user, but before the	364	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	365	selection text is copied, so changes to the beginning, end or type of the
…		…
230	=item on_sel_extend $term	379	=item on_sel_extend $term
231		380
232	Called whenever the user tries to extend the selection (e.g. with a double	381	Called whenever the user tries to extend the selection (e.g. with a double
233	click) and is either supposed to return false (normal operation), or	382	click) and is either supposed to return false (normal operation), or
234	should extend the selection itelf and return true to suppress the built-in	383	should extend the selection itelf and return true to suppress the built-in
235	processing.	384	processing. This can happen multiple times, as long as the callback
		385	returns true, it will be called on every further click by the user and is
		386	supposed to enlarge the selection more and more, if possible.
236		387
237	See the F<selection> example extension.	388	See the F<selection> example extension.
238		389
239	=item on_view_change $term, $offset	390	=item on_view_change $term, $offset
240		391
…		…
307		458
308	Called whenever the user presses a key combination that has a	459	Called whenever the user presses a key combination that has a
309	C<perl:string> action bound to it (see description of the B<keysym>	460	C<perl:string> action bound to it (see description of the B<keysym>
310	resource in the @@RXVT_NAME@@(1) manpage).	461	resource in the @@RXVT_NAME@@(1) manpage).
311		462
		463	=item on_x_event $term, $event
		464
		465	Called on every X event received on the vt window (and possibly other
		466	windows). Should only be used as a last resort. Most event structure
		467	members are not passed.
		468
312	=item on_focus_in $term	469	=item on_focus_in $term
313		470
314	Called whenever the window gets the keyboard focus, before rxvt-unicode	471	Called whenever the window gets the keyboard focus, before rxvt-unicode
315	does focus in processing.	472	does focus in processing.
316		473
317	=item on_focus_out $term	474	=item on_focus_out $term
318		475
319	Called wheneever the window loses keyboard focus, before rxvt-unicode does	476	Called wheneever the window loses keyboard focus, before rxvt-unicode does
320	focus out processing.	477	focus out processing.
321		478
		479	=item on_configure_notify $term, $event
		480
		481	=item on_property_notify $term, $event
		482
322	=item on_key_press $term, $event, $keysym, $octets	483	=item on_key_press $term, $event, $keysym, $octets
323		484
324	=item on_key_release $term, $event, $keysym	485	=item on_key_release $term, $event, $keysym
325		486
326	=item on_button_press $term, $event	487	=item on_button_press $term, $event
…		…
335		496
336	Called whenever the corresponding X event is received for the terminal If	497	Called whenever the corresponding X event is received for the terminal If
337	the hook returns true, then the even will be ignored by rxvt-unicode.	498	the hook returns true, then the even will be ignored by rxvt-unicode.
338		499
339	The event is a hash with most values as named by Xlib (see the XEvent	500	The event is a hash with most values as named by Xlib (see the XEvent
340	manpage), with the additional members C<row> and C<col>, which are the row	501	manpage), with the additional members C<row> and C<col>, which are the
341	and column under the mouse cursor.	502	(real, not screen-based) row and column under the mouse cursor.
342		503
343	C<on_key_press> additionally receives the string rxvt-unicode would	504	C<on_key_press> additionally receives the string rxvt-unicode would
344	output, if any, in locale-specific encoding.	505	output, if any, in locale-specific encoding.
345		506
346	subwindow.	507	subwindow.
		508
		509	=item on_client_message $term, $event
		510
		511	=item on_wm_protocols $term, $event
		512
		513	=item on_wm_delete_window $term, $event
		514
		515	Called when various types of ClientMessage events are received (all with
		516	format=32, WM_PROTOCOLS or WM_PROTOCOLS:WM_DELETE_WINDOW).
347		517
348	=back	518	=back
349		519
350	=cut	520	=cut
351		521
…		…
357	use Scalar::Util ();	527	use Scalar::Util ();
358	use List::Util ();	528	use List::Util ();
359		529
360	our $VERSION = 1;	530	our $VERSION = 1;
361	our $TERM;	531	our $TERM;
		532	our @TERM_INIT;
		533	our @TERM_EXT;
362	our @HOOKNAME;	534	our @HOOKNAME;
363	our %HOOKTYPE = map +($HOOKNAME[$_] => $_), 0..$#HOOKNAME;	535	our %HOOKTYPE = map +($HOOKNAME[$_] => $_), 0..$#HOOKNAME;
364	our %OPTION;	536	our %OPTION;
365		537
366	our $LIBDIR;	538	our $LIBDIR;
…		…
388	=item $urxvt::TERM	560	=item $urxvt::TERM
389		561
390	The current terminal. This variable stores the current C<urxvt::term>	562	The current terminal. This variable stores the current C<urxvt::term>
391	object, whenever a callback/hook is executing.	563	object, whenever a callback/hook is executing.
392		564
		565	=item @urxvt::TERM_INIT
		566
		567	All coderefs in this array will be called as methods of the next newly
		568	created C<urxvt::term> object (during the C<on_init> phase). The array
		569	gets cleared before the codereferences that were in it are being executed,
		570	so coderefs can push themselves onto it again if they so desire.
		571
		572	This complements to the perl-eval commandline option, but gets executed
		573	first.
		574
		575	=item @urxvt::TERM_EXT
		576
		577	Works similar to C<@TERM_INIT>, but contains perl package/class names, which
		578	get registered as normal extensions after calling the hooks in C<@TERM_INIT>
		579	but before other extensions. Gets cleared just like C<@TERM_INIT>.
		580
393	=back	581	=back
394		582
395	=head2 Functions in the C<urxvt> Package	583	=head2 Functions in the C<urxvt> Package
396		584
397	=over 4	585	=over 4
…		…
411	Using this function has the advantage that its output ends up in the	599	Using this function has the advantage that its output ends up in the
412	correct place, e.g. on stderr of the connecting urxvtc client.	600	correct place, e.g. on stderr of the connecting urxvtc client.
413		601
414	Messages have a size limit of 1023 bytes currently.	602	Messages have a size limit of 1023 bytes currently.
415		603
416	=item $is_safe = urxvt::safe
417
418	Returns true when it is safe to do potentially unsafe things, such as
419	evaluating perl code specified by the user. This is true when urxvt was
420	started setuid or setgid.
421
422	=item $time = urxvt::NOW	604	=item $time = urxvt::NOW
423		605
424	Returns the "current time" (as per the event loop).	606	Returns the "current time" (as per the event loop).
425		607
426	=item urxvt::CurrentTime	608	=item urxvt::CurrentTime
427		609
428	=item urxvt::ShiftMask, LockMask, ControlMask, Mod1Mask, Mod2Mask,	610	=item urxvt::ShiftMask, LockMask, ControlMask, Mod1Mask, Mod2Mask,
429	Mod3Mask, Mod4Mask, Mod5Mask, Button1Mask, Button2Mask, Button3Mask,	611	Mod3Mask, Mod4Mask, Mod5Mask, Button1Mask, Button2Mask, Button3Mask,
430	Button4Mask, Button5Mask, AnyModifier	612	Button4Mask, Button5Mask, AnyModifier
		613
		614	=item urxvt::NoEventMask, KeyPressMask, KeyReleaseMask,
		615	ButtonPressMask, ButtonReleaseMask, EnterWindowMask, LeaveWindowMask,
		616	PointerMotionMask, PointerMotionHintMask, Button1MotionMask, Button2MotionMask,
		617	Button3MotionMask, Button4MotionMask, Button5MotionMask, ButtonMotionMask,
		618	KeymapStateMask, ExposureMask, VisibilityChangeMask, StructureNotifyMask,
		619	ResizeRedirectMask, SubstructureNotifyMask, SubstructureRedirectMask,
		620	FocusChangeMask, PropertyChangeMask, ColormapChangeMask, OwnerGrabButtonMask
		621
		622	=item urxvt::KeyPress, KeyRelease, ButtonPress, ButtonRelease, MotionNotify,
		623	EnterNotify, LeaveNotify, FocusIn, FocusOut, KeymapNotify, Expose,
		624	GraphicsExpose, NoExpose, VisibilityNotify, CreateNotify, DestroyNotify,
		625	UnmapNotify, MapNotify, MapRequest, ReparentNotify, ConfigureNotify,
		626	ConfigureRequest, GravityNotify, ResizeRequest, CirculateNotify,
		627	CirculateRequest, PropertyNotify, SelectionClear, SelectionRequest,
		628	SelectionNotify, ColormapNotify, ClientMessage, MappingNotify
431		629
432	Various constants for use in X calls and event processing.	630	Various constants for use in X calls and event processing.
433		631
434	=back	632	=back
435		633
…		…
486	=back	684	=back
487		685
488	=cut	686	=cut
489		687
490	BEGIN {	688	BEGIN {
491	urxvt->bootstrap;
492
493	# overwrite perl's warn	689	# overwrite perl's warn
494	*CORE::GLOBAL::warn = sub {	690	*CORE::GLOBAL::warn = sub {
495	my $msg = join "", @_;	691	my $msg = join "", @_;
496	$msg .= "\n"	692	$msg .= "\n"
497	unless $msg =~ /\n$/;	693	unless $msg =~ /\n$/;
498	urxvt::warn ($msg);	694	urxvt::warn ($msg);
499	};	695	};
500
501	# %ENV is the original startup environment
502	delete $ENV{IFS};
503	delete $ENV{CDPATH};
504	delete $ENV{BASH_ENV};
505	$ENV{PATH} = "/bin:/sbin:/usr/bin:/usr/sbin:/usr/local/bin:/usr/local/sbin:/opt/bin:/opt/sbin";
506	}	696	}
507		697
508	my @hook_count;
509	my $verbosity = $ENV{URXVT_PERL_VERBOSITY};	698	my $verbosity = $ENV{URXVT_PERL_VERBOSITY};
510		699
511	sub verbose {	700	sub verbose {
512	my ($level, $msg) = @_;	701	my ($level, $msg) = @_;
513	warn "$msg\n" if $level <= $verbosity;	702	warn "$msg\n" if $level <= $verbosity;
514	}	703	}
515		704
516	my $extension_pkg = "extension0000";
517	my %extension_pkg;	705	my %extension_pkg;
518		706
519	# load a single script into its own package, once only	707	# load a single script into its own package, once only
520	sub extension_package($) {	708	sub extension_package($) {
521	my ($path) = @_;	709	my ($path) = @_;
522		710
523	$extension_pkg{$path} \|\|= do {	711	$extension_pkg{$path} \|\|= do {
524	my $pkg = "urxvt::" . ($extension_pkg++);	712	$path =~ /([^\/\\]+)$/;
		713	my $pkg = $1;
		714	$pkg =~ s/[^[:word:]]/_/g;
		715	$pkg = "urxvt::ext::$pkg";
525		716
526	verbose 3, "loading extension '$path' into package '$pkg'";	717	verbose 3, "loading extension '$path' into package '$pkg'";
527		718
528	open my $fh, "<:raw", $path	719	open my $fh, "<:raw", $path
529	or die "$path: $!";	720	or die "$path: $!";
530		721
531	my $source = untaint	722	my $source =
532	"package $pkg; use strict; use utf8;\n"	723	"package $pkg; use strict; use utf8;\n"
533	. "use base urxvt::term::extension::;\n"
534	. "#line 1 \"$path\"\n{\n"	724	. "#line 1 \"$path\"\n{\n"
535	. (do { local $/; <$fh> })	725	. (do { local $/; <$fh> })
536	. "\n};\n1";	726	. "\n};\n1";
537		727
538	eval $source	728	eval $source
…		…
552	if ($htype == 0) { # INIT	742	if ($htype == 0) { # INIT
553	my @dirs = ((split /:/, $TERM->resource ("perl_lib")), "$LIBDIR/perl");	743	my @dirs = ((split /:/, $TERM->resource ("perl_lib")), "$LIBDIR/perl");
554		744
555	my %ext_arg;	745	my %ext_arg;
556		746
		747	{
		748	my @init = @TERM_INIT;
		749	@TERM_INIT = ();
		750	$_->($TERM) for @init;
		751	my @pkg = @TERM_EXT;
		752	@TERM_EXT = ();
		753	$TERM->register_package ($_) for @pkg;
		754	}
		755
557	for (map { split /,/, $TERM->resource ("perl_ext_$_") } 1, 2) {	756	for (grep $_, map { split /,/, $TERM->resource ("perl_ext_$_") } 1, 2) {
558	if ($_ eq "default") {	757	if ($_ eq "default") {
559	$ext_arg{$_} \|\|= [] for qw(selection option-popup selection-popup searchable-scrollback);	758	$ext_arg{$_} \|\|= [] for qw(selection option-popup selection-popup searchable-scrollback);
560	} elsif (/^-(.*)$/) {	759	} elsif (/^-(.*)$/) {
561	delete $ext_arg{$1};	760	delete $ext_arg{$1};
562	} elsif (/^([^<]+)<(.*)>$/) {	761	} elsif (/^([^<]+)<(.*)>$/) {
…		…
587	if $verbosity >= 10;	786	if $verbosity >= 10;
588		787
589	keys %$cb;	788	keys %$cb;
590		789
591	while (my ($pkg, $cb) = each %$cb) {	790	while (my ($pkg, $cb) = each %$cb) {
592	$retval = eval { $cb->($TERM->{_pkg}{$pkg}, @_) }	791	my $retval_ = eval { $cb->($TERM->{_pkg}{$pkg}, @_) };
593	and last;	792	$retval \|\|= $retval_;
594		793
595	if ($@) {	794	if ($@) {
596	$TERM->ungrab; # better to lose the grab than the session	795	$TERM->ungrab; # better to lose the grab than the session
597	warn $@;	796	warn $@;
598	}	797	}
599	}	798	}
		799
		800	verbose 11, "$HOOKNAME[$htype] returning <$retval>"
		801	if $verbosity >= 11;
600	}	802	}
601		803
602	if ($htype == 1) { # DESTROY	804	if ($htype == 1) { # DESTROY
603	if (my $hook = delete $TERM->{_hook}) {
604	for my $htype (0..$#$hook) {
605	$hook_count[$htype] -= scalar keys %{ $hook->[$htype] \|\| {} }
606	or set_should_invoke $htype, 0;
607	}
608	}
609
610	# clear package objects	805	# clear package objects
611	%$_ = () for values %{ $TERM->{_pkg} };	806	%$_ = () for values %{ $TERM->{_pkg} };
612		807
613	# clear package	808	# clear package
614	%$TERM = ();	809	%$TERM = ();
615	}	810	}
616		811
617	$retval	812	$retval
618	}
619
620	sub exec_async(@) {
621	my $pid = fork;
622
623	return
624	if !defined $pid or $pid;
625
626	%ENV = %{ $TERM->env };
627
628	exec @_;
629	_exit 255;
630	}	813	}
631		814
632	# urxvt::term::extension	815	# urxvt::term::extension
633		816
634	package urxvt::term::extension;	817	package urxvt::term::extension;
…		…
640	while (my ($name, $cb) = each %hook) {	823	while (my ($name, $cb) = each %hook) {
641	my $htype = $HOOKTYPE{uc $name};	824	my $htype = $HOOKTYPE{uc $name};
642	defined $htype	825	defined $htype
643	or Carp::croak "unsupported hook type '$name'";	826	or Carp::croak "unsupported hook type '$name'";
644		827
		828	$self->set_should_invoke ($htype, +1)
645	unless (exists $self->{term}{_hook}[$htype]{$pkg}) {	829	unless exists $self->{term}{_hook}[$htype]{$pkg};
646	$hook_count[$htype]++
647	or urxvt::set_should_invoke $htype, 1;
648	}
649		830
650	$self->{term}{_hook}[$htype]{$pkg} = $cb;	831	$self->{term}{_hook}[$htype]{$pkg} = $cb;
651	}	832	}
652	}	833	}
653		834
…		…
658	for my $name (@hook) {	839	for my $name (@hook) {
659	my $htype = $HOOKTYPE{uc $name};	840	my $htype = $HOOKTYPE{uc $name};
660	defined $htype	841	defined $htype
661	or Carp::croak "unsupported hook type '$name'";	842	or Carp::croak "unsupported hook type '$name'";
662		843
		844	$self->set_should_invoke ($htype, -1)
663	if (delete $self->{term}{_hook}[$htype]{$pkg}) {	845	if delete $self->{term}{_hook}[$htype]{$pkg};
664	--$hook_count[$htype]
665	or urxvt::set_should_invoke $htype, 0;
666	}
667	}	846	}
668	}	847	}
669		848
670	our $AUTOLOAD;	849	our $AUTOLOAD;
671		850
…		…
777	# find on_xxx subs in the package and register them	956	# find on_xxx subs in the package and register them
778	# as hooks	957	# as hooks
779	sub register_package {	958	sub register_package {
780	my ($self, $pkg, $argv) = @_;	959	my ($self, $pkg, $argv) = @_;
781		960
		961	no strict 'refs';
		962
		963	urxvt::verbose 6, "register package $pkg to $self";
		964
		965	@{"$pkg\::ISA"} = urxvt::term::extension::;
		966
782	my $proxy = bless {	967	my $proxy = bless {
783	_pkg => $pkg,	968	_pkg => $pkg,
784	argv => $argv,	969	argv => $argv,
785	}, $pkg;	970	}, $pkg;
786	Scalar::Util::weaken ($proxy->{term} = $self);	971	Scalar::Util::weaken ($proxy->{term} = $self);
…		…
817		1002
818	Destroy the terminal object (close the window, free resources	1003	Destroy the terminal object (close the window, free resources
819	etc.). Please note that @@RXVT_NAME@@ will not exit as long as any event	1004	etc.). Please note that @@RXVT_NAME@@ will not exit as long as any event
820	watchers (timers, io watchers) are still active.	1005	watchers (timers, io watchers) are still active.
821		1006
		1007	=item $term->exec_async ($cmd[, @args])
		1008
		1009	Works like the combination of the C<fork>/C<exec> builtins, which executes
		1010	("starts") programs in the background. This function takes care of setting
		1011	the user environment before exec'ing the command (e.g. C<PATH>) and should
		1012	be preferred over explicit calls to C<exec> or C<system>.
		1013
		1014	Returns the pid of the subprocess or C<undef> on error.
		1015
		1016	=cut
		1017
		1018	sub exec_async {
		1019	my $self = shift;
		1020
		1021	my $pid = fork;
		1022
		1023	return $pid
		1024	if !defined $pid or $pid;
		1025
		1026	%ENV = %{ $self->env };
		1027
		1028	exec @_;
		1029	urxvt::_exit 255;
		1030	}
		1031
822	=item $isset = $term->option ($optval[, $set])	1032	=item $isset = $term->option ($optval[, $set])
823		1033
824	Returns true if the option specified by C<$optval> is enabled, and	1034	Returns true if the option specified by C<$optval> is enabled, and
825	optionally change it. All option values are stored by name in the hash	1035	optionally change it. All option values are stored by name in the hash
826	C<%urxvt::OPTION>. Options not enabled in this binary are not in the hash.	1036	C<%urxvt::OPTION>. Options not enabled in this binary are not in the hash.
…		…
828	Here is a a likely non-exhaustive list of option names, please see the	1038	Here is a a likely non-exhaustive list of option names, please see the
829	source file F</src/optinc.h> to see the actual list:	1039	source file F</src/optinc.h> to see the actual list:
830		1040
831	borderLess console cursorBlink cursorUnderline hold iconic insecure	1041	borderLess console cursorBlink cursorUnderline hold iconic insecure
832	intensityStyles jumpScroll loginShell mapAlert meta8 mouseWheelScrollPage	1042	intensityStyles jumpScroll loginShell mapAlert meta8 mouseWheelScrollPage
833	pastableTabs pointerBlank reverseVideo scrollBar scrollBar_floating	1043	override-redirect pastableTabs pointerBlank reverseVideo scrollBar
834	scrollBar_right scrollTtyKeypress scrollTtyOutput scrollWithBuffer	1044	scrollBar_floating scrollBar_right scrollTtyKeypress scrollTtyOutput
835	secondaryScreen secondaryScroll skipBuiltinGlyphs transparent	1045	scrollWithBuffer secondaryScreen secondaryScroll skipBuiltinGlyphs
836	tripleclickwords utmpInhibit visualBell	1046	transparent tripleclickwords utmpInhibit visualBell
837		1047
838	=item $value = $term->resource ($name[, $newval])	1048	=item $value = $term->resource ($name[, $newval])
839		1049
840	Returns the current resource value associated with a given name and	1050	Returns the current resource value associated with a given name and
841	optionally sets a new value. Setting values is most useful in the C<init>	1051	optionally sets a new value. Setting values is most useful in the C<init>
…		…
858		1068
859	answerbackstring backgroundPixmap backspace_key boldFont boldItalicFont	1069	answerbackstring backgroundPixmap backspace_key boldFont boldItalicFont
860	borderLess color cursorBlink cursorUnderline cutchars delete_key	1070	borderLess color cursorBlink cursorUnderline cutchars delete_key
861	display_name embed ext_bwidth fade font geometry hold iconName	1071	display_name embed ext_bwidth fade font geometry hold iconName
862	imFont imLocale inputMethod insecure int_bwidth intensityStyles	1072	imFont imLocale inputMethod insecure int_bwidth intensityStyles
863	italicFont jumpScroll lineSpace loginShell mapAlert menu meta8 modifier	1073	italicFont jumpScroll lineSpace loginShell mapAlert meta8 modifier
864	mouseWheelScrollPage name pastableTabs path perl_eval perl_ext_1 perl_ext_2	1074	mouseWheelScrollPage name override_redirect pastableTabs path perl_eval
865	perl_lib pointerBlank pointerBlankDelay preeditType print_pipe pty_fd	1075	perl_ext_1 perl_ext_2 perl_lib pointerBlank pointerBlankDelay
866	reverseVideo saveLines scrollBar scrollBar_align scrollBar_floating	1076	preeditType print_pipe pty_fd reverseVideo saveLines scrollBar
867	scrollBar_right scrollBar_thickness scrollTtyKeypress scrollTtyOutput	1077	scrollBar_align scrollBar_floating scrollBar_right scrollBar_thickness
868	scrollWithBuffer scrollstyle secondaryScreen secondaryScroll selectstyle	1078	scrollTtyKeypress scrollTtyOutput scrollWithBuffer scrollstyle
869	shade term_name title transparent transparent_all tripleclickwords	1079	secondaryScreen secondaryScroll selectstyle shade term_name title
870	utmpInhibit visualBell	1080	transient_for transparent transparent_all tripleclickwords utmpInhibit
		1081	visualBell
871		1082
872	=cut	1083	=cut
873		1084
874	sub resource($$;$) {	1085	sub resource($$;$) {
875	my ($self, $name) = (shift, shift);	1086	my ($self, $name) = (shift, shift);
…		…
910	=item ($row, $col) = $term->selection_end ([$row, $col])	1121	=item ($row, $col) = $term->selection_end ([$row, $col])
911		1122
912	Return the current values of the selection mark, begin or end positions,	1123	Return the current values of the selection mark, begin or end positions,
913	and optionally set them to new values.	1124	and optionally set them to new values.
914		1125
		1126	=item $term->selection_make ($eventtime[, $rectangular])
		1127
		1128	Tries to make a selection as set by C<selection_beg> and
		1129	C<selection_end>. If C<$rectangular> is true (default: false), a
		1130	rectangular selection will be made. This is the prefered function to make
		1131	a selection.
		1132
915	=item $success = $term->selection_grab ($eventtime)	1133	=item $success = $term->selection_grab ($eventtime)
916		1134
917	Try to request the primary selection from the server (for example, as set	1135	Try to request the primary selection text from the server (for example, as
918	by the next method).	1136	set by the next method). No visual feedback will be given. This function
		1137	is mostly useful from within C<on_sel_grab> hooks.
919		1138
920	=item $oldtext = $term->selection ([$newtext])	1139	=item $oldtext = $term->selection ([$newtext])
921		1140
922	Return the current selection text and optionally replace it by C<$newtext>.	1141	Return the current selection text and optionally replace it by C<$newtext>.
923		1142
…		…
1016	Convert the given locale-encoded octets into a perl string.	1235	Convert the given locale-encoded octets into a perl string.
1017		1236
1018	=item $term->scr_xor_span ($beg_row, $beg_col, $end_row, $end_col[, $rstyle])	1237	=item $term->scr_xor_span ($beg_row, $beg_col, $end_row, $end_col[, $rstyle])
1019		1238
1020	XORs the rendition values in the given span with the provided value	1239	XORs the rendition values in the given span with the provided value
1021	(default: C<RS_RVid>). Useful in refresh hooks to provide effects similar	1240	(default: C<RS_RVid>), which I<MUST NOT> contain font styles. Useful in
1022	to the selection.	1241	refresh hooks to provide effects similar to the selection.
1023		1242
1024	=item $term->scr_xor_rect ($beg_row, $beg_col, $end_row, $end_col[, $rstyle1[, $rstyle2]])	1243	=item $term->scr_xor_rect ($beg_row, $beg_col, $end_row, $end_col[, $rstyle1[, $rstyle2]])
1025		1244
1026	Similar to C<scr_xor_span>, but xors a rectangle instead. Trailing	1245	Similar to C<scr_xor_span>, but xors a rectangle instead. Trailing
1027	whitespace will additionally be xored with the C<$rstyle2>, which defaults	1246	whitespace will additionally be xored with the C<$rstyle2>, which defaults
1028	to C<RS_RVid \| RS_Uline>, which removes reverse video again and underlines	1247	to C<RS_RVid \| RS_Uline>, which removes reverse video again and underlines
1029	it instead.	1248	it instead. Both styles I<MUST NOT> contain font styles.
1030		1249
1031	=item $term->scr_bell	1250	=item $term->scr_bell
1032		1251
1033	Ring the bell!	1252	Ring the bell!
1034		1253
…		…
1068		1287
1069	=item $windowid = $term->vt	1288	=item $windowid = $term->vt
1070		1289
1071	Return the window id of the terminal window.	1290	Return the window id of the terminal window.
1072		1291
		1292	=item $term->vt_emask_add ($x_event_mask)
		1293
		1294	Adds the specified events to the vt event mask. Useful e.g. when you want
		1295	to receive pointer events all the times:
		1296
		1297	$term->vt_emask_add (urxvt::PointerMotionMask);
		1298
1073	=item $window_width = $term->width	1299	=item $window_width = $term->width
1074		1300
1075	=item $window_height = $term->height	1301	=item $window_height = $term->height
1076		1302
1077	=item $font_width = $term->fwidth	1303	=item $font_width = $term->fwidth
…		…
1090		1316
1091	=item $max_scrollback = $term->saveLines	1317	=item $max_scrollback = $term->saveLines
1092		1318
1093	=item $nrow_plus_saveLines = $term->total_rows	1319	=item $nrow_plus_saveLines = $term->total_rows
1094		1320
1095	=item $lines_in_scrollback = $term->nsaved	1321	=item $topmost_scrollback_row = $term->top_row
1096		1322
1097	Return various integers describing terminal characteristics.	1323	Return various integers describing terminal characteristics.
1098		1324
1099	=item $x_display = $term->display_id	1325	=item $x_display = $term->display_id
1100		1326
…		…
1128	Return the modifier masks corresponding to the "ISO Level 3 Shift" (often	1354	Return the modifier masks corresponding to the "ISO Level 3 Shift" (often
1129	AltGr), the meta key (often Alt) and the num lock key, if applicable.	1355	AltGr), the meta key (often Alt) and the num lock key, if applicable.
1130		1356
1131	=item $view_start = $term->view_start ([$newvalue])	1357	=item $view_start = $term->view_start ([$newvalue])
1132		1358
1133	Returns the negative row number of the topmost line. Minimum value is	1359	Returns the row number of the topmost displayed line. Maximum value is
1134	C<0>, which displays the normal terminal contents. Larger values scroll	1360	C<0>, which displays the normal terminal contents. Lower values scroll
1135	this many lines into the scrollback buffer.	1361	this many lines into the scrollback buffer.
1136		1362
1137	=item $term->want_refresh	1363	=item $term->want_refresh
1138		1364
1139	Requests a screen refresh. At the next opportunity, rxvt-unicode will	1365	Requests a screen refresh. At the next opportunity, rxvt-unicode will
…		…
1218	Return the row number of the first/last row of the line, respectively.	1444	Return the row number of the first/last row of the line, respectively.
1219		1445
1220	=item $offset = $line->offset_of ($row, $col)	1446	=item $offset = $line->offset_of ($row, $col)
1221		1447
1222	Returns the character offset of the given row\|col pair within the logical	1448	Returns the character offset of the given row\|col pair within the logical
1223	line.	1449	line. Works for rows outside the line, too, and returns corresponding
		1450	offsets outside the string.
1224		1451
1225	=item ($row, $col) = $line->coord_of ($offset)	1452	=item ($row, $col) = $line->coord_of ($offset)
1226		1453
1227	Translates a string offset into terminal coordinates again.	1454	Translates a string offset into terminal coordinates again.
1228		1455
…		…
1341		1568
1342	Calls XUngrab for the most recent grab. Is called automatically on	1569	Calls XUngrab for the most recent grab. Is called automatically on
1343	evaluation errors, as it is better to lose the grab in the error case as	1570	evaluation errors, as it is better to lose the grab in the error case as
1344	the session.	1571	the session.
1345		1572
		1573	=item $atom = $term->XInternAtom ($atom_name[, $only_if_exists])
		1574
		1575	=item $atom_name = $term->XGetAtomName ($atom)
		1576
		1577	=item @atoms = $term->XListProperties ($window)
		1578
		1579	=item ($type,$format,$octets) = $term->XGetWindowProperty ($window, $property)
		1580
		1581	=item $term->XChangeWindowProperty ($window, $property, $type, $format, $octets)
		1582
		1583	=item $term->XDeleteProperty ($window, $property)
		1584
		1585	=item $window = $term->DefaultRootWindow
		1586
		1587	=item $term->XReparentWindow ($window, $parent, [$x, $y])
		1588
		1589	=item $term->XMapWindow ($window)
		1590
		1591	=item $term->XUnmapWindow ($window)
		1592
		1593	=item $term->XMoveResizeWindow ($window, $x, $y, $width, $height)
		1594
		1595	=item ($x, $y, $child_window) = $term->XTranslateCoordinates ($src, $dst, $x, $y)
		1596
		1597	=item $term->XChangeInput ($window, $add_events[, $del_events])
		1598
		1599	Various X or X-related functions. The C<$term> object only serves as
		1600	the source of the display, otherwise those functions map more-or-less
		1601	directory onto the X functions of the same name.
		1602
1346	=back	1603	=back
1347		1604
1348	=cut	1605	=cut
1349		1606
1350	package urxvt::popup;	1607	package urxvt::popup;
…		…
1451	my $env = $self->{term}->env;	1708	my $env = $self->{term}->env;
1452	# we can't hope to reproduce the locale algorithm, so nuke LC_ALL and set LC_CTYPE.	1709	# we can't hope to reproduce the locale algorithm, so nuke LC_ALL and set LC_CTYPE.
1453	delete $env->{LC_ALL};	1710	delete $env->{LC_ALL};
1454	$env->{LC_CTYPE} = $self->{term}->locale;	1711	$env->{LC_CTYPE} = $self->{term}->locale;
1455		1712
1456	urxvt::term->new ($env, $self->{term}->resource ("name"),	1713	urxvt::term->new ($env, "popup",
1457	"--perl-lib" => "", "--perl-ext-common" => "", "-pty-fd" => -1, "-sl" => 0, "-b" => 0,	1714	"--perl-lib" => "", "--perl-ext-common" => "",
		1715	"-pty-fd" => -1, "-sl" => 0,
		1716	"-b" => 1, "-bd" => "grey80", "-bl", "-override-redirect",
1458	"--transient-for" => $self->{term}->parent,	1717	"--transient-for" => $self->{term}->parent,
1459	"-display" => $self->{term}->display_id,	1718	"-display" => $self->{term}->display_id,
1460	"-pe" => "urxvt-popup")	1719	"-pe" => "urxvt-popup")
1461	or die "unable to create popup window\n";	1720	or die "unable to create popup window\n";
1462	}	1721	}
…		…
1467	delete $self->{term}{_destroy}{$self};	1726	delete $self->{term}{_destroy}{$self};
1468	$self->{term}->ungrab;	1727	$self->{term}->ungrab;
1469	}	1728	}
1470		1729
1471	=back	1730	=back
		1731
		1732	=cut
		1733
		1734	package urxvt::watcher;
		1735
		1736	@urxvt::timer::ISA = __PACKAGE__;
		1737	@urxvt::iow::ISA = __PACKAGE__;
		1738	@urxvt::pw::ISA = __PACKAGE__;
		1739	@urxvt::iw::ISA = __PACKAGE__;
1472		1740
1473	=head2 The C<urxvt::timer> Class	1741	=head2 The C<urxvt::timer> Class
1474		1742
1475	This class implements timer watchers/events. Time is represented as a	1743	This class implements timer watchers/events. Time is represented as a
1476	fractional number of seconds since the epoch. Example:	1744	fractional number of seconds since the epoch. Example:
…		…
1514	Start the timer.	1782	Start the timer.
1515		1783
1516	=item $timer = $timer->start ($tstamp)	1784	=item $timer = $timer->start ($tstamp)
1517		1785
1518	Set the event trigger time to C<$tstamp> and start the timer.	1786	Set the event trigger time to C<$tstamp> and start the timer.
		1787
		1788	=item $timer = $timer->after ($delay)
		1789
		1790	Like C<start>, but sets the expiry timer to c<urxvt::NOW + $delay>.
1519		1791
1520	=item $timer = $timer->stop	1792	=item $timer = $timer->stop
1521		1793
1522	Stop the timer.	1794	Stop the timer.
1523		1795
…		…
1570		1842
1571	Stop watching for events on the given filehandle.	1843	Stop watching for events on the given filehandle.
1572		1844
1573	=back	1845	=back
1574		1846
		1847	=head2 The C<urxvt::iw> Class
		1848
		1849	This class implements idle watchers, that get called automatically when
		1850	the process is idle. They should return as fast as possible, after doing
		1851	some useful work.
		1852
		1853	=over 4
		1854
		1855	=item $iw = new urxvt::iw
		1856
		1857	Create a new idle watcher object in stopped state.
		1858
		1859	=item $iw = $iw->cb (sub { my ($iw) = @_; ... })
		1860
		1861	Set the callback to be called when the watcher triggers.
		1862
		1863	=item $timer = $timer->start
		1864
		1865	Start the watcher.
		1866
		1867	=item $timer = $timer->stop
		1868
		1869	Stop the watcher.
		1870
		1871	=back
		1872
		1873	=head2 The C<urxvt::pw> Class
		1874
		1875	This class implements process watchers. They create an event whenever a
		1876	process exits, after which they stop automatically.
		1877
		1878	my $pid = fork;
		1879	...
		1880	$term->{pw} = urxvt::pw
		1881	->new
		1882	->start ($pid)
		1883	->cb (sub {
		1884	my ($pw, $exit_status) = @_;
		1885	...
		1886	});
		1887
		1888	=over 4
		1889
		1890	=item $pw = new urxvt::pw
		1891
		1892	Create a new process watcher in stopped state.
		1893
		1894	=item $pw = $pw->cb (sub { my ($pw, $exit_status) = @_; ... })
		1895
		1896	Set the callback to be called when the timer triggers.
		1897
		1898	=item $pw = $timer->start ($pid)
		1899
		1900	Tells the wqtcher to start watching for process C<$pid>.
		1901
		1902	=item $pw = $pw->stop
		1903
		1904	Stop the watcher.
		1905
		1906	=back
		1907
1575	=head1 ENVIRONMENT	1908	=head1 ENVIRONMENT
1576		1909
1577	=head2 URXVT_PERL_VERBOSITY	1910	=head2 URXVT_PERL_VERBOSITY
1578		1911
1579	This variable controls the verbosity level of the perl extension. Higher	1912	This variable controls the verbosity level of the perl extension. Higher
…		…
1583		1916
1584	=item == 0 - fatal messages	1917	=item == 0 - fatal messages
1585		1918
1586	=item >= 3 - script loading and management	1919	=item >= 3 - script loading and management
1587		1920
1588	=item >=10 - all events received	1921	=item >=10 - all called hooks
		1922
		1923	=item >=11 - hook reutrn values
1589		1924
1590	=back	1925	=back
1591		1926
1592	=head1 AUTHOR	1927	=head1 AUTHOR
1593		1928

Diff Legend

-–
+Removed lines
-+
+Added lines
-<
+Changed lines
->
+Changed lines

Comparing rxvt-unicode/src/urxvt.pm (file contents): Revision 1.84 by root, Thu Jan 12 02:20:56 2006 UTC vs. Revision 1.120 by root, Fri Jan 20 22:05:41 2006 UTC

Diff Legend

Comparing rxvt-unicode/src/urxvt.pm (file contents):
Revision 1.84 by root, Thu Jan 12 02:20:56 2006 UTC vs.
Revision 1.120 by root, Fri Jan 20 22:05:41 2006 UTC