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

Comparing rxvt-unicode/src/urxvt.pm (file contents):
Revision 1.43 by root, Sat Jan 7 04:19:43 2006 UTC vs.
Revision 1.74 by root, Tue Jan 10 04:26:54 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
…		…
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	Intelligent selection. This extension tries to be more intelligent when
45	the user extends selections (double-click). Right now, it tries to select	45	the user extends selections (double-click). Right now, it tries to select
46	urls and complete shell-quoted arguments, which is very convenient, too,	46	urls and complete shell-quoted arguments, which is very convenient, too,
47	if your F<ls> supports C<--quoting-style=shell>.	47	if your F<ls> supports C<--quoting-style=shell>.
…		…
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.
		70
		71	=item searchable-scrollback<hotkey> (enabled by default)
		72
		73	Adds regex search functionality to the scrollback buffer, triggered
		74	by a hotkey (default: C<M-s>). When in search mode, normal terminal
		75	input/output is suspended.
		76
		77	C</> starts an incremental regex search, C<n> searches further, C<p> or
		78	C<N> jump to the previous match, C<G> jumps to the bottom and clears the
		79	history, C<enter> leaves search mode at the current position and C<escape>
		80	returns to the original position.
60		81
61	=item digital-clock	82	=item digital-clock
62		83
63	Displays a digital clock using the built-in overlay.	84	Displays a digital clock using the built-in overlay.
64		85
…		…
114	Either binary data or - more common - a text string encoded in a	135	Either binary data or - more common - a text string encoded in a
115	locale-specific way.	136	locale-specific way.
116		137
117	=back	138	=back
118		139
		140	=head2 Extension Objects
		141
		142	Very perl extension is a perl class. A separate perl object is created
		143	for each terminal and each extension and passed as the first parameter to
		144	hooks. So extensions can use their C<$self> object without having to think
		145	about other extensions, with the exception of methods and members that
		146	begin with an underscore character C<_>: these are reserved for internal
		147	use.
		148
		149	Although it isn't a C<urxvt::term> object, you can call all methods of the
		150	C<urxvt::term> class on this object.
		151
		152	It has the following methods and data members:
		153
		154	=over 4
		155
		156	=item $urxvt_term = $self->{term}
		157
		158	Returns the C<urxvt::term> object associated with this instance of the
		159	extension. This member I<must not> be changed in any way.
		160
		161	=item $self->enable ($hook_name => $cb, [$hook_name => $cb..])
		162
		163	Dynamically enable the given hooks (named without the C<on_> prefix) for
		164	this extension, replacing any previous hook. This is useful when you want
		165	to overwrite time-critical hooks only temporarily.
		166
		167	=item $self->disable ($hook_name[, $hook_name..])
		168
		169	Dynamically disable the given hooks.
		170
		171	=back
		172
119	=head2 Hooks	173	=head2 Hooks
120		174
121	The following subroutines can be declared in extension files, and will be	175	The following subroutines can be declared in extension files, and will be
122	called whenever the relevant event happens.	176	called whenever the relevant event happens.
123		177
124	The first argument passed to them is an object private to each terminal	178	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	179	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.
129		180
130	All of them must return a boolean value. If it is true, then the event	181	B<All> of these hooks must return a boolean value. If it is true, then the
131	counts as being I<consumed>, and the invocation of other hooks is skipped,	182	event counts as being I<consumed>, and the invocation of other hooks is
132	and the relevant action might not be carried out by the C++ code.	183	skipped, and the relevant action might not be carried out by the C++ code.
133		184
134	When in doubt, return a false value (preferably C<()>).	185	I<< When in doubt, return a false value (preferably C<()>). >>
135		186
136	=over 4	187	=over 4
137		188
138	=item on_init $term	189	=item on_init $term
139		190
…		…
178	should extend the selection itelf and return true to suppress the built-in	229	should extend the selection itelf and return true to suppress the built-in
179	processing.	230	processing.
180		231
181	See the F<selection> example extension.	232	See the F<selection> example extension.
182		233
183	=item on_focus_in $term
184
185	Called whenever the window gets the keyboard focus, before urxvt does
186	focus in processing.
187
188	=item on_focus_out $term
189
190	Called wheneever the window loses keyboard focus, before urxvt does focus
191	out processing.
192
193	=item on_view_change $term, $offset	234	=item on_view_change $term, $offset
194		235
195	Called whenever the view offset changes, i..e the user or program	236	Called whenever the view offset changes, i..e the user or program
196	scrolls. Offset C<0> means display the normal terminal, positive values	237	scrolls. Offset C<0> means display the normal terminal, positive values
197	show this many lines of scrollback.	238	show this many lines of scrollback.
…		…
203	than the scroll back buffer or the terminal.	244	than the scroll back buffer or the terminal.
204		245
205	It is called before lines are scrolled out (so rows 0 .. min ($lines - 1,	246	It is called before lines are scrolled out (so rows 0 .. min ($lines - 1,
206	$nrow - 1) represent the lines to be scrolled out). C<$saved> is the total	247	$nrow - 1) represent the lines to be scrolled out). C<$saved> is the total
207	number of lines that will be in the scrollback buffer.	248	number of lines that will be in the scrollback buffer.
208
209	=item on_tty_activity $term NYI
210
211	Called whenever the program(s) running in the urxvt window send output.
212		249
213	=item on_osc_seq $term, $string	250	=item on_osc_seq $term, $string
214		251
215	Called whenever the B<ESC ] 777 ; string ST> command sequence (OSC =	252	Called whenever the B<ESC ] 777 ; string ST> command sequence (OSC =
216	operating system command) is processed. Cursor position and other state	253	operating system command) is processed. Cursor position and other state
…		…
229	can filter/change and output the text yourself by returning a true value	266	can filter/change and output the text yourself by returning a true value
230	and calling C<< $term->scr_add_lines >> yourself. Please note that this	267	and calling C<< $term->scr_add_lines >> yourself. Please note that this
231	might be very slow, however, as your hook is called for B<all> text being	268	might be very slow, however, as your hook is called for B<all> text being
232	output.	269	output.
233		270
		271	=item on_tt_write $term, $octets
		272
		273	Called whenever some data is written to the tty/pty and can be used to
		274	suppress or filter tty input.
		275
