[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.59 by root, Mon Jan 9 00:34:36 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
…		…
178	click) and is either supposed to return false (normal operation), or	188	click) and is either supposed to return false (normal operation), or
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
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		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
…		…
261		261
262	Called whenever the user presses a key combination that has a	262	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>	263	C<perl:string> action bound to it (see description of the B<keysym>
264	resource in the @@RXVT_NAME@@(1) manpage).	264	resource in the @@RXVT_NAME@@(1) manpage).
265		265
		266	=item on_focus_in $term
		267
		268	Called whenever the window gets the keyboard focus, before rxvt-unicode
		269	does focus in processing.
		270
		271	=item on_focus_out $term
		272
		273	Called wheneever the window loses keyboard focus, before rxvt-unicode does
		274	focus out processing.
		275
266	=item on_key_press $term, $event, $octets	276	=item on_key_press $term, $event, $octets
267		277
268	=item on_key_release $term, $event	278	=item on_key_release $term, $event
269		279
270	=item on_button_press $term, $event	280	=item on_button_press $term, $event
271		281
272	=item on_button_release $term, $event	282	=item on_button_release $term, $event
273		283
274	=item on_motion_notify $term, $event	284	=item on_motion_notify $term, $event
275		285
		286	=item on_map_notify $term, $event
		287
		288	=item on_unmap_notify $term, $event
		289
276	Called whenever the corresponding X event is received for the terminal	290	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	291	the hook returns true, then the even will be ignored by rxvt-unicode.
278	ignored by rxvt-unicode.	292
		293	The event is a hash with most values as named by Xlib (see the XEvent
		294	manpage), with the additional members C<row> and C<col>, which are the row
		295	and column under the mouse cursor.
279		296
280	C<on_key_press> additionally receives the string rxvt-unicode would	297	C<on_key_press> additionally receives the string rxvt-unicode would
281	output, if any, in locale-specific encoding.	298	output, if any, in locale-specific encoding.
282		299
283	subwindow.	300	subwindow.
…		…
288		305
289	=over 4	306	=over 4
290		307
291	=item $urxvt::TERM	308	=item $urxvt::TERM
292		309
293	The current terminal. Whenever a callback/Hook is bein executed, this	310	The current terminal. This variable stores the current C<urxvt::term>
294	variable stores the current C<urxvt::term> object.	311	object, whenever a callback/hook is executing.
295		312
296	=back	313	=back
297		314
298	=head2 Functions in the C<urxvt> Package	315	=head2 Functions in the C<urxvt> Package
299		316
…		…
324		341
325	=item $time = urxvt::NOW	342	=item $time = urxvt::NOW
326		343
327	Returns the "current time" (as per the event loop).	344	Returns the "current time" (as per the event loop).
328		345
		346	=item urxvt::CurrentTime
		347
		348	=item urxvt::ShiftMask, LockMask, ControlMask, Mod1Mask, Mod2Mask,
		349	Mod3Mask, Mod4Mask, Mod5Mask, Button1Mask, Button2Mask, Button3Mask,
		350	Button4Mask, Button5Mask, AnyModifier
		351
		352	Various constants for use in X calls and event processing.
		353
329	=back	354	=back
330		355
331	=head2 RENDITION	356	=head2 RENDITION
332		357
333	Rendition bitsets contain information about colour, font, font styles and	358	Rendition bitsets contain information about colour, font, font styles and
…		…
382		407
383	=cut	408	=cut
384		409
385	package urxvt;	410	package urxvt;
386		411
		412	use utf8;
387	use strict;	413	use strict;
388	use Scalar::Util ();	414	use Scalar::Util ();
		415	use List::Util ();
389		416
		417	our $VERSION = 1;
390	our $TERM;	418	our $TERM;
391	our @HOOKNAME;	419	our @HOOKNAME;
		420	our %OPTION;
