[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.60 by root, Mon Jan 9 01:21:43 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	delete $ENV{IFS};
		435	delete $ENV{CDPATH};
		436	delete $ENV{BASH_ENV};
		437	$ENV{PATH} = "/bin:/sbin:/usr/bin:/usr/sbin:/usr/local/bin:/usr/local/sbin:/opt/bin:/opt/sbin";
404	}	438	}
405		439
406	my @hook_count;	440	my @hook_count;
407	my $verbosity = $ENV{URXVT_PERL_VERBOSITY};	441	my $verbosity = $ENV{URXVT_PERL_VERBOSITY};
408		442
…		…
426	$hook_count[$htype]++	460	$hook_count[$htype]++
427	or set_should_invoke $htype, 1;	461	or set_should_invoke $htype, 1;
428	}	462	}
429	}	463	}
430		464
431	my $script_pkg = "script0000";	465	my $extension_pkg = "extension0000";
432	my %script_pkg;	466	my %extension_pkg;
433		467
434	# load a single script into its own package, once only	468	# load a single script into its own package, once only
435	sub script_package($) {	469	sub extension_package($) {
436	my ($path) = @_;	470	my ($path) = @_;
437		471
438	$script_pkg{$path} \|\|= do {	472	$extension_pkg{$path} \|\|= do {
439	my $pkg = "urxvt::" . ($script_pkg++);	473	my $pkg = "urxvt::" . ($extension_pkg++);
440		474
441	verbose 3, "loading script '$path' into package '$pkg'";	475	verbose 3, "loading extension '$path' into package '$pkg'";
442		476
443	open my $fh, "<:raw", $path	477	open my $fh, "<:raw", $path
444	or die "$path: $!";	478	or die "$path: $!";
445		479
446	my $source = "package $pkg; use strict; use utf8;\n"	480	my $source = untaint "package $pkg; use strict; use utf8;\n"
		481	. "use base urxvt::term::proxy::;\n"
447	. "#line 1 \"$path\"\n{\n"	482	. "#line 1 \"$path\"\n{\n"
448	. (do { local $/; <$fh> })	483	. (do { local $/; <$fh> })
449	. "\n};\n1";	484	. "\n};\n1";
450		485
451	eval $source or die "$path: $@";	486	eval $source or die "$path: $@";
…		…
461	local $TERM = shift;	496	local $TERM = shift;
462	my $htype = shift;	497	my $htype = shift;
463		498
464	if ($htype == 0) { # INIT	499	if ($htype == 0) { # INIT
465	my @dirs = ((split /:/, $TERM->resource ("perl_lib")), "$LIBDIR/perl");	500	my @dirs = ((split /:/, $TERM->resource ("perl_lib")), "$LIBDIR/perl");
		501
		502	my %want_ext;
466		503
467	for my $ext (map { split /:/, $TERM->resource ("perl_ext_$_") } 1, 2) {	504	for (map { split /,/, $TERM->resource ("perl_ext_$_") } 1, 2) {
		505	if ($_ eq "default") {
		506	$want_ext{$_}++ for qw(selection option-popup selection-popup);
		507	} elsif (/^-(.*)$/) {
		508	delete $want_ext{$1};
		509	} else {
		510	$want_ext{$_}++;
		511	}
		512	}
		513
		514	for my $ext (keys %want_ext) {
468	my @files = grep -f $_, map "$_/$ext", @dirs;	515	my @files = grep -f $_, map "$_/$ext", @dirs;
469		516
470	if (@files) {	517	if (@files) {
471	register_package script_package $files[0];	518	register_package extension_package $files[0];
472	} else {	519	} else {
473	warn "perl extension '$ext' not found in perl library search path\n";	520	warn "perl extension '$ext' not found in perl library search path\n";
474	}	521	}
475	}	522	}
		523
		524	eval "#line 1 \"--perl-eval resource/argument\"\n" . $TERM->resource ("perl_eval");
		525	warn $@ if $@;
476	}	526	}
477		527
478	$retval = undef;	528	$retval = undef;
479		529
480	if (my $cb = $TERM->{_hook}[$htype]) {	530	if (my $cb = $TERM->{_hook}[$htype]) {
…		…
482	if $verbosity >= 10;	532	if $verbosity >= 10;
483		533
484	keys %$cb;	534	keys %$cb;
485		535
486	while (my ($pkg, $cb) = each %$cb) {	536	while (my ($pkg, $cb) = each %$cb) {
		537	eval {
487	$retval = $cb->(	538	$retval = $cb->(
488	$TERM->{_pkg}{$pkg} \|\|= do {	539	$TERM->{_pkg}{$pkg} \|\|= do {
489	my $proxy = bless { }, urxvt::term::proxy::;	540	my $proxy = bless { }, $pkg;
490	Scalar::Util::weaken ($proxy->{term} = $TERM);	541	Scalar::Util::weaken ($proxy->{term} = $TERM);
491	$proxy	542	$proxy
492	},	543	},
493	@_,	544	@_,
494	) and last;	545	) and last;
		546	};
		547	if ($@) {
		548	$TERM->ungrab; # better to lose the grab than the session
		549	warn $@;
		550	}
495	}	551	}
496	}	552	}
497		553
498	if ($htype == 1) { # DESTROY	554	if ($htype == 1) { # DESTROY
499	# remove hooks if unused	555	# remove hooks if unused
…		…
512	}	568	}
513		569
514	$retval	570	$retval
515	}	571	}
516		572
		573	# urxvt::term::proxy
		574