234	=item on_line_update $term, $row	276	=item on_line_update $term, $row
235		277
236	Called whenever a line was updated or changed. Can be used to filter	278	Called whenever a line was updated or changed. Can be used to filter
237	screen output (e.g. underline urls or other useless stuff). Only lines	279	screen output (e.g. underline urls or other useless stuff). Only lines
238	that are being shown will be filtered, and, due to performance reasons,	280	that are being shown will be filtered, and, due to performance reasons,
…		…
260		302
261	Called whenever the user presses a key combination that has a	303	Called whenever the user presses a key combination that has a
262	C<perl:string> action bound to it (see description of the B<keysym>	304	C<perl:string> action bound to it (see description of the B<keysym>
263	resource in the @@RXVT_NAME@@(1) manpage).	305	resource in the @@RXVT_NAME@@(1) manpage).
264		306
		307	=item on_focus_in $term
		308
		309	Called whenever the window gets the keyboard focus, before rxvt-unicode
		310	does focus in processing.
		311
		312	=item on_focus_out $term
		313
		314	Called wheneever the window loses keyboard focus, before rxvt-unicode does
		315	focus out processing.
		316
265	=item on_key_press $term, $event, $octets	317	=item on_key_press $term, $event, $keysym, $octets
266		318
267	=item on_key_release $term, $event	319	=item on_key_release $term, $event, $keysym
268		320
269	=item on_button_press $term, $event	321	=item on_button_press $term, $event
270		322
271	=item on_button_release $term, $event	323	=item on_button_release $term, $event
272		324
273	=item on_motion_notify $term, $event	325	=item on_motion_notify $term, $event
		326
		327	=item on_map_notify $term, $event
		328
		329	=item on_unmap_notify $term, $event
