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

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

…		…
17		17
18	@@RXVT_NAME@@ --perl-lib $HOME -pe grab_test	18	@@RXVT_NAME@@ --perl-lib $HOME -pe grab_test
19		19
20	=head1 DESCRIPTION	20	=head1 DESCRIPTION
21		21
22	Everytime a terminal object gets created, scripts specified via the	22	Everytime a terminal object gets created, extension scripts specified via
23	C<perl> resource are loaded and associated with it.	23	the C<perl> resource are loaded and associated with it.
24		24
25	Scripts are compiled in a 'use strict' and 'use utf8' environment, and	25	Scripts are compiled in a 'use strict' and 'use utf8' environment, and
26	thus must be encoded as UTF-8.	26	thus must be encoded as UTF-8.
27		27
28	Each script will only ever be loaded once, even in @@RXVT_NAME@@d, where	28	Each script will only ever be loaded once, even in @@RXVT_NAME@@d, where
…		…
37		37
38	@@RXVT_NAME@@ -pe <extensionname>	38	@@RXVT_NAME@@ -pe <extensionname>
39		39
40	=over 4	40	=over 4
41		41
42	=item selection	42	=item selection (enabled by default)
43		43
44	Intelligent selection. This extension tries to be more intelligent when	44	Intelligent selection. This extension tries to be more intelligent when
45	the user extends selections (double-click). Right now, it tries to select	45	the user extends selections (double-click). Right now, it tries to select
46	urls and complete shell-quoted arguments, which is very convenient, too,	46	urls and complete shell-quoted arguments, which is very convenient, too,
47	if your F<ls> supports C<--quoting-style=shell>.	47	if your F<ls> supports C<--quoting-style=shell>.
…		…
56		56
57	URxvt.keysym.C-M-r: perl:selection:rot13	57	URxvt.keysym.C-M-r: perl:selection:rot13
58		58
59	=back	59	=back
60		60
		61	=item option-popup (enabled by default)
		62
		63	Binds a popup menu to Ctrl-Button2 that lets you toggle (some) options at
		64	runtime.
		65
		66	=item selection-popup (enabled by default)
		67
		68	Binds a popup menu to Ctrl-Button3 that lets you convert the selection
		69	text into various other formats/action.
		70
61	=item digital-clock	71	=item digital-clock
62		72
63	Displays a digital clock using the built-in overlay.	73	Displays a digital clock using the built-in overlay.
64		74
65	=item mark-urls	75	=item mark-urls
66		76
67	Uses per-line filtering (C<on_line_update>) to underline urls.	77	Uses per-line display filtering (C<on_line_update>) to underline urls.
		78
		79	=item block-graphics-to-ascii
		80
		81	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
		83	similar-looking ascii character.
