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

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.73 by root, Tue Jan 10 04:23:39 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.73 by root, Tue Jan 10 04:23:39 2006 UTC