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

Comparing rxvt-unicode/src/urxvt.pm (file contents):
Revision 1.37 by root, Fri Jan 6 03:40:19 2006 UTC vs.
Revision 1.75 by root, Tue Jan 10 05:00:13 2006 UTC

…		…
17		17
18	@@RXVT_NAME@@ --perl-lib $HOME -pe grab_test	18	@@RXVT_NAME@@ --perl-lib $HOME -pe grab_test
19		19
20	=head1 DESCRIPTION	20	=head1 DESCRIPTION
21		21
22	Everytime a terminal object gets created, scripts specified via the	22	Everytime a terminal object gets created, extension scripts specified via
23	C<perl> resource are loaded and associated with it.	23	the C<perl> resource are loaded and associated with it.
24		24
25	Scripts are compiled in a 'use strict' and 'use utf8' environment, and	25	Scripts are compiled in a 'use strict' and 'use utf8' environment, and
26	thus must be encoded as UTF-8.	26	thus must be encoded as UTF-8.
27		27
28	Each script will only ever be loaded once, even in @@RXVT_NAME@@d, where	28	Each script will only ever be loaded once, even in @@RXVT_NAME@@d, where
29	scripts will be shared (but not enabled) for all terminals.	29	scripts will be shared (but not enabled) for all terminals.
30		30
31	=head2 Prepackaged Extensions	31	=head1 PREPACKAGED EXTENSIONS
32		32
33	This section describes the extensiosn delivered with this version. You can	33	This section describes the extensions delivered with this release. You can
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		39
40	=over 4	40	=over 4
41		41
42	=item selection	42	=item selection (enabled by default)
43		43
44	Intelligent selection. This extension tries to be more intelligent when	44	(More) intelligent selection. This extension tries to be more intelligent
45	the user extends selections (double-click). Right now, it tries to select	45	when the user extends selections (double-click). Right now, it tries to
46	urls and complete shell-quoted arguments, which is very convenient, too,	46	select urls and complete shell-quoted arguments, which is very convenient,
47	if your F<ls> supports C<--quoting-style=shell>.	47	too, if your F<ls> supports C<--quoting-style=shell>.
48		48
49	It also offers the following bindable event:	49	It also offers the following bindable keyboard command:
50		50
51	=over 4	51	=over 4
52		52
53	=item rot13	53	=item rot13
54		54
…		…
56		56
57	URxvt.keysym.C-M-r: perl:selection:rot13	57	URxvt.keysym.C-M-r: perl:selection:rot13
58		58
59	=back	59	=back
60		60
		61	=item option-popup (enabled by default)
		62
		63	Binds a popup menu to Ctrl-Button2 that lets you toggle (some) options at
		64	runtime.
		65
		66	=item selection-popup (enabled by default)
		67
		68	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
		70	evalution, web-browser starting etc.), depending on content.
		71
		72	=item searchable-scrollback<hotkey> (enabled by default)
		73
		74	Adds regex search functionality to the scrollback buffer, triggered
		75	by a hotkey (default: C<M-s>). When in search mode, normal terminal
		76	input/output is suspended.
		77
		78	C</> starts an incremental regex search, C<n> searches further, C<p> or
		79	C<N> jump to the previous match, C<G> jumps to the bottom and clears the
		80	history, C<enter> leaves search mode at the current position and C<escape>
		81	returns to the original position.
		82
61	=item digital-clock	83	=item digital-clock
62		84
63	Displays a digital clock using the built-in overlay.	85	Displays a digital clock using the built-in overlay.
64		86
65	=item mark-urls	87	=item mark-urls
66		88
67	Uses per-line filtering (C<on_line_update>) to underline urls.	89	Uses per-line display filtering (C<on_line_update>) to underline urls.
		90
		91	=item block-graphics-to-ascii
		92
		93	A not very useful example of filtering all text output to the terminal,
		94	by replacing all line-drawing characters (U+2500 .. U+259F) by a
		95	similar-looking ascii character.
68		96
69	=item example-refresh-hooks	97	=item example-refresh-hooks
70		98
71	Displays a very simple digital clock in the upper right corner of the	99	Displays a very simple digital clock in the upper right corner of the
72	window. Illustrates overwriting the refresh callbacks to create your own	100	window. Illustrates overwriting the refresh callbacks to create your own
73	overlays or changes.	101	overlays or changes.
74		102
75	=item example-filter-input
76
77	A not very useful example of filtering all text output to the terminal, by
78	underlining all urls that matches a certain regex (i.e. some urls :). It
79	is not very useful because urls that are output in multiple steps (e.g.
80	when typing them) do not get marked.
81
82	=back	103	=back
		104
		105	=head1 API DOCUMENTATION
83		106
84	=head2 General API Considerations	107	=head2 General API Considerations
85		108
86	All objects (such as terminals, time watchers etc.) are typical	109	All objects (such as terminals, time watchers etc.) are typical
87	reference-to-hash objects. The hash can be used to store anything you	110	reference-to-hash objects. The hash can be used to store anything you
…		…
115	Either binary data or - more common - a text string encoded in a	138	Either binary data or - more common - a text string encoded in a
116	locale-specific way.	139	locale-specific way.
117		140
118	=back	141	=back
119		142
		143	=head2 Extension Objects
		144
		145	Very perl extension is a perl class. A separate perl object is created
		146	for each terminal and each extension and passed as the first parameter to
		147	hooks. So extensions can use their C<$self> object without having to think
		148	about other extensions, with the exception of methods and members that
		149	begin with an underscore character C<_>: these are reserved for internal
		150	use.
		151
		152	Although it isn't a C<urxvt::term> object, you can call all methods of the
		153	C<urxvt::term> class on this object.
		154
		155	It has the following methods and data members:
		156
		157	=over 4
		158
		159	=item $urxvt_term = $self->{term}
		160
		161	Returns the C<urxvt::term> object associated with this instance of the
		162	extension. This member I<must not> be changed in any way.
		163
		164	=item $self->enable ($hook_name => $cb, [$hook_name => $cb..])
		165
		166	Dynamically enable the given hooks (named without the C<on_> prefix) for
		167	this extension, replacing any previous hook. This is useful when you want
		168	to overwrite time-critical hooks only temporarily.
		169
		170	=item $self->disable ($hook_name[, $hook_name..])
		171
		172	Dynamically disable the given hooks.
		173
		174	=back
		175
