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

Comparing rxvt-unicode/src/urxvt.pm (file contents):
Revision 1.44 by root, Sat Jan 7 19:29:17 2006 UTC vs.
Revision 1.76 by root, Tue Jan 10 19:46:28 2006 UTC

…		…
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
55	Rot-13 the selection when activated. Used via keyboard trigger:	55	Rot-13 the selection when activated. Used via keyboard trigger:
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
		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.
60		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
…		…
77	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
78	window. Illustrates overwriting the refresh callbacks to create your own	100	window. Illustrates overwriting the refresh callbacks to create your own
79	overlays or changes.	101	overlays or changes.
80		102
81	=back	103	=back
		104
		105	=head1 API DOCUMENTATION
82		106
83	=head2 General API Considerations	107	=head2 General API Considerations
84		108
85	All objects (such as terminals, time watchers etc.) are typical	109	All objects (such as terminals, time watchers etc.) are typical
86	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
…		…
114	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
115	locale-specific way.	139	locale-specific way.
116		140
117	=back	141	=back
118		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
119	=head2 Hooks	176	=head2 Hooks
120		177
121	The following subroutines can be declared in extension files, and will be	178	The following subroutines can be declared in extension files, and will be
122	called whenever the relevant event happens.	179	called whenever the relevant event happens.
123		180
124	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
125	and extension package. You can call all C<urxvt::term> methods on it, but	182	the in the C<Extension Objects> section.
126	its not a real C<urxvt::term> object. Instead, the real C<urxvt::term>
127	object that is shared between all packages is stored in the C<term>
128	member. It is, however, blessed intot he package of the extension script,
129	so for all practical purposes you can treat an extension script as a class.
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, $octets	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
		329
		330	=item on_map_notify $term, $event
		331
		332	=item on_unmap_notify $term, $event
