[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.83 by root, Thu Jan 12 01:38:37 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
…		…
204	than the scroll back buffer or the terminal.	249	than the scroll back buffer or the terminal.
205		250
206	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,
207	$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
208	number of lines that will be in the scrollback buffer.	253	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		254
214	=item on_osc_seq $term, $string	255	=item on_osc_seq $term, $string
215		256
216	Called whenever the B<ESC ] 777 ; string ST> command sequence (OSC =	257	Called whenever the B<ESC ] 777 ; string ST> command sequence (OSC =
217	operating system command) is processed. Cursor position and other state	258	operating system command) is processed. Cursor position and other state
…		…
230	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
231	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
232	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
233	output.	274	output.
234		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
235	=item on_line_update $term, $row	281	=item on_line_update $term, $row
236		282
237	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
238	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
239	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,
…		…
271	=item on_focus_out $term	317	=item on_focus_out $term
272		318
273	Called wheneever the window loses keyboard focus, before rxvt-unicode does	319	Called wheneever the window loses keyboard focus, before rxvt-unicode does
274	focus out processing.	320	focus out processing.
275		321
276	=item on_key_press $term, $event, $octets	322	=item on_key_press $term, $event, $keysym, $octets
277		323
278	=item on_key_release $term, $event	324	=item on_key_release $term, $event, $keysym
279		325
280	=item on_button_press $term, $event	326	=item on_button_press $term, $event
281		327
282	=item on_button_release $term, $event	328	=item on_button_release $term, $event
283		329
…		…
299		345
300	subwindow.	346	subwindow.
301		347
302	=back	348	=back
303		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
304	=head2 Variables in the C<urxvt> Package	371	=head2 Variables in the C<urxvt> Package
305		372
306	=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>.
307		387
308	=item $urxvt::TERM	388	=item $urxvt::TERM
309		389
310	The current terminal. This variable stores the current C<urxvt::term>	390	The current terminal. This variable stores the current C<urxvt::term>
311	object, whenever a callback/hook is executing.	391	object, whenever a callback/hook is executing.
…		…
313	=back	393	=back
314		394
315	=head2 Functions in the C<urxvt> Package	395	=head2 Functions in the C<urxvt> Package
316		396
317	=over 4	397	=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		398
327	=item urxvt::fatal $errormessage	399	=item urxvt::fatal $errormessage
328		400
329	Fatally aborts execution with the given error message. Avoid at all	401	Fatally aborts execution with the given error message. Avoid at all
330	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
…		…
336	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
337	that calls this function.	409	that calls this function.
338		410
339	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
340	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.
341		421
342	=item $time = urxvt::NOW	422	=item $time = urxvt::NOW
343		423
344	Returns the "current time" (as per the event loop).	424	Returns the "current time" (as per the event loop).
345		425
…		…
384		464
385	=item $background = urxvt::GET_BASEBG $rend	465	=item $background = urxvt::GET_BASEBG $rend
386		466
387	Return the foreground/background colour index, respectively.	467	Return the foreground/background colour index, respectively.
388		468
389	=item $rend = urxvt::SET_FGCOLOR ($rend, $new_colour)	469	=item $rend = urxvt::SET_FGCOLOR $rend, $new_colour
390		470
391	=item $rend = urxvt::SET_BGCOLOR ($rend, $new_colour)	471	=item $rend = urxvt::SET_BGCOLOR $rend, $new_colour
392		472
393	Replace the foreground/background colour in the rendition mask with the	473	Replace the foreground/background colour in the rendition mask with the
394	specified one.	474	specified one.
395		475
396	=item $value = urxvt::GET_CUSTOM ($rend)	476	=item $value = urxvt::GET_CUSTOM $rend
397		477
398	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
399	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
400	zero.	480	zero.
401		481
402	=item $rend = urxvt::SET_CUSTOM ($rend, $new_value)	482	=item $rend = urxvt::SET_CUSTOM $rend, $new_value
403		483
404	Change the custom value.	484	Change the custom value.
405		485
406	=back	486	=back
407		487
408	=cut	488	=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		489
423	BEGIN {	490	BEGIN {
424	urxvt->bootstrap;	491	urxvt->bootstrap;
425		492
426	# overwrite perl's warn	493	# overwrite perl's warn
…		…
429	$msg .= "\n"	496	$msg .= "\n"
430	unless $msg =~ /\n$/;	497	unless $msg =~ /\n$/;
431	urxvt::warn ($msg);	498	urxvt::warn ($msg);
432	};	499	};
433		500
		501	# %ENV is the original startup environment
		502	delete $ENV{IFS};
		503	delete $ENV{CDPATH};
		504	delete $ENV{BASH_ENV};