120	=head2 Hooks	176	=head2 Hooks
121		177
122	The following subroutines can be declared in loaded scripts, and will be	178	The following subroutines can be declared in extension files, and will be
123	called whenever the relevant event happens.	179	called whenever the relevant event happens.
124		180
125	The first argument passed to them is an object private to each terminal	181	The first argument passed to them is an extension oject as described in
126	and extension package. You can call all C<urxvt::term> methods on it, but	182	the in the C<Extension Objects> section.
127	its not a real C<urxvt::term> object. Instead, the real C<urxvt::term>
128	object that is shared between all packages is stored in the C<term>
129	member.
130		183
131	All of them must return a boolean value. If it is true, then the event	184	B<All> of these hooks must return a boolean value. If it is true, then the
132	counts as being I<consumed>, and the invocation of other hooks is skipped,	185	event counts as being I<consumed>, and the invocation of other hooks is
133	and the relevant action might not be carried out by the C++ code.	186	skipped, and the relevant action might not be carried out by the C++ code.
134		187
135	When in doubt, return a false value (preferably C<()>).	188	I<< When in doubt, return a false value (preferably C<()>). >>
136		189
137	=over 4	190	=over 4
138		191
139	=item on_init $term	192	=item on_init $term
140		193
…		…
179	should extend the selection itelf and return true to suppress the built-in	232	should extend the selection itelf and return true to suppress the built-in
180	processing.	233	processing.
181		234
182	See the F<selection> example extension.	235	See the F<selection> example extension.
183		236
184	=item on_focus_in $term
185
186	Called whenever the window gets the keyboard focus, before urxvt does
187	focus in processing.
188
189	=item on_focus_out $term
190
191	Called wheneever the window loses keyboard focus, before urxvt does focus
192	out processing.
193
194	=item on_view_change $term, $offset	237	=item on_view_change $term, $offset
195		238
196	Called whenever the view offset changes, i..e the user or program	239	Called whenever the view offset changes, i..e the user or program
197	scrolls. Offset C<0> means display the normal terminal, positive values	240	scrolls. Offset C<0> means display the normal terminal, positive values
198	show this many lines of scrollback.	241	show this many lines of scrollback.
…		…
204	than the scroll back buffer or the terminal.	247	than the scroll back buffer or the terminal.
205		248
206	It is called before lines are scrolled out (so rows 0 .. min ($lines - 1,	249	It is called before lines are scrolled out (so rows 0 .. min ($lines - 1,
207	$nrow - 1) represent the lines to be scrolled out). C<$saved> is the total	250	$nrow - 1) represent the lines to be scrolled out). C<$saved> is the total
208	number of lines that will be in the scrollback buffer.	251	number of lines that will be in the scrollback buffer.
209
210	=item on_tty_activity $term NYI
211
212	Called whenever the program(s) running in the urxvt window send output.
213		252
214	=item on_osc_seq $term, $string	253	=item on_osc_seq $term, $string
215		254
216	Called whenever the B<ESC ] 777 ; string ST> command sequence (OSC =	255	Called whenever the B<ESC ] 777 ; string ST> command sequence (OSC =
217	operating system command) is processed. Cursor position and other state	256	operating system command) is processed. Cursor position and other state
…		…
230	can filter/change and output the text yourself by returning a true value	269	can filter/change and output the text yourself by returning a true value
231	and calling C<< $term->scr_add_lines >> yourself. Please note that this	270	and calling C<< $term->scr_add_lines >> yourself. Please note that this
232	might be very slow, however, as your hook is called for B<all> text being	271	might be very slow, however, as your hook is called for B<all> text being
233	output.	272	output.
234		273
		274	=item on_tt_write $term, $octets
		275
		276	Called whenever some data is written to the tty/pty and can be used to
		277	suppress or filter tty input.
		278
235	=item on_line_update $term, $row	279	=item on_line_update $term, $row
236		280
237	Called whenever a line was updated or changed. Can be used to filter	281	Called whenever a line was updated or changed. Can be used to filter
238	screen output (e.g. underline urls or other useless stuff). Only lines	282	screen output (e.g. underline urls or other useless stuff). Only lines
239	that are being shown will be filtered, and, due to performance reasons,	283	that are being shown will be filtered, and, due to performance reasons,
…		…
261		305
262	Called whenever the user presses a key combination that has a	306	Called whenever the user presses a key combination that has a
263	C<perl:string> action bound to it (see description of the B<keysym>	307	C<perl:string> action bound to it (see description of the B<keysym>
264	resource in the @@RXVT_NAME@@(1) manpage).	308	resource in the @@RXVT_NAME@@(1) manpage).
265		309
		310	=item on_focus_in $term
		311
		312	Called whenever the window gets the keyboard focus, before rxvt-unicode
		313	does focus in processing.
		314
		315	=item on_focus_out $term
		316
		317	Called wheneever the window loses keyboard focus, before rxvt-unicode does
		318	focus out processing.
		319
266	=item on_key_press $term, $event	320	=item on_key_press $term, $event, $keysym, $octets
267		321
268	=item on_key_release $term, $event	322	=item on_key_release $term, $event, $keysym
269		323
270	=item on_button_press $term, $event	324	=item on_button_press $term, $event
271		325
272	=item on_button_release $term, $event	326	=item on_button_release $term, $event
273		327
274	=item on_motion_notify $term, $event	328	=item on_motion_notify $term, $event
275		329
		330	=item on_map_notify $term, $event
		331
		332	=item on_unmap_notify $term, $event
		333
276	Called whenever the corresponding X event is received for the terminal. If	334	Called whenever the corresponding X event is received for the terminal If
277	the hook returns true, then the even will be ignored by rxvt-unicode.	335	the hook returns true, then the even will be ignored by rxvt-unicode.
278		336
		337	The event is a hash with most values as named by Xlib (see the XEvent
		338	manpage), with the additional members C<row> and C<col>, which are the row
		339	and column under the mouse cursor.
		340
		341	C<on_key_press> additionally receives the string rxvt-unicode would
		342	output, if any, in locale-specific encoding.
		343
