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

Comparing rxvt-unicode/src/urxvt.pm (file contents):
Revision 1.58 by root, Sun Jan 8 22:58:13 2006 UTC vs.
Revision 1.84 by root, Thu Jan 12 02:20:56 2006 UTC

…		…
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
29	scripts will be shared (but not enabled) for all terminals.	29	scripts will be shared (but not enabled) for all terminals.
30		30
31	=head2 Prepackaged Extensions	31	=head1 PREPACKAGED EXTENSIONS
32		32
33	This section describes the extensiosn delivered with this version. You can	33	This section describes the extensions delivered with this release. You can
34	find them in F<@@RXVT_LIBDIR@@/urxvt/perl/>.	34	find them in F<@@RXVT_LIBDIR@@/urxvt/perl/>.
35		35
36	You can activate them like this:	36	You can activate them like this:
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 (enabled by default)	42	=item selection (enabled by default)
43		43
44	Intelligent selection. This extension tries to be more intelligent when	44	(More) intelligent selection. This extension tries to be more intelligent
45	the user extends selections (double-click). Right now, it tries to select	45	when the user extends selections (double-click). Right now, it tries to
46	urls and complete shell-quoted arguments, which is very convenient, too,	46	select urls and complete shell-quoted arguments, which is very convenient,
47	if your F<ls> supports C<--quoting-style=shell>.	47	too, if your F<ls> supports C<--quoting-style=shell>.
48		48
49	It also offers the following bindable event:	49	It also offers the following bindable keyboard command:
50		50
51	=over 4	51	=over 4
52		52
53	=item rot13	53	=item rot13
54		54
…		…
58		58
59	=back	59	=back
60		60
61	=item option-popup (enabled by default)	61	=item option-popup (enabled by default)
62		62
63	Binds a popup menu to Ctrl-Button3 that lets you toggle (some) options at	63	Binds a popup menu to Ctrl-Button2 that lets you toggle (some) options at
64	runtime.	64	runtime.
65		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 (such as uri unescaping, perl
		70	evalution, web-browser starting etc.), depending on content.
		71
		72	=item searchable-scrollback<hotkey> (enabled by default)
		73
		74	Adds regex search functionality to the scrollback buffer, triggered
		75	by a hotkey (default: C<M-s>). When in search mode, normal terminal
		76	input/output is suspended.
		77
		78	C</> starts an incremental regex search, C<n> searches further, C<p> or
		79	C<N> jump to the previous match, C<G> jumps to the bottom and clears the
		80	history, C<enter> leaves search mode at the current position and C<escape>
		81	returns to the original position.
		82
66	=item digital-clock	83	=item digital-clock
67		84
68	Displays a digital clock using the built-in overlay.	85	Displays a digital clock using the built-in overlay.
69		86
70	=item mark-urls	87	=item mark-urls
71		88
72	Uses per-line display filtering (C<on_line_update>) to underline urls.	89	Uses per-line display filtering (C<on_line_update>) to underline urls and
		90	make them clickable. When middle-clicked, the program specified in the
		91	resource C<urlLauncher> (default C<x-www-browser>) will be started.
73		92
74	=item block-graphics-to-ascii	93	=item block-graphics-to-ascii
75		94
76	A not very useful example of filtering all text output to the terminal,	95	A not very useful example of filtering all text output to the terminal,
77	by replacing all line-drawing characters (U+2500 .. U+259F) by a	96	by replacing all line-drawing characters (U+2500 .. U+259F) by a
…		…
82	Displays a very simple digital clock in the upper right corner of the	101	Displays a very simple digital clock in the upper right corner of the
83	window. Illustrates overwriting the refresh callbacks to create your own	102	window. Illustrates overwriting the refresh callbacks to create your own
84	overlays or changes.	103	overlays or changes.
85		104
86	=back	105	=back
		106
		107	=head1 API DOCUMENTATION
87		108
88	=head2 General API Considerations	109	=head2 General API Considerations
89		110
90	All objects (such as terminals, time watchers etc.) are typical	111	All objects (such as terminals, time watchers etc.) are typical
91	reference-to-hash objects. The hash can be used to store anything you	112	reference-to-hash objects. The hash can be used to store anything you
…		…
104	=over 4	125	=over 4
105		126
106	=item $text	127	=item $text
107		128
108	Rxvt-unicodes special way of encoding text, where one "unicode" character	129	Rxvt-unicodes special way of encoding text, where one "unicode" character
109	always represents one screen cell. See L<row_t> for a discussion of this format.	130	always represents one screen cell. See L<ROW_t> for a discussion of this format.
110		131
111	=item $string	132	=item $string
112		133
113	A perl text string, with an emphasis on I<text>. It can store all unicode	134	A perl text string, with an emphasis on I<text>. It can store all unicode
114	characters and is to be distinguished with text encoded in a specific	135	characters and is to be distinguished with text encoded in a specific
…		…
119	Either binary data or - more common - a text string encoded in a	140	Either binary data or - more common - a text string encoded in a
120	locale-specific way.	141	locale-specific way.
121		142
122	=back	143	=back
123		144
		145	=head2 Extension Objects
		146
		147	Very perl extension is a perl class. A separate perl object is created
		148	for each terminal and each extension and passed as the first parameter to
		149	hooks. So extensions can use their C<$self> object without having to think
		150	about other extensions, with the exception of methods and members that
		151	begin with an underscore character C<_>: these are reserved for internal
		152	use.
		153
		154	Although it isn't a C<urxvt::term> object, you can call all methods of the
		155	C<urxvt::term> class on this object.
		156
		157	It has the following methods and data members:
		158
		159	=over 4
		160
		161	=item $urxvt_term = $self->{term}
		162
		163	Returns the C<urxvt::term> object associated with this instance of the
		164	extension. This member I<must not> be changed in any way.
		165
		166	=item $self->enable ($hook_name => $cb, [$hook_name => $cb..])
		167
		168	Dynamically enable the given hooks (named without the C<on_> prefix) for
		169	this extension, replacing any previous hook. This is useful when you want
		170	to overwrite time-critical hooks only temporarily.
		171
		172	=item $self->disable ($hook_name[, $hook_name..])
		173
		174	Dynamically disable the given hooks.
		175
		176	=back
		177