274		330
275	Called whenever the corresponding X event is received for the terminal If	331	Called whenever the corresponding X event is received for the terminal If
276	the hook returns true, then the even will be ignored by rxvt-unicode.	332	the hook returns true, then the even will be ignored by rxvt-unicode.
277		333
278	The event is a hash with most values as named by Xlib (see the XEvent	334	The event is a hash with most values as named by Xlib (see the XEvent
…		…
322	that calls this function.	378	that calls this function.
323		379
324	Using this function has the advantage that its output ends up in the	380	Using this function has the advantage that its output ends up in the
325	correct place, e.g. on stderr of the connecting urxvtc client.	381	correct place, e.g. on stderr of the connecting urxvtc client.
326		382
		383	=item $is_safe = urxvt::safe
		384
		385	Returns true when it is safe to do potentially unsafe things, such as
		386	evaluating perl code specified by the user. This is true when urxvt was
		387	started setuid or setgid.
		388
327	=item $time = urxvt::NOW	389	=item $time = urxvt::NOW
328		390
329	Returns the "current time" (as per the event loop).	391	Returns the "current time" (as per the event loop).
		392
		393	=item urxvt::CurrentTime
		394
		395	=item urxvt::ShiftMask, LockMask, ControlMask, Mod1Mask, Mod2Mask,
		396	Mod3Mask, Mod4Mask, Mod5Mask, Button1Mask, Button2Mask, Button3Mask,
		397	Button4Mask, Button5Mask, AnyModifier
		398
		399	Various constants for use in X calls and event processing.
330		400
331	=back	401	=back
332		402
333	=head2 RENDITION	403	=head2 RENDITION
334		404
…		…
384		454
385	=cut	455	=cut
386		456
387	package urxvt;	457	package urxvt;
388		458
		459	use utf8;
389	use strict;	460	use strict;
		461	use Carp ();
390	use Scalar::Util ();	462	use Scalar::Util ();
		463	use List::Util ();
391		464
		465	our $VERSION = 1;
392	our $TERM;	466	our $TERM;
393	our @HOOKNAME;	467	our @HOOKNAME;
		468	our %HOOKTYPE = map +($HOOKNAME[$_] => $_), 0..$#HOOKNAME;
		469	our %OPTION;
		470
394	our $LIBDIR;	471	our $LIBDIR;
		472	our $RESNAME;
		473	our $RESCLASS;
		474	our $RXVTNAME;
395		475
396	BEGIN {	476	BEGIN {
397	urxvt->bootstrap;	477	urxvt->bootstrap;
398		478
399	# overwrite perl's warn	479	# overwrite perl's warn
…		…
401	my $msg = join "", @_;	481	my $msg = join "", @_;
402	$msg .= "\n"	482	$msg .= "\n"
403	unless $msg =~ /\n$/;	483	unless $msg =~ /\n$/;
404	urxvt::warn ($msg);	484	urxvt::warn ($msg);
405	};	485	};
		486
		487	delete $ENV{IFS};
		488	delete $ENV{CDPATH};
		489	delete $ENV{BASH_ENV};
		490	$ENV{PATH} = "/bin:/sbin:/usr/bin:/usr/sbin:/usr/local/bin:/usr/local/sbin:/opt/bin:/opt/sbin";
406	}	491	}
407		492
408	my @hook_count;	493	my @hook_count;
409	my $verbosity = $ENV{URXVT_PERL_VERBOSITY};	494	my $verbosity = $ENV{URXVT_PERL_VERBOSITY};
410		495
411	sub verbose {	496	sub verbose {
412	my ($level, $msg) = @_;	497	my ($level, $msg) = @_;
413	warn "$msg\n" if $level <= $verbosity;	498	warn "$msg\n" if $level <= $verbosity;
414	}	499	}
415		500
416	# find on_xxx subs in the package and register them	501	my $extension_pkg = "extension0000";
417	# as hooks	502	my %extension_pkg;
418	sub register_package($) {
419	my ($pkg) = @_;
420
421	for my $htype (0.. $#HOOKNAME) {
422	my $name = $HOOKNAME[$htype];
423
424	my $ref = $pkg->can ("on_" . lc $name)
425	or next;
426
427	$TERM->{_hook}[$htype]{$pkg} = $ref;
428	$hook_count[$htype]++
429	or set_should_invoke $htype, 1;
430	}
431	}
432
433	my $script_pkg = "script0000";
434	my %script_pkg;
435		503
436	# load a single script into its own package, once only	504	# load a single script into its own package, once only
437	sub script_package($) {	505	sub extension_package($) {
438	my ($path) = @_;	506	my ($path) = @_;
439		507
440	$script_pkg{$path} \|\|= do {	508	$extension_pkg{$path} \|\|= do {
441	my $pkg = "urxvt::" . ($script_pkg++);	509	my $pkg = "urxvt::" . ($extension_pkg++);
442		510
443	verbose 3, "loading script '$path' into package '$pkg'";	511	verbose 3, "loading extension '$path' into package '$pkg'";
444		512
445	open my $fh, "<:raw", $path	513	open my $fh, "<:raw", $path
446	or die "$path: $!";	514	or die "$path: $!";
447		515
		516	my $source = untaint
448	my $source = "package $pkg; use strict; use utf8;\n"	517	"package $pkg; use strict; use utf8;\n"
		518	. "use base urxvt::term::extension::;\n"
449	. "#line 1 \"$path\"\n{\n"	519	. "#line 1 \"$path\"\n{\n"
450	. (do { local $/; <$fh> })	520	. (do { local $/; <$fh> })
451	. "\n};\n1";	521	. "\n};\n1";
452		522
		523	eval $source
453	eval $source or die "$path: $@";	524	or die "$path: $@";
454		525
455	$pkg	526	$pkg
456	}	527	}
457	}	528	}
458		529
…		…
463	local $TERM = shift;	534	local $TERM = shift;
464	my $htype = shift;	535	my $htype = shift;
465		536
466	if ($htype == 0) { # INIT	537	if ($htype == 0) { # INIT
467	my @dirs = ((split /:/, $TERM->resource ("perl_lib")), "$LIBDIR/perl");	538	my @dirs = ((split /:/, $TERM->resource ("perl_lib")), "$LIBDIR/perl");
		539
		540	my %ext_arg;
468		541
469	for my $ext (map { split /,/, $TERM->resource ("perl_ext_$_") } 1, 2) {	542	for (map { split /,/, $TERM->resource ("perl_ext_$_") } 1, 2) {
		543	if ($_ eq "default") {
		544	$ext_arg{$_} \|\|= [] for qw(selection option-popup selection-popup searchable-scrollback);
		545	} elsif (/^-(.*)$/) {
		546	delete $ext_arg{$1};
		547	} elsif (/^([^<]+)<(.*)>$/) {
		548	push @{ $ext_arg{$1} }, $2;
		549	} else {
		550	$ext_arg{$_} \|\|= [];
		551	}
		552	}
		553
		554	while (my ($ext, $argv) = each %ext_arg) {
470	my @files = grep -f $_, map "$_/$ext", @dirs;	555	my @files = grep -f $_, map "$_/$ext", @dirs;
471		556
472	if (@files) {	557	if (@files) {
473	register_package script_package $files[0];	558	$TERM->register_package (extension_package $files[0], $argv);
474	} else {	559	} else {
475	warn "perl extension '$ext' not found in perl library search path\n";	560	warn "perl extension '$ext' not found in perl library search path\n";
476	}	561	}
477	}	562	}
		563
		564	eval "#line 1 \"--perl-eval resource/argument\"\n" . $TERM->resource ("perl_eval");
		565	warn $@ if $@;
478	}	566	}
479		567
480	$retval = undef;	568	$retval = undef;
481		569
482	if (my $cb = $TERM->{_hook}[$htype]) {	570	if (my $cb = $TERM->{_hook}[$htype]) {
…		…
484	if $verbosity >= 10;	572	if $verbosity >= 10;
485		573
486	keys %$cb;	574	keys %$cb;
487		575
488	while (my ($pkg, $cb) = each %$cb) {	576	while (my ($pkg, $cb) = each %$cb) {
489	$retval = $cb->(	577	$retval = eval { $cb->($TERM->{_pkg}{$pkg}, @_) }
490	$TERM->{_pkg}{$pkg} \|\|= do {
491	my $proxy = bless { }, urxvt::term::proxy::;
492	Scalar::Util::weaken ($proxy->{term} = $TERM);
493	$proxy
494	},
495	@_,
496	) and last;	578	and last;
		579
		580	if ($@) {
		581	$TERM->ungrab; # better to lose the grab than the session
		582	warn $@;
		583	}
497	}	584	}
498	}	585	}
499		586
500	if ($htype == 1) { # DESTROY	587	if ($htype == 1) { # DESTROY
501	# remove hooks if unused
502	if (my $hook = $TERM->{_hook}) {	588	if (my $hook = delete $TERM->{_hook}) {
503	for my $htype (0..$#$hook) {	589	for my $htype (0..$#$hook) {
504	$hook_count[$htype] -= scalar keys %{ $hook->[$htype] \|\| {} }	590	$hook_count[$htype] -= scalar keys %{ $hook->[$htype] \|\| {} }
505	or set_should_invoke $htype, 0;	591	or set_should_invoke $htype, 0;
506	}	592	}
507	}	593	}
…		…
514	}	600	}
515		601
516	$retval	602	$retval
517	}	603	}
518		604
519	sub urxvt::term::proxy::AUTOLOAD {	605	# urxvt::term::extension
520	$urxvt::term::proxy::AUTOLOAD =~ /:([^:]+)$/	606
		607	package urxvt::term::extension;
		608
		609	sub enable {
		610	my ($self, %hook) = @_;
		611	my $pkg = $self->{_pkg};
		612
		613	while (my ($name, $cb) = each %hook) {
		614	my $htype = $HOOKTYPE{uc $name};
		615	defined $htype
		616	or Carp::croak "unsupported hook type '$name'";
		617
		618	unless (exists $self->{term}{_hook}[$htype]{$pkg}) {
		619	$hook_count[$htype]++
		620	or urxvt::set_should_invoke $htype, 1;
		621	}
		622
		623	$self->{term}{_hook}[$htype]{$pkg} = $cb;
		624	}
		625	}
		626
		627	sub disable {
		628	my ($self, @hook) = @_;
		629	my $pkg = $self->{_pkg};
		630
		631	for my $name (@hook) {
		632	my $htype = $HOOKTYPE{uc $name};
		633	defined $htype
		634	or Carp::croak "unsupported hook type '$name'";
		635
		636	if (delete $self->{term}{_hook}[$htype]{$pkg}) {
		637	--$hook_count[$htype]
		638	or urxvt::set_should_invoke $htype, 0;
		639	}
		640	}
		641	}
		642
		643	our $AUTOLOAD;
		644
		645	sub AUTOLOAD {
		646	$AUTOLOAD =~ /:([^:]+)$/
521	or die "FATAL: \$AUTOLOAD '$urxvt::term::proxy::AUTOLOAD' unparsable";	647	or die "FATAL: \$AUTOLOAD '$AUTOLOAD' unparsable";
522		648
523	eval qq{	649	eval qq{
524	sub $urxvt::term::proxy::AUTOLOAD {	650	sub $AUTOLOAD {
525	my \$proxy = shift;	651	my \$proxy = shift;
526	\$proxy->{term}->$1 (\@_)	652	\$proxy->{term}->$1 (\@_)
527	}	653	}
528	1	654	1
529	} or die "FATAL: unable to compile method forwarder: $@";	655	} or die "FATAL: unable to compile method forwarder: $@";
530		656
531	goto &$urxvt::term::proxy::AUTOLOAD;	657	goto &$AUTOLOAD;
532	}	658	}
		659
		660	sub DESTROY {
		661	# nop
		662	}
		663
		664	# urxvt::destroy_hook
		665
		666	sub urxvt::destroy_hook::DESTROY {
		667	${$_[0]}->();
		668	}
		669
		670	sub urxvt::destroy_hook(&) {
		671	bless \shift, urxvt::destroy_hook::
		672	}
		673
		674	package urxvt::anyevent;
		675
		676	=head2 The C<urxvt::anyevent> Class
		677
		678	The sole purpose of this class is to deliver an interface to the
		679	C<AnyEvent> module - any module using it will work inside urxvt without
		680	further work. The only exception is that you cannot wait on condition
		681	variables, but non-blocking condvar use is ok. What this means is that you
		682	cannot use blocking APIs, but the non-blocking variant should work.
		683
		684	=cut
		685
		686	our $VERSION = 1;
		687
		688	$INC{"urxvt/anyevent.pm"} = 1; # mark us as there
		689	push @AnyEvent::REGISTRY, [urxvt => urxvt::anyevent::];
		690
		691	sub timer {
		692	my ($class, %arg) = @_;
		693
		694	my $cb = $arg{cb};
		695
		696	urxvt::timer
		697	->new
		698	->start (urxvt::NOW + $arg{after})
		699	->cb (sub {
		700	$_[0]->stop; # need to cancel manually
		701	$cb->();
		702	})
		703	}
		704
		705	sub io {
		706	my ($class, %arg) = @_;
		707
		708	my $cb = $arg{cb};
		709
		710	bless [$arg{fh}, urxvt::iow
		711	->new
		712	->fd (fileno $arg{fh})
		713	->events (($arg{poll} =~ /r/ ? 1 : 0)
		714	\| ($arg{poll} =~ /w/ ? 2 : 0))
		715	->start
		716	->cb (sub {
		717	$cb->(($_[1] & 1 ? 'r' : '')
		718	. ($_[1] & 2 ? 'w' : ''));
		719	})],
		720	urxvt::anyevent::
		721	}
		722
		723	sub DESTROY {
		724	$_[0][1]->stop;
		725	}
		726
		727	sub condvar {
		728	bless \my $flag, urxvt::anyevent::condvar::
		729	}
		730
		731	sub urxvt::anyevent::condvar::broadcast {
		732	${$_[0]}++;
		733	}
		734
		735	sub urxvt::anyevent::condvar::wait {
		736	unless (${$_[0]}) {
		737	Carp::croak "AnyEvent->condvar blocking wait unsupported in urxvt, use a non-blocking API";
		738	}
		739	}
		740
		741	package urxvt::term;
