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

Comparing rxvt-unicode/src/urxvt.pm (file contents):
Revision 1.46 by root, Sat Jan 7 20:29:28 2006 UTC vs.
Revision 1.77 by root, Wed Jan 11 00:59:58 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
…		…
194	than the scroll back buffer or the terminal.	247	than the scroll back buffer or the terminal.
195		248
196	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,
197	$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
198	number of lines that will be in the scrollback buffer.	251	number of lines that will be in the scrollback buffer.
199
200	=item on_tty_activity $term NYI
201
202	Called whenever the program(s) running in the urxvt window send output.
203		252
204	=item on_osc_seq $term, $string	253	=item on_osc_seq $term, $string
205		254
206	Called whenever the B<ESC ] 777 ; string ST> command sequence (OSC =	255	Called whenever the B<ESC ] 777 ; string ST> command sequence (OSC =
207	operating system command) is processed. Cursor position and other state	256	operating system command) is processed. Cursor position and other state
…		…
220	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
221	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
222	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
223	output.	272	output.
224		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
225	=item on_line_update $term, $row	279	=item on_line_update $term, $row
226		280
227	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
228	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
229	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	=item on_focus_out $term	315	=item on_focus_out $term
262		316
263	Called wheneever the window loses keyboard focus, before rxvt-unicode does	317	Called wheneever the window loses keyboard focus, before rxvt-unicode does
264	focus out processing.	318	focus out processing.
265		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
…		…
289		343
290	subwindow.	344	subwindow.
291		345
292	=back	346	=back
293		347
		348	=cut
		349
		350	package urxvt;
		351
		352	use utf8;
		353	use strict;
		354	use Carp ();
		355	use Scalar::Util ();
		356	use List::Util ();
		357
		358	our $VERSION = 1;
		359	our $TERM;
		360	our @HOOKNAME;
		361	our %HOOKTYPE = map +($HOOKNAME[$_] => $_), 0..$#HOOKNAME;
		362	our %OPTION;
		363
		364	our $LIBDIR;
		365	our $RESNAME;
		366	our $RESCLASS;
		367	our $RXVTNAME;
		368
294	=head2 Variables in the C<urxvt> Package	369	=head2 Variables in the C<urxvt> Package
295		370
296	=over 4	371	=over 4
		372
		373	=item $urxvt::LIBDIR
		374
		375	The rxvt-unicode library directory, where, among other things, the perl
		376	modules and scripts are stored.
		377
		378	=item $urxvt::RESCLASS, $urxvt::RESCLASS
		379
		380	The resource class and name rxvt-unicode uses to look up X resources.
		381
		382	=item $urxvt::RXVTNAME
		383
		384	The basename of the installed binaries, usually C<urxvt>.
297		385
298	=item $urxvt::TERM	386	=item $urxvt::TERM
299		387
300	The current terminal. This variable stores the current C<urxvt::term>	388	The current terminal. This variable stores the current C<urxvt::term>
301	object, whenever a callback/hook is executing.	389	object, whenever a callback/hook is executing.
302		390
		391	=item
		392
303	=back	393	=back
304		394
305	=head2 Functions in the C<urxvt> Package	395	=head2 Functions in the C<urxvt> Package
306		396
307	=over 4	397	=over 4
308
309	=item $term = new urxvt [arg...]
310
311	Creates a new terminal, very similar as if you had started it with
312	C<system $binfile, arg...>. Croaks (and probably outputs an error message)
313	if the new instance couldn't be created. Returns C<undef> if the new
314	instance didn't initialise perl, and the terminal object otherwise. The
315	C<init> and C<start> hooks will be called during the call.
316		398
317	=item urxvt::fatal $errormessage	399	=item urxvt::fatal $errormessage
318		400
319	Fatally aborts execution with the given error message. Avoid at all	401	Fatally aborts execution with the given error message. Avoid at all
320	costs! The only time this is acceptable is when the terminal process	402	costs! The only time this is acceptable is when the terminal process
…		…
327	that calls this function.	409	that calls this function.
328		410
329	Using this function has the advantage that its output ends up in the	411	Using this function has the advantage that its output ends up in the
330	correct place, e.g. on stderr of the connecting urxvtc client.	412	correct place, e.g. on stderr of the connecting urxvtc client.
331		413
		414	Messages have a size limit of 1023 bytes currently.
		415
		416	=item $is_safe = urxvt::safe
		417
		418	Returns true when it is safe to do potentially unsafe things, such as
		419	evaluating perl code specified by the user. This is true when urxvt was
		420	started setuid or setgid.
		421
332	=item $time = urxvt::NOW	422	=item $time = urxvt::NOW
333		423
334	Returns the "current time" (as per the event loop).	424	Returns the "current time" (as per the event loop).
		425
		426	=item urxvt::CurrentTime
		427
		428	=item urxvt::ShiftMask, LockMask, ControlMask, Mod1Mask, Mod2Mask,
		429	Mod3Mask, Mod4Mask, Mod5Mask, Button1Mask, Button2Mask, Button3Mask,
		430	Button4Mask, Button5Mask, AnyModifier
		431
		432	Various constants for use in X calls and event processing.
