[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.114 by root, Fri Jan 20 12:16:28 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	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
53	It also offers the following bindable keyboard command:	75	This extension also offers following bindable keyboard commands:
54		76
55	=over 4	77	=over 4
56		78
57	=item rot13	79	=item rot13
58		80
…		…
70	=item selection-popup (enabled by default)	92	=item selection-popup (enabled by default)
71		93
72	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
73	text into various other formats/action (such as uri unescaping, perl	95	text into various other formats/action (such as uri unescaping, perl
74	evalution, web-browser starting etc.), depending on content.	96	evalution, 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	};
75		116
76	=item searchable-scrollback<hotkey> (enabled by default)	117	=item searchable-scrollback<hotkey> (enabled by default)
77		118
78	Adds regex search functionality to the scrollback buffer, triggered	119	Adds regex search functionality to the scrollback buffer, triggered
79	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
…		…
86	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
87	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
88	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
89	selection.	130	selection.
90		131
91	=item digital-clock	132	=item selection-autotransform
92		133
93	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.
94		166
95	=item mark-urls	167	=item mark-urls
96		168
97	Uses per-line display filtering (C<on_line_update>) to underline urls and	169	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	170	make them clickable. When middle-clicked, the program specified in the
99	resource C<urlLauncher> (default C<x-www-browser>) will be started with	171	resource C<urlLauncher> (default C<x-www-browser>) will be started with
100	the URL as first argument.	172	the URL as first argument.
101		173
		174	=item automove-background
		175
		176	This is basically a one-line extension that dynamically changes the background pixmap offset
		177	to the window position, in effect creating the same effect as pseudo transparency with
		178	a custom pixmap. No scaling is supported in this mode. Exmaple:
		179
		180	@@RXVT_NAME@@ -pixmap background.xpm -pe automove-background
		181
102	=item block-graphics-to-ascii	182	=item block-graphics-to-ascii
103		183
104	A not very useful example of filtering all text output to the terminal,	184	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	185	by replacing all line-drawing characters (U+2500 .. U+259F) by a
106	similar-looking ascii character.	186	similar-looking ascii character.
107		187
		188	=item digital-clock
		189
		190	Displays a digital clock using the built-in overlay.
		191
108	=item example-refresh-hooks	192	=item example-refresh-hooks
109		193
110	Displays a very simple digital clock in the upper right corner of the	194	Displays a very simple digital clock in the upper right corner of the
111	window. Illustrates overwriting the refresh callbacks to create your own	195	window. Illustrates overwriting the refresh callbacks to create your own
112	overlays or changes.	196	overlays or changes.
		197
		198	=item selection-pastebin
		199
		200	This is a little rarely useful extension that Uploads the selection as
		201	textfile to a remote site (or does other things). (The implementation is
		202	not currently secure for use in a multiuser environment as it writes to
		203	F</tmp> directly.).
		204
		205	It listens to the C<selection-pastebin:remote-pastebin> keyboard command,
		206	i.e.
		207
		208	URxvt.keysym.C-M-e: perl:selection-pastebin:remote-pastebin
		209
		210	Pressing this combination runs a command with C<%> replaced by the name of
		211	the textfile. This command can be set via a resource:
		212
		213	URxvt.selection-pastebin.cmd: rsync -apP % ruth:/var/www/www.ta-sa.org/files/txt/.
		214
		215	And the default is likely not useful to anybody but the few people around
		216	here :)
		217
		218	The name of the textfile is the hex encoded md5 sum of the selection, so
		219	the same content should lead to the same filename.
		220
		221	After a successful upload the selection will be replaced by the text given
		222	in the C<selection-pastebin-url> resource (again, the % is the placeholder
		223	for the filename):
		224
		225	URxvt.selection-pastebin.url: http://www.ta-sa.org/files/txt/%
