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

Comparing rxvt-unicode/src/urxvt.pm (file contents):
Revision 1.39 by root, Fri Jan 6 05:28:55 2006 UTC vs.
Revision 1.71 by root, Mon Jan 9 23:18:49 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>.
…		…
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		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.
		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
65	=item mark-urls	83	=item mark-urls
66		84
67	Uses per-line filtering (C<on_line_update>) to underline urls.	85	Uses per-line display filtering (C<on_line_update>) to underline urls.
		86
		87	=item block-graphics-to-ascii
		88
		89	A not very useful example of filtering all text output to the terminal,
		90	by replacing all line-drawing characters (U+2500 .. U+259F) by a
		91	similar-looking ascii character.
68		92
69	=item example-refresh-hooks	93	=item example-refresh-hooks
70		94
71	Displays a very simple digital clock in the upper right corner of the	95	Displays a very simple digital clock in the upper right corner of the
72	window. Illustrates overwriting the refresh callbacks to create your own	96	window. Illustrates overwriting the refresh callbacks to create your own
73	overlays or changes.	97	overlays or changes.
74
75	=item example-filter-input
76
77	A not very useful example of filtering all text output to the terminal, by
78	underlining all urls that matches a certain regex (i.e. some urls :). It
79	is not very useful because urls that are output in multiple steps (e.g.
80	when typing them) do not get marked.
81		98
82	=back	99	=back
83		100
84	=head2 General API Considerations	101	=head2 General API Considerations
85		102
…		…
115	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
116	locale-specific way.	133	locale-specific way.
117		134
118	=back	135	=back
119		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
120	=head2 Hooks	170	=head2 Hooks
121		171
122	The following subroutines can be declared in loaded scripts, and will be	172	The following subroutines can be declared in extension files, and will be
123	called whenever the relevant event happens.	173	called whenever the relevant event happens.
124		174
125	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
126	and extension package. You can call all C<urxvt::term> methods on it, but	176	the in the C<Extension Objects> section.
127	its not a real C<urxvt::term> object. Instead, the real C<urxvt::term>
128	object that is shared between all packages is stored in the C<term>
129	member.
130		177
131	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
132	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
133	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.
134		181
135	When in doubt, return a false value (preferably C<()>).	182	I<< When in doubt, return a false value (preferably C<()>). >>
136		183
137	=over 4	184	=over 4
138		185
139	=item on_init $term	186	=item on_init $term
140		187
…		…
179	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
180	processing.	227	processing.
181		228
182	See the F<selection> example extension.	229	See the F<selection> example extension.
183		230
184	=item on_focus_in $term
185
186	Called whenever the window gets the keyboard focus, before urxvt does
187	focus in processing.
188
189	=item on_focus_out $term
190
191	Called wheneever the window loses keyboard focus, before urxvt does focus
192	out processing.
193
194	=item on_view_change $term, $offset	231	=item on_view_change $term, $offset
195		232
196	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
197	scrolls. Offset C<0> means display the normal terminal, positive values	234	scrolls. Offset C<0> means display the normal terminal, positive values
198	show this many lines of scrollback.	235	show this many lines of scrollback.
…		…
204	than the scroll back buffer or the terminal.	241	than the scroll back buffer or the terminal.
205		242
206	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,
207	$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
208	number of lines that will be in the scrollback buffer.	245	number of lines that will be in the scrollback buffer.
209
210	=item on_tty_activity $term NYI
211
212	Called whenever the program(s) running in the urxvt window send output.
213		246
214	=item on_osc_seq $term, $string	247	=item on_osc_seq $term, $string
215		248
216	Called whenever the B<ESC ] 777 ; string ST> command sequence (OSC =	249	Called whenever the B<ESC ] 777 ; string ST> command sequence (OSC =
217	operating system command) is processed. Cursor position and other state	250	operating system command) is processed. Cursor position and other state
…		…
261		294
262	Called whenever the user presses a key combination that has a	295	Called whenever the user presses a key combination that has a
263	C<perl:string> action bound to it (see description of the B<keysym>	296	C<perl:string> action bound to it (see description of the B<keysym>
264	resource in the @@RXVT_NAME@@(1) manpage).	297	resource in the @@RXVT_NAME@@(1) manpage).
265		298
		299	=item on_focus_in $term
		300
		301	Called whenever the window gets the keyboard focus, before rxvt-unicode
		302	does focus in processing.
		303
		304	=item on_focus_out $term
		305
		306	Called wheneever the window loses keyboard focus, before rxvt-unicode does
		307	focus out processing.
		308
266	=item on_key_press $term, $event, $octets	309	=item on_key_press $term, $event, $keysym, $octets
267		310
268	=item on_key_release $term, $event	311	=item on_key_release $term, $event, $keysym
269		312
270	=item on_button_press $term, $event	313	=item on_button_press $term, $event
271		314
272	=item on_button_release $term, $event	315	=item on_button_release $term, $event
273		316
274	=item on_motion_notify $term, $event	317	=item on_motion_notify $term, $event
		318
		319	=item on_map_notify $term, $event
		320
		321	=item on_unmap_notify $term, $event