335		433
336	=back	434	=back
337		435
338	=head2 RENDITION	436	=head2 RENDITION
339		437
…		…
366		464
367	=item $background = urxvt::GET_BASEBG $rend	465	=item $background = urxvt::GET_BASEBG $rend
368		466
369	Return the foreground/background colour index, respectively.	467	Return the foreground/background colour index, respectively.
370		468
371	=item $rend = urxvt::SET_FGCOLOR ($rend, $new_colour)	469	=item $rend = urxvt::SET_FGCOLOR $rend, $new_colour
372		470
373	=item $rend = urxvt::SET_BGCOLOR ($rend, $new_colour)	471	=item $rend = urxvt::SET_BGCOLOR $rend, $new_colour
374		472
375	Replace the foreground/background colour in the rendition mask with the	473	Replace the foreground/background colour in the rendition mask with the
376	specified one.	474	specified one.
377		475
378	=item $value = urxvt::GET_CUSTOM ($rend)	476	=item $value = urxvt::GET_CUSTOM $rend
379		477
380	Return the "custom" value: Every rendition has 5 bits for use by	478	Return the "custom" value: Every rendition has 5 bits for use by
381	extensions. They can be set and changed as you like and are initially	479	extensions. They can be set and changed as you like and are initially
382	zero.	480	zero.
383		481
384	=item $rend = urxvt::SET_CUSTOM ($rend, $new_value)	482	=item $rend = urxvt::SET_CUSTOM $rend, $new_value
385		483
386	Change the custom value.	484	Change the custom value.
387		485
388	=back	486	=back
389		487
390	=cut	488	=cut
391
392	package urxvt;
393
394	use strict;
395	use Scalar::Util ();
396
397	our $TERM;
398	our @HOOKNAME;
399	our $LIBDIR;
400		489
401	BEGIN {	490	BEGIN {
402	urxvt->bootstrap;	491	urxvt->bootstrap;
403		492
404	# overwrite perl's warn	493	# overwrite perl's warn
…		…
406	my $msg = join "", @_;	495	my $msg = join "", @_;
407	$msg .= "\n"	496	$msg .= "\n"
408	unless $msg =~ /\n$/;	497	unless $msg =~ /\n$/;
409	urxvt::warn ($msg);	498	urxvt::warn ($msg);
410	};	499	};
		500
		501	delete $ENV{IFS};
		502	delete $ENV{CDPATH};
		503	delete $ENV{BASH_ENV};
		504	$ENV{PATH} = "/bin:/sbin:/usr/bin:/usr/sbin:/usr/local/bin:/usr/local/sbin:/opt/bin:/opt/sbin";