392	our $LIBDIR;	421	our $LIBDIR;
393		422
394	BEGIN {	423	BEGIN {
395	urxvt->bootstrap;	424	urxvt->bootstrap;
396		425
…		…
399	my $msg = join "", @_;	428	my $msg = join "", @_;
400	$msg .= "\n"	429	$msg .= "\n"
401	unless $msg =~ /\n$/;	430	unless $msg =~ /\n$/;
402	urxvt::warn ($msg);	431	urxvt::warn ($msg);
403	};	432	};
		433
		434	$ENV{PATH} = "/bin:/sbin:/usr/bin:/usr/sbin:/usr/local/bin:/usr/local/sbin:/opt/bin:/opt/sbin";
		435	delete $ENV{CDPATH};
404	}	436	}
405		437
406	my @hook_count;	438	my @hook_count;
407	my $verbosity = $ENV{URXVT_PERL_VERBOSITY};	439	my $verbosity = $ENV{URXVT_PERL_VERBOSITY};
408		440
…		…
426	$hook_count[$htype]++	458	$hook_count[$htype]++
427	or set_should_invoke $htype, 1;	459	or set_should_invoke $htype, 1;
428	}	460	}
429	}	461	}
430		462
431	my $script_pkg = "script0000";	463	my $extension_pkg = "extension0000";
432	my %script_pkg;	464	my %extension_pkg;
433		465
434	# load a single script into its own package, once only	466	# load a single script into its own package, once only
435	sub script_package($) {	467	sub extension_package($) {
436	my ($path) = @_;	468	my ($path) = @_;
437		469
438	$script_pkg{$path} \|\|= do {	470	$extension_pkg{$path} \|\|= do {
439	my $pkg = "urxvt::" . ($script_pkg++);	471	my $pkg = "urxvt::" . ($extension_pkg++);
440		472
441	verbose 3, "loading script '$path' into package '$pkg'";	473	verbose 3, "loading extension '$path' into package '$pkg'";
442		474
443	open my $fh, "<:raw", $path	475	open my $fh, "<:raw", $path
444	or die "$path: $!";	476	or die "$path: $!";
445		477
446	my $source = "package $pkg; use strict; use utf8;\n"	478	my $source = untaint "package $pkg; use strict; use utf8;\n"
		479	. "use base urxvt::term::proxy::;\n"
447	. "#line 1 \"$path\"\n{\n"	480	. "#line 1 \"$path\"\n{\n"
448	. (do { local $/; <$fh> })	481	. (do { local $/; <$fh> })
449	. "\n};\n1";	482	. "\n};\n1";
450		483
451	eval $source or die "$path: $@";	484	eval $source or die "$path: $@";
…		…
461	local $TERM = shift;	494	local $TERM = shift;
462	my $htype = shift;	495	my $htype = shift;
463		496
464	if ($htype == 0) { # INIT	497	if ($htype == 0) { # INIT
465	my @dirs = ((split /:/, $TERM->resource ("perl_lib")), "$LIBDIR/perl");	498	my @dirs = ((split /:/, $TERM->resource ("perl_lib")), "$LIBDIR/perl");
		499
		500	my %want_ext;
466		501
467	for my $ext (map { split /:/, $TERM->resource ("perl_ext_$_") } 1, 2) {	502	for (map { split /,/, $TERM->resource ("perl_ext_$_") } 1, 2) {
		503	if ($_ eq "default") {
		504	$want_ext{$_}++ for qw(selection option-popup selection-popup);
		505	} elsif (/^-(.*)$/) {
		506	delete $want_ext{$1};
		507	} else {
		508	$want_ext{$_}++;
		509	}
		510	}
		511
		512	for my $ext (keys %want_ext) {
468	my @files = grep -f $_, map "$_/$ext", @dirs;	513	my @files = grep -f $_, map "$_/$ext", @dirs;
469		514
470	if (@files) {	515	if (@files) {
471	register_package script_package $files[0];	516	register_package extension_package $files[0];
472	} else {	517	} else {
473	warn "perl extension '$ext' not found in perl library search path\n";	518	warn "perl extension '$ext' not found in perl library search path\n";
474	}	519	}
475	}	520	}
		521
		522	eval "#line 1 \"--perl-eval resource/argument\"\n" . $TERM->resource ("perl_eval");
		523	warn $@ if $@;
476	}	524	}
477		525
478	$retval = undef;	526	$retval = undef;
479		527
480	if (my $cb = $TERM->{_hook}[$htype]) {	528	if (my $cb = $TERM->{_hook}[$htype]) {
…		…
482	if $verbosity >= 10;	530	if $verbosity >= 10;
483		531
484	keys %$cb;	532	keys %$cb;
485		533
486	while (my ($pkg, $cb) = each %$cb) {	534	while (my ($pkg, $cb) = each %$cb) {
		535	eval {
487	$retval = $cb->(	536	$retval = $cb->(
488	$TERM->{_pkg}{$pkg} \|\|= do {	537	$TERM->{_pkg}{$pkg} \|\|= do {
489	my $proxy = bless { }, urxvt::term::proxy::;	538	my $proxy = bless { }, $pkg;
490	Scalar::Util::weaken ($proxy->{term} = $TERM);	539	Scalar::Util::weaken ($proxy->{term} = $TERM);
491	$proxy	540	$proxy
492	},	541	},
493	@_,	542	@_,
494	) and last;	543	) and last;
		544	};
		545	if ($@) {
		546	$TERM->ungrab; # better to lose the grab than the session
		547	warn $@;
		548	}
495	}	549	}
496	}	550	}
497		551
498	if ($htype == 1) { # DESTROY	552	if ($htype == 1) { # DESTROY
499	# remove hooks if unused	553	# remove hooks if unused
…		…
512	}	566	}
513		567
514	$retval	568	$retval
515	}	569	}
516		570
		571	# urxvt::term::proxy
		572