517	sub urxvt::term::proxy::AUTOLOAD {	575	sub urxvt::term::proxy::AUTOLOAD {
518	$urxvt::term::proxy::AUTOLOAD =~ /:([^:]+)$/	576	$urxvt::term::proxy::AUTOLOAD =~ /:([^:]+)$/
519	or die "FATAL: \$AUTOLOAD '$urxvt::term::proxy::AUTOLOAD' unparsable";	577	or die "FATAL: \$AUTOLOAD '$urxvt::term::proxy::AUTOLOAD' unparsable";
520		578
521	eval qq{	579	eval qq{
…		…
527	} or die "FATAL: unable to compile method forwarder: $@";	585	} or die "FATAL: unable to compile method forwarder: $@";
528		586
529	goto &$urxvt::term::proxy::AUTOLOAD;	587	goto &$urxvt::term::proxy::AUTOLOAD;
530	}	588	}
531		589
		590	sub urxvt::term::proxy::DESTROY {
		591	# nop
		592	}
		593
		594	# urxvt::destroy_hook
		595
		596	sub urxvt::destroy_hook::DESTROY {
		597	${$_[0]}->();
		598	}
		599
		600	sub urxvt::destroy_hook(&) {
		601	bless \shift, urxvt::destroy_hook::
		602	}
		603
		604	package urxvt::anyevent;
		605
		606	=head2 The C<urxvt::anyevent> Class
		607
		608	The sole purpose of this class is to deliver an interface to the
		609	C<AnyEvent> module - any module using it will work inside urxvt without
		610	further work. The only exception is that you cannot wait on condition
		611	variables, but non-blocking condvar use is ok. What this means is that you
		612	cannot use blocking APIs, but the non-blocking variant should work.
		613
		614	=cut
		615
		616	our $VERSION = 1;
		617
		618	$INC{"urxvt/anyevent.pm"} = 1; # mark us as there
		619	push @AnyEvent::REGISTRY, [urxvt => urxvt::anyevent::];
		620
		621	sub timer {
		622	my ($class, %arg) = @_;
		623
		624	my $cb = $arg{cb};
		625
		626	urxvt::timer
		627	->new
		628	->start (urxvt::NOW + $arg{after})
		629	->cb (sub {
		630	$_[0]->stop; # need to cancel manually
		631	$cb->();
		632	})
		633	}
		634
		635	sub io {
		636	my ($class, %arg) = @_;
		637
		638	my $cb = $arg{cb};
		639
		640	bless [$arg{fh}, urxvt::iow
		641	->new
		642	->fd (fileno $arg{fh})
		643	->events (($arg{poll} =~ /r/ ? 1 : 0)
		644	\| ($arg{poll} =~ /w/ ? 2 : 0))
		645	->start
		646	->cb (sub {
		647	$cb->(($_[1] & 1 ? 'r' : '')
		648	. ($_[1] & 2 ? 'w' : ''));
		649	})],
		650	urxvt::anyevent::
		651	}
		652
		653	sub DESTROY {
		654	$_[0][1]->stop;
		655	}
		656
		657	sub condvar {
		658	bless \my $flag, urxvt::anyevent::condvar::
		659	}
		660
		661	sub urxvt::anyevent::condvar::broadcast {
		662	${$_[0]}++;
		663	}
		664
		665	sub urxvt::anyevent::condvar::wait {
		666	unless (${$_[0]}) {
		667	require Carp;
		668	Carp::croak ("AnyEvent->condvar blocking wait unsupported in urxvt, use a non-blocking API");
		669	}
		670	}
		671
		672	package urxvt::term;
		673