113		226
114	=back	227	=back
115		228
116	=head1 API DOCUMENTATION	229	=head1 API DOCUMENTATION
117		230
…		…
190	called whenever the relevant event happens.	303	called whenever the relevant event happens.
191		304
192	The first argument passed to them is an extension oject as described in	305	The first argument passed to them is an extension oject as described in
193	the in the C<Extension Objects> section.	306	the in the C<Extension Objects> section.
194		307
195	B<All> of these hooks must return a boolean value. If it is true, then the	308	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	309	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.	310	relevant action might not be carried out by the C++ code.
198		311
199	I<< When in doubt, return a false value (preferably C<()>). >>	312	I<< When in doubt, return a false value (preferably C<()>). >>
200		313
201	=over 4	314	=over 4
202		315
203	=item on_init $term	316	=item on_init $term
204		317
205	Called after a new terminal object has been initialized, but before	318	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	319	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	320	call or deliver senseless data, as terminal size and other characteristics
208	have not yet been determined. You can safely query and change resources,	321	have not yet been determined. You can safely query and change resources
209	though.	322	and options, though. For many purposes the C<on_start> hook is a better
		323	place.
		324
		325	=item on_start $term
		326
		327	Called at the very end of initialisation of a new terminal, just before
		328	trying to map (display) the toplevel and returning to the mainloop.
		329
		330	=item on_destroy $term
		331
		332	Called whenever something tries to destroy terminal, before doing anything
		333	yet. If this hook returns true, then destruction is skipped, but this is
		334	rarely a good idea.
210		335
211	=item on_reset $term	336	=item on_reset $term
212		337
213	Called after the screen is "reset" for any reason, such as resizing or	338	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	339	control sequences. Here is where you can react on changes to size-related
215	variables.	340	variables.
216		341
217	=item on_start $term	342	=item on_child_start $term, $pid
218		343
219	Called at the very end of initialisation of a new terminal, just before	344	Called just after the child process has been C<fork>ed.
220	returning to the mainloop.	345
		346	=item on_child_exit $term, $status
		347
		348	Called just after the child process has exited. C<$status> is the status
		349	from C<waitpid>.
221		350
222	=item on_sel_make $term, $eventtime	351	=item on_sel_make $term, $eventtime
223		352
224	Called whenever a selection has been made by the user, but before the	353	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	354	selection text is copied, so changes to the beginning, end or type of the
…		…
318		447
319	Called whenever the user presses a key combination that has a	448	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>	449	C<perl:string> action bound to it (see description of the B<keysym>
321	resource in the @@RXVT_NAME@@(1) manpage).	450	resource in the @@RXVT_NAME@@(1) manpage).
322		451
		452	=item on_x_event $term, $event
		453
		454	Called on every X event received on the vt window (and possibly other
		455	windows). Should only be used as a last resort. Most event structure
		456	members are not passed.
		457
323	=item on_focus_in $term	458	=item on_focus_in $term
324		459
325	Called whenever the window gets the keyboard focus, before rxvt-unicode	460	Called whenever the window gets the keyboard focus, before rxvt-unicode
326	does focus in processing.	461	does focus in processing.
327		462
328	=item on_focus_out $term	463	=item on_focus_out $term
329		464
330	Called wheneever the window loses keyboard focus, before rxvt-unicode does	465	Called wheneever the window loses keyboard focus, before rxvt-unicode does
331	focus out processing.	466	focus out processing.
		467
		468	=item on_configure_notify $term, $event
332		469
333	=item on_key_press $term, $event, $keysym, $octets	470	=item on_key_press $term, $event, $keysym, $octets
334		471
335	=item on_key_release $term, $event, $keysym	472	=item on_key_release $term, $event, $keysym
336		473
…		…
353		490
354	C<on_key_press> additionally receives the string rxvt-unicode would	491	C<on_key_press> additionally receives the string rxvt-unicode would
355	output, if any, in locale-specific encoding.	492	output, if any, in locale-specific encoding.
356		493
357	subwindow.	494	subwindow.
		495
		496	=item on_client_message $term, $event
		497
		498	=item on_wm_protocols $term, $event
		499
		500	=item on_wm_delete_window $term, $event
		501
		502	Called when various types of ClientMessage events are received (all with
		503	format=32, WM_PROTOCOLS or WM_PROTOCOLS:WM_DELETE_WINDOW).
358		504
359	=back	505	=back
360		506
361	=cut	507	=cut
362		508
…		…
368	use Scalar::Util ();	514	use Scalar::Util ();
369	use List::Util ();	515	use List::Util ();
370		516
371	our $VERSION = 1;	517	our $VERSION = 1;
372	our $TERM;	518	our $TERM;
		519	our @TERM_INIT;
		520	our @TERM_EXT;
