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

Comparing rxvt-unicode/src/urxvt.pm (file contents):
Revision 1.38 by root, Fri Jan 6 03:43:12 2006 UTC vs.
Revision 1.69 by root, Mon Jan 9 22:41:41 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
275		318
		319	=item on_map_notify $term, $event
		320
		321	=item on_unmap_notify $term, $event
		322
276	Called whenever the corresponding X event is received for the terminal	323	Called whenever the corresponding X event is received for the terminal If
277	(see the XEvent manpage) If the hook returns true, then the even will be	324	the hook returns true, then the even will be ignored by rxvt-unicode.
278	ignored by rxvt-unicode.	325
		326	The event is a hash with most values as named by Xlib (see the XEvent
		327	manpage), with the additional members C<row> and C<col>, which are the row
		328	and column under the mouse cursor.
279		329
280	C<on_key_press> additionally receives the string rxvt-unicode would	330	C<on_key_press> additionally receives the string rxvt-unicode would
281	output, if any, in locale-specific encoding.	331	output, if any, in locale-specific encoding.
282		332
283	subwindow.	333	subwindow.
…		…
288		338
289	=over 4	339	=over 4
290		340
291	=item $urxvt::TERM	341	=item $urxvt::TERM
292		342
293	The current terminal. Whenever a callback/Hook is bein executed, this	343	The current terminal. This variable stores the current C<urxvt::term>
294	variable stores the current C<urxvt::term> object.	344	object, whenever a callback/hook is executing.
295		345
296	=back	346	=back
297		347
298	=head2 Functions in the C<urxvt> Package	348	=head2 Functions in the C<urxvt> Package
299		349
…		…
320	that calls this function.	370	that calls this function.
321		371
322	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
323	correct place, e.g. on stderr of the connecting urxvtc client.	373	correct place, e.g. on stderr of the connecting urxvtc client.
324		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
325	=item $time = urxvt::NOW	381	=item $time = urxvt::NOW
326		382
327	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.
328		392
329	=back	393	=back
330		394
331	=head2 RENDITION	395	=head2 RENDITION
332		396
…		…
382		446
383	=cut	447	=cut
384		448
385	package urxvt;	449	package urxvt;
386		450
		451	use utf8;
387	use strict;	452	use strict;
		453	use Carp ();
388	use Scalar::Util ();	454	use Scalar::Util ();
		455	use List::Util ();
389		456
		457	our $VERSION = 1;
390	our $TERM;	458	our $TERM;
391	our @HOOKNAME;	459	our @HOOKNAME;
		460	our %HOOKTYPE = map +($HOOKNAME[$_] => $_), 0..$#HOOKNAME;
		461	our %OPTION;