434	$ENV{PATH} = "/bin:/sbin:/usr/bin:/usr/sbin:/usr/local/bin:/usr/local/sbin:/opt/bin:/opt/sbin";	505	$ENV{PATH} = "/bin:/sbin:/usr/bin:/usr/sbin:/usr/local/bin:/usr/local/sbin:/opt/bin:/opt/sbin";
435	delete $ENV{CDPATH};
436	}	506	}
437		507
438	my @hook_count;	508	my @hook_count;
439	my $verbosity = $ENV{URXVT_PERL_VERBOSITY};	509	my $verbosity = $ENV{URXVT_PERL_VERBOSITY};
440		510
441	sub verbose {	511	sub verbose {
442	my ($level, $msg) = @_;	512	my ($level, $msg) = @_;
443	warn "$msg\n" if $level <= $verbosity;	513	warn "$msg\n" if $level <= $verbosity;
444	}	514	}
445		515
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";	516	my $extension_pkg = "extension0000";
464	my %extension_pkg;	517	my %extension_pkg;
465		518
466	# load a single script into its own package, once only	519	# load a single script into its own package, once only
467	sub extension_package($) {	520	sub extension_package($) {
…		…
473	verbose 3, "loading extension '$path' into package '$pkg'";	526	verbose 3, "loading extension '$path' into package '$pkg'";
474		527
475	open my $fh, "<:raw", $path	528	open my $fh, "<:raw", $path
476	or die "$path: $!";	529	or die "$path: $!";
477		530
		531	my $source = untaint
478	my $source = untaint "package $pkg; use strict; use utf8;\n"	532	"package $pkg; use strict; use utf8;\n"
479	. "use base urxvt::term::proxy::;\n"	533	. "use base urxvt::term::extension::;\n"
480	. "#line 1 \"$path\"\n{\n"	534	. "#line 1 \"$path\"\n{\n"
481	. (do { local $/; <$fh> })	535	. (do { local $/; <$fh> })
482	. "\n};\n1";	536	. "\n};\n1";
483		537
		538	eval $source
484	eval $source or die "$path: $@";	539	or die "$path: $@";
485		540
486	$pkg	541	$pkg
487	}	542	}
488	}	543	}
489		544
…		…
495	my $htype = shift;	550	my $htype = shift;
496		551
497	if ($htype == 0) { # INIT	552	if ($htype == 0) { # INIT
498	my @dirs = ((split /:/, $TERM->resource ("perl_lib")), "$LIBDIR/perl");	553	my @dirs = ((split /:/, $TERM->resource ("perl_lib")), "$LIBDIR/perl");
499		554
500	my %want_ext;	555	my %ext_arg;
501		556
502	for (map { split /,/, $TERM->resource ("perl_ext_$_") } 1, 2) {	557	for (map { split /,/, $TERM->resource ("perl_ext_$_") } 1, 2) {
503	if ($_ eq "default") {	558	if ($_ eq "default") {
504	$want_ext{$_}++ for qw(selection option-popup selection-popup);	559	$ext_arg{$_} \|\|= [] for qw(selection option-popup selection-popup searchable-scrollback);
505	} elsif (/^-(.*)$/) {	560	} elsif (/^-(.*)$/) {
506	delete $want_ext{$1};	561	delete $ext_arg{$1};
		562	} elsif (/^([^<]+)<(.*)>$/) {
		563	push @{ $ext_arg{$1} }, $2;
507	} else {	564	} else {
508	$want_ext{$_}++;	565	$ext_arg{$_} \|\|= [];
509	}	566	}
510	}	567	}
511		568
512	for my $ext (keys %want_ext) {	569	while (my ($ext, $argv) = each %ext_arg) {
513	my @files = grep -f $_, map "$_/$ext", @dirs;	570	my @files = grep -f $_, map "$_/$ext", @dirs;
514		571
515	if (@files) {	572	if (@files) {
516	register_package extension_package $files[0];	573	$TERM->register_package (extension_package $files[0], $argv);
517	} else {	574	} else {
518	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";
519	}	576	}
520	}	577	}
521		578
…		…
530	if $verbosity >= 10;	587	if $verbosity >= 10;
531		588
532	keys %$cb;	589	keys %$cb;
533		590
534	while (my ($pkg, $cb) = each %$cb) {	591	while (my ($pkg, $cb) = each %$cb) {
535	eval {	592	$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;	593	and last;
544	};	594
545	if ($@) {	595	if ($@) {
546	$TERM->ungrab; # better to lose the grab than the session	596	$TERM->ungrab; # better to lose the grab than the session
547	warn $@;	597	warn $@;
548	}	598	}
549	}	599	}
550	}	600	}
551		601
552	if ($htype == 1) { # DESTROY	602	if ($htype == 1) { # DESTROY
553	# remove hooks if unused
554	if (my $hook = $TERM->{_hook}) {	603	if (my $hook = delete $TERM->{_hook}) {
555	for my $htype (0..$#$hook) {	604	for my $htype (0..$#$hook) {
556	$hook_count[$htype] -= scalar keys %{ $hook->[$htype] \|\| {} }	605	$hook_count[$htype] -= scalar keys %{ $hook->[$htype] \|\| {} }
557	or set_should_invoke $htype, 0;	606	or set_should_invoke $htype, 0;
558	}	607	}
559	}	608	}
…		…
566	}	615	}
567		616
568	$retval	617	$retval
569	}	618	}
570		619
571	# urxvt::term::proxy	620	# urxvt::term::extension
572		621
573	sub urxvt::term::proxy::AUTOLOAD {	622	package urxvt::term::extension;
574	$urxvt::term::proxy::AUTOLOAD =~ /:([^:]+)$/	623
		624	sub enable {
		625	my ($self, %hook) = @_;
		626	my $pkg = $self->{_pkg};
		627
		628	while (my ($name, $cb) = each %hook) {
		629	my $htype = $HOOKTYPE{uc $name};
		630	defined $htype
		631	or Carp::croak "unsupported hook type '$name'";
		632
		633	unless (exists $self->{term}{_hook}[$htype]{$pkg}) {
		634	$hook_count[$htype]++
		635	or urxvt::set_should_invoke $htype, 1;
		636	}
		637
		638	$self->{term}{_hook}[$htype]{$pkg} = $cb;
		639	}
		640	}
		641
		642	sub disable {
		643	my ($self, @hook) = @_;
		644	my $pkg = $self->{_pkg};
		645
		646	for my $name (@hook) {
		647	my $htype = $HOOKTYPE{uc $name};
		648	defined $htype
		649	or Carp::croak "unsupported hook type '$name'";
		650
		651	if (delete $self->{term}{_hook}[$htype]{$pkg}) {
		652	--$hook_count[$htype]
		653	or urxvt::set_should_invoke $htype, 0;
		654	}
		655	}
		656	}
		657
		658	our $AUTOLOAD;
		659
		660	sub AUTOLOAD {
		661	$AUTOLOAD =~ /:([^:]+)$/
575	or die "FATAL: \$AUTOLOAD '$urxvt::term::proxy::AUTOLOAD' unparsable";	662	or die "FATAL: \$AUTOLOAD '$AUTOLOAD' unparsable";
576		663
577	eval qq{	664	eval qq{
578	sub $urxvt::term::proxy::AUTOLOAD {	665	sub $AUTOLOAD {
579	my \$proxy = shift;	666	my \$proxy = shift;
580	\$proxy->{term}->$1 (\@_)	667	\$proxy->{term}->$1 (\@_)
581	}	668	}
582	1	669	1
583	} or die "FATAL: unable to compile method forwarder: $@";	670	} or die "FATAL: unable to compile method forwarder: $@";
584		671
585	goto &$urxvt::term::proxy::AUTOLOAD;	672	goto &$AUTOLOAD;
586	}	673	}
587		674
588	sub urxvt::term::proxy::DESTROY {	675	sub DESTROY {
589	# nop	676	# nop
590	}	677	}
591		678
592	# urxvt::destroy_hook	679	# urxvt::destroy_hook
593		680
…		…
603		690
604	=head2 The C<urxvt::anyevent> Class	691	=head2 The C<urxvt::anyevent> Class
605		692
606	The sole purpose of this class is to deliver an interface to the	693	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	694	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	695	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	696	condition variables, but non-blocking condvar use is ok. What this means
610	cannot use blocking APIs, but the non-blocking variant should work.	697	is that you cannot use blocking APIs, but the non-blocking variant should
		698	work.
