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

Comparing rxvt-unicode/src/urxvt.pm (file contents):
Revision 1.59 by root, Mon Jan 9 00:34:36 2006 UTC vs.
Revision 1.86 by root, Thu Jan 12 05:22:47 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
…		…
64	runtime.	64	runtime.
65		65
66	=item selection-popup (enabled by default)	66	=item selection-popup (enabled by default)
67		67
68	Binds a popup menu to Ctrl-Button3 that lets you convert the selection	68	Binds a popup menu to Ctrl-Button3 that lets you convert the selection
69	text into various other formats/action.	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.
70		82
71	=item digital-clock	83	=item digital-clock
72		84
73	Displays a digital clock using the built-in overlay.	85	Displays a digital clock using the built-in overlay.
74		86
75	=item mark-urls	87	=item mark-urls
76		88
77	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.
78		92
79	=item block-graphics-to-ascii	93	=item block-graphics-to-ascii
80		94
81	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,
82	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
…		…
87	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
88	window. Illustrates overwriting the refresh callbacks to create your own	102	window. Illustrates overwriting the refresh callbacks to create your own
89	overlays or changes.	103	overlays or changes.
90		104
91	=back	105	=back
		106
		107	=head1 API DOCUMENTATION
92		108
93	=head2 General API Considerations	109	=head2 General API Considerations
94		110
95	All objects (such as terminals, time watchers etc.) are typical	111	All objects (such as terminals, time watchers etc.) are typical
96	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
…		…
109	=over 4	125	=over 4
110		126
111	=item $text	127	=item $text
112		128
113	Rxvt-unicodes special way of encoding text, where one "unicode" character	129	Rxvt-unicodes special way of encoding text, where one "unicode" character
114	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.
115		131
116	=item $string	132	=item $string
117		133
118	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
119	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
…		…
124	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
125	locale-specific way.	141	locale-specific way.
126		142
127	=back	143	=back
128		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
129	=head2 Hooks	178	=head2 Hooks
130		179
131	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
132	called whenever the relevant event happens.	181	called whenever the relevant event happens.
133		182
134	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
135	and extension package. You can call all C<urxvt::term> methods on it, but	184	the in the C<Extension Objects> section.
136	its not a real C<urxvt::term> object. Instead, the real C<urxvt::term>
137	object that is shared between all packages is stored in the C<term>
138	member. It is, however, blessed intot he package of the extension script,
139	so for all practical purposes you can treat an extension script as a class.
140		185
141	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
142	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
143	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.
144		189
145	When in doubt, return a false value (preferably C<()>).	190	I<< When in doubt, return a false value (preferably C<()>). >>
146		191
147	=over 4	192	=over 4
148		193
149	=item on_init $term	194	=item on_init $term
150		195
…		…
185	=item on_sel_extend $term	230	=item on_sel_extend $term
186		231
187	Called whenever the user tries to extend the selection (e.g. with a double	232	Called whenever the user tries to extend the selection (e.g. with a double
188	click) and is either supposed to return false (normal operation), or	233	click) and is either supposed to return false (normal operation), or
189	should extend the selection itelf and return true to suppress the built-in	234	should extend the selection itelf and return true to suppress the built-in
190	processing.	235	processing. This can happen multiple times, as long as the callback
		236	returns true, it will be called on every further click by the user and is
		237	supposed to enlarge the selection more and more, if possible.
191		238
192	See the F<selection> example extension.	239	See the F<selection> example extension.
193		240
194	=item on_view_change $term, $offset	241	=item on_view_change $term, $offset
195		242
…		…
204	than the scroll back buffer or the terminal.	251	than the scroll back buffer or the terminal.
205		252
206	It is called before lines are scrolled out (so rows 0 .. min ($lines - 1,	253	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	254	$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.	255	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		256
214	=item on_osc_seq $term, $string	257	=item on_osc_seq $term, $string
215		258
216	Called whenever the B<ESC ] 777 ; string ST> command sequence (OSC =	259	Called whenever the B<ESC ] 777 ; string ST> command sequence (OSC =
217	operating system command) is processed. Cursor position and other state	260	operating system command) is processed. Cursor position and other state
…		…
230	can filter/change and output the text yourself by returning a true value	273	can filter/change and output the text yourself by returning a true value
231	and calling C<< $term->scr_add_lines >> yourself. Please note that this	274	and calling C<< $term->scr_add_lines >> yourself. Please note that this
232	might be very slow, however, as your hook is called for B<all> text being	275	might be very slow, however, as your hook is called for B<all> text being
233	output.	276	output.
234		277
		278	=item on_tt_write $term, $octets
		279
		280	Called whenever some data is written to the tty/pty and can be used to
		281	suppress or filter tty input.
		282
235	=item on_line_update $term, $row	283	=item on_line_update $term, $row
236		284
237	Called whenever a line was updated or changed. Can be used to filter	285	Called whenever a line was updated or changed. Can be used to filter
238	screen output (e.g. underline urls or other useless stuff). Only lines	286	screen output (e.g. underline urls or other useless stuff). Only lines
239	that are being shown will be filtered, and, due to performance reasons,	287	that are being shown will be filtered, and, due to performance reasons,
…		…
271	=item on_focus_out $term	319	=item on_focus_out $term
272		320
273	Called wheneever the window loses keyboard focus, before rxvt-unicode does	321	Called wheneever the window loses keyboard focus, before rxvt-unicode does
274	focus out processing.	322	focus out processing.
275		323
276	=item on_key_press $term, $event, $octets	324	=item on_key_press $term, $event, $keysym, $octets
277		325
278	=item on_key_release $term, $event	326	=item on_key_release $term, $event, $keysym
279		327
280	=item on_button_press $term, $event	328	=item on_button_press $term, $event
281		329
282	=item on_button_release $term, $event	330	=item on_button_release $term, $event
283		331
…		…
299		347
300	subwindow.	348	subwindow.
301		349
302	=back	350	=back
303		351
		352	=cut
		353
		354	package urxvt;
		355
		356	use utf8;
		357	use strict;
		358	use Carp ();
		359	use Scalar::Util ();
		360	use List::Util ();
		361
		362	our $VERSION = 1;
		363	our $TERM;
		364	our @HOOKNAME;
		365	our %HOOKTYPE = map +($HOOKNAME[$_] => $_), 0..$#HOOKNAME;
		366	our %OPTION;
		367
		368	our $LIBDIR;
		369	our $RESNAME;
		370	our $RESCLASS;
		371	our $RXVTNAME;
		372