533		742
534	=head2 The C<urxvt::term> Class	743	=head2 The C<urxvt::term> Class
535		744
536	=over 4	745	=over 4
537		746
		747	=cut
		748
		749	# find on_xxx subs in the package and register them
		750	# as hooks
		751	sub register_package {
		752	my ($self, $pkg, $argv) = @_;
		753
		754	my $proxy = bless {
		755	_pkg => $pkg,
		756	argv => $argv,
		757	}, $pkg;
		758	Scalar::Util::weaken ($proxy->{term} = $self);
		759
		760	$self->{_pkg}{$pkg} = $proxy;
		761
		762	for my $name (@HOOKNAME) {
		763	if (my $ref = $pkg->can ("on_" . lc $name)) {
		764	$proxy->enable ($name => $ref);
		765	}
		766	}
		767	}
		768
538	=item $term->destroy	769	=item $term->destroy
539		770
540	Destroy the terminal object (close the window, free resources etc.).	771	Destroy the terminal object (close the window, free resources etc.).
		772
		773	=item $isset = $term->option ($optval[, $set])
		774
		775	Returns true if the option specified by C<$optval> is enabled, and
		776	optionally change it. All option values are stored by name in the hash
		777	C<%urxvt::OPTION>. Options not enabled in this binary are not in the hash.
		778
		779	Here is a a likely non-exhaustive list of option names, please see the
		780	source file F</src/optinc.h> to see the actual list:
		781
		782	borderLess console cursorBlink cursorUnderline hold iconic insecure
		783	intensityStyles jumpScroll loginShell mapAlert meta8 mouseWheelScrollPage
		784	pastableTabs pointerBlank reverseVideo scrollBar scrollBar_floating
		785	scrollBar_right scrollTtyKeypress scrollTtyOutput scrollWithBuffer
		786	secondaryScreen secondaryScroll skipBuiltinGlyphs transparent
		787	tripleclickwords utmpInhibit visualBell