275		322
276	Called whenever the corresponding X event is received for the terminal If	323	Called whenever the corresponding X event is received for the terminal If
277	the hook returns true, then the even will be ignored by rxvt-unicode.	324	the hook returns true, then the even will be ignored by rxvt-unicode.
278		325
279	The event is a hash with most values as named by Xlib (see the XEvent	326	The event is a hash with most values as named by Xlib (see the XEvent
…		…
291		338
292	=over 4	339	=over 4
293		340
294	=item $urxvt::TERM	341	=item $urxvt::TERM
295		342
296	The current terminal. Whenever a callback/Hook is bein executed, this	343	The current terminal. This variable stores the current C<urxvt::term>
297	variable stores the current C<urxvt::term> object.	344	object, whenever a callback/hook is executing.
298		345
299	=back	346	=back
300		347
301	=head2 Functions in the C<urxvt> Package	348	=head2 Functions in the C<urxvt> Package
302		349
…		…
323	that calls this function.	370	that calls this function.
324		371
325	Using this function has the advantage that its output ends up in the	372	Using this function has the advantage that its output ends up in the
326	correct place, e.g. on stderr of the connecting urxvtc client.	373	correct place, e.g. on stderr of the connecting urxvtc client.
327		374
		375	=item $is_safe = urxvt::safe
		376
		377	Returns true when it is safe to do potentially unsafe things, such as
		378	evaluating perl code specified by the user. This is true when urxvt was
		379	started setuid or setgid.
		380
328	=item $time = urxvt::NOW	381	=item $time = urxvt::NOW
329		382
330	Returns the "current time" (as per the event loop).	383	Returns the "current time" (as per the event loop).
		384
		385	=item urxvt::CurrentTime
		386
		387	=item urxvt::ShiftMask, LockMask, ControlMask, Mod1Mask, Mod2Mask,
		388	Mod3Mask, Mod4Mask, Mod5Mask, Button1Mask, Button2Mask, Button3Mask,
		389	Button4Mask, Button5Mask, AnyModifier
		390
		391	Various constants for use in X calls and event processing.
331		392
332	=back	393	=back
333		394
334	=head2 RENDITION	395	=head2 RENDITION
335		396
…		…
385		446
386	=cut	447	=cut
387		448
388	package urxvt;	449	package urxvt;
389		450
		451	use utf8;
390	use strict;	452	use strict;
		453	use Carp ();
391	use Scalar::Util ();	454	use Scalar::Util ();
		455	use List::Util ();
392		456
		457	our $VERSION = 1;
393	our $TERM;	458	our $TERM;
394	our @HOOKNAME;	459	our @HOOKNAME;
		460	our %HOOKTYPE = map +($HOOKNAME[$_] => $_), 0..$#HOOKNAME;
		461	our %OPTION;
395	our $LIBDIR;	462	our $LIBDIR;
396		463
397	BEGIN {	464	BEGIN {
398	urxvt->bootstrap;	465	urxvt->bootstrap;
399		466
…		…
402	my $msg = join "", @_;	469	my $msg = join "", @_;
403	$msg .= "\n"	470	$msg .= "\n"
404	unless $msg =~ /\n$/;	471	unless $msg =~ /\n$/;
405	urxvt::warn ($msg);	472	urxvt::warn ($msg);
406	};	473	};
		474
		475	delete $ENV{IFS};
		476	delete $ENV{CDPATH};
		477	delete $ENV{BASH_ENV};
		478	$ENV{PATH} = "/bin:/sbin:/usr/bin:/usr/sbin:/usr/local/bin:/usr/local/sbin:/opt/bin:/opt/sbin";
407	}	479	}
408		480
409	my @hook_count;	481	my @hook_count;
410	my $verbosity = $ENV{URXVT_PERL_VERBOSITY};	482	my $verbosity = $ENV{URXVT_PERL_VERBOSITY};
411		483
412	sub verbose {	484	sub verbose {
413	my ($level, $msg) = @_;	485	my ($level, $msg) = @_;
414	warn "$msg\n" if $level <= $verbosity;	486	warn "$msg\n" if $level <= $verbosity;
415	}	487	}
416		488
417	# find on_xxx subs in the package and register them	489	my $extension_pkg = "extension0000";
418	# as hooks	490	my %extension_pkg;
419	sub register_package($) {
420	my ($pkg) = @_;
421
422	for my $htype (0.. $#HOOKNAME) {
423	my $name = $HOOKNAME[$htype];
424
425	my $ref = $pkg->can ("on_" . lc $name)
426	or next;
427
428	$TERM->{_hook}[$htype]{$pkg} = $ref;
429	$hook_count[$htype]++
430	or set_should_invoke $htype, 1;
431	}
432	}
433
434	my $script_pkg = "script0000";
435	my %script_pkg;
436		491
437	# load a single script into its own package, once only	492	# load a single script into its own package, once only
438	sub script_package($) {	493	sub extension_package($) {
439	my ($path) = @_;	494	my ($path) = @_;
440		495
441	$script_pkg{$path} \|\|= do {	496	$extension_pkg{$path} \|\|= do {
442	my $pkg = "urxvt::" . ($script_pkg++);	497	my $pkg = "urxvt::" . ($extension_pkg++);
443		498
444	verbose 3, "loading script '$path' into package '$pkg'";	499	verbose 3, "loading extension '$path' into package '$pkg'";
445		500
446	open my $fh, "<:raw", $path	501	open my $fh, "<:raw", $path
447	or die "$path: $!";	502	or die "$path: $!";
448		503
		504	my $source = untaint
449	my $source = "package $pkg; use strict; use utf8;\n"	505	"package $pkg; use strict; use utf8;\n"
		506	. "use base urxvt::term::extension::;\n"
450	. "#line 1 \"$path\"\n{\n"	507	. "#line 1 \"$path\"\n{\n"
451	. (do { local $/; <$fh> })	508	. (do { local $/; <$fh> })
452	. "\n};\n1";	509	. "\n};\n1";
453		510
		511	eval $source
454	eval $source or die "$path: $@";	512	or die "$path: $@";
455		513
456	$pkg	514	$pkg
457	}	515	}
458	}	516	}
459		517
…		…
464	local $TERM = shift;	522	local $TERM = shift;
465	my $htype = shift;	523	my $htype = shift;
466		524
467	if ($htype == 0) { # INIT	525	if ($htype == 0) { # INIT
468	my @dirs = ((split /:/, $TERM->resource ("perl_lib")), "$LIBDIR/perl");	526	my @dirs = ((split /:/, $TERM->resource ("perl_lib")), "$LIBDIR/perl");
		527
		528	my %ext_arg;
469		529
470	for my $ext (map { split /:/, $TERM->resource ("perl_ext_$_") } 1, 2) {	530	for (map { split /,/, $TERM->resource ("perl_ext_$_") } 1, 2) {
		531	if ($_ eq "default") {
		532	$ext_arg{$_} \|\|= [] for qw(selection option-popup selection-popup searchable-scrollback);
		533	} elsif (/^-(.*)$/) {
		534	delete $ext_arg{$1};
		535	} elsif (/^([^<]+)<(.*)>$/) {
		536	push @{ $ext_arg{$1} }, $2;
		537	} else {
		538	$ext_arg{$_} \|\|= [];
		539	}
		540	}
		541
		542	while (my ($ext, $argv) = each %ext_arg) {
471	my @files = grep -f $_, map "$_/$ext", @dirs;	543	my @files = grep -f $_, map "$_/$ext", @dirs;
472		544
473	if (@files) {	545	if (@files) {
474	register_package script_package $files[0];	546	$TERM->register_package (extension_package $files[0], $argv);
475	} else {	547	} else {
476	warn "perl extension '$ext' not found in perl library search path\n";	548	warn "perl extension '$ext' not found in perl library search path\n";
477	}	549	}
478	}	550	}
		551
		552	eval "#line 1 \"--perl-eval resource/argument\"\n" . $TERM->resource ("perl_eval");
		553	warn $@ if $@;
479	}	554	}
480		555
481	$retval = undef;	556	$retval = undef;
482		557
483	if (my $cb = $TERM->{_hook}[$htype]) {	558	if (my $cb = $TERM->{_hook}[$htype]) {
…		…
485	if $verbosity >= 10;	560	if $verbosity >= 10;
486		561
487	keys %$cb;	562	keys %$cb;
488		563
489	while (my ($pkg, $cb) = each %$cb) {	564	while (my ($pkg, $cb) = each %$cb) {
490	$retval = $cb->(	565	$retval = eval { $cb->($TERM->{_pkg}{$pkg}, @_) }
491	$TERM->{_pkg}{$pkg} \|\|= do {
492	my $proxy = bless { }, urxvt::term::proxy::;
493	Scalar::Util::weaken ($proxy->{term} = $TERM);
494	$proxy
495	},
496	@_,
497	) and last;	566	and last;
		567
		568	if ($@) {
		569	$TERM->ungrab; # better to lose the grab than the session
		570	warn $@;
		571	}
498	}	572	}
499	}	573	}
500		574
501	if ($htype == 1) { # DESTROY	575	if ($htype == 1) { # DESTROY
502	# remove hooks if unused
503	if (my $hook = $TERM->{_hook}) {	576	if (my $hook = delete $TERM->{_hook}) {
504	for my $htype (0..$#$hook) {	577	for my $htype (0..$#$hook) {
505	$hook_count[$htype] -= scalar keys %{ $hook->[$htype] \|\| {} }	578	$hook_count[$htype] -= scalar keys %{ $hook->[$htype] \|\| {} }
506	or set_should_invoke $htype, 0;	579	or set_should_invoke $htype, 0;
507	}	580	}
508	}	581	}
…		…
515	}	588	}
516		589
517	$retval	590	$retval
518	}	591	}
519		592
520	sub urxvt::term::proxy::AUTOLOAD {	593	# urxvt::term::extension
521	$urxvt::term::proxy::AUTOLOAD =~ /:([^:]+)$/	594
		595	package urxvt::term::extension;
		596
		597	sub enable {
		598	my ($self, %hook) = @_;
		599	my $pkg = $self->{_pkg};
		600
		601	while (my ($name, $cb) = each %hook) {
		602	my $htype = $HOOKTYPE{uc $name};
		603	defined $htype
		604	or Carp::croak "unsupported hook type '$name'";
		605
		606	unless (exists $self->{term}{_hook}[$htype]{$pkg}) {
		607	$hook_count[$htype]++
		608	or urxvt::set_should_invoke $htype, 1;
		609	}
		610
		611	$self->{term}{_hook}[$htype]{$pkg} = $cb;
		612	}
		613	}
		614
		615	sub disable {
		616	my ($self, @hook) = @_;
		617	my $pkg = $self->{_pkg};
		618
		619	for my $name (@hook) {
		620	my $htype = $HOOKTYPE{uc $name};
		621	defined $htype
		622	or Carp::croak "unsupported hook type '$name'";
		623
		624	if (delete $self->{term}{_hook}[$htype]{$pkg}) {
		625	--$hook_count[$htype]
		626	or urxvt::set_should_invoke $htype, 0;
		627	}
		628	}
		629	}
		630
		631	our $AUTOLOAD;
		632
		633	sub AUTOLOAD {
		634	$AUTOLOAD =~ /:([^:]+)$/
522	or die "FATAL: \$AUTOLOAD '$urxvt::term::proxy::AUTOLOAD' unparsable";	635	or die "FATAL: \$AUTOLOAD '$AUTOLOAD' unparsable";
523		636
524	eval qq{	637	eval qq{
525	sub $urxvt::term::proxy::AUTOLOAD {	638	sub $AUTOLOAD {
526	my \$proxy = shift;	639	my \$proxy = shift;
527	\$proxy->{term}->$1 (\@_)	640	\$proxy->{term}->$1 (\@_)
528	}	641	}
529	1	642	1
530	} or die "FATAL: unable to compile method forwarder: $@";	643	} or die "FATAL: unable to compile method forwarder: $@";
531		644
532	goto &$urxvt::term::proxy::AUTOLOAD;	645	goto &$AUTOLOAD;
533	}	646	}
		647
		648	sub DESTROY {
		649	# nop
		650	}
		651
		652	# urxvt::destroy_hook
		653
		654	sub urxvt::destroy_hook::DESTROY {
		655	${$_[0]}->();
		656	}
		657
		658	sub urxvt::destroy_hook(&) {
		659	bless \shift, urxvt::destroy_hook::
		660	}
		661
		662	package urxvt::anyevent;
		663
		664	=head2 The C<urxvt::anyevent> Class
		665
		666	The sole purpose of this class is to deliver an interface to the
		667	C<AnyEvent> module - any module using it will work inside urxvt without
		668	further work. The only exception is that you cannot wait on condition
		669	variables, but non-blocking condvar use is ok. What this means is that you
		670	cannot use blocking APIs, but the non-blocking variant should work.
		671
		672	=cut
		673
		674	our $VERSION = 1;
		675
		676	$INC{"urxvt/anyevent.pm"} = 1; # mark us as there
		677	push @AnyEvent::REGISTRY, [urxvt => urxvt::anyevent::];
		678
		679	sub timer {
		680	my ($class, %arg) = @_;
		681
		682	my $cb = $arg{cb};
		683
		684	urxvt::timer
		685	->new
		686	->start (urxvt::NOW + $arg{after})
		687	->cb (sub {
		688	$_[0]->stop; # need to cancel manually
		689	$cb->();
		690	})
		691	}
		692
		693	sub io {
		694	my ($class, %arg) = @_;
		695
		696	my $cb = $arg{cb};
		697
		698	bless [$arg{fh}, urxvt::iow
		699	->new
		700	->fd (fileno $arg{fh})
		701	->events (($arg{poll} =~ /r/ ? 1 : 0)
		702	\| ($arg{poll} =~ /w/ ? 2 : 0))
		703	->start
		704	->cb (sub {
		705	$cb->(($_[1] & 1 ? 'r' : '')
		706	. ($_[1] & 2 ? 'w' : ''));
		707	})],
		708	urxvt::anyevent::
		709	}
		710
		711	sub DESTROY {
		712	$_[0][1]->stop;
		713	}
		714
		715	sub condvar {
		716	bless \my $flag, urxvt::anyevent::condvar::
		717	}
		718
		719	sub urxvt::anyevent::condvar::broadcast {
		720	${$_[0]}++;
		721	}
		722
		723	sub urxvt::anyevent::condvar::wait {
		724	unless (${$_[0]}) {
		725	Carp::croak "AnyEvent->condvar blocking wait unsupported in urxvt, use a non-blocking API";
		726	}
		727	}
		728
		729	package urxvt::term;