124	=head2 Hooks	178	=head2 Hooks
125		179
126	The following subroutines can be declared in extension files, and will be	180	The following subroutines can be declared in extension files, and will be
127	called whenever the relevant event happens.	181	called whenever the relevant event happens.
128		182
129	The first argument passed to them is an object private to each terminal	183	The first argument passed to them is an extension oject as described in
130	and extension package. You can call all C<urxvt::term> methods on it, but	184	the in the C<Extension Objects> section.
131	its not a real C<urxvt::term> object. Instead, the real C<urxvt::term>
132	object that is shared between all packages is stored in the C<term>
133	member. It is, however, blessed intot he package of the extension script,
134	so for all practical purposes you can treat an extension script as a class.
135		185
136	All of them must return a boolean value. If it is true, then the event	186	B<All> of these hooks must return a boolean value. If it is true, then the
137	counts as being I<consumed>, and the invocation of other hooks is skipped,	187	event counts as being I<consumed>, and the invocation of other hooks is
138	and the relevant action might not be carried out by the C++ code.	188	skipped, and the relevant action might not be carried out by the C++ code.
139		189
140	When in doubt, return a false value (preferably C<()>).	190	I<< When in doubt, return a false value (preferably C<()>). >>
141		191
142	=over 4	192	=over 4
143		193
144	=item on_init $term	194	=item on_init $term
145		195
…		…
199	than the scroll back buffer or the terminal.	249	than the scroll back buffer or the terminal.
200		250
201	It is called before lines are scrolled out (so rows 0 .. min ($lines - 1,	251	It is called before lines are scrolled out (so rows 0 .. min ($lines - 1,
202	$nrow - 1) represent the lines to be scrolled out). C<$saved> is the total	252	$nrow - 1) represent the lines to be scrolled out). C<$saved> is the total
203	number of lines that will be in the scrollback buffer.	253	number of lines that will be in the scrollback buffer.
204
205	=item on_tty_activity $term NYI
206
207	Called whenever the program(s) running in the urxvt window send output.
208		254
209	=item on_osc_seq $term, $string	255	=item on_osc_seq $term, $string
210		256
211	Called whenever the B<ESC ] 777 ; string ST> command sequence (OSC =	257	Called whenever the B<ESC ] 777 ; string ST> command sequence (OSC =
212	operating system command) is processed. Cursor position and other state	258	operating system command) is processed. Cursor position and other state
…		…
225	can filter/change and output the text yourself by returning a true value	271	can filter/change and output the text yourself by returning a true value
226	and calling C<< $term->scr_add_lines >> yourself. Please note that this	272	and calling C<< $term->scr_add_lines >> yourself. Please note that this
227	might be very slow, however, as your hook is called for B<all> text being	273	might be very slow, however, as your hook is called for B<all> text being
228	output.	274	output.
229		275
		276	=item on_tt_write $term, $octets
		277
		278	Called whenever some data is written to the tty/pty and can be used to
		279	suppress or filter tty input.
		280
230	=item on_line_update $term, $row	281	=item on_line_update $term, $row
231		282
232	Called whenever a line was updated or changed. Can be used to filter	283	Called whenever a line was updated or changed. Can be used to filter
233	screen output (e.g. underline urls or other useless stuff). Only lines	284	screen output (e.g. underline urls or other useless stuff). Only lines
234	that are being shown will be filtered, and, due to performance reasons,	285	that are being shown will be filtered, and, due to performance reasons,
…		…
266	=item on_focus_out $term	317	=item on_focus_out $term
267		318
268	Called wheneever the window loses keyboard focus, before rxvt-unicode does	319	Called wheneever the window loses keyboard focus, before rxvt-unicode does
269	focus out processing.	320	focus out processing.
270		321
271	=item on_key_press $term, $event, $octets	322	=item on_key_press $term, $event, $keysym, $octets
272		323
273	=item on_key_release $term, $event	324	=item on_key_release $term, $event, $keysym
274		325
275	=item on_button_press $term, $event	326	=item on_button_press $term, $event
276		327
277	=item on_button_release $term, $event	328	=item on_button_release $term, $event
278		329
…		…
294		345
295	subwindow.	346	subwindow.
296		347
297	=back	348	=back
298		349
		350	=cut
		351
		352	package urxvt;
		353
		354	use utf8;
		355	use strict;
		356	use Carp ();
		357	use Scalar::Util ();
		358	use List::Util ();
		359
		360	our $VERSION = 1;
		361	our $TERM;
		362	our @HOOKNAME;
		363	our %HOOKTYPE = map +($HOOKNAME[$_] => $_), 0..$#HOOKNAME;
		364	our %OPTION;
		365
		366	our $LIBDIR;
		367	our $RESNAME;
		368	our $RESCLASS;
		369	our $RXVTNAME;
		370
299	=head2 Variables in the C<urxvt> Package	371	=head2 Variables in the C<urxvt> Package
300		372
301	=over 4	373	=over 4
		374
		375	=item $urxvt::LIBDIR
		376
		377	The rxvt-unicode library directory, where, among other things, the perl
		378	modules and scripts are stored.
		379
		380	=item $urxvt::RESCLASS, $urxvt::RESCLASS
		381
		382	The resource class and name rxvt-unicode uses to look up X resources.
		383
		384	=item $urxvt::RXVTNAME
		385
		386	The basename of the installed binaries, usually C<urxvt>.