611		699
612	=cut	700	=cut
613		701
614	our $VERSION = 1;	702	our $VERSION = 1;
615		703
…		…
660	${$_[0]}++;	748	${$_[0]}++;
661	}	749	}
662		750
663	sub urxvt::anyevent::condvar::wait {	751	sub urxvt::anyevent::condvar::wait {
664	unless (${$_[0]}) {	752	unless (${$_[0]}) {
665	require Carp;
666	Carp::croak ("AnyEvent->condvar blocking wait unsupported in urxvt, use a non-blocking API");	753	Carp::croak "AnyEvent->condvar blocking wait unsupported in urxvt, use a non-blocking API";
667	}	754	}
668	}	755	}
669		756
670	package urxvt::term;	757	package urxvt::term;
671		758
672	=head2 The C<urxvt::term> Class	759	=head2 The C<urxvt::term> Class
673		760
674	=over 4	761	=over 4
675		762
		763	=cut
		764
		765	# find on_xxx subs in the package and register them
		766	# as hooks
		767	sub register_package {
		768	my ($self, $pkg, $argv) = @_;
		769
		770	my $proxy = bless {
		771	_pkg => $pkg,
		772	argv => $argv,
		773	}, $pkg;
		774	Scalar::Util::weaken ($proxy->{term} = $self);
		775
		776	$self->{_pkg}{$pkg} = $proxy;
		777
		778	for my $name (@HOOKNAME) {
		779	if (my $ref = $pkg->can ("on_" . lc $name)) {
		780	$proxy->enable ($name => $ref);
		781	}
		782	}
		783	}
		784
		785	=item $term = new urxvt::term $envhashref, $rxvtname, [arg...]
		786
		787	Creates a new terminal, very similar as if you had started it with system
		788	C<$rxvtname, arg...>. C<$envhashref> must be a reference to a C<%ENV>-like
		789	hash which defines the environment of the new terminal.
		790
		791	Croaks (and probably outputs an error message) if the new instance
		792	couldn't be created. Returns C<undef> if the new instance didn't
		793	initialise perl, and the terminal object otherwise. The C<init> and
		794	C<start> hooks will be called during this call.
		795
		796	=cut
		797
		798	sub new {
		799	my ($class, $env, @args) = @_;
		800
		801	_new ([ map "$_=$env->{$_}", keys %$env ], @args);
		802	}
		803