541		788
542	=item $value = $term->resource ($name[, $newval])	789	=item $value = $term->resource ($name[, $newval])
543		790
544	Returns the current resource value associated with a given name and	791	Returns the current resource value associated with a given name and
545	optionally sets a new value. Setting values is most useful in the C<init>	792	optionally sets a new value. Setting values is most useful in the C<init>
…		…
555		802
556	Please note that resource strings will currently only be freed when the	803	Please note that resource strings will currently only be freed when the
557	terminal is destroyed, so changing options frequently will eat memory.	804	terminal is destroyed, so changing options frequently will eat memory.
558		805
559	Here is a a likely non-exhaustive list of resource names, not all of which	806	Here is a a likely non-exhaustive list of resource names, not all of which
560	are supported in every build, please see the source to see the actual	807	are supported in every build, please see the source file F</src/rsinc.h>
561	list:	808	to see the actual list:
562		809
563	answerbackstring backgroundPixmap backspace_key boldFont boldItalicFont	810	answerbackstring backgroundPixmap backspace_key boldFont boldItalicFont
564	borderLess color cursorBlink cursorUnderline cutchars delete_key	811	borderLess color cursorBlink cursorUnderline cutchars delete_key
565	display_name embed ext_bwidth fade font geometry hold iconName	812	display_name embed ext_bwidth fade font geometry hold iconName
566	imFont imLocale inputMethod insecure int_bwidth intensityStyles	813	imFont imLocale inputMethod insecure int_bwidth intensityStyles
…		…
573	shade term_name title transparent transparent_all tripleclickwords	820	shade term_name title transparent transparent_all tripleclickwords
574	utmpInhibit visualBell	821	utmpInhibit visualBell
575		822
576	=cut	823	=cut
577		824
578	sub urxvt::term::resource($$;$) {	825	sub resource($$;$) {
579	my ($self, $name) = (shift, shift);	826	my ($self, $name) = (shift, shift);
580	unshift @_, $self, $name, ($name =~ s/\s\+\s(\d+)$// ? $1 : 0);	827	unshift @_, $self, $name, ($name =~ s/\s\+\s(\d+)$// ? $1 : 0);
581	goto &urxvt::term::_resource;	828	&urxvt::term::_resource
582	}	829	}
		830
		831	=item $success = $term->parse_keysym ($keysym_spec, $command_string)
		832
		833	Adds a keymap translation exactly as specified via a resource. See the
		834	C<keysym> resource in the @@RXVT_NAME@@(1) manpage.
583		835
584	=item $rend = $term->rstyle ([$new_rstyle])	836	=item $rend = $term->rstyle ([$new_rstyle])
585		837
586	Return and optionally change the current rendition. Text that is output by	838	Return and optionally change the current rendition. Text that is output by
587	the terminal application will use this style.	839	the terminal application will use this style.
…		…
607		859
608	=item $oldtext = $term->selection ([$newtext])	860	=item $oldtext = $term->selection ([$newtext])
609		861
610	Return the current selection text and optionally replace it by C<$newtext>.	862	Return the current selection text and optionally replace it by C<$newtext>.
611		863
612	#=item $term->overlay ($x, $y, $text)	864	=item $term->overlay_simple ($x, $y, $text)
613	#	865
614	#Create a simple multi-line overlay box. See the next method for details.	866	Create a simple multi-line overlay box. See the next method for details.
615	#	867
616	#=cut	868	=cut
617	#	869
618	#sub urxvt::term::scr_overlay {	870	sub overlay_simple {
619	# my ($self, $x, $y, $text) = @_;	871	my ($self, $x, $y, $text) = @_;
620	#	872
621	# my @lines = split /\n/, $text;	873	my @lines = split /\n/, $text;
622	#	874
623	# my $w = 0;	875	my $w = List::Util::max map $self->strwidth ($_), @lines;
624	# for (map $self->strwidth ($_), @lines) {	876
625	# $w = $_ if $w < $_;
626	# }
627	#
628	# $self->scr_overlay_new ($x, $y, $w, scalar @lines);	877	my $overlay = $self->overlay ($x, $y, $w, scalar @lines);
629	# $self->scr_overlay_set (0, $_, $lines[$_]) for 0.. $#lines;	878	$overlay->set (0, $_, $lines[$_]) for 0.. $#lines;
630	#}	879
		880	$overlay
		881	}