302		387
303	=item $urxvt::TERM	388	=item $urxvt::TERM
304		389
305	The current terminal. This variable stores the current C<urxvt::term>	390	The current terminal. This variable stores the current C<urxvt::term>
306	object, whenever a callback/hook is executing.	391	object, whenever a callback/hook is executing.
…		…
308	=back	393	=back
309		394
310	=head2 Functions in the C<urxvt> Package	395	=head2 Functions in the C<urxvt> Package
311		396
312	=over 4	397	=over 4
313
314	=item $term = new urxvt [arg...]
315
316	Creates a new terminal, very similar as if you had started it with
317	C<system $binfile, arg...>. Croaks (and probably outputs an error message)
318	if the new instance couldn't be created. Returns C<undef> if the new
319	instance didn't initialise perl, and the terminal object otherwise. The
320	C<init> and C<start> hooks will be called during the call.
321		398
322	=item urxvt::fatal $errormessage	399	=item urxvt::fatal $errormessage
323		400
324	Fatally aborts execution with the given error message. Avoid at all	401	Fatally aborts execution with the given error message. Avoid at all
325	costs! The only time this is acceptable is when the terminal process	402	costs! The only time this is acceptable is when the terminal process
…		…
331	newline. The module also overwrites the C<warn> builtin with a function	408	newline. The module also overwrites the C<warn> builtin with a function
332	that calls this function.	409	that calls this function.
333		410
334	Using this function has the advantage that its output ends up in the	411	Using this function has the advantage that its output ends up in the
335	correct place, e.g. on stderr of the connecting urxvtc client.	412	correct place, e.g. on stderr of the connecting urxvtc client.
		413
		414	Messages have a size limit of 1023 bytes currently.
		415
		416	=item $is_safe = urxvt::safe
		417
		418	Returns true when it is safe to do potentially unsafe things, such as
		419	evaluating perl code specified by the user. This is true when urxvt was
		420	started setuid or setgid.
336		421
337	=item $time = urxvt::NOW	422	=item $time = urxvt::NOW
338		423
339	Returns the "current time" (as per the event loop).	424	Returns the "current time" (as per the event loop).
340		425
…		…
379		464
380	=item $background = urxvt::GET_BASEBG $rend	465	=item $background = urxvt::GET_BASEBG $rend
381		466
382	Return the foreground/background colour index, respectively.	467	Return the foreground/background colour index, respectively.
383		468
384	=item $rend = urxvt::SET_FGCOLOR ($rend, $new_colour)	469	=item $rend = urxvt::SET_FGCOLOR $rend, $new_colour
385		470
386	=item $rend = urxvt::SET_BGCOLOR ($rend, $new_colour)	471	=item $rend = urxvt::SET_BGCOLOR $rend, $new_colour
387		472
388	Replace the foreground/background colour in the rendition mask with the	473	Replace the foreground/background colour in the rendition mask with the
389	specified one.	474	specified one.
390		475
391	=item $value = urxvt::GET_CUSTOM ($rend)	476	=item $value = urxvt::GET_CUSTOM $rend
392		477
393	Return the "custom" value: Every rendition has 5 bits for use by	478	Return the "custom" value: Every rendition has 5 bits for use by
394	extensions. They can be set and changed as you like and are initially	479	extensions. They can be set and changed as you like and are initially
395	zero.	480	zero.
396		481
397	=item $rend = urxvt::SET_CUSTOM ($rend, $new_value)	482	=item $rend = urxvt::SET_CUSTOM $rend, $new_value
398		483
399	Change the custom value.	484	Change the custom value.
400		485
401	=back	486	=back
402		487
403	=cut	488	=cut
404
405	package urxvt;
406
407	use utf8;
408	use strict;
409	use Scalar::Util ();
410	use List::Util ();
411
412	our $VERSION = 1;
413	our $TERM;
414	our @HOOKNAME;
415	our %OPTION;
416	our $LIBDIR;
417		489
418	BEGIN {	490	BEGIN {
419	urxvt->bootstrap;	491	urxvt->bootstrap;
420		492
421	# overwrite perl's warn	493	# overwrite perl's warn
…		…
423	my $msg = join "", @_;	495	my $msg = join "", @_;
424	$msg .= "\n"	496	$msg .= "\n"
425	unless $msg =~ /\n$/;	497	unless $msg =~ /\n$/;
426	urxvt::warn ($msg);	498	urxvt::warn ($msg);
427	};	499	};
		500
		501	# %ENV is the original startup environment
		502	delete $ENV{IFS};
		503	delete $ENV{CDPATH};
		504	delete $ENV{BASH_ENV};
		505	$ENV{PATH} = "/bin:/sbin:/usr/bin:/usr/sbin:/usr/local/bin:/usr/local/sbin:/opt/bin:/opt/sbin";