373	our @HOOKNAME;	521	our @HOOKNAME;
374	our %HOOKTYPE = map +($HOOKNAME[$_] => $_), 0..$#HOOKNAME;	522	our %HOOKTYPE = map +($HOOKNAME[$_] => $_), 0..$#HOOKNAME;
375	our %OPTION;	523	our %OPTION;
376		524
377	our $LIBDIR;	525	our $LIBDIR;
…		…
399	=item $urxvt::TERM	547	=item $urxvt::TERM
400		548
401	The current terminal. This variable stores the current C<urxvt::term>	549	The current terminal. This variable stores the current C<urxvt::term>
402	object, whenever a callback/hook is executing.	550	object, whenever a callback/hook is executing.
403		551
		552	=item @urxvt::TERM_INIT
		553
		554	All coderefs in this array will be called as methods of the next newly
		555	created C<urxvt::term> object (during the C<on_init> phase). The array
		556	gets cleared before the codereferences that were in it are being executed,
		557	so coderefs can push themselves onto it again if they so desire.
		558
		559	This complements to the perl-eval commandline option, but gets executed
		560	first.
		561
		562	=item @urxvt::TERM_EXT
		563
		564	Works similar to C<@TERM_INIT>, but contains perl package/class names, which
		565	get registered as normal extensions after calling the hooks in C<@TERM_INIT>
		566	but before other extensions. Gets cleared just like C<@TERM_INIT>.
		567
404	=back	568	=back
405		569
406	=head2 Functions in the C<urxvt> Package	570	=head2 Functions in the C<urxvt> Package
407		571
408	=over 4	572	=over 4
…		…
422	Using this function has the advantage that its output ends up in the	586	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.	587	correct place, e.g. on stderr of the connecting urxvtc client.
424		588
425	Messages have a size limit of 1023 bytes currently.	589	Messages have a size limit of 1023 bytes currently.
426		590
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	591	=item $time = urxvt::NOW
434		592
435	Returns the "current time" (as per the event loop).	593	Returns the "current time" (as per the event loop).
436		594
437	=item urxvt::CurrentTime	595	=item urxvt::CurrentTime
438		596
439	=item urxvt::ShiftMask, LockMask, ControlMask, Mod1Mask, Mod2Mask,	597	=item urxvt::ShiftMask, LockMask, ControlMask, Mod1Mask, Mod2Mask,
440	Mod3Mask, Mod4Mask, Mod5Mask, Button1Mask, Button2Mask, Button3Mask,	598	Mod3Mask, Mod4Mask, Mod5Mask, Button1Mask, Button2Mask, Button3Mask,
441	Button4Mask, Button5Mask, AnyModifier	599	Button4Mask, Button5Mask, AnyModifier
		600
		601	=item urxvt::NoEventMask, KeyPressMask, KeyReleaseMask,
		602	ButtonPressMask, ButtonReleaseMask, EnterWindowMask, LeaveWindowMask,
		603	PointerMotionMask, PointerMotionHintMask, Button1MotionMask, Button2MotionMask,
		604	Button3MotionMask, Button4MotionMask, Button5MotionMask, ButtonMotionMask,
		605	KeymapStateMask, ExposureMask, VisibilityChangeMask, StructureNotifyMask,
		606	ResizeRedirectMask, SubstructureNotifyMask, SubstructureRedirectMask,
		607	FocusChangeMask, PropertyChangeMask, ColormapChangeMask, OwnerGrabButtonMask
		608
		609	=item urxvt::KeyPress, KeyRelease, ButtonPress, ButtonRelease, MotionNotify,
		610	EnterNotify, LeaveNotify, FocusIn, FocusOut, KeymapNotify, Expose,
		611	GraphicsExpose, NoExpose, VisibilityNotify, CreateNotify, DestroyNotify,
		612	UnmapNotify, MapNotify, MapRequest, ReparentNotify, ConfigureNotify,
		613	ConfigureRequest, GravityNotify, ResizeRequest, CirculateNotify,
		614	CirculateRequest, PropertyNotify, SelectionClear, SelectionRequest,
		615	SelectionNotify, ColormapNotify, ClientMessage, MappingNotify