304	=head2 Variables in the C<urxvt> Package	373	=head2 Variables in the C<urxvt> Package
305		374
306	=over 4	375	=over 4
		376
		377	=item $urxvt::LIBDIR
		378
		379	The rxvt-unicode library directory, where, among other things, the perl
		380	modules and scripts are stored.
		381
		382	=item $urxvt::RESCLASS, $urxvt::RESCLASS
		383
		384	The resource class and name rxvt-unicode uses to look up X resources.
		385
		386	=item $urxvt::RXVTNAME
		387
		388	The basename of the installed binaries, usually C<urxvt>.
307		389
308	=item $urxvt::TERM	390	=item $urxvt::TERM
309		391
310	The current terminal. This variable stores the current C<urxvt::term>	392	The current terminal. This variable stores the current C<urxvt::term>
311	object, whenever a callback/hook is executing.	393	object, whenever a callback/hook is executing.
…		…
313	=back	395	=back
314		396
315	=head2 Functions in the C<urxvt> Package	397	=head2 Functions in the C<urxvt> Package
316		398
317	=over 4	399	=over 4
318
319	=item $term = new urxvt [arg...]
320
321	Creates a new terminal, very similar as if you had started it with
322	C<system $binfile, arg...>. Croaks (and probably outputs an error message)
323	if the new instance couldn't be created. Returns C<undef> if the new
324	instance didn't initialise perl, and the terminal object otherwise. The
325	C<init> and C<start> hooks will be called during the call.
326		400
327	=item urxvt::fatal $errormessage	401	=item urxvt::fatal $errormessage
328		402
329	Fatally aborts execution with the given error message. Avoid at all	403	Fatally aborts execution with the given error message. Avoid at all
330	costs! The only time this is acceptable is when the terminal process	404	costs! The only time this is acceptable is when the terminal process
…		…
336	newline. The module also overwrites the C<warn> builtin with a function	410	newline. The module also overwrites the C<warn> builtin with a function
337	that calls this function.	411	that calls this function.
338		412
339	Using this function has the advantage that its output ends up in the	413	Using this function has the advantage that its output ends up in the
340	correct place, e.g. on stderr of the connecting urxvtc client.	414	correct place, e.g. on stderr of the connecting urxvtc client.
		415
		416	Messages have a size limit of 1023 bytes currently.
		417
		418	=item $is_safe = urxvt::safe
		419
		420	Returns true when it is safe to do potentially unsafe things, such as
		421	evaluating perl code specified by the user. This is true when urxvt was
		422	started setuid or setgid.
341		423
342	=item $time = urxvt::NOW	424	=item $time = urxvt::NOW
343		425
344	Returns the "current time" (as per the event loop).	426	Returns the "current time" (as per the event loop).
345		427
…		…
384		466
385	=item $background = urxvt::GET_BASEBG $rend	467	=item $background = urxvt::GET_BASEBG $rend
386		468
387	Return the foreground/background colour index, respectively.	469	Return the foreground/background colour index, respectively.
388		470
389	=item $rend = urxvt::SET_FGCOLOR ($rend, $new_colour)	471	=item $rend = urxvt::SET_FGCOLOR $rend, $new_colour
390		472
391	=item $rend = urxvt::SET_BGCOLOR ($rend, $new_colour)	473	=item $rend = urxvt::SET_BGCOLOR $rend, $new_colour
392		474
393	Replace the foreground/background colour in the rendition mask with the	475	Replace the foreground/background colour in the rendition mask with the
394	specified one.	476	specified one.
395		477
396	=item $value = urxvt::GET_CUSTOM ($rend)	478	=item $value = urxvt::GET_CUSTOM $rend
397		479
398	Return the "custom" value: Every rendition has 5 bits for use by	480	Return the "custom" value: Every rendition has 5 bits for use by
399	extensions. They can be set and changed as you like and are initially	481	extensions. They can be set and changed as you like and are initially
400	zero.	482	zero.
401		483
402	=item $rend = urxvt::SET_CUSTOM ($rend, $new_value)	484	=item $rend = urxvt::SET_CUSTOM $rend, $new_value
403		485
404	Change the custom value.	486	Change the custom value.
405		487
406	=back	488	=back
407		489
408	=cut	490	=cut
409
410	package urxvt;
411
412	use utf8;
413	use strict;
414	use Scalar::Util ();
415	use List::Util ();
416
417	our $VERSION = 1;
418	our $TERM;
419	our @HOOKNAME;
420	our %OPTION;
421	our $LIBDIR;
422		491
423	BEGIN {	492	BEGIN {
424	urxvt->bootstrap;	493	urxvt->bootstrap;
425		494
426	# overwrite perl's warn	495	# overwrite perl's warn
…		…
429	$msg .= "\n"	498	$msg .= "\n"
430	unless $msg =~ /\n$/;	499	unless $msg =~ /\n$/;
431	urxvt::warn ($msg);	500	urxvt::warn ($msg);
432	};	501	};
433		502
		503	# %ENV is the original startup environment
		504	delete $ENV{IFS};
		505	delete $ENV{CDPATH};
		506	delete $ENV{BASH_ENV};