428	}	506	}
429		507
430	my @hook_count;	508	my @hook_count;
431	my $verbosity = $ENV{URXVT_PERL_VERBOSITY};	509	my $verbosity = $ENV{URXVT_PERL_VERBOSITY};
432		510
433	sub verbose {	511	sub verbose {
434	my ($level, $msg) = @_;	512	my ($level, $msg) = @_;
435	warn "$msg\n" if $level <= $verbosity;	513	warn "$msg\n" if $level <= $verbosity;
436	}	514	}
437		515
438	# find on_xxx subs in the package and register them
439	# as hooks
440	sub register_package($) {
441	my ($pkg) = @_;
442
443	for my $htype (0.. $#HOOKNAME) {
444	my $name = $HOOKNAME[$htype];
445
446	my $ref = $pkg->can ("on_" . lc $name)
447	or next;
448
449	$TERM->{_hook}[$htype]{$pkg} = $ref;
450	$hook_count[$htype]++
451	or set_should_invoke $htype, 1;
452	}
453	}
454
455	my $extension_pkg = "extension0000";	516	my $extension_pkg = "extension0000";
456	my %extension_pkg;	517	my %extension_pkg;
457		518
458	# load a single script into its own package, once only	519	# load a single script into its own package, once only
459	sub extension_package($) {	520	sub extension_package($) {
…		…
465	verbose 3, "loading extension '$path' into package '$pkg'";	526	verbose 3, "loading extension '$path' into package '$pkg'";
466		527
467	open my $fh, "<:raw", $path	528	open my $fh, "<:raw", $path
468	or die "$path: $!";	529	or die "$path: $!";
469		530
		531	my $source = untaint
470	my $source = "package $pkg; use strict; use utf8;\n"	532	"package $pkg; use strict; use utf8;\n"
471	. "use base urxvt::term::proxy::;\n"	533	. "use base urxvt::term::extension::;\n"
472	. "#line 1 \"$path\"\n{\n"	534	. "#line 1 \"$path\"\n{\n"
473	. (do { local $/; <$fh> })	535	. (do { local $/; <$fh> })
474	. "\n};\n1";	536	. "\n};\n1";
475		537
476	$source =~ /(.*)/s and $source = $1; # untaint	538	eval $source
477
478	eval $source or die "$path: $@";	539	or die "$path: $@";
479		540
480	$pkg	541	$pkg
481	}	542	}
482	}	543	}
483		544
…		…
489	my $htype = shift;	550	my $htype = shift;
490		551
491	if ($htype == 0) { # INIT	552	if ($htype == 0) { # INIT
492	my @dirs = ((split /:/, $TERM->resource ("perl_lib")), "$LIBDIR/perl");	553	my @dirs = ((split /:/, $TERM->resource ("perl_lib")), "$LIBDIR/perl");
493		554
494	my %want_ext;	555	my %ext_arg;
495		556
496	for (map { split /,/, $TERM->resource ("perl_ext_$_") } 1, 2) {	557	for (map { split /,/, $TERM->resource ("perl_ext_$_") } 1, 2) {
497	if ($_ eq "default") {	558	if ($_ eq "default") {
498	$want_ext{$_}++ for qw(selection option-popup);	559	$ext_arg{$_} \|\|= [] for qw(selection option-popup selection-popup searchable-scrollback);
499	} elsif (/^-(.*)$/) {	560	} elsif (/^-(.*)$/) {
500	delete $want_ext{$1};	561	delete $ext_arg{$1};
		562	} elsif (/^([^<]+)<(.*)>$/) {
		563	push @{ $ext_arg{$1} }, $2;
501	} else {	564	} else {
502	$want_ext{$_}++;	565	$ext_arg{$_} \|\|= [];
503	}	566	}
504	}	567	}
505		568
506	for my $ext (keys %want_ext) {	569	while (my ($ext, $argv) = each %ext_arg) {
507	my @files = grep -f $_, map "$_/$ext", @dirs;	570	my @files = grep -f $_, map "$_/$ext", @dirs;
508		571
509	if (@files) {	572	if (@files) {
510	register_package extension_package $files[0];	573	$TERM->register_package (extension_package $files[0], $argv);
511	} else {	574	} else {
512	warn "perl extension '$ext' not found in perl library search path\n";	575	warn "perl extension '$ext' not found in perl library search path\n";
513	}	576	}
514	}	577	}
515		578
…		…
524	if $verbosity >= 10;	587	if $verbosity >= 10;
525		588
526	keys %$cb;	589	keys %$cb;
527		590
528	while (my ($pkg, $cb) = each %$cb) {	591	while (my ($pkg, $cb) = each %$cb) {
529	eval {	592	$retval = eval { $cb->($TERM->{_pkg}{$pkg}, @_) }
530	$retval = $cb->(
531	$TERM->{_pkg}{$pkg} \|\|= do {
532	my $proxy = bless { }, $pkg;
533	Scalar::Util::weaken ($proxy->{term} = $TERM);
534	$proxy
535	},
536	@_,
537	) and last;	593	and last;
538	};	594
539	if ($@) {	595	if ($@) {
540	$TERM->ungrab; # better to lose the grab than the session	596	$TERM->ungrab; # better to lose the grab than the session
541	warn $@;	597	warn $@;
542	}	598	}
543	}	599	}
544	}	600	}
545		601
546	if ($htype == 1) { # DESTROY	602	if ($htype == 1) { # DESTROY
547	# remove hooks if unused
548	if (my $hook = $TERM->{_hook}) {	603	if (my $hook = delete $TERM->{_hook}) {
549	for my $htype (0..$#$hook) {	604	for my $htype (0..$#$hook) {
550	$hook_count[$htype] -= scalar keys %{ $hook->[$htype] \|\| {} }	605	$hook_count[$htype] -= scalar keys %{ $hook->[$htype] \|\| {} }
551	or set_should_invoke $htype, 0;	606	or set_should_invoke $htype, 0;
552	}	607	}
553	}	608	}
…		…
560	}	615	}
561		616
562	$retval	617	$retval
563	}	618	}
564		619
565	# urxvt::term::proxy	620	sub exec_async(@) {
		621	my $pid = fork;