68		84
69	=item example-refresh-hooks	85	=item example-refresh-hooks
70		86
71	Displays a very simple digital clock in the upper right corner of the	87	Displays a very simple digital clock in the upper right corner of the
72	window. Illustrates overwriting the refresh callbacks to create your own	88	window. Illustrates overwriting the refresh callbacks to create your own
73	overlays or changes.	89	overlays or changes.
74
75	=item example-filter-input
76
77	A not very useful example of filtering all text output to the terminal, by
78	underlining all urls that matches a certain regex (i.e. some urls :). It
79	is not very useful because urls that are output in multiple steps (e.g.
80	when typing them) do not get marked.
81		90
82	=back	91	=back
83		92
84	=head2 General API Considerations	93	=head2 General API Considerations
85		94
…		…
117		126
118	=back	127	=back
119		128
120	=head2 Hooks	129	=head2 Hooks
121		130
122	The following subroutines can be declared in loaded scripts, and will be	131	The following subroutines can be declared in extension files, and will be
123	called whenever the relevant event happens.	132	called whenever the relevant event happens.
124		133
125	The first argument passed to them is an object private to each terminal	134	The first argument passed to them is an object private to each terminal
126	and extension package. You can call all C<urxvt::term> methods on it, but	135	and extension package. You can call all C<urxvt::term> methods on it, but
127	its not a real C<urxvt::term> object. Instead, the real C<urxvt::term>	136	its not a real C<urxvt::term> object. Instead, the real C<urxvt::term>
128	object that is shared between all packages is stored in the C<term>	137	object that is shared between all packages is stored in the C<term>
129	member.	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.
130		140
131	All of them must return a boolean value. If it is true, then the event	141	All of them must return a boolean value. If it is true, then the event
132	counts as being I<consumed>, and the invocation of other hooks is skipped,	142	counts as being I<consumed>, and the invocation of other hooks is skipped,
133	and the relevant action might not be carried out by the C++ code.	143	and the relevant action might not be carried out by the C++ code.
134		144
…		…
179	should extend the selection itelf and return true to suppress the built-in	189	should extend the selection itelf and return true to suppress the built-in
180	processing.	190	processing.
181		191
182	See the F<selection> example extension.	192	See the F<selection> example extension.
183		193
184	=item on_focus_in $term
185
186	Called whenever the window gets the keyboard focus, before urxvt does
187	focus in processing.
188
189	=item on_focus_out $term
190
191	Called wheneever the window loses keyboard focus, before urxvt does focus
192	out processing.
193
194	=item on_view_change $term, $offset	194	=item on_view_change $term, $offset
195		195
196	Called whenever the view offset changes, i..e the user or program	196	Called whenever the view offset changes, i..e the user or program
197	scrolls. Offset C<0> means display the normal terminal, positive values	197	scrolls. Offset C<0> means display the normal terminal, positive values
198	show this many lines of scrollback.	198	show this many lines of scrollback.
…		…
204	than the scroll back buffer or the terminal.	204	than the scroll back buffer or the terminal.
205		205
206	It is called before lines are scrolled out (so rows 0 .. min ($lines - 1,	206	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	207	$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.	208	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		209
214	=item on_osc_seq $term, $string	210	=item on_osc_seq $term, $string
215		211
216	Called whenever the B<ESC ] 777 ; string ST> command sequence (OSC =	212	Called whenever the B<ESC ] 777 ; string ST> command sequence (OSC =
217	operating system command) is processed. Cursor position and other state	213	operating system command) is processed. Cursor position and other state
…		…
261		257
262	Called whenever the user presses a key combination that has a	258	Called whenever the user presses a key combination that has a
263	C<perl:string> action bound to it (see description of the B<keysym>	259	C<perl:string> action bound to it (see description of the B<keysym>
264	resource in the @@RXVT_NAME@@(1) manpage).	260	resource in the @@RXVT_NAME@@(1) manpage).
265		261
		262	=item on_focus_in $term
		263
		264	Called whenever the window gets the keyboard focus, before rxvt-unicode
		265	does focus in processing.
		266
		267	=item on_focus_out $term
		268
		269	Called wheneever the window loses keyboard focus, before rxvt-unicode does
		270	focus out processing.
		271
266	=item on_key_press $term, $event, $octets	272	=item on_key_press $term, $event, $octets
267		273
268	=item on_key_release $term, $event	274	=item on_key_release $term, $event
269		275
270	=item on_button_press $term, $event	276	=item on_button_press $term, $event
271		277
272	=item on_button_release $term, $event	278	=item on_button_release $term, $event
273		279
274	=item on_motion_notify $term, $event	280	=item on_motion_notify $term, $event
275		281
		282	=item on_map_notify $term, $event
		283
		284	=item on_unmap_notify $term, $event
		285
276	Called whenever the corresponding X event is received for the terminal	286	Called whenever the corresponding X event is received for the terminal If
277	(see the XEvent manpage) If the hook returns true, then the even will be	287	the hook returns true, then the even will be ignored by rxvt-unicode.
278	ignored by rxvt-unicode.	288
		289	The event is a hash with most values as named by Xlib (see the XEvent
		290	manpage), with the additional members C<row> and C<col>, which are the row
		291	and column under the mouse cursor.
279		292
280	C<on_key_press> additionally receives the string rxvt-unicode would	293	C<on_key_press> additionally receives the string rxvt-unicode would
281	output, if any, in locale-specific encoding.	294	output, if any, in locale-specific encoding.
282		295
283	subwindow.	296	subwindow.
…		…
288		301
289	=over 4	302	=over 4
290		303
291	=item $urxvt::TERM	304	=item $urxvt::TERM
292		305
293	The current terminal. Whenever a callback/Hook is bein executed, this	306	The current terminal. This variable stores the current C<urxvt::term>
294	variable stores the current C<urxvt::term> object.	307	object, whenever a callback/hook is executing.
295		308
296	=back	309	=back
297		310
298	=head2 Functions in the C<urxvt> Package	311	=head2 Functions in the C<urxvt> Package
299		312
…		…
320	that calls this function.	333	that calls this function.
321		334
322	Using this function has the advantage that its output ends up in the	335	Using this function has the advantage that its output ends up in the
323	correct place, e.g. on stderr of the connecting urxvtc client.	336	correct place, e.g. on stderr of the connecting urxvtc client.
324		337
		338	=item $is_safe = urxvt::safe
		339
		340	Returns true when it is safe to do potentially unsafe things, such as
		341	evaluating perl code specified by the user. This is true when urxvt was
		342	started setuid or setgid.
		343