532	=head2 The C<urxvt::term> Class	674	=head2 The C<urxvt::term> Class
533		675
534	=over 4	676	=over 4
535		677
536	=item $term->destroy	678	=item $term->destroy
537		679
538	Destroy the terminal object (close the window, free resources etc.).	680	Destroy the terminal object (close the window, free resources etc.).
		681
		682	=item $isset = $term->option ($optval[, $set])
		683
		684	Returns true if the option specified by C<$optval> is enabled, and
		685	optionally change it. All option values are stored by name in the hash
		686	C<%urxvt::OPTION>. Options not enabled in this binary are not in the hash.
		687
		688	Here is a a likely non-exhaustive list of option names, please see the
		689	source file F</src/optinc.h> to see the actual list:
		690
		691	borderLess console cursorBlink cursorUnderline hold iconic insecure
		692	intensityStyles jumpScroll loginShell mapAlert meta8 mouseWheelScrollPage
		693	pastableTabs pointerBlank reverseVideo scrollBar scrollBar_floating
		694	scrollBar_right scrollTtyKeypress scrollTtyOutput scrollWithBuffer
		695	secondaryScreen secondaryScroll skipBuiltinGlyphs transparent
		696	tripleclickwords utmpInhibit visualBell
539		697
540	=item $value = $term->resource ($name[, $newval])	698	=item $value = $term->resource ($name[, $newval])
541		699
542	Returns the current resource value associated with a given name and	700	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>	701	optionally sets a new value. Setting values is most useful in the C<init>
…		…
553		711
554	Please note that resource strings will currently only be freed when the	712	Please note that resource strings will currently only be freed when the
555	terminal is destroyed, so changing options frequently will eat memory.	713	terminal is destroyed, so changing options frequently will eat memory.
556		714
557	Here is a a likely non-exhaustive list of resource names, not all of which	715	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	716	are supported in every build, please see the source file F</src/rsinc.h>
559	list:	717	to see the actual list:
560		718
561	answerbackstring backgroundPixmap backspace_key boldFont boldItalicFont	719	answerbackstring backgroundPixmap backspace_key boldFont boldItalicFont
562	borderLess color cursorBlink cursorUnderline cutchars delete_key	720	borderLess color cursorBlink cursorUnderline cutchars delete_key
563	display_name embed ext_bwidth fade font geometry hold iconName	721	display_name embed ext_bwidth fade font geometry hold iconName
564	imFont imLocale inputMethod insecure int_bwidth intensityStyles	722	imFont imLocale inputMethod insecure int_bwidth intensityStyles
…		…
571	shade term_name title transparent transparent_all tripleclickwords	729	shade term_name title transparent transparent_all tripleclickwords
572	utmpInhibit visualBell	730	utmpInhibit visualBell
573		731
574	=cut	732	=cut
575		733
576	sub urxvt::term::resource($$;$) {	734	sub resource($$;$) {
577	my ($self, $name) = (shift, shift);	735	my ($self, $name) = (shift, shift);
578	unshift @_, $self, $name, ($name =~ s/\s\+\s(\d+)$// ? $1 : 0);	736	unshift @_, $self, $name, ($name =~ s/\s\+\s(\d+)$// ? $1 : 0);
579	goto &urxvt::term::_resource;	737	&urxvt::term::_resource
580	}	738	}
581		739
582	=item $rend = $term->rstyle ([$new_rstyle])	740	=item $rend = $term->rstyle ([$new_rstyle])
583		741
584	Return and optionally change the current rendition. Text that is output by	742	Return and optionally change the current rendition. Text that is output by
…		…
660		818
661	If hidden, display the overlay again.	819	If hidden, display the overlay again.
662		820
663	=back	821	=back
664		822
		823	=item $popup = $term->popup ($event)
		824
		825	Creates a new C<urxvt::popup> object that implements a popup menu. The
		826	C<$event> I<must> be the event causing the menu to pop up (a button event,
		827	currently).
		828
		829	=cut
		830
		831	sub popup {
		832	my ($self, $event) = @_;
		833
		834	$self->grab ($event->{time}, 1)
		835	or return;
		836
		837	my $popup = bless {
		838	term => $self,
		839	event => $event,
		840	}, urxvt::popup::;
		841
		842	Scalar::Util::weaken $popup->{term};
		843
		844	$self->{_destroy}{$popup} = urxvt::destroy_hook { $popup->{popup}->destroy };
		845	Scalar::Util::weaken $self->{_destroy}{$popup};
		846
		847	$popup
		848	}
		849
665	=item $cellwidth = $term->strwidth $string	850	=item $cellwidth = $term->strwidth ($string)
666		851
667	Returns the number of screen-cells this string would need. Correctly	852	Returns the number of screen-cells this string would need. Correctly
668	accounts for wide and combining characters.	853	accounts for wide and combining characters.
669		854
670	=item $octets = $term->locale_encode $string	855	=item $octets = $term->locale_encode ($string)
671		856
672	Convert the given text string into the corresponding locale encoding.	857	Convert the given text string into the corresponding locale encoding.
673		858
674	=item $string = $term->locale_decode $octets	859	=item $string = $term->locale_decode ($octets)
675		860
676	Convert the given locale-encoded octets into a perl string.	861	Convert the given locale-encoded octets into a perl string.
677		862
678	=item $term->scr_add_lines ($string)	863	=item $term->scr_add_lines ($string)
679		864
…		…
696		881
697	Write the octets given in C<$data> to the tty (i.e. as program input). To	882	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	883	pass characters instead of octets, you should convert your strings first
699	to the locale-specific encoding using C<< $term->locale_encode >>.	884	to the locale-specific encoding using C<< $term->locale_encode >>.
700		885
		886	=item $windowid = $term->parent
		887
		888	Return the window id of the toplevel window.
		889
		890	=item $windowid = $term->vt
		891
		892	Return the window id of the terminal window.
		893
701	=item $window_width = $term->width	894	=item $window_width = $term->width
702		895
703	=item $window_height = $term->height	896	=item $window_height = $term->height
704		897
705	=item $font_width = $term->fwidth	898	=item $font_width = $term->fwidth
…		…
721	=item $nrow_plus_saveLines = $term->total_rows	914	=item $nrow_plus_saveLines = $term->total_rows
722		915
723	=item $lines_in_scrollback = $term->nsaved	916	=item $lines_in_scrollback = $term->nsaved
724		917
725	Return various integers describing terminal characteristics.	918	Return various integers describing terminal characteristics.
		919
		920	=item $modifiermask = $term->ModLevel3Mask
		921
		922	=item $modifiermask = $term->ModMetaMask
		923
		924	=item $modifiermask = $term->ModNumLockMask
		925
		926	Return the modifier masks corresponding to the "ISO Level 3 Shift" (often
		927	AltGr), the meta key (often Alt) and the num lock key, if applicable.
726		928
727	=item $view_start = $term->view_start ([$newvalue])	929	=item $view_start = $term->view_start ([$newvalue])
728		930
729	Returns the negative row number of the topmost line. Minimum value is	931	Returns the negative row number of the topmost line. Minimum value is
730	C<0>, which displays the normal terminal contents. Larger values scroll	932	C<0>, which displays the normal terminal contents. Larger values scroll
…		…
824		1026
825	=back	1027	=back
826		1028
827	=cut	1029	=cut
828		1030
829	sub urxvt::term::line {	1031	sub line {
830	my ($self, $row) = @_;	1032	my ($self, $row) = @_;
831		1033
832	my $maxrow = $self->nrow - 1;	1034	my $maxrow = $self->nrow - 1;
833		1035
834	my ($beg, $end) = ($row, $row);	1036	my ($beg, $end) = ($row, $row);
…		…
911		1113
912	Converts rxvt-unicodes text reprsentation into a perl string. See	1114	Converts rxvt-unicodes text reprsentation into a perl string. See
913	C<< $term->ROW_t >> for details.	1115	C<< $term->ROW_t >> for details.
914		1116
915	=back	1117	=back
		1118
		1119	=cut
		1120
		1121	package urxvt::popup;
		1122
		1123	=head2 The C<urxvt::popup> Class
		1124
		1125	=over 4
		1126
		1127	=cut
		1128
		1129	sub add_item {
		1130	my ($self, $item) = @_;
		1131
		1132	$item->{rend}{normal} = "\x1b[0;30;47m" unless exists $item->{rend}{normal};
		1133	$item->{rend}{hover} = "\x1b[0;30;46m" unless exists $item->{rend}{hover};
		1134	$item->{rend}{active} = "\x1b[m" unless exists $item->{rend}{active};
		1135
		1136	$item->{render} \|\|= sub { $_[0]{text} };
		1137
		1138	push @{ $self->{item} }, $item;
		1139	}
		1140
		1141	sub add_separator {
		1142	my ($self, $sep) = @_;
		1143
		1144	$sep \|\|= "═";
		1145
		1146	$self->add_item ({
		1147	rend => { normal => "\x1b[0;30;47m", hover => "\x1b[0;30;47m", active => "\x1b[0;30;47m" },
		1148	text => "",
		1149	render => sub { $sep x $urxvt::TERM->ncol },
		1150	activate => sub { },
		1151	});
		1152	}
		1153
		1154	sub add_title {
		1155	my ($self, $title) = @_;
		1156
		1157	$self->add_item ({
		1158	rend => { normal => "\x1b[38;5;11;44m", hover => "\x1b[38;5;11;44m", active => "\x1b[38;5;11;44m" },
		1159	text => $title,
		1160	activate => sub { },
		1161	});
		1162	}
		1163
		1164	sub add_button {
		1165	my ($self, $text, $cb) = @_;
		1166
		1167	$self->add_item ({ type => "button", text => "[ $text ]", activate => $cb});
		1168	}
		1169
		1170	sub add_toggle {
		1171	my ($self, $text, $cb, $value) = @_;
		1172
		1173	my $item; $item = {
		1174	type => "button",
		1175	text => " $text",
		1176	value => $value,
		1177	render => sub { ($_[0]{value} ? "* " : " ") . $text },
		1178	activate => sub { $cb->($_[0]{value} = !$_[0]{value}); },
		1179	};
		1180
		1181	$self->add_item ($item);
		1182	}
		1183
		1184	sub show {
		1185	my ($self) = @_;
		1186
		1187	local $urxvt::popup::self = $self;
		1188
		1189	urxvt->new ("--perl-lib" => "", "--perl-ext-common" => "", "-pty-fd" => -1, "-sl" => 0, "-b" => 0,
		1190	"--transient-for" => $self->{term}->parent,
		1191	"-pe" => "urxvt-popup")
		1192	or die "unable to create popup window\n";
		1193	}
		1194
		1195	sub DESTROY {
		1196	my ($self) = @_;
		1197
		1198	delete $self->{term}{_destroy}{$self};
		1199	$self->{term}->ungrab;
		1200	}
916		1201
917	=head2 The C<urxvt::timer> Class	1202	=head2 The C<urxvt::timer> Class
918		1203
919	This class implements timer watchers/events. Time is represented as a	1204	This class implements timer watchers/events. Time is represented as a
920	fractional number of seconds since the epoch. Example:	1205	fractional number of seconds since the epoch. Example:
…		…
1022	This variable controls the verbosity level of the perl extension. Higher	1307	This variable controls the verbosity level of the perl extension. Higher
1023	numbers indicate more verbose output.	1308	numbers indicate more verbose output.
1024		1309
1025	=over 4	1310	=over 4
1026		1311
1027	=item =0 - only fatal messages	1312	=item == 0 - fatal messages
1028		1313
1029	=item =3 - script loading and management	1314	=item >= 3 - script loading and management
1030		1315
1031	=item =10 - all events received	1316	=item >=10 - all events received
1032		1317
1033	=back	1318	=back
1034		1319
1035	=head1 AUTHOR	1320	=head1 AUTHOR
1036		1321

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.60 by root, Mon Jan 9 01:21:43 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.60 by root, Mon Jan 9 01:21:43 2006 UTC