534		730
535	=head2 The C<urxvt::term> Class	731	=head2 The C<urxvt::term> Class
536		732
537	=over 4	733	=over 4
538		734
		735	=cut
		736
		737	# find on_xxx subs in the package and register them
		738	# as hooks
		739	sub register_package {
		740	my ($self, $pkg, $argv) = @_;
		741
		742	my $proxy = bless {
		743	_pkg => $pkg,
		744	argv => $argv,
		745	}, $pkg;
		746	Scalar::Util::weaken ($proxy->{term} = $self);
		747
		748	$self->{_pkg}{$pkg} = $proxy;
		749
		750	for my $name (@HOOKNAME) {
		751	if (my $ref = $pkg->can ("on_" . lc $name)) {
		752	$proxy->enable ($name => $ref);
		753	}
		754	}
		755	}
		756
539	=item $term->destroy	757	=item $term->destroy
540		758
541	Destroy the terminal object (close the window, free resources etc.).	759	Destroy the terminal object (close the window, free resources etc.).
		760
		761	=item $isset = $term->option ($optval[, $set])
		762
		763	Returns true if the option specified by C<$optval> is enabled, and
		764	optionally change it. All option values are stored by name in the hash
		765	C<%urxvt::OPTION>. Options not enabled in this binary are not in the hash.
		766
		767	Here is a a likely non-exhaustive list of option names, please see the
		768	source file F</src/optinc.h> to see the actual list:
		769
		770	borderLess console cursorBlink cursorUnderline hold iconic insecure
		771	intensityStyles jumpScroll loginShell mapAlert meta8 mouseWheelScrollPage
		772	pastableTabs pointerBlank reverseVideo scrollBar scrollBar_floating
		773	scrollBar_right scrollTtyKeypress scrollTtyOutput scrollWithBuffer
		774	secondaryScreen secondaryScroll skipBuiltinGlyphs transparent
		775	tripleclickwords utmpInhibit visualBell