275		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
279	The event is a hash with most values as named by Xlib (see the XEvent	337	The event is a hash with most values as named by Xlib (see the XEvent
…		…
289		347
290	=head2 Variables in the C<urxvt> Package	348	=head2 Variables in the C<urxvt> Package
291		349
292	=over 4	350	=over 4
293		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
294	=item $urxvt::TERM	365	=item $urxvt::TERM
295		366
296	The current terminal. This variable stores the current C<urxvt::term>	367	The current terminal. This variable stores the current C<urxvt::term>
297	object, whenever a callback/hook is executing.	368	object, whenever a callback/hook is executing.
		369
		370	=item
298		371
299	=back	372	=back
300		373
301	=head2 Functions in the C<urxvt> Package	374	=head2 Functions in the C<urxvt> Package
302		375
…		…
323	that calls this function.	396	that calls this function.
324		397
325	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
326	correct place, e.g. on stderr of the connecting urxvtc client.	399	correct place, e.g. on stderr of the connecting urxvtc client.
327		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
328	=item $time = urxvt::NOW	407	=item $time = urxvt::NOW
329		408
330	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.
331		418
332	=back	419	=back
333		420
334	=head2 RENDITION	421	=head2 RENDITION
335		422
…		…
362		449
363	=item $background = urxvt::GET_BASEBG $rend	450	=item $background = urxvt::GET_BASEBG $rend
364		451
365	Return the foreground/background colour index, respectively.	452	Return the foreground/background colour index, respectively.
366		453
367	=item $rend = urxvt::SET_FGCOLOR ($rend, $new_colour)	454	=item $rend = urxvt::SET_FGCOLOR $rend, $new_colour
368		455
369	=item $rend = urxvt::SET_BGCOLOR ($rend, $new_colour)	456	=item $rend = urxvt::SET_BGCOLOR $rend, $new_colour
370		457
371	Replace the foreground/background colour in the rendition mask with the	458	Replace the foreground/background colour in the rendition mask with the
372	specified one.	459	specified one.
373		460
374	=item $value = urxvt::GET_CUSTOM ($rend)	461	=item $value = urxvt::GET_CUSTOM $rend
375		462
376	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
377	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
378	zero.	465	zero.
379		466
380	=item $rend = urxvt::SET_CUSTOM ($rend, $new_value)	467	=item $rend = urxvt::SET_CUSTOM $rend, $new_value
381		468
382	Change the custom value.	469	Change the custom value.
383		470
384	=back	471	=back
385		472
386	=cut	473	=cut
387		474
388	package urxvt;	475	package urxvt;
389		476
		477	use utf8;
390	use strict;	478	use strict;
		479	use Carp ();
391	use Scalar::Util ();	480	use Scalar::Util ();
		481	use List::Util ();
392		482
		483	our $VERSION = 1;
393	our $TERM;	484	our $TERM;
394	our @HOOKNAME;	485	our @HOOKNAME;
		486	our %HOOKTYPE = map +($HOOKNAME[$_] => $_), 0..$#HOOKNAME;
		487	our %OPTION;
		488
395	our $LIBDIR;	489	our $LIBDIR;
		490	our $RESNAME;
		491	our $RESCLASS;
		492	our $RXVTNAME;
396		493
397	BEGIN {	494	BEGIN {
398	urxvt->bootstrap;	495	urxvt->bootstrap;
399		496
400	# overwrite perl's warn	497	# overwrite perl's warn
…		…
402	my $msg = join "", @_;	499	my $msg = join "", @_;
403	$msg .= "\n"	500	$msg .= "\n"
404	unless $msg =~ /\n$/;	501	unless $msg =~ /\n$/;
405	urxvt::warn ($msg);	502	urxvt::warn ($msg);
406	};	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";
407	}	509	}
408		510
409	my @hook_count;	511	my @hook_count;
410	my $verbosity = $ENV{URXVT_PERL_VERBOSITY};	512	my $verbosity = $ENV{URXVT_PERL_VERBOSITY};
411		513
412	sub verbose {	514	sub verbose {
413	my ($level, $msg) = @_;	515	my ($level, $msg) = @_;
414	warn "$msg\n" if $level <= $verbosity;	516	warn "$msg\n" if $level <= $verbosity;
415	}	517	}
416		518
417	# find on_xxx subs in the package and register them
418	# as hooks
419	sub register_package($) {
420	my ($pkg) = @_;
421
422	for my $htype (0.. $#HOOKNAME) {
423	my $name = $HOOKNAME[$htype];
424
425	my $ref = $pkg->can ("on_" . lc $name)
426	or next;
427
428	$TERM->{_hook}[$htype]{$pkg} = $ref;
429	$hook_count[$htype]++
430	or set_should_invoke $htype, 1;
431	}
432	}
433
434	my $extension_pkg = "extension0000";	519	my $extension_pkg = "extension0000";
435	my %extension_pkg;	520	my %extension_pkg;
436		521
437	# load a single script into its own package, once only	522	# load a single script into its own package, once only
438	sub extension_package($) {	523	sub extension_package($) {
…		…
444	verbose 3, "loading extension '$path' into package '$pkg'";	529	verbose 3, "loading extension '$path' into package '$pkg'";
445		530
446	open my $fh, "<:raw", $path	531	open my $fh, "<:raw", $path
447	or die "$path: $!";	532	or die "$path: $!";
448		533
		534	my $source = untaint
449	my $source = "package $pkg; use strict; use utf8;\n"	535	"package $pkg; use strict; use utf8;\n"
450	. "use base urxvt::term::proxy::;\n"	536	. "use base urxvt::term::extension::;\n"
451	. "#line 1 \"$path\"\n{\n"	537	. "#line 1 \"$path\"\n{\n"
452	. (do { local $/; <$fh> })	538	. (do { local $/; <$fh> })
453	. "\n};\n1";	539	. "\n};\n1";
454		540
		541	eval $source
455	eval $source or die "$path: $@";	542	or die "$path: $@";
456		543
457	$pkg	544	$pkg
458	}	545	}
459	}	546	}
460		547
…		…
465	local $TERM = shift;	552	local $TERM = shift;
466	my $htype = shift;	553	my $htype = shift;
467		554
468	if ($htype == 0) { # INIT	555	if ($htype == 0) { # INIT
469	my @dirs = ((split /:/, $TERM->resource ("perl_lib")), "$LIBDIR/perl");	556	my @dirs = ((split /:/, $TERM->resource ("perl_lib")), "$LIBDIR/perl");
		557
		558	my %ext_arg;
470		559
471	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) {
472	my @files = grep -f $_, map "$_/$ext", @dirs;	573	my @files = grep -f $_, map "$_/$ext", @dirs;
473		574
474	if (@files) {	575	if (@files) {
475	register_package extension_package $files[0];	576	$TERM->register_package (extension_package $files[0], $argv);
476	} else {	577	} else {
477	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";
478	}	579	}
479	}	580	}
		581
		582	eval "#line 1 \"--perl-eval resource/argument\"\n" . $TERM->resource ("perl_eval");
		583	warn $@ if $@;