566		622
567	sub urxvt::term::proxy::AUTOLOAD {	623	return
568	$urxvt::term::proxy::AUTOLOAD =~ /:([^:]+)$/	624	if !defined $pid or $pid;
		625
		626	%ENV = %{ $TERM->env };
		627
		628	exec @_;
		629	_exit 255;
		630	}
		631
		632	# urxvt::term::extension
		633
		634	package urxvt::term::extension;
		635
		636	sub enable {
		637	my ($self, %hook) = @_;
		638	my $pkg = $self->{_pkg};
		639
		640	while (my ($name, $cb) = each %hook) {
		641	my $htype = $HOOKTYPE{uc $name};
		642	defined $htype
		643	or Carp::croak "unsupported hook type '$name'";
		644
		645	unless (exists $self->{term}{_hook}[$htype]{$pkg}) {
		646	$hook_count[$htype]++
		647	or urxvt::set_should_invoke $htype, 1;
		648	}
		649
		650	$self->{term}{_hook}[$htype]{$pkg} = $cb;
		651	}
		652	}
		653
		654	sub disable {
		655	my ($self, @hook) = @_;
		656	my $pkg = $self->{_pkg};
		657
		658	for my $name (@hook) {
		659	my $htype = $HOOKTYPE{uc $name};
		660	defined $htype
		661	or Carp::croak "unsupported hook type '$name'";
		662
		663	if (delete $self->{term}{_hook}[$htype]{$pkg}) {
		664	--$hook_count[$htype]
		665	or urxvt::set_should_invoke $htype, 0;
		666	}
		667	}
		668	}
		669
		670	our $AUTOLOAD;
		671
		672	sub AUTOLOAD {
		673	$AUTOLOAD =~ /:([^:]+)$/
569	or die "FATAL: \$AUTOLOAD '$urxvt::term::proxy::AUTOLOAD' unparsable";	674	or die "FATAL: \$AUTOLOAD '$AUTOLOAD' unparsable";
570		675
571	eval qq{	676	eval qq{
572	sub $urxvt::term::proxy::AUTOLOAD {	677	sub $AUTOLOAD {
573	my \$proxy = shift;	678	my \$proxy = shift;
574	\$proxy->{term}->$1 (\@_)	679	\$proxy->{term}->$1 (\@_)
575	}	680	}
576	1	681	1
577	} or die "FATAL: unable to compile method forwarder: $@";	682	} or die "FATAL: unable to compile method forwarder: $@";
578		683
579	goto &$urxvt::term::proxy::AUTOLOAD;	684	goto &$AUTOLOAD;
580	}	685	}
581		686
582	sub urxvt::term::proxy::DESTROY {	687	sub DESTROY {
583	# nop	688	# nop
584	}	689	}
585		690
586	# urxvt::destroy_hook	691	# urxvt::destroy_hook
587		692
…		…
597		702
598	=head2 The C<urxvt::anyevent> Class	703	=head2 The C<urxvt::anyevent> Class
599		704
600	The sole purpose of this class is to deliver an interface to the	705	The sole purpose of this class is to deliver an interface to the
601	C<AnyEvent> module - any module using it will work inside urxvt without	706	C<AnyEvent> module - any module using it will work inside urxvt without
602	further work. The only exception is that you cannot wait on condition	707	further programming. The only exception is that you cannot wait on
603	variables, but non-blocking condvar use is ok. What this means is that you	708	condition variables, but non-blocking condvar use is ok. What this means
604	cannot use blocking APIs, but the non-blocking variant should work.	709	is that you cannot use blocking APIs, but the non-blocking variant should
		710	work.
605		711
606	=cut	712	=cut
607		713
608	our $VERSION = 1;	714	our $VERSION = 1;
609		715
…		…
654	${$_[0]}++;	760	${$_[0]}++;
655	}	761	}
656		762
657	sub urxvt::anyevent::condvar::wait {	763	sub urxvt::anyevent::condvar::wait {
658	unless (${$_[0]}) {	764	unless (${$_[0]}) {
659	require Carp;
660	Carp::croak ("AnyEvent->condvar blocking wait unsupported in urxvt, use a non-blocking API");	765	Carp::croak "AnyEvent->condvar blocking wait unsupported in urxvt, use a non-blocking API";
661	}	766	}
662	}	767	}
663		768
664	package urxvt::term;	769	package urxvt::term;
665		770
666	=head2 The C<urxvt::term> Class	771	=head2 The C<urxvt::term> Class
667		772
668	=over 4	773	=over 4
669		774
		775	=cut
		776
		777	# find on_xxx subs in the package and register them
		778	# as hooks
		779	sub register_package {
		780	my ($self, $pkg, $argv) = @_;
		781
		782	my $proxy = bless {
		783	_pkg => $pkg,
		784	argv => $argv,
		785	}, $pkg;
		786	Scalar::Util::weaken ($proxy->{term} = $self);
		787
		788	$self->{_pkg}{$pkg} = $proxy;
		789
		790	for my $name (@HOOKNAME) {
		791	if (my $ref = $pkg->can ("on_" . lc $name)) {
		792	$proxy->enable ($name => $ref);
		793	}
		794	}
		795	}
		796
		797	=item $term = new urxvt::term $envhashref, $rxvtname, [arg...]
		798
		799	Creates a new terminal, very similar as if you had started it with system
		800	C<$rxvtname, arg...>. C<$envhashref> must be a reference to a C<%ENV>-like
		801	hash which defines the environment of the new terminal.
		802
		803	Croaks (and probably outputs an error message) if the new instance
		804	couldn't be created. Returns C<undef> if the new instance didn't
		805	initialise perl, and the terminal object otherwise. The C<init> and
		806	C<start> hooks will be called during this call.
		807
		808	=cut
		809
		810	sub new {
		811	my ($class, $env, @args) = @_;
		812
		813	_new ([ map "$_=$env->{$_}", keys %$env ], @args);
		814	}
		815
670	=item $term->destroy	816	=item $term->destroy
671		817
672	Destroy the terminal object (close the window, free resources etc.).	818	Destroy the terminal object (close the window, free resources
		819	etc.). Please note that @@RXVT_NAME@@ will not exit as long as any event
		820	watchers (timers, io watchers) are still active.