542		776
543	=item $value = $term->resource ($name[, $newval])	777	=item $value = $term->resource ($name[, $newval])
544		778
545	Returns the current resource value associated with a given name and	779	Returns the current resource value associated with a given name and
546	optionally sets a new value. Setting values is most useful in the C<init>	780	optionally sets a new value. Setting values is most useful in the C<init>
…		…
556		790
557	Please note that resource strings will currently only be freed when the	791	Please note that resource strings will currently only be freed when the
558	terminal is destroyed, so changing options frequently will eat memory.	792	terminal is destroyed, so changing options frequently will eat memory.
559		793
560	Here is a a likely non-exhaustive list of resource names, not all of which	794	Here is a a likely non-exhaustive list of resource names, not all of which
561	are supported in every build, please see the source to see the actual	795	are supported in every build, please see the source file F</src/rsinc.h>
562	list:	796	to see the actual list:
563		797
564	answerbackstring backgroundPixmap backspace_key boldFont boldItalicFont	798	answerbackstring backgroundPixmap backspace_key boldFont boldItalicFont
565	borderLess color cursorBlink cursorUnderline cutchars delete_key	799	borderLess color cursorBlink cursorUnderline cutchars delete_key
566	display_name embed ext_bwidth fade font geometry hold iconName	800	display_name embed ext_bwidth fade font geometry hold iconName
567	imFont imLocale inputMethod insecure int_bwidth intensityStyles	801	imFont imLocale inputMethod insecure int_bwidth intensityStyles
…		…
574	shade term_name title transparent transparent_all tripleclickwords	808	shade term_name title transparent transparent_all tripleclickwords
575	utmpInhibit visualBell	809	utmpInhibit visualBell
576		810
577	=cut	811	=cut
578		812
579	sub urxvt::term::resource($$;$) {	813	sub resource($$;$) {
580	my ($self, $name) = (shift, shift);	814	my ($self, $name) = (shift, shift);
581	unshift @_, $self, $name, ($name =~ s/\s\+\s(\d+)$// ? $1 : 0);	815	unshift @_, $self, $name, ($name =~ s/\s\+\s(\d+)$// ? $1 : 0);
582	goto &urxvt::term::_resource;	816	&urxvt::term::_resource
583	}	817	}
		818
		819	=item $success = $term->parse_keysym ($keysym_spec, $command_string)
		820
		821	Adds a keymap translation exactly as specified via a resource. See the
		822	C<keysym> resource in the @@RXVT_NAME@@(1) manpage.
584		823
585	=item $rend = $term->rstyle ([$new_rstyle])	824	=item $rend = $term->rstyle ([$new_rstyle])
586		825
587	Return and optionally change the current rendition. Text that is output by	826	Return and optionally change the current rendition. Text that is output by
588	the terminal application will use this style.	827	the terminal application will use this style.
…		…
608		847
609	=item $oldtext = $term->selection ([$newtext])	848	=item $oldtext = $term->selection ([$newtext])
610		849
611	Return the current selection text and optionally replace it by C<$newtext>.	850	Return the current selection text and optionally replace it by C<$newtext>.
612		851
613	#=item $term->overlay ($x, $y, $text)	852	=item $term->overlay_simple ($x, $y, $text)
614	#	853
615	#Create a simple multi-line overlay box. See the next method for details.	854	Create a simple multi-line overlay box. See the next method for details.
616	#	855
617	#=cut	856	=cut
618	#	857
619	#sub urxvt::term::scr_overlay {	858	sub overlay_simple {
620	# my ($self, $x, $y, $text) = @_;	859	my ($self, $x, $y, $text) = @_;
621	#	860
622	# my @lines = split /\n/, $text;	861	my @lines = split /\n/, $text;
623	#	862
624	# my $w = 0;	863	my $w = List::Util::max map $self->strwidth ($_), @lines;
625	# for (map $self->strwidth ($_), @lines) {	864
626	# $w = $_ if $w < $_;
627	# }
628	#
629	# $self->scr_overlay_new ($x, $y, $w, scalar @lines);	865	my $overlay = $self->overlay ($x, $y, $w, scalar @lines);
630	# $self->scr_overlay_set (0, $_, $lines[$_]) for 0.. $#lines;	866	$overlay->set (0, $_, $lines[$_]) for 0.. $#lines;
631	#}	867
		868	$overlay
		869	}