411	}	505	}
412		506
413	my @hook_count;	507	my @hook_count;
414	my $verbosity = $ENV{URXVT_PERL_VERBOSITY};	508	my $verbosity = $ENV{URXVT_PERL_VERBOSITY};
415		509
416	sub verbose {	510	sub verbose {
417	my ($level, $msg) = @_;	511	my ($level, $msg) = @_;
418	warn "$msg\n" if $level <= $verbosity;	512	warn "$msg\n" if $level <= $verbosity;
419	}	513	}
420		514
421	# find on_xxx subs in the package and register them
422	# as hooks
423	sub register_package($) {
424	my ($pkg) = @_;
425
426	for my $htype (0.. $#HOOKNAME) {
427	my $name = $HOOKNAME[$htype];
428
429	my $ref = $pkg->can ("on_" . lc $name)
430	or next;
431
432	$TERM->{_hook}[$htype]{$pkg} = $ref;
433	$hook_count[$htype]++
434	or set_should_invoke $htype, 1;
435	}
436	}
437
438	my $extension_pkg = "extension0000";	515	my $extension_pkg = "extension0000";
439	my %extension_pkg;	516	my %extension_pkg;
440		517
441	# load a single script into its own package, once only	518	# load a single script into its own package, once only
442	sub extension_package($) {	519	sub extension_package($) {
…		…
448	verbose 3, "loading extension '$path' into package '$pkg'";	525	verbose 3, "loading extension '$path' into package '$pkg'";
449		526
450	open my $fh, "<:raw", $path	527	open my $fh, "<:raw", $path
451	or die "$path: $!";	528	or die "$path: $!";
452		529
		530	my $source = untaint
453	my $source = "package $pkg; use strict; use utf8;\n"	531	"package $pkg; use strict; use utf8;\n"
454	. "use base urxvt::term::proxy::;\n"	532	. "use base urxvt::term::extension::;\n"
455	. "#line 1 \"$path\"\n{\n"	533	. "#line 1 \"$path\"\n{\n"
456	. (do { local $/; <$fh> })	534	. (do { local $/; <$fh> })
457	. "\n};\n1";	535	. "\n};\n1";
458		536
		537	eval $source
459	eval $source or die "$path: $@";	538	or die "$path: $@";
460		539
461	$pkg	540	$pkg
462	}	541	}
463	}	542	}
464		543
…		…
469	local $TERM = shift;	548	local $TERM = shift;
470	my $htype = shift;	549	my $htype = shift;
471		550
472	if ($htype == 0) { # INIT	551	if ($htype == 0) { # INIT
473	my @dirs = ((split /:/, $TERM->resource ("perl_lib")), "$LIBDIR/perl");	552	my @dirs = ((split /:/, $TERM->resource ("perl_lib")), "$LIBDIR/perl");
		553
		554	my %ext_arg;
474		555
475	for my $ext (map { split /,/, $TERM->resource ("perl_ext_$_") } 1, 2) {	556	for (map { split /,/, $TERM->resource ("perl_ext_$_") } 1, 2) {
		557	if ($_ eq "default") {
		558	$ext_arg{$_} \|\|= [] for qw(selection option-popup selection-popup searchable-scrollback);
		559	} elsif (/^-(.*)$/) {
		560	delete $ext_arg{$1};
		561	} elsif (/^([^<]+)<(.*)>$/) {
		562	push @{ $ext_arg{$1} }, $2;
		563	} else {
		564	$ext_arg{$_} \|\|= [];
		565	}
		566	}
		567
		568	while (my ($ext, $argv) = each %ext_arg) {
476	my @files = grep -f $_, map "$_/$ext", @dirs;	569	my @files = grep -f $_, map "$_/$ext", @dirs;
477		570
478	if (@files) {	571	if (@files) {
479	register_package extension_package $files[0];	572	$TERM->register_package (extension_package $files[0], $argv);
480	} else {	573	} else {
481	warn "perl extension '$ext' not found in perl library search path\n";	574	warn "perl extension '$ext' not found in perl library search path\n";
482	}	575	}
483	}	576	}
		577
		578	eval "#line 1 \"--perl-eval resource/argument\"\n" . $TERM->resource ("perl_eval");
		579	warn $@ if $@;
484	}	580	}
485		581
486	$retval = undef;	582	$retval = undef;
487		583
488	if (my $cb = $TERM->{_hook}[$htype]) {	584	if (my $cb = $TERM->{_hook}[$htype]) {
…		…
490	if $verbosity >= 10;	586	if $verbosity >= 10;
491		587
492	keys %$cb;	588	keys %$cb;
493		589
494	while (my ($pkg, $cb) = each %$cb) {	590	while (my ($pkg, $cb) = each %$cb) {
495	eval {	591	$retval = eval { $cb->($TERM->{_pkg}{$pkg}, @_) }
496	$retval = $cb->(
497	$TERM->{_pkg}{$pkg} \|\|= do {
498	my $proxy = bless { }, $pkg;
499	Scalar::Util::weaken ($proxy->{term} = $TERM);
500	$proxy
501	},
502	@_,
503	) and last;	592	and last;
		593
		594	if ($@) {
		595	$TERM->ungrab; # better to lose the grab than the session
		596	warn $@;
504	};	597	}
505	warn $@ if $@;#d#
506	}	598	}
507	}	599	}
508		600
509	if ($htype == 1) { # DESTROY	601	if ($htype == 1) { # DESTROY
510	# remove hooks if unused
511	if (my $hook = $TERM->{_hook}) {	602	if (my $hook = delete $TERM->{_hook}) {
512	for my $htype (0..$#$hook) {	603	for my $htype (0..$#$hook) {
513	$hook_count[$htype] -= scalar keys %{ $hook->[$htype] \|\| {} }	604	$hook_count[$htype] -= scalar keys %{ $hook->[$htype] \|\| {} }
514	or set_should_invoke $htype, 0;	605	or set_should_invoke $htype, 0;
515	}	606	}
516	}	607	}
…		…
523	}	614	}
524		615
525	$retval	616	$retval
526	}	617	}
527		618
528	sub urxvt::term::proxy::AUTOLOAD {	619	# urxvt::term::extension
529	$urxvt::term::proxy::AUTOLOAD =~ /:([^:]+)$/	620
		621	package urxvt::term::extension;
		622
		623	sub enable {
		624	my ($self, %hook) = @_;
		625	my $pkg = $self->{_pkg};
		626
		627	while (my ($name, $cb) = each %hook) {
		628	my $htype = $HOOKTYPE{uc $name};
		629	defined $htype
		630	or Carp::croak "unsupported hook type '$name'";
		631
		632	unless (exists $self->{term}{_hook}[$htype]{$pkg}) {
		633	$hook_count[$htype]++
		634	or urxvt::set_should_invoke $htype, 1;
		635	}
		636
		637	$self->{term}{_hook}[$htype]{$pkg} = $cb;
		638	}
		639	}
		640
		641	sub disable {
		642	my ($self, @hook) = @_;
		643	my $pkg = $self->{_pkg};
		644
		645	for my $name (@hook) {
		646	my $htype = $HOOKTYPE{uc $name};
		647	defined $htype
		648	or Carp::croak "unsupported hook type '$name'";
		649
		650	if (delete $self->{term}{_hook}[$htype]{$pkg}) {
		651	--$hook_count[$htype]
		652	or urxvt::set_should_invoke $htype, 0;
		653	}
		654	}
		655	}
		656
		657	our $AUTOLOAD;
		658
		659	sub AUTOLOAD {
		660	$AUTOLOAD =~ /:([^:]+)$/
530	or die "FATAL: \$AUTOLOAD '$urxvt::term::proxy::AUTOLOAD' unparsable";	661	or die "FATAL: \$AUTOLOAD '$AUTOLOAD' unparsable";
531		662
532	eval qq{	663	eval qq{
533	sub $urxvt::term::proxy::AUTOLOAD {	664	sub $AUTOLOAD {
534	my \$proxy = shift;	665	my \$proxy = shift;
535	\$proxy->{term}->$1 (\@_)	666	\$proxy->{term}->$1 (\@_)
536	}	667	}
537	1	668	1
538	} or die "FATAL: unable to compile method forwarder: $@";	669	} or die "FATAL: unable to compile method forwarder: $@";
539		670
540	goto &$urxvt::term::proxy::AUTOLOAD;	671	goto &$AUTOLOAD;
541	}	672	}
		673
		674	sub DESTROY {
		675	# nop
		676	}
		677
		678	# urxvt::destroy_hook