279	subwindow.	344	subwindow.
280		345
281	=back	346	=back
282		347
283	=head2 Variables in the C<urxvt> Package	348	=head2 Variables in the C<urxvt> Package
284		349
285	=over 4	350	=over 4
286		351
		352	=item $urxvt::LIBDIR
		353
		354	The rxvt-unicode library directory, where, among other things, the perl
		355	modules and scripts are stored.
		356
		357	=item $urxvt::RESCLASS, $urxvt::RESCLASS
		358
		359	The resource class and name rxvt-unicode uses to look up X resources.
		360
		361	=item $urxvt::RXVTNAME
		362
		363	The basename of the installed binaries, usually C<urxvt>.
		364
287	=item $urxvt::TERM	365	=item $urxvt::TERM
288		366
289	The current terminal. Whenever a callback/Hook is bein executed, this	367	The current terminal. This variable stores the current C<urxvt::term>
290	variable stores the current C<urxvt::term> object.	368	object, whenever a callback/hook is executing.
		369
		370	=item
291		371
292	=back	372	=back
293		373
294	=head2 Functions in the C<urxvt> Package	374	=head2 Functions in the C<urxvt> Package
295		375
…		…
316	that calls this function.	396	that calls this function.
317		397
318	Using this function has the advantage that its output ends up in the	398	Using this function has the advantage that its output ends up in the
319	correct place, e.g. on stderr of the connecting urxvtc client.	399	correct place, e.g. on stderr of the connecting urxvtc client.
320		400
		401	=item $is_safe = urxvt::safe
		402
		403	Returns true when it is safe to do potentially unsafe things, such as
		404	evaluating perl code specified by the user. This is true when urxvt was
		405	started setuid or setgid.
		406
321	=item $time = urxvt::NOW	407	=item $time = urxvt::NOW
322		408
323	Returns the "current time" (as per the event loop).	409	Returns the "current time" (as per the event loop).
		410
		411	=item urxvt::CurrentTime
		412
		413	=item urxvt::ShiftMask, LockMask, ControlMask, Mod1Mask, Mod2Mask,
		414	Mod3Mask, Mod4Mask, Mod5Mask, Button1Mask, Button2Mask, Button3Mask,
		415	Button4Mask, Button5Mask, AnyModifier
		416
		417	Various constants for use in X calls and event processing.
324		418
325	=back	419	=back
326		420
327	=head2 RENDITION	421	=head2 RENDITION
328		422
…		…
355		449
356	=item $background = urxvt::GET_BASEBG $rend	450	=item $background = urxvt::GET_BASEBG $rend
357		451
358	Return the foreground/background colour index, respectively.	452	Return the foreground/background colour index, respectively.
359		453
360	=item $rend = urxvt::SET_FGCOLOR ($rend, $new_colour)	454	=item $rend = urxvt::SET_FGCOLOR $rend, $new_colour
361		455
362	=item $rend = urxvt::SET_BGCOLOR ($rend, $new_colour)	456	=item $rend = urxvt::SET_BGCOLOR $rend, $new_colour
363		457
364	Replace the foreground/background colour in the rendition mask with the	458	Replace the foreground/background colour in the rendition mask with the
365	specified one.	459	specified one.
366		460
367	=item $value = urxvt::GET_CUSTOM ($rend)	461	=item $value = urxvt::GET_CUSTOM $rend
368		462
369	Return the "custom" value: Every rendition has 5 bits for use by	463	Return the "custom" value: Every rendition has 5 bits for use by
370	extensions. They can be set and changed as you like and are initially	464	extensions. They can be set and changed as you like and are initially
371	zero.	465	zero.
372		466
373	=item $rend = urxvt::SET_CUSTOM ($rend, $new_value)	467	=item $rend = urxvt::SET_CUSTOM $rend, $new_value
374		468
375	Change the custom value.	469	Change the custom value.
376		470
377	=back	471	=back
378		472
379	=cut	473	=cut
380		474
381	package urxvt;	475	package urxvt;
382		476
		477	use utf8;
383	use strict;	478	use strict;
		479	use Carp ();
384	use Scalar::Util ();	480	use Scalar::Util ();
		481	use List::Util ();
385		482
		483	our $VERSION = 1;
386	our $TERM;	484	our $TERM;
387	our @HOOKNAME;	485	our @HOOKNAME;
		486	our %HOOKTYPE = map +($HOOKNAME[$_] => $_), 0..$#HOOKNAME;
		487	our %OPTION;
		488
388	our $LIBDIR;	489	our $LIBDIR;
		490	our $RESNAME;
		491	our $RESCLASS;
		492	our $RXVTNAME;
389		493
390	BEGIN {	494	BEGIN {
391	urxvt->bootstrap;	495	urxvt->bootstrap;
392		496
393	# overwrite perl's warn	497	# overwrite perl's warn
…		…
395	my $msg = join "", @_;	499	my $msg = join "", @_;
396	$msg .= "\n"	500	$msg .= "\n"
397	unless $msg =~ /\n$/;	501	unless $msg =~ /\n$/;
398	urxvt::warn ($msg);	502	urxvt::warn ($msg);
399	};	503	};
		504
		505	delete $ENV{IFS};
		506	delete $ENV{CDPATH};
		507	delete $ENV{BASH_ENV};
		508	$ENV{PATH} = "/bin:/sbin:/usr/bin:/usr/sbin:/usr/local/bin:/usr/local/sbin:/opt/bin:/opt/sbin";