632		870
633	=item $term->overlay ($x, $y, $width, $height[, $rstyle[, $border]])	871	=item $term->overlay ($x, $y, $width, $height[, $rstyle[, $border]])
634		872
635	Create a new (empty) overlay at the given position with the given	873	Create a new (empty) overlay at the given position with the given
636	width/height. C<$rstyle> defines the initial rendition style	874	width/height. C<$rstyle> defines the initial rendition style
…		…
663		901
664	If hidden, display the overlay again.	902	If hidden, display the overlay again.
665		903
666	=back	904	=back
667		905
		906	=item $popup = $term->popup ($event)
		907
		908	Creates a new C<urxvt::popup> object that implements a popup menu. The
		909	C<$event> I<must> be the event causing the menu to pop up (a button event,
		910	currently).
		911
		912	=cut
		913
		914	sub popup {
		915	my ($self, $event) = @_;
		916
		917	$self->grab ($event->{time}, 1)
		918	or return;
		919
		920	my $popup = bless {
		921	term => $self,
		922	event => $event,
		923	}, urxvt::popup::;
		924
		925	Scalar::Util::weaken $popup->{term};
		926
		927	$self->{_destroy}{$popup} = urxvt::destroy_hook { $popup->{popup}->destroy };
		928	Scalar::Util::weaken $self->{_destroy}{$popup};
		929
		930	$popup
		931	}
		932