434	$ENV{PATH} = "/bin:/sbin:/usr/bin:/usr/sbin:/usr/local/bin:/usr/local/sbin:/opt/bin:/opt/sbin";	507	$ENV{PATH} = "/bin:/sbin:/usr/bin:/usr/sbin:/usr/local/bin:/usr/local/sbin:/opt/bin:/opt/sbin";
435	delete $ENV{CDPATH};
436	}	508	}
437		509
438	my @hook_count;	510	my @hook_count;
439	my $verbosity = $ENV{URXVT_PERL_VERBOSITY};	511	my $verbosity = $ENV{URXVT_PERL_VERBOSITY};
440		512
441	sub verbose {	513	sub verbose {
442	my ($level, $msg) = @_;	514	my ($level, $msg) = @_;
443	warn "$msg\n" if $level <= $verbosity;	515	warn "$msg\n" if $level <= $verbosity;
444	}	516	}
445		517
446	# find on_xxx subs in the package and register them
447	# as hooks
448	sub register_package($) {
449	my ($pkg) = @_;
450
451	for my $htype (0.. $#HOOKNAME) {
452	my $name = $HOOKNAME[$htype];
453
454	my $ref = $pkg->can ("on_" . lc $name)
455	or next;
456
457	$TERM->{_hook}[$htype]{$pkg} = $ref;
458	$hook_count[$htype]++
459	or set_should_invoke $htype, 1;
460	}
461	}
462
463	my $extension_pkg = "extension0000";	518	my $extension_pkg = "extension0000";
464	my %extension_pkg;	519	my %extension_pkg;
465		520
466	# load a single script into its own package, once only	521	# load a single script into its own package, once only
467	sub extension_package($) {	522	sub extension_package($) {
…		…
473	verbose 3, "loading extension '$path' into package '$pkg'";	528	verbose 3, "loading extension '$path' into package '$pkg'";
474		529
475	open my $fh, "<:raw", $path	530	open my $fh, "<:raw", $path
476	or die "$path: $!";	531	or die "$path: $!";
477		532
		533	my $source = untaint
478	my $source = untaint "package $pkg; use strict; use utf8;\n"	534	"package $pkg; use strict; use utf8;\n"
479	. "use base urxvt::term::proxy::;\n"	535	. "use base urxvt::term::extension::;\n"
480	. "#line 1 \"$path\"\n{\n"	536	. "#line 1 \"$path\"\n{\n"
481	. (do { local $/; <$fh> })	537	. (do { local $/; <$fh> })
482	. "\n};\n1";	538	. "\n};\n1";
483		539
		540	eval $source
484	eval $source or die "$path: $@";	541	or die "$path: $@";
485		542
486	$pkg	543	$pkg
487	}	544	}
488	}	545	}
489		546
…		…
495	my $htype = shift;	552	my $htype = shift;
496		553
497	if ($htype == 0) { # INIT	554	if ($htype == 0) { # INIT
498	my @dirs = ((split /:/, $TERM->resource ("perl_lib")), "$LIBDIR/perl");	555	my @dirs = ((split /:/, $TERM->resource ("perl_lib")), "$LIBDIR/perl");
499		556
500	my %want_ext;	557	my %ext_arg;
501		558
502	for (map { split /,/, $TERM->resource ("perl_ext_$_") } 1, 2) {	559	for (map { split /,/, $TERM->resource ("perl_ext_$_") } 1, 2) {
503	if ($_ eq "default") {	560	if ($_ eq "default") {
504	$want_ext{$_}++ for qw(selection option-popup selection-popup);	561	$ext_arg{$_} \|\|= [] for qw(selection option-popup selection-popup searchable-scrollback);
505	} elsif (/^-(.*)$/) {	562	} elsif (/^-(.*)$/) {
506	delete $want_ext{$1};	563	delete $ext_arg{$1};
		564	} elsif (/^([^<]+)<(.*)>$/) {
		565	push @{ $ext_arg{$1} }, $2;
507	} else {	566	} else {
508	$want_ext{$_}++;	567	$ext_arg{$_} \|\|= [];
509	}	568	}
510	}	569	}
511		570
512	for my $ext (keys %want_ext) {	571	while (my ($ext, $argv) = each %ext_arg) {
513	my @files = grep -f $_, map "$_/$ext", @dirs;	572	my @files = grep -f $_, map "$_/$ext", @dirs;
514		573
515	if (@files) {	574	if (@files) {
516	register_package extension_package $files[0];	575	$TERM->register_package (extension_package $files[0], $argv);
517	} else {	576	} else {
518	warn "perl extension '$ext' not found in perl library search path\n";	577	warn "perl extension '$ext' not found in perl library search path\n";
519	}	578	}
520	}	579	}
521		580
…		…
530	if $verbosity >= 10;	589	if $verbosity >= 10;
531		590
532	keys %$cb;	591	keys %$cb;
533		592
534	while (my ($pkg, $cb) = each %$cb) {	593	while (my ($pkg, $cb) = each %$cb) {
535	eval {	594	$retval = eval { $cb->($TERM->{_pkg}{$pkg}, @_) }
536	$retval = $cb->(
537	$TERM->{_pkg}{$pkg} \|\|= do {
538	my $proxy = bless { }, $pkg;
539	Scalar::Util::weaken ($proxy->{term} = $TERM);
540	$proxy
541	},
542	@_,
543	) and last;	595	and last;
544	};	596
545	if ($@) {	597	if ($@) {
546	$TERM->ungrab; # better to lose the grab than the session	598	$TERM->ungrab; # better to lose the grab than the session
547	warn $@;	599	warn $@;
548	}	600	}
549	}	601	}
		602
		603	verbose 11, "$HOOKNAME[$htype] returning <$retval>"
		604	if $verbosity >= 11;
550	}	605	}
551		606
552	if ($htype == 1) { # DESTROY	607	if ($htype == 1) { # DESTROY
553	# remove hooks if unused
554	if (my $hook = $TERM->{_hook}) {	608	if (my $hook = delete $TERM->{_hook}) {
555	for my $htype (0..$#$hook) {	609	for my $htype (0..$#$hook) {
556	$hook_count[$htype] -= scalar keys %{ $hook->[$htype] \|\| {} }	610	$hook_count[$htype] -= scalar keys %{ $hook->[$htype] \|\| {} }
557	or set_should_invoke $htype, 0;	611	or set_should_invoke $htype, 0;
558	}	612	}
559	}	613	}
…		…
566	}	620	}
567		621
568	$retval	622	$retval
569	}	623	}
570		624
571	# urxvt::term::proxy	625	sub exec_async(@) {
		626	my $pid = fork;