676	=item $term->destroy	804	=item $term->destroy
677		805
678	Destroy the terminal object (close the window, free resources etc.).	806	Destroy the terminal object (close the window, free resources
		807	etc.). Please note that @@RXVT_NAME@@ will not exit as long as any event
		808	watchers (timers, io watchers) are still active.
679		809
680	=item $isset = $term->option ($optval[, $set])	810	=item $isset = $term->option ($optval[, $set])
681		811
682	Returns true if the option specified by C<$optval> is enabled, and	812	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	813	optionally change it. All option values are stored by name in the hash
…		…
733	my ($self, $name) = (shift, shift);	863	my ($self, $name) = (shift, shift);
734	unshift @_, $self, $name, ($name =~ s/\s\+\s(\d+)$// ? $1 : 0);	864	unshift @_, $self, $name, ($name =~ s/\s\+\s(\d+)$// ? $1 : 0);
735	&urxvt::term::_resource	865	&urxvt::term::_resource
736	}	866	}
737		867
		868	=item $value = $term->x_resource ($pattern)
		869
		870	Returns the X-Resource for the given pattern, excluding the program or
		871	class name, i.e. C<< $term->x_resource ("boldFont") >> should return the
		872	same value as used by this instance of rxvt-unicode. Returns C<undef> if no
		873	resource with that pattern exists.
		874
		875	This method should only be called during the C<on_start> hook, as there is
		876	only one resource database per display, and later invocations might return
		877	the wrong resources.
		878
		879	=item $success = $term->parse_keysym ($keysym_spec, $command_string)
		880
		881	Adds a keymap translation exactly as specified via a resource. See the
		882	C<keysym> resource in the @@RXVT_NAME@@(1) manpage.
		883