668	=item $cellwidth = $term->strwidth $string	933	=item $cellwidth = $term->strwidth ($string)
669		934
670	Returns the number of screen-cells this string would need. Correctly	935	Returns the number of screen-cells this string would need. Correctly
671	accounts for wide and combining characters.	936	accounts for wide and combining characters.
672		937
673	=item $octets = $term->locale_encode $string	938	=item $octets = $term->locale_encode ($string)
674		939
675	Convert the given text string into the corresponding locale encoding.	940	Convert the given text string into the corresponding locale encoding.
676		941
677	=item $string = $term->locale_decode $octets	942	=item $string = $term->locale_decode ($octets)
678		943
679	Convert the given locale-encoded octets into a perl string.	944	Convert the given locale-encoded octets into a perl string.
		945
		946	=item $term->scr_xor_span ($beg_row, $beg_col, $end_row, $end_col[, $rstyle])
		947
		948	XORs the rendition values in the given span with the provided value
		949	(default: C<RS_RVid>). Useful in refresh hooks to provide effects similar
		950	to the selection.
		951
		952	=item $term->scr_xor_rect ($beg_row, $beg_col, $end_row, $end_col[, $rstyle1[, $rstyle2]])
		953
		954	Similar to C<scr_xor_span>, but xors a rectangle instead. Trailing
		955	whitespace will additionally be xored with the C<$rstyle2>, which defaults
		956	to C<RS_RVid \| RS_Uline>, which removes reverse video again and underlines
		957	it instead.
		958
		959	=item $term->scr_bell
		960
		961	Ring the bell!
