[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.72 by root, Mon Jan 9 23:30:01 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;
394	our $LIBDIR;	467	our $LIBDIR;
395		468
396	BEGIN {	469	BEGIN {
397	urxvt->bootstrap;	470	urxvt->bootstrap;
398		471
…		…
401	my $msg = join "", @_;	474	my $msg = join "", @_;
402	$msg .= "\n"	475	$msg .= "\n"
403	unless $msg =~ /\n$/;	476	unless $msg =~ /\n$/;
404	urxvt::warn ($msg);	477	urxvt::warn ($msg);
405	};	478	};
		479
		480	delete $ENV{IFS};
		481	delete $ENV{CDPATH};
		482	delete $ENV{BASH_ENV};
		483	$ENV{PATH} = "/bin:/sbin:/usr/bin:/usr/sbin:/usr/local/bin:/usr/local/sbin:/opt/bin:/opt/sbin";
406	}	484	}
407		485
408	my @hook_count;	486	my @hook_count;
409	my $verbosity = $ENV{URXVT_PERL_VERBOSITY};	487	my $verbosity = $ENV{URXVT_PERL_VERBOSITY};
410		488
411	sub verbose {	489	sub verbose {
412	my ($level, $msg) = @_;	490	my ($level, $msg) = @_;
413	warn "$msg\n" if $level <= $verbosity;	491	warn "$msg\n" if $level <= $verbosity;
414	}	492	}
415		493
416	# find on_xxx subs in the package and register them	494	my $extension_pkg = "extension0000";
417	# as hooks	495	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		496
436	# load a single script into its own package, once only	497	# load a single script into its own package, once only
437	sub script_package($) {	498	sub extension_package($) {
438	my ($path) = @_;	499	my ($path) = @_;
439		500
440	$script_pkg{$path} \|\|= do {	501	$extension_pkg{$path} \|\|= do {
441	my $pkg = "urxvt::" . ($script_pkg++);	502	my $pkg = "urxvt::" . ($extension_pkg++);
442		503
443	verbose 3, "loading script '$path' into package '$pkg'";	504	verbose 3, "loading extension '$path' into package '$pkg'";
444		505
445	open my $fh, "<:raw", $path	506	open my $fh, "<:raw", $path
446	or die "$path: $!";	507	or die "$path: $!";
447		508
		509	my $source = untaint
448	my $source = "package $pkg; use strict; use utf8;\n"	510	"package $pkg; use strict; use utf8;\n"
		511	. "use base urxvt::term::extension::;\n"
449	. "#line 1 \"$path\"\n{\n"	512	. "#line 1 \"$path\"\n{\n"
450	. (do { local $/; <$fh> })	513	. (do { local $/; <$fh> })
451	. "\n};\n1";	514	. "\n};\n1";
452		515
		516	eval $source
453	eval $source or die "$path: $@";	517	or die "$path: $@";
454		518
455	$pkg	519	$pkg
456	}	520	}
457	}	521	}
458		522
…		…
463	local $TERM = shift;	527	local $TERM = shift;
464	my $htype = shift;	528	my $htype = shift;
465		529
466	if ($htype == 0) { # INIT	530	if ($htype == 0) { # INIT
467	my @dirs = ((split /:/, $TERM->resource ("perl_lib")), "$LIBDIR/perl");	531	my @dirs = ((split /:/, $TERM->resource ("perl_lib")), "$LIBDIR/perl");
		532
		533	my %ext_arg;
468		534
469	for my $ext (map { split /,/, $TERM->resource ("perl_ext_$_") } 1, 2) {	535	for (map { split /,/, $TERM->resource ("perl_ext_$_") } 1, 2) {
		536	if ($_ eq "default") {
		537	$ext_arg{$_} \|\|= [] for qw(selection option-popup selection-popup searchable-scrollback);
		538	} elsif (/^-(.*)$/) {
		539	delete $ext_arg{$1};
		540	} elsif (/^([^<]+)<(.*)>$/) {
		541	push @{ $ext_arg{$1} }, $2;
		542	} else {
		543	$ext_arg{$_} \|\|= [];
		544	}
		545	}
		546
		547	while (my ($ext, $argv) = each %ext_arg) {
470	my @files = grep -f $_, map "$_/$ext", @dirs;	548	my @files = grep -f $_, map "$_/$ext", @dirs;
471		549
472	if (@files) {	550	if (@files) {
473	register_package script_package $files[0];	551	$TERM->register_package (extension_package $files[0], $argv);
474	} else {	552	} else {
475	warn "perl extension '$ext' not found in perl library search path\n";	553	warn "perl extension '$ext' not found in perl library search path\n";
476	}	554	}
477	}	555	}
		556
		557	eval "#line 1 \"--perl-eval resource/argument\"\n" . $TERM->resource ("perl_eval");
		558	warn $@ if $@;
478	}	559	}
479		560
480	$retval = undef;	561	$retval = undef;
481		562
482	if (my $cb = $TERM->{_hook}[$htype]) {	563	if (my $cb = $TERM->{_hook}[$htype]) {
…		…
484	if $verbosity >= 10;	565	if $verbosity >= 10;
485		566
486	keys %$cb;	567	keys %$cb;
487		568
488	while (my ($pkg, $cb) = each %$cb) {	569	while (my ($pkg, $cb) = each %$cb) {
489	$retval = $cb->(	570	$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;	571	and last;
		572
		573	if ($@) {
		574	$TERM->ungrab; # better to lose the grab than the session
		575	warn $@;
		576	}
497	}	577	}
498	}	578	}
499		579
500	if ($htype == 1) { # DESTROY	580	if ($htype == 1) { # DESTROY
501	# remove hooks if unused
502	if (my $hook = $TERM->{_hook}) {	581	if (my $hook = delete $TERM->{_hook}) {
503	for my $htype (0..$#$hook) {	582	for my $htype (0..$#$hook) {
504	$hook_count[$htype] -= scalar keys %{ $hook->[$htype] \|\| {} }	583	$hook_count[$htype] -= scalar keys %{ $hook->[$htype] \|\| {} }
505	or set_should_invoke $htype, 0;	584	or set_should_invoke $htype, 0;
506	}	585	}
507	}	586	}
…		…
514	}	593	}
515		594
516	$retval	595	$retval
517	}	596	}
518		597
519	sub urxvt::term::proxy::AUTOLOAD {	598	# urxvt::term::extension
520	$urxvt::term::proxy::AUTOLOAD =~ /:([^:]+)$/	599
		600	package urxvt::term::extension;
		601
		602	sub enable {
		603	my ($self, %hook) = @_;
		604	my $pkg = $self->{_pkg};
		605
		606	while (my ($name, $cb) = each %hook) {
		607	my $htype = $HOOKTYPE{uc $name};
		608	defined $htype
		609	or Carp::croak "unsupported hook type '$name'";
		610
		611	unless (exists $self->{term}{_hook}[$htype]{$pkg}) {
		612	$hook_count[$htype]++
		613	or urxvt::set_should_invoke $htype, 1;
		614	}
		615
		616	$self->{term}{_hook}[$htype]{$pkg} = $cb;
		617	}
		618	}
		619
		620	sub disable {
		621	my ($self, @hook) = @_;
		622	my $pkg = $self->{_pkg};
		623
		624	for my $name (@hook) {
		625	my $htype = $HOOKTYPE{uc $name};
		626	defined $htype
		627	or Carp::croak "unsupported hook type '$name'";
		628
		629	if (delete $self->{term}{_hook}[$htype]{$pkg}) {
		630	--$hook_count[$htype]
		631	or urxvt::set_should_invoke $htype, 0;
		632	}
		633	}
		634	}
		635
		636	our $AUTOLOAD;
		637
		638	sub AUTOLOAD {
		639	$AUTOLOAD =~ /:([^:]+)$/
521	or die "FATAL: \$AUTOLOAD '$urxvt::term::proxy::AUTOLOAD' unparsable";	640	or die "FATAL: \$AUTOLOAD '$AUTOLOAD' unparsable";
522		641
523	eval qq{	642	eval qq{
524	sub $urxvt::term::proxy::AUTOLOAD {	643	sub $AUTOLOAD {
525	my \$proxy = shift;	644	my \$proxy = shift;
526	\$proxy->{term}->$1 (\@_)	645	\$proxy->{term}->$1 (\@_)
527	}	646	}
528	1	647	1
529	} or die "FATAL: unable to compile method forwarder: $@";	648	} or die "FATAL: unable to compile method forwarder: $@";
530		649
531	goto &$urxvt::term::proxy::AUTOLOAD;	650	goto &$AUTOLOAD;
532	}	651	}
		652
		653	sub DESTROY {
		654	# nop
		655	}
		656
		657	# urxvt::destroy_hook
		658
		659	sub urxvt::destroy_hook::DESTROY {
		660	${$_[0]}->();
		661	}
		662
		663	sub urxvt::destroy_hook(&) {
		664	bless \shift, urxvt::destroy_hook::
		665	}
		666
		667	package urxvt::anyevent;
		668
		669	=head2 The C<urxvt::anyevent> Class
		670
		671	The sole purpose of this class is to deliver an interface to the
		672	C<AnyEvent> module - any module using it will work inside urxvt without
		673	further work. The only exception is that you cannot wait on condition
		674	variables, but non-blocking condvar use is ok. What this means is that you
		675	cannot use blocking APIs, but the non-blocking variant should work.
		676
		677	=cut
		678
		679	our $VERSION = 1;
		680
		681	$INC{"urxvt/anyevent.pm"} = 1; # mark us as there
		682	push @AnyEvent::REGISTRY, [urxvt => urxvt::anyevent::];
		683
		684	sub timer {
		685	my ($class, %arg) = @_;
		686
		687	my $cb = $arg{cb};
		688
		689	urxvt::timer
		690	->new
		691	->start (urxvt::NOW + $arg{after})
		692	->cb (sub {
		693	$_[0]->stop; # need to cancel manually
		694	$cb->();
		695	})
		696	}
		697
		698	sub io {
		699	my ($class, %arg) = @_;
		700
		701	my $cb = $arg{cb};
		702
		703	bless [$arg{fh}, urxvt::iow
		704	->new
		705	->fd (fileno $arg{fh})
		706	->events (($arg{poll} =~ /r/ ? 1 : 0)
		707	\| ($arg{poll} =~ /w/ ? 2 : 0))
		708	->start
		709	->cb (sub {
		710	$cb->(($_[1] & 1 ? 'r' : '')
		711	. ($_[1] & 2 ? 'w' : ''));
		712	})],
		713	urxvt::anyevent::
		714	}
		715
		716	sub DESTROY {
		717	$_[0][1]->stop;
		718	}
		719
		720	sub condvar {
		721	bless \my $flag, urxvt::anyevent::condvar::
		722	}
		723
		724	sub urxvt::anyevent::condvar::broadcast {
		725	${$_[0]}++;
		726	}
		727
		728	sub urxvt::anyevent::condvar::wait {
		729	unless (${$_[0]}) {
		730	Carp::croak "AnyEvent->condvar blocking wait unsupported in urxvt, use a non-blocking API";
		731	}
		732	}
		733
		734	package urxvt::term;