480	}	584	}
481		585
482	$retval = undef;	586	$retval = undef;
483		587
484	if (my $cb = $TERM->{_hook}[$htype]) {	588	if (my $cb = $TERM->{_hook}[$htype]) {
…		…
486	if $verbosity >= 10;	590	if $verbosity >= 10;
487		591
488	keys %$cb;	592	keys %$cb;
489		593
490	while (my ($pkg, $cb) = each %$cb) {	594	while (my ($pkg, $cb) = each %$cb) {
491	eval {	595	$retval = eval { $cb->($TERM->{_pkg}{$pkg}, @_) }
492	$retval = $cb->(
493	$TERM->{_pkg}{$pkg} \|\|= do {
494	my $proxy = bless { }, $pkg;
495	Scalar::Util::weaken ($proxy->{term} = $TERM);
496	$proxy
497	},
498	@_,
499	) and last;	596	and last;
		597
		598	if ($@) {
		599	$TERM->ungrab; # better to lose the grab than the session
		600	warn $@;
500	};	601	}
501	warn $@ if $@;#d#
502	}	602	}
503	}	603	}
504		604
505	if ($htype == 1) { # DESTROY	605	if ($htype == 1) { # DESTROY
506	# remove hooks if unused
507	if (my $hook = $TERM->{_hook}) {	606	if (my $hook = delete $TERM->{_hook}) {
508	for my $htype (0..$#$hook) {	607	for my $htype (0..$#$hook) {
509	$hook_count[$htype] -= scalar keys %{ $hook->[$htype] \|\| {} }	608	$hook_count[$htype] -= scalar keys %{ $hook->[$htype] \|\| {} }
510	or set_should_invoke $htype, 0;	609	or set_should_invoke $htype, 0;
511	}	610	}
512	}	611	}
…		…
519	}	618	}
520		619
521	$retval	620	$retval
522	}	621	}
523		622
524	sub urxvt::term::proxy::AUTOLOAD {	623	# urxvt::term::extension
525	$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 =~ /:([^:]+)$/
526	or die "FATAL: \$AUTOLOAD '$urxvt::term::proxy::AUTOLOAD' unparsable";	665	or die "FATAL: \$AUTOLOAD '$AUTOLOAD' unparsable";
527		666
528	eval qq{	667	eval qq{
529	sub $urxvt::term::proxy::AUTOLOAD {	668	sub $AUTOLOAD {
530	my \$proxy = shift;	669	my \$proxy = shift;
531	\$proxy->{term}->$1 (\@_)	670	\$proxy->{term}->$1 (\@_)
532	}	671	}
533	1	672	1
534	} or die "FATAL: unable to compile method forwarder: $@";	673	} or die "FATAL: unable to compile method forwarder: $@";
535		674
536	goto &$urxvt::term::proxy::AUTOLOAD;	675	goto &$AUTOLOAD;
537	}	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;
538		761
539	=head2 The C<urxvt::term> Class	762	=head2 The C<urxvt::term> Class
540		763
541	=over 4	764	=over 4
542		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
543	=item $term->destroy	788	=item $term->destroy
544		789
545	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
546		809
547	=item $value = $term->resource ($name[, $newval])	810	=item $value = $term->resource ($name[, $newval])
548		811
549	Returns the current resource value associated with a given name and	812	Returns the current resource value associated with a given name and
550	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>
…		…
560		823
561	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
562	terminal is destroyed, so changing options frequently will eat memory.	825	terminal is destroyed, so changing options frequently will eat memory.
563		826
564	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
565	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>
566	list:	829	to see the actual list:
567		830
568	answerbackstring backgroundPixmap backspace_key boldFont boldItalicFont	831	answerbackstring backgroundPixmap backspace_key boldFont boldItalicFont
569	borderLess color cursorBlink cursorUnderline cutchars delete_key	832	borderLess color cursorBlink cursorUnderline cutchars delete_key
570	display_name embed ext_bwidth fade font geometry hold iconName	833	display_name embed ext_bwidth fade font geometry hold iconName
571	imFont imLocale inputMethod insecure int_bwidth intensityStyles	834	imFont imLocale inputMethod insecure int_bwidth intensityStyles
…		…
578	shade term_name title transparent transparent_all tripleclickwords	841	shade term_name title transparent transparent_all tripleclickwords
579	utmpInhibit visualBell	842	utmpInhibit visualBell
580		843
581	=cut	844	=cut
582		845
583	sub urxvt::term::resource($$;$) {	846	sub resource($$;$) {
584	my ($self, $name) = (shift, shift);	847	my ($self, $name) = (shift, shift);
585	unshift @_, $self, $name, ($name =~ s/\s\+\s(\d+)$// ? $1 : 0);	848	unshift @_, $self, $name, ($name =~ s/\s\+\s(\d+)$// ? $1 : 0);
586	goto &urxvt::term::_resource;	849	&urxvt::term::_resource
587	}	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.
588		856
589	=item $rend = $term->rstyle ([$new_rstyle])	857	=item $rend = $term->rstyle ([$new_rstyle])
590		858
591	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
592	the terminal application will use this style.	860	the terminal application will use this style.
…		…
612		880
613	=item $oldtext = $term->selection ([$newtext])	881	=item $oldtext = $term->selection ([$newtext])
614		882
615	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>.
616		884
617	#=item $term->overlay ($x, $y, $text)	885	=item $term->overlay_simple ($x, $y, $text)
618	#	886
619	#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.
620	#	888
621	#=cut	889	=cut
622	#	890
623	#sub urxvt::term::scr_overlay {	891	sub overlay_simple {
624	# my ($self, $x, $y, $text) = @_;	892	my ($self, $x, $y, $text) = @_;
625	#	893
626	# my @lines = split /\n/, $text;	894	my @lines = split /\n/, $text;
627	#	895
628	# my $w = 0;	896	my $w = List::Util::max map $self->strwidth ($_), @lines;
629	# for (map $self->strwidth ($_), @lines) {	897
630	# $w = $_ if $w < $_;
631	# }
632	#
633	# $self->scr_overlay_new ($x, $y, $w, scalar @lines);	898	my $overlay = $self->overlay ($x, $y, $w, scalar @lines);
634	# $self->scr_overlay_set (0, $_, $lines[$_]) for 0.. $#lines;	899	$overlay->set (0, $_, $lines[$_]) for 0.. $#lines;
635	#}	900
		901	$overlay
		902	}
636		903
637	=item $term->overlay ($x, $y, $width, $height[, $rstyle[, $border]])	904	=item $term->overlay ($x, $y, $width, $height[, $rstyle[, $border]])
638		905
639	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
640	width/height. C<$rstyle> defines the initial rendition style	907	width/height. C<$rstyle> defines the initial rendition style
…		…
667		934
668	If hidden, display the overlay again.	935	If hidden, display the overlay again.
669		936
670	=back	937	=back
671		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
672	=item $cellwidth = $term->strwidth ($string)	966	=item $cellwidth = $term->strwidth ($string)
673		967
674	Returns the number of screen-cells this string would need. Correctly	968	Returns the number of screen-cells this string would need. Correctly
675	accounts for wide and combining characters.	969	accounts for wide and combining characters.
676		970
…		…
679	Convert the given text string into the corresponding locale encoding.	973	Convert the given text string into the corresponding locale encoding.
680		974
681	=item $string = $term->locale_decode ($octets)	975	=item $string = $term->locale_decode ($octets)
682		976
683	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!
684		995
685	=item $term->scr_add_lines ($string)	996	=item $term->scr_add_lines ($string)
686		997
687	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
688	running inside the terminal. It may not contain command sequences (escape	999	running inside the terminal. It may not contain command sequences (escape
…		…
703		1014
704	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
705	pass characters instead of octets, you should convert your strings first	1016	pass characters instead of octets, you should convert your strings first
706	to the locale-specific encoding using C<< $term->locale_encode >>.	1017	to the locale-specific encoding using C<< $term->locale_encode >>.
707		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
708	=item $windowid = $term->parent	1026	=item $windowid = $term->parent
709		1027
710	Return the window id of the toplevel window.	1028	Return the window id of the toplevel window.
711		1029
712	=item $windowid = $term->vt	1030	=item $windowid = $term->vt
…		…
736	=item $nrow_plus_saveLines = $term->total_rows	1054	=item $nrow_plus_saveLines = $term->total_rows
737		1055
738	=item $lines_in_scrollback = $term->nsaved	1056	=item $lines_in_scrollback = $term->nsaved
739		1057
740	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.
741		1076
742	=item $view_start = $term->view_start ([$newvalue])	1077	=item $view_start = $term->view_start ([$newvalue])
743		1078
744	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
745	C<0>, which displays the normal terminal contents. Larger values scroll	1080	C<0>, which displays the normal terminal contents. Larger values scroll
…		…
839		1174
840	=back	1175	=back
841		1176
842	=cut	1177	=cut
843		1178
844	sub urxvt::term::line {	1179	sub line {
845	my ($self, $row) = @_;	1180	my ($self, $row) = @_;
846		1181
847	my $maxrow = $self->nrow - 1;	1182	my $maxrow = $self->nrow - 1;
848		1183
849	my ($beg, $end) = ($row, $row);	1184	my ($beg, $end) = ($row, $row);
…		…
913	$offset / $self->{ncol} + $self->{beg},	1248	$offset / $self->{ncol} + $self->{beg},
914	$offset % $self->{ncol}	1249	$offset % $self->{ncol}
915	)	1250	)
916	}	1251	}
917		1252
918	=item ($row, $col) = $line->coord_of ($offset)
919	=item $text = $term->special_encode $string	1253	=item $text = $term->special_encode $string
920		1254
921	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,
922	where one character corresponds to one screen cell. See	1256	where one character corresponds to one screen cell. See
923	C<< $term->ROW_t >> for details.	1257	C<< $term->ROW_t >> for details.
…		…
925	=item $string = $term->special_decode $text	1259	=item $string = $term->special_decode $text
926		1260
927	Converts rxvt-unicodes text reprsentation into a perl string. See	1261	Converts rxvt-unicodes text reprsentation into a perl string. See
928	C<< $term->ROW_t >> for details.	1262	C<< $term->ROW_t >> for details.
929		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
930	=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	=item $popup->add_title ($title)
		1317
		1318	Adds a non-clickable title to the popup.
		1319
		1320	=cut
		1321
		1322	sub add_title {
		1323	my ($self, $title) = @_;
		1324
		1325	$self->add_item ({
		1326	rend => { normal => "\x1b[38;5;11;44m", hover => "\x1b[38;5;11;44m", active => "\x1b[38;5;11;44m" },
		1327	text => $title,
		1328	activate => sub { },
		1329	});
		1330	}
		1331
		1332	=item $popup->add_separator ([$sepchr])
		1333
		1334	Creates a separator, optionally using the character given as C<$sepchr>.
		1335
		1336	=cut
		1337
		1338	sub add_separator {
		1339	my ($self, $sep) = @_;
		1340
		1341	$sep \|\|= "=";
		1342
		1343	$self->add_item ({
		1344	rend => { normal => "\x1b[0;30;47m", hover => "\x1b[0;30;47m", active => "\x1b[0;30;47m" },
		1345	text => "",
		1346	render => sub { $sep x $self->{term}->ncol },
		1347	activate => sub { },
		1348	});
		1349	}
		1350
		1351	=item $popup->add_button ($text, $cb)
		1352
		1353	Adds a clickable button to the popup. C<$cb> is called whenever it is
		1354	selected.
		1355
		1356	=cut
		1357
		1358	sub add_button {
		1359	my ($self, $text, $cb) = @_;
		1360
		1361	$self->add_item ({ type => "button", text => $text, activate => $cb});
		1362	}
		1363
		1364	=item $popup->add_toggle ($text, $cb, $initial_value)
		1365
		1366	Adds a toggle/checkbox item to the popup. Teh callback gets called
		1367	whenever it gets toggled, with a boolean indicating its value as its first
		1368	argument.
		1369
		1370	=cut
		1371
		1372	sub add_toggle {
		1373	my ($self, $text, $cb, $value) = @_;
		1374
		1375	my $item; $item = {
		1376	type => "button",
		1377	text => " $text",
		1378	value => $value,
		1379	render => sub { ($_[0]{value} ? "* " : " ") . $text },
		1380	activate => sub { $cb->($_[1]{value} = !$_[1]{value}); },
		1381	};
		1382
		1383	$self->add_item ($item);
		1384	}
		1385
		1386	=item $popup->show
		1387
		1388	Displays the popup (which is initially hidden).
		1389
		1390	=cut
		1391
		1392	sub show {
		1393	my ($self) = @_;
		1394
		1395	local $urxvt::popup::self = $self;
		1396
		1397	local $ENV{LC_ALL} = $self->{term}->locale;
		1398
		1399	urxvt->new ("--perl-lib" => "", "--perl-ext-common" => "", "-pty-fd" => -1, "-sl" => 0, "-b" => 0,
		1400	"--transient-for" => $self->{term}->parent,
		1401	"-display" => $self->{term}->display_id,
		1402	"-pe" => "urxvt-popup")
		1403	or die "unable to create popup window\n";
		1404	}
		1405
		1406	sub DESTROY {
		1407	my ($self) = @_;
		1408
		1409	delete $self->{term}{_destroy}{$self};
		1410	$self->{term}->ungrab;
		1411	}
931		1412
932	=head2 The C<urxvt::timer> Class	1413	=head2 The C<urxvt::timer> Class
933		1414
934	This class implements timer watchers/events. Time is represented as a	1415	This class implements timer watchers/events. Time is represented as a
935	fractional number of seconds since the epoch. Example:	1416	fractional number of seconds since the epoch. Example:
…		…
988		1469
989	$term->{socket} = ...	1470	$term->{socket} = ...
990	$term->{iow} = urxvt::iow	1471	$term->{iow} = urxvt::iow
991	->new	1472	->new
992	->fd (fileno $term->{socket})	1473	->fd (fileno $term->{socket})
993	->events (1) # wait for read data	1474	->events (urxvt::EVENT_READ)
994	->start	1475	->start
995	->cb (sub {	1476	->cb (sub {
996	my ($iow, $revents) = @_;	1477	my ($iow, $revents) = @_;
997	# $revents must be 1 here, no need to check	1478	# $revents must be 1 here, no need to check
998	sysread $term->{socket}, my $buf, 8192	1479	sysread $term->{socket}, my $buf, 8192
…		…
1015		1496
1016	Set the filedescriptor (not handle) to watch.	1497	Set the filedescriptor (not handle) to watch.
1017		1498
1018	=item $iow = $iow->events ($eventmask)	1499	=item $iow = $iow->events ($eventmask)
1019		1500
1020	Set the event mask to watch. Bit #0 (value C<1>) enables watching for read	1501	Set the event mask to watch. The only allowed values are
1021	data, Bit #1 (value C<2>) enables watching for write data.	1502	C<urxvt::EVENT_READ> and C<urxvt::EVENT_WRITE>, which might be ORed
		1503	together, or C<urxvt::EVENT_NONE>.
1022		1504
1023	=item $iow = $iow->start	1505	=item $iow = $iow->start
1024		1506
1025	Start watching for requested events on the given handle.	1507	Start watching for requested events on the given handle.
1026		1508
…		…
1037	This variable controls the verbosity level of the perl extension. Higher	1519	This variable controls the verbosity level of the perl extension. Higher
1038	numbers indicate more verbose output.	1520	numbers indicate more verbose output.
1039		1521
1040	=over 4	1522	=over 4
1041		1523
1042	=item =0 - only fatal messages	1524	=item == 0 - fatal messages
1043		1525
1044	=item =3 - script loading and management	1526	=item >= 3 - script loading and management
1045		1527
1046	=item =10 - all events received	1528	=item >=10 - all events received
1047		1529
1048	=back	1530	=back
1049		1531
1050	=head1 AUTHOR	1532	=head1 AUTHOR
1051		1533

Diff Legend

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

Comparing rxvt-unicode/src/urxvt.pm (file contents): Revision 1.44 by root, Sat Jan 7 19:29:17 2006 UTC vs. Revision 1.76 by root, Tue Jan 10 19:46:28 2006 UTC

Diff Legend

Comparing rxvt-unicode/src/urxvt.pm (file contents):
Revision 1.44 by root, Sat Jan 7 19:29:17 2006 UTC vs.
Revision 1.76 by root, Tue Jan 10 19:46:28 2006 UTC