517	sub urxvt::term::proxy::AUTOLOAD {	573	sub urxvt::term::proxy::AUTOLOAD {
518	$urxvt::term::proxy::AUTOLOAD =~ /:([^:]+)$/	574	$urxvt::term::proxy::AUTOLOAD =~ /:([^:]+)$/
519	or die "FATAL: \$AUTOLOAD '$urxvt::term::proxy::AUTOLOAD' unparsable";	575	or die "FATAL: \$AUTOLOAD '$urxvt::term::proxy::AUTOLOAD' unparsable";
520		576
521	eval qq{	577	eval qq{
…		…
527	} or die "FATAL: unable to compile method forwarder: $@";	583	} or die "FATAL: unable to compile method forwarder: $@";
528		584
529	goto &$urxvt::term::proxy::AUTOLOAD;	585	goto &$urxvt::term::proxy::AUTOLOAD;
530	}	586	}
531		587
		588	sub urxvt::term::proxy::DESTROY {
		589	# nop
		590	}
		591
		592	# urxvt::destroy_hook
		593
		594	sub urxvt::destroy_hook::DESTROY {
		595	${$_[0]}->();
		596	}
		597
		598	sub urxvt::destroy_hook(&) {
		599	bless \shift, urxvt::destroy_hook::
		600	}
		601
		602	package urxvt::anyevent;
		603
		604	=head2 The C<urxvt::anyevent> Class
		605
		606	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
		608	further work. The only exception is that you cannot wait on condition
		609	variables, but non-blocking condvar use is ok. What this means is that you
		610	cannot use blocking APIs, but the non-blocking variant should work.
		611
		612	=cut
		613
		614	our $VERSION = 1;
		615
		616	$INC{"urxvt/anyevent.pm"} = 1; # mark us as there
		617	push @AnyEvent::REGISTRY, [urxvt => urxvt::anyevent::];
		618
		619	sub timer {
		620	my ($class, %arg) = @_;
		621
		622	my $cb = $arg{cb};
		623
		624	urxvt::timer
		625	->new
		626	->start (urxvt::NOW + $arg{after})
		627	->cb (sub {
		628	$_[0]->stop; # need to cancel manually
		629	$cb->();
		630	})
		631	}
		632
		633	sub io {
		634	my ($class, %arg) = @_;
		635
		636	my $cb = $arg{cb};
		637
		638	bless [$arg{fh}, urxvt::iow
		639	->new
		640	->fd (fileno $arg{fh})
		641	->events (($arg{poll} =~ /r/ ? 1 : 0)
		642	\| ($arg{poll} =~ /w/ ? 2 : 0))
		643	->start
		644	->cb (sub {
		645	$cb->(($_[1] & 1 ? 'r' : '')
		646	. ($_[1] & 2 ? 'w' : ''));
		647	})],
		648	urxvt::anyevent::
		649	}
		650
		651	sub DESTROY {
		652	$_[0][1]->stop;
		653	}
		654
		655	sub condvar {
		656	bless \my $flag, urxvt::anyevent::condvar::
		657	}
		658
		659	sub urxvt::anyevent::condvar::broadcast {
		660	${$_[0]}++;
		661	}
		662
		663	sub urxvt::anyevent::condvar::wait {
		664	unless (${$_[0]}) {
		665	require Carp;
		666	Carp::croak ("AnyEvent->condvar blocking wait unsupported in urxvt, use a non-blocking API");
		667	}
		668	}
		669
		670	package urxvt::term;
		671