533		735
534	=head2 The C<urxvt::term> Class	736	=head2 The C<urxvt::term> Class
535		737
536	=over 4	738	=over 4
537		739
		740	=cut
		741
		742	# find on_xxx subs in the package and register them
		743	# as hooks
		744	sub register_package {
		745	my ($self, $pkg, $argv) = @_;
		746
		747	my $proxy = bless {
		748	_pkg => $pkg,
		749	argv => $argv,
		750	}, $pkg;
		751	Scalar::Util::weaken ($proxy->{term} = $self);
		752
		753	$self->{_pkg}{$pkg} = $proxy;
		754
		755	for my $name (@HOOKNAME) {
		756	if (my $ref = $pkg->can ("on_" . lc $name)) {
		757	$proxy->enable ($name => $ref);
		758	}
		759	}
		760	}
		761
538	=item $term->destroy	762	=item $term->destroy
539		763
540	Destroy the terminal object (close the window, free resources etc.).	764	Destroy the terminal object (close the window, free resources etc.).
		765
		766	=item $isset = $term->option ($optval[, $set])
		767
		768	Returns true if the option specified by C<$optval> is enabled, and
		769	optionally change it. All option values are stored by name in the hash
		770	C<%urxvt::OPTION>. Options not enabled in this binary are not in the hash.
		771
		772	Here is a a likely non-exhaustive list of option names, please see the
		773	source file F</src/optinc.h> to see the actual list:
		774
		775	borderLess console cursorBlink cursorUnderline hold iconic insecure
		776	intensityStyles jumpScroll loginShell mapAlert meta8 mouseWheelScrollPage
		777	pastableTabs pointerBlank reverseVideo scrollBar scrollBar_floating
		778	scrollBar_right scrollTtyKeypress scrollTtyOutput scrollWithBuffer
		779	secondaryScreen secondaryScroll skipBuiltinGlyphs transparent
		780	tripleclickwords utmpInhibit visualBell