400	}	509	}
401		510
402	my @hook_count;	511	my @hook_count;
403	my $verbosity = $ENV{URXVT_PERL_VERBOSITY};	512	my $verbosity = $ENV{URXVT_PERL_VERBOSITY};
404		513
405	sub verbose {	514	sub verbose {
406	my ($level, $msg) = @_;	515	my ($level, $msg) = @_;
407	warn "$msg\n" if $level <= $verbosity;	516	warn "$msg\n" if $level <= $verbosity;
408	}	517	}
409		518
410	# find on_xxx subs in the package and register them	519	my $extension_pkg = "extension0000";
411	# as hooks	520	my %extension_pkg;
412	sub register_package($) {
413	my ($pkg) = @_;
414
415	for my $htype (0.. $#HOOKNAME) {
416	my $name = $HOOKNAME[$htype];
417
418	my $ref = $pkg->can ("on_" . lc $name)
419	or next;
420
421	$TERM->{_hook}[$htype]{$pkg} = $ref;
422	$hook_count[$htype]++
423	or set_should_invoke $htype, 1;
424	}
425	}
426
427	my $script_pkg = "script0000";
428	my %script_pkg;
429		521
430	# load a single script into its own package, once only	522	# load a single script into its own package, once only
431	sub script_package($) {	523	sub extension_package($) {
432	my ($path) = @_;	524	my ($path) = @_;
433		525
434	$script_pkg{$path} \|\|= do {	526	$extension_pkg{$path} \|\|= do {
435	my $pkg = "urxvt::" . ($script_pkg++);	527	my $pkg = "urxvt::" . ($extension_pkg++);
436		528
437	verbose 3, "loading script '$path' into package '$pkg'";	529	verbose 3, "loading extension '$path' into package '$pkg'";
438		530
439	open my $fh, "<:raw", $path	531	open my $fh, "<:raw", $path
440	or die "$path: $!";	532	or die "$path: $!";
441		533
		534	my $source = untaint
442	my $source = "package $pkg; use strict; use utf8;\n"	535	"package $pkg; use strict; use utf8;\n"
		536	. "use base urxvt::term::extension::;\n"
443	. "#line 1 \"$path\"\n{\n"	537	. "#line 1 \"$path\"\n{\n"
444	. (do { local $/; <$fh> })	538	. (do { local $/; <$fh> })
445	. "\n};\n1";	539	. "\n};\n1";
446		540
		541	eval $source
447	eval $source or die "$path: $@";	542	or die "$path: $@";
448		543
449	$pkg	544	$pkg
450	}	545	}
451	}	546	}
452		547
…		…
457	local $TERM = shift;	552	local $TERM = shift;
458	my $htype = shift;	553	my $htype = shift;
459		554
460	if ($htype == 0) { # INIT	555	if ($htype == 0) { # INIT
461	my @dirs = ((split /:/, $TERM->resource ("perl_lib")), "$LIBDIR/perl");	556	my @dirs = ((split /:/, $TERM->resource ("perl_lib")), "$LIBDIR/perl");
		557
		558	my %ext_arg;
462		559
463	for my $ext (map { split /:/, $TERM->resource ("perl_ext_$_") } 1, 2) {	560	for (map { split /,/, $TERM->resource ("perl_ext_$_") } 1, 2) {
		561	if ($_ eq "default") {
		562	$ext_arg{$_} \|\|= [] for qw(selection option-popup selection-popup searchable-scrollback);
		563	} elsif (/^-(.*)$/) {
		564	delete $ext_arg{$1};
		565	} elsif (/^([^<]+)<(.*)>$/) {
		566	push @{ $ext_arg{$1} }, $2;
		567	} else {
		568	$ext_arg{$_} \|\|= [];
		569	}
		570	}
		571
		572	while (my ($ext, $argv) = each %ext_arg) {
464	my @files = grep -f $_, map "$_/$ext", @dirs;	573	my @files = grep -f $_, map "$_/$ext", @dirs;
465		574
466	if (@files) {	575	if (@files) {
467	register_package script_package $files[0];	576	$TERM->register_package (extension_package $files[0], $argv);
468	} else {	577	} else {
469	warn "perl extension '$ext' not found in perl library search path\n";	578	warn "perl extension '$ext' not found in perl library search path\n";
470	}	579	}
471	}	580	}
		581
		582	eval "#line 1 \"--perl-eval resource/argument\"\n" . $TERM->resource ("perl_eval");
		583	warn $@ if $@;
472	}	584	}
473		585
474	$retval = undef;	586	$retval = undef;
475		587
476	if (my $cb = $TERM->{_hook}[$htype]) {	588	if (my $cb = $TERM->{_hook}[$htype]) {
…		…
478	if $verbosity >= 10;	590	if $verbosity >= 10;
479		591
480	keys %$cb;	592	keys %$cb;
481		593
482	while (my ($pkg, $cb) = each %$cb) {	594	while (my ($pkg, $cb) = each %$cb) {
483	$retval = $cb->(	595	$retval = eval { $cb->($TERM->{_pkg}{$pkg}, @_) }
484	$TERM->{_pkg}{$pkg} \|\|= do {
485	my $proxy = bless { }, urxvt::term::proxy::;
486	Scalar::Util::weaken ($proxy->{term} = $TERM);
487	$proxy
488	},
489	@_,
490	) and last;	596	and last;
		597
		598	if ($@) {
		599	$TERM->ungrab; # better to lose the grab than the session
		600	warn $@;
		601	}
491	}	602	}
492	}	603	}
493		604
494	if ($htype == 1) { # DESTROY	605	if ($htype == 1) { # DESTROY
495	# remove hooks if unused
496	if (my $hook = $TERM->{_hook}) {	606	if (my $hook = delete $TERM->{_hook}) {
497	for my $htype (0..$#$hook) {	607	for my $htype (0..$#$hook) {
498	$hook_count[$htype] -= scalar keys %{ $hook->[$htype] \|\| {} }	608	$hook_count[$htype] -= scalar keys %{ $hook->[$htype] \|\| {} }
499	or set_should_invoke $htype, 0;	609	or set_should_invoke $htype, 0;
500	}	610	}
501	}	611	}
…		…
508	}	618	}
509		619
510	$retval	620	$retval
511	}	621	}
512		622
513	sub urxvt::term::proxy::AUTOLOAD {	623	# urxvt::term::extension
514	$urxvt::term::proxy::AUTOLOAD =~ /:([^:]+)$/	624
		625	package urxvt::term::extension;
		626
		627	sub enable {
		628	my ($self, %hook) = @_;
		629	my $pkg = $self->{_pkg};
		630
		631	while (my ($name, $cb) = each %hook) {
		632	my $htype = $HOOKTYPE{uc $name};
		633	defined $htype
		634	or Carp::croak "unsupported hook type '$name'";
		635
		636	unless (exists $self->{term}{_hook}[$htype]{$pkg}) {
		637	$hook_count[$htype]++
		638	or urxvt::set_should_invoke $htype, 1;
		639	}
		640
		641	$self->{term}{_hook}[$htype]{$pkg} = $cb;
		642	}
		643	}
		644
		645	sub disable {
		646	my ($self, @hook) = @_;
		647	my $pkg = $self->{_pkg};
		648
		649	for my $name (@hook) {
		650	my $htype = $HOOKTYPE{uc $name};
		651	defined $htype
		652	or Carp::croak "unsupported hook type '$name'";
		653
		654	if (delete $self->{term}{_hook}[$htype]{$pkg}) {
		655	--$hook_count[$htype]
		656	or urxvt::set_should_invoke $htype, 0;
		657	}
		658	}
		659	}
		660
		661	our $AUTOLOAD;
		662
		663	sub AUTOLOAD {
		664	$AUTOLOAD =~ /:([^:]+)$/
515	or die "FATAL: \$AUTOLOAD '$urxvt::term::proxy::AUTOLOAD' unparsable";	665	or die "FATAL: \$AUTOLOAD '$AUTOLOAD' unparsable";
516		666
517	eval qq{	667	eval qq{
518	sub $urxvt::term::proxy::AUTOLOAD {	668	sub $AUTOLOAD {
519	my \$proxy = shift;	669	my \$proxy = shift;
520	\$proxy->{term}->$1 (\@_)	670	\$proxy->{term}->$1 (\@_)
521	}	671	}
522	1	672	1
523	} or die "FATAL: unable to compile method forwarder: $@";	673	} or die "FATAL: unable to compile method forwarder: $@";
524		674
525	goto &$urxvt::term::proxy::AUTOLOAD;	675	goto &$AUTOLOAD;
526	}	676	}
		677
		678	sub DESTROY {
		679	# nop
		680	}
		681
		682	# urxvt::destroy_hook
		683
		684	sub urxvt::destroy_hook::DESTROY {
		685	${$_[0]}->();
		686	}
		687
		688	sub urxvt::destroy_hook(&) {
		689	bless \shift, urxvt::destroy_hook::
		690	}
		691
		692	package urxvt::anyevent;
		693
		694	=head2 The C<urxvt::anyevent> Class
		695
		696	The sole purpose of this class is to deliver an interface to the
		697	C<AnyEvent> module - any module using it will work inside urxvt without
		698	further programming. The only exception is that you cannot wait on
		699	condition variables, but non-blocking condvar use is ok. What this means
		700	is that you cannot use blocking APIs, but the non-blocking variant should
		701	work.
		702
		703	=cut
		704
		705	our $VERSION = 1;
		706
		707	$INC{"urxvt/anyevent.pm"} = 1; # mark us as there
		708	push @AnyEvent::REGISTRY, [urxvt => urxvt::anyevent::];
		709
		710	sub timer {
		711	my ($class, %arg) = @_;
		712
		713	my $cb = $arg{cb};
		714
		715	urxvt::timer
		716	->new
		717	->start (urxvt::NOW + $arg{after})
		718	->cb (sub {
		719	$_[0]->stop; # need to cancel manually
		720	$cb->();
		721	})
		722	}
		723
		724	sub io {
		725	my ($class, %arg) = @_;
		726
		727	my $cb = $arg{cb};
		728
		729	bless [$arg{fh}, urxvt::iow
		730	->new
		731	->fd (fileno $arg{fh})
		732	->events (($arg{poll} =~ /r/ ? 1 : 0)
		733	\| ($arg{poll} =~ /w/ ? 2 : 0))
		734	->start
		735	->cb (sub {
		736	$cb->(($_[1] & 1 ? 'r' : '')
		737	. ($_[1] & 2 ? 'w' : ''));
		738	})],
		739	urxvt::anyevent::
		740	}
		741
		742	sub DESTROY {
		743	$_[0][1]->stop;
		744	}
		745
		746	sub condvar {
		747	bless \my $flag, urxvt::anyevent::condvar::
		748	}
		749
		750	sub urxvt::anyevent::condvar::broadcast {
		751	${$_[0]}++;
		752	}
		753
		754	sub urxvt::anyevent::condvar::wait {
		755	unless (${$_[0]}) {
		756	Carp::croak "AnyEvent->condvar blocking wait unsupported in urxvt, use a non-blocking API";
		757	}
		758	}
		759
		760	package urxvt::term;