572		627
573	sub urxvt::term::proxy::AUTOLOAD {	628	return
574	$urxvt::term::proxy::AUTOLOAD =~ /:([^:]+)$/	629	if !defined $pid or $pid;
		630
		631	%ENV = %{ $TERM->env };
		632
		633	exec @_;
		634	_exit 255;
		635	}
		636
		637	# urxvt::term::extension
		638
		639	package urxvt::term::extension;
		640
		641	sub enable {
		642	my ($self, %hook) = @_;
		643	my $pkg = $self->{_pkg};
		644
		645	while (my ($name, $cb) = each %hook) {
		646	my $htype = $HOOKTYPE{uc $name};
		647	defined $htype
		648	or Carp::croak "unsupported hook type '$name'";
		649
		650	unless (exists $self->{term}{_hook}[$htype]{$pkg}) {
		651	$hook_count[$htype]++
		652	or urxvt::set_should_invoke $htype, 1;
		653	}
		654
		655	$self->{term}{_hook}[$htype]{$pkg} = $cb;
		656	}
		657	}
		658
		659	sub disable {
		660	my ($self, @hook) = @_;
		661	my $pkg = $self->{_pkg};
		662
		663	for my $name (@hook) {
		664	my $htype = $HOOKTYPE{uc $name};
		665	defined $htype
		666	or Carp::croak "unsupported hook type '$name'";
		667
		668	if (delete $self->{term}{_hook}[$htype]{$pkg}) {
		669	--$hook_count[$htype]
		670	or urxvt::set_should_invoke $htype, 0;
		671	}
		672	}
		673	}
		674
		675	our $AUTOLOAD;
		676
		677	sub AUTOLOAD {
		678	$AUTOLOAD =~ /:([^:]+)$/
575	or die "FATAL: \$AUTOLOAD '$urxvt::term::proxy::AUTOLOAD' unparsable";	679	or die "FATAL: \$AUTOLOAD '$AUTOLOAD' unparsable";
576		680
577	eval qq{	681	eval qq{
578	sub $urxvt::term::proxy::AUTOLOAD {	682	sub $AUTOLOAD {
579	my \$proxy = shift;	683	my \$proxy = shift;
580	\$proxy->{term}->$1 (\@_)	684	\$proxy->{term}->$1 (\@_)
581	}	685	}
582	1	686	1
583	} or die "FATAL: unable to compile method forwarder: $@";	687	} or die "FATAL: unable to compile method forwarder: $@";
584		688
585	goto &$urxvt::term::proxy::AUTOLOAD;	689	goto &$AUTOLOAD;
586	}	690	}
587		691
588	sub urxvt::term::proxy::DESTROY {	692	sub DESTROY {
589	# nop	693	# nop
590	}	694	}
591		695
592	# urxvt::destroy_hook	696	# urxvt::destroy_hook
593		697
…		…
603		707
604	=head2 The C<urxvt::anyevent> Class	708	=head2 The C<urxvt::anyevent> Class
605		709
606	The sole purpose of this class is to deliver an interface to the	710	The sole purpose of this class is to deliver an interface to the
607	C<AnyEvent> module - any module using it will work inside urxvt without	711	C<AnyEvent> module - any module using it will work inside urxvt without
608	further work. The only exception is that you cannot wait on condition	712	further programming. The only exception is that you cannot wait on
609	variables, but non-blocking condvar use is ok. What this means is that you	713	condition variables, but non-blocking condvar use is ok. What this means
610	cannot use blocking APIs, but the non-blocking variant should work.	714	is that you cannot use blocking APIs, but the non-blocking variant should
		715	work.