542		679
543	sub urxvt::destroy_hook::DESTROY {	680	sub urxvt::destroy_hook::DESTROY {
544	${$_[0]}->();	681	${$_[0]}->();
545	}	682	}
546		683
547	sub urxvt::destroy_hook(&) {	684	sub urxvt::destroy_hook(&) {
548	bless \shift, urxvt::destroy_hook::	685	bless \shift, urxvt::destroy_hook::
549	}	686	}
550		687
		688	package urxvt::anyevent;
		689
		690	=head2 The C<urxvt::anyevent> Class
		691
		692	The sole purpose of this class is to deliver an interface to the
		693	C<AnyEvent> module - any module using it will work inside urxvt without
		694	further programming. The only exception is that you cannot wait on
		695	condition variables, but non-blocking condvar use is ok. What this means
		696	is that you cannot use blocking APIs, but the non-blocking variant should
		697	work.
		698
		699	=cut
		700
		701	our $VERSION = 1;
		702
		703	$INC{"urxvt/anyevent.pm"} = 1; # mark us as there
		704	push @AnyEvent::REGISTRY, [urxvt => urxvt::anyevent::];
		705
		706	sub timer {
		707	my ($class, %arg) = @_;
		708
		709	my $cb = $arg{cb};
		710
		711	urxvt::timer
		712	->new
		713	->start (urxvt::NOW + $arg{after})
		714	->cb (sub {
		715	$_[0]->stop; # need to cancel manually
		716	$cb->();
		717	})
		718	}
		719
		720	sub io {
		721	my ($class, %arg) = @_;
		722
		723	my $cb = $arg{cb};
		724
		725	bless [$arg{fh}, urxvt::iow
		726	->new
		727	->fd (fileno $arg{fh})
		728	->events (($arg{poll} =~ /r/ ? 1 : 0)
		729	\| ($arg{poll} =~ /w/ ? 2 : 0))
		730	->start
		731	->cb (sub {
		732	$cb->(($_[1] & 1 ? 'r' : '')
		733	. ($_[1] & 2 ? 'w' : ''));
		734	})],
		735	urxvt::anyevent::
		736	}
		737
		738	sub DESTROY {
		739	$_[0][1]->stop;
		740	}
		741
		742	sub condvar {
		743	bless \my $flag, urxvt::anyevent::condvar::
		744	}
		745
		746	sub urxvt::anyevent::condvar::broadcast {
		747	${$_[0]}++;
		748	}
		749
		750	sub urxvt::anyevent::condvar::wait {
		751	unless (${$_[0]}) {
		752	Carp::croak "AnyEvent->condvar blocking wait unsupported in urxvt, use a non-blocking API";
		753	}
		754	}
		755
		756	package urxvt::term;
		757
551	=head2 The C<urxvt::term> Class	758	=head2 The C<urxvt::term> Class
552		759
553	=over 4	760	=over 4
554		761
		762	=cut
		763
		764	# find on_xxx subs in the package and register them
		765	# as hooks
		766	sub register_package {
		767	my ($self, $pkg, $argv) = @_;
		768
		769	my $proxy = bless {
		770	_pkg => $pkg,
		771	argv => $argv,
		772	}, $pkg;
		773	Scalar::Util::weaken ($proxy->{term} = $self);
		774
		775	$self->{_pkg}{$pkg} = $proxy;
		776
		777	for my $name (@HOOKNAME) {
		778	if (my $ref = $pkg->can ("on_" . lc $name)) {
		779	$proxy->enable ($name => $ref);
		780	}
		781	}
		782	}
		783
		784	=item $term = new urxvt::term $envhashref, $rxvtname, [arg...]
		785
		786	Creates a new terminal, very similar as if you had started it with system
		787	C<$rxvtname, arg...>. C<$envhashref> must be a reference to a %ENV>-like
		788	C<hash which defines the environment of the new terminal.
		789
		790	Croaks (and probably outputs an error message) if the new instance
		791	couldn't be created. Returns C<undef> if the new instance didn't
		792	initialise perl, and the terminal object otherwise. The C<init> and
		793	C<start> hooks will be called during this call.
		794
		795	=cut
		796
		797	sub new {
		798	my ($class, $env, @args) = @_;
		799
		800	_new ([ map "$_=$env->{$_}", keys %$env ], @args);
		801	}
		802