631		882
632	=item $term->overlay ($x, $y, $width, $height[, $rstyle[, $border]])	883	=item $term->overlay ($x, $y, $width, $height[, $rstyle[, $border]])
633		884
634	Create a new (empty) overlay at the given position with the given	885	Create a new (empty) overlay at the given position with the given
635	width/height. C<$rstyle> defines the initial rendition style	886	width/height. C<$rstyle> defines the initial rendition style
…		…
662		913
663	If hidden, display the overlay again.	914	If hidden, display the overlay again.
664		915
665	=back	916	=back
666		917
		918	=item $popup = $term->popup ($event)
		919
		920	Creates a new C<urxvt::popup> object that implements a popup menu. The
		921	C<$event> I<must> be the event causing the menu to pop up (a button event,
		922	currently).
		923
		924	=cut
		925
		926	sub popup {
		927	my ($self, $event) = @_;
		928
		929	$self->grab ($event->{time}, 1)
		930	or return;
		931
		932	my $popup = bless {
		933	term => $self,
		934	event => $event,
		935	}, urxvt::popup::;
		936
		937	Scalar::Util::weaken $popup->{term};
		938
		939	$self->{_destroy}{$popup} = urxvt::destroy_hook { $popup->{popup}->destroy };
		940	Scalar::Util::weaken $self->{_destroy}{$popup};
		941
		942	$popup
		943	}
		944
667	=item $cellwidth = $term->strwidth ($string)	945	=item $cellwidth = $term->strwidth ($string)
668		946
669	Returns the number of screen-cells this string would need. Correctly	947	Returns the number of screen-cells this string would need. Correctly
670	accounts for wide and combining characters.	948	accounts for wide and combining characters.
671		949
…		…
674	Convert the given text string into the corresponding locale encoding.	952	Convert the given text string into the corresponding locale encoding.
675		953
676	=item $string = $term->locale_decode ($octets)	954	=item $string = $term->locale_decode ($octets)
677		955
678	Convert the given locale-encoded octets into a perl string.	956	Convert the given locale-encoded octets into a perl string.
		957
		958	=item $term->scr_xor_span ($beg_row, $beg_col, $end_row, $end_col[, $rstyle])
		959
		960	XORs the rendition values in the given span with the provided value
		961	(default: C<RS_RVid>). Useful in refresh hooks to provide effects similar
		962	to the selection.
		963
		964	=item $term->scr_xor_rect ($beg_row, $beg_col, $end_row, $end_col[, $rstyle1[, $rstyle2]])
		965
		966	Similar to C<scr_xor_span>, but xors a rectangle instead. Trailing
		967	whitespace will additionally be xored with the C<$rstyle2>, which defaults
		968	to C<RS_RVid \| RS_Uline>, which removes reverse video again and underlines
		969	it instead.
		970
		971	=item $term->scr_bell
		972
		973	Ring the bell!