527		761
528	=head2 The C<urxvt::term> Class	762	=head2 The C<urxvt::term> Class
529		763
530	=over 4	764	=over 4
531		765
		766	=cut
		767
		768	# find on_xxx subs in the package and register them
		769	# as hooks
		770	sub register_package {
		771	my ($self, $pkg, $argv) = @_;
		772
		773	my $proxy = bless {
		774	_pkg => $pkg,
		775	argv => $argv,
		776	}, $pkg;
		777	Scalar::Util::weaken ($proxy->{term} = $self);
		778
		779	$self->{_pkg}{$pkg} = $proxy;
		780
		781	for my $name (@HOOKNAME) {
		782	if (my $ref = $pkg->can ("on_" . lc $name)) {
		783	$proxy->enable ($name => $ref);
		784	}
		785	}
		786	}
		787
532	=item $term->destroy	788	=item $term->destroy
533		789
534	Destroy the terminal object (close the window, free resources etc.).	790	Destroy the terminal object (close the window, free resources
		791	etc.). Please note that @@RXVT_NAME@@ will not exit as long as any event
		792	watchers (timers, io watchers) are still active.
		793
		794	=item $isset = $term->option ($optval[, $set])
		795
		796	Returns true if the option specified by C<$optval> is enabled, and
		797	optionally change it. All option values are stored by name in the hash
		798	C<%urxvt::OPTION>. Options not enabled in this binary are not in the hash.
		799
		800	Here is a a likely non-exhaustive list of option names, please see the
		801	source file F</src/optinc.h> to see the actual list:
		802
		803	borderLess console cursorBlink cursorUnderline hold iconic insecure
		804	intensityStyles jumpScroll loginShell mapAlert meta8 mouseWheelScrollPage
		805	pastableTabs pointerBlank reverseVideo scrollBar scrollBar_floating
		806	scrollBar_right scrollTtyKeypress scrollTtyOutput scrollWithBuffer
		807	secondaryScreen secondaryScroll skipBuiltinGlyphs transparent
		808	tripleclickwords utmpInhibit visualBell