325	=item $time = urxvt::NOW	344	=item $time = urxvt::NOW
326		345
327	Returns the "current time" (as per the event loop).	346	Returns the "current time" (as per the event loop).
		347
		348	=item urxvt::CurrentTime
		349
		350	=item urxvt::ShiftMask, LockMask, ControlMask, Mod1Mask, Mod2Mask,
		351	Mod3Mask, Mod4Mask, Mod5Mask, Button1Mask, Button2Mask, Button3Mask,
		352	Button4Mask, Button5Mask, AnyModifier
		353
		354	Various constants for use in X calls and event processing.
328		355
329	=back	356	=back
330		357
331	=head2 RENDITION	358	=head2 RENDITION
332		359
…		…
382		409
383	=cut	410	=cut
384		411
385	package urxvt;	412	package urxvt;
386		413
		414	use utf8;
387	use strict;	415	use strict;
388	use Scalar::Util ();	416	use Scalar::Util ();
		417	use List::Util ();
389		418
		419	our $VERSION = 1;
390	our $TERM;	420	our $TERM;
391	our @HOOKNAME;	421	our @HOOKNAME;
		422	our %OPTION;
392	our $LIBDIR;	423	our $LIBDIR;
393		424
394	BEGIN {	425	BEGIN {
395	urxvt->bootstrap;	426	urxvt->bootstrap;
396		427
…		…
399	my $msg = join "", @_;	430	my $msg = join "", @_;
400	$msg .= "\n"	431	$msg .= "\n"
401	unless $msg =~ /\n$/;	432	unless $msg =~ /\n$/;
402	urxvt::warn ($msg);	433	urxvt::warn ($msg);
403	};	434	};
		435
		436	delete $ENV{IFS};
		437	delete $ENV{CDPATH};
		438	delete $ENV{BASH_ENV};
		439	$ENV{PATH} = "/bin:/sbin:/usr/bin:/usr/sbin:/usr/local/bin:/usr/local/sbin:/opt/bin:/opt/sbin";