541		781
542	=item $value = $term->resource ($name[, $newval])	782	=item $value = $term->resource ($name[, $newval])
543		783
544	Returns the current resource value associated with a given name and	784	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>	785	optionally sets a new value. Setting values is most useful in the C<init>
…		…
555		795
556	Please note that resource strings will currently only be freed when the	796	Please note that resource strings will currently only be freed when the
557	terminal is destroyed, so changing options frequently will eat memory.	797	terminal is destroyed, so changing options frequently will eat memory.
558		798
559	Here is a a likely non-exhaustive list of resource names, not all of which	799	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	800	are supported in every build, please see the source file F</src/rsinc.h>
561	list:	801	to see the actual list:
562		802
563	answerbackstring backgroundPixmap backspace_key boldFont boldItalicFont	803	answerbackstring backgroundPixmap backspace_key boldFont boldItalicFont
564	borderLess color cursorBlink cursorUnderline cutchars delete_key	804	borderLess color cursorBlink cursorUnderline cutchars delete_key
565	display_name embed ext_bwidth fade font geometry hold iconName	805	display_name embed ext_bwidth fade font geometry hold iconName
566	imFont imLocale inputMethod insecure int_bwidth intensityStyles	806	imFont imLocale inputMethod insecure int_bwidth intensityStyles
…		…
573	shade term_name title transparent transparent_all tripleclickwords	813	shade term_name title transparent transparent_all tripleclickwords
574	utmpInhibit visualBell	814	utmpInhibit visualBell
575		815
576	=cut	816	=cut
577		817
578	sub urxvt::term::resource($$;$) {	818	sub resource($$;$) {
579	my ($self, $name) = (shift, shift);	819	my ($self, $name) = (shift, shift);
580	unshift @_, $self, $name, ($name =~ s/\s\+\s(\d+)$// ? $1 : 0);	820	unshift @_, $self, $name, ($name =~ s/\s\+\s(\d+)$// ? $1 : 0);
581	goto &urxvt::term::_resource;	821	&urxvt::term::_resource
582	}	822	}
		823
		824	=item $success = $term->parse_keysym ($keysym_spec, $command_string)
		825
		826	Adds a keymap translation exactly as specified via a resource. See the
		827	C<keysym> resource in the @@RXVT_NAME@@(1) manpage.
583		828
584	=item $rend = $term->rstyle ([$new_rstyle])	829	=item $rend = $term->rstyle ([$new_rstyle])
585		830
586	Return and optionally change the current rendition. Text that is output by	831	Return and optionally change the current rendition. Text that is output by
587	the terminal application will use this style.	832	the terminal application will use this style.
…		…
607		852
608	=item $oldtext = $term->selection ([$newtext])	853	=item $oldtext = $term->selection ([$newtext])
609		854
610	Return the current selection text and optionally replace it by C<$newtext>.	855	Return the current selection text and optionally replace it by C<$newtext>.
611		856
612	#=item $term->overlay ($x, $y, $text)	857	=item $term->overlay_simple ($x, $y, $text)
613	#	858
614	#Create a simple multi-line overlay box. See the next method for details.	859	Create a simple multi-line overlay box. See the next method for details.
615	#	860
616	#=cut	861	=cut
617	#	862
618	#sub urxvt::term::scr_overlay {	863	sub overlay_simple {
619	# my ($self, $x, $y, $text) = @_;	864	my ($self, $x, $y, $text) = @_;
620	#	865
621	# my @lines = split /\n/, $text;	866	my @lines = split /\n/, $text;
622	#	867
623	# my $w = 0;	868	my $w = List::Util::max map $self->strwidth ($_), @lines;
624	# for (map $self->strwidth ($_), @lines) {	869
625	# $w = $_ if $w < $_;
626	# }
627	#
628	# $self->scr_overlay_new ($x, $y, $w, scalar @lines);	870	my $overlay = $self->overlay ($x, $y, $w, scalar @lines);
629	# $self->scr_overlay_set (0, $_, $lines[$_]) for 0.. $#lines;	871	$overlay->set (0, $_, $lines[$_]) for 0.. $#lines;
630	#}	872
		873	$overlay
		874	}