535		809
536	=item $value = $term->resource ($name[, $newval])	810	=item $value = $term->resource ($name[, $newval])
537		811
538	Returns the current resource value associated with a given name and	812	Returns the current resource value associated with a given name and
539	optionally sets a new value. Setting values is most useful in the C<init>	813	optionally sets a new value. Setting values is most useful in the C<init>
…		…
549		823
550	Please note that resource strings will currently only be freed when the	824	Please note that resource strings will currently only be freed when the
551	terminal is destroyed, so changing options frequently will eat memory.	825	terminal is destroyed, so changing options frequently will eat memory.
552		826
553	Here is a a likely non-exhaustive list of resource names, not all of which	827	Here is a a likely non-exhaustive list of resource names, not all of which
554	are supported in every build, please see the source to see the actual	828	are supported in every build, please see the source file F</src/rsinc.h>
555	list:	829	to see the actual list:
556		830
557	answerbackstring backgroundPixmap backspace_key boldFont boldItalicFont	831	answerbackstring backgroundPixmap backspace_key boldFont boldItalicFont
558	borderLess color cursorBlink cursorUnderline cutchars delete_key	832	borderLess color cursorBlink cursorUnderline cutchars delete_key
559	display_name embed ext_bwidth fade font geometry hold iconName	833	display_name embed ext_bwidth fade font geometry hold iconName
560	imFont imLocale inputMethod insecure int_bwidth intensityStyles	834	imFont imLocale inputMethod insecure int_bwidth intensityStyles
…		…
567	shade term_name title transparent transparent_all tripleclickwords	841	shade term_name title transparent transparent_all tripleclickwords
568	utmpInhibit visualBell	842	utmpInhibit visualBell
569		843
570	=cut	844	=cut
571		845
572	sub urxvt::term::resource($$;$) {	846	sub resource($$;$) {
573	my ($self, $name) = (shift, shift);	847	my ($self, $name) = (shift, shift);
574	unshift @_, $self, $name, ($name =~ s/\s\+\s(\d+)$// ? $1 : 0);	848	unshift @_, $self, $name, ($name =~ s/\s\+\s(\d+)$// ? $1 : 0);
575	goto &urxvt::term::_resource;	849	&urxvt::term::_resource
576	}	850	}
		851
		852	=item $success = $term->parse_keysym ($keysym_spec, $command_string)
		853
		854	Adds a keymap translation exactly as specified via a resource. See the
		855	C<keysym> resource in the @@RXVT_NAME@@(1) manpage.
577		856
578	=item $rend = $term->rstyle ([$new_rstyle])	857	=item $rend = $term->rstyle ([$new_rstyle])
579		858
580	Return and optionally change the current rendition. Text that is output by	859	Return and optionally change the current rendition. Text that is output by
581	the terminal application will use this style.	860	the terminal application will use this style.
…		…
601		880
602	=item $oldtext = $term->selection ([$newtext])	881	=item $oldtext = $term->selection ([$newtext])
603		882
604	Return the current selection text and optionally replace it by C<$newtext>.	883	Return the current selection text and optionally replace it by C<$newtext>.
605		884
606	#=item $term->overlay ($x, $y, $text)	885	=item $term->overlay_simple ($x, $y, $text)
607	#	886
608	#Create a simple multi-line overlay box. See the next method for details.	887	Create a simple multi-line overlay box. See the next method for details.
609	#	888
610	#=cut	889	=cut
611	#	890
612	#sub urxvt::term::scr_overlay {	891	sub overlay_simple {
613	# my ($self, $x, $y, $text) = @_;	892	my ($self, $x, $y, $text) = @_;
614	#	893
615	# my @lines = split /\n/, $text;	894	my @lines = split /\n/, $text;
616	#	895
617	# my $w = 0;	896	my $w = List::Util::max map $self->strwidth ($_), @lines;
618	# for (map $self->strwidth ($_), @lines) {	897
619	# $w = $_ if $w < $_;
620	# }
621	#
622	# $self->scr_overlay_new ($x, $y, $w, scalar @lines);	898	my $overlay = $self->overlay ($x, $y, $w, scalar @lines);
623	# $self->scr_overlay_set (0, $_, $lines[$_]) for 0.. $#lines;	899	$overlay->set (0, $_, $lines[$_]) for 0.. $#lines;
624	#}	900
		901	$overlay
		902	}
625		903
626	=item $term->overlay ($x, $y, $width, $height[, $rstyle[, $border]])	904	=item $term->overlay ($x, $y, $width, $height[, $rstyle[, $border]])
627		905
628	Create a new (empty) overlay at the given position with the given	906	Create a new (empty) overlay at the given position with the given
629	width/height. C<$rstyle> defines the initial rendition style	907	width/height. C<$rstyle> defines the initial rendition style
…		…
656		934
657	If hidden, display the overlay again.	935	If hidden, display the overlay again.
658		936
659	=back	937	=back
660		938
		939	=item $popup = $term->popup ($event)
		940
		941	Creates a new C<urxvt::popup> object that implements a popup menu. The
		942	C<$event> I<must> be the event causing the menu to pop up (a button event,
		943	currently).
		944
		945	=cut
		946
		947	sub popup {
		948	my ($self, $event) = @_;
		949
		950	$self->grab ($event->{time}, 1)
		951	or return;
		952
		953	my $popup = bless {
		954	term => $self,
		955	event => $event,
		956	}, urxvt::popup::;
		957
		958	Scalar::Util::weaken $popup->{term};
		959
		960	$self->{_destroy}{$popup} = urxvt::destroy_hook { $popup->{popup}->destroy };
		961	Scalar::Util::weaken $self->{_destroy}{$popup};
		962
		963	$popup
		964	}
		965
661	=item $cellwidth = $term->strwidth $string	966	=item $cellwidth = $term->strwidth ($string)
662		967
663	Returns the number of screen-cells this string would need. Correctly	968	Returns the number of screen-cells this string would need. Correctly
664	accounts for wide and combining characters.	969	accounts for wide and combining characters.
665		970
666	=item $octets = $term->locale_encode $string	971	=item $octets = $term->locale_encode ($string)
667		972
668	Convert the given text string into the corresponding locale encoding.	973	Convert the given text string into the corresponding locale encoding.
669		974
670	=item $string = $term->locale_decode $octets	975	=item $string = $term->locale_decode ($octets)
671		976
672	Convert the given locale-encoded octets into a perl string.	977	Convert the given locale-encoded octets into a perl string.
		978
		979	=item $term->scr_xor_span ($beg_row, $beg_col, $end_row, $end_col[, $rstyle])
		980
		981	XORs the rendition values in the given span with the provided value
		982	(default: C<RS_RVid>). Useful in refresh hooks to provide effects similar
		983	to the selection.
		984
		985	=item $term->scr_xor_rect ($beg_row, $beg_col, $end_row, $end_col[, $rstyle1[, $rstyle2]])
		986
		987	Similar to C<scr_xor_span>, but xors a rectangle instead. Trailing
		988	whitespace will additionally be xored with the C<$rstyle2>, which defaults
		989	to C<RS_RVid \| RS_Uline>, which removes reverse video again and underlines
		990	it instead.
		991
		992	=item $term->scr_bell
		993
		994	Ring the bell!