611		716
612	=cut	717	=cut
613		718
614	our $VERSION = 1;	719	our $VERSION = 1;
615		720
…		…
660	${$_[0]}++;	765	${$_[0]}++;
661	}	766	}
662		767
663	sub urxvt::anyevent::condvar::wait {	768	sub urxvt::anyevent::condvar::wait {
664	unless (${$_[0]}) {	769	unless (${$_[0]}) {
665	require Carp;
666	Carp::croak ("AnyEvent->condvar blocking wait unsupported in urxvt, use a non-blocking API");	770	Carp::croak "AnyEvent->condvar blocking wait unsupported in urxvt, use a non-blocking API";
667	}	771	}
668	}	772	}
669		773
670	package urxvt::term;	774	package urxvt::term;
671		775
672	=head2 The C<urxvt::term> Class	776	=head2 The C<urxvt::term> Class
673		777
674	=over 4	778	=over 4
675		779
		780	=cut
		781
		782	# find on_xxx subs in the package and register them
		783	# as hooks
		784	sub register_package {
		785	my ($self, $pkg, $argv) = @_;
		786
		787	my $proxy = bless {
		788	_pkg => $pkg,
		789	argv => $argv,
		790	}, $pkg;
		791	Scalar::Util::weaken ($proxy->{term} = $self);
		792
		793	$self->{_pkg}{$pkg} = $proxy;
		794
		795	for my $name (@HOOKNAME) {
		796	if (my $ref = $pkg->can ("on_" . lc $name)) {
		797	$proxy->enable ($name => $ref);
		798	}
		799	}
		800	}
		801
		802	=item $term = new urxvt::term $envhashref, $rxvtname, [arg...]
		803
		804	Creates a new terminal, very similar as if you had started it with system
		805	C<$rxvtname, arg...>. C<$envhashref> must be a reference to a C<%ENV>-like
		806	hash which defines the environment of the new terminal.
		807
		808	Croaks (and probably outputs an error message) if the new instance
		809	couldn't be created. Returns C<undef> if the new instance didn't
		810	initialise perl, and the terminal object otherwise. The C<init> and
		811	C<start> hooks will be called during this call.
		812
		813	=cut
		814
		815	sub new {
		816	my ($class, $env, @args) = @_;
		817
		818	_new ([ map "$_=$env->{$_}", keys %$env ], @args);
		819	}
		820
676	=item $term->destroy	821	=item $term->destroy
677		822
678	Destroy the terminal object (close the window, free resources etc.).	823	Destroy the terminal object (close the window, free resources
		824	etc.). Please note that @@RXVT_NAME@@ will not exit as long as any event
		825	watchers (timers, io watchers) are still active.
679		826
680	=item $isset = $term->option ($optval[, $set])	827	=item $isset = $term->option ($optval[, $set])
681		828
682	Returns true if the option specified by C<$optval> is enabled, and	829	Returns true if the option specified by C<$optval> is enabled, and
683	optionally change it. All option values are stored by name in the hash	830	optionally change it. All option values are stored by name in the hash
…		…
733	my ($self, $name) = (shift, shift);	880	my ($self, $name) = (shift, shift);
734	unshift @_, $self, $name, ($name =~ s/\s\+\s(\d+)$// ? $1 : 0);	881	unshift @_, $self, $name, ($name =~ s/\s\+\s(\d+)$// ? $1 : 0);
735	&urxvt::term::_resource	882	&urxvt::term::_resource
736	}	883	}
737		884
		885	=item $value = $term->x_resource ($pattern)
		886
		887	Returns the X-Resource for the given pattern, excluding the program or
		888	class name, i.e. C<< $term->x_resource ("boldFont") >> should return the
		889	same value as used by this instance of rxvt-unicode. Returns C<undef> if no
		890	resource with that pattern exists.
		891
		892	This method should only be called during the C<on_start> hook, as there is
		893	only one resource database per display, and later invocations might return
		894	the wrong resources.
		895
		896	=item $success = $term->parse_keysym ($keysym_spec, $command_string)
		897
		898	Adds a keymap translation exactly as specified via a resource. See the
		899	C<keysym> resource in the @@RXVT_NAME@@(1) manpage.
		900
738	=item $rend = $term->rstyle ([$new_rstyle])	901	=item $rend = $term->rstyle ([$new_rstyle])
739		902
740	Return and optionally change the current rendition. Text that is output by	903	Return and optionally change the current rendition. Text that is output by
741	the terminal application will use this style.	904	the terminal application will use this style.
742		905
…		…
752	=item ($row, $col) = $term->selection_end ([$row, $col])	915	=item ($row, $col) = $term->selection_end ([$row, $col])
753		916
754	Return the current values of the selection mark, begin or end positions,	917	Return the current values of the selection mark, begin or end positions,
755	and optionally set them to new values.	918	and optionally set them to new values.
756		919
		920	=item $term->selection_make ($eventtime[, $rectangular])
		921
		922	Tries to make a selection as set by C<selection_beg> and
		923	C<selection_end>. If C<$rectangular> is true (default: false), a
		924	rectangular selection will be made. This is the prefered function to make
		925	a selection.
		926
757	=item $success = $term->selection_grab ($eventtime)	927	=item $success = $term->selection_grab ($eventtime)
758		928
759	Try to request the primary selection from the server (for example, as set	929	Try to request the primary selection text from the server (for example, as
760	by the next method).	930	set by the next method). No visual feedback will be given. This function
		931	is mostly useful from within C<on_sel_grab> hooks.
761		932
762	=item $oldtext = $term->selection ([$newtext])	933	=item $oldtext = $term->selection ([$newtext])
763		934
764	Return the current selection text and optionally replace it by C<$newtext>.	935	Return the current selection text and optionally replace it by C<$newtext>.
765		936
766	#=item $term->overlay ($x, $y, $text)	937	=item $term->overlay_simple ($x, $y, $text)
767	#	938
768	#Create a simple multi-line overlay box. See the next method for details.	939	Create a simple multi-line overlay box. See the next method for details.
769	#	940
770	#=cut	941	=cut
771	#	942
772	#sub urxvt::term::scr_overlay {	943	sub overlay_simple {
773	# my ($self, $x, $y, $text) = @_;	944	my ($self, $x, $y, $text) = @_;
774	#	945
775	# my @lines = split /\n/, $text;	946	my @lines = split /\n/, $text;
776	#	947
777	# my $w = 0;	948	my $w = List::Util::max map $self->strwidth ($_), @lines;
778	# for (map $self->strwidth ($_), @lines) {	949
779	# $w = $_ if $w < $_;
780	# }
781	#
782	# $self->scr_overlay_new ($x, $y, $w, scalar @lines);	950	my $overlay = $self->overlay ($x, $y, $w, scalar @lines);
783	# $self->scr_overlay_set (0, $_, $lines[$_]) for 0.. $#lines;	951	$overlay->set (0, $_, $lines[$_]) for 0.. $#lines;
784	#}	952
		953	$overlay
		954	}