679		974
680	=item $term->scr_add_lines ($string)	975	=item $term->scr_add_lines ($string)
681		976
682	Write the given text string to the screen, as if output by the application	977	Write the given text string to the screen, as if output by the application
683	running inside the terminal. It may not contain command sequences (escape	978	running inside the terminal. It may not contain command sequences (escape
…		…
698		993
699	Write the octets given in C<$data> to the tty (i.e. as program input). To	994	Write the octets given in C<$data> to the tty (i.e. as program input). To
700	pass characters instead of octets, you should convert your strings first	995	pass characters instead of octets, you should convert your strings first
701	to the locale-specific encoding using C<< $term->locale_encode >>.	996	to the locale-specific encoding using C<< $term->locale_encode >>.
702		997
		998	=item $old_events = $term->pty_ev_events ([$new_events])
		999
		1000	Replaces the event mask of the pty watcher by the given event mask. Can
		1001	be used to suppress input and output handling to the pty/tty. See the
		1002	description of C<< urxvt::timer->events >>. Make sure to always restore
		1003	the previous value.
		1004
703	=item $windowid = $term->parent	1005	=item $windowid = $term->parent
704		1006
705	Return the window id of the toplevel window.	1007	Return the window id of the toplevel window.
706		1008
707	=item $windowid = $term->vt	1009	=item $windowid = $term->vt
…		…
731	=item $nrow_plus_saveLines = $term->total_rows	1033	=item $nrow_plus_saveLines = $term->total_rows
732		1034
733	=item $lines_in_scrollback = $term->nsaved	1035	=item $lines_in_scrollback = $term->nsaved
734		1036
735	Return various integers describing terminal characteristics.	1037	Return various integers describing terminal characteristics.
		1038
		1039	=item $lc_ctype = $term->locale
		1040
		1041	Returns the LC_CTYPE category string used by this rxvt-unicode.
		1042
		1043	=item $x_display = $term->display_id
		1044
		1045	Return the DISPLAY used by rxvt-unicode.
		1046
		1047	=item $modifiermask = $term->ModLevel3Mask
		1048
		1049	=item $modifiermask = $term->ModMetaMask
		1050
		1051	=item $modifiermask = $term->ModNumLockMask
		1052
		1053	Return the modifier masks corresponding to the "ISO Level 3 Shift" (often
		1054	AltGr), the meta key (often Alt) and the num lock key, if applicable.
736		1055
737	=item $view_start = $term->view_start ([$newvalue])	1056	=item $view_start = $term->view_start ([$newvalue])
738		1057
739	Returns the negative row number of the topmost line. Minimum value is	1058	Returns the negative row number of the topmost line. Minimum value is
740	C<0>, which displays the normal terminal contents. Larger values scroll	1059	C<0>, which displays the normal terminal contents. Larger values scroll
…		…
834		1153
835	=back	1154	=back
836		1155
837	=cut	1156	=cut
838		1157
839	sub urxvt::term::line {	1158	sub line {
840	my ($self, $row) = @_;	1159	my ($self, $row) = @_;
841		1160
842	my $maxrow = $self->nrow - 1;	1161	my $maxrow = $self->nrow - 1;
843		1162
844	my ($beg, $end) = ($row, $row);	1163	my ($beg, $end) = ($row, $row);
…		…
908	$offset / $self->{ncol} + $self->{beg},	1227	$offset / $self->{ncol} + $self->{beg},
909	$offset % $self->{ncol}	1228	$offset % $self->{ncol}
910	)	1229	)
911	}	1230	}
912		1231
913	=item ($row, $col) = $line->coord_of ($offset)
914	=item $text = $term->special_encode $string	1232	=item $text = $term->special_encode $string
915		1233
916	Converts a perl string into the special encoding used by rxvt-unicode,	1234	Converts a perl string into the special encoding used by rxvt-unicode,
917	where one character corresponds to one screen cell. See	1235	where one character corresponds to one screen cell. See
918	C<< $term->ROW_t >> for details.	1236	C<< $term->ROW_t >> for details.
…		…
920	=item $string = $term->special_decode $text	1238	=item $string = $term->special_decode $text
921		1239
922	Converts rxvt-unicodes text reprsentation into a perl string. See	1240	Converts rxvt-unicodes text reprsentation into a perl string. See
923	C<< $term->ROW_t >> for details.	1241	C<< $term->ROW_t >> for details.
924		1242
		1243	=item $success = $term->grab_button ($button, $modifiermask)
		1244
		1245	Registers a synchronous button grab. See the XGrabButton manpage.
		1246
		1247	=item $success = $term->grab ($eventtime[, $sync])
		1248
		1249	Calls XGrabPointer and XGrabKeyboard in asynchronous (default) or
		1250	synchronous (C<$sync> is true). Also remembers the grab timestampe.
		1251
		1252	=item $term->allow_events_async
		1253
		1254	Calls XAllowEvents with AsyncBoth for the most recent grab.
		1255
		1256	=item $term->allow_events_sync
		1257
		1258	Calls XAllowEvents with SyncBoth for the most recent grab.
		1259
		1260	=item $term->allow_events_replay
		1261
		1262	Calls XAllowEvents with both ReplayPointer and ReplayKeyboard for the most
		1263	recent grab.
		1264
		1265	=item $term->ungrab
		1266
		1267	Calls XUngrab for the most recent grab. Is called automatically on
		1268	evaluation errors, as it is better to lose the grab in the error case as
		1269	the session.
		1270