404	}	440	}
405		441
406	my @hook_count;	442	my @hook_count;
407	my $verbosity = $ENV{URXVT_PERL_VERBOSITY};	443	my $verbosity = $ENV{URXVT_PERL_VERBOSITY};
408		444
…		…
426	$hook_count[$htype]++	462	$hook_count[$htype]++
427	or set_should_invoke $htype, 1;	463	or set_should_invoke $htype, 1;
428	}	464	}
429	}	465	}
430		466
431	my $script_pkg = "script0000";	467	my $extension_pkg = "extension0000";
432	my %script_pkg;	468	my %extension_pkg;
433		469
434	# load a single script into its own package, once only	470	# load a single script into its own package, once only
435	sub script_package($) {	471	sub extension_package($) {
436	my ($path) = @_;	472	my ($path) = @_;
437		473
438	$script_pkg{$path} \|\|= do {	474	$extension_pkg{$path} \|\|= do {
439	my $pkg = "urxvt::" . ($script_pkg++);	475	my $pkg = "urxvt::" . ($extension_pkg++);
440		476
441	verbose 3, "loading script '$path' into package '$pkg'";	477	verbose 3, "loading extension '$path' into package '$pkg'";
442		478
443	open my $fh, "<:raw", $path	479	open my $fh, "<:raw", $path
444	or die "$path: $!";	480	or die "$path: $!";
445		481
446	my $source = "package $pkg; use strict; use utf8;\n"	482	my $source = untaint "package $pkg; use strict; use utf8;\n"
		483	. "use base urxvt::term::proxy::;\n"
447	. "#line 1 \"$path\"\n{\n"	484	. "#line 1 \"$path\"\n{\n"
448	. (do { local $/; <$fh> })	485	. (do { local $/; <$fh> })
449	. "\n};\n1";	486	. "\n};\n1";
450		487
451	eval $source or die "$path: $@";	488	eval $source or die "$path: $@";
…		…
461	local $TERM = shift;	498	local $TERM = shift;
462	my $htype = shift;	499	my $htype = shift;
463		500
464	if ($htype == 0) { # INIT	501	if ($htype == 0) { # INIT
465	my @dirs = ((split /:/, $TERM->resource ("perl_lib")), "$LIBDIR/perl");	502	my @dirs = ((split /:/, $TERM->resource ("perl_lib")), "$LIBDIR/perl");
		503
		504	my %want_ext;
466		505
467	for my $ext (map { split /:/, $TERM->resource ("perl_ext_$_") } 1, 2) {	506	for (map { split /,/, $TERM->resource ("perl_ext_$_") } 1, 2) {
		507	if ($_ eq "default") {
		508	$want_ext{$_}++ for qw(selection option-popup selection-popup);
		509	} elsif (/^-(.*)$/) {
		510	delete $want_ext{$1};
		511	} else {
		512	$want_ext{$_}++;
		513	}
		514	}
		515
		516	for my $ext (keys %want_ext) {
468	my @files = grep -f $_, map "$_/$ext", @dirs;	517	my @files = grep -f $_, map "$_/$ext", @dirs;
469		518
470	if (@files) {	519	if (@files) {
471	register_package script_package $files[0];	520	register_package extension_package $files[0];
472	} else {	521	} else {
473	warn "perl extension '$ext' not found in perl library search path\n";	522	warn "perl extension '$ext' not found in perl library search path\n";
474	}	523	}
475	}	524	}
		525
		526	eval "#line 1 \"--perl-eval resource/argument\"\n" . $TERM->resource ("perl_eval");
		527	warn $@ if $@;
476	}	528	}
477		529
478	$retval = undef;	530	$retval = undef;
479		531
480	if (my $cb = $TERM->{_hook}[$htype]) {	532	if (my $cb = $TERM->{_hook}[$htype]) {
…		…
482	if $verbosity >= 10;	534	if $verbosity >= 10;
483		535
484	keys %$cb;	536	keys %$cb;
485		537
486	while (my ($pkg, $cb) = each %$cb) {	538	while (my ($pkg, $cb) = each %$cb) {
		539	eval {
487	$retval = $cb->(	540	$retval = $cb->(
488	$TERM->{_pkg}{$pkg} \|\|= do {	541	$TERM->{_pkg}{$pkg} \|\|= do {
489	my $proxy = bless { }, urxvt::term::proxy::;	542	my $proxy = bless { }, $pkg;
490	Scalar::Util::weaken ($proxy->{term} = $TERM);	543	Scalar::Util::weaken ($proxy->{term} = $TERM);
491	$proxy	544	$proxy
492	},	545	},
493	@_,	546	@_,
494	) and last;	547	) and last;
		548	};
		549	if ($@) {
		550	$TERM->ungrab; # better to lose the grab than the session
		551	warn $@;
		552	}
495	}	553	}
496	}	554	}
497		555
498	if ($htype == 1) { # DESTROY	556	if ($htype == 1) { # DESTROY
499	# remove hooks if unused	557	# remove hooks if unused
…		…
512	}	570	}
513		571
514	$retval	572	$retval
515	}	573	}
516		574
		575	# urxvt::term::proxy
		576