631		875
632	=item $term->overlay ($x, $y, $width, $height[, $rstyle[, $border]])	876	=item $term->overlay ($x, $y, $width, $height[, $rstyle[, $border]])
633		877
634	Create a new (empty) overlay at the given position with the given	878	Create a new (empty) overlay at the given position with the given
635	width/height. C<$rstyle> defines the initial rendition style	879	width/height. C<$rstyle> defines the initial rendition style
…		…
662		906
663	If hidden, display the overlay again.	907	If hidden, display the overlay again.
664		908
665	=back	909	=back
666		910
		911	=item $popup = $term->popup ($event)
		912
		913	Creates a new C<urxvt::popup> object that implements a popup menu. The
		914	C<$event> I<must> be the event causing the menu to pop up (a button event,
		915	currently).
		916
		917	=cut
		918
		919	sub popup {
		920	my ($self, $event) = @_;
		921
		922	$self->grab ($event->{time}, 1)
		923	or return;
		924
		925	my $popup = bless {
		926	term => $self,
		927	event => $event,
		928	}, urxvt::popup::;
		929
		930	Scalar::Util::weaken $popup->{term};
		931
		932	$self->{_destroy}{$popup} = urxvt::destroy_hook { $popup->{popup}->destroy };
		933	Scalar::Util::weaken $self->{_destroy}{$popup};
		934
		935	$popup
		936	}
		937