555	=item $term->destroy	803	=item $term->destroy
556		804
557	Destroy the terminal object (close the window, free resources etc.).	805	Destroy the terminal object (close the window, free resources
		806	etc.). Please note that @@RXVT_NAME@@ will not exit as long as any event
		807	watchers (timers, io watchers) are still active.
		808
		809	=item $isset = $term->option ($optval[, $set])
		810
		811	Returns true if the option specified by C<$optval> is enabled, and
		812	optionally change it. All option values are stored by name in the hash
		813	C<%urxvt::OPTION>. Options not enabled in this binary are not in the hash.
		814
		815	Here is a a likely non-exhaustive list of option names, please see the
		816	source file F</src/optinc.h> to see the actual list:
		817
		818	borderLess console cursorBlink cursorUnderline hold iconic insecure
		819	intensityStyles jumpScroll loginShell mapAlert meta8 mouseWheelScrollPage
		820	pastableTabs pointerBlank reverseVideo scrollBar scrollBar_floating
		821	scrollBar_right scrollTtyKeypress scrollTtyOutput scrollWithBuffer
		822	secondaryScreen secondaryScroll skipBuiltinGlyphs transparent
		823	tripleclickwords utmpInhibit visualBell
558		824
559	=item $value = $term->resource ($name[, $newval])	825	=item $value = $term->resource ($name[, $newval])
560		826
561	Returns the current resource value associated with a given name and	827	Returns the current resource value associated with a given name and
562	optionally sets a new value. Setting values is most useful in the C<init>	828	optionally sets a new value. Setting values is most useful in the C<init>
…		…
572		838
573	Please note that resource strings will currently only be freed when the	839	Please note that resource strings will currently only be freed when the
574	terminal is destroyed, so changing options frequently will eat memory.	840	terminal is destroyed, so changing options frequently will eat memory.
575		841
576	Here is a a likely non-exhaustive list of resource names, not all of which	842	Here is a a likely non-exhaustive list of resource names, not all of which
577	are supported in every build, please see the source to see the actual	843	are supported in every build, please see the source file F</src/rsinc.h>
578	list:	844	to see the actual list:
579		845
580	answerbackstring backgroundPixmap backspace_key boldFont boldItalicFont	846	answerbackstring backgroundPixmap backspace_key boldFont boldItalicFont
581	borderLess color cursorBlink cursorUnderline cutchars delete_key	847	borderLess color cursorBlink cursorUnderline cutchars delete_key
582	display_name embed ext_bwidth fade font geometry hold iconName	848	display_name embed ext_bwidth fade font geometry hold iconName
583	imFont imLocale inputMethod insecure int_bwidth intensityStyles	849	imFont imLocale inputMethod insecure int_bwidth intensityStyles
…		…
590	shade term_name title transparent transparent_all tripleclickwords	856	shade term_name title transparent transparent_all tripleclickwords
591	utmpInhibit visualBell	857	utmpInhibit visualBell
592		858
593	=cut	859	=cut
594		860
595	sub urxvt::term::resource($$;$) {	861	sub resource($$;$) {
596	my ($self, $name) = (shift, shift);	862	my ($self, $name) = (shift, shift);
597	unshift @_, $self, $name, ($name =~ s/\s\+\s(\d+)$// ? $1 : 0);	863	unshift @_, $self, $name, ($name =~ s/\s\+\s(\d+)$// ? $1 : 0);
598	&urxvt::term::_resource	864	&urxvt::term::_resource
599	}	865	}
600		866
		867	=item $success = $term->parse_keysym ($keysym_spec, $command_string)
		868
		869	Adds a keymap translation exactly as specified via a resource. See the
		870	C<keysym> resource in the @@RXVT_NAME@@(1) manpage.
		871
601	=item $rend = $term->rstyle ([$new_rstyle])	872	=item $rend = $term->rstyle ([$new_rstyle])
602		873
603	Return and optionally change the current rendition. Text that is output by	874	Return and optionally change the current rendition. Text that is output by
604	the terminal application will use this style.	875	the terminal application will use this style.
605		876
…		…
624		895
625	=item $oldtext = $term->selection ([$newtext])	896	=item $oldtext = $term->selection ([$newtext])
626		897
627	Return the current selection text and optionally replace it by C<$newtext>.	898	Return the current selection text and optionally replace it by C<$newtext>.
628		899
629	#=item $term->overlay ($x, $y, $text)	900	=item $term->overlay_simple ($x, $y, $text)
630	#	901
631	#Create a simple multi-line overlay box. See the next method for details.	902	Create a simple multi-line overlay box. See the next method for details.
632	#	903
633	#=cut	904	=cut
634	#	905
635	#sub urxvt::term::scr_overlay {	906	sub overlay_simple {
636	# my ($self, $x, $y, $text) = @_;	907	my ($self, $x, $y, $text) = @_;
637	#	908
638	# my @lines = split /\n/, $text;	909	my @lines = split /\n/, $text;
639	#	910
640	# my $w = 0;	911	my $w = List::Util::max map $self->strwidth ($_), @lines;
641	# for (map $self->strwidth ($_), @lines) {	912
642	# $w = $_ if $w < $_;
643	# }
644	#
645	# $self->scr_overlay_new ($x, $y, $w, scalar @lines);	913	my $overlay = $self->overlay ($x, $y, $w, scalar @lines);
646	# $self->scr_overlay_set (0, $_, $lines[$_]) for 0.. $#lines;	914	$overlay->set (0, $_, $lines[$_]) for 0.. $#lines;
647	#}	915
		916	$overlay
		917	}