517	sub urxvt::term::proxy::AUTOLOAD {	577	sub urxvt::term::proxy::AUTOLOAD {
518	$urxvt::term::proxy::AUTOLOAD =~ /:([^:]+)$/	578	$urxvt::term::proxy::AUTOLOAD =~ /:([^:]+)$/
519	or die "FATAL: \$AUTOLOAD '$urxvt::term::proxy::AUTOLOAD' unparsable";	579	or die "FATAL: \$AUTOLOAD '$urxvt::term::proxy::AUTOLOAD' unparsable";
520		580
521	eval qq{	581	eval qq{
…		…
527	} or die "FATAL: unable to compile method forwarder: $@";	587	} or die "FATAL: unable to compile method forwarder: $@";
528		588
529	goto &$urxvt::term::proxy::AUTOLOAD;	589	goto &$urxvt::term::proxy::AUTOLOAD;
530	}	590	}
531		591
		592	sub urxvt::term::proxy::DESTROY {
		593	# nop
		594	}
		595
		596	# urxvt::destroy_hook
		597
		598	sub urxvt::destroy_hook::DESTROY {
		599	${$_[0]}->();
		600	}
		601
		602	sub urxvt::destroy_hook(&) {
		603	bless \shift, urxvt::destroy_hook::
		604	}
		605
		606	package urxvt::anyevent;
		607
		608	=head2 The C<urxvt::anyevent> Class
		609
		610	The sole purpose of this class is to deliver an interface to the
		611	C<AnyEvent> module - any module using it will work inside urxvt without
		612	further work. The only exception is that you cannot wait on condition
		613	variables, but non-blocking condvar use is ok. What this means is that you
		614	cannot use blocking APIs, but the non-blocking variant should work.
		615
		616	=cut
		617
		618	our $VERSION = 1;
		619
		620	$INC{"urxvt/anyevent.pm"} = 1; # mark us as there
		621	push @AnyEvent::REGISTRY, [urxvt => urxvt::anyevent::];
		622
		623	sub timer {
		624	my ($class, %arg) = @_;
		625
		626	my $cb = $arg{cb};
		627
		628	urxvt::timer
		629	->new
		630	->start (urxvt::NOW + $arg{after})
		631	->cb (sub {
		632	$_[0]->stop; # need to cancel manually
		633	$cb->();
		634	})
		635	}
		636
		637	sub io {
		638	my ($class, %arg) = @_;
		639
		640	my $cb = $arg{cb};
		641
		642	bless [$arg{fh}, urxvt::iow
		643	->new
		644	->fd (fileno $arg{fh})
		645	->events (($arg{poll} =~ /r/ ? 1 : 0)
		646	\| ($arg{poll} =~ /w/ ? 2 : 0))
		647	->start
		648	->cb (sub {
		649	$cb->(($_[1] & 1 ? 'r' : '')
		650	. ($_[1] & 2 ? 'w' : ''));
		651	})],
		652	urxvt::anyevent::
		653	}
		654
		655	sub DESTROY {
		656	$_[0][1]->stop;
		657	}
		658
		659	sub condvar {
		660	bless \my $flag, urxvt::anyevent::condvar::
		661	}
		662
		663	sub urxvt::anyevent::condvar::broadcast {
		664	${$_[0]}++;
		665	}
		666
		667	sub urxvt::anyevent::condvar::wait {
		668	unless (${$_[0]}) {
		669	require Carp;
		670	Carp::croak ("AnyEvent->condvar blocking wait unsupported in urxvt, use a non-blocking API");
		671	}
		672	}
		673
		674	package urxvt::term;
		675
532	=head2 The C<urxvt::term> Class	676	=head2 The C<urxvt::term> Class
533		677
534	=over 4	678	=over 4
535		679
536	=item $term->destroy	680	=item $term->destroy
537		681
538	Destroy the terminal object (close the window, free resources etc.).	682	Destroy the terminal object (close the window, free resources etc.).
		683
		684	=item $isset = $term->option ($optval[, $set])
		685
		686	Returns true if the option specified by C<$optval> is enabled, and
		687	optionally change it. All option values are stored by name in the hash
		688	C<%urxvt::OPTION>. Options not enabled in this binary are not in the hash.
		689
		690	Here is a a likely non-exhaustive list of option names, please see the
		691	source file F</src/optinc.h> to see the actual list:
		692
		693	borderLess console cursorBlink cursorUnderline hold iconic insecure
		694	intensityStyles jumpScroll loginShell mapAlert meta8 mouseWheelScrollPage
		695	pastableTabs pointerBlank reverseVideo scrollBar scrollBar_floating
		696	scrollBar_right scrollTtyKeypress scrollTtyOutput scrollWithBuffer
		697	secondaryScreen secondaryScroll skipBuiltinGlyphs transparent
		698	tripleclickwords utmpInhibit visualBell