738	=item $rend = $term->rstyle ([$new_rstyle])	884	=item $rend = $term->rstyle ([$new_rstyle])
739		885
740	Return and optionally change the current rendition. Text that is output by	886	Return and optionally change the current rendition. Text that is output by
741	the terminal application will use this style.	887	the terminal application will use this style.
742		888
…		…
761		907
762	=item $oldtext = $term->selection ([$newtext])	908	=item $oldtext = $term->selection ([$newtext])
763		909
764	Return the current selection text and optionally replace it by C<$newtext>.	910	Return the current selection text and optionally replace it by C<$newtext>.
765		911
766	#=item $term->overlay ($x, $y, $text)	912	=item $term->overlay_simple ($x, $y, $text)
767	#	913
768	#Create a simple multi-line overlay box. See the next method for details.	914	Create a simple multi-line overlay box. See the next method for details.
769	#	915
770	#=cut	916	=cut
771	#	917
772	#sub urxvt::term::scr_overlay {	918	sub overlay_simple {
773	# my ($self, $x, $y, $text) = @_;	919	my ($self, $x, $y, $text) = @_;
774	#	920
775	# my @lines = split /\n/, $text;	921	my @lines = split /\n/, $text;
776	#	922
777	# my $w = 0;	923	my $w = List::Util::max map $self->strwidth ($_), @lines;
778	# for (map $self->strwidth ($_), @lines) {	924
779	# $w = $_ if $w < $_;
780	# }
781	#
782	# $self->scr_overlay_new ($x, $y, $w, scalar @lines);	925	my $overlay = $self->overlay ($x, $y, $w, scalar @lines);
783	# $self->scr_overlay_set (0, $_, $lines[$_]) for 0.. $#lines;	926	$overlay->set (0, $_, $lines[$_]) for 0.. $#lines;
784	#}	927
		928	$overlay
		929	}
785		930
786	=item $term->overlay ($x, $y, $width, $height[, $rstyle[, $border]])	931	=item $term->overlay ($x, $y, $width, $height[, $rstyle[, $border]])
787		932
788	Create a new (empty) overlay at the given position with the given	933	Create a new (empty) overlay at the given position with the given
789	width/height. C<$rstyle> defines the initial rendition style	934	width/height. C<$rstyle> defines the initial rendition style
…		…
856		1001
857	=item $string = $term->locale_decode ($octets)	1002	=item $string = $term->locale_decode ($octets)
858		1003
859	Convert the given locale-encoded octets into a perl string.	1004	Convert the given locale-encoded octets into a perl string.
860		1005
		1006	=item $term->scr_xor_span ($beg_row, $beg_col, $end_row, $end_col[, $rstyle])
		1007
		1008	XORs the rendition values in the given span with the provided value
		1009	(default: C<RS_RVid>). Useful in refresh hooks to provide effects similar
		1010	to the selection.
		1011
		1012	=item $term->scr_xor_rect ($beg_row, $beg_col, $end_row, $end_col[, $rstyle1[, $rstyle2]])
		1013
		1014	Similar to C<scr_xor_span>, but xors a rectangle instead. Trailing
		1015	whitespace will additionally be xored with the C<$rstyle2>, which defaults
		1016	to C<RS_RVid \| RS_Uline>, which removes reverse video again and underlines
		1017	it instead.
		1018
		1019	=item $term->scr_bell
		1020
		1021	Ring the bell!
		1022