648		918
649	=item $term->overlay ($x, $y, $width, $height[, $rstyle[, $border]])	919	=item $term->overlay ($x, $y, $width, $height[, $rstyle[, $border]])
650		920
651	Create a new (empty) overlay at the given position with the given	921	Create a new (empty) overlay at the given position with the given
652	width/height. C<$rstyle> defines the initial rendition style	922	width/height. C<$rstyle> defines the initial rendition style
…		…
687	C<$event> I<must> be the event causing the menu to pop up (a button event,	957	C<$event> I<must> be the event causing the menu to pop up (a button event,
688	currently).	958	currently).
689		959
690	=cut	960	=cut
691		961
692	sub urxvt::term::popup {	962	sub popup {
693	my ($self, $event) = @_;	963	my ($self, $event) = @_;
694		964
695	$self->grab ($event->{time}, 1)	965	$self->grab ($event->{time}, 1)
696	or return;	966	or return;
697		967
…		…
719		989
720	=item $string = $term->locale_decode ($octets)	990	=item $string = $term->locale_decode ($octets)
721		991
722	Convert the given locale-encoded octets into a perl string.	992	Convert the given locale-encoded octets into a perl string.
723		993
		994	=item $term->scr_xor_span ($beg_row, $beg_col, $end_row, $end_col[, $rstyle])
		995
		996	XORs the rendition values in the given span with the provided value
		997	(default: C<RS_RVid>). Useful in refresh hooks to provide effects similar
		998	to the selection.
		999
		1000	=item $term->scr_xor_rect ($beg_row, $beg_col, $end_row, $end_col[, $rstyle1[, $rstyle2]])
		1001
		1002	Similar to C<scr_xor_span>, but xors a rectangle instead. Trailing
		1003	whitespace will additionally be xored with the C<$rstyle2>, which defaults
		1004	to C<RS_RVid \| RS_Uline>, which removes reverse video again and underlines
		1005	it instead.
		1006
		1007	=item $term->scr_bell
		1008
		1009	Ring the bell!
		1010
724	=item $term->scr_add_lines ($string)	1011	=item $term->scr_add_lines ($string)
725		1012
726	Write the given text string to the screen, as if output by the application	1013	Write the given text string to the screen, as if output by the application
727	running inside the terminal. It may not contain command sequences (escape	1014	running inside the terminal. It may not contain command sequences (escape
728	codes), but is free to use line feeds, carriage returns and tabs. The	1015	codes), but is free to use line feeds, carriage returns and tabs. The
…		…
742		1029
743	Write the octets given in C<$data> to the tty (i.e. as program input). To	1030	Write the octets given in C<$data> to the tty (i.e. as program input). To
744	pass characters instead of octets, you should convert your strings first	1031	pass characters instead of octets, you should convert your strings first
745	to the locale-specific encoding using C<< $term->locale_encode >>.	1032	to the locale-specific encoding using C<< $term->locale_encode >>.
746		1033
		1034	=item $old_events = $term->pty_ev_events ([$new_events])
		1035
		1036	Replaces the event mask of the pty watcher by the given event mask. Can
		1037	be used to suppress input and output handling to the pty/tty. See the
		1038	description of C<< urxvt::timer->events >>. Make sure to always restore
		1039	the previous value.
		1040
747	=item $windowid = $term->parent	1041	=item $windowid = $term->parent
748		1042
749	Return the window id of the toplevel window.	1043	Return the window id of the toplevel window.
750		1044
751	=item $windowid = $term->vt	1045	=item $windowid = $term->vt
…		…
775	=item $nrow_plus_saveLines = $term->total_rows	1069	=item $nrow_plus_saveLines = $term->total_rows
776		1070
777	=item $lines_in_scrollback = $term->nsaved	1071	=item $lines_in_scrollback = $term->nsaved
778		1072
779	Return various integers describing terminal characteristics.	1073	Return various integers describing terminal characteristics.
		1074
		1075	=item $x_display = $term->display_id
		1076
		1077	Return the DISPLAY used by rxvt-unicode.
		1078
		1079	=item $lc_ctype = $term->locale
		1080
		1081	Returns the LC_CTYPE category string used by this rxvt-unicode.
		1082
		1083	=item $env = $term->env
		1084
		1085	Returns a copy of the environment in effect for the terminal as a hashref
		1086	similar to C<\%ENV>.
		1087
		1088	=cut
		1089
		1090	sub env {
		1091	if (my $env = $_[0]->_env) {
		1092	+{ map /^([^=]+)(?:=(.*))?$/s && ($1 => $2), @$env }
		1093	} else {
		1094	+{ %ENV }
		1095	}
		1096	}
		1097
		1098	=item $modifiermask = $term->ModLevel3Mask
		1099
		1100	=item $modifiermask = $term->ModMetaMask
		1101
		1102	=item $modifiermask = $term->ModNumLockMask
		1103
		1104	Return the modifier masks corresponding to the "ISO Level 3 Shift" (often
		1105	AltGr), the meta key (often Alt) and the num lock key, if applicable.
780		1106
781	=item $view_start = $term->view_start ([$newvalue])	1107	=item $view_start = $term->view_start ([$newvalue])
782		1108
783	Returns the negative row number of the topmost line. Minimum value is	1109	Returns the negative row number of the topmost line. Minimum value is
784	C<0>, which displays the normal terminal contents. Larger values scroll	1110	C<0>, which displays the normal terminal contents. Larger values scroll
…		…
878		1204
879	=back	1205	=back
880		1206
881	=cut	1207	=cut
882		1208
883	sub urxvt::term::line {	1209	sub line {
884	my ($self, $row) = @_;	1210	my ($self, $row) = @_;
885		1211
886	my $maxrow = $self->nrow - 1;	1212	my $maxrow = $self->nrow - 1;
887		1213
888	my ($beg, $end) = ($row, $row);	1214	my ($beg, $end) = ($row, $row);
…		…
952	$offset / $self->{ncol} + $self->{beg},	1278	$offset / $self->{ncol} + $self->{beg},
953	$offset % $self->{ncol}	1279	$offset % $self->{ncol}
954	)	1280	)
955	}	1281	}
956		1282
957	=item ($row, $col) = $line->coord_of ($offset)
958	=item $text = $term->special_encode $string	1283	=item $text = $term->special_encode $string
959		1284
960	Converts a perl string into the special encoding used by rxvt-unicode,	1285	Converts a perl string into the special encoding used by rxvt-unicode,
961	where one character corresponds to one screen cell. See	1286	where one character corresponds to one screen cell. See
962	C<< $term->ROW_t >> for details.	1287	C<< $term->ROW_t >> for details.
…		…
964	=item $string = $term->special_decode $text	1289	=item $string = $term->special_decode $text
965		1290
966	Converts rxvt-unicodes text reprsentation into a perl string. See	1291	Converts rxvt-unicodes text reprsentation into a perl string. See
967	C<< $term->ROW_t >> for details.	1292	C<< $term->ROW_t >> for details.
968		1293
		1294	=item $success = $term->grab_button ($button, $modifiermask)
		1295
		1296	Registers a synchronous button grab. See the XGrabButton manpage.
		1297
		1298	=item $success = $term->grab ($eventtime[, $sync])
		1299
		1300	Calls XGrabPointer and XGrabKeyboard in asynchronous (default) or
		1301	synchronous (C<$sync> is true). Also remembers the grab timestampe.
		1302
		1303	=item $term->allow_events_async
		1304
		1305	Calls XAllowEvents with AsyncBoth for the most recent grab.
		1306
		1307	=item $term->allow_events_sync
		1308
		1309	Calls XAllowEvents with SyncBoth for the most recent grab.
		1310
		1311	=item $term->allow_events_replay
		1312
		1313	Calls XAllowEvents with both ReplayPointer and ReplayKeyboard for the most
		1314	recent grab.
		1315
		1316	=item $term->ungrab
		1317
		1318	Calls XUngrab for the most recent grab. Is called automatically on
		1319	evaluation errors, as it is better to lose the grab in the error case as
		1320	the session.
		1321