392	our $LIBDIR;	462	our $LIBDIR;
393		463
394	BEGIN {	464	BEGIN {
395	urxvt->bootstrap;	465	urxvt->bootstrap;
396		466
…		…
399	my $msg = join "", @_;	469	my $msg = join "", @_;
400	$msg .= "\n"	470	$msg .= "\n"
401	unless $msg =~ /\n$/;	471	unless $msg =~ /\n$/;
402	urxvt::warn ($msg);	472	urxvt::warn ($msg);
403	};	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";
404	}	479	}
405		480
406	my @hook_count;	481	my @hook_count;
407	my $verbosity = $ENV{URXVT_PERL_VERBOSITY};	482	my $verbosity = $ENV{URXVT_PERL_VERBOSITY};
408		483
409	sub verbose {	484	sub verbose {
410	my ($level, $msg) = @_;	485	my ($level, $msg) = @_;
411	warn "$msg\n" if $level <= $verbosity;	486	warn "$msg\n" if $level <= $verbosity;
412	}	487	}
413		488
414	# find on_xxx subs in the package and register them	489	my $extension_pkg = "extension0000";
415	# as hooks	490	my %extension_pkg;
416	sub register_package($) {
417	my ($pkg) = @_;
418
419	for my $htype (0.. $#HOOKNAME) {
420	my $name = $HOOKNAME[$htype];
421
422	my $ref = $pkg->can ("on_" . lc $name)
423	or next;
424
425	$TERM->{_hook}[$htype]{$pkg} = $ref;
426	$hook_count[$htype]++
427	or set_should_invoke $htype, 1;
428	}
429	}
430
431	my $script_pkg = "script0000";
432	my %script_pkg;
433		491
434	# load a single script into its own package, once only	492	# load a single script into its own package, once only
435	sub script_package($) {	493	sub extension_package($) {
436	my ($path) = @_;	494	my ($path) = @_;
437		495
438	$script_pkg{$path} \|\|= do {	496	$extension_pkg{$path} \|\|= do {
439	my $pkg = "urxvt::" . ($script_pkg++);	497	my $pkg = "urxvt::" . ($extension_pkg++);
440		498
441	verbose 3, "loading script '$path' into package '$pkg'";	499	verbose 3, "loading extension '$path' into package '$pkg'";
442		500
443	open my $fh, "<:raw", $path	501	open my $fh, "<:raw", $path
444	or die "$path: $!";	502	or die "$path: $!";
445		503
		504	my $source = untaint
446	my $source = "package $pkg; use strict; use utf8;\n"	505	"package $pkg; use strict; use utf8;\n"
		506	. "use base urxvt::term::proxy::;\n"
447	. "#line 1 \"$path\"\n{\n"	507	. "#line 1 \"$path\"\n{\n"
448	. (do { local $/; <$fh> })	508	. (do { local $/; <$fh> })
449	. "\n};\n1";	509	. "\n};\n1";
450		510
		511	eval $source
451	eval $source or die "$path: $@";	512	or die "$path: $@";
452		513
453	$pkg	514	$pkg
454	}	515	}
455	}	516	}
456		517
…		…
461	local $TERM = shift;	522	local $TERM = shift;
462	my $htype = shift;	523	my $htype = shift;
463		524
464	if ($htype == 0) { # INIT	525	if ($htype == 0) { # INIT
465	my @dirs = ((split /:/, $TERM->resource ("perl_lib")), "$LIBDIR/perl");	526	my @dirs = ((split /:/, $TERM->resource ("perl_lib")), "$LIBDIR/perl");
		527
		528	my %ext_arg;
466		529
467	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) {
468	my @files = grep -f $_, map "$_/$ext", @dirs;	543	my @files = grep -f $_, map "$_/$ext", @dirs;
469		544
470	if (@files) {	545	if (@files) {
471	register_package script_package $files[0];	546	$TERM->register_package (extension_package $files[0], $argv);
472	} else {	547	} else {
473	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";
474	}	549	}
475	}	550	}
		551
		552	eval "#line 1 \"--perl-eval resource/argument\"\n" . $TERM->resource ("perl_eval");
		553	warn $@ if $@;