539		699
540	=item $value = $term->resource ($name[, $newval])	700	=item $value = $term->resource ($name[, $newval])
541		701
542	Returns the current resource value associated with a given name and	702	Returns the current resource value associated with a given name and
543	optionally sets a new value. Setting values is most useful in the C<init>	703	optionally sets a new value. Setting values is most useful in the C<init>
…		…
553		713
554	Please note that resource strings will currently only be freed when the	714	Please note that resource strings will currently only be freed when the
555	terminal is destroyed, so changing options frequently will eat memory.	715	terminal is destroyed, so changing options frequently will eat memory.
556		716
557	Here is a a likely non-exhaustive list of resource names, not all of which	717	Here is a a likely non-exhaustive list of resource names, not all of which
558	are supported in every build, please see the source to see the actual	718	are supported in every build, please see the source file F</src/rsinc.h>
559	list:	719	to see the actual list:
560		720
561	answerbackstring backgroundPixmap backspace_key boldFont boldItalicFont	721	answerbackstring backgroundPixmap backspace_key boldFont boldItalicFont
562	borderLess color cursorBlink cursorUnderline cutchars delete_key	722	borderLess color cursorBlink cursorUnderline cutchars delete_key
563	display_name embed ext_bwidth fade font geometry hold iconName	723	display_name embed ext_bwidth fade font geometry hold iconName
564	imFont imLocale inputMethod insecure int_bwidth intensityStyles	724	imFont imLocale inputMethod insecure int_bwidth intensityStyles
…		…
571	shade term_name title transparent transparent_all tripleclickwords	731	shade term_name title transparent transparent_all tripleclickwords
572	utmpInhibit visualBell	732	utmpInhibit visualBell
573		733
574	=cut	734	=cut
575		735
576	sub urxvt::term::resource($$;$) {	736	sub resource($$;$) {
577	my ($self, $name) = (shift, shift);	737	my ($self, $name) = (shift, shift);
578	unshift @_, $self, $name, ($name =~ s/\s\+\s(\d+)$// ? $1 : 0);	738	unshift @_, $self, $name, ($name =~ s/\s\+\s(\d+)$// ? $1 : 0);
579	goto &urxvt::term::_resource;	739	&urxvt::term::_resource
580	}	740	}
581		741
582	=item $rend = $term->rstyle ([$new_rstyle])	742	=item $rend = $term->rstyle ([$new_rstyle])
583		743
584	Return and optionally change the current rendition. Text that is output by	744	Return and optionally change the current rendition. Text that is output by
…		…
660		820
661	If hidden, display the overlay again.	821	If hidden, display the overlay again.
662		822
663	=back	823	=back
664		824
		825	=item $popup = $term->popup ($event)
		826
		827	Creates a new C<urxvt::popup> object that implements a popup menu. The
		828	C<$event> I<must> be the event causing the menu to pop up (a button event,
		829	currently).
		830
		831	=cut
		832
		833	sub popup {
		834	my ($self, $event) = @_;
		835
		836	$self->grab ($event->{time}, 1)
		837	or return;
		838
		839	my $popup = bless {
		840	term => $self,
		841	event => $event,
		842	}, urxvt::popup::;
		843
		844	Scalar::Util::weaken $popup->{term};
		845
		846	$self->{_destroy}{$popup} = urxvt::destroy_hook { $popup->{popup}->destroy };
		847	Scalar::Util::weaken $self->{_destroy}{$popup};
		848
		849	$popup
		850	}
		851
665	=item $cellwidth = $term->strwidth $string	852	=item $cellwidth = $term->strwidth ($string)
666		853
667	Returns the number of screen-cells this string would need. Correctly	854	Returns the number of screen-cells this string would need. Correctly
668	accounts for wide and combining characters.	855	accounts for wide and combining characters.
669		856
670	=item $octets = $term->locale_encode $string	857	=item $octets = $term->locale_encode ($string)
671		858
672	Convert the given text string into the corresponding locale encoding.	859	Convert the given text string into the corresponding locale encoding.
673		860
674	=item $string = $term->locale_decode $octets	861	=item $string = $term->locale_decode ($octets)
675		862
676	Convert the given locale-encoded octets into a perl string.	863	Convert the given locale-encoded octets into a perl string.
677		864
678	=item $term->scr_add_lines ($string)	865	=item $term->scr_add_lines ($string)
679		866
…		…
696		883
697	Write the octets given in C<$data> to the tty (i.e. as program input). To	884	Write the octets given in C<$data> to the tty (i.e. as program input). To
698	pass characters instead of octets, you should convert your strings first	885	pass characters instead of octets, you should convert your strings first
699	to the locale-specific encoding using C<< $term->locale_encode >>.	886	to the locale-specific encoding using C<< $term->locale_encode >>.
700		887
		888	=item $windowid = $term->parent
		889
		890	Return the window id of the toplevel window.
		891
		892	=item $windowid = $term->vt
		893
		894	Return the window id of the terminal window.
		895
701	=item $window_width = $term->width	896	=item $window_width = $term->width
702		897
703	=item $window_height = $term->height	898	=item $window_height = $term->height
704		899
705	=item $font_width = $term->fwidth	900	=item $font_width = $term->fwidth
…		…
721	=item $nrow_plus_saveLines = $term->total_rows	916	=item $nrow_plus_saveLines = $term->total_rows
722		917
723	=item $lines_in_scrollback = $term->nsaved	918	=item $lines_in_scrollback = $term->nsaved
724		919
725	Return various integers describing terminal characteristics.	920	Return various integers describing terminal characteristics.
		921
		922	=item $lc_ctype = $term->locale
		923
		924	Returns the LC_CTYPE category string used by this rxvt-unicode.
		925
		926	=item $x_display = $term->display_id
		927
		928	Return the DISPLAY used by rxvt-unicode.
		929
		930	=item $modifiermask = $term->ModLevel3Mask
		931
		932	=item $modifiermask = $term->ModMetaMask
		933
		934	=item $modifiermask = $term->ModNumLockMask
		935
		936	Return the modifier masks corresponding to the "ISO Level 3 Shift" (often
		937	AltGr), the meta key (often Alt) and the num lock key, if applicable.
726		938
727	=item $view_start = $term->view_start ([$newvalue])	939	=item $view_start = $term->view_start ([$newvalue])
728		940
729	Returns the negative row number of the topmost line. Minimum value is	941	Returns the negative row number of the topmost line. Minimum value is
730	C<0>, which displays the normal terminal contents. Larger values scroll	942	C<0>, which displays the normal terminal contents. Larger values scroll
…		…
824		1036
825	=back	1037	=back
826		1038
827	=cut	1039	=cut
828		1040
829	sub urxvt::term::line {	1041	sub line {
830	my ($self, $row) = @_;	1042	my ($self, $row) = @_;
831		1043
832	my $maxrow = $self->nrow - 1;	1044	my $maxrow = $self->nrow - 1;
833		1045
834	my ($beg, $end) = ($row, $row);	1046	my ($beg, $end) = ($row, $row);
…		…
898	$offset / $self->{ncol} + $self->{beg},	1110	$offset / $self->{ncol} + $self->{beg},
899	$offset % $self->{ncol}	1111	$offset % $self->{ncol}
900	)	1112	)
901	}	1113	}
902		1114
903	=item ($row, $col) = $line->coord_of ($offset)
904	=item $text = $term->special_encode $string	1115	=item $text = $term->special_encode $string
905		1116
906	Converts a perl string into the special encoding used by rxvt-unicode,	1117	Converts a perl string into the special encoding used by rxvt-unicode,
907	where one character corresponds to one screen cell. See	1118	where one character corresponds to one screen cell. See
908	C<< $term->ROW_t >> for details.	1119	C<< $term->ROW_t >> for details.
…		…
910	=item $string = $term->special_decode $text	1121	=item $string = $term->special_decode $text
911		1122
912	Converts rxvt-unicodes text reprsentation into a perl string. See	1123	Converts rxvt-unicodes text reprsentation into a perl string. See
913	C<< $term->ROW_t >> for details.	1124	C<< $term->ROW_t >> for details.
914		1125
		1126	=item $success = $term->grab_button ($button, $modifiermask)
		1127
		1128	Registers a synchronous button grab. See the XGrabButton manpage.
		1129
		1130	=item $success = $term->grab ($eventtime[, $sync])
		1131
		1132	Calls XGrabPointer and XGrabKeyboard in asynchronous (default) or
		1133	synchronous (C<$sync> is true). Also remembers the grab timestampe.
		1134
		1135	=item $term->allow_events_async
		1136
		1137	Calls XAllowEvents with AsyncBoth for the most recent grab.
		1138
		1139	=item $term->allow_events_sync
		1140
		1141	Calls XAllowEvents with SyncBoth for the most recent grab.
		1142
		1143	=item $term->allow_events_replay
		1144
		1145	Calls XAllowEvents with both ReplayPointer and ReplayKeyboard for the most
		1146	recent grab.
		1147
		1148	=item $term->ungrab
		1149
		1150	Calls XUngrab for the most recent grab. Is called automatically on
		1151	evaluation errors, as it is better to lose the grab in the error case as
		1152	the session.
		1153