925	=back	1271	=back
		1272
		1273	=cut
		1274
		1275	package urxvt::popup;
		1276
		1277	=head2 The C<urxvt::popup> Class
		1278
		1279	=over 4
		1280
		1281	=cut
		1282
		1283	sub add_item {
		1284	my ($self, $item) = @_;
		1285
		1286	$item->{rend}{normal} = "\x1b[0;30;47m" unless exists $item->{rend}{normal};
		1287	$item->{rend}{hover} = "\x1b[0;30;46m" unless exists $item->{rend}{hover};
		1288	$item->{rend}{active} = "\x1b[m" unless exists $item->{rend}{active};
		1289
		1290	$item->{render} \|\|= sub { $_[0]{text} };
		1291
		1292	push @{ $self->{item} }, $item;
		1293	}
		1294
		1295	sub add_separator {
		1296	my ($self, $sep) = @_;
		1297
		1298	$sep \|\|= "=";
		1299
		1300	$self->add_item ({
		1301	rend => { normal => "\x1b[0;30;47m", hover => "\x1b[0;30;47m", active => "\x1b[0;30;47m" },
		1302	text => "",
		1303	render => sub { $sep x $self->{term}->ncol },
		1304	activate => sub { },
		1305	});
		1306	}
		1307
		1308	sub add_title {
		1309	my ($self, $title) = @_;
		1310
		1311	$self->add_item ({
		1312	rend => { normal => "\x1b[38;5;11;44m", hover => "\x1b[38;5;11;44m", active => "\x1b[38;5;11;44m" },
		1313	text => $title,
		1314	activate => sub { },
		1315	});
		1316	}
		1317
		1318	sub add_button {
		1319	my ($self, $text, $cb) = @_;
		1320
		1321	$self->add_item ({ type => "button", text => $text, activate => $cb});
		1322	}
		1323
		1324	sub add_toggle {
		1325	my ($self, $text, $cb, $value) = @_;
		1326
		1327	my $item; $item = {
		1328	type => "button",
		1329	text => " $text",
		1330	value => $value,
		1331	render => sub { ($_[0]{value} ? "* " : " ") . $text },
		1332	activate => sub { $cb->($_[0]{value} = !$_[0]{value}); },
		1333	};
		1334
		1335	$self->add_item ($item);
		1336	}
		1337
		1338	sub show {
		1339	my ($self) = @_;
		1340
		1341	local $urxvt::popup::self = $self;
		1342
		1343	local $ENV{LC_ALL} = $self->{term}->locale;
		1344
		1345	urxvt->new ("--perl-lib" => "", "--perl-ext-common" => "", "-pty-fd" => -1, "-sl" => 0, "-b" => 0,
		1346	"--transient-for" => $self->{term}->parent,
		1347	"-display" => $self->{term}->display_id,
		1348	"-pe" => "urxvt-popup")
		1349	or die "unable to create popup window\n";
		1350	}
		1351
		1352	sub DESTROY {
		1353	my ($self) = @_;
		1354
		1355	delete $self->{term}{_destroy}{$self};
		1356	$self->{term}->ungrab;
		1357	}
926		1358
927	=head2 The C<urxvt::timer> Class	1359	=head2 The C<urxvt::timer> Class
928		1360
929	This class implements timer watchers/events. Time is represented as a	1361	This class implements timer watchers/events. Time is represented as a
930	fractional number of seconds since the epoch. Example:	1362	fractional number of seconds since the epoch. Example:
…		…
983		1415
984	$term->{socket} = ...	1416	$term->{socket} = ...
985	$term->{iow} = urxvt::iow	1417	$term->{iow} = urxvt::iow
986	->new	1418	->new
987	->fd (fileno $term->{socket})	1419	->fd (fileno $term->{socket})
988	->events (1) # wait for read data	1420	->events (urxvt::EVENT_READ)
989	->start	1421	->start
990	->cb (sub {	1422	->cb (sub {
991	my ($iow, $revents) = @_;	1423	my ($iow, $revents) = @_;
992	# $revents must be 1 here, no need to check	1424	# $revents must be 1 here, no need to check
993	sysread $term->{socket}, my $buf, 8192	1425	sysread $term->{socket}, my $buf, 8192
…		…
1010		1442
1011	Set the filedescriptor (not handle) to watch.	1443	Set the filedescriptor (not handle) to watch.
1012		1444
1013	=item $iow = $iow->events ($eventmask)	1445	=item $iow = $iow->events ($eventmask)
1014		1446
1015	Set the event mask to watch. Bit #0 (value C<1>) enables watching for read	1447	Set the event mask to watch. The only allowed values are
1016	data, Bit #1 (value C<2>) enables watching for write data.	1448	C<urxvt::EVENT_READ> and C<urxvt::EVENT_WRITE>, which might be ORed
		1449	together, or C<urxvt::EVENT_NONE>.
1017		1450
1018	=item $iow = $iow->start	1451	=item $iow = $iow->start
1019		1452
1020	Start watching for requested events on the given handle.	1453	Start watching for requested events on the given handle.
1021		1454
…		…
1032	This variable controls the verbosity level of the perl extension. Higher	1465	This variable controls the verbosity level of the perl extension. Higher
1033	numbers indicate more verbose output.	1466	numbers indicate more verbose output.
1034		1467
1035	=over 4	1468	=over 4
1036		1469
1037	=item =0 - only fatal messages	1470	=item == 0 - fatal messages
1038		1471
1039	=item =3 - script loading and management	1472	=item >= 3 - script loading and management
1040		1473
1041	=item =10 - all events received	1474	=item >=10 - all events received
1042		1475
1043	=back	1476	=back
1044		1477
1045	=head1 AUTHOR	1478	=head1 AUTHOR
1046		1479

Diff Legend

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

Comparing rxvt-unicode/src/urxvt.pm (file contents): Revision 1.43 by root, Sat Jan 7 04:19:43 2006 UTC vs. Revision 1.74 by root, Tue Jan 10 04:26:54 2006 UTC

Diff Legend

Comparing rxvt-unicode/src/urxvt.pm (file contents):
Revision 1.43 by root, Sat Jan 7 04:19:43 2006 UTC vs.
Revision 1.74 by root, Tue Jan 10 04:26:54 2006 UTC