680		962
681	=item $term->scr_add_lines ($string)	963	=item $term->scr_add_lines ($string)
682		964
683	Write the given text string to the screen, as if output by the application	965	Write the given text string to the screen, as if output by the application
684	running inside the terminal. It may not contain command sequences (escape	966	running inside the terminal. It may not contain command sequences (escape
…		…
699		981
700	Write the octets given in C<$data> to the tty (i.e. as program input). To	982	Write the octets given in C<$data> to the tty (i.e. as program input). To
701	pass characters instead of octets, you should convert your strings first	983	pass characters instead of octets, you should convert your strings first
702	to the locale-specific encoding using C<< $term->locale_encode >>.	984	to the locale-specific encoding using C<< $term->locale_encode >>.
703		985
		986	=item $old_events = $term->pty_ev_events ([$new_events])
		987
		988	Replaces the event mask of the pty watcher by the given event mask. Can
		989	be used to suppress input and output handling to the pty/tty. See the
		990	description of C<< urxvt::timer->events >>. Make sure to always restore
		991	the previous value.
		992
		993	=item $windowid = $term->parent
		994
		995	Return the window id of the toplevel window.
		996
		997	=item $windowid = $term->vt
		998
		999	Return the window id of the terminal window.
		1000
704	=item $window_width = $term->width	1001	=item $window_width = $term->width
705		1002
706	=item $window_height = $term->height	1003	=item $window_height = $term->height
707		1004
708	=item $font_width = $term->fwidth	1005	=item $font_width = $term->fwidth
…		…
724	=item $nrow_plus_saveLines = $term->total_rows	1021	=item $nrow_plus_saveLines = $term->total_rows
725		1022
726	=item $lines_in_scrollback = $term->nsaved	1023	=item $lines_in_scrollback = $term->nsaved
727		1024
728	Return various integers describing terminal characteristics.	1025	Return various integers describing terminal characteristics.
		1026
		1027	=item $lc_ctype = $term->locale
		1028
		1029	Returns the LC_CTYPE category string used by this rxvt-unicode.
		1030
		1031	=item $x_display = $term->display_id
		1032
		1033	Return the DISPLAY used by rxvt-unicode.
		1034
		1035	=item $modifiermask = $term->ModLevel3Mask
		1036
		1037	=item $modifiermask = $term->ModMetaMask
		1038
		1039	=item $modifiermask = $term->ModNumLockMask
		1040
		1041	Return the modifier masks corresponding to the "ISO Level 3 Shift" (often
		1042	AltGr), the meta key (often Alt) and the num lock key, if applicable.
729		1043
730	=item $view_start = $term->view_start ([$newvalue])	1044	=item $view_start = $term->view_start ([$newvalue])
731		1045
732	Returns the negative row number of the topmost line. Minimum value is	1046	Returns the negative row number of the topmost line. Minimum value is
733	C<0>, which displays the normal terminal contents. Larger values scroll	1047	C<0>, which displays the normal terminal contents. Larger values scroll
…		…
827		1141
828	=back	1142	=back
829		1143
830	=cut	1144	=cut
831		1145
832	sub urxvt::term::line {	1146	sub line {
833	my ($self, $row) = @_;	1147	my ($self, $row) = @_;
834		1148
835	my $maxrow = $self->nrow - 1;	1149	my $maxrow = $self->nrow - 1;
836		1150
837	my ($beg, $end) = ($row, $row);	1151	my ($beg, $end) = ($row, $row);
…		…
901	$offset / $self->{ncol} + $self->{beg},	1215	$offset / $self->{ncol} + $self->{beg},
902	$offset % $self->{ncol}	1216	$offset % $self->{ncol}
903	)	1217	)
904	}	1218	}
905		1219
906	=item ($row, $col) = $line->coord_of ($offset)
907	=item $text = $term->special_encode $string	1220	=item $text = $term->special_encode $string
908		1221
909	Converts a perl string into the special encoding used by rxvt-unicode,	1222	Converts a perl string into the special encoding used by rxvt-unicode,
910	where one character corresponds to one screen cell. See	1223	where one character corresponds to one screen cell. See
911	C<< $term->ROW_t >> for details.	1224	C<< $term->ROW_t >> for details.
…		…
913	=item $string = $term->special_decode $text	1226	=item $string = $term->special_decode $text
914		1227
915	Converts rxvt-unicodes text reprsentation into a perl string. See	1228	Converts rxvt-unicodes text reprsentation into a perl string. See
916	C<< $term->ROW_t >> for details.	1229	C<< $term->ROW_t >> for details.
917		1230
		1231	=item $success = $term->grab_button ($button, $modifiermask)
		1232
		1233	Registers a synchronous button grab. See the XGrabButton manpage.
		1234
		1235	=item $success = $term->grab ($eventtime[, $sync])
		1236
		1237	Calls XGrabPointer and XGrabKeyboard in asynchronous (default) or
		1238	synchronous (C<$sync> is true). Also remembers the grab timestampe.
		1239
		1240	=item $term->allow_events_async
		1241
		1242	Calls XAllowEvents with AsyncBoth for the most recent grab.
		1243
		1244	=item $term->allow_events_sync
		1245
		1246	Calls XAllowEvents with SyncBoth for the most recent grab.
		1247
		1248	=item $term->allow_events_replay
		1249
		1250	Calls XAllowEvents with both ReplayPointer and ReplayKeyboard for the most
		1251	recent grab.
		1252
		1253	=item $term->ungrab
		1254
		1255	Calls XUngrab for the most recent grab. Is called automatically on
		1256	evaluation errors, as it is better to lose the grab in the error case as
		1257	the session.
		1258