667	=item $cellwidth = $term->strwidth ($string)	938	=item $cellwidth = $term->strwidth ($string)
668		939
669	Returns the number of screen-cells this string would need. Correctly	940	Returns the number of screen-cells this string would need. Correctly
670	accounts for wide and combining characters.	941	accounts for wide and combining characters.
671		942
…		…
674	Convert the given text string into the corresponding locale encoding.	945	Convert the given text string into the corresponding locale encoding.
675		946
676	=item $string = $term->locale_decode ($octets)	947	=item $string = $term->locale_decode ($octets)
677		948
678	Convert the given locale-encoded octets into a perl string.	949	Convert the given locale-encoded octets into a perl string.
		950
		951	=item $term->scr_xor_span ($beg_row, $beg_col, $end_row, $end_col[, $rstyle])
		952
		953	XORs the rendition values in the given span with the provided value
		954	(default: C<RS_RVid>). Useful in refresh hooks to provide effects similar
		955	to the selection.
		956
		957	=item $term->scr_xor_rect ($beg_row, $beg_col, $end_row, $end_col[, $rstyle1[, $rstyle2]])
		958
		959	Similar to C<scr_xor_span>, but xors a rectangle instead. Trailing
		960	whitespace will additionally be xored with the C<$rstyle2>, which defaults
		961	to C<RS_RVid \| RS_Uline>, which removes reverse video again and underlines
		962	it instead.
		963
		964	=item $term->scr_bell
		965
		966	Ring the bell!