785		955
786	=item $term->overlay ($x, $y, $width, $height[, $rstyle[, $border]])	956	=item $term->overlay ($x, $y, $width, $height[, $rstyle[, $border]])
787		957
788	Create a new (empty) overlay at the given position with the given	958	Create a new (empty) overlay at the given position with the given
789	width/height. C<$rstyle> defines the initial rendition style	959	width/height. C<$rstyle> defines the initial rendition style
…		…
856		1026
857	=item $string = $term->locale_decode ($octets)	1027	=item $string = $term->locale_decode ($octets)
858		1028
859	Convert the given locale-encoded octets into a perl string.	1029	Convert the given locale-encoded octets into a perl string.
860		1030
		1031	=item $term->scr_xor_span ($beg_row, $beg_col, $end_row, $end_col[, $rstyle])
		1032
		1033	XORs the rendition values in the given span with the provided value
		1034	(default: C<RS_RVid>), which I<MUST NOT> contain font styles. Useful in
		1035	refresh hooks to provide effects similar to the selection.
		1036
		1037	=item $term->scr_xor_rect ($beg_row, $beg_col, $end_row, $end_col[, $rstyle1[, $rstyle2]])
		1038
		1039	Similar to C<scr_xor_span>, but xors a rectangle instead. Trailing
		1040	whitespace will additionally be xored with the C<$rstyle2>, which defaults
		1041	to C<RS_RVid \| RS_Uline>, which removes reverse video again and underlines
		1042	it instead. Both styles I<MUST NOT> contain font styles.
		1043
		1044	=item $term->scr_bell
		1045
		1046	Ring the bell!
		1047
861	=item $term->scr_add_lines ($string)	1048	=item $term->scr_add_lines ($string)
862		1049
863	Write the given text string to the screen, as if output by the application	1050	Write the given text string to the screen, as if output by the application
864	running inside the terminal. It may not contain command sequences (escape	1051	running inside the terminal. It may not contain command sequences (escape
865	codes), but is free to use line feeds, carriage returns and tabs. The	1052	codes), but is free to use line feeds, carriage returns and tabs. The
…		…
879		1066
880	Write the octets given in C<$data> to the tty (i.e. as program input). To	1067	Write the octets given in C<$data> to the tty (i.e. as program input). To
881	pass characters instead of octets, you should convert your strings first	1068	pass characters instead of octets, you should convert your strings first
882	to the locale-specific encoding using C<< $term->locale_encode >>.	1069	to the locale-specific encoding using C<< $term->locale_encode >>.
883		1070
		1071	=item $old_events = $term->pty_ev_events ([$new_events])
		1072
		1073	Replaces the event mask of the pty watcher by the given event mask. Can
		1074	be used to suppress input and output handling to the pty/tty. See the
		1075	description of C<< urxvt::timer->events >>. Make sure to always restore
		1076	the previous value.
		1077
884	=item $windowid = $term->parent	1078	=item $windowid = $term->parent
885		1079
886	Return the window id of the toplevel window.	1080	Return the window id of the toplevel window.
887		1081
888	=item $windowid = $term->vt	1082	=item $windowid = $term->vt
…		…
912	=item $nrow_plus_saveLines = $term->total_rows	1106	=item $nrow_plus_saveLines = $term->total_rows
913		1107
914	=item $lines_in_scrollback = $term->nsaved	1108	=item $lines_in_scrollback = $term->nsaved
915		1109
916	Return various integers describing terminal characteristics.	1110	Return various integers describing terminal characteristics.
		1111
		1112	=item $x_display = $term->display_id
		1113
		1114	Return the DISPLAY used by rxvt-unicode.
		1115
		1116	=item $lc_ctype = $term->locale
		1117
		1118	Returns the LC_CTYPE category string used by this rxvt-unicode.
		1119
		1120	=item $env = $term->env
		1121
		1122	Returns a copy of the environment in effect for the terminal as a hashref
		1123	similar to C<\%ENV>.
		1124
		1125	=cut
		1126
		1127	sub env {
		1128	if (my $env = $_[0]->_env) {
		1129	+{ map /^([^=]+)(?:=(.*))?$/s && ($1 => $2), @$env }
		1130	} else {
		1131	+{ %ENV }
		1132	}
		1133	}
917		1134
918	=item $modifiermask = $term->ModLevel3Mask	1135	=item $modifiermask = $term->ModLevel3Mask
919		1136
920	=item $modifiermask = $term->ModMetaMask	1137	=item $modifiermask = $term->ModMetaMask
921		1138
…		…
1014	Return the row number of the first/last row of the line, respectively.	1231	Return the row number of the first/last row of the line, respectively.
1015		1232
1016	=item $offset = $line->offset_of ($row, $col)	1233	=item $offset = $line->offset_of ($row, $col)
1017		1234
1018	Returns the character offset of the given row\|col pair within the logical	1235	Returns the character offset of the given row\|col pair within the logical
1019	line.	1236	line. Works for rows outside the line, too, and returns corresponding
		1237	offsets outside the string.