673		821
674	=item $isset = $term->option ($optval[, $set])	822	=item $isset = $term->option ($optval[, $set])
675		823
676	Returns true if the option specified by C<$optval> is enabled, and	824	Returns true if the option specified by C<$optval> is enabled, and
677	optionally change it. All option values are stored by name in the hash	825	optionally change it. All option values are stored by name in the hash
…		…
727	my ($self, $name) = (shift, shift);	875	my ($self, $name) = (shift, shift);
728	unshift @_, $self, $name, ($name =~ s/\s\+\s(\d+)$// ? $1 : 0);	876	unshift @_, $self, $name, ($name =~ s/\s\+\s(\d+)$// ? $1 : 0);
729	&urxvt::term::_resource	877	&urxvt::term::_resource
730	}	878	}
731		879
		880	=item $value = $term->x_resource ($pattern)
		881
		882	Returns the X-Resource for the given pattern, excluding the program or
		883	class name, i.e. C<< $term->x_resource ("boldFont") >> should return the
		884	same value as used by this instance of rxvt-unicode. Returns C<undef> if no
		885	resource with that pattern exists.
		886
		887	This method should only be called during the C<on_start> hook, as there is
		888	only one resource database per display, and later invocations might return
		889	the wrong resources.
		890
		891	=item $success = $term->parse_keysym ($keysym_spec, $command_string)
		892
		893	Adds a keymap translation exactly as specified via a resource. See the
		894	C<keysym> resource in the @@RXVT_NAME@@(1) manpage.
		895
732	=item $rend = $term->rstyle ([$new_rstyle])	896	=item $rend = $term->rstyle ([$new_rstyle])
733		897
734	Return and optionally change the current rendition. Text that is output by	898	Return and optionally change the current rendition. Text that is output by
735	the terminal application will use this style.	899	the terminal application will use this style.
736		900
…		…
755		919
756	=item $oldtext = $term->selection ([$newtext])	920	=item $oldtext = $term->selection ([$newtext])
757		921
758	Return the current selection text and optionally replace it by C<$newtext>.	922	Return the current selection text and optionally replace it by C<$newtext>.
759		923
760	#=item $term->overlay ($x, $y, $text)	924	=item $term->overlay_simple ($x, $y, $text)
761	#	925
762	#Create a simple multi-line overlay box. See the next method for details.	926	Create a simple multi-line overlay box. See the next method for details.
763	#	927
764	#=cut	928	=cut
765	#	929
766	#sub urxvt::term::scr_overlay {	930	sub overlay_simple {
767	# my ($self, $x, $y, $text) = @_;	931	my ($self, $x, $y, $text) = @_;
768	#	932
769	# my @lines = split /\n/, $text;	933	my @lines = split /\n/, $text;
770	#	934
771	# my $w = 0;	935	my $w = List::Util::max map $self->strwidth ($_), @lines;
772	# for (map $self->strwidth ($_), @lines) {	936
773	# $w = $_ if $w < $_;
774	# }
775	#
776	# $self->scr_overlay_new ($x, $y, $w, scalar @lines);	937	my $overlay = $self->overlay ($x, $y, $w, scalar @lines);
777	# $self->scr_overlay_set (0, $_, $lines[$_]) for 0.. $#lines;	938	$overlay->set (0, $_, $lines[$_]) for 0.. $#lines;
778	#}	939
		940	$overlay
		941	}
779		942
780	=item $term->overlay ($x, $y, $width, $height[, $rstyle[, $border]])	943	=item $term->overlay ($x, $y, $width, $height[, $rstyle[, $border]])
781		944
782	Create a new (empty) overlay at the given position with the given	945	Create a new (empty) overlay at the given position with the given
783	width/height. C<$rstyle> defines the initial rendition style	946	width/height. C<$rstyle> defines the initial rendition style
…		…
850		1013
851	=item $string = $term->locale_decode ($octets)	1014	=item $string = $term->locale_decode ($octets)
852		1015
853	Convert the given locale-encoded octets into a perl string.	1016	Convert the given locale-encoded octets into a perl string.
854		1017
		1018	=item $term->scr_xor_span ($beg_row, $beg_col, $end_row, $end_col[, $rstyle])
		1019
		1020	XORs the rendition values in the given span with the provided value
		1021	(default: C<RS_RVid>). Useful in refresh hooks to provide effects similar
		1022	to the selection.
		1023
		1024	=item $term->scr_xor_rect ($beg_row, $beg_col, $end_row, $end_col[, $rstyle1[, $rstyle2]])
		1025
		1026	Similar to C<scr_xor_span>, but xors a rectangle instead. Trailing
		1027	whitespace will additionally be xored with the C<$rstyle2>, which defaults
		1028	to C<RS_RVid \| RS_Uline>, which removes reverse video again and underlines
		1029	it instead.
		1030
		1031	=item $term->scr_bell
		1032
		1033	Ring the bell!
		1034
855	=item $term->scr_add_lines ($string)	1035	=item $term->scr_add_lines ($string)
856		1036
857	Write the given text string to the screen, as if output by the application	1037	Write the given text string to the screen, as if output by the application
858	running inside the terminal. It may not contain command sequences (escape	1038	running inside the terminal. It may not contain command sequences (escape
859	codes), but is free to use line feeds, carriage returns and tabs. The	1039	codes), but is free to use line feeds, carriage returns and tabs. The
…		…
873		1053
874	Write the octets given in C<$data> to the tty (i.e. as program input). To	1054	Write the octets given in C<$data> to the tty (i.e. as program input). To
875	pass characters instead of octets, you should convert your strings first	1055	pass characters instead of octets, you should convert your strings first
876	to the locale-specific encoding using C<< $term->locale_encode >>.	1056	to the locale-specific encoding using C<< $term->locale_encode >>.
877		1057
		1058	=item $old_events = $term->pty_ev_events ([$new_events])
		1059
		1060	Replaces the event mask of the pty watcher by the given event mask. Can
		1061	be used to suppress input and output handling to the pty/tty. See the
		1062	description of C<< urxvt::timer->events >>. Make sure to always restore
		1063	the previous value.
		1064