915	=back	1154	=back
		1155
		1156	=cut
		1157
		1158	package urxvt::popup;
		1159
		1160	=head2 The C<urxvt::popup> Class
		1161
		1162	=over 4
		1163
		1164	=cut
		1165
		1166	sub add_item {
		1167	my ($self, $item) = @_;
		1168
		1169	$item->{rend}{normal} = "\x1b[0;30;47m" unless exists $item->{rend}{normal};
		1170	$item->{rend}{hover} = "\x1b[0;30;46m" unless exists $item->{rend}{hover};
		1171	$item->{rend}{active} = "\x1b[m" unless exists $item->{rend}{active};
		1172
		1173	$item->{render} \|\|= sub { $_[0]{text} };
		1174
		1175	push @{ $self->{item} }, $item;
		1176	}
		1177
		1178	sub add_separator {
		1179	my ($self, $sep) = @_;
		1180
		1181	$sep \|\|= "=";
		1182
		1183	$self->add_item ({
		1184	rend => { normal => "\x1b[0;30;47m", hover => "\x1b[0;30;47m", active => "\x1b[0;30;47m" },
		1185	text => "",
		1186	render => sub { $sep x $self->{term}->ncol },
		1187	activate => sub { },
		1188	});
		1189	}
		1190
		1191	sub add_title {
		1192	my ($self, $title) = @_;
		1193
		1194	$self->add_item ({
		1195	rend => { normal => "\x1b[38;5;11;44m", hover => "\x1b[38;5;11;44m", active => "\x1b[38;5;11;44m" },
		1196	text => $title,
		1197	activate => sub { },
		1198	});
		1199	}
		1200
		1201	sub add_button {
		1202	my ($self, $text, $cb) = @_;
		1203
		1204	$self->add_item ({ type => "button", text => $text, activate => $cb});
		1205	}
		1206
		1207	sub add_toggle {
		1208	my ($self, $text, $cb, $value) = @_;
		1209
		1210	my $item; $item = {
		1211	type => "button",
		1212	text => " $text",
		1213	value => $value,
		1214	render => sub { ($_[0]{value} ? "* " : " ") . $text },
		1215	activate => sub { $cb->($_[0]{value} = !$_[0]{value}); },
		1216	};
		1217
		1218	$self->add_item ($item);
		1219	}
		1220
		1221	sub show {
		1222	my ($self) = @_;
		1223
		1224	local $urxvt::popup::self = $self;
		1225
		1226	local $ENV{LC_ALL} = $self->{term}->locale;
		1227
		1228	urxvt->new ("--perl-lib" => "", "--perl-ext-common" => "", "-pty-fd" => -1, "-sl" => 0, "-b" => 0,
		1229	"--transient-for" => $self->{term}->parent,
		1230	"-display" => $self->{term}->display_id,
		1231	"-pe" => "urxvt-popup")
		1232	or die "unable to create popup window\n";
		1233	}
		1234
		1235	sub DESTROY {
		1236	my ($self) = @_;
		1237
		1238	delete $self->{term}{_destroy}{$self};
		1239	$self->{term}->ungrab;
		1240	}
916		1241
917	=head2 The C<urxvt::timer> Class	1242	=head2 The C<urxvt::timer> Class
918		1243
919	This class implements timer watchers/events. Time is represented as a	1244	This class implements timer watchers/events. Time is represented as a
920	fractional number of seconds since the epoch. Example:	1245	fractional number of seconds since the epoch. Example:
…		…
1022	This variable controls the verbosity level of the perl extension. Higher	1347	This variable controls the verbosity level of the perl extension. Higher
1023	numbers indicate more verbose output.	1348	numbers indicate more verbose output.
1024		1349
1025	=over 4	1350	=over 4
1026		1351
1027	=item =0 - only fatal messages	1352	=item == 0 - fatal messages
1028		1353
1029	=item =3 - script loading and management	1354	=item >= 3 - script loading and management
1030		1355
1031	=item =10 - all events received	1356	=item >=10 - all events received
1032		1357
1033	=back	1358	=back
1034		1359
1035	=head1 AUTHOR	1360	=head1 AUTHOR
1036		1361

Diff Legend

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

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

Diff Legend

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