1020		1238
1021	=item ($row, $col) = $line->coord_of ($offset)	1239	=item ($row, $col) = $line->coord_of ($offset)
1022		1240
1023	Translates a string offset into terminal coordinates again.	1241	Translates a string offset into terminal coordinates again.
1024		1242
…		…
1098	$offset / $self->{ncol} + $self->{beg},	1316	$offset / $self->{ncol} + $self->{beg},
1099	$offset % $self->{ncol}	1317	$offset % $self->{ncol}
1100	)	1318	)
1101	}	1319	}
1102		1320
1103	=item ($row, $col) = $line->coord_of ($offset)
1104	=item $text = $term->special_encode $string	1321	=item $text = $term->special_encode $string
1105		1322
1106	Converts a perl string into the special encoding used by rxvt-unicode,	1323	Converts a perl string into the special encoding used by rxvt-unicode,
1107	where one character corresponds to one screen cell. See	1324	where one character corresponds to one screen cell. See
1108	C<< $term->ROW_t >> for details.	1325	C<< $term->ROW_t >> for details.
…		…
1110	=item $string = $term->special_decode $text	1327	=item $string = $term->special_decode $text
1111		1328
1112	Converts rxvt-unicodes text reprsentation into a perl string. See	1329	Converts rxvt-unicodes text reprsentation into a perl string. See
1113	C<< $term->ROW_t >> for details.	1330	C<< $term->ROW_t >> for details.
1114		1331
		1332	=item $success = $term->grab_button ($button, $modifiermask)
		1333
		1334	Registers a synchronous button grab. See the XGrabButton manpage.
		1335
		1336	=item $success = $term->grab ($eventtime[, $sync])
		1337
		1338	Calls XGrabPointer and XGrabKeyboard in asynchronous (default) or
		1339	synchronous (C<$sync> is true). Also remembers the grab timestampe.
		1340
		1341	=item $term->allow_events_async
		1342
		1343	Calls XAllowEvents with AsyncBoth for the most recent grab.
		1344
		1345	=item $term->allow_events_sync
		1346
		1347	Calls XAllowEvents with SyncBoth for the most recent grab.
		1348
		1349	=item $term->allow_events_replay
		1350
		1351	Calls XAllowEvents with both ReplayPointer and ReplayKeyboard for the most
		1352	recent grab.
		1353
		1354	=item $term->ungrab
		1355
		1356	Calls XUngrab for the most recent grab. Is called automatically on
		1357	evaluation errors, as it is better to lose the grab in the error case as
		1358	the session.
		1359
1115	=back	1360	=back
1116		1361
1117	=cut	1362	=cut
1118		1363
1119	package urxvt::popup;	1364	package urxvt::popup;
…		…
1134	$item->{render} \|\|= sub { $_[0]{text} };	1379	$item->{render} \|\|= sub { $_[0]{text} };
1135		1380
1136	push @{ $self->{item} }, $item;	1381	push @{ $self->{item} }, $item;
1137	}	1382	}
1138		1383
1139	sub add_separator {	1384	=item $popup->add_title ($title)
1140	my ($self, $sep) = @_;
1141		1385
1142	$sep \|\|= "═";	1386	Adds a non-clickable title to the popup.
1143		1387
1144	$self->add_item ({	1388	=cut
1145	rend => { normal => "\x1b[0;30;47m", hover => "\x1b[0;30;47m", active => "\x1b[0;30;47m" },
1146	text => "",
1147	render => sub { $sep x $urxvt::TERM->ncol },
1148	activate => sub { },
1149	});
1150	}
1151		1389
1152	sub add_title {	1390	sub add_title {
1153	my ($self, $title) = @_;	1391	my ($self, $title) = @_;
1154		1392
1155	$self->add_item ({	1393	$self->add_item ({
…		…
1157	text => $title,	1395	text => $title,
1158	activate => sub { },	1396	activate => sub { },
1159	});	1397	});
1160	}	1398	}
1161		1399
		1400	=item $popup->add_separator ([$sepchr])
		1401
		1402	Creates a separator, optionally using the character given as C<$sepchr>.
		1403
		1404	=cut
		1405
		1406	sub add_separator {
		1407	my ($self, $sep) = @_;
		1408
		1409	$sep \|\|= "=";
		1410
		1411	$self->add_item ({
		1412	rend => { normal => "\x1b[0;30;47m", hover => "\x1b[0;30;47m", active => "\x1b[0;30;47m" },
		1413	text => "",
		1414	render => sub { $sep x $self->{term}->ncol },
		1415	activate => sub { },
		1416	});
		1417	}
		1418
		1419	=item $popup->add_button ($text, $cb)
		1420
		1421	Adds a clickable button to the popup. C<$cb> is called whenever it is
		1422	selected.
		1423
		1424	=cut
		1425
1162	sub add_button {	1426	sub add_button {
1163	my ($self, $text, $cb) = @_;	1427	my ($self, $text, $cb) = @_;
1164		1428
1165	$self->add_item ({ type => "button", text => "[ $text ]", activate => $cb});	1429	$self->add_item ({ type => "button", text => $text, activate => $cb});
1166	}	1430	}
		1431
		1432	=item $popup->add_toggle ($text, $cb, $initial_value)
		1433
		1434	Adds a toggle/checkbox item to the popup. Teh callback gets called
		1435	whenever it gets toggled, with a boolean indicating its value as its first
		1436	argument.
		1437
		1438	=cut