532	=head2 The C<urxvt::term> Class	672	=head2 The C<urxvt::term> Class
533		673
534	=over 4	674	=over 4
535		675
536	=item $term->destroy	676	=item $term->destroy
537		677
538	Destroy the terminal object (close the window, free resources etc.).	678	Destroy the terminal object (close the window, free resources etc.).
		679
		680	=item $isset = $term->option ($optval[, $set])
		681
		682	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
		684	C<%urxvt::OPTION>. Options not enabled in this binary are not in the hash.
		685
		686	Here is a a likely non-exhaustive list of option names, please see the
		687	source file F</src/optinc.h> to see the actual list:
		688
		689	borderLess console cursorBlink cursorUnderline hold iconic insecure
		690	intensityStyles jumpScroll loginShell mapAlert meta8 mouseWheelScrollPage
		691	pastableTabs pointerBlank reverseVideo scrollBar scrollBar_floating
		692	scrollBar_right scrollTtyKeypress scrollTtyOutput scrollWithBuffer
		693	secondaryScreen secondaryScroll skipBuiltinGlyphs transparent
		694	tripleclickwords utmpInhibit visualBell
539		695
540	=item $value = $term->resource ($name[, $newval])	696	=item $value = $term->resource ($name[, $newval])
541		697
542	Returns the current resource value associated with a given name and	698	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>	699	optionally sets a new value. Setting values is most useful in the C<init>
…		…
553		709
554	Please note that resource strings will currently only be freed when the	710	Please note that resource strings will currently only be freed when the
555	terminal is destroyed, so changing options frequently will eat memory.	711	terminal is destroyed, so changing options frequently will eat memory.
556		712
557	Here is a a likely non-exhaustive list of resource names, not all of which	713	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	714	are supported in every build, please see the source file F</src/rsinc.h>
559	list:	715	to see the actual list:
560		716
561	answerbackstring backgroundPixmap backspace_key boldFont boldItalicFont	717	answerbackstring backgroundPixmap backspace_key boldFont boldItalicFont
562	borderLess color cursorBlink cursorUnderline cutchars delete_key	718	borderLess color cursorBlink cursorUnderline cutchars delete_key
563	display_name embed ext_bwidth fade font geometry hold iconName	719	display_name embed ext_bwidth fade font geometry hold iconName
564	imFont imLocale inputMethod insecure int_bwidth intensityStyles	720	imFont imLocale inputMethod insecure int_bwidth intensityStyles
…		…
571	shade term_name title transparent transparent_all tripleclickwords	727	shade term_name title transparent transparent_all tripleclickwords
572	utmpInhibit visualBell	728	utmpInhibit visualBell
573		729
574	=cut	730	=cut
575		731
576	sub urxvt::term::resource($$;$) {	732	sub resource($$;$) {
577	my ($self, $name) = (shift, shift);	733	my ($self, $name) = (shift, shift);
578	unshift @_, $self, $name, ($name =~ s/\s\+\s(\d+)$// ? $1 : 0);	734	unshift @_, $self, $name, ($name =~ s/\s\+\s(\d+)$// ? $1 : 0);
579	goto &urxvt::term::_resource;	735	&urxvt::term::_resource
580	}	736	}
581		737
582	=item $rend = $term->rstyle ([$new_rstyle])	738	=item $rend = $term->rstyle ([$new_rstyle])
583		739
584	Return and optionally change the current rendition. Text that is output by	740	Return and optionally change the current rendition. Text that is output by
…		…
660		816
661	If hidden, display the overlay again.	817	If hidden, display the overlay again.
662		818
663	=back	819	=back
664		820
		821	=item $popup = $term->popup ($event)
		822
		823	Creates a new C<urxvt::popup> object that implements a popup menu. The
		824	C<$event> I<must> be the event causing the menu to pop up (a button event,
		825	currently).
		826
		827	=cut
		828
		829	sub popup {
		830	my ($self, $event) = @_;
		831
		832	$self->grab ($event->{time}, 1)
		833	or return;
		834
		835	my $popup = bless {
		836	term => $self,
		837	event => $event,
		838	}, urxvt::popup::;
		839
		840	Scalar::Util::weaken $popup->{term};
		841
		842	$self->{_destroy}{$popup} = urxvt::destroy_hook { $popup->{popup}->destroy };
		843	Scalar::Util::weaken $self->{_destroy}{$popup};
		844
		845	$popup
		846	}
		847
665	=item $cellwidth = $term->strwidth $string	848	=item $cellwidth = $term->strwidth ($string)
666		849
667	Returns the number of screen-cells this string would need. Correctly	850	Returns the number of screen-cells this string would need. Correctly
668	accounts for wide and combining characters.	851	accounts for wide and combining characters.
669		852
670	=item $octets = $term->locale_encode $string	853	=item $octets = $term->locale_encode ($string)
671		854
672	Convert the given text string into the corresponding locale encoding.	855	Convert the given text string into the corresponding locale encoding.
673		856
674	=item $string = $term->locale_decode $octets	857	=item $string = $term->locale_decode ($octets)
675		858
676	Convert the given locale-encoded octets into a perl string.	859	Convert the given locale-encoded octets into a perl string.
677		860
678	=item $term->scr_add_lines ($string)	861	=item $term->scr_add_lines ($string)
679		862
…		…
696		879
697	Write the octets given in C<$data> to the tty (i.e. as program input). To	880	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	881	pass characters instead of octets, you should convert your strings first
699	to the locale-specific encoding using C<< $term->locale_encode >>.	882	to the locale-specific encoding using C<< $term->locale_encode >>.
700		883
		884	=item $windowid = $term->parent
		885
		886	Return the window id of the toplevel window.
		887
		888	=item $windowid = $term->vt
		889
		890	Return the window id of the terminal window.
		891
701	=item $window_width = $term->width	892	=item $window_width = $term->width
702		893
703	=item $window_height = $term->height	894	=item $window_height = $term->height
704		895
705	=item $font_width = $term->fwidth	896	=item $font_width = $term->fwidth
…		…
721	=item $nrow_plus_saveLines = $term->total_rows	912	=item $nrow_plus_saveLines = $term->total_rows
722		913
723	=item $lines_in_scrollback = $term->nsaved	914	=item $lines_in_scrollback = $term->nsaved
724		915
725	Return various integers describing terminal characteristics.	916	Return various integers describing terminal characteristics.
		917
		918	=item $modifiermask = $term->ModLevel3Mask
		919
		920	=item $modifiermask = $term->ModMetaMask
		921
		922	=item $modifiermask = $term->ModNumLockMask
		923
		924	Return the modifier masks corresponding to the "ISO Level 3 Shift" (often
		925	AltGr), the meta key (often Alt) and the num lock key, if applicable.
726		926
727	=item $view_start = $term->view_start ([$newvalue])	927	=item $view_start = $term->view_start ([$newvalue])
728		928
729	Returns the negative row number of the topmost line. Minimum value is	929	Returns the negative row number of the topmost line. Minimum value is
730	C<0>, which displays the normal terminal contents. Larger values scroll	930	C<0>, which displays the normal terminal contents. Larger values scroll
…		…
824		1024
825	=back	1025	=back
826		1026
827	=cut	1027	=cut
828		1028
829	sub urxvt::term::line {	1029	sub line {
830	my ($self, $row) = @_;	1030	my ($self, $row) = @_;
831		1031
832	my $maxrow = $self->nrow - 1;	1032	my $maxrow = $self->nrow - 1;
833		1033
834	my ($beg, $end) = ($row, $row);	1034	my ($beg, $end) = ($row, $row);
…		…
911		1111
912	Converts rxvt-unicodes text reprsentation into a perl string. See	1112	Converts rxvt-unicodes text reprsentation into a perl string. See
913	C<< $term->ROW_t >> for details.	1113	C<< $term->ROW_t >> for details.
914		1114
915	=back	1115	=back
		1116
		1117	=cut
		1118
		1119	package urxvt::popup;
		1120
		1121	=head2 The C<urxvt::popup> Class
		1122
		1123	=over 4
		1124
		1125	=cut
		1126
		1127	sub add_item {
		1128	my ($self, $item) = @_;
		1129
		1130	$item->{rend}{normal} = "\x1b[0;30;47m" unless exists $item->{rend}{normal};
		1131	$item->{rend}{hover} = "\x1b[0;30;46m" unless exists $item->{rend}{hover};
		1132	$item->{rend}{active} = "\x1b[m" unless exists $item->{rend}{active};
		1133
		1134	$item->{render} \|\|= sub { $_[0]{text} };
		1135
		1136	push @{ $self->{item} }, $item;
		1137	}
		1138
		1139	sub add_separator {
		1140	my ($self, $sep) = @_;
		1141
		1142	$sep \|\|= "═";
		1143
		1144	$self->add_item ({
		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
		1152	sub add_title {
		1153	my ($self, $title) = @_;
		1154
		1155	$self->add_item ({
		1156	rend => { normal => "\x1b[38;5;11;44m", hover => "\x1b[38;5;11;44m", active => "\x1b[38;5;11;44m" },
		1157	text => $title,
		1158	activate => sub { },
		1159	});
		1160	}
		1161
		1162	sub add_button {
		1163	my ($self, $text, $cb) = @_;
		1164
		1165	$self->add_item ({ type => "button", text => "[ $text ]", activate => $cb});
		1166	}
		1167
		1168	sub add_toggle {
		1169	my ($self, $text, $cb, $value) = @_;
		1170
		1171	my $item; $item = {
		1172	type => "button",
		1173	text => " $text",
		1174	value => $value,
		1175	render => sub { ($_[0]{value} ? "* " : " ") . $text },
		1176	activate => sub { $cb->($_[0]{value} = !$_[0]{value}); },
		1177	};
		1178
		1179	$self->add_item ($item);
		1180	}
		1181
		1182	sub show {
		1183	my ($self) = @_;
		1184
		1185	local $urxvt::popup::self = $self;
		1186
		1187	urxvt->new ("--perl-lib" => "", "--perl-ext-common" => "", "-pty-fd" => -1, "-sl" => 0, "-b" => 0,
		1188	"--transient-for" => $self->{term}->parent,
		1189	"-pe" => "urxvt-popup")
		1190	or die "unable to create popup window\n";
		1191	}
		1192
		1193	sub DESTROY {
		1194	my ($self) = @_;
		1195
		1196	delete $self->{term}{_destroy}{$self};
		1197	$self->{term}->ungrab;
		1198	}
916		1199
917	=head2 The C<urxvt::timer> Class	1200	=head2 The C<urxvt::timer> Class
918		1201
919	This class implements timer watchers/events. Time is represented as a	1202	This class implements timer watchers/events. Time is represented as a
920	fractional number of seconds since the epoch. Example:	1203	fractional number of seconds since the epoch. Example:
…		…
1022	This variable controls the verbosity level of the perl extension. Higher	1305	This variable controls the verbosity level of the perl extension. Higher
1023	numbers indicate more verbose output.	1306	numbers indicate more verbose output.
1024		1307
1025	=over 4	1308	=over 4
1026		1309
1027	=item =0 - only fatal messages	1310	=item == 0 - fatal messages
1028		1311
1029	=item =3 - script loading and management	1312	=item >= 3 - script loading and management
1030		1313
1031	=item =10 - all events received	1314	=item >=10 - all events received
1032		1315
1033	=back	1316	=back
1034		1317
1035	=head1 AUTHOR	1318	=head1 AUTHOR
1036		1319

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.59 by root, Mon Jan 9 00:34:36 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.59 by root, Mon Jan 9 00:34:36 2006 UTC