442		616
443	Various constants for use in X calls and event processing.	617	Various constants for use in X calls and event processing.
444		618
445	=back	619	=back
446		620
…		…
497	=back	671	=back
498		672
499	=cut	673	=cut
500		674
501	BEGIN {	675	BEGIN {
502	urxvt->bootstrap;
503
504	# overwrite perl's warn	676	# overwrite perl's warn
505	*CORE::GLOBAL::warn = sub {	677	*CORE::GLOBAL::warn = sub {
506	my $msg = join "", @_;	678	my $msg = join "", @_;
507	$msg .= "\n"	679	$msg .= "\n"
508	unless $msg =~ /\n$/;	680	unless $msg =~ /\n$/;
509	urxvt::warn ($msg);	681	urxvt::warn ($msg);
510	};	682	};
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	}	683	}
518		684
519	my @hook_count;
520	my $verbosity = $ENV{URXVT_PERL_VERBOSITY};	685	my $verbosity = $ENV{URXVT_PERL_VERBOSITY};
521		686
522	sub verbose {	687	sub verbose {
523	my ($level, $msg) = @_;	688	my ($level, $msg) = @_;
524	warn "$msg\n" if $level <= $verbosity;	689	warn "$msg\n" if $level <= $verbosity;
525	}	690	}
526		691
527	my $extension_pkg = "extension0000";
528	my %extension_pkg;	692	my %extension_pkg;
529		693
530	# load a single script into its own package, once only	694	# load a single script into its own package, once only
531	sub extension_package($) {	695	sub extension_package($) {
532	my ($path) = @_;	696	my ($path) = @_;
533		697
534	$extension_pkg{$path} \|\|= do {	698	$extension_pkg{$path} \|\|= do {
535	my $pkg = "urxvt::" . ($extension_pkg++);	699	$path =~ /([^\/\\]+)$/;
		700	my $pkg = $1;
		701	$pkg =~ s/[^[:word:]]/_/g;
		702	$pkg = "urxvt::ext::$pkg";
536		703
537	verbose 3, "loading extension '$path' into package '$pkg'";	704	verbose 3, "loading extension '$path' into package '$pkg'";
538		705
539	open my $fh, "<:raw", $path	706	open my $fh, "<:raw", $path
540	or die "$path: $!";	707	or die "$path: $!";
541		708
542	my $source = untaint	709	my $source =
543	"package $pkg; use strict; use utf8;\n"	710	"package $pkg; use strict; use utf8;\n"
544	. "use base urxvt::term::extension::;\n"
545	. "#line 1 \"$path\"\n{\n"	711	. "#line 1 \"$path\"\n{\n"
546	. (do { local $/; <$fh> })	712	. (do { local $/; <$fh> })
547	. "\n};\n1";	713	. "\n};\n1";
548		714
549	eval $source	715	eval $source
…		…
563	if ($htype == 0) { # INIT	729	if ($htype == 0) { # INIT
564	my @dirs = ((split /:/, $TERM->resource ("perl_lib")), "$LIBDIR/perl");	730	my @dirs = ((split /:/, $TERM->resource ("perl_lib")), "$LIBDIR/perl");
565		731
566	my %ext_arg;	732	my %ext_arg;
567		733
		734	{
		735	my @init = @TERM_INIT;
		736	@TERM_INIT = ();
		737	$_->($TERM) for @init;
		738	my @pkg = @TERM_EXT;
		739	@TERM_EXT = ();
		740	$TERM->register_package ($_) for @pkg;
		741	}
		742
568	for (map { split /,/, $TERM->resource ("perl_ext_$_") } 1, 2) {	743	for (grep $_, map { split /,/, $TERM->resource ("perl_ext_$_") } 1, 2) {
569	if ($_ eq "default") {	744	if ($_ eq "default") {
570	$ext_arg{$_} \|\|= [] for qw(selection option-popup selection-popup searchable-scrollback);	745	$ext_arg{$_} \|\|= [] for qw(selection option-popup selection-popup searchable-scrollback);
571	} elsif (/^-(.*)$/) {	746	} elsif (/^-(.*)$/) {
572	delete $ext_arg{$1};	747	delete $ext_arg{$1};
573	} elsif (/^([^<]+)<(.*)>$/) {	748	} elsif (/^([^<]+)<(.*)>$/) {
…		…
598	if $verbosity >= 10;	773	if $verbosity >= 10;
599		774
600	keys %$cb;	775	keys %$cb;
601		776
602	while (my ($pkg, $cb) = each %$cb) {	777	while (my ($pkg, $cb) = each %$cb) {
603	$retval = eval { $cb->($TERM->{_pkg}{$pkg}, @_) }	778	my $retval_ = eval { $cb->($TERM->{_pkg}{$pkg}, @_) };
604	and last;	779	$retval \|\|= $retval_;
605		780
606	if ($@) {	781	if ($@) {
607	$TERM->ungrab; # better to lose the grab than the session	782	$TERM->ungrab; # better to lose the grab than the session
608	warn $@;	783	warn $@;
609	}	784	}
…		…
612	verbose 11, "$HOOKNAME[$htype] returning <$retval>"	787	verbose 11, "$HOOKNAME[$htype] returning <$retval>"
613	if $verbosity >= 11;	788	if $verbosity >= 11;
614	}	789	}
615		790
616	if ($htype == 1) { # DESTROY	791	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	792	# clear package objects
625	%$_ = () for values %{ $TERM->{_pkg} };	793	%$_ = () for values %{ $TERM->{_pkg} };
626		794
627	# clear package	795	# clear package
628	%$TERM = ();	796	%$TERM = ();
629	}	797	}
630		798
631	$retval	799	$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	}	800	}
645		801
646	# urxvt::term::extension	802	# urxvt::term::extension
647		803
648	package urxvt::term::extension;	804	package urxvt::term::extension;
…		…
654	while (my ($name, $cb) = each %hook) {	810	while (my ($name, $cb) = each %hook) {
655	my $htype = $HOOKTYPE{uc $name};	811	my $htype = $HOOKTYPE{uc $name};
656	defined $htype	812	defined $htype
657	or Carp::croak "unsupported hook type '$name'";	813	or Carp::croak "unsupported hook type '$name'";
658		814
		815	$self->set_should_invoke ($htype, +1)
659	unless (exists $self->{term}{_hook}[$htype]{$pkg}) {	816	unless exists $self->{term}{_hook}[$htype]{$pkg};
660	$hook_count[$htype]++
661	or urxvt::set_should_invoke $htype, 1;
662	}
663		817
664	$self->{term}{_hook}[$htype]{$pkg} = $cb;	818	$self->{term}{_hook}[$htype]{$pkg} = $cb;
665	}	819	}
666	}	820	}
667		821
…		…
672	for my $name (@hook) {	826	for my $name (@hook) {
673	my $htype = $HOOKTYPE{uc $name};	827	my $htype = $HOOKTYPE{uc $name};
674	defined $htype	828	defined $htype
675	or Carp::croak "unsupported hook type '$name'";	829	or Carp::croak "unsupported hook type '$name'";
676		830
		831	$self->set_should_invoke ($htype, -1)
677	if (delete $self->{term}{_hook}[$htype]{$pkg}) {	832	if delete $self->{term}{_hook}[$htype]{$pkg};
678	--$hook_count[$htype]
679	or urxvt::set_should_invoke $htype, 0;
680	}
681	}	833	}
682	}	834	}
683		835
684	our $AUTOLOAD;	836	our $AUTOLOAD;
685		837
…		…
791	# find on_xxx subs in the package and register them	943	# find on_xxx subs in the package and register them
792	# as hooks	944	# as hooks
793	sub register_package {	945	sub register_package {
794	my ($self, $pkg, $argv) = @_;	946	my ($self, $pkg, $argv) = @_;
795		947
		948	no strict 'refs';
		949
		950	urxvt::verbose 6, "register package $pkg to $self";
		951
		952	@{"$pkg\::ISA"} = urxvt::term::extension::;
		953
796	my $proxy = bless {	954	my $proxy = bless {
797	_pkg => $pkg,	955	_pkg => $pkg,
798	argv => $argv,	956	argv => $argv,
799	}, $pkg;	957	}, $pkg;
800	Scalar::Util::weaken ($proxy->{term} = $self);	958	Scalar::Util::weaken ($proxy->{term} = $self);
…		…
831		989
832	Destroy the terminal object (close the window, free resources	990	Destroy the terminal object (close the window, free resources
833	etc.). Please note that @@RXVT_NAME@@ will not exit as long as any event	991	etc.). Please note that @@RXVT_NAME@@ will not exit as long as any event
834	watchers (timers, io watchers) are still active.	992	watchers (timers, io watchers) are still active.
835		993
		994	=item $term->exec_async ($cmd[, @args])
		995
		996	Works like the combination of the C<fork>/C<exec> builtins, which executes
		997	("starts") programs in the background. This function takes care of setting
		998	the user environment before exec'ing the command (e.g. C<PATH>) and should
		999	be preferred over explicit calls to C<exec> or C<system>.
		1000
		1001	Returns the pid of the subprocess or C<undef> on error.
		1002
		1003	=cut
		1004
		1005	sub exec_async {
		1006	my $self = shift;
		1007
		1008	my $pid = fork;
		1009
		1010	return $pid
		1011	if !defined $pid or $pid;
		1012
		1013	%ENV = %{ $self->env };
		1014
		1015	exec @_;
		1016	urxvt::_exit 255;
		1017	}
		1018
836	=item $isset = $term->option ($optval[, $set])	1019	=item $isset = $term->option ($optval[, $set])
837		1020
838	Returns true if the option specified by C<$optval> is enabled, and	1021	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	1022	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.	1023	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	1025	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:	1026	source file F</src/optinc.h> to see the actual list:
844		1027
845	borderLess console cursorBlink cursorUnderline hold iconic insecure	1028	borderLess console cursorBlink cursorUnderline hold iconic insecure
846	intensityStyles jumpScroll loginShell mapAlert meta8 mouseWheelScrollPage	1029	intensityStyles jumpScroll loginShell mapAlert meta8 mouseWheelScrollPage
847	pastableTabs pointerBlank reverseVideo scrollBar scrollBar_floating	1030	override-redirect pastableTabs pointerBlank reverseVideo scrollBar
848	scrollBar_right scrollTtyKeypress scrollTtyOutput scrollWithBuffer	1031	scrollBar_floating scrollBar_right scrollTtyKeypress scrollTtyOutput
849	secondaryScreen secondaryScroll skipBuiltinGlyphs transparent	1032	scrollWithBuffer secondaryScreen secondaryScroll skipBuiltinGlyphs
850	tripleclickwords utmpInhibit visualBell	1033	transparent tripleclickwords utmpInhibit visualBell
851		1034
852	=item $value = $term->resource ($name[, $newval])	1035	=item $value = $term->resource ($name[, $newval])
853		1036
854	Returns the current resource value associated with a given name and	1037	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>	1038	optionally sets a new value. Setting values is most useful in the C<init>
…		…
872		1055
873	answerbackstring backgroundPixmap backspace_key boldFont boldItalicFont	1056	answerbackstring backgroundPixmap backspace_key boldFont boldItalicFont
874	borderLess color cursorBlink cursorUnderline cutchars delete_key	1057	borderLess color cursorBlink cursorUnderline cutchars delete_key
875	display_name embed ext_bwidth fade font geometry hold iconName	1058	display_name embed ext_bwidth fade font geometry hold iconName
876	imFont imLocale inputMethod insecure int_bwidth intensityStyles	1059	imFont imLocale inputMethod insecure int_bwidth intensityStyles
877	italicFont jumpScroll lineSpace loginShell mapAlert menu meta8 modifier	1060	italicFont jumpScroll lineSpace loginShell mapAlert meta8 modifier
878	mouseWheelScrollPage name pastableTabs path perl_eval perl_ext_1 perl_ext_2	1061	mouseWheelScrollPage name override_redirect pastableTabs path perl_eval
879	perl_lib pointerBlank pointerBlankDelay preeditType print_pipe pty_fd	1062	perl_ext_1 perl_ext_2 perl_lib pointerBlank pointerBlankDelay
880	reverseVideo saveLines scrollBar scrollBar_align scrollBar_floating	1063	preeditType print_pipe pty_fd reverseVideo saveLines scrollBar
881	scrollBar_right scrollBar_thickness scrollTtyKeypress scrollTtyOutput	1064	scrollBar_align scrollBar_floating scrollBar_right scrollBar_thickness
882	scrollWithBuffer scrollstyle secondaryScreen secondaryScroll selectstyle	1065	scrollTtyKeypress scrollTtyOutput scrollWithBuffer scrollstyle
883	shade term_name title transparent transparent_all tripleclickwords	1066	secondaryScreen secondaryScroll selectstyle shade term_name title
884	utmpInhibit visualBell	1067	transient_for transparent transparent_all tripleclickwords utmpInhibit
		1068	visualBell
885		1069
886	=cut	1070	=cut
887		1071
888	sub resource($$;$) {	1072	sub resource($$;$) {
889	my ($self, $name) = (shift, shift);	1073	my ($self, $name) = (shift, shift);
…		…
1090		1274
1091	=item $windowid = $term->vt	1275	=item $windowid = $term->vt
1092		1276
1093	Return the window id of the terminal window.	1277	Return the window id of the terminal window.
1094		1278
		1279	=item $term->vt_emask_add ($x_event_mask)
		1280
		1281	Adds the specified events to the vt event mask. Useful e.g. when you want
		1282	to receive pointer events all the times:
		1283
		1284	$term->vt_emask_add (urxvt::PointerMotionMask);
		1285
1095	=item $window_width = $term->width	1286	=item $window_width = $term->width
1096		1287
1097	=item $window_height = $term->height	1288	=item $window_height = $term->height
1098		1289
1099	=item $font_width = $term->fwidth	1290	=item $font_width = $term->fwidth
…		…
1112		1303
1113	=item $max_scrollback = $term->saveLines	1304	=item $max_scrollback = $term->saveLines
1114		1305
1115	=item $nrow_plus_saveLines = $term->total_rows	1306	=item $nrow_plus_saveLines = $term->total_rows
1116		1307
1117	=item $lines_in_scrollback = $term->nsaved	1308	=item $topmost_scrollback_row = $term->top_row
1118		1309
1119	Return various integers describing terminal characteristics.	1310	Return various integers describing terminal characteristics.
1120		1311
1121	=item $x_display = $term->display_id	1312	=item $x_display = $term->display_id
1122		1313
…		…
1150	Return the modifier masks corresponding to the "ISO Level 3 Shift" (often	1341	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.	1342	AltGr), the meta key (often Alt) and the num lock key, if applicable.
1152		1343
1153	=item $view_start = $term->view_start ([$newvalue])	1344	=item $view_start = $term->view_start ([$newvalue])
1154		1345
1155	Returns the negative row number of the topmost line. Minimum value is	1346	Returns the row number of the topmost displayed line. Maximum value is
1156	C<0>, which displays the normal terminal contents. Larger values scroll	1347	C<0>, which displays the normal terminal contents. Lower values scroll
1157	this many lines into the scrollback buffer.	1348	this many lines into the scrollback buffer.
1158		1349
1159	=item $term->want_refresh	1350	=item $term->want_refresh
1160		1351
1161	Requests a screen refresh. At the next opportunity, rxvt-unicode will	1352	Requests a screen refresh. At the next opportunity, rxvt-unicode will
…		…
1474	my $env = $self->{term}->env;	1665	my $env = $self->{term}->env;
1475	# we can't hope to reproduce the locale algorithm, so nuke LC_ALL and set LC_CTYPE.	1666	# we can't hope to reproduce the locale algorithm, so nuke LC_ALL and set LC_CTYPE.
1476	delete $env->{LC_ALL};	1667	delete $env->{LC_ALL};
1477	$env->{LC_CTYPE} = $self->{term}->locale;	1668	$env->{LC_CTYPE} = $self->{term}->locale;
1478		1669
1479	urxvt::term->new ($env, $self->{term}->resource ("name"),	1670	urxvt::term->new ($env, "popup",
1480	"--perl-lib" => "", "--perl-ext-common" => "", "-pty-fd" => -1, "-sl" => 0, "-b" => 0,	1671	"--perl-lib" => "", "--perl-ext-common" => "",
		1672	"-pty-fd" => -1, "-sl" => 0,
		1673	"-b" => 1, "-bd" => "grey80", "-bl", "-override-redirect",
1481	"--transient-for" => $self->{term}->parent,	1674	"--transient-for" => $self->{term}->parent,
1482	"-display" => $self->{term}->display_id,	1675	"-display" => $self->{term}->display_id,
1483	"-pe" => "urxvt-popup")	1676	"-pe" => "urxvt-popup")
1484	or die "unable to create popup window\n";	1677	or die "unable to create popup window\n";
1485	}	1678	}
…		…
1490	delete $self->{term}{_destroy}{$self};	1683	delete $self->{term}{_destroy}{$self};
1491	$self->{term}->ungrab;	1684	$self->{term}->ungrab;
1492	}	1685	}
1493		1686
1494	=back	1687	=back
		1688
		1689	=cut
		1690
		1691	package urxvt::watcher;
		1692
		1693	@urxvt::timer::ISA = __PACKAGE__;
		1694	@urxvt::iow::ISA = __PACKAGE__;
		1695	@urxvt::pw::ISA = __PACKAGE__;
		1696	@urxvt::iw::ISA = __PACKAGE__;
1495		1697
1496	=head2 The C<urxvt::timer> Class	1698	=head2 The C<urxvt::timer> Class
1497		1699
1498	This class implements timer watchers/events. Time is represented as a	1700	This class implements timer watchers/events. Time is represented as a
1499	fractional number of seconds since the epoch. Example:	1701	fractional number of seconds since the epoch. Example:
…		…
1537	Start the timer.	1739	Start the timer.
1538		1740
1539	=item $timer = $timer->start ($tstamp)	1741	=item $timer = $timer->start ($tstamp)
1540		1742
1541	Set the event trigger time to C<$tstamp> and start the timer.	1743	Set the event trigger time to C<$tstamp> and start the timer.
		1744
		1745	=item $timer = $timer->after ($delay)
		1746
		1747	Like C<start>, but sets the expiry timer to c<urxvt::NOW + $delay>.
1542		1748
1543	=item $timer = $timer->stop	1749	=item $timer = $timer->stop
1544		1750
1545	Stop the timer.	1751	Stop the timer.
1546		1752
…		…
1593		1799
1594	Stop watching for events on the given filehandle.	1800	Stop watching for events on the given filehandle.
1595		1801
1596	=back	1802	=back
1597		1803
		1804	=head2 The C<urxvt::iw> Class
		1805
		1806	This class implements idle watchers, that get called automatically when
		1807	the process is idle. They should return as fast as possible, after doing
		1808	some useful work.
		1809
		1810	=over 4
		1811
		1812	=item $iw = new urxvt::iw
		1813
		1814	Create a new idle watcher object in stopped state.
		1815
		1816	=item $iw = $iw->cb (sub { my ($iw) = @_; ... })
		1817
		1818	Set the callback to be called when the watcher triggers.
		1819
		1820	=item $timer = $timer->start
		1821
		1822	Start the watcher.
		1823
		1824	=item $timer = $timer->stop
		1825
		1826	Stop the watcher.
		1827
		1828	=back
		1829
		1830	=head2 The C<urxvt::pw> Class
		1831
		1832	This class implements process watchers. They create an event whenever a
		1833	process exits, after which they stop automatically.
		1834
		1835	my $pid = fork;
		1836	...
		1837	$term->{pw} = urxvt::pw
		1838	->new
		1839	->start ($pid)
		1840	->cb (sub {
		1841	my ($pw, $exit_status) = @_;
		1842	...
		1843	});
		1844
		1845	=over 4
		1846
		1847	=item $pw = new urxvt::pw
		1848
		1849	Create a new process watcher in stopped state.
		1850
		1851	=item $pw = $pw->cb (sub { my ($pw, $exit_status) = @_; ... })
		1852
		1853	Set the callback to be called when the timer triggers.
		1854
		1855	=item $pw = $timer->start ($pid)
		1856
		1857	Tells the wqtcher to start watching for process C<$pid>.
		1858
		1859	=item $pw = $pw->stop
		1860
		1861	Stop the watcher.
		1862
		1863	=back
		1864
1598	=head1 ENVIRONMENT	1865	=head1 ENVIRONMENT
1599		1866
1600	=head2 URXVT_PERL_VERBOSITY	1867	=head2 URXVT_PERL_VERBOSITY
1601		1868
1602	This variable controls the verbosity level of the perl extension. Higher	1869	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.114 by root, Fri Jan 20 12:16:28 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.114 by root, Fri Jan 20 12:16:28 2006 UTC