969	=back	1322	=back
970		1323
		1324	=cut
		1325
		1326	package urxvt::popup;
		1327
971	=head2 The C<urxvt::popup> Class	1328	=head2 The C<urxvt::popup> Class
972		1329
973	=over 4	1330	=over 4
974		1331
975	=cut	1332	=cut
976
977	package urxvt::popup;
978		1333
979	sub add_item {	1334	sub add_item {
980	my ($self, $item) = @_;	1335	my ($self, $item) = @_;
981		1336
		1337	$item->{rend}{normal} = "\x1b[0;30;47m" unless exists $item->{rend}{normal};
		1338	$item->{rend}{hover} = "\x1b[0;30;46m" unless exists $item->{rend}{hover};
		1339	$item->{rend}{active} = "\x1b[m" unless exists $item->{rend}{active};
		1340
		1341	$item->{render} \|\|= sub { $_[0]{text} };
		1342
982	push @{ $self->{item} }, $item;	1343	push @{ $self->{item} }, $item;
983	}	1344	}
		1345
		1346	=item $popup->add_title ($title)
		1347
		1348	Adds a non-clickable title to the popup.
		1349
		1350	=cut
		1351
		1352	sub add_title {
		1353	my ($self, $title) = @_;
		1354
		1355	$self->add_item ({
		1356	rend => { normal => "\x1b[38;5;11;44m", hover => "\x1b[38;5;11;44m", active => "\x1b[38;5;11;44m" },
		1357	text => $title,
		1358	activate => sub { },
		1359	});
		1360	}
		1361
		1362	=item $popup->add_separator ([$sepchr])
		1363
		1364	Creates a separator, optionally using the character given as C<$sepchr>.
		1365
		1366	=cut
		1367
		1368	sub add_separator {
		1369	my ($self, $sep) = @_;
		1370
		1371	$sep \|\|= "=";
		1372
		1373	$self->add_item ({
		1374	rend => { normal => "\x1b[0;30;47m", hover => "\x1b[0;30;47m", active => "\x1b[0;30;47m" },
		1375	text => "",
		1376	render => sub { $sep x $self->{term}->ncol },
		1377	activate => sub { },
		1378	});
		1379	}
		1380
		1381	=item $popup->add_button ($text, $cb)
		1382
		1383	Adds a clickable button to the popup. C<$cb> is called whenever it is
		1384	selected.
		1385
		1386	=cut