679		967
680	=item $term->scr_add_lines ($string)	968	=item $term->scr_add_lines ($string)
681		969
682	Write the given text string to the screen, as if output by the application	970	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	971	running inside the terminal. It may not contain command sequences (escape
…		…
698		986
699	Write the octets given in C<$data> to the tty (i.e. as program input). To	987	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	988	pass characters instead of octets, you should convert your strings first
701	to the locale-specific encoding using C<< $term->locale_encode >>.	989	to the locale-specific encoding using C<< $term->locale_encode >>.
702		990
		991	=item $old_events = $term->pty_ev_events ([$new_events])
		992
		993	Replaces the event mask of the pty watcher by the given event mask. Can
		994	be used to suppress input and output handling to the pty/tty. See the
		995	description of C<< urxvt::timer->events >>. Make sure to always restore
		996	the previous value.
		997
703	=item $windowid = $term->parent	998	=item $windowid = $term->parent
704		999
705	Return the window id of the toplevel window.	1000	Return the window id of the toplevel window.
706		1001
707	=item $windowid = $term->vt	1002	=item $windowid = $term->vt
…		…
731	=item $nrow_plus_saveLines = $term->total_rows	1026	=item $nrow_plus_saveLines = $term->total_rows
732		1027
733	=item $lines_in_scrollback = $term->nsaved	1028	=item $lines_in_scrollback = $term->nsaved
734		1029
735	Return various integers describing terminal characteristics.	1030	Return various integers describing terminal characteristics.
		1031
		1032	=item $lc_ctype = $term->locale
		1033
		1034	Returns the LC_CTYPE category string used by this rxvt-unicode.
		1035
		1036	=item $x_display = $term->display_id
		1037
		1038	Return the DISPLAY used by rxvt-unicode.
		1039
		1040	=item $modifiermask = $term->ModLevel3Mask
		1041
		1042	=item $modifiermask = $term->ModMetaMask
		1043
		1044	=item $modifiermask = $term->ModNumLockMask
		1045
		1046	Return the modifier masks corresponding to the "ISO Level 3 Shift" (often
		1047	AltGr), the meta key (often Alt) and the num lock key, if applicable.
736		1048
737	=item $view_start = $term->view_start ([$newvalue])	1049	=item $view_start = $term->view_start ([$newvalue])
738		1050
739	Returns the negative row number of the topmost line. Minimum value is	1051	Returns the negative row number of the topmost line. Minimum value is
740	C<0>, which displays the normal terminal contents. Larger values scroll	1052	C<0>, which displays the normal terminal contents. Larger values scroll
…		…
834		1146
835	=back	1147	=back
836		1148
837	=cut	1149	=cut
838		1150
839	sub urxvt::term::line {	1151	sub line {
840	my ($self, $row) = @_;	1152	my ($self, $row) = @_;
841		1153
842	my $maxrow = $self->nrow - 1;	1154	my $maxrow = $self->nrow - 1;
843		1155
844	my ($beg, $end) = ($row, $row);	1156	my ($beg, $end) = ($row, $row);
…		…
908	$offset / $self->{ncol} + $self->{beg},	1220	$offset / $self->{ncol} + $self->{beg},
909	$offset % $self->{ncol}	1221	$offset % $self->{ncol}
910	)	1222	)
911	}	1223	}
912		1224
913	=item ($row, $col) = $line->coord_of ($offset)
914	=item $text = $term->special_encode $string	1225	=item $text = $term->special_encode $string
915		1226
916	Converts a perl string into the special encoding used by rxvt-unicode,	1227	Converts a perl string into the special encoding used by rxvt-unicode,
917	where one character corresponds to one screen cell. See	1228	where one character corresponds to one screen cell. See
918	C<< $term->ROW_t >> for details.	1229	C<< $term->ROW_t >> for details.
…		…
920	=item $string = $term->special_decode $text	1231	=item $string = $term->special_decode $text
921		1232
922	Converts rxvt-unicodes text reprsentation into a perl string. See	1233	Converts rxvt-unicodes text reprsentation into a perl string. See
923	C<< $term->ROW_t >> for details.	1234	C<< $term->ROW_t >> for details.
924		1235
		1236	=item $success = $term->grab_button ($button, $modifiermask)
		1237
		1238	Registers a synchronous button grab. See the XGrabButton manpage.
		1239
		1240	=item $success = $term->grab ($eventtime[, $sync])
		1241
		1242	Calls XGrabPointer and XGrabKeyboard in asynchronous (default) or
		1243	synchronous (C<$sync> is true). Also remembers the grab timestampe.
		1244
		1245	=item $term->allow_events_async
		1246
		1247	Calls XAllowEvents with AsyncBoth for the most recent grab.
		1248
		1249	=item $term->allow_events_sync
		1250
		1251	Calls XAllowEvents with SyncBoth for the most recent grab.
		1252
		1253	=item $term->allow_events_replay
		1254
		1255	Calls XAllowEvents with both ReplayPointer and ReplayKeyboard for the most
		1256	recent grab.
		1257
		1258	=item $term->ungrab
		1259
		1260	Calls XUngrab for the most recent grab. Is called automatically on
		1261	evaluation errors, as it is better to lose the grab in the error case as
		1262	the session.
		1263
