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

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

Diff Legend

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

Comparing rxvt-unicode/src/urxvt.pm (file contents): Revision 1.89 by root, Thu Jan 12 12:10:06 2006 UTC vs. Revision 1.123 by root, Sat Jan 21 14:49:18 2006 UTC

Diff Legend

Comparing rxvt-unicode/src/urxvt.pm (file contents):
Revision 1.89 by root, Thu Jan 12 12:10:06 2006 UTC vs.
Revision 1.123 by root, Sat Jan 21 14:49:18 2006 UTC