878	=item $windowid = $term->parent	1065	=item $windowid = $term->parent
879		1066
880	Return the window id of the toplevel window.	1067	Return the window id of the toplevel window.
881		1068
882	=item $windowid = $term->vt	1069	=item $windowid = $term->vt
…		…
906	=item $nrow_plus_saveLines = $term->total_rows	1093	=item $nrow_plus_saveLines = $term->total_rows
907		1094
908	=item $lines_in_scrollback = $term->nsaved	1095	=item $lines_in_scrollback = $term->nsaved
909		1096
910	Return various integers describing terminal characteristics.	1097	Return various integers describing terminal characteristics.
		1098
		1099	=item $x_display = $term->display_id
		1100
		1101	Return the DISPLAY used by rxvt-unicode.
		1102
		1103	=item $lc_ctype = $term->locale
		1104
		1105	Returns the LC_CTYPE category string used by this rxvt-unicode.
		1106
		1107	=item $env = $term->env
		1108
		1109	Returns a copy of the environment in effect for the terminal as a hashref
		1110	similar to C<\%ENV>.
		1111
		1112	=cut
		1113
		1114	sub env {
		1115	if (my $env = $_[0]->_env) {
		1116	+{ map /^([^=]+)(?:=(.*))?$/s && ($1 => $2), @$env }
		1117	} else {
		1118	+{ %ENV }
		1119	}
		1120	}
911		1121
912	=item $modifiermask = $term->ModLevel3Mask	1122	=item $modifiermask = $term->ModLevel3Mask
913		1123
914	=item $modifiermask = $term->ModMetaMask	1124	=item $modifiermask = $term->ModMetaMask
915		1125
…		…
1092	$offset / $self->{ncol} + $self->{beg},	1302	$offset / $self->{ncol} + $self->{beg},
1093	$offset % $self->{ncol}	1303	$offset % $self->{ncol}
1094	)	1304	)
1095	}	1305	}
1096		1306
1097	=item ($row, $col) = $line->coord_of ($offset)
1098	=item $text = $term->special_encode $string	1307	=item $text = $term->special_encode $string
1099		1308
1100	Converts a perl string into the special encoding used by rxvt-unicode,	1309	Converts a perl string into the special encoding used by rxvt-unicode,
1101	where one character corresponds to one screen cell. See	1310	where one character corresponds to one screen cell. See
1102	C<< $term->ROW_t >> for details.	1311	C<< $term->ROW_t >> for details.
…		…
1104	=item $string = $term->special_decode $text	1313	=item $string = $term->special_decode $text
1105		1314
1106	Converts rxvt-unicodes text reprsentation into a perl string. See	1315	Converts rxvt-unicodes text reprsentation into a perl string. See
1107	C<< $term->ROW_t >> for details.	1316	C<< $term->ROW_t >> for details.
1108		1317
		1318	=item $success = $term->grab_button ($button, $modifiermask)
		1319
		1320	Registers a synchronous button grab. See the XGrabButton manpage.
		1321
		1322	=item $success = $term->grab ($eventtime[, $sync])
		1323
		1324	Calls XGrabPointer and XGrabKeyboard in asynchronous (default) or
		1325	synchronous (C<$sync> is true). Also remembers the grab timestampe.
		1326
		1327	=item $term->allow_events_async
		1328
		1329	Calls XAllowEvents with AsyncBoth for the most recent grab.
		1330
		1331	=item $term->allow_events_sync
		1332
		1333	Calls XAllowEvents with SyncBoth for the most recent grab.
		1334
		1335	=item $term->allow_events_replay
		1336
		1337	Calls XAllowEvents with both ReplayPointer and ReplayKeyboard for the most
		1338	recent grab.
		1339
		1340	=item $term->ungrab
		1341
		1342	Calls XUngrab for the most recent grab. Is called automatically on
		1343	evaluation errors, as it is better to lose the grab in the error case as
		1344	the session.
		1345
1109	=back	1346	=back
1110		1347
1111	=cut	1348	=cut
1112		1349
1113	package urxvt::popup;	1350	package urxvt::popup;
…		…
1128	$item->{render} \|\|= sub { $_[0]{text} };	1365	$item->{render} \|\|= sub { $_[0]{text} };
1129		1366
1130	push @{ $self->{item} }, $item;	1367	push @{ $self->{item} }, $item;
1131	}	1368	}
1132		1369
1133	sub add_separator {	1370	=item $popup->add_title ($title)
1134	my ($self, $sep) = @_;
1135		1371
1136	$sep \|\|= "═";	1372	Adds a non-clickable title to the popup.
1137		1373
1138	$self->add_item ({	1374	=cut
1139	rend => { normal => "\x1b[0;30;47m", hover => "\x1b[0;30;47m", active => "\x1b[0;30;47m" },
1140	text => "",
1141	render => sub { $sep x $urxvt::TERM->ncol },
1142	activate => sub { },
1143	});
1144	}
1145		1375
1146	sub add_title {	1376	sub add_title {
1147	my ($self, $title) = @_;	1377	my ($self, $title) = @_;
1148		1378
1149	$self->add_item ({	1379	$self->add_item ({
…		…
1151	text => $title,	1381	text => $title,
1152	activate => sub { },	1382	activate => sub { },
1153	});	1383	});
1154	}	1384	}
1155		1385
		1386	=item $popup->add_separator ([$sepchr])
		1387
		1388	Creates a separator, optionally using the character given as C<$sepchr>.
		1389
		1390	=cut
		1391
		1392	sub add_separator {
		1393	my ($self, $sep) = @_;
		1394
		1395	$sep \|\|= "=";
		1396
		1397	$self->add_item ({
		1398	rend => { normal => "\x1b[0;30;47m", hover => "\x1b[0;30;47m", active => "\x1b[0;30;47m" },
		1399	text => "",
		1400	render => sub { $sep x $self->{term}->ncol },
		1401	activate => sub { },
		1402	});
		1403	}
		1404
		1405	=item $popup->add_button ($text, $cb)
		1406
		1407	Adds a clickable button to the popup. C<$cb> is called whenever it is
		1408	selected.
		1409
		1410	=cut
		1411