925	=back	1264	=back
		1265
		1266	=cut
		1267
		1268	package urxvt::popup;
		1269
		1270	=head2 The C<urxvt::popup> Class
		1271
		1272	=over 4
		1273
		1274	=cut
		1275
		1276	sub add_item {
		1277	my ($self, $item) = @_;
		1278
		1279	$item->{rend}{normal} = "\x1b[0;30;47m" unless exists $item->{rend}{normal};
		1280	$item->{rend}{hover} = "\x1b[0;30;46m" unless exists $item->{rend}{hover};
		1281	$item->{rend}{active} = "\x1b[m" unless exists $item->{rend}{active};
		1282
		1283	$item->{render} \|\|= sub { $_[0]{text} };
		1284
		1285	push @{ $self->{item} }, $item;
		1286	}
		1287
		1288	sub add_separator {
		1289	my ($self, $sep) = @_;
		1290
		1291	$sep \|\|= "=";
		1292
		1293	$self->add_item ({
		1294	rend => { normal => "\x1b[0;30;47m", hover => "\x1b[0;30;47m", active => "\x1b[0;30;47m" },
		1295	text => "",
		1296	render => sub { $sep x $self->{term}->ncol },
		1297	activate => sub { },
		1298	});
		1299	}
		1300
		1301	sub add_title {
		1302	my ($self, $title) = @_;
		1303
		1304	$self->add_item ({
		1305	rend => { normal => "\x1b[38;5;11;44m", hover => "\x1b[38;5;11;44m", active => "\x1b[38;5;11;44m" },
		1306	text => $title,
		1307	activate => sub { },
		1308	});
		1309	}
		1310
		1311	sub add_button {
		1312	my ($self, $text, $cb) = @_;
		1313
		1314	$self->add_item ({ type => "button", text => $text, activate => $cb});
		1315	}
		1316
		1317	sub add_toggle {
		1318	my ($self, $text, $cb, $value) = @_;
		1319
		1320	my $item; $item = {
		1321	type => "button",
		1322	text => " $text",
		1323	value => $value,
		1324	render => sub { ($_[0]{value} ? "* " : " ") . $text },
		1325	activate => sub { $cb->($_[0]{value} = !$_[0]{value}); },
		1326	};
		1327
		1328	$self->add_item ($item);
		1329	}
		1330
		1331	sub show {
		1332	my ($self) = @_;
		1333
		1334	local $urxvt::popup::self = $self;
		1335
		1336	local $ENV{LC_ALL} = $self->{term}->locale;
		1337
		1338	urxvt->new ("--perl-lib" => "", "--perl-ext-common" => "", "-pty-fd" => -1, "-sl" => 0, "-b" => 0,
		1339	"--transient-for" => $self->{term}->parent,
		1340	"-display" => $self->{term}->display_id,
		1341	"-pe" => "urxvt-popup")
		1342	or die "unable to create popup window\n";
		1343	}
		1344
		1345	sub DESTROY {
		1346	my ($self) = @_;
		1347
		1348	delete $self->{term}{_destroy}{$self};
		1349	$self->{term}->ungrab;
		1350	}