1167		1439
1168	sub add_toggle {	1440	sub add_toggle {
1169	my ($self, $text, $cb, $value) = @_;	1441	my ($self, $text, $cb, $value) = @_;
1170		1442
1171	my $item; $item = {	1443	my $item; $item = {
1172	type => "button",	1444	type => "button",
1173	text => " $text",	1445	text => " $text",
1174	value => $value,	1446	value => $value,
1175	render => sub { ($_[0]{value} ? "* " : " ") . $text },	1447	render => sub { ($_[0]{value} ? "* " : " ") . $text },
1176	activate => sub { $cb->($_[0]{value} = !$_[0]{value}); },	1448	activate => sub { $cb->($_[1]{value} = !$_[1]{value}); },
1177	};	1449	};
1178		1450
1179	$self->add_item ($item);	1451	$self->add_item ($item);
1180	}	1452	}
		1453
		1454	=item $popup->show
		1455
		1456	Displays the popup (which is initially hidden).
		1457
		1458	=cut
1181		1459
1182	sub show {	1460	sub show {
1183	my ($self) = @_;	1461	my ($self) = @_;
1184		1462
1185	local $urxvt::popup::self = $self;	1463	local $urxvt::popup::self = $self;
1186		1464
		1465	my $env = $self->{term}->env;
		1466	# we can't hope to reproduce the locale algorithm, so nuke LC_ALL and set LC_CTYPE.
		1467	delete $env->{LC_ALL};
		1468	$env->{LC_CTYPE} = $self->{term}->locale;
		1469
		1470	urxvt::term->new ($env, $self->{term}->resource ("name"),
1187	urxvt->new ("--perl-lib" => "", "--perl-ext-common" => "", "-pty-fd" => -1, "-sl" => 0, "-b" => 0,	1471	"--perl-lib" => "", "--perl-ext-common" => "", "-pty-fd" => -1, "-sl" => 0, "-b" => 0,
1188	"--transient-for" => $self->{term}->parent,	1472	"--transient-for" => $self->{term}->parent,
		1473	"-display" => $self->{term}->display_id,
1189	"-pe" => "urxvt-popup")	1474	"-pe" => "urxvt-popup")
1190	or die "unable to create popup window\n";	1475	or die "unable to create popup window\n";
1191	}	1476	}
1192		1477
1193	sub DESTROY {	1478	sub DESTROY {
1194	my ($self) = @_;	1479	my ($self) = @_;
1195		1480
1196	delete $self->{term}{_destroy}{$self};	1481	delete $self->{term}{_destroy}{$self};
1197	$self->{term}->ungrab;	1482	$self->{term}->ungrab;
1198	}	1483	}
		1484
		1485	=back
1199		1486
1200	=head2 The C<urxvt::timer> Class	1487	=head2 The C<urxvt::timer> Class
1201		1488
1202	This class implements timer watchers/events. Time is represented as a	1489	This class implements timer watchers/events. Time is represented as a
1203	fractional number of seconds since the epoch. Example:	1490	fractional number of seconds since the epoch. Example:
…		…
1256		1543
1257	$term->{socket} = ...	1544	$term->{socket} = ...
1258	$term->{iow} = urxvt::iow	1545	$term->{iow} = urxvt::iow
1259	->new	1546	->new
1260	->fd (fileno $term->{socket})	1547	->fd (fileno $term->{socket})
1261	->events (1) # wait for read data	1548	->events (urxvt::EVENT_READ)
1262	->start	1549	->start
1263	->cb (sub {	1550	->cb (sub {
1264	my ($iow, $revents) = @_;	1551	my ($iow, $revents) = @_;
1265	# $revents must be 1 here, no need to check	1552	# $revents must be 1 here, no need to check
1266	sysread $term->{socket}, my $buf, 8192	1553	sysread $term->{socket}, my $buf, 8192
…		…
1283		1570
1284	Set the filedescriptor (not handle) to watch.	1571	Set the filedescriptor (not handle) to watch.
1285		1572
1286	=item $iow = $iow->events ($eventmask)	1573	=item $iow = $iow->events ($eventmask)
1287		1574
1288	Set the event mask to watch. Bit #0 (value C<1>) enables watching for read	1575	Set the event mask to watch. The only allowed values are
1289	data, Bit #1 (value C<2>) enables watching for write data.	1576	C<urxvt::EVENT_READ> and C<urxvt::EVENT_WRITE>, which might be ORed
		1577	together, or C<urxvt::EVENT_NONE>.
1290		1578
1291	=item $iow = $iow->start	1579	=item $iow = $iow->start
1292		1580
1293	Start watching for requested events on the given handle.	1581	Start watching for requested events on the given handle.
1294		1582
…		…
1309		1597
1310	=item == 0 - fatal messages	1598	=item == 0 - fatal messages
1311		1599
1312	=item >= 3 - script loading and management	1600	=item >= 3 - script loading and management
1313		1601
1314	=item >=10 - all events received	1602	=item >=10 - all called hooks
		1603
		1604	=item >=11 - hook reutrn values
1315		1605
1316	=back	1606	=back
1317		1607
1318	=head1 AUTHOR	1608	=head1 AUTHOR
1319		1609

Diff Legend

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

Comparing rxvt-unicode/src/urxvt.pm (file contents): Revision 1.59 by root, Mon Jan 9 00:34:36 2006 UTC vs. Revision 1.86 by root, Thu Jan 12 05:22:47 2006 UTC

Diff Legend

Comparing rxvt-unicode/src/urxvt.pm (file contents):
Revision 1.59 by root, Mon Jan 9 00:34:36 2006 UTC vs.
Revision 1.86 by root, Thu Jan 12 05:22:47 2006 UTC