1156	sub add_button {	1412	sub add_button {
1157	my ($self, $text, $cb) = @_;	1413	my ($self, $text, $cb) = @_;
1158		1414
1159	$self->add_item ({ type => "button", text => "[ $text ]", activate => $cb});	1415	$self->add_item ({ type => "button", text => $text, activate => $cb});
1160	}	1416	}
		1417
		1418	=item $popup->add_toggle ($text, $cb, $initial_value)
		1419
		1420	Adds a toggle/checkbox item to the popup. Teh callback gets called
		1421	whenever it gets toggled, with a boolean indicating its value as its first
		1422	argument.
		1423
		1424	=cut
1161		1425
1162	sub add_toggle {	1426	sub add_toggle {
1163	my ($self, $text, $cb, $value) = @_;	1427	my ($self, $text, $cb, $value) = @_;
1164		1428
1165	my $item; $item = {	1429	my $item; $item = {
1166	type => "button",	1430	type => "button",
1167	text => " $text",	1431	text => " $text",
1168	value => $value,	1432	value => $value,
1169	render => sub { ($_[0]{value} ? "* " : " ") . $text },	1433	render => sub { ($_[0]{value} ? "* " : " ") . $text },
1170	activate => sub { $cb->($_[0]{value} = !$_[0]{value}); },	1434	activate => sub { $cb->($_[1]{value} = !$_[1]{value}); },
1171	};	1435	};
1172		1436
1173	$self->add_item ($item);	1437	$self->add_item ($item);
1174	}	1438	}
		1439
		1440	=item $popup->show
		1441
		1442	Displays the popup (which is initially hidden).
		1443
		1444	=cut
1175		1445
1176	sub show {	1446	sub show {
1177	my ($self) = @_;	1447	my ($self) = @_;
1178		1448
1179	local $urxvt::popup::self = $self;	1449	local $urxvt::popup::self = $self;
1180		1450
		1451	my $env = $self->{term}->env;
		1452	# we can't hope to reproduce the locale algorithm, so nuke LC_ALL and set LC_CTYPE.
		1453	delete $env->{LC_ALL};
		1454	$env->{LC_CTYPE} = $self->{term}->locale;
		1455
		1456	urxvt::term->new ($env, $self->{term}->resource ("name"),
1181	urxvt->new ("--perl-lib" => "", "--perl-ext-common" => "", "-pty-fd" => -1, "-sl" => 0, "-b" => 0,	1457	"--perl-lib" => "", "--perl-ext-common" => "", "-pty-fd" => -1, "-sl" => 0, "-b" => 0,
1182	"--transient-for" => $self->{term}->parent,	1458	"--transient-for" => $self->{term}->parent,
		1459	"-display" => $self->{term}->display_id,
1183	"-pe" => "urxvt-popup")	1460	"-pe" => "urxvt-popup")
1184	or die "unable to create popup window\n";	1461	or die "unable to create popup window\n";
1185	}	1462	}
1186		1463
1187	sub DESTROY {	1464	sub DESTROY {
1188	my ($self) = @_;	1465	my ($self) = @_;
1189		1466
1190	delete $self->{term}{_destroy}{$self};	1467	delete $self->{term}{_destroy}{$self};
1191	$self->{term}->ungrab;	1468	$self->{term}->ungrab;
1192	}	1469	}
		1470
		1471	=back
1193		1472
1194	=head2 The C<urxvt::timer> Class	1473	=head2 The C<urxvt::timer> Class
1195		1474
1196	This class implements timer watchers/events. Time is represented as a	1475	This class implements timer watchers/events. Time is represented as a
1197	fractional number of seconds since the epoch. Example:	1476	fractional number of seconds since the epoch. Example:
…		…
1250		1529
1251	$term->{socket} = ...	1530	$term->{socket} = ...
1252	$term->{iow} = urxvt::iow	1531	$term->{iow} = urxvt::iow
1253	->new	1532	->new
1254	->fd (fileno $term->{socket})	1533	->fd (fileno $term->{socket})
1255	->events (1) # wait for read data	1534	->events (urxvt::EVENT_READ)
1256	->start	1535	->start
1257	->cb (sub {	1536	->cb (sub {
1258	my ($iow, $revents) = @_;	1537	my ($iow, $revents) = @_;
1259	# $revents must be 1 here, no need to check	1538	# $revents must be 1 here, no need to check
1260	sysread $term->{socket}, my $buf, 8192	1539	sysread $term->{socket}, my $buf, 8192
…		…
1277		1556
1278	Set the filedescriptor (not handle) to watch.	1557	Set the filedescriptor (not handle) to watch.
1279		1558
1280	=item $iow = $iow->events ($eventmask)	1559	=item $iow = $iow->events ($eventmask)
1281		1560
1282	Set the event mask to watch. Bit #0 (value C<1>) enables watching for read	1561	Set the event mask to watch. The only allowed values are
1283	data, Bit #1 (value C<2>) enables watching for write data.	1562	C<urxvt::EVENT_READ> and C<urxvt::EVENT_WRITE>, which might be ORed
		1563	together, or C<urxvt::EVENT_NONE>.
1284		1564
1285	=item $iow = $iow->start	1565	=item $iow = $iow->start
1286		1566
1287	Start watching for requested events on the given handle.	1567	Start watching for requested events on the given handle.
1288		1568

Diff Legend

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

Comparing rxvt-unicode/src/urxvt.pm (file contents): Revision 1.58 by root, Sun Jan 8 22:58:13 2006 UTC vs. Revision 1.84 by root, Thu Jan 12 02:20:56 2006 UTC

Diff Legend

Comparing rxvt-unicode/src/urxvt.pm (file contents):
Revision 1.58 by root, Sun Jan 8 22:58:13 2006 UTC vs.
Revision 1.84 by root, Thu Jan 12 02:20:56 2006 UTC