861	=item $term->scr_add_lines ($string)	1023	=item $term->scr_add_lines ($string)
862		1024
863	Write the given text string to the screen, as if output by the application	1025	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	1026	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	1027	codes), but is free to use line feeds, carriage returns and tabs. The
…		…
879		1041
880	Write the octets given in C<$data> to the tty (i.e. as program input). To	1042	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	1043	pass characters instead of octets, you should convert your strings first
882	to the locale-specific encoding using C<< $term->locale_encode >>.	1044	to the locale-specific encoding using C<< $term->locale_encode >>.
883		1045
		1046	=item $old_events = $term->pty_ev_events ([$new_events])
		1047
		1048	Replaces the event mask of the pty watcher by the given event mask. Can
		1049	be used to suppress input and output handling to the pty/tty. See the
		1050	description of C<< urxvt::timer->events >>. Make sure to always restore
		1051	the previous value.
		1052
884	=item $windowid = $term->parent	1053	=item $windowid = $term->parent
885		1054
886	Return the window id of the toplevel window.	1055	Return the window id of the toplevel window.
887		1056
888	=item $windowid = $term->vt	1057	=item $windowid = $term->vt
…		…
912	=item $nrow_plus_saveLines = $term->total_rows	1081	=item $nrow_plus_saveLines = $term->total_rows
913		1082
914	=item $lines_in_scrollback = $term->nsaved	1083	=item $lines_in_scrollback = $term->nsaved
915		1084
916	Return various integers describing terminal characteristics.	1085	Return various integers describing terminal characteristics.
		1086
		1087	=item $x_display = $term->display_id
		1088
		1089	Return the DISPLAY used by rxvt-unicode.
		1090
		1091	=item $lc_ctype = $term->locale
		1092
		1093	Returns the LC_CTYPE category string used by this rxvt-unicode.
		1094
		1095	=item $env = $term->env
		1096
		1097	Returns a copy of the environment in effect for the terminal as a hashref
		1098	similar to C<\%ENV>.
		1099
		1100	=cut
		1101
		1102	sub env {
		1103	if (my $env = $_[0]->_env) {
		1104	+{ map /^([^=]+)(?:=(.*))?$/s && ($1 => $2), @$env }
		1105	} else {
		1106	+{ %ENV }
		1107	}
		1108	}
917		1109
918	=item $modifiermask = $term->ModLevel3Mask	1110	=item $modifiermask = $term->ModLevel3Mask
919		1111
920	=item $modifiermask = $term->ModMetaMask	1112	=item $modifiermask = $term->ModMetaMask
921		1113
…		…
1098	$offset / $self->{ncol} + $self->{beg},	1290	$offset / $self->{ncol} + $self->{beg},
1099	$offset % $self->{ncol}	1291	$offset % $self->{ncol}
1100	)	1292	)
1101	}	1293	}
1102		1294
1103	=item ($row, $col) = $line->coord_of ($offset)
1104	=item $text = $term->special_encode $string	1295	=item $text = $term->special_encode $string
1105		1296
1106	Converts a perl string into the special encoding used by rxvt-unicode,	1297	Converts a perl string into the special encoding used by rxvt-unicode,
1107	where one character corresponds to one screen cell. See	1298	where one character corresponds to one screen cell. See
1108	C<< $term->ROW_t >> for details.	1299	C<< $term->ROW_t >> for details.
…		…
1110	=item $string = $term->special_decode $text	1301	=item $string = $term->special_decode $text
1111		1302
1112	Converts rxvt-unicodes text reprsentation into a perl string. See	1303	Converts rxvt-unicodes text reprsentation into a perl string. See
1113	C<< $term->ROW_t >> for details.	1304	C<< $term->ROW_t >> for details.
1114		1305
		1306	=item $success = $term->grab_button ($button, $modifiermask)
		1307
		1308	Registers a synchronous button grab. See the XGrabButton manpage.
		1309
		1310	=item $success = $term->grab ($eventtime[, $sync])
		1311
		1312	Calls XGrabPointer and XGrabKeyboard in asynchronous (default) or
		1313	synchronous (C<$sync> is true). Also remembers the grab timestampe.
		1314
		1315	=item $term->allow_events_async
		1316
		1317	Calls XAllowEvents with AsyncBoth for the most recent grab.
		1318
		1319	=item $term->allow_events_sync
		1320
		1321	Calls XAllowEvents with SyncBoth for the most recent grab.
		1322
		1323	=item $term->allow_events_replay
		1324
		1325	Calls XAllowEvents with both ReplayPointer and ReplayKeyboard for the most
		1326	recent grab.
		1327
		1328	=item $term->ungrab
		1329
		1330	Calls XUngrab for the most recent grab. Is called automatically on
		1331	evaluation errors, as it is better to lose the grab in the error case as
		1332	the session.
		1333