673		995
674	=item $term->scr_add_lines ($string)	996	=item $term->scr_add_lines ($string)
675		997
676	Write the given text string to the screen, as if output by the application	998	Write the given text string to the screen, as if output by the application
677	running inside the terminal. It may not contain command sequences (escape	999	running inside the terminal. It may not contain command sequences (escape
…		…
692		1014
693	Write the octets given in C<$data> to the tty (i.e. as program input). To	1015	Write the octets given in C<$data> to the tty (i.e. as program input). To
694	pass characters instead of octets, you should convert your strings first	1016	pass characters instead of octets, you should convert your strings first
695	to the locale-specific encoding using C<< $term->locale_encode >>.	1017	to the locale-specific encoding using C<< $term->locale_encode >>.
696		1018
		1019	=item $old_events = $term->pty_ev_events ([$new_events])
		1020
		1021	Replaces the event mask of the pty watcher by the given event mask. Can
		1022	be used to suppress input and output handling to the pty/tty. See the
		1023	description of C<< urxvt::timer->events >>. Make sure to always restore
		1024	the previous value.
		1025
		1026	=item $windowid = $term->parent
		1027
		1028	Return the window id of the toplevel window.
		1029
		1030	=item $windowid = $term->vt
		1031
		1032	Return the window id of the terminal window.
		1033
697	=item $window_width = $term->width	1034	=item $window_width = $term->width
698		1035
699	=item $window_height = $term->height	1036	=item $window_height = $term->height
700		1037
701	=item $font_width = $term->fwidth	1038	=item $font_width = $term->fwidth
…		…
717	=item $nrow_plus_saveLines = $term->total_rows	1054	=item $nrow_plus_saveLines = $term->total_rows
718		1055
719	=item $lines_in_scrollback = $term->nsaved	1056	=item $lines_in_scrollback = $term->nsaved
720		1057
721	Return various integers describing terminal characteristics.	1058	Return various integers describing terminal characteristics.
		1059
		1060	=item $lc_ctype = $term->locale
		1061
		1062	Returns the LC_CTYPE category string used by this rxvt-unicode.
		1063
		1064	=item $x_display = $term->display_id
		1065
		1066	Return the DISPLAY used by rxvt-unicode.
		1067
		1068	=item $modifiermask = $term->ModLevel3Mask
		1069
		1070	=item $modifiermask = $term->ModMetaMask
		1071
		1072	=item $modifiermask = $term->ModNumLockMask
		1073
		1074	Return the modifier masks corresponding to the "ISO Level 3 Shift" (often
		1075	AltGr), the meta key (often Alt) and the num lock key, if applicable.
722		1076
723	=item $view_start = $term->view_start ([$newvalue])	1077	=item $view_start = $term->view_start ([$newvalue])
724		1078
725	Returns the negative row number of the topmost line. Minimum value is	1079	Returns the negative row number of the topmost line. Minimum value is
726	C<0>, which displays the normal terminal contents. Larger values scroll	1080	C<0>, which displays the normal terminal contents. Larger values scroll
…		…
820		1174
821	=back	1175	=back
822		1176
823	=cut	1177	=cut
824		1178
825	sub urxvt::term::line {	1179	sub line {
826	my ($self, $row) = @_;	1180	my ($self, $row) = @_;
827		1181
828	my $maxrow = $self->nrow - 1;	1182	my $maxrow = $self->nrow - 1;
829		1183
830	my ($beg, $end) = ($row, $row);	1184	my ($beg, $end) = ($row, $row);
…		…
894	$offset / $self->{ncol} + $self->{beg},	1248	$offset / $self->{ncol} + $self->{beg},
895	$offset % $self->{ncol}	1249	$offset % $self->{ncol}
896	)	1250	)
897	}	1251	}
898		1252
899	=item ($row, $col) = $line->coord_of ($offset)
900	=item $text = $term->special_encode $string	1253	=item $text = $term->special_encode $string
901		1254
902	Converts a perl string into the special encoding used by rxvt-unicode,	1255	Converts a perl string into the special encoding used by rxvt-unicode,
903	where one character corresponds to one screen cell. See	1256	where one character corresponds to one screen cell. See
904	C<< $term->ROW_t >> for details.	1257	C<< $term->ROW_t >> for details.
…		…
906	=item $string = $term->special_decode $text	1259	=item $string = $term->special_decode $text
907		1260
908	Converts rxvt-unicodes text reprsentation into a perl string. See	1261	Converts rxvt-unicodes text reprsentation into a perl string. See
909	C<< $term->ROW_t >> for details.	1262	C<< $term->ROW_t >> for details.
910		1263
		1264	=item $success = $term->grab_button ($button, $modifiermask)
		1265
		1266	Registers a synchronous button grab. See the XGrabButton manpage.
		1267
		1268	=item $success = $term->grab ($eventtime[, $sync])
		1269
		1270	Calls XGrabPointer and XGrabKeyboard in asynchronous (default) or
		1271	synchronous (C<$sync> is true). Also remembers the grab timestampe.
		1272
		1273	=item $term->allow_events_async
		1274
		1275	Calls XAllowEvents with AsyncBoth for the most recent grab.
		1276
		1277	=item $term->allow_events_sync
		1278
		1279	Calls XAllowEvents with SyncBoth for the most recent grab.
		1280
		1281	=item $term->allow_events_replay
		1282
		1283	Calls XAllowEvents with both ReplayPointer and ReplayKeyboard for the most
		1284	recent grab.
		1285
		1286	=item $term->ungrab
		1287
		1288	Calls XUngrab for the most recent grab. Is called automatically on
		1289	evaluation errors, as it is better to lose the grab in the error case as
		1290	the session.
		1291