476	}	554	}
477		555
478	$retval = undef;	556	$retval = undef;
479		557
480	if (my $cb = $TERM->{_hook}[$htype]) {	558	if (my $cb = $TERM->{_hook}[$htype]) {
…		…
482	if $verbosity >= 10;	560	if $verbosity >= 10;
483		561
484	keys %$cb;	562	keys %$cb;
485		563
486	while (my ($pkg, $cb) = each %$cb) {	564	while (my ($pkg, $cb) = each %$cb) {
487	$retval = $cb->(	565	$retval = eval { $cb->($TERM->{_pkg}{$pkg}, @_) }
488	$TERM->{_pkg}{$pkg} \|\|= do {
489	my $proxy = bless { }, urxvt::term::proxy::;
490	Scalar::Util::weaken ($proxy->{term} = $TERM);
491	$proxy
492	},
493	@_,
494	) and last;	566	and last;
		567
		568	if ($@) {
		569	$TERM->ungrab; # better to lose the grab than the session
		570	warn $@;
		571	}
495	}	572	}
496	}	573	}
497		574
498	if ($htype == 1) { # DESTROY	575	if ($htype == 1) { # DESTROY
499	# remove hooks if unused
500	if (my $hook = $TERM->{_hook}) {	576	if (my $hook = delete $TERM->{_hook}) {
501	for my $htype (0..$#$hook) {	577	for my $htype (0..$#$hook) {
502	$hook_count[$htype] -= scalar keys %{ $hook->[$htype] \|\| {} }	578	$hook_count[$htype] -= scalar keys %{ $hook->[$htype] \|\| {} }
503	or set_should_invoke $htype, 0;	579	or set_should_invoke $htype, 0;
504	}	580	}
505	}	581	}
…		…
512	}	588	}
513		589
514	$retval	590	$retval
515	}	591	}
516		592
517	sub urxvt::term::proxy::AUTOLOAD {	593	# urxvt::term::proxy
518	$urxvt::term::proxy::AUTOLOAD =~ /:([^:]+)$/	594
		595	package urxvt::term::proxy;
		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 =~ /:([^:]+)$/
519	or die "FATAL: \$AUTOLOAD '$urxvt::term::proxy::AUTOLOAD' unparsable";	635	or die "FATAL: \$AUTOLOAD '$AUTOLOAD' unparsable";
520		636
521	eval qq{	637	eval qq{
522	sub $urxvt::term::proxy::AUTOLOAD {	638	sub $AUTOLOAD {
523	my \$proxy = shift;	639	my \$proxy = shift;
524	\$proxy->{term}->$1 (\@_)	640	\$proxy->{term}->$1 (\@_)
525	}	641	}
526	1	642	1
527	} or die "FATAL: unable to compile method forwarder: $@";	643	} or die "FATAL: unable to compile method forwarder: $@";
528		644
529	goto &$urxvt::term::proxy::AUTOLOAD;	645	goto &$AUTOLOAD;
530	}	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;
531		730
532	=head2 The C<urxvt::term> Class	731	=head2 The C<urxvt::term> Class
533		732
534	=over 4	733	=over 4
535		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
536	=item $term->destroy	757	=item $term->destroy
537		758
538	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
539		776
540	=item $value = $term->resource ($name[, $newval])	777	=item $value = $term->resource ($name[, $newval])
541		778
542	Returns the current resource value associated with a given name and	779	Returns the current resource value associated with a given name and
543	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>
…		…
553		790
554	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
555	terminal is destroyed, so changing options frequently will eat memory.	792	terminal is destroyed, so changing options frequently will eat memory.
556		793
557	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
558	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>
559	list:	796	to see the actual list:
560		797
561	answerbackstring backgroundPixmap backspace_key boldFont boldItalicFont	798	answerbackstring backgroundPixmap backspace_key boldFont boldItalicFont
562	borderLess color cursorBlink cursorUnderline cutchars delete_key	799	borderLess color cursorBlink cursorUnderline cutchars delete_key
563	display_name embed ext_bwidth fade font geometry hold iconName	800	display_name embed ext_bwidth fade font geometry hold iconName
564	imFont imLocale inputMethod insecure int_bwidth intensityStyles	801	imFont imLocale inputMethod insecure int_bwidth intensityStyles
…		…
571	shade term_name title transparent transparent_all tripleclickwords	808	shade term_name title transparent transparent_all tripleclickwords
572	utmpInhibit visualBell	809	utmpInhibit visualBell
573		810
574	=cut	811	=cut
575		812
576	sub urxvt::term::resource($$;$) {	813	sub resource($$;$) {
577	my ($self, $name) = (shift, shift);	814	my ($self, $name) = (shift, shift);
578	unshift @_, $self, $name, ($name =~ s/\s\+\s(\d+)$// ? $1 : 0);	815	unshift @_, $self, $name, ($name =~ s/\s\+\s(\d+)$// ? $1 : 0);
579	goto &urxvt::term::_resource;	816	&urxvt::term::_resource
580	}	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.
581		823
582	=item $rend = $term->rstyle ([$new_rstyle])	824	=item $rend = $term->rstyle ([$new_rstyle])
583		825
584	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
585	the terminal application will use this style.	827	the terminal application will use this style.
…		…
605		847
606	=item $oldtext = $term->selection ([$newtext])	848	=item $oldtext = $term->selection ([$newtext])
607		849
608	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>.
609		851
610	#=item $term->overlay ($x, $y, $text)	852	=item $term->overlay_simple ($x, $y, $text)
611	#	853
612	#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.
613	#	855
614	#=cut	856	=cut
615	#	857
616	#sub urxvt::term::scr_overlay {	858	sub overlay_simple {
617	# my ($self, $x, $y, $text) = @_;	859	my ($self, $x, $y, $text) = @_;
618	#	860
619	# my @lines = split /\n/, $text;	861	my @lines = split /\n/, $text;
620	#	862
621	# my $w = 0;	863	my $w = List::Util::max map $self->strwidth ($_), @lines;
622	# for (map $self->strwidth ($_), @lines) {	864
623	# $w = $_ if $w < $_;
624	# }
625	#
626	# $self->scr_overlay_new ($x, $y, $w, scalar @lines);	865	my $overlay = $self->overlay ($x, $y, $w, scalar @lines);
627	# $self->scr_overlay_set (0, $_, $lines[$_]) for 0.. $#lines;	866	$overlay->set (0, $_, $lines[$_]) for 0.. $#lines;
628	#}	867
		868	$overlay
		869	}
629		870
630	=item $term->overlay ($x, $y, $width, $height[, $rstyle[, $border]])	871	=item $term->overlay ($x, $y, $width, $height[, $rstyle[, $border]])
631		872
632	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
633	width/height. C<$rstyle> defines the initial rendition style	874	width/height. C<$rstyle> defines the initial rendition style
…		…
660		901
661	If hidden, display the overlay again.	902	If hidden, display the overlay again.
662		903
663	=back	904	=back
664		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
665	=item $cellwidth = $term->strwidth $string	933	=item $cellwidth = $term->strwidth ($string)
666		934
667	Returns the number of screen-cells this string would need. Correctly	935	Returns the number of screen-cells this string would need. Correctly
668	accounts for wide and combining characters.	936	accounts for wide and combining characters.
669		937
670	=item $octets = $term->locale_encode $string	938	=item $octets = $term->locale_encode ($string)
671		939
672	Convert the given text string into the corresponding locale encoding.	940	Convert the given text string into the corresponding locale encoding.
673		941
674	=item $string = $term->locale_decode $octets	942	=item $string = $term->locale_decode ($octets)
675		943
676	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_bell
		947
		948	Ring the bell!
677		949
678	=item $term->scr_add_lines ($string)	950	=item $term->scr_add_lines ($string)
679		951
680	Write the given text string to the screen, as if output by the application	952	Write the given text string to the screen, as if output by the application
681	running inside the terminal. It may not contain command sequences (escape	953	running inside the terminal. It may not contain command sequences (escape
…		…
696		968
697	Write the octets given in C<$data> to the tty (i.e. as program input). To	969	Write the octets given in C<$data> to the tty (i.e. as program input). To
698	pass characters instead of octets, you should convert your strings first	970	pass characters instead of octets, you should convert your strings first
699	to the locale-specific encoding using C<< $term->locale_encode >>.	971	to the locale-specific encoding using C<< $term->locale_encode >>.
700		972
		973	=item $old_events = $term->pty_ev_events ([$new_events])
		974
		975	Replaces the event mask of the pty watcher by the given event mask. Can
		976	be used to suppress input and output handling to the pty/tty. See the
		977	description of C<< urxvt::timer->events >>. Make sure to always restore
		978	the previous value.
		979
		980	=item $windowid = $term->parent
		981
		982	Return the window id of the toplevel window.
		983
		984	=item $windowid = $term->vt
		985
		986	Return the window id of the terminal window.
		987
701	=item $window_width = $term->width	988	=item $window_width = $term->width
702		989
703	=item $window_height = $term->height	990	=item $window_height = $term->height
704		991
705	=item $font_width = $term->fwidth	992	=item $font_width = $term->fwidth
…		…
721	=item $nrow_plus_saveLines = $term->total_rows	1008	=item $nrow_plus_saveLines = $term->total_rows
722		1009
723	=item $lines_in_scrollback = $term->nsaved	1010	=item $lines_in_scrollback = $term->nsaved
724		1011
725	Return various integers describing terminal characteristics.	1012	Return various integers describing terminal characteristics.
		1013
		1014	=item $lc_ctype = $term->locale
		1015
		1016	Returns the LC_CTYPE category string used by this rxvt-unicode.
		1017
		1018	=item $x_display = $term->display_id
		1019
		1020	Return the DISPLAY used by rxvt-unicode.
		1021
		1022	=item $modifiermask = $term->ModLevel3Mask
		1023
		1024	=item $modifiermask = $term->ModMetaMask
		1025
		1026	=item $modifiermask = $term->ModNumLockMask
		1027
		1028	Return the modifier masks corresponding to the "ISO Level 3 Shift" (often
		1029	AltGr), the meta key (often Alt) and the num lock key, if applicable.
726		1030
727	=item $view_start = $term->view_start ([$newvalue])	1031	=item $view_start = $term->view_start ([$newvalue])
728		1032
729	Returns the negative row number of the topmost line. Minimum value is	1033	Returns the negative row number of the topmost line. Minimum value is
730	C<0>, which displays the normal terminal contents. Larger values scroll	1034	C<0>, which displays the normal terminal contents. Larger values scroll
…		…
824		1128
825	=back	1129	=back
826		1130
827	=cut	1131	=cut
828		1132
829	sub urxvt::term::line {	1133	sub line {
830	my ($self, $row) = @_;	1134	my ($self, $row) = @_;
831		1135
832	my $maxrow = $self->nrow - 1;	1136	my $maxrow = $self->nrow - 1;
833		1137
834	my ($beg, $end) = ($row, $row);	1138	my ($beg, $end) = ($row, $row);
…		…
898	$offset / $self->{ncol} + $self->{beg},	1202	$offset / $self->{ncol} + $self->{beg},
899	$offset % $self->{ncol}	1203	$offset % $self->{ncol}
900	)	1204	)
901	}	1205	}
902		1206
903	=item ($row, $col) = $line->coord_of ($offset)
904	=item $text = $term->special_encode $string	1207	=item $text = $term->special_encode $string
905		1208
906	Converts a perl string into the special encoding used by rxvt-unicode,	1209	Converts a perl string into the special encoding used by rxvt-unicode,
907	where one character corresponds to one screen cell. See	1210	where one character corresponds to one screen cell. See
908	C<< $term->ROW_t >> for details.	1211	C<< $term->ROW_t >> for details.
…		…
910	=item $string = $term->special_decode $text	1213	=item $string = $term->special_decode $text
911		1214
912	Converts rxvt-unicodes text reprsentation into a perl string. See	1215	Converts rxvt-unicodes text reprsentation into a perl string. See
913	C<< $term->ROW_t >> for details.	1216	C<< $term->ROW_t >> for details.
914		1217
		1218	=item $success = $term->grab_button ($button, $modifiermask)
		1219
		1220	Registers a synchronous button grab. See the XGrabButton manpage.
		1221
		1222	=item $success = $term->grab ($eventtime[, $sync])
		1223
		1224	Calls XGrabPointer and XGrabKeyboard in asynchronous (default) or
		1225	synchronous (C<$sync> is true). Also remembers the grab timestampe.
		1226
		1227	=item $term->allow_events_async
		1228
		1229	Calls XAllowEvents with AsyncBoth for the most recent grab.
		1230
		1231	=item $term->allow_events_sync
		1232
		1233	Calls XAllowEvents with SyncBoth for the most recent grab.
		1234
		1235	=item $term->allow_events_replay
		1236
		1237	Calls XAllowEvents with both ReplayPointer and ReplayKeyboard for the most
		1238	recent grab.
		1239
		1240	=item $term->ungrab
		1241
		1242	Calls XUngrab for the most recent grab. Is called automatically on
		1243	evaluation errors, as it is better to lose the grab in the error case as
		1244	the session.
		1245
915	=back	1246	=back
		1247
		1248	=cut
		1249
		1250	package urxvt::popup;
		1251
		1252	=head2 The C<urxvt::popup> Class
		1253
		1254	=over 4
		1255
		1256	=cut
		1257
		1258	sub add_item {
		1259	my ($self, $item) = @_;
		1260
		1261	$item->{rend}{normal} = "\x1b[0;30;47m" unless exists $item->{rend}{normal};
		1262	$item->{rend}{hover} = "\x1b[0;30;46m" unless exists $item->{rend}{hover};
		1263	$item->{rend}{active} = "\x1b[m" unless exists $item->{rend}{active};
		1264
		1265	$item->{render} \|\|= sub { $_[0]{text} };
		1266
		1267	push @{ $self->{item} }, $item;
		1268	}
		1269
		1270	sub add_separator {
		1271	my ($self, $sep) = @_;
		1272
		1273	$sep \|\|= "=";
		1274
		1275	$self->add_item ({
		1276	rend => { normal => "\x1b[0;30;47m", hover => "\x1b[0;30;47m", active => "\x1b[0;30;47m" },
		1277	text => "",
		1278	render => sub { $sep x $self->{term}->ncol },
		1279	activate => sub { },
		1280	});
		1281	}
		1282
		1283	sub add_title {
		1284	my ($self, $title) = @_;
		1285
		1286	$self->add_item ({
		1287	rend => { normal => "\x1b[38;5;11;44m", hover => "\x1b[38;5;11;44m", active => "\x1b[38;5;11;44m" },
		1288	text => $title,
		1289	activate => sub { },
		1290	});
		1291	}
		1292
		1293	sub add_button {
		1294	my ($self, $text, $cb) = @_;
		1295
		1296	$self->add_item ({ type => "button", text => $text, activate => $cb});
		1297	}
		1298
		1299	sub add_toggle {
		1300	my ($self, $text, $cb, $value) = @_;
		1301
		1302	my $item; $item = {
		1303	type => "button",
		1304	text => " $text",
		1305	value => $value,
		1306	render => sub { ($_[0]{value} ? "* " : " ") . $text },
		1307	activate => sub { $cb->($_[0]{value} = !$_[0]{value}); },
		1308	};
		1309
		1310	$self->add_item ($item);
		1311	}
		1312
		1313	sub show {
		1314	my ($self) = @_;
		1315
		1316	local $urxvt::popup::self = $self;
		1317
		1318	local $ENV{LC_ALL} = $self->{term}->locale;
		1319
		1320	urxvt->new ("--perl-lib" => "", "--perl-ext-common" => "", "-pty-fd" => -1, "-sl" => 0, "-b" => 0,
		1321	"--transient-for" => $self->{term}->parent,
		1322	"-display" => $self->{term}->display_id,
		1323	"-pe" => "urxvt-popup")
		1324	or die "unable to create popup window\n";
		1325	}
		1326
		1327	sub DESTROY {
		1328	my ($self) = @_;
		1329
		1330	delete $self->{term}{_destroy}{$self};
		1331	$self->{term}->ungrab;
		1332	}
916		1333
917	=head2 The C<urxvt::timer> Class	1334	=head2 The C<urxvt::timer> Class
918		1335
919	This class implements timer watchers/events. Time is represented as a	1336	This class implements timer watchers/events. Time is represented as a
920	fractional number of seconds since the epoch. Example:	1337	fractional number of seconds since the epoch. Example:
…		…
973		1390
974	$term->{socket} = ...	1391	$term->{socket} = ...
975	$term->{iow} = urxvt::iow	1392	$term->{iow} = urxvt::iow
976	->new	1393	->new
977	->fd (fileno $term->{socket})	1394	->fd (fileno $term->{socket})
978	->events (1) # wait for read data	1395	->events (urxvt::EVENT_READ)
979	->start	1396	->start
980	->cb (sub {	1397	->cb (sub {
981	my ($iow, $revents) = @_;	1398	my ($iow, $revents) = @_;
982	# $revents must be 1 here, no need to check	1399	# $revents must be 1 here, no need to check
983	sysread $term->{socket}, my $buf, 8192	1400	sysread $term->{socket}, my $buf, 8192
…		…
1000		1417
1001	Set the filedescriptor (not handle) to watch.	1418	Set the filedescriptor (not handle) to watch.
1002		1419
1003	=item $iow = $iow->events ($eventmask)	1420	=item $iow = $iow->events ($eventmask)
1004		1421
1005	Set the event mask to watch. Bit #0 (value C<1>) enables watching for read	1422	Set the event mask to watch. The only allowed values are
1006	data, Bit #1 (value C<2>) enables watching for write data.	1423	C<urxvt::EVENT_READ> and C<urxvt::EVENT_WRITE>, which might be ORed
		1424	together, or C<urxvt::EVENT_NONE>.
1007		1425
1008	=item $iow = $iow->start	1426	=item $iow = $iow->start
1009		1427
1010	Start watching for requested events on the given handle.	1428	Start watching for requested events on the given handle.
1011		1429
…		…
1022	This variable controls the verbosity level of the perl extension. Higher	1440	This variable controls the verbosity level of the perl extension. Higher
1023	numbers indicate more verbose output.	1441	numbers indicate more verbose output.
1024		1442
1025	=over 4	1443	=over 4
1026		1444
1027	=item =0 - only fatal messages	1445	=item == 0 - fatal messages
1028		1446
1029	=item =3 - script loading and management	1447	=item >= 3 - script loading and management
1030		1448
1031	=item =10 - all events received	1449	=item >=10 - all events received
1032		1450
1033	=back	1451	=back
1034		1452
1035	=head1 AUTHOR	1453	=head1 AUTHOR
1036		1454

Diff Legend

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

Comparing rxvt-unicode/src/urxvt.pm (file contents): Revision 1.38 by root, Fri Jan 6 03:43:12 2006 UTC vs. Revision 1.69 by root, Mon Jan 9 22:41:41 2006 UTC

Diff Legend

Comparing rxvt-unicode/src/urxvt.pm (file contents):
Revision 1.38 by root, Fri Jan 6 03:43:12 2006 UTC vs.
Revision 1.69 by root, Mon Jan 9 22:41:41 2006 UTC