1115	=back	1334	=back
1116		1335
1117	=cut	1336	=cut
1118		1337
1119	package urxvt::popup;	1338	package urxvt::popup;
…		…
1134	$item->{render} \|\|= sub { $_[0]{text} };	1353	$item->{render} \|\|= sub { $_[0]{text} };
1135		1354
1136	push @{ $self->{item} }, $item;	1355	push @{ $self->{item} }, $item;
1137	}	1356	}
1138		1357
1139	sub add_separator {	1358	=item $popup->add_title ($title)
1140	my ($self, $sep) = @_;
1141		1359
1142	$sep \|\|= "═";	1360	Adds a non-clickable title to the popup.
1143		1361
1144	$self->add_item ({	1362	=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		1363
1152	sub add_title {	1364	sub add_title {
1153	my ($self, $title) = @_;	1365	my ($self, $title) = @_;
1154		1366
1155	$self->add_item ({	1367	$self->add_item ({
…		…
1157	text => $title,	1369	text => $title,
1158	activate => sub { },	1370	activate => sub { },
1159	});	1371	});
1160	}	1372	}
1161		1373
		1374	=item $popup->add_separator ([$sepchr])
		1375
		1376	Creates a separator, optionally using the character given as C<$sepchr>.
		1377
		1378	=cut
		1379
		1380	sub add_separator {
		1381	my ($self, $sep) = @_;
		1382
		1383	$sep \|\|= "=";
		1384
		1385	$self->add_item ({
		1386	rend => { normal => "\x1b[0;30;47m", hover => "\x1b[0;30;47m", active => "\x1b[0;30;47m" },
		1387	text => "",
		1388	render => sub { $sep x $self->{term}->ncol },
		1389	activate => sub { },
		1390	});
		1391	}
		1392
		1393	=item $popup->add_button ($text, $cb)
		1394
		1395	Adds a clickable button to the popup. C<$cb> is called whenever it is
		1396	selected.
		1397
		1398	=cut
		1399
1162	sub add_button {	1400	sub add_button {
1163	my ($self, $text, $cb) = @_;	1401	my ($self, $text, $cb) = @_;
1164		1402
1165	$self->add_item ({ type => "button", text => "[ $text ]", activate => $cb});	1403	$self->add_item ({ type => "button", text => $text, activate => $cb});
1166	}	1404	}
		1405
		1406	=item $popup->add_toggle ($text, $cb, $initial_value)
		1407
		1408	Adds a toggle/checkbox item to the popup. Teh callback gets called
		1409	whenever it gets toggled, with a boolean indicating its value as its first
		1410	argument.
		1411
		1412	=cut
1167		1413
1168	sub add_toggle {	1414	sub add_toggle {
1169	my ($self, $text, $cb, $value) = @_;	1415	my ($self, $text, $cb, $value) = @_;
1170		1416
1171	my $item; $item = {	1417	my $item; $item = {
1172	type => "button",	1418	type => "button",
1173	text => " $text",	1419	text => " $text",
1174	value => $value,	1420	value => $value,
1175	render => sub { ($_[0]{value} ? "* " : " ") . $text },	1421	render => sub { ($_[0]{value} ? "* " : " ") . $text },
1176	activate => sub { $cb->($_[0]{value} = !$_[0]{value}); },	1422	activate => sub { $cb->($_[1]{value} = !$_[1]{value}); },
1177	};	1423	};
1178		1424
1179	$self->add_item ($item);	1425	$self->add_item ($item);
1180	}	1426	}
		1427
		1428	=item $popup->show
		1429
		1430	Displays the popup (which is initially hidden).
		1431
		1432	=cut
1181		1433
1182	sub show {	1434	sub show {
1183	my ($self) = @_;	1435	my ($self) = @_;
1184		1436
1185	local $urxvt::popup::self = $self;	1437	local $urxvt::popup::self = $self;
1186		1438
		1439	my $env = $self->{term}->env;
		1440	# we can't hope to reproduce the locale algorithm, so nuke LC_ALL and set LC_CTYPE.
		1441	delete $env->{LC_ALL};
		1442	$env->{LC_CTYPE} = $self->{term}->locale;
		1443
		1444	urxvt::term->new ($env, $self->{term}->resource ("name"),
1187	urxvt->new ("--perl-lib" => "", "--perl-ext-common" => "", "-pty-fd" => -1, "-sl" => 0, "-b" => 0,	1445	"--perl-lib" => "", "--perl-ext-common" => "", "-pty-fd" => -1, "-sl" => 0, "-b" => 0,
1188	"--transient-for" => $self->{term}->parent,	1446	"--transient-for" => $self->{term}->parent,
		1447	"-display" => $self->{term}->display_id,
1189	"-pe" => "urxvt-popup")	1448	"-pe" => "urxvt-popup")
1190	or die "unable to create popup window\n";	1449	or die "unable to create popup window\n";
1191	}	1450	}
1192		1451
1193	sub DESTROY {	1452	sub DESTROY {
1194	my ($self) = @_;	1453	my ($self) = @_;
1195		1454
1196	delete $self->{term}{_destroy}{$self};	1455	delete $self->{term}{_destroy}{$self};
1197	$self->{term}->ungrab;	1456	$self->{term}->ungrab;
1198	}	1457	}
		1458
		1459	=back
1199		1460
1200	=head2 The C<urxvt::timer> Class	1461	=head2 The C<urxvt::timer> Class
1201		1462
1202	This class implements timer watchers/events. Time is represented as a	1463	This class implements timer watchers/events. Time is represented as a
1203	fractional number of seconds since the epoch. Example:	1464	fractional number of seconds since the epoch. Example:
…		…
1256		1517
1257	$term->{socket} = ...	1518	$term->{socket} = ...
1258	$term->{iow} = urxvt::iow	1519	$term->{iow} = urxvt::iow
1259	->new	1520	->new
1260	->fd (fileno $term->{socket})	1521	->fd (fileno $term->{socket})
1261	->events (1) # wait for read data	1522	->events (urxvt::EVENT_READ)
1262	->start	1523	->start
1263	->cb (sub {	1524	->cb (sub {
1264	my ($iow, $revents) = @_;	1525	my ($iow, $revents) = @_;
1265	# $revents must be 1 here, no need to check	1526	# $revents must be 1 here, no need to check
1266	sysread $term->{socket}, my $buf, 8192	1527	sysread $term->{socket}, my $buf, 8192
…		…
1283		1544
1284	Set the filedescriptor (not handle) to watch.	1545	Set the filedescriptor (not handle) to watch.
1285		1546
1286	=item $iow = $iow->events ($eventmask)	1547	=item $iow = $iow->events ($eventmask)
1287		1548
1288	Set the event mask to watch. Bit #0 (value C<1>) enables watching for read	1549	Set the event mask to watch. The only allowed values are
1289	data, Bit #1 (value C<2>) enables watching for write data.	1550	C<urxvt::EVENT_READ> and C<urxvt::EVENT_WRITE>, which might be ORed
		1551	together, or C<urxvt::EVENT_NONE>.
1290		1552
1291	=item $iow = $iow->start	1553	=item $iow = $iow->start
1292		1554
1293	Start watching for requested events on the given handle.	1555	Start watching for requested events on the given handle.
1294		1556

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.83 by root, Thu Jan 12 01:38:37 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.83 by root, Thu Jan 12 01:38:37 2006 UTC