911	=back	1292	=back
		1293
		1294	=cut
		1295
		1296	package urxvt::popup;
		1297
		1298	=head2 The C<urxvt::popup> Class
		1299
		1300	=over 4
		1301
		1302	=cut
		1303
		1304	sub add_item {
		1305	my ($self, $item) = @_;
		1306
		1307	$item->{rend}{normal} = "\x1b[0;30;47m" unless exists $item->{rend}{normal};
		1308	$item->{rend}{hover} = "\x1b[0;30;46m" unless exists $item->{rend}{hover};
		1309	$item->{rend}{active} = "\x1b[m" unless exists $item->{rend}{active};
		1310
		1311	$item->{render} \|\|= sub { $_[0]{text} };
		1312
		1313	push @{ $self->{item} }, $item;
		1314	}
		1315
		1316	sub add_separator {
		1317	my ($self, $sep) = @_;
		1318
		1319	$sep \|\|= "=";
		1320
		1321	$self->add_item ({
		1322	rend => { normal => "\x1b[0;30;47m", hover => "\x1b[0;30;47m", active => "\x1b[0;30;47m" },
		1323	text => "",
		1324	render => sub { $sep x $self->{term}->ncol },
		1325	activate => sub { },
		1326	});
		1327	}
		1328
		1329	sub add_title {
		1330	my ($self, $title) = @_;
		1331
		1332	$self->add_item ({
		1333	rend => { normal => "\x1b[38;5;11;44m", hover => "\x1b[38;5;11;44m", active => "\x1b[38;5;11;44m" },
		1334	text => $title,
		1335	activate => sub { },
		1336	});
		1337	}
		1338
		1339	sub add_button {
		1340	my ($self, $text, $cb) = @_;
		1341
		1342	$self->add_item ({ type => "button", text => $text, activate => $cb});
		1343	}
		1344
		1345	sub add_toggle {
		1346	my ($self, $text, $cb, $value) = @_;
		1347
		1348	my $item; $item = {
		1349	type => "button",
		1350	text => " $text",
		1351	value => $value,
		1352	render => sub { ($_[0]{value} ? "* " : " ") . $text },
		1353	activate => sub { $cb->($_[0]{value} = !$_[0]{value}); },
		1354	};
		1355
		1356	$self->add_item ($item);
		1357	}
		1358
		1359	sub show {
		1360	my ($self) = @_;
		1361
		1362	local $urxvt::popup::self = $self;
		1363
		1364	local $ENV{LC_ALL} = $self->{term}->locale;
		1365
		1366	urxvt->new ("--perl-lib" => "", "--perl-ext-common" => "", "-pty-fd" => -1, "-sl" => 0, "-b" => 0,
		1367	"--transient-for" => $self->{term}->parent,
		1368	"-display" => $self->{term}->display_id,
		1369	"-pe" => "urxvt-popup")
		1370	or die "unable to create popup window\n";
		1371	}
		1372
		1373	sub DESTROY {
		1374	my ($self) = @_;
		1375
		1376	delete $self->{term}{_destroy}{$self};
		1377	$self->{term}->ungrab;
		1378	}
912		1379
913	=head2 The C<urxvt::timer> Class	1380	=head2 The C<urxvt::timer> Class
914		1381
915	This class implements timer watchers/events. Time is represented as a	1382	This class implements timer watchers/events. Time is represented as a
916	fractional number of seconds since the epoch. Example:	1383	fractional number of seconds since the epoch. Example:
…		…
969		1436
970	$term->{socket} = ...	1437	$term->{socket} = ...
971	$term->{iow} = urxvt::iow	1438	$term->{iow} = urxvt::iow
972	->new	1439	->new
973	->fd (fileno $term->{socket})	1440	->fd (fileno $term->{socket})
974	->events (1) # wait for read data	1441	->events (urxvt::EVENT_READ)
975	->start	1442	->start
976	->cb (sub {	1443	->cb (sub {
977	my ($iow, $revents) = @_;	1444	my ($iow, $revents) = @_;
978	# $revents must be 1 here, no need to check	1445	# $revents must be 1 here, no need to check
979	sysread $term->{socket}, my $buf, 8192	1446	sysread $term->{socket}, my $buf, 8192
…		…
996		1463
997	Set the filedescriptor (not handle) to watch.	1464	Set the filedescriptor (not handle) to watch.
998		1465
999	=item $iow = $iow->events ($eventmask)	1466	=item $iow = $iow->events ($eventmask)
1000		1467
1001	Set the event mask to watch. Bit #0 (value C<1>) enables watching for read	1468	Set the event mask to watch. The only allowed values are
1002	data, Bit #1 (value C<2>) enables watching for write data.	1469	C<urxvt::EVENT_READ> and C<urxvt::EVENT_WRITE>, which might be ORed
		1470	together, or C<urxvt::EVENT_NONE>.
1003		1471
1004	=item $iow = $iow->start	1472	=item $iow = $iow->start
1005		1473
1006	Start watching for requested events on the given handle.	1474	Start watching for requested events on the given handle.
1007		1475
…		…
1018	This variable controls the verbosity level of the perl extension. Higher	1486	This variable controls the verbosity level of the perl extension. Higher
1019	numbers indicate more verbose output.	1487	numbers indicate more verbose output.
1020		1488
1021	=over 4	1489	=over 4
1022		1490
1023	=item =0 - only fatal messages	1491	=item == 0 - fatal messages
1024		1492
1025	=item =3 - script loading and management	1493	=item >= 3 - script loading and management
1026		1494
1027	=item =10 - all events received	1495	=item >=10 - all events received
1028		1496
1029	=back	1497	=back
1030		1498
1031	=head1 AUTHOR	1499	=head1 AUTHOR
1032		1500

Diff Legend

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

Comparing rxvt-unicode/src/urxvt.pm (file contents): Revision 1.37 by root, Fri Jan 6 03:40:19 2006 UTC vs. Revision 1.75 by root, Tue Jan 10 05:00:13 2006 UTC

Diff Legend

Comparing rxvt-unicode/src/urxvt.pm (file contents):
Revision 1.37 by root, Fri Jan 6 03:40:19 2006 UTC vs.
Revision 1.75 by root, Tue Jan 10 05:00:13 2006 UTC