918	=back	1259	=back
		1260
		1261	=cut
		1262
		1263	package urxvt::popup;
		1264
		1265	=head2 The C<urxvt::popup> Class
		1266
		1267	=over 4
		1268
		1269	=cut
		1270
		1271	sub add_item {
		1272	my ($self, $item) = @_;
		1273
		1274	$item->{rend}{normal} = "\x1b[0;30;47m" unless exists $item->{rend}{normal};
		1275	$item->{rend}{hover} = "\x1b[0;30;46m" unless exists $item->{rend}{hover};
		1276	$item->{rend}{active} = "\x1b[m" unless exists $item->{rend}{active};
		1277
		1278	$item->{render} \|\|= sub { $_[0]{text} };
		1279
		1280	push @{ $self->{item} }, $item;
		1281	}
		1282
		1283	sub add_separator {
		1284	my ($self, $sep) = @_;
		1285
		1286	$sep \|\|= "=";
		1287
		1288	$self->add_item ({
		1289	rend => { normal => "\x1b[0;30;47m", hover => "\x1b[0;30;47m", active => "\x1b[0;30;47m" },
		1290	text => "",
		1291	render => sub { $sep x $self->{term}->ncol },
		1292	activate => sub { },
		1293	});
		1294	}
		1295
		1296	sub add_title {
		1297	my ($self, $title) = @_;
		1298
		1299	$self->add_item ({
		1300	rend => { normal => "\x1b[38;5;11;44m", hover => "\x1b[38;5;11;44m", active => "\x1b[38;5;11;44m" },
		1301	text => $title,
		1302	activate => sub { },
		1303	});
		1304	}
		1305
		1306	sub add_button {
		1307	my ($self, $text, $cb) = @_;
		1308
		1309	$self->add_item ({ type => "button", text => $text, activate => $cb});
		1310	}
		1311
		1312	sub add_toggle {
		1313	my ($self, $text, $cb, $value) = @_;
		1314
		1315	my $item; $item = {
		1316	type => "button",
		1317	text => " $text",
		1318	value => $value,
		1319	render => sub { ($_[0]{value} ? "* " : " ") . $text },
		1320	activate => sub { $cb->($_[0]{value} = !$_[0]{value}); },
		1321	};
		1322
		1323	$self->add_item ($item);
		1324	}
		1325
		1326	sub show {
		1327	my ($self) = @_;
		1328
		1329	local $urxvt::popup::self = $self;
		1330
		1331	local $ENV{LC_ALL} = $self->{term}->locale;
		1332
		1333	urxvt->new ("--perl-lib" => "", "--perl-ext-common" => "", "-pty-fd" => -1, "-sl" => 0, "-b" => 0,
		1334	"--transient-for" => $self->{term}->parent,
		1335	"-display" => $self->{term}->display_id,
		1336	"-pe" => "urxvt-popup")
		1337	or die "unable to create popup window\n";
		1338	}
		1339
		1340	sub DESTROY {
		1341	my ($self) = @_;
		1342
		1343	delete $self->{term}{_destroy}{$self};
		1344	$self->{term}->ungrab;
		1345	}
919		1346
920	=head2 The C<urxvt::timer> Class	1347	=head2 The C<urxvt::timer> Class
921		1348
922	This class implements timer watchers/events. Time is represented as a	1349	This class implements timer watchers/events. Time is represented as a
923	fractional number of seconds since the epoch. Example:	1350	fractional number of seconds since the epoch. Example:
…		…
976		1403
977	$term->{socket} = ...	1404	$term->{socket} = ...
978	$term->{iow} = urxvt::iow	1405	$term->{iow} = urxvt::iow
979	->new	1406	->new
980	->fd (fileno $term->{socket})	1407	->fd (fileno $term->{socket})
981	->events (1) # wait for read data	1408	->events (urxvt::EVENT_READ)
982	->start	1409	->start
983	->cb (sub {	1410	->cb (sub {
984	my ($iow, $revents) = @_;	1411	my ($iow, $revents) = @_;
985	# $revents must be 1 here, no need to check	1412	# $revents must be 1 here, no need to check
986	sysread $term->{socket}, my $buf, 8192	1413	sysread $term->{socket}, my $buf, 8192
…		…
1003		1430
1004	Set the filedescriptor (not handle) to watch.	1431	Set the filedescriptor (not handle) to watch.
1005		1432
1006	=item $iow = $iow->events ($eventmask)	1433	=item $iow = $iow->events ($eventmask)
1007		1434
1008	Set the event mask to watch. Bit #0 (value C<1>) enables watching for read	1435	Set the event mask to watch. The only allowed values are
1009	data, Bit #1 (value C<2>) enables watching for write data.	1436	C<urxvt::EVENT_READ> and C<urxvt::EVENT_WRITE>, which might be ORed
		1437	together, or C<urxvt::EVENT_NONE>.
1010		1438
1011	=item $iow = $iow->start	1439	=item $iow = $iow->start
1012		1440
1013	Start watching for requested events on the given handle.	1441	Start watching for requested events on the given handle.
1014		1442
…		…
1025	This variable controls the verbosity level of the perl extension. Higher	1453	This variable controls the verbosity level of the perl extension. Higher
1026	numbers indicate more verbose output.	1454	numbers indicate more verbose output.
1027		1455
1028	=over 4	1456	=over 4
1029		1457
1030	=item =0 - only fatal messages	1458	=item == 0 - fatal messages
1031		1459
1032	=item =3 - script loading and management	1460	=item >= 3 - script loading and management
1033		1461
1034	=item =10 - all events received	1462	=item >=10 - all events received
1035		1463
1036	=back	1464	=back
1037		1465
1038	=head1 AUTHOR	1466	=head1 AUTHOR
1039		1467

Diff Legend

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

Comparing rxvt-unicode/src/urxvt.pm (file contents): Revision 1.39 by root, Fri Jan 6 05:28:55 2006 UTC vs. Revision 1.71 by root, Mon Jan 9 23:18:49 2006 UTC

Diff Legend

Comparing rxvt-unicode/src/urxvt.pm (file contents):
Revision 1.39 by root, Fri Jan 6 05:28:55 2006 UTC vs.
Revision 1.71 by root, Mon Jan 9 23:18:49 2006 UTC