984		1387
985	sub add_button {	1388	sub add_button {
986	my ($self, $text, $cb) = @_;	1389	my ($self, $text, $cb) = @_;
987		1390
988	$self->add_item ({ type => "button", text => "[ $text ]", activate => $cb });	1391	$self->add_item ({ type => "button", text => $text, activate => $cb});
989	}	1392	}
		1393
		1394	=item $popup->add_toggle ($text, $cb, $initial_value)
		1395
		1396	Adds a toggle/checkbox item to the popup. Teh callback gets called
		1397	whenever it gets toggled, with a boolean indicating its value as its first
		1398	argument.
		1399
		1400	=cut
		1401
		1402	sub add_toggle {
		1403	my ($self, $text, $cb, $value) = @_;
		1404
		1405	my $item; $item = {
		1406	type => "button",
		1407	text => " $text",
		1408	value => $value,
		1409	render => sub { ($_[0]{value} ? "* " : " ") . $text },
		1410	activate => sub { $cb->($_[1]{value} = !$_[1]{value}); },
		1411	};
		1412
		1413	$self->add_item ($item);
		1414	}
		1415
		1416	=item $popup->show
		1417
		1418	Displays the popup (which is initially hidden).
		1419
		1420	=cut
990		1421
991	sub show {	1422	sub show {
992	my ($self) = @_;	1423	my ($self) = @_;
993		1424
994	local $urxvt::popup::self = $self;	1425	local $urxvt::popup::self = $self;
995		1426
		1427	my $env = $self->{term}->env;
		1428	# we can't hope to reproduce the locale algorithm, so nuke LC_ALL and set LC_CTYPE.
		1429	delete $env->{LC_ALL};
		1430	$env->{LC_CTYPE} = $self->{term}->locale;
		1431
		1432	urxvt::term->new ($env, $self->{term}->resource ("name"),
996	urxvt->new ("--perl-lib" => "", "--perl-ext-common" => "", "-pty-fd" => -1, "-sl" => 0, "-b" => 0,	1433	"--perl-lib" => "", "--perl-ext-common" => "", "-pty-fd" => -1, "-sl" => 0, "-b" => 0,
997	"--transient-for" => $self->{term}->parent,	1434	"--transient-for" => $self->{term}->parent,
		1435	"-display" => $self->{term}->display_id,
998	"-pe" => "urxvt-popup")	1436	"-pe" => "urxvt-popup")
999	or die "unable to create popup window\n";	1437	or die "unable to create popup window\n";
1000	}	1438	}
1001		1439
1002	sub DESTROY {	1440	sub DESTROY {
1003	my ($self) = @_;	1441	my ($self) = @_;
1004		1442
		1443	delete $self->{term}{_destroy}{$self};
1005	$self->{term}->ungrab;	1444	$self->{term}->ungrab;
1006	}	1445	}
1007		1446
1008	=head2 The C<urxvt::timer> Class	1447	=head2 The C<urxvt::timer> Class
1009		1448
…		…
1064		1503
1065	$term->{socket} = ...	1504	$term->{socket} = ...
1066	$term->{iow} = urxvt::iow	1505	$term->{iow} = urxvt::iow
1067	->new	1506	->new
1068	->fd (fileno $term->{socket})	1507	->fd (fileno $term->{socket})
1069	->events (1) # wait for read data	1508	->events (urxvt::EVENT_READ)
1070	->start	1509	->start
1071	->cb (sub {	1510	->cb (sub {
1072	my ($iow, $revents) = @_;	1511	my ($iow, $revents) = @_;
1073	# $revents must be 1 here, no need to check	1512	# $revents must be 1 here, no need to check
1074	sysread $term->{socket}, my $buf, 8192	1513	sysread $term->{socket}, my $buf, 8192
…		…
1091		1530
1092	Set the filedescriptor (not handle) to watch.	1531	Set the filedescriptor (not handle) to watch.
1093		1532
1094	=item $iow = $iow->events ($eventmask)	1533	=item $iow = $iow->events ($eventmask)
1095		1534
1096	Set the event mask to watch. Bit #0 (value C<1>) enables watching for read	1535	Set the event mask to watch. The only allowed values are
1097	data, Bit #1 (value C<2>) enables watching for write data.	1536	C<urxvt::EVENT_READ> and C<urxvt::EVENT_WRITE>, which might be ORed
		1537	together, or C<urxvt::EVENT_NONE>.
1098		1538
1099	=item $iow = $iow->start	1539	=item $iow = $iow->start
1100		1540
1101	Start watching for requested events on the given handle.	1541	Start watching for requested events on the given handle.
1102		1542
…		…
1113	This variable controls the verbosity level of the perl extension. Higher	1553	This variable controls the verbosity level of the perl extension. Higher
1114	numbers indicate more verbose output.	1554	numbers indicate more verbose output.
1115		1555
1116	=over 4	1556	=over 4
1117		1557
1118	=item =0 - only fatal messages	1558	=item == 0 - fatal messages
1119		1559
1120	=item =3 - script loading and management	1560	=item >= 3 - script loading and management
1121		1561
1122	=item =10 - all events received	1562	=item >=10 - all events received
1123		1563
1124	=back	1564	=back
1125		1565
1126	=head1 AUTHOR	1566	=head1 AUTHOR
1127		1567

Diff Legend

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

Comparing rxvt-unicode/src/urxvt.pm (file contents): Revision 1.46 by root, Sat Jan 7 20:29:28 2006 UTC vs. Revision 1.77 by root, Wed Jan 11 00:59:58 2006 UTC

Diff Legend

Comparing rxvt-unicode/src/urxvt.pm (file contents):
Revision 1.46 by root, Sat Jan 7 20:29:28 2006 UTC vs.
Revision 1.77 by root, Wed Jan 11 00:59:58 2006 UTC