926		1351
927	=head2 The C<urxvt::timer> Class	1352	=head2 The C<urxvt::timer> Class
928		1353
929	This class implements timer watchers/events. Time is represented as a	1354	This class implements timer watchers/events. Time is represented as a
930	fractional number of seconds since the epoch. Example:	1355	fractional number of seconds since the epoch. Example:
…		…
983		1408
984	$term->{socket} = ...	1409	$term->{socket} = ...
985	$term->{iow} = urxvt::iow	1410	$term->{iow} = urxvt::iow
986	->new	1411	->new
987	->fd (fileno $term->{socket})	1412	->fd (fileno $term->{socket})
988	->events (1) # wait for read data	1413	->events (urxvt::EVENT_READ)
989	->start	1414	->start
990	->cb (sub {	1415	->cb (sub {
991	my ($iow, $revents) = @_;	1416	my ($iow, $revents) = @_;
992	# $revents must be 1 here, no need to check	1417	# $revents must be 1 here, no need to check
993	sysread $term->{socket}, my $buf, 8192	1418	sysread $term->{socket}, my $buf, 8192
…		…
1010		1435
1011	Set the filedescriptor (not handle) to watch.	1436	Set the filedescriptor (not handle) to watch.
1012		1437
1013	=item $iow = $iow->events ($eventmask)	1438	=item $iow = $iow->events ($eventmask)
1014		1439
1015	Set the event mask to watch. Bit #0 (value C<1>) enables watching for read	1440	Set the event mask to watch. The only allowed values are
1016	data, Bit #1 (value C<2>) enables watching for write data.	1441	C<urxvt::EVENT_READ> and C<urxvt::EVENT_WRITE>, which might be ORed
		1442	together, or C<urxvt::EVENT_NONE>.
1017		1443
1018	=item $iow = $iow->start	1444	=item $iow = $iow->start
1019		1445
1020	Start watching for requested events on the given handle.	1446	Start watching for requested events on the given handle.
1021		1447
…		…
1032	This variable controls the verbosity level of the perl extension. Higher	1458	This variable controls the verbosity level of the perl extension. Higher
1033	numbers indicate more verbose output.	1459	numbers indicate more verbose output.
1034		1460
1035	=over 4	1461	=over 4
1036		1462
1037	=item =0 - only fatal messages	1463	=item == 0 - fatal messages
1038		1464
1039	=item =3 - script loading and management	1465	=item >= 3 - script loading and management
1040		1466
1041	=item =10 - all events received	1467	=item >=10 - all events received
1042		1468
1043	=back	1469	=back
1044		1470
1045	=head1 AUTHOR	1471	=head1 AUTHOR
1046		1472

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.72 by root, Mon Jan 9 23:30:01 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.72 by root, Mon Jan 